builtin-script.c 87.5 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
F
Frederic Weisbecker 已提交
2 3
#include "builtin.h"

A
Andrea Gelmini 已提交
4
#include "perf.h"
F
Frederic Weisbecker 已提交
5
#include "util/cache.h"
A
Andrea Gelmini 已提交
6
#include "util/debug.h"
7
#include <subcmd/exec-cmd.h>
A
Andrea Gelmini 已提交
8
#include "util/header.h"
9
#include <subcmd/parse-options.h>
10
#include "util/perf_regs.h"
A
Andrea Gelmini 已提交
11
#include "util/session.h"
12
#include "util/tool.h"
F
Frederic Weisbecker 已提交
13 14
#include "util/symbol.h"
#include "util/thread.h"
I
Ingo Molnar 已提交
15
#include "util/trace-event.h"
A
Andrea Gelmini 已提交
16
#include "util/util.h"
17 18
#include "util/evlist.h"
#include "util/evsel.h"
19
#include "util/sort.h"
20
#include "util/data.h"
21
#include "util/auxtrace.h"
22 23 24
#include "util/cpumap.h"
#include "util/thread_map.h"
#include "util/stat.h"
25
#include "util/color.h"
26
#include "util/string2.h"
27
#include "util/thread-stack.h"
28
#include "util/time-utils.h"
29
#include "print_binary.h"
30
#include <linux/bitmap.h>
31
#include <linux/kernel.h>
32
#include <linux/stringify.h>
33
#include <linux/time64.h>
34
#include "asm/bug.h"
J
Jiri Olsa 已提交
35
#include "util/mem-events.h"
36
#include "util/dump-insn.h"
37
#include <dirent.h>
38
#include <errno.h>
39
#include <inttypes.h>
40
#include <signal.h>
41
#include <sys/param.h>
42 43 44
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
F
Frederic Weisbecker 已提交
45

46 47
#include "sane_ctype.h"

T
Tom Zanussi 已提交
48 49
static char const		*script_name;
static char const		*generate_script_lang;
50
static bool			debug_mode;
51
static u64			last_timestamp;
52
static u64			nr_unordered;
53
static bool			no_callchain;
54
static bool			latency_format;
55
static bool			system_wide;
56
static bool			print_flags;
57
static bool			nanosecs;
58 59
static const char		*cpu_list;
static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
60
static struct perf_stat_config	stat_config;
61
static int			max_blocks;
T
Tom Zanussi 已提交
62

63
unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
64

65 66 67 68 69 70 71 72
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,
73 74
	PERF_OUTPUT_IP              = 1U << 7,
	PERF_OUTPUT_SYM             = 1U << 8,
75
	PERF_OUTPUT_DSO             = 1U << 9,
76
	PERF_OUTPUT_ADDR            = 1U << 10,
77
	PERF_OUTPUT_SYMOFFSET       = 1U << 11,
78
	PERF_OUTPUT_SRCLINE         = 1U << 12,
J
Jiri Olsa 已提交
79
	PERF_OUTPUT_PERIOD          = 1U << 13,
80
	PERF_OUTPUT_IREGS	    = 1U << 14,
81 82
	PERF_OUTPUT_BRSTACK	    = 1U << 15,
	PERF_OUTPUT_BRSTACKSYM	    = 1U << 16,
83 84
	PERF_OUTPUT_DATA_SRC	    = 1U << 17,
	PERF_OUTPUT_WEIGHT	    = 1U << 18,
85
	PERF_OUTPUT_BPF_OUTPUT	    = 1U << 19,
86
	PERF_OUTPUT_CALLINDENT	    = 1U << 20,
A
Andi Kleen 已提交
87 88
	PERF_OUTPUT_INSN	    = 1U << 21,
	PERF_OUTPUT_INSNLEN	    = 1U << 22,
89
	PERF_OUTPUT_BRSTACKINSN	    = 1U << 23,
90
	PERF_OUTPUT_BRSTACKOFF	    = 1U << 24,
91
	PERF_OUTPUT_SYNTH           = 1U << 25,
92
	PERF_OUTPUT_PHYS_ADDR       = 1U << 26,
A
Andi Kleen 已提交
93
	PERF_OUTPUT_UREGS	    = 1U << 27,
94
	PERF_OUTPUT_METRIC	    = 1U << 28,
95 96 97 98 99 100 101 102 103 104 105 106 107
};

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},
108
	{.str = "ip",    .field = PERF_OUTPUT_IP},
109
	{.str = "sym",   .field = PERF_OUTPUT_SYM},
110
	{.str = "dso",   .field = PERF_OUTPUT_DSO},
111
	{.str = "addr",  .field = PERF_OUTPUT_ADDR},
112
	{.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
113
	{.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
J
Jiri Olsa 已提交
114
	{.str = "period", .field = PERF_OUTPUT_PERIOD},
115
	{.str = "iregs", .field = PERF_OUTPUT_IREGS},
A
Andi Kleen 已提交
116
	{.str = "uregs", .field = PERF_OUTPUT_UREGS},
117 118
	{.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
	{.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
119 120
	{.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
	{.str = "weight",   .field = PERF_OUTPUT_WEIGHT},
121
	{.str = "bpf-output",   .field = PERF_OUTPUT_BPF_OUTPUT},
122
	{.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
A
Andi Kleen 已提交
123 124
	{.str = "insn", .field = PERF_OUTPUT_INSN},
	{.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
125
	{.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
126
	{.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
127
	{.str = "synth", .field = PERF_OUTPUT_SYNTH},
128
	{.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
129
	{.str = "metric", .field = PERF_OUTPUT_METRIC},
130 131
};

132 133 134 135 136
enum {
	OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
	OUTPUT_TYPE_MAX
};

137
/* default set to maintain compatibility with current format */
138 139
static struct {
	bool user_set;
140
	bool wildcard_set;
141
	unsigned int print_ip_opts;
142 143
	u64 fields;
	u64 invalid_fields;
144
} output[OUTPUT_TYPE_MAX] = {
145 146 147 148 149 150

	[PERF_TYPE_HARDWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
151
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
152 153
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
			      PERF_OUTPUT_PERIOD,
154

155
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
156 157 158 159 160 161 162
	},

	[PERF_TYPE_SOFTWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
163
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
164
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
165
			      PERF_OUTPUT_PERIOD | PERF_OUTPUT_BPF_OUTPUT,
166 167 168 169 170 171 172 173 174

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_TRACEPOINT] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
				  PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
175
				  PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
176
	},
177 178 179 180 181 182

	[PERF_TYPE_RAW] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
183
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
184
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
185
			      PERF_OUTPUT_PERIOD |  PERF_OUTPUT_ADDR |
186 187
			      PERF_OUTPUT_DATA_SRC | PERF_OUTPUT_WEIGHT |
			      PERF_OUTPUT_PHYS_ADDR,
188

189
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
190
	},
191 192 193 194 195 196 197 198 199 200

	[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,

201
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
202
	},
203 204 205 206 207 208 209

	[OUTPUT_TYPE_SYNTH] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
210 211
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
			      PERF_OUTPUT_SYNTH,
212 213 214

		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
	},
215
};
216

217 218 219 220
struct perf_evsel_script {
       char *filename;
       FILE *fp;
       u64  samples;
221 222 223
       /* For metric output */
       u64  val;
       int  gnum;
224 225
};

226 227 228 229 230
static inline struct perf_evsel_script *evsel_script(struct perf_evsel *evsel)
{
	return (struct perf_evsel_script *)evsel->priv;
}

231
static struct perf_evsel_script *perf_evsel_script__new(struct perf_evsel *evsel,
232
							struct perf_data *data)
233
{
234
	struct perf_evsel_script *es = zalloc(sizeof(*es));
235 236

	if (es != NULL) {
J
Jiri Olsa 已提交
237
		if (asprintf(&es->filename, "%s.%s.dump", data->file.path, perf_evsel__name(evsel)) < 0)
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
			goto out_free;
		es->fp = fopen(es->filename, "w");
		if (es->fp == NULL)
			goto out_free_filename;
	}

	return es;
out_free_filename:
	zfree(&es->filename);
out_free:
	free(es);
	return NULL;
}

static void perf_evsel_script__delete(struct perf_evsel_script *es)
{
	zfree(&es->filename);
	fclose(es->fp);
	es->fp = NULL;
	free(es);
}

static int perf_evsel_script__fprintf(struct perf_evsel_script *es, FILE *fp)
{
	struct stat st;

	fstat(fileno(es->fp), &st);
	return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
		       st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
}

269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
static inline int output_type(unsigned int type)
{
	switch (type) {
	case PERF_TYPE_SYNTH:
		return OUTPUT_TYPE_SYNTH;
	default:
		return type;
	}
}

static inline unsigned int attr_type(unsigned int type)
{
	switch (type) {
	case OUTPUT_TYPE_SYNTH:
		return PERF_TYPE_SYNTH;
	default:
		return type;
	}
}

289 290 291
static bool output_set_by_user(void)
{
	int j;
292
	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
293 294 295 296 297
		if (output[j].user_set)
			return true;
	}
	return false;
}
298

299 300 301 302 303 304 305 306 307 308 309 310 311 312
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;
}

313
#define PRINT_FIELD(x)  (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
314

315 316 317 318
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)
319
{
320
	struct perf_event_attr *attr = &evsel->attr;
321
	int type = output_type(attr->type);
322 323 324 325 326 327
	const char *evname;

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

	if (output[type].user_set) {
328 329
		if (allow_user_set)
			return 0;
330
		evname = perf_evsel__name(evsel);
331 332 333 334 335 336 337 338
		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;
339
	evname = perf_evsel__name(evsel);
340 341 342 343 344 345 346
	pr_debug("Samples for '%s' event do not have %s attribute set. "
		 "Skipping '%s' field.\n",
		 evname, sample_msg, output_field2str(field));

	return 0;
}

347 348 349 350 351 352 353 354
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);
}

355 356 357 358
static int perf_evsel__check_attr(struct perf_evsel *evsel,
				  struct perf_session *session)
{
	struct perf_event_attr *attr = &evsel->attr;
359 360
	bool allow_user_set;

361 362 363
	if (perf_header__has_feat(&session->header, HEADER_STAT))
		return 0;

364 365
	allow_user_set = perf_header__has_feat(&session->header,
					       HEADER_AUXTRACE);
366

367 368 369 370
	if (PRINT_FIELD(TRACE) &&
		!perf_session__has_traces(session, "record -R"))
		return -EINVAL;

371
	if (PRINT_FIELD(IP)) {
372 373
		if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
					    PERF_OUTPUT_IP))
374 375
			return -EINVAL;
	}
376 377

	if (PRINT_FIELD(ADDR) &&
378 379
		perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
					   PERF_OUTPUT_ADDR, allow_user_set))
