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,
25 const char **argv __unused)
30 static int default_stop_script(void)
35 static int default_generate_script(const char *outfile __unused)
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 trace 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 perf_session *session)
68 struct sample_data data;
69 struct thread *thread;
71 memset(&data, 0, sizeof(data));
76 event__parse_sample(event, session->sample_type, &data);
78 dump_printf("(IP, %d): %d/%d: %#Lx period: %Ld\n", event->header.misc,
79 data.pid, data.tid, data.ip, data.period);
81 thread = perf_session__findnew(session, event->ip.pid);
83 pr_debug("problem processing %d event, skipping it.\n",
88 if (session->sample_type & PERF_SAMPLE_RAW) {
90 if (data.time < last_timestamp) {
91 pr_err("Samples misordered, previous: %llu "
92 "this: %llu\n", last_timestamp,
96 last_timestamp = data.time;
100 * FIXME: better resolve from pid from the struct trace_entry
101 * field, although it should be the same than this perf
104 scripting_ops->process_event(data.cpu, data.raw_data,
106 data.time, thread->comm);
109 session->hists.stats.total_period += data.period;
115 static int process_lost_event(event_t *event, struct perf_session *session __used)
117 nr_lost += event->lost.lost;
122 static struct perf_event_ops event_ops = {
123 .sample = process_sample_event,
124 .comm = event__process_comm,
125 .attr = event__process_attr,
126 .event_type = event__process_event_type,
127 .tracing_data = event__process_tracing_data,
128 .build_id = event__process_build_id,
129 .lost = process_lost_event,
130 .ordered_samples = true,
133 extern volatile int session_done;
135 static void sig_handler(int sig __unused)
140 static int __cmd_trace(struct perf_session *session)
144 signal(SIGINT, sig_handler);
146 ret = perf_session__process_events(session, &event_ops);
149 pr_err("Misordered timestamps: %llu\n", nr_unordered);
150 pr_err("Lost events: %llu\n", nr_lost);
157 struct list_head node;
158 struct scripting_ops *ops;
162 LIST_HEAD(script_specs);
164 static struct script_spec *script_spec__new(const char *spec,
165 struct scripting_ops *ops)
167 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
170 strcpy(s->spec, spec);
177 static void script_spec__delete(struct script_spec *s)
183 static void script_spec__add(struct script_spec *s)
185 list_add_tail(&s->node, &script_specs);
188 static struct script_spec *script_spec__find(const char *spec)
190 struct script_spec *s;
192 list_for_each_entry(s, &script_specs, node)
193 if (strcasecmp(s->spec, spec) == 0)
198 static struct script_spec *script_spec__findnew(const char *spec,
199 struct scripting_ops *ops)
201 struct script_spec *s = script_spec__find(spec);
206 s = script_spec__new(spec, ops);
208 goto out_delete_spec;
215 script_spec__delete(s);
220 int script_spec_register(const char *spec, struct scripting_ops *ops)
222 struct script_spec *s;
224 s = script_spec__find(spec);
228 s = script_spec__findnew(spec, ops);
235 static struct scripting_ops *script_spec__lookup(const char *spec)
237 struct script_spec *s = script_spec__find(spec);
244 static void list_available_languages(void)
246 struct script_spec *s;
248 fprintf(stderr, "\n");
249 fprintf(stderr, "Scripting language extensions (used in "
250 "perf trace -s [spec:]script.[spec]):\n\n");
252 list_for_each_entry(s, &script_specs, node)
253 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
255 fprintf(stderr, "\n");
258 static int parse_scriptname(const struct option *opt __used,
259 const char *str, int unset __used)
262 const char *script, *ext;
265 if (strcmp(str, "lang") == 0) {
266 list_available_languages();
270 script = strchr(str, ':');
273 if (len >= PATH_MAX) {
274 fprintf(stderr, "invalid language specifier");
277 strncpy(spec, str, len);
279 scripting_ops = script_spec__lookup(spec);
280 if (!scripting_ops) {
281 fprintf(stderr, "invalid language specifier");
287 ext = strrchr(script, '.');
289 fprintf(stderr, "invalid script extension");
292 scripting_ops = script_spec__lookup(++ext);
293 if (!scripting_ops) {
294 fprintf(stderr, "invalid script extension");
299 script_name = strdup(script);
304 #define for_each_lang(scripts_dir, lang_dirent, lang_next) \
305 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
307 if (lang_dirent.d_type == DT_DIR && \
308 (strcmp(lang_dirent.d_name, ".")) && \
309 (strcmp(lang_dirent.d_name, "..")))
311 #define for_each_script(lang_dir, script_dirent, script_next) \
312 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
314 if (script_dirent.d_type != DT_DIR)
317 #define RECORD_SUFFIX "-record"
318 #define REPORT_SUFFIX "-report"
321 struct list_head node;
327 LIST_HEAD(script_descs);
329 static struct script_desc *script_desc__new(const char *name)
331 struct script_desc *s = zalloc(sizeof(*s));
333 if (s != NULL && name)
334 s->name = strdup(name);
339 static void script_desc__delete(struct script_desc *s)
347 static void script_desc__add(struct script_desc *s)
349 list_add_tail(&s->node, &script_descs);
352 static struct script_desc *script_desc__find(const char *name)
354 struct script_desc *s;
356 list_for_each_entry(s, &script_descs, node)
357 if (strcasecmp(s->name, name) == 0)
362 static struct script_desc *script_desc__findnew(const char *name)
364 struct script_desc *s = script_desc__find(name);
369 s = script_desc__new(name);
371 goto out_delete_desc;
378 script_desc__delete(s);
383 static char *ends_with(char *str, const char *suffix)
385 size_t suffix_len = strlen(suffix);
388 if (strlen(str) > suffix_len) {
389 p = str + strlen(str) - suffix_len;
390 if (!strncmp(p, suffix, suffix_len))
397 static char *ltrim(char *str)
399 int len = strlen(str);
401 while (len && isspace(*str)) {
409 static int read_script_info(struct script_desc *desc, const char *filename)
411 char line[BUFSIZ], *p;
414 fp = fopen(filename, "r");
418 while (fgets(line, sizeof(line), fp)) {
425 if (strlen(p) && *p == '!')
429 if (strlen(p) && p[strlen(p) - 1] == '\n')
430 p[strlen(p) - 1] = '\0';
432 if (!strncmp(p, "description:", strlen("description:"))) {
433 p += strlen("description:");
434 desc->half_liner = strdup(ltrim(p));
438 if (!strncmp(p, "args:", strlen("args:"))) {
439 p += strlen("args:");
440 desc->args = strdup(ltrim(p));
450 static int list_available_scripts(const struct option *opt __used,
451 const char *s __used, int unset __used)
453 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
454 char scripts_path[MAXPATHLEN];
455 DIR *scripts_dir, *lang_dir;
456 char script_path[MAXPATHLEN];
457 char lang_path[MAXPATHLEN];
458 struct script_desc *desc;
459 char first_half[BUFSIZ];
463 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
465 scripts_dir = opendir(scripts_path);
469 for_each_lang(scripts_dir, lang_dirent, lang_next) {
470 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
472 lang_dir = opendir(lang_path);
476 for_each_script(lang_dir, script_dirent, script_next) {
477 script_root = strdup(script_dirent.d_name);
478 str = ends_with(script_root, REPORT_SUFFIX);
481 desc = script_desc__findnew(script_root);
482 snprintf(script_path, MAXPATHLEN, "%s/%s",
483 lang_path, script_dirent.d_name);
484 read_script_info(desc, script_path);
490 fprintf(stdout, "List of available trace scripts:\n");
491 list_for_each_entry(desc, &script_descs, node) {
492 sprintf(first_half, "%s %s", desc->name,
493 desc->args ? desc->args : "");
494 fprintf(stdout, " %-36s %s\n", first_half,
495 desc->half_liner ? desc->half_liner : "");
501 static char *get_script_path(const char *script_root, const char *suffix)
503 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
504 char scripts_path[MAXPATHLEN];
505 char script_path[MAXPATHLEN];
506 DIR *scripts_dir, *lang_dir;
507 char lang_path[MAXPATHLEN];
508 char *str, *__script_root;
511 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
513 scripts_dir = opendir(scripts_path);
517 for_each_lang(scripts_dir, lang_dirent, lang_next) {
518 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
520 lang_dir = opendir(lang_path);
524 for_each_script(lang_dir, script_dirent, script_next) {
525 __script_root = strdup(script_dirent.d_name);
526 str = ends_with(__script_root, suffix);
529 if (strcmp(__script_root, script_root))
531 snprintf(script_path, MAXPATHLEN, "%s/%s",
532 lang_path, script_dirent.d_name);
533 path = strdup(script_path);
544 static bool is_top_script(const char *script_path)
546 return ends_with((char *)script_path, "top") == NULL ? false : true;
549 static int has_required_arg(char *script_path)
551 struct script_desc *desc;
555 desc = script_desc__new(NULL);
557 if (read_script_info(desc, script_path))
563 for (p = desc->args; *p; p++)
567 script_desc__delete(desc);
572 static const char * const trace_usage[] = {
573 "perf trace [<options>]",
574 "perf trace [<options>] record <script> [<record-options>] <command>",
575 "perf trace [<options>] report <script> [script-args]",
576 "perf trace [<options>] <script> [<record-options>] <command>",
577 "perf trace [<options>] <top-script> [script-args]",
581 static const struct option options[] = {
582 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
583 "dump raw trace in ASCII"),
584 OPT_INCR('v', "verbose", &verbose,
585 "be more verbose (show symbol address, etc)"),
586 OPT_BOOLEAN('L', "Latency", &latency_format,
587 "show latency attributes (irqs/preemption disabled, etc)"),
588 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
589 list_available_scripts),
590 OPT_CALLBACK('s', "script", NULL, "name",
591 "script file name (lang:script name, script name, or *)",
593 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
594 "generate perf-trace.xx script in specified language"),
595 OPT_STRING('i', "input", &input_name, "file",
597 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
598 "do various checks like samples ordering and lost events"),
603 static bool have_cmd(int argc, const char **argv)
605 char **__argv = malloc(sizeof(const char *) * argc);
609 memcpy(__argv, argv, sizeof(const char *) * argc);
610 argc = parse_options(argc, (const char **)__argv, record_options,
611 NULL, PARSE_OPT_STOP_AT_NON_OPTION);
617 int cmd_trace(int argc, const char **argv, const char *prefix __used)
619 char *rec_script_path = NULL;
620 char *rep_script_path = NULL;
621 struct perf_session *session;
622 char *script_path = NULL;
629 argc = parse_options(argc, argv, options, trace_usage,
630 PARSE_OPT_STOP_AT_NON_OPTION);
632 if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
633 rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
634 if (!rec_script_path)
635 return cmd_record(argc, argv, NULL);
638 if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
639 rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
640 if (!rep_script_path) {
642 "Please specify a valid report script"
643 "(see 'perf trace -l' for listing)\n");
648 /* make sure PERF_EXEC_PATH is set for scripts */
649 perf_set_argv_exec_path(perf_exec_path());
651 if (argc && !script_name && !rec_script_path && !rep_script_path) {
656 rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
657 rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
659 if (!rec_script_path && !rep_script_path) {
660 fprintf(stderr, " Couldn't find script %s\n\n See perf"
661 " trace -l for available scripts.\n", argv[0]);
662 usage_with_options(trace_usage, options);
665 if (is_top_script(argv[0])) {
670 rep_args = has_required_arg(rep_script_path);
671 rec_args = (argc - 1) - rep_args;
673 fprintf(stderr, " %s script requires options."
674 "\n\n See perf trace -l for available "
675 "scripts and options.\n", argv[0]);
676 usage_with_options(trace_usage, options);
680 if (pipe(live_pipe) < 0) {
681 perror("failed to create pipe");
687 perror("failed to fork");
695 dup2(live_pipe[1], 1);
698 if (!is_top_script(argv[0]))
699 system_wide = !have_cmd(argc - rep_args,
702 __argv = malloc((argc + 6) * sizeof(const char *));
706 __argv[j++] = "/bin/sh";
707 __argv[j++] = rec_script_path;
713 for (i = rep_args + 1; i < argc; i++)
714 __argv[j++] = argv[i];
717 execvp("/bin/sh", (char **)__argv);
722 dup2(live_pipe[0], 0);
725 __argv = malloc((argc + 4) * sizeof(const char *));
729 __argv[j++] = "/bin/sh";
730 __argv[j++] = rep_script_path;
731 for (i = 1; i < rep_args + 1; i++)
732 __argv[j++] = argv[i];
737 execvp("/bin/sh", (char **)__argv);
743 script_path = rec_script_path;
745 script_path = rep_script_path;
752 system_wide = !have_cmd(argc - 1, &argv[1]);
754 __argv = malloc((argc + 2) * sizeof(const char *));
757 __argv[j++] = "/bin/sh";
758 __argv[j++] = script_path;
761 for (i = 2; i < argc; i++)
762 __argv[j++] = argv[i];
765 execvp("/bin/sh", (char **)__argv);
770 if (symbol__init() < 0)
775 session = perf_session__new(input_name, O_RDONLY, 0, false);
779 if (strcmp(input_name, "-") &&
780 !perf_session__has_traces(session, "record -R"))
783 if (generate_script_lang) {
784 struct stat perf_stat;
786 int input = open(input_name, O_RDONLY);
788 perror("failed to open file");
792 err = fstat(input, &perf_stat);
794 perror("failed to stat file");
798 if (!perf_stat.st_size) {
799 fprintf(stderr, "zero-sized file, nothing to do!\n");
803 scripting_ops = script_spec__lookup(generate_script_lang);
804 if (!scripting_ops) {
805 fprintf(stderr, "invalid language specifier");
809 err = scripting_ops->generate_script("perf-trace");
814 err = scripting_ops->start_script(script_name, argc, argv);
817 pr_debug("perf trace started with script %s\n\n", script_name);
820 err = __cmd_trace(session);
822 perf_session__delete(session);