builtin-script.c 90.6 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 "util/path.h"
30
#include "print_binary.h"
31
#include <linux/bitmap.h>
32
#include <linux/kernel.h>
33
#include <linux/stringify.h>
34
#include <linux/time64.h>
35
#include "asm/bug.h"
J
Jiri Olsa 已提交
36
#include "util/mem-events.h"
37
#include "util/dump-insn.h"
38
#include <dirent.h>
39
#include <errno.h>
40
#include <inttypes.h>
41
#include <signal.h>
42
#include <sys/param.h>
43 44
#include <sys/types.h>
#include <sys/stat.h>
45
#include <fcntl.h>
46
#include <unistd.h>
F
Frederic Weisbecker 已提交
47

48 49
#include "sane_ctype.h"

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

65
unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
66

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

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

136 137 138 139 140
enum {
	OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
	OUTPUT_TYPE_MAX
};

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

	[PERF_TYPE_HARDWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
155
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
156 157
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
			      PERF_OUTPUT_PERIOD,
158

159
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
160 161 162 163 164 165 166
	},

	[PERF_TYPE_SOFTWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
167
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
168
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
169
			      PERF_OUTPUT_PERIOD | PERF_OUTPUT_BPF_OUTPUT,
170 171 172 173 174 175 176 177 178

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_TRACEPOINT] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
				  PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
179
				  PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
180
	},
181 182 183 184 185 186

	[PERF_TYPE_RAW] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
187
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
188
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
189
			      PERF_OUTPUT_PERIOD |  PERF_OUTPUT_ADDR |
190 191
			      PERF_OUTPUT_DATA_SRC | PERF_OUTPUT_WEIGHT |
			      PERF_OUTPUT_PHYS_ADDR,
192

193
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
194
	},
195 196 197 198 199 200 201 202 203 204

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

205
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
206
	},
207 208 209 210 211 212 213

	[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 |
214 215
			      PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
			      PERF_OUTPUT_SYNTH,
216 217 218

		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
	},
219
};
220

221 222 223 224
struct perf_evsel_script {
       char *filename;
       FILE *fp;
       u64  samples;
225 226 227
       /* For metric output */
       u64  val;
       int  gnum;
228 229
};

230 231 232 233 234
static inline struct perf_evsel_script *evsel_script(struct perf_evsel *evsel)
{
	return (struct perf_evsel_script *)evsel->priv;
}

235
static struct perf_evsel_script *perf_evsel_script__new(struct perf_evsel *evsel,
236
							struct perf_data *data)
237
{
238
	struct perf_evsel_script *es = zalloc(sizeof(*es));
239 240

	if (es != NULL) {
J
Jiri Olsa 已提交
241
		if (asprintf(&es->filename, "%s.%s.dump", data->file.path, perf_evsel__name(evsel)) < 0)
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 269 270 271 272
			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);
}

273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
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;
	}
}

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

303 304 305 306 307 308 309 310 311 312 313 314 315 316
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;
}

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

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

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

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

	return 0;
}

351 352 353 354 355 356 357 358
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);
}

359 360 361 362
static int perf_evsel__check_attr(struct perf_evsel *evsel,
				  struct perf_session *session)
{
	struct perf_event_attr *attr = &evsel->attr;
363 364
	bool allow_user_set;

365 366 367
	if (perf_header__has_feat(&session->header, HEADER_STAT))
		return 0;

368 369
	allow_user_set = perf_header__has_feat(&session->header,
					       HEADER_AUXTRACE);
370

371 372 373 374
	if (PRINT_FIELD(TRACE) &&
		!perf_session__has_traces(session, "record -R"))
		return -EINVAL;

375
	if (PRINT_FIELD(IP)) {
376 377
		if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
					    PERF_OUTPUT_IP))
378 379
			return -EINVAL;
	}
380 381

	if (PRINT_FIELD(ADDR) &&
382 383
		perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
					   PERF_OUTPUT_ADDR, allow_user_set))
384 385
		return -EINVAL;

386 387 388 389 390 391 392 393 394 395
	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;

396 397 398 399
	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");
400 401
		return -EINVAL;
	}
402 403 404 405 406
	if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
		pr_err("Display of offsets requested but symbol is not"
		       "selected.\n");
		return -EINVAL;
	}
407
	if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR) &&
408 409 410
	    !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");
411 412
		return -EINVAL;
	}
413 414 415 416 417
	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;
	}
418 419 420 421 422 423 424
	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;
	}
425
	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
426 427
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
					PERF_OUTPUT_TID|PERF_OUTPUT_PID))
428 429 430
		return -EINVAL;

	if (PRINT_FIELD(TIME) &&
431 432
		perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
					PERF_OUTPUT_TIME))
433 434 435
		return -EINVAL;

	if (PRINT_FIELD(CPU) &&
436 437
		perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
					   PERF_OUTPUT_CPU, allow_user_set))
438
		return -EINVAL;
439

440 441 442 443 444
	if (PRINT_FIELD(IREGS) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
					PERF_OUTPUT_IREGS))
		return -EINVAL;

A
Andi Kleen 已提交
445 446 447 448 449
	if (PRINT_FIELD(UREGS) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS",
					PERF_OUTPUT_UREGS))
		return -EINVAL;

450 451 452 453 454
	if (PRINT_FIELD(PHYS_ADDR) &&
		perf_evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR",
					PERF_OUTPUT_PHYS_ADDR))
		return -EINVAL;

455 456 457
	return 0;
}

458 459
static void set_print_ip_opts(struct perf_event_attr *attr)
{
460
	unsigned int type = output_type(attr->type);
461 462 463

	output[type].print_ip_opts = 0;
	if (PRINT_FIELD(IP))
464
		output[type].print_ip_opts |= EVSEL__PRINT_IP;
465 466

	if (PRINT_FIELD(SYM))
467
		output[type].print_ip_opts |= EVSEL__PRINT_SYM;
468 469

	if (PRINT_FIELD(DSO))
470
		output[type].print_ip_opts |= EVSEL__PRINT_DSO;
471 472

	if (PRINT_FIELD(SYMOFFSET))
473
		output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
474 475

	if (PRINT_FIELD(SRCLINE))
476
		output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
477 478
}

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

488 489
	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
		evsel = perf_session__find_first_evtype(session, attr_type(j));
490 491 492 493 494

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

		if (evsel && output[j].fields &&
			perf_evsel__check_attr(evsel, session))
			return -1;
506 507 508 509

		if (evsel == NULL)
			continue;

510
		set_print_ip_opts(&evsel->attr);
511 512
	}

