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