9413f3e31fea8b5c1c305f1d914b7de2d3e12009
[linux-3.10.git] / tools / perf / util / hist.h
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_lost_warned;
32         u32 nr_unknown_events;
33         u32 nr_invalid_chains;
34         u32 nr_unknown_id;
35         u32 nr_unprocessable_samples;
36 };
37
38 enum hist_column {
39         HISTC_SYMBOL,
40         HISTC_DSO,
41         HISTC_THREAD,
42         HISTC_COMM,
43         HISTC_PARENT,
44         HISTC_CPU,
45         HISTC_MISPREDICT,
46         HISTC_SYMBOL_FROM,
47         HISTC_SYMBOL_TO,
48         HISTC_DSO_FROM,
49         HISTC_DSO_TO,
50         HISTC_NR_COLS, /* Last entry */
51 };
52
53 struct thread;
54 struct dso;
55
56 struct hists {
57         struct rb_root          entries_in_array[2];
58         struct rb_root          *entries_in;
59         struct rb_root          entries;
60         struct rb_root          entries_collapsed;
61         u64                     nr_entries;
62         const struct thread     *thread_filter;
63         const struct dso        *dso_filter;
64         const char              *uid_filter_str;
65         pthread_mutex_t         lock;
66         struct events_stats     stats;
67         u64                     event_stream;
68         u16                     col_len[HISTC_NR_COLS];
69         /* Best would be to reuse the session callchain cursor */
70         struct callchain_cursor callchain_cursor;
71 };
72
73 struct hist_entry *__hists__add_entry(struct hists *self,
74                                       struct addr_location *al,
75                                       struct symbol *parent, u64 period);
76 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
77 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
78 int hist_entry__snprintf(struct hist_entry *self, char *bf, size_t size,
79                          struct hists *hists);
80 void hist_entry__free(struct hist_entry *);
81
82 struct hist_entry *__hists__add_branch_entry(struct hists *self,
83                                              struct addr_location *al,
84                                              struct symbol *sym_parent,
85                                              struct branch_info *bi,
86                                              u64 period);
87
88 void hists__output_resort(struct hists *self);
89 void hists__output_resort_threaded(struct hists *hists);
90 void hists__collapse_resort(struct hists *self);
91 void hists__collapse_resort_threaded(struct hists *hists);
92
93 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
94 void hists__decay_entries_threaded(struct hists *hists, bool zap_user,
95                                    bool zap_kernel);
96 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
97
98 void hists__inc_nr_events(struct hists *self, u32 type);
99 size_t hists__fprintf_nr_events(struct hists *self, FILE *fp);
100
101 size_t hists__fprintf(struct hists *self, struct hists *pair,
102                       bool show_displacement, bool show_header,
103                       int max_rows, int max_cols, FILE *fp);
104
105 int hist_entry__inc_addr_samples(struct hist_entry *self, int evidx, u64 addr);
106 int hist_entry__annotate(struct hist_entry *self, size_t privsize);
107
108 void hists__filter_by_dso(struct hists *hists);
109 void hists__filter_by_thread(struct hists *hists);
110
111 u16 hists__col_len(struct hists *self, enum hist_column col);
112 void hists__set_col_len(struct hists *self, enum hist_column col, u16 len);
113 bool hists__new_col_len(struct hists *self, enum hist_column col, u16 len);
114
115 struct perf_evlist;
116
117 #ifdef NO_NEWT_SUPPORT
118 static inline
119 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __used,
120                                   const char *help __used,
121                                   void(*timer)(void *arg) __used,
122                                   void *arg __used,
123                                   int refresh __used)
124 {
125         return 0;
126 }
127
128 static inline int hist_entry__tui_annotate(struct hist_entry *self __used,
129                                            int evidx __used,
130                                            void(*timer)(void *arg) __used,
131                                            void *arg __used,
132                                            int delay_secs __used)
133 {
134         return 0;
135 }
136 #define K_LEFT -1
137 #define K_RIGHT -2
138 #else
139 #include "ui/keysyms.h"
140 int hist_entry__tui_annotate(struct hist_entry *he, int evidx,
141                              void(*timer)(void *arg), void *arg, int delay_secs);
142
143 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
144                                   void(*timer)(void *arg), void *arg,
145                                   int refresh);
146 #endif
147
148 unsigned int hists__sort_list_width(struct hists *self);
149
150 #endif  /* __PERF_HIST_H */