builtin-script.c 55.8 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 <linux/bitmap.h>
25
#include "asm/bug.h"
F
Frederic Weisbecker 已提交
26

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

41
unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
42

43 44 45 46 47 48 49 50
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,
51 52
	PERF_OUTPUT_IP              = 1U << 7,
	PERF_OUTPUT_SYM             = 1U << 8,
53
	PERF_OUTPUT_DSO             = 1U << 9,
54
	PERF_OUTPUT_ADDR            = 1U << 10,
55
	PERF_OUTPUT_SYMOFFSET       = 1U << 11,
56
	PERF_OUTPUT_SRCLINE         = 1U << 12,
J
Jiri Olsa 已提交
57
	PERF_OUTPUT_PERIOD          = 1U << 13,
58
	PERF_OUTPUT_IREGS	    = 1U << 14,
59 60
	PERF_OUTPUT_BRSTACK	    = 1U << 15,
	PERF_OUTPUT_BRSTACKSYM	    = 1U << 16,
61 62
	PERF_OUTPUT_DATA_SRC	    = 1U << 17,
	PERF_OUTPUT_WEIGHT	    = 1U << 18,
63 64 65 66 67 68 69 70 71 72 73 74 75
};

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},
76
	{.str = "ip",    .field = PERF_OUTPUT_IP},
77
	{.str = "sym",   .field = PERF_OUTPUT_SYM},
78
	{.str = "dso",   .field = PERF_OUTPUT_DSO},
79
	{.str = "addr",  .field = PERF_OUTPUT_ADDR},
80
	{.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
81
	{.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
J
Jiri Olsa 已提交
82
	{.str = "period", .field = PERF_OUTPUT_PERIOD},
83
	{.str = "iregs", .field = PERF_OUTPUT_IREGS},
84 85
	{.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
	{.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
86 87
	{.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
	{.str = "weight",   .field = PERF_OUTPUT_WEIGHT},
88 89 90
};

/* default set to maintain compatibility with current format */
91 92
static struct {
	bool user_set;
93
	bool wildcard_set;
94
	unsigned int print_ip_opts;
95 96 97 98 99 100 101 102 103
	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 |
104
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
105 106
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
			      PERF_OUTPUT_PERIOD,
107 108 109 110 111 112 113 114 115

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_SOFTWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
116
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
117 118
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
			      PERF_OUTPUT_PERIOD,
119 120 121 122 123 124 125 126 127 128 129

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_TRACEPOINT] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
				  PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
				  PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
	},
130 131 132 133 134 135

	[PERF_TYPE_RAW] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
136
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
137 138
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
			      PERF_OUTPUT_PERIOD,
139 140 141

		.invalid_fields = PERF_OUTPUT_TRACE,
	},
142 143 144 145 146 147 148 149 150 151 152 153

	[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,

		.invalid_fields = PERF_OUTPUT_TRACE,
	},
154
};
155

156 157 158 159 160 161 162 163 164
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;
}
165

166 167 168 169 170 171 172 173 174 175 176 177 178 179
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;
}

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

182 183 184 185
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)
186
{
187
	struct perf_event_attr *attr = &evsel->attr;
188 189 190 191 192 193 194
	int type = attr->type;
	const char *evname;

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

	if (output[type].user_set) {
195 196
		if (allow_user_set)
			return 0;
197
		evname = perf_evsel__name(evsel);
198 199 200 201 202 203 204 205
		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;
206
	evname = perf_evsel__name(evsel);
207 208 209 210 211 212 213
	pr_debug("Samples for '%s' event do not have %s attribute set. "
		 "Skipping '%s' field.\n",
		 evname, sample_msg, output_field2str(field));

	return 0;
}

214 215 216 217 218 219 220 221
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);
}

222 223 224 225
static int perf_evsel__check_attr(struct perf_evsel *evsel,
				  struct perf_session *session)
{
	struct perf_event_attr *attr = &evsel->attr;
226 227
	bool allow_user_set;

228 229 230
	if (perf_header__has_feat(&session->header, HEADER_STAT))
		return 0;

231 232
	allow_user_set = perf_header__has_feat(&session->header,
					       HEADER_AUXTRACE);
233

234 235 236 237
	if (PRINT_FIELD(TRACE) &&
		!perf_session__has_traces(session, "record -R"))
		return -EINVAL;

238
	if (PRINT_FIELD(IP)) {
239 240
		if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
					    PERF_OUTPUT_IP))
241 242
			return -EINVAL;
	}
243 244

	if (PRINT_FIELD(ADDR) &&
245 246
		perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
					   PERF_OUTPUT_ADDR, allow_user_set))
247 248
		return -EINVAL;

249 250 251 252 253 254 255 256 257 258
	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;

