projects/linux·blob master · refs

220 lines · 7.2 KiB

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 /** @one_mmap_size: Size of the single mmap in bytes. */
75 u64 one_mmap_size;
76 /** @ordered_events: Used to turn unordered events into ordered ones. */
77 struct ordered_events ordered_events;
78 /** @data: Optional perf data file being read from. */
79 struct perf_data *data;
80 /** @tool: callbacks for event handling. */
81 const struct perf_tool *tool;
82 /**
83 * @bytes_transferred: Used by perf record to count written bytes before
84 * compression.
85 */
86 u64 bytes_transferred;
87 /**
88 * @bytes_compressed: Used by perf record to count written bytes after
89 * compression.
90 */
91 u64 bytes_compressed;
92 /** @zstd_data: Owner of global compression state, buffers, etc. */
93 struct zstd_data zstd_data;
94 struct decomp_data decomp_data;
95 struct decomp_data *active_decomp;
96};
97
98struct decomp {
99 struct decomp *next;
100 u64 file_pos;
101 const char *file_path;
102 size_t mmap_len;
103 u64 head;
104 size_t size;
105 char data[];
106};
107
108struct perf_tool;
109
110struct perf_session *__perf_session__new(struct perf_data *data,
111 struct perf_tool *tool,
112 bool trace_event_repipe,
113 struct perf_env *host_env);
114
115static inline struct perf_session *perf_session__new(struct perf_data *data,
116 struct perf_tool *tool)
117{
118 return __perf_session__new(data, tool, /*trace_event_repipe=*/false, /*host_env=*/NULL);
119}
120
121void perf_session__delete(struct perf_session *session);
122
123void perf_event_header__bswap(struct perf_event_header *hdr);
124
125bool perf_event__too_small(const union perf_event *event, u32 *min);
126
127int perf_session__peek_event(struct perf_session *session, off_t file_offset,
128 void *buf, size_t buf_sz,
129 union perf_event **event_ptr,
130 struct perf_sample *sample);
131typedef int (*peek_events_cb_t)(struct perf_session *session,
132 union perf_event *event, u64 offset,
133 void *data);
134int perf_session__peek_events(struct perf_session *session, u64 offset,
135 u64 size, peek_events_cb_t cb, void *data);
136
137int perf_session__process_events(struct perf_session *session);
138
139int perf_session__queue_event(struct perf_session *s, union perf_event *event,
140 u64 timestamp, u64 file_offset, const char *file_path);
141
142int perf_session__resolve_callchain(struct perf_session *session,
143 struct evsel *evsel,
144 struct thread *thread,
145 struct ip_callchain *chain,
146 struct symbol **parent);
147
148bool perf_session__has_traces(struct perf_session *session, const char *msg);
149bool perf_session__has_switch_events(struct perf_session *session);
150
151void perf_event__attr_swap(struct perf_event_attr *attr);
152
153int perf_session__create_kernel_maps(struct perf_session *session);
154
155void perf_session__set_id_hdr_size(struct perf_session *session);
156
157static inline
158struct machine *perf_session__find_machine(struct perf_session *session, pid_t pid)
159{
160 return machines__find(&session->machines, pid);
161}
162
163static inline
164struct machine *perf_session__findnew_machine(struct perf_session *session, pid_t pid)
165{
166 return machines__findnew(&session->machines, pid);
167}
168
169struct thread *perf_session__findnew(struct perf_session *session, pid_t pid);
170int perf_session__register_idle_thread(struct perf_session *session);
171
172size_t perf_session__fprintf(struct perf_session *session, FILE *fp);
173
174size_t perf_session__fprintf_dsos(struct perf_session *session, FILE *fp);
175
176size_t perf_session__fprintf_dsos_buildid(struct perf_session *session, FILE *fp,
177 bool (fn)(struct dso *dso, int parm), int parm);
178
179size_t perf_session__fprintf_nr_events(struct perf_session *session, FILE *fp);
180
181void perf_session__dump_kmaps(struct perf_session *session);
182
183struct evsel *perf_session__find_first_evtype(struct perf_session *session,
184 unsigned int type);
185
186int perf_session__cpu_bitmap(struct perf_session *session,
187 const char *cpu_list, unsigned long *cpu_bitmap);
188
189void perf_session__fprintf_info(struct perf_session *s, FILE *fp, bool full);
190
191struct evsel_str_handler;
192
193#define perf_session__set_tracepoints_handlers(session, array) \
194 __evlist__set_tracepoints_handlers(session->evlist, array, ARRAY_SIZE(array))
195
196extern volatile int session_done;
197
198#define session_done() READ_ONCE(session_done)
199
200int perf_session__deliver_synth_event(struct perf_session *session,
201 union perf_event *event,
202 struct perf_sample *sample);
203int perf_session__deliver_synth_attr_event(struct perf_session *session,
204 const struct perf_event_attr *attr,
205 u64 id);
206
207int perf_session__dsos_hit_all(struct perf_session *session);
208
209int perf_event__process_id_index(const struct perf_tool *tool,
210 struct perf_session *session,
211 union perf_event *event);
212
213int perf_event__process_finished_round(const struct perf_tool *tool,
214 union perf_event *event,
215 struct ordered_events *oe);
216
217struct perf_env *perf_session__env(struct perf_session *session);
218uint16_t perf_session__e_machine(struct perf_session *session, uint32_t *e_flags);
219
220#endif /* __PERF_SESSION_H */