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