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

62
#include <linux/ctype.h>
63

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

83
unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
84

85
enum perf_output_field {
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
	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,
118
	PERF_OUTPUT_TOD             = 1ULL << 32,
K
Kan Liang 已提交
119
	PERF_OUTPUT_DATA_PAGE_SIZE  = 1ULL << 33,
120
	PERF_OUTPUT_CODE_PAGE_SIZE  = 1ULL << 34,
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
};

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;
146 147 148 149 150 151 152 153 154 155 156 157 158
};

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

189 190
enum {
	OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
191
	OUTPUT_TYPE_OTHER,
192 193 194
	OUTPUT_TYPE_MAX
};

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

	[PERF_TYPE_HARDWARE] = {
		.user_set = false,

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

215
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
216 217 218 219 220 221 222
	},

	[PERF_TYPE_SOFTWARE] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
223
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
224 225 226
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
			      PERF_OUTPUT_BPF_OUTPUT,
227 228 229 230 231 232 233 234 235

		.invalid_fields = PERF_OUTPUT_TRACE,
	},

	[PERF_TYPE_TRACEPOINT] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
				  PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
236
				  PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
237
	},
238

239 240 241 242 243 244 245 246 247 248 249 250
	[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,
	},

251 252 253 254 255
	[PERF_TYPE_RAW] = {
		.user_set = false,

		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
256
			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
257 258 259
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
			      PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
K
Kan Liang 已提交
260
			      PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR |
261
			      PERF_OUTPUT_DATA_PAGE_SIZE | PERF_OUTPUT_CODE_PAGE_SIZE,
262

263
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
264
	},
265 266 267 268 269 270 271

	[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 |
272 273
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
274

275
		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
276
	},
277 278 279 280 281 282 283

	[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 |
284 285
			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
			      PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
286 287 288

		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
	},
289 290 291 292 293 294 295 296 297 298 299 300

	[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,
	},
301
};
302

303
struct evsel_script {
304 305 306
       char *filename;
       FILE *fp;
       u64  samples;
307 308 309
       /* For metric output */
       u64  val;
       int  gnum;
310 311
};

312
static inline struct evsel_script *evsel_script(struct evsel *evsel)
313
{
314
	return (struct evsel_script *)evsel->priv;
315 316
}

317
static struct evsel_script *evsel_script__new(struct evsel *evsel, struct perf_data *data)
318
{
319
	struct evsel_script *es = zalloc(sizeof(*es));
320 321

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

337
static void evsel_script__delete(struct evsel_script *es)
338 339 340 341 342 343 344
{
	zfree(&es->filename);
	fclose(es->fp);
	es->fp = NULL;
	free(es);
}

345
static int evsel_script__fprintf(struct evsel_script *es, FILE *fp)
346 347 348 349 350 351 352 353
{
	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);
}

354 355 356 357 358 359
static inline int output_type(unsigned int type)
{
	switch (type) {
	case PERF_TYPE_SYNTH:
		return OUTPUT_TYPE_SYNTH;
	default:
360 361
		if (type < PERF_TYPE_MAX)
			return type;
362
	}
363 364

	return OUTPUT_TYPE_OTHER;
365 366 367 368 369 370 371 372 373 374 375 376
}

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

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

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

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

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

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

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

	return 0;
}

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

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

444 445 446
	if (perf_header__has_feat(&session->header, HEADER_STAT))
		return 0;

447 448
	allow_user_set = perf_header__has_feat(&session->header,
					       HEADER_AUXTRACE);
449

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

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

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

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

	if (PRINT_FIELD(WEIGHT) &&
468
	    evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT", PERF_OUTPUT_WEIGHT))
469 470
		return -EINVAL;

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

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

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

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

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

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

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

527 528 529 530
	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;

531 532 533
	return 0;
}

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

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

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

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

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

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

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

565 566
	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
		evsel = perf_session__find_first_evtype(session, attr_type(j));
567 568 569 570 571

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

		if (evsel && output[j].fields &&
581
			evsel__check_attr(evsel, session))
582
			return -1;
583 584 585 586

		if (evsel == NULL)
			continue;

587
		set_print_ip_opts(&evsel->core.attr);
588
		tod |= output[j].fields & PERF_OUTPUT_TOD;
589 590
	}

591 592
	if (!no_callchain) {
		bool use_callchain = false;
593
		bool not_pipe = false;
594

595
		evlist__for_each_entry(session->evlist, evsel) {
596
			not_pipe = true;
597
			if (evsel__has_callchain(evsel)) {
598 599 600 601
				use_callchain = true;
				break;
			}
		}
602
		if (not_pipe && !use_callchain)
603 604 605
			symbol_conf.use_callchain = false;
	}

606 607 608 609 610 611 612 613
	/*
	 * 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;

614
		evlist__for_each_entry(session->evlist, evsel) {
615
			if (evsel->core.attr.type != j)
616 617
				continue;

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

629 630 631 632 633
	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;
	}
634
out:
635 636
	return 0;
}
637

638
static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
639
				     FILE *fp)
A
Andi Kleen 已提交
640 641
{
	unsigned i = 0, r;
642
	int printed = 0;
A
Andi Kleen 已提交
643 644

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

647
	printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
A
Andi Kleen 已提交
648 649 650

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

	return printed;
A
Andi Kleen 已提交
655 656
}

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

707 708 709 710 711 712 713 714 715 716 717 718 719 720
static int perf_sample__fprintf_iregs(struct perf_sample *sample,
				      struct perf_event_attr *attr, FILE *fp)
{
	return perf_sample__fprintf_regs(&sample->intr_regs,
					 attr->sample_regs_intr, fp);
}

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

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

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

736
		if (latency_format)
737
			printed += fprintf(fp, "%8.8s ", comm);
738
		else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
739
			printed += fprintf(fp, "%s ", comm);
740
		else
741
			printed += fprintf(fp, "%16s ", comm);
742
	}
743

744
	if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
745
		printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
746
	else if (PRINT_FIELD(PID))
747
		printed += fprintf(fp, "%5d ", sample->pid);
748
	else if (PRINT_FIELD(TID))
749
		printed += fprintf(fp, "%5d ", sample->tid);
750 751 752

	if (PRINT_FIELD(CPU)) {
		if (latency_format)
753
			printed += fprintf(fp, "%3d ", sample->cpu);
754
		else
755
			printed += fprintf(fp, "[%03d] ", sample->cpu);
756
	}
757

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

		#undef has

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

802 803 804 805 806
	if (PRINT_FIELD(TOD)) {
		tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
		printed += fprintf(fp, "%s ", tstr);
	}

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

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

	return printed;
835 836
}

837 838 839 840 841 842 843 844 845
static inline char
mispred_str(struct branch_entry *br)
{
	if (!(br->flags.mispred  || br->flags.predicted))
		return '-';

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

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

	if (!(br && br->nr))
857
		return 0;
858 859

	for (i = 0; i < br->nr; i++) {
860 861
		from = entries[i].from;
		to   = entries[i].to;
862 863 864 865

		if (PRINT_FIELD(DSO)) {
			memset(&alf, 0, sizeof(alf));
			memset(&alt, 0, sizeof(alt));
866 867
			thread__find_map_fb(thread, sample->cpumode, from, &alf);
			thread__find_map_fb(thread, sample->cpumode, to, &alt);
868 869
		}

870
		printed += fprintf(fp, " 0x%"PRIx64, from);
871
		if (PRINT_FIELD(DSO)) {
872 873 874
			printed += fprintf(fp, "(");
			printed += map__fprintf_dsoname(alf.map, fp);
			printed += fprintf(fp, ")");
875 876
		}

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

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

	return printed;
892 893
}

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

	if (!(br && br->nr))
905
		return 0;
906 907 908 909 910

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

		memset(&alf, 0, sizeof(alf));
		memset(&alt, 0, sizeof(alt));
911 912
		from = entries[i].from;
		to   = entries[i].to;
913

914 915
		thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
		thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
916

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

	return printed;
938 939
}

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

	if (!(br && br->nr))
951
		return 0;
952 953 954 955 956

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

		memset(&alf, 0, sizeof(alf));
		memset(&alt, 0, sizeof(alt));
957 958
		from = entries[i].from;
		to   = entries[i].to;
959

960
		if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
961
		    !alf.map->dso->adjust_symbols)
962 963
			from = map__map_ip(alf.map, from);

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

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

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

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

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

1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
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 已提交
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
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;
}

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

1128 1129 1130
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)
1131 1132
{
	struct addr_location al;
1133
	int off, printed = 0;
1134 1135 1136

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

1137 1138
	thread__find_map(thread, cpumode, addr, &al);

1139
	if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1140
		return 0;
1141 1142 1143 1144 1145 1146 1147

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

	if (!al.sym)
1148
		return 0;
1149 1150 1151 1152 1153

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

	return printed;
1164 1165
}

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

	if (!(br && br->nr))
1182
		return 0;
1183 1184 1185 1186 1187 1188 1189
	nr = br->nr;
	if (max_blocks && nr > max_blocks + 1)
		nr = max_blocks + 1;

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

1190
	printed += fprintf(fp, "%c", '\n');
1191 1192

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

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

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

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

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

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

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

	if (!sample_addr_correlates_sym(attr))
1315
		goto out;
1316

1317
	thread__resolve(thread, &al, sample);
1318 1319

	if (PRINT_FIELD(SYM)) {
1320
		printed += fprintf(fp, " ");
1321
		if (PRINT_FIELD(SYMOFFSET))
1322
			printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1323
		else
1324
			printed += symbol__fprintf_symname(al.sym, fp);
1325 1326 1327
	}

	if (PRINT_FIELD(DSO)) {
1328 1329 1330
		printed += fprintf(fp, " (");
		printed += map__fprintf_dsoname(al.map, fp);
		printed += fprintf(fp, ")");
1331
	}
1332 1333
out:
	return printed;
1334 1335
}

1336
static const char *resolve_branch_sym(struct perf_sample *sample,
1337
				      struct evsel *evsel,
1338 1339 1340 1341 1342
				      struct thread *thread,
				      struct addr_location *al,
				      u64 *ip)
{
	struct addr_location addr_al;
1343
	struct perf_event_attr *attr = &evsel->core.attr;
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
	const char *name = NULL;

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

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

1385
	name = resolve_branch_sym(sample, evsel, thread, al, &ip);
1386

1387 1388 1389 1390 1391 1392
	if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
		dlen += fprintf(fp, "(");
		dlen += map__fprintf_dsoname(al->map, fp);
		dlen += fprintf(fp, ")\t");
	}

1393
	if (name)
1394
		len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1395
	else if (ip)
1396
		len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1397 1398

	if (len < 0)
1399
		return len;
1400 1401 1402 1403 1404 1405 1406 1407 1408

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

1411
	return len + dlen;
1412 1413
}

1414 1415 1416 1417 1418 1419
__weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
			    struct thread *thread __maybe_unused,
			    struct machine *machine __maybe_unused)
{
}

1420 1421 1422 1423
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 已提交
1424
{
1425 1426
	int printed = 0;

1427 1428 1429
	if (sample->insn_len == 0 && native_arch)
		arch_fetch_insn(sample, thread, machine);

A
Andi Kleen 已提交
1430
	if (PRINT_FIELD(INSNLEN))
1431
		printed += fprintf(fp, " ilen: %d", sample->insn_len);
1432
	if (PRINT_FIELD(INSN) && sample->insn_len) {
A
Andi Kleen 已提交
1433 1434
		int i;

1435
		printed += fprintf(fp, " insn:");
A
Andi Kleen 已提交
1436
		for (i = 0; i < sample->insn_len; i++)
1437
			printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
A
Andi Kleen 已提交
1438
	}
1439
	if (PRINT_FIELD(BRSTACKINSN))
1440 1441 1442
		printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);

	return printed;
A
Andi Kleen 已提交
1443 1444
}

1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458
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);
}

1459
static int perf_sample__fprintf_bts(struct perf_sample *sample,
1460
				    struct evsel *evsel,
1461 1462 1463
				    struct thread *thread,
				    struct addr_location *al,
				    struct machine *machine, FILE *fp)
1464
{
1465
	struct perf_event_attr *attr = &evsel->core.attr;
1466
	unsigned int type = output_type(attr->type);
1467
	bool print_srcline_last = false;
1468
	int printed = 0;
1469

1470
	if (PRINT_FIELD(CALLINDENT))
1471
		printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, fp);
1472

1473 1474
	/* print branch_from information */
	if (PRINT_FIELD(IP)) {
1475
		unsigned int print_opts = output[type].print_ip_opts;
1476
		struct callchain_cursor *cursor = NULL;
1477

1478
		if (symbol_conf.use_callchain && sample->callchain &&
1479
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1480
					      sample, NULL, NULL, scripting_max_stack) == 0)
