builtin-script.c 57.9 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
#include "util/debug.h"
6
#include <subcmd/exec-cmd.h>
A
Andrea Gelmini 已提交
7
#include "util/header.h"
8
#include <subcmd/parse-options.h>
9
#include "util/perf_regs.h"
A
Andrea Gelmini 已提交
10
#include "util/session.h"
11
#include "util/tool.h"
F
Frederic Weisbecker 已提交
12 13
#include "util/symbol.h"
#include "util/thread.h"
I
Ingo Molnar 已提交
14
#include "util/trace-event.h"
A
Andrea Gelmini 已提交
15
#include "util/util.h"
16 17
#include "util/evlist.h"
#include "util/evsel.h"
18
#include "util/sort.h"
19
#include "util/data.h"
20
#include "util/auxtrace.h"
21 22 23
#include "util/cpumap.h"
#include "util/thread_map.h"
#include "util/stat.h"
24
#include <linux/bitmap.h>
25
#include "asm/bug.h"
J
Jiri Olsa 已提交
26
#include "util/mem-events.h"
F
Frederic Weisbecker 已提交
27

T
Tom Zanussi 已提交
28 29
static char const		*script_name;
static char const		*generate_script_lang;
30
static bool			debug_mode;
31
static u64			last_timestamp;
32
static u64			nr_unordered;
33
static bool			no_callchain;
34
static bool			latency_format;
35
static bool			system_wide;
36
static bool			print_flags;
37
static bool			nanosecs;
38 39
static const char		*cpu_list;
static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
40
static struct perf_stat_config	stat_config;
T
Tom Zanussi 已提交
41

42
unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
43

44 45 46 47 48 49 50 51
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,
52 53
	PERF_OUTPUT_IP              = 1U << 7,
	PERF_OUTPUT_SYM             = 1U << 8,
54
	PERF_OUTPUT_DSO             = 1U << 9,
55
	PERF_OUTPUT_ADDR            = 1U << 10,
56
	PERF_OUTPUT_SYMOFFSET       = 1U << 11,
57
	PERF_OUTPUT_SRCLINE         = 1U << 12,
J
Jiri Olsa 已提交
58
	PERF_OUTPUT_PERIOD          = 1U << 13,
59
	PERF_OUTPUT_IREGS	    = 1U << 14,
60 61
	PERF_OUTPUT_BRSTACK	    = 1U << 15,
	PERF_OUTPUT_BRSTACKSYM	    = 1U << 16,
62 63
	PERF_OUTPUT_DATA_SRC	    = 1U << 17,
	PERF_OUTPUT_WEIGHT	    = 1U << 18,
64
	PERF_OUTPUT_BPF_OUTPUT	    = 1U << 19,
65 66 67 68 69 70 71 72 73 74 75 76 77
};

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},
78
	{.str = "ip",    .field = PERF_OUTPUT_IP},
79
	{.str = "sym",   .field = PERF_OUTPUT_SYM},
80
	{.str = "dso",   .field = PERF_OUTPUT_DSO},
81
	{.str = "addr",  .field = PERF_OUTPUT_ADDR},
82
	{.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
83
	{.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
J
Jiri Olsa 已提交
84
	{.str = "period", .field = PERF_OUTPUT_PERIOD},
85
	{.str = "iregs", .field = PERF_OUTPUT_IREGS},
86 87
	{.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
	{.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
88 89
	{.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
	{.str = "weight",   .field = PERF_OUTPUT_WEIGHT},
90
	{.str = "bpf-output",   .field = PERF_OUTPUT_BPF_OUTPUT},
91 92 93
};

/* default set to maintain compatibility with current format */
94 95
static struct {
	bool user_set;
96
	bool wildcard_set;
97
	unsigned int print_ip_opts;
98 99 100 101 102 103 104 105 106
	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 |
107
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
108 109
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
			      PERF_OUTPUT_PERIOD,
110

111
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
112 113 114 115 116 117 118
	},

	[PERF_TYPE_SOFTWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
119
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
120
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
121
			      PERF_OUTPUT_PERIOD | PERF_OUTPUT_BPF_OUTPUT,
122 123 124 125 126 127 128 129 130

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_TRACEPOINT] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
				  PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
131
				  PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
132
	},
133 134 135 136 137 138

	[PERF_TYPE_RAW] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
139
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
140
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
141 142
			      PERF_OUTPUT_PERIOD |  PERF_OUTPUT_ADDR |
			      PERF_OUTPUT_DATA_SRC | PERF_OUTPUT_WEIGHT,
143

144
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
145
	},
146 147 148 149 150 151 152 153 154 155

	[PERF_TYPE_BREAKPOINT] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
			      PERF_OUTPUT_PERIOD,

156
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
157
	},
158
};
159

160 161 162 163 164 165 166 167 168
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;
}
169

170 171 172 173 174 175 176 177 178 179 180 181 182 183
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;
}

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

186 187 188 189
static int perf_evsel__do_check_stype(struct perf_evsel *evsel,
				      u64 sample_type, const char *sample_msg,
				      enum perf_output_field field,
				      bool allow_user_set)
190
{
191
	struct perf_event_attr *attr = &evsel->attr;
192 193 194 195 196 197 198
	int type = attr->type;
	const char *evname;

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

	if (output[type].user_set) {
199 200
		if (allow_user_set)
			return 0;
201
		evname = perf_evsel__name(evsel);
202 203 204 205 206 207 208 209
		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;
210
	evname = perf_evsel__name(evsel);
211 212 213 214 215 216 217
	pr_debug("Samples for '%s' event do not have %s attribute set. "
		 "Skipping '%s' field.\n",
		 evname, sample_msg, output_field2str(field));

	return 0;
}

218 219 220 221 222 223 224 225
static int perf_evsel__check_stype(struct perf_evsel *evsel,
				   u64 sample_type, const char *sample_msg,
				   enum perf_output_field field)
{
	return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
					  false);
}

226 227 228 229
static int perf_evsel__check_attr(struct perf_evsel *evsel,
				  struct perf_session *session)
{
	struct perf_event_attr *attr = &evsel->attr;
230 231
	bool allow_user_set;

232 233 234
	if (perf_header__has_feat(&session->header, HEADER_STAT))
		return 0;

235 236
	allow_user_set = perf_header__has_feat(&session->header,
					       HEADER_AUXTRACE);
237

238 239 240 241
	if (PRINT_FIELD(TRACE) &&
		!perf_session__has_traces(session, "record -R"))
		return -EINVAL;

242
	if (PRINT_FIELD(IP)) {
243 244
		if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
					    PERF_OUTPUT_IP))
245 246
			return -EINVAL;
	}
247 248

	if (PRINT_FIELD(ADDR) &&
249 250
		perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
					   PERF_OUTPUT_ADDR, allow_user_set))
251 252
		return -EINVAL;

