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

4
#include "util/counts.h"
A
Andrea Gelmini 已提交
5
#include "util/debug.h"
6
#include "util/dso.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"
13
#include "util/map.h"
14
#include "util/srcline.h"
F
Frederic Weisbecker 已提交
15 16
#include "util/symbol.h"
#include "util/thread.h"
I
Ingo Molnar 已提交
17
#include "util/trace-event.h"
18 19
#include "util/evlist.h"
#include "util/evsel.h"
20
#include "util/evsel_fprintf.h"
21
#include "util/evswitch.h"
22
#include "util/sort.h"
23
#include "util/data.h"
24
#include "util/auxtrace.h"
25 26 27
#include "util/cpumap.h"
#include "util/thread_map.h"
#include "util/stat.h"
28
#include "util/color.h"
29
#include "util/string2.h"
30
#include "util/thread-stack.h"
31
#include "util/time-utils.h"
32
#include "util/path.h"
K
Kan Liang 已提交
33
#include "util/event.h"
34
#include "ui/ui.h"
35
#include "print_binary.h"
36
#include "archinsn.h"
37
#include <linux/bitmap.h>
38
#include <linux/kernel.h>
39
#include <linux/stringify.h>
40
#include <linux/time64.h>
41
#include <linux/zalloc.h>
42
#include <sys/utsname.h>
43
#include "asm/bug.h"
J
Jiri Olsa 已提交
44
#include "util/mem-events.h"
45
#include "util/dump-insn.h"
46
#include <dirent.h>
47
#include <errno.h>
48
#include <inttypes.h>
49
#include <signal.h>
50
#include <sys/param.h>
51 52
#include <sys/types.h>
#include <sys/stat.h>
53
#include <fcntl.h>
54
#include <unistd.h>
55
#include <subcmd/pager.h>
56
#include <perf/evlist.h>
57
#include <linux/err.h>
58
#include "util/dlfilter.h"
59
#include "util/record.h"
60
#include "util/util.h"
61
#include "perf.h"
F
Frederic Weisbecker 已提交
62

63
#include <linux/ctype.h>
64

T
Tom Zanussi 已提交
65 66
static char const		*script_name;
static char const		*generate_script_lang;
A
Andi Kleen 已提交
67
static bool			reltime;
68
static bool			deltatime;
A
Andi Kleen 已提交
69
static u64			initial_time;
70
static u64			previous_time;
71
static bool			debug_mode;
72
static u64			last_timestamp;
73
static u64			nr_unordered;
74
static bool			no_callchain;
75
static bool			latency_format;
76
static bool			system_wide;
77
static bool			print_flags;
78 79
static const char		*cpu_list;
static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
80
static struct perf_stat_config	stat_config;
81
static int			max_blocks;
82
static bool			native_arch;
83
static struct dlfilter		*dlfilter;
84 85
static int			dlargc;
static char			**dlargv;
T
Tom Zanussi 已提交
86

87
unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
88

89
enum perf_output_field {
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
	PERF_OUTPUT_COMM            = 1ULL << 0,
	PERF_OUTPUT_TID             = 1ULL << 1,
	PERF_OUTPUT_PID             = 1ULL << 2,
	PERF_OUTPUT_TIME            = 1ULL << 3,
	PERF_OUTPUT_CPU             = 1ULL << 4,
	PERF_OUTPUT_EVNAME          = 1ULL << 5,
	PERF_OUTPUT_TRACE           = 1ULL << 6,
	PERF_OUTPUT_IP              = 1ULL << 7,
	PERF_OUTPUT_SYM             = 1ULL << 8,
	PERF_OUTPUT_DSO             = 1ULL << 9,
	PERF_OUTPUT_ADDR            = 1ULL << 10,
	PERF_OUTPUT_SYMOFFSET       = 1ULL << 11,
	PERF_OUTPUT_SRCLINE         = 1ULL << 12,
	PERF_OUTPUT_PERIOD          = 1ULL << 13,
	PERF_OUTPUT_IREGS	    = 1ULL << 14,
	PERF_OUTPUT_BRSTACK	    = 1ULL << 15,
	PERF_OUTPUT_BRSTACKSYM	    = 1ULL << 16,
	PERF_OUTPUT_DATA_SRC	    = 1ULL << 17,
	PERF_OUTPUT_WEIGHT	    = 1ULL << 18,
	PERF_OUTPUT_BPF_OUTPUT	    = 1ULL << 19,
	PERF_OUTPUT_CALLINDENT	    = 1ULL << 20,
	PERF_OUTPUT_INSN	    = 1ULL << 21,
	PERF_OUTPUT_INSNLEN	    = 1ULL << 22,
	PERF_OUTPUT_BRSTACKINSN	    = 1ULL << 23,
	PERF_OUTPUT_BRSTACKOFF	    = 1ULL << 24,
	PERF_OUTPUT_SYNTH           = 1ULL << 25,
	PERF_OUTPUT_PHYS_ADDR       = 1ULL << 26,
	PERF_OUTPUT_UREGS	    = 1ULL << 27,
	PERF_OUTPUT_METRIC	    = 1ULL << 28,
	PERF_OUTPUT_MISC            = 1ULL << 29,
	PERF_OUTPUT_SRCCODE	    = 1ULL << 30,
	PERF_OUTPUT_IPC             = 1ULL << 31,
122
	PERF_OUTPUT_TOD             = 1ULL << 32,
K
Kan Liang 已提交
123
	PERF_OUTPUT_DATA_PAGE_SIZE  = 1ULL << 33,
124
	PERF_OUTPUT_CODE_PAGE_SIZE  = 1ULL << 34,
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
};

struct perf_script {
	struct perf_tool	tool;
	struct perf_session	*session;
	bool			show_task_events;
	bool			show_mmap_events;
	bool			show_switch_events;
	bool			show_namespace_events;
	bool			show_lost_events;
	bool			show_round_events;
	bool			show_bpf_events;
	bool			show_cgroup_events;
	bool			show_text_poke_events;
	bool			allocated;
	bool			per_event_dump;
	bool			stitch_lbr;
	struct evswitch		evswitch;
	struct perf_cpu_map	*cpus;
	struct perf_thread_map *threads;
	int			name_width;
	const char              *time_str;
	struct perf_time_interval *ptime_range;
	int			range_size;
	int			range_num;
150 151 152 153 154 155 156 157 158 159 160 161 162
};

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},
163
	{.str = "ip",    .field = PERF_OUTPUT_IP},
164
	{.str = "sym",   .field = PERF_OUTPUT_SYM},
165
	{.str = "dso",   .field = PERF_OUTPUT_DSO},
166
	{.str = "addr",  .field = PERF_OUTPUT_ADDR},
