builtin-script.c 31.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 <linux/bitmap.h>
F
Frederic Weisbecker 已提交
18

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

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

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},
56
	{.str = "ip",    .field = PERF_OUTPUT_IP},
57
	{.str = "sym",   .field = PERF_OUTPUT_SYM},
58
	{.str = "dso",   .field = PERF_OUTPUT_DSO},
59
	{.str = "addr",  .field = PERF_OUTPUT_ADDR},
60 61 62
};

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

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_SOFTWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
86
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
87
				  PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
88 89 90 91 92 93 94 95 96 97 98

		.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,
	},
99 100 101 102 103 104

	[PERF_TYPE_RAW] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
105
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
106
				  PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
107 108 109

		.invalid_fields = PERF_OUTPUT_TRACE,
	},
110
};
111

112 113 114 115 116 117 118 119 120
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;
}
121

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

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

138 139 140
static int perf_event_attr__check_stype(struct perf_event_attr *attr,
				  u64 sample_type, const char *sample_msg,
				  enum perf_output_field field)
141
{
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
	int type = attr->type;
	const char *evname;

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

	if (output[type].user_set) {
		evname = __event_name(attr->type, attr->config);
		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;
	evname = __event_name(attr->type, attr->config);
	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;

171 172 173 174
	if (PRINT_FIELD(TRACE) &&
		!perf_session__has_traces(session, "record -R"))
		return -EINVAL;

175
	if (PRINT_FIELD(IP)) {
176
		if (perf_event_attr__check_stype(attr, PERF_SAMPLE_IP, "IP",
177
					   PERF_OUTPUT_IP))
178
			return -EINVAL;
179

180
		if (!no_callchain &&
181
		    !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
182 183
			symbol_conf.use_callchain = false;
	}
184 185 186 187 188 189 190 191 192 193

	if (PRINT_FIELD(ADDR) &&
		perf_event_attr__check_stype(attr, PERF_SAMPLE_ADDR, "ADDR",
				       PERF_OUTPUT_ADDR))
		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");
194 195
		return -EINVAL;
	}
196 197 198 199
	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");
200 201
		return -EINVAL;
	}
202 203

	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
204 205
		perf_event_attr__check_stype(attr, PERF_SAMPLE_TID, "TID",
				       PERF_OUTPUT_TID|PERF_OUTPUT_PID))
206 207 208
		return -EINVAL;

	if (PRINT_FIELD(TIME) &&
209 210
		perf_event_attr__check_stype(attr, PERF_SAMPLE_TIME, "TIME",
				       PERF_OUTPUT_TIME))
211 212 213
		return -EINVAL;

	if (PRINT_FIELD(CPU) &&
214 215
		perf_event_attr__check_stype(attr, PERF_SAMPLE_CPU, "CPU",
				       PERF_OUTPUT_CPU))
216
		return -EINVAL;
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246

	return 0;
}

