builtin-script.c 62.1 KB
Newer Older
F
Frederic Weisbecker 已提交
1 2
#include "builtin.h"

A
Andrea Gelmini 已提交
3
#include "perf.h"
F
Frederic Weisbecker 已提交
4
#include "util/cache.h"
A
Andrea Gelmini 已提交
5
#include "util/debug.h"
6
#include <subcmd/exec-cmd.h>
A
Andrea Gelmini 已提交
7
#include "util/header.h"
8
#include <subcmd/parse-options.h>
9
#include "util/perf_regs.h"
A
Andrea Gelmini 已提交
10
#include "util/session.h"
11
#include "util/tool.h"
F
Frederic Weisbecker 已提交
12 13
#include "util/symbol.h"
#include "util/thread.h"
I
Ingo Molnar 已提交
14
#include "util/trace-event.h"
A
Andrea Gelmini 已提交
15
#include "util/util.h"
16 17
#include "util/evlist.h"
#include "util/evsel.h"
18
#include "util/sort.h"
19
#include "util/data.h"
20
#include "util/auxtrace.h"
21 22 23
#include "util/cpumap.h"
#include "util/thread_map.h"
#include "util/stat.h"
24
#include "util/thread-stack.h"
25
#include "util/time-utils.h"
26
#include <linux/bitmap.h>
27
#include <linux/stringify.h>
28
#include <linux/time64.h>
29
#include "asm/bug.h"
J
Jiri Olsa 已提交
30
#include "util/mem-events.h"
F
Frederic Weisbecker 已提交
31

T
Tom Zanussi 已提交
32 33
static char const		*script_name;
static char const		*generate_script_lang;
34
static bool			debug_mode;
35
static u64			last_timestamp;
36
static u64			nr_unordered;
37
static bool			no_callchain;
38
static bool			latency_format;
39
static bool			system_wide;
40
static bool			print_flags;
41
static bool			nanosecs;
42 43
static const char		*cpu_list;
static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
44
static struct perf_stat_config	stat_config;
T
Tom Zanussi 已提交
45

46
unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
47

48 49 50 51 52 53 54 55
enum perf_output_field {
	PERF_OUTPUT_COMM            = 1U << 0,
	PERF_OUTPUT_TID             = 1U << 1,
	PERF_OUTPUT_PID             = 1U << 2,
	PERF_OUTPUT_TIME            = 1U << 3,
	PERF_OUTPUT_CPU             = 1U << 4,
	PERF_OUTPUT_EVNAME          = 1U << 5,
	PERF_OUTPUT_TRACE           = 1U << 6,
56 57
	PERF_OUTPUT_IP              = 1U << 7,
	PERF_OUTPUT_SYM             = 1U << 8,
58
	PERF_OUTPUT_DSO             = 1U << 9,
59
	PERF_OUTPUT_ADDR            = 1U << 10,
60
	PERF_OUTPUT_SYMOFFSET       = 1U << 11,
61
	PERF_OUTPUT_SRCLINE         = 1U << 12,
J
Jiri Olsa 已提交
62
	PERF_OUTPUT_PERIOD          = 1U << 13,
63
	PERF_OUTPUT_IREGS	    = 1U << 14,
64 65
	PERF_OUTPUT_BRSTACK	    = 1U << 15,
	PERF_OUTPUT_BRSTACKSYM	    = 1U << 16,
66 67
	PERF_OUTPUT_DATA_SRC	    = 1U << 17,
	PERF_OUTPUT_WEIGHT	    = 1U << 18,
68
	PERF_OUTPUT_BPF_OUTPUT	    = 1U << 19,
69
	PERF_OUTPUT_CALLINDENT	    = 1U << 20,
A
Andi Kleen 已提交
70 71
	PERF_OUTPUT_INSN	    = 1U << 21,
	PERF_OUTPUT_INSNLEN	    = 1U << 22,
72 73 74 75 76 77 78 79 80 81 82 83 84
};

struct output_option {
	const char *str;
	enum perf_output_field field;
} all_output_options[] = {
	{.str = "comm",  .field = PERF_OUTPUT_COMM},
	{.str = "tid",   .field = PERF_OUTPUT_TID},
	{.str = "pid",   .field = PERF_OUTPUT_PID},
	{.str = "time",  .field = PERF_OUTPUT_TIME},
	{.str = "cpu",   .field = PERF_OUTPUT_CPU},
	{.str = "event", .field = PERF_OUTPUT_EVNAME},
	{.str = "trace", .field = PERF_OUTPUT_TRACE},
85
	{.str = "ip",    .field = PERF_OUTPUT_IP},
86
	{.str = "sym",   .field = PERF_OUTPUT_SYM},
87
	{.str = "dso",   .field = PERF_OUTPUT_DSO},
88
	{.str = "addr",  .field = PERF_OUTPUT_ADDR},
89
	{.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
90
	{.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
J
Jiri Olsa 已提交
91
	{.str = "period", .field = PERF_OUTPUT_PERIOD},
92
	{.str = "iregs", .field = PERF_OUTPUT_IREGS},
93 94
	{.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
	{.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
95 96
	{.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
	{.str = "weight",   .field = PERF_OUTPUT_WEIGHT},
97
	{.str = "bpf-output",   .field = PERF_OUTPUT_BPF_OUTPUT},
98
	{.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
A
Andi Kleen 已提交
99 100
	{.str = "insn", .field = PERF_OUTPUT_INSN},
	{.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
101 102 103
};

/* default set to maintain compatibility with current format */
104 105
static struct {
	bool user_set;
106
	bool wildcard_set;
107
	unsigned int print_ip_opts;
108 109 110 111 112 113 114 115 116
	u64 fields;
	u64 invalid_fields;
} output[PERF_TYPE_MAX] = {

	[PERF_TYPE_HARDWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
117
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
118 119
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
			      PERF_OUTPUT_PERIOD,
120

121
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
122 123 124 125 126 127 128
	},

	[PERF_TYPE_SOFTWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
129
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
130
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
131
			      PERF_OUTPUT_PERIOD | PERF_OUTPUT_BPF_OUTPUT,
132 133 134 135 136 137 138 139 140

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_TRACEPOINT] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
				  PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
141
				  PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
142
	},
143 144 145 146 147 148

	[PERF_TYPE_RAW] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
149
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
150
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
151 152
			      PERF_OUTPUT_PERIOD |  PERF_OUTPUT_ADDR |
			      PERF_OUTPUT_DATA_SRC | PERF_OUTPUT_WEIGHT,
153

154
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
155
	},
156 157 158 159 160 161 162 163 164 165

	[PERF_TYPE_BREAKPOINT] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
			      PERF_OUTPUT_PERIOD,

166
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
167
	},
168
};
169

170 171 172 173 174 175 176 177 178
static bool output_set_by_user(void)
{
	int j;
	for (j = 0; j < PERF_TYPE_MAX; ++j) {
		if (output[j].user_set)
			return true;
	}
	return false;
}
179

180 181 182 183 184 185 186 187 188 189 190 191 192 193
static const char *output_field2str(enum perf_output_field field)
{
	int i, imax = ARRAY_SIZE(all_output_options);
	const char *str = "";

	for (i = 0; i < imax; ++i) {
		if (all_output_options[i].field == field) {
			str = all_output_options[i].str;
			break;
		}
	}
	return str;
}

194
#define PRINT_FIELD(x)  (output[attr->type].fields & PERF_OUTPUT_##x)
195

196 197 198 199
static int perf_evsel__do_check_stype(struct perf_evsel *evsel,
				      u64 sample_type, const char *sample_msg,
				      enum perf_output_field field,
				      bool allow_user_set)
200
{
201
	struct perf_event_attr *attr = &evsel->attr;
202 203 204 205 206 207 208
	int type = attr->type;
	const char *evname;

	if (attr->sample_type & sample_type)
		return 0;

	if (output[type].user_set) {
209 210
		if (allow_user_set)
			return 0;
211
		evname = perf_evsel__name(evsel);
212 213 214 215 216 217 218 219
		pr_err("Samples for '%s' event do not have %s attribute set. "
		       "Cannot print '%s' field.\n",
		       evname, sample_msg, output_field2str(field));
		return -1;
	}

	/* user did not ask for it explicitly so remove from the default list */
	output[type].fields &= ~field;
220
	evname = perf_evsel__name(evsel);
221 222 223 224 225 226 227
	pr_debug("Samples for '%s' event do not have %s attribute set. "
		 "Skipping '%s' field.\n",
		 evname, sample_msg, output_field2str(field));

	return 0;
}

228 229 230 231 232 233 234 235
static int perf_evsel__check_stype(struct perf_evsel *evsel,
				   u64 sample_type, const char *sample_msg,
				   enum perf_output_field field)
{
	return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
					  false);
}

236 237 238 239
static int perf_evsel__check_attr(struct perf_evsel *evsel,
				  struct perf_session *session)
{
	struct perf_event_attr *attr = &evsel->attr;
240 241
	bool allow_user_set;

242 243 244
	if (perf_header__has_feat(&session->header, HEADER_STAT))
		return 0;

245 246
	allow_user_set = perf_header__has_feat(&session->header,
					       HEADER_AUXTRACE);
247

248 249 250 251
	if (PRINT_FIELD(TRACE) &&
		!perf_session__has_traces(session, "record -R"))
		return -EINVAL;

252
	if (PRINT_FIELD(IP)) {
253 254
		if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
					    PERF_OUTPUT_IP))
255 256
			return -EINVAL;
	}
257 258

	if (PRINT_FIELD(ADDR) &&
259 260
		perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
					   PERF_OUTPUT_ADDR, allow_user_set))
261 262
		return -EINVAL;

263 264 265 266 267 268 269 270 271 272
	if (PRINT_FIELD(DATA_SRC) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
					PERF_OUTPUT_DATA_SRC))
		return -EINVAL;

	if (PRINT_FIELD(WEIGHT) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
					PERF_OUTPUT_WEIGHT))
		return -EINVAL;