259 260 261 262
	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");
263 264
		return -EINVAL;
	}
265 266 267 268 269
	if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
		pr_err("Display of offsets requested but symbol is not"
		       "selected.\n");
		return -EINVAL;
	}
270 271 272 273
	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");
274 275
		return -EINVAL;
	}
276 277 278 279 280
	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;
	}
281 282

	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
283 284
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
					PERF_OUTPUT_TID|PERF_OUTPUT_PID))
285 286 287
		return -EINVAL;

	if (PRINT_FIELD(TIME) &&
288 289
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
					PERF_OUTPUT_TIME))
290 291 292
		return -EINVAL;

	if (PRINT_FIELD(CPU) &&
293 294
		perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
					   PERF_OUTPUT_CPU, allow_user_set))
295
		return -EINVAL;
296

J
Jiri Olsa 已提交
297 298 299 300 301
	if (PRINT_FIELD(PERIOD) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD",
					PERF_OUTPUT_PERIOD))
		return -EINVAL;

302 303 304 305 306
	if (PRINT_FIELD(IREGS) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
					PERF_OUTPUT_IREGS))
		return -EINVAL;

307 308 309
	return 0;
}

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
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))
		output[type].print_ip_opts |= PRINT_IP_OPT_IP;

	if (PRINT_FIELD(SYM))
		output[type].print_ip_opts |= PRINT_IP_OPT_SYM;

	if (PRINT_FIELD(DSO))
		output[type].print_ip_opts |= PRINT_IP_OPT_DSO;

	if (PRINT_FIELD(SYMOFFSET))
		output[type].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET;
326 327 328

	if (PRINT_FIELD(SRCLINE))
		output[type].print_ip_opts |= PRINT_IP_OPT_SRCLINE;
329 330
}

331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
/*
 * verify all user requested events exist and the samples
 * have the expected data
 */
static int perf_session__check_output_opt(struct perf_session *session)
{
	int j;
	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;
357 358 359 360

		if (evsel == NULL)
			continue;

361
		set_print_ip_opts(&evsel->attr);
362 363
	}

364 365 366 367 368 369 370 371 372 373 374 375 376
	if (!no_callchain) {
		bool use_callchain = false;

		evlist__for_each(session->evlist, evsel) {
			if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) {
				use_callchain = true;
				break;
			}
		}
		if (!use_callchain)
			symbol_conf.use_callchain = false;
	}

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
	/*
	 * 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;
		evsel = perf_session__find_first_evtype(session, j);
		if (evsel == NULL)
			goto out;

		attr = &evsel->attr;

		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);
		}
	}

out:
401 402
	return 0;
}
403

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
static void print_sample_iregs(union perf_event *event __maybe_unused,
			  struct perf_sample *sample,
			  struct thread *thread __maybe_unused,
			  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);
	}
}

422
static void print_sample_start(struct perf_sample *sample,
423
			       struct thread *thread,
424
			       struct perf_evsel *evsel)
425
{
426
	struct perf_event_attr *attr = &evsel->attr;
427 428
	unsigned long secs;
	unsigned long usecs;
429 430 431 432
	unsigned long long nsecs;

	if (PRINT_FIELD(COMM)) {
		if (latency_format)
433
			printf("%8.8s ", thread__comm_str(thread));
434
		else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
435
			printf("%s ", thread__comm_str(thread));
436
		else
437
			printf("%16s ", thread__comm_str(thread));
438
	}
439

440 441 442 443 444 445 446 447 448 449 450 451 452
	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);
	}
453

454 455 456 457 458
	if (PRINT_FIELD(TIME)) {
		nsecs = sample->time;
		secs = nsecs / NSECS_PER_SEC;
		nsecs -= secs * NSECS_PER_SEC;
		usecs = nsecs / NSECS_PER_USEC;
459 460 461 462
		if (nanosecs)
			printf("%5lu.%09llu: ", secs, nsecs);
		else
			printf("%5lu.%06lu: ", secs, usecs);
463
	}
464 465
}

466 467 468 469 470 471 472 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 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
static inline char
mispred_str(struct branch_entry *br)
{
	if (!(br->flags.mispred  || br->flags.predicted))
		return '-';

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

static void print_sample_brstack(union perf_event *event __maybe_unused,
			  struct perf_sample *sample,
			  struct thread *thread __maybe_unused,
			  struct perf_event_attr *attr __maybe_unused)
{
	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);
	}
}

static void print_sample_brstacksym(union perf_event *event __maybe_unused,
			  struct perf_sample *sample,
			  struct thread *thread __maybe_unused,
			  struct perf_event_attr *attr __maybe_unused)
{
	struct branch_stack *br = sample->branch_stack;
	struct addr_location alf, alt;
	u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
	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;

		thread__find_addr_map(thread, cpumode, MAP__FUNCTION, from, &alf);
		if (alf.map)
			alf.sym = map__find_symbol(alf.map, alf.addr, NULL);

		thread__find_addr_map(thread, cpumode, MAP__FUNCTION, to, &alt);
		if (alt.map)
			alt.sym = map__find_symbol(alt.map, alt.addr, NULL);

		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);
	}
}


537 538 539 540 541 542 543 544 545 546 547 548
static void print_sample_addr(union perf_event *event,
			  struct perf_sample *sample,
			  struct thread *thread,
			  struct perf_event_attr *attr)
{
	struct addr_location al;

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

	if (!sample_addr_correlates_sym(attr))
		return;

549
	perf_event__preprocess_sample_addr(event, sample, thread, &al);
550 551

	if (PRINT_FIELD(SYM)) {
552
		printf(" ");
553 554 555 556
		if (PRINT_FIELD(SYMOFFSET))
			symbol__fprintf_symname_offs(al.sym, &al, stdout);
		else
			symbol__fprintf_symname(al.sym, stdout);
557 558 559
	}

	if (PRINT_FIELD(DSO)) {
560 561 562
		printf(" (");
		map__fprintf_dsoname(al.map, stdout);
		printf(")");
563 564 565
	}
}

566 567 568
static void print_sample_bts(union perf_event *event,
			     struct perf_sample *sample,
			     struct perf_evsel *evsel,
569 570
			     struct thread *thread,
			     struct addr_location *al)
571 572
{
	struct perf_event_attr *attr = &evsel->attr;
573
	bool print_srcline_last = false;
574 575 576

	/* print branch_from information */
	if (PRINT_FIELD(IP)) {
577 578 579
		unsigned int print_opts = output[attr->type].print_ip_opts;

		if (symbol_conf.use_callchain && sample->callchain) {
580
			printf("\n");
581 582 583 584 585 586 587 588
		} else {
			printf(" ");
			if (print_opts & PRINT_IP_OPT_SRCLINE) {
				print_srcline_last = true;
				print_opts &= ~PRINT_IP_OPT_SRCLINE;
			}
		}
		perf_evsel__print_ip(evsel, sample, al, print_opts,
589
				     scripting_max_stack);
590 591 592
	}

	/* print branch_to information */