/*
 * 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;
247 248 249 250
	}

	return 0;
}
251

252
static void print_sample_start(struct perf_sample *sample,
253 254
			       struct thread *thread,
			       struct perf_event_attr *attr)
255 256 257 258 259 260
{
	int type;
	struct event *event;
	const char *evname = NULL;
	unsigned long secs;
	unsigned long usecs;
261 262 263 264 265
	unsigned long long nsecs;

	if (PRINT_FIELD(COMM)) {
		if (latency_format)
			printf("%8.8s ", thread->comm);
266
		else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
267
			printf("%s ", thread->comm);
268 269 270
		else
			printf("%16s ", thread->comm);
	}
271

272 273 274 275 276 277 278 279 280 281 282 283 284
	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);
	}
285

286 287 288 289 290 291 292
	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);
	}
293

294
	if (PRINT_FIELD(EVNAME)) {
295 296 297 298 299 300 301
		if (attr->type == PERF_TYPE_TRACEPOINT) {
			type = trace_parse_common_type(sample->raw_data);
			event = trace_find_event(type);
			if (event)
				evname = event->name;
		} else
			evname = __event_name(attr->type, attr->config);
302

303 304
		printf("%s: ", evname ? evname : "(unknown)");
	}
305 306
}

307 308 309 310 311 312 313 314 315 316 317 318 319
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;

	return false;
}

static void print_sample_addr(union perf_event *event,
			  struct perf_sample *sample,
320
			  struct machine *machine,
321 322 323 324 325 326 327 328 329 330 331 332
			  struct thread *thread,
			  struct perf_event_attr *attr)
{
	struct addr_location al;
	u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
	const char *symname, *dsoname;

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

	if (!sample_addr_correlates_sym(attr))
		return;

333 334
	thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
			      sample->addr, &al);
335
	if (!al.map)
336 337
		thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE,
				      sample->addr, &al);
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363

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

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

	if (PRINT_FIELD(SYM)) {
		if (al.sym && al.sym->name)
			symname = al.sym->name;
		else
			symname = "";

		printf(" %16s", symname);
	}

	if (PRINT_FIELD(DSO)) {
		if (al.map && al.map->dso && al.map->dso->name)
			dsoname = al.map->dso->name;
		else
			dsoname = "";

		printf(" (%s)", dsoname);
	}
}

364 365
static void process_event(union perf_event *event __unused,
			  struct perf_sample *sample,
366
			  struct perf_evsel *evsel,
367
			  struct machine *machine,
368 369
			  struct thread *thread)
{
370
	struct perf_event_attr *attr = &evsel->attr;
371

372
	if (output[attr->type].fields == 0)
373 374 375
		return;

	print_sample_start(sample, thread, attr);
376 377 378 379 380

	if (PRINT_FIELD(TRACE))
		print_trace_event(sample->cpu, sample->raw_data,
				  sample->raw_size);

381
	if (PRINT_FIELD(ADDR))
382
		print_sample_addr(event, sample, machine, thread, attr);
383

384
	if (PRINT_FIELD(IP)) {
385 386 387 388
		if (!symbol_conf.use_callchain)
			printf(" ");
		else
			printf("\n");
389 390
		perf_event__print_ip(event, sample, machine, evsel,
				     PRINT_FIELD(SYM), PRINT_FIELD(DSO));
391 392
	}

393
	printf("\n");
394 395
}

396 397 398
static int default_start_script(const char *script __unused,
				int argc __unused,
				const char **argv __unused)
T
Tom Zanussi 已提交
399 400 401 402 403 404 405 406 407
{
	return 0;
}

static int default_stop_script(void)
{
	return 0;
}

408
static int default_generate_script(const char *outfile __unused)
T
Tom Zanussi 已提交
409 410 411 412 413 414 415
{
	return 0;
}

static struct scripting_ops default_scripting_ops = {
	.start_script		= default_start_script,
	.stop_script		= default_stop_script,
416
	.process_event		= process_event,
T
Tom Zanussi 已提交
417 418 419 420 421 422 423
	.generate_script	= default_generate_script,
};

static struct scripting_ops	*scripting_ops;

static void setup_scripting(void)
{
424
	setup_perl_scripting();
425
	setup_python_scripting();
426

T
Tom Zanussi 已提交
427 428 429 430 431
	scripting_ops = &default_scripting_ops;
}

static int cleanup_scripting(void)
{
432
	pr_debug("\nperf script stopped\n");
433

T
Tom Zanussi 已提交
434 435 436
	return scripting_ops->stop_script();
}

437
static const char *input_name;
F
Frederic Weisbecker 已提交
438

439
static int process_sample_event(struct perf_tool *tool __used,
440
				union perf_event *event,
441
				struct perf_sample *sample,
442
				struct perf_evsel *evsel,
443
				struct machine *machine)
F
Frederic Weisbecker 已提交
444
{
445
	struct addr_location al;
446
	struct thread *thread = machine__findnew_thread(machine, event->ip.tid);
447

F
Frederic Weisbecker 已提交
448
	if (thread == NULL) {
449 450
		pr_debug("problem processing %d event, skipping it.\n",
			 event->header.type);
F
Frederic Weisbecker 已提交
451 452 453
		return -1;
	}

454 455 456 457 458 459
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
460
		}
461 462
		last_timestamp = sample->time;
		return 0;
F
Frederic Weisbecker 已提交
463
	}
464

465 466 467 468 469 470 471 472 473
	if (perf_event__preprocess_sample(event, machine, &al, sample, 0) < 0) {
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
		return -1;
	}

	if (al.filtered)
		return 0;

474 475 476
	if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
		return 0;

477
	scripting_ops->process_event(event, sample, evsel, machine, thread);
F
Frederic Weisbecker 已提交
478

479
	evsel->hists.stats.total_period += sample->period;
F
Frederic Weisbecker 已提交
480 481 482
	return 0;
}

483
static struct perf_tool perf_script = {
484
	.sample		 = process_sample_event,
485
	.mmap		 = perf_event__process_mmap,
486
	.comm		 = perf_event__process_comm,
487 488
	.exit		 = perf_event__process_task,
	.fork		 = perf_event__process_task,
489 490 491 492
	.attr		 = perf_event__process_attr,
	.event_type	 = perf_event__process_event_type,
	.tracing_data	 = perf_event__process_tracing_data,
	.build_id	 = perf_event__process_build_id,
493
	.ordered_samples = true,
494
	.ordering_requires_timestamps = true,
495 496
};

497 498 499 500 501 502 503
extern volatile int session_done;

static void sig_handler(int sig __unused)
{
	session_done = 1;
}

504
static int __cmd_script(struct perf_session *session)
F
Frederic Weisbecker 已提交
505
{
506 507
	int ret;

508 509
	signal(SIGINT, sig_handler);

510
	ret = perf_session__process_events(session, &perf_script);
511

512
	if (debug_mode)
513
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
514 515

	return ret;
F
Frederic Weisbecker 已提交
516 517
}

T
Tom Zanussi 已提交
518 519 520 521 522 523
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
	char			spec[0];
};

524
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563

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)
564
		return NULL;
T
Tom Zanussi 已提交
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600

	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 "
601
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
602 603 604 605 606 607 608 609 610 611 612 613 614 615

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

	fprintf(stderr, "\n");
}

static int parse_scriptname(const struct option *opt __used,
			    const char *str, int unset __used)
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

616
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
617
		list_available_languages();
618
		exit(0);
T
Tom Zanussi 已提交
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
	}

	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;
638
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
		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;
}

655 656 657 658 659
static int parse_output_fields(const struct option *opt __used,
			    const char *arg, int unset __used)
{
	char *tok;
	int i, imax = sizeof(all_output_options) / sizeof(struct output_option);
660
	int j;
661 662
	int rc = 0;
	char *str = strdup(arg);
663
	int type = -1;
664 665 666 667

	if (!str)
		return -ENOMEM;

668 669 670
	/* 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.
671
	 */