253 254 255 256 257 258 259 260 261 262
	if (PRINT_FIELD(DATA_SRC) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
					PERF_OUTPUT_DATA_SRC))
		return -EINVAL;

	if (PRINT_FIELD(WEIGHT) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
					PERF_OUTPUT_WEIGHT))
		return -EINVAL;

263 264 265 266
	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");
267 268
		return -EINVAL;
	}
269 270 271 272 273
	if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
		pr_err("Display of offsets requested but symbol is not"
		       "selected.\n");
		return -EINVAL;
	}
274 275 276 277
	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");
278 279
		return -EINVAL;
	}
280 281 282 283 284
	if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
		pr_err("Display of source line number requested but sample IP is not\n"
		       "selected. Hence, no address to lookup the source line number.\n");
		return -EINVAL;
	}
285 286

	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
287 288
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
					PERF_OUTPUT_TID|PERF_OUTPUT_PID))
289 290 291
		return -EINVAL;

	if (PRINT_FIELD(TIME) &&
292 293
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
					PERF_OUTPUT_TIME))
294 295 296
		return -EINVAL;

	if (PRINT_FIELD(CPU) &&
297 298
		perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
					   PERF_OUTPUT_CPU, allow_user_set))
299
		return -EINVAL;
300

J
Jiri Olsa 已提交
301 302 303 304 305
	if (PRINT_FIELD(PERIOD) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD",
					PERF_OUTPUT_PERIOD))
		return -EINVAL;

306 307 308 309 310
	if (PRINT_FIELD(IREGS) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
					PERF_OUTPUT_IREGS))
		return -EINVAL;

311 312 313
	return 0;
}

314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
static void set_print_ip_opts(struct perf_event_attr *attr)
{
	unsigned int type = attr->type;

	output[type].print_ip_opts = 0;
	if (PRINT_FIELD(IP))
		output[type].print_ip_opts |= PRINT_IP_OPT_IP;

	if (PRINT_FIELD(SYM))
		output[type].print_ip_opts |= PRINT_IP_OPT_SYM;

	if (PRINT_FIELD(DSO))
		output[type].print_ip_opts |= PRINT_IP_OPT_DSO;

	if (PRINT_FIELD(SYMOFFSET))
		output[type].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET;
330 331 332

	if (PRINT_FIELD(SRCLINE))
		output[type].print_ip_opts |= PRINT_IP_OPT_SRCLINE;
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
/*
 * 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;
361 362 363 364

		if (evsel == NULL)
			continue;

365
		set_print_ip_opts(&evsel->attr);
366 367
	}

368 369 370 371 372 373 374 375 376 377 378 379 380
	if (!no_callchain) {
		bool use_callchain = false;

		evlist__for_each(session->evlist, evsel) {
			if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) {
				use_callchain = true;
				break;
			}
		}
		if (!use_callchain)
			symbol_conf.use_callchain = false;
	}

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
	/*
	 * set default for tracepoints to print symbols only
	 * if callchains are present
	 */
	if (symbol_conf.use_callchain &&
	    !output[PERF_TYPE_TRACEPOINT].user_set) {
		struct perf_event_attr *attr;

		j = PERF_TYPE_TRACEPOINT;
		evsel = perf_session__find_first_evtype(session, j);
		if (evsel == NULL)
			goto out;

		attr = &evsel->attr;

		if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
			output[j].fields |= PERF_OUTPUT_IP;
			output[j].fields |= PERF_OUTPUT_SYM;
			output[j].fields |= PERF_OUTPUT_DSO;
			set_print_ip_opts(attr);
		}
	}

out:
405 406
	return 0;
}
407

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
static void print_sample_iregs(union perf_event *event __maybe_unused,
			  struct perf_sample *sample,
			  struct thread *thread __maybe_unused,
			  struct perf_event_attr *attr)
{
	struct regs_dump *regs = &sample->intr_regs;
	uint64_t mask = attr->sample_regs_intr;
	unsigned i = 0, r;

	if (!regs)
		return;

	for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
		u64 val = regs->regs[i++];
		printf("%5s:0x%"PRIx64" ", perf_reg_name(r), val);
	}
}

426
static void print_sample_start(struct perf_sample *sample,
427
			       struct thread *thread,
428
			       struct perf_evsel *evsel)
429
{
430
	struct perf_event_attr *attr = &evsel->attr;
431 432
	unsigned long secs;
	unsigned long usecs;
433 434 435 436
	unsigned long long nsecs;

	if (PRINT_FIELD(COMM)) {
		if (latency_format)
437
			printf("%8.8s ", thread__comm_str(thread));
438
		else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
439
			printf("%s ", thread__comm_str(thread));
440
		else
441
			printf("%16s ", thread__comm_str(thread));
442
	}
443

444 445 446 447 448 449 450 451 452 453 454 455 456
	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);
	}
457

458 459 460 461 462
	if (PRINT_FIELD(TIME)) {
		nsecs = sample->time;
		secs = nsecs / NSECS_PER_SEC;
		nsecs -= secs * NSECS_PER_SEC;
		usecs = nsecs / NSECS_PER_USEC;
463 464 465 466
		if (nanosecs)
			printf("%5lu.%09llu: ", secs, nsecs);
		else
			printf("%5lu.%06lu: ", secs, usecs);
467
	}
468 469
}

470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 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 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
static inline char
mispred_str(struct branch_entry *br)
{
	if (!(br->flags.mispred  || br->flags.predicted))
		return '-';

	return br->flags.predicted ? 'P' : 'M';
}

static void print_sample_brstack(union perf_event *event __maybe_unused,
			  struct perf_sample *sample,
			  struct thread *thread __maybe_unused,
			  struct perf_event_attr *attr __maybe_unused)
{
	struct branch_stack *br = sample->branch_stack;
	u64 i;

	if (!(br && br->nr))
		return;

	for (i = 0; i < br->nr; i++) {
		printf(" 0x%"PRIx64"/0x%"PRIx64"/%c/%c/%c/%d ",
			br->entries[i].from,
			br->entries[i].to,
			mispred_str( br->entries + i),
			br->entries[i].flags.in_tx? 'X' : '-',
			br->entries[i].flags.abort? 'A' : '-',
			br->entries[i].flags.cycles);
	}
}

static void print_sample_brstacksym(union perf_event *event __maybe_unused,
			  struct perf_sample *sample,
			  struct thread *thread __maybe_unused,
			  struct perf_event_attr *attr __maybe_unused)
{
	struct branch_stack *br = sample->branch_stack;
	struct addr_location alf, alt;
	u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
	u64 i, from, to;

	if (!(br && br->nr))
		return;