593 594
	if (PRINT_FIELD(ADDR) ||
	    ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
595 596
	     !output[attr->type].user_set)) {
		printf(" => ");
597
		print_sample_addr(event, sample, thread, attr);
598
	}
599

600 601 602
	if (print_srcline_last)
		map__fprintf_srcline(al->map, al->addr, "\n  ", stdout);

603 604 605
	printf("\n");
}

606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
static void print_sample_flags(u32 flags)
{
	const char *chars = PERF_IP_FLAG_CHARS;
	const int n = strlen(PERF_IP_FLAG_CHARS);
	char str[33];
	int i, pos = 0;

	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;
	printf("  %-4s ", str);
}

625 626 627 628 629 630
struct perf_script {
	struct perf_tool	tool;
	struct perf_session	*session;
	bool			show_task_events;
	bool			show_mmap_events;
	bool			show_switch_events;
631 632 633
	bool			allocated;
	struct cpu_map		*cpus;
	struct thread_map	*threads;
634
	int			name_width;
635 636
};

637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
static int perf_evlist__max_name_len(struct perf_evlist *evlist)
{
	struct perf_evsel *evsel;
	int max = 0;

	evlist__for_each(evlist, evsel) {
		int len = strlen(perf_evsel__name(evsel));

		max = MAX(len, max);
	}

	return max;
}

static void process_event(struct perf_script *script, union perf_event *event,
652 653
			  struct perf_sample *sample, struct perf_evsel *evsel,
			  struct addr_location *al)
