projects / deliverable / linux.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
perf script: Stop using pevent directly
[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 <linux/bitmap.h>
18
19 static char const *script_name;
20 static char const *generate_script_lang;
21 static bool debug_mode;
22 static u64 last_timestamp;
23 static u64 nr_unordered;
24 extern const struct option record_options[];
25 static bool no_callchain;
26 static bool show_full_info;
27 static bool system_wide;
28 static const char *cpu_list;
29 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
30
31 enum 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
46 struct 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 /* default set to maintain compatibility with current format */
65 static 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
114 static 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
124 static 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
140 static 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 /* user did not ask for it explicitly so remove from the default list */
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
169 static 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 * verify all user requested events exist and the samples
231 * have the expected data
232 */
233 static 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 * even if fields is set to 0 (ie., show nothing) event must
243 * exist if user explicitly includes it on the command line
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
260 static 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
307 static 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
314 static 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
328 static 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
369 static 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 /* print branch_from information */
378 if (PRINT_FIELD(IP)) {
379 if (!symbol_conf.use_callchain)
380 printf(" ");
381 else
382 printf("\n");
383 perf_event__print_ip(event, sample, machine,
384 PRINT_FIELD(SYM), PRINT_FIELD(DSO),
385 PRINT_FIELD(SYMOFFSET));
386 }
387
388 printf(" => ");
389
390 /* print branch_to information */
391 if (PRINT_FIELD(ADDR))
392 print_sample_addr(event, sample, machine, thread, attr);
393
394 printf("\n");
395 }
396
397 static void process_event(union perf_event *event, struct perf_sample *sample,
398 struct perf_evsel *evsel, struct machine *machine,
399 struct thread *thread)
400 {
401 struct perf_event_attr *attr = &evsel->attr;
402
403 if (output[attr->type].fields == 0)
404 return;
405
406 print_sample_start(sample, thread, evsel);
407
408 if (is_bts_event(attr)) {
409 print_sample_bts(event, sample, evsel, machine, thread);
410 return;
411 }
412
413 if (PRINT_FIELD(TRACE))
414 event_format__print(evsel->tp_format, sample->cpu,
415 sample->raw_data, sample->raw_size);
416 if (PRINT_FIELD(ADDR))
417 print_sample_addr(event, sample, machine, thread, attr);
418
419 if (PRINT_FIELD(IP)) {
420 if (!symbol_conf.use_callchain)
421 printf(" ");
422 else
423 printf("\n");
424 perf_event__print_ip(event, sample, machine,
425 PRINT_FIELD(SYM), PRINT_FIELD(DSO),
426 PRINT_FIELD(SYMOFFSET));
427 }
428
429 printf("\n");
430 }
431
432 static int default_start_script(const char *script __unused,
433 int argc __unused,
434 const char **argv __unused)
435 {
436 return 0;
437 }
438
439 static int default_stop_script(void)
440 {
441 return 0;
442 }
443
444 static int default_generate_script(struct pevent *pevent __unused,
445 const char *outfile __unused)
446 {
447 return 0;
448 }
449
450 static struct scripting_ops default_scripting_ops = {
451 .start_script = default_start_script,
452 .stop_script = default_stop_script,
453 .process_event = process_event,
454 .generate_script = default_generate_script,
455 };
456
457 static struct scripting_ops *scripting_ops;
458
459 static void setup_scripting(void)
460 {
461 setup_perl_scripting();
462 setup_python_scripting();
463
464 scripting_ops = &default_scripting_ops;
465 }
466
467 static int cleanup_scripting(void)
468 {
469 pr_debug("\nperf script stopped\n");
470
471 return scripting_ops->stop_script();
472 }
473
474 static const char *input_name;
475
476 static int process_sample_event(struct perf_tool *tool __used,
477 union perf_event *event,
478 struct perf_sample *sample,
479 struct perf_evsel *evsel,
480 struct machine *machine)
481 {
482 struct addr_location al;
483 struct thread *thread = machine__findnew_thread(machine, event->ip.tid);
484
485 if (thread == NULL) {
486 pr_debug("problem processing %d event, skipping it.\n",
487 event->header.type);
488 return -1;
489 }
490
491 if (debug_mode) {
492 if (sample->time < last_timestamp) {
493 pr_err("Samples misordered, previous: %" PRIu64
494 " this: %" PRIu64 "\n", last_timestamp,
495 sample->time);
496 nr_unordered++;
497 }
498 last_timestamp = sample->time;
499 return 0;
500 }
501
502 if (perf_event__preprocess_sample(event, machine, &al, sample, 0) < 0) {
503 pr_err("problem processing %d event, skipping it.\n",
504 event->header.type);
505 return -1;
506 }
507
508 if (al.filtered)
509 return 0;
510
511 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
512 return 0;
513
514 scripting_ops->process_event(event, sample, evsel, machine, thread);
515
516 evsel->hists.stats.total_period += sample->period;
517 return 0;
518 }
519
520 static struct perf_tool perf_script = {
521 .sample = process_sample_event,
522 .mmap = perf_event__process_mmap,
523 .comm = perf_event__process_comm,
524 .exit = perf_event__process_task,
525 .fork = perf_event__process_task,
526 .attr = perf_event__process_attr,
527 .event_type = perf_event__process_event_type,
528 .tracing_data = perf_event__process_tracing_data,
529 .build_id = perf_event__process_build_id,
530 .ordered_samples = true,
531 .ordering_requires_timestamps = true,
532 };
533
534 extern volatile int session_done;
535
536 static void sig_handler(int sig __unused)
537 {
538 session_done = 1;
539 }
540
541 static int __cmd_script(struct perf_session *session)
542 {
543 int ret;
544
545 signal(SIGINT, sig_handler);
546
547 ret = perf_session__process_events(session, &perf_script);
548
549 if (debug_mode)
550 pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
551
552 return ret;
553 }
554
555 struct script_spec {
556 struct list_head node;
557 struct scripting_ops *ops;
558 char spec[0];
559 };
560
561 static LIST_HEAD(script_specs);
562
563 static struct script_spec *script_spec__new(const char *spec,
564 struct scripting_ops *ops)
565 {
566 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
567
568 if (s != NULL) {
569 strcpy(s->spec, spec);
570 s->ops = ops;
571 }
572
573 return s;
574 }
575
576 static void script_spec__add(struct script_spec *s)
577 {
578 list_add_tail(&s->node, &script_specs);
579 }
580
581 static struct script_spec *script_spec__find(const char *spec)
582 {
583 struct script_spec *s;
584
585 list_for_each_entry(s, &script_specs, node)
586 if (strcasecmp(s->spec, spec) == 0)
587 return s;
588 return NULL;
589 }
590
591 static struct script_spec *script_spec__findnew(const char *spec,
592 struct scripting_ops *ops)
593 {
594 struct script_spec *s = script_spec__find(spec);
595
596 if (s)
597 return s;
598
599 s = script_spec__new(spec, ops);
600 if (!s)
601 return NULL;
602
603 script_spec__add(s);
604
605 return s;
606 }
607
608 int script_spec_register(const char *spec, struct scripting_ops *ops)
609 {
610 struct script_spec *s;
611
612 s = script_spec__find(spec);
613 if (s)
614 return -1;
615
616 s = script_spec__findnew(spec, ops);
617 if (!s)
618 return -1;
619
620 return 0;
621 }
622
623 static struct scripting_ops *script_spec__lookup(const char *spec)
624 {
625 struct script_spec *s = script_spec__find(spec);
626 if (!s)
627 return NULL;
628
629 return s->ops;
630 }
631
632 static void list_available_languages(void)
633 {
634 struct script_spec *s;
635
636 fprintf(stderr, "\n");
637 fprintf(stderr, "Scripting language extensions (used in "
638 "perf script -s [spec:]script.[spec]):\n\n");
639
640 list_for_each_entry(s, &script_specs, node)
641 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
642
643 fprintf(stderr, "\n");
644 }
645
646 static int parse_scriptname(const struct option *opt __used,
647 const char *str, int unset __used)
648 {
649 char spec[PATH_MAX];
650 const char *script, *ext;
651 int len;
652
653 if (strcmp(str, "lang") == 0) {
654 list_available_languages();
655 exit(0);
656 }
657
658 script = strchr(str, ':');
659 if (script) {
660 len = script - str;
661 if (len >= PATH_MAX) {
662 fprintf(stderr, "invalid language specifier");
663 return -1;
664 }
665 strncpy(spec, str, len);
666 spec[len] = '\0';
667 scripting_ops = script_spec__lookup(spec);
668 if (!scripting_ops) {
669 fprintf(stderr, "invalid language specifier");
670 return -1;
671 }
672 script++;
673 } else {
674 script = str;
675 ext = strrchr(script, '.');
676 if (!ext) {
677 fprintf(stderr, "invalid script extension");
678 return -1;
679 }
680 scripting_ops = script_spec__lookup(++ext);
681 if (!scripting_ops) {
682 fprintf(stderr, "invalid script extension");
683 return -1;
684 }
685 }
686
687 script_name = strdup(script);
688
689 return 0;
690 }
691
692 static int parse_output_fields(const struct option *opt __used,
693 const char *arg, int unset __used)
694 {
695 char *tok;
696 int i, imax = sizeof(all_output_options) / sizeof(struct output_option);
697 int j;
698 int rc = 0;
699 char *str = strdup(arg);
700 int type = -1;
701
702 if (!str)
703 return -ENOMEM;
704
705 /* first word can state for which event type the user is specifying
706 * the fields. If no type exists, the specified fields apply to all
707 * event types found in the file minus the invalid fields for a type.
708 */
709 tok = strchr(str, ':');
710 if (tok) {
711 *tok = '\0';
712 tok++;
713 if (!strcmp(str, "hw"))
714 type = PERF_TYPE_HARDWARE;
715 else if (!strcmp(str, "sw"))
716 type = PERF_TYPE_SOFTWARE;
717 else if (!strcmp(str, "trace"))
718 type = PERF_TYPE_TRACEPOINT;
719 else if (!strcmp(str, "raw"))
720 type = PERF_TYPE_RAW;
721 else {
722 fprintf(stderr, "Invalid event type in field string.\n");
723 rc = -EINVAL;
724 goto out;
725 }
726
727 if (output[type].user_set)
728 pr_warning("Overriding previous field request for %s events.\n",
729 event_type(type));
730
731 output[type].fields = 0;
732 output[type].user_set = true;
733 output[type].wildcard_set = false;
734
735 } else {
736 tok = str;
737 if (strlen(str) == 0) {
738 fprintf(stderr,
739 "Cannot set fields to 'none' for all event types.\n");
740 rc = -EINVAL;
741 goto out;
742 }
743
744 if (output_set_by_user())
745 pr_warning("Overriding previous field request for all events.\n");
746
747 for (j = 0; j < PERF_TYPE_MAX; ++j) {
748 output[j].fields = 0;
749 output[j].user_set = true;
750 output[j].wildcard_set = true;
751 }
752 }
753
754 tok = strtok(tok, ",");
755 while (tok) {
756 for (i = 0; i < imax; ++i) {
757 if (strcmp(tok, all_output_options[i].str) == 0)
758 break;
759 }
760 if (i == imax) {
761 fprintf(stderr, "Invalid field requested.\n");
762 rc = -EINVAL;
763 goto out;
764 }
765
766 if (type == -1) {
767 /* add user option to all events types for
768 * which it is valid
769 */
770 for (j = 0; j < PERF_TYPE_MAX; ++j) {
771 if (output[j].invalid_fields & all_output_options[i].field) {
772 pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
773 all_output_options[i].str, event_type(j));
774 } else
775 output[j].fields |= all_output_options[i].field;
776 }
777 } else {
778 if (output[type].invalid_fields & all_output_options[i].field) {
779 fprintf(stderr, "\'%s\' not valid for %s events.\n",
780 all_output_options[i].str, event_type(type));
781
782 rc = -EINVAL;
783 goto out;
784 }
785 output[type].fields |= all_output_options[i].field;
786 }
787
788 tok = strtok(NULL, ",");
789 }
790
791 if (type >= 0) {
792 if (output[type].fields == 0) {
793 pr_debug("No fields requested for %s type. "
794 "Events will not be displayed.\n", event_type(type));
795 }
796 }
797
798 out:
799 free(str);
800 return rc;
801 }
802
803 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
804 static int is_directory(const char *base_path, const struct dirent *dent)
805 {
806 char path[PATH_MAX];
807 struct stat st;
808
809 sprintf(path, "%s/%s", base_path, dent->d_name);
810 if (stat(path, &st))
811 return 0;
812
813 return S_ISDIR(st.st_mode);
814 }
815
816 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
817 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
818 lang_next) \
819 if ((lang_dirent.d_type == DT_DIR || \
820 (lang_dirent.d_type == DT_UNKNOWN && \
821 is_directory(scripts_path, &lang_dirent))) && \
822 (strcmp(lang_dirent.d_name, ".")) && \
823 (strcmp(lang_dirent.d_name, "..")))
824
825 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
826 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
827 script_next) \
828 if (script_dirent.d_type != DT_DIR && \
829 (script_dirent.d_type != DT_UNKNOWN || \
830 !is_directory(lang_path, &script_dirent)))
831
832
833 #define RECORD_SUFFIX "-record"
834 #define REPORT_SUFFIX "-report"
835
836 struct script_desc {
837 struct list_head node;
838 char *name;
839 char *half_liner;
840 char *args;
841 };
842
843 static LIST_HEAD(script_descs);
844
845 static struct script_desc *script_desc__new(const char *name)
846 {
847 struct script_desc *s = zalloc(sizeof(*s));
848
849 if (s != NULL && name)
850 s->name = strdup(name);
851
852 return s;
853 }
854
855 static void script_desc__delete(struct script_desc *s)
856 {
857 free(s->name);
858 free(s->half_liner);
859 free(s->args);
860 free(s);
861 }
862
863 static void script_desc__add(struct script_desc *s)
864 {
865 list_add_tail(&s->node, &script_descs);
866 }
867
868 static struct script_desc *script_desc__find(const char *name)
869 {
870 struct script_desc *s;
871
872 list_for_each_entry(s, &script_descs, node)
873 if (strcasecmp(s->name, name) == 0)
874 return s;
875 return NULL;
876 }
877
878 static struct script_desc *script_desc__findnew(const char *name)
879 {
880 struct script_desc *s = script_desc__find(name);
881
882 if (s)
883 return s;
884
885 s = script_desc__new(name);
886 if (!s)
887 goto out_delete_desc;
888
889 script_desc__add(s);
890
891 return s;
892
893 out_delete_desc:
894 script_desc__delete(s);
895
896 return NULL;
897 }
898
899 static const char *ends_with(const char *str, const char *suffix)
900 {
901 size_t suffix_len = strlen(suffix);
902 const char *p = str;
903
904 if (strlen(str) > suffix_len) {
905 p = str + strlen(str) - suffix_len;
906 if (!strncmp(p, suffix, suffix_len))
907 return p;
908 }
909
910 return NULL;
911 }
912
913 static char *ltrim(char *str)
914 {
915 int len = strlen(str);
916
917 while (len && isspace(*str)) {
918 len--;
919 str++;
920 }
921
922 return str;
923 }
924
925 static int read_script_info(struct script_desc *desc, const char *filename)
926 {
927 char line[BUFSIZ], *p;
928 FILE *fp;
929
930 fp = fopen(filename, "r");
931 if (!fp)
932 return -1;
933
934 while (fgets(line, sizeof(line), fp)) {
935 p = ltrim(line);
936 if (strlen(p) == 0)
937 continue;
938 if (*p != '#')
939 continue;
940 p++;
941 if (strlen(p) && *p == '!')
942 continue;
943
944 p = ltrim(p);
945 if (strlen(p) && p[strlen(p) - 1] == '\n')
946 p[strlen(p) - 1] = '\0';
947
948 if (!strncmp(p, "description:", strlen("description:"))) {
949 p += strlen("description:");
950 desc->half_liner = strdup(ltrim(p));
951 continue;
952 }
953
954 if (!strncmp(p, "args:", strlen("args:"))) {
955 p += strlen("args:");
956 desc->args = strdup(ltrim(p));
957 continue;
958 }
959 }
960
961 fclose(fp);
962
963 return 0;
964 }
965
966 static char *get_script_root(struct dirent *script_dirent, const char *suffix)
967 {
968 char *script_root, *str;
969
970 script_root = strdup(script_dirent->d_name);
971 if (!script_root)
972 return NULL;
973
974 str = (char *)ends_with(script_root, suffix);
975 if (!str) {
976 free(script_root);
977 return NULL;
978 }
979
980 *str = '\0';
981 return script_root;
982 }
983
984 static int list_available_scripts(const struct option *opt __used,
985 const char *s __used, int unset __used)
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 static char *get_script_path(const char *script_root, const char *suffix)
1033 {
1034 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1035 char scripts_path[MAXPATHLEN];
1036 char script_path[MAXPATHLEN];
1037 DIR *scripts_dir, *lang_dir;
1038 char lang_path[MAXPATHLEN];
1039 char *__script_root;
1040
1041 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1042
1043 scripts_dir = opendir(scripts_path);
1044 if (!scripts_dir)
1045 return NULL;
1046
1047 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1048 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1049 lang_dirent.d_name);
1050 lang_dir = opendir(lang_path);
1051 if (!lang_dir)
1052 continue;
1053
1054 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1055 __script_root = get_script_root(&script_dirent, suffix);
1056 if (__script_root && !strcmp(script_root, __script_root)) {
1057 free(__script_root);
1058 closedir(lang_dir);
1059 closedir(scripts_dir);
1060 snprintf(script_path, MAXPATHLEN, "%s/%s",
1061 lang_path, script_dirent.d_name);
1062 return strdup(script_path);
1063 }
1064 free(__script_root);
1065 }
1066 closedir(lang_dir);
1067 }
1068 closedir(scripts_dir);
1069
1070 return NULL;
1071 }
1072
1073 static bool is_top_script(const char *script_path)
1074 {
1075 return ends_with(script_path, "top") == NULL ? false : true;
1076 }
1077
1078 static int has_required_arg(char *script_path)
1079 {
1080 struct script_desc *desc;
1081 int n_args = 0;
1082 char *p;
1083
1084 desc = script_desc__new(NULL);
1085
1086 if (read_script_info(desc, script_path))
1087 goto out;
1088
1089 if (!desc->args)
1090 goto out;
1091
1092 for (p = desc->args; *p; p++)
1093 if (*p == '<')
1094 n_args++;
1095 out:
1096 script_desc__delete(desc);
1097
1098 return n_args;
1099 }
1100
1101 static const char * const script_usage[] = {
1102 "perf script [<options>]",
1103 "perf script [<options>] record <script> [<record-options>] <command>",
1104 "perf script [<options>] report <script> [script-args]",
1105 "perf script [<options>] <script> [<record-options>] <command>",
1106 "perf script [<options>] <top-script> [script-args]",
1107 NULL
1108 };
1109
1110 static const struct option options[] = {
1111 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1112 "dump raw trace in ASCII"),
1113 OPT_INCR('v', "verbose", &verbose,
1114 "be more verbose (show symbol address, etc)"),
1115 OPT_BOOLEAN('L', "Latency", &latency_format,
1116 "show latency attributes (irqs/preemption disabled, etc)"),
1117 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1118 list_available_scripts),
1119 OPT_CALLBACK('s', "script", NULL, "name",
1120 "script file name (lang:script name, script name, or *)",
1121 parse_scriptname),
1122 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1123 "generate perf-script.xx script in specified language"),
1124 OPT_STRING('i', "input", &input_name, "file",
1125 "input file name"),
1126 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1127 "do various checks like samples ordering and lost events"),
1128 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1129 "file", "vmlinux pathname"),
1130 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1131 "file", "kallsyms pathname"),
1132 OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1133 "When printing symbols do not display call chain"),
1134 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1135 "Look for files with symbols relative to this directory"),
1136 OPT_CALLBACK('f', "fields", NULL, "str",
1137 "comma separated output fields prepend with 'type:'. "
1138 "Valid types: hw,sw,trace,raw. "
1139 "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1140 "addr,symoff",
1141 parse_output_fields),
1142 OPT_BOOLEAN('a', "all-cpus", &system_wide,
1143 "system-wide collection from all CPUs"),
1144 OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1145 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1146 "only display events for these comms"),
1147 OPT_BOOLEAN('I', "show-info", &show_full_info,
1148 "display extended information from perf.data file"),
1149 OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
1150 "Show the path of [kernel.kallsyms]"),
1151
1152 OPT_END()
1153 };
1154
1155 static bool have_cmd(int argc, const char **argv)
1156 {
1157 char **__argv = malloc(sizeof(const char *) * argc);
1158
1159 if (!__argv)
1160 die("malloc");
1161 memcpy(__argv, argv, sizeof(const char *) * argc);
1162 argc = parse_options(argc, (const char **)__argv, record_options,
1163 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1164 free(__argv);
1165
1166 return argc != 0;
1167 }
1168
1169 int cmd_script(int argc, const char **argv, const char *prefix __used)
1170 {
1171 char *rec_script_path = NULL;
1172 char *rep_script_path = NULL;
1173 struct perf_session *session;
1174 char *script_path = NULL;
1175 const char **__argv;
1176 int i, j, err;
1177
1178 setup_scripting();
1179
1180 argc = parse_options(argc, argv, options, script_usage,
1181 PARSE_OPT_STOP_AT_NON_OPTION);
1182
1183 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1184 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1185 if (!rec_script_path)
1186 return cmd_record(argc, argv, NULL);
1187 }
1188
1189 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1190 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1191 if (!rep_script_path) {
1192 fprintf(stderr,
1193 "Please specify a valid report script"
1194 "(see 'perf script -l' for listing)\n");
1195 return -1;
1196 }
1197 }
1198
1199 /* make sure PERF_EXEC_PATH is set for scripts */
1200 perf_set_argv_exec_path(perf_exec_path());
1201
1202 if (argc && !script_name && !rec_script_path && !rep_script_path) {
1203 int live_pipe[2];
1204 int rep_args;
1205 pid_t pid;
1206
1207 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1208 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1209
1210 if (!rec_script_path && !rep_script_path) {
1211 fprintf(stderr, " Couldn't find script %s\n\n See perf"
1212 " script -l for available scripts.\n", argv[0]);
1213 usage_with_options(script_usage, options);
1214 }
1215
1216 if (is_top_script(argv[0])) {
1217 rep_args = argc - 1;
1218 } else {
1219 int rec_args;
1220
1221 rep_args = has_required_arg(rep_script_path);
1222 rec_args = (argc - 1) - rep_args;
1223 if (rec_args < 0) {
1224 fprintf(stderr, " %s script requires options."
1225 "\n\n See perf script -l for available "
1226 "scripts and options.\n", argv[0]);
1227 usage_with_options(script_usage, options);
1228 }
1229 }
1230
1231 if (pipe(live_pipe) < 0) {
1232 perror("failed to create pipe");
1233 exit(-1);
1234 }
1235
1236 pid = fork();
1237 if (pid < 0) {
1238 perror("failed to fork");
1239 exit(-1);
1240 }
1241
1242 if (!pid) {
1243 j = 0;
1244
1245 dup2(live_pipe[1], 1);
1246 close(live_pipe[0]);
1247
1248 if (is_top_script(argv[0])) {
1249 system_wide = true;
1250 } else if (!system_wide) {
1251 system_wide = !have_cmd(argc - rep_args,
1252 &argv[rep_args]);
1253 }
1254
1255 __argv = malloc((argc + 6) * sizeof(const char *));
1256 if (!__argv)
1257 die("malloc");
1258
1259 __argv[j++] = "/bin/sh";
1260 __argv[j++] = rec_script_path;
1261 if (system_wide)
1262 __argv[j++] = "-a";
1263 __argv[j++] = "-q";
1264 __argv[j++] = "-o";
1265 __argv[j++] = "-";
1266 for (i = rep_args + 1; i < argc; i++)
1267 __argv[j++] = argv[i];
1268 __argv[j++] = NULL;
1269
1270 execvp("/bin/sh", (char **)__argv);
1271 free(__argv);
1272 exit(-1);
1273 }
1274
1275 dup2(live_pipe[0], 0);
1276 close(live_pipe[1]);
1277
1278 __argv = malloc((argc + 4) * sizeof(const char *));
1279 if (!__argv)
1280 die("malloc");
1281 j = 0;
1282 __argv[j++] = "/bin/sh";
1283 __argv[j++] = rep_script_path;
1284 for (i = 1; i < rep_args + 1; i++)
1285 __argv[j++] = argv[i];
1286 __argv[j++] = "-i";
1287 __argv[j++] = "-";
1288 __argv[j++] = NULL;
1289
1290 execvp("/bin/sh", (char **)__argv);
1291 free(__argv);
1292 exit(-1);
1293 }
1294
1295 if (rec_script_path)
1296 script_path = rec_script_path;
1297 if (rep_script_path)
1298 script_path = rep_script_path;
1299
1300 if (script_path) {
1301 j = 0;
1302
1303 if (!rec_script_path)
1304 system_wide = false;
1305 else if (!system_wide)
1306 system_wide = !have_cmd(argc - 1, &argv[1]);
1307
1308 __argv = malloc((argc + 2) * sizeof(const char *));
1309 if (!__argv)
1310 die("malloc");
1311 __argv[j++] = "/bin/sh";
1312 __argv[j++] = script_path;
1313 if (system_wide)
1314 __argv[j++] = "-a";
1315 for (i = 2; i < argc; i++)
1316 __argv[j++] = argv[i];
1317 __argv[j++] = NULL;
1318
1319 execvp("/bin/sh", (char **)__argv);
1320 free(__argv);
1321 exit(-1);
1322 }
1323
1324 if (symbol__init() < 0)
1325 return -1;
1326 if (!script_name)
1327 setup_pager();
1328
1329 session = perf_session__new(input_name, O_RDONLY, 0, false,
1330 &perf_script);
1331 if (session == NULL)
1332 return -ENOMEM;
1333
1334 if (cpu_list) {
1335 if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
1336 return -1;
1337 }
1338
1339 perf_session__fprintf_info(session, stdout, show_full_info);
1340
1341 if (!no_callchain)
1342 symbol_conf.use_callchain = true;
1343 else
1344 symbol_conf.use_callchain = false;
1345
1346 if (generate_script_lang) {
1347 struct stat perf_stat;
1348 int input;
1349
1350 if (output_set_by_user()) {
1351 fprintf(stderr,
1352 "custom fields not supported for generated scripts");
1353 return -1;
1354 }
1355
1356 input = open(session->filename, O_RDONLY); /* input_name */
1357 if (input < 0) {
1358 perror("failed to open file");
1359 exit(-1);
1360 }
1361
1362 err = fstat(input, &perf_stat);
1363 if (err < 0) {
1364 perror("failed to stat file");
1365 exit(-1);
1366 }
1367
1368 if (!perf_stat.st_size) {
1369 fprintf(stderr, "zero-sized file, nothing to do!\n");
1370 exit(0);
1371 }
1372
1373 scripting_ops = script_spec__lookup(generate_script_lang);
1374 if (!scripting_ops) {
1375 fprintf(stderr, "invalid language specifier");
1376 return -1;
1377 }
1378
1379 err = scripting_ops->generate_script(session->pevent,
1380 "perf-script");
1381 goto out;
1382 }
1383
1384 if (script_name) {
1385 err = scripting_ops->start_script(script_name, argc, argv);
1386 if (err)
1387 goto out;
1388 pr_debug("perf script started with script %s\n\n", script_name);
1389 }
1390
1391
1392 err = perf_session__check_output_opt(session);
1393 if (err < 0)
1394 goto out;
1395
1396 err = __cmd_script(session);
1397
1398 perf_session__delete(session);
1399 cleanup_scripting();
1400 out:
1401 return err;
1402 }
Linux kernel - Deliverables
This page took 0.072526 seconds and 6 git commands to generate.