builtin-script.c 43.3 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 6 7 8 9
#include "util/debug.h"
#include "util/exec_cmd.h"
#include "util/header.h"
#include "util/parse-options.h"
#include "util/session.h"
10
#include "util/tool.h"
F
Frederic Weisbecker 已提交
11 12
#include "util/symbol.h"
#include "util/thread.h"
I
Ingo Molnar 已提交
13
#include "util/trace-event.h"
A
Andrea Gelmini 已提交
14
#include "util/util.h"
15 16
#include "util/evlist.h"
#include "util/evsel.h"
17
#include "util/sort.h"
18
#include "util/data.h"
19
#include <linux/bitmap.h>
F
Frederic Weisbecker 已提交
20

T
Tom Zanussi 已提交
21 22
static char const		*script_name;
static char const		*generate_script_lang;
23
static bool			debug_mode;
24
static u64			last_timestamp;
25
static u64			nr_unordered;
26
extern const struct option	record_options[];
27
static bool			no_callchain;
28
static bool			latency_format;
29
static bool			system_wide;
30 31
static const char		*cpu_list;
static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
T
Tom Zanussi 已提交
32

33 34 35 36 37 38 39 40
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,
41 42
	PERF_OUTPUT_IP              = 1U << 7,
	PERF_OUTPUT_SYM             = 1U << 8,
43
	PERF_OUTPUT_DSO             = 1U << 9,
44
	PERF_OUTPUT_ADDR            = 1U << 10,
45
	PERF_OUTPUT_SYMOFFSET       = 1U << 11,
46
	PERF_OUTPUT_SRCLINE         = 1U << 12,
47 48 49 50 51 52 53 54 55 56 57 58 59
};

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},
60
	{.str = "ip",    .field = PERF_OUTPUT_IP},
61
	{.str = "sym",   .field = PERF_OUTPUT_SYM},
62
	{.str = "dso",   .field = PERF_OUTPUT_DSO},
63
	{.str = "addr",  .field = PERF_OUTPUT_ADDR},
64
	{.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
65
	{.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
66 67 68
};

/* default set to maintain compatibility with current format */
69 70
static struct {
	bool user_set;
71
	bool wildcard_set;
72
	unsigned int print_ip_opts;
73 74 75 76 77 78 79 80 81
	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 |
82
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
83
				  PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
84 85 86 87 88 89 90 91 92

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_SOFTWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
93
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
94
				  PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
95 96 97 98 99 100 101 102 103 104 105

		.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,
	},
106 107 108 109 110 111

	[PERF_TYPE_RAW] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
112
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
113
				  PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
114 115 116

		.invalid_fields = PERF_OUTPUT_TRACE,
	},
117
};
118

119 120 121 122 123 124 125 126 127
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;
}
128

129 130 131 132 133 134 135 136 137 138 139 140 141 142
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;
}

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

145 146 147
static int perf_evsel__check_stype(struct perf_evsel *evsel,
				   u64 sample_type, const char *sample_msg,
				   enum perf_output_field field)
148
{
149
	struct perf_event_attr *attr = &evsel->attr;
150 151 152 153 154 155 156
	int type = attr->type;
	const char *evname;

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

	if (output[type].user_set) {
157
		evname = perf_evsel__name(evsel);
158 159 160 161 162 163 164 165
		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;
166
	evname = perf_evsel__name(evsel);
167 168 169 170 171 172 173 174 175 176 177 178
	pr_debug("Samples for '%s' event do not have %s attribute set. "
		 "Skipping '%s' field.\n",
		 evname, sample_msg, output_field2str(field));

	return 0;
}

static int perf_evsel__check_attr(struct perf_evsel *evsel,
				  struct perf_session *session)
{
	struct perf_event_attr *attr = &evsel->attr;

179 180 181 182
	if (PRINT_FIELD(TRACE) &&
		!perf_session__has_traces(session, "record -R"))
		return -EINVAL;

183
	if (PRINT_FIELD(IP)) {
184 185
		if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
					    PERF_OUTPUT_IP))
186
			return -EINVAL;
187

188
		if (!no_callchain &&
189
		    !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
190 191
			symbol_conf.use_callchain = false;
	}
192 193

	if (PRINT_FIELD(ADDR) &&
194 195
		perf_evsel__check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
					PERF_OUTPUT_ADDR))
