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