builtin-script.c 44.5 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 "util/auxtrace.h"
20
#include <linux/bitmap.h>
F
Frederic Weisbecker 已提交
21

T
Tom Zanussi 已提交
22 23
static char const		*script_name;
static char const		*generate_script_lang;
24
static bool			debug_mode;
25
static u64			last_timestamp;
26
static u64			nr_unordered;
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,
J
Jiri Olsa 已提交
47
	PERF_OUTPUT_PERIOD          = 1U << 13,
48 49 50 51 52 53 54 55 56 57 58 59 60
};

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},
61
	{.str = "ip",    .field = PERF_OUTPUT_IP},
62
	{.str = "sym",   .field = PERF_OUTPUT_SYM},
63
	{.str = "dso",   .field = PERF_OUTPUT_DSO},
64
	{.str = "addr",  .field = PERF_OUTPUT_ADDR},
65
	{.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
66
	{.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
J
Jiri Olsa 已提交
67
	{.str = "period", .field = PERF_OUTPUT_PERIOD},
68 69 70
};

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

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_SOFTWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
96
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
97 98
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
			      PERF_OUTPUT_PERIOD,
99 100 101 102 103 104 105 106 107 108 109

		.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,
	},
110 111 112 113 114 115

	[PERF_TYPE_RAW] = {
		.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

		.invalid_fields = PERF_OUTPUT_TRACE,
	},
122
};
123

124 125 126 127 128 129 130 131 132
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;
}
133

134 135 136 137 138 139 140 141 142 143 144 145 146 147
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;
}

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

150 151 152
static int perf_evsel__check_stype(struct perf_evsel *evsel,
				   u64 sample_type, const char *sample_msg,
				   enum perf_output_field field)
153
{
154
	struct perf_event_attr *attr = &evsel->attr;
155 156 157 158 159 160 161
	int type = attr->type;
	const char *evname;

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

	if (output[type].user_set) {
162
		evname = perf_evsel__name(evsel);
163 164 165 166 167 168 169 170
		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;
171
	evname = perf_evsel__name(evsel);
172 173 174 175 176 177 178 179 180 181 182 183
	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;

184 185 186 187
	if (PRINT_FIELD(TRACE) &&
		!perf_session__has_traces(session, "record -R"))
		return -EINVAL;

188
	if (PRINT_FIELD(IP)) {
189 190
		if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
					    PERF_OUTPUT_IP))
191 192
			return -EINVAL;
	}
193 194

	if (PRINT_FIELD(ADDR) &&
195 196
		perf_evsel__check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
					PERF_OUTPUT_ADDR))
197 198 199 200 201 202
		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");
203 204
		return -EINVAL;
	}
205 206 207 208 209
	if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
		pr_err("Display of offsets requested but symbol is not"
		       "selected.\n");
		return -EINVAL;
	}
210 211 212 213
	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");
214 215
		return -EINVAL;
	}
216 217 218 219 220
	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;
	}
221 222

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

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

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

J
Jiri Olsa 已提交
237 238 239 240 241
	if (PRINT_FIELD(PERIOD) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD",
					PERF_OUTPUT_PERIOD))
		return -EINVAL;

242 243 244
	return 0;
}

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
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;
261 262 263

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

