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         u8                      cpumode;
  93
  94         struct hist_entry_diff  diff;
  95
  96         /* We are added by hists__add_dummy_entry. */
  97         bool                    dummy;
  98
  99         /* XXX These two should move to some tree widget lib */
 100         u16                     row_offset;
 101         u16                     nr_rows;
 102
 103         bool                    init_have_children;
 104         char                    level;
 105         bool                    used;
 106         u8                      filtered;
 107         char                    *srcline;
 108         struct symbol           *parent;
 109         unsigned long           position;
 110         struct rb_root          sorted_chain;
 111         struct branch_info      *branch_info;
 112         struct hists            *hists;
 113         struct mem_info         *mem_info;
 114         struct callchain_root   callchain[0]; /* must be last member */
 115 };
 116
 117 static inline bool hist_entry__has_pairs(struct hist_entry *he)
 118 {
 119         return !list_empty(&he->pairs.node);
 120 }
 121
 122 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
 123 {
 124         if (hist_entry__has_pairs(he))
 125                 return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
 126         return NULL;
 127 }
 128
 129 static inline void hist_entry__add_pair(struct hist_entry *pair,
 130                                         struct hist_entry *he)
 131 {
 132         list_add_tail(&pair->pairs.node, &he->pairs.head);
 133 }
 134
 135 static inline float hist_entry__get_percent_limit(struct hist_entry *he)
 136 {
 137         u64 period = he->stat.period;
 138         u64 total_period = hists__total_period(he->hists);
 139
 140         if (unlikely(total_period == 0))
 141                 return 0;
 142
 143         if (symbol_conf.cumulate_callchain)
 144                 period = he->stat_acc->period;
 145
 146         return period * 100.0 / total_period;
 147 }
 148
 149
 150 enum sort_mode {
 151         SORT_MODE__NORMAL,
 152         SORT_MODE__BRANCH,
 153         SORT_MODE__MEMORY,
 154         SORT_MODE__TOP,
 155         SORT_MODE__DIFF,
 156 };
 157
 158 enum sort_type {
 159         /* common sort keys */
 160         SORT_PID,
 161         SORT_COMM,
 162         SORT_DSO,
 163         SORT_SYM,
 164         SORT_PARENT,
 165         SORT_CPU,
 166         SORT_SRCLINE,
 167         SORT_LOCAL_WEIGHT,
 168         SORT_GLOBAL_WEIGHT,
 169         SORT_TRANSACTION,
 170
 171         /* branch stack specific sort keys */
 172         __SORT_BRANCH_STACK,
 173         SORT_DSO_FROM = __SORT_BRANCH_STACK,
 174         SORT_DSO_TO,
 175         SORT_SYM_FROM,
 176         SORT_SYM_TO,
 177         SORT_MISPREDICT,
 178         SORT_ABORT,
 179         SORT_IN_TX,
 180
 181         /* memory mode specific sort keys */
 182         __SORT_MEMORY_MODE,
 183         SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
 184         SORT_MEM_DADDR_DSO,
 185         SORT_MEM_LOCKED,
 186         SORT_MEM_TLB,
 187         SORT_MEM_LVL,
 188         SORT_MEM_SNOOP,
 189         SORT_MEM_DCACHELINE,
 190 };
 191
 192 /*
 193  * configurable sorting bits
 194  */
 195
 196 struct sort_entry {
 197         struct list_head list;
 198
 199         const char *se_header;
 200
 201         int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
 202         int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
 203         int64_t (*se_sort)(struct hist_entry *, struct hist_entry *);
 204         int     (*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
 205                                unsigned int width);
 206         u8      se_width_idx;
 207 };
 208
 209 extern struct sort_entry sort_thread;
 210 extern struct list_head hist_entry__sort_list;
 211
 212 int setup_sorting(void);
 213 int setup_output_field(void);
 214 void reset_output_field(void);
 215 extern int sort_dimension__add(const char *);
 216 void sort__setup_elide(FILE *fp);
 217 void perf_hpp__set_elide(int idx, bool elide);
 218
 219 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
 220
 221 bool is_strict_order(const char *order);
 222 #endif  /* __PERF_SORT_H */