513 514
	if (!no_callchain) {
		bool use_callchain = false;
515
		bool not_pipe = false;
516

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

528 529 530 531 532 533 534 535 536 537
	/*
	 * 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;

538
		evlist__for_each_entry(session->evlist, evsel) {
539 540 541 542
			if (evsel->attr.type != j)
				continue;

			attr = &evsel->attr;
543

544 545 546 547 548 549 550
			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;
			}
551 552 553 554
		}
	}

out:
555 556
	return 0;
}
557

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

	if (!regs)
567
		return 0;
568 569 570

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

	return printed;
575 576
}

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

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

588
	printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
A
Andi Kleen 已提交
589 590 591

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

	return printed;
A
Andi Kleen 已提交
596 597
}

598 599
static int perf_sample__fprintf_start(struct perf_sample *sample,
				      struct thread *thread,
600 601
				      struct perf_evsel *evsel,
				      u32 type, FILE *fp)
602
{
603
	struct perf_event_attr *attr = &evsel->attr;
604
	unsigned long secs;
605
	unsigned long long nsecs;
606
	int printed = 0;
607 608 609

	if (PRINT_FIELD(COMM)) {
		if (latency_format)
610
			printed += fprintf(fp, "%8.8s ", thread__comm_str(thread));
611
		else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
612
			printed += fprintf(fp, "%s ", thread__comm_str(thread));
613
		else
614
			printed += fprintf(fp, "%16s ", thread__comm_str(thread));
615
	}
616

617
	if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
618
		printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
619
	else if (PRINT_FIELD(PID))
620
		printed += fprintf(fp, "%5d ", sample->pid);
621
	else if (PRINT_FIELD(TID))
622
		printed += fprintf(fp, "%5d ", sample->tid);
623 624 625

	if (PRINT_FIELD(CPU)) {
		if (latency_format)
626
			printed += fprintf(fp, "%3d ", sample->cpu);
627
		else
628
			printed += fprintf(fp, "[%03d] ", sample->cpu);
629
	}
630

631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
	if (PRINT_FIELD(MISC)) {
		int ret = 0;

		#define has(m) \
			(sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m

		if (has(KERNEL))
			ret += fprintf(fp, "K");
		if (has(USER))
			ret += fprintf(fp, "U");
		if (has(HYPERVISOR))
			ret += fprintf(fp, "H");
		if (has(GUEST_KERNEL))
			ret += fprintf(fp, "G");
		if (has(GUEST_USER))
			ret += fprintf(fp, "g");

		switch (type) {
		case PERF_RECORD_MMAP:
		case PERF_RECORD_MMAP2:
			if (has(MMAP_DATA))
				ret += fprintf(fp, "M");
			break;
		case PERF_RECORD_COMM:
			if (has(COMM_EXEC))
				ret += fprintf(fp, "E");
			break;
		case PERF_RECORD_SWITCH:
		case PERF_RECORD_SWITCH_CPU_WIDE:
660
			if (has(SWITCH_OUT)) {
661
				ret += fprintf(fp, "S");
662 663 664
				if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
					ret += fprintf(fp, "p");
			}
665 666 667 668 669 670 671 672 673 674
		default:
			break;
		}

		#undef has

		ret += fprintf(fp, "%*s", 6 - ret, " ");
		printed += ret;
	}

675 676
	if (PRINT_FIELD(TIME)) {
		nsecs = sample->time;
677 678
		secs = nsecs / NSEC_PER_SEC;
		nsecs -= secs * NSEC_PER_SEC;
679

680
		if (nanosecs)
681
			printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
682 683 684
		else {
			char sample_time[32];
			timestamp__scnprintf_usec(sample->time, sample_time, sizeof(sample_time));
685
			printed += fprintf(fp, "%12s: ", sample_time);
686
		}
687
	}
688 689

	return printed;
690 691
}

692 693 694 695 696 697 698 699 700
static inline char
mispred_str(struct branch_entry *br)
{
	if (!(br->flags.mispred  || br->flags.predicted))
		return '-';

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

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

	if (!(br && br->nr))
711
		return 0;
712 713

	for (i = 0; i < br->nr; i++) {
714 715 716 717 718 719
		from = br->entries[i].from;
		to   = br->entries[i].to;

		if (PRINT_FIELD(DSO)) {
			memset(&alf, 0, sizeof(alf));
			memset(&alt, 0, sizeof(alt));
720 721
			thread__find_map(thread, sample->cpumode, from, &alf);
			thread__find_map(thread, sample->cpumode, to, &alt);
722 723
		}

724
		printed += fprintf(fp, " 0x%"PRIx64, from);
725
		if (PRINT_FIELD(DSO)) {
726 727 728
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alf.map, fp);
			printed += fprintf(fp, ")");
729 730
		}

731
		printed += fprintf(fp, "/0x%"PRIx64, to);
732
		if (PRINT_FIELD(DSO)) {
733 734 735
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alt.map, fp);
			printed += fprintf(fp, ")");
736 737
		}

738
		printed += fprintf(fp, "/%c/%c/%c/%d ",
739 740 741 742 743
			mispred_str( br->entries + i),
			br->entries[i].flags.in_tx? 'X' : '-',
			br->entries[i].flags.abort? 'A' : '-',
			br->entries[i].flags.cycles);
	}
744 745

	return printed;
746 747
}

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

	if (!(br && br->nr))
758
		return 0;
759 760 761 762 763 764 765 766

	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;

767
		thread__find_map(thread, sample->cpumode, from, &alf);
768
		if (alf.map)
769
			alf.sym = map__find_symbol(alf.map, alf.addr);
770

771
		thread__find_map(thread, sample->cpumode, to, &alt);
772
		if (alt.map)
773
			alt.sym = map__find_symbol(alt.map, alt.addr);
774

775
		printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
776
		if (PRINT_FIELD(DSO)) {
777 778 779
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alf.map, fp);
			printed += fprintf(fp, ")");
780
		}
781 782
		printed += fprintf(fp, "%c", '/');
		printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
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
static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
					   struct thread *thread,
					   struct perf_event_attr *attr, FILE *fp)
801 802 803 804
{
	struct branch_stack *br = sample->branch_stack;
	struct addr_location alf, alt;
	u64 i, from, to;
805
	int printed = 0;
806 807

	if (!(br && br->nr))
808
		return 0;
809 810 811 812 813 814 815 816

	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;

817
		thread__find_map(thread, sample->cpumode, from, &alf);
818 819 820
		if (alf.map && !alf.map->dso->adjust_symbols)
			from = map__map_ip(alf.map, from);

821
		thread__find_map(thread, sample->cpumode, to, &alt);
822 823 824
		if (alt.map && !alt.map->dso->adjust_symbols)
			to = map__map_ip(alt.map, to);

825
		printed += fprintf(fp, " 0x%"PRIx64, from);
826
		if (PRINT_FIELD(DSO)) {
827 828 829
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alf.map, fp);
			printed += fprintf(fp, ")");
830
		}
831
		printed += fprintf(fp, "/0x%"PRIx64, to);
832
		if (PRINT_FIELD(DSO)) {
833 834 835
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alt.map, fp);
			printed += fprintf(fp, ")");
836
		}
837
		printed += fprintf(fp, "/%c/%c/%c/%d ",
838 839 840 841 842
			mispred_str(br->entries + i),
			br->entries[i].flags.in_tx ? 'X' : '-',
			br->entries[i].flags.abort ? 'A' : '-',
			br->entries[i].flags.cycles);
	}
843 844

	return printed;
845
}
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
#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)) {
872
		pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
873 874 875 876 877 878
		return -ENXIO;
	}

	memset(&al, 0, sizeof(al));
	if (end - start > MAXBB - MAXINSN) {
		if (last)
879
			pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
880
		else
881
			pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
882 883 884
		return 0;
	}

885
	thread__find_map(thread, *cpumode, start, &al);
886
	if (!al.map || !al.map->dso) {
887
		pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
888 889 890
		return 0;
	}
	if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
891
		pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
892 893 894 895 896 897 898 899 900 901 902 903
		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)
904
		pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
905 906 907 908
			start, end);
	return len;
}

909 910 911
static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
			    struct perf_insn *x, u8 *inbuf, int len,
			    int insn, FILE *fp)
912
{
913 914 915 916 917 918
	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" : "");
919
	if (en->flags.cycles) {
920
		printed += fprintf(fp, " %d cycles", en->flags.cycles);
921
		if (insn)
922
			printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
923
	}
924
	return printed + fprintf(fp, "\n");
925 926
}

927 928 929
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)
930 931
{
	struct addr_location al;
932
	int off, printed = 0;
933 934 935

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

936
	thread__find_map(thread, cpumode, addr, &al);
937
	if (!al.map)
938
		__thread__find_map(thread, cpumode, MAP__VARIABLE, addr, &al);
939
	if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
940
		return 0;
941 942 943 944 945 946 947

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

	if (!al.sym)
948
		return 0;
949 950 951 952 953

	if (al.addr < al.sym->end)
		off = al.addr - al.sym->start;
	else
		off = al.addr - al.map->start - al.sym->start;
954
	printed += fprintf(fp, "\t%s", al.sym->name);
955
	if (off)
956 957
		printed += fprintf(fp, "%+d", off);
	printed += fprintf(fp, ":");
958
	if (PRINT_FIELD(SRCLINE))
959 960
		printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
	printed += fprintf(fp, "\n");
961
	*lastsym = al.sym;
962 963

	return printed;
964 965
}

966 967 968 969
static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
					    struct thread *thread,
					    struct perf_event_attr *attr,
					    struct machine *machine, FILE *fp)
970 971 972
{
	struct branch_stack *br = sample->branch_stack;
	u64 start, end;
973
	int i, insn, len, nr, ilen, printed = 0;
974 975 976 977 978 979
	struct perf_insn x;
	u8 buffer[MAXBB];
	unsigned off;
	struct symbol *lastsym = NULL;

	if (!(br && br->nr))
980
		return 0;
981 982 983 984 985 986 987
	nr = br->nr;
	if (max_blocks && nr > max_blocks + 1)
		nr = max_blocks + 1;

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

988
	printed += fprintf(fp, "%c", '\n');
989 990 991 992 993 994

	/* 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) {
995 996 997 998
		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);
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
	}

	/* 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;

1024
			printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1025
			if (ip == end) {
1026
				printed += ip__fprintf_jump(ip, &br->entries[i], &x, buffer + off, len - off, insn, fp);
1027 1028
				break;
			} else {
1029 1030
				printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
						   dump_insn(&x, ip, buffer + off, len - off, &ilen));
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
				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)
1043
		goto out;
1044
	if (br->entries[0].flags.abort)
1045
		goto out;
1046 1047 1048 1049 1050 1051 1052

	/*
	 * 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);
1053
	printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1054 1055 1056 1057 1058
	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)
1059
			goto out;
1060

1061
		printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1062
			dump_insn(&x, sample->ip, buffer, len, NULL));
1063
		goto out;
1064 1065
	}
	for (off = 0; off <= end - start; off += ilen) {
1066 1067
		printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
				   dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1068 1069 1070
		if (ilen == 0)
			break;
	}
1071 1072
out:
	return printed;
1073
}
1074

1075 1076 1077
static int perf_sample__fprintf_addr(struct perf_sample *sample,
				     struct thread *thread,
				     struct perf_event_attr *attr, FILE *fp)
1078 1079
{
	struct addr_location al;
1080
	int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1081 1082

	if (!sample_addr_correlates_sym(attr))
1083
		goto out;
1084

1085
	thread__resolve(thread, &al, sample);
1086 1087

	if (PRINT_FIELD(SYM)) {
1088
		printed += fprintf(fp, " ");
1089
		if (PRINT_FIELD(SYMOFFSET))
1090
			printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1091
		else
1092
			printed += symbol__fprintf_symname(al.sym, fp);
1093 1094 1095
	}

	if (PRINT_FIELD(DSO)) {
1096 1097 1098
		printed += fprintf(fp, " (");
		printed += map__fprintf_dsoname(al.map, fp);
		printed += fprintf(fp, ")");
1099
	}
1100 1101
out:
	return printed;
1102 1103
}

1104 1105 1106 1107
static int perf_sample__fprintf_callindent(struct perf_sample *sample,
					   struct perf_evsel *evsel,
					   struct thread *thread,
					   struct addr_location *al, FILE *fp)
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
{
	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)
1142
		len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1143
	else if (ip)
1144
		len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1145 1146

	if (len < 0)
1147
		return len;
1148 1149 1150 1151 1152 1153 1154 1155 1156

	/*
	 * 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)
1157 1158 1159
		len += fprintf(fp, "%*s", spacing - len, "");

	return len;
1160 1161
}

1162 1163 1164 1165
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 已提交
1166
{
1167 1168
	int printed = 0;

A
Andi Kleen 已提交
1169
	if (PRINT_FIELD(INSNLEN))
1170
		printed += fprintf(fp, " ilen: %d", sample->insn_len);
A
Andi Kleen 已提交
1171 1172 1173
	if (PRINT_FIELD(INSN)) {
		int i;

1174
		printed += fprintf(fp, " insn:");
A
Andi Kleen 已提交
1175
		for (i = 0; i < sample->insn_len; i++)
1176
			printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
A
Andi Kleen 已提交
1177
	}
1178
	if (PRINT_FIELD(BRSTACKINSN))
1179 1180 1181
		printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);

	return printed;
A
Andi Kleen 已提交
1182 1183
}

1184 1185 1186 1187 1188
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)
1189 1190
{
	struct perf_event_attr *attr = &evsel->attr;
1191
	unsigned int type = output_type(attr->type);
1192
	bool print_srcline_last = false;
1193
	int printed = 0;
1194

1195
	if (PRINT_FIELD(CALLINDENT))
1196
		printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, fp);
1197

1198 1199
	/* print branch_from information */
	if (PRINT_FIELD(IP)) {
1200
		unsigned int print_opts = output[type].print_ip_opts;
1201
		struct callchain_cursor *cursor = NULL;
1202

1203
		if (symbol_conf.use_callchain && sample->callchain &&
1204
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1205
					      sample, NULL, NULL, scripting_max_stack) == 0)
1206
			cursor = &callchain_cursor;
1207 1208

		if (cursor == NULL) {
1209
			printed += fprintf(fp, " ");
1210
			if (print_opts & EVSEL__PRINT_SRCLINE) {
1211
				print_srcline_last = true;
1212
				print_opts &= ~EVSEL__PRINT_SRCLINE;
1213
			}
1214
		} else
1215
			printed += fprintf(fp, "\n");
1216

1217
		printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor, fp);
