]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - tools/perf/builtin-script.c
perf session: Add perf_session__peek_event()
[mirror_ubuntu-bionic-kernel.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
AG
5#include "util/debug.h"
6#include "util/exec_cmd.h"
7#include "util/header.h"
8#include "util/parse-options.h"
9#include "util/session.h"
45694aa7 10#include "util/tool.h"
5f9c39dc
FW
11#include "util/symbol.h"
12#include "util/thread.h"
cf72344d 13#include "util/trace-event.h"
b7eead86 14#include "util/util.h"
1424dc96
DA
15#include "util/evlist.h"
16#include "util/evsel.h"
36385be5 17#include "util/sort.h"
f5fc1412 18#include "util/data.h"
5d67be97 19#include <linux/bitmap.h>
5f9c39dc 20
956ffd02
TZ
21static char const *script_name;
22static char const *generate_script_lang;
ffabd99e 23static bool debug_mode;
e1889d75 24static u64 last_timestamp;
6fcf7ddb 25static u64 nr_unordered;
34c86ea9 26extern const struct option record_options[];
c0230b2b 27static bool no_callchain;
47390ae2 28static bool latency_format;
317df650 29static bool system_wide;
5d67be97
AB
30static const char *cpu_list;
31static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
956ffd02 32
745f43e3
DA
33enum perf_output_field {
34 PERF_OUTPUT_COMM = 1U << 0,
35 PERF_OUTPUT_TID = 1U << 1,
36 PERF_OUTPUT_PID = 1U << 2,
37 PERF_OUTPUT_TIME = 1U << 3,
38 PERF_OUTPUT_CPU = 1U << 4,
39 PERF_OUTPUT_EVNAME = 1U << 5,
40 PERF_OUTPUT_TRACE = 1U << 6,
787bef17
DA
41 PERF_OUTPUT_IP = 1U << 7,
42 PERF_OUTPUT_SYM = 1U << 8,
610723f2 43 PERF_OUTPUT_DSO = 1U << 9,
7cec0922 44 PERF_OUTPUT_ADDR = 1U << 10,
a978f2ab 45 PERF_OUTPUT_SYMOFFSET = 1U << 11,
cc8fae1d 46 PERF_OUTPUT_SRCLINE = 1U << 12,
745f43e3
DA
47};
48
49struct output_option {
50 const char *str;
51 enum perf_output_field field;
52} all_output_options[] = {
53 {.str = "comm", .field = PERF_OUTPUT_COMM},
54 {.str = "tid", .field = PERF_OUTPUT_TID},
55 {.str = "pid", .field = PERF_OUTPUT_PID},
56 {.str = "time", .field = PERF_OUTPUT_TIME},
57 {.str = "cpu", .field = PERF_OUTPUT_CPU},
58 {.str = "event", .field = PERF_OUTPUT_EVNAME},
59 {.str = "trace", .field = PERF_OUTPUT_TRACE},
787bef17 60 {.str = "ip", .field = PERF_OUTPUT_IP},
c0230b2b 61 {.str = "sym", .field = PERF_OUTPUT_SYM},
610723f2 62 {.str = "dso", .field = PERF_OUTPUT_DSO},
7cec0922 63 {.str = "addr", .field = PERF_OUTPUT_ADDR},
a978f2ab 64 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
cc8fae1d 65 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
745f43e3
DA
66};
67
68/* default set to maintain compatibility with current format */
2c9e45f7
DA
69static struct {
70 bool user_set;
9cbdb702 71 bool wildcard_set;
a6ffaf91 72 unsigned int print_ip_opts;
2c9e45f7
DA
73 u64 fields;
74 u64 invalid_fields;
75} output[PERF_TYPE_MAX] = {
76
77 [PERF_TYPE_HARDWARE] = {
78 .user_set = false,
79
80 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
81 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
787bef17 82 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
610723f2 83 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
2c9e45f7
DA
84
85 .invalid_fields = PERF_OUTPUT_TRACE,
86 },
87
88 [PERF_TYPE_SOFTWARE] = {
89 .user_set = false,
90
91 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
92 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
787bef17 93 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
610723f2 94 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
2c9e45f7
DA
95
96 .invalid_fields = PERF_OUTPUT_TRACE,
97 },
98
99 [PERF_TYPE_TRACEPOINT] = {
100 .user_set = false,
101
102 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
103 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
104 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
105 },
0817a6a3
AS
106
107 [PERF_TYPE_RAW] = {
108 .user_set = false,
109
110 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
111 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
787bef17 112 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
610723f2 113 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
0817a6a3
AS
114
115 .invalid_fields = PERF_OUTPUT_TRACE,
116 },
1424dc96 117};
745f43e3 118
2c9e45f7
DA
119static bool output_set_by_user(void)
120{
121 int j;
122 for (j = 0; j < PERF_TYPE_MAX; ++j) {
123 if (output[j].user_set)
124 return true;
125 }
126 return false;
127}
745f43e3 128
9cbdb702
DA
129static const char *output_field2str(enum perf_output_field field)
130{
131 int i, imax = ARRAY_SIZE(all_output_options);
132 const char *str = "";
133
134 for (i = 0; i < imax; ++i) {
135 if (all_output_options[i].field == field) {
136 str = all_output_options[i].str;
137 break;
138 }
139 }
140 return str;
141}
142
2c9e45f7 143#define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
1424dc96 144
5bff01f6
ACM
145static int perf_evsel__check_stype(struct perf_evsel *evsel,
146 u64 sample_type, const char *sample_msg,
147 enum perf_output_field field)
1424dc96 148{
5bff01f6 149 struct perf_event_attr *attr = &evsel->attr;
9cbdb702
DA
150 int type = attr->type;
151 const char *evname;
152
153 if (attr->sample_type & sample_type)
154 return 0;
155
156 if (output[type].user_set) {
5bff01f6 157 evname = perf_evsel__name(evsel);
9cbdb702
DA
158 pr_err("Samples for '%s' event do not have %s attribute set. "
159 "Cannot print '%s' field.\n",
160 evname, sample_msg, output_field2str(field));
161 return -1;
162 }
163
164 /* user did not ask for it explicitly so remove from the default list */
165 output[type].fields &= ~field;
5bff01f6 166 evname = perf_evsel__name(evsel);
9cbdb702
DA
167 pr_debug("Samples for '%s' event do not have %s attribute set. "
168 "Skipping '%s' field.\n",
169 evname, sample_msg, output_field2str(field));
170
171 return 0;
172}
173
174static int perf_evsel__check_attr(struct perf_evsel *evsel,
175 struct perf_session *session)
176{
177 struct perf_event_attr *attr = &evsel->attr;
178
1424dc96
DA
179 if (PRINT_FIELD(TRACE) &&
180 !perf_session__has_traces(session, "record -R"))
181 return -EINVAL;
182
787bef17 183 if (PRINT_FIELD(IP)) {
5bff01f6
ACM
184 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
185 PERF_OUTPUT_IP))
1424dc96 186 return -EINVAL;
9cbdb702 187
1424dc96 188 if (!no_callchain &&
9cbdb702 189 !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
1424dc96
DA
190 symbol_conf.use_callchain = false;
191 }
7cec0922
DA
192
193 if (PRINT_FIELD(ADDR) &&
5bff01f6
ACM
194 perf_evsel__check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
195 PERF_OUTPUT_ADDR))
7cec0922
DA
196 return -EINVAL;
197
198 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
199 pr_err("Display of symbols requested but neither sample IP nor "
200 "sample address\nis selected. Hence, no addresses to convert "
201 "to symbols.\n");
787bef17
DA
202 return -EINVAL;
203 }
a978f2ab
AN
204 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
205 pr_err("Display of offsets requested but symbol is not"
206 "selected.\n");
207 return -EINVAL;
208 }
7cec0922
DA
209 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
210 pr_err("Display of DSO requested but neither sample IP nor "
211 "sample address\nis selected. Hence, no addresses to convert "
212 "to DSO.\n");
610723f2
DA
213 return -EINVAL;
214 }
cc8fae1d
AH
215 if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
216 pr_err("Display of source line number requested but sample IP is not\n"
217 "selected. Hence, no address to lookup the source line number.\n");
218 return -EINVAL;
219 }
1424dc96
DA
220
221 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
5bff01f6
ACM
222 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
223 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
1424dc96 224 return -EINVAL;
1424dc96
DA
225
226 if (PRINT_FIELD(TIME) &&
5bff01f6
ACM
227 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
228 PERF_OUTPUT_TIME))
1424dc96 229 return -EINVAL;
1424dc96
DA
230
231 if (PRINT_FIELD(CPU) &&
5bff01f6
ACM
232 perf_evsel__check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
233 PERF_OUTPUT_CPU))
1424dc96 234 return -EINVAL;
9cbdb702
DA
235
236 return 0;
237}
238
7ea95727
AH
239static void set_print_ip_opts(struct perf_event_attr *attr)
240{
241 unsigned int type = attr->type;
242
243 output[type].print_ip_opts = 0;
244 if (PRINT_FIELD(IP))
245 output[type].print_ip_opts |= PRINT_IP_OPT_IP;
246
247 if (PRINT_FIELD(SYM))
248 output[type].print_ip_opts |= PRINT_IP_OPT_SYM;
249
250 if (PRINT_FIELD(DSO))
251 output[type].print_ip_opts |= PRINT_IP_OPT_DSO;
252
253 if (PRINT_FIELD(SYMOFFSET))
254 output[type].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET;
cc8fae1d
AH
255
256 if (PRINT_FIELD(SRCLINE))
257 output[type].print_ip_opts |= PRINT_IP_OPT_SRCLINE;
7ea95727
AH
258}
259
9cbdb702
DA
260/*
261 * verify all user requested events exist and the samples
262 * have the expected data
263 */
264static int perf_session__check_output_opt(struct perf_session *session)
265{
266 int j;
267 struct perf_evsel *evsel;
268
269 for (j = 0; j < PERF_TYPE_MAX; ++j) {
270 evsel = perf_session__find_first_evtype(session, j);
271
272 /*
273 * even if fields is set to 0 (ie., show nothing) event must
274 * exist if user explicitly includes it on the command line
275 */
276 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
277 pr_err("%s events do not exist. "
278 "Remove corresponding -f option to proceed.\n",
279 event_type(j));
280 return -1;
281 }
282
283 if (evsel && output[j].fields &&
284 perf_evsel__check_attr(evsel, session))
285 return -1;
a6ffaf91
DA
286
287 if (evsel == NULL)
288 continue;
289
7ea95727 290 set_print_ip_opts(&evsel->attr);
1424dc96
DA
291 }
292
80b8b496
DA
293 /*
294 * set default for tracepoints to print symbols only
295 * if callchains are present
296 */
297 if (symbol_conf.use_callchain &&
298 !output[PERF_TYPE_TRACEPOINT].user_set) {
299 struct perf_event_attr *attr;
300
301 j = PERF_TYPE_TRACEPOINT;
302 evsel = perf_session__find_first_evtype(session, j);
303 if (evsel == NULL)
304 goto out;
305
306 attr = &evsel->attr;
307
308 if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
309 output[j].fields |= PERF_OUTPUT_IP;
310 output[j].fields |= PERF_OUTPUT_SYM;
311 output[j].fields |= PERF_OUTPUT_DSO;
312 set_print_ip_opts(attr);
313 }
314 }
315
316out:
1424dc96
DA
317 return 0;
318}
745f43e3 319
fcf65bf1 320static void print_sample_start(struct perf_sample *sample,
1424dc96 321 struct thread *thread,
5bff01f6 322 struct perf_evsel *evsel)
c70c94b4 323{
5bff01f6 324 struct perf_event_attr *attr = &evsel->attr;
c70c94b4
DA
325 unsigned long secs;
326 unsigned long usecs;
745f43e3
DA
327 unsigned long long nsecs;
328
329 if (PRINT_FIELD(COMM)) {
330 if (latency_format)
b9c5143a 331 printf("%8.8s ", thread__comm_str(thread));
787bef17 332 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
b9c5143a 333 printf("%s ", thread__comm_str(thread));
745f43e3 334 else
b9c5143a 335 printf("%16s ", thread__comm_str(thread));
745f43e3 336 }
c70c94b4 337
745f43e3
DA
338 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
339 printf("%5d/%-5d ", sample->pid, sample->tid);
340 else if (PRINT_FIELD(PID))
341 printf("%5d ", sample->pid);
342 else if (PRINT_FIELD(TID))
343 printf("%5d ", sample->tid);
344
345 if (PRINT_FIELD(CPU)) {
346 if (latency_format)
347 printf("%3d ", sample->cpu);
348 else
349 printf("[%03d] ", sample->cpu);
350 }
c70c94b4 351
745f43e3
DA
352 if (PRINT_FIELD(TIME)) {
353 nsecs = sample->time;
354 secs = nsecs / NSECS_PER_SEC;
355 nsecs -= secs * NSECS_PER_SEC;
356 usecs = nsecs / NSECS_PER_USEC;
357 printf("%5lu.%06lu: ", secs, usecs);
358 }
c70c94b4
DA
359}
360
7cec0922
DA
361static void print_sample_addr(union perf_event *event,
362 struct perf_sample *sample,
743eb868 363 struct machine *machine,
7cec0922
DA
364 struct thread *thread,
365 struct perf_event_attr *attr)
366{
367 struct addr_location al;
7cec0922
DA
368
369 printf("%16" PRIx64, sample->addr);
370
371 if (!sample_addr_correlates_sym(attr))
372 return;
373
9b0d2d87 374 perf_event__preprocess_sample_addr(event, sample, machine, thread, &al);
7cec0922
DA
375
376 if (PRINT_FIELD(SYM)) {
547a92e0 377 printf(" ");
a978f2ab
AN
378 if (PRINT_FIELD(SYMOFFSET))
379 symbol__fprintf_symname_offs(al.sym, &al, stdout);
380 else
381 symbol__fprintf_symname(al.sym, stdout);
7cec0922
DA
382 }
383
384 if (PRINT_FIELD(DSO)) {
547a92e0
AN
385 printf(" (");
386 map__fprintf_dsoname(al.map, stdout);
387 printf(")");
7cec0922
DA
388 }
389}
390
95582596
AN
391static void print_sample_bts(union perf_event *event,
392 struct perf_sample *sample,
393 struct perf_evsel *evsel,
a2cb3cf2
AH
394 struct thread *thread,
395 struct addr_location *al)
95582596
AN
396{
397 struct perf_event_attr *attr = &evsel->attr;
8066be5f 398 bool print_srcline_last = false;
95582596
AN
399
400 /* print branch_from information */
401 if (PRINT_FIELD(IP)) {
8066be5f
AH
402 unsigned int print_opts = output[attr->type].print_ip_opts;
403
404 if (symbol_conf.use_callchain && sample->callchain) {
95582596 405 printf("\n");
8066be5f
AH
406 } else {
407 printf(" ");
408 if (print_opts & PRINT_IP_OPT_SRCLINE) {
409 print_srcline_last = true;
410 print_opts &= ~PRINT_IP_OPT_SRCLINE;
411 }
412 }
413 perf_evsel__print_ip(evsel, sample, al, print_opts,
307cbb92 414 PERF_MAX_STACK_DEPTH);
95582596
AN
415 }
416
95582596 417 /* print branch_to information */
243be3dd
AH
418 if (PRINT_FIELD(ADDR) ||
419 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
578bea40
AH
420 !output[attr->type].user_set)) {
421 printf(" => ");
cc22e575 422 print_sample_addr(event, sample, al->machine, thread, attr);
578bea40 423 }
95582596 424
8066be5f
AH
425 if (print_srcline_last)
426 map__fprintf_srcline(al->map, al->addr, "\n ", stdout);
427
95582596
AN
428 printf("\n");
429}
430
97822433 431static void process_event(union perf_event *event, struct perf_sample *sample,
cc22e575 432 struct perf_evsel *evsel, struct thread *thread,
a2cb3cf2 433 struct addr_location *al)
be6d842a 434{
9e69c210 435 struct perf_event_attr *attr = &evsel->attr;
1424dc96 436
2c9e45f7 437 if (output[attr->type].fields == 0)
1424dc96
DA
438 return;
439
fcf65bf1 440 print_sample_start(sample, thread, evsel);
745f43e3 441
e944d3d7
NK
442 if (PRINT_FIELD(EVNAME)) {
443 const char *evname = perf_evsel__name(evsel);
444 printf("%s: ", evname ? evname : "[unknown]");
445 }
446
95582596 447 if (is_bts_event(attr)) {
cc22e575 448 print_sample_bts(event, sample, evsel, thread, al);
95582596
AN
449 return;
450 }
451
745f43e3 452 if (PRINT_FIELD(TRACE))
fcf65bf1
ACM
453 event_format__print(evsel->tp_format, sample->cpu,
454 sample->raw_data, sample->raw_size);
7cec0922 455 if (PRINT_FIELD(ADDR))
cc22e575 456 print_sample_addr(event, sample, al->machine, thread, attr);
7cec0922 457
787bef17 458 if (PRINT_FIELD(IP)) {
c0230b2b
DA
459 if (!symbol_conf.use_callchain)
460 printf(" ");
461 else
462 printf("\n");
a6ffaf91 463
cc22e575 464 perf_evsel__print_ip(evsel, sample, al,
307cbb92
DA
465 output[attr->type].print_ip_opts,
466 PERF_MAX_STACK_DEPTH);
c0230b2b
DA
467 }
468
c70c94b4 469 printf("\n");
be6d842a
DA
470}
471
1d037ca1
IT
472static int default_start_script(const char *script __maybe_unused,
473 int argc __maybe_unused,
474 const char **argv __maybe_unused)
956ffd02
TZ
475{
476 return 0;
477}
478
479static int default_stop_script(void)
480{
481 return 0;
482}
483
1d037ca1
IT
484static int default_generate_script(struct pevent *pevent __maybe_unused,
485 const char *outfile __maybe_unused)
956ffd02
TZ
486{
487 return 0;
488}
489
490static struct scripting_ops default_scripting_ops = {
491 .start_script = default_start_script,
492 .stop_script = default_stop_script,
be6d842a 493 .process_event = process_event,
956ffd02
TZ
494 .generate_script = default_generate_script,
495};
496
497static struct scripting_ops *scripting_ops;
498
499static void setup_scripting(void)
500{
16c632de 501 setup_perl_scripting();
7e4b21b8 502 setup_python_scripting();
16c632de 503
956ffd02
TZ
504 scripting_ops = &default_scripting_ops;
505}
506
507static int cleanup_scripting(void)
508{
133dc4c3 509 pr_debug("\nperf script stopped\n");
3824a4e8 510
956ffd02
TZ
511 return scripting_ops->stop_script();
512}
513
1d037ca1 514static int process_sample_event(struct perf_tool *tool __maybe_unused,
d20deb64 515 union perf_event *event,
8115d60c 516 struct perf_sample *sample,
9e69c210 517 struct perf_evsel *evsel,
743eb868 518 struct machine *machine)
5f9c39dc 519{
e7984b7b 520 struct addr_location al;
ef89325f
AH
521 struct thread *thread = machine__findnew_thread(machine, sample->pid,
522 sample->tid);
6ddf259d 523
5f9c39dc 524 if (thread == NULL) {
6beba7ad
ACM
525 pr_debug("problem processing %d event, skipping it.\n",
526 event->header.type);
5f9c39dc
FW
527 return -1;
528 }
529
1424dc96
DA
530 if (debug_mode) {
531 if (sample->time < last_timestamp) {
532 pr_err("Samples misordered, previous: %" PRIu64
533 " this: %" PRIu64 "\n", last_timestamp,
534 sample->time);
535 nr_unordered++;
e1889d75 536 }
1424dc96
DA
537 last_timestamp = sample->time;
538 return 0;
5f9c39dc 539 }
5d67be97 540
e44baa3e 541 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
e7984b7b
DA
542 pr_err("problem processing %d event, skipping it.\n",
543 event->header.type);
544 return -1;
545 }
546
547 if (al.filtered)
548 return 0;
549
5d67be97
AB
550 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
551 return 0;
552
cc22e575 553 scripting_ops->process_event(event, sample, evsel, thread, &al);
5f9c39dc 554
743eb868 555 evsel->hists.stats.total_period += sample->period;
5f9c39dc
FW
556 return 0;
557}
558
6f3e5eda
AH
559struct perf_script {
560 struct perf_tool tool;
561 struct perf_session *session;
ad7ebb9a 562 bool show_task_events;
ba1ddf42 563 bool show_mmap_events;
016e92fb
FW
564};
565
7ea95727
AH
566static int process_attr(struct perf_tool *tool, union perf_event *event,
567 struct perf_evlist **pevlist)
568{
569 struct perf_script *scr = container_of(tool, struct perf_script, tool);
570 struct perf_evlist *evlist;
571 struct perf_evsel *evsel, *pos;
572 int err;
573
574 err = perf_event__process_attr(tool, event, pevlist);
575 if (err)
576 return err;
577
578 evlist = *pevlist;
579 evsel = perf_evlist__last(*pevlist);
580
581 if (evsel->attr.type >= PERF_TYPE_MAX)
582 return 0;
583
0050f7aa 584 evlist__for_each(evlist, pos) {
7ea95727
AH
585 if (pos->attr.type == evsel->attr.type && pos != evsel)
586 return 0;
587 }
588
589 set_print_ip_opts(&evsel->attr);
590
591 return perf_evsel__check_attr(evsel, scr->session);
592}
593
ad7ebb9a
NK
594static int process_comm_event(struct perf_tool *tool,
595 union perf_event *event,
596 struct perf_sample *sample,
597 struct machine *machine)
598{
599 struct thread *thread;
600 struct perf_script *script = container_of(tool, struct perf_script, tool);
601 struct perf_session *session = script->session;
602 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
603 int ret = -1;
604
605 thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
606 if (thread == NULL) {
607 pr_debug("problem processing COMM event, skipping it.\n");
608 return -1;
609 }
610
611 if (perf_event__process_comm(tool, event, sample, machine) < 0)
612 goto out;
613
614 if (!evsel->attr.sample_id_all) {
615 sample->cpu = 0;
616 sample->time = 0;
617 sample->tid = event->comm.tid;
618 sample->pid = event->comm.pid;
619 }
620 print_sample_start(sample, thread, evsel);
621 perf_event__fprintf(event, stdout);
622 ret = 0;
623
624out:
625 return ret;
626}
627
628static int process_fork_event(struct perf_tool *tool,
629 union perf_event *event,
630 struct perf_sample *sample,
631 struct machine *machine)
632{
633 struct thread *thread;
634 struct perf_script *script = container_of(tool, struct perf_script, tool);
635 struct perf_session *session = script->session;
636 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
637
638 if (perf_event__process_fork(tool, event, sample, machine) < 0)
639 return -1;
640
641 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
642 if (thread == NULL) {
643 pr_debug("problem processing FORK event, skipping it.\n");
644 return -1;
645 }
646
647 if (!evsel->attr.sample_id_all) {
648 sample->cpu = 0;
649 sample->time = event->fork.time;
650 sample->tid = event->fork.tid;
651 sample->pid = event->fork.pid;
652 }
653 print_sample_start(sample, thread, evsel);
654 perf_event__fprintf(event, stdout);
655
656 return 0;
657}
658static int process_exit_event(struct perf_tool *tool,
659 union perf_event *event,
660 struct perf_sample *sample,
661 struct machine *machine)
662{
663 struct thread *thread;
664 struct perf_script *script = container_of(tool, struct perf_script, tool);
665 struct perf_session *session = script->session;
666 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
667
668 thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
669 if (thread == NULL) {
670 pr_debug("problem processing EXIT event, skipping it.\n");
671 return -1;
672 }
673
674 if (!evsel->attr.sample_id_all) {
675 sample->cpu = 0;
676 sample->time = 0;
677 sample->tid = event->comm.tid;
678 sample->pid = event->comm.pid;
679 }
680 print_sample_start(sample, thread, evsel);
681 perf_event__fprintf(event, stdout);
682
683 if (perf_event__process_exit(tool, event, sample, machine) < 0)
684 return -1;
685
686 return 0;
687}
688
ba1ddf42
NK
689static int process_mmap_event(struct perf_tool *tool,
690 union perf_event *event,
691 struct perf_sample *sample,
692 struct machine *machine)
693{
694 struct thread *thread;
695 struct perf_script *script = container_of(tool, struct perf_script, tool);
696 struct perf_session *session = script->session;
697 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
698
699 if (perf_event__process_mmap(tool, event, sample, machine) < 0)
700 return -1;
701
702 thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
703 if (thread == NULL) {
704 pr_debug("problem processing MMAP event, skipping it.\n");
705 return -1;
706 }
707
708 if (!evsel->attr.sample_id_all) {
709 sample->cpu = 0;
710 sample->time = 0;
711 sample->tid = event->mmap.tid;
712 sample->pid = event->mmap.pid;
713 }
714 print_sample_start(sample, thread, evsel);
715 perf_event__fprintf(event, stdout);
716
717 return 0;
718}
719
720static int process_mmap2_event(struct perf_tool *tool,
721 union perf_event *event,
722 struct perf_sample *sample,
723 struct machine *machine)
724{
725 struct thread *thread;
726 struct perf_script *script = container_of(tool, struct perf_script, tool);
727 struct perf_session *session = script->session;
728 struct perf_evsel *evsel = perf_evlist__first(session->evlist);
729
730 if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
731 return -1;
732
733 thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
734 if (thread == NULL) {
735 pr_debug("problem processing MMAP2 event, skipping it.\n");
736 return -1;
737 }
738
739 if (!evsel->attr.sample_id_all) {
740 sample->cpu = 0;
741 sample->time = 0;
742 sample->tid = event->mmap2.tid;
743 sample->pid = event->mmap2.pid;
744 }
745 print_sample_start(sample, thread, evsel);
746 perf_event__fprintf(event, stdout);
747
748 return 0;
749}
750
1d037ca1 751static void sig_handler(int sig __maybe_unused)
c239da3b
TZ
752{
753 session_done = 1;
754}
755
6f3e5eda 756static int __cmd_script(struct perf_script *script)
5f9c39dc 757{
6fcf7ddb
FW
758 int ret;
759
c239da3b
TZ
760 signal(SIGINT, sig_handler);
761
ad7ebb9a
NK
762 /* override event processing functions */
763 if (script->show_task_events) {
764 script->tool.comm = process_comm_event;
765 script->tool.fork = process_fork_event;
766 script->tool.exit = process_exit_event;
767 }
ba1ddf42
NK
768 if (script->show_mmap_events) {
769 script->tool.mmap = process_mmap_event;
770 script->tool.mmap2 = process_mmap2_event;
771 }
ad7ebb9a 772
6f3e5eda 773 ret = perf_session__process_events(script->session, &script->tool);
6fcf7ddb 774
6d8afb56 775 if (debug_mode)
9486aa38 776 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
6fcf7ddb
FW
777
778 return ret;
5f9c39dc
FW
779}
780
956ffd02
TZ
781struct script_spec {
782 struct list_head node;
783 struct scripting_ops *ops;
784 char spec[0];
785};
786
eccdfe2d 787static LIST_HEAD(script_specs);
956ffd02
TZ
788
789static struct script_spec *script_spec__new(const char *spec,
790 struct scripting_ops *ops)
791{
792 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
793
794 if (s != NULL) {
795 strcpy(s->spec, spec);
796 s->ops = ops;
797 }
798
799 return s;
800}
801
956ffd02
TZ
802static void script_spec__add(struct script_spec *s)
803{
804 list_add_tail(&s->node, &script_specs);
805}
806
807static struct script_spec *script_spec__find(const char *spec)
808{
809 struct script_spec *s;
810
811 list_for_each_entry(s, &script_specs, node)
812 if (strcasecmp(s->spec, spec) == 0)
813 return s;
814 return NULL;
815}
816
817static struct script_spec *script_spec__findnew(const char *spec,
818 struct scripting_ops *ops)
819{
820 struct script_spec *s = script_spec__find(spec);
821
822 if (s)
823 return s;
824
825 s = script_spec__new(spec, ops);
826 if (!s)
466e2876 827 return NULL;
956ffd02
TZ
828
829 script_spec__add(s);
830
831 return s;
956ffd02
TZ
832}
833
834int script_spec_register(const char *spec, struct scripting_ops *ops)
835{
836 struct script_spec *s;
837
838 s = script_spec__find(spec);
839 if (s)
840 return -1;
841
842 s = script_spec__findnew(spec, ops);
843 if (!s)
844 return -1;
845
846 return 0;
847}
848
849static struct scripting_ops *script_spec__lookup(const char *spec)
850{
851 struct script_spec *s = script_spec__find(spec);
852 if (!s)
853 return NULL;
854
855 return s->ops;
856}
857
858static void list_available_languages(void)
859{
860 struct script_spec *s;
861
862 fprintf(stderr, "\n");
863 fprintf(stderr, "Scripting language extensions (used in "
133dc4c3 864 "perf script -s [spec:]script.[spec]):\n\n");
956ffd02
TZ
865
866 list_for_each_entry(s, &script_specs, node)
867 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
868
869 fprintf(stderr, "\n");
870}
871
1d037ca1
IT
872static int parse_scriptname(const struct option *opt __maybe_unused,
873 const char *str, int unset __maybe_unused)
956ffd02
TZ
874{
875 char spec[PATH_MAX];
876 const char *script, *ext;
877 int len;
878
f526d68b 879 if (strcmp(str, "lang") == 0) {
956ffd02 880 list_available_languages();
f526d68b 881 exit(0);
956ffd02
TZ
882 }
883
884 script = strchr(str, ':');
885 if (script) {
886 len = script - str;
887 if (len >= PATH_MAX) {
888 fprintf(stderr, "invalid language specifier");
889 return -1;
890 }
891 strncpy(spec, str, len);
892 spec[len] = '\0';
893 scripting_ops = script_spec__lookup(spec);
894 if (!scripting_ops) {
895 fprintf(stderr, "invalid language specifier");
896 return -1;
897 }
898 script++;
899 } else {
900 script = str;
d1e95bb5 901 ext = strrchr(script, '.');
956ffd02
TZ
902 if (!ext) {
903 fprintf(stderr, "invalid script extension");
904 return -1;
905 }
906 scripting_ops = script_spec__lookup(++ext);
907 if (!scripting_ops) {
908 fprintf(stderr, "invalid script extension");
909 return -1;
910 }
911 }
912
913 script_name = strdup(script);
914
915 return 0;
916}
917
1d037ca1
IT
918static int parse_output_fields(const struct option *opt __maybe_unused,
919 const char *arg, int unset __maybe_unused)
745f43e3
DA
920{
921 char *tok;
50ca19ae 922 int i, imax = ARRAY_SIZE(all_output_options);
2c9e45f7 923 int j;
745f43e3
DA
924 int rc = 0;
925 char *str = strdup(arg);
1424dc96 926 int type = -1;
745f43e3
DA
927
928 if (!str)
929 return -ENOMEM;
930
2c9e45f7
DA
931 /* first word can state for which event type the user is specifying
932 * the fields. If no type exists, the specified fields apply to all
933 * event types found in the file minus the invalid fields for a type.
1424dc96 934 */
2c9e45f7
DA
935 tok = strchr(str, ':');
936 if (tok) {
937 *tok = '\0';
938 tok++;
939 if (!strcmp(str, "hw"))
940 type = PERF_TYPE_HARDWARE;
941 else if (!strcmp(str, "sw"))
942 type = PERF_TYPE_SOFTWARE;
943 else if (!strcmp(str, "trace"))
944 type = PERF_TYPE_TRACEPOINT;
0817a6a3
AS
945 else if (!strcmp(str, "raw"))
946 type = PERF_TYPE_RAW;
2c9e45f7
DA
947 else {
948 fprintf(stderr, "Invalid event type in field string.\n");
38efb539
RR
949 rc = -EINVAL;
950 goto out;
2c9e45f7
DA
951 }
952
953 if (output[type].user_set)
954 pr_warning("Overriding previous field request for %s events.\n",
955 event_type(type));
956
957 output[type].fields = 0;
958 output[type].user_set = true;
9cbdb702 959 output[type].wildcard_set = false;
2c9e45f7
DA
960
961 } else {
962 tok = str;
963 if (strlen(str) == 0) {
964 fprintf(stderr,
965 "Cannot set fields to 'none' for all event types.\n");
966 rc = -EINVAL;
967 goto out;
968 }
969
970 if (output_set_by_user())
971 pr_warning("Overriding previous field request for all events.\n");
972
973 for (j = 0; j < PERF_TYPE_MAX; ++j) {
974 output[j].fields = 0;
975 output[j].user_set = true;
9cbdb702 976 output[j].wildcard_set = true;
2c9e45f7 977 }
745f43e3
DA
978 }
979
2c9e45f7
DA
980 tok = strtok(tok, ",");
981 while (tok) {
745f43e3 982 for (i = 0; i < imax; ++i) {
2c9e45f7 983 if (strcmp(tok, all_output_options[i].str) == 0)
745f43e3 984 break;
745f43e3
DA
985 }
986 if (i == imax) {
2c9e45f7 987 fprintf(stderr, "Invalid field requested.\n");
745f43e3 988 rc = -EINVAL;
2c9e45f7 989 goto out;
745f43e3
DA
990 }
991
2c9e45f7
DA
992 if (type == -1) {
993 /* add user option to all events types for
994 * which it is valid
995 */
996 for (j = 0; j < PERF_TYPE_MAX; ++j) {
997 if (output[j].invalid_fields & all_output_options[i].field) {
998 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
999 all_output_options[i].str, event_type(j));
1000 } else
1001 output[j].fields |= all_output_options[i].field;
1002 }
1003 } else {
1004 if (output[type].invalid_fields & all_output_options[i].field) {
1005 fprintf(stderr, "\'%s\' not valid for %s events.\n",
1006 all_output_options[i].str, event_type(type));
1007
1008 rc = -EINVAL;
1009 goto out;
1010 }
1011 output[type].fields |= all_output_options[i].field;
1012 }
1013
1014 tok = strtok(NULL, ",");
745f43e3
DA
1015 }
1016
2c9e45f7
DA
1017 if (type >= 0) {
1018 if (output[type].fields == 0) {
1019 pr_debug("No fields requested for %s type. "
1020 "Events will not be displayed.\n", event_type(type));
1021 }
1022 }
745f43e3 1023
2c9e45f7 1024out:
745f43e3
DA
1025 free(str);
1026 return rc;
1027}
1028
008f29d3
SB
1029/* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1030static int is_directory(const char *base_path, const struct dirent *dent)
1031{
1032 char path[PATH_MAX];
1033 struct stat st;
1034
1035 sprintf(path, "%s/%s", base_path, dent->d_name);
1036 if (stat(path, &st))
1037 return 0;
1038
1039 return S_ISDIR(st.st_mode);
1040}
1041
1042#define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
4b9c0c59
TZ
1043 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
1044 lang_next) \
008f29d3
SB
1045 if ((lang_dirent.d_type == DT_DIR || \
1046 (lang_dirent.d_type == DT_UNKNOWN && \
1047 is_directory(scripts_path, &lang_dirent))) && \
4b9c0c59
TZ
1048 (strcmp(lang_dirent.d_name, ".")) && \
1049 (strcmp(lang_dirent.d_name, "..")))
1050
008f29d3 1051#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
4b9c0c59
TZ
1052 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
1053 script_next) \
008f29d3
SB
1054 if (script_dirent.d_type != DT_DIR && \
1055 (script_dirent.d_type != DT_UNKNOWN || \
1056 !is_directory(lang_path, &script_dirent)))
4b9c0c59
TZ
1057
1058
1059#define RECORD_SUFFIX "-record"
1060#define REPORT_SUFFIX "-report"
1061
1062struct script_desc {
1063 struct list_head node;
1064 char *name;
1065 char *half_liner;
1066 char *args;
1067};
1068
eccdfe2d 1069static LIST_HEAD(script_descs);
4b9c0c59
TZ
1070
1071static struct script_desc *script_desc__new(const char *name)
1072{
1073 struct script_desc *s = zalloc(sizeof(*s));
1074
b5b87312 1075 if (s != NULL && name)
4b9c0c59
TZ
1076 s->name = strdup(name);
1077
1078 return s;
1079}
1080
1081static void script_desc__delete(struct script_desc *s)
1082{
74cf249d
ACM
1083 zfree(&s->name);
1084 zfree(&s->half_liner);
1085 zfree(&s->args);
4b9c0c59
TZ
1086 free(s);
1087}
1088
1089static void script_desc__add(struct script_desc *s)
1090{
1091 list_add_tail(&s->node, &script_descs);
1092}
1093
1094static struct script_desc *script_desc__find(const char *name)
1095{
1096 struct script_desc *s;
1097
1098 list_for_each_entry(s, &script_descs, node)
1099 if (strcasecmp(s->name, name) == 0)
1100 return s;
1101 return NULL;
1102}
1103
1104static struct script_desc *script_desc__findnew(const char *name)
1105{
1106 struct script_desc *s = script_desc__find(name);
1107
1108 if (s)
1109 return s;
1110
1111 s = script_desc__new(name);
1112 if (!s)
1113 goto out_delete_desc;
1114
1115 script_desc__add(s);
1116
1117 return s;
1118
1119out_delete_desc:
1120 script_desc__delete(s);
1121
1122 return NULL;
1123}
1124
965bb6be 1125static const char *ends_with(const char *str, const char *suffix)
4b9c0c59
TZ
1126{
1127 size_t suffix_len = strlen(suffix);
965bb6be 1128 const char *p = str;
4b9c0c59
TZ
1129
1130 if (strlen(str) > suffix_len) {
1131 p = str + strlen(str) - suffix_len;
1132 if (!strncmp(p, suffix, suffix_len))
1133 return p;
1134 }
1135
1136 return NULL;
1137}
1138
4b9c0c59
TZ
1139static int read_script_info(struct script_desc *desc, const char *filename)
1140{
1141 char line[BUFSIZ], *p;
1142 FILE *fp;
1143
1144 fp = fopen(filename, "r");
1145 if (!fp)
1146 return -1;
1147
1148 while (fgets(line, sizeof(line), fp)) {
1149 p = ltrim(line);
1150 if (strlen(p) == 0)
1151 continue;
1152 if (*p != '#')
1153 continue;
1154 p++;
1155 if (strlen(p) && *p == '!')
1156 continue;
1157
1158 p = ltrim(p);
1159 if (strlen(p) && p[strlen(p) - 1] == '\n')
1160 p[strlen(p) - 1] = '\0';
1161
1162 if (!strncmp(p, "description:", strlen("description:"))) {
1163 p += strlen("description:");
1164 desc->half_liner = strdup(ltrim(p));
1165 continue;
1166 }
1167
1168 if (!strncmp(p, "args:", strlen("args:"))) {
1169 p += strlen("args:");
1170 desc->args = strdup(ltrim(p));
1171 continue;
1172 }
1173 }
1174
1175 fclose(fp);
1176
1177 return 0;
1178}
1179
38efb539
RR
1180static char *get_script_root(struct dirent *script_dirent, const char *suffix)
1181{
1182 char *script_root, *str;
1183
1184 script_root = strdup(script_dirent->d_name);
1185 if (!script_root)
1186 return NULL;
1187
1188 str = (char *)ends_with(script_root, suffix);
1189 if (!str) {
1190 free(script_root);
1191 return NULL;
1192 }
1193
1194 *str = '\0';
1195 return script_root;
1196}
1197
1d037ca1
IT
1198static int list_available_scripts(const struct option *opt __maybe_unused,
1199 const char *s __maybe_unused,
1200 int unset __maybe_unused)
4b9c0c59
TZ
1201{
1202 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1203 char scripts_path[MAXPATHLEN];
1204 DIR *scripts_dir, *lang_dir;
1205 char script_path[MAXPATHLEN];
1206 char lang_path[MAXPATHLEN];
1207 struct script_desc *desc;
1208 char first_half[BUFSIZ];
1209 char *script_root;
4b9c0c59
TZ
1210
1211 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1212
1213 scripts_dir = opendir(scripts_path);
1214 if (!scripts_dir)
1215 return -1;
1216
008f29d3 1217 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
4b9c0c59
TZ
1218 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1219 lang_dirent.d_name);
1220 lang_dir = opendir(lang_path);
1221 if (!lang_dir)
1222 continue;
1223
008f29d3 1224 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
38efb539
RR
1225 script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
1226 if (script_root) {
4b9c0c59
TZ
1227 desc = script_desc__findnew(script_root);
1228 snprintf(script_path, MAXPATHLEN, "%s/%s",
1229 lang_path, script_dirent.d_name);
1230 read_script_info(desc, script_path);
38efb539 1231 free(script_root);
4b9c0c59 1232 }
4b9c0c59
TZ
1233 }
1234 }
1235
1236 fprintf(stdout, "List of available trace scripts:\n");
1237 list_for_each_entry(desc, &script_descs, node) {
1238 sprintf(first_half, "%s %s", desc->name,
1239 desc->args ? desc->args : "");
1240 fprintf(stdout, " %-36s %s\n", first_half,
1241 desc->half_liner ? desc->half_liner : "");
1242 }
1243
1244 exit(0);
1245}
1246
49e639e2
FT
1247/*
1248 * Some scripts specify the required events in their "xxx-record" file,
1249 * this function will check if the events in perf.data match those
1250 * mentioned in the "xxx-record".
1251 *
1252 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1253 * which is covered well now. And new parsing code should be added to
1254 * cover the future complexing formats like event groups etc.
1255 */
1256static int check_ev_match(char *dir_name, char *scriptname,
1257 struct perf_session *session)
1258{
1259 char filename[MAXPATHLEN], evname[128];
1260 char line[BUFSIZ], *p;
1261 struct perf_evsel *pos;
1262 int match, len;
1263 FILE *fp;
1264
1265 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1266
1267 fp = fopen(filename, "r");
1268 if (!fp)
1269 return -1;
1270
1271 while (fgets(line, sizeof(line), fp)) {
1272 p = ltrim(line);
1273 if (*p == '#')
1274 continue;
1275
1276 while (strlen(p)) {
1277 p = strstr(p, "-e");
1278 if (!p)
1279 break;
1280
1281 p += 2;
1282 p = ltrim(p);
1283 len = strcspn(p, " \t");
1284 if (!len)
1285 break;
1286
1287 snprintf(evname, len + 1, "%s", p);
1288
1289 match = 0;
0050f7aa 1290 evlist__for_each(session->evlist, pos) {
49e639e2
FT
1291 if (!strcmp(perf_evsel__name(pos), evname)) {
1292 match = 1;
1293 break;
1294 }
1295 }
1296
1297 if (!match) {
1298 fclose(fp);
1299 return -1;
1300 }
1301 }
1302 }
1303
1304 fclose(fp);
1305 return 0;
1306}
1307
e5f3705e
FT
1308/*
1309 * Return -1 if none is found, otherwise the actual scripts number.
1310 *
1311 * Currently the only user of this function is the script browser, which
1312 * will list all statically runnable scripts, select one, execute it and
1313 * show the output in a perf browser.
1314 */
1315int find_scripts(char **scripts_array, char **scripts_path_array)
1316{
1317 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
49e639e2 1318 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
e5f3705e 1319 DIR *scripts_dir, *lang_dir;
49e639e2 1320 struct perf_session *session;
f5fc1412
JO
1321 struct perf_data_file file = {
1322 .path = input_name,
1323 .mode = PERF_DATA_MODE_READ,
1324 };
e5f3705e
FT
1325 char *temp;
1326 int i = 0;
1327
f5fc1412 1328 session = perf_session__new(&file, false, NULL);
49e639e2
FT
1329 if (!session)
1330 return -1;
1331
e5f3705e
FT
1332 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1333
1334 scripts_dir = opendir(scripts_path);
49e639e2
FT
1335 if (!scripts_dir) {
1336 perf_session__delete(session);
e5f3705e 1337 return -1;
49e639e2 1338 }
e5f3705e
FT
1339
1340 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1341 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1342 lang_dirent.d_name);
1343#ifdef NO_LIBPERL
1344 if (strstr(lang_path, "perl"))
1345 continue;
1346#endif
1347#ifdef NO_LIBPYTHON
1348 if (strstr(lang_path, "python"))
1349 continue;
1350#endif
1351
1352 lang_dir = opendir(lang_path);
1353 if (!lang_dir)
1354 continue;
1355
1356 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1357 /* Skip those real time scripts: xxxtop.p[yl] */
1358 if (strstr(script_dirent.d_name, "top."))
1359 continue;
1360 sprintf(scripts_path_array[i], "%s/%s", lang_path,
1361 script_dirent.d_name);
1362 temp = strchr(script_dirent.d_name, '.');
1363 snprintf(scripts_array[i],
1364 (temp - script_dirent.d_name) + 1,
1365 "%s", script_dirent.d_name);
49e639e2
FT
1366
1367 if (check_ev_match(lang_path,
1368 scripts_array[i], session))
1369 continue;
1370
e5f3705e
FT
1371 i++;
1372 }
49e639e2 1373 closedir(lang_dir);
e5f3705e
FT
1374 }
1375
49e639e2
FT
1376 closedir(scripts_dir);
1377 perf_session__delete(session);
e5f3705e
FT
1378 return i;
1379}
1380
3875294f
TZ
1381static char *get_script_path(const char *script_root, const char *suffix)
1382{
1383 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1384 char scripts_path[MAXPATHLEN];
1385 char script_path[MAXPATHLEN];
1386 DIR *scripts_dir, *lang_dir;
1387 char lang_path[MAXPATHLEN];
38efb539 1388 char *__script_root;
3875294f
TZ
1389
1390 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1391
1392 scripts_dir = opendir(scripts_path);
1393 if (!scripts_dir)
1394 return NULL;
1395
008f29d3 1396 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
3875294f
TZ
1397 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1398 lang_dirent.d_name);
1399 lang_dir = opendir(lang_path);
1400 if (!lang_dir)
1401 continue;
1402
008f29d3 1403 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
38efb539
RR
1404 __script_root = get_script_root(&script_dirent, suffix);
1405 if (__script_root && !strcmp(script_root, __script_root)) {
1406 free(__script_root);
946ef2a2
NK
1407 closedir(lang_dir);
1408 closedir(scripts_dir);
3875294f
TZ
1409 snprintf(script_path, MAXPATHLEN, "%s/%s",
1410 lang_path, script_dirent.d_name);
38efb539 1411 return strdup(script_path);
3875294f
TZ
1412 }
1413 free(__script_root);
1414 }
946ef2a2 1415 closedir(lang_dir);
3875294f 1416 }
946ef2a2 1417 closedir(scripts_dir);
3875294f 1418
38efb539 1419 return NULL;
3875294f
TZ
1420}
1421
b5b87312
TZ
1422static bool is_top_script(const char *script_path)
1423{
965bb6be 1424 return ends_with(script_path, "top") == NULL ? false : true;
b5b87312
TZ
1425}
1426
1427static int has_required_arg(char *script_path)
1428{
1429 struct script_desc *desc;
1430 int n_args = 0;
1431 char *p;
1432
1433 desc = script_desc__new(NULL);
1434
1435 if (read_script_info(desc, script_path))
1436 goto out;
1437
1438 if (!desc->args)
1439 goto out;
1440
1441 for (p = desc->args; *p; p++)
1442 if (*p == '<')
1443 n_args++;
1444out:
1445 script_desc__delete(desc);
1446
1447 return n_args;
1448}
1449
69b6470e
ACM
1450static int have_cmd(int argc, const char **argv)
1451{
1452 char **__argv = malloc(sizeof(const char *) * argc);
1453
1454 if (!__argv) {
1455 pr_err("malloc failed\n");
1456 return -1;
1457 }
1458
1459 memcpy(__argv, argv, sizeof(const char *) * argc);
1460 argc = parse_options(argc, (const char **)__argv, record_options,
1461 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1462 free(__argv);
5f9c39dc 1463
69b6470e
ACM
1464 system_wide = (argc == 0);
1465
1466 return 0;
1467}
1468
1469int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
1470{
1471 bool show_full_info = false;
e90debdd
JO
1472 bool header = false;
1473 bool header_only = false;
6cc870f0 1474 bool script_started = false;
69b6470e
ACM
1475 char *rec_script_path = NULL;
1476 char *rep_script_path = NULL;
1477 struct perf_session *session;
1478 char *script_path = NULL;
1479 const char **__argv;
6cc870f0 1480 int i, j, err = 0;
6f3e5eda
AH
1481 struct perf_script script = {
1482 .tool = {
1483 .sample = process_sample_event,
1484 .mmap = perf_event__process_mmap,
1485 .mmap2 = perf_event__process_mmap2,
1486 .comm = perf_event__process_comm,
1487 .exit = perf_event__process_exit,
1488 .fork = perf_event__process_fork,
7ea95727 1489 .attr = process_attr,
6f3e5eda
AH
1490 .tracing_data = perf_event__process_tracing_data,
1491 .build_id = perf_event__process_build_id,
0a8cb85c 1492 .ordered_events = true,
6f3e5eda
AH
1493 .ordering_requires_timestamps = true,
1494 },
1495 };
69b6470e 1496 const struct option options[] = {
5f9c39dc
FW
1497 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1498 "dump raw trace in ASCII"),
c0555642 1499 OPT_INCR('v', "verbose", &verbose,
69b6470e 1500 "be more verbose (show symbol address, etc)"),
4b9c0c59 1501 OPT_BOOLEAN('L', "Latency", &latency_format,
cda48461 1502 "show latency attributes (irqs/preemption disabled, etc)"),
4b9c0c59
TZ
1503 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1504 list_available_scripts),
956ffd02
TZ
1505 OPT_CALLBACK('s', "script", NULL, "name",
1506 "script file name (lang:script name, script name, or *)",
1507 parse_scriptname),
1508 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
133dc4c3 1509 "generate perf-script.xx script in specified language"),
69b6470e 1510 OPT_STRING('i', "input", &input_name, "file", "input file name"),
ffabd99e
FW
1511 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1512 "do various checks like samples ordering and lost events"),
e90debdd
JO
1513 OPT_BOOLEAN(0, "header", &header, "Show data header."),
1514 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
c0230b2b
DA
1515 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1516 "file", "vmlinux pathname"),
1517 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1518 "file", "kallsyms pathname"),
1519 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1520 "When printing symbols do not display call chain"),
1521 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1522 "Look for files with symbols relative to this directory"),
745f43e3 1523 OPT_CALLBACK('f', "fields", NULL, "str",
a978f2ab
AN
1524 "comma separated output fields prepend with 'type:'. "
1525 "Valid types: hw,sw,trace,raw. "
1526 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
69b6470e 1527 "addr,symoff", parse_output_fields),
317df650 1528 OPT_BOOLEAN('a', "all-cpus", &system_wide,
69b6470e 1529 "system-wide collection from all CPUs"),
36385be5
FT
1530 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1531 "only consider these symbols"),
c8e66720 1532 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
e7984b7b
DA
1533 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1534 "only display events for these comms"),
fbe96f29
SE
1535 OPT_BOOLEAN('I', "show-info", &show_full_info,
1536 "display extended information from perf.data file"),
0bc8d205
AN
1537 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
1538 "Show the path of [kernel.kallsyms]"),
ad7ebb9a
NK
1539 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
1540 "Show the fork/comm/exit events"),
ba1ddf42
NK
1541 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
1542 "Show the mmap events"),
1909629f 1543 OPT_END()
69b6470e
ACM
1544 };
1545 const char * const script_usage[] = {
1546 "perf script [<options>]",
1547 "perf script [<options>] record <script> [<record-options>] <command>",
1548 "perf script [<options>] report <script> [script-args]",
1549 "perf script [<options>] <script> [<record-options>] <command>",
1550 "perf script [<options>] <top-script> [script-args]",
1551 NULL
1552 };
f5fc1412
JO
1553 struct perf_data_file file = {
1554 .mode = PERF_DATA_MODE_READ,
1555 };
3875294f 1556
b5b87312
TZ
1557 setup_scripting();
1558
133dc4c3 1559 argc = parse_options(argc, argv, options, script_usage,
b5b87312
TZ
1560 PARSE_OPT_STOP_AT_NON_OPTION);
1561
f5fc1412
JO
1562 file.path = input_name;
1563
b5b87312
TZ
1564 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1565 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1566 if (!rec_script_path)
1567 return cmd_record(argc, argv, NULL);
3875294f
TZ
1568 }
1569
b5b87312
TZ
1570 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1571 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1572 if (!rep_script_path) {
3875294f 1573 fprintf(stderr,
b5b87312 1574 "Please specify a valid report script"
133dc4c3 1575 "(see 'perf script -l' for listing)\n");
3875294f
TZ
1576 return -1;
1577 }
3875294f
TZ
1578 }
1579
44e668c6
BH
1580 /* make sure PERF_EXEC_PATH is set for scripts */
1581 perf_set_argv_exec_path(perf_exec_path());
1582
b5b87312 1583 if (argc && !script_name && !rec_script_path && !rep_script_path) {
a0cccc2e 1584 int live_pipe[2];
b5b87312 1585 int rep_args;
a0cccc2e
TZ
1586 pid_t pid;
1587
b5b87312
TZ
1588 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1589 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1590
1591 if (!rec_script_path && !rep_script_path) {
1592 fprintf(stderr, " Couldn't find script %s\n\n See perf"
133dc4c3
IM
1593 " script -l for available scripts.\n", argv[0]);
1594 usage_with_options(script_usage, options);
a0cccc2e
TZ
1595 }
1596
b5b87312
TZ
1597 if (is_top_script(argv[0])) {
1598 rep_args = argc - 1;
1599 } else {
1600 int rec_args;
1601
1602 rep_args = has_required_arg(rep_script_path);
1603 rec_args = (argc - 1) - rep_args;
1604 if (rec_args < 0) {
1605 fprintf(stderr, " %s script requires options."
133dc4c3 1606 "\n\n See perf script -l for available "
b5b87312 1607 "scripts and options.\n", argv[0]);
133dc4c3 1608 usage_with_options(script_usage, options);
b5b87312 1609 }
a0cccc2e
TZ
1610 }
1611
1612 if (pipe(live_pipe) < 0) {
1613 perror("failed to create pipe");
d54b1a9e 1614 return -1;
a0cccc2e
TZ
1615 }
1616
1617 pid = fork();
1618 if (pid < 0) {
1619 perror("failed to fork");
d54b1a9e 1620 return -1;
a0cccc2e
TZ
1621 }
1622
1623 if (!pid) {
b5b87312
TZ
1624 j = 0;
1625
a0cccc2e
TZ
1626 dup2(live_pipe[1], 1);
1627 close(live_pipe[0]);
1628
317df650
RR
1629 if (is_top_script(argv[0])) {
1630 system_wide = true;
1631 } else if (!system_wide) {
d54b1a9e
DA
1632 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
1633 err = -1;
1634 goto out;
1635 }
317df650 1636 }
b5b87312
TZ
1637
1638 __argv = malloc((argc + 6) * sizeof(const char *));
d54b1a9e
DA
1639 if (!__argv) {
1640 pr_err("malloc failed\n");
1641 err = -ENOMEM;
1642 goto out;
1643 }
e8719adf 1644
b5b87312
TZ
1645 __argv[j++] = "/bin/sh";
1646 __argv[j++] = rec_script_path;
1647 if (system_wide)
1648 __argv[j++] = "-a";
1649 __argv[j++] = "-q";
1650 __argv[j++] = "-o";
1651 __argv[j++] = "-";
1652 for (i = rep_args + 1; i < argc; i++)
1653 __argv[j++] = argv[i];
1654 __argv[j++] = NULL;
a0cccc2e
TZ
1655
1656 execvp("/bin/sh", (char **)__argv);
e8719adf 1657 free(__argv);
a0cccc2e
TZ
1658 exit(-1);
1659 }
1660
1661 dup2(live_pipe[0], 0);
1662 close(live_pipe[1]);
1663
b5b87312 1664 __argv = malloc((argc + 4) * sizeof(const char *));
d54b1a9e
DA
1665 if (!__argv) {
1666 pr_err("malloc failed\n");
1667 err = -ENOMEM;
1668 goto out;
1669 }
1670
b5b87312
TZ
1671 j = 0;
1672 __argv[j++] = "/bin/sh";
1673 __argv[j++] = rep_script_path;
1674 for (i = 1; i < rep_args + 1; i++)
1675 __argv[j++] = argv[i];
1676 __argv[j++] = "-i";
1677 __argv[j++] = "-";
1678 __argv[j++] = NULL;
a0cccc2e
TZ
1679
1680 execvp("/bin/sh", (char **)__argv);
e8719adf 1681 free(__argv);
a0cccc2e
TZ
1682 exit(-1);
1683 }
1684
b5b87312
TZ
1685 if (rec_script_path)
1686 script_path = rec_script_path;
1687 if (rep_script_path)
1688 script_path = rep_script_path;
34c86ea9 1689
b5b87312 1690 if (script_path) {
b5b87312 1691 j = 0;
3875294f 1692
317df650
RR
1693 if (!rec_script_path)
1694 system_wide = false;
d54b1a9e
DA
1695 else if (!system_wide) {
1696 if (have_cmd(argc - 1, &argv[1]) != 0) {
1697 err = -1;
1698 goto out;
1699 }
1700 }
34c86ea9 1701
b5b87312 1702 __argv = malloc((argc + 2) * sizeof(const char *));
d54b1a9e
DA
1703 if (!__argv) {
1704 pr_err("malloc failed\n");
1705 err = -ENOMEM;
1706 goto out;
1707 }
1708
34c86ea9
TZ
1709 __argv[j++] = "/bin/sh";
1710 __argv[j++] = script_path;
1711 if (system_wide)
1712 __argv[j++] = "-a";
b5b87312 1713 for (i = 2; i < argc; i++)
34c86ea9
TZ
1714 __argv[j++] = argv[i];
1715 __argv[j++] = NULL;
3875294f
TZ
1716
1717 execvp("/bin/sh", (char **)__argv);
e8719adf 1718 free(__argv);
3875294f
TZ
1719 exit(-1);
1720 }
956ffd02 1721
cf4fee50
TZ
1722 if (!script_name)
1723 setup_pager();
5f9c39dc 1724
6f3e5eda 1725 session = perf_session__new(&file, false, &script.tool);
d8f66248
ACM
1726 if (session == NULL)
1727 return -ENOMEM;
1728
e90debdd
JO
1729 if (header || header_only) {
1730 perf_session__fprintf_info(session, stdout, show_full_info);
1731 if (header_only)
6cc870f0 1732 goto out_delete;
e90debdd
JO
1733 }
1734
0a7e6d1b 1735 if (symbol__init(&session->header.env) < 0)
38520dc3
NK
1736 goto out_delete;
1737
6f3e5eda
AH
1738 script.session = session;
1739
5d67be97 1740 if (cpu_list) {
6cc870f0
NK
1741 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
1742 if (err < 0)
1743 goto out_delete;
5d67be97
AB
1744 }
1745
1424dc96 1746 if (!no_callchain)
c0230b2b
DA
1747 symbol_conf.use_callchain = true;
1748 else
1749 symbol_conf.use_callchain = false;
1750
956ffd02
TZ
1751 if (generate_script_lang) {
1752 struct stat perf_stat;
745f43e3
DA
1753 int input;
1754
2c9e45f7 1755 if (output_set_by_user()) {
745f43e3
DA
1756 fprintf(stderr,
1757 "custom fields not supported for generated scripts");
6cc870f0
NK
1758 err = -EINVAL;
1759 goto out_delete;
745f43e3 1760 }
956ffd02 1761
cc9784bd 1762 input = open(file.path, O_RDONLY); /* input_name */
956ffd02 1763 if (input < 0) {
6cc870f0 1764 err = -errno;
956ffd02 1765 perror("failed to open file");
6cc870f0 1766 goto out_delete;
956ffd02
TZ
1767 }
1768
1769 err = fstat(input, &perf_stat);
1770 if (err < 0) {
1771 perror("failed to stat file");
6cc870f0 1772 goto out_delete;
956ffd02
TZ
1773 }
1774
1775 if (!perf_stat.st_size) {
1776 fprintf(stderr, "zero-sized file, nothing to do!\n");
6cc870f0 1777 goto out_delete;
956ffd02
TZ
1778 }
1779
1780 scripting_ops = script_spec__lookup(generate_script_lang);
1781 if (!scripting_ops) {
1782 fprintf(stderr, "invalid language specifier");
6cc870f0
NK
1783 err = -ENOENT;
1784 goto out_delete;
956ffd02
TZ
1785 }
1786
29f5ffd3 1787 err = scripting_ops->generate_script(session->tevent.pevent,
da378962 1788 "perf-script");
6cc870f0 1789 goto out_delete;
956ffd02
TZ
1790 }
1791
1792 if (script_name) {
586bc5cc 1793 err = scripting_ops->start_script(script_name, argc, argv);
956ffd02 1794 if (err)
6cc870f0 1795 goto out_delete;
133dc4c3 1796 pr_debug("perf script started with script %s\n\n", script_name);
6cc870f0 1797 script_started = true;
956ffd02
TZ
1798 }
1799
9cbdb702
DA
1800
1801 err = perf_session__check_output_opt(session);
1802 if (err < 0)
6cc870f0 1803 goto out_delete;
9cbdb702 1804
6f3e5eda 1805 err = __cmd_script(&script);
956ffd02 1806
6cc870f0 1807out_delete:
d8f66248 1808 perf_session__delete(session);
6cc870f0
NK
1809
1810 if (script_started)
1811 cleanup_scripting();
956ffd02
TZ
1812out:
1813 return err;
5f9c39dc 1814}