211 lines · c
1/* SPDX-License-Identifier: GPL-2.0 */2#ifndef __PERF_SESSION_H3#define __PERF_SESSION_H4 5#include "trace-event.h"6#include "event.h"7#include "header.h"8#include "machine.h"9#include "data.h"10#include "ordered-events.h"11#include "util/compress.h"12#include <linux/kernel.h>13#include <linux/rbtree.h>14#include <linux/perf_event.h>15 16struct ip_callchain;17struct symbol;18struct thread;19 20struct auxtrace;21struct itrace_synth_opts;22 23struct decomp_data {24 struct decomp *decomp;25 struct decomp *decomp_last;26 struct zstd_data *zstd_decomp;27};28 29/**30 * struct perf_session- A Perf session holds the main state when the program is31 * working with live perf events or reading data from an input file.32 *33 * The rough organization of a perf_session is:34 * ```35 * +--------------+ +-----------+ +------------+36 * | Session |1..* ----->| Machine |1..* ----->| Thread |37 * +--------------+ +-----------+ +------------+38 * ```39 */40struct perf_session {41 /**42 * @header: The read version of a perf_file_header, or captures global43 * information from a live session.44 */45 struct perf_header header;46 /** @machines: Machines within the session a host and 0 or more guests. */47 struct machines machines;48 /** @evlist: List of evsels/events of the session. */49 struct evlist *evlist;50 /** @auxtrace: callbacks to allow AUX area data decoding. */51 const struct auxtrace *auxtrace;52 /** @itrace_synth_opts: AUX area tracing synthesis options. */53 struct itrace_synth_opts *itrace_synth_opts;54 /** @auxtrace_index: index of AUX area tracing events within a perf.data file. */55 struct list_head auxtrace_index;56#ifdef HAVE_LIBTRACEEVENT57 /** @tevent: handles for libtraceevent and plugins. */58 struct trace_event tevent;59#endif60 /** @time_conv: Holds contents of last PERF_RECORD_TIME_CONV event. */61 struct perf_record_time_conv time_conv;62 /** @trace_event_repipe: When set causes read trace events to be written to stdout. */63 bool trace_event_repipe;64 /**65 * @one_mmap: The reader will use a single mmap by default. There may be66 * multiple data files in particular for aux events. If this is true67 * then the single big mmap for the data file can be assumed.68 */69 bool one_mmap;70 /** @one_mmap_addr: Address of initial perf data file reader mmap. */71 void *one_mmap_addr;72 /** @one_mmap_offset: File offset in perf.data file when mapped. */73 u64 one_mmap_offset;74 /** @ordered_events: Used to turn unordered events into ordered ones. */75 struct ordered_events ordered_events;76 /** @data: Optional perf data file being read from. */77 struct perf_data *data;78 /** @tool: callbacks for event handling. */79 const struct perf_tool *tool;80 /**81 * @bytes_transferred: Used by perf record to count written bytes before82 * compression.83 */84 u64 bytes_transferred;85 /**86 * @bytes_compressed: Used by perf record to count written bytes after87 * compression.88 */89 u64 bytes_compressed;90 /** @zstd_data: Owner of global compression state, buffers, etc. */91 struct zstd_data zstd_data;92 struct decomp_data decomp_data;93 struct decomp_data *active_decomp;94};95 96struct decomp {97 struct decomp *next;98 u64 file_pos;99 const char *file_path;100 size_t mmap_len;101 u64 head;102 size_t size;103 char data[];104};105 106struct perf_tool;107 108struct perf_session *__perf_session__new(struct perf_data *data,109 struct perf_tool *tool,110 bool trace_event_repipe);111 112static inline struct perf_session *perf_session__new(struct perf_data *data,113 struct perf_tool *tool)114{115 return __perf_session__new(data, tool, /*trace_event_repipe=*/false);116}117 118void perf_session__delete(struct perf_session *session);119 120void perf_event_header__bswap(struct perf_event_header *hdr);121 122int perf_session__peek_event(struct perf_session *session, off_t file_offset,123 void *buf, size_t buf_sz,124 union perf_event **event_ptr,125 struct perf_sample *sample);126typedef int (*peek_events_cb_t)(struct perf_session *session,127 union perf_event *event, u64 offset,128 void *data);129int perf_session__peek_events(struct perf_session *session, u64 offset,130 u64 size, peek_events_cb_t cb, void *data);131 132int perf_session__process_events(struct perf_session *session);133 134int perf_session__queue_event(struct perf_session *s, union perf_event *event,135 u64 timestamp, u64 file_offset, const char *file_path);136 137int perf_session__resolve_callchain(struct perf_session *session,138 struct evsel *evsel,139 struct thread *thread,140 struct ip_callchain *chain,141 struct symbol **parent);142 143bool perf_session__has_traces(struct perf_session *session, const char *msg);144 145void perf_event__attr_swap(struct perf_event_attr *attr);146 147int perf_session__create_kernel_maps(struct perf_session *session);148 149void perf_session__set_id_hdr_size(struct perf_session *session);150 151static inline152struct machine *perf_session__find_machine(struct perf_session *session, pid_t pid)153{154 return machines__find(&session->machines, pid);155}156 157static inline158struct machine *perf_session__findnew_machine(struct perf_session *session, pid_t pid)159{160 return machines__findnew(&session->machines, pid);161}162 163struct thread *perf_session__findnew(struct perf_session *session, pid_t pid);164int perf_session__register_idle_thread(struct perf_session *session);165 166size_t perf_session__fprintf(struct perf_session *session, FILE *fp);167 168size_t perf_session__fprintf_dsos(struct perf_session *session, FILE *fp);169 170size_t perf_session__fprintf_dsos_buildid(struct perf_session *session, FILE *fp,171 bool (fn)(struct dso *dso, int parm), int parm);172 173size_t perf_session__fprintf_nr_events(struct perf_session *session, FILE *fp);174 175void perf_session__dump_kmaps(struct perf_session *session);176 177struct evsel *perf_session__find_first_evtype(struct perf_session *session,178 unsigned int type);179 180int perf_session__cpu_bitmap(struct perf_session *session,181 const char *cpu_list, unsigned long *cpu_bitmap);182 183void perf_session__fprintf_info(struct perf_session *s, FILE *fp, bool full);184 185struct evsel_str_handler;186 187#define perf_session__set_tracepoints_handlers(session, array) \188 __evlist__set_tracepoints_handlers(session->evlist, array, ARRAY_SIZE(array))189 190extern volatile int session_done;191 192#define session_done() READ_ONCE(session_done)193 194int perf_session__deliver_synth_event(struct perf_session *session,195 union perf_event *event,196 struct perf_sample *sample);197int perf_session__deliver_synth_attr_event(struct perf_session *session,198 const struct perf_event_attr *attr,199 u64 id);200 201int perf_session__dsos_hit_all(struct perf_session *session);202 203int perf_event__process_id_index(struct perf_session *session,204 union perf_event *event);205 206int perf_event__process_finished_round(const struct perf_tool *tool,207 union perf_event *event,208 struct ordered_events *oe);209 210#endif /* __PERF_SESSION_H */211