Skip to content

Commit 54ce793

Browse files
committed
chore: add doc on the --obj-skip feature to the changelog
1 parent cf0a147 commit 54ce793

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

CODSPEED-CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This file documents changes made to Valgrind for CodSpeed integration, beyond the baseline Valgrind distribution.
44

5+
## Features
6+
57

68
### Callgrind: Inline Function Tracking
79

@@ -81,3 +83,22 @@ cfni=??? ← Leaving inlined function
8183
+1 3
8284
cfn=printf
8385
```
86+
87+
### Callgrind: Object-Level Function Skipping
88+
89+
**Feature**: Added `--obj-skip=<object>` command-line option to exclude entire objects (shared libraries or executables) from profiling.
90+
91+
**Motivation**: When profiling applications, it's often necessary to focus on specific parts of the codebase while excluding standard libraries or third-party dependencies. The existing `--fn-skip=<function>` option works at the function level, but requires listing every function individually. For large libraries with hundreds of functions, this becomes impractical. The `--obj-skip` option allows skipping all functions from a given object file in one command.
92+
93+
**Usage**:
94+
```bash
95+
valgrind --tool=callgrind --obj-skip=/lib/x86_64-linux-gnu/libc.so.6 ./your_program
96+
```
97+
98+
Multiple objects can be skipped by repeating the option:
99+
```bash
100+
valgrind --tool=callgrind \
101+
--obj-skip=/lib/x86_64-linux-gnu/libc.so.6 \
102+
--obj-skip=/lib/x86_64-linux-gnu/libpthread.so.0 \
103+
./your_program
104+
```

0 commit comments

Comments
 (0)