xref: /openbmc/linux/tools/perf/builtin-script.c (revision 6d425d7c)
1 // SPDX-License-Identifier: GPL-2.0
2 #include "builtin.h"
3 
4 #include "util/counts.h"
5 #include "util/debug.h"
6 #include "util/dso.h"
7 #include <subcmd/exec-cmd.h>
8 #include "util/header.h"
9 #include <subcmd/parse-options.h>
10 #include "util/perf_regs.h"
11 #include "util/session.h"
12 #include "util/tool.h"
13 #include "util/map.h"
14 #include "util/srcline.h"
15 #include "util/symbol.h"
16 #include "util/thread.h"
17 #include "util/trace-event.h"
18 #include "util/evlist.h"
19 #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 #include "util/cpumap.h"
26 #include "util/thread_map.h"
27 #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"
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"
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 #include <sys/types.h>
52 #include <sys/stat.h>
53 #include <fcntl.h>
54 #include <unistd.h>
55 #include <subcmd/pager.h>
56 #include <perf/evlist.h>
57 #include <linux/err.h>
58 #include "util/dlfilter.h"
59 #include "util/record.h"
60 #include "util/util.h"
61 #include "perf.h"
62 
63 #include <linux/ctype.h>
64 
65 static char const		*script_name;
66 static char const		*generate_script_lang;
67 static bool			reltime;
68 static bool			deltatime;
69 static u64			initial_time;
70 static u64			previous_time;
71 static bool			debug_mode;
72 static u64			last_timestamp;
73 static u64			nr_unordered;
74 static bool			no_callchain;
75 static bool			latency_format;
76 static bool			system_wide;
77 static bool			print_flags;
78 static const char		*cpu_list;
79 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
80 static struct perf_stat_config	stat_config;
81 static int			max_blocks;
82 static bool			native_arch;
83 static struct dlfilter		*dlfilter;
84 static int			dlargc;
85 static char			**dlargv;
86 
87 unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
88 
89 enum perf_output_field {
90 	PERF_OUTPUT_COMM            = 1ULL << 0,
91 	PERF_OUTPUT_TID             = 1ULL << 1,
92 	PERF_OUTPUT_PID             = 1ULL << 2,
93 	PERF_OUTPUT_TIME            = 1ULL << 3,
94 	PERF_OUTPUT_CPU             = 1ULL << 4,
95 	PERF_OUTPUT_EVNAME          = 1ULL << 5,
96 	PERF_OUTPUT_TRACE           = 1ULL << 6,
97 	PERF_OUTPUT_IP              = 1ULL << 7,
98 	PERF_OUTPUT_SYM             = 1ULL << 8,
99 	PERF_OUTPUT_DSO             = 1ULL << 9,
100 	PERF_OUTPUT_ADDR            = 1ULL << 10,
101 	PERF_OUTPUT_SYMOFFSET       = 1ULL << 11,
102 	PERF_OUTPUT_SRCLINE         = 1ULL << 12,
103 	PERF_OUTPUT_PERIOD          = 1ULL << 13,
104 	PERF_OUTPUT_IREGS	    = 1ULL << 14,
105 	PERF_OUTPUT_BRSTACK	    = 1ULL << 15,
106 	PERF_OUTPUT_BRSTACKSYM	    = 1ULL << 16,
107 	PERF_OUTPUT_DATA_SRC	    = 1ULL << 17,
108 	PERF_OUTPUT_WEIGHT	    = 1ULL << 18,
109 	PERF_OUTPUT_BPF_OUTPUT	    = 1ULL << 19,
110 	PERF_OUTPUT_CALLINDENT	    = 1ULL << 20,
111 	PERF_OUTPUT_INSN	    = 1ULL << 21,
112 	PERF_OUTPUT_INSNLEN	    = 1ULL << 22,
113 	PERF_OUTPUT_BRSTACKINSN	    = 1ULL << 23,
114 	PERF_OUTPUT_BRSTACKOFF	    = 1ULL << 24,
115 	PERF_OUTPUT_SYNTH           = 1ULL << 25,
116 	PERF_OUTPUT_PHYS_ADDR       = 1ULL << 26,
117 	PERF_OUTPUT_UREGS	    = 1ULL << 27,
118 	PERF_OUTPUT_METRIC	    = 1ULL << 28,
119 	PERF_OUTPUT_MISC            = 1ULL << 29,
120 	PERF_OUTPUT_SRCCODE	    = 1ULL << 30,
121 	PERF_OUTPUT_IPC             = 1ULL << 31,
122 	PERF_OUTPUT_TOD             = 1ULL << 32,
123 	PERF_OUTPUT_DATA_PAGE_SIZE  = 1ULL << 33,
124 	PERF_OUTPUT_CODE_PAGE_SIZE  = 1ULL << 34,
125 	PERF_OUTPUT_INS_LAT         = 1ULL << 35,
126 };
127 
128 struct perf_script {
129 	struct perf_tool	tool;
130 	struct perf_session	*session;
131 	bool			show_task_events;
132 	bool			show_mmap_events;
133 	bool			show_switch_events;
134 	bool			show_namespace_events;
135 	bool			show_lost_events;
136 	bool			show_round_events;
137 	bool			show_bpf_events;
138 	bool			show_cgroup_events;
139 	bool			show_text_poke_events;
140 	bool			allocated;
141 	bool			per_event_dump;
142 	bool			stitch_lbr;
143 	struct evswitch		evswitch;
144 	struct perf_cpu_map	*cpus;
145 	struct perf_thread_map *threads;
146 	int			name_width;
147 	const char              *time_str;
148 	struct perf_time_interval *ptime_range;
149 	int			range_size;
150 	int			range_num;
151 };
152 
153 struct output_option {
154 	const char *str;
155 	enum perf_output_field field;
156 } all_output_options[] = {
157 	{.str = "comm",  .field = PERF_OUTPUT_COMM},
158 	{.str = "tid",   .field = PERF_OUTPUT_TID},
159 	{.str = "pid",   .field = PERF_OUTPUT_PID},
160 	{.str = "time",  .field = PERF_OUTPUT_TIME},
161 	{.str = "cpu",   .field = PERF_OUTPUT_CPU},
162 	{.str = "event", .field = PERF_OUTPUT_EVNAME},
163 	{.str = "trace", .field = PERF_OUTPUT_TRACE},
164 	{.str = "ip",    .field = PERF_OUTPUT_IP},
165 	{.str = "sym",   .field = PERF_OUTPUT_SYM},
166 	{.str = "dso",   .field = PERF_OUTPUT_DSO},
167 	{.str = "addr",  .field = PERF_OUTPUT_ADDR},
168 	{.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
169 	{.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
170 	{.str = "period", .field = PERF_OUTPUT_PERIOD},
171 	{.str = "iregs", .field = PERF_OUTPUT_IREGS},
172 	{.str = "uregs", .field = PERF_OUTPUT_UREGS},
173 	{.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
174 	{.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
175 	{.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
176 	{.str = "weight",   .field = PERF_OUTPUT_WEIGHT},
177 	{.str = "bpf-output",   .field = PERF_OUTPUT_BPF_OUTPUT},
178 	{.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
179 	{.str = "insn", .field = PERF_OUTPUT_INSN},
180 	{.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
181 	{.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
182 	{.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
183 	{.str = "synth", .field = PERF_OUTPUT_SYNTH},
184 	{.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
185 	{.str = "metric", .field = PERF_OUTPUT_METRIC},
186 	{.str = "misc", .field = PERF_OUTPUT_MISC},
187 	{.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
188 	{.str = "ipc", .field = PERF_OUTPUT_IPC},
189 	{.str = "tod", .field = PERF_OUTPUT_TOD},
190 	{.str = "data_page_size", .field = PERF_OUTPUT_DATA_PAGE_SIZE},
191 	{.str = "code_page_size", .field = PERF_OUTPUT_CODE_PAGE_SIZE},
192 	{.str = "ins_lat", .field = PERF_OUTPUT_INS_LAT},
193 };
194 
195 enum {
196 	OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
197 	OUTPUT_TYPE_OTHER,
198 	OUTPUT_TYPE_MAX
199 };
200 
201 /* default set to maintain compatibility with current format */
202 static struct {
203 	bool user_set;
204 	bool wildcard_set;
205 	unsigned int print_ip_opts;
206 	u64 fields;
207 	u64 invalid_fields;
208 	u64 user_set_fields;
209 	u64 user_unset_fields;
210 } output[OUTPUT_TYPE_MAX] = {
211 
212 	[PERF_TYPE_HARDWARE] = {
213 		.user_set = false,
214 
215 		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
216 			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
217 			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
218 			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
219 			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
220 
221 		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
222 	},
223 
224 	[PERF_TYPE_SOFTWARE] = {
225 		.user_set = false,
226 
227 		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
228 			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
229 			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
230 			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
231 			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
232 			      PERF_OUTPUT_BPF_OUTPUT,
233 
234 		.invalid_fields = PERF_OUTPUT_TRACE,
235 	},
236 
237 	[PERF_TYPE_TRACEPOINT] = {
238 		.user_set = false,
239 
240 		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
241 				  PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
242 				  PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
243 	},
244 
245 	[PERF_TYPE_HW_CACHE] = {
246 		.user_set = false,
247 
248 		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
249 			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
250 			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
251 			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
252 			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
253 
254 		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
255 	},
256 
257 	[PERF_TYPE_RAW] = {
258 		.user_set = false,
259 
260 		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
261 			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
262 			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
263 			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
264 			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
265 			      PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
266 			      PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR |
267 			      PERF_OUTPUT_DATA_PAGE_SIZE | PERF_OUTPUT_CODE_PAGE_SIZE |
268 			      PERF_OUTPUT_INS_LAT,
269 
270 		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
271 	},
272 
273 	[PERF_TYPE_BREAKPOINT] = {
274 		.user_set = false,
275 
276 		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
277 			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
278 			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
279 			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
280 			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
281 
282 		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
283 	},
284 
285 	[OUTPUT_TYPE_SYNTH] = {
286 		.user_set = false,
287 
288 		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
289 			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
290 			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
291 			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
292 			      PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
293 
294 		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
295 	},
296 
297 	[OUTPUT_TYPE_OTHER] = {
298 		.user_set = false,
299 
300 		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
301 			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
302 			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
303 			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
304 			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
305 
306 		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
307 	},
308 };
309 
310 struct evsel_script {
311        char *filename;
312        FILE *fp;
313        u64  samples;
314        /* For metric output */
315        u64  val;
316        int  gnum;
317 };
318 
319 static inline struct evsel_script *evsel_script(struct evsel *evsel)
320 {
321 	return (struct evsel_script *)evsel->priv;
322 }
323 
324 static struct evsel_script *evsel_script__new(struct evsel *evsel, struct perf_data *data)
325 {
326 	struct evsel_script *es = zalloc(sizeof(*es));
327 
328 	if (es != NULL) {
329 		if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
330 			goto out_free;
331 		es->fp = fopen(es->filename, "w");
332 		if (es->fp == NULL)
333 			goto out_free_filename;
334 	}
335 
336 	return es;
337 out_free_filename:
338 	zfree(&es->filename);
339 out_free:
340 	free(es);
341 	return NULL;
342 }
343 
344 static void evsel_script__delete(struct evsel_script *es)
345 {
346 	zfree(&es->filename);
347 	fclose(es->fp);
348 	es->fp = NULL;
349 	free(es);
350 }
351 
352 static int evsel_script__fprintf(struct evsel_script *es, FILE *fp)
353 {
354 	struct stat st;
355 
356 	fstat(fileno(es->fp), &st);
357 	return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
358 		       st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
359 }
360 
361 static inline int output_type(unsigned int type)
362 {
363 	switch (type) {
364 	case PERF_TYPE_SYNTH:
365 		return OUTPUT_TYPE_SYNTH;
366 	default:
367 		if (type < PERF_TYPE_MAX)
368 			return type;
369 	}
370 
371 	return OUTPUT_TYPE_OTHER;
372 }
373 
374 static bool output_set_by_user(void)
375 {
376 	int j;
377 	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
378 		if (output[j].user_set)
379 			return true;
380 	}
381 	return false;
382 }
383 
384 static const char *output_field2str(enum perf_output_field field)
385 {
386 	int i, imax = ARRAY_SIZE(all_output_options);
387 	const char *str = "";
388 
389 	for (i = 0; i < imax; ++i) {
390 		if (all_output_options[i].field == field) {
391 			str = all_output_options[i].str;
392 			break;
393 		}
394 	}
395 	return str;
396 }
397 
398 #define PRINT_FIELD(x)  (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
399 
400 static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
401 				 enum perf_output_field field, bool allow_user_set)
402 {
403 	struct perf_event_attr *attr = &evsel->core.attr;
404 	int type = output_type(attr->type);
405 	const char *evname;
406 
407 	if (attr->sample_type & sample_type)
408 		return 0;
409 
410 	if (output[type].user_set_fields & field) {
411 		if (allow_user_set)
412 			return 0;
413 		evname = evsel__name(evsel);
414 		pr_err("Samples for '%s' event do not have %s attribute set. "
415 		       "Cannot print '%s' field.\n",
416 		       evname, sample_msg, output_field2str(field));
417 		return -1;
418 	}
419 
420 	/* user did not ask for it explicitly so remove from the default list */
421 	output[type].fields &= ~field;
422 	evname = evsel__name(evsel);
423 	pr_debug("Samples for '%s' event do not have %s attribute set. "
424 		 "Skipping '%s' field.\n",
425 		 evname, sample_msg, output_field2str(field));
426 
427 	return 0;
428 }
429 
430 static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
431 			      enum perf_output_field field)
432 {
433 	return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
434 }
435 
436 static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
437 {
438 	struct perf_event_attr *attr = &evsel->core.attr;
439 	bool allow_user_set;
440 
441 	if (perf_header__has_feat(&session->header, HEADER_STAT))
442 		return 0;
443 
444 	allow_user_set = perf_header__has_feat(&session->header,
445 					       HEADER_AUXTRACE);
446 
447 	if (PRINT_FIELD(TRACE) &&
448 	    !perf_session__has_traces(session, "record -R"))
449 		return -EINVAL;
450 
451 	if (PRINT_FIELD(IP)) {
452 		if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
453 			return -EINVAL;
454 	}
455 
456 	if (PRINT_FIELD(ADDR) &&
457 	    evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
458 		return -EINVAL;
459 
460 	if (PRINT_FIELD(DATA_SRC) &&
461 	    evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC))
462 		return -EINVAL;
463 
464 	if (PRINT_FIELD(WEIGHT) &&
465 	    evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_TYPE, "WEIGHT", PERF_OUTPUT_WEIGHT))
466 		return -EINVAL;
467 
468 	if (PRINT_FIELD(SYM) &&
469 	    !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
470 		pr_err("Display of symbols requested but neither sample IP nor "
471 			   "sample address\navailable. Hence, no addresses to convert "
472 		       "to symbols.\n");
473 		return -EINVAL;
474 	}
475 	if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
476 		pr_err("Display of offsets requested but symbol is not"
477 		       "selected.\n");
478 		return -EINVAL;
479 	}
480 	if (PRINT_FIELD(DSO) &&
481 	    !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
482 		pr_err("Display of DSO requested but no address to convert.\n");
483 		return -EINVAL;
484 	}
485 	if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
486 		pr_err("Display of source line number requested but sample IP is not\n"
487 		       "selected. Hence, no address to lookup the source line number.\n");
488 		return -EINVAL;
489 	}
490 	if (PRINT_FIELD(BRSTACKINSN) && !allow_user_set &&
491 	    !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
492 		pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
493 		       "Hint: run 'perf record -b ...'\n");
494 		return -EINVAL;
495 	}
496 	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
497 	    evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
498 		return -EINVAL;
499 
500 	if (PRINT_FIELD(TIME) &&
501 	    evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
502 		return -EINVAL;
503 
504 	if (PRINT_FIELD(CPU) &&
505 	    evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
506 		return -EINVAL;
507 
508 	if (PRINT_FIELD(IREGS) &&
509 	    evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
510 		return -EINVAL;
511 
512 	if (PRINT_FIELD(UREGS) &&
513 	    evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
514 		return -EINVAL;
515 
516 	if (PRINT_FIELD(PHYS_ADDR) &&
517 	    evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR))
518 		return -EINVAL;
519 
520 	if (PRINT_FIELD(DATA_PAGE_SIZE) &&
521 	    evsel__check_stype(evsel, PERF_SAMPLE_DATA_PAGE_SIZE, "DATA_PAGE_SIZE", PERF_OUTPUT_DATA_PAGE_SIZE))
522 		return -EINVAL;
523 
524 	if (PRINT_FIELD(CODE_PAGE_SIZE) &&
525 	    evsel__check_stype(evsel, PERF_SAMPLE_CODE_PAGE_SIZE, "CODE_PAGE_SIZE", PERF_OUTPUT_CODE_PAGE_SIZE))
526 		return -EINVAL;
527 
528 	if (PRINT_FIELD(INS_LAT) &&
529 	    evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT_STRUCT, "WEIGHT_STRUCT", PERF_OUTPUT_INS_LAT))
530 		return -EINVAL;
531 
532 	return 0;
533 }
534 
535 static void set_print_ip_opts(struct perf_event_attr *attr)
536 {
537 	unsigned int type = output_type(attr->type);
538 
539 	output[type].print_ip_opts = 0;
540 	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 static struct evsel *find_first_output_type(struct evlist *evlist,
557 					    unsigned int type)
558 {
559 	struct evsel *evsel;
560 
561 	evlist__for_each_entry(evlist, evsel) {
562 		if (output_type(evsel->core.attr.type) == (int)type)
563 			return evsel;
564 	}
565 	return NULL;
566 }
567 
568 /*
569  * verify all user requested events exist and the samples
570  * have the expected data
571  */
572 static int perf_session__check_output_opt(struct perf_session *session)
573 {
574 	bool tod = false;
575 	unsigned int j;
576 	struct evsel *evsel;
577 
578 	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
579 		evsel = find_first_output_type(session->evlist, j);
580 
581 		/*
582 		 * even if fields is set to 0 (ie., show nothing) event must
583 		 * exist if user explicitly includes it on the command line
584 		 */
585 		if (!evsel && output[j].user_set && !output[j].wildcard_set &&
586 		    j != OUTPUT_TYPE_SYNTH) {
587 			pr_err("%s events do not exist. "
588 			       "Remove corresponding -F option to proceed.\n",
589 			       event_type(j));
590 			return -1;
591 		}
592 
593 		if (evsel && output[j].fields &&
594 			evsel__check_attr(evsel, session))
595 			return -1;
596 
597 		if (evsel == NULL)
598 			continue;
599 
600 		set_print_ip_opts(&evsel->core.attr);
601 		tod |= output[j].fields & PERF_OUTPUT_TOD;
602 	}
603 
604 	if (!no_callchain) {
605 		bool use_callchain = false;
606 		bool not_pipe = false;
607 
608 		evlist__for_each_entry(session->evlist, evsel) {
609 			not_pipe = true;
610 			if (evsel__has_callchain(evsel)) {
611 				use_callchain = true;
612 				break;
613 			}
614 		}
615 		if (not_pipe && !use_callchain)
616 			symbol_conf.use_callchain = false;
617 	}
618 
619 	/*
620 	 * set default for tracepoints to print symbols only
621 	 * if callchains are present
622 	 */
623 	if (symbol_conf.use_callchain &&
624 	    !output[PERF_TYPE_TRACEPOINT].user_set) {
625 		j = PERF_TYPE_TRACEPOINT;
626 
627 		evlist__for_each_entry(session->evlist, evsel) {
628 			if (evsel->core.attr.type != j)
629 				continue;
630 
631 			if (evsel__has_callchain(evsel)) {
632 				output[j].fields |= PERF_OUTPUT_IP;
633 				output[j].fields |= PERF_OUTPUT_SYM;
634 				output[j].fields |= PERF_OUTPUT_SYMOFFSET;
635 				output[j].fields |= PERF_OUTPUT_DSO;
636 				set_print_ip_opts(&evsel->core.attr);
637 				goto out;
638 			}
639 		}
640 	}
641 
642 	if (tod && !session->header.env.clock.enabled) {
643 		pr_err("Can't provide 'tod' time, missing clock data. "
644 		       "Please record with -k/--clockid option.\n");
645 		return -1;
646 	}
647 out:
648 	return 0;
649 }
650 
651 static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
652 				     FILE *fp)
653 {
654 	unsigned i = 0, r;
655 	int printed = 0;
656 
657 	if (!regs || !regs->regs)
658 		return 0;
659 
660 	printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
661 
662 	for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
663 		u64 val = regs->regs[i++];
664 		printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r), val);
665 	}
666 
667 	return printed;
668 }
669 
670 #define DEFAULT_TOD_FMT "%F %H:%M:%S"
671 
672 static char*
673 tod_scnprintf(struct perf_script *script, char *buf, int buflen,
674 	     u64 timestamp)
675 {
676 	u64 tod_ns, clockid_ns;
677 	struct perf_env *env;
678 	unsigned long nsec;
679 	struct tm ltime;
680 	char date[64];
681 	time_t sec;
682 
683 	buf[0] = '\0';
684 	if (buflen < 64 || !script)
685 		return buf;
686 
687 	env = &script->session->header.env;
688 	if (!env->clock.enabled) {
689 		scnprintf(buf, buflen, "disabled");
690 		return buf;
691 	}
692 
693 	clockid_ns = env->clock.clockid_ns;
694 	tod_ns     = env->clock.tod_ns;
695 
696 	if (timestamp > clockid_ns)
697 		tod_ns += timestamp - clockid_ns;
698 	else
699 		tod_ns -= clockid_ns - timestamp;
700 
701 	sec  = (time_t) (tod_ns / NSEC_PER_SEC);
702 	nsec = tod_ns - sec * NSEC_PER_SEC;
703 
704 	if (localtime_r(&sec, &ltime) == NULL) {
705 		scnprintf(buf, buflen, "failed");
706 	} else {
707 		strftime(date, sizeof(date), DEFAULT_TOD_FMT, &ltime);
708 
709 		if (symbol_conf.nanosecs) {
710 			snprintf(buf, buflen, "%s.%09lu", date, nsec);
711 		} else {
712 			snprintf(buf, buflen, "%s.%06lu",
713 				 date, nsec / NSEC_PER_USEC);
714 		}
715 	}
716 
717 	return buf;
718 }
719 
720 static int perf_sample__fprintf_iregs(struct perf_sample *sample,
721 				      struct perf_event_attr *attr, FILE *fp)
722 {
723 	return perf_sample__fprintf_regs(&sample->intr_regs,
724 					 attr->sample_regs_intr, fp);
725 }
726 
727 static int perf_sample__fprintf_uregs(struct perf_sample *sample,
728 				      struct perf_event_attr *attr, FILE *fp)
729 {
730 	return perf_sample__fprintf_regs(&sample->user_regs,
731 					 attr->sample_regs_user, fp);
732 }
733 
734 static int perf_sample__fprintf_start(struct perf_script *script,
735 				      struct perf_sample *sample,
736 				      struct thread *thread,
737 				      struct evsel *evsel,
738 				      u32 type, FILE *fp)
739 {
740 	struct perf_event_attr *attr = &evsel->core.attr;
741 	unsigned long secs;
742 	unsigned long long nsecs;
743 	int printed = 0;
744 	char tstr[128];
745 
746 	if (PRINT_FIELD(COMM)) {
747 		const char *comm = thread ? thread__comm_str(thread) : ":-1";
748 
749 		if (latency_format)
750 			printed += fprintf(fp, "%8.8s ", comm);
751 		else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
752 			printed += fprintf(fp, "%s ", comm);
753 		else
754 			printed += fprintf(fp, "%16s ", comm);
755 	}
756 
757 	if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
758 		printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
759 	else if (PRINT_FIELD(PID))
760 		printed += fprintf(fp, "%5d ", sample->pid);
761 	else if (PRINT_FIELD(TID))
762 		printed += fprintf(fp, "%5d ", sample->tid);
763 
764 	if (PRINT_FIELD(CPU)) {
765 		if (latency_format)
766 			printed += fprintf(fp, "%3d ", sample->cpu);
767 		else
768 			printed += fprintf(fp, "[%03d] ", sample->cpu);
769 	}
770 
771 	if (PRINT_FIELD(MISC)) {
772 		int ret = 0;
773 
774 		#define has(m) \
775 			(sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
776 
777 		if (has(KERNEL))
778 			ret += fprintf(fp, "K");
779 		if (has(USER))
780 			ret += fprintf(fp, "U");
781 		if (has(HYPERVISOR))
782 			ret += fprintf(fp, "H");
783 		if (has(GUEST_KERNEL))
784 			ret += fprintf(fp, "G");
785 		if (has(GUEST_USER))
786 			ret += fprintf(fp, "g");
787 
788 		switch (type) {
789 		case PERF_RECORD_MMAP:
790 		case PERF_RECORD_MMAP2:
791 			if (has(MMAP_DATA))
792 				ret += fprintf(fp, "M");
793 			break;
794 		case PERF_RECORD_COMM:
795 			if (has(COMM_EXEC))
796 				ret += fprintf(fp, "E");
797 			break;
798 		case PERF_RECORD_SWITCH:
799 		case PERF_RECORD_SWITCH_CPU_WIDE:
800 			if (has(SWITCH_OUT)) {
801 				ret += fprintf(fp, "S");
802 				if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
803 					ret += fprintf(fp, "p");
804 			}
805 		default:
806 			break;
807 		}
808 
809 		#undef has
810 
811 		ret += fprintf(fp, "%*s", 6 - ret, " ");
812 		printed += ret;
813 	}
814 
815 	if (PRINT_FIELD(TOD)) {
816 		tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
817 		printed += fprintf(fp, "%s ", tstr);
818 	}
819 
820 	if (PRINT_FIELD(TIME)) {
821 		u64 t = sample->time;
822 		if (reltime) {
823 			if (!initial_time)
824 				initial_time = sample->time;
825 			t = sample->time - initial_time;
826 		} else if (deltatime) {
827 			if (previous_time)
828 				t = sample->time - previous_time;
829 			else {
830 				t = 0;
831 			}
832 			previous_time = sample->time;
833 		}
834 		nsecs = t;
835 		secs = nsecs / NSEC_PER_SEC;
836 		nsecs -= secs * NSEC_PER_SEC;
837 
838 		if (symbol_conf.nanosecs)
839 			printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
840 		else {
841 			char sample_time[32];
842 			timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
843 			printed += fprintf(fp, "%12s: ", sample_time);
844 		}
845 	}
846 
847 	return printed;
848 }
849 
850 static inline char
851 mispred_str(struct branch_entry *br)
852 {
853 	if (!(br->flags.mispred  || br->flags.predicted))
854 		return '-';
855 
856 	return br->flags.predicted ? 'P' : 'M';
857 }
858 
859 static int perf_sample__fprintf_brstack(struct perf_sample *sample,
860 					struct thread *thread,
861 					struct perf_event_attr *attr, FILE *fp)
862 {
863 	struct branch_stack *br = sample->branch_stack;
864 	struct branch_entry *entries = perf_sample__branch_entries(sample);
865 	struct addr_location alf, alt;
866 	u64 i, from, to;
867 	int printed = 0;
868 
869 	if (!(br && br->nr))
870 		return 0;
871 
872 	for (i = 0; i < br->nr; i++) {
873 		from = entries[i].from;
874 		to   = entries[i].to;
875 
876 		if (PRINT_FIELD(DSO)) {
877 			memset(&alf, 0, sizeof(alf));
878 			memset(&alt, 0, sizeof(alt));
879 			thread__find_map_fb(thread, sample->cpumode, from, &alf);
880 			thread__find_map_fb(thread, sample->cpumode, to, &alt);
881 		}
882 
883 		printed += fprintf(fp, " 0x%"PRIx64, from);
884 		if (PRINT_FIELD(DSO)) {
885 			printed += fprintf(fp, "(");
886 			printed += map__fprintf_dsoname(alf.map, fp);
887 			printed += fprintf(fp, ")");
888 		}
889 
890 		printed += fprintf(fp, "/0x%"PRIx64, to);
891 		if (PRINT_FIELD(DSO)) {
892 			printed += fprintf(fp, "(");
893 			printed += map__fprintf_dsoname(alt.map, fp);
894 			printed += fprintf(fp, ")");
895 		}
896 
897 		printed += fprintf(fp, "/%c/%c/%c/%d ",
898 			mispred_str(entries + i),
899 			entries[i].flags.in_tx ? 'X' : '-',
900 			entries[i].flags.abort ? 'A' : '-',
901 			entries[i].flags.cycles);
902 	}
903 
904 	return printed;
905 }
906 
907 static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
908 					   struct thread *thread,
909 					   struct perf_event_attr *attr, FILE *fp)
910 {
911 	struct branch_stack *br = sample->branch_stack;
912 	struct branch_entry *entries = perf_sample__branch_entries(sample);
913 	struct addr_location alf, alt;
914 	u64 i, from, to;
915 	int printed = 0;
916 
917 	if (!(br && br->nr))
918 		return 0;
919 
920 	for (i = 0; i < br->nr; i++) {
921 
922 		memset(&alf, 0, sizeof(alf));
923 		memset(&alt, 0, sizeof(alt));
924 		from = entries[i].from;
925 		to   = entries[i].to;
926 
927 		thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
928 		thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
929 
930 		printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
931 		if (PRINT_FIELD(DSO)) {
932 			printed += fprintf(fp, "(");
933 			printed += map__fprintf_dsoname(alf.map, fp);
934 			printed += fprintf(fp, ")");
935 		}
936 		printed += fprintf(fp, "%c", '/');
937 		printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
938 		if (PRINT_FIELD(DSO)) {
939 			printed += fprintf(fp, "(");
940 			printed += map__fprintf_dsoname(alt.map, fp);
941 			printed += fprintf(fp, ")");
942 		}
943 		printed += fprintf(fp, "/%c/%c/%c/%d ",
944 			mispred_str(entries + i),
945 			entries[i].flags.in_tx ? 'X' : '-',
946 			entries[i].flags.abort ? 'A' : '-',
947 			entries[i].flags.cycles);
948 	}
949 
950 	return printed;
951 }
952 
953 static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
954 					   struct thread *thread,
955 					   struct perf_event_attr *attr, FILE *fp)
956 {
957 	struct branch_stack *br = sample->branch_stack;
958 	struct branch_entry *entries = perf_sample__branch_entries(sample);
959 	struct addr_location alf, alt;
960 	u64 i, from, to;
961 	int printed = 0;
962 
963 	if (!(br && br->nr))
964 		return 0;
965 
966 	for (i = 0; i < br->nr; i++) {
967 
968 		memset(&alf, 0, sizeof(alf));
969 		memset(&alt, 0, sizeof(alt));
970 		from = entries[i].from;
971 		to   = entries[i].to;
972 
973 		if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
974 		    !alf.map->dso->adjust_symbols)
975 			from = map__map_ip(alf.map, from);
976 
977 		if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
978 		    !alt.map->dso->adjust_symbols)
979 			to = map__map_ip(alt.map, to);
980 
981 		printed += fprintf(fp, " 0x%"PRIx64, from);
982 		if (PRINT_FIELD(DSO)) {
983 			printed += fprintf(fp, "(");
984 			printed += map__fprintf_dsoname(alf.map, fp);
985 			printed += fprintf(fp, ")");
986 		}
987 		printed += fprintf(fp, "/0x%"PRIx64, to);
988 		if (PRINT_FIELD(DSO)) {
989 			printed += fprintf(fp, "(");
990 			printed += map__fprintf_dsoname(alt.map, fp);
991 			printed += fprintf(fp, ")");
992 		}
993 		printed += fprintf(fp, "/%c/%c/%c/%d ",
994 			mispred_str(entries + i),
995 			entries[i].flags.in_tx ? 'X' : '-',
996 			entries[i].flags.abort ? 'A' : '-',
997 			entries[i].flags.cycles);
998 	}
999 
1000 	return printed;
1001 }
1002 #define MAXBB 16384UL
1003 
1004 static int grab_bb(u8 *buffer, u64 start, u64 end,
1005 		    struct machine *machine, struct thread *thread,
1006 		    bool *is64bit, u8 *cpumode, bool last)
1007 {
1008 	long offset, len;
1009 	struct addr_location al;
1010 	bool kernel;
1011 
1012 	if (!start || !end)
1013 		return 0;
1014 
1015 	kernel = machine__kernel_ip(machine, start);
1016 	if (kernel)
1017 		*cpumode = PERF_RECORD_MISC_KERNEL;
1018 	else
1019 		*cpumode = PERF_RECORD_MISC_USER;
1020 
1021 	/*
1022 	 * Block overlaps between kernel and user.
1023 	 * This can happen due to ring filtering
1024 	 * On Intel CPUs the entry into the kernel is filtered,
1025 	 * but the exit is not. Let the caller patch it up.
1026 	 */
1027 	if (kernel != machine__kernel_ip(machine, end)) {
1028 		pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
1029 		return -ENXIO;
1030 	}
1031 
1032 	memset(&al, 0, sizeof(al));
1033 	if (end - start > MAXBB - MAXINSN) {
1034 		if (last)
1035 			pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
1036 		else
1037 			pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
1038 		return 0;
1039 	}
1040 
1041 	if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
1042 		pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1043 		return 0;
1044 	}
1045 	if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
1046 		pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1047 		return 0;
1048 	}
1049 
1050 	/* Load maps to ensure dso->is_64_bit has been updated */
1051 	map__load(al.map);
1052 
1053 	offset = al.map->map_ip(al.map, start);
1054 	len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
1055 				    end - start + MAXINSN);
1056 
1057 	*is64bit = al.map->dso->is_64_bit;
1058 	if (len <= 0)
1059 		pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1060 			start, end);
1061 	return len;
1062 }
1063 
1064 static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
1065 {
1066 	char *srcfile;
1067 	int ret = 0;
1068 	unsigned line;
1069 	int len;
1070 	char *srccode;
1071 
1072 	if (!map || !map->dso)
1073 		return 0;
1074 	srcfile = get_srcline_split(map->dso,
1075 				    map__rip_2objdump(map, addr),
1076 				    &line);
1077 	if (!srcfile)
1078 		return 0;
1079 
1080 	/* Avoid redundant printing */
1081 	if (state &&
1082 	    state->srcfile &&
1083 	    !strcmp(state->srcfile, srcfile) &&
1084 	    state->line == line) {
1085 		free(srcfile);
1086 		return 0;
1087 	}
1088 
1089 	srccode = find_sourceline(srcfile, line, &len);
1090 	if (!srccode)
1091 		goto out_free_line;
1092 
1093 	ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
1094 
1095 	if (state) {
1096 		state->srcfile = srcfile;
1097 		state->line = line;
1098 	}
1099 	return ret;
1100 
1101 out_free_line:
1102 	free(srcfile);
1103 	return ret;
1104 }
1105 
1106 static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
1107 {
1108 	struct addr_location al;
1109 	int ret = 0;
1110 
1111 	memset(&al, 0, sizeof(al));
1112 	thread__find_map(thread, cpumode, addr, &al);
1113 	if (!al.map)
1114 		return 0;
1115 	ret = map__fprintf_srccode(al.map, al.addr, stdout,
1116 		    &thread->srccode_state);
1117 	if (ret)
1118 		ret += printf("\n");
1119 	return ret;
1120 }
1121 
1122 static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1123 			    struct perf_insn *x, u8 *inbuf, int len,
1124 			    int insn, FILE *fp, int *total_cycles)
1125 {
1126 	int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t#%s%s%s%s", ip,
1127 			      dump_insn(x, ip, inbuf, len, NULL),
1128 			      en->flags.predicted ? " PRED" : "",
1129 			      en->flags.mispred ? " MISPRED" : "",
1130 			      en->flags.in_tx ? " INTX" : "",
1131 			      en->flags.abort ? " ABORT" : "");
1132 	if (en->flags.cycles) {
1133 		*total_cycles += en->flags.cycles;
1134 		printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1135 		if (insn)
1136 			printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1137 	}
1138 	return printed + fprintf(fp, "\n");
1139 }
1140 
1141 static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1142 			   u8 cpumode, int cpu, struct symbol **lastsym,
1143 			   struct perf_event_attr *attr, FILE *fp)
1144 {
1145 	struct addr_location al;
1146 	int off, printed = 0;
1147 
1148 	memset(&al, 0, sizeof(al));
1149 
1150 	thread__find_map(thread, cpumode, addr, &al);
1151 
1152 	if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1153 		return 0;
1154 
1155 	al.cpu = cpu;
1156 	al.sym = NULL;
1157 	if (al.map)
1158 		al.sym = map__find_symbol(al.map, al.addr);
1159 
1160 	if (!al.sym)
1161 		return 0;
1162 
1163 	if (al.addr < al.sym->end)
1164 		off = al.addr - al.sym->start;
1165 	else
1166 		off = al.addr - al.map->start - al.sym->start;
1167 	printed += fprintf(fp, "\t%s", al.sym->name);
1168 	if (off)
1169 		printed += fprintf(fp, "%+d", off);
1170 	printed += fprintf(fp, ":");
1171 	if (PRINT_FIELD(SRCLINE))
1172 		printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1173 	printed += fprintf(fp, "\n");
1174 	*lastsym = al.sym;
1175 
1176 	return printed;
1177 }
1178 
1179 static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1180 					    struct thread *thread,
1181 					    struct perf_event_attr *attr,
1182 					    struct machine *machine, FILE *fp)
1183 {
1184 	struct branch_stack *br = sample->branch_stack;
1185 	struct branch_entry *entries = perf_sample__branch_entries(sample);
1186 	u64 start, end;
1187 	int i, insn, len, nr, ilen, printed = 0;
1188 	struct perf_insn x;
1189 	u8 buffer[MAXBB];
1190 	unsigned off;
1191 	struct symbol *lastsym = NULL;
1192 	int total_cycles = 0;
1193 
1194 	if (!(br && br->nr))
1195 		return 0;
1196 	nr = br->nr;
1197 	if (max_blocks && nr > max_blocks + 1)
1198 		nr = max_blocks + 1;
1199 
1200 	x.thread = thread;
1201 	x.cpu = sample->cpu;
1202 
1203 	printed += fprintf(fp, "%c", '\n');
1204 
1205 	/* Handle first from jump, of which we don't know the entry. */
1206 	len = grab_bb(buffer, entries[nr-1].from,
1207 			entries[nr-1].from,
1208 			machine, thread, &x.is64bit, &x.cpumode, false);
1209 	if (len > 0) {
1210 		printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1211 					   x.cpumode, x.cpu, &lastsym, attr, fp);
1212 		printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1213 					    &x, buffer, len, 0, fp, &total_cycles);
1214 		if (PRINT_FIELD(SRCCODE))
1215 			printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1216 	}
1217 
1218 	/* Print all blocks */
1219 	for (i = nr - 2; i >= 0; i--) {
1220 		if (entries[i].from || entries[i].to)
1221 			pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1222 				 entries[i].from,
1223 				 entries[i].to);
1224 		start = entries[i + 1].to;
1225 		end   = entries[i].from;
1226 
1227 		len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1228 		/* Patch up missing kernel transfers due to ring filters */
1229 		if (len == -ENXIO && i > 0) {
1230 			end = entries[--i].from;
1231 			pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1232 			len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1233 		}
1234 		if (len <= 0)
1235 			continue;
1236 
1237 		insn = 0;
1238 		for (off = 0; off < (unsigned)len; off += ilen) {
1239 			uint64_t ip = start + off;
1240 
1241 			printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1242 			if (ip == end) {
1243 				printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1244 							    &total_cycles);
1245 				if (PRINT_FIELD(SRCCODE))
1246 					printed += print_srccode(thread, x.cpumode, ip);
1247 				break;
1248 			} else {
1249 				ilen = 0;
1250 				printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
1251 						   dump_insn(&x, ip, buffer + off, len - off, &ilen));
1252 				if (ilen == 0)
1253 					break;
1254 				if (PRINT_FIELD(SRCCODE))
1255 					print_srccode(thread, x.cpumode, ip);
1256 				insn++;
1257 			}
1258 		}
1259 		if (off != end - start)
1260 			printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1261 	}
1262 
1263 	/*
1264 	 * Hit the branch? In this case we are already done, and the target
1265 	 * has not been executed yet.
1266 	 */
1267 	if (entries[0].from == sample->ip)
1268 		goto out;
1269 	if (entries[0].flags.abort)
1270 		goto out;
1271 
1272 	/*
1273 	 * Print final block upto sample
1274 	 *
1275 	 * Due to pipeline delays the LBRs might be missing a branch
1276 	 * or two, which can result in very large or negative blocks
1277 	 * between final branch and sample. When this happens just
1278 	 * continue walking after the last TO until we hit a branch.
1279 	 */
1280 	start = entries[0].to;
1281 	end = sample->ip;
1282 	if (end < start) {
1283 		/* Missing jump. Scan 128 bytes for the next branch */
1284 		end = start + 128;
1285 	}
1286 	len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1287 	printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1288 	if (len <= 0) {
1289 		/* Print at least last IP if basic block did not work */
1290 		len = grab_bb(buffer, sample->ip, sample->ip,
1291 			      machine, thread, &x.is64bit, &x.cpumode, false);
1292 		if (len <= 0)
1293 			goto out;
1294 		printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1295 			dump_insn(&x, sample->ip, buffer, len, NULL));
1296 		if (PRINT_FIELD(SRCCODE))
1297 			print_srccode(thread, x.cpumode, sample->ip);
1298 		goto out;
1299 	}
1300 	for (off = 0; off <= end - start; off += ilen) {
1301 		ilen = 0;
1302 		printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
1303 				   dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1304 		if (ilen == 0)
1305 			break;
1306 		if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1307 			/*
1308 			 * Hit a missing branch. Just stop.
1309 			 */
1310 			printed += fprintf(fp, "\t... not reaching sample ...\n");
1311 			break;
1312 		}
1313 		if (PRINT_FIELD(SRCCODE))
1314 			print_srccode(thread, x.cpumode, start + off);
1315 	}
1316 out:
1317 	return printed;
1318 }
1319 
1320 static int perf_sample__fprintf_addr(struct perf_sample *sample,
1321 				     struct thread *thread,
1322 				     struct perf_event_attr *attr, FILE *fp)
1323 {
1324 	struct addr_location al;
1325 	int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1326 
1327 	if (!sample_addr_correlates_sym(attr))
1328 		goto out;
1329 
1330 	thread__resolve(thread, &al, sample);
1331 
1332 	if (PRINT_FIELD(SYM)) {
1333 		printed += fprintf(fp, " ");
1334 		if (PRINT_FIELD(SYMOFFSET))
1335 			printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1336 		else
1337 			printed += symbol__fprintf_symname(al.sym, fp);
1338 	}
1339 
1340 	if (PRINT_FIELD(DSO)) {
1341 		printed += fprintf(fp, " (");
1342 		printed += map__fprintf_dsoname(al.map, fp);
1343 		printed += fprintf(fp, ")");
1344 	}
1345 out:
1346 	return printed;
1347 }
1348 
1349 static const char *resolve_branch_sym(struct perf_sample *sample,
1350 				      struct evsel *evsel,
1351 				      struct thread *thread,
1352 				      struct addr_location *al,
1353 				      struct addr_location *addr_al,
1354 				      u64 *ip)
1355 {
1356 	struct perf_event_attr *attr = &evsel->core.attr;
1357 	const char *name = NULL;
1358 
1359 	if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1360 		if (sample_addr_correlates_sym(attr)) {
1361 			if (!addr_al->thread)
1362 				thread__resolve(thread, addr_al, sample);
1363 			if (addr_al->sym)
1364 				name = addr_al->sym->name;
1365 			else
1366 				*ip = sample->addr;
1367 		} else {
1368 			*ip = sample->addr;
1369 		}
1370 	} else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1371 		if (al->sym)
1372 			name = al->sym->name;
1373 		else
1374 			*ip = sample->ip;
1375 	}
1376 	return name;
1377 }
1378 
1379 static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1380 					   struct evsel *evsel,
1381 					   struct thread *thread,
1382 					   struct addr_location *al,
1383 					   struct addr_location *addr_al,
1384 					   FILE *fp)
1385 {
1386 	struct perf_event_attr *attr = &evsel->core.attr;
1387 	size_t depth = thread_stack__depth(thread, sample->cpu);
1388 	const char *name = NULL;
1389 	static int spacing;
1390 	int len = 0;
1391 	int dlen = 0;
1392 	u64 ip = 0;
1393 
1394 	/*
1395 	 * The 'return' has already been popped off the stack so the depth has
1396 	 * to be adjusted to match the 'call'.
1397 	 */
1398 	if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1399 		depth += 1;
1400 
1401 	name = resolve_branch_sym(sample, evsel, thread, al, addr_al, &ip);
1402 
1403 	if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1404 		dlen += fprintf(fp, "(");
1405 		dlen += map__fprintf_dsoname(al->map, fp);
1406 		dlen += fprintf(fp, ")\t");
1407 	}
1408 
1409 	if (name)
1410 		len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1411 	else if (ip)
1412 		len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1413 
1414 	if (len < 0)
1415 		return len;
1416 
1417 	/*
1418 	 * Try to keep the output length from changing frequently so that the
1419 	 * output lines up more nicely.
1420 	 */
1421 	if (len > spacing || (len && len < spacing - 52))
1422 		spacing = round_up(len + 4, 32);
1423 
1424 	if (len < spacing)
1425 		len += fprintf(fp, "%*s", spacing - len, "");
1426 
1427 	return len + dlen;
1428 }
1429 
1430 __weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1431 			    struct thread *thread __maybe_unused,
1432 			    struct machine *machine __maybe_unused)
1433 {
1434 }
1435 
1436 void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
1437 		       struct machine *machine)
1438 {
1439 	if (sample->insn_len == 0 && native_arch)
1440 		arch_fetch_insn(sample, thread, machine);
1441 }
1442 
1443 static int perf_sample__fprintf_insn(struct perf_sample *sample,
1444 				     struct perf_event_attr *attr,
1445 				     struct thread *thread,
1446 				     struct machine *machine, FILE *fp)
1447 {
1448 	int printed = 0;
1449 
1450 	script_fetch_insn(sample, thread, machine);
1451 
1452 	if (PRINT_FIELD(INSNLEN))
1453 		printed += fprintf(fp, " ilen: %d", sample->insn_len);
1454 	if (PRINT_FIELD(INSN) && sample->insn_len) {
1455 		int i;
1456 
1457 		printed += fprintf(fp, " insn:");
1458 		for (i = 0; i < sample->insn_len; i++)
1459 			printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1460 	}
1461 	if (PRINT_FIELD(BRSTACKINSN))
1462 		printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1463 
1464 	return printed;
1465 }
1466 
1467 static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1468 				    struct perf_event_attr *attr, FILE *fp)
1469 {
1470 	unsigned int ipc;
1471 
1472 	if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1473 		return 0;
1474 
1475 	ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1476 
1477 	return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1478 		       ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1479 }
1480 
1481 static int perf_sample__fprintf_bts(struct perf_sample *sample,
1482 				    struct evsel *evsel,
1483 				    struct thread *thread,
1484 				    struct addr_location *al,
1485 				    struct addr_location *addr_al,
1486 				    struct machine *machine, FILE *fp)
1487 {
1488 	struct perf_event_attr *attr = &evsel->core.attr;
1489 	unsigned int type = output_type(attr->type);
1490 	bool print_srcline_last = false;
1491 	int printed = 0;
1492 
1493 	if (PRINT_FIELD(CALLINDENT))
1494 		printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, addr_al, fp);
1495 
1496 	/* print branch_from information */
1497 	if (PRINT_FIELD(IP)) {
1498 		unsigned int print_opts = output[type].print_ip_opts;
1499 		struct callchain_cursor *cursor = NULL;
1500 
1501 		if (symbol_conf.use_callchain && sample->callchain &&
1502 		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1503 					      sample, NULL, NULL, scripting_max_stack) == 0)
1504 			cursor = &callchain_cursor;
1505 
1506 		if (cursor == NULL) {
1507 			printed += fprintf(fp, " ");
1508 			if (print_opts & EVSEL__PRINT_SRCLINE) {
1509 				print_srcline_last = true;
1510 				print_opts &= ~EVSEL__PRINT_SRCLINE;
1511 			}
1512 		} else
1513 			printed += fprintf(fp, "\n");
1514 
1515 		printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1516 					       symbol_conf.bt_stop_list, fp);
1517 	}
1518 
1519 	/* print branch_to information */
1520 	if (PRINT_FIELD(ADDR) ||
1521 	    ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1522 	     !output[type].user_set)) {
1523 		printed += fprintf(fp, " => ");
1524 		printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1525 	}
1526 
1527 	printed += perf_sample__fprintf_ipc(sample, attr, fp);
1528 
1529 	if (print_srcline_last)
1530 		printed += map__fprintf_srcline(al->map, al->addr, "\n  ", fp);
1531 
1532 	printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1533 	printed += fprintf(fp, "\n");
1534 	if (PRINT_FIELD(SRCCODE)) {
1535 		int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1536 					 &thread->srccode_state);
1537 		if (ret) {
1538 			printed += ret;
1539 			printed += printf("\n");
1540 		}
1541 	}
1542 	return printed;
1543 }
1544 
1545 static struct {
1546 	u32 flags;
1547 	const char *name;
1548 } sample_flags[] = {
1549 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1550 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1551 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1552 	{PERF_IP_FLAG_BRANCH, "jmp"},
1553 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1554 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1555 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1556 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1557 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1558 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC |	PERF_IP_FLAG_INTERRUPT, "hw int"},
1559 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1560 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1561 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1562 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMENTRY, "vmentry"},
1563 	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMEXIT, "vmexit"},
1564 	{0, NULL}
1565 };
1566 
1567 static const char *sample_flags_to_name(u32 flags)
1568 {
1569 	int i;
1570 
1571 	for (i = 0; sample_flags[i].name ; i++) {
1572 		if (sample_flags[i].flags == flags)
1573 			return sample_flags[i].name;
1574 	}
1575 
1576 	return NULL;
1577 }
1578 
1579 int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz)
1580 {
1581 	const char *chars = PERF_IP_FLAG_CHARS;
1582 	const size_t n = strlen(PERF_IP_FLAG_CHARS);
1583 	bool in_tx = flags & PERF_IP_FLAG_IN_TX;
1584 	const char *name = NULL;
1585 	size_t i, pos = 0;
1586 
1587 	name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
1588 	if (name)
1589 		return snprintf(str, sz, "%-15s%4s", name, in_tx ? "(x)" : "");
1590 
1591 	if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1592 		name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_BEGIN));
1593 		if (name)
1594 			return snprintf(str, sz, "tr strt %-7s%4s", name, in_tx ? "(x)" : "");
1595 	}
1596 
1597 	if (flags & PERF_IP_FLAG_TRACE_END) {
1598 		name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_END));
1599 		if (name)
1600 			return snprintf(str, sz, "tr end  %-7s%4s", name, in_tx ? "(x)" : "");
1601 	}
1602 
1603 	for (i = 0; i < n; i++, flags >>= 1) {
1604 		if ((flags & 1) && pos < sz)
1605 			str[pos++] = chars[i];
1606 	}
1607 	for (; i < 32; i++, flags >>= 1) {
1608 		if ((flags & 1) && pos < sz)
1609 			str[pos++] = '?';
1610 	}
1611 	if (pos < sz)
1612 		str[pos] = 0;
1613 
1614 	return pos;
1615 }
1616 
1617 static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1618 {
1619 	char str[SAMPLE_FLAGS_BUF_SIZE];
1620 
1621 	perf_sample__sprintf_flags(flags, str, sizeof(str));
1622 	return fprintf(fp, "  %-19s ", str);
1623 }
1624 
1625 struct printer_data {
1626 	int line_no;
1627 	bool hit_nul;
1628 	bool is_printable;
1629 };
1630 
1631 static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1632 				      unsigned int val,
1633 				      void *extra, FILE *fp)
1634 {
1635 	unsigned char ch = (unsigned char)val;
1636 	struct printer_data *printer_data = extra;
1637 	int printed = 0;
1638 
1639 	switch (op) {
1640 	case BINARY_PRINT_DATA_BEGIN:
1641 		printed += fprintf(fp, "\n");
1642 		break;
1643 	case BINARY_PRINT_LINE_BEGIN:
1644 		printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1645 						        "           ");
1646 		break;
1647 	case BINARY_PRINT_ADDR:
1648 		printed += fprintf(fp, " %04x:", val);
1649 		break;
1650 	case BINARY_PRINT_NUM_DATA:
1651 		printed += fprintf(fp, " %02x", val);
1652 		break;
1653 	case BINARY_PRINT_NUM_PAD:
1654 		printed += fprintf(fp, "   ");
1655 		break;
1656 	case BINARY_PRINT_SEP:
1657 		printed += fprintf(fp, "  ");
1658 		break;
1659 	case BINARY_PRINT_CHAR_DATA:
1660 		if (printer_data->hit_nul && ch)
1661 			printer_data->is_printable = false;
1662 
1663 		if (!isprint(ch)) {
1664 			printed += fprintf(fp, "%c", '.');
1665 
1666 			if (!printer_data->is_printable)
1667 				break;
1668 
1669 			if (ch == '\0')
1670 				printer_data->hit_nul = true;
1671 			else
1672 				printer_data->is_printable = false;
1673 		} else {
1674 			printed += fprintf(fp, "%c", ch);
1675 		}
1676 		break;
1677 	case BINARY_PRINT_CHAR_PAD:
1678 		printed += fprintf(fp, " ");
1679 		break;
1680 	case BINARY_PRINT_LINE_END:
1681 		printed += fprintf(fp, "\n");
1682 		printer_data->line_no++;
1683 		break;
1684 	case BINARY_PRINT_DATA_END:
1685 	default:
1686 		break;
1687 	}
1688 
1689 	return printed;
1690 }
1691 
1692 static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
1693 {
1694 	unsigned int nr_bytes = sample->raw_size;
1695 	struct printer_data printer_data = {0, false, true};
1696 	int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1697 				      sample__fprintf_bpf_output, &printer_data, fp);
1698 
1699 	if (printer_data.is_printable && printer_data.hit_nul)
1700 		printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1701 
1702 	return printed;
1703 }
1704 
1705 static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1706 {
1707 	if (len > 0 && len < spacing)
1708 		return fprintf(fp, "%*s", spacing - len, "");
1709 
1710 	return 0;
1711 }
1712 
1713 static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1714 {
1715 	return perf_sample__fprintf_spacing(len, 34, fp);
1716 }
1717 
1718 static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1719 {
1720 	struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1721 	int len;
1722 
1723 	if (perf_sample__bad_synth_size(sample, *data))
1724 		return 0;
1725 
1726 	len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1727 		     data->ip, le64_to_cpu(data->payload));
1728 	return len + perf_sample__fprintf_pt_spacing(len, fp);
1729 }
1730 
1731 static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1732 {
1733 	struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1734 	int len;
1735 
1736 	if (perf_sample__bad_synth_size(sample, *data))
1737 		return 0;
1738 
1739 	len = fprintf(fp, " hints: %#x extensions: %#x ",
1740 		      data->hints, data->extensions);
1741 	return len + perf_sample__fprintf_pt_spacing(len, fp);
1742 }
1743 
1744 static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1745 {
1746 	struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1747 	int len;
1748 
1749 	if (perf_sample__bad_synth_size(sample, *data))
1750 		return 0;
1751 
1752 	len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1753 		      data->hw, data->cstate, data->subcstate);
1754 	return len + perf_sample__fprintf_pt_spacing(len, fp);
1755 }
1756 
1757 static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1758 {
1759 	struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1760 	int len;
1761 
1762 	if (perf_sample__bad_synth_size(sample, *data))
1763 		return 0;
1764 
1765 	len = fprintf(fp, " IP: %u ", data->ip);
1766 	return len + perf_sample__fprintf_pt_spacing(len, fp);
1767 }
1768 
1769 static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1770 {
1771 	struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1772 	int len;
1773 
1774 	if (perf_sample__bad_synth_size(sample, *data))
1775 		return 0;
1776 
1777 	len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1778 		     data->deepest_cstate, data->last_cstate,
1779 		     data->wake_reason);
1780 	return len + perf_sample__fprintf_pt_spacing(len, fp);
1781 }
1782 
1783 static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1784 {
1785 	struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1786 	unsigned int percent, freq;
1787 	int len;
1788 
1789 	if (perf_sample__bad_synth_size(sample, *data))
1790 		return 0;
1791 
1792 	freq = (le32_to_cpu(data->freq) + 500) / 1000;
1793 	len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1794 	if (data->max_nonturbo) {
1795 		percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1796 		len += fprintf(fp, "(%3u%%) ", percent);
1797 	}
1798 	return len + perf_sample__fprintf_pt_spacing(len, fp);
1799 }
1800 
1801 static int perf_sample__fprintf_synth_psb(struct perf_sample *sample, FILE *fp)
1802 {
1803 	struct perf_synth_intel_psb *data = perf_sample__synth_ptr(sample);
1804 	int len;
1805 
1806 	if (perf_sample__bad_synth_size(sample, *data))
1807 		return 0;
1808 
1809 	len = fprintf(fp, " psb offs: %#" PRIx64, data->offset);
1810 	return len + perf_sample__fprintf_pt_spacing(len, fp);
1811 }
1812 
1813 static int perf_sample__fprintf_synth(struct perf_sample *sample,
1814 				      struct evsel *evsel, FILE *fp)
1815 {
1816 	switch (evsel->core.attr.config) {
1817 	case PERF_SYNTH_INTEL_PTWRITE:
1818 		return perf_sample__fprintf_synth_ptwrite(sample, fp);
1819 	case PERF_SYNTH_INTEL_MWAIT:
1820 		return perf_sample__fprintf_synth_mwait(sample, fp);
1821 	case PERF_SYNTH_INTEL_PWRE:
1822 		return perf_sample__fprintf_synth_pwre(sample, fp);
1823 	case PERF_SYNTH_INTEL_EXSTOP:
1824 		return perf_sample__fprintf_synth_exstop(sample, fp);
1825 	case PERF_SYNTH_INTEL_PWRX:
1826 		return perf_sample__fprintf_synth_pwrx(sample, fp);
1827 	case PERF_SYNTH_INTEL_CBR:
1828 		return perf_sample__fprintf_synth_cbr(sample, fp);
1829 	case PERF_SYNTH_INTEL_PSB:
1830 		return perf_sample__fprintf_synth_psb(sample, fp);
1831 	default:
1832 		break;
1833 	}
1834 
1835 	return 0;
1836 }
1837 
1838 static int evlist__max_name_len(struct evlist *evlist)
1839 {
1840 	struct evsel *evsel;
1841 	int max = 0;
1842 
1843 	evlist__for_each_entry(evlist, evsel) {
1844 		int len = strlen(evsel__name(evsel));
1845 
1846 		max = MAX(len, max);
1847 	}
1848 
1849 	return max;
1850 }
1851 
1852 static int data_src__fprintf(u64 data_src, FILE *fp)
1853 {
1854 	struct mem_info mi = { .data_src.val = data_src };
1855 	char decode[100];
1856 	char out[100];
1857 	static int maxlen;
1858 	int len;
1859 
1860 	perf_script__meminfo_scnprintf(decode, 100, &mi);
1861 
1862 	len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1863 	if (maxlen < len)
1864 		maxlen = len;
1865 
1866 	return fprintf(fp, "%-*s", maxlen, out);
1867 }
1868 
1869 struct metric_ctx {
1870 	struct perf_sample	*sample;
1871 	struct thread		*thread;
1872 	struct evsel	*evsel;
1873 	FILE 			*fp;
1874 };
1875 
1876 static void script_print_metric(struct perf_stat_config *config __maybe_unused,
1877 				void *ctx, const char *color,
1878 			        const char *fmt,
1879 			        const char *unit, double val)
1880 {
1881 	struct metric_ctx *mctx = ctx;
1882 
1883 	if (!fmt)
1884 		return;
1885 	perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1886 				   PERF_RECORD_SAMPLE, mctx->fp);
1887 	fputs("\tmetric: ", mctx->fp);
1888 	if (color)
1889 		color_fprintf(mctx->fp, color, fmt, val);
1890 	else
1891 		printf(fmt, val);
1892 	fprintf(mctx->fp, " %s\n", unit);
1893 }
1894 
1895 static void script_new_line(struct perf_stat_config *config __maybe_unused,
1896 			    void *ctx)
1897 {
1898 	struct metric_ctx *mctx = ctx;
1899 
1900 	perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1901 				   PERF_RECORD_SAMPLE, mctx->fp);
1902 	fputs("\tmetric: ", mctx->fp);
1903 }
1904 
1905 static void perf_sample__fprint_metric(struct perf_script *script,
1906 				       struct thread *thread,
1907 				       struct evsel *evsel,
1908 				       struct perf_sample *sample,
1909 				       FILE *fp)
1910 {
1911 	struct evsel *leader = evsel__leader(evsel);
1912 	struct perf_stat_output_ctx ctx = {
1913 		.print_metric = script_print_metric,
1914 		.new_line = script_new_line,
1915 		.ctx = &(struct metric_ctx) {
1916 				.sample = sample,
1917 				.thread = thread,
1918 				.evsel  = evsel,
1919 				.fp     = fp,
1920 			 },
1921 		.force_header = false,
1922 	};
1923 	struct evsel *ev2;
1924 	u64 val;
1925 
1926 	if (!evsel->stats)
1927 		evlist__alloc_stats(script->session->evlist, false);
1928 	if (evsel_script(leader)->gnum++ == 0)
1929 		perf_stat__reset_shadow_stats();
1930 	val = sample->period * evsel->scale;
1931 	perf_stat__update_shadow_stats(evsel,
1932 				       val,
1933 				       sample->cpu,
1934 				       &rt_stat);
1935 	evsel_script(evsel)->val = val;
1936 	if (evsel_script(leader)->gnum == leader->core.nr_members) {
1937 		for_each_group_member (ev2, leader) {
1938 			perf_stat__print_shadow_stats(&stat_config, ev2,
1939 						      evsel_script(ev2)->val,
1940 						      sample->cpu,
1941 						      &ctx,
1942 						      NULL,
1943 						      &rt_stat);
1944 		}
1945 		evsel_script(leader)->gnum = 0;
1946 	}
1947 }
1948 
1949 static bool show_event(struct perf_sample *sample,
1950 		       struct evsel *evsel,
1951 		       struct thread *thread,
1952 		       struct addr_location *al,
1953 		       struct addr_location *addr_al)
1954 {
1955 	int depth = thread_stack__depth(thread, sample->cpu);
1956 
1957 	if (!symbol_conf.graph_function)
1958 		return true;
1959 
1960 	if (thread->filter) {
1961 		if (depth <= thread->filter_entry_depth) {
1962 			thread->filter = false;
1963 			return false;
1964 		}
1965 		return true;
1966 	} else {
1967 		const char *s = symbol_conf.graph_function;
1968 		u64 ip;
1969 		const char *name = resolve_branch_sym(sample, evsel, thread, al, addr_al,
1970 				&ip);
1971 		unsigned nlen;
1972 
1973 		if (!name)
1974 			return false;
1975 		nlen = strlen(name);
1976 		while (*s) {
1977 			unsigned len = strcspn(s, ",");
1978 			if (nlen == len && !strncmp(name, s, len)) {
1979 				thread->filter = true;
1980 				thread->filter_entry_depth = depth;
1981 				return true;
1982 			}
1983 			s += len;
1984 			if (*s == ',')
1985 				s++;
1986 		}
1987 		return false;
1988 	}
1989 }
1990 
1991 static void process_event(struct perf_script *script,
1992 			  struct perf_sample *sample, struct evsel *evsel,
1993 			  struct addr_location *al,
1994 			  struct addr_location *addr_al,
1995 			  struct machine *machine)
1996 {
1997 	struct thread *thread = al->thread;
1998 	struct perf_event_attr *attr = &evsel->core.attr;
1999 	unsigned int type = output_type(attr->type);
2000 	struct evsel_script *es = evsel->priv;
2001 	FILE *fp = es->fp;
2002 	char str[PAGE_SIZE_NAME_LEN];
2003 
2004 	if (output[type].fields == 0)
2005 		return;
2006 
2007 	++es->samples;
2008 
2009 	perf_sample__fprintf_start(script, sample, thread, evsel,
2010 				   PERF_RECORD_SAMPLE, fp);
2011 
2012 	if (PRINT_FIELD(PERIOD))
2013 		fprintf(fp, "%10" PRIu64 " ", sample->period);
2014 
2015 	if (PRINT_FIELD(EVNAME)) {
2016 		const char *evname = evsel__name(evsel);
2017 
2018 		if (!script->name_width)
2019 			script->name_width = evlist__max_name_len(script->session->evlist);
2020 
2021 		fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
2022 	}
2023 
2024 	if (print_flags)
2025 		perf_sample__fprintf_flags(sample->flags, fp);
2026 
2027 	if (is_bts_event(attr)) {
2028 		perf_sample__fprintf_bts(sample, evsel, thread, al, addr_al, machine, fp);
2029 		return;
2030 	}
2031 
2032 	if (PRINT_FIELD(TRACE) && sample->raw_data) {
2033 		event_format__fprintf(evsel->tp_format, sample->cpu,
2034 				      sample->raw_data, sample->raw_size, fp);
2035 	}
2036 
2037 	if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
2038 		perf_sample__fprintf_synth(sample, evsel, fp);
2039 
2040 	if (PRINT_FIELD(ADDR))
2041 		perf_sample__fprintf_addr(sample, thread, attr, fp);
2042 
2043 	if (PRINT_FIELD(DATA_SRC))
2044 		data_src__fprintf(sample->data_src, fp);
2045 
2046 	if (PRINT_FIELD(WEIGHT))
2047 		fprintf(fp, "%16" PRIu64, sample->weight);
2048 
2049 	if (PRINT_FIELD(INS_LAT))
2050 		fprintf(fp, "%16" PRIu16, sample->ins_lat);
2051 
2052 	if (PRINT_FIELD(IP)) {
2053 		struct callchain_cursor *cursor = NULL;
2054 
2055 		if (script->stitch_lbr)
2056 			al->thread->lbr_stitch_enable = true;
2057 
2058 		if (symbol_conf.use_callchain && sample->callchain &&
2059 		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
2060 					      sample, NULL, NULL, scripting_max_stack) == 0)
2061 			cursor = &callchain_cursor;
2062 
2063 		fputc(cursor ? '\n' : ' ', fp);
2064 		sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
2065 				    symbol_conf.bt_stop_list, fp);
2066 	}
2067 
2068 	if (PRINT_FIELD(IREGS))
2069 		perf_sample__fprintf_iregs(sample, attr, fp);
2070 
2071 	if (PRINT_FIELD(UREGS))
2072 		perf_sample__fprintf_uregs(sample, attr, fp);
2073 
2074 	if (PRINT_FIELD(BRSTACK))
2075 		perf_sample__fprintf_brstack(sample, thread, attr, fp);
2076 	else if (PRINT_FIELD(BRSTACKSYM))
2077 		perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
2078 	else if (PRINT_FIELD(BRSTACKOFF))
2079 		perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2080 
2081 	if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2082 		perf_sample__fprintf_bpf_output(sample, fp);
2083 	perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2084 
2085 	if (PRINT_FIELD(PHYS_ADDR))
2086 		fprintf(fp, "%16" PRIx64, sample->phys_addr);
2087 
2088 	if (PRINT_FIELD(DATA_PAGE_SIZE))
2089 		fprintf(fp, " %s", get_page_size_name(sample->data_page_size, str));
2090 
2091 	if (PRINT_FIELD(CODE_PAGE_SIZE))
2092 		fprintf(fp, " %s", get_page_size_name(sample->code_page_size, str));
2093 
2094 	perf_sample__fprintf_ipc(sample, attr, fp);
2095 
2096 	fprintf(fp, "\n");
2097 
2098 	if (PRINT_FIELD(SRCCODE)) {
2099 		if (map__fprintf_srccode(al->map, al->addr, stdout,
2100 					 &thread->srccode_state))
2101 			printf("\n");
2102 	}
2103 
2104 	if (PRINT_FIELD(METRIC))
2105 		perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2106 
2107 	if (verbose)
2108 		fflush(fp);
2109 }
2110 
2111 static struct scripting_ops	*scripting_ops;
2112 
2113 static void __process_stat(struct evsel *counter, u64 tstamp)
2114 {
2115 	int nthreads = perf_thread_map__nr(counter->core.threads);
2116 	int ncpus = evsel__nr_cpus(counter);
2117 	int cpu, thread;
2118 	static int header_printed;
2119 
2120 	if (counter->core.system_wide)
2121 		nthreads = 1;
2122 
2123 	if (!header_printed) {
2124 		printf("%3s %8s %15s %15s %15s %15s %s\n",
2125 		       "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
2126 		header_printed = 1;
2127 	}
2128 
2129 	for (thread = 0; thread < nthreads; thread++) {
2130 		for (cpu = 0; cpu < ncpus; cpu++) {
2131 			struct perf_counts_values *counts;
2132 
2133 			counts = perf_counts(counter->counts, cpu, thread);
2134 
2135 			printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2136 				counter->core.cpus->map[cpu],
2137 				perf_thread_map__pid(counter->core.threads, thread),
2138 				counts->val,
2139 				counts->ena,
2140 				counts->run,
2141 				tstamp,
2142 				evsel__name(counter));
2143 		}
2144 	}
2145 }
2146 
2147 static void process_stat(struct evsel *counter, u64 tstamp)
2148 {
2149 	if (scripting_ops && scripting_ops->process_stat)
2150 		scripting_ops->process_stat(&stat_config, counter, tstamp);
2151 	else
2152 		__process_stat(counter, tstamp);
2153 }
2154 
2155 static void process_stat_interval(u64 tstamp)
2156 {
2157 	if (scripting_ops && scripting_ops->process_stat_interval)
2158 		scripting_ops->process_stat_interval(tstamp);
2159 }
2160 
2161 static void setup_scripting(void)
2162 {
2163 	setup_perl_scripting();
2164 	setup_python_scripting();
2165 }
2166 
2167 static int flush_scripting(void)
2168 {
2169 	return scripting_ops ? scripting_ops->flush_script() : 0;
2170 }
2171 
2172 static int cleanup_scripting(void)
2173 {
2174 	pr_debug("\nperf script stopped\n");
2175 
2176 	return scripting_ops ? scripting_ops->stop_script() : 0;
2177 }
2178 
2179 static bool filter_cpu(struct perf_sample *sample)
2180 {
2181 	if (cpu_list && sample->cpu != (u32)-1)
2182 		return !test_bit(sample->cpu, cpu_bitmap);
2183 	return false;
2184 }
2185 
2186 static int process_sample_event(struct perf_tool *tool,
2187 				union perf_event *event,
2188 				struct perf_sample *sample,
2189 				struct evsel *evsel,
2190 				struct machine *machine)
2191 {
2192 	struct perf_script *scr = container_of(tool, struct perf_script, tool);
2193 	struct addr_location al;
2194 	struct addr_location addr_al;
2195 	int ret = 0;
2196 
2197 	/* Set thread to NULL to indicate addr_al and al are not initialized */
2198 	addr_al.thread = NULL;
2199 	al.thread = NULL;
2200 
2201 	ret = dlfilter__filter_event_early(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2202 	if (ret) {
2203 		if (ret > 0)
2204 			ret = 0;
2205 		goto out_put;
2206 	}
2207 
2208 	if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2209 					  sample->time)) {
2210 		goto out_put;
2211 	}
2212 
2213 	if (debug_mode) {
2214 		if (sample->time < last_timestamp) {
2215 			pr_err("Samples misordered, previous: %" PRIu64
2216 				" this: %" PRIu64 "\n", last_timestamp,
2217 				sample->time);
2218 			nr_unordered++;
2219 		}
2220 		last_timestamp = sample->time;
2221 		goto out_put;
2222 	}
2223 
2224 	if (filter_cpu(sample))
2225 		goto out_put;
2226 
2227 	if (!al.thread && machine__resolve(machine, &al, sample) < 0) {
2228 		pr_err("problem processing %d event, skipping it.\n",
2229 		       event->header.type);
2230 		ret = -1;
2231 		goto out_put;
2232 	}
2233 
2234 	if (al.filtered)
2235 		goto out_put;
2236 
2237 	if (!show_event(sample, evsel, al.thread, &al, &addr_al))
2238 		goto out_put;
2239 
2240 	if (evswitch__discard(&scr->evswitch, evsel))
2241 		goto out_put;
2242 
2243 	ret = dlfilter__filter_event(dlfilter, event, sample, evsel, machine, &al, &addr_al);
2244 	if (ret) {
2245 		if (ret > 0)
2246 			ret = 0;
2247 		goto out_put;
2248 	}
2249 
2250 	if (scripting_ops) {
2251 		struct addr_location *addr_al_ptr = NULL;
2252 
2253 		if ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
2254 		    sample_addr_correlates_sym(&evsel->core.attr)) {
2255 			if (!addr_al.thread)
2256 				thread__resolve(al.thread, &addr_al, sample);
2257 			addr_al_ptr = &addr_al;
2258 		}
2259 		scripting_ops->process_event(event, sample, evsel, &al, addr_al_ptr);
2260 	} else {
2261 		process_event(scr, sample, evsel, &al, &addr_al, machine);
2262 	}
2263 
2264 out_put:
2265 	if (al.thread)
2266 		addr_location__put(&al);
2267 	return ret;
2268 }
2269 
2270 static int process_attr(struct perf_tool *tool, union perf_event *event,
2271 			struct evlist **pevlist)
2272 {
2273 	struct perf_script *scr = container_of(tool, struct perf_script, tool);
2274 	struct evlist *evlist;
2275 	struct evsel *evsel, *pos;
2276 	u64 sample_type;
2277 	int err;
2278 	static struct evsel_script *es;
2279 
2280 	err = perf_event__process_attr(tool, event, pevlist);
2281 	if (err)
2282 		return err;
2283 
2284 	evlist = *pevlist;
2285 	evsel = evlist__last(*pevlist);
2286 
2287 	if (!evsel->priv) {
2288 		if (scr->per_event_dump) {
2289 			evsel->priv = evsel_script__new(evsel, scr->session->data);
2290 		} else {
2291 			es = zalloc(sizeof(*es));
2292 			if (!es)
2293 				return -ENOMEM;
2294 			es->fp = stdout;
2295 			evsel->priv = es;
2296 		}
2297 	}
2298 
2299 	if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2300 	    evsel->core.attr.type != PERF_TYPE_SYNTH)
2301 		return 0;
2302 
2303 	evlist__for_each_entry(evlist, pos) {
2304 		if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2305 			return 0;
2306 	}
2307 
2308 	if (evsel->core.attr.sample_type) {
2309 		err = evsel__check_attr(evsel, scr->session);
2310 		if (err)
2311 			return err;
2312 	}
2313 
2314 	/*
2315 	 * Check if we need to enable callchains based
2316 	 * on events sample_type.
2317 	 */
2318 	sample_type = evlist__combined_sample_type(evlist);
2319 	callchain_param_setup(sample_type);
2320 
2321 	/* Enable fields for callchain entries */
2322 	if (symbol_conf.use_callchain &&
2323 	    (sample_type & PERF_SAMPLE_CALLCHAIN ||
2324 	     sample_type & PERF_SAMPLE_BRANCH_STACK ||
2325 	     (sample_type & PERF_SAMPLE_REGS_USER &&
2326 	      sample_type & PERF_SAMPLE_STACK_USER))) {
2327 		int type = output_type(evsel->core.attr.type);
2328 
2329 		if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2330 			output[type].fields |= PERF_OUTPUT_IP;
2331 		if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2332 			output[type].fields |= PERF_OUTPUT_SYM;
2333 	}
2334 	set_print_ip_opts(&evsel->core.attr);
2335 	return 0;
2336 }
2337 
2338 static int print_event_with_time(struct perf_tool *tool,
2339 				 union perf_event *event,
2340 				 struct perf_sample *sample,
2341 				 struct machine *machine,
2342 				 pid_t pid, pid_t tid, u64 timestamp)
2343 {
2344 	struct perf_script *script = container_of(tool, struct perf_script, tool);
2345 	struct perf_session *session = script->session;
2346 	struct evsel *evsel = evlist__id2evsel(session->evlist, sample->id);
2347 	struct thread *thread = NULL;
2348 
2349 	if (evsel && !evsel->core.attr.sample_id_all) {
2350 		sample->cpu = 0;
2351 		sample->time = timestamp;
2352 		sample->pid = pid;
2353 		sample->tid = tid;
2354 	}
2355 
2356 	if (filter_cpu(sample))
2357 		return 0;
2358 
2359 	if (tid != -1)
2360 		thread = machine__findnew_thread(machine, pid, tid);
2361 
2362 	if (evsel) {
2363 		perf_sample__fprintf_start(script, sample, thread, evsel,
2364 					   event->header.type, stdout);
2365 	}
2366 
2367 	perf_event__fprintf(event, machine, stdout);
2368 
2369 	thread__put(thread);
2370 
2371 	return 0;
2372 }
2373 
2374 static int print_event(struct perf_tool *tool, union perf_event *event,
2375 		       struct perf_sample *sample, struct machine *machine,
2376 		       pid_t pid, pid_t tid)
2377 {
2378 	return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2379 }
2380 
2381 static int process_comm_event(struct perf_tool *tool,
2382 			      union perf_event *event,
2383 			      struct perf_sample *sample,
2384 			      struct machine *machine)
2385 {
2386 	if (perf_event__process_comm(tool, event, sample, machine) < 0)
2387 		return -1;
2388 
2389 	return print_event(tool, event, sample, machine, event->comm.pid,
2390 			   event->comm.tid);
2391 }
2392 
2393 static int process_namespaces_event(struct perf_tool *tool,
2394 				    union perf_event *event,
2395 				    struct perf_sample *sample,
2396 				    struct machine *machine)
2397 {
2398 	if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2399 		return -1;
2400 
2401 	return print_event(tool, event, sample, machine, event->namespaces.pid,
2402 			   event->namespaces.tid);
2403 }
2404 
2405 static int process_cgroup_event(struct perf_tool *tool,
2406 				union perf_event *event,
2407 				struct perf_sample *sample,
2408 				struct machine *machine)
2409 {
2410 	if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2411 		return -1;
2412 
2413 	return print_event(tool, event, sample, machine, sample->pid,
2414 			    sample->tid);
2415 }
2416 
2417 static int process_fork_event(struct perf_tool *tool,
2418 			      union perf_event *event,
2419 			      struct perf_sample *sample,
2420 			      struct machine *machine)
2421 {
2422 	if (perf_event__process_fork(tool, event, sample, machine) < 0)
2423 		return -1;
2424 
2425 	return print_event_with_time(tool, event, sample, machine,
2426 				     event->fork.pid, event->fork.tid,
2427 				     event->fork.time);
2428 }
2429 static int process_exit_event(struct perf_tool *tool,
2430 			      union perf_event *event,
2431 			      struct perf_sample *sample,
2432 			      struct machine *machine)
2433 {
2434 	/* Print before 'exit' deletes anything */
2435 	if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2436 				  event->fork.tid, event->fork.time))
2437 		return -1;
2438 
2439 	return perf_event__process_exit(tool, event, sample, machine);
2440 }
2441 
2442 static int process_mmap_event(struct perf_tool *tool,
2443 			      union perf_event *event,
2444 			      struct perf_sample *sample,
2445 			      struct machine *machine)
2446 {
2447 	if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2448 		return -1;
2449 
2450 	return print_event(tool, event, sample, machine, event->mmap.pid,
2451 			   event->mmap.tid);
2452 }
2453 
2454 static int process_mmap2_event(struct perf_tool *tool,
2455 			      union perf_event *event,
2456 			      struct perf_sample *sample,
2457 			      struct machine *machine)
2458 {
2459 	if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2460 		return -1;
2461 
2462 	return print_event(tool, event, sample, machine, event->mmap2.pid,
2463 			   event->mmap2.tid);
2464 }
2465 
2466 static int process_switch_event(struct perf_tool *tool,
2467 				union perf_event *event,
2468 				struct perf_sample *sample,
2469 				struct machine *machine)
2470 {
2471 	struct perf_script *script = container_of(tool, struct perf_script, tool);
2472 
2473 	if (perf_event__process_switch(tool, event, sample, machine) < 0)
2474 		return -1;
2475 
2476 	if (scripting_ops && scripting_ops->process_switch)
2477 		scripting_ops->process_switch(event, sample, machine);
2478 
2479 	if (!script->show_switch_events)
2480 		return 0;
2481 
2482 	return print_event(tool, event, sample, machine, sample->pid,
2483 			   sample->tid);
2484 }
2485 
2486 static int process_auxtrace_error(struct perf_session *session,
2487 				  union perf_event *event)
2488 {
2489 	if (scripting_ops && scripting_ops->process_auxtrace_error) {
2490 		scripting_ops->process_auxtrace_error(session, event);
2491 		return 0;
2492 	}
2493 
2494 	return perf_event__process_auxtrace_error(session, event);
2495 }
2496 
2497 static int
2498 process_lost_event(struct perf_tool *tool,
2499 		   union perf_event *event,
2500 		   struct perf_sample *sample,
2501 		   struct machine *machine)
2502 {
2503 	return print_event(tool, event, sample, machine, sample->pid,
2504 			   sample->tid);
2505 }
2506 
2507 static int
2508 process_throttle_event(struct perf_tool *tool __maybe_unused,
2509 		       union perf_event *event,
2510 		       struct perf_sample *sample,
2511 		       struct machine *machine)
2512 {
2513 	if (scripting_ops && scripting_ops->process_throttle)
2514 		scripting_ops->process_throttle(event, sample, machine);
2515 	return 0;
2516 }
2517 
2518 static int
2519 process_finished_round_event(struct perf_tool *tool __maybe_unused,
2520 			     union perf_event *event,
2521 			     struct ordered_events *oe __maybe_unused)
2522 
2523 {
2524 	perf_event__fprintf(event, NULL, stdout);
2525 	return 0;
2526 }
2527 
2528 static int
2529 process_bpf_events(struct perf_tool *tool __maybe_unused,
2530 		   union perf_event *event,
2531 		   struct perf_sample *sample,
2532 		   struct machine *machine)
2533 {
2534 	if (machine__process_ksymbol(machine, event, sample) < 0)
2535 		return -1;
2536 
2537 	return print_event(tool, event, sample, machine, sample->pid,
2538 			   sample->tid);
2539 }
2540 
2541 static int process_text_poke_events(struct perf_tool *tool,
2542 				    union perf_event *event,
2543 				    struct perf_sample *sample,
2544 				    struct machine *machine)
2545 {
2546 	if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
2547 		return -1;
2548 
2549 	return print_event(tool, event, sample, machine, sample->pid,
2550 			   sample->tid);
2551 }
2552 
2553 static void sig_handler(int sig __maybe_unused)
2554 {
2555 	session_done = 1;
2556 }
2557 
2558 static void perf_script__fclose_per_event_dump(struct perf_script *script)
2559 {
2560 	struct evlist *evlist = script->session->evlist;
2561 	struct evsel *evsel;
2562 
2563 	evlist__for_each_entry(evlist, evsel) {
2564 		if (!evsel->priv)
2565 			break;
2566 		evsel_script__delete(evsel->priv);
2567 		evsel->priv = NULL;
2568 	}
2569 }
2570 
2571 static int perf_script__fopen_per_event_dump(struct perf_script *script)
2572 {
2573 	struct evsel *evsel;
2574 
2575 	evlist__for_each_entry(script->session->evlist, evsel) {
2576 		/*
2577 		 * Already setup? I.e. we may be called twice in cases like
2578 		 * Intel PT, one for the intel_pt// and dummy events, then
2579 		 * for the evsels synthesized from the auxtrace info.
2580 		 *
2581 		 * Ses perf_script__process_auxtrace_info.
2582 		 */
2583 		if (evsel->priv != NULL)
2584 			continue;
2585 
2586 		evsel->priv = evsel_script__new(evsel, script->session->data);
2587 		if (evsel->priv == NULL)
2588 			goto out_err_fclose;
2589 	}
2590 
2591 	return 0;
2592 
2593 out_err_fclose:
2594 	perf_script__fclose_per_event_dump(script);
2595 	return -1;
2596 }
2597 
2598 static int perf_script__setup_per_event_dump(struct perf_script *script)
2599 {
2600 	struct evsel *evsel;
2601 	static struct evsel_script es_stdout;
2602 
2603 	if (script->per_event_dump)
2604 		return perf_script__fopen_per_event_dump(script);
2605 
2606 	es_stdout.fp = stdout;
2607 
2608 	evlist__for_each_entry(script->session->evlist, evsel)
2609 		evsel->priv = &es_stdout;
2610 
2611 	return 0;
2612 }
2613 
2614 static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2615 {
2616 	struct evsel *evsel;
2617 
2618 	evlist__for_each_entry(script->session->evlist, evsel) {
2619 		struct evsel_script *es = evsel->priv;
2620 
2621 		evsel_script__fprintf(es, stdout);
2622 		evsel_script__delete(es);
2623 		evsel->priv = NULL;
2624 	}
2625 }
2626 
2627 static void perf_script__exit(struct perf_script *script)
2628 {
2629 	perf_thread_map__put(script->threads);
2630 	perf_cpu_map__put(script->cpus);
2631 }
2632 
2633 static int __cmd_script(struct perf_script *script)
2634 {
2635 	int ret;
2636 
2637 	signal(SIGINT, sig_handler);
2638 
2639 	perf_stat__init_shadow_stats();
2640 
2641 	/* override event processing functions */
2642 	if (script->show_task_events) {
2643 		script->tool.comm = process_comm_event;
2644 		script->tool.fork = process_fork_event;
2645 		script->tool.exit = process_exit_event;
2646 	}
2647 	if (script->show_mmap_events) {
2648 		script->tool.mmap = process_mmap_event;
2649 		script->tool.mmap2 = process_mmap2_event;
2650 	}
2651 	if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2652 		script->tool.context_switch = process_switch_event;
2653 	if (scripting_ops && scripting_ops->process_auxtrace_error)
2654 		script->tool.auxtrace_error = process_auxtrace_error;
2655 	if (script->show_namespace_events)
2656 		script->tool.namespaces = process_namespaces_event;
2657 	if (script->show_cgroup_events)
2658 		script->tool.cgroup = process_cgroup_event;
2659 	if (script->show_lost_events)
2660 		script->tool.lost = process_lost_event;
2661 	if (script->show_round_events) {
2662 		script->tool.ordered_events = false;
2663 		script->tool.finished_round = process_finished_round_event;
2664 	}
2665 	if (script->show_bpf_events) {
2666 		script->tool.ksymbol = process_bpf_events;
2667 		script->tool.bpf     = process_bpf_events;
2668 	}
2669 	if (script->show_text_poke_events) {
2670 		script->tool.ksymbol   = process_bpf_events;
2671 		script->tool.text_poke = process_text_poke_events;
2672 	}
2673 
2674 	if (perf_script__setup_per_event_dump(script)) {
2675 		pr_err("Couldn't create the per event dump files\n");
2676 		return -1;
2677 	}
2678 
2679 	ret = perf_session__process_events(script->session);
2680 
2681 	if (script->per_event_dump)
2682 		perf_script__exit_per_event_dump_stats(script);
2683 
2684 	if (debug_mode)
2685 		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2686 
2687 	return ret;
2688 }
2689 
2690 struct script_spec {
2691 	struct list_head	node;
2692 	struct scripting_ops	*ops;
2693 	char			spec[];
2694 };
2695 
2696 static LIST_HEAD(script_specs);
2697 
2698 static struct script_spec *script_spec__new(const char *spec,
2699 					    struct scripting_ops *ops)
2700 {
2701 	struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2702 
2703 	if (s != NULL) {
2704 		strcpy(s->spec, spec);
2705 		s->ops = ops;
2706 	}
2707 
2708 	return s;
2709 }
2710 
2711 static void script_spec__add(struct script_spec *s)
2712 {
2713 	list_add_tail(&s->node, &script_specs);
2714 }
2715 
2716 static struct script_spec *script_spec__find(const char *spec)
2717 {
2718 	struct script_spec *s;
2719 
2720 	list_for_each_entry(s, &script_specs, node)
2721 		if (strcasecmp(s->spec, spec) == 0)
2722 			return s;
2723 	return NULL;
2724 }
2725 
2726 int script_spec_register(const char *spec, struct scripting_ops *ops)
2727 {
2728 	struct script_spec *s;
2729 
2730 	s = script_spec__find(spec);
2731 	if (s)
2732 		return -1;
2733 
2734 	s = script_spec__new(spec, ops);
2735 	if (!s)
2736 		return -1;
2737 	else
2738 		script_spec__add(s);
2739 
2740 	return 0;
2741 }
2742 
2743 static struct scripting_ops *script_spec__lookup(const char *spec)
2744 {
2745 	struct script_spec *s = script_spec__find(spec);
2746 	if (!s)
2747 		return NULL;
2748 
2749 	return s->ops;
2750 }
2751 
2752 static void list_available_languages(void)
2753 {
2754 	struct script_spec *s;
2755 
2756 	fprintf(stderr, "\n");
2757 	fprintf(stderr, "Scripting language extensions (used in "
2758 		"perf script -s [spec:]script.[spec]):\n\n");
2759 
2760 	list_for_each_entry(s, &script_specs, node)
2761 		fprintf(stderr, "  %-42s [%s]\n", s->spec, s->ops->name);
2762 
2763 	fprintf(stderr, "\n");
2764 }
2765 
2766 /* Find script file relative to current directory or exec path */
2767 static char *find_script(const char *script)
2768 {
2769 	char path[PATH_MAX];
2770 
2771 	if (!scripting_ops) {
2772 		const char *ext = strrchr(script, '.');
2773 
2774 		if (!ext)
2775 			return NULL;
2776 
2777 		scripting_ops = script_spec__lookup(++ext);
2778 		if (!scripting_ops)
2779 			return NULL;
2780 	}
2781 
2782 	if (access(script, R_OK)) {
2783 		char *exec_path = get_argv_exec_path();
2784 
2785 		if (!exec_path)
2786 			return NULL;
2787 		snprintf(path, sizeof(path), "%s/scripts/%s/%s",
2788 			 exec_path, scripting_ops->dirname, script);
2789 		free(exec_path);
2790 		script = path;
2791 		if (access(script, R_OK))
2792 			return NULL;
2793 	}
2794 	return strdup(script);
2795 }
2796 
2797 static int parse_scriptname(const struct option *opt __maybe_unused,
2798 			    const char *str, int unset __maybe_unused)
2799 {
2800 	char spec[PATH_MAX];
2801 	const char *script, *ext;
2802 	int len;
2803 
2804 	if (strcmp(str, "lang") == 0) {
2805 		list_available_languages();
2806 		exit(0);
2807 	}
2808 
2809 	script = strchr(str, ':');
2810 	if (script) {
2811 		len = script - str;
2812 		if (len >= PATH_MAX) {
2813 			fprintf(stderr, "invalid language specifier");
2814 			return -1;
2815 		}
2816 		strncpy(spec, str, len);
2817 		spec[len] = '\0';
2818 		scripting_ops = script_spec__lookup(spec);
2819 		if (!scripting_ops) {
2820 			fprintf(stderr, "invalid language specifier");
2821 			return -1;
2822 		}
2823 		script++;
2824 	} else {
2825 		script = str;
2826 		ext = strrchr(script, '.');
2827 		if (!ext) {
2828 			fprintf(stderr, "invalid script extension");
2829 			return -1;
2830 		}
2831 		scripting_ops = script_spec__lookup(++ext);
2832 		if (!scripting_ops) {
2833 			fprintf(stderr, "invalid script extension");
2834 			return -1;
2835 		}
2836 	}
2837 
2838 	script_name = find_script(script);
2839 	if (!script_name)
2840 		script_name = strdup(script);
2841 
2842 	return 0;
2843 }
2844 
2845 static int parse_output_fields(const struct option *opt __maybe_unused,
2846 			    const char *arg, int unset __maybe_unused)
2847 {
2848 	char *tok, *strtok_saveptr = NULL;
2849 	int i, imax = ARRAY_SIZE(all_output_options);
2850 	int j;
2851 	int rc = 0;
2852 	char *str = strdup(arg);
2853 	int type = -1;
2854 	enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2855 
2856 	if (!str)
2857 		return -ENOMEM;
2858 
2859 	/* first word can state for which event type the user is specifying
2860 	 * the fields. If no type exists, the specified fields apply to all
2861 	 * event types found in the file minus the invalid fields for a type.
2862 	 */
2863 	tok = strchr(str, ':');
2864 	if (tok) {
2865 		*tok = '\0';
2866 		tok++;
2867 		if (!strcmp(str, "hw"))
2868 			type = PERF_TYPE_HARDWARE;
2869 		else if (!strcmp(str, "sw"))
2870 			type = PERF_TYPE_SOFTWARE;
2871 		else if (!strcmp(str, "trace"))
2872 			type = PERF_TYPE_TRACEPOINT;
2873 		else if (!strcmp(str, "raw"))
2874 			type = PERF_TYPE_RAW;
2875 		else if (!strcmp(str, "break"))
2876 			type = PERF_TYPE_BREAKPOINT;
2877 		else if (!strcmp(str, "synth"))
2878 			type = OUTPUT_TYPE_SYNTH;
2879 		else {
2880 			fprintf(stderr, "Invalid event type in field string.\n");
2881 			rc = -EINVAL;
2882 			goto out;
2883 		}
2884 
2885 		if (output[type].user_set)
2886 			pr_warning("Overriding previous field request for %s events.\n",
2887 				   event_type(type));
2888 
2889 		/* Don't override defaults for +- */
2890 		if (strchr(tok, '+') || strchr(tok, '-'))
2891 			goto parse;
2892 
2893 		output[type].fields = 0;
2894 		output[type].user_set = true;
2895 		output[type].wildcard_set = false;
2896 
2897 	} else {
2898 		tok = str;
2899 		if (strlen(str) == 0) {
2900 			fprintf(stderr,
2901 				"Cannot set fields to 'none' for all event types.\n");
2902 			rc = -EINVAL;
2903 			goto out;
2904 		}
2905 
2906 		/* Don't override defaults for +- */
2907 		if (strchr(str, '+') || strchr(str, '-'))
2908 			goto parse;
2909 
2910 		if (output_set_by_user())
2911 			pr_warning("Overriding previous field request for all events.\n");
2912 
2913 		for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2914 			output[j].fields = 0;
2915 			output[j].user_set = true;
2916 			output[j].wildcard_set = true;
2917 		}
2918 	}
2919 
2920 parse:
2921 	for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2922 		if (*tok == '+') {
2923 			if (change == SET)
2924 				goto out_badmix;
2925 			change = ADD;
2926 			tok++;
2927 		} else if (*tok == '-') {
2928 			if (change == SET)
2929 				goto out_badmix;
2930 			change = REMOVE;
2931 			tok++;
2932 		} else {
2933 			if (change != SET && change != DEFAULT)
2934 				goto out_badmix;
2935 			change = SET;
2936 		}
2937 
2938 		for (i = 0; i < imax; ++i) {
2939 			if (strcmp(tok, all_output_options[i].str) == 0)
2940 				break;
2941 		}
2942 		if (i == imax && strcmp(tok, "flags") == 0) {
2943 			print_flags = change != REMOVE;
2944 			continue;
2945 		}
2946 		if (i == imax) {
2947 			fprintf(stderr, "Invalid field requested.\n");
2948 			rc = -EINVAL;
2949 			goto out;
2950 		}
2951 
2952 		if (type == -1) {
2953 			/* add user option to all events types for
2954 			 * which it is valid
2955 			 */
2956 			for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2957 				if (output[j].invalid_fields & all_output_options[i].field) {
2958 					pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
2959 						   all_output_options[i].str, event_type(j));
2960 				} else {
2961 					if (change == REMOVE) {
2962 						output[j].fields &= ~all_output_options[i].field;
2963 						output[j].user_set_fields &= ~all_output_options[i].field;
2964 						output[j].user_unset_fields |= all_output_options[i].field;
2965 					} else {
2966 						output[j].fields |= all_output_options[i].field;
2967 						output[j].user_set_fields |= all_output_options[i].field;
2968 						output[j].user_unset_fields &= ~all_output_options[i].field;
2969 					}
2970 					output[j].user_set = true;
2971 					output[j].wildcard_set = true;
2972 				}
2973 			}
2974 		} else {
2975 			if (output[type].invalid_fields & all_output_options[i].field) {
2976 				fprintf(stderr, "\'%s\' not valid for %s events.\n",
2977 					 all_output_options[i].str, event_type(type));
2978 
2979 				rc = -EINVAL;
2980 				goto out;
2981 			}
2982 			if (change == REMOVE)
2983 				output[type].fields &= ~all_output_options[i].field;
2984 			else
2985 				output[type].fields |= all_output_options[i].field;
2986 			output[type].user_set = true;
2987 			output[type].wildcard_set = true;
2988 		}
2989 	}
2990 
2991 	if (type >= 0) {
2992 		if (output[type].fields == 0) {
2993 			pr_debug("No fields requested for %s type. "
2994 				 "Events will not be displayed.\n", event_type(type));
2995 		}
2996 	}
2997 	goto out;
2998 
2999 out_badmix:
3000 	fprintf(stderr, "Cannot mix +-field with overridden fields\n");
3001 	rc = -EINVAL;
3002 out:
3003 	free(str);
3004 	return rc;
3005 }
3006 
3007 #define for_each_lang(scripts_path, scripts_dir, lang_dirent)		\
3008 	while ((lang_dirent = readdir(scripts_dir)) != NULL)		\
3009 		if ((lang_dirent->d_type == DT_DIR ||			\
3010 		     (lang_dirent->d_type == DT_UNKNOWN &&		\
3011 		      is_directory(scripts_path, lang_dirent))) &&	\
3012 		    (strcmp(lang_dirent->d_name, ".")) &&		\
3013 		    (strcmp(lang_dirent->d_name, "..")))
3014 
3015 #define for_each_script(lang_path, lang_dir, script_dirent)		\
3016 	while ((script_dirent = readdir(lang_dir)) != NULL)		\
3017 		if (script_dirent->d_type != DT_DIR &&			\
3018 		    (script_dirent->d_type != DT_UNKNOWN ||		\
3019 		     !is_directory(lang_path, script_dirent)))
3020 
3021 
3022 #define RECORD_SUFFIX			"-record"
3023 #define REPORT_SUFFIX			"-report"
3024 
3025 struct script_desc {
3026 	struct list_head	node;
3027 	char			*name;
3028 	char			*half_liner;
3029 	char			*args;
3030 };
3031 
3032 static LIST_HEAD(script_descs);
3033 
3034 static struct script_desc *script_desc__new(const char *name)
3035 {
3036 	struct script_desc *s = zalloc(sizeof(*s));
3037 
3038 	if (s != NULL && name)
3039 		s->name = strdup(name);
3040 
3041 	return s;
3042 }
3043 
3044 static void script_desc__delete(struct script_desc *s)
3045 {
3046 	zfree(&s->name);
3047 	zfree(&s->half_liner);
3048 	zfree(&s->args);
3049 	free(s);
3050 }
3051 
3052 static void script_desc__add(struct script_desc *s)
3053 {
3054 	list_add_tail(&s->node, &script_descs);
3055 }
3056 
3057 static struct script_desc *script_desc__find(const char *name)
3058 {
3059 	struct script_desc *s;
3060 
3061 	list_for_each_entry(s, &script_descs, node)
3062 		if (strcasecmp(s->name, name) == 0)
3063 			return s;
3064 	return NULL;
3065 }
3066 
3067 static struct script_desc *script_desc__findnew(const char *name)
3068 {
3069 	struct script_desc *s = script_desc__find(name);
3070 
3071 	if (s)
3072 		return s;
3073 
3074 	s = script_desc__new(name);
3075 	if (!s)
3076 		return NULL;
3077 
3078 	script_desc__add(s);
3079 
3080 	return s;
3081 }
3082 
3083 static const char *ends_with(const char *str, const char *suffix)
3084 {
3085 	size_t suffix_len = strlen(suffix);
3086 	const char *p = str;
3087 
3088 	if (strlen(str) > suffix_len) {
3089 		p = str + strlen(str) - suffix_len;
3090 		if (!strncmp(p, suffix, suffix_len))
3091 			return p;
3092 	}
3093 
3094 	return NULL;
3095 }
3096 
3097 static int read_script_info(struct script_desc *desc, const char *filename)
3098 {
3099 	char line[BUFSIZ], *p;
3100 	FILE *fp;
3101 
3102 	fp = fopen(filename, "r");
3103 	if (!fp)
3104 		return -1;
3105 
3106 	while (fgets(line, sizeof(line), fp)) {
3107 		p = skip_spaces(line);
3108 		if (strlen(p) == 0)
3109 			continue;
3110 		if (*p != '#')
3111 			continue;
3112 		p++;
3113 		if (strlen(p) && *p == '!')
3114 			continue;
3115 
3116 		p = skip_spaces(p);
3117 		if (strlen(p) && p[strlen(p) - 1] == '\n')
3118 			p[strlen(p) - 1] = '\0';
3119 
3120 		if (!strncmp(p, "description:", strlen("description:"))) {
3121 			p += strlen("description:");
3122 			desc->half_liner = strdup(skip_spaces(p));
3123 			continue;
3124 		}
3125 
3126 		if (!strncmp(p, "args:", strlen("args:"))) {
3127 			p += strlen("args:");
3128 			desc->args = strdup(skip_spaces(p));
3129 			continue;
3130 		}
3131 	}
3132 
3133 	fclose(fp);
3134 
3135 	return 0;
3136 }
3137 
3138 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
3139 {
3140 	char *script_root, *str;
3141 
3142 	script_root = strdup(script_dirent->d_name);
3143 	if (!script_root)
3144 		return NULL;
3145 
3146 	str = (char *)ends_with(script_root, suffix);
3147 	if (!str) {
3148 		free(script_root);
3149 		return NULL;
3150 	}
3151 
3152 	*str = '\0';
3153 	return script_root;
3154 }
3155 
3156 static int list_available_scripts(const struct option *opt __maybe_unused,
3157 				  const char *s __maybe_unused,
3158 				  int unset __maybe_unused)
3159 {
3160 	struct dirent *script_dirent, *lang_dirent;
3161 	char scripts_path[MAXPATHLEN];
3162 	DIR *scripts_dir, *lang_dir;
3163 	char script_path[MAXPATHLEN];
3164 	char lang_path[MAXPATHLEN];
3165 	struct script_desc *desc;
3166 	char first_half[BUFSIZ];
3167 	char *script_root;
3168 
3169 	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3170 
3171 	scripts_dir = opendir(scripts_path);
3172 	if (!scripts_dir) {
3173 		fprintf(stdout,
3174 			"open(%s) failed.\n"
3175 			"Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
3176 			scripts_path);
3177 		exit(-1);
3178 	}
3179 
3180 	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3181 		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3182 			  lang_dirent->d_name);
3183 		lang_dir = opendir(lang_path);
3184 		if (!lang_dir)
3185 			continue;
3186 
3187 		for_each_script(lang_path, lang_dir, script_dirent) {
3188 			script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3189 			if (script_root) {
3190 				desc = script_desc__findnew(script_root);
3191 				scnprintf(script_path, MAXPATHLEN, "%s/%s",
3192 					  lang_path, script_dirent->d_name);
3193 				read_script_info(desc, script_path);
3194 				free(script_root);
3195 			}
3196 		}
3197 	}
3198 
3199 	fprintf(stdout, "List of available trace scripts:\n");
3200 	list_for_each_entry(desc, &script_descs, node) {
3201 		sprintf(first_half, "%s %s", desc->name,
3202 			desc->args ? desc->args : "");
3203 		fprintf(stdout, "  %-36s %s\n", first_half,
3204 			desc->half_liner ? desc->half_liner : "");
3205 	}
3206 
3207 	exit(0);
3208 }
3209 
3210 static int add_dlarg(const struct option *opt __maybe_unused,
3211 		     const char *s, int unset __maybe_unused)
3212 {
3213 	char *arg = strdup(s);
3214 	void *a;
3215 
3216 	if (!arg)
3217 		return -1;
3218 
3219 	a = realloc(dlargv, sizeof(dlargv[0]) * (dlargc + 1));
3220 	if (!a) {
3221 		free(arg);
3222 		return -1;
3223 	}
3224 
3225 	dlargv = a;
3226 	dlargv[dlargc++] = arg;
3227 
3228 	return 0;
3229 }
3230 
3231 static void free_dlarg(void)
3232 {
3233 	while (dlargc--)
3234 		free(dlargv[dlargc]);
3235 	free(dlargv);
3236 }
3237 
3238 /*
3239  * Some scripts specify the required events in their "xxx-record" file,
3240  * this function will check if the events in perf.data match those
3241  * mentioned in the "xxx-record".
3242  *
3243  * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3244  * which is covered well now. And new parsing code should be added to
3245  * cover the future complex formats like event groups etc.
3246  */
3247 static int check_ev_match(char *dir_name, char *scriptname,
3248 			struct perf_session *session)
3249 {
3250 	char filename[MAXPATHLEN], evname[128];
3251 	char line[BUFSIZ], *p;
3252 	struct evsel *pos;
3253 	int match, len;
3254 	FILE *fp;
3255 
3256 	scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3257 
3258 	fp = fopen(filename, "r");
3259 	if (!fp)
3260 		return -1;
3261 
3262 	while (fgets(line, sizeof(line), fp)) {
3263 		p = skip_spaces(line);
3264 		if (*p == '#')
3265 			continue;
3266 
3267 		while (strlen(p)) {
3268 			p = strstr(p, "-e");
3269 			if (!p)
3270 				break;
3271 
3272 			p += 2;
3273 			p = skip_spaces(p);
3274 			len = strcspn(p, " \t");
3275 			if (!len)
3276 				break;
3277 
3278 			snprintf(evname, len + 1, "%s", p);
3279 
3280 			match = 0;
3281 			evlist__for_each_entry(session->evlist, pos) {
3282 				if (!strcmp(evsel__name(pos), evname)) {
3283 					match = 1;
3284 					break;
3285 				}
3286 			}
3287 
3288 			if (!match) {
3289 				fclose(fp);
3290 				return -1;
3291 			}
3292 		}
3293 	}
3294 
3295 	fclose(fp);
3296 	return 0;
3297 }
3298 
3299 /*
3300  * Return -1 if none is found, otherwise the actual scripts number.
3301  *
3302  * Currently the only user of this function is the script browser, which
3303  * will list all statically runnable scripts, select one, execute it and
3304  * show the output in a perf browser.
3305  */
3306 int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3307 		 int pathlen)
3308 {
3309 	struct dirent *script_dirent, *lang_dirent;
3310 	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3311 	DIR *scripts_dir, *lang_dir;
3312 	struct perf_session *session;
3313 	struct perf_data data = {
3314 		.path = input_name,
3315 		.mode = PERF_DATA_MODE_READ,
3316 	};
3317 	char *temp;
3318 	int i = 0;
3319 
3320 	session = perf_session__new(&data, NULL);
3321 	if (IS_ERR(session))
3322 		return PTR_ERR(session);
3323 
3324 	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3325 
3326 	scripts_dir = opendir(scripts_path);
3327 	if (!scripts_dir) {
3328 		perf_session__delete(session);
3329 		return -1;
3330 	}
3331 
3332 	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3333 		scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3334 			  lang_dirent->d_name);
3335 #ifndef HAVE_LIBPERL_SUPPORT
3336 		if (strstr(lang_path, "perl"))
3337 			continue;
3338 #endif
3339 #ifndef HAVE_LIBPYTHON_SUPPORT
3340 		if (strstr(lang_path, "python"))
3341 			continue;
3342 #endif
3343 
3344 		lang_dir = opendir(lang_path);
3345 		if (!lang_dir)
3346 			continue;
3347 
3348 		for_each_script(lang_path, lang_dir, script_dirent) {
3349 			/* Skip those real time scripts: xxxtop.p[yl] */
3350 			if (strstr(script_dirent->d_name, "top."))
3351 				continue;
3352 			if (i >= num)
3353 				break;
3354 			snprintf(scripts_path_array[i], pathlen, "%s/%s",
3355 				lang_path,
3356 				script_dirent->d_name);
3357 			temp = strchr(script_dirent->d_name, '.');
3358 			snprintf(scripts_array[i],
3359 				(temp - script_dirent->d_name) + 1,
3360 				"%s", script_dirent->d_name);
3361 
3362 			if (check_ev_match(lang_path,
3363 					scripts_array[i], session))
3364 				continue;
3365 
3366 			i++;
3367 		}
3368 		closedir(lang_dir);
3369 	}
3370 
3371 	closedir(scripts_dir);
3372 	perf_session__delete(session);
3373 	return i;
3374 }
3375 
3376 static char *get_script_path(const char *script_root, const char *suffix)
3377 {
3378 	struct dirent *script_dirent, *lang_dirent;
3379 	char scripts_path[MAXPATHLEN];
3380 	char script_path[MAXPATHLEN];
3381 	DIR *scripts_dir, *lang_dir;
3382 	char lang_path[MAXPATHLEN];
3383 	char *__script_root;
3384 
3385 	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3386 
3387 	scripts_dir = opendir(scripts_path);
3388 	if (!scripts_dir)
3389 		return NULL;
3390 
3391 	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3392 		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3393 			  lang_dirent->d_name);
3394 		lang_dir = opendir(lang_path);
3395 		if (!lang_dir)
3396 			continue;
3397 
3398 		for_each_script(lang_path, lang_dir, script_dirent) {
3399 			__script_root = get_script_root(script_dirent, suffix);
3400 			if (__script_root && !strcmp(script_root, __script_root)) {
3401 				free(__script_root);
3402 				closedir(scripts_dir);
3403 				scnprintf(script_path, MAXPATHLEN, "%s/%s",
3404 					  lang_path, script_dirent->d_name);
3405 				closedir(lang_dir);
3406 				return strdup(script_path);
3407 			}
3408 			free(__script_root);
3409 		}
3410 		closedir(lang_dir);
3411 	}
3412 	closedir(scripts_dir);
3413 
3414 	return NULL;
3415 }
3416 
3417 static bool is_top_script(const char *script_path)
3418 {
3419 	return ends_with(script_path, "top") != NULL;
3420 }
3421 
3422 static int has_required_arg(char *script_path)
3423 {
3424 	struct script_desc *desc;
3425 	int n_args = 0;
3426 	char *p;
3427 
3428 	desc = script_desc__new(NULL);
3429 
3430 	if (read_script_info(desc, script_path))
3431 		goto out;
3432 
3433 	if (!desc->args)
3434 		goto out;
3435 
3436 	for (p = desc->args; *p; p++)
3437 		if (*p == '<')
3438 			n_args++;
3439 out:
3440 	script_desc__delete(desc);
3441 
3442 	return n_args;
3443 }
3444 
3445 static int have_cmd(int argc, const char **argv)
3446 {
3447 	char **__argv = malloc(sizeof(const char *) * argc);
3448 
3449 	if (!__argv) {
3450 		pr_err("malloc failed\n");
3451 		return -1;
3452 	}
3453 
3454 	memcpy(__argv, argv, sizeof(const char *) * argc);
3455 	argc = parse_options(argc, (const char **)__argv, record_options,
3456 			     NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3457 	free(__argv);
3458 
3459 	system_wide = (argc == 0);
3460 
3461 	return 0;
3462 }
3463 
3464 static void script__setup_sample_type(struct perf_script *script)
3465 {
3466 	struct perf_session *session = script->session;
3467 	u64 sample_type = evlist__combined_sample_type(session->evlist);
3468 
3469 	if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
3470 		if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3471 		    (sample_type & PERF_SAMPLE_STACK_USER)) {
3472 			callchain_param.record_mode = CALLCHAIN_DWARF;
3473 			dwarf_callchain_users = true;
3474 		} else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3475 			callchain_param.record_mode = CALLCHAIN_LBR;
3476 		else
3477 			callchain_param.record_mode = CALLCHAIN_FP;
3478 	}
3479 
3480 	if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3481 		pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3482 			   "Please apply --call-graph lbr when recording.\n");
3483 		script->stitch_lbr = false;
3484 	}
3485 }
3486 
3487 static int process_stat_round_event(struct perf_session *session,
3488 				    union perf_event *event)
3489 {
3490 	struct perf_record_stat_round *round = &event->stat_round;
3491 	struct evsel *counter;
3492 
3493 	evlist__for_each_entry(session->evlist, counter) {
3494 		perf_stat_process_counter(&stat_config, counter);
3495 		process_stat(counter, round->time);
3496 	}
3497 
3498 	process_stat_interval(round->time);
3499 	return 0;
3500 }
3501 
3502 static int process_stat_config_event(struct perf_session *session __maybe_unused,
3503 				     union perf_event *event)
3504 {
3505 	perf_event__read_stat_config(&stat_config, &event->stat_config);
3506 	return 0;
3507 }
3508 
3509 static int set_maps(struct perf_script *script)
3510 {
3511 	struct evlist *evlist = script->session->evlist;
3512 
3513 	if (!script->cpus || !script->threads)
3514 		return 0;
3515 
3516 	if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3517 		return -EINVAL;
3518 
3519 	perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3520 
3521 	if (evlist__alloc_stats(evlist, true))
3522 		return -ENOMEM;
3523 
3524 	script->allocated = true;
3525 	return 0;
3526 }
3527 
3528 static
3529 int process_thread_map_event(struct perf_session *session,
3530 			     union perf_event *event)
3531 {
3532 	struct perf_tool *tool = session->tool;
3533 	struct perf_script *script = container_of(tool, struct perf_script, tool);
3534 
3535 	if (script->threads) {
3536 		pr_warning("Extra thread map event, ignoring.\n");
3537 		return 0;
3538 	}
3539 
3540 	script->threads = thread_map__new_event(&event->thread_map);
3541 	if (!script->threads)
3542 		return -ENOMEM;
3543 
3544 	return set_maps(script);
3545 }
3546 
3547 static
3548 int process_cpu_map_event(struct perf_session *session,
3549 			  union perf_event *event)
3550 {
3551 	struct perf_tool *tool = session->tool;
3552 	struct perf_script *script = container_of(tool, struct perf_script, tool);
3553 
3554 	if (script->cpus) {
3555 		pr_warning("Extra cpu map event, ignoring.\n");
3556 		return 0;
3557 	}
3558 
3559 	script->cpus = cpu_map__new_data(&event->cpu_map.data);
3560 	if (!script->cpus)
3561 		return -ENOMEM;
3562 
3563 	return set_maps(script);
3564 }
3565 
3566 static int process_feature_event(struct perf_session *session,
3567 				 union perf_event *event)
3568 {
3569 	if (event->feat.feat_id < HEADER_LAST_FEATURE)
3570 		return perf_event__process_feature(session, event);
3571 	return 0;
3572 }
3573 
3574 #ifdef HAVE_AUXTRACE_SUPPORT
3575 static int perf_script__process_auxtrace_info(struct perf_session *session,
3576 					      union perf_event *event)
3577 {
3578 	struct perf_tool *tool = session->tool;
3579 
3580 	int ret = perf_event__process_auxtrace_info(session, event);
3581 
3582 	if (ret == 0) {
3583 		struct perf_script *script = container_of(tool, struct perf_script, tool);
3584 
3585 		ret = perf_script__setup_per_event_dump(script);
3586 	}
3587 
3588 	return ret;
3589 }
3590 #else
3591 #define perf_script__process_auxtrace_info 0
3592 #endif
3593 
3594 static int parse_insn_trace(const struct option *opt __maybe_unused,
3595 			    const char *str __maybe_unused,
3596 			    int unset __maybe_unused)
3597 {
3598 	parse_output_fields(NULL, "+insn,-event,-period", 0);
3599 	itrace_parse_synth_opts(opt, "i0ns", 0);
3600 	symbol_conf.nanosecs = true;
3601 	return 0;
3602 }
3603 
3604 static int parse_xed(const struct option *opt __maybe_unused,
3605 		     const char *str __maybe_unused,
3606 		     int unset __maybe_unused)
3607 {
3608 	if (isatty(1))
3609 		force_pager("xed -F insn: -A -64 | less");
3610 	else
3611 		force_pager("xed -F insn: -A -64");
3612 	return 0;
3613 }
3614 
3615 static int parse_call_trace(const struct option *opt __maybe_unused,
3616 			    const char *str __maybe_unused,
3617 			    int unset __maybe_unused)
3618 {
3619 	parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3620 	itrace_parse_synth_opts(opt, "cewp", 0);
3621 	symbol_conf.nanosecs = true;
3622 	symbol_conf.pad_output_len_dso = 50;
3623 	return 0;
3624 }
3625 
3626 static int parse_callret_trace(const struct option *opt __maybe_unused,
3627 			    const char *str __maybe_unused,
3628 			    int unset __maybe_unused)
3629 {
3630 	parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3631 	itrace_parse_synth_opts(opt, "crewp", 0);
3632 	symbol_conf.nanosecs = true;
3633 	return 0;
3634 }
3635 
3636 int cmd_script(int argc, const char **argv)
3637 {
3638 	bool show_full_info = false;
3639 	bool header = false;
3640 	bool header_only = false;
3641 	bool script_started = false;
3642 	char *rec_script_path = NULL;
3643 	char *rep_script_path = NULL;
3644 	struct perf_session *session;
3645 	struct itrace_synth_opts itrace_synth_opts = {
3646 		.set = false,
3647 		.default_no_sample = true,
3648 	};
3649 	struct utsname uts;
3650 	char *script_path = NULL;
3651 	const char *dlfilter_file = NULL;
3652 	const char **__argv;
3653 	int i, j, err = 0;
3654 	struct perf_script script = {
3655 		.tool = {
3656 			.sample		 = process_sample_event,
3657 			.mmap		 = perf_event__process_mmap,
3658 			.mmap2		 = perf_event__process_mmap2,
3659 			.comm		 = perf_event__process_comm,
3660 			.namespaces	 = perf_event__process_namespaces,
3661 			.cgroup		 = perf_event__process_cgroup,
3662 			.exit		 = perf_event__process_exit,
3663 			.fork		 = perf_event__process_fork,
3664 			.attr		 = process_attr,
3665 			.event_update   = perf_event__process_event_update,
3666 			.tracing_data	 = perf_event__process_tracing_data,
3667 			.feature	 = process_feature_event,
3668 			.build_id	 = perf_event__process_build_id,
3669 			.id_index	 = perf_event__process_id_index,
3670 			.auxtrace_info	 = perf_script__process_auxtrace_info,
3671 			.auxtrace	 = perf_event__process_auxtrace,
3672 			.auxtrace_error	 = perf_event__process_auxtrace_error,
3673 			.stat		 = perf_event__process_stat_event,
3674 			.stat_round	 = process_stat_round_event,
3675 			.stat_config	 = process_stat_config_event,
3676 			.thread_map	 = process_thread_map_event,
3677 			.cpu_map	 = process_cpu_map_event,
3678 			.throttle	 = process_throttle_event,
3679 			.unthrottle	 = process_throttle_event,
3680 			.ordered_events	 = true,
3681 			.ordering_requires_timestamps = true,
3682 		},
3683 	};
3684 	struct perf_data data = {
3685 		.mode = PERF_DATA_MODE_READ,
3686 	};
3687 	const struct option options[] = {
3688 	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3689 		    "dump raw trace in ASCII"),
3690 	OPT_INCR('v', "verbose", &verbose,
3691 		 "be more verbose (show symbol address, etc)"),
3692 	OPT_BOOLEAN('L', "Latency", &latency_format,
3693 		    "show latency attributes (irqs/preemption disabled, etc)"),
3694 	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3695 			   list_available_scripts),
3696 	OPT_CALLBACK_NOOPT(0, "list-dlfilters", NULL, NULL, "list available dlfilters",
3697 			   list_available_dlfilters),
3698 	OPT_CALLBACK('s', "script", NULL, "name",
3699 		     "script file name (lang:script name, script name, or *)",
3700 		     parse_scriptname),
3701 	OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3702 		   "generate perf-script.xx script in specified language"),
3703 	OPT_STRING(0, "dlfilter", &dlfilter_file, "file", "filter .so file name"),
3704 	OPT_CALLBACK(0, "dlarg", NULL, "argument", "filter argument",
3705 		     add_dlarg),
3706 	OPT_STRING('i', "input", &input_name, "file", "input file name"),
3707 	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3708 		   "do various checks like samples ordering and lost events"),
3709 	OPT_BOOLEAN(0, "header", &header, "Show data header."),
3710 	OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3711 	OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3712 		   "file", "vmlinux pathname"),
3713 	OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3714 		   "file", "kallsyms pathname"),
3715 	OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3716 		    "When printing symbols do not display call chain"),
3717 	OPT_CALLBACK(0, "symfs", NULL, "directory",
3718 		     "Look for files with symbols relative to this directory",
3719 		     symbol__config_symfs),
3720 	OPT_CALLBACK('F', "fields", NULL, "str",
3721 		     "comma separated output fields prepend with 'type:'. "
3722 		     "+field to add and -field to remove."
3723 		     "Valid types: hw,sw,trace,raw,synth. "
3724 		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3725 		     "addr,symoff,srcline,period,iregs,uregs,brstack,"
3726 		     "brstacksym,flags,bpf-output,brstackinsn,brstackoff,"
3727 		     "callindent,insn,insnlen,synth,phys_addr,metric,misc,ipc,tod,"
3728 		     "data_page_size,code_page_size,ins_lat",
3729 		     parse_output_fields),
3730 	OPT_BOOLEAN('a', "all-cpus", &system_wide,
3731 		    "system-wide collection from all CPUs"),
3732 	OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
3733 		   "only consider symbols in these DSOs"),
3734 	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3735 		   "only consider these symbols"),
3736 	OPT_INTEGER(0, "addr-range", &symbol_conf.addr_range,
3737 		    "Use with -S to list traced records within address range"),
3738 	OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3739 			"Decode instructions from itrace", parse_insn_trace),
3740 	OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3741 			"Run xed disassembler on output", parse_xed),
3742 	OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3743 			"Decode calls from from itrace", parse_call_trace),
3744 	OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3745 			"Decode calls and returns from itrace", parse_callret_trace),
3746 	OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3747 			"Only print symbols and callees with --call-trace/--call-ret-trace"),
3748 	OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3749 		   "Stop display of callgraph at these symbols"),
3750 	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3751 	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3752 		   "only display events for these comms"),
3753 	OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3754 		   "only consider symbols in these pids"),
3755 	OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3756 		   "only consider symbols in these tids"),
3757 	OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3758 		     "Set the maximum stack depth when parsing the callchain, "
3759 		     "anything beyond the specified depth will be ignored. "
3760 		     "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3761 	OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3762 	OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3763 	OPT_BOOLEAN('I', "show-info", &show_full_info,
3764 		    "display extended information from perf.data file"),
3765 	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3766 		    "Show the path of [kernel.kallsyms]"),
3767 	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3768 		    "Show the fork/comm/exit events"),
3769 	OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3770 		    "Show the mmap events"),
3771 	OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3772 		    "Show context switch events (if recorded)"),
3773 	OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3774 		    "Show namespace events (if recorded)"),
3775 	OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3776 		    "Show cgroup events (if recorded)"),
3777 	OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3778 		    "Show lost events (if recorded)"),
3779 	OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3780 		    "Show round events (if recorded)"),
3781 	OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3782 		    "Show bpf related events (if recorded)"),
3783 	OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
3784 		    "Show text poke related events (if recorded)"),
3785 	OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3786 		    "Dump trace output to files named by the monitored events"),
3787 	OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3788 	OPT_INTEGER(0, "max-blocks", &max_blocks,
3789 		    "Maximum number of code blocks to dump with brstackinsn"),
3790 	OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3791 		    "Use 9 decimal places when displaying time"),
3792 	OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3793 			    "Instruction Tracing options\n" ITRACE_HELP,
3794 			    itrace_parse_synth_opts),
3795 	OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3796 			"Show full source file name path for source lines"),
3797 	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3798 			"Enable symbol demangling"),
3799 	OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3800 			"Enable kernel symbol demangling"),
3801 	OPT_STRING(0, "time", &script.time_str, "str",
3802 		   "Time span of interest (start,stop)"),
3803 	OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3804 		    "Show inline function"),
3805 	OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3806 		   "guest mount directory under which every guest os"
3807 		   " instance has a subdir"),
3808 	OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3809 		   "file", "file saving guest os vmlinux"),
3810 	OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3811 		   "file", "file saving guest os /proc/kallsyms"),
3812 	OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3813 		   "file", "file saving guest os /proc/modules"),
3814 	OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
3815 		    "Enable LBR callgraph stitching approach"),
3816 	OPTS_EVSWITCH(&script.evswitch),
3817 	OPT_END()
3818 	};
3819 	const char * const script_subcommands[] = { "record", "report", NULL };
3820 	const char *script_usage[] = {
3821 		"perf script [<options>]",
3822 		"perf script [<options>] record <script> [<record-options>] <command>",
3823 		"perf script [<options>] report <script> [script-args]",
3824 		"perf script [<options>] <script> [<record-options>] <command>",
3825 		"perf script [<options>] <top-script> [script-args]",
3826 		NULL
3827 	};
3828 
3829 	perf_set_singlethreaded();
3830 
3831 	setup_scripting();
3832 
3833 	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3834 			     PARSE_OPT_STOP_AT_NON_OPTION);
3835 
3836 	if (symbol_conf.guestmount ||
3837 	    symbol_conf.default_guest_vmlinux_name ||
3838 	    symbol_conf.default_guest_kallsyms ||
3839 	    symbol_conf.default_guest_modules) {
3840 		/*
3841 		 * Enable guest sample processing.
3842 		 */
3843 		perf_guest = true;
3844 	}
3845 
3846 	data.path  = input_name;
3847 	data.force = symbol_conf.force;
3848 
3849 	if (symbol__validate_sym_arguments())
3850 		return -1;
3851 
3852 	if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
3853 		rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
3854 		if (!rec_script_path)
3855 			return cmd_record(argc, argv);
3856 	}
3857 
3858 	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
3859 		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
3860 		if (!rep_script_path) {
3861 			fprintf(stderr,
3862 				"Please specify a valid report script"
3863 				"(see 'perf script -l' for listing)\n");
3864 			return -1;
3865 		}
3866 	}
3867 
3868 	if (reltime && deltatime) {
3869 		fprintf(stderr,
3870 			"reltime and deltatime - the two don't get along well. "
3871 			"Please limit to --reltime or --deltatime.\n");
3872 		return -1;
3873 	}
3874 
3875 	if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
3876 	    itrace_synth_opts.callchain_sz > scripting_max_stack)
3877 		scripting_max_stack = itrace_synth_opts.callchain_sz;
3878 
3879 	/* make sure PERF_EXEC_PATH is set for scripts */
3880 	set_argv_exec_path(get_argv_exec_path());
3881 
3882 	if (argc && !script_name && !rec_script_path && !rep_script_path) {
3883 		int live_pipe[2];
3884 		int rep_args;
3885 		pid_t pid;
3886 
3887 		rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
3888 		rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
3889 
3890 		if (!rec_script_path && !rep_script_path) {
3891 			script_name = find_script(argv[0]);
3892 			if (script_name) {
3893 				argc -= 1;
3894 				argv += 1;
3895 				goto script_found;
3896 			}
3897 			usage_with_options_msg(script_usage, options,
3898 				"Couldn't find script `%s'\n\n See perf"
3899 				" script -l for available scripts.\n", argv[0]);
3900 		}
3901 
3902 		if (is_top_script(argv[0])) {
3903 			rep_args = argc - 1;
3904 		} else {
3905 			int rec_args;
3906 
3907 			rep_args = has_required_arg(rep_script_path);
3908 			rec_args = (argc - 1) - rep_args;
3909 			if (rec_args < 0) {
3910 				usage_with_options_msg(script_usage, options,
3911 					"`%s' script requires options."
3912 					"\n\n See perf script -l for available "
3913 					"scripts and options.\n", argv[0]);
3914 			}
3915 		}
3916 
3917 		if (pipe(live_pipe) < 0) {
3918 			perror("failed to create pipe");
3919 			return -1;
3920 		}
3921 
3922 		pid = fork();
3923 		if (pid < 0) {
3924 			perror("failed to fork");
3925 			return -1;
3926 		}
3927 
3928 		if (!pid) {
3929 			j = 0;
3930 
3931 			dup2(live_pipe[1], 1);
3932 			close(live_pipe[0]);
3933 
3934 			if (is_top_script(argv[0])) {
3935 				system_wide = true;
3936 			} else if (!system_wide) {
3937 				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
3938 					err = -1;
3939 					goto out;
3940 				}
3941 			}
3942 
3943 			__argv = malloc((argc + 6) * sizeof(const char *));
3944 			if (!__argv) {
3945 				pr_err("malloc failed\n");
3946 				err = -ENOMEM;
3947 				goto out;
3948 			}
3949 
3950 			__argv[j++] = "/bin/sh";
3951 			__argv[j++] = rec_script_path;
3952 			if (system_wide)
3953 				__argv[j++] = "-a";
3954 			__argv[j++] = "-q";
3955 			__argv[j++] = "-o";
3956 			__argv[j++] = "-";
3957 			for (i = rep_args + 1; i < argc; i++)
3958 				__argv[j++] = argv[i];
3959 			__argv[j++] = NULL;
3960 
3961 			execvp("/bin/sh", (char **)__argv);
3962 			free(__argv);
3963 			exit(-1);
3964 		}
3965 
3966 		dup2(live_pipe[0], 0);
3967 		close(live_pipe[1]);
3968 
3969 		__argv = malloc((argc + 4) * sizeof(const char *));
3970 		if (!__argv) {
3971 			pr_err("malloc failed\n");
3972 			err = -ENOMEM;
3973 			goto out;
3974 		}
3975 
3976 		j = 0;
3977 		__argv[j++] = "/bin/sh";
3978 		__argv[j++] = rep_script_path;
3979 		for (i = 1; i < rep_args + 1; i++)
3980 			__argv[j++] = argv[i];
3981 		__argv[j++] = "-i";
3982 		__argv[j++] = "-";
3983 		__argv[j++] = NULL;
3984 
3985 		execvp("/bin/sh", (char **)__argv);
3986 		free(__argv);
3987 		exit(-1);
3988 	}
3989 script_found:
3990 	if (rec_script_path)
3991 		script_path = rec_script_path;
3992 	if (rep_script_path)
3993 		script_path = rep_script_path;
3994 
3995 	if (script_path) {
3996 		j = 0;
3997 
3998 		if (!rec_script_path)
3999 			system_wide = false;
4000 		else if (!system_wide) {
4001 			if (have_cmd(argc - 1, &argv[1]) != 0) {
4002 				err = -1;
4003 				goto out;
4004 			}
4005 		}
4006 
4007 		__argv = malloc((argc + 2) * sizeof(const char *));
4008 		if (!__argv) {
4009 			pr_err("malloc failed\n");
4010 			err = -ENOMEM;
4011 			goto out;
4012 		}
4013 
4014 		__argv[j++] = "/bin/sh";
4015 		__argv[j++] = script_path;
4016 		if (system_wide)
4017 			__argv[j++] = "-a";
4018 		for (i = 2; i < argc; i++)
4019 			__argv[j++] = argv[i];
4020 		__argv[j++] = NULL;
4021 
4022 		execvp("/bin/sh", (char **)__argv);
4023 		free(__argv);
4024 		exit(-1);
4025 	}
4026 
4027 	if (dlfilter_file) {
4028 		dlfilter = dlfilter__new(dlfilter_file, dlargc, dlargv);
4029 		if (!dlfilter)
4030 			return -1;
4031 	}
4032 
4033 	if (!script_name) {
4034 		setup_pager();
4035 		use_browser = 0;
4036 	}
4037 
4038 	session = perf_session__new(&data, &script.tool);
4039 	if (IS_ERR(session))
4040 		return PTR_ERR(session);
4041 
4042 	if (header || header_only) {
4043 		script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
4044 		perf_session__fprintf_info(session, stdout, show_full_info);
4045 		if (header_only)
4046 			goto out_delete;
4047 	}
4048 	if (show_full_info)
4049 		script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
4050 
4051 	if (symbol__init(&session->header.env) < 0)
4052 		goto out_delete;
4053 
4054 	uname(&uts);
4055 	if (data.is_pipe) { /* Assume pipe_mode indicates native_arch */
4056 		native_arch = true;
4057 	} else if (session->header.env.arch) {
4058 		if (!strcmp(uts.machine, session->header.env.arch))
4059 			native_arch = true;
4060 		else if (!strcmp(uts.machine, "x86_64") &&
4061 			 !strcmp(session->header.env.arch, "i386"))
4062 			native_arch = true;
4063 	}
4064 
4065 	script.session = session;
4066 	script__setup_sample_type(&script);
4067 
4068 	if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
4069 	    symbol_conf.graph_function)
4070 		itrace_synth_opts.thread_stack = true;
4071 
4072 	session->itrace_synth_opts = &itrace_synth_opts;
4073 
4074 	if (cpu_list) {
4075 		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
4076 		if (err < 0)
4077 			goto out_delete;
4078 		itrace_synth_opts.cpu_bitmap = cpu_bitmap;
4079 	}
4080 
4081 	if (!no_callchain)
4082 		symbol_conf.use_callchain = true;
4083 	else
4084 		symbol_conf.use_callchain = false;
4085 
4086 	if (session->tevent.pevent &&
4087 	    tep_set_function_resolver(session->tevent.pevent,
4088 				      machine__resolve_kernel_addr,
4089 				      &session->machines.host) < 0) {
4090 		pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
4091 		err = -1;
4092 		goto out_delete;
4093 	}
4094 
4095 	if (generate_script_lang) {
4096 		struct stat perf_stat;
4097 		int input;
4098 
4099 		if (output_set_by_user()) {
4100 			fprintf(stderr,
4101 				"custom fields not supported for generated scripts");
4102 			err = -EINVAL;
4103 			goto out_delete;
4104 		}
4105 
4106 		input = open(data.path, O_RDONLY);	/* input_name */
4107 		if (input < 0) {
4108 			err = -errno;
4109 			perror("failed to open file");
4110 			goto out_delete;
4111 		}
4112 
4113 		err = fstat(input, &perf_stat);
4114 		if (err < 0) {
4115 			perror("failed to stat file");
4116 			goto out_delete;
4117 		}
4118 
4119 		if (!perf_stat.st_size) {
4120 			fprintf(stderr, "zero-sized file, nothing to do!\n");
4121 			goto out_delete;
4122 		}
4123 
4124 		scripting_ops = script_spec__lookup(generate_script_lang);
4125 		if (!scripting_ops) {
4126 			fprintf(stderr, "invalid language specifier");
4127 			err = -ENOENT;
4128 			goto out_delete;
4129 		}
4130 
4131 		err = scripting_ops->generate_script(session->tevent.pevent,
4132 						     "perf-script");
4133 		goto out_delete;
4134 	}
4135 
4136 	err = dlfilter__start(dlfilter, session);
4137 	if (err)
4138 		goto out_delete;
4139 
4140 	if (script_name) {
4141 		err = scripting_ops->start_script(script_name, argc, argv, session);
4142 		if (err)
4143 			goto out_delete;
4144 		pr_debug("perf script started with script %s\n\n", script_name);
4145 		script_started = true;
4146 	}
4147 
4148 
4149 	err = perf_session__check_output_opt(session);
4150 	if (err < 0)
4151 		goto out_delete;
4152 
4153 	if (script.time_str) {
4154 		err = perf_time__parse_for_ranges_reltime(script.time_str, session,
4155 						  &script.ptime_range,
4156 						  &script.range_size,
4157 						  &script.range_num,
4158 						  reltime);
4159 		if (err < 0)
4160 			goto out_delete;
4161 
4162 		itrace_synth_opts__set_time_range(&itrace_synth_opts,
4163 						  script.ptime_range,
4164 						  script.range_num);
4165 	}
4166 
4167 	err = evswitch__init(&script.evswitch, session->evlist, stderr);
4168 	if (err)
4169 		goto out_delete;
4170 
4171 	if (zstd_init(&(session->zstd_data), 0) < 0)
4172 		pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
4173 
4174 	err = __cmd_script(&script);
4175 
4176 	flush_scripting();
4177 
4178 out_delete:
4179 	if (script.ptime_range) {
4180 		itrace_synth_opts__clear_time_range(&itrace_synth_opts);
4181 		zfree(&script.ptime_range);
4182 	}
4183 
4184 	zstd_fini(&(session->zstd_data));
4185 	evlist__free_stats(session->evlist);
4186 	perf_session__delete(session);
4187 	perf_script__exit(&script);
4188 
4189 	if (script_started)
4190 		cleanup_scripting();
4191 	dlfilter__cleanup(dlfilter);
4192 	free_dlarg();
4193 out:
4194 	return err;
4195 }
4196