380 381
		return -EINVAL;

382 383 384 385 386 387 388 389 390 391
	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;

392 393 394 395
	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");
396 397
		return -EINVAL;
	}
398 399 400 401 402
	if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
		pr_err("Display of offsets requested but symbol is not"
		       "selected.\n");
		return -EINVAL;
	}
403
	if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR) &&
404 405 406
	    !PRINT_FIELD(BRSTACK) && !PRINT_FIELD(BRSTACKSYM) && !PRINT_FIELD(BRSTACKOFF)) {
		pr_err("Display of DSO requested but no address to convert.  Select\n"
		       "sample IP, sample address, brstack, brstacksym, or brstackoff.\n");
407 408
		return -EINVAL;
	}
409 410 411 412 413
	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;
	}
414 415 416 417 418 419 420
	if (PRINT_FIELD(BRSTACKINSN) &&
	    !(perf_evlist__combined_branch_type(session->evlist) &
	      PERF_SAMPLE_BRANCH_ANY)) {
		pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
		       "Hint: run 'perf record -b ...'\n");
		return -EINVAL;
	}
421
	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
422 423
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
					PERF_OUTPUT_TID|PERF_OUTPUT_PID))
424 425 426
		return -EINVAL;

	if (PRINT_FIELD(TIME) &&
427 428
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
					PERF_OUTPUT_TIME))
429 430 431
		return -EINVAL;

	if (PRINT_FIELD(CPU) &&
432 433
		perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
					   PERF_OUTPUT_CPU, allow_user_set))
434
		return -EINVAL;
435

436 437 438 439 440
	if (PRINT_FIELD(IREGS) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
					PERF_OUTPUT_IREGS))
		return -EINVAL;

A
Andi Kleen 已提交
441 442 443 444 445
	if (PRINT_FIELD(UREGS) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS",
					PERF_OUTPUT_UREGS))
		return -EINVAL;

446 447 448 449 450
	if (PRINT_FIELD(PHYS_ADDR) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR",
					PERF_OUTPUT_PHYS_ADDR))
		return -EINVAL;

451 452 453
	return 0;
}

454 455
static void set_print_ip_opts(struct perf_event_attr *attr)
{
456
	unsigned int type = output_type(attr->type);
457 458 459

	output[type].print_ip_opts = 0;
	if (PRINT_FIELD(IP))
460
		output[type].print_ip_opts |= EVSEL__PRINT_IP;
461 462

	if (PRINT_FIELD(SYM))
463
		output[type].print_ip_opts |= EVSEL__PRINT_SYM;
464 465

	if (PRINT_FIELD(DSO))
466
		output[type].print_ip_opts |= EVSEL__PRINT_DSO;
467 468

	if (PRINT_FIELD(SYMOFFSET))
469
		output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
470 471

	if (PRINT_FIELD(SRCLINE))
472
		output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
473 474
}

475 476 477 478 479 480
/*
 * verify all user requested events exist and the samples
 * have the expected data
 */
static int perf_session__check_output_opt(struct perf_session *session)
{
481
	unsigned int j;
482 483
	struct perf_evsel *evsel;

484 485
	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
		evsel = perf_session__find_first_evtype(session, attr_type(j));
486 487 488 489 490

		/*
		 * even if fields is set to 0 (ie., show nothing) event must
		 * exist if user explicitly includes it on the command line
		 */
491 492
		if (!evsel && output[j].user_set && !output[j].wildcard_set &&
		    j != OUTPUT_TYPE_SYNTH) {
493
			pr_err("%s events do not exist. "
494
			       "Remove corresponding -F option to proceed.\n",
495 496 497 498 499 500 501
			       event_type(j));
			return -1;
		}

		if (evsel && output[j].fields &&
			perf_evsel__check_attr(evsel, session))
			return -1;
502 503 504 505

		if (evsel == NULL)
			continue;

506
		set_print_ip_opts(&evsel->attr);
507 508
	}

509 510
	if (!no_callchain) {
		bool use_callchain = false;
511
		bool not_pipe = false;
512

513
		evlist__for_each_entry(session->evlist, evsel) {
514
			not_pipe = true;
515 516 517 518 519
			if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) {
				use_callchain = true;
				break;
			}
		}
520
		if (not_pipe && !use_callchain)
521 522 523
			symbol_conf.use_callchain = false;
	}

524 525 526 527 528 529 530 531 532 533
	/*
	 * 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;

534
		evlist__for_each_entry(session->evlist, evsel) {
535 536 537 538
			if (evsel->attr.type != j)
				continue;

			attr = &evsel->attr;
539

540 541 542 543 544 545 546
			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);
				goto out;
			}
547 548 549 550
		}
	}

out:
551 552
	return 0;
}
553

554 555
static int perf_sample__fprintf_iregs(struct perf_sample *sample,
				      struct perf_event_attr *attr, FILE *fp)
556 557 558 559
{
	struct regs_dump *regs = &sample->intr_regs;
	uint64_t mask = attr->sample_regs_intr;
	unsigned i = 0, r;
560
	int printed = 0;
561 562

	if (!regs)
563
		return 0;
564 565 566

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

	return printed;
571 572
}

573 574
static int perf_sample__fprintf_uregs(struct perf_sample *sample,
				      struct perf_event_attr *attr, FILE *fp)
A
Andi Kleen 已提交
575 576 577 578
{
	struct regs_dump *regs = &sample->user_regs;
	uint64_t mask = attr->sample_regs_user;
	unsigned i = 0, r;
579
	int printed = 0;
A
Andi Kleen 已提交
580 581

	if (!regs || !regs->regs)
582
		return 0;
A
Andi Kleen 已提交
583

584
	printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
A
Andi Kleen 已提交
585 586 587

	for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
		u64 val = regs->regs[i++];
588
		printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r), val);
A
Andi Kleen 已提交
589
	}
590 591

	return printed;
A
Andi Kleen 已提交
592 593
}

594 595 596
static int perf_sample__fprintf_start(struct perf_sample *sample,
				      struct thread *thread,
				      struct perf_evsel *evsel, FILE *fp)
597
{
598
	struct perf_event_attr *attr = &evsel->attr;
599
	unsigned long secs;
600
	unsigned long long nsecs;
601
	int printed = 0;
602 603 604

	if (PRINT_FIELD(COMM)) {
		if (latency_format)
605
			printed += fprintf(fp, "%8.8s ", thread__comm_str(thread));
606
		else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
607
			printed += fprintf(fp, "%s ", thread__comm_str(thread));
608
		else
609
			printed += fprintf(fp, "%16s ", thread__comm_str(thread));
610
	}
611

612
	if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
613
		printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
614
	else if (PRINT_FIELD(PID))
615
		printed += fprintf(fp, "%5d ", sample->pid);
616
	else if (PRINT_FIELD(TID))
617
		printed += fprintf(fp, "%5d ", sample->tid);
618 619 620

	if (PRINT_FIELD(CPU)) {
		if (latency_format)
621
			printed += fprintf(fp, "%3d ", sample->cpu);
622
		else
623
			printed += fprintf(fp, "[%03d] ", sample->cpu);
624
	}
625

626 627
	if (PRINT_FIELD(TIME)) {
		nsecs = sample->time;
628 629
		secs = nsecs / NSEC_PER_SEC;
		nsecs -= secs * NSEC_PER_SEC;
630

631
		if (nanosecs)
632
			printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
633 634 635
		else {
			char sample_time[32];
			timestamp__scnprintf_usec(sample->time, sample_time, sizeof(sample_time));
636
			printed += fprintf(fp, "%12s: ", sample_time);
637
		}
638
	}
639 640

	return printed;
641 642
}

643 644 645 646 647 648 649 650 651
static inline char
mispred_str(struct branch_entry *br)
{
	if (!(br->flags.mispred  || br->flags.predicted))
		return '-';

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

652 653 654
static int perf_sample__fprintf_brstack(struct perf_sample *sample,
					struct thread *thread,
					struct perf_event_attr *attr, FILE *fp)
655 656
{
	struct branch_stack *br = sample->branch_stack;
657 658
	struct addr_location alf, alt;
	u64 i, from, to;
659
	int printed = 0;
660 661

	if (!(br && br->nr))
662
		return 0;
663 664

	for (i = 0; i < br->nr; i++) {
665 666 667 668 669 670 671 672 673 674
		from = br->entries[i].from;
		to   = br->entries[i].to;

		if (PRINT_FIELD(DSO)) {
			memset(&alf, 0, sizeof(alf));
			memset(&alt, 0, sizeof(alt));
			thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, from, &alf);
			thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt);
		}

675
		printed += fprintf(fp, " 0x%"PRIx64, from);
676
		if (PRINT_FIELD(DSO)) {
677 678 679
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alf.map, fp);
			printed += fprintf(fp, ")");
680 681
		}

682
		printed += fprintf(fp, "/0x%"PRIx64, to);
683
		if (PRINT_FIELD(DSO)) {
684 685 686
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alt.map, fp);
			printed += fprintf(fp, ")");
687 688
		}

689
		printed += fprintf(fp, "/%c/%c/%c/%d ",
690 691 692 693 694
			mispred_str( br->entries + i),
			br->entries[i].flags.in_tx? 'X' : '-',
			br->entries[i].flags.abort? 'A' : '-',
			br->entries[i].flags.cycles);
	}
695 696

	return printed;
697 698
}

699 700 701
static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
					   struct thread *thread,
					   struct perf_event_attr *attr, FILE *fp)
702 703 704 705
{
	struct branch_stack *br = sample->branch_stack;
	struct addr_location alf, alt;
	u64 i, from, to;
706
	int printed = 0;
707 708

	if (!(br && br->nr))
709
		return 0;
710 711 712 713 714 715 716 717

	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;

718
		thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, from, &alf);
719
		if (alf.map)
720
			alf.sym = map__find_symbol(alf.map, alf.addr);
721

722
		thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt);
723
		if (alt.map)
724
			alt.sym = map__find_symbol(alt.map, alt.addr);
725

726
		printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
727
		if (PRINT_FIELD(DSO)) {
728 729 730
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alf.map, fp);
			printed += fprintf(fp, ")");
731
		}
732 733
		printed += fprintf(fp, "%c", '/');
		printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
734
		if (PRINT_FIELD(DSO)) {
735 736 737
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alt.map, fp);
			printed += fprintf(fp, ")");
738
		}
739
		printed += fprintf(fp, "/%c/%c/%c/%d ",
740 741 742 743 744
			mispred_str( br->entries + i),
			br->entries[i].flags.in_tx? 'X' : '-',
			br->entries[i].flags.abort? 'A' : '-',
			br->entries[i].flags.cycles);
	}
745 746

	return printed;
747 748
}

749 750 751
static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
					   struct thread *thread,
					   struct perf_event_attr *attr, FILE *fp)
752 753 754 755
{
	struct branch_stack *br = sample->branch_stack;
	struct addr_location alf, alt;
	u64 i, from, to;
756
	int printed = 0;
757 758

	if (!(br && br->nr))
759
		return 0;
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775

	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, sample->cpumode, MAP__FUNCTION, from, &alf);
		if (alf.map && !alf.map->dso->adjust_symbols)
			from = map__map_ip(alf.map, from);

		thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt);
		if (alt.map && !alt.map->dso->adjust_symbols)
			to = map__map_ip(alt.map, to);

776
		printed += fprintf(fp, " 0x%"PRIx64, from);
777
		if (PRINT_FIELD(DSO)) {
778 779 780
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alf.map, fp);
			printed += fprintf(fp, ")");
781
		}
782
		printed += fprintf(fp, "/0x%"PRIx64, to);
783
		if (PRINT_FIELD(DSO)) {
784 785 786
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alt.map, fp);
			printed += fprintf(fp, ")");
787
		}
788
		printed += fprintf(fp, "/%c/%c/%c/%d ",
789 790 791 792 793
			mispred_str(br->entries + i),
			br->entries[i].flags.in_tx ? 'X' : '-',
			br->entries[i].flags.abort ? 'A' : '-',
			br->entries[i].flags.cycles);
	}
794 795

	return printed;
796
}
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
#define MAXBB 16384UL

static int grab_bb(u8 *buffer, u64 start, u64 end,
		    struct machine *machine, struct thread *thread,
		    bool *is64bit, u8 *cpumode, bool last)
{
	long offset, len;
	struct addr_location al;
	bool kernel;

	if (!start || !end)
		return 0;

	kernel = machine__kernel_ip(machine, start);
	if (kernel)
		*cpumode = PERF_RECORD_MISC_KERNEL;
	else
		*cpumode = PERF_RECORD_MISC_USER;

	/*
	 * Block overlaps between kernel and user.
	 * This can happen due to ring filtering
	 * On Intel CPUs the entry into the kernel is filtered,
	 * but the exit is not. Let the caller patch it up.
	 */
	if (kernel != machine__kernel_ip(machine, end)) {
823
		pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
824 825 826 827 828 829
		return -ENXIO;
	}

	memset(&al, 0, sizeof(al));
	if (end - start > MAXBB - MAXINSN) {
		if (last)
830
			pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
831
		else
832
			pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
833 834 835 836 837
		return 0;
	}

	thread__find_addr_map(thread, *cpumode, MAP__FUNCTION, start, &al);
	if (!al.map || !al.map->dso) {
838
		pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
839 840 841
		return 0;
	}
	if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
