builtin-script.c 41.2 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 47 48 49 50 51 52 53 54 55 56 57 58
};

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

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

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_SOFTWARE] = {
		.user_set = false,

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

		.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,
	},
104 105 106 107 108 109

	[PERF_TYPE_RAW] = {
		.user_set = false,

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

		.invalid_fields = PERF_OUTPUT_TRACE,
	},
115
};
116

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

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

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

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

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

	if (output[type].user_set) {
155
		evname = perf_evsel__name(evsel);
156 157 158 159 160 161 162 163
		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;
164
	evname = perf_evsel__name(evsel);
165 166 167 168 169 170 171 172 173 174 175 176
	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;

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

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

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

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

	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
215 216
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
					PERF_OUTPUT_TID|PERF_OUTPUT_PID))
217 218 219
		return -EINVAL;

	if (PRINT_FIELD(TIME) &&
220 221
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
					PERF_OUTPUT_TIME))
222 223 224
		return -EINVAL;

	if (PRINT_FIELD(CPU) &&
225 226
		perf_evsel__check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
					PERF_OUTPUT_CPU))
227
		return -EINVAL;
228 229 230 231

	return 0;
}

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
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;
}

250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
/*
 * 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;
276 277 278 279

		if (evsel == NULL)
			continue;

280
		set_print_ip_opts(&evsel->attr);
281 282
	}

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
	/*
	 * 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:
307 308
	return 0;
}
309

310
static void print_sample_start(struct perf_sample *sample,
311
			       struct thread *thread,
312
			       struct perf_evsel *evsel)
313
{
314
	struct perf_event_attr *attr = &evsel->attr;
315 316
	unsigned long secs;
	unsigned long usecs;
317 318 319 320
	unsigned long long nsecs;

	if (PRINT_FIELD(COMM)) {
		if (latency_format)
321
			printf("%8.8s ", thread__comm_str(thread));
322
		else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
323
			printf("%s ", thread__comm_str(thread));
324
		else
325
			printf("%16s ", thread__comm_str(thread));
326
	}
327

328 329 330 331 332 333 334 335 336 337 338 339 340
	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);
	}
341

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

351 352 353 354 355 356 357
static bool is_bts_event(struct perf_event_attr *attr)
{
	return ((attr->type == PERF_TYPE_HARDWARE) &&
		(attr->config & PERF_COUNT_HW_BRANCH_INSTRUCTIONS) &&
		(attr->sample_period == 1));
}

358 359 360 361 362 363 364 365
static bool sample_addr_correlates_sym(struct perf_event_attr *attr)
{
	if ((attr->type == PERF_TYPE_SOFTWARE) &&
	    ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) ||
	     (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) ||
	     (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ)))
		return true;

366 367 368
	if (is_bts_event(attr))
		return true;

369 370 371 372 373
	return false;
}

static void print_sample_addr(union perf_event *event,
			  struct perf_sample *sample,
374
			  struct machine *machine,
375 376 377 378 379 380 381 382 383 384 385
			  struct thread *thread,
			  struct perf_event_attr *attr)
{
	struct addr_location al;
	u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;

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

	if (!sample_addr_correlates_sym(attr))
		return;

386
	thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
387
			      sample->addr, &al);
388
	if (!al.map)
389
		thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE,
390
				      sample->addr, &al);
391 392 393 394 395 396 397 398

	al.cpu = sample->cpu;
	al.sym = NULL;

	if (al.map)
		al.sym = map__find_symbol(al.map, al.addr, NULL);

	if (PRINT_FIELD(SYM)) {
399
		printf(" ");
400 401 402 403
		if (PRINT_FIELD(SYMOFFSET))
			symbol__fprintf_symname_offs(al.sym, &al, stdout);
		else
			symbol__fprintf_symname(al.sym, stdout);
404 405 406
	}

	if (PRINT_FIELD(DSO)) {
407 408 409
		printf(" (");
		map__fprintf_dsoname(al.map, stdout);
		printf(")");
410 411 412
	}
}

413 414 415 416 417 418 419 420 421 422 423 424 425 426
static void print_sample_bts(union perf_event *event,
			     struct perf_sample *sample,
			     struct perf_evsel *evsel,
			     struct machine *machine,
			     struct thread *thread)
{
	struct perf_event_attr *attr = &evsel->attr;

	/* print branch_from information */
	if (PRINT_FIELD(IP)) {
		if (!symbol_conf.use_callchain)
			printf(" ");
		else
			printf("\n");
427
		perf_evsel__print_ip(evsel, event, sample, machine,
428 429
				     output[attr->type].print_ip_opts,
				     PERF_MAX_STACK_DEPTH);
430 431 432 433 434
	}

	printf(" => ");

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

	printf("\n");
}