1481
			cursor = &callchain_cursor;
1482 1483

		if (cursor == NULL) {
1484
			printed += fprintf(fp, " ");
1485
			if (print_opts & EVSEL__PRINT_SRCLINE) {
1486
				print_srcline_last = true;
1487
				print_opts &= ~EVSEL__PRINT_SRCLINE;
1488
			}
1489
		} else
1490
			printed += fprintf(fp, "\n");
1491

1492 1493
		printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
					       symbol_conf.bt_stop_list, fp);
1494 1495 1496
	}

	/* print branch_to information */
1497
	if (PRINT_FIELD(ADDR) ||
1498
	    ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1499
	     !output[type].user_set)) {
1500 1501
		printed += fprintf(fp, " => ");
		printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1502
	}
1503

1504 1505
	printed += perf_sample__fprintf_ipc(sample, attr, fp);

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

1509
	printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
A
Andi Kleen 已提交
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
	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;
1520 1521
}

1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538
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"},
1539 1540
	{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"},
1541 1542 1543
	{0, NULL}
};

1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
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;
}

1556
int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz)
1557 1558
{
	const char *chars = PERF_IP_FLAG_CHARS;
1559
	const size_t n = strlen(PERF_IP_FLAG_CHARS);
1560 1561
	bool in_tx = flags & PERF_IP_FLAG_IN_TX;
	const char *name = NULL;
1562
	size_t i, pos = 0;
1563

1564 1565
	name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
	if (name)
1566
		return snprintf(str, sz, "%-15s%4s", name, in_tx ? "(x)" : "");
1567 1568 1569 1570

	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)
1571
			return snprintf(str, sz, "tr strt %-7s%4s", name, in_tx ? "(x)" : "");
1572 1573 1574 1575 1576
	}

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

1580
	for (i = 0; i < n; i++, flags >>= 1) {
1581
		if ((flags & 1) && pos < sz)
1582 1583 1584
			str[pos++] = chars[i];
	}
	for (; i < 32; i++, flags >>= 1) {
1585
		if ((flags & 1) && pos < sz)
1586 1587
			str[pos++] = '?';
	}
1588 1589 1590 1591 1592 1593 1594 1595 1596
	if (pos < sz)
		str[pos] = 0;

	return pos;
}

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

1598
	perf_sample__sprintf_flags(flags, str, sizeof(str));
1599
	return fprintf(fp, "  %-19s ", str);
1600 1601
}

1602 1603 1604 1605 1606 1607
struct printer_data {
	int line_no;
	bool hit_nul;
	bool is_printable;
};

1608 1609 1610
static int sample__fprintf_bpf_output(enum binary_printer_ops op,
				      unsigned int val,
				      void *extra, FILE *fp)
1611 1612 1613
{
	unsigned char ch = (unsigned char)val;
	struct printer_data *printer_data = extra;
1614
	int printed = 0;
1615 1616 1617

	switch (op) {
	case BINARY_PRINT_DATA_BEGIN:
1618
		printed += fprintf(fp, "\n");
1619 1620
		break;
	case BINARY_PRINT_LINE_BEGIN:
1621
		printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1622 1623 1624
						        "           ");
		break;
	case BINARY_PRINT_ADDR:
1625
		printed += fprintf(fp, " %04x:", val);
1626 1627
		break;
	case BINARY_PRINT_NUM_DATA:
1628
		printed += fprintf(fp, " %02x", val);
1629 1630
		break;
	case BINARY_PRINT_NUM_PAD:
1631
		printed += fprintf(fp, "   ");
1632 1633
		break;
	case BINARY_PRINT_SEP:
1634
		printed += fprintf(fp, "  ");
1635 1636 1637 1638 1639 1640
		break;
	case BINARY_PRINT_CHAR_DATA:
		if (printer_data->hit_nul && ch)
			printer_data->is_printable = false;

		if (!isprint(ch)) {
1641
			printed += fprintf(fp, "%c", '.');
1642 1643 1644 1645 1646 1647 1648 1649 1650

			if (!printer_data->is_printable)
				break;

			if (ch == '\0')
				printer_data->hit_nul = true;
			else
				printer_data->is_printable = false;
		} else {
1651
			printed += fprintf(fp, "%c", ch);
1652 1653 1654
		}
		break;
	case BINARY_PRINT_CHAR_PAD:
1655
		printed += fprintf(fp, " ");
1656 1657
		break;
	case BINARY_PRINT_LINE_END:
1658
		printed += fprintf(fp, "\n");
1659 1660 1661 1662 1663 1664
		printer_data->line_no++;
		break;
	case BINARY_PRINT_DATA_END:
	default:
		break;
	}
1665 1666

	return printed;
1667 1668
}

1669
static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1670 1671 1672
{
	unsigned int nr_bytes = sample->raw_size;
	struct printer_data printer_data = {0, false, true};
1673 1674
	int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
				      sample__fprintf_bpf_output, &printer_data, fp);
1675 1676

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

	return printed;
1680 1681
}

1682
static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1683 1684
{
	if (len > 0 && len < spacing)
1685 1686 1687
		return fprintf(fp, "%*s", spacing - len, "");

	return 0;
1688 1689
}

1690
static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1691
{
1692
	return perf_sample__fprintf_spacing(len, 34, fp);
1693 1694
}

1695
static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1696 1697 1698 1699 1700
{
	struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
	int len;

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

1703
	len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1704
		     data->ip, le64_to_cpu(data->payload));