266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
/*
 * 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;
292 293 294 295

		if (evsel == NULL)
			continue;

296
		set_print_ip_opts(&evsel->attr);
297 298
	}

299 300 301 302 303 304 305 306 307 308 309 310 311
	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;
	}

312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
	/*
	 * 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:
336 337
	return 0;
}
338

339
static void print_sample_start(struct perf_sample *sample,
340
			       struct thread *thread,
341
			       struct perf_evsel *evsel)
342
{
343
	struct perf_event_attr *attr = &evsel->attr;
344 345
	unsigned long secs;
	unsigned long usecs;
346 347 348 349
	unsigned long long nsecs;

	if (PRINT_FIELD(COMM)) {
		if (latency_format)
350
			printf("%8.8s ", thread__comm_str(thread));
351
		else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
352
			printf("%s ", thread__comm_str(thread));
353
		else
354
			printf("%16s ", thread__comm_str(thread));
355
	}
356

357 358 359 360 361 362 363 364 365 366 367 368 369
	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);
	}
370

371 372 373 374 375 376 377
	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);
	}
378 379
}

380 381 382 383 384 385 386 387 388 389 390 391
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;

392
	perf_event__preprocess_sample_addr(event, sample, thread, &al);
393 394

	if (PRINT_FIELD(SYM)) {
395
		printf(" ");
396 397 398 399
		if (PRINT_FIELD(SYMOFFSET))
			symbol__fprintf_symname_offs(al.sym, &al, stdout);
		else
			symbol__fprintf_symname(al.sym, stdout);
400 401 402
	}

	if (PRINT_FIELD(DSO)) {
403 404 405
		printf(" (");
		map__fprintf_dsoname(al.map, stdout);
		printf(")");
406 407 408
	}
}

409 410 411
static void print_sample_bts(union perf_event *event,
			     struct perf_sample *sample,
			     struct perf_evsel *evsel,
412 413
			     struct thread *thread,
			     struct addr_location *al)
414 415
{
	struct perf_event_attr *attr = &evsel->attr;
416
	bool print_srcline_last = false;
417 418 419

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

		if (symbol_conf.use_callchain && sample->callchain) {
423
			printf("\n");
424 425 426 427 428 429 430 431
		} 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,
432
				     PERF_MAX_STACK_DEPTH);
433 434 435
	}

	/* print branch_to information */
436 437
	if (PRINT_FIELD(ADDR) ||
	    ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
438 439
	     !output[attr->type].user_set)) {
		printf(" => ");
440
		print_sample_addr(event, sample, thread, attr);
441
	}
442

443 444 445
	if (print_srcline_last)
		map__fprintf_srcline(al->map, al->addr, "\n  ", stdout);

446 447 448
	printf("\n");
}

449
static void process_event(union perf_event *event, struct perf_sample *sample,
450
			  struct perf_evsel *evsel, struct addr_location *al)
451
{
452
	struct thread *thread = al->thread;
453
	struct perf_event_attr *attr = &evsel->attr;
454

455
	if (output[attr->type].fields == 0)
456 457
		return;

458
	print_sample_start(sample, thread, evsel);
459

J
Jiri Olsa 已提交
460 461 462
	if (PRINT_FIELD(PERIOD))
		printf("%10" PRIu64 " ", sample->period);

463 464 465 466 467
	if (PRINT_FIELD(EVNAME)) {
		const char *evname = perf_evsel__name(evsel);
		printf("%s: ", evname ? evname : "[unknown]");
	}

468
	if (is_bts_event(attr)) {
469
		print_sample_bts(event, sample, evsel, thread, al);
470 471 472
		return;
	}

473
	if (PRINT_FIELD(TRACE))
474 475
		event_format__print(evsel->tp_format, sample->cpu,
				    sample->raw_data, sample->raw_size);
476
	if (PRINT_FIELD(ADDR))
477
		print_sample_addr(event, sample, thread, attr);
478

479
	if (PRINT_FIELD(IP)) {
480 481 482 483
		if (!symbol_conf.use_callchain)
			printf(" ");
		else
			printf("\n");
484

485
		perf_evsel__print_ip(evsel, sample, al,
486 487
				     output[attr->type].print_ip_opts,
				     PERF_MAX_STACK_DEPTH);
488 489
	}

490
	printf("\n");
491 492
}

493 494 495
static int default_start_script(const char *script __maybe_unused,
				int argc __maybe_unused,
				const char **argv __maybe_unused)
T
Tom Zanussi 已提交
496 497 498 499
{
	return 0;
}

500 501 502 503 504
static int default_flush_script(void)
{
	return 0;
}

T
Tom Zanussi 已提交
505 506 507 508 509
static int default_stop_script(void)
{
	return 0;
}

510 511
static int default_generate_script(struct pevent *pevent __maybe_unused,
				   const char *outfile __maybe_unused)
T
Tom Zanussi 已提交
512 513 514 515 516 517
{
	return 0;
}

static struct scripting_ops default_scripting_ops = {
	.start_script		= default_start_script,
518
	.flush_script		= default_flush_script,
T
Tom Zanussi 已提交
519
	.stop_script		= default_stop_script,
520
	.process_event		= process_event,
T
Tom Zanussi 已提交
521 522 523 524 525 526 527
	.generate_script	= default_generate_script,
};

static struct scripting_ops	*scripting_ops;

