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
16 #ifndef __PERF_AUXTRACE_H
17 #define __PERF_AUXTRACE_H
19 #include <sys/types.h>
22 #include <linux/list.h>
23 #include <linux/perf_event.h>
24 #include <linux/types.h>
37 struct auxtrace_info_event;
41 PERF_AUXTRACE_UNKNOWN,
42 PERF_AUXTRACE_INTEL_PT,
43 PERF_AUXTRACE_INTEL_BTS,
46 enum itrace_period_type {
47 PERF_ITRACE_PERIOD_INSTRUCTIONS,
48 PERF_ITRACE_PERIOD_TICKS,
49 PERF_ITRACE_PERIOD_NANOSECS,
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 * @callchain_sz: maximum callchain size
67 * @period: 'instructions' events period
68 * @period_type: 'instructions' events period type
70 struct itrace_synth_opts {
82 unsigned int callchain_sz;
83 unsigned long long period;
84 enum itrace_period_type period_type;
88 * struct auxtrace_index_entry - indexes a AUX area tracing event within a
90 * @file_offset: offset within the perf.data file
91 * @sz: size of the event
93 struct auxtrace_index_entry {
98 #define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
101 * struct auxtrace_index - index of AUX area tracing events within a perf.data
103 * @list: linking a number of arrays of entries
104 * @nr: number of entries
105 * @entries: array of entries
107 struct auxtrace_index {
108 struct list_head list;
110 struct auxtrace_index_entry entries[PERF_AUXTRACE_INDEX_ENTRY_COUNT];
114 * struct auxtrace - session callbacks to allow AUX area data decoding.
115 * @process_event: lets the decoder see all session events
116 * @flush_events: process any remaining data
117 * @free_events: free resources associated with event processing
118 * @free: free resources associated with the session
121 int (*process_event)(struct perf_session *session,
122 union perf_event *event,
123 struct perf_sample *sample,
124 struct perf_tool *tool);
125 int (*process_auxtrace_event)(struct perf_session *session,
126 union perf_event *event,
127 struct perf_tool *tool);
128 int (*flush_events)(struct perf_session *session,
129 struct perf_tool *tool);
130 void (*free_events)(struct perf_session *session);
131 void (*free)(struct perf_session *session);
135 * struct auxtrace_buffer - a buffer containing AUX area tracing data.
136 * @list: buffers are queued in a list held by struct auxtrace_queue
137 * @size: size of the buffer in bytes
138 * @pid: in per-thread mode, the pid this buffer is associated with
139 * @tid: in per-thread mode, the tid this buffer is associated with
140 * @cpu: in per-cpu mode, the cpu this buffer is associated with
141 * @data: actual buffer data (can be null if the data has not been loaded)
142 * @data_offset: file offset at which the buffer can be read
143 * @mmap_addr: mmap address at which the buffer can be read
144 * @mmap_size: size of the mmap at @mmap_addr
145 * @data_needs_freeing: @data was malloc'd so free it when it is no longer
147 * @consecutive: the original data was split up and this buffer is consecutive
148 * to the previous buffer
149 * @offset: offset as determined by aux_head / aux_tail members of struct
150 * perf_event_mmap_page
151 * @reference: an implementation-specific reference determined when the data is
153 * @buffer_nr: used to number each buffer
154 * @use_size: implementation actually only uses this number of bytes
155 * @use_data: implementation actually only uses data starting at this address
157 struct auxtrace_buffer {
158 struct list_head list;
167 bool data_needs_freeing;
177 * struct auxtrace_queue - a queue of AUX area tracing data buffers.
178 * @head: head of buffer list
179 * @tid: in per-thread mode, the tid this queue is associated with
180 * @cpu: in per-cpu mode, the cpu this queue is associated with
181 * @set: %true once this queue has been dedicated to a specific thread or cpu
182 * @priv: implementation-specific data
184 struct auxtrace_queue {
185 struct list_head head;
193 * struct auxtrace_queues - an array of AUX area tracing queues.
194 * @queue_array: array of queues
195 * @nr_queues: number of queues
196 * @new_data: set whenever new data is queued
197 * @populated: queues have been fully populated using the auxtrace_index
198 * @next_buffer_nr: used to number each buffer
200 struct auxtrace_queues {
201 struct auxtrace_queue *queue_array;
202 unsigned int nr_queues;
209 * struct auxtrace_heap_item - element of struct auxtrace_heap.
210 * @queue_nr: queue number
211 * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
214 struct auxtrace_heap_item {
215 unsigned int queue_nr;
220 * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
221 * @heap_array: the heap
222 * @heap_cnt: the number of elements in the heap
223 * @heap_sz: maximum number of elements (grows as needed)
225 struct auxtrace_heap {
226 struct auxtrace_heap_item *heap_array;
227 unsigned int heap_cnt;
228 unsigned int heap_sz;
232 * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
233 * @base: address of mapped area
234 * @userpg: pointer to buffer's perf_event_mmap_page
235 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
236 * @len: size of mapped area
237 * @prev: previous aux_head
238 * @idx: index of this mmap
239 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
241 * @cpu: cpu number for a per-cpu mmap otherwise %-1
243 struct auxtrace_mmap {
255 * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
256 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
257 * @offset: file offset of mapped area
258 * @len: size of mapped area
259 * @prot: mmap memory protection
260 * @idx: index of this mmap
261 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
263 * @cpu: cpu number for a per-cpu mmap otherwise %-1
265 struct auxtrace_mmap_params {
276 * struct auxtrace_record - callbacks for recording AUX area data.
277 * @recording_options: validate and process recording options
278 * @info_priv_size: return the size of the private data in auxtrace_info_event
279 * @info_fill: fill-in the private data in auxtrace_info_event
280 * @free: free this auxtrace record structure
281 * @snapshot_start: starting a snapshot
282 * @snapshot_finish: finishing a snapshot
283 * @find_snapshot: find data to snapshot within auxtrace mmap
284 * @parse_snapshot_options: parse snapshot options
285 * @reference: provide a 64-bit reference number for auxtrace_event
286 * @read_finish: called after reading from an auxtrace mmap
288 struct auxtrace_record {
289 int (*recording_options)(struct auxtrace_record *itr,
290 struct perf_evlist *evlist,
291 struct record_opts *opts);
292 size_t (*info_priv_size)(struct auxtrace_record *itr);
293 int (*info_fill)(struct auxtrace_record *itr,
294 struct perf_session *session,
295 struct auxtrace_info_event *auxtrace_info,
297 void (*free)(struct auxtrace_record *itr);
298 int (*snapshot_start)(struct auxtrace_record *itr);
299 int (*snapshot_finish)(struct auxtrace_record *itr);
300 int (*find_snapshot)(struct auxtrace_record *itr, int idx,
301 struct auxtrace_mmap *mm, unsigned char *data,
302 u64 *head, u64 *old);
303 int (*parse_snapshot_options)(struct auxtrace_record *itr,
304 struct record_opts *opts,
306 u64 (*reference)(struct auxtrace_record *itr);
307 int (*read_finish)(struct auxtrace_record *itr, int idx);
308 unsigned int alignment;
311 #ifdef HAVE_AUXTRACE_SUPPORT
314 * In snapshot mode the mmapped page is read-only which makes using
315 * __sync_val_compare_and_swap() problematic. However, snapshot mode expects
316 * the buffer is not updated while the snapshot is made (e.g. Intel PT disables
317 * the event) so there is not a race anyway.
319 static inline u64 auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap *mm)
321 struct perf_event_mmap_page *pc = mm->userpg;
322 u64 head = ACCESS_ONCE(pc->aux_head);
324 /* Ensure all reads are done after we read the head */
329 static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm)
331 struct perf_event_mmap_page *pc = mm->userpg;
332 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
333 u64 head = ACCESS_ONCE(pc->aux_head);
335 u64 head = __sync_val_compare_and_swap(&pc->aux_head, 0, 0);
338 /* Ensure all reads are done after we read the head */
343 static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail)
345 struct perf_event_mmap_page *pc = mm->userpg;
346 #if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
350 /* Ensure all reads are done before we write the tail out */
352 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
356 old_tail = __sync_val_compare_and_swap(&pc->aux_tail, 0, 0);
357 } while (!__sync_bool_compare_and_swap(&pc->aux_tail, old_tail, tail));
361 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
362 struct auxtrace_mmap_params *mp,
363 void *userpg, int fd);
364 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
365 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
366 off_t auxtrace_offset,
367 unsigned int auxtrace_pages,
368 bool auxtrace_overwrite);
369 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
370 struct perf_evlist *evlist, int idx,
373 typedef int (*process_auxtrace_t)(struct perf_tool *tool,
374 union perf_event *event, void *data1,
375 size_t len1, void *data2, size_t len2);
377 int auxtrace_mmap__read(struct auxtrace_mmap *mm, struct auxtrace_record *itr,
378 struct perf_tool *tool, process_auxtrace_t fn);
380 int auxtrace_mmap__read_snapshot(struct auxtrace_mmap *mm,
381 struct auxtrace_record *itr,
382 struct perf_tool *tool, process_auxtrace_t fn,
383 size_t snapshot_size);
385 int auxtrace_queues__init(struct auxtrace_queues *queues);
386 int auxtrace_queues__add_event(struct auxtrace_queues *queues,
387 struct perf_session *session,
388 union perf_event *event, off_t data_offset,
389 struct auxtrace_buffer **buffer_ptr);
390 void auxtrace_queues__free(struct auxtrace_queues *queues);
391 int auxtrace_queues__process_index(struct auxtrace_queues *queues,
392 struct perf_session *session);
393 struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
394 struct auxtrace_buffer *buffer);
395 void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd);
396 void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer);
397 void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer);
398 void auxtrace_buffer__free(struct auxtrace_buffer *buffer);
400 int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
402 void auxtrace_heap__pop(struct auxtrace_heap *heap);
403 void auxtrace_heap__free(struct auxtrace_heap *heap);
405 struct auxtrace_cache_entry {
406 struct hlist_node hash;
410 struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
411 unsigned int limit_percent);
412 void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache);
413 void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c);
414 void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry);
415 int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
416 struct auxtrace_cache_entry *entry);
417 void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key);
419 struct auxtrace_record *auxtrace_record__init(struct perf_evlist *evlist,
422 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
423 struct record_opts *opts,
425 int auxtrace_record__options(struct auxtrace_record *itr,
426 struct perf_evlist *evlist,
427 struct record_opts *opts);
428 size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr);
429 int auxtrace_record__info_fill(struct auxtrace_record *itr,
430 struct perf_session *session,
431 struct auxtrace_info_event *auxtrace_info,
433 void auxtrace_record__free(struct auxtrace_record *itr);
434 int auxtrace_record__snapshot_start(struct auxtrace_record *itr);
435 int auxtrace_record__snapshot_finish(struct auxtrace_record *itr);
436 int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
437 struct auxtrace_mmap *mm,
438 unsigned char *data, u64 *head, u64 *old);
439 u64 auxtrace_record__reference(struct auxtrace_record *itr);
441 int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event,
443 int auxtrace_index__write(int fd, struct list_head *head);
444 int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
446 void auxtrace_index__free(struct list_head *head);
448 void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type,
449 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
452 int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
453 struct perf_tool *tool,
454 struct perf_session *session,
455 perf_event__handler_t process);
456 int perf_event__process_auxtrace_info(struct perf_tool *tool,
457 union perf_event *event,
458 struct perf_session *session);
459 s64 perf_event__process_auxtrace(struct perf_tool *tool,
460 union perf_event *event,
461 struct perf_session *session);
462 int perf_event__process_auxtrace_error(struct perf_tool *tool,
463 union perf_event *event,
464 struct perf_session *session);
465 int itrace_parse_synth_opts(const struct option *opt, const char *str,
467 void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts);
469 size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp);
470 void perf_session__auxtrace_error_inc(struct perf_session *session,
471 union perf_event *event);
472 void events_stats__auxtrace_error_warn(const struct events_stats *stats);
474 static inline int auxtrace__process_event(struct perf_session *session,
475 union perf_event *event,
476 struct perf_sample *sample,
477 struct perf_tool *tool)
479 if (!session->auxtrace)
482 return session->auxtrace->process_event(session, event, sample, tool);
485 static inline int auxtrace__flush_events(struct perf_session *session,
486 struct perf_tool *tool)
488 if (!session->auxtrace)
491 return session->auxtrace->flush_events(session, tool);
494 static inline void auxtrace__free_events(struct perf_session *session)
496 if (!session->auxtrace)
499 return session->auxtrace->free_events(session);
502 static inline void auxtrace__free(struct perf_session *session)
504 if (!session->auxtrace)
507 return session->auxtrace->free(session);
512 static inline struct auxtrace_record *
513 auxtrace_record__init(struct perf_evlist *evlist __maybe_unused,
514 int *err __maybe_unused)
521 void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused)
526 perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr __maybe_unused,
527 struct perf_tool *tool __maybe_unused,
528 struct perf_session *session __maybe_unused,
529 perf_event__handler_t process __maybe_unused)
535 int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused,
536 struct perf_evlist *evlist __maybe_unused,
537 struct record_opts *opts __maybe_unused)
542 #define perf_event__process_auxtrace_info 0
543 #define perf_event__process_auxtrace 0
544 #define perf_event__process_auxtrace_error 0
547 void perf_session__auxtrace_error_inc(struct perf_session *session
549 union perf_event *event
555 void events_stats__auxtrace_error_warn(const struct events_stats *stats
561 int itrace_parse_synth_opts(const struct option *opt __maybe_unused,
562 const char *str __maybe_unused,
563 int unset __maybe_unused)
565 pr_err("AUX area tracing not supported\n");
570 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused,
571 struct record_opts *opts __maybe_unused,
576 pr_err("AUX area tracing not supported\n");
581 int auxtrace__process_event(struct perf_session *session __maybe_unused,
582 union perf_event *event __maybe_unused,
583 struct perf_sample *sample __maybe_unused,
584 struct perf_tool *tool __maybe_unused)
590 int auxtrace__flush_events(struct perf_session *session __maybe_unused,
591 struct perf_tool *tool __maybe_unused)
597 void auxtrace__free_events(struct perf_session *session __maybe_unused)
602 void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused)
607 void auxtrace__free(struct perf_session *session __maybe_unused)
612 int auxtrace_index__write(int fd __maybe_unused,
613 struct list_head *head __maybe_unused)
619 int auxtrace_index__process(int fd __maybe_unused,
620 u64 size __maybe_unused,
621 struct perf_session *session __maybe_unused,
622 bool needs_swap __maybe_unused)
628 void auxtrace_index__free(struct list_head *head __maybe_unused)
632 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
633 struct auxtrace_mmap_params *mp,
634 void *userpg, int fd);
635 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
636 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
637 off_t auxtrace_offset,
638 unsigned int auxtrace_pages,
639 bool auxtrace_overwrite);
640 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
641 struct perf_evlist *evlist, int idx,