1705
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1706 1707
}

1708
static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1709 1710 1711 1712 1713
{
	struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
	int len;

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

1716 1717 1718
	len = fprintf(fp, " hints: %#x extensions: %#x ",
		      data->hints, data->extensions);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1719 1720
}

1721
static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1722 1723 1724 1725 1726
{
	struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
	int len;

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

1729 1730 1731
	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);
1732 1733
}

1734
static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1735 1736 1737 1738 1739
{
	struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
	int len;

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

1742 1743
	len = fprintf(fp, " IP: %u ", data->ip);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1744 1745
}

1746
static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1747 1748 1749 1750 1751
{
	struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
	int len;

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

1754
	len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1755 1756
		     data->deepest_cstate, data->last_cstate,
		     data->wake_reason);
1757
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1758 1759
}

1760
static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1761 1762 1763 1764 1765 1766
{
	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))
1767
		return 0;
1768 1769

	freq = (le32_to_cpu(data->freq) + 500) / 1000;
1770
	len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1771 1772
	if (data->max_nonturbo) {
		percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1773
		len += fprintf(fp, "(%3u%%) ", percent);
1774
	}
1775
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1776 1777
}

A
Adrian Hunter 已提交
1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789
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);
}

1790
static int perf_sample__fprintf_synth(struct perf_sample *sample,
1791
				      struct evsel *evsel, FILE *fp)
1792
{
1793
	switch (evsel->core.attr.config) {
1794
	case PERF_SYNTH_INTEL_PTWRITE:
1795
		return perf_sample__fprintf_synth_ptwrite(sample, fp);
1796
	case PERF_SYNTH_INTEL_MWAIT:
1797
		return perf_sample__fprintf_synth_mwait(sample, fp);
1798
	case PERF_SYNTH_INTEL_PWRE:
1799
		return perf_sample__fprintf_synth_pwre(sample, fp);
1800
	case PERF_SYNTH_INTEL_EXSTOP:
1801
		return perf_sample__fprintf_synth_exstop(sample, fp);
1802
	case PERF_SYNTH_INTEL_PWRX:
1803
		return perf_sample__fprintf_synth_pwrx(sample, fp);
1804
	case PERF_SYNTH_INTEL_CBR:
1805
		return perf_sample__fprintf_synth_cbr(sample, fp);
A
Adrian Hunter 已提交
1806 1807
	case PERF_SYNTH_INTEL_PSB:
		return perf_sample__fprintf_synth_psb(sample, fp);
1808 1809 1810
	default:
		break;
	}
1811 1812

	return 0;
1813 1814
}

1815
static int evlist__max_name_len(struct evlist *evlist)
1816
{
1817
	struct evsel *evsel;
1818 1819
	int max = 0;

1820
	evlist__for_each_entry(evlist, evsel) {
1821
		int len = strlen(evsel__name(evsel));
1822 1823 1824 1825 1826 1827 1828

		max = MAX(len, max);
	}

	return max;
}

1829
static int data_src__fprintf(u64 data_src, FILE *fp)
J
Jiri Olsa 已提交
1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842
{
	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;

1843
	return fprintf(fp, "%-*s", maxlen, out);
J
Jiri Olsa 已提交
1844 1845
}

1846 1847 1848
struct metric_ctx {
	struct perf_sample	*sample;
	struct thread		*thread;
1849
	struct evsel	*evsel;
1850 1851 1852
	FILE 			*fp;
};

1853 1854
static void script_print_metric(struct perf_stat_config *config __maybe_unused,
				void *ctx, const char *color,
1855 1856 1857 1858 1859 1860 1861
			        const char *fmt,
			        const char *unit, double val)
{
	struct metric_ctx *mctx = ctx;

	if (!fmt)
		return;
1862
	perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1863
				   PERF_RECORD_SAMPLE, mctx->fp);
1864 1865 1866 1867 1868 1869 1870 1871
	fputs("\tmetric: ", mctx->fp);
	if (color)
		color_fprintf(mctx->fp, color, fmt, val);
	else
		printf(fmt, val);
	fprintf(mctx->fp, " %s\n", unit);
}

1872 1873
static void script_new_line(struct perf_stat_config *config __maybe_unused,
			    void *ctx)
1874 1875 1876
{
	struct metric_ctx *mctx = ctx;

1877
	perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1878
				   PERF_RECORD_SAMPLE, mctx->fp);
1879 1880 1881 1882 1883
	fputs("\tmetric: ", mctx->fp);
}

static void perf_sample__fprint_metric(struct perf_script *script,
				       struct thread *thread,
1884
				       struct evsel *evsel,
1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
				       struct perf_sample *sample,
				       FILE *fp)
{
	struct perf_stat_output_ctx ctx = {
		.print_metric = script_print_metric,
		.new_line = script_new_line,
		.ctx = &(struct metric_ctx) {
				.sample = sample,
				.thread = thread,
				.evsel  = evsel,
				.fp     = fp,
			 },
		.force_header = false,
	};
1899
	struct evsel *ev2;
1900 1901 1902
	u64 val;

	if (!evsel->stats)
1903
		evlist__alloc_stats(script->session->evlist, false);
1904 1905 1906 1907 1908
	if (evsel_script(evsel->leader)->gnum++ == 0)
		perf_stat__reset_shadow_stats();
	val = sample->period * evsel->scale;
	perf_stat__update_shadow_stats(evsel,
				       val,
1909 1910
				       sample->cpu,
				       &rt_stat);
1911
	evsel_script(evsel)->val = val;
1912
	if (evsel_script(evsel->leader)->gnum == evsel->leader->core.nr_members) {
1913
		for_each_group_member (ev2, evsel->leader) {
1914
			perf_stat__print_shadow_stats(&stat_config, ev2,
1915 1916 1917
						      evsel_script(ev2)->val,
						      sample->cpu,
						      &ctx,
J
Jin Yao 已提交
1918 1919
						      NULL,
						      &rt_stat);
1920 1921 1922 1923 1924
		}
		evsel_script(evsel->leader)->gnum = 0;
	}
}

1925
static bool show_event(struct perf_sample *sample,
1926
		       struct evsel *evsel,
1927 1928 1929
		       struct thread *thread,
		       struct addr_location *al)
{
1930
	int depth = thread_stack__depth(thread, sample->cpu);
1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965

	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;
		const char *name = resolve_branch_sym(sample, evsel, thread, al,
				&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;
	}
}

1966
static void process_event(struct perf_script *script,
1967
			  struct perf_sample *sample, struct evsel *evsel,
1968 1969
			  struct addr_location *al,
			  struct machine *machine)
1970
{
1971
	struct thread *thread = al->thread;
1972
	struct perf_event_attr *attr = &evsel->core.attr;
1973
	unsigned int type = output_type(attr->type);
1974
	struct evsel_script *es = evsel->priv;
1975
	FILE *fp = es->fp;
K
Kan Liang 已提交
1976
	char str[PAGE_SIZE_NAME_LEN];
1977

1978
	if (output[type].fields == 0)
1979 1980
		return;

1981 1982 1983
	if (!show_event(sample, evsel, thread, al))
		return;

1984 1985
	if (evswitch__discard(&script->evswitch, evsel))
		return;
1986

1987 1988
	++es->samples;

1989
	perf_sample__fprintf_start(script, sample, thread, evsel,
1990
				   PERF_RECORD_SAMPLE, fp);
1991

J
Jiri Olsa 已提交
1992
	if (PRINT_FIELD(PERIOD))
1993
		fprintf(fp, "%10" PRIu64 " ", sample->period);
J
Jiri Olsa 已提交
1994

1995
	if (PRINT_FIELD(EVNAME)) {
1996
		const char *evname = evsel__name(evsel);
1997 1998

		if (!script->name_width)
1999
			script->name_width = evlist__max_name_len(script->session->evlist);
2000

2001
		fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
2002 2003
	}

2004
	if (print_flags)
2005
		perf_sample__fprintf_flags(sample->flags, fp);
2006

2007
	if (is_bts_event(attr)) {
2008
		perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
2009 2010 2011
		return;
	}

2012
	if (PRINT_FIELD(TRACE) && sample->raw_data) {
2013 2014 2015
		event_format__fprintf(evsel->tp_format, sample->cpu,
				      sample->raw_data, sample->raw_size, fp);
	}
2016 2017

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

2020
	if (PRINT_FIELD(ADDR))
2021
		perf_sample__fprintf_addr(sample, thread, attr, fp);
2022

2023
	if (PRINT_FIELD(DATA_SRC))
2024
		data_src__fprintf(sample->data_src, fp);
2025 2026

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

2029
	if (PRINT_FIELD(IP)) {
2030
		struct callchain_cursor *cursor = NULL;
2031

2032 2033 2034
		if (script->stitch_lbr)
			al->thread->lbr_stitch_enable = true;

2035
		if (symbol_conf.use_callchain && sample->callchain &&
2036
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
2037
					      sample, NULL, NULL, scripting_max_stack) == 0)
2038
			cursor = &callchain_cursor;
2039

2040
		fputc(cursor ? '\n' : ' ', fp);
2041 2042
		sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
				    symbol_conf.bt_stop_list, fp);
