Merge tag 'nfs-for-4.7-1' of git://git.linux-nfs.org/projects/anna/linux-nfs
[linux-2.6-block.git] / tools / perf / builtin-script.c
CommitLineData
5f9c39dc
FW
1#include "builtin.h"
2
b7eead86 3#include "perf.h"
5f9c39dc 4#include "util/cache.h"
b7eead86 5#include "util/debug.h"
4b6ab94e 6#include <subcmd/exec-cmd.h>
b7eead86 7#include "util/header.h"
4b6ab94e 8#include <subcmd/parse-options.h>
fc36f948 9#include "util/perf_regs.h"
b7eead86 10#include "util/session.h"
45694aa7 11#include "util/tool.h"
5f9c39dc
FW
12#include "util/symbol.h"
13#include "util/thread.h"
cf72344d 14#include "util/trace-event.h"
b7eead86 15#include "util/util.h"
1424dc96
DA
16#include "util/evlist.h"
17#include "util/evsel.h"
36385be5 18#include "util/sort.h"
f5fc1412 19#include "util/data.h"
7a680eb9 20#include "util/auxtrace.h"
cfc8874a
JO
21#include "util/cpumap.h"
22#include "util/thread_map.h"
23#include "util/stat.h"
5d67be97 24#include <linux/bitmap.h>
6125cc8d 25#include <linux/stringify.h>
cfc8874a 26#include "asm/bug.h"
c19ac912 27#include "util/mem-events.h"
5f9c39dc 28
956ffd02
TZ
29static char const *script_name;
30static char const *generate_script_lang;
ffabd99e 31static bool debug_mode;
e1889d75 32static u64 last_timestamp;
6fcf7ddb 33static u64 nr_unordered;
c0230b2b 34static bool no_callchain;
47390ae2 35static bool latency_format;
317df650 36static bool system_wide;
400ea6d3 37static bool print_flags;
83e19860 38static bool nanosecs;
5d67be97
AB
39static const char *cpu_list;
40static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
91a2c3d5 41static struct perf_stat_config stat_config;
956ffd02 42
44cbe729 43unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
03cd1fed 44
745f43e3
DA
45enum perf_output_field {
46 PERF_OUTPUT_COMM = 1U << 0,
47 PERF_OUTPUT_TID = 1U << 1,
48 PERF_OUTPUT_PID = 1U << 2,
49 PERF_OUTPUT_TIME = 1U << 3,
50 PERF_OUTPUT_CPU = 1U << 4,
51 PERF_OUTPUT_EVNAME = 1U << 5,
52 PERF_OUTPUT_TRACE = 1U << 6,
787bef17
DA
53 PERF_OUTPUT_IP = 1U << 7,
54 PERF_OUTPUT_SYM = 1U << 8,
610723f2 55 PERF_OUTPUT_DSO = 1U << 9,
7cec0922 56 PERF_OUTPUT_ADDR = 1U << 10,
a978f2ab 57 PERF_OUTPUT_SYMOFFSET = 1U << 11,
cc8fae1d 58 PERF_OUTPUT_SRCLINE = 1U << 12,
535aeaae 59 PERF_OUTPUT_PERIOD = 1U << 13,
fc36f948 60 PERF_OUTPUT_IREGS = 1U << 14,
dc323ce8
SE
61 PERF_OUTPUT_BRSTACK = 1U << 15,
62 PERF_OUTPUT_BRSTACKSYM = 1U << 16,
94ddddfa
JO
63 PERF_OUTPUT_DATA_SRC = 1U << 17,
64 PERF_OUTPUT_WEIGHT = 1U << 18,
30372f04 65 PERF_OUTPUT_BPF_OUTPUT = 1U << 19,
745f43e3
DA
66};
67
68struct output_option {
69 const char *str;
70 enum perf_output_field field;
71} all_output_options[] = {
72 {.str = "comm", .field = PERF_OUTPUT_COMM},
73 {.str = "tid", .field = PERF_OUTPUT_TID},
74 {.str = "pid", .field = PERF_OUTPUT_PID},
75 {.str = "time", .field = PERF_OUTPUT_TIME},
76 {.str = "cpu", .field = PERF_OUTPUT_CPU},
77 {.str = "event", .field = PERF_OUTPUT_EVNAME},
78 {.str = "trace", .field = PERF_OUTPUT_TRACE},
787bef17 79 {.str = "ip", .field = PERF_OUTPUT_IP},
c0230b2b 80 {.str = "sym", .field = PERF_OUTPUT_SYM},
610723f2 81 {.str = "dso", .field = PERF_OUTPUT_DSO},
7cec0922 82 {.str = "addr", .field = PERF_OUTPUT_ADDR},
a978f2ab 83 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
cc8fae1d 84 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
535aeaae 85 {.str = "period", .field = PERF_OUTPUT_PERIOD},
fc36f948 86 {.str = "iregs", .field = PERF_OUTPUT_IREGS},
dc323ce8
SE
87 {.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
88 {.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
94ddddfa
JO
89 {.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
90 {.str = "weight", .field = PERF_OUTPUT_WEIGHT},
30372f04 91 {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT},
745f43e3
DA
92};
93
94/* default set to maintain compatibility with current format */
2c9e45f7
DA
95static struct {
96 bool user_set;
9cbdb702 97 bool wildcard_set;
a6ffaf91 98 unsigned int print_ip_opts;
2c9e45f7
DA
99 u64 fields;
100 u64 invalid_fields;
101} output[PERF_TYPE_MAX] = {
102
103 [PERF_TYPE_HARDWARE] = {
104 .user_set = false,
105
106 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
107 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
787bef17 108 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
e8564b71
JO
109 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
110 PERF_OUTPUT_PERIOD,
2c9e45f7 111
30372f04 112 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
2c9e45f7
DA
113 },
114
115 [PERF_TYPE_SOFTWARE] = {
116 .user_set = false,
117
118 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
119 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
787bef17 120 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
e8564b71 121 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
30372f04 122 PERF_OUTPUT_PERIOD | PERF_OUTPUT_BPF_OUTPUT,
2c9e45f7
DA
123
124 .invalid_fields = PERF_OUTPUT_TRACE,
125 },
126
127 [PERF_TYPE_TRACEPOINT] = {
128 .user_set = false,
129
130 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
131 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
30372f04 132 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
2c9e45f7 133 },
0817a6a3
AS
134
135 [PERF_TYPE_RAW] = {
136 .user_set = false,
137
138 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
139 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
787bef17 140 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
e8564b71 141 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
ff7b1915
JO
142 PERF_OUTPUT_PERIOD | PERF_OUTPUT_ADDR |
143 PERF_OUTPUT_DATA_SRC | PERF_OUTPUT_WEIGHT,
0817a6a3 144
30372f04 145 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
0817a6a3 146 },
27cfef00
WN
147
148 [PERF_TYPE_BREAKPOINT] = {
149 .user_set = false,
150
151 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
152 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
153 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
154 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
155 PERF_OUTPUT_PERIOD,
156
30372f04 157 .invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
27cfef00 158 },
1424dc96 159};
745f43e3 160
2c9e45f7
DA
161static bool output_set_by_user(void)
162{
163 int j;
164 for (j = 0; j < PERF_TYPE_MAX; ++j) {
165 if (output[j].user_set)
166 return true;
167 }
168 return false;
169}
745f43e3 170
9cbdb702
DA
171static const char *output_field2str(enum perf_output_field field)
172{
173 int i, imax = ARRAY_SIZE(all_output_options);
174 const char *str = "";
175
176 for (i = 0; i < imax; ++i) {
177 if (all_output_options[i].field == field) {
178 str = all_output_options[i].str;
179 break;
180 }
181 }
182 return str;
183}
184
2c9e45f7 185#define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
1424dc96 186
6d5cdd64
AH
187static int perf_evsel__do_check_stype(struct perf_evsel *evsel,
188 u64 sample_type, const char *sample_msg,
189 enum perf_output_field field,
190 bool allow_user_set)
1424dc96 191{
5bff01f6 192 struct perf_event_attr *attr = &evsel->attr;
9cbdb702
DA
193 int type = attr->type;
194 const char *evname;
195
196 if (attr->sample_type & sample_type)
197 return 0;
198
199 if (output[type].user_set) {
6d5cdd64
AH
200 if (allow_user_set)
201 return 0;
5bff01f6 202 evname = perf_evsel__name(evsel);
9cbdb702
DA
203 pr_err("Samples for '%s' event do not have %s attribute set. "
204 "Cannot print '%s' field.\n",
205 evname, sample_msg, output_field2str(field));
206 return -1;
207 }
208
209 /* user did not ask for it explicitly so remove from the default list */
210 output[type].fields &= ~field;
5bff01f6 211 evname = perf_evsel__name(evsel);
9cbdb702
DA
212 pr_debug("Samples for '%s' event do not have %s attribute set. "
213 "Skipping '%s' field.\n",
214 evname, sample_msg, output_field2str(field));
215
216 return 0;
217}
218
6d5cdd64
AH
219static int perf_evsel__check_stype(struct perf_evsel *evsel,
220 u64 sample_type, const char *sample_msg,
221 enum perf_output_field field)
222{
223 return perf_evsel__do_check_stype(evsel, sample_type, sample_msg, field,
224 false);
225}
226
9cbdb702
DA
227static int perf_evsel__check_attr(struct perf_evsel *evsel,
228 struct perf_session *session)
229{
230 struct perf_event_attr *attr = &evsel->attr;
6d5cdd64
AH
231 bool allow_user_set;
232
e099eba8
JO
233 if (perf_header__has_feat(&session->header, HEADER_STAT))
234 return 0;
235
6d5cdd64
AH
236 allow_user_set = perf_header__has_feat(&session->header,
237 HEADER_AUXTRACE);
9cbdb702 238
1424dc96
DA
239 if (PRINT_FIELD(TRACE) &&
240 !perf_session__has_traces(session, "record -R"))
241 return -EINVAL;
242
787bef17 243 if (PRINT_FIELD(IP)) {
5bff01f6
ACM
244 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
245 PERF_OUTPUT_IP))
1424dc96 246 return -EINVAL;
1424dc96 247 }
7cec0922
DA
248
249 if (PRINT_FIELD(ADDR) &&
6d5cdd64
AH
250 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
251 PERF_OUTPUT_ADDR, allow_user_set))
7cec0922
DA
252 return -EINVAL;
253
94ddddfa
JO
254 if (PRINT_FIELD(DATA_SRC) &&
255 perf_evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC",
256 PERF_OUTPUT_DATA_SRC))
257 return -EINVAL;
258
259 if (PRINT_FIELD(WEIGHT) &&
260 perf_evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT",
261 PERF_OUTPUT_WEIGHT))
262 return -EINVAL;
263
7cec0922
DA
264 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
265 pr_err("Display of symbols requested but neither sample IP nor "
266 "sample address\nis selected. Hence, no addresses to convert "
267 "to symbols.\n");
787bef17
DA
268 return -EINVAL;
269 }
a978f2ab
AN
270 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
271 pr_err("Display of offsets requested but symbol is not"
272 "selected.\n");
273 return -EINVAL;
274 }
7cec0922
DA
275 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
276 pr_err("Display of DSO requested but neither sample IP nor "
277 "sample address\nis selected. Hence, no addresses to convert "
278 "to DSO.\n");
610723f2
DA
279 return -EINVAL;
280 }
cc8fae1d
AH
281 if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
282 pr_err("Display of source line number requested but sample IP is not\n"
283 "selected. Hence, no address to lookup the source line number.\n");
284 return -EINVAL;
285 }
1424dc96
DA
286
287 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
5bff01f6
ACM
288 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
289 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
1424dc96 290 return -EINVAL;
1424dc96
DA
291
292 if (PRINT_FIELD(TIME) &&
5bff01f6
ACM
293 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
294 PERF_OUTPUT_TIME))
1424dc96 295 return -EINVAL;
1424dc96
DA
296
297 if (PRINT_FIELD(CPU) &&
6d5cdd64
AH
298 perf_evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
299 PERF_OUTPUT_CPU, allow_user_set))
1424dc96 300 return -EINVAL;
9cbdb702 301
535aeaae
JO
302 if (PRINT_FIELD(PERIOD) &&
303 perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD",
304 PERF_OUTPUT_PERIOD))
305 return -EINVAL;
306
fc36f948
SE
307 if (PRINT_FIELD(IREGS) &&
308 perf_evsel__check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS",
309 PERF_OUTPUT_IREGS))
310 return -EINVAL;
311
9cbdb702
DA
312 return 0;
313}
314
7ea95727
AH
315static void set_print_ip_opts(struct perf_event_attr *attr)
316{
317 unsigned int type = attr->type;
318
319 output[type].print_ip_opts = 0;
320 if (PRINT_FIELD(IP))
e20ab86e 321 output[type].print_ip_opts |= EVSEL__PRINT_IP;
7ea95727
AH
322
323 if (PRINT_FIELD(SYM))
e20ab86e 324 output[type].print_ip_opts |= EVSEL__PRINT_SYM;
7ea95727
AH
325
326 if (PRINT_FIELD(DSO))
e20ab86e 327 output[type].print_ip_opts |= EVSEL__PRINT_DSO;
7ea95727
AH
328
329 if (PRINT_FIELD(SYMOFFSET))
e20ab86e 330 output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
cc8fae1d
AH
331
332 if (PRINT_FIELD(SRCLINE))
e20ab86e 333 output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
7ea95727
AH
334}
335
9cbdb702
DA
336/*
337 * verify all user requested events exist and the samples
338 * have the expected data
339 */
340static int perf_session__check_output_opt(struct perf_session *session)
341{
342 int j;
343 struct perf_evsel *evsel;
344
345 for (j = 0; j < PERF_TYPE_MAX; ++j) {
346 evsel = perf_session__find_first_evtype(session, j);
347
348 /*
349 * even if fields is set to 0 (ie., show nothing) event must
350 * exist if user explicitly includes it on the command line
351 */
352 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
353 pr_err("%s events do not exist. "
354 "Remove corresponding -f option to proceed.\n",
355 event_type(j));
356 return -1;
357 }
358
359 if (evsel && output[j].fields &&
360 perf_evsel__check_attr(evsel, session))
361 return -1;
a6ffaf91
DA
362
363 if (evsel == NULL)
364 continue;
365
7ea95727 366 set_print_ip_opts(&evsel->attr);
1424dc96
DA
367 }
368
98526ee7
AH
369 if (!no_callchain) {
370 bool use_callchain = false;
371
372 evlist__for_each(session->evlist, evsel) {
373 if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) {
374 use_callchain = true;
375 break;
376 }
377 }
378 if (!use_callchain)
379 symbol_conf.use_callchain = false;
380 }
381
80b8b496
DA
382 /*
383 * set default for tracepoints to print symbols only
384 * if callchains are present
385 */
386 if (symbol_conf.use_callchain &&
387 !output[PERF_TYPE_TRACEPOINT].user_set) {
388 struct perf_event_attr *attr;
389
390 j = PERF_TYPE_TRACEPOINT;
391 evsel = perf_session__find_first_evtype(session, j);
392 if (evsel == NULL)
393 goto out;
394
395 attr = &evsel->attr;
396
397 if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
398 output[j].fields |= PERF_OUTPUT_IP;
399 output[j].fields |= PERF_OUTPUT_SYM;
400 output[j].fields |= PERF_OUTPUT_DSO;
401 set_print_ip_opts(attr);
402 }
403 }
404
405out:
1424dc96
DA
406 return 0;
407}
745f43e3 408
a3dff304 409static void print_sample_iregs(struct perf_sample *sample,
fc36f948
SE
410 struct perf_event_attr *attr)
411{
412 struct regs_dump *regs = &sample->intr_regs;
413 uint64_t mask = attr->sample_regs_intr;
414 unsigned i = 0, r;
415
416 if (!regs)
417 return;
418
419 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
420 u64 val = regs->regs[i++];
421 printf("%5s:0x%"PRIx64" ", perf_reg_name(r), val);
422 }
423}
424
fcf65bf1 425static void print_sample_start(struct perf_sample *sample,
1424dc96 426 struct thread *thread,
5bff01f6 427 struct perf_evsel *evsel)
c70c94b4 428{
5bff01f6 429 struct perf_event_attr *attr = &evsel->attr;
c70c94b4
DA
430 unsigned long secs;
431 unsigned long usecs;
745f43e3
DA
432 unsigned long long nsecs;
433
434 if (PRINT_FIELD(COMM)) {
435 if (latency_format)
b9c5143a 436 printf("%8.8s ", thread__comm_str(thread));
787bef17 437 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
b9c5143a 438 printf("%s ", thread__comm_str(thread));
745f43e3 439 else
b9c5143a 440 printf("%16s ", thread__comm_str(thread));
745f43e3 441 }
c70c94b4 442
745f43e3
DA
443 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
444 printf("%5d/%-5d ", sample->pid, sample->tid);
445 else if (PRINT_FIELD(PID))
446 printf("%5d ", sample->pid);
447 else if (PRINT_FIELD(TID))
448 printf("%5d ", sample->tid);
449
450 if (PRINT_FIELD(CPU)) {
451 if (latency_format)
452 printf("%3d ", sample->cpu);
453 else
454 printf("[%03d] ", sample->cpu);
455 }
c70c94b4 456
745f43e3
DA
457 if (PRINT_FIELD(TIME)) {
458 nsecs = sample->time;
459 secs = nsecs / NSECS_PER_SEC;
460 nsecs -= secs * NSECS_PER_SEC;
461 usecs = nsecs / NSECS_PER_USEC;
83e19860
AH
462 if (nanosecs)
463 printf("%5lu.%09llu: ", secs, nsecs);
464 else
465 printf("%5lu.%06lu: ", secs, usecs);
745f43e3 466 }
c70c94b4
DA
467}
468
dc323ce8
SE
469static inline char
470mispred_str(struct branch_entry *br)
471{
472 if (!(br->flags.mispred || br->flags.predicted))
473 return '-';
474
475 return br->flags.predicted ? 'P' : 'M';
476}
477
a3dff304 478static void print_sample_brstack(struct perf_sample *sample)
dc323ce8
SE
479{
480 struct branch_stack *br = sample->branch_stack;
481 u64 i;
482
483 if (!(br && br->nr))
484 return;
485
486 for (i = 0; i < br->nr; i++) {
487 printf(" 0x%"PRIx64"/0x%"PRIx64"/%c/%c/%c/%d ",
488 br->entries[i].from,
489 br->entries[i].to,
490 mispred_str( br->entries + i),
491 br->entries[i].flags.in_tx? 'X' : '-',
492 br->entries[i].flags.abort? 'A' : '-',
493 br->entries[i].flags.cycles);
494 }
495}
496
a3dff304
ACM
497static void print_sample_brstacksym(struct perf_sample *sample,
498 struct thread *thread)
dc323ce8
SE
499{
500 struct branch_stack *br = sample->branch_stack;
501 struct addr_location alf, alt;
dc323ce8
SE
502 u64 i, from, to;
503
504 if (!(br && br->nr))
505 return;
506
507 for (i = 0; i < br->nr; i++) {
508
509 memset(&alf, 0, sizeof(alf));
510 memset(&alt, 0, sizeof(alt));
511 from = br->entries[i].from;
512 to = br->entries[i].to;
513
473398a2 514 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, from, &alf);
dc323ce8
SE
515 if (alf.map)
516 alf.sym = map__find_symbol(alf.map, alf.addr, NULL);
517
473398a2 518 thread__find_addr_map(thread, sample->cpumode, MAP__FUNCTION, to, &alt);
dc323ce8
SE
519 if (alt.map)
520 alt.sym = map__find_symbol(alt.map, alt.addr, NULL);
521
522 symbol__fprintf_symname_offs(alf.sym, &alf, stdout);
523 putchar('/');
524 symbol__fprintf_symname_offs(alt.sym, &alt, stdout);
525 printf("/%c/%c/%c/%d ",
526 mispred_str( br->entries + i),
527 br->entries[i].flags.in_tx? 'X' : '-',
528 br->entries[i].flags.abort? 'A' : '-',
529 br->entries[i].flags.cycles);
530 }
531}
532
533
a3dff304 534static void print_sample_addr(struct perf_sample *sample,
7cec0922
DA
535 struct thread *thread,
536 struct perf_event_attr *attr)
537{
538 struct addr_location al;
7cec0922
DA
539
540 printf("%16" PRIx64, sample->addr);
541
542 if (!sample_addr_correlates_sym(attr))
543 return;
544
c2740a87 545 thread__resolve(thread, &al, sample);
7cec0922
DA
546
547 if (PRINT_FIELD(SYM)) {
547a92e0 548 printf(" ");
a978f2ab
AN
549 if (PRINT_FIELD(SYMOFFSET))
550 symbol__fprintf_symname_offs(al.sym, &al, stdout);
551 else
552 symbol__fprintf_symname(al.sym, stdout);
7cec0922
DA
553 }
554
555 if (PRINT_FIELD(DSO)) {
547a92e0
AN
556 printf(" (");
557 map__fprintf_dsoname(al.map, stdout);
558 printf(")");
7cec0922
DA
559 }
560}
561
a3dff304 562static void print_sample_bts(struct perf_sample *sample,
95582596 563 struct perf_evsel *evsel,
a2cb3cf2
AH
564 struct thread *thread,
565 struct addr_location *al)
95582596
AN
566{
567 struct perf_event_attr *attr = &evsel->attr;
8066be5f 568 bool print_srcline_last = false;
95582596
AN
569
570 /* print branch_from information */
571 if (PRINT_FIELD(IP)) {
8066be5f 572 unsigned int print_opts = output[attr->type].print_ip_opts;
e557b674 573 struct callchain_cursor *cursor = NULL;
8066be5f 574
6f736735 575 if (symbol_conf.use_callchain && sample->callchain &&
e557b674 576 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
6f736735 577 sample, NULL, NULL, scripting_max_stack) == 0)
e557b674 578 cursor = &callchain_cursor;
6f736735
ACM
579
580 if (cursor == NULL) {
581 putchar(' ');
e20ab86e 582 if (print_opts & EVSEL__PRINT_SRCLINE) {
8066be5f 583 print_srcline_last = true;
e20ab86e 584 print_opts &= ~EVSEL__PRINT_SRCLINE;
8066be5f 585 }
6f736735
ACM
586 } else
587 putchar('\n');
588
589 sample__fprintf_sym(sample, al, 0, print_opts, cursor, stdout);
95582596
AN
590 }
591
95582596 592 /* print branch_to information */
243be3dd
AH
593 if (PRINT_FIELD(ADDR) ||
594 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
578bea40
AH
595 !output[attr->type].user_set)) {
596 printf(" => ");
a3dff304 597 print_sample_addr(sample, thread, attr);
578bea40 598 }
95582596 599
8066be5f
AH
600 if (print_srcline_last)
601 map__fprintf_srcline(al->map, al->addr, "\n ", stdout);
602
95582596
AN
603 printf("\n");
604}
605
400ea6d3
AH
606static void print_sample_flags(u32 flags)
607{
608 const char *chars = PERF_IP_FLAG_CHARS;
609 const int n = strlen(PERF_IP_FLAG_CHARS);
610 char str[33];
611 int i, pos = 0;
612
613 for (i = 0; i < n; i++, flags >>= 1) {
614 if (flags & 1)
615 str[pos++] = chars[i];
616 }
617 for (; i < 32; i++, flags >>= 1) {
618 if (flags & 1)
619 str[pos++] = '?';
620 }
621 str[pos] = 0;
622 printf(" %-4s ", str);
623}
624
30372f04
WN
625struct printer_data {
626 int line_no;
627 bool hit_nul;
628 bool is_printable;
629};
630
631static void
632print_sample_bpf_output_printer(enum binary_printer_ops op,
633 unsigned int val,
634 void *extra)
635{
636 unsigned char ch = (unsigned char)val;
637 struct printer_data *printer_data = extra;
638
639 switch (op) {
640 case BINARY_PRINT_DATA_BEGIN:
641 printf("\n");
642 break;
643 case BINARY_PRINT_LINE_BEGIN:
644 printf("%17s", !printer_data->line_no ? "BPF output:" :
645 " ");
646 break;
647 case BINARY_PRINT_ADDR:
648 printf(" %04x:", val);
649 break;
650 case BINARY_PRINT_NUM_DATA:
651 printf(" %02x", val);
652 break;
653 case BINARY_PRINT_NUM_PAD:
654 printf(" ");
655 break;
656 case BINARY_PRINT_SEP:
657 printf(" ");
658 break;
659 case BINARY_PRINT_CHAR_DATA:
660 if (printer_data->hit_nul && ch)
661 printer_data->is_printable = false;
662
663 if (!isprint(ch)) {
664 printf("%c", '.');
665
666 if (!printer_data->is_printable)
667 break;
668
669 if (ch == '\0')
670 printer_data->hit_nul = true;
671 else
672 printer_data->is_printable = false;
673 } else {
674 printf("%c", ch);
675 }
676 break;
677 case BINARY_PRINT_CHAR_PAD:
678 printf(" ");
679 break;
680 case BINARY_PRINT_LINE_END:
681 printf("\n");
682 printer_data->line_no++;
683 break;
684 case BINARY_PRINT_DATA_END:
685 default:
686 break;
687 }
688}
689
690static void print_sample_bpf_output(struct perf_sample *sample)
691{
692 unsigned int nr_bytes = sample->raw_size;
693 struct printer_data printer_data = {0, false, true};
694
695 print_binary(sample->raw_data, nr_bytes, 8,
696 print_sample_bpf_output_printer, &printer_data);
697
698 if (printer_data.is_printable && printer_data.hit_nul)
699 printf("%17s \"%s\"\n", "BPF string:",
700 (char *)(sample->raw_data));
701}
702
809e9423
JO
703struct perf_script {
704 struct perf_tool tool;
705 struct perf_session *session;
706 bool show_task_events;
707 bool show_mmap_events;
708 bool show_switch_events;
cfc8874a
JO
709 bool allocated;
710 struct cpu_map *cpus;
711 struct thread_map *threads;
9cdbc409 712 int name_width;
809e9423
JO
713};
714
9cdbc409
JO
715static int perf_evlist__max_name_len(struct perf_evlist *evlist)
716{
717 struct perf_evsel *evsel;
718 int max = 0;
719
720 evlist__for_each(evlist, evsel) {
721 int len = strlen(perf_evsel__name(evsel));
722
723 max = MAX(len, max);
724 }
725
726 return max;
727}
728
c19ac912
JO
729static size_t data_src__printf(u64 data_src)
730{
731 struct mem_info mi = { .data_src.val = data_src };
732 char decode[100];
733 char out[100];
734 static int maxlen;
735 int len;
736
737 perf_script__meminfo_scnprintf(decode, 100, &mi);
738
739 len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
740 if (maxlen < len)
741 maxlen = len;
742
743 return printf("%-*s", maxlen, out);
744}
745
a3dff304 746static void process_event(struct perf_script *script,
809e9423
JO
747 struct perf_sample *sample, struct perf_evsel *evsel,
748 struct addr_location *al)
be6d842a 749{
f9d5d549 750 struct thread *thread = al->thread;
9e69c210 751 struct perf_event_attr *attr = &evsel->attr;
1424dc96 752
2c9e45f7 753 if (output[attr->type].fields == 0)
1424dc96
DA
754 return;
755
fcf65bf1 756 print_sample_start(sample, thread, evsel);
745f43e3 757
535aeaae
JO
758 if (PRINT_FIELD(PERIOD))
759 printf("%10" PRIu64 " ", sample->period);
760
e944d3d7
NK
761 if (PRINT_FIELD(EVNAME)) {
762 const char *evname = perf_evsel__name(evsel);
9cdbc409
JO
763
764 if (!script->name_width)
765 script->name_width = perf_evlist__max_name_len(script->session->evlist);
766
767 printf("%*s: ", script->name_width,
768 evname ? evname : "[unknown]");
e944d3d7
NK
769 }
770
400ea6d3
AH
771 if (print_flags)
772 print_sample_flags(sample->flags);
773
95582596 774 if (is_bts_event(attr)) {
a3dff304 775 print_sample_bts(sample, evsel, thread, al);
95582596
AN
776 return;
777 }
778
745f43e3 779 if (PRINT_FIELD(TRACE))
fcf65bf1
ACM
780 event_format__print(evsel->tp_format, sample->cpu,
781 sample->raw_data, sample->raw_size);
7cec0922 782 if (PRINT_FIELD(ADDR))
a3dff304 783 print_sample_addr(sample, thread, attr);
7cec0922 784
94ddddfa 785 if (PRINT_FIELD(DATA_SRC))
c19ac912 786 data_src__printf(sample->data_src);
94ddddfa
JO
787
788 if (PRINT_FIELD(WEIGHT))
789 printf("%16" PRIu64, sample->weight);
790
787bef17 791 if (PRINT_FIELD(IP)) {
e557b674 792 struct callchain_cursor *cursor = NULL;
6f736735 793
92231521 794 if (symbol_conf.use_callchain && sample->callchain &&
e557b674 795 thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
6f736735 796 sample, NULL, NULL, scripting_max_stack) == 0)
e557b674 797 cursor = &callchain_cursor;
a6ffaf91 798
6f736735
ACM
799 putchar(cursor ? '\n' : ' ');
800 sample__fprintf_sym(sample, al, 0, output[attr->type].print_ip_opts, cursor, stdout);
c0230b2b
DA
801 }
802
fc36f948 803 if (PRINT_FIELD(IREGS))
a3dff304 804 print_sample_iregs(sample, attr);
fc36f948 805
dc323ce8 806 if (PRINT_FIELD(BRSTACK))
a3dff304 807 print_sample_brstack(sample);
dc323ce8 808 else if (PRINT_FIELD(BRSTACKSYM))
a3dff304 809 print_sample_brstacksym(sample, thread);
dc323ce8 810
30372f04
WN
811 if (perf_evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
812 print_sample_bpf_output(sample);
813
c70c94b4 814 printf("\n");
be6d842a
DA
815}
816
956ffd02
TZ
817static struct scripting_ops *scripting_ops;
818
36e33c53
JO
819static void __process_stat(struct perf_evsel *counter, u64 tstamp)
820{
821 int nthreads = thread_map__nr(counter->threads);
822 int ncpus = perf_evsel__nr_cpus(counter);
823 int cpu, thread;
824 static int header_printed;
825
826 if (counter->system_wide)
827 nthreads = 1;
828
829 if (!header_printed) {
830 printf("%3s %8s %15s %15s %15s %15s %s\n",
831 "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
832 header_printed = 1;
833 }
834
835 for (thread = 0; thread < nthreads; thread++) {
836 for (cpu = 0; cpu < ncpus; cpu++) {
837 struct perf_counts_values *counts;
838
839 counts = perf_counts(counter->counts, cpu, thread);
840
841 printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
842 counter->cpus->map[cpu],
843 thread_map__pid(counter->threads, thread),
844 counts->val,
845 counts->ena,
846 counts->run,
847 tstamp,
848 perf_evsel__name(counter));
849 }
850 }
851}
852
e099eba8
JO
853static void process_stat(struct perf_evsel *counter, u64 tstamp)
854{
855 if (scripting_ops && scripting_ops->process_stat)
856 scripting_ops->process_stat(&stat_config, counter, tstamp);
36e33c53
JO
857 else
858 __process_stat(counter, tstamp);
e099eba8
JO
859}
860
861static void process_stat_interval(u64 tstamp)
862{
863 if (scripting_ops && scripting_ops->process_stat_interval)
864 scripting_ops->process_stat_interval(tstamp);
865}
866
956ffd02
TZ
867static void setup_scripting(void)
868{
16c632de 869 setup_perl_scripting();
7e4b21b8 870 setup_python_scripting();
956ffd02
TZ
871}
872
d445dd2a
AH
873static int flush_scripting(void)
874{
2aaecfc5 875 return scripting_ops ? scripting_ops->flush_script() : 0;
d445dd2a
AH
876}
877
956ffd02
TZ
878static int cleanup_scripting(void)
879{
133dc4c3 880 pr_debug("\nperf script stopped\n");
3824a4e8 881
2aaecfc5 882 return scripting_ops ? scripting_ops->stop_script() : 0;
956ffd02
TZ
883}
884
809e9423 885static int process_sample_event(struct perf_tool *tool,
d20deb64 886 union perf_event *event,
8115d60c 887 struct perf_sample *sample,
9e69c210 888 struct perf_evsel *evsel,
743eb868 889 struct machine *machine)
5f9c39dc 890{
809e9423 891 struct perf_script *scr = container_of(tool, struct perf_script, tool);
e7984b7b 892 struct addr_location al;
5f9c39dc 893
1424dc96
DA
894 if (debug_mode) {
895 if (sample->time < last_timestamp) {
896 pr_err("Samples misordered, previous: %" PRIu64
897 " this: %" PRIu64 "\n", last_timestamp,
898 sample->time);
899 nr_unordered++;
e1889d75 900 }
1424dc96
DA
901 last_timestamp = sample->time;
902 return 0;
5f9c39dc 903 }
5d67be97 904
bb3eb566 905 if (machine__resolve(machine, &al, sample) < 0) {
e7984b7b
DA
906 pr_err("problem processing %d event, skipping it.\n",
907 event->header.type);
908 return -1;
909 }
910
911 if (al.filtered)
b91fc39f 912 goto out_put;
e7984b7b 913
5d67be97 914 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
b91fc39f 915 goto out_put;
5d67be97 916
2aaecfc5
JO
917 if (scripting_ops)
918 scripting_ops->process_event(event, sample, evsel, &al);
919 else
a3dff304 920 process_event(scr, sample, evsel, &al);
2aaecfc5 921
b91fc39f
ACM
922out_put:
923 addr_location__put(&al);
5f9c39dc
FW
924 return 0;
925}
926
7ea95727
AH
927static int process_attr(struct perf_tool *tool, union perf_event *event,
928 struct perf_evlist **pevlist)
929{
930 struct perf_script *scr = container_of(tool, struct perf_script, tool);
931 struct perf_evlist *evlist;
932 struct perf_evsel *evsel, *pos;
933 int err;
934
935 err = perf_event__process_attr(tool, event, pevlist);
936 if (err)
937 return err;
938
939 evlist = *pevlist;
940 evsel = perf_evlist__last(*pevlist);
941
942 if (evsel->attr.type >= PERF_TYPE_MAX)
943 return 0;
944
0050f7aa 945 evlist__for_each(evlist, pos) {
7ea95727
AH
946 if (pos->attr.type == evsel->attr.type && pos != evsel)
947 return 0;
948 }
949
950 set_print_ip_opts(&evsel->attr);
951
d2b5a315
JO
952 if (evsel->attr.sample_type)
953 err = perf_evsel__check_attr(evsel, scr->session);
954
955 return err;
7ea95727
AH
956}
957
ad7ebb9a
NK
958static int process_comm_event(struct perf_tool *tool,
959 union perf_event *event,
960 struct perf_sample *sample,
961 struct machine *machine)
962{
963 struct thread *thread;
964 struct perf_script *script = container_of(tool, struct perf_script, tool);
965 struct perf_session *session = script->session;
06b234ec 966 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
ad7ebb9a
NK
967 int ret = -1;
968
969 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
970 if (thread == NULL) {
971 pr_debug("problem processing COMM event, skipping it.\n");
972 return -1;
973 }
974
975 if (perf_event__process_comm(tool, event, sample, machine) < 0)
976 goto out;
977
978 if (!evsel->attr.sample_id_all) {
979 sample->cpu = 0;
980 sample->time = 0;
981 sample->tid = event->comm.tid;
982 sample->pid = event->comm.pid;
983 }
984 print_sample_start(sample, thread, evsel);
985 perf_event__fprintf(event, stdout);
986 ret = 0;
ad7ebb9a 987out:
b91fc39f 988 thread__put(thread);
ad7ebb9a
NK
989 return ret;
990}
991
992static int process_fork_event(struct perf_tool *tool,
993 union perf_event *event,
994 struct perf_sample *sample,
995 struct machine *machine)
996{
997 struct thread *thread;
998 struct perf_script *script = container_of(tool, struct perf_script, tool);
999 struct perf_session *session = script->session;
06b234ec 1000 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
ad7ebb9a
NK
1001
1002 if (perf_event__process_fork(tool, event, sample, machine) < 0)
1003 return -1;
1004
1005 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1006 if (thread == NULL) {
1007 pr_debug("problem processing FORK event, skipping it.\n");
1008 return -1;
1009 }
1010
1011 if (!evsel->attr.sample_id_all) {
1012 sample->cpu = 0;
1013 sample->time = event->fork.time;
1014 sample->tid = event->fork.tid;
1015 sample->pid = event->fork.pid;
1016 }
1017 print_sample_start(sample, thread, evsel);
1018 perf_event__fprintf(event, stdout);
b91fc39f 1019 thread__put(thread);
ad7ebb9a
NK
1020
1021 return 0;
1022}
1023static int process_exit_event(struct perf_tool *tool,
1024 union perf_event *event,
1025 struct perf_sample *sample,
1026 struct machine *machine)
1027{
b91fc39f 1028 int err = 0;
ad7ebb9a
NK
1029 struct thread *thread;
1030 struct perf_script *script = container_of(tool, struct perf_script, tool);
1031 struct perf_session *session = script->session;
06b234ec 1032 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
ad7ebb9a
NK
1033
1034 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
1035 if (thread == NULL) {
1036 pr_debug("problem processing EXIT event, skipping it.\n");
1037 return -1;
1038 }
1039
1040 if (!evsel->attr.sample_id_all) {
1041 sample->cpu = 0;
1042 sample->time = 0;
53ff6bc3
AH
1043 sample->tid = event->fork.tid;
1044 sample->pid = event->fork.pid;
ad7ebb9a
NK
1045 }
1046 print_sample_start(sample, thread, evsel);
1047 perf_event__fprintf(event, stdout);
1048
1049 if (perf_event__process_exit(tool, event, sample, machine) < 0)
b91fc39f 1050 err = -1;
ad7ebb9a 1051
b91fc39f
ACM
1052 thread__put(thread);
1053 return err;
ad7ebb9a
NK
1054}
1055
ba1ddf42
NK
1056static int process_mmap_event(struct perf_tool *tool,
1057 union perf_event *event,
1058 struct perf_sample *sample,
1059 struct machine *machine)
1060{
1061 struct thread *thread;
1062 struct perf_script *script = container_of(tool, struct perf_script, tool);
1063 struct perf_session *session = script->session;
06b234ec 1064 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
ba1ddf42
NK
1065
1066 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
1067 return -1;
1068
1069 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
1070 if (thread == NULL) {
1071 pr_debug("problem processing MMAP event, skipping it.\n");
1072 return -1;
1073 }
1074
1075 if (!evsel->attr.sample_id_all) {
1076 sample->cpu = 0;
1077 sample->time = 0;
1078 sample->tid = event->mmap.tid;
1079 sample->pid = event->mmap.pid;
1080 }
1081 print_sample_start(sample, thread, evsel);
1082 perf_event__fprintf(event, stdout);
b91fc39f 1083 thread__put(thread);
ba1ddf42
NK
1084 return 0;
1085}
1086
1087static int process_mmap2_event(struct perf_tool *tool,
1088 union perf_event *event,
1089 struct perf_sample *sample,
1090 struct machine *machine)
1091{
1092 struct thread *thread;
1093 struct perf_script *script = container_of(tool, struct perf_script, tool);
1094 struct perf_session *session = script->session;
06b234ec 1095 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
ba1ddf42
NK
1096
1097 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
1098 return -1;
1099
1100 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
1101 if (thread == NULL) {
1102 pr_debug("problem processing MMAP2 event, skipping it.\n");
1103 return -1;
1104 }
1105
1106 if (!evsel->attr.sample_id_all) {
1107 sample->cpu = 0;
1108 sample->time = 0;
1109 sample->tid = event->mmap2.tid;
1110 sample->pid = event->mmap2.pid;
1111 }
1112 print_sample_start(sample, thread, evsel);
1113 perf_event__fprintf(event, stdout);
b91fc39f 1114 thread__put(thread);
ba1ddf42
NK
1115 return 0;
1116}
1117
7c14898b
AH
1118static int process_switch_event(struct perf_tool *tool,
1119 union perf_event *event,
1120 struct perf_sample *sample,
1121 struct machine *machine)
1122{
1123 struct thread *thread;
1124 struct perf_script *script = container_of(tool, struct perf_script, tool);
1125 struct perf_session *session = script->session;
1126 struct perf_evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
1127
1128 if (perf_event__process_switch(tool, event, sample, machine) < 0)
1129 return -1;
1130
1131 thread = machine__findnew_thread(machine, sample->pid,
1132 sample->tid);
1133 if (thread == NULL) {
1134 pr_debug("problem processing SWITCH event, skipping it.\n");
1135 return -1;
1136 }
1137
1138 print_sample_start(sample, thread, evsel);
1139 perf_event__fprintf(event, stdout);
1140 thread__put(thread);
1141 return 0;
1142}
1143
1d037ca1 1144static void sig_handler(int sig __maybe_unused)
c239da3b
TZ
1145{
1146 session_done = 1;
1147}
1148
6f3e5eda 1149static int __cmd_script(struct perf_script *script)
5f9c39dc 1150{
6fcf7ddb
FW
1151 int ret;
1152
c239da3b
TZ
1153 signal(SIGINT, sig_handler);
1154
ad7ebb9a
NK
1155 /* override event processing functions */
1156 if (script->show_task_events) {
1157 script->tool.comm = process_comm_event;
1158 script->tool.fork = process_fork_event;
1159 script->tool.exit = process_exit_event;
1160 }
ba1ddf42
NK
1161 if (script->show_mmap_events) {
1162 script->tool.mmap = process_mmap_event;
1163 script->tool.mmap2 = process_mmap2_event;
1164 }
7c14898b
AH
1165 if (script->show_switch_events)
1166 script->tool.context_switch = process_switch_event;
ad7ebb9a 1167
b7b61cbe 1168 ret = perf_session__process_events(script->session);
6fcf7ddb 1169
6d8afb56 1170 if (debug_mode)
9486aa38 1171 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
6fcf7ddb
FW
1172
1173 return ret;
5f9c39dc
FW
1174}
1175
956ffd02
TZ
1176struct script_spec {
1177 struct list_head node;
1178 struct scripting_ops *ops;
1179 char spec[0];
1180};
1181
eccdfe2d 1182static LIST_HEAD(script_specs);
956ffd02
TZ
1183
1184static struct script_spec *script_spec__new(const char *spec,
1185 struct scripting_ops *ops)
1186{
1187 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
1188
1189 if (s != NULL) {
1190 strcpy(s->spec, spec);
1191 s->ops = ops;
1192 }
1193
1194 return s;
1195}
1196
956ffd02
TZ
1197static void script_spec__add(struct script_spec *s)
1198{
1199 list_add_tail(&s->node, &script_specs);
1200}
1201
1202static struct script_spec *script_spec__find(const char *spec)
1203{
1204 struct script_spec *s;
1205
1206 list_for_each_entry(s, &script_specs, node)
1207 if (strcasecmp(s->spec, spec) == 0)
1208 return s;
1209 return NULL;
1210}
1211
956ffd02
TZ
1212int script_spec_register(const char *spec, struct scripting_ops *ops)
1213{
1214 struct script_spec *s;
1215
1216 s = script_spec__find(spec);
1217 if (s)
1218 return -1;
1219
8560bae0 1220 s = script_spec__new(spec, ops);
956ffd02
TZ
1221 if (!s)
1222 return -1;
8560bae0
TS
1223 else
1224 script_spec__add(s);
956ffd02
TZ
1225
1226 return 0;
1227}
1228
1229static struct scripting_ops *script_spec__lookup(const char *spec)
1230{
1231 struct script_spec *s = script_spec__find(spec);
1232 if (!s)
1233 return NULL;
1234
1235 return s->ops;
1236}
1237
1238static void list_available_languages(void)
1239{
1240 struct script_spec *s;
1241
1242 fprintf(stderr, "\n");
1243 fprintf(stderr, "Scripting language extensions (used in "
133dc4c3 1244 "perf script -s [spec:]script.[spec]):\n\n");
956ffd02
TZ
1245
1246 list_for_each_entry(s, &script_specs, node)
1247 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
1248
1249 fprintf(stderr, "\n");
1250}
1251
1d037ca1
IT
1252static int parse_scriptname(const struct option *opt __maybe_unused,
1253 const char *str, int unset __maybe_unused)
956ffd02
TZ
1254{
1255 char spec[PATH_MAX];
1256 const char *script, *ext;
1257 int len;
1258
f526d68b 1259 if (strcmp(str, "lang") == 0) {
956ffd02 1260 list_available_languages();
f526d68b 1261 exit(0);
956ffd02
TZ
1262 }
1263
1264 script = strchr(str, ':');
1265 if (script) {
1266 len = script - str;
1267 if (len >= PATH_MAX) {
1268 fprintf(stderr, "invalid language specifier");
1269 return -1;
1270 }
1271 strncpy(spec, str, len);
1272 spec[len] = '\0';
1273 scripting_ops = script_spec__lookup(spec);
1274 if (!scripting_ops) {
1275 fprintf(stderr, "invalid language specifier");
1276 return -1;
1277 }
1278 script++;
1279 } else {
1280 script = str;
d1e95bb5 1281 ext = strrchr(script, '.');
956ffd02
TZ
1282 if (!ext) {
1283 fprintf(stderr, "invalid script extension");
1284 return -1;
1285 }
1286 scripting_ops = script_spec__lookup(++ext);
1287 if (!scripting_ops) {
1288 fprintf(stderr, "invalid script extension");
1289 return -1;
1290 }
1291 }
1292
1293 script_name = strdup(script);
1294
1295 return 0;
1296}
1297
1d037ca1
IT
1298static int parse_output_fields(const struct option *opt __maybe_unused,
1299 const char *arg, int unset __maybe_unused)
745f43e3
DA
1300{
1301 char *tok;
50ca19ae 1302 int i, imax = ARRAY_SIZE(all_output_options);
2c9e45f7 1303 int j;
745f43e3
DA
1304 int rc = 0;
1305 char *str = strdup(arg);
1424dc96 1306 int type = -1;
745f43e3
DA
1307
1308 if (!str)
1309 return -ENOMEM;
1310
2c9e45f7
DA
1311 /* first word can state for which event type the user is specifying
1312 * the fields. If no type exists, the specified fields apply to all
1313 * event types found in the file minus the invalid fields for a type.
1424dc96 1314 */
2c9e45f7
DA
1315 tok = strchr(str, ':');
1316 if (tok) {
1317 *tok = '\0';
1318 tok++;
1319 if (!strcmp(str, "hw"))
1320 type = PERF_TYPE_HARDWARE;
1321 else if (!strcmp(str, "sw"))
1322 type = PERF_TYPE_SOFTWARE;
1323 else if (!strcmp(str, "trace"))
1324 type = PERF_TYPE_TRACEPOINT;
0817a6a3
AS
1325 else if (!strcmp(str, "raw"))
1326 type = PERF_TYPE_RAW;
27cfef00
WN
1327 else if (!strcmp(str, "break"))
1328 type = PERF_TYPE_BREAKPOINT;
2c9e45f7
DA
1329 else {
1330 fprintf(stderr, "Invalid event type in field string.\n");
38efb539
RR
1331 rc = -EINVAL;
1332 goto out;
2c9e45f7
DA
1333 }
1334
1335 if (output[type].user_set)
1336 pr_warning("Overriding previous field request for %s events.\n",
1337 event_type(type));
1338
1339 output[type].fields = 0;
1340 output[type].user_set = true;
9cbdb702 1341 output[type].wildcard_set = false;
2c9e45f7
DA
1342
1343 } else {
1344 tok = str;
1345 if (strlen(str) == 0) {
1346 fprintf(stderr,
1347 "Cannot set fields to 'none' for all event types.\n");
1348 rc = -EINVAL;
1349 goto out;
1350 }
1351
1352 if (output_set_by_user())
1353 pr_warning("Overriding previous field request for all events.\n");
1354
1355 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1356 output[j].fields = 0;
1357 output[j].user_set = true;
9cbdb702 1358 output[j].wildcard_set = true;
2c9e45f7 1359 }
745f43e3
DA
1360 }
1361
400ea6d3 1362 for (tok = strtok(tok, ","); tok; tok = strtok(NULL, ",")) {
745f43e3 1363 for (i = 0; i < imax; ++i) {
2c9e45f7 1364 if (strcmp(tok, all_output_options[i].str) == 0)
745f43e3 1365 break;
745f43e3 1366 }
400ea6d3
AH
1367 if (i == imax && strcmp(tok, "flags") == 0) {
1368 print_flags = true;
1369 continue;
1370 }
745f43e3 1371 if (i == imax) {
2c9e45f7 1372 fprintf(stderr, "Invalid field requested.\n");
745f43e3 1373 rc = -EINVAL;
2c9e45f7 1374 goto out;
745f43e3
DA
1375 }
1376
2c9e45f7
DA
1377 if (type == -1) {
1378 /* add user option to all events types for
1379 * which it is valid
1380 */
1381 for (j = 0; j < PERF_TYPE_MAX; ++j) {
1382 if (output[j].invalid_fields & all_output_options[i].field) {
1383 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
1384 all_output_options[i].str, event_type(j));
1385 } else
1386 output[j].fields |= all_output_options[i].field;
1387 }
1388 } else {
1389 if (output[type].invalid_fields & all_output_options[i].field) {
1390 fprintf(stderr, "\'%s\' not valid for %s events.\n",
1391 all_output_options[i].str, event_type(type));
1392
1393 rc = -EINVAL;
1394 goto out;
1395 }
1396 output[type].fields |= all_output_options[i].field;
1397 }
745f43e3
DA
1398 }
1399
2c9e45f7
DA
1400 if (type >= 0) {
1401 if (output[type].fields == 0) {
1402 pr_debug("No fields requested for %s type. "
1403 "Events will not be displayed.\n", event_type(type));
1404 }
1405 }
745f43e3 1406
2c9e45f7 1407out:
745f43e3
DA
1408 free(str);
1409 return rc;
1410}
1411
008f29d3
SB
1412/* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1413static int is_directory(const char *base_path, const struct dirent *dent)
1414{
1415 char path[PATH_MAX];
1416 struct stat st;
1417
1418 sprintf(path, "%s/%s", base_path, dent->d_name);
1419 if (stat(path, &st))
1420 return 0;
1421
1422 return S_ISDIR(st.st_mode);
1423}
1424
a5e8e825
ACM
1425#define for_each_lang(scripts_path, scripts_dir, lang_dirent) \
1426 while ((lang_dirent = readdir(scripts_dir)) != NULL) \
1427 if ((lang_dirent->d_type == DT_DIR || \
1428 (lang_dirent->d_type == DT_UNKNOWN && \
1429 is_directory(scripts_path, lang_dirent))) && \
1430 (strcmp(lang_dirent->d_name, ".")) && \
1431 (strcmp(lang_dirent->d_name, "..")))
1432
1433#define for_each_script(lang_path, lang_dir, script_dirent) \
1434 while ((script_dirent = readdir(lang_dir)) != NULL) \
1435 if (script_dirent->d_type != DT_DIR && \
1436 (script_dirent->d_type != DT_UNKNOWN || \
1437 !is_directory(lang_path, script_dirent)))
4b9c0c59
TZ
1438
1439
1440#define RECORD_SUFFIX "-record"
1441#define REPORT_SUFFIX "-report"
1442
1443struct script_desc {
1444 struct list_head node;
1445 char *name;
1446 char *half_liner;
1447 char *args;
1448};
1449
eccdfe2d 1450static LIST_HEAD(script_descs);
4b9c0c59
TZ
1451
1452static struct script_desc *script_desc__new(const char *name)
1453{
1454 struct script_desc *s = zalloc(sizeof(*s));
1455
b5b87312 1456 if (s != NULL && name)
4b9c0c59
TZ
1457 s->name = strdup(name);
1458
1459 return s;
1460}
1461
1462static void script_desc__delete(struct script_desc *s)
1463{
74cf249d
ACM
1464 zfree(&s->name);
1465 zfree(&s->half_liner);
1466 zfree(&s->args);
4b9c0c59
TZ
1467 free(s);
1468}
1469
1470static void script_desc__add(struct script_desc *s)
1471{
1472 list_add_tail(&s->node, &script_descs);
1473}
1474
1475static struct script_desc *script_desc__find(const char *name)
1476{
1477 struct script_desc *s;
1478
1479 list_for_each_entry(s, &script_descs, node)
1480 if (strcasecmp(s->name, name) == 0)
1481 return s;
1482 return NULL;
1483}
1484
1485static struct script_desc *script_desc__findnew(const char *name)
1486{
1487 struct script_desc *s = script_desc__find(name);
1488
1489 if (s)
1490 return s;
1491
1492 s = script_desc__new(name);
1493 if (!s)
1494 goto out_delete_desc;
1495
1496 script_desc__add(s);
1497
1498 return s;
1499
1500out_delete_desc:
1501 script_desc__delete(s);
1502
1503 return NULL;
1504}
1505
965bb6be 1506static const char *ends_with(const char *str, const char *suffix)
4b9c0c59
TZ
1507{
1508 size_t suffix_len = strlen(suffix);
965bb6be 1509 const char *p = str;
4b9c0c59
TZ
1510
1511 if (strlen(str) > suffix_len) {
1512 p = str + strlen(str) - suffix_len;
1513 if (!strncmp(p, suffix, suffix_len))
1514 return p;
1515 }
1516
1517 return NULL;
1518}
1519
4b9c0c59
TZ
1520static int read_script_info(struct script_desc *desc, const char *filename)
1521{
1522 char line[BUFSIZ], *p;
1523 FILE *fp;
1524
1525 fp = fopen(filename, "r");
1526 if (!fp)
1527 return -1;
1528
1529 while (fgets(line, sizeof(line), fp)) {
1530 p = ltrim(line);
1531 if (strlen(p) == 0)
1532 continue;
1533 if (*p != '#')
1534 continue;
1535 p++;
1536 if (strlen(p) && *p == '!')
1537 continue;
1538
1539 p = ltrim(p);
1540 if (strlen(p) && p[strlen(p) - 1] == '\n')
1541 p[strlen(p) - 1] = '\0';
1542
1543 if (!strncmp(p, "description:", strlen("description:"))) {
1544 p += strlen("description:");
1545 desc->half_liner = strdup(ltrim(p));
1546 continue;
1547 }
1548
1549 if (!strncmp(p, "args:", strlen("args:"))) {
1550 p += strlen("args:");
1551 desc->args = strdup(ltrim(p));
1552 continue;
1553 }
1554 }
1555
1556 fclose(fp);
1557
1558 return 0;
1559}
1560
38efb539
RR
1561static char *get_script_root(struct dirent *script_dirent, const char *suffix)
1562{
1563 char *script_root, *str;
1564
1565 script_root = strdup(script_dirent->d_name);
1566 if (!script_root)
1567 return NULL;
1568
1569 str = (char *)ends_with(script_root, suffix);
1570 if (!str) {
1571 free(script_root);
1572 return NULL;
1573 }
1574
1575 *str = '\0';
1576 return script_root;
1577}
1578
1d037ca1
IT
1579static int list_available_scripts(const struct option *opt __maybe_unused,
1580 const char *s __maybe_unused,
1581 int unset __maybe_unused)
4b9c0c59 1582{
a5e8e825 1583 struct dirent *script_dirent, *lang_dirent;
4b9c0c59
TZ
1584 char scripts_path[MAXPATHLEN];
1585 DIR *scripts_dir, *lang_dir;
1586 char script_path[MAXPATHLEN];
1587 char lang_path[MAXPATHLEN];
1588 struct script_desc *desc;
1589 char first_half[BUFSIZ];
1590 char *script_root;
4b9c0c59 1591
46113a54 1592 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
4b9c0c59
TZ
1593
1594 scripts_dir = opendir(scripts_path);
1595 if (!scripts_dir)
1596 return -1;
1597
a5e8e825 1598 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
4b9c0c59 1599 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
a5e8e825 1600 lang_dirent->d_name);
4b9c0c59
TZ
1601 lang_dir = opendir(lang_path);
1602 if (!lang_dir)
1603 continue;
1604
a5e8e825
ACM
1605 for_each_script(lang_path, lang_dir, script_dirent) {
1606 script_root = get_script_root(script_dirent, REPORT_SUFFIX);
38efb539 1607 if (script_root) {
4b9c0c59
TZ
1608 desc = script_desc__findnew(script_root);
1609 snprintf(script_path, MAXPATHLEN, "%s/%s",
a5e8e825 1610 lang_path, script_dirent->d_name);
4b9c0c59 1611 read_script_info(desc, script_path);
38efb539 1612 free(script_root);
4b9c0c59 1613 }
4b9c0c59
TZ
1614 }
1615 }
1616
1617 fprintf(stdout, "List of available trace scripts:\n");
1618 list_for_each_entry(desc, &script_descs, node) {
1619 sprintf(first_half, "%s %s", desc->name,
1620 desc->args ? desc->args : "");
1621 fprintf(stdout, " %-36s %s\n", first_half,
1622 desc->half_liner ? desc->half_liner : "");
1623 }
1624
1625 exit(0);
1626}
1627
49e639e2
FT
1628/*
1629 * Some scripts specify the required events in their "xxx-record" file,
1630 * this function will check if the events in perf.data match those
1631 * mentioned in the "xxx-record".
1632 *
1633 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1634 * which is covered well now. And new parsing code should be added to
1635 * cover the future complexing formats like event groups etc.
1636 */
1637static int check_ev_match(char *dir_name, char *scriptname,
1638 struct perf_session *session)
1639{
1640 char filename[MAXPATHLEN], evname[128];
1641 char line[BUFSIZ], *p;
1642 struct perf_evsel *pos;
1643 int match, len;
1644 FILE *fp;
1645
1646 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1647
1648 fp = fopen(filename, "r");
1649 if (!fp)
1650 return -1;
1651
1652 while (fgets(line, sizeof(line), fp)) {
1653 p = ltrim(line);
1654 if (*p == '#')
1655 continue;
1656
1657 while (strlen(p)) {
1658 p = strstr(p, "-e");
1659 if (!p)
1660 break;
1661
1662 p += 2;
1663 p = ltrim(p);
1664 len = strcspn(p, " \t");
1665 if (!len)
1666 break;
1667
1668 snprintf(evname, len + 1, "%s", p);
1669
1670 match = 0;
0050f7aa 1671 evlist__for_each(session->evlist, pos) {
49e639e2
FT
1672 if (!strcmp(perf_evsel__name(pos), evname)) {
1673 match = 1;
1674 break;
1675 }
1676 }
1677
1678 if (!match) {
1679 fclose(fp);
1680 return -1;
1681 }
1682 }
1683 }
1684
1685 fclose(fp);
1686 return 0;
1687}
1688
e5f3705e
FT
1689/*
1690 * Return -1 if none is found, otherwise the actual scripts number.
1691 *
1692 * Currently the only user of this function is the script browser, which
1693 * will list all statically runnable scripts, select one, execute it and
1694 * show the output in a perf browser.
1695 */
1696int find_scripts(char **scripts_array, char **scripts_path_array)
1697{
a5e8e825 1698 struct dirent *script_dirent, *lang_dirent;
49e639e2 1699 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
e5f3705e 1700 DIR *scripts_dir, *lang_dir;
49e639e2 1701 struct perf_session *session;
f5fc1412
JO
1702 struct perf_data_file file = {
1703 .path = input_name,
1704 .mode = PERF_DATA_MODE_READ,
1705 };
e5f3705e
FT
1706 char *temp;
1707 int i = 0;
1708
f5fc1412 1709 session = perf_session__new(&file, false, NULL);
49e639e2
FT
1710 if (!session)
1711 return -1;
1712
46113a54 1713 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
e5f3705e
FT
1714
1715 scripts_dir = opendir(scripts_path);
49e639e2
FT
1716 if (!scripts_dir) {
1717 perf_session__delete(session);
e5f3705e 1718 return -1;
49e639e2 1719 }
e5f3705e 1720
a5e8e825 1721 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
e5f3705e 1722 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
a5e8e825 1723 lang_dirent->d_name);
e5f3705e
FT
1724#ifdef NO_LIBPERL
1725 if (strstr(lang_path, "perl"))
1726 continue;
1727#endif
1728#ifdef NO_LIBPYTHON
1729 if (strstr(lang_path, "python"))
1730 continue;
1731#endif
1732
1733 lang_dir = opendir(lang_path);
1734 if (!lang_dir)
1735 continue;
1736
a5e8e825 1737 for_each_script(lang_path, lang_dir, script_dirent) {
e5f3705e 1738 /* Skip those real time scripts: xxxtop.p[yl] */
a5e8e825 1739 if (strstr(script_dirent->d_name, "top."))
e5f3705e
FT
1740 continue;
1741 sprintf(scripts_path_array[i], "%s/%s", lang_path,
a5e8e825
ACM
1742 script_dirent->d_name);
1743 temp = strchr(script_dirent->d_name, '.');
e5f3705e 1744 snprintf(scripts_array[i],
a5e8e825
ACM
1745 (temp - script_dirent->d_name) + 1,
1746 "%s", script_dirent->d_name);
49e639e2
FT
1747
1748 if (check_ev_match(lang_path,
1749 scripts_array[i], session))
1750 continue;
1751
e5f3705e
FT
1752 i++;
1753 }
49e639e2 1754 closedir(lang_dir);
e5f3705e
FT
1755 }
1756
49e639e2
FT
1757 closedir(scripts_dir);
1758 perf_session__delete(session);
e5f3705e
FT
1759 return i;
1760}
1761
3875294f
TZ
1762static char *get_script_path(const char *script_root, const char *suffix)
1763{
a5e8e825 1764 struct dirent *script_dirent, *lang_dirent;
3875294f
TZ
1765 char scripts_path[MAXPATHLEN];
1766 char script_path[MAXPATHLEN];
1767 DIR *scripts_dir, *lang_dir;
1768 char lang_path[MAXPATHLEN];
38efb539 1769 char *__script_root;
3875294f 1770
46113a54 1771 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3875294f
TZ
1772
1773 scripts_dir = opendir(scripts_path);
1774 if (!scripts_dir)
1775 return NULL;
1776
a5e8e825 1777 for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3875294f 1778 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
a5e8e825 1779 lang_dirent->d_name);
3875294f
TZ
1780 lang_dir = opendir(lang_path);
1781 if (!lang_dir)
1782 continue;
1783
a5e8e825
ACM
1784 for_each_script(lang_path, lang_dir, script_dirent) {
1785 __script_root = get_script_root(script_dirent, suffix);
38efb539
RR
1786 if (__script_root && !strcmp(script_root, __script_root)) {
1787 free(__script_root);
946ef2a2
NK
1788 closedir(lang_dir);
1789 closedir(scripts_dir);
3875294f 1790 snprintf(script_path, MAXPATHLEN, "%s/%s",
a5e8e825 1791 lang_path, script_dirent->d_name);
38efb539 1792 return strdup(script_path);
3875294f
TZ
1793 }
1794 free(__script_root);
1795 }
946ef2a2 1796 closedir(lang_dir);
3875294f 1797 }
946ef2a2 1798 closedir(scripts_dir);
3875294f 1799
38efb539 1800 return NULL;
3875294f
TZ
1801}
1802
b5b87312
TZ
1803static bool is_top_script(const char *script_path)
1804{
965bb6be 1805 return ends_with(script_path, "top") == NULL ? false : true;
b5b87312
TZ
1806}
1807
1808static int has_required_arg(char *script_path)
1809{
1810 struct script_desc *desc;
1811 int n_args = 0;
1812 char *p;
1813
1814 desc = script_desc__new(NULL);
1815
1816 if (read_script_info(desc, script_path))
1817 goto out;
1818
1819 if (!desc->args)
1820 goto out;
1821
1822 for (p = desc->args; *p; p++)
1823 if (*p == '<')
1824 n_args++;
1825out:
1826 script_desc__delete(desc);
1827
1828 return n_args;
1829}
1830
69b6470e
ACM
1831static int have_cmd(int argc, const char **argv)
1832{
1833 char **__argv = malloc(sizeof(const char *) * argc);
1834
1835 if (!__argv) {
1836 pr_err("malloc failed\n");
1837 return -1;
1838 }
1839
1840 memcpy(__argv, argv, sizeof(const char *) * argc);
1841 argc = parse_options(argc, (const char **)__argv, record_options,
1842 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1843 free(__argv);
5f9c39dc 1844
69b6470e
ACM
1845 system_wide = (argc == 0);
1846
1847 return 0;
1848}
1849
7322d6c9
JO
1850static void script__setup_sample_type(struct perf_script *script)
1851{
1852 struct perf_session *session = script->session;
1853 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
1854
1855 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
1856 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
1857 (sample_type & PERF_SAMPLE_STACK_USER))
1858 callchain_param.record_mode = CALLCHAIN_DWARF;
1859 else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
1860 callchain_param.record_mode = CALLCHAIN_LBR;
1861 else
1862 callchain_param.record_mode = CALLCHAIN_FP;
1863 }
1864}
1865
e099eba8
JO
1866static int process_stat_round_event(struct perf_tool *tool __maybe_unused,
1867 union perf_event *event,
1868 struct perf_session *session)
1869{
1870 struct stat_round_event *round = &event->stat_round;
1871 struct perf_evsel *counter;
1872
1873 evlist__for_each(session->evlist, counter) {
1874 perf_stat_process_counter(&stat_config, counter);
1875 process_stat(counter, round->time);
1876 }
1877
1878 process_stat_interval(round->time);
1879 return 0;
1880}
1881
91a2c3d5
JO
1882static int process_stat_config_event(struct perf_tool *tool __maybe_unused,
1883 union perf_event *event,
1884 struct perf_session *session __maybe_unused)
1885{
1886 perf_event__read_stat_config(&stat_config, &event->stat_config);
1887 return 0;
1888}
1889
cfc8874a
JO
1890static int set_maps(struct perf_script *script)
1891{
1892 struct perf_evlist *evlist = script->session->evlist;
1893
1894 if (!script->cpus || !script->threads)
1895 return 0;
1896
1897 if (WARN_ONCE(script->allocated, "stats double allocation\n"))
1898 return -EINVAL;
1899
1900 perf_evlist__set_maps(evlist, script->cpus, script->threads);
1901
1902 if (perf_evlist__alloc_stats(evlist, true))
1903 return -ENOMEM;
1904
1905 script->allocated = true;
1906 return 0;
1907}
1908
1909static
1910int process_thread_map_event(struct perf_tool *tool,
1911 union perf_event *event,
1912 struct perf_session *session __maybe_unused)
1913{
1914 struct perf_script *script = container_of(tool, struct perf_script, tool);
1915
1916 if (script->threads) {
1917 pr_warning("Extra thread map event, ignoring.\n");
1918 return 0;
1919 }
1920
1921 script->threads = thread_map__new_event(&event->thread_map);
1922 if (!script->threads)
1923 return -ENOMEM;
1924
1925 return set_maps(script);
1926}
1927
1928static
1929int process_cpu_map_event(struct perf_tool *tool __maybe_unused,
1930 union perf_event *event,
1931 struct perf_session *session __maybe_unused)
1932{
1933 struct perf_script *script = container_of(tool, struct perf_script, tool);
1934
1935 if (script->cpus) {
1936 pr_warning("Extra cpu map event, ignoring.\n");
1937 return 0;
1938 }
1939
1940 script->cpus = cpu_map__new_data(&event->cpu_map.data);
1941 if (!script->cpus)
1942 return -ENOMEM;
1943
1944 return set_maps(script);
1945}
1946
69b6470e
ACM
1947int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
1948{
1949 bool show_full_info = false;
e90debdd
JO
1950 bool header = false;
1951 bool header_only = false;
6cc870f0 1952 bool script_started = false;
69b6470e
ACM
1953 char *rec_script_path = NULL;
1954 char *rep_script_path = NULL;
1955 struct perf_session *session;
7a680eb9 1956 struct itrace_synth_opts itrace_synth_opts = { .set = false, };
69b6470e
ACM
1957 char *script_path = NULL;
1958 const char **__argv;
6cc870f0 1959 int i, j, err = 0;
6f3e5eda
AH
1960 struct perf_script script = {
1961 .tool = {
1962 .sample = process_sample_event,
1963 .mmap = perf_event__process_mmap,
1964 .mmap2 = perf_event__process_mmap2,
1965 .comm = perf_event__process_comm,
1966 .exit = perf_event__process_exit,
1967 .fork = perf_event__process_fork,
7ea95727 1968 .attr = process_attr,
91daee30 1969 .event_update = perf_event__process_event_update,
6f3e5eda
AH
1970 .tracing_data = perf_event__process_tracing_data,
1971 .build_id = perf_event__process_build_id,
7a680eb9
AH
1972 .id_index = perf_event__process_id_index,
1973 .auxtrace_info = perf_event__process_auxtrace_info,
1974 .auxtrace = perf_event__process_auxtrace,
1975 .auxtrace_error = perf_event__process_auxtrace_error,
e099eba8
JO
1976 .stat = perf_event__process_stat_event,
1977 .stat_round = process_stat_round_event,
91a2c3d5 1978 .stat_config = process_stat_config_event,
cfc8874a
JO
1979 .thread_map = process_thread_map_event,
1980 .cpu_map = process_cpu_map_event,
0a8cb85c 1981 .ordered_events = true,
6f3e5eda
AH
1982 .ordering_requires_timestamps = true,
1983 },
1984 };
06af0f2c
YS
1985 struct perf_data_file file = {
1986 .mode = PERF_DATA_MODE_READ,
1987 };
69b6470e 1988 const struct option options[] = {
5f9c39dc
FW
1989 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1990 "dump raw trace in ASCII"),
c0555642 1991 OPT_INCR('v', "verbose", &verbose,
69b6470e 1992 "be more verbose (show symbol address, etc)"),
4b9c0c59 1993 OPT_BOOLEAN('L', "Latency", &latency_format,
cda48461 1994 "show latency attributes (irqs/preemption disabled, etc)"),
4b9c0c59
TZ
1995 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1996 list_available_scripts),
956ffd02
TZ
1997 OPT_CALLBACK('s', "script", NULL, "name",
1998 "script file name (lang:script name, script name, or *)",
1999 parse_scriptname),
2000 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
133dc4c3 2001 "generate perf-script.xx script in specified language"),
69b6470e 2002 OPT_STRING('i', "input", &input_name, "file", "input file name"),
ffabd99e
FW
2003 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
2004 "do various checks like samples ordering and lost events"),
e90debdd
JO
2005 OPT_BOOLEAN(0, "header", &header, "Show data header."),
2006 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
c0230b2b
DA
2007 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
2008 "file", "vmlinux pathname"),
2009 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
2010 "file", "kallsyms pathname"),
2011 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
2012 "When printing symbols do not display call chain"),
a7066709
HK
2013 OPT_CALLBACK(0, "symfs", NULL, "directory",
2014 "Look for files with symbols relative to this directory",
2015 symbol__config_symfs),
06af0f2c 2016 OPT_CALLBACK('F', "fields", NULL, "str",
a978f2ab
AN
2017 "comma separated output fields prepend with 'type:'. "
2018 "Valid types: hw,sw,trace,raw. "
2019 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
dc323ce8 2020 "addr,symoff,period,iregs,brstack,brstacksym,flags", parse_output_fields),
317df650 2021 OPT_BOOLEAN('a', "all-cpus", &system_wide,
69b6470e 2022 "system-wide collection from all CPUs"),
36385be5
FT
2023 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
2024 "only consider these symbols"),
c8e66720 2025 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
e7984b7b
DA
2026 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
2027 "only display events for these comms"),
e03eaa40
DA
2028 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
2029 "only consider symbols in these pids"),
2030 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
2031 "only consider symbols in these tids"),
6125cc8d
ACM
2032 OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
2033 "Set the maximum stack depth when parsing the callchain, "
2034 "anything beyond the specified depth will be ignored. "
4cb93446 2035 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
fbe96f29
SE
2036 OPT_BOOLEAN('I', "show-info", &show_full_info,
2037 "display extended information from perf.data file"),
0bc8d205
AN
2038 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
2039 "Show the path of [kernel.kallsyms]"),
ad7ebb9a
NK
2040 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
2041 "Show the fork/comm/exit events"),
ba1ddf42
NK
2042 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
2043 "Show the mmap events"),
7c14898b
AH
2044 OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
2045 "Show context switch events (if recorded)"),
06af0f2c 2046 OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
83e19860
AH
2047 OPT_BOOLEAN(0, "ns", &nanosecs,
2048 "Use 9 decimal places when displaying time"),
7a680eb9
AH
2049 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
2050 "Instruction Tracing options",
2051 itrace_parse_synth_opts),
a9710ba0
AK
2052 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
2053 "Show full source file name path for source lines"),
77e0070d
MD
2054 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
2055 "Enable symbol demangling"),
2056 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
2057 "Enable kernel symbol demangling"),
2058
1909629f 2059 OPT_END()
69b6470e 2060 };
40cae2b7
YS
2061 const char * const script_subcommands[] = { "record", "report", NULL };
2062 const char *script_usage[] = {
69b6470e
ACM
2063 "perf script [<options>]",
2064 "perf script [<options>] record <script> [<record-options>] <command>",
2065 "perf script [<options>] report <script> [script-args]",
2066 "perf script [<options>] <script> [<record-options>] <command>",
2067 "perf script [<options>] <top-script> [script-args]",
2068 NULL
2069 };
3875294f 2070
b5b87312
TZ
2071 setup_scripting();
2072
40cae2b7 2073 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
b5b87312
TZ
2074 PARSE_OPT_STOP_AT_NON_OPTION);
2075
f5fc1412
JO
2076 file.path = input_name;
2077
b5b87312
TZ
2078 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
2079 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
2080 if (!rec_script_path)
2081 return cmd_record(argc, argv, NULL);
3875294f
TZ
2082 }
2083
b5b87312
TZ
2084 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
2085 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
2086 if (!rep_script_path) {
3875294f 2087 fprintf(stderr,
b5b87312 2088 "Please specify a valid report script"
133dc4c3 2089 "(see 'perf script -l' for listing)\n");
3875294f
TZ
2090 return -1;
2091 }
3875294f
TZ
2092 }
2093
3c5b645f
AH
2094 if (itrace_synth_opts.callchain &&
2095 itrace_synth_opts.callchain_sz > scripting_max_stack)
2096 scripting_max_stack = itrace_synth_opts.callchain_sz;
2097
44e668c6 2098 /* make sure PERF_EXEC_PATH is set for scripts */
46113a54 2099 set_argv_exec_path(get_argv_exec_path());
44e668c6 2100
b5b87312 2101 if (argc && !script_name && !rec_script_path && !rep_script_path) {
a0cccc2e 2102 int live_pipe[2];
b5b87312 2103 int rep_args;
a0cccc2e
TZ
2104 pid_t pid;
2105
b5b87312
TZ
2106 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
2107 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
2108
2109 if (!rec_script_path && !rep_script_path) {
c7118369
NK
2110 usage_with_options_msg(script_usage, options,
2111 "Couldn't find script `%s'\n\n See perf"
133dc4c3 2112 " script -l for available scripts.\n", argv[0]);
a0cccc2e
TZ
2113 }
2114
b5b87312
TZ
2115 if (is_top_script(argv[0])) {
2116 rep_args = argc - 1;
2117 } else {
2118 int rec_args;
2119
2120 rep_args = has_required_arg(rep_script_path);
2121 rec_args = (argc - 1) - rep_args;
2122 if (rec_args < 0) {
c7118369
NK
2123 usage_with_options_msg(script_usage, options,
2124 "`%s' script requires options."
133dc4c3 2125 "\n\n See perf script -l for available "
b5b87312 2126 "scripts and options.\n", argv[0]);
b5b87312 2127 }
a0cccc2e
TZ
2128 }
2129
2130 if (pipe(live_pipe) < 0) {
2131 perror("failed to create pipe");
d54b1a9e 2132 return -1;
a0cccc2e
TZ
2133 }
2134
2135 pid = fork();
2136 if (pid < 0) {
2137 perror("failed to fork");
d54b1a9e 2138 return -1;
a0cccc2e
TZ
2139 }
2140
2141 if (!pid) {
b5b87312
TZ
2142 j = 0;
2143
a0cccc2e
TZ
2144 dup2(live_pipe[1], 1);
2145 close(live_pipe[0]);
2146
317df650
RR
2147 if (is_top_script(argv[0])) {
2148 system_wide = true;
2149 } else if (!system_wide) {
d54b1a9e
DA
2150 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
2151 err = -1;
2152 goto out;
2153 }
317df650 2154 }
b5b87312
TZ
2155
2156 __argv = malloc((argc + 6) * sizeof(const char *));
d54b1a9e
DA
2157 if (!__argv) {
2158 pr_err("malloc failed\n");
2159 err = -ENOMEM;
2160 goto out;
2161 }
e8719adf 2162
b5b87312
TZ
2163 __argv[j++] = "/bin/sh";
2164 __argv[j++] = rec_script_path;
2165 if (system_wide)
2166 __argv[j++] = "-a";
2167 __argv[j++] = "-q";
2168 __argv[j++] = "-o";
2169 __argv[j++] = "-";
2170 for (i = rep_args + 1; i < argc; i++)
2171 __argv[j++] = argv[i];
2172 __argv[j++] = NULL;
a0cccc2e
TZ
2173
2174 execvp("/bin/sh", (char **)__argv);
e8719adf 2175 free(__argv);
a0cccc2e
TZ
2176 exit(-1);
2177 }
2178
2179 dup2(live_pipe[0], 0);
2180 close(live_pipe[1]);
2181
b5b87312 2182 __argv = malloc((argc + 4) * sizeof(const char *));
d54b1a9e
DA
2183 if (!__argv) {
2184 pr_err("malloc failed\n");
2185 err = -ENOMEM;
2186 goto out;
2187 }
2188
b5b87312
TZ
2189 j = 0;
2190 __argv[j++] = "/bin/sh";
2191 __argv[j++] = rep_script_path;
2192 for (i = 1; i < rep_args + 1; i++)
2193 __argv[j++] = argv[i];
2194 __argv[j++] = "-i";
2195 __argv[j++] = "-";
2196 __argv[j++] = NULL;
a0cccc2e
TZ
2197
2198 execvp("/bin/sh", (char **)__argv);
e8719adf 2199 free(__argv);
a0cccc2e
TZ
2200 exit(-1);
2201 }
2202
b5b87312
TZ
2203 if (rec_script_path)
2204 script_path = rec_script_path;
2205 if (rep_script_path)
2206 script_path = rep_script_path;
34c86ea9 2207
b5b87312 2208 if (script_path) {
b5b87312 2209 j = 0;
3875294f 2210
317df650
RR
2211 if (!rec_script_path)
2212 system_wide = false;
d54b1a9e
DA
2213 else if (!system_wide) {
2214 if (have_cmd(argc - 1, &argv[1]) != 0) {
2215 err = -1;
2216 goto out;
2217 }
2218 }
34c86ea9 2219
b5b87312 2220 __argv = malloc((argc + 2) * sizeof(const char *));
d54b1a9e
DA
2221 if (!__argv) {
2222 pr_err("malloc failed\n");
2223 err = -ENOMEM;
2224 goto out;
2225 }
2226
34c86ea9
TZ
2227 __argv[j++] = "/bin/sh";
2228 __argv[j++] = script_path;
2229 if (system_wide)
2230 __argv[j++] = "-a";
b5b87312 2231 for (i = 2; i < argc; i++)
34c86ea9
TZ
2232 __argv[j++] = argv[i];
2233 __argv[j++] = NULL;
3875294f
TZ
2234
2235 execvp("/bin/sh", (char **)__argv);
e8719adf 2236 free(__argv);
3875294f
TZ
2237 exit(-1);
2238 }
956ffd02 2239
cf4fee50
TZ
2240 if (!script_name)
2241 setup_pager();
5f9c39dc 2242
6f3e5eda 2243 session = perf_session__new(&file, false, &script.tool);
d8f66248 2244 if (session == NULL)
52e02834 2245 return -1;
d8f66248 2246
e90debdd
JO
2247 if (header || header_only) {
2248 perf_session__fprintf_info(session, stdout, show_full_info);
2249 if (header_only)
6cc870f0 2250 goto out_delete;
e90debdd
JO
2251 }
2252
0a7e6d1b 2253 if (symbol__init(&session->header.env) < 0)
38520dc3
NK
2254 goto out_delete;
2255
6f3e5eda 2256 script.session = session;
7322d6c9 2257 script__setup_sample_type(&script);
6f3e5eda 2258
7a680eb9
AH
2259 session->itrace_synth_opts = &itrace_synth_opts;
2260
5d67be97 2261 if (cpu_list) {
6cc870f0
NK
2262 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
2263 if (err < 0)
2264 goto out_delete;
5d67be97
AB
2265 }
2266
1424dc96 2267 if (!no_callchain)
c0230b2b
DA
2268 symbol_conf.use_callchain = true;
2269 else
2270 symbol_conf.use_callchain = false;
2271
9ee67421
ACM
2272 if (session->tevent.pevent &&
2273 pevent_set_function_resolver(session->tevent.pevent,
ccb3a829
ACM
2274 machine__resolve_kernel_addr,
2275 &session->machines.host) < 0) {
2276 pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
2277 return -1;
2278 }
2279
956ffd02
TZ
2280 if (generate_script_lang) {
2281 struct stat perf_stat;
745f43e3
DA
2282 int input;
2283
2c9e45f7 2284 if (output_set_by_user()) {
745f43e3
DA
2285 fprintf(stderr,
2286 "custom fields not supported for generated scripts");
6cc870f0
NK
2287 err = -EINVAL;
2288 goto out_delete;
745f43e3 2289 }
956ffd02 2290
cc9784bd 2291 input = open(file.path, O_RDONLY); /* input_name */
956ffd02 2292 if (input < 0) {
6cc870f0 2293 err = -errno;
956ffd02 2294 perror("failed to open file");
6cc870f0 2295 goto out_delete;
956ffd02
TZ
2296 }
2297
2298 err = fstat(input, &perf_stat);
2299 if (err < 0) {
2300 perror("failed to stat file");
6cc870f0 2301 goto out_delete;
956ffd02
TZ
2302 }
2303
2304 if (!perf_stat.st_size) {
2305 fprintf(stderr, "zero-sized file, nothing to do!\n");
6cc870f0 2306 goto out_delete;
956ffd02
TZ
2307 }
2308
2309 scripting_ops = script_spec__lookup(generate_script_lang);
2310 if (!scripting_ops) {
2311 fprintf(stderr, "invalid language specifier");
6cc870f0
NK
2312 err = -ENOENT;
2313 goto out_delete;
956ffd02
TZ
2314 }
2315
29f5ffd3 2316 err = scripting_ops->generate_script(session->tevent.pevent,
da378962 2317 "perf-script");
6cc870f0 2318 goto out_delete;
956ffd02
TZ
2319 }
2320
2321 if (script_name) {
586bc5cc 2322 err = scripting_ops->start_script(script_name, argc, argv);
956ffd02 2323 if (err)
6cc870f0 2324 goto out_delete;
133dc4c3 2325 pr_debug("perf script started with script %s\n\n", script_name);
6cc870f0 2326 script_started = true;
956ffd02
TZ
2327 }
2328
9cbdb702
DA
2329
2330 err = perf_session__check_output_opt(session);
2331 if (err < 0)
6cc870f0 2332 goto out_delete;
9cbdb702 2333
6f3e5eda 2334 err = __cmd_script(&script);
956ffd02 2335
d445dd2a
AH
2336 flush_scripting();
2337
6cc870f0 2338out_delete:
cfc8874a 2339 perf_evlist__free_stats(session->evlist);
d8f66248 2340 perf_session__delete(session);
6cc870f0
NK
2341
2342 if (script_started)
2343 cleanup_scripting();
956ffd02
TZ
2344out:
2345 return err;
5f9c39dc 2346}