builtin-diff.c 15.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
/*
 * builtin-diff.c
 *
 * Builtin diff command: Analyze two perf.data input files, look up and read
 * DSOs and symbol information, sort them and produce a diff.
 */
#include "builtin.h"

#include "util/debug.h"
#include "util/event.h"
#include "util/hist.h"
12
#include "util/evsel.h"
13
#include "util/evlist.h"
14
#include "util/session.h"
15
#include "util/tool.h"
16 17 18 19 20 21
#include "util/sort.h"
#include "util/symbol.h"
#include "util/util.h"

#include <stdlib.h>

22 23
static char const *input_old = "perf.data.old",
		  *input_new = "perf.data";
24
static char	  diff__default_sort_order[] = "dso,symbol";
25
static bool  force;
26
static bool show_displacement;
27
static bool show_period;
28
static bool show_formula;
29
static bool show_baseline_only;
30
static bool sort_compute;
31

32 33 34
static s64 compute_wdiff_w1;
static s64 compute_wdiff_w2;

35 36 37
enum {
	COMPUTE_DELTA,
	COMPUTE_RATIO,
38
	COMPUTE_WEIGHTED_DIFF,
39 40 41 42 43 44
	COMPUTE_MAX,
};

const char *compute_names[COMPUTE_MAX] = {
	[COMPUTE_DELTA] = "delta",
	[COMPUTE_RATIO] = "ratio",
45
	[COMPUTE_WEIGHTED_DIFF] = "wdiff",
46 47 48 49
};

static int compute;

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
static int setup_compute_opt_wdiff(char *opt)
{
	char *w1_str = opt;
	char *w2_str;

	int ret = -EINVAL;

	if (!opt)
		goto out;

	w2_str = strchr(opt, ',');
	if (!w2_str)
		goto out;

	*w2_str++ = 0x0;
	if (!*w2_str)
		goto out;

	compute_wdiff_w1 = strtol(w1_str, NULL, 10);
	compute_wdiff_w2 = strtol(w2_str, NULL, 10);

	if (!compute_wdiff_w1 || !compute_wdiff_w2)
		goto out;

	pr_debug("compute wdiff w1(%" PRId64 ") w2(%" PRId64 ")\n",
		  compute_wdiff_w1, compute_wdiff_w2);

	ret = 0;

 out:
	if (ret)
		pr_err("Failed: wrong weight data, use 'wdiff:w1,w2'\n");

	return ret;
}

static int setup_compute_opt(char *opt)
{
	if (compute == COMPUTE_WEIGHTED_DIFF)
		return setup_compute_opt_wdiff(opt);

	if (opt) {
		pr_err("Failed: extra option specified '%s'", opt);
		return -EINVAL;
	}

	return 0;
}

99 100 101 102
static int setup_compute(const struct option *opt, const char *str,
			 int unset __maybe_unused)
{
	int *cp = (int *) opt->value;
103 104
	char *cstr = (char *) str;
	char buf[50];
105
	unsigned i;
106
	char *option;
107 108 109 110 111 112

	if (!str) {
		*cp = COMPUTE_DELTA;
		return 0;
	}

113 114
	if (*str == '+') {
		sort_compute = true;
115
		cstr = (char *) ++str;
116 117 118 119
		if (!*str)
			return 0;
	}

120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
	option = strchr(str, ':');
	if (option) {
		unsigned len = option++ - str;

		/*
		 * The str data are not writeable, so we need
		 * to use another buffer.
		 */

		/* No option value is longer. */
		if (len >= sizeof(buf))
			return -EINVAL;

		strncpy(buf, str, len);
		buf[len] = 0x0;
		cstr = buf;
	}

138
	for (i = 0; i < COMPUTE_MAX; i++)
139
		if (!strcmp(cstr, compute_names[i])) {
140
			*cp = i;
141
			return setup_compute_opt(option);
142 143 144
		}

	pr_err("Failed: '%s' is not computation method "
145
	       "(use 'delta','ratio' or 'wdiff')\n", str);
146 147 148
	return -EINVAL;
}

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
static double get_period_percent(struct hist_entry *he, u64 period)
{
	u64 total = he->hists->stats.total_period;
	return (period * 100.0) / total;
}