842
		pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
843 844 845 846 847 848 849 850 851 852 853 854
		return 0;
	}

	/* Load maps to ensure dso->is_64_bit has been updated */
	map__load(al.map);

	offset = al.map->map_ip(al.map, start);
	len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
				    end - start + MAXINSN);

	*is64bit = al.map->dso->is_64_bit;
	if (len <= 0)
855
		pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
856 857 858 859
			start, end);
	return len;
}

860 861 862
static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
			    struct perf_insn *x, u8 *inbuf, int len,
			    int insn, FILE *fp)
863
{
864 865 866 867 868 869
	int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t#%s%s%s%s", ip,
			      dump_insn(x, ip, inbuf, len, NULL),
			      en->flags.predicted ? " PRED" : "",
			      en->flags.mispred ? " MISPRED" : "",
			      en->flags.in_tx ? " INTX" : "",
			      en->flags.abort ? " ABORT" : "");
870
	if (en->flags.cycles) {
871
		printed += fprintf(fp, " %d cycles", en->flags.cycles);
872
		if (insn)
873
			printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
874
	}
875
	return printed + fprintf(fp, "\n");
876 877
}

878 879 880
static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
			   u8 cpumode, int cpu, struct symbol **lastsym,
			   struct perf_event_attr *attr, FILE *fp)
881 882
{
	struct addr_location al;
883
	int off, printed = 0;
884 885 886 887 888 889 890 891

	memset(&al, 0, sizeof(al));

	thread__find_addr_map(thread, cpumode, MAP__FUNCTION, addr, &al);
	if (!al.map)
		thread__find_addr_map(thread, cpumode, MAP__VARIABLE,
				      addr, &al);
	if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
892
		return 0;
893 894 895 896 897 898 899

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

	if (!al.sym)
900
		return 0;
901 902 903 904 905

	if (al.addr < al.sym->end)
		off = al.addr - al.sym->start;
	else
		off = al.addr - al.map->start - al.sym->start;
906
	printed += fprintf(fp, "\t%s", al.sym->name);
907
	if (off)
908 909
		printed += fprintf(fp, "%+d", off);
	printed += fprintf(fp, ":");
910
	if (PRINT_FIELD(SRCLINE))
911 912
		printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
	printed += fprintf(fp, "\n");
913
	*lastsym = al.sym;
914 915

	return printed;
916 917
}

918 919 920 921
static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
					    struct thread *thread,
					    struct perf_event_attr *attr,
					    struct machine *machine, FILE *fp)
922 923 924
{
	struct branch_stack *br = sample->branch_stack;
	u64 start, end;
925
	int i, insn, len, nr, ilen, printed = 0;
926 927 928 929 930 931
	struct perf_insn x;
	u8 buffer[MAXBB];
	unsigned off;
	struct symbol *lastsym = NULL;

	if (!(br && br->nr))
932
		return 0;
933 934 935 936 937 938 939
	nr = br->nr;
	if (max_blocks && nr > max_blocks + 1)
		nr = max_blocks + 1;

	x.thread = thread;
	x.cpu = sample->cpu;

940
	printed += fprintf(fp, "%c", '\n');
941 942 943 944 945 946

	/* Handle first from jump, of which we don't know the entry. */
	len = grab_bb(buffer, br->entries[nr-1].from,
			br->entries[nr-1].from,
			machine, thread, &x.is64bit, &x.cpumode, false);
	if (len > 0) {
947 948 949 950
		printed += ip__fprintf_sym(br->entries[nr - 1].from, thread,
					   x.cpumode, x.cpu, &lastsym, attr, fp);
		printed += ip__fprintf_jump(br->entries[nr - 1].from, &br->entries[nr - 1],
					    &x, buffer, len, 0, fp);
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
	}

	/* Print all blocks */
	for (i = nr - 2; i >= 0; i--) {
		if (br->entries[i].from || br->entries[i].to)
			pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
				 br->entries[i].from,
				 br->entries[i].to);
		start = br->entries[i + 1].to;
		end   = br->entries[i].from;

		len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
		/* Patch up missing kernel transfers due to ring filters */
		if (len == -ENXIO && i > 0) {
			end = br->entries[--i].from;
			pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
			len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
		}
		if (len <= 0)
			continue;

		insn = 0;
		for (off = 0;; off += ilen) {
			uint64_t ip = start + off;

976
			printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
977
			if (ip == end) {
978
				printed += ip__fprintf_jump(ip, &br->entries[i], &x, buffer + off, len - off, insn, fp);
979 980
				break;
			} else {
981 982
				printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
						   dump_insn(&x, ip, buffer + off, len - off, &ilen));
983 984 985 986 987 988 989 990 991 992 993 994
				if (ilen == 0)
					break;
				insn++;
			}
		}
	}

	/*
	 * Hit the branch? In this case we are already done, and the target
	 * has not been executed yet.
	 */
	if (br->entries[0].from == sample->ip)
995
		goto out;
996
	if (br->entries[0].flags.abort)
997
		goto out;
998 999 1000 1001 1002 1003 1004

	/*
	 * Print final block upto sample
	 */
	start = br->entries[0].to;
	end = sample->ip;
	len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1005
	printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1006 1007 1008 1009 1010
	if (len <= 0) {
		/* Print at least last IP if basic block did not work */
		len = grab_bb(buffer, sample->ip, sample->ip,
			      machine, thread, &x.is64bit, &x.cpumode, false);
		if (len <= 0)
1011
			goto out;
1012

1013
		printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1014
			dump_insn(&x, sample->ip, buffer, len, NULL));
1015
		goto out;
1016 1017
	}
	for (off = 0; off <= end - start; off += ilen) {
1018 1019
		printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
				   dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1020 1021 1022
		if (ilen == 0)
			break;
	}
1023 1024
out:
	return printed;
1025
}
1026

1027 1028 1029
static int perf_sample__fprintf_addr(struct perf_sample *sample,
				     struct thread *thread,
				     struct perf_event_attr *attr, FILE *fp)
1030 1031
{
	struct addr_location al;
1032
	int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1033 1034

	if (!sample_addr_correlates_sym(attr))
1035
		goto out;
1036

1037
	thread__resolve(thread, &al, sample);
1038 1039

	if (PRINT_FIELD(SYM)) {
1040
		printed += fprintf(fp, " ");
1041
		if (PRINT_FIELD(SYMOFFSET))
1042
			printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1043
		else
1044
			printed += symbol__fprintf_symname(al.sym, fp);
1045 1046 1047
	}

	if (PRINT_FIELD(DSO)) {
1048 1049 1050
		printed += fprintf(fp, " (");
		printed += map__fprintf_dsoname(al.map, fp);
		printed += fprintf(fp, ")");
1051
	}
1052 1053
out:
	return printed;
1054 1055
}

