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
;
15 static int default_start_script(const char *script __unused
,
17 const char **argv __unused
)
22 static int default_stop_script(void)
27 static int default_generate_script(const char *outfile __unused
)
32 static struct scripting_ops default_scripting_ops
= {
33 .start_script
= default_start_script
,
34 .stop_script
= default_stop_script
,
35 .process_event
= print_event
,
36 .generate_script
= default_generate_script
,
39 static struct scripting_ops
*scripting_ops
;
41 static void setup_scripting(void)
43 /* make sure PERF_EXEC_PATH is set for scripts */
44 perf_set_argv_exec_path(perf_exec_path());
46 setup_perl_scripting();
47 setup_python_scripting();
49 scripting_ops
= &default_scripting_ops
;
52 static int cleanup_scripting(void)
54 return scripting_ops
->stop_script();
57 #include "util/parse-options.h"
60 #include "util/debug.h"
62 #include "util/trace-event.h"
63 #include "util/exec_cmd.h"
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 * FIXME: better resolve from pid from the struct trace_entry
92 * field, although it should be the same than this perf
95 scripting_ops
->process_event(data
.cpu
, data
.raw_data
,
97 data
.time
, thread
->comm
);
100 session
->events_stats
.total
+= data
.period
;
104 static struct perf_event_ops event_ops
= {
105 .sample
= process_sample_event
,
106 .comm
= event__process_comm
,
109 static int __cmd_trace(struct perf_session
*session
)
111 return perf_session__process_events(session
, &event_ops
);
115 struct list_head node
;
116 struct scripting_ops
*ops
;
120 LIST_HEAD(script_specs
);
122 static struct script_spec
*script_spec__new(const char *spec
,
123 struct scripting_ops
*ops
)
125 struct script_spec
*s
= malloc(sizeof(*s
) + strlen(spec
) + 1);
128 strcpy(s
->spec
, spec
);
135 static void script_spec__delete(struct script_spec
*s
)
141 static void script_spec__add(struct script_spec
*s
)
143 list_add_tail(&s
->node
, &script_specs
);
146 static struct script_spec
*script_spec__find(const char *spec
)
148 struct script_spec
*s
;
150 list_for_each_entry(s
, &script_specs
, node
)
151 if (strcasecmp(s
->spec
, spec
) == 0)
156 static struct script_spec
*script_spec__findnew(const char *spec
,
157 struct scripting_ops
*ops
)
159 struct script_spec
*s
= script_spec__find(spec
);
164 s
= script_spec__new(spec
, ops
);
166 goto out_delete_spec
;
173 script_spec__delete(s
);
178 int script_spec_register(const char *spec
, struct scripting_ops
*ops
)
180 struct script_spec
*s
;
182 s
= script_spec__find(spec
);
186 s
= script_spec__findnew(spec
, ops
);
193 static struct scripting_ops
*script_spec__lookup(const char *spec
)
195 struct script_spec
*s
= script_spec__find(spec
);
202 static void list_available_languages(void)
204 struct script_spec
*s
;
206 fprintf(stderr
, "\n");
207 fprintf(stderr
, "Scripting language extensions (used in "
208 "perf trace -s [spec:]script.[spec]):\n\n");
210 list_for_each_entry(s
, &script_specs
, node
)
211 fprintf(stderr
, " %-42s [%s]\n", s
->spec
, s
->ops
->name
);
213 fprintf(stderr
, "\n");
216 static int parse_scriptname(const struct option
*opt __used
,
217 const char *str
, int unset __used
)
220 const char *script
, *ext
;
223 if (strcmp(str
, "lang") == 0) {
224 list_available_languages();
228 script
= strchr(str
, ':');
231 if (len
>= PATH_MAX
) {
232 fprintf(stderr
, "invalid language specifier");
235 strncpy(spec
, str
, len
);
237 scripting_ops
= script_spec__lookup(spec
);
238 if (!scripting_ops
) {
239 fprintf(stderr
, "invalid language specifier");
245 ext
= strchr(script
, '.');
247 fprintf(stderr
, "invalid script extension");
250 scripting_ops
= script_spec__lookup(++ext
);
251 if (!scripting_ops
) {
252 fprintf(stderr
, "invalid script extension");
257 script_name
= strdup(script
);
262 #define for_each_lang(scripts_dir, lang_dirent, lang_next) \
263 while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
265 if (lang_dirent.d_type == DT_DIR && \
266 (strcmp(lang_dirent.d_name, ".")) && \
267 (strcmp(lang_dirent.d_name, "..")))
269 #define for_each_script(lang_dir, script_dirent, script_next) \
270 while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
272 if (script_dirent.d_type != DT_DIR)
275 #define RECORD_SUFFIX "-record"
276 #define REPORT_SUFFIX "-report"
279 struct list_head node
;
285 LIST_HEAD(script_descs
);
287 static struct script_desc
*script_desc__new(const char *name
)
289 struct script_desc
*s
= zalloc(sizeof(*s
));
292 s
->name
= strdup(name
);
297 static void script_desc__delete(struct script_desc
*s
)
303 static void script_desc__add(struct script_desc
*s
)
305 list_add_tail(&s
->node
, &script_descs
);
308 static struct script_desc
*script_desc__find(const char *name
)
310 struct script_desc
*s
;
312 list_for_each_entry(s
, &script_descs
, node
)
313 if (strcasecmp(s
->name
, name
) == 0)
318 static struct script_desc
*script_desc__findnew(const char *name
)
320 struct script_desc
*s
= script_desc__find(name
);
325 s
= script_desc__new(name
);
327 goto out_delete_desc
;
334 script_desc__delete(s
);
339 static char *ends_with(char *str
, const char *suffix
)
341 size_t suffix_len
= strlen(suffix
);
344 if (strlen(str
) > suffix_len
) {
345 p
= str
+ strlen(str
) - suffix_len
;
346 if (!strncmp(p
, suffix
, suffix_len
))
353 static char *ltrim(char *str
)
355 int len
= strlen(str
);
357 while (len
&& isspace(*str
)) {
365 static int read_script_info(struct script_desc
*desc
, const char *filename
)
367 char line
[BUFSIZ
], *p
;
370 fp
= fopen(filename
, "r");
374 while (fgets(line
, sizeof(line
), fp
)) {
381 if (strlen(p
) && *p
== '!')
385 if (strlen(p
) && p
[strlen(p
) - 1] == '\n')
386 p
[strlen(p
) - 1] = '\0';
388 if (!strncmp(p
, "description:", strlen("description:"))) {
389 p
+= strlen("description:");
390 desc
->half_liner
= strdup(ltrim(p
));
394 if (!strncmp(p
, "args:", strlen("args:"))) {
395 p
+= strlen("args:");
396 desc
->args
= strdup(ltrim(p
));
406 static int list_available_scripts(const struct option
*opt __used
,
407 const char *s __used
, int unset __used
)
409 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
410 char scripts_path
[MAXPATHLEN
];
411 DIR *scripts_dir
, *lang_dir
;
412 char script_path
[MAXPATHLEN
];
413 char lang_path
[MAXPATHLEN
];
414 struct script_desc
*desc
;
415 char first_half
[BUFSIZ
];
419 snprintf(scripts_path
, MAXPATHLEN
, "%s/scripts", perf_exec_path());
421 scripts_dir
= opendir(scripts_path
);
425 for_each_lang(scripts_dir
, lang_dirent
, lang_next
) {
426 snprintf(lang_path
, MAXPATHLEN
, "%s/%s/bin", scripts_path
,
428 lang_dir
= opendir(lang_path
);
432 for_each_script(lang_dir
, script_dirent
, script_next
) {
433 script_root
= strdup(script_dirent
.d_name
);
434 str
= ends_with(script_root
, REPORT_SUFFIX
);
437 desc
= script_desc__findnew(script_root
);
438 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
439 lang_path
, script_dirent
.d_name
);
440 read_script_info(desc
, script_path
);
446 fprintf(stdout
, "List of available trace scripts:\n");
447 list_for_each_entry(desc
, &script_descs
, node
) {
448 sprintf(first_half
, "%s %s", desc
->name
,
449 desc
->args
? desc
->args
: "");
450 fprintf(stdout
, " %-36s %s\n", first_half
,
451 desc
->half_liner
? desc
->half_liner
: "");
457 static char *get_script_path(const char *script_root
, const char *suffix
)
459 struct dirent
*script_next
, *lang_next
, script_dirent
, lang_dirent
;
460 char scripts_path
[MAXPATHLEN
];
461 char script_path
[MAXPATHLEN
];
462 DIR *scripts_dir
, *lang_dir
;
463 char lang_path
[MAXPATHLEN
];
464 char *str
, *__script_root
;
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
, suffix
);
485 if (strcmp(__script_root
, script_root
))
487 snprintf(script_path
, MAXPATHLEN
, "%s/%s",
488 lang_path
, script_dirent
.d_name
);
489 path
= strdup(script_path
);
500 static const char * const trace_usage
[] = {
501 "perf trace [<options>] <command>",
505 static const struct option options
[] = {
506 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
507 "dump raw trace in ASCII"),
508 OPT_BOOLEAN('v', "verbose", &verbose
,
509 "be more verbose (show symbol address, etc)"),
510 OPT_BOOLEAN('L', "Latency", &latency_format
,
511 "show latency attributes (irqs/preemption disabled, etc)"),
512 OPT_CALLBACK_NOOPT('l', "list", NULL
, NULL
, "list available scripts",
513 list_available_scripts
),
514 OPT_CALLBACK('s', "script", NULL
, "name",
515 "script file name (lang:script name, script name, or *)",
517 OPT_STRING('g', "gen-script", &generate_script_lang
, "lang",
518 "generate perf-trace.xx script in specified language"),
519 OPT_STRING('i', "input", &input_name
, "file",
525 int cmd_trace(int argc
, const char **argv
, const char *prefix __used
)
527 struct perf_session
*session
;
528 const char *suffix
= NULL
;
533 if (argc
>= 2 && strncmp(argv
[1], "rec", strlen("rec")) == 0) {
536 "Please specify a record script\n");
539 suffix
= RECORD_SUFFIX
;
542 if (argc
>= 2 && strncmp(argv
[1], "rep", strlen("rep")) == 0) {
545 "Please specify a report script\n");
548 suffix
= REPORT_SUFFIX
;
552 script_path
= get_script_path(argv
[2], suffix
);
554 fprintf(stderr
, "script not found\n");
558 __argv
= malloc((argc
+ 1) * sizeof(const char *));
559 __argv
[0] = "/bin/sh";
560 __argv
[1] = script_path
;
561 for (i
= 3; i
< argc
; i
++)
562 __argv
[i
- 1] = argv
[i
];
563 __argv
[argc
- 1] = NULL
;
565 execvp("/bin/sh", (char **)__argv
);
571 argc
= parse_options(argc
, argv
, options
, trace_usage
,
572 PARSE_OPT_STOP_AT_NON_OPTION
);
574 if (symbol__init() < 0)
579 session
= perf_session__new(input_name
, O_RDONLY
, 0);
583 if (!perf_session__has_traces(session
, "record -R"))
586 if (generate_script_lang
) {
587 struct stat perf_stat
;
589 int input
= open(input_name
, O_RDONLY
);
591 perror("failed to open file");
595 err
= fstat(input
, &perf_stat
);
597 perror("failed to stat file");
601 if (!perf_stat
.st_size
) {
602 fprintf(stderr
, "zero-sized file, nothing to do!\n");
606 scripting_ops
= script_spec__lookup(generate_script_lang
);
607 if (!scripting_ops
) {
608 fprintf(stderr
, "invalid language specifier");
612 err
= scripting_ops
->generate_script("perf-trace");
617 err
= scripting_ops
->start_script(script_name
, argc
, argv
);
622 err
= __cmd_trace(session
);
624 perf_session__delete(session
);