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