builtin-report.c 13.5 KB
Newer Older
1 2 3 4 5 6 7
/*
 * builtin-report.c
 *
 * Builtin report command: Analyze the perf.data input file,
 * look up and read DSOs and symbol information and display
 * a histogram of results, along various sorting keys.
 */
8
#include "builtin.h"
9

10 11
#include "util/util.h"

12
#include "util/color.h"
13
#include <linux/list.h>
14
#include "util/cache.h"
15
#include <linux/rbtree.h>
16
#include "util/symbol.h"
17
#include "util/callchain.h"
18
#include "util/strlist.h"
19
#include "util/values.h"
20

21
#include "perf.h"
22
#include "util/debug.h"
23
#include "util/header.h"
24
#include "util/session.h"
25 26 27 28

#include "util/parse-options.h"
#include "util/parse-events.h"

29
#include "util/thread.h"
30
#include "util/sort.h"
31
#include "util/hist.h"
32

33
static char		const *input_name = "perf.data";
34

35
static bool		force;
36
static bool		hide_unresolved;
37
static bool		dont_use_callchains;
38

39
static bool		show_threads;
40 41
static struct perf_read_values	show_threads_values;

42 43 44
static char		default_pretty_printing_style[] = "normal";
static char		*pretty_printing_style = default_pretty_printing_style;

45 46
static char		callchain_default_opt[] = "fractal,0.5";

47 48 49
static struct hists *perf_session__hists_findnew(struct perf_session *self,
						 u64 event_stream, u32 type,
						 u64 config)
50
{
51
	struct rb_node **p = &self->hists_tree.rb_node;
52
	struct rb_node *parent = NULL;
53
	struct hists *iter, *new;
54 55 56

	while (*p != NULL) {
		parent = *p;
57
		iter = rb_entry(parent, struct hists, rb_node);
58 59 60 61 62 63 64 65 66 67
		if (iter->config == config)
			return iter;


		if (config > iter->config)
			p = &(*p)->rb_right;
		else
			p = &(*p)->rb_left;
	}

68
	new = malloc(sizeof(struct hists));
69 70
	if (new == NULL)
		return NULL;
71
	memset(new, 0, sizeof(struct hists));
72 73 74 75
	new->event_stream = event_stream;
	new->config = config;
	new->type = type;
	rb_link_node(&new->rb_node, parent, p);
76
	rb_insert_color(&new->rb_node, &self->hists_tree);
77 78 79
	return new;
}

80 81
static int perf_session__add_hist_entry(struct perf_session *self,
					struct addr_location *al,
82
					struct sample_data *data)
83
{
84 85
	struct map_symbol *syms = NULL;
	struct symbol *parent = NULL;
86
	int err = -ENOMEM;
87
	struct hist_entry *he;
88
	struct hists *hists;
89
	struct perf_event_attr *attr;
90

91
	if ((sort__has_parent || symbol_conf.use_callchain) && data->callchain) {
92
		syms = perf_session__resolve_callchain(self, al->thread,
93
						       data->callchain, &parent);
94 95 96
		if (syms == NULL)
			return -ENOMEM;
	}
97 98 99

	attr = perf_header__find_attr(data->id, &self->header);
	if (attr)
100
		hists = perf_session__hists_findnew(self, data->id, attr->type, attr->config);
101
	else
102 103
		hists = perf_session__hists_findnew(self, data->id, 0, 0);
	if (hists == NULL)
104
		goto out_free_syms;
105
	he = __hists__add_entry(hists, al, parent, data->period);
106
	if (he == NULL)
107 108
		goto out_free_syms;
	err = 0;
109
	if (symbol_conf.use_callchain) {
110
		err = append_chain(he->callchain, data->callchain, syms);
111 112 113 114 115 116 117 118 119 120
		if (err)
			goto out_free_syms;
	}
	/*
	 * Only in the newt browser we are doing integrated annotation,
	 * so we don't allocated the extra space needed because the stdio
	 * code will not use it.
	 */
	if (use_browser)
		err = hist_entry__inc_addr_samples(he, al->addr);
121 122 123
out_free_syms:
	free(syms);
	return err;
124 125
}

126 127 128 129
static int add_event_total(struct perf_session *session,
			   struct sample_data *data,
			   struct perf_event_attr *attr)
{
130
	struct hists *hists;
131 132