1056 1057 1058 1059
static int perf_sample__fprintf_callindent(struct perf_sample *sample,
					   struct perf_evsel *evsel,
					   struct thread *thread,
					   struct addr_location *al, FILE *fp)
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
{
	struct perf_event_attr *attr = &evsel->attr;
	size_t depth = thread_stack__depth(thread);
	struct addr_location addr_al;
	const char *name = NULL;
	static int spacing;
	int len = 0;
	u64 ip = 0;

	/*
	 * The 'return' has already been popped off the stack so the depth has
	 * to be adjusted to match the 'call'.
	 */
	if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
		depth += 1;

	if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
		if (sample_addr_correlates_sym(attr)) {
			thread__resolve(thread, &addr_al, sample);
			if (addr_al.sym)
				name = addr_al.sym->name;
			else
				ip = sample->addr;
		} else {
			ip = sample->addr;
		}
	} else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
		if (al->sym)
			name = al->sym->name;
		else
			ip = sample->ip;
	}

	if (name)
1094
		len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1095
	else if (ip)
1096
		len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1097 1098

	if (len < 0)
1099
		return len;
1100 1101 1102 1103 1104 1105 1106 1107 1108

	/*
	 * Try to keep the output length from changing frequently so that the
	 * output lines up more nicely.
	 */
	if (len > spacing || (len && len < spacing - 52))
		spacing = round_up(len + 4, 32);

	if (len < spacing)
1109 1110 1111
		len += fprintf(fp, "%*s", spacing - len, "");

	return len;
1112 1113
}

1114 1115 1116 1117
static int perf_sample__fprintf_insn(struct perf_sample *sample,
				     struct perf_event_attr *attr,
				     struct thread *thread,
				     struct machine *machine, FILE *fp)
A
Andi Kleen 已提交
1118
{
1119 1120
	int printed = 0;

A
Andi Kleen 已提交
1121
	if (PRINT_FIELD(INSNLEN))
1122
		printed += fprintf(fp, " ilen: %d", sample->insn_len);
A
Andi Kleen 已提交
1123 1124 1125
	if (PRINT_FIELD(INSN)) {
		int i;

1126
		printed += fprintf(fp, " insn:");
A
Andi Kleen 已提交
1127
		for (i = 0; i < sample->insn_len; i++)
1128
			printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
A
Andi Kleen 已提交
1129
	}
1130
	if (PRINT_FIELD(BRSTACKINSN))
1131 1132 1133
		printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);

	return printed;
A
Andi Kleen 已提交
1134 1135
}

1136 1137 1138 1139 1140
static int perf_sample__fprintf_bts(struct perf_sample *sample,
				    struct perf_evsel *evsel,
				    struct thread *thread,
				    struct addr_location *al,
				    struct machine *machine, FILE *fp)
1141 1142
{
	struct perf_event_attr *attr = &evsel->attr;
1143
	unsigned int type = output_type(attr->type);
1144
	bool print_srcline_last = false;
1145
	int printed = 0;
1146

1147
	if (PRINT_FIELD(CALLINDENT))
1148
		printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, fp);
1149

1150 1151
	/* print branch_from information */
	if (PRINT_FIELD(IP)) {
1152
		unsigned int print_opts = output[type].print_ip_opts;
1153
		struct callchain_cursor *cursor = NULL;
1154

1155
		if (symbol_conf.use_callchain && sample->callchain &&
1156
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1157
					      sample, NULL, NULL, scripting_max_stack) == 0)
1158
			cursor = &callchain_cursor;
1159 1160

		if (cursor == NULL) {
1161
			printed += fprintf(fp, " ");
1162
			if (print_opts & EVSEL__PRINT_SRCLINE) {
1163
				print_srcline_last = true;
1164
				print_opts &= ~EVSEL__PRINT_SRCLINE;
1165
			}
1166
		} else
1167
			printed += fprintf(fp, "\n");
1168

1169
		printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor, fp);
1170 1171 1172
	}

	/* print branch_to information */
1173 1174
	if (PRINT_FIELD(ADDR) ||
	    ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
1175
	     !output[type].user_set)) {
1176 1177
		printed += fprintf(fp, " => ");
		printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1178
	}
1179

1180
	if (print_srcline_last)
1181
		printed += map__fprintf_srcline(al->map, al->addr, "\n  ", fp);
A
Andi Kleen 已提交
1182

1183 1184
	printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
	return printed + fprintf(fp, "\n");
1185 1186
}

1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
static struct {
	u32 flags;
	const char *name;
} sample_flags[] = {
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
	{PERF_IP_FLAG_BRANCH, "jmp"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC |	PERF_IP_FLAG_INTERRUPT, "hw int"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
	{0, NULL}
};

1207
static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1208 1209 1210
{
	const char *chars = PERF_IP_FLAG_CHARS;
	const int n = strlen(PERF_IP_FLAG_CHARS);
1211 1212
	bool in_tx = flags & PERF_IP_FLAG_IN_TX;
	const char *name = NULL;
1213 1214 1215
	char str[33];
	int i, pos = 0;

1216 1217 1218 1219 1220 1221 1222
	for (i = 0; sample_flags[i].name ; i++) {
		if (sample_flags[i].flags == (flags & ~PERF_IP_FLAG_IN_TX)) {
			name = sample_flags[i].name;
			break;
		}
	}

1223 1224 1225 1226 1227 1228 1229 1230 1231
	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;
1232 1233

	if (name)
1234 1235 1236
		return fprintf(fp, "  %-7s%4s ", name, in_tx ? "(x)" : "");

	return fprintf(fp, "  %-11s ", str);
1237 1238
}

1239 1240 1241 1242 1243 1244
struct printer_data {
	int line_no;
	bool hit_nul;
	bool is_printable;
};

1245 1246 1247
static int sample__fprintf_bpf_output(enum binary_printer_ops op,
				      unsigned int val,
				      void *extra, FILE *fp)
1248 1249 1250
{
	unsigned char ch = (unsigned char)val;
	struct printer_data *printer_data = extra;
1251
	int printed = 0;
1252 1253 1254

	switch (op) {
	case BINARY_PRINT_DATA_BEGIN:
1255
		printed += fprintf(fp, "\n");
1256 1257
		break;
	case BINARY_PRINT_LINE_BEGIN:
1258
		printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1259 1260 1261
						        "           ");
		break;
	case BINARY_PRINT_ADDR:
1262
		printed += fprintf(fp, " %04x:", val);
1263 1264
		break;
	case BINARY_PRINT_NUM_DATA:
1265
		printed += fprintf(fp, " %02x", val);
1266 1267
		break;
	case BINARY_PRINT_NUM_PAD:
1268
		printed += fprintf(fp, "   ");
1269 1270
		break;
	case BINARY_PRINT_SEP:
1271
		printed += fprintf(fp, "  ");
1272 1273 1274 1275 1276 1277
		break;
	case BINARY_PRINT_CHAR_DATA:
		if (printer_data->hit_nul && ch)
			printer_data->is_printable = false;

		if (!isprint(ch)) {
1278
			printed += fprintf(fp, "%c", '.');
1279 1280 1281 1282 1283 1284 1285 1286 1287

			if (!printer_data->is_printable)
				break;

			if (ch == '\0')
				printer_data->hit_nul = true;
			else
				printer_data->is_printable = false;
		} else {
1288
			printed += fprintf(fp, "%c", ch);
1289 1290 1291
		}
		break;
	case BINARY_PRINT_CHAR_PAD:
1292
		printed += fprintf(fp, " ");
1293 1294
		break;
	case BINARY_PRINT_LINE_END:
1295
		printed += fprintf(fp, "\n");
1296 1297 1298 1299 1300 1301
		printer_data->line_no++;
		break;
	case BINARY_PRINT_DATA_END:
	default:
		break;
	}
1302 1303

	return printed;
1304 1305
}

1306
static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1307 1308 1309
{
	unsigned int nr_bytes = sample->raw_size;
	struct printer_data printer_data = {0, false, true};
1310 1311
	int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
				      sample__fprintf_bpf_output, &printer_data, fp);
1312 1313

	if (printer_data.is_printable && printer_data.hit_nul)
1314 1315 1316
		printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));

	return printed;
1317 1318
}

1319
static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1320 1321
{
	if (len > 0 && len < spacing)
1322 1323 1324
		return fprintf(fp, "%*s", spacing - len, "");

	return 0;
1325 1326
}

1327
static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1328
{
1329
	return perf_sample__fprintf_spacing(len, 34, fp);
1330 1331
}

1332
static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1333 1334 1335 1336 1337
{
	struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1338
		return 0;
1339

1340
	len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1341
		     data->ip, le64_to_cpu(data->payload));
1342
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1343 1344
}

1345
static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1346 1347 1348 1349 1350
{
	struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1351
		return 0;
1352

1353 1354 1355
	len = fprintf(fp, " hints: %#x extensions: %#x ",
		      data->hints, data->extensions);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1356 1357
}

1358
static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1359 1360 1361 1362 1363
{
	struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1364
		return 0;
1365

1366 1367 1368
	len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
		      data->hw, data->cstate, data->subcstate);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1369 1370
}

1371
static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1372 1373 1374 1375 1376
{
	struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1377
		return 0;
1378

1379 1380
	len = fprintf(fp, " IP: %u ", data->ip);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1381 1382
}

1383
static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1384 1385 1386 1387 1388
{
	struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1389
		return 0;
1390

1391
	len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1392 1393
		     data->deepest_cstate, data->last_cstate,
		     data->wake_reason);
1394
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1395 1396
}

1397
static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1398 1399 1400 1401 1402 1403
{
	struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
	unsigned int percent, freq;
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1404
		return 0;
1405 1406

	freq = (le32_to_cpu(data->freq) + 500) / 1000;
1407
	len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1408 1409
	if (data->max_nonturbo) {
		percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1410
		len += fprintf(fp, "(%3u%%) ", percent);
1411
	}
1412
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1413 1414
}