	for (i = 0; i < br->nr; i++) {

		memset(&alf, 0, sizeof(alf));
		memset(&alt, 0, sizeof(alt));
		from = br->entries[i].from;
		to   = br->entries[i].to;

		thread__find_addr_map(thread, cpumode, MAP__FUNCTION, from, &alf);
		if (alf.map)
			alf.sym = map__find_symbol(alf.map, alf.addr, NULL);

		thread__find_addr_map(thread, cpumode, MAP__FUNCTION, to, &alt);
		if (alt.map)
			alt.sym = map__find_symbol(alt.map, alt.addr, NULL);

		symbol__fprintf_symname_offs(alf.sym, &alf, stdout);
		putchar('/');
		symbol__fprintf_symname_offs(alt.sym, &alt, stdout);
		printf("/%c/%c/%c/%d ",
			mispred_str( br->entries + i),
			br->entries[i].flags.in_tx? 'X' : '-',
			br->entries[i].flags.abort? 'A' : '-',
			br->entries[i].flags.cycles);
	}
}


541 542 543 544 545 546 547 548 549 550 551 552
static void print_sample_addr(union perf_event *event,
			  struct perf_sample *sample,
			  struct thread *thread,
			  struct perf_event_attr *attr)
{
	struct addr_location al;

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

	if (!sample_addr_correlates_sym(attr))
		return;

553
	perf_event__preprocess_sample_addr(event, sample, thread, &al);
554 555

	if (PRINT_FIELD(SYM)) {
556
		printf(" ");
557 558 559 560
		if (PRINT_FIELD(SYMOFFSET))
			symbol__fprintf_symname_offs(al.sym, &al, stdout);
		else
			symbol__fprintf_symname(al.sym, stdout);
561 562 563
	}

	if (PRINT_FIELD(DSO)) {
564 565 566
		printf(" (");
		map__fprintf_dsoname(al.map, stdout);
		printf(")");
567 568 569
	}
}

570 571 572
static void print_sample_bts(union perf_event *event,
			     struct perf_sample *sample,
			     struct perf_evsel *evsel,
573 574
			     struct thread *thread,
			     struct addr_location *al)
575 576
{
	struct perf_event_attr *attr = &evsel->attr;
577
	bool print_srcline_last = false;
578 579 580

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

		if (symbol_conf.use_callchain && sample->callchain) {
584
			printf("\n");
585 586 587 588 589 590 591 592
		} else {
			printf(" ");
			if (print_opts & PRINT_IP_OPT_SRCLINE) {
				print_srcline_last = true;
				print_opts &= ~PRINT_IP_OPT_SRCLINE;
			}
		}
		perf_evsel__print_ip(evsel, sample, al, print_opts,
593
				     scripting_max_stack);
594 595 596
	}

	/* print branch_to information */
597 598
	if (PRINT_FIELD(ADDR) ||
	    ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
599 600
	     !output[attr->type].user_set)) {
		printf(" => ");
601
		print_sample_addr(event, sample, thread, attr);
602
	}
603

604 605 606
	if (print_srcline_last)
		map__fprintf_srcline(al->map, al->addr, "\n  ", stdout);

607 608 609
	printf("\n");
}

610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
static void print_sample_flags(u32 flags)
{
	const char *chars = PERF_IP_FLAG_CHARS;
	const int n = strlen(PERF_IP_FLAG_CHARS);
	char str[33];
	int i, pos = 0;

	for (i = 0; i < n; i++, flags >>= 1) {
		if (flags & 1)
			str[pos++] = chars[i];
	}
	for (; i < 32; i++, flags >>= 1) {
		if (flags & 1)
			str[pos++] = '?';
	}
	str[pos] = 0;
	printf("  %-4s ", str);
}

629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
struct printer_data {
	int line_no;
	bool hit_nul;
	bool is_printable;
};

static void
print_sample_bpf_output_printer(enum binary_printer_ops op,
				unsigned int val,
				void *extra)
{
	unsigned char ch = (unsigned char)val;
	struct printer_data *printer_data = extra;

	switch (op) {
	case BINARY_PRINT_DATA_BEGIN:
		printf("\n");
		break;
	case BINARY_PRINT_LINE_BEGIN:
		printf("%17s", !printer_data->line_no ? "BPF output:" :
						        "           ");
		break;
	case BINARY_PRINT_ADDR:
		printf(" %04x:", val);
		break;
	case BINARY_PRINT_NUM_DATA:
		printf(" %02x", val);
		break;
	case BINARY_PRINT_NUM_PAD:
		printf("   ");
		break;
	case BINARY_PRINT_SEP:
		printf("  ");
		break;
	case BINARY_PRINT_CHAR_DATA:
		if (printer_data->hit_nul && ch)
			printer_data->is_printable = false;

		if (!isprint(ch)) {
			printf("%c", '.');

			if (!printer_data->is_printable)
				break;

			if (ch == '\0')
				printer_data->hit_nul = true;
			else
				printer_data->is_printable = false;
		} else {
			printf("%c", ch);
		}
		break;
	case BINARY_PRINT_CHAR_PAD:
		printf(" ");
		break;
	case BINARY_PRINT_LINE_END:
		printf("\n");
		printer_data->line_no++;
		break;
	case BINARY_PRINT_DATA_END:
	default:
		break;
	}
}

static void print_sample_bpf_output(struct perf_sample *sample)
{
	unsigned int nr_bytes = sample->raw_size;
	struct printer_data printer_data = {0, false, true};

	print_binary(sample->raw_data, nr_bytes, 8,
		     print_sample_bpf_output_printer, &printer_data);

	if (printer_data.is_printable && printer_data.hit_nul)
		printf("%17s \"%s\"\n", "BPF string:",
		       (char *)(sample->raw_data));
}

707 708 709 710 711 712
struct perf_script {
	struct perf_tool	tool;
	struct perf_session	*session;
	bool			show_task_events;
	bool			show_mmap_events;
	bool			show_switch_events;
713 714 715
	bool			allocated;
	struct cpu_map		*cpus;
	struct thread_map	*threads;
716
	int			name_width;
717 718
};

719 720 721 722 723 724 725 726 727 728 729 730 731 732
static int perf_evlist__max_name_len(struct perf_evlist *evlist)
{
	struct perf_evsel *evsel;
	int max = 0;

	evlist__for_each(evlist, evsel) {
		int len = strlen(perf_evsel__name(evsel));

		max = MAX(len, max);
	}

	return max;
}

J
Jiri Olsa 已提交
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
static size_t data_src__printf(u64 data_src)
{
	struct mem_info mi = { .data_src.val = data_src };
	char decode[100];
	char out[100];
	static int maxlen;
	int len;

	perf_script__meminfo_scnprintf(decode, 100, &mi);

	len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
	if (maxlen < len)
		maxlen = len;

	return printf("%-*s", maxlen, out);
}

750
static void process_event(struct perf_script *script, union perf_event *event,
751 752
			  struct perf_sample *sample, struct perf_evsel *evsel,
			  struct addr_location *al)
