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