builtin-script.c 24.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"
F
Frederic Weisbecker 已提交
10 11
#include "util/symbol.h"
#include "util/thread.h"
I
Ingo Molnar 已提交
12
#include "util/trace-event.h"
13
#include "util/parse-options.h"
A
Andrea Gelmini 已提交
14
#include "util/util.h"
15 16
#include "util/evlist.h"
#include "util/evsel.h"
F
Frederic Weisbecker 已提交
17

T
Tom Zanussi 已提交
18 19
static char const		*script_name;
static char const		*generate_script_lang;
20
static bool			debug_mode;
21
static u64			last_timestamp;
22
static u64			nr_unordered;
23
extern const struct option	record_options[];
24
static bool			no_callchain;
T
Tom Zanussi 已提交
25

26 27 28 29 30 31 32 33
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,
34
	PERF_OUTPUT_SYM             = 1U << 7,
35 36 37 38 39 40 41 42 43 44 45 46 47
};

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},
48
	{.str = "sym",   .field = PERF_OUTPUT_SYM},
49 50 51
};

/* default set to maintain compatibility with current format */
52 53 54 55 56 57 58 59 60 61 62 63 64
static u64 output_fields[PERF_TYPE_MAX] = {
	[PERF_TYPE_HARDWARE] = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | \
			       PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | \
			       PERF_OUTPUT_EVNAME | PERF_OUTPUT_SYM,

	[PERF_TYPE_SOFTWARE] = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | \
			       PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | \
			       PERF_OUTPUT_EVNAME | PERF_OUTPUT_SYM,

	[PERF_TYPE_TRACEPOINT] = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | \
				 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | \
				 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
};
65 66 67

static bool output_set_by_user;

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
#define PRINT_FIELD(x)  (output_fields[attr->type] & PERF_OUTPUT_##x)

static int perf_session__check_attr(struct perf_session *session,
				    struct perf_event_attr *attr)
{
	if (PRINT_FIELD(TRACE) &&
		!perf_session__has_traces(session, "record -R"))
		return -EINVAL;

	if (PRINT_FIELD(SYM)) {
		if (!(session->sample_type & PERF_SAMPLE_IP)) {
			pr_err("Samples do not contain IP data.\n");
			return -EINVAL;
		}
		if (!no_callchain &&
		    !(session->sample_type & PERF_SAMPLE_CALLCHAIN))
			symbol_conf.use_callchain = false;
	}

	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
		!(session->sample_type & PERF_SAMPLE_TID)) {
		pr_err("Samples do not contain TID/PID data.\n");
		return -EINVAL;
	}

	if (PRINT_FIELD(TIME) &&
		!(session->sample_type & PERF_SAMPLE_TIME)) {
		pr_err("Samples do not contain timestamps.\n");
		return -EINVAL;
	}

	if (PRINT_FIELD(CPU) &&
		!(session->sample_type & PERF_SAMPLE_CPU)) {
		pr_err("Samples do not contain cpu.\n");
		return -EINVAL;
	}

	return 0;
}
107

108
static void print_sample_start(struct perf_sample *sample,
109 110
			       struct thread *thread,
			       struct perf_event_attr *attr)
111 112 113 114 115 116
{
	int type;
	struct event *event;
	const char *evname = NULL;
	unsigned long secs;
	unsigned long usecs;
117 118 119 120 121
	unsigned long long nsecs;

	if (PRINT_FIELD(COMM)) {
		if (latency_format)
			printf("%8.8s ", thread->comm);
122 123
		else if (PRINT_FIELD(SYM) && symbol_conf.use_callchain)
			printf("%s ", thread->comm);
124 125 126
		else
			printf("%16s ", thread->comm);
	}
127

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

142 143 144 145 146 147 148
	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);
	}
149

150
	if (PRINT_FIELD(EVNAME)) {
151 152 153 154 155 156 157
		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);
158

159 160
		printf("%s: ", evname ? evname : "(unknown)");
	}
161 162
}

163 164
static void process_event(union perf_event *event __unused,
			  struct perf_sample *sample,
165
			  struct perf_evsel *evsel,
166
			  struct perf_session *session,
167 168
			  struct thread *thread)
{
169
	struct perf_event_attr *attr = &evsel->attr;
170 171 172 173 174 175 176 177

	if (output_fields[attr->type] == 0)
		return;

	if (perf_session__check_attr(session, attr) < 0)
		return;