167
	{.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
168
	{.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
J
Jiri Olsa 已提交
169
	{.str = "period", .field = PERF_OUTPUT_PERIOD},
170
	{.str = "iregs", .field = PERF_OUTPUT_IREGS},
A
Andi Kleen 已提交
171
	{.str = "uregs", .field = PERF_OUTPUT_UREGS},
172 173
	{.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
	{.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
174 175
	{.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
	{.str = "weight",   .field = PERF_OUTPUT_WEIGHT},
176
	{.str = "bpf-output",   .field = PERF_OUTPUT_BPF_OUTPUT},
177
	{.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
A
Andi Kleen 已提交
178 179
	{.str = "insn", .field = PERF_OUTPUT_INSN},
	{.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
180
	{.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
181
	{.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
182
	{.str = "synth", .field = PERF_OUTPUT_SYNTH},
183
	{.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
184
	{.str = "metric", .field = PERF_OUTPUT_METRIC},
185
	{.str = "misc", .field = PERF_OUTPUT_MISC},
A
Andi Kleen 已提交
186
	{.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
187
	{.str = "ipc", .field = PERF_OUTPUT_IPC},
188
	{.str = "tod", .field = PERF_OUTPUT_TOD},
K
Kan Liang 已提交
189
	{.str = "data_page_size", .field = PERF_OUTPUT_DATA_PAGE_SIZE},
190
	{.str = "code_page_size", .field = PERF_OUTPUT_CODE_PAGE_SIZE},
191 192
};

193 194
enum {
	OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
195
	OUTPUT_TYPE_OTHER,
196 197 198
	OUTPUT_TYPE_MAX
};

199
/* default set to maintain compatibility with current format */
200 201
static struct {
	bool user_set;
202
	bool wildcard_set;
203
	unsigned int print_ip_opts;
204 205
	u64 fields;
	u64 invalid_fields;
206
	u64 user_set_fields;
207
	u64 user_unset_fields;
208
} output[OUTPUT_TYPE_MAX] = {
209 210 211 212 213 214

	[PERF_TYPE_HARDWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
215
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
216 217
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
218

219
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
220 221 222 223 224 225 226
	},

	[PERF_TYPE_SOFTWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
227
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
228 229 230
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
			      PERF_OUTPUT_BPF_OUTPUT,
231 232 233 234 235 236 237 238 239

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_TRACEPOINT] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
				  PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
240
				  PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
241
	},
242

243 244 245 246 247 248 249 250 251 252 253 254
	[PERF_TYPE_HW_CACHE] = {
		.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_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,

		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
	},

255 256 257 258 259
	[PERF_TYPE_RAW] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
260
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
261 262 263
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
			      PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
K
Kan Liang 已提交
264
			      PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR |
265
			      PERF_OUTPUT_DATA_PAGE_SIZE | PERF_OUTPUT_CODE_PAGE_SIZE,
266

267
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
268
	},
269 270 271 272 273 274 275

	[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 |
276 277
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
278

279
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
280
	},
281 282 283 284 285 286 287

	[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 |
288 289
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
290 291 292

		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
	},
293 294 295 296 297 298 299 300 301 302 303 304

	[OUTPUT_TYPE_OTHER] = {
		.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_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,

		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
	},
305
};
306

307
struct evsel_script {
308 309 310
       char *filename;
       FILE *fp;
       u64  samples;
311 312 313
       /* For metric output */
       u64  val;
       int  gnum;
314 315
};

316
static inline struct evsel_script *evsel_script(struct evsel *evsel)
317
{
318
	return (struct evsel_script *)evsel->priv;
319 320
}

321
static struct evsel_script *evsel_script__new(struct evsel *evsel, struct perf_data *data)
322
{
323
	struct evsel_script *es = zalloc(sizeof(*es));
324 325

	if (es != NULL) {
326
		if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
327 328 329 330 331 332 333 334 335 336 337 338 339 340
			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;
}

341
static void evsel_script__delete(struct evsel_script *es)
342 343 344 345 346 347 348
{
	zfree(&es->filename);
	fclose(es->fp);
	es->fp = NULL;
	free(es);
}

349
static int evsel_script__fprintf(struct evsel_script *es, FILE *fp)
350 351 352 353 354 355 356 357
{
	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);
}

358 359 360 361 362 363
static inline int output_type(unsigned int type)
{
	switch (type) {
	case PERF_TYPE_SYNTH:
		return OUTPUT_TYPE_SYNTH;
	default:
364 365
		if (type < PERF_TYPE_MAX)
			return type;
366
	}
367 368

	return OUTPUT_TYPE_OTHER;
369 370
}

371 372 373
static bool output_set_by_user(void)
{
	int j;
374
	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
375 376 377 378 379
		if (output[j].user_set)
			return true;
	}
	return false;
}
380

381 382 383 384 385 386 387 388 389 390 391 392 393 394
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;
}

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

397 398
static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
				 enum perf_output_field field, bool allow_user_set)
399
{
400
	struct perf_event_attr *attr = &evsel->core.attr;
401
	int type = output_type(attr->type);
402 403 404 405 406
	const char *evname;

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

407
	if (output[type].user_set_fields & field) {
408 409
		if (allow_user_set)
			return 0;
410
		evname = evsel__name(evsel);
411 412 413 414 415 416 417 418
		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;
419
	evname = evsel__name(evsel);
420 421 422 423 424 425 426
	pr_debug("Samples for '%s' event do not have %s attribute set. "
		 "Skipping '%s' field.\n",
		 evname, sample_msg, output_field2str(field));

	return 0;
}

427 428
static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
			      enum perf_output_field field)
429
{
430
	return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
431 432
}

433
static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
434
{
435
	struct perf_event_attr *attr = &evsel->core.attr;
436 437
	bool allow_user_set;

438 439 440
	if (perf_header__has_feat(&session->header, HEADER_STAT))
		return 0;

441 442
	allow_user_set = perf_header__has_feat(&session->header,
					       HEADER_AUXTRACE);
443

444
	if (PRINT_FIELD(TRACE) &&
445
	    !perf_session__has_traces(session, "record -R"))
446 447
		return -EINVAL;

448
	if (PRINT_FIELD(IP)) {
449
		if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
450 451
			return -EINVAL;
	}
452 453

	if (PRINT_FIELD(ADDR) &&
454
	    evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
455 456
		return -EINVAL;

457
	if (PRINT_FIELD(DATA_SRC) &&
458
	    evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC))
459 460 461
		return -EINVAL;

	if (PRINT_FIELD(WEIGHT) &&
462
	    evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT", PERF_OUTPUT_WEIGHT))
463 464
		return -EINVAL;

465
	if (PRINT_FIELD(SYM) &&
466
	    !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
467
		pr_err("Display of symbols requested but neither sample IP nor "
468
			   "sample address\navailable. Hence, no addresses to convert "
469
		       "to symbols.\n");
470 471
		return -EINVAL;
	}
472 473 474 475 476
	if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
		pr_err("Display of offsets requested but symbol is not"
		       "selected.\n");
		return -EINVAL;
	}
477
	if (PRINT_FIELD(DSO) &&
478
	    !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
479
		pr_err("Display of DSO requested but no address to convert.\n");
480 481
		return -EINVAL;
	}
A
Andi Kleen 已提交
482
	if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
483 484 485 486
		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;
	}
487
	if (PRINT_FIELD(BRSTACKINSN) && !allow_user_set &&
488
	    !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
489 490 491 492
		pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
		       "Hint: run 'perf record -b ...'\n");
		return -EINVAL;
	}
493
	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
494
	    evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
495 496 497
		return -EINVAL;

	if (PRINT_FIELD(TIME) &&
498
	    evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
499 500 501
		return -EINVAL;

	if (PRINT_FIELD(CPU) &&
502
	    evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
503
		return -EINVAL;
504

505
	if (PRINT_FIELD(IREGS) &&
506
	    evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
507 508
		return -EINVAL;

A
Andi Kleen 已提交
509
	if (PRINT_FIELD(UREGS) &&
510
	    evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
A
Andi Kleen 已提交
511 512
		return -EINVAL;

513
	if (PRINT_FIELD(PHYS_ADDR) &&
514
	    evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR))
515 516
		return -EINVAL;

K
Kan Liang 已提交
517 518 519 520
	if (PRINT_FIELD(DATA_PAGE_SIZE) &&
	    evsel__check_stype(evsel, PERF_SAMPLE_DATA_PAGE_SIZE, "DATA_PAGE_SIZE", PERF_OUTPUT_DATA_PAGE_SIZE))
		return -EINVAL;

521 522 523 524
	if (PRINT_FIELD(CODE_PAGE_SIZE) &&
	    evsel__check_stype(evsel, PERF_SAMPLE_CODE_PAGE_SIZE, "CODE_PAGE_SIZE", PERF_OUTPUT_CODE_PAGE_SIZE))
		return -EINVAL;

525 526 527
	return 0;
}

528 529
static void set_print_ip_opts(struct perf_event_attr *attr)
{
530
	unsigned int type = output_type(attr->type);
531 532 533

	output[type].print_ip_opts = 0;
	if (PRINT_FIELD(IP))
534
		output[type].print_ip_opts |= EVSEL__PRINT_IP;
535 536

	if (PRINT_FIELD(SYM))
537
		output[type].print_ip_opts |= EVSEL__PRINT_SYM;
538 539

	if (PRINT_FIELD(DSO))
540
		output[type].print_ip_opts |= EVSEL__PRINT_DSO;
541 542

	if (PRINT_FIELD(SYMOFFSET))
543
		output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
544 545

	if (PRINT_FIELD(SRCLINE))
546
		output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
547 548
}

549 550 551 552 553 554 555 556 557 558 559 560
static struct evsel *find_first_output_type(struct evlist *evlist,
					    unsigned int type)
{
	struct evsel *evsel;

	evlist__for_each_entry(evlist, evsel) {
		if (output_type(evsel->core.attr.type) == (int)type)
			return evsel;
	}
	return NULL;
}

561 562 563 564 565 566
/*
 * verify all user requested events exist and the samples
 * have the expected data
 */
static int perf_session__check_output_opt(struct perf_session *session)
{
567
	bool tod = false;
568
	unsigned int j;
569
	struct evsel *evsel;
570

571
	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
572
		evsel = find_first_output_type(session->evlist, j);
573 574 575 576 577

		/*
		 * even if fields is set to 0 (ie., show nothing) event must
		 * exist if user explicitly includes it on the command line
		 */
578 579
		if (!evsel && output[j].user_set && !output[j].wildcard_set &&
		    j != OUTPUT_TYPE_SYNTH) {
580
			pr_err("%s events do not exist. "
581
			       "Remove corresponding -F option to proceed.\n",
582 583 584 585 586
			       event_type(j));
			return -1;
		}

		if (evsel && output[j].fields &&
587
			evsel__check_attr(evsel, session))
588
			return -1;
589 590 591 592

		if (evsel == NULL)
			continue;

593
		set_print_ip_opts(&evsel->core.attr);
594
		tod |= output[j].fields & PERF_OUTPUT_TOD;
595 596
	}

597 598
	if (!no_callchain) {
		bool use_callchain = false;
599
		bool not_pipe = false;
600

601
		evlist__for_each_entry(session->evlist, evsel) {
602
			not_pipe = true;
603
			if (evsel__has_callchain(evsel)) {
604 605 606 607
				use_callchain = true;
				break;
			}
		}
608
		if (not_pipe && !use_callchain)
609 610 611
			symbol_conf.use_callchain = false;
	}

612 613 614 615 616 617 618 619
	/*
	 * set default for tracepoints to print symbols only
	 * if callchains are present
	 */
	if (symbol_conf.use_callchain &&
	    !output[PERF_TYPE_TRACEPOINT].user_set) {
		j = PERF_TYPE_TRACEPOINT;

620
		evlist__for_each_entry(session->evlist, evsel) {
621
			if (evsel->core.attr.type != j)
622 623
				continue;

624
			if (evsel__has_callchain(evsel)) {
625 626
				output[j].fields |= PERF_OUTPUT_IP;
				output[j].fields |= PERF_OUTPUT_SYM;
627
				output[j].fields |= PERF_OUTPUT_SYMOFFSET;
628
				output[j].fields |= PERF_OUTPUT_DSO;
629
				set_print_ip_opts(&evsel->core.attr);
630 631
				goto out;
			}
632 633 634
		}
	}

635 636 637 638 639
	if (tod && !session->header.env.clock.enabled) {
		pr_err("Can't provide 'tod' time, missing clock data. "
		       "Please record with -k/--clockid option.\n");
		return -1;
	}
640
out:
641 642
	return 0;
}
643

644
static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
645
				     FILE *fp)
A
Andi Kleen 已提交
646 647
{
	unsigned i = 0, r;
648
	int printed = 0;
A
Andi Kleen 已提交
649 650

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

653
	printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
A
Andi Kleen 已提交
654 655 656

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

	return printed;
A
Andi Kleen 已提交
661 662
}

663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
#define DEFAULT_TOD_FMT "%F %H:%M:%S"

static char*
tod_scnprintf(struct perf_script *script, char *buf, int buflen,
	     u64 timestamp)
{
	u64 tod_ns, clockid_ns;
	struct perf_env *env;
	unsigned long nsec;
	struct tm ltime;
	char date[64];
	time_t sec;

	buf[0] = '\0';
	if (buflen < 64 || !script)
		return buf;

	env = &script->session->header.env;
	if (!env->clock.enabled) {
		scnprintf(buf, buflen, "disabled");
		return buf;
	}

	clockid_ns = env->clock.clockid_ns;
	tod_ns     = env->clock.tod_ns;

	if (timestamp > clockid_ns)
		tod_ns += timestamp - clockid_ns;
	else
		tod_ns -= clockid_ns - timestamp;

	sec  = (time_t) (tod_ns / NSEC_PER_SEC);
	nsec = tod_ns - sec * NSEC_PER_SEC;

	if (localtime_r(&sec, &ltime) == NULL) {
		scnprintf(buf, buflen, "failed");
	} else {
		strftime(date, sizeof(date), DEFAULT_TOD_FMT, &ltime);

		if (symbol_conf.nanosecs) {
			snprintf(buf, buflen, "%s.%09lu", date, nsec);
		} else {
			snprintf(buf, buflen, "%s.%06lu",
				 date, nsec / NSEC_PER_USEC);
		}
	}

	return buf;
}

713 714 715 716 717 718 719 720 721 722 723 724 725 726
static int perf_sample__fprintf_iregs(struct perf_sample *sample,
				      struct perf_event_attr *attr, FILE *fp)
{
	return perf_sample__fprintf_regs(&sample->intr_regs,
					 attr->sample_regs_intr, fp);
}

static int perf_sample__fprintf_uregs(struct perf_sample *sample,
				      struct perf_event_attr *attr, FILE *fp)
{
	return perf_sample__fprintf_regs(&sample->user_regs,
					 attr->sample_regs_user, fp);
}

727 728
static int perf_sample__fprintf_start(struct perf_script *script,
				      struct perf_sample *sample,
729
				      struct thread *thread,
730
				      struct evsel *evsel,
731
				      u32 type, FILE *fp)
732
{
733
	struct perf_event_attr *attr = &evsel->core.attr;
734
	unsigned long secs;
735
	unsigned long long nsecs;
736
	int printed = 0;
737
	char tstr[128];
738 739

	if (PRINT_FIELD(COMM)) {
740 741
		const char *comm = thread ? thread__comm_str(thread) : ":-1";

742
		if (latency_format)
743
			printed += fprintf(fp, "%8.8s ", comm);
744
		else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
745
			printed += fprintf(fp, "%s ", comm);
746
		else
747
			printed += fprintf(fp, "%16s ", comm);
748
	}
749

750
	if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
751
		printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
752
	else if (PRINT_FIELD(PID))
753
		printed += fprintf(fp, "%5d ", sample->pid);
754
	else if (PRINT_FIELD(TID))
755
		printed += fprintf(fp, "%5d ", sample->tid);
756 757 758

	if (PRINT_FIELD(CPU)) {
		if (latency_format)
759
			printed += fprintf(fp, "%3d ", sample->cpu);
760
		else
761
			printed += fprintf(fp, "[%03d] ", sample->cpu);
762
	}
763

764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
	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:
793
			if (has(SWITCH_OUT)) {
794
				ret += fprintf(fp, "S");
795 796 797
				if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
					ret += fprintf(fp, "p");
			}
798 799 800 801 802 803 804 805 806 807
		default:
			break;
		}

		#undef has

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

808 809 810 811 812
	if (PRINT_FIELD(TOD)) {
		tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
		printed += fprintf(fp, "%s ", tstr);
	}

813
	if (PRINT_FIELD(TIME)) {
A
Andi Kleen 已提交
814 815 816 817 818
		u64 t = sample->time;
		if (reltime) {
			if (!initial_time)
				initial_time = sample->time;
			t = sample->time - initial_time;
819 820 821 822 823 824 825
		} else if (deltatime) {
			if (previous_time)
				t = sample->time - previous_time;
			else {
				t = 0;
			}
			previous_time = sample->time;
A
Andi Kleen 已提交
826 827
		}
		nsecs = t;
828 829
		secs = nsecs / NSEC_PER_SEC;
		nsecs -= secs * NSEC_PER_SEC;
830

831
		if (symbol_conf.nanosecs)
832
			printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
833 834
		else {
			char sample_time[32];
A
Andi Kleen 已提交
835
			timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
836
			printed += fprintf(fp, "%12s: ", sample_time);
837
		}
838
	}
839 840

	return printed;
841 842
}

843 844 845 846 847 848 849 850 851
static inline char
mispred_str(struct branch_entry *br)
{
	if (!(br->flags.mispred  || br->flags.predicted))
		return '-';

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

852 853 854
static int perf_sample__fprintf_brstack(struct perf_sample *sample,
					struct thread *thread,
					struct perf_event_attr *attr, FILE *fp)
855 856
{
	struct branch_stack *br = sample->branch_stack;
857
	struct branch_entry *entries = perf_sample__branch_entries(sample);
858 859
	struct addr_location alf, alt;
	u64 i, from, to;
860
	int printed = 0;
861 862

	if (!(br && br->nr))
863
		return 0;
864 865

	for (i = 0; i < br->nr; i++) {
866 867
		from = entries[i].from;
		to   = entries[i].to;
868 869 870 871

		if (PRINT_FIELD(DSO)) {
			memset(&alf, 0, sizeof(alf));
			memset(&alt, 0, sizeof(alt));
872 873
			thread__find_map_fb(thread, sample->cpumode, from, &alf);
			thread__find_map_fb(thread, sample->cpumode, to, &alt);
874 875
		}

876
		printed += fprintf(fp, " 0x%"PRIx64, from);
877
		if (PRINT_FIELD(DSO)) {
878 879 880
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alf.map, fp);
			printed += fprintf(fp, ")");
881 882
		}

883
		printed += fprintf(fp, "/0x%"PRIx64, to);
884
		if (PRINT_FIELD(DSO)) {
885 886 887
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alt.map, fp);
			printed += fprintf(fp, ")");
888 889
		}

890
		printed += fprintf(fp, "/%c/%c/%c/%d ",
891 892 893 894
			mispred_str(entries + i),
			entries[i].flags.in_tx ? 'X' : '-',
			entries[i].flags.abort ? 'A' : '-',
			entries[i].flags.cycles);
895
	}
896 897

	return printed;
898 899
}

900 901 902
static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
					   struct thread *thread,
					   struct perf_event_attr *attr, FILE *fp)
903 904
{
	struct branch_stack *br = sample->branch_stack;
905
	struct branch_entry *entries = perf_sample__branch_entries(sample);
906 907
	struct addr_location alf, alt;
	u64 i, from, to;
908
	int printed = 0;
909 910

	if (!(br && br->nr))
911
		return 0;
912 913 914 915 916

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

		memset(&alf, 0, sizeof(alf));
		memset(&alt, 0, sizeof(alt));
917 918
		from = entries[i].from;
		to   = entries[i].to;
919

920 921
		thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
		thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
922

923
		printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
924
		if (PRINT_FIELD(DSO)) {
925 926 927
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alf.map, fp);
			printed += fprintf(fp, ")");
928
		}
929 930
		printed += fprintf(fp, "%c", '/');
		printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
931
		if (PRINT_FIELD(DSO)) {
932 933 934
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alt.map, fp);
			printed += fprintf(fp, ")");
935
		}
936
		printed += fprintf(fp, "/%c/%c/%c/%d ",
937 938 939 940
			mispred_str(entries + i),
			entries[i].flags.in_tx ? 'X' : '-',
			entries[i].flags.abort ? 'A' : '-',
			entries[i].flags.cycles);
941
	}
942 943

	return printed;
944 945
}

946 947 948
static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
					   struct thread *thread,
					   struct perf_event_attr *attr, FILE *fp)
949 950
{
	struct branch_stack *br = sample->branch_stack;
951
	struct branch_entry *entries = perf_sample__branch_entries(sample);
952 953
	struct addr_location alf, alt;
	u64 i, from, to;
954
	int printed = 0;
955 956

	if (!(br && br->nr))
957
		return 0;
958 959 960 961 962

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

		memset(&alf, 0, sizeof(alf));
		memset(&alt, 0, sizeof(alt));
963 964
		from = entries[i].from;
		to   = entries[i].to;
965

966
		if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
967
		    !alf.map->dso->adjust_symbols)
