builtin-script.c 104.6 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 *perf_evsel_script__new(struct evsel *evsel,
318
							struct perf_data *data)
319
{
320
	struct evsel_script *es = zalloc(sizeof(*es));
321 322

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

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

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

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

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

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

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

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

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

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

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

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

	return 0;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

532 533 534
	return 0;
}

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

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

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

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

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

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

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

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

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

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

		if (evsel == NULL)
			continue;

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

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

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

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

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

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

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

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

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

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

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

	return printed;
A
Andi Kleen 已提交
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 707
#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;
}

708 709 710 711 712 713 714 715 716 717 718 719 720 721
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);
}

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

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

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

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

	if (PRINT_FIELD(CPU)) {
		if (latency_format)
754
			printed += fprintf(fp, "%3d ", sample->cpu);
755
		else
756
			printed += fprintf(fp, "[%03d] ", sample->cpu);
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 787
	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:
788
			if (has(SWITCH_OUT)) {
789
				ret += fprintf(fp, "S");
790 791 792
				if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
					ret += fprintf(fp, "p");
			}
793 794 795 796 797 798 799 800 801 802
		default:
			break;
		}

		#undef has

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

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

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

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

	return printed;
836 837
}

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

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

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

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

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

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

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

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

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

	return printed;
893 894
}

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

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

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

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

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

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

	return printed;
939 940
}

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

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

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

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

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

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

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

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

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

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

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 1093
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 已提交
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
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;
}

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

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

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

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

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

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

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

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

	return printed;
1165 1166
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1412
	return len + dlen;
1413 1414
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
static struct {
	u32 flags;
	const char *name;
} sample_flags[] = {
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
	{PERF_IP_FLAG_BRANCH, "jmp"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC |	PERF_IP_FLAG_INTERRUPT, "hw int"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
	{0, NULL}
};

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

1555
static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1556 1557 1558
{
	const char *chars = PERF_IP_FLAG_CHARS;
	const int n = strlen(PERF_IP_FLAG_CHARS);
1559 1560
	bool in_tx = flags & PERF_IP_FLAG_IN_TX;
	const char *name = NULL;
1561 1562 1563
	char str[33];
	int i, pos = 0;

1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
	name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
	if (name)
		return fprintf(fp, "  %-15s%4s ", name, in_tx ? "(x)" : "");

	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)
			return fprintf(fp, "  tr strt %-7s%4s ", name, in_tx ? "(x)" : "");
	}

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

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

1590
	return fprintf(fp, "  %-19s ", str);
1591 1592
}

1593 1594 1595 1596 1597 1598
struct printer_data {
	int line_no;
	bool hit_nul;
	bool is_printable;
};

1599 1600 1601
static int sample__fprintf_bpf_output(enum binary_printer_ops op,
				      unsigned int val,
				      void *extra, FILE *fp)
1602 1603 1604
{
	unsigned char ch = (unsigned char)val;
	struct printer_data *printer_data = extra;
1605
	int printed = 0;
1606 1607 1608

	switch (op) {
	case BINARY_PRINT_DATA_BEGIN:
1609
		printed += fprintf(fp, "\n");
1610 1611
		break;
	case BINARY_PRINT_LINE_BEGIN:
1612
		printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1613 1614 1615
						        "           ");
		break;
	case BINARY_PRINT_ADDR:
1616
		printed += fprintf(fp, " %04x:", val);
1617 1618
		break;
	case BINARY_PRINT_NUM_DATA:
1619
		printed += fprintf(fp, " %02x", val);
1620 1621
		break;
	case BINARY_PRINT_NUM_PAD:
1622
		printed += fprintf(fp, "   ");
1623 1624
		break;
	case BINARY_PRINT_SEP:
1625
		printed += fprintf(fp, "  ");
1626 1627 1628 1629 1630 1631
		break;
	case BINARY_PRINT_CHAR_DATA:
		if (printer_data->hit_nul && ch)
			printer_data->is_printable = false;

		if (!isprint(ch)) {
1632
			printed += fprintf(fp, "%c", '.');
1633 1634 1635 1636 1637 1638 1639 1640 1641

			if (!printer_data->is_printable)
				break;

			if (ch == '\0')
				printer_data->hit_nul = true;
			else
				printer_data->is_printable = false;
		} else {
1642
			printed += fprintf(fp, "%c", ch);
1643 1644 1645
		}
		break;
	case BINARY_PRINT_CHAR_PAD:
1646
		printed += fprintf(fp, " ");
1647 1648
		break;
	case BINARY_PRINT_LINE_END:
1649
		printed += fprintf(fp, "\n");
1650 1651 1652 1653 1654 1655
		printer_data->line_no++;
		break;
	case BINARY_PRINT_DATA_END:
	default:
		break;
	}
1656 1657

	return printed;
1658 1659
}

1660
static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1661 1662 1663
{
	unsigned int nr_bytes = sample->raw_size;
	struct printer_data printer_data = {0, false, true};
1664 1665
	int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
				      sample__fprintf_bpf_output, &printer_data, fp);
1666 1667

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

	return printed;
1671 1672
}

1673
static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1674 1675
{
	if (len > 0 && len < spacing)
1676 1677 1678
		return fprintf(fp, "%*s", spacing - len, "");

	return 0;
1679 1680
}

1681
static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1682
{
1683
	return perf_sample__fprintf_spacing(len, 34, fp);
1684 1685
}

1686
static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1687 1688 1689 1690 1691
{
	struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
	int len;

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

1694
	len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1695
		     data->ip, le64_to_cpu(data->payload));
1696
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1697 1698
}

1699
static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1700 1701 1702 1703 1704
{
	struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
	int len;

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

1707 1708 1709
	len = fprintf(fp, " hints: %#x extensions: %#x ",
		      data->hints, data->extensions);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1710 1711
}

1712
static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1713 1714 1715 1716 1717
{
	struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
	int len;

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

1720 1721 1722
	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);
1723 1724
}

1725
static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1726 1727 1728 1729 1730
{
	struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
	int len;

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

1733 1734
	len = fprintf(fp, " IP: %u ", data->ip);
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1735 1736
}

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

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

1745
	len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1746 1747
		     data->deepest_cstate, data->last_cstate,
		     data->wake_reason);
1748
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1749 1750
}

1751
static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1752 1753 1754 1755 1756 1757
{
	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))
1758
		return 0;
1759 1760

	freq = (le32_to_cpu(data->freq) + 500) / 1000;
1761
	len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1762 1763
	if (data->max_nonturbo) {
		percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1764
		len += fprintf(fp, "(%3u%%) ", percent);
1765
	}
1766
	return len + perf_sample__fprintf_pt_spacing(len, fp);
1767 1768
}

A
Adrian Hunter 已提交
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780
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);
}

1781
static int perf_sample__fprintf_synth(struct perf_sample *sample,
1782
				      struct evsel *evsel, FILE *fp)
