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