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