273 274 275 276
	if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
		pr_err("Display of symbols requested but neither sample IP nor "
			   "sample address\nis selected. Hence, no addresses to convert "
		       "to symbols.\n");
277 278
		return -EINVAL;
	}
279 280 281 282 283
	if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
		pr_err("Display of offsets requested but symbol is not"
		       "selected.\n");
		return -EINVAL;
	}
284 285 286 287
	if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
		pr_err("Display of DSO requested but neither sample IP nor "
			   "sample address\nis selected. Hence, no addresses to convert "
		       "to DSO.\n");
288 289
		return -EINVAL;
	}
290 291 292 293 294
	if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
		pr_err("Display of source line number requested but sample IP is not\n"
		       "selected. Hence, no address to lookup the source line number.\n");
		return -EINVAL;
	}
295 296

	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
297 298
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
					PERF_OUTPUT_TID|PERF_OUTPUT_PID))
299 300 301
		return -EINVAL;

	if (PRINT_FIELD(TIME) &&
302 303
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
					PERF_OUTPUT_TIME))
304 305 306
		return -EINVAL;

	if (PRINT_FIELD(CPU) &&
307 308
		perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
					   PERF_OUTPUT_CPU, allow_user_set))
309
		return -EINVAL;
310

J
Jiri Olsa 已提交
311 312 313 314 315
	if (PRINT_FIELD(PERIOD) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD",
					PERF_OUTPUT_PERIOD))
		return -EINVAL;

316 317 318 319 320
	if (PRINT_FIELD(IREGS) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
					PERF_OUTPUT_IREGS))
		return -EINVAL;

321 322 323
	return 0;
}

324 325 326 327 328 329
static void set_print_ip_opts(struct perf_event_attr *attr)
{
	unsigned int type = attr->type;

	output[type].print_ip_opts = 0;
	if (PRINT_FIELD(IP))
330
		output[type].print_ip_opts |= EVSEL__PRINT_IP;
331 332

	if (PRINT_FIELD(SYM))
333
		output[type].print_ip_opts |= EVSEL__PRINT_SYM;
334 335

	if (PRINT_FIELD(DSO))
336
		output[type].print_ip_opts |= EVSEL__PRINT_DSO;
337 338

	if (PRINT_FIELD(SYMOFFSET))
339
		output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
340 341

	if (PRINT_FIELD(SRCLINE))
342
		output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
343 344
}

345 346 347 348 349 350
/*
 * verify all user requested events exist and the samples
 * have the expected data
 */
static int perf_session__check_output_opt(struct perf_session *session)
{
351
	unsigned int j;
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
	struct perf_evsel *evsel;

	for (j = 0; j < PERF_TYPE_MAX; ++j) {
		evsel = perf_session__find_first_evtype(session, j);

		/*
		 * even if fields is set to 0 (ie., show nothing) event must
		 * exist if user explicitly includes it on the command line
		 */
		if (!evsel && output[j].user_set && !output[j].wildcard_set) {
			pr_err("%s events do not exist. "
			       "Remove corresponding -f option to proceed.\n",
			       event_type(j));
			return -1;
		}

		if (evsel && output[j].fields &&
			perf_evsel__check_attr(evsel, session))
			return -1;
371 372 373 374

		if (evsel == NULL)
			continue;

375
		set_print_ip_opts(&evsel->attr);
376 377
	}

378 379
	if (!no_callchain) {
		bool use_callchain = false;
380
		bool not_pipe = false;
381

382
		evlist__for_each_entry(session->evlist, evsel) {
383
			not_pipe = true;
384 385 386 387 388
			if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) {
				use_callchain = true;
				break;
			}
		}
389
		if (not_pipe && !use_callchain)
390 391 392
			symbol_conf.use_callchain = false;
	}

393 394 395 396 397 398 399 400 401 402
	/*
	 * set default for tracepoints to print symbols only
	 * if callchains are present
	 */
	if (symbol_conf.use_callchain &&
	    !output[PERF_TYPE_TRACEPOINT].user_set) {
		struct perf_event_attr *attr;

		j = PERF_TYPE_TRACEPOINT;

403
		evlist__for_each_entry(session->evlist, evsel) {
404 405 406 407
			if (evsel->attr.type != j)
				continue;

			attr = &evsel->attr;
408

409 410 411 412 413 414 415
			if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
				output[j].fields |= PERF_OUTPUT_IP;
				output[j].fields |= PERF_OUTPUT_SYM;
				output[j].fields |= PERF_OUTPUT_DSO;
				set_print_ip_opts(attr);
				goto out;
			}
416 417 418 419
		}
	}

out:
420 421
	return 0;
}
422

423
static void print_sample_iregs(struct perf_sample *sample,
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
			  struct perf_event_attr *attr)
{
	struct regs_dump *regs = &sample->intr_regs;
	uint64_t mask = attr->sample_regs_intr;
	unsigned i = 0, r;

	if (!regs)
		return;

	for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
		u64 val = regs->regs[i++];
		printf("%5s:0x%"PRIx64" ", perf_reg_name(r), val);
	}
}

439
static void print_sample_start(struct perf_sample *sample,
440
			       struct thread *thread,
441
			       struct perf_evsel *evsel)
442
{
443
	struct perf_event_attr *attr = &evsel->attr;
444
	unsigned long secs;
445 446 447 448
	unsigned long long nsecs;

	if (PRINT_FIELD(COMM)) {
		if (latency_format)
449
			printf("%8.8s ", thread__comm_str(thread));
450
		else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
451
			printf("%s ", thread__comm_str(thread));
452
		else
453
			printf("%16s ", thread__comm_str(thread));
454
	}
455

456 457 458 459 460 461 462 463 464 465 466 467 468
	if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
		printf("%5d/%-5d ", sample->pid, sample->tid);
	else if (PRINT_FIELD(PID))
		printf("%5d ", sample->pid);
	else if (PRINT_FIELD(TID))
		printf("%5d ", sample->tid);

	if (PRINT_FIELD(CPU)) {
		if (latency_format)
			printf("%3d ", sample->cpu);
		else
			printf("[%03d] ", sample->cpu);
	}
469

470 471
	if (PRINT_FIELD(TIME)) {
		nsecs = sample->time;
472 473
		secs = nsecs / NSEC_PER_SEC;
		nsecs -= secs * NSEC_PER_SEC;
474

475 476
		if (nanosecs)
			printf("%5lu.%09llu: ", secs, nsecs);
477 478 479 480 481
		else {
			char sample_time[32];
			timestamp__scnprintf_usec(sample->time, sample_time, sizeof(sample_time));
			printf("%12s: ", sample_time);
		}
482
	}
483 484
}

485 486 487 488 489 490 491 492 493
static inline char
mispred_str(struct branch_entry *br)
{
	if (!(br->flags.mispred  || br->flags.predicted))
		return '-';

	return br->flags.predicted ? 'P' : 'M';
}

494
static void print_sample_brstack(struct perf_sample *sample)
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
{
	struct branch_stack *br = sample->branch_stack;
	u64 i;

	if (!(br && br->nr))
		return;

	for (i = 0; i < br->nr; i++) {
		printf(" 0x%"PRIx64"/0x%"PRIx64"/%c/%c/%c/%d ",
			br->entries[i].from,
			br->entries[i].to,
			mispred_str( br->entries + i),
			br->entries[i].flags.in_tx? 'X' : '-',
			br->entries[i].flags.abort? 'A' : '-',
			br->entries[i].flags.cycles);
	}
}

513 514
static void print_sample_brstacksym(struct perf_sample *sample,
				    struct thread *thread)
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
{
	struct branch_stack *br = sample->branch_stack;
	struct addr_location alf, alt;
	u64 i, from, to;

	if (!(br && br->nr))
		return;

	for (i = 0; i < br->nr; i++) {

		memset(&alf, 0, sizeof(alf));
		memset(&alt, 0, sizeof(alt));
		from = br->entries[i].from;
		to   = br->entries[i].to;

530
		thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, from, &alf);
531
		if (alf.map)
532
			alf.sym = map__find_symbol(alf.map, alf.addr);
533

534
		thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt);
535
		if (alt.map)
536
			alt.sym = map__find_symbol(alt.map, alt.addr);
