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

64
#include <linux/ctype.h>
65

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

88
unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
89

90
enum perf_output_field {
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 122
	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,
123
	PERF_OUTPUT_TOD             = 1ULL << 32,
K
Kan Liang 已提交
124
	PERF_OUTPUT_DATA_PAGE_SIZE  = 1ULL << 33,
125
	PERF_OUTPUT_CODE_PAGE_SIZE  = 1ULL << 34,
126
	PERF_OUTPUT_INS_LAT         = 1ULL << 35,
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
};

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;
152 153 154 155 156 157 158 159 160 161 162 163 164
};

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

196 197
enum {
	OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
198
	OUTPUT_TYPE_OTHER,
199 200 201
	OUTPUT_TYPE_MAX
};

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

	[PERF_TYPE_HARDWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
218
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
219 220
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
221

222
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
223 224 225 226 227 228 229
	},

	[PERF_TYPE_SOFTWARE] = {
		.user_set = false,

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

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_TRACEPOINT] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
				  PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
243
				  PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
244
	},
245

246 247 248 249 250 251 252 253 254 255 256 257
	[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,
	},

258 259 260 261 262
	[PERF_TYPE_RAW] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
263
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
264 265 266
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
			      PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
K
Kan Liang 已提交
267
			      PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR |
268 269
			      PERF_OUTPUT_DATA_PAGE_SIZE | PERF_OUTPUT_CODE_PAGE_SIZE |
			      PERF_OUTPUT_INS_LAT,
270

271
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
272
	},
273 274 275 276 277 278 279

	[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 |
280 281
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
282

283
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
284
	},
285 286 287 288 289 290 291

	[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 |
292 293
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
294 295 296

		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
	},
297 298 299 300 301 302 303 304 305 306 307 308

	[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,
	},
309
};
310

311
struct evsel_script {
312 313 314
       char *filename;
       FILE *fp;
       u64  samples;
315 316 317
       /* For metric output */
       u64  val;
       int  gnum;
318 319
};

320
static inline struct evsel_script *evsel_script(struct evsel *evsel)
321
{
322
	return (struct evsel_script *)evsel->priv;
323 324
}

325
static struct evsel_script *evsel_script__new(struct evsel *evsel, struct perf_data *data)
326
{
327
	struct evsel_script *es = zalloc(sizeof(*es));
328 329

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

345
static void evsel_script__delete(struct evsel_script *es)
346 347 348 349 350 351 352
{
	zfree(&es->filename);
	fclose(es->fp);
	es->fp = NULL;
	free(es);
}

353
static int evsel_script__fprintf(struct evsel_script *es, FILE *fp)
354 355 356 357 358 359 360 361
{
	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);
}

362 363 364 365 366 367
static inline int output_type(unsigned int type)
{
	switch (type) {
	case PERF_TYPE_SYNTH:
		return OUTPUT_TYPE_SYNTH;
	default:
368 369
		if (type < PERF_TYPE_MAX)
			return type;
370
	}
371 372

	return OUTPUT_TYPE_OTHER;
373 374
}

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

385 386 387 388 389 390 391 392 393 394 395 396 397 398
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;
}

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

401 402
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)
403
{
404
	struct perf_event_attr *attr = &evsel->core.attr;
405
	int type = output_type(attr->type);
406 407 408 409 410
	const char *evname;

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

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

	return 0;
}

431 432
static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
			      enum perf_output_field field)
433
{
434
	return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
435 436
}

437
static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
438
{
439
	struct perf_event_attr *attr = &evsel->core.attr;
440 441
	bool allow_user_set;

442 443 444
	if (perf_header__has_feat(&session->header, HEADER_STAT))
		return 0;

445 446
	allow_user_set = perf_header__has_feat(&session->header,
					       HEADER_AUXTRACE);
447

448
	if (PRINT_FIELD(TRACE) &&
449
	    !perf_session__has_traces(session, "record -R"))
450 451
		return -EINVAL;

452
	if (PRINT_FIELD(IP)) {
453
		if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
454 455
			return -EINVAL;
	}
456 457

	if (PRINT_FIELD(ADDR) &&
458
	    evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
459 460
		return -EINVAL;

461
	if (PRINT_FIELD(DATA_SRC) &&
462
	    evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC))
463 464 465
		return -EINVAL;

	if (PRINT_FIELD(WEIGHT) &&
466
	    evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_TYPE, "WEIGHT", PERF_OUTPUT_WEIGHT))
