tools/perf/util/sort.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __PERF_SORT_H
   3 #define __PERF_SORT_H
   4 #include <regex.h>
   5 #include <stdbool.h>
   6 #include <linux/list.h>
   7 #include <linux/rbtree.h>
   8 #include "map_symbol.h"
   9 #include "symbol_conf.h"
  10 #include "callchain.h"
  11 #include "values.h"
  12 #include "hist.h"
  13 #include "stat.h"
  14 #include "spark.h"
  15
  16 struct option;
  17 struct thread;
  18
  19 extern regex_t parent_regex;
  20 extern const char *sort_order;
  21 extern const char *field_order;
  22 extern const char default_parent_pattern[];
  23 extern const char *parent_pattern;
  24 extern const char *default_sort_order;
  25 extern regex_t ignore_callees_regex;
  26 extern int have_ignore_callees;
  27 extern enum sort_mode sort__mode;
  28 extern struct sort_entry sort_comm;
  29 extern struct sort_entry sort_dso;
  30 extern struct sort_entry sort_sym;
  31 extern struct sort_entry sort_parent;
  32 extern struct sort_entry sort_dso_from;
  33 extern struct sort_entry sort_dso_to;
  34 extern struct sort_entry sort_sym_from;
  35 extern struct sort_entry sort_sym_to;
  36 extern struct sort_entry sort_srcline;
  37 extern const char default_mem_sort_order[];
  38 extern bool chk_double_cl;
  39
  40 struct res_sample {
  41         u64 time;
  42         int cpu;
  43         int tid;
  44 };
  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         u32                     nr_events;
  53 };
  54
  55 struct namespace_id {
  56         u64                     dev;
  57         u64                     ino;
  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                 /* PERF_HPP_DIFF__CYCLES */
  73                 s64     cycles;
  74         };
  75         struct stats    stats;
  76         unsigned long   svals[NUM_SPARKS];
  77 };
  78
  79 struct hist_entry_ops {
  80         void    *(*new)(size_t size);
  81         void    (*free)(void *ptr);
  82 };
  83
  84 /**
  85  * struct hist_entry - histogram entry
  86  *
  87  * @row_offset - offset from the first callchain expanded to appear on screen
  88  * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
  89  */
  90 struct hist_entry {
  91         struct rb_node          rb_node_in;
  92         struct rb_node          rb_node;
  93         union {
  94                 struct list_head node;
  95                 struct list_head head;
  96         } pairs;
  97         struct he_stat          stat;
  98         struct he_stat          *stat_acc;
  99         struct map_symbol       ms;
 100         struct thread           *thread;
 101         struct comm             *comm;
 102         struct namespace_id     cgroup_id;
 103         u64                     cgroup;
 104         u64                     ip;
 105         u64                     transaction;
 106         s32                     socket;
 107         s32                     cpu;
 108         u64                     code_page_size;
 109         u64                     weight;
 110         u64                     ins_lat;
 111         u64                     p_stage_cyc;
 112         u8                      cpumode;
 113         u8                      depth;
 114         struct simd_flags       simd_flags;
 115
 116         /* We are added by hists__add_dummy_entry. */
 117         bool                    dummy;
 118         bool                    leaf;
 119
 120         char                    level;
 121         u8                      filtered;
 122
 123         u16                     callchain_size;
 124         union {
 125                 /*
 126                  * Since perf diff only supports the stdio output, TUI
 127                  * fields are only accessed from perf report (or perf
 128                  * top).  So make it a union to reduce memory usage.
 129                  */
 130                 struct hist_entry_diff  diff;
 131                 struct /* for TUI */ {
 132                         u16     row_offset;
 133                         u16     nr_rows;
 134                         bool    init_have_children;
 135                         bool    unfolded;
 136                         bool    has_children;
 137                         bool    has_no_entry;
 138                 };
 139         };
 140         char                    *srcline;
 141         char                    *srcfile;
 142         struct symbol           *parent;
 143         struct branch_info      *branch_info;
 144         long                    time;
 145         struct hists            *hists;
 146         struct mem_info         *mem_info;
 147         struct block_info       *block_info;
 148         struct kvm_info         *kvm_info;
 149         void                    *raw_data;
 150         u32                     raw_size;
 151         int                     num_res;
 152         struct res_sample       *res_samples;
 153         void                    *trace_output;
 154         struct perf_hpp_list    *hpp_list;
 155         struct hist_entry       *parent_he;
 156         struct hist_entry_ops   *ops;
 157         union {
 158                 /* this is for hierarchical entry structure */
 159                 struct {
 160                         struct rb_root_cached   hroot_in;
 161                         struct rb_root_cached   hroot_out;
 162                 };                              /* non-leaf entries */
 163                 struct rb_root  sorted_chain;   /* leaf entry has callchains */
 164         };
 165         struct callchain_root   callchain[0]; /* must be last member */
 166 };
 167
 168 static __pure inline bool hist_entry__has_callchains(struct hist_entry *he)
 169 {
 170         return he->callchain_size != 0;
 171 }
 172
 173 int hist_entry__sym_snprintf(struct hist_entry *he, char *bf, size_t size, unsigned int width);
 174
 175 static inline bool hist_entry__has_pairs(struct hist_entry *he)
 176 {
 177         return !list_empty(&he->pairs.node);
 178 }
 179
 180 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
 181 {
 182         if (hist_entry__has_pairs(he))
 183                 return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
 184         return NULL;
 185 }
 186
 187 static inline void hist_entry__add_pair(struct hist_entry *pair,
 188                                         struct hist_entry *he)
 189 {
 190         list_add_tail(&pair->pairs.node, &he->pairs.head);
 191 }
 192
 193 static inline float hist_entry__get_percent_limit(struct hist_entry *he)
 194 {
 195         u64 period = he->stat.period;
 196         u64 total_period = hists__total_period(he->hists);
 197
 198         if (unlikely(total_period == 0))
 199                 return 0;
 200
 201         if (symbol_conf.cumulate_callchain)
 202                 period = he->stat_acc->period;
 203
 204         return period * 100.0 / total_period;
 205 }
 206
 207 enum sort_mode {
 208         SORT_MODE__NORMAL,
 209         SORT_MODE__BRANCH,
 210         SORT_MODE__MEMORY,
 211         SORT_MODE__TOP,
 212         SORT_MODE__DIFF,
 213         SORT_MODE__TRACEPOINT,
 214 };
 215
 216 enum sort_type {
 217         /* common sort keys */
 218         SORT_PID,
 219         SORT_COMM,
 220         SORT_DSO,
 221         SORT_SYM,
 222         SORT_PARENT,
 223         SORT_CPU,
 224         SORT_SOCKET,
 225         SORT_SRCLINE,
 226         SORT_SRCFILE,
 227         SORT_LOCAL_WEIGHT,
 228         SORT_GLOBAL_WEIGHT,
 229         SORT_TRANSACTION,
 230         SORT_TRACE,
 231         SORT_SYM_SIZE,
 232         SORT_DSO_SIZE,
 233         SORT_CGROUP,
 234         SORT_CGROUP_ID,
 235         SORT_SYM_IPC_NULL,
 236         SORT_TIME,
 237         SORT_CODE_PAGE_SIZE,
 238         SORT_LOCAL_INS_LAT,
 239         SORT_GLOBAL_INS_LAT,
 240         SORT_LOCAL_PIPELINE_STAGE_CYC,
 241         SORT_GLOBAL_PIPELINE_STAGE_CYC,
 242         SORT_ADDR,
 243         SORT_LOCAL_RETIRE_LAT,
 244         SORT_GLOBAL_RETIRE_LAT,
 245         SORT_SIMD,
 246
 247         /* branch stack specific sort keys */
 248         __SORT_BRANCH_STACK,
 249         SORT_DSO_FROM = __SORT_BRANCH_STACK,
 250         SORT_DSO_TO,
 251         SORT_SYM_FROM,
 252         SORT_SYM_TO,
 253         SORT_MISPREDICT,
 254         SORT_ABORT,
 255         SORT_IN_TX,
 256         SORT_CYCLES,
 257         SORT_SRCLINE_FROM,
 258         SORT_SRCLINE_TO,
 259         SORT_SYM_IPC,
 260         SORT_ADDR_FROM,
 261         SORT_ADDR_TO,
 262
 263         /* memory mode specific sort keys */
 264         __SORT_MEMORY_MODE,
 265         SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
 266         SORT_MEM_DADDR_DSO,
 267         SORT_MEM_LOCKED,
 268         SORT_MEM_TLB,
 269         SORT_MEM_LVL,
 270         SORT_MEM_SNOOP,
 271         SORT_MEM_DCACHELINE,
 272         SORT_MEM_IADDR_SYMBOL,
 273         SORT_MEM_PHYS_DADDR,
 274         SORT_MEM_DATA_PAGE_SIZE,
 275         SORT_MEM_BLOCKED,
 276 };
 277
 278 /*
 279  * configurable sorting bits
 280  */
 281
 282 struct sort_entry {
 283         const char *se_header;
 284
 285         int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
 286         int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
 287         int64_t (*se_sort)(struct hist_entry *, struct hist_entry *);
 288         int     (*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
 289                                unsigned int width);
 290         int     (*se_filter)(struct hist_entry *he, int type, const void *arg);
 291         void    (*se_init)(struct hist_entry *he);
 292         u8      se_width_idx;
 293 };
 294
 295 struct block_hist {
 296         struct hists            block_hists;
 297         struct perf_hpp_list    block_list;
 298         struct perf_hpp_fmt     block_fmt;
 299         int                     block_idx;
 300         bool                    valid;
 301         struct hist_entry       he;
 302 };
 303
 304 extern struct sort_entry sort_thread;
 305
 306 struct evlist;
 307 struct tep_handle;
 308 int setup_sorting(struct evlist *evlist);
 309 int setup_output_field(void);
 310 void reset_output_field(void);
 311 void sort__setup_elide(FILE *fp);
 312 void perf_hpp__set_elide(int idx, bool elide);
 313
 314 char *sort_help(const char *prefix);
 315
 316 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
 317
 318 bool is_strict_order(const char *order);
 319
 320 int hpp_dimension__add_output(unsigned col);
 321 void reset_dimensions(void);
 322 int sort_dimension__add(struct perf_hpp_list *list, const char *tok,
 323                         struct evlist *evlist,
 324                         int level);
 325 int output_field_add(struct perf_hpp_list *list, char *tok);
 326 int64_t
 327 sort__iaddr_cmp(struct hist_entry *left, struct hist_entry *right);
 328 int64_t
 329 sort__daddr_cmp(struct hist_entry *left, struct hist_entry *right);
 330 int64_t
 331 sort__dcacheline_cmp(struct hist_entry *left, struct hist_entry *right);
 332 int64_t
 333 _sort__sym_cmp(struct symbol *sym_l, struct symbol *sym_r);
 334 char *hist_entry__srcline(struct hist_entry *he);
 335 #endif  /* __PERF_SORT_H */