196 197 198 199 200 201
		return -EINVAL;

	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");
202 203
		return -EINVAL;
	}
204 205 206 207 208
	if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
		pr_err("Display of offsets requested but symbol is not"
		       "selected.\n");
		return -EINVAL;
	}
209 210 211 212
	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");
213 214
		return -EINVAL;
	}
215 216 217 218 219
	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;
	}
220 221

	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
222 223
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
					PERF_OUTPUT_TID|PERF_OUTPUT_PID))
224 225 226
		return -EINVAL;

	if (PRINT_FIELD(TIME) &&
227 228
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
					PERF_OUTPUT_TIME))
229 230 231
		return -EINVAL;

	if (PRINT_FIELD(CPU) &&
232 233
		perf_evsel__check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
					PERF_OUTPUT_CPU))
234
		return -EINVAL;
235 236 237 238

	return 0;
}

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
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;
255 256 257

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

260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
/*
 * 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;
286 287 288 289

		if (evsel == NULL)
			continue;

290
		set_print_ip_opts(&evsel->attr);
291 292
	}

293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
	/*
	 * 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:
317 318
	return 0;
}
319

320
static void print_sample_start(struct perf_sample *sample,
321
			       struct thread *thread,
322
			       struct perf_evsel *evsel)
323
{
324
	struct perf_event_attr *attr = &evsel->attr;
325 326
	unsigned long secs;
	unsigned long usecs;
327 328 329 330
	unsigned long long nsecs;

	if (PRINT_FIELD(COMM)) {
		if (latency_format)
331
			printf("%8.8s ", thread__comm_str(thread));
332
		else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
333
			printf("%s ", thread__comm_str(thread));
334
		else
335
			printf("%16s ", thread__comm_str(thread));
336
	}
337

338 339 340 341 342 343 344 345 346 347 348 349 350
	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);
	}
351

352 353 354 355 356 357 358
	if (PRINT_FIELD(TIME)) {
		nsecs = sample->time;
		secs = nsecs / NSECS_PER_SEC;
		nsecs -= secs * NSECS_PER_SEC;
		usecs = nsecs / NSECS_PER_USEC;
		printf("%5lu.%06lu: ", secs, usecs);
	}
359 360
}

361 362
static void print_sample_addr(union perf_event *event,
			  struct perf_sample *sample,
363
			  struct machine *machine,
364 365 366 367 368 369 370 371 372 373
			  struct thread *thread,
			  struct perf_event_attr *attr)
{
	struct addr_location al;

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

	if (!sample_addr_correlates_sym(attr))
		return;

374
	perf_event__preprocess_sample_addr(event, sample, machine, thread, &al);
375 376

	if (PRINT_FIELD(SYM)) {
377
		printf(" ");
378 379 380 381
		if (PRINT_FIELD(SYMOFFSET))
			symbol__fprintf_symname_offs(al.sym, &al, stdout);
		else
			symbol__fprintf_symname(al.sym, stdout);
382 383 384
	}

	if (PRINT_FIELD(DSO)) {
385 386 387
		printf(" (");
		map__fprintf_dsoname(al.map, stdout);
		printf(")");
388 389 390
	}
}

391 392 393
static void print_sample_bts(union perf_event *event,
			     struct perf_sample *sample,
			     struct perf_evsel *evsel,
394 395
			     struct thread *thread,
			     struct addr_location *al)
396 397
{
	struct perf_event_attr *attr = &evsel->attr;
398
	bool print_srcline_last = false;
399 400 401

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

		if (symbol_conf.use_callchain && sample->callchain) {
405
			printf("\n");
406 407 408 409 410 411 412 413
		} 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,
414
				     PERF_MAX_STACK_DEPTH);
415 416 417
	}

	/* print branch_to information */
418 419
	if (PRINT_FIELD(ADDR) ||
	    ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
420 421
	     !output[attr->type].user_set)) {
		printf(" => ");
422
		print_sample_addr(event, sample, al->machine, thread, attr);
423
	}