968 969
			from = map__map_ip(alf.map, from);

970
		if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
971
		    !alt.map->dso->adjust_symbols)
972 973
			to = map__map_ip(alt.map, to);

974
		printed += fprintf(fp, " 0x%"PRIx64, from);
975
		if (PRINT_FIELD(DSO)) {
976 977 978
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alf.map, fp);
			printed += fprintf(fp, ")");
979
		}
980
		printed += fprintf(fp, "/0x%"PRIx64, to);
981
		if (PRINT_FIELD(DSO)) {
982 983 984
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alt.map, fp);
			printed += fprintf(fp, ")");
985
		}
986
		printed += fprintf(fp, "/%c/%c/%c/%d ",
987 988 989 990
			mispred_str(entries + i),
			entries[i].flags.in_tx ? 'X' : '-',
			entries[i].flags.abort ? 'A' : '-',
			entries[i].flags.cycles);
991
	}
992 993

	return printed;
994
}
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
#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)) {
1021
		pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1022 1023 1024 1025 1026 1027
		return -ENXIO;
	}

	memset(&al, 0, sizeof(al));
	if (end - start > MAXBB - MAXINSN) {
		if (last)
1028
			pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
1029
		else
1030
			pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
1031 1032 1033
		return 0;
	}

1034
	if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
1035
		pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1036 1037 1038
		return 0;
	}
	if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
1039
		pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
		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)
1052
		pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1053 1054 1055 1056
			start, end);
	return len;
}

1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
{
	char *srcfile;
	int ret = 0;
	unsigned line;
	int len;
	char *srccode;

	if (!map || !map->dso)
		return 0;
	srcfile = get_srcline_split(map->dso,
				    map__rip_2objdump(map, addr),
				    &line);
	if (!srcfile)
		return 0;

	/* Avoid redundant printing */
	if (state &&
	    state->srcfile &&
	    !strcmp(state->srcfile, srcfile) &&
	    state->line == line) {
		free(srcfile);
		return 0;
	}

	srccode = find_sourceline(srcfile, line, &len);
	if (!srccode)
		goto out_free_line;

	ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);

	if (state) {
		state->srcfile = srcfile;
		state->line = line;
	}
	return ret;

out_free_line:
	free(srcfile);
	return ret;
}

A
Andi Kleen 已提交
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
{
	struct addr_location al;
	int ret = 0;

	memset(&al, 0, sizeof(al));
	thread__find_map(thread, cpumode, addr, &al);
	if (!al.map)
		return 0;
	ret = map__fprintf_srccode(al.map, al.addr, stdout,
		    &thread->srccode_state);
	if (ret)
		ret += printf("\n");
	return ret;
}

1115 1116
static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
			    struct perf_insn *x, u8 *inbuf, int len,
1117
			    int insn, FILE *fp, int *total_cycles)
1118
{
1119 1120 1121 1122 1123 1124
	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" : "");
1125
	if (en->flags.cycles) {
1126 1127
		*total_cycles += en->flags.cycles;
		printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1128
		if (insn)
1129
			printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1130
	}
1131
	return printed + fprintf(fp, "\n");
1132 1133
}

1134 1135 1136
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)
1137 1138
{
	struct addr_location al;
1139
	int off, printed = 0;
1140 1141 1142

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

1143 1144
	thread__find_map(thread, cpumode, addr, &al);

1145
	if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1146
		return 0;
1147 1148 1149 1150 1151 1152 1153

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

	if (!al.sym)
1154
		return 0;
1155 1156 1157 1158 1159

	if (al.addr < al.sym->end)
		off = al.addr - al.sym->start;
	else
		off = al.addr - al.map->start - al.sym->start;
1160
	printed += fprintf(fp, "\t%s", al.sym->name);
1161
	if (off)
1162 1163
		printed += fprintf(fp, "%+d", off);
	printed += fprintf(fp, ":");
1164
	if (PRINT_FIELD(SRCLINE))
1165 1166
		printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
	printed += fprintf(fp, "\n");
1167
	*lastsym = al.sym;
1168 1169

	return printed;
1170 1171
}

1172 1173 1174 1175
static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
					    struct thread *thread,
					    struct perf_event_attr *attr,
					    struct machine *machine, FILE *fp)
1176 1177
{
	struct branch_stack *br = sample->branch_stack;
1178
	struct branch_entry *entries = perf_sample__branch_entries(sample);
1179
	u64 start, end;
1180
	int i, insn, len, nr, ilen, printed = 0;
1181 1182 1183 1184
	struct perf_insn x;
	u8 buffer[MAXBB];
	unsigned off;
	struct symbol *lastsym = NULL;
1185
	int total_cycles = 0;
1186 1187

	if (!(br && br->nr))
1188
		return 0;
1189 1190 1191 1192 1193 1194 1195
	nr = br->nr;
	if (max_blocks && nr > max_blocks + 1)
		nr = max_blocks + 1;

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

1196
	printed += fprintf(fp, "%c", '\n');
1197 1198

	/* Handle first from jump, of which we don't know the entry. */
1199 1200
	len = grab_bb(buffer, entries[nr-1].from,
			entries[nr-1].from,
1201 1202
			machine, thread, &x.is64bit, &x.cpumode, false);
	if (len > 0) {
1203
		printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1204
					   x.cpumode, x.cpu, &lastsym, attr, fp);
1205
		printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1206
					    &x, buffer, len, 0, fp, &total_cycles);
A
Andi Kleen 已提交
1207
		if (PRINT_FIELD(SRCCODE))
1208
			printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1209 1210 1211 1212
	}

	/* Print all blocks */
	for (i = nr - 2; i >= 0; i--) {
1213
		if (entries[i].from || entries[i].to)
1214
			pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1215 1216 1217 1218
				 entries[i].from,
				 entries[i].to);
		start = entries[i + 1].to;
		end   = entries[i].from;
1219 1220 1221 1222

		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) {
1223
			end = entries[--i].from;
1224 1225 1226 1227 1228 1229 1230
			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;
1231
		for (off = 0; off < (unsigned)len; off += ilen) {
1232 1233
			uint64_t ip = start + off;

1234
			printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1235
			if (ip == end) {
1236
				printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1237
							    &total_cycles);
A
Andi Kleen 已提交
1238 1239
				if (PRINT_FIELD(SRCCODE))
					printed += print_srccode(thread, x.cpumode, ip);
1240 1241
				break;
			} else {
1242
				ilen = 0;
1243 1244
				printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
						   dump_insn(&x, ip, buffer + off, len - off, &ilen));
1245 1246
				if (ilen == 0)
					break;
A
Andi Kleen 已提交
1247 1248
				if (PRINT_FIELD(SRCCODE))
					print_srccode(thread, x.cpumode, ip);
1249 1250 1251
				insn++;
			}
		}
1252
		if (off != end - start)
1253
			printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1254 1255 1256 1257 1258 1259
	}

	/*
	 * Hit the branch? In this case we are already done, and the target
	 * has not been executed yet.
	 */
1260
	if (entries[0].from == sample->ip)
1261
		goto out;
1262
	if (entries[0].flags.abort)
1263
		goto out;
1264 1265 1266

	/*
	 * Print final block upto sample
1267 1268 1269 1270 1271
	 *
	 * Due to pipeline delays the LBRs might be missing a branch
	 * or two, which can result in very large or negative blocks
	 * between final branch and sample. When this happens just
	 * continue walking after the last TO until we hit a branch.
1272
	 */
1273
	start = entries[0].to;
1274
	end = sample->ip;
1275 1276 1277 1278
	if (end < start) {
		/* Missing jump. Scan 128 bytes for the next branch */
		end = start + 128;
	}
1279
	len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1280
	printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1281 1282 1283 1284 1285
	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)
1286 1287
			goto out;
		printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1288
			dump_insn(&x, sample->ip, buffer, len, NULL));
A
Andi Kleen 已提交
1289 1290
		if (PRINT_FIELD(SRCCODE))
			print_srccode(thread, x.cpumode, sample->ip);
1291
		goto out;
1292 1293
	}
	for (off = 0; off <= end - start; off += ilen) {
1294
		ilen = 0;
1295 1296
		printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
				   dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1297 1298
		if (ilen == 0)
			break;
1299 1300 1301 1302 1303 1304 1305
		if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
			/*
			 * Hit a missing branch. Just stop.
			 */
			printed += fprintf(fp, "\t... not reaching sample ...\n");
			break;
		}
A
Andi Kleen 已提交
1306 1307
		if (PRINT_FIELD(SRCCODE))
			print_srccode(thread, x.cpumode, start + off);
1308
	}
1309 1310
out:
	return printed;
1311
}
1312

1313 1314 1315
static int perf_sample__fprintf_addr(struct perf_sample *sample,
				     struct thread *thread,
				     struct perf_event_attr *attr, FILE *fp)
1316 1317
{
	struct addr_location al;
1318
	int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1319 1320

	if (!sample_addr_correlates_sym(attr))
1321
		goto out;
1322

1323
	thread__resolve(thread, &al, sample);
1324 1325

	if (PRINT_FIELD(SYM)) {
1326
		printed += fprintf(fp, " ");
1327
		if (PRINT_FIELD(SYMOFFSET))
1328
			printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1329
		else
1330
			printed += symbol__fprintf_symname(al.sym, fp);
1331 1332 1333
	}

	if (PRINT_FIELD(DSO)) {
1334 1335 1336
		printed += fprintf(fp, " (");
		printed += map__fprintf_dsoname(al.map, fp);
		printed += fprintf(fp, ")");
1337
	}
1338 1339
out:
	return printed;
1340 1341
}

1342
static const char *resolve_branch_sym(struct perf_sample *sample,
1343
				      struct evsel *evsel,
1344 1345
				      struct thread *thread,
				      struct addr_location *al,
1346
				      struct addr_location *addr_al,
1347 1348
				      u64 *ip)
{
1349
	struct perf_event_attr *attr = &evsel->core.attr;
1350 1351 1352 1353
	const char *name = NULL;

	if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
		if (sample_addr_correlates_sym(attr)) {
1354 1355 1356 1357
			if (!addr_al->thread)
				thread__resolve(thread, addr_al, sample);
			if (addr_al->sym)
				name = addr_al->sym->name;
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
			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;
	}
	return name;
}

1372
static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1373
					   struct evsel *evsel,
1374
					   struct thread *thread,
1375 1376 1377
					   struct addr_location *al,
					   struct addr_location *addr_al,
					   FILE *fp)
1378
{
1379
	struct perf_event_attr *attr = &evsel->core.attr;
1380
	size_t depth = thread_stack__depth(thread, sample->cpu);
1381 1382 1383
	const char *name = NULL;
	static int spacing;
	int len = 0;
1384
	int dlen = 0;
1385 1386 1387 1388 1389 1390 1391 1392 1393
	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;

1394
	name = resolve_branch_sym(sample, evsel, thread, al, addr_al, &ip);
1395

1396 1397 1398 1399 1400 1401
	if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
		dlen += fprintf(fp, "(");
		dlen += map__fprintf_dsoname(al->map, fp);
		dlen += fprintf(fp, ")\t");
	}

1402
	if (name)
1403
		len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1404
	else if (ip)
1405
		len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1406 1407

	if (len < 0)
1408
		return len;
1409 1410 1411 1412 1413 1414 1415 1416 1417

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

1420
	return len + dlen;
1421 1422
}

1423 1424 1425 1426 1427 1428
__weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
			    struct thread *thread __maybe_unused,
			    struct machine *machine __maybe_unused)
{
}

1429 1430 1431 1432 1433 1434 1435
void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
		       struct machine *machine)
{
	if (sample->insn_len == 0 && native_arch)
		arch_fetch_insn(sample, thread, machine);
}

1436 1437 1438 1439
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 已提交
1440
{
1441 1442
	int printed = 0;

1443
	script_fetch_insn(sample, thread, machine);
1444

A
Andi Kleen 已提交
1445
	if (PRINT_FIELD(INSNLEN))
1446
		printed += fprintf(fp, " ilen: %d", sample->insn_len);
1447
	if (PRINT_FIELD(INSN) && sample->insn_len) {
A
Andi Kleen 已提交
1448 1449
		int i;

1450
		printed += fprintf(fp, " insn:");
A
Andi Kleen 已提交
1451
		for (i = 0; i < sample->insn_len; i++)
1452
			printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
A
Andi Kleen 已提交
1453
	}
1454
	if (PRINT_FIELD(BRSTACKINSN))
1455 1456 1457
		printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);

	return printed;
A
Andi Kleen 已提交
1458 1459
}

1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473
static int perf_sample__fprintf_ipc(struct perf_sample *sample,
				    struct perf_event_attr *attr, FILE *fp)
{
	unsigned int ipc;

	if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
		return 0;

	ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;

	return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
		       ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
}

1474
static int perf_sample__fprintf_bts(struct perf_sample *sample,
1475
				    struct evsel *evsel,
1476 1477
				    struct thread *thread,
				    struct addr_location *al,
1478
				    struct addr_location *addr_al,
1479
				    struct machine *machine, FILE *fp)
1480
{
1481
	struct perf_event_attr *attr = &evsel->core.attr;
1482
	unsigned int type = output_type(attr->type);
1483
	bool print_srcline_last = false;
1484
	int printed = 0;
1485

1486
	if (PRINT_FIELD(CALLINDENT))
1487
		printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, addr_al, fp);
1488

1489 1490
	/* print branch_from information */
	if (PRINT_FIELD(IP)) {
1491
		unsigned int print_opts = output[type].print_ip_opts;
1492
		struct callchain_cursor *cursor = NULL;
1493

1494
		if (symbol_conf.use_callchain && sample->callchain &&
1495
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1496
					      sample, NULL, NULL, scripting_max_stack) == 0)
