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