xref: /openbmc/linux/tools/perf/util/hist.h (revision 565d76cb)
1 #ifndef __PERF_HIST_H
2 #define __PERF_HIST_H
3 
4 #include <linux/types.h>
5 #include "callchain.h"
6 
7 extern struct callchain_param callchain_param;
8 
9 struct hist_entry;
10 struct addr_location;
11 struct symbol;
12 
13 /*
14  * The kernel collects the number of events it couldn't send in a stretch and
15  * when possible sends this number in a PERF_RECORD_LOST event. The number of
16  * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
17  * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
18  * the sum of all struct lost_event.lost fields reported.
19  *
20  * The total_period is needed because by default auto-freq is used, so
21  * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
22  * the total number of low level events, it is necessary to to sum all struct
23  * sample_event.period and stash the result in total_period.
24  */
25 struct events_stats {
26 	u64 total_period;
27 	u64 total_lost;
28 	u64 total_invalid_chains;
29 	u32 nr_events[PERF_RECORD_HEADER_MAX];
30 	u32 nr_unknown_events;
31 	u32 nr_invalid_chains;
32 };
33 
34 enum hist_column {
35 	HISTC_SYMBOL,
36 	HISTC_DSO,
37 	HISTC_THREAD,
38 	HISTC_COMM,
39 	HISTC_PARENT,
40 	HISTC_CPU,
41 	HISTC_NR_COLS, /* Last entry */
42 };
43 
44 struct hists {
45 	struct rb_root		entries;
46 	u64			nr_entries;
47 	struct events_stats	stats;
48 	u64			event_stream;
49 	u16			col_len[HISTC_NR_COLS];
50 	/* Best would be to reuse the session callchain cursor */
51 	struct callchain_cursor	callchain_cursor;
52 };
53 
54 struct hist_entry *__hists__add_entry(struct hists *self,
55 				      struct addr_location *al,
56 				      struct symbol *parent, u64 period);
57 extern int64_t hist_entry__cmp(struct hist_entry *, struct hist_entry *);
58 extern int64_t hist_entry__collapse(struct hist_entry *, struct hist_entry *);
59 int hist_entry__fprintf(struct hist_entry *self, struct hists *hists,
60 			struct hists *pair_hists, bool show_displacement,
61 			long displacement, FILE *fp, u64 total);
62 int hist_entry__snprintf(struct hist_entry *self, char *bf, size_t size,
63 			 struct hists *hists, struct hists *pair_hists,
64 			 bool show_displacement, long displacement,
65 			 bool color, u64 total);
66 void hist_entry__free(struct hist_entry *);
67 
68 void hists__output_resort(struct hists *self);
69 void hists__collapse_resort(struct hists *self);
70 
71 void hists__inc_nr_events(struct hists *self, u32 type);
72 size_t hists__fprintf_nr_events(struct hists *self, FILE *fp);
73 
74 size_t hists__fprintf(struct hists *self, struct hists *pair,
75 		      bool show_displacement, FILE *fp);
76 
77 int hist_entry__inc_addr_samples(struct hist_entry *self, int evidx, u64 addr);
78 int hist_entry__annotate(struct hist_entry *self, size_t privsize);
79 
80 void hists__filter_by_dso(struct hists *self, const struct dso *dso);
81 void hists__filter_by_thread(struct hists *self, const struct thread *thread);
82 
83 u16 hists__col_len(struct hists *self, enum hist_column col);
84 void hists__set_col_len(struct hists *self, enum hist_column col, u16 len);
85 bool hists__new_col_len(struct hists *self, enum hist_column col, u16 len);
86 
87 struct perf_evlist;
88 
89 #ifdef NO_NEWT_SUPPORT
90 static inline
91 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __used,
92 				  const char *help __used)
93 {
94 	return 0;
95 }
96 
97 static inline int hist_entry__tui_annotate(struct hist_entry *self __used,
98 					   int evidx __used)
99 {
100 	return 0;
101 }
102 #define KEY_LEFT -1
103 #define KEY_RIGHT -2
104 #else
105 #include <newt.h>
106 int hist_entry__tui_annotate(struct hist_entry *self, int evidx);
107 
108 #define KEY_LEFT NEWT_KEY_LEFT
109 #define KEY_RIGHT NEWT_KEY_RIGHT
110 
111 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help);
112 #endif
113 
114 unsigned int hists__sort_list_width(struct hists *self);
115 
116 #endif	/* __PERF_HIST_H */
117