diff options
Diffstat (limited to 'tools/perf/Documentation')
-rw-r--r-- | tools/perf/Documentation/perf-annotate.txt | 2 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-bench.txt | 8 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-buildid-cache.txt | 4 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-diff.txt | 2 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-inject.txt | 35 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-kmem.txt | 2 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-kvm.txt | 68 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-list.txt | 33 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-probe.txt | 21 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-record.txt | 8 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-sched.txt | 4 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-stat.txt | 4 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-test.txt | 22 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-trace-perl.txt | 6 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-trace-python.txt | 16 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-trace.txt | 2 |
16 files changed, 203 insertions, 34 deletions
diff --git a/tools/perf/Documentation/perf-annotate.txt b/tools/perf/Documentation/perf-annotate.txt index c9dcade06831..5164a655c39f 100644 --- a/tools/perf/Documentation/perf-annotate.txt +++ b/tools/perf/Documentation/perf-annotate.txt | |||
@@ -1,5 +1,5 @@ | |||
1 | perf-annotate(1) | 1 | perf-annotate(1) |
2 | ============== | 2 | ================ |
3 | 3 | ||
4 | NAME | 4 | NAME |
5 | ---- | 5 | ---- |
diff --git a/tools/perf/Documentation/perf-bench.txt b/tools/perf/Documentation/perf-bench.txt index ae525ac5a2ce..a3dbadb26ef5 100644 --- a/tools/perf/Documentation/perf-bench.txt +++ b/tools/perf/Documentation/perf-bench.txt | |||
@@ -1,5 +1,5 @@ | |||
1 | perf-bench(1) | 1 | perf-bench(1) |
2 | ============ | 2 | ============= |
3 | 3 | ||
4 | NAME | 4 | NAME |
5 | ---- | 5 | ---- |
@@ -19,12 +19,12 @@ COMMON OPTIONS | |||
19 | -f:: | 19 | -f:: |
20 | --format=:: | 20 | --format=:: |
21 | Specify format style. | 21 | Specify format style. |
22 | Current available format styles are, | 22 | Current available format styles are: |
23 | 23 | ||
24 | 'default':: | 24 | 'default':: |
25 | Default style. This is mainly for human reading. | 25 | Default style. This is mainly for human reading. |
26 | --------------------- | 26 | --------------------- |
27 | % perf bench sched pipe # with no style specify | 27 | % perf bench sched pipe # with no style specified |
28 | (executing 1000000 pipe operations between two tasks) | 28 | (executing 1000000 pipe operations between two tasks) |
29 | Total time:5.855 sec | 29 | Total time:5.855 sec |
30 | 5.855061 usecs/op | 30 | 5.855061 usecs/op |
@@ -79,7 +79,7 @@ options (20 sender and receiver processes per group) | |||
79 | 79 | ||
80 | Total time:0.308 sec | 80 | Total time:0.308 sec |
81 | 81 | ||
82 | % perf bench sched messaging -t -g 20 # be multi-thread,with 20 groups | 82 | % perf bench sched messaging -t -g 20 # be multi-thread, with 20 groups |
83 | (20 sender and receiver threads per group) | 83 | (20 sender and receiver threads per group) |
84 | (20 groups == 800 threads run) | 84 | (20 groups == 800 threads run) |
85 | 85 | ||
diff --git a/tools/perf/Documentation/perf-buildid-cache.txt b/tools/perf/Documentation/perf-buildid-cache.txt index 88bc3b519746..5d1a9500277f 100644 --- a/tools/perf/Documentation/perf-buildid-cache.txt +++ b/tools/perf/Documentation/perf-buildid-cache.txt | |||
@@ -8,7 +8,7 @@ perf-buildid-cache - Manage build-id cache. | |||
8 | SYNOPSIS | 8 | SYNOPSIS |
9 | -------- | 9 | -------- |
10 | [verse] | 10 | [verse] |
11 | 'perf buildid-list <options>' | 11 | 'perf buildid-cache <options>' |
12 | 12 | ||
13 | DESCRIPTION | 13 | DESCRIPTION |
14 | ----------- | 14 | ----------- |
@@ -30,4 +30,4 @@ OPTIONS | |||
30 | 30 | ||
31 | SEE ALSO | 31 | SEE ALSO |
32 | -------- | 32 | -------- |
33 | linkperf:perf-record[1], linkperf:perf-report[1] | 33 | linkperf:perf-record[1], linkperf:perf-report[1], linkperf:perf-buildid-list[1] |
diff --git a/tools/perf/Documentation/perf-diff.txt b/tools/perf/Documentation/perf-diff.txt index 8974e208cba6..20d97d84ea1c 100644 --- a/tools/perf/Documentation/perf-diff.txt +++ b/tools/perf/Documentation/perf-diff.txt | |||
@@ -1,5 +1,5 @@ | |||
1 | perf-diff(1) | 1 | perf-diff(1) |
2 | ============== | 2 | ============ |
3 | 3 | ||
4 | NAME | 4 | NAME |
5 | ---- | 5 | ---- |
diff --git a/tools/perf/Documentation/perf-inject.txt b/tools/perf/Documentation/perf-inject.txt new file mode 100644 index 000000000000..025630d43cd2 --- /dev/null +++ b/tools/perf/Documentation/perf-inject.txt | |||
@@ -0,0 +1,35 @@ | |||
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. | ||
32 | |||
33 | SEE ALSO | ||
34 | -------- | ||
35 | linkperf:perf-record[1], linkperf:perf-report[1], linkperf:perf-archive[1] | ||
diff --git a/tools/perf/Documentation/perf-kmem.txt b/tools/perf/Documentation/perf-kmem.txt index eac4d852e7cd..a52fcde894c7 100644 --- a/tools/perf/Documentation/perf-kmem.txt +++ b/tools/perf/Documentation/perf-kmem.txt | |||
@@ -1,5 +1,5 @@ | |||
1 | perf-kmem(1) | 1 | perf-kmem(1) |
2 | ============== | 2 | ============ |
3 | 3 | ||
4 | NAME | 4 | NAME |
5 | ---- | 5 | ---- |
diff --git a/tools/perf/Documentation/perf-kvm.txt b/tools/perf/Documentation/perf-kvm.txt new file mode 100644 index 000000000000..d004e19fe6d6 --- /dev/null +++ b/tools/perf/Documentation/perf-kvm.txt | |||
@@ -0,0 +1,68 @@ | |||
1 | perf-kvm(1) | ||
2 | =========== | ||
3 | |||
4 | NAME | ||
5 | ---- | ||
6 | perf-kvm - Tool to trace/measure kvm guest os | ||
7 | |||
8 | SYNOPSIS | ||
9 | -------- | ||
10 | [verse] | ||
11 | 'perf kvm' [--host] [--guest] [--guestmount=<path> | ||
12 | [--guestkallsyms=<path> --guestmodules=<path> | --guestvmlinux=<path>]] | ||
13 | {top|record|report|diff|buildid-list} | ||
14 | 'perf kvm' [--host] [--guest] [--guestkallsyms=<path> --guestmodules=<path> | ||
15 | | --guestvmlinux=<path>] {top|record|report|diff|buildid-list} | ||
16 | |||
17 | DESCRIPTION | ||
18 | ----------- | ||
19 | There are a couple of variants of perf kvm: | ||
20 | |||
21 | 'perf kvm [options] top <command>' to generates and displays | ||
22 | a performance counter profile of guest os in realtime | ||
23 | of an arbitrary workload. | ||
24 | |||
25 | 'perf kvm record <command>' to record the performance couinter profile | ||
26 | of an arbitrary workload and save it into a perf data file. If both | ||
27 | --host and --guest are input, the perf data file name is perf.data.kvm. | ||
28 | If there is no --host but --guest, the file name is perf.data.guest. | ||
29 | If there is no --guest but --host, the file name is perf.data.host. | ||
30 | |||
31 | 'perf kvm report' to display the performance counter profile information | ||
32 | recorded via perf kvm record. | ||
33 | |||
34 | 'perf kvm diff' to displays the performance difference amongst two perf.data | ||
35 | files captured via perf record. | ||
36 | |||
37 | 'perf kvm buildid-list' to display the buildids found in a perf data file, | ||
38 | so that other tools can be used to fetch packages with matching symbol tables | ||
39 | for use by perf report. | ||
40 | |||
41 | OPTIONS | ||
42 | ------- | ||
43 | --host=:: | ||
44 | Collect host side performance profile. | ||
45 | --guest=:: | ||
46 | Collect guest side performance profile. | ||
47 | --guestmount=<path>:: | ||
48 | Guest os root file system mount directory. Users mounts guest os | ||
49 | root directories under <path> by a specific filesystem access method, | ||
50 | typically, sshfs. For example, start 2 guest os. The one's pid is 8888 | ||
51 | and the other's is 9999. | ||
52 | #mkdir ~/guestmount; cd ~/guestmount | ||
53 | #sshfs -o allow_other,direct_io -p 5551 localhost:/ 8888/ | ||
54 | #sshfs -o allow_other,direct_io -p 5552 localhost:/ 9999/ | ||
55 | #perf kvm --host --guest --guestmount=~/guestmount top | ||
56 | --guestkallsyms=<path>:: | ||
57 | Guest os /proc/kallsyms file copy. 'perf' kvm' reads it to get guest | ||
58 | kernel symbols. Users copy it out from guest os. | ||
59 | --guestmodules=<path>:: | ||
60 | Guest os /proc/modules file copy. 'perf' kvm' reads it to get guest | ||
61 | kernel module information. Users copy it out from guest os. | ||
62 | --guestvmlinux=<path>:: | ||
63 | Guest os kernel vmlinux. | ||
64 | |||
65 | SEE ALSO | ||
66 | -------- | ||
67 | linkperf:perf-top[1], linkperf:perf-record[1], linkperf:perf-report[1], | ||
68 | linkperf:perf-diff[1], linkperf:perf-buildid-list[1] | ||
diff --git a/tools/perf/Documentation/perf-list.txt b/tools/perf/Documentation/perf-list.txt index 8290b9422668..43e3dd284b90 100644 --- a/tools/perf/Documentation/perf-list.txt +++ b/tools/perf/Documentation/perf-list.txt | |||
@@ -15,6 +15,35 @@ DESCRIPTION | |||
15 | This command displays the symbolic event types which can be selected in the | 15 | This command displays the symbolic event types which can be selected in the |
16 | various perf commands with the -e option. | 16 | various perf commands with the -e option. |
17 | 17 | ||
18 | RAW HARDWARE EVENT DESCRIPTOR | ||
19 | ----------------------------- | ||
20 | Even when an event is not available in a symbolic form within perf right now, | ||
21 | it can be encoded in a per processor specific way. | ||
22 | |||
23 | For instance For x86 CPUs NNN represents the raw register encoding with the | ||
24 | layout of IA32_PERFEVTSELx MSRs (see [Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3B: System Programming Guide] Figure 30-1 Layout | ||
25 | of IA32_PERFEVTSELx MSRs) or AMD's PerfEvtSeln (see [AMD64 Architecture Programmer’s Manual Volume 2: System Programming], Page 344, | ||
26 | Figure 13-7 Performance Event-Select Register (PerfEvtSeln)). | ||
27 | |||
28 | Example: | ||
29 | |||
30 | If the Intel docs for a QM720 Core i7 describe an event as: | ||
31 | |||
32 | Event Umask Event Mask | ||
33 | Num. Value Mnemonic Description Comment | ||
34 | |||
35 | A8H 01H LSD.UOPS Counts the number of micro-ops Use cmask=1 and | ||
36 | delivered by loop stream detector invert to count | ||
37 | cycles | ||
38 | |||
39 | raw encoding of 0x1A8 can be used: | ||
40 | |||
41 | perf stat -e r1a8 -a sleep 1 | ||
42 | perf record -e r1a8 ... | ||
43 | |||
44 | You should refer to the processor specific documentation for getting these | ||
45 | details. Some of them are referenced in the SEE ALSO section below. | ||
46 | |||
18 | OPTIONS | 47 | OPTIONS |
19 | ------- | 48 | ------- |
20 | None | 49 | None |
@@ -22,4 +51,6 @@ None | |||
22 | SEE ALSO | 51 | SEE ALSO |
23 | -------- | 52 | -------- |
24 | linkperf:perf-stat[1], linkperf:perf-top[1], | 53 | linkperf:perf-stat[1], linkperf:perf-top[1], |
25 | linkperf:perf-record[1] | 54 | linkperf:perf-record[1], |
55 | http://www.intel.com/Assets/PDF/manual/253669.pdf[Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3B: System Programming Guide], | ||
56 | http://support.amd.com/us/Processor_TechDocs/24593.pdf[AMD64 Architecture Programmer’s Manual Volume 2: System Programming] | ||
diff --git a/tools/perf/Documentation/perf-probe.txt b/tools/perf/Documentation/perf-probe.txt index 34202b1be0bb..94a258c96a44 100644 --- a/tools/perf/Documentation/perf-probe.txt +++ b/tools/perf/Documentation/perf-probe.txt | |||
@@ -57,6 +57,14 @@ OPTIONS | |||
57 | --force:: | 57 | --force:: |
58 | Forcibly add events with existing name. | 58 | Forcibly add events with existing name. |
59 | 59 | ||
60 | -n:: | ||
61 | --dry-run:: | ||
62 | Dry run. With this option, --add and --del doesn't execute actual | ||
63 | adding and removal operations. | ||
64 | |||
65 | --max-probes:: | ||
66 | Set the maximum number of probe points for an event. Default is 128. | ||
67 | |||
60 | PROBE SYNTAX | 68 | PROBE SYNTAX |
61 | ------------ | 69 | ------------ |
62 | Probe points are defined by following syntax. | 70 | Probe points are defined by following syntax. |
@@ -74,13 +82,22 @@ Probe points are defined by following syntax. | |||
74 | 'EVENT' specifies the name of new event, if omitted, it will be set the name of the probed function. Currently, event group name is set as 'probe'. | 82 | 'EVENT' specifies the name of new event, if omitted, it will be set the name of the probed function. Currently, event group name is set as 'probe'. |
75 | 'FUNC' specifies a probed function name, and it may have one of the following options; '+OFFS' is the offset from function entry address in bytes, ':RLN' is the relative-line number from function entry line, and '%return' means that it probes function return. And ';PTN' means lazy matching pattern (see LAZY MATCHING). Note that ';PTN' must be the end of the probe point definition. In addition, '@SRC' specifies a source file which has that function. | 83 | 'FUNC' specifies a probed function name, and it may have one of the following options; '+OFFS' is the offset from function entry address in bytes, ':RLN' is the relative-line number from function entry line, and '%return' means that it probes function return. And ';PTN' means lazy matching pattern (see LAZY MATCHING). Note that ';PTN' must be the end of the probe point definition. In addition, '@SRC' specifies a source file which has that function. |
76 | It is also possible to specify a probe point by the source line number or lazy matching by using 'SRC:ALN' or 'SRC;PTN' syntax, where 'SRC' is the source file path, ':ALN' is the line number and ';PTN' is the lazy matching pattern. | 84 | It is also possible to specify a probe point by the source line number or lazy matching by using 'SRC:ALN' or 'SRC;PTN' syntax, where 'SRC' is the source file path, ':ALN' is the line number and ';PTN' is the lazy matching pattern. |
77 | 'ARG' specifies the arguments of this probe point. You can use the name of local variable, or kprobe-tracer argument format (e.g. $retval, %ax, etc). | 85 | 'ARG' specifies the arguments of this probe point, (see PROBE ARGUMENT). |
86 | |||
87 | PROBE ARGUMENT | ||
88 | -------------- | ||
89 | Each probe argument follows below syntax. | ||
90 | |||
91 | [NAME=]LOCALVAR|$retval|%REG|@SYMBOL[:TYPE] | ||
92 | |||
93 | 'NAME' specifies the name of this argument (optional). You can use the name of local variable, local data structure member (e.g. var->field, var.field2), or kprobe-tracer argument format (e.g. $retval, %ax, etc). Note that the name of this argument will be set as the last member name if you specify a local data structure member (e.g. field2 for 'var->field1.field2'.) | ||
94 | 'TYPE' casts the type of this argument (optional). If omitted, perf probe automatically set the type based on debuginfo. | ||
78 | 95 | ||
79 | LINE SYNTAX | 96 | LINE SYNTAX |
80 | ----------- | 97 | ----------- |
81 | Line range is descripted by following syntax. | 98 | Line range is descripted by following syntax. |
82 | 99 | ||
83 | "FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]" | 100 | "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]" |
84 | 101 | ||
85 | FUNC specifies the function name of showing lines. 'RLN' is the start line | 102 | FUNC specifies the function name of showing lines. 'RLN' is the start line |
86 | number from function entry line, and 'RLN2' is the end line number. As same as | 103 | number from function entry line, and 'RLN2' is the end line number. As same as |
diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt index fc46c0b40f6e..34e255fc3e2f 100644 --- a/tools/perf/Documentation/perf-record.txt +++ b/tools/perf/Documentation/perf-record.txt | |||
@@ -58,7 +58,7 @@ OPTIONS | |||
58 | 58 | ||
59 | -f:: | 59 | -f:: |
60 | --force:: | 60 | --force:: |
61 | Overwrite existing data file. | 61 | Overwrite existing data file. (deprecated) |
62 | 62 | ||
63 | -c:: | 63 | -c:: |
64 | --count=:: | 64 | --count=:: |
@@ -69,8 +69,8 @@ OPTIONS | |||
69 | Output file name. | 69 | Output file name. |
70 | 70 | ||
71 | -i:: | 71 | -i:: |
72 | --inherit:: | 72 | --no-inherit:: |
73 | Child tasks inherit counters. | 73 | Child tasks do not inherit counters. |
74 | -F:: | 74 | -F:: |
75 | --freq=:: | 75 | --freq=:: |
76 | Profile at this frequency. | 76 | Profile at this frequency. |
@@ -101,7 +101,7 @@ OPTIONS | |||
101 | 101 | ||
102 | -R:: | 102 | -R:: |
103 | --raw-samples:: | 103 | --raw-samples:: |
104 | Collect raw sample records from all opened counters (typically for tracepoint counters). | 104 | Collect raw sample records from all opened counters (default for tracepoint counters). |
105 | 105 | ||
106 | SEE ALSO | 106 | SEE ALSO |
107 | -------- | 107 | -------- |
diff --git a/tools/perf/Documentation/perf-sched.txt b/tools/perf/Documentation/perf-sched.txt index 1ce79198997b..8417644a6166 100644 --- a/tools/perf/Documentation/perf-sched.txt +++ b/tools/perf/Documentation/perf-sched.txt | |||
@@ -12,7 +12,7 @@ SYNOPSIS | |||
12 | 12 | ||
13 | DESCRIPTION | 13 | DESCRIPTION |
14 | ----------- | 14 | ----------- |
15 | There's four variants of perf sched: | 15 | There are four variants of perf sched: |
16 | 16 | ||
17 | 'perf sched record <command>' to record the scheduling events | 17 | 'perf sched record <command>' to record the scheduling events |
18 | of an arbitrary workload. | 18 | of an arbitrary workload. |
@@ -27,7 +27,7 @@ There's four variants of perf sched: | |||
27 | via perf sched record. (this is done by starting up mockup threads | 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 | 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) | 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 | 30 | of the workload as it occurred when it was recorded - and can repeat |
31 | it a number of times, measuring its performance.) | 31 | it a number of times, measuring its performance.) |
32 | 32 | ||
33 | OPTIONS | 33 | OPTIONS |
diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt index 484080dd5b6f..2cab8e8c33d0 100644 --- a/tools/perf/Documentation/perf-stat.txt +++ b/tools/perf/Documentation/perf-stat.txt | |||
@@ -31,8 +31,8 @@ OPTIONS | |||
31 | hexadecimal event descriptor. | 31 | hexadecimal event descriptor. |
32 | 32 | ||
33 | -i:: | 33 | -i:: |
34 | --inherit:: | 34 | --no-inherit:: |
35 | child tasks inherit counters | 35 | child tasks do not inherit counters |
36 | -p:: | 36 | -p:: |
37 | --pid=<pid>:: | 37 | --pid=<pid>:: |
38 | stat events on existing pid | 38 | stat events on existing pid |
diff --git a/tools/perf/Documentation/perf-test.txt b/tools/perf/Documentation/perf-test.txt new file mode 100644 index 000000000000..1c4b5f5b7f71 --- /dev/null +++ b/tools/perf/Documentation/perf-test.txt | |||
@@ -0,0 +1,22 @@ | |||
1 | perf-test(1) | ||
2 | ============ | ||
3 | |||
4 | NAME | ||
5 | ---- | ||
6 | perf-test - Runs sanity tests. | ||
7 | |||
8 | SYNOPSIS | ||
9 | -------- | ||
10 | [verse] | ||
11 | 'perf test <options>' | ||
12 | |||
13 | DESCRIPTION | ||
14 | ----------- | ||
15 | This command does assorted sanity tests, initially thru linked routines but | ||
16 | also will look for a directory with more tests in the form of scripts. | ||
17 | |||
18 | OPTIONS | ||
19 | ------- | ||
20 | -v:: | ||
21 | --verbose:: | ||
22 | Be more verbose. | ||
diff --git a/tools/perf/Documentation/perf-trace-perl.txt b/tools/perf/Documentation/perf-trace-perl.txt index d729cee8d987..ee6525ee6d69 100644 --- a/tools/perf/Documentation/perf-trace-perl.txt +++ b/tools/perf/Documentation/perf-trace-perl.txt | |||
@@ -49,12 +49,10 @@ available as calls back into the perf executable (see below). | |||
49 | As an example, the following perf record command can be used to record | 49 | As an example, the following perf record command can be used to record |
50 | all sched_wakeup events in the system: | 50 | all sched_wakeup events in the system: |
51 | 51 | ||
52 | # perf record -c 1 -f -a -M -R -e sched:sched_wakeup | 52 | # perf record -a -e sched:sched_wakeup |
53 | 53 | ||
54 | Traces meant to be processed using a script should be recorded with | 54 | Traces meant to be processed using a script should be recorded with |
55 | the above options: -c 1 says to sample every event, -a to enable | 55 | the above option: -a to enable system-wide collection. |
56 | system-wide collection, -M to multiplex the output, and -R to collect | ||
57 | raw samples. | ||
58 | 56 | ||
59 | The format file for the sched_wakep event defines the following fields | 57 | The format file for the sched_wakep event defines the following fields |
60 | (see /sys/kernel/debug/tracing/events/sched/sched_wakeup/format): | 58 | (see /sys/kernel/debug/tracing/events/sched/sched_wakeup/format): |
diff --git a/tools/perf/Documentation/perf-trace-python.txt b/tools/perf/Documentation/perf-trace-python.txt index a241aca77184..693be804dd3d 100644 --- a/tools/perf/Documentation/perf-trace-python.txt +++ b/tools/perf/Documentation/perf-trace-python.txt | |||
@@ -1,5 +1,5 @@ | |||
1 | perf-trace-python(1) | 1 | perf-trace-python(1) |
2 | ================== | 2 | ==================== |
3 | 3 | ||
4 | NAME | 4 | NAME |
5 | ---- | 5 | ---- |
@@ -93,7 +93,7 @@ don't care how it exited, so we'll use 'perf record' to record only | |||
93 | the sys_enter events: | 93 | the sys_enter events: |
94 | 94 | ||
95 | ---- | 95 | ---- |
96 | # perf record -c 1 -f -a -M -R -e raw_syscalls:sys_enter | 96 | # perf record -a -e raw_syscalls:sys_enter |
97 | 97 | ||
98 | ^C[ perf record: Woken up 1 times to write data ] | 98 | ^C[ perf record: Woken up 1 times to write data ] |
99 | [ perf record: Captured and wrote 56.545 MB perf.data (~2470503 samples) ] | 99 | [ perf record: Captured and wrote 56.545 MB perf.data (~2470503 samples) ] |
@@ -182,7 +182,7 @@ mean either that the record step recorded event types that it wasn't | |||
182 | really interested in, or the script was run against a trace file that | 182 | really interested in, or the script was run against a trace file that |
183 | doesn't correspond to the script. | 183 | doesn't correspond to the script. |
184 | 184 | ||
185 | The script generated by -g option option simply prints a line for each | 185 | The script generated by -g option simply prints a line for each |
186 | event found in the trace stream i.e. it basically just dumps the event | 186 | event found in the trace stream i.e. it basically just dumps the event |
187 | and its parameter values to stdout. The print_header() function is | 187 | and its parameter values to stdout. The print_header() function is |
188 | simply a utility function used for that purpose. Let's rename the | 188 | simply a utility function used for that purpose. Let's rename the |
@@ -359,7 +359,7 @@ your script: | |||
359 | # cat kernel-source/tools/perf/scripts/python/bin/syscall-counts-record | 359 | # cat kernel-source/tools/perf/scripts/python/bin/syscall-counts-record |
360 | 360 | ||
361 | #!/bin/bash | 361 | #!/bin/bash |
362 | perf record -c 1 -f -a -M -R -e raw_syscalls:sys_enter | 362 | perf record -a -e raw_syscalls:sys_enter |
363 | ---- | 363 | ---- |
364 | 364 | ||
365 | The 'report' script is also a shell script with the same base name as | 365 | The 'report' script is also a shell script with the same base name as |
@@ -449,12 +449,10 @@ available as calls back into the perf executable (see below). | |||
449 | As an example, the following perf record command can be used to record | 449 | As an example, the following perf record command can be used to record |
450 | all sched_wakeup events in the system: | 450 | all sched_wakeup events in the system: |
451 | 451 | ||
452 | # perf record -c 1 -f -a -M -R -e sched:sched_wakeup | 452 | # perf record -a -e sched:sched_wakeup |
453 | 453 | ||
454 | Traces meant to be processed using a script should be recorded with | 454 | Traces meant to be processed using a script should be recorded with |
455 | the above options: -c 1 says to sample every event, -a to enable | 455 | the above option: -a to enable system-wide collection. |
456 | system-wide collection, -M to multiplex the output, and -R to collect | ||
457 | raw samples. | ||
458 | 456 | ||
459 | The format file for the sched_wakep event defines the following fields | 457 | The format file for the sched_wakep event defines the following fields |
460 | (see /sys/kernel/debug/tracing/events/sched/sched_wakeup/format): | 458 | (see /sys/kernel/debug/tracing/events/sched/sched_wakeup/format): |
@@ -584,7 +582,7 @@ files: | |||
584 | flag_str(event_name, field_name, field_value) - returns the string represention corresponding to field_value for the flag field field_name of event event_name | 582 | flag_str(event_name, field_name, field_value) - returns the string represention corresponding to field_value for the flag field field_name of event event_name |
585 | symbol_str(event_name, field_name, field_value) - returns the string represention corresponding to field_value for the symbolic field field_name of event event_name | 583 | symbol_str(event_name, field_name, field_value) - returns the string represention corresponding to field_value for the symbolic field field_name of event event_name |
586 | 584 | ||
587 | The *autodict* function returns a special special kind of Python | 585 | The *autodict* function returns a special kind of Python |
588 | dictionary that implements Perl's 'autovivifying' hashes in Python | 586 | dictionary that implements Perl's 'autovivifying' hashes in Python |
589 | i.e. with autovivifying hashes, you can assign nested hash values | 587 | i.e. with autovivifying hashes, you can assign nested hash values |
590 | without having to go to the trouble of creating intermediate levels if | 588 | without having to go to the trouble of creating intermediate levels if |
diff --git a/tools/perf/Documentation/perf-trace.txt b/tools/perf/Documentation/perf-trace.txt index 8879299cd9df..122ec9dc4853 100644 --- a/tools/perf/Documentation/perf-trace.txt +++ b/tools/perf/Documentation/perf-trace.txt | |||
@@ -1,5 +1,5 @@ | |||
1 | perf-trace(1) | 1 | perf-trace(1) |
2 | ============== | 2 | ============= |
3 | 3 | ||
4 | NAME | 4 | NAME |
5 | ---- | 5 | ---- |