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