1415 1416
static int perf_sample__fprintf_synth(struct perf_sample *sample,
				      struct perf_evsel *evsel, FILE *fp)
1417 1418
{
	switch (evsel->attr.config) {
1419
	case PERF_SYNTH_INTEL_PTWRITE:
1420
		return perf_sample__fprintf_synth_ptwrite(sample, fp);
1421
	case PERF_SYNTH_INTEL_MWAIT:
1422
		return perf_sample__fprintf_synth_mwait(sample, fp);
1423
	case PERF_SYNTH_INTEL_PWRE:
1424
		return perf_sample__fprintf_synth_pwre(sample, fp);
1425
	case PERF_SYNTH_INTEL_EXSTOP:
1426
		return perf_sample__fprintf_synth_exstop(sample, fp);
1427
	case PERF_SYNTH_INTEL_PWRX:
1428
		return perf_sample__fprintf_synth_pwrx(sample, fp);
1429
	case PERF_SYNTH_INTEL_CBR:
1430
		return perf_sample__fprintf_synth_cbr(sample, fp);
1431 1432 1433
	default:
		break;
	}
1434 1435

	return 0;
1436 1437
}

1438 1439 1440 1441 1442 1443
struct perf_script {
	struct perf_tool	tool;
	struct perf_session	*session;
	bool			show_task_events;
	bool			show_mmap_events;
	bool			show_switch_events;
1444
	bool			show_namespace_events;
1445
	bool			allocated;
1446
	bool			per_event_dump;
1447 1448
	struct cpu_map		*cpus;
	struct thread_map	*threads;
1449
	int			name_width;
1450 1451
	const char              *time_str;
	struct perf_time_interval ptime;
1452 1453
};

1454 1455 1456 1457 1458
static int perf_evlist__max_name_len(struct perf_evlist *evlist)
{
	struct perf_evsel *evsel;
	int max = 0;

1459
	evlist__for_each_entry(evlist, evsel) {
1460 1461 1462 1463 1464 1465 1466 1467
		int len = strlen(perf_evsel__name(evsel));

		max = MAX(len, max);
	}

	return max;
}

1468
static int data_src__fprintf(u64 data_src, FILE *fp)
J
Jiri Olsa 已提交
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
{
	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;

1482
	return fprintf(fp, "%-*s", maxlen, out);
J
Jiri Olsa 已提交
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 1511 1512 1513 1514 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
struct metric_ctx {
	struct perf_sample	*sample;
	struct thread		*thread;
	struct perf_evsel	*evsel;
	FILE 			*fp;
};

static void script_print_metric(void *ctx, const char *color,
			        const char *fmt,
			        const char *unit, double val)
{
	struct metric_ctx *mctx = ctx;

	if (!fmt)
		return;
	perf_sample__fprintf_start(mctx->sample, mctx->thread, mctx->evsel,
				   mctx->fp);
	fputs("\tmetric: ", mctx->fp);
	if (color)
		color_fprintf(mctx->fp, color, fmt, val);
	else
		printf(fmt, val);
	fprintf(mctx->fp, " %s\n", unit);
}

static void script_new_line(void *ctx)
{
	struct metric_ctx *mctx = ctx;

	perf_sample__fprintf_start(mctx->sample, mctx->thread, mctx->evsel,
				   mctx->fp);
	fputs("\tmetric: ", mctx->fp);
}

static void perf_sample__fprint_metric(struct perf_script *script,
				       struct thread *thread,
				       struct perf_evsel *evsel,
				       struct perf_sample *sample,
				       FILE *fp)
{
	struct perf_stat_output_ctx ctx = {
		.print_metric = script_print_metric,
		.new_line = script_new_line,
		.ctx = &(struct metric_ctx) {
				.sample = sample,
				.thread = thread,
				.evsel  = evsel,
				.fp     = fp,
			 },
		.force_header = false,
	};
	struct perf_evsel *ev2;
	static bool init;
	u64 val;

	if (!init) {
		perf_stat__init_shadow_stats();
		init = true;
	}
	if (!evsel->stats)
		perf_evlist__alloc_stats(script->session->evlist, false);
	if (evsel_script(evsel->leader)->gnum++ == 0)
		perf_stat__reset_shadow_stats();
	val = sample->period * evsel->scale;
	perf_stat__update_shadow_stats(evsel,
				       val,
				       sample->cpu);
	evsel_script(evsel)->val = val;
	if (evsel_script(evsel->leader)->gnum == evsel->leader->nr_members) {
		for_each_group_member (ev2, evsel->leader) {
			perf_stat__print_shadow_stats(ev2,
						      evsel_script(ev2)->val,
						      sample->cpu,
						      &ctx,
						      NULL);
		}
		evsel_script(evsel->leader)->gnum = 0;
	}
}

1565
static void process_event(struct perf_script *script,
1566
			  struct perf_sample *sample, struct perf_evsel *evsel,
1567 1568
			  struct addr_location *al,
			  struct machine *machine)
1569
{
1570
	struct thread *thread = al->thread;
1571
	struct perf_event_attr *attr = &evsel->attr;
1572
	unsigned int type = output_type(attr->type);
1573 1574
	struct perf_evsel_script *es = evsel->priv;
	FILE *fp = es->fp;
1575

1576
	if (output[type].fields == 0)
1577 1578
		return;

1579 1580
	++es->samples;

1581
	perf_sample__fprintf_start(sample, thread, evsel, fp);
1582

J
Jiri Olsa 已提交
1583
	if (PRINT_FIELD(PERIOD))
1584
		fprintf(fp, "%10" PRIu64 " ", sample->period);
J
Jiri Olsa 已提交
1585

1586 1587
	if (PRINT_FIELD(EVNAME)) {
		const char *evname = perf_evsel__name(evsel);
1588 1589 1590 1591

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

1592
		fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
1593 1594
	}

1595
	if (print_flags)
1596
		perf_sample__fprintf_flags(sample->flags, fp);
1597

1598
	if (is_bts_event(attr)) {
1599
		perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
1600 1601 1602
		return;
	}

1603 1604 1605 1606
	if (PRINT_FIELD(TRACE)) {
		event_format__fprintf(evsel->tp_format, sample->cpu,
				      sample->raw_data, sample->raw_size, fp);
	}
1607 1608

	if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
1609
		perf_sample__fprintf_synth(sample, evsel, fp);
1610

1611
	if (PRINT_FIELD(ADDR))
1612
		perf_sample__fprintf_addr(sample, thread, attr, fp);
1613

1614
	if (PRINT_FIELD(DATA_SRC))
1615
		data_src__fprintf(sample->data_src, fp);
1616 1617

	if (PRINT_FIELD(WEIGHT))
1618
		fprintf(fp, "%16" PRIu64, sample->weight);
1619

1620
	if (PRINT_FIELD(IP)) {
1621
		struct callchain_cursor *cursor = NULL;
1622

1623
		if (symbol_conf.use_callchain && sample->callchain &&
1624
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1625
					      sample, NULL, NULL, scripting_max_stack) == 0)
1626
			cursor = &callchain_cursor;
1627

1628 1629
		fputc(cursor ? '\n' : ' ', fp);
		sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor, fp);
1630 1631
	}

1632
	if (PRINT_FIELD(IREGS))
1633
		perf_sample__fprintf_iregs(sample, attr, fp);
1634

A
Andi Kleen 已提交
1635
	if (PRINT_FIELD(UREGS))
1636
		perf_sample__fprintf_uregs(sample, attr, fp);
A
Andi Kleen 已提交
1637

1638
	if (PRINT_FIELD(BRSTACK))
1639
		perf_sample__fprintf_brstack(sample, thread, attr, fp);
1640
	else if (PRINT_FIELD(BRSTACKSYM))
1641
		perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
1642
	else if (PRINT_FIELD(BRSTACKOFF))
1643
		perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
1644

1645
	if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
1646 1647
		perf_sample__fprintf_bpf_output(sample, fp);
	perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1648 1649

	if (PRINT_FIELD(PHYS_ADDR))
1650 1651
		fprintf(fp, "%16" PRIx64, sample->phys_addr);
	fprintf(fp, "\n");
1652 1653 1654

	if (PRINT_FIELD(METRIC))
		perf_sample__fprint_metric(script, thread, evsel, sample, fp);
1655 1656
}

T
Tom Zanussi 已提交
1657 1658
static struct scripting_ops	*scripting_ops;

1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692
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));
		}
	}
}

1693 1694 1695 1696
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);
1697 1698
	else
		__process_stat(counter, tstamp);
1699 1700 1701 1702 1703 1704 1705 1706
}

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

T
Tom Zanussi 已提交
1707 1708
static void setup_scripting(void)
{
1709
	setup_perl_scripting();
1710
	setup_python_scripting();
T
Tom Zanussi 已提交
1711 1712
}

1713 1714
static int flush_scripting(void)
{
1715
	return scripting_ops ? scripting_ops->flush_script() : 0;
1716 1717
}

T
Tom Zanussi 已提交
1718 1719
static int cleanup_scripting(void)
{
1720
	pr_debug("\nperf script stopped\n");
1721

1722
	return scripting_ops ? scripting_ops->stop_script() : 0;
T
Tom Zanussi 已提交
1723 1724
}

1725
static int process_sample_event(struct perf_tool *tool,
1726
				union perf_event *event,
1727
				struct perf_sample *sample,
1728
				struct perf_evsel *evsel,
1729
				struct machine *machine)
F
Frederic Weisbecker 已提交
1730
{
1731
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
1732
	struct addr_location al;
F
Frederic Weisbecker 已提交
1733

1734 1735 1736
	if (perf_time__skip_sample(&scr->ptime, sample->time))
		return 0;

1737 1738 1739 1740 1741 1742
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
1743
		}
1744 1745
		last_timestamp = sample->time;
		return 0;
F
Frederic Weisbecker 已提交
1746
	}
1747

1748
	if (machine__resolve(machine, &al, sample) < 0) {
1749 1750 1751 1752 1753 1754
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
		return -1;
	}

	if (al.filtered)
1755
		goto out_put;
1756

1757
	if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
1758
		goto out_put;
1759