	if (attr)
133 134
		hists = perf_session__hists_findnew(session, data->id,
						    attr->type, attr->config);
135
	else
136
		hists = perf_session__hists_findnew(session, data->id, 0, 0);
137

138
	if (!hists)
139 140
		return -ENOMEM;

141
	hists->stats.total += data->period;
142 143 144 145 146 147
	/*
	 * FIXME: add_event_total should be moved from here to
	 * perf_session__process_event so that the proper hist is passed to
	 * the event_op methods.
	 */
	hists__inc_nr_events(hists, PERF_RECORD_SAMPLE);
148
	session->hists.stats.total += data->period;
149 150 151
	return 0;
}

152
static int process_sample_event(event_t *event, struct perf_session *session)
153
{
154
	struct sample_data data = { .period = 1, };
155
	struct addr_location al;
156
	struct perf_event_attr *attr;
157

158
	event__parse_sample(event, session->sample_type, &data);
159

160 161
	dump_printf("(IP, %d): %d/%d: %#Lx period: %Ld\n", event->header.misc,
		    data.pid, data.tid, data.ip, data.period);
162

163
	if (session->sample_type & PERF_SAMPLE_CALLCHAIN) {
164
		unsigned int i;
165

166
		dump_printf("... chain: nr:%Lu\n", data.callchain->nr);
167

168
		if (!ip_callchain__valid(data.callchain, event)) {
169 170
			pr_debug("call-chain problem with event, "
				 "skipping it.\n");
171 172 173 174
			return 0;
		}

		if (dump_trace) {
175 176 177
			for (i = 0; i < data.callchain->nr; i++)
				dump_printf("..... %2d: %016Lx\n",
					    i, data.callchain->ips[i]);
178 179 180
		}
	}

181 182
	if (event__preprocess_sample(event, session, &al, NULL) < 0) {
		fprintf(stderr, "problem processing %d event, skipping it.\n",
183 184 185
			event->header.type);
		return -1;
	}
186

187
	if (al.filtered || (hide_unresolved && al.sym == NULL))
188
		return 0;
189

190
	if (perf_session__add_hist_entry(session, &al, &data)) {
191
		pr_debug("problem incrementing symbol count, skipping event\n");
192
		return -1;
193
	}
194

195 196 197 198 199 200 201
	attr = perf_header__find_attr(data.id, &session->header);

	if (add_event_total(session, &data, attr)) {
		pr_debug("problem adding event count\n");
		return -1;
	}

202 203
	return 0;
}
I
Ingo Molnar 已提交
204

205
static int process_read_event(event_t *event, struct perf_session *session __used)
206
{
207
	struct perf_event_attr *attr;
208

209
	attr = perf_header__find_attr(event->read.id, &session->header);
210

211
	if (show_threads) {
212
		const char *name = attr ? __event_name(attr->type, attr->config)
213 214 215 216 217 218 219 220
				   : "unknown";
		perf_read_values_add_value(&show_threads_values,
					   event->read.pid, event->read.tid,
					   event->read.id,
					   name,
					   event->read.value);
	}

221 222 223
	dump_printf(": %d %d %s %Lu\n", event->read.pid, event->read.tid,
		    attr ? __event_name(attr->type, attr->config) : "FAIL",
		    event->read.value);
224 225 226 227

	return 0;
}

228
static int perf_session__setup_sample_type(struct perf_session *self)
229
{
230
	if (!(self->sample_type & PERF_SAMPLE_CALLCHAIN)) {
231 232 233 234
		if (sort__has_parent) {
			fprintf(stderr, "selected --sort parent, but no"
					" callchain data. Did you call"
					" perf record without -g?\n");
235
			return -EINVAL;
236
		}
237
		if (symbol_conf.use_callchain) {
238
			fprintf(stderr, "selected -g but no callchain data."
239 240
					" Did you call perf record without"
					" -g?\n");
241
			return -1;
242
		}
243 244
	} else if (!dont_use_callchains && callchain_param.mode != CHAIN_NONE &&
		   !symbol_conf.use_callchain) {
245
			symbol_conf.use_callchain = true;
246 247 248
			if (register_callchain_param(&callchain_param) < 0) {
				fprintf(stderr, "Can't register callchain"
						" params\n");
249
				return -EINVAL;
250
			}
251 252
	}

253 254
	return 0;
}
255

