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