perf-list.txt 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. perf-list(1)
  2. ============
  3. NAME
  4. ----
  5. perf-list - List all symbolic event types
  6. SYNOPSIS
  7. --------
  8. [verse]
  9. 'perf list' [hw|sw|cache|tracepoint|event_glob]
  10. DESCRIPTION
  11. -----------
  12. This command displays the symbolic event types which can be selected in the
  13. various perf commands with the -e option.
  14. EVENT MODIFIERS
  15. ---------------
  16. Events can optionally have a modifer by appending a colon and one or
  17. more modifiers. Modifiers allow the user to restrict when events are
  18. counted with 'u' for user-space, 'k' for kernel, 'h' for hypervisor.
  19. Additional modifiers are 'G' for guest counting (in KVM guests) and 'H'
  20. for host counting (not in KVM guests).
  21. The 'p' modifier can be used for specifying how precise the instruction
  22. address should be. The 'p' modifier is currently only implemented for
  23. Intel PEBS and can be specified multiple times:
  24. 0 - SAMPLE_IP can have arbitrary skid
  25. 1 - SAMPLE_IP must have constant skid
  26. 2 - SAMPLE_IP requested to have 0 skid
  27. 3 - SAMPLE_IP must have 0 skid
  28. The PEBS implementation now supports up to 2.
  29. RAW HARDWARE EVENT DESCRIPTOR
  30. -----------------------------
  31. Even when an event is not available in a symbolic form within perf right now,
  32. it can be encoded in a per processor specific way.
  33. For instance For x86 CPUs NNN represents the raw register encoding with the
  34. 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
  35. of IA32_PERFEVTSELx MSRs) or AMD's PerfEvtSeln (see [AMD64 Architecture Programmer’s Manual Volume 2: System Programming], Page 344,
  36. Figure 13-7 Performance Event-Select Register (PerfEvtSeln)).
  37. Example:
  38. If the Intel docs for a QM720 Core i7 describe an event as:
  39. Event Umask Event Mask
  40. Num. Value Mnemonic Description Comment
  41. A8H 01H LSD.UOPS Counts the number of micro-ops Use cmask=1 and
  42. delivered by loop stream detector invert to count
  43. cycles
  44. raw encoding of 0x1A8 can be used:
  45. perf stat -e r1a8 -a sleep 1
  46. perf record -e r1a8 ...
  47. You should refer to the processor specific documentation for getting these
  48. details. Some of them are referenced in the SEE ALSO section below.
  49. OPTIONS
  50. -------
  51. Without options all known events will be listed.
  52. To limit the list use:
  53. . 'hw' or 'hardware' to list hardware events such as cache-misses, etc.
  54. . 'sw' or 'software' to list software events such as context switches, etc.
  55. . 'cache' or 'hwcache' to list hardware cache events such as L1-dcache-loads, etc.
  56. . 'tracepoint' to list all tracepoint events, alternatively use
  57. 'subsys_glob:event_glob' to filter by tracepoint subsystems such as sched,
  58. block, etc.
  59. . If none of the above is matched, it will apply the supplied glob to all
  60. events, printing the ones that match.
  61. One or more types can be used at the same time, listing the events for the
  62. types specified.
  63. SEE ALSO
  64. --------
  65. linkperf:perf-stat[1], linkperf:perf-top[1],
  66. linkperf:perf-record[1],
  67. http://www.intel.com/Assets/PDF/manual/253669.pdf[Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3B: System Programming Guide],
  68. http://support.amd.com/us/Processor_TechDocs/24593.pdf[AMD64 Architecture Programmer’s Manual Volume 2: System Programming]