672 673 674 675 676 677 678 679 680 681
	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;
682 683
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
684 685
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
686 687
			rc = -EINVAL;
			goto out;
688 689 690 691 692 693 694 695
		}

		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;
696
		output[type].wildcard_set = false;
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712

	} 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;
713
			output[j].wildcard_set = true;
714
		}
715 716
	}

717 718
	tok = strtok(tok, ",");
	while (tok) {
719
		for (i = 0; i < imax; ++i) {
720
			if (strcmp(tok, all_output_options[i].str) == 0)
721 722 723
				break;
		}
		if (i == imax) {
724
			fprintf(stderr, "Invalid field requested.\n");
725
			rc = -EINVAL;
726
			goto out;
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
		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, ",");
752 753
	}

754 755 756 757 758 759
	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));
		}
	}
760

761
out:
762 763 764 765
	free(str);
	return rc;
}

766 767 768 769 770 771 772 773 774 775 776 777 778 779
/* 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)\
780 781
	while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) &&	\
	       lang_next)						\
782 783 784
		if ((lang_dirent.d_type == DT_DIR ||			\
		     (lang_dirent.d_type == DT_UNKNOWN &&		\
		      is_directory(scripts_path, &lang_dirent))) &&	\
785 786 787
		    (strcmp(lang_dirent.d_name, ".")) &&		\
		    (strcmp(lang_dirent.d_name, "..")))

788
#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
789 790
	while (!readdir_r(lang_dir, &script_dirent, &script_next) &&	\
	       script_next)						\
791 792 793
		if (script_dirent.d_type != DT_DIR &&			\
		    (script_dirent.d_type != DT_UNKNOWN ||		\
		     !is_directory(lang_path, &script_dirent)))
794 795 796 797 798 799 800 801 802 803 804 805


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

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

806
static LIST_HEAD(script_descs);
807 808 809 810 811

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

812
	if (s != NULL && name)
813 814 815 816 817 818 819 820
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
	free(s->name);
821 822
	free(s->half_liner);
	free(s->args);
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 850 851 852 853 854 855 856 857 858 859 860 861
	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;
}

862
static const char *ends_with(const char *str, const char *suffix)
863 864
{
	size_t suffix_len = strlen(suffix);
865
	const char *p = str;
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928

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

	return NULL;
}

static char *ltrim(char *str)
{
	int len = strlen(str);

	while (len && isspace(*str)) {
		len--;
		str++;
	}

	return str;
}

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

929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
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;
}

947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
static int list_available_scripts(const struct option *opt __used,
				  const char *s __used, int unset __used)
{
	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;

965
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
966 967 968 969 970 971
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

972
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
973 974
			script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
			if (script_root) {
975 976 977 978
				desc = script_desc__findnew(script_root);
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
				read_script_info(desc, script_path);
979
				free(script_root);
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
			}
		}
	}

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

995 996 997 998 999 1000 1001
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];
1002
	char *__script_root;
1003 1004 1005 1006 1007 1008 1009

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

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

1010
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1011 1012 1013 1014 1015 1016
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1017
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1018 1019 1020
			__script_root = get_script_root(&script_dirent, suffix);
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
1021 1022
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
1023
				return strdup(script_path);
1024 1025 1026 1027 1028
			}
			free(__script_root);
		}
	}

1029
	return NULL;
1030 1031
}

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

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

1060 1061 1062 1063 1064 1065
static 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]",
F
Frederic Weisbecker 已提交
1066 1067 1068 1069 1070 1071
	NULL
};

static const struct option options[] = {
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
1072
	OPT_INCR('v', "verbose", &verbose,
F
Frederic Weisbecker 已提交
1073
		    "be more verbose (show symbol address, etc)"),
1074
	OPT_BOOLEAN('L', "Latency", &latency_format,
1075
		    "show latency attributes (irqs/preemption disabled, etc)"),
1076 1077
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
T
Tom Zanussi 已提交
1078 1079 1080 1081
	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",
1082
		   "generate perf-script.xx script in specified language"),
1083 1084
	OPT_STRING('i', "input", &input_name, "file",
		    "input file name"),
1085 1086
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
1087 1088 1089 1090 1091 1092 1093 1094
	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"),
1095
	OPT_CALLBACK('f', "fields", NULL, "str",
1096
		     "comma separated output fields prepend with 'type:'. Valid types: hw,sw,trace,raw. Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,addr",
1097
		     parse_output_fields),
1098 1099
	OPT_BOOLEAN('a', "all-cpus", &system_wide,
		     "system-wide collection from all CPUs"),
1100
	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1101 1102
	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only display events for these comms"),
1103 1104
	OPT_BOOLEAN('I', "show-info", &show_full_info,
		    "display extended information from perf.data file"),
1105
	OPT_END()
F
Frederic Weisbecker 已提交
1106 1107
};

1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
static bool have_cmd(int argc, const char **argv)
{
	char **__argv = malloc(sizeof(const char *) * argc);

	if (!__argv)
		die("malloc");
	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);

	return argc != 0;
}

1122
int cmd_script(int argc, const char **argv, const char *prefix __used)
F
Frederic Weisbecker 已提交
1123
{
1124 1125
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
1126
	struct perf_session *session;
1127
	char *script_path = NULL;
1128
	const char **__argv;
1129
	int i, j, err;
1130

1131 1132
	setup_scripting();

1133
	argc = parse_options(argc, argv, options, script_usage,
1134 1135 1136 1137 1138 1139
			     PARSE_OPT_STOP_AT_NON_OPTION);

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

1142 1143 1144
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
1145
			fprintf(stderr,
1146
				"Please specify a valid report script"
1147
				"(see 'perf script -l' for listing)\n");
1148 1149 1150 1151
			return -1;
		}
	}

1152 1153 1154
	/* make sure PERF_EXEC_PATH is set for scripts */
	perf_set_argv_exec_path(perf_exec_path());