256
static struct perf_event_ops event_ops = {
257 258 259 260 261 262 263
	.sample	= process_sample_event,
	.mmap	= event__process_mmap,
	.comm	= event__process_comm,
	.exit	= event__process_task,
	.fork	= event__process_task,
	.lost	= event__process_lost,
	.read	= process_read_event,
264
	.attr	= event__process_attr,
265
	.event_type = event__process_event_type,
266
	.tracing_data = event__process_tracing_data,
267
	.build_id = event__process_build_id,
268
};
269

270 271 272 273 274 275 276
extern volatile int session_done;

static void sig_handler(int sig __attribute__((__unused__)))
{
	session_done = 1;
}

277 278
static int __cmd_report(void)
{
279
	int ret = -EINVAL;
280
	struct perf_session *session;
281
	struct rb_node *next;
282
	const char *help = "For a higher level overview, try: perf report --sort comm,dso";
283

284 285
	signal(SIGINT, sig_handler);

T
Tom Zanussi 已提交
286
	session = perf_session__new(input_name, O_RDONLY, force, false);
287 288 289
	if (session == NULL)
		return -ENOMEM;

290 291
	if (show_threads)
		perf_read_values_init(&show_threads_values);
292

293 294 295 296
	ret = perf_session__setup_sample_type(session);
	if (ret)
		goto out_delete;

297
	ret = perf_session__process_events(session, &event_ops);
298
	if (ret)
299
		goto out_delete;
300

301
	if (dump_trace) {
302
		perf_session__fprintf_nr_events(session, stdout);
303
		goto out_delete;
304
	}
305

306
	if (verbose > 3)
307
		perf_session__fprintf(session, stdout);
308

309
	if (verbose > 2)
310
		perf_session__fprintf_dsos(session, stdout);
311

312
	next = rb_first(&session->hists_tree);
313
	while (next) {
314
		struct hists *hists;
315

316 317
		hists = rb_entry(next, struct hists, rb_node);
		hists__collapse_resort(hists);
318
		hists__output_resort(hists);
319
		if (use_browser)
320
			hists__browse(hists, help, input_name);
321
		else {
322 323
			if (rb_first(&session->hists.entries) ==
			    rb_last(&session->hists.entries))
324
				fprintf(stdout, "# Samples: %Ld\n#\n",
325
					hists->stats.total);
326 327
			else
				fprintf(stdout, "# Samples: %Ld %s\n#\n",
328 329
					hists->stats.total,
					__event_name(hists->type, hists->config));
330

331
			hists__fprintf(hists, NULL, false, stdout);
332 333 334
			fprintf(stdout, "\n\n");
		}

335
		next = rb_next(&hists->rb_node);
336 337
	}

338 339 340
	if (!use_browser && sort_order == default_sort_order &&
	    parent_pattern == default_parent_pattern) {
		fprintf(stdout, "#\n# (%s)\n#\n", help);
341

342 343 344 345 346 347
		if (show_threads) {
			bool style = !strcmp(pretty_printing_style, "raw");
			perf_read_values_display(stdout, &show_threads_values,
						 style);
			perf_read_values_destroy(&show_threads_values);
		}
348
	}
349 350
out_delete:
	perf_session__delete(session);
351
	return ret;
352 353
}

354 355
static int
parse_callchain_opt(const struct option *opt __used, const char *arg,
356
		    int unset)
357
{
358
	char *tok, *tok2;
359 360
	char *endptr;

361 362 363 364 365 366 367 368
	/*
	 * --no-call-graph
	 */
	if (unset) {
		dont_use_callchains = true;
		return 0;
	}

369
	symbol_conf.use_callchain = true;
370 371 372 373

	if (!arg)
		return 0;

374 375 376 377 378 379
	tok = strtok((char *)arg, ",");
	if (!tok)
		return -1;

	/* get the output mode */
	if (!strncmp(tok, "graph", strlen(arg)))
380
		callchain_param.mode = CHAIN_GRAPH_ABS;
381

382
	else if (!strncmp(tok, "flat", strlen(arg)))
383 384 385 386 387
		callchain_param.mode = CHAIN_FLAT;

	else if (!strncmp(tok, "fractal", strlen(arg)))
		callchain_param.mode = CHAIN_GRAPH_REL;

388 389
	else if (!strncmp(tok, "none", strlen(arg))) {
		callchain_param.mode = CHAIN_NONE;
390
		symbol_conf.use_callchain = false;
391 392 393 394

		return 0;
	}

395 396 397
	else
		return -1;

398 399 400
	/* get the min percentage */
	tok = strtok(NULL, ",");
	if (!tok)
401
		goto setup;
402

403
	tok2 = strtok(NULL, ",");
404
	callchain_param.min_percent = strtod(tok, &endptr);
405 406 407
	if (tok == endptr)
		return -1;

408 409
	if (tok2)
		callchain_param.print_limit = strtod(tok2, &endptr);
410 411 412 413 414
setup:
	if (register_callchain_param(&callchain_param) < 0) {
		fprintf(stderr, "Can't register callchain params\n");
		return -1;
	}
415 416 417
	return 0;
}