double perf_diff__compute_delta(struct hist_entry *he)
{
	struct hist_entry *pair = he->pair;
	double new_percent = get_period_percent(he, he->stat.period);
	double old_percent = pair ? get_period_percent(pair, pair->stat.period) : 0.0;

	he->diff.period_ratio_delta = new_percent - old_percent;
	he->diff.computed = true;
	return he->diff.period_ratio_delta;
}

double perf_diff__compute_ratio(struct hist_entry *he)
{
	struct hist_entry *pair = he->pair;
	double new_period = he->stat.period;
	double old_period = pair ? pair->stat.period : 0;

	he->diff.computed = true;
	he->diff.period_ratio = pair ? (new_period / old_period) : 0;
	return he->diff.period_ratio;
}

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
s64 perf_diff__compute_wdiff(struct hist_entry *he)
{
	struct hist_entry *pair = he->pair;
	u64 new_period = he->stat.period;
	u64 old_period = pair ? pair->stat.period : 0;

	he->diff.computed = true;

	if (!pair)
		he->diff.wdiff = 0;
	else
		he->diff.wdiff = new_period * compute_wdiff_w2 -
				 old_period * compute_wdiff_w1;

	return he->diff.wdiff;
}

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
static int formula_delta(struct hist_entry *he, char *buf, size_t size)
{
	struct hist_entry *pair = he->pair;

	if (!pair)
		return -1;

	return scnprintf(buf, size,
			 "(%" PRIu64 " * 100 / %" PRIu64 ") - "
			 "(%" PRIu64 " * 100 / %" PRIu64 ")",
			  he->stat.period, he->hists->stats.total_period,
			  pair->stat.period, pair->hists->stats.total_period);
}

static int formula_ratio(struct hist_entry *he, char *buf, size_t size)
{
	struct hist_entry *pair = he->pair;
	double new_period = he->stat.period;
	double old_period = pair ? pair->stat.period : 0;

	if (!pair)
		return -1;

	return scnprintf(buf, size, "%.0F / %.0F", new_period, old_period);
}

static int formula_wdiff(struct hist_entry *he, char *buf, size_t size)
{
	struct hist_entry *pair = he->pair;
	u64 new_period = he->stat.period;
	u64 old_period = pair ? pair->stat.period : 0;

	if (!pair)
		return -1;

	return scnprintf(buf, size,
		  "(%" PRIu64 " * " "%" PRId64 ") - (%" PRIu64 " * " "%" PRId64 ")",
		  new_period, compute_wdiff_w2, old_period, compute_wdiff_w1);
}

int perf_diff__formula(char *buf, size_t size, struct hist_entry *he)
{
	switch (compute) {
	case COMPUTE_DELTA:
		return formula_delta(he, buf, size);
	case COMPUTE_RATIO:
		return formula_ratio(he, buf, size);
	case COMPUTE_WEIGHTED_DIFF:
		return formula_wdiff(he, buf, size);
	default:
		BUG_ON(1);
	}

	return -1;
}

250
static int hists__add_entry(struct hists *self,
251
			    struct addr_location *al, u64 period)
252
{
253
	if (__hists__add_entry(self, al, NULL, period) != NULL)
254 255
		return 0;
	return -ENOMEM;
256 257
}

258
static int diff__process_sample_event(struct perf_tool *tool __maybe_unused,
259
				      union perf_event *event,
260
				      struct perf_sample *sample,
261
				      struct perf_evsel *evsel,
262
				      struct machine *machine)
263 264 265
{
	struct addr_location al;

266
	if (perf_event__preprocess_sample(event, machine, &al, sample, NULL) < 0) {
267 268 269 270 271
		pr_warning("problem processing %d event, skipping it.\n",
			   event->header.type);
		return -1;
	}

272
	if (al.filtered || al.sym == NULL)
273 274
		return 0;

275
	if (hists__add_entry(&evsel->hists, &al, sample->period)) {
276
		pr_warning("problem incrementing symbol period, skipping event\n");
277 278 279
		return -1;
	}

280
	evsel->hists.stats.total_period += sample->period;
281 282 283
	return 0;
}