467 468
		return -EINVAL;

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

	if (PRINT_FIELD(TIME) &&
502
	    evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
503 504 505
		return -EINVAL;

	if (PRINT_FIELD(CPU) &&
506
	    evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
507
		return -EINVAL;
508

509
	if (PRINT_FIELD(IREGS) &&
510
	    evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
511 512
		return -EINVAL;

A
Andi Kleen 已提交
513
	if (PRINT_FIELD(UREGS) &&
514
	    evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
A
Andi Kleen 已提交
515 516
		return -EINVAL;

517
	if (PRINT_FIELD(PHYS_ADDR) &&
518
	    evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR))
519 520
		return -EINVAL;

K
Kan Liang 已提交
521 522 523 524
	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;

525 526 527 528
	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;

529 530 531 532
	if (PRINT_FIELD(INS_LAT) &&
	    evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_INS_LAT))
		return -EINVAL;

533 534 535
	return 0;
}

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

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

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

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

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

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

557 558 559 560 561 562 563 564 565 566 567 568
static struct evsel *find_first_output_type(struct evlist *evlist,
					    unsigned int type)
{
	struct evsel *evsel;

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

569 570 571 572 573 574
/*
 * verify all user requested events exist and the samples
 * have the expected data
 */
static int perf_session__check_output_opt(struct perf_session *session)
{
575
	bool tod = false;
576
	unsigned int j;
577
	struct evsel *evsel;
578

579
	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
580
		evsel = find_first_output_type(session->evlist, j);
581 582 583 584 585

		/*
		 * even if fields is set to 0 (ie., show nothing) event must
		 * exist if user explicitly includes it on the command line
		 */
586 587
		if (!evsel && output[j].user_set && !output[j].wildcard_set &&
		    j != OUTPUT_TYPE_SYNTH) {
588
			pr_err("%s events do not exist. "
589
			       "Remove corresponding -F option to proceed.\n",
590 591 592 593 594
			       event_type(j));
			return -1;
		}

		if (evsel && output[j].fields &&
595
			evsel__check_attr(evsel, session))
596
			return -1;
597 598 599 600

		if (evsel == NULL)
			continue;

601
		set_print_ip_opts(&evsel->core.attr);
602
		tod |= output[j].fields & PERF_OUTPUT_TOD;
603 604
	}

605 606
	if (!no_callchain) {
		bool use_callchain = false;
607
		bool not_pipe = false;
608

609
		evlist__for_each_entry(session->evlist, evsel) {
610
			not_pipe = true;
611
			if (evsel__has_callchain(evsel)) {
612 613 614 615
				use_callchain = true;
				break;
			}
		}
616
		if (not_pipe && !use_callchain)
617 618 619
			symbol_conf.use_callchain = false;
	}

620 621 622 623 624 625 626 627
	/*
	 * 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;

628
		evlist__for_each_entry(session->evlist, evsel) {
629
			if (evsel->core.attr.type != j)
630 631
				continue;

632
			if (evsel__has_callchain(evsel)) {
633 634
				output[j].fields |= PERF_OUTPUT_IP;
				output[j].fields |= PERF_OUTPUT_SYM;
635
				output[j].fields |= PERF_OUTPUT_SYMOFFSET;
636
				output[j].fields |= PERF_OUTPUT_DSO;
637
				set_print_ip_opts(&evsel->core.attr);
638 639
				goto out;
			}
640 641 642
		}
	}

643 644 645 646 647
	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;
	}
648
out:
649 650
	return 0;
}
651

652
static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask, const char *arch,
653
				     FILE *fp)
A
Andi Kleen 已提交
654 655
{
	unsigned i = 0, r;
656
	int printed = 0;
A
Andi Kleen 已提交
657 658

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

661
	printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
A
Andi Kleen 已提交
662 663 664

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

	return printed;
A
Andi Kleen 已提交
669 670
}

671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
#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;
}

721
static int perf_sample__fprintf_iregs(struct perf_sample *sample,
722
				      struct perf_event_attr *attr, const char *arch, FILE *fp)
723 724
{
	return perf_sample__fprintf_regs(&sample->intr_regs,
725
					 attr->sample_regs_intr, arch, fp);
726 727 728
}

static int perf_sample__fprintf_uregs(struct perf_sample *sample,
729
				      struct perf_event_attr *attr, const char *arch, FILE *fp)
730 731
{
	return perf_sample__fprintf_regs(&sample->user_regs,
732
					 attr->sample_regs_user, arch, fp);
733 734
}

735 736
static int perf_sample__fprintf_start(struct perf_script *script,
				      struct perf_sample *sample,
737
				      struct thread *thread,
738
				      struct evsel *evsel,
739
				      u32 type, FILE *fp)
740
{
741
	struct perf_event_attr *attr = &evsel->core.attr;
742
	unsigned long secs;
743
	unsigned long long nsecs;
744
	int printed = 0;
745
	char tstr[128];
746 747

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

750
		if (latency_format)
751
			printed += fprintf(fp, "%8.8s ", comm);
752
		else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
753
			printed += fprintf(fp, "%s ", comm);
754
		else
755
			printed += fprintf(fp, "%16s ", comm);
756
	}
757

758
	if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
759
		printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
760
	else if (PRINT_FIELD(PID))
761
		printed += fprintf(fp, "%5d ", sample->pid);
762
	else if (PRINT_FIELD(TID))
763
		printed += fprintf(fp, "%5d ", sample->tid);
764 765 766

	if (PRINT_FIELD(CPU)) {
		if (latency_format)
767
			printed += fprintf(fp, "%3d ", sample->cpu);
768
		else
769
			printed += fprintf(fp, "[%03d] ", sample->cpu);
770
	}
771

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

		#undef has

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

816 817 818 819 820
	if (PRINT_FIELD(TOD)) {
		tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
		printed += fprintf(fp, "%s ", tstr);
	}

821
	if (PRINT_FIELD(TIME)) {
A
Andi Kleen 已提交
822 823 824 825 826
		u64 t = sample->time;
		if (reltime) {
			if (!initial_time)
				initial_time = sample->time;
			t = sample->time - initial_time;
827 828 829 830 831 832 833
		} else if (deltatime) {
			if (previous_time)
				t = sample->time - previous_time;
			else {
				t = 0;
			}
			previous_time = sample->time;
A
Andi Kleen 已提交
834 835
		}
		nsecs = t;
836 837
		secs = nsecs / NSEC_PER_SEC;
		nsecs -= secs * NSEC_PER_SEC;
838

839
		if (symbol_conf.nanosecs)
840
			printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
841 842
		else {
			char sample_time[32];
A
Andi Kleen 已提交
843
			timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
844
			printed += fprintf(fp, "%12s: ", sample_time);
845
		}
846
	}
847 848

	return printed;
849 850
}

851 852 853 854 855 856 857 858 859
static inline char
mispred_str(struct branch_entry *br)
{
	if (!(br->flags.mispred  || br->flags.predicted))
		return '-';

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

860 861 862
static int perf_sample__fprintf_brstack(struct perf_sample *sample,
					struct thread *thread,
					struct perf_event_attr *attr, FILE *fp)
863 864
{
	struct branch_stack *br = sample->branch_stack;
865
	struct branch_entry *entries = perf_sample__branch_entries(sample);
866 867
	struct addr_location alf, alt;
	u64 i, from, to;
868
	int printed = 0;
869 870

	if (!(br && br->nr))
871
		return 0;
872 873

	for (i = 0; i < br->nr; i++) {
874 875
		from = entries[i].from;
		to   = entries[i].to;
876 877 878 879

		if (PRINT_FIELD(DSO)) {
			memset(&alf, 0, sizeof(alf));
			memset(&alt, 0, sizeof(alt));
880 881
			thread__find_map_fb(thread, sample->cpumode, from, &alf);
			thread__find_map_fb(thread, sample->cpumode, to, &alt);
882 883
		}

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

891
		printed += fprintf(fp, "/0x%"PRIx64, to);
892
		if (PRINT_FIELD(DSO)) {
893 894 895
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alt.map, fp);
			printed += fprintf(fp, ")");
896 897
		}

898
		printed += fprintf(fp, "/%c/%c/%c/%d ",
899 900 901 902
			mispred_str(entries + i),
			entries[i].flags.in_tx ? 'X' : '-',
			entries[i].flags.abort ? 'A' : '-',
			entries[i].flags.cycles);
903
	}
904 905

	return printed;
906 907
}

908 909 910
static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
					   struct thread *thread,
					   struct perf_event_attr *attr, FILE *fp)
911 912
{
	struct branch_stack *br = sample->branch_stack;
913
	struct branch_entry *entries = perf_sample__branch_entries(sample);
914 915
	struct addr_location alf, alt;
	u64 i, from, to;
916
	int printed = 0;
917 918

	if (!(br && br->nr))
919
		return 0;
920 921 922 923 924

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

		memset(&alf, 0, sizeof(alf));
		memset(&alt, 0, sizeof(alt));
925 926
		from = entries[i].from;
		to   = entries[i].to;
927

928 929
		thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
		thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
930

931
		printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
932
		if (PRINT_FIELD(DSO)) {
933 934 935
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alf.map, fp);
			printed += fprintf(fp, ")");
936
		}
937 938
		printed += fprintf(fp, "%c", '/');
		printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
939
		if (PRINT_FIELD(DSO)) {
940 941 942
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alt.map, fp);
			printed += fprintf(fp, ")");
943
		}
944
		printed += fprintf(fp, "/%c/%c/%c/%d ",
945 946 947 948
			mispred_str(entries + i),
			entries[i].flags.in_tx ? 'X' : '-',
			entries[i].flags.abort ? 'A' : '-',
			entries[i].flags.cycles);
949
	}
950 951

	return printed;
952 953
}

954 955 956
static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
					   struct thread *thread,
					   struct perf_event_attr *attr, FILE *fp)
957 958
{
	struct branch_stack *br = sample->branch_stack;
959
	struct branch_entry *entries = perf_sample__branch_entries(sample);
960 961
	struct addr_location alf, alt;
	u64 i, from, to;
962
	int printed = 0;
963 964

	if (!(br && br->nr))
965
		return 0;
966 967 968 969 970

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

		memset(&alf, 0, sizeof(alf));
		memset(&alt, 0, sizeof(alt));
971 972
		from = entries[i].from;
		to   = entries[i].to;
973

974
		if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
975
		    !alf.map->dso->adjust_symbols)
976 977
			from = map__map_ip(alf.map, from);

978
		if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
979
		    !alt.map->dso->adjust_symbols)
980 981
			to = map__map_ip(alt.map, to);

982
		printed += fprintf(fp, " 0x%"PRIx64, from);
983
		if (PRINT_FIELD(DSO)) {
984 985 986
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alf.map, fp);
			printed += fprintf(fp, ")");
987
		}
988
		printed += fprintf(fp, "/0x%"PRIx64, to);
989
		if (PRINT_FIELD(DSO)) {
990 991 992
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alt.map, fp);
			printed += fprintf(fp, ")");
993
		}
994
		printed += fprintf(fp, "/%c/%c/%c/%d ",
995 996 997 998
			mispred_str(entries + i),
			entries[i].flags.in_tx ? 'X' : '-',
			entries[i].flags.abort ? 'A' : '-',
			entries[i].flags.cycles);
999
	}
1000 1001

	return printed;
1002
}
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
#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)) {
1029
		pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1030 1031 1032 1033 1034 1035
		return -ENXIO;
	}

	memset(&al, 0, sizeof(al));
	if (end - start > MAXBB - MAXINSN) {
		if (last)
1036
			pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
1037
		else
1038
			pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
1039 1040 1041
		return 0;
	}

1042
	if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
1043
		pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1044 1045 1046
		return 0;
	}
	if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
1047
		pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
		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)
1060
		pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1061 1062 1063 1064
			start, end);
	return len;
}

1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
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 已提交
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
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;
}

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

1142 1143 1144
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)
1145 1146
{
	struct addr_location al;
1147
	int off, printed = 0;
1148 1149 1150

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

1151 1152
	thread__find_map(thread, cpumode, addr, &al);

1153
	if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1154
		return 0;
1155 1156 1157 1158 1159 1160 1161

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

	if (!al.sym)
1162
		return 0;
1163 1164 1165 1166 1167

	if (al.addr < al.sym->end)
		off = al.addr - al.sym->start;
	else
		off = al.addr - al.map->start - al.sym->start;
1168
	printed += fprintf(fp, "\t%s", al.sym->name);
1169
	if (off)
1170 1171
		printed += fprintf(fp, "%+d", off);
	printed += fprintf(fp, ":");
1172
	if (PRINT_FIELD(SRCLINE))
1173 1174
		printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
	printed += fprintf(fp, "\n");
1175
	*lastsym = al.sym;
1176 1177

	return printed;
1178 1179
}

1180 1181 1182 1183
static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
					    struct thread *thread,
					    struct perf_event_attr *attr,
					    struct machine *machine, FILE *fp)
1184 1185
{
	struct branch_stack *br = sample->branch_stack;
1186
	struct branch_entry *entries = perf_sample__branch_entries(sample);
1187
	u64 start, end;
1188
	int i, insn, len, nr, ilen, printed = 0;
1189 1190 1191 1192
	struct perf_insn x;
	u8 buffer[MAXBB];
	unsigned off;
	struct symbol *lastsym = NULL;
1193
	int total_cycles = 0;
1194 1195

	if (!(br && br->nr))
1196
		return 0;
1197 1198 1199 1200 1201 1202 1203
	nr = br->nr;
	if (max_blocks && nr > max_blocks + 1)
		nr = max_blocks + 1;

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

1204
	printed += fprintf(fp, "%c", '\n');
1205 1206

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

	/* Print all blocks */
	for (i = nr - 2; i >= 0; i--) {
1221
		if (entries[i].from || entries[i].to)
1222
			pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1223 1224 1225 1226
				 entries[i].from,
				 entries[i].to);
		start = entries[i + 1].to;
		end   = entries[i].from;
1227 1228 1229 1230

		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) {
1231
			end = entries[--i].from;
1232 1233 1234 1235 1236 1237 1238
			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;
1239
		for (off = 0; off < (unsigned)len; off += ilen) {
1240 1241
			uint64_t ip = start + off;

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

	/*
	 * Hit the branch? In this case we are already done, and the target
	 * has not been executed yet.
	 */
1268
	if (entries[0].from == sample->ip)
1269
		goto out;
1270
	if (entries[0].flags.abort)
1271
		goto out;
1272 1273 1274

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

1321 1322 1323
static int perf_sample__fprintf_addr(struct perf_sample *sample,
				     struct thread *thread,
				     struct perf_event_attr *attr, FILE *fp)
1324 1325
{
	struct addr_location al;
1326
	int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1327 1328

	if (!sample_addr_correlates_sym(attr))
1329
		goto out;
1330

1331
	thread__resolve(thread, &al, sample);
1332 1333

	if (PRINT_FIELD(SYM)) {
1334
		printed += fprintf(fp, " ");
1335
		if (PRINT_FIELD(SYMOFFSET))
1336
			printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1337
		else
1338
			printed += symbol__fprintf_symname(al.sym, fp);
1339 1340 1341
	}

	if (PRINT_FIELD(DSO)) {
1342 1343 1344
		printed += fprintf(fp, " (");
		printed += map__fprintf_dsoname(al.map, fp);
		printed += fprintf(fp, ")");
1345
	}
1346 1347
out:
	return printed;
1348 1349
}

1350
static const char *resolve_branch_sym(struct perf_sample *sample,
1351
				      struct evsel *evsel,
1352 1353
				      struct thread *thread,
				      struct addr_location *al,
1354
				      struct addr_location *addr_al,
1355 1356
				      u64 *ip)
{
1357
	struct perf_event_attr *attr = &evsel->core.attr;
1358 1359 1360 1361
	const char *name = NULL;

	if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
		if (sample_addr_correlates_sym(attr)) {
1362 1363 1364 1365
			if (!addr_al->thread)
				thread__resolve(thread, addr_al, sample);
			if (addr_al->sym)
				name = addr_al->sym->name;
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
			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;
}

1380
static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1381
					   struct evsel *evsel,
1382
					   struct thread *thread,
1383 1384 1385
					   struct addr_location *al,
					   struct addr_location *addr_al,
					   FILE *fp)
1386
{
1387
	struct perf_event_attr *attr = &evsel->core.attr;
1388
	size_t depth = thread_stack__depth(thread, sample->cpu);
1389 1390 1391
	const char *name = NULL;
	static int spacing;
	int len = 0;
1392
	int dlen = 0;
1393 1394 1395 1396 1397 1398 1399 1400 1401
	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;

1402
	name = resolve_branch_sym(sample, evsel, thread, al, addr_al, &ip);
1403

1404 1405 1406 1407 1408 1409
	if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
		dlen += fprintf(fp, "(");
		dlen += map__fprintf_dsoname(al->map, fp);
		dlen += fprintf(fp, ")\t");
	}

1410
	if (name)
1411
		len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1412
	else if (ip)
1413
		len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1414 1415

	if (len < 0)
1416
		return len;
1417 1418 1419 1420 1421 1422 1423 1424 1425

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

1428
	return len + dlen;
1429 1430
}

1431 1432 1433 1434 1435 1436
__weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
			    struct thread *thread __maybe_unused,
			    struct machine *machine __maybe_unused)
{
}

1437 1438 1439 1440 1441 1442 1443
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);
}

