]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - tools/perf/Documentation/perf-inject.txt
perf inject: Add Instruction Tracing support
[mirror_ubuntu-bionic-kernel.git] / tools / perf / Documentation / perf-inject.txt
CommitLineData
11d232ec
ACM
1perf-inject(1)
2==============
3
4NAME
5----
6perf-inject - Filter to augment the events stream with additional information
7
8SYNOPSIS
9--------
10[verse]
11'perf inject <options>'
12
13DESCRIPTION
14-----------
15perf-inject reads a perf-record event stream and repipes it to stdout. At any
16point the processing code can inject other events into the event stream - in
17this case build-ids (-b option) are read and injected as needed into the event
18stream.
19
20Build-ids are just the first user of perf-inject - potentially anything that
21needs userspace processing to augment the events stream with additional
22information could make use of this facility.
23
24OPTIONS
25-------
26-b::
27--build-ids=::
28 Inject build-ids into the output stream
29-v::
30--verbose::
31 Be more verbose.
e558a5bd
AV
32-i::
33--input=::
34 Input file name. (default: stdin)
35-o::
36--output=::
37 Output file name. (default: stdout)
26a031e1
AV
38-s::
39--sched-stat::
40 Merge sched_stat and sched_switch for getting events where and how long
41 tasks slept. sched_switch contains a callchain where a task slept and
42 sched_stat contains a timeslice how long a task slept.
11d232ec 43
a7a2b8b4
AH
44--kallsyms=<file>::
45 kallsyms pathname
46
0f0aa5e0
AH
47--itrace::
48 Decode Instruction Tracing data, replacing it with synthesized events.
49 Options are:
50
51 i synthesize instructions events
52 b synthesize branches events
53 c synthesize branches events (calls only)
54 r synthesize branches events (returns only)
55 e synthesize error events
56 d create a debug log
57 g synthesize a call chain for instructions events
58
59 The default is all events i.e. the same as --itrace=ibe
60
61 In addition, the period (default 100000) for instructions events
62 can be specified in units of:
63
64 i instructions
65 t ticks
66 ms milliseconds
67 us microseconds
68 ns nanoseconds (default)
69
70 Also the call chain size (default 16, max. 1024) for instructions
71 events can be specified.
72
11d232ec
ACM
73SEE ALSO
74--------
75linkperf:perf-record[1], linkperf:perf-report[1], linkperf:perf-archive[1]