1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_RECORD_H
3 #define __PERF_RECORD_H
5 * The linux/stddef.h isn't need here, but is needed for __always_inline used
6 * in files included from uapi/linux/perf_event.h such as
7 * /usr/include/linux/swab.h and /usr/include/linux/byteorder/little_endian.h,
8 * detected in at least musl libc, used in Alpine Linux. -acme
11 #include <linux/stddef.h>
12 #include <perf/event.h>
13 #include <linux/types.h>
15 #include "perf_regs.h"
19 struct perf_event_attr;
23 * /usr/include/inttypes.h uses just 'lu' for PRIu64, but we end up defining
24 * __u64 as long long unsigned int, and then -Werror=format= kicks in and
25 * complains of the mismatched types, so use these two special extra PRI
26 * macros to overcome that.
28 #define PRI_lu64 "l" PRIu64
29 #define PRI_lx64 "l" PRIx64
30 #define PRI_ld64 "l" PRId64
32 #define PRI_lu64 PRIu64
33 #define PRI_lx64 PRIx64
34 #define PRI_ld64 PRId64
37 #define PERF_SAMPLE_MASK \
38 (PERF_SAMPLE_IP | PERF_SAMPLE_TID | \
39 PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR | \
40 PERF_SAMPLE_ID | PERF_SAMPLE_STREAM_ID | \
41 PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD | \
42 PERF_SAMPLE_IDENTIFIER)
44 /* perf sample has 16 bits size limit */
45 #define PERF_SAMPLE_MAX_SIZE (1 << 16)
52 /* Cached values/mask filled by first register access. */
53 u64 cache_regs[PERF_REGS_MAX];
63 struct sample_read_value {
74 struct sample_read_value *values;
76 struct sample_read_value one;
88 PERF_IP_FLAG_BRANCH = 1ULL << 0,
89 PERF_IP_FLAG_CALL = 1ULL << 1,
90 PERF_IP_FLAG_RETURN = 1ULL << 2,
91 PERF_IP_FLAG_CONDITIONAL = 1ULL << 3,
92 PERF_IP_FLAG_SYSCALLRET = 1ULL << 4,
93 PERF_IP_FLAG_ASYNC = 1ULL << 5,
94 PERF_IP_FLAG_INTERRUPT = 1ULL << 6,
95 PERF_IP_FLAG_TX_ABORT = 1ULL << 7,
96 PERF_IP_FLAG_TRACE_BEGIN = 1ULL << 8,
97 PERF_IP_FLAG_TRACE_END = 1ULL << 9,
98 PERF_IP_FLAG_IN_TX = 1ULL << 10,
101 #define PERF_IP_FLAG_CHARS "bcrosyiABEx"
103 #define PERF_BRANCH_MASK (\
104 PERF_IP_FLAG_BRANCH |\
106 PERF_IP_FLAG_RETURN |\
107 PERF_IP_FLAG_CONDITIONAL |\
108 PERF_IP_FLAG_SYSCALLRET |\
109 PERF_IP_FLAG_ASYNC |\
110 PERF_IP_FLAG_INTERRUPT |\
111 PERF_IP_FLAG_TX_ABORT |\
112 PERF_IP_FLAG_TRACE_BEGIN |\
113 PERF_IP_FLAG_TRACE_END)
144 bool no_hw_idx; /* No hw_idx collected in branch_stack */
147 struct ip_callchain *callchain;
148 struct branch_stack *branch_stack;
149 struct regs_dump user_regs;
150 struct regs_dump intr_regs;
151 struct stack_dump user_stack;
152 struct sample_read read;
153 struct aux_sample aux_sample;
156 #define PERF_MEM_DATA_SRC_NONE \
157 (PERF_MEM_S(OP, NA) |\
158 PERF_MEM_S(LVL, NA) |\
159 PERF_MEM_S(SNOOP, NA) |\
160 PERF_MEM_S(LOCK, NA) |\
163 /* Attribute type for custom synthesized events */
164 #define PERF_TYPE_SYNTH (INT_MAX + 1U)
166 /* Attribute config for custom synthesized events */
168 PERF_SYNTH_INTEL_PTWRITE,
169 PERF_SYNTH_INTEL_MWAIT,
170 PERF_SYNTH_INTEL_PWRE,
171 PERF_SYNTH_INTEL_EXSTOP,
172 PERF_SYNTH_INTEL_PWRX,
173 PERF_SYNTH_INTEL_CBR,
177 * Raw data formats for synthesized events. Note that 4 bytes of padding are
178 * present to match the 'size' member of PERF_SAMPLE_RAW data which is always
179 * 8-byte aligned. That means we must dereference raw_data with an offset of 4.
180 * Refer perf_sample__synth_ptr() and perf_synth__raw_data(). It also means the
181 * structure sizes are 4 bytes bigger than the raw_size, refer
182 * perf_synth__raw_size().
185 struct perf_synth_intel_ptwrite {
197 struct perf_synth_intel_mwait {
211 struct perf_synth_intel_pwre {
226 struct perf_synth_intel_exstop {
237 struct perf_synth_intel_pwrx {
242 u64 deepest_cstate : 4,
251 struct perf_synth_intel_cbr {
267 * raw_data is always 4 bytes from an 8-byte boundary, so subtract 4 to get
270 static inline void *perf_sample__synth_ptr(struct perf_sample *sample)
272 return sample->raw_data - 4;
275 static inline void *perf_synth__raw_data(void *p)
280 #define perf_synth__raw_size(d) (sizeof(d) - 4)
282 #define perf_sample__bad_synth_size(s, d) ((s)->raw_size < sizeof(d) - 4)
285 PERF_STAT_ROUND_TYPE__INTERVAL = 0,
286 PERF_STAT_ROUND_TYPE__FINAL = 1,
289 void perf_event__print_totals(void);
292 struct perf_record_stat_config;
293 struct perf_stat_config;
296 void perf_event__read_stat_config(struct perf_stat_config *config,
297 struct perf_record_stat_config *event);
299 int perf_event__process_comm(struct perf_tool *tool,
300 union perf_event *event,
301 struct perf_sample *sample,
302 struct machine *machine);
303 int perf_event__process_lost(struct perf_tool *tool,
304 union perf_event *event,
305 struct perf_sample *sample,
306 struct machine *machine);
307 int perf_event__process_lost_samples(struct perf_tool *tool,
308 union perf_event *event,
309 struct perf_sample *sample,
310 struct machine *machine);
311 int perf_event__process_aux(struct perf_tool *tool,
312 union perf_event *event,
313 struct perf_sample *sample,
314 struct machine *machine);
315 int perf_event__process_itrace_start(struct perf_tool *tool,
316 union perf_event *event,
317 struct perf_sample *sample,
318 struct machine *machine);
319 int perf_event__process_switch(struct perf_tool *tool,
320 union perf_event *event,
321 struct perf_sample *sample,
322 struct machine *machine);
323 int perf_event__process_namespaces(struct perf_tool *tool,
324 union perf_event *event,
325 struct perf_sample *sample,
326 struct machine *machine);
327 int perf_event__process_cgroup(struct perf_tool *tool,
328 union perf_event *event,
329 struct perf_sample *sample,
330 struct machine *machine);
331 int perf_event__process_mmap(struct perf_tool *tool,
332 union perf_event *event,
333 struct perf_sample *sample,
334 struct machine *machine);
335 int perf_event__process_mmap2(struct perf_tool *tool,
336 union perf_event *event,
337 struct perf_sample *sample,
338 struct machine *machine);
339 int perf_event__process_fork(struct perf_tool *tool,
340 union perf_event *event,
341 struct perf_sample *sample,
342 struct machine *machine);
343 int perf_event__process_exit(struct perf_tool *tool,
344 union perf_event *event,
345 struct perf_sample *sample,
346 struct machine *machine);
347 int perf_event__process_ksymbol(struct perf_tool *tool,
348 union perf_event *event,
349 struct perf_sample *sample,
350 struct machine *machine);
351 int perf_event__process_bpf(struct perf_tool *tool,
352 union perf_event *event,
353 struct perf_sample *sample,
354 struct machine *machine);
355 int perf_event__process_text_poke(struct perf_tool *tool,
356 union perf_event *event,
357 struct perf_sample *sample,
358 struct machine *machine);
359 int perf_event__process(struct perf_tool *tool,
360 union perf_event *event,
361 struct perf_sample *sample,
362 struct machine *machine);
364 struct addr_location;
366 int machine__resolve(struct machine *machine, struct addr_location *al,
367 struct perf_sample *sample);
369 void addr_location__put(struct addr_location *al);
373 bool is_bts_event(struct perf_event_attr *attr);
374 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
375 void thread__resolve(struct thread *thread, struct addr_location *al,
376 struct perf_sample *sample);
378 const char *perf_event__name(unsigned int id);
380 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
381 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
382 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
383 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
384 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
385 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
386 size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
387 size_t perf_event__fprintf_thread_map(union perf_event *event, FILE *fp);
388 size_t perf_event__fprintf_cpu_map(union perf_event *event, FILE *fp);
389 size_t perf_event__fprintf_namespaces(union perf_event *event, FILE *fp);
390 size_t perf_event__fprintf_cgroup(union perf_event *event, FILE *fp);
391 size_t perf_event__fprintf_ksymbol(union perf_event *event, FILE *fp);
392 size_t perf_event__fprintf_bpf(union perf_event *event, FILE *fp);
393 size_t perf_event__fprintf_text_poke(union perf_event *event, struct machine *machine,FILE *fp);
394 size_t perf_event__fprintf(union perf_event *event, struct machine *machine, FILE *fp);
396 int kallsyms__get_function_start(const char *kallsyms_filename,
397 const char *symbol_name, u64 *addr);
399 void *cpu_map_data__alloc(struct perf_cpu_map *map, size_t *size, u16 *type, int *max);
400 void cpu_map_data__synthesize(struct perf_record_cpu_map_data *data, struct perf_cpu_map *map,
403 void event_attr_init(struct perf_event_attr *attr);
405 int perf_event_paranoid(void);
406 bool perf_event_paranoid_check(int max_level);
408 extern int sysctl_perf_event_max_stack;
409 extern int sysctl_perf_event_max_contexts_per_stack;
410 extern unsigned int proc_map_timeout;
412 #define PAGE_SIZE_NAME_LEN 32
413 char *get_page_size_name(u64 size, char *str);
415 #endif /* __PERF_RECORD_H */