?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Linux 4.1.18
[linux/fpc-iii.git] / tools / perf / builtin-script.c
blob58f10b8e6ff20d51429634b8f79628188fbc2dd4
1 #include "builtin.h"
2
3 #include "perf.h"
4 #include "util/cache.h"
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"
10 #include "util/tool.h"
11 #include "util/symbol.h"
12 #include "util/thread.h"
13 #include "util/trace-event.h"
14 #include "util/util.h"
15 #include "util/evlist.h"
16 #include "util/evsel.h"
17 #include "util/sort.h"
18 #include "util/data.h"
19 #include <linux/bitmap.h>
20
21 static char const *script_name;
22 static char const *generate_script_lang;
23 static bool debug_mode;
24 static u64 last_timestamp;
25 static u64 nr_unordered;
26 static bool no_callchain;
27 static bool latency_format;
28 static bool system_wide;
29 static const char *cpu_list;
30 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
31
32 enum perf_output_field {
33 PERF_OUTPUT_COMM = 1U << 0,
34 PERF_OUTPUT_TID = 1U << 1,
35 PERF_OUTPUT_PID = 1U << 2,
36 PERF_OUTPUT_TIME = 1U << 3,
37 PERF_OUTPUT_CPU = 1U << 4,
38 PERF_OUTPUT_EVNAME = 1U << 5,
39 PERF_OUTPUT_TRACE = 1U << 6,
40 PERF_OUTPUT_IP = 1U << 7,
41 PERF_OUTPUT_SYM = 1U << 8,
42 PERF_OUTPUT_DSO = 1U << 9,
43 PERF_OUTPUT_ADDR = 1U << 10,
44 PERF_OUTPUT_SYMOFFSET = 1U << 11,
45 PERF_OUTPUT_SRCLINE = 1U << 12,
46 PERF_OUTPUT_PERIOD = 1U << 13,
47 };
48
49 struct 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},
60 {.str = "ip", .field = PERF_OUTPUT_IP},
61 {.str = "sym", .field = PERF_OUTPUT_SYM},
62 {.str = "dso", .field = PERF_OUTPUT_DSO},
63 {.str = "addr", .field = PERF_OUTPUT_ADDR},
64 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
65 {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
66 {.str = "period", .field = PERF_OUTPUT_PERIOD},
67 };
68
69 /* default set to maintain compatibility with current format */
70 static struct {
71 bool user_set;
72 bool wildcard_set;
73 unsigned int print_ip_opts;
74 u64 fields;
75 u64 invalid_fields;
76 } output[PERF_TYPE_MAX] = {
77
78 [PERF_TYPE_HARDWARE] = {
79 .user_set = false,
80
81 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
82 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
83 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
84 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
85 PERF_OUTPUT_PERIOD,
86
87 .invalid_fields = PERF_OUTPUT_TRACE,
88 },
89
90 [PERF_TYPE_SOFTWARE] = {
91 .user_set = false,
92
93 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
94 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
95 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
96 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
97 PERF_OUTPUT_PERIOD,
98
99 .invalid_fields = PERF_OUTPUT_TRACE,
100 },
101
102 [PERF_TYPE_TRACEPOINT] = {
103 .user_set = false,
104
105 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
106 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
107 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
108 },
109
110 [PERF_TYPE_RAW] = {
111 .user_set = false,
112
113 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
114 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
115 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
116 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO |
117 PERF_OUTPUT_PERIOD,
118
119 .invalid_fields = PERF_OUTPUT_TRACE,
120 },
121 };
122
123 static bool output_set_by_user(void)
124 {
125 int j;
126 for (j = 0; j < PERF_TYPE_MAX; ++j) {
127 if (output[j].user_set)
128 return true;
129 }
130 return false;
131 }
132
133 static const char *output_field2str(enum perf_output_field field)
134 {
135 int i, imax = ARRAY_SIZE(all_output_options);
136 const char *str = "";
137
138 for (i = 0; i < imax; ++i) {
139 if (all_output_options[i].field == field) {
140 str = all_output_options[i].str;
141 break;
142 }
143 }
144 return str;
145 }
146
147 #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
148
149 static int perf_evsel__check_stype(struct perf_evsel *evsel,
150 u64 sample_type, const char *sample_msg,
151 enum perf_output_field field)
152 {
153 struct perf_event_attr *attr = &evsel->attr;
154 int type = attr->type;
155 const char *evname;
156
157 if (attr->sample_type & sample_type)
158 return 0;
159
160 if (output[type].user_set) {
161 evname = perf_evsel__name(evsel);
162 pr_err("Samples for '%s' event do not have %s attribute set. "
163 "Cannot print '%s' field.\n",
164 evname, sample_msg, output_field2str(field));
165 return -1;
166 }
167
168 /* user did not ask for it explicitly so remove from the default list */
169 output[type].fields &= ~field;
170 evname = perf_evsel__name(evsel);
171 pr_debug("Samples for '%s' event do not have %s attribute set. "
172 "Skipping '%s' field.\n",
173 evname, sample_msg, output_field2str(field));
174
175 return 0;
176 }
177
178 static int perf_evsel__check_attr(struct perf_evsel *evsel,
179 struct perf_session *session)
180 {
181 struct perf_event_attr *attr = &evsel->attr;
182
183 if (PRINT_FIELD(TRACE) &&
184 !perf_session__has_traces(session, "record -R"))
185 return -EINVAL;
186
187 if (PRINT_FIELD(IP)) {
188 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
189 PERF_OUTPUT_IP))
190 return -EINVAL;
191 }
192
193 if (PRINT_FIELD(ADDR) &&
194 perf_evsel__check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
195 PERF_OUTPUT_ADDR))
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");
202 return -EINVAL;
203 }
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 }
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");
213 return -EINVAL;
214 }
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 }
220
221 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
222 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
223 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
224 return -EINVAL;
225
226 if (PRINT_FIELD(TIME) &&
227 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
228 PERF_OUTPUT_TIME))
229 return -EINVAL;
230
231 if (PRINT_FIELD(CPU) &&
232 perf_evsel__check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
233 PERF_OUTPUT_CPU))
234 return -EINVAL;
235
236 if (PRINT_FIELD(PERIOD) &&
237 perf_evsel__check_stype(evsel, PERF_SAMPLE_PERIOD, "PERIOD",
238 PERF_OUTPUT_PERIOD))
239 return -EINVAL;
240
241 return 0;
242 }
243
244 static void set_print_ip_opts(struct perf_event_attr *attr)
245 {
246 unsigned int type = attr->type;
247
248 output[type].print_ip_opts = 0;
249 if (PRINT_FIELD(IP))
250 output[type].print_ip_opts |= PRINT_IP_OPT_IP;
251
252 if (PRINT_FIELD(SYM))
253 output[type].print_ip_opts |= PRINT_IP_OPT_SYM;
254
255 if (PRINT_FIELD(DSO))
256 output[type].print_ip_opts |= PRINT_IP_OPT_DSO;
257
258 if (PRINT_FIELD(SYMOFFSET))
259 output[type].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET;
260
261 if (PRINT_FIELD(SRCLINE))
262 output[type].print_ip_opts |= PRINT_IP_OPT_SRCLINE;
263 }
264
265 /*
266 * verify all user requested events exist and the samples
267 * have the expected data
268 */
269 static int perf_session__check_output_opt(struct perf_session *session)
270 {
271 int j;
272 struct perf_evsel *evsel;
273
274 for (j = 0; j < PERF_TYPE_MAX; ++j) {
275 evsel = perf_session__find_first_evtype(session, j);
276
277 /*
278 * even if fields is set to 0 (ie., show nothing) event must
279 * exist if user explicitly includes it on the command line
280 */
281 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
282 pr_err("%s events do not exist. "
283 "Remove corresponding -f option to proceed.\n",
284 event_type(j));
285 return -1;
286 }
287
288 if (evsel && output[j].fields &&
289 perf_evsel__check_attr(evsel, session))
290 return -1;
291
292 if (evsel == NULL)
293 continue;
294
295 set_print_ip_opts(&evsel->attr);
296 }
297
298 if (!no_callchain) {
299 bool use_callchain = false;
300
301 evlist__for_each(session->evlist, evsel) {
302 if (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) {
303 use_callchain = true;
304 break;
305 }
306 }
307 if (!use_callchain)
308 symbol_conf.use_callchain = false;
309 }
310
311 /*
312 * set default for tracepoints to print symbols only
313 * if callchains are present
314 */
315 if (symbol_conf.use_callchain &&
316 !output[PERF_TYPE_TRACEPOINT].user_set) {
317 struct perf_event_attr *attr;
318
319 j = PERF_TYPE_TRACEPOINT;
320 evsel = perf_session__find_first_evtype(session, j);
321 if (evsel == NULL)
322 goto out;
323
324 attr = &evsel->attr;
325
326 if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
327 output[j].fields |= PERF_OUTPUT_IP;
328 output[j].fields |= PERF_OUTPUT_SYM;
329 output[j].fields |= PERF_OUTPUT_DSO;
330 set_print_ip_opts(attr);
331 }
332 }
333
334 out:
335 return 0;
336 }
337
338 static void print_sample_start(struct perf_sample *sample,
339 struct thread *thread,
340 struct perf_evsel *evsel)
341 {
342 struct perf_event_attr *attr = &evsel->attr;
343 unsigned long secs;
344 unsigned long usecs;
345 unsigned long long nsecs;
346
347 if (PRINT_FIELD(COMM)) {
348 if (latency_format)
349 printf("%8.8s ", thread__comm_str(thread));
350 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
351 printf("%s ", thread__comm_str(thread));
352 else
353 printf("%16s ", thread__comm_str(thread));
354 }
355
356 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
357 printf("%5d/%-5d ", sample->pid, sample->tid);
358 else if (PRINT_FIELD(PID))
359 printf("%5d ", sample->pid);
360 else if (PRINT_FIELD(TID))
361 printf("%5d ", sample->tid);
362
363 if (PRINT_FIELD(CPU)) {
364 if (latency_format)
365 printf("%3d ", sample->cpu);
366 else
367 printf("[%03d] ", sample->cpu);
368 }
369
370 if (PRINT_FIELD(TIME)) {
371 nsecs = sample->time;
372 secs = nsecs / NSECS_PER_SEC;
373 nsecs -= secs * NSECS_PER_SEC;
374 usecs = nsecs / NSECS_PER_USEC;
375 printf("%5lu.%06lu: ", secs, usecs);
376 }
377 }
378
379 static void print_sample_addr(union perf_event *event,
380 struct perf_sample *sample,
381 struct thread *thread,
382 struct perf_event_attr *attr)
383 {
384 struct addr_location al;
385
386 printf("%16" PRIx64, sample->addr);
387
388 if (!sample_addr_correlates_sym(attr))
389 return;
390
391 perf_event__preprocess_sample_addr(event, sample, thread, &al);
392
393 if (PRINT_FIELD(SYM)) {
394 printf(" ");
395 if (PRINT_FIELD(SYMOFFSET))
396 symbol__fprintf_symname_offs(al.sym, &al, stdout);
397 else
398 symbol__fprintf_symname(al.sym, stdout);
399 }
400
401 if (PRINT_FIELD(DSO)) {
402 printf(" (");
403 map__fprintf_dsoname(al.map, stdout);
404 printf(")");
405 }
406 }
407
408 static void print_sample_bts(union perf_event *event,
409 struct perf_sample *sample,
410 struct perf_evsel *evsel,
411 struct thread *thread,
412 struct addr_location *al)
413 {
414 struct perf_event_attr *attr = &evsel->attr;
415 bool print_srcline_last = false;
416
417 /* print branch_from information */
418 if (PRINT_FIELD(IP)) {
419 unsigned int print_opts = output[attr->type].print_ip_opts;
420
421 if (symbol_conf.use_callchain && sample->callchain) {
422 printf("\n");
423 } else {
424 printf(" ");
425 if (print_opts & PRINT_IP_OPT_SRCLINE) {
426 print_srcline_last = true;
427 print_opts &= ~PRINT_IP_OPT_SRCLINE;
428 }
429 }
430 perf_evsel__print_ip(evsel, sample, al, print_opts,
431 PERF_MAX_STACK_DEPTH);
432 }
433
434 /* print branch_to information */
435 if (PRINT_FIELD(ADDR) ||
436 ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
437 !output[attr->type].user_set)) {
438 printf(" => ");
439 print_sample_addr(event, sample, thread, attr);
440 }
441
442 if (print_srcline_last)
443 map__fprintf_srcline(al->map, al->addr, "\n ", stdout);
444
445 printf("\n");
446 }
447
448 static void process_event(union perf_event *event, struct perf_sample *sample,
449 struct perf_evsel *evsel, struct addr_location *al)
450 {
451 struct thread *thread = al->thread;
452 struct perf_event_attr *attr = &evsel->attr;
453
454 if (output[attr->type].fields == 0)
455 return;
456
457 print_sample_start(sample, thread, evsel);
458
459 if (PRINT_FIELD(PERIOD))
460 printf("%10" PRIu64 " ", sample->period);
461
462 if (PRINT_FIELD(EVNAME)) {
463 const char *evname = perf_evsel__name(evsel);
464 printf("%s: ", evname ? evname : "[unknown]");
465 }
466
467 if (is_bts_event(attr)) {
468 print_sample_bts(event, sample, evsel, thread, al);
469 return;
470 }
471
472 if (PRINT_FIELD(TRACE))
473 event_format__print(evsel->tp_format, sample->cpu,
474 sample->raw_data, sample->raw_size);
475 if (PRINT_FIELD(ADDR))
476 print_sample_addr(event, sample, thread, attr);
477
478 if (PRINT_FIELD(IP)) {
479 if (!symbol_conf.use_callchain)
480 printf(" ");
481 else
482 printf("\n");
483
484 perf_evsel__print_ip(evsel, sample, al,
485 output[attr->type].print_ip_opts,
486 PERF_MAX_STACK_DEPTH);
487 }
488
489 printf("\n");
490 }
491
492 static int default_start_script(const char *script __maybe_unused,
493 int argc __maybe_unused,
494 const char **argv __maybe_unused)
495 {
496 return 0;
497 }
498
499 static int default_flush_script(void)
500 {
501 return 0;
502 }
503
504 static int default_stop_script(void)
505 {
506 return 0;
507 }
508
509 static int default_generate_script(struct pevent *pevent __maybe_unused,
510 const char *outfile __maybe_unused)
511 {
512 return 0;
513 }
514
515 static struct scripting_ops default_scripting_ops = {
516 .start_script = default_start_script,
517 .flush_script = default_flush_script,
518 .stop_script = default_stop_script,
519 .process_event = process_event,
520 .generate_script = default_generate_script,
521 };
522
523 static struct scripting_ops *scripting_ops;
524
525 static void setup_scripting(void)
526 {
527 setup_perl_scripting();
528 setup_python_scripting();
529
530 scripting_ops = &default_scripting_ops;
531 }
532
533 static int flush_scripting(void)
534 {
535 return scripting_ops->flush_script();
536 }
537
538 static int cleanup_scripting(void)
539 {
540 pr_debug("\nperf script stopped\n");
541
542 return scripting_ops->stop_script();
543 }
544
545 static int process_sample_event(struct perf_tool *tool __maybe_unused,
546 union perf_event *event,
547 struct perf_sample *sample,
548 struct perf_evsel *evsel,
549 struct machine *machine)
550 {
551 struct addr_location al;
552
553 if (debug_mode) {
554 if (sample->time < last_timestamp) {
555 pr_err("Samples misordered, previous: %" PRIu64
556 " this: %" PRIu64 "\n", last_timestamp,
557 sample->time);
558 nr_unordered++;
559 }
560 last_timestamp = sample->time;
561 return 0;
562 }
563
564 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
565 pr_err("problem processing %d event, skipping it.\n",
566 event->header.type);
567 return -1;
568 }
569
570 if (al.filtered)
571 return 0;
572
573 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
574 return 0;
575
576 scripting_ops->process_event(event, sample, evsel, &al);
577
578 return 0;
579 }
580
581 struct perf_script {
582 struct perf_tool tool;
583 struct perf_session *session;
584 bool show_task_events;
585 bool show_mmap_events;
586 };
587
588 static 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 evlist__for_each(evlist, pos) {
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
616 static 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
646 out:
647 return ret;
648 }
649
650 static 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 }
680 static 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
711 static 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
742 static 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
773 static void sig_handler(int sig __maybe_unused)
774 {
775 session_done = 1;
776 }
777
778 static int __cmd_script(struct perf_script *script)
779 {
780 int ret;
781
782 signal(SIGINT, sig_handler);
783
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 }
790 if (script->show_mmap_events) {
791 script->tool.mmap = process_mmap_event;
792 script->tool.mmap2 = process_mmap2_event;
793 }
794
795 ret = perf_session__process_events(script->session);
796
797 if (debug_mode)
798 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
799
800 return ret;
801 }
802
803 struct script_spec {
804 struct list_head node;
805 struct scripting_ops *ops;
806 char spec[0];
807 };
808
809 static LIST_HEAD(script_specs);
810
811 static 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
824 static void script_spec__add(struct script_spec *s)
825 {
826 list_add_tail(&s->node, &script_specs);
827 }
828
829 static 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
839 static 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)
849 return NULL;
850
851 script_spec__add(s);
852
853 return s;
854 }
855
856 int 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
871 static 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
880 static void list_available_languages(void)
881 {
882 struct script_spec *s;
883
884 fprintf(stderr, "\n");
885 fprintf(stderr, "Scripting language extensions (used in "
886 "perf script -s [spec:]script.[spec]):\n\n");
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
894 static int parse_scriptname(const struct option *opt __maybe_unused,
895 const char *str, int unset __maybe_unused)
896 {
897 char spec[PATH_MAX];
898 const char *script, *ext;
899 int len;
900
901 if (strcmp(str, "lang") == 0) {
902 list_available_languages();
903 exit(0);
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;
923 ext = strrchr(script, '.');
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
940 static int parse_output_fields(const struct option *opt __maybe_unused,
941 const char *arg, int unset __maybe_unused)
942 {
943 char *tok;
944 int i, imax = ARRAY_SIZE(all_output_options);
945 int j;
946 int rc = 0;
947 char *str = strdup(arg);
948 int type = -1;
949
950 if (!str)
951 return -ENOMEM;
952
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.
956 */
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;
967 else if (!strcmp(str, "raw"))
968 type = PERF_TYPE_RAW;
969 else {
970 fprintf(stderr, "Invalid event type in field string.\n");
971 rc = -EINVAL;
972 goto out;
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;
981 output[type].wildcard_set = false;
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;
998 output[j].wildcard_set = true;
999 }
1000 }
1001
1002 tok = strtok(tok, ",");
1003 while (tok) {
1004 for (i = 0; i < imax; ++i) {
1005 if (strcmp(tok, all_output_options[i].str) == 0)
1006 break;
1007 }
1008 if (i == imax) {
1009 fprintf(stderr, "Invalid field requested.\n");
1010 rc = -EINVAL;
1011 goto out;
1012 }
1013
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, ",");
1037 }
1038
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 }
1045
1046 out:
1047 free(str);
1048 return rc;
1049 }
1050
1051 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1052 static 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)\
1065 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
1066 lang_next) \
1067 if ((lang_dirent.d_type == DT_DIR || \
1068 (lang_dirent.d_type == DT_UNKNOWN && \
1069 is_directory(scripts_path, &lang_dirent))) && \
1070 (strcmp(lang_dirent.d_name, ".")) && \
1071 (strcmp(lang_dirent.d_name, "..")))
1072
1073 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
1074 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
1075 script_next) \
1076 if (script_dirent.d_type != DT_DIR && \
1077 (script_dirent.d_type != DT_UNKNOWN || \
1078 !is_directory(lang_path, &script_dirent)))
1079
1080
1081 #define RECORD_SUFFIX "-record"
1082 #define REPORT_SUFFIX "-report"
1083
1084 struct script_desc {
1085 struct list_head node;
1086 char *name;
1087 char *half_liner;
1088 char *args;
1089 };
1090
1091 static LIST_HEAD(script_descs);
1092
1093 static struct script_desc *script_desc__new(const char *name)
1094 {
1095 struct script_desc *s = zalloc(sizeof(*s));
1096
1097 if (s != NULL && name)
1098 s->name = strdup(name);
1099
1100 return s;
1101 }
1102
1103 static void script_desc__delete(struct script_desc *s)
1104 {
1105 zfree(&s->name);
1106 zfree(&s->half_liner);
1107 zfree(&s->args);
1108 free(s);
1109 }
1110
1111 static void script_desc__add(struct script_desc *s)
1112 {
1113 list_add_tail(&s->node, &script_descs);
1114 }
1115
1116 static 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
1126 static 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
1141 out_delete_desc:
1142 script_desc__delete(s);
1143
1144 return NULL;
1145 }
1146
1147 static const char *ends_with(const char *str, const char *suffix)
1148 {
1149 size_t suffix_len = strlen(suffix);
1150 const char *p = str;
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
1161 static 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
1202 static 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
1220 static int list_available_scripts(const struct option *opt __maybe_unused,
1221 const char *s __maybe_unused,
1222 int unset __maybe_unused)
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;
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
1239 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
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
1246 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1247 script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
1248 if (script_root) {
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);
1253 free(script_root);
1254 }
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
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 */
1278 static 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 evlist__for_each(session->evlist, pos) {
1313 if (!strcmp(perf_evsel__name(pos), evname)) {
1314 match = 1;
1315 break;
1316 }
1317 }
1318
1319 if (!match) {
1320 fclose(fp);
1321 return -1;
1322 }
1323 }
1324 }
1325
1326 fclose(fp);
1327 return 0;
1328 }
1329
1330 /*
1331 * Return -1 if none is found, otherwise the actual scripts number.
1332 *
1333 * Currently the only user of this function is the script browser, which
1334 * will list all statically runnable scripts, select one, execute it and
1335 * show the output in a perf browser.
1336 */
1337 int find_scripts(char **scripts_array, char **scripts_path_array)
1338 {
1339 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1340 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1341 DIR *scripts_dir, *lang_dir;
1342 struct perf_session *session;
1343 struct perf_data_file file = {
1344 .path = input_name,
1345 .mode = PERF_DATA_MODE_READ,
1346 };
1347 char *temp;
1348 int i = 0;
1349
1350 session = perf_session__new(&file, false, NULL);
1351 if (!session)
1352 return -1;
1353
1354 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1355
1356 scripts_dir = opendir(scripts_path);
1357 if (!scripts_dir) {
1358 perf_session__delete(session);
1359 return -1;
1360 }
1361
1362 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1363 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1364 lang_dirent.d_name);
1365 #ifdef NO_LIBPERL
1366 if (strstr(lang_path, "perl"))
1367 continue;
1368 #endif
1369 #ifdef NO_LIBPYTHON
1370 if (strstr(lang_path, "python"))
1371 continue;
1372 #endif
1373
1374 lang_dir = opendir(lang_path);
1375 if (!lang_dir)
1376 continue;
1377
1378 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1379 /* Skip those real time scripts: xxxtop.p[yl] */
1380 if (strstr(script_dirent.d_name, "top."))
1381 continue;
1382 sprintf(scripts_path_array[i], "%s/%s", lang_path,
1383 script_dirent.d_name);
1384 temp = strchr(script_dirent.d_name, '.');
1385 snprintf(scripts_array[i],
1386 (temp - script_dirent.d_name) + 1,
1387 "%s", script_dirent.d_name);
1388
1389 if (check_ev_match(lang_path,
1390 scripts_array[i], session))
1391 continue;
1392
1393 i++;
1394 }
1395 closedir(lang_dir);
1396 }
1397
1398 closedir(scripts_dir);
1399 perf_session__delete(session);
1400 return i;
1401 }
1402
1403 static char *get_script_path(const char *script_root, const char *suffix)
1404 {
1405 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1406 char scripts_path[MAXPATHLEN];
1407 char script_path[MAXPATHLEN];
1408 DIR *scripts_dir, *lang_dir;
1409 char lang_path[MAXPATHLEN];
1410 char *__script_root;
1411
1412 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1413
1414 scripts_dir = opendir(scripts_path);
1415 if (!scripts_dir)
1416 return NULL;
1417
1418 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1419 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1420 lang_dirent.d_name);
1421 lang_dir = opendir(lang_path);
1422 if (!lang_dir)
1423 continue;
1424
1425 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1426 __script_root = get_script_root(&script_dirent, suffix);
1427 if (__script_root && !strcmp(script_root, __script_root)) {
1428 free(__script_root);
1429 closedir(lang_dir);
1430 closedir(scripts_dir);
1431 snprintf(script_path, MAXPATHLEN, "%s/%s",
1432 lang_path, script_dirent.d_name);
1433 return strdup(script_path);
1434 }
1435 free(__script_root);
1436 }
1437 closedir(lang_dir);
1438 }
1439 closedir(scripts_dir);
1440
1441 return NULL;
1442 }
1443
1444 static bool is_top_script(const char *script_path)
1445 {
1446 return ends_with(script_path, "top") == NULL ? false : true;
1447 }
1448
1449 static int has_required_arg(char *script_path)
1450 {
1451 struct script_desc *desc;
1452 int n_args = 0;
1453 char *p;
1454
1455 desc = script_desc__new(NULL);
1456
1457 if (read_script_info(desc, script_path))
1458 goto out;
1459
1460 if (!desc->args)
1461 goto out;
1462
1463 for (p = desc->args; *p; p++)
1464 if (*p == '<')
1465 n_args++;
1466 out:
1467 script_desc__delete(desc);
1468
1469 return n_args;
1470 }
1471
1472 static int have_cmd(int argc, const char **argv)
1473 {
1474 char **__argv = malloc(sizeof(const char *) * argc);
1475
1476 if (!__argv) {
1477 pr_err("malloc failed\n");
1478 return -1;
1479 }
1480
1481 memcpy(__argv, argv, sizeof(const char *) * argc);
1482 argc = parse_options(argc, (const char **)__argv, record_options,
1483 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1484 free(__argv);
1485
1486 system_wide = (argc == 0);
1487
1488 return 0;
1489 }
1490
1491 int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
1492 {
1493 bool show_full_info = false;
1494 bool header = false;
1495 bool header_only = false;
1496 bool script_started = false;
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 = 0;
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,
1511 .attr = process_attr,
1512 .tracing_data = perf_event__process_tracing_data,
1513 .build_id = perf_event__process_build_id,
1514 .ordered_events = true,
1515 .ordering_requires_timestamps = true,
1516 },
1517 };
1518 struct perf_data_file file = {
1519 .mode = PERF_DATA_MODE_READ,
1520 };
1521 const struct option options[] = {
1522 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1523 "dump raw trace in ASCII"),
1524 OPT_INCR('v', "verbose", &verbose,
1525 "be more verbose (show symbol address, etc)"),
1526 OPT_BOOLEAN('L', "Latency", &latency_format,
1527 "show latency attributes (irqs/preemption disabled, etc)"),
1528 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1529 list_available_scripts),
1530 OPT_CALLBACK('s', "script", NULL, "name",
1531 "script file name (lang:script name, script name, or *)",
1532 parse_scriptname),
1533 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1534 "generate perf-script.xx script in specified language"),
1535 OPT_STRING('i', "input", &input_name, "file", "input file name"),
1536 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1537 "do various checks like samples ordering and lost events"),
1538 OPT_BOOLEAN(0, "header", &header, "Show data header."),
1539 OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
1540 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1541 "file", "vmlinux pathname"),
1542 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1543 "file", "kallsyms pathname"),
1544 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1545 "When printing symbols do not display call chain"),
1546 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1547 "Look for files with symbols relative to this directory"),
1548 OPT_CALLBACK('F', "fields", NULL, "str",
1549 "comma separated output fields prepend with 'type:'. "
1550 "Valid types: hw,sw,trace,raw. "
1551 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1552 "addr,symoff,period", parse_output_fields),
1553 OPT_BOOLEAN('a', "all-cpus", &system_wide,
1554 "system-wide collection from all CPUs"),
1555 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1556 "only consider these symbols"),
1557 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1558 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1559 "only display events for these comms"),
1560 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
1561 "only consider symbols in these pids"),
1562 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
1563 "only consider symbols in these tids"),
1564 OPT_BOOLEAN('I', "show-info", &show_full_info,
1565 "display extended information from perf.data file"),
1566 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
1567 "Show the path of [kernel.kallsyms]"),
1568 OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
1569 "Show the fork/comm/exit events"),
1570 OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
1571 "Show the mmap events"),
1572 OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
1573 OPT_END()
1574 };
1575 const char * const script_subcommands[] = { "record", "report", NULL };
1576 const char *script_usage[] = {
1577 "perf script [<options>]",
1578 "perf script [<options>] record <script> [<record-options>] <command>",
1579 "perf script [<options>] report <script> [script-args]",
1580 "perf script [<options>] <script> [<record-options>] <command>",
1581 "perf script [<options>] <top-script> [script-args]",
1582 NULL
1583 };
1584
1585 setup_scripting();
1586
1587 argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
1588 PARSE_OPT_STOP_AT_NON_OPTION);
1589
1590 file.path = input_name;
1591
1592 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1593 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1594 if (!rec_script_path)
1595 return cmd_record(argc, argv, NULL);
1596 }
1597
1598 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1599 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1600 if (!rep_script_path) {
1601 fprintf(stderr,
1602 "Please specify a valid report script"
1603 "(see 'perf script -l' for listing)\n");
1604 return -1;
1605 }
1606 }
1607
1608 /* make sure PERF_EXEC_PATH is set for scripts */
1609 perf_set_argv_exec_path(perf_exec_path());
1610
1611 if (argc && !script_name && !rec_script_path && !rep_script_path) {
1612 int live_pipe[2];
1613 int rep_args;
1614 pid_t pid;
1615
1616 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1617 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1618
1619 if (!rec_script_path && !rep_script_path) {
1620 fprintf(stderr, " Couldn't find script %s\n\n See perf"
1621 " script -l for available scripts.\n", argv[0]);
1622 usage_with_options(script_usage, options);
1623 }
1624
1625 if (is_top_script(argv[0])) {
1626 rep_args = argc - 1;
1627 } else {
1628 int rec_args;
1629
1630 rep_args = has_required_arg(rep_script_path);
1631 rec_args = (argc - 1) - rep_args;
1632 if (rec_args < 0) {
1633 fprintf(stderr, " %s script requires options."
1634 "\n\n See perf script -l for available "
1635 "scripts and options.\n", argv[0]);
1636 usage_with_options(script_usage, options);
1637 }
1638 }
1639
1640 if (pipe(live_pipe) < 0) {
1641 perror("failed to create pipe");
1642 return -1;
1643 }
1644
1645 pid = fork();
1646 if (pid < 0) {
1647 perror("failed to fork");
1648 return -1;
1649 }
1650
1651 if (!pid) {
1652 j = 0;
1653
1654 dup2(live_pipe[1], 1);
1655 close(live_pipe[0]);
1656
1657 if (is_top_script(argv[0])) {
1658 system_wide = true;
1659 } else if (!system_wide) {
1660 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
1661 err = -1;
1662 goto out;
1663 }
1664 }
1665
1666 __argv = malloc((argc + 6) * sizeof(const char *));
1667 if (!__argv) {
1668 pr_err("malloc failed\n");
1669 err = -ENOMEM;
1670 goto out;
1671 }
1672
1673 __argv[j++] = "/bin/sh";
1674 __argv[j++] = rec_script_path;
1675 if (system_wide)
1676 __argv[j++] = "-a";
1677 __argv[j++] = "-q";
1678 __argv[j++] = "-o";
1679 __argv[j++] = "-";
1680 for (i = rep_args + 1; i < argc; i++)
1681 __argv[j++] = argv[i];
1682 __argv[j++] = NULL;
1683
1684 execvp("/bin/sh", (char **)__argv);
1685 free(__argv);
1686 exit(-1);
1687 }
1688
1689 dup2(live_pipe[0], 0);
1690 close(live_pipe[1]);
1691
1692 __argv = malloc((argc + 4) * sizeof(const char *));
1693 if (!__argv) {
1694 pr_err("malloc failed\n");
1695 err = -ENOMEM;
1696 goto out;
1697 }
1698
1699 j = 0;
1700 __argv[j++] = "/bin/sh";
1701 __argv[j++] = rep_script_path;
1702 for (i = 1; i < rep_args + 1; i++)
1703 __argv[j++] = argv[i];
1704 __argv[j++] = "-i";
1705 __argv[j++] = "-";
1706 __argv[j++] = NULL;
1707
1708 execvp("/bin/sh", (char **)__argv);
1709 free(__argv);
1710 exit(-1);
1711 }
1712
1713 if (rec_script_path)
1714 script_path = rec_script_path;
1715 if (rep_script_path)
1716 script_path = rep_script_path;
1717
1718 if (script_path) {
1719 j = 0;
1720
1721 if (!rec_script_path)
1722 system_wide = false;
1723 else if (!system_wide) {
1724 if (have_cmd(argc - 1, &argv[1]) != 0) {
1725 err = -1;
1726 goto out;
1727 }
1728 }
1729
1730 __argv = malloc((argc + 2) * sizeof(const char *));
1731 if (!__argv) {
1732 pr_err("malloc failed\n");
1733 err = -ENOMEM;
1734 goto out;
1735 }
1736
1737 __argv[j++] = "/bin/sh";
1738 __argv[j++] = script_path;
1739 if (system_wide)
1740 __argv[j++] = "-a";
1741 for (i = 2; i < argc; i++)
1742 __argv[j++] = argv[i];
1743 __argv[j++] = NULL;
1744
1745 execvp("/bin/sh", (char **)__argv);
1746 free(__argv);
1747 exit(-1);
1748 }
1749
1750 if (!script_name)
1751 setup_pager();
1752
1753 session = perf_session__new(&file, false, &script.tool);
1754 if (session == NULL)
1755 return -1;
1756
1757 if (header || header_only) {
1758 perf_session__fprintf_info(session, stdout, show_full_info);
1759 if (header_only)
1760 goto out_delete;
1761 }
1762
1763 if (symbol__init(&session->header.env) < 0)
1764 goto out_delete;
1765
1766 script.session = session;
1767
1768 if (cpu_list) {
1769 err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
1770 if (err < 0)
1771 goto out_delete;
1772 }
1773
1774 if (!no_callchain)
1775 symbol_conf.use_callchain = true;
1776 else
1777 symbol_conf.use_callchain = false;
1778
1779 if (generate_script_lang) {
1780 struct stat perf_stat;
1781 int input;
1782
1783 if (output_set_by_user()) {
1784 fprintf(stderr,
1785 "custom fields not supported for generated scripts");
1786 err = -EINVAL;
1787 goto out_delete;
1788 }
1789
1790 input = open(file.path, O_RDONLY); /* input_name */
1791 if (input < 0) {
1792 err = -errno;
1793 perror("failed to open file");
1794 goto out_delete;
1795 }
1796
1797 err = fstat(input, &perf_stat);
1798 if (err < 0) {
1799 perror("failed to stat file");
1800 goto out_delete;
1801 }
1802
1803 if (!perf_stat.st_size) {
1804 fprintf(stderr, "zero-sized file, nothing to do!\n");
1805 goto out_delete;
1806 }
1807
1808 scripting_ops = script_spec__lookup(generate_script_lang);
1809 if (!scripting_ops) {
1810 fprintf(stderr, "invalid language specifier");
1811 err = -ENOENT;
1812 goto out_delete;
1813 }
1814
1815 err = scripting_ops->generate_script(session->tevent.pevent,
1816 "perf-script");
1817 goto out_delete;
1818 }
1819
1820 if (script_name) {
1821 err = scripting_ops->start_script(script_name, argc, argv);
1822 if (err)
1823 goto out_delete;
1824 pr_debug("perf script started with script %s\n\n", script_name);
1825 script_started = true;
1826 }
1827
1828
1829 err = perf_session__check_output_opt(session);
1830 if (err < 0)
1831 goto out_delete;
1832
1833 err = __cmd_script(&script);
1834
1835 flush_scripting();
1836
1837 out_delete:
1838 perf_session__delete(session);
1839
1840 if (script_started)
1841 cleanup_scripting();
1842 out:
1843 return err;
1844 }
Linux with added FPC-III support