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"
15 static char const *script_name;
16 static char const *generate_script_lang;
17 static bool debug_mode;
18 static u64 last_timestamp;
19 static u64 nr_unordered;
21 static int default_start_script(const char *script __unused,
23 const char **argv __unused)
28 static int default_stop_script(void)
33 static int default_generate_script(const char *outfile __unused)
38 static struct scripting_ops default_scripting_ops = {
39 .start_script = default_start_script,
40 .stop_script = default_stop_script,
41 .process_event = print_event,
42 .generate_script = default_generate_script,
45 static struct scripting_ops *scripting_ops;
47 static void setup_scripting(void)
49 /* make sure PERF_EXEC_PATH is set for scripts */
50 perf_set_argv_exec_path(perf_exec_path());
52 setup_perl_scripting();
53 setup_python_scripting();
55 scripting_ops = &default_scripting_ops;
58 static int cleanup_scripting(void)
60 pr_debug("\nperf trace script stopped\n");
62 return scripting_ops->stop_script();
65 static char const *input_name = "perf.data";
67 static int process_sample_event(event_t *event, struct perf_session *session)
69 struct sample_data data;
70 struct thread *thread;
72 memset(&data, 0, sizeof(data));
77 event__parse_sample(event, session->sample_type, &data);
79 dump_printf("(IP, %d): %d/%d: %#Lx period: %Ld\n", event->header.misc,
80 data.pid, data.tid, data.ip, data.period);
82 thread = perf_session__findnew(session, event->ip.pid);
84 pr_debug("problem processing %d event, skipping it.\n",
89 if (session->sample_type & PERF_SAMPLE_RAW) {
91 if (data.time < last_timestamp) {
92 pr_err("Samples misordered, previous: %llu "
93 "this: %llu\n", last_timestamp,
97 last_timestamp = data.time;
101 * FIXME: better resolve from pid from the struct trace_entry
102 * field, although it should be the same than this perf
105 scripting_ops->process_event(data.cpu, data.raw_data,
107 data.time, thread->comm);
110 session->hists.stats.total_period += data.period;
116 static int process_lost_event(event_t *event, struct perf_session *session __used)
118 nr_lost += event->lost.lost;
123 static struct perf_event_ops event_ops = {
124 .sample = process_sample_event,
125 .comm = event__process_comm,
126 .attr = event__process_attr,
127 .event_type = event__process_event_type,
128 .tracing_data = event__process_tracing_data,
129 .build_id = event__process_build_id,
130 .lost = process_lost_event,
131 .ordered_samples = true,
134 extern volatile int session_done;
136 static void sig_handler(int sig __unused)
141 static int __cmd_trace(struct perf_session *session)
145 signal(SIGINT, sig_handler);
147 ret = perf_session__process_events(session, &event_ops);
150 pr_err("Misordered timestamps: %llu\n", nr_unordered);
151 pr_err("Lost events: %llu\n", nr_lost);
158 struct list_head node;
159 struct scripting_ops *ops;
163 LIST_HEAD(script_specs);
165 static struct script_spec *script_spec__new(const char *spec,
166 struct scripting_ops *ops)
168 struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
171 strcpy(s->spec, spec);
178 static void script_spec__delete(struct script_spec *s)
184 static void script_spec__add(struct script_spec *s)
186 list_add_tail(&s->node, &script_specs);
189 static struct script_spec *script_spec__find(const char *spec)
191 struct script_spec *s;
193 list_for_each_entry(s, &script_specs, node)
194 if (strcasecmp(s->spec, spec) == 0)
199 static struct script_spec *script_spec__findnew(const char *spec,
200 struct scripting_ops *ops)
202 struct script_spec *s = script_spec__find(spec);
207 s = script_spec__new(spec, ops);
209 goto out_delete_spec;
216 script_spec__delete(s);
221 int script_spec_register(const char *spec, struct scripting_ops *ops)
223 struct script_spec *s;
225 s = script_spec__find(spec);
229 s = script_spec__findnew(spec, ops);
236 static struct scripting_ops *script_spec__lookup(const char *spec)
238 struct script_spec *s = script_spec__find(spec);
245 static void list_available_languages(void)
247 struct script_spec *s;
249 fprintf(stderr, "\n");
250 fprintf(stderr, "Scripting language extensions (used in "
251 "perf trace -s [spec:]script.[spec]):\n\n");
253 list_for_each_entry(s, &script_specs, node)
254 fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
256 fprintf(stderr, "\n");
259 static int parse_scriptname(const struct option *opt __used,
260 const char *str, int unset __used)
263 const char *script, *ext;
266 if (strcmp(str, "lang") == 0) {
267 list_available_languages();
271 script = strchr(str, ':');
274 if (len >= PATH_MAX) {
275 fprintf(stderr, "invalid language specifier");
278 strncpy(spec, str, len);
280 scripting_ops = script_spec__lookup(spec);
281 if (!scripting_ops) {
282 fprintf(stderr, "invalid language specifier");
288 ext = strchr(script, '.');
290 fprintf(stderr, "invalid script extension");
293 scripting_ops = script_spec__lookup(++ext);
294 if (!scripting_ops) {
295 fprintf(stderr, "invalid script extension");
300 script_name = strdup(script);
305 #define for_each_lang(scripts_dir, lang_dirent, lang_next) \
306 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
308 if (lang_dirent.d_type == DT_DIR && \
309 (strcmp(lang_dirent.d_name, ".")) && \
310 (strcmp(lang_dirent.d_name, "..")))
312 #define for_each_script(lang_dir, script_dirent, script_next) \
313 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
315 if (script_dirent.d_type != DT_DIR)
318 #define RECORD_SUFFIX "-record"
319 #define REPORT_SUFFIX "-report"
322 struct list_head node;
328 LIST_HEAD(script_descs);
330 static struct script_desc *script_desc__new(const char *name)
332 struct script_desc *s = zalloc(sizeof(*s));
335 s->name = strdup(name);
340 static void script_desc__delete(struct script_desc *s)
346 static void script_desc__add(struct script_desc *s)
348 list_add_tail(&s->node, &script_descs);
351 static struct script_desc *script_desc__find(const char *name)
353 struct script_desc *s;
355 list_for_each_entry(s, &script_descs, node)
356 if (strcasecmp(s->name, name) == 0)
361 static struct script_desc *script_desc__findnew(const char *name)
363 struct script_desc *s = script_desc__find(name);
368 s = script_desc__new(name);
370 goto out_delete_desc;
377 script_desc__delete(s);
382 static char *ends_with(char *str, const char *suffix)
384 size_t suffix_len = strlen(suffix);
387 if (strlen(str) > suffix_len) {
388 p = str + strlen(str) - suffix_len;
389 if (!strncmp(p, suffix, suffix_len))
396 static char *ltrim(char *str)
398 int len = strlen(str);
400 while (len && isspace(*str)) {
408 static int read_script_info(struct script_desc *desc, const char *filename)
410 char line[BUFSIZ], *p;
413 fp = fopen(filename, "r");
417 while (fgets(line, sizeof(line), fp)) {
424 if (strlen(p) && *p == '!')
428 if (strlen(p) && p[strlen(p) - 1] == '\n')
429 p[strlen(p) - 1] = '\0';
431 if (!strncmp(p, "description:", strlen("description:"))) {
432 p += strlen("description:");
433 desc->half_liner = strdup(ltrim(p));
437 if (!strncmp(p, "args:", strlen("args:"))) {
438 p += strlen("args:");
439 desc->args = strdup(ltrim(p));
449 static int list_available_scripts(const struct option *opt __used,
450 const char *s __used, int unset __used)
452 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
453 char scripts_path[MAXPATHLEN];
454 DIR *scripts_dir, *lang_dir;
455 char script_path[MAXPATHLEN];
456 char lang_path[MAXPATHLEN];
457 struct script_desc *desc;
458 char first_half[BUFSIZ];
462 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
464 scripts_dir = opendir(scripts_path);
468 for_each_lang(scripts_dir, lang_dirent, lang_next) {
469 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
471 lang_dir = opendir(lang_path);
475 for_each_script(lang_dir, script_dirent, script_next) {
476 script_root = strdup(script_dirent.d_name);
477 str = ends_with(script_root, REPORT_SUFFIX);
480 desc = script_desc__findnew(script_root);
481 snprintf(script_path, MAXPATHLEN, "%s/%s",
482 lang_path, script_dirent.d_name);
483 read_script_info(desc, script_path);
489 fprintf(stdout, "List of available trace scripts:\n");
490 list_for_each_entry(desc, &script_descs, node) {
491 sprintf(first_half, "%s %s", desc->name,
492 desc->args ? desc->args : "");
493 fprintf(stdout, " %-36s %s\n", first_half,
494 desc->half_liner ? desc->half_liner : "");
500 static char *get_script_path(const char *script_root, const char *suffix)
502 struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
503 char scripts_path[MAXPATHLEN];
504 char script_path[MAXPATHLEN];
505 DIR *scripts_dir, *lang_dir;
506 char lang_path[MAXPATHLEN];
507 char *str, *__script_root;
510 snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
512 scripts_dir = opendir(scripts_path);
516 for_each_lang(scripts_dir, lang_dirent, lang_next) {
517 snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
519 lang_dir = opendir(lang_path);
523 for_each_script(lang_dir, script_dirent, script_next) {
524 __script_root = strdup(script_dirent.d_name);
525 str = ends_with(__script_root, suffix);
528 if (strcmp(__script_root, script_root))
530 snprintf(script_path, MAXPATHLEN, "%s/%s",
531 lang_path, script_dirent.d_name);
532 path = strdup(script_path);
543 static const char * const trace_usage[] = {
544 "perf trace [<options>] <command>",
548 static const struct option options[] = {
549 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
550 "dump raw trace in ASCII"),
551 OPT_INCR('v', "verbose", &verbose,
552 "be more verbose (show symbol address, etc)"),
553 OPT_BOOLEAN('L', "Latency", &latency_format,
554 "show latency attributes (irqs/preemption disabled, etc)"),
555 OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
556 list_available_scripts),
557 OPT_CALLBACK('s', "script", NULL, "name",
558 "script file name (lang:script name, script name, or *)",
560 OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
561 "generate perf-trace.xx script in specified language"),
562 OPT_STRING('i', "input", &input_name, "file",
564 OPT_BOOLEAN('d', "debug-mode", &debug_mode,
565 "do various checks like samples ordering and lost events"),
570 int cmd_trace(int argc, const char **argv, const char *prefix __used)
572 struct perf_session *session;
573 const char *suffix = NULL;
578 if (argc >= 2 && strncmp(argv[1], "rec", strlen("rec")) == 0) {
581 "Please specify a record script\n");
584 suffix = RECORD_SUFFIX;
587 if (argc >= 2 && strncmp(argv[1], "rep", strlen("rep")) == 0) {
590 "Please specify a report script\n");
593 suffix = REPORT_SUFFIX;
596 if (!suffix && argc >= 2 && strncmp(argv[1], "-", strlen("-")) != 0) {
597 char *record_script_path, *report_script_path;
601 record_script_path = get_script_path(argv[1], RECORD_SUFFIX);
602 if (!record_script_path) {
603 fprintf(stderr, "record script not found\n");
607 report_script_path = get_script_path(argv[1], REPORT_SUFFIX);
608 if (!report_script_path) {
609 fprintf(stderr, "report script not found\n");
613 if (pipe(live_pipe) < 0) {
614 perror("failed to create pipe");
620 perror("failed to fork");
625 dup2(live_pipe[1], 1);
628 __argv = malloc(5 * sizeof(const char *));
629 __argv[0] = "/bin/sh";
630 __argv[1] = record_script_path;
635 execvp("/bin/sh", (char **)__argv);
639 dup2(live_pipe[0], 0);
642 __argv = malloc((argc + 3) * sizeof(const char *));
643 __argv[0] = "/bin/sh";
644 __argv[1] = report_script_path;
645 for (i = 2; i < argc; i++)
651 execvp("/bin/sh", (char **)__argv);
656 script_path = get_script_path(argv[2], suffix);
658 fprintf(stderr, "script not found\n");
662 __argv = malloc((argc + 1) * sizeof(const char *));
663 __argv[0] = "/bin/sh";
664 __argv[1] = script_path;
665 for (i = 3; i < argc; i++)
666 __argv[i - 1] = argv[i];
667 __argv[argc - 1] = NULL;
669 execvp("/bin/sh", (char **)__argv);
675 argc = parse_options(argc, argv, options, trace_usage,
676 PARSE_OPT_STOP_AT_NON_OPTION);
678 if (symbol__init() < 0)
683 session = perf_session__new(input_name, O_RDONLY, 0, false);
687 if (strcmp(input_name, "-") &&
688 !perf_session__has_traces(session, "record -R"))
691 if (generate_script_lang) {
692 struct stat perf_stat;
694 int input = open(input_name, O_RDONLY);
696 perror("failed to open file");
700 err = fstat(input, &perf_stat);
702 perror("failed to stat file");
706 if (!perf_stat.st_size) {
707 fprintf(stderr, "zero-sized file, nothing to do!\n");
711 scripting_ops = script_spec__lookup(generate_script_lang);
712 if (!scripting_ops) {
713 fprintf(stderr, "invalid language specifier");
717 err = scripting_ops->generate_script("perf-trace");
722 err = scripting_ops->start_script(script_name, argc, argv);
725 pr_debug("perf trace started with script %s\n\n", script_name);
728 err = __cmd_trace(session);
730 perf_session__delete(session);