1497
			cursor = &callchain_cursor;
1498 1499

		if (cursor == NULL) {
1500
			printed += fprintf(fp, " ");
1501
			if (print_opts & EVSEL__PRINT_SRCLINE) {
1502
				print_srcline_last = true;
1503
				print_opts &= ~EVSEL__PRINT_SRCLINE;
1504
			}
1505
		} else
1506
			printed += fprintf(fp, "\n");
1507

1508 1509
		printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
					       symbol_conf.bt_stop_list, fp);
1510 1511 1512
	}

	/* print branch_to information */
1513
	if (PRINT_FIELD(ADDR) ||
1514
	    ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1515
	     !output[type].user_set)) {
1516 1517
		printed += fprintf(fp, " => ");
		printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1518
	}
1519

1520 1521
	printed += perf_sample__fprintf_ipc(sample, attr, fp);

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

1525
	printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
A
Andi Kleen 已提交
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535
	printed += fprintf(fp, "\n");
	if (PRINT_FIELD(SRCCODE)) {
		int ret = map__fprintf_srccode(al->map, al->addr, stdout,
					 &thread->srccode_state);
		if (ret) {
			printed += ret;
			printed += printf("\n");
		}
	}
	return printed;
1536 1537
}

1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554
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"},
1555 1556
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMENTRY, "vmentry"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMEXIT, "vmexit"},
1557 1558 1559
	{0, NULL}
};

1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
static const char *sample_flags_to_name(u32 flags)
{
	int i;

	for (i = 0; sample_flags[i].name ; i++) {
		if (sample_flags[i].flags == flags)
			return sample_flags[i].name;
	}

	return NULL;
}

1572
int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz)
1573 1574
{
	const char *chars = PERF_IP_FLAG_CHARS;
1575
	const size_t n = strlen(PERF_IP_FLAG_CHARS);
1576 1577
	bool in_tx = flags & PERF_IP_FLAG_IN_TX;
	const char *name = NULL;
1578
	size_t i, pos = 0;
1579

1580 1581
	name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
	if (name)
1582
		return snprintf(str, sz, "%-15s%4s", name, in_tx ? "(x)" : "");
1583 1584 1585 1586

	if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
		name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_BEGIN));
		if (name)
1587
			return snprintf(str, sz, "tr strt %-7s%4s", name, in_tx ? "(x)" : "");
1588 1589 1590 1591 1592
	}

	if (flags & PERF_IP_FLAG_TRACE_END) {
		name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_END));
		if (name)
1593
			return snprintf(str, sz, "tr end  %-7s%4s", name, in_tx ? "(x)" : "");
1594 1595
	}

1596
	for (i = 0; i < n; i++, flags >>= 1) {
1597
		if ((flags & 1) && pos < sz)
1598 1599 1600
			str[pos++] = chars[i];
	}
	for (; i < 32; i++, flags >>= 1) {
1601
		if ((flags & 1) && pos < sz)
1602 1603
			str[pos++] = '?';
	}
1604 1605 1606 1607 1608 1609 1610 1611 1612
	if (pos < sz)
		str[pos] = 0;

	return pos;
}

static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
{
	char str[SAMPLE_FLAGS_BUF_SIZE];
1613

1614
	perf_sample__sprintf_flags(flags, str, sizeof(str));
1615
	return fprintf(fp, "  %-19s ", str);
1616 1617
}

1618 1619 1620 1621 1622 1623
struct printer_data {
	int line_no;
	bool hit_nul;
	bool is_printable;
};

1624 1625 1626
static int sample__fprintf_bpf_output(enum binary_printer_ops op,
				      unsigned int val,
				      void *extra, FILE *fp)
1627 1628 1629
{
	unsigned char ch = (unsigned char)val;
	struct printer_data *printer_data = extra;
1630
	int printed = 0;
1631 1632 1633

	switch (op) {
	case BINARY_PRINT_DATA_BEGIN:
1634
		printed += fprintf(fp, "\n");
1635 1636
		break;
	case BINARY_PRINT_LINE_BEGIN:
1637
		printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1638 1639 1640
						        "           ");
		break;
	case BINARY_PRINT_ADDR:
1641
		printed += fprintf(fp, " %04x:", val);
1642 1643
		break;
	case BINARY_PRINT_NUM_DATA:
1644
		printed += fprintf(fp, " %02x", val);
1645 1646
		break;
	case BINARY_PRINT_NUM_PAD:
1647
		printed += fprintf(fp, "   ");
1648 1649
		break;
	case BINARY_PRINT_SEP:
1650
		printed += fprintf(fp, "  ");
1651 1652 1653 1654 1655 1656
		break;
	case BINARY_PRINT_CHAR_DATA:
		if (printer_data->hit_nul && ch)
			printer_data->is_printable = false;

		if (!isprint(ch)) {
1657
			printed += fprintf(fp, "%c", '.');
1658 1659 1660 1661 1662 1663 1664 1665 1666

			if (!printer_data->is_printable)
				break;

			if (ch == '\0')
				printer_data->hit_nul = true;
			else
				printer_data->is_printable = false;
		} else {
1667
			printed += fprintf(fp, "%c", ch);
1668 1669 1670
		}
		break;
	case BINARY_PRINT_CHAR_PAD:
1671
		printed += fprintf(fp, " ");
1672 1673
		break;
	case BINARY_PRINT_LINE_END:
1674
		printed += fprintf(fp, "\n");
1675 1676 1677 1678 1679 1680
		printer_data->line_no++;
		break;
	case BINARY_PRINT_DATA_END:
	default:
		break;
	}
1681 1682

	return printed;
1683 1684
}

1685
static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1686 1687 1688
{
	unsigned int nr_bytes = sample->raw_size;
	struct printer_data printer_data = {0, false, true};
1689 1690
	int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
				      sample__fprintf_bpf_output, &printer_data, fp);
1691 1692

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

	return printed;
1696 1697
}

1698
static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1699 1700
{
	if (len > 0 && len < spacing)
1701 1702 1703
		return fprintf(fp, "%*s", spacing - len, "");

	return 0;
1704 1705
}

1706
static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1707
{
1708
	return perf_sample__fprintf_spacing(len, 34, fp);
1709 1710
}

1711
static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1712 1713 1714 1715 1716
{
	struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1717
		return 0;
1718

1719
	len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1720
		     data->ip, le64_to_cpu(data->payload));
1721
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1722 1723
}

1724
static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1725 1726 1727 1728 1729
{
	struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1730
		return 0;
1731

1732 1733 1734
	len = fprintf(fp, " hints: %#x extensions: %#x ",
		      data->hints, data->extensions);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1735 1736
}

1737
static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1738 1739 1740 1741 1742
{
	struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1743
		return 0;
1744

1745 1746 1747
	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);
1748 1749
}

1750
static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1751 1752 1753 1754 1755
{
	struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1756
		return 0;
1757

1758 1759
	len = fprintf(fp, " IP: %u ", data->ip);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1760 1761
}

1762
static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1763 1764 1765 1766 1767
{
	struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
	int len;

	if (perf_sample__bad_synth_size(sample, *data))
1768
		return 0;
1769

1770
	len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1771 1772
		     data->deepest_cstate, data->last_cstate,
		     data->wake_reason);
1773
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1774 1775
}

1776
static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1777 1778 1779 1780 1781 1782
{
	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))
1783
		return 0;
1784 1785

	freq = (le32_to_cpu(data->freq) + 500) / 1000;
1786
	len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1787 1788
	if (data->max_nonturbo) {
		percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1789
		len += fprintf(fp, "(%3u%%) ", percent);
1790
	}
1791
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1792 1793
}

A
Adrian Hunter 已提交
1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805
static int perf_sample__fprintf_synth_psb(struct perf_sample *sample, FILE *fp)
{
	struct perf_synth_intel_psb *data = perf_sample__synth_ptr(sample);
	int len;

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

	len = fprintf(fp, " psb offs: %#" PRIx64, data->offset);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
}

1806
static int perf_sample__fprintf_synth(struct perf_sample *sample,
1807
				      struct evsel *evsel, FILE *fp)
1808
{
1809
	switch (evsel->core.attr.config) {
1810
	case PERF_SYNTH_INTEL_PTWRITE:
1811
		return perf_sample__fprintf_synth_ptwrite(sample, fp);
1812
	case PERF_SYNTH_INTEL_MWAIT:
1813
		return perf_sample__fprintf_synth_mwait(sample, fp);
1814
	case PERF_SYNTH_INTEL_PWRE:
1815
		return perf_sample__fprintf_synth_pwre(sample, fp);
1816
	case PERF_SYNTH_INTEL_EXSTOP:
1817
		return perf_sample__fprintf_synth_exstop(sample, fp);
1818
	case PERF_SYNTH_INTEL_PWRX:
1819
		return perf_sample__fprintf_synth_pwrx(sample, fp);
1820
	case PERF_SYNTH_INTEL_CBR:
1821
		return perf_sample__fprintf_synth_cbr(sample, fp);
A
Adrian Hunter 已提交
1822 1823
	case PERF_SYNTH_INTEL_PSB:
		return perf_sample__fprintf_synth_psb(sample, fp);
1824 1825 1826
	default:
		break;
	}
1827 1828

	return 0;
1829 1830
}

1831
static int evlist__max_name_len(struct evlist *evlist)
1832
{
1833
	struct evsel *evsel;
1834 1835
	int max = 0;

1836
	evlist__for_each_entry(evlist, evsel) {
1837
		int len = strlen(evsel__name(evsel));
1838 1839 1840 1841 1842 1843 1844

		max = MAX(len, max);
	}

	return max;
}

1845
static int data_src__fprintf(u64 data_src, FILE *fp)
J
Jiri Olsa 已提交
1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858
{
	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;

1859
	return fprintf(fp, "%-*s", maxlen, out);
J
Jiri Olsa 已提交
1860 1861
}

1862 1863 1864
struct metric_ctx {
	struct perf_sample	*sample;
	struct thread		*thread;
1865
	struct evsel	*evsel;
1866 1867 1868
	FILE 			*fp;
};

1869 1870
static void script_print_metric(struct perf_stat_config *config __maybe_unused,
				void *ctx, const char *color,
1871 1872 1873 1874 1875 1876 1877
			        const char *fmt,
			        const char *unit, double val)
{
	struct metric_ctx *mctx = ctx;

	if (!fmt)
		return;
1878
	perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1879
				   PERF_RECORD_SAMPLE, mctx->fp);
1880 1881 1882 1883 1884 1885 1886 1887
	fputs("\tmetric: ", mctx->fp);
	if (color)
		color_fprintf(mctx->fp, color, fmt, val);
	else
		printf(fmt, val);
	fprintf(mctx->fp, " %s\n", unit);
}

1888 1889
static void script_new_line(struct perf_stat_config *config __maybe_unused,
			    void *ctx)
1890 1891 1892
{
	struct metric_ctx *mctx = ctx;

1893
	perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1894
				   PERF_RECORD_SAMPLE, mctx->fp);
1895 1896 1897 1898 1899
	fputs("\tmetric: ", mctx->fp);
}

static void perf_sample__fprint_metric(struct perf_script *script,
				       struct thread *thread,
1900
				       struct evsel *evsel,
1901 1902 1903
				       struct perf_sample *sample,
				       FILE *fp)
{
1904
	struct evsel *leader = evsel__leader(evsel);
1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915
	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,
	};
1916
	struct evsel *ev2;
1917 1918 1919
	u64 val;

	if (!evsel->stats)
1920
		evlist__alloc_stats(script->session->evlist, false);
1921
	if (evsel_script(leader)->gnum++ == 0)
1922 1923 1924 1925
		perf_stat__reset_shadow_stats();
	val = sample->period * evsel->scale;
	perf_stat__update_shadow_stats(evsel,
				       val,
1926 1927
				       sample->cpu,
				       &rt_stat);
1928
	evsel_script(evsel)->val = val;
1929 1930
	if (evsel_script(leader)->gnum == leader->core.nr_members) {
		for_each_group_member (ev2, leader) {
1931
			perf_stat__print_shadow_stats(&stat_config, ev2,
1932 1933 1934
						      evsel_script(ev2)->val,
						      sample->cpu,
						      &ctx,
J
Jin Yao 已提交
1935 1936
						      NULL,
						      &rt_stat);
1937
		}
1938
		evsel_script(leader)->gnum = 0;
1939 1940 1941
	}
}

1942
static bool show_event(struct perf_sample *sample,
1943
		       struct evsel *evsel,
1944
		       struct thread *thread,
1945 1946
		       struct addr_location *al,
		       struct addr_location *addr_al)
1947
{
1948
	int depth = thread_stack__depth(thread, sample->cpu);
1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961

	if (!symbol_conf.graph_function)
		return true;

	if (thread->filter) {
		if (depth <= thread->filter_entry_depth) {
			thread->filter = false;
			return false;
		}
		return true;
	} else {
		const char *s = symbol_conf.graph_function;
		u64 ip;
1962
		const char *name = resolve_branch_sym(sample, evsel, thread, al, addr_al,
1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983
				&ip);
		unsigned nlen;

		if (!name)
			return false;
		nlen = strlen(name);
		while (*s) {
			unsigned len = strcspn(s, ",");
			if (nlen == len && !strncmp(name, s, len)) {
				thread->filter = true;
				thread->filter_entry_depth = depth;
				return true;
			}
			s += len;
			if (*s == ',')
				s++;
		}
		return false;
	}
}

1984
static void process_event(struct perf_script *script,
1985
			  struct perf_sample *sample, struct evsel *evsel,
1986
			  struct addr_location *al,
1987
			  struct addr_location *addr_al,
1988
			  struct machine *machine)
