builtin-script.c 108.9 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 374 375 376 377 378 379 380
}

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

381 382 383
static bool output_set_by_user(void)
{
	int j;
384
	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
385 386 387 388 389
		if (output[j].user_set)
			return true;
	}
	return false;
}
390

391 392 393 394 395 396 397 398 399 400 401 402 403 404
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;
}

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

407 408
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)
409
{
410
	struct perf_event_attr *attr = &evsel->core.attr;
411
	int type = output_type(attr->type);
412 413 414 415 416
	const char *evname;

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

417
	if (output[type].user_set_fields & field) {
418 419
		if (allow_user_set)
			return 0;
420
		evname = evsel__name(evsel);
421 422 423 424 425 426 427 428
		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;
429
	evname = evsel__name(evsel);
430 431 432 433 434 435 436
	pr_debug("Samples for '%s' event do not have %s attribute set. "
		 "Skipping '%s' field.\n",
		 evname, sample_msg, output_field2str(field));

	return 0;
}

437 438
static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
			      enum perf_output_field field)
439
{
440
	return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
441 442
}

443
static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
444
{
445
	struct perf_event_attr *attr = &evsel->core.attr;
446 447
	bool allow_user_set;

448 449 450
	if (perf_header__has_feat(&session->header, HEADER_STAT))
		return 0;

451 452
	allow_user_set = perf_header__has_feat(&session->header,
					       HEADER_AUXTRACE);
453

454
	if (PRINT_FIELD(TRACE) &&
455
	    !perf_session__has_traces(session, "record -R"))
456 457
		return -EINVAL;

458
	if (PRINT_FIELD(IP)) {
459
		if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
460 461
			return -EINVAL;
	}
462 463

	if (PRINT_FIELD(ADDR) &&
464
	    evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
465 466
		return -EINVAL;

467
	if (PRINT_FIELD(DATA_SRC) &&
468
	    evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC))
469 470 471
		return -EINVAL;

	if (PRINT_FIELD(WEIGHT) &&
472
	    evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT", PERF_OUTPUT_WEIGHT))
473 474
		return -EINVAL;

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

	if (PRINT_FIELD(TIME) &&
508
	    evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
509 510 511
		return -EINVAL;

	if (PRINT_FIELD(CPU) &&
512
	    evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
513
		return -EINVAL;
514

515
	if (PRINT_FIELD(IREGS) &&
516
	    evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
517 518
		return -EINVAL;

A
Andi Kleen 已提交
519
	if (PRINT_FIELD(UREGS) &&
520
	    evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
A
Andi Kleen 已提交
521 522
		return -EINVAL;

523
	if (PRINT_FIELD(PHYS_ADDR) &&
524
	    evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR))
525 526
		return -EINVAL;

K
Kan Liang 已提交
527 528 529 530
	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;

531 532 533 534
	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;

535 536 537
	return 0;
}

538 539
static void set_print_ip_opts(struct perf_event_attr *attr)
{
540
	unsigned int type = output_type(attr->type);
541 542 543

	output[type].print_ip_opts = 0;
	if (PRINT_FIELD(IP))
544
		output[type].print_ip_opts |= EVSEL__PRINT_IP;
545 546

	if (PRINT_FIELD(SYM))
547
		output[type].print_ip_opts |= EVSEL__PRINT_SYM;
548 549

	if (PRINT_FIELD(DSO))
550
		output[type].print_ip_opts |= EVSEL__PRINT_DSO;
551 552

	if (PRINT_FIELD(SYMOFFSET))
553
		output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
554 555

	if (PRINT_FIELD(SRCLINE))
556
		output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
557 558
}

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

569 570
	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
		evsel = perf_session__find_first_evtype(session, attr_type(j));
571 572 573 574 575

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

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

		if (evsel == NULL)
			continue;

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

595 596
	if (!no_callchain) {
		bool use_callchain = false;
597
		bool not_pipe = false;
598

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

610 611 612 613 614 615 616 617
	/*
	 * 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;

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

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

633 634 635 636 637
	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;
	}
638
out:
639 640
	return 0;
}
641

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

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

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

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

	return printed;
A
Andi Kleen 已提交
659 660
}

661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
#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;
}

711 712 713 714 715 716 717 718 719 720 721 722 723 724
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);
}

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

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

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

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

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

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
	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:
791
			if (has(SWITCH_OUT)) {
792
				ret += fprintf(fp, "S");
793 794 795
				if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
					ret += fprintf(fp, "p");
			}
796 797 798 799 800 801 802 803 804 805
		default:
			break;
		}

		#undef has

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

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

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

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

	return printed;
839 840
}

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

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

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

	if (!(br && br->nr))
861
		return 0;
862 863

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

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

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

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

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

	return printed;
896 897
}

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

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

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

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

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

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

	return printed;
942 943
}

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

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

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

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

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

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

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

	return printed;
992
}
993 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
#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)) {
1019
		pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1020 1021 1022 1023 1024 1025
		return -ENXIO;
	}

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

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

1055 1056 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
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 已提交
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
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;
}

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

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

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

1141 1142
	thread__find_map(thread, cpumode, addr, &al);

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

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

	if (!al.sym)
1152
		return 0;
1153 1154 1155 1156 1157

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

	return printed;
1168 1169
}

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

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

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

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

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

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

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

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

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

	/*
	 * Print final block upto sample
1265 1266 1267 1268 1269
	 *
	 * 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.
1270
	 */
1271
	start = entries[0].to;
1272
	end = sample->ip;
1273 1274 1275 1276
	if (end < start) {
		/* Missing jump. Scan 128 bytes for the next branch */
		end = start + 128;
	}
1277
	len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1278
	printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1279 1280 1281 1282 1283
	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)
1284 1285
			goto out;
		printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1286
			dump_insn(&x, sample->ip, buffer, len, NULL));
A
Andi Kleen 已提交
1287 1288
		if (PRINT_FIELD(SRCCODE))
			print_srccode(thread, x.cpumode, sample->ip);
1289
		goto out;
1290 1291
	}
	for (off = 0; off <= end - start; off += ilen) {
1292
		ilen = 0;
1293 1294
		printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
				   dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1295 1296
		if (ilen == 0)
			break;
1297 1298 1299 1300 1301 1302 1303
		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 已提交
1304 1305
		if (PRINT_FIELD(SRCCODE))
			print_srccode(thread, x.cpumode, start + off);
1306
	}
1307 1308
out:
	return printed;
1309
}
1310

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

	if (!sample_addr_correlates_sym(attr))
1319
		goto out;
1320

1321
	thread__resolve(thread, &al, sample);
1322 1323

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

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

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

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

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

1392
	name = resolve_branch_sym(sample, evsel, thread, al, addr_al, &ip);
1393

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

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

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

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

1418
	return len + dlen;
1419 1420
}

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