1155
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
1156
		int live_pipe[2];
1157
		int rep_args;
1158 1159
		pid_t pid;

1160 1161 1162 1163 1164
		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"
1165 1166
				" script -l for available scripts.\n", argv[0]);
			usage_with_options(script_usage, options);
1167 1168
		}

1169 1170 1171 1172 1173 1174 1175 1176 1177
		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."
1178
					"\n\n See perf script -l for available "
1179
					"scripts and options.\n", argv[0]);
1180
				usage_with_options(script_usage, options);
1181
			}
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
			exit(-1);
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
			exit(-1);
		}

		if (!pid) {
1196 1197
			j = 0;

1198 1199 1200
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

1201 1202 1203
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
1204 1205
				system_wide = !have_cmd(argc - rep_args,
							&argv[rep_args]);
1206
			}
1207 1208

			__argv = malloc((argc + 6) * sizeof(const char *));
1209 1210 1211
			if (!__argv)
				die("malloc");

1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
			__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;
1222 1223

			execvp("/bin/sh", (char **)__argv);
1224
			free(__argv);
1225 1226 1227 1228 1229 1230
			exit(-1);
		}

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

1231
		__argv = malloc((argc + 4) * sizeof(const char *));
1232 1233
		if (!__argv)
			die("malloc");
