/* * auxtrace.h: AUX area trace support * Copyright (c) 2013-2015, Intel Corporation. * * This program is free software; you can redistribute it and/or modify it * under the terms and conditions of the GNU General Public License, * version 2, as published by the Free Software Foundation. * * This program is distributed in the hope it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * */ #ifndef __PERF_AUXTRACE_H #define __PERF_AUXTRACE_H #include #include #include #include #include #include #include "../perf.h" #include "event.h" #include "session.h" #include "debug.h" union perf_event; struct perf_session; struct perf_evlist; struct perf_tool; struct option; struct record_opts; struct auxtrace_info_event; struct events_stats; enum auxtrace_type { PERF_AUXTRACE_UNKNOWN, }; enum itrace_period_type { PERF_ITRACE_PERIOD_INSTRUCTIONS, PERF_ITRACE_PERIOD_TICKS, PERF_ITRACE_PERIOD_NANOSECS, }; /** * struct itrace_synth_opts - AUX area tracing synthesis options. * @set: indicates whether or not options have been set * @inject: indicates the event (not just the sample) must be fully synthesized * because 'perf inject' will write it out * @instructions: whether to synthesize 'instructions' events * @branches: whether to synthesize 'branches' events * @transactions: whether to synthesize events for transactions * @errors: whether to synthesize decoder error events * @dont_decode: whether to skip decoding entirely * @log: write a decoding log * @calls: limit branch samples to calls (can be combined with @returns) * @returns: limit branch samples to returns (can be combined with @calls) * @callchain: add callchain to 'instructions' events * @callchain_sz: maximum callchain size * @period: 'instructions' events period * @period_type: 'instructions' events period type */ struct itrace_synth_opts { bool set; bool inject; bool instructions; bool branches; bool transactions; bool errors; bool dont_decode; bool log; bool calls; bool returns; bool callchain; unsigned int callchain_sz; unsigned long long period; enum itrace_period_type period_type; }; /** * struct auxtrace_index_entry - indexes a AUX area tracing event within a * perf.data file. * @file_offset: offset within the perf.data file * @sz: size of the event */ struct auxtrace_index_entry { u64 file_offset; u64 sz; }; #define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256 /** * struct auxtrace_index - index of AUX area tracing events within a perf.data * file. * @list: linking a number of arrays of entries * @nr: number of entries * @entries: array of entries */ struct auxtrace_index { struct list_head list; size_t nr; struct auxtrace_index_entry entries[PERF_AUXTRACE_INDEX_ENTRY_COUNT]; }; /** * struct auxtrace - session callbacks to allow AUX area data decoding. * @process_event: lets the decoder see all session events * @flush_events: process any remaining data * @free_events: free resources associated with event processing * @free: free resources associated with the session */ struct auxtrace { int (*process_event)(struct perf_session *session, union perf_event *event, struct perf_sample *sample, struct perf_tool *tool); int (*process_auxtrace_event)(struct perf_session *session, union perf_event *event, struct perf_tool *tool); int (*flush_events)(struct perf_session *session, struct perf_tool *tool); void (*free_events)(struct perf_session *session); void (*free)(struct perf_session *session); }; /** * struct auxtrace_buffer - a buffer containing AUX area tracing data. * @list: buffers are queued in a list held by struct auxtrace_queue * @size: size of the buffer in bytes * @pid: in per-thread mode, the pid this buffer is associated with * @tid: in per-thread mode, the tid this buffer is associated with * @cpu: in per-cpu mode, the cpu this buffer is associated with * @data: actual buffer data (can be null if the data has not been loaded) * @data_offset: file offset at which the buffer can be read * @mmap_addr: mmap address at which the buffer can be read * @mmap_size: size of the mmap at @mmap_addr * @data_needs_freeing: @data was malloc'd so free it when it is no longer * needed * @consecutive: the original data was split up and this buffer is consecutive * to the previous buffer * @offset: offset as determined by aux_head / aux_tail members of struct * perf_event_mmap_page * @reference: an implementation-specific reference determined when the data is * recorded * @buffer_nr: used to number each buffer * @use_size: implementation actually only uses this number of bytes * @use_data: implementation actually only uses data starting at this address */ struct auxtrace_buffer { struct list_head list; size_t size; pid_t pid; pid_t tid; int cpu; void *data; off_t data_offset; void *mmap_addr; size_t mmap_size; bool data_needs_freeing; bool consecutive; u64 offset; u64 reference; u64 buffer_nr; size_t use_size; void *use_data; }; /** * struct auxtrace_queue - a queue of AUX area tracing data buffers. * @head: head of buffer list * @tid: in per-thread mode, the tid this queue is associated with * @cpu: in per-cpu mode, the cpu this queue is associated with * @set: %true once this queue has been dedicated to a specific thread or cpu * @priv: implementation-specific data */ struct auxtrace_queue { struct list_head head; pid_t tid; int cpu; bool set; void *priv; }; /** * struct auxtrace_queues - an array of AUX area tracing queues. * @queue_array: array of queues * @nr_queues: number of queues * @new_data: set whenever new data is queued * @populated: queues have been fully populated using the auxtrace_index * @next_buffer_nr: used to number each buffer */ struct auxtrace_queues { struct auxtrace_queue *queue_array; unsigned int nr_queues; bool new_data; bool populated; u64 next_buffer_nr; }; /** * struct auxtrace_heap_item - element of struct auxtrace_heap. * @queue_nr: queue number * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected * to be a timestamp */ struct auxtrace_heap_item { unsigned int queue_nr; u64 ordinal; }; /** * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues. * @heap_array: the heap * @heap_cnt: the number of elements in the heap * @heap_sz: maximum number of elements (grows as needed) */ struct auxtrace_heap { struct auxtrace_heap_item *heap_array; unsigned int heap_cnt; unsigned int heap_sz; }; /** * struct auxtrace_mmap - records an mmap of the auxtrace buffer. * @base: address of mapped area * @userpg: pointer to buffer's perf_event_mmap_page * @mask: %0 if @len is not a power of two, otherwise (@len - %1) * @len: size of mapped area * @prev: previous aux_head * @idx: index of this mmap * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu * mmap) otherwise %0 * @cpu: cpu number for a per-cpu mmap otherwise %-1 */ struct auxtrace_mmap { void *base; void *userpg; size_t mask; size_t len; u64 prev; int idx; pid_t tid; int cpu; }; /** * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap. * @mask: %0 if @len is not a power of two, otherwise (@len - %1) * @offset: file offset of mapped area * @len: size of mapped area * @prot: mmap memory protection * @idx: index of this mmap * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu * mmap) otherwise %0 * @cpu: cpu number for a per-cpu mmap otherwise %-1 */ struct auxtrace_mmap_params { size_t mask; off_t offset; size_t len; int prot; int idx; pid_t tid; int cpu; }; /** * struct auxtrace_record - callbacks for recording AUX area data. * @recording_options: validate and process recording options * @info_priv_size: return the size of the private data in auxtrace_info_event * @info_fill: fill-in the private data in auxtrace_info_event * @free: free this auxtrace record structure * @snapshot_start: starting a snapshot * @snapshot_finish: finishing a snapshot * @find_snapshot: find data to snapshot within auxtrace mmap * @parse_snapshot_options: parse snapshot options * @reference: provide a 64-bit reference number for auxtrace_event * @read_finish: called after reading from an auxtrace mmap */ struct auxtrace_record { int (*recording_options)(struct auxtrace_record *itr, struct perf_evlist *evlist, struct record_opts *opts); size_t (*info_priv_size)(struct auxtrace_record *itr); int (*info_fill)(struct auxtrace_record *itr, struct perf_session *session, struct auxtrace_info_event *auxtrace_info, size_t priv_size); void (*free)(struct auxtrace_record *itr); int (*snapshot_start)(struct auxtrace_record *itr); int (*snapshot_finish)(struct auxtrace_record *itr); int (*find_snapshot)(struct auxtrace_record *itr, int idx, struct auxtrace_mmap *mm, unsigned char *data, u64 *head, u64 *old); int (*parse_snapshot_options)(struct auxtrace_record *itr, struct record_opts *opts, const char *str); u64 (*reference)(struct auxtrace_record *itr); int (*read_finish)(struct auxtrace_record *itr, int idx); }; #ifdef HAVE_AUXTRACE_SUPPORT /* * In snapshot mode the mmapped page is read-only which makes using * __sync_val_compare_and_swap() problematic. However, snapshot mode expects * the buffer is not updated while the snapshot is made (e.g. Intel PT disables * the event) so there is not a race anyway. */ static inline u64 auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap *mm) { struct perf_event_mmap_page *pc = mm->userpg; u64 head = ACCESS_ONCE(pc->aux_head); /* Ensure all reads are done after we read the head */ rmb(); return head; } static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm) { struct perf_event_mmap_page *pc = mm->userpg; #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT) u64 head = ACCESS_ONCE(pc->aux_head); #else u64 head = __sync_val_compare_and_swap(&pc->aux_head, 0, 0); #endif /* Ensure all reads are done after we read the head */ rmb(); return head; } static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail) { struct perf_event_mmap_page *pc = mm->userpg; #if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT) u64 old_tail; #endif /* Ensure all reads are done before we write the tail out */ mb(); #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT) pc->aux_tail = tail; #else do { old_tail = __sync_val_compare_and_swap(&pc->aux_tail, 0, 0); } while (!__sync_bool_compare_and_swap(&pc->aux_tail, old_tail, tail)); #endif } int auxtrace_mmap__mmap(struct auxtrace_mmap *mm, struct auxtrace_mmap_params *mp, void *userpg, int fd); void auxtrace_mmap__munmap(struct auxtrace_mmap *mm); void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp, off_t auxtrace_offset, unsigned int auxtrace_pages, bool auxtrace_overwrite); void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp, struct perf_evlist *evlist, int idx, bool per_cpu); typedef int (*process_auxtrace_t)(struct perf_tool *tool, union perf_event *event, void *data1, size_t len1, void *data2, size_t len2); int auxtrace_mmap__read(struct auxtrace_mmap *mm, struct auxtrace_record *itr, struct perf_tool *tool, process_auxtrace_t fn); int auxtrace_mmap__read_snapshot(struct auxtrace_mmap *mm, struct auxtrace_record *itr, struct perf_tool *tool, process_auxtrace_t fn, size_t snapshot_size); int auxtrace_queues__init(struct auxtrace_queues *queues); int auxtrace_queues__add_event(struct auxtrace_queues *queues, struct perf_session *session, union perf_event *event, off_t data_offset, struct auxtrace_buffer **buffer_ptr); void auxtrace_queues__free(struct auxtrace_queues *queues); int auxtrace_queues__process_index(struct auxtrace_queues *queues, struct perf_session *session); struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue, struct auxtrace_buffer *buffer); void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd); void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer); void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer); void auxtrace_buffer__free(struct auxtrace_buffer *buffer); int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr, u64 ordinal); void auxtrace_heap__pop(struct auxtrace_heap *heap); void auxtrace_heap__free(struct auxtrace_heap *heap); struct auxtrace_cache_entry { struct hlist_node hash; u32 key; }; struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size, unsigned int limit_percent); void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache); void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c); void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry); int auxtrace_cache__add(struct auxtrace_cache *c, u32 key, struct auxtrace_cache_entry *entry); void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key); struct auxtrace_record *auxtrace_record__init(struct perf_evlist *evlist, int *err); int auxtrace_parse_snapshot_options(struct auxtrace_record *itr, struct record_opts *opts, const char *str); int auxtrace_record__options(struct auxtrace_record *itr, struct perf_evlist *evlist, struct record_opts *opts); size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr); int auxtrace_record__info_fill(struct auxtrace_record *itr, struct perf_session *session, struct auxtrace_info_event *auxtrace_info, size_t priv_size); void auxtrace_record__free(struct auxtrace_record *itr); int auxtrace_record__snapshot_start(struct auxtrace_record *itr); int auxtrace_record__snapshot_finish(struct auxtrace_record *itr); int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx, struct auxtrace_mmap *mm, unsigned char *data, u64 *head, u64 *old); u64 auxtrace_record__reference(struct auxtrace_record *itr); int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event, off_t file_offset); int auxtrace_index__write(int fd, struct list_head *head); int auxtrace_index__process(int fd, u64 size, struct perf_session *session, bool needs_swap); void auxtrace_index__free(struct list_head *head); void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type, int code, int cpu, pid_t pid, pid_t tid, u64 ip, const char *msg); int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr, struct perf_tool *tool, struct perf_session *session, perf_event__handler_t process); int perf_event__process_auxtrace_info(struct perf_tool *tool, union perf_event *event, struct perf_session *session); s64 perf_event__process_auxtrace(struct perf_tool *tool, union perf_event *event, struct perf_session *session); int perf_event__process_auxtrace_error(struct perf_tool *tool, union perf_event *event, struct perf_session *session); int itrace_parse_synth_opts(const struct option *opt, const char *str, int unset); void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts); size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp); void perf_session__auxtrace_error_inc(struct perf_session *session, union perf_event *event); void events_stats__auxtrace_error_warn(const struct events_stats *stats); static inline int auxtrace__process_event(struct perf_session *session, union perf_event *event, struct perf_sample *sample, struct perf_tool *tool) { if (!session->auxtrace) return 0; return session->auxtrace->process_event(session, event, sample, tool); } static inline int auxtrace__flush_events(struct perf_session *session, struct perf_tool *tool) { if (!session->auxtrace) return 0; return session->auxtrace->flush_events(session, tool); } static inline void auxtrace__free_events(struct perf_session *session) { if (!session->auxtrace) return; return session->auxtrace->free_events(session); } static inline void auxtrace__free(struct perf_session *session) { if (!session->auxtrace) return; return session->auxtrace->free(session); } #else static inline struct auxtrace_record * auxtrace_record__init(struct perf_evlist *evlist __maybe_unused, int *err __maybe_unused) { *err = 0; return NULL; } static inline void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused) { } static inline int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr __maybe_unused, struct perf_tool *tool __maybe_unused, struct perf_session *session __maybe_unused, perf_event__handler_t process __maybe_unused) { return -EINVAL; } static inline int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused, struct perf_evlist *evlist __maybe_unused, struct record_opts *opts __maybe_unused) { return 0; } #define perf_event__process_auxtrace_info 0 #define perf_event__process_auxtrace 0 #define perf_event__process_auxtrace_error 0 static inline void perf_session__auxtrace_error_inc(struct perf_session *session __maybe_unused, union perf_event *event __maybe_unused) { } static inline void events_stats__auxtrace_error_warn(const struct events_stats *stats __maybe_unused) { } static inline int itrace_parse_synth_opts(const struct option *opt __maybe_unused, const char *str __maybe_unused, int unset __maybe_unused) { pr_err("AUX area tracing not supported\n"); return -EINVAL; } static inline int auxtrace__process_event(struct perf_session *session __maybe_unused, union perf_event *event __maybe_unused, struct perf_sample *sample __maybe_unused, struct perf_tool *tool __maybe_unused) { return 0; } static inline int auxtrace__flush_events(struct perf_session *session __maybe_unused, struct perf_tool *tool __maybe_unused) { return 0; } static inline void auxtrace__free_events(struct perf_session *session __maybe_unused) { } static inline void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused) { } static inline void auxtrace__free(struct perf_session *session __maybe_unused) { } static inline int auxtrace_index__write(int fd __maybe_unused, struct list_head *head __maybe_unused) { return -EINVAL; } static inline int auxtrace_index__process(int fd __maybe_unused, u64 size __maybe_unused, struct perf_session *session __maybe_unused, bool needs_swap __maybe_unused) { return -EINVAL; } static inline void auxtrace_index__free(struct list_head *head __maybe_unused) { } int auxtrace_mmap__mmap(struct auxtrace_mmap *mm, struct auxtrace_mmap_params *mp, void *userpg, int fd); void auxtrace_mmap__munmap(struct auxtrace_mmap *mm); void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp, off_t auxtrace_offset, unsigned int auxtrace_pages, bool auxtrace_overwrite); void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp, struct perf_evlist *evlist, int idx, bool per_cpu); #endif #endif