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