tools/perf/util/sort.h

   1 #ifndef __PERF_SORT_H
   2 #define __PERF_SORT_H
   3 #include "../builtin.h"
   4
   5 #include "util.h"
   6
   7 #include "color.h"
   8 #include <linux/list.h>
   9 #include "cache.h"
  10 #include <linux/rbtree.h>
  11 #include "symbol.h"
  12 #include "string.h"
  13 #include "callchain.h"
  14 #include "strlist.h"
  15 #include "values.h"
  16
  17 #include "../perf.h"
  18 #include "debug.h"
  19 #include "header.h"
  20
  21 #include "parse-options.h"
  22 #include "parse-events.h"
  23 #include "hist.h"
  24 #include "thread.h"
  25
  26 extern regex_t parent_regex;
  27 extern const char *sort_order;
  28 extern const char *field_order;
  29 extern const char default_parent_pattern[];
  30 extern const char *parent_pattern;
  31 extern const char default_sort_order[];
  32 extern regex_t ignore_callees_regex;
  33 extern int have_ignore_callees;
  34 extern int sort__need_collapse;
  35 extern int sort__has_parent;
  36 extern int sort__has_sym;
  37 extern enum sort_mode sort__mode;
  38 extern struct sort_entry sort_comm;
  39 extern struct sort_entry sort_dso;
  40 extern struct sort_entry sort_sym;
  41 extern struct sort_entry sort_parent;
  42 extern struct sort_entry sort_dso_from;
  43 extern struct sort_entry sort_dso_to;
  44 extern struct sort_entry sort_sym_from;
  45 extern struct sort_entry sort_sym_to;
  46 extern enum sort_type sort__first_dimension;
  47
  48 struct he_stat {
  49         u64                     period;
  50         u64                     period_sys;
  51         u64                     period_us;
  52         u64                     period_guest_sys;
  53         u64                     period_guest_us;
  54         u64                     weight;
  55         u32                     nr_events;
  56 };
  57
  58 struct hist_entry_diff {
  59         bool    computed;
  60
  61         /* PERF_HPP__DELTA */
  62         double  period_ratio_delta;
  63
  64         /* PERF_HPP__RATIO */
  65         double  period_ratio;
  66
  67         /* HISTC_WEIGHTED_DIFF */
  68         s64     wdiff;
  69 };
  70
  71 /**
  72  * struct hist_entry - histogram entry
  73  *
  74  * @row_offset - offset from the first callchain expanded to appear on screen
  75  * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
  76  */
  77 struct hist_entry {
  78         struct rb_node          rb_node_in;
  79         struct rb_node          rb_node;
  80         union {
  81                 struct list_head node;
  82                 struct list_head head;
  83         } pairs;
  84         struct he_stat          stat;
  85         struct he_stat          *stat_acc;
  86         struct map_symbol       ms;
  87         struct thread           *thread;
  88         struct comm             *comm;
  89         u64                     ip;
  90         u64                     transaction;
  91         s32                     cpu;
  92
  93         struct hist_entry_diff  diff;
  94
  95         /* We are added by hists__add_dummy_entry. */
  96         bool                    dummy;
  97
  98         /* XXX These two should move to some tree widget lib */
  99         u16                     row_offset;
 100         u16                     nr_rows;
 101
 102         bool                    init_have_children;
 103         char                    level;
 104         bool                    used;
 105         u8                      filtered;
 106         char                    *srcline;
 107         struct symbol           *parent;
 108         unsigned long           position;
 109         struct rb_root          sorted_chain;
 110         struct branch_info      *branch_info;
 111         struct hists            *hists;
 112         struct mem_info         *mem_info;
 113         struct callchain_root   callchain[0]; /* must be last member */
 114 };
 115
 116 static inline bool hist_entry__has_pairs(struct hist_entry *he)
 117 {
 118         return !list_empty(&he->pairs.node);
 119 }
 120
 121 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
 122 {
 123         if (hist_entry__has_pairs(he))
 124                 return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
 125         return NULL;
 126 }
 127
 128 static inline void hist_entry__add_pair(struct hist_entry *pair,
 129                                         struct hist_entry *he)
 130 {
 131         list_add_tail(&pair->pairs.node, &he->pairs.head);
 132 }
 133
 134 static inline float hist_entry__get_percent_limit(struct hist_entry *he)
 135 {
 136         u64 period = he->stat.period;
 137         u64 total_period = hists__total_period(he->hists);
 138
 139         if (unlikely(total_period == 0))
 140                 return 0;
 141
 142         if (symbol_conf.cumulate_callchain)
 143                 period = he->stat_acc->period;
 144
 145         return period * 100.0 / total_period;
 146 }
 147
 148
 149 enum sort_mode {
 150         SORT_MODE__NORMAL,
 151         SORT_MODE__BRANCH,
 152         SORT_MODE__MEMORY,
 153         SORT_MODE__TOP,
 154         SORT_MODE__DIFF,
 155 };
 156
 157 enum sort_type {
 158         /* common sort keys */
 159         SORT_PID,
 160         SORT_COMM,
 161         SORT_DSO,
 162         SORT_SYM,
 163         SORT_PARENT,
 164         SORT_CPU,
 165         SORT_SRCLINE,
 166         SORT_LOCAL_WEIGHT,
 167         SORT_GLOBAL_WEIGHT,
 168         SORT_TRANSACTION,
 169
 170         /* branch stack specific sort keys */
 171         __SORT_BRANCH_STACK,
 172         SORT_DSO_FROM = __SORT_BRANCH_STACK,
 173         SORT_DSO_TO,
 174         SORT_SYM_FROM,
 175         SORT_SYM_TO,
 176         SORT_MISPREDICT,
 177         SORT_ABORT,
 178         SORT_IN_TX,
 179
 180         /* memory mode specific sort keys */
 181         __SORT_MEMORY_MODE,
 182         SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
 183         SORT_MEM_DADDR_DSO,
 184         SORT_MEM_LOCKED,
 185         SORT_MEM_TLB,
 186         SORT_MEM_LVL,
 187         SORT_MEM_SNOOP,
 188 };
 189
 190 /*
 191  * configurable sorting bits
 192  */
 193
 194 struct sort_entry {
 195         struct list_head list;
 196
 197         const char *se_header;
 198
 199         int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
 200         int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
 201         int64_t (*se_sort)(struct hist_entry *, struct hist_entry *);
 202         int     (*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
 203                                unsigned int width);
 204         u8      se_width_idx;
 205 };
 206
 207 extern struct sort_entry sort_thread;
 208 extern struct list_head hist_entry__sort_list;
 209
 210 int setup_sorting(void);
 211 int setup_output_field(void);
 212 void reset_output_field(void);
 213 extern int sort_dimension__add(const char *);
 214 void sort__setup_elide(FILE *fp);
 215 void perf_hpp__set_elide(int idx, bool elide);
 216
 217 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
 218
 219 #endif  /* __PERF_SORT_H */