builtin-script.c 22.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"
F
Frederic Weisbecker 已提交
15

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

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

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},
46
	{.str = "sym",   .field = PERF_OUTPUT_SYM},
47 48 49 50 51 52 53 54 55 56 57
};

/* default set to maintain compatibility with current format */
static u64 output_fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | \
			   PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | \
			   PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE;

static bool output_set_by_user;

#define PRINT_FIELD(x)  (output_fields & PERF_OUTPUT_##x)

58 59 60 61 62 63 64 65
static void print_sample_start(struct perf_sample *sample,
			       struct thread *thread)
{
	int type;
	struct event *event;
	const char *evname = NULL;
	unsigned long secs;
	unsigned long usecs;
66 67 68 69 70
	unsigned long long nsecs;

	if (PRINT_FIELD(COMM)) {
		if (latency_format)
			printf("%8.8s ", thread->comm);
71 72
		else if (PRINT_FIELD(SYM) && symbol_conf.use_callchain)
			printf("%s ", thread->comm);
73 74 75
		else
			printf("%16s ", thread->comm);
	}
76

77 78 79 80 81 82 83 84 85 86 87 88 89
	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);
	}
90

91 92 93 94 95 96 97
	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);
	}
98

99 100 101 102 103
	if (PRINT_FIELD(EVNAME)) {
		type = trace_parse_common_type(sample->raw_data);
		event = trace_find_event(type);
		if (event)
			evname = event->name;
104

105 106
		printf("%s: ", evname ? evname : "(unknown)");
	}
107 108
}

109 110 111 112 113
static void process_event(union perf_event *event __unused,
			  struct perf_sample *sample,
			  struct perf_session *session __unused,
			  struct thread *thread)
{
114
	print_sample_start(sample, thread);
115 116 117 118 119

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

120 121 122 123 124 125 126 127
	if (PRINT_FIELD(SYM)) {
		if (!symbol_conf.use_callchain)
			printf(" ");
		else
			printf("\n");
		perf_session__print_symbols(event, sample, session);
	}

128
	printf("\n");
129 130
}

131 132 133
static int default_start_script(const char *script __unused,
				int argc __unused,
				const char **argv __unused)
T
Tom Zanussi 已提交
134 135 136 137 138 139 140 141 142
{
	return 0;
}

static int default_stop_script(void)
{
	return 0;
}

143
static int default_generate_script(const char *outfile __unused)
T
Tom Zanussi 已提交
144 145 146 147 148 149 150
{
	return 0;
}

static struct scripting_ops default_scripting_ops = {
	.start_script		= default_start_script,
	.stop_script		= default_stop_script,
151
	.process_event		= process_event,
T
Tom Zanussi 已提交
152 153 154 155 156 157 158
	.generate_script	= default_generate_script,
};

static struct scripting_ops	*scripting_ops;

static void setup_scripting(void)
{
159
	setup_perl_scripting();
160
	setup_python_scripting();
161

T
Tom Zanussi 已提交
162 163 164 165 166
	scripting_ops = &default_scripting_ops;
}

static int cleanup_scripting(void)
{
167
	pr_debug("\nperf script stopped\n");
168

T
Tom Zanussi 已提交
169 170 171 172
	return scripting_ops->stop_script();
}

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

174 175
static int process_sample_event(union perf_event *event,
				struct perf_sample *sample,
176
				struct perf_session *session)
F
Frederic Weisbecker 已提交
177
{
178
	struct thread *thread = perf_session__findnew(session, event->ip.pid);
179

F
Frederic Weisbecker 已提交
180
	if (thread == NULL) {
181 182
		pr_debug("problem processing %d event, skipping it.\n",
			 event->header.type);
F
Frederic Weisbecker 已提交
183 184 185
		return -1;
	}

186
	if (session->sample_type & PERF_SAMPLE_RAW) {
187
		if (debug_mode) {
188
			if (sample->time < last_timestamp) {
189 190
				pr_err("Samples misordered, previous: %" PRIu64
					" this: %" PRIu64 "\n", last_timestamp,
191
					sample->time);
192
				nr_unordered++;
193
			}
194
			last_timestamp = sample->time;
195
			return 0;
196
		}
197
		scripting_ops->process_event(event, sample, session, thread);
F
Frederic Weisbecker 已提交
198 199
	}

200
	session->hists.stats.total_period += sample->period;
F
Frederic Weisbecker 已提交
201 202 203
	return 0;
}