753
{
754
	struct thread *thread = al->thread;
755
	struct perf_event_attr *attr = &evsel->attr;
756

757
	if (output[attr->type].fields == 0)
758 759
		return;

760
	print_sample_start(sample, thread, evsel);
761

J
Jiri Olsa 已提交
762 763 764
	if (PRINT_FIELD(PERIOD))
		printf("%10" PRIu64 " ", sample->period);

765 766
	if (PRINT_FIELD(EVNAME)) {
		const char *evname = perf_evsel__name(evsel);
767 768 769 770 771 772

		if (!script->name_width)
			script->name_width = perf_evlist__max_name_len(script->session->evlist);

		printf("%*s: ", script->name_width,
		       evname ? evname : "[unknown]");
773 774
	}

775 776 777
	if (print_flags)
		print_sample_flags(sample->flags);

778
	if (is_bts_event(attr)) {
779
		print_sample_bts(event, sample, evsel, thread, al);
780 781 782
		return;
	}

783
	if (PRINT_FIELD(TRACE))
784 785
		event_format__print(evsel->tp_format, sample->cpu,
				    sample->raw_data, sample->raw_size);
786
	if (PRINT_FIELD(ADDR))
787
		print_sample_addr(event, sample, thread, attr);
788

789
	if (PRINT_FIELD(DATA_SRC))
J
Jiri Olsa 已提交
790
		data_src__printf(sample->data_src);
791 792 793 794

	if (PRINT_FIELD(WEIGHT))
		printf("%16" PRIu64, sample->weight);

795
	if (PRINT_FIELD(IP)) {
796 797 798 799
		if (!symbol_conf.use_callchain)
			printf(" ");
		else
			printf("\n");
800

801
		perf_evsel__print_ip(evsel, sample, al,
802
				     output[attr->type].print_ip_opts,
803
				     scripting_max_stack);
804 805
	}

806 807 808
	if (PRINT_FIELD(IREGS))
		print_sample_iregs(event, sample, thread, attr);

809 810 811 812 813
	if (PRINT_FIELD(BRSTACK))
		print_sample_brstack(event, sample, thread, attr);
	else if (PRINT_FIELD(BRSTACKSYM))
		print_sample_brstacksym(event, sample, thread, attr);

814 815 816
	if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
		print_sample_bpf_output(sample);

817
	printf("\n");
818 819
}

T
Tom Zanussi 已提交
820 821
static struct scripting_ops	*scripting_ops;

822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
static void __process_stat(struct perf_evsel *counter, u64 tstamp)
{
	int nthreads = thread_map__nr(counter->threads);
	int ncpus = perf_evsel__nr_cpus(counter);
	int cpu, thread;
	static int header_printed;

	if (counter->system_wide)
		nthreads = 1;

	if (!header_printed) {
		printf("%3s %8s %15s %15s %15s %15s %s\n",
		       "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
		header_printed = 1;
	}

	for (thread = 0; thread < nthreads; thread++) {
		for (cpu = 0; cpu < ncpus; cpu++) {
			struct perf_counts_values *counts;

			counts = perf_counts(counter->counts, cpu, thread);

			printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
				counter->cpus->map[cpu],
				thread_map__pid(counter->threads, thread),
				counts->val,
				counts->ena,
				counts->run,
				tstamp,
				perf_evsel__name(counter));
		}
	}
}

856 857 858 859
static void process_stat(struct perf_evsel *counter, u64 tstamp)
{
	if (scripting_ops && scripting_ops->process_stat)
		scripting_ops->process_stat(&stat_config, counter, tstamp);
860 861
	else
		__process_stat(counter, tstamp);
862 863 864 865 866 867 868 869
}

static void process_stat_interval(u64 tstamp)
{
	if (scripting_ops && scripting_ops->process_stat_interval)
		scripting_ops->process_stat_interval(tstamp);
}

T
Tom Zanussi 已提交
870 871
static void setup_scripting(void)
{
872
	setup_perl_scripting();
873
	setup_python_scripting();
T
Tom Zanussi 已提交
874 875
}

876 877
static int flush_scripting(void)
{
878
	return scripting_ops ? scripting_ops->flush_script() : 0;
879 880
}

T
Tom Zanussi 已提交
881 882
static int cleanup_scripting(void)
{
883
	pr_debug("\nperf script stopped\n");
884

885
	return scripting_ops ? scripting_ops->stop_script() : 0;
T
Tom Zanussi 已提交
886 887
}

888
static int process_sample_event(struct perf_tool *tool,
889
				union perf_event *event,
890
				struct perf_sample *sample,
891
				struct perf_evsel *evsel,
892
				struct machine *machine)
F
Frederic Weisbecker 已提交
893
{
894
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
895
	struct addr_location al;
F
Frederic Weisbecker 已提交
896

897 898 899 900 901 902
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
903
		}
904 905
		last_timestamp = sample->time;
		return 0;
F
Frederic Weisbecker 已提交
906
	}
907

908
	if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
909 910 911 912 913 914
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
		return -1;
	}

	if (al.filtered)
915
		goto out_put;
916

917
	if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
918
		goto out_put;
919

920 921 922
	if (scripting_ops)
		scripting_ops->process_event(event, sample, evsel, &al);
	else
923
		process_event(scr, event, sample, evsel, &al);
924

925 926
out_put:
	addr_location__put(&al);
F
Frederic Weisbecker 已提交
927 928 929
	return 0;
}

930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
static int process_attr(struct perf_tool *tool, union perf_event *event,
			struct perf_evlist **pevlist)
{
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
	struct perf_evlist *evlist;
	struct perf_evsel *evsel, *pos;
	int err;

	err = perf_event__process_attr(tool, event, pevlist);
	if (err)
		return err;

	evlist = *pevlist;
	evsel = perf_evlist__last(*pevlist);

	if (evsel->attr.type >= PERF_TYPE_MAX)
		return 0;

948
	evlist__for_each(evlist, pos) {
949 950 951 952 953 954
		if (pos->attr.type == evsel->attr.type && pos != evsel)
			return 0;
	}

	set_print_ip_opts(&evsel->attr);

955 956 957 958
	if (evsel->attr.sample_type)
		err = perf_evsel__check_attr(evsel, scr->session);

	return err;
959 960
}

961 962 963 964 965 966 967 968
static int process_comm_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
969
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990
	int ret = -1;

	thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
	if (thread == NULL) {
		pr_debug("problem processing COMM event, skipping it.\n");
		return -1;
	}

	if (perf_event__process_comm(tool, event, sample, machine) < 0)
		goto out;

	if (!evsel->attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = 0;
		sample->tid = event->comm.tid;
		sample->pid = event->comm.pid;
	}
	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);
	ret = 0;
out:
991
	thread__put(thread);
992 993 994 995 996 997 998 999 1000 1001 1002
	return ret;
}

