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