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