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