	print_sample_start(sample, thread, attr);
178 179 180 181 182

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

183 184 185 186 187 188 189 190
	if (PRINT_FIELD(SYM)) {
		if (!symbol_conf.use_callchain)
			printf(" ");
		else
			printf("\n");
		perf_session__print_symbols(event, sample, session);
	}

191
	printf("\n");
192 193
}

194 195 196
static int default_start_script(const char *script __unused,
				int argc __unused,
				const char **argv __unused)
T
Tom Zanussi 已提交
197 198 199 200 201 202 203 204 205
{
	return 0;
}

static int default_stop_script(void)
{
	return 0;
}

206
static int default_generate_script(const char *outfile __unused)
T
Tom Zanussi 已提交
207 208 209 210 211 212 213
{
	return 0;
}

static struct scripting_ops default_scripting_ops = {
	.start_script		= default_start_script,
	.stop_script		= default_stop_script,
214
	.process_event		= process_event,
T
Tom Zanussi 已提交
215 216 217 218 219 220 221
	.generate_script	= default_generate_script,
};

static struct scripting_ops	*scripting_ops;

static void setup_scripting(void)
{
222
	setup_perl_scripting();
223
	setup_python_scripting();
224

T
Tom Zanussi 已提交
225 226 227 228 229
	scripting_ops = &default_scripting_ops;
}

static int cleanup_scripting(void)
{
230
	pr_debug("\nperf script stopped\n");
231

T
Tom Zanussi 已提交
232 233 234 235
	return scripting_ops->stop_script();
}

static char const		*input_name = "perf.data";
F
Frederic Weisbecker 已提交
236

237 238
static int process_sample_event(union perf_event *event,
				struct perf_sample *sample,
239
				struct perf_evsel *evsel,
240
				struct perf_session *session)
F
Frederic Weisbecker 已提交
241
{
242
	struct thread *thread = perf_session__findnew(session, event->ip.pid);
243

F
Frederic Weisbecker 已提交
244
	if (thread == NULL) {
245 246
		pr_debug("problem processing %d event, skipping it.\n",
			 event->header.type);
F
Frederic Weisbecker 已提交
247 248 249
		return -1;
	}

250 251 252 253 254 255
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
256
		}
257 258
		last_timestamp = sample->time;
		return 0;
F
Frederic Weisbecker 已提交
259
	}
260
	scripting_ops->process_event(event, sample, evsel, session, thread);
F
Frederic Weisbecker 已提交
261

262
	session->hists.stats.total_period += sample->period;
F
Frederic Weisbecker 已提交
263 264 265
	return 0;
}

266
static struct perf_event_ops event_ops = {
267
	.sample		 = process_sample_event,
268
	.mmap		 = perf_event__process_mmap,
269
	.comm		 = perf_event__process_comm,
270 271
	.exit		 = perf_event__process_task,
	.fork		 = perf_event__process_task,
272 273 274 275
	.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,
276
	.ordered_samples = true,
277
	.ordering_requires_timestamps = true,
278 279
};

280 281 282 283 284 285 286
extern volatile int session_done;

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

287
static int __cmd_script(struct perf_session *session)
F
Frederic Weisbecker 已提交
288
{
289 290
	int ret;

291 292
	signal(SIGINT, sig_handler);

293 294
	ret = perf_session__process_events(session, &event_ops);

295
	if (debug_mode)
296
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
297 298

	return ret;
F
Frederic Weisbecker 已提交
299 300
}

T
Tom Zanussi 已提交
301 302 303 304 305 306
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
	char			spec[0];
};

307
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394

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__delete(struct script_spec *s)
{
	free(s->spec);
	free(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)
		goto out_delete_spec;

	script_spec__add(s);

	return s;

out_delete_spec:
	script_spec__delete(s);

	return NULL;
}

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 "
395
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
396 397 398 399 400 401 402 403 404 405 406 407 408 409

	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;

410
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
411
		list_available_languages();
412
		exit(0);
T
Tom Zanussi 已提交
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
	}

	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;
432
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
		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;
}

449 450 451 452 453 454 455
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);
	int rc = 0;
	char *str = strdup(arg);
456
	int type = -1;
457 458 459 460

	if (!str)
		return -ENOMEM;

461
	tok = strtok(str, ":");
462
	if (!tok) {
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
		fprintf(stderr,
			"Invalid field string - not prepended with type.");
		return -EINVAL;
	}

	/* first word should state which event type user
	 * is specifying the fields
	 */
	if (!strcmp(tok, "hw"))
		type = PERF_TYPE_HARDWARE;
	else if (!strcmp(tok, "sw"))
		type = PERF_TYPE_SOFTWARE;
	else if (!strcmp(tok, "trace"))
		type = PERF_TYPE_TRACEPOINT;
	else {
		fprintf(stderr, "Invalid event type in field string.");
479 480 481
		return -EINVAL;
	}

