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