204
static struct perf_event_ops event_ops = {
205
	.sample		 = process_sample_event,
206
	.mmap		 = perf_event__process_mmap,
207
	.comm		 = perf_event__process_comm,
208 209
	.exit		 = perf_event__process_task,
	.fork		 = perf_event__process_task,
210 211 212 213
	.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,
214
	.ordered_samples = true,
215
	.ordering_requires_timestamps = true,
216 217
};

218 219 220 221 222 223 224
extern volatile int session_done;

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

225
static int __cmd_script(struct perf_session *session)
F
Frederic Weisbecker 已提交
226
{
227 228
	int ret;

229 230
	signal(SIGINT, sig_handler);

231 232
	ret = perf_session__process_events(session, &event_ops);

233
	if (debug_mode)
234
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
235 236

	return ret;
F
Frederic Weisbecker 已提交
237 238
}

T
Tom Zanussi 已提交
239 240 241 242 243 244
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
	char			spec[0];
};

245
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
246 247 248 249 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 276 277 278 279 280 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 307 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

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 "
333
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
334 335 336 337 338 339 340 341 342 343 344 345 346 347

	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;

348
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
349
		list_available_languages();
350
		exit(0);
T
Tom Zanussi 已提交
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
	}

	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;
370
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
		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;
}

387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
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);

	if (!str)
		return -ENOMEM;

	tok = strtok(str, ",");
	if (!tok) {
		fprintf(stderr, "Invalid field string.");
		return -EINVAL;
	}

	output_fields = 0;
	while (1) {
		for (i = 0; i < imax; ++i) {
			if (strcmp(tok, all_output_options[i].str) == 0) {
				output_fields |= all_output_options[i].field;
				break;
			}
		}
		if (i == imax) {
			fprintf(stderr, "Invalid field requested.");
			rc = -EINVAL;
			break;
		}

		tok = strtok(NULL, ",");
		if (!tok)
			break;
	}

	output_set_by_user = true;

	free(str);
	return rc;
}

429 430 431 432 433 434 435 436 437 438 439 440 441 442
/* 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)\
443 444
	while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) &&	\
	       lang_next)						\
445 446 447
		if ((lang_dirent.d_type == DT_DIR ||			\
		     (lang_dirent.d_type == DT_UNKNOWN &&		\
		      is_directory(scripts_path, &lang_dirent))) &&	\
448 449 450
		    (strcmp(lang_dirent.d_name, ".")) &&		\
		    (strcmp(lang_dirent.d_name, "..")))

451
#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
452 453
	while (!readdir_r(lang_dir, &script_dirent, &script_next) &&	\
	       script_next)						\
454 455 456
		if (script_dirent.d_type != DT_DIR &&			\
		    (script_dirent.d_type != DT_UNKNOWN ||		\
		     !is_directory(lang_path, &script_dirent)))
457 458 459 460 461 462 463 464 465 466 467 468


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

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

469
static LIST_HEAD(script_descs);
470 471 472 473 474

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

475
	if (s != NULL && name)
476 477 478 479 480 481 482 483
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
	free(s->name);
484 485
	free(s->half_liner);
	free(s->args);
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
	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;
}

525
static const char *ends_with(const char *str, const char *suffix)
526 527
{
	size_t suffix_len = strlen(suffix);
528
	const char *p = str;
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 564 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 601 602 603 604 605 606 607 608 609 610

	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;

611
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
612 613 614 615 616 617
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

618
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
619
			script_root = strdup(script_dirent.d_name);
620
			str = (char *)ends_with(script_root, REPORT_SUFFIX);
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
			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);
}

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
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;

659
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
660 661 662 663 664 665
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

666
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
667
			__script_root = strdup(script_dirent.d_name);
668
			str = (char *)ends_with(__script_root, suffix);
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
			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;
}

686 687
static bool is_top_script(const char *script_path)
{
688
	return ends_with(script_path, "top") == NULL ? false : true;
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
}

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

714 715 716 717 718 719
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 已提交
720 721 722 723 724 725
	NULL
};

static const struct option options[] = {
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
726
	OPT_INCR('v', "verbose", &verbose,
F
Frederic Weisbecker 已提交
727
		    "be more verbose (show symbol address, etc)"),
728
	OPT_BOOLEAN('L', "Latency", &latency_format,
729
		    "show latency attributes (irqs/preemption disabled, etc)"),
730 731
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
T
Tom Zanussi 已提交
732 733 734 735
	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",
736
		   "generate perf-script.xx script in specified language"),
737 738
	OPT_STRING('i', "input", &input_name, "file",
		    "input file name"),
739 740
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
741 742 743 744 745 746 747 748
	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"),
749
	OPT_CALLBACK('f', "fields", NULL, "str",
750
		     "comma separated output fields. Options: comm,tid,pid,time,cpu,event,trace,sym",
751
		     parse_output_fields),
T
Tom Zanussi 已提交
752

753
	OPT_END()
F
Frederic Weisbecker 已提交
754 755
};

756 757 758 759 760 761 762 763 764 765 766 767 768 769
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;
}

770
int cmd_script(int argc, const char **argv, const char *prefix __used)
F
Frederic Weisbecker 已提交
771
{
772 773
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
774
	struct perf_session *session;
775
	char *script_path = NULL;
776
	const char **__argv;
777 778
	bool system_wide;
	int i, j, err;
779

780 781
	setup_scripting();

782
	argc = parse_options(argc, argv, options, script_usage,
783 784 785 786 787 788
			     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);
789 790
	}

791 792 793
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
794
			fprintf(stderr,
795
				"Please specify a valid report script"
796
				"(see 'perf script -l' for listing)\n");
797 798 799 800
			return -1;
		}
	}

801 802 803
	/* make sure PERF_EXEC_PATH is set for scripts */
	perf_set_argv_exec_path(perf_exec_path());

