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"
35 void boot_Perf__Trace__Context(pTHX_ CV *cv);
36 void boot_DynaLoader(pTHX_ CV *cv);
40 const char *file = __FILE__;
43 newXS("Perf::Trace::Context::bootstrap", boot_Perf__Trace__Context,
45 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
50 #define FTRACE_MAX_EVENT \
51 ((1 << (sizeof(unsigned short) * 8)) - 1)
53 struct event *events[FTRACE_MAX_EVENT];
55 static struct scripting_context *scripting_context;
57 static char *cur_field_name;
58 static int zero_flag_atom;
60 static void define_symbolic_value(const char *ev_name,
61 const char *field_name,
62 const char *field_value,
63 const char *field_str)
65 unsigned long long value;
68 value = eval_flag(field_value);
74 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
75 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
76 XPUSHs(sv_2mortal(newSVuv(value)));
77 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
80 if (get_cv("main::define_symbolic_value", 0))
81 call_pv("main::define_symbolic_value", G_SCALAR);
88 static void define_symbolic_values(struct print_flag_sym *field,
90 const char *field_name)
92 define_symbolic_value(ev_name, field_name, field->value, field->str);
94 define_symbolic_values(field->next, ev_name, field_name);
97 static void define_symbolic_field(const char *ev_name,
98 const char *field_name)
106 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
107 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
110 if (get_cv("main::define_symbolic_field", 0))
111 call_pv("main::define_symbolic_field", G_SCALAR);
118 static void define_flag_value(const char *ev_name,
119 const char *field_name,
120 const char *field_value,
121 const char *field_str)
123 unsigned long long value;
126 value = eval_flag(field_value);
132 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
133 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
134 XPUSHs(sv_2mortal(newSVuv(value)));
135 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
138 if (get_cv("main::define_flag_value", 0))
139 call_pv("main::define_flag_value", G_SCALAR);
146 static void define_flag_values(struct print_flag_sym *field,
148 const char *field_name)
150 define_flag_value(ev_name, field_name, field->value, field->str);
152 define_flag_values(field->next, ev_name, field_name);
155 static void define_flag_field(const char *ev_name,
156 const char *field_name,
165 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
166 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
167 XPUSHs(sv_2mortal(newSVpv(delim, 0)));
170 if (get_cv("main::define_flag_field", 0))
171 call_pv("main::define_flag_field", G_SCALAR);
178 static void define_event_symbols(struct event *event,
180 struct print_arg *args)
182 switch (args->type) {
186 define_flag_value(ev_name, cur_field_name, "0",
192 free(cur_field_name);
193 cur_field_name = strdup(args->field.name);
196 define_event_symbols(event, ev_name, args->flags.field);
197 define_flag_field(ev_name, cur_field_name, args->flags.delim);
198 define_flag_values(args->flags.flags, ev_name, cur_field_name);
201 define_event_symbols(event, ev_name, args->symbol.field);
202 define_symbolic_field(ev_name, cur_field_name);
203 define_symbolic_values(args->symbol.symbols, ev_name,
209 define_event_symbols(event, ev_name, args->typecast.item);
212 if (strcmp(args->op.op, ":") == 0)
214 define_event_symbols(event, ev_name, args->op.left);
215 define_event_symbols(event, ev_name, args->op.right);
218 /* we should warn... */
223 define_event_symbols(event, ev_name, args->next);
226 static inline struct event *find_cache_event(int type)
228 static char ev_name[256];
234 events[type] = event = trace_find_event(type);
238 sprintf(ev_name, "%s::%s", event->system, event->name);
240 define_event_symbols(event, ev_name, event->print_fmt.args);
245 int common_pc(struct scripting_context *context)
249 pc = parse_common_pc(context->event_data);
254 int common_flags(struct scripting_context *context)
258 flags = parse_common_flags(context->event_data);
263 int common_lock_depth(struct scripting_context *context)
267 lock_depth = parse_common_lock_depth(context->event_data);
272 static void perl_process_event(int cpu, void *data,
273 int size __attribute((unused)),
274 unsigned long long nsecs, char *comm)
276 struct format_field *field;
277 static char handler[256];
278 unsigned long long val;
286 type = trace_parse_common_type(data);
288 event = find_cache_event(type);
290 die("ug! no event found for type %d", type);
292 pid = trace_parse_common_pid(data);
294 sprintf(handler, "%s::%s", event->system, event->name);
296 s = nsecs / NSECS_PER_SEC;
297 ns = nsecs - s * NSECS_PER_SEC;
299 scripting_context->event_data = data;
305 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
306 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
307 XPUSHs(sv_2mortal(newSVuv(cpu)));
308 XPUSHs(sv_2mortal(newSVuv(s)));
309 XPUSHs(sv_2mortal(newSVuv(ns)));
310 XPUSHs(sv_2mortal(newSViv(pid)));
311 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
313 /* common fields other than pid can be accessed via xsub fns */
315 for (field = event->format.fields; field; field = field->next) {
316 if (field->flags & FIELD_IS_STRING) {
318 if (field->flags & FIELD_IS_DYNAMIC) {
319 offset = *(int *)(data + field->offset);
322 offset = field->offset;
323 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0)));
324 } else { /* FIELD_IS_NUMERIC */
325 val = read_size(data + field->offset, field->size);
326 if (field->flags & FIELD_IS_SIGNED) {
327 XPUSHs(sv_2mortal(newSViv(val)));
329 XPUSHs(sv_2mortal(newSVuv(val)));
336 if (get_cv(handler, 0))
337 call_pv(handler, G_SCALAR);
338 else if (get_cv("main::trace_unhandled", 0)) {
339 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
340 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
341 XPUSHs(sv_2mortal(newSVuv(cpu)));
342 XPUSHs(sv_2mortal(newSVuv(nsecs)));
343 XPUSHs(sv_2mortal(newSViv(pid)));
344 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
345 call_pv("main::trace_unhandled", G_SCALAR);
353 static void run_start_sub(void)
355 dSP; /* access to Perl stack */
358 if (get_cv("main::trace_begin", 0))
359 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
365 static int perl_start_script(const char *script)
367 const char *command_line[2] = { "", NULL };
369 command_line[1] = script;
371 my_perl = perl_alloc();
372 perl_construct(my_perl);
374 if (perl_parse(my_perl, xs_init, 2, (char **)command_line,
384 fprintf(stderr, "perf trace started with Perl script %s\n\n", script);
392 static int perl_stop_script(void)
394 dSP; /* access to Perl stack */
397 if (get_cv("main::trace_end", 0))
398 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
400 perl_destruct(my_perl);
403 fprintf(stderr, "\nperf trace Perl script stopped\n");
408 static int perl_generate_script(const char *outfile)
410 struct event *event = NULL;
411 struct format_field *f;
412 char fname[PATH_MAX];
413 int not_first, count;
416 sprintf(fname, "%s.pl", outfile);
417 ofp = fopen(fname, "w");
419 fprintf(stderr, "couldn't open %s\n", fname);
423 fprintf(ofp, "# perf trace event handlers, "
424 "generated by perf trace -g perl\n");
426 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
427 " License version 2\n\n");
429 fprintf(ofp, "# The common_* event handler fields are the most useful "
430 "fields common to\n");
432 fprintf(ofp, "# all events. They don't necessarily correspond to "
433 "the 'common_*' fields\n");
435 fprintf(ofp, "# in the format files. Those fields not available as "
436 "handler params can\n");
438 fprintf(ofp, "# be retrieved using Perl functions of the form "
439 "common_*($context).\n");
441 fprintf(ofp, "# See Context.pm for the list of available "
444 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
445 "Perf-Trace-Util/lib\";\n");
447 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n");
448 fprintf(ofp, "use Perf::Trace::Core;\n");
449 fprintf(ofp, "use Perf::Trace::Context;\n");
450 fprintf(ofp, "use Perf::Trace::Util;\n\n");
452 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n");
453 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n\n");
455 while ((event = trace_find_next_event(event))) {
456 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
457 fprintf(ofp, "\tmy (");
459 fprintf(ofp, "$event_name, ");
460 fprintf(ofp, "$context, ");
461 fprintf(ofp, "$common_cpu, ");
462 fprintf(ofp, "$common_secs, ");
463 fprintf(ofp, "$common_nsecs,\n");
464 fprintf(ofp, "\t $common_pid, ");
465 fprintf(ofp, "$common_comm,\n\t ");
470 for (f = event->format.fields; f; f = f->next) {
473 if (++count % 5 == 0)
474 fprintf(ofp, "\n\t ");
476 fprintf(ofp, "$%s", f->name);
478 fprintf(ofp, ") = @_;\n\n");
480 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
481 "$common_secs, $common_nsecs,\n\t "
482 "$common_pid, $common_comm);\n\n");
484 fprintf(ofp, "\tprintf(\"");
489 for (f = event->format.fields; f; f = f->next) {
492 if (count && count % 4 == 0) {
493 fprintf(ofp, "\".\n\t \"");
497 fprintf(ofp, "%s=", f->name);
498 if (f->flags & FIELD_IS_STRING ||
499 f->flags & FIELD_IS_FLAG ||
500 f->flags & FIELD_IS_SYMBOLIC)
502 else if (f->flags & FIELD_IS_SIGNED)
508 fprintf(ofp, "\\n\",\n\t ");
513 for (f = event->format.fields; f; f = f->next) {
517 if (++count % 5 == 0)
518 fprintf(ofp, "\n\t ");
520 if (f->flags & FIELD_IS_FLAG) {
521 if ((count - 1) % 5 != 0) {
522 fprintf(ofp, "\n\t ");
525 fprintf(ofp, "flag_str(\"");
526 fprintf(ofp, "%s::%s\", ", event->system,
528 fprintf(ofp, "\"%s\", $%s)", f->name,
530 } else if (f->flags & FIELD_IS_SYMBOLIC) {
531 if ((count - 1) % 5 != 0) {
532 fprintf(ofp, "\n\t ");
535 fprintf(ofp, "symbol_str(\"");
536 fprintf(ofp, "%s::%s\", ", event->system,
538 fprintf(ofp, "\"%s\", $%s)", f->name,
541 fprintf(ofp, "$%s", f->name);
544 fprintf(ofp, ");\n");
545 fprintf(ofp, "}\n\n");
548 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
549 "$common_cpu, $common_secs, $common_nsecs,\n\t "
550 "$common_pid, $common_comm) = @_;\n\n");
552 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
553 "$common_secs, $common_nsecs,\n\t $common_pid, "
554 "$common_comm);\n}\n\n");
556 fprintf(ofp, "sub print_header\n{\n"
557 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
558 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
559 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}");
563 fprintf(stderr, "generated Perl script: %s\n", fname);
568 struct scripting_ops perl_scripting_ops = {
570 .start_script = perl_start_script,
571 .stop_script = perl_stop_script,
572 .process_event = perl_process_event,
573 .generate_script = perl_generate_script,
577 void setup_perl_scripting(void)
579 fprintf(stderr, "Perl scripting not supported."
580 " Install libperl and rebuild perf to enable it. e.g. "
581 "apt-get install libperl-dev (ubuntu), yum install "
582 "perl-ExtUtils-Embed (Fedora), etc.\n");
585 void setup_perl_scripting(void)
588 err = script_spec_register("Perl", &perl_scripting_ops);
590 die("error registering Perl script extension");
592 err = script_spec_register("pl", &perl_scripting_ops);
594 die("error registering pl script extension");
596 scripting_context = malloc(sizeof(struct scripting_context));