1783
{
1784
	switch (evsel->core.attr.config) {
1785
	case PERF_SYNTH_INTEL_PTWRITE:
1786
		return perf_sample__fprintf_synth_ptwrite(sample, fp);
1787
	case PERF_SYNTH_INTEL_MWAIT:
1788
		return perf_sample__fprintf_synth_mwait(sample, fp);
1789
	case PERF_SYNTH_INTEL_PWRE:
1790
		return perf_sample__fprintf_synth_pwre(sample, fp);
1791
	case PERF_SYNTH_INTEL_EXSTOP:
1792
		return perf_sample__fprintf_synth_exstop(sample, fp);
1793
	case PERF_SYNTH_INTEL_PWRX:
1794
		return perf_sample__fprintf_synth_pwrx(sample, fp);
1795
	case PERF_SYNTH_INTEL_CBR:
1796
		return perf_sample__fprintf_synth_cbr(sample, fp);
A
Adrian Hunter 已提交
1797 1798
	case PERF_SYNTH_INTEL_PSB:
		return perf_sample__fprintf_synth_psb(sample, fp);
1799 1800 1801
	default:
		break;
	}
1802 1803

	return 0;
1804 1805
}

1806
static int evlist__max_name_len(struct evlist *evlist)
1807
{
1808
	struct evsel *evsel;
1809 1810
	int max = 0;

1811
	evlist__for_each_entry(evlist, evsel) {
1812
		int len = strlen(evsel__name(evsel));
1813 1814 1815 1816 1817 1818 1819

		max = MAX(len, max);
	}

	return max;
}

1820
static int data_src__fprintf(u64 data_src, FILE *fp)
J
Jiri Olsa 已提交
1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833
{
	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;

1834
	return fprintf(fp, "%-*s", maxlen, out);
J
Jiri Olsa 已提交
1835 1836
}

1837 1838 1839
struct metric_ctx {
	struct perf_sample	*sample;
	struct thread		*thread;
1840
	struct evsel	*evsel;
1841 1842 1843
	FILE 			*fp;
};

1844 1845
static void script_print_metric(struct perf_stat_config *config __maybe_unused,
				void *ctx, const char *color,
1846 1847 1848 1849 1850 1851 1852
			        const char *fmt,
			        const char *unit, double val)
{
	struct metric_ctx *mctx = ctx;

	if (!fmt)
		return;
1853
	perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1854
				   PERF_RECORD_SAMPLE, mctx->fp);
1855 1856 1857 1858 1859 1860 1861 1862
	fputs("\tmetric: ", mctx->fp);
	if (color)
		color_fprintf(mctx->fp, color, fmt, val);
	else
		printf(fmt, val);
	fprintf(mctx->fp, " %s\n", unit);
}

1863 1864
static void script_new_line(struct perf_stat_config *config __maybe_unused,
			    void *ctx)
1865 1866 1867
{
	struct metric_ctx *mctx = ctx;

1868
	perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1869
				   PERF_RECORD_SAMPLE, mctx->fp);
1870 1871 1872 1873 1874
	fputs("\tmetric: ", mctx->fp);
}

static void perf_sample__fprint_metric(struct perf_script *script,
				       struct thread *thread,
1875
				       struct evsel *evsel,
1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889
				       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,
	};
1890
	struct evsel *ev2;
1891 1892 1893
	u64 val;

	if (!evsel->stats)
1894
		evlist__alloc_stats(script->session->evlist, false);
1895 1896 1897 1898 1899
	if (evsel_script(evsel->leader)->gnum++ == 0)
		perf_stat__reset_shadow_stats();
	val = sample->period * evsel->scale;
	perf_stat__update_shadow_stats(evsel,
				       val,
1900 1901
				       sample->cpu,
				       &rt_stat);
1902
	evsel_script(evsel)->val = val;
1903
	if (evsel_script(evsel->leader)->gnum == evsel->leader->core.nr_members) {
1904
		for_each_group_member (ev2, evsel->leader) {
1905
			perf_stat__print_shadow_stats(&stat_config, ev2,
1906 1907 1908
						      evsel_script(ev2)->val,
						      sample->cpu,
						      &ctx,
J
Jin Yao 已提交
1909 1910
						      NULL,
						      &rt_stat);
1911 1912 1913 1914 1915
		}
		evsel_script(evsel->leader)->gnum = 0;
	}
}

1916
static bool show_event(struct perf_sample *sample,
1917
		       struct evsel *evsel,
1918 1919 1920
		       struct thread *thread,
		       struct addr_location *al)
{
1921
	int depth = thread_stack__depth(thread, sample->cpu);
1922 1923 1924 1925 1926 1927 1928 1929 1930 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

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

1957
static void process_event(struct perf_script *script,
1958
			  struct perf_sample *sample, struct evsel *evsel,
1959 1960
			  struct addr_location *al,
			  struct machine *machine)
1961
{
1962
	struct thread *thread = al->thread;
1963
	struct perf_event_attr *attr = &evsel->core.attr;
1964
	unsigned int type = output_type(attr->type);
1965
	struct evsel_script *es = evsel->priv;
1966
	FILE *fp = es->fp;
K
Kan Liang 已提交
1967
	char str[PAGE_SIZE_NAME_LEN];
1968

1969
	if (output[type].fields == 0)
1970 1971
		return;

1972 1973 1974
	if (!show_event(sample, evsel, thread, al))
		return;

1975 1976
	if (evswitch__discard(&script->evswitch, evsel))
		return;
1977

1978 1979
	++es->samples;

1980
	perf_sample__fprintf_start(script, sample, thread, evsel,
1981
				   PERF_RECORD_SAMPLE, fp);
1982

J
Jiri Olsa 已提交
1983
	if (PRINT_FIELD(PERIOD))
1984
		fprintf(fp, "%10" PRIu64 " ", sample->period);
J
Jiri Olsa 已提交
1985

1986
	if (PRINT_FIELD(EVNAME)) {
1987
		const char *evname = evsel__name(evsel);
1988 1989

		if (!script->name_width)
1990
			script->name_width = evlist__max_name_len(script->session->evlist);
1991

1992
		fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
1993 1994
	}

1995
	if (print_flags)
1996
		perf_sample__fprintf_flags(sample->flags, fp);
1997

1998
	if (is_bts_event(attr)) {
1999
		perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
2000 2001 2002
		return;
	}

2003
	if (PRINT_FIELD(TRACE) && sample->raw_data) {
2004 2005 2006
		event_format__fprintf(evsel->tp_format, sample->cpu,
				      sample->raw_data, sample->raw_size, fp);
	}
2007 2008

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

2011
	if (PRINT_FIELD(ADDR))
2012
		perf_sample__fprintf_addr(sample, thread, attr, fp);
2013

2014
	if (PRINT_FIELD(DATA_SRC))
2015
		data_src__fprintf(sample->data_src, fp);
2016 2017

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

2020
	if (PRINT_FIELD(IP)) {
2021
		struct callchain_cursor *cursor = NULL;
2022

2023 2024 2025
		if (script->stitch_lbr)
			al->thread->lbr_stitch_enable = true;

2026
		if (symbol_conf.use_callchain && sample->callchain &&
2027
		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
2028
					      sample, NULL, NULL, scripting_max_stack) == 0)
2029
			cursor = &callchain_cursor;
2030

2031
		fputc(cursor ? '\n' : ' ', fp);
2032 2033
		sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
				    symbol_conf.bt_stop_list, fp);
2034 2035
	}

