Skip to content

Commit 9f16403

Browse files
committed
docs(agents): describe native libs and CodSpeed mode accurately
1 parent 422a221 commit 9f16403

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

AGENTS.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# CLAUDE.md
2-
3-
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
1+
# AGENTS.md
42

53
## Project Overview
64

@@ -88,9 +86,12 @@ The repository combines Maven and Gradle via Gradle's composite build feature:
8886

8987
### CodSpeed Integration Points
9088

91-
1. **Walltime Collection**: Modified JMH fork in `jmh-fork/jmh-core` collects walltime metrics during benchmark execution
92-
2. **JNI Bindings**: Native code hooks (C) for precise instrumentation in `jmh-fork/jmh-core/src/main/java/io/codspeed/`
93-
3. **CI Integration**: GitHub Actions workflows trigger CodSpeed measurement runs on `codspeed-macro` runners
89+
1. **Walltime Collection**: Modified JMH fork in `jmh-fork/jmh-core` collects walltime metrics during benchmark execution. Java-side bindings live in `jmh-fork/jmh-core/src/main/java/io/codspeed/`.
90+
2. **Native libraries**: Bundled under `jmh-fork/jmh-core/`:
91+
- `native-instrument-hooks/`: shared CodSpeed instrument-hooks library (Zig/C) used to talk to the CodSpeed runner
92+
- `native-perf-map-agent/`: perf map agent used for symbolization
93+
3. **CodSpeed mode**: When running under CodSpeed (`isInstrumented`), the JMH fork normalizes the benchmark mode to `AverageTime` and emits raw ops/duration per iteration so the runner can compute its own statistics.
94+
4. **CI Integration**: GitHub Actions workflows trigger CodSpeed measurement runs on `codspeed-macro` runners
9495

9596
### Benchmark Architecture
9697

0 commit comments

Comments
 (0)