perf tools: Centralize default columns init in perf_hpp__init
[cascardo/linux.git] / tools / perf / ui / hist.c
1 #include <math.h>
2 #include <linux/compiler.h>
3
4 #include "../util/hist.h"
5 #include "../util/util.h"
6 #include "../util/sort.h"
7 #include "../util/evsel.h"
8
9 /* hist period print (hpp) functions */
10
11 typedef int (*hpp_snprint_fn)(char *buf, size_t size, const char *fmt, ...);
12
13 static int __hpp__fmt(struct perf_hpp *hpp, struct hist_entry *he,
14                       u64 (*get_field)(struct hist_entry *),
15                       const char *fmt, hpp_snprint_fn print_fn,
16                       bool fmt_percent)
17 {
18         int ret;
19         struct hists *hists = he->hists;
20         struct perf_evsel *evsel = hists_to_evsel(hists);
21
22         if (fmt_percent) {
23                 double percent = 0.0;
24
25                 if (hists->stats.total_period)
26                         percent = 100.0 * get_field(he) /
27                                   hists->stats.total_period;
28
29                 ret = print_fn(hpp->buf, hpp->size, fmt, percent);
30         } else
31                 ret = print_fn(hpp->buf, hpp->size, fmt, get_field(he));
32
33         if (perf_evsel__is_group_event(evsel)) {
34                 int prev_idx, idx_delta;
35                 struct hist_entry *pair;
36                 int nr_members = evsel->nr_members;
37
38                 prev_idx = perf_evsel__group_idx(evsel);
39
40                 list_for_each_entry(pair, &he->pairs.head, pairs.node) {
41                         u64 period = get_field(pair);
42                         u64 total = pair->hists->stats.total_period;
43
44                         if (!total)
45                                 continue;
46
47                         evsel = hists_to_evsel(pair->hists);
48                         idx_delta = perf_evsel__group_idx(evsel) - prev_idx - 1;
49
50                         while (idx_delta--) {
51                                 /*
52                                  * zero-fill group members in the middle which
53                                  * have no sample
54                                  */
55                                 ret += print_fn(hpp->buf + ret, hpp->size - ret,
56                                                 fmt, 0);
57                         }
58
59                         if (fmt_percent)
60                                 ret += print_fn(hpp->buf + ret, hpp->size - ret,
61                                                 fmt, 100.0 * period / total);
62                         else
63                                 ret += print_fn(hpp->buf + ret, hpp->size - ret,
64                                                 fmt, period);
65
66                         prev_idx = perf_evsel__group_idx(evsel);
67                 }
68
69                 idx_delta = nr_members - prev_idx - 1;
70
71                 while (idx_delta--) {
72                         /*
73                          * zero-fill group members at last which have no sample
74                          */
75                         ret += print_fn(hpp->buf + ret, hpp->size - ret,
76                                         fmt, 0);
77                 }
78         }
79         return ret;
80 }
81
82 #define __HPP_HEADER_FN(_type, _str, _min_width, _unit_width)           \
83 static int hpp__header_##_type(struct perf_hpp_fmt *fmt __maybe_unused, \
84                                struct perf_hpp *hpp)                    \
85 {                                                                       \
86         int len = _min_width;                                           \
87                                                                         \
88         if (symbol_conf.event_group) {                                  \
89                 struct perf_evsel *evsel = hpp->ptr;                    \
90                                                                         \
91                 len = max(len, evsel->nr_members * _unit_width);        \
92         }                                                               \
93         return scnprintf(hpp->buf, hpp->size, "%*s", len, _str);        \
94 }
95
96 #define __HPP_WIDTH_FN(_type, _min_width, _unit_width)                  \
97 static int hpp__width_##_type(struct perf_hpp_fmt *fmt __maybe_unused,  \
98                               struct perf_hpp *hpp __maybe_unused)      \
99 {                                                                       \
100         int len = _min_width;                                           \
101                                                                         \
102         if (symbol_conf.event_group) {                                  \
103                 struct perf_evsel *evsel = hpp->ptr;                    \
104                                                                         \
105                 len = max(len, evsel->nr_members * _unit_width);        \
106         }                                                               \
107         return len;                                                     \
108 }
109
110 #define __HPP_COLOR_PERCENT_FN(_type, _field)                                   \
111 static u64 he_get_##_field(struct hist_entry *he)                               \
112 {                                                                               \
113         return he->stat._field;                                                 \
114 }                                                                               \
115                                                                                 \
116 static int hpp__color_##_type(struct perf_hpp_fmt *fmt __maybe_unused,          \
117                               struct perf_hpp *hpp, struct hist_entry *he)      \
118 {                                                                               \
119         return __hpp__fmt(hpp, he, he_get_##_field, " %6.2f%%",                 \
120                           (hpp_snprint_fn)percent_color_snprintf, true);        \
121 }
122
123 #define __HPP_ENTRY_PERCENT_FN(_type, _field)                                   \
124 static int hpp__entry_##_type(struct perf_hpp_fmt *_fmt __maybe_unused,         \
125                               struct perf_hpp *hpp, struct hist_entry *he)      \
126 {                                                                               \
127         const char *fmt = symbol_conf.field_sep ? " %.2f" : " %6.2f%%";         \
128         return __hpp__fmt(hpp, he, he_get_##_field, fmt,                        \
129                           scnprintf, true);                                     \
130 }
131
132 #define __HPP_ENTRY_RAW_FN(_type, _field)                                       \
133 static u64 he_get_raw_##_field(struct hist_entry *he)                           \
134 {                                                                               \
135         return he->stat._field;                                                 \
136 }                                                                               \
137                                                                                 \
138 static int hpp__entry_##_type(struct perf_hpp_fmt *_fmt __maybe_unused,         \
139                               struct perf_hpp *hpp, struct hist_entry *he)      \
140 {                                                                               \
141         const char *fmt = symbol_conf.field_sep ? " %"PRIu64 : " %11"PRIu64;    \
142         return __hpp__fmt(hpp, he, he_get_raw_##_field, fmt, scnprintf, false); \
143 }
144
145 #define HPP_PERCENT_FNS(_type, _str, _field, _min_width, _unit_width)   \
146 __HPP_HEADER_FN(_type, _str, _min_width, _unit_width)                   \
147 __HPP_WIDTH_FN(_type, _min_width, _unit_width)                          \
148 __HPP_COLOR_PERCENT_FN(_type, _field)                                   \
149 __HPP_ENTRY_PERCENT_FN(_type, _field)
150
151 #define HPP_RAW_FNS(_type, _str, _field, _min_width, _unit_width)       \
152 __HPP_HEADER_FN(_type, _str, _min_width, _unit_width)                   \
153 __HPP_WIDTH_FN(_type, _min_width, _unit_width)                          \
154 __HPP_ENTRY_RAW_FN(_type, _field)
155
156
157 HPP_PERCENT_FNS(overhead, "Overhead", period, 8, 8)
158 HPP_PERCENT_FNS(overhead_sys, "sys", period_sys, 8, 8)
159 HPP_PERCENT_FNS(overhead_us, "usr", period_us, 8, 8)
160 HPP_PERCENT_FNS(overhead_guest_sys, "guest sys", period_guest_sys, 9, 8)
161 HPP_PERCENT_FNS(overhead_guest_us, "guest usr", period_guest_us, 9, 8)
162
163 HPP_RAW_FNS(samples, "Samples", nr_events, 12, 12)
164 HPP_RAW_FNS(period, "Period", period, 12, 12)
165
166
167 static int hpp__header_baseline(struct perf_hpp_fmt *fmt __maybe_unused,
168                                 struct perf_hpp *hpp)
169 {
170         return scnprintf(hpp->buf, hpp->size, "Baseline");
171 }
172
173 static int hpp__width_baseline(struct perf_hpp_fmt *fmt __maybe_unused,
174                                struct perf_hpp *hpp __maybe_unused)
175 {
176         return 8;
177 }
178
179 static double baseline_percent(struct hist_entry *he)
180 {
181         struct hist_entry *pair = hist_entry__next_pair(he);
182         struct hists *pair_hists = pair ? pair->hists : NULL;
183         double percent = 0.0;
184
185         if (pair) {
186                 u64 total_period = pair_hists->stats.total_period;
187                 u64 base_period  = pair->stat.period;
188
189                 percent = 100.0 * base_period / total_period;
190         }
191
192         return percent;
193 }
194
195 static int hpp__color_baseline(struct perf_hpp_fmt *fmt __maybe_unused,
196                                struct perf_hpp *hpp, struct hist_entry *he)
197 {
198         double percent = baseline_percent(he);
199
200         if (hist_entry__has_pairs(he) || symbol_conf.field_sep)
201                 return percent_color_snprintf(hpp->buf, hpp->size, " %6.2f%%", percent);
202         else
203                 return scnprintf(hpp->buf, hpp->size, "        ");
204 }
205
206 static int hpp__entry_baseline(struct perf_hpp_fmt *_fmt __maybe_unused,
207                                struct perf_hpp *hpp, struct hist_entry *he)
208 {
209         double percent = baseline_percent(he);
210         const char *fmt = symbol_conf.field_sep ? "%.2f" : " %6.2f%%";
211
212         if (hist_entry__has_pairs(he) || symbol_conf.field_sep)
213                 return scnprintf(hpp->buf, hpp->size, fmt, percent);
214         else
215                 return scnprintf(hpp->buf, hpp->size, "            ");
216 }
217
218 static int hpp__header_period_baseline(struct perf_hpp_fmt *_fmt __maybe_unused,
219                                        struct perf_hpp *hpp)
220 {
221         const char *fmt = symbol_conf.field_sep ? "%s" : "%12s";
222
223         return scnprintf(hpp->buf, hpp->size, fmt, "Period Base");
224 }
225
226 static int hpp__width_period_baseline(struct perf_hpp_fmt *fmt __maybe_unused,
227                                       struct perf_hpp *hpp __maybe_unused)
228 {
229         return 12;
230 }
231
232 static int hpp__entry_period_baseline(struct perf_hpp_fmt *_fmt __maybe_unused,
233                                       struct perf_hpp *hpp, struct hist_entry *he)
234 {
235         struct hist_entry *pair = hist_entry__next_pair(he);
236         u64 period = pair ? pair->stat.period : 0;
237         const char *fmt = symbol_conf.field_sep ? "%" PRIu64 : "%12" PRIu64;
238
239         return scnprintf(hpp->buf, hpp->size, fmt, period);
240 }
241
242 static int hpp__header_delta(struct perf_hpp_fmt *_fmt __maybe_unused,
243                              struct perf_hpp *hpp)
244 {
245         const char *fmt = symbol_conf.field_sep ? "%s" : "%7s";
246
247         return scnprintf(hpp->buf, hpp->size, fmt, "Delta");
248 }
249
250 static int hpp__width_delta(struct perf_hpp_fmt *fmt __maybe_unused,
251                             struct perf_hpp *hpp __maybe_unused)
252 {
253         return 7;
254 }
255
256 static int hpp__entry_delta(struct perf_hpp_fmt *_fmt __maybe_unused,
257                             struct perf_hpp *hpp, struct hist_entry *he)
258 {
259         struct hist_entry *pair = hist_entry__next_pair(he);
260         const char *fmt = symbol_conf.field_sep ? "%s" : "%7.7s";
261         char buf[32] = " ";
262         double diff = 0.0;
263
264         if (pair) {
265                 if (he->diff.computed)
266                         diff = he->diff.period_ratio_delta;
267                 else
268                         diff = perf_diff__compute_delta(he, pair);
269         } else
270                 diff = perf_diff__period_percent(he, he->stat.period);
271
272         if (fabs(diff) >= 0.01)
273                 scnprintf(buf, sizeof(buf), "%+4.2F%%", diff);
274
275         return scnprintf(hpp->buf, hpp->size, fmt, buf);
276 }
277
278 static int hpp__header_ratio(struct perf_hpp_fmt *_fmt __maybe_unused,
279                              struct perf_hpp *hpp)
280 {
281         const char *fmt = symbol_conf.field_sep ? "%s" : "%14s";
282
283         return scnprintf(hpp->buf, hpp->size, fmt, "Ratio");
284 }
285
286 static int hpp__width_ratio(struct perf_hpp_fmt *fmt __maybe_unused,
287                             struct perf_hpp *hpp __maybe_unused)
288 {
289         return 14;
290 }
291
292 static int hpp__entry_ratio(struct perf_hpp_fmt *_fmt __maybe_unused,
293                             struct perf_hpp *hpp, struct hist_entry *he)
294 {
295         struct hist_entry *pair = hist_entry__next_pair(he);
296         const char *fmt = symbol_conf.field_sep ? "%s" : "%14s";
297         char buf[32] = " ";
298         double ratio = 0.0;
299
300         if (pair) {
301                 if (he->diff.computed)
302                         ratio = he->diff.period_ratio;
303                 else
304                         ratio = perf_diff__compute_ratio(he, pair);
305         }
306
307         if (ratio > 0.0)
308                 scnprintf(buf, sizeof(buf), "%+14.6F", ratio);
309
310         return scnprintf(hpp->buf, hpp->size, fmt, buf);
311 }
312
313 static int hpp__header_wdiff(struct perf_hpp_fmt *_fmt __maybe_unused,
314                              struct perf_hpp *hpp)
315 {
316         const char *fmt = symbol_conf.field_sep ? "%s" : "%14s";
317
318         return scnprintf(hpp->buf, hpp->size, fmt, "Weighted diff");
319 }
320
321 static int hpp__width_wdiff(struct perf_hpp_fmt *fmt __maybe_unused,
322                             struct perf_hpp *hpp __maybe_unused)
323 {
324         return 14;
325 }
326
327 static int hpp__entry_wdiff(struct perf_hpp_fmt *_fmt __maybe_unused,
328                             struct perf_hpp *hpp, struct hist_entry *he)
329 {
330         struct hist_entry *pair = hist_entry__next_pair(he);
331         const char *fmt = symbol_conf.field_sep ? "%s" : "%14s";
332         char buf[32] = " ";
333         s64 wdiff = 0;
334
335         if (pair) {
336                 if (he->diff.computed)
337                         wdiff = he->diff.wdiff;
338                 else
339                         wdiff = perf_diff__compute_wdiff(he, pair);
340         }
341
342         if (wdiff != 0)
343                 scnprintf(buf, sizeof(buf), "%14ld", wdiff);
344
345         return scnprintf(hpp->buf, hpp->size, fmt, buf);
346 }
347
348 static int hpp__header_formula(struct perf_hpp_fmt *_fmt __maybe_unused,
349                                struct perf_hpp *hpp)
350 {
351         const char *fmt = symbol_conf.field_sep ? "%s" : "%70s";
352
353         return scnprintf(hpp->buf, hpp->size, fmt, "Formula");
354 }
355
356 static int hpp__width_formula(struct perf_hpp_fmt *fmt __maybe_unused,
357                               struct perf_hpp *hpp __maybe_unused)
358 {
359         return 70;
360 }
361
362 static int hpp__entry_formula(struct perf_hpp_fmt *_fmt __maybe_unused,
363                               struct perf_hpp *hpp, struct hist_entry *he)
364 {
365         struct hist_entry *pair = hist_entry__next_pair(he);
366         const char *fmt = symbol_conf.field_sep ? "%s" : "%-70s";
367         char buf[96] = " ";
368
369         if (pair)
370                 perf_diff__formula(he, pair, buf, sizeof(buf));
371
372         return scnprintf(hpp->buf, hpp->size, fmt, buf);
373 }
374
375 #define HPP__COLOR_PRINT_FNS(_name)                     \
376         {                                               \
377                 .header = hpp__header_ ## _name,        \
378                 .width  = hpp__width_ ## _name,         \
379                 .color  = hpp__color_ ## _name,         \
380                 .entry  = hpp__entry_ ## _name          \
381         }
382
383 #define HPP__PRINT_FNS(_name)                           \
384         {                                               \
385                 .header = hpp__header_ ## _name,        \
386                 .width  = hpp__width_ ## _name,         \
387                 .entry  = hpp__entry_ ## _name          \
388         }
389
390 struct perf_hpp_fmt perf_hpp__format[] = {
391         HPP__COLOR_PRINT_FNS(baseline),
392         HPP__COLOR_PRINT_FNS(overhead),
393         HPP__COLOR_PRINT_FNS(overhead_sys),
394         HPP__COLOR_PRINT_FNS(overhead_us),
395         HPP__COLOR_PRINT_FNS(overhead_guest_sys),
396         HPP__COLOR_PRINT_FNS(overhead_guest_us),
397         HPP__PRINT_FNS(samples),
398         HPP__PRINT_FNS(period),
399         HPP__PRINT_FNS(period_baseline),
400         HPP__PRINT_FNS(delta),
401         HPP__PRINT_FNS(ratio),
402         HPP__PRINT_FNS(wdiff),
403         HPP__PRINT_FNS(formula)
404 };
405
406 LIST_HEAD(perf_hpp__list);
407
408
409 #undef HPP__COLOR_PRINT_FNS
410 #undef HPP__PRINT_FNS
411
412 #undef HPP_PERCENT_FNS
413 #undef HPP_RAW_FNS
414
415 #undef __HPP_HEADER_FN
416 #undef __HPP_WIDTH_FN
417 #undef __HPP_COLOR_PERCENT_FN
418 #undef __HPP_ENTRY_PERCENT_FN
419 #undef __HPP_ENTRY_RAW_FN
420
421
422 void perf_hpp__init(void)
423 {
424         perf_hpp__column_enable(PERF_HPP__OVERHEAD);
425
426         if (symbol_conf.show_cpu_utilization) {
427                 perf_hpp__column_enable(PERF_HPP__OVERHEAD_SYS);
428                 perf_hpp__column_enable(PERF_HPP__OVERHEAD_US);
429
430                 if (perf_guest) {
431                         perf_hpp__column_enable(PERF_HPP__OVERHEAD_GUEST_SYS);
432                         perf_hpp__column_enable(PERF_HPP__OVERHEAD_GUEST_US);
433                 }
434         }
435
436         if (symbol_conf.show_nr_samples)
437                 perf_hpp__column_enable(PERF_HPP__SAMPLES);
438
439         if (symbol_conf.show_total_period)
440                 perf_hpp__column_enable(PERF_HPP__PERIOD);
441 }
442
443 void perf_hpp__column_register(struct perf_hpp_fmt *format)
444 {
445         list_add_tail(&format->list, &perf_hpp__list);
446 }
447
448 void perf_hpp__column_enable(unsigned col)
449 {
450         BUG_ON(col >= PERF_HPP__MAX_INDEX);
451         perf_hpp__column_register(&perf_hpp__format[col]);
452 }
453
454 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
455 {
456         hpp->buf  += inc;
457         hpp->size -= inc;
458 }
459
460 int hist_entry__period_snprintf(struct perf_hpp *hpp, struct hist_entry *he,
461                                 bool color)
462 {
463         const char *sep = symbol_conf.field_sep;
464         struct perf_hpp_fmt *fmt;
465         char *start = hpp->buf;
466         int ret;
467         bool first = true;
468
469         if (symbol_conf.exclude_other && !he->parent)
470                 return 0;
471
472         perf_hpp__for_each_format(fmt) {
473                 /*
474                  * If there's no field_sep, we still need
475                  * to display initial '  '.
476                  */
477                 if (!sep || !first) {
478                         ret = scnprintf(hpp->buf, hpp->size, "%s", sep ?: "  ");
479                         advance_hpp(hpp, ret);
480                 } else
481                         first = false;
482
483                 if (color && fmt->color)
484                         ret = fmt->color(fmt, hpp, he);
485                 else
486                         ret = fmt->entry(fmt, hpp, he);
487
488                 advance_hpp(hpp, ret);
489         }
490
491         return hpp->buf - start;
492 }
493
494 int hist_entry__sort_snprintf(struct hist_entry *he, char *s, size_t size,
495                               struct hists *hists)
496 {
497         const char *sep = symbol_conf.field_sep;
498         struct sort_entry *se;
499         int ret = 0;
500
501         list_for_each_entry(se, &hist_entry__sort_list, list) {
502                 if (se->elide)
503                         continue;
504
505                 ret += scnprintf(s + ret, size - ret, "%s", sep ?: "  ");
506                 ret += se->se_snprintf(he, s + ret, size - ret,
507                                        hists__col_len(hists, se->se_width_idx));
508         }
509
510         return ret;
511 }
512
513 /*
514  * See hists__fprintf to match the column widths
515  */
516 unsigned int hists__sort_list_width(struct hists *hists)
517 {
518         struct perf_hpp_fmt *fmt;
519         struct sort_entry *se;
520         int i = 0, ret = 0;
521         struct perf_hpp dummy_hpp = {
522                 .ptr    = hists_to_evsel(hists),
523         };
524
525         perf_hpp__for_each_format(fmt) {
526                 if (i)
527                         ret += 2;
528
529                 ret += fmt->width(fmt, &dummy_hpp);
530         }
531
532         list_for_each_entry(se, &hist_entry__sort_list, list)
533                 if (!se->elide)
534                         ret += 2 + hists__col_len(hists, se->se_width_idx);
535
536         if (verbose) /* Addr + origin */
537                 ret += 3 + BITS_PER_LONG / 4;
538
539         return ret;
540 }