1 // SPDX-License-Identifier: GPL-2.0
4 #include <linux/string.h>
6 #include "../../util/callchain.h"
7 #include "../../util/debug.h"
8 #include "../../util/event.h"
9 #include "../../util/hist.h"
10 #include "../../util/map.h"
11 #include "../../util/map_groups.h"
12 #include "../../util/symbol.h"
13 #include "../../util/sort.h"
14 #include "../../util/evsel.h"
15 #include "../../util/srcline.h"
16 #include "../../util/string2.h"
17 #include "../../util/thread.h"
18 #include <linux/ctype.h>
19 #include <linux/zalloc.h>
21 static size_t callchain__fprintf_left_margin(FILE *fp, int left_margin)
24 int ret = fprintf(fp, " ");
26 for (i = 0; i < left_margin; i++)
27 ret += fprintf(fp, " ");
32 static size_t ipchain__fprintf_graph_line(FILE *fp, int depth, int depth_mask,
36 size_t ret = callchain__fprintf_left_margin(fp, left_margin);
38 for (i = 0; i < depth; i++)
39 if (depth_mask & (1 << i))
40 ret += fprintf(fp, "| ");
42 ret += fprintf(fp, " ");
44 ret += fprintf(fp, "\n");
49 static size_t ipchain__fprintf_graph(FILE *fp, struct callchain_node *node,
50 struct callchain_list *chain,
51 int depth, int depth_mask, int period,
52 u64 total_samples, int left_margin)
56 char bf[1024], *alloc_str = NULL;
60 ret += callchain__fprintf_left_margin(fp, left_margin);
61 for (i = 0; i < depth; i++) {
62 if (depth_mask & (1 << i))
63 ret += fprintf(fp, "|");
65 ret += fprintf(fp, " ");
66 if (!period && i == depth - 1) {
67 ret += fprintf(fp, "--");
68 ret += callchain_node__fprintf_value(node, fp, total_samples);
69 ret += fprintf(fp, "--");
71 ret += fprintf(fp, "%s", " ");
74 str = callchain_list__sym_name(chain, bf, sizeof(bf), false);
76 if (symbol_conf.show_branchflag_count) {
77 callchain_list_counts__printf_value(chain, NULL,
80 if (asprintf(&alloc_str, "%s%s", str, buf) < 0)
81 str = "Not enough memory!";
93 static struct symbol *rem_sq_bracket;
94 static struct callchain_list rem_hits;
96 static void init_rem_hits(void)
98 rem_sq_bracket = malloc(sizeof(*rem_sq_bracket) + 6);
99 if (!rem_sq_bracket) {
100 fprintf(stderr, "Not enough memory to display remaining hits\n");
104 strcpy(rem_sq_bracket->name, "[...]");
105 rem_hits.ms.sym = rem_sq_bracket;
108 static size_t __callchain__fprintf_graph(FILE *fp, struct rb_root *root,
109 u64 total_samples, int depth,
110 int depth_mask, int left_margin)
112 struct rb_node *node, *next;
113 struct callchain_node *child = NULL;
114 struct callchain_list *chain;
115 int new_depth_mask = depth_mask;
119 uint entries_printed = 0;
122 remaining = total_samples;
124 node = rb_first(root);
129 child = rb_entry(node, struct callchain_node, rb_node);
130 cumul = callchain_cumul_hits(child);
132 cumul_count += callchain_cumul_counts(child);
135 * The depth mask manages the output of pipes that show
136 * the depth. We don't want to keep the pipes of the current
137 * level for the last child of this depth.
138 * Except if we have remaining filtered hits. They will
139 * supersede the last child
141 next = rb_next(node);
142 if (!next && (callchain_param.mode != CHAIN_GRAPH_REL || !remaining))
143 new_depth_mask &= ~(1 << (depth - 1));
146 * But we keep the older depth mask for the line separator
147 * to keep the level link until we reach the last child
149 ret += ipchain__fprintf_graph_line(fp, depth, depth_mask,
152 list_for_each_entry(chain, &child->val, list) {
153 ret += ipchain__fprintf_graph(fp, child, chain, depth,
159 if (callchain_param.mode == CHAIN_GRAPH_REL)
160 new_total = child->children_hit;
162 new_total = total_samples;
164 ret += __callchain__fprintf_graph(fp, &child->rb_root, new_total,
166 new_depth_mask | (1 << depth),
169 if (++entries_printed == callchain_param.print_limit)
173 if (callchain_param.mode == CHAIN_GRAPH_REL &&
174 remaining && remaining != total_samples) {
175 struct callchain_node rem_node = {
182 if (callchain_param.value == CCVAL_COUNT && child && child->parent) {
183 rem_node.count = child->parent->children_count - cumul_count;
184 if (rem_node.count <= 0)
188 new_depth_mask &= ~(1 << (depth - 1));
189 ret += ipchain__fprintf_graph(fp, &rem_node, &rem_hits, depth,
190 new_depth_mask, 0, total_samples,
198 * If have one single callchain root, don't bother printing
199 * its percentage (100 % in fractal mode and the same percentage
200 * than the hist in graph mode). This also avoid one level of column.
202 * However when percent-limit applied, it's possible that single callchain
203 * node have different (non-100% in fractal mode) percentage.
205 static bool need_percent_display(struct rb_node *node, u64 parent_samples)
207 struct callchain_node *cnode;
212 cnode = rb_entry(node, struct callchain_node, rb_node);
213 return callchain_cumul_hits(cnode) != parent_samples;
216 static size_t callchain__fprintf_graph(FILE *fp, struct rb_root *root,
217 u64 total_samples, u64 parent_samples,
220 struct callchain_node *cnode;
221 struct callchain_list *chain;
222 u32 entries_printed = 0;
223 bool printed = false;
224 struct rb_node *node;
229 node = rb_first(root);
230 if (node && !need_percent_display(node, parent_samples)) {
231 cnode = rb_entry(node, struct callchain_node, rb_node);
232 list_for_each_entry(chain, &cnode->val, list) {
234 * If we sort by symbol, the first entry is the same than
235 * the symbol. No need to print it otherwise it appears as
238 if (!i++ && field_order == NULL &&
239 sort_order && strstarts(sort_order, "sym"))
243 ret += callchain__fprintf_left_margin(fp, left_margin);
244 ret += fprintf(fp, "|\n");
245 ret += callchain__fprintf_left_margin(fp, left_margin);
246 ret += fprintf(fp, "---");
250 ret += callchain__fprintf_left_margin(fp, left_margin);
252 ret += fprintf(fp, "%s",
253 callchain_list__sym_name(chain, bf,
257 if (symbol_conf.show_branchflag_count)
258 ret += callchain_list_counts__printf_value(
260 ret += fprintf(fp, "\n");
262 if (++entries_printed == callchain_param.print_limit)
265 root = &cnode->rb_root;
268 if (callchain_param.mode == CHAIN_GRAPH_REL)
269 total_samples = parent_samples;
271 ret += __callchain__fprintf_graph(fp, root, total_samples,
274 /* do not add a blank line if it printed nothing */
275 ret += fprintf(fp, "\n");
281 static size_t __callchain__fprintf_flat(FILE *fp, struct callchain_node *node,
284 struct callchain_list *chain;
291 ret += __callchain__fprintf_flat(fp, node->parent, total_samples);
294 list_for_each_entry(chain, &node->val, list) {
295 if (chain->ip >= PERF_CONTEXT_MAX)
297 ret += fprintf(fp, " %s\n", callchain_list__sym_name(chain,
298 bf, sizeof(bf), false));
304 static size_t callchain__fprintf_flat(FILE *fp, struct rb_root *tree,
308 u32 entries_printed = 0;
309 struct callchain_node *chain;
310 struct rb_node *rb_node = rb_first(tree);
313 chain = rb_entry(rb_node, struct callchain_node, rb_node);
315 ret += fprintf(fp, " ");
316 ret += callchain_node__fprintf_value(chain, fp, total_samples);
317 ret += fprintf(fp, "\n");
318 ret += __callchain__fprintf_flat(fp, chain, total_samples);
319 ret += fprintf(fp, "\n");
320 if (++entries_printed == callchain_param.print_limit)
323 rb_node = rb_next(rb_node);
329 static size_t __callchain__fprintf_folded(FILE *fp, struct callchain_node *node)
331 const char *sep = symbol_conf.field_sep ?: ";";
332 struct callchain_list *chain;
340 ret += __callchain__fprintf_folded(fp, node->parent);
343 list_for_each_entry(chain, &node->val, list) {
344 if (chain->ip >= PERF_CONTEXT_MAX)
346 ret += fprintf(fp, "%s%s", first ? "" : sep,
347 callchain_list__sym_name(chain,
348 bf, sizeof(bf), false));
355 static size_t callchain__fprintf_folded(FILE *fp, struct rb_root *tree,
359 u32 entries_printed = 0;
360 struct callchain_node *chain;
361 struct rb_node *rb_node = rb_first(tree);
365 chain = rb_entry(rb_node, struct callchain_node, rb_node);
367 ret += callchain_node__fprintf_value(chain, fp, total_samples);
368 ret += fprintf(fp, " ");
369 ret += __callchain__fprintf_folded(fp, chain);
370 ret += fprintf(fp, "\n");
371 if (++entries_printed == callchain_param.print_limit)
374 rb_node = rb_next(rb_node);
380 static size_t hist_entry_callchain__fprintf(struct hist_entry *he,
381 u64 total_samples, int left_margin,
384 u64 parent_samples = he->stat.period;
386 if (symbol_conf.cumulate_callchain)
387 parent_samples = he->stat_acc->period;
389 switch (callchain_param.mode) {
390 case CHAIN_GRAPH_REL:
391 return callchain__fprintf_graph(fp, &he->sorted_chain, total_samples,
392 parent_samples, left_margin);
394 case CHAIN_GRAPH_ABS:
395 return callchain__fprintf_graph(fp, &he->sorted_chain, total_samples,
396 parent_samples, left_margin);
399 return callchain__fprintf_flat(fp, &he->sorted_chain, total_samples);
402 return callchain__fprintf_folded(fp, &he->sorted_chain, total_samples);
407 pr_err("Bad callchain mode\n");
413 int __hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp,
414 struct perf_hpp_list *hpp_list)
416 const char *sep = symbol_conf.field_sep;
417 struct perf_hpp_fmt *fmt;
418 char *start = hpp->buf;
422 if (symbol_conf.exclude_other && !he->parent)
425 perf_hpp_list__for_each_format(hpp_list, fmt) {
426 if (perf_hpp__should_skip(fmt, he->hists))
430 * If there's no field_sep, we still need
431 * to display initial ' '.
433 if (!sep || !first) {
434 ret = scnprintf(hpp->buf, hpp->size, "%s", sep ?: " ");
435 advance_hpp(hpp, ret);
439 if (perf_hpp__use_color() && fmt->color)
440 ret = fmt->color(fmt, hpp, he);
442 ret = fmt->entry(fmt, hpp, he);
444 ret = hist_entry__snprintf_alignment(he, hpp, fmt, ret);
445 advance_hpp(hpp, ret);
448 return hpp->buf - start;
451 static int hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp)
453 return __hist_entry__snprintf(he, hpp, he->hists->hpp_list);
456 static int hist_entry__hierarchy_fprintf(struct hist_entry *he,
457 struct perf_hpp *hpp,
461 const char *sep = symbol_conf.field_sep;
462 struct perf_hpp_fmt *fmt;
463 struct perf_hpp_list_node *fmt_node;
464 char *buf = hpp->buf;
465 size_t size = hpp->size;
466 int ret, printed = 0;
469 if (symbol_conf.exclude_other && !he->parent)
472 ret = scnprintf(hpp->buf, hpp->size, "%*s", he->depth * HIERARCHY_INDENT, "");
473 advance_hpp(hpp, ret);
475 /* the first hpp_list_node is for overhead columns */
476 fmt_node = list_first_entry(&hists->hpp_formats,
477 struct perf_hpp_list_node, list);
478 perf_hpp_list__for_each_format(&fmt_node->hpp, fmt) {
480 * If there's no field_sep, we still need
481 * to display initial ' '.
483 if (!sep || !first) {
484 ret = scnprintf(hpp->buf, hpp->size, "%s", sep ?: " ");
485 advance_hpp(hpp, ret);
489 if (perf_hpp__use_color() && fmt->color)
490 ret = fmt->color(fmt, hpp, he);
492 ret = fmt->entry(fmt, hpp, he);
494 ret = hist_entry__snprintf_alignment(he, hpp, fmt, ret);
495 advance_hpp(hpp, ret);
499 ret = scnprintf(hpp->buf, hpp->size, "%*s",
500 (hists->nr_hpp_node - 2) * HIERARCHY_INDENT, "");
501 advance_hpp(hpp, ret);
503 printed += fprintf(fp, "%s", buf);
505 perf_hpp_list__for_each_format(he->hpp_list, fmt) {
510 * No need to call hist_entry__snprintf_alignment() since this
511 * fmt is always the last column in the hierarchy mode.
513 if (perf_hpp__use_color() && fmt->color)
514 fmt->color(fmt, hpp, he);
516 fmt->entry(fmt, hpp, he);
519 * dynamic entries are right-aligned but we want left-aligned
520 * in the hierarchy mode
522 printed += fprintf(fp, "%s%s", sep ?: " ", skip_spaces(buf));
524 printed += putc('\n', fp);
526 if (he->leaf && hist_entry__has_callchains(he) && symbol_conf.use_callchain) {
527 u64 total = hists__total_period(hists);
529 printed += hist_entry_callchain__fprintf(he, total, 0, fp);
537 static int hist_entry__block_fprintf(struct hist_entry *he,
538 char *bf, size_t size,
541 struct block_hist *bh = container_of(he, struct block_hist, he);
544 for (unsigned int i = 0; i < bh->block_hists.nr_entries; i++) {
545 struct perf_hpp hpp = {
552 hist_entry__snprintf(he, &hpp);
555 ret += fprintf(fp, "%s\n", bf);
561 static int hist_entry__fprintf(struct hist_entry *he, size_t size,
562 char *bf, size_t bfsz, FILE *fp,
563 bool ignore_callchains)
566 int callchain_ret = 0;
567 struct perf_hpp hpp = {
571 struct hists *hists = he->hists;
572 u64 total_period = hists->stats.total_period;
574 if (size == 0 || size > bfsz)
575 size = hpp.size = bfsz;
577 if (symbol_conf.report_hierarchy)
578 return hist_entry__hierarchy_fprintf(he, &hpp, hists, fp);
580 if (symbol_conf.report_block)
581 return hist_entry__block_fprintf(he, bf, size, fp);
583 hist_entry__snprintf(he, &hpp);
585 ret = fprintf(fp, "%s\n", bf);
587 if (hist_entry__has_callchains(he) && !ignore_callchains)
588 callchain_ret = hist_entry_callchain__fprintf(he, total_period,
591 ret += callchain_ret;
596 static int print_hierarchy_indent(const char *sep, int indent,
597 const char *line, FILE *fp)
601 if (sep != NULL || indent < 2)
604 width = (indent - 2) * HIERARCHY_INDENT;
606 return fprintf(fp, "%-*.*s", width, width, line);
609 static int hists__fprintf_hierarchy_headers(struct hists *hists,
610 struct perf_hpp *hpp, FILE *fp)
612 bool first_node, first_col;
616 unsigned header_width = 0;
617 struct perf_hpp_fmt *fmt;
618 struct perf_hpp_list_node *fmt_node;
619 const char *sep = symbol_conf.field_sep;
621 indent = hists->nr_hpp_node;
623 /* preserve max indent depth for column headers */
624 print_hierarchy_indent(sep, indent, " ", fp);
626 /* the first hpp_list_node is for overhead columns */
627 fmt_node = list_first_entry(&hists->hpp_formats,
628 struct perf_hpp_list_node, list);
630 perf_hpp_list__for_each_format(&fmt_node->hpp, fmt) {
631 fmt->header(fmt, hpp, hists, 0, NULL);
632 fprintf(fp, "%s%s", hpp->buf, sep ?: " ");
635 /* combine sort headers with ' / ' */
637 list_for_each_entry_continue(fmt_node, &hists->hpp_formats, list) {
639 header_width += fprintf(fp, " / ");
643 perf_hpp_list__for_each_format(&fmt_node->hpp, fmt) {
644 if (perf_hpp__should_skip(fmt, hists))
648 header_width += fprintf(fp, "+");
651 fmt->header(fmt, hpp, hists, 0, NULL);
653 header_width += fprintf(fp, "%s", strim(hpp->buf));
659 /* preserve max indent depth for initial dots */
660 print_hierarchy_indent(sep, indent, dots, fp);
662 /* the first hpp_list_node is for overhead columns */
663 fmt_node = list_first_entry(&hists->hpp_formats,
664 struct perf_hpp_list_node, list);
667 perf_hpp_list__for_each_format(&fmt_node->hpp, fmt) {
669 fprintf(fp, "%s", sep ?: "..");
672 width = fmt->width(fmt, hpp, hists);
673 fprintf(fp, "%.*s", width, dots);
677 list_for_each_entry_continue(fmt_node, &hists->hpp_formats, list) {
679 width = depth * HIERARCHY_INDENT;
681 perf_hpp_list__for_each_format(&fmt_node->hpp, fmt) {
682 if (perf_hpp__should_skip(fmt, hists))
686 width++; /* for '+' sign between column header */
689 width += fmt->width(fmt, hpp, hists);
692 if (width > header_width)
693 header_width = width;
698 fprintf(fp, "%s%-.*s", sep ?: " ", header_width, dots);
700 fprintf(fp, "\n#\n");
705 static void fprintf_line(struct hists *hists, struct perf_hpp *hpp,
708 struct perf_hpp_fmt *fmt;
709 const char *sep = symbol_conf.field_sep;
713 hists__for_each_format(hists, fmt) {
714 if (perf_hpp__should_skip(fmt, hists))
718 fprintf(fp, "%s", sep ?: " ");
722 fmt->header(fmt, hpp, hists, line, &span);
725 fprintf(fp, "%s", hpp->buf);
730 hists__fprintf_standard_headers(struct hists *hists,
731 struct perf_hpp *hpp,
734 struct perf_hpp_list *hpp_list = hists->hpp_list;
735 struct perf_hpp_fmt *fmt;
737 const char *sep = symbol_conf.field_sep;
741 for (line = 0; line < hpp_list->nr_header_lines; line++) {
742 /* first # is displayed one level up */
745 fprintf_line(hists, hpp, line, fp);
750 return hpp_list->nr_header_lines;
756 hists__for_each_format(hists, fmt) {
759 if (perf_hpp__should_skip(fmt, hists))
763 fprintf(fp, "%s", sep ?: " ");
767 width = fmt->width(fmt, hpp, hists);
768 for (i = 0; i < width; i++)
774 return hpp_list->nr_header_lines + 2;
777 int hists__fprintf_headers(struct hists *hists, FILE *fp)
780 struct perf_hpp dummy_hpp = {
787 if (symbol_conf.report_hierarchy)
788 return hists__fprintf_hierarchy_headers(hists, &dummy_hpp, fp);
790 return hists__fprintf_standard_headers(hists, &dummy_hpp, fp);
794 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
795 int max_cols, float min_pcnt, FILE *fp,
796 bool ignore_callchains)
800 const char *sep = symbol_conf.field_sep;
808 hists__reset_column_width(hists);
810 if (symbol_conf.col_width_list_str)
811 perf_hpp__set_user_width(symbol_conf.col_width_list_str);
814 nr_rows += hists__fprintf_headers(hists, fp);
816 if (max_rows && nr_rows >= max_rows)
819 linesz = hists__sort_list_width(hists) + 3 + 1;
820 linesz += perf_hpp__color_overhead();
821 line = malloc(linesz);
827 indent = hists__overhead_width(hists) + 4;
829 for (nd = rb_first_cached(&hists->entries); nd;
830 nd = __rb_hierarchy_next(nd, HMD_FORCE_CHILD)) {
831 struct hist_entry *h = rb_entry(nd, struct hist_entry, rb_node);
837 percent = hist_entry__get_percent_limit(h);
838 if (percent < min_pcnt)
841 ret += hist_entry__fprintf(h, max_cols, line, linesz, fp, ignore_callchains);
843 if (max_rows && ++nr_rows >= max_rows)
847 * If all children are filtered out or percent-limited,
848 * display "no entry >= x.xx%" message.
850 if (!h->leaf && !hist_entry__has_hierarchy_children(h, min_pcnt)) {
851 int depth = hists->nr_hpp_node + h->depth + 1;
853 print_hierarchy_indent(sep, depth, " ", fp);
854 fprintf(fp, "%*sno entry >= %.2f%%\n", indent, "", min_pcnt);
856 if (max_rows && ++nr_rows >= max_rows)
860 if (h->ms.map == NULL && verbose > 1) {
861 map_groups__fprintf(h->thread->mg, fp);
862 fprintf(fp, "%.10s end\n", graph_dotted_line);
868 zfree(&rem_sq_bracket);
873 size_t events_stats__fprintf(struct events_stats *stats, FILE *fp)
878 for (i = 0; i < PERF_RECORD_HEADER_MAX; ++i) {
881 name = perf_event__name(i);
882 if (!strcmp(name, "UNKNOWN"))
885 ret += fprintf(fp, "%16s events: %10d\n", name, stats->nr_events[i]);