1 perf-inject(1) 1 perf-inject(1)
2 ============== 2 ==============
3 3
4 NAME 4 NAME
5 ---- 5 ----
6 perf-inject - Filter to augment the events str 6 perf-inject - Filter to augment the events stream with additional information
7 7
8 SYNOPSIS 8 SYNOPSIS
9 -------- 9 --------
10 [verse] 10 [verse]
11 'perf inject <options>' 11 'perf inject <options>'
12 12
13 DESCRIPTION 13 DESCRIPTION
14 ----------- 14 -----------
15 perf-inject reads a perf-record event stream a 15 perf-inject reads a perf-record event stream and repipes it to stdout. At any
16 point the processing code can inject other eve 16 point the processing code can inject other events into the event stream - in
17 this case build-ids (-b option) are read and i 17 this case build-ids (-b option) are read and injected as needed into the event
18 stream. 18 stream.
19 19
20 Build-ids are just the first user of perf-inje 20 Build-ids are just the first user of perf-inject - potentially anything that
21 needs userspace processing to augment the even 21 needs userspace processing to augment the events stream with additional
22 information could make use of this facility. 22 information could make use of this facility.
23 23
24 OPTIONS 24 OPTIONS
25 ------- 25 -------
26 -b:: 26 -b::
27 --build-ids:: 27 --build-ids::
28 Inject build-ids of DSOs hit by sample !! 28 Inject build-ids into the output stream
29 This means it needs to process all SAM <<
30 29
31 --buildid-all:: !! 30 --buildid-all:
32 Inject build-ids of all DSOs into the !! 31 Inject build-ids of all DSOs into the output stream
33 and skip SAMPLE processing. <<
34 <<
35 --known-build-ids=:: <<
36 Override build-ids to inject using the <<
37 build-id and path. Understands file:// <<
38 from a file, which can be generated wi <<
39 32
40 -v:: 33 -v::
41 --verbose:: 34 --verbose::
42 Be more verbose. 35 Be more verbose.
43 -i:: 36 -i::
44 --input=:: 37 --input=::
45 Input file name. (default: stdin) 38 Input file name. (default: stdin)
46 -o:: 39 -o::
47 --output=:: 40 --output=::
48 Output file name. (default: stdout) 41 Output file name. (default: stdout)
49 -s:: 42 -s::
50 --sched-stat:: 43 --sched-stat::
51 Merge sched_stat and sched_switch for 44 Merge sched_stat and sched_switch for getting events where and how long
52 tasks slept. sched_switch contains a c 45 tasks slept. sched_switch contains a callchain where a task slept and
53 sched_stat contains a timeslice how lo 46 sched_stat contains a timeslice how long a task slept.
54 47
55 -k:: 48 -k::
56 --vmlinux=<file>:: 49 --vmlinux=<file>::
57 vmlinux pathname 50 vmlinux pathname
58 51
59 --ignore-vmlinux:: 52 --ignore-vmlinux::
60 Ignore vmlinux files. 53 Ignore vmlinux files.
61 54
62 --kallsyms=<file>:: 55 --kallsyms=<file>::
63 kallsyms pathname 56 kallsyms pathname
64 57
65 --itrace:: 58 --itrace::
66 Decode Instruction Tracing data, repla 59 Decode Instruction Tracing data, replacing it with synthesized events.
67 Options are: 60 Options are:
68 61
69 include::itrace.txt[] 62 include::itrace.txt[]
70 63
71 --strip:: 64 --strip::
72 Use with --itrace to strip out non-syn 65 Use with --itrace to strip out non-synthesized events.
73 66
74 -j:: 67 -j::
75 --jit:: 68 --jit::
76 Process jitdump files by injecting the 69 Process jitdump files by injecting the mmap records corresponding to jitted
77 functions. This option also generates 70 functions. This option also generates the ELF images for each jitted function
78 found in the jitdumps files captured i 71 found in the jitdumps files captured in the input perf.data file. Use this option
79 if you are monitoring environment usin 72 if you are monitoring environment using JIT runtimes, such as Java, DART or V8.
80 73
81 -f:: 74 -f::
82 --force:: 75 --force::
83 Don't complain, do it. 76 Don't complain, do it.
84 77
85 --vm-time-correlation[=OPTIONS]:: 78 --vm-time-correlation[=OPTIONS]::
86 Some architectures may capture AUX are 79 Some architectures may capture AUX area data which contains timestamps
87 affected by virtualization. This optio 80 affected by virtualization. This option will update those timestamps
88 in place, to correlate with host times 81 in place, to correlate with host timestamps. The in-place update means
89 that an output file is not specified, 82 that an output file is not specified, and instead the input file is
90 modified. The options are architectur 83 modified. The options are architecture specific, except that they may
91 start with "dry-run" which will cause 84 start with "dry-run" which will cause the file to be processed but
92 without updating it. Currently this op 85 without updating it. Currently this option is supported only by
93 Intel PT, refer linkperf:perf-intel-pt 86 Intel PT, refer linkperf:perf-intel-pt[1]
94 87
95 --guest-data=<path>,<pid>[,<time offset>[,<tim 88 --guest-data=<path>,<pid>[,<time offset>[,<time scale>]]::
96 Insert events from a perf.data file re 89 Insert events from a perf.data file recorded in a virtual machine at
97 the same time as the input perf.data f 90 the same time as the input perf.data file was recorded on the host.
98 The Process ID (PID) of the QEMU hyper 91 The Process ID (PID) of the QEMU hypervisor process must be provided,
99 and the time offset and time scale (mu 92 and the time offset and time scale (multiplier) will likely be needed
100 to convert guest time stamps into host 93 to convert guest time stamps into host time stamps. For example, for
101 x86 the TSC Offset and Multiplier coul 94 x86 the TSC Offset and Multiplier could be provided for a virtual machine
102 using Linux command line option no-kvm 95 using Linux command line option no-kvmclock.
103 Currently only mmap, mmap2, comm, task 96 Currently only mmap, mmap2, comm, task, context_switch, ksymbol,
104 and text_poke events are inserted, as 97 and text_poke events are inserted, as well as build ID information.
105 The QEMU option -name debug-threads=on 98 The QEMU option -name debug-threads=on is needed so that thread names
106 can be used to determine which thread 99 can be used to determine which thread is running which VCPU. Note
107 libvirt seems to use this by default. 100 libvirt seems to use this by default.
108 When using perf record in the guest, o 101 When using perf record in the guest, option --sample-identifier
109 should be used, and also --buildid-all 102 should be used, and also --buildid-all and --switch-events may be
110 useful. 103 useful.
111 104
112 :GMEXAMPLECMD: inject 105 :GMEXAMPLECMD: inject
113 :GMEXAMPLESUBCMD: 106 :GMEXAMPLESUBCMD:
114 include::guestmount.txt[] 107 include::guestmount.txt[]
115 108
116 SEE ALSO 109 SEE ALSO
117 -------- 110 --------
118 linkperf:perf-record[1], linkperf:perf-report[ 111 linkperf:perf-record[1], linkperf:perf-report[1], linkperf:perf-archive[1],
119 linkperf:perf-intel-pt[1] 112 linkperf:perf-intel-pt[1]
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.