perf_event.h 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077
  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. __reserved_1 : 47;
  192. union {
  193. __u32 wakeup_events; /* wakeup every n events */
  194. __u32 wakeup_watermark; /* bytes before wakeup */
  195. };
  196. __u32 bp_type;
  197. __u64 bp_addr;
  198. __u64 bp_len;
  199. };
  200. /*
  201. * Ioctls that can be done on a perf event fd:
  202. */
  203. #define PERF_EVENT_IOC_ENABLE _IO ('$', 0)
  204. #define PERF_EVENT_IOC_DISABLE _IO ('$', 1)
  205. #define PERF_EVENT_IOC_REFRESH _IO ('$', 2)
  206. #define PERF_EVENT_IOC_RESET _IO ('$', 3)
  207. #define PERF_EVENT_IOC_PERIOD _IOW('$', 4, __u64)
  208. #define PERF_EVENT_IOC_SET_OUTPUT _IO ('$', 5)
  209. #define PERF_EVENT_IOC_SET_FILTER _IOW('$', 6, char *)
  210. enum perf_event_ioc_flags {
  211. PERF_IOC_FLAG_GROUP = 1U << 0,
  212. };
  213. /*
  214. * Structure of the page that can be mapped via mmap
  215. */
  216. struct perf_event_mmap_page {
  217. __u32 version; /* version number of this structure */
  218. __u32 compat_version; /* lowest version this is compat with */
  219. /*
  220. * Bits needed to read the hw events in user-space.
  221. *
  222. * u32 seq;
  223. * s64 count;
  224. *
  225. * do {
  226. * seq = pc->lock;
  227. *
  228. * barrier()
  229. * if (pc->index) {
  230. * count = pmc_read(pc->index - 1);
  231. * count += pc->offset;
  232. * } else
  233. * goto regular_read;
  234. *
  235. * barrier();
  236. * } while (pc->lock != seq);
  237. *
  238. * NOTE: for obvious reason this only works on self-monitoring
  239. * processes.
  240. */
  241. __u32 lock; /* seqlock for synchronization */
  242. __u32 index; /* hardware event identifier */
  243. __s64 offset; /* add to hardware event value */
  244. __u64 time_enabled; /* time event active */
  245. __u64 time_running; /* time event on cpu */
  246. /*
  247. * Hole for extension of the self monitor capabilities
  248. */
  249. __u64 __reserved[123]; /* align to 1k */
  250. /*
  251. * Control data for the mmap() data buffer.
  252. *
  253. * User-space reading the @data_head value should issue an rmb(), on
  254. * SMP capable platforms, after reading this value -- see
  255. * perf_event_wakeup().
  256. *
  257. * When the mapping is PROT_WRITE the @data_tail value should be
  258. * written by userspace to reflect the last read data. In this case
  259. * the kernel will not over-write unread data.
  260. */
  261. __u64 data_head; /* head in the data section */
  262. __u64 data_tail; /* user-space written tail */
  263. };
  264. #define PERF_RECORD_MISC_CPUMODE_MASK (7 << 0)
  265. #define PERF_RECORD_MISC_CPUMODE_UNKNOWN (0 << 0)
  266. #define PERF_RECORD_MISC_KERNEL (1 << 0)
  267. #define PERF_RECORD_MISC_USER (2 << 0)
  268. #define PERF_RECORD_MISC_HYPERVISOR (3 << 0)
  269. #define PERF_RECORD_MISC_GUEST_KERNEL (4 << 0)
  270. #define PERF_RECORD_MISC_GUEST_USER (5 << 0)
  271. /*
  272. * Indicates that the content of PERF_SAMPLE_IP points to
  273. * the actual instruction that triggered the event. See also
  274. * perf_event_attr::precise_ip.
  275. */
  276. #define PERF_RECORD_MISC_EXACT_IP (1 << 14)
  277. /*
  278. * Reserve the last bit to indicate some extended misc field
  279. */
  280. #define PERF_RECORD_MISC_EXT_RESERVED (1 << 15)
  281. struct perf_event_header {
  282. __u32 type;
  283. __u16 misc;
  284. __u16 size;
  285. };
  286. enum perf_event_type {
  287. /*
  288. * The MMAP events record the PROT_EXEC mappings so that we can
  289. * correlate userspace IPs to code. They have the following structure:
  290. *
  291. * struct {
  292. * struct perf_event_header header;
  293. *
  294. * u32 pid, tid;
  295. * u64 addr;
  296. * u64 len;
  297. * u64 pgoff;
  298. * char filename[];
  299. * };
  300. */
  301. PERF_RECORD_MMAP = 1,
  302. /*
  303. * struct {
  304. * struct perf_event_header header;
  305. * u64 id;
  306. * u64 lost;
  307. * };
  308. */
  309. PERF_RECORD_LOST = 2,
  310. /*
  311. * struct {
  312. * struct perf_event_header header;
  313. *
  314. * u32 pid, tid;
  315. * char comm[];
  316. * };
  317. */
  318. PERF_RECORD_COMM = 3,
  319. /*
  320. * struct {
  321. * struct perf_event_header header;
  322. * u32 pid, ppid;
  323. * u32 tid, ptid;
  324. * u64 time;
  325. * };
  326. */
  327. PERF_RECORD_EXIT = 4,
  328. /*
  329. * struct {
  330. * struct perf_event_header header;
  331. * u64 time;
  332. * u64 id;
  333. * u64 stream_id;
  334. * };
  335. */
  336. PERF_RECORD_THROTTLE = 5,
  337. PERF_RECORD_UNTHROTTLE = 6,
  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_FORK = 7,
  347. /*
  348. * struct {
  349. * struct perf_event_header header;
  350. * u32 pid, tid;
  351. *
  352. * struct read_format values;
  353. * };
  354. */
  355. PERF_RECORD_READ = 8,
  356. /*
  357. * struct {
  358. * struct perf_event_header header;
  359. *
  360. * { u64 ip; } && PERF_SAMPLE_IP
  361. * { u32 pid, tid; } && PERF_SAMPLE_TID
  362. * { u64 time; } && PERF_SAMPLE_TIME
  363. * { u64 addr; } && PERF_SAMPLE_ADDR
  364. * { u64 id; } && PERF_SAMPLE_ID
  365. * { u64 stream_id;} && PERF_SAMPLE_STREAM_ID
  366. * { u32 cpu, res; } && PERF_SAMPLE_CPU
  367. * { u64 period; } && PERF_SAMPLE_PERIOD
  368. *
  369. * { struct read_format values; } && PERF_SAMPLE_READ
  370. *
  371. * { u64 nr,
  372. * u64 ips[nr]; } && PERF_SAMPLE_CALLCHAIN
  373. *
  374. * #
  375. * # The RAW record below is opaque data wrt the ABI
  376. * #
  377. * # That is, the ABI doesn't make any promises wrt to
  378. * # the stability of its content, it may vary depending
  379. * # on event, hardware, kernel version and phase of
  380. * # the moon.
  381. * #
  382. * # In other words, PERF_SAMPLE_RAW contents are not an ABI.
  383. * #
  384. *
  385. * { u32 size;
  386. * char data[size];}&& PERF_SAMPLE_RAW
  387. * };
  388. */
  389. PERF_RECORD_SAMPLE = 9,
  390. PERF_RECORD_MAX, /* non-ABI */
  391. };
  392. enum perf_callchain_context {
  393. PERF_CONTEXT_HV = (__u64)-32,
  394. PERF_CONTEXT_KERNEL = (__u64)-128,
  395. PERF_CONTEXT_USER = (__u64)-512,
  396. PERF_CONTEXT_GUEST = (__u64)-2048,
  397. PERF_CONTEXT_GUEST_KERNEL = (__u64)-2176,
  398. PERF_CONTEXT_GUEST_USER = (__u64)-2560,
  399. PERF_CONTEXT_MAX = (__u64)-4095,
  400. };
  401. #define PERF_FLAG_FD_NO_GROUP (1U << 0)
  402. #define PERF_FLAG_FD_OUTPUT (1U << 1)
  403. #ifdef __KERNEL__
  404. /*
  405. * Kernel-internal data types and definitions:
  406. */
  407. #ifdef CONFIG_PERF_EVENTS
  408. # include <asm/perf_event.h>
  409. #endif
  410. struct perf_guest_info_callbacks {
  411. int (*is_in_guest) (void);
  412. int (*is_user_mode) (void);
  413. unsigned long (*get_guest_ip) (void);
  414. };
  415. #ifdef CONFIG_HAVE_HW_BREAKPOINT
  416. #include <asm/hw_breakpoint.h>
  417. #endif
  418. #include <linux/list.h>
  419. #include <linux/mutex.h>
  420. #include <linux/rculist.h>
  421. #include <linux/rcupdate.h>
  422. #include <linux/spinlock.h>
  423. #include <linux/hrtimer.h>
  424. #include <linux/fs.h>
  425. #include <linux/pid_namespace.h>
  426. #include <linux/workqueue.h>
  427. #include <linux/ftrace.h>
  428. #include <linux/cpu.h>
  429. #include <asm/atomic.h>
  430. #include <asm/local.h>
  431. #define PERF_MAX_STACK_DEPTH 255
  432. struct perf_callchain_entry {
  433. __u64 nr;
  434. __u64 ip[PERF_MAX_STACK_DEPTH];
  435. };
  436. struct perf_raw_record {
  437. u32 size;
  438. void *data;
  439. };
  440. struct perf_branch_entry {
  441. __u64 from;
  442. __u64 to;
  443. __u64 flags;
  444. };
  445. struct perf_branch_stack {
  446. __u64 nr;
  447. struct perf_branch_entry entries[0];
  448. };
  449. struct task_struct;
  450. /**
  451. * struct hw_perf_event - performance event hardware details:
  452. */
  453. struct hw_perf_event {
  454. #ifdef CONFIG_PERF_EVENTS
  455. union {
  456. struct { /* hardware */
  457. u64 config;
  458. u64 last_tag;
  459. unsigned long config_base;
  460. unsigned long event_base;
  461. int idx;
  462. int last_cpu;
  463. };
  464. struct { /* software */
  465. s64 remaining;
  466. struct hrtimer hrtimer;
  467. };
  468. #ifdef CONFIG_HAVE_HW_BREAKPOINT
  469. /* breakpoint */
  470. struct arch_hw_breakpoint info;
  471. #endif
  472. };
  473. atomic64_t prev_count;
  474. u64 sample_period;
  475. u64 last_period;
  476. atomic64_t period_left;
  477. u64 interrupts;
  478. u64 freq_time_stamp;
  479. u64 freq_count_stamp;
  480. #endif
  481. };
  482. struct perf_event;
  483. #define PERF_EVENT_TXN_STARTED 1
  484. /**
  485. * struct pmu - generic performance monitoring unit
  486. */
  487. struct pmu {
  488. int (*enable) (struct perf_event *event);
  489. void (*disable) (struct perf_event *event);
  490. int (*start) (struct perf_event *event);
  491. void (*stop) (struct perf_event *event);
  492. void (*read) (struct perf_event *event);
  493. void (*unthrottle) (struct perf_event *event);
  494. /*
  495. * group events scheduling is treated as a transaction,
  496. * add group events as a whole and perform one schedulability test.
  497. * If test fails, roll back the whole group
  498. */
  499. void (*start_txn) (const struct pmu *pmu);
  500. void (*cancel_txn) (const struct pmu *pmu);
  501. int (*commit_txn) (const struct pmu *pmu);
  502. };
  503. /**
  504. * enum perf_event_active_state - the states of a event
  505. */
  506. enum perf_event_active_state {
  507. PERF_EVENT_STATE_ERROR = -2,
  508. PERF_EVENT_STATE_OFF = -1,
  509. PERF_EVENT_STATE_INACTIVE = 0,
  510. PERF_EVENT_STATE_ACTIVE = 1,
  511. };
  512. struct file;
  513. struct perf_mmap_data {
  514. struct rcu_head rcu_head;
  515. #ifdef CONFIG_PERF_USE_VMALLOC
  516. struct work_struct work;
  517. int page_order; /* allocation order */
  518. #endif
  519. int nr_pages; /* nr of data pages */
  520. int writable; /* are we writable */
  521. int nr_locked; /* nr pages mlocked */
  522. atomic_t poll; /* POLL_ for wakeups */
  523. local_t head; /* write position */
  524. local_t nest; /* nested writers */
  525. local_t events; /* event limit */
  526. local_t wakeup; /* wakeup stamp */
  527. local_t lost; /* nr records lost */
  528. long watermark; /* wakeup watermark */
  529. struct perf_event_mmap_page *user_page;
  530. void *data_pages[0];
  531. };
  532. struct perf_pending_entry {
  533. struct perf_pending_entry *next;
  534. void (*func)(struct perf_pending_entry *);
  535. };
  536. struct perf_sample_data;
  537. typedef void (*perf_overflow_handler_t)(struct perf_event *, int,
  538. struct perf_sample_data *,
  539. struct pt_regs *regs);
  540. enum perf_group_flag {
  541. PERF_GROUP_SOFTWARE = 0x1,
  542. };
  543. #define SWEVENT_HLIST_BITS 8
  544. #define SWEVENT_HLIST_SIZE (1 << SWEVENT_HLIST_BITS)
  545. struct swevent_hlist {
  546. struct hlist_head heads[SWEVENT_HLIST_SIZE];
  547. struct rcu_head rcu_head;
  548. };
  549. /**
  550. * struct perf_event - performance event kernel representation:
  551. */
  552. struct perf_event {
  553. #ifdef CONFIG_PERF_EVENTS
  554. struct list_head group_entry;
  555. struct list_head event_entry;
  556. struct list_head sibling_list;
  557. struct hlist_node hlist_entry;
  558. int nr_siblings;
  559. int group_flags;
  560. struct perf_event *group_leader;
  561. struct perf_event *output;
  562. const struct pmu *pmu;
  563. enum perf_event_active_state state;
  564. atomic64_t count;
  565. /*
  566. * These are the total time in nanoseconds that the event
  567. * has been enabled (i.e. eligible to run, and the task has
  568. * been scheduled in, if this is a per-task event)
  569. * and running (scheduled onto the CPU), respectively.
  570. *
  571. * They are computed from tstamp_enabled, tstamp_running and
  572. * tstamp_stopped when the event is in INACTIVE or ACTIVE state.
  573. */
  574. u64 total_time_enabled;
  575. u64 total_time_running;
  576. /*
  577. * These are timestamps used for computing total_time_enabled
  578. * and total_time_running when the event is in INACTIVE or
  579. * ACTIVE state, measured in nanoseconds from an arbitrary point
  580. * in time.
  581. * tstamp_enabled: the notional time when the event was enabled
  582. * tstamp_running: the notional time when the event was scheduled on
  583. * tstamp_stopped: in INACTIVE state, the notional time when the
  584. * event was scheduled off.
  585. */
  586. u64 tstamp_enabled;
  587. u64 tstamp_running;
  588. u64 tstamp_stopped;
  589. struct perf_event_attr attr;
  590. struct hw_perf_event hw;
  591. struct perf_event_context *ctx;
  592. struct file *filp;
  593. /*
  594. * These accumulate total time (in nanoseconds) that children
  595. * events have been enabled and running, respectively.
  596. */
  597. atomic64_t child_total_time_enabled;
  598. atomic64_t child_total_time_running;
  599. /*
  600. * Protect attach/detach and child_list:
  601. */
  602. struct mutex child_mutex;
  603. struct list_head child_list;
  604. struct perf_event *parent;
  605. int oncpu;
  606. int cpu;
  607. struct list_head owner_entry;
  608. struct task_struct *owner;
  609. /* mmap bits */
  610. struct mutex mmap_mutex;
  611. atomic_t mmap_count;
  612. struct perf_mmap_data *data;
  613. /* poll related */
  614. wait_queue_head_t waitq;
  615. struct fasync_struct *fasync;
  616. /* delayed work for NMIs and such */
  617. int pending_wakeup;
  618. int pending_kill;
  619. int pending_disable;
  620. struct perf_pending_entry pending;
  621. atomic_t event_limit;
  622. void (*destroy)(struct perf_event *);
  623. struct rcu_head rcu_head;
  624. struct pid_namespace *ns;
  625. u64 id;
  626. perf_overflow_handler_t overflow_handler;
  627. #ifdef CONFIG_EVENT_TRACING
  628. struct ftrace_event_call *tp_event;
  629. struct event_filter *filter;
  630. #endif
  631. #endif /* CONFIG_PERF_EVENTS */
  632. };
  633. /**
  634. * struct perf_event_context - event context structure
  635. *
  636. * Used as a container for task events and CPU events as well:
  637. */
  638. struct perf_event_context {
  639. /*
  640. * Protect the states of the events in the list,
  641. * nr_active, and the list:
  642. */
  643. raw_spinlock_t lock;
  644. /*
  645. * Protect the list of events. Locking either mutex or lock
  646. * is sufficient to ensure the list doesn't change; to change
  647. * the list you need to lock both the mutex and the spinlock.
  648. */
  649. struct mutex mutex;
  650. struct list_head pinned_groups;
  651. struct list_head flexible_groups;
  652. struct list_head event_list;
  653. int nr_events;
  654. int nr_active;
  655. int is_active;
  656. int nr_stat;
  657. atomic_t refcount;
  658. struct task_struct *task;
  659. /*
  660. * Context clock, runs when context enabled.
  661. */
  662. u64 time;
  663. u64 timestamp;
  664. /*
  665. * These fields let us detect when two contexts have both
  666. * been cloned (inherited) from a common ancestor.
  667. */
  668. struct perf_event_context *parent_ctx;
  669. u64 parent_gen;
  670. u64 generation;
  671. int pin_count;
  672. struct rcu_head rcu_head;
  673. };
  674. /**
  675. * struct perf_event_cpu_context - per cpu event context structure
  676. */
  677. struct perf_cpu_context {
  678. struct perf_event_context ctx;
  679. struct perf_event_context *task_ctx;
  680. int active_oncpu;
  681. int max_pertask;
  682. int exclusive;
  683. struct swevent_hlist *swevent_hlist;
  684. struct mutex hlist_mutex;
  685. int hlist_refcount;
  686. /*
  687. * Recursion avoidance:
  688. *
  689. * task, softirq, irq, nmi context
  690. */
  691. int recursion[4];
  692. };
  693. struct perf_output_handle {
  694. struct perf_event *event;
  695. struct perf_mmap_data *data;
  696. unsigned long wakeup;
  697. unsigned long size;
  698. void *addr;
  699. int page;
  700. int nmi;
  701. int sample;
  702. };
  703. #ifdef CONFIG_PERF_EVENTS
  704. /*
  705. * Set by architecture code:
  706. */
  707. extern int perf_max_events;
  708. extern const struct pmu *hw_perf_event_init(struct perf_event *event);
  709. extern void perf_event_task_sched_in(struct task_struct *task);
  710. extern void perf_event_task_sched_out(struct task_struct *task, struct task_struct *next);
  711. extern void perf_event_task_tick(struct task_struct *task);
  712. extern int perf_event_init_task(struct task_struct *child);
  713. extern void perf_event_exit_task(struct task_struct *child);
  714. extern void perf_event_free_task(struct task_struct *task);
  715. extern void set_perf_event_pending(void);
  716. extern void perf_event_do_pending(void);
  717. extern void perf_event_print_debug(void);
  718. extern void __perf_disable(void);
  719. extern bool __perf_enable(void);
  720. extern void perf_disable(void);
  721. extern void perf_enable(void);
  722. extern int perf_event_task_disable(void);
  723. extern int perf_event_task_enable(void);
  724. extern void perf_event_update_userpage(struct perf_event *event);
  725. extern int perf_event_release_kernel(struct perf_event *event);
  726. extern struct perf_event *
  727. perf_event_create_kernel_counter(struct perf_event_attr *attr,
  728. int cpu,
  729. pid_t pid,
  730. perf_overflow_handler_t callback);
  731. extern u64 perf_event_read_value(struct perf_event *event,
  732. u64 *enabled, u64 *running);
  733. struct perf_sample_data {
  734. u64 type;
  735. u64 ip;
  736. struct {
  737. u32 pid;
  738. u32 tid;
  739. } tid_entry;
  740. u64 time;
  741. u64 addr;
  742. u64 id;
  743. u64 stream_id;
  744. struct {
  745. u32 cpu;
  746. u32 reserved;
  747. } cpu_entry;
  748. u64 period;
  749. struct perf_callchain_entry *callchain;
  750. struct perf_raw_record *raw;
  751. };
  752. static inline
  753. void perf_sample_data_init(struct perf_sample_data *data, u64 addr)
  754. {
  755. data->addr = addr;
  756. data->raw = NULL;
  757. }
  758. extern void perf_output_sample(struct perf_output_handle *handle,
  759. struct perf_event_header *header,
  760. struct perf_sample_data *data,
  761. struct perf_event *event);
  762. extern void perf_prepare_sample(struct perf_event_header *header,
  763. struct perf_sample_data *data,
  764. struct perf_event *event,
  765. struct pt_regs *regs);
  766. extern int perf_event_overflow(struct perf_event *event, int nmi,
  767. struct perf_sample_data *data,
  768. struct pt_regs *regs);
  769. /*
  770. * Return 1 for a software event, 0 for a hardware event
  771. */
  772. static inline int is_software_event(struct perf_event *event)
  773. {
  774. switch (event->attr.type) {
  775. case PERF_TYPE_SOFTWARE:
  776. case PERF_TYPE_TRACEPOINT:
  777. /* for now the breakpoint stuff also works as software event */
  778. case PERF_TYPE_BREAKPOINT:
  779. return 1;
  780. }
  781. return 0;
  782. }
  783. extern atomic_t perf_swevent_enabled[PERF_COUNT_SW_MAX];
  784. extern void __perf_sw_event(u32, u64, int, struct pt_regs *, u64);
  785. extern void
  786. perf_arch_fetch_caller_regs(struct pt_regs *regs, unsigned long ip, int skip);
  787. /*
  788. * Take a snapshot of the regs. Skip ip and frame pointer to
  789. * the nth caller. We only need a few of the regs:
  790. * - ip for PERF_SAMPLE_IP
  791. * - cs for user_mode() tests
  792. * - bp for callchains
  793. * - eflags, for future purposes, just in case
  794. */
  795. static inline void perf_fetch_caller_regs(struct pt_regs *regs, int skip)
  796. {
  797. unsigned long ip;
  798. memset(regs, 0, sizeof(*regs));
  799. switch (skip) {
  800. case 1 :
  801. ip = CALLER_ADDR0;
  802. break;
  803. case 2 :
  804. ip = CALLER_ADDR1;
  805. break;
  806. case 3 :
  807. ip = CALLER_ADDR2;
  808. break;
  809. case 4:
  810. ip = CALLER_ADDR3;
  811. break;
  812. /* No need to support further for now */
  813. default:
  814. ip = 0;
  815. }
  816. return perf_arch_fetch_caller_regs(regs, ip, skip);
  817. }
  818. static inline void
  819. perf_sw_event(u32 event_id, u64 nr, int nmi, struct pt_regs *regs, u64 addr)
  820. {
  821. if (atomic_read(&perf_swevent_enabled[event_id])) {
  822. struct pt_regs hot_regs;
  823. if (!regs) {
  824. perf_fetch_caller_regs(&hot_regs, 1);
  825. regs = &hot_regs;
  826. }
  827. __perf_sw_event(event_id, nr, nmi, regs, addr);
  828. }
  829. }
  830. extern void __perf_event_mmap(struct vm_area_struct *vma);
  831. static inline void perf_event_mmap(struct vm_area_struct *vma)
  832. {
  833. if (vma->vm_flags & VM_EXEC)
  834. __perf_event_mmap(vma);
  835. }
  836. extern struct perf_guest_info_callbacks *perf_guest_cbs;
  837. extern int perf_register_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
  838. extern int perf_unregister_guest_info_callbacks(struct perf_guest_info_callbacks *callbacks);
  839. extern void perf_event_comm(struct task_struct *tsk);
  840. extern void perf_event_fork(struct task_struct *tsk);
  841. extern struct perf_callchain_entry *perf_callchain(struct pt_regs *regs);
  842. extern int sysctl_perf_event_paranoid;
  843. extern int sysctl_perf_event_mlock;
  844. extern int sysctl_perf_event_sample_rate;
  845. static inline bool perf_paranoid_tracepoint_raw(void)
  846. {
  847. return sysctl_perf_event_paranoid > -1;
  848. }
  849. static inline bool perf_paranoid_cpu(void)
  850. {
  851. return sysctl_perf_event_paranoid > 0;
  852. }
  853. static inline bool perf_paranoid_kernel(void)
  854. {
  855. return sysctl_perf_event_paranoid > 1;
  856. }
  857. extern void perf_event_init(void);
  858. extern void perf_tp_event(u64 addr, u64 count, void *record,
  859. int entry_size, struct pt_regs *regs,
  860. struct hlist_head *head);
  861. extern void perf_bp_event(struct perf_event *event, void *data);
  862. #ifndef perf_misc_flags
  863. #define perf_misc_flags(regs) (user_mode(regs) ? PERF_RECORD_MISC_USER : \
  864. PERF_RECORD_MISC_KERNEL)
  865. #define perf_instruction_pointer(regs) instruction_pointer(regs)
  866. #endif
  867. extern int perf_output_begin(struct perf_output_handle *handle,
  868. struct perf_event *event, unsigned int size,
  869. int nmi, int sample);
  870. extern void perf_output_end(struct perf_output_handle *handle);
  871. extern void perf_output_copy(struct perf_output_handle *handle,
  872. const void *buf, unsigned int len);
  873. extern int perf_swevent_get_recursion_context(void);
  874. extern void perf_swevent_put_recursion_context(int rctx);
  875. extern void perf_event_enable(struct perf_event *event);
  876. extern void perf_event_disable(struct perf_event *event);
  877. #else
  878. static inline void
  879. perf_event_task_sched_in(struct task_struct *task) { }
  880. static inline void
  881. perf_event_task_sched_out(struct task_struct *task,
  882. struct task_struct *next) { }
  883. static inline void
  884. perf_event_task_tick(struct task_struct *task) { }
  885. static inline int perf_event_init_task(struct task_struct *child) { return 0; }
  886. static inline void perf_event_exit_task(struct task_struct *child) { }
  887. static inline void perf_event_free_task(struct task_struct *task) { }
  888. static inline void perf_event_do_pending(void) { }
  889. static inline void perf_event_print_debug(void) { }
  890. static inline void perf_disable(void) { }
  891. static inline void perf_enable(void) { }
  892. static inline int perf_event_task_disable(void) { return -EINVAL; }
  893. static inline int perf_event_task_enable(void) { return -EINVAL; }
  894. static inline void
  895. perf_sw_event(u32 event_id, u64 nr, int nmi,
  896. struct pt_regs *regs, u64 addr) { }
  897. static inline void
  898. perf_bp_event(struct perf_event *event, void *data) { }
  899. static inline int perf_register_guest_info_callbacks
  900. (struct perf_guest_info_callbacks *callbacks) { return 0; }
  901. static inline int perf_unregister_guest_info_callbacks
  902. (struct perf_guest_info_callbacks *callbacks) { return 0; }
  903. static inline void perf_event_mmap(struct vm_area_struct *vma) { }
  904. static inline void perf_event_comm(struct task_struct *tsk) { }
  905. static inline void perf_event_fork(struct task_struct *tsk) { }
  906. static inline void perf_event_init(void) { }
  907. static inline int perf_swevent_get_recursion_context(void) { return -1; }
  908. static inline void perf_swevent_put_recursion_context(int rctx) { }
  909. static inline void perf_event_enable(struct perf_event *event) { }
  910. static inline void perf_event_disable(struct perf_event *event) { }
  911. #endif
  912. #define perf_output_put(handle, x) \
  913. perf_output_copy((handle), &(x), sizeof(x))
  914. /*
  915. * This has to have a higher priority than migration_notifier in sched.c.
  916. */
  917. #define perf_cpu_notifier(fn) \
  918. do { \
  919. static struct notifier_block fn##_nb __cpuinitdata = \
  920. { .notifier_call = fn, .priority = 20 }; \
  921. fn(&fn##_nb, (unsigned long)CPU_UP_PREPARE, \
  922. (void *)(unsigned long)smp_processor_id()); \
  923. fn(&fn##_nb, (unsigned long)CPU_STARTING, \
  924. (void *)(unsigned long)smp_processor_id()); \
  925. fn(&fn##_nb, (unsigned long)CPU_ONLINE, \
  926. (void *)(unsigned long)smp_processor_id()); \
  927. register_cpu_notifier(&fn##_nb); \
  928. } while (0)
  929. #endif /* __KERNEL__ */
  930. #endif /* _LINUX_PERF_EVENT_H */