537 538 539 540 541 542 543 544 545 546 547 548 549

		symbol__fprintf_symname_offs(alf.sym, &alf, stdout);
		putchar('/');
		symbol__fprintf_symname_offs(alt.sym, &alt, stdout);
		printf("/%c/%c/%c/%d ",
			mispred_str( br->entries + i),
			br->entries[i].flags.in_tx? 'X' : '-',
			br->entries[i].flags.abort? 'A' : '-',
			br->entries[i].flags.cycles);
	}
}


550
static void print_sample_addr(struct perf_sample *sample,
551 552 553 554 555 556 557 558 559 560
			  struct thread *thread,
			  struct perf_event_attr *attr)
{
	struct addr_location al;

	printf("%16" PRIx64, sample->addr);

	if (!sample_addr_correlates_sym(attr))
		return;

561
	thread__resolve(thread, &al, sample);
562 563

	if (PRINT_FIELD(SYM)) {
564
		printf(" ");
565 566 567 568
		if (PRINT_FIELD(SYMOFFSET))
			symbol__fprintf_symname_offs(al.sym, &al, stdout);
		else
			symbol__fprintf_symname(al.sym, stdout);
569 570 571
	}

	if (PRINT_FIELD(DSO)) {
572 573 574
		printf(" (");
		map__fprintf_dsoname(al.map, stdout);
		printf(")");
575 576 577
	}
}

578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
static void print_sample_callindent(struct perf_sample *sample,
				    struct perf_evsel *evsel,
				    struct thread *thread,
				    struct addr_location *al)
{
	struct perf_event_attr *attr = &evsel->attr;
	size_t depth = thread_stack__depth(thread);
	struct addr_location addr_al;
	const char *name = NULL;
	static int spacing;
	int len = 0;
	u64 ip = 0;

	/*
	 * The 'return' has already been popped off the stack so the depth has
	 * to be adjusted to match the 'call'.
	 */
	if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
		depth += 1;

	if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
		if (sample_addr_correlates_sym(attr)) {
			thread__resolve(thread, &addr_al, sample);
			if (addr_al.sym)
				name = addr_al.sym->name;
			else
				ip = sample->addr;
		} else {
			ip = sample->addr;
		}
	} else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
		if (al->sym)
			name = al->sym->name;
		else
			ip = sample->ip;
	}

	if (name)
		len = printf("%*s%s", (int)depth * 4, "", name);
	else if (ip)
		len = printf("%*s%16" PRIx64, (int)depth * 4, "", ip);

	if (len < 0)
		return;

	/*
	 * Try to keep the output length from changing frequently so that the
	 * output lines up more nicely.
	 */
	if (len > spacing || (len && len < spacing - 52))
		spacing = round_up(len + 4, 32);

	if (len < spacing)
		printf("%*s", spacing - len, "");
}

A
Andi Kleen 已提交
634 635 636 637 638 639 640 641 642 643 644 645 646 647
static void print_insn(struct perf_sample *sample,
		       struct perf_event_attr *attr)
{
	if (PRINT_FIELD(INSNLEN))
		printf(" ilen: %d", sample->insn_len);
	if (PRINT_FIELD(INSN)) {
		int i;

		printf(" insn:");
		for (i = 0; i < sample->insn_len; i++)
			printf(" %02x", (unsigned char)sample->insn[i]);
	}
}

648
static void print_sample_bts(struct perf_sample *sample,
649
			     struct perf_evsel *evsel,
650 651
			     struct thread *thread,
			     struct addr_location *al)
652 653
{
	struct perf_event_attr *attr = &evsel->attr;
654
	bool print_srcline_last = false;
655

656 657 658
	if (PRINT_FIELD(CALLINDENT))
		print_sample_callindent(sample, evsel, thread, al);

659 660
	/* print branch_from information */
	if (PRINT_FIELD(IP)) {
661
		unsigned int print_opts = output[attr->type].print_ip_opts;
662
		struct callchain_cursor *cursor = NULL;
663

664
		if (symbol_conf.use_callchain && sample->callchain &&
665
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
666
					      sample, NULL, NULL, scripting_max_stack) == 0)
667
			cursor = &callchain_cursor;
668 669 670

		if (cursor == NULL) {
			putchar(' ');
671
			if (print_opts & EVSEL__PRINT_SRCLINE) {
672
				print_srcline_last = true;
673
				print_opts &= ~EVSEL__PRINT_SRCLINE;
674
			}
675 676 677 678
		} else
			putchar('\n');

		sample__fprintf_sym(sample, al, 0, print_opts, cursor, stdout);
679 680 681
	}

	/* print branch_to information */
682 683
	if (PRINT_FIELD(ADDR) ||
	    ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
684 685
	     !output[attr->type].user_set)) {
		printf(" => ");
686
		print_sample_addr(sample, thread, attr);
687
	}
688

689 690 691
	if (print_srcline_last)
		map__fprintf_srcline(al->map, al->addr, "\n  ", stdout);

A
Andi Kleen 已提交
692 693
	print_insn(sample, attr);

694 695 696
	printf("\n");
}

697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
static struct {
	u32 flags;
	const char *name;
} sample_flags[] = {
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
	{PERF_IP_FLAG_BRANCH, "jmp"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC |	PERF_IP_FLAG_INTERRUPT, "hw int"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
	{0, NULL}
};

717 718 719 720
static void print_sample_flags(u32 flags)
{
	const char *chars = PERF_IP_FLAG_CHARS;
	const int n = strlen(PERF_IP_FLAG_CHARS);
721 722
	bool in_tx = flags & PERF_IP_FLAG_IN_TX;
	const char *name = NULL;
723 724 725
	char str[33];
	int i, pos = 0;

726 727 728 729 730 731 732
	for (i = 0; sample_flags[i].name ; i++) {
		if (sample_flags[i].flags == (flags & ~PERF_IP_FLAG_IN_TX)) {
			name = sample_flags[i].name;
			break;
		}
	}

733 734 735 736 737 738 739 740 741
	for (i = 0; i < n; i++, flags >>= 1) {
		if (flags & 1)
			str[pos++] = chars[i];
	}
	for (; i < 32; i++, flags >>= 1) {
		if (flags & 1)
			str[pos++] = '?';
	}
	str[pos] = 0;
742 743 744 745 746

	if (name)
		printf("  %-7s%4s ", name, in_tx ? "(x)" : "");
	else
		printf("  %-11s ", str);
747 748
}

749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
struct printer_data {
	int line_no;
	bool hit_nul;
	bool is_printable;
};

static void
print_sample_bpf_output_printer(enum binary_printer_ops op,
				unsigned int val,
				void *extra)
{
	unsigned char ch = (unsigned char)val;
	struct printer_data *printer_data = extra;

	switch (op) {
	case BINARY_PRINT_DATA_BEGIN:
		printf("\n");
		break;
	case BINARY_PRINT_LINE_BEGIN:
		printf("%17s", !printer_data->line_no ? "BPF output:" :
						        "           ");
		break;
	case BINARY_PRINT_ADDR:
		printf(" %04x:", val);
		break;
	case BINARY_PRINT_NUM_DATA:
		printf(" %02x", val);
		break;
	case BINARY_PRINT_NUM_PAD:
		printf("   ");
		break;
	case BINARY_PRINT_SEP:
		printf("  ");
		break;
	case BINARY_PRINT_CHAR_DATA:
		if (printer_data->hit_nul && ch)
			printer_data->is_printable = false;

		if (!isprint(ch)) {
			printf("%c", '.');

			if (!printer_data->is_printable)
				break;

			if (ch == '\0')
				printer_data->hit_nul = true;
			else
				printer_data->is_printable = false;
		} else {
			printf("%c", ch);
		}
		break;
	case BINARY_PRINT_CHAR_PAD:
		printf(" ");
		break;
	case BINARY_PRINT_LINE_END:
		printf("\n");
		printer_data->line_no++;
		break;
	case BINARY_PRINT_DATA_END:
	default:
		break;
	}
}

static void print_sample_bpf_output(struct perf_sample *sample)
{
	unsigned int nr_bytes = sample->raw_size;
	struct printer_data printer_data = {0, false, true};

	print_binary(sample->raw_data, nr_bytes, 8,
		     print_sample_bpf_output_printer, &printer_data);

	if (printer_data.is_printable && printer_data.hit_nul)
		printf("%17s \"%s\"\n", "BPF string:",
		       (char *)(sample->raw_data));
}

827 828 829 830 831 832
struct perf_script {
	struct perf_tool	tool;
	struct perf_session	*session;
	bool			show_task_events;
	bool			show_mmap_events;
	bool			show_switch_events;
833 834 835
	bool			allocated;
	struct cpu_map		*cpus;
	struct thread_map	*threads;
836
	int			name_width;
837 838
	const char              *time_str;
	struct perf_time_interval ptime;
839 840
};

841 842 843 844 845
static int perf_evlist__max_name_len(struct perf_evlist *evlist)
{
	struct perf_evsel *evsel;
	int max = 0;

846
	evlist__for_each_entry(evlist, evsel) {
847 848 849 850 851 852 853 854
		int len = strlen(perf_evsel__name(evsel));

		max = MAX(len, max);
	}

	return max;
}

J
Jiri Olsa 已提交
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
static size_t data_src__printf(u64 data_src)
{
	struct mem_info mi = { .data_src.val = data_src };
	char decode[100];
	char out[100];
	static int maxlen;
	int len;

	perf_script__meminfo_scnprintf(decode, 100, &mi);

	len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
	if (maxlen < len)
		maxlen = len;

	return printf("%-*s", maxlen, out);
}

872
static void process_event(struct perf_script *script,
873 874
			  struct perf_sample *sample, struct perf_evsel *evsel,
			  struct addr_location *al)
875
{
876
	struct thread *thread = al->thread;
877
	struct perf_event_attr *attr = &evsel->attr;
878

879
	if (output[attr->type].fields == 0)
880 881
		return;

882
	print_sample_start(sample, thread, evsel);
883

J
Jiri Olsa 已提交
884 885 886
	if (PRINT_FIELD(PERIOD))
		printf("%10" PRIu64 " ", sample->period);

887 888
	if (PRINT_FIELD(EVNAME)) {
		const char *evname = perf_evsel__name(evsel);
889 890 891 892 893 894

		if (!script->name_width)
			script->name_width = perf_evlist__max_name_len(script->session->evlist);

		printf("%*s: ", script->name_width,
		       evname ? evname : "[unknown]");
895 896
	}

897 898 899
	if (print_flags)
		print_sample_flags(sample->flags);

900
	if (is_bts_event(attr)) {
901
		print_sample_bts(sample, evsel, thread, al);
902 903 904
		return;
	}

905
	if (PRINT_FIELD(TRACE))
906 907
		event_format__print(evsel->tp_format, sample->cpu,
				    sample->raw_data, sample->raw_size);
908
	if (PRINT_FIELD(ADDR))
909
		print_sample_addr(sample, thread, attr);
910

911
	if (PRINT_FIELD(DATA_SRC))
J
Jiri Olsa 已提交
912
		data_src__printf(sample->data_src);
913 914 915 916

	if (PRINT_FIELD(WEIGHT))
		printf("%16" PRIu64, sample->weight);

917
	if (PRINT_FIELD(IP)) {
918
		struct callchain_cursor *cursor = NULL;
919

920
		if (symbol_conf.use_callchain && sample->callchain &&
921
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
922
					      sample, NULL, NULL, scripting_max_stack) == 0)
923
			cursor = &callchain_cursor;
924

925 926
		putchar(cursor ? '\n' : ' ');
		sample__fprintf_sym(sample, al, 0, output[attr->type].print_ip_opts, cursor, stdout);
927 928
	}

929
	if (PRINT_FIELD(IREGS))
930
		print_sample_iregs(sample, attr);
931

932
	if (PRINT_FIELD(BRSTACK))
933
		print_sample_brstack(sample);
934
	else if (PRINT_FIELD(BRSTACKSYM))
935
		print_sample_brstacksym(sample, thread);
936

937 938
	if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
		print_sample_bpf_output(sample);
A
Andi Kleen 已提交
939
	print_insn(sample, attr);
940
	printf("\n");
941 942
}

