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