424

425 426 427
	if (print_srcline_last)
		map__fprintf_srcline(al->map, al->addr, "\n  ", stdout);

428 429 430
	printf("\n");
}

431
static void process_event(union perf_event *event, struct perf_sample *sample,
432
			  struct perf_evsel *evsel, struct thread *thread,
433
			  struct addr_location *al)
434
{
435
	struct perf_event_attr *attr = &evsel->attr;
436

437
	if (output[attr->type].fields == 0)
438 439
		return;

440
	print_sample_start(sample, thread, evsel);
441

442 443 444 445 446
	if (PRINT_FIELD(EVNAME)) {
		const char *evname = perf_evsel__name(evsel);
		printf("%s: ", evname ? evname : "[unknown]");
	}

447
	if (is_bts_event(attr)) {
448
		print_sample_bts(event, sample, evsel, thread, al);
449 450 451
		return;
	}

452
	if (PRINT_FIELD(TRACE))
453 454
		event_format__print(evsel->tp_format, sample->cpu,
				    sample->raw_data, sample->raw_size);
455
	if (PRINT_FIELD(ADDR))
456
		print_sample_addr(event, sample, al->machine, thread, attr);
457

458
	if (PRINT_FIELD(IP)) {
459 460 461 462
		if (!symbol_conf.use_callchain)
			printf(" ");
		else
			printf("\n");
463

464
		perf_evsel__print_ip(evsel, sample, al,
465 466
				     output[attr->type].print_ip_opts,
				     PERF_MAX_STACK_DEPTH);
467 468
	}

469
	printf("\n");
470 471
}

472 473 474
static int default_start_script(const char *script __maybe_unused,
				int argc __maybe_unused,
				const char **argv __maybe_unused)
T
Tom Zanussi 已提交
475 476 477 478 479 480 481 482 483
{
	return 0;
}

static int default_stop_script(void)
{
	return 0;
}

484 485
static int default_generate_script(struct pevent *pevent __maybe_unused,
				   const char *outfile __maybe_unused)
T
Tom Zanussi 已提交
486 487 488 489 490 491 492
{
	return 0;
}

static struct scripting_ops default_scripting_ops = {
	.start_script		= default_start_script,
	.stop_script		= default_stop_script,
493
	.process_event		= process_event,
T
Tom Zanussi 已提交
494 495 496 497 498 499 500
	.generate_script	= default_generate_script,
};

static struct scripting_ops	*scripting_ops;

static void setup_scripting(void)
{
501
	setup_perl_scripting();
502
	setup_python_scripting();
503

T
Tom Zanussi 已提交
504 505 506 507 508
	scripting_ops = &default_scripting_ops;
}

static int cleanup_scripting(void)
{
509
	pr_debug("\nperf script stopped\n");
510

T
Tom Zanussi 已提交
511 512 513
	return scripting_ops->stop_script();
}

514
static int process_sample_event(struct perf_tool *tool __maybe_unused,
515
				union perf_event *event,
516
				struct perf_sample *sample,
517
				struct perf_evsel *evsel,
518
				struct machine *machine)
F
Frederic Weisbecker 已提交
519
{
520
	struct addr_location al;
521 522
	struct thread *thread = machine__findnew_thread(machine, sample->pid,
							sample->tid);
523

F
Frederic Weisbecker 已提交
524
	if (thread == NULL) {
525 526
		pr_debug("problem processing %d event, skipping it.\n",
			 event->header.type);
F
Frederic Weisbecker 已提交
527 528 529
		return -1;
	}

530 531 532 533 534 535
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
536
		}
537 538
		last_timestamp = sample->time;
		return 0;
F
Frederic Weisbecker 已提交
539
	}
540

541
	if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
542 543 544 545 546 547 548 549
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
		return -1;
	}

	if (al.filtered)
		return 0;

550 551 552
	if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
		return 0;

553
	scripting_ops->process_event(event, sample, evsel, thread, &al);
F
Frederic Weisbecker 已提交
554

555
	evsel->hists.stats.total_period += sample->period;