static int process_fork_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
1003
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021

	if (perf_event__process_fork(tool, event, sample, machine) < 0)
		return -1;

	thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
	if (thread == NULL) {
		pr_debug("problem processing FORK event, skipping it.\n");
		return -1;
	}

	if (!evsel->attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = event->fork.time;
		sample->tid = event->fork.tid;
		sample->pid = event->fork.pid;
	}
	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);
1022
	thread__put(thread);
1023 1024 1025 1026 1027 1028 1029 1030

	return 0;
}
static int process_exit_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
1031
	int err = 0;
1032 1033 1034
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
1035
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045

	thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
	if (thread == NULL) {
		pr_debug("problem processing EXIT event, skipping it.\n");
		return -1;
	}

	if (!evsel->attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = 0;
1046 1047
		sample->tid = event->fork.tid;
		sample->pid = event->fork.pid;
1048 1049 1050 1051 1052
	}
	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);

	if (perf_event__process_exit(tool, event, sample, machine) < 0)
1053
		err = -1;
1054

1055 1056
	thread__put(thread);
	return err;
1057 1058
}

1059 1060 1061 1062 1063 1064 1065 1066
static int process_mmap_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
1067
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085

	if (perf_event__process_mmap(tool, event, sample, machine) < 0)
		return -1;

	thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
	if (thread == NULL) {
		pr_debug("problem processing MMAP event, skipping it.\n");
		return -1;
	}

	if (!evsel->attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = 0;
		sample->tid = event->mmap.tid;
		sample->pid = event->mmap.pid;
	}
	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);
1086
	thread__put(thread);
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
	return 0;
}

static int process_mmap2_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
1098
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116

	if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
		return -1;

	thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
	if (thread == NULL) {
		pr_debug("problem processing MMAP2 event, skipping it.\n");
		return -1;
	}

	if (!evsel->attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = 0;
		sample->tid = event->mmap2.tid;
		sample->pid = event->mmap2.pid;
	}
	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);
1117
	thread__put(thread);
1118 1119 1120
	return 0;
}

1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
static int process_switch_event(struct perf_tool *tool,
				union perf_event *event,
				struct perf_sample *sample,
				struct machine *machine)
{
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);

	if (perf_event__process_switch(tool, event, sample, machine) < 0)
		return -1;

	thread = machine__findnew_thread(machine, sample->pid,
					 sample->tid);
	if (thread == NULL) {
		pr_debug("problem processing SWITCH event, skipping it.\n");
		return -1;
	}

	print_sample_start(sample, thread, evsel);
	perf_event__fprintf(event, stdout);
	thread__put(thread);
	return 0;
}

1147
static void sig_handler(int sig __maybe_unused)
1148 1149 1150 1151
{
	session_done = 1;
}

1152
static int __cmd_script(struct perf_script *script)
F
Frederic Weisbecker 已提交
1153
{
1154 1155
	int ret;

1156 1157
	signal(SIGINT, sig_handler);

1158 1159 1160 1161 1162 1163
	/* override event processing functions */
	if (script->show_task_events) {
		script->tool.comm = process_comm_event;
		script->tool.fork = process_fork_event;
		script->tool.exit = process_exit_event;
	}
1164 1165 1166 1167
	if (script->show_mmap_events) {
		script->tool.mmap = process_mmap_event;
		script->tool.mmap2 = process_mmap2_event;
	}
1168 1169
	if (script->show_switch_events)
		script->tool.context_switch = process_switch_event;
1170

1171
	ret = perf_session__process_events(script->session);
1172

1173
	if (debug_mode)
1174
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
1175 1176

	return ret;
F
Frederic Weisbecker 已提交
1177 1178
}

T
Tom Zanussi 已提交
1179 1180 1181 1182 1183 1184
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
	char			spec[0];
};

1185
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222

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

int script_spec_register(const char *spec, struct scripting_ops *ops)
{
	struct script_spec *s;

	s = script_spec__find(spec);
	if (s)
		return -1;

1223
	s = script_spec__new(spec, ops);
T
Tom Zanussi 已提交
1224 1225
	if (!s)
		return -1;
1226 1227
	else
		script_spec__add(s);
T
Tom Zanussi 已提交
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246

	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 "
1247
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
1248 1249 1250 1251 1252 1253 1254

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

	fprintf(stderr, "\n");
}

1255 1256
static int parse_scriptname(const struct option *opt __maybe_unused,
			    const char *str, int unset __maybe_unused)
T
Tom Zanussi 已提交
1257 1258 1259 1260 1261
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

1262
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
1263
		list_available_languages();
1264
		exit(0);
T
Tom Zanussi 已提交
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
	}

	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;
1284
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
		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;
}

1301 1302
static int parse_output_fields(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused)
1303 1304
{
	char *tok;
1305
	int i, imax = ARRAY_SIZE(all_output_options);
1306
	int j;
1307 1308
	int rc = 0;
	char *str = strdup(arg);
1309
	int type = -1;
1310 1311 1312 1313

	if (!str)
		return -ENOMEM;

1314 1315 1316
	/* 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.
1317
	 */
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
	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;
1328 1329
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
1330 1331
		else if (!strcmp(str, "break"))
			type = PERF_TYPE_BREAKPOINT;
1332 1333
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
1334 1335
			rc = -EINVAL;
			goto out;
1336 1337 1338 1339 1340 1341 1342 1343
		}

		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;
1344
		output[type].wildcard_set = false;
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360

	} 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;
1361
			output[j].wildcard_set = true;
1362
		}
1363 1364
	}

1365
	for (tok = strtok(tok, ","); tok; tok = strtok(NULL, ",")) {
1366
		for (i = 0; i < imax; ++i) {
1367
			if (strcmp(tok, all_output_options[i].str) == 0)
1368 1369
				break;
		}
1370 1371 1372 1373
		if (i == imax && strcmp(tok, "flags") == 0) {
			print_flags = true;
			continue;
		}
1374
		if (i == imax) {
1375
			fprintf(stderr, "Invalid field requested.\n");
1376
			rc = -EINVAL;
1377
			goto out;
1378 1379
		}

1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
		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;
		}
1401 1402
	}

1403 1404 1405 1406 1407 1408
	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));
		}
	}
1409

1410
out:
1411 1412 1413 1414
	free(str);
	return rc;
}