443 444
static void process_event(union perf_event *event, struct perf_sample *sample,
			  struct perf_evsel *evsel, struct machine *machine,
445 446
			  struct thread *thread,
			  struct addr_location *al __maybe_unused)
447
{
448
	struct perf_event_attr *attr = &evsel->attr;
449

450
	if (output[attr->type].fields == 0)
451 452
		return;

453
	print_sample_start(sample, thread, evsel);
454

455 456 457 458 459
	if (PRINT_FIELD(EVNAME)) {
		const char *evname = perf_evsel__name(evsel);
		printf("%s: ", evname ? evname : "[unknown]");
	}

460 461 462 463 464
	if (is_bts_event(attr)) {
		print_sample_bts(event, sample, evsel, machine, thread);
		return;
	}

465
	if (PRINT_FIELD(TRACE))
466 467
		event_format__print(evsel->tp_format, sample->cpu,
				    sample->raw_data, sample->raw_size);
468
	if (PRINT_FIELD(ADDR))
469
		print_sample_addr(event, sample, machine, thread, attr);
470

471
	if (PRINT_FIELD(IP)) {
472 473 474 475
		if (!symbol_conf.use_callchain)
			printf(" ");
		else
			printf("\n");
476

477
		perf_evsel__print_ip(evsel, event, sample, machine,
478 479
				     output[attr->type].print_ip_opts,
				     PERF_MAX_STACK_DEPTH);
480 481
	}

482
	printf("\n");
483 484
}

485 486 487
static int default_start_script(const char *script __maybe_unused,
				int argc __maybe_unused,
				const char **argv __maybe_unused)
T
Tom Zanussi 已提交
488 489 490 491 492 493 494 495 496
{
	return 0;
}

static int default_stop_script(void)
{
	return 0;
}

497 498
static int default_generate_script(struct pevent *pevent __maybe_unused,
				   const char *outfile __maybe_unused)
T
Tom Zanussi 已提交
499 500 501 502 503 504 505
{
	return 0;
}

static struct scripting_ops default_scripting_ops = {
	.start_script		= default_start_script,
	.stop_script		= default_stop_script,
506
	.process_event		= process_event,
T
Tom Zanussi 已提交
507 508 509 510 511 512 513
	.generate_script	= default_generate_script,
};

static struct scripting_ops	*scripting_ops;

static void setup_scripting(void)
{
514
	setup_perl_scripting();
515
	setup_python_scripting();
516

T
Tom Zanussi 已提交
517 518 519 520 521
	scripting_ops = &default_scripting_ops;
}

static int cleanup_scripting(void)
{
522
	pr_debug("\nperf script stopped\n");
523

T
Tom Zanussi 已提交
524 525 526
	return scripting_ops->stop_script();
}

527
static int process_sample_event(struct perf_tool *tool __maybe_unused,
528
				union perf_event *event,
529
				struct perf_sample *sample,
530
				struct perf_evsel *evsel,
531
				struct machine *machine)
F
Frederic Weisbecker 已提交
532
{
533
	struct addr_location al;
534 535
	struct thread *thread = machine__findnew_thread(machine, sample->pid,
							sample->tid);
536

F
Frederic Weisbecker 已提交
537
	if (thread == NULL) {
538 539
		pr_debug("problem processing %d event, skipping it.\n",
			 event->header.type);
F
Frederic Weisbecker 已提交
540 541 542
		return -1;
	}

543 544 545 546 547 548
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
549
		}
550 551
		last_timestamp = sample->time;
		return 0;
F
Frederic Weisbecker 已提交
552
	}
553

554
	if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
555 556 557 558 559 560 561 562
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
		return -1;
	}

	if (al.filtered)
		return 0;

563 564 565
	if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
		return 0;

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

568
	evsel->hists.stats.total_period += sample->period;
F
Frederic Weisbecker 已提交
569 570 571
	return 0;
}

572 573 574
struct perf_script {
	struct perf_tool	tool;
	struct perf_session	*session;
575
	bool			show_task_events;
576 577
};

578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
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;

	list_for_each_entry(pos, &evlist->entries, node) {
		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);
}

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 689 690 691 692 693 694 695 696 697 698 699 700
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;
}

701
static void sig_handler(int sig __maybe_unused)
702 703 704 705
{
	session_done = 1;
}

