xref: /linux/tools/perf/Documentation/perf-trace.txt (revision b7d3622a39fde7658170b7f3cf6c6889bb8db30d)
1perf-trace(1)
2=============
3
4NAME
5----
6perf-trace - strace inspired tool
7
8SYNOPSIS
9--------
10[verse]
11'perf trace'
12'perf trace record'
13
14DESCRIPTION
15-----------
16This command will show the events associated with the target, initially
17syscalls, but other system events like pagefaults, task lifetime events,
18scheduling events, etc.
19
20This is a live mode tool in addition to working with perf.data files like
21the other perf tools. Files can be generated using the 'perf record' command
22but the session needs to include the raw_syscalls events (-e 'raw_syscalls:*').
23Alernatively, the 'perf trace record' can be used as a shortcut to
24automatically include the raw_syscalls events when writing events to a file.
25
26The following options apply to perf trace; options to perf trace record are
27found in the perf record man page.
28
29OPTIONS
30-------
31
32-a::
33--all-cpus::
34        System-wide collection from all CPUs.
35
36-e::
37--expr::
38	List of events to show, currently only syscall names.
39	Prefixing with ! shows all syscalls but the ones specified.  You may
40	need to escape it.
41
42-o::
43--output=::
44	Output file name.
45
46-p::
47--pid=::
48	Record events on existing process ID (comma separated list).
49
50-t::
51--tid=::
52        Record events on existing thread ID (comma separated list).
53
54-u::
55--uid=::
56        Record events in threads owned by uid. Name or number.
57
58-v::
59--verbose=::
60        Verbosity level.
61
62-i::
63--no-inherit::
64	Child tasks do not inherit counters.
65
66-m::
67--mmap-pages=::
68	Number of mmap data pages (must be a power of two) or size
69	specification with appended unit character - B/K/M/G. The
70	size is rounded up to have nearest pages power of two value.
71
72-C::
73--cpu::
74Collect samples only on the list of CPUs provided. Multiple CPUs can be provided as a
75comma-separated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2.
76In per-thread mode with inheritance mode on (default), Events are captured only when
77the thread executes on the designated CPUs. Default is to monitor all CPUs.
78
79--duration:
80	Show only events that had a duration greater than N.M ms.
81
82--sched:
83	Accrue thread runtime and provide a summary at the end of the session.
84
85-i
86--input
87	Process events from a given perf data file.
88
89-T
90--time
91	Print full timestamp rather time relative to first sample.
92
93--comm::
94        Show process COMM right beside its ID, on by default, disable with --no-comm.
95
96-s::
97--summary::
98	Show only a summary of syscalls by thread with min, max, and average times
99    (in msec) and relative stddev.
100
101-S::
102--with-summary::
103	Show all syscalls followed by a summary by thread with min, max, and
104    average times (in msec) and relative stddev.
105
106--tool_stats::
107	Show tool stats such as number of times fd->pathname was discovered thru
108	hooking the open syscall return + vfs_getname or via reading /proc/pid/fd, etc.
109
110SEE ALSO
111--------
112linkperf:perf-record[1], linkperf:perf-script[1]
113