1234 1235 1236 1237 1238 1239 1240 1241
		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;
1242 1243

		execvp("/bin/sh", (char **)__argv);
1244
		free(__argv);
1245 1246 1247
		exit(-1);
	}

1248 1249 1250 1251
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
1252

1253 1254
	if (script_path) {
		j = 0;
1255

1256 1257 1258
		if (!rec_script_path)
			system_wide = false;
		else if (!system_wide)
1259
			system_wide = !have_cmd(argc - 1, &argv[1]);
1260

1261
		__argv = malloc((argc + 2) * sizeof(const char *));
1262 1263
		if (!__argv)
			die("malloc");
1264 1265 1266 1267
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
1268
		for (i = 2; i < argc; i++)
1269 1270
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
1271 1272

		execvp("/bin/sh", (char **)__argv);
1273
		free(__argv);
1274 1275
		exit(-1);
	}
T
Tom Zanussi 已提交
1276

1277 1278
	if (symbol__init() < 0)
		return -1;
1279 1280
	if (!script_name)
		setup_pager();
F
Frederic Weisbecker 已提交
1281

1282
	session = perf_session__new(input_name, O_RDONLY, 0, false, &perf_script);
1283 1284 1285
	if (session == NULL)
		return -ENOMEM;

1286 1287 1288 1289 1290
	if (cpu_list) {
		if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
			return -1;
	}

1291 1292
	perf_session__fprintf_info(session, stdout, show_full_info);

1293
	if (!no_callchain)
1294 1295 1296 1297
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

T
Tom Zanussi 已提交
1298 1299
	if (generate_script_lang) {
		struct stat perf_stat;
1300 1301
		int input;

1302
		if (output_set_by_user()) {
1303 1304 1305 1306
			fprintf(stderr,
				"custom fields not supported for generated scripts");
			return -1;
		}
T
Tom Zanussi 已提交
1307

1308
		input = open(session->filename, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
		if (input < 0) {
			perror("failed to open file");
			exit(-1);
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
			exit(-1);
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
			exit(0);
		}

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

1331
		err = scripting_ops->generate_script("perf-script");
T
Tom Zanussi 已提交
1332 1333 1334 1335
		goto out;
	}

	if (script_name) {
1336
		err = scripting_ops->start_script(script_name, argc, argv);
T
Tom Zanussi 已提交
1337 1338
		if (err)
			goto out;
1339
		pr_debug("perf script started with script %s\n\n", script_name);
T
Tom Zanussi 已提交
1340 1341
	}

1342 1343 1344 1345 1346

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

1347
	err = __cmd_script(session);
T
Tom Zanussi 已提交
1348

1349
	perf_session__delete(session);
T
Tom Zanussi 已提交
1350 1351 1352
	cleanup_scripting();
out:
	return err;
F
Frederic Weisbecker 已提交
1353
}