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