1989
{
1990
	struct thread *thread = al->thread;
1991
	struct perf_event_attr *attr = &evsel->core.attr;
1992
	unsigned int type = output_type(attr->type);
1993
	struct evsel_script *es = evsel->priv;
1994
	FILE *fp = es->fp;
K
Kan Liang 已提交
1995
	char str[PAGE_SIZE_NAME_LEN];
1996

1997
	if (output[type].fields == 0)
1998 1999
		return;

2000 2001
	++es->samples;

2002
	perf_sample__fprintf_start(script, sample, thread, evsel,
2003
				   PERF_RECORD_SAMPLE, fp);
2004

J
Jiri Olsa 已提交
2005
	if (PRINT_FIELD(PERIOD))
2006
		fprintf(fp, "%10" PRIu64 " ", sample->period);
J
Jiri Olsa 已提交
2007

2008
	if (PRINT_FIELD(EVNAME)) {
2009
		const char *evname = evsel__name(evsel);
2010 2011

		if (!script->name_width)
2012
			script->name_width = evlist__max_name_len(script->session->evlist);
2013

2014
		fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
2015 2016
	}

2017
	if (print_flags)
2018
		perf_sample__fprintf_flags(sample->flags, fp);
2019

2020
	if (is_bts_event(attr)) {
2021
		perf_sample__fprintf_bts(sample, evsel, thread, al, addr_al, machine, fp);
2022 2023 2024
		return;
	}

2025
	if (PRINT_FIELD(TRACE) && sample->raw_data) {
2026 2027 2028
		event_format__fprintf(evsel->tp_format, sample->cpu,
				      sample->raw_data, sample->raw_size, fp);
	}
2029 2030

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

2033
	if (PRINT_FIELD(ADDR))
2034
		perf_sample__fprintf_addr(sample, thread, attr, fp);
2035

2036
	if (PRINT_FIELD(DATA_SRC))
2037
		data_src__fprintf(sample->data_src, fp);
2038 2039

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

2042
	if (PRINT_FIELD(IP)) {
2043
		struct callchain_cursor *cursor = NULL;
2044

2045 2046 2047
		if (script->stitch_lbr)
			al->thread->lbr_stitch_enable = true;

2048
		if (symbol_conf.use_callchain && sample->callchain &&
2049
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
2050
					      sample, NULL, NULL, scripting_max_stack) == 0)
2051
			cursor = &callchain_cursor;
2052

2053
		fputc(cursor ? '\n' : ' ', fp);
2054 2055
		sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
				    symbol_conf.bt_stop_list, fp);
2056 2057
	}

2058
	if (PRINT_FIELD(IREGS))
2059
		perf_sample__fprintf_iregs(sample, attr, fp);
2060

A
Andi Kleen 已提交
2061
	if (PRINT_FIELD(UREGS))
2062
		perf_sample__fprintf_uregs(sample, attr, fp);
A
Andi Kleen 已提交
2063

2064
	if (PRINT_FIELD(BRSTACK))
2065
		perf_sample__fprintf_brstack(sample, thread, attr, fp);
2066
	else if (PRINT_FIELD(BRSTACKSYM))
2067
		perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2068
	else if (PRINT_FIELD(BRSTACKOFF))
2069
		perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2070

2071
	if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2072 2073
		perf_sample__fprintf_bpf_output(sample, fp);
	perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2074 2075

	if (PRINT_FIELD(PHYS_ADDR))
2076
		fprintf(fp, "%16" PRIx64, sample->phys_addr);
2077

K
Kan Liang 已提交
2078 2079 2080
	if (PRINT_FIELD(DATA_PAGE_SIZE))
		fprintf(fp, " %s", get_page_size_name(sample->data_page_size, str));

2081 2082 2083
	if (PRINT_FIELD(CODE_PAGE_SIZE))
		fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));

2084 2085
	perf_sample__fprintf_ipc(sample, attr, fp);

2086
	fprintf(fp, "\n");
2087

A
Andi Kleen 已提交
2088 2089 2090 2091 2092 2093
	if (PRINT_FIELD(SRCCODE)) {
		if (map__fprintf_srccode(al->map, al->addr, stdout,
					 &thread->srccode_state))
			printf("\n");
	}

2094 2095
	if (PRINT_FIELD(METRIC))
		perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2096 2097 2098

	if (verbose)
		fflush(fp);
2099 2100
}

T
Tom Zanussi 已提交
2101 2102
static struct scripting_ops	*scripting_ops;

2103
static void __process_stat(struct evsel *counter, u64 tstamp)
2104
{
2105
	int nthreads = perf_thread_map__nr(counter->core.threads);
2106
	int ncpus = evsel__nr_cpus(counter);
2107 2108 2109
	int cpu, thread;
	static int header_printed;

2110
	if (counter->core.system_wide)
2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125
		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",
2126
				counter->core.cpus->map[cpu],
2127
				perf_thread_map__pid(counter->core.threads, thread),
2128 2129 2130 2131
				counts->val,
				counts->ena,
				counts->run,
				tstamp,
2132
				evsel__name(counter));
2133 2134 2135 2136
		}
	}
}

2137
static void process_stat(struct evsel *counter, u64 tstamp)
2138 2139 2140
{
	if (scripting_ops && scripting_ops->process_stat)
		scripting_ops->process_stat(&stat_config, counter, tstamp);
2141 2142
	else
		__process_stat(counter, tstamp);
2143 2144 2145 2146 2147 2148 2149 2150
}

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

T
Tom Zanussi 已提交
2151 2152
static void setup_scripting(void)
{
2153
	setup_perl_scripting();
2154
	setup_python_scripting();
T
Tom Zanussi 已提交
2155 2156
}

2157 2158
static int flush_scripting(void)
{
2159
	return scripting_ops ? scripting_ops->flush_script() : 0;
2160 2161
}

T
Tom Zanussi 已提交
2162 2163
static int cleanup_scripting(void)
{
2164
	pr_debug("\nperf script stopped\n");
2165

2166
	return scripting_ops ? scripting_ops->stop_script() : 0;
T
Tom Zanussi 已提交
2167 2168
}

2169 2170
static bool filter_cpu(struct perf_sample *sample)
{
2171
	if (cpu_list && sample->cpu != (u32)-1)
2172 2173 2174 2175
		return !test_bit(sample->cpu, cpu_bitmap);
	return false;
}

2176
static int process_sample_event(struct perf_tool *tool,
2177
				union perf_event *event,
2178
				struct perf_sample *sample,
2179
				struct evsel *evsel,
2180
				struct machine *machine)
F
Frederic Weisbecker 已提交
2181
{
2182
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
2183
	struct addr_location al;
2184
	struct addr_location addr_al;
2185
	int ret = 0;
F
Frederic Weisbecker 已提交
2186

2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197
	/* Set thread to NULL to indicate addr_al and al are not initialized */
	addr_al.thread = NULL;
	al.thread = NULL;

	ret = dlfilter__filter_event_early(dlfilter, event, sample, evsel, machine, &al, &addr_al);
	if (ret) {
		if (ret > 0)
			ret = 0;
		goto out_put;
	}

2198 2199
	if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
					  sample->time)) {
2200
		goto out_put;
2201
	}
2202

2203 2204 2205 2206 2207 2208
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
2209
		}
2210
		last_timestamp = sample->time;
2211
		goto out_put;
F
Frederic Weisbecker 已提交
2212
	}
2213

2214
	if (filter_cpu(sample))
2215
		goto out_put;
2216

2217
	if (!al.thread && machine__resolve(machine, &al, sample) < 0) {
2218 2219
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
2220 2221
		ret = -1;
		goto out_put;
2222 2223 2224
	}

	if (al.filtered)
2225
		goto out_put;
2226

2227
	if (!show_event(sample, evsel, al.thread, &al, &addr_al))
2228 2229 2230 2231 2232
		goto out_put;

	if (evswitch__discard(&scr->evswitch, evsel))
		goto out_put;

2233 2234 2235 2236 2237 2238 2239
	ret = dlfilter__filter_event(dlfilter, event, sample, evsel, machine, &al, &addr_al);
	if (ret) {
		if (ret > 0)
			ret = 0;
		goto out_put;
	}

2240 2241 2242 2243 2244
	if (scripting_ops) {
		struct addr_location *addr_al_ptr = NULL;

		if ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
		    sample_addr_correlates_sym(&evsel->core.attr)) {
2245 2246
			if (!addr_al.thread)
				thread__resolve(al.thread, &addr_al, sample);
2247 2248 2249 2250
			addr_al_ptr = &addr_al;
		}
		scripting_ops->process_event(event, sample, evsel, &al, addr_al_ptr);
	} else {
2251
		process_event(scr, sample, evsel, &al, &addr_al, machine);
2252
	}
2253

2254
out_put:
2255 2256
	if (al.thread)
		addr_location__put(&al);
2257
	return ret;
F
Frederic Weisbecker 已提交
2258 2259
}

2260
static int process_attr(struct perf_tool *tool, union perf_event *event,
2261
			struct evlist **pevlist)
2262 2263
{
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
2264
	struct evlist *evlist;
2265
	struct evsel *evsel, *pos;
2266
	u64 sample_type;
2267
	int err;
2268
	static struct evsel_script *es;
2269 2270 2271 2272 2273 2274

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

	evlist = *pevlist;
2275
	evsel = evlist__last(*pevlist);
2276

2277 2278
	if (!evsel->priv) {
		if (scr->per_event_dump) {
2279
			evsel->priv = evsel_script__new(evsel, scr->session->data);
2280 2281 2282 2283 2284 2285 2286 2287 2288
		} else {
			es = zalloc(sizeof(*es));
			if (!es)
				return -ENOMEM;
			es->fp = stdout;
			evsel->priv = es;
		}
	}

2289 2290
	if (evsel->core.attr.type >= PERF_TYPE_MAX &&
	    evsel->core.attr.type != PERF_TYPE_SYNTH)
2291 2292
		return 0;

2293
	evlist__for_each_entry(evlist, pos) {
2294
		if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2295 2296 2297
			return 0;
	}

2298
	if (evsel->core.attr.sample_type) {
2299
		err = evsel__check_attr(evsel, scr->session);
2300 2301 2302
		if (err)
			return err;
	}
2303

2304 2305 2306 2307
	/*
	 * Check if we need to enable callchains based
	 * on events sample_type.
	 */
2308
	sample_type = evlist__combined_sample_type(evlist);
2309
	callchain_param_setup(sample_type);
2310

2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322
	/* Enable fields for callchain entries */
	if (symbol_conf.use_callchain &&
	    (sample_type & PERF_SAMPLE_CALLCHAIN ||
	     sample_type & PERF_SAMPLE_BRANCH_STACK ||
	     (sample_type & PERF_SAMPLE_REGS_USER &&
	      sample_type & PERF_SAMPLE_STACK_USER))) {
		int type = output_type(evsel->core.attr.type);

		if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
			output[type].fields |= PERF_OUTPUT_IP;
		if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
			output[type].fields |= PERF_OUTPUT_SYM;
2323 2324
	}
	set_print_ip_opts(&evsel->core.attr);
2325
	return 0;
2326 2327
}

2328 2329 2330 2331 2332
static int print_event_with_time(struct perf_tool *tool,
				 union perf_event *event,
				 struct perf_sample *sample,
				 struct machine *machine,
				 pid_t pid, pid_t tid, u64 timestamp)
2333 2334 2335
{
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
2336
	struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2337
	struct thread *thread = NULL;
2338

2339 2340 2341 2342 2343
	if (evsel && !evsel->core.attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = timestamp;
		sample->pid = pid;
		sample->tid = tid;
2344 2345
	}

2346 2347
	if (filter_cpu(sample))
		return 0;
2348

2349 2350 2351
	if (tid != -1)
		thread = machine__findnew_thread(machine, pid, tid);

2352
	if (evsel) {
2353
		perf_sample__fprintf_start(script, sample, thread, evsel,
2354
					   event->header.type, stdout);
2355
	}
2356

2357
	perf_event__fprintf(event, machine, stdout);
2358

2359
	thread__put(thread);
2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380

	return 0;
}

static int print_event(struct perf_tool *tool, union perf_event *event,
		       struct perf_sample *sample, struct machine *machine,
		       pid_t pid, pid_t tid)
{
	return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
}

static int process_comm_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
	if (perf_event__process_comm(tool, event, sample, machine) < 0)
		return -1;

	return print_event(tool, event, sample, machine, event->comm.pid,
			   event->comm.tid);
2381 2382
}

2383 2384 2385 2386 2387 2388
static int process_namespaces_event(struct perf_tool *tool,
				    union perf_event *event,
				    struct perf_sample *sample,
				    struct machine *machine)
{
	if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2389
		return -1;
2390

2391 2392
	return print_event(tool, event, sample, machine, event->namespaces.pid,
			   event->namespaces.tid);
2393 2394
}

2395 2396 2397 2398 2399 2400
static int process_cgroup_event(struct perf_tool *tool,
				union perf_event *event,
				struct perf_sample *sample,
				struct machine *machine)
{
	if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2401
		return -1;
2402

2403 2404
	return print_event(tool, event, sample, machine, sample->pid,
			    sample->tid);
2405 2406
}

2407 2408 2409 2410 2411 2412 2413 2414
static int process_fork_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
	if (perf_event__process_fork(tool, event, sample, machine) < 0)
		return -1;

2415 2416 2417
	return print_event_with_time(tool, event, sample, machine,
				     event->fork.pid, event->fork.tid,
				     event->fork.time);
2418 2419 2420 2421 2422 2423
}
static int process_exit_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
2424 2425 2426
	/* Print before 'exit' deletes anything */
	if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
				  event->fork.tid, event->fork.time))
2427 2428
		return -1;

2429
	return perf_event__process_exit(tool, event, sample, machine);
2430 2431
}

2432 2433 2434 2435 2436 2437 2438 2439
static int process_mmap_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
	if (perf_event__process_mmap(tool, event, sample, machine) < 0)
		return -1;

2440 2441
	return print_event(tool, event, sample, machine, event->mmap.pid,
			   event->mmap.tid);
2442 2443 2444 2445 2446 2447 2448 2449 2450 2451
}

static int process_mmap2_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
	if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
		return -1;