1218 1219 1220
	}

	/* print branch_to information */
1221 1222
	if (PRINT_FIELD(ADDR) ||
	    ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
1223
	     !output[type].user_set)) {
1224 1225
		printed += fprintf(fp, " => ");
		printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1226
	}
1227

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

1231 1232
	printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
	return printed + fprintf(fp, "\n");
1233 1234
}

1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
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}
};

1255
static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1256 1257 1258
{
	const char *chars = PERF_IP_FLAG_CHARS;
	const int n = strlen(PERF_IP_FLAG_CHARS);
1259 1260
	bool in_tx = flags & PERF_IP_FLAG_IN_TX;
	const char *name = NULL;
1261 1262 1263
	char str[33];
	int i, pos = 0;

1264 1265 1266 1267 1268 1269 1270
	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;
		}
	}

1271 1272 1273 1274 1275 1276 1277 1278 1279
	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;
1280 1281

	if (name)
1282 1283 1284
		return fprintf(fp, "  %-7s%4s ", name, in_tx ? "(x)" : "");

	return fprintf(fp, "  %-11s ", str);
1285 1286
}

1287 1288 1289 1290 1291 1292
struct printer_data {
	int line_no;
	bool hit_nul;
	bool is_printable;
};

1293 1294 1295
static int sample__fprintf_bpf_output(enum binary_printer_ops op,
				      unsigned int val,
				      void *extra, FILE *fp)
1296 1297 1298
{
	unsigned char ch = (unsigned char)val;
	struct printer_data *printer_data = extra;
1299
	int printed = 0;
1300 1301 1302

	switch (op) {
	case BINARY_PRINT_DATA_BEGIN:
1303
		printed += fprintf(fp, "\n");
1304 1305
		break;
	case BINARY_PRINT_LINE_BEGIN:
1306
		printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1307 1308 1309
						        "           ");
		break;
	case BINARY_PRINT_ADDR:
1310
		printed += fprintf(fp, " %04x:", val);
1311 1312
		break;
	case BINARY_PRINT_NUM_DATA:
1313
		printed += fprintf(fp, " %02x", val);
1314 1315
		break;
	case BINARY_PRINT_NUM_PAD:
1316
		printed += fprintf(fp, "   ");
1317 1318
		break;
	case BINARY_PRINT_SEP:
1319
		printed += fprintf(fp, "  ");
1320 1321 1322 1323 1324 1325
		break;
	case BINARY_PRINT_CHAR_DATA:
		if (printer_data->hit_nul && ch)
			printer_data->is_printable = false;

		if (!isprint(ch)) {
1326
			printed += fprintf(fp, "%c", '.');
1327 1328 1329 1330 1331 1332 1333 1334 1335

			if (!printer_data->is_printable)
				break;

			if (ch == '\0')
				printer_data->hit_nul = true;
			else
				printer_data->is_printable = false;
		} else {
1336
			printed += fprintf(fp, "%c", ch);
1337 1338 1339
		}
		break;
	case BINARY_PRINT_CHAR_PAD:
1340
		printed += fprintf(fp, " ");
1341 1342
		break;
	case BINARY_PRINT_LINE_END:
1343
		printed += fprintf(fp, "\n");
1344 1345 1346 1347 1348 1349
		printer_data->line_no++;
		break;
	case BINARY_PRINT_DATA_END:
	default:
		break;
	}