2043 2044
	}

2045
	if (PRINT_FIELD(IREGS))
2046
		perf_sample__fprintf_iregs(sample, attr, fp);
2047

A
Andi Kleen 已提交
2048
	if (PRINT_FIELD(UREGS))
2049
		perf_sample__fprintf_uregs(sample, attr, fp);
A
Andi Kleen 已提交
2050

2051
	if (PRINT_FIELD(BRSTACK))
2052
		perf_sample__fprintf_brstack(sample, thread, attr, fp);
2053
	else if (PRINT_FIELD(BRSTACKSYM))
2054
		perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2055
	else if (PRINT_FIELD(BRSTACKOFF))
2056
		perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2057

2058
	if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2059 2060
		perf_sample__fprintf_bpf_output(sample, fp);
	perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2061 2062

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

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

2068 2069 2070
	if (PRINT_FIELD(CODE_PAGE_SIZE))
		fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));

2071 2072
	perf_sample__fprintf_ipc(sample, attr, fp);

2073
	fprintf(fp, "\n");
2074

A
Andi Kleen 已提交
2075 2076 2077 2078 2079 2080
	if (PRINT_FIELD(SRCCODE)) {
		if (map__fprintf_srccode(al->map, al->addr, stdout,
					 &thread->srccode_state))
			printf("\n");
	}

2081 2082
	if (PRINT_FIELD(METRIC))
		perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2083 2084 2085

	if (verbose)
		fflush(fp);
2086 2087
}

T
Tom Zanussi 已提交
2088 2089
static struct scripting_ops	*scripting_ops;

2090
static void __process_stat(struct evsel *counter, u64 tstamp)
2091
{
2092
	int nthreads = perf_thread_map__nr(counter->core.threads);
2093
	int ncpus = evsel__nr_cpus(counter);
2094 2095 2096
	int cpu, thread;
	static int header_printed;

2097
	if (counter->core.system_wide)
2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112
		nthreads = 1;

	if (!header_printed) {
		printf("%3s %8s %15s %15s %15s %15s %s\n",
		       "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
		header_printed = 1;
	}

	for (thread = 0; thread < nthreads; thread++) {
		for (cpu = 0; cpu < ncpus; cpu++) {
			struct perf_counts_values *counts;

			counts = perf_counts(counter->counts, cpu, thread);

			printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2113
				counter->core.cpus->map[cpu],
2114
				perf_thread_map__pid(counter->core.threads, thread),
2115 2116 2117 2118
				counts->val,
				counts->ena,
				counts->run,
				tstamp,
2119
				evsel__name(counter));
2120 2121 2122 2123
		}
	}
}

2124
static void process_stat(struct evsel *counter, u64 tstamp)
2125 2126 2127
{
	if (scripting_ops && scripting_ops->process_stat)
		scripting_ops->process_stat(&stat_config, counter, tstamp);
2128 2129
	else
		__process_stat(counter, tstamp);
2130 2131 2132 2133 2134 2135 2136 2137
}

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

T
Tom Zanussi 已提交
2138 2139
static void setup_scripting(void)
{
2140
	setup_perl_scripting();
2141
	setup_python_scripting();
T
Tom Zanussi 已提交
2142 2143
}

2144 2145
static int flush_scripting(void)
{
2146
	return scripting_ops ? scripting_ops->flush_script() : 0;
2147 2148
}

T
Tom Zanussi 已提交
2149 2150
static int cleanup_scripting(void)
{
2151
	pr_debug("\nperf script stopped\n");
2152

2153
	return scripting_ops ? scripting_ops->stop_script() : 0;
T
Tom Zanussi 已提交
2154 2155
}

2156 2157
static bool filter_cpu(struct perf_sample *sample)
{
2158
	if (cpu_list && sample->cpu != (u32)-1)
2159 2160 2161 2162
		return !test_bit(sample->cpu, cpu_bitmap);
	return false;
}

2163
static int process_sample_event(struct perf_tool *tool,
2164
				union perf_event *event,
2165
				struct perf_sample *sample,
2166
				struct evsel *evsel,
2167
				struct machine *machine)
F
Frederic Weisbecker 已提交
2168
{
2169
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
2170
	struct addr_location al;
F
Frederic Weisbecker 已提交
2171

2172 2173
	if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
					  sample->time)) {
2174
		return 0;
2175
	}
2176

2177 2178 2179 2180 2181 2182
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
2183
		}
2184 2185
		last_timestamp = sample->time;
		return 0;
F
Frederic Weisbecker 已提交
2186
	}
2187

2188
	if (machine__resolve(machine, &al, sample) < 0) {
2189 2190 2191 2192 2193 2194
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
		return -1;
	}

	if (al.filtered)
2195
		goto out_put;
2196

2197
	if (filter_cpu(sample))
2198
		goto out_put;
2199

2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210
	if (scripting_ops) {
		struct addr_location *addr_al_ptr = NULL;
		struct addr_location addr_al;

		if ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
		    sample_addr_correlates_sym(&evsel->core.attr)) {
			thread__resolve(al.thread, &addr_al, sample);
			addr_al_ptr = &addr_al;
		}
		scripting_ops->process_event(event, sample, evsel, &al, addr_al_ptr);
	} else {
2211
		process_event(scr, sample, evsel, &al, machine);
2212
	}
2213

2214 2215
out_put:
	addr_location__put(&al);
F
Frederic Weisbecker 已提交
2216 2217 2218
	return 0;
}

2219
static int process_attr(struct perf_tool *tool, union perf_event *event,
2220
			struct evlist **pevlist)
2221 2222
{
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
2223
	struct evlist *evlist;
2224
	struct evsel *evsel, *pos;
2225
	u64 sample_type;
2226
	int err;
2227
	static struct evsel_script *es;
2228 2229 2230 2231 2232 2233

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

	evlist = *pevlist;
2234
	evsel = evlist__last(*pevlist);
2235

2236 2237
	if (!evsel->priv) {
		if (scr->per_event_dump) {
2238
			evsel->priv = evsel_script__new(evsel, scr->session->data);
2239 2240 2241 2242 2243 2244 2245 2246 2247
		} else {
			es = zalloc(sizeof(*es));
			if (!es)
				return -ENOMEM;
			es->fp = stdout;
			evsel->priv = es;
		}
	}

2248 2249
	if (evsel->core.attr.type >= PERF_TYPE_MAX &&
	    evsel->core.attr.type != PERF_TYPE_SYNTH)
2250 2251
		return 0;

2252
	evlist__for_each_entry(evlist, pos) {
2253
		if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2254 2255 2256
			return 0;
	}

2257
	if (evsel->core.attr.sample_type) {
2258
		err = evsel__check_attr(evsel, scr->session);
2259 2260 2261
		if (err)
			return err;
	}
2262

2263 2264 2265 2266
	/*
	 * Check if we need to enable callchains based
	 * on events sample_type.
	 */
2267
	sample_type = evlist__combined_sample_type(evlist);
2268
	callchain_param_setup(sample_type);
2269

2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281
	/* 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;
2282 2283
	}
	set_print_ip_opts(&evsel->core.attr);
2284
	return 0;
2285 2286
}

2287 2288 2289 2290 2291
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)
2292 2293 2294
{
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
2295
	struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2296
	struct thread *thread = NULL;
2297

2298 2299 2300 2301 2302
	if (evsel && !evsel->core.attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = timestamp;
		sample->pid = pid;
		sample->tid = tid;
2303 2304
	}

2305 2306
	if (filter_cpu(sample))
		return 0;
2307

2308 2309 2310
	if (tid != -1)
		thread = machine__findnew_thread(machine, pid, tid);

2311
	if (evsel) {
2312
		perf_sample__fprintf_start(script, sample, thread, evsel,
2313
					   event->header.type, stdout);
2314
	}
2315

2316
	perf_event__fprintf(event, machine, stdout);
2317

2318
	thread__put(thread);
2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339

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

2342 2343 2344 2345 2346 2347
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)
2348
		return -1;
2349

2350 2351
	return print_event(tool, event, sample, machine, event->namespaces.pid,
			   event->namespaces.tid);
2352 2353
}

2354 2355 2356 2357 2358 2359
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)
2360
		return -1;
2361

2362 2363
	return print_event(tool, event, sample, machine, sample->pid,
			    sample->tid);
2364 2365
}

2366 2367 2368 2369 2370 2371 2372 2373
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;

2374 2375 2376
	return print_event_with_time(tool, event, sample, machine,
				     event->fork.pid, event->fork.tid,
				     event->fork.time);
2377 2378 2379 2380 2381 2382
}
static int process_exit_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
2383 2384 2385
	/* Print before 'exit' deletes anything */
	if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
				  event->fork.tid, event->fork.time))
2386 2387
		return -1;

2388
	return perf_event__process_exit(tool, event, sample, machine);
2389 2390
}

2391 2392 2393 2394 2395 2396 2397 2398
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;

2399 2400
	return print_event(tool, event, sample, machine, event->mmap.pid,
			   event->mmap.tid);
2401 2402 2403 2404 2405 2406 2407 2408 2409 2410
}

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;