F
Frederic Weisbecker 已提交
556 557 558
	return 0;
}

559 560 561
struct perf_script {
	struct perf_tool	tool;
	struct perf_session	*session;
562
	bool			show_task_events;
563
	bool			show_mmap_events;
564 565
};

566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
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;

584
	evlist__for_each(evlist, pos) {
585 586 587 588 589 590 591 592 593
		if (pos->attr.type == evsel->attr.type && pos != evsel)
			return 0;
	}

	set_print_ip_opts(&evsel->attr);

	return perf_evsel__check_attr(evsel, scr->session);
}

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 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
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;
	struct perf_evsel *evsel = perf_evlist__first(session->evlist);
	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:
	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;
	struct perf_evsel *evsel = perf_evlist__first(session->evlist);

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

	return 0;
}
static int process_exit_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__first(session->evlist);

	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;
		sample->tid = event->comm.tid;
		sample->pid = event->comm.pid;
	}
	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);

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

	return 0;
}

689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 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
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;
	struct perf_evsel *evsel = perf_evlist__first(session->evlist);

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

	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;
	struct perf_evsel *evsel = perf_evlist__first(session->evlist);

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

	return 0;
}

751
static void sig_handler(int sig __maybe_unused)
752 753 754 755
{
	session_done = 1;
}

756
static int __cmd_script(struct perf_script *script)
F
Frederic Weisbecker 已提交
757
{
758 759
	int ret;

760 761
	signal(SIGINT, sig_handler);

762 763 764 765 766 767
	/* 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;
	}
768 769 770 771
	if (script->show_mmap_events) {
		script->tool.mmap = process_mmap_event;
		script->tool.mmap2 = process_mmap2_event;
	}
772

773
	ret = perf_session__process_events(script->session, &script->tool);
774

775
	if (debug_mode)
776
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
777 778

	return ret;
F
Frederic Weisbecker 已提交
779 780
}

T
Tom Zanussi 已提交
781 782 783 784 785 786
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
	char			spec[0];
};

787
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
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

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)
827
		return NULL;
T
Tom Zanussi 已提交
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863

	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 "
864
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
865 866 867 868 869 870 871

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

	fprintf(stderr, "\n");
}

872 873
static int parse_scriptname(const struct option *opt __maybe_unused,
			    const char *str, int unset __maybe_unused)
T
Tom Zanussi 已提交
874 875 876 877 878
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

879
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
880
		list_available_languages();
881
		exit(0);
T
Tom Zanussi 已提交
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
	}

	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;
901
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
		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;
}

918 919
static int parse_output_fields(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused)
920 921
{
	char *tok;
922
	int i, imax = ARRAY_SIZE(all_output_options);
923
	int j;
924 925
	int rc = 0;
	char *str = strdup(arg);
926
	int type = -1;
927 928 929 930

	if (!str)
		return -ENOMEM;

931 932 933
	/* 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.
934
	 */
935 936 937 938 939 940 941 942 943 944
	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;
945 946
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
947 948
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
949 950
			rc = -EINVAL;
			goto out;
951 952 953 954 955 956 957 958
		}

		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;
959
		output[type].wildcard_set = false;
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975

	} 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;
976
			output[j].wildcard_set = true;
977
		}
978 979
	}

980 981
	tok = strtok(tok, ",");
	while (tok) {
982
		for (i = 0; i < imax; ++i) {
983
			if (strcmp(tok, all_output_options[i].str) == 0)
984 985 986
				break;
		}
		if (i == imax) {
987
			fprintf(stderr, "Invalid field requested.\n");
988
			rc = -EINVAL;
989
			goto out;
990 991
		}

992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
		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;
		}

		tok = strtok(NULL, ",");
1015 1016
	}

1017 1018 1019 1020 1021 1022
	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));
		}
	}
1023