1444 1445 1446 1447
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 已提交
1448
{
1449 1450
	int printed = 0;

1451
	script_fetch_insn(sample, thread, machine);
1452

A
Andi Kleen 已提交
1453
	if (PRINT_FIELD(INSNLEN))
1454
		printed += fprintf(fp, " ilen: %d", sample->insn_len);
1455
	if (PRINT_FIELD(INSN) && sample->insn_len) {
A
Andi Kleen 已提交
1456 1457
		int i;

1458
		printed += fprintf(fp, " insn:");
A
Andi Kleen 已提交
1459
		for (i = 0; i < sample->insn_len; i++)
1460
			printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
A
Andi Kleen 已提交
1461
	}
1462
	if (PRINT_FIELD(BRSTACKINSN))
1463 1464 1465
		printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);

	return printed;
A
Andi Kleen 已提交
1466 1467
}

1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
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);
}

1482
static int perf_sample__fprintf_bts(struct perf_sample *sample,
1483
				    struct evsel *evsel,
1484 1485
				    struct thread *thread,
				    struct addr_location *al,
1486
				    struct addr_location *addr_al,
1487
				    struct machine *machine, FILE *fp)
1488
{
1489
	struct perf_event_attr *attr = &evsel->core.attr;
1490
	unsigned int type = output_type(attr->type);
1491
	bool print_srcline_last = false;
1492
	int printed = 0;
1493

1494
	if (PRINT_FIELD(CALLINDENT))
1495
		printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, addr_al, fp);
1496

1497 1498
	/* print branch_from information */
	if (PRINT_FIELD(IP)) {
1499
		unsigned int print_opts = output[type].print_ip_opts;
1500
		struct callchain_cursor *cursor = NULL;
1501

1502
		if (symbol_conf.use_callchain && sample->callchain &&
1503
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1504
					      sample, NULL, NULL, scripting_max_stack) == 0)
1505
			cursor = &callchain_cursor;
1506 1507

		if (cursor == NULL) {
1508
			printed += fprintf(fp, " ");
1509
			if (print_opts & EVSEL__PRINT_SRCLINE) {
1510
				print_srcline_last = true;
1511
				print_opts &= ~EVSEL__PRINT_SRCLINE;
1512
			}
1513
		} else
1514
			printed += fprintf(fp, "\n");
1515

1516 1517
		printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
					       symbol_conf.bt_stop_list, fp);
1518 1519 1520
	}

	/* print branch_to information */
1521
	if (PRINT_FIELD(ADDR) ||
1522
	    ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1523
	     !output[type].user_set)) {
1524 1525
		printed += fprintf(fp, " => ");
		printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1526
	}
1527

1528 1529
	printed += perf_sample__fprintf_ipc(sample, attr, fp);

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

1533
	printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
A
Andi Kleen 已提交
1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
	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;
1544 1545
}

1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
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"},
1563 1564
	{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"},
1565 1566 1567
	{0, NULL}
};

1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579
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;
}

1580
int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz)
1581 1582
{
	const char *chars = PERF_IP_FLAG_CHARS;
1583
	const size_t n = strlen(PERF_IP_FLAG_CHARS);
1584 1585
	bool in_tx = flags & PERF_IP_FLAG_IN_TX;
	const char *name = NULL;
1586
	size_t i, pos = 0;
1587

1588 1589
	name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
	if (name)
1590
		return snprintf(str, sz, "%-15s%4s", name, in_tx ? "(x)" : "");
1591 1592 1593 1594

	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)
1595
			return snprintf(str, sz, "tr strt %-7s%4s", name, in_tx ? "(x)" : "");
1596 1597 1598 1599 1600
	}

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

1604
	for (i = 0; i < n; i++, flags >>= 1) {
1605
		if ((flags & 1) && pos < sz)
1606 1607 1608
			str[pos++] = chars[i];
	}
	for (; i < 32; i++, flags >>= 1) {
1609
		if ((flags & 1) && pos < sz)
1610 1611
			str[pos++] = '?';
	}
1612 1613 1614 1615 1616 1617 1618 1619 1620
	if (pos < sz)
		str[pos] = 0;

	return pos;
}

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

1622
	perf_sample__sprintf_flags(flags, str, sizeof(str));
1623
	return fprintf(fp, "  %-19s ", str);
1624 1625
}

1626 1627 1628 1629 1630 1631
struct printer_data {
	int line_no;
	bool hit_nul;
	bool is_printable;
};

1632 1633 1634
static int sample__fprintf_bpf_output(enum binary_printer_ops op,
				      unsigned int val,
				      void *extra, FILE *fp)
1635 1636 1637
{
	unsigned char ch = (unsigned char)val;
	struct printer_data *printer_data = extra;
1638
	int printed = 0;
1639 1640 1641

	switch (op) {
	case BINARY_PRINT_DATA_BEGIN:
1642
		printed += fprintf(fp, "\n");
1643 1644
		break;
	case BINARY_PRINT_LINE_BEGIN:
1645
		printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1646 1647 1648
						        "           ");
		break;
	case BINARY_PRINT_ADDR:
1649
		printed += fprintf(fp, " %04x:", val);
1650 1651
		break;
	case BINARY_PRINT_NUM_DATA:
1652
		printed += fprintf(fp, " %02x", val);
1653 1654
		break;
	case BINARY_PRINT_NUM_PAD:
1655
		printed += fprintf(fp, "   ");
1656 1657
		break;
	case BINARY_PRINT_SEP:
1658
		printed += fprintf(fp, "  ");
1659 1660 1661 1662 1663 1664
		break;
	case BINARY_PRINT_CHAR_DATA:
		if (printer_data->hit_nul && ch)
			printer_data->is_printable = false;

		if (!isprint(ch)) {
1665
			printed += fprintf(fp, "%c", '.');
1666 1667 1668 1669 1670 1671 1672 1673 1674

			if (!printer_data->is_printable)
				break;

			if (ch == '\0')
				printer_data->hit_nul = true;
			else
				printer_data->is_printable = false;
		} else {
1675
			printed += fprintf(fp, "%c", ch);
1676 1677 1678
		}
		break;
	case BINARY_PRINT_CHAR_PAD:
1679
		printed += fprintf(fp, " ");
1680 1681
		break;
	case BINARY_PRINT_LINE_END:
1682
		printed += fprintf(fp, "\n");
1683 1684 1685 1686 1687 1688
		printer_data->line_no++;
		break;
	case BINARY_PRINT_DATA_END:
	default:
		break;
	}