1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428
/* 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)\
1429 1430
	while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) &&	\
	       lang_next)						\
1431 1432 1433
		if ((lang_dirent.d_type == DT_DIR ||			\
		     (lang_dirent.d_type == DT_UNKNOWN &&		\
		      is_directory(scripts_path, &lang_dirent))) &&	\
1434 1435 1436
		    (strcmp(lang_dirent.d_name, ".")) &&		\
		    (strcmp(lang_dirent.d_name, "..")))

1437
#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
1438 1439
	while (!readdir_r(lang_dir, &script_dirent, &script_next) &&	\
	       script_next)						\
1440 1441 1442
		if (script_dirent.d_type != DT_DIR &&			\
		    (script_dirent.d_type != DT_UNKNOWN ||		\
		     !is_directory(lang_path, &script_dirent)))
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454


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

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

1455
static LIST_HEAD(script_descs);
1456 1457 1458 1459 1460

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

1461
	if (s != NULL && name)
1462 1463 1464 1465 1466 1467 1468
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
1469 1470 1471
	zfree(&s->name);
	zfree(&s->half_liner);
	zfree(&s->args);
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
	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;
}

1511
static const char *ends_with(const char *str, const char *suffix)
1512 1513
{
	size_t suffix_len = strlen(suffix);
1514
	const char *p = str;
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565

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

	return NULL;
}

static int read_script_info(struct script_desc *desc, const char *filename)
{
	char line[BUFSIZ], *p;
	FILE *fp;

	fp = fopen(filename, "r");
	if (!fp)
		return -1;

	while (fgets(line, sizeof(line), fp)) {
		p = ltrim(line);
		if (strlen(p) == 0)
			continue;
		if (*p != '#')
			continue;
		p++;
		if (strlen(p) && *p == '!')
			continue;

		p = ltrim(p);
		if (strlen(p) && p[strlen(p) - 1] == '\n')
			p[strlen(p) - 1] = '\0';

		if (!strncmp(p, "description:", strlen("description:"))) {
			p += strlen("description:");
			desc->half_liner = strdup(ltrim(p));
			continue;
		}

		if (!strncmp(p, "args:", strlen("args:"))) {
			p += strlen("args:");
			desc->args = strdup(ltrim(p));
			continue;
		}
	}

	fclose(fp);

	return 0;
}

1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583
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;
}

1584 1585 1586
static int list_available_scripts(const struct option *opt __maybe_unused,
				  const char *s __maybe_unused,
				  int unset __maybe_unused)
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596
{
	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;

1597
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1598 1599 1600 1601 1602

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

1603
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1604 1605 1606 1607 1608 1609
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1610
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1611 1612
			script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
			if (script_root) {
1613 1614 1615 1616
				desc = script_desc__findnew(script_root);
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
				read_script_info(desc, script_path);
1617
				free(script_root);
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632
			}
		}
	}

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

1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675
/*
 * Some scripts specify the required events in their "xxx-record" file,
 * this function will check if the events in perf.data match those
 * mentioned in the "xxx-record".
 *
 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
 * which is covered well now. And new parsing code should be added to
 * cover the future complexing formats like event groups etc.
 */
static int check_ev_match(char *dir_name, char *scriptname,
			struct perf_session *session)
{
	char filename[MAXPATHLEN], evname[128];
	char line[BUFSIZ], *p;
	struct perf_evsel *pos;
	int match, len;
	FILE *fp;

	sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);

	fp = fopen(filename, "r");
	if (!fp)
		return -1;

	while (fgets(line, sizeof(line), fp)) {
		p = ltrim(line);
		if (*p == '#')
			continue;

		while (strlen(p)) {
			p = strstr(p, "-e");
			if (!p)
				break;

			p += 2;
			p = ltrim(p);
			len = strcspn(p, " \t");
			if (!len)
				break;

			snprintf(evname, len + 1, "%s", p);

			match = 0;
1676
			evlist__for_each(session->evlist, pos) {
1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693
				if (!strcmp(perf_evsel__name(pos), evname)) {
					match = 1;
					break;
				}
			}

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

	fclose(fp);
	return 0;
}

1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
/*
 * Return -1 if none is found, otherwise the actual scripts number.
 *
 * Currently the only user of this function is the script browser, which
 * will list all statically runnable scripts, select one, execute it and
 * show the output in a perf browser.
 */
int find_scripts(char **scripts_array, char **scripts_path_array)
{
	struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1704
	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1705
	DIR *scripts_dir, *lang_dir;
1706
	struct perf_session *session;
1707 1708 1709 1710
	struct perf_data_file file = {
		.path = input_name,
		.mode = PERF_DATA_MODE_READ,
	};
1711 1712 1713
	char *temp;
	int i = 0;

1714
	session = perf_session__new(&file, false, NULL);
1715 1716 1717
	if (!session)
		return -1;

1718
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1719 1720

	scripts_dir = opendir(scripts_path);
1721 1722
	if (!scripts_dir) {
		perf_session__delete(session);
1723
		return -1;
1724
	}
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751

	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
		snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
			 lang_dirent.d_name);
#ifdef NO_LIBPERL
		if (strstr(lang_path, "perl"))
			continue;
#endif
#ifdef NO_LIBPYTHON
		if (strstr(lang_path, "python"))
			continue;
#endif

		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
			/* Skip those real time scripts: xxxtop.p[yl] */
			if (strstr(script_dirent.d_name, "top."))
				continue;
			sprintf(scripts_path_array[i], "%s/%s", lang_path,
				script_dirent.d_name);
			temp = strchr(script_dirent.d_name, '.');
			snprintf(scripts_array[i],
				(temp - script_dirent.d_name) + 1,
				"%s", script_dirent.d_name);
1752 1753 1754 1755 1756

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

1757 1758
			i++;
		}
1759
		closedir(lang_dir);
1760 1761
	}

1762 1763
	closedir(scripts_dir);
	perf_session__delete(session);
1764 1765 1766
	return i;
}

1767 1768 1769 1770 1771 1772 1773
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];
1774
	char *__script_root;
1775

1776
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
1777 1778 1779 1780 1781

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

1782
	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1783 1784 1785 1786 1787 1788
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

1789
		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1790 1791 1792
			__script_root = get_script_root(&script_dirent, suffix);
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
1793 1794
				closedir(lang_dir);
				closedir(scripts_dir);
1795 1796
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
1797
				return strdup(script_path);
1798 1799 1800
			}
			free(__script_root);
		}
1801
		closedir(lang_dir);
1802
	}
1803
	closedir(scripts_dir);
1804

1805
	return NULL;
1806 1807
}

1808 1809
static bool is_top_script(const char *script_path)
{
1810
	return ends_with(script_path, "top") == NULL ? false : true;
1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835
}

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

1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848
static int have_cmd(int argc, const char **argv)
{
	char **__argv = malloc(sizeof(const char *) * argc);

	if (!__argv) {
		pr_err("malloc failed\n");
		return -1;
	}

	memcpy(__argv, argv, sizeof(const char *) * argc);
	argc = parse_options(argc, (const char **)__argv, record_options,
			     NULL, PARSE_OPT_STOP_AT_NON_OPTION);
	free(__argv);
F
Frederic Weisbecker 已提交
1849

1850 1851 1852 1853 1854
	system_wide = (argc == 0);

	return 0;
}