706
static int __cmd_script(struct perf_script *script)
F
Frederic Weisbecker 已提交
707
{
708 709
	int ret;

710 711
	signal(SIGINT, sig_handler);

712 713 714 715 716 717 718
	/* 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;
	}

719
	ret = perf_session__process_events(script->session, &script->tool);
720

721
	if (debug_mode)
722
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
723 724

	return ret;
F
Frederic Weisbecker 已提交
725 726
}

T
Tom Zanussi 已提交
727 728 729 730 731 732
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
	char			spec[0];
};

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

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)
773
		return NULL;
T
Tom Zanussi 已提交
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809

	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 "
810
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
811 812 813 814 815 816 817

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

	fprintf(stderr, "\n");
}

818 819
static int parse_scriptname(const struct option *opt __maybe_unused,
			    const char *str, int unset __maybe_unused)
T
Tom Zanussi 已提交
820 821 822 823 824
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

825
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
826
		list_available_languages();
827
		exit(0);
T
Tom Zanussi 已提交
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
	}

	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;
847
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
		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;
}

864 865
static int parse_output_fields(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused)
866 867
{
	char *tok;
868
	int i, imax = ARRAY_SIZE(all_output_options);
869
	int j;
870 871
	int rc = 0;
	char *str = strdup(arg);
872
	int type = -1;
873 874 875 876

	if (!str)
		return -ENOMEM;

877 878 879
	/* 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.
880
	 */
881 882 883 884 885 886 887 888 889 890
	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;
891 892
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
893 894
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
895 896
			rc = -EINVAL;
			goto out;
897 898 899 900 901 902 903 904
		}

		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;
905
		output[type].wildcard_set = false;
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921

	} 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;
922
			output[j].wildcard_set = true;
923
		}
924 925
	}

926 927
	tok = strtok(tok, ",");
	while (tok) {
928
		for (i = 0; i < imax; ++i) {
929
			if (strcmp(tok, all_output_options[i].str) == 0)
930 931 932
				break;
		}
		if (i == imax) {
933
			fprintf(stderr, "Invalid field requested.\n");
934
			rc = -EINVAL;
935
			goto out;
936 937
		}

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
		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, ",");
961 962
	}

963 964 965 966 967 968
	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));
		}
	}
969

970
out:
971 972 973 974
	free(str);
	return rc;
}