1689 1690

	return printed;
1691 1692
}

1693
static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1694 1695 1696
{
	unsigned int nr_bytes = sample->raw_size;
	struct printer_data printer_data = {0, false, true};
1697 1698
	int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
				      sample__fprintf_bpf_output, &printer_data, fp);
1699 1700

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

	return printed;
1704 1705
}

1706
static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1707 1708
{
	if (len > 0 && len < spacing)
1709 1710 1711
		return fprintf(fp, "%*s", spacing - len, "");

	return 0;
1712 1713
}

1714
static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1715
{
1716
	return perf_sample__fprintf_spacing(len, 34, fp);
1717 1718
}

1719
static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1720 1721 1722 1723 1724
{
	struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
	int len;

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

1727
	len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1728
		     data->ip, le64_to_cpu(data->payload));
1729
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1730 1731
}

1732
static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1733 1734 1735 1736 1737
{
	struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
	int len;

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

1740 1741 1742
	len = fprintf(fp, " hints: %#x extensions: %#x ",
		      data->hints, data->extensions);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1743 1744
}

1745
static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1746 1747 1748 1749 1750
{
	struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
	int len;

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

1753 1754 1755
	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);
1756 1757
}

1758
static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1759 1760 1761 1762 1763
{
	struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
	int len;

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

1766 1767
	len = fprintf(fp, " IP: %u ", data->ip);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1768 1769
}

1770
static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1771 1772 1773 1774 1775
{
	struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
	int len;

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

1778
	len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1779 1780
		     data->deepest_cstate, data->last_cstate,
		     data->wake_reason);
1781
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1782 1783
}

1784
static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1785 1786 1787 1788 1789 1790
{
	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))
1791
		return 0;
1792 1793

	freq = (le32_to_cpu(data->freq) + 500) / 1000;
1794
	len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1795 1796
	if (data->max_nonturbo) {
		percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1797
		len += fprintf(fp, "(%3u%%) ", percent);
1798
	}
1799
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1800 1801
}

A
Adrian Hunter 已提交
1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813
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);
}

1814
static int perf_sample__fprintf_synth(struct perf_sample *sample,
1815
				      struct evsel *evsel, FILE *fp)
1816
{
1817
	switch (evsel->core.attr.config) {
1818
	case PERF_SYNTH_INTEL_PTWRITE:
1819
		return perf_sample__fprintf_synth_ptwrite(sample, fp);
1820
	case PERF_SYNTH_INTEL_MWAIT:
1821
		return perf_sample__fprintf_synth_mwait(sample, fp);
1822
	case PERF_SYNTH_INTEL_PWRE:
1823
		return perf_sample__fprintf_synth_pwre(sample, fp);
1824
	case PERF_SYNTH_INTEL_EXSTOP:
1825
		return perf_sample__fprintf_synth_exstop(sample, fp);
1826
	case PERF_SYNTH_INTEL_PWRX:
1827
		return perf_sample__fprintf_synth_pwrx(sample, fp);
1828
	case PERF_SYNTH_INTEL_CBR:
1829
		return perf_sample__fprintf_synth_cbr(sample, fp);
A
Adrian Hunter 已提交
1830 1831
	case PERF_SYNTH_INTEL_PSB:
		return perf_sample__fprintf_synth_psb(sample, fp);
1832 1833 1834
	default:
		break;
	}
1835 1836

	return 0;
1837 1838
}

1839
static int evlist__max_name_len(struct evlist *evlist)
1840
{
1841
	struct evsel *evsel;
1842 1843
	int max = 0;

1844
	evlist__for_each_entry(evlist, evsel) {
1845
		int len = strlen(evsel__name(evsel));
1846 1847 1848 1849 1850 1851 1852

		max = MAX(len, max);
	}

	return max;
}

1853
static int data_src__fprintf(u64 data_src, FILE *fp)
J
Jiri Olsa 已提交
1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866
{
	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;

1867
	return fprintf(fp, "%-*s", maxlen, out);
J
Jiri Olsa 已提交
1868 1869
}

1870 1871 1872
struct metric_ctx {
	struct perf_sample	*sample;
	struct thread		*thread;
1873
	struct evsel	*evsel;
1874 1875 1876
	FILE 			*fp;
};

1877 1878
static void script_print_metric(struct perf_stat_config *config __maybe_unused,
				void *ctx, const char *color,
1879 1880 1881 1882 1883 1884 1885
			        const char *fmt,
			        const char *unit, double val)
{
	struct metric_ctx *mctx = ctx;

	if (!fmt)
		return;
1886
	perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1887
				   PERF_RECORD_SAMPLE, mctx->fp);
1888 1889 1890 1891 1892 1893 1894 1895
	fputs("\tmetric: ", mctx->fp);
	if (color)
		color_fprintf(mctx->fp, color, fmt, val);
	else
		printf(fmt, val);
	fprintf(mctx->fp, " %s\n", unit);
}

1896 1897
static void script_new_line(struct perf_stat_config *config __maybe_unused,
			    void *ctx)
1898 1899 1900
{
	struct metric_ctx *mctx = ctx;

1901
	perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1902
				   PERF_RECORD_SAMPLE, mctx->fp);
1903 1904 1905 1906 1907
	fputs("\tmetric: ", mctx->fp);
}

static void perf_sample__fprint_metric(struct perf_script *script,
				       struct thread *thread,
1908
				       struct evsel *evsel,
1909 1910 1911
				       struct perf_sample *sample,
				       FILE *fp)
{
1912
	struct evsel *leader = evsel__leader(evsel);
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923
	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,
	};
1924
	struct evsel *ev2;
1925 1926 1927
	u64 val;

	if (!evsel->stats)
1928
		evlist__alloc_stats(script->session->evlist, false);
1929
	if (evsel_script(leader)->gnum++ == 0)
1930 1931 1932 1933
		perf_stat__reset_shadow_stats();
	val = sample->period * evsel->scale;
	perf_stat__update_shadow_stats(evsel,
				       val,
1934 1935
				       sample->cpu,
				       &rt_stat);
1936
	evsel_script(evsel)->val = val;
1937 1938
	if (evsel_script(leader)->gnum == leader->core.nr_members) {
		for_each_group_member (ev2, leader) {
1939
			perf_stat__print_shadow_stats(&stat_config, ev2,
1940 1941 1942
						      evsel_script(ev2)->val,
						      sample->cpu,
						      &ctx,
J
Jin Yao 已提交
1943 1944
						      NULL,
						      &rt_stat);
1945
		}
1946
		evsel_script(leader)->gnum = 0;
1947 1948 1949
	}
}

1950
static bool show_event(struct perf_sample *sample,
1951
		       struct evsel *evsel,
1952
		       struct thread *thread,
1953 1954
		       struct addr_location *al,
		       struct addr_location *addr_al)
1955
{
1956
	int depth = thread_stack__depth(thread, sample->cpu);
1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969

	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;
1970
		const char *name = resolve_branch_sym(sample, evsel, thread, al, addr_al,
1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991
				&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;
	}
}

1992
static void process_event(struct perf_script *script,
1993
			  struct perf_sample *sample, struct evsel *evsel,
1994
			  struct addr_location *al,
1995
			  struct addr_location *addr_al,
1996
			  struct machine *machine)
1997
{
1998
	struct thread *thread = al->thread;
1999
	struct perf_event_attr *attr = &evsel->core.attr;
2000
	unsigned int type = output_type(attr->type);
2001
	struct evsel_script *es = evsel->priv;
2002
	FILE *fp = es->fp;
K
Kan Liang 已提交
2003
	char str[PAGE_SIZE_NAME_LEN];
2004
	const char *arch = perf_env__arch(machine->env);
2005

2006
	if (output[type].fields == 0)
2007 2008
		return;

2009 2010
	++es->samples;

2011
	perf_sample__fprintf_start(script, sample, thread, evsel,
2012
				   PERF_RECORD_SAMPLE, fp);
2013

J
Jiri Olsa 已提交
2014
	if (PRINT_FIELD(PERIOD))
2015
		fprintf(fp, "%10" PRIu64 " ", sample->period);
J
Jiri Olsa 已提交
2016

2017
	if (PRINT_FIELD(EVNAME)) {
2018
		const char *evname = evsel__name(evsel);
2019 2020

		if (!script->name_width)
2021
			script->name_width = evlist__max_name_len(script->session->evlist);
2022

2023
		fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
2024 2025
	}

2026
	if (print_flags)
2027
		perf_sample__fprintf_flags(sample->flags, fp);
2028

2029
	if (is_bts_event(attr)) {
2030
		perf_sample__fprintf_bts(sample, evsel, thread, al, addr_al, machine, fp);
2031 2032 2033
		return;
	}

2034
	if (PRINT_FIELD(TRACE) && sample->raw_data) {
2035 2036 2037
		event_format__fprintf(evsel->tp_format, sample->cpu,
				      sample->raw_data, sample->raw_size, fp);
	}
2038 2039

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

2042
	if (PRINT_FIELD(ADDR))
2043
		perf_sample__fprintf_addr(sample, thread, attr, fp);
2044

2045
	if (PRINT_FIELD(DATA_SRC))
2046
		data_src__fprintf(sample->data_src, fp);
2047 2048

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

2051 2052 2053
	if (PRINT_FIELD(INS_LAT))
		fprintf(fp, "%16" PRIu16, sample->ins_lat);

2054
	if (PRINT_FIELD(IP)) {
2055
		struct callchain_cursor *cursor = NULL;
2056

2057 2058 2059
		if (script->stitch_lbr)
			al->thread->lbr_stitch_enable = true;

2060
		if (symbol_conf.use_callchain && sample->callchain &&
2061
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
2062
					      sample, NULL, NULL, scripting_max_stack) == 0)
2063
			cursor = &callchain_cursor;
2064

2065
		fputc(cursor ? '\n' : ' ', fp);
2066 2067
		sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
				    symbol_conf.bt_stop_list, fp);