1760 1761 1762
	if (scripting_ops)
		scripting_ops->process_event(event, sample, evsel, &al);
	else
1763
		process_event(scr, sample, evsel, &al, machine);
1764

1765 1766
out_put:
	addr_location__put(&al);
F
Frederic Weisbecker 已提交
1767 1768 1769
	return 0;
}

1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
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);

1785 1786
	if (evsel->attr.type >= PERF_TYPE_MAX &&
	    evsel->attr.type != PERF_TYPE_SYNTH)
1787 1788
		return 0;

1789
	evlist__for_each_entry(evlist, pos) {
1790 1791 1792 1793 1794 1795
		if (pos->attr.type == evsel->attr.type && pos != evsel)
			return 0;
	}

	set_print_ip_opts(&evsel->attr);

1796 1797 1798 1799
	if (evsel->attr.sample_type)
		err = perf_evsel__check_attr(evsel, scr->session);

	return err;
1800 1801
}

1802 1803 1804 1805 1806 1807 1808 1809
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;
1810
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
	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;
	}
1828
	perf_sample__fprintf_start(sample, thread, evsel, stdout);
1829 1830 1831
	perf_event__fprintf(event, stdout);
	ret = 0;
out:
1832
	thread__put(thread);
1833 1834 1835
	return ret;
}

1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
static int process_namespaces_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);
	int ret = -1;

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

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

	if (!evsel->attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = 0;
		sample->tid = event->namespaces.tid;
		sample->pid = event->namespaces.pid;
	}
1863
	perf_sample__fprintf_start(sample, thread, evsel, stdout);
1864 1865 1866 1867 1868 1869 1870
	perf_event__fprintf(event, stdout);
	ret = 0;
out:
	thread__put(thread);
	return ret;
}

1871 1872 1873 1874 1875 1876 1877 1878
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;
1879
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895

	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;
	}
1896
	perf_sample__fprintf_start(sample, thread, evsel, stdout);
1897
	perf_event__fprintf(event, stdout);
1898
	thread__put(thread);
1899 1900 1901 1902 1903 1904 1905 1906

	return 0;
}
static int process_exit_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
1907
	int err = 0;
1908 1909 1910
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
1911
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1912 1913 1914 1915 1916 1917 1918 1919 1920 1921

	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;
1922 1923
		sample->tid = event->fork.tid;
		sample->pid = event->fork.pid;
1924
	}
1925
	perf_sample__fprintf_start(sample, thread, evsel, stdout);
1926 1927 1928
	perf_event__fprintf(event, stdout);

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

1931 1932
	thread__put(thread);
	return err;
1933 1934
}

1935 1936 1937 1938 1939 1940 1941 1942
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;
1943
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959

	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;
	}
1960
	perf_sample__fprintf_start(sample, thread, evsel, stdout);
1961
	perf_event__fprintf(event, stdout);
1962
	thread__put(thread);
1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973
	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;
1974
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990

	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;
	}
1991
	perf_sample__fprintf_start(sample, thread, evsel, stdout);
1992
	perf_event__fprintf(event, stdout);
1993
	thread__put(thread);
1994 1995 1996
	return 0;
}

1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016
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;
	}

2017
	perf_sample__fprintf_start(sample, thread, evsel, stdout);
2018 2019 2020 2021 2022
	perf_event__fprintf(event, stdout);
	thread__put(thread);
	return 0;
}

2023
static void sig_handler(int sig __maybe_unused)
2024 2025 2026 2027
{
	session_done = 1;
}

2028 2029 2030 2031 2032 2033 2034 2035
static void perf_script__fclose_per_event_dump(struct perf_script *script)
{
	struct perf_evlist *evlist = script->session->evlist;
	struct perf_evsel *evsel;

	evlist__for_each_entry(evlist, evsel) {
		if (!evsel->priv)
			break;
2036
		perf_evsel_script__delete(evsel->priv);
2037 2038 2039 2040 2041 2042 2043 2044 2045
		evsel->priv = NULL;
	}
}

static int perf_script__fopen_per_event_dump(struct perf_script *script)
{
	struct perf_evsel *evsel;

	evlist__for_each_entry(script->session->evlist, evsel) {
2046 2047 2048 2049 2050 2051 2052 2053 2054 2055
		/*
		 * Already setup? I.e. we may be called twice in cases like
		 * Intel PT, one for the intel_pt// and dummy events, then
		 * for the evsels syntheized from the auxtrace info.
		 *
		 * Ses perf_script__process_auxtrace_info.
		 */
		if (evsel->priv != NULL)
			continue;

2056
		evsel->priv = perf_evsel_script__new(evsel, script->session->data);
2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070
		if (evsel->priv == NULL)
			goto out_err_fclose;
	}

	return 0;

out_err_fclose:
	perf_script__fclose_per_event_dump(script);
	return -1;
}

static int perf_script__setup_per_event_dump(struct perf_script *script)
{
	struct perf_evsel *evsel;
2071
	static struct perf_evsel_script es_stdout;
2072 2073 2074 2075

	if (script->per_event_dump)
		return perf_script__fopen_per_event_dump(script);

2076 2077
	es_stdout.fp = stdout;

2078
	evlist__for_each_entry(script->session->evlist, evsel)
2079
		evsel->priv = &es_stdout;
2080 2081 2082 2083

	return 0;
}

2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096
static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
{
	struct perf_evsel *evsel;

	evlist__for_each_entry(script->session->evlist, evsel) {
		struct perf_evsel_script *es = evsel->priv;

		perf_evsel_script__fprintf(es, stdout);
		perf_evsel_script__delete(es);
		evsel->priv = NULL;
	}
}

2097
static int __cmd_script(struct perf_script *script)
F
Frederic Weisbecker 已提交
2098
{
2099 2100
	int ret;

2101 2102
	signal(SIGINT, sig_handler);

2103 2104 2105 2106 2107 2108
	/* 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;
	}
2109 2110 2111 2112
	if (script->show_mmap_events) {
		script->tool.mmap = process_mmap_event;
		script->tool.mmap2 = process_mmap2_event;
	}
2113 2114
	if (script->show_switch_events)
		script->tool.context_switch = process_switch_event;
2115 2116
	if (script->show_namespace_events)
		script->tool.namespaces = process_namespaces_event;
2117

2118 2119 2120 2121 2122
	if (perf_script__setup_per_event_dump(script)) {
		pr_err("Couldn't create the per event dump files\n");
		return -1;
	}

2123
	ret = perf_session__process_events(script->session);
2124

2125
	if (script->per_event_dump)
2126
		perf_script__exit_per_event_dump_stats(script);
2127

2128
	if (debug_mode)
2129
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2130 2131

	return ret;
F
Frederic Weisbecker 已提交
2132 2133
}

T
Tom Zanussi 已提交
2134 2135 2136 2137 2138 2139
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
	char			spec[0];
};

2140
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177

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;

2178
	s = script_spec__new(spec, ops);
T
Tom Zanussi 已提交
2179 2180
	if (!s)
		return -1;
2181 2182
	else
		script_spec__add(s);
T
Tom Zanussi 已提交
2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201

	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 "
2202
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
2203 2204 2205 2206 2207 2208 2209

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

	fprintf(stderr, "\n");
}

2210 2211
static int parse_scriptname(const struct option *opt __maybe_unused,
			    const char *str, int unset __maybe_unused)
T
Tom Zanussi 已提交
2212 2213 2214 2215 2216
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

2217
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
2218
		list_available_languages();
2219
		exit(0);
T
Tom Zanussi 已提交
2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238
	}

	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;
2239
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255
		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;
}

2256 2257
static int parse_output_fields(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused)
2258
{
2259
	char *tok, *strtok_saveptr = NULL;
2260
	int i, imax = ARRAY_SIZE(all_output_options);
2261
	int j;
2262 2263
	int rc = 0;
	char *str = strdup(arg);
2264
	int type = -1;
2265
	enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2266 2267 2268 2269

	if (!str)
		return -ENOMEM;

2270 2271 2272
	/* 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.
2273
	 */
2274 2275 2276 2277 2278 2279 2280 2281 2282 2283
	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;
2284 2285
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
2286 2287
		else if (!strcmp(str, "break"))
			type = PERF_TYPE_BREAKPOINT;
2288 2289
		else if (!strcmp(str, "synth"))
			type = OUTPUT_TYPE_SYNTH;
2290 2291
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
2292 2293
			rc = -EINVAL;
			goto out;
2294 2295 2296 2297 2298 2299 2300 2301
		}

		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;
2302
		output[type].wildcard_set = false;
2303 2304 2305 2306 2307 2308 2309 2310 2311 2312

	} else {
		tok = str;
		if (strlen(str) == 0) {
			fprintf(stderr,
				"Cannot set fields to 'none' for all event types.\n");
			rc = -EINVAL;
			goto out;
		}

2313 2314 2315 2316
		/* Don't override defaults for +- */
		if (strchr(str, '+') || strchr(str, '-'))
			goto parse;

2317 2318 2319
		if (output_set_by_user())
			pr_warning("Overriding previous field request for all events.\n");

2320
		for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2321 2322
			output[j].fields = 0;
			output[j].user_set = true;
2323
			output[j].wildcard_set = true;
2324
		}
2325 2326
	}

2327
parse:
2328
	for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344
		if (*tok == '+') {
			if (change == SET)
				goto out_badmix;
			change = ADD;
			tok++;
		} else if (*tok == '-') {
			if (change == SET)
				goto out_badmix;
			change = REMOVE;
			tok++;
		} else {
			if (change != SET && change != DEFAULT)
				goto out_badmix;
			change = SET;
		}

2345
		for (i = 0; i < imax; ++i) {
2346
			if (strcmp(tok, all_output_options[i].str) == 0)
2347 2348
				break;
		}
2349
		if (i == imax && strcmp(tok, "flags") == 0) {
2350
			print_flags = change == REMOVE ? false : true;
2351 2352
			continue;
		}
2353
		if (i == imax) {
2354
			fprintf(stderr, "Invalid field requested.\n");
2355
			rc = -EINVAL;
2356
			goto out;
2357 2358
		}

2359 2360 2361 2362
		if (type == -1) {
			/* add user option to all events types for
			 * which it is valid
			 */
2363
			for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2364 2365 2366
				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));
