xref: /openbmc/linux/tools/perf/util/hist.h (revision 79f08d9e)
1 #ifndef __PERF_HIST_H
2 #define __PERF_HIST_H
3 
4 #include <linux/types.h>
5 #include <pthread.h>
6 #include "callchain.h"
7 #include "header.h"
8 #include "color.h"
9 #include "ui/progress.h"
10 
11 extern struct callchain_param callchain_param;
12 
13 struct hist_entry;
14 struct addr_location;
15 struct symbol;
16 
17 /*
18  * The kernel collects the number of events it couldn't send in a stretch and
19  * when possible sends this number in a PERF_RECORD_LOST event. The number of
20  * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
21  * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
22  * the sum of all struct lost_event.lost fields reported.
23  *
24  * The total_period is needed because by default auto-freq is used, so
25  * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
26  * the total number of low level events, it is necessary to to sum all struct
27  * sample_event.period and stash the result in total_period.
28  */
29 struct events_stats {
30 	u64 total_period;
31 	u64 total_lost;
32 	u64 total_invalid_chains;
33 	u32 nr_events[PERF_RECORD_HEADER_MAX];
34 	u32 nr_lost_warned;
35 	u32 nr_unknown_events;
36 	u32 nr_invalid_chains;
37 	u32 nr_unknown_id;
38 	u32 nr_unprocessable_samples;
39 };
40 
41 enum hist_column {
42 	HISTC_SYMBOL,
43 	HISTC_DSO,
44 	HISTC_THREAD,
45 	HISTC_COMM,
46 	HISTC_PARENT,
47 	HISTC_CPU,
48 	HISTC_SRCLINE,
49 	HISTC_MISPREDICT,
50 	HISTC_IN_TX,
51 	HISTC_ABORT,
52 	HISTC_SYMBOL_FROM,
53 	HISTC_SYMBOL_TO,
54 	HISTC_DSO_FROM,
55 	HISTC_DSO_TO,
56 	HISTC_LOCAL_WEIGHT,
57 	HISTC_GLOBAL_WEIGHT,
58 	HISTC_MEM_DADDR_SYMBOL,
59 	HISTC_MEM_DADDR_DSO,
60 	HISTC_MEM_LOCKED,
61 	HISTC_MEM_TLB,
62 	HISTC_MEM_LVL,
63 	HISTC_MEM_SNOOP,
64 	HISTC_TRANSACTION,
65 	HISTC_NR_COLS, /* Last entry */
66 };
67 
68 struct thread;
69 struct dso;
70 
71 struct hists {
72 	struct rb_root		entries_in_array[2];
73 	struct rb_root		*entries_in;
74 	struct rb_root		entries;
75 	struct rb_root		entries_collapsed;
76 	u64			nr_entries;
77 	const struct thread	*thread_filter;
78 	const struct dso	*dso_filter;
79 	const char		*uid_filter_str;
80 	const char		*symbol_filter_str;
81 	pthread_mutex_t		lock;
82 	struct events_stats	stats;
83 	u64			event_stream;
84 	u16			col_len[HISTC_NR_COLS];
85 };
86 
87 struct hist_entry *__hists__add_entry(struct hists *hists,
88 				      struct addr_location *al,
89 				      struct symbol *parent,
90 				      struct branch_info *bi,
91 				      struct mem_info *mi, u64 period,
92 				      u64 weight, u64 transaction);
93 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
94 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
95 int hist_entry__transaction_len(void);
96 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
97 			      struct hists *hists);
98 void hist_entry__free(struct hist_entry *);
99 
100 void hists__output_resort(struct hists *hists);
101 void hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
102 
103 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
104 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
105 
106 void hists__inc_nr_entries(struct hists *hists, struct hist_entry *h);
107 void hists__inc_nr_events(struct hists *hists, u32 type);
108 void events_stats__inc(struct events_stats *stats, u32 type);
109 size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
110 
111 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
112 		      int max_cols, float min_pcnt, FILE *fp);
113 
114 int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 addr);
115 int hist_entry__annotate(struct hist_entry *he, size_t privsize);
116 
117 void hists__filter_by_dso(struct hists *hists);
118 void hists__filter_by_thread(struct hists *hists);
119 void hists__filter_by_symbol(struct hists *hists);
120 
121 u16 hists__col_len(struct hists *hists, enum hist_column col);
122 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
123 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
124 void hists__reset_col_len(struct hists *hists);
125 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
126 
127 void hists__match(struct hists *leader, struct hists *other);
128 int hists__link(struct hists *leader, struct hists *other);
129 
130 struct perf_hpp {
131 	char *buf;
132 	size_t size;
133 	const char *sep;
134 	void *ptr;
135 };
136 
137 struct perf_hpp_fmt {
138 	int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp);
139 	int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp);
140 	int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
141 		     struct hist_entry *he);
142 	int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
143 		     struct hist_entry *he);
144 
145 	struct list_head list;
146 };
147 
148 extern struct list_head perf_hpp__list;
149 
150 #define perf_hpp__for_each_format(format) \
151 	list_for_each_entry(format, &perf_hpp__list, list)
152 
153 extern struct perf_hpp_fmt perf_hpp__format[];
154 
155 enum {
156 	/* Matches perf_hpp__format array. */
157 	PERF_HPP__OVERHEAD,
158 	PERF_HPP__OVERHEAD_SYS,
159 	PERF_HPP__OVERHEAD_US,
160 	PERF_HPP__OVERHEAD_GUEST_SYS,
161 	PERF_HPP__OVERHEAD_GUEST_US,
162 	PERF_HPP__SAMPLES,
163 	PERF_HPP__PERIOD,
164 
165 	PERF_HPP__MAX_INDEX
166 };
167 
168 void perf_hpp__init(void);
169 void perf_hpp__column_register(struct perf_hpp_fmt *format);
170 void perf_hpp__column_enable(unsigned col);
171 
172 static inline size_t perf_hpp__use_color(void)
173 {
174 	return !symbol_conf.field_sep;
175 }
176 
177 static inline size_t perf_hpp__color_overhead(void)
178 {
179 	return perf_hpp__use_color() ?
180 	       (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
181 	       : 0;
182 }
183 
184 struct perf_evlist;
185 
186 struct hist_browser_timer {
187 	void (*timer)(void *arg);
188 	void *arg;
189 	int refresh;
190 };
191 
192 #ifdef HAVE_SLANG_SUPPORT
193 #include "../ui/keysyms.h"
194 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
195 			     struct hist_browser_timer *hbt);
196 
197 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
198 				  struct hist_browser_timer *hbt,
199 				  float min_pcnt,
200 				  struct perf_session_env *env);
201 int script_browse(const char *script_opt);
202 #else
203 static inline
204 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
205 				  const char *help __maybe_unused,
206 				  struct hist_browser_timer *hbt __maybe_unused,
207 				  float min_pcnt __maybe_unused,
208 				  struct perf_session_env *env __maybe_unused)
209 {
210 	return 0;
211 }
212 
213 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
214 					   struct perf_evsel *evsel __maybe_unused,
215 					   struct hist_browser_timer *hbt __maybe_unused)
216 {
217 	return 0;
218 }
219 
220 static inline int script_browse(const char *script_opt __maybe_unused)
221 {
222 	return 0;
223 }
224 
225 #define K_LEFT  -1000
226 #define K_RIGHT -2000
227 #define K_SWITCH_INPUT_DATA -3000
228 #endif
229 
230 unsigned int hists__sort_list_width(struct hists *hists);
231 #endif	/* __PERF_HIST_H */
232