1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __PERF_RECORD_H 3 #define __PERF_RECORD_H 4 /* 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 9 */ 10 #include <stdio.h> 11 #include <linux/stddef.h> 12 #include <perf/event.h> 13 #include <linux/types.h> 14 15 struct dso; 16 struct machine; 17 struct perf_event_attr; 18 struct perf_sample; 19 20 #ifdef __LP64__ 21 /* 22 * /usr/include/inttypes.h uses just 'lu' for PRIu64, but we end up defining 23 * __u64 as long long unsigned int, and then -Werror=format= kicks in and 24 * complains of the mismatched types, so use these two special extra PRI 25 * macros to overcome that. 26 */ 27 #define PRI_lu64 "l" PRIu64 28 #define PRI_lx64 "l" PRIx64 29 #define PRI_ld64 "l" PRId64 30 #else 31 #define PRI_lu64 PRIu64 32 #define PRI_lx64 PRIx64 33 #define PRI_ld64 PRId64 34 #endif 35 36 #define PERF_SAMPLE_MASK \ 37 (PERF_SAMPLE_IP | PERF_SAMPLE_TID | \ 38 PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR | \ 39 PERF_SAMPLE_ID | PERF_SAMPLE_STREAM_ID | \ 40 PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD | \ 41 PERF_SAMPLE_IDENTIFIER) 42 43 /* perf sample has 16 bits size limit */ 44 #define PERF_SAMPLE_MAX_SIZE (1 << 16) 45 46 struct ip_callchain { 47 u64 nr; 48 u64 ips[]; 49 }; 50 51 struct branch_stack; 52 53 enum { 54 PERF_IP_FLAG_BRANCH = 1ULL << 0, 55 PERF_IP_FLAG_CALL = 1ULL << 1, 56 PERF_IP_FLAG_RETURN = 1ULL << 2, 57 PERF_IP_FLAG_CONDITIONAL = 1ULL << 3, 58 PERF_IP_FLAG_SYSCALLRET = 1ULL << 4, 59 PERF_IP_FLAG_ASYNC = 1ULL << 5, 60 PERF_IP_FLAG_INTERRUPT = 1ULL << 6, 61 PERF_IP_FLAG_TX_ABORT = 1ULL << 7, 62 PERF_IP_FLAG_TRACE_BEGIN = 1ULL << 8, 63 PERF_IP_FLAG_TRACE_END = 1ULL << 9, 64 PERF_IP_FLAG_IN_TX = 1ULL << 10, 65 PERF_IP_FLAG_VMENTRY = 1ULL << 11, 66 PERF_IP_FLAG_VMEXIT = 1ULL << 12, 67 PERF_IP_FLAG_INTR_DISABLE = 1ULL << 13, 68 PERF_IP_FLAG_INTR_TOGGLE = 1ULL << 14, 69 PERF_IP_FLAG_BRANCH_MISS = 1ULL << 15, 70 PERF_IP_FLAG_NOT_TAKEN = 1ULL << 16, 71 }; 72 73 #define PERF_IP_FLAG_CHARS "bcrosyiABExghDtmn" 74 75 #define PERF_ADDITIONAL_STATE_MASK \ 76 (PERF_IP_FLAG_IN_TX | \ 77 PERF_IP_FLAG_INTR_DISABLE | \ 78 PERF_IP_FLAG_INTR_TOGGLE) 79 80 #define PERF_BRANCH_MASK (\ 81 PERF_IP_FLAG_BRANCH |\ 82 PERF_IP_FLAG_CALL |\ 83 PERF_IP_FLAG_RETURN |\ 84 PERF_IP_FLAG_CONDITIONAL |\ 85 PERF_IP_FLAG_SYSCALLRET |\ 86 PERF_IP_FLAG_ASYNC |\ 87 PERF_IP_FLAG_INTERRUPT |\ 88 PERF_IP_FLAG_TX_ABORT |\ 89 PERF_IP_FLAG_TRACE_BEGIN |\ 90 PERF_IP_FLAG_TRACE_END |\ 91 PERF_IP_FLAG_VMENTRY |\ 92 PERF_IP_FLAG_VMEXIT) 93 94 #define PERF_IP_FLAG_BRANCH_EVENT_MASK \ 95 (PERF_IP_FLAG_BRANCH_MISS | \ 96 PERF_IP_FLAG_NOT_TAKEN) 97 98 #define PERF_MEM_DATA_SRC_NONE \ 99 (PERF_MEM_S(OP, NA) |\ 100 PERF_MEM_S(LVL, NA) |\ 101 PERF_MEM_S(SNOOP, NA) |\ 102 PERF_MEM_S(LOCK, NA) |\ 103 PERF_MEM_S(TLB, NA) |\ 104 PERF_MEM_S(LVLNUM, NA)) 105 106 /* Attribute type for custom synthesized events */ 107 #define PERF_TYPE_SYNTH (INT_MAX + 1U) 108 109 /* Attribute config for custom synthesized events */ 110 enum perf_synth_id { 111 PERF_SYNTH_INTEL_PTWRITE, 112 PERF_SYNTH_INTEL_MWAIT, 113 PERF_SYNTH_INTEL_PWRE, 114 PERF_SYNTH_INTEL_EXSTOP, 115 PERF_SYNTH_INTEL_PWRX, 116 PERF_SYNTH_INTEL_CBR, 117 PERF_SYNTH_INTEL_PSB, 118 PERF_SYNTH_INTEL_EVT, 119 PERF_SYNTH_INTEL_IFLAG_CHG, 120 }; 121 122 /* 123 * Raw data formats for synthesized events. Note that 4 bytes of padding are 124 * present to match the 'size' member of PERF_SAMPLE_RAW data which is always 125 * 8-byte aligned. That means we must dereference raw_data with an offset of 4. 126 * Refer perf_sample__synth_ptr() and perf_synth__raw_data(). It also means the 127 * structure sizes are 4 bytes bigger than the raw_size, refer 128 * perf_synth__raw_size(). 129 */ 130 131 struct perf_synth_intel_ptwrite { 132 u32 padding; 133 union { 134 struct { 135 u32 ip : 1, 136 reserved : 31; 137 }; 138 u32 flags; 139 }; 140 u64 payload; 141 }; 142 143 struct perf_synth_intel_mwait { 144 u32 padding; 145 u32 reserved; 146 union { 147 struct { 148 u64 hints : 8, 149 reserved1 : 24, 150 extensions : 2, 151 reserved2 : 30; 152 }; 153 u64 payload; 154 }; 155 }; 156 157 struct perf_synth_intel_pwre { 158 u32 padding; 159 u32 reserved; 160 union { 161 struct { 162 u64 reserved1 : 7, 163 hw : 1, 164 subcstate : 4, 165 cstate : 4, 166 reserved2 : 48; 167 }; 168 u64 payload; 169 }; 170 }; 171 172 struct perf_synth_intel_exstop { 173 u32 padding; 174 union { 175 struct { 176 u32 ip : 1, 177 reserved : 31; 178 }; 179 u32 flags; 180 }; 181 }; 182 183 struct perf_synth_intel_pwrx { 184 u32 padding; 185 u32 reserved; 186 union { 187 struct { 188 u64 deepest_cstate : 4, 189 last_cstate : 4, 190 wake_reason : 4, 191 reserved1 : 52; 192 }; 193 u64 payload; 194 }; 195 }; 196 197 struct perf_synth_intel_cbr { 198 u32 padding; 199 union { 200 struct { 201 u32 cbr : 8, 202 reserved1 : 8, 203 max_nonturbo : 8, 204 reserved2 : 8; 205 }; 206 u32 flags; 207 }; 208 u32 freq; 209 u32 reserved3; 210 }; 211 212 struct perf_synth_intel_psb { 213 u32 padding; 214 u32 reserved; 215 u64 offset; 216 }; 217 218 struct perf_synth_intel_evd { 219 union { 220 struct { 221 u8 evd_type; 222 u8 reserved[7]; 223 }; 224 u64 et; 225 }; 226 u64 payload; 227 }; 228 229 /* Intel PT Event Trace */ 230 struct perf_synth_intel_evt { 231 u32 padding; 232 union { 233 struct { 234 u32 type : 5, 235 reserved : 2, 236 ip : 1, 237 vector : 8, 238 evd_cnt : 16; 239 }; 240 u32 cfe; 241 }; 242 struct perf_synth_intel_evd evd[0]; 243 }; 244 245 struct perf_synth_intel_iflag_chg { 246 u32 padding; 247 union { 248 struct { 249 u32 iflag : 1, 250 via_branch : 1; 251 }; 252 u32 flags; 253 }; 254 u64 branch_ip; /* If via_branch */ 255 }; 256 257 static inline void *perf_synth__raw_data(void *p) 258 { 259 return p + 4; 260 } 261 262 #define perf_synth__raw_size(d) (sizeof(d) - 4) 263 264 #define perf_sample__bad_synth_size(s, d) ((s)->raw_size < sizeof(d) - 4) 265 266 enum { 267 PERF_STAT_ROUND_TYPE__INTERVAL = 0, 268 PERF_STAT_ROUND_TYPE__FINAL = 1, 269 }; 270 271 void perf_event__print_totals(void); 272 273 struct perf_cpu_map; 274 struct perf_record_stat_config; 275 struct perf_stat_config; 276 struct perf_tool; 277 278 void perf_event__read_stat_config(struct perf_stat_config *config, 279 struct perf_record_stat_config *event); 280 281 int perf_event__process_comm(const struct perf_tool *tool, 282 union perf_event *event, 283 struct perf_sample *sample, 284 struct machine *machine); 285 int perf_event__process_lost(const struct perf_tool *tool, 286 union perf_event *event, 287 struct perf_sample *sample, 288 struct machine *machine); 289 int perf_event__process_lost_samples(const struct perf_tool *tool, 290 union perf_event *event, 291 struct perf_sample *sample, 292 struct machine *machine); 293 int perf_event__process_aux(const struct perf_tool *tool, 294 union perf_event *event, 295 struct perf_sample *sample, 296 struct machine *machine); 297 int perf_event__process_itrace_start(const struct perf_tool *tool, 298 union perf_event *event, 299 struct perf_sample *sample, 300 struct machine *machine); 301 int perf_event__process_aux_output_hw_id(const struct perf_tool *tool, 302 union perf_event *event, 303 struct perf_sample *sample, 304 struct machine *machine); 305 int perf_event__process_switch(const struct perf_tool *tool, 306 union perf_event *event, 307 struct perf_sample *sample, 308 struct machine *machine); 309 int perf_event__process_namespaces(const struct perf_tool *tool, 310 union perf_event *event, 311 struct perf_sample *sample, 312 struct machine *machine); 313 int perf_event__process_cgroup(const struct perf_tool *tool, 314 union perf_event *event, 315 struct perf_sample *sample, 316 struct machine *machine); 317 int perf_event__process_mmap(const struct perf_tool *tool, 318 union perf_event *event, 319 struct perf_sample *sample, 320 struct machine *machine); 321 int perf_event__process_mmap2(const struct perf_tool *tool, 322 union perf_event *event, 323 struct perf_sample *sample, 324 struct machine *machine); 325 int perf_event__process_fork(const struct perf_tool *tool, 326 union perf_event *event, 327 struct perf_sample *sample, 328 struct machine *machine); 329 int perf_event__process_exit(const struct perf_tool *tool, 330 union perf_event *event, 331 struct perf_sample *sample, 332 struct machine *machine); 333 int perf_event__exit_del_thread(const struct perf_tool *tool, 334 union perf_event *event, 335 struct perf_sample *sample, 336 struct machine *machine); 337 int perf_event__process_ksymbol(const struct perf_tool *tool, 338 union perf_event *event, 339 struct perf_sample *sample, 340 struct machine *machine); 341 int perf_event__process_bpf(const struct perf_tool *tool, 342 union perf_event *event, 343 struct perf_sample *sample, 344 struct machine *machine); 345 int perf_event__process_text_poke(const struct perf_tool *tool, 346 union perf_event *event, 347 struct perf_sample *sample, 348 struct machine *machine); 349 int perf_event__process(const struct perf_tool *tool, 350 union perf_event *event, 351 struct perf_sample *sample, 352 struct machine *machine); 353 354 bool is_bts_event(struct perf_event_attr *attr); 355 bool sample_addr_correlates_sym(struct perf_event_attr *attr); 356 357 const char *perf_event__name(unsigned int id); 358 359 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp); 360 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp); 361 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp); 362 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp); 363 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp); 364 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp); 365 size_t perf_event__fprintf_aux_output_hw_id(union perf_event *event, FILE *fp); 366 size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp); 367 size_t perf_event__fprintf_thread_map(union perf_event *event, FILE *fp); 368 size_t perf_event__fprintf_cpu_map(union perf_event *event, FILE *fp); 369 size_t perf_event__fprintf_namespaces(union perf_event *event, FILE *fp); 370 size_t perf_event__fprintf_cgroup(union perf_event *event, FILE *fp); 371 size_t perf_event__fprintf_ksymbol(union perf_event *event, FILE *fp); 372 size_t perf_event__fprintf_bpf(union perf_event *event, FILE *fp); 373 size_t perf_event__fprintf_text_poke(union perf_event *event, struct machine *machine,FILE *fp); 374 size_t perf_event__fprintf(union perf_event *event, struct machine *machine, FILE *fp); 375 376 int kallsyms__get_function_start(const char *kallsyms_filename, 377 const char *symbol_name, u64 *addr); 378 int kallsyms__get_symbol_start(const char *kallsyms_filename, 379 const char *symbol_name, u64 *addr); 380 381 void event_attr_init(struct perf_event_attr *attr); 382 383 int perf_event_paranoid(void); 384 bool perf_event_paranoid_check(int max_level); 385 386 extern int sysctl_perf_event_max_stack; 387 extern int sysctl_perf_event_max_contexts_per_stack; 388 extern unsigned int proc_map_timeout; 389 390 #define PAGE_SIZE_NAME_LEN 32 391 char *get_page_size_name(u64 size, char *str); 392 393 void arch_perf_parse_sample_weight(struct perf_sample *data, const __u64 *array, u64 type); 394 void arch_perf_synthesize_sample_weight(const struct perf_sample *data, __u64 *array, u64 type); 395 const char *arch_perf_header_entry(const char *se_header); 396 int arch_support_sort_key(const char *sort_key); 397 398 static inline bool perf_event_header__cpumode_is_guest(u8 cpumode) 399 { 400 return cpumode == PERF_RECORD_MISC_GUEST_KERNEL || 401 cpumode == PERF_RECORD_MISC_GUEST_USER; 402 } 403 404 static inline bool perf_event_header__misc_is_guest(u16 misc) 405 { 406 return perf_event_header__cpumode_is_guest(misc & PERF_RECORD_MISC_CPUMODE_MASK); 407 } 408 409 static inline bool perf_event_header__is_guest(const struct perf_event_header *header) 410 { 411 return perf_event_header__misc_is_guest(header->misc); 412 } 413 414 static inline bool perf_event__is_guest(const union perf_event *event) 415 { 416 return perf_event_header__is_guest(&event->header); 417 } 418 419 #endif /* __PERF_RECORD_H */ 420