T
Tom Zanussi 已提交
943 944
static struct scripting_ops	*scripting_ops;

945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
static void __process_stat(struct perf_evsel *counter, u64 tstamp)
{
	int nthreads = thread_map__nr(counter->threads);
	int ncpus = perf_evsel__nr_cpus(counter);
	int cpu, thread;
	static int header_printed;

	if (counter->system_wide)
		nthreads = 1;

	if (!header_printed) {
		printf("%3s %8s %15s %15s %15s %15s %s\n",
		       "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
		header_printed = 1;
	}

	for (thread = 0; thread < nthreads; thread++) {
		for (cpu = 0; cpu < ncpus; cpu++) {
			struct perf_counts_values *counts;

			counts = perf_counts(counter->counts, cpu, thread);

			printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
				counter->cpus->map[cpu],
				thread_map__pid(counter->threads, thread),
				counts->val,
				counts->ena,
				counts->run,
				tstamp,
				perf_evsel__name(counter));
		}
	}
}

979 980 981 982
static void process_stat(struct perf_evsel *counter, u64 tstamp)
{
	if (scripting_ops && scripting_ops->process_stat)
		scripting_ops->process_stat(&stat_config, counter, tstamp);
983 984
	else
		__process_stat(counter, tstamp);
985 986 987 988 989 990 991 992
}

static void process_stat_interval(u64 tstamp)
{
	if (scripting_ops && scripting_ops->process_stat_interval)
		scripting_ops->process_stat_interval(tstamp);
}

T
Tom Zanussi 已提交
993 994
static void setup_scripting(void)
{
995
	setup_perl_scripting();
996
	setup_python_scripting();
T
Tom Zanussi 已提交
997 998
}

999 1000
static int flush_scripting(void)
{
1001
	return scripting_ops ? scripting_ops->flush_script() : 0;
1002 1003
}

T
Tom Zanussi 已提交
1004 1005
static int cleanup_scripting(void)
{
1006
	pr_debug("\nperf script stopped\n");
1007

1008
	return scripting_ops ? scripting_ops->stop_script() : 0;
T
Tom Zanussi 已提交
1009 1010
}

1011
static int process_sample_event(struct perf_tool *tool,
1012
				union perf_event *event,
1013
				struct perf_sample *sample,
1014
				struct perf_evsel *evsel,
1015
				struct machine *machine)
F
Frederic Weisbecker 已提交
1016
{
1017
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
1018
	struct addr_location al;
F
Frederic Weisbecker 已提交
1019

1020 1021 1022
	if (perf_time__skip_sample(&scr->ptime, sample->time))
		return 0;

1023 1024 1025 1026 1027 1028
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
1029
		}
1030 1031
		last_timestamp = sample->time;
		return 0;
F
Frederic Weisbecker 已提交
1032
	}
1033

1034
	if (machine__resolve(machine, &al, sample) < 0) {
1035 1036 1037 1038 1039 1040
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
		return -1;
	}

	if (al.filtered)
1041
		goto out_put;
1042

1043
	if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
1044
		goto out_put;
1045

1046 1047 1048
	if (scripting_ops)
		scripting_ops->process_event(event, sample, evsel, &al);
	else
1049
		process_event(scr, sample, evsel, &al);
1050

1051 1052
out_put:
	addr_location__put(&al);
F
Frederic Weisbecker 已提交
1053 1054 1055
	return 0;
}

1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
static int process_attr(struct perf_tool *tool, union perf_event *event,
			struct perf_evlist **pevlist)
{
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
	struct perf_evlist *evlist;
	struct perf_evsel *evsel, *pos;
	int err;

	err = perf_event__process_attr(tool, event, pevlist);
	if (err)
		return err;

	evlist = *pevlist;
	evsel = perf_evlist__last(*pevlist);

	if (evsel->attr.type >= PERF_TYPE_MAX)
		return 0;

1074
	evlist__for_each_entry(evlist, pos) {
1075 1076 1077 1078 1079 1080
		if (pos->attr.type == evsel->attr.type && pos != evsel)
			return 0;
	}

	set_print_ip_opts(&evsel->attr);

1081 1082 1083 1084
	if (evsel->attr.sample_type)
		err = perf_evsel__check_attr(evsel, scr->session);

	return err;
1085 1086
}

1087 1088 1089 1090 1091 1092 1093 1094
static int process_comm_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
1095
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
	int ret = -1;

	thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
	if (thread == NULL) {
		pr_debug("problem processing COMM event, skipping it.\n");
		return -1;
	}

	if (perf_event__process_comm(tool, event, sample, machine) < 0)
		goto out;

	if (!evsel->attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = 0;
		sample->tid = event->comm.tid;
		sample->pid = event->comm.pid;
	}
	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);
	ret = 0;
out:
1117
	thread__put(thread);
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
	return ret;
}

static int process_fork_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
1129
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147

	if (perf_event__process_fork(tool, event, sample, machine) < 0)
		return -1;

	thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
	if (thread == NULL) {
		pr_debug("problem processing FORK event, skipping it.\n");
		return -1;
	}

	if (!evsel->attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = event->fork.time;
		sample->tid = event->fork.tid;
		sample->pid = event->fork.pid;
	}
	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);
1148
	thread__put(thread);
1149 1150 1151 1152 1153 1154 1155 1156

	return 0;
}
static int process_exit_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
1157
	int err = 0;
1158 1159 1160
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
1161
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171

	thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
	if (thread == NULL) {
		pr_debug("problem processing EXIT event, skipping it.\n");
		return -1;
	}

	if (!evsel->attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = 0;
1172 1173
		sample->tid = event->fork.tid;
		sample->pid = event->fork.pid;
1174 1175 1176 1177 1178
	}
	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);

	if (perf_event__process_exit(tool, event, sample, machine) < 0)
1179
		err = -1;
1180

1181 1182
	thread__put(thread);
	return err;
1183 1184
}

1185 1186 1187 1188 1189 1190 1191 1192
static int process_mmap_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
1193
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211

	if (perf_event__process_mmap(tool, event, sample, machine) < 0)
		return -1;

	thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
	if (thread == NULL) {
		pr_debug("problem processing MMAP event, skipping it.\n");
		return -1;
	}

	if (!evsel->attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = 0;
		sample->tid = event->mmap.tid;
		sample->pid = event->mmap.pid;
	}
	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);