2367 2368 2369 2370 2371 2372
				} else {
					if (change == REMOVE)
						output[j].fields &= ~all_output_options[i].field;
					else
						output[j].fields |= all_output_options[i].field;
				}
2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383
			}
		} 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;
		}
2384 2385
	}

2386 2387 2388 2389 2390 2391
	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));
		}
	}
2392
	goto out;
2393

2394 2395 2396
out_badmix:
	fprintf(stderr, "Cannot mix +-field with overridden fields\n");
	rc = -EINVAL;
2397
out:
2398 2399 2400 2401
	free(str);
	return rc;
}

2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414
/* 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);
}

2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
#define for_each_lang(scripts_path, scripts_dir, lang_dirent)		\
	while ((lang_dirent = readdir(scripts_dir)) != NULL)		\
		if ((lang_dirent->d_type == DT_DIR ||			\
		     (lang_dirent->d_type == DT_UNKNOWN &&		\
		      is_directory(scripts_path, lang_dirent))) &&	\
		    (strcmp(lang_dirent->d_name, ".")) &&		\
		    (strcmp(lang_dirent->d_name, "..")))

#define for_each_script(lang_path, lang_dir, script_dirent)		\
	while ((script_dirent = readdir(lang_dir)) != NULL)		\
		if (script_dirent->d_type != DT_DIR &&			\
		    (script_dirent->d_type != DT_UNKNOWN ||		\
		     !is_directory(lang_path, script_dirent)))
2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439


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

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

2440
static LIST_HEAD(script_descs);
2441 2442 2443 2444 2445

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

2446
	if (s != NULL && name)
2447 2448 2449 2450 2451 2452 2453
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
2454 2455 2456
	zfree(&s->name);
	zfree(&s->half_liner);
	zfree(&s->args);
2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483
	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)
2484
		return NULL;
2485 2486 2487 2488 2489 2490

	script_desc__add(s);

	return s;
}

2491
static const char *ends_with(const char *str, const char *suffix)
2492 2493
{
	size_t suffix_len = strlen(suffix);
2494
	const char *p = str;
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545

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

2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563
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;
}

2564 2565 2566
static int list_available_scripts(const struct option *opt __maybe_unused,
				  const char *s __maybe_unused,
				  int unset __maybe_unused)
2567
{
2568
	struct dirent *script_dirent, *lang_dirent;
2569 2570 2571 2572 2573 2574 2575 2576
	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;

2577
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2578 2579

	scripts_dir = opendir(scripts_path);
2580 2581 2582 2583 2584 2585 2586
	if (!scripts_dir) {
		fprintf(stdout,
			"open(%s) failed.\n"
			"Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
			scripts_path);
		exit(-1);
	}
2587

2588
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2589
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
2590
			 lang_dirent->d_name);
2591 2592 2593 2594
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

2595 2596
		for_each_script(lang_path, lang_dir, script_dirent) {
			script_root = get_script_root(script_dirent, REPORT_SUFFIX);
2597
			if (script_root) {
2598 2599
				desc = script_desc__findnew(script_root);
				snprintf(script_path, MAXPATHLEN, "%s/%s",
2600
					 lang_path, script_dirent->d_name);
2601
				read_script_info(desc, script_path);
2602
				free(script_root);
2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617
			}
		}
	}

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

2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660
/*
 * 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;
2661
			evlist__for_each_entry(session->evlist, pos) {
2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678
				if (!strcmp(perf_evsel__name(pos), evname)) {
					match = 1;
					break;
				}
			}

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

	fclose(fp);
	return 0;
}

2679 2680 2681 2682 2683 2684 2685 2686 2687
/*
 * 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)
{
2688
	struct dirent *script_dirent, *lang_dirent;
2689
	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
2690
	DIR *scripts_dir, *lang_dir;
2691
	struct perf_session *session;
2692
	struct perf_data data = {
J
Jiri Olsa 已提交
2693 2694 2695 2696
		.file      = {
			.path = input_name,
		},
		.mode      = PERF_DATA_MODE_READ,
2697
	};
2698 2699 2700
	char *temp;
	int i = 0;

2701
	session = perf_session__new(&data, false, NULL);
2702 2703 2704
	if (!session)
		return -1;

2705
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2706 2707

	scripts_dir = opendir(scripts_path);
2708 2709
	if (!scripts_dir) {
		perf_session__delete(session);
2710
		return -1;
2711
	}
2712

2713
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2714
		snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
2715
			 lang_dirent->d_name);
2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728
#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;

2729
		for_each_script(lang_path, lang_dir, script_dirent) {
2730
			/* Skip those real time scripts: xxxtop.p[yl] */
2731
			if (strstr(script_dirent->d_name, "top."))
2732 2733
				continue;
			sprintf(scripts_path_array[i], "%s/%s", lang_path,
2734 2735
				script_dirent->d_name);
			temp = strchr(script_dirent->d_name, '.');
2736
			snprintf(scripts_array[i],
2737 2738
				(temp - script_dirent->d_name) + 1,
				"%s", script_dirent->d_name);
2739 2740 2741 2742 2743

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

2744 2745
			i++;
		}
2746
		closedir(lang_dir);
2747 2748
	}

2749 2750
	closedir(scripts_dir);
	perf_session__delete(session);
2751 2752 2753
	return i;
}

2754 2755
static char *get_script_path(const char *script_root, const char *suffix)
{
2756
	struct dirent *script_dirent, *lang_dirent;
2757 2758 2759 2760
	char scripts_path[MAXPATHLEN];
	char script_path[MAXPATHLEN];
	DIR *scripts_dir, *lang_dir;
	char lang_path[MAXPATHLEN];
2761
	char *__script_root;
2762

2763
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2764 2765 2766 2767 2768

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

2769
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2770
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
2771
			 lang_dirent->d_name);
2772 2773 2774 2775
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

2776 2777
		for_each_script(lang_path, lang_dir, script_dirent) {
			__script_root = get_script_root(script_dirent, suffix);
2778 2779
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
2780 2781
				closedir(lang_dir);
				closedir(scripts_dir);
2782
				snprintf(script_path, MAXPATHLEN, "%s/%s",
2783
					 lang_path, script_dirent->d_name);
2784
				return strdup(script_path);
2785 2786 2787
			}
			free(__script_root);
		}
2788
		closedir(lang_dir);
2789
	}
2790
	closedir(scripts_dir);
2791

2792
	return NULL;
2793 2794
}

2795 2796
static bool is_top_script(const char *script_path)
{
2797
	return ends_with(script_path, "top") == NULL ? false : true;
2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822
}

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

2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835
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 已提交
2836

2837 2838 2839 2840 2841
	system_wide = (argc == 0);

	return 0;
}

2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857
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;
	}
}

2858 2859 2860 2861 2862 2863 2864
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;

2865
	evlist__for_each_entry(session->evlist, counter) {
2866 2867 2868 2869 2870 2871 2872 2873
		perf_stat_process_counter(&stat_config, counter);
		process_stat(counter, round->time);
	}

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

2874 2875 2876 2877 2878 2879 2880 2881
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;
}

2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938
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);
}

2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957
#ifdef HAVE_AUXTRACE_SUPPORT
static int perf_script__process_auxtrace_info(struct perf_tool *tool,
					      union perf_event *event,
					      struct perf_session *session)
{
	int ret = perf_event__process_auxtrace_info(tool, event, session);

	if (ret == 0) {
		struct perf_script *script = container_of(tool, struct perf_script, tool);

		ret = perf_script__setup_per_event_dump(script);
	}

	return ret;
}
#else
#define perf_script__process_auxtrace_info 0
#endif

2958
int cmd_script(int argc, const char **argv)
2959 2960
{
	bool show_full_info = false;
2961 2962
	bool header = false;
	bool header_only = false;
2963
	bool script_started = false;
2964 2965 2966
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
	struct perf_session *session;
2967
	struct itrace_synth_opts itrace_synth_opts = { .set = false, };
2968 2969
	char *script_path = NULL;
	const char **__argv;
2970
	int i, j, err = 0;
2971 2972 2973 2974 2975 2976
	struct perf_script script = {
		.tool = {
			.sample		 = process_sample_event,
			.mmap		 = perf_event__process_mmap,
			.mmap2		 = perf_event__process_mmap2,
			.comm		 = perf_event__process_comm,
2977
			.namespaces	 = perf_event__process_namespaces,
2978 2979
			.exit		 = perf_event__process_exit,
			.fork		 = perf_event__process_fork,
2980
			.attr		 = process_attr,
2981
			.event_update   = perf_event__process_event_update,
2982
			.tracing_data	 = perf_event__process_tracing_data,
2983
			.feature	 = perf_event__process_feature,
2984
			.build_id	 = perf_event__process_build_id,
2985
			.id_index	 = perf_event__process_id_index,
2986
			.auxtrace_info	 = perf_script__process_auxtrace_info,
2987 2988
			.auxtrace	 = perf_event__process_auxtrace,
			.auxtrace_error	 = perf_event__process_auxtrace_error,
2989 2990
			.stat		 = perf_event__process_stat_event,
			.stat_round	 = process_stat_round_event,
2991
			.stat_config	 = process_stat_config_event,
2992 2993
			.thread_map	 = process_thread_map_event,
			.cpu_map	 = process_cpu_map_event,
2994
			.ordered_events	 = true,
2995 2996 2997
			.ordering_requires_timestamps = true,
		},
	};
2998
	struct perf_data data = {
2999 3000
		.mode = PERF_DATA_MODE_READ,
	};
3001
	const struct option options[] = {
F
Frederic Weisbecker 已提交
3002 3003
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
3004
	OPT_INCR('v', "verbose", &verbose,
3005
		 "be more verbose (show symbol address, etc)"),
3006
	OPT_BOOLEAN('L', "Latency", &latency_format,
3007
		    "show latency attributes (irqs/preemption disabled, etc)"),
3008 3009
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
T
Tom Zanussi 已提交
3010 3011 3012 3013
	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",
3014
		   "generate perf-script.xx script in specified language"),
3015
	OPT_STRING('i', "input", &input_name, "file", "input file name"),
3016 3017
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
3018 3019
	OPT_BOOLEAN(0, "header", &header, "Show data header."),
	OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3020 3021 3022 3023 3024 3025
	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"),
3026 3027 3028
	OPT_CALLBACK(0, "symfs", NULL, "directory",
		     "Look for files with symbols relative to this directory",
		     symbol__config_symfs),
3029
	OPT_CALLBACK('F', "fields", NULL, "str",
3030
		     "comma separated output fields prepend with 'type:'. "
3031
		     "+field to add and -field to remove."
3032
		     "Valid types: hw,sw,trace,raw,synth. "
3033
		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
A
Andi Kleen 已提交
3034
		     "addr,symoff,period,iregs,uregs,brstack,brstacksym,flags,"
3035
		     "bpf-output,callindent,insn,insnlen,brstackinsn,synth,phys_addr",
3036
		     parse_output_fields),
3037
	OPT_BOOLEAN('a', "all-cpus", &system_wide,
3038
		    "system-wide collection from all CPUs"),
3039 3040
	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
		   "only consider these symbols"),
