perf_event.h 32 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216
  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 _LINUX_PERF_EVENT_H
  15. #define _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_MAX, /* non-ABI */
  100. };
  101. /*
  102. * Bits that can be set in attr.sample_type to request information
  103. * in the overflow packets.
  104. */
  105. enum perf_event_sample_format {
  106. PERF_SAMPLE_IP = 1U << 0,
  107. PERF_SAMPLE_TID = 1U << 1,
  108. PERF_SAMPLE_TIME = 1U << 2,
  109. PERF_SAMPLE_ADDR = 1U << 3,
  110. PERF_SAMPLE_READ = 1U << 4,
  111. PERF_SAMPLE_CALLCHAIN = 1U << 5,
  112. PERF_SAMPLE_ID = 1U << 6,
  113. PERF_SAMPLE_CPU = 1U << 7,
  114. PERF_SAMPLE_PERIOD = 1U << 8,
  115. PERF_SAMPLE_STREAM_ID = 1U << 9,
  116. PERF_SAMPLE_RAW = 1U << 10,
  117. PERF_SAMPLE_MAX = 1U << 11, /* non-ABI */
  118. };
  119. /*
  120. * The format of the data returned by read() on a perf event fd,
  121. * as specified by attr.read_format:
  122. *
  123. * struct read_format {
  124. * { u64 value;
  125. * { u64 time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
  126. * { u64 time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
  127. * { u64 id; } && PERF_FORMAT_ID
  128. * } && !PERF_FORMAT_GROUP
  129. *
  130. * { u64 nr;
  131. * { u64 time_enabled; } && PERF_FORMAT_TOTAL_TIME_ENABLED
  132. * { u64 time_running; } && PERF_FORMAT_TOTAL_TIME_RUNNING
  133. * { u64 value;
  134. * { u64 id; } && PERF_FORMAT_ID
  135. * } cntr[nr];
  136. * } && PERF_FORMAT_GROUP
  137. * };
  138. */
  139. enum perf_event_read_format {
  140. PERF_FORMAT_TOTAL_TIME_ENABLED = 1U << 0,
  141. PERF_FORMAT_TOTAL_TIME_RUNNING = 1U << 1,
  142. PERF_FORMAT_ID = 1U << 2,
  143. PERF_FORMAT_GROUP = 1U << 3,
  144. PERF_FORMAT_MAX = 1U << 4, /* non-ABI */
  145. };
  146. #define PERF_ATTR_SIZE_VER0 64 /* sizeof first published struct */
  147. /*
  148. * Hardware event_id to monitor via a performance monitoring event:
  149. */
  150. struct perf_event_attr {
  151. /*
  152. * Major type: hardware/software/tracepoint/etc.
  153. */
  154. __u32 type;
  155. /*
  156. * Size of the attr structure, for fwd/bwd compat.
  157. */
  158. __u32 size;
  159. /*
  160. * Type specific configuration information.
  161. */
  162. __u64 config;
  163. union {
  164. __u64 sample_period;
  165. __u64 sample_freq;
  166. };
  167. __u64 sample_type;
  168. __u64 read_format;
  169. __u64 disabled : 1, /* off by default */
  170. inherit : 1, /* children inherit it */
  171. pinned : 1, /* must always be on PMU */
  172. exclusive : 1, /* only group on PMU */
  173. exclude_user : 1, /* don't count user */
  174. exclude_kernel : 1, /* ditto kernel */
  175. exclude_hv : 1, /* ditto hypervisor */
  176. exclude_idle : 1, /* don't count when idle */
  177. mmap : 1, /* include mmap data */
  178. comm : 1, /* include comm data */
  179. freq : 1, /* use freq, not period */
  180. inherit_stat : 1, /* per task counts */
  181. enable_on_exec : 1, /* next exec enables */
  182. task : 1, /* trace fork/exit */
  183. watermark : 1, /* wakeup_watermark */
  184. /*
  185. * precise_ip:
  186. *
  187. * 0 - SAMPLE_IP can have arbitrary skid
  188. * 1 - SAMPLE_IP must have constant skid
  189. * 2 - SAMPLE_IP requested to have 0 skid
  190. * 3 - SAMPLE_IP must have 0 skid
  191. *
  192. * See also PERF_RECORD_MISC_EXACT_IP
  193. */
  194. precise_ip : 2, /* skid constraint */
  195. mmap_data : 1, /* non-exec mmap data */
  196. sample_id_all : 1, /* sample_type all events */
  197. exclude_host : 1, /* don't count in host */
  198. exclude_guest : 1, /* don't count in guest */
  199. __reserved_1 : 43;
  200. union {
  201. __u32 wakeup_events; /* wakeup every n events */
  202. __u32 wakeup_watermark; /* bytes before wakeup */
  203. };
  204. __u32 bp_type;
  205. union {
  206. __u64 bp_addr;
  207. __u64 config1; /* extension of config */
  208. };
  209. union {
  210. __u64 bp_len;
  211. __u64 config2; /* extension of config1 */
  212. };
  213. };
  214. /*
  215. * Ioctls that can be done on a perf event fd:
  216. */
  217. #define PERF_EVENT_IOC_ENABLE _IO ('$', 0)
  218. #define PERF_EVENT_IOC_DISABLE _IO ('$', 1)
  219. #define PERF_EVENT_IOC_REFRESH _IO ('$', 2)
  220. #define PERF_EVENT_IOC_RESET _IO ('$', 3)
  221. #define PERF_EVENT_IOC_PERIOD _IOW('$', 4, __u64)
  222. #define PERF_EVENT_IOC_SET_OUTPUT _IO ('$', 5)
  223. #define PERF_EVENT_IOC_SET_FILTER _IOW('$', 6, char *)
  224. enum perf_event_ioc_flags {
  225. PERF_IOC_FLAG_GROUP = 1U << 0,
  226. };
  227. /*
  228. * Structure of the page that can be mapped via mmap
  229. */
  230. struct perf_event_mmap_page {
  231. __u32 version; /* version number of this structure */
  232. __u32 compat_version; /* lowest version this is compat with */
  233. /*
  234. * Bits needed to read the hw events in user-space.
  235. *
  236. * u32 seq;
  237. * s64 count;
  238. *
  239. * do {
  240. * seq = pc->lock;
  241. *
  242. * barrier()
  243. * if (pc->index) {
  244. * count = pmc_read(pc->index - 1);
  245. * count += pc->offset;
  246. * } else
  247. * goto regular_read;
  248. *
  249. * barrier();
  250. * } while (pc->lock != seq);
  251. *
  252. * NOTE: for obvious reason this only works on self-monitoring
  253. * processes.
  254. */
  255. __u32 lock; /* seqlock for synchronization */
  256. __u32 index; /* hardware event identifier */
  257. __s64 offset; /* add to hardware event value */
  258. __u64 time_enabled; /* time event active */
  259. __u64 time_running; /* time event on cpu */
  260. /*
  261. * Hole for extension of the self monitor capabilities
  262. */
  263. __u64 __reserved[123]; /* align to 1k */
  264. /*
  265. * Control data for the mmap() data buffer.
  266. *
  267. * User-space reading the @data_head value should issue an rmb(), on
  268. * SMP capable platforms, after reading this value -- see
  269. * perf_event_wakeup().
  270. *
  271. * When the mapping is PROT_WRITE the @data_tail value should be
  272. * written by userspace to reflect the last read data. In this case
  273. * the kernel will not over-write unread data.
  274. */
  275. __u64 data_head; /* head in the data section */
  276. __u64 data_tail; /* user-space written tail */
  277. };
  278. #define PERF_RECORD_MISC_CPUMODE_MASK (7 << 0)
  279. #define PERF_RECORD_MISC_CPUMODE_UNKNOWN (0 << 0)
  280. #define PERF_RECORD_MISC_KERNEL (1 << 0)
  281. #define PERF_RECORD_MISC_USER (2 << 0)
  282. #define PERF_RECORD_MISC_HYPERVISOR (3 << 0)
  283. #define PERF_RECORD_MISC_GUEST_KERNEL (4 << 0)
  284. #define PERF_RECORD_MISC_GUEST_USER (5 << 0)
  285. /*
  286. * Indicates that the content of PERF_SAMPLE_IP points to
  287. * the actual instruction that triggered the event. See also
  288. * perf_event_attr::precise_ip.
  289. */
  290. #define PERF_RECORD_MISC_EXACT_IP (1 << 14)
  291. /*
  292. * Reserve the last bit to indicate some extended misc field
  293. */
  294. #define PERF_RECORD_MISC_EXT_RESERVED (1 << 15)
  295. struct perf_event_header {
  296. __u32 type;
  297. __u16 misc;
  298. __u16 size;
  299. };
  300. enum perf_event_type {
  301. /*
  302. * If perf_event_attr.sample_id_all is set then all event types will
  303. * have the sample_type selected fields related to where/when
  304. * (identity) an event took place (TID, TIME, ID, CPU, STREAM_ID)
  305. * described in PERF_RECORD_SAMPLE below, it will be stashed just after
  306. * the perf_event_header and the fields already present for the existing
  307. * fields, i.e. at the end of the payload. That way a newer perf.data
  308. * file will be supported by older perf tools, with these new optional
  309. * fields being ignored.
  310. *
  311. * The MMAP events record the PROT_EXEC mappings so that we can
  312. * correlate userspace IPs to code. They have the following structure:
  313. *
  314. * struct {
  315. * struct perf_event_header header;
  316. *
  317. * u32 pid, tid;
  318. * u64 addr;
  319. * u64 len;
  320. * u64 pgoff;
  321. * char filename[];
  322. * };
  323. */
  324. PERF_RECORD_MMAP = 1,
  325. /*
  326. * struct {
  327. * struct perf_event_header header;
  328. * u64 id;
  329. * u64 lost;
  330. * };
  331. */
  332. PERF_RECORD_LOST = 2,
  333. /*
  334. * struct {
  335. * struct perf_event_header header;
  336. *
  337. * u32 pid, tid;
  338. * char comm[];
  339. * };
  340. */
  341. PERF_RECORD_COMM = 3,
  342. /*
  343. * struct {
  344. * struct perf_event_header header;
  345. * u32 pid, ppid;
  346. * u32 tid, ptid;
  347. * u64 time;
  348. * };
  349. */
  350. PERF_RECORD_EXIT = 4,
  351. /*
  352. * struct {
  353. * struct perf_event_header header;
  354. * u64 time;
  355. * u64 id;
  356. * u64 stream_id;
  357. * };
  358. */
  359. PERF_RECORD_THROTTLE = 5,
  360. PERF_RECORD_UNTHROTTLE = 6,
  361. /*
  362. * struct {
  363. * struct perf_event_header header;
  364. * u32 pid, ppid;
  365. * u32 tid, ptid;
  366. * u64 time;
  367. * };
  368. */
  369. PERF_RECORD_FORK = 7,
  370. /*
  371. * struct {
  372. * struct perf_event_header header;
  373. * u32 pid, tid;
  374. *
  375. * struct read_format values;
  376. * };
  377. */
  378. PERF_RECORD_READ = 8,
  379. /*
  380. * struct {
  381. * struct perf_event_header header;
  382. *
  383. * { u64 ip; } && PERF_SAMPLE_IP
  384. * { u32 pid, tid; } && PERF_SAMPLE_TID
  385. * { u64 time; } && PERF_SAMPLE_TIME
  386. * { u64 addr; } && PERF_SAMPLE_ADDR
  387. * { u64 id; } && PERF_SAMPLE_ID
  388. * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
  389. * { u32 cpu, res; } && PERF_SAMPLE_CPU
  390. * { u64 period; } && PERF_SAMPLE_PERIOD
  391. *
  392. * { struct read_format values; } && PERF_SAMPLE_READ
  393. *
  394. * { u64 nr,
  395. * u64 ips[nr]; } && PERF_SAMPLE_CALLCHAIN
  396. *
  397. * #
  398. * # The RAW record below is opaque data wrt the ABI
  399. * #
  400. * # That is, the ABI doesn't make any promises wrt to
  401. * # the stability of its content, it may vary depending
  402. * # on event, hardware, kernel version and phase of
  403. * # the moon.
  404. * #
  405. * # In other words, PERF_SAMPLE_RAW contents are not an ABI.
  406. * #
  407. *
  408. * { u32 size;
  409. * char data[size];}&& PERF_SAMPLE_RAW
  410. * };
  411. */
  412. PERF_RECORD_SAMPLE = 9,
  413. PERF_RECORD_MAX, /* non-ABI */
  414. };
  415. enum perf_callchain_context {
  416. PERF_CONTEXT_HV = (__u64)-32,
  417. PERF_CONTEXT_KERNEL = (__u64)-128,
  418. PERF_CONTEXT_USER = (__u64)-512,
  419. PERF_CONTEXT_GUEST = (__u64)-2048,
  420. PERF_CONTEXT_GUEST_KERNEL = (__u64)-2176,
  421. PERF_CONTEXT_GUEST_USER = (__u64)-2560,
  422. PERF_CONTEXT_MAX = (__u64)-4095,
  423. };
  424. #define PERF_FLAG_FD_NO_GROUP (1U << 0)
  425. #define PERF_FLAG_FD_OUTPUT (1U << 1)
  426. #define PERF_FLAG_PID_CGROUP (1U << 2) /* pid=cgroup id, per-cpu mode only */
  427. #ifdef __KERNEL__
  428. /*
  429. * Kernel-internal data types and definitions:
  430. */
  431. #ifdef CONFIG_PERF_EVENTS
  432. # include <linux/cgroup.h>
  433. # include <asm/perf_event.h>
  434. # include <asm/local64.h>
  435. #endif
  436. struct perf_guest_info_callbacks {
  437. int (*is_in_guest)(void);
  438. int (*is_user_mode)(void);
  439. unsigned long (*get_guest_ip)(void);
  440. };
  441. #ifdef CONFIG_HAVE_HW_BREAKPOINT
  442. #include <asm/hw_breakpoint.h>
  443. #endif
  444. #include <linux/list.h>
  445. #include <linux/mutex.h>
  446. #include <linux/rculist.h>
  447. #include <linux/rcupdate.h>
  448. #include <linux/spinlock.h>
  449. #include <linux/hrtimer.h>
  450. #include <linux/fs.h>
  451. #include <linux/pid_namespace.h>
  452. #include <linux/workqueue.h>
  453. #include <linux/ftrace.h>
  454. #include <linux/cpu.h>
  455. #include <linux/irq_work.h>
  456. #include <linux/jump_label.h>
  457. #include <linux/atomic.h>
  458. #include <asm/local.h>
  459. #define PERF_MAX_STACK_DEPTH 255
  460. struct perf_callchain_entry {
  461. __u64 nr;
  462. __u64 ip[PERF_MAX_STACK_DEPTH];
  463. };
  464. struct perf_raw_record {
  465. u32 size;
  466. void *data;
  467. };
  468. struct perf_branch_entry {
  469. __u64 from;
  470. __u64 to;
  471. __u64 flags;
  472. };
  473. struct perf_branch_stack {
  474. __u64 nr;
  475. struct perf_branch_entry entries[0];
  476. };
  477. struct task_struct;
  478. /*
  479. * extra PMU register associated with an event
  480. */
  481. struct hw_perf_event_extra {
  482. u64 config; /* register value */
  483. unsigned int reg; /* register address or index */
  484. int alloc; /* extra register already allocated */
  485. int idx; /* index in shared_regs->regs[] */
  486. };
  487. /**
  488. * struct hw_perf_event - performance event hardware details:
  489. */
  490. struct hw_perf_event {
  491. #ifdef CONFIG_PERF_EVENTS
  492. union {
  493. struct { /* hardware */
  494. u64 config;
  495. u64 last_tag;
  496. unsigned long config_base;
  497. unsigned long event_base;
  498. int idx;
  499. int last_cpu;
  500. struct hw_perf_event_extra extra_reg;
  501. };
  502. struct { /* software */
  503. struct hrtimer hrtimer;
  504. };
  505. #ifdef CONFIG_HAVE_HW_BREAKPOINT
  506. struct { /* breakpoint */
  507. struct arch_hw_breakpoint info;
  508. struct list_head bp_list;
  509. /*
  510. * Crufty hack to avoid the chicken and egg
  511. * problem hw_breakpoint has with context
  512. * creation and event initalization.
  513. */
  514. struct task_struct *bp_target;
  515. };
  516. #endif
  517. };
  518. int state;
  519. local64_t prev_count;
  520. u64 sample_period;
  521. u64 last_period;
  522. local64_t period_left;
  523. u64 interrupts;
  524. u64 freq_time_stamp;
  525. u64 freq_count_stamp;
  526. #endif
  527. };
  528. /*
  529. * hw_perf_event::state flags
  530. */
  531. #define PERF_HES_STOPPED 0x01 /* the counter is stopped */
  532. #define PERF_HES_UPTODATE 0x02 /* event->count up-to-date */
  533. #define PERF_HES_ARCH 0x04
  534. struct perf_event;
  535. /*
  536. * Common implementation detail of pmu::{start,commit,cancel}_txn
  537. */
  538. #define PERF_EVENT_TXN 0x1
  539. /**
  540. * struct pmu - generic performance monitoring unit
  541. */
  542. struct pmu {
  543. struct list_head entry;
  544. struct device *dev;
  545. char *name;
  546. int type;
  547. int * __percpu pmu_disable_count;
  548. struct perf_cpu_context * __percpu pmu_cpu_context;
  549. int task_ctx_nr;
  550. /*
  551. * Fully disable/enable this PMU, can be used to protect from the PMI
  552. * as well as for lazy/batch writing of the MSRs.
  553. */
  554. void (*pmu_enable) (struct pmu *pmu); /* optional */
  555. void (*pmu_disable) (struct pmu *pmu); /* optional */
  556. /*
  557. * Try and initialize the event for this PMU.
  558. * Should return -ENOENT when the @event doesn't match this PMU.
  559. */
  560. int (*event_init) (struct perf_event *event);
  561. #define PERF_EF_START 0x01 /* start the counter when adding */
  562. #define PERF_EF_RELOAD 0x02 /* reload the counter when starting */
  563. #define PERF_EF_UPDATE 0x04 /* update the counter when stopping */
  564. /*
  565. * Adds/Removes a counter to/from the PMU, can be done inside
  566. * a transaction, see the ->*_txn() methods.
  567. */
  568. int (*add) (struct perf_event *event, int flags);
  569. void (*del) (struct perf_event *event, int flags);
  570. /*
  571. * Starts/Stops a counter present on the PMU. The PMI handler
  572. * should stop the counter when perf_event_overflow() returns
  573. * !0. ->start() will be used to continue.
  574. */
  575. void (*start) (struct perf_event *event, int flags);
  576. void (*stop) (struct perf_event *event, int flags);
  577. /*
  578. * Updates the counter value of the event.
  579. */
  580. void (*read) (struct perf_event *event);
  581. /*
  582. * Group events scheduling is treated as a transaction, add
  583. * group events as a whole and perform one schedulability test.
  584. * If the test fails, roll back the whole group
  585. *
  586. * Start the transaction, after this ->add() doesn't need to
  587. * do schedulability tests.
  588. */
  589. void (*start_txn) (struct pmu *pmu); /* optional */
  590. /*
  591. * If ->start_txn() disabled the ->add() schedulability test
  592. * then ->commit_txn() is required to perform one. On success
  593. * the transaction is closed. On error the transaction is kept
  594. * open until ->cancel_txn() is called.
  595. */
  596. int (*commit_txn) (struct pmu *pmu); /* optional */
  597. /*
  598. * Will cancel the transaction, assumes ->del() is called
  599. * for each successful ->add() during the transaction.
  600. */
  601. void (*cancel_txn) (struct pmu *pmu); /* optional */
  602. /*
  603. * Will return the value for perf_event_mmap_page::index for this event,
  604. * if no implementation is provided it will default to: event->hw.idx + 1.
  605. */
  606. int (*event_idx) (struct perf_event *event); /*optional */
  607. };
  608. /**
  609. * enum perf_event_active_state - the states of a event
  610. */
  611. enum perf_event_active_state {
  612. PERF_EVENT_STATE_ERROR = -2,
  613. PERF_EVENT_STATE_OFF = -1,
  614. PERF_EVENT_STATE_INACTIVE = 0,
  615. PERF_EVENT_STATE_ACTIVE = 1,
  616. };
  617. struct file;
  618. struct perf_sample_data;
  619. typedef void (*perf_overflow_handler_t)(struct perf_event *,
  620. struct perf_sample_data *,
  621. struct pt_regs *regs);
  622. enum perf_group_flag {
  623. PERF_GROUP_SOFTWARE = 0x1,
  624. };
  625. #define SWEVENT_HLIST_BITS 8
  626. #define SWEVENT_HLIST_SIZE (1 << SWEVENT_HLIST_BITS)
  627. struct swevent_hlist {
  628. struct hlist_head heads[SWEVENT_HLIST_SIZE];
  629. struct rcu_head rcu_head;
  630. };
  631. #define PERF_ATTACH_CONTEXT 0x01
  632. #define PERF_ATTACH_GROUP 0x02
  633. #define PERF_ATTACH_TASK 0x04
  634. #ifdef CONFIG_CGROUP_PERF
  635. /*
  636. * perf_cgroup_info keeps track of time_enabled for a cgroup.
  637. * This is a per-cpu dynamically allocated data structure.
  638. */
  639. struct perf_cgroup_info {
  640. u64 time;
  641. u64 timestamp;
  642. };
  643. struct perf_cgroup {
  644. struct cgroup_subsys_state css;
  645. struct perf_cgroup_info *info; /* timing info, one per cpu */
  646. };
  647. #endif
  648. struct ring_buffer;
  649. /**
  650. * struct perf_event - performance event kernel representation:
  651. */
  652. struct perf_event {
  653. #ifdef CONFIG_PERF_EVENTS
  654. struct list_head group_entry;
  655. struct list_head event_entry;
  656. struct list_head sibling_list;
  657. struct hlist_node hlist_entry;
  658. int nr_siblings;
  659. int group_flags;
  660. struct perf_event *group_leader;
  661. struct pmu *pmu;
  662. enum perf_event_active_state state;
  663. unsigned int attach_state;
  664. local64_t count;
  665. atomic64_t child_count;
  666. /*
  667. * These are the total time in nanoseconds that the event
  668. * has been enabled (i.e. eligible to run, and the task has
  669. * been scheduled in, if this is a per-task event)
  670. * and running (scheduled onto the CPU), respectively.
  671. *
  672. * They are computed from tstamp_enabled, tstamp_running and
  673. * tstamp_stopped when the event is in INACTIVE or ACTIVE state.
  674. */
  675. u64 total_time_enabled;
  676. u64 total_time_running;
  677. /*
  678. * These are timestamps used for computing total_time_enabled
  679. * and total_time_running when the event is in INACTIVE or
  680. * ACTIVE state, measured in nanoseconds from an arbitrary point
  681. * in time.
  682. * tstamp_enabled: the notional time when the event was enabled
  683. * tstamp_running: the notional time when the event was scheduled on
  684. * tstamp_stopped: in INACTIVE state, the notional time when the
  685. * event was scheduled off.
  686. */
  687. u64 tstamp_enabled;
  688. u64 tstamp_running;
  689. u64 tstamp_stopped;
  690. /*
  691. * timestamp shadows the actual context timing but it can
  692. * be safely used in NMI interrupt context. It reflects the
  693. * context time as it was when the event was last scheduled in.
  694. *
  695. * ctx_time already accounts for ctx->timestamp. Therefore to
  696. * compute ctx_time for a sample, simply add perf_clock().
  697. */
  698. u64 shadow_ctx_time;
  699. struct perf_event_attr attr;
  700. u16 header_size;
  701. u16 id_header_size;
  702. u16 read_size;
  703. struct hw_perf_event hw;
  704. struct perf_event_context *ctx;
  705. struct file *filp;
  706. /*
  707. * These accumulate total time (in nanoseconds) that children
  708. * events have been enabled and running, respectively.
  709. */
  710. atomic64_t child_total_time_enabled;
  711. atomic64_t child_total_time_running;
  712. /*
  713. * Protect attach/detach and child_list:
  714. */
  715. struct mutex child_mutex;
  716. struct list_head child_list;
  717. struct perf_event *parent;
  718. int oncpu;
  719. int cpu;
  720. struct list_head owner_entry;
  721. struct task_struct *owner;
  722. /* mmap bits */
  723. struct mutex mmap_mutex;
  724. atomic_t mmap_count;
  725. int mmap_locked;
  726. struct user_struct *mmap_user;
  727. struct ring_buffer *rb;
  728. struct list_head rb_entry;
  729. /* poll related */
  730. wait_queue_head_t waitq;
  731. struct fasync_struct *fasync;
  732. /* delayed work for NMIs and such */
  733. int pending_wakeup;
  734. int pending_kill;
  735. int pending_disable;
  736. struct irq_work pending;
  737. atomic_t event_limit;
  738. void (*destroy)(struct perf_event *);
  739. struct rcu_head rcu_head;
  740. struct pid_namespace *ns;
  741. u64 id;
  742. perf_overflow_handler_t overflow_handler;
  743. void *overflow_handler_context;
  744. #ifdef CONFIG_EVENT_TRACING
  745. struct ftrace_event_call *tp_event;
  746. struct event_filter *filter;
  747. #endif
  748. #ifdef CONFIG_CGROUP_PERF
  749. struct perf_cgroup *cgrp; /* cgroup event is attach to */
  750. int cgrp_defer_enabled;
  751. #endif
  752. #endif /* CONFIG_PERF_EVENTS */
  753. };
  754. enum perf_event_context_type {
  755. task_context,
  756. cpu_context,
  757. };
  758. /**
  759. * struct perf_event_context - event context structure
  760. *
  761. * Used as a container for task events and CPU events as well:
  762. */
  763. struct perf_event_context {
  764. struct pmu *pmu;
  765. enum perf_event_context_type type;
  766. /*
  767. * Protect the states of the events in the list,
  768. * nr_active, and the list:
  769. */
  770. raw_spinlock_t lock;
  771. /*
  772. * Protect the list of events. Locking either mutex or lock
  773. * is sufficient to ensure the list doesn't change; to change
  774. * the list you need to lock both the mutex and the spinlock.
  775. */
  776. struct mutex mutex;
  777. struct list_head pinned_groups;
  778. struct list_head flexible_groups;
  779. struct list_head event_list;
  780. int nr_events;
  781. int nr_active;
  782. int is_active;
  783. int nr_stat;
  784. int nr_freq;
  785. int rotate_disable;
  786. atomic_t refcount;
  787. struct task_struct *task;
  788. /*
  789. * Context clock, runs when context enabled.
  790. */
  791. u64 time;
  792. u64 timestamp;
  793. /*
  794. * These fields let us detect when two contexts have both
  795. * been cloned (inherited) from a common ancestor.
  796. */
  797. struct perf_event_context *parent_ctx;
  798. u64 parent_gen;
  799. u64 generation;
  800. int pin_count;
  801. int nr_cgroups; /* cgroup events present */
  802. struct rcu_head rcu_head;
  803. };
  804. /*
  805. * Number of contexts where an event can trigger:
  806. * task, softirq, hardirq, nmi.
  807. */
  808. #define PERF_NR_CONTEXTS 4
  809. /**
  810. * struct perf_event_cpu_context - per cpu event context structure
  811. */
  812. struct perf_cpu_context {
  813. struct perf_event_context ctx;
  814. struct perf_event_context *task_ctx;
  815. int active_oncpu;
  816. int exclusive;
  817. struct list_head rotation_list;
  818. int jiffies_interval;
  819. struct pmu *active_pmu;
  820. struct perf_cgroup *cgrp;
  821. };
  822. struct perf_output_handle {
  823. struct perf_event *event;
  824. struct ring_buffer *rb;
  825. unsigned long wakeup;
  826. unsigned long size;
  827. void *addr;
  828. int page;
  829. };
  830. #ifdef CONFIG_PERF_EVENTS
  831. extern int perf_pmu_register(struct pmu *pmu, char *name, int type);
  832. extern void perf_pmu_unregister(struct pmu *pmu);
  833. extern int perf_num_counters(void);
  834. extern const char *perf_pmu_name(void);
  835. extern void __perf_event_task_sched_in(struct task_struct *prev,
  836. struct task_struct *task);
  837. extern void __perf_event_task_sched_out(struct task_struct *prev,
  838. struct task_struct *next);
  839. extern int perf_event_init_task(struct task_struct *child);
  840. extern void perf_event_exit_task(struct task_struct *child);
  841. extern void perf_event_free_task(struct task_struct *task);
  842. extern void perf_event_delayed_put(struct task_struct *task);
  843. extern void perf_event_print_debug(void);
  844. extern void perf_pmu_disable(struct pmu *pmu);
  845. extern void perf_pmu_enable(struct pmu *pmu);
  846. extern int perf_event_task_disable(void);
  847. extern int perf_event_task_enable(void);
  848. extern int perf_event_refresh(struct perf_event *event, int refresh);
  849. extern void perf_event_update_userpage(struct perf_event *event);
  850. extern int perf_event_release_kernel(struct perf_event *event);
  851. extern struct perf_event *
  852. perf_event_create_kernel_counter(struct perf_event_attr *attr,
  853. int cpu,
  854. struct task_struct *task,
  855. perf_overflow_handler_t callback,
  856. void *context);
  857. extern u64 perf_event_read_value(struct perf_event *event,
  858. u64 *enabled, u64 *running);
  859. struct perf_sample_data {
  860. u64 type;
  861. u64 ip;
  862. struct {
  863. u32 pid;
  864. u32 tid;
  865. } tid_entry;
  866. u64 time;
  867. u64 addr;
  868. u64 id;
  869. u64 stream_id;
  870. struct {
  871. u32 cpu;
  872. u32 reserved;
  873. } cpu_entry;
  874. u64 period;
  875. struct perf_callchain_entry *callchain;
  876. struct perf_raw_record *raw;
  877. };
  878. static inline void perf_sample_data_init(struct perf_sample_data *data, u64 addr)
  879. {
  880. data->addr = addr;
  881. data->raw = NULL;
  882. }
  883. extern void perf_output_sample(struct perf_output_handle *handle,
  884. struct perf_event_header *header,
  885. struct perf_sample_data *data,
  886. struct perf_event *event);
  887. extern void perf_prepare_sample(struct perf_event_header *header,
  888. struct perf_sample_data *data,
  889. struct perf_event *event,
  890. struct pt_regs *regs);
  891. extern int perf_event_overflow(struct perf_event *event,
  892. struct perf_sample_data *data,
  893. struct pt_regs *regs);
  894. static inline bool is_sampling_event(struct perf_event *event)
  895. {
  896. return event->attr.sample_period != 0;
  897. }
  898. /*
  899. * Return 1 for a software event, 0 for a hardware event
  900. */
  901. static inline int is_software_event(struct perf_event *event)
  902. {
  903. return event->pmu->task_ctx_nr == perf_sw_context;
  904. }
  905. extern struct jump_label_key perf_swevent_enabled[PERF_COUNT_SW_MAX];
  906. extern void __perf_sw_event(u32, u64, struct pt_regs *, u64);
  907. #ifndef perf_arch_fetch_caller_regs
  908. static inline void perf_arch_fetch_caller_regs(struct pt_regs *regs, unsigned long ip) { }
  909. #endif
  910. /*
  911. * Take a snapshot of the regs. Skip ip and frame pointer to
  912. * the nth caller. We only need a few of the regs:
  913. * - ip for PERF_SAMPLE_IP
  914. * - cs for user_mode() tests
  915. * - bp for callchains
  916. * - eflags, for future purposes, just in case
  917. */
  918. static inline void perf_fetch_caller_regs(struct pt_regs *regs)
  919. {
  920. memset(regs, 0, sizeof(*regs));
  921. perf_arch_fetch_caller_regs(regs, CALLER_ADDR0);
  922. }
  923. static __always_inline void
  924. perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr)
  925. {
  926. struct pt_regs hot_regs;
  927. if (static_branch(&perf_swevent_enabled[event_id])) {
  928. if (!regs) {
  929. perf_fetch_caller_regs(&hot_regs);
  930. regs = &hot_regs;
  931. }
  932. __perf_sw_event(event_id, nr, regs, addr);
  933. }
  934. }
  935. extern struct jump_label_key_deferred perf_sched_events;
  936. static inline void perf_event_task_sched_in(struct task_struct *prev,
  937. struct task_struct *task)
  938. {
  939. if (static_branch(&perf_sched_events.key))
  940. __perf_event_task_sched_in(prev, task);
  941. }
  942. static inline void perf_event_task_sched_out(struct task_struct *prev,
  943. struct task_struct *next)
  944. {
  945. perf_sw_event(PERF_COUNT_SW_CONTEXT_SWITCHES, 1, NULL, 0);
  946. if (static_branch(&perf_sched_events.key))
  947. __perf_event_task_sched_out(prev, next);
  948. }
  949. extern void perf_event_mmap(struct vm_area_struct *vma);
  950. extern struct perf_guest_info_callbacks *perf_guest_cbs;
  951. extern int perf_register_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
  952. extern int perf_unregister_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
  953. extern void perf_event_comm(struct task_struct *tsk);
  954. extern void perf_event_fork(struct task_struct *tsk);
  955. /* Callchains */
  956. DECLARE_PER_CPU(struct perf_callchain_entry, perf_callchain_entry);
  957. extern void perf_callchain_user(struct perf_callchain_entry *entry, struct pt_regs *regs);
  958. extern void perf_callchain_kernel(struct perf_callchain_entry *entry, struct pt_regs *regs);
  959. static inline void perf_callchain_store(struct perf_callchain_entry *entry, u64 ip)
  960. {
  961. if (entry->nr < PERF_MAX_STACK_DEPTH)
  962. entry->ip[entry->nr++] = ip;
  963. }
  964. extern int sysctl_perf_event_paranoid;
  965. extern int sysctl_perf_event_mlock;
  966. extern int sysctl_perf_event_sample_rate;
  967. extern int perf_proc_update_handler(struct ctl_table *table, int write,
  968. void __user *buffer, size_t *lenp,
  969. loff_t *ppos);
  970. static inline bool perf_paranoid_tracepoint_raw(void)
  971. {
  972. return sysctl_perf_event_paranoid > -1;
  973. }
  974. static inline bool perf_paranoid_cpu(void)
  975. {
  976. return sysctl_perf_event_paranoid > 0;
  977. }
  978. static inline bool perf_paranoid_kernel(void)
  979. {
  980. return sysctl_perf_event_paranoid > 1;
  981. }
  982. extern void perf_event_init(void);
  983. extern void perf_tp_event(u64 addr, u64 count, void *record,
  984. int entry_size, struct pt_regs *regs,
  985. struct hlist_head *head, int rctx);
  986. extern void perf_bp_event(struct perf_event *event, void *data);
  987. #ifndef perf_misc_flags
  988. # define perf_misc_flags(regs) \
  989. (user_mode(regs) ? PERF_RECORD_MISC_USER : PERF_RECORD_MISC_KERNEL)
  990. # define perf_instruction_pointer(regs) instruction_pointer(regs)
  991. #endif
  992. extern int perf_output_begin(struct perf_output_handle *handle,
  993. struct perf_event *event, unsigned int size);
  994. extern void perf_output_end(struct perf_output_handle *handle);
  995. extern void perf_output_copy(struct perf_output_handle *handle,
  996. const void *buf, unsigned int len);
  997. extern int perf_swevent_get_recursion_context(void);
  998. extern void perf_swevent_put_recursion_context(int rctx);
  999. extern void perf_event_enable(struct perf_event *event);
  1000. extern void perf_event_disable(struct perf_event *event);
  1001. extern void perf_event_task_tick(void);
  1002. #else
  1003. static inline void
  1004. perf_event_task_sched_in(struct task_struct *prev,
  1005. struct task_struct *task) { }
  1006. static inline void
  1007. perf_event_task_sched_out(struct task_struct *prev,
  1008. struct task_struct *next) { }
  1009. static inline int perf_event_init_task(struct task_struct *child) { return 0; }
  1010. static inline void perf_event_exit_task(struct task_struct *child) { }
  1011. static inline void perf_event_free_task(struct task_struct *task) { }
  1012. static inline void perf_event_delayed_put(struct task_struct *task) { }
  1013. static inline void perf_event_print_debug(void) { }
  1014. static inline int perf_event_task_disable(void) { return -EINVAL; }
  1015. static inline int perf_event_task_enable(void) { return -EINVAL; }
  1016. static inline int perf_event_refresh(struct perf_event *event, int refresh)
  1017. {
  1018. return -EINVAL;
  1019. }
  1020. static inline void
  1021. perf_sw_event(u32 event_id, u64 nr, struct pt_regs *regs, u64 addr) { }
  1022. static inline void
  1023. perf_bp_event(struct perf_event *event, void *data) { }
  1024. static inline int perf_register_guest_info_callbacks
  1025. (struct perf_guest_info_callbacks *callbacks) { return 0; }
  1026. static inline int perf_unregister_guest_info_callbacks
  1027. (struct perf_guest_info_callbacks *callbacks) { return 0; }
  1028. static inline void perf_event_mmap(struct vm_area_struct *vma) { }
  1029. static inline void perf_event_comm(struct task_struct *tsk) { }
  1030. static inline void perf_event_fork(struct task_struct *tsk) { }
  1031. static inline void perf_event_init(void) { }
  1032. static inline int perf_swevent_get_recursion_context(void) { return -1; }
  1033. static inline void perf_swevent_put_recursion_context(int rctx) { }
  1034. static inline void perf_event_enable(struct perf_event *event) { }
  1035. static inline void perf_event_disable(struct perf_event *event) { }
  1036. static inline void perf_event_task_tick(void) { }
  1037. #endif
  1038. #define perf_output_put(handle, x) perf_output_copy((handle), &(x), sizeof(x))
  1039. /*
  1040. * This has to have a higher priority than migration_notifier in sched.c.
  1041. */
  1042. #define perf_cpu_notifier(fn) \
  1043. do { \
  1044. static struct notifier_block fn##_nb __cpuinitdata = \
  1045. { .notifier_call = fn, .priority = CPU_PRI_PERF }; \
  1046. fn(&fn##_nb, (unsigned long)CPU_UP_PREPARE, \
  1047. (void *)(unsigned long)smp_processor_id()); \
  1048. fn(&fn##_nb, (unsigned long)CPU_STARTING, \
  1049. (void *)(unsigned long)smp_processor_id()); \
  1050. fn(&fn##_nb, (unsigned long)CPU_ONLINE, \
  1051. (void *)(unsigned long)smp_processor_id()); \
  1052. register_cpu_notifier(&fn##_nb); \
  1053. } while (0)
  1054. #endif /* __KERNEL__ */
  1055. #endif /* _LINUX_PERF_EVENT_H */