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