[deliverable/linux.git] / tools / perf / Documentation / perf-inject.txt

perf-inject(1)
==============

NAME
----
perf-inject - Filter to augment the events stream with additional information

SYNOPSIS
--------
[verse]
'perf inject <options>'

DESCRIPTION
-----------
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.

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.

OPTIONS
-------
-b::
--build-ids=::
        Inject build-ids into the output stream
-v::
--verbose::
	Be more verbose.
-i::
--input=::
	Input file name. (default: stdin)
-o::
--output=::
	Output file name. (default: stdout)
-s::
--sched-stat::
	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.

--kallsyms=<file>::
	kallsyms pathname

--itrace::
	Decode Instruction Tracing data, replacing it with synthesized events.
	Options are:

include::itrace.txt[]

SEE ALSO
--------
linkperf:perf-record[1], linkperf:perf-report[1], linkperf:perf-archive[1]
Commit	Line	Data
11d232ec ACM	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.
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
60b88d87	51	include::itrace.txt[]
0f0aa5e0	52
11d232ec ACM	53	SEE ALSO
	54	--------
	55	linkperf:perf-record[1], linkperf:perf-report[1], linkperf:perf-archive[1]