1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __PERF_HIST_H 3 #define __PERF_HIST_H 4 5 #include <linux/rbtree.h> 6 #include <linux/types.h> 7 #include "evsel.h" 8 #include "color.h" 9 #include "events_stats.h" 10 #include "mutex.h" 11 12 struct hist_entry; 13 struct hist_entry_ops; 14 struct addr_location; 15 struct map_symbol; 16 struct mem_info; 17 struct kvm_info; 18 struct branch_info; 19 struct branch_stack; 20 struct block_info; 21 struct symbol; 22 struct ui_progress; 23 24 enum hist_filter { 25 HIST_FILTER__DSO, 26 HIST_FILTER__THREAD, 27 HIST_FILTER__PARENT, 28 HIST_FILTER__SYMBOL, 29 HIST_FILTER__GUEST, 30 HIST_FILTER__HOST, 31 HIST_FILTER__SOCKET, 32 HIST_FILTER__C2C, 33 }; 34 35 enum hist_column { 36 HISTC_SYMBOL, 37 HISTC_TIME, 38 HISTC_DSO, 39 HISTC_THREAD, 40 HISTC_COMM, 41 HISTC_CGROUP_ID, 42 HISTC_CGROUP, 43 HISTC_PARENT, 44 HISTC_CPU, 45 HISTC_SOCKET, 46 HISTC_SRCLINE, 47 HISTC_SRCFILE, 48 HISTC_MISPREDICT, 49 HISTC_IN_TX, 50 HISTC_ABORT, 51 HISTC_SYMBOL_FROM, 52 HISTC_SYMBOL_TO, 53 HISTC_DSO_FROM, 54 HISTC_DSO_TO, 55 HISTC_LOCAL_WEIGHT, 56 HISTC_GLOBAL_WEIGHT, 57 HISTC_CODE_PAGE_SIZE, 58 HISTC_MEM_DADDR_SYMBOL, 59 HISTC_MEM_DADDR_DSO, 60 HISTC_MEM_PHYS_DADDR, 61 HISTC_MEM_DATA_PAGE_SIZE, 62 HISTC_MEM_LOCKED, 63 HISTC_MEM_TLB, 64 HISTC_MEM_LVL, 65 HISTC_MEM_SNOOP, 66 HISTC_MEM_DCACHELINE, 67 HISTC_MEM_IADDR_SYMBOL, 68 HISTC_TRANSACTION, 69 HISTC_CYCLES, 70 HISTC_SRCLINE_FROM, 71 HISTC_SRCLINE_TO, 72 HISTC_TRACE, 73 HISTC_SYM_SIZE, 74 HISTC_DSO_SIZE, 75 HISTC_SYMBOL_IPC, 76 HISTC_MEM_BLOCKED, 77 HISTC_LOCAL_INS_LAT, 78 HISTC_GLOBAL_INS_LAT, 79 HISTC_LOCAL_P_STAGE_CYC, 80 HISTC_GLOBAL_P_STAGE_CYC, 81 HISTC_ADDR_FROM, 82 HISTC_ADDR_TO, 83 HISTC_ADDR, 84 HISTC_SIMD, 85 HISTC_TYPE, 86 HISTC_TYPE_OFFSET, 87 HISTC_SYMBOL_OFFSET, 88 HISTC_NR_COLS, /* Last entry */ 89 }; 90 91 struct thread; 92 struct dso; 93 94 struct hists { 95 struct rb_root_cached entries_in_array[2]; 96 struct rb_root_cached *entries_in; 97 struct rb_root_cached entries; 98 struct rb_root_cached entries_collapsed; 99 u64 nr_entries; 100 u64 nr_non_filtered_entries; 101 u64 callchain_period; 102 u64 callchain_non_filtered_period; 103 struct thread *thread_filter; 104 const struct dso *dso_filter; 105 const char *uid_filter_str; 106 const char *symbol_filter_str; 107 struct mutex lock; 108 struct hists_stats stats; 109 u64 event_stream; 110 u16 col_len[HISTC_NR_COLS]; 111 bool has_callchains; 112 int socket_filter; 113 struct perf_hpp_list *hpp_list; 114 struct list_head hpp_formats; 115 int nr_hpp_node; 116 }; 117 118 #define hists__has(__h, __f) (__h)->hpp_list->__f 119 120 struct hist_entry_iter; 121 122 struct hist_iter_ops { 123 int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *); 124 int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *); 125 int (*next_entry)(struct hist_entry_iter *, struct addr_location *); 126 int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *); 127 int (*finish_entry)(struct hist_entry_iter *, struct addr_location *); 128 }; 129 130 struct hist_entry_iter { 131 int total; 132 int curr; 133 134 bool hide_unresolved; 135 136 struct evsel *evsel; 137 struct perf_sample *sample; 138 struct hist_entry *he; 139 struct symbol *parent; 140 void *priv; 141 142 const struct hist_iter_ops *ops; 143 /* user-defined callback function (optional) */ 144 int (*add_entry_cb)(struct hist_entry_iter *iter, 145 struct addr_location *al, bool single, void *arg); 146 }; 147 148 extern const struct hist_iter_ops hist_iter_normal; 149 extern const struct hist_iter_ops hist_iter_branch; 150 extern const struct hist_iter_ops hist_iter_mem; 151 extern const struct hist_iter_ops hist_iter_cumulative; 152 153 struct hist_entry *hists__add_entry(struct hists *hists, 154 struct addr_location *al, 155 struct symbol *parent, 156 struct branch_info *bi, 157 struct mem_info *mi, 158 struct kvm_info *ki, 159 struct perf_sample *sample, 160 bool sample_self); 161 162 struct hist_entry *hists__add_entry_ops(struct hists *hists, 163 struct hist_entry_ops *ops, 164 struct addr_location *al, 165 struct symbol *sym_parent, 166 struct branch_info *bi, 167 struct mem_info *mi, 168 struct kvm_info *ki, 169 struct perf_sample *sample, 170 bool sample_self); 171 172 struct hist_entry *hists__add_entry_block(struct hists *hists, 173 struct addr_location *al, 174 struct block_info *bi); 175 176 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al, 177 int max_stack_depth, void *arg); 178 179 struct perf_hpp; 180 struct perf_hpp_fmt; 181 182 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right); 183 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right); 184 int hist_entry__transaction_len(void); 185 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size, 186 struct hists *hists); 187 int hist_entry__snprintf_alignment(struct hist_entry *he, struct perf_hpp *hpp, 188 struct perf_hpp_fmt *fmt, int printed); 189 void hist_entry__delete(struct hist_entry *he); 190 191 typedef int (*hists__resort_cb_t)(struct hist_entry *he, void *arg); 192 193 void evsel__output_resort_cb(struct evsel *evsel, struct ui_progress *prog, 194 hists__resort_cb_t cb, void *cb_arg); 195 void evsel__output_resort(struct evsel *evsel, struct ui_progress *prog); 196 void hists__output_resort(struct hists *hists, struct ui_progress *prog); 197 void hists__output_resort_cb(struct hists *hists, struct ui_progress *prog, 198 hists__resort_cb_t cb); 199 int hists__collapse_resort(struct hists *hists, struct ui_progress *prog); 200 201 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel); 202 void hists__delete_entries(struct hists *hists); 203 void hists__output_recalc_col_len(struct hists *hists, int max_rows); 204 205 struct hist_entry *hists__get_entry(struct hists *hists, int idx); 206 207 u64 hists__total_period(struct hists *hists); 208 void hists__reset_stats(struct hists *hists); 209 void hists__inc_stats(struct hists *hists, struct hist_entry *h); 210 void hists__inc_nr_events(struct hists *hists); 211 void hists__inc_nr_samples(struct hists *hists, bool filtered); 212 void hists__inc_nr_lost_samples(struct hists *hists, u32 lost); 213 214 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows, 215 int max_cols, float min_pcnt, FILE *fp, 216 bool ignore_callchains); 217 size_t evlist__fprintf_nr_events(struct evlist *evlist, FILE *fp, 218 bool skip_empty); 219 220 void hists__filter_by_dso(struct hists *hists); 221 void hists__filter_by_thread(struct hists *hists); 222 void hists__filter_by_symbol(struct hists *hists); 223 void hists__filter_by_socket(struct hists *hists); 224 225 static inline bool hists__has_filter(struct hists *hists) 226 { 227 return hists->thread_filter || hists->dso_filter || 228 hists->symbol_filter_str || (hists->socket_filter > -1); 229 } 230 231 u16 hists__col_len(struct hists *hists, enum hist_column col); 232 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len); 233 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len); 234 void hists__reset_col_len(struct hists *hists); 235 void hists__calc_col_len(struct hists *hists, struct hist_entry *he); 236 237 void hists__match(struct hists *leader, struct hists *other); 238 int hists__link(struct hists *leader, struct hists *other); 239 int hists__unlink(struct hists *hists); 240 241 struct hists_evsel { 242 struct evsel evsel; 243 struct hists hists; 244 }; 245 246 static inline struct evsel *hists_to_evsel(struct hists *hists) 247 { 248 struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists); 249 return &hevsel->evsel; 250 } 251 252 static inline struct hists *evsel__hists(struct evsel *evsel) 253 { 254 struct hists_evsel *hevsel = (struct hists_evsel *)evsel; 255 return &hevsel->hists; 256 } 257 258 static __pure inline bool hists__has_callchains(struct hists *hists) 259 { 260 return hists->has_callchains; 261 } 262 263 int hists__init(void); 264 int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list); 265 266 struct rb_root_cached *hists__get_rotate_entries_in(struct hists *hists); 267 268 struct perf_hpp { 269 char *buf; 270 size_t size; 271 const char *sep; 272 void *ptr; 273 bool skip; 274 }; 275 276 struct perf_hpp_fmt { 277 const char *name; 278 int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp, 279 struct hists *hists, int line, int *span); 280 int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp, 281 struct hists *hists); 282 void (*init)(struct perf_hpp_fmt *fmt, struct hist_entry *he); 283 int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp, 284 struct hist_entry *he); 285 int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp, 286 struct hist_entry *he); 287 int64_t (*cmp)(struct perf_hpp_fmt *fmt, 288 struct hist_entry *a, struct hist_entry *b); 289 int64_t (*collapse)(struct perf_hpp_fmt *fmt, 290 struct hist_entry *a, struct hist_entry *b); 291 int64_t (*sort)(struct perf_hpp_fmt *fmt, 292 struct hist_entry *a, struct hist_entry *b); 293 bool (*equal)(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b); 294 void (*free)(struct perf_hpp_fmt *fmt); 295 296 struct list_head list; 297 struct list_head sort_list; 298 bool elide; 299 int len; 300 int user_len; 301 int idx; 302 int level; 303 }; 304 305 struct perf_hpp_list { 306 struct list_head fields; 307 struct list_head sorts; 308 309 int nr_header_lines; 310 int need_collapse; 311 int parent; 312 int sym; 313 int dso; 314 int socket; 315 int thread; 316 int comm; 317 }; 318 319 extern struct perf_hpp_list perf_hpp_list; 320 321 struct perf_hpp_list_node { 322 struct list_head list; 323 struct perf_hpp_list hpp; 324 int level; 325 bool skip; 326 }; 327 328 void perf_hpp_list__column_register(struct perf_hpp_list *list, 329 struct perf_hpp_fmt *format); 330 void perf_hpp_list__register_sort_field(struct perf_hpp_list *list, 331 struct perf_hpp_fmt *format); 332 void perf_hpp_list__prepend_sort_field(struct perf_hpp_list *list, 333 struct perf_hpp_fmt *format); 334 335 static inline void perf_hpp__column_register(struct perf_hpp_fmt *format) 336 { 337 perf_hpp_list__column_register(&perf_hpp_list, format); 338 } 339 340 static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format) 341 { 342 perf_hpp_list__register_sort_field(&perf_hpp_list, format); 343 } 344 345 static inline void perf_hpp__prepend_sort_field(struct perf_hpp_fmt *format) 346 { 347 perf_hpp_list__prepend_sort_field(&perf_hpp_list, format); 348 } 349 350 #define perf_hpp_list__for_each_format(_list, format) \ 351 list_for_each_entry(format, &(_list)->fields, list) 352 353 #define perf_hpp_list__for_each_format_safe(_list, format, tmp) \ 354 list_for_each_entry_safe(format, tmp, &(_list)->fields, list) 355 356 #define perf_hpp_list__for_each_sort_list(_list, format) \ 357 list_for_each_entry(format, &(_list)->sorts, sort_list) 358 359 #define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp) \ 360 list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list) 361 362 #define hists__for_each_format(hists, format) \ 363 perf_hpp_list__for_each_format((hists)->hpp_list, format) 364 365 #define hists__for_each_sort_list(hists, format) \ 366 perf_hpp_list__for_each_sort_list((hists)->hpp_list, format) 367 368 extern struct perf_hpp_fmt perf_hpp__format[]; 369 370 enum { 371 /* Matches perf_hpp__format array. */ 372 PERF_HPP__OVERHEAD, 373 PERF_HPP__OVERHEAD_SYS, 374 PERF_HPP__OVERHEAD_US, 375 PERF_HPP__OVERHEAD_GUEST_SYS, 376 PERF_HPP__OVERHEAD_GUEST_US, 377 PERF_HPP__OVERHEAD_ACC, 378 PERF_HPP__SAMPLES, 379 PERF_HPP__PERIOD, 380 381 PERF_HPP__MAX_INDEX 382 }; 383 384 void perf_hpp__init(void); 385 void perf_hpp__cancel_cumulate(void); 386 void perf_hpp__setup_output_field(struct perf_hpp_list *list); 387 void perf_hpp__reset_output_field(struct perf_hpp_list *list); 388 void perf_hpp__append_sort_keys(struct perf_hpp_list *list); 389 int perf_hpp__setup_hists_formats(struct perf_hpp_list *list, 390 struct evlist *evlist); 391 392 393 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format); 394 bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format); 395 bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists); 396 bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt); 397 bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt); 398 bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt); 399 bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt); 400 bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt); 401 bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt); 402 bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt); 403 404 struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt); 405 406 int hist_entry__filter(struct hist_entry *he, int type, const void *arg); 407 408 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format, 409 struct hists *hists) 410 { 411 if (format->elide) 412 return true; 413 414 if (perf_hpp__is_dynamic_entry(format) && 415 !perf_hpp__defined_dynamic_entry(format, hists)) 416 return true; 417 418 return false; 419 } 420 421 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists); 422 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists); 423 void perf_hpp__set_user_width(const char *width_list_str); 424 void hists__reset_column_width(struct hists *hists); 425 426 typedef u64 (*hpp_field_fn)(struct hist_entry *he); 427 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front); 428 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...); 429 430 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp, 431 struct hist_entry *he, hpp_field_fn get_field, 432 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent); 433 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp, 434 struct hist_entry *he, hpp_field_fn get_field, 435 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent); 436 437 static inline void advance_hpp(struct perf_hpp *hpp, int inc) 438 { 439 hpp->buf += inc; 440 hpp->size -= inc; 441 } 442 443 static inline size_t perf_hpp__use_color(void) 444 { 445 return !symbol_conf.field_sep; 446 } 447 448 static inline size_t perf_hpp__color_overhead(void) 449 { 450 return perf_hpp__use_color() ? 451 (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX 452 : 0; 453 } 454 455 struct evlist; 456 457 struct hist_browser_timer { 458 void (*timer)(void *arg); 459 void *arg; 460 int refresh; 461 }; 462 463 struct res_sample; 464 465 enum rstype { 466 A_NORMAL, 467 A_ASM, 468 A_SOURCE 469 }; 470 471 struct block_hist; 472 473 #ifdef HAVE_SLANG_SUPPORT 474 #include "../ui/keysyms.h" 475 void attr_to_script(char *buf, struct perf_event_attr *attr); 476 477 int map_symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel, 478 struct hist_browser_timer *hbt); 479 480 int hist_entry__tui_annotate(struct hist_entry *he, struct evsel *evsel, 481 struct hist_browser_timer *hbt); 482 483 int evlist__tui_browse_hists(struct evlist *evlist, const char *help, struct hist_browser_timer *hbt, 484 float min_pcnt, struct perf_env *env, bool warn_lost_event); 485 486 int script_browse(const char *script_opt, struct evsel *evsel); 487 488 void run_script(char *cmd); 489 int res_sample_browse(struct res_sample *res_samples, int num_res, 490 struct evsel *evsel, enum rstype rstype); 491 void res_sample_init(void); 492 493 int block_hists_tui_browse(struct block_hist *bh, struct evsel *evsel, 494 float min_percent, struct perf_env *env); 495 #else 496 static inline 497 int evlist__tui_browse_hists(struct evlist *evlist __maybe_unused, 498 const char *help __maybe_unused, 499 struct hist_browser_timer *hbt __maybe_unused, 500 float min_pcnt __maybe_unused, 501 struct perf_env *env __maybe_unused, 502 bool warn_lost_event __maybe_unused) 503 { 504 return 0; 505 } 506 static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused, 507 struct evsel *evsel __maybe_unused, 508 struct hist_browser_timer *hbt __maybe_unused) 509 { 510 return 0; 511 } 512 513 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused, 514 struct evsel *evsel __maybe_unused, 515 struct hist_browser_timer *hbt __maybe_unused) 516 { 517 return 0; 518 } 519 520 static inline int script_browse(const char *script_opt __maybe_unused, 521 struct evsel *evsel __maybe_unused) 522 { 523 return 0; 524 } 525 526 static inline int res_sample_browse(struct res_sample *res_samples __maybe_unused, 527 int num_res __maybe_unused, 528 struct evsel *evsel __maybe_unused, 529 enum rstype rstype __maybe_unused) 530 { 531 return 0; 532 } 533 534 static inline void res_sample_init(void) {} 535 536 static inline int block_hists_tui_browse(struct block_hist *bh __maybe_unused, 537 struct evsel *evsel __maybe_unused, 538 float min_percent __maybe_unused, 539 struct perf_env *env __maybe_unused) 540 { 541 return 0; 542 } 543 544 #define K_LEFT -1000 545 #define K_RIGHT -2000 546 #define K_SWITCH_INPUT_DATA -3000 547 #define K_RELOAD -4000 548 #endif 549 550 unsigned int hists__sort_list_width(struct hists *hists); 551 unsigned int hists__overhead_width(struct hists *hists); 552 553 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al, 554 struct perf_sample *sample, bool nonany_branch_mode, 555 u64 *total_cycles); 556 557 struct option; 558 int parse_filter_percentage(const struct option *opt, const char *arg, int unset); 559 int perf_hist_config(const char *var, const char *value); 560 561 void perf_hpp_list__init(struct perf_hpp_list *list); 562 563 enum hierarchy_move_dir { 564 HMD_NORMAL, 565 HMD_FORCE_SIBLING, 566 HMD_FORCE_CHILD, 567 }; 568 569 struct rb_node *rb_hierarchy_last(struct rb_node *node); 570 struct rb_node *__rb_hierarchy_next(struct rb_node *node, 571 enum hierarchy_move_dir hmd); 572 struct rb_node *rb_hierarchy_prev(struct rb_node *node); 573 574 static inline struct rb_node *rb_hierarchy_next(struct rb_node *node) 575 { 576 return __rb_hierarchy_next(node, HMD_NORMAL); 577 } 578 579 #define HIERARCHY_INDENT 3 580 581 bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit); 582 int hpp_color_scnprintf(struct perf_hpp *hpp, const char *fmt, ...); 583 int __hpp__slsmg_color_printf(struct perf_hpp *hpp, const char *fmt, ...); 584 int __hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp, 585 struct perf_hpp_list *hpp_list); 586 int hists__fprintf_headers(struct hists *hists, FILE *fp); 587 int __hists__scnprintf_title(struct hists *hists, char *bf, size_t size, bool show_freq); 588 589 static inline int hists__scnprintf_title(struct hists *hists, char *bf, size_t size) 590 { 591 return __hists__scnprintf_title(hists, bf, size, true); 592 } 593 594 #endif /* __PERF_HIST_H */ 595