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