Add ring buffer tests

bpf/CMakeLists.txt

@@ -5,61 +5,59 @@ set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin)
 
-# Each test consists of a C file, an output file name, and an optional option, seperated by commas.
+# Each test consists of a C file, an output file name, and an optional option-list, seperated by commas.
 set(test_cases
-    "baseline"
+    "baseline,baseline,-DBPF"
     "generic_map,hash,-DTYPE=BPF_MAP_TYPE_HASH"
     "generic_map,percpu_hash,-DTYPE=BPF_MAP_TYPE_PERCPU_HASH"
     "generic_map,lru_hash,-DTYPE=BPF_MAP_TYPE_LRU_HASH"
     "generic_map,lru_per_cpu_hash,-DTYPE=BPF_MAP_TYPE_LRU_PERCPU_HASH"
     "generic_map,array,-DTYPE=BPF_MAP_TYPE_ARRAY"
     "generic_map,percpu_array,-DTYPE=BPF_MAP_TYPE_PERCPU_ARRAY"
-    "helpers"
+    "helpers,helpers"
     "lpm,lpm_1024,-DMAX_ENTRIES=1024"
     "lpm,lpm_16384,-DMAX_ENTRIES=16384"
     "lpm,lpm_262144,-DMAX_ENTRIES=262144"
     "lpm,lpm_1048576,-DMAX_ENTRIES=1048576"
     "map_in_map,hash_of_array,-DTYPE=BPF_MAP_TYPE_HASH_OF_MAPS"
     "map_in_map,array_of_array,-DTYPE=BPF_MAP_TYPE_ARRAY_OF_MAPS"
-    "ringbuf"
-    "rolling_lru"
-    "tail_call"
-    "xdp"
-    "max_tail_call"
+    # The smallest power of 2 that is >= (128 * 1024) is 2^17 = 131072
+    "ringbuf,ringbuf,-DBPF -DRB_SIZE=131072 -DRECORD_SIZE=128"
+    # The smallest power of 2 that is >= (400 * 300000) is 2^27 = 134217728
+    "ringbuf,ringbuf_300K_400b,-DBPF -DRB_SIZE=134217728 -DRECORD_SIZE=400"
+    # The smallest power of 2 that is >= (1420 * 100000) is 2^28 = 268435456
+    "ringbuf,ringbuf_100K_1420b,-DBPF -DRB_SIZE=268435456 -DRECORD_SIZE=1420"
+    "rolling_lru,rolling_lru,-DBPF"
+    "tail_call,tail_call,-DBPF"
+    "xdp,xdp,-DBPF"
+    "max_tail_call,max_tail_call,-DBPF"
     )
 
-function(process_test_cases worker)
-    foreach(test ${test_cases})
+function(process_test_cases worker test_list)
+    foreach(test ${test_list})
         # Split test into list of strings
         string(REPLACE "," " " elements ${test})
         separate_arguments(elements NATIVE_COMMAND ${elements})
 
-        # Append out_file and options if they are missing
-        list(LENGTH elements num_elements)
-
-        if (num_elements EQUAL 1)
-            list(GET elements 0 file_name)
-            set(out_name ${file_name})
-            set(option "-DBPF")
-        endif()
-        if (num_elements EQUAL 2)
-            list(GET elements 0 file_name)
-            list(GET elements 1 out_name)
-            set(option "-DBPF")
-        endif()
-        if (num_elements EQUAL 3)
-            list(GET elements 0 file_name)
-            list(GET elements 1 out_name)
-            list(GET elements 2 option)
-        endif()
-
-        cmake_language(CALL ${worker} ${file_name} ${out_name} ${option})
+        # Extract file_name, out_name, and option_list
+        list(GET elements 0 file_name)
+        list(GET elements 1 out_name)
+        list(REMOVE_AT elements 0 1)
+
+        # Build the option_list from the remaining elements
+        set(option_list "")
+        foreach(element IN LISTS elements)
+            list(APPEND option_list "${element}")
+        endforeach()
+
+        message(STATUS "Calling cmake_language(), using: worker=${worker}, file_name=${file_name}, out_name=${out_name}, option_list=${option_list}")
+        cmake_language(CALL ${worker} ${file_name} ${out_name} "${option_list}")
     endforeach()
 endfunction()
 
 find_program(clang_path "clang")
 
-function(build_bpf file_name out_name option)
+function(build_bpf file_name out_name option_list)
     message(STATUS "Building BPF ${out_name}")
 
     set(optimize_flags "-O2")
@@ -74,18 +72,18 @@ function(build_bpf file_name out_name option)
         message(FATAL_ERROR "BPF file ${bpf_file_path} does not exist")
     endif()
 
