diff options
Diffstat (limited to 'man2/perf_event_open.2')
| -rw-r--r-- | man2/perf_event_open.2 | 96 |
1 files changed, 48 insertions, 48 deletions
diff --git a/man2/perf_event_open.2 b/man2/perf_event_open.2 index 377b1d6d12..8cff4c8f0d 100644 --- a/man2/perf_event_open.2 +++ b/man2/perf_event_open.2 @@ -142,7 +142,7 @@ It is unclear why this is useful. .BR PERF_FLAG_FD_OUTPUT This flag reroutes the output from an event to the group leader. .TP -.BR PERF_FLAG_PID_CGROUP " (Since Linux 2.6.39)." +.BR PERF_FLAG_PID_CGROUP " (since Linux 2.6.39)." This flag activates per-container system-wide monitoring. A container is an abstraction that isolates a set of resources for finer grain @@ -271,7 +271,7 @@ field definition. This indicates a "raw" implementation-specific event in the .IR config " field." .TP -.BR PERF_TYPE_BREAKPOINT " (Since Linux 2.6.33)" +.BR PERF_TYPE_BREAKPOINT " (since Linux 2.6.33)" This indicates a hardware breakpoint as provided by the CPU. Breakpoints can be read/write accesses to an address as well as execution of an instruction address. @@ -393,13 +393,13 @@ Mispredicted branch instructions. .B PERF_COUNT_HW_BUS_CYCLES Bus cycles, which can be different from total cycles. .TP -.BR PERF_COUNT_HW_STALLED_CYCLES_FRONTEND " (Since Linux 3.0)" +.BR PERF_COUNT_HW_STALLED_CYCLES_FRONTEND " (since Linux 3.0)" Stalled cycles during issue. .TP -.BR PERF_COUNT_HW_STALLED_CYCLES_BACKEND " (Since Linux 3.0)" +.BR PERF_COUNT_HW_STALLED_CYCLES_BACKEND " (since Linux 3.0)" Stalled cycles during retirement. .TP -.BR PERF_COUNT_HW_REF_CPU_CYCLES " (Since Linux 3.3)" +.BR PERF_COUNT_HW_REF_CPU_CYCLES " (since Linux 3.3)" Total cycles; not affected by CPU frequency scaling. .RE .IP @@ -439,19 +439,19 @@ These did not require disk I/O to handle. This counts the number of major page faults. These required disk I/O to handle. .TP -.BR PERF_COUNT_SW_ALIGNMENT_FAULTS " (Since Linux 2.6.33)" +.BR PERF_COUNT_SW_ALIGNMENT_FAULTS " (since Linux 2.6.33)" This counts the number of alignment faults. These happen when unaligned memory accesses happen; the kernel can handle these but it reduces performance. This happens only on some architectures (never on x86). .TP -.BR PERF_COUNT_SW_EMULATION_FAULTS " (Since Linux 2.6.33)" +.BR PERF_COUNT_SW_EMULATION_FAULTS " (since Linux 2.6.33)" This counts the number of emulation faults. The kernel sometimes traps on unimplemented instructions and emulates them for user space. This can negatively impact performance. .TP -.BR PERF_COUNT_SW_DUMMY " (Since Linux 3.12)" +.BR PERF_COUNT_SW_DUMMY " (since Linux 3.12)" This is a placeholder event that counts nothing. Informational sample record types such as mmap or comm must be associated with an active event. @@ -511,7 +511,7 @@ for measuring the Instruction TLB .B PERF_COUNT_HW_CACHE_BPU for measuring the branch prediction unit .TP -.BR PERF_COUNT_HW_CACHE_NODE " (Since Linux 3.0)" +.BR PERF_COUNT_HW_CACHE_NODE " (since Linux 3.0)" for measuring local memory accesses .RE .P @@ -643,7 +643,7 @@ This ID is the same as the one returned by Records additional data, if applicable. Usually returned by tracepoint events. .TP -.BR PERF_SAMPLE_BRANCH_STACK " (Since Linux 3.4)" +.BR PERF_SAMPLE_BRANCH_STACK " (since Linux 3.4)" This provides a record of recent branches, as provided by CPU branch sampling hardware (such as Intel Last Branch Record). Not all hardware supports this feature. @@ -652,26 +652,26 @@ See the .I branch_sample_type field for how to filter which branches are reported. .TP -.BR PERF_SAMPLE_REGS_USER " (Since Linux 3.7)" +.BR PERF_SAMPLE_REGS_USER " (since Linux 3.7)" Records the current user-level CPU register state (the values in the process before the kernel was called). .TP -.BR PERF_SAMPLE_STACK_USER " (Since Linux 3.7)" +.BR PERF_SAMPLE_STACK_USER " (since Linux 3.7)" Records the user level stack, allowing stack unwinding. .TP -.BR PERF_SAMPLE_WEIGHT " (Since Linux 3.10)" +.BR PERF_SAMPLE_WEIGHT " (since Linux 3.10)" Records a hardware provided weight value that expresses how costly the sampled event was. This allows the hardware to highlight expensive events in a profile. .TP -.BR PERF_SAMPLE_DATA_SRC " (Since Linux 3.10)" +.BR PERF_SAMPLE_DATA_SRC " (since Linux 3.10)" Records the data source: where in the memory hierarchy the data associated with the sampled instruction came from. This is only available if the underlying hardware supports this feature. .TP -.BR PERF_SAMPLE_IDENTIFIER " (Since Linux 3.12)" +.BR PERF_SAMPLE_IDENTIFIER " (since Linux 3.12)" Places the .B SAMPLE_ID value in a fixed position in the record, @@ -879,7 +879,7 @@ Otherwise interrupts happen after .I wakeup_events samples. .TP -.IR "precise_ip" " (Since Linux 2.6.35)" +.IR "precise_ip" " (since Linux 2.6.35)" This controls the amount of skid. Skid is how many instructions execute between an event of interest happening and the kernel @@ -911,7 +911,7 @@ See also .BR PERF_RECORD_MISC_EXACT_IP . .RE .TP -.IR "mmap_data" " (Since Linux 2.6.36)" +.IR "mmap_data" " (since Linux 2.6.36)" The counterpart of the .I mmap field. @@ -923,7 +923,7 @@ calls that do not have .B PROT_EXEC set (for example data and SysV shared memory). .TP -.IR "sample_id_all" " (Since Linux 2.6.38)" +.IR "sample_id_all" " (since Linux 2.6.38)" If set, then TID, TIME, ID, STREAM_ID, and CPU can additionally be included in .RB non- PERF_RECORD_SAMPLE s @@ -952,16 +952,16 @@ struct sample_id { }; .fi .TP -.IR "exclude_host" " (Since Linux 3.2)" +.IR "exclude_host" " (since Linux 3.2)" Do not measure time spent in VM host. .TP -.IR "exclude_guest" " (Since Linux 3.2)" +.IR "exclude_guest" " (since Linux 3.2)" Do not measure time spent in VM guest. .TP -.IR "exclude_callchain_kernel" " (Since Linux 3.7)" +.IR "exclude_callchain_kernel" " (since Linux 3.7)" Do not include kernel callchains. .TP -.IR "exclude_callchain_user" " (Since Linux 3.7)" +.IR "exclude_callchain_user" " (since Linux 3.7)" Do not include user callchains. .TP .IR "wakeup_events" ", " "wakeup_watermark" @@ -984,7 +984,7 @@ type set .I wakeup_watermark to 1. .TP -.IR "bp_type" " (Since Linux 2.6.33)" +.IR "bp_type" " (since Linux 2.6.33)" This chooses the breakpoint type. It is one of: .RS @@ -1014,21 +1014,21 @@ with is not allowed. .RE .TP -.IR "bp_addr" " (Since Linux 2.6.33)" +.IR "bp_addr" " (since Linux 2.6.33)" .I bp_addr address of the breakpoint. For execution breakpoints this is the memory address of the instruction of interest; for read and write breakpoints it is the memory address of the memory location of interest. .TP -.IR "config1" " (Since Linux 2.6.39)" +.IR "config1" " (since Linux 2.6.39)" .I config1 is used for setting events that need an extra register or otherwise do not fit in the regular config field. Raw OFFCORE_EVENTS on Nehalem/Westmere/SandyBridge use this field on 3.3 and later kernels. .TP -.IR "bp_len" " (Since Linux 2.6.33)" +.IR "bp_len" " (since Linux 2.6.33)" .I bp_len is the length of the breakpoint being measured if .I type @@ -1042,14 +1042,14 @@ Options are For an execution breakpoint, set this to .IR sizeof(long) . .TP -.IR "config2" " (Since Linux 2.6.39)" +.IR "config2" " (since Linux 2.6.39)" .I config2 is a further extension of the .I config1 field. .TP -.IR "branch_sample_type" " (Since Linux 3.4)" +.IR "branch_sample_type" " (since Linux 3.4)" If .B PERF_SAMPLE_BRANCH_STACK is enabled, then this specifies what branches to include @@ -1091,24 +1091,24 @@ Any return branch. .B PERF_SAMPLE_BRANCH_IND_CALL Indirect calls. .TP -.BR PERF_SAMPLE_BRANCH_ABORT_TX " (Since Linux 3.11)" +.BR PERF_SAMPLE_BRANCH_ABORT_TX " (since Linux 3.11)" Transactional memory aborts. .TP -.BR PERF_SAMPLE_BRANCH_IN_TX " (Since Linux 3.11)" +.BR PERF_SAMPLE_BRANCH_IN_TX " (since Linux 3.11)" Branch in transactional memory transaction. .TP -.BR PERF_SAMPLE_BRANCH_NO_TX " (Since Linux 3.11)" +.BR PERF_SAMPLE_BRANCH_NO_TX " (since Linux 3.11)" Branch not in transactional memory transaction. .RE .TP -.IR "sample_regs_user" " (Since Linux 3.7)" +.IR "sample_regs_user" " (since Linux 3.7)" This bit mask defines the set of user CPU registers to dump on samples. The layout of the register mask is architecture-specific and described in the kernel header .IR arch/ARCH/include/uapi/asm/perf_regs.h . .TP -.IR "sample_stack_user" " (Since Linux 3.7)" +.IR "sample_stack_user" " (since Linux 3.7)" This defines the size of the user stack to dump if .B PERF_SAMPLE_STACK_USER is specified. @@ -1273,7 +1273,7 @@ Time the event was active. .I time_running Time the event was running. .TP -.IR cap_usr_time " / " cap_usr_rdpmc " / " cap_bit0 " (Since Linux 3.4)" +.IR cap_usr_time " / " cap_usr_rdpmc " / " cap_bit0 " (since Linux 3.4)" There was a bug in the definition of .I cap_usr_time and @@ -1295,7 +1295,7 @@ and fields instead. .TP -.IR cap_bit0_is_deprecated " (Since Linux 3.12)" +.IR cap_bit0_is_deprecated " (since Linux 3.12)" If set this bit indicates that the kernel supports the properly separated .I cap_user_time @@ -1311,7 +1311,7 @@ map to the same bit and thus both features should be used with caution. .TP -.IR cap_user_rdpmc " (Since Linux 3.12)" +.IR cap_user_rdpmc " (since Linux 3.12)" If the hardware supports user-space read of performance counters without syscall (this is the "rdpmc" instruction on x86), then the following code can be used to do a read: @@ -1348,11 +1348,11 @@ do { .fi .in .TP -.I cap_user_time " (Since Linux 3.12)" +.I cap_user_time " (since Linux 3.12)" This bit indicates the hardware has a constant, nonstop timestamp counter (TSC on x86). .TP -.IR cap_user_time_zero " (Since Linux 3.12)" +.IR cap_user_time_zero " (since Linux 3.12)" Indicates the presence of .I time_zero which allows mapping timestamp values to @@ -1409,7 +1409,7 @@ enabled and possible running (if idx), improving the scaling: count = quot * enabled + (rem * enabled) / running; .fi .TP -.IR time_zero " (Since Linux 3.12)" +.IR time_zero " (since Linux 3.12)" If .I cap_usr_time_zero @@ -1817,10 +1817,10 @@ The branch target was mispredicted. .I predicted The branch target was predicted. .TP -.IR in_tx " (Since Linux 3.11)" +.IR in_tx " (since Linux 3.11)" The branch was in a transactional memory transaction. .TP -.IR abort " (Since Linux 3.11)" +.IR abort " (since Linux 3.11)" The branch was in an aborted transactional memory transaction. .P @@ -2211,12 +2211,12 @@ The file descriptors must all be on the same CPU. The argument specifies the desired file descriptor, or \-1 if output should be ignored. .TP -.BR PERF_EVENT_IOC_SET_FILTER " (Since Linux 2.6.33)" +.BR PERF_EVENT_IOC_SET_FILTER " (since Linux 2.6.33)" This adds an ftrace filter to this event. The argument is a pointer to the desired ftrace filter. .TP -.BR PERF_EVENT_IOC_ID " (Since Linux 3.12)" +.BR PERF_EVENT_IOC_ID " (since Linux 3.12)" Returns the event ID value for the given event fd. The argument is a pointer to a 64-bit unsigned integer @@ -2284,17 +2284,17 @@ Information on how to program these PMUs can be found under .IR /sys/bus/event_source/devices/ . Each subdirectory corresponds to a different PMU. .TP -.IR /sys/bus/event_source/devices/*/type " (Since Linux 2.6.38)" +.IR /sys/bus/event_source/devices/*/type " (since Linux 2.6.38)" This contains an integer that can be used in the .I type field of perf_event_attr to indicate you wish to use this PMU. .TP -.IR /sys/bus/event_source/devices/*/rdpmc " (Since Linux 3.4)" +.IR /sys/bus/event_source/devices/*/rdpmc " (since Linux 3.4)" If this file is 1, then direct user-space access to the performance counter registers is allowed via the rdpmc instruction. This can be disabled by echoing 0 to the file. .TP -.IR /sys/bus/event_source/devices/*/format/ " (Since Linux 3.4)" +.IR /sys/bus/event_source/devices/*/format/ " (since Linux 3.4)" This subdirectory contains information on the architecture-specific subfields available for programming the various .I config @@ -2310,7 +2310,7 @@ may contain the value which indicates that event is an attribute that occupies bits 1,6-10, and 44 of perf_event_attr::config1. .TP -.IR /sys/bus/event_source/devices/*/events/ " (Since Linux 3.4)" +.IR /sys/bus/event_source/devices/*/events/ " (since Linux 3.4)" This subdirectory contains files with predefined events. The contents are strings describing the event settings expressed in terms of the fields found in the previously mentioned @@ -2331,7 +2331,7 @@ An example entry may look like this: This file is the standard kernel device interface for injecting hotplug events. .TP -.IR /sys/bus/event_source/devices/*/cpumask " (Since Linux 3.7)" +.IR /sys/bus/event_source/devices/*/cpumask " (since Linux 3.7)" The .I cpumask file contains a comma-separated list of integers that |