2036
	if (PRINT_FIELD(IREGS))
2037
		perf_sample__fprintf_iregs(sample, attr, fp);
2038

A
Andi Kleen 已提交
2039
	if (PRINT_FIELD(UREGS))
2040
		perf_sample__fprintf_uregs(sample, attr, fp);
A
Andi Kleen 已提交
2041

2042
	if (PRINT_FIELD(BRSTACK))
2043
		perf_sample__fprintf_brstack(sample, thread, attr, fp);
2044
	else if (PRINT_FIELD(BRSTACKSYM))
2045
		perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2046
	else if (PRINT_FIELD(BRSTACKOFF))
2047
		perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2048

2049
	if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2050 2051
		perf_sample__fprintf_bpf_output(sample, fp);
	perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2052 2053

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

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

2059 2060 2061
	if (PRINT_FIELD(CODE_PAGE_SIZE))
		fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));

2062 2063
	perf_sample__fprintf_ipc(sample, attr, fp);

2064
	fprintf(fp, "\n");
2065

A
Andi Kleen 已提交
2066 2067 2068 2069 2070 2071
	if (PRINT_FIELD(SRCCODE)) {
		if (map__fprintf_srccode(al->map, al->addr, stdout,
					 &thread->srccode_state))
			printf("\n");
	}

2072 2073
	if (PRINT_FIELD(METRIC))
		perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2074 2075 2076

	if (verbose)
		fflush(fp);
2077 2078
}

T
Tom Zanussi 已提交
2079 2080
static struct scripting_ops	*scripting_ops;

2081
static void __process_stat(struct evsel *counter, u64 tstamp)
2082
{
2083
	int nthreads = perf_thread_map__nr(counter->core.threads);
2084
	int ncpus = evsel__nr_cpus(counter);
2085 2086 2087
	int cpu, thread;
	static int header_printed;

2088
	if (counter->core.system_wide)
2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103
		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",
2104
				counter->core.cpus->map[cpu],
2105
				perf_thread_map__pid(counter->core.threads, thread),
2106 2107 2108 2109
				counts->val,
				counts->ena,
				counts->run,
				tstamp,
2110
				evsel__name(counter));
2111 2112 2113 2114
		}
	}
}

2115
static void process_stat(struct evsel *counter, u64 tstamp)
2116 2117 2118
{
	if (scripting_ops && scripting_ops->process_stat)
		scripting_ops->process_stat(&stat_config, counter, tstamp);
2119 2120
	else
		__process_stat(counter, tstamp);
2121 2122 2123 2124 2125 2126 2127 2128
}

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

T
Tom Zanussi 已提交
2129 2130
static void setup_scripting(void)
{
2131
	setup_perl_scripting();
2132
	setup_python_scripting();
T
Tom Zanussi 已提交
2133 2134
}

2135 2136
static int flush_scripting(void)
{
2137
	return scripting_ops ? scripting_ops->flush_script() : 0;
2138 2139
}

T
Tom Zanussi 已提交
2140 2141
static int cleanup_scripting(void)
{
2142
	pr_debug("\nperf script stopped\n");
2143

2144
	return scripting_ops ? scripting_ops->stop_script() : 0;
T
Tom Zanussi 已提交
2145 2146
}

2147 2148
static bool filter_cpu(struct perf_sample *sample)
{
2149
	if (cpu_list && sample->cpu != (u32)-1)
2150 2151 2152 2153
		return !test_bit(sample->cpu, cpu_bitmap);
	return false;
}

2154
static int process_sample_event(struct perf_tool *tool,
2155
				union perf_event *event,
2156
				struct perf_sample *sample,
2157
				struct evsel *evsel,
2158
				struct machine *machine)
F
Frederic Weisbecker 已提交
2159
{
2160
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
2161
	struct addr_location al;
F
Frederic Weisbecker 已提交
2162

2163 2164
	if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
					  sample->time)) {
2165
		return 0;
2166
	}
2167

2168 2169 2170 2171 2172 2173
	if (debug_mode) {
		if (sample->time < last_timestamp) {
			pr_err("Samples misordered, previous: %" PRIu64
				" this: %" PRIu64 "\n", last_timestamp,
				sample->time);
			nr_unordered++;
2174
		}
2175 2176
		last_timestamp = sample->time;
		return 0;
F
Frederic Weisbecker 已提交
2177
	}
2178

2179
	if (machine__resolve(machine, &al, sample) < 0) {
2180 2181 2182 2183 2184 2185
		pr_err("problem processing %d event, skipping it.\n",
		       event->header.type);
		return -1;
	}

	if (al.filtered)
2186
		goto out_put;
2187

2188
	if (filter_cpu(sample))
2189
		goto out_put;
2190

2191 2192 2193
	if (scripting_ops)
		scripting_ops->process_event(event, sample, evsel, &al);
	else
2194
		process_event(scr, sample, evsel, &al, machine);
2195

2196 2197
out_put:
	addr_location__put(&al);
F
Frederic Weisbecker 已提交
2198 2199 2200
	return 0;
}

2201
static int process_attr(struct perf_tool *tool, union perf_event *event,
2202
			struct evlist **pevlist)
