1151750ceSArjan van de Venperf-timechart(1)
2151750ceSArjan van de Ven=================
3151750ceSArjan van de Ven
4151750ceSArjan van de VenNAME
5151750ceSArjan van de Ven----
6151750ceSArjan van de Venperf-timechart - Tool to visualize total system behavior during a workload
7151750ceSArjan van de Ven
8151750ceSArjan van de VenSYNOPSIS
9151750ceSArjan van de Ven--------
10151750ceSArjan van de Ven[verse]
11367b3152SStanislav Fomichev'perf timechart' [<timechart options>] {record} [<record options>]
12151750ceSArjan van de Ven
13151750ceSArjan van de VenDESCRIPTION
14151750ceSArjan van de Ven-----------
15151750ceSArjan van de VenThere are two variants of perf timechart:
16151750ceSArjan van de Ven
17151750ceSArjan van de Ven  'perf timechart record <command>' to record the system level events
18b97b59b9SStanislav Fomichev  of an arbitrary workload. By default timechart records only scheduler
19b97b59b9SStanislav Fomichev  and CPU events (task switches, running times, CPU power states, etc),
20b97b59b9SStanislav Fomichev  but it's possible to record IO (disk, network) activity using -I argument.
21151750ceSArjan van de Ven
22151750ceSArjan van de Ven  'perf timechart' to turn a trace into a Scalable Vector Graphics file,
23b97b59b9SStanislav Fomichev  that can be viewed with popular SVG viewers such as 'Inkscape'. Depending
24b97b59b9SStanislav Fomichev  on the events in the perf.data file, timechart will contain scheduler/cpu
25b97b59b9SStanislav Fomichev  events or IO events.
26b97b59b9SStanislav Fomichev
27b97b59b9SStanislav Fomichev  In IO mode, every bar has two charts: upper and lower.
28b97b59b9SStanislav Fomichev  Upper bar shows incoming events (disk reads, ingress network packets).
29b97b59b9SStanislav Fomichev  Lower bar shows outgoing events (disk writes, egress network packets).
30b97b59b9SStanislav Fomichev  There are also poll bars which show how much time application spent
31b97b59b9SStanislav Fomichev  in poll/epoll/select syscalls.
32151750ceSArjan van de Ven
33367b3152SStanislav FomichevTIMECHART OPTIONS
34367b3152SStanislav Fomichev-----------------
35151750ceSArjan van de Ven-o::
36151750ceSArjan van de Ven--output=::
37151750ceSArjan van de Ven        Select the output file (default: output.svg)
38151750ceSArjan van de Ven-i::
39151750ceSArjan van de Ven--input=::
40efad1415SRobert Richter        Select the input file (default: perf.data unless stdin is a fifo)
415094b655SArjan van de Ven-w::
425094b655SArjan van de Ven--width=::
435094b655SArjan van de Ven        Select the width of the SVG file (default: 1000)
44bbe2987bSArjan van de Ven-P::
4539a90a8eSArjan van de Ven--power-only::
4639a90a8eSArjan van de Ven        Only output the CPU power section of the diagram
47c87097d3SStanislav Fomichev-T::
48c87097d3SStanislav Fomichev--tasks-only::
49c87097d3SStanislav Fomichev        Don't output processor state transitions
50bbe2987bSArjan van de Ven-p::
51bbe2987bSArjan van de Ven--process::
52bbe2987bSArjan van de Ven        Select the processes to display, by name or PID
53151750ceSArjan van de Ven
54ec5761eaSDavid Ahern--symfs=<directory>::
55ec5761eaSDavid Ahern        Look for files with symbols relative to this directory.
5654874e32SStanislav Fomichev-n::
5754874e32SStanislav Fomichev--proc-num::
5854874e32SStanislav Fomichev        Print task info for at least given number of tasks.
59c5079997SStanislav Fomichev-t::
60c5079997SStanislav Fomichev--topology::
61c5079997SStanislav Fomichev        Sort CPUs according to topology.
62e57a2dffSStanislav Fomichev--highlight=<duration_nsecs|task_name>::
63e57a2dffSStanislav Fomichev	Highlight tasks (using different color) that run more than given
64e57a2dffSStanislav Fomichev	duration or tasks with given name. If number is given it's interpreted
65e57a2dffSStanislav Fomichev	as number of nanoseconds. If non-numeric string is given it's
66e57a2dffSStanislav Fomichev	interpreted as task name.
6754874e32SStanislav Fomichev
68367b3152SStanislav FomichevRECORD OPTIONS
69367b3152SStanislav Fomichev--------------
70367b3152SStanislav Fomichev-P::
71367b3152SStanislav Fomichev--power-only::
72367b3152SStanislav Fomichev        Record only power-related events
73367b3152SStanislav Fomichev-T::
74367b3152SStanislav Fomichev--tasks-only::
75367b3152SStanislav Fomichev        Record only tasks-related events
76b97b59b9SStanislav Fomichev-I::
77b97b59b9SStanislav Fomichev--io-only::
78b97b59b9SStanislav Fomichev        Record only io-related events
796f8d67faSStanislav Fomichev-g::
806f8d67faSStanislav Fomichev--callchain::
816f8d67faSStanislav Fomichev        Do call-graph (stack chain/backtrace) recording
82367b3152SStanislav Fomichev
83f48e00ceSStanislav FomichevEXAMPLES
84f48e00ceSStanislav Fomichev--------
85f48e00ceSStanislav Fomichev
86f48e00ceSStanislav Fomichev$ perf timechart record git pull
87f48e00ceSStanislav Fomichev
88f48e00ceSStanislav Fomichev  [ perf record: Woken up 13 times to write data ]
89f48e00ceSStanislav Fomichev  [ perf record: Captured and wrote 4.253 MB perf.data (~185801 samples) ]
90f48e00ceSStanislav Fomichev
91f48e00ceSStanislav Fomichev$ perf timechart
92f48e00ceSStanislav Fomichev
93f48e00ceSStanislav Fomichev  Written 10.2 seconds of trace to output.svg.
94f48e00ceSStanislav Fomichev
95f48e00ceSStanislav FomichevRecord system-wide timechart:
96f48e00ceSStanislav Fomichev
97f48e00ceSStanislav Fomichev  $ perf timechart record
98f48e00ceSStanislav Fomichev
99f48e00ceSStanislav Fomichev  then generate timechart and highlight 'gcc' tasks:
100f48e00ceSStanislav Fomichev
101f48e00ceSStanislav Fomichev  $ perf timechart --highlight gcc
102f48e00ceSStanislav Fomichev
103b97b59b9SStanislav FomichevRecord system-wide IO events:
104b97b59b9SStanislav Fomichev
105b97b59b9SStanislav Fomichev  $ perf timechart record -I
106b97b59b9SStanislav Fomichev
107b97b59b9SStanislav Fomichev  then generate timechart:
108b97b59b9SStanislav Fomichev
109b97b59b9SStanislav Fomichev  $ perf timechart
110b97b59b9SStanislav Fomichev
111151750ceSArjan van de VenSEE ALSO
112151750ceSArjan van de Ven--------
113151750ceSArjan van de Venlinkperf:perf-record[1]
114