diff options
author | Michael Kerrisk <mtk.manpages@gmail.com> | 2020-11-18 23:17:53 +0100 |
---|---|---|
committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2020-11-18 23:39:00 +0100 |
commit | 5ae2634dbac81bafc24bfc16b3ad5b107ea57ae2 (patch) | |
tree | 2eae9859c6eb61fbf83416dd9f403c375a237f4f | |
parent | 1e554f3e320adf54e6b79212044f021d654c3184 (diff) | |
download | man-pages-5ae2634dbac81bafc24bfc16b3ad5b107ea57ae2.tar.gz |
perf_event_open.2: Minor tweaks
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
-rw-r--r-- | man2/perf_event_open.2 | 61 |
1 files changed, 31 insertions, 30 deletions
diff --git a/man2/perf_event_open.2 b/man2/perf_event_open.2 index 62731bbac1..3cc2cc252c 100644 --- a/man2/perf_event_open.2 +++ b/man2/perf_event_open.2 @@ -880,11 +880,11 @@ instruction's retirement. .BR PERF_SAMPLE_PHYS_ADDR " (since Linux 4.13)" .\" commit fc7ce9c74c3ad232b084d80148654f926d01ece7 Records physical address of data like in -.B PERF_SAMPLE_ADDR . +.BR PERF_SAMPLE_ADDR . .TP .BR PERF_SAMPLE_CGROUP " (since Linux 5.7)" .\" commit 96aaab686505c449e24d76e76507290dcc30e008 -Records (perf_event) cgroup id of the process. +Records (perf_event) cgroup ID of the process. This corresponds to the .I id field in the @@ -1227,28 +1227,28 @@ settings. .TP .IR write_backward " (since Linux 4.6)" .\" commit 9ecda41acb971ebd07c8fb35faf24005c0baea12 -This makes the ring buffer is written from end to beginning. +This causes the ring buffer to be written from the end to the beginning. This is to support reading from overwritable ring buffer. .TP .IR namespaces " (since Linux 4.11)" .\" commit e422267322cd319e2695a535e47c5b1feeac45eb This enables the generation of .B PERF_RECORD_NAMESPACES -records when a task is entering to a new namespace. +records when a task enters a new namespace. Each namespace has a combination of device and inode numbers. .TP .IR ksymbol " (since Linux 5.0)" .\" commit 76193a94522f1d4edf2447a536f3f796ce56343b This enables the generation of .B PERF_RECORD_KSYMBOL -records when a new kernel symbols are registered or unregistered. +records when new kernel symbols are registered or unregistered. This is analyzing dynamic kernel functions like eBPF. .TP .IR bpf_event " (since Linux 5.0)" .\" commit 6ee52e2a3fe4ea35520720736e6791df1fb67106 This enables the generation of .B PERF_RECORD_BPF_EVENT -records when a eBPF program is loaded or unloaded. +records when an eBPF program is loaded or unloaded. .TP .IR auxevent " (since Linux 5.4)" .\" commit ab43762ef010967e4ccd53627f70a2eecbeafefb @@ -1266,7 +1266,7 @@ records when a new cgroup is created (and activated). This enables the generation of .B PERF_RECORD_TEXT_POKE records when there's a changes to the kernel text -(i.e. self-modifying code). +(i.e., self-modifying code). .TP .IR wakeup_events ", " wakeup_watermark This union sets how many samples @@ -2642,13 +2642,14 @@ bit mask. .I phys_addr If the .B PERF_SAMPLE_PHYS_ADDR -flag is set, then 64-bit physical address is recorded. +flag is set, then the 64-bit physical address is recorded. .TP .I cgroup If the .B PERF_SAMPLE_CGROUP -flag is set, then 64-bit cgroup id (for the perf_event subsystem) is recorded. -To get the pathname of the cgroup, the id should match to one in a +flag is set, +then the 64-bit cgroup ID (for the perf_event subsystem) is recorded. +To get the pathname of the cgroup, the ID should match to one in a .B PERF_RECORD_CGROUP . .RE .TP @@ -2865,9 +2866,9 @@ This record includes various namespace information of a process. .EX struct { struct perf_event_header header; - u32 pid; - u32 tid; - u64 nr_namespaces; + u32 pid; + u32 tid; + u64 nr_namespaces; struct { u64 dev, inode } [nr_namespaces]; struct sample_id sample_id; }; @@ -2923,11 +2924,11 @@ This record indicates kernel symbol register/unregister events. .EX struct { struct perf_event_header header; - u64 addr; - u32 len; - u16 ksym_type; - u16 flags; - char name[]; + u64 addr; + u32 len; + u16 ksym_type; + u16 flags; + char name[]; struct sample_id sample_id; }; .EE @@ -2935,18 +2936,18 @@ struct { .RS .TP .I addr -is the address of the kernel symbol +is the address of the kernel symbol. .TP .I len -is the length of the kernel symbol +is the length of the kernel symbol. .TP .I ksym_type is the type of the kernel symbol. -Currently following types are available: +Currently the following types are available: .RS .TP .B PERF_RECORD_KSYMBOL_TYPE_BPF -The kernel symbols is a BPF function. +The kernel symbol is a BPF function. .RE .TP .I flags @@ -2985,7 +2986,7 @@ A BPF program is unloaded .RE .TP .I id -is the id of the BPF program. +is the ID of the BPF program. .TP .I tag is the tag of the BPF program. @@ -3002,8 +3003,8 @@ This record indicates a new cgroup is created and activated. .EX struct { struct perf_event_header header; - u64 id; - char path[]; + u64 id; + char path[]; struct sample_id sample_id; }; .EE @@ -3012,7 +3013,7 @@ struct { .TP .I id is the cgroup identifier. -This can be also retreived by +This can be also retrieved by .BR name_to_handle_at (2) on the cgroup path (as a file handle). .TP @@ -3030,10 +3031,10 @@ and the corresponding length is zero in this case. .EX struct { struct perf_event_header header; - u64 addr; - u16 old_len; - u16 new_len; - u8 bytes[]; + u64 addr; + u16 old_len; + u16 new_len; + u8 bytes[]; struct sample_id sample_id; }; .EE |