1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __PERF_SESSION_H
3#define __PERF_SESSION_H
4
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 is
31 * 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 global
43 * 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_LIBTRACEEVENT
57 /** @tevent: handles for libtraceevent and plugins. */
58 struct trace_event tevent;
59#endif
60 /** @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 be
66 * multiple data files in particular for aux events. If this is true
67 * 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 before
82 * compression.
83 */
84 u64 bytes_transferred;
85 /**
86 * @bytes_compressed: Used by perf record to count written bytes after
87 * 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 struct perf_env *host_env);
112
113static inline struct perf_session *perf_session__new(struct perf_data *data,
114 struct perf_tool *tool)
115{
116 return __perf_session__new(data, tool, /*trace_event_repipe=*/trace_event_repipe: false, /*host_env=*/NULL);
117}
118
119void perf_session__delete(struct perf_session *session);
120
121void perf_event_header__bswap(struct perf_event_header *hdr);
122
123int perf_session__peek_event(struct perf_session *session, off_t file_offset,
124 void *buf, size_t buf_sz,
125 union perf_event **event_ptr,
126 struct perf_sample *sample);
127typedef int (*peek_events_cb_t)(struct perf_session *session,
128 union perf_event *event, u64 offset,
129 void *data);
130int perf_session__peek_events(struct perf_session *session, u64 offset,
131 u64 size, peek_events_cb_t cb, void *data);
132
133int perf_session__process_events(struct perf_session *session);
134
135int perf_session__queue_event(struct perf_session *s, union perf_event *event,
136 u64 timestamp, u64 file_offset, const char *file_path);
137
138int perf_session__resolve_callchain(struct perf_session *session,
139 struct evsel *evsel,
140 struct thread *thread,
141 struct ip_callchain *chain,
142 struct symbol **parent);
143
144bool perf_session__has_traces(struct perf_session *session, const char *msg);
145bool perf_session__has_switch_events(struct perf_session *session);
146
147void perf_event__attr_swap(struct perf_event_attr *attr);
148
149int perf_session__create_kernel_maps(struct perf_session *session);
150
151void perf_session__set_id_hdr_size(struct perf_session *session);
152
153static inline
154struct machine *perf_session__find_machine(struct perf_session *session, pid_t pid)
155{
156 return machines__find(machines: &session->machines, pid);
157}
158
159static inline
160struct machine *perf_session__findnew_machine(struct perf_session *session, pid_t pid)
161{
162 return machines__findnew(machines: &session->machines, pid);
163}
164
165struct thread *perf_session__findnew(struct perf_session *session, pid_t pid);
166int perf_session__register_idle_thread(struct perf_session *session);
167
168size_t perf_session__fprintf(struct perf_session *session, FILE *fp);
169
170size_t perf_session__fprintf_dsos(struct perf_session *session, FILE *fp);
171
172size_t perf_session__fprintf_dsos_buildid(struct perf_session *session, FILE *fp,
173 bool (fn)(struct dso *dso, int parm), int parm);
174
175size_t perf_session__fprintf_nr_events(struct perf_session *session, FILE *fp);
176
177void perf_session__dump_kmaps(struct perf_session *session);
178
179struct evsel *perf_session__find_first_evtype(struct perf_session *session,
180 unsigned int type);
181
182int perf_session__cpu_bitmap(struct perf_session *session,
183 const char *cpu_list, unsigned long *cpu_bitmap);
184
185void perf_session__fprintf_info(struct perf_session *s, FILE *fp, bool full);
186
187struct evsel_str_handler;
188
189#define perf_session__set_tracepoints_handlers(session, array) \
190 __evlist__set_tracepoints_handlers(session->evlist, array, ARRAY_SIZE(array))
191
192extern volatile int session_done;
193
194#define session_done() READ_ONCE(session_done)
195
196int perf_session__deliver_synth_event(struct perf_session *session,
197 union perf_event *event,
198 struct perf_sample *sample);
199int perf_session__deliver_synth_attr_event(struct perf_session *session,
200 const struct perf_event_attr *attr,
201 u64 id);
202
203int perf_session__dsos_hit_all(struct perf_session *session);
204
205int perf_event__process_id_index(const struct perf_tool *tool,
206 struct perf_session *session,
207 union perf_event *event);
208
209int perf_event__process_finished_round(const struct perf_tool *tool,
210 union perf_event *event,
211 struct ordered_events *oe);
212
213struct perf_env *perf_session__env(struct perf_session *session);
214
215#endif /* __PERF_SESSION_H */
216

source code of linux/tools/perf/util/session.h