|
| 1 | +#!/usr/bin/env python3 |
| 2 | +# /// script |
| 3 | +# requires-python = ">=3.9" |
| 4 | +# dependencies = [ |
| 5 | +# "pytest>=8.0", |
| 6 | +# "pytest-codspeed>=4.2.0", |
| 7 | +# ] |
| 8 | +# /// |
| 9 | + |
| 10 | +import argparse |
| 11 | +import os |
| 12 | +import subprocess |
| 13 | +from pathlib import Path |
| 14 | + |
| 15 | +import pytest |
| 16 | + |
| 17 | + |
| 18 | +class ValgrindRunner: |
| 19 | + """Run Valgrind with different configurations.""" |
| 20 | + |
| 21 | + def __init__( |
| 22 | + self, |
| 23 | + binary_path: str, |
| 24 | + valgrind_path: str = "valgrind", |
| 25 | + output_dir: str = "/tmp", |
| 26 | + ): |
| 27 | + """Initialize valgrind runner. |
| 28 | +
|
| 29 | + Args: |
| 30 | + binary_path: Path to the binary to profile |
| 31 | + valgrind_path: Path to valgrind executable |
| 32 | + output_dir: Directory for callgrind output files |
| 33 | + """ |
| 34 | + self.binary_path = Path(binary_path) |
| 35 | + self.valgrind_path = valgrind_path |
| 36 | + self.output_dir = Path(output_dir) |
| 37 | + self.output_dir.mkdir(parents=True, exist_ok=True) |
| 38 | + |
| 39 | + if not self.binary_path.exists(): |
| 40 | + raise FileNotFoundError(f"Binary not found: {self.binary_path}") |
| 41 | + |
| 42 | + # Verify valgrind is available |
| 43 | + result = subprocess.run( |
| 44 | + [self.valgrind_path, "--version"], |
| 45 | + capture_output=True, |
| 46 | + text=True, |
| 47 | + ) |
| 48 | + if result.returncode != 0: |
| 49 | + raise RuntimeError(f"Valgrind not found at: {self.valgrind_path}") |
| 50 | + self.valgrind_version = result.stdout.strip() |
| 51 | + |
| 52 | + def run_valgrind(self, *args: str) -> None: |
| 53 | + """Execute valgrind with given arguments. |
| 54 | +
|
| 55 | + Args: |
| 56 | + *args: Valgrind arguments |
| 57 | + """ |
| 58 | + callgrind_output = self.output_dir / f"callgrind.{os.getpid()}" |
| 59 | + |
| 60 | + cmd = [ |
| 61 | + self.valgrind_path, |
| 62 | + "--tool=callgrind", |
| 63 | + f"--callgrind-out-file={callgrind_output}", |
| 64 | + *args, |
| 65 | + str(self.binary_path), |
| 66 | + ] |
| 67 | + |
| 68 | + result = subprocess.run(executable=self.valgrind_path, args=cmd) |
| 69 | + if result.returncode != 0: |
| 70 | + raise RuntimeError( |
| 71 | + f"Valgrind execution failed with code {result.returncode}" |
| 72 | + ) |
| 73 | + |
| 74 | + # Clean up |
| 75 | + if callgrind_output.exists(): |
| 76 | + callgrind_output.unlink() |
| 77 | + |
| 78 | + |
| 79 | +@pytest.fixture |
| 80 | +def runner(request): |
| 81 | + """Fixture to provide runner instance to tests.""" |
| 82 | + return request.config._valgrind_runner |
| 83 | + |
| 84 | + |
| 85 | +@pytest.mark.benchmark |
| 86 | +def test_baseline(runner): |
| 87 | + if runner: |
| 88 | + runner.run_valgrind("--read-inline-info=no") |
| 89 | + |
| 90 | + |
| 91 | +@pytest.mark.benchmark |
| 92 | +def test_with_inline_info(runner): |
| 93 | + if runner: |
| 94 | + runner.run_valgrind("--read-inline-info=yes") |
| 95 | + |
| 96 | + |
| 97 | +@pytest.mark.benchmark |
| 98 | +def test_full_inline(runner): |
| 99 | + if runner: |
| 100 | + args = [ |
| 101 | + "--trace-children=yes", |
| 102 | + "--cache-sim=yes", |
| 103 | + "--I1=32768,8,64", |
| 104 | + "--D1=32768,8,64", |
| 105 | + "--LL=8388608,16,64", |
| 106 | + "--collect-systime=nsec", |
| 107 | + "--compress-strings=no", |
| 108 | + "--combine-dumps=yes", |
| 109 | + "--dump-line=no", |
| 110 | + "--read-inline-info=yes", |
| 111 | + ] |
| 112 | + runner.run_valgrind(*args) |
| 113 | + |
| 114 | + |
| 115 | +@pytest.mark.benchmark |
| 116 | +def test_full(runner): |
| 117 | + if runner: |
| 118 | + args = [ |
| 119 | + "--trace-children=yes", |
| 120 | + "--cache-sim=yes", |
| 121 | + "--I1=32768,8,64", |
| 122 | + "--D1=32768,8,64", |
| 123 | + "--LL=8388608,16,64", |
| 124 | + "--collect-systime=nsec", |
| 125 | + "--compress-strings=no", |
| 126 | + "--combine-dumps=yes", |
| 127 | + "--dump-line=no", |
| 128 | + ] |
| 129 | + runner.run_valgrind(*args) |
| 130 | + |
| 131 | + |
| 132 | +def main(): |
| 133 | + parser = argparse.ArgumentParser( |
| 134 | + description="Benchmark Valgrind with pytest-codspeed", |
| 135 | + formatter_class=argparse.RawDescriptionHelpFormatter, |
| 136 | + epilog=""" |
| 137 | +Examples: |
| 138 | + # Run with default binary |
| 139 | + uv run bench.py --binary-path /path/to/binary |
| 140 | +
|
| 141 | + # Run with custom valgrind installation |
| 142 | + uv run bench.py --binary-path /path/to/binary --valgrind-path /usr/local/bin/valgrind |
| 143 | + """, |
| 144 | + ) |
| 145 | + |
| 146 | + parser.add_argument( |
| 147 | + "--binary-path", |
| 148 | + type=str, |
| 149 | + required=True, |
| 150 | + help="Path to the binary to profile", |
| 151 | + ) |
| 152 | + parser.add_argument( |
| 153 | + "--valgrind-path", |
| 154 | + type=str, |
| 155 | + default="valgrind", |
| 156 | + help="Path to valgrind executable (default: valgrind)", |
| 157 | + ) |
| 158 | + parser.add_argument( |
| 159 | + "--output-dir", |
| 160 | + type=str, |
| 161 | + default="/tmp", |
| 162 | + help="Directory for callgrind files (default: /tmp)", |
| 163 | + ) |
| 164 | + |
| 165 | + args = parser.parse_args() |
| 166 | + |
| 167 | + # Create runner instance |
| 168 | + runner = ValgrindRunner( |
| 169 | + binary_path=args.binary_path, |
| 170 | + valgrind_path=args.valgrind_path, |
| 171 | + output_dir=args.output_dir, |
| 172 | + ) |
| 173 | + print(f"Valgrind version: {runner.valgrind_version}") |
| 174 | + print(f"Binary: {args.binary_path}") |
| 175 | + |
| 176 | + # Plugin to pass runner to tests |
| 177 | + class RunnerPlugin: |
| 178 | + def pytest_configure(self, config): |
| 179 | + config._valgrind_runner = runner |
| 180 | + |
| 181 | + exit_code = pytest.main( |
| 182 | + [__file__, "-v", "--codspeed"], |
| 183 | + plugins=[RunnerPlugin()], |
| 184 | + ) |
| 185 | + if exit_code != 0 and exit_code != 5: |
| 186 | + print(f"Benchmark execution returned exit code: {exit_code}") |
| 187 | + |
| 188 | + |
| 189 | +if __name__ == "__main__": |
| 190 | + main() |
0 commit comments