284 285 286 287 288 289 290 291 292
static struct perf_tool tool = {
	.sample	= diff__process_sample_event,
	.mmap	= perf_event__process_mmap,
	.comm	= perf_event__process_comm,
	.exit	= perf_event__process_task,
	.fork	= perf_event__process_task,
	.lost	= perf_event__process_lost,
	.ordered_samples = true,
	.ordering_requires_timestamps = true,
293 294
};

295 296
static void insert_hist_entry_by_name(struct rb_root *root,
				      struct hist_entry *he)
297 298 299 300 301 302 303 304
{
	struct rb_node **p = &root->rb_node;
	struct rb_node *parent = NULL;
	struct hist_entry *iter;

	while (*p != NULL) {
		parent = *p;
		iter = rb_entry(parent, struct hist_entry, rb_node);
305
		if (hist_entry__cmp(he, iter) < 0)
306
			p = &(*p)->rb_left;
307
		else
308 309 310 311 312 313 314
			p = &(*p)->rb_right;
	}

	rb_link_node(&he->rb_node, parent, p);
	rb_insert_color(&he->rb_node, root);
}

315
static void hists__name_resort(struct hists *self, bool sort)
316 317 318
{
	unsigned long position = 1;
	struct rb_root tmp = RB_ROOT;
319
	struct rb_node *next = rb_first(&self->entries);
320 321 322 323 324 325

	while (next != NULL) {
		struct hist_entry *n = rb_entry(next, struct hist_entry, rb_node);

		next = rb_next(&n->rb_node);
		n->position = position++;
326 327 328 329 330

		if (sort) {
			rb_erase(&n->rb_node, &self->entries);
			insert_hist_entry_by_name(&tmp, n);
		}
331 332
	}

333 334
	if (sort)
		self->entries = tmp;
335 336
}

337 338
static struct hist_entry *hists__find_entry(struct hists *self,
					    struct hist_entry *he)
339
{
340
	struct rb_node *n = self->entries.rb_node;
341 342 343

	while (n) {
		struct hist_entry *iter = rb_entry(n, struct hist_entry, rb_node);
344
		int64_t cmp = hist_entry__cmp(he, iter);
345

346
		if (cmp < 0)
347
			n = n->rb_left;
348
		else if (cmp > 0)
349
			n = n->rb_right;
350
		else
351
			return iter;
352 353 354 355 356
	}

	return NULL;
}

357
static void hists__match(struct hists *older, struct hists *newer)
358 359 360
{
	struct rb_node *nd;

361
	for (nd = rb_first(&newer->entries); nd; nd = rb_next(nd)) {
362
		struct hist_entry *pos = rb_entry(nd, struct hist_entry, rb_node);
363
		pos->pair = hists__find_entry(older, pos);
364 365 366
	}
}

367 368 369 370 371 372 373 374 375 376 377 378
static struct perf_evsel *evsel_match(struct perf_evsel *evsel,
				      struct perf_evlist *evlist)
{
	struct perf_evsel *e;

	list_for_each_entry(e, &evlist->entries, node)
		if (perf_evsel__match2(evsel, e))
			return e;

	return NULL;
}

379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
static void perf_evlist__resort_hists(struct perf_evlist *evlist, bool name)
{
	struct perf_evsel *evsel;

	list_for_each_entry(evsel, &evlist->entries, node) {
		struct hists *hists = &evsel->hists;

		hists__output_resort(hists);

		/*
		 * The hists__name_resort only sets possition
		 * if name is false.
		 */
		if (name || ((!name) && show_displacement))
			hists__name_resort(hists, name);
	}
}

397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
static void hists__baseline_only(struct hists *hists)
{
	struct rb_node *next = rb_first(&hists->entries);

	while (next != NULL) {
		struct hist_entry *he = rb_entry(next, struct hist_entry, rb_node);

		next = rb_next(&he->rb_node);
		if (!he->pair) {
			rb_erase(&he->rb_node, &hists->entries);
			hist_entry__free(he);
		}
	}
}

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
static void hists__precompute(struct hists *hists)
{
	struct rb_node *next = rb_first(&hists->entries);

	while (next != NULL) {
		struct hist_entry *he = rb_entry(next, struct hist_entry, rb_node);

		next = rb_next(&he->rb_node);

		switch (compute) {
		case COMPUTE_DELTA:
			perf_diff__compute_delta(he);
			break;
		case COMPUTE_RATIO:
			perf_diff__compute_ratio(he);
			break;
428 429 430
		case COMPUTE_WEIGHTED_DIFF:
			perf_diff__compute_wdiff(he);
			break;
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
		default:
			BUG_ON(1);
		}
	}
}