482
	output_fields[type] = 0;
483
	while (1) {
484 485 486
		tok = strtok(NULL, ",");
		if (!tok)
			break;
487 488
		for (i = 0; i < imax; ++i) {
			if (strcmp(tok, all_output_options[i].str) == 0) {
489
				output_fields[type] |= all_output_options[i].field;
490 491 492 493 494 495 496 497
				break;
			}
		}
		if (i == imax) {
			fprintf(stderr, "Invalid field requested.");
			rc = -EINVAL;
			break;
		}
498
	}
499

500 501 502
	if (output_fields[type] == 0) {
		pr_debug("No fields requested for %s type. "
			 "Events will not be displayed\n", event_type(type));
503 504 505 506 507 508 509 510
	}

	output_set_by_user = true;

	free(str);
	return rc;
}

511 512 513 514 515 516 517 518 519 520 521 522 523 524
/* 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)\
525 526
	while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) &&	\
	       lang_next)						\
527 528 529
		if ((lang_dirent.d_type == DT_DIR ||			\
		     (lang_dirent.d_type == DT_UNKNOWN &&		\
		      is_directory(scripts_path, &lang_dirent))) &&	\
530 531 532
		    (strcmp(lang_dirent.d_name, ".")) &&		\
		    (strcmp(lang_dirent.d_name, "..")))

533
#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
534 535
	while (!readdir_r(lang_dir, &script_dirent, &script_next) &&	\
	       script_next)						\
536 537 538
		if (script_dirent.d_type != DT_DIR &&			\
		    (script_dirent.d_type != DT_UNKNOWN ||		\
		     !is_directory(lang_path, &script_dirent)))
539 540 541 542 543 544 545 546 547 548 549 550


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

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

551
static LIST_HEAD(script_descs);
552 553 554 555 556

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

557
	if (s != NULL && name)
558 559 560 561 562 563 564 565
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
	free(s->name);
566 567
	free(s->half_liner);
	free(s->args);
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 601 602 603 604 605 606
	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;
}

607
static const char *ends_with(const char *str, const char *suffix)
608 609
{
	size_t suffix_len = strlen(suffix);
610
	const char *p = str;
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

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

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;
	char *str;

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

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

693
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
694 695 696 697 698 699
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

700
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
701
			script_root = strdup(script_dirent.d_name);
702
			str = (char *)ends_with(script_root, REPORT_SUFFIX);
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
			if (str) {
				*str = '\0';
				desc = script_desc__findnew(script_root);
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
				read_script_info(desc, script_path);
			}
			free(script_root);
		}
	}

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

725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
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];
	char *str, *__script_root;
	char *path = NULL;

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

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

741
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
742 743 744 745 746 747
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

748
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
749
			__script_root = strdup(script_dirent.d_name);
750
			str = (char *)ends_with(__script_root, suffix);
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
			if (str) {
				*str = '\0';
				if (strcmp(__script_root, script_root))
					continue;
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
				path = strdup(script_path);
				free(__script_root);
				break;
			}
			free(__script_root);
		}
	}

	return path;
}

768 769
static bool is_top_script(const char *script_path)
{
770
	return ends_with(script_path, "top") == NULL ? false : true;
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
}

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

796 797 798 799 800 801
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 已提交
802 803 804 805 806 807
	NULL
};

static const struct option options[] = {
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
808
	OPT_INCR('v', "verbose", &verbose,
F
Frederic Weisbecker 已提交
809
		    "be more verbose (show symbol address, etc)"),
810
	OPT_BOOLEAN('L', "Latency", &latency_format,
811
		    "show latency attributes (irqs/preemption disabled, etc)"),
812 813
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
T
Tom Zanussi 已提交
814 815 816 817
	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",
818
		   "generate perf-script.xx script in specified language"),
819 820
	OPT_STRING('i', "input", &input_name, "file",
		    "input file name"),
821 822
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
823 824 825 826 827 828 829 830
	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"),
831
	OPT_CALLBACK('f', "fields", NULL, "str",
832
		     "comma separated output fields prepend with 'type:'. Valid types: hw,sw,trace. Fields: comm,tid,pid,time,cpu,event,trace,sym",
833
		     parse_output_fields),
T
Tom Zanussi 已提交
834

835
	OPT_END()
F
Frederic Weisbecker 已提交
836 837
};

838 839 840 841 842 843 844 845 846 847 848 849 850 851
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;
}

852
int cmd_script(int argc, const char **argv, const char *prefix __used)
F
Frederic Weisbecker 已提交
853
{
854 855
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
856
	struct perf_session *session;
857
	char *script_path = NULL;
858
	const char **__argv;
859 860
	bool system_wide;
	int i, j, err;
861

862 863
	setup_scripting();

864
	argc = parse_options(argc, argv, options, script_usage,
865 866 867 868 869 870
			     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);
871 872
	}

873 874 875
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
876
			fprintf(stderr,
877
				"Please specify a valid report script"
878
				"(see 'perf script -l' for listing)\n");
879 880 881 882
			return -1;
		}
	}

883 884 885
	/* make sure PERF_EXEC_PATH is set for scripts */
	perf_set_argv_exec_path(perf_exec_path());

