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 <subcmd/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_dso;
  36 extern int sort__has_parent;
  37 extern int sort__has_sym;
  38 extern int sort__has_socket;
  39 extern int sort__has_thread;
  40 extern enum sort_mode sort__mode;
  41 extern struct sort_entry sort_comm;
  42 extern struct sort_entry sort_dso;
  43 extern struct sort_entry sort_sym;
  44 extern struct sort_entry sort_parent;
  45 extern struct sort_entry sort_dso_from;
  46 extern struct sort_entry sort_dso_to;
  47 extern struct sort_entry sort_sym_from;
  48 extern struct sort_entry sort_sym_to;
  49 extern enum sort_type sort__first_dimension;
  50 extern const char default_mem_sort_order[];
  51
  52 struct he_stat {
  53         u64                     period;
  54         u64                     period_sys;
  55         u64                     period_us;
  56         u64                     period_guest_sys;
  57         u64                     period_guest_us;
  58         u64                     weight;
  59         u32                     nr_events;
  60 };
  61
  62 struct hist_entry_diff {
  63         bool    computed;
  64         union {
  65                 /* PERF_HPP__DELTA */
  66                 double  period_ratio_delta;
  67
  68                 /* PERF_HPP__RATIO */
  69                 double  period_ratio;
  70
  71                 /* HISTC_WEIGHTED_DIFF */
  72                 s64     wdiff;
  73         };
  74 };
  75
  76 /**
  77  * struct hist_entry - histogram entry
  78  *
  79  * @row_offset - offset from the first callchain expanded to appear on screen
  80  * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
  81  */
  82 struct hist_entry {
  83         struct rb_node          rb_node_in;
  84         struct rb_node          rb_node;
  85         union {
  86                 struct list_head node;
  87                 struct list_head head;
  88         } pairs;
  89         struct he_stat          stat;
  90         struct he_stat          *stat_acc;
  91         struct map_symbol       ms;
  92         struct thread           *thread;
  93         struct comm             *comm;
  94         u64                     ip;
  95         u64                     transaction;
  96         s32                     socket;
  97         s32                     cpu;
  98         u8                      cpumode;
  99         u8                      depth;
 100
 101         /* We are added by hists__add_dummy_entry. */
 102         bool                    dummy;
 103         bool                    leaf;
 104
 105         char                    level;
 106         u8                      filtered;
 107         union {
 108                 /*
 109                  * Since perf diff only supports the stdio output, TUI
 110                  * fields are only accessed from perf report (or perf
 111                  * top).  So make it an union to reduce memory usage.
 112                  */
 113                 struct hist_entry_diff  diff;
 114                 struct /* for TUI */ {
 115                         u16     row_offset;
 116                         u16     nr_rows;
 117                         bool    init_have_children;
 118                         bool    unfolded;
 119                         bool    has_children;
 120                 };
 121         };
 122         char                    *srcline;
 123         char                    *srcfile;
 124         struct symbol           *parent;
 125         struct branch_info      *branch_info;
 126         struct hists            *hists;
 127         struct mem_info         *mem_info;
 128         void                    *raw_data;
 129         u32                     raw_size;
 130         void                    *trace_output;
 131         struct perf_hpp_fmt     *fmt;
 132         struct hist_entry       *parent_he;
 133         union {
 134                 /* this is for hierarchical entry structure */
 135                 struct {
 136                         struct rb_root  hroot_in;
 137                         struct rb_root  hroot_out;
 138                 };                              /* non-leaf entries */
 139                 struct rb_root  sorted_chain;   /* leaf entry has callchains */
 140         };
 141         struct callchain_root   callchain[0]; /* must be last member */
 142 };
 143
 144 static inline bool hist_entry__has_pairs(struct hist_entry *he)
 145 {
 146         return !list_empty(&he->pairs.node);
 147 }
 148
 149 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
 150 {
 151         if (hist_entry__has_pairs(he))
 152                 return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
 153         return NULL;
 154 }
 155
 156 static inline void hist_entry__add_pair(struct hist_entry *pair,
 157                                         struct hist_entry *he)
 158 {
 159         list_add_tail(&pair->pairs.node, &he->pairs.head);
 160 }
 161
 162 static inline float hist_entry__get_percent_limit(struct hist_entry *he)
 163 {
 164         u64 period = he->stat.period;
 165         u64 total_period = hists__total_period(he->hists);
 166
 167         if (unlikely(total_period == 0))
 168                 return 0;
 169
 170         if (symbol_conf.cumulate_callchain)
 171                 period = he->stat_acc->period;
 172
 173         return period * 100.0 / total_period;
 174 }
 175
 176 static inline u64 cl_address(u64 address)
 177 {
 178         /* return the cacheline of the address */
 179         return (address & ~(cacheline_size - 1));
 180 }
 181
 182 static inline u64 cl_offset(u64 address)
 183 {
 184         /* return the cacheline of the address */
 185         return (address & (cacheline_size - 1));
 186 }
 187
 188 enum sort_mode {
 189         SORT_MODE__NORMAL,
 190         SORT_MODE__BRANCH,
 191         SORT_MODE__MEMORY,
 192         SORT_MODE__TOP,
 193         SORT_MODE__DIFF,
 194         SORT_MODE__TRACEPOINT,
 195 };
 196
 197 enum sort_type {
 198         /* common sort keys */
 199         SORT_PID,
 200         SORT_COMM,
 201         SORT_DSO,
 202         SORT_SYM,
 203         SORT_PARENT,
 204         SORT_CPU,
 205         SORT_SOCKET,
 206         SORT_SRCLINE,
 207         SORT_SRCFILE,
 208         SORT_LOCAL_WEIGHT,
 209         SORT_GLOBAL_WEIGHT,
 210         SORT_TRANSACTION,
 211         SORT_TRACE,
 212
 213         /* branch stack specific sort keys */
 214         __SORT_BRANCH_STACK,
 215         SORT_DSO_FROM = __SORT_BRANCH_STACK,
 216         SORT_DSO_TO,
 217         SORT_SYM_FROM,
 218         SORT_SYM_TO,
 219         SORT_MISPREDICT,
 220         SORT_ABORT,
 221         SORT_IN_TX,
 222         SORT_CYCLES,
 223
 224         /* memory mode specific sort keys */
 225         __SORT_MEMORY_MODE,
 226         SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
 227         SORT_MEM_DADDR_DSO,
 228         SORT_MEM_LOCKED,
 229         SORT_MEM_TLB,
 230         SORT_MEM_LVL,
 231         SORT_MEM_SNOOP,
 232         SORT_MEM_DCACHELINE,
 233         SORT_MEM_IADDR_SYMBOL,
 234 };
 235
 236 /*
 237  * configurable sorting bits
 238  */
 239
 240 struct sort_entry {
 241         const char *se_header;
 242
 243         int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
 244         int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
 245         int64_t (*se_sort)(struct hist_entry *, struct hist_entry *);
 246         int     (*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
 247                                unsigned int width);
 248         int     (*se_filter)(struct hist_entry *he, int type, const void *arg);
 249         u8      se_width_idx;
 250 };
 251
 252 extern struct sort_entry sort_thread;
 253 extern struct list_head hist_entry__sort_list;
 254
 255 struct perf_evlist;
 256 struct pevent;
 257 int setup_sorting(struct perf_evlist *evlist);
 258 int setup_output_field(void);
 259 void reset_output_field(void);
 260 void sort__setup_elide(FILE *fp);
 261 void perf_hpp__set_elide(int idx, bool elide);
 262
 263 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
 264
 265 bool is_strict_order(const char *order);
 266
 267 int hpp_dimension__add_output(unsigned col);
 268 #endif  /* __PERF_SORT_H */