Add a test to ensure the report_stats hook is actually called internally

jbpf_tests/functional/CMakeLists.txt

@@ -31,4 +31,4 @@ add_subdirectory(verifier_extensions)
 add_subdirectory(ctrl_hooks)
 add_subdirectory(helper_functions)
 add_subdirectory(array)
-
+add_subdirectory(report_stats)

jbpf_tests/functional/report_stats/CMakeLists.txt

@@ -0,0 +1,27 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+## report stats hook tests
+set(REPORT_STATS_TESTS ${TESTS_FUNCTIONAL}/report_stats)
+file(GLOB REPORT_STATS_TESTS_SOURCES ${REPORT_STATS_TESTS}/*.c)
+set(JBPF_TESTS ${JBPF_TESTS} PARENT_SCOPE)
+# Loop through each test file and create an executable
+foreach(TEST_FILE ${REPORT_STATS_TESTS_SOURCES})
+  # Get the filename without the path
+  get_filename_component(TEST_NAME ${TEST_FILE} NAME_WE)
+
+  # Create an executable target for the test
+  add_executable(${TEST_NAME} ${TEST_FILE} ${TESTS_COMMON}/jbpf_test_lib.c ${JBPF_HASHMAP_MGMT_SOURCES}) 
+
+  # Link the necessary libraries
+  target_link_libraries(${TEST_NAME} PUBLIC jbpf::core_lib jbpf::logger_lib jbpf::mem_mgmt_lib)
+
+  # Set the include directories
+  target_include_directories(${TEST_NAME} PUBLIC ${JBPF_LIB_HEADER_FILES} ${TEST_HEADER_FILES} ${JBPF_HASHMAP_MGMT_HEADER_FILES})
+
+  # Add the test to the list of tests to be executed
+  add_test(NAME REPORT_STATS_TESTS/${TEST_NAME} COMMAND ${TEST_NAME})
+
+  # Test coverage
+  list(APPEND JBPF_TESTS REPORT_STATS_TESTS/${TEST_NAME})
+  add_clang_format_check(${TEST_NAME} ${TEST_FILE})
+  set(JBPF_TESTS ${JBPF_TESTS} PARENT_SCOPE)
+endforeach()

jbpf_tests/functional/report_stats/report_stats_hook_test.c

@@ -0,0 +1,122 @@
+/*
+ * This test does the following:
+ * 1. It loads a single codelet (C1).
+ * 2. The codelet has a single hook (report_stats) that is called by the agent internally at the interval of
+ * MAINTENANCE_CHECK_INTERVAL (see jbpf_perf.c).
+ * 3. Then we check if the codelet (attached to report_stats hook) has been actually called by the agent. If it has been
+ * called, we should get the output from the codelet.
+ * 4. It uses the LCM IPC API to unload the codelet.
+ */
+
+#include <assert.h>
+#include <semaphore.h>
+#include <fcntl.h>
+#include <sys/wait.h>
+#include <signal.h>
+
+#include "jbpf.h"
+#include "jbpf_agent_common.h"
+#include "jbpf_utils.h"
+
+// Contains the struct and hook definitions
+#include "jbpf_test_def.h"
+
+pid_t cpid = -1;
+
+sem_t sem;
+
+jbpf_io_stream_id_t stream_id_c1 = {
+    .id = {0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0xFF}};
+
+static void
+io_channel_check_output(jbpf_io_stream_id_t* stream_id, void** bufs, int num_bufs, void* ctx)
+{
+    int count = 0;
+    for (int i = 0; i < num_bufs; i++) {
+        if (memcmp(stream_id, &stream_id_c1, sizeof(stream_id_c1)) == 0) {
+            // Output from C1. Check that the counter has the expected value
+            count++;
+        } else {
+            // Unexpected output. Fail the test
+            assert(false);
+        }
+    }
+
+    // This means the report_stats hook has been called
+    if (count > 0) {
+        sem_post(&sem);
+    } else {
+        // we don't get any output from the codelet, meaning the report_stats hook has not been called
+        assert(false);
+    }
+}
+
+int
+main(int argc, char** argv)
+{
+    struct jbpf_codeletset_load_req codeletset_req_c1 = {0};
+    struct jbpf_codeletset_unload_req codeletset_unload_req_c1 = {0};
+    const char* jbpf_path = getenv("JBPF_PATH");
+    struct jbpf_config config = {0};
+
+    jbpf_set_default_config_options(&config);
+    sem_init(&sem, 0, 0);
+
+    config.lcm_ipc_config.has_lcm_ipc_thread = false;
+
+    assert(jbpf_init(&config) == 0);
+
+    // The thread will be calling hooks, so we need to register it
+    jbpf_register_thread();
+
+    // Register a callback to handle the buffers sent from the codelets
+    jbpf_register_io_output_cb(io_channel_check_output);
+
+    // Load the codeletset with codelet C1 in hook "test1"
+
+    // The name of the codeletset
+    strcpy(codeletset_req_c1.codeletset_id.name, "simple_output_codeletset");
+
+    // We have only one codelet in this codeletset
+    codeletset_req_c1.num_codelet_descriptors = 1;
+
+    // The codelet has just one output channel and no shared maps
+    codeletset_req_c1.codelet_descriptor[0].num_in_io_channel = 0;
+    codeletset_req_c1.codelet_descriptor[0].num_out_io_channel = 1;
+
+    // The name of the output map that corresponds to the output channel of the codelet
+    strcpy(codeletset_req_c1.codelet_descriptor[0].out_io_channel[0].name, "output_map");
+    // Link the map to a stream id
+    memcpy(&codeletset_req_c1.codelet_descriptor[0].out_io_channel[0].stream_id, &stream_id_c1, JBPF_STREAM_ID_LEN);
+    // The output channel of the codelet does not have a serializer
+    codeletset_req_c1.codelet_descriptor[0].out_io_channel[0].has_serde = false;
+    codeletset_req_c1.codelet_descriptor[0].num_linked_maps = 0;
+
+    // The path of the codelet
+    assert(jbpf_path != NULL);
+    snprintf(
+        codeletset_req_c1.codelet_descriptor[0].codelet_path,
+        JBPF_PATH_LEN,
+        "%s/jbpf_tests/test_files/codelets/simple_output/simple_output.o",
+        jbpf_path);
+    strcpy(codeletset_req_c1.codelet_descriptor[0].codelet_name, "simple_output");
+    strcpy(codeletset_req_c1.codelet_descriptor[0].hook_name, "report_stats");
+
+    // Load the codeletset
+    assert(jbpf_codeletset_load(&codeletset_req_c1, NULL) == JBPF_CODELET_LOAD_SUCCESS);
+
+    // Wait for all the output checks to finish
+    sem_wait(&sem);
+
+    // Unload the codeletsets
+    strcpy(codeletset_unload_req_c1.codeletset_id.name, "simple_output_codeletset");
+    assert(jbpf_codeletset_unload(&codeletset_unload_req_c1, NULL) == JBPF_CODELET_UNLOAD_SUCCESS);
+
+    // Stop
+    jbpf_stop();
+
+    sem_destroy(&sem);
+
+    printf("Test completed successfully.\n");
+    return 0;
+}