1212
	thread__put(thread);
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
	return 0;
}

static int process_mmap2_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
1224
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242

	if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
		return -1;

	thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
	if (thread == NULL) {
		pr_debug("problem processing MMAP2 event, skipping it.\n");
		return -1;
	}

	if (!evsel->attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = 0;
		sample->tid = event->mmap2.tid;
		sample->pid = event->mmap2.pid;
	}
	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);
1243
	thread__put(thread);
1244 1245 1246
	return 0;
}

1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
static int process_switch_event(struct perf_tool *tool,
				union perf_event *event,
				struct perf_sample *sample,
				struct machine *machine)
{
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);

	if (perf_event__process_switch(tool, event, sample, machine) < 0)
		return -1;

	thread = machine__findnew_thread(machine, sample->pid,
					 sample->tid);
	if (thread == NULL) {
		pr_debug("problem processing SWITCH event, skipping it.\n");
		return -1;
	}

	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);
	thread__put(thread);
	return 0;
}

1273
static void sig_handler(int sig __maybe_unused)
1274 1275 1276 1277
{
	session_done = 1;
}

1278
static int __cmd_script(struct perf_script *script)
F
Frederic Weisbecker 已提交
1279
{
1280 1281
	int ret;

1282 1283
	signal(SIGINT, sig_handler);

1284 1285 1286 1287 1288 1289
	/* override event processing functions */
	if (script->show_task_events) {
		script->tool.comm = process_comm_event;
		script->tool.fork = process_fork_event;
		script->tool.exit = process_exit_event;
	}
1290 1291 1292 1293
	if (script->show_mmap_events) {
		script->tool.mmap = process_mmap_event;
		script->tool.mmap2 = process_mmap2_event;
	}
1294 1295
	if (script->show_switch_events)
		script->tool.context_switch = process_switch_event;
1296

1297
	ret = perf_session__process_events(script->session);
1298

1299
	if (debug_mode)
1300
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
1301 1302

	return ret;
F
Frederic Weisbecker 已提交
1303 1304
}

T
Tom Zanussi 已提交
1305 1306 1307 1308 1309 1310
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
	char			spec[0];
};

1311
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348

static struct script_spec *script_spec__new(const char *spec,
					    struct scripting_ops *ops)
{
	struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);

	if (s != NULL) {
		strcpy(s->spec, spec);
		s->ops = ops;
	}

	return s;
}

static void script_spec__add(struct script_spec *s)
{
	list_add_tail(&s->node, &script_specs);
}

static struct script_spec *script_spec__find(const char *spec)
{
	struct script_spec *s;

	list_for_each_entry(s, &script_specs, node)
		if (strcasecmp(s->spec, spec) == 0)
			return s;
	return NULL;
}

int script_spec_register(const char *spec, struct scripting_ops *ops)
{
	struct script_spec *s;

	s = script_spec__find(spec);
	if (s)
		return -1;

1349
	s = script_spec__new(spec, ops);
T
Tom Zanussi 已提交
1350 1351
	if (!s)
		return -1;
1352 1353
	else
		script_spec__add(s);
T
Tom Zanussi 已提交
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372

	return 0;
}

static struct scripting_ops *script_spec__lookup(const char *spec)
{
	struct script_spec *s = script_spec__find(spec);
	if (!s)
		return NULL;

	return s->ops;
}

static void list_available_languages(void)
{
	struct script_spec *s;

	fprintf(stderr, "\n");
	fprintf(stderr, "Scripting language extensions (used in "
1373
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
1374 1375 1376 1377 1378 1379 1380

	list_for_each_entry(s, &script_specs, node)
		fprintf(stderr, "  %-42s [%s]\n", s->spec, s->ops->name);

	fprintf(stderr, "\n");
}

1381 1382
static int parse_scriptname(const struct option *opt __maybe_unused,
			    const char *str, int unset __maybe_unused)
T
Tom Zanussi 已提交
1383 1384 1385 1386 1387
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

1388
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
1389
		list_available_languages();
1390
		exit(0);
T
Tom Zanussi 已提交
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
	}

	script = strchr(str, ':');
	if (script) {
		len = script - str;
		if (len >= PATH_MAX) {
			fprintf(stderr, "invalid language specifier");
			return -1;
		}
		strncpy(spec, str, len);
		spec[len] = '\0';
		scripting_ops = script_spec__lookup(spec);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
			return -1;
		}
		script++;
	} else {
		script = str;
1410
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
		if (!ext) {
			fprintf(stderr, "invalid script extension");
			return -1;
		}
		scripting_ops = script_spec__lookup(++ext);
		if (!scripting_ops) {
			fprintf(stderr, "invalid script extension");
			return -1;
		}
	}

	script_name = strdup(script);

	return 0;
}

1427 1428
static int parse_output_fields(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused)
1429 1430
{
	char *tok;
1431
	int i, imax = ARRAY_SIZE(all_output_options);
1432
	int j;
1433 1434
	int rc = 0;
	char *str = strdup(arg);
1435
	int type = -1;
1436 1437 1438 1439

	if (!str)
		return -ENOMEM;

1440 1441 1442
	/* first word can state for which event type the user is specifying
	 * the fields. If no type exists, the specified fields apply to all
	 * event types found in the file minus the invalid fields for a type.
1443
	 */
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
	tok = strchr(str, ':');
	if (tok) {
		*tok = '\0';
		tok++;
		if (!strcmp(str, "hw"))
			type = PERF_TYPE_HARDWARE;
		else if (!strcmp(str, "sw"))
			type = PERF_TYPE_SOFTWARE;
		else if (!strcmp(str, "trace"))
			type = PERF_TYPE_TRACEPOINT;
1454 1455
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
1456 1457
		else if (!strcmp(str, "break"))
			type = PERF_TYPE_BREAKPOINT;
1458 1459
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
1460 1461
			rc = -EINVAL;
			goto out;
1462 1463 1464 1465 1466 1467 1468 1469
		}

		if (output[type].user_set)
			pr_warning("Overriding previous field request for %s events.\n",
				   event_type(type));

		output[type].fields = 0;
		output[type].user_set = true;
1470
		output[type].wildcard_set = false;
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486

	} else {
		tok = str;
		if (strlen(str) == 0) {
			fprintf(stderr,
				"Cannot set fields to 'none' for all event types.\n");
			rc = -EINVAL;
			goto out;
		}

		if (output_set_by_user())
			pr_warning("Overriding previous field request for all events.\n");

		for (j = 0; j < PERF_TYPE_MAX; ++j) {
			output[j].fields = 0;
			output[j].user_set = true;
1487
			output[j].wildcard_set = true;
1488
		}
1489 1490
	}

1491
	for (tok = strtok(tok, ","); tok; tok = strtok(NULL, ",")) {
1492
		for (i = 0; i < imax; ++i) {
1493
			if (strcmp(tok, all_output_options[i].str) == 0)
1494 1495
				break;
		}
1496 1497 1498 1499
		if (i == imax && strcmp(tok, "flags") == 0) {
			print_flags = true;
			continue;
		}
1500
		if (i == imax) {
1501
			fprintf(stderr, "Invalid field requested.\n");
1502
			rc = -EINVAL;
1503
			goto out;
1504 1505
		}

1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526
		if (type == -1) {
			/* add user option to all events types for
			 * which it is valid
			 */
			for (j = 0; j < PERF_TYPE_MAX; ++j) {
				if (output[j].invalid_fields & all_output_options[i].field) {
					pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
						   all_output_options[i].str, event_type(j));
				} else
					output[j].fields |= all_output_options[i].field;
			}
		} else {
			if (output[type].invalid_fields & all_output_options[i].field) {
				fprintf(stderr, "\'%s\' not valid for %s events.\n",
					 all_output_options[i].str, event_type(type));

				rc = -EINVAL;
				goto out;
			}
			output[type].fields |= all_output_options[i].field;
		}
1527 1528
	}

1529 1530 1531 1532 1533 1534
	if (type >= 0) {
		if (output[type].fields == 0) {
			pr_debug("No fields requested for %s type. "
				 "Events will not be displayed.\n", event_type(type));
		}
	}
1535

1536
out:
1537 1538 1539 1540
	free(str);
	return rc;
}

