perf script: Fix event ordering settings to work with older kernels
[linux-2.6/btrfs-unstable.git] / tools / perf / builtin-script.c
blob43480fd66db7ebed659efe27d0415e8f68882330
1 #include "builtin.h"
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/parse-options.h"
14 #include "util/util.h"
16 static char const *script_name;
17 static char const *generate_script_lang;
18 static bool debug_mode;
19 static u64 last_timestamp;
20 static u64 nr_unordered;
21 extern const struct option record_options[];
23 static int default_start_script(const char *script __unused,
24 int argc __unused,
25 const char **argv __unused)
27 return 0;
30 static int default_stop_script(void)
32 return 0;
35 static int default_generate_script(const char *outfile __unused)
37 return 0;
40 static struct scripting_ops default_scripting_ops = {
41 .start_script = default_start_script,
42 .stop_script = default_stop_script,
43 .process_event = print_event,
44 .generate_script = default_generate_script,
47 static struct scripting_ops *scripting_ops;
49 static void setup_scripting(void)
51 setup_perl_scripting();
52 setup_python_scripting();
54 scripting_ops = &default_scripting_ops;
57 static int cleanup_scripting(void)
59 pr_debug("\nperf script stopped\n");
61 return scripting_ops->stop_script();
64 static char const *input_name = "perf.data";
66 static int process_sample_event(event_t *event, struct sample_data *sample,
67 struct perf_session *session)
69 struct thread *thread = perf_session__findnew(session, event->ip.pid);
71 if (thread == NULL) {
72 pr_debug("problem processing %d event, skipping it.\n",
73 event->header.type);
74 return -1;
77 if (session->sample_type & PERF_SAMPLE_RAW) {
78 if (debug_mode) {
79 if (sample->time < last_timestamp) {
80 pr_err("Samples misordered, previous: %llu "
81 "this: %llu\n", last_timestamp,
82 sample->time);
83 nr_unordered++;
85 last_timestamp = sample->time;
86 return 0;
89 * FIXME: better resolve from pid from the struct trace_entry
90 * field, although it should be the same than this perf
91 * event pid
93 scripting_ops->process_event(sample->cpu, sample->raw_data,
94 sample->raw_size,
95 sample->time, thread->comm);
98 session->hists.stats.total_period += sample->period;
99 return 0;
102 static u64 nr_lost;
104 static int process_lost_event(event_t *event, struct sample_data *sample __used,
105 struct perf_session *session __used)
107 nr_lost += event->lost.lost;
109 return 0;
112 static struct perf_event_ops event_ops = {
113 .sample = process_sample_event,
114 .comm = event__process_comm,
115 .attr = event__process_attr,
116 .event_type = event__process_event_type,
117 .tracing_data = event__process_tracing_data,
118 .build_id = event__process_build_id,
119 .lost = process_lost_event,
120 .ordering_requires_timestamps = true,
121 .ordered_samples = true,
124 extern volatile int session_done;
126 static void sig_handler(int sig __unused)
128 session_done = 1;
131 static int __cmd_script(struct perf_session *session)
133 int ret;
135 signal(SIGINT, sig_handler);
137 ret = perf_session__process_events(session, &event_ops);
139 if (debug_mode) {
140 pr_err("Misordered timestamps: %llu\n", nr_unordered);
141 pr_err("Lost events: %llu\n", nr_lost);
144 return ret;
147 struct script_spec {
148 struct list_head node;
149 struct scripting_ops *ops;
150 char spec[0];
153 LIST_HEAD(script_specs);
155 static struct script_spec *script_spec__new(const char *spec,
156 struct scripting_ops *ops)
158 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
160 if (s != NULL) {
161 strcpy(s->spec, spec);
162 s->ops = ops;
165 return s;
168 static void script_spec__delete(struct script_spec *s)
170 free(s->spec);
171 free(s);
174 static void script_spec__add(struct script_spec *s)
176 list_add_tail(&s->node, &script_specs);
179 static struct script_spec *script_spec__find(const char *spec)
181 struct script_spec *s;
183 list_for_each_entry(s, &script_specs, node)
184 if (strcasecmp(s->spec, spec) == 0)
185 return s;
186 return NULL;
189 static struct script_spec *script_spec__findnew(const char *spec,
190 struct scripting_ops *ops)
192 struct script_spec *s = script_spec__find(spec);
194 if (s)
195 return s;
197 s = script_spec__new(spec, ops);
198 if (!s)
199 goto out_delete_spec;
201 script_spec__add(s);
203 return s;
205 out_delete_spec:
206 script_spec__delete(s);
208 return NULL;
211 int script_spec_register(const char *spec, struct scripting_ops *ops)
213 struct script_spec *s;
215 s = script_spec__find(spec);
216 if (s)
217 return -1;
219 s = script_spec__findnew(spec, ops);
220 if (!s)
221 return -1;
223 return 0;
226 static struct scripting_ops *script_spec__lookup(const char *spec)
228 struct script_spec *s = script_spec__find(spec);
229 if (!s)
230 return NULL;
232 return s->ops;
235 static void list_available_languages(void)
237 struct script_spec *s;
239 fprintf(stderr, "\n");
240 fprintf(stderr, "Scripting language extensions (used in "
241 "perf script -s [spec:]script.[spec]):\n\n");
243 list_for_each_entry(s, &script_specs, node)
244 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
246 fprintf(stderr, "\n");
249 static int parse_scriptname(const struct option *opt __used,
250 const char *str, int unset __used)
252 char spec[PATH_MAX];
253 const char *script, *ext;
254 int len;
256 if (strcmp(str, "lang") == 0) {
257 list_available_languages();
258 exit(0);
261 script = strchr(str, ':');
262 if (script) {
263 len = script - str;
264 if (len >= PATH_MAX) {
265 fprintf(stderr, "invalid language specifier");
266 return -1;
268 strncpy(spec, str, len);
269 spec[len] = '\0';
270 scripting_ops = script_spec__lookup(spec);
271 if (!scripting_ops) {
272 fprintf(stderr, "invalid language specifier");
273 return -1;
275 script++;
276 } else {
277 script = str;
278 ext = strrchr(script, '.');
279 if (!ext) {
280 fprintf(stderr, "invalid script extension");
281 return -1;
283 scripting_ops = script_spec__lookup(++ext);
284 if (!scripting_ops) {
285 fprintf(stderr, "invalid script extension");
286 return -1;
290 script_name = strdup(script);
292 return 0;
295 /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
296 static int is_directory(const char *base_path, const struct dirent *dent)
298 char path[PATH_MAX];
299 struct stat st;
301 sprintf(path, "%s/%s", base_path, dent->d_name);
302 if (stat(path, &st))
303 return 0;
305 return S_ISDIR(st.st_mode);
308 #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
309 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
310 lang_next) \
311 if ((lang_dirent.d_type == DT_DIR || \
312 (lang_dirent.d_type == DT_UNKNOWN && \
313 is_directory(scripts_path, &lang_dirent))) && \
314 (strcmp(lang_dirent.d_name, ".")) && \
315 (strcmp(lang_dirent.d_name, "..")))
317 #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
318 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
319 script_next) \
320 if (script_dirent.d_type != DT_DIR && \
321 (script_dirent.d_type != DT_UNKNOWN || \
322 !is_directory(lang_path, &script_dirent)))
325 #define RECORD_SUFFIX "-record"
326 #define REPORT_SUFFIX "-report"
328 struct script_desc {
329 struct list_head node;
330 char *name;
331 char *half_liner;
332 char *args;
335 LIST_HEAD(script_descs);
337 static struct script_desc *script_desc__new(const char *name)
339 struct script_desc *s = zalloc(sizeof(*s));
341 if (s != NULL && name)
342 s->name = strdup(name);
344 return s;
347 static void script_desc__delete(struct script_desc *s)
349 free(s->name);
350 free(s->half_liner);
351 free(s->args);
352 free(s);
355 static void script_desc__add(struct script_desc *s)
357 list_add_tail(&s->node, &script_descs);
360 static struct script_desc *script_desc__find(const char *name)
362 struct script_desc *s;
364 list_for_each_entry(s, &script_descs, node)
365 if (strcasecmp(s->name, name) == 0)
366 return s;
367 return NULL;
370 static struct script_desc *script_desc__findnew(const char *name)
372 struct script_desc *s = script_desc__find(name);
374 if (s)
375 return s;
377 s = script_desc__new(name);
378 if (!s)
379 goto out_delete_desc;
381 script_desc__add(s);
383 return s;
385 out_delete_desc:
386 script_desc__delete(s);
388 return NULL;
391 static const char *ends_with(const char *str, const char *suffix)
393 size_t suffix_len = strlen(suffix);
394 const char *p = str;
396 if (strlen(str) > suffix_len) {
397 p = str + strlen(str) - suffix_len;
398 if (!strncmp(p, suffix, suffix_len))
399 return p;
402 return NULL;
405 static char *ltrim(char *str)
407 int len = strlen(str);
409 while (len && isspace(*str)) {
410 len--;
411 str++;
414 return str;
417 static int read_script_info(struct script_desc *desc, const char *filename)
419 char line[BUFSIZ], *p;
420 FILE *fp;
422 fp = fopen(filename, "r");
423 if (!fp)
424 return -1;
426 while (fgets(line, sizeof(line), fp)) {
427 p = ltrim(line);
428 if (strlen(p) == 0)
429 continue;
430 if (*p != '#')
431 continue;
432 p++;
433 if (strlen(p) && *p == '!')
434 continue;
436 p = ltrim(p);
437 if (strlen(p) && p[strlen(p) - 1] == '\n')
438 p[strlen(p) - 1] = '\0';
440 if (!strncmp(p, "description:", strlen("description:"))) {
441 p += strlen("description:");
442 desc->half_liner = strdup(ltrim(p));
443 continue;
446 if (!strncmp(p, "args:", strlen("args:"))) {
447 p += strlen("args:");
448 desc->args = strdup(ltrim(p));
449 continue;
453 fclose(fp);
455 return 0;
458 static int list_available_scripts(const struct option *opt __used,
459 const char *s __used, int unset __used)
461 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
462 char scripts_path[MAXPATHLEN];
463 DIR *scripts_dir, *lang_dir;
464 char script_path[MAXPATHLEN];
465 char lang_path[MAXPATHLEN];
466 struct script_desc *desc;
467 char first_half[BUFSIZ];
468 char *script_root;
469 char *str;
471 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
473 scripts_dir = opendir(scripts_path);
474 if (!scripts_dir)
475 return -1;
477 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
478 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
479 lang_dirent.d_name);
480 lang_dir = opendir(lang_path);
481 if (!lang_dir)
482 continue;
484 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
485 script_root = strdup(script_dirent.d_name);
486 str = (char *)ends_with(script_root, REPORT_SUFFIX);
487 if (str) {
488 *str = '\0';
489 desc = script_desc__findnew(script_root);
490 snprintf(script_path, MAXPATHLEN, "%s/%s",
491 lang_path, script_dirent.d_name);
492 read_script_info(desc, script_path);
494 free(script_root);
498 fprintf(stdout, "List of available trace scripts:\n");
499 list_for_each_entry(desc, &script_descs, node) {
500 sprintf(first_half, "%s %s", desc->name,
501 desc->args ? desc->args : "");
502 fprintf(stdout, " %-36s %s\n", first_half,
503 desc->half_liner ? desc->half_liner : "");
506 exit(0);
509 static char *get_script_path(const char *script_root, const char *suffix)
511 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
512 char scripts_path[MAXPATHLEN];
513 char script_path[MAXPATHLEN];
514 DIR *scripts_dir, *lang_dir;
515 char lang_path[MAXPATHLEN];
516 char *str, *__script_root;
517 char *path = NULL;
519 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
521 scripts_dir = opendir(scripts_path);
522 if (!scripts_dir)
523 return NULL;
525 for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
526 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
527 lang_dirent.d_name);
528 lang_dir = opendir(lang_path);
529 if (!lang_dir)
530 continue;
532 for_each_script(lang_path, lang_dir, script_dirent, script_next) {
533 __script_root = strdup(script_dirent.d_name);
534 str = (char *)ends_with(__script_root, suffix);
535 if (str) {
536 *str = '\0';
537 if (strcmp(__script_root, script_root))
538 continue;
539 snprintf(script_path, MAXPATHLEN, "%s/%s",
540 lang_path, script_dirent.d_name);
541 path = strdup(script_path);
542 free(__script_root);
543 break;
545 free(__script_root);
549 return path;
552 static bool is_top_script(const char *script_path)
554 return ends_with(script_path, "top") == NULL ? false : true;
557 static int has_required_arg(char *script_path)
559 struct script_desc *desc;
560 int n_args = 0;
561 char *p;
563 desc = script_desc__new(NULL);
565 if (read_script_info(desc, script_path))
566 goto out;
568 if (!desc->args)
569 goto out;
571 for (p = desc->args; *p; p++)
572 if (*p == '<')
573 n_args++;
574 out:
575 script_desc__delete(desc);
577 return n_args;
580 static const char * const script_usage[] = {
581 "perf script [<options>]",
582 "perf script [<options>] record <script> [<record-options>] <command>",
583 "perf script [<options>] report <script> [script-args]",
584 "perf script [<options>] <script> [<record-options>] <command>",
585 "perf script [<options>] <top-script> [script-args]",
586 NULL
589 static const struct option options[] = {
590 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
591 "dump raw trace in ASCII"),
592 OPT_INCR('v', "verbose", &verbose,
593 "be more verbose (show symbol address, etc)"),
594 OPT_BOOLEAN('L', "Latency", &latency_format,
595 "show latency attributes (irqs/preemption disabled, etc)"),
596 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
597 list_available_scripts),
598 OPT_CALLBACK('s', "script", NULL, "name",
599 "script file name (lang:script name, script name, or *)",
600 parse_scriptname),
601 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
602 "generate perf-script.xx script in specified language"),
603 OPT_STRING('i', "input", &input_name, "file",
604 "input file name"),
605 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
606 "do various checks like samples ordering and lost events"),
608 OPT_END()
611 static bool have_cmd(int argc, const char **argv)
613 char **__argv = malloc(sizeof(const char *) * argc);
615 if (!__argv)
616 die("malloc");
617 memcpy(__argv, argv, sizeof(const char *) * argc);
618 argc = parse_options(argc, (const char **)__argv, record_options,
619 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
620 free(__argv);
622 return argc != 0;
625 int cmd_script(int argc, const char **argv, const char *prefix __used)
627 char *rec_script_path = NULL;
628 char *rep_script_path = NULL;
629 struct perf_session *session;
630 char *script_path = NULL;
631 const char **__argv;
632 bool system_wide;
633 int i, j, err;
635 setup_scripting();
637 argc = parse_options(argc, argv, options, script_usage,
638 PARSE_OPT_STOP_AT_NON_OPTION);
640 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
641 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
642 if (!rec_script_path)
643 return cmd_record(argc, argv, NULL);
646 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
647 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
648 if (!rep_script_path) {
649 fprintf(stderr,
650 "Please specify a valid report script"
651 "(see 'perf script -l' for listing)\n");
652 return -1;
656 /* make sure PERF_EXEC_PATH is set for scripts */
657 perf_set_argv_exec_path(perf_exec_path());
659 if (argc && !script_name && !rec_script_path && !rep_script_path) {
660 int live_pipe[2];
661 int rep_args;
662 pid_t pid;
664 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
665 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
667 if (!rec_script_path && !rep_script_path) {
668 fprintf(stderr, " Couldn't find script %s\n\n See perf"
669 " script -l for available scripts.\n", argv[0]);
670 usage_with_options(script_usage, options);
673 if (is_top_script(argv[0])) {
674 rep_args = argc - 1;
675 } else {
676 int rec_args;
678 rep_args = has_required_arg(rep_script_path);
679 rec_args = (argc - 1) - rep_args;
680 if (rec_args < 0) {
681 fprintf(stderr, " %s script requires options."
682 "\n\n See perf script -l for available "
683 "scripts and options.\n", argv[0]);
684 usage_with_options(script_usage, options);
688 if (pipe(live_pipe) < 0) {
689 perror("failed to create pipe");
690 exit(-1);
693 pid = fork();
694 if (pid < 0) {
695 perror("failed to fork");
696 exit(-1);
699 if (!pid) {
700 system_wide = true;
701 j = 0;
703 dup2(live_pipe[1], 1);
704 close(live_pipe[0]);
706 if (!is_top_script(argv[0]))
707 system_wide = !have_cmd(argc - rep_args,
708 &argv[rep_args]);
710 __argv = malloc((argc + 6) * sizeof(const char *));
711 if (!__argv)
712 die("malloc");
714 __argv[j++] = "/bin/sh";
715 __argv[j++] = rec_script_path;
716 if (system_wide)
717 __argv[j++] = "-a";
718 __argv[j++] = "-q";
719 __argv[j++] = "-o";
720 __argv[j++] = "-";
721 for (i = rep_args + 1; i < argc; i++)
722 __argv[j++] = argv[i];
723 __argv[j++] = NULL;
725 execvp("/bin/sh", (char **)__argv);
726 free(__argv);
727 exit(-1);
730 dup2(live_pipe[0], 0);
731 close(live_pipe[1]);
733 __argv = malloc((argc + 4) * sizeof(const char *));
734 if (!__argv)
735 die("malloc");
736 j = 0;
737 __argv[j++] = "/bin/sh";
738 __argv[j++] = rep_script_path;
739 for (i = 1; i < rep_args + 1; i++)
740 __argv[j++] = argv[i];
741 __argv[j++] = "-i";
742 __argv[j++] = "-";
743 __argv[j++] = NULL;
745 execvp("/bin/sh", (char **)__argv);
746 free(__argv);
747 exit(-1);
750 if (rec_script_path)
751 script_path = rec_script_path;
752 if (rep_script_path)
753 script_path = rep_script_path;
755 if (script_path) {
756 system_wide = false;
757 j = 0;
759 if (rec_script_path)
760 system_wide = !have_cmd(argc - 1, &argv[1]);
762 __argv = malloc((argc + 2) * sizeof(const char *));
763 if (!__argv)
764 die("malloc");
765 __argv[j++] = "/bin/sh";
766 __argv[j++] = script_path;
767 if (system_wide)
768 __argv[j++] = "-a";
769 for (i = 2; i < argc; i++)
770 __argv[j++] = argv[i];
771 __argv[j++] = NULL;
773 execvp("/bin/sh", (char **)__argv);
774 free(__argv);
775 exit(-1);
778 if (symbol__init() < 0)
779 return -1;
780 if (!script_name)
781 setup_pager();
783 session = perf_session__new(input_name, O_RDONLY, 0, false, &event_ops);
784 if (session == NULL)
785 return -ENOMEM;
787 if (strcmp(input_name, "-") &&
788 !perf_session__has_traces(session, "record -R"))
789 return -EINVAL;
791 if (generate_script_lang) {
792 struct stat perf_stat;
794 int input = open(input_name, O_RDONLY);
795 if (input < 0) {
796 perror("failed to open file");
797 exit(-1);
800 err = fstat(input, &perf_stat);
801 if (err < 0) {
802 perror("failed to stat file");
803 exit(-1);
806 if (!perf_stat.st_size) {
807 fprintf(stderr, "zero-sized file, nothing to do!\n");
808 exit(0);
811 scripting_ops = script_spec__lookup(generate_script_lang);
812 if (!scripting_ops) {
813 fprintf(stderr, "invalid language specifier");
814 return -1;
817 err = scripting_ops->generate_script("perf-script");
818 goto out;
821 if (script_name) {
822 err = scripting_ops->start_script(script_name, argc, argv);
823 if (err)
824 goto out;
825 pr_debug("perf script started with script %s\n\n", script_name);
828 err = __cmd_script(session);
830 perf_session__delete(session);
831 cleanup_scripting();
832 out:
833 return err;