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 "hist.h"
   7
   8 struct option;
   9
  10 extern regex_t parent_regex;
  11 extern const char *sort_order;
  12 extern const char *field_order;
  13 extern const char default_parent_pattern[];
  14 extern const char *parent_pattern;
  15 extern const char *default_sort_order;
  16 extern regex_t ignore_callees_regex;
  17 extern int have_ignore_callees;
  18 extern enum sort_mode sort__mode;
  19 extern struct sort_entry sort_comm;
  20 extern struct sort_entry sort_dso;
  21 extern struct sort_entry sort_sym;
  22 extern struct sort_entry sort_parent;
  23 extern struct sort_entry sort_dso_from;
  24 extern struct sort_entry sort_dso_to;
  25 extern struct sort_entry sort_sym_from;
  26 extern struct sort_entry sort_sym_to;
  27 extern struct sort_entry sort_srcline;
  28 extern struct sort_entry sort_type;
  29 extern const char default_mem_sort_order[];
  30 extern bool chk_double_cl;
  31
  32 enum sort_mode {
  33         SORT_MODE__NORMAL,
  34         SORT_MODE__BRANCH,
  35         SORT_MODE__MEMORY,
  36         SORT_MODE__TOP,
  37         SORT_MODE__DIFF,
  38         SORT_MODE__TRACEPOINT,
  39 };
  40
  41 enum sort_type {
  42         /* common sort keys */
  43         SORT_PID,
  44         SORT_COMM,
  45         SORT_DSO,
  46         SORT_SYM,
  47         SORT_PARENT,
  48         SORT_CPU,
  49         SORT_SOCKET,
  50         SORT_SRCLINE,
  51         SORT_SRCFILE,
  52         SORT_LOCAL_WEIGHT,
  53         SORT_GLOBAL_WEIGHT,
  54         SORT_TRANSACTION,
  55         SORT_TRACE,
  56         SORT_SYM_SIZE,
  57         SORT_DSO_SIZE,
  58         SORT_CGROUP,
  59         SORT_CGROUP_ID,
  60         SORT_SYM_IPC_NULL,
  61         SORT_TIME,
  62         SORT_CODE_PAGE_SIZE,
  63         SORT_LOCAL_INS_LAT,
  64         SORT_GLOBAL_INS_LAT,
  65         SORT_LOCAL_PIPELINE_STAGE_CYC,
  66         SORT_GLOBAL_PIPELINE_STAGE_CYC,
  67         SORT_ADDR,
  68         SORT_LOCAL_RETIRE_LAT,
  69         SORT_GLOBAL_RETIRE_LAT,
  70         SORT_SIMD,
  71         SORT_ANNOTATE_DATA_TYPE,
  72         SORT_ANNOTATE_DATA_TYPE_OFFSET,
  73         SORT_SYM_OFFSET,
  74         SORT_ANNOTATE_DATA_TYPE_CACHELINE,
  75
  76         /* branch stack specific sort keys */
  77         __SORT_BRANCH_STACK,
  78         SORT_DSO_FROM = __SORT_BRANCH_STACK,
  79         SORT_DSO_TO,
  80         SORT_SYM_FROM,
  81         SORT_SYM_TO,
  82         SORT_MISPREDICT,
  83         SORT_ABORT,
  84         SORT_IN_TX,
  85         SORT_CYCLES,
  86         SORT_SRCLINE_FROM,
  87         SORT_SRCLINE_TO,
  88         SORT_SYM_IPC,
  89         SORT_ADDR_FROM,
  90         SORT_ADDR_TO,
  91         SORT_CALLCHAIN_BRANCH_PREDICTED,
  92         SORT_CALLCHAIN_BRANCH_ABORT,
  93         SORT_CALLCHAIN_BRANCH_CYCLES,
  94
  95         /* memory mode specific sort keys */
  96         __SORT_MEMORY_MODE,
  97         SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
  98         SORT_MEM_DADDR_DSO,
  99         SORT_MEM_LOCKED,
 100         SORT_MEM_TLB,
 101         SORT_MEM_LVL,
 102         SORT_MEM_SNOOP,
 103         SORT_MEM_DCACHELINE,
 104         SORT_MEM_IADDR_SYMBOL,
 105         SORT_MEM_PHYS_DADDR,
 106         SORT_MEM_DATA_PAGE_SIZE,
 107         SORT_MEM_BLOCKED,
 108 };
 109
 110 /*
 111  * configurable sorting bits
 112  */
 113
 114 struct sort_entry {
 115         const char *se_header;
 116
 117         int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
 118         int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
 119         int64_t (*se_sort)(struct hist_entry *, struct hist_entry *);
 120         int     (*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
 121                                unsigned int width);
 122         int     (*se_filter)(struct hist_entry *he, int type, const void *arg);
 123         void    (*se_init)(struct hist_entry *he);
 124         u8      se_width_idx;
 125 };
 126
 127 extern struct sort_entry sort_thread;
 128
 129 struct evlist;
 130 struct tep_handle;
 131 int setup_sorting(struct evlist *evlist);
 132 int setup_output_field(void);
 133 void reset_output_field(void);
 134 void sort__setup_elide(FILE *fp);
 135 void perf_hpp__set_elide(int idx, bool elide);
 136
 137 char *sort_help(const char *prefix, enum sort_mode mode);
 138
 139 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
 140
 141 bool is_strict_order(const char *order);
 142
 143 int hpp_dimension__add_output(unsigned col);
 144 void reset_dimensions(void);
 145 int sort_dimension__add(struct perf_hpp_list *list, const char *tok,
 146                         struct evlist *evlist,
 147                         int level);
 148 int output_field_add(struct perf_hpp_list *list, const char *tok);
 149 int64_t
 150 sort__iaddr_cmp(struct hist_entry *left, struct hist_entry *right);
 151 int64_t
 152 sort__daddr_cmp(struct hist_entry *left, struct hist_entry *right);
 153 int64_t
 154 sort__dcacheline_cmp(struct hist_entry *left, struct hist_entry *right);
 155 int64_t
 156 _sort__sym_cmp(struct symbol *sym_l, struct symbol *sym_r);
 157 char *hist_entry__srcline(struct hist_entry *he);
 158 #endif  /* __PERF_SORT_H */