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 <linux/bitmap.h>
19
20static char const *script_name;
21static char const *generate_script_lang;
22static bool debug_mode;
23static u64 last_timestamp;
24static u64 nr_unordered;
25extern const struct option record_options[];
26static bool no_callchain;
27static bool system_wide;
28static const char *cpu_list;
29static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
30
31enum perf_output_field {
32 PERF_OUTPUT_COMM = 1U << 0,
33 PERF_OUTPUT_TID = 1U << 1,
34 PERF_OUTPUT_PID = 1U << 2,
35 PERF_OUTPUT_TIME = 1U << 3,
36 PERF_OUTPUT_CPU = 1U << 4,
37 PERF_OUTPUT_EVNAME = 1U << 5,
38 PERF_OUTPUT_TRACE = 1U << 6,
39 PERF_OUTPUT_IP = 1U << 7,
40 PERF_OUTPUT_SYM = 1U << 8,
41 PERF_OUTPUT_DSO = 1U << 9,
42 PERF_OUTPUT_ADDR = 1U << 10,
43 PERF_OUTPUT_SYMOFFSET = 1U << 11,
44};
45
46struct output_option {
47 const char *str;
48 enum perf_output_field field;
49} all_output_options[] = {
50 {.str = "comm", .field = PERF_OUTPUT_COMM},
51 {.str = "tid", .field = PERF_OUTPUT_TID},
52 {.str = "pid", .field = PERF_OUTPUT_PID},
53 {.str = "time", .field = PERF_OUTPUT_TIME},
54 {.str = "cpu", .field = PERF_OUTPUT_CPU},
55 {.str = "event", .field = PERF_OUTPUT_EVNAME},
56 {.str = "trace", .field = PERF_OUTPUT_TRACE},
57 {.str = "ip", .field = PERF_OUTPUT_IP},
58 {.str = "sym", .field = PERF_OUTPUT_SYM},
59 {.str = "dso", .field = PERF_OUTPUT_DSO},
60 {.str = "addr", .field = PERF_OUTPUT_ADDR},
61 {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
62};
63
64
65static struct {
66 bool user_set;
67 bool wildcard_set;
68 u64 fields;
69 u64 invalid_fields;
70} output[PERF_TYPE_MAX] = {
71
72 [PERF_TYPE_HARDWARE] = {
73 .user_set = false,
74
75 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
76 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
77 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
78 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
79
80 .invalid_fields = PERF_OUTPUT_TRACE,
81 },
82
83 [PERF_TYPE_SOFTWARE] = {
84 .user_set = false,
85
86 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
87 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
88 PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
89 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
90
91 .invalid_fields = PERF_OUTPUT_TRACE,
92 },
93
94 [PERF_TYPE_TRACEPOINT] = {
95 .user_set = false,
96
97 .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
98 PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
99 PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
100 },
101
102 [PERF_TYPE_RAW] = {
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_IP |
108 PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
109
110 .invalid_fields = PERF_OUTPUT_TRACE,
111 },
112};
113
114static bool output_set_by_user(void)
115{
116 int j;
117 for (j = 0; j < PERF_TYPE_MAX; ++j) {
118 if (output[j].user_set)
119 return true;
120 }
121 return false;
122}
123
124static const char *output_field2str(enum perf_output_field field)
125{
126 int i, imax = ARRAY_SIZE(all_output_options);
127 const char *str = "";
128
129 for (i = 0; i < imax; ++i) {
130 if (all_output_options[i].field == field) {
131 str = all_output_options[i].str;
132 break;
133 }
134 }
135 return str;
136}
137
138#define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x)
139
140static int perf_evsel__check_stype(struct perf_evsel *evsel,
141 u64 sample_type, const char *sample_msg,
142 enum perf_output_field field)
143{
144 struct perf_event_attr *attr = &evsel->attr;
145 int type = attr->type;
146 const char *evname;
147
148 if (attr->sample_type & sample_type)
149 return 0;
150
151 if (output[type].user_set) {
152 evname = perf_evsel__name(evsel);
153 pr_err("Samples for '%s' event do not have %s attribute set. "
154 "Cannot print '%s' field.\n",
155 evname, sample_msg, output_field2str(field));
156 return -1;
157 }
158
159
160 output[type].fields &= ~field;
161 evname = perf_evsel__name(evsel);
162 pr_debug("Samples for '%s' event do not have %s attribute set. "
163 "Skipping '%s' field.\n",
164 evname, sample_msg, output_field2str(field));
165
166 return 0;
167}
168
169static int perf_evsel__check_attr(struct perf_evsel *evsel,
170 struct perf_session *session)
171{
172 struct perf_event_attr *attr = &evsel->attr;
173
174 if (PRINT_FIELD(TRACE) &&
175 !perf_session__has_traces(session, "record -R"))
176 return -EINVAL;
177
178 if (PRINT_FIELD(IP)) {
179 if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
180 PERF_OUTPUT_IP))
181 return -EINVAL;
182
183 if (!no_callchain &&
184 !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
185 symbol_conf.use_callchain = false;
186 }
187
188 if (PRINT_FIELD(ADDR) &&
189 perf_evsel__check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
190 PERF_OUTPUT_ADDR))
191 return -EINVAL;
192
193 if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
194 pr_err("Display of symbols requested but neither sample IP nor "
195 "sample address\nis selected. Hence, no addresses to convert "
196 "to symbols.\n");
197 return -EINVAL;
198 }
199 if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
200 pr_err("Display of offsets requested but symbol is not"
201 "selected.\n");
202 return -EINVAL;
203 }
204 if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
205 pr_err("Display of DSO requested but neither sample IP nor "
206 "sample address\nis selected. Hence, no addresses to convert "
207 "to DSO.\n");
208 return -EINVAL;
209 }
210
211 if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
212 perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
213 PERF_OUTPUT_TID|PERF_OUTPUT_PID))
214 return -EINVAL;
215
216 if (PRINT_FIELD(TIME) &&
217 perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
218 PERF_OUTPUT_TIME))
219 return -EINVAL;
220
221 if (PRINT_FIELD(CPU) &&
222 perf_evsel__check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
223 PERF_OUTPUT_CPU))
224 return -EINVAL;
225
226 return 0;
227}
228
229
230
231
232
233static int perf_session__check_output_opt(struct perf_session *session)
234{
235 int j;
236 struct perf_evsel *evsel;
237
238 for (j = 0; j < PERF_TYPE_MAX; ++j) {
239 evsel = perf_session__find_first_evtype(session, j);
240
241
242
243
244
245 if (!evsel && output[j].user_set && !output[j].wildcard_set) {
246 pr_err("%s events do not exist. "
247 "Remove corresponding -f option to proceed.\n",
248 event_type(j));
249 return -1;
250 }
251
252 if (evsel && output[j].fields &&
253 perf_evsel__check_attr(evsel, session))
254 return -1;
255 }
256
257 return 0;
258}
259
260static void print_sample_start(struct perf_sample *sample,
261 struct thread *thread,
262 struct perf_evsel *evsel)
263{
264 struct perf_event_attr *attr = &evsel->attr;
265 const char *evname = NULL;
266 unsigned long secs;
267 unsigned long usecs;
268 unsigned long long nsecs;
269
270 if (PRINT_FIELD(COMM)) {
271 if (latency_format)
272 printf("%8.8s ", thread->comm);
273 else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
274 printf("%s ", thread->comm);
275 else
276 printf("%16s ", thread->comm);
277 }
278
279 if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
280 printf("%5d/%-5d ", sample->pid, sample->tid);
281 else if (PRINT_FIELD(PID))
282 printf("%5d ", sample->pid);
283 else if (PRINT_FIELD(TID))
284 printf("%5d ", sample->tid);
285
286 if (PRINT_FIELD(CPU)) {
287 if (latency_format)
288 printf("%3d ", sample->cpu);
289 else
290 printf("[%03d] ", sample->cpu);
291 }
292
293 if (PRINT_FIELD(TIME)) {
294 nsecs = sample->time;
295 secs = nsecs / NSECS_PER_SEC;
296 nsecs -= secs * NSECS_PER_SEC;
297 usecs = nsecs / NSECS_PER_USEC;
298 printf("%5lu.%06lu: ", secs, usecs);
299 }
300
301 if (PRINT_FIELD(EVNAME)) {
302 evname = perf_evsel__name(evsel);
303 printf("%s: ", evname ? evname : "[unknown]");
304 }
305}
306
307static bool is_bts_event(struct perf_event_attr *attr)
308{
309 return ((attr->type == PERF_TYPE_HARDWARE) &&
310 (attr->config & PERF_COUNT_HW_BRANCH_INSTRUCTIONS) &&
311 (attr->sample_period == 1));
312}
313
314static bool sample_addr_correlates_sym(struct perf_event_attr *attr)
315{
316 if ((attr->type == PERF_TYPE_SOFTWARE) &&
317 ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) ||
318 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) ||
319 (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ)))
320 return true;
321
322 if (is_bts_event(attr))
323 return true;
324
325 return false;
326}
327
328static void print_sample_addr(union perf_event *event,
329 struct perf_sample *sample,
330 struct machine *machine,
331 struct thread *thread,
332 struct perf_event_attr *attr)
333{
334 struct addr_location al;
335 u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
336
337 printf("%16" PRIx64, sample->addr);
338
339 if (!sample_addr_correlates_sym(attr))
340 return;
341
342 thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
343 sample->addr, &al);
344 if (!al.map)
345 thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE,
346 sample->addr, &al);
347
348 al.cpu = sample->cpu;
349 al.sym = NULL;
350
351 if (al.map)
352 al.sym = map__find_symbol(al.map, al.addr, NULL);
353
354 if (PRINT_FIELD(SYM)) {
355 printf(" ");
356 if (PRINT_FIELD(SYMOFFSET))
357 symbol__fprintf_symname_offs(al.sym, &al, stdout);
358 else
359 symbol__fprintf_symname(al.sym, stdout);
360 }
361
362 if (PRINT_FIELD(DSO)) {
363 printf(" (");
364 map__fprintf_dsoname(al.map, stdout);
365 printf(")");
366 }
367}
368
369static void print_sample_bts(union perf_event *event,
370 struct perf_sample *sample,
371 struct perf_evsel *evsel,
372 struct machine *machine,
373 struct thread *thread)
374{
375 struct perf_event_attr *attr = &evsel->attr;
376
377
378 if (PRINT_FIELD(IP)) {
379 if (!symbol_conf.use_callchain)
380 printf(" ");
381 else
382 printf("\n");
383 perf_evsel__print_ip(evsel, event, sample, machine,
384 PRINT_FIELD(SYM), PRINT_FIELD(DSO),
385 PRINT_FIELD(SYMOFFSET));
386 }
387
388 printf(" => ");
389
390
391 if (PRINT_FIELD(ADDR))
392 print_sample_addr(event, sample, machine, thread, attr);
393
394 printf("\n");
395}
396
397static void process_event(union perf_event *event, struct perf_sample *sample,
398 struct perf_evsel *evsel, struct machine *machine,
399 struct addr_location *al)
400{
401 struct perf_event_attr *attr = &evsel->attr;
402 struct thread *thread = al->thread;
403
404 if (output[attr->type].fields == 0)
405 return;
406
407 print_sample_start(sample, thread, evsel);
408
409 if (is_bts_event(attr)) {
410 print_sample_bts(event, sample, evsel, machine, thread);
411 return;
412 }
413
414 if (PRINT_FIELD(TRACE))
415 event_format__print(evsel->tp_format, sample->cpu,
416 sample->raw_data, sample->raw_size);
417 if (PRINT_FIELD(ADDR))
418 print_sample_addr(event, sample, machine, thread, attr);
419
420 if (PRINT_FIELD(IP)) {
421 if (!symbol_conf.use_callchain)
422 printf(" ");
423 else
424 printf("\n");
425 perf_evsel__print_ip(evsel, event, sample, machine,
426 PRINT_FIELD(SYM), PRINT_FIELD(DSO),
427 PRINT_FIELD(SYMOFFSET));
428 }
429
430 printf("\n");
431}
432
433static int default_start_script(const char *script __maybe_unused,
434 int argc __maybe_unused,
435 const char **argv __maybe_unused)
436{
437 return 0;
438}
439
440static int default_stop_script(void)
441{
442 return 0;
443}
444
445static int default_generate_script(struct pevent *pevent __maybe_unused,
446 const char *outfile __maybe_unused)
447{
448 return 0;
449}
450
451static struct scripting_ops default_scripting_ops = {
452 .start_script = default_start_script,
453 .stop_script = default_stop_script,
454 .process_event = process_event,
455 .generate_script = default_generate_script,
456};
457
458static struct scripting_ops *scripting_ops;
459
460static void setup_scripting(void)
461{
462 setup_perl_scripting();
463 setup_python_scripting();
464
465 scripting_ops = &default_scripting_ops;
466}
467
468static int cleanup_scripting(void)
469{
470 pr_debug("\nperf script stopped\n");
471
472 return scripting_ops->stop_script();
473}
474
475static int process_sample_event(struct perf_tool *tool __maybe_unused,
476 union perf_event *event,
477 struct perf_sample *sample,
478 struct perf_evsel *evsel,
479 struct machine *machine)
480{
481 struct addr_location al;
482 struct thread *thread = machine__findnew_thread(machine, event->ip.tid);
483
484 if (thread == NULL) {
485 pr_debug("problem processing %d event, skipping it.\n",
486 event->header.type);
487 return -1;
488 }
489
490 if (debug_mode) {
491 if (sample->time < last_timestamp) {
492 pr_err("Samples misordered, previous: %" PRIu64
493 " this: %" PRIu64 "\n", last_timestamp,
494 sample->time);
495 nr_unordered++;
496 }
497 last_timestamp = sample->time;
498 return 0;
499 }
500
501 if (perf_event__preprocess_sample(event, machine, &al, sample, 0) < 0) {
502 pr_err("problem processing %d event, skipping it.\n",
503 event->header.type);
504 return -1;
505 }
506
507 if (al.filtered)
508 return 0;
509
510 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
511 return 0;
512
513 scripting_ops->process_event(event, sample, evsel, machine, &al);
514
515 evsel->hists.stats.total_period += sample->period;
516 return 0;
517}
518
519static struct perf_tool perf_script = {
520 .sample = process_sample_event,
521 .mmap = perf_event__process_mmap,
522 .comm = perf_event__process_comm,
523 .exit = perf_event__process_exit,
524 .fork = perf_event__process_fork,
525 .attr = perf_event__process_attr,
526 .event_type = perf_event__process_event_type,
527 .tracing_data = perf_event__process_tracing_data,
528 .build_id = perf_event__process_build_id,
529 .ordered_samples = true,
530 .ordering_requires_timestamps = true,
531};
532
533extern volatile int session_done;
534
535static void sig_handler(int sig __maybe_unused)
536{
537 session_done = 1;
538}
539
540static int __cmd_script(struct perf_session *session)
541{
542 int ret;
543
544 signal(SIGINT, sig_handler);
545
546 ret = perf_session__process_events(session, &perf_script);
547
548 if (debug_mode)
549 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
550
551 return ret;
552}
553
554struct script_spec {
555 struct list_head node;
556 struct scripting_ops *ops;
557 char spec[0];
558};
559
560static LIST_HEAD(script_specs);
561
562static struct script_spec *script_spec__new(const char *spec,
563 struct scripting_ops *ops)
564{
565 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
566
567 if (s != NULL) {
568 strcpy(s->spec, spec);
569 s->ops = ops;
570 }
571
572 return s;
573}
574
575static void script_spec__add(struct script_spec *s)
576{
577 list_add_tail(&s->node, &script_specs);
578}
579
580static struct script_spec *script_spec__find(const char *spec)
581{
582 struct script_spec *s;
583
584 list_for_each_entry(s, &script_specs, node)
585 if (strcasecmp(s->spec, spec) == 0)
586 return s;
587 return NULL;
588}
589
590static struct script_spec *script_spec__findnew(const char *spec,
591 struct scripting_ops *ops)
592{
593 struct script_spec *s = script_spec__find(spec);
594
595 if (s)
596 return s;
597
598 s = script_spec__new(spec, ops);
599 if (!s)
600 return NULL;
601
602 script_spec__add(s);
603
604 return s;
605}
606
607int script_spec_register(const char *spec, struct scripting_ops *ops)
608{
609 struct script_spec *s;
610
611 s = script_spec__find(spec);
612 if (s)
613 return -1;
614
615 s = script_spec__findnew(spec, ops);
616 if (!s)
617 return -1;
618
619 return 0;
620}
621
622static struct scripting_ops *script_spec__lookup(const char *spec)
623{
624 struct script_spec *s = script_spec__find(spec);
625 if (!s)
626 return NULL;
627
628 return s->ops;
629}
630
631static void list_available_languages(void)
632{
633 struct script_spec *s;
634
635 fprintf(stderr, "\n");
636 fprintf(stderr, "Scripting language extensions (used in "
637 "perf script -s [spec:]script.[spec]):\n\n");
638
639 list_for_each_entry(s, &script_specs, node)
640 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
641
642 fprintf(stderr, "\n");
643}
644
645static int parse_scriptname(const struct option *opt __maybe_unused,
646 const char *str, int unset __maybe_unused)
647{
648 char spec[PATH_MAX];
649 const char *script, *ext;
650 int len;
651
652 if (strcmp(str, "lang") == 0) {
653 list_available_languages();
654 exit(0);
655 }
656
657 script = strchr(str, ':');
658 if (script) {
659 len = script - str;
660 if (len >= PATH_MAX) {
661 fprintf(stderr, "invalid language specifier");
662 return -1;
663 }
664 strncpy(spec, str, len);
665 spec[len] = '\0';
666 scripting_ops = script_spec__lookup(spec);
667 if (!scripting_ops) {
668 fprintf(stderr, "invalid language specifier");
669 return -1;
670 }
671 script++;
672 } else {
673 script = str;
674 ext = strrchr(script, '.');
675 if (!ext) {
676 fprintf(stderr, "invalid script extension");
677 return -1;
678 }
679 scripting_ops = script_spec__lookup(++ext);
680 if (!scripting_ops) {
681 fprintf(stderr, "invalid script extension");
682 return -1;
683 }
684 }
685
686 script_name = strdup(script);
687
688 return 0;
689}
690
691static int parse_output_fields(const struct option *opt __maybe_unused,
692 const char *arg, int unset __maybe_unused)
693{
694 char *tok;
695 int i, imax = sizeof(all_output_options) / sizeof(struct output_option);
696 int j;
697 int rc = 0;
698 char *str = strdup(arg);
699 int type = -1;
700
701 if (!str)
702 return -ENOMEM;
703
704
705
706
707
708 tok = strchr(str, ':');
709 if (tok) {
710 *tok = '\0';
711 tok++;
712 if (!strcmp(str, "hw"))
713 type = PERF_TYPE_HARDWARE;
714 else if (!strcmp(str, "sw"))
715 type = PERF_TYPE_SOFTWARE;
716 else if (!strcmp(str, "trace"))
717 type = PERF_TYPE_TRACEPOINT;
718 else if (!strcmp(str, "raw"))
719 type = PERF_TYPE_RAW;
720 else {
721 fprintf(stderr, "Invalid event type in field string.\n");
722 rc = -EINVAL;
723 goto out;
724 }
725
726 if (output[type].user_set)
727 pr_warning("Overriding previous field request for %s events.\n",
728 event_type(type));
729
730 output[type].fields = 0;
731 output[type].user_set = true;
732 output[type].wildcard_set = false;
733
734 } else {
735 tok = str;
736 if (strlen(str) == 0) {
737 fprintf(stderr,
738 "Cannot set fields to 'none' for all event types.\n");
739 rc = -EINVAL;
740 goto out;
741 }
742
743 if (output_set_by_user())
744 pr_warning("Overriding previous field request for all events.\n");
745
746 for (j = 0; j < PERF_TYPE_MAX; ++j) {
747 output[j].fields = 0;
748 output[j].user_set = true;
749 output[j].wildcard_set = true;
750 }
751 }
752
753 tok = strtok(tok, ",");
754 while (tok) {
755 for (i = 0; i < imax; ++i) {
756 if (strcmp(tok, all_output_options[i].str) == 0)
757 break;
758 }
759 if (i == imax) {
760 fprintf(stderr, "Invalid field requested.\n");
761 rc = -EINVAL;
762 goto out;
763 }
764
765 if (type == -1) {
766
767
768
769 for (j = 0; j < PERF_TYPE_MAX; ++j) {
770 if (output[j].invalid_fields & all_output_options[i].field) {
771 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
772 all_output_options[i].str, event_type(j));
773 } else
774 output[j].fields |= all_output_options[i].field;
775 }
776 } else {
777 if (output[type].invalid_fields & all_output_options[i].field) {
778 fprintf(stderr, "\'%s\' not valid for %s events.\n",
779 all_output_options[i].str, event_type(type));
780
781 rc = -EINVAL;
782 goto out;
783 }
784 output[type].fields |= all_output_options[i].field;
785 }
786
787 tok = strtok(NULL, ",");
788 }
789
790 if (type >= 0) {
791 if (output[type].fields == 0) {
792 pr_debug("No fields requested for %s type. "
793 "Events will not be displayed.\n", event_type(type));
794 }
795 }
796
797out:
798 free(str);
799 return rc;
800}
801
802
803static int is_directory(const char *base_path, const struct dirent *dent)
804{
805 char path[PATH_MAX];
806 struct stat st;
807
808 sprintf(path, "%s/%s", base_path, dent->d_name);
809 if (stat(path, &st))
810 return 0;
811
812 return S_ISDIR(st.st_mode);
813}
814
815#define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
816 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
817 lang_next) \
818 if ((lang_dirent.d_type == DT_DIR || \
819 (lang_dirent.d_type == DT_UNKNOWN && \
820 is_directory(scripts_path, &lang_dirent))) && \
821 (strcmp(lang_dirent.d_name, ".")) && \
822 (strcmp(lang_dirent.d_name, "..")))
823
824#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
825 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
826 script_next) \
827 if (script_dirent.d_type != DT_DIR && \
828 (script_dirent.d_type != DT_UNKNOWN || \
829 !is_directory(lang_path, &script_dirent)))
830
831
832#define RECORD_SUFFIX "-record"
833#define REPORT_SUFFIX "-report"
834
835struct script_desc {
836 struct list_head node;
837 char *name;
838 char *half_liner;
839 char *args;
840};
841
842static LIST_HEAD(script_descs);
843
844static struct script_desc *script_desc__new(const char *name)
845{
846 struct script_desc *s = zalloc(sizeof(*s));
847
848 if (s != NULL && name)
849 s->name = strdup(name);
850
851 return s;
852}
853
854static void script_desc__delete(struct script_desc *s)
855{
856 free(s->name);
857 free(s->half_liner);
858 free(s->args);
859 free(s);
860}
861
862static void script_desc__add(struct script_desc *s)
863{
864 list_add_tail(&s->node, &script_descs);
865}
866
867static struct script_desc *script_desc__find(const char *name)
868{
869 struct script_desc *s;
870
871 list_for_each_entry(s, &script_descs, node)
872 if (strcasecmp(s->name, name) == 0)
873 return s;
874 return NULL;
875}
876
877static struct script_desc *script_desc__findnew(const char *name)
878{
879 struct script_desc *s = script_desc__find(name);
880
881 if (s)
882 return s;
883
884 s = script_desc__new(name);
885 if (!s)
886 goto out_delete_desc;
887
888 script_desc__add(s);
889
890 return s;
891
892out_delete_desc:
893 script_desc__delete(s);
894
895 return NULL;
896}
897
898static const char *ends_with(const char *str, const char *suffix)
899{
900 size_t suffix_len = strlen(suffix);
901 const char *p = str;
902
903 if (strlen(str) > suffix_len) {
904 p = str + strlen(str) - suffix_len;
905 if (!strncmp(p, suffix, suffix_len))
906 return p;
907 }
908
909 return NULL;
910}
911
912static char *ltrim(char *str)
913{
914 int len = strlen(str);
915
916 while (len && isspace(*str)) {
917 len--;
918 str++;
919 }
920
921 return str;
922}
923
924static int read_script_info(struct script_desc *desc, const char *filename)
925{
926 char line[BUFSIZ], *p;
927 FILE *fp;
928
929 fp = fopen(filename, "r");
930 if (!fp)
931 return -1;
932
933 while (fgets(line, sizeof(line), fp)) {
934 p = ltrim(line);
935 if (strlen(p) == 0)
936 continue;
937 if (*p != '#')
938 continue;
939 p++;
940 if (strlen(p) && *p == '!')
941 continue;
942
943 p = ltrim(p);
944 if (strlen(p) && p[strlen(p) - 1] == '\n')
945 p[strlen(p) - 1] = '\0';
946
947 if (!strncmp(p, "description:", strlen("description:"))) {
948 p += strlen("description:");
949 desc->half_liner = strdup(ltrim(p));
950 continue;
951 }
952
953 if (!strncmp(p, "args:", strlen("args:"))) {
954 p += strlen("args:");
955 desc->args = strdup(ltrim(p));
956 continue;
957 }
958 }
959
960 fclose(fp);
961
962 return 0;
963}
964
965static char *get_script_root(struct dirent *script_dirent, const char *suffix)
966{
967 char *script_root, *str;
968
969 script_root = strdup(script_dirent->d_name);
970 if (!script_root)
971 return NULL;
972
973 str = (char *)ends_with(script_root, suffix);
974 if (!str) {
975 free(script_root);
976 return NULL;
977 }
978
979 *str = '\0';
980 return script_root;
981}
982
983static int list_available_scripts(const struct option *opt __maybe_unused,
984 const char *s __maybe_unused,
985 int unset __maybe_unused)
986{
987 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
988 char scripts_path[MAXPATHLEN];
989 DIR *scripts_dir, *lang_dir;
990 char script_path[MAXPATHLEN];
991 char lang_path[MAXPATHLEN];
992 struct script_desc *desc;
993 char first_half[BUFSIZ];
994 char *script_root;
995
996 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
997
998 scripts_dir = opendir(scripts_path);
999 if (!scripts_dir)
1000 return -1;
1001
1002 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1003 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1004 lang_dirent.d_name);
1005 lang_dir = opendir(lang_path);
1006 if (!lang_dir)
1007 continue;
1008
1009 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1010 script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
1011 if (script_root) {
1012 desc = script_desc__findnew(script_root);
1013 snprintf(script_path, MAXPATHLEN, "%s/%s",
1014 lang_path, script_dirent.d_name);
1015 read_script_info(desc, script_path);
1016 free(script_root);
1017 }
1018 }
1019 }
1020
1021 fprintf(stdout, "List of available trace scripts:\n");
1022 list_for_each_entry(desc, &script_descs, node) {
1023 sprintf(first_half, "%s %s", desc->name,
1024 desc->args ? desc->args : "");
1025 fprintf(stdout, " %-36s %s\n", first_half,
1026 desc->half_liner ? desc->half_liner : "");
1027 }
1028
1029 exit(0);
1030}
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041static int check_ev_match(char *dir_name, char *scriptname,
1042 struct perf_session *session)
1043{
1044 char filename[MAXPATHLEN], evname[128];
1045 char line[BUFSIZ], *p;
1046 struct perf_evsel *pos;
1047 int match, len;
1048 FILE *fp;
1049
1050 sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1051
1052 fp = fopen(filename, "r");
1053 if (!fp)
1054 return -1;
1055
1056 while (fgets(line, sizeof(line), fp)) {
1057 p = ltrim(line);
1058 if (*p == '#')
1059 continue;
1060
1061 while (strlen(p)) {
1062 p = strstr(p, "-e");
1063 if (!p)
1064 break;
1065
1066 p += 2;
1067 p = ltrim(p);
1068 len = strcspn(p, " \t");
1069 if (!len)
1070 break;
1071
1072 snprintf(evname, len + 1, "%s", p);
1073
1074 match = 0;
1075 list_for_each_entry(pos,
1076 &session->evlist->entries, node) {
1077 if (!strcmp(perf_evsel__name(pos), evname)) {
1078 match = 1;
1079 break;
1080 }
1081 }
1082
1083 if (!match) {
1084 fclose(fp);
1085 return -1;
1086 }
1087 }
1088 }
1089
1090 fclose(fp);
1091 return 0;
1092}
1093
1094
1095
1096
1097
1098
1099
1100
1101int find_scripts(char **scripts_array, char **scripts_path_array)
1102{
1103 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1104 char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1105 DIR *scripts_dir, *lang_dir;
1106 struct perf_session *session;
1107 char *temp;
1108 int i = 0;
1109
1110 session = perf_session__new(input_name, O_RDONLY, 0, false, NULL);
1111 if (!session)
1112 return -1;
1113
1114 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1115
1116 scripts_dir = opendir(scripts_path);
1117 if (!scripts_dir) {
1118 perf_session__delete(session);
1119 return -1;
1120 }
1121
1122 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1123 snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1124 lang_dirent.d_name);
1125#ifdef NO_LIBPERL
1126 if (strstr(lang_path, "perl"))
1127 continue;
1128#endif
1129#ifdef NO_LIBPYTHON
1130 if (strstr(lang_path, "python"))
1131 continue;
1132#endif
1133
1134 lang_dir = opendir(lang_path);
1135 if (!lang_dir)
1136 continue;
1137
1138 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1139
1140 if (strstr(script_dirent.d_name, "top."))
1141 continue;
1142 sprintf(scripts_path_array[i], "%s/%s", lang_path,
1143 script_dirent.d_name);
1144 temp = strchr(script_dirent.d_name, '.');
1145 snprintf(scripts_array[i],
1146 (temp - script_dirent.d_name) + 1,
1147 "%s", script_dirent.d_name);
1148
1149 if (check_ev_match(lang_path,
1150 scripts_array[i], session))
1151 continue;
1152
1153 i++;
1154 }
1155 closedir(lang_dir);
1156 }
1157
1158 closedir(scripts_dir);
1159 perf_session__delete(session);
1160 return i;
1161}
1162
1163static char *get_script_path(const char *script_root, const char *suffix)
1164{
1165 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1166 char scripts_path[MAXPATHLEN];
1167 char script_path[MAXPATHLEN];
1168 DIR *scripts_dir, *lang_dir;
1169 char lang_path[MAXPATHLEN];
1170 char *__script_root;
1171
1172 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1173
1174 scripts_dir = opendir(scripts_path);
1175 if (!scripts_dir)
1176 return NULL;
1177
1178 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1179 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1180 lang_dirent.d_name);
1181 lang_dir = opendir(lang_path);
1182 if (!lang_dir)
1183 continue;
1184
1185 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1186 __script_root = get_script_root(&script_dirent, suffix);
1187 if (__script_root && !strcmp(script_root, __script_root)) {
1188 free(__script_root);
1189 closedir(lang_dir);
1190 closedir(scripts_dir);
1191 snprintf(script_path, MAXPATHLEN, "%s/%s",
1192 lang_path, script_dirent.d_name);
1193 return strdup(script_path);
1194 }
1195 free(__script_root);
1196 }
1197 closedir(lang_dir);
1198 }
1199 closedir(scripts_dir);
1200
1201 return NULL;
1202}
1203
1204static bool is_top_script(const char *script_path)
1205{
1206 return ends_with(script_path, "top") == NULL ? false : true;
1207}
1208
1209static int has_required_arg(char *script_path)
1210{
1211 struct script_desc *desc;
1212 int n_args = 0;
1213 char *p;
1214
1215 desc = script_desc__new(NULL);
1216
1217 if (read_script_info(desc, script_path))
1218 goto out;
1219
1220 if (!desc->args)
1221 goto out;
1222
1223 for (p = desc->args; *p; p++)
1224 if (*p == '<')
1225 n_args++;
1226out:
1227 script_desc__delete(desc);
1228
1229 return n_args;
1230}
1231
1232static int have_cmd(int argc, const char **argv)
1233{
1234 char **__argv = malloc(sizeof(const char *) * argc);
1235
1236 if (!__argv) {
1237 pr_err("malloc failed\n");
1238 return -1;
1239 }
1240
1241 memcpy(__argv, argv, sizeof(const char *) * argc);
1242 argc = parse_options(argc, (const char **)__argv, record_options,
1243 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1244 free(__argv);
1245
1246 system_wide = (argc == 0);
1247
1248 return 0;
1249}
1250
1251int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
1252{
1253 bool show_full_info = false;
1254 char *rec_script_path = NULL;
1255 char *rep_script_path = NULL;
1256 struct perf_session *session;
1257 char *script_path = NULL;
1258 const char **__argv;
1259 int i, j, err;
1260 const struct option options[] = {
1261 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1262 "dump raw trace in ASCII"),
1263 OPT_INCR('v', "verbose", &verbose,
1264 "be more verbose (show symbol address, etc)"),
1265 OPT_BOOLEAN('L', "Latency", &latency_format,
1266 "show latency attributes (irqs/preemption disabled, etc)"),
1267 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1268 list_available_scripts),
1269 OPT_CALLBACK('s', "script", NULL, "name",
1270 "script file name (lang:script name, script name, or *)",
1271 parse_scriptname),
1272 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1273 "generate perf-script.xx script in specified language"),
1274 OPT_STRING('i', "input", &input_name, "file", "input file name"),
1275 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1276 "do various checks like samples ordering and lost events"),
1277 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1278 "file", "vmlinux pathname"),
1279 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1280 "file", "kallsyms pathname"),
1281 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1282 "When printing symbols do not display call chain"),
1283 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1284 "Look for files with symbols relative to this directory"),
1285 OPT_CALLBACK('f', "fields", NULL, "str",
1286 "comma separated output fields prepend with 'type:'. "
1287 "Valid types: hw,sw,trace,raw. "
1288 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1289 "addr,symoff", parse_output_fields),
1290 OPT_BOOLEAN('a', "all-cpus", &system_wide,
1291 "system-wide collection from all CPUs"),
1292 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1293 "only consider these symbols"),
1294 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1295 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1296 "only display events for these comms"),
1297 OPT_BOOLEAN('I', "show-info", &show_full_info,
1298 "display extended information from perf.data file"),
1299 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
1300 "Show the path of [kernel.kallsyms]"),
1301 OPT_END()
1302 };
1303 const char * const script_usage[] = {
1304 "perf script [<options>]",
1305 "perf script [<options>] record <script> [<record-options>] <command>",
1306 "perf script [<options>] report <script> [script-args]",
1307 "perf script [<options>] <script> [<record-options>] <command>",
1308 "perf script [<options>] <top-script> [script-args]",
1309 NULL
1310 };
1311
1312 setup_scripting();
1313
1314 argc = parse_options(argc, argv, options, script_usage,
1315 PARSE_OPT_STOP_AT_NON_OPTION);
1316
1317 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1318 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1319 if (!rec_script_path)
1320 return cmd_record(argc, argv, NULL);
1321 }
1322
1323 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1324 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1325 if (!rep_script_path) {
1326 fprintf(stderr,
1327 "Please specify a valid report script"
1328 "(see 'perf script -l' for listing)\n");
1329 return -1;
1330 }
1331 }
1332
1333
1334 perf_set_argv_exec_path(perf_exec_path());
1335
1336 if (argc && !script_name && !rec_script_path && !rep_script_path) {
1337 int live_pipe[2];
1338 int rep_args;
1339 pid_t pid;
1340
1341 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1342 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1343
1344 if (!rec_script_path && !rep_script_path) {
1345 fprintf(stderr, " Couldn't find script %s\n\n See perf"
1346 " script -l for available scripts.\n", argv[0]);
1347 usage_with_options(script_usage, options);
1348 }
1349
1350 if (is_top_script(argv[0])) {
1351 rep_args = argc - 1;
1352 } else {
1353 int rec_args;
1354
1355 rep_args = has_required_arg(rep_script_path);
1356 rec_args = (argc - 1) - rep_args;
1357 if (rec_args < 0) {
1358 fprintf(stderr, " %s script requires options."
1359 "\n\n See perf script -l for available "
1360 "scripts and options.\n", argv[0]);
1361 usage_with_options(script_usage, options);
1362 }
1363 }
1364
1365 if (pipe(live_pipe) < 0) {
1366 perror("failed to create pipe");
1367 return -1;
1368 }
1369
1370 pid = fork();
1371 if (pid < 0) {
1372 perror("failed to fork");
1373 return -1;
1374 }
1375
1376 if (!pid) {
1377 j = 0;
1378
1379 dup2(live_pipe[1], 1);
1380 close(live_pipe[0]);
1381
1382 if (is_top_script(argv[0])) {
1383 system_wide = true;
1384 } else if (!system_wide) {
1385 if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
1386 err = -1;
1387 goto out;
1388 }
1389 }
1390
1391 __argv = malloc((argc + 6) * sizeof(const char *));
1392 if (!__argv) {
1393 pr_err("malloc failed\n");
1394 err = -ENOMEM;
1395 goto out;
1396 }
1397
1398 __argv[j++] = "/bin/sh";
1399 __argv[j++] = rec_script_path;
1400 if (system_wide)
1401 __argv[j++] = "-a";
1402 __argv[j++] = "-q";
1403 __argv[j++] = "-o";
1404 __argv[j++] = "-";
1405 for (i = rep_args + 1; i < argc; i++)
1406 __argv[j++] = argv[i];
1407 __argv[j++] = NULL;
1408
1409 execvp("/bin/sh", (char **)__argv);
1410 free(__argv);
1411 exit(-1);
1412 }
1413
1414 dup2(live_pipe[0], 0);
1415 close(live_pipe[1]);
1416
1417 __argv = malloc((argc + 4) * sizeof(const char *));
1418 if (!__argv) {
1419 pr_err("malloc failed\n");
1420 err = -ENOMEM;
1421 goto out;
1422 }
1423
1424 j = 0;
1425 __argv[j++] = "/bin/sh";
1426 __argv[j++] = rep_script_path;
1427 for (i = 1; i < rep_args + 1; i++)
1428 __argv[j++] = argv[i];
1429 __argv[j++] = "-i";
1430 __argv[j++] = "-";
1431 __argv[j++] = NULL;
1432
1433 execvp("/bin/sh", (char **)__argv);
1434 free(__argv);
1435 exit(-1);
1436 }
1437
1438 if (rec_script_path)
1439 script_path = rec_script_path;
1440 if (rep_script_path)
1441 script_path = rep_script_path;
1442
1443 if (script_path) {
1444 j = 0;
1445
1446 if (!rec_script_path)
1447 system_wide = false;
1448 else if (!system_wide) {
1449 if (have_cmd(argc - 1, &argv[1]) != 0) {
1450 err = -1;
1451 goto out;
1452 }
1453 }
1454
1455 __argv = malloc((argc + 2) * sizeof(const char *));
1456 if (!__argv) {
1457 pr_err("malloc failed\n");
1458 err = -ENOMEM;
1459 goto out;
1460 }
1461
1462 __argv[j++] = "/bin/sh";
1463 __argv[j++] = script_path;
1464 if (system_wide)
1465 __argv[j++] = "-a";
1466 for (i = 2; i < argc; i++)
1467 __argv[j++] = argv[i];
1468 __argv[j++] = NULL;
1469
1470 execvp("/bin/sh", (char **)__argv);
1471 free(__argv);
1472 exit(-1);
1473 }
1474
1475 if (symbol__init() < 0)
1476 return -1;
1477 if (!script_name)
1478 setup_pager();
1479
1480 session = perf_session__new(input_name, O_RDONLY, 0, false,
1481 &perf_script);
1482 if (session == NULL)
1483 return -ENOMEM;
1484
1485 if (cpu_list) {
1486 if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
1487 return -1;
1488 }
1489
1490 perf_session__fprintf_info(session, stdout, show_full_info);
1491
1492 if (!no_callchain)
1493 symbol_conf.use_callchain = true;
1494 else
1495 symbol_conf.use_callchain = false;
1496
1497 if (generate_script_lang) {
1498 struct stat perf_stat;
1499 int input;
1500
1501 if (output_set_by_user()) {
1502 fprintf(stderr,
1503 "custom fields not supported for generated scripts");
1504 return -1;
1505 }
1506
1507 input = open(session->filename, O_RDONLY);
1508 if (input < 0) {
1509 perror("failed to open file");
1510 return -1;
1511 }
1512
1513 err = fstat(input, &perf_stat);
1514 if (err < 0) {
1515 perror("failed to stat file");
1516 return -1;
1517 }
1518
1519 if (!perf_stat.st_size) {
1520 fprintf(stderr, "zero-sized file, nothing to do!\n");
1521 return 0;
1522 }
1523
1524 scripting_ops = script_spec__lookup(generate_script_lang);
1525 if (!scripting_ops) {
1526 fprintf(stderr, "invalid language specifier");
1527 return -1;
1528 }
1529
1530 err = scripting_ops->generate_script(session->pevent,
1531 "perf-script");
1532 goto out;
1533 }
1534
1535 if (script_name) {
1536 err = scripting_ops->start_script(script_name, argc, argv);
1537 if (err)
1538 goto out;
1539 pr_debug("perf script started with script %s\n\n", script_name);
1540 }
1541
1542
1543 err = perf_session__check_output_opt(session);
1544 if (err < 0)
1545 goto out;
1546
1547 err = __cmd_script(session);
1548
1549 perf_session__delete(session);
1550 cleanup_scripting();
1551out:
1552 return err;
1553}
1554