2411 2412
	return print_event(tool, event, sample, machine, event->mmap2.pid,
			   event->mmap2.tid);
2413 2414
}

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

2425 2426 2427 2428 2429 2430
	if (scripting_ops && scripting_ops->process_switch)
		scripting_ops->process_switch(event, sample, machine);

	if (!script->show_switch_events)
		return 0;

2431 2432
	return print_event(tool, event, sample, machine, sample->pid,
			   sample->tid);
2433 2434
}

2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445
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);
}

2446 2447 2448 2449 2450 2451
static int
process_lost_event(struct perf_tool *tool,
		   union perf_event *event,
		   struct perf_sample *sample,
		   struct machine *machine)
{
2452 2453
	return print_event(tool, event, sample, machine, sample->pid,
			   sample->tid);
2454 2455
}

2456 2457 2458 2459 2460 2461
static int
process_finished_round_event(struct perf_tool *tool __maybe_unused,
			     union perf_event *event,
			     struct ordered_events *oe __maybe_unused)

{
2462
	perf_event__fprintf(event, NULL, stdout);
2463 2464 2465
	return 0;
}

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

2475 2476
	return print_event(tool, event, sample, machine, sample->pid,
			   sample->tid);
2477 2478
}

2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490
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);
}

2491
static void sig_handler(int sig __maybe_unused)
2492 2493 2494 2495
{
	session_done = 1;
}

2496 2497
static void perf_script__fclose_per_event_dump(struct perf_script *script)
{
2498
	struct evlist *evlist = script->session->evlist;
2499
	struct evsel *evsel;
2500 2501 2502 2503

	evlist__for_each_entry(evlist, evsel) {
		if (!evsel->priv)
			break;
2504
		evsel_script__delete(evsel->priv);
2505 2506 2507 2508 2509 2510
		evsel->priv = NULL;
	}
}

static int perf_script__fopen_per_event_dump(struct perf_script *script)
{
2511
	struct evsel *evsel;
2512 2513

	evlist__for_each_entry(script->session->evlist, evsel) {
2514 2515 2516
		/*
		 * Already setup? I.e. we may be called twice in cases like
		 * Intel PT, one for the intel_pt// and dummy events, then
2517
		 * for the evsels synthesized from the auxtrace info.
2518 2519 2520 2521 2522 2523
		 *
		 * Ses perf_script__process_auxtrace_info.
		 */
		if (evsel->priv != NULL)
			continue;

2524
		evsel->priv = evsel_script__new(evsel, script->session->data);
2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537
		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)
{
2538 2539
	struct evsel *evsel;
	static struct evsel_script es_stdout;
2540 2541 2542 2543

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

2544 2545
	es_stdout.fp = stdout;

2546
	evlist__for_each_entry(script->session->evlist, evsel)
2547
		evsel->priv = &es_stdout;
2548 2549 2550 2551

	return 0;
}

2552 2553
static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
{
2554
	struct evsel *evsel;
2555 2556

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

2559 2560
		evsel_script__fprintf(es, stdout);
		evsel_script__delete(es);
2561 2562 2563 2564
		evsel->priv = NULL;
	}
}

2565
static int __cmd_script(struct perf_script *script)
F
Frederic Weisbecker 已提交
2566
{
2567 2568
	int ret;

2569 2570
	signal(SIGINT, sig_handler);

2571 2572
	perf_stat__init_shadow_stats();

2573 2574 2575 2576 2577 2578
	/* 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;
	}
2579 2580 2581 2582
	if (script->show_mmap_events) {
		script->tool.mmap = process_mmap_event;
		script->tool.mmap2 = process_mmap2_event;
	}
2583
	if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2584
		script->tool.context_switch = process_switch_event;
2585 2586
	if (scripting_ops && scripting_ops->process_auxtrace_error)
		script->tool.auxtrace_error = process_auxtrace_error;
2587 2588
	if (script->show_namespace_events)
		script->tool.namespaces = process_namespaces_event;
2589 2590
	if (script->show_cgroup_events)
		script->tool.cgroup = process_cgroup_event;
2591 2592
	if (script->show_lost_events)
		script->tool.lost = process_lost_event;
2593 2594 2595 2596
	if (script->show_round_events) {
		script->tool.ordered_events = false;
		script->tool.finished_round = process_finished_round_event;
	}
2597
	if (script->show_bpf_events) {
2598 2599
		script->tool.ksymbol = process_bpf_events;
		script->tool.bpf     = process_bpf_events;
2600
	}
2601 2602 2603 2604
	if (script->show_text_poke_events) {
		script->tool.ksymbol   = process_bpf_events;
		script->tool.text_poke = process_text_poke_events;
	}
2605

2606 2607 2608 2609 2610
	if (perf_script__setup_per_event_dump(script)) {
		pr_err("Couldn't create the per event dump files\n");
		return -1;
	}

2611
	ret = perf_session__process_events(script->session);
2612

2613
	if (script->per_event_dump)
2614
		perf_script__exit_per_event_dump_stats(script);
2615

2616
	if (debug_mode)
2617
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2618 2619

	return ret;
F
Frederic Weisbecker 已提交
2620 2621
}

T
Tom Zanussi 已提交
2622 2623 2624
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
2625
	char			spec[];
T
Tom Zanussi 已提交
2626 2627
};

2628
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665

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;

2666
	s = script_spec__new(spec, ops);
T
Tom Zanussi 已提交
2667 2668
	if (!s)
		return -1;
2669 2670
	else
		script_spec__add(s);
T
Tom Zanussi 已提交
2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689

	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 "
2690
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
2691 2692 2693 2694 2695 2696 2697

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

	fprintf(stderr, "\n");
}

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

2729 2730
static int parse_scriptname(const struct option *opt __maybe_unused,
			    const char *str, int unset __maybe_unused)
T
Tom Zanussi 已提交
2731 2732 2733 2734 2735
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

2736
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
2737
		list_available_languages();
2738
		exit(0);
T
Tom Zanussi 已提交
2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757
	}

	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;
2758
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769
		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;
		}
	}

2770 2771 2772
	script_name = find_script(script);
	if (!script_name)
		script_name = strdup(script);
T
Tom Zanussi 已提交
2773 2774 2775 2776

	return 0;
}

2777 2778
static int parse_output_fields(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused)
2779
{
2780
	char *tok, *strtok_saveptr = NULL;
2781
	int i, imax = ARRAY_SIZE(all_output_options);
2782
	int j;
2783 2784
	int rc = 0;
	char *str = strdup(arg);
2785
	int type = -1;
2786
	enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2787 2788 2789 2790

	if (!str)
		return -ENOMEM;

2791 2792 2793
	/* 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.
2794
	 */
2795 2796 2797 2798 2799 2800 2801 2802 2803 2804
	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;
2805 2806
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
2807 2808
		else if (!strcmp(str, "break"))
			type = PERF_TYPE_BREAKPOINT;
2809 2810
		else if (!strcmp(str, "synth"))
			type = OUTPUT_TYPE_SYNTH;
2811 2812
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
2813 2814
			rc = -EINVAL;
			goto out;
2815 2816 2817 2818 2819 2820
		}

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

2821 2822 2823 2824
		/* Don't override defaults for +- */
		if (strchr(tok, '+') || strchr(tok, '-'))
			goto parse;

2825 2826
		output[type].fields = 0;
		output[type].user_set = true;
2827
		output[type].wildcard_set = false;
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837

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

2838 2839 2840 2841
		/* Don't override defaults for +- */
		if (strchr(str, '+') || strchr(str, '-'))
			goto parse;

2842 2843 2844
		if (output_set_by_user())
			pr_warning("Overriding previous field request for all events.\n");

2845
		for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2846 2847
			output[j].fields = 0;
			output[j].user_set = true;
2848
			output[j].wildcard_set = true;
2849
		}
2850 2851
	}

2852
parse:
2853
	for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869
		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;
		}

2870
		for (i = 0; i < imax; ++i) {
2871
			if (strcmp(tok, all_output_options[i].str) == 0)
2872 2873
				break;
		}
2874
		if (i == imax && strcmp(tok, "flags") == 0) {
Y
Yang Li 已提交
2875
			print_flags = change != REMOVE;
2876 2877
			continue;
		}
2878
		if (i == imax) {
2879
			fprintf(stderr, "Invalid field requested.\n");
2880
			rc = -EINVAL;
2881
			goto out;
2882 2883
		}

2884 2885 2886 2887
		if (type == -1) {
			/* add user option to all events types for
			 * which it is valid
			 */
2888
			for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2889 2890 2891
				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));
2892
				} else {
2893
					if (change == REMOVE) {
2894
						output[j].fields &= ~all_output_options[i].field;
2895
						output[j].user_set_fields &= ~all_output_options[i].field;
2896
						output[j].user_unset_fields |= all_output_options[i].field;
2897
					} else {
2898
						output[j].fields |= all_output_options[i].field;
2899
						output[j].user_set_fields |= all_output_options[i].field;
2900
						output[j].user_unset_fields &= ~all_output_options[i].field;
2901
					}
2902 2903
					output[j].user_set = true;
					output[j].wildcard_set = true;
2904
				}