static int64_t cmp_doubles(double l, double r)
{
	if (l > r)
		return -1;
	else if (l < r)
		return 1;
	else
		return 0;
}

static int64_t
hist_entry__cmp_compute(struct hist_entry *left, struct hist_entry *right,
			int c)
{
	switch (c) {
	case COMPUTE_DELTA:
	{
		double l = left->diff.period_ratio_delta;
		double r = right->diff.period_ratio_delta;

		return cmp_doubles(l, r);
	}
	case COMPUTE_RATIO:
	{
		double l = left->diff.period_ratio;
		double r = right->diff.period_ratio;

		return cmp_doubles(l, r);
	}
466 467 468 469 470 471 472
	case COMPUTE_WEIGHTED_DIFF:
	{
		s64 l = left->diff.wdiff;
		s64 r = right->diff.wdiff;

		return r - l;
	}
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
	default:
		BUG_ON(1);
	}

	return 0;
}

static void insert_hist_entry_by_compute(struct rb_root *root,
					 struct hist_entry *he,
					 int c)
{
	struct rb_node **p = &root->rb_node;
	struct rb_node *parent = NULL;
	struct hist_entry *iter;

	while (*p != NULL) {
		parent = *p;
		iter = rb_entry(parent, struct hist_entry, rb_node);
		if (hist_entry__cmp_compute(he, iter, c) < 0)
			p = &(*p)->rb_left;
		else
			p = &(*p)->rb_right;
	}

	rb_link_node(&he->rb_node, parent, p);
	rb_insert_color(&he->rb_node, root);
}

static void hists__compute_resort(struct hists *hists)
{
	struct rb_root tmp = RB_ROOT;
	struct rb_node *next = rb_first(&hists->entries);

	while (next != NULL) {
		struct hist_entry *he = rb_entry(next, struct hist_entry, rb_node);

		next = rb_next(&he->rb_node);

		rb_erase(&he->rb_node, &hists->entries);
		insert_hist_entry_by_compute(&tmp, he, compute);
	}

	hists->entries = tmp;
}

518 519 520 521 522 523 524
static void hists__process(struct hists *old, struct hists *new)
{
	hists__match(old, new);

	if (show_baseline_only)
		hists__baseline_only(new);

525 526 527 528 529
	if (sort_compute) {
		hists__precompute(new);
		hists__compute_resort(new);
	}

530 531 532
	hists__fprintf(new, true, 0, 0, stdout);
}

533 534 535
static int __cmd_diff(void)
{
	int ret, i;
536 537
#define older (session[0])
#define newer (session[1])
538
	struct perf_session *session[2];
539 540 541
	struct perf_evlist *evlist_new, *evlist_old;
	struct perf_evsel *evsel;
	bool first = true;
542

543
	older = perf_session__new(input_old, O_RDONLY, force, false,
544
				  &tool);
545
	newer = perf_session__new(input_new, O_RDONLY, force, false,
546
				  &tool);
547 548 549 550
	if (session[0] == NULL || session[1] == NULL)
		return -ENOMEM;

	for (i = 0; i < 2; ++i) {
551
		ret = perf_session__process_events(session[i], &tool);
552 553 554 555
		if (ret)
			goto out_delete;
	}

556 557 558
	evlist_old = older->evlist;
	evlist_new = newer->evlist;

559 560
	perf_evlist__resort_hists(evlist_old, true);
	perf_evlist__resort_hists(evlist_new, false);
561 562 563 564 565 566 567 568 569 570 571 572 573

	list_for_each_entry(evsel, &evlist_new->entries, node) {
		struct perf_evsel *evsel_old;

		evsel_old = evsel_match(evsel, evlist_old);
		if (!evsel_old)
			continue;

		fprintf(stdout, "%s# Event '%s'\n#\n", first ? "" : "\n",
			perf_evsel__name(evsel));

		first = false;

574
		hists__process(&evsel_old->hists, &evsel->hists);
575
	}
576

577 578 579 580
out_delete:
	for (i = 0; i < 2; ++i)
		perf_session__delete(session[i]);
	return ret;
581 582
#undef older
#undef newer
583 584
}