2452 2453
	return print_event(tool, event, sample, machine, event->mmap2.pid,
			   event->mmap2.tid);
2454 2455
}

2456 2457 2458 2459 2460 2461 2462 2463 2464 2465
static int process_switch_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);

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

2466 2467 2468 2469 2470 2471
	if (scripting_ops && scripting_ops->process_switch)
		scripting_ops->process_switch(event, sample, machine);

	if (!script->show_switch_events)
		return 0;

2472 2473
	return print_event(tool, event, sample, machine, sample->pid,
			   sample->tid);
2474 2475
}

2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486
static int process_auxtrace_error(struct perf_session *session,
				  union perf_event *event)
{
	if (scripting_ops && scripting_ops->process_auxtrace_error) {
		scripting_ops->process_auxtrace_error(session, event);
		return 0;
	}

	return perf_event__process_auxtrace_error(session, event);
}

2487 2488 2489 2490 2491 2492
static int
process_lost_event(struct perf_tool *tool,
		   union perf_event *event,
		   struct perf_sample *sample,
		   struct machine *machine)
{
2493 2494
	return print_event(tool, event, sample, machine, sample->pid,
			   sample->tid);
2495 2496
}

2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507
static int
process_throttle_event(struct perf_tool *tool __maybe_unused,
		       union perf_event *event,
		       struct perf_sample *sample,
		       struct machine *machine)
{
	if (scripting_ops && scripting_ops->process_throttle)
		scripting_ops->process_throttle(event, sample, machine);
	return 0;
}

2508 2509 2510 2511 2512 2513
static int
process_finished_round_event(struct perf_tool *tool __maybe_unused,
			     union perf_event *event,
			     struct ordered_events *oe __maybe_unused)

{
2514
	perf_event__fprintf(event, NULL, stdout);
2515 2516 2517
	return 0;
}

2518 2519 2520 2521 2522 2523 2524 2525 2526
static int
process_bpf_events(struct perf_tool *tool __maybe_unused,
		   union perf_event *event,
		   struct perf_sample *sample,
		   struct machine *machine)
{
	if (machine__process_ksymbol(machine, event, sample) < 0)
		return -1;

2527 2528
	return print_event(tool, event, sample, machine, sample->pid,
			   sample->tid);
2529 2530
}

2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542
static int process_text_poke_events(struct perf_tool *tool,
				    union perf_event *event,
				    struct perf_sample *sample,
				    struct machine *machine)
{
	if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
		return -1;

	return print_event(tool, event, sample, machine, sample->pid,
			   sample->tid);
}

2543
static void sig_handler(int sig __maybe_unused)
2544 2545 2546 2547
{
	session_done = 1;
}

2548 2549
static void perf_script__fclose_per_event_dump(struct perf_script *script)
{
2550
	struct evlist *evlist = script->session->evlist;
2551
	struct evsel *evsel;
2552 2553 2554 2555

	evlist__for_each_entry(evlist, evsel) {
		if (!evsel->priv)
			break;
2556
		evsel_script__delete(evsel->priv);
2557 2558 2559 2560 2561 2562
		evsel->priv = NULL;
	}
}

static int perf_script__fopen_per_event_dump(struct perf_script *script)
{
2563
	struct evsel *evsel;
2564 2565

	evlist__for_each_entry(script->session->evlist, evsel) {
2566 2567 2568
		/*
		 * Already setup? I.e. we may be called twice in cases like
		 * Intel PT, one for the intel_pt// and dummy events, then
2569
		 * for the evsels synthesized from the auxtrace info.
2570 2571 2572 2573 2574 2575
		 *
		 * Ses perf_script__process_auxtrace_info.
		 */
		if (evsel->priv != NULL)
			continue;

2576
		evsel->priv = evsel_script__new(evsel, script->session->data);
2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589
		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)
{
2590 2591
	struct evsel *evsel;
	static struct evsel_script es_stdout;
2592 2593 2594 2595

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

2596 2597
	es_stdout.fp = stdout;

2598
	evlist__for_each_entry(script->session->evlist, evsel)
2599
		evsel->priv = &es_stdout;
2600 2601 2602 2603

	return 0;
}

2604 2605
static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
{
2606
	struct evsel *evsel;
2607 2608

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

2611 2612
		evsel_script__fprintf(es, stdout);
		evsel_script__delete(es);
2613 2614 2615 2616
		evsel->priv = NULL;
	}
}

2617 2618 2619 2620 2621 2622
static void perf_script__exit(struct perf_script *script)
{
	perf_thread_map__put(script->threads);
	perf_cpu_map__put(script->cpus);
}

2623
static int __cmd_script(struct perf_script *script)
F
Frederic Weisbecker 已提交
2624
{
2625 2626
	int ret;

2627 2628
	signal(SIGINT, sig_handler);

2629 2630
	perf_stat__init_shadow_stats();

2631 2632 2633 2634 2635 2636
	/* 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;
	}
2637 2638 2639 2640
	if (script->show_mmap_events) {
		script->tool.mmap = process_mmap_event;
		script->tool.mmap2 = process_mmap2_event;
	}
2641
	if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2642
		script->tool.context_switch = process_switch_event;
2643 2644
	if (scripting_ops && scripting_ops->process_auxtrace_error)
		script->tool.auxtrace_error = process_auxtrace_error;
2645 2646
	if (script->show_namespace_events)
		script->tool.namespaces = process_namespaces_event;
2647 2648
	if (script->show_cgroup_events)
		script->tool.cgroup = process_cgroup_event;
2649 2650
	if (script->show_lost_events)
		script->tool.lost = process_lost_event;
2651 2652 2653 2654
	if (script->show_round_events) {
		script->tool.ordered_events = false;
		script->tool.finished_round = process_finished_round_event;
	}
2655
	if (script->show_bpf_events) {
2656 2657
		script->tool.ksymbol = process_bpf_events;
		script->tool.bpf     = process_bpf_events;
2658
	}
2659 2660 2661 2662
	if (script->show_text_poke_events) {
		script->tool.ksymbol   = process_bpf_events;
		script->tool.text_poke = process_text_poke_events;
	}
2663

2664 2665 2666 2667 2668
	if (perf_script__setup_per_event_dump(script)) {
		pr_err("Couldn't create the per event dump files\n");
		return -1;
	}

2669
	ret = perf_session__process_events(script->session);
2670

2671
	if (script->per_event_dump)
2672
		perf_script__exit_per_event_dump_stats(script);
2673

2674
	if (debug_mode)
2675
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2676 2677

	return ret;
F
Frederic Weisbecker 已提交
2678 2679
}

T
Tom Zanussi 已提交
2680 2681 2682
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
2683
	char			spec[];
T
Tom Zanussi 已提交
2684 2685
};

2686
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723

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;

2724
	s = script_spec__new(spec, ops);
T
Tom Zanussi 已提交
2725 2726
	if (!s)
		return -1;
2727 2728
	else
		script_spec__add(s);
T
Tom Zanussi 已提交
2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747

	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 "
2748
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
2749 2750 2751 2752 2753 2754 2755

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

	fprintf(stderr, "\n");
}

2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786
/* Find script file relative to current directory or exec path */
static char *find_script(const char *script)
{
	char path[PATH_MAX];

	if (!scripting_ops) {
		const char *ext = strrchr(script, '.');

		if (!ext)
			return NULL;

		scripting_ops = script_spec__lookup(++ext);
		if (!scripting_ops)
			return NULL;
	}

	if (access(script, R_OK)) {
		char *exec_path = get_argv_exec_path();

		if (!exec_path)
			return NULL;
		snprintf(path, sizeof(path), "%s/scripts/%s/%s",
			 exec_path, scripting_ops->dirname, script);
		free(exec_path);
		script = path;
		if (access(script, R_OK))
			return NULL;
	}
	return strdup(script);
}

2787 2788
static int parse_scriptname(const struct option *opt __maybe_unused,
			    const char *str, int unset __maybe_unused)
T
Tom Zanussi 已提交
2789 2790 2791 2792 2793
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

2794
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
2795
		list_available_languages();
2796
		exit(0);
T
Tom Zanussi 已提交
2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815
	}

	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;
2816
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827
		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;
		}
	}

2828 2829 2830
	script_name = find_script(script);
	if (!script_name)
		script_name = strdup(script);
T
Tom Zanussi 已提交
2831 2832 2833 2834

	return 0;
}

2835 2836
static int parse_output_fields(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused)
2837
{
2838
	char *tok, *strtok_saveptr = NULL;
2839
	int i, imax = ARRAY_SIZE(all_output_options);
2840
	int j;
2841 2842
	int rc = 0;
	char *str = strdup(arg);
2843
	int type = -1;
2844
	enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2845 2846 2847 2848

	if (!str)
		return -ENOMEM;

2849 2850 2851
	/* 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.
2852
	 */
2853 2854 2855 2856 2857 2858 2859 2860 2861 2862
	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;
2863 2864
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
2865 2866
		else if (!strcmp(str, "break"))
			type = PERF_TYPE_BREAKPOINT;
2867 2868
		else if (!strcmp(str, "synth"))
			type = OUTPUT_TYPE_SYNTH;
2869 2870
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
2871 2872
			rc = -EINVAL;
			goto out;
2873 2874 2875 2876 2877 2878
		}

		if (output[type].user_set)
			pr_warning("Overriding previous field request for %s events.\n",
				   event_type(type));

2879 2880 2881 2882
		/* Don't override defaults for +- */
		if (strchr(tok, '+') || strchr(tok, '-'))
			goto parse;

2883 2884
		output[type].fields = 0;
		output[type].user_set = true;
2885
		output[type].wildcard_set = false;
2886 2887 2888 2889 2890 2891 2892 2893 2894 2895

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

2896 2897 2898 2899
		/* Don't override defaults for +- */
		if (strchr(str, '+') || strchr(str, '-'))
			goto parse;

2900 2901 2902
		if (output_set_by_user())
			pr_warning("Overriding previous field request for all events.\n");

2903
		for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2904 2905
			output[j].fields = 0;
			output[j].user_set = true;
2906
			output[j].wildcard_set = true;
2907
		}
2908 2909
	}

2910
parse:
2911
	for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927
		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;
		}

2928
		for (i = 0; i < imax; ++i) {
2929
			if (strcmp(tok, all_output_options[i].str) == 0)
2930 2931
				break;
		}
2932
		if (i == imax && strcmp(tok, "flags") == 0) {
Y
Yang Li 已提交
2933
			print_flags = change != REMOVE;
2934 2935
			continue;
		}
2936
		if (i == imax) {
2937
			fprintf(stderr, "Invalid field requested.\n");
2938
			rc = -EINVAL;
2939
			goto out;
2940 2941
		}

2942 2943 2944 2945
		if (type == -1) {
			/* add user option to all events types for
			 * which it is valid
			 */
2946
			for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2947 2948 2949
				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));
2950
				} else {
2951
					if (change == REMOVE) {
2952
						output[j].fields &= ~all_output_options[i].field;
2953
						output[j].user_set_fields &= ~all_output_options[i].field;
2954
						output[j].user_unset_fields |= all_output_options[i].field;
2955
					} else {
2956
						output[j].fields |= all_output_options[i].field;
2957
						output[j].user_set_fields |= all_output_options[i].field;
2958
						output[j].user_unset_fields &= ~all_output_options[i].field;
2959
					}
2960 2961
					output[j].user_set = true;
					output[j].wildcard_set = true;
2962
				}
2963 2964 2965 2966 2967 2968 2969 2970 2971
			}
		} 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;
			}
2972 2973 2974 2975
			if (change == REMOVE)
				output[type].fields &= ~all_output_options[i].field;
			else
				output[type].fields |= all_output_options[i].field;
2976 2977
			output[type].user_set = true;
			output[type].wildcard_set = true;
2978
		}
2979 2980
	}

2981 2982 2983 2984 2985 2986
	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));
		}
	}
2987
	goto out;
2988

2989 2990 2991
out_badmix:
	fprintf(stderr, "Cannot mix +-field with overridden fields\n");
	rc = -EINVAL;
2992
out:
2993 2994 2995 2996
	free(str);
	return rc;
}

2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009
#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)))
3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021


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

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

3022
static LIST_HEAD(script_descs);
3023 3024 3025 3026 3027

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

3028
	if (s != NULL && name)
3029 3030 3031 3032 3033 3034 3035
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
3036 3037 3038
	zfree(&s->name);
	zfree(&s->half_liner);
	zfree(&s->args);
3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065
	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)
3066
		return NULL;
3067 3068 3069 3070 3071 3072

	script_desc__add(s);

	return s;
}

3073
static const char *ends_with(const char *str, const char *suffix)
3074 3075
{
	size_t suffix_len = strlen(suffix);
3076
	const char *p = str;
3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096

	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)) {
3097
		p = skip_spaces(line);
3098 3099 3100 3101 3102 3103 3104 3105
		if (strlen(p) == 0)
			continue;
		if (*p != '#')
			continue;
		p++;
		if (strlen(p) && *p == '!')
			continue;

3106
		p = skip_spaces(p);
3107 3108 3109 3110 3111
		if (strlen(p) && p[strlen(p) - 1] == '\n')
			p[strlen(p) - 1] = '\0';

		if (!strncmp(p, "description:", strlen("description:"))) {
			p += strlen("description:");
3112
			desc->half_liner = strdup(skip_spaces(p));
3113 3114 3115 3116 3117
			continue;
		}

		if (!strncmp(p, "args:", strlen("args:"))) {
			p += strlen("args:");
3118
			desc->args = strdup(skip_spaces(p));
3119 3120 3121 3122 3123 3124 3125 3126 3127
			continue;
		}
	}

	fclose(fp);

	return 0;
}

3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145
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;
}

3146 3147 3148
static int list_available_scripts(const struct option *opt __maybe_unused,
				  const char *s __maybe_unused,
				  int unset __maybe_unused)
