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