3 #include <linux/compiler.h>
5 #include "../util/hist.h"
6 #include "../util/util.h"
7 #include "../util/sort.h"
8 #include "../util/evsel.h"
9 #include "../util/evlist.h"
11 /* hist period print (hpp) functions */
13 #define hpp__call_print_fn(hpp, fn, fmt, ...) \
15 int __ret = fn(hpp, fmt, ##__VA_ARGS__); \
16 advance_hpp(hpp, __ret); \
20 static int __hpp__fmt(struct perf_hpp *hpp, struct hist_entry *he,
21 hpp_field_fn get_field, const char *fmt, int len,
22 hpp_snprint_fn print_fn, bool fmt_percent)
25 struct hists *hists = he->hists;
26 struct perf_evsel *evsel = hists_to_evsel(hists);
28 size_t size = hpp->size;
32 u64 total = hists__total_period(hists);
35 percent = 100.0 * get_field(he) / total;
37 ret = hpp__call_print_fn(hpp, print_fn, fmt, len, percent);
39 ret = hpp__call_print_fn(hpp, print_fn, fmt, len, get_field(he));
41 if (perf_evsel__is_group_event(evsel)) {
42 int prev_idx, idx_delta;
43 struct hist_entry *pair;
44 int nr_members = evsel->nr_members;
46 prev_idx = perf_evsel__group_idx(evsel);
48 list_for_each_entry(pair, &he->pairs.head, pairs.node) {
49 u64 period = get_field(pair);
50 u64 total = hists__total_period(pair->hists);
55 evsel = hists_to_evsel(pair->hists);
56 idx_delta = perf_evsel__group_idx(evsel) - prev_idx - 1;
60 * zero-fill group members in the middle which
64 ret += hpp__call_print_fn(hpp, print_fn,
67 ret += hpp__call_print_fn(hpp, print_fn,
73 ret += hpp__call_print_fn(hpp, print_fn, fmt, len,
74 100.0 * period / total);
76 ret += hpp__call_print_fn(hpp, print_fn, fmt,
80 prev_idx = perf_evsel__group_idx(evsel);
83 idx_delta = nr_members - prev_idx - 1;
87 * zero-fill group members at last which have no sample
90 ret += hpp__call_print_fn(hpp, print_fn,
93 ret += hpp__call_print_fn(hpp, print_fn,
100 * Restore original buf and size as it's where caller expects
101 * the result will be saved.
109 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
110 struct hist_entry *he, hpp_field_fn get_field,
111 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent)
113 int len = fmt->user_len ?: fmt->len;
115 if (symbol_conf.field_sep) {
116 return __hpp__fmt(hpp, he, get_field, fmtstr, 1,
117 print_fn, fmt_percent);
121 len -= 2; /* 2 for a space and a % sign */
125 return __hpp__fmt(hpp, he, get_field, fmtstr, len, print_fn, fmt_percent);
128 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
129 struct hist_entry *he, hpp_field_fn get_field,
130 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent)
132 if (!symbol_conf.cumulate_callchain) {
133 int len = fmt->user_len ?: fmt->len;
134 return snprintf(hpp->buf, hpp->size, " %*s", len - 1, "N/A");
137 return hpp__fmt(fmt, hpp, he, get_field, fmtstr, print_fn, fmt_percent);
140 static int field_cmp(u64 field_a, u64 field_b)
142 if (field_a > field_b)
144 if (field_a < field_b)
149 static int __hpp__sort(struct hist_entry *a, struct hist_entry *b,
150 hpp_field_fn get_field)
154 struct perf_evsel *evsel;
155 struct hist_entry *pair;
156 u64 *fields_a, *fields_b;
158 ret = field_cmp(get_field(a), get_field(b));
159 if (ret || !symbol_conf.event_group)
162 evsel = hists_to_evsel(a->hists);
163 if (!perf_evsel__is_group_event(evsel))
166 nr_members = evsel->nr_members;
167 fields_a = calloc(nr_members, sizeof(*fields_a));
168 fields_b = calloc(nr_members, sizeof(*fields_b));
170 if (!fields_a || !fields_b)
173 list_for_each_entry(pair, &a->pairs.head, pairs.node) {
174 evsel = hists_to_evsel(pair->hists);
175 fields_a[perf_evsel__group_idx(evsel)] = get_field(pair);
178 list_for_each_entry(pair, &b->pairs.head, pairs.node) {
179 evsel = hists_to_evsel(pair->hists);
180 fields_b[perf_evsel__group_idx(evsel)] = get_field(pair);
183 for (i = 1; i < nr_members; i++) {
184 ret = field_cmp(fields_a[i], fields_b[i]);
196 static int __hpp__sort_acc(struct hist_entry *a, struct hist_entry *b,
197 hpp_field_fn get_field)
201 if (symbol_conf.cumulate_callchain) {
203 * Put caller above callee when they have equal period.
205 ret = field_cmp(get_field(a), get_field(b));
209 if (a->thread != b->thread || !symbol_conf.use_callchain)
212 ret = b->callchain->max_depth - a->callchain->max_depth;
213 if (callchain_param.order == ORDER_CALLER)
219 static int hpp__width_fn(struct perf_hpp_fmt *fmt,
220 struct perf_hpp *hpp __maybe_unused,
223 int len = fmt->user_len ?: fmt->len;
224 struct perf_evsel *evsel = hists_to_evsel(hists);
226 if (symbol_conf.event_group)
227 len = max(len, evsel->nr_members * fmt->len);
229 if (len < (int)strlen(fmt->name))
230 len = strlen(fmt->name);
235 static int hpp__header_fn(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
236 struct hists *hists, int line __maybe_unused,
237 int *span __maybe_unused)
239 int len = hpp__width_fn(fmt, hpp, hists);
240 return scnprintf(hpp->buf, hpp->size, "%*s", len, fmt->name);
243 int hpp_color_scnprintf(struct perf_hpp *hpp, const char *fmt, ...)
246 ssize_t ssize = hpp->size;
251 len = va_arg(args, int);
252 percent = va_arg(args, double);
253 ret = percent_color_len_snprintf(hpp->buf, hpp->size, fmt, len, percent);
256 return (ret >= ssize) ? (ssize - 1) : ret;
259 static int hpp_entry_scnprintf(struct perf_hpp *hpp, const char *fmt, ...)
262 ssize_t ssize = hpp->size;
266 ret = vsnprintf(hpp->buf, hpp->size, fmt, args);
269 return (ret >= ssize) ? (ssize - 1) : ret;
272 #define __HPP_COLOR_PERCENT_FN(_type, _field) \
273 static u64 he_get_##_field(struct hist_entry *he) \
275 return he->stat._field; \
278 static int hpp__color_##_type(struct perf_hpp_fmt *fmt, \
279 struct perf_hpp *hpp, struct hist_entry *he) \
281 return hpp__fmt(fmt, hpp, he, he_get_##_field, " %*.2f%%", \
282 hpp_color_scnprintf, true); \
285 #define __HPP_ENTRY_PERCENT_FN(_type, _field) \
286 static int hpp__entry_##_type(struct perf_hpp_fmt *fmt, \
287 struct perf_hpp *hpp, struct hist_entry *he) \
289 return hpp__fmt(fmt, hpp, he, he_get_##_field, " %*.2f%%", \
290 hpp_entry_scnprintf, true); \
293 #define __HPP_SORT_FN(_type, _field) \
294 static int64_t hpp__sort_##_type(struct perf_hpp_fmt *fmt __maybe_unused, \
295 struct hist_entry *a, struct hist_entry *b) \
297 return __hpp__sort(a, b, he_get_##_field); \
300 #define __HPP_COLOR_ACC_PERCENT_FN(_type, _field) \
301 static u64 he_get_acc_##_field(struct hist_entry *he) \
303 return he->stat_acc->_field; \
306 static int hpp__color_##_type(struct perf_hpp_fmt *fmt, \
307 struct perf_hpp *hpp, struct hist_entry *he) \
309 return hpp__fmt_acc(fmt, hpp, he, he_get_acc_##_field, " %*.2f%%", \
310 hpp_color_scnprintf, true); \
313 #define __HPP_ENTRY_ACC_PERCENT_FN(_type, _field) \
314 static int hpp__entry_##_type(struct perf_hpp_fmt *fmt, \
315 struct perf_hpp *hpp, struct hist_entry *he) \
317 return hpp__fmt_acc(fmt, hpp, he, he_get_acc_##_field, " %*.2f%%", \
318 hpp_entry_scnprintf, true); \
321 #define __HPP_SORT_ACC_FN(_type, _field) \
322 static int64_t hpp__sort_##_type(struct perf_hpp_fmt *fmt __maybe_unused, \
323 struct hist_entry *a, struct hist_entry *b) \
325 return __hpp__sort_acc(a, b, he_get_acc_##_field); \
328 #define __HPP_ENTRY_RAW_FN(_type, _field) \
329 static u64 he_get_raw_##_field(struct hist_entry *he) \
331 return he->stat._field; \
334 static int hpp__entry_##_type(struct perf_hpp_fmt *fmt, \
335 struct perf_hpp *hpp, struct hist_entry *he) \
337 return hpp__fmt(fmt, hpp, he, he_get_raw_##_field, " %*"PRIu64, \
338 hpp_entry_scnprintf, false); \
341 #define __HPP_SORT_RAW_FN(_type, _field) \
342 static int64_t hpp__sort_##_type(struct perf_hpp_fmt *fmt __maybe_unused, \
343 struct hist_entry *a, struct hist_entry *b) \
345 return __hpp__sort(a, b, he_get_raw_##_field); \
349 #define HPP_PERCENT_FNS(_type, _field) \
350 __HPP_COLOR_PERCENT_FN(_type, _field) \
351 __HPP_ENTRY_PERCENT_FN(_type, _field) \
352 __HPP_SORT_FN(_type, _field)
354 #define HPP_PERCENT_ACC_FNS(_type, _field) \
355 __HPP_COLOR_ACC_PERCENT_FN(_type, _field) \
356 __HPP_ENTRY_ACC_PERCENT_FN(_type, _field) \
357 __HPP_SORT_ACC_FN(_type, _field)
359 #define HPP_RAW_FNS(_type, _field) \
360 __HPP_ENTRY_RAW_FN(_type, _field) \
361 __HPP_SORT_RAW_FN(_type, _field)
363 HPP_PERCENT_FNS(overhead, period)
364 HPP_PERCENT_FNS(overhead_sys, period_sys)
365 HPP_PERCENT_FNS(overhead_us, period_us)
366 HPP_PERCENT_FNS(overhead_guest_sys, period_guest_sys)
367 HPP_PERCENT_FNS(overhead_guest_us, period_guest_us)
368 HPP_PERCENT_ACC_FNS(overhead_acc, period)
370 HPP_RAW_FNS(samples, nr_events)
371 HPP_RAW_FNS(period, period)
373 static int64_t hpp__nop_cmp(struct perf_hpp_fmt *fmt __maybe_unused,
374 struct hist_entry *a __maybe_unused,
375 struct hist_entry *b __maybe_unused)
380 static bool perf_hpp__is_hpp_entry(struct perf_hpp_fmt *a)
382 return a->header == hpp__header_fn;
385 static bool hpp__equal(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b)
387 if (!perf_hpp__is_hpp_entry(a) || !perf_hpp__is_hpp_entry(b))
390 return a->idx == b->idx;
393 #define HPP__COLOR_PRINT_FNS(_name, _fn, _idx) \
396 .header = hpp__header_fn, \
397 .width = hpp__width_fn, \
398 .color = hpp__color_ ## _fn, \
399 .entry = hpp__entry_ ## _fn, \
400 .cmp = hpp__nop_cmp, \
401 .collapse = hpp__nop_cmp, \
402 .sort = hpp__sort_ ## _fn, \
403 .idx = PERF_HPP__ ## _idx, \
404 .equal = hpp__equal, \
407 #define HPP__COLOR_ACC_PRINT_FNS(_name, _fn, _idx) \
410 .header = hpp__header_fn, \
411 .width = hpp__width_fn, \
412 .color = hpp__color_ ## _fn, \
413 .entry = hpp__entry_ ## _fn, \
414 .cmp = hpp__nop_cmp, \
415 .collapse = hpp__nop_cmp, \
416 .sort = hpp__sort_ ## _fn, \
417 .idx = PERF_HPP__ ## _idx, \
418 .equal = hpp__equal, \
421 #define HPP__PRINT_FNS(_name, _fn, _idx) \
424 .header = hpp__header_fn, \
425 .width = hpp__width_fn, \
426 .entry = hpp__entry_ ## _fn, \
427 .cmp = hpp__nop_cmp, \
428 .collapse = hpp__nop_cmp, \
429 .sort = hpp__sort_ ## _fn, \
430 .idx = PERF_HPP__ ## _idx, \
431 .equal = hpp__equal, \
434 struct perf_hpp_fmt perf_hpp__format[] = {
435 HPP__COLOR_PRINT_FNS("Overhead", overhead, OVERHEAD),
436 HPP__COLOR_PRINT_FNS("sys", overhead_sys, OVERHEAD_SYS),
437 HPP__COLOR_PRINT_FNS("usr", overhead_us, OVERHEAD_US),
438 HPP__COLOR_PRINT_FNS("guest sys", overhead_guest_sys, OVERHEAD_GUEST_SYS),
439 HPP__COLOR_PRINT_FNS("guest usr", overhead_guest_us, OVERHEAD_GUEST_US),
440 HPP__COLOR_ACC_PRINT_FNS("Children", overhead_acc, OVERHEAD_ACC),
441 HPP__PRINT_FNS("Samples", samples, SAMPLES),
442 HPP__PRINT_FNS("Period", period, PERIOD)
445 struct perf_hpp_list perf_hpp_list = {
446 .fields = LIST_HEAD_INIT(perf_hpp_list.fields),
447 .sorts = LIST_HEAD_INIT(perf_hpp_list.sorts),
448 .nr_header_lines = 1,
451 #undef HPP__COLOR_PRINT_FNS
452 #undef HPP__COLOR_ACC_PRINT_FNS
453 #undef HPP__PRINT_FNS
455 #undef HPP_PERCENT_FNS
456 #undef HPP_PERCENT_ACC_FNS
459 #undef __HPP_HEADER_FN
460 #undef __HPP_WIDTH_FN
461 #undef __HPP_COLOR_PERCENT_FN
462 #undef __HPP_ENTRY_PERCENT_FN
463 #undef __HPP_COLOR_ACC_PERCENT_FN
464 #undef __HPP_ENTRY_ACC_PERCENT_FN
465 #undef __HPP_ENTRY_RAW_FN
467 #undef __HPP_SORT_ACC_FN
468 #undef __HPP_SORT_RAW_FN
471 void perf_hpp__init(void)
475 for (i = 0; i < PERF_HPP__MAX_INDEX; i++) {
476 struct perf_hpp_fmt *fmt = &perf_hpp__format[i];
478 INIT_LIST_HEAD(&fmt->list);
480 /* sort_list may be linked by setup_sorting() */
481 if (fmt->sort_list.next == NULL)
482 INIT_LIST_HEAD(&fmt->sort_list);
486 * If user specified field order, no need to setup default fields.
488 if (is_strict_order(field_order))
491 if (symbol_conf.cumulate_callchain) {
492 hpp_dimension__add_output(PERF_HPP__OVERHEAD_ACC);
493 perf_hpp__format[PERF_HPP__OVERHEAD].name = "Self";
496 hpp_dimension__add_output(PERF_HPP__OVERHEAD);
498 if (symbol_conf.show_cpu_utilization) {
499 hpp_dimension__add_output(PERF_HPP__OVERHEAD_SYS);
500 hpp_dimension__add_output(PERF_HPP__OVERHEAD_US);
503 hpp_dimension__add_output(PERF_HPP__OVERHEAD_GUEST_SYS);
504 hpp_dimension__add_output(PERF_HPP__OVERHEAD_GUEST_US);
508 if (symbol_conf.show_nr_samples)
509 hpp_dimension__add_output(PERF_HPP__SAMPLES);
511 if (symbol_conf.show_total_period)
512 hpp_dimension__add_output(PERF_HPP__PERIOD);
515 void perf_hpp_list__column_register(struct perf_hpp_list *list,
516 struct perf_hpp_fmt *format)
518 list_add_tail(&format->list, &list->fields);
521 void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
522 struct perf_hpp_fmt *format)
524 list_add_tail(&format->sort_list, &list->sorts);
527 void perf_hpp_list__prepend_sort_field(struct perf_hpp_list *list,
528 struct perf_hpp_fmt *format)
530 list_add(&format->sort_list, &list->sorts);
533 void perf_hpp__column_unregister(struct perf_hpp_fmt *format)
535 list_del(&format->list);
538 void perf_hpp__cancel_cumulate(void)
540 struct perf_hpp_fmt *fmt, *acc, *ovh, *tmp;
542 if (is_strict_order(field_order))
545 ovh = &perf_hpp__format[PERF_HPP__OVERHEAD];
546 acc = &perf_hpp__format[PERF_HPP__OVERHEAD_ACC];
548 perf_hpp_list__for_each_format_safe(&perf_hpp_list, fmt, tmp) {
549 if (acc->equal(acc, fmt)) {
550 perf_hpp__column_unregister(fmt);
554 if (ovh->equal(ovh, fmt))
555 fmt->name = "Overhead";
559 static bool fmt_equal(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b)
561 return a->equal && a->equal(a, b);
564 void perf_hpp__setup_output_field(struct perf_hpp_list *list)
566 struct perf_hpp_fmt *fmt;
568 /* append sort keys to output field */
569 perf_hpp_list__for_each_sort_list(list, fmt) {
570 struct perf_hpp_fmt *pos;
572 /* skip sort-only fields ("sort_compute" in perf diff) */
573 if (!fmt->entry && !fmt->color)
576 perf_hpp_list__for_each_format(list, pos) {
577 if (fmt_equal(fmt, pos))
581 perf_hpp__column_register(fmt);
587 void perf_hpp__append_sort_keys(struct perf_hpp_list *list)
589 struct perf_hpp_fmt *fmt;
591 /* append output fields to sort keys */
592 perf_hpp_list__for_each_format(list, fmt) {
593 struct perf_hpp_fmt *pos;
595 perf_hpp_list__for_each_sort_list(list, pos) {
596 if (fmt_equal(fmt, pos))
600 perf_hpp__register_sort_field(fmt);
607 static void fmt_free(struct perf_hpp_fmt *fmt)
613 void perf_hpp__reset_output_field(struct perf_hpp_list *list)
615 struct perf_hpp_fmt *fmt, *tmp;
617 /* reset output fields */
618 perf_hpp_list__for_each_format_safe(list, fmt, tmp) {
619 list_del_init(&fmt->list);
620 list_del_init(&fmt->sort_list);
624 /* reset sort keys */
625 perf_hpp_list__for_each_sort_list_safe(list, fmt, tmp) {
626 list_del_init(&fmt->list);
627 list_del_init(&fmt->sort_list);
633 * See hists__fprintf to match the column widths
635 unsigned int hists__sort_list_width(struct hists *hists)
637 struct perf_hpp_fmt *fmt;
640 struct perf_hpp dummy_hpp;
642 hists__for_each_format(hists, fmt) {
643 if (perf_hpp__should_skip(fmt, hists))
651 ret += fmt->width(fmt, &dummy_hpp, hists);
654 if (verbose > 0 && hists__has(hists, sym)) /* Addr + origin */
655 ret += 3 + BITS_PER_LONG / 4;
660 unsigned int hists__overhead_width(struct hists *hists)
662 struct perf_hpp_fmt *fmt;
665 struct perf_hpp dummy_hpp;
667 hists__for_each_format(hists, fmt) {
668 if (perf_hpp__is_sort_entry(fmt) || perf_hpp__is_dynamic_entry(fmt))
676 ret += fmt->width(fmt, &dummy_hpp, hists);
682 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists)
684 if (perf_hpp__is_sort_entry(fmt))
685 return perf_hpp__reset_sort_width(fmt, hists);
687 if (perf_hpp__is_dynamic_entry(fmt))
690 BUG_ON(fmt->idx >= PERF_HPP__MAX_INDEX);
693 case PERF_HPP__OVERHEAD:
694 case PERF_HPP__OVERHEAD_SYS:
695 case PERF_HPP__OVERHEAD_US:
696 case PERF_HPP__OVERHEAD_ACC:
700 case PERF_HPP__OVERHEAD_GUEST_SYS:
701 case PERF_HPP__OVERHEAD_GUEST_US:
705 case PERF_HPP__SAMPLES:
706 case PERF_HPP__PERIOD:
715 void hists__reset_column_width(struct hists *hists)
717 struct perf_hpp_fmt *fmt;
718 struct perf_hpp_list_node *node;
720 hists__for_each_format(hists, fmt)
721 perf_hpp__reset_width(fmt, hists);
723 /* hierarchy entries have their own hpp list */
724 list_for_each_entry(node, &hists->hpp_formats, list) {
725 perf_hpp_list__for_each_format(&node->hpp, fmt)
726 perf_hpp__reset_width(fmt, hists);
730 void perf_hpp__set_user_width(const char *width_list_str)
732 struct perf_hpp_fmt *fmt;
733 const char *ptr = width_list_str;
735 perf_hpp_list__for_each_format(&perf_hpp_list, fmt) {
738 int len = strtol(ptr, &p, 10);
748 static int add_hierarchy_fmt(struct hists *hists, struct perf_hpp_fmt *fmt)
750 struct perf_hpp_list_node *node = NULL;
751 struct perf_hpp_fmt *fmt_copy;
753 bool skip = perf_hpp__should_skip(fmt, hists);
755 list_for_each_entry(node, &hists->hpp_formats, list) {
756 if (node->level == fmt->level) {
763 node = malloc(sizeof(*node));
768 node->level = fmt->level;
769 perf_hpp_list__init(&node->hpp);
771 hists->nr_hpp_node++;
772 list_add_tail(&node->list, &hists->hpp_formats);
775 fmt_copy = perf_hpp_fmt__dup(fmt);
776 if (fmt_copy == NULL)
782 list_add_tail(&fmt_copy->list, &node->hpp.fields);
783 list_add_tail(&fmt_copy->sort_list, &node->hpp.sorts);
788 int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
789 struct perf_evlist *evlist)
791 struct perf_evsel *evsel;
792 struct perf_hpp_fmt *fmt;
796 if (!symbol_conf.report_hierarchy)
799 evlist__for_each_entry(evlist, evsel) {
800 hists = evsel__hists(evsel);
802 perf_hpp_list__for_each_sort_list(list, fmt) {
803 if (perf_hpp__is_dynamic_entry(fmt) &&
804 !perf_hpp__defined_dynamic_entry(fmt, hists))
807 ret = add_hierarchy_fmt(hists, fmt);