1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870
static void script__setup_sample_type(struct perf_script *script)
{
	struct perf_session *session = script->session;
	u64 sample_type = perf_evlist__combined_sample_type(session->evlist);

	if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
		if ((sample_type & PERF_SAMPLE_REGS_USER) &&
		    (sample_type & PERF_SAMPLE_STACK_USER))
			callchain_param.record_mode = CALLCHAIN_DWARF;
		else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
			callchain_param.record_mode = CALLCHAIN_LBR;
		else
			callchain_param.record_mode = CALLCHAIN_FP;
	}
}

1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
static int process_stat_round_event(struct perf_tool *tool __maybe_unused,
				    union perf_event *event,
				    struct perf_session *session)
{
	struct stat_round_event *round = &event->stat_round;
	struct perf_evsel *counter;

	evlist__for_each(session->evlist, counter) {
		perf_stat_process_counter(&stat_config, counter);
		process_stat(counter, round->time);
	}

	process_stat_interval(round->time);
	return 0;
}

1887 1888 1889 1890 1891 1892 1893 1894
static int process_stat_config_event(struct perf_tool *tool __maybe_unused,
				     union perf_event *event,
				     struct perf_session *session __maybe_unused)
{
	perf_event__read_stat_config(&stat_config, &event->stat_config);
	return 0;
}

1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951
static int set_maps(struct perf_script *script)
{
	struct perf_evlist *evlist = script->session->evlist;

	if (!script->cpus || !script->threads)
		return 0;

	if (WARN_ONCE(script->allocated, "stats double allocation\n"))
		return -EINVAL;

	perf_evlist__set_maps(evlist, script->cpus, script->threads);

	if (perf_evlist__alloc_stats(evlist, true))
		return -ENOMEM;

	script->allocated = true;
	return 0;
}

static
int process_thread_map_event(struct perf_tool *tool,
			     union perf_event *event,
			     struct perf_session *session __maybe_unused)
{
	struct perf_script *script = container_of(tool, struct perf_script, tool);

	if (script->threads) {
		pr_warning("Extra thread map event, ignoring.\n");
		return 0;
	}

	script->threads = thread_map__new_event(&event->thread_map);
	if (!script->threads)
		return -ENOMEM;

	return set_maps(script);
}

static
int process_cpu_map_event(struct perf_tool *tool __maybe_unused,
			  union perf_event *event,
			  struct perf_session *session __maybe_unused)
{
	struct perf_script *script = container_of(tool, struct perf_script, tool);

	if (script->cpus) {
		pr_warning("Extra cpu map event, ignoring.\n");
		return 0;
	}

	script->cpus = cpu_map__new_data(&event->cpu_map.data);
	if (!script->cpus)
		return -ENOMEM;

	return set_maps(script);
}

1952 1953 1954
int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
{
	bool show_full_info = false;
1955 1956
	bool header = false;
	bool header_only = false;
1957
	bool script_started = false;
1958 1959 1960
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
	struct perf_session *session;
1961
	struct itrace_synth_opts itrace_synth_opts = { .set = false, };
1962 1963
	char *script_path = NULL;
	const char **__argv;
1964
	int i, j, err = 0;
1965 1966 1967 1968 1969 1970 1971 1972
	struct perf_script script = {
		.tool = {
			.sample		 = process_sample_event,
			.mmap		 = perf_event__process_mmap,
			.mmap2		 = perf_event__process_mmap2,
			.comm		 = perf_event__process_comm,
			.exit		 = perf_event__process_exit,
			.fork		 = perf_event__process_fork,
1973
			.attr		 = process_attr,
1974 1975
			.tracing_data	 = perf_event__process_tracing_data,
			.build_id	 = perf_event__process_build_id,
1976 1977 1978 1979
			.id_index	 = perf_event__process_id_index,
			.auxtrace_info	 = perf_event__process_auxtrace_info,
			.auxtrace	 = perf_event__process_auxtrace,
			.auxtrace_error	 = perf_event__process_auxtrace_error,
1980 1981
			.stat		 = perf_event__process_stat_event,
			.stat_round	 = process_stat_round_event,
1982
			.stat_config	 = process_stat_config_event,
1983 1984
			.thread_map	 = process_thread_map_event,
			.cpu_map	 = process_cpu_map_event,
1985
			.ordered_events	 = true,
1986 1987 1988
			.ordering_requires_timestamps = true,
		},
	};
1989 1990 1991
	struct perf_data_file file = {
		.mode = PERF_DATA_MODE_READ,
	};
1992
	const struct option options[] = {
F
Frederic Weisbecker 已提交
1993 1994
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
1995
	OPT_INCR('v', "verbose", &verbose,
1996
		 "be more verbose (show symbol address, etc)"),
1997
	OPT_BOOLEAN('L', "Latency", &latency_format,
1998
		    "show latency attributes (irqs/preemption disabled, etc)"),
1999 2000
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
T
Tom Zanussi 已提交
2001 2002 2003 2004
	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",
2005
		   "generate perf-script.xx script in specified language"),
2006
	OPT_STRING('i', "input", &input_name, "file", "input file name"),
2007 2008
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
2009 2010
	OPT_BOOLEAN(0, "header", &header, "Show data header."),
	OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
2011 2012 2013 2014 2015 2016 2017 2018
	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"),
2019
	OPT_CALLBACK('F', "fields", NULL, "str",
2020 2021 2022
		     "comma separated output fields prepend with 'type:'. "
		     "Valid types: hw,sw,trace,raw. "
		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
2023
		     "addr,symoff,period,iregs,brstack,brstacksym,flags", parse_output_fields),
2024
	OPT_BOOLEAN('a', "all-cpus", &system_wide,
2025
		    "system-wide collection from all CPUs"),
2026 2027
	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
		   "only consider these symbols"),
2028
	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
2029 2030
	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only display events for these comms"),
2031 2032 2033 2034
	OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
		   "only consider symbols in these pids"),
	OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
		   "only consider symbols in these tids"),
2035 2036
	OPT_BOOLEAN('I', "show-info", &show_full_info,
		    "display extended information from perf.data file"),
2037 2038
	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
		    "Show the path of [kernel.kallsyms]"),
2039 2040
	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
		    "Show the fork/comm/exit events"),
2041 2042
	OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
		    "Show the mmap events"),
2043 2044
	OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
		    "Show context switch events (if recorded)"),
2045
	OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
2046 2047
	OPT_BOOLEAN(0, "ns", &nanosecs,
		    "Use 9 decimal places when displaying time"),
2048 2049 2050
	OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
			    "Instruction Tracing options",
			    itrace_parse_synth_opts),
2051 2052
	OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
			"Show full source file name path for source lines"),
2053 2054 2055 2056 2057
	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
			"Enable symbol demangling"),
	OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
			"Enable kernel symbol demangling"),

2058
	OPT_END()
2059
	};
2060 2061
	const char * const script_subcommands[] = { "record", "report", NULL };
	const char *script_usage[] = {
2062 2063 2064 2065 2066 2067 2068
		"perf script [<options>]",
		"perf script [<options>] record <script> [<record-options>] <command>",
		"perf script [<options>] report <script> [script-args]",
		"perf script [<options>] <script> [<record-options>] <command>",
		"perf script [<options>] <top-script> [script-args]",
		NULL
	};
