feat: add the tracegrind tool

.github/workflows/ci.yml

@@ -8,14 +8,18 @@ on:
   workflow_dispatch:
 
 jobs:
-  test-callgrind:
+  test:
+    timeout-minutes: 30
     strategy:
       matrix:
         runner:
           - platform: ubuntu-22.04
             ubuntu-version: 22.04
           - platform: ubuntu-24.04
             ubuntu-version: 24.04
+        tool:
+          - callgrind
+          - tracegrind
 
     runs-on: ${{ matrix.runner.platform }}
 
@@ -32,7 +36,7 @@ jobs:
           path-exclude /usr/share/man/*
           path-exclude /usr/share/info/*
           EOF
-          
+
       - name: Update apt-get cache
         run: sudo apt-get update
 
@@ -51,6 +55,10 @@ jobs:
             docbook-xml \
             xsltproc
 
+      - name: Install uv
+        if: matrix.tool == 'tracegrind'
+        uses: astral-sh/setup-uv@v7
+
       - name: Run autogen
         run: ./autogen.sh
 
@@ -63,17 +71,17 @@ jobs:
       - name: Build test dependencies
         run: |
           make -C tests arch_test os_test true
-          make -C callgrind/tests check
+          make -C ${{ matrix.tool }}/tests check
 
-      - name: Run Callgrind tests
+      - name: Run tests
         run: |
-          cd callgrind/tests
+          cd ${{ matrix.tool }}/tests
           TESTS=$(ls *.vgtest | grep -v bug497723.vgtest)
           perl ../../tests/vg_regtest --valgrind=../../vg-in-place $TESTS
 
       - name: Upload test logs
         if: failure()
         uses: actions/upload-artifact@v4
         with:
-          name: callgrind-test-logs-${{ matrix.runner.ubuntu-version }}
-          path: callgrind/tests/*.log
+          name: ${{ matrix.tool }}-test-logs-${{ matrix.runner.ubuntu-version }}
+          path: ${{ matrix.tool }}/tests/*.log

.gitignore

@@ -10,13 +10,16 @@
 /autom4te.cache
 /bin
 /cachegrind.out.*
+/callgrind.out.*
+/tracegrind.out.*
 /compile
 /config.guess
 /config.h*
 /config.log
 /config.status
 /config.sub
 /configure
+/configure~
 /default.supp
 /depcomp
 /glibc-2.X.supp
@@ -161,6 +164,31 @@
 /callgrind/tests/inline-samefile
 /callgrind/tests/inline-crossfile
 
+# /tracegrind/
+/tracegrind/*.so
+/tracegrind/.deps
+/tracegrind/tracegrind-*-darwin
+/tracegrind/tracegrind-*-linux
+/tracegrind/tracegrind-*-solaris
+/tracegrind/tracegrind-*-freebsd
+/tracegrind/Makefile
+/tracegrind/Makefile.in
+
+# /tracegrind/tests/
+/tracegrind/tests/*.dSYM
+/tracegrind/tests/*.post.diff*
+/tracegrind/tests/*.post.out
+/tracegrind/tests/*.stderr.diff*
+/tracegrind/tests/*.stderr.out
+/tracegrind/tests/*.stdout.diff*
+/tracegrind/tests/*.stdout.out
+/tracegrind/tests/.deps
+/tracegrind/tests/Makefile
+/tracegrind/tests/Makefile.in
+/tracegrind/tests/tracegrind.out.*
+/tracegrind/tests/fibo
+/tracegrind/tests/*.bin
+
 # /coregrind/
 /coregrind/*.a
 /coregrind/*.dSYM

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v14.0.6
+    hooks:
+      - id: clang-format
+        files: ^tracegrind/
+        types_or: [c, c++]

Makefile.am

@@ -9,6 +9,7 @@ TOOLS = \
 		memcheck \
 		cachegrind \
 		callgrind \
+		tracegrind \
 		helgrind \
 		drd \
 		massif \

bench/bench.py

@@ -41,16 +41,33 @@ def __init__(
             raise RuntimeError(f"Valgrind not found at: {self.valgrind_path}")
         self.valgrind_version = result.stdout.strip()
 
-    def run_valgrind(self, *args: str) -> None:
-        """Execute valgrind with given arguments.
+        # Check which tools are available
+        self.available_tools = self._detect_available_tools()
+
+    def _detect_available_tools(self) -> set:
+        """Detect which valgrind tools are available."""
+        tools = set()
+        for tool in ["callgrind", "tracegrind"]:
+            result = subprocess.run(
+                [self.valgrind_path, f"--tool={tool}", "--help"],
+                capture_output=True,
+                text=True,
+            )
+            if result.returncode == 0:
+                tools.add(tool)
+        return tools
+
+    def run_valgrind(self, tool: str, *args: str) -> None:
+        """Execute valgrind with given tool and arguments.
 
         Args:
+            tool: Valgrind tool to use (callgrind, tracegrind)
             *args: Valgrind arguments
         """
 
         cmd = [
             self.valgrind_path,
-            "--tool=callgrind",
+            f"--tool={tool}",
             "--log-file=/dev/null",
             *args,
             *shlex.split(self.cmd),
@@ -75,76 +92,119 @@ def runner(request):
     return request.config._valgrind_runner
 
 
+CACHE_SIM_OPTIONS = [
+    "--cache-sim=yes",
+    "--I1=32768,8,64",
+    "--D1=32768,8,64",
+    "--LL=8388608,16,64",
+]
+
 def pytest_generate_tests(metafunc):
     """Parametrize tests with valgrind configurations."""
-    if "valgrind_args" in metafunc.fixturenames:
+    if "tool_and_args" in metafunc.fixturenames:
         runner = getattr(metafunc.config, "_valgrind_runner", None)
         if not runner:
             return
 
-        # Define valgrind configurations
-        configs = [
-            (["--read-inline-info=no"], "no-inline"),
-            (["--read-inline-info=yes"], "inline"),
+        # Define configurations for each tool
+        # Format: (tool, args, config_name)
+        all_configs = [
+            # Callgrind configurations
+            ("callgrind", ["--read-inline-info=no"], "cg/no-inline"),
+            ("callgrind", ["--read-inline-info=yes"], "cg/inline"),
             (
+                "callgrind",
                 [
+                    *CACHE_SIM_OPTIONS,
                     "--trace-children=yes",
-                    "--cache-sim=yes",
-                    "--I1=32768,8,64",
-                    "--D1=32768,8,64",
-                    "--LL=8388608,16,64",
                     "--collect-systime=nsec",
                     "--compress-strings=no",
                     "--combine-dumps=yes",
                     "--dump-line=no",
                     "--read-inline-info=yes",
                 ],
-                "full-with-inline",
+                "cg/full-inline",
             ),
             (
+                "callgrind",
                 [
+                    *CACHE_SIM_OPTIONS,
                     "--trace-children=yes",
-                    "--cache-sim=yes",
-                    "--I1=32768,8,64",
-                    "--D1=32768,8,64",
-                    "--LL=8388608,16,64",
                     "--collect-systime=nsec",
                     "--compress-strings=no",
                     "--combine-dumps=yes",
                     "--dump-line=no",
+                    "--read-inline-info=no",
+                ],
+                "cg/full-no-inline",
+            ),
+            # Tracegrind configurations (only available in codspeed fork)
+            ("tracegrind", ["--read-inline-info=no"], "tg/no-inline"),
+            ("tracegrind", ["--read-inline-info=yes"], "tg/inline"),
+            (
+                "tracegrind",
+                [
+                    *CACHE_SIM_OPTIONS,
+                    "--trace-children=yes",
+                    "--collect-systime=nsec",
+                    "--read-inline-info=no",
                 ],
-                "full-no-inline",
+                "tg/full-no-inline",
+            ),
+            (
+                "tracegrind",
+                [
+                    *CACHE_SIM_OPTIONS,
+                    "--trace-children=yes",
+                    "--collect-systime=nsec",
+                    "--read-inline-info=yes",
+                ],
+                "tg/full-inline",
             ),
         ]
 
+        # Filter configs to only include available tools
+        configs = [
+            (tool, args, name)
+            for tool, args, name in all_configs
+            if tool in runner.available_tools
+        ]
+
+        if not configs:
+            return
+
         # If the valgrind version is from CodSpeed, we don't want to display the exact version
-        # to allow comparison against older versions. 
+        # to allow comparison against older versions.
         if ".codspeed" in runner.valgrind_version:
-            runner.valgrind_version = "valgrind.codspeed"
+            runner.valgrind_version = "codspeed"
+        # Clean valgrind version names
+        else:
+            runner.valgrind_version.removeprefix("valgrind-")
 
         # Create test IDs with format: valgrind-version, command, config-name
         test_ids = [
-            f"{runner.valgrind_version}, {runner.cmd}, {config_name}"
-            for _, config_name in configs
+            f"{runner.valgrind_version}/{config_name}, {runner.cmd}"
+            for _, _, config_name in configs
         ]
 
-        # Parametrize with just the args
+        # Parametrize with (tool, args) tuples
         metafunc.parametrize(
-            "valgrind_args",
-            [args for args, _ in configs],
+            "tool_and_args",
+            [(tool, args) for tool, args, _ in configs],
             ids=test_ids,
         )
 
 
 @pytest.mark.benchmark
-def test_valgrind(runner, valgrind_args):
+def test_valgrind(runner, tool_and_args):
     if runner:
-        runner.run_valgrind(*valgrind_args)
+        tool, args = tool_and_args
+        runner.run_valgrind(tool, *args)
 
 
 def main():
     parser = argparse.ArgumentParser(
-        description="Benchmark Valgrind with pytest-codspeed",
+        description="Benchmark Valgrind tools (callgrind, tracegrind) with pytest-codspeed",
         formatter_class=argparse.RawDescriptionHelpFormatter,
         epilog="""
 Examples:
@@ -179,6 +239,7 @@ def main():
         valgrind_path=args.valgrind_path,
     )
     print(f"Valgrind version: {runner.valgrind_version}")
+    print(f"Available tools: {', '.join(sorted(runner.available_tools))}")
     print(f"Command: {args.cmd}")
 
     # Plugin to pass runner to tests
@@ -187,7 +248,7 @@ def pytest_configure(self, config):
             config._valgrind_runner = runner
 
     exit_code = pytest.main(
-        [__file__, "-v", "--codspeed", "--codspeed-warmup-time=0", "--codspeed-max-time=5"],
+        [__file__, "-v", "--codspeed", "--codspeed-warmup-time=0", "--codspeed-max-time=30"],
         plugins=[RunnerPlugin()],
     )
     if exit_code != 0 and exit_code != 5:

configure.ac

@@ -5807,6 +5807,8 @@ AC_CONFIG_FILES([
    callgrind/callgrind_annotate
    callgrind/callgrind_control
    callgrind/tests/Makefile
+   tracegrind/Makefile
+   tracegrind/tests/Makefile
    helgrind/Makefile
    helgrind/tests/Makefile
    drd/Makefile