1427 1428 1429 1430 1431 1432 1433
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);
}

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

1441
	script_fetch_insn(sample, thread, machine);
1442

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

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

	return printed;
A
Andi Kleen 已提交
1456 1457
}

1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471
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);
}

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

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

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

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

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

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

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

1518 1519
	printed += perf_sample__fprintf_ipc(sample, attr, fp);

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

1523
	printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
A
Andi Kleen 已提交
1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
	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;
1534 1535
}

1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
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"},
1553 1554
	{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"},
1555 1556 1557
	{0, NULL}
};

1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
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;
}

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

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

	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)
1585
			return snprintf(str, sz, "tr strt %-7s%4s", name, in_tx ? "(x)" : "");
1586 1587 1588 1589 1590
	}

	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)
1591
			return snprintf(str, sz, "tr end  %-7s%4s", name, in_tx ? "(x)" : "");
1592 1593
	}

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

	return pos;
}

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

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

1616 1617 1618 1619 1620 1621
struct printer_data {
	int line_no;
	bool hit_nul;
	bool is_printable;
};

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

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

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

			if (!printer_data->is_printable)
				break;

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

	return printed;
1681 1682
}

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

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

	return printed;
1694 1695
}

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

	return 0;
1702 1703
}

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

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

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

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

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

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

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

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

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

1743 1744 1745
	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);
