diff options
Diffstat (limited to 'tools/perf/Documentation')
-rw-r--r-- | tools/perf/Documentation/perf-sched.txt | 41 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-timechart.txt | 38 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-trace.txt | 25 |
3 files changed, 104 insertions, 0 deletions
diff --git a/tools/perf/Documentation/perf-sched.txt b/tools/perf/Documentation/perf-sched.txt new file mode 100644 index 000000000000..1ce79198997b --- /dev/null +++ b/tools/perf/Documentation/perf-sched.txt | |||
@@ -0,0 +1,41 @@ | |||
1 | perf-sched(1) | ||
2 | ============== | ||
3 | |||
4 | NAME | ||
5 | ---- | ||
6 | perf-sched - Tool to trace/measure scheduler properties (latencies) | ||
7 | |||
8 | SYNOPSIS | ||
9 | -------- | ||
10 | [verse] | ||
11 | 'perf sched' {record|latency|replay|trace} | ||
12 | |||
13 | DESCRIPTION | ||
14 | ----------- | ||
15 | There's four variants of perf sched: | ||
16 | |||
17 | 'perf sched record <command>' to record the scheduling events | ||
18 | of an arbitrary workload. | ||
19 | |||
20 | 'perf sched latency' to report the per task scheduling latencies | ||
21 | and other scheduling properties of the workload. | ||
22 | |||
23 | 'perf sched trace' to see a detailed trace of the workload that | ||
24 | was recorded. | ||
25 | |||
26 | 'perf sched replay' to simulate the workload that was recorded | ||
27 | via perf sched record. (this is done by starting up mockup threads | ||
28 | that mimic the workload based on the events in the trace. These | ||
29 | threads can then replay the timings (CPU runtime and sleep patterns) | ||
30 | of the workload as it occured when it was recorded - and can repeat | ||
31 | it a number of times, measuring its performance.) | ||
32 | |||
33 | OPTIONS | ||
34 | ------- | ||
35 | -D:: | ||
36 | --dump-raw-trace=:: | ||
37 | Display verbose dump of the sched data. | ||
38 | |||
39 | SEE ALSO | ||
40 | -------- | ||
41 | linkperf:perf-record[1] | ||
diff --git a/tools/perf/Documentation/perf-timechart.txt b/tools/perf/Documentation/perf-timechart.txt new file mode 100644 index 000000000000..1c2ed3090cce --- /dev/null +++ b/tools/perf/Documentation/perf-timechart.txt | |||
@@ -0,0 +1,38 @@ | |||
1 | perf-timechart(1) | ||
2 | ================= | ||
3 | |||
4 | NAME | ||
5 | ---- | ||
6 | perf-timechart - Tool to visualize total system behavior during a workload | ||
7 | |||
8 | SYNOPSIS | ||
9 | -------- | ||
10 | [verse] | ||
11 | 'perf timechart' {record} | ||
12 | |||
13 | DESCRIPTION | ||
14 | ----------- | ||
15 | There are two variants of perf timechart: | ||
16 | |||
17 | 'perf timechart record <command>' to record the system level events | ||
18 | of an arbitrary workload. | ||
19 | |||
20 | 'perf timechart' to turn a trace into a Scalable Vector Graphics file, | ||
21 | that can be viewed with popular SVG viewers such as 'Inkscape'. | ||
22 | |||
23 | OPTIONS | ||
24 | ------- | ||
25 | -o:: | ||
26 | --output=:: | ||
27 | Select the output file (default: output.svg) | ||
28 | -i:: | ||
29 | --input=:: | ||
30 | Select the input file (default: perf.data) | ||
31 | -w:: | ||
32 | --width=:: | ||
33 | Select the width of the SVG file (default: 1000) | ||
34 | |||
35 | |||
36 | SEE ALSO | ||
37 | -------- | ||
38 | linkperf:perf-record[1] | ||
diff --git a/tools/perf/Documentation/perf-trace.txt b/tools/perf/Documentation/perf-trace.txt new file mode 100644 index 000000000000..41ed75398ca9 --- /dev/null +++ b/tools/perf/Documentation/perf-trace.txt | |||
@@ -0,0 +1,25 @@ | |||
1 | perf-trace(1) | ||
2 | ============== | ||
3 | |||
4 | NAME | ||
5 | ---- | ||
6 | perf-trace - Read perf.data (created by perf record) and display trace output | ||
7 | |||
8 | SYNOPSIS | ||
9 | -------- | ||
10 | [verse] | ||
11 | 'perf trace' [-i <file> | --input=file] symbol_name | ||
12 | |||
13 | DESCRIPTION | ||
14 | ----------- | ||
15 | This command reads the input file and displays the trace recorded. | ||
16 | |||
17 | OPTIONS | ||
18 | ------- | ||
19 | -D:: | ||
20 | --dump-raw-trace=:: | ||
21 | Display verbose dump of the trace data. | ||
22 | |||
23 | SEE ALSO | ||
24 | -------- | ||
25 | linkperf:perf-record[1] | ||