2905 2906 2907 2908 2909 2910 2911 2912 2913
			}
		} 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;
			}
2914 2915 2916 2917
			if (change == REMOVE)
				output[type].fields &= ~all_output_options[i].field;
			else
				output[type].fields |= all_output_options[i].field;
2918 2919
			output[type].user_set = true;
			output[type].wildcard_set = true;
2920
		}
2921 2922
	}

2923 2924 2925 2926 2927 2928
	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));
		}
	}
2929
	goto out;
2930

2931 2932 2933
out_badmix:
	fprintf(stderr, "Cannot mix +-field with overridden fields\n");
	rc = -EINVAL;
2934
out:
2935 2936 2937 2938
	free(str);
	return rc;
}

2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951
#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)))
2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963


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

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

2964
static LIST_HEAD(script_descs);
2965 2966 2967 2968 2969

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

2970
	if (s != NULL && name)
2971 2972 2973 2974 2975 2976 2977
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
2978 2979 2980
	zfree(&s->name);
	zfree(&s->half_liner);
	zfree(&s->args);
2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007
	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)
3008
		return NULL;
3009 3010 3011 3012 3013 3014

	script_desc__add(s);

	return s;
}

3015
static const char *ends_with(const char *str, const char *suffix)
3016 3017
{
	size_t suffix_len = strlen(suffix);
3018
	const char *p = str;
3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038

	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)) {
3039
		p = skip_spaces(line);
3040 3041 3042 3043 3044 3045 3046 3047
		if (strlen(p) == 0)
			continue;
		if (*p != '#')
			continue;
		p++;
		if (strlen(p) && *p == '!')
			continue;

3048
		p = skip_spaces(p);
3049 3050 3051 3052 3053
		if (strlen(p) && p[strlen(p) - 1] == '\n')
			p[strlen(p) - 1] = '\0';

		if (!strncmp(p, "description:", strlen("description:"))) {
			p += strlen("description:");
3054
			desc->half_liner = strdup(skip_spaces(p));
3055 3056 3057 3058 3059
			continue;
		}

		if (!strncmp(p, "args:", strlen("args:"))) {
			p += strlen("args:");
3060
			desc->args = strdup(skip_spaces(p));
3061 3062 3063 3064 3065 3066 3067 3068 3069
			continue;
		}
	}

	fclose(fp);

	return 0;
}

3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087
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;
}

3088 3089 3090
static int list_available_scripts(const struct option *opt __maybe_unused,
				  const char *s __maybe_unused,
				  int unset __maybe_unused)
3091
{
3092
	struct dirent *script_dirent, *lang_dirent;
3093 3094 3095 3096 3097 3098 3099 3100
	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;

3101
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3102 3103

	scripts_dir = opendir(scripts_path);
3104 3105 3106 3107 3108 3109 3110
	if (!scripts_dir) {
		fprintf(stdout,
			"open(%s) failed.\n"
			"Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
			scripts_path);
		exit(-1);
	}
3111

3112
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3113 3114
		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			  lang_dirent->d_name);
3115 3116 3117 3118
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

3119 3120
		for_each_script(lang_path, lang_dir, script_dirent) {
			script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3121
			if (script_root) {
3122
				desc = script_desc__findnew(script_root);
3123 3124
				scnprintf(script_path, MAXPATHLEN, "%s/%s",
					  lang_path, script_dirent->d_name);
3125
				read_script_info(desc, script_path);
3126
				free(script_root);
3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141
			}
		}
	}

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

3142 3143 3144 3145 3146 3147 3148
/*
 * 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
3149
 * cover the future complex formats like event groups etc.
3150 3151 3152 3153 3154 3155
 */
static int check_ev_match(char *dir_name, char *scriptname,
			struct perf_session *session)
{
	char filename[MAXPATHLEN], evname[128];
	char line[BUFSIZ], *p;
3156
	struct evsel *pos;
3157 3158 3159
	int match, len;
	FILE *fp;

3160
	scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3161 3162 3163 3164 3165 3166

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

	while (fgets(line, sizeof(line), fp)) {
3167
		p = skip_spaces(line);
3168 3169 3170 3171 3172 3173 3174 3175 3176
		if (*p == '#')
			continue;

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

			p += 2;
3177
			p = skip_spaces(p);
3178 3179 3180 3181 3182 3183 3184
			len = strcspn(p, " \t");
			if (!len)
				break;

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

			match = 0;
3185
			evlist__for_each_entry(session->evlist, pos) {
3186
				if (!strcmp(evsel__name(pos), evname)) {
3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202
					match = 1;
					break;
				}
			}

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

	fclose(fp);
	return 0;
}

3203 3204 3205 3206 3207 3208 3209
/*
 * 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.
 */
3210 3211
int find_scripts(char **scripts_array, char **scripts_path_array, int num,
		 int pathlen)
3212
{
3213
	struct dirent *script_dirent, *lang_dirent;
3214
	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3215
	DIR *scripts_dir, *lang_dir;
3216
	struct perf_session *session;
3217
	struct perf_data data = {
J
Jiri Olsa 已提交
3218 3219
		.path = input_name,
		.mode = PERF_DATA_MODE_READ,
3220
	};
3221 3222 3223
	char *temp;
	int i = 0;

3224
	session = perf_session__new(&data, false, NULL);
3225 3226
	if (IS_ERR(session))
		return PTR_ERR(session);
3227

3228
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3229 3230

	scripts_dir = opendir(scripts_path);
3231 3232
	if (!scripts_dir) {
		perf_session__delete(session);
3233
		return -1;
3234
	}
3235

3236
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3237 3238
		scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
			  lang_dirent->d_name);
3239
#ifndef HAVE_LIBPERL_SUPPORT
3240 3241 3242
		if (strstr(lang_path, "perl"))
			continue;
#endif
3243
#ifndef HAVE_LIBPYTHON_SUPPORT
3244 3245 3246 3247 3248 3249 3250 3251
		if (strstr(lang_path, "python"))
			continue;
#endif

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

3252
		for_each_script(lang_path, lang_dir, script_dirent) {
3253
			/* Skip those real time scripts: xxxtop.p[yl] */
3254
			if (strstr(script_dirent->d_name, "top."))
3255
				continue;
3256 3257 3258 3259
			if (i >= num)
				break;
			snprintf(scripts_path_array[i], pathlen, "%s/%s",
				lang_path,
3260 3261
				script_dirent->d_name);
			temp = strchr(script_dirent->d_name, '.');
3262
			snprintf(scripts_array[i],
3263 3264
				(temp - script_dirent->d_name) + 1,
				"%s", script_dirent->d_name);
3265 3266 3267 3268 3269

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

3270 3271
			i++;
		}
3272
		closedir(lang_dir);
3273 3274
	}

3275 3276
	closedir(scripts_dir);
	perf_session__delete(session);
3277 3278 3279
	return i;
}

3280 3281
static char *get_script_path(const char *script_root, const char *suffix)
{
3282
	struct dirent *script_dirent, *lang_dirent;
3283 3284 3285 3286
	char scripts_path[MAXPATHLEN];
	char script_path[MAXPATHLEN];
	DIR *scripts_dir, *lang_dir;
	char lang_path[MAXPATHLEN];
3287
	char *__script_root;
3288

3289
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3290 3291 3292 3293 3294

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

3295
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3296 3297
		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			  lang_dirent->d_name);
3298 3299 3300 3301
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

3302 3303
		for_each_script(lang_path, lang_dir, script_dirent) {
			__script_root = get_script_root(script_dirent, suffix);
3304 3305
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
3306
				closedir(scripts_dir);
3307 3308
				scnprintf(script_path, MAXPATHLEN, "%s/%s",
					  lang_path, script_dirent->d_name);
3309
				closedir(lang_dir);
3310
				return strdup(script_path);
3311 3312 3313
			}
			free(__script_root);
		}
3314
		closedir(lang_dir);
3315
	}
3316
	closedir(scripts_dir);
3317

3318
	return NULL;
3319 3320
}

3321 3322
static bool is_top_script(const char *script_path)
{
Y
Yang Li 已提交
3323
	return ends_with(script_path, "top") != NULL;
3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348
}

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

3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361
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 已提交
3362

3363 3364 3365 3366 3367
	system_wide = (argc == 0);

	return 0;
}

3368 3369 3370
static void script__setup_sample_type(struct perf_script *script)
{
	struct perf_session *session = script->session;
3371
	u64 sample_type = evlist__combined_sample_type(session->evlist);
3372 3373 3374

	if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
		if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3375
		    (sample_type & PERF_SAMPLE_STACK_USER)) {
3376
			callchain_param.record_mode = CALLCHAIN_DWARF;
3377 3378
			dwarf_callchain_users = true;
		} else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3379 3380 3381 3382
			callchain_param.record_mode = CALLCHAIN_LBR;
		else
			callchain_param.record_mode = CALLCHAIN_FP;
	}
3383 3384 3385 3386 3387 3388

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

3391 3392
static int process_stat_round_event(struct perf_session *session,
				    union perf_event *event)