1350 1351

	return printed;
1352 1353
}

1354
static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1355 1356 1357
{
	unsigned int nr_bytes = sample->raw_size;
	struct printer_data printer_data = {0, false, true};
1358 1359
	int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
				      sample__fprintf_bpf_output, &printer_data, fp);
1360 1361

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

	return printed;
1365 1366
}

1367
static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1368 1369
{
	if (len > 0 && len < spacing)
1370 1371 1372
		return fprintf(fp, "%*s", spacing - len, "");

	return 0;
1373 1374
}

1375
static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1376
{
1377
	return perf_sample__fprintf_spacing(len, 34, fp);
1378 1379
}

1380
static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1381 1382 1383 1384 1385
{
	struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1386
		return 0;
1387

1388
	len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1389
		     data->ip, le64_to_cpu(data->payload));
1390
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1391 1392
}

1393
static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1394 1395 1396 1397 1398
{
	struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1399
		return 0;
1400

1401 1402 1403
	len = fprintf(fp, " hints: %#x extensions: %#x ",
		      data->hints, data->extensions);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1404 1405
}

1406
static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1407 1408 1409 1410 1411
{
	struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1412
		return 0;
1413

1414 1415 1416
	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);
1417 1418
}

1419
static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1420 1421 1422 1423 1424
{
	struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1425
		return 0;
1426

1427 1428
	len = fprintf(fp, " IP: %u ", data->ip);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1429 1430
}

1431
static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1432 1433 1434 1435 1436
{
	struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1437
		return 0;
1438

1439
	len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1440 1441
		     data->deepest_cstate, data->last_cstate,
		     data->wake_reason);
1442
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1443 1444
}

1445
static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1446 1447 1448 1449 1450 1451
{
	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))
1452
		return 0;
1453 1454

	freq = (le32_to_cpu(data->freq) + 500) / 1000;
1455
	len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1456 1457
	if (data->max_nonturbo) {
		percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1458
		len += fprintf(fp, "(%3u%%) ", percent);
1459
	}
1460
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1461 1462
}

1463 1464
static int perf_sample__fprintf_synth(struct perf_sample *sample,
				      struct perf_evsel *evsel, FILE *fp)
1465 1466
{
	switch (evsel->attr.config) {
1467
	case PERF_SYNTH_INTEL_PTWRITE:
1468
		return perf_sample__fprintf_synth_ptwrite(sample, fp);
1469
	case PERF_SYNTH_INTEL_MWAIT:
1470
		return perf_sample__fprintf_synth_mwait(sample, fp);
1471
	case PERF_SYNTH_INTEL_PWRE:
1472
		return perf_sample__fprintf_synth_pwre(sample, fp);
1473
	case PERF_SYNTH_INTEL_EXSTOP:
1474
		return perf_sample__fprintf_synth_exstop(sample, fp);
1475
	case PERF_SYNTH_INTEL_PWRX:
1476
		return perf_sample__fprintf_synth_pwrx(sample, fp);
1477
	case PERF_SYNTH_INTEL_CBR:
1478
		return perf_sample__fprintf_synth_cbr(sample, fp);
1479 1480 1481
	default:
		break;
	}
1482 1483

	return 0;
1484 1485
}

1486 1487 1488 1489 1490 1491
struct perf_script {
	struct perf_tool	tool;
	struct perf_session	*session;
	bool			show_task_events;
	bool			show_mmap_events;
	bool			show_switch_events;
1492
	bool			show_namespace_events;
1493
	bool			show_lost_events;
1494
	bool			show_round_events;
1495
	bool			allocated;
1496
	bool			per_event_dump;
1497 1498
	struct cpu_map		*cpus;
	struct thread_map	*threads;
1499
	int			name_width;
1500
	const char              *time_str;
1501 1502
	struct perf_time_interval *ptime_range;
	int			range_size;
1503
	int			range_num;
1504 1505
};

1506 1507 1508 1509 1510
static int perf_evlist__max_name_len(struct perf_evlist *evlist)
{
	struct perf_evsel *evsel;
	int max = 0;

1511
	evlist__for_each_entry(evlist, evsel) {
1512 1513 1514 1515 1516 1517 1518 1519
		int len = strlen(perf_evsel__name(evsel));

		max = MAX(len, max);
	}

	return max;
}

1520
static int data_src__fprintf(u64 data_src, FILE *fp)
J
Jiri Olsa 已提交
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
{
	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;

1534
	return fprintf(fp, "%-*s", maxlen, out);
J
Jiri Olsa 已提交
1535 1536
}

1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
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,
1553
				   PERF_RECORD_SAMPLE, mctx->fp);
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
	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,
1567
				   PERF_RECORD_SAMPLE, mctx->fp);
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
	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,
1603 1604
				       sample->cpu,
				       &rt_stat);
1605 1606 1607 1608 1609 1610 1611
	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,
J
Jin Yao 已提交
1612 1613
						      NULL,
						      &rt_stat);
1614 1615 1616 1617 1618
		}
		evsel_script(evsel->leader)->gnum = 0;
	}
}

1619
static void process_event(struct perf_script *script,
1620
			  struct perf_sample *sample, struct perf_evsel *evsel,
1621 1622
			  struct addr_location *al,
			  struct machine *machine)
1623
{
1624
	struct thread *thread = al->thread;
1625
	struct perf_event_attr *attr = &evsel->attr;
1626
	unsigned int type = output_type(attr->type);
1627 1628
	struct perf_evsel_script *es = evsel->priv;
	FILE *fp = es->fp;
1629

1630
	if (output[type].fields == 0)
1631 1632
		return;

1633 1634
	++es->samples;

1635 1636
	perf_sample__fprintf_start(sample, thread, evsel,
				   PERF_RECORD_SAMPLE, fp);
1637

J
Jiri Olsa 已提交
1638
	if (PRINT_FIELD(PERIOD))
1639
		fprintf(fp, "%10" PRIu64 " ", sample->period);
J
Jiri Olsa 已提交
1640

1641 1642
	if (PRINT_FIELD(EVNAME)) {
		const char *evname = perf_evsel__name(evsel);
1643 1644 1645 1646

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

1647
		fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
1648 1649
	}

1650
	if (print_flags)
1651
		perf_sample__fprintf_flags(sample->flags, fp);
1652

1653
	if (is_bts_event(attr)) {
1654
		perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
1655 1656 1657
		return;
	}

1658 1659 1660 1661
	if (PRINT_FIELD(TRACE)) {
		event_format__fprintf(evsel->tp_format, sample->cpu,
				      sample->raw_data, sample->raw_size, fp);
	}
1662 1663

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

1666
	if (PRINT_FIELD(ADDR))
1667
		perf_sample__fprintf_addr(sample, thread, attr, fp);
1668

1669
	if (PRINT_FIELD(DATA_SRC))
1670
		data_src__fprintf(sample->data_src, fp);
1671 1672

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

1675
	if (PRINT_FIELD(IP)) {
1676
		struct callchain_cursor *cursor = NULL;
1677

1678
		if (symbol_conf.use_callchain && sample->callchain &&
1679
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1680
					      sample, NULL, NULL, scripting_max_stack) == 0)
1681
			cursor = &callchain_cursor;
1682

1683 1684
		fputc(cursor ? '\n' : ' ', fp);
		sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor, fp);
1685 1686
	}

1687
	if (PRINT_FIELD(IREGS))
1688
		perf_sample__fprintf_iregs(sample, attr, fp);
1689

A
Andi Kleen 已提交
1690
	if (PRINT_FIELD(UREGS))
1691
		perf_sample__fprintf_uregs(sample, attr, fp);
A
Andi Kleen 已提交
1692

1693
	if (PRINT_FIELD(BRSTACK))
1694
		perf_sample__fprintf_brstack(sample, thread, attr, fp);
1695
	else if (PRINT_FIELD(BRSTACKSYM))
1696
		perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
1697
	else if (PRINT_FIELD(BRSTACKOFF))
