perf_event.h 32 KB

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