654
{
655
	struct thread *thread = al->thread;
656
	struct perf_event_attr *attr = &evsel->attr;
657

658
	if (output[attr->type].fields == 0)
659 660
		return;

661
	print_sample_start(sample, thread, evsel);
662

J
Jiri Olsa 已提交
663 664 665
	if (PRINT_FIELD(PERIOD))
		printf("%10" PRIu64 " ", sample->period);

666 667
	if (PRINT_FIELD(EVNAME)) {
		const char *evname = perf_evsel__name(evsel);
668 669 670 671 672 673

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

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

676 677 678
	if (print_flags)
		print_sample_flags(sample->flags);

679
	if (is_bts_event(attr)) {
680
		print_sample_bts(event, sample, evsel, thread, al);
681 682 683
		return;
	}

684
	if (PRINT_FIELD(TRACE))
685 686
		event_format__print(evsel->tp_format, sample->cpu,
				    sample->raw_data, sample->raw_size);
687
	if (PRINT_FIELD(ADDR))
688
		print_sample_addr(event, sample, thread, attr);
689

690 691 692 693 694 695
	if (PRINT_FIELD(DATA_SRC))
		printf("%16" PRIx64, sample->data_src);

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

696
	if (PRINT_FIELD(IP)) {
697 698 699 700
		if (!symbol_conf.use_callchain)
			printf(" ");
		else
			printf("\n");
701

702
		perf_evsel__print_ip(evsel, sample, al,
703
				     output[attr->type].print_ip_opts,
704
				     scripting_max_stack);
705 706
	}

707 708 709
	if (PRINT_FIELD(IREGS))
		print_sample_iregs(event, sample, thread, attr);

710 711 712 713 714
	if (PRINT_FIELD(BRSTACK))
		print_sample_brstack(event, sample, thread, attr);
	else if (PRINT_FIELD(BRSTACKSYM))
		print_sample_brstacksym(event, sample, thread, attr);

715
	printf("\n");
716 717
}

T
Tom Zanussi 已提交
718 719
static struct scripting_ops	*scripting_ops;

720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
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));
		}
	}
}

754 755 756 757
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);
758 759
	else
		__process_stat(counter, tstamp);
760 761 762 763 764 765 766 767
}

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

T
Tom Zanussi 已提交
768 769
static void setup_scripting(void)
{
770
	setup_perl_scripting();
771
	setup_python_scripting();
T
Tom Zanussi 已提交
772 773
}

774 775
static int flush_scripting(void)
{
776
	return scripting_ops ? scripting_ops->flush_script() : 0;
777 778
}

T
Tom Zanussi 已提交
779 780
static int cleanup_scripting(void)
{
781
	pr_debug("\nperf script stopped\n");
782

783
	return scripting_ops ? scripting_ops->stop_script() : 0;
T
Tom Zanussi 已提交
784 785
}

786
static int process_sample_event(struct perf_tool *tool,
787
				union perf_event *event,
788
				struct perf_sample *sample,
789
				struct perf_evsel *evsel,
790
				struct machine *machine)
F
Frederic Weisbecker 已提交
791
{
792
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
793
	struct addr_location al;
F
Frederic Weisbecker 已提交
794

795 796 797 798 799 800
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
801
		}
802 803
		last_timestamp = sample->time;
		return 0;
F
Frederic Weisbecker 已提交
804
	}
805

806
	if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
807 808 809 810 811 812
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
		return -1;
	}

	if (al.filtered)
813
		goto out_put;
814

815
	if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
816
		goto out_put;
817

818 819 820
	if (scripting_ops)
		scripting_ops->process_event(event, sample, evsel, &al);
	else
821
		process_event(scr, event, sample, evsel, &al);
822

823 824
out_put:
	addr_location__put(&al);
F
Frederic Weisbecker 已提交
825 826 827
	return 0;
}

828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
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;

846
	evlist__for_each(evlist, pos) {
847 848 849 850 851 852
		if (pos->attr.type == evsel->attr.type && pos != evsel)
			return 0;
	}

	set_print_ip_opts(&evsel->attr);

853 854 855 856
	if (evsel->attr.sample_type)
		err = perf_evsel__check_attr(evsel, scr->session);

	return err;
857 858
}

859 860 861 862 863 864 865 866
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;
867
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
	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:
889
	thread__put(thread);
890 891 892 893 894 895 896 897 898 899 900
	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;
901
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919

	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);
920
	thread__put(thread);
921 922 923 924 925 926 927 928

	return 0;
}
static int process_exit_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
929
	int err = 0;
930 931 932
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
933
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
934 935 936 937 938 939 940 941 942 943

	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;
944 945
		sample->tid = event->fork.tid;
		sample->pid = event->fork.pid;
946 947 948 949 950
	}
	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);

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

953 954
	thread__put(thread);
	return err;
955 956
}

957 958 959 960 961 962 963 964
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;
965
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983

	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);
984
	thread__put(thread);
985 986 987 988 989 990 991 992 993 994 995
	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;
996
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014

	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);
1015
	thread__put(thread);
1016 1017 1018
	return 0;
}

1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
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;
}

1045
static void sig_handler(int sig __maybe_unused)
1046 1047 1048 1049
{
	session_done = 1;
}

