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