2203 2204
{
	struct perf_script *scr = container_of(tool, struct perf_script, tool);
2205
	struct evlist *evlist;
2206
	struct evsel *evsel, *pos;
2207
	u64 sample_type;
2208
	int err;
2209
	static struct evsel_script *es;
2210 2211 2212 2213 2214 2215

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

	evlist = *pevlist;
2216
	evsel = evlist__last(*pevlist);
2217

2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230
	if (!evsel->priv) {
		if (scr->per_event_dump) {
			evsel->priv = perf_evsel_script__new(evsel,
						scr->session->data);
		} else {
			es = zalloc(sizeof(*es));
			if (!es)
				return -ENOMEM;
			es->fp = stdout;
			evsel->priv = es;
		}
	}

2231 2232
	if (evsel->core.attr.type >= PERF_TYPE_MAX &&
	    evsel->core.attr.type != PERF_TYPE_SYNTH)
2233 2234
		return 0;

2235
	evlist__for_each_entry(evlist, pos) {
2236
		if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2237 2238 2239
			return 0;
	}

2240
	if (evsel->core.attr.sample_type) {
2241
		err = evsel__check_attr(evsel, scr->session);
2242 2243 2244
		if (err)
			return err;
	}
2245

2246 2247 2248 2249
	/*
	 * Check if we need to enable callchains based
	 * on events sample_type.
	 */
2250
	sample_type = evlist__combined_sample_type(evlist);
2251
	callchain_param_setup(sample_type);
2252

2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264
	/* 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;
2265 2266
	}
	set_print_ip_opts(&evsel->core.attr);
2267
	return 0;
2268 2269
}

2270 2271 2272 2273 2274
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)
2275 2276 2277
{
	struct perf_script *script = container_of(tool, struct perf_script, tool);
	struct perf_session *session = script->session;
2278
	struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2279
	struct thread *thread = NULL;
2280

2281 2282 2283 2284 2285
	if (evsel && !evsel->core.attr.sample_id_all) {
		sample->cpu = 0;
		sample->time = timestamp;
		sample->pid = pid;
		sample->tid = tid;
2286 2287
	}

2288 2289
	if (filter_cpu(sample))
		return 0;
2290

2291 2292 2293
	if (tid != -1)
		thread = machine__findnew_thread(machine, pid, tid);

2294
	if (evsel) {
2295
		perf_sample__fprintf_start(script, sample, thread, evsel,
2296
					   event->header.type, stdout);
2297
	}
2298

2299
	perf_event__fprintf(event, machine, stdout);
2300

2301
	thread__put(thread);
2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322

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

2325 2326 2327 2328 2329 2330
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)
2331
		return -1;
2332

2333 2334
	return print_event(tool, event, sample, machine, event->namespaces.pid,
			   event->namespaces.tid);
2335 2336
}

2337 2338 2339 2340 2341 2342
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)
2343
		return -1;
2344

2345 2346
	return print_event(tool, event, sample, machine, sample->pid,
			    sample->tid);
2347 2348
}

2349 2350 2351 2352 2353 2354 2355 2356
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;

2357 2358 2359
	return print_event_with_time(tool, event, sample, machine,
				     event->fork.pid, event->fork.tid,
				     event->fork.time);
2360 2361 2362 2363 2364 2365
}
static int process_exit_event(struct perf_tool *tool,
			      union perf_event *event,
			      struct perf_sample *sample,
			      struct machine *machine)
{
2366 2367 2368
	/* Print before 'exit' deletes anything */
	if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
				  event->fork.tid, event->fork.time))
2369 2370
		return -1;

2371
	return perf_event__process_exit(tool, event, sample, machine);
2372 2373
}

2374 2375 2376 2377 2378 2379 2380 2381
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;

2382 2383
	return print_event(tool, event, sample, machine, event->mmap.pid,
			   event->mmap.tid);
2384 2385 2386 2387 2388 2389 2390 2391 2392 2393
}

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;

2394 2395
	return print_event(tool, event, sample, machine, event->mmap2.pid,
			   event->mmap2.tid);
2396 2397
}

2398 2399 2400 2401 2402 2403 2404 2405 2406 2407
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;

2408 2409 2410 2411 2412 2413
	if (scripting_ops && scripting_ops->process_switch)
		scripting_ops->process_switch(event, sample, machine);

	if (!script->show_switch_events)
		return 0;

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

2418 2419 2420 2421 2422 2423
static int
process_lost_event(struct perf_tool *tool,
		   union perf_event *event,
		   struct perf_sample *sample,
		   struct machine *machine)
{
2424 2425
	return print_event(tool, event, sample, machine, sample->pid,
			   sample->tid);
2426 2427
}

2428 2429 2430 2431 2432 2433
static int
process_finished_round_event(struct perf_tool *tool __maybe_unused,
			     union perf_event *event,
			     struct ordered_events *oe __maybe_unused)

{
2434
	perf_event__fprintf(event, NULL, stdout);
2435 2436 2437
	return 0;
}

2438 2439 2440 2441 2442 2443 2444 2445 2446
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;

2447 2448
	return print_event(tool, event, sample, machine, sample->pid,
			   sample->tid);
2449 2450
}

2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462
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);
}

2463
static void sig_handler(int sig __maybe_unused)
2464 2465 2466 2467
{
	session_done = 1;
}

2468 2469
static void perf_script__fclose_per_event_dump(struct perf_script *script)
{
2470
	struct evlist *evlist = script->session->evlist;
2471
	struct evsel *evsel;
2472 2473 2474 2475

	evlist__for_each_entry(evlist, evsel) {
		if (!evsel->priv)
			break;
2476
		perf_evsel_script__delete(evsel->priv);
2477 2478 2479 2480 2481 2482
		evsel->priv = NULL;
	}
}