+    message(STATUS "Calling add_custom_command(), using: ${clang_path} ${option_list} -I ${EBPF_INC_PATH} -I ${CMAKE_CURRENT_BINARY_DIR} -g ${optimize_flags} -target bpf -c ${bpf_file_path} -o ${bpf_obj_file_path}")
     add_custom_command(
         OUTPUT ${bpf_obj_file_path}
-        COMMAND ${clang_path} ${option} -I ${EBPF_INC_PATH} -I ${CMAKE_CURRENT_BINARY_DIR} -g ${optimize_flags} -target bpf -c ${bpf_file_path} -o ${bpf_obj_file_path}
+        COMMAND ${clang_path} ${option_list} -I ${EBPF_INC_PATH} -I ${CMAKE_CURRENT_BINARY_DIR} -g ${optimize_flags} -target bpf -c ${bpf_file_path} -o ${bpf_obj_file_path}
         DEPENDS ${bpf_file_path}
-        COMMENT "Building BPF object ${bpf_obj_file_path}"
+        COMMENT "-- Building BPF object ${bpf_obj_file_path}"
     )
-
     add_custom_target(${out_name}_ELF ALL DEPENDS ${bpf_obj_file_path} SOURCES ${bpf_file_path})
 endfunction()
 
 # Run packages\eBPF-for-Windows\build\native\bin\Convert-BpfToNative.ps1 on each .o file to produce a .sys file
-function(convert_to_native file_name out_name option)
+function(convert_to_native file_name out_name option_list)
     message(STATUS "Converting BPF ${out_name} to native")
 
     set(bpf_obj_file_name ${out_name}.o)
@@ -114,7 +112,6 @@ function(convert_to_native file_name out_name option)
         POST_BUILD
     )
 
-
     # Copy the .sys file to the output directory as part of post build
     add_custom_command(
         OUTPUT ${bpf_sys_file_output_path}
@@ -142,12 +139,12 @@ configure_file(
     ${CMAKE_CURRENT_BINARY_DIR}/bpf.h
 )
 
-process_test_cases("build_bpf")
+process_test_cases("build_bpf" "${test_cases}")
 
 configure_file(
     ${CMAKE_CURRENT_SOURCE_DIR}/tests.yml
     ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/tests.yml COPYONLY)
 
 if (PLATFORM_WINDOWS)
-    process_test_cases("convert_to_native")
+    process_test_cases("convert_to_native" "${test_cases}")
 endif()

bpf/ringbuf.c

@@ -3,16 +3,36 @@
 
 #include "bpf.h"
 
+#if !defined(RB_SIZE)
+#define RB_SIZE (128 * 1024)
+#endif
+
+#if !defined(RECORD_SIZE)
+#define RECORD_SIZE 128
+#endif
+
 struct
 {
     __uint(type, BPF_MAP_TYPE_RINGBUF);
-    __uint(max_entries, 128 * 1024);
-} map SEC(".maps");
+    __uint(max_entries, RB_SIZE);
+} rb_map SEC(".maps");
+
+struct
+{
+    __uint(type, BPF_MAP_TYPE_ARRAY);
+    __type(key, int);
+    __uint(max_entries, 1);
+    __uint(value_size, RECORD_SIZE);
+} buf_map SEC(".maps");
 
 SEC("sockops/bpf_ringbuf_output") int output(void* ctx)
 {
-    char msg[] = "Hello, World!";
-    if (bpf_ringbuf_output(&map, msg, sizeof(msg), 0) < 0) {
+    int key = 0;
+    void* msg = bpf_map_lookup_elem(&buf_map, &key);
+    if (!msg) {
+        return 1;
+    }
+    if (bpf_ringbuf_output(&rb_map, msg, RECORD_SIZE, 0) < 0) {
         return 1;
     } else {
         return 0;

bpf/tests.yml

@@ -481,5 +481,18 @@ tests:
     iteration_count: 10000000
     program_cpu_assignment:
       output: all
-
+
+  - name: BPF_MAP_TYPE_RINGBUF output - 300K entries of 400bytes
+    description: Tests the bpf_ringbuf_output helper writing 300K entries of 400bytes.
+    elf_file: ringbuf_300K_400b.o
+    iteration_count: 300000
+    program_cpu_assignment:
+      output: all
+
+  - name: BPF_MAP_TYPE_RINGBUF output - 100K entries of 1420bytes
+    description: Tests the bpf_ringbuf_output helper writing 100K entries of 1420bytes.
+    elf_file: ringbuf_100K_1420b.o
+    iteration_count: 100000
+    program_cpu_assignment:
+      output: all
   # Add more test cases as needed