static void setup_scripting(void)
{
528
	setup_perl_scripting();
529
	setup_python_scripting();
530

T
Tom Zanussi 已提交
531 532 533
	scripting_ops = &default_scripting_ops;
}

534 535 536 537 538
static int flush_scripting(void)
{
	return scripting_ops->flush_script();
}

T
Tom Zanussi 已提交
539 540
static int cleanup_scripting(void)
{
541
	pr_debug("\nperf script stopped\n");
542

T
Tom Zanussi 已提交
543 544 545
	return scripting_ops->stop_script();
}

546
static int process_sample_event(struct perf_tool *tool __maybe_unused,
547
				union perf_event *event,
548
				struct perf_sample *sample,
549
				struct perf_evsel *evsel,
550
				struct machine *machine)
F
Frederic Weisbecker 已提交
551
{
552
	struct addr_location al;
F
Frederic Weisbecker 已提交
553

554 555 556 557 558 559
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
560
		}
561 562
		last_timestamp = sample->time;
		return 0;
F
Frederic Weisbecker 已提交
563
	}
564

565
	if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
566 567 568 569 570 571 572 573
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
		return -1;
	}

	if (al.filtered)
		return 0;

574 575 576
	if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
		return 0;

577
	scripting_ops->process_event(event, sample, evsel, &al);
F
Frederic Weisbecker 已提交
578 579 580 581

	return 0;
}

582 583 584
struct perf_script {
	struct perf_tool	tool;
	struct perf_session	*session;
585
	bool			show_task_events;
586
	bool			show_mmap_events;
587 588
};

589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
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;

607
	evlist__for_each(evlist, pos) {
608 609 610 611 612 613 614 615 616
		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);
}

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 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
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;
}

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 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
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;
}

774
static void sig_handler(int sig __maybe_unused)
775 776 777 778
{
	session_done = 1;
}

779
static int __cmd_script(struct perf_script *script)
F
Frederic Weisbecker 已提交
780
{
781 782
	int ret;

783 784
	signal(SIGINT, sig_handler);

785 786 787 788 789 790
	/* 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;
	}
791 792 793 794
	if (script->show_mmap_events) {
		script->tool.mmap = process_mmap_event;
		script->tool.mmap2 = process_mmap2_event;
	}
795

796
	ret = perf_session__process_events(script->session);
797

798
	if (debug_mode)
799
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
800 801

	return ret;
F
Frederic Weisbecker 已提交
802 803
}

T
Tom Zanussi 已提交
804 805 806 807 808 809
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
	char			spec[0];
};

810
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849

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)
850
		return NULL;
T
Tom Zanussi 已提交
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886

	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 "
887
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
888 889 890 891 892 893 894

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

	fprintf(stderr, "\n");
}

895 896
static int parse_scriptname(const struct option *opt __maybe_unused,
			    const char *str, int unset __maybe_unused)
T
Tom Zanussi 已提交
897 898 899 900 901
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

902
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
903
		list_available_languages();
904
		exit(0);
T
Tom Zanussi 已提交
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
	}

	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;
924
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
		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;
}

941 942
static int parse_output_fields(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused)
943 944
{
	char *tok;
945
	int i, imax = ARRAY_SIZE(all_output_options);
946
	int j;
947 948
	int rc = 0;
	char *str = strdup(arg);
949
	int type = -1;
950 951 952 953

	if (!str)
		return -ENOMEM;

954 955 956
	/* 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.
957
	 */
958 959 960 961 962 963 964 965 966 967
	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;
968 969
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
970 971
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
972 973
			rc = -EINVAL;
			goto out;
974 975 976 977 978 979 980 981
		}

		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;
982
		output[type].wildcard_set = false;
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998

	} 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;
999
			output[j].wildcard_set = true;
1000
		}
1001 1002
	}

1003 1004
	tok = strtok(tok, ",");
	while (tok) {
1005
		for (i = 0; i < imax; ++i) {
1006
			if (strcmp(tok, all_output_options[i].str) == 0)
1007 1008 1009
				break;
		}
		if (i == imax) {
1010
			fprintf(stderr, "Invalid field requested.\n");
1011
			rc = -EINVAL;
1012
			goto out;
1013 1014
		}

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
		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, ",");
1038 1039
	}