3041 3042
	OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
		   "Stop display of callgraph at these symbols"),
3043
	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3044 3045
	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only display events for these comms"),
3046 3047 3048 3049
	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"),
3050 3051 3052
	OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
		     "Set the maximum stack depth when parsing the callchain, "
		     "anything beyond the specified depth will be ignored. "
3053
		     "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3054 3055
	OPT_BOOLEAN('I', "show-info", &show_full_info,
		    "display extended information from perf.data file"),
3056 3057
	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
		    "Show the path of [kernel.kallsyms]"),
3058 3059
	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
		    "Show the fork/comm/exit events"),
3060 3061
	OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
		    "Show the mmap events"),
3062 3063
	OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
		    "Show context switch events (if recorded)"),
3064 3065
	OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
		    "Show namespace events (if recorded)"),
3066 3067
	OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
		    "Dump trace output to files named by the monitored events"),
3068
	OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3069 3070
	OPT_INTEGER(0, "max-blocks", &max_blocks,
		    "Maximum number of code blocks to dump with brstackinsn"),
3071 3072
	OPT_BOOLEAN(0, "ns", &nanosecs,
		    "Use 9 decimal places when displaying time"),
3073 3074 3075
	OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
			    "Instruction Tracing options",
			    itrace_parse_synth_opts),
3076 3077
	OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
			"Show full source file name path for source lines"),
3078 3079 3080 3081
	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
			"Enable symbol demangling"),
	OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
			"Enable kernel symbol demangling"),
3082 3083
	OPT_STRING(0, "time", &script.time_str, "str",
		   "Time span of interest (start,stop)"),
3084 3085
	OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
		    "Show inline function"),
3086
	OPT_END()
3087
	};
3088 3089
	const char * const script_subcommands[] = { "record", "report", NULL };
	const char *script_usage[] = {
3090 3091 3092 3093 3094 3095 3096
		"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
	};
3097

3098 3099
	perf_set_singlethreaded();

3100 3101
	setup_scripting();

3102
	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3103 3104
			     PARSE_OPT_STOP_AT_NON_OPTION);

J
Jiri Olsa 已提交
3105 3106
	data.file.path = input_name;
	data.force     = symbol_conf.force;
3107

3108 3109 3110
	if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
		rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
		if (!rec_script_path)
3111
			return cmd_record(argc, argv);
3112 3113
	}

3114 3115 3116
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
3117
			fprintf(stderr,
3118
				"Please specify a valid report script"
3119
				"(see 'perf script -l' for listing)\n");
3120 3121 3122 3123
			return -1;
		}
	}

3124 3125 3126 3127
	if (itrace_synth_opts.callchain &&
	    itrace_synth_opts.callchain_sz > scripting_max_stack)
		scripting_max_stack = itrace_synth_opts.callchain_sz;

3128
	/* make sure PERF_EXEC_PATH is set for scripts */
3129
	set_argv_exec_path(get_argv_exec_path());
3130

3131
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
3132
		int live_pipe[2];
3133
		int rep_args;
3134 3135
		pid_t pid;

3136 3137 3138 3139
		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) {
3140 3141
			usage_with_options_msg(script_usage, options,
				"Couldn't find script `%s'\n\n See perf"
3142
				" script -l for available scripts.\n", argv[0]);
3143 3144
		}

3145 3146 3147 3148 3149 3150 3151 3152
		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) {
3153 3154
				usage_with_options_msg(script_usage, options,
					"`%s' script requires options."
3155
					"\n\n See perf script -l for available "
3156 3157
					"scripts and options.\n", argv[0]);
			}
3158 3159 3160 3161
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
3162
			return -1;
3163 3164 3165 3166 3167
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
3168
			return -1;
3169 3170 3171
		}

		if (!pid) {
3172 3173
			j = 0;

3174 3175 3176
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

3177 3178 3179
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
3180 3181 3182 3183
				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
					err = -1;
					goto out;
				}
3184
			}
3185 3186

			__argv = malloc((argc + 6) * sizeof(const char *));
3187 3188 3189 3190 3191
			if (!__argv) {
				pr_err("malloc failed\n");
				err = -ENOMEM;
				goto out;
			}
3192

3193 3194 3195 3196 3197 3198 3199 3200 3201 3202
			__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;
3203 3204

			execvp("/bin/sh", (char **)__argv);
3205
			free(__argv);
3206 3207 3208 3209 3210 3211
			exit(-1);
		}

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

3212
		__argv = malloc((argc + 4) * sizeof(const char *));
3213 3214 3215 3216 3217 3218
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

3219 3220 3221 3222 3223 3224 3225 3226
		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;
3227 3228

		execvp("/bin/sh", (char **)__argv);
3229
		free(__argv);
3230 3231 3232
		exit(-1);
	}

3233 3234 3235 3236
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
3237

3238 3239
	if (script_path) {
		j = 0;
3240

3241 3242
		if (!rec_script_path)
			system_wide = false;
3243 3244 3245 3246 3247 3248
		else if (!system_wide) {
			if (have_cmd(argc - 1, &argv[1]) != 0) {
				err = -1;
				goto out;
			}
		}
3249

3250
		__argv = malloc((argc + 2) * sizeof(const char *));
3251 3252 3253 3254 3255 3256
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

3257 3258 3259 3260
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
3261
		for (i = 2; i < argc; i++)
3262 3263
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
3264 3265

		execvp("/bin/sh", (char **)__argv);
3266
		free(__argv);
3267 3268
		exit(-1);
	}
T
Tom Zanussi 已提交
3269

3270 3271
	if (!script_name)
		setup_pager();
F
Frederic Weisbecker 已提交
3272

3273
	session = perf_session__new(&data, false, &script.tool);
3274
	if (session == NULL)
3275
		return -1;
3276

3277
	if (header || header_only) {
3278
		script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3279 3280
		perf_session__fprintf_info(session, stdout, show_full_info);
		if (header_only)
3281
			goto out_delete;
3282
	}
3283 3284
	if (show_full_info)
		script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3285

3286
	if (symbol__init(&session->header.env) < 0)
3287 3288
		goto out_delete;

3289
	script.session = session;
3290
	script__setup_sample_type(&script);
3291

3292 3293 3294
	if (output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT)
		itrace_synth_opts.thread_stack = true;

3295 3296
	session->itrace_synth_opts = &itrace_synth_opts;

3297
	if (cpu_list) {
3298 3299 3300
		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
		if (err < 0)
			goto out_delete;
3301
		itrace_synth_opts.cpu_bitmap = cpu_bitmap;
3302 3303
	}

3304
	if (!no_callchain)
3305 3306 3307 3308
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

3309 3310
	if (session->tevent.pevent &&
	    pevent_set_function_resolver(session->tevent.pevent,
3311 3312 3313
					 machine__resolve_kernel_addr,
					 &session->machines.host) < 0) {
		pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
3314 3315
		err = -1;
		goto out_delete;
3316 3317
	}

T
Tom Zanussi 已提交
3318 3319
	if (generate_script_lang) {
		struct stat perf_stat;
3320 3321
		int input;

3322
		if (output_set_by_user()) {
3323 3324
			fprintf(stderr,
				"custom fields not supported for generated scripts");
3325 3326
			err = -EINVAL;
			goto out_delete;
3327
		}
T
Tom Zanussi 已提交
3328

J
Jiri Olsa 已提交
3329
		input = open(data.file.path, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
3330
		if (input < 0) {
3331
			err = -errno;
T
Tom Zanussi 已提交
3332
			perror("failed to open file");
3333
			goto out_delete;
T
Tom Zanussi 已提交
3334 3335 3336 3337 3338
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
3339
			goto out_delete;
T
Tom Zanussi 已提交
3340 3341 3342 3343
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
3344
			goto out_delete;
T
Tom Zanussi 已提交
3345 3346 3347 3348 3349
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
3350 3351
			err = -ENOENT;
			goto out_delete;
T
Tom Zanussi 已提交
3352 3353
		}

J
Jiri Olsa 已提交
3354
		err = scripting_ops->generate_script(session->tevent.pevent,
3355
						     "perf-script");
3356
		goto out_delete;
T
Tom Zanussi 已提交
3357 3358 3359
	}

	if (script_name) {
3360
		err = scripting_ops->start_script(script_name, argc, argv);
T
Tom Zanussi 已提交
3361
		if (err)
3362
			goto out_delete;
3363
		pr_debug("perf script started with script %s\n\n", script_name);
3364
		script_started = true;
T
Tom Zanussi 已提交
3365 3366
	}

3367 3368 3369

	err = perf_session__check_output_opt(session);
	if (err < 0)
3370
		goto out_delete;
3371

3372 3373 3374
	/* needs to be parsed after looking up reference time */
	if (perf_time__parse_str(&script.ptime, script.time_str) != 0) {
		pr_err("Invalid time string\n");
3375 3376
		err = -EINVAL;
		goto out_delete;
3377 3378
	}

3379
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
3380

3381 3382
	flush_scripting();

3383
out_delete:
3384
	perf_evlist__free_stats(session->evlist);
3385
	perf_session__delete(session);
3386 3387 3388

	if (script_started)
		cleanup_scripting();
T
Tom Zanussi 已提交
3389 3390
out:
	return err;
F
Frederic Weisbecker 已提交
3391
}