2069

2070 2071
	setup_scripting();

2072
	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
2073 2074
			     PARSE_OPT_STOP_AT_NON_OPTION);

2075 2076
	file.path = input_name;

2077 2078 2079 2080
	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);
2081 2082
	}

2083 2084 2085
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
2086
			fprintf(stderr,
2087
				"Please specify a valid report script"
2088
				"(see 'perf script -l' for listing)\n");
2089 2090 2091 2092
			return -1;
		}
	}

2093 2094 2095 2096
	if (itrace_synth_opts.callchain &&
	    itrace_synth_opts.callchain_sz > scripting_max_stack)
		scripting_max_stack = itrace_synth_opts.callchain_sz;

2097
	/* make sure PERF_EXEC_PATH is set for scripts */
2098
	set_argv_exec_path(get_argv_exec_path());
2099

2100
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
2101
		int live_pipe[2];
2102
		int rep_args;
2103 2104
		pid_t pid;

2105 2106 2107 2108
		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) {
2109 2110
			usage_with_options_msg(script_usage, options,
				"Couldn't find script `%s'\n\n See perf"
2111
				" script -l for available scripts.\n", argv[0]);
2112 2113
		}

2114 2115 2116 2117 2118 2119 2120 2121
		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) {
2122 2123
				usage_with_options_msg(script_usage, options,
					"`%s' script requires options."
2124
					"\n\n See perf script -l for available "
2125 2126
					"scripts and options.\n", argv[0]);
			}
2127 2128 2129 2130
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
2131
			return -1;
2132 2133 2134 2135 2136
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
2137
			return -1;
2138 2139 2140
		}

		if (!pid) {
2141 2142
			j = 0;

2143 2144 2145
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

2146 2147 2148
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
2149 2150 2151 2152
				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
					err = -1;
					goto out;
				}
2153
			}
2154 2155

			__argv = malloc((argc + 6) * sizeof(const char *));
2156 2157 2158 2159 2160
			if (!__argv) {
				pr_err("malloc failed\n");
				err = -ENOMEM;
				goto out;
			}
2161

2162 2163 2164 2165 2166 2167 2168 2169 2170 2171
			__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;
2172 2173

			execvp("/bin/sh", (char **)__argv);
2174
			free(__argv);
2175 2176 2177 2178 2179 2180
			exit(-1);
		}

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

2181
		__argv = malloc((argc + 4) * sizeof(const char *));
2182 2183 2184 2185 2186 2187
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

2188 2189 2190 2191 2192 2193 2194 2195
		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;
2196 2197

		execvp("/bin/sh", (char **)__argv);
2198
		free(__argv);
2199 2200 2201
		exit(-1);
	}

2202 2203 2204 2205
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
2206

2207 2208
	if (script_path) {
		j = 0;
2209

2210 2211
		if (!rec_script_path)
			system_wide = false;
2212 2213 2214 2215 2216 2217
		else if (!system_wide) {
			if (have_cmd(argc - 1, &argv[1]) != 0) {
				err = -1;
				goto out;
			}
		}
2218

2219
		__argv = malloc((argc + 2) * sizeof(const char *));
2220 2221 2222 2223 2224 2225
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

2226 2227 2228 2229
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
2230
		for (i = 2; i < argc; i++)
2231 2232
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
2233 2234

		execvp("/bin/sh", (char **)__argv);
2235
		free(__argv);
2236 2237
		exit(-1);
	}
T
Tom Zanussi 已提交
2238

2239 2240
	if (!script_name)
		setup_pager();
F
Frederic Weisbecker 已提交
2241

2242
	session = perf_session__new(&file, false, &script.tool);
2243
	if (session == NULL)
2244
		return -1;
2245

2246 2247 2248
	if (header || header_only) {
		perf_session__fprintf_info(session, stdout, show_full_info);
		if (header_only)
2249
			goto out_delete;
2250 2251
	}

2252
	if (symbol__init(&session->header.env) < 0)
2253 2254
		goto out_delete;

2255
	script.session = session;
2256
	script__setup_sample_type(&script);
2257

2258 2259
	session->itrace_synth_opts = &itrace_synth_opts;

2260
	if (cpu_list) {
2261 2262 2263
		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
		if (err < 0)
			goto out_delete;
2264 2265
	}

2266
	if (!no_callchain)
2267 2268 2269 2270
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

2271 2272
	if (session->tevent.pevent &&
	    pevent_set_function_resolver(session->tevent.pevent,
2273 2274 2275 2276 2277 2278
					 machine__resolve_kernel_addr,
					 &session->machines.host) < 0) {
		pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
		return -1;
	}

T
Tom Zanussi 已提交
2279 2280
	if (generate_script_lang) {
		struct stat perf_stat;
2281 2282
		int input;

2283
		if (output_set_by_user()) {
2284 2285
			fprintf(stderr,
				"custom fields not supported for generated scripts");
2286 2287
			err = -EINVAL;
			goto out_delete;
2288
		}
T
Tom Zanussi 已提交
2289

2290
		input = open(file.path, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
2291
		if (input < 0) {
2292
			err = -errno;
T
Tom Zanussi 已提交
2293
			perror("failed to open file");
2294
			goto out_delete;
T
Tom Zanussi 已提交
2295 2296 2297 2298 2299
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
2300
			goto out_delete;
T
Tom Zanussi 已提交
2301 2302 2303 2304
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
2305
			goto out_delete;
T
Tom Zanussi 已提交
2306 2307 2308 2309 2310
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
2311 2312
			err = -ENOENT;
			goto out_delete;
T
Tom Zanussi 已提交
2313 2314
		}

J
Jiri Olsa 已提交
2315
		err = scripting_ops->generate_script(session->tevent.pevent,
2316
						     "perf-script");
2317
		goto out_delete;
T
Tom Zanussi 已提交
2318 2319 2320
	}

	if (script_name) {
2321
		err = scripting_ops->start_script(script_name, argc, argv);
T
Tom Zanussi 已提交
2322
		if (err)
2323
			goto out_delete;
2324
		pr_debug("perf script started with script %s\n\n", script_name);
2325
		script_started = true;
T
Tom Zanussi 已提交
2326 2327
	}

2328 2329 2330

	err = perf_session__check_output_opt(session);
	if (err < 0)
2331
		goto out_delete;
2332

2333
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
2334

2335 2336
	flush_scripting();

2337
out_delete:
2338
	perf_evlist__free_stats(session->evlist);
2339
	perf_session__delete(session);
2340 2341 2342

	if (script_started)
		cleanup_scripting();
T
Tom Zanussi 已提交
2343 2344
out:
	return err;
F
Frederic Weisbecker 已提交
2345
}