perf_event.h 30 KB

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