1040 1041 1042 1043 1044 1045
	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));
		}
	}
1046

1047
out:
1048 1049 1050 1051
	free(str);
	return rc;
}

1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
/* 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)\
1066 1067
	while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) &&	\
	       lang_next)						\
1068 1069 1070
		if ((lang_dirent.d_type == DT_DIR ||			\
		     (lang_dirent.d_type == DT_UNKNOWN &&		\
		      is_directory(scripts_path, &lang_dirent))) &&	\
1071 1072 1073
		    (strcmp(lang_dirent.d_name, ".")) &&		\
		    (strcmp(lang_dirent.d_name, "..")))

1074
#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
1075 1076
	while (!readdir_r(lang_dir, &script_dirent, &script_next) &&	\
	       script_next)						\
1077 1078 1079
		if (script_dirent.d_type != DT_DIR &&			\
		    (script_dirent.d_type != DT_UNKNOWN ||		\
		     !is_directory(lang_path, &script_dirent)))
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091


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

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

1092
static LIST_HEAD(script_descs);
1093 1094 1095 1096 1097

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

1098
	if (s != NULL && name)
1099 1100 1101 1102 1103 1104 1105
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
1106 1107 1108
	zfree(&s->name);
	zfree(&s->half_liner);
	zfree(&s->args);
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
	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;
}

1148
static const char *ends_with(const char *str, const char *suffix)
1149 1150
{
	size_t suffix_len = strlen(suffix);
1151
	const char *p = str;
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 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202

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

1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
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;
}

1221 1222 1223
static int list_available_scripts(const struct option *opt __maybe_unused,
				  const char *s __maybe_unused,
				  int unset __maybe_unused)
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
{
	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;

1240
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1241 1242 1243 1244 1245 1246
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1247
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1248 1249
			script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
			if (script_root) {
1250 1251 1252 1253
				desc = script_desc__findnew(script_root);
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
				read_script_info(desc, script_path);
1254
				free(script_root);
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
			}
		}
	}

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

1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
/*
 * 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;
1313
			evlist__for_each(session->evlist, pos) {
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
				if (!strcmp(perf_evsel__name(pos), evname)) {
					match = 1;
					break;
				}
			}

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

	fclose(fp);
	return 0;
}

1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
/*
 * 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;
1341
	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1342
	DIR *scripts_dir, *lang_dir;
1343
	struct perf_session *session;
1344 1345 1346 1347
	struct perf_data_file file = {
		.path = input_name,
		.mode = PERF_DATA_MODE_READ,
	};
1348 1349 1350
	char *temp;
	int i = 0;

1351
	session = perf_session__new(&file, false, NULL);
1352 1353 1354
	if (!session)
		return -1;

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

	scripts_dir = opendir(scripts_path);
1358 1359
	if (!scripts_dir) {
		perf_session__delete(session);
1360
		return -1;
1361
	}
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388

	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);
1389 1390 1391 1392 1393

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

1394 1395
			i++;
		}
1396
		closedir(lang_dir);
1397 1398
	}

1399 1400
	closedir(scripts_dir);
	perf_session__delete(session);
1401 1402 1403
	return i;
}

1404 1405 1406 1407 1408 1409 1410
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];
1411
	char *__script_root;
1412 1413 1414 1415 1416 1417 1418

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

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

1419
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1420 1421 1422 1423 1424 1425
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1426
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1427 1428 1429
			__script_root = get_script_root(&script_dirent, suffix);
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
1430 1431
				closedir(lang_dir);
				closedir(scripts_dir);
1432 1433
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
1434
				return strdup(script_path);
1435 1436 1437
			}
			free(__script_root);
		}
1438
		closedir(lang_dir);
1439
	}
1440
	closedir(scripts_dir);
1441

1442
	return NULL;
1443 1444
}

1445 1446
static bool is_top_script(const char *script_path)
{
1447
	return ends_with(script_path, "top") == NULL ? false : true;
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
}

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

1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
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 已提交
1486

1487 1488 1489 1490 1491 1492 1493 1494
	system_wide = (argc == 0);

	return 0;
}

int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
{
	bool show_full_info = false;
1495 1496
	bool header = false;
	bool header_only = false;
1497
	bool script_started = false;
1498 1499 1500
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
	struct perf_session *session;
1501
	struct itrace_synth_opts itrace_synth_opts = { .set = false, };
1502 1503
	char *script_path = NULL;
	const char **__argv;
1504
	int i, j, err = 0;
1505 1506 1507 1508 1509 1510 1511 1512
	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,
1513
			.attr		 = process_attr,
1514 1515
			.tracing_data	 = perf_event__process_tracing_data,
			.build_id	 = perf_event__process_build_id,
1516 1517 1518 1519
			.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,
1520
			.ordered_events	 = true,
1521 1522 1523
			.ordering_requires_timestamps = true,
		},
	};
1524 1525 1526
	struct perf_data_file file = {
		.mode = PERF_DATA_MODE_READ,
	};
1527
	const struct option options[] = {
F
Frederic Weisbecker 已提交
1528 1529
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
1530
	OPT_INCR('v', "verbose", &verbose,
1531
		 "be more verbose (show symbol address, etc)"),
1532
	OPT_BOOLEAN('L', "Latency", &latency_format,
1533
		    "show latency attributes (irqs/preemption disabled, etc)"),
1534 1535
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
T
Tom Zanussi 已提交
1536 1537 1538 1539
	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",
1540
		   "generate perf-script.xx script in specified language"),
1541
	OPT_STRING('i', "input", &input_name, "file", "input file name"),
1542 1543
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
1544 1545
	OPT_BOOLEAN(0, "header", &header, "Show data header."),
	OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
1546 1547 1548 1549 1550 1551 1552 1553
	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"),
1554
	OPT_CALLBACK('F', "fields", NULL, "str",
1555 1556 1557
		     "comma separated output fields prepend with 'type:'. "
		     "Valid types: hw,sw,trace,raw. "
		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
J
Jiri Olsa 已提交
1558
		     "addr,symoff,period", parse_output_fields),
1559
	OPT_BOOLEAN('a', "all-cpus", &system_wide,
1560
		    "system-wide collection from all CPUs"),
1561 1562
	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
		   "only consider these symbols"),
1563
	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1564 1565
	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only display events for these comms"),
1566 1567 1568 1569
	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"),
1570 1571
	OPT_BOOLEAN('I', "show-info", &show_full_info,
		    "display extended information from perf.data file"),
1572 1573
	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
		    "Show the path of [kernel.kallsyms]"),
1574 1575
	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
		    "Show the fork/comm/exit events"),
1576 1577
	OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
		    "Show the mmap events"),
1578
	OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
1579 1580 1581
	OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
			    "Instruction Tracing options",
			    itrace_parse_synth_opts),
1582
	OPT_END()
1583
	};
1584 1585
	const char * const script_subcommands[] = { "record", "report", NULL };
	const char *script_usage[] = {
1586 1587 1588 1589 1590 1591 1592
		"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
	};
1593

1594 1595
	setup_scripting();

1596
	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
1597 1598
			     PARSE_OPT_STOP_AT_NON_OPTION);

1599 1600
	file.path = input_name;

1601 1602 1603 1604
	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);
1605 1606
	}

1607 1608 1609
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
1610
			fprintf(stderr,
1611
				"Please specify a valid report script"
1612
				"(see 'perf script -l' for listing)\n");
1613 1614 1615 1616
			return -1;
		}
	}

1617 1618 1619
	/* make sure PERF_EXEC_PATH is set for scripts */
	perf_set_argv_exec_path(perf_exec_path());

