evlist.h 10.8 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
2 3 4
#ifndef __PERF_EVLIST_H
#define __PERF_EVLIST_H 1

5
#include <linux/compiler.h>
6
#include <linux/kernel.h>
7
#include <linux/refcount.h>
8
#include <linux/list.h>
9
#include <api/fd/array.h>
10
#include <fcntl.h>
11
#include <stdio.h>
12
#include "../perf.h"
13
#include "event.h"
14
#include "evsel.h"
15
#include "mmap.h"
16
#include "util.h"
17
#include <signal.h>
18
#include <unistd.h>
19

20
struct pollfd;
21 22
struct thread_map;
struct cpu_map;
23
struct record_opts;
24

25 26 27
#define PERF_EVLIST__HLIST_BITS 8
#define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS)

28 29
struct perf_evlist {
	struct list_head entries;
30
	struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
31
	int		 nr_entries;
32
	int		 nr_groups;
33
	int		 nr_mmaps;
34
	bool		 enabled;
35
	bool		 has_user_cpus;
36
	size_t		 mmap_len;
37 38 39
	int		 id_pos;
	int		 is_pos;
	u64		 combined_sample_type;
40
	enum bkw_mmap_state bkw_mmap_state;
41 42 43 44
	struct {
		int	cork_fd;
		pid_t	pid;
	} workload;
45
	struct fdarray	 pollfd;
46
	struct perf_mmap *mmap;
47
	struct perf_mmap *overwrite_mmap;
48 49
	struct thread_map *threads;
	struct cpu_map	  *cpus;
50
	struct perf_evsel *selected;
51
	struct events_stats stats;
52
	struct perf_env	*env;
53 54
};

55 56 57 58 59
struct perf_evsel_str_handler {
	const char *name;
	void	   *handler;
};

60
struct perf_evlist *perf_evlist__new(void);
61
struct perf_evlist *perf_evlist__new_default(void);
62
struct perf_evlist *perf_evlist__new_dummy(void);
63 64
void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
		       struct thread_map *threads);
65
void perf_evlist__exit(struct perf_evlist *evlist);
66 67 68
void perf_evlist__delete(struct perf_evlist *evlist);

void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry);
69
void perf_evlist__remove(struct perf_evlist *evlist, struct perf_evsel *evsel);
70 71 72 73 74 75 76 77

int __perf_evlist__add_default(struct perf_evlist *evlist, bool precise);

static inline int perf_evlist__add_default(struct perf_evlist *evlist)
{
	return __perf_evlist__add_default(evlist, true);
}

78 79
int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
				     struct perf_event_attr *attrs, size_t nr_attrs);
80

81 82
#define perf_evlist__add_default_attrs(evlist, array) \
	__perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
83

84 85
int perf_evlist__add_dummy(struct perf_evlist *evlist);

86 87 88
int perf_evlist__add_newtp(struct perf_evlist *evlist,
			   const char *sys, const char *name, void *handler);

89 90 91 92 93 94 95 96 97 98 99
void __perf_evlist__set_sample_bit(struct perf_evlist *evlist,
				   enum perf_event_sample_format bit);
void __perf_evlist__reset_sample_bit(struct perf_evlist *evlist,
				     enum perf_event_sample_format bit);

#define perf_evlist__set_sample_bit(evlist, bit) \
	__perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit)

#define perf_evlist__reset_sample_bit(evlist, bit) \
	__perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit)

100
int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter);
101
int perf_evlist__set_filter_pid(struct perf_evlist *evlist, pid_t pid);
102
int perf_evlist__set_filter_pids(struct perf_evlist *evlist, size_t npids, pid_t *pids);
103

104 105 106
struct perf_evsel *
perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id);

107 108 109 110
struct perf_evsel *
perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist,
				     const char *name);

111 112
void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
			 int cpu, int thread, u64 id);
J
Jiri Olsa 已提交
113 114 115
int perf_evlist__id_add_fd(struct perf_evlist *evlist,
			   struct perf_evsel *evsel,
			   int cpu, int thread, int fd);
116