2068 2069
	}

2070
	if (PRINT_FIELD(IREGS))
2071
		perf_sample__fprintf_iregs(sample, attr, arch, fp);
2072

A
Andi Kleen 已提交
2073
	if (PRINT_FIELD(UREGS))
2074
		perf_sample__fprintf_uregs(sample, attr, arch, fp);
A
Andi Kleen 已提交
2075

2076
	if (PRINT_FIELD(BRSTACK))
2077
		perf_sample__fprintf_brstack(sample, thread, attr, fp);
2078
	else if (PRINT_FIELD(BRSTACKSYM))
2079
		perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2080
	else if (PRINT_FIELD(BRSTACKOFF))
2081
		perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2082

2083
	if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2084 2085
		perf_sample__fprintf_bpf_output(sample, fp);
	perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2086 2087

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

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

2093 2094 2095
	if (PRINT_FIELD(CODE_PAGE_SIZE))
		fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));

2096 2097
	perf_sample__fprintf_ipc(sample, attr, fp);

2098
	fprintf(fp, "\n");
2099

A
Andi Kleen 已提交
2100 2101 2102 2103 2104 2105
	if (PRINT_FIELD(SRCCODE)) {
		if (map__fprintf_srccode(al->map, al->addr, stdout,
					 &thread->srccode_state))
			printf("\n");
	}

2106 2107
	if (PRINT_FIELD(METRIC))
		perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2108 2109 2110

	if (verbose)
		fflush(fp);
2111 2112
}

T
Tom Zanussi 已提交
2113 2114
static struct scripting_ops	*scripting_ops;

2115
static void __process_stat(struct evsel *counter, u64 tstamp)
2116
{
2117
	int nthreads = perf_thread_map__nr(counter->core.threads);
2118
	int idx, cpu, thread;
2119 2120
	static int header_printed;

2121
	if (counter->core.system_wide)
2122 2123 2124 2125 2126 2127 2128 2129 2130
		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++) {
2131
		perf_cpu_map__for_each_cpu(cpu, idx, evsel__cpus(counter)) {
2132 2133
			struct perf_counts_values *counts;

2134
			counts = perf_counts(counter->counts, idx, thread);
2135 2136

			printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2137
				cpu,
2138
				perf_thread_map__pid(counter->core.threads, thread),
2139 2140 2141 2142
				counts->val,
				counts->ena,
				counts->run,
				tstamp,
2143
				evsel__name(counter));
2144 2145 2146 2147
		}
	}
}

2148
static void process_stat(struct evsel *counter, u64 tstamp)
2149 2150 2151
{
	if (scripting_ops && scripting_ops->process_stat)
		scripting_ops->process_stat(&stat_config, counter, tstamp);
2152 2153
	else
		__process_stat(counter, tstamp);
2154 2155 2156 2157 2158 2159 2160 2161
}

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

T
Tom Zanussi 已提交
2162 2163
static void setup_scripting(void)
{
2164
	setup_perl_scripting();
2165
	setup_python_scripting();
T
Tom Zanussi 已提交
2166 2167
}

2168 2169
static int flush_scripting(void)
{
2170
	return scripting_ops ? scripting_ops->flush_script() : 0;
2171 2172
}

T
Tom Zanussi 已提交
2173 2174
static int cleanup_scripting(void)
{
2175
	pr_debug("\nperf script stopped\n");
2176

2177
	return scripting_ops ? scripting_ops->stop_script() : 0;
T
Tom Zanussi 已提交
2178 2179
}

2180 2181
static bool filter_cpu(struct perf_sample *sample)
{
2182
	if (cpu_list && sample->cpu != (u32)-1)
2183 2184 2185 2186
		return !test_bit(sample->cpu, cpu_bitmap);
	return false;
}

2187
static int process_sample_event(struct perf_tool *tool,
2188
				union perf_event *event,
2189
				struct perf_sample *sample,
2190
				struct evsel *evsel,
2191
				struct machine *machine)
F
Frederic Weisbecker 已提交
2192
{
2193
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
2194
	struct addr_location al;
2195
	struct addr_location addr_al;
2196
	int ret = 0;
F
Frederic Weisbecker 已提交
2197

2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208
	/* 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;
	}

2209 2210
	if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
					  sample->time)) {
2211
		goto out_put;
2212
	}
2213

2214 2215 2216 2217 2218 2219
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
2220
		}
2221
		last_timestamp = sample->time;
2222
		goto out_put;
F
Frederic Weisbecker 已提交
2223
	}
2224

2225
	if (filter_cpu(sample))
2226
		goto out_put;
2227

2228
	if (!al.thread && machine__resolve(machine, &al, sample) < 0) {
2229 2230
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
2231 2232
		ret = -1;
		goto out_put;
2233 2234 2235
	}

	if (al.filtered)
2236
		goto out_put;
2237

2238
	if (!show_event(sample, evsel, al.thread, &al, &addr_al))
2239 2240 2241 2242 2243
		goto out_put;

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

2244 2245 2246 2247 2248 2249 2250
	ret = dlfilter__filter_event(dlfilter, event, sample, evsel, machine, &al, &addr_al);
	if (ret) {
		if (ret > 0)
			ret = 0;
		goto out_put;
	}

2251 2252 2253 2254 2255
	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)) {
2256 2257
			if (!addr_al.thread)
				thread__resolve(al.thread, &addr_al, sample);
2258 2259 2260 2261
			addr_al_ptr = &addr_al;
		}
		scripting_ops->process_event(event, sample, evsel, &al, addr_al_ptr);
	} else {
2262
		process_event(scr, sample, evsel, &al, &addr_al, machine);
2263
	}
2264

2265
out_put:
2266 2267
	if (al.thread)
		addr_location__put(&al);
2268
	return ret;
F
Frederic Weisbecker 已提交
2269 2270
}

2271
static int process_attr(struct perf_tool *tool, union perf_event *event,
2272
			struct evlist **pevlist)
2273 2274
{
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
2275
	struct evlist *evlist;
2276
	struct evsel *evsel, *pos;
2277
	u64 sample_type;
2278
	int err;
2279
	static struct evsel_script *es;
2280 2281 2282 2283 2284 2285

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

	evlist = *pevlist;
2286
	evsel = evlist__last(*pevlist);
2287

2288 2289
	if (!evsel->priv) {
		if (scr->per_event_dump) {
2290
			evsel->priv = evsel_script__new(evsel, scr->session->data);
2291 2292 2293 2294 2295 2296 2297 2298 2299
		} else {
			es = zalloc(sizeof(*es));
			if (!es)
				return -ENOMEM;
			es->fp = stdout;
			evsel->priv = es;
		}
	}

2300 2301
	if (evsel->core.attr.type >= PERF_TYPE_MAX &&
	    evsel->core.attr.type != PERF_TYPE_SYNTH)
2302 2303
		return 0;

2304
	evlist__for_each_entry(evlist, pos) {
2305
		if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2306 2307 2308
			return 0;
	}

2309
	if (evsel->core.attr.sample_type) {
2310
		err = evsel__check_attr(evsel, scr->session);
2311 2312 2313
		if (err)
			return err;
	}
2314

2315 2316 2317 2318
	/*
	 * Check if we need to enable callchains based
	 * on events sample_type.
	 */
2319
	sample_type = evlist__combined_sample_type(evlist);
2320
	callchain_param_setup(sample_type, perf_env__arch((*pevlist)->env));
2321

2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333
	/* 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;
2334 2335
	}
	set_print_ip_opts(&evsel->core.attr);
2336
	return 0;
2337 2338
}

2339 2340 2341 2342 2343
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)
2344 2345 2346
{
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
2347
	struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2348
	struct thread *thread = NULL;
2349

2350 2351 2352 2353 2354
	if (evsel && !evsel->core.attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = timestamp;
		sample->pid = pid;
		sample->tid = tid;
2355 2356
	}

2357 2358
	if (filter_cpu(sample))
		return 0;
2359

2360 2361 2362
	if (tid != -1)
		thread = machine__findnew_thread(machine, pid, tid);

2363
	if (evsel) {
2364
		perf_sample__fprintf_start(script, sample, thread, evsel,
2365
					   event->header.type, stdout);
2366
	}
2367

2368
	perf_event__fprintf(event, machine, stdout);
2369

2370
	thread__put(thread);
2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391

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

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

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

2406 2407 2408 2409 2410 2411
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)
2412
		return -1;
2413

2414 2415
	return print_event(tool, event, sample, machine, sample->pid,
			    sample->tid);
2416 2417
}

2418 2419 2420 2421 2422 2423 2424 2425
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;

2426 2427 2428
	return print_event_with_time(tool, event, sample, machine,
				     event->fork.pid, event->fork.tid,
				     event->fork.time);
2429 2430 2431 2432 2433 2434
}
static int process_exit_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
2435 2436 2437
	/* Print before 'exit' deletes anything */
	if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
				  event->fork.tid, event->fork.time))