1024
out:
1025 1026 1027 1028
	free(str);
	return rc;
}

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
/* 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)\
1043 1044
	while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) &&	\
	       lang_next)						\
1045 1046 1047
		if ((lang_dirent.d_type == DT_DIR ||			\
		     (lang_dirent.d_type == DT_UNKNOWN &&		\
		      is_directory(scripts_path, &lang_dirent))) &&	\
1048 1049 1050
		    (strcmp(lang_dirent.d_name, ".")) &&		\
		    (strcmp(lang_dirent.d_name, "..")))

1051
#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
1052 1053
	while (!readdir_r(lang_dir, &script_dirent, &script_next) &&	\
	       script_next)						\
1054 1055 1056
		if (script_dirent.d_type != DT_DIR &&			\
		    (script_dirent.d_type != DT_UNKNOWN ||		\
		     !is_directory(lang_path, &script_dirent)))
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068


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

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

1069
static LIST_HEAD(script_descs);
1070 1071 1072 1073 1074

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

1075
	if (s != NULL && name)
1076 1077 1078 1079 1080 1081 1082
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
1083 1084 1085
	zfree(&s->name);
	zfree(&s->half_liner);
	zfree(&s->args);
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 1123 1124
	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;
}

1125
static const char *ends_with(const char *str, const char *suffix)
1126 1127
{
	size_t suffix_len = strlen(suffix);
1128
	const char *p = str;
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 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179

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

1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
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;
}

1198 1199 1200
static int list_available_scripts(const struct option *opt __maybe_unused,
				  const char *s __maybe_unused,
				  int unset __maybe_unused)
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
{
	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;

	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());

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

1217
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1218 1219 1220 1221 1222 1223
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1224
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1225 1226
			script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
			if (script_root) {
1227 1228 1229 1230
				desc = script_desc__findnew(script_root);
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
				read_script_info(desc, script_path);
1231
				free(script_root);
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
			}
		}
	}

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

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 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
/*
 * 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;
1290
			evlist__for_each(session->evlist, pos) {
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307
				if (!strcmp(perf_evsel__name(pos), evname)) {
					match = 1;
					break;
				}
			}

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

	fclose(fp);
	return 0;
}

1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
/*
 * 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;
1318
	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1319
	DIR *scripts_dir, *lang_dir;
1320
	struct perf_session *session;
1321 1322 1323 1324
	struct perf_data_file file = {
		.path = input_name,
		.mode = PERF_DATA_MODE_READ,
	};
1325 1326 1327
	char *temp;
	int i = 0;

1328
	session = perf_session__new(&file, false, NULL);
1329 1330 1331
	if (!session)
		return -1;

1332 1333 1334
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());

	scripts_dir = opendir(scripts_path);
1335 1336
	if (!scripts_dir) {
		perf_session__delete(session);
1337
		return -1;
1338
	}
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365

	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);
1366 1367 1368 1369 1370

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

1371 1372
			i++;
		}
1373
		closedir(lang_dir);
1374 1375
	}

1376 1377
	closedir(scripts_dir);
	perf_session__delete(session);
1378 1379 1380
	return i;
}

1381 1382 1383 1384 1385 1386 1387
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];
1388
	char *__script_root;
1389 1390 1391 1392 1393 1394 1395

	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());

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

1396
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1397 1398 1399 1400 1401 1402
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1403
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1404 1405 1406
			__script_root = get_script_root(&script_dirent, suffix);
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
1407 1408
				closedir(lang_dir);
				closedir(scripts_dir);
1409 1410
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
1411
				return strdup(script_path);
1412 1413 1414
			}
			free(__script_root);
		}
1415
		closedir(lang_dir);
1416
	}
1417
	closedir(scripts_dir);
1418

1419
	return NULL;
1420 1421
}

1422 1423
static bool is_top_script(const char *script_path)
{
1424
	return ends_with(script_path, "top") == NULL ? false : true;
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
}

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

1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
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 已提交
1463

1464 1465 1466 1467 1468 1469 1470 1471
	system_wide = (argc == 0);

	return 0;
}

int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
{
	bool show_full_info = false;
1472 1473
	bool header = false;
	bool header_only = false;
1474
	bool script_started = false;
1475 1476 1477 1478 1479
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
	struct perf_session *session;
	char *script_path = NULL;
	const char **__argv;
1480
	int i, j, err = 0;
1481 1482 1483 1484 1485 1486 1487 1488
	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,
1489
			.attr		 = process_attr,
1490 1491
			.tracing_data	 = perf_event__process_tracing_data,
			.build_id	 = perf_event__process_build_id,
1492
			.ordered_events	 = true,
1493 1494 1495
			.ordering_requires_timestamps = true,
		},
	};
1496
	const struct option options[] = {
F
Frederic Weisbecker 已提交
1497 1498
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
1499
	OPT_INCR('v', "verbose", &verbose,
1500
		 "be more verbose (show symbol address, etc)"),
1501
	OPT_BOOLEAN('L', "Latency", &latency_format,
1502
		    "show latency attributes (irqs/preemption disabled, etc)"),
1503 1504
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
T
Tom Zanussi 已提交
1505 1506 1507 1508
	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",
1509
		   "generate perf-script.xx script in specified language"),
1510
	OPT_STRING('i', "input", &input_name, "file", "input file name"),
1511 1512
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
1513 1514
	OPT_BOOLEAN(0, "header", &header, "Show data header."),
	OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
1515 1516 1517 1518 1519 1520 1521 1522
	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"),
1523
	OPT_CALLBACK('f', "fields", NULL, "str",
1524 1525 1526
		     "comma separated output fields prepend with 'type:'. "
		     "Valid types: hw,sw,trace,raw. "
		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1527
		     "addr,symoff", parse_output_fields),
1528
	OPT_BOOLEAN('a', "all-cpus", &system_wide,
1529
		    "system-wide collection from all CPUs"),
1530 1531
	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
		   "only consider these symbols"),
1532
	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1533 1534
	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only display events for these comms"),
1535 1536
	OPT_BOOLEAN('I', "show-info", &show_full_info,
		    "display extended information from perf.data file"),
1537 1538
	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
		    "Show the path of [kernel.kallsyms]"),
1539 1540
	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
		    "Show the fork/comm/exit events"),
1541 1542
	OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
		    "Show the mmap events"),
1543
	OPT_END()
1544 1545 1546 1547 1548 1549 1550 1551 1552
	};
	const char * const script_usage[] = {
		"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
	};
1553 1554 1555
	struct perf_data_file file = {
		.mode = PERF_DATA_MODE_READ,
	};
1556

1557 1558
	setup_scripting();

1559
	argc = parse_options(argc, argv, options, script_usage,
1560 1561
			     PARSE_OPT_STOP_AT_NON_OPTION);

1562 1563
	file.path = input_name;

1564 1565 1566 1567
	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);
1568 1569
	}

1570 1571 1572
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
1573
			fprintf(stderr,
1574
				"Please specify a valid report script"
1575
				"(see 'perf script -l' for listing)\n");
1576 1577 1578 1579
			return -1;
		}
	}

1580 1581 1582
	/* make sure PERF_EXEC_PATH is set for scripts */
	perf_set_argv_exec_path(perf_exec_path());

