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