2438 2439
		return -1;

2440
	return perf_event__process_exit(tool, event, sample, machine);
2441 2442
}

2443 2444 2445 2446 2447 2448 2449 2450
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;

2451 2452
	return print_event(tool, event, sample, machine, event->mmap.pid,
			   event->mmap.tid);
2453 2454 2455 2456 2457 2458 2459 2460 2461 2462
}

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;

2463 2464
	return print_event(tool, event, sample, machine, event->mmap2.pid,
			   event->mmap2.tid);
2465 2466
}

2467 2468 2469 2470 2471 2472 2473 2474 2475 2476
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;

2477
	if (scripting_ops && scripting_ops->process_switch && !filter_cpu(sample))
2478 2479 2480 2481 2482
		scripting_ops->process_switch(event, sample, machine);

	if (!script->show_switch_events)
		return 0;

2483 2484
	return print_event(tool, event, sample, machine, sample->pid,
			   sample->tid);
2485 2486
}

2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497
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);
}

2498 2499 2500 2501 2502 2503
static int
process_lost_event(struct perf_tool *tool,
		   union perf_event *event,
		   struct perf_sample *sample,
		   struct machine *machine)
{
2504 2505
	return print_event(tool, event, sample, machine, sample->pid,
			   sample->tid);
2506 2507
}

2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518
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;
}

2519 2520 2521 2522 2523 2524
static int
process_finished_round_event(struct perf_tool *tool __maybe_unused,
			     union perf_event *event,
			     struct ordered_events *oe __maybe_unused)

{
2525
	perf_event__fprintf(event, NULL, stdout);
2526 2527 2528
	return 0;
}

2529 2530 2531 2532 2533 2534 2535 2536 2537
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;

2538 2539
	return print_event(tool, event, sample, machine, sample->pid,
			   sample->tid);
2540 2541
}

2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553
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);
}

2554
static void sig_handler(int sig __maybe_unused)
2555 2556 2557 2558
{
	session_done = 1;
}

2559 2560
static void perf_script__fclose_per_event_dump(struct perf_script *script)
{
2561
	struct evlist *evlist = script->session->evlist;
2562
	struct evsel *evsel;
2563 2564 2565 2566

	evlist__for_each_entry(evlist, evsel) {
		if (!evsel->priv)
			break;
2567
		evsel_script__delete(evsel->priv);
2568 2569 2570 2571 2572 2573
		evsel->priv = NULL;
	}
}

static int perf_script__fopen_per_event_dump(struct perf_script *script)
{
2574
	struct evsel *evsel;
2575 2576

	evlist__for_each_entry(script->session->evlist, evsel) {
2577 2578 2579
		/*
		 * Already setup? I.e. we may be called twice in cases like
		 * Intel PT, one for the intel_pt// and dummy events, then
2580
		 * for the evsels synthesized from the auxtrace info.
2581 2582 2583 2584 2585 2586
		 *
		 * Ses perf_script__process_auxtrace_info.
		 */
		if (evsel->priv != NULL)
			continue;

2587
		evsel->priv = evsel_script__new(evsel, script->session->data);
2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600
		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)
{
2601 2602
	struct evsel *evsel;
	static struct evsel_script es_stdout;
2603 2604 2605 2606

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

2607 2608
	es_stdout.fp = stdout;

2609
	evlist__for_each_entry(script->session->evlist, evsel)
2610
		evsel->priv = &es_stdout;
2611 2612 2613 2614

	return 0;
}

2615 2616
static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
{
2617
	struct evsel *evsel;
2618 2619

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

2622 2623
		evsel_script__fprintf(es, stdout);
		evsel_script__delete(es);
2624 2625 2626 2627
		evsel->priv = NULL;
	}
}

2628 2629 2630 2631 2632 2633
static void perf_script__exit(struct perf_script *script)
{
	perf_thread_map__put(script->threads);
	perf_cpu_map__put(script->cpus);
}

2634
static int __cmd_script(struct perf_script *script)
F
Frederic Weisbecker 已提交
2635
{
2636 2637
	int ret;

2638 2639
	signal(SIGINT, sig_handler);

2640 2641
	perf_stat__init_shadow_stats();

2642 2643 2644 2645 2646 2647
	/* 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;
	}
2648 2649 2650 2651
	if (script->show_mmap_events) {
		script->tool.mmap = process_mmap_event;
		script->tool.mmap2 = process_mmap2_event;
	}
2652
	if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2653
		script->tool.context_switch = process_switch_event;
2654 2655
	if (scripting_ops && scripting_ops->process_auxtrace_error)
		script->tool.auxtrace_error = process_auxtrace_error;
2656 2657
	if (script->show_namespace_events)
		script->tool.namespaces = process_namespaces_event;
2658 2659
	if (script->show_cgroup_events)
		script->tool.cgroup = process_cgroup_event;
2660 2661
	if (script->show_lost_events)
		script->tool.lost = process_lost_event;
2662 2663 2664 2665
	if (script->show_round_events) {
		script->tool.ordered_events = false;
		script->tool.finished_round = process_finished_round_event;
	}
2666
	if (script->show_bpf_events) {
2667 2668
		script->tool.ksymbol = process_bpf_events;
		script->tool.bpf     = process_bpf_events;
2669
	}
2670 2671 2672 2673
	if (script->show_text_poke_events) {
		script->tool.ksymbol   = process_bpf_events;
		script->tool.text_poke = process_text_poke_events;
	}
2674

2675 2676 2677 2678 2679
	if (perf_script__setup_per_event_dump(script)) {
		pr_err("Couldn't create the per event dump files\n");
		return -1;
	}

2680
	ret = perf_session__process_events(script->session);
2681

2682
	if (script->per_event_dump)
2683
		perf_script__exit_per_event_dump_stats(script);
2684

2685
	if (debug_mode)
2686
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2687 2688

	return ret;
F
Frederic Weisbecker 已提交
2689 2690
}

T
Tom Zanussi 已提交
2691 2692 2693
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
2694
	char			spec[];
T
Tom Zanussi 已提交
2695 2696
};

2697
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734

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;

2735
	s = script_spec__new(spec, ops);
T
Tom Zanussi 已提交
2736 2737
	if (!s)
		return -1;
2738 2739
	else
		script_spec__add(s);
T
Tom Zanussi 已提交
2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758

	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 "
2759
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
2760 2761 2762 2763 2764 2765 2766

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

	fprintf(stderr, "\n");
}

2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797
/* 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);
}

2798 2799
static int parse_scriptname(const struct option *opt __maybe_unused,
			    const char *str, int unset __maybe_unused)
T
Tom Zanussi 已提交
2800 2801 2802 2803 2804
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

2805
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
2806
		list_available_languages();
2807
		exit(0);
T
Tom Zanussi 已提交
2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826
	}

	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;
2827
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838
		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;
		}
	}

2839 2840 2841
	script_name = find_script(script);
	if (!script_name)
		script_name = strdup(script);
T
Tom Zanussi 已提交
2842 2843 2844 2845

	return 0;
}

2846 2847
static int parse_output_fields(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused)
2848
{
2849
	char *tok, *strtok_saveptr = NULL;
2850
	int i, imax = ARRAY_SIZE(all_output_options);
2851
	int j;
2852 2853
	int rc = 0;
	char *str = strdup(arg);
2854
	int type = -1;
2855
	enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2856 2857 2858 2859

	if (!str)
		return -ENOMEM;

2860 2861 2862
	/* 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.
2863
	 */
2864 2865 2866 2867 2868 2869 2870 2871 2872 2873
	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;
2874 2875
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
2876 2877
		else if (!strcmp(str, "break"))
			type = PERF_TYPE_BREAKPOINT;
2878 2879
		else if (!strcmp(str, "synth"))
			type = OUTPUT_TYPE_SYNTH;
2880 2881
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
2882 2883
			rc = -EINVAL;
			goto out;
2884 2885 2886 2887 2888 2889
		}

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

2890 2891 2892 2893
		/* Don't override defaults for +- */
		if (strchr(tok, '+') || strchr(tok, '-'))
			goto parse;

2894 2895
		output[type].fields = 0;
		output[type].user_set = true;
2896
		output[type].wildcard_set = false;
2897 2898 2899 2900 2901 2902 2903 2904 2905 2906

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

2907 2908 2909 2910
		/* Don't override defaults for +- */
		if (strchr(str, '+') || strchr(str, '-'))
			goto parse;

2911 2912 2913
		if (output_set_by_user())
			pr_warning("Overriding previous field request for all events.\n");

2914
		for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2915 2916
			output[j].fields = 0;
			output[j].user_set = true;
2917
			output[j].wildcard_set = true;
2918
		}
2919 2920
	}

2921
parse:
2922
	for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938
		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;
		}

2939
		for (i = 0; i < imax; ++i) {
2940
			if (strcmp(tok, all_output_options[i].str) == 0)
2941 2942
				break;
		}