1698
		perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
1699

1700
	if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
1701 1702
		perf_sample__fprintf_bpf_output(sample, fp);
	perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1703 1704

	if (PRINT_FIELD(PHYS_ADDR))
1705 1706
		fprintf(fp, "%16" PRIx64, sample->phys_addr);
	fprintf(fp, "\n");
1707 1708 1709

	if (PRINT_FIELD(METRIC))
		perf_sample__fprint_metric(script, thread, evsel, sample, fp);
1710 1711
}

T
Tom Zanussi 已提交
1712 1713
static struct scripting_ops	*scripting_ops;

1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747
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));
		}
	}
}

1748 1749 1750 1751
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);
1752 1753
	else
		__process_stat(counter, tstamp);
1754 1755 1756 1757 1758 1759 1760 1761
}

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

T
Tom Zanussi 已提交
1762 1763
static void setup_scripting(void)
{
1764
	setup_perl_scripting();
1765
	setup_python_scripting();
T
Tom Zanussi 已提交
1766 1767
}

1768 1769
static int flush_scripting(void)
{
1770
	return scripting_ops ? scripting_ops->flush_script() : 0;
1771 1772
}

T
Tom Zanussi 已提交
1773 1774
static int cleanup_scripting(void)
{
1775
	pr_debug("\nperf script stopped\n");
1776

1777
	return scripting_ops ? scripting_ops->stop_script() : 0;
T
Tom Zanussi 已提交
1778 1779
}

1780
static int process_sample_event(struct perf_tool *tool,
1781
				union perf_event *event,
1782
				struct perf_sample *sample,
1783
				struct perf_evsel *evsel,
1784
				struct machine *machine)
F
Frederic Weisbecker 已提交
1785
{
1786
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
1787
	struct addr_location al;
F
Frederic Weisbecker 已提交
1788

1789 1790
	if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
					  sample->time)) {
1791
		return 0;
1792
	}
1793

1794 1795 1796 1797 1798 1799
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
1800
		}
1801 1802
		last_timestamp = sample->time;
		return 0;
F
Frederic Weisbecker 已提交
1803
	}
1804

1805
	if (machine__resolve(machine, &al, sample) < 0) {
1806 1807 1808 1809 1810 1811
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
		return -1;
	}

	if (al.filtered)
1812
		goto out_put;
1813

1814
	if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
1815
		goto out_put;
1816

1817 1818 1819
	if (scripting_ops)
		scripting_ops->process_event(event, sample, evsel, &al);
	else
1820
		process_event(scr, sample, evsel, &al, machine);
1821

1822 1823
out_put:
	addr_location__put(&al);
F
Frederic Weisbecker 已提交
1824 1825 1826
	return 0;
}

1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841
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);

1842 1843
	if (evsel->attr.type >= PERF_TYPE_MAX &&
	    evsel->attr.type != PERF_TYPE_SYNTH)
1844 1845
		return 0;

1846
	evlist__for_each_entry(evlist, pos) {
1847 1848 1849 1850 1851 1852
		if (pos->attr.type == evsel->attr.type && pos != evsel)
			return 0;
	}

	set_print_ip_opts(&evsel->attr);

1853 1854 1855 1856
	if (evsel->attr.sample_type)
		err = perf_evsel__check_attr(evsel, scr->session);

	return err;
1857 1858
}

1859 1860 1861 1862 1863 1864 1865 1866
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;
1867
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884
	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;
	}
1885 1886
	perf_sample__fprintf_start(sample, thread, evsel,
				   PERF_RECORD_COMM, stdout);
1887 1888 1889
	perf_event__fprintf(event, stdout);
	ret = 0;
out:
1890
	thread__put(thread);
1891 1892 1893
	return ret;
}

1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920
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;
	}
1921 1922
	perf_sample__fprintf_start(sample, thread, evsel,
				   PERF_RECORD_NAMESPACES, stdout);
1923 1924 1925 1926 1927 1928 1929
	perf_event__fprintf(event, stdout);
	ret = 0;
out:
	thread__put(thread);
	return ret;
}

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

	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;
	}
1955 1956
	perf_sample__fprintf_start(sample, thread, evsel,
				   PERF_RECORD_FORK, stdout);
1957
	perf_event__fprintf(event, stdout);
1958
	thread__put(thread);
1959 1960 1961 1962 1963 1964 1965 1966

	return 0;
}
static int process_exit_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
1967
	int err = 0;
1968 1969 1970
	struct thread *thread;
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
1971
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981

	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;
1982 1983
		sample->tid = event->fork.tid;
		sample->pid = event->fork.pid;
1984
	}
1985 1986
	perf_sample__fprintf_start(sample, thread, evsel,
				   PERF_RECORD_EXIT, stdout);
1987 1988 1989
	perf_event__fprintf(event, stdout);

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

1992 1993
	thread__put(thread);
	return err;
1994 1995
}

1996 1997 1998 1999 2000 2001 2002 2003
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;
2004
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020

	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;
	}
2021 2022
	perf_sample__fprintf_start(sample, thread, evsel,
				   PERF_RECORD_MMAP, stdout);
2023
	perf_event__fprintf(event, stdout);
2024
	thread__put(thread);
2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035
	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;
2036
	struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052

	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;
	}
2053 2054
	perf_sample__fprintf_start(sample, thread, evsel,
				   PERF_RECORD_MMAP2, stdout);
2055
	perf_event__fprintf(event, stdout);
2056
	thread__put(thread);
2057 2058 2059
	return 0;
}

2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
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;
	}

2080 2081
	perf_sample__fprintf_start(sample, thread, evsel,
				   PERF_RECORD_SWITCH, stdout);
2082 2083 2084 2085 2086
	perf_event__fprintf(event, stdout);
	thread__put(thread);
	return 0;
}

2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109
static int
process_lost_event(struct perf_tool *tool,
		   union perf_event *event,
		   struct perf_sample *sample,
		   struct machine *machine)
{
	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);
	struct thread *thread;

	thread = machine__findnew_thread(machine, sample->pid,
					 sample->tid);
	if (thread == NULL)
		return -1;

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

2110 2111 2112 2113 2114 2115 2116 2117 2118 2119
static int
process_finished_round_event(struct perf_tool *tool __maybe_unused,
			     union perf_event *event,
			     struct ordered_events *oe __maybe_unused)

{
	perf_event__fprintf(event, stdout);
	return 0;
}

2120
static void sig_handler(int sig __maybe_unused)
2121 2122 2123 2124
{
	session_done = 1;
}

2125 2126 2127 2128 2129 2130 2131 2132
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;
2133
		perf_evsel_script__delete(evsel->priv);
