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