tools/perf/util/hist.h

   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
   8 extern struct callchain_param callchain_param;
   9
  10 struct hist_entry;
  11 struct addr_location;
  12 struct symbol;
  13
  14 /*
  15  * The kernel collects the number of events it couldn't send in a stretch and
  16  * when possible sends this number in a PERF_RECORD_LOST event. The number of
  17  * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
  18  * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
  19  * the sum of all struct lost_event.lost fields reported.
  20  *
  21  * The total_period is needed because by default auto-freq is used, so
  22  * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
  23  * the total number of low level events, it is necessary to to sum all struct
  24  * sample_event.period and stash the result in total_period.
  25  */
  26 struct events_stats {
  27         u64 total_period;
  28         u64 total_lost;
  29         u64 total_invalid_chains;
  30         u32 nr_events[PERF_RECORD_HEADER_MAX];
  31         u32 nr_lost_warned;
  32         u32 nr_unknown_events;
  33         u32 nr_invalid_chains;
  34         u32 nr_unknown_id;
  35 };
  36
  37 enum hist_column {
  38         HISTC_SYMBOL,
  39         HISTC_DSO,
  40         HISTC_THREAD,
  41         HISTC_COMM,
  42         HISTC_PARENT,
  43         HISTC_CPU,
  44         HISTC_NR_COLS, /* Last entry */
  45 };
  46
  47 struct thread;
  48 struct dso;
  49
  50 struct hists {
  51         struct rb_root          entries_in_array[2];
  52         struct rb_root          *entries_in;
  53         struct rb_root          entries;
  54         struct rb_root          entries_collapsed;
  55         u64                     nr_entries;
  56         const struct thread     *thread_filter;
  57         const struct dso        *dso_filter;
  58         pthread_mutex_t         lock;
  59         struct events_stats     stats;
  60         u64                     event_stream;
  61         u16                     col_len[HISTC_NR_COLS];
  62         /* Best would be to reuse the session callchain cursor */
  63         struct callchain_cursor callchain_cursor;
  64 };
  65
  66 struct hist_entry *__hists__add_entry(struct hists *self,
  67                                       struct addr_location *al,
  68                                       struct symbol *parent, u64 period);
  69 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
  70 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
  71 int hist_entry__snprintf(struct hist_entry *self, char *bf, size_t size,
  72                          struct hists *hists);
  73 void hist_entry__free(struct hist_entry *);
  74
  75 void hists__output_resort(struct hists *self);
  76 void hists__output_resort_threaded(struct hists *hists);
  77 void hists__collapse_resort(struct hists *self);
  78 void hists__collapse_resort_threaded(struct hists *hists);
  79
  80 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
  81 void hists__decay_entries_threaded(struct hists *hists, bool zap_user,
  82                                    bool zap_kernel);
  83 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
  84
  85 void hists__inc_nr_events(struct hists *self, u32 type);
  86 size_t hists__fprintf_nr_events(struct hists *self, FILE *fp);
  87
  88 size_t hists__fprintf(struct hists *self, struct hists *pair,
  89                       bool show_displacement, bool show_header,
  90                       int max_rows, int max_cols, FILE *fp);
  91
  92 int hist_entry__inc_addr_samples(struct hist_entry *self, int evidx, u64 addr);
  93 int hist_entry__annotate(struct hist_entry *self, size_t privsize);
  94
  95 void hists__filter_by_dso(struct hists *hists);
  96 void hists__filter_by_thread(struct hists *hists);
  97
  98 u16 hists__col_len(struct hists *self, enum hist_column col);
  99 void hists__set_col_len(struct hists *self, enum hist_column col, u16 len);
 100 bool hists__new_col_len(struct hists *self, enum hist_column col, u16 len);
 101
 102 struct perf_evlist;
 103
 104 #ifdef NO_NEWT_SUPPORT
 105 static inline
 106 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __used,
 107                                   const char *help __used,
 108                                   void(*timer)(void *arg) __used,
 109                                   void *arg __used,
 110                                   int refresh __used)
 111 {
 112         return 0;
 113 }
 114
 115 static inline int hist_entry__tui_annotate(struct hist_entry *self __used,
 116                                            int evidx __used,
 117                                            void(*timer)(void *arg) __used,
 118                                            void *arg __used,
 119                                            int delay_secs __used)
 120 {
 121         return 0;
 122 }
 123 #define K_LEFT -1
 124 #define K_RIGHT -2
 125 #else
 126 #include "ui/keysyms.h"
 127 int hist_entry__tui_annotate(struct hist_entry *he, int evidx,
 128                              void(*timer)(void *arg), void *arg, int delay_secs);
 129
 130 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
 131                                   void(*timer)(void *arg), void *arg,
 132                                   int refresh);
 133 #endif
 134
 135 unsigned int hists__sort_list_width(struct hists *self);
 136
 137 #endif  /* __PERF_HIST_H */