3393
{
3394
	struct perf_record_stat_round *round = &event->stat_round;
3395
	struct evsel *counter;
3396

3397
	evlist__for_each_entry(session->evlist, counter) {
3398 3399 3400 3401 3402 3403 3404 3405
		perf_stat_process_counter(&stat_config, counter);
		process_stat(counter, round->time);
	}

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

3406 3407
static int process_stat_config_event(struct perf_session *session __maybe_unused,
				     union perf_event *event)
3408 3409 3410 3411 3412
{
	perf_event__read_stat_config(&stat_config, &event->stat_config);
	return 0;
}

3413 3414
static int set_maps(struct perf_script *script)
{
3415
	struct evlist *evlist = script->session->evlist;
3416 3417 3418 3419 3420 3421 3422

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

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

3423
	perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3424

3425
	if (evlist__alloc_stats(evlist, true))
3426 3427 3428 3429 3430 3431 3432
		return -ENOMEM;

	script->allocated = true;
	return 0;
}

static
3433 3434
int process_thread_map_event(struct perf_session *session,
			     union perf_event *event)
3435
{
3436
	struct perf_tool *tool = session->tool;
3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451
	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
3452 3453
int process_cpu_map_event(struct perf_session *session,
			  union perf_event *event)
3454
{
3455
	struct perf_tool *tool = session->tool;
3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469
	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);
}

3470 3471
static int process_feature_event(struct perf_session *session,
				 union perf_event *event)
3472 3473
{
	if (event->feat.feat_id < HEADER_LAST_FEATURE)
3474
		return perf_event__process_feature(session, event);
3475 3476 3477
	return 0;
}

3478
#ifdef HAVE_AUXTRACE_SUPPORT
3479 3480
static int perf_script__process_auxtrace_info(struct perf_session *session,
					      union perf_event *event)
3481
{
3482 3483 3484
	struct perf_tool *tool = session->tool;

	int ret = perf_event__process_auxtrace_info(session, event);
3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497

	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

3498 3499 3500 3501 3502 3503
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);
3504
	symbol_conf.nanosecs = true;
3505 3506 3507 3508 3509 3510 3511
	return 0;
}

static int parse_xed(const struct option *opt __maybe_unused,
		     const char *str __maybe_unused,
		     int unset __maybe_unused)
{
3512 3513 3514 3515
	if (isatty(1))
		force_pager("xed -F insn: -A -64 | less");
	else
		force_pager("xed -F insn: -A -64");
3516 3517 3518
	return 0;
}

3519 3520 3521 3522 3523 3524
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);
3525
	symbol_conf.nanosecs = true;
3526
	symbol_conf.pad_output_len_dso = 50;
3527 3528 3529 3530 3531 3532 3533 3534 3535
	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);
3536
	symbol_conf.nanosecs = true;
3537 3538 3539
	return 0;
}

3540
int cmd_script(int argc, const char **argv)
3541 3542
{
	bool show_full_info = false;
3543 3544
	bool header = false;
	bool header_only = false;
3545
	bool script_started = false;
3546 3547 3548
	char *rec_script_path = NULL;
	char *rep_script_path = NULL;
	struct perf_session *session;
3549 3550 3551 3552
	struct itrace_synth_opts itrace_synth_opts = {
		.set = false,
		.default_no_sample = true,
	};
3553
	struct utsname uts;
3554 3555
	char *script_path = NULL;
	const char **__argv;
3556
	int i, j, err = 0;
3557 3558 3559 3560 3561 3562
	struct perf_script script = {
		.tool = {
			.sample		 = process_sample_event,
			.mmap		 = perf_event__process_mmap,
			.mmap2		 = perf_event__process_mmap2,
			.comm		 = perf_event__process_comm,
3563
			.namespaces	 = perf_event__process_namespaces,
3564
			.cgroup		 = perf_event__process_cgroup,
3565 3566
			.exit		 = perf_event__process_exit,
			.fork		 = perf_event__process_fork,
3567
			.attr		 = process_attr,
3568
			.event_update   = perf_event__process_event_update,
3569
			.tracing_data	 = perf_event__process_tracing_data,
3570
			.feature	 = process_feature_event,
3571
			.build_id	 = perf_event__process_build_id,
3572
			.id_index	 = perf_event__process_id_index,
3573
			.auxtrace_info	 = perf_script__process_auxtrace_info,
3574 3575
			.auxtrace	 = perf_event__process_auxtrace,
			.auxtrace_error	 = perf_event__process_auxtrace_error,
3576 3577
			.stat		 = perf_event__process_stat_event,
			.stat_round	 = process_stat_round_event,
3578
			.stat_config	 = process_stat_config_event,
3579 3580
			.thread_map	 = process_thread_map_event,
			.cpu_map	 = process_cpu_map_event,
3581
			.ordered_events	 = true,
3582 3583 3584
			.ordering_requires_timestamps = true,
		},
	};
3585
	struct perf_data data = {
3586 3587
		.mode = PERF_DATA_MODE_READ,
	};
3588
	const struct option options[] = {
F
Frederic Weisbecker 已提交
3589 3590
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
3591
	OPT_INCR('v', "verbose", &verbose,
3592
		 "be more verbose (show symbol address, etc)"),
3593
	OPT_BOOLEAN('L', "Latency", &latency_format,
3594
		    "show latency attributes (irqs/preemption disabled, etc)"),
3595 3596
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
T
Tom Zanussi 已提交
3597 3598 3599 3600
	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",
3601
		   "generate perf-script.xx script in specified language"),
3602
	OPT_STRING('i', "input", &input_name, "file", "input file name"),
3603 3604
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),
3605 3606
	OPT_BOOLEAN(0, "header", &header, "Show data header."),
	OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3607 3608 3609 3610 3611 3612
	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"),
3613 3614 3615
	OPT_CALLBACK(0, "symfs", NULL, "directory",
		     "Look for files with symbols relative to this directory",
		     symbol__config_symfs),
3616
	OPT_CALLBACK('F', "fields", NULL, "str",
3617
		     "comma separated output fields prepend with 'type:'. "
3618
		     "+field to add and -field to remove."
3619
		     "Valid types: hw,sw,trace,raw,synth. "
3620
		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3621 3622
		     "addr,symoff,srcline,period,iregs,uregs,brstack,"
		     "brstacksym,flags,bpf-output,brstackinsn,brstackoff,"
K
Kan Liang 已提交
3623
		     "callindent,insn,insnlen,synth,phys_addr,metric,misc,ipc,tod,"
3624
		     "data_page_size,code_page_size",
3625
		     parse_output_fields),
3626
	OPT_BOOLEAN('a', "all-cpus", &system_wide,
3627
		    "system-wide collection from all CPUs"),
3628 3629
	OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
		   "only consider symbols in these DSOs"),
3630 3631
	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
		   "only consider these symbols"),
3632 3633
	OPT_INTEGER(0, "addr-range", &symbol_conf.addr_range,
		    "Use with -S to list traced records within address range"),
3634 3635 3636 3637
	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),
3638 3639 3640 3641
	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),
3642 3643
	OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
			"Only print symbols and callees with --call-trace/--call-ret-trace"),
3644 3645
	OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
		   "Stop display of callgraph at these symbols"),
3646
	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3647 3648
	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only display events for these comms"),
3649 3650 3651 3652
	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"),
3653 3654 3655
	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. "
3656
		     "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
A
Andi Kleen 已提交
3657
	OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3658
	OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3659 3660
	OPT_BOOLEAN('I', "show-info", &show_full_info,
		    "display extended information from perf.data file"),
3661 3662
	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
		    "Show the path of [kernel.kallsyms]"),
3663 3664
	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
		    "Show the fork/comm/exit events"),
3665 3666
	OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
		    "Show the mmap events"),
3667 3668
	OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
		    "Show context switch events (if recorded)"),
3669 3670
	OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
		    "Show namespace events (if recorded)"),
3671 3672
	OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
		    "Show cgroup events (if recorded)"),
3673 3674
	OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
		    "Show lost events (if recorded)"),
3675 3676
	OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
		    "Show round events (if recorded)"),
3677 3678
	OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
		    "Show bpf related events (if recorded)"),
3679 3680
	OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
		    "Show text poke related events (if recorded)"),
3681 3682
	OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
		    "Dump trace output to files named by the monitored events"),
3683
	OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3684 3685
	OPT_INTEGER(0, "max-blocks", &max_blocks,
		    "Maximum number of code blocks to dump with brstackinsn"),
3686
	OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3687
		    "Use 9 decimal places when displaying time"),
3688
	OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3689
			    "Instruction Tracing options\n" ITRACE_HELP,
3690
			    itrace_parse_synth_opts),
3691 3692
	OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
			"Show full source file name path for source lines"),
3693 3694 3695 3696
	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
			"Enable symbol demangling"),
	OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
			"Enable kernel symbol demangling"),
3697 3698
	OPT_STRING(0, "time", &script.time_str, "str",
		   "Time span of interest (start,stop)"),
3699 3700
	OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
		    "Show inline function"),
3701 3702 3703 3704 3705 3706 3707 3708 3709
	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"),
3710 3711
	OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
		    "Enable LBR callgraph stitching approach"),
