Loading...
1/*
2 * auxtrace.h: AUX area trace support
3 * Copyright (c) 2013-2015, Intel Corporation.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
14 */
15
16#ifndef __PERF_AUXTRACE_H
17#define __PERF_AUXTRACE_H
18
19#include <sys/types.h>
20#include <stdbool.h>
21#include <stddef.h>
22#include <linux/list.h>
23#include <linux/perf_event.h>
24#include <linux/types.h>
25
26#include "../perf.h"
27#include "event.h"
28#include "session.h"
29#include "debug.h"
30
31union perf_event;
32struct perf_session;
33struct perf_evlist;
34struct perf_tool;
35struct option;
36struct record_opts;
37struct auxtrace_info_event;
38struct events_stats;
39
40enum auxtrace_type {
41 PERF_AUXTRACE_UNKNOWN,
42 PERF_AUXTRACE_INTEL_PT,
43 PERF_AUXTRACE_INTEL_BTS,
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 * struct itrace_synth_opts - AUX area tracing synthesis options.
54 * @set: indicates whether or not options have been set
55 * @inject: indicates the event (not just the sample) must be fully synthesized
56 * because 'perf inject' will write it out
57 * @instructions: whether to synthesize 'instructions' events
58 * @branches: whether to synthesize 'branches' events
59 * @transactions: whether to synthesize events for transactions
60 * @errors: whether to synthesize decoder error events
61 * @dont_decode: whether to skip decoding entirely
62 * @log: write a decoding log
63 * @calls: limit branch samples to calls (can be combined with @returns)
64 * @returns: limit branch samples to returns (can be combined with @calls)
65 * @callchain: add callchain to 'instructions' events
66 * @last_branch: add branch context to 'instruction' events
67 * @callchain_sz: maximum callchain size
68 * @last_branch_sz: branch context size
69 * @period: 'instructions' events period
70 * @period_type: 'instructions' events period type
71 */
72struct itrace_synth_opts {
73 bool set;
74 bool inject;
75 bool instructions;
76 bool branches;
77 bool transactions;
78 bool errors;
79 bool dont_decode;
80 bool log;
81 bool calls;
82 bool returns;
83 bool callchain;
84 bool last_branch;
85 unsigned int callchain_sz;
86 unsigned int last_branch_sz;
87 unsigned long long period;
88 enum itrace_period_type period_type;
89};
90
91/**
92 * struct auxtrace_index_entry - indexes a AUX area tracing event within a
93 * perf.data file.
94 * @file_offset: offset within the perf.data file
95 * @sz: size of the event
96 */
97struct auxtrace_index_entry {
98 u64 file_offset;
99 u64 sz;
100};
101
102#define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
103
104/**
105 * struct auxtrace_index - index of AUX area tracing events within a perf.data
106 * file.
107 * @list: linking a number of arrays of entries
108 * @nr: number of entries
109 * @entries: array of entries
110 */
111struct auxtrace_index {
112 struct list_head list;
113 size_t nr;
114 struct auxtrace_index_entry entries[PERF_AUXTRACE_INDEX_ENTRY_COUNT];
115};
116
117/**
118 * struct auxtrace - session callbacks to allow AUX area data decoding.
119 * @process_event: lets the decoder see all session events
120 * @flush_events: process any remaining data
121 * @free_events: free resources associated with event processing
122 * @free: free resources associated with the session
123 */
124struct auxtrace {
125 int (*process_event)(struct perf_session *session,
126 union perf_event *event,
127 struct perf_sample *sample,
128 struct perf_tool *tool);
129 int (*process_auxtrace_event)(struct perf_session *session,
130 union perf_event *event,
131 struct perf_tool *tool);
132 int (*flush_events)(struct perf_session *session,
133 struct perf_tool *tool);
134 void (*free_events)(struct perf_session *session);
135 void (*free)(struct perf_session *session);
136};
137
138/**
139 * struct auxtrace_buffer - a buffer containing AUX area tracing data.
140 * @list: buffers are queued in a list held by struct auxtrace_queue
141 * @size: size of the buffer in bytes
142 * @pid: in per-thread mode, the pid this buffer is associated with
143 * @tid: in per-thread mode, the tid this buffer is associated with
144 * @cpu: in per-cpu mode, the cpu this buffer is associated with
145 * @data: actual buffer data (can be null if the data has not been loaded)
146 * @data_offset: file offset at which the buffer can be read
147 * @mmap_addr: mmap address at which the buffer can be read
148 * @mmap_size: size of the mmap at @mmap_addr
149 * @data_needs_freeing: @data was malloc'd so free it when it is no longer
150 * needed
151 * @consecutive: the original data was split up and this buffer is consecutive
152 * to the previous buffer
153 * @offset: offset as determined by aux_head / aux_tail members of struct
154 * perf_event_mmap_page
155 * @reference: an implementation-specific reference determined when the data is
156 * recorded
157 * @buffer_nr: used to number each buffer
158 * @use_size: implementation actually only uses this number of bytes
159 * @use_data: implementation actually only uses data starting at this address
160 */
161struct auxtrace_buffer {
162 struct list_head list;
163 size_t size;
164 pid_t pid;
165 pid_t tid;
166 int cpu;
167 void *data;
168 off_t data_offset;
169 void *mmap_addr;
170 size_t mmap_size;
171 bool data_needs_freeing;
172 bool consecutive;
173 u64 offset;
174 u64 reference;
175 u64 buffer_nr;
176 size_t use_size;
177 void *use_data;
178};
179
180/**
181 * struct auxtrace_queue - a queue of AUX area tracing data buffers.
182 * @head: head of buffer list
183 * @tid: in per-thread mode, the tid this queue is associated with
184 * @cpu: in per-cpu mode, the cpu this queue is associated with
185 * @set: %true once this queue has been dedicated to a specific thread or cpu
186 * @priv: implementation-specific data
187 */
188struct auxtrace_queue {
189 struct list_head head;
190 pid_t tid;
191 int cpu;
192 bool set;
193 void *priv;
194};
195
196/**
197 * struct auxtrace_queues - an array of AUX area tracing queues.
198 * @queue_array: array of queues
199 * @nr_queues: number of queues
200 * @new_data: set whenever new data is queued
201 * @populated: queues have been fully populated using the auxtrace_index
202 * @next_buffer_nr: used to number each buffer
203 */
204struct auxtrace_queues {
205 struct auxtrace_queue *queue_array;
206 unsigned int nr_queues;
207 bool new_data;
208 bool populated;
209 u64 next_buffer_nr;
210};
211
212/**
213 * struct auxtrace_heap_item - element of struct auxtrace_heap.
214 * @queue_nr: queue number
215 * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
216 * to be a timestamp
217 */
218struct auxtrace_heap_item {
219 unsigned int queue_nr;
220 u64 ordinal;
221};
222
223/**
224 * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
225 * @heap_array: the heap
226 * @heap_cnt: the number of elements in the heap
227 * @heap_sz: maximum number of elements (grows as needed)
228 */
229struct auxtrace_heap {
230 struct auxtrace_heap_item *heap_array;
231 unsigned int heap_cnt;
232 unsigned int heap_sz;
233};
234
235/**
236 * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
237 * @base: address of mapped area
238 * @userpg: pointer to buffer's perf_event_mmap_page
239 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
240 * @len: size of mapped area
241 * @prev: previous aux_head
242 * @idx: index of this mmap
243 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
244 * mmap) otherwise %0
245 * @cpu: cpu number for a per-cpu mmap otherwise %-1
246 */
247struct auxtrace_mmap {
248 void *base;
249 void *userpg;
250 size_t mask;
251 size_t len;
252 u64 prev;
253 int idx;
254 pid_t tid;
255 int cpu;
256};
257
258/**
259 * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
260 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
261 * @offset: file offset of mapped area
262 * @len: size of mapped area
263 * @prot: mmap memory protection
264 * @idx: index of this mmap
265 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
266 * mmap) otherwise %0
267 * @cpu: cpu number for a per-cpu mmap otherwise %-1
268 */
269struct auxtrace_mmap_params {
270 size_t mask;
271 off_t offset;
272 size_t len;
273 int prot;
274 int idx;
275 pid_t tid;
276 int cpu;
277};
278
279/**
280 * struct auxtrace_record - callbacks for recording AUX area data.
281 * @recording_options: validate and process recording options
282 * @info_priv_size: return the size of the private data in auxtrace_info_event
283 * @info_fill: fill-in the private data in auxtrace_info_event
284 * @free: free this auxtrace record structure
285 * @snapshot_start: starting a snapshot
286 * @snapshot_finish: finishing a snapshot
287 * @find_snapshot: find data to snapshot within auxtrace mmap
288 * @parse_snapshot_options: parse snapshot options
289 * @reference: provide a 64-bit reference number for auxtrace_event
290 * @read_finish: called after reading from an auxtrace mmap
291 */
292struct auxtrace_record {
293 int (*recording_options)(struct auxtrace_record *itr,
294 struct perf_evlist *evlist,
295 struct record_opts *opts);
296 size_t (*info_priv_size)(struct auxtrace_record *itr,
297 struct perf_evlist *evlist);
298 int (*info_fill)(struct auxtrace_record *itr,
299 struct perf_session *session,
300 struct auxtrace_info_event *auxtrace_info,
301 size_t priv_size);
302 void (*free)(struct auxtrace_record *itr);
303 int (*snapshot_start)(struct auxtrace_record *itr);
304 int (*snapshot_finish)(struct auxtrace_record *itr);
305 int (*find_snapshot)(struct auxtrace_record *itr, int idx,
306 struct auxtrace_mmap *mm, unsigned char *data,
307 u64 *head, u64 *old);
308 int (*parse_snapshot_options)(struct auxtrace_record *itr,
309 struct record_opts *opts,
310 const char *str);
311 u64 (*reference)(struct auxtrace_record *itr);
312 int (*read_finish)(struct auxtrace_record *itr, int idx);
313 unsigned int alignment;
314};
315
316#ifdef HAVE_AUXTRACE_SUPPORT
317
318/*
319 * In snapshot mode the mmapped page is read-only which makes using
320 * __sync_val_compare_and_swap() problematic. However, snapshot mode expects
321 * the buffer is not updated while the snapshot is made (e.g. Intel PT disables
322 * the event) so there is not a race anyway.
323 */
324static inline u64 auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap *mm)
325{
326 struct perf_event_mmap_page *pc = mm->userpg;
327 u64 head = ACCESS_ONCE(pc->aux_head);
328
329 /* Ensure all reads are done after we read the head */
330 rmb();
331 return head;
332}
333
334static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm)
335{
336 struct perf_event_mmap_page *pc = mm->userpg;
337#if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
338 u64 head = ACCESS_ONCE(pc->aux_head);
339#else
340 u64 head = __sync_val_compare_and_swap(&pc->aux_head, 0, 0);
341#endif
342
343 /* Ensure all reads are done after we read the head */
344 rmb();
345 return head;
346}
347
348static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail)
349{
350 struct perf_event_mmap_page *pc = mm->userpg;
351#if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
352 u64 old_tail;
353#endif
354
355 /* Ensure all reads are done before we write the tail out */
356 mb();
357#if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
358 pc->aux_tail = tail;
359#else
360 do {
361 old_tail = __sync_val_compare_and_swap(&pc->aux_tail, 0, 0);
362 } while (!__sync_bool_compare_and_swap(&pc->aux_tail, old_tail, tail));
363#endif
364}
365
366int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
367 struct auxtrace_mmap_params *mp,
368 void *userpg, int fd);
369void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
370void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
371 off_t auxtrace_offset,
372 unsigned int auxtrace_pages,
373 bool auxtrace_overwrite);
374void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
375 struct perf_evlist *evlist, int idx,
376 bool per_cpu);
377
378typedef int (*process_auxtrace_t)(struct perf_tool *tool,
379 union perf_event *event, void *data1,
380 size_t len1, void *data2, size_t len2);
381
382int auxtrace_mmap__read(struct auxtrace_mmap *mm, struct auxtrace_record *itr,
383 struct perf_tool *tool, process_auxtrace_t fn);
384
385int auxtrace_mmap__read_snapshot(struct auxtrace_mmap *mm,
386 struct auxtrace_record *itr,
387 struct perf_tool *tool, process_auxtrace_t fn,
388 size_t snapshot_size);
389
390int auxtrace_queues__init(struct auxtrace_queues *queues);
391int auxtrace_queues__add_event(struct auxtrace_queues *queues,
392 struct perf_session *session,
393 union perf_event *event, off_t data_offset,
394 struct auxtrace_buffer **buffer_ptr);
395void auxtrace_queues__free(struct auxtrace_queues *queues);
396int auxtrace_queues__process_index(struct auxtrace_queues *queues,
397 struct perf_session *session);
398struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
399 struct auxtrace_buffer *buffer);
400void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd);
401void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer);
402void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer);
403void auxtrace_buffer__free(struct auxtrace_buffer *buffer);
404
405int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
406 u64 ordinal);
407void auxtrace_heap__pop(struct auxtrace_heap *heap);
408void auxtrace_heap__free(struct auxtrace_heap *heap);
409
410struct auxtrace_cache_entry {
411 struct hlist_node hash;
412 u32 key;
413};
414
415struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
416 unsigned int limit_percent);
417void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache);
418void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c);
419void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry);
420int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
421 struct auxtrace_cache_entry *entry);
422void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key);
423
424struct auxtrace_record *auxtrace_record__init(struct perf_evlist *evlist,
425 int *err);
426
427int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
428 struct record_opts *opts,
429 const char *str);
430int auxtrace_record__options(struct auxtrace_record *itr,
431 struct perf_evlist *evlist,
432 struct record_opts *opts);
433size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
434 struct perf_evlist *evlist);
435int auxtrace_record__info_fill(struct auxtrace_record *itr,
436 struct perf_session *session,
437 struct auxtrace_info_event *auxtrace_info,
438 size_t priv_size);
439void auxtrace_record__free(struct auxtrace_record *itr);
440int auxtrace_record__snapshot_start(struct auxtrace_record *itr);
441int auxtrace_record__snapshot_finish(struct auxtrace_record *itr);
442int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
443 struct auxtrace_mmap *mm,
444 unsigned char *data, u64 *head, u64 *old);
445u64 auxtrace_record__reference(struct auxtrace_record *itr);
446
447int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event,
448 off_t file_offset);
449int auxtrace_index__write(int fd, struct list_head *head);
450int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
451 bool needs_swap);
452void auxtrace_index__free(struct list_head *head);
453
454void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type,
455 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
456 const char *msg);
457
458int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
459 struct perf_tool *tool,
460 struct perf_session *session,
461 perf_event__handler_t process);
462int perf_event__process_auxtrace_info(struct perf_tool *tool,
463 union perf_event *event,
464 struct perf_session *session);
465s64 perf_event__process_auxtrace(struct perf_tool *tool,
466 union perf_event *event,
467 struct perf_session *session);
468int perf_event__process_auxtrace_error(struct perf_tool *tool,
469 union perf_event *event,
470 struct perf_session *session);
471int itrace_parse_synth_opts(const struct option *opt, const char *str,
472 int unset);
473void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts);
474
475size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp);
476void perf_session__auxtrace_error_inc(struct perf_session *session,
477 union perf_event *event);
478void events_stats__auxtrace_error_warn(const struct events_stats *stats);
479
480static inline int auxtrace__process_event(struct perf_session *session,
481 union perf_event *event,
482 struct perf_sample *sample,
483 struct perf_tool *tool)
484{
485 if (!session->auxtrace)
486 return 0;
487
488 return session->auxtrace->process_event(session, event, sample, tool);
489}
490
491static inline int auxtrace__flush_events(struct perf_session *session,
492 struct perf_tool *tool)
493{
494 if (!session->auxtrace)
495 return 0;
496
497 return session->auxtrace->flush_events(session, tool);
498}
499
500static inline void auxtrace__free_events(struct perf_session *session)
501{
502 if (!session->auxtrace)
503 return;
504
505 return session->auxtrace->free_events(session);
506}
507
508static inline void auxtrace__free(struct perf_session *session)
509{
510 if (!session->auxtrace)
511 return;
512
513 return session->auxtrace->free(session);
514}
515
516#else
517
518static inline struct auxtrace_record *
519auxtrace_record__init(struct perf_evlist *evlist __maybe_unused,
520 int *err)
521{
522 *err = 0;
523 return NULL;
524}
525
526static inline
527void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused)
528{
529}
530
531static inline int
532perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr __maybe_unused,
533 struct perf_tool *tool __maybe_unused,
534 struct perf_session *session __maybe_unused,
535 perf_event__handler_t process __maybe_unused)
536{
537 return -EINVAL;
538}
539
540static inline
541int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused,
542 struct perf_evlist *evlist __maybe_unused,
543 struct record_opts *opts __maybe_unused)
544{
545 return 0;
546}
547
548#define perf_event__process_auxtrace_info 0
549#define perf_event__process_auxtrace 0
550#define perf_event__process_auxtrace_error 0
551
552static inline
553void perf_session__auxtrace_error_inc(struct perf_session *session
554 __maybe_unused,
555 union perf_event *event
556 __maybe_unused)
557{
558}
559
560static inline
561void events_stats__auxtrace_error_warn(const struct events_stats *stats
562 __maybe_unused)
563{
564}
565
566static inline
567int itrace_parse_synth_opts(const struct option *opt __maybe_unused,
568 const char *str __maybe_unused,
569 int unset __maybe_unused)
570{
571 pr_err("AUX area tracing not supported\n");
572 return -EINVAL;
573}
574
575static inline
576int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused,
577 struct record_opts *opts __maybe_unused,
578 const char *str)
579{
580 if (!str)
581 return 0;
582 pr_err("AUX area tracing not supported\n");
583 return -EINVAL;
584}
585
586static inline
587int auxtrace__process_event(struct perf_session *session __maybe_unused,
588 union perf_event *event __maybe_unused,
589 struct perf_sample *sample __maybe_unused,
590 struct perf_tool *tool __maybe_unused)
591{
592 return 0;
593}
594
595static inline
596int auxtrace__flush_events(struct perf_session *session __maybe_unused,
597 struct perf_tool *tool __maybe_unused)
598{
599 return 0;
600}
601
602static inline
603void auxtrace__free_events(struct perf_session *session __maybe_unused)
604{
605}
606
607static inline
608void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused)
609{
610}
611
612static inline
613void auxtrace__free(struct perf_session *session __maybe_unused)
614{
615}
616
617static inline
618int auxtrace_index__write(int fd __maybe_unused,
619 struct list_head *head __maybe_unused)
620{
621 return -EINVAL;
622}
623
624static inline
625int auxtrace_index__process(int fd __maybe_unused,
626 u64 size __maybe_unused,
627 struct perf_session *session __maybe_unused,
628 bool needs_swap __maybe_unused)
629{
630 return -EINVAL;
631}
632
633static inline
634void auxtrace_index__free(struct list_head *head __maybe_unused)
635{
636}
637
638int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
639 struct auxtrace_mmap_params *mp,
640 void *userpg, int fd);
641void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
642void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
643 off_t auxtrace_offset,
644 unsigned int auxtrace_pages,
645 bool auxtrace_overwrite);
646void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
647 struct perf_evlist *evlist, int idx,
648 bool per_cpu);
649
650#endif
651
652#endif
1/*
2 * auxtrace.h: AUX area trace support
3 * Copyright (c) 2013-2015, Intel Corporation.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
14 */
15
16#ifndef __PERF_AUXTRACE_H
17#define __PERF_AUXTRACE_H
18
19#include <sys/types.h>
20#include <errno.h>
21#include <stdbool.h>
22#include <stddef.h>
23#include <linux/list.h>
24#include <linux/perf_event.h>
25#include <linux/types.h>
26
27#include "../perf.h"
28#include "event.h"
29#include "session.h"
30#include "debug.h"
31
32union perf_event;
33struct perf_session;
34struct perf_evlist;
35struct perf_tool;
36struct option;
37struct record_opts;
38struct auxtrace_info_event;
39struct events_stats;
40
41enum auxtrace_type {
42 PERF_AUXTRACE_UNKNOWN,
43 PERF_AUXTRACE_INTEL_PT,
44 PERF_AUXTRACE_INTEL_BTS,
45 PERF_AUXTRACE_CS_ETM,
46 PERF_AUXTRACE_ARM_SPE,
47};
48
49enum itrace_period_type {
50 PERF_ITRACE_PERIOD_INSTRUCTIONS,
51 PERF_ITRACE_PERIOD_TICKS,
52 PERF_ITRACE_PERIOD_NANOSECS,
53};
54
55/**
56 * struct itrace_synth_opts - AUX area tracing synthesis options.
57 * @set: indicates whether or not options have been set
58 * @inject: indicates the event (not just the sample) must be fully synthesized
59 * because 'perf inject' will write it out
60 * @instructions: whether to synthesize 'instructions' events
61 * @branches: whether to synthesize 'branches' events
62 * @transactions: whether to synthesize events for transactions
63 * @ptwrites: whether to synthesize events for ptwrites
64 * @pwr_events: whether to synthesize power events
65 * @errors: whether to synthesize decoder error events
66 * @dont_decode: whether to skip decoding entirely
67 * @log: write a decoding log
68 * @calls: limit branch samples to calls (can be combined with @returns)
69 * @returns: limit branch samples to returns (can be combined with @calls)
70 * @callchain: add callchain to 'instructions' events
71 * @thread_stack: feed branches to the thread_stack
72 * @last_branch: add branch context to 'instruction' events
73 * @callchain_sz: maximum callchain size
74 * @last_branch_sz: branch context size
75 * @period: 'instructions' events period
76 * @period_type: 'instructions' events period type
77 * @initial_skip: skip N events at the beginning.
78 * @cpu_bitmap: CPUs for which to synthesize events, or NULL for all
79 */
80struct itrace_synth_opts {
81 bool set;
82 bool inject;
83 bool instructions;
84 bool branches;
85 bool transactions;
86 bool ptwrites;
87 bool pwr_events;
88 bool errors;
89 bool dont_decode;
90 bool log;
91 bool calls;
92 bool returns;
93 bool callchain;
94 bool thread_stack;
95 bool last_branch;
96 unsigned int callchain_sz;
97 unsigned int last_branch_sz;
98 unsigned long long period;
99 enum itrace_period_type period_type;
100 unsigned long initial_skip;
101 unsigned long *cpu_bitmap;
102};
103
104/**
105 * struct auxtrace_index_entry - indexes a AUX area tracing event within a
106 * perf.data file.
107 * @file_offset: offset within the perf.data file
108 * @sz: size of the event
109 */
110struct auxtrace_index_entry {
111 u64 file_offset;
112 u64 sz;
113};
114
115#define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
116
117/**
118 * struct auxtrace_index - index of AUX area tracing events within a perf.data
119 * file.
120 * @list: linking a number of arrays of entries
121 * @nr: number of entries
122 * @entries: array of entries
123 */
124struct auxtrace_index {
125 struct list_head list;
126 size_t nr;
127 struct auxtrace_index_entry entries[PERF_AUXTRACE_INDEX_ENTRY_COUNT];
128};
129
130/**
131 * struct auxtrace - session callbacks to allow AUX area data decoding.
132 * @process_event: lets the decoder see all session events
133 * @process_auxtrace_event: process a PERF_RECORD_AUXTRACE event
134 * @flush_events: process any remaining data
135 * @free_events: free resources associated with event processing
136 * @free: free resources associated with the session
137 */
138struct auxtrace {
139 int (*process_event)(struct perf_session *session,
140 union perf_event *event,
141 struct perf_sample *sample,
142 struct perf_tool *tool);
143 int (*process_auxtrace_event)(struct perf_session *session,
144 union perf_event *event,
145 struct perf_tool *tool);
146 int (*flush_events)(struct perf_session *session,
147 struct perf_tool *tool);
148 void (*free_events)(struct perf_session *session);
149 void (*free)(struct perf_session *session);
150};
151
152/**
153 * struct auxtrace_buffer - a buffer containing AUX area tracing data.
154 * @list: buffers are queued in a list held by struct auxtrace_queue
155 * @size: size of the buffer in bytes
156 * @pid: in per-thread mode, the pid this buffer is associated with
157 * @tid: in per-thread mode, the tid this buffer is associated with
158 * @cpu: in per-cpu mode, the cpu this buffer is associated with
159 * @data: actual buffer data (can be null if the data has not been loaded)
160 * @data_offset: file offset at which the buffer can be read
161 * @mmap_addr: mmap address at which the buffer can be read
162 * @mmap_size: size of the mmap at @mmap_addr
163 * @data_needs_freeing: @data was malloc'd so free it when it is no longer
164 * needed
165 * @consecutive: the original data was split up and this buffer is consecutive
166 * to the previous buffer
167 * @offset: offset as determined by aux_head / aux_tail members of struct
168 * perf_event_mmap_page
169 * @reference: an implementation-specific reference determined when the data is
170 * recorded
171 * @buffer_nr: used to number each buffer
172 * @use_size: implementation actually only uses this number of bytes
173 * @use_data: implementation actually only uses data starting at this address
174 */
175struct auxtrace_buffer {
176 struct list_head list;
177 size_t size;
178 pid_t pid;
179 pid_t tid;
180 int cpu;
181 void *data;
182 off_t data_offset;
183 void *mmap_addr;
184 size_t mmap_size;
185 bool data_needs_freeing;
186 bool consecutive;
187 u64 offset;
188 u64 reference;
189 u64 buffer_nr;
190 size_t use_size;
191 void *use_data;
192};
193
194/**
195 * struct auxtrace_queue - a queue of AUX area tracing data buffers.
196 * @head: head of buffer list
197 * @tid: in per-thread mode, the tid this queue is associated with
198 * @cpu: in per-cpu mode, the cpu this queue is associated with
199 * @set: %true once this queue has been dedicated to a specific thread or cpu
200 * @priv: implementation-specific data
201 */
202struct auxtrace_queue {
203 struct list_head head;
204 pid_t tid;
205 int cpu;
206 bool set;
207 void *priv;
208};
209
210/**
211 * struct auxtrace_queues - an array of AUX area tracing queues.
212 * @queue_array: array of queues
213 * @nr_queues: number of queues
214 * @new_data: set whenever new data is queued
215 * @populated: queues have been fully populated using the auxtrace_index
216 * @next_buffer_nr: used to number each buffer
217 */
218struct auxtrace_queues {
219 struct auxtrace_queue *queue_array;
220 unsigned int nr_queues;
221 bool new_data;
222 bool populated;
223 u64 next_buffer_nr;
224};
225
226/**
227 * struct auxtrace_heap_item - element of struct auxtrace_heap.
228 * @queue_nr: queue number
229 * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
230 * to be a timestamp
231 */
232struct auxtrace_heap_item {
233 unsigned int queue_nr;
234 u64 ordinal;
235};
236
237/**
238 * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
239 * @heap_array: the heap
240 * @heap_cnt: the number of elements in the heap
241 * @heap_sz: maximum number of elements (grows as needed)
242 */
243struct auxtrace_heap {
244 struct auxtrace_heap_item *heap_array;
245 unsigned int heap_cnt;
246 unsigned int heap_sz;
247};
248
249/**
250 * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
251 * @base: address of mapped area
252 * @userpg: pointer to buffer's perf_event_mmap_page
253 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
254 * @len: size of mapped area
255 * @prev: previous aux_head
256 * @idx: index of this mmap
257 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
258 * mmap) otherwise %0
259 * @cpu: cpu number for a per-cpu mmap otherwise %-1
260 */
261struct auxtrace_mmap {
262 void *base;
263 void *userpg;
264 size_t mask;
265 size_t len;
266 u64 prev;
267 int idx;
268 pid_t tid;
269 int cpu;
270};
271
272/**
273 * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
274 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
275 * @offset: file offset of mapped area
276 * @len: size of mapped area
277 * @prot: mmap memory protection
278 * @idx: index of this mmap
279 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
280 * mmap) otherwise %0
281 * @cpu: cpu number for a per-cpu mmap otherwise %-1
282 */
283struct auxtrace_mmap_params {
284 size_t mask;
285 off_t offset;
286 size_t len;
287 int prot;
288 int idx;
289 pid_t tid;
290 int cpu;
291};
292
293/**
294 * struct auxtrace_record - callbacks for recording AUX area data.
295 * @recording_options: validate and process recording options
296 * @info_priv_size: return the size of the private data in auxtrace_info_event
297 * @info_fill: fill-in the private data in auxtrace_info_event
298 * @free: free this auxtrace record structure
299 * @snapshot_start: starting a snapshot
300 * @snapshot_finish: finishing a snapshot
301 * @find_snapshot: find data to snapshot within auxtrace mmap
302 * @parse_snapshot_options: parse snapshot options
303 * @reference: provide a 64-bit reference number for auxtrace_event
304 * @read_finish: called after reading from an auxtrace mmap
305 * @alignment: alignment (if any) for AUX area data
306 */
307struct auxtrace_record {
308 int (*recording_options)(struct auxtrace_record *itr,
309 struct perf_evlist *evlist,
310 struct record_opts *opts);
311 size_t (*info_priv_size)(struct auxtrace_record *itr,
312 struct perf_evlist *evlist);
313 int (*info_fill)(struct auxtrace_record *itr,
314 struct perf_session *session,
315 struct auxtrace_info_event *auxtrace_info,
316 size_t priv_size);
317 void (*free)(struct auxtrace_record *itr);
318 int (*snapshot_start)(struct auxtrace_record *itr);
319 int (*snapshot_finish)(struct auxtrace_record *itr);
320 int (*find_snapshot)(struct auxtrace_record *itr, int idx,
321 struct auxtrace_mmap *mm, unsigned char *data,
322 u64 *head, u64 *old);
323 int (*parse_snapshot_options)(struct auxtrace_record *itr,
324 struct record_opts *opts,
325 const char *str);
326 u64 (*reference)(struct auxtrace_record *itr);
327 int (*read_finish)(struct auxtrace_record *itr, int idx);
328 unsigned int alignment;
329};
330
331/**
332 * struct addr_filter - address filter.
333 * @list: list node
334 * @range: true if it is a range filter
335 * @start: true if action is 'filter' or 'start'
336 * @action: 'filter', 'start' or 'stop' ('tracestop' is accepted but converted
337 * to 'stop')
338 * @sym_from: symbol name for the filter address
339 * @sym_to: symbol name that determines the filter size
340 * @sym_from_idx: selects n'th from symbols with the same name (0 means global
341 * and less than 0 means symbol must be unique)
342 * @sym_to_idx: same as @sym_from_idx but for @sym_to
343 * @addr: filter address
344 * @size: filter region size (for range filters)
345 * @filename: DSO file name or NULL for the kernel
346 * @str: allocated string that contains the other string members
347 */
348struct addr_filter {
349 struct list_head list;
350 bool range;
351 bool start;
352 const char *action;
353 const char *sym_from;
354 const char *sym_to;
355 int sym_from_idx;
356 int sym_to_idx;
357 u64 addr;
358 u64 size;
359 const char *filename;
360 char *str;
361};
362
363/**
364 * struct addr_filters - list of address filters.
365 * @head: list of address filters
366 * @cnt: number of address filters
367 */
368struct addr_filters {
369 struct list_head head;
370 int cnt;
371};
372
373#ifdef HAVE_AUXTRACE_SUPPORT
374
375/*
376 * In snapshot mode the mmapped page is read-only which makes using
377 * __sync_val_compare_and_swap() problematic. However, snapshot mode expects
378 * the buffer is not updated while the snapshot is made (e.g. Intel PT disables
379 * the event) so there is not a race anyway.
380 */
381static inline u64 auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap *mm)
382{
383 struct perf_event_mmap_page *pc = mm->userpg;
384 u64 head = READ_ONCE(pc->aux_head);
385
386 /* Ensure all reads are done after we read the head */
387 rmb();
388 return head;
389}
390
391static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm)
392{
393 struct perf_event_mmap_page *pc = mm->userpg;
394#if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
395 u64 head = READ_ONCE(pc->aux_head);
396#else
397 u64 head = __sync_val_compare_and_swap(&pc->aux_head, 0, 0);
398#endif
399
400 /* Ensure all reads are done after we read the head */
401 rmb();
402 return head;
403}
404
405static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail)
406{
407 struct perf_event_mmap_page *pc = mm->userpg;
408#if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
409 u64 old_tail;
410#endif
411
412 /* Ensure all reads are done before we write the tail out */
413 mb();
414#if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
415 pc->aux_tail = tail;
416#else
417 do {
418 old_tail = __sync_val_compare_and_swap(&pc->aux_tail, 0, 0);
419 } while (!__sync_bool_compare_and_swap(&pc->aux_tail, old_tail, tail));
420#endif
421}
422
423int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
424 struct auxtrace_mmap_params *mp,
425 void *userpg, int fd);
426void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
427void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
428 off_t auxtrace_offset,
429 unsigned int auxtrace_pages,
430 bool auxtrace_overwrite);
431void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
432 struct perf_evlist *evlist, int idx,
433 bool per_cpu);
434
435typedef int (*process_auxtrace_t)(struct perf_tool *tool,
436 union perf_event *event, void *data1,
437 size_t len1, void *data2, size_t len2);
438
439int auxtrace_mmap__read(struct auxtrace_mmap *mm, struct auxtrace_record *itr,
440 struct perf_tool *tool, process_auxtrace_t fn);
441
442int auxtrace_mmap__read_snapshot(struct auxtrace_mmap *mm,
443 struct auxtrace_record *itr,
444 struct perf_tool *tool, process_auxtrace_t fn,
445 size_t snapshot_size);
446
447int auxtrace_queues__init(struct auxtrace_queues *queues);
448int auxtrace_queues__add_event(struct auxtrace_queues *queues,
449 struct perf_session *session,
450 union perf_event *event, off_t data_offset,
451 struct auxtrace_buffer **buffer_ptr);
452void auxtrace_queues__free(struct auxtrace_queues *queues);
453int auxtrace_queues__process_index(struct auxtrace_queues *queues,
454 struct perf_session *session);
455struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
456 struct auxtrace_buffer *buffer);
457void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd);
458void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer);
459void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer);
460void auxtrace_buffer__free(struct auxtrace_buffer *buffer);
461
462int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
463 u64 ordinal);
464void auxtrace_heap__pop(struct auxtrace_heap *heap);
465void auxtrace_heap__free(struct auxtrace_heap *heap);
466
467struct auxtrace_cache_entry {
468 struct hlist_node hash;
469 u32 key;
470};
471
472struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
473 unsigned int limit_percent);
474void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache);
475void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c);
476void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry);
477int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
478 struct auxtrace_cache_entry *entry);
479void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key);
480
481struct auxtrace_record *auxtrace_record__init(struct perf_evlist *evlist,
482 int *err);
483
484int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
485 struct record_opts *opts,
486 const char *str);
487int auxtrace_record__options(struct auxtrace_record *itr,
488 struct perf_evlist *evlist,
489 struct record_opts *opts);
490size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
491 struct perf_evlist *evlist);
492int auxtrace_record__info_fill(struct auxtrace_record *itr,
493 struct perf_session *session,
494 struct auxtrace_info_event *auxtrace_info,
495 size_t priv_size);
496void auxtrace_record__free(struct auxtrace_record *itr);
497int auxtrace_record__snapshot_start(struct auxtrace_record *itr);
498int auxtrace_record__snapshot_finish(struct auxtrace_record *itr);
499int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
500 struct auxtrace_mmap *mm,
501 unsigned char *data, u64 *head, u64 *old);
502u64 auxtrace_record__reference(struct auxtrace_record *itr);
503
504int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event,
505 off_t file_offset);
506int auxtrace_index__write(int fd, struct list_head *head);
507int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
508 bool needs_swap);
509void auxtrace_index__free(struct list_head *head);
510
511void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type,
512 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
513 const char *msg);
514
515int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
516 struct perf_tool *tool,
517 struct perf_session *session,
518 perf_event__handler_t process);
519int perf_event__process_auxtrace_info(struct perf_tool *tool,
520 union perf_event *event,
521 struct perf_session *session);
522s64 perf_event__process_auxtrace(struct perf_tool *tool,
523 union perf_event *event,
524 struct perf_session *session);
525int perf_event__process_auxtrace_error(struct perf_tool *tool,
526 union perf_event *event,
527 struct perf_session *session);
528int itrace_parse_synth_opts(const struct option *opt, const char *str,
529 int unset);
530void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts);
531
532size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp);
533void perf_session__auxtrace_error_inc(struct perf_session *session,
534 union perf_event *event);
535void events_stats__auxtrace_error_warn(const struct events_stats *stats);
536
537void addr_filters__init(struct addr_filters *filts);
538void addr_filters__exit(struct addr_filters *filts);
539int addr_filters__parse_bare_filter(struct addr_filters *filts,
540 const char *filter);
541int auxtrace_parse_filters(struct perf_evlist *evlist);
542
543static inline int auxtrace__process_event(struct perf_session *session,
544 union perf_event *event,
545 struct perf_sample *sample,
546 struct perf_tool *tool)
547{
548 if (!session->auxtrace)
549 return 0;
550
551 return session->auxtrace->process_event(session, event, sample, tool);
552}
553
554static inline int auxtrace__flush_events(struct perf_session *session,
555 struct perf_tool *tool)
556{
557 if (!session->auxtrace)
558 return 0;
559
560 return session->auxtrace->flush_events(session, tool);
561}
562
563static inline void auxtrace__free_events(struct perf_session *session)
564{
565 if (!session->auxtrace)
566 return;
567
568 return session->auxtrace->free_events(session);
569}
570
571static inline void auxtrace__free(struct perf_session *session)
572{
573 if (!session->auxtrace)
574 return;
575
576 return session->auxtrace->free(session);
577}
578
579#else
580
581static inline struct auxtrace_record *
582auxtrace_record__init(struct perf_evlist *evlist __maybe_unused,
583 int *err)
584{
585 *err = 0;
586 return NULL;
587}
588
589static inline
590void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused)
591{
592}
593
594static inline int
595perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr __maybe_unused,
596 struct perf_tool *tool __maybe_unused,
597 struct perf_session *session __maybe_unused,
598 perf_event__handler_t process __maybe_unused)
599{
600 return -EINVAL;
601}
602
603static inline
604int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused,
605 struct perf_evlist *evlist __maybe_unused,
606 struct record_opts *opts __maybe_unused)
607{
608 return 0;
609}
610
611#define perf_event__process_auxtrace_info 0
612#define perf_event__process_auxtrace 0
613#define perf_event__process_auxtrace_error 0
614
615static inline
616void perf_session__auxtrace_error_inc(struct perf_session *session
617 __maybe_unused,
618 union perf_event *event
619 __maybe_unused)
620{
621}
622
623static inline
624void events_stats__auxtrace_error_warn(const struct events_stats *stats
625 __maybe_unused)
626{
627}
628
629static inline
630int itrace_parse_synth_opts(const struct option *opt __maybe_unused,
631 const char *str __maybe_unused,
632 int unset __maybe_unused)
633{
634 pr_err("AUX area tracing not supported\n");
635 return -EINVAL;
636}
637
638static inline
639int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused,
640 struct record_opts *opts __maybe_unused,
641 const char *str)
642{
643 if (!str)
644 return 0;
645 pr_err("AUX area tracing not supported\n");
646 return -EINVAL;
647}
648
649static inline
650int auxtrace__process_event(struct perf_session *session __maybe_unused,
651 union perf_event *event __maybe_unused,
652 struct perf_sample *sample __maybe_unused,
653 struct perf_tool *tool __maybe_unused)
654{
655 return 0;
656}
657
658static inline
659int auxtrace__flush_events(struct perf_session *session __maybe_unused,
660 struct perf_tool *tool __maybe_unused)
661{
662 return 0;
663}
664
665static inline
666void auxtrace__free_events(struct perf_session *session __maybe_unused)
667{
668}
669
670static inline
671void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused)
672{
673}
674
675static inline
676void auxtrace__free(struct perf_session *session __maybe_unused)
677{
678}
679
680static inline
681int auxtrace_index__write(int fd __maybe_unused,
682 struct list_head *head __maybe_unused)
683{
684 return -EINVAL;
685}
686
687static inline
688int auxtrace_index__process(int fd __maybe_unused,
689 u64 size __maybe_unused,
690 struct perf_session *session __maybe_unused,
691 bool needs_swap __maybe_unused)
692{
693 return -EINVAL;
694}
695
696static inline
697void auxtrace_index__free(struct list_head *head __maybe_unused)
698{
699}
700
701static inline
702int auxtrace_parse_filters(struct perf_evlist *evlist __maybe_unused)
703{
704 return 0;
705}
706
707int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
708 struct auxtrace_mmap_params *mp,
709 void *userpg, int fd);
710void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
711void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
712 off_t auxtrace_offset,
713 unsigned int auxtrace_pages,
714 bool auxtrace_overwrite);
715void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
716 struct perf_evlist *evlist, int idx,
717 bool per_cpu);
718
719#endif
720
721#endif