1620
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
1621
		int live_pipe[2];
1622
		int rep_args;
1623 1624
		pid_t pid;

1625 1626 1627 1628 1629
		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"
1630 1631
				" script -l for available scripts.\n", argv[0]);
			usage_with_options(script_usage, options);
1632 1633
		}

1634 1635 1636 1637 1638 1639 1640 1641 1642
		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."
1643
					"\n\n See perf script -l for available "
1644
					"scripts and options.\n", argv[0]);
1645
				usage_with_options(script_usage, options);
1646
			}
1647 1648 1649 1650
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
1651
			return -1;
1652 1653 1654 1655 1656
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
1657
			return -1;
1658 1659 1660
		}

		if (!pid) {
1661 1662
			j = 0;

1663 1664 1665
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

1666 1667 1668
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
1669 1670 1671 1672
				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
					err = -1;
					goto out;
				}
1673
			}
1674 1675

			__argv = malloc((argc + 6) * sizeof(const char *));
1676 1677 1678 1679 1680
			if (!__argv) {
				pr_err("malloc failed\n");
				err = -ENOMEM;
				goto out;
			}
1681

1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
			__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;
1692 1693

			execvp("/bin/sh", (char **)__argv);
1694
			free(__argv);
1695 1696 1697 1698 1699 1700
			exit(-1);
		}

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

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