886
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
887
		int live_pipe[2];
888
		int rep_args;
889 890
		pid_t pid;

891 892 893 894 895
		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"
896 897
				" script -l for available scripts.\n", argv[0]);
			usage_with_options(script_usage, options);
898 899
		}

900 901 902 903 904 905 906 907 908
		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."
909
					"\n\n See perf script -l for available "
910
					"scripts and options.\n", argv[0]);
911
				usage_with_options(script_usage, options);
912
			}
913 914 915 916 917 918 919 920 921 922 923 924 925 926
		}

		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) {
927 928 929
			system_wide = true;
			j = 0;

930 931 932
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

933 934 935 936 937
			if (!is_top_script(argv[0]))
				system_wide = !have_cmd(argc - rep_args,
							&argv[rep_args]);

			__argv = malloc((argc + 6) * sizeof(const char *));
938 939 940
			if (!__argv)
				die("malloc");

941 942 943 944 945 946 947 948 949 950
			__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;
951 952

			execvp("/bin/sh", (char **)__argv);
953
			free(__argv);
954 955 956 957 958 959
			exit(-1);
		}

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

960
		__argv = malloc((argc + 4) * sizeof(const char *));
961 962
		if (!__argv)
			die("malloc");
963 964 965 966 967 968 969 970
		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;
971 972

		execvp("/bin/sh", (char **)__argv);
973
		free(__argv);
974 975 976
		exit(-1);
	}

977 978 979 980
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
981

982 983 984
	if (script_path) {
		system_wide = false;
		j = 0;
985

986 987
		if (rec_script_path)
			system_wide = !have_cmd(argc - 1, &argv[1]);
988

989
		__argv = malloc((argc + 2) * sizeof(const char *));
990 991
		if (!__argv)
			die("malloc");
992 993 994 995
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
996
		for (i = 2; i < argc; i++)
997 998
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
999 1000

		execvp("/bin/sh", (char **)__argv);
1001
		free(__argv);
1002 1003
		exit(-1);
	}
T
Tom Zanussi 已提交
1004

1005 1006
	if (symbol__init() < 0)
		return -1;
1007 1008
	if (!script_name)
		setup_pager();
F
Frederic Weisbecker 已提交
1009

1010
	session = perf_session__new(input_name, O_RDONLY, 0, false, &event_ops);
1011 1012 1013
	if (session == NULL)
		return -ENOMEM;

1014
	if (!no_callchain)
1015 1016 1017 1018
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

T
Tom Zanussi 已提交
1019 1020
	if (generate_script_lang) {
		struct stat perf_stat;
1021 1022 1023 1024 1025 1026 1027
		int input;

		if (output_set_by_user) {
			fprintf(stderr,
				"custom fields not supported for generated scripts");
			return -1;
		}
T
Tom Zanussi 已提交
1028

1029
		input = open(input_name, O_RDONLY);
T
Tom Zanussi 已提交
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
		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;
		}

1052
		err = scripting_ops->generate_script("perf-script");
T
Tom Zanussi 已提交
1053 1054 1055 1056
		goto out;
	}

	if (script_name) {
1057
		err = scripting_ops->start_script(script_name, argc, argv);
T
Tom Zanussi 已提交
1058 1059
		if (err)
			goto out;
1060
		pr_debug("perf script started with script %s\n\n", script_name);
T
Tom Zanussi 已提交
1061 1062
	}

1063
	err = __cmd_script(session);
T
Tom Zanussi 已提交
1064

1065
	perf_session__delete(session);
T
Tom Zanussi 已提交
1066 1067 1068
	cleanup_scripting();
out:
	return err;
F
Frederic Weisbecker 已提交
1069
}