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