1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
/* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
static int is_directory(const char *base_path, const struct dirent *dent)
{
	char path[PATH_MAX];
	struct stat st;

	sprintf(path, "%s/%s", base_path, dent->d_name);
	if (stat(path, &st))
		return 0;

	return S_ISDIR(st.st_mode);
}

1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
#define for_each_lang(scripts_path, scripts_dir, lang_dirent)		\
	while ((lang_dirent = readdir(scripts_dir)) != NULL)		\
		if ((lang_dirent->d_type == DT_DIR ||			\
		     (lang_dirent->d_type == DT_UNKNOWN &&		\
		      is_directory(scripts_path, lang_dirent))) &&	\
		    (strcmp(lang_dirent->d_name, ".")) &&		\
		    (strcmp(lang_dirent->d_name, "..")))

#define for_each_script(lang_path, lang_dir, script_dirent)		\
	while ((script_dirent = readdir(lang_dir)) != NULL)		\
		if (script_dirent->d_type != DT_DIR &&			\
		    (script_dirent->d_type != DT_UNKNOWN ||		\
		     !is_directory(lang_path, script_dirent)))
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578


#define RECORD_SUFFIX			"-record"
#define REPORT_SUFFIX			"-report"

struct script_desc {
	struct list_head	node;
	char			*name;
	char			*half_liner;
	char			*args;
};

1579
static LIST_HEAD(script_descs);
1580 1581 1582 1583 1584

static struct script_desc *script_desc__new(const char *name)
{
	struct script_desc *s = zalloc(sizeof(*s));

1585
	if (s != NULL && name)
1586 1587 1588 1589 1590 1591 1592
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
1593 1594 1595
	zfree(&s->name);
	zfree(&s->half_liner);
	zfree(&s->args);
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
	free(s);
}

static void script_desc__add(struct script_desc *s)
{
	list_add_tail(&s->node, &script_descs);
}

static struct script_desc *script_desc__find(const char *name)
{
	struct script_desc *s;

	list_for_each_entry(s, &script_descs, node)
		if (strcasecmp(s->name, name) == 0)
			return s;
	return NULL;
}

static struct script_desc *script_desc__findnew(const char *name)
{
	struct script_desc *s = script_desc__find(name);

	if (s)
		return s;

	s = script_desc__new(name);
	if (!s)
		goto out_delete_desc;

	script_desc__add(s);

	return s;

out_delete_desc:
	script_desc__delete(s);

	return NULL;
}

1635
static const char *ends_with(const char *str, const char *suffix)
1636 1637
{
	size_t suffix_len = strlen(suffix);
1638
	const char *p = str;
1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689

	if (strlen(str) > suffix_len) {
		p = str + strlen(str) - suffix_len;
		if (!strncmp(p, suffix, suffix_len))
			return p;
	}

	return NULL;
}

static int read_script_info(struct script_desc *desc, const char *filename)
{
	char line[BUFSIZ], *p;
	FILE *fp;

	fp = fopen(filename, "r");
	if (!fp)
		return -1;

	while (fgets(line, sizeof(line), fp)) {
		p = ltrim(line);
		if (strlen(p) == 0)
			continue;
		if (*p != '#')
			continue;
		p++;
		if (strlen(p) && *p == '!')
			continue;

		p = ltrim(p);
		if (strlen(p) && p[strlen(p) - 1] == '\n')
			p[strlen(p) - 1] = '\0';

		if (!strncmp(p, "description:", strlen("description:"))) {
			p += strlen("description:");
			desc->half_liner = strdup(ltrim(p));
			continue;
		}

		if (!strncmp(p, "args:", strlen("args:"))) {
			p += strlen("args:");
			desc->args = strdup(ltrim(p));
			continue;
		}
	}

	fclose(fp);

	return 0;
}

1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707
static char *get_script_root(struct dirent *script_dirent, const char *suffix)
{
	char *script_root, *str;

	script_root = strdup(script_dirent->d_name);
	if (!script_root)
		return NULL;

	str = (char *)ends_with(script_root, suffix);
	if (!str) {
		free(script_root);
		return NULL;
	}

	*str = '\0';
	return script_root;
}

1708 1709 1710
static int list_available_scripts(const struct option *opt __maybe_unused,
				  const char *s __maybe_unused,
				  int unset __maybe_unused)
1711
{
1712
	struct dirent *script_dirent, *lang_dirent;
1713 1714 1715 1716 1717 1718 1719 1720
	char scripts_path[MAXPATHLEN];
	DIR *scripts_dir, *lang_dir;
	char script_path[MAXPATHLEN];
	char lang_path[MAXPATHLEN];
	struct script_desc *desc;
	char first_half[BUFSIZ];
	char *script_root;

1721
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1722 1723

	scripts_dir = opendir(scripts_path);
1724 1725 1726 1727 1728 1729 1730
	if (!scripts_dir) {
		fprintf(stdout,
			"open(%s) failed.\n"
			"Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
			scripts_path);
		exit(-1);
	}
1731

1732
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
1733
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1734
			 lang_dirent->d_name);
1735 1736 1737 1738
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1739 1740
		for_each_script(lang_path, lang_dir, script_dirent) {
			script_root = get_script_root(script_dirent, REPORT_SUFFIX);
1741
			if (script_root) {
1742 1743
				desc = script_desc__findnew(script_root);
				snprintf(script_path, MAXPATHLEN, "%s/%s",
1744
					 lang_path, script_dirent->d_name);
1745
				read_script_info(desc, script_path);
1746
				free(script_root);
1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761
			}
		}
	}

	fprintf(stdout, "List of available trace scripts:\n");
	list_for_each_entry(desc, &script_descs, node) {
		sprintf(first_half, "%s %s", desc->name,
			desc->args ? desc->args : "");
		fprintf(stdout, "  %-36s %s\n", first_half,
			desc->half_liner ? desc->half_liner : "");
	}

	exit(0);
}

1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804
/*
 * Some scripts specify the required events in their "xxx-record" file,
 * this function will check if the events in perf.data match those
 * mentioned in the "xxx-record".
 *
 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
 * which is covered well now. And new parsing code should be added to
 * cover the future complexing formats like event groups etc.
 */
static int check_ev_match(char *dir_name, char *scriptname,
			struct perf_session *session)
{
	char filename[MAXPATHLEN], evname[128];
	char line[BUFSIZ], *p;
	struct perf_evsel *pos;
	int match, len;
	FILE *fp;

	sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);

	fp = fopen(filename, "r");
	if (!fp)
		return -1;

	while (fgets(line, sizeof(line), fp)) {
		p = ltrim(line);
		if (*p == '#')
			continue;

		while (strlen(p)) {
			p = strstr(p, "-e");
			if (!p)
				break;

			p += 2;
			p = ltrim(p);
			len = strcspn(p, " \t");
			if (!len)
				break;

			snprintf(evname, len + 1, "%s", p);

			match = 0;
1805
			evlist__for_each_entry(session->evlist, pos) {
1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822
				if (!strcmp(perf_evsel__name(pos), evname)) {
					match = 1;
					break;
				}
			}

			if (!match) {
				fclose(fp);
				return -1;
			}
		}
	}

	fclose(fp);
	return 0;
}

1823 1824 1825 1826 1827 1828 1829 1830 1831
/*
 * Return -1 if none is found, otherwise the actual scripts number.
 *
 * Currently the only user of this function is the script browser, which
 * will list all statically runnable scripts, select one, execute it and
 * show the output in a perf browser.
 */
int find_scripts(char **scripts_array, char **scripts_path_array)
{
1832
	struct dirent *script_dirent, *lang_dirent;
1833
	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1834
	DIR *scripts_dir, *lang_dir;
1835
	struct perf_session *session;
1836 1837 1838 1839
	struct perf_data_file file = {
		.path = input_name,
		.mode = PERF_DATA_MODE_READ,
	};
1840 1841 1842
	char *temp;
	int i = 0;

1843
	session = perf_session__new(&file, false, NULL);
1844 1845 1846
	if (!session)
		return -1;

1847
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1848 1849

	scripts_dir = opendir(scripts_path);
1850 1851
	if (!scripts_dir) {
		perf_session__delete(session);
1852
		return -1;
1853
	}
1854

1855
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
1856
		snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1857
			 lang_dirent->d_name);
1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870
#ifdef NO_LIBPERL
		if (strstr(lang_path, "perl"))
			continue;
#endif
#ifdef NO_LIBPYTHON
		if (strstr(lang_path, "python"))
			continue;
#endif

		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1871
		for_each_script(lang_path, lang_dir, script_dirent) {
1872
			/* Skip those real time scripts: xxxtop.p[yl] */
1873
			if (strstr(script_dirent->d_name, "top."))
1874 1875
				continue;
			sprintf(scripts_path_array[i], "%s/%s", lang_path,
1876 1877
				script_dirent->d_name);
			temp = strchr(script_dirent->d_name, '.');
1878
			snprintf(scripts_array[i],
1879 1880
				(temp - script_dirent->d_name) + 1,
				"%s", script_dirent->d_name);
1881 1882 1883 1884 1885

			if (check_ev_match(lang_path,
					scripts_array[i], session))
				continue;

1886 1887
			i++;
		}
1888
		closedir(lang_dir);
1889 1890
	}

1891 1892
	closedir(scripts_dir);
	perf_session__delete(session);
1893 1894 1895
	return i;
}

1896 1897
static char *get_script_path(const char *script_root, const char *suffix)
{
1898
	struct dirent *script_dirent, *lang_dirent;
1899 1900 1901 1902
	char scripts_path[MAXPATHLEN];
	char script_path[MAXPATHLEN];
	DIR *scripts_dir, *lang_dir;
	char lang_path[MAXPATHLEN];
1903
	char *__script_root;
1904

1905
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1906 1907 1908 1909 1910

	scripts_dir = opendir(scripts_path);
	if (!scripts_dir)
		return NULL;

1911
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
1912
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1913
			 lang_dirent->d_name);
