perf hists: Move sort__has_sym into struct perf_hpp_list
[deliverable/linux.git] / tools / perf / util / hist.h
... / ...
CommitLineData
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 "evsel.h"
8#include "header.h"
9#include "color.h"
10#include "ui/progress.h"
11
12struct hist_entry;
13struct addr_location;
14struct symbol;
15
16enum hist_filter {
17 HIST_FILTER__DSO,
18 HIST_FILTER__THREAD,
19 HIST_FILTER__PARENT,
20 HIST_FILTER__SYMBOL,
21 HIST_FILTER__GUEST,
22 HIST_FILTER__HOST,
23 HIST_FILTER__SOCKET,
24};
25
26enum hist_column {
27 HISTC_SYMBOL,
28 HISTC_DSO,
29 HISTC_THREAD,
30 HISTC_COMM,
31 HISTC_PARENT,
32 HISTC_CPU,
33 HISTC_SOCKET,
34 HISTC_SRCLINE,
35 HISTC_SRCFILE,
36 HISTC_MISPREDICT,
37 HISTC_IN_TX,
38 HISTC_ABORT,
39 HISTC_SYMBOL_FROM,
40 HISTC_SYMBOL_TO,
41 HISTC_DSO_FROM,
42 HISTC_DSO_TO,
43 HISTC_LOCAL_WEIGHT,
44 HISTC_GLOBAL_WEIGHT,
45 HISTC_MEM_DADDR_SYMBOL,
46 HISTC_MEM_DADDR_DSO,
47 HISTC_MEM_LOCKED,
48 HISTC_MEM_TLB,
49 HISTC_MEM_LVL,
50 HISTC_MEM_SNOOP,
51 HISTC_MEM_DCACHELINE,
52 HISTC_MEM_IADDR_SYMBOL,
53 HISTC_TRANSACTION,
54 HISTC_CYCLES,
55 HISTC_TRACE,
56 HISTC_NR_COLS, /* Last entry */
57};
58
59struct thread;
60struct dso;
61
62struct hists {
63 struct rb_root entries_in_array[2];
64 struct rb_root *entries_in;
65 struct rb_root entries;
66 struct rb_root entries_collapsed;
67 u64 nr_entries;
68 u64 nr_non_filtered_entries;
69 u64 callchain_period;
70 u64 callchain_non_filtered_period;
71 struct thread *thread_filter;
72 const struct dso *dso_filter;
73 const char *uid_filter_str;
74 const char *symbol_filter_str;
75 pthread_mutex_t lock;
76 struct events_stats stats;
77 u64 event_stream;
78 u16 col_len[HISTC_NR_COLS];
79 int socket_filter;
80 struct perf_hpp_list *hpp_list;
81 struct list_head hpp_formats;
82 int nr_hpp_node;
83};
84
85#define hists__has(__h, __f) (__h)->hpp_list->__f
86
87struct hist_entry_iter;
88
89struct hist_iter_ops {
90 int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
91 int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
92 int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
93 int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
94 int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
95};
96
97struct hist_entry_iter {
98 int total;
99 int curr;
100
101 bool hide_unresolved;
102 int max_stack;
103
104 struct perf_evsel *evsel;
105 struct perf_sample *sample;
106 struct hist_entry *he;
107 struct symbol *parent;
108 void *priv;
109
110 const struct hist_iter_ops *ops;
111 /* user-defined callback function (optional) */
112 int (*add_entry_cb)(struct hist_entry_iter *iter,
113 struct addr_location *al, bool single, void *arg);
114};
115
116extern const struct hist_iter_ops hist_iter_normal;
117extern const struct hist_iter_ops hist_iter_branch;
118extern const struct hist_iter_ops hist_iter_mem;
119extern const struct hist_iter_ops hist_iter_cumulative;
120
121struct hist_entry *__hists__add_entry(struct hists *hists,
122 struct addr_location *al,
123 struct symbol *parent,
124 struct branch_info *bi,
125 struct mem_info *mi,
126 struct perf_sample *sample,
127 bool sample_self);
128int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
129 int max_stack_depth, void *arg);
130
131struct perf_hpp;
132struct perf_hpp_fmt;
133
134int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
135int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
136int hist_entry__transaction_len(void);
137int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
138 struct hists *hists);
139int hist_entry__snprintf_alignment(struct hist_entry *he, struct perf_hpp *hpp,
140 struct perf_hpp_fmt *fmt, int printed);
141void hist_entry__delete(struct hist_entry *he);
142
143void perf_evsel__output_resort(struct perf_evsel *evsel, struct ui_progress *prog);
144void hists__output_resort(struct hists *hists, struct ui_progress *prog);
145int hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
146
147void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
148void hists__delete_entries(struct hists *hists);
149void hists__output_recalc_col_len(struct hists *hists, int max_rows);
150
151u64 hists__total_period(struct hists *hists);
152void hists__reset_stats(struct hists *hists);
153void hists__inc_stats(struct hists *hists, struct hist_entry *h);
154void hists__inc_nr_events(struct hists *hists, u32 type);
155void hists__inc_nr_samples(struct hists *hists, bool filtered);
156void events_stats__inc(struct events_stats *stats, u32 type);
157size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
158
159size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
160 int max_cols, float min_pcnt, FILE *fp);
161size_t perf_evlist__fprintf_nr_events(struct perf_evlist *evlist, FILE *fp);
162
163void hists__filter_by_dso(struct hists *hists);
164void hists__filter_by_thread(struct hists *hists);
165void hists__filter_by_symbol(struct hists *hists);
166void hists__filter_by_socket(struct hists *hists);
167
168static inline bool hists__has_filter(struct hists *hists)
169{
170 return hists->thread_filter || hists->dso_filter ||
171 hists->symbol_filter_str || (hists->socket_filter > -1);
172}
173
174u16 hists__col_len(struct hists *hists, enum hist_column col);
175void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
176bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
177void hists__reset_col_len(struct hists *hists);
178void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
179
180void hists__match(struct hists *leader, struct hists *other);
181int hists__link(struct hists *leader, struct hists *other);
182
183struct hists_evsel {
184 struct perf_evsel evsel;
185 struct hists hists;
186};
187
188static inline struct perf_evsel *hists_to_evsel(struct hists *hists)
189{
190 struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
191 return &hevsel->evsel;
192}
193
194static inline struct hists *evsel__hists(struct perf_evsel *evsel)
195{
196 struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
197 return &hevsel->hists;
198}
199
200int hists__init(void);
201int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list);
202
203struct rb_root *hists__get_rotate_entries_in(struct hists *hists);
204
205struct perf_hpp {
206 char *buf;
207 size_t size;
208 const char *sep;
209 void *ptr;
210};
211
212struct perf_hpp_fmt {
213 const char *name;
214 int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
215 struct perf_evsel *evsel);
216 int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
217 struct perf_evsel *evsel);
218 int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
219 struct hist_entry *he);
220 int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
221 struct hist_entry *he);
222 int64_t (*cmp)(struct perf_hpp_fmt *fmt,
223 struct hist_entry *a, struct hist_entry *b);
224 int64_t (*collapse)(struct perf_hpp_fmt *fmt,
225 struct hist_entry *a, struct hist_entry *b);
226 int64_t (*sort)(struct perf_hpp_fmt *fmt,
227 struct hist_entry *a, struct hist_entry *b);
228 bool (*equal)(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
229 void (*free)(struct perf_hpp_fmt *fmt);
230
231 struct list_head list;
232 struct list_head sort_list;
233 bool elide;
234 int len;
235 int user_len;
236 int idx;
237 int level;
238};
239
240struct perf_hpp_list {
241 struct list_head fields;
242 struct list_head sorts;
243
244 int need_collapse;
245 int parent;
246 int sym;
247};
248
249extern struct perf_hpp_list perf_hpp_list;
250
251struct perf_hpp_list_node {
252 struct list_head list;
253 struct perf_hpp_list hpp;
254 int level;
255 bool skip;
256};
257
258void perf_hpp_list__column_register(struct perf_hpp_list *list,
259 struct perf_hpp_fmt *format);
260void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
261 struct perf_hpp_fmt *format);
262
263static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
264{
265 perf_hpp_list__column_register(&perf_hpp_list, format);
266}
267
268static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
269{
270 perf_hpp_list__register_sort_field(&perf_hpp_list, format);
271}
272
273#define perf_hpp_list__for_each_format(_list, format) \
274 list_for_each_entry(format, &(_list)->fields, list)
275
276#define perf_hpp_list__for_each_format_safe(_list, format, tmp) \
277 list_for_each_entry_safe(format, tmp, &(_list)->fields, list)
278
279#define perf_hpp_list__for_each_sort_list(_list, format) \
280 list_for_each_entry(format, &(_list)->sorts, sort_list)
281
282#define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp) \
283 list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list)
284
285#define hists__for_each_format(hists, format) \
286 perf_hpp_list__for_each_format((hists)->hpp_list, fmt)
287
288#define hists__for_each_sort_list(hists, format) \
289 perf_hpp_list__for_each_sort_list((hists)->hpp_list, fmt)
290
291extern struct perf_hpp_fmt perf_hpp__format[];
292
293enum {
294 /* Matches perf_hpp__format array. */
295 PERF_HPP__OVERHEAD,
296 PERF_HPP__OVERHEAD_SYS,
297 PERF_HPP__OVERHEAD_US,
298 PERF_HPP__OVERHEAD_GUEST_SYS,
299 PERF_HPP__OVERHEAD_GUEST_US,
300 PERF_HPP__OVERHEAD_ACC,
301 PERF_HPP__SAMPLES,
302 PERF_HPP__PERIOD,
303
304 PERF_HPP__MAX_INDEX
305};
306
307void perf_hpp__init(void);
308void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
309void perf_hpp__cancel_cumulate(void);
310void perf_hpp__setup_output_field(struct perf_hpp_list *list);
311void perf_hpp__reset_output_field(struct perf_hpp_list *list);
312void perf_hpp__append_sort_keys(struct perf_hpp_list *list);
313int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
314 struct perf_evlist *evlist);
315
316
317bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
318bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
319bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists);
320bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt);
321bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt);
322bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt);
323bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt);
324bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt);
325bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt);
326bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt);
327
328struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt);
329
330int hist_entry__filter(struct hist_entry *he, int type, const void *arg);
331
332static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
333 struct hists *hists)
334{
335 if (format->elide)
336 return true;
337
338 if (perf_hpp__is_dynamic_entry(format) &&
339 !perf_hpp__defined_dynamic_entry(format, hists))
340 return true;
341
342 return false;
343}
344
345void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
346void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
347void perf_hpp__set_user_width(const char *width_list_str);
348
349typedef u64 (*hpp_field_fn)(struct hist_entry *he);
350typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
351typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
352
353int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
354 struct hist_entry *he, hpp_field_fn get_field,
355 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
356int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
357 struct hist_entry *he, hpp_field_fn get_field,
358 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
359
360static inline void advance_hpp(struct perf_hpp *hpp, int inc)
361{
362 hpp->buf += inc;
363 hpp->size -= inc;
364}
365
366static inline size_t perf_hpp__use_color(void)
367{
368 return !symbol_conf.field_sep;
369}
370
371static inline size_t perf_hpp__color_overhead(void)
372{
373 return perf_hpp__use_color() ?
374 (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
375 : 0;
376}
377
378struct perf_evlist;
379
380struct hist_browser_timer {
381 void (*timer)(void *arg);
382 void *arg;
383 int refresh;
384};
385
386#ifdef HAVE_SLANG_SUPPORT
387#include "../ui/keysyms.h"
388int map_symbol__tui_annotate(struct map_symbol *ms, struct perf_evsel *evsel,
389 struct hist_browser_timer *hbt);
390
391int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
392 struct hist_browser_timer *hbt);
393
394int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
395 struct hist_browser_timer *hbt,
396 float min_pcnt,
397 struct perf_env *env);
398int script_browse(const char *script_opt);
399#else
400static inline
401int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
402 const char *help __maybe_unused,
403 struct hist_browser_timer *hbt __maybe_unused,
404 float min_pcnt __maybe_unused,
405 struct perf_env *env __maybe_unused)
406{
407 return 0;
408}
409static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
410 struct perf_evsel *evsel __maybe_unused,
411 struct hist_browser_timer *hbt __maybe_unused)
412{
413 return 0;
414}
415
416static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
417 struct perf_evsel *evsel __maybe_unused,
418 struct hist_browser_timer *hbt __maybe_unused)
419{
420 return 0;
421}
422
423static inline int script_browse(const char *script_opt __maybe_unused)
424{
425 return 0;
426}
427
428#define K_LEFT -1000
429#define K_RIGHT -2000
430#define K_SWITCH_INPUT_DATA -3000
431#endif
432
433unsigned int hists__sort_list_width(struct hists *hists);
434unsigned int hists__overhead_width(struct hists *hists);
435
436void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
437 struct perf_sample *sample, bool nonany_branch_mode);
438
439struct option;
440int parse_filter_percentage(const struct option *opt, const char *arg, int unset);
441int perf_hist_config(const char *var, const char *value);
442
443void perf_hpp_list__init(struct perf_hpp_list *list);
444
445enum hierarchy_move_dir {
446 HMD_NORMAL,
447 HMD_FORCE_SIBLING,
448 HMD_FORCE_CHILD,
449};
450
451struct rb_node *rb_hierarchy_last(struct rb_node *node);
452struct rb_node *__rb_hierarchy_next(struct rb_node *node,
453 enum hierarchy_move_dir hmd);
454struct rb_node *rb_hierarchy_prev(struct rb_node *node);
455
456static inline struct rb_node *rb_hierarchy_next(struct rb_node *node)
457{
458 return __rb_hierarchy_next(node, HMD_NORMAL);
459}
460
461#define HIERARCHY_INDENT 3
462
463bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit);
464
465#endif /* __PERF_HIST_H */
This page took 0.024887 seconds and 5 git commands to generate.