1583
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
1584
		int live_pipe[2];
1585
		int rep_args;
1586 1587
		pid_t pid;

1588 1589 1590 1591 1592
		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) {
			fprintf(stderr, " Couldn't find script %s\n\n See perf"
1593 1594
				" script -l for available scripts.\n", argv[0]);
			usage_with_options(script_usage, options);
1595 1596
		}

1597 1598 1599 1600 1601 1602 1603 1604 1605
		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) {
				fprintf(stderr, " %s script requires options."
1606
					"\n\n See perf script -l for available "
1607
					"scripts and options.\n", argv[0]);
1608
				usage_with_options(script_usage, options);
1609
			}
1610 1611 1612 1613
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
1614
			return -1;
1615 1616 1617 1618 1619
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
1620
			return -1;
1621 1622 1623
		}

		if (!pid) {
1624 1625
			j = 0;

1626 1627 1628
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

1629 1630 1631
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
1632 1633 1634 1635
				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
					err = -1;
					goto out;
				}
1636
			}
1637 1638

			__argv = malloc((argc + 6) * sizeof(const char *));
1639 1640 1641 1642 1643
			if (!__argv) {
				pr_err("malloc failed\n");
				err = -ENOMEM;
				goto out;
			}
1644

1645 1646 1647 1648 1649 1650 1651 1652 1653 1654
			__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;
