Commit | Line | Data |
---|---|---|
2025cf9e | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
718c602d AH |
2 | /* |
3 | * auxtrace.h: AUX area trace support | |
4 | * Copyright (c) 2013-2015, Intel Corporation. | |
718c602d AH |
5 | */ |
6 | ||
7 | #ifndef __PERF_AUXTRACE_H | |
8 | #define __PERF_AUXTRACE_H | |
9 | ||
10 | #include <sys/types.h> | |
a43783ae | 11 | #include <errno.h> |
718c602d | 12 | #include <stdbool.h> |
9e0cc4fe | 13 | #include <stddef.h> |
ea49e01c | 14 | #include <stdio.h> // FILE |
e5027893 | 15 | #include <linux/list.h> |
718c602d AH |
16 | #include <linux/perf_event.h> |
17 | #include <linux/types.h> | |
c4d9d95f | 18 | #include <perf/cpumap.h> |
291ed51d | 19 | #include <asm/bitsperlong.h> |
91854f9a | 20 | #include <asm/barrier.h> |
718c602d | 21 | |
9e0cc4fe AH |
22 | union perf_event; |
23 | struct perf_session; | |
63503dba | 24 | struct evlist; |
853f37d7 | 25 | struct evsel; |
9e0cc4fe | 26 | struct perf_tool; |
a5830532 | 27 | struct mmap; |
bd23ac11 | 28 | struct perf_sample; |
f6986c95 | 29 | struct option; |
9e0cc4fe | 30 | struct record_opts; |
ea49e01c | 31 | struct perf_record_auxtrace_error; |
72932371 | 32 | struct perf_record_auxtrace_info; |
85ed4729 | 33 | struct events_stats; |
ad60ba0c | 34 | struct perf_pmu; |
718c602d | 35 | |
47729258 ACM |
36 | enum auxtrace_error_type { |
37 | PERF_AUXTRACE_ERROR_ITRACE = 1, | |
38 | PERF_AUXTRACE_ERROR_MAX | |
39 | }; | |
40 | ||
c3fcadf0 AH |
41 | /* Auxtrace records must have the same alignment as perf event records */ |
42 | #define PERF_AUXTRACE_RECORD_ALIGNMENT 8 | |
43 | ||
73f75fb1 AH |
44 | enum auxtrace_type { |
45 | PERF_AUXTRACE_UNKNOWN, | |
55ea4ab4 | 46 | PERF_AUXTRACE_INTEL_PT, |
d0170af7 | 47 | PERF_AUXTRACE_INTEL_BTS, |
a818c563 | 48 | PERF_AUXTRACE_CS_ETM, |
ffd3d18c | 49 | PERF_AUXTRACE_ARM_SPE, |
b96e6615 | 50 | PERF_AUXTRACE_S390_CPUMSF, |
057381a7 | 51 | PERF_AUXTRACE_HISI_PTT, |
73f75fb1 AH |
52 | }; |
53 | ||
f6986c95 AH |
54 | enum itrace_period_type { |
55 | PERF_ITRACE_PERIOD_INSTRUCTIONS, | |
56 | PERF_ITRACE_PERIOD_TICKS, | |
57 | PERF_ITRACE_PERIOD_NANOSECS, | |
58 | }; | |
59 | ||
cb971438 AH |
60 | #define AUXTRACE_ERR_FLG_OVERFLOW (1 << ('o' - 'a')) |
61 | #define AUXTRACE_ERR_FLG_DATA_LOST (1 << ('l' - 'a')) | |
62 | ||
935aac2d | 63 | #define AUXTRACE_LOG_FLG_ALL_PERF_EVTS (1 << ('a' - 'a')) |
a7fdd30a | 64 | #define AUXTRACE_LOG_FLG_ON_ERROR (1 << ('e' - 'a')) |
4b2b2c6a | 65 | #define AUXTRACE_LOG_FLG_USE_STDOUT (1 << ('o' - 'a')) |
935aac2d | 66 | |
f6986c95 AH |
67 | /** |
68 | * struct itrace_synth_opts - AUX area tracing synthesis options. | |
69 | * @set: indicates whether or not options have been set | |
4eb06815 | 70 | * @default_no_sample: Default to no sampling. |
f6986c95 AH |
71 | * @inject: indicates the event (not just the sample) must be fully synthesized |
72 | * because 'perf inject' will write it out | |
73 | * @instructions: whether to synthesize 'instructions' events | |
7e55b956 SG |
74 | * @cycles: whether to synthesize 'cycles' events |
75 | * (not fully accurate, since CYC packets are only emitted | |
76 | * together with other events, such as branches) | |
f6986c95 | 77 | * @branches: whether to synthesize 'branches' events |
9f74d770 | 78 | * (branch misses only for Arm SPE) |
53c76b0e | 79 | * @transactions: whether to synthesize events for transactions |
3bdafdff | 80 | * @ptwrites: whether to synthesize events for ptwrites |
70d110d7 | 81 | * @pwr_events: whether to synthesize power events |
181ebb5e AH |
82 | * @other_events: whether to synthesize other events recorded due to the use of |
83 | * aux_output | |
8ee9a9ab | 84 | * @intr_events: whether to synthesize interrupt events |
f6986c95 AH |
85 | * @errors: whether to synthesize decoder error events |
86 | * @dont_decode: whether to skip decoding entirely | |
87 | * @log: write a decoding log | |
88 | * @calls: limit branch samples to calls (can be combined with @returns) | |
89 | * @returns: limit branch samples to returns (can be combined with @calls) | |
90 | * @callchain: add callchain to 'instructions' events | |
1c5c25b3 | 91 | * @add_callchain: add callchain to existing event records |
50f73637 | 92 | * @thread_stack: feed branches to the thread_stack |
601897b5 | 93 | * @last_branch: add branch context to 'instruction' events |
ec90e42c | 94 | * @add_last_branch: add branch context to existing event records |
b6778fe1 | 95 | * @approx_ipc: approximate IPC |
9f74d770 TX |
96 | * @flc: whether to synthesize first level cache events |
97 | * @llc: whether to synthesize last level cache events | |
98 | * @tlb: whether to synthesize TLB events | |
99 | * @remote_access: whether to synthesize remote access events | |
014a771c | 100 | * @mem: whether to synthesize memory events |
18f49494 | 101 | * @timeless_decoding: prefer "timeless" decoding i.e. ignore timestamps |
83d7f5f1 AH |
102 | * @vm_time_correlation: perform VM Time Correlation |
103 | * @vm_tm_corr_dry_run: VM Time Correlation dry-run | |
104 | * @vm_tm_corr_args: VM Time Correlation implementation-specific arguments | |
f6986c95 | 105 | * @callchain_sz: maximum callchain size |
601897b5 | 106 | * @last_branch_sz: branch context size |
f6986c95 AH |
107 | * @period: 'instructions' events period |
108 | * @period_type: 'instructions' events period type | |
d1706b39 | 109 | * @initial_skip: skip N events at the beginning. |
644e0840 | 110 | * @cpu_bitmap: CPUs for which to synthesize events, or NULL for all |
33526f36 AH |
111 | * @ptime_range: time intervals to trace or NULL |
112 | * @range_num: number of time intervals to trace | |
cb971438 AH |
113 | * @error_plus_flags: flags to affect what errors are reported |
114 | * @error_minus_flags: flags to affect what errors are reported | |
935aac2d AH |
115 | * @log_plus_flags: flags to affect what is logged |
116 | * @log_minus_flags: flags to affect what is logged | |
51971536 | 117 | * @quick: quicker (less detailed) decoding |
a7fdd30a | 118 | * @log_on_error_size: size of log to keep for outputting log only on errors |
f6986c95 AH |
119 | */ |
120 | struct itrace_synth_opts { | |
121 | bool set; | |
4eb06815 | 122 | bool default_no_sample; |
f6986c95 AH |
123 | bool inject; |
124 | bool instructions; | |
7e55b956 | 125 | bool cycles; |
f6986c95 | 126 | bool branches; |
53c76b0e | 127 | bool transactions; |
3bdafdff | 128 | bool ptwrites; |
70d110d7 | 129 | bool pwr_events; |
181ebb5e | 130 | bool other_events; |
8ee9a9ab | 131 | bool intr_events; |
f6986c95 AH |
132 | bool errors; |
133 | bool dont_decode; | |
134 | bool log; | |
135 | bool calls; | |
136 | bool returns; | |
137 | bool callchain; | |
1c5c25b3 | 138 | bool add_callchain; |
50f73637 | 139 | bool thread_stack; |
601897b5 | 140 | bool last_branch; |
ec90e42c | 141 | bool add_last_branch; |
b6778fe1 | 142 | bool approx_ipc; |
9f74d770 TX |
143 | bool flc; |
144 | bool llc; | |
145 | bool tlb; | |
146 | bool remote_access; | |
014a771c | 147 | bool mem; |
18f49494 | 148 | bool timeless_decoding; |
83d7f5f1 AH |
149 | bool vm_time_correlation; |
150 | bool vm_tm_corr_dry_run; | |
151 | char *vm_tm_corr_args; | |
f6986c95 | 152 | unsigned int callchain_sz; |
601897b5 | 153 | unsigned int last_branch_sz; |
f6986c95 AH |
154 | unsigned long long period; |
155 | enum itrace_period_type period_type; | |
d1706b39 | 156 | unsigned long initial_skip; |
644e0840 | 157 | unsigned long *cpu_bitmap; |
33526f36 AH |
158 | struct perf_time_interval *ptime_range; |
159 | int range_num; | |
cb971438 AH |
160 | unsigned int error_plus_flags; |
161 | unsigned int error_minus_flags; | |
935aac2d AH |
162 | unsigned int log_plus_flags; |
163 | unsigned int log_minus_flags; | |
51971536 | 164 | unsigned int quick; |
a7fdd30a | 165 | unsigned int log_on_error_size; |
f6986c95 AH |
166 | }; |
167 | ||
99fa2984 AH |
168 | /** |
169 | * struct auxtrace_index_entry - indexes a AUX area tracing event within a | |
170 | * perf.data file. | |
171 | * @file_offset: offset within the perf.data file | |
172 | * @sz: size of the event | |
173 | */ | |
174 | struct auxtrace_index_entry { | |
175 | u64 file_offset; | |
176 | u64 sz; | |
177 | }; | |
178 | ||
179 | #define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256 | |
180 | ||
181 | /** | |
182 | * struct auxtrace_index - index of AUX area tracing events within a perf.data | |
183 | * file. | |
184 | * @list: linking a number of arrays of entries | |
185 | * @nr: number of entries | |
186 | * @entries: array of entries | |
187 | */ | |
188 | struct auxtrace_index { | |
189 | struct list_head list; | |
190 | size_t nr; | |
191 | struct auxtrace_index_entry entries[PERF_AUXTRACE_INDEX_ENTRY_COUNT]; | |
192 | }; | |
193 | ||
c446870d AH |
194 | /** |
195 | * struct auxtrace - session callbacks to allow AUX area data decoding. | |
196 | * @process_event: lets the decoder see all session events | |
b818ec61 | 197 | * @process_auxtrace_event: process a PERF_RECORD_AUXTRACE event |
ac2f445f AH |
198 | * @queue_data: queue an AUX sample or PERF_RECORD_AUXTRACE event for later |
199 | * processing | |
b04b8dd1 | 200 | * @dump_auxtrace_sample: dump AUX area sample data |
c446870d AH |
201 | * @flush_events: process any remaining data |
202 | * @free_events: free resources associated with event processing | |
203 | * @free: free resources associated with the session | |
204 | */ | |
205 | struct auxtrace { | |
206 | int (*process_event)(struct perf_session *session, | |
207 | union perf_event *event, | |
208 | struct perf_sample *sample, | |
209 | struct perf_tool *tool); | |
73f75fb1 AH |
210 | int (*process_auxtrace_event)(struct perf_session *session, |
211 | union perf_event *event, | |
212 | struct perf_tool *tool); | |
ac2f445f AH |
213 | int (*queue_data)(struct perf_session *session, |
214 | struct perf_sample *sample, union perf_event *event, | |
215 | u64 data_offset); | |
b04b8dd1 AH |
216 | void (*dump_auxtrace_sample)(struct perf_session *session, |
217 | struct perf_sample *sample); | |
c446870d AH |
218 | int (*flush_events)(struct perf_session *session, |
219 | struct perf_tool *tool); | |
220 | void (*free_events)(struct perf_session *session); | |
221 | void (*free)(struct perf_session *session); | |
853f37d7 AH |
222 | bool (*evsel_is_auxtrace)(struct perf_session *session, |
223 | struct evsel *evsel); | |
c446870d AH |
224 | }; |
225 | ||
e5027893 AH |
226 | /** |
227 | * struct auxtrace_buffer - a buffer containing AUX area tracing data. | |
228 | * @list: buffers are queued in a list held by struct auxtrace_queue | |
229 | * @size: size of the buffer in bytes | |
230 | * @pid: in per-thread mode, the pid this buffer is associated with | |
231 | * @tid: in per-thread mode, the tid this buffer is associated with | |
232 | * @cpu: in per-cpu mode, the cpu this buffer is associated with | |
233 | * @data: actual buffer data (can be null if the data has not been loaded) | |
234 | * @data_offset: file offset at which the buffer can be read | |
235 | * @mmap_addr: mmap address at which the buffer can be read | |
236 | * @mmap_size: size of the mmap at @mmap_addr | |
237 | * @data_needs_freeing: @data was malloc'd so free it when it is no longer | |
238 | * needed | |
239 | * @consecutive: the original data was split up and this buffer is consecutive | |
240 | * to the previous buffer | |
241 | * @offset: offset as determined by aux_head / aux_tail members of struct | |
242 | * perf_event_mmap_page | |
243 | * @reference: an implementation-specific reference determined when the data is | |
244 | * recorded | |
245 | * @buffer_nr: used to number each buffer | |
246 | * @use_size: implementation actually only uses this number of bytes | |
247 | * @use_data: implementation actually only uses data starting at this address | |
248 | */ | |
249 | struct auxtrace_buffer { | |
250 | struct list_head list; | |
251 | size_t size; | |
252 | pid_t pid; | |
253 | pid_t tid; | |
6d18804b | 254 | struct perf_cpu cpu; |
e5027893 AH |
255 | void *data; |
256 | off_t data_offset; | |
257 | void *mmap_addr; | |
258 | size_t mmap_size; | |
259 | bool data_needs_freeing; | |
260 | bool consecutive; | |
261 | u64 offset; | |
262 | u64 reference; | |
263 | u64 buffer_nr; | |
264 | size_t use_size; | |
265 | void *use_data; | |
266 | }; | |
267 | ||
268 | /** | |
269 | * struct auxtrace_queue - a queue of AUX area tracing data buffers. | |
270 | * @head: head of buffer list | |
271 | * @tid: in per-thread mode, the tid this queue is associated with | |
272 | * @cpu: in per-cpu mode, the cpu this queue is associated with | |
273 | * @set: %true once this queue has been dedicated to a specific thread or cpu | |
274 | * @priv: implementation-specific data | |
275 | */ | |
276 | struct auxtrace_queue { | |
277 | struct list_head head; | |
278 | pid_t tid; | |
279 | int cpu; | |
280 | bool set; | |
281 | void *priv; | |
282 | }; | |
283 | ||
284 | /** | |
285 | * struct auxtrace_queues - an array of AUX area tracing queues. | |
286 | * @queue_array: array of queues | |
287 | * @nr_queues: number of queues | |
288 | * @new_data: set whenever new data is queued | |
289 | * @populated: queues have been fully populated using the auxtrace_index | |
290 | * @next_buffer_nr: used to number each buffer | |
291 | */ | |
292 | struct auxtrace_queues { | |
293 | struct auxtrace_queue *queue_array; | |
294 | unsigned int nr_queues; | |
295 | bool new_data; | |
296 | bool populated; | |
297 | u64 next_buffer_nr; | |
298 | }; | |
299 | ||
f9397155 AH |
300 | /** |
301 | * struct auxtrace_heap_item - element of struct auxtrace_heap. | |
302 | * @queue_nr: queue number | |
303 | * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected | |
304 | * to be a timestamp | |
305 | */ | |
306 | struct auxtrace_heap_item { | |
307 | unsigned int queue_nr; | |
308 | u64 ordinal; | |
309 | }; | |
310 | ||
311 | /** | |
312 | * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues. | |
313 | * @heap_array: the heap | |
314 | * @heap_cnt: the number of elements in the heap | |
315 | * @heap_sz: maximum number of elements (grows as needed) | |
316 | */ | |
317 | struct auxtrace_heap { | |
318 | struct auxtrace_heap_item *heap_array; | |
319 | unsigned int heap_cnt; | |
320 | unsigned int heap_sz; | |
321 | }; | |
322 | ||
718c602d AH |
323 | /** |
324 | * struct auxtrace_mmap - records an mmap of the auxtrace buffer. | |
325 | * @base: address of mapped area | |
326 | * @userpg: pointer to buffer's perf_event_mmap_page | |
327 | * @mask: %0 if @len is not a power of two, otherwise (@len - %1) | |
328 | * @len: size of mapped area | |
329 | * @prev: previous aux_head | |
330 | * @idx: index of this mmap | |
331 | * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu | |
332 | * mmap) otherwise %0 | |
333 | * @cpu: cpu number for a per-cpu mmap otherwise %-1 | |
334 | */ | |
335 | struct auxtrace_mmap { | |
336 | void *base; | |
337 | void *userpg; | |
338 | size_t mask; | |
339 | size_t len; | |
340 | u64 prev; | |
341 | int idx; | |
342 | pid_t tid; | |
343 | int cpu; | |
344 | }; | |
345 | ||
346 | /** | |
347 | * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap. | |
348 | * @mask: %0 if @len is not a power of two, otherwise (@len - %1) | |
349 | * @offset: file offset of mapped area | |
350 | * @len: size of mapped area | |
351 | * @prot: mmap memory protection | |
352 | * @idx: index of this mmap | |
353 | * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu | |
354 | * mmap) otherwise %0 | |
d01508f2 AH |
355 | * @mmap_needed: set to %false for non-auxtrace events. This is needed because |
356 | * auxtrace mmapping is done in the same code path as non-auxtrace | |
357 | * mmapping but not every evsel that needs non-auxtrace mmapping | |
358 | * also needs auxtrace mmapping. | |
718c602d AH |
359 | * @cpu: cpu number for a per-cpu mmap otherwise %-1 |
360 | */ | |
361 | struct auxtrace_mmap_params { | |
362 | size_t mask; | |
363 | off_t offset; | |
364 | size_t len; | |
365 | int prot; | |
366 | int idx; | |
367 | pid_t tid; | |
d01508f2 | 368 | bool mmap_needed; |
6d18804b | 369 | struct perf_cpu cpu; |
718c602d AH |
370 | }; |
371 | ||
9e0cc4fe AH |
372 | /** |
373 | * struct auxtrace_record - callbacks for recording AUX area data. | |
374 | * @recording_options: validate and process recording options | |
375 | * @info_priv_size: return the size of the private data in auxtrace_info_event | |
376 | * @info_fill: fill-in the private data in auxtrace_info_event | |
377 | * @free: free this auxtrace record structure | |
d20031bb AH |
378 | * @snapshot_start: starting a snapshot |
379 | * @snapshot_finish: finishing a snapshot | |
380 | * @find_snapshot: find data to snapshot within auxtrace mmap | |
381 | * @parse_snapshot_options: parse snapshot options | |
9e0cc4fe AH |
382 | * @reference: provide a 64-bit reference number for auxtrace_event |
383 | * @read_finish: called after reading from an auxtrace mmap | |
b818ec61 | 384 | * @alignment: alignment (if any) for AUX area data |
f0bb7ee8 | 385 | * @default_aux_sample_size: default sample size for --aux sample option |
ad60ba0c AH |
386 | * @pmu: associated pmu |
387 | * @evlist: selected events list | |
9e0cc4fe AH |
388 | */ |
389 | struct auxtrace_record { | |
390 | int (*recording_options)(struct auxtrace_record *itr, | |
63503dba | 391 | struct evlist *evlist, |
9e0cc4fe | 392 | struct record_opts *opts); |
14a05e13 | 393 | size_t (*info_priv_size)(struct auxtrace_record *itr, |
63503dba | 394 | struct evlist *evlist); |
9e0cc4fe AH |
395 | int (*info_fill)(struct auxtrace_record *itr, |
396 | struct perf_session *session, | |
72932371 | 397 | struct perf_record_auxtrace_info *auxtrace_info, |
9e0cc4fe AH |
398 | size_t priv_size); |
399 | void (*free)(struct auxtrace_record *itr); | |
d20031bb AH |
400 | int (*snapshot_start)(struct auxtrace_record *itr); |
401 | int (*snapshot_finish)(struct auxtrace_record *itr); | |
402 | int (*find_snapshot)(struct auxtrace_record *itr, int idx, | |
403 | struct auxtrace_mmap *mm, unsigned char *data, | |
404 | u64 *head, u64 *old); | |
405 | int (*parse_snapshot_options)(struct auxtrace_record *itr, | |
406 | struct record_opts *opts, | |
407 | const char *str); | |
9e0cc4fe AH |
408 | u64 (*reference)(struct auxtrace_record *itr); |
409 | int (*read_finish)(struct auxtrace_record *itr, int idx); | |
83b2ea25 | 410 | unsigned int alignment; |
f0bb7ee8 | 411 | unsigned int default_aux_sample_size; |
ad60ba0c AH |
412 | struct perf_pmu *pmu; |
413 | struct evlist *evlist; | |
9e0cc4fe AH |
414 | }; |
415 | ||
1b36c03e AH |
416 | /** |
417 | * struct addr_filter - address filter. | |
418 | * @list: list node | |
419 | * @range: true if it is a range filter | |
420 | * @start: true if action is 'filter' or 'start' | |
421 | * @action: 'filter', 'start' or 'stop' ('tracestop' is accepted but converted | |
422 | * to 'stop') | |
423 | * @sym_from: symbol name for the filter address | |
424 | * @sym_to: symbol name that determines the filter size | |
425 | * @sym_from_idx: selects n'th from symbols with the same name (0 means global | |
426 | * and less than 0 means symbol must be unique) | |
427 | * @sym_to_idx: same as @sym_from_idx but for @sym_to | |
428 | * @addr: filter address | |
429 | * @size: filter region size (for range filters) | |
430 | * @filename: DSO file name or NULL for the kernel | |
431 | * @str: allocated string that contains the other string members | |
432 | */ | |
433 | struct addr_filter { | |
434 | struct list_head list; | |
435 | bool range; | |
436 | bool start; | |
437 | const char *action; | |
438 | const char *sym_from; | |
439 | const char *sym_to; | |
440 | int sym_from_idx; | |
441 | int sym_to_idx; | |
442 | u64 addr; | |
443 | u64 size; | |
444 | const char *filename; | |
445 | char *str; | |
446 | }; | |
447 | ||
448 | /** | |
449 | * struct addr_filters - list of address filters. | |
450 | * @head: list of address filters | |
451 | * @cnt: number of address filters | |
452 | */ | |
453 | struct addr_filters { | |
454 | struct list_head head; | |
455 | int cnt; | |
456 | }; | |
457 | ||
f2a39fe8 ACM |
458 | struct auxtrace_cache; |
459 | ||
e31f0d01 AH |
460 | #ifdef HAVE_AUXTRACE_SUPPORT |
461 | ||
bbc49f12 LY |
462 | u64 compat_auxtrace_mmap__read_head(struct auxtrace_mmap *mm); |
463 | int compat_auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail); | |
464 | ||
465 | static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm, | |
466 | int kernel_is_64_bit __maybe_unused) | |
718c602d AH |
467 | { |
468 | struct perf_event_mmap_page *pc = mm->userpg; | |
bbc49f12 LY |
469 | u64 head; |
470 | ||
471 | #if BITS_PER_LONG == 32 | |
472 | if (kernel_is_64_bit) | |
473 | return compat_auxtrace_mmap__read_head(mm); | |
474 | #endif | |
475 | head = READ_ONCE(pc->aux_head); | |
718c602d AH |
476 | |
477 | /* Ensure all reads are done after we read the head */ | |
bde1e7d9 | 478 | smp_rmb(); |
718c602d AH |
479 | return head; |
480 | } | |
481 | ||
bbc49f12 LY |
482 | static inline int auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail, |
483 | int kernel_is_64_bit __maybe_unused) | |
718c602d AH |
484 | { |
485 | struct perf_event_mmap_page *pc = mm->userpg; | |
718c602d | 486 | |
bbc49f12 LY |
487 | #if BITS_PER_LONG == 32 |
488 | if (kernel_is_64_bit) | |
489 | return compat_auxtrace_mmap__write_tail(mm, tail); | |
490 | #endif | |
718c602d | 491 | /* Ensure all reads are done before we write the tail out */ |
bde1e7d9 | 492 | smp_mb(); |
1ea3cb15 | 493 | WRITE_ONCE(pc->aux_tail, tail); |
bbc49f12 | 494 | return 0; |
718c602d AH |
495 | } |
496 | ||
497 | int auxtrace_mmap__mmap(struct auxtrace_mmap *mm, | |
498 | struct auxtrace_mmap_params *mp, | |
499 | void *userpg, int fd); | |
500 | void auxtrace_mmap__munmap(struct auxtrace_mmap *mm); | |
501 | void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp, | |
502 | off_t auxtrace_offset, | |
503 | unsigned int auxtrace_pages, | |
504 | bool auxtrace_overwrite); | |
505 | void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp, | |
d01508f2 | 506 | struct evlist *evlist, |
84bd5aba | 507 | struct evsel *evsel, int idx); |
718c602d | 508 | |
9e0cc4fe | 509 | typedef int (*process_auxtrace_t)(struct perf_tool *tool, |
a5830532 | 510 | struct mmap *map, |
9e0cc4fe AH |
511 | union perf_event *event, void *data1, |
512 | size_t len1, void *data2, size_t len2); | |
513 | ||
a5830532 | 514 | int auxtrace_mmap__read(struct mmap *map, struct auxtrace_record *itr, |
9e0cc4fe AH |
515 | struct perf_tool *tool, process_auxtrace_t fn); |
516 | ||
a5830532 | 517 | int auxtrace_mmap__read_snapshot(struct mmap *map, |
d20031bb AH |
518 | struct auxtrace_record *itr, |
519 | struct perf_tool *tool, process_auxtrace_t fn, | |
520 | size_t snapshot_size); | |
521 | ||
e5027893 AH |
522 | int auxtrace_queues__init(struct auxtrace_queues *queues); |
523 | int auxtrace_queues__add_event(struct auxtrace_queues *queues, | |
524 | struct perf_session *session, | |
525 | union perf_event *event, off_t data_offset, | |
526 | struct auxtrace_buffer **buffer_ptr); | |
ac2f445f AH |
527 | struct auxtrace_queue * |
528 | auxtrace_queues__sample_queue(struct auxtrace_queues *queues, | |
529 | struct perf_sample *sample, | |
530 | struct perf_session *session); | |
531 | int auxtrace_queues__add_sample(struct auxtrace_queues *queues, | |
532 | struct perf_session *session, | |
533 | struct perf_sample *sample, u64 data_offset, | |
534 | u64 reference); | |
e5027893 | 535 | void auxtrace_queues__free(struct auxtrace_queues *queues); |
99fa2984 AH |
536 | int auxtrace_queues__process_index(struct auxtrace_queues *queues, |
537 | struct perf_session *session); | |
ac2f445f AH |
538 | int auxtrace_queue_data(struct perf_session *session, bool samples, |
539 | bool events); | |
e5027893 AH |
540 | struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue, |
541 | struct auxtrace_buffer *buffer); | |
6aa3afc9 AH |
542 | void *auxtrace_buffer__get_data_rw(struct auxtrace_buffer *buffer, int fd, bool rw); |
543 | static inline void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd) | |
544 | { | |
545 | return auxtrace_buffer__get_data_rw(buffer, fd, false); | |
546 | } | |
e5027893 AH |
547 | void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer); |
548 | void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer); | |
549 | void auxtrace_buffer__free(struct auxtrace_buffer *buffer); | |
f9397155 AH |
550 | |
551 | int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr, | |
552 | u64 ordinal); | |
553 | void auxtrace_heap__pop(struct auxtrace_heap *heap); | |
554 | void auxtrace_heap__free(struct auxtrace_heap *heap); | |
555 | ||
c3278f02 AH |
556 | struct auxtrace_cache_entry { |
557 | struct hlist_node hash; | |
558 | u32 key; | |
559 | }; | |
560 | ||
561 | struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size, | |
562 | unsigned int limit_percent); | |
563 | void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache); | |
564 | void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c); | |
565 | void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry); | |
566 | int auxtrace_cache__add(struct auxtrace_cache *c, u32 key, | |
567 | struct auxtrace_cache_entry *entry); | |
fd62c109 | 568 | void auxtrace_cache__remove(struct auxtrace_cache *c, u32 key); |
c3278f02 AH |
569 | void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key); |
570 | ||
63503dba | 571 | struct auxtrace_record *auxtrace_record__init(struct evlist *evlist, |
9e0cc4fe AH |
572 | int *err); |
573 | ||
d20031bb AH |
574 | int auxtrace_parse_snapshot_options(struct auxtrace_record *itr, |
575 | struct record_opts *opts, | |
576 | const char *str); | |
f0bb7ee8 AH |
577 | int auxtrace_parse_sample_options(struct auxtrace_record *itr, |
578 | struct evlist *evlist, | |
579 | struct record_opts *opts, const char *str); | |
d58b3f7e | 580 | void auxtrace_regroup_aux_output(struct evlist *evlist); |
9e0cc4fe | 581 | int auxtrace_record__options(struct auxtrace_record *itr, |
63503dba | 582 | struct evlist *evlist, |
9e0cc4fe | 583 | struct record_opts *opts); |
14a05e13 | 584 | size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr, |
63503dba | 585 | struct evlist *evlist); |
9e0cc4fe AH |
586 | int auxtrace_record__info_fill(struct auxtrace_record *itr, |
587 | struct perf_session *session, | |
72932371 | 588 | struct perf_record_auxtrace_info *auxtrace_info, |
9e0cc4fe AH |
589 | size_t priv_size); |
590 | void auxtrace_record__free(struct auxtrace_record *itr); | |
d20031bb | 591 | int auxtrace_record__snapshot_start(struct auxtrace_record *itr); |
ce7b0e42 | 592 | int auxtrace_record__snapshot_finish(struct auxtrace_record *itr, bool on_exit); |
d20031bb AH |
593 | int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx, |
594 | struct auxtrace_mmap *mm, | |
595 | unsigned char *data, u64 *head, u64 *old); | |
9e0cc4fe | 596 | u64 auxtrace_record__reference(struct auxtrace_record *itr); |
ad60ba0c | 597 | int auxtrace_record__read_finish(struct auxtrace_record *itr, int idx); |
9e0cc4fe | 598 | |
99fa2984 AH |
599 | int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event, |
600 | off_t file_offset); | |
601 | int auxtrace_index__write(int fd, struct list_head *head); | |
602 | int auxtrace_index__process(int fd, u64 size, struct perf_session *session, | |
603 | bool needs_swap); | |
604 | void auxtrace_index__free(struct list_head *head); | |
605 | ||
7151c1d1 AH |
606 | void auxtrace_synth_guest_error(struct perf_record_auxtrace_error *auxtrace_error, int type, |
607 | int code, int cpu, pid_t pid, pid_t tid, u64 ip, | |
608 | const char *msg, u64 timestamp, | |
609 | pid_t machine_pid, int vcpu); | |
72932371 | 610 | void auxtrace_synth_error(struct perf_record_auxtrace_error *auxtrace_error, int type, |
85ed4729 | 611 | int code, int cpu, pid_t pid, pid_t tid, u64 ip, |
16bd4321 | 612 | const char *msg, u64 timestamp); |
85ed4729 | 613 | |
89f1688a JO |
614 | int perf_event__process_auxtrace_info(struct perf_session *session, |
615 | union perf_event *event); | |
7336555a JO |
616 | s64 perf_event__process_auxtrace(struct perf_session *session, |
617 | union perf_event *event); | |
89f1688a JO |
618 | int perf_event__process_auxtrace_error(struct perf_session *session, |
619 | union perf_event *event); | |
e621b8ff AH |
620 | int itrace_do_parse_synth_opts(struct itrace_synth_opts *synth_opts, |
621 | const char *str, int unset); | |
f6986c95 AH |
622 | int itrace_parse_synth_opts(const struct option *opt, const char *str, |
623 | int unset); | |
4eb06815 AK |
624 | void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts, |
625 | bool no_sample); | |
9e0cc4fe | 626 | |
85ed4729 AH |
627 | size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp); |
628 | void perf_session__auxtrace_error_inc(struct perf_session *session, | |
629 | union perf_event *event); | |
630 | void events_stats__auxtrace_error_warn(const struct events_stats *stats); | |
631 | ||
1b36c03e AH |
632 | void addr_filters__init(struct addr_filters *filts); |
633 | void addr_filters__exit(struct addr_filters *filts); | |
634 | int addr_filters__parse_bare_filter(struct addr_filters *filts, | |
635 | const char *filter); | |
63503dba | 636 | int auxtrace_parse_filters(struct evlist *evlist); |
1b36c03e | 637 | |
f2a39fe8 ACM |
638 | int auxtrace__process_event(struct perf_session *session, union perf_event *event, |
639 | struct perf_sample *sample, struct perf_tool *tool); | |
b04b8dd1 AH |
640 | void auxtrace__dump_auxtrace_sample(struct perf_session *session, |
641 | struct perf_sample *sample); | |
f2a39fe8 ACM |
642 | int auxtrace__flush_events(struct perf_session *session, struct perf_tool *tool); |
643 | void auxtrace__free_events(struct perf_session *session); | |
644 | void auxtrace__free(struct perf_session *session); | |
853f37d7 AH |
645 | bool auxtrace__evsel_is_auxtrace(struct perf_session *session, |
646 | struct evsel *evsel); | |
c446870d | 647 | |
c12e039d | 648 | #define ITRACE_HELP \ |
1e8f7869 | 649 | " i[period]: synthesize instructions events\n" \ |
7e55b956 | 650 | " y[period]: synthesize cycles events (same period as i)\n" \ |
9f74d770 | 651 | " b: synthesize branches events (branch misses for Arm SPE)\n" \ |
c12e039d AK |
652 | " c: synthesize branches events (calls only)\n" \ |
653 | " r: synthesize branches events (returns only)\n" \ | |
654 | " x: synthesize transactions events\n" \ | |
655 | " w: synthesize ptwrite events\n" \ | |
656 | " p: synthesize power events\n" \ | |
1e8f7869 AH |
657 | " o: synthesize other events recorded due to the use\n" \ |
658 | " of aux-output (refer to perf record)\n" \ | |
8ee9a9ab AH |
659 | " I: synthesize interrupt or similar (asynchronous) events\n" \ |
660 | " (e.g. Intel PT Event Trace)\n" \ | |
cb971438 AH |
661 | " e[flags]: synthesize error events\n" \ |
662 | " each flag must be preceded by + or -\n" \ | |
663 | " error flags are: o (overflow)\n" \ | |
664 | " l (data lost)\n" \ | |
935aac2d AH |
665 | " d[flags]: create a debug log\n" \ |
666 | " each flag must be preceded by + or -\n" \ | |
667 | " log flags are: a (all perf events)\n" \ | |
4b2b2c6a | 668 | " o (output to stdout)\n" \ |
9f74d770 TX |
669 | " f: synthesize first level cache events\n" \ |
670 | " m: synthesize last level cache events\n" \ | |
671 | " t: synthesize TLB events\n" \ | |
672 | " a: synthesize remote access events\n" \ | |
c12e039d | 673 | " g[len]: synthesize a call chain (use with i or x)\n" \ |
1e8f7869 | 674 | " G[len]: synthesize a call chain on existing event records\n" \ |
c12e039d | 675 | " l[len]: synthesize last branch entries (use with i or x)\n" \ |
1e8f7869 | 676 | " L[len]: synthesize last branch entries on existing event records\n" \ |
c12e039d | 677 | " sNUMBER: skip initial number of events\n" \ |
51971536 | 678 | " q: quicker (less detailed) decoding\n" \ |
b6778fe1 | 679 | " A: approximate IPC\n" \ |
cf14013b | 680 | " Z: prefer to ignore timestamps (so-called \"timeless\" decoding)\n" \ |
c12e039d | 681 | " PERIOD[ns|us|ms|i|t]: specify period to sample stream\n" \ |
7e55b956 | 682 | " concatenate multiple options. Default is iybxwpe or cewp\n" |
c12e039d | 683 | |
33526f36 AH |
684 | static inline |
685 | void itrace_synth_opts__set_time_range(struct itrace_synth_opts *opts, | |
686 | struct perf_time_interval *ptime_range, | |
687 | int range_num) | |
688 | { | |
689 | opts->ptime_range = ptime_range; | |
690 | opts->range_num = range_num; | |
691 | } | |
692 | ||
693 | static inline | |
694 | void itrace_synth_opts__clear_time_range(struct itrace_synth_opts *opts) | |
695 | { | |
696 | opts->ptime_range = NULL; | |
697 | opts->range_num = 0; | |
698 | } | |
c12e039d | 699 | |
e31f0d01 | 700 | #else |
b4209025 | 701 | #include "debug.h" |
e31f0d01 AH |
702 | |
703 | static inline struct auxtrace_record * | |
63503dba | 704 | auxtrace_record__init(struct evlist *evlist __maybe_unused, |
b8f8eb84 | 705 | int *err) |
e31f0d01 AH |
706 | { |
707 | *err = 0; | |
708 | return NULL; | |
709 | } | |
710 | ||
711 | static inline | |
712 | void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused) | |
713 | { | |
714 | } | |
715 | ||
e31f0d01 AH |
716 | static inline |
717 | int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused, | |
63503dba | 718 | struct evlist *evlist __maybe_unused, |
e31f0d01 AH |
719 | struct record_opts *opts __maybe_unused) |
720 | { | |
721 | return 0; | |
722 | } | |
723 | ||
04612968 ACM |
724 | static inline |
725 | int perf_event__process_auxtrace_info(struct perf_session *session __maybe_unused, | |
726 | union perf_event *event __maybe_unused) | |
727 | { | |
728 | return 0; | |
729 | } | |
730 | ||
731 | static inline | |
732 | s64 perf_event__process_auxtrace(struct perf_session *session __maybe_unused, | |
733 | union perf_event *event __maybe_unused) | |
734 | { | |
735 | return 0; | |
736 | } | |
737 | ||
738 | static inline | |
739 | int perf_event__process_auxtrace_error(struct perf_session *session __maybe_unused, | |
740 | union perf_event *event __maybe_unused) | |
741 | { | |
742 | return 0; | |
743 | } | |
e31f0d01 AH |
744 | |
745 | static inline | |
746 | void perf_session__auxtrace_error_inc(struct perf_session *session | |
747 | __maybe_unused, | |
748 | union perf_event *event | |
749 | __maybe_unused) | |
750 | { | |
751 | } | |
752 | ||
753 | static inline | |
754 | void events_stats__auxtrace_error_warn(const struct events_stats *stats | |
755 | __maybe_unused) | |
756 | { | |
757 | } | |
758 | ||
e621b8ff AH |
759 | static inline |
760 | int itrace_do_parse_synth_opts(struct itrace_synth_opts *synth_opts __maybe_unused, | |
761 | const char *str __maybe_unused, int unset __maybe_unused) | |
762 | { | |
763 | pr_err("AUX area tracing not supported\n"); | |
764 | return -EINVAL; | |
765 | } | |
766 | ||
e31f0d01 AH |
767 | static inline |
768 | int itrace_parse_synth_opts(const struct option *opt __maybe_unused, | |
769 | const char *str __maybe_unused, | |
770 | int unset __maybe_unused) | |
771 | { | |
772 | pr_err("AUX area tracing not supported\n"); | |
773 | return -EINVAL; | |
774 | } | |
775 | ||
2dd6d8a1 AH |
776 | static inline |
777 | int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused, | |
778 | struct record_opts *opts __maybe_unused, | |
779 | const char *str) | |
f0bb7ee8 AH |
780 | { |
781 | if (!str) | |
782 | return 0; | |
783 | pr_err("AUX area tracing not supported\n"); | |
784 | return -EINVAL; | |
785 | } | |
786 | ||
787 | static inline | |
788 | int auxtrace_parse_sample_options(struct auxtrace_record *itr __maybe_unused, | |
789 | struct evlist *evlist __maybe_unused, | |
790 | struct record_opts *opts __maybe_unused, | |
791 | const char *str) | |
2dd6d8a1 AH |
792 | { |
793 | if (!str) | |
794 | return 0; | |
795 | pr_err("AUX area tracing not supported\n"); | |
796 | return -EINVAL; | |
797 | } | |
798 | ||
d58b3f7e AH |
799 | static inline |
800 | void auxtrace_regroup_aux_output(struct evlist *evlist __maybe_unused) | |
801 | { | |
802 | } | |
803 | ||
e31f0d01 AH |
804 | static inline |
805 | int auxtrace__process_event(struct perf_session *session __maybe_unused, | |
806 | union perf_event *event __maybe_unused, | |
807 | struct perf_sample *sample __maybe_unused, | |
808 | struct perf_tool *tool __maybe_unused) | |
809 | { | |
810 | return 0; | |
811 | } | |
812 | ||
b04b8dd1 AH |
813 | static inline |
814 | void auxtrace__dump_auxtrace_sample(struct perf_session *session __maybe_unused, | |
815 | struct perf_sample *sample __maybe_unused) | |
816 | { | |
817 | } | |
818 | ||
e31f0d01 AH |
819 | static inline |
820 | int auxtrace__flush_events(struct perf_session *session __maybe_unused, | |
821 | struct perf_tool *tool __maybe_unused) | |
822 | { | |
823 | return 0; | |
824 | } | |
825 | ||
826 | static inline | |
827 | void auxtrace__free_events(struct perf_session *session __maybe_unused) | |
828 | { | |
829 | } | |
830 | ||
831 | static inline | |
832 | void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused) | |
833 | { | |
834 | } | |
835 | ||
836 | static inline | |
837 | void auxtrace__free(struct perf_session *session __maybe_unused) | |
838 | { | |
839 | } | |
840 | ||
841 | static inline | |
842 | int auxtrace_index__write(int fd __maybe_unused, | |
843 | struct list_head *head __maybe_unused) | |
844 | { | |
845 | return -EINVAL; | |
846 | } | |
847 | ||
848 | static inline | |
849 | int auxtrace_index__process(int fd __maybe_unused, | |
850 | u64 size __maybe_unused, | |
851 | struct perf_session *session __maybe_unused, | |
852 | bool needs_swap __maybe_unused) | |
853 | { | |
854 | return -EINVAL; | |
855 | } | |
856 | ||
857 | static inline | |
858 | void auxtrace_index__free(struct list_head *head __maybe_unused) | |
859 | { | |
860 | } | |
861 | ||
853f37d7 AH |
862 | static inline |
863 | bool auxtrace__evsel_is_auxtrace(struct perf_session *session __maybe_unused, | |
864 | struct evsel *evsel __maybe_unused) | |
865 | { | |
866 | return false; | |
867 | } | |
868 | ||
1b36c03e | 869 | static inline |
63503dba | 870 | int auxtrace_parse_filters(struct evlist *evlist __maybe_unused) |
1b36c03e AH |
871 | { |
872 | return 0; | |
873 | } | |
874 | ||
e31f0d01 AH |
875 | int auxtrace_mmap__mmap(struct auxtrace_mmap *mm, |
876 | struct auxtrace_mmap_params *mp, | |
877 | void *userpg, int fd); | |
878 | void auxtrace_mmap__munmap(struct auxtrace_mmap *mm); | |
879 | void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp, | |
880 | off_t auxtrace_offset, | |
881 | unsigned int auxtrace_pages, | |
882 | bool auxtrace_overwrite); | |
883 | void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp, | |
d01508f2 | 884 | struct evlist *evlist, |
84bd5aba | 885 | struct evsel *evsel, int idx); |
e31f0d01 | 886 | |
c12e039d AK |
887 | #define ITRACE_HELP "" |
888 | ||
33526f36 AH |
889 | static inline |
890 | void itrace_synth_opts__set_time_range(struct itrace_synth_opts *opts | |
891 | __maybe_unused, | |
892 | struct perf_time_interval *ptime_range | |
893 | __maybe_unused, | |
894 | int range_num __maybe_unused) | |
895 | { | |
896 | } | |
897 | ||
898 | static inline | |
899 | void itrace_synth_opts__clear_time_range(struct itrace_synth_opts *opts | |
900 | __maybe_unused) | |
901 | { | |
902 | } | |
903 | ||
e31f0d01 AH |
904 | #endif |
905 | ||
718c602d | 906 | #endif |