1050
static int __cmd_script(struct perf_script *script)
F
Frederic Weisbecker 已提交
1051
{
1052 1053
	int ret;

1054 1055
	signal(SIGINT, sig_handler);

1056 1057 1058 1059 1060 1061
	/* 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;
	}
1062 1063 1064 1065
	if (script->show_mmap_events) {
		script->tool.mmap = process_mmap_event;
		script->tool.mmap2 = process_mmap2_event;
	}
1066 1067
	if (script->show_switch_events)
		script->tool.context_switch = process_switch_event;
1068

1069
	ret = perf_session__process_events(script->session);
1070

1071
	if (debug_mode)
1072
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
1073 1074

	return ret;
F
Frederic Weisbecker 已提交
1075 1076
}

T
Tom Zanussi 已提交
1077 1078 1079 1080 1081 1082
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
	char			spec[0];
};

1083
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122

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;
}

static struct script_spec *script_spec__findnew(const char *spec,
						struct scripting_ops *ops)
{
	struct script_spec *s = script_spec__find(spec);

	if (s)
		return s;

	s = script_spec__new(spec, ops);
	if (!s)
1123
		return NULL;
T
Tom Zanussi 已提交
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159

	script_spec__add(s);

	return s;
}

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

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

	s = script_spec__findnew(spec, ops);
	if (!s)
		return -1;

	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 "
1160
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
1161 1162 1163 1164 1165 1166 1167

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

	fprintf(stderr, "\n");
}

1168 1169
static int parse_scriptname(const struct option *opt __maybe_unused,
			    const char *str, int unset __maybe_unused)
T
Tom Zanussi 已提交
1170 1171 1172 1173 1174
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

1175
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
1176
		list_available_languages();
1177
		exit(0);
T
Tom Zanussi 已提交
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
	}

	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;
1197
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
		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;
}

1214 1215
static int parse_output_fields(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused)
1216 1217
{
	char *tok;
1218
	int i, imax = ARRAY_SIZE(all_output_options);
1219
	int j;
1220 1221
	int rc = 0;
	char *str = strdup(arg);
1222
	int type = -1;
1223 1224 1225 1226

	if (!str)
		return -ENOMEM;

1227 1228 1229
	/* 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.
1230
	 */
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
	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;
1241 1242
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
1243 1244
		else if (!strcmp(str, "break"))
			type = PERF_TYPE_BREAKPOINT;
1245 1246
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
1247 1248
			rc = -EINVAL;
			goto out;
1249 1250 1251 1252 1253 1254 1255 1256
		}

		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;
1257
		output[type].wildcard_set = false;
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273

	} 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;
1274
			output[j].wildcard_set = true;
1275
		}
1276 1277
	}

1278
	for (tok = strtok(tok, ","); tok; tok = strtok(NULL, ",")) {
1279
		for (i = 0; i < imax; ++i) {
1280
			if (strcmp(tok, all_output_options[i].str) == 0)
1281 1282
				break;
		}
1283 1284 1285 1286
		if (i == imax && strcmp(tok, "flags") == 0) {
			print_flags = true;
			continue;
		}
1287
		if (i == imax) {
1288
			fprintf(stderr, "Invalid field requested.\n");
1289
			rc = -EINVAL;
1290
			goto out;
1291 1292
		}

1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
		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;
		}
1314 1315
	}

1316 1317 1318 1319 1320 1321
	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));
		}
	}
1322

1323
out:
1324 1325 1326 1327
	free(str);
	return rc;
}