2134 2135 2136 2137 2138 2139 2140 2141 2142
		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) {
2143 2144 2145 2146 2147 2148 2149 2150 2151 2152
		/*
		 * 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;

2153
		evsel->priv = perf_evsel_script__new(evsel, script->session->data);
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
		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;
2168
	static struct perf_evsel_script es_stdout;
2169 2170 2171 2172

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

2173 2174
	es_stdout.fp = stdout;

2175
	evlist__for_each_entry(script->session->evlist, evsel)
2176
		evsel->priv = &es_stdout;
2177 2178 2179 2180

	return 0;
}

2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193
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;
	}
}

2194
static int __cmd_script(struct perf_script *script)
F
Frederic Weisbecker 已提交
2195
{
2196 2197
	int ret;

2198 2199
	signal(SIGINT, sig_handler);

2200 2201 2202 2203 2204 2205
	/* 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;
	}
2206 2207 2208 2209
	if (script->show_mmap_events) {
		script->tool.mmap = process_mmap_event;
		script->tool.mmap2 = process_mmap2_event;
	}
2210 2211
	if (script->show_switch_events)
		script->tool.context_switch = process_switch_event;
2212 2213
	if (script->show_namespace_events)
		script->tool.namespaces = process_namespaces_event;
2214 2215
	if (script->show_lost_events)
		script->tool.lost = process_lost_event;
2216 2217 2218 2219
	if (script->show_round_events) {
		script->tool.ordered_events = false;
		script->tool.finished_round = process_finished_round_event;
	}
2220

2221 2222 2223 2224 2225
	if (perf_script__setup_per_event_dump(script)) {
		pr_err("Couldn't create the per event dump files\n");
		return -1;
	}

2226
	ret = perf_session__process_events(script->session);
2227

2228
	if (script->per_event_dump)
2229
		perf_script__exit_per_event_dump_stats(script);
2230

2231
	if (debug_mode)
2232
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2233 2234

	return ret;
F
Frederic Weisbecker 已提交
2235 2236
}

T
Tom Zanussi 已提交
2237 2238 2239 2240 2241 2242
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
	char			spec[0];
};

2243
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280

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;

2281
	s = script_spec__new(spec, ops);
T
Tom Zanussi 已提交
2282 2283
	if (!s)
		return -1;
2284 2285
	else
		script_spec__add(s);
T
Tom Zanussi 已提交
2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304

	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 "
2305
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
2306 2307 2308 2309 2310 2311 2312

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

	fprintf(stderr, "\n");
}

2313 2314
static int parse_scriptname(const struct option *opt __maybe_unused,
			    const char *str, int unset __maybe_unused)
T
Tom Zanussi 已提交
2315 2316 2317 2318 2319
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

2320
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
2321
		list_available_languages();
2322
		exit(0);
T
Tom Zanussi 已提交
2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341
	}

	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;
2342
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358
		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;
}

2359 2360
static int parse_output_fields(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused)
2361
{
2362
	char *tok, *strtok_saveptr = NULL;
2363
	int i, imax = ARRAY_SIZE(all_output_options);
2364
	int j;
2365 2366
	int rc = 0;
	char *str = strdup(arg);
2367
	int type = -1;
2368
	enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2369 2370 2371 2372

	if (!str)
		return -ENOMEM;

2373 2374 2375
	/* 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.
2376
	 */
2377 2378 2379 2380 2381 2382 2383 2384 2385 2386
	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;
2387 2388
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
2389 2390
		else if (!strcmp(str, "break"))
			type = PERF_TYPE_BREAKPOINT;
2391 2392
		else if (!strcmp(str, "synth"))
			type = OUTPUT_TYPE_SYNTH;
2393 2394
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
2395 2396
			rc = -EINVAL;
			goto out;
2397 2398 2399 2400 2401 2402 2403 2404
		}

		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;
2405
		output[type].wildcard_set = false;
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415

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

2416 2417 2418 2419
		/* Don't override defaults for +- */
		if (strchr(str, '+') || strchr(str, '-'))
			goto parse;

2420 2421 2422
		if (output_set_by_user())
			pr_warning("Overriding previous field request for all events.\n");

2423
		for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2424 2425
			output[j].fields = 0;
			output[j].user_set = true;
2426
			output[j].wildcard_set = true;
2427
		}
2428 2429
	}

2430
parse:
2431
	for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447
		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;
		}

2448
		for (i = 0; i < imax; ++i) {
2449
			if (strcmp(tok, all_output_options[i].str) == 0)
2450 2451
				break;
		}
2452
		if (i == imax && strcmp(tok, "flags") == 0) {
2453
			print_flags = change == REMOVE ? false : true;
2454 2455
			continue;
		}
2456
		if (i == imax) {
2457
			fprintf(stderr, "Invalid field requested.\n");
2458
			rc = -EINVAL;
2459
			goto out;
2460 2461
		}

2462 2463 2464 2465
		if (type == -1) {
			/* add user option to all events types for
			 * which it is valid
			 */
2466
			for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2467 2468 2469
				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));
2470 2471 2472 2473 2474 2475
				} else {
					if (change == REMOVE)
						output[j].fields &= ~all_output_options[i].field;
					else
						output[j].fields |= all_output_options[i].field;
				}
2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486
			}
		} 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;
		}
2487 2488
	}

2489 2490 2491 2492 2493 2494
	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));
		}
	}
2495
	goto out;
2496

2497 2498 2499
out_badmix:
	fprintf(stderr, "Cannot mix +-field with overridden fields\n");
	rc = -EINVAL;
2500
out:
2501 2502 2503 2504
	free(str);
	return rc;
}

2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517
#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)))
2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529


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

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

2530
static LIST_HEAD(script_descs);
2531 2532 2533 2534 2535

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

2536
	if (s != NULL && name)
2537 2538 2539 2540 2541 2542 2543
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
2544 2545 2546
	zfree(&s->name);
	zfree(&s->half_liner);
	zfree(&s->args);
2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573
	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)
2574
		return NULL;
2575 2576 2577 2578 2579 2580

	script_desc__add(s);

	return s;
}

2581
static const char *ends_with(const char *str, const char *suffix)
2582 2583
{
	size_t suffix_len = strlen(suffix);
2584
	const char *p = str;
2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635

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

2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653
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;
}

2654 2655 2656
static int list_available_scripts(const struct option *opt __maybe_unused,
				  const char *s __maybe_unused,
				  int unset __maybe_unused)
2657
{
2658
	struct dirent *script_dirent, *lang_dirent;
2659 2660 2661 2662 2663 2664 2665 2666
	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;

2667
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2668 2669

	scripts_dir = opendir(scripts_path);
2670 2671 2672 2673 2674 2675 2676
	if (!scripts_dir) {
		fprintf(stdout,
			"open(%s) failed.\n"
			"Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
			scripts_path);
		exit(-1);
	}
2677

2678
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2679 2680
		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			  lang_dirent->d_name);
2681 2682 2683 2684
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

2685 2686
		for_each_script(lang_path, lang_dir, script_dirent) {
			script_root = get_script_root(script_dirent, REPORT_SUFFIX);
2687
			if (script_root) {
2688
				desc = script_desc__findnew(script_root);
2689 2690
				scnprintf(script_path, MAXPATHLEN, "%s/%s",
					  lang_path, script_dirent->d_name);
2691
				read_script_info(desc, script_path);
2692
				free(script_root);
2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707
			}
		}
	}

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

2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725
/*
 * 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;

2726
	scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750

	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;
2751
			evlist__for_each_entry(session->evlist, pos) {
2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768
				if (!strcmp(perf_evsel__name(pos), evname)) {
					match = 1;
					break;
				}
			}

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

	fclose(fp);
	return 0;
}

2769 2770 2771 2772 2773 2774 2775 2776 2777
/*
 * 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)
{
2778
	struct dirent *script_dirent, *lang_dirent;
2779
	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
2780
	DIR *scripts_dir, *lang_dir;
2781
	struct perf_session *session;
2782
	struct perf_data data = {
J
Jiri Olsa 已提交
2783 2784 2785 2786
		.file      = {
			.path = input_name,
		},
		.mode      = PERF_DATA_MODE_READ,
2787
	};
2788 2789 2790
	char *temp;
	int i = 0;

2791
	session = perf_session__new(&data, false, NULL);
2792 2793 2794
	if (!session)
		return -1;

2795
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2796 2797

	scripts_dir = opendir(scripts_path);
2798 2799
	if (!scripts_dir) {
		perf_session__delete(session);
2800
		return -1;
2801
	}
2802

2803
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2804 2805
		scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
			  lang_dirent->d_name);
2806
#ifndef HAVE_LIBPERL_SUPPORT
2807 2808 2809
		if (strstr(lang_path, "perl"))
			continue;
#endif
2810
#ifndef HAVE_LIBPYTHON_SUPPORT
2811 2812 2813 2814 2815 2816 2817 2818
		if (strstr(lang_path, "python"))
			continue;
#endif

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

2819
		for_each_script(lang_path, lang_dir, script_dirent) {
2820
			/* Skip those real time scripts: xxxtop.p[yl] */
2821
			if (strstr(script_dirent->d_name, "top."))
2822 2823
				continue;
			sprintf(scripts_path_array[i], "%s/%s", lang_path,
2824 2825
				script_dirent->d_name);
			temp = strchr(script_dirent->d_name, '.');
2826
			snprintf(scripts_array[i],
2827 2828
				(temp - script_dirent->d_name) + 1,
				"%s", script_dirent->d_name);
2829 2830 2831 2832 2833

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

2834 2835
			i++;
		}