975 976 977 978 979 980 981 982 983 984 985 986 987 988
/* 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)\
989 990
	while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) &&	\
	       lang_next)						\
991 992 993
		if ((lang_dirent.d_type == DT_DIR ||			\
		     (lang_dirent.d_type == DT_UNKNOWN &&		\
		      is_directory(scripts_path, &lang_dirent))) &&	\
994 995 996
		    (strcmp(lang_dirent.d_name, ".")) &&		\
		    (strcmp(lang_dirent.d_name, "..")))

997
#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
998 999
	while (!readdir_r(lang_dir, &script_dirent, &script_next) &&	\
	       script_next)						\
1000 1001 1002
		if (script_dirent.d_type != DT_DIR &&			\
		    (script_dirent.d_type != DT_UNKNOWN ||		\
		     !is_directory(lang_path, &script_dirent)))
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014


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

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

1015
static LIST_HEAD(script_descs);
1016 1017 1018 1019 1020

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

1021
	if (s != NULL && name)
1022 1023 1024 1025 1026 1027 1028 1029
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
	free(s->name);
1030 1031
	free(s->half_liner);
	free(s->args);
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
	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;
}

1071
static const char *ends_with(const char *str, const char *suffix)
1072 1073
{
	size_t suffix_len = strlen(suffix);
1074
	const char *p = str;
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125

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

1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
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;
}

1144 1145 1146
static int list_available_scripts(const struct option *opt __maybe_unused,
				  const char *s __maybe_unused,
				  int unset __maybe_unused)
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
{
	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;

1163
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1164 1165 1166 1167 1168 1169
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1170
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1171 1172
			script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
			if (script_root) {
1173 1174 1175 1176
				desc = script_desc__findnew(script_root);
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
				read_script_info(desc, script_path);
1177
				free(script_root);
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
			}
		}
	}

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

1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
/*
 * 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;
			list_for_each_entry(pos,
					&session->evlist->entries, node) {
				if (!strcmp(perf_evsel__name(pos), evname)) {
					match = 1;
					break;
				}
			}

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

	fclose(fp);
	return 0;
}

1255 1256 1257 1258 1259 1260 1261 1262 1263 1264
/*
 * 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;
1265
	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1266
	DIR *scripts_dir, *lang_dir;
1267
	struct perf_session *session;
1268 1269 1270 1271
	struct perf_data_file file = {
		.path = input_name,
		.mode = PERF_DATA_MODE_READ,
	};
1272 1273 1274
	char *temp;
	int i = 0;

1275
	session = perf_session__new(&file, false, NULL);
1276 1277 1278
	if (!session)
		return -1;

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

	scripts_dir = opendir(scripts_path);
1282 1283
	if (!scripts_dir) {
		perf_session__delete(session);
1284
		return -1;
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

	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);
1313 1314 1315 1316 1317

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

1318 1319
			i++;
		}
1320
		closedir(lang_dir);
1321 1322
	}

1323 1324
	closedir(scripts_dir);
	perf_session__delete(session);
1325 1326 1327
	return i;
}

1328 1329 1330 1331 1332 1333 1334
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];
1335
	char *__script_root;
1336 1337 1338 1339 1340 1341 1342

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

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

1343
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1344 1345 1346 1347 1348 1349
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1350
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1351 1352 1353
			__script_root = get_script_root(&script_dirent, suffix);
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
1354 1355
				closedir(lang_dir);
				closedir(scripts_dir);
1356 1357
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
1358
				return strdup(script_path);
1359 1360 1361
			}
			free(__script_root);
		}
1362
		closedir(lang_dir);
1363
	}
1364
	closedir(scripts_dir);
1365

1366
	return NULL;
1367 1368
}

1369 1370
static bool is_top_script(const char *script_path)
{
1371
	return ends_with(script_path, "top") == NULL ? false : true;
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
}

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

1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
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 已提交
1410

1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
	system_wide = (argc == 0);

	return 0;
}

int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
{
	bool show_full_info = false;
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
	struct perf_session *session;
	char *script_path = NULL;
	const char **__argv;
	int i, j, err;
1425 1426 1427 1428 1429 1430 1431 1432
	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,
1433
			.attr		 = process_attr,
1434 1435 1436 1437 1438 1439
			.tracing_data	 = perf_event__process_tracing_data,
			.build_id	 = perf_event__process_build_id,
			.ordered_samples = true,
			.ordering_requires_timestamps = true,
		},
	};
1440
	const struct option options[] = {
F
Frederic Weisbecker 已提交
1441 1442
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
1443
	OPT_INCR('v', "verbose", &verbose,
1444
		 "be more verbose (show symbol address, etc)"),
1445
	OPT_BOOLEAN('L', "Latency", &latency_format,
1446
		    "show latency attributes (irqs/preemption disabled, etc)"),
1447 1448
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
T
Tom Zanussi 已提交
1449 1450 1451 1452
	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",
1453
		   "generate perf-script.xx script in specified language"),
1454
	OPT_STRING('i', "input", &input_name, "file", "input file name"),
1455 1456
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
1457 1458 1459 1460 1461 1462 1463 1464
	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"),
1465
	OPT_CALLBACK('f', "fields", NULL, "str",
1466 1467 1468
		     "comma separated output fields prepend with 'type:'. "
		     "Valid types: hw,sw,trace,raw. "
		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1469
		     "addr,symoff", parse_output_fields),
1470
	OPT_BOOLEAN('a', "all-cpus", &system_wide,
1471
		    "system-wide collection from all CPUs"),
1472 1473
	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
		   "only consider these symbols"),
1474
	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1475 1476
	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only display events for these comms"),
1477 1478
	OPT_BOOLEAN('I', "show-info", &show_full_info,
		    "display extended information from perf.data file"),
1479 1480
	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
		    "Show the path of [kernel.kallsyms]"),
1481 1482
	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
		    "Show the fork/comm/exit events"),
1483
	OPT_END()
1484 1485 1486 1487 1488 1489 1490 1491 1492
	};
	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
	};
1493 1494 1495
	struct perf_data_file file = {
		.mode = PERF_DATA_MODE_READ,
	};
1496

1497 1498
	setup_scripting();

1499
	argc = parse_options(argc, argv, options, script_usage,
1500 1501
			     PARSE_OPT_STOP_AT_NON_OPTION);

1502 1503
	file.path = input_name;

1504 1505 1506 1507
	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);
1508 1509
	}

1510 1511 1512
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
1513
			fprintf(stderr,
1514
				"Please specify a valid report script"
1515
				"(see 'perf script -l' for listing)\n");
1516 1517 1518 1519
			return -1;
		}
	}

1520 1521 1522
	/* make sure PERF_EXEC_PATH is set for scripts */
	perf_set_argv_exec_path(perf_exec_path());

1523
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
1524
		int live_pipe[2];
1525
		int rep_args;
1526 1527
		pid_t pid;

1528 1529 1530 1531 1532
		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"
