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 void hists__init(struct hists *hists);
  67
  68 struct hist_entry *__hists__add_entry(struct hists *self,
  69                                       struct addr_location *al,
  70                                       struct symbol *parent, u64 period);
  71 extern int64_t hist_entry__cmp(struct hist_entry *, struct hist_entry *);
  72 extern int64_t hist_entry__collapse(struct hist_entry *, struct hist_entry *);
  73 int hist_entry__fprintf(struct hist_entry *he, size_t size, struct hists *hists,
  74                         struct hists *pair_hists, bool show_displacement,
  75                         long displacement, FILE *fp, u64 session_total);
  76 int hist_entry__snprintf(struct hist_entry *self, char *bf, size_t size,
  77                          struct hists *hists);
  78 void hist_entry__free(struct hist_entry *);
  79
  80 void hists__output_resort(struct hists *self);
  81 void hists__output_resort_threaded(struct hists *hists);
  82 void hists__collapse_resort(struct hists *self);
  83 void hists__collapse_resort_threaded(struct hists *hists);
  84
  85 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
  86 void hists__decay_entries_threaded(struct hists *hists, bool zap_user,
  87                                    bool zap_kernel);
  88 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
  89
  90 void hists__inc_nr_events(struct hists *self, u32 type);
  91 size_t hists__fprintf_nr_events(struct hists *self, FILE *fp);
  92
  93 size_t hists__fprintf(struct hists *self, struct hists *pair,
  94                       bool show_displacement, bool show_header,
  95                       int max_rows, int max_cols, FILE *fp);
  96
  97 int hist_entry__inc_addr_samples(struct hist_entry *self, int evidx, u64 addr);
  98 int hist_entry__annotate(struct hist_entry *self, size_t privsize);
  99
 100 void hists__filter_by_dso(struct hists *hists);
 101 void hists__filter_by_thread(struct hists *hists);
 102
 103 u16 hists__col_len(struct hists *self, enum hist_column col);
 104 void hists__set_col_len(struct hists *self, enum hist_column col, u16 len);
 105 bool hists__new_col_len(struct hists *self, enum hist_column col, u16 len);
 106
 107 struct perf_evlist;
 108
 109 #ifdef NO_NEWT_SUPPORT
 110 static inline
 111 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __used,
 112                                   const char *help __used,
 113                                   void(*timer)(void *arg) __used,
 114                                   void *arg __used,
 115                                   int refresh __used)
 116 {
 117         return 0;
 118 }
 119
 120 static inline int hist_entry__tui_annotate(struct hist_entry *self __used,
 121                                            int evidx __used,
 122                                            int nr_events __used,
 123                                            void(*timer)(void *arg) __used,
 124                                            void *arg __used,
 125                                            int delay_secs __used)
 126 {
 127         return 0;
 128 }
 129 #define K_LEFT -1
 130 #define K_RIGHT -2
 131 #else
 132 #include "ui/keysyms.h"
 133 int hist_entry__tui_annotate(struct hist_entry *he, int evidx, int nr_events,
 134                              void(*timer)(void *arg), void *arg, int delay_secs);
 135
 136 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
 137                                   void(*timer)(void *arg), void *arg,
 138                                   int refresh);
 139 #endif
 140
 141 unsigned int hists__sort_list_width(struct hists *self);
 142
 143 #endif  /* __PERF_HIST_H */