804
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
805
		int live_pipe[2];
806
		int rep_args;
807 808
		pid_t pid;

809 810 811 812 813
		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"
814 815
				" script -l for available scripts.\n", argv[0]);
			usage_with_options(script_usage, options);
816 817
		}

818 819 820 821 822 823 824 825 826
		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."
827
					"\n\n See perf script -l for available "
828
					"scripts and options.\n", argv[0]);
829
				usage_with_options(script_usage, options);
830
			}
831 832 833 834 835 836 837 838 839 840 841 842 843 844
		}

		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) {
845 846 847
			system_wide = true;
			j = 0;

848 849 850
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

851 852 853 854 855
			if (!is_top_script(argv[0]))
				system_wide = !have_cmd(argc - rep_args,
							&argv[rep_args]);

			__argv = malloc((argc + 6) * sizeof(const char *));
856 857 858
			if (!__argv)
				die("malloc");

859 860 861 862 863 864 865 866 867 868
			__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;
869 870

			execvp("/bin/sh", (char **)__argv);
871
			free(__argv);
872 873 874 875 876 877
			exit(-1);
		}

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

878
		__argv = malloc((argc + 4) * sizeof(const char *));
879 880
		if (!__argv)
			die("malloc");
881 882 883 884 885 886 887 888
		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;
889 890

		execvp("/bin/sh", (char **)__argv);
891
		free(__argv);
892 893 894
		exit(-1);
	}

895 896 897 898
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
899

900 901 902
	if (script_path) {
		system_wide = false;
		j = 0;
903

904 905
		if (rec_script_path)
			system_wide = !have_cmd(argc - 1, &argv[1]);
906

907
		__argv = malloc((argc + 2) * sizeof(const char *));
908 909
		if (!__argv)
			die("malloc");
910 911 912 913
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
914
		for (i = 2; i < argc; i++)
915 916
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
917 918

		execvp("/bin/sh", (char **)__argv);
919
		free(__argv);
920 921
		exit(-1);
	}
T
Tom Zanussi 已提交
922

923 924
	if (symbol__init() < 0)
		return -1;
925 926
	if (!script_name)
		setup_pager();
F
Frederic Weisbecker 已提交
927

928
	session = perf_session__new(input_name, O_RDONLY, 0, false, &event_ops);
929 930 931
	if (session == NULL)
		return -ENOMEM;

932 933 934 935 936
	if (!no_callchain && (session->sample_type & PERF_SAMPLE_CALLCHAIN))
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

937 938
	if (strcmp(input_name, "-") &&
	    !perf_session__has_traces(session, "record -R"))
939 940
		return -EINVAL;

T
Tom Zanussi 已提交
941 942
	if (generate_script_lang) {
		struct stat perf_stat;
943 944 945 946 947 948 949
		int input;

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

951
		input = open(input_name, O_RDONLY);
T
Tom Zanussi 已提交
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
		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;
		}

974
		err = scripting_ops->generate_script("perf-script");
T
Tom Zanussi 已提交
975 976 977 978
		goto out;
	}

	if (script_name) {
979
		err = scripting_ops->start_script(script_name, argc, argv);
T
Tom Zanussi 已提交
980 981
		if (err)
			goto out;
982
		pr_debug("perf script started with script %s\n\n", script_name);
T
Tom Zanussi 已提交
983 984
	}

985
	err = __cmd_script(session);
T
Tom Zanussi 已提交
986

987
	perf_session__delete(session);
T
Tom Zanussi 已提交
988 989 990
	cleanup_scripting();
out:
	return err;
F
Frederic Weisbecker 已提交
991
}