1533 1534
				" script -l for available scripts.\n", argv[0]);
			usage_with_options(script_usage, options);
1535 1536
		}

1537 1538 1539 1540 1541 1542 1543 1544 1545
		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."
1546
					"\n\n See perf script -l for available "
1547
					"scripts and options.\n", argv[0]);
1548
				usage_with_options(script_usage, options);
1549
			}
1550 1551 1552 1553
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
1554
			return -1;
1555 1556 1557 1558 1559
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
1560
			return -1;
1561 1562 1563
		}

		if (!pid) {
1564 1565
			j = 0;

1566 1567 1568
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

1569 1570 1571
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
1572 1573 1574 1575
				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
					err = -1;
					goto out;
				}
1576
			}
1577 1578

			__argv = malloc((argc + 6) * sizeof(const char *));
1579 1580 1581 1582 1583
			if (!__argv) {
				pr_err("malloc failed\n");
				err = -ENOMEM;
				goto out;
			}
1584

1585 1586 1587 1588 1589 1590 1591 1592 1593 1594
			__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;
1595 1596

			execvp("/bin/sh", (char **)__argv);
1597
			free(__argv);
1598 1599 1600 1601 1602 1603
			exit(-1);
		}

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

1604
		__argv = malloc((argc + 4) * sizeof(const char *));
1605 1606 1607 1608 1609 1610
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

1611 1612 1613 1614 1615 1616 1617 1618
		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;
1619 1620

		execvp("/bin/sh", (char **)__argv);
1621
		free(__argv);
1622 1623 1624
		exit(-1);
	}

1625 1626 1627 1628
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
1629

1630 1631
	if (script_path) {
		j = 0;
1632

1633 1634
		if (!rec_script_path)
			system_wide = false;
1635 1636 1637 1638 1639 1640
		else if (!system_wide) {
			if (have_cmd(argc - 1, &argv[1]) != 0) {
				err = -1;
				goto out;
			}
		}
1641

1642
		__argv = malloc((argc + 2) * sizeof(const char *));
1643 1644 1645 1646 1647 1648
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

1649 1650 1651 1652
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
1653
		for (i = 2; i < argc; i++)
1654 1655
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
1656 1657

		execvp("/bin/sh", (char **)__argv);
1658
		free(__argv);
1659 1660
		exit(-1);
	}
T
Tom Zanussi 已提交
1661

1662 1663
	if (symbol__init() < 0)
		return -1;
1664 1665
	if (!script_name)
		setup_pager();
F
Frederic Weisbecker 已提交
1666

1667
	session = perf_session__new(&file, false, &script.tool);
1668 1669 1670
	if (session == NULL)
		return -ENOMEM;

1671 1672
	script.session = session;

1673 1674 1675 1676 1677
	if (cpu_list) {
		if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
			return -1;
	}

1678 1679
	if (!script_name && !generate_script_lang)
		perf_session__fprintf_info(session, stdout, show_full_info);
1680

1681
	if (!no_callchain)
1682 1683 1684 1685
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

T
Tom Zanussi 已提交
1686 1687
	if (generate_script_lang) {
		struct stat perf_stat;
1688 1689
		int input;

1690
		if (output_set_by_user()) {
1691 1692 1693 1694
			fprintf(stderr,
				"custom fields not supported for generated scripts");
			return -1;
		}
T
Tom Zanussi 已提交
1695

1696
		input = open(file.path, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
1697 1698
		if (input < 0) {
			perror("failed to open file");
1699
			return -1;
T
Tom Zanussi 已提交
1700 1701 1702 1703 1704
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
1705
			return -1;
T
Tom Zanussi 已提交
1706 1707 1708 1709
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
1710
			return 0;
T
Tom Zanussi 已提交
1711 1712 1713 1714 1715 1716 1717 1718
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
			return -1;
		}

1719 1720
		err = scripting_ops->generate_script(session->pevent,
						     "perf-script");
T
Tom Zanussi 已提交
1721 1722 1723 1724
		goto out;
	}

	if (script_name) {
1725
		err = scripting_ops->start_script(script_name, argc, argv);
T
Tom Zanussi 已提交
1726 1727
		if (err)
			goto out;
1728
		pr_debug("perf script started with script %s\n\n", script_name);
T
Tom Zanussi 已提交
1729 1730
	}

1731 1732 1733 1734 1735

	err = perf_session__check_output_opt(session);
	if (err < 0)
		goto out;

1736
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
1737

1738
	perf_session__delete(session);
T
Tom Zanussi 已提交
1739 1740 1741
	cleanup_scripting();
out:
	return err;
F
Frederic Weisbecker 已提交
1742
}