static int perf_script__fopen_per_event_dump(struct perf_script *script)
{
2483
	struct evsel *evsel;
2484 2485

	evlist__for_each_entry(script->session->evlist, evsel) {
2486 2487 2488 2489 2490 2491 2492 2493 2494 2495
		/*
		 * Already setup? I.e. we may be called twice in cases like
		 * Intel PT, one for the intel_pt// and dummy events, then
		 * for the evsels syntheized from the auxtrace info.
		 *
		 * Ses perf_script__process_auxtrace_info.
		 */
		if (evsel->priv != NULL)
			continue;

2496
		evsel->priv = perf_evsel_script__new(evsel, script->session->data);
2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509
		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)
{
2510 2511
	struct evsel *evsel;
	static struct evsel_script es_stdout;
2512 2513 2514 2515

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

2516 2517
	es_stdout.fp = stdout;

2518
	evlist__for_each_entry(script->session->evlist, evsel)
2519
		evsel->priv = &es_stdout;
2520 2521 2522 2523

	return 0;
}

2524 2525
static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
{
2526
	struct evsel *evsel;
2527 2528

	evlist__for_each_entry(script->session->evlist, evsel) {
2529
		struct evsel_script *es = evsel->priv;
2530 2531 2532 2533 2534 2535 2536

		perf_evsel_script__fprintf(es, stdout);
		perf_evsel_script__delete(es);
		evsel->priv = NULL;
	}
}

2537
static int __cmd_script(struct perf_script *script)
F
Frederic Weisbecker 已提交
2538
{
2539 2540
	int ret;

2541 2542
	signal(SIGINT, sig_handler);

2543 2544
	perf_stat__init_shadow_stats();

2545 2546 2547 2548 2549 2550
	/* 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;
	}
2551 2552 2553 2554
	if (script->show_mmap_events) {
		script->tool.mmap = process_mmap_event;
		script->tool.mmap2 = process_mmap2_event;
	}
2555
	if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2556
		script->tool.context_switch = process_switch_event;
2557 2558
	if (script->show_namespace_events)
		script->tool.namespaces = process_namespaces_event;
2559 2560
	if (script->show_cgroup_events)
		script->tool.cgroup = process_cgroup_event;
2561 2562
	if (script->show_lost_events)
		script->tool.lost = process_lost_event;
2563 2564 2565 2566
	if (script->show_round_events) {
		script->tool.ordered_events = false;
		script->tool.finished_round = process_finished_round_event;
	}
2567
	if (script->show_bpf_events) {
2568 2569
		script->tool.ksymbol = process_bpf_events;
		script->tool.bpf     = process_bpf_events;
2570
	}
2571 2572 2573 2574
	if (script->show_text_poke_events) {
		script->tool.ksymbol   = process_bpf_events;
		script->tool.text_poke = process_text_poke_events;
	}
2575

2576 2577 2578 2579 2580
	if (perf_script__setup_per_event_dump(script)) {
		pr_err("Couldn't create the per event dump files\n");
		return -1;
	}

2581
	ret = perf_session__process_events(script->session);
2582

2583
	if (script->per_event_dump)
2584
		perf_script__exit_per_event_dump_stats(script);
2585

2586
	if (debug_mode)
2587
		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2588 2589

	return ret;
F
Frederic Weisbecker 已提交
2590 2591
}

T
Tom Zanussi 已提交
2592 2593 2594
struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
2595
	char			spec[];
T
Tom Zanussi 已提交
2596 2597
};

2598
static LIST_HEAD(script_specs);
T
Tom Zanussi 已提交
2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635

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;

2636
	s = script_spec__new(spec, ops);
T
Tom Zanussi 已提交
2637 2638
	if (!s)
		return -1;
2639 2640
	else
		script_spec__add(s);
T
Tom Zanussi 已提交
2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659

	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 "
2660
		"perf script -s [spec:]script.[spec]):\n\n");
T
Tom Zanussi 已提交
2661 2662 2663 2664 2665 2666 2667

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

	fprintf(stderr, "\n");
}

2668 2669
static int parse_scriptname(const struct option *opt __maybe_unused,
			    const char *str, int unset __maybe_unused)
T
Tom Zanussi 已提交
2670 2671 2672 2673 2674
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

2675
	if (strcmp(str, "lang") == 0) {
T
Tom Zanussi 已提交
2676
		list_available_languages();
2677
		exit(0);
T
Tom Zanussi 已提交
2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696
	}

	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;
2697
		ext = strrchr(script, '.');
T
Tom Zanussi 已提交
2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713
		if (!ext) {
			fprintf(stderr, "invalid script extension");
			return -1;
		}
		scripting_ops = script_spec__lookup(++ext);
		if (!scripting_ops) {
			fprintf(stderr, "invalid script extension");
			return -1;
		}
	}

	script_name = strdup(script);

	return 0;
}

2714 2715
static int parse_output_fields(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused)
2716
{
2717
	char *tok, *strtok_saveptr = NULL;
2718
	int i, imax = ARRAY_SIZE(all_output_options);
2719
	int j;
2720 2721
	int rc = 0;
	char *str = strdup(arg);
2722
	int type = -1;
2723
	enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2724 2725 2726 2727

	if (!str)
		return -ENOMEM;

2728 2729 2730
	/* 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.
2731
	 */
2732 2733 2734 2735 2736 2737 2738 2739 2740 2741
	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;
2742 2743
		else if (!strcmp(str, "raw"))
			type = PERF_TYPE_RAW;
2744 2745
		else if (!strcmp(str, "break"))
			type = PERF_TYPE_BREAKPOINT;
2746 2747
		else if (!strcmp(str, "synth"))
			type = OUTPUT_TYPE_SYNTH;
2748 2749
		else {
			fprintf(stderr, "Invalid event type in field string.\n");
2750 2751
			rc = -EINVAL;
			goto out;
2752 2753 2754 2755 2756 2757
		}

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

2758 2759 2760 2761
		/* Don't override defaults for +- */
		if (strchr(tok, '+') || strchr(tok, '-'))
			goto parse;

2762 2763
		output[type].fields = 0;
		output[type].user_set = true;
2764
		output[type].wildcard_set = false;
2765 2766 2767 2768 2769 2770 2771 2772 2773 2774

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

2775 2776 2777 2778
		/* Don't override defaults for +- */
		if (strchr(str, '+') || strchr(str, '-'))
			goto parse;

2779 2780 2781
		if (output_set_by_user())
			pr_warning("Overriding previous field request for all events.\n");

2782
		for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2783 2784
			output[j].fields = 0;
			output[j].user_set = true;
2785
			output[j].wildcard_set = true;
2786
		}
2787 2788
	}

2789
parse:
2790
	for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806
		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;
		}

2807
		for (i = 0; i < imax; ++i) {
2808
			if (strcmp(tok, all_output_options[i].str) == 0)
2809 2810
				break;
		}
2811
		if (i == imax && strcmp(tok, "flags") == 0) {
Y
Yang Li 已提交
2812
			print_flags = change != REMOVE;
2813 2814
			continue;
		}
2815
		if (i == imax) {
2816
			fprintf(stderr, "Invalid field requested.\n");
2817
			rc = -EINVAL;
2818
			goto out;
2819 2820
		}

2821 2822 2823 2824
		if (type == -1) {
			/* add user option to all events types for
			 * which it is valid
			 */
2825
			for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2826 2827 2828
				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));
2829
				} else {
2830
					if (change == REMOVE) {
2831
						output[j].fields &= ~all_output_options[i].field;
2832
						output[j].user_set_fields &= ~all_output_options[i].field;
2833
						output[j].user_unset_fields |= all_output_options[i].field;
2834
					} else {
2835
						output[j].fields |= all_output_options[i].field;
2836
						output[j].user_set_fields |= all_output_options[i].field;
2837
						output[j].user_unset_fields &= ~all_output_options[i].field;
2838
					}
2839 2840
					output[j].user_set = true;
					output[j].wildcard_set = true;
2841
				}
2842 2843 2844 2845 2846 2847 2848 2849 2850
			}
		} 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;
			}
2851 2852 2853 2854
			if (change == REMOVE)
				output[type].fields &= ~all_output_options[i].field;
			else
				output[type].fields |= all_output_options[i].field;
2855 2856
			output[type].user_set = true;
			output[type].wildcard_set = true;
2857
		}
2858 2859
	}

2860 2861 2862 2863 2864 2865
	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));
		}
	}
2866
	goto out;
2867

2868 2869 2870
out_badmix:
	fprintf(stderr, "Cannot mix +-field with overridden fields\n");
	rc = -EINVAL;
2871
out:
2872 2873 2874 2875
	free(str);
	return rc;
}

2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888
#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)))
2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900


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

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

2901
static LIST_HEAD(script_descs);
2902 2903 2904 2905 2906

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

2907
	if (s != NULL && name)
2908 2909 2910 2911 2912 2913 2914
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
2915 2916 2917
	zfree(&s->name);
	zfree(&s->half_liner);
	zfree(&s->args);