3149
{
3150
	struct dirent *script_dirent, *lang_dirent;
3151 3152 3153 3154 3155 3156 3157 3158
	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;

3159
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3160 3161

	scripts_dir = opendir(scripts_path);
3162 3163 3164 3165 3166 3167 3168
	if (!scripts_dir) {
		fprintf(stdout,
			"open(%s) failed.\n"
			"Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
			scripts_path);
		exit(-1);
	}
3169

3170
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3171 3172
		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			  lang_dirent->d_name);
3173 3174 3175 3176
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

3177 3178
		for_each_script(lang_path, lang_dir, script_dirent) {
			script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3179
			if (script_root) {
3180
				desc = script_desc__findnew(script_root);
3181 3182
				scnprintf(script_path, MAXPATHLEN, "%s/%s",
					  lang_path, script_dirent->d_name);
3183
				read_script_info(desc, script_path);
3184
				free(script_root);
3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199
			}
		}
	}

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

3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227
static int add_dlarg(const struct option *opt __maybe_unused,
		     const char *s, int unset __maybe_unused)
{
	char *arg = strdup(s);
	void *a;

	if (!arg)
		return -1;

	a = realloc(dlargv, sizeof(dlargv[0]) * (dlargc + 1));
	if (!a) {
		free(arg);
		return -1;
	}

	dlargv = a;
	dlargv[dlargc++] = arg;

	return 0;
}

static void free_dlarg(void)
{
	while (dlargc--)
		free(dlargv[dlargc]);
	free(dlargv);
}

3228 3229 3230 3231 3232 3233 3234
/*
 * 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
3235
 * cover the future complex formats like event groups etc.
3236 3237 3238 3239 3240 3241
 */
static int check_ev_match(char *dir_name, char *scriptname,
			struct perf_session *session)
{
	char filename[MAXPATHLEN], evname[128];
	char line[BUFSIZ], *p;
3242
	struct evsel *pos;
3243 3244 3245
	int match, len;
	FILE *fp;

3246
	scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3247 3248 3249 3250 3251 3252

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

	while (fgets(line, sizeof(line), fp)) {
3253
		p = skip_spaces(line);
3254 3255 3256 3257 3258 3259 3260 3261 3262
		if (*p == '#')
			continue;

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

			p += 2;
3263
			p = skip_spaces(p);
3264 3265 3266 3267 3268 3269 3270
			len = strcspn(p, " \t");
			if (!len)
				break;

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

			match = 0;
3271
			evlist__for_each_entry(session->evlist, pos) {
3272
				if (!strcmp(evsel__name(pos), evname)) {
3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288
					match = 1;
					break;
				}
			}

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

	fclose(fp);
	return 0;
}

3289 3290 3291 3292 3293 3294 3295
/*
 * 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.
 */
3296 3297
int find_scripts(char **scripts_array, char **scripts_path_array, int num,
		 int pathlen)
3298
{
3299
	struct dirent *script_dirent, *lang_dirent;
3300
	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3301
	DIR *scripts_dir, *lang_dir;
3302
	struct perf_session *session;
3303
	struct perf_data data = {
J
Jiri Olsa 已提交
3304 3305
		.path = input_name,
		.mode = PERF_DATA_MODE_READ,
3306
	};
3307 3308 3309
	char *temp;
	int i = 0;

3310
	session = perf_session__new(&data, NULL);
3311 3312
	if (IS_ERR(session))
		return PTR_ERR(session);
3313

3314
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3315 3316

	scripts_dir = opendir(scripts_path);
3317 3318
	if (!scripts_dir) {
		perf_session__delete(session);
3319
		return -1;
3320
	}
3321

3322
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3323 3324
		scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
			  lang_dirent->d_name);
3325
#ifndef HAVE_LIBPERL_SUPPORT
3326 3327 3328
		if (strstr(lang_path, "perl"))
			continue;
#endif
3329
#ifndef HAVE_LIBPYTHON_SUPPORT
3330 3331 3332 3333 3334 3335 3336 3337
		if (strstr(lang_path, "python"))
			continue;
#endif

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

3338
		for_each_script(lang_path, lang_dir, script_dirent) {
3339
			/* Skip those real time scripts: xxxtop.p[yl] */
3340
			if (strstr(script_dirent->d_name, "top."))
3341
				continue;
3342 3343 3344 3345
			if (i >= num)
				break;
			snprintf(scripts_path_array[i], pathlen, "%s/%s",
				lang_path,
3346 3347
				script_dirent->d_name);
			temp = strchr(script_dirent->d_name, '.');
3348
			snprintf(scripts_array[i],
3349 3350
				(temp - script_dirent->d_name) + 1,
				"%s", script_dirent->d_name);
3351 3352 3353 3354 3355

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

3356 3357
			i++;
		}
3358
		closedir(lang_dir);
3359 3360
	}

3361 3362
	closedir(scripts_dir);
	perf_session__delete(session);
3363 3364 3365
	return i;
}

3366 3367
static char *get_script_path(const char *script_root, const char *suffix)
{
3368
	struct dirent *script_dirent, *lang_dirent;
3369 3370 3371 3372
	char scripts_path[MAXPATHLEN];
	char script_path[MAXPATHLEN];
	DIR *scripts_dir, *lang_dir;
	char lang_path[MAXPATHLEN];
3373
	char *__script_root;
3374

3375
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3376 3377 3378 3379 3380

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

3381
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3382 3383
		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			  lang_dirent->d_name);
3384 3385 3386 3387
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

3388 3389
		for_each_script(lang_path, lang_dir, script_dirent) {
			__script_root = get_script_root(script_dirent, suffix);
3390 3391
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
3392
				closedir(scripts_dir);
3393 3394
				scnprintf(script_path, MAXPATHLEN, "%s/%s",
					  lang_path, script_dirent->d_name);
3395
				closedir(lang_dir);
3396
				return strdup(script_path);
3397 3398 3399
			}
			free(__script_root);
		}
3400
		closedir(lang_dir);
3401
	}
3402
	closedir(scripts_dir);
3403

3404
	return NULL;
3405 3406
}

3407 3408
static bool is_top_script(const char *script_path)
{
Y
Yang Li 已提交
3409
	return ends_with(script_path, "top") != NULL;
3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434
}

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

3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447
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 已提交
3448

3449 3450 3451 3452 3453
	system_wide = (argc == 0);

	return 0;
}

3454 3455 3456
static void script__setup_sample_type(struct perf_script *script)
{
	struct perf_session *session = script->session;
3457
	u64 sample_type = evlist__combined_sample_type(session->evlist);
3458 3459 3460

	if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
		if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3461
		    (sample_type & PERF_SAMPLE_STACK_USER)) {
3462
			callchain_param.record_mode = CALLCHAIN_DWARF;
3463 3464
			dwarf_callchain_users = true;
		} else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3465 3466 3467 3468
			callchain_param.record_mode = CALLCHAIN_LBR;
		else
			callchain_param.record_mode = CALLCHAIN_FP;
	}
3469 3470 3471 3472 3473 3474

	if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
		pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
			   "Please apply --call-graph lbr when recording.\n");
		script->stitch_lbr = false;
	}
3475 3476
}

3477 3478
static int process_stat_round_event(struct perf_session *session,
				    union perf_event *event)
3479
{
3480
	struct perf_record_stat_round *round = &event->stat_round;
3481
	struct evsel *counter;
3482

3483
	evlist__for_each_entry(session->evlist, counter) {
3484 3485 3486 3487 3488 3489 3490 3491
		perf_stat_process_counter(&stat_config, counter);
		process_stat(counter, round->time);
	}

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

3492 3493
static int process_stat_config_event(struct perf_session *session __maybe_unused,
				     union perf_event *event)
3494 3495 3496 3497 3498
{
	perf_event__read_stat_config(&stat_config, &event->stat_config);
	return 0;
}

3499 3500
static int set_maps(struct perf_script *script)
{
3501
	struct evlist *evlist = script->session->evlist;
3502 3503 3504 3505 3506 3507 3508

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

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

3509
	perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3510

3511
	if (evlist__alloc_stats(evlist, true))
3512 3513 3514 3515 3516 3517 3518
		return -ENOMEM;

	script->allocated = true;
	return 0;
}

static
3519 3520
int process_thread_map_event(struct perf_session *session,
			     union perf_event *event)
3521
{
3522
	struct perf_tool *tool = session->tool;
3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537
	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
3538 3539
int process_cpu_map_event(struct perf_session *session,
			  union perf_event *event)
3540
{
3541
	struct perf_tool *tool = session->tool;
3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555
	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);
}

3556 3557
static int process_feature_event(struct perf_session *session,
				 union perf_event *event)
3558 3559
{
	if (event->feat.feat_id < HEADER_LAST_FEATURE)
3560
		return perf_event__process_feature(session, event);
3561 3562 3563
	return 0;
}

3564
#ifdef HAVE_AUXTRACE_SUPPORT
3565 3566
static int perf_script__process_auxtrace_info(struct perf_session *session,
					      union perf_event *event)
3567
{
3568 3569 3570
	struct perf_tool *tool = session->tool;

	int ret = perf_event__process_auxtrace_info(session, event);
3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583

	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

3584 3585 3586 3587 3588 3589
static int parse_insn_trace(const struct option *opt __maybe_unused,
			    const char *str __maybe_unused,
			    int unset __maybe_unused)
{
	parse_output_fields(NULL, "+insn,-event,-period", 0);
	itrace_parse_synth_opts(opt, "i0ns", 0);
3590
	symbol_conf.nanosecs = true;
3591 3592 3593 3594 3595 3596 3597
	return 0;
}

static int parse_xed(const struct option *opt __maybe_unused,
		     const char *str __maybe_unused,
		     int unset __maybe_unused)
{
3598 3599 3600 3601
	if (isatty(1))
		force_pager("xed -F insn: -A -64 | less");
	else
		force_pager("xed -F insn: -A -64");
3602 3603 3604
	return 0;
}

3605 3606 3607 3608 3609 3610
static int parse_call_trace(const struct option *opt __maybe_unused,
			    const char *str __maybe_unused,
			    int unset __maybe_unused)
{
	parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
	itrace_parse_synth_opts(opt, "cewp", 0);
3611
	symbol_conf.nanosecs = true;
3612
	symbol_conf.pad_output_len_dso = 50;
3613 3614 3615 3616 3617 3618 3619 3620 3621
	return 0;
}

static int parse_callret_trace(const struct option *opt __maybe_unused,
			    const char *str __maybe_unused,
			    int unset __maybe_unused)
{
	parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
	itrace_parse_synth_opts(opt, "crewp", 0);
3622
	symbol_conf.nanosecs = true;
3623 3624 3625
	return 0;
}

3626
int cmd_script(int argc, const char **argv)
3627 3628
{
	bool show_full_info = false;
3629 3630
	bool header = false;
	bool header_only = false;
3631
	bool script_started = false;
3632 3633 3634
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
	struct perf_session *session;
3635 3636 3637 3638
	struct itrace_synth_opts itrace_synth_opts = {
		.set = false,
		.default_no_sample = true,
	};
3639
	struct utsname uts;
3640
	char *script_path = NULL;
3641
	const char *dlfilter_file = NULL;
3642
	const char **__argv;
3643
	int i, j, err = 0;
3644 3645 3646 3647 3648 3649
	struct perf_script script = {
		.tool = {
			.sample		 = process_sample_event,
			.mmap		 = perf_event__process_mmap,
			.mmap2		 = perf_event__process_mmap2,
			.comm		 = perf_event__process_comm,
3650
			.namespaces	 = perf_event__process_namespaces,
3651
			.cgroup		 = perf_event__process_cgroup,
3652 3653
			.exit		 = perf_event__process_exit,
			.fork		 = perf_event__process_fork,
3654
			.attr		 = process_attr,
3655
			.event_update   = perf_event__process_event_update,
3656
			.tracing_data	 = perf_event__process_tracing_data,
3657
			.feature	 = process_feature_event,
3658
			.build_id	 = perf_event__process_build_id,
3659
			.id_index	 = perf_event__process_id_index,
3660
			.auxtrace_info	 = perf_script__process_auxtrace_info,
3661 3662
			.auxtrace	 = perf_event__process_auxtrace,
			.auxtrace_error	 = perf_event__process_auxtrace_error,
3663 3664
			.stat		 = perf_event__process_stat_event,
			.stat_round	 = process_stat_round_event,
3665
			.stat_config	 = process_stat_config_event,
3666 3667
			.thread_map	 = process_thread_map_event,
			.cpu_map	 = process_cpu_map_event,
3668 3669
			.throttle	 = process_throttle_event,
			.unthrottle	 = process_throttle_event,
3670
			.ordered_events	 = true,
3671 3672 3673
			.ordering_requires_timestamps = true,
		},
	};
3674
	struct perf_data data = {
3675 3676
		.mode = PERF_DATA_MODE_READ,
	};
3677
	const struct option options[] = {
F
Frederic Weisbecker 已提交
3678 3679
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
3680
	OPT_INCR('v', "verbose", &verbose,
3681
		 "be more verbose (show symbol address, etc)"),
3682
	OPT_BOOLEAN('L', "Latency", &latency_format,
3683
		    "show latency attributes (irqs/preemption disabled, etc)"),
3684 3685
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
3686 3687
	OPT_CALLBACK_NOOPT(0, "list-dlfilters", NULL, NULL, "list available dlfilters",
			   list_available_dlfilters),
T
Tom Zanussi 已提交
3688 3689 3690 3691
	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",
3692
		   "generate perf-script.xx script in specified language"),
3693
	OPT_STRING(0, "dlfilter", &dlfilter_file, "file", "filter .so file name"),
3694 3695
	OPT_CALLBACK(0, "dlarg", NULL, "argument", "filter argument",
		     add_dlarg),
3696
	OPT_STRING('i', "input", &input_name, "file", "input file name"),
3697 3698
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
3699 3700
	OPT_BOOLEAN(0, "header", &header, "Show data header."),
	OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3701 3702 3703 3704 3705 3706
	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"),
3707 3708 3709
	OPT_CALLBACK(0, "symfs", NULL, "directory",
		     "Look for files with symbols relative to this directory",
		     symbol__config_symfs),
3710
	OPT_CALLBACK('F', "fields", NULL, "str",
3711
		     "comma separated output fields prepend with 'type:'. "
3712
		     "+field to add and -field to remove."
3713
		     "Valid types: hw,sw,trace,raw,synth. "
3714
		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3715 3716
		     "addr,symoff,srcline,period,iregs,uregs,brstack,"
		     "brstacksym,flags,bpf-output,brstackinsn,brstackoff,"
K
Kan Liang 已提交
3717
		     "callindent,insn,insnlen,synth,phys_addr,metric,misc,ipc,tod,"
3718
		     "data_page_size,code_page_size",
3719
		     parse_output_fields),
3720
	OPT_BOOLEAN('a', "all-cpus", &system_wide,
3721
		    "system-wide collection from all CPUs"),
3722 3723
	OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
		   "only consider symbols in these DSOs"),
3724 3725
	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
		   "only consider these symbols"),
3726 3727
	OPT_INTEGER(0, "addr-range", &symbol_conf.addr_range,
		    "Use with -S to list traced records within address range"),
3728 3729 3730 3731
	OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
			"Decode instructions from itrace", parse_insn_trace),
	OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
			"Run xed disassembler on output", parse_xed),