2943
		if (i == imax && strcmp(tok, "flags") == 0) {
Y
Yang Li 已提交
2944
			print_flags = change != REMOVE;
2945 2946
			continue;
		}
2947
		if (i == imax) {
2948
			fprintf(stderr, "Invalid field requested.\n");
2949
			rc = -EINVAL;
2950
			goto out;
2951 2952
		}

2953 2954 2955 2956
		if (type == -1) {
			/* add user option to all events types for
			 * which it is valid
			 */
2957
			for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2958 2959 2960
				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));
2961
				} else {
2962
					if (change == REMOVE) {
2963
						output[j].fields &= ~all_output_options[i].field;
2964
						output[j].user_set_fields &= ~all_output_options[i].field;
2965
						output[j].user_unset_fields |= all_output_options[i].field;
2966
					} else {
2967
						output[j].fields |= all_output_options[i].field;
2968
						output[j].user_set_fields |= all_output_options[i].field;
2969
						output[j].user_unset_fields &= ~all_output_options[i].field;
2970
					}
2971 2972
					output[j].user_set = true;
					output[j].wildcard_set = true;
2973
				}
2974 2975 2976 2977 2978 2979 2980 2981 2982
			}
		} 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;
			}
2983 2984 2985 2986
			if (change == REMOVE)
				output[type].fields &= ~all_output_options[i].field;
			else
				output[type].fields |= all_output_options[i].field;
2987 2988
			output[type].user_set = true;
			output[type].wildcard_set = true;
2989
		}
2990 2991
	}

2992 2993 2994 2995 2996 2997
	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));
		}
	}
2998
	goto out;
2999

3000 3001 3002
out_badmix:
	fprintf(stderr, "Cannot mix +-field with overridden fields\n");
	rc = -EINVAL;
3003
out:
3004 3005 3006 3007
	free(str);
	return rc;
}

3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020
#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)))
3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032


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

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

3033
static LIST_HEAD(script_descs);
3034 3035 3036 3037 3038

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

3039
	if (s != NULL && name)
3040 3041 3042 3043 3044 3045 3046
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
3047 3048 3049
	zfree(&s->name);
	zfree(&s->half_liner);
	zfree(&s->args);
3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076
	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)
3077
		return NULL;
3078 3079 3080 3081 3082 3083

	script_desc__add(s);

	return s;
}

3084
static const char *ends_with(const char *str, const char *suffix)
3085 3086
{
	size_t suffix_len = strlen(suffix);
3087
	const char *p = str;
3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107

	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)) {
3108
		p = skip_spaces(line);
3109 3110 3111 3112 3113 3114 3115 3116
		if (strlen(p) == 0)
			continue;
		if (*p != '#')
			continue;
		p++;
		if (strlen(p) && *p == '!')
			continue;

3117
		p = skip_spaces(p);
3118 3119 3120 3121 3122
		if (strlen(p) && p[strlen(p) - 1] == '\n')
			p[strlen(p) - 1] = '\0';

		if (!strncmp(p, "description:", strlen("description:"))) {
			p += strlen("description:");
3123
			desc->half_liner = strdup(skip_spaces(p));
3124 3125 3126 3127 3128
			continue;
		}

		if (!strncmp(p, "args:", strlen("args:"))) {
			p += strlen("args:");
3129
			desc->args = strdup(skip_spaces(p));
3130 3131 3132 3133 3134 3135 3136 3137 3138
			continue;
		}
	}

	fclose(fp);

	return 0;
}

3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156
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;
}

3157 3158 3159
static int list_available_scripts(const struct option *opt __maybe_unused,
				  const char *s __maybe_unused,
				  int unset __maybe_unused)
3160
{
3161
	struct dirent *script_dirent, *lang_dirent;
3162 3163 3164 3165 3166 3167 3168 3169
	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;

3170
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3171 3172

	scripts_dir = opendir(scripts_path);
3173 3174 3175 3176 3177 3178 3179
	if (!scripts_dir) {
		fprintf(stdout,
			"open(%s) failed.\n"
			"Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
			scripts_path);
		exit(-1);
	}
3180

3181
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3182 3183
		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			  lang_dirent->d_name);
3184 3185 3186 3187
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

3188 3189
		for_each_script(lang_path, lang_dir, script_dirent) {
			script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3190
			if (script_root) {
3191
				desc = script_desc__findnew(script_root);
3192 3193
				scnprintf(script_path, MAXPATHLEN, "%s/%s",
					  lang_path, script_dirent->d_name);
3194
				read_script_info(desc, script_path);
3195
				free(script_root);
3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210
			}
		}
	}

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

3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238
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);
}

3239 3240 3241 3242 3243 3244 3245
/*
 * 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
3246
 * cover the future complex formats like event groups etc.
3247 3248 3249 3250 3251 3252
 */
static int check_ev_match(char *dir_name, char *scriptname,
			struct perf_session *session)
{
	char filename[MAXPATHLEN], evname[128];
	char line[BUFSIZ], *p;
3253
	struct evsel *pos;
3254 3255 3256
	int match, len;
	FILE *fp;

3257
	scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3258 3259 3260 3261 3262 3263

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

	while (fgets(line, sizeof(line), fp)) {
3264
		p = skip_spaces(line);
3265 3266 3267 3268 3269 3270 3271 3272 3273
		if (*p == '#')
			continue;

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

			p += 2;
3274
			p = skip_spaces(p);
3275 3276 3277 3278 3279 3280 3281
			len = strcspn(p, " \t");
			if (!len)
				break;

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

			match = 0;
3282
			evlist__for_each_entry(session->evlist, pos) {
3283
				if (!strcmp(evsel__name(pos), evname)) {
3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299
					match = 1;
					break;
				}
			}

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

	fclose(fp);
	return 0;
}

3300 3301 3302 3303 3304 3305 3306
/*
 * 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.
 */
3307 3308
int find_scripts(char **scripts_array, char **scripts_path_array, int num,
		 int pathlen)
3309
{
3310
	struct dirent *script_dirent, *lang_dirent;
3311
	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3312
	DIR *scripts_dir, *lang_dir;
3313
	struct perf_session *session;
3314
	struct perf_data data = {
J
Jiri Olsa 已提交
3315 3316
		.path = input_name,
		.mode = PERF_DATA_MODE_READ,
3317
	};
3318 3319 3320
	char *temp;
	int i = 0;

3321
	session = perf_session__new(&data, NULL);
3322 3323
	if (IS_ERR(session))
		return PTR_ERR(session);
3324

3325
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3326 3327

	scripts_dir = opendir(scripts_path);
3328 3329
	if (!scripts_dir) {
		perf_session__delete(session);
3330
		return -1;
3331
	}
3332

3333
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3334 3335
		scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
			  lang_dirent->d_name);
3336
#ifndef HAVE_LIBPERL_SUPPORT
3337 3338 3339
		if (strstr(lang_path, "perl"))
			continue;
#endif
3340
#ifndef HAVE_LIBPYTHON_SUPPORT
3341 3342 3343 3344 3345 3346 3347 3348
		if (strstr(lang_path, "python"))
			continue;
#endif

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

3349
		for_each_script(lang_path, lang_dir, script_dirent) {
3350
			/* Skip those real time scripts: xxxtop.p[yl] */
3351
			if (strstr(script_dirent->d_name, "top."))
3352
				continue;
3353 3354 3355 3356
			if (i >= num)
				break;
			snprintf(scripts_path_array[i], pathlen, "%s/%s",
				lang_path,
3357 3358
				script_dirent->d_name);
			temp = strchr(script_dirent->d_name, '.');
3359
			snprintf(scripts_array[i],
3360 3361
				(temp - script_dirent->d_name) + 1,
				"%s", script_dirent->d_name);
3362 3363 3364 3365 3366

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

3367 3368
			i++;
		}
3369
		closedir(lang_dir);
3370 3371
	}

3372 3373
	closedir(scripts_dir);
	perf_session__delete(session);
3374 3375 3376
	return i;
}

3377 3378
static char *get_script_path(const char *script_root, const char *suffix)
{
3379
	struct dirent *script_dirent, *lang_dirent;
3380 3381 3382 3383
	char scripts_path[MAXPATHLEN];
	char script_path[MAXPATHLEN];
	DIR *scripts_dir, *lang_dir;
	char lang_path[MAXPATHLEN];
3384
	char *__script_root;
3385

3386
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3387 3388 3389 3390 3391

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

3392
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3393 3394
		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			  lang_dirent->d_name);
3395 3396 3397 3398
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

3399 3400
		for_each_script(lang_path, lang_dir, script_dirent) {
			__script_root = get_script_root(script_dirent, suffix);
3401 3402
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
3403
				closedir(scripts_dir);
3404 3405
				scnprintf(script_path, MAXPATHLEN, "%s/%s",
					  lang_path, script_dirent->d_name);
3406
				closedir(lang_dir);
3407
				return strdup(script_path);
3408 3409 3410
			}
			free(__script_root);
		}
3411
		closedir(lang_dir);
3412
	}
3413
	closedir(scripts_dir);
3414

3415
	return NULL;
3416 3417
}

3418 3419
static bool is_top_script(const char *script_path)
{
Y
Yang Li 已提交
3420
	return ends_with(script_path, "top") != NULL;
3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445
}

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

3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458
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 已提交
3459

3460 3461 3462 3463 3464
	system_wide = (argc == 0);

	return 0;
}

