4 #include "util/cache.h"
5 #include "util/symbol.h"
6 #include "util/thread.h"
7 #include "util/header.h"
8 #include "util/exec_cmd.h"
9 #include "util/trace-event.h"
10 #include "util/session.h"
12 static char const *script_name
;
13 static char const *generate_script_lang
;
14 static bool debug_mode
;
15 static u64 last_timestamp
;
16 static u64 nr_unordered
;
18 static int default_start_script(const char *script __unused
,
20 const char **argv __unused
)
25 static int default_stop_script(void)
30 static int default_generate_script(const char *outfile __unused
)
35 static struct scripting_ops default_scripting_ops
= {
36 .start_script
= default_start_script
,
37 .stop_script
= default_stop_script
,
38 .process_event
= print_event
,
39 .generate_script
= default_generate_script
,
42 static struct scripting_ops
*scripting_ops
;
44 static void setup_scripting(void)
46 /* make sure PERF_EXEC_PATH is set for scripts */
47 perf_set_argv_exec_path(perf_exec_path());
49 setup_perl_scripting();
50 setup_python_scripting();
52 scripting_ops
= &default_scripting_ops
;
55 static int cleanup_scripting(void)
57 pr_debug("\nperf trace script stopped\n");
59 return scripting_ops
->stop_script();
62 #include "util/parse-options.h"
65 #include "util/debug.h"
67 #include "util/trace-event.h"
68 #include "util/exec_cmd.h"
70 static char const *input_name
= "perf.data";
72 static int process_sample_event(event_t
*event
, struct perf_session
*session
)
74 struct sample_data data
;
75 struct thread
*thread
;
77 memset(&data
, 0, sizeof(data
));
82 event__parse_sample(event
, session
->sample_type
, &data
);
84 dump_printf("(IP, %d): %d/%d: %#Lx period: %Ld\n", event
->header
.misc
,
85 data
.pid
, data
.tid
, data
.ip
, data
.period
);
87 thread
= perf_session__findnew(session
, event
->ip
.pid
);
89 pr_debug("problem processing %d event, skipping it.\n",
94 if (session
->sample_type
& PERF_SAMPLE_RAW
) {
96 if (data
.time
< last_timestamp
) {
97 pr_err("Samples misordered, previous: %llu "
98 "this: %llu\n", last_timestamp
,
102 last_timestamp
= data
.time
;
106 * FIXME: better resolve from pid from the struct trace_entry
107 * field, although it should be the same than this perf
110 scripting_ops
->process_event(data
.cpu
, data
.raw_data
,
112 data
.time
, thread
->comm
);
115 session
->hists
.stats
.total_period
+= data
.period
;
121 static int process_lost_event(event_t
*event
, struct perf_session
*session __used
)
123 nr_lost
+= event
->lost
.lost
;
128 static struct perf_event_ops event_ops
= {
129 .sample
= process_sample_event
,
130 .comm
= event__process_comm
,
131 .attr
= event__process_attr
,
132 .event_type
= event__process_event_type
,
133 .tracing_data
= event__process_tracing_data
,
134 .build_id
= event__process_build_id
,
135 .lost
= process_lost_event
,
136 .ordered_samples
= true,
139 extern volatile int session_done
;
141 static void sig_handler(int sig __unused
)
146 static int __cmd_trace(struct perf_session
*session
)
150 signal(SIGINT
, sig_handler
);
152 ret
= perf_session__process_events(session
, &event_ops
);
155 pr_err("Misordered timestamps: %llu\n", nr_unordered
);
156 pr_err("Lost events: %llu\n", nr_lost
);
163 struct list_head node
;
164 struct scripting_ops
*ops
;
168 LIST_HEAD(script_specs
);
170 static struct script_spec
*script_spec__new(const char *spec
,
171 struct scripting_ops
*ops
)
173 struct script_spec
*s
= malloc(sizeof(*s
) + strlen(spec
) + 1);
176 strcpy(s
->spec
, spec
);
183 static void script_spec__delete(struct script_spec
*s
)
189 static void script_spec__add(struct script_spec
*s
)
191 list_add_tail(&s
->node
, &script_specs
);
194 static struct script_spec
*script_spec__find(const char *spec
)
196 struct script_spec
*s
;
198 list_for_each_entry(s
, &script_specs
, node
)
199 if (strcasecmp(s
->spec
, spec
) == 0)
204 static struct script_spec
*script_spec__findnew(const char *spec
,
205 struct scripting_ops
*ops
)
207 struct script_spec
*s
= script_spec__find(spec
);
212 s
= script_spec__new(spec
, ops
);
214 goto out_delete_spec
;
221 script_spec__delete(s
);
226 int script_spec_register(const char *spec
, struct scripting_ops
*ops
)
228 struct script_spec
*s
;
230 s
= script_spec__find(spec
);
234 s
= script_spec__findnew(spec
, ops
);
241 static struct scripting_ops
*script_spec__lookup(const char *spec
)
243 struct script_spec
*s
= script_spec__find(spec
);
250 static void list_available_languages(void)
252 struct script_spec
*s
;
254 fprintf(stderr
, "\n");
255 fprintf(stderr
, "Scripting language extensions (used in "
256 "perf trace -s [spec:]script.[spec]):\n\n");
258 list_for_each_entry(s
, &script_specs
, node
)
259 fprintf(stderr
, " %-42s [%s]\n", s
->spec
, s
->ops
->name
);
261 fprintf(stderr
, "\n");
264 static int parse_scriptname(const struct option
*opt __used
,
265 const char *str
, int unset __used
)
268 const char *script
, *ext
;
271 if (strcmp(str
, "lang") == 0) {
272 list_available_languages();
276 script
= strchr(str
, ':');
279 if (len
>= PATH_MAX
) {
280 fprintf(stderr
, "invalid language specifier");
283 strncpy(spec
, str
, len
);
285 scripting_ops
= script_spec__lookup(spec
);
286 if (!scripting_ops
) {
287 fprintf(stderr
, "invalid language specifier");
293 ext
= strchr(script
, '.');
295 fprintf(stderr
, "invalid script extension");
298 scripting_ops
= script_spec__lookup(++ext
);
299 if (!scripting_ops
) {
300 fprintf(stderr
, "invalid script extension");
305 script_name
= strdup(script
);
310 #define for_each_lang(scripts_dir, lang_dirent, lang_next) \
311 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
313 if (lang_dirent.d_type == DT_DIR && \
314 (strcmp(lang_dirent.d_name, ".")) && \
315 (strcmp(lang_dirent.d_name, "..")))
317 #define for_each_script(lang_dir, script_dirent, script_next) \
318 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
320 if (script_dirent.d_type != DT_DIR)
323 #define RECORD_SUFFIX "-record"
324 #define REPORT_SUFFIX "-report"
327 struct list_head node
;
333 LIST_HEAD(script_descs
);
335 static struct script_desc
*script_desc__new(const char *name
)
337 struct script_desc
*s
= zalloc(sizeof(*s
));
340 s
->name
= strdup(name
);
345 static void script_desc__delete(struct script_desc
*s
)
351 static void script_desc__add(struct script_desc
*s
)
353 list_add_tail(&s
->node
, &script_descs
);
356 static struct script_desc
*script_desc__find(const char *name
)
358 struct script_desc
*s
;
360 list_for_each_entry(s
, &script_descs
, node
)
361 if (strcasecmp(s
->name
, name
) == 0)
366 static struct script_desc
*script_desc__findnew(const char *name
)
368 struct script_desc
*s
= script_desc__find(name
);
373 s
= script_desc__new(name
);
375 goto out_delete_desc
;
382 script_desc__delete(s
);
387 static char *ends_with(char *str
, const char *suffix
)
389 size_t suffix_len
= strlen(suffix
);
392 if (strlen(str
) > suffix_len
) {
393 p
= str
+ strlen(str
) - suffix_len
;
394 if (!strncmp(p
, suffix
, suffix_len
))
401 static char *ltrim(char *str
)
403 int len
= strlen(str
);
405 while (len
&& isspace(*str
)) {
413 static int read_script_info(struct script_desc
*desc
, const char *filename
)
415 char line
[BUFSIZ
], *p
;
418 fp
= fopen(filename
, "r");
422 while (fgets(line
, sizeof(line
), fp
)) {
429 if (strlen(p
) && *p
== '!')
433 if (strlen(p
) && p
[strlen(p
) - 1] == '\n')
434 p
[strlen(p
) - 1] = '\0';
436 if (!strncmp(p
, "description:", strlen("description:"))) {
437 p
+= strlen("description:");
438 desc
->half_liner
= strdup(ltrim(p
));
442 if (!strncmp(p
, "args:", strlen("args:"))) {
443 p
+= strlen("args:");
444 desc
->args
= strdup(ltrim(p
));
454 static int list_available_scripts(const struct option
*opt __used
,
455 const char *s __used
, int unset __used
)
457 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
458 char scripts_path
[MAXPATHLEN
];
459 DIR *scripts_dir
, *lang_dir
;
460 char script_path
[MAXPATHLEN
];
461 char lang_path
[MAXPATHLEN
];
462 struct script_desc
*desc
;
463 char first_half
[BUFSIZ
];
467 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", perf_exec_path());
469 scripts_dir
= opendir(scripts_path
);
473 for_each_lang(scripts_dir
, lang_dirent
, lang_next
) {
474 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
476 lang_dir
= opendir(lang_path
);
480 for_each_script(lang_dir
, script_dirent
, script_next
) {
481 script_root
= strdup(script_dirent
.d_name
);
482 str
= ends_with(script_root
, REPORT_SUFFIX
);
485 desc
= script_desc__findnew(script_root
);
486 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
487 lang_path
, script_dirent
.d_name
);
488 read_script_info(desc
, script_path
);
494 fprintf(stdout
, "List of available trace scripts:\n");
495 list_for_each_entry(desc
, &script_descs
, node
) {
496 sprintf(first_half
, "%s %s", desc
->name
,
497 desc
->args
? desc
->args
: "");
498 fprintf(stdout
, " %-36s %s\n", first_half
,
499 desc
->half_liner
? desc
->half_liner
: "");
505 static char *get_script_path(const char *script_root
, const char *suffix
)
507 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
508 char scripts_path
[MAXPATHLEN
];
509 char script_path
[MAXPATHLEN
];
510 DIR *scripts_dir
, *lang_dir
;
511 char lang_path
[MAXPATHLEN
];
512 char *str
, *__script_root
;
515 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", perf_exec_path());
517 scripts_dir
= opendir(scripts_path
);
521 for_each_lang(scripts_dir
, lang_dirent
, lang_next
) {
522 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
524 lang_dir
= opendir(lang_path
);
528 for_each_script(lang_dir
, script_dirent
, script_next
) {
529 __script_root
= strdup(script_dirent
.d_name
);
530 str
= ends_with(__script_root
, suffix
);
533 if (strcmp(__script_root
, script_root
))
535 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
536 lang_path
, script_dirent
.d_name
);
537 path
= strdup(script_path
);
548 static const char * const trace_usage
[] = {
549 "perf trace [<options>] <command>",
553 static const struct option options
[] = {
554 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
555 "dump raw trace in ASCII"),
556 OPT_INCR('v', "verbose", &verbose
,
557 "be more verbose (show symbol address, etc)"),
558 OPT_BOOLEAN('L', "Latency", &latency_format
,
559 "show latency attributes (irqs/preemption disabled, etc)"),
560 OPT_CALLBACK_NOOPT('l', "list", NULL
, NULL
, "list available scripts",
561 list_available_scripts
),
562 OPT_CALLBACK('s', "script", NULL
, "name",
563 "script file name (lang:script name, script name, or *)",
565 OPT_STRING('g', "gen-script", &generate_script_lang
, "lang",
566 "generate perf-trace.xx script in specified language"),
567 OPT_STRING('i', "input", &input_name
, "file",
569 OPT_BOOLEAN('d', "debug-mode", &debug_mode
,
570 "do various checks like samples ordering and lost events"),
575 int cmd_trace(int argc
, const char **argv
, const char *prefix __used
)
577 struct perf_session
*session
;
578 const char *suffix
= NULL
;
583 if (argc
>= 2 && strncmp(argv
[1], "rec", strlen("rec")) == 0) {
586 "Please specify a record script\n");
589 suffix
= RECORD_SUFFIX
;
592 if (argc
>= 2 && strncmp(argv
[1], "rep", strlen("rep")) == 0) {
595 "Please specify a report script\n");
598 suffix
= REPORT_SUFFIX
;
601 if (!suffix
&& argc
>= 2 && strncmp(argv
[1], "-", strlen("-")) != 0) {
602 char *record_script_path
, *report_script_path
;
606 record_script_path
= get_script_path(argv
[1], RECORD_SUFFIX
);
607 if (!record_script_path
) {
608 fprintf(stderr
, "record script not found\n");
612 report_script_path
= get_script_path(argv
[1], REPORT_SUFFIX
);
613 if (!report_script_path
) {
614 fprintf(stderr
, "report script not found\n");
618 if (pipe(live_pipe
) < 0) {
619 perror("failed to create pipe");
625 perror("failed to fork");
630 dup2(live_pipe
[1], 1);
633 __argv
= malloc(5 * sizeof(const char *));
634 __argv
[0] = "/bin/sh";
635 __argv
[1] = record_script_path
;
640 execvp("/bin/sh", (char **)__argv
);
644 dup2(live_pipe
[0], 0);
647 __argv
= malloc((argc
+ 3) * sizeof(const char *));
648 __argv
[0] = "/bin/sh";
649 __argv
[1] = report_script_path
;
650 for (i
= 2; i
< argc
; i
++)
656 execvp("/bin/sh", (char **)__argv
);
661 script_path
= get_script_path(argv
[2], suffix
);
663 fprintf(stderr
, "script not found\n");
667 __argv
= malloc((argc
+ 1) * sizeof(const char *));
668 __argv
[0] = "/bin/sh";
669 __argv
[1] = script_path
;
670 for (i
= 3; i
< argc
; i
++)
671 __argv
[i
- 1] = argv
[i
];
672 __argv
[argc
- 1] = NULL
;
674 execvp("/bin/sh", (char **)__argv
);
680 argc
= parse_options(argc
, argv
, options
, trace_usage
,
681 PARSE_OPT_STOP_AT_NON_OPTION
);
683 if (symbol__init() < 0)
688 session
= perf_session__new(input_name
, O_RDONLY
, 0, false);
692 if (strcmp(input_name
, "-") &&
693 !perf_session__has_traces(session
, "record -R"))
696 if (generate_script_lang
) {
697 struct stat perf_stat
;
699 int input
= open(input_name
, O_RDONLY
);
701 perror("failed to open file");
705 err
= fstat(input
, &perf_stat
);
707 perror("failed to stat file");
711 if (!perf_stat
.st_size
) {
712 fprintf(stderr
, "zero-sized file, nothing to do!\n");
716 scripting_ops
= script_spec__lookup(generate_script_lang
);
717 if (!scripting_ops
) {
718 fprintf(stderr
, "invalid language specifier");
722 err
= scripting_ops
->generate_script("perf-trace");
727 err
= scripting_ops
->start_script(script_name
, argc
, argv
);
730 pr_debug("perf trace started with script %s\n\n", script_name
);
733 err
= __cmd_trace(session
);
735 perf_session__delete(session
);