Merge branch 'linux-4.6' of git://github.com/skeggsb/linux into drm-fixes
[sfrench/cifs-2.6.git] / tools / perf / Documentation / perf-inject.txt
1 perf-inject(1)
2 ==============
3
4 NAME
5 ----
6 perf-inject - Filter to augment the events stream with additional information
7
8 SYNOPSIS
9 --------
10 [verse]
11 'perf inject <options>'
12
13 DESCRIPTION
14 -----------
15 perf-inject reads a perf-record event stream and repipes it to stdout.  At any
16 point the processing code can inject other events into the event stream - in
17 this case build-ids (-b option) are read and injected as needed into the event
18 stream.
19
20 Build-ids are just the first user of perf-inject - potentially anything that
21 needs userspace processing to augment the events stream with additional
22 information could make use of this facility.
23
24 OPTIONS
25 -------
26 -b::
27 --build-ids=::
28         Inject build-ids into the output stream
29 -v::
30 --verbose::
31         Be more verbose.
32 -i::
33 --input=::
34         Input file name. (default: stdin)
35 -o::
36 --output=::
37         Output file name. (default: stdout)
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.
43
44 --kallsyms=<file>::
45         kallsyms pathname
46
47 --itrace::
48         Decode Instruction Tracing data, replacing it with synthesized events.
49         Options are:
50
51 include::itrace.txt[]
52
53 --strip::
54         Use with --itrace to strip out non-synthesized events.
55
56 -j::
57 --jit::
58         Process jitdump files by injecting the mmap records corresponding to jitted
59         functions. This option also generates the ELF images for each jitted function
60         found in the jitdumps files captured in the input perf.data file. Use this option
61         if you are monitoring environment using JIT runtimes, such as Java, DART or V8.
62
63 SEE ALSO
64 --------
65 linkperf:perf-record[1], linkperf:perf-report[1], linkperf:perf-archive[1]