3465 3466 3467
static void script__setup_sample_type(struct perf_script *script)
{
	struct perf_session *session = script->session;
3468
	u64 sample_type = evlist__combined_sample_type(session->evlist);
3469

3470
	callchain_param_setup(sample_type, perf_env__arch(session->machines.host.env));
3471 3472 3473 3474 3475 3476

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

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

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

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

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

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

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

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

3511
	perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3512

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

	script->allocated = true;
	return 0;
}

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

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

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

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

	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

3586 3587 3588 3589 3590 3591
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);
3592
	symbol_conf.nanosecs = true;
3593 3594 3595 3596 3597 3598 3599
	return 0;
}

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

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

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

3821 3822
	perf_set_singlethreaded();

3823 3824
	setup_scripting();

3825
	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3826 3827
			     PARSE_OPT_STOP_AT_NON_OPTION);

3828 3829 3830 3831 3832 3833 3834 3835 3836 3837
	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 已提交
3838 3839
	data.path  = input_name;
	data.force = symbol_conf.force;
3840

3841 3842 3843
	if (symbol__validate_sym_arguments())
		return -1;

3844 3845 3846
	if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
		rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
		if (!rec_script_path)
3847
			return cmd_record(argc, argv);
3848 3849
	}

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

3860 3861 3862 3863 3864 3865 3866
	if (reltime && deltatime) {
		fprintf(stderr,
			"reltime and deltatime - the two don't get along well. "
			"Please limit to --reltime or --deltatime.\n");
		return -1;
	}

3867
	if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
3868 3869 3870
	    itrace_synth_opts.callchain_sz > scripting_max_stack)
		scripting_max_stack = itrace_synth_opts.callchain_sz;

3871
	/* make sure PERF_EXEC_PATH is set for scripts */
3872
	set_argv_exec_path(get_argv_exec_path());
3873

3874
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
3875
		int live_pipe[2];
3876
		int rep_args;
3877 3878
		pid_t pid;

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

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

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
3911
			return -1;
3912 3913 3914 3915 3916
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
3917
			return -1;
3918 3919 3920
		}

		if (!pid) {
3921 3922
			j = 0;

3923 3924 3925
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

3926 3927 3928
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
3929 3930 3931 3932
				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
					err = -1;
					goto out;
				}
3933
			}
3934 3935

			__argv = malloc((argc + 6) * sizeof(const char *));
3936 3937 3938 3939 3940
			if (!__argv) {
				pr_err("malloc failed\n");
				err = -ENOMEM;
				goto out;
			}
3941

3942 3943 3944 3945 3946 3947 3948 3949 3950 3951
			__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;
3952 3953

			execvp("/bin/sh", (char **)__argv);
3954
			free(__argv);
3955 3956 3957 3958 3959 3960
			exit(-1);
		}

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

3961
		__argv = malloc((argc + 4) * sizeof(const char *));
3962 3963 3964 3965 3966 3967
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

3968 3969 3970 3971 3972 3973 3974 3975
		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;
3976 3977

		execvp("/bin/sh", (char **)__argv);
3978
		free(__argv);
3979 3980
		exit(-1);
	}
3981
script_found:
3982 3983 3984 3985
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
3986

3987 3988
	if (script_path) {
		j = 0;
3989

3990 3991
		if (!rec_script_path)
			system_wide = false;
3992 3993 3994 3995 3996 3997
		else if (!system_wide) {
			if (have_cmd(argc - 1, &argv[1]) != 0) {
				err = -1;
				goto out;
			}
		}
3998

3999
		__argv = malloc((argc + 2) * sizeof(const char *));
4000 4001 4002 4003 4004 4005
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

4006 4007 4008 4009
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
4010
		for (i = 2; i < argc; i++)
4011 4012
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
4013 4014

		execvp("/bin/sh", (char **)__argv);
4015
		free(__argv);
4016 4017
		exit(-1);
	}
T
Tom Zanussi 已提交
4018

4019
	if (dlfilter_file) {
4020
		dlfilter = dlfilter__new(dlfilter_file, dlargc, dlargv);
4021 4022 4023 4024
		if (!dlfilter)
			return -1;
	}

4025
	if (!script_name) {
4026
		setup_pager();
4027 4028
		use_browser = 0;
	}
F
Frederic Weisbecker 已提交
4029

4030
	session = perf_session__new(&data, &script.tool);
4031 4032
	if (IS_ERR(session))
		return PTR_ERR(session);
4033

4034
	if (header || header_only) {
4035
		script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
4036 4037
		perf_session__fprintf_info(session, stdout, show_full_info);
		if (header_only)
4038
			goto out_delete;
4039
	}
4040 4041
	if (show_full_info)
		script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
4042

4043
	if (symbol__init(&session->header.env) < 0)
4044 4045
		goto out_delete;

4046
	uname(&uts);
4047
	if (data.is_pipe) { /* Assume pipe_mode indicates native_arch */
4048
		native_arch = true;
4049 4050 4051 4052 4053 4054 4055
	} else if (session->header.env.arch) {
		if (!strcmp(uts.machine, session->header.env.arch))
			native_arch = true;
		else if (!strcmp(uts.machine, "x86_64") &&
			 !strcmp(session->header.env.arch, "i386"))
			native_arch = true;
	}
4056

4057
	script.session = session;
4058
	script__setup_sample_type(&script);
4059

4060 4061
	if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
	    symbol_conf.graph_function)
4062 4063
		itrace_synth_opts.thread_stack = true;

4064 4065
	session->itrace_synth_opts = &itrace_synth_opts;

4066
	if (cpu_list) {
4067 4068 4069
		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
		if (err < 0)
			goto out_delete;
4070
		itrace_synth_opts.cpu_bitmap = cpu_bitmap;
4071 4072
	}

4073
	if (!no_callchain)
4074 4075 4076 4077
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

4078
	if (session->tevent.pevent &&
4079 4080 4081
	    tep_set_function_resolver(session->tevent.pevent,
				      machine__resolve_kernel_addr,
				      &session->machines.host) < 0) {
4082
		pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
4083 4084
		err = -1;
		goto out_delete;
4085 4086
	}

T
Tom Zanussi 已提交
4087 4088
	if (generate_script_lang) {
		struct stat perf_stat;
4089 4090
		int input;

4091
		if (output_set_by_user()) {
4092 4093
			fprintf(stderr,
				"custom fields not supported for generated scripts");
4094 4095
			err = -EINVAL;
			goto out_delete;
4096
		}
T
Tom Zanussi 已提交
4097

J
Jiri Olsa 已提交
4098
		input = open(data.path, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
4099
		if (input < 0) {
4100
			err = -errno;
T
Tom Zanussi 已提交
4101
			perror("failed to open file");
4102
			goto out_delete;
T
Tom Zanussi 已提交
4103 4104 4105 4106 4107
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
4108
			goto out_delete;
T
Tom Zanussi 已提交
4109 4110 4111 4112
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
4113
			goto out_delete;
T
Tom Zanussi 已提交
4114 4115 4116 4117 4118
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
4119 4120
			err = -ENOENT;
			goto out_delete;
T
Tom Zanussi 已提交
4121 4122
		}

J
Jiri Olsa 已提交
4123
		err = scripting_ops->generate_script(session->tevent.pevent,
4124
						     "perf-script");
4125
		goto out_delete;
T
Tom Zanussi 已提交
4126 4127
	}

4128 4129 4130 4131
	err = dlfilter__start(dlfilter, session);
	if (err)
		goto out_delete;

T
Tom Zanussi 已提交
4132
	if (script_name) {
4133
		err = scripting_ops->start_script(script_name, argc, argv, session);
T
Tom Zanussi 已提交
4134
		if (err)
4135
			goto out_delete;
4136
		pr_debug("perf script started with script %s\n\n", script_name);
4137
		script_started = true;
T
Tom Zanussi 已提交
4138 4139
	}

4140 4141 4142

	err = perf_session__check_output_opt(session);
	if (err < 0)
4143
		goto out_delete;
4144

4145
	if (script.time_str) {
4146
		err = perf_time__parse_for_ranges_reltime(script.time_str, session,
4147 4148
						  &script.ptime_range,
						  &script.range_size,
4149 4150
						  &script.range_num,
						  reltime);
4151
		if (err < 0)
4152
			goto out_delete;
4153 4154 4155 4156

		itrace_synth_opts__set_time_range(&itrace_synth_opts,
						  script.ptime_range,
						  script.range_num);
4157 4158
	}

4159 4160 4161
	err = evswitch__init(&script.evswitch, session->evlist, stderr);
	if (err)
		goto out_delete;
4162

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

4166
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
4167

4168 4169
	flush_scripting();

4170
out_delete:
4171 4172
	if (script.ptime_range) {
		itrace_synth_opts__clear_time_range(&itrace_synth_opts);
4173
		zfree(&script.ptime_range);
4174
	}
4175

4176
	zstd_fini(&(session->zstd_data));
4177
	evlist__free_stats(session->evlist);
4178
	perf_session__delete(session);
4179
	perf_script__exit(&script);
4180 4181 4182

	if (script_started)
		cleanup_scripting();
4183
	dlfilter__cleanup(dlfilter);
4184
	free_dlarg();
T
Tom Zanussi 已提交
4185 4186
out:
	return err;
F
Frederic Weisbecker 已提交
4187
}