2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944
	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)
2945
		return NULL;
2946 2947 2948 2949 2950 2951

	script_desc__add(s);

	return s;
}

2952
static const char *ends_with(const char *str, const char *suffix)
2953 2954
{
	size_t suffix_len = strlen(suffix);
2955
	const char *p = str;
2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975

	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)) {
2976
		p = skip_spaces(line);
2977 2978 2979 2980 2981 2982 2983 2984
		if (strlen(p) == 0)
			continue;
		if (*p != '#')
			continue;
		p++;
		if (strlen(p) && *p == '!')
			continue;

2985
		p = skip_spaces(p);
2986 2987 2988 2989 2990
		if (strlen(p) && p[strlen(p) - 1] == '\n')
			p[strlen(p) - 1] = '\0';

		if (!strncmp(p, "description:", strlen("description:"))) {
			p += strlen("description:");
2991
			desc->half_liner = strdup(skip_spaces(p));
2992 2993 2994 2995 2996
			continue;
		}

		if (!strncmp(p, "args:", strlen("args:"))) {
			p += strlen("args:");
2997
			desc->args = strdup(skip_spaces(p));
2998 2999 3000 3001 3002 3003 3004 3005 3006
			continue;
		}
	}

	fclose(fp);

	return 0;
}

3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024
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;
}

3025 3026 3027
static int list_available_scripts(const struct option *opt __maybe_unused,
				  const char *s __maybe_unused,
				  int unset __maybe_unused)
3028
{
3029
	struct dirent *script_dirent, *lang_dirent;
3030 3031 3032 3033 3034 3035 3036 3037
	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;

3038
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3039 3040

	scripts_dir = opendir(scripts_path);
3041 3042 3043 3044 3045 3046 3047
	if (!scripts_dir) {
		fprintf(stdout,
			"open(%s) failed.\n"
			"Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
			scripts_path);
		exit(-1);
	}
3048

3049
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3050 3051
		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			  lang_dirent->d_name);
3052 3053 3054 3055
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

3056 3057
		for_each_script(lang_path, lang_dir, script_dirent) {
			script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3058
			if (script_root) {
3059
				desc = script_desc__findnew(script_root);
3060 3061
				scnprintf(script_path, MAXPATHLEN, "%s/%s",
					  lang_path, script_dirent->d_name);
3062
				read_script_info(desc, script_path);
3063
				free(script_root);
3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078
			}
		}
	}

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

3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092
/*
 * Some scripts specify the required events in their "xxx-record" file,
 * this function will check if the events in perf.data match those
 * mentioned in the "xxx-record".
 *
 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
 * which is covered well now. And new parsing code should be added to
 * cover the future complexing formats like event groups etc.
 */
static int check_ev_match(char *dir_name, char *scriptname,
			struct perf_session *session)
{
	char filename[MAXPATHLEN], evname[128];
	char line[BUFSIZ], *p;
3093
	struct evsel *pos;
3094 3095 3096
	int match, len;
	FILE *fp;

3097
	scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3098 3099 3100 3101 3102 3103

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

	while (fgets(line, sizeof(line), fp)) {
3104
		p = skip_spaces(line);
3105 3106 3107 3108 3109 3110 3111 3112 3113
		if (*p == '#')
			continue;

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

			p += 2;
3114
			p = skip_spaces(p);
3115 3116 3117 3118 3119 3120 3121
			len = strcspn(p, " \t");
			if (!len)
				break;

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

			match = 0;
3122
			evlist__for_each_entry(session->evlist, pos) {
3123
				if (!strcmp(evsel__name(pos), evname)) {
3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139
					match = 1;
					break;
				}
			}

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

	fclose(fp);
	return 0;
}

3140 3141 3142 3143 3144 3145 3146
/*
 * 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.
 */
3147 3148
int find_scripts(char **scripts_array, char **scripts_path_array, int num,
		 int pathlen)
3149
{
3150
	struct dirent *script_dirent, *lang_dirent;
3151
	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3152
	DIR *scripts_dir, *lang_dir;
3153
	struct perf_session *session;
3154
	struct perf_data data = {
J
Jiri Olsa 已提交
3155 3156
		.path = input_name,
		.mode = PERF_DATA_MODE_READ,
3157
	};
3158 3159 3160
	char *temp;
	int i = 0;

3161
	session = perf_session__new(&data, false, NULL);
3162 3163
	if (IS_ERR(session))
		return PTR_ERR(session);
3164

3165
	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3166 3167

	scripts_dir = opendir(scripts_path);
3168 3169
	if (!scripts_dir) {
		perf_session__delete(session);
3170
		return -1;
3171
	}
3172

3173
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3174 3175
		scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
			  lang_dirent->d_name);
3176
#ifndef HAVE_LIBPERL_SUPPORT
3177 3178 3179
		if (strstr(lang_path, "perl"))
			continue;
#endif
3180
#ifndef HAVE_LIBPYTHON_SUPPORT
3181 3182 3183 3184 3185 3186 3187 3188
		if (strstr(lang_path, "python"))
			continue;
#endif

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

3189
		for_each_script(lang_path, lang_dir, script_dirent) {
3190
			/* Skip those real time scripts: xxxtop.p[yl] */
3191
			if (strstr(script_dirent->d_name, "top."))
3192
				continue;
3193 3194 3195 3196
			if (i >= num)
				break;
			snprintf(scripts_path_array[i], pathlen, "%s/%s",
				lang_path,
3197 3198
				script_dirent->d_name);
			temp = strchr(script_dirent->d_name, '.');
3199
			snprintf(scripts_array[i],
3200 3201
				(temp - script_dirent->d_name) + 1,
				"%s", script_dirent->d_name);
3202 3203 3204 3205 3206

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

3207 3208
			i++;
		}
3209
		closedir(lang_dir);
3210 3211
	}

3212 3213
	closedir(scripts_dir);
	perf_session__delete(session);
3214 3215 3216
	return i;
}

3217 3218
static char *get_script_path(const char *script_root, const char *suffix)
{
3219
	struct dirent *script_dirent, *lang_dirent;
3220 3221 3222 3223
	char scripts_path[MAXPATHLEN];
	char script_path[MAXPATHLEN];
	DIR *scripts_dir, *lang_dir;
	char lang_path[MAXPATHLEN];
3224
	char *__script_root;
3225

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

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

3232
	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3233 3234
		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			  lang_dirent->d_name);
3235 3236 3237 3238
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

3239 3240
		for_each_script(lang_path, lang_dir, script_dirent) {
			__script_root = get_script_root(script_dirent, suffix);
3241 3242
			if (__script_root && !strcmp(script_root, __script_root)) {
				free(__script_root);
3243
				closedir(scripts_dir);
3244 3245
				scnprintf(script_path, MAXPATHLEN, "%s/%s",
					  lang_path, script_dirent->d_name);
3246
				closedir(lang_dir);
3247
				return strdup(script_path);
3248 3249 3250
			}
			free(__script_root);
		}
