linux/tools/perf/util/hist.h
<<
>>
Prefs
   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
  11extern struct callchain_param callchain_param;
  12
  13struct hist_entry;
  14struct addr_location;
  15struct symbol;
  16
  17enum 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 */
  38struct 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
  52enum 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_MEM_DCACHELINE,
  76        HISTC_TRANSACTION,
  77        HISTC_NR_COLS, /* Last entry */
  78};
  79
  80struct thread;
  81struct dso;
  82
  83struct hists {
  84        struct rb_root          entries_in_array[2];
  85        struct rb_root          *entries_in;
  86        struct rb_root          entries;
  87        struct rb_root          entries_collapsed;
  88        u64                     nr_entries;
  89        u64                     nr_non_filtered_entries;
  90        const struct thread     *thread_filter;
  91        const struct dso        *dso_filter;
  92        const char              *uid_filter_str;
  93        const char              *symbol_filter_str;
  94        pthread_mutex_t         lock;
  95        struct events_stats     stats;
  96        u64                     event_stream;
  97        u16                     col_len[HISTC_NR_COLS];
  98};
  99
 100struct hist_entry_iter;
 101
 102struct hist_iter_ops {
 103        int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
 104        int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
 105        int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
 106        int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
 107        int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
 108};
 109
 110struct hist_entry_iter {
 111        int total;
 112        int curr;
 113
 114        bool hide_unresolved;
 115
 116        struct perf_evsel *evsel;
 117        struct perf_sample *sample;
 118        struct hist_entry *he;
 119        struct symbol *parent;
 120        void *priv;
 121
 122        const struct hist_iter_ops *ops;
 123        /* user-defined callback function (optional) */
 124        int (*add_entry_cb)(struct hist_entry_iter *iter,
 125                            struct addr_location *al, bool single, void *arg);
 126};
 127
 128extern const struct hist_iter_ops hist_iter_normal;
 129extern const struct hist_iter_ops hist_iter_branch;
 130extern const struct hist_iter_ops hist_iter_mem;
 131extern const struct hist_iter_ops hist_iter_cumulative;
 132
 133struct hist_entry *__hists__add_entry(struct hists *hists,
 134                                      struct addr_location *al,
 135                                      struct symbol *parent,
 136                                      struct branch_info *bi,
 137                                      struct mem_info *mi, u64 period,
 138                                      u64 weight, u64 transaction,
 139                                      bool sample_self);
 140int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
 141                         struct perf_evsel *evsel, struct perf_sample *sample,
 142                         int max_stack_depth, void *arg);
 143
 144int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
 145int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
 146int hist_entry__transaction_len(void);
 147int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
 148                              struct hists *hists);
 149void hist_entry__free(struct hist_entry *);
 150
 151void hists__output_resort(struct hists *hists);
 152void hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
 153
 154void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
 155void hists__output_recalc_col_len(struct hists *hists, int max_rows);
 156
 157u64 hists__total_period(struct hists *hists);
 158void hists__reset_stats(struct hists *hists);
 159void hists__inc_stats(struct hists *hists, struct hist_entry *h);
 160void hists__inc_nr_events(struct hists *hists, u32 type);
 161void hists__inc_nr_samples(struct hists *hists, bool filtered);
 162void events_stats__inc(struct events_stats *stats, u32 type);
 163size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
 164
 165size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
 166                      int max_cols, float min_pcnt, FILE *fp);
 167
 168void hists__filter_by_dso(struct hists *hists);
 169void hists__filter_by_thread(struct hists *hists);
 170void hists__filter_by_symbol(struct hists *hists);
 171
 172static inline bool hists__has_filter(struct hists *hists)
 173{
 174        return hists->thread_filter || hists->dso_filter ||
 175                hists->symbol_filter_str;
 176}
 177
 178u16 hists__col_len(struct hists *hists, enum hist_column col);
 179void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
 180bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
 181void hists__reset_col_len(struct hists *hists);
 182void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
 183
 184void hists__match(struct hists *leader, struct hists *other);
 185int hists__link(struct hists *leader, struct hists *other);
 186
 187struct perf_hpp {
 188        char *buf;
 189        size_t size;
 190        const char *sep;
 191        void *ptr;
 192};
 193
 194struct perf_hpp_fmt {
 195        int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 196                      struct perf_evsel *evsel);
 197        int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 198                     struct perf_evsel *evsel);
 199        int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 200                     struct hist_entry *he);
 201        int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
 202                     struct hist_entry *he);
 203        int64_t (*cmp)(struct hist_entry *a, struct hist_entry *b);
 204        int64_t (*collapse)(struct hist_entry *a, struct hist_entry *b);
 205        int64_t (*sort)(struct hist_entry *a, struct hist_entry *b);
 206
 207        struct list_head list;
 208        struct list_head sort_list;
 209        bool elide;
 210};
 211
 212extern struct list_head perf_hpp__list;
 213extern struct list_head perf_hpp__sort_list;
 214
 215#define perf_hpp__for_each_format(format) \
 216        list_for_each_entry(format, &perf_hpp__list, list)
 217
 218#define perf_hpp__for_each_format_safe(format, tmp)     \
 219        list_for_each_entry_safe(format, tmp, &perf_hpp__list, list)
 220
 221#define perf_hpp__for_each_sort_list(format) \
 222        list_for_each_entry(format, &perf_hpp__sort_list, sort_list)
 223
 224#define perf_hpp__for_each_sort_list_safe(format, tmp)  \
 225        list_for_each_entry_safe(format, tmp, &perf_hpp__sort_list, sort_list)
 226
 227extern struct perf_hpp_fmt perf_hpp__format[];
 228
 229enum {
 230        /* Matches perf_hpp__format array. */
 231        PERF_HPP__OVERHEAD,
 232        PERF_HPP__OVERHEAD_SYS,
 233        PERF_HPP__OVERHEAD_US,
 234        PERF_HPP__OVERHEAD_GUEST_SYS,
 235        PERF_HPP__OVERHEAD_GUEST_US,
 236        PERF_HPP__OVERHEAD_ACC,
 237        PERF_HPP__SAMPLES,
 238        PERF_HPP__PERIOD,
 239
 240        PERF_HPP__MAX_INDEX
 241};
 242
 243void perf_hpp__init(void);
 244void perf_hpp__column_register(struct perf_hpp_fmt *format);
 245void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
 246void perf_hpp__column_enable(unsigned col);
 247void perf_hpp__column_disable(unsigned col);
 248void perf_hpp__cancel_cumulate(void);
 249
 250void perf_hpp__register_sort_field(struct perf_hpp_fmt *format);
 251void perf_hpp__setup_output_field(void);
 252void perf_hpp__reset_output_field(void);
 253void perf_hpp__append_sort_keys(void);
 254
 255bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
 256bool perf_hpp__same_sort_entry(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
 257
 258static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format)
 259{
 260        return format->elide;
 261}
 262
 263void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
 264
 265typedef u64 (*hpp_field_fn)(struct hist_entry *he);
 266typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
 267typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
 268
 269int __hpp__fmt(struct perf_hpp *hpp, struct hist_entry *he,
 270               hpp_field_fn get_field, const char *fmt,
 271               hpp_snprint_fn print_fn, bool fmt_percent);
 272int __hpp__fmt_acc(struct perf_hpp *hpp, struct hist_entry *he,
 273                   hpp_field_fn get_field, const char *fmt,
 274                   hpp_snprint_fn print_fn, bool fmt_percent);
 275
 276static inline void advance_hpp(struct perf_hpp *hpp, int inc)
 277{
 278        hpp->buf  += inc;
 279        hpp->size -= inc;
 280}
 281
 282static inline size_t perf_hpp__use_color(void)
 283{
 284        return !symbol_conf.field_sep;
 285}
 286
 287static inline size_t perf_hpp__color_overhead(void)
 288{
 289        return perf_hpp__use_color() ?
 290               (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
 291               : 0;
 292}
 293
 294struct perf_evlist;
 295
 296struct hist_browser_timer {
 297        void (*timer)(void *arg);
 298        void *arg;
 299        int refresh;
 300};
 301
 302#ifdef HAVE_SLANG_SUPPORT
 303#include "../ui/keysyms.h"
 304int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
 305                             struct hist_browser_timer *hbt);
 306
 307int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
 308                                  struct hist_browser_timer *hbt,
 309                                  float min_pcnt,
 310                                  struct perf_session_env *env);
 311int script_browse(const char *script_opt);
 312#else
 313static inline
 314int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
 315                                  const char *help __maybe_unused,
 316                                  struct hist_browser_timer *hbt __maybe_unused,
 317                                  float min_pcnt __maybe_unused,
 318                                  struct perf_session_env *env __maybe_unused)
 319{
 320        return 0;
 321}
 322
 323static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
 324                                           struct perf_evsel *evsel __maybe_unused,
 325                                           struct hist_browser_timer *hbt __maybe_unused)
 326{
 327        return 0;
 328}
 329
 330static inline int script_browse(const char *script_opt __maybe_unused)
 331{
 332        return 0;
 333}
 334
 335#define K_LEFT  -1000
 336#define K_RIGHT -2000
 337#define K_SWITCH_INPUT_DATA -3000
 338#endif
 339
 340unsigned int hists__sort_list_width(struct hists *hists);
 341
 342struct option;
 343int parse_filter_percentage(const struct option *opt __maybe_unused,
 344                            const char *arg, int unset __maybe_unused);
 345int perf_hist_config(const char *var, const char *value);
 346
 347#endif  /* __PERF_HIST_H */
 348