1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
/* 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);
}

#define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
1342 1343
	while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) &&	\
	       lang_next)						\
1344 1345 1346
		if ((lang_dirent.d_type == DT_DIR ||			\
		     (lang_dirent.d_type == DT_UNKNOWN &&		\
		      is_directory(scripts_path, &lang_dirent))) &&	\
1347 1348 1349
		    (strcmp(lang_dirent.d_name, ".")) &&		\
		    (strcmp(lang_dirent.d_name, "..")))

1350
#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
1351 1352
	while (!readdir_r(lang_dir, &script_dirent, &script_next) &&	\
	       script_next)						\
1353 1354 1355
		if (script_dirent.d_type != DT_DIR &&			\
		    (script_dirent.d_type != DT_UNKNOWN ||		\
		     !is_directory(lang_path, &script_dirent)))
1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367


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

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

1368
static LIST_HEAD(script_descs);
1369 1370 1371 1372 1373

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

1374
	if (s != NULL && name)
1375 1376 1377 1378 1379 1380 1381
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
1382 1383 1384
	zfree(&s->name);
	zfree(&s->half_liner);
	zfree(&s->args);
1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
	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;
}

1424
static const char *ends_with(const char *str, const char *suffix)
1425 1426
{
	size_t suffix_len = strlen(suffix);
1427
	const char *p = str;
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478

	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;
}

1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496
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;
}

1497 1498 1499
static int list_available_scripts(const struct option *opt __maybe_unused,
				  const char *s __maybe_unused,
				  int unset __maybe_unused)
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509
{
	struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
	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;

1510
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1511 1512 1513 1514 1515

	scripts_dir = opendir(scripts_path);
	if (!scripts_dir)
		return -1;

1516
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1517 1518 1519 1520 1521 1522
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1523
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1524 1525
			script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
			if (script_root) {
1526 1527 1528 1529
				desc = script_desc__findnew(script_root);
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
				read_script_info(desc, script_path);
1530
				free(script_root);
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
			}
		}
	}

	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);
}

1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
/*
 * 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;
1589
			evlist__for_each(session->evlist, pos) {
1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
				if (!strcmp(perf_evsel__name(pos), evname)) {
					match = 1;
					break;
				}
			}

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

	fclose(fp);
	return 0;
}

1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
/*
 * 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)
{
	struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1617
	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1618
	DIR *scripts_dir, *lang_dir;
1619
	struct perf_session *session;
1620 1621 1622 1623
	struct perf_data_file file = {
		.path = input_name,
		.mode = PERF_DATA_MODE_READ,
	};
1624 1625 1626
	char *temp;
	int i = 0;

1627
	session = perf_session__new(&file, false, NULL);
1628 1629 1630
	if (!session)
		return -1;

1631
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1632 1633

	scripts_dir = opendir(scripts_path);
1634 1635
	if (!scripts_dir) {
		perf_session__delete(session);
1636
		return -1;
1637
	}
1638 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

	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
		snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
			 lang_dirent.d_name);
#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;

		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
			/* Skip those real time scripts: xxxtop.p[yl] */
			if (strstr(script_dirent.d_name, "top."))
				continue;
			sprintf(scripts_path_array[i], "%s/%s", lang_path,
				script_dirent.d_name);
			temp = strchr(script_dirent.d_name, '.');
			snprintf(scripts_array[i],
				(temp - script_dirent.d_name) + 1,
				"%s", script_dirent.d_name);
1665 1666 1667 1668 1669

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

1670 1671
			i++;
		}
1672
		closedir(lang_dir);
1673 1674
	}

1675 1676
	closedir(scripts_dir);
	perf_session__delete(session);
1677 1678 1679
	return i;
}

1680 1681 1682 1683 1684 1685 1686
static char *get_script_path(const char *script_root, const char *suffix)
{
	struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
	char scripts_path[MAXPATHLEN];
	char script_path[MAXPATHLEN];
	DIR *scripts_dir, *lang_dir;
	char lang_path[MAXPATHLEN];
1687
	char *__script_root;
1688

1689
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1690 1691 1692 1693 1694

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

1695
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1696 1697 1698 1699 1700 1701
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1702
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1703 1704 1705
			__script_root = get_script_root(&script_dirent, suffix);
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
1706 1707
				closedir(lang_dir);
				closedir(scripts_dir);
1708 1709
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
1710
				return strdup(script_path);
1711 1712 1713
			}
			free(__script_root);
		}
1714
		closedir(lang_dir);
1715
	}
1716
	closedir(scripts_dir);
1717

1718
	return NULL;
1719 1720
}

1721 1722
static bool is_top_script(const char *script_path)
{
1723
	return ends_with(script_path, "top") == NULL ? false : true;
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
}

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;
}

1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761
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 已提交
1762

1763 1764 1765 1766 1767
	system_wide = (argc == 0);

	return 0;
}

1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
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;
	}
}

1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799
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;

	evlist__for_each(session->evlist, counter) {
		perf_stat_process_counter(&stat_config, counter);
		process_stat(counter, round->time);
	}

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

1800 1801 1802 1803 1804 1805 1806 1807
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;
}

1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864
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);
}

1865 1866 1867
int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
{
	bool show_full_info = false;
1868 1869
	bool header = false;
	bool header_only = false;
1870
	bool script_started = false;
1871 1872 1873
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
	struct perf_session *session;
1874
	struct itrace_synth_opts itrace_synth_opts = { .set = false, };
1875 1876
	char *script_path = NULL;
	const char **__argv;
1877
	int i, j, err = 0;
1878 1879 1880 1881 1882 1883 1884 1885
	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,
1886
			.attr		 = process_attr,
1887 1888
			.tracing_data	 = perf_event__process_tracing_data,
			.build_id	 = perf_event__process_build_id,
1889 1890 1891 1892
			.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,
1893 1894
			.stat		 = perf_event__process_stat_event,
			.stat_round	 = process_stat_round_event,
1895
			.stat_config	 = process_stat_config_event,
1896 1897
			.thread_map	 = process_thread_map_event,
			.cpu_map	 = process_cpu_map_event,
1898
			.ordered_events	 = true,
1899 1900 1901
			.ordering_requires_timestamps = true,
		},
	};
