Skip to content

Commit e800bef

Browse files
committed
docs: add parity benchmark instructions and table to CLAUDE.md
1 parent b247d78 commit e800bef

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,3 +145,37 @@ This SHOULD be run alongside local tests and linting, especially for changes tha
145145
- Modify build configuration
146146
- Add new dependencies
147147
- Change platform-specific code
148+
149+
## Parity Benchmarks
150+
151+
Parity-tagged benchmarks (`// PARITY:`) have evmdb equivalents with
152+
identical parameters for cross-project comparison. Both repos use
153+
identical 32-byte binary keys and 128-byte binary values via
154+
`parity_key`/`parity_value` in `benches/utils.rs`.
155+
156+
```bash
157+
# Run all parity benchmarks (native macOS or Linux)
158+
cargo bench --bench cursor_write -- "cursor_write::put::sync|cursor_write::append::sync"
159+
cargo bench --bench cursor -- "cursor::traverse::iter$"
160+
cargo bench --bench concurrent -- "readers_no_writer|readers_one_writer"
161+
cargo bench --bench scaling -- "sequential_get|random_get|full_iteration|append_ordered_put"
162+
163+
# Cold-read parity benchmarks (Linux only — posix_fadvise is a no-op on macOS)
164+
cargo bench --bench scaling -- "cold_random_get|cold_sequential_scan"
165+
```
166+
167+
### Parity bench list
168+
169+
| Bench | File | evmdb counterpart |
170+
|-------|------|-------------------|
171+
| `cursor_write::put::sync` | cursor_write.rs | write_put_100 |
172+
| `cursor_write::append::sync` | cursor_write.rs | write_put_100_sorted |
173+
| `cursor::traverse::iter` | cursor.rs | cursor_seek_first_iterate |
174+
| `readers_no_writer` | concurrent.rs | readers_no_writer |
175+
| `readers_one_writer` | concurrent.rs | readers_with_writer |
176+
| `sequential_get` | scaling.rs | sequential_get |
177+
| `random_get` | scaling.rs | random_get |
178+
| `full_iteration` | scaling.rs | full_iteration |
179+
| `append_ordered_put` | scaling.rs | put_sorted |
180+
| `cold_random_get` | scaling.rs | cold_random_get |
181+
| `cold_sequential_scan` | scaling.rs | cold_sequential_scan |

0 commit comments

Comments
 (0)