Merge pull request #26 from ilmanzo/split-.cpp-and-.hpp-files-to-improve-c++-testing

move is_func_relevant to header

Author: ilmanzo

FuncTracer.cpp

@@ -2,10 +2,8 @@
 #include "pin.H"
 #include <iostream>
 #include <fstream>
-#include <string>
-#include <set>
-#include <mutex>
 #include <unistd.h> // For getpid()
+#include "Functracer.hpp"
 
 // Global set and mutex to track logged functions
 static std::set<std::string> logged_functions;
@@ -31,21 +29,6 @@ VOID log_function_call(const char* img_name, const char* func_name)
     LOG(ss.str());
 }
 
-// Determine if function name is relevant to us and if it will be logged
-bool func_is_relevant(const std::string_view &func_name)
-{
-    static const std::set<std::string_view> blacklist = {
-        "main", "_init", "_start", ".plt.got"
-    };
-    if (blacklist.contains(func_name))
-        return false;
-
-    // Ignore PLT functions and internal functions (usually prefixed with __)
-    if (func_name.ends_with("@plt") || func_name.starts_with("__"))
-        return false;
-
-    return true;
-}
 
 // Pin calls this function for every image loaded into the process's address space.
 // An image is either an executable or a shared library.

FuncTracer.hpp

@@ -0,0 +1,24 @@
+#ifndef FUNCTRACER_HPP
+#define FUNCTRACER_HPP
+
+#include <string>
+#include <set>
+#include <mutex>
+
+// Determine if function name is relevant to us and if it will be logged
+bool func_is_relevant(const std::string_view &func_name)
+{
+    static const std::set<std::string_view> blacklist = {
+        "main", "_init", "_start", ".plt.got"
+    };
+    if (blacklist.contains(func_name))
+        return false;
+
+    // Ignore PLT functions and internal functions (usually prefixed with __)
+    if (func_name.ends_with("@plt") || func_name.starts_with("__"))
+        return false;
+
+    return true;
+}
+
+#endif // FUNCTRACER_HPP

tests/run_unit_tests.sh

@@ -1,19 +1,16 @@
 #!/bin/bash
 set -e
 
-
 echo "Running Python unit tests..."
 export PIN_ROOT="${PIN_ROOT:-/var/coverage/pin}"
 pushd tests || exit 1
 python3 test_coverage_analyzer.py
 sudo -E python3 test_wrap.py
-popd 
-
 echo "Building and running C++ unit tests..."
-SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 CXXFLAGS=$(pkg-config --cflags catch2 2>/dev/null || echo "")
 LDFLAGS=$(pkg-config --libs catch2 2>/dev/null || echo "")
-g++ -std=c++11 $CXXFLAGS "$SCRIPT_DIR/test_func_tracer.cpp" $LDFLAGS -o "$SCRIPT_DIR/test_func_tracer"
-"$SCRIPT_DIR/test_func_tracer"
+g++ -std=c++20 $CXXFLAGS test_func_tracer.cpp $LDFLAGS -o "test_func_tracer"
+./test_func_tracer && rm -f test_func_tracer
+popd 
 
 echo "All tests passed."

tests/test_func_tracer.cpp

@@ -1,82 +1,31 @@
 #define CATCH_CONFIG_MAIN
 #include "catch2/catch.hpp"
-#include <string>
-#include <set>
-#include <mutex>
+#include "../FuncTracer.hpp"
 
-// Updated is_Relevant logic (returns true if function is relevant, i.e., NOT blacklisted)
-bool is_Relevant(const std::string& func_name) {
-    static const std::set<std::string> blacklist = {
-        "main", "_init", "_start", ".plt.got"
-    };
-    if (func_name.length() >= 4 && func_name.compare(func_name.length() - 4, 4, "@plt") == 0) return false;
-    if (func_name.length() >= 2 && func_name.compare(0, 2, "__") == 0) return false;
-    return (blacklist.find(func_name) == blacklist.end());
-}
-
-// Deduplication logic for testing
-static std::set<std::string> logged_functions;
-static std::mutex log_mutex;
-
-bool log_function_call_test(const char* img_name, const char* func_name)
-{
-    std::string key = std::string(img_name) + ":" + std::string(func_name);
-    {
-        std::lock_guard<std::mutex> guard(log_mutex);
-        if (logged_functions.find(key) != logged_functions.end())
-            return false; // Already logged, skip
-        logged_functions.insert(key);
-    }
-    return true; // Logged for the first time
-}
-
-TEST_CASE("is_Relevant works as expected") {
+TEST_CASE("func_is_relevant works as expected") {
     SECTION("PLT functions are not relevant") {
-        REQUIRE_FALSE(is_Relevant("foo@plt"));
-        REQUIRE_FALSE(is_Relevant("bar@plt"));
+        REQUIRE_FALSE(func_is_relevant("foo@plt"));
+        REQUIRE_FALSE(func_is_relevant("bar@plt"));
     }
     SECTION("Functions starting with __ are not relevant") {
-        REQUIRE_FALSE(is_Relevant("__internal"));
-        REQUIRE_FALSE(is_Relevant("__something"));
+        REQUIRE_FALSE(func_is_relevant("__internal"));
+        REQUIRE_FALSE(func_is_relevant("__something"));
     }
     SECTION("Explicit blacklist") {
-        REQUIRE_FALSE(is_Relevant("main"));
-        REQUIRE_FALSE(is_Relevant("_init"));
-        REQUIRE_FALSE(is_Relevant("_start"));
-        REQUIRE_FALSE(is_Relevant(".plt.got"));
+        REQUIRE_FALSE(func_is_relevant("main"));
+        REQUIRE_FALSE(func_is_relevant("_init"));
+        REQUIRE_FALSE(func_is_relevant("_start"));
+        REQUIRE_FALSE(func_is_relevant(".plt.got"));
     }
     SECTION("Normal functions are relevant") {
-        REQUIRE(is_Relevant("foo"));
-        REQUIRE(is_Relevant("bar"));
-        REQUIRE(is_Relevant("baz"));
+        REQUIRE(func_is_relevant("foo"));
+        REQUIRE(func_is_relevant("bar"));
+        REQUIRE(func_is_relevant("baz"));
     }
     SECTION("Short names are relevant") {
-        REQUIRE(is_Relevant("a"));
-        REQUIRE(is_Relevant("b@p"));
-        REQUIRE(is_Relevant("_m"));
+        REQUIRE(func_is_relevant("a"));
+        REQUIRE(func_is_relevant("b@p"));
+        REQUIRE(func_is_relevant("_m"));
     }
 }
 
-TEST_CASE("log_function_call deduplicates function calls") {
-    // Clear the set before testing
-    logged_functions.clear();
-
-    SECTION("First call logs, second call skips") {
-        REQUIRE(log_function_call_test("img1", "funcA") == true);  // First call, should log
-        REQUIRE(log_function_call_test("img1", "funcA") == false); // Second call, should skip
-    }
-
-    SECTION("Different functions are logged separately") {
-        REQUIRE(log_function_call_test("img1", "funcB") == true);
-        REQUIRE(log_function_call_test("img1", "funcC") == true);
-        REQUIRE(log_function_call_test("img1", "funcB") == false);
-        REQUIRE(log_function_call_test("img1", "funcC") == false);
-    }
-
-    SECTION("Same function name in different images are logged separately") {
-        REQUIRE(log_function_call_test("img1", "funcD") == true);
-        REQUIRE(log_function_call_test("img2", "funcD") == true);
-        REQUIRE(log_function_call_test("img1", "funcD") == false);
-        REQUIRE(log_function_call_test("img2", "funcD") == false);
-    }
-}