3251
		closedir(lang_dir);
3252
	}
3253
	closedir(scripts_dir);
3254

3255
	return NULL;
3256 3257
}

3258 3259
static bool is_top_script(const char *script_path)
{
Y
Yang Li 已提交
3260
	return ends_with(script_path, "top") != NULL;
3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285
}

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

3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298
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 已提交
3299

3300 3301 3302 3303 3304
	system_wide = (argc == 0);

	return 0;
}

3305 3306 3307
static void script__setup_sample_type(struct perf_script *script)
{
	struct perf_session *session = script->session;
3308
	u64 sample_type = evlist__combined_sample_type(session->evlist);
3309 3310 3311

	if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
		if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3312
		    (sample_type & PERF_SAMPLE_STACK_USER)) {
3313
			callchain_param.record_mode = CALLCHAIN_DWARF;
3314 3315
			dwarf_callchain_users = true;
		} else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3316 3317 3318 3319
			callchain_param.record_mode = CALLCHAIN_LBR;
		else
			callchain_param.record_mode = CALLCHAIN_FP;
	}
3320 3321 3322 3323 3324 3325

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

3328 3329
static int process_stat_round_event(struct perf_session *session,
				    union perf_event *event)
3330
{
3331
	struct perf_record_stat_round *round = &event->stat_round;
3332
	struct evsel *counter;
3333

3334
	evlist__for_each_entry(session->evlist, counter) {
3335 3336 3337 3338 3339 3340 3341 3342
		perf_stat_process_counter(&stat_config, counter);
		process_stat(counter, round->time);
	}

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

3343 3344
static int process_stat_config_event(struct perf_session *session __maybe_unused,
				     union perf_event *event)
3345 3346 3347 3348 3349
{
	perf_event__read_stat_config(&stat_config, &event->stat_config);
	return 0;
}

3350 3351
static int set_maps(struct perf_script *script)
{
3352
	struct evlist *evlist = script->session->evlist;
3353 3354 3355 3356 3357 3358 3359

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

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

3360
	perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3361

3362
	if (evlist__alloc_stats(evlist, true))
3363 3364 3365 3366 3367 3368 3369
		return -ENOMEM;

	script->allocated = true;
	return 0;
}

static
3370 3371
int process_thread_map_event(struct perf_session *session,
			     union perf_event *event)
3372
{
3373
	struct perf_tool *tool = session->tool;
3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388
	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
3389 3390
int process_cpu_map_event(struct perf_session *session,
			  union perf_event *event)
3391
{
3392
	struct perf_tool *tool = session->tool;
3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406
	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);
}

3407 3408
static int process_feature_event(struct perf_session *session,
				 union perf_event *event)
3409 3410
{
	if (event->feat.feat_id < HEADER_LAST_FEATURE)
3411
		return perf_event__process_feature(session, event);
3412 3413 3414
	return 0;
}

3415
#ifdef HAVE_AUXTRACE_SUPPORT
3416 3417
static int perf_script__process_auxtrace_info(struct perf_session *session,
					      union perf_event *event)
3418
{
3419 3420 3421
	struct perf_tool *tool = session->tool;

	int ret = perf_event__process_auxtrace_info(session, event);
3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434

	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

3435 3436 3437 3438 3439 3440
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);
3441
	symbol_conf.nanosecs = true;
3442 3443 3444 3445 3446 3447 3448
	return 0;
}

static int parse_xed(const struct option *opt __maybe_unused,
		     const char *str __maybe_unused,
		     int unset __maybe_unused)
{
3449 3450 3451 3452
	if (isatty(1))
		force_pager("xed -F insn: -A -64 | less");
	else
		force_pager("xed -F insn: -A -64");
3453 3454 3455
	return 0;
}

3456 3457 3458 3459 3460 3461
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);
3462
	symbol_conf.nanosecs = true;
3463
	symbol_conf.pad_output_len_dso = 50;
3464 3465 3466 3467 3468 3469 3470 3471 3472
	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);
3473
	symbol_conf.nanosecs = true;
3474 3475 3476
	return 0;
}

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

3662 3663
	perf_set_singlethreaded();

3664 3665
	setup_scripting();

3666
	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3667 3668
			     PARSE_OPT_STOP_AT_NON_OPTION);

3669 3670 3671 3672 3673 3674 3675 3676 3677 3678
	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 已提交
3679 3680
	data.path  = input_name;
	data.force = symbol_conf.force;
3681

3682 3683 3684
	if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
		rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
		if (!rec_script_path)
3685
			return cmd_record(argc, argv);
3686 3687
	}

3688 3689 3690
	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!rep_script_path) {
3691
			fprintf(stderr,
3692
				"Please specify a valid report script"
3693
				"(see 'perf script -l' for listing)\n");
3694 3695 3696 3697
			return -1;
		}
	}

3698 3699 3700 3701 3702 3703 3704
	if (reltime && deltatime) {
		fprintf(stderr,
			"reltime and deltatime - the two don't get along well. "
			"Please limit to --reltime or --deltatime.\n");
		return -1;
	}

3705
	if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
3706 3707 3708
	    itrace_synth_opts.callchain_sz > scripting_max_stack)
		scripting_max_stack = itrace_synth_opts.callchain_sz;

3709
	/* make sure PERF_EXEC_PATH is set for scripts */
3710
	set_argv_exec_path(get_argv_exec_path());
3711

3712
	if (argc && !script_name && !rec_script_path && !rep_script_path) {
3713
		int live_pipe[2];
3714
		int rep_args;
3715 3716
		pid_t pid;

3717 3718 3719 3720
		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) {
3721 3722
			usage_with_options_msg(script_usage, options,
				"Couldn't find script `%s'\n\n See perf"
3723
				" script -l for available scripts.\n", argv[0]);
3724 3725
		}

3726 3727 3728 3729 3730 3731 3732 3733
		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) {
3734 3735
				usage_with_options_msg(script_usage, options,
					"`%s' script requires options."
3736
					"\n\n See perf script -l for available "
3737 3738
					"scripts and options.\n", argv[0]);
			}
3739 3740 3741 3742
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
3743
			return -1;
3744 3745 3746 3747 3748
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
3749
			return -1;
3750 3751 3752
		}

		if (!pid) {
3753 3754
			j = 0;

3755 3756 3757
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

3758 3759 3760
			if (is_top_script(argv[0])) {
				system_wide = true;
			} else if (!system_wide) {
3761 3762 3763 3764
				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
					err = -1;
					goto out;
				}
3765
			}
3766 3767

			__argv = malloc((argc + 6) * sizeof(const char *));
3768 3769 3770 3771 3772
			if (!__argv) {
				pr_err("malloc failed\n");
				err = -ENOMEM;
				goto out;
			}
