Skip to content

Commit 6aa0c77

Browse files
d-e-s-oanakryiko
authored andcommitted
readme: Few changes to profile section
Update the section about the profile example in the README, showcasing the updated format and linking to blazesym. Signed-off-by: Daniel Müller <deso@posteo.net>
1 parent 37d0f37 commit 6aa0c77

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -268,25 +268,29 @@ $ sudo cat /sys/kernel/debug/tracing/trace_pipe
268268

269269
## profile
270270

271-
`profile` is an example written in Rust and C with BlazeSym. It
271+
`profile` is an example written in Rust and C using the
272+
[`blazesym`](https://github.com/libbpf/blazesym) symbolization library. It
272273
attaches to perf events, sampling on every processor periodically. It
273-
shows addresses, symbols, file names, and line numbers of stacktraces.
274+
shows addresses, symbols, file names, and line numbers of stacktraces (if
275+
available).
274276

275277
```shell
276278
$ sudo ./target/release/profile
277-
COMM: swapper/6 (pid=0) @ CPU 6
279+
COMM: swapper/2 (pid=0) @ CPU 2
278280
Kernel:
279-
0 [<ffffffff81bdf010>] intel_idle+0x96
280-
1 [<ffffffff819959b0>] cpuidle_enter_state+0x80 /ro/source/drivers/cpuidle/cpuidle.c:238
281-
2 [<ffffffff81995cc9>] cpuidle_enter+0x29 /ro/source/drivers/cpuidle/cpuidle.c:353
282-
3 [<ffffffff810f8c0b>] do_idle+0x1bb /ro/source/kernel/sched/idle.c:243
283-
4 [<ffffffff810f8de9>] cpu_startup_entry+0x19 /ro/source/kernel/sched/idle.c:396
284-
5 [<ffffffff81044f46>] start_secondary+0x116 /ro/source/arch/x86/kernel/smpboot.c:272
285-
6 [<ffffffff810000f5>] secondary_startup_64_no_verify+0xb0 /ro/source/arch/x86/kernel/head_64.S:283
281+
0xffffffffb59141f8: mwait_idle_with_hints.constprop.0 @ 0xffffffffb59141b0+0x48
282+
0xffffffffb5f731ce: intel_idle @ 0xffffffffb5f731b0+0x1e
283+
0xffffffffb5c7bf09: cpuidle_enter_state @ 0xffffffffb5c7be80+0x89
284+
0xffffffffb5c7c309: cpuidle_enter @ 0xffffffffb5c7c2e0+0x29
285+
0xffffffffb516f57c: do_idle @ 0xffffffffb516f370+0x20c
286+
0xffffffffb516f829: cpu_startup_entry @ 0xffffffffb516f810+0x19
287+
0xffffffffb5075bfa: start_secondary @ 0xffffffffb5075ae0+0x11a
288+
0xffffffffb500015a: secondary_startup_64_no_verify @ 0xffffffffb5000075+0xe5
286289
No Userspace Stack
287290
```
288291

289-
C version and Rust version show the same content. Both of them use BlazeSym to symbolize stacktraces.
292+
C version and Rust version show the same content. Both of them use `blazesym`
293+
to symbolize stacktraces.
290294

291295
## sockfilter
292296

0 commit comments

Comments
 (0)