perf_event.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785
  1. /*
  2. * Performance events:
  3. *
  4. * Copyright (C) 2008-2009, Thomas Gleixner <tglx@linutronix.de>
  5. * Copyright (C) 2008-2011, Red Hat, Inc., Ingo Molnar
  6. * Copyright (C) 2008-2011, Red Hat, Inc., Peter Zijlstra
  7. *
  8. * Data type definitions, declarations, prototypes.
  9. *
  10. * Started by: Thomas Gleixner and Ingo Molnar
  11. *
  12. * For licencing details see kernel-base/COPYING
  13. */
  14. #ifndef _UAPI_LINUX_PERF_EVENT_H
  15. #define _UAPI_LINUX_PERF_EVENT_H
  16. #include <linux/types.h>
  17. #include <linux/ioctl.h>
  18. #include <asm/byteorder.h>
  19. /*
  20. * User-space ABI bits:
  21. */
  22. /*
  23. * attr.type
  24. */
  25. enum perf_type_id {
  26. PERF_TYPE_HARDWARE = 0,
  27. PERF_TYPE_SOFTWARE = 1,
  28. PERF_TYPE_TRACEPOINT = 2,
  29. PERF_TYPE_HW_CACHE = 3,
  30. PERF_TYPE_RAW = 4,
  31. PERF_TYPE_BREAKPOINT = 5,
  32. PERF_TYPE_MAX, /* non-ABI */
  33. };
  34. /*
  35. * Generalized performance event event_id types, used by the
  36. * attr.event_id parameter of the sys_perf_event_open()
  37. * syscall:
  38. */
  39. enum perf_hw_id {
  40. /*
  41. * Common hardware events, generalized by the kernel:
  42. */
  43. PERF_COUNT_HW_CPU_CYCLES = 0,
  44. PERF_COUNT_HW_INSTRUCTIONS = 1,
  45. PERF_COUNT_HW_CACHE_REFERENCES = 2,
  46. PERF_COUNT_HW_CACHE_MISSES = 3,
  47. PERF_COUNT_HW_BRANCH_INSTRUCTIONS = 4,
  48. PERF_COUNT_HW_BRANCH_MISSES = 5,
  49. PERF_COUNT_HW_BUS_CYCLES = 6,
  50. PERF_COUNT_HW_STALLED_CYCLES_FRONTEND = 7,
  51. PERF_COUNT_HW_STALLED_CYCLES_BACKEND = 8,
  52. PERF_COUNT_HW_REF_CPU_CYCLES = 9,
  53. PERF_COUNT_HW_MAX, /* non-ABI */
  54. };
  55. /*
  56. * Generalized hardware cache events:
  57. *
  58. * { L1-D, L1-I, LLC, ITLB, DTLB, BPU, NODE } x
  59. * { read, write, prefetch } x
  60. * { accesses, misses }
  61. */
  62. enum perf_hw_cache_id {
  63. PERF_COUNT_HW_CACHE_L1D = 0,
  64. PERF_COUNT_HW_CACHE_L1I = 1,
  65. PERF_COUNT_HW_CACHE_LL = 2,
  66. PERF_COUNT_HW_CACHE_DTLB = 3,
  67. PERF_COUNT_HW_CACHE_ITLB = 4,
  68. PERF_COUNT_HW_CACHE_BPU = 5,
  69. PERF_COUNT_HW_CACHE_NODE = 6,
  70. PERF_COUNT_HW_CACHE_MAX, /* non-ABI */
  71. };
  72. enum perf_hw_cache_op_id {
  73. PERF_COUNT_HW_CACHE_OP_READ = 0,
  74. PERF_COUNT_HW_CACHE_OP_WRITE = 1,
  75. PERF_COUNT_HW_CACHE_OP_PREFETCH = 2,
  76. PERF_COUNT_HW_CACHE_OP_MAX, /* non-ABI */
  77. };
  78. enum perf_hw_cache_op_result_id {
  79. PERF_COUNT_HW_CACHE_RESULT_ACCESS = 0,
  80. PERF_COUNT_HW_CACHE_RESULT_MISS = 1,
  81. PERF_COUNT_HW_CACHE_RESULT_MAX, /* non-ABI */
  82. };
  83. /*
  84. * Special "software" events provided by the kernel, even if the hardware
  85. * does not support performance events. These events measure various
  86. * physical and sw events of the kernel (and allow the profiling of them as
  87. * well):
  88. */
  89. enum perf_sw_ids {
  90. PERF_COUNT_SW_CPU_CLOCK = 0,
  91. PERF_COUNT_SW_TASK_CLOCK = 1,
  92. PERF_COUNT_SW_PAGE_FAULTS = 2,
  93. PERF_COUNT_SW_CONTEXT_SWITCHES = 3,
  94. PERF_COUNT_SW_CPU_MIGRATIONS = 4,
  95. PERF_COUNT_SW_PAGE_FAULTS_MIN = 5,
  96. PERF_COUNT_SW_PAGE_FAULTS_MAJ = 6,
  97. PERF_COUNT_SW_ALIGNMENT_FAULTS = 7,
  98. PERF_COUNT_SW_EMULATION_FAULTS = 8,
  99. PERF_COUNT_SW_DUMMY = 9,
  100. PERF_COUNT_SW_MAX, /* non-ABI */
  101. };
  102. /*
  103. * Bits that can be set in attr.sample_type to request information
  104. * in the overflow packets.
  105. */
  106. enum perf_event_sample_format {
  107. PERF_SAMPLE_IP = 1U << 0,
  108. PERF_SAMPLE_TID = 1U << 1,
  109. PERF_SAMPLE_TIME = 1U << 2,
  110. PERF_SAMPLE_ADDR = 1U << 3,
  111. PERF_SAMPLE_READ = 1U << 4,
  112. PERF_SAMPLE_CALLCHAIN = 1U << 5,
  113. PERF_SAMPLE_ID = 1U << 6,
  114. PERF_SAMPLE_CPU = 1U << 7,
  115. PERF_SAMPLE_PERIOD = 1U << 8,
  116. PERF_SAMPLE_STREAM_ID = 1U << 9,
  117. PERF_SAMPLE_RAW = 1U << 10,
  118. PERF_SAMPLE_BRANCH_STACK = 1U << 11,
  119. PERF_SAMPLE_REGS_USER = 1U << 12,
  120. PERF_SAMPLE_STACK_USER = 1U << 13,
  121. PERF_SAMPLE_WEIGHT = 1U << 14,
  122. PERF_SAMPLE_DATA_SRC = 1U << 15,
  123. PERF_SAMPLE_IDENTIFIER = 1U << 16,
  124. PERF_SAMPLE_MAX = 1U << 17, /* non-ABI */
  125. };
  126. /*
  127. * values to program into branch_sample_type when PERF_SAMPLE_BRANCH is set
  128. *
  129. * If the user does not pass priv level information via branch_sample_type,
  130. * the kernel uses the event's priv level. Branch and event priv levels do
  131. * not have to match. Branch priv level is checked for permissions.
  132. *
  133. * The branch types can be combined, however BRANCH_ANY covers all types
  134. * of branches and therefore it supersedes all the other types.
  135. */
  136. enum perf_branch_sample_type {
  137. PERF_SAMPLE_BRANCH_USER = 1U << 0, /* user branches */
  138. PERF_SAMPLE_BRANCH_KERNEL = 1U << 1, /* kernel branches */
  139. PERF_SAMPLE_BRANCH_HV = 1U << 2, /* hypervisor branches */
  140. PERF_SAMPLE_BRANCH_ANY = 1U << 3, /* any branch types */
  141. PERF_SAMPLE_BRANCH_ANY_CALL = 1U << 4, /* any call branch */
  142. PERF_SAMPLE_BRANCH_ANY_RETURN = 1U << 5, /* any return branch */
  143. PERF_SAMPLE_BRANCH_IND_CALL = 1U << 6, /* indirect calls */
  144. PERF_SAMPLE_BRANCH_ABORT_TX = 1U << 7, /* transaction aborts */
  145. PERF_SAMPLE_BRANCH_IN_TX = 1U << 8, /* in transaction */
  146. PERF_SAMPLE_BRANCH_NO_TX = 1U << 9, /* not in transaction */
  147. PERF_SAMPLE_BRANCH_MAX = 1U << 10, /* non-ABI */
  148. };
  149. #define PERF_SAMPLE_BRANCH_PLM_ALL \
  150. (PERF_SAMPLE_BRANCH_USER|\
  151. PERF_SAMPLE_BRANCH_KERNEL|\
  152. PERF_SAMPLE_BRANCH_HV)
  153. /*
  154. * Values to determine ABI of the registers dump.
  155. */
  156. enum perf_sample_regs_abi {
  157. PERF_SAMPLE_REGS_ABI_NONE = 0,
  158. PERF_SAMPLE_REGS_ABI_32 = 1,
  159. PERF_SAMPLE_REGS_ABI_64 = 2,
  160. };
  161. /*
  162. * The format of the data returned by read() on a perf event fd,
  163. * as specified by attr.read_format:
  164. *
  165. * struct read_format {
  166. * { u64 value;
  167. * { u64 time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
  168. * { u64 time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
  169. * { u64 id; } && PERF_FORMAT_ID
  170. * } && !PERF_FORMAT_GROUP
  171. *
  172. * { u64 nr;
  173. * { u64 time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
  174. * { u64 time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
  175. * { u64 value;
  176. * { u64 id; } && PERF_FORMAT_ID
  177. * } cntr[nr];
  178. * } && PERF_FORMAT_GROUP
  179. * };
  180. */
  181. enum perf_event_read_format {
  182. PERF_FORMAT_TOTAL_TIME_ENABLED = 1U << 0,
  183. PERF_FORMAT_TOTAL_TIME_RUNNING = 1U << 1,
  184. PERF_FORMAT_ID = 1U << 2,
  185. PERF_FORMAT_GROUP = 1U << 3,
  186. PERF_FORMAT_MAX = 1U << 4, /* non-ABI */
  187. };
  188. #define PERF_ATTR_SIZE_VER0 64 /* sizeof first published struct */
  189. #define PERF_ATTR_SIZE_VER1 72 /* add: config2 */
  190. #define PERF_ATTR_SIZE_VER2 80 /* add: branch_sample_type */
  191. #define PERF_ATTR_SIZE_VER3 96 /* add: sample_regs_user */
  192. /* add: sample_stack_user */
  193. /*
  194. * Hardware event_id to monitor via a performance monitoring event:
  195. */
  196. struct perf_event_attr {
  197. /*
  198. * Major type: hardware/software/tracepoint/etc.
  199. */
  200. __u32 type;
  201. /*
  202. * Size of the attr structure, for fwd/bwd compat.
  203. */
  204. __u32 size;
  205. /*
  206. * Type specific configuration information.
  207. */
  208. __u64 config;
  209. union {
  210. __u64 sample_period;
  211. __u64 sample_freq;
  212. };
  213. __u64 sample_type;
  214. __u64 read_format;
  215. __u64 disabled : 1, /* off by default */
  216. inherit : 1, /* children inherit it */
  217. pinned : 1, /* must always be on PMU */
  218. exclusive : 1, /* only group on PMU */
  219. exclude_user : 1, /* don't count user */
  220. exclude_kernel : 1, /* ditto kernel */
  221. exclude_hv : 1, /* ditto hypervisor */
  222. exclude_idle : 1, /* don't count when idle */
  223. mmap : 1, /* include mmap data */
  224. comm : 1, /* include comm data */
  225. freq : 1, /* use freq, not period */
  226. inherit_stat : 1, /* per task counts */
  227. enable_on_exec : 1, /* next exec enables */
  228. task : 1, /* trace fork/exit */
  229. watermark : 1, /* wakeup_watermark */
  230. /*
  231. * precise_ip:
  232. *
  233. * 0 - SAMPLE_IP can have arbitrary skid
  234. * 1 - SAMPLE_IP must have constant skid
  235. * 2 - SAMPLE_IP requested to have 0 skid
  236. * 3 - SAMPLE_IP must have 0 skid
  237. *
  238. * See also PERF_RECORD_MISC_EXACT_IP
  239. */
  240. precise_ip : 2, /* skid constraint */
  241. mmap_data : 1, /* non-exec mmap data */
  242. sample_id_all : 1, /* sample_type all events */
  243. exclude_host : 1, /* don't count in host */
  244. exclude_guest : 1, /* don't count in guest */
  245. exclude_callchain_kernel : 1, /* exclude kernel callchains */
  246. exclude_callchain_user : 1, /* exclude user callchains */
  247. mmap2 : 1, /* include mmap with inode data */
  248. __reserved_1 : 40;
  249. union {
  250. __u32 wakeup_events; /* wakeup every n events */
  251. __u32 wakeup_watermark; /* bytes before wakeup */
  252. };
  253. __u32 bp_type;
  254. union {
  255. __u64 bp_addr;
  256. __u64 config1; /* extension of config */
  257. };
  258. union {
  259. __u64 bp_len;
  260. __u64 config2; /* extension of config1 */
  261. };
  262. __u64 branch_sample_type; /* enum perf_branch_sample_type */
  263. /*
  264. * Defines set of user regs to dump on samples.
  265. * See asm/perf_regs.h for details.
  266. */
  267. __u64 sample_regs_user;
  268. /*
  269. * Defines size of the user stack to dump on samples.
  270. */
  271. __u32 sample_stack_user;
  272. /* Align to u64. */
  273. __u32 __reserved_2;
  274. };
  275. #define perf_flags(attr) (*(&(attr)->read_format + 1))
  276. /*
  277. * Ioctls that can be done on a perf event fd:
  278. */
  279. #define PERF_EVENT_IOC_ENABLE _IO ('$', 0)
  280. #define PERF_EVENT_IOC_DISABLE _IO ('$', 1)
  281. #define PERF_EVENT_IOC_REFRESH _IO ('$', 2)
  282. #define PERF_EVENT_IOC_RESET _IO ('$', 3)
  283. #define PERF_EVENT_IOC_PERIOD _IOW('$', 4, __u64)
  284. #define PERF_EVENT_IOC_SET_OUTPUT _IO ('$', 5)
  285. #define PERF_EVENT_IOC_SET_FILTER _IOW('$', 6, char *)
  286. #define PERF_EVENT_IOC_ID _IOR('$', 7, u64 *)
  287. enum perf_event_ioc_flags {
  288. PERF_IOC_FLAG_GROUP = 1U << 0,
  289. };
  290. /*
  291. * Structure of the page that can be mapped via mmap
  292. */
  293. struct perf_event_mmap_page {
  294. __u32 version; /* version number of this structure */
  295. __u32 compat_version; /* lowest version this is compat with */
  296. /*
  297. * Bits needed to read the hw events in user-space.
  298. *
  299. * u32 seq, time_mult, time_shift, idx, width;
  300. * u64 count, enabled, running;
  301. * u64 cyc, time_offset;
  302. * s64 pmc = 0;
  303. *
  304. * do {
  305. * seq = pc->lock;
  306. * barrier()
  307. *
  308. * enabled = pc->time_enabled;
  309. * running = pc->time_running;
  310. *
  311. * if (pc->cap_usr_time && enabled != running) {
  312. * cyc = rdtsc();
  313. * time_offset = pc->time_offset;
  314. * time_mult = pc->time_mult;
  315. * time_shift = pc->time_shift;
  316. * }
  317. *
  318. * idx = pc->index;
  319. * count = pc->offset;
  320. * if (pc->cap_usr_rdpmc && idx) {
  321. * width = pc->pmc_width;
  322. * pmc = rdpmc(idx - 1);
  323. * }
  324. *
  325. * barrier();
  326. * } while (pc->lock != seq);
  327. *
  328. * NOTE: for obvious reason this only works on self-monitoring
  329. * processes.
  330. */
  331. __u32 lock; /* seqlock for synchronization */
  332. __u32 index; /* hardware event identifier */
  333. __s64 offset; /* add to hardware event value */
  334. __u64 time_enabled; /* time event active */
  335. __u64 time_running; /* time event on cpu */
  336. union {
  337. __u64 capabilities;
  338. struct {
  339. __u64 cap_usr_time : 1,
  340. cap_usr_rdpmc : 1,
  341. cap_usr_time_zero : 1,
  342. cap_____res : 61;
  343. };
  344. };
  345. /*
  346. * If cap_usr_rdpmc this field provides the bit-width of the value
  347. * read using the rdpmc() or equivalent instruction. This can be used
  348. * to sign extend the result like:
  349. *
  350. * pmc <<= 64 - width;
  351. * pmc >>= 64 - width; // signed shift right
  352. * count += pmc;
  353. */
  354. __u16 pmc_width;
  355. /*
  356. * If cap_usr_time the below fields can be used to compute the time
  357. * delta since time_enabled (in ns) using rdtsc or similar.
  358. *
  359. * u64 quot, rem;
  360. * u64 delta;
  361. *
  362. * quot = (cyc >> time_shift);
  363. * rem = cyc & ((1 << time_shift) - 1);
  364. * delta = time_offset + quot * time_mult +
  365. * ((rem * time_mult) >> time_shift);
  366. *
  367. * Where time_offset,time_mult,time_shift and cyc are read in the
  368. * seqcount loop described above. This delta can then be added to
  369. * enabled and possible running (if idx), improving the scaling:
  370. *
  371. * enabled += delta;
  372. * if (idx)
  373. * running += delta;
  374. *
  375. * quot = count / running;
  376. * rem = count % running;
  377. * count = quot * enabled + (rem * enabled) / running;
  378. */
  379. __u16 time_shift;
  380. __u32 time_mult;
  381. __u64 time_offset;
  382. /*
  383. * If cap_usr_time_zero, the hardware clock (e.g. TSC) can be calculated
  384. * from sample timestamps.
  385. *
  386. * time = timestamp - time_zero;
  387. * quot = time / time_mult;
  388. * rem = time % time_mult;
  389. * cyc = (quot << time_shift) + (rem << time_shift) / time_mult;
  390. *
  391. * And vice versa:
  392. *
  393. * quot = cyc >> time_shift;
  394. * rem = cyc & ((1 << time_shift) - 1);
  395. * timestamp = time_zero + quot * time_mult +
  396. * ((rem * time_mult) >> time_shift);
  397. */
  398. __u64 time_zero;
  399. /*
  400. * Hole for extension of the self monitor capabilities
  401. */
  402. __u64 __reserved[119]; /* align to 1k */
  403. /*
  404. * Control data for the mmap() data buffer.
  405. *
  406. * User-space reading the @data_head value should issue an rmb(), on
  407. * SMP capable platforms, after reading this value -- see
  408. * perf_event_wakeup().
  409. *
  410. * When the mapping is PROT_WRITE the @data_tail value should be
  411. * written by userspace to reflect the last read data. In this case
  412. * the kernel will not over-write unread data.
  413. */
  414. __u64 data_head; /* head in the data section */
  415. __u64 data_tail; /* user-space written tail */
  416. };
  417. #define PERF_RECORD_MISC_CPUMODE_MASK (7 << 0)
  418. #define PERF_RECORD_MISC_CPUMODE_UNKNOWN (0 << 0)
  419. #define PERF_RECORD_MISC_KERNEL (1 << 0)
  420. #define PERF_RECORD_MISC_USER (2 << 0)
  421. #define PERF_RECORD_MISC_HYPERVISOR (3 << 0)
  422. #define PERF_RECORD_MISC_GUEST_KERNEL (4 << 0)
  423. #define PERF_RECORD_MISC_GUEST_USER (5 << 0)
  424. #define PERF_RECORD_MISC_MMAP_DATA (1 << 13)
  425. /*
  426. * Indicates that the content of PERF_SAMPLE_IP points to
  427. * the actual instruction that triggered the event. See also
  428. * perf_event_attr::precise_ip.
  429. */
  430. #define PERF_RECORD_MISC_EXACT_IP (1 << 14)
  431. /*
  432. * Reserve the last bit to indicate some extended misc field
  433. */
  434. #define PERF_RECORD_MISC_EXT_RESERVED (1 << 15)
  435. struct perf_event_header {
  436. __u32 type;
  437. __u16 misc;
  438. __u16 size;
  439. };
  440. enum perf_event_type {
  441. /*
  442. * If perf_event_attr.sample_id_all is set then all event types will
  443. * have the sample_type selected fields related to where/when
  444. * (identity) an event took place (TID, TIME, ID, STREAM_ID, CPU,
  445. * IDENTIFIER) described in PERF_RECORD_SAMPLE below, it will be stashed
  446. * just after the perf_event_header and the fields already present for
  447. * the existing fields, i.e. at the end of the payload. That way a newer
  448. * perf.data file will be supported by older perf tools, with these new
  449. * optional fields being ignored.
  450. *
  451. * struct sample_id {
  452. * { u32 pid, tid; } && PERF_SAMPLE_TID
  453. * { u64 time; } && PERF_SAMPLE_TIME
  454. * { u64 id; } && PERF_SAMPLE_ID
  455. * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
  456. * { u32 cpu, res; } && PERF_SAMPLE_CPU
  457. * { u64 id; } && PERF_SAMPLE_IDENTIFIER
  458. * } && perf_event_attr::sample_id_all
  459. *
  460. * Note that PERF_SAMPLE_IDENTIFIER duplicates PERF_SAMPLE_ID. The
  461. * advantage of PERF_SAMPLE_IDENTIFIER is that its position is fixed
  462. * relative to header.size.
  463. */
  464. /*
  465. * The MMAP events record the PROT_EXEC mappings so that we can
  466. * correlate userspace IPs to code. They have the following structure:
  467. *
  468. * struct {
  469. * struct perf_event_header header;
  470. *
  471. * u32 pid, tid;
  472. * u64 addr;
  473. * u64 len;
  474. * u64 pgoff;
  475. * char filename[];
  476. * };
  477. */
  478. PERF_RECORD_MMAP = 1,
  479. /*
  480. * struct {
  481. * struct perf_event_header header;
  482. * u64 id;
  483. * u64 lost;
  484. * struct sample_id sample_id;
  485. * };
  486. */
  487. PERF_RECORD_LOST = 2,
  488. /*
  489. * struct {
  490. * struct perf_event_header header;
  491. *
  492. * u32 pid, tid;
  493. * char comm[];
  494. * struct sample_id sample_id;
  495. * };
  496. */
  497. PERF_RECORD_COMM = 3,
  498. /*
  499. * struct {
  500. * struct perf_event_header header;
  501. * u32 pid, ppid;
  502. * u32 tid, ptid;
  503. * u64 time;
  504. * struct sample_id sample_id;
  505. * };
  506. */
  507. PERF_RECORD_EXIT = 4,
  508. /*
  509. * struct {
  510. * struct perf_event_header header;
  511. * u64 time;
  512. * u64 id;
  513. * u64 stream_id;
  514. * struct sample_id sample_id;
  515. * };
  516. */
  517. PERF_RECORD_THROTTLE = 5,
  518. PERF_RECORD_UNTHROTTLE = 6,
  519. /*
  520. * struct {
  521. * struct perf_event_header header;
  522. * u32 pid, ppid;
  523. * u32 tid, ptid;
  524. * u64 time;
  525. * struct sample_id sample_id;
  526. * };
  527. */
  528. PERF_RECORD_FORK = 7,
  529. /*
  530. * struct {
  531. * struct perf_event_header header;
  532. * u32 pid, tid;
  533. *
  534. * struct read_format values;
  535. * struct sample_id sample_id;
  536. * };
  537. */
  538. PERF_RECORD_READ = 8,
  539. /*
  540. * struct {
  541. * struct perf_event_header header;
  542. *
  543. * #
  544. * # Note that PERF_SAMPLE_IDENTIFIER duplicates PERF_SAMPLE_ID.
  545. * # The advantage of PERF_SAMPLE_IDENTIFIER is that its position
  546. * # is fixed relative to header.
  547. * #
  548. *
  549. * { u64 id; } && PERF_SAMPLE_IDENTIFIER
  550. * { u64 ip; } && PERF_SAMPLE_IP
  551. * { u32 pid, tid; } && PERF_SAMPLE_TID
  552. * { u64 time; } && PERF_SAMPLE_TIME
  553. * { u64 addr; } && PERF_SAMPLE_ADDR
  554. * { u64 id; } && PERF_SAMPLE_ID
  555. * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
  556. * { u32 cpu, res; } && PERF_SAMPLE_CPU
  557. * { u64 period; } && PERF_SAMPLE_PERIOD
  558. *
  559. * { struct read_format values; } && PERF_SAMPLE_READ
  560. *
  561. * { u64 nr,
  562. * u64 ips[nr]; } && PERF_SAMPLE_CALLCHAIN
  563. *
  564. * #
  565. * # The RAW record below is opaque data wrt the ABI
  566. * #
  567. * # That is, the ABI doesn't make any promises wrt to
  568. * # the stability of its content, it may vary depending
  569. * # on event, hardware, kernel version and phase of
  570. * # the moon.
  571. * #
  572. * # In other words, PERF_SAMPLE_RAW contents are not an ABI.
  573. * #
  574. *
  575. * { u32 size;
  576. * char data[size];}&& PERF_SAMPLE_RAW
  577. *
  578. * { u64 nr;
  579. * { u64 from, to, flags } lbr[nr];} && PERF_SAMPLE_BRANCH_STACK
  580. *
  581. * { u64 abi; # enum perf_sample_regs_abi
  582. * u64 regs[weight(mask)]; } && PERF_SAMPLE_REGS_USER
  583. *
  584. * { u64 size;
  585. * char data[size];
  586. * u64 dyn_size; } && PERF_SAMPLE_STACK_USER
  587. *
  588. * { u64 weight; } && PERF_SAMPLE_WEIGHT
  589. * { u64 data_src; } && PERF_SAMPLE_DATA_SRC
  590. * };
  591. */
  592. PERF_RECORD_SAMPLE = 9,
  593. /*
  594. * The MMAP2 records are an augmented version of MMAP, they add
  595. * maj, min, ino numbers to be used to uniquely identify each mapping
  596. *
  597. * struct {
  598. * struct perf_event_header header;
  599. *
  600. * u32 pid, tid;
  601. * u64 addr;
  602. * u64 len;
  603. * u64 pgoff;
  604. * u32 maj;
  605. * u32 min;
  606. * u64 ino;
  607. * u64 ino_generation;
  608. * char filename[];
  609. * struct sample_id sample_id;
  610. * };
  611. */
  612. PERF_RECORD_MMAP2 = 10,
  613. PERF_RECORD_MAX, /* non-ABI */
  614. };
  615. #define PERF_MAX_STACK_DEPTH 127
  616. enum perf_callchain_context {
  617. PERF_CONTEXT_HV = (__u64)-32,
  618. PERF_CONTEXT_KERNEL = (__u64)-128,
  619. PERF_CONTEXT_USER = (__u64)-512,
  620. PERF_CONTEXT_GUEST = (__u64)-2048,
  621. PERF_CONTEXT_GUEST_KERNEL = (__u64)-2176,
  622. PERF_CONTEXT_GUEST_USER = (__u64)-2560,
  623. PERF_CONTEXT_MAX = (__u64)-4095,
  624. };
  625. #define PERF_FLAG_FD_NO_GROUP (1U << 0)
  626. #define PERF_FLAG_FD_OUTPUT (1U << 1)
  627. #define PERF_FLAG_PID_CGROUP (1U << 2) /* pid=cgroup id, per-cpu mode only */
  628. union perf_mem_data_src {
  629. __u64 val;
  630. struct {
  631. __u64 mem_op:5, /* type of opcode */
  632. mem_lvl:14, /* memory hierarchy level */
  633. mem_snoop:5, /* snoop mode */
  634. mem_lock:2, /* lock instr */
  635. mem_dtlb:7, /* tlb access */
  636. mem_rsvd:31;
  637. };
  638. };
  639. /* type of opcode (load/store/prefetch,code) */
  640. #define PERF_MEM_OP_NA 0x01 /* not available */
  641. #define PERF_MEM_OP_LOAD 0x02 /* load instruction */
  642. #define PERF_MEM_OP_STORE 0x04 /* store instruction */
  643. #define PERF_MEM_OP_PFETCH 0x08 /* prefetch */
  644. #define PERF_MEM_OP_EXEC 0x10 /* code (execution) */
  645. #define PERF_MEM_OP_SHIFT 0
  646. /* memory hierarchy (memory level, hit or miss) */
  647. #define PERF_MEM_LVL_NA 0x01 /* not available */
  648. #define PERF_MEM_LVL_HIT 0x02 /* hit level */
  649. #define PERF_MEM_LVL_MISS 0x04 /* miss level */
  650. #define PERF_MEM_LVL_L1 0x08 /* L1 */
  651. #define PERF_MEM_LVL_LFB 0x10 /* Line Fill Buffer */
  652. #define PERF_MEM_LVL_L2 0x20 /* L2 */
  653. #define PERF_MEM_LVL_L3 0x40 /* L3 */
  654. #define PERF_MEM_LVL_LOC_RAM 0x80 /* Local DRAM */
  655. #define PERF_MEM_LVL_REM_RAM1 0x100 /* Remote DRAM (1 hop) */
  656. #define PERF_MEM_LVL_REM_RAM2 0x200 /* Remote DRAM (2 hops) */
  657. #define PERF_MEM_LVL_REM_CCE1 0x400 /* Remote Cache (1 hop) */
  658. #define PERF_MEM_LVL_REM_CCE2 0x800 /* Remote Cache (2 hops) */
  659. #define PERF_MEM_LVL_IO 0x1000 /* I/O memory */
  660. #define PERF_MEM_LVL_UNC 0x2000 /* Uncached memory */
  661. #define PERF_MEM_LVL_SHIFT 5
  662. /* snoop mode */
  663. #define PERF_MEM_SNOOP_NA 0x01 /* not available */
  664. #define PERF_MEM_SNOOP_NONE 0x02 /* no snoop */
  665. #define PERF_MEM_SNOOP_HIT 0x04 /* snoop hit */
  666. #define PERF_MEM_SNOOP_MISS 0x08 /* snoop miss */
  667. #define PERF_MEM_SNOOP_HITM 0x10 /* snoop hit modified */
  668. #define PERF_MEM_SNOOP_SHIFT 19
  669. /* locked instruction */
  670. #define PERF_MEM_LOCK_NA 0x01 /* not available */
  671. #define PERF_MEM_LOCK_LOCKED 0x02 /* locked transaction */
  672. #define PERF_MEM_LOCK_SHIFT 24
  673. /* TLB access */
  674. #define PERF_MEM_TLB_NA 0x01 /* not available */
  675. #define PERF_MEM_TLB_HIT 0x02 /* hit level */
  676. #define PERF_MEM_TLB_MISS 0x04 /* miss level */
  677. #define PERF_MEM_TLB_L1 0x08 /* L1 */
  678. #define PERF_MEM_TLB_L2 0x10 /* L2 */
  679. #define PERF_MEM_TLB_WK 0x20 /* Hardware Walker*/
  680. #define PERF_MEM_TLB_OS 0x40 /* OS fault handler */
  681. #define PERF_MEM_TLB_SHIFT 26
  682. #define PERF_MEM_S(a, s) \
  683. (((u64)PERF_MEM_##a##_##s) << PERF_MEM_##a##_SHIFT)
  684. /*
  685. * single taken branch record layout:
  686. *
  687. * from: source instruction (may not always be a branch insn)
  688. * to: branch target
  689. * mispred: branch target was mispredicted
  690. * predicted: branch target was predicted
  691. *
  692. * support for mispred, predicted is optional. In case it
  693. * is not supported mispred = predicted = 0.
  694. *
  695. * in_tx: running in a hardware transaction
  696. * abort: aborting a hardware transaction
  697. */
  698. struct perf_branch_entry {
  699. __u64 from;
  700. __u64 to;
  701. __u64 mispred:1, /* target mispredicted */
  702. predicted:1,/* target predicted */
  703. in_tx:1, /* in transaction */
  704. abort:1, /* transaction abort */
  705. reserved:60;
  706. };
  707. #endif /* _UAPI_LINUX_PERF_EVENT_H */