LXR linux/tools/perf/util/hist.h

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