1902 1903 1904
	struct perf_data_file file = {
		.mode = PERF_DATA_MODE_READ,
	};
1905
	const struct option options[] = {
F
Frederic Weisbecker 已提交
1906 1907
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
1908
	OPT_INCR('v', "verbose", &verbose,
1909
		 "be more verbose (show symbol address, etc)"),
1910
	OPT_BOOLEAN('L', "Latency", &latency_format,
1911
		    "show latency attributes (irqs/preemption disabled, etc)"),
1912 1913
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
T
Tom Zanussi 已提交
1914 1915 1916 1917
	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",
1918
		   "generate perf-script.xx script in specified language"),
1919
	OPT_STRING('i', "input", &input_name, "file", "input file name"),
1920 1921
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
1922 1923
	OPT_BOOLEAN(0, "header", &header, "Show data header."),
	OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
1924 1925 1926 1927 1928 1929 1930 1931
	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"),
	OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
		    "Look for files with symbols relative to this directory"),
1932
	OPT_CALLBACK('F', "fields", NULL, "str",
1933 1934 1935
		     "comma separated output fields prepend with 'type:'. "
		     "Valid types: hw,sw,trace,raw. "
		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1936
		     "addr,symoff,period,iregs,brstack,brstacksym,flags", parse_output_fields),
1937
	OPT_BOOLEAN('a', "all-cpus", &system_wide,
1938
		    "system-wide collection from all CPUs"),
1939 1940
	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
		   "only consider these symbols"),
1941
	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1942 1943
	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only display events for these comms"),
1944 1945 1946 1947
	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"),
1948 1949
	OPT_BOOLEAN('I', "show-info", &show_full_info,
		    "display extended information from perf.data file"),
1950 1951
	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
		    "Show the path of [kernel.kallsyms]"),
1952 1953
	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
		    "Show the fork/comm/exit events"),
1954 1955
	OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
		    "Show the mmap events"),
1956 1957
	OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
		    "Show context switch events (if recorded)"),
1958
	OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
1959 1960
	OPT_BOOLEAN(0, "ns", &nanosecs,
		    "Use 9 decimal places when displaying time"),
1961 1962 1963
	OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
			    "Instruction Tracing options",
			    itrace_parse_synth_opts),
1964 1965
	OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
			"Show full source file name path for source lines"),
1966 1967 1968 1969 1970
	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
			"Enable symbol demangling"),
	OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
			"Enable kernel symbol demangling"),

1971
	OPT_END()
1972
	};
1973 1974
	const char * const script_subcommands[] = { "record", "report", NULL };
	const char *script_usage[] = {
1975 1976 1977 1978 1979 1980 1981
		"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
	};
1982

1983 1984
	setup_scripting();

1985
	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
1986 1987
			     PARSE_OPT_STOP_AT_NON_OPTION);

1988 1989
	file.path = input_name;

1990 1991 1992 1993
	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);
1994 1995
	}

1996 1997 1998
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
1999
			fprintf(stderr,
2000
				"Please specify a valid report script"
2001
				"(see 'perf script -l' for listing)\n");
2002 2003 2004 2005
			return -1;
		}
	}

2006 2007 2008 2009
	if (itrace_synth_opts.callchain &&
	    itrace_synth_opts.callchain_sz > scripting_max_stack)
		scripting_max_stack = itrace_synth_opts.callchain_sz;

2010
	/* make sure PERF_EXEC_PATH is set for scripts */
2011
	set_argv_exec_path(get_argv_exec_path());
2012

2013
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
2014
		int live_pipe[2];
2015
		int rep_args;
2016 2017
		pid_t pid;

2018 2019 2020 2021
		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) {
2022 2023
			usage_with_options_msg(script_usage, options,
				"Couldn't find script `%s'\n\n See perf"
2024
				" script -l for available scripts.\n", argv[0]);
2025 2026
		}

2027 2028 2029 2030 2031 2032 2033 2034
		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) {
2035 2036
				usage_with_options_msg(script_usage, options,
					"`%s' script requires options."
2037
					"\n\n See perf script -l for available "
2038 2039
					"scripts and options.\n", argv[0]);
			}
2040 2041 2042 2043
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
2044
			return -1;
2045 2046 2047 2048 2049
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
2050
			return -1;
2051 2052 2053
		}

		if (!pid) {
2054 2055
			j = 0;

2056 2057 2058
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

2059 2060 2061
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
2062 2063 2064 2065
				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
					err = -1;
					goto out;
				}
2066
			}
2067 2068

			__argv = malloc((argc + 6) * sizeof(const char *));
2069 2070 2071 2072 2073
			if (!__argv) {
				pr_err("malloc failed\n");
				err = -ENOMEM;
				goto out;
			}
