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
28 #include "../../perf.h"
30 #include "../trace-event.h"
35 void boot_Perf__Trace__Context(pTHX_ CV *cv);
36 void boot_DynaLoader(pTHX_ CV *cv);
37 typedef PerlInterpreter * INTERP;
43 const char *file = __FILE__;
46 newXS("Perf::Trace::Context::bootstrap", boot_Perf__Trace__Context,
48 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
53 #define FTRACE_MAX_EVENT \
54 ((1 << (sizeof(unsigned short) * 8)) - 1)
56 struct event *events[FTRACE_MAX_EVENT];
58 extern struct scripting_context *scripting_context;
60 static char *cur_field_name;
61 static int zero_flag_atom;
63 static void define_symbolic_value(const char *ev_name,
64 const char *field_name,
65 const char *field_value,
66 const char *field_str)
68 unsigned long long value;
71 value = eval_flag(field_value);
77 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
78 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
79 XPUSHs(sv_2mortal(newSVuv(value)));
80 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
83 if (get_cv("main::define_symbolic_value", 0))
84 call_pv("main::define_symbolic_value", G_SCALAR);
91 static void define_symbolic_values(struct print_flag_sym *field,
93 const char *field_name)
95 define_symbolic_value(ev_name, field_name, field->value, field->str);
97 define_symbolic_values(field->next, ev_name, field_name);
100 static void define_symbolic_field(const char *ev_name,
101 const char *field_name)
109 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
110 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
113 if (get_cv("main::define_symbolic_field", 0))
114 call_pv("main::define_symbolic_field", G_SCALAR);
121 static void define_flag_value(const char *ev_name,
122 const char *field_name,
123 const char *field_value,
124 const char *field_str)
126 unsigned long long value;
129 value = eval_flag(field_value);
135 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
136 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
137 XPUSHs(sv_2mortal(newSVuv(value)));
138 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
141 if (get_cv("main::define_flag_value", 0))
142 call_pv("main::define_flag_value", G_SCALAR);
149 static void define_flag_values(struct print_flag_sym *field,
151 const char *field_name)
153 define_flag_value(ev_name, field_name, field->value, field->str);
155 define_flag_values(field->next, ev_name, field_name);
158 static void define_flag_field(const char *ev_name,
159 const char *field_name,
168 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
169 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
170 XPUSHs(sv_2mortal(newSVpv(delim, 0)));
173 if (get_cv("main::define_flag_field", 0))
174 call_pv("main::define_flag_field", G_SCALAR);
181 static void define_event_symbols(struct event *event,
183 struct print_arg *args)
185 switch (args->type) {
189 define_flag_value(ev_name, cur_field_name, "0",
195 free(cur_field_name);
196 cur_field_name = strdup(args->field.name);
199 define_event_symbols(event, ev_name, args->flags.field);
200 define_flag_field(ev_name, cur_field_name, args->flags.delim);
201 define_flag_values(args->flags.flags, ev_name, cur_field_name);
204 define_event_symbols(event, ev_name, args->symbol.field);
205 define_symbolic_field(ev_name, cur_field_name);
206 define_symbolic_values(args->symbol.symbols, ev_name,
212 define_event_symbols(event, ev_name, args->typecast.item);
215 if (strcmp(args->op.op, ":") == 0)
217 define_event_symbols(event, ev_name, args->op.left);
218 define_event_symbols(event, ev_name, args->op.right);
221 /* we should warn... */
226 define_event_symbols(event, ev_name, args->next);
229 static inline struct event *find_cache_event(int type)
231 static char ev_name[256];
237 events[type] = event = trace_find_event(type);
241 sprintf(ev_name, "%s::%s", event->system, event->name);
243 define_event_symbols(event, ev_name, event->print_fmt.args);
248 static void perl_process_event(int cpu, void *data,
250 unsigned long long nsecs, char *comm)
252 struct format_field *field;
253 static char handler[256];
254 unsigned long long val;
262 type = trace_parse_common_type(data);
264 event = find_cache_event(type);
266 die("ug! no event found for type %d", type);
268 pid = trace_parse_common_pid(data);
270 sprintf(handler, "%s::%s", event->system, event->name);
272 s = nsecs / NSECS_PER_SEC;
273 ns = nsecs - s * NSECS_PER_SEC;
275 scripting_context->event_data = data;
281 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
282 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
283 XPUSHs(sv_2mortal(newSVuv(cpu)));
284 XPUSHs(sv_2mortal(newSVuv(s)));
285 XPUSHs(sv_2mortal(newSVuv(ns)));
286 XPUSHs(sv_2mortal(newSViv(pid)));
287 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
289 /* common fields other than pid can be accessed via xsub fns */
291 for (field = event->format.fields; field; field = field->next) {
292 if (field->flags & FIELD_IS_STRING) {
294 if (field->flags & FIELD_IS_DYNAMIC) {
295 offset = *(int *)(data + field->offset);
298 offset = field->offset;
299 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0)));
300 } else { /* FIELD_IS_NUMERIC */
301 val = read_size(data + field->offset, field->size);
302 if (field->flags & FIELD_IS_SIGNED) {
303 XPUSHs(sv_2mortal(newSViv(val)));
305 XPUSHs(sv_2mortal(newSVuv(val)));
312 if (get_cv(handler, 0))
313 call_pv(handler, G_SCALAR);
314 else if (get_cv("main::trace_unhandled", 0)) {
315 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
316 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
317 XPUSHs(sv_2mortal(newSVuv(cpu)));
318 XPUSHs(sv_2mortal(newSVuv(nsecs)));
319 XPUSHs(sv_2mortal(newSViv(pid)));
320 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
321 call_pv("main::trace_unhandled", G_SCALAR);
329 static void run_start_sub(void)
331 dSP; /* access to Perl stack */
334 if (get_cv("main::trace_begin", 0))
335 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
341 static int perl_start_script(const char *script, int argc, const char **argv)
343 const char **command_line;
346 command_line = malloc((argc + 2) * sizeof(const char *));
347 command_line[0] = "";
348 command_line[1] = script;
349 for (i = 2; i < argc + 2; i++)
350 command_line[i] = argv[i - 2];
352 my_perl = perl_alloc();
353 perl_construct(my_perl);
355 if (perl_parse(my_perl, xs_init, argc + 2, (char **)command_line,
361 if (perl_run(my_perl)) {
385 static int perl_stop_script(void)
387 dSP; /* access to Perl stack */
390 if (get_cv("main::trace_end", 0))
391 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
393 perl_destruct(my_perl);
399 static int perl_generate_script(const char *outfile)
401 struct event *event = NULL;
402 struct format_field *f;
403 char fname[PATH_MAX];
404 int not_first, count;
407 sprintf(fname, "%s.pl", outfile);
408 ofp = fopen(fname, "w");
410 fprintf(stderr, "couldn't open %s\n", fname);
414 fprintf(ofp, "# perf trace event handlers, "
415 "generated by perf trace -g perl\n");
417 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
418 " License version 2\n\n");
420 fprintf(ofp, "# The common_* event handler fields are the most useful "
421 "fields common to\n");
423 fprintf(ofp, "# all events. They don't necessarily correspond to "
424 "the 'common_*' fields\n");
426 fprintf(ofp, "# in the format files. Those fields not available as "
427 "handler params can\n");
429 fprintf(ofp, "# be retrieved using Perl functions of the form "
430 "common_*($context).\n");
432 fprintf(ofp, "# See Context.pm for the list of available "
435 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
436 "Perf-Trace-Util/lib\";\n");
438 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n");
439 fprintf(ofp, "use Perf::Trace::Core;\n");
440 fprintf(ofp, "use Perf::Trace::Context;\n");
441 fprintf(ofp, "use Perf::Trace::Util;\n\n");
443 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n");
444 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n\n");
446 while ((event = trace_find_next_event(event))) {
447 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
448 fprintf(ofp, "\tmy (");
450 fprintf(ofp, "$event_name, ");
451 fprintf(ofp, "$context, ");
452 fprintf(ofp, "$common_cpu, ");
453 fprintf(ofp, "$common_secs, ");
454 fprintf(ofp, "$common_nsecs,\n");
455 fprintf(ofp, "\t $common_pid, ");
456 fprintf(ofp, "$common_comm,\n\t ");
461 for (f = event->format.fields; f; f = f->next) {
464 if (++count % 5 == 0)
465 fprintf(ofp, "\n\t ");
467 fprintf(ofp, "$%s", f->name);
469 fprintf(ofp, ") = @_;\n\n");
471 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
472 "$common_secs, $common_nsecs,\n\t "
473 "$common_pid, $common_comm);\n\n");
475 fprintf(ofp, "\tprintf(\"");
480 for (f = event->format.fields; f; f = f->next) {
483 if (count && count % 4 == 0) {
484 fprintf(ofp, "\".\n\t \"");
488 fprintf(ofp, "%s=", f->name);
489 if (f->flags & FIELD_IS_STRING ||
490 f->flags & FIELD_IS_FLAG ||
491 f->flags & FIELD_IS_SYMBOLIC)
493 else if (f->flags & FIELD_IS_SIGNED)
499 fprintf(ofp, "\\n\",\n\t ");
504 for (f = event->format.fields; f; f = f->next) {
508 if (++count % 5 == 0)
509 fprintf(ofp, "\n\t ");
511 if (f->flags & FIELD_IS_FLAG) {
512 if ((count - 1) % 5 != 0) {
513 fprintf(ofp, "\n\t ");
516 fprintf(ofp, "flag_str(\"");
517 fprintf(ofp, "%s::%s\", ", event->system,
519 fprintf(ofp, "\"%s\", $%s)", f->name,
521 } else if (f->flags & FIELD_IS_SYMBOLIC) {
522 if ((count - 1) % 5 != 0) {
523 fprintf(ofp, "\n\t ");
526 fprintf(ofp, "symbol_str(\"");
527 fprintf(ofp, "%s::%s\", ", event->system,
529 fprintf(ofp, "\"%s\", $%s)", f->name,
532 fprintf(ofp, "$%s", f->name);
535 fprintf(ofp, ");\n");
536 fprintf(ofp, "}\n\n");
539 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
540 "$common_cpu, $common_secs, $common_nsecs,\n\t "
541 "$common_pid, $common_comm) = @_;\n\n");
543 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
544 "$common_secs, $common_nsecs,\n\t $common_pid, "
545 "$common_comm);\n}\n\n");
547 fprintf(ofp, "sub print_header\n{\n"
548 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
549 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
550 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}");
554 fprintf(stderr, "generated Perl script: %s\n", fname);
559 struct scripting_ops perl_scripting_ops = {
561 .start_script = perl_start_script,
562 .stop_script = perl_stop_script,
563 .process_event = perl_process_event,
564 .generate_script = perl_generate_script,