3712
	OPTS_EVSWITCH(&script.evswitch),
3713
	OPT_END()
3714
	};
3715 3716
	const char * const script_subcommands[] = { "record", "report", NULL };
	const char *script_usage[] = {
3717 3718 3719 3720 3721 3722 3723
		"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
	};
3724

3725 3726
	perf_set_singlethreaded();

3727 3728
	setup_scripting();

3729
	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3730 3731
			     PARSE_OPT_STOP_AT_NON_OPTION);

3732 3733 3734 3735 3736 3737 3738 3739 3740 3741
	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 已提交
3742 3743
	data.path  = input_name;
	data.force = symbol_conf.force;
3744

3745 3746 3747
	if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
		rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
		if (!rec_script_path)
3748
			return cmd_record(argc, argv);
3749 3750
	}

3751 3752 3753
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
3754
			fprintf(stderr,
3755
				"Please specify a valid report script"
3756
				"(see 'perf script -l' for listing)\n");
3757 3758 3759 3760
			return -1;
		}
	}

3761 3762 3763 3764 3765 3766 3767
	if (reltime && deltatime) {
		fprintf(stderr,
			"reltime and deltatime - the two don't get along well. "
			"Please limit to --reltime or --deltatime.\n");
		return -1;
	}

3768
	if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
3769 3770 3771
	    itrace_synth_opts.callchain_sz > scripting_max_stack)
		scripting_max_stack = itrace_synth_opts.callchain_sz;

3772
	/* make sure PERF_EXEC_PATH is set for scripts */
3773
	set_argv_exec_path(get_argv_exec_path());
3774

3775
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
3776
		int live_pipe[2];
3777
		int rep_args;
3778 3779
		pid_t pid;

3780 3781 3782 3783
		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) {
3784 3785 3786 3787 3788 3789
			script_name = find_script(argv[0]);
			if (script_name) {
				argc -= 1;
				argv += 1;
				goto script_found;
			}
3790 3791
			usage_with_options_msg(script_usage, options,
				"Couldn't find script `%s'\n\n See perf"
3792
				" script -l for available scripts.\n", argv[0]);
3793 3794
		}

3795 3796 3797 3798 3799 3800 3801 3802
		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) {
3803 3804
				usage_with_options_msg(script_usage, options,
					"`%s' script requires options."
3805
					"\n\n See perf script -l for available "
3806 3807
					"scripts and options.\n", argv[0]);
			}
3808 3809 3810 3811
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
3812
			return -1;
3813 3814 3815 3816 3817
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
3818
			return -1;
3819 3820 3821
		}

		if (!pid) {
3822 3823
			j = 0;

3824 3825 3826
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

3827 3828 3829
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
3830 3831 3832 3833
				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
					err = -1;
					goto out;
				}
3834
			}
3835 3836

			__argv = malloc((argc + 6) * sizeof(const char *));
3837 3838 3839 3840 3841
			if (!__argv) {
				pr_err("malloc failed\n");
				err = -ENOMEM;
				goto out;
			}
3842

3843 3844 3845 3846 3847 3848 3849 3850 3851 3852
			__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;
3853 3854

			execvp("/bin/sh", (char **)__argv);
3855
			free(__argv);
3856 3857 3858 3859 3860 3861
			exit(-1);
		}

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

3862
		__argv = malloc((argc + 4) * sizeof(const char *));
3863 3864 3865 3866 3867 3868
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

3869 3870 3871 3872 3873 3874 3875 3876
		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;
3877 3878

		execvp("/bin/sh", (char **)__argv);
3879
		free(__argv);
3880 3881
		exit(-1);
	}
3882
script_found:
3883 3884 3885 3886
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
3887

3888 3889
	if (script_path) {
		j = 0;
3890

3891 3892
		if (!rec_script_path)
			system_wide = false;
3893 3894 3895 3896 3897 3898
		else if (!system_wide) {
			if (have_cmd(argc - 1, &argv[1]) != 0) {
				err = -1;
				goto out;
			}
		}
3899

3900
		__argv = malloc((argc + 2) * sizeof(const char *));
3901 3902 3903 3904 3905 3906
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

3907 3908 3909 3910
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
3911
		for (i = 2; i < argc; i++)
3912 3913
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
3914 3915

		execvp("/bin/sh", (char **)__argv);
3916
		free(__argv);
3917 3918
		exit(-1);
	}
T
Tom Zanussi 已提交
3919

3920
	if (!script_name) {
3921
		setup_pager();
3922 3923
		use_browser = 0;
	}
F
Frederic Weisbecker 已提交
3924

3925
	session = perf_session__new(&data, false, &script.tool);
3926 3927
	if (IS_ERR(session))
		return PTR_ERR(session);
3928

3929
	if (header || header_only) {
3930
		script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3931 3932
		perf_session__fprintf_info(session, stdout, show_full_info);
		if (header_only)
3933
			goto out_delete;
3934
	}
3935 3936
	if (show_full_info)
		script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3937

3938
	if (symbol__init(&session->header.env) < 0)
3939 3940
		goto out_delete;

3941
	uname(&uts);
3942 3943
	if (data.is_pipe ||  /* assume pipe_mode indicates native_arch */
	    !strcmp(uts.machine, session->header.env.arch) ||
3944 3945 3946 3947
	    (!strcmp(uts.machine, "x86_64") &&
	     !strcmp(session->header.env.arch, "i386")))
		native_arch = true;

3948
	script.session = session;
3949
	script__setup_sample_type(&script);
3950

3951 3952
	if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
	    symbol_conf.graph_function)
3953 3954
		itrace_synth_opts.thread_stack = true;

3955 3956
	session->itrace_synth_opts = &itrace_synth_opts;

3957
	if (cpu_list) {
3958 3959 3960
		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
		if (err < 0)
			goto out_delete;
3961
		itrace_synth_opts.cpu_bitmap = cpu_bitmap;
3962 3963
	}

3964
	if (!no_callchain)
3965 3966 3967 3968
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

3969
	if (session->tevent.pevent &&
3970 3971 3972
	    tep_set_function_resolver(session->tevent.pevent,
				      machine__resolve_kernel_addr,
				      &session->machines.host) < 0) {
3973
		pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
3974 3975
		err = -1;
		goto out_delete;
3976 3977
	}

T
Tom Zanussi 已提交
3978 3979
	if (generate_script_lang) {
		struct stat perf_stat;
3980 3981
		int input;

3982
		if (output_set_by_user()) {
3983 3984
			fprintf(stderr,
				"custom fields not supported for generated scripts");
3985 3986
			err = -EINVAL;
			goto out_delete;
3987
		}
T
Tom Zanussi 已提交
3988

J
Jiri Olsa 已提交
3989
		input = open(data.path, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
3990
		if (input < 0) {
3991
			err = -errno;
T
Tom Zanussi 已提交
3992
			perror("failed to open file");
3993
			goto out_delete;
T
Tom Zanussi 已提交
3994 3995 3996 3997 3998
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
3999
			goto out_delete;
T
Tom Zanussi 已提交
4000 4001 4002 4003
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
4004
			goto out_delete;
T
Tom Zanussi 已提交
4005 4006 4007 4008 4009
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
4010 4011
			err = -ENOENT;
			goto out_delete;
T
Tom Zanussi 已提交
4012 4013
		}

J
Jiri Olsa 已提交
4014
		err = scripting_ops->generate_script(session->tevent.pevent,
4015
						     "perf-script");
4016
		goto out_delete;
T
Tom Zanussi 已提交
4017 4018 4019
	}

	if (script_name) {
4020
		err = scripting_ops->start_script(script_name, argc, argv, session);
T
Tom Zanussi 已提交
4021
		if (err)
4022
			goto out_delete;
4023
		pr_debug("perf script started with script %s\n\n", script_name);
4024
		script_started = true;
T
Tom Zanussi 已提交
4025 4026
	}

4027 4028 4029

	err = perf_session__check_output_opt(session);
	if (err < 0)
4030
		goto out_delete;
4031

4032
	if (script.time_str) {
4033
		err = perf_time__parse_for_ranges_reltime(script.time_str, session,
4034 4035
						  &script.ptime_range,
						  &script.range_size,
4036 4037
						  &script.range_num,
						  reltime);
4038
		if (err < 0)
4039
			goto out_delete;
4040 4041 4042 4043

		itrace_synth_opts__set_time_range(&itrace_synth_opts,
						  script.ptime_range,
						  script.range_num);
4044 4045
	}

4046 4047 4048
	err = evswitch__init(&script.evswitch, session->evlist, stderr);
	if (err)
		goto out_delete;
4049

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

4053
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
4054

4055 4056
	flush_scripting();

4057
out_delete:
4058 4059
	if (script.ptime_range) {
		itrace_synth_opts__clear_time_range(&itrace_synth_opts);
4060
		zfree(&script.ptime_range);
4061
	}
4062

4063
	evlist__free_stats(session->evlist);
4064
	perf_session__delete(session);
4065 4066 4067

	if (script_started)
		cleanup_scripting();
T
Tom Zanussi 已提交
4068 4069
out:
	return err;
F
Frederic Weisbecker 已提交
4070
}