1746 1747
}

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

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

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

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

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

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

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

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

A
Adrian Hunter 已提交
1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803
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);
}

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

	return 0;
1827 1828
}

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

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

		max = MAX(len, max);
	}

	return max;
}

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

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

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

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

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

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

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

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

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

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

	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;
1960
		const char *name = resolve_branch_sym(sample, evsel, thread, al, addr_al,
1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981
				&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;
	}
}

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

1995
	if (output[type].fields == 0)
1996 1997
		return;

1998 1999
	++es->samples;

2000
	perf_sample__fprintf_start(script, sample, thread, evsel,
2001
				   PERF_RECORD_SAMPLE, fp);
2002

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

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

		if (!script->name_width)
2010
			script->name_width = evlist__max_name_len(script->session->evlist);
2011

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

2015
	if (print_flags)
2016
		perf_sample__fprintf_flags(sample->flags, fp);
2017

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

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

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

2031
	if (PRINT_FIELD(ADDR))
2032
		perf_sample__fprintf_addr(sample, thread, attr, fp);
2033

2034
	if (PRINT_FIELD(DATA_SRC))
2035
		data_src__fprintf(sample->data_src, fp);
2036 2037

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

2040
	if (PRINT_FIELD(IP)) {
2041
		struct callchain_cursor *cursor = NULL;
2042

2043 2044 2045
		if (script->stitch_lbr)
			al->thread->lbr_stitch_enable = true;

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

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

2056
	if (PRINT_FIELD(IREGS))
2057
		perf_sample__fprintf_iregs(sample, attr, fp);
2058

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

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

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

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

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

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

2082 2083
	perf_sample__fprintf_ipc(sample, attr, fp);

2084
	fprintf(fp, "\n");
2085

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

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

	if (verbose)
		fflush(fp);
2097 2098
}

T
Tom Zanussi 已提交
2099 2100
static struct scripting_ops	*scripting_ops;

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

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

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

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

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

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

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

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

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

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