2836
		closedir(lang_dir);
2837 2838
	}

2839 2840
	closedir(scripts_dir);
	perf_session__delete(session);
2841 2842 2843
	return i;
}

2844 2845
static char *get_script_path(const char *script_root, const char *suffix)
{
2846
	struct dirent *script_dirent, *lang_dirent;
2847 2848 2849 2850
	char scripts_path[MAXPATHLEN];
	char script_path[MAXPATHLEN];
	DIR *scripts_dir, *lang_dir;
	char lang_path[MAXPATHLEN];
2851
	char *__script_root;
2852

2853
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2854 2855 2856 2857 2858

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

2859
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2860 2861
		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			  lang_dirent->d_name);
2862 2863 2864 2865
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

2866 2867
		for_each_script(lang_path, lang_dir, script_dirent) {
			__script_root = get_script_root(script_dirent, suffix);
2868 2869
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
2870 2871
				closedir(lang_dir);
				closedir(scripts_dir);
2872 2873
				scnprintf(script_path, MAXPATHLEN, "%s/%s",
					  lang_path, script_dirent->d_name);
2874
				return strdup(script_path);
2875 2876 2877
			}
			free(__script_root);
		}
2878
		closedir(lang_dir);
2879
	}
2880
	closedir(scripts_dir);
2881

2882
	return NULL;
2883 2884
}

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

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

2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925
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 已提交
2926

2927 2928 2929 2930 2931
	system_wide = (argc == 0);

	return 0;
}

2932 2933 2934 2935 2936 2937 2938
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) &&
2939
		    (sample_type & PERF_SAMPLE_STACK_USER)) {
2940
			callchain_param.record_mode = CALLCHAIN_DWARF;
2941 2942
			dwarf_callchain_users = true;
		} else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
2943 2944 2945 2946 2947 2948
			callchain_param.record_mode = CALLCHAIN_LBR;
		else
			callchain_param.record_mode = CALLCHAIN_FP;
	}
}

2949 2950 2951 2952 2953 2954 2955
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;

2956
	evlist__for_each_entry(session->evlist, counter) {
2957 2958 2959 2960 2961 2962 2963 2964
		perf_stat_process_counter(&stat_config, counter);
		process_stat(counter, round->time);
	}

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

2965 2966 2967 2968 2969 2970 2971 2972
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;
}

2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029
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);
}

3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048
#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

3049
int cmd_script(int argc, const char **argv)
3050 3051
{
	bool show_full_info = false;
3052 3053
	bool header = false;
	bool header_only = false;
3054
	bool script_started = false;
3055 3056 3057
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
	struct perf_session *session;
3058
	struct itrace_synth_opts itrace_synth_opts = { .set = false, };
3059 3060
	char *script_path = NULL;
	const char **__argv;
3061
	int i, j, err = 0;
3062 3063 3064 3065 3066 3067
	struct perf_script script = {
		.tool = {
			.sample		 = process_sample_event,
			.mmap		 = perf_event__process_mmap,
			.mmap2		 = perf_event__process_mmap2,
			.comm		 = perf_event__process_comm,
3068
			.namespaces	 = perf_event__process_namespaces,
3069 3070
			.exit		 = perf_event__process_exit,
			.fork		 = perf_event__process_fork,
3071
			.attr		 = process_attr,
3072
			.event_update   = perf_event__process_event_update,
3073
			.tracing_data	 = perf_event__process_tracing_data,
3074
			.feature	 = perf_event__process_feature,
3075
			.build_id	 = perf_event__process_build_id,
3076
			.id_index	 = perf_event__process_id_index,
3077
			.auxtrace_info	 = perf_script__process_auxtrace_info,
3078 3079
			.auxtrace	 = perf_event__process_auxtrace,
			.auxtrace_error	 = perf_event__process_auxtrace_error,
3080 3081
			.stat		 = perf_event__process_stat_event,
			.stat_round	 = process_stat_round_event,
3082
			.stat_config	 = process_stat_config_event,
3083 3084
			.thread_map	 = process_thread_map_event,
			.cpu_map	 = process_cpu_map_event,
3085
			.ordered_events	 = true,
3086 3087 3088
			.ordering_requires_timestamps = true,
		},
	};
3089
	struct perf_data data = {
3090 3091
		.mode = PERF_DATA_MODE_READ,
	};
3092
	const struct option options[] = {
F
Frederic Weisbecker 已提交
3093 3094
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
3095
	OPT_INCR('v', "verbose", &verbose,
3096
		 "be more verbose (show symbol address, etc)"),
3097
	OPT_BOOLEAN('L', "Latency", &latency_format,
3098
		    "show latency attributes (irqs/preemption disabled, etc)"),
3099 3100
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
T
Tom Zanussi 已提交
3101 3102 3103 3104
	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",
3105
		   "generate perf-script.xx script in specified language"),
3106
	OPT_STRING('i', "input", &input_name, "file", "input file name"),
3107 3108
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
3109 3110
	OPT_BOOLEAN(0, "header", &header, "Show data header."),
	OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3111 3112 3113 3114 3115 3116
	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"),
3117 3118 3119
	OPT_CALLBACK(0, "symfs", NULL, "directory",
		     "Look for files with symbols relative to this directory",
		     symbol__config_symfs),
3120
	OPT_CALLBACK('F', "fields", NULL, "str",
3121
		     "comma separated output fields prepend with 'type:'. "
3122
		     "+field to add and -field to remove."
3123
		     "Valid types: hw,sw,trace,raw,synth. "
3124
		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
A
Andi Kleen 已提交
3125
		     "addr,symoff,period,iregs,uregs,brstack,brstacksym,flags,"
3126
		     "bpf-output,callindent,insn,insnlen,brstackinsn,synth,phys_addr",
3127
		     parse_output_fields),
3128
	OPT_BOOLEAN('a', "all-cpus", &system_wide,
3129
		    "system-wide collection from all CPUs"),
3130 3131
	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
		   "only consider these symbols"),
3132 3133
	OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
		   "Stop display of callgraph at these symbols"),
3134
	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3135 3136
	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only display events for these comms"),
3137 3138 3139 3140
	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"),
3141 3142 3143
	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. "
3144
		     "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3145 3146
	OPT_BOOLEAN('I', "show-info", &show_full_info,
		    "display extended information from perf.data file"),
3147 3148
	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
		    "Show the path of [kernel.kallsyms]"),
3149 3150
	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
		    "Show the fork/comm/exit events"),
3151 3152
	OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
		    "Show the mmap events"),
3153 3154
	OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
		    "Show context switch events (if recorded)"),
3155 3156
	OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
		    "Show namespace events (if recorded)"),
3157 3158
	OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
		    "Show lost events (if recorded)"),
3159 3160
	OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
		    "Show round events (if recorded)"),
3161 3162
	OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
		    "Dump trace output to files named by the monitored events"),
3163
	OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3164 3165
	OPT_INTEGER(0, "max-blocks", &max_blocks,
		    "Maximum number of code blocks to dump with brstackinsn"),
3166 3167
	OPT_BOOLEAN(0, "ns", &nanosecs,
		    "Use 9 decimal places when displaying time"),
3168 3169 3170
	OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
			    "Instruction Tracing options",
			    itrace_parse_synth_opts),
3171 3172
	OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
			"Show full source file name path for source lines"),
3173 3174 3175 3176
	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
			"Enable symbol demangling"),
	OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
			"Enable kernel symbol demangling"),
3177 3178
	OPT_STRING(0, "time", &script.time_str, "str",
		   "Time span of interest (start,stop)"),
3179 3180
	OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
		    "Show inline function"),
3181
	OPT_END()
3182
	};
3183 3184
	const char * const script_subcommands[] = { "record", "report", NULL };
	const char *script_usage[] = {
3185 3186 3187 3188 3189 3190 3191
		"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
	};
3192

3193 3194
	perf_set_singlethreaded();

3195 3196
	setup_scripting();

3197
	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3198 3199
			     PARSE_OPT_STOP_AT_NON_OPTION);

J
Jiri Olsa 已提交
3200 3201
	data.file.path = input_name;
	data.force     = symbol_conf.force;
3202

