perf_event.h 42 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448
  1. /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
  2. /*
  3. * Performance events:
  4. *
  5. * Copyright (C) 2008-2009, Thomas Gleixner <tglx@linutronix.de>
  6. * Copyright (C) 2008-2011, Red Hat, Inc., Ingo Molnar
  7. * Copyright (C) 2008-2011, Red Hat, Inc., Peter Zijlstra
  8. *
  9. * Data type definitions, declarations, prototypes.
  10. *
  11. * Started by: Thomas Gleixner and Ingo Molnar
  12. *
  13. * For licencing details see kernel-base/COPYING
  14. */
  15. #ifndef _LINUX_PERF_EVENT_H
  16. #define _LINUX_PERF_EVENT_H
  17. #include <linux/types.h>
  18. #include <linux/ioctl.h>
  19. #include <asm/byteorder.h>
  20. /*
  21. * User-space ABI bits:
  22. */
  23. /*
  24. * attr.type
  25. */
  26. enum perf_type_id {
  27. PERF_TYPE_HARDWARE = 0,
  28. PERF_TYPE_SOFTWARE = 1,
  29. PERF_TYPE_TRACEPOINT = 2,
  30. PERF_TYPE_HW_CACHE = 3,
  31. PERF_TYPE_RAW = 4,
  32. PERF_TYPE_BREAKPOINT = 5,
  33. PERF_TYPE_MAX, /* non-ABI */
  34. };
  35. /*
  36. * attr.config layout for type PERF_TYPE_HARDWARE and PERF_TYPE_HW_CACHE
  37. * PERF_TYPE_HARDWARE: 0xEEEEEEEE000000AA
  38. * AA: hardware event ID
  39. * EEEEEEEE: PMU type ID
  40. * PERF_TYPE_HW_CACHE: 0xEEEEEEEE00DDCCBB
  41. * BB: hardware cache ID
  42. * CC: hardware cache op ID
  43. * DD: hardware cache op result ID
  44. * EEEEEEEE: PMU type ID
  45. * If the PMU type ID is 0, the PERF_TYPE_RAW will be applied.
  46. */
  47. #define PERF_PMU_TYPE_SHIFT 32
  48. #define PERF_HW_EVENT_MASK 0xffffffff
  49. /*
  50. * Generalized performance event event_id types, used by the
  51. * attr.event_id parameter of the sys_perf_event_open()
  52. * syscall:
  53. */
  54. enum perf_hw_id {
  55. /*
  56. * Common hardware events, generalized by the kernel:
  57. */
  58. PERF_COUNT_HW_CPU_CYCLES = 0,
  59. PERF_COUNT_HW_INSTRUCTIONS = 1,
  60. PERF_COUNT_HW_CACHE_REFERENCES = 2,
  61. PERF_COUNT_HW_CACHE_MISSES = 3,
  62. PERF_COUNT_HW_BRANCH_INSTRUCTIONS = 4,
  63. PERF_COUNT_HW_BRANCH_MISSES = 5,
  64. PERF_COUNT_HW_BUS_CYCLES = 6,
  65. PERF_COUNT_HW_STALLED_CYCLES_FRONTEND = 7,
  66. PERF_COUNT_HW_STALLED_CYCLES_BACKEND = 8,
  67. PERF_COUNT_HW_REF_CPU_CYCLES = 9,
  68. PERF_COUNT_HW_MAX, /* non-ABI */
  69. };
  70. /*
  71. * Generalized hardware cache events:
  72. *
  73. * { L1-D, L1-I, LLC, ITLB, DTLB, BPU, NODE } x
  74. * { read, write, prefetch } x
  75. * { accesses, misses }
  76. */
  77. enum perf_hw_cache_id {
  78. PERF_COUNT_HW_CACHE_L1D = 0,
  79. PERF_COUNT_HW_CACHE_L1I = 1,
  80. PERF_COUNT_HW_CACHE_LL = 2,
  81. PERF_COUNT_HW_CACHE_DTLB = 3,
  82. PERF_COUNT_HW_CACHE_ITLB = 4,
  83. PERF_COUNT_HW_CACHE_BPU = 5,
  84. PERF_COUNT_HW_CACHE_NODE = 6,
  85. PERF_COUNT_HW_CACHE_MAX, /* non-ABI */
  86. };
  87. enum perf_hw_cache_op_id {
  88. PERF_COUNT_HW_CACHE_OP_READ = 0,
  89. PERF_COUNT_HW_CACHE_OP_WRITE = 1,
  90. PERF_COUNT_HW_CACHE_OP_PREFETCH = 2,
  91. PERF_COUNT_HW_CACHE_OP_MAX, /* non-ABI */
  92. };
  93. enum perf_hw_cache_op_result_id {
  94. PERF_COUNT_HW_CACHE_RESULT_ACCESS = 0,
  95. PERF_COUNT_HW_CACHE_RESULT_MISS = 1,
  96. PERF_COUNT_HW_CACHE_RESULT_MAX, /* non-ABI */
  97. };
  98. /*
  99. * Special "software" events provided by the kernel, even if the hardware
  100. * does not support performance events. These events measure various
  101. * physical and sw events of the kernel (and allow the profiling of them as
  102. * well):
  103. */
  104. enum perf_sw_ids {
  105. PERF_COUNT_SW_CPU_CLOCK = 0,
  106. PERF_COUNT_SW_TASK_CLOCK = 1,
  107. PERF_COUNT_SW_PAGE_FAULTS = 2,
  108. PERF_COUNT_SW_CONTEXT_SWITCHES = 3,
  109. PERF_COUNT_SW_CPU_MIGRATIONS = 4,
  110. PERF_COUNT_SW_PAGE_FAULTS_MIN = 5,
  111. PERF_COUNT_SW_PAGE_FAULTS_MAJ = 6,
  112. PERF_COUNT_SW_ALIGNMENT_FAULTS = 7,
  113. PERF_COUNT_SW_EMULATION_FAULTS = 8,
  114. PERF_COUNT_SW_DUMMY = 9,
  115. PERF_COUNT_SW_BPF_OUTPUT = 10,
  116. PERF_COUNT_SW_CGROUP_SWITCHES = 11,
  117. PERF_COUNT_SW_MAX, /* non-ABI */
  118. };
  119. /*
  120. * Bits that can be set in attr.sample_type to request information
  121. * in the overflow packets.
  122. */
  123. enum perf_event_sample_format {
  124. PERF_SAMPLE_IP = 1U << 0,
  125. PERF_SAMPLE_TID = 1U << 1,
  126. PERF_SAMPLE_TIME = 1U << 2,
  127. PERF_SAMPLE_ADDR = 1U << 3,
  128. PERF_SAMPLE_READ = 1U << 4,
  129. PERF_SAMPLE_CALLCHAIN = 1U << 5,
  130. PERF_SAMPLE_ID = 1U << 6,
  131. PERF_SAMPLE_CPU = 1U << 7,
  132. PERF_SAMPLE_PERIOD = 1U << 8,
  133. PERF_SAMPLE_STREAM_ID = 1U << 9,
  134. PERF_SAMPLE_RAW = 1U << 10,
  135. PERF_SAMPLE_BRANCH_STACK = 1U << 11,
  136. PERF_SAMPLE_REGS_USER = 1U << 12,
  137. PERF_SAMPLE_STACK_USER = 1U << 13,
  138. PERF_SAMPLE_WEIGHT = 1U << 14,
  139. PERF_SAMPLE_DATA_SRC = 1U << 15,
  140. PERF_SAMPLE_IDENTIFIER = 1U << 16,
  141. PERF_SAMPLE_TRANSACTION = 1U << 17,
  142. PERF_SAMPLE_REGS_INTR = 1U << 18,
  143. PERF_SAMPLE_PHYS_ADDR = 1U << 19,
  144. PERF_SAMPLE_AUX = 1U << 20,
  145. PERF_SAMPLE_CGROUP = 1U << 21,
  146. PERF_SAMPLE_DATA_PAGE_SIZE = 1U << 22,
  147. PERF_SAMPLE_CODE_PAGE_SIZE = 1U << 23,
  148. PERF_SAMPLE_WEIGHT_STRUCT = 1U << 24,
  149. PERF_SAMPLE_MAX = 1U << 25, /* non-ABI */
  150. };
  151. #define PERF_SAMPLE_WEIGHT_TYPE (PERF_SAMPLE_WEIGHT | PERF_SAMPLE_WEIGHT_STRUCT)
  152. /*
  153. * values to program into branch_sample_type when PERF_SAMPLE_BRANCH is set
  154. *
  155. * If the user does not pass priv level information via branch_sample_type,
  156. * the kernel uses the event's priv level. Branch and event priv levels do
  157. * not have to match. Branch priv level is checked for permissions.
  158. *
  159. * The branch types can be combined, however BRANCH_ANY covers all types
  160. * of branches and therefore it supersedes all the other types.
  161. */
  162. enum perf_branch_sample_type_shift {
  163. PERF_SAMPLE_BRANCH_USER_SHIFT = 0, /* user branches */
  164. PERF_SAMPLE_BRANCH_KERNEL_SHIFT = 1, /* kernel branches */
  165. PERF_SAMPLE_BRANCH_HV_SHIFT = 2, /* hypervisor branches */
  166. PERF_SAMPLE_BRANCH_ANY_SHIFT = 3, /* any branch types */
  167. PERF_SAMPLE_BRANCH_ANY_CALL_SHIFT = 4, /* any call branch */
  168. PERF_SAMPLE_BRANCH_ANY_RETURN_SHIFT = 5, /* any return branch */
  169. PERF_SAMPLE_BRANCH_IND_CALL_SHIFT = 6, /* indirect calls */
  170. PERF_SAMPLE_BRANCH_ABORT_TX_SHIFT = 7, /* transaction aborts */
  171. PERF_SAMPLE_BRANCH_IN_TX_SHIFT = 8, /* in transaction */
  172. PERF_SAMPLE_BRANCH_NO_TX_SHIFT = 9, /* not in transaction */
  173. PERF_SAMPLE_BRANCH_COND_SHIFT = 10, /* conditional branches */
  174. PERF_SAMPLE_BRANCH_CALL_STACK_SHIFT = 11, /* call/ret stack */
  175. PERF_SAMPLE_BRANCH_IND_JUMP_SHIFT = 12, /* indirect jumps */
  176. PERF_SAMPLE_BRANCH_CALL_SHIFT = 13, /* direct call */
  177. PERF_SAMPLE_BRANCH_NO_FLAGS_SHIFT = 14, /* no flags */
  178. PERF_SAMPLE_BRANCH_NO_CYCLES_SHIFT = 15, /* no cycles */
  179. PERF_SAMPLE_BRANCH_TYPE_SAVE_SHIFT = 16, /* save branch type */
  180. PERF_SAMPLE_BRANCH_HW_INDEX_SHIFT = 17, /* save low level index of raw branch records */
  181. PERF_SAMPLE_BRANCH_PRIV_SAVE_SHIFT = 18, /* save privilege mode */
  182. PERF_SAMPLE_BRANCH_MAX_SHIFT /* non-ABI */
  183. };
  184. enum perf_branch_sample_type {
  185. PERF_SAMPLE_BRANCH_USER = 1U << PERF_SAMPLE_BRANCH_USER_SHIFT,
  186. PERF_SAMPLE_BRANCH_KERNEL = 1U << PERF_SAMPLE_BRANCH_KERNEL_SHIFT,
  187. PERF_SAMPLE_BRANCH_HV = 1U << PERF_SAMPLE_BRANCH_HV_SHIFT,
  188. PERF_SAMPLE_BRANCH_ANY = 1U << PERF_SAMPLE_BRANCH_ANY_SHIFT,
  189. PERF_SAMPLE_BRANCH_ANY_CALL = 1U << PERF_SAMPLE_BRANCH_ANY_CALL_SHIFT,
  190. PERF_SAMPLE_BRANCH_ANY_RETURN = 1U << PERF_SAMPLE_BRANCH_ANY_RETURN_SHIFT,
  191. PERF_SAMPLE_BRANCH_IND_CALL = 1U << PERF_SAMPLE_BRANCH_IND_CALL_SHIFT,
  192. PERF_SAMPLE_BRANCH_ABORT_TX = 1U << PERF_SAMPLE_BRANCH_ABORT_TX_SHIFT,
  193. PERF_SAMPLE_BRANCH_IN_TX = 1U << PERF_SAMPLE_BRANCH_IN_TX_SHIFT,
  194. PERF_SAMPLE_BRANCH_NO_TX = 1U << PERF_SAMPLE_BRANCH_NO_TX_SHIFT,
  195. PERF_SAMPLE_BRANCH_COND = 1U << PERF_SAMPLE_BRANCH_COND_SHIFT,
  196. PERF_SAMPLE_BRANCH_CALL_STACK = 1U << PERF_SAMPLE_BRANCH_CALL_STACK_SHIFT,
  197. PERF_SAMPLE_BRANCH_IND_JUMP = 1U << PERF_SAMPLE_BRANCH_IND_JUMP_SHIFT,
  198. PERF_SAMPLE_BRANCH_CALL = 1U << PERF_SAMPLE_BRANCH_CALL_SHIFT,
  199. PERF_SAMPLE_BRANCH_NO_FLAGS = 1U << PERF_SAMPLE_BRANCH_NO_FLAGS_SHIFT,
  200. PERF_SAMPLE_BRANCH_NO_CYCLES = 1U << PERF_SAMPLE_BRANCH_NO_CYCLES_SHIFT,
  201. PERF_SAMPLE_BRANCH_TYPE_SAVE =
  202. 1U << PERF_SAMPLE_BRANCH_TYPE_SAVE_SHIFT,
  203. PERF_SAMPLE_BRANCH_HW_INDEX = 1U << PERF_SAMPLE_BRANCH_HW_INDEX_SHIFT,
  204. PERF_SAMPLE_BRANCH_PRIV_SAVE = 1U << PERF_SAMPLE_BRANCH_PRIV_SAVE_SHIFT,
  205. PERF_SAMPLE_BRANCH_MAX = 1U << PERF_SAMPLE_BRANCH_MAX_SHIFT,
  206. };
  207. /*
  208. * Common flow change classification
  209. */
  210. enum {
  211. PERF_BR_UNKNOWN = 0, /* unknown */
  212. PERF_BR_COND = 1, /* conditional */
  213. PERF_BR_UNCOND = 2, /* unconditional */
  214. PERF_BR_IND = 3, /* indirect */
  215. PERF_BR_CALL = 4, /* function call */
  216. PERF_BR_IND_CALL = 5, /* indirect function call */
  217. PERF_BR_RET = 6, /* function return */
  218. PERF_BR_SYSCALL = 7, /* syscall */
  219. PERF_BR_SYSRET = 8, /* syscall return */
  220. PERF_BR_COND_CALL = 9, /* conditional function call */
  221. PERF_BR_COND_RET = 10, /* conditional function return */
  222. PERF_BR_ERET = 11, /* exception return */
  223. PERF_BR_IRQ = 12, /* irq */
  224. PERF_BR_SERROR = 13, /* system error */
  225. PERF_BR_NO_TX = 14, /* not in transaction */
  226. PERF_BR_EXTEND_ABI = 15, /* extend ABI */
  227. PERF_BR_MAX,
  228. };
  229. /*
  230. * Common branch speculation outcome classification
  231. */
  232. enum {
  233. PERF_BR_SPEC_NA = 0, /* Not available */
  234. PERF_BR_SPEC_WRONG_PATH = 1, /* Speculative but on wrong path */
  235. PERF_BR_NON_SPEC_CORRECT_PATH = 2, /* Non-speculative but on correct path */
  236. PERF_BR_SPEC_CORRECT_PATH = 3, /* Speculative and on correct path */
  237. PERF_BR_SPEC_MAX,
  238. };
  239. enum {
  240. PERF_BR_NEW_FAULT_ALGN = 0, /* Alignment fault */
  241. PERF_BR_NEW_FAULT_DATA = 1, /* Data fault */
  242. PERF_BR_NEW_FAULT_INST = 2, /* Inst fault */
  243. PERF_BR_NEW_ARCH_1 = 3, /* Architecture specific */
  244. PERF_BR_NEW_ARCH_2 = 4, /* Architecture specific */
  245. PERF_BR_NEW_ARCH_3 = 5, /* Architecture specific */
  246. PERF_BR_NEW_ARCH_4 = 6, /* Architecture specific */
  247. PERF_BR_NEW_ARCH_5 = 7, /* Architecture specific */
  248. PERF_BR_NEW_MAX,
  249. };
  250. enum {
  251. PERF_BR_PRIV_UNKNOWN = 0,
  252. PERF_BR_PRIV_USER = 1,
  253. PERF_BR_PRIV_KERNEL = 2,
  254. PERF_BR_PRIV_HV = 3,
  255. };
  256. #define PERF_BR_ARM64_FIQ PERF_BR_NEW_ARCH_1
  257. #define PERF_BR_ARM64_DEBUG_HALT PERF_BR_NEW_ARCH_2
  258. #define PERF_BR_ARM64_DEBUG_EXIT PERF_BR_NEW_ARCH_3
  259. #define PERF_BR_ARM64_DEBUG_INST PERF_BR_NEW_ARCH_4
  260. #define PERF_BR_ARM64_DEBUG_DATA PERF_BR_NEW_ARCH_5
  261. #define PERF_SAMPLE_BRANCH_PLM_ALL \
  262. (PERF_SAMPLE_BRANCH_USER|\
  263. PERF_SAMPLE_BRANCH_KERNEL|\
  264. PERF_SAMPLE_BRANCH_HV)
  265. /*
  266. * Values to determine ABI of the registers dump.
  267. */
  268. enum perf_sample_regs_abi {
  269. PERF_SAMPLE_REGS_ABI_NONE = 0,
  270. PERF_SAMPLE_REGS_ABI_32 = 1,
  271. PERF_SAMPLE_REGS_ABI_64 = 2,
  272. };
  273. /*
  274. * Values for the memory transaction event qualifier, mostly for
  275. * abort events. Multiple bits can be set.
  276. */
  277. enum {
  278. PERF_TXN_ELISION = (1 << 0), /* From elision */
  279. PERF_TXN_TRANSACTION = (1 << 1), /* From transaction */
  280. PERF_TXN_SYNC = (1 << 2), /* Instruction is related */
  281. PERF_TXN_ASYNC = (1 << 3), /* Instruction not related */
  282. PERF_TXN_RETRY = (1 << 4), /* Retry possible */
  283. PERF_TXN_CONFLICT = (1 << 5), /* Conflict abort */
  284. PERF_TXN_CAPACITY_WRITE = (1 << 6), /* Capacity write abort */
  285. PERF_TXN_CAPACITY_READ = (1 << 7), /* Capacity read abort */
  286. PERF_TXN_MAX = (1 << 8), /* non-ABI */
  287. /* bits 32..63 are reserved for the abort code */
  288. PERF_TXN_ABORT_MASK = (0xffffffffULL << 32),
  289. PERF_TXN_ABORT_SHIFT = 32,
  290. };
  291. /*
  292. * The format of the data returned by read() on a perf event fd,
  293. * as specified by attr.read_format:
  294. *
  295. * struct read_format {
  296. * { u64 value;
  297. * { u64 time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
  298. * { u64 time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
  299. * { u64 id; } && PERF_FORMAT_ID
  300. * { u64 lost; } && PERF_FORMAT_LOST
  301. * } && !PERF_FORMAT_GROUP
  302. *
  303. * { u64 nr;
  304. * { u64 time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
  305. * { u64 time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
  306. * { u64 value;
  307. * { u64 id; } && PERF_FORMAT_ID
  308. * { u64 lost; } && PERF_FORMAT_LOST
  309. * } cntr[nr];
  310. * } && PERF_FORMAT_GROUP
  311. * };
  312. */
  313. enum perf_event_read_format {
  314. PERF_FORMAT_TOTAL_TIME_ENABLED = 1U << 0,
  315. PERF_FORMAT_TOTAL_TIME_RUNNING = 1U << 1,
  316. PERF_FORMAT_ID = 1U << 2,
  317. PERF_FORMAT_GROUP = 1U << 3,
  318. PERF_FORMAT_LOST = 1U << 4,
  319. PERF_FORMAT_MAX = 1U << 5, /* non-ABI */
  320. };
  321. #define PERF_ATTR_SIZE_VER0 64 /* sizeof first published struct */
  322. #define PERF_ATTR_SIZE_VER1 72 /* add: config2 */
  323. #define PERF_ATTR_SIZE_VER2 80 /* add: branch_sample_type */
  324. #define PERF_ATTR_SIZE_VER3 96 /* add: sample_regs_user */
  325. /* add: sample_stack_user */
  326. #define PERF_ATTR_SIZE_VER4 104 /* add: sample_regs_intr */
  327. #define PERF_ATTR_SIZE_VER5 112 /* add: aux_watermark */
  328. #define PERF_ATTR_SIZE_VER6 120 /* add: aux_sample_size */
  329. #define PERF_ATTR_SIZE_VER7 128 /* add: sig_data */
  330. #define PERF_ATTR_SIZE_VER8 136 /* add: config3 */
  331. /*
  332. * Hardware event_id to monitor via a performance monitoring event:
  333. *
  334. * @sample_max_stack: Max number of frame pointers in a callchain,
  335. * should be < /proc/sys/kernel/perf_event_max_stack
  336. */
  337. struct perf_event_attr {
  338. /*
  339. * Major type: hardware/software/tracepoint/etc.
  340. */
  341. __u32 type;
  342. /*
  343. * Size of the attr structure, for fwd/bwd compat.
  344. */
  345. __u32 size;
  346. /*
  347. * Type specific configuration information.
  348. */
  349. __u64 config;
  350. union {
  351. __u64 sample_period;
  352. __u64 sample_freq;
  353. };
  354. __u64 sample_type;
  355. __u64 read_format;
  356. __u64 disabled : 1, /* off by default */
  357. inherit : 1, /* children inherit it */
  358. pinned : 1, /* must always be on PMU */
  359. exclusive : 1, /* only group on PMU */
  360. exclude_user : 1, /* don't count user */
  361. exclude_kernel : 1, /* ditto kernel */
  362. exclude_hv : 1, /* ditto hypervisor */
  363. exclude_idle : 1, /* don't count when idle */
  364. mmap : 1, /* include mmap data */
  365. comm : 1, /* include comm data */
  366. freq : 1, /* use freq, not period */
  367. inherit_stat : 1, /* per task counts */
  368. enable_on_exec : 1, /* next exec enables */
  369. task : 1, /* trace fork/exit */
  370. watermark : 1, /* wakeup_watermark */
  371. /*
  372. * precise_ip:
  373. *
  374. * 0 - SAMPLE_IP can have arbitrary skid
  375. * 1 - SAMPLE_IP must have constant skid
  376. * 2 - SAMPLE_IP requested to have 0 skid
  377. * 3 - SAMPLE_IP must have 0 skid
  378. *
  379. * See also PERF_RECORD_MISC_EXACT_IP
  380. */
  381. precise_ip : 2, /* skid constraint */
  382. mmap_data : 1, /* non-exec mmap data */
  383. sample_id_all : 1, /* sample_type all events */
  384. exclude_host : 1, /* don't count in host */
  385. exclude_guest : 1, /* don't count in guest */
  386. exclude_callchain_kernel : 1, /* exclude kernel callchains */
  387. exclude_callchain_user : 1, /* exclude user callchains */
  388. mmap2 : 1, /* include mmap with inode data */
  389. comm_exec : 1, /* flag comm events that are due to an exec */
  390. use_clockid : 1, /* use @clockid for time fields */
  391. context_switch : 1, /* context switch data */
  392. write_backward : 1, /* Write ring buffer from end to beginning */
  393. namespaces : 1, /* include namespaces data */
  394. ksymbol : 1, /* include ksymbol events */
  395. bpf_event : 1, /* include bpf events */
  396. aux_output : 1, /* generate AUX records instead of events */
  397. cgroup : 1, /* include cgroup events */
  398. text_poke : 1, /* include text poke events */
  399. build_id : 1, /* use build id in mmap2 events */
  400. inherit_thread : 1, /* children only inherit if cloned with CLONE_THREAD */
  401. remove_on_exec : 1, /* event is removed from task on exec */
  402. sigtrap : 1, /* send synchronous SIGTRAP on event */
  403. __reserved_1 : 26;
  404. union {
  405. __u32 wakeup_events; /* wakeup every n events */
  406. __u32 wakeup_watermark; /* bytes before wakeup */
  407. };
  408. __u32 bp_type;
  409. union {
  410. __u64 bp_addr;
  411. __u64 kprobe_func; /* for perf_kprobe */
  412. __u64 uprobe_path; /* for perf_uprobe */
  413. __u64 config1; /* extension of config */
  414. };
  415. union {
  416. __u64 bp_len;
  417. __u64 kprobe_addr; /* when kprobe_func == NULL */
  418. __u64 probe_offset; /* for perf_[k,u]probe */
  419. __u64 config2; /* extension of config1 */
  420. };
  421. __u64 branch_sample_type; /* enum perf_branch_sample_type */
  422. /*
  423. * Defines set of user regs to dump on samples.
  424. * See asm/perf_regs.h for details.
  425. */
  426. __u64 sample_regs_user;
  427. /*
  428. * Defines size of the user stack to dump on samples.
  429. */
  430. __u32 sample_stack_user;
  431. __s32 clockid;
  432. /*
  433. * Defines set of regs to dump for each sample
  434. * state captured on:
  435. * - precise = 0: PMU interrupt
  436. * - precise > 0: sampled instruction
  437. *
  438. * See asm/perf_regs.h for details.
  439. */
  440. __u64 sample_regs_intr;
  441. /*
  442. * Wakeup watermark for AUX area
  443. */
  444. __u32 aux_watermark;
  445. __u16 sample_max_stack;
  446. __u16 __reserved_2;
  447. __u32 aux_sample_size;
  448. __u32 __reserved_3;
  449. /*
  450. * User provided data if sigtrap=1, passed back to user via
  451. * siginfo_t::si_perf_data, e.g. to permit user to identify the event.
  452. * Note, siginfo_t::si_perf_data is long-sized, and sig_data will be
  453. * truncated accordingly on 32 bit architectures.
  454. */
  455. __u64 sig_data;
  456. __u64 config3; /* extension of config2 */
  457. };
  458. /*
  459. * Structure used by below PERF_EVENT_IOC_QUERY_BPF command
  460. * to query bpf programs attached to the same perf tracepoint
  461. * as the given perf event.
  462. */
  463. struct perf_event_query_bpf {
  464. /*
  465. * The below ids array length
  466. */
  467. __u32 ids_len;
  468. /*
  469. * Set by the kernel to indicate the number of
  470. * available programs
  471. */
  472. __u32 prog_cnt;
  473. /*
  474. * User provided buffer to store program ids
  475. */
  476. __u32 ids[];
  477. };
  478. /*
  479. * Ioctls that can be done on a perf event fd:
  480. */
  481. #define PERF_EVENT_IOC_ENABLE _IO ('$', 0)
  482. #define PERF_EVENT_IOC_DISABLE _IO ('$', 1)
  483. #define PERF_EVENT_IOC_REFRESH _IO ('$', 2)
  484. #define PERF_EVENT_IOC_RESET _IO ('$', 3)
  485. #define PERF_EVENT_IOC_PERIOD _IOW('$', 4, __u64)
  486. #define PERF_EVENT_IOC_SET_OUTPUT _IO ('$', 5)
  487. #define PERF_EVENT_IOC_SET_FILTER _IOW('$', 6, char *)
  488. #define PERF_EVENT_IOC_ID _IOR('$', 7, __u64 *)
  489. #define PERF_EVENT_IOC_SET_BPF _IOW('$', 8, __u32)
  490. #define PERF_EVENT_IOC_PAUSE_OUTPUT _IOW('$', 9, __u32)
  491. #define PERF_EVENT_IOC_QUERY_BPF _IOWR('$', 10, struct perf_event_query_bpf *)
  492. #define PERF_EVENT_IOC_MODIFY_ATTRIBUTES _IOW('$', 11, struct perf_event_attr *)
  493. enum perf_event_ioc_flags {
  494. PERF_IOC_FLAG_GROUP = 1U << 0,
  495. };
  496. /*
  497. * Structure of the page that can be mapped via mmap
  498. */
  499. struct perf_event_mmap_page {
  500. __u32 version; /* version number of this structure */
  501. __u32 compat_version; /* lowest version this is compat with */
  502. /*
  503. * Bits needed to read the hw events in user-space.
  504. *
  505. * u32 seq, time_mult, time_shift, index, width;
  506. * u64 count, enabled, running;
  507. * u64 cyc, time_offset;
  508. * s64 pmc = 0;
  509. *
  510. * do {
  511. * seq = pc->lock;
  512. * barrier()
  513. *
  514. * enabled = pc->time_enabled;
  515. * running = pc->time_running;
  516. *
  517. * if (pc->cap_usr_time && enabled != running) {
  518. * cyc = rdtsc();
  519. * time_offset = pc->time_offset;
  520. * time_mult = pc->time_mult;
  521. * time_shift = pc->time_shift;
  522. * }
  523. *
  524. * index = pc->index;
  525. * count = pc->offset;
  526. * if (pc->cap_user_rdpmc && index) {
  527. * width = pc->pmc_width;
  528. * pmc = rdpmc(index - 1);
  529. * }
  530. *
  531. * barrier();
  532. * } while (pc->lock != seq);
  533. *
  534. * NOTE: for obvious reason this only works on self-monitoring
  535. * processes.
  536. */
  537. __u32 lock; /* seqlock for synchronization */
  538. __u32 index; /* hardware event identifier */
  539. __s64 offset; /* add to hardware event value */
  540. __u64 time_enabled; /* time event active */
  541. __u64 time_running; /* time event on cpu */
  542. union {
  543. __u64 capabilities;
  544. struct {
  545. __u64 cap_bit0 : 1, /* Always 0, deprecated, see commit 860f085b74e9 */
  546. cap_bit0_is_deprecated : 1, /* Always 1, signals that bit 0 is zero */
  547. cap_user_rdpmc : 1, /* The RDPMC instruction can be used to read counts */
  548. cap_user_time : 1, /* The time_{shift,mult,offset} fields are used */
  549. cap_user_time_zero : 1, /* The time_zero field is used */
  550. cap_user_time_short : 1, /* the time_{cycle,mask} fields are used */
  551. cap_____res : 58;
  552. };
  553. };
  554. /*
  555. * If cap_user_rdpmc this field provides the bit-width of the value
  556. * read using the rdpmc() or equivalent instruction. This can be used
  557. * to sign extend the result like:
  558. *
  559. * pmc <<= 64 - width;
  560. * pmc >>= 64 - width; // signed shift right
  561. * count += pmc;
  562. */
  563. __u16 pmc_width;
  564. /*
  565. * If cap_usr_time the below fields can be used to compute the time
  566. * delta since time_enabled (in ns) using rdtsc or similar.
  567. *
  568. * u64 quot, rem;
  569. * u64 delta;
  570. *
  571. * quot = (cyc >> time_shift);
  572. * rem = cyc & (((u64)1 << time_shift) - 1);
  573. * delta = time_offset + quot * time_mult +
  574. * ((rem * time_mult) >> time_shift);
  575. *
  576. * Where time_offset,time_mult,time_shift and cyc are read in the
  577. * seqcount loop described above. This delta can then be added to
  578. * enabled and possible running (if index), improving the scaling:
  579. *
  580. * enabled += delta;
  581. * if (index)
  582. * running += delta;
  583. *
  584. * quot = count / running;
  585. * rem = count % running;
  586. * count = quot * enabled + (rem * enabled) / running;
  587. */
  588. __u16 time_shift;
  589. __u32 time_mult;
  590. __u64 time_offset;
  591. /*
  592. * If cap_usr_time_zero, the hardware clock (e.g. TSC) can be calculated
  593. * from sample timestamps.
  594. *
  595. * time = timestamp - time_zero;
  596. * quot = time / time_mult;
  597. * rem = time % time_mult;
  598. * cyc = (quot << time_shift) + (rem << time_shift) / time_mult;
  599. *
  600. * And vice versa:
  601. *
  602. * quot = cyc >> time_shift;
  603. * rem = cyc & (((u64)1 << time_shift) - 1);
  604. * timestamp = time_zero + quot * time_mult +
  605. * ((rem * time_mult) >> time_shift);
  606. */
  607. __u64 time_zero;
  608. __u32 size; /* Header size up to __reserved[] fields. */
  609. __u32 __reserved_1;
  610. /*
  611. * If cap_usr_time_short, the hardware clock is less than 64bit wide
  612. * and we must compute the 'cyc' value, as used by cap_usr_time, as:
  613. *
  614. * cyc = time_cycles + ((cyc - time_cycles) & time_mask)
  615. *
  616. * NOTE: this form is explicitly chosen such that cap_usr_time_short
  617. * is a correction on top of cap_usr_time, and code that doesn't
  618. * know about cap_usr_time_short still works under the assumption
  619. * the counter doesn't wrap.
  620. */
  621. __u64 time_cycles;
  622. __u64 time_mask;
  623. /*
  624. * Hole for extension of the self monitor capabilities
  625. */
  626. __u8 __reserved[116*8]; /* align to 1k. */
  627. /*
  628. * Control data for the mmap() data buffer.
  629. *
  630. * User-space reading the @data_head value should issue an smp_rmb(),
  631. * after reading this value.
  632. *
  633. * When the mapping is PROT_WRITE the @data_tail value should be
  634. * written by userspace to reflect the last read data, after issueing
  635. * an smp_mb() to separate the data read from the ->data_tail store.
  636. * In this case the kernel will not over-write unread data.
  637. *
  638. * See perf_output_put_handle() for the data ordering.
  639. *
  640. * data_{offset,size} indicate the location and size of the perf record
  641. * buffer within the mmapped area.
  642. */
  643. __u64 data_head; /* head in the data section */
  644. __u64 data_tail; /* user-space written tail */
  645. __u64 data_offset; /* where the buffer starts */
  646. __u64 data_size; /* data buffer size */
  647. /*
  648. * AUX area is defined by aux_{offset,size} fields that should be set
  649. * by the userspace, so that
  650. *
  651. * aux_offset >= data_offset + data_size
  652. *
  653. * prior to mmap()ing it. Size of the mmap()ed area should be aux_size.
  654. *
  655. * Ring buffer pointers aux_{head,tail} have the same semantics as
  656. * data_{head,tail} and same ordering rules apply.
  657. */
  658. __u64 aux_head;
  659. __u64 aux_tail;
  660. __u64 aux_offset;
  661. __u64 aux_size;
  662. };
  663. /*
  664. * The current state of perf_event_header::misc bits usage:
  665. * ('|' used bit, '-' unused bit)
  666. *
  667. * 012 CDEF
  668. * |||---------||||
  669. *
  670. * Where:
  671. * 0-2 CPUMODE_MASK
  672. *
  673. * C PROC_MAP_PARSE_TIMEOUT
  674. * D MMAP_DATA / COMM_EXEC / FORK_EXEC / SWITCH_OUT
  675. * E MMAP_BUILD_ID / EXACT_IP / SCHED_OUT_PREEMPT
  676. * F (reserved)
  677. */
  678. #define PERF_RECORD_MISC_CPUMODE_MASK (7 << 0)
  679. #define PERF_RECORD_MISC_CPUMODE_UNKNOWN (0 << 0)
  680. #define PERF_RECORD_MISC_KERNEL (1 << 0)
  681. #define PERF_RECORD_MISC_USER (2 << 0)
  682. #define PERF_RECORD_MISC_HYPERVISOR (3 << 0)
  683. #define PERF_RECORD_MISC_GUEST_KERNEL (4 << 0)
  684. #define PERF_RECORD_MISC_GUEST_USER (5 << 0)
  685. /*
  686. * Indicates that /proc/PID/maps parsing are truncated by time out.
  687. */
  688. #define PERF_RECORD_MISC_PROC_MAP_PARSE_TIMEOUT (1 << 12)
  689. /*
  690. * Following PERF_RECORD_MISC_* are used on different
  691. * events, so can reuse the same bit position:
  692. *
  693. * PERF_RECORD_MISC_MMAP_DATA - PERF_RECORD_MMAP* events
  694. * PERF_RECORD_MISC_COMM_EXEC - PERF_RECORD_COMM event
  695. * PERF_RECORD_MISC_FORK_EXEC - PERF_RECORD_FORK event (perf internal)
  696. * PERF_RECORD_MISC_SWITCH_OUT - PERF_RECORD_SWITCH* events
  697. */
  698. #define PERF_RECORD_MISC_MMAP_DATA (1 << 13)
  699. #define PERF_RECORD_MISC_COMM_EXEC (1 << 13)
  700. #define PERF_RECORD_MISC_FORK_EXEC (1 << 13)
  701. #define PERF_RECORD_MISC_SWITCH_OUT (1 << 13)
  702. /*
  703. * These PERF_RECORD_MISC_* flags below are safely reused
  704. * for the following events:
  705. *
  706. * PERF_RECORD_MISC_EXACT_IP - PERF_RECORD_SAMPLE of precise events
  707. * PERF_RECORD_MISC_SWITCH_OUT_PREEMPT - PERF_RECORD_SWITCH* events
  708. * PERF_RECORD_MISC_MMAP_BUILD_ID - PERF_RECORD_MMAP2 event
  709. *
  710. *
  711. * PERF_RECORD_MISC_EXACT_IP:
  712. * Indicates that the content of PERF_SAMPLE_IP points to
  713. * the actual instruction that triggered the event. See also
  714. * perf_event_attr::precise_ip.
  715. *
  716. * PERF_RECORD_MISC_SWITCH_OUT_PREEMPT:
  717. * Indicates that thread was preempted in TASK_RUNNING state.
  718. *
  719. * PERF_RECORD_MISC_MMAP_BUILD_ID:
  720. * Indicates that mmap2 event carries build id data.
  721. */
  722. #define PERF_RECORD_MISC_EXACT_IP (1 << 14)
  723. #define PERF_RECORD_MISC_SWITCH_OUT_PREEMPT (1 << 14)
  724. #define PERF_RECORD_MISC_MMAP_BUILD_ID (1 << 14)
  725. /*
  726. * Reserve the last bit to indicate some extended misc field
  727. */
  728. #define PERF_RECORD_MISC_EXT_RESERVED (1 << 15)
  729. struct perf_event_header {
  730. __u32 type;
  731. __u16 misc;
  732. __u16 size;
  733. };
  734. struct perf_ns_link_info {
  735. __u64 dev;
  736. __u64 ino;
  737. };
  738. enum {
  739. NET_NS_INDEX = 0,
  740. UTS_NS_INDEX = 1,
  741. IPC_NS_INDEX = 2,
  742. PID_NS_INDEX = 3,
  743. USER_NS_INDEX = 4,
  744. MNT_NS_INDEX = 5,
  745. CGROUP_NS_INDEX = 6,
  746. NR_NAMESPACES, /* number of available namespaces */
  747. };
  748. enum perf_event_type {
  749. /*
  750. * If perf_event_attr.sample_id_all is set then all event types will
  751. * have the sample_type selected fields related to where/when
  752. * (identity) an event took place (TID, TIME, ID, STREAM_ID, CPU,
  753. * IDENTIFIER) described in PERF_RECORD_SAMPLE below, it will be stashed
  754. * just after the perf_event_header and the fields already present for
  755. * the existing fields, i.e. at the end of the payload. That way a newer
  756. * perf.data file will be supported by older perf tools, with these new
  757. * optional fields being ignored.
  758. *
  759. * struct sample_id {
  760. * { u32 pid, tid; } && PERF_SAMPLE_TID
  761. * { u64 time; } && PERF_SAMPLE_TIME
  762. * { u64 id; } && PERF_SAMPLE_ID
  763. * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
  764. * { u32 cpu, res; } && PERF_SAMPLE_CPU
  765. * { u64 id; } && PERF_SAMPLE_IDENTIFIER
  766. * } && perf_event_attr::sample_id_all
  767. *
  768. * Note that PERF_SAMPLE_IDENTIFIER duplicates PERF_SAMPLE_ID. The
  769. * advantage of PERF_SAMPLE_IDENTIFIER is that its position is fixed
  770. * relative to header.size.
  771. */
  772. /*
  773. * The MMAP events record the PROT_EXEC mappings so that we can
  774. * correlate userspace IPs to code. They have the following structure:
  775. *
  776. * struct {
  777. * struct perf_event_header header;
  778. *
  779. * u32 pid, tid;
  780. * u64 addr;
  781. * u64 len;
  782. * u64 pgoff;
  783. * char filename[];
  784. * struct sample_id sample_id;
  785. * };
  786. */
  787. PERF_RECORD_MMAP = 1,
  788. /*
  789. * struct {
  790. * struct perf_event_header header;
  791. * u64 id;
  792. * u64 lost;
  793. * struct sample_id sample_id;
  794. * };
  795. */
  796. PERF_RECORD_LOST = 2,
  797. /*
  798. * struct {
  799. * struct perf_event_header header;
  800. *
  801. * u32 pid, tid;
  802. * char comm[];
  803. * struct sample_id sample_id;
  804. * };
  805. */
  806. PERF_RECORD_COMM = 3,
  807. /*
  808. * struct {
  809. * struct perf_event_header header;
  810. * u32 pid, ppid;
  811. * u32 tid, ptid;
  812. * u64 time;
  813. * struct sample_id sample_id;
  814. * };
  815. */
  816. PERF_RECORD_EXIT = 4,
  817. /*
  818. * struct {
  819. * struct perf_event_header header;
  820. * u64 time;
  821. * u64 id;
  822. * u64 stream_id;
  823. * struct sample_id sample_id;
  824. * };
  825. */
  826. PERF_RECORD_THROTTLE = 5,
  827. PERF_RECORD_UNTHROTTLE = 6,
  828. /*
  829. * struct {
  830. * struct perf_event_header header;
  831. * u32 pid, ppid;
  832. * u32 tid, ptid;
  833. * u64 time;
  834. * struct sample_id sample_id;
  835. * };
  836. */
  837. PERF_RECORD_FORK = 7,
  838. /*
  839. * struct {
  840. * struct perf_event_header header;
  841. * u32 pid, tid;
  842. *
  843. * struct read_format values;
  844. * struct sample_id sample_id;
  845. * };
  846. */
  847. PERF_RECORD_READ = 8,
  848. /*
  849. * struct {
  850. * struct perf_event_header header;
  851. *
  852. * #
  853. * # Note that PERF_SAMPLE_IDENTIFIER duplicates PERF_SAMPLE_ID.
  854. * # The advantage of PERF_SAMPLE_IDENTIFIER is that its position
  855. * # is fixed relative to header.
  856. * #
  857. *
  858. * { u64 id; } && PERF_SAMPLE_IDENTIFIER
  859. * { u64 ip; } && PERF_SAMPLE_IP
  860. * { u32 pid, tid; } && PERF_SAMPLE_TID
  861. * { u64 time; } && PERF_SAMPLE_TIME
  862. * { u64 addr; } && PERF_SAMPLE_ADDR
  863. * { u64 id; } && PERF_SAMPLE_ID
  864. * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
  865. * { u32 cpu, res; } && PERF_SAMPLE_CPU
  866. * { u64 period; } && PERF_SAMPLE_PERIOD
  867. *
  868. * { struct read_format values; } && PERF_SAMPLE_READ
  869. *
  870. * { u64 nr,
  871. * u64 ips[nr]; } && PERF_SAMPLE_CALLCHAIN
  872. *
  873. * #
  874. * # The RAW record below is opaque data wrt the ABI
  875. * #
  876. * # That is, the ABI doesn't make any promises wrt to
  877. * # the stability of its content, it may vary depending
  878. * # on event, hardware, kernel version and phase of
  879. * # the moon.
  880. * #
  881. * # In other words, PERF_SAMPLE_RAW contents are not an ABI.
  882. * #
  883. *
  884. * { u32 size;
  885. * char data[size];}&& PERF_SAMPLE_RAW
  886. *
  887. * { u64 nr;
  888. * { u64 hw_idx; } && PERF_SAMPLE_BRANCH_HW_INDEX
  889. * { u64 from, to, flags } lbr[nr];
  890. * } && PERF_SAMPLE_BRANCH_STACK
  891. *
  892. * { u64 abi; # enum perf_sample_regs_abi
  893. * u64 regs[weight(mask)]; } && PERF_SAMPLE_REGS_USER
  894. *
  895. * { u64 size;
  896. * char data[size];
  897. * u64 dyn_size; } && PERF_SAMPLE_STACK_USER
  898. *
  899. * { union perf_sample_weight
  900. * {
  901. * u64 full; && PERF_SAMPLE_WEIGHT
  902. * #if defined(__LITTLE_ENDIAN_BITFIELD)
  903. * struct {
  904. * u32 var1_dw;
  905. * u16 var2_w;
  906. * u16 var3_w;
  907. * } && PERF_SAMPLE_WEIGHT_STRUCT
  908. * #elif defined(__BIG_ENDIAN_BITFIELD)
  909. * struct {
  910. * u16 var3_w;
  911. * u16 var2_w;
  912. * u32 var1_dw;
  913. * } && PERF_SAMPLE_WEIGHT_STRUCT
  914. * #endif
  915. * }
  916. * }
  917. * { u64 data_src; } && PERF_SAMPLE_DATA_SRC
  918. * { u64 transaction; } && PERF_SAMPLE_TRANSACTION
  919. * { u64 abi; # enum perf_sample_regs_abi
  920. * u64 regs[weight(mask)]; } && PERF_SAMPLE_REGS_INTR
  921. * { u64 phys_addr;} && PERF_SAMPLE_PHYS_ADDR
  922. * { u64 size;
  923. * char data[size]; } && PERF_SAMPLE_AUX
  924. * { u64 data_page_size;} && PERF_SAMPLE_DATA_PAGE_SIZE
  925. * { u64 code_page_size;} && PERF_SAMPLE_CODE_PAGE_SIZE
  926. * };
  927. */
  928. PERF_RECORD_SAMPLE = 9,
  929. /*
  930. * The MMAP2 records are an augmented version of MMAP, they add
  931. * maj, min, ino numbers to be used to uniquely identify each mapping
  932. *
  933. * struct {
  934. * struct perf_event_header header;
  935. *
  936. * u32 pid, tid;
  937. * u64 addr;
  938. * u64 len;
  939. * u64 pgoff;
  940. * union {
  941. * struct {
  942. * u32 maj;
  943. * u32 min;
  944. * u64 ino;
  945. * u64 ino_generation;
  946. * };
  947. * struct {
  948. * u8 build_id_size;
  949. * u8 __reserved_1;
  950. * u16 __reserved_2;
  951. * u8 build_id[20];
  952. * };
  953. * };
  954. * u32 prot, flags;
  955. * char filename[];
  956. * struct sample_id sample_id;
  957. * };
  958. */
  959. PERF_RECORD_MMAP2 = 10,
  960. /*
  961. * Records that new data landed in the AUX buffer part.
  962. *
  963. * struct {
  964. * struct perf_event_header header;
  965. *
  966. * u64 aux_offset;
  967. * u64 aux_size;
  968. * u64 flags;
  969. * struct sample_id sample_id;
  970. * };
  971. */
  972. PERF_RECORD_AUX = 11,
  973. /*
  974. * Indicates that instruction trace has started
  975. *
  976. * struct {
  977. * struct perf_event_header header;
  978. * u32 pid;
  979. * u32 tid;
  980. * struct sample_id sample_id;
  981. * };
  982. */
  983. PERF_RECORD_ITRACE_START = 12,
  984. /*
  985. * Records the dropped/lost sample number.
  986. *
  987. * struct {
  988. * struct perf_event_header header;
  989. *
  990. * u64 lost;
  991. * struct sample_id sample_id;
  992. * };
  993. */
  994. PERF_RECORD_LOST_SAMPLES = 13,
  995. /*
  996. * Records a context switch in or out (flagged by
  997. * PERF_RECORD_MISC_SWITCH_OUT). See also
  998. * PERF_RECORD_SWITCH_CPU_WIDE.
  999. *
  1000. * struct {
  1001. * struct perf_event_header header;
  1002. * struct sample_id sample_id;
  1003. * };
  1004. */
  1005. PERF_RECORD_SWITCH = 14,
  1006. /*
  1007. * CPU-wide version of PERF_RECORD_SWITCH with next_prev_pid and
  1008. * next_prev_tid that are the next (switching out) or previous
  1009. * (switching in) pid/tid.
  1010. *
  1011. * struct {
  1012. * struct perf_event_header header;
  1013. * u32 next_prev_pid;
  1014. * u32 next_prev_tid;
  1015. * struct sample_id sample_id;
  1016. * };
  1017. */
  1018. PERF_RECORD_SWITCH_CPU_WIDE = 15,
  1019. /*
  1020. * struct {
  1021. * struct perf_event_header header;
  1022. * u32 pid;
  1023. * u32 tid;
  1024. * u64 nr_namespaces;
  1025. * { u64 dev, inode; } [nr_namespaces];
  1026. * struct sample_id sample_id;
  1027. * };
  1028. */
  1029. PERF_RECORD_NAMESPACES = 16,
  1030. /*
  1031. * Record ksymbol register/unregister events:
  1032. *
  1033. * struct {
  1034. * struct perf_event_header header;
  1035. * u64 addr;
  1036. * u32 len;
  1037. * u16 ksym_type;
  1038. * u16 flags;
  1039. * char name[];
  1040. * struct sample_id sample_id;
  1041. * };
  1042. */
  1043. PERF_RECORD_KSYMBOL = 17,
  1044. /*
  1045. * Record bpf events:
  1046. * enum perf_bpf_event_type {
  1047. * PERF_BPF_EVENT_UNKNOWN = 0,
  1048. * PERF_BPF_EVENT_PROG_LOAD = 1,
  1049. * PERF_BPF_EVENT_PROG_UNLOAD = 2,
  1050. * };
  1051. *
  1052. * struct {
  1053. * struct perf_event_header header;
  1054. * u16 type;
  1055. * u16 flags;
  1056. * u32 id;
  1057. * u8 tag[BPF_TAG_SIZE];
  1058. * struct sample_id sample_id;
  1059. * };
  1060. */
  1061. PERF_RECORD_BPF_EVENT = 18,
  1062. /*
  1063. * struct {
  1064. * struct perf_event_header header;
  1065. * u64 id;
  1066. * char path[];
  1067. * struct sample_id sample_id;
  1068. * };
  1069. */
  1070. PERF_RECORD_CGROUP = 19,
  1071. /*
  1072. * Records changes to kernel text i.e. self-modified code. 'old_len' is
  1073. * the number of old bytes, 'new_len' is the number of new bytes. Either
  1074. * 'old_len' or 'new_len' may be zero to indicate, for example, the
  1075. * addition or removal of a trampoline. 'bytes' contains the old bytes
  1076. * followed immediately by the new bytes.
  1077. *
  1078. * struct {
  1079. * struct perf_event_header header;
  1080. * u64 addr;
  1081. * u16 old_len;
  1082. * u16 new_len;
  1083. * u8 bytes[];
  1084. * struct sample_id sample_id;
  1085. * };
  1086. */
  1087. PERF_RECORD_TEXT_POKE = 20,
  1088. /*
  1089. * Data written to the AUX area by hardware due to aux_output, may need
  1090. * to be matched to the event by an architecture-specific hardware ID.
  1091. * This records the hardware ID, but requires sample_id to provide the
  1092. * event ID. e.g. Intel PT uses this record to disambiguate PEBS-via-PT
  1093. * records from multiple events.
  1094. *
  1095. * struct {
  1096. * struct perf_event_header header;
  1097. * u64 hw_id;
  1098. * struct sample_id sample_id;
  1099. * };
  1100. */
  1101. PERF_RECORD_AUX_OUTPUT_HW_ID = 21,
  1102. PERF_RECORD_MAX, /* non-ABI */
  1103. };
  1104. enum perf_record_ksymbol_type {
  1105. PERF_RECORD_KSYMBOL_TYPE_UNKNOWN = 0,
  1106. PERF_RECORD_KSYMBOL_TYPE_BPF = 1,
  1107. /*
  1108. * Out of line code such as kprobe-replaced instructions or optimized
  1109. * kprobes or ftrace trampolines.
  1110. */
  1111. PERF_RECORD_KSYMBOL_TYPE_OOL = 2,
  1112. PERF_RECORD_KSYMBOL_TYPE_MAX /* non-ABI */
  1113. };
  1114. #define PERF_RECORD_KSYMBOL_FLAGS_UNREGISTER (1 << 0)
  1115. enum perf_bpf_event_type {
  1116. PERF_BPF_EVENT_UNKNOWN = 0,
  1117. PERF_BPF_EVENT_PROG_LOAD = 1,
  1118. PERF_BPF_EVENT_PROG_UNLOAD = 2,
  1119. PERF_BPF_EVENT_MAX, /* non-ABI */
  1120. };
  1121. #define PERF_MAX_STACK_DEPTH 127
  1122. #define PERF_MAX_CONTEXTS_PER_STACK 8
  1123. enum perf_callchain_context {
  1124. PERF_CONTEXT_HV = (__u64)-32,
  1125. PERF_CONTEXT_KERNEL = (__u64)-128,
  1126. PERF_CONTEXT_USER = (__u64)-512,
  1127. PERF_CONTEXT_GUEST = (__u64)-2048,
  1128. PERF_CONTEXT_GUEST_KERNEL = (__u64)-2176,
  1129. PERF_CONTEXT_GUEST_USER = (__u64)-2560,
  1130. PERF_CONTEXT_MAX = (__u64)-4095,
  1131. };
  1132. /**
  1133. * PERF_RECORD_AUX::flags bits
  1134. */
  1135. #define PERF_AUX_FLAG_TRUNCATED 0x01 /* record was truncated to fit */
  1136. #define PERF_AUX_FLAG_OVERWRITE 0x02 /* snapshot from overwrite mode */
  1137. #define PERF_AUX_FLAG_PARTIAL 0x04 /* record contains gaps */
  1138. #define PERF_AUX_FLAG_COLLISION 0x08 /* sample collided with another */
  1139. #define PERF_AUX_FLAG_PMU_FORMAT_TYPE_MASK 0xff00 /* PMU specific trace format type */
  1140. /* CoreSight PMU AUX buffer formats */
  1141. #define PERF_AUX_FLAG_CORESIGHT_FORMAT_CORESIGHT 0x0000 /* Default for backward compatibility */
  1142. #define PERF_AUX_FLAG_CORESIGHT_FORMAT_RAW 0x0100 /* Raw format of the source */
  1143. #define PERF_FLAG_FD_NO_GROUP (1UL << 0)
  1144. #define PERF_FLAG_FD_OUTPUT (1UL << 1)
  1145. #define PERF_FLAG_PID_CGROUP (1UL << 2) /* pid=cgroup id, per-cpu mode only */
  1146. #define PERF_FLAG_FD_CLOEXEC (1UL << 3) /* O_CLOEXEC */
  1147. #if defined(__LITTLE_ENDIAN_BITFIELD)
  1148. union perf_mem_data_src {
  1149. __u64 val;
  1150. struct {
  1151. __u64 mem_op:5, /* type of opcode */
  1152. mem_lvl:14, /* memory hierarchy level */
  1153. mem_snoop:5, /* snoop mode */
  1154. mem_lock:2, /* lock instr */
  1155. mem_dtlb:7, /* tlb access */
  1156. mem_lvl_num:4, /* memory hierarchy level number */
  1157. mem_remote:1, /* remote */
  1158. mem_snoopx:2, /* snoop mode, ext */
  1159. mem_blk:3, /* access blocked */
  1160. mem_hops:3, /* hop level */
  1161. mem_rsvd:18;
  1162. };
  1163. };
  1164. #elif defined(__BIG_ENDIAN_BITFIELD)
  1165. union perf_mem_data_src {
  1166. __u64 val;
  1167. struct {
  1168. __u64 mem_rsvd:18,
  1169. mem_hops:3, /* hop level */
  1170. mem_blk:3, /* access blocked */
  1171. mem_snoopx:2, /* snoop mode, ext */
  1172. mem_remote:1, /* remote */
  1173. mem_lvl_num:4, /* memory hierarchy level number */
  1174. mem_dtlb:7, /* tlb access */
  1175. mem_lock:2, /* lock instr */
  1176. mem_snoop:5, /* snoop mode */
  1177. mem_lvl:14, /* memory hierarchy level */
  1178. mem_op:5; /* type of opcode */
  1179. };
  1180. };
  1181. #else
  1182. #error "Unknown endianness"
  1183. #endif
  1184. /* type of opcode (load/store/prefetch,code) */
  1185. #define PERF_MEM_OP_NA 0x01 /* not available */
  1186. #define PERF_MEM_OP_LOAD 0x02 /* load instruction */
  1187. #define PERF_MEM_OP_STORE 0x04 /* store instruction */
  1188. #define PERF_MEM_OP_PFETCH 0x08 /* prefetch */
  1189. #define PERF_MEM_OP_EXEC 0x10 /* code (execution) */
  1190. #define PERF_MEM_OP_SHIFT 0
  1191. /*
  1192. * PERF_MEM_LVL_* namespace being depricated to some extent in the
  1193. * favour of newer composite PERF_MEM_{LVLNUM_,REMOTE_,SNOOPX_} fields.
  1194. * Supporting this namespace inorder to not break defined ABIs.
  1195. *
  1196. * memory hierarchy (memory level, hit or miss)
  1197. */
  1198. #define PERF_MEM_LVL_NA 0x01 /* not available */
  1199. #define PERF_MEM_LVL_HIT 0x02 /* hit level */
  1200. #define PERF_MEM_LVL_MISS 0x04 /* miss level */
  1201. #define PERF_MEM_LVL_L1 0x08 /* L1 */
  1202. #define PERF_MEM_LVL_LFB 0x10 /* Line Fill Buffer */
  1203. #define PERF_MEM_LVL_L2 0x20 /* L2 */
  1204. #define PERF_MEM_LVL_L3 0x40 /* L3 */
  1205. #define PERF_MEM_LVL_LOC_RAM 0x80 /* Local DRAM */
  1206. #define PERF_MEM_LVL_REM_RAM1 0x100 /* Remote DRAM (1 hop) */
  1207. #define PERF_MEM_LVL_REM_RAM2 0x200 /* Remote DRAM (2 hops) */
  1208. #define PERF_MEM_LVL_REM_CCE1 0x400 /* Remote Cache (1 hop) */
  1209. #define PERF_MEM_LVL_REM_CCE2 0x800 /* Remote Cache (2 hops) */
  1210. #define PERF_MEM_LVL_IO 0x1000 /* I/O memory */
  1211. #define PERF_MEM_LVL_UNC 0x2000 /* Uncached memory */
  1212. #define PERF_MEM_LVL_SHIFT 5
  1213. #define PERF_MEM_REMOTE_REMOTE 0x01 /* Remote */
  1214. #define PERF_MEM_REMOTE_SHIFT 37
  1215. #define PERF_MEM_LVLNUM_L1 0x01 /* L1 */
  1216. #define PERF_MEM_LVLNUM_L2 0x02 /* L2 */
  1217. #define PERF_MEM_LVLNUM_L3 0x03 /* L3 */
  1218. #define PERF_MEM_LVLNUM_L4 0x04 /* L4 */
  1219. /* 5-0x8 available */
  1220. #define PERF_MEM_LVLNUM_CXL 0x09 /* CXL */
  1221. #define PERF_MEM_LVLNUM_IO 0x0a /* I/O */
  1222. #define PERF_MEM_LVLNUM_ANY_CACHE 0x0b /* Any cache */
  1223. #define PERF_MEM_LVLNUM_LFB 0x0c /* LFB */
  1224. #define PERF_MEM_LVLNUM_RAM 0x0d /* RAM */
  1225. #define PERF_MEM_LVLNUM_PMEM 0x0e /* PMEM */
  1226. #define PERF_MEM_LVLNUM_NA 0x0f /* N/A */
  1227. #define PERF_MEM_LVLNUM_SHIFT 33
  1228. /* snoop mode */
  1229. #define PERF_MEM_SNOOP_NA 0x01 /* not available */
  1230. #define PERF_MEM_SNOOP_NONE 0x02 /* no snoop */
  1231. #define PERF_MEM_SNOOP_HIT 0x04 /* snoop hit */
  1232. #define PERF_MEM_SNOOP_MISS 0x08 /* snoop miss */
  1233. #define PERF_MEM_SNOOP_HITM 0x10 /* snoop hit modified */
  1234. #define PERF_MEM_SNOOP_SHIFT 19
  1235. #define PERF_MEM_SNOOPX_FWD 0x01 /* forward */
  1236. #define PERF_MEM_SNOOPX_PEER 0x02 /* xfer from peer */
  1237. #define PERF_MEM_SNOOPX_SHIFT 38
  1238. /* locked instruction */
  1239. #define PERF_MEM_LOCK_NA 0x01 /* not available */
  1240. #define PERF_MEM_LOCK_LOCKED 0x02 /* locked transaction */
  1241. #define PERF_MEM_LOCK_SHIFT 24
  1242. /* TLB access */
  1243. #define PERF_MEM_TLB_NA 0x01 /* not available */
  1244. #define PERF_MEM_TLB_HIT 0x02 /* hit level */
  1245. #define PERF_MEM_TLB_MISS 0x04 /* miss level */
  1246. #define PERF_MEM_TLB_L1 0x08 /* L1 */
  1247. #define PERF_MEM_TLB_L2 0x10 /* L2 */
  1248. #define PERF_MEM_TLB_WK 0x20 /* Hardware Walker*/
  1249. #define PERF_MEM_TLB_OS 0x40 /* OS fault handler */
  1250. #define PERF_MEM_TLB_SHIFT 26
  1251. /* Access blocked */
  1252. #define PERF_MEM_BLK_NA 0x01 /* not available */
  1253. #define PERF_MEM_BLK_DATA 0x02 /* data could not be forwarded */
  1254. #define PERF_MEM_BLK_ADDR 0x04 /* address conflict */
  1255. #define PERF_MEM_BLK_SHIFT 40
  1256. /* hop level */
  1257. #define PERF_MEM_HOPS_0 0x01 /* remote core, same node */
  1258. #define PERF_MEM_HOPS_1 0x02 /* remote node, same socket */
  1259. #define PERF_MEM_HOPS_2 0x03 /* remote socket, same board */
  1260. #define PERF_MEM_HOPS_3 0x04 /* remote board */
  1261. /* 5-7 available */
  1262. #define PERF_MEM_HOPS_SHIFT 43
  1263. #define PERF_MEM_S(a, s) \
  1264. (((__u64)PERF_MEM_##a##_##s) << PERF_MEM_##a##_SHIFT)
  1265. /*
  1266. * single taken branch record layout:
  1267. *
  1268. * from: source instruction (may not always be a branch insn)
  1269. * to: branch target
  1270. * mispred: branch target was mispredicted
  1271. * predicted: branch target was predicted
  1272. *
  1273. * support for mispred, predicted is optional. In case it
  1274. * is not supported mispred = predicted = 0.
  1275. *
  1276. * in_tx: running in a hardware transaction
  1277. * abort: aborting a hardware transaction
  1278. * cycles: cycles from last branch (or 0 if not supported)
  1279. * type: branch type
  1280. * spec: branch speculation info (or 0 if not supported)
  1281. */
  1282. struct perf_branch_entry {
  1283. __u64 from;
  1284. __u64 to;
  1285. __u64 mispred:1, /* target mispredicted */
  1286. predicted:1,/* target predicted */
  1287. in_tx:1, /* in transaction */
  1288. abort:1, /* transaction abort */
  1289. cycles:16, /* cycle count to last branch */
  1290. type:4, /* branch type */
  1291. spec:2, /* branch speculation info */
  1292. new_type:4, /* additional branch type */
  1293. priv:3, /* privilege level */
  1294. reserved:31;
  1295. };
  1296. union perf_sample_weight {
  1297. __u64 full;
  1298. #if defined(__LITTLE_ENDIAN_BITFIELD)
  1299. struct {
  1300. __u32 var1_dw;
  1301. __u16 var2_w;
  1302. __u16 var3_w;
  1303. };
  1304. #elif defined(__BIG_ENDIAN_BITFIELD)
  1305. struct {
  1306. __u16 var3_w;
  1307. __u16 var2_w;
  1308. __u32 var1_dw;
  1309. };
  1310. #else
  1311. #error "Unknown endianness"
  1312. #endif
  1313. };
  1314. #endif /* _LINUX_PERF_EVENT_H */