2 #include <linux/compiler.h>
4 #include "../util/hist.h"
5 #include "../util/util.h"
6 #include "../util/sort.h"
7 #include "../util/evsel.h"
8 #include "../util/evlist.h"
10 /* hist period print (hpp) functions */
12 #define hpp__call_print_fn(hpp, fn, fmt, ...) \
14 int __ret = fn(hpp, fmt, ##__VA_ARGS__); \
15 advance_hpp(hpp, __ret); \
19 static int __hpp__fmt(struct perf_hpp *hpp, struct hist_entry *he,
20 hpp_field_fn get_field, const char *fmt, int len,
21 hpp_snprint_fn print_fn, bool fmt_percent)
24 struct hists *hists = he->hists;
25 struct perf_evsel *evsel = hists_to_evsel(hists);
27 size_t size = hpp->size;
31 u64 total = hists__total_period(hists);
34 percent = 100.0 * get_field(he) / total;
36 ret = hpp__call_print_fn(hpp, print_fn, fmt, len, percent);
38 ret = hpp__call_print_fn(hpp, print_fn, fmt, len, get_field(he));
40 if (perf_evsel__is_group_event(evsel)) {
41 int prev_idx, idx_delta;
42 struct hist_entry *pair;
43 int nr_members = evsel->nr_members;
45 prev_idx = perf_evsel__group_idx(evsel);
47 list_for_each_entry(pair, &he->pairs.head, pairs.node) {
48 u64 period = get_field(pair);
49 u64 total = hists__total_period(pair->hists);
54 evsel = hists_to_evsel(pair->hists);
55 idx_delta = perf_evsel__group_idx(evsel) - prev_idx - 1;
59 * zero-fill group members in the middle which
63 ret += hpp__call_print_fn(hpp, print_fn,
66 ret += hpp__call_print_fn(hpp, print_fn,
72 ret += hpp__call_print_fn(hpp, print_fn, fmt, len,
73 100.0 * period / total);
75 ret += hpp__call_print_fn(hpp, print_fn, fmt,
79 prev_idx = perf_evsel__group_idx(evsel);
82 idx_delta = nr_members - prev_idx - 1;
86 * zero-fill group members at last which have no sample
89 ret += hpp__call_print_fn(hpp, print_fn,
92 ret += hpp__call_print_fn(hpp, print_fn,
99 * Restore original buf and size as it's where caller expects
100 * the result will be saved.
108 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
109 struct hist_entry *he, hpp_field_fn get_field,
110 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent)
112 int len = fmt->user_len ?: fmt->len;
114 if (symbol_conf.field_sep) {
115 return __hpp__fmt(hpp, he, get_field, fmtstr, 1,
116 print_fn, fmt_percent);
120 len -= 2; /* 2 for a space and a % sign */
124 return __hpp__fmt(hpp, he, get_field, fmtstr, len, print_fn, fmt_percent);
127 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
128 struct hist_entry *he, hpp_field_fn get_field,
129 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent)
131 if (!symbol_conf.cumulate_callchain) {
132 int len = fmt->user_len ?: fmt->len;
133 return snprintf(hpp->buf, hpp->size, " %*s", len - 1, "N/A");
136 return hpp__fmt(fmt, hpp, he, get_field, fmtstr, print_fn, fmt_percent);
139 static int field_cmp(u64 field_a, u64 field_b)
141 if (field_a > field_b)
143 if (field_a < field_b)
148 static int __hpp__sort(struct hist_entry *a, struct hist_entry *b,
149 hpp_field_fn get_field)
153 struct perf_evsel *evsel;
154 struct hist_entry *pair;
155 u64 *fields_a, *fields_b;
157 ret = field_cmp(get_field(a), get_field(b));
158 if (ret || !symbol_conf.event_group)
161 evsel = hists_to_evsel(a->hists);
162 if (!perf_evsel__is_group_event(evsel))
165 nr_members = evsel->nr_members;
166 fields_a = calloc(nr_members, sizeof(*fields_a));
167 fields_b = calloc(nr_members, sizeof(*fields_b));
169 if (!fields_a || !fields_b)
172 list_for_each_entry(pair, &a->pairs.head, pairs.node) {
173 evsel = hists_to_evsel(pair->hists);
174 fields_a[perf_evsel__group_idx(evsel)] = get_field(pair);
177 list_for_each_entry(pair, &b->pairs.head, pairs.node) {
178 evsel = hists_to_evsel(pair->hists);
179 fields_b[perf_evsel__group_idx(evsel)] = get_field(pair);
182 for (i = 1; i < nr_members; i++) {
183 ret = field_cmp(fields_a[i], fields_b[i]);
195 static int __hpp__sort_acc(struct hist_entry *a, struct hist_entry *b,
196 hpp_field_fn get_field)
200 if (symbol_conf.cumulate_callchain) {
202 * Put caller above callee when they have equal period.
204 ret = field_cmp(get_field(a), get_field(b));
208 if (a->thread != b->thread || !symbol_conf.use_callchain)
211 ret = b->callchain->max_depth - a->callchain->max_depth;
216 static int hpp__width_fn(struct perf_hpp_fmt *fmt,
217 struct perf_hpp *hpp __maybe_unused,
220 int len = fmt->user_len ?: fmt->len;
221 struct perf_evsel *evsel = hists_to_evsel(hists);
223 if (symbol_conf.event_group)
224 len = max(len, evsel->nr_members * fmt->len);
226 if (len < (int)strlen(fmt->name))
227 len = strlen(fmt->name);
232 static int hpp__header_fn(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
233 struct hists *hists, int line __maybe_unused,
234 int *span __maybe_unused)
236 int len = hpp__width_fn(fmt, hpp, hists);
237 return scnprintf(hpp->buf, hpp->size, "%*s", len, fmt->name);
240 int hpp_color_scnprintf(struct perf_hpp *hpp, const char *fmt, ...)
243 ssize_t ssize = hpp->size;
248 len = va_arg(args, int);
249 percent = va_arg(args, double);
250 ret = percent_color_len_snprintf(hpp->buf, hpp->size, fmt, len, percent);
253 return (ret >= ssize) ? (ssize - 1) : ret;
256 static int hpp_entry_scnprintf(struct perf_hpp *hpp, const char *fmt, ...)
259 ssize_t ssize = hpp->size;
263 ret = vsnprintf(hpp->buf, hpp->size, fmt, args);
266 return (ret >= ssize) ? (ssize - 1) : ret;
269 #define __HPP_COLOR_PERCENT_FN(_type, _field) \
270 static u64 he_get_##_field(struct hist_entry *he) \
272 return he->stat._field; \
275 static int hpp__color_##_type(struct perf_hpp_fmt *fmt, \
276 struct perf_hpp *hpp, struct hist_entry *he) \
278 return hpp__fmt(fmt, hpp, he, he_get_##_field, " %*.2f%%", \
279 hpp_color_scnprintf, true); \
282 #define __HPP_ENTRY_PERCENT_FN(_type, _field) \
283 static int hpp__entry_##_type(struct perf_hpp_fmt *fmt, \
284 struct perf_hpp *hpp, struct hist_entry *he) \
286 return hpp__fmt(fmt, hpp, he, he_get_##_field, " %*.2f%%", \
287 hpp_entry_scnprintf, true); \
290 #define __HPP_SORT_FN(_type, _field) \
291 static int64_t hpp__sort_##_type(struct perf_hpp_fmt *fmt __maybe_unused, \
292 struct hist_entry *a, struct hist_entry *b) \
294 return __hpp__sort(a, b, he_get_##_field); \
297 #define __HPP_COLOR_ACC_PERCENT_FN(_type, _field) \
298 static u64 he_get_acc_##_field(struct hist_entry *he) \
300 return he->stat_acc->_field; \
303 static int hpp__color_##_type(struct perf_hpp_fmt *fmt, \
304 struct perf_hpp *hpp, struct hist_entry *he) \
306 return hpp__fmt_acc(fmt, hpp, he, he_get_acc_##_field, " %*.2f%%", \
307 hpp_color_scnprintf, true); \
310 #define __HPP_ENTRY_ACC_PERCENT_FN(_type, _field) \
311 static int hpp__entry_##_type(struct perf_hpp_fmt *fmt, \
312 struct perf_hpp *hpp, struct hist_entry *he) \
314 return hpp__fmt_acc(fmt, hpp, he, he_get_acc_##_field, " %*.2f%%", \
315 hpp_entry_scnprintf, true); \
318 #define __HPP_SORT_ACC_FN(_type, _field) \
319 static int64_t hpp__sort_##_type(struct perf_hpp_fmt *fmt __maybe_unused, \
320 struct hist_entry *a, struct hist_entry *b) \
322 return __hpp__sort_acc(a, b, he_get_acc_##_field); \
325 #define __HPP_ENTRY_RAW_FN(_type, _field) \
326 static u64 he_get_raw_##_field(struct hist_entry *he) \
328 return he->stat._field; \
331 static int hpp__entry_##_type(struct perf_hpp_fmt *fmt, \
332 struct perf_hpp *hpp, struct hist_entry *he) \
334 return hpp__fmt(fmt, hpp, he, he_get_raw_##_field, " %*"PRIu64, \
335 hpp_entry_scnprintf, false); \
338 #define __HPP_SORT_RAW_FN(_type, _field) \
339 static int64_t hpp__sort_##_type(struct perf_hpp_fmt *fmt __maybe_unused, \
340 struct hist_entry *a, struct hist_entry *b) \
342 return __hpp__sort(a, b, he_get_raw_##_field); \
346 #define HPP_PERCENT_FNS(_type, _field) \
347 __HPP_COLOR_PERCENT_FN(_type, _field) \
348 __HPP_ENTRY_PERCENT_FN(_type, _field) \
349 __HPP_SORT_FN(_type, _field)
351 #define HPP_PERCENT_ACC_FNS(_type, _field) \
352 __HPP_COLOR_ACC_PERCENT_FN(_type, _field) \
353 __HPP_ENTRY_ACC_PERCENT_FN(_type, _field) \
354 __HPP_SORT_ACC_FN(_type, _field)
356 #define HPP_RAW_FNS(_type, _field) \
357 __HPP_ENTRY_RAW_FN(_type, _field) \
358 __HPP_SORT_RAW_FN(_type, _field)
360 HPP_PERCENT_FNS(overhead, period)
361 HPP_PERCENT_FNS(overhead_sys, period_sys)
362 HPP_PERCENT_FNS(overhead_us, period_us)
363 HPP_PERCENT_FNS(overhead_guest_sys, period_guest_sys)
364 HPP_PERCENT_FNS(overhead_guest_us, period_guest_us)
365 HPP_PERCENT_ACC_FNS(overhead_acc, period)
367 HPP_RAW_FNS(samples, nr_events)
368 HPP_RAW_FNS(period, period)
370 static int64_t hpp__nop_cmp(struct perf_hpp_fmt *fmt __maybe_unused,
371 struct hist_entry *a __maybe_unused,
372 struct hist_entry *b __maybe_unused)
377 static bool perf_hpp__is_hpp_entry(struct perf_hpp_fmt *a)
379 return a->header == hpp__header_fn;
382 static bool hpp__equal(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b)
384 if (!perf_hpp__is_hpp_entry(a) || !perf_hpp__is_hpp_entry(b))
387 return a->idx == b->idx;
390 #define HPP__COLOR_PRINT_FNS(_name, _fn, _idx) \
393 .header = hpp__header_fn, \
394 .width = hpp__width_fn, \
395 .color = hpp__color_ ## _fn, \
396 .entry = hpp__entry_ ## _fn, \
397 .cmp = hpp__nop_cmp, \
398 .collapse = hpp__nop_cmp, \
399 .sort = hpp__sort_ ## _fn, \
400 .idx = PERF_HPP__ ## _idx, \
401 .equal = hpp__equal, \
404 #define HPP__COLOR_ACC_PRINT_FNS(_name, _fn, _idx) \
407 .header = hpp__header_fn, \
408 .width = hpp__width_fn, \
409 .color = hpp__color_ ## _fn, \
410 .entry = hpp__entry_ ## _fn, \
411 .cmp = hpp__nop_cmp, \
412 .collapse = hpp__nop_cmp, \
413 .sort = hpp__sort_ ## _fn, \
414 .idx = PERF_HPP__ ## _idx, \
415 .equal = hpp__equal, \
418 #define HPP__PRINT_FNS(_name, _fn, _idx) \
421 .header = hpp__header_fn, \
422 .width = hpp__width_fn, \
423 .entry = hpp__entry_ ## _fn, \
424 .cmp = hpp__nop_cmp, \
425 .collapse = hpp__nop_cmp, \
426 .sort = hpp__sort_ ## _fn, \
427 .idx = PERF_HPP__ ## _idx, \
428 .equal = hpp__equal, \
431 struct perf_hpp_fmt perf_hpp__format[] = {
432 HPP__COLOR_PRINT_FNS("Overhead", overhead, OVERHEAD),
433 HPP__COLOR_PRINT_FNS("sys", overhead_sys, OVERHEAD_SYS),
434 HPP__COLOR_PRINT_FNS("usr", overhead_us, OVERHEAD_US),
435 HPP__COLOR_PRINT_FNS("guest sys", overhead_guest_sys, OVERHEAD_GUEST_SYS),
436 HPP__COLOR_PRINT_FNS("guest usr", overhead_guest_us, OVERHEAD_GUEST_US),
437 HPP__COLOR_ACC_PRINT_FNS("Children", overhead_acc, OVERHEAD_ACC),
438 HPP__PRINT_FNS("Samples", samples, SAMPLES),
439 HPP__PRINT_FNS("Period", period, PERIOD)
442 struct perf_hpp_list perf_hpp_list = {
443 .fields = LIST_HEAD_INIT(perf_hpp_list.fields),
444 .sorts = LIST_HEAD_INIT(perf_hpp_list.sorts),
445 .nr_header_lines = 1,
448 #undef HPP__COLOR_PRINT_FNS
449 #undef HPP__COLOR_ACC_PRINT_FNS
450 #undef HPP__PRINT_FNS
452 #undef HPP_PERCENT_FNS
453 #undef HPP_PERCENT_ACC_FNS
456 #undef __HPP_HEADER_FN
457 #undef __HPP_WIDTH_FN
458 #undef __HPP_COLOR_PERCENT_FN
459 #undef __HPP_ENTRY_PERCENT_FN
460 #undef __HPP_COLOR_ACC_PERCENT_FN
461 #undef __HPP_ENTRY_ACC_PERCENT_FN
462 #undef __HPP_ENTRY_RAW_FN
464 #undef __HPP_SORT_ACC_FN
465 #undef __HPP_SORT_RAW_FN
468 void perf_hpp__init(void)
472 for (i = 0; i < PERF_HPP__MAX_INDEX; i++) {
473 struct perf_hpp_fmt *fmt = &perf_hpp__format[i];
475 INIT_LIST_HEAD(&fmt->list);
477 /* sort_list may be linked by setup_sorting() */
478 if (fmt->sort_list.next == NULL)
479 INIT_LIST_HEAD(&fmt->sort_list);
483 * If user specified field order, no need to setup default fields.
485 if (is_strict_order(field_order))
488 if (symbol_conf.cumulate_callchain) {
489 hpp_dimension__add_output(PERF_HPP__OVERHEAD_ACC);
490 perf_hpp__format[PERF_HPP__OVERHEAD].name = "Self";
493 hpp_dimension__add_output(PERF_HPP__OVERHEAD);
495 if (symbol_conf.show_cpu_utilization) {
496 hpp_dimension__add_output(PERF_HPP__OVERHEAD_SYS);
497 hpp_dimension__add_output(PERF_HPP__OVERHEAD_US);
500 hpp_dimension__add_output(PERF_HPP__OVERHEAD_GUEST_SYS);
501 hpp_dimension__add_output(PERF_HPP__OVERHEAD_GUEST_US);
505 if (symbol_conf.show_nr_samples)
506 hpp_dimension__add_output(PERF_HPP__SAMPLES);
508 if (symbol_conf.show_total_period)
509 hpp_dimension__add_output(PERF_HPP__PERIOD);
512 void perf_hpp_list__column_register(struct perf_hpp_list *list,
513 struct perf_hpp_fmt *format)
515 list_add_tail(&format->list, &list->fields);
518 void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
519 struct perf_hpp_fmt *format)
521 list_add_tail(&format->sort_list, &list->sorts);
524 void perf_hpp_list__prepend_sort_field(struct perf_hpp_list *list,
525 struct perf_hpp_fmt *format)
527 list_add(&format->sort_list, &list->sorts);
530 void perf_hpp__column_unregister(struct perf_hpp_fmt *format)
532 list_del(&format->list);
535 void perf_hpp__cancel_cumulate(void)
537 struct perf_hpp_fmt *fmt, *acc, *ovh, *tmp;
539 if (is_strict_order(field_order))
542 ovh = &perf_hpp__format[PERF_HPP__OVERHEAD];
543 acc = &perf_hpp__format[PERF_HPP__OVERHEAD_ACC];
545 perf_hpp_list__for_each_format_safe(&perf_hpp_list, fmt, tmp) {
546 if (acc->equal(acc, fmt)) {
547 perf_hpp__column_unregister(fmt);
551 if (ovh->equal(ovh, fmt))
552 fmt->name = "Overhead";
556 static bool fmt_equal(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b)
558 return a->equal && a->equal(a, b);
561 void perf_hpp__setup_output_field(struct perf_hpp_list *list)
563 struct perf_hpp_fmt *fmt;
565 /* append sort keys to output field */
566 perf_hpp_list__for_each_sort_list(list, fmt) {
567 struct perf_hpp_fmt *pos;
569 /* skip sort-only fields ("sort_compute" in perf diff) */
570 if (!fmt->entry && !fmt->color)
573 perf_hpp_list__for_each_format(list, pos) {
574 if (fmt_equal(fmt, pos))
578 perf_hpp__column_register(fmt);
584 void perf_hpp__append_sort_keys(struct perf_hpp_list *list)
586 struct perf_hpp_fmt *fmt;
588 /* append output fields to sort keys */
589 perf_hpp_list__for_each_format(list, fmt) {
590 struct perf_hpp_fmt *pos;
592 perf_hpp_list__for_each_sort_list(list, pos) {
593 if (fmt_equal(fmt, pos))
597 perf_hpp__register_sort_field(fmt);
604 static void fmt_free(struct perf_hpp_fmt *fmt)
610 void perf_hpp__reset_output_field(struct perf_hpp_list *list)
612 struct perf_hpp_fmt *fmt, *tmp;
614 /* reset output fields */
615 perf_hpp_list__for_each_format_safe(list, fmt, tmp) {
616 list_del_init(&fmt->list);
617 list_del_init(&fmt->sort_list);
621 /* reset sort keys */
622 perf_hpp_list__for_each_sort_list_safe(list, fmt, tmp) {
623 list_del_init(&fmt->list);
624 list_del_init(&fmt->sort_list);
630 * See hists__fprintf to match the column widths
632 unsigned int hists__sort_list_width(struct hists *hists)
634 struct perf_hpp_fmt *fmt;
637 struct perf_hpp dummy_hpp;
639 hists__for_each_format(hists, fmt) {
640 if (perf_hpp__should_skip(fmt, hists))
648 ret += fmt->width(fmt, &dummy_hpp, hists);
651 if (verbose && hists__has(hists, sym)) /* Addr + origin */
652 ret += 3 + BITS_PER_LONG / 4;
657 unsigned int hists__overhead_width(struct hists *hists)
659 struct perf_hpp_fmt *fmt;
662 struct perf_hpp dummy_hpp;
664 hists__for_each_format(hists, fmt) {
665 if (perf_hpp__is_sort_entry(fmt) || perf_hpp__is_dynamic_entry(fmt))
673 ret += fmt->width(fmt, &dummy_hpp, hists);
679 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists)
681 if (perf_hpp__is_sort_entry(fmt))
682 return perf_hpp__reset_sort_width(fmt, hists);
684 if (perf_hpp__is_dynamic_entry(fmt))
687 BUG_ON(fmt->idx >= PERF_HPP__MAX_INDEX);
690 case PERF_HPP__OVERHEAD:
691 case PERF_HPP__OVERHEAD_SYS:
692 case PERF_HPP__OVERHEAD_US:
693 case PERF_HPP__OVERHEAD_ACC:
697 case PERF_HPP__OVERHEAD_GUEST_SYS:
698 case PERF_HPP__OVERHEAD_GUEST_US:
702 case PERF_HPP__SAMPLES:
703 case PERF_HPP__PERIOD:
712 void hists__reset_column_width(struct hists *hists)
714 struct perf_hpp_fmt *fmt;
715 struct perf_hpp_list_node *node;
717 hists__for_each_format(hists, fmt)
718 perf_hpp__reset_width(fmt, hists);
720 /* hierarchy entries have their own hpp list */
721 list_for_each_entry(node, &hists->hpp_formats, list) {
722 perf_hpp_list__for_each_format(&node->hpp, fmt)
723 perf_hpp__reset_width(fmt, hists);
727 void perf_hpp__set_user_width(const char *width_list_str)
729 struct perf_hpp_fmt *fmt;
730 const char *ptr = width_list_str;
732 perf_hpp_list__for_each_format(&perf_hpp_list, fmt) {
735 int len = strtol(ptr, &p, 10);
745 static int add_hierarchy_fmt(struct hists *hists, struct perf_hpp_fmt *fmt)
747 struct perf_hpp_list_node *node = NULL;
748 struct perf_hpp_fmt *fmt_copy;
750 bool skip = perf_hpp__should_skip(fmt, hists);
752 list_for_each_entry(node, &hists->hpp_formats, list) {
753 if (node->level == fmt->level) {
760 node = malloc(sizeof(*node));
765 node->level = fmt->level;
766 perf_hpp_list__init(&node->hpp);
768 hists->nr_hpp_node++;
769 list_add_tail(&node->list, &hists->hpp_formats);
772 fmt_copy = perf_hpp_fmt__dup(fmt);
773 if (fmt_copy == NULL)
779 list_add_tail(&fmt_copy->list, &node->hpp.fields);
780 list_add_tail(&fmt_copy->sort_list, &node->hpp.sorts);
785 int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
786 struct perf_evlist *evlist)
788 struct perf_evsel *evsel;
789 struct perf_hpp_fmt *fmt;
793 if (!symbol_conf.report_hierarchy)
796 evlist__for_each_entry(evlist, evsel) {
797 hists = evsel__hists(evsel);
799 perf_hpp_list__for_each_sort_list(list, fmt) {
800 if (perf_hpp__is_dynamic_entry(fmt) &&
801 !perf_hpp__defined_dynamic_entry(fmt, hists))
804 ret = add_hierarchy_fmt(hists, fmt);