3773

3774 3775 3776 3777 3778 3779 3780 3781 3782 3783
			__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;
3784 3785

			execvp("/bin/sh", (char **)__argv);
3786
			free(__argv);
3787 3788 3789 3790 3791 3792
			exit(-1);
		}

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

3793
		__argv = malloc((argc + 4) * sizeof(const char *));
3794 3795 3796 3797 3798 3799
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

3800 3801 3802 3803 3804 3805 3806 3807
		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;
3808 3809

		execvp("/bin/sh", (char **)__argv);
3810
		free(__argv);
3811 3812 3813
		exit(-1);
	}

3814 3815 3816 3817
	if (rec_script_path)
		script_path = rec_script_path;
	if (rep_script_path)
		script_path = rep_script_path;
3818

3819 3820
	if (script_path) {
		j = 0;
3821

3822 3823
		if (!rec_script_path)
			system_wide = false;
3824 3825 3826 3827 3828 3829
		else if (!system_wide) {
			if (have_cmd(argc - 1, &argv[1]) != 0) {
				err = -1;
				goto out;
			}
		}
3830

3831
		__argv = malloc((argc + 2) * sizeof(const char *));
3832 3833 3834 3835 3836 3837
		if (!__argv) {
			pr_err("malloc failed\n");
			err = -ENOMEM;
			goto out;
		}

3838 3839 3840 3841
		__argv[j++] = "/bin/sh";
		__argv[j++] = script_path;
		if (system_wide)
			__argv[j++] = "-a";
3842
		for (i = 2; i < argc; i++)
3843 3844
			__argv[j++] = argv[i];
		__argv[j++] = NULL;
3845 3846

		execvp("/bin/sh", (char **)__argv);
3847
		free(__argv);
3848 3849
		exit(-1);
	}
T
Tom Zanussi 已提交
3850

3851
	if (!script_name) {
3852
		setup_pager();
3853 3854
		use_browser = 0;
	}
F
Frederic Weisbecker 已提交
3855

3856
	session = perf_session__new(&data, false, &script.tool);
3857 3858
	if (IS_ERR(session))
		return PTR_ERR(session);
3859

3860
	if (header || header_only) {
3861
		script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3862 3863
		perf_session__fprintf_info(session, stdout, show_full_info);
		if (header_only)
3864
			goto out_delete;
3865
	}
3866 3867
	if (show_full_info)
		script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3868

3869
	if (symbol__init(&session->header.env) < 0)
3870 3871
		goto out_delete;

3872
	uname(&uts);
3873 3874
	if (data.is_pipe ||  /* assume pipe_mode indicates native_arch */
	    !strcmp(uts.machine, session->header.env.arch) ||
3875 3876 3877 3878
	    (!strcmp(uts.machine, "x86_64") &&
	     !strcmp(session->header.env.arch, "i386")))
		native_arch = true;

3879
	script.session = session;
3880
	script__setup_sample_type(&script);
3881

3882 3883
	if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
	    symbol_conf.graph_function)
3884 3885
		itrace_synth_opts.thread_stack = true;

3886 3887
	session->itrace_synth_opts = &itrace_synth_opts;

3888
	if (cpu_list) {
3889 3890 3891
		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
		if (err < 0)
			goto out_delete;
3892
		itrace_synth_opts.cpu_bitmap = cpu_bitmap;
3893 3894
	}

3895
	if (!no_callchain)
3896 3897 3898 3899
		symbol_conf.use_callchain = true;
	else
		symbol_conf.use_callchain = false;

3900
	if (session->tevent.pevent &&
3901 3902 3903
	    tep_set_function_resolver(session->tevent.pevent,
				      machine__resolve_kernel_addr,
				      &session->machines.host) < 0) {
3904
		pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
3905 3906
		err = -1;
		goto out_delete;
3907 3908
	}

T
Tom Zanussi 已提交
3909 3910
	if (generate_script_lang) {
		struct stat perf_stat;
3911 3912
		int input;

3913
		if (output_set_by_user()) {
3914 3915
			fprintf(stderr,
				"custom fields not supported for generated scripts");
3916 3917
			err = -EINVAL;
			goto out_delete;
3918
		}
T
Tom Zanussi 已提交
3919

J
Jiri Olsa 已提交
3920
		input = open(data.path, O_RDONLY);	/* input_name */
T
Tom Zanussi 已提交
3921
		if (input < 0) {
3922
			err = -errno;
T
Tom Zanussi 已提交
3923
			perror("failed to open file");
3924
			goto out_delete;
T
Tom Zanussi 已提交
3925 3926 3927 3928 3929
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
3930
			goto out_delete;
T
Tom Zanussi 已提交
3931 3932 3933 3934
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
3935
			goto out_delete;
T
Tom Zanussi 已提交
3936 3937 3938 3939 3940
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
3941 3942
			err = -ENOENT;
			goto out_delete;
T
Tom Zanussi 已提交
3943 3944
		}

J
Jiri Olsa 已提交
3945
		err = scripting_ops->generate_script(session->tevent.pevent,
3946
						     "perf-script");
3947
		goto out_delete;
T
Tom Zanussi 已提交
3948 3949 3950
	}

	if (script_name) {
3951
		err = scripting_ops->start_script(script_name, argc, argv);
T
Tom Zanussi 已提交
3952
		if (err)
3953
			goto out_delete;
3954
		pr_debug("perf script started with script %s\n\n", script_name);
3955
		script_started = true;
T
Tom Zanussi 已提交
3956 3957
	}

3958 3959 3960

	err = perf_session__check_output_opt(session);
	if (err < 0)
3961
		goto out_delete;
3962

3963
	if (script.time_str) {
3964
		err = perf_time__parse_for_ranges_reltime(script.time_str, session,
3965 3966
						  &script.ptime_range,
						  &script.range_size,
3967 3968
						  &script.range_num,
						  reltime);
3969
		if (err < 0)
3970
			goto out_delete;
3971 3972 3973 3974

		itrace_synth_opts__set_time_range(&itrace_synth_opts,
						  script.ptime_range,
						  script.range_num);
3975 3976
	}

3977 3978 3979
	err = evswitch__init(&script.evswitch, session->evlist, stderr);
	if (err)
		goto out_delete;
3980

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

3984
	err = __cmd_script(&script);
T
Tom Zanussi 已提交
3985

3986 3987
	flush_scripting();

3988
out_delete:
3989 3990
	if (script.ptime_range) {
		itrace_synth_opts__clear_time_range(&itrace_synth_opts);
3991
		zfree(&script.ptime_range);
3992
	}
3993

3994
	evlist__free_stats(session->evlist);
3995
	perf_session__delete(session);
3996 3997 3998

	if (script_started)
		cleanup_scripting();
T
Tom Zanussi 已提交
3999 4000
out:
	return err;
F
Frederic Weisbecker 已提交
4001
}