1914 1915 1916 1917
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1918 1919
		for_each_script(lang_path, lang_dir, script_dirent) {
			__script_root = get_script_root(script_dirent, suffix);
1920 1921
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
1922 1923
				closedir(lang_dir);
				closedir(scripts_dir);
1924
				snprintf(script_path, MAXPATHLEN, "%s/%s",
1925
					 lang_path, script_dirent->d_name);
1926
				return strdup(script_path);
1927 1928 1929
			}
			free(__script_root);
		}
1930
		closedir(lang_dir);
1931
	}
1932
	closedir(scripts_dir);
1933

1934
	return NULL;
1935 1936
}

1937 1938
static bool is_top_script(const char *script_path)
{
1939
	return ends_with(script_path, "top") == NULL ? false : true;
1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964
}

static int has_required_arg(char *script_path)
{
	struct script_desc *desc;
	int n_args = 0;
	char *p;

	desc = script_desc__new(NULL);

	if (read_script_info(desc, script_path))
		goto out;

	if (!desc->args)
		goto out;

	for (p = desc->args; *p; p++)
		if (*p == '<')
			n_args++;
out:
	script_desc__delete(desc);

	return n_args;
}

1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
static int have_cmd(int argc, const char **argv)
{
	char **__argv = malloc(sizeof(const char *) * argc);

	if (!__argv) {
		pr_err("malloc failed\n");
		return -1;
	}

	memcpy(__argv, argv, sizeof(const char *) * argc);
	argc = parse_options(argc, (const char **)__argv, record_options,
			     NULL, PARSE_OPT_STOP_AT_NON_OPTION);
	free(__argv);
F
Frederic Weisbecker 已提交
1978

1979 1980 1981 1982 1983
	system_wide = (argc == 0);

	return 0;
}

1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999
static void script__setup_sample_type(struct perf_script *script)
{
	struct perf_session *session = script->session;
	u64 sample_type = perf_evlist__combined_sample_type(session->evlist);

	if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
		if ((sample_type & PERF_SAMPLE_REGS_USER) &&
		    (sample_type & PERF_SAMPLE_STACK_USER))
			callchain_param.record_mode = CALLCHAIN_DWARF;
		else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
			callchain_param.record_mode = CALLCHAIN_LBR;
		else
			callchain_param.record_mode = CALLCHAIN_FP;
	}
}

2000 2001 2002 2003 2004 2005 2006
static int process_stat_round_event(struct perf_tool *tool __maybe_unused,
				    union perf_event *event,
				    struct perf_session *session)
{
	struct stat_round_event *round = &event->stat_round;
	struct perf_evsel *counter;

2007
	evlist__for_each_entry(session->evlist, counter) {
2008 2009 2010 2011 2012 2013 2014 2015
		perf_stat_process_counter(&stat_config, counter);
		process_stat(counter, round->time);
	}

	process_stat_interval(round->time);
	return 0;
}

2016 2017 2018 2019 2020 2021 2022 2023
static int process_stat_config_event(struct perf_tool *tool __maybe_unused,
				     union perf_event *event,
				     struct perf_session *session __maybe_unused)
{
	perf_event__read_stat_config(&stat_config, &event->stat_config);
	return 0;
}

2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080
static int set_maps(struct perf_script *script)
{
	struct perf_evlist *evlist = script->session->evlist;

	if (!script->cpus || !script->threads)
		return 0;

	if (WARN_ONCE(script->allocated, "stats double allocation\n"))
		return -EINVAL;

	perf_evlist__set_maps(evlist, script->cpus, script->threads);

	if (perf_evlist__alloc_stats(evlist, true))
		return -ENOMEM;

	script->allocated = true;
	return 0;
}

static
int process_thread_map_event(struct perf_tool *tool,
			     union perf_event *event,
			     struct perf_session *session __maybe_unused)
{
	struct perf_script *script = container_of(tool, struct perf_script, tool);

	if (script->threads) {
		pr_warning("Extra thread map event, ignoring.\n");
		return 0;
	}

	script->threads = thread_map__new_event(&event->thread_map);
	if (!script->threads)
		return -ENOMEM;

	return set_maps(script);
}

static
int process_cpu_map_event(struct perf_tool *tool __maybe_unused,
			  union perf_event *event,
			  struct perf_session *session __maybe_unused)
{
	struct perf_script *script = container_of(tool, struct perf_script, tool);

	if (script->cpus) {
		pr_warning("Extra cpu map event, ignoring.\n");
		return 0;
	}

	script->cpus = cpu_map__new_data(&event->cpu_map.data);
	if (!script->cpus)
		return -ENOMEM;

	return set_maps(script);
}

2081 2082 2083
int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
{
	bool show_full_info = false;
2084 2085
	bool header = false;
	bool header_only = false;
2086
	bool script_started = false;
2087 2088 2089
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
	struct perf_session *session;
2090
	struct itrace_synth_opts itrace_synth_opts = { .set = false, };
2091 2092
	char *script_path = NULL;
	const char **__argv;
2093
	int i, j, err = 0;
2094 2095 2096 2097 2098 2099 2100 2101
	struct perf_script script = {
		.tool = {
			.sample		 = process_sample_event,
			.mmap		 = perf_event__process_mmap,
			.mmap2		 = perf_event__process_mmap2,
			.comm		 = perf_event__process_comm,
			.exit		 = perf_event__process_exit,
			.fork		 = perf_event__process_fork,
2102
			.attr		 = process_attr,
2103
			.event_update   = perf_event__process_event_update,
2104 2105
			.tracing_data	 = perf_event__process_tracing_data,
			.build_id	 = perf_event__process_build_id,
2106 2107 2108 2109
			.id_index	 = perf_event__process_id_index,
			.auxtrace_info	 = perf_event__process_auxtrace_info,
			.auxtrace	 = perf_event__process_auxtrace,
			.auxtrace_error	 = perf_event__process_auxtrace_error,
2110 2111
			.stat		 = perf_event__process_stat_event,
			.stat_round	 = process_stat_round_event,
2112
			.stat_config	 = process_stat_config_event,
2113 2114
			.thread_map	 = process_thread_map_event,
			.cpu_map	 = process_cpu_map_event,
2115
			.ordered_events	 = true,
2116 2117 2118
			.ordering_requires_timestamps = true,
		},
	};
2119 2120 2121
	struct perf_data_file file = {
		.mode = PERF_DATA_MODE_READ,
	};
2122
	const struct option options[] = {
F
Frederic Weisbecker 已提交
2123 2124
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
2125
	OPT_INCR('v', "verbose", &verbose,
2126
		 "be more verbose (show symbol address, etc)"),
2127
	OPT_BOOLEAN('L', "Latency", &latency_format,
2128
		    "show latency attributes (irqs/preemption disabled, etc)"),
2129 2130
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
T
Tom Zanussi 已提交
2131 2132 2133 2134
	OPT_CALLBACK('s', "script", NULL, "name",
		     "script file name (lang:script name, script name, or *)",
		     parse_scriptname),
	OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
2135
		   "generate perf-script.xx script in specified language"),
2136
	OPT_STRING('i', "input", &input_name, "file", "input file name"),
2137 2138
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
2139 2140
	OPT_BOOLEAN(0, "header", &header, "Show data header."),
	OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
2141 2142 2143 2144 2145 2146
	OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
		   "file", "vmlinux pathname"),
	OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
		   "file", "kallsyms pathname"),
	OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
		    "When printing symbols do not display call chain"),
2147 2148 2149
	OPT_CALLBACK(0, "symfs", NULL, "directory",
		     "Look for files with symbols relative to this directory",
		     symbol__config_symfs),
2150
	OPT_CALLBACK('F', "fields", NULL, "str",
2151 2152 2153
		     "comma separated output fields prepend with 'type:'. "
		     "Valid types: hw,sw,trace,raw. "
		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
2154
		     "addr,symoff,period,iregs,brstack,brstacksym,flags,"
A
Andi Kleen 已提交
2155
		     "bpf-output,callindent,insn,insnlen", parse_output_fields),
2156
	OPT_BOOLEAN('a', "all-cpus", &system_wide,
2157
		    "system-wide collection from all CPUs"),
2158 2159
	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
		   "only consider these symbols"),
2160 2161
	OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
		   "Stop display of callgraph at these symbols"),
2162
	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
2163 2164
	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only display events for these comms"),
2165 2166 2167 2168
	OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
		   "only consider symbols in these pids"),
	OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
		   "only consider symbols in these tids"),
2169 2170 2171
	OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
		     "Set the maximum stack depth when parsing the callchain, "
		     "anything beyond the specified depth will be ignored. "
2172
		     "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
2173 2174
	OPT_BOOLEAN('I', "show-info", &show_full_info,
		    "display extended information from perf.data file"),
2175 2176
	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
		    "Show the path of [kernel.kallsyms]"),
2177 2178
	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
		    "Show the fork/comm/exit events"),
2179 2180
	OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
		    "Show the mmap events"),
2181 2182
	OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
		    "Show context switch events (if recorded)"),
