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