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