2 * trace-event-perl. Feed perf trace events to an embedded Perl interpreter.
4 * Copyright (C) 2009 Tom Zanussi <tzanussi@gmail.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #include "trace-event.h"
31 #include "trace-event-perl.h"
37 const char *file = __FILE__;
40 newXS("Perf::Trace::Context::bootstrap", boot_Perf__Trace__Context,
42 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
47 #define FTRACE_MAX_EVENT \
48 ((1 << (sizeof(unsigned short) * 8)) - 1)
50 struct event *events[FTRACE_MAX_EVENT];
52 static struct scripting_context *scripting_context;
54 static char *cur_field_name;
55 static int zero_flag_atom;
57 static void define_symbolic_value(const char *ev_name,
58 const char *field_name,
59 const char *field_value,
60 const char *field_str)
62 unsigned long long value;
65 value = eval_flag(field_value);
71 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
72 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
73 XPUSHs(sv_2mortal(newSVuv(value)));
74 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
77 if (get_cv("main::define_symbolic_value", 0))
78 call_pv("main::define_symbolic_value", G_SCALAR);
85 static void define_symbolic_values(struct print_flag_sym *field,
87 const char *field_name)
89 define_symbolic_value(ev_name, field_name, field->value, field->str);
91 define_symbolic_values(field->next, ev_name, field_name);
94 static void define_symbolic_field(const char *ev_name,
95 const char *field_name)
103 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
104 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
107 if (get_cv("main::define_symbolic_field", 0))
108 call_pv("main::define_symbolic_field", G_SCALAR);
115 static void define_flag_value(const char *ev_name,
116 const char *field_name,
117 const char *field_value,
118 const char *field_str)
120 unsigned long long value;
123 value = eval_flag(field_value);
129 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
130 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
131 XPUSHs(sv_2mortal(newSVuv(value)));
132 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
135 if (get_cv("main::define_flag_value", 0))
136 call_pv("main::define_flag_value", G_SCALAR);
143 static void define_flag_values(struct print_flag_sym *field,
145 const char *field_name)
147 define_flag_value(ev_name, field_name, field->value, field->str);
149 define_flag_values(field->next, ev_name, field_name);
152 static void define_flag_field(const char *ev_name,
153 const char *field_name,
162 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
163 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
164 XPUSHs(sv_2mortal(newSVpv(delim, 0)));
167 if (get_cv("main::define_flag_field", 0))
168 call_pv("main::define_flag_field", G_SCALAR);
175 static void define_event_symbols(struct event *event,
177 struct print_arg *args)
179 switch (args->type) {
183 define_flag_value(ev_name, cur_field_name, "0",
189 free(cur_field_name);
190 cur_field_name = strdup(args->field.name);
193 define_event_symbols(event, ev_name, args->flags.field);
194 define_flag_field(ev_name, cur_field_name, args->flags.delim);
195 define_flag_values(args->flags.flags, ev_name, cur_field_name);
198 define_event_symbols(event, ev_name, args->symbol.field);
199 define_symbolic_field(ev_name, cur_field_name);
200 define_symbolic_values(args->symbol.symbols, ev_name,
206 define_event_symbols(event, ev_name, args->typecast.item);
209 if (strcmp(args->op.op, ":") == 0)
211 define_event_symbols(event, ev_name, args->op.left);
212 define_event_symbols(event, ev_name, args->op.right);
215 /* we should warn... */
220 define_event_symbols(event, ev_name, args->next);
223 static inline struct event *find_cache_event(int type)
225 static char ev_name[256];
231 events[type] = event = trace_find_event(type);
235 sprintf(ev_name, "%s::%s", event->system, event->name);
237 define_event_symbols(event, ev_name, event->print_fmt.args);
242 int common_pc(struct scripting_context *context)
246 pc = parse_common_pc(context->event_data);
251 int common_flags(struct scripting_context *context)
255 flags = parse_common_flags(context->event_data);
260 int common_lock_depth(struct scripting_context *context)
264 lock_depth = parse_common_lock_depth(context->event_data);
269 static void perl_process_event(int cpu, void *data,
270 int size __attribute((unused)),
271 unsigned long long nsecs, char *comm)
273 struct format_field *field;
274 static char handler[256];
275 unsigned long long val;
283 type = trace_parse_common_type(data);
285 event = find_cache_event(type);
287 die("ug! no event found for type %d", type);
289 pid = trace_parse_common_pid(data);
291 sprintf(handler, "%s::%s", event->system, event->name);
293 s = nsecs / NSECS_PER_SEC;
294 ns = nsecs - s * NSECS_PER_SEC;
296 scripting_context->event_data = data;
302 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
303 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
304 XPUSHs(sv_2mortal(newSVuv(cpu)));
305 XPUSHs(sv_2mortal(newSVuv(s)));
306 XPUSHs(sv_2mortal(newSVuv(ns)));
307 XPUSHs(sv_2mortal(newSViv(pid)));
308 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
310 /* common fields other than pid can be accessed via xsub fns */
312 for (field = event->format.fields; field; field = field->next) {
313 if (field->flags & FIELD_IS_STRING) {
315 if (field->flags & FIELD_IS_DYNAMIC) {
316 offset = *(int *)(data + field->offset);
319 offset = field->offset;
320 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0)));
321 } else { /* FIELD_IS_NUMERIC */
322 val = read_size(data + field->offset, field->size);
323 if (field->flags & FIELD_IS_SIGNED) {
324 XPUSHs(sv_2mortal(newSViv(val)));
326 XPUSHs(sv_2mortal(newSVuv(val)));
333 if (get_cv(handler, 0))
334 call_pv(handler, G_SCALAR);
335 else if (get_cv("main::trace_unhandled", 0)) {
336 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
337 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
338 XPUSHs(sv_2mortal(newSVuv(cpu)));
339 XPUSHs(sv_2mortal(newSVuv(nsecs)));
340 XPUSHs(sv_2mortal(newSViv(pid)));
341 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
342 call_pv("main::trace_unhandled", G_SCALAR);
350 static void run_start_sub(void)
352 dSP; /* access to Perl stack */
355 if (get_cv("main::trace_begin", 0))
356 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
362 static int perl_start_script(const char *script)
364 const char *command_line[2] = { "", NULL };
366 command_line[1] = script;
368 my_perl = perl_alloc();
369 perl_construct(my_perl);
371 if (perl_parse(my_perl, xs_init, 2, (char **)command_line,
381 fprintf(stderr, "perf trace started with Perl script %s\n\n", script);
389 static int perl_stop_script(void)
391 dSP; /* access to Perl stack */
394 if (get_cv("main::trace_end", 0))
395 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
397 perl_destruct(my_perl);
400 fprintf(stderr, "\nperf trace Perl script stopped\n");
405 static int perl_generate_script(const char *outfile)
407 struct event *event = NULL;
408 struct format_field *f;
409 char fname[PATH_MAX];
410 int not_first, count;
413 sprintf(fname, "%s.pl", outfile);
414 ofp = fopen(fname, "w");
416 fprintf(stderr, "couldn't open %s\n", fname);
420 fprintf(ofp, "# perf trace event handlers, "
421 "generated by perf trace -g perl\n");
423 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
424 " License version 2\n\n");
426 fprintf(ofp, "# The common_* event handler fields are the most useful "
427 "fields common to\n");
429 fprintf(ofp, "# all events. They don't necessarily correspond to "
430 "the 'common_*' fields\n");
432 fprintf(ofp, "# in the format files. Those fields not available as "
433 "handler params can\n");
435 fprintf(ofp, "# be retrieved using Perl functions of the form "
436 "common_*($context).\n");
438 fprintf(ofp, "# See Context.pm for the list of available "
441 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
442 "Perf-Trace-Util/lib\";\n");
444 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n");
445 fprintf(ofp, "use Perf::Trace::Core;\n");
446 fprintf(ofp, "use Perf::Trace::Context;\n");
447 fprintf(ofp, "use Perf::Trace::Util;\n\n");
449 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n");
450 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n\n");
452 while ((event = trace_find_next_event(event))) {
453 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
454 fprintf(ofp, "\tmy (");
456 fprintf(ofp, "$event_name, ");
457 fprintf(ofp, "$context, ");
458 fprintf(ofp, "$common_cpu, ");
459 fprintf(ofp, "$common_secs, ");
460 fprintf(ofp, "$common_nsecs,\n");
461 fprintf(ofp, "\t $common_pid, ");
462 fprintf(ofp, "$common_comm,\n\t ");
467 for (f = event->format.fields; f; f = f->next) {
470 if (++count % 5 == 0)
471 fprintf(ofp, "\n\t ");
473 fprintf(ofp, "$%s", f->name);
475 fprintf(ofp, ") = @_;\n\n");
477 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
478 "$common_secs, $common_nsecs,\n\t "
479 "$common_pid, $common_comm);\n\n");
481 fprintf(ofp, "\tprintf(\"");
486 for (f = event->format.fields; f; f = f->next) {
489 if (count && count % 4 == 0) {
490 fprintf(ofp, "\".\n\t \"");
494 fprintf(ofp, "%s=", f->name);
495 if (f->flags & FIELD_IS_STRING ||
496 f->flags & FIELD_IS_FLAG ||
497 f->flags & FIELD_IS_SYMBOLIC)
499 else if (f->flags & FIELD_IS_SIGNED)
505 fprintf(ofp, "\\n\",\n\t ");
510 for (f = event->format.fields; f; f = f->next) {
514 if (++count % 5 == 0)
515 fprintf(ofp, "\n\t ");
517 if (f->flags & FIELD_IS_FLAG) {
518 if ((count - 1) % 5 != 0) {
519 fprintf(ofp, "\n\t ");
522 fprintf(ofp, "flag_str(\"");
523 fprintf(ofp, "%s::%s\", ", event->system,
525 fprintf(ofp, "\"%s\", $%s)", f->name,
527 } else if (f->flags & FIELD_IS_SYMBOLIC) {
528 if ((count - 1) % 5 != 0) {
529 fprintf(ofp, "\n\t ");
532 fprintf(ofp, "symbol_str(\"");
533 fprintf(ofp, "%s::%s\", ", event->system,
535 fprintf(ofp, "\"%s\", $%s)", f->name,
538 fprintf(ofp, "$%s", f->name);
541 fprintf(ofp, ");\n");
542 fprintf(ofp, "}\n\n");
545 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
546 "$common_cpu, $common_secs, $common_nsecs,\n\t "
547 "$common_pid, $common_comm) = @_;\n\n");
549 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
550 "$common_secs, $common_nsecs,\n\t $common_pid, "
551 "$common_comm);\n}\n\n");
553 fprintf(ofp, "sub print_header\n{\n"
554 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
555 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
556 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}");
560 fprintf(stderr, "generated Perl script: %s\n", fname);
565 struct scripting_ops perl_scripting_ops = {
567 .start_script = perl_start_script,
568 .stop_script = perl_stop_script,
569 .process_event = perl_process_event,
570 .generate_script = perl_generate_script,
574 void setup_perl_scripting(void)
576 fprintf(stderr, "Perl scripting not supported."
577 " Install libperl and rebuild perf to enable it. e.g. "
578 "apt-get install libperl-dev (ubuntu), yum install "
579 "perl-ExtUtils-Embed (Fedora), etc.\n");
582 void setup_perl_scripting(void)
585 err = script_spec_register("Perl", &perl_scripting_ops);
587 die("error registering Perl script extension");
589 err = script_spec_register("pl", &perl_scripting_ops);
591 die("error registering pl script extension");
593 scripting_context = malloc(sizeof(struct scripting_context));