3203 3204 3205
	if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
		rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
		if (!rec_script_path)
3206
			return cmd_record(argc, argv);
3207 3208
	}

3209 3210 3211
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
3212
			fprintf(stderr,
3213
				"Please specify a valid report script"
3214
				"(see 'perf script -l' for listing)\n");
3215 3216 3217 3218
			return -1;
		}
	}

3219 3220 3221 3222
	if (itrace_synth_opts.callchain &&
	    itrace_synth_opts.callchain_sz > scripting_max_stack)
		scripting_max_stack = itrace_synth_opts.callchain_sz;

3223
	/* make sure PERF_EXEC_PATH is set for scripts */
3224
	set_argv_exec_path(get_argv_exec_path());
3225

3226
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
3227
		int live_pipe[2];
3228
		int rep_args;
3229 3230
		pid_t pid;

3231 3232 3233 3234
		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) {
3235 3236
			usage_with_options_msg(script_usage, options,
				"Couldn't find script `%s'\n\n See perf"
3237
				" script -l for available scripts.\n", argv[0]);
3238 3239
		}

3240 3241 3242 3243 3244 3245 3246 3247
		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) {
3248 3249
				usage_with_options_msg(script_usage, options,
					"`%s' script requires options."
3250
					"\n\n See perf script -l for available "
3251 3252
					"scripts and options.\n", argv[0]);
			}
3253 3254 3255 3256
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
3257
			return -1;
3258 3259 3260 3261 3262
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
3263
			return -1;
3264 3265 3266
		}

		if (!pid) {
3267 3268
			j = 0;

3269 3270 3271
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

3272 3273 3274
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
3275 3276 3277 3278
				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
					err = -1;
					goto out;
				}
3279
			}
3280 3281

			__argv = malloc((argc + 6) * sizeof(const char *));
3282 3283 3284 3285 3286
			if (!__argv) {
				pr_err("malloc failed\n");
				err = -ENOMEM;
				goto out;
			}
3287

3288 3289 3290 3291 3292 3293 3294 3295 3296 3297
			__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;
3298 3299

			execvp("/bin/sh", (char **)__argv);
3300
			free(__argv);
3301 3302 3303 3304 3305 3306
			exit(-1);
		}

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

3307
		__argv = malloc((argc + 4) * sizeof(const char *));
3308 3309 3310 3311 3312 3313
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

3314 3315 3316 3317 3318 3319 3320 3321
		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;
3322 3323

		execvp("/bin/sh", (char **)__argv);
3324
		free(__argv);
3325 3326 3327
		exit(-1);
	}

3328 3329 3330 3331
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
3332

3333 3334
	if (script_path) {
		j = 0;
3335

3336 3337
		if (!rec_script_path)
			system_wide = false;
3338 3339 3340 3341 3342 3343
		else if (!system_wide) {
			if (have_cmd(argc - 1, &argv[1]) != 0) {
				err = -1;
				goto out;
			}
		}
3344

3345
		__argv = malloc((argc + 2) * sizeof(const char *));
3346 3347 3348 3349 3350 3351
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

3352 3353 3354 3355
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
3356
		for (i = 2; i < argc; i++)
3357 3358
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
3359 3360

		execvp("/bin/sh", (char **)__argv);
3361
		free(__argv);
3362 3363
		exit(-1);
	}
T
Tom Zanussi 已提交
3364

3365 3366
	if (!script_name)
		setup_pager();
F
Frederic Weisbecker 已提交
3367

3368
	session = perf_session__new(&data, false, &script.tool);
3369
	if (session == NULL)
3370
		return -1;
3371

3372
	if (header || header_only) {
3373
		script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3374 3375
		perf_session__fprintf_info(session, stdout, show_full_info);
		if (header_only)
3376
			goto out_delete;
3377
	}
3378 3379
	if (show_full_info)
		script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3380

3381
	if (symbol__init(&session->header.env) < 0)
3382 3383
		goto out_delete;

3384
	script.session = session;
3385
	script__setup_sample_type(&script);
3386

3387 3388 3389
	if (output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT)
		itrace_synth_opts.thread_stack = true;

3390 3391
	session->itrace_synth_opts = &itrace_synth_opts;

3392
	if (cpu_list) {
3393 3394 3395
		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
		if (err < 0)
			goto out_delete;
3396
		itrace_synth_opts.cpu_bitmap = cpu_bitmap;
3397 3398
	}

3399
	if (!no_callchain)
3400 3401 3402 3403
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

3404 3405
	if (session->tevent.pevent &&
	    pevent_set_function_resolver(session->tevent.pevent,
3406 3407 3408
					 machine__resolve_kernel_addr,
					 &session->machines.host) < 0) {
		pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
3409 3410
		err = -1;
		goto out_delete;
3411 3412
	}

T
Tom Zanussi 已提交
3413 3414
	if (generate_script_lang) {
		struct stat perf_stat;
3415 3416
		int input;

3417
		if (output_set_by_user()) {
3418 3419
			fprintf(stderr,
				"custom fields not supported for generated scripts");
3420 3421
			err = -EINVAL;
			goto out_delete;
3422
		}
T
Tom Zanussi 已提交
3423

J
Jiri Olsa 已提交
3424
		input = open(data.file.path, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
3425
		if (input < 0) {
3426
			err = -errno;
T
Tom Zanussi 已提交
3427
			perror("failed to open file");
3428
			goto out_delete;
T
Tom Zanussi 已提交
3429 3430 3431 3432 3433
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
3434
			goto out_delete;
T
Tom Zanussi 已提交
3435 3436 3437 3438
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
3439
			goto out_delete;
T
Tom Zanussi 已提交
3440 3441 3442 3443 3444
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
3445 3446
			err = -ENOENT;
			goto out_delete;
T
Tom Zanussi 已提交
3447 3448
		}

J
Jiri Olsa 已提交
3449
		err = scripting_ops->generate_script(session->tevent.pevent,
3450
						     "perf-script");
3451
		goto out_delete;
T
Tom Zanussi 已提交
3452 3453 3454
	}

	if (script_name) {
3455
		err = scripting_ops->start_script(script_name, argc, argv);
T
Tom Zanussi 已提交
3456
		if (err)
3457
			goto out_delete;
3458
		pr_debug("perf script started with script %s\n\n", script_name);
3459
		script_started = true;
T
Tom Zanussi 已提交
3460 3461
	}

3462 3463 3464

	err = perf_session__check_output_opt(session);
	if (err < 0)
3465
		goto out_delete;
3466

3467 3468 3469 3470 3471 3472 3473
	script.ptime_range = perf_time__range_alloc(script.time_str,
						    &script.range_size);
	if (!script.ptime_range) {
		err = -ENOMEM;
		goto out_delete;
	}

3474
	/* needs to be parsed after looking up reference time */
3475 3476 3477
	if (perf_time__parse_str(script.ptime_range, script.time_str) != 0) {
		if (session->evlist->first_sample_time == 0 &&
		    session->evlist->last_sample_time == 0) {
3478 3479 3480
			pr_err("HINT: no first/last sample time found in perf data.\n"
			       "Please use latest perf binary to execute 'perf record'\n"
			       "(if '--buildid-all' is enabled, please set '--timestamp-boundary').\n");
3481 3482 3483 3484 3485
			err = -EINVAL;
			goto out_delete;
		}

		script.range_num = perf_time__percent_parse_str(
3486
					script.ptime_range, script.range_size,
3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497
					script.time_str,
					session->evlist->first_sample_time,
					session->evlist->last_sample_time);

		if (script.range_num < 0) {
			pr_err("Invalid time string\n");
			err = -EINVAL;
			goto out_delete;
		}
	} else {
		script.range_num = 1;
3498 3499
	}

3500
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
3501

3502 3503
	flush_scripting();

3504
out_delete:
3505 3506
	zfree(&script.ptime_range);

3507
	perf_evlist__free_stats(session->evlist);
3508
	perf_session__delete(session);
3509 3510 3511

	if (script_started)
		cleanup_scripting();
T
Tom Zanussi 已提交
3512 3513
out:
	return err;
F
Frederic Weisbecker 已提交
3514
}