xref: /openbmc/linux/tools/perf/util/hist.h (revision 61a3e166)
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 struct rb_root;
13 
14 struct objdump_line {
15 	struct list_head node;
16 	s64		 offset;
17 	char		 *line;
18 };
19 
20 void objdump_line__free(struct objdump_line *self);
21 struct objdump_line *objdump__get_next_ip_line(struct list_head *head,
22 					       struct objdump_line *pos);
23 
24 struct sym_hist {
25 	u64		sum;
26 	u64		ip[0];
27 };
28 
29 struct sym_ext {
30 	struct rb_node	node;
31 	double		percent;
32 	char		*path;
33 };
34 
35 struct sym_priv {
36 	struct sym_hist	*hist;
37 	struct sym_ext	*ext;
38 };
39 
40 /*
41  * The kernel collects the number of events it couldn't send in a stretch and
42  * when possible sends this number in a PERF_RECORD_LOST event. The number of
43  * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
44  * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
45  * the sum of all struct lost_event.lost fields reported.
46  *
47  * The total_period is needed because by default auto-freq is used, so
48  * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
49  * the total number of low level events, it is necessary to to sum all struct
50  * sample_event.period and stash the result in total_period.
51  */
52 struct events_stats {
53 	u64 total_period;
54 	u64 total_lost;
55 	u32 nr_events[PERF_RECORD_HEADER_MAX];
56 	u32 nr_unknown_events;
57 };
58 
59 enum hist_column {
60 	HISTC_SYMBOL,
61 	HISTC_DSO,
62 	HISTC_THREAD,
63 	HISTC_COMM,
64 	HISTC_PARENT,
65 	HISTC_CPU,
66 	HISTC_NR_COLS, /* Last entry */
67 };
68 
69 struct hists {
70 	struct rb_node		rb_node;
71 	struct rb_root		entries;
72 	u64			nr_entries;
73 	struct events_stats	stats;
74 	u64			config;
75 	u64			event_stream;
76 	u32			type;
77 	u16			col_len[HISTC_NR_COLS];
78 };
79 
80 struct hist_entry *__hists__add_entry(struct hists *self,
81 				      struct addr_location *al,
82 				      struct symbol *parent, u64 period);
83 extern int64_t hist_entry__cmp(struct hist_entry *, struct hist_entry *);
84 extern int64_t hist_entry__collapse(struct hist_entry *, struct hist_entry *);
85 int hist_entry__fprintf(struct hist_entry *self, struct hists *hists,
86 			struct hists *pair_hists, bool show_displacement,
87 			long displacement, FILE *fp, u64 total);
88 int hist_entry__snprintf(struct hist_entry *self, char *bf, size_t size,
89 			 struct hists *hists, struct hists *pair_hists,
90 			 bool show_displacement, long displacement,
91 			 bool color, u64 total);
92 void hist_entry__free(struct hist_entry *);
93 
94 void hists__output_resort(struct hists *self);
95 void hists__collapse_resort(struct hists *self);
96 
97 void hists__inc_nr_events(struct hists *self, u32 type);
98 size_t hists__fprintf_nr_events(struct hists *self, FILE *fp);
99 
100 size_t hists__fprintf(struct hists *self, struct hists *pair,
101 		      bool show_displacement, FILE *fp);
102 
103 int hist_entry__inc_addr_samples(struct hist_entry *self, u64 ip);
104 int hist_entry__annotate(struct hist_entry *self, struct list_head *head);
105 
106 void hists__filter_by_dso(struct hists *self, const struct dso *dso);
107 void hists__filter_by_thread(struct hists *self, const struct thread *thread);
108 
109 u16 hists__col_len(struct hists *self, enum hist_column col);
110 void hists__set_col_len(struct hists *self, enum hist_column col, u16 len);
111 bool hists__new_col_len(struct hists *self, enum hist_column col, u16 len);
112 
113 #ifdef NO_NEWT_SUPPORT
114 static inline int hists__browse(struct hists *self __used,
115 				const char *helpline __used,
116 				const char *ev_name __used)
117 {
118 	return 0;
119 }
120 
121 static inline int hists__tui_browse_tree(struct rb_root *self __used,
122 					 const char *help __used)
123 {
124 	return 0;
125 }
126 
127 static inline int hist_entry__tui_annotate(struct hist_entry *self __used)
128 {
129 	return 0;
130 }
131 #define KEY_LEFT -1
132 #define KEY_RIGHT -2
133 #else
134 #include <newt.h>
135 int hists__browse(struct hists *self, const char *helpline,
136 		  const char *ev_name);
137 int hist_entry__tui_annotate(struct hist_entry *self);
138 
139 #define KEY_LEFT NEWT_KEY_LEFT
140 #define KEY_RIGHT NEWT_KEY_RIGHT
141 
142 int hists__tui_browse_tree(struct rb_root *self, const char *help);
143 #endif
144 
145 unsigned int hists__sort_list_width(struct hists *self);
146 
147 #endif	/* __PERF_HIST_H */
148