xref: /linux/tools/perf/util/session.h (revision 088e88be5a380cc4e81963a9a02815da465d144f)
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 perf_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 time_conv_event	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, struct perf_tool *tool);
59 void perf_session__delete(struct perf_session *session);
60 
61 void perf_event_header__bswap(struct perf_event_header *hdr);
62 
63 int perf_session__peek_event(struct perf_session *session, off_t file_offset,
64 			     void *buf, size_t buf_sz,
65 			     union perf_event **event_ptr,
66 			     struct perf_sample *sample);
67 
68 int perf_session__process_events(struct perf_session *session);
69 
70 int perf_session__queue_event(struct perf_session *s, union perf_event *event,
71 			      u64 timestamp, u64 file_offset);
72 
73 void perf_tool__fill_defaults(struct perf_tool *tool);
74 
75 int perf_session__resolve_callchain(struct perf_session *session,
76 				    struct perf_evsel *evsel,
77 				    struct thread *thread,
78 				    struct ip_callchain *chain,
79 				    struct symbol **parent);
80 
81 bool perf_session__has_traces(struct perf_session *session, const char *msg);
82 
83 void perf_event__attr_swap(struct perf_event_attr *attr);
84 
85 int perf_session__create_kernel_maps(struct perf_session *session);
86 
87 void perf_session__set_id_hdr_size(struct perf_session *session);
88 
89 static inline
90 struct machine *perf_session__find_machine(struct perf_session *session, pid_t pid)
91 {
92 	return machines__find(&session->machines, pid);
93 }
94 
95 static inline
96 struct machine *perf_session__findnew_machine(struct perf_session *session, pid_t pid)
97 {
98 	return machines__findnew(&session->machines, pid);
99 }
100 
101 struct thread *perf_session__findnew(struct perf_session *session, pid_t pid);
102 int perf_session__register_idle_thread(struct perf_session *session);
103 
104 size_t perf_session__fprintf(struct perf_session *session, FILE *fp);
105 
106 size_t perf_session__fprintf_dsos(struct perf_session *session, FILE *fp);
107 
108 size_t perf_session__fprintf_dsos_buildid(struct perf_session *session, FILE *fp,
109 					  bool (fn)(struct dso *dso, int parm), int parm);
110 
111 size_t perf_session__fprintf_nr_events(struct perf_session *session, FILE *fp);
112 
113 struct perf_evsel *perf_session__find_first_evtype(struct perf_session *session,
114 					    unsigned int type);
115 
116 int perf_session__cpu_bitmap(struct perf_session *session,
117 			     const char *cpu_list, unsigned long *cpu_bitmap);
118 
119 void perf_session__fprintf_info(struct perf_session *s, FILE *fp, bool full);
120 
121 struct perf_evsel_str_handler;
122 
123 int __perf_session__set_tracepoints_handlers(struct perf_session *session,
124 					     const struct perf_evsel_str_handler *assocs,
125 					     size_t nr_assocs);
126 
127 #define perf_session__set_tracepoints_handlers(session, array) \
128 	__perf_session__set_tracepoints_handlers(session, array, ARRAY_SIZE(array))
129 
130 extern volatile int session_done;
131 
132 #define session_done()	READ_ONCE(session_done)
133 
134 int perf_session__deliver_synth_event(struct perf_session *session,
135 				      union perf_event *event,
136 				      struct perf_sample *sample);
137 
138 int perf_event__process_id_index(struct perf_session *session,
139 				 union perf_event *event);
140 
141 int perf_event__synthesize_id_index(struct perf_tool *tool,
142 				    perf_event__handler_t process,
143 				    struct perf_evlist *evlist,
144 				    struct machine *machine);
145 
146 #endif /* __PERF_SESSION_H */
147