117 118
int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
int perf_evlist__alloc_pollfd(struct perf_evlist *evlist);
119 120
int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask);

121 122
int perf_evlist__poll(struct perf_evlist *evlist, int timeout);

123
struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);
124 125
struct perf_evsel *perf_evlist__id2evsel_strict(struct perf_evlist *evlist,
						u64 id);
126

127 128
struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id);

129 130
void perf_evlist__toggle_bkw_mmap(struct perf_evlist *evlist, enum bkw_mmap_state state);

131
union perf_event *perf_evlist__mmap_read(struct perf_evlist *evlist, int idx);
132

133 134
union perf_event *perf_evlist__mmap_read_forward(struct perf_evlist *evlist,
						 int idx);
135 136 137 138
union perf_event *perf_evlist__mmap_read_backward(struct perf_evlist *evlist,
						  int idx);
void perf_evlist__mmap_read_catchup(struct perf_evlist *evlist, int idx);

139 140
void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx);

141
int perf_evlist__open(struct perf_evlist *evlist);
142
void perf_evlist__close(struct perf_evlist *evlist);
143

144 145
struct callchain_param;

146 147
void perf_evlist__set_id_pos(struct perf_evlist *evlist);
bool perf_can_sample_identifier(void);
148
bool perf_can_record_switch_events(void);
149
bool perf_can_record_cpu_wide(void);
150 151
void perf_evlist__config(struct perf_evlist *evlist, struct record_opts *opts,
			 struct callchain_param *callchain);
152
int record_opts__config(struct record_opts *opts);
153

154
int perf_evlist__prepare_workload(struct perf_evlist *evlist,
155
				  struct target *target,
156
				  const char *argv[], bool pipe_output,
157 158
				  void (*exec_error)(int signo, siginfo_t *info,
						     void *ucontext));
159 160
int perf_evlist__start_workload(struct perf_evlist *evlist);

161 162
struct option;

163
int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
164 165 166 167
int perf_evlist__parse_mmap_pages(const struct option *opt,
				  const char *str,
				  int unset);

168 169
unsigned long perf_event_mlock_kb_in_pages(void);

170
int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages,
171
			 unsigned int auxtrace_pages,
172
			 bool auxtrace_overwrite);
173
int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages);
174 175
void perf_evlist__munmap(struct perf_evlist *evlist);

176 177
size_t perf_evlist__mmap_size(unsigned long pages);

178
void perf_evlist__disable(struct perf_evlist *evlist);
179
void perf_evlist__enable(struct perf_evlist *evlist);
180
void perf_evlist__toggle_enable(struct perf_evlist *evlist);
181

182 183
int perf_evlist__enable_event_idx(struct perf_evlist *evlist,
				  struct perf_evsel *evsel, int idx);
184

185 186 187
void perf_evlist__set_selected(struct perf_evlist *evlist,
			       struct perf_evsel *evsel);

188 189
void perf_evlist__set_maps(struct perf_evlist *evlist, struct cpu_map *cpus,
			   struct thread_map *threads);
190
int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target);
191
int perf_evlist__apply_filters(struct perf_evlist *evlist, struct perf_evsel **err_evsel);
192

193 194 195
void __perf_evlist__set_leader(struct list_head *list);
void perf_evlist__set_leader(struct perf_evlist *evlist);

196
u64 perf_evlist__read_format(struct perf_evlist *evlist);
197 198
u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist);
u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist);
199
u64 perf_evlist__combined_branch_type(struct perf_evlist *evlist);
200 201
bool perf_evlist__sample_id_all(struct perf_evlist *evlist);
u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist);
202

203
int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
204
			      struct perf_sample *sample);
205

206 207 208 209
int perf_evlist__parse_sample_timestamp(struct perf_evlist *evlist,
					union perf_event *event,
					u64 *timestamp);

210 211
bool perf_evlist__valid_sample_type(struct perf_evlist *evlist);
bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist);
212
bool perf_evlist__valid_read_format(struct perf_evlist *evlist);
213 214

void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
215
				   struct list_head *list);
