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