1
2
3
4
5
6
7#ifndef __PERF_AUXTRACE_H
8#define __PERF_AUXTRACE_H
9
10#include <sys/types.h>
11#include <errno.h>
12#include <stdbool.h>
13#include <stddef.h>
14#include <linux/list.h>
15#include <linux/perf_event.h>
16#include <linux/types.h>
17#include <asm/bitsperlong.h>
18
19#include "../perf.h"
20#include "event.h"
21#include "session.h"
22#include "debug.h"
23
24union perf_event;
25struct perf_session;
26struct perf_evlist;
27struct perf_tool;
28struct perf_mmap;
29struct option;
30struct record_opts;
31struct auxtrace_info_event;
32struct events_stats;
33
34
35#define PERF_AUXTRACE_RECORD_ALIGNMENT 8
36
37enum auxtrace_type {
38 PERF_AUXTRACE_UNKNOWN,
39 PERF_AUXTRACE_INTEL_PT,
40 PERF_AUXTRACE_INTEL_BTS,
41 PERF_AUXTRACE_CS_ETM,
42 PERF_AUXTRACE_ARM_SPE,
43 PERF_AUXTRACE_S390_CPUMSF,
44};
45
46enum itrace_period_type {
47 PERF_ITRACE_PERIOD_INSTRUCTIONS,
48 PERF_ITRACE_PERIOD_TICKS,
49 PERF_ITRACE_PERIOD_NANOSECS,
50};
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80struct itrace_synth_opts {
81 bool set;
82 bool default_no_sample;
83 bool inject;
84 bool instructions;
85 bool branches;
86 bool transactions;
87 bool ptwrites;
88 bool pwr_events;
89 bool errors;
90 bool dont_decode;
91 bool log;
92 bool calls;
93 bool returns;
94 bool callchain;
95 bool thread_stack;
96 bool last_branch;
97 unsigned int callchain_sz;
98 unsigned int last_branch_sz;
99 unsigned long long period;
100 enum itrace_period_type period_type;
101 unsigned long initial_skip;
102 unsigned long *cpu_bitmap;
103 struct perf_time_interval *ptime_range;
104 int range_num;
105};
106
107
108
109
110
111
112
113struct auxtrace_index_entry {
114 u64 file_offset;
115 u64 sz;
116};
117
118#define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
119
120
121
122
123
124
125
126
127struct auxtrace_index {
128 struct list_head list;
129 size_t nr;
130 struct auxtrace_index_entry entries[PERF_AUXTRACE_INDEX_ENTRY_COUNT];
131};
132
133
134
135
136
137
138
139
140
141struct auxtrace {
142 int (*process_event)(struct perf_session *session,
143 union perf_event *event,
144 struct perf_sample *sample,
145 struct perf_tool *tool);
146 int (*process_auxtrace_event)(struct perf_session *session,
147 union perf_event *event,
148 struct perf_tool *tool);
149 int (*flush_events)(struct perf_session *session,
150 struct perf_tool *tool);
151 void (*free_events)(struct perf_session *session);
152 void (*free)(struct perf_session *session);
153};
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178struct auxtrace_buffer {
179 struct list_head list;
180 size_t size;
181 pid_t pid;
182 pid_t tid;
183 int cpu;
184 void *data;
185 off_t data_offset;
186 void *mmap_addr;
187 size_t mmap_size;
188 bool data_needs_freeing;
189 bool consecutive;
190 u64 offset;
191 u64 reference;
192 u64 buffer_nr;
193 size_t use_size;
194 void *use_data;
195};
196
197
198
199
200
201
202
203
204
205struct auxtrace_queue {
206 struct list_head head;
207 pid_t tid;
208 int cpu;
209 bool set;
210 void *priv;
211};
212
213
214
215
216
217
218
219
220
221struct auxtrace_queues {
222 struct auxtrace_queue *queue_array;
223 unsigned int nr_queues;
224 bool new_data;
225 bool populated;
226 u64 next_buffer_nr;
227};
228
229
230
231
232
233
234
235struct auxtrace_heap_item {
236 unsigned int queue_nr;
237 u64 ordinal;
238};
239
240
241
242
243
244
245
246struct auxtrace_heap {
247 struct auxtrace_heap_item *heap_array;
248 unsigned int heap_cnt;
249 unsigned int heap_sz;
250};
251
252
253
254
255
256
257
258
259
260
261
262
263
264struct auxtrace_mmap {
265 void *base;
266 void *userpg;
267 size_t mask;
268 size_t len;
269 u64 prev;
270 int idx;
271 pid_t tid;
272 int cpu;
273};
274
275
276
277
278
279
280
281
282
283
284
285
286struct auxtrace_mmap_params {
287 size_t mask;
288 off_t offset;
289 size_t len;
290 int prot;
291 int idx;
292 pid_t tid;
293 int cpu;
294};
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310struct auxtrace_record {
311 int (*recording_options)(struct auxtrace_record *itr,
312 struct perf_evlist *evlist,
313 struct record_opts *opts);
314 size_t (*info_priv_size)(struct auxtrace_record *itr,
315 struct perf_evlist *evlist);
316 int (*info_fill)(struct auxtrace_record *itr,
317 struct perf_session *session,
318 struct auxtrace_info_event *auxtrace_info,
319 size_t priv_size);
320 void (*free)(struct auxtrace_record *itr);
321 int (*snapshot_start)(struct auxtrace_record *itr);
322 int (*snapshot_finish)(struct auxtrace_record *itr);
323 int (*find_snapshot)(struct auxtrace_record *itr, int idx,
324 struct auxtrace_mmap *mm, unsigned char *data,
325 u64 *head, u64 *old);
326 int (*parse_snapshot_options)(struct auxtrace_record *itr,
327 struct record_opts *opts,
328 const char *str);
329 u64 (*reference)(struct auxtrace_record *itr);
330 int (*read_finish)(struct auxtrace_record *itr, int idx);
331 unsigned int alignment;
332};
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351struct addr_filter {
352 struct list_head list;
353 bool range;
354 bool start;
355 const char *action;
356 const char *sym_from;
357 const char *sym_to;
358 int sym_from_idx;
359 int sym_to_idx;
360 u64 addr;
361 u64 size;
362 const char *filename;
363 char *str;
364};
365
366
367
368
369
370
371struct addr_filters {
372 struct list_head head;
373 int cnt;
374};
375
376#ifdef HAVE_AUXTRACE_SUPPORT
377
378
379
380
381
382
383
384static inline u64 auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap *mm)
385{
386 struct perf_event_mmap_page *pc = mm->userpg;
387 u64 head = READ_ONCE(pc->aux_head);
388
389
390 rmb();
391 return head;
392}
393
394static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm)
395{
396 struct perf_event_mmap_page *pc = mm->userpg;
397#if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
398 u64 head = READ_ONCE(pc->aux_head);
399#else
400 u64 head = __sync_val_compare_and_swap(&pc->aux_head, 0, 0);
401#endif
402
403
404 rmb();
405 return head;
406}
407
408static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail)
409{
410 struct perf_event_mmap_page *pc = mm->userpg;
411#if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
412 u64 old_tail;
413#endif
414
415
416 mb();
417#if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
418 pc->aux_tail = tail;
419#else
420 do {
421 old_tail = __sync_val_compare_and_swap(&pc->aux_tail, 0, 0);
422 } while (!__sync_bool_compare_and_swap(&pc->aux_tail, old_tail, tail));
423#endif
424}
425
426int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
427 struct auxtrace_mmap_params *mp,
428 void *userpg, int fd);
429void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
430void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
431 off_t auxtrace_offset,
432 unsigned int auxtrace_pages,
433 bool auxtrace_overwrite);
434void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
435 struct perf_evlist *evlist, int idx,
436 bool per_cpu);
437
438typedef int (*process_auxtrace_t)(struct perf_tool *tool,
439 struct perf_mmap *map,
440 union perf_event *event, void *data1,
441 size_t len1, void *data2, size_t len2);
442
443int auxtrace_mmap__read(struct perf_mmap *map, struct auxtrace_record *itr,
444 struct perf_tool *tool, process_auxtrace_t fn);
445
446int auxtrace_mmap__read_snapshot(struct perf_mmap *map,
447 struct auxtrace_record *itr,
448 struct perf_tool *tool, process_auxtrace_t fn,
449 size_t snapshot_size);
450
451int auxtrace_queues__init(struct auxtrace_queues *queues);
452int auxtrace_queues__add_event(struct auxtrace_queues *queues,
453 struct perf_session *session,
454 union perf_event *event, off_t data_offset,
455 struct auxtrace_buffer **buffer_ptr);
456void auxtrace_queues__free(struct auxtrace_queues *queues);
457int auxtrace_queues__process_index(struct auxtrace_queues *queues,
458 struct perf_session *session);
459struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
460 struct auxtrace_buffer *buffer);
461void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd);
462void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer);
463void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer);
464void auxtrace_buffer__free(struct auxtrace_buffer *buffer);
465
466int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
467 u64 ordinal);
468void auxtrace_heap__pop(struct auxtrace_heap *heap);
469void auxtrace_heap__free(struct auxtrace_heap *heap);
470
471struct auxtrace_cache_entry {
472 struct hlist_node hash;
473 u32 key;
474};
475
476struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
477 unsigned int limit_percent);
478void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache);
479void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c);
480void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry);
481int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
482 struct auxtrace_cache_entry *entry);
483void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key);
484
485struct auxtrace_record *auxtrace_record__init(struct perf_evlist *evlist,
486 int *err);
487
488int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
489 struct record_opts *opts,
490 const char *str);
491int auxtrace_record__options(struct auxtrace_record *itr,
492 struct perf_evlist *evlist,
493 struct record_opts *opts);
494size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
495 struct perf_evlist *evlist);
496int auxtrace_record__info_fill(struct auxtrace_record *itr,
497 struct perf_session *session,
498 struct auxtrace_info_event *auxtrace_info,
499 size_t priv_size);
500void auxtrace_record__free(struct auxtrace_record *itr);
501int auxtrace_record__snapshot_start(struct auxtrace_record *itr);
502int auxtrace_record__snapshot_finish(struct auxtrace_record *itr);
503int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
504 struct auxtrace_mmap *mm,
505 unsigned char *data, u64 *head, u64 *old);
506u64 auxtrace_record__reference(struct auxtrace_record *itr);
507
508int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event,
509 off_t file_offset);
510int auxtrace_index__write(int fd, struct list_head *head);
511int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
512 bool needs_swap);
513void auxtrace_index__free(struct list_head *head);
514
515void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type,
516 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
517 const char *msg, u64 timestamp);
518
519int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
520 struct perf_tool *tool,
521 struct perf_session *session,
522 perf_event__handler_t process);
523int perf_event__process_auxtrace_info(struct perf_session *session,
524 union perf_event *event);
525s64 perf_event__process_auxtrace(struct perf_session *session,
526 union perf_event *event);
527int perf_event__process_auxtrace_error(struct perf_session *session,
528 union perf_event *event);
529int itrace_parse_synth_opts(const struct option *opt, const char *str,
530 int unset);
531void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts,
532 bool no_sample);
533
534size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp);
535void perf_session__auxtrace_error_inc(struct perf_session *session,
536 union perf_event *event);
537void events_stats__auxtrace_error_warn(const struct events_stats *stats);
538
539void addr_filters__init(struct addr_filters *filts);
540void addr_filters__exit(struct addr_filters *filts);
541int addr_filters__parse_bare_filter(struct addr_filters *filts,
542 const char *filter);
543int auxtrace_parse_filters(struct perf_evlist *evlist);
544
545static inline int auxtrace__process_event(struct perf_session *session,
546 union perf_event *event,
547 struct perf_sample *sample,
548 struct perf_tool *tool)
549{
550 if (!session->auxtrace)
551 return 0;
552
553 return session->auxtrace->process_event(session, event, sample, tool);
554}
555
556static inline int auxtrace__flush_events(struct perf_session *session,
557 struct perf_tool *tool)
558{
559 if (!session->auxtrace)
560 return 0;
561
562 return session->auxtrace->flush_events(session, tool);
563}
564
565static inline void auxtrace__free_events(struct perf_session *session)
566{
567 if (!session->auxtrace)
568 return;
569
570 return session->auxtrace->free_events(session);
571}
572
573static inline void auxtrace__free(struct perf_session *session)
574{
575 if (!session->auxtrace)
576 return;
577
578 return session->auxtrace->free(session);
579}
580
581#define ITRACE_HELP \
582" i: synthesize instructions events\n" \
583" b: synthesize branches events\n" \
584" c: synthesize branches events (calls only)\n" \
585" r: synthesize branches events (returns only)\n" \
586" x: synthesize transactions events\n" \
587" w: synthesize ptwrite events\n" \
588" p: synthesize power events\n" \
589" e: synthesize error events\n" \
590" d: create a debug log\n" \
591" g[len]: synthesize a call chain (use with i or x)\n" \
592" l[len]: synthesize last branch entries (use with i or x)\n" \
593" sNUMBER: skip initial number of events\n" \
594" PERIOD[ns|us|ms|i|t]: specify period to sample stream\n" \
595" concatenate multiple options. Default is ibxwpe or cewp\n"
596
597static inline
598void itrace_synth_opts__set_time_range(struct itrace_synth_opts *opts,
599 struct perf_time_interval *ptime_range,
600 int range_num)
601{
602 opts->ptime_range = ptime_range;
603 opts->range_num = range_num;
604}
605
606static inline
607void itrace_synth_opts__clear_time_range(struct itrace_synth_opts *opts)
608{
609 opts->ptime_range = NULL;
610 opts->range_num = 0;
611}
612
613#else
614
615static inline struct auxtrace_record *
616auxtrace_record__init(struct perf_evlist *evlist __maybe_unused,
617 int *err)
618{
619 *err = 0;
620 return NULL;
621}
622
623static inline
624void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused)
625{
626}
627
628static inline int
629perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr __maybe_unused,
630 struct perf_tool *tool __maybe_unused,
631 struct perf_session *session __maybe_unused,
632 perf_event__handler_t process __maybe_unused)
633{
634 return -EINVAL;
635}
636
637static inline
638int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused,
639 struct perf_evlist *evlist __maybe_unused,
640 struct record_opts *opts __maybe_unused)
641{
642 return 0;
643}
644
645#define perf_event__process_auxtrace_info 0
646#define perf_event__process_auxtrace 0
647#define perf_event__process_auxtrace_error 0
648
649static inline
650void perf_session__auxtrace_error_inc(struct perf_session *session
651 __maybe_unused,
652 union perf_event *event
653 __maybe_unused)
654{
655}
656
657static inline
658void events_stats__auxtrace_error_warn(const struct events_stats *stats
659 __maybe_unused)
660{
661}
662
663static inline
664int itrace_parse_synth_opts(const struct option *opt __maybe_unused,
665 const char *str __maybe_unused,
666 int unset __maybe_unused)
667{
668 pr_err("AUX area tracing not supported\n");
669 return -EINVAL;
670}
671
672static inline
673int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused,
674 struct record_opts *opts __maybe_unused,
675 const char *str)
676{
677 if (!str)
678 return 0;
679 pr_err("AUX area tracing not supported\n");
680 return -EINVAL;
681}
682
683static inline
684int auxtrace__process_event(struct perf_session *session __maybe_unused,
685 union perf_event *event __maybe_unused,
686 struct perf_sample *sample __maybe_unused,
687 struct perf_tool *tool __maybe_unused)
688{
689 return 0;
690}
691
692static inline
693int auxtrace__flush_events(struct perf_session *session __maybe_unused,
694 struct perf_tool *tool __maybe_unused)
695{
696 return 0;
697}
698
699static inline
700void auxtrace__free_events(struct perf_session *session __maybe_unused)
701{
702}
703
704static inline
705void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused)
706{
707}
708
709static inline
710void auxtrace__free(struct perf_session *session __maybe_unused)
711{
712}
713
714static inline
715int auxtrace_index__write(int fd __maybe_unused,
716 struct list_head *head __maybe_unused)
717{
718 return -EINVAL;
719}
720
721static inline
722int auxtrace_index__process(int fd __maybe_unused,
723 u64 size __maybe_unused,
724 struct perf_session *session __maybe_unused,
725 bool needs_swap __maybe_unused)
726{
727 return -EINVAL;
728}
729
730static inline
731void auxtrace_index__free(struct list_head *head __maybe_unused)
732{
733}
734
735static inline
736int auxtrace_parse_filters(struct perf_evlist *evlist __maybe_unused)
737{
738 return 0;
739}
740
741int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
742 struct auxtrace_mmap_params *mp,
743 void *userpg, int fd);
744void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
745void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
746 off_t auxtrace_offset,
747 unsigned int auxtrace_pages,
748 bool auxtrace_overwrite);
749void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
750 struct perf_evlist *evlist, int idx,
751 bool per_cpu);
752
753#define ITRACE_HELP ""
754
755static inline
756void itrace_synth_opts__set_time_range(struct itrace_synth_opts *opts
757 __maybe_unused,
758 struct perf_time_interval *ptime_range
759 __maybe_unused,
760 int range_num __maybe_unused)
761{
762}
763
764static inline
765void itrace_synth_opts__clear_time_range(struct itrace_synth_opts *opts
766 __maybe_unused)
767{
768}
769
770#endif
771
772#endif
773