2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195
	/* 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;
	}

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

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

2212
	if (filter_cpu(sample))
2213
		goto out_put;
2214

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

	if (al.filtered)
2223
		goto out_put;
2224

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

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

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

2238 2239 2240 2241 2242
	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)) {
2243 2244
			if (!addr_al.thread)
				thread__resolve(al.thread, &addr_al, sample);
2245 2246 2247 2248
			addr_al_ptr = &addr_al;
		}
		scripting_ops->process_event(event, sample, evsel, &al, addr_al_ptr);
	} else {
2249
		process_event(scr, sample, evsel, &al, &addr_al, machine);
2250
	}
2251

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

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

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

	evlist = *pevlist;
2273
	evsel = evlist__last(*pevlist);
2274

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

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

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

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

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

2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320
	/* 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;
2321 2322
	}
	set_print_ip_opts(&evsel->core.attr);
2323
	return 0;
2324 2325
}

2326 2327 2328 2329 2330
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)
2331 2332 2333
{
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
2334
	struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2335
	struct thread *thread = NULL;
2336

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

2344 2345
	if (filter_cpu(sample))
		return 0;
2346

2347 2348 2349
	if (tid != -1)
		thread = machine__findnew_thread(machine, pid, tid);

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

2355
	perf_event__fprintf(event, machine, stdout);
2356

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

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

2381 2382 2383 2384 2385 2386
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)
2387
		return -1;
2388

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

2393 2394 2395 2396 2397 2398
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)
2399
		return -1;
2400

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

2405 2406 2407 2408 2409 2410 2411 2412
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;

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

2427
	return perf_event__process_exit(tool, event, sample, machine);
2428 2429
}

2430 2431 2432 2433 2434 2435 2436 2437
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;

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

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;

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

2454 2455 2456 2457 2458 2459 2460 2461 2462 2463
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;

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

	if (!script->show_switch_events)
		return 0;

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

2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484
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);
}

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

2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505
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;
}

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

{
2512
	perf_event__fprintf(event, NULL, stdout);
2513 2514 2515
	return 0;
}

2516 2517 2518 2519 2520 2521 2522 2523 2524
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;

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

2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540
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);
}

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

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

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

static int perf_script__fopen_per_event_dump(struct perf_script *script)
{
2561
	struct evsel *evsel;
2562 2563

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

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

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

2594 2595
	es_stdout.fp = stdout;

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

	return 0;
}

2602 2603
static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
{
2604
	struct evsel *evsel;
2605 2606

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

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

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

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

2625 2626
	signal(SIGINT, sig_handler);

2627 2628
	perf_stat__init_shadow_stats();

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

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

2667
	ret = perf_session__process_events(script->session);
2668

2669
	if (script->per_event_dump)
2670
		perf_script__exit_per_event_dump_stats(script);
2671

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

	return ret;
F
Frederic Weisbecker 已提交
2676 2677
}

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

2684
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
2685 2686 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

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;

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

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

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

	fprintf(stderr, "\n");
}

2754 2755 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
/* 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);
}

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

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

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

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

	return 0;
}

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

	if (!str)
		return -ENOMEM;

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

3020
static LIST_HEAD(script_descs);
3021 3022 3023 3024 3025

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

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

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
3034 3035 3036
	zfree(&s->name);
	zfree(&s->half_liner);
	zfree(&s->args);
3037 3038 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
	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)
3064
		return NULL;
3065 3066 3067 3068 3069 3070

	script_desc__add(s);

	return s;
}

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

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

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

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

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

	fclose(fp);

	return 0;
}

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

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

3157
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3158 3159

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	fclose(fp);
	return 0;
}

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

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

3312
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3313 3314

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

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

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

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

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

3354 3355
			i++;
		}
3356
		closedir(lang_dir);
3357 3358
	}

3359 3360
	closedir(scripts_dir);
	perf_session__delete(session);
3361 3362 3363
	return i;
}

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

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

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

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

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

3402
	return NULL;
3403 3404
}

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

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

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

3447 3448 3449 3450 3451
	system_wide = (argc == 0);

	return 0;
}

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

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

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

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

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

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

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

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

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

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

3507
	perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3508

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

	script->allocated = true;
	return 0;
}

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

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

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

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

	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

3582 3583 3584 3585 3586 3587
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);
3588
	symbol_conf.nanosecs = true;
3589 3590 3591 3592 3593 3594 3595
	return 0;
}

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

3603 3604 3605 3606 3607 3608
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);
3609
	symbol_conf.nanosecs = true;
3610
	symbol_conf.pad_output_len_dso = 50;
3611 3612 3613 3614 3615 3616 3617 3618 3619
	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);
3620
	symbol_conf.nanosecs = true;
3621 3622 3623
	return 0;
}

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

3817 3818
	perf_set_singlethreaded();

3819 3820
	setup_scripting();

3821
	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3822 3823
			     PARSE_OPT_STOP_AT_NON_OPTION);

3824 3825 3826 3827 3828 3829 3830 3831 3832 3833
	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 已提交
3834 3835
	data.path  = input_name;
	data.force = symbol_conf.force;
3836

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

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

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

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

3864
	/* make sure PERF_EXEC_PATH is set for scripts */
3865
	set_argv_exec_path(get_argv_exec_path());
3866

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

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

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

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

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

		if (!pid) {
3914 3915
			j = 0;

3916 3917 3918
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

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

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

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

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

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

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

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

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

3980 3981
	if (script_path) {
		j = 0;
3982

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

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

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

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

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

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

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

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

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

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

4046
	script.session = session;
4047
	script__setup_sample_type(&script);
4048

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

4053 4054
	session->itrace_synth_opts = &itrace_synth_opts;

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

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

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

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

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

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

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

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

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

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

4117 4118 4119 4120
	err = dlfilter__start(dlfilter, session);
	if (err)
		goto out_delete;

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

4129 4130 4131

	err = perf_session__check_output_opt(session);
	if (err < 0)
4132
		goto out_delete;
4133

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

		itrace_synth_opts__set_time_range(&itrace_synth_opts,
						  script.ptime_range,
						  script.range_num);
4146 4147
	}

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

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

4155
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
4156

4157 4158
	flush_scripting();

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

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

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