216

217 218 219 220 221
static inline bool perf_evlist__empty(struct perf_evlist *evlist)
{
	return list_empty(&evlist->entries);
}

222 223 224 225 226 227 228 229 230
static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist)
{
	return list_entry(evlist->entries.next, struct perf_evsel, node);
}

static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist)
{
	return list_entry(evlist->entries.prev, struct perf_evsel, node);
}
231 232

size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);
233

234
int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size);
235
int perf_evlist__strerror_mmap(struct perf_evlist *evlist, int err, char *buf, size_t size);
236

237
bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str);
238 239 240
void perf_evlist__to_front(struct perf_evlist *evlist,
			   struct perf_evsel *move_evsel);

241
/**
242
 * __evlist__for_each_entry - iterate thru all the evsels
243 244 245
 * @list: list_head instance to iterate
 * @evsel: struct evsel iterator
 */
246
#define __evlist__for_each_entry(list, evsel) \
247 248 249
        list_for_each_entry(evsel, list, node)

/**
250
 * evlist__for_each_entry - iterate thru all the evsels
251 252 253
 * @evlist: evlist instance to iterate
 * @evsel: struct evsel iterator
 */
254 255
#define evlist__for_each_entry(evlist, evsel) \
	__evlist__for_each_entry(&(evlist)->entries, evsel)
256 257

/**
258
 * __evlist__for_each_entry_continue - continue iteration thru all the evsels
259 260 261
 * @list: list_head instance to iterate
 * @evsel: struct evsel iterator
 */
262
#define __evlist__for_each_entry_continue(list, evsel) \
263 264 265
        list_for_each_entry_continue(evsel, list, node)

/**
266
 * evlist__for_each_entry_continue - continue iteration thru all the evsels
267 268 269
 * @evlist: evlist instance to iterate
 * @evsel: struct evsel iterator
 */
270 271
#define evlist__for_each_entry_continue(evlist, evsel) \
	__evlist__for_each_entry_continue(&(evlist)->entries, evsel)
272 273

/**
274
 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
275 276 277
 * @list: list_head instance to iterate
 * @evsel: struct evsel iterator
 */
278
#define __evlist__for_each_entry_reverse(list, evsel) \
279 280 281
        list_for_each_entry_reverse(evsel, list, node)

/**
282
 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
283 284 285
 * @evlist: evlist instance to iterate
 * @evsel: struct evsel iterator
 */
286 287
#define evlist__for_each_entry_reverse(evlist, evsel) \
	__evlist__for_each_entry_reverse(&(evlist)->entries, evsel)
288 289

/**
290
 * __evlist__for_each_entry_safe - safely iterate thru all the evsels
291 292 293 294
 * @list: list_head instance to iterate
 * @tmp: struct evsel temp iterator
 * @evsel: struct evsel iterator
 */
295
#define __evlist__for_each_entry_safe(list, tmp, evsel) \
296 297 298
        list_for_each_entry_safe(evsel, tmp, list, node)

/**
299
 * evlist__for_each_entry_safe - safely iterate thru all the evsels
300 301 302 303
 * @evlist: evlist instance to iterate
 * @evsel: struct evsel iterator
 * @tmp: struct evsel temp iterator
 */
304 305
#define evlist__for_each_entry_safe(evlist, tmp, evsel) \
	__evlist__for_each_entry_safe(&(evlist)->entries, tmp, evsel)
306

307 308
void perf_evlist__set_tracking_event(struct perf_evlist *evlist,
				     struct perf_evsel *tracking_evsel);
309 310

void perf_event_attr__set_max_precise_ip(struct perf_event_attr *attr);
311 312 313

struct perf_evsel *
perf_evlist__find_evsel_by_str(struct perf_evlist *evlist, const char *str);
J
Jiri Olsa 已提交
314 315 316

struct perf_evsel *perf_evlist__event2evsel(struct perf_evlist *evlist,
					    union perf_event *event);
317 318

bool perf_evlist__exclude_kernel(struct perf_evlist *evlist);
319
#endif /* __PERF_EVLIST_H */