2074

2075 2076 2077 2078 2079 2080 2081 2082 2083 2084
			__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;
2085 2086

			execvp("/bin/sh", (char **)__argv);
2087
			free(__argv);
2088 2089 2090 2091 2092 2093
			exit(-1);
		}

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

2094
		__argv = malloc((argc + 4) * sizeof(const char *));
2095 2096 2097 2098 2099 2100
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

2101 2102 2103 2104 2105 2106 2107 2108
		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;
2109 2110

		execvp("/bin/sh", (char **)__argv);
2111
		free(__argv);
2112 2113 2114
		exit(-1);
	}

2115 2116 2117 2118
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
2119

2120 2121
	if (script_path) {
		j = 0;
2122

2123 2124
		if (!rec_script_path)
			system_wide = false;
2125 2126 2127 2128 2129 2130
		else if (!system_wide) {
			if (have_cmd(argc - 1, &argv[1]) != 0) {
				err = -1;
				goto out;
			}
		}
2131

2132
		__argv = malloc((argc + 2) * sizeof(const char *));
2133 2134 2135 2136 2137 2138
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

2139 2140 2141 2142
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
2143
		for (i = 2; i < argc; i++)
2144 2145
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
2146 2147

		execvp("/bin/sh", (char **)__argv);
2148
		free(__argv);
2149 2150
		exit(-1);
	}
T
Tom Zanussi 已提交
2151

2152 2153
	if (!script_name)
		setup_pager();
F
Frederic Weisbecker 已提交
2154

2155
	session = perf_session__new(&file, false, &script.tool);
2156
	if (session == NULL)
2157
		return -1;
2158

2159 2160 2161
	if (header || header_only) {
		perf_session__fprintf_info(session, stdout, show_full_info);
		if (header_only)
2162
			goto out_delete;
2163 2164
	}

2165
	if (symbol__init(&session->header.env) < 0)
2166 2167
		goto out_delete;

2168
	script.session = session;
2169
	script__setup_sample_type(&script);
2170

2171 2172
	session->itrace_synth_opts = &itrace_synth_opts;

2173
	if (cpu_list) {
2174 2175 2176
		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
		if (err < 0)
			goto out_delete;
2177 2178
	}

2179
	if (!no_callchain)
2180 2181 2182 2183
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

2184 2185
	if (session->tevent.pevent &&
	    pevent_set_function_resolver(session->tevent.pevent,
2186 2187 2188 2189 2190 2191
					 machine__resolve_kernel_addr,
					 &session->machines.host) < 0) {
		pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
		return -1;
	}

T
Tom Zanussi 已提交
2192 2193
	if (generate_script_lang) {
		struct stat perf_stat;
2194 2195
		int input;

2196
		if (output_set_by_user()) {
2197 2198
			fprintf(stderr,
				"custom fields not supported for generated scripts");
2199 2200
			err = -EINVAL;
			goto out_delete;
2201
		}
T
Tom Zanussi 已提交
2202

2203
		input = open(file.path, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
2204
		if (input < 0) {
2205
			err = -errno;
T
Tom Zanussi 已提交
2206
			perror("failed to open file");
2207
			goto out_delete;
T
Tom Zanussi 已提交
2208 2209 2210 2211 2212
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
2213
			goto out_delete;
T
Tom Zanussi 已提交
2214 2215 2216 2217
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
2218
			goto out_delete;
T
Tom Zanussi 已提交
2219 2220 2221 2222 2223
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
2224 2225
			err = -ENOENT;
			goto out_delete;
T
Tom Zanussi 已提交
2226 2227
		}

J
Jiri Olsa 已提交
2228
		err = scripting_ops->generate_script(session->tevent.pevent,
2229
						     "perf-script");
2230
		goto out_delete;
T
Tom Zanussi 已提交
2231 2232 2233
	}

	if (script_name) {
2234
		err = scripting_ops->start_script(script_name, argc, argv);
T
Tom Zanussi 已提交
2235
		if (err)
2236
			goto out_delete;
2237
		pr_debug("perf script started with script %s\n\n", script_name);
2238
		script_started = true;
T
Tom Zanussi 已提交
2239 2240
	}

2241 2242 2243

	err = perf_session__check_output_opt(session);
	if (err < 0)
2244
		goto out_delete;
2245

2246
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
2247

2248 2249
	flush_scripting();

2250
out_delete:
2251
	perf_evlist__free_stats(session->evlist);
2252
	perf_session__delete(session);
2253 2254 2255

	if (script_started)
		cleanup_scripting();
T
Tom Zanussi 已提交
2256 2257
out:
	return err;
F
Frederic Weisbecker 已提交
2258
}