418
static const char * const report_usage[] = {
419 420 421 422 423 424 425
	"perf report [<options>] <command>",
	NULL
};

static const struct option options[] = {
	OPT_STRING('i', "input", &input_name, "file",
		    "input file name"),
426
	OPT_INCR('v', "verbose", &verbose,
427
		    "be more verbose (show symbol address, etc)"),
428 429
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
430 431
	OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
		   "file", "vmlinux pathname"),
432
	OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
433
	OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
434
		    "load module symbols - WARNING: use only with -k and LIVE kernel"),
435
	OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
436
		    "Show a column with the number of samples"),
437 438
	OPT_BOOLEAN('T', "threads", &show_threads,
		    "Show per-thread event counters"),
439 440
	OPT_STRING(0, "pretty", &pretty_printing_style, "key",
		   "pretty printing style key: normal raw"),
441
	OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
442
		   "sort by key(s): pid, comm, dso, symbol, parent"),
443
	OPT_BOOLEAN('P', "full-paths", &symbol_conf.full_paths,
444
		    "Don't shorten the pathnames taking into account the cwd"),
445 446
	OPT_BOOLEAN(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
		    "Show sample percentage for different cpu modes"),
447 448
	OPT_STRING('p', "parent", &parent_pattern, "regex",
		   "regex filter to identify parent, see: '--sort parent'"),
449
	OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
450
		    "Only display entries with parent-match"),
451
	OPT_CALLBACK_DEFAULT('g', "call-graph", NULL, "output_type,min_percent",
452
		     "Display callchains using output_type (graph, flat, fractal, or none) and min percent threshold. "
453
		     "Default: fractal,0.5", &parse_callchain_opt, callchain_default_opt),
454
	OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
455
		   "only consider symbols in these dsos"),
456
	OPT_STRING('C', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
457
		   "only consider symbols in these comms"),
458
	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
459
		   "only consider these symbols"),
460
	OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
461 462
		   "width[,width...]",
		   "don't try to adjust column width, use these fixed values"),
463
	OPT_STRING('t', "field-separator", &symbol_conf.field_sep, "separator",
464 465
		   "separator for columns, no spaces will be added between "
		   "columns '.' is reserved."),
466 467
	OPT_BOOLEAN('U', "hide-unresolved", &hide_unresolved,
		    "Only display entries resolved to a symbol"),
468 469 470
	OPT_END()
};

471
int cmd_report(int argc, const char **argv, const char *prefix __used)
472
{
473 474
	argc = parse_options(argc, argv, options, report_usage, 0);

475 476
	if (strcmp(input_name, "-") != 0)
		setup_browser();
477 478 479 480 481 482 483
	/*
	 * Only in the newt browser we are doing integrated annotation,
	 * so don't allocate extra space that won't be used in the stdio
	 * implementation.
	 */
	if (use_browser)
		symbol_conf.priv_size = sizeof(struct sym_priv);
484

485
	if (symbol__init() < 0)
486
		return -1;
487

488
	setup_sorting(report_usage, options);
489

490
	if (parent_pattern != default_parent_pattern) {
491 492
		if (sort_dimension__add("parent") < 0)
			return -1;
493 494
		sort_parent.elide = 1;
	} else
495
		symbol_conf.exclude_other = false;
496

497 498 499 500 501 502
	/*
	 * Any (unrecognized) arguments left?
	 */
	if (argc)
		usage_with_options(report_usage, options);

503 504 505
	sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", stdout);
	sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", stdout);
	sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", stdout);
506

507 508
	return __cmd_report();
}