585
static const char * const diff_usage[] = {
586
	"perf diff [<options>] [old_file] [new_file]",
587
	NULL,
588 589 590
};

static const struct option options[] = {
591
	OPT_INCR('v', "verbose", &verbose,
592
		    "be more verbose (show symbol address, etc)"),
593
	OPT_BOOLEAN('M', "displacement", &show_displacement,
594
		    "Show position displacement relative to baseline"),
595 596
	OPT_BOOLEAN('b', "baseline-only", &show_baseline_only,
		    "Show only items with match in baseline"),
597 598
	OPT_CALLBACK('c', "compute", &compute,
		     "delta,ratio,wdiff:w1,w2 (default delta)",
599 600
		     "Entries differential computation selection",
		     setup_compute),
601 602
	OPT_BOOLEAN('p', "period", &show_period,
		    "Show period values."),
603 604
	OPT_BOOLEAN('F', "formula", &show_formula,
		    "Show formula."),
605 606 607 608 609
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
	OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
	OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
		    "load module symbols - WARNING: use only with -k and LIVE kernel"),
610 611 612 613 614 615
	OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
		   "only consider symbols in these dsos"),
	OPT_STRING('C', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only consider symbols in these comms"),
	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
		   "only consider these symbols"),
616 617 618 619 620
	OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
		   "sort by key(s): pid, comm, dso, symbol, parent"),
	OPT_STRING('t', "field-separator", &symbol_conf.field_sep, "separator",
		   "separator for columns, no spaces will be added between "
		   "columns '.' is reserved."),
621 622
	OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
		    "Look for files with symbols relative to this directory"),
623 624 625
	OPT_END()
};

626 627 628 629 630 631 632
static void ui_init(void)
{
	perf_hpp__init();

	/* No overhead column. */
	perf_hpp__column_enable(PERF_HPP__OVERHEAD, false);

633 634 635 636
	/*
	 * Display baseline/delta/ratio/displacement/
	 * formula/periods columns.
	 */
637
	perf_hpp__column_enable(PERF_HPP__BASELINE, true);
638 639 640 641 642 643 644

	switch (compute) {
	case COMPUTE_DELTA:
		perf_hpp__column_enable(PERF_HPP__DELTA, true);
		break;
	case COMPUTE_RATIO:
		perf_hpp__column_enable(PERF_HPP__RATIO, true);
645 646 647
		break;
	case COMPUTE_WEIGHTED_DIFF:
		perf_hpp__column_enable(PERF_HPP__WEIGHTED_DIFF, true);
648 649 650 651
		break;
	default:
		BUG_ON(1);
	};
652 653 654

	if (show_displacement)
		perf_hpp__column_enable(PERF_HPP__DISPL, true);
655

656 657 658
	if (show_formula)
		perf_hpp__column_enable(PERF_HPP__FORMULA, true);

659 660 661 662
	if (show_period) {
		perf_hpp__column_enable(PERF_HPP__PERIOD, true);
		perf_hpp__column_enable(PERF_HPP__PERIOD_BASELINE, true);
	}
663 664
}

665
int cmd_diff(int argc, const char **argv, const char *prefix __maybe_unused)
666
{
667
	sort_order = diff__default_sort_order;
668 669 670 671 672 673 674 675 676
	argc = parse_options(argc, argv, options, diff_usage, 0);
	if (argc) {
		if (argc > 2)
			usage_with_options(diff_usage, options);
		if (argc == 2) {
			input_old = argv[0];
			input_new = argv[1];
		} else
			input_new = argv[0];
677 678 679 680
	} else if (symbol_conf.default_guest_vmlinux_name ||
		   symbol_conf.default_guest_kallsyms) {
		input_old = "perf.data.host";
		input_new = "perf.data.guest";
681 682
	}

683
	symbol_conf.exclude_other = false;
684 685 686
	if (symbol__init() < 0)
		return -1;

687 688
	ui_init();

689
	setup_sorting(diff_usage, options);
690
	setup_pager();
691 692 693 694 695

	sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", NULL);
	sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", NULL);
	sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", NULL);

696 697
	return __cmd_diff();
}