Merge pull request #81 from ilmanzo/pin40

Update to PIN 4.0

Author: ilmanzo

FuncTracer.cpp

@@ -2,19 +2,22 @@
 #include "pin.H"
 #include <iostream>
 #include <fstream>
+#include <sstream>
 #include <unistd.h> // For getpid()
 #include "FuncTracer.hpp"
 
+using namespace std;
+
 // Global set and mutex to track logged functions
-static std::set<std::string> logged_functions;
-static std::mutex log_mutex;
+static set<string> logged_functions;
+static mutex log_mutex;
 
 void log_function_call(const char* img_name, const char* func_name)
 {
-    std::string log_key;
+    string log_key;
     {
-        std::lock_guard<std::mutex> guard(log_mutex);
-        log_key = std::string(img_name) + ":" + func_name;
+        lock_guard<mutex> guard(log_mutex);
+        log_key = string(img_name) + ":" + func_name;
         if (logged_functions.contains(log_key))
             return;
         logged_functions.insert(log_key);
@@ -25,7 +28,7 @@ void log_function_call(const char* img_name, const char* func_name)
     pid = PIN_GetPid();
     PIN_UnlockClient();
 
-    std::ostringstream oss;
+    ostringstream oss;
     oss << "[PID:" << pid << "] [Image:" << img_name << "] [Called:" << func_name << "]\n";
     LOG(oss.str());
 }
@@ -34,7 +37,7 @@ void log_function_call(const char* img_name, const char* func_name)
 // An image is either an executable or a shared library.
 VOID image_load(IMG img, VOID *v)
 {
-    const std::string &image_name = IMG_Name(img);
+    const string &image_name = IMG_Name(img);
     if (!image_is_relevant(image_name)) // Check if the image is relevant for our analysis
     {
         LOG("[Image:" + image_name + "] is not relevant, skipping...\n");
@@ -50,13 +53,13 @@ VOID image_load(IMG img, VOID *v)
         for (RTN rtn = SEC_RtnHead(sec); RTN_Valid(rtn); rtn = RTN_Next(rtn))
         {
             RTN_Open(rtn);
-            const std::string &rtn_name = RTN_Name(rtn);
+            const string &rtn_name = RTN_Name(rtn);
             if (func_is_relevant(rtn_name)) // Check if the function is relevant for our analysis
             {
-                std::stringstream ss;
+                ostringstream oss;
                 // We log the image name and function name so we can see which function is being instrumented.
-                ss << "[Image:" << image_name << "] [Function:" << RTN_Name(rtn) << "]\n";
-                LOG(ss.str());
+                oss << "[Image:" << image_name << "] [Function:" << RTN_Name(rtn) << "]\n";
+                LOG(oss.str());
                 // For each routine, we insert a call to our analysis function `log_function_call`.
                 RTN_InsertCall(rtn, IPOINT_BEFORE, (AFUNPTR)log_function_call,
                                IARG_PTR, image_name.c_str(),
@@ -75,17 +78,16 @@ BOOL follow_child_process(CHILD_PROCESS childProcess, VOID *v)
     return TRUE; // Follow the child
 }
 
-// Pintool entry point
+// Pintool (shared library) entry point
 int main(int argc, char *argv[])
 {
-
     // Initialize PIN symbols. This is required for routine-level instrumentation.
     PIN_InitSymbols();
 
     // Initialize PIN. This must be the first function called.
     if (PIN_Init(argc, argv))
     {
-        std::cerr << "PIN_Init failed" << std::endl;
+        cerr << "PIN_Init failed" << endl;
         return 1;
     }
     // Register the function to be called for every loaded image.
@@ -96,6 +98,6 @@ int main(int argc, char *argv[])
 
     // Start the program, never returns
     PIN_StartProgram();
-
+    assert(false); // We should never reach here
     return 0;
 }

README.md

@@ -18,7 +18,7 @@ To build and run this tool, you'll need:
 - **x86_64 CPU** (other architectures are not supported)
 - `make`
 - **Go language compiler**
-- `g++` version **14** (Pin is not compatible with version 15)
+- `g++` version **15** (or any c++ 2017 )
 - **Catch2 v2** library (optional, only for running the C++ test suite)
   - A copy is provided in `tests/catch2/catch.hpp`
 
@@ -50,7 +50,7 @@ Download and build the project:
 Before building, export the PIN_ROOT environment variable:
 
 ```bash
-export PIN_ROOT=../pin-external-3.31-98869-gfa6f126a8-gcc-linux
+export PIN_ROOT=../pin-external-4.0-99633-g5ca9893f2-gcc-linux
 ```
 
 `PIN_ROOT` should point to the root directory where Intel Pin was extracted.
@@ -74,7 +74,7 @@ coverage. Please compile your target programs with:
 gcc -g -gdwarf-4 main.c
 ```
 
-Pin 3.31 supports DWARF4. Debug info is essential for accurate line mapping.
+Pin 3+ supports DWARF4. Debug info is essential for accurate line mapping.
 
 ## 🧪 Running Unit Tests
 

build.sh

@@ -1,30 +1,8 @@
 #!/bin/bash
 set -euo pipefail
 
-PIN_ARCHIVE="pin-external-3.31-98869-gfa6f126a8-gcc-linux"
+PIN_ARCHIVE="pin-external-4.0-99633-g5ca9893f2-gcc-linux"
 PIN_URL="https://software.intel.com/sites/landingpage/pintool/downloads/${PIN_ARCHIVE}.tar.gz"
-REQUIRED_GCC=14
-
-CXX=""
-GPP_VERSION=""
-
-if command -v g++-14 &>/dev/null; then
-    CXX=$(command -v g++-14)
-else
-    if command -v g++ &>/dev/null; then
-        CXX=$(command -v g++)
-        GPP_VERSION=$($CXX -dumpversion)
-        GPP_MAJOR_VERSION=${GPP_VERSION%%.*}
-        if [[ "$GPP_MAJOR_VERSION" -ne "$REQUIRED_GCC" ]]; then
-            echo "Error: Found $CXX version $GPP_VERSION; required version is $REQUIRED_GCC.*"
-            exit 1
-        fi
-    else
-        echo "Error: g++ 14.* not found in PATH."
-        exit 1
-    fi
-fi
-echo "Using $CXX $GPP_VERSION"
 
 pushd .. > /dev/null
 
@@ -38,12 +16,12 @@ if [[ ! -d "$PIN_ARCHIVE" ]]; then
     exit 1
 fi
 
-PIN_ROOT=$(realpath `ls -d pin*`)
+PIN_ROOT=$(realpath `ls -d $PIN_ARCHIVE`)
 export PIN_ROOT
 popd > /dev/null
-export CXX="$CXX -std=c++20"
 make
 echo "export PIN_ROOT=\"$PIN_ROOT\"" > env
+strip obj-intel64/FuncTracer.so
 
 # Build Go program in cmd folder
 if command -v go &>/dev/null; then
@@ -57,9 +35,3 @@ else
 fi
 
 
-
-# Optional: Build and run the example
-# First you have to set PIN_ENV generated in `env`
-#
-# pushd example && make && popd
-# "$PIN_ROOT/pin" -t ./obj-intel64/FuncTracer.so -- example/cov_sample 7 3

cmd/funkoverage.go

@@ -8,7 +8,7 @@ import (
 	"strings"
 )
 
-const versionString = "0.4.5"
+const versionString = "0.5.0"
 
 // --- CLI ---
 

cmd/wrapunwrap.go

@@ -141,7 +141,7 @@ timestamp=$(date "+%%Y%%m%%d-%%H%%M%%S")
 nano_seconds=$(date "+%%N")
 log_file="$LOG_DIR/${binary_name}_${timestamp}_${nano_seconds}.log"
 
-exec "$PIN_ROOT/pin" -t "$PIN_TOOL" -logfile "$log_file" -- "$ORIGINAL_BINARY" "$@"
+exec "$PIN_ROOT/pin" -follow_execv -t "$PIN_TOOL" -logfile "$log_file" -- "$ORIGINAL_BINARY" "$@"
 `, wrapperIDComment, time.Now().Format(time.RFC3339), movedBinaryPath, PIN_ROOT, pinTool, LOG_DIR, movedBinaryPath)
 	if err := os.WriteFile(targetBinary, []byte(wrapperScript), 0755); err != nil {
 		return err

makefile.rules

@@ -83,4 +83,6 @@ SANITY_SUBSET := $(TEST_TOOL_ROOTS) $(TEST_ROOTS)
 
 # This section contains the build rules for all binaries that have special build rules.
 # See makefile.default.rules for the default build rules.
+#
+TOOL_CXXFLAGS += -std=c++20