3732 3733 3734 3735
	OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
			"Decode calls from from itrace", parse_call_trace),
	OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
			"Decode calls and returns from itrace", parse_callret_trace),
3736 3737
	OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
			"Only print symbols and callees with --call-trace/--call-ret-trace"),
3738 3739
	OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
		   "Stop display of callgraph at these symbols"),
3740
	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3741 3742
	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only display events for these comms"),
3743 3744 3745 3746
	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"),
3747 3748 3749
	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. "
3750
		     "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
A
Andi Kleen 已提交
3751
	OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3752
	OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3753 3754
	OPT_BOOLEAN('I', "show-info", &show_full_info,
		    "display extended information from perf.data file"),
3755 3756
	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
		    "Show the path of [kernel.kallsyms]"),
3757 3758
	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
		    "Show the fork/comm/exit events"),
3759 3760
	OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
		    "Show the mmap events"),
3761 3762
	OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
		    "Show context switch events (if recorded)"),
3763 3764
	OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
		    "Show namespace events (if recorded)"),
3765 3766
	OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
		    "Show cgroup events (if recorded)"),
3767 3768
	OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
		    "Show lost events (if recorded)"),
3769 3770
	OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
		    "Show round events (if recorded)"),
3771 3772
	OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
		    "Show bpf related events (if recorded)"),
3773 3774
	OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
		    "Show text poke related events (if recorded)"),
3775 3776
	OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
		    "Dump trace output to files named by the monitored events"),
3777
	OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3778 3779
	OPT_INTEGER(0, "max-blocks", &max_blocks,
		    "Maximum number of code blocks to dump with brstackinsn"),
3780
	OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3781
		    "Use 9 decimal places when displaying time"),
3782
	OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3783
			    "Instruction Tracing options\n" ITRACE_HELP,
3784
			    itrace_parse_synth_opts),
3785 3786
	OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
			"Show full source file name path for source lines"),
3787 3788 3789 3790
	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
			"Enable symbol demangling"),
	OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
			"Enable kernel symbol demangling"),
3791 3792
	OPT_STRING(0, "time", &script.time_str, "str",
		   "Time span of interest (start,stop)"),
3793 3794
	OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
		    "Show inline function"),
3795 3796 3797 3798 3799 3800 3801 3802 3803
	OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
		   "guest mount directory under which every guest os"
		   " instance has a subdir"),
	OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
		   "file", "file saving guest os vmlinux"),
	OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
		   "file", "file saving guest os /proc/kallsyms"),
	OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
		   "file", "file saving guest os /proc/modules"),
3804 3805
	OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
		    "Enable LBR callgraph stitching approach"),
3806
	OPTS_EVSWITCH(&script.evswitch),
3807
	OPT_END()
3808
	};
3809 3810
	const char * const script_subcommands[] = { "record", "report", NULL };
	const char *script_usage[] = {
3811 3812 3813 3814 3815 3816 3817
		"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
	};
3818

3819 3820
	perf_set_singlethreaded();

3821 3822
	setup_scripting();

3823
	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3824 3825
			     PARSE_OPT_STOP_AT_NON_OPTION);

3826 3827 3828 3829 3830 3831 3832 3833 3834 3835
	if (symbol_conf.guestmount ||
	    symbol_conf.default_guest_vmlinux_name ||
	    symbol_conf.default_guest_kallsyms ||
	    symbol_conf.default_guest_modules) {
		/*
		 * Enable guest sample processing.
		 */
		perf_guest = true;
	}

J
Jiri Olsa 已提交
3836 3837
	data.path  = input_name;
	data.force = symbol_conf.force;
3838

3839 3840 3841
	if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
		rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
		if (!rec_script_path)
3842
			return cmd_record(argc, argv);
3843 3844
	}

3845 3846 3847
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
3848
			fprintf(stderr,
3849
				"Please specify a valid report script"
3850
				"(see 'perf script -l' for listing)\n");
3851 3852 3853 3854
			return -1;
		}
	}

3855 3856 3857 3858 3859 3860 3861
	if (reltime && deltatime) {
		fprintf(stderr,
			"reltime and deltatime - the two don't get along well. "
			"Please limit to --reltime or --deltatime.\n");
		return -1;
	}

3862
	if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
3863 3864 3865
	    itrace_synth_opts.callchain_sz > scripting_max_stack)
		scripting_max_stack = itrace_synth_opts.callchain_sz;

3866
	/* make sure PERF_EXEC_PATH is set for scripts */
3867
	set_argv_exec_path(get_argv_exec_path());
3868

3869
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
3870
		int live_pipe[2];
3871
		int rep_args;
3872 3873
		pid_t pid;

3874 3875 3876 3877
		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) {
3878 3879 3880 3881 3882 3883
			script_name = find_script(argv[0]);
			if (script_name) {
				argc -= 1;
				argv += 1;
				goto script_found;
			}
3884 3885
			usage_with_options_msg(script_usage, options,
				"Couldn't find script `%s'\n\n See perf"
3886
				" script -l for available scripts.\n", argv[0]);
3887 3888
		}

3889 3890 3891 3892 3893 3894 3895 3896
		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) {
3897 3898
				usage_with_options_msg(script_usage, options,
					"`%s' script requires options."
3899
					"\n\n See perf script -l for available "
3900 3901
					"scripts and options.\n", argv[0]);
			}
3902 3903 3904 3905
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
3906
			return -1;
3907 3908 3909 3910 3911
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
3912
			return -1;
3913 3914 3915
		}

		if (!pid) {
3916 3917
			j = 0;

3918 3919 3920
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

3921 3922 3923
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
3924 3925 3926 3927
				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
					err = -1;
					goto out;
				}
3928
			}
3929 3930

			__argv = malloc((argc + 6) * sizeof(const char *));
3931 3932 3933 3934 3935
			if (!__argv) {
				pr_err("malloc failed\n");
				err = -ENOMEM;
				goto out;
			}
3936

3937 3938 3939 3940 3941 3942 3943 3944 3945 3946
			__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;
3947 3948

			execvp("/bin/sh", (char **)__argv);
3949
			free(__argv);
3950 3951 3952 3953 3954 3955
			exit(-1);
		}

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

3956
		__argv = malloc((argc + 4) * sizeof(const char *));
3957 3958 3959 3960 3961 3962
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

3963 3964 3965 3966 3967 3968 3969 3970
		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;
3971 3972

		execvp("/bin/sh", (char **)__argv);
3973
		free(__argv);
3974 3975
		exit(-1);
	}
3976
script_found:
3977 3978 3979 3980
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
3981

3982 3983
	if (script_path) {
		j = 0;
3984

3985 3986
		if (!rec_script_path)
			system_wide = false;
3987 3988 3989 3990 3991 3992
		else if (!system_wide) {
			if (have_cmd(argc - 1, &argv[1]) != 0) {
				err = -1;
				goto out;
			}
		}
3993

3994
		__argv = malloc((argc + 2) * sizeof(const char *));
3995 3996 3997 3998 3999 4000
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

4001 4002 4003 4004
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
4005
		for (i = 2; i < argc; i++)
4006 4007
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
4008 4009

		execvp("/bin/sh", (char **)__argv);
4010
		free(__argv);
4011 4012
		exit(-1);
	}
T
Tom Zanussi 已提交
4013

4014
	if (dlfilter_file) {
4015
		dlfilter = dlfilter__new(dlfilter_file, dlargc, dlargv);
4016 4017 4018 4019
		if (!dlfilter)
			return -1;
	}

4020
	if (!script_name) {
4021
		setup_pager();
4022 4023
		use_browser = 0;
	}
F
Frederic Weisbecker 已提交
4024

4025
	session = perf_session__new(&data, &script.tool);
4026 4027
	if (IS_ERR(session))
		return PTR_ERR(session);
4028

4029
	if (header || header_only) {
4030
		script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
4031 4032
		perf_session__fprintf_info(session, stdout, show_full_info);
		if (header_only)
4033
			goto out_delete;
4034
	}
4035 4036
	if (show_full_info)
		script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
4037

4038
	if (symbol__init(&session->header.env) < 0)
4039 4040
		goto out_delete;

4041
	uname(&uts);
4042 4043
	if (data.is_pipe ||  /* assume pipe_mode indicates native_arch */
	    !strcmp(uts.machine, session->header.env.arch) ||
4044 4045 4046 4047
	    (!strcmp(uts.machine, "x86_64") &&
	     !strcmp(session->header.env.arch, "i386")))
		native_arch = true;

4048
	script.session = session;
4049
	script__setup_sample_type(&script);
4050

4051 4052
	if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
	    symbol_conf.graph_function)
4053 4054
		itrace_synth_opts.thread_stack = true;

4055 4056
	session->itrace_synth_opts = &itrace_synth_opts;

4057
	if (cpu_list) {
4058 4059 4060
		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
		if (err < 0)
			goto out_delete;
4061
		itrace_synth_opts.cpu_bitmap = cpu_bitmap;
4062 4063
	}

4064
	if (!no_callchain)
4065 4066 4067 4068
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

4069
	if (session->tevent.pevent &&
4070 4071 4072
	    tep_set_function_resolver(session->tevent.pevent,
				      machine__resolve_kernel_addr,
				      &session->machines.host) < 0) {
4073
		pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
4074 4075
		err = -1;
		goto out_delete;
4076 4077
	}

T
Tom Zanussi 已提交
4078 4079
	if (generate_script_lang) {
		struct stat perf_stat;
4080 4081
		int input;

4082
		if (output_set_by_user()) {
4083 4084
			fprintf(stderr,
				"custom fields not supported for generated scripts");
4085 4086
			err = -EINVAL;
			goto out_delete;
4087
		}
T
Tom Zanussi 已提交
4088

J
Jiri Olsa 已提交
4089
		input = open(data.path, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
4090
		if (input < 0) {
4091
			err = -errno;
T
Tom Zanussi 已提交
4092
			perror("failed to open file");
4093
			goto out_delete;
T
Tom Zanussi 已提交
4094 4095 4096 4097 4098
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
4099
			goto out_delete;
T
Tom Zanussi 已提交
4100 4101 4102 4103
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
4104
			goto out_delete;
T
Tom Zanussi 已提交
4105 4106 4107 4108 4109
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
4110 4111
			err = -ENOENT;
			goto out_delete;
T
Tom Zanussi 已提交
4112 4113
		}

J
Jiri Olsa 已提交
4114
		err = scripting_ops->generate_script(session->tevent.pevent,
4115
						     "perf-script");
4116
		goto out_delete;
T
Tom Zanussi 已提交
4117 4118
	}

4119 4120 4121 4122
	err = dlfilter__start(dlfilter, session);
	if (err)
		goto out_delete;

T
Tom Zanussi 已提交
4123
	if (script_name) {
4124
		err = scripting_ops->start_script(script_name, argc, argv, session);
T
Tom Zanussi 已提交
4125
		if (err)
4126
			goto out_delete;
4127
		pr_debug("perf script started with script %s\n\n", script_name);
4128
		script_started = true;
T
Tom Zanussi 已提交
4129 4130
	}

4131 4132 4133

	err = perf_session__check_output_opt(session);
	if (err < 0)
4134
		goto out_delete;
4135

4136
	if (script.time_str) {
4137
		err = perf_time__parse_for_ranges_reltime(script.time_str, session,
4138 4139
						  &script.ptime_range,
						  &script.range_size,
4140 4141
						  &script.range_num,
						  reltime);
4142
		if (err < 0)
4143
			goto out_delete;
4144 4145 4146 4147

		itrace_synth_opts__set_time_range(&itrace_synth_opts,
						  script.ptime_range,
						  script.range_num);
4148 4149
	}

4150 4151 4152
	err = evswitch__init(&script.evswitch, session->evlist, stderr);
	if (err)
		goto out_delete;
4153

M
Milian Wolff 已提交
4154 4155 4156
	if (zstd_init(&(session->zstd_data), 0) < 0)
		pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");

4157
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
4158

4159 4160
	flush_scripting();

4161
out_delete:
4162 4163
	if (script.ptime_range) {
		itrace_synth_opts__clear_time_range(&itrace_synth_opts);
4164
		zfree(&script.ptime_range);
4165
	}
4166

4167
	zstd_fini(&(session->zstd_data));
4168
	evlist__free_stats(session->evlist);
4169
	perf_session__delete(session);
4170
	perf_script__exit(&script);
4171 4172 4173

	if (script_started)
		cleanup_scripting();
4174
	dlfilter__cleanup(dlfilter);
4175
	free_dlarg();
T
Tom Zanussi 已提交
4176 4177
out:
	return err;
F
Frederic Weisbecker 已提交
4178
}