xref: /linux/tools/perf/ui/stdio/hist.c (revision 607bfbd7ffc60156ae0831c917497dc91a57dd8d)
1 #include <stdio.h>
2 
3 #include "../../util/util.h"
4 #include "../../util/hist.h"
5 #include "../../util/sort.h"
6 #include "../../util/evsel.h"
7 
8 
9 static size_t callchain__fprintf_left_margin(FILE *fp, int left_margin)
10 {
11 	int i;
12 	int ret = fprintf(fp, "            ");
13 
14 	for (i = 0; i < left_margin; i++)
15 		ret += fprintf(fp, " ");
16 
17 	return ret;
18 }
19 
20 static size_t ipchain__fprintf_graph_line(FILE *fp, int depth, int depth_mask,
21 					  int left_margin)
22 {
23 	int i;
24 	size_t ret = callchain__fprintf_left_margin(fp, left_margin);
25 
26 	for (i = 0; i < depth; i++)
27 		if (depth_mask & (1 << i))
28 			ret += fprintf(fp, "|          ");
29 		else
30 			ret += fprintf(fp, "           ");
31 
32 	ret += fprintf(fp, "\n");
33 
34 	return ret;
35 }
36 
37 static size_t ipchain__fprintf_graph(FILE *fp, struct callchain_node *node,
38 				     struct callchain_list *chain,
39 				     int depth, int depth_mask, int period,
40 				     u64 total_samples, int left_margin)
41 {
42 	int i;
43 	size_t ret = 0;
44 	char bf[1024];
45 
46 	ret += callchain__fprintf_left_margin(fp, left_margin);
47 	for (i = 0; i < depth; i++) {
48 		if (depth_mask & (1 << i))
49 			ret += fprintf(fp, "|");
50 		else
51 			ret += fprintf(fp, " ");
52 		if (!period && i == depth - 1) {
53 			ret += fprintf(fp, "--");
54 			ret += callchain_node__fprintf_value(node, fp, total_samples);
55 			ret += fprintf(fp, "--");
56 		} else
57 			ret += fprintf(fp, "%s", "          ");
58 	}
59 	fputs(callchain_list__sym_name(chain, bf, sizeof(bf), false), fp);
60 	fputc('\n', fp);
61 	return ret;
62 }
63 
64 static struct symbol *rem_sq_bracket;
65 static struct callchain_list rem_hits;
66 
67 static void init_rem_hits(void)
68 {
69 	rem_sq_bracket = malloc(sizeof(*rem_sq_bracket) + 6);
70 	if (!rem_sq_bracket) {
71 		fprintf(stderr, "Not enough memory to display remaining hits\n");
72 		return;
73 	}
74 
75 	strcpy(rem_sq_bracket->name, "[...]");
76 	rem_hits.ms.sym = rem_sq_bracket;
77 }
78 
79 static size_t __callchain__fprintf_graph(FILE *fp, struct rb_root *root,
80 					 u64 total_samples, int depth,
81 					 int depth_mask, int left_margin)
82 {
83 	struct rb_node *node, *next;
84 	struct callchain_node *child = NULL;
85 	struct callchain_list *chain;
86 	int new_depth_mask = depth_mask;
87 	u64 remaining;
88 	size_t ret = 0;
89 	int i;
90 	uint entries_printed = 0;
91 	int cumul_count = 0;
92 
93 	remaining = total_samples;
94 
95 	node = rb_first(root);
96 	while (node) {
97 		u64 new_total;
98 		u64 cumul;
99 
100 		child = rb_entry(node, struct callchain_node, rb_node);
101 		cumul = callchain_cumul_hits(child);
102 		remaining -= cumul;
103 		cumul_count += callchain_cumul_counts(child);
104 
105 		/*
106 		 * The depth mask manages the output of pipes that show
107 		 * the depth. We don't want to keep the pipes of the current
108 		 * level for the last child of this depth.
109 		 * Except if we have remaining filtered hits. They will
110 		 * supersede the last child
111 		 */
112 		next = rb_next(node);
113 		if (!next && (callchain_param.mode != CHAIN_GRAPH_REL || !remaining))
114 			new_depth_mask &= ~(1 << (depth - 1));
115 
116 		/*
117 		 * But we keep the older depth mask for the line separator
118 		 * to keep the level link until we reach the last child
119 		 */
120 		ret += ipchain__fprintf_graph_line(fp, depth, depth_mask,
121 						   left_margin);
122 		i = 0;
123 		list_for_each_entry(chain, &child->val, list) {
124 			ret += ipchain__fprintf_graph(fp, child, chain, depth,
125 						      new_depth_mask, i++,
126 						      total_samples,
127 						      left_margin);
128 		}
129 
130 		if (callchain_param.mode == CHAIN_GRAPH_REL)
131 			new_total = child->children_hit;
132 		else
133 			new_total = total_samples;
134 
135 		ret += __callchain__fprintf_graph(fp, &child->rb_root, new_total,
136 						  depth + 1,
137 						  new_depth_mask | (1 << depth),
138 						  left_margin);
139 		node = next;
140 		if (++entries_printed == callchain_param.print_limit)
141 			break;
142 	}
143 
144 	if (callchain_param.mode == CHAIN_GRAPH_REL &&
145 		remaining && remaining != total_samples) {
146 		struct callchain_node rem_node = {
147 			.hit = remaining,
148 		};
149 
150 		if (!rem_sq_bracket)
151 			return ret;
152 
153 		if (callchain_param.value == CCVAL_COUNT && child && child->parent) {
154 			rem_node.count = child->parent->children_count - cumul_count;
155 			if (rem_node.count <= 0)
156 				return ret;
157 		}
158 
159 		new_depth_mask &= ~(1 << (depth - 1));
160 		ret += ipchain__fprintf_graph(fp, &rem_node, &rem_hits, depth,
161 					      new_depth_mask, 0, total_samples,
162 					      left_margin);
163 	}
164 
165 	return ret;
166 }
167 
168 /*
169  * If have one single callchain root, don't bother printing
170  * its percentage (100 % in fractal mode and the same percentage
171  * than the hist in graph mode). This also avoid one level of column.
172  *
173  * However when percent-limit applied, it's possible that single callchain
174  * node have different (non-100% in fractal mode) percentage.
175  */
176 static bool need_percent_display(struct rb_node *node, u64 parent_samples)
177 {
178 	struct callchain_node *cnode;
179 
180 	if (rb_next(node))
181 		return true;
182 
183 	cnode = rb_entry(node, struct callchain_node, rb_node);
184 	return callchain_cumul_hits(cnode) != parent_samples;
185 }
186 
187 static size_t callchain__fprintf_graph(FILE *fp, struct rb_root *root,
188 				       u64 total_samples, u64 parent_samples,
189 				       int left_margin)
190 {
191 	struct callchain_node *cnode;
192 	struct callchain_list *chain;
193 	u32 entries_printed = 0;
194 	bool printed = false;
195 	struct rb_node *node;
196 	int i = 0;
197 	int ret = 0;
198 	char bf[1024];
199 
200 	node = rb_first(root);
201 	if (node && !need_percent_display(node, parent_samples)) {
202 		cnode = rb_entry(node, struct callchain_node, rb_node);
203 		list_for_each_entry(chain, &cnode->val, list) {
204 			/*
205 			 * If we sort by symbol, the first entry is the same than
206 			 * the symbol. No need to print it otherwise it appears as
207 			 * displayed twice.
208 			 */
209 			if (!i++ && field_order == NULL &&
210 			    sort_order && !prefixcmp(sort_order, "sym"))
211 				continue;
212 			if (!printed) {
213 				ret += callchain__fprintf_left_margin(fp, left_margin);
214 				ret += fprintf(fp, "|\n");
215 				ret += callchain__fprintf_left_margin(fp, left_margin);
216 				ret += fprintf(fp, "---");
217 				left_margin += 3;
218 				printed = true;
219 			} else
220 				ret += callchain__fprintf_left_margin(fp, left_margin);
221 
222 			ret += fprintf(fp, "%s\n", callchain_list__sym_name(chain, bf, sizeof(bf),
223 							false));
224 
225 			if (++entries_printed == callchain_param.print_limit)
226 				break;
227 		}
228 		root = &cnode->rb_root;
229 	}
230 
231 	if (callchain_param.mode == CHAIN_GRAPH_REL)
232 		total_samples = parent_samples;
233 
234 	ret += __callchain__fprintf_graph(fp, root, total_samples,
235 					  1, 1, left_margin);
236 	if (ret) {
237 		/* do not add a blank line if it printed nothing */
238 		ret += fprintf(fp, "\n");
239 	}
240 
241 	return ret;
242 }
243 
244 static size_t __callchain__fprintf_flat(FILE *fp, struct callchain_node *node,
245 					u64 total_samples)
246 {
247 	struct callchain_list *chain;
248 	size_t ret = 0;
249 	char bf[1024];
250 
251 	if (!node)
252 		return 0;
253 
254 	ret += __callchain__fprintf_flat(fp, node->parent, total_samples);
255 
256 
257 	list_for_each_entry(chain, &node->val, list) {
258 		if (chain->ip >= PERF_CONTEXT_MAX)
259 			continue;
260 		ret += fprintf(fp, "                %s\n", callchain_list__sym_name(chain,
261 					bf, sizeof(bf), false));
262 	}
263 
264 	return ret;
265 }
266 
267 static size_t callchain__fprintf_flat(FILE *fp, struct rb_root *tree,
268 				      u64 total_samples)
269 {
270 	size_t ret = 0;
271 	u32 entries_printed = 0;
272 	struct callchain_node *chain;
273 	struct rb_node *rb_node = rb_first(tree);
274 
275 	while (rb_node) {
276 		chain = rb_entry(rb_node, struct callchain_node, rb_node);
277 
278 		ret += fprintf(fp, "           ");
279 		ret += callchain_node__fprintf_value(chain, fp, total_samples);
280 		ret += fprintf(fp, "\n");
281 		ret += __callchain__fprintf_flat(fp, chain, total_samples);
282 		ret += fprintf(fp, "\n");
283 		if (++entries_printed == callchain_param.print_limit)
284 			break;
285 
286 		rb_node = rb_next(rb_node);
287 	}
288 
289 	return ret;
290 }
291 
292 static size_t __callchain__fprintf_folded(FILE *fp, struct callchain_node *node)
293 {
294 	const char *sep = symbol_conf.field_sep ?: ";";
295 	struct callchain_list *chain;
296 	size_t ret = 0;
297 	char bf[1024];
298 	bool first;
299 
300 	if (!node)
301 		return 0;
302 
303 	ret += __callchain__fprintf_folded(fp, node->parent);
304 
305 	first = (ret == 0);
306 	list_for_each_entry(chain, &node->val, list) {
307 		if (chain->ip >= PERF_CONTEXT_MAX)
308 			continue;
309 		ret += fprintf(fp, "%s%s", first ? "" : sep,
310 			       callchain_list__sym_name(chain,
311 						bf, sizeof(bf), false));
312 		first = false;
313 	}
314 
315 	return ret;
316 }
317 
318 static size_t callchain__fprintf_folded(FILE *fp, struct rb_root *tree,
319 					u64 total_samples)
320 {
321 	size_t ret = 0;
322 	u32 entries_printed = 0;
323 	struct callchain_node *chain;
324 	struct rb_node *rb_node = rb_first(tree);
325 
326 	while (rb_node) {
327 
328 		chain = rb_entry(rb_node, struct callchain_node, rb_node);
329 
330 		ret += callchain_node__fprintf_value(chain, fp, total_samples);
331 		ret += fprintf(fp, " ");
332 		ret += __callchain__fprintf_folded(fp, chain);
333 		ret += fprintf(fp, "\n");
334 		if (++entries_printed == callchain_param.print_limit)
335 			break;
336 
337 		rb_node = rb_next(rb_node);
338 	}
339 
340 	return ret;
341 }
342 
343 static size_t hist_entry_callchain__fprintf(struct hist_entry *he,
344 					    u64 total_samples, int left_margin,
345 					    FILE *fp)
346 {
347 	u64 parent_samples = he->stat.period;
348 
349 	if (symbol_conf.cumulate_callchain)
350 		parent_samples = he->stat_acc->period;
351 
352 	switch (callchain_param.mode) {
353 	case CHAIN_GRAPH_REL:
354 		return callchain__fprintf_graph(fp, &he->sorted_chain, total_samples,
355 						parent_samples, left_margin);
356 		break;
357 	case CHAIN_GRAPH_ABS:
358 		return callchain__fprintf_graph(fp, &he->sorted_chain, total_samples,
359 						parent_samples, left_margin);
360 		break;
361 	case CHAIN_FLAT:
362 		return callchain__fprintf_flat(fp, &he->sorted_chain, total_samples);
363 		break;
364 	case CHAIN_FOLDED:
365 		return callchain__fprintf_folded(fp, &he->sorted_chain, total_samples);
366 		break;
367 	case CHAIN_NONE:
368 		break;
369 	default:
370 		pr_err("Bad callchain mode\n");
371 	}
372 
373 	return 0;
374 }
375 
376 static int hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp)
377 {
378 	const char *sep = symbol_conf.field_sep;
379 	struct perf_hpp_fmt *fmt;
380 	char *start = hpp->buf;
381 	int ret;
382 	bool first = true;
383 
384 	if (symbol_conf.exclude_other && !he->parent)
385 		return 0;
386 
387 	hists__for_each_format(he->hists, fmt) {
388 		if (perf_hpp__should_skip(fmt, he->hists))
389 			continue;
390 
391 		/*
392 		 * If there's no field_sep, we still need
393 		 * to display initial '  '.
394 		 */
395 		if (!sep || !first) {
396 			ret = scnprintf(hpp->buf, hpp->size, "%s", sep ?: "  ");
397 			advance_hpp(hpp, ret);
398 		} else
399 			first = false;
400 
401 		if (perf_hpp__use_color() && fmt->color)
402 			ret = fmt->color(fmt, hpp, he);
403 		else
404 			ret = fmt->entry(fmt, hpp, he);
405 
406 		ret = hist_entry__snprintf_alignment(he, hpp, fmt, ret);
407 		advance_hpp(hpp, ret);
408 	}
409 
410 	return hpp->buf - start;
411 }
412 
413 static int hist_entry__fprintf(struct hist_entry *he, size_t size,
414 			       struct hists *hists,
415 			       char *bf, size_t bfsz, FILE *fp)
416 {
417 	int ret;
418 	struct perf_hpp hpp = {
419 		.buf		= bf,
420 		.size		= size,
421 	};
422 	u64 total_period = hists->stats.total_period;
423 
424 	if (size == 0 || size > bfsz)
425 		size = hpp.size = bfsz;
426 
427 	hist_entry__snprintf(he, &hpp);
428 
429 	ret = fprintf(fp, "%s\n", bf);
430 
431 	if (symbol_conf.use_callchain)
432 		ret += hist_entry_callchain__fprintf(he, total_period, 0, fp);
433 
434 	return ret;
435 }
436 
437 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
438 		      int max_cols, float min_pcnt, FILE *fp)
439 {
440 	struct perf_hpp_fmt *fmt;
441 	struct rb_node *nd;
442 	size_t ret = 0;
443 	unsigned int width;
444 	const char *sep = symbol_conf.field_sep;
445 	int nr_rows = 0;
446 	char bf[96];
447 	struct perf_hpp dummy_hpp = {
448 		.buf	= bf,
449 		.size	= sizeof(bf),
450 	};
451 	bool first = true;
452 	size_t linesz;
453 	char *line = NULL;
454 
455 	init_rem_hits();
456 
457 	hists__for_each_format(hists, fmt)
458 		perf_hpp__reset_width(fmt, hists);
459 
460 	if (symbol_conf.col_width_list_str)
461 		perf_hpp__set_user_width(symbol_conf.col_width_list_str);
462 
463 	if (!show_header)
464 		goto print_entries;
465 
466 	fprintf(fp, "# ");
467 
468 	hists__for_each_format(hists, fmt) {
469 		if (perf_hpp__should_skip(fmt, hists))
470 			continue;
471 
472 		if (!first)
473 			fprintf(fp, "%s", sep ?: "  ");
474 		else
475 			first = false;
476 
477 		fmt->header(fmt, &dummy_hpp, hists_to_evsel(hists));
478 		fprintf(fp, "%s", bf);
479 	}
480 
481 	fprintf(fp, "\n");
482 	if (max_rows && ++nr_rows >= max_rows)
483 		goto out;
484 
485 	if (sep)
486 		goto print_entries;
487 
488 	first = true;
489 
490 	fprintf(fp, "# ");
491 
492 	hists__for_each_format(hists, fmt) {
493 		unsigned int i;
494 
495 		if (perf_hpp__should_skip(fmt, hists))
496 			continue;
497 
498 		if (!first)
499 			fprintf(fp, "%s", sep ?: "  ");
500 		else
501 			first = false;
502 
503 		width = fmt->width(fmt, &dummy_hpp, hists_to_evsel(hists));
504 		for (i = 0; i < width; i++)
505 			fprintf(fp, ".");
506 	}
507 
508 	fprintf(fp, "\n");
509 	if (max_rows && ++nr_rows >= max_rows)
510 		goto out;
511 
512 	fprintf(fp, "#\n");
513 	if (max_rows && ++nr_rows >= max_rows)
514 		goto out;
515 
516 print_entries:
517 	linesz = hists__sort_list_width(hists) + 3 + 1;
518 	linesz += perf_hpp__color_overhead();
519 	line = malloc(linesz);
520 	if (line == NULL) {
521 		ret = -1;
522 		goto out;
523 	}
524 
525 	for (nd = rb_first(&hists->entries); nd; nd = rb_next(nd)) {
526 		struct hist_entry *h = rb_entry(nd, struct hist_entry, rb_node);
527 		float percent;
528 
529 		if (h->filtered)
530 			continue;
531 
532 		percent = hist_entry__get_percent_limit(h);
533 		if (percent < min_pcnt)
534 			continue;
535 
536 		ret += hist_entry__fprintf(h, max_cols, hists, line, linesz, fp);
537 
538 		if (max_rows && ++nr_rows >= max_rows)
539 			break;
540 
541 		if (h->ms.map == NULL && verbose > 1) {
542 			__map_groups__fprintf_maps(h->thread->mg,
543 						   MAP__FUNCTION, fp);
544 			fprintf(fp, "%.10s end\n", graph_dotted_line);
545 		}
546 	}
547 
548 	free(line);
549 out:
550 	zfree(&rem_sq_bracket);
551 
552 	return ret;
553 }
554 
555 size_t events_stats__fprintf(struct events_stats *stats, FILE *fp)
556 {
557 	int i;
558 	size_t ret = 0;
559 
560 	for (i = 0; i < PERF_RECORD_HEADER_MAX; ++i) {
561 		const char *name;
562 
563 		if (stats->nr_events[i] == 0)
564 			continue;
565 
566 		name = perf_event__name(i);
567 		if (!strcmp(name, "UNKNOWN"))
568 			continue;
569 
570 		ret += fprintf(fp, "%16s events: %10d\n", name,
571 			       stats->nr_events[i]);
572 	}
573 
574 	return ret;
575 }
576