1 #ifndef __PERF_HIST_H 2 #define __PERF_HIST_H 3 4 #include <linux/types.h> 5 #include <pthread.h> 6 #include "callchain.h" 7 #include "header.h" 8 #include "color.h" 9 #include "ui/progress.h" 10 11 extern struct callchain_param callchain_param; 12 13 struct hist_entry; 14 struct addr_location; 15 struct symbol; 16 17 enum hist_filter { 18 HIST_FILTER__DSO, 19 HIST_FILTER__THREAD, 20 HIST_FILTER__PARENT, 21 HIST_FILTER__SYMBOL, 22 HIST_FILTER__GUEST, 23 HIST_FILTER__HOST, 24 }; 25 26 /* 27 * The kernel collects the number of events it couldn't send in a stretch and 28 * when possible sends this number in a PERF_RECORD_LOST event. The number of 29 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while 30 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is 31 * the sum of all struct lost_event.lost fields reported. 32 * 33 * The total_period is needed because by default auto-freq is used, so 34 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get 35 * the total number of low level events, it is necessary to to sum all struct 36 * sample_event.period and stash the result in total_period. 37 */ 38 struct events_stats { 39 u64 total_period; 40 u64 total_non_filtered_period; 41 u64 total_lost; 42 u64 total_invalid_chains; 43 u32 nr_events[PERF_RECORD_HEADER_MAX]; 44 u32 nr_non_filtered_samples; 45 u32 nr_lost_warned; 46 u32 nr_unknown_events; 47 u32 nr_invalid_chains; 48 u32 nr_unknown_id; 49 u32 nr_unprocessable_samples; 50 }; 51 52 enum hist_column { 53 HISTC_SYMBOL, 54 HISTC_DSO, 55 HISTC_THREAD, 56 HISTC_COMM, 57 HISTC_PARENT, 58 HISTC_CPU, 59 HISTC_SRCLINE, 60 HISTC_MISPREDICT, 61 HISTC_IN_TX, 62 HISTC_ABORT, 63 HISTC_SYMBOL_FROM, 64 HISTC_SYMBOL_TO, 65 HISTC_DSO_FROM, 66 HISTC_DSO_TO, 67 HISTC_LOCAL_WEIGHT, 68 HISTC_GLOBAL_WEIGHT, 69 HISTC_MEM_DADDR_SYMBOL, 70 HISTC_MEM_DADDR_DSO, 71 HISTC_MEM_LOCKED, 72 HISTC_MEM_TLB, 73 HISTC_MEM_LVL, 74 HISTC_MEM_SNOOP, 75 HISTC_TRANSACTION, 76 HISTC_NR_COLS, /* Last entry */ 77 }; 78 79 struct thread; 80 struct dso; 81 82 struct hists { 83 struct rb_root entries_in_array[2]; 84 struct rb_root *entries_in; 85 struct rb_root entries; 86 struct rb_root entries_collapsed; 87 u64 nr_entries; 88 u64 nr_non_filtered_entries; 89 const struct thread *thread_filter; 90 const struct dso *dso_filter; 91 const char *uid_filter_str; 92 const char *symbol_filter_str; 93 pthread_mutex_t lock; 94 struct events_stats stats; 95 u64 event_stream; 96 u16 col_len[HISTC_NR_COLS]; 97 }; 98 99 struct hist_entry_iter; 100 101 struct hist_iter_ops { 102 int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *); 103 int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *); 104 int (*next_entry)(struct hist_entry_iter *, struct addr_location *); 105 int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *); 106 int (*finish_entry)(struct hist_entry_iter *, struct addr_location *); 107 }; 108 109 struct hist_entry_iter { 110 int total; 111 int curr; 112 113 bool hide_unresolved; 114 115 struct perf_evsel *evsel; 116 struct perf_sample *sample; 117 struct hist_entry *he; 118 struct symbol *parent; 119 void *priv; 120 121 const struct hist_iter_ops *ops; 122 /* user-defined callback function (optional) */ 123 int (*add_entry_cb)(struct hist_entry_iter *iter, 124 struct addr_location *al, bool single, void *arg); 125 }; 126 127 extern const struct hist_iter_ops hist_iter_normal; 128 extern const struct hist_iter_ops hist_iter_branch; 129 extern const struct hist_iter_ops hist_iter_mem; 130 extern const struct hist_iter_ops hist_iter_cumulative; 131 132 struct hist_entry *__hists__add_entry(struct hists *hists, 133 struct addr_location *al, 134 struct symbol *parent, 135 struct branch_info *bi, 136 struct mem_info *mi, u64 period, 137 u64 weight, u64 transaction, 138 bool sample_self); 139 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al, 140 struct perf_evsel *evsel, struct perf_sample *sample, 141 int max_stack_depth, void *arg); 142 143 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right); 144 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right); 145 int hist_entry__transaction_len(void); 146 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size, 147 struct hists *hists); 148 void hist_entry__free(struct hist_entry *); 149 150 void hists__output_resort(struct hists *hists); 151 void hists__collapse_resort(struct hists *hists, struct ui_progress *prog); 152 153 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel); 154 void hists__output_recalc_col_len(struct hists *hists, int max_rows); 155 156 u64 hists__total_period(struct hists *hists); 157 void hists__reset_stats(struct hists *hists); 158 void hists__inc_stats(struct hists *hists, struct hist_entry *h); 159 void hists__inc_nr_events(struct hists *hists, u32 type); 160 void hists__inc_nr_samples(struct hists *hists, bool filtered); 161 void events_stats__inc(struct events_stats *stats, u32 type); 162 size_t events_stats__fprintf(struct events_stats *stats, FILE *fp); 163 164 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows, 165 int max_cols, float min_pcnt, FILE *fp); 166 167 void hists__filter_by_dso(struct hists *hists); 168 void hists__filter_by_thread(struct hists *hists); 169 void hists__filter_by_symbol(struct hists *hists); 170 171 static inline bool hists__has_filter(struct hists *hists) 172 { 173 return hists->thread_filter || hists->dso_filter || 174 hists->symbol_filter_str; 175 } 176 177 u16 hists__col_len(struct hists *hists, enum hist_column col); 178 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len); 179 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len); 180 void hists__reset_col_len(struct hists *hists); 181 void hists__calc_col_len(struct hists *hists, struct hist_entry *he); 182 183 void hists__match(struct hists *leader, struct hists *other); 184 int hists__link(struct hists *leader, struct hists *other); 185 186 struct perf_hpp { 187 char *buf; 188 size_t size; 189 const char *sep; 190 void *ptr; 191 }; 192 193 struct perf_hpp_fmt { 194 int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp, 195 struct perf_evsel *evsel); 196 int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp, 197 struct perf_evsel *evsel); 198 int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp, 199 struct hist_entry *he); 200 int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp, 201 struct hist_entry *he); 202 int64_t (*cmp)(struct hist_entry *a, struct hist_entry *b); 203 int64_t (*collapse)(struct hist_entry *a, struct hist_entry *b); 204 int64_t (*sort)(struct hist_entry *a, struct hist_entry *b); 205 206 struct list_head list; 207 struct list_head sort_list; 208 bool elide; 209 }; 210 211 extern struct list_head perf_hpp__list; 212 extern struct list_head perf_hpp__sort_list; 213 214 #define perf_hpp__for_each_format(format) \ 215 list_for_each_entry(format, &perf_hpp__list, list) 216 217 #define perf_hpp__for_each_format_safe(format, tmp) \ 218 list_for_each_entry_safe(format, tmp, &perf_hpp__list, list) 219 220 #define perf_hpp__for_each_sort_list(format) \ 221 list_for_each_entry(format, &perf_hpp__sort_list, sort_list) 222 223 #define perf_hpp__for_each_sort_list_safe(format, tmp) \ 224 list_for_each_entry_safe(format, tmp, &perf_hpp__sort_list, sort_list) 225 226 extern struct perf_hpp_fmt perf_hpp__format[]; 227 228 enum { 229 /* Matches perf_hpp__format array. */ 230 PERF_HPP__OVERHEAD, 231 PERF_HPP__OVERHEAD_SYS, 232 PERF_HPP__OVERHEAD_US, 233 PERF_HPP__OVERHEAD_GUEST_SYS, 234 PERF_HPP__OVERHEAD_GUEST_US, 235 PERF_HPP__OVERHEAD_ACC, 236 PERF_HPP__SAMPLES, 237 PERF_HPP__PERIOD, 238 239 PERF_HPP__MAX_INDEX 240 }; 241 242 void perf_hpp__init(void); 243 void perf_hpp__column_register(struct perf_hpp_fmt *format); 244 void perf_hpp__column_unregister(struct perf_hpp_fmt *format); 245 void perf_hpp__column_enable(unsigned col); 246 void perf_hpp__column_disable(unsigned col); 247 void perf_hpp__cancel_cumulate(void); 248 249 void perf_hpp__register_sort_field(struct perf_hpp_fmt *format); 250 void perf_hpp__setup_output_field(void); 251 void perf_hpp__reset_output_field(void); 252 void perf_hpp__append_sort_keys(void); 253 254 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format); 255 bool perf_hpp__same_sort_entry(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b); 256 257 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format) 258 { 259 return format->elide; 260 } 261 262 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists); 263 264 typedef u64 (*hpp_field_fn)(struct hist_entry *he); 265 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front); 266 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...); 267 268 int __hpp__fmt(struct perf_hpp *hpp, struct hist_entry *he, 269 hpp_field_fn get_field, const char *fmt, 270 hpp_snprint_fn print_fn, bool fmt_percent); 271 int __hpp__fmt_acc(struct perf_hpp *hpp, struct hist_entry *he, 272 hpp_field_fn get_field, const char *fmt, 273 hpp_snprint_fn print_fn, bool fmt_percent); 274 275 static inline void advance_hpp(struct perf_hpp *hpp, int inc) 276 { 277 hpp->buf += inc; 278 hpp->size -= inc; 279 } 280 281 static inline size_t perf_hpp__use_color(void) 282 { 283 return !symbol_conf.field_sep; 284 } 285 286 static inline size_t perf_hpp__color_overhead(void) 287 { 288 return perf_hpp__use_color() ? 289 (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX 290 : 0; 291 } 292 293 struct perf_evlist; 294 295 struct hist_browser_timer { 296 void (*timer)(void *arg); 297 void *arg; 298 int refresh; 299 }; 300 301 #ifdef HAVE_SLANG_SUPPORT 302 #include "../ui/keysyms.h" 303 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel, 304 struct hist_browser_timer *hbt); 305 306 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help, 307 struct hist_browser_timer *hbt, 308 float min_pcnt, 309 struct perf_session_env *env); 310 int script_browse(const char *script_opt); 311 #else 312 static inline 313 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused, 314 const char *help __maybe_unused, 315 struct hist_browser_timer *hbt __maybe_unused, 316 float min_pcnt __maybe_unused, 317 struct perf_session_env *env __maybe_unused) 318 { 319 return 0; 320 } 321 322 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused, 323 struct perf_evsel *evsel __maybe_unused, 324 struct hist_browser_timer *hbt __maybe_unused) 325 { 326 return 0; 327 } 328 329 static inline int script_browse(const char *script_opt __maybe_unused) 330 { 331 return 0; 332 } 333 334 #define K_LEFT -1000 335 #define K_RIGHT -2000 336 #define K_SWITCH_INPUT_DATA -3000 337 #endif 338 339 unsigned int hists__sort_list_width(struct hists *hists); 340 341 struct option; 342 int parse_filter_percentage(const struct option *opt __maybe_unused, 343 const char *arg, int unset __maybe_unused); 344 int perf_hist_config(const char *var, const char *value); 345 346 #endif /* __PERF_HIST_H */ 347