'\" t
.\"     Title: perf-inject
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\"      Date: 2019-10-02
.\"    Manual: perf Manual
.\"    Source: perf
.\"  Language: English
.\"
.TH "PERF_5.3\-INJECT" "1" "2019-10-02" "perf" "perf Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
perf\-inject \- Filter to augment the events stream with additional information
.SH "SYNOPSIS"
.sp
.sp
.nf
\fIperf inject <options>\fP
.fi
.br
.SH "DESCRIPTION"
.sp
perf\-inject reads a perf\-record event stream and repipes it to stdout.  At any
point the processing code can inject other events into the event stream \- in
this case build\-ids (\-b option) are read and injected as needed into the event
stream.
.sp
Build\-ids are just the first user of perf\-inject \- potentially anything that
needs userspace processing to augment the events stream with additional
information could make use of this facility.
.SH "OPTIONS"
.sp
\-b, \-\-build\-ids=
.RS 4
Inject build\-ids into the output stream
.RE
.sp
\-v, \-\-verbose
.RS 4
Be more verbose.
.RE
.sp
\-i, \-\-input=
.RS 4
Input file name. (default: stdin)
.RE
.sp
\-o, \-\-output=
.RS 4
Output file name. (default: stdout)
.RE
.sp
\-s, \-\-sched\-stat
.RS 4
Merge sched_stat and sched_switch for getting events where and how long
tasks slept. sched_switch contains a callchain where a task slept and
sched_stat contains a timeslice how long a task slept.
.RE
.sp
\-\-kallsyms=<file>
.RS 4
kallsyms pathname
.RE
.sp
\-\-itrace
.RS 4
Decode Instruction Tracing data, replacing it with synthesized events.
Options are:
.sp
.if n .RS 4
.nf
i        synthesize instructions events
b        synthesize branches events
c        synthesize branches events (calls only)
r        synthesize branches events (returns only)
x        synthesize transactions events
w        synthesize ptwrite events
p        synthesize power events
e        synthesize error events
d        create a debug log
g        synthesize a call chain (use with i or x)
l        synthesize last branch entries (use with i or x)
s       skip initial number of events
.fi
.if n .RE
.sp
.if n .RS 4
.nf
The default is all events i.e. the same as \-\-itrace=ibxwpe,
except for perf script where it is \-\-itrace=ce
.fi
.if n .RE
.sp
.if n .RS 4
.nf
In addition, the period (default 100000, except for perf script where it is 1)
for instructions events can be specified in units of:
.fi
.if n .RE
.sp
.if n .RS 4
.nf
i        instructions
t        ticks
ms        milliseconds
us        microseconds
ns        nanoseconds (default)
.fi
.if n .RE
.sp
.if n .RS 4
.nf
Also the call chain size (default 16, max. 1024) for instructions or
transactions events can be specified.
.fi
.if n .RE
.sp
.if n .RS 4
.nf
Also the number of last branch entries (default 64, max. 1024) for
instructions or transactions events can be specified.
.fi
.if n .RE
.sp
.if n .RS 4
.nf
It is also possible to skip events generated (instructions, branches, transactions,
ptwrite, power) at the beginning. This is useful to ignore initialization code.
.fi
.if n .RE
.sp
.if n .RS 4
.nf
\-\-itrace=i0nss1000000
.fi
.if n .RE
.sp
.if n .RS 4
.nf
skips the first million instructions.
.fi
.if n .RE
.RE
.sp
\-\-strip
.RS 4
Use with \-\-itrace to strip out non\-synthesized events.
.RE
.sp
\-j, \-\-jit
.RS 4
Process jitdump files by injecting the mmap records corresponding to jitted
functions. This option also generates the ELF images for each jitted function
found in the jitdumps files captured in the input perf.data file. Use this option
if you are monitoring environment using JIT runtimes, such as Java, DART or V8.
.RE
.sp
\-f, \-\-force
.RS 4
Don\(cqt complain, do it.
.RE
.SH "SEE ALSO"
.sp
perf\-record(1), perf\-report(1), perf\-archive(1)