1655 1656

			execvp("/bin/sh", (char **)__argv);
1657
			free(__argv);
1658 1659 1660 1661 1662 1663
			exit(-1);
		}

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

1664
		__argv = malloc((argc + 4) * sizeof(const char *));
1665 1666 1667 1668 1669 1670
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

1671 1672 1673 1674 1675 1676 1677 1678
		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;
1679 1680

		execvp("/bin/sh", (char **)__argv);
1681
		free(__argv);
1682 1683 1684
		exit(-1);
	}

1685 1686 1687 1688
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
1689

1690 1691
	if (script_path) {
		j = 0;
1692

1693 1694
		if (!rec_script_path)
			system_wide = false;
1695 1696 1697 1698 1699 1700
		else if (!system_wide) {
			if (have_cmd(argc - 1, &argv[1]) != 0) {
				err = -1;
				goto out;
			}
		}
1701

1702
		__argv = malloc((argc + 2) * sizeof(const char *));
1703 1704 1705 1706 1707 1708
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

1709 1710 1711 1712
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
1713
		for (i = 2; i < argc; i++)
1714 1715
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
1716 1717

		execvp("/bin/sh", (char **)__argv);
1718
		free(__argv);
1719 1720
		exit(-1);
	}
T
Tom Zanussi 已提交
1721

1722 1723
	if (!script_name)
		setup_pager();
F
Frederic Weisbecker 已提交
1724

1725
	session = perf_session__new(&file, false, &script.tool);
1726 1727 1728
	if (session == NULL)
		return -ENOMEM;

1729 1730 1731
	if (header || header_only) {
		perf_session__fprintf_info(session, stdout, show_full_info);
		if (header_only)
1732
			goto out_delete;
1733 1734
	}

1735 1736 1737
	if (symbol__init() < 0)
		goto out_delete;

1738 1739
	script.session = session;

1740
	if (cpu_list) {
1741 1742 1743
		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
		if (err < 0)
			goto out_delete;
1744 1745
	}

1746
	if (!no_callchain)
1747 1748 1749 1750
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

T
Tom Zanussi 已提交
1751 1752
	if (generate_script_lang) {
		struct stat perf_stat;
1753 1754
		int input;

1755
		if (output_set_by_user()) {
1756 1757
			fprintf(stderr,
				"custom fields not supported for generated scripts");
1758 1759
			err = -EINVAL;
			goto out_delete;
1760
		}
T
Tom Zanussi 已提交
1761

1762
		input = open(file.path, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
1763
		if (input < 0) {
1764
			err = -errno;
T
Tom Zanussi 已提交
1765
			perror("failed to open file");
1766
			goto out_delete;
T
Tom Zanussi 已提交
1767 1768 1769 1770 1771
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
1772
			goto out_delete;
T
Tom Zanussi 已提交
1773 1774 1775 1776
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
1777
			goto out_delete;
T
Tom Zanussi 已提交
1778 1779 1780 1781 1782
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
1783 1784
			err = -ENOENT;
			goto out_delete;
T
Tom Zanussi 已提交
1785 1786
		}

J
Jiri Olsa 已提交
1787
		err = scripting_ops->generate_script(session->tevent.pevent,
1788
						     "perf-script");
1789
		goto out_delete;
T
Tom Zanussi 已提交
1790 1791 1792
	}

	if (script_name) {
1793
		err = scripting_ops->start_script(script_name, argc, argv);
T
Tom Zanussi 已提交
1794
		if (err)
1795
			goto out_delete;
1796
		pr_debug("perf script started with script %s\n\n", script_name);
1797
		script_started = true;
T
Tom Zanussi 已提交
1798 1799
	}

1800 1801 1802

	err = perf_session__check_output_opt(session);
	if (err < 0)
1803
		goto out_delete;
1804

1805
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
1806

1807
out_delete:
1808
	perf_session__delete(session);
1809 1810 1811

	if (script_started)
		cleanup_scripting();
T
Tom Zanussi 已提交
1812 1813
out:
	return err;
F
Frederic Weisbecker 已提交
1814
}