xref: /openbmc/linux/tools/perf/util/session.h (revision 5c816641)
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 
16 struct ip_callchain;
17 struct symbol;
18 struct thread;
19 
20 struct auxtrace;
21 struct itrace_synth_opts;
22 
23 struct decomp_data {
24 	struct decomp	 *decomp;
25 	struct decomp	 *decomp_last;
26 	struct zstd_data *zstd_decomp;
27 };
28 
29 struct perf_session {
30 	struct perf_header	header;
31 	struct machines		machines;
32 	struct evlist	*evlist;
33 	struct auxtrace		*auxtrace;
34 	struct itrace_synth_opts *itrace_synth_opts;
35 	struct list_head	auxtrace_index;
36 	struct trace_event	tevent;
37 	struct perf_record_time_conv	time_conv;
38 	bool			repipe;
39 	bool			one_mmap;
40 	void			*one_mmap_addr;
41 	u64			one_mmap_offset;
42 	struct ordered_events	ordered_events;
43 	struct perf_data	*data;
44 	struct perf_tool	*tool;
45 	u64			bytes_transferred;
46 	u64			bytes_compressed;
47 	struct zstd_data	zstd_data;
48 	struct decomp_data	decomp_data;
49 	struct decomp_data	*active_decomp;
50 };
51 
52 struct decomp {
53 	struct decomp *next;
54 	u64 file_pos;
55 	size_t mmap_len;
56 	u64 head;
57 	size_t size;
58 	char data[];
59 };
60 
61 struct perf_tool;
62 
63 struct perf_session *__perf_session__new(struct perf_data *data,
64 					 bool repipe, int repipe_fd,
65 					 struct perf_tool *tool);
66 
67 static inline struct perf_session *perf_session__new(struct perf_data *data,
68 						     struct perf_tool *tool)
69 {
70 	return __perf_session__new(data, false, -1, tool);
71 }
72 
73 void perf_session__delete(struct perf_session *session);
74 
75 void perf_event_header__bswap(struct perf_event_header *hdr);
76 
77 int perf_session__peek_event(struct perf_session *session, off_t file_offset,
78 			     void *buf, size_t buf_sz,
79 			     union perf_event **event_ptr,
80 			     struct perf_sample *sample);
81 typedef int (*peek_events_cb_t)(struct perf_session *session,
82 				union perf_event *event, u64 offset,
83 				void *data);
84 int perf_session__peek_events(struct perf_session *session, u64 offset,
85 			      u64 size, peek_events_cb_t cb, void *data);
86 
87 int perf_session__process_events(struct perf_session *session);
88 
89 int perf_session__queue_event(struct perf_session *s, union perf_event *event,
90 			      u64 timestamp, u64 file_offset);
91 
92 void perf_tool__fill_defaults(struct perf_tool *tool);
93 
94 int perf_session__resolve_callchain(struct perf_session *session,
95 				    struct evsel *evsel,
96 				    struct thread *thread,
97 				    struct ip_callchain *chain,
98 				    struct symbol **parent);
99 
100 bool perf_session__has_traces(struct perf_session *session, const char *msg);
101 
102 void perf_event__attr_swap(struct perf_event_attr *attr);
103 
104 int perf_session__create_kernel_maps(struct perf_session *session);
105 
106 void perf_session__set_id_hdr_size(struct perf_session *session);
107 
108 static inline
109 struct machine *perf_session__find_machine(struct perf_session *session, pid_t pid)
110 {
111 	return machines__find(&session->machines, pid);
112 }
113 
114 static inline
115 struct machine *perf_session__findnew_machine(struct perf_session *session, pid_t pid)
116 {
117 	return machines__findnew(&session->machines, pid);
118 }
119 
120 struct thread *perf_session__findnew(struct perf_session *session, pid_t pid);
121 int perf_session__register_idle_thread(struct perf_session *session);
122 
123 size_t perf_session__fprintf(struct perf_session *session, FILE *fp);
124 
125 size_t perf_session__fprintf_dsos(struct perf_session *session, FILE *fp);
126 
127 size_t perf_session__fprintf_dsos_buildid(struct perf_session *session, FILE *fp,
128 					  bool (fn)(struct dso *dso, int parm), int parm);
129 
130 size_t perf_session__fprintf_nr_events(struct perf_session *session, FILE *fp,
131 				       bool skip_empty);
132 
133 struct evsel *perf_session__find_first_evtype(struct perf_session *session,
134 					    unsigned int type);
135 
136 int perf_session__cpu_bitmap(struct perf_session *session,
137 			     const char *cpu_list, unsigned long *cpu_bitmap);
138 
139 void perf_session__fprintf_info(struct perf_session *s, FILE *fp, bool full);
140 
141 struct evsel_str_handler;
142 
143 #define perf_session__set_tracepoints_handlers(session, array) \
144 	__evlist__set_tracepoints_handlers(session->evlist, array, ARRAY_SIZE(array))
145 
146 extern volatile int session_done;
147 
148 #define session_done()	READ_ONCE(session_done)
149 
150 int perf_session__deliver_synth_event(struct perf_session *session,
151 				      union perf_event *event,
152 				      struct perf_sample *sample);
153 
154 int perf_event__process_id_index(struct perf_session *session,
155 				 union perf_event *event);
156 
157 #endif /* __PERF_SESSION_H */
158