1708 1709 1710 1711 1712 1713 1714 1715
		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;
1716 1717

		execvp("/bin/sh", (char **)__argv);
1718
		free(__argv);
1719 1720 1721
		exit(-1);
	}

1722 1723 1724 1725
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
1726

1727 1728
	if (script_path) {
		j = 0;
1729

1730 1731
		if (!rec_script_path)
			system_wide = false;
1732 1733 1734 1735 1736 1737
		else if (!system_wide) {
			if (have_cmd(argc - 1, &argv[1]) != 0) {
				err = -1;
				goto out;
			}
		}
1738

1739
		__argv = malloc((argc + 2) * sizeof(const char *));
1740 1741 1742 1743 1744 1745
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

1746 1747 1748 1749
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
1750
		for (i = 2; i < argc; i++)
1751 1752
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
1753 1754

		execvp("/bin/sh", (char **)__argv);
1755
		free(__argv);
1756 1757
		exit(-1);
	}
T
Tom Zanussi 已提交
1758

1759 1760
	if (!script_name)
		setup_pager();
F
Frederic Weisbecker 已提交
1761

1762
	session = perf_session__new(&file, false, &script.tool);
1763
	if (session == NULL)
1764
		return -1;
1765

1766 1767 1768
	if (header || header_only) {
		perf_session__fprintf_info(session, stdout, show_full_info);
		if (header_only)
1769
			goto out_delete;
1770 1771
	}

1772
	if (symbol__init(&session->header.env) < 0)
1773 1774
		goto out_delete;

1775 1776
	script.session = session;

1777 1778
	session->itrace_synth_opts = &itrace_synth_opts;

1779
	if (cpu_list) {
1780 1781 1782
		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
		if (err < 0)
			goto out_delete;
1783 1784
	}

1785
	if (!no_callchain)
1786 1787 1788 1789
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

T
Tom Zanussi 已提交
1790 1791
	if (generate_script_lang) {
		struct stat perf_stat;
1792 1793
		int input;

1794
		if (output_set_by_user()) {
1795 1796
			fprintf(stderr,
				"custom fields not supported for generated scripts");
1797 1798
			err = -EINVAL;
			goto out_delete;
1799
		}
T
Tom Zanussi 已提交
1800

1801
		input = open(file.path, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
1802
		if (input < 0) {
1803
			err = -errno;
T
Tom Zanussi 已提交
1804
			perror("failed to open file");
1805
			goto out_delete;
T
Tom Zanussi 已提交
1806 1807 1808 1809 1810
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
1811
			goto out_delete;
T
Tom Zanussi 已提交
1812 1813 1814 1815
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
1816
			goto out_delete;
T
Tom Zanussi 已提交
1817 1818 1819 1820 1821
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
1822 1823
			err = -ENOENT;
			goto out_delete;
T
Tom Zanussi 已提交
1824 1825
		}

J
Jiri Olsa 已提交
1826
		err = scripting_ops->generate_script(session->tevent.pevent,
1827
						     "perf-script");
1828
		goto out_delete;
T
Tom Zanussi 已提交
1829 1830 1831
	}

	if (script_name) {
1832
		err = scripting_ops->start_script(script_name, argc, argv);
T
Tom Zanussi 已提交
1833
		if (err)
1834
			goto out_delete;
1835
		pr_debug("perf script started with script %s\n\n", script_name);
1836
		script_started = true;
T
Tom Zanussi 已提交
1837 1838
	}

1839 1840 1841

	err = perf_session__check_output_opt(session);
	if (err < 0)
1842
		goto out_delete;
1843

1844
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
1845

1846 1847
	flush_scripting();

1848
out_delete:
1849
	perf_session__delete(session);
1850 1851 1852

	if (script_started)
		cleanup_scripting();
T
Tom Zanussi 已提交
1853 1854
out:
	return err;
F
Frederic Weisbecker 已提交
1855
}