2183
	OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
2184 2185
	OPT_BOOLEAN(0, "ns", &nanosecs,
		    "Use 9 decimal places when displaying time"),
2186 2187 2188
	OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
			    "Instruction Tracing options",
			    itrace_parse_synth_opts),
2189 2190
	OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
			"Show full source file name path for source lines"),
2191 2192 2193 2194
	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
			"Enable symbol demangling"),
	OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
			"Enable kernel symbol demangling"),
2195 2196
	OPT_STRING(0, "time", &script.time_str, "str",
		   "Time span of interest (start,stop)"),
2197
	OPT_END()
2198
	};
2199 2200
	const char * const script_subcommands[] = { "record", "report", NULL };
	const char *script_usage[] = {
2201 2202 2203 2204 2205 2206 2207
		"perf script [<options>]",
		"perf script [<options>] record <script> [<record-options>] <command>",
		"perf script [<options>] report <script> [script-args]",
		"perf script [<options>] <script> [<record-options>] <command>",
		"perf script [<options>] <top-script> [script-args]",
		NULL
	};
2208

2209 2210
	setup_scripting();

2211
	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
2212 2213
			     PARSE_OPT_STOP_AT_NON_OPTION);

2214 2215
	file.path = input_name;

2216 2217 2218 2219
	if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
		rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
		if (!rec_script_path)
			return cmd_record(argc, argv, NULL);
2220 2221
	}

2222 2223 2224
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
2225
			fprintf(stderr,
2226
				"Please specify a valid report script"
2227
				"(see 'perf script -l' for listing)\n");
2228 2229 2230 2231
			return -1;
		}
	}

2232 2233 2234 2235
	if (itrace_synth_opts.callchain &&
	    itrace_synth_opts.callchain_sz > scripting_max_stack)
		scripting_max_stack = itrace_synth_opts.callchain_sz;

2236
	/* make sure PERF_EXEC_PATH is set for scripts */
2237
	set_argv_exec_path(get_argv_exec_path());
2238

2239
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
2240
		int live_pipe[2];
2241
		int rep_args;
2242 2243
		pid_t pid;

2244 2245 2246 2247
		rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
		rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);

		if (!rec_script_path && !rep_script_path) {
2248 2249
			usage_with_options_msg(script_usage, options,
				"Couldn't find script `%s'\n\n See perf"
2250
				" script -l for available scripts.\n", argv[0]);
2251 2252
		}

2253 2254 2255 2256 2257 2258 2259 2260
		if (is_top_script(argv[0])) {
			rep_args = argc - 1;
		} else {
			int rec_args;

			rep_args = has_required_arg(rep_script_path);
			rec_args = (argc - 1) - rep_args;
			if (rec_args < 0) {
2261 2262
				usage_with_options_msg(script_usage, options,
					"`%s' script requires options."
2263
					"\n\n See perf script -l for available "
2264 2265
					"scripts and options.\n", argv[0]);
			}
2266 2267 2268 2269
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
2270
			return -1;
2271 2272 2273 2274 2275
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
2276
			return -1;
2277 2278 2279
		}

		if (!pid) {
2280 2281
			j = 0;

2282 2283 2284
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

2285 2286 2287
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
2288 2289 2290 2291
				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
					err = -1;
					goto out;
				}
2292
			}
2293 2294

			__argv = malloc((argc + 6) * sizeof(const char *));
2295 2296 2297 2298 2299
			if (!__argv) {
				pr_err("malloc failed\n");
				err = -ENOMEM;
				goto out;
			}
2300

2301 2302 2303 2304 2305 2306 2307 2308 2309 2310
			__argv[j++] = "/bin/sh";
			__argv[j++] = rec_script_path;
			if (system_wide)
				__argv[j++] = "-a";
			__argv[j++] = "-q";
			__argv[j++] = "-o";
			__argv[j++] = "-";
			for (i = rep_args + 1; i < argc; i++)
				__argv[j++] = argv[i];
			__argv[j++] = NULL;
2311 2312

			execvp("/bin/sh", (char **)__argv);
2313
			free(__argv);
2314 2315 2316 2317 2318 2319
			exit(-1);
		}

		dup2(live_pipe[0], 0);
		close(live_pipe[1]);

2320
		__argv = malloc((argc + 4) * sizeof(const char *));
2321 2322 2323 2324 2325 2326
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

2327 2328 2329 2330 2331 2332 2333 2334
		j = 0;
		__argv[j++] = "/bin/sh";
		__argv[j++] = rep_script_path;
		for (i = 1; i < rep_args + 1; i++)
			__argv[j++] = argv[i];
		__argv[j++] = "-i";
		__argv[j++] = "-";
		__argv[j++] = NULL;
2335 2336

		execvp("/bin/sh", (char **)__argv);
2337
		free(__argv);
2338 2339 2340
		exit(-1);
	}

2341 2342 2343 2344
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
2345

2346 2347
	if (script_path) {
		j = 0;
2348

2349 2350
		if (!rec_script_path)
			system_wide = false;
2351 2352 2353 2354 2355 2356
		else if (!system_wide) {
			if (have_cmd(argc - 1, &argv[1]) != 0) {
				err = -1;
				goto out;
			}
		}
2357

2358
		__argv = malloc((argc + 2) * sizeof(const char *));
2359 2360 2361 2362 2363 2364
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

2365 2366 2367 2368
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
2369
		for (i = 2; i < argc; i++)
2370 2371
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
2372 2373

		execvp("/bin/sh", (char **)__argv);
2374
		free(__argv);
2375 2376
		exit(-1);
	}
T
Tom Zanussi 已提交
2377

2378 2379
	if (!script_name)
		setup_pager();
F
Frederic Weisbecker 已提交
2380

2381
	session = perf_session__new(&file, false, &script.tool);
2382
	if (session == NULL)
2383
		return -1;
2384

2385 2386 2387
	if (header || header_only) {
		perf_session__fprintf_info(session, stdout, show_full_info);
		if (header_only)
2388
			goto out_delete;
2389 2390
	}

2391
	if (symbol__init(&session->header.env) < 0)
2392 2393
		goto out_delete;

2394
	script.session = session;
2395
	script__setup_sample_type(&script);
2396

2397 2398 2399
	if (output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT)
		itrace_synth_opts.thread_stack = true;

2400 2401
	session->itrace_synth_opts = &itrace_synth_opts;

2402
	if (cpu_list) {
2403 2404 2405
		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
		if (err < 0)
			goto out_delete;
2406 2407
	}

2408
	if (!no_callchain)
2409 2410 2411 2412
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

2413 2414
	if (session->tevent.pevent &&
	    pevent_set_function_resolver(session->tevent.pevent,
2415 2416 2417 2418 2419 2420
					 machine__resolve_kernel_addr,
					 &session->machines.host) < 0) {
		pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
		return -1;
	}

T
Tom Zanussi 已提交
2421 2422
	if (generate_script_lang) {
		struct stat perf_stat;
2423 2424
		int input;

2425
		if (output_set_by_user()) {
2426 2427
			fprintf(stderr,
				"custom fields not supported for generated scripts");
2428 2429
			err = -EINVAL;
			goto out_delete;
2430
		}
T
Tom Zanussi 已提交
2431

2432
		input = open(file.path, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
2433
		if (input < 0) {
2434
			err = -errno;
T
Tom Zanussi 已提交
2435
			perror("failed to open file");
2436
			goto out_delete;
T
Tom Zanussi 已提交
2437 2438 2439 2440 2441
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
2442
			goto out_delete;
T
Tom Zanussi 已提交
2443 2444 2445 2446
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
2447
			goto out_delete;
T
Tom Zanussi 已提交
2448 2449 2450 2451 2452
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
2453 2454
			err = -ENOENT;
			goto out_delete;
T
Tom Zanussi 已提交
2455 2456
		}

J
Jiri Olsa 已提交
2457
		err = scripting_ops->generate_script(session->tevent.pevent,
2458
						     "perf-script");
2459
		goto out_delete;
T
Tom Zanussi 已提交
2460 2461 2462
	}

	if (script_name) {
2463
		err = scripting_ops->start_script(script_name, argc, argv);
T
Tom Zanussi 已提交
2464
		if (err)
2465
			goto out_delete;
2466
		pr_debug("perf script started with script %s\n\n", script_name);
2467
		script_started = true;
T
Tom Zanussi 已提交
2468 2469
	}

2470 2471 2472

	err = perf_session__check_output_opt(session);
	if (err < 0)
2473
		goto out_delete;
2474

2475 2476 2477 2478 2479 2480
	/* needs to be parsed after looking up reference time */
	if (perf_time__parse_str(&script.ptime, script.time_str) != 0) {
		pr_err("Invalid time string\n");
		return -EINVAL;
	}

2481
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
2482

2483 2484
	flush_scripting();

2485
out_delete:
2486
	perf_evlist__free_stats(session->evlist);
2487
	perf_session__delete(session);
2488 2489 2490

	if (script_started)
		cleanup_scripting();
T
Tom Zanussi 已提交
2491 2492
out:
	return err;
F
Frederic Weisbecker 已提交
2493
}