2 * trace-event-perl. Feed perf script 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
27 #include <linux/bitmap.h>
33 #include "../../perf.h"
34 #include "../thread.h"
36 #include "../trace-event.h"
40 void boot_Perf__Trace__Context(pTHX_ CV *cv);
41 void boot_DynaLoader(pTHX_ CV *cv);
42 typedef PerlInterpreter * INTERP;
48 const char *file = __FILE__;
51 newXS("Perf::Trace::Context::bootstrap", boot_Perf__Trace__Context,
53 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
58 #define TRACE_EVENT_TYPE_MAX \
59 ((1 << (sizeof(unsigned short) * 8)) - 1)
61 static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
63 extern struct scripting_context *scripting_context;
65 static char *cur_field_name;
66 static int zero_flag_atom;
68 static void define_symbolic_value(const char *ev_name,
69 const char *field_name,
70 const char *field_value,
71 const char *field_str)
73 unsigned long long value;
76 value = eval_flag(field_value);
82 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
83 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
84 XPUSHs(sv_2mortal(newSVuv(value)));
85 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
88 if (get_cv("main::define_symbolic_value", 0))
89 call_pv("main::define_symbolic_value", G_SCALAR);
96 static void define_symbolic_values(struct print_flag_sym *field,
98 const char *field_name)
100 define_symbolic_value(ev_name, field_name, field->value, field->str);
102 define_symbolic_values(field->next, ev_name, field_name);
105 static void define_symbolic_field(const char *ev_name,
106 const char *field_name)
114 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
115 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
118 if (get_cv("main::define_symbolic_field", 0))
119 call_pv("main::define_symbolic_field", G_SCALAR);
126 static void define_flag_value(const char *ev_name,
127 const char *field_name,
128 const char *field_value,
129 const char *field_str)
131 unsigned long long value;
134 value = eval_flag(field_value);
140 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
141 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
142 XPUSHs(sv_2mortal(newSVuv(value)));
143 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
146 if (get_cv("main::define_flag_value", 0))
147 call_pv("main::define_flag_value", G_SCALAR);
154 static void define_flag_values(struct print_flag_sym *field,
156 const char *field_name)
158 define_flag_value(ev_name, field_name, field->value, field->str);
160 define_flag_values(field->next, ev_name, field_name);
163 static void define_flag_field(const char *ev_name,
164 const char *field_name,
173 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
174 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
175 XPUSHs(sv_2mortal(newSVpv(delim, 0)));
178 if (get_cv("main::define_flag_field", 0))
179 call_pv("main::define_flag_field", G_SCALAR);
186 static void define_event_symbols(struct event_format *event,
188 struct print_arg *args)
193 switch (args->type) {
197 define_flag_value(ev_name, cur_field_name, "0",
202 free(cur_field_name);
203 cur_field_name = strdup(args->field.name);
206 define_event_symbols(event, ev_name, args->flags.field);
207 define_flag_field(ev_name, cur_field_name, args->flags.delim);
208 define_flag_values(args->flags.flags, ev_name, cur_field_name);
211 define_event_symbols(event, ev_name, args->symbol.field);
212 define_symbolic_field(ev_name, cur_field_name);
213 define_symbolic_values(args->symbol.symbols, ev_name,
217 define_event_symbols(event, ev_name, args->hex.field);
218 define_event_symbols(event, ev_name, args->hex.size);
220 case PRINT_INT_ARRAY:
221 define_event_symbols(event, ev_name, args->int_array.field);
222 define_event_symbols(event, ev_name, args->int_array.count);
223 define_event_symbols(event, ev_name, args->int_array.el_size);
226 case PRINT_DYNAMIC_ARRAY:
227 case PRINT_DYNAMIC_ARRAY_LEN:
232 define_event_symbols(event, ev_name, args->typecast.item);
235 if (strcmp(args->op.op, ":") == 0)
237 define_event_symbols(event, ev_name, args->op.left);
238 define_event_symbols(event, ev_name, args->op.right);
242 pr_err("Unsupported print arg type\n");
243 /* we should warn... */
248 define_event_symbols(event, ev_name, args->next);
251 static void perl_process_tracepoint(struct perf_sample *sample,
252 struct perf_evsel *evsel,
253 struct thread *thread)
255 struct event_format *event = evsel->tp_format;
256 struct format_field *field;
257 static char handler[256];
258 unsigned long long val;
261 int cpu = sample->cpu;
262 void *data = sample->raw_data;
263 unsigned long long nsecs = sample->time;
264 const char *comm = thread__comm_str(thread);
268 if (evsel->attr.type != PERF_TYPE_TRACEPOINT)
272 die("ug! no event found for type %" PRIu64, (u64)evsel->attr.config);
274 pid = raw_field_value(event, "common_pid", data);
276 sprintf(handler, "%s::%s", event->system, event->name);
278 if (!test_and_set_bit(event->id, events_defined))
279 define_event_symbols(event, handler, event->print_fmt.args);
281 s = nsecs / NSECS_PER_SEC;
282 ns = nsecs - s * NSECS_PER_SEC;
284 scripting_context->event_data = data;
285 scripting_context->pevent = evsel->tp_format->pevent;
291 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
292 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
293 XPUSHs(sv_2mortal(newSVuv(cpu)));
294 XPUSHs(sv_2mortal(newSVuv(s)));
295 XPUSHs(sv_2mortal(newSVuv(ns)));
296 XPUSHs(sv_2mortal(newSViv(pid)));
297 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
299 /* common fields other than pid can be accessed via xsub fns */
301 for (field = event->format.fields; field; field = field->next) {
302 if (field->flags & FIELD_IS_STRING) {
304 if (field->flags & FIELD_IS_DYNAMIC) {
305 offset = *(int *)(data + field->offset);
308 offset = field->offset;
309 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0)));
310 } else { /* FIELD_IS_NUMERIC */
311 val = read_size(event, data + field->offset,
313 if (field->flags & FIELD_IS_SIGNED) {
314 XPUSHs(sv_2mortal(newSViv(val)));
316 XPUSHs(sv_2mortal(newSVuv(val)));
323 if (get_cv(handler, 0))
324 call_pv(handler, G_SCALAR);
325 else if (get_cv("main::trace_unhandled", 0)) {
326 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
327 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
328 XPUSHs(sv_2mortal(newSVuv(cpu)));
329 XPUSHs(sv_2mortal(newSVuv(nsecs)));
330 XPUSHs(sv_2mortal(newSViv(pid)));
331 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
332 call_pv("main::trace_unhandled", G_SCALAR);
340 static void perl_process_event_generic(union perf_event *event,
341 struct perf_sample *sample,
342 struct perf_evsel *evsel)
346 if (!get_cv("process_event", 0))
352 XPUSHs(sv_2mortal(newSVpvn((const char *)event, event->header.size)));
353 XPUSHs(sv_2mortal(newSVpvn((const char *)&evsel->attr, sizeof(evsel->attr))));
354 XPUSHs(sv_2mortal(newSVpvn((const char *)sample, sizeof(*sample))));
355 XPUSHs(sv_2mortal(newSVpvn((const char *)sample->raw_data, sample->raw_size)));
357 call_pv("process_event", G_SCALAR);
364 static void perl_process_event(union perf_event *event,
365 struct perf_sample *sample,
366 struct perf_evsel *evsel,
367 struct addr_location *al)
369 perl_process_tracepoint(sample, evsel, al->thread);
370 perl_process_event_generic(event, sample, evsel);
373 static void run_start_sub(void)
375 dSP; /* access to Perl stack */
378 if (get_cv("main::trace_begin", 0))
379 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
385 static int perl_start_script(const char *script, int argc, const char **argv)
387 const char **command_line;
390 command_line = malloc((argc + 2) * sizeof(const char *));
391 command_line[0] = "";
392 command_line[1] = script;
393 for (i = 2; i < argc + 2; i++)
394 command_line[i] = argv[i - 2];
396 my_perl = perl_alloc();
397 perl_construct(my_perl);
399 if (perl_parse(my_perl, xs_init, argc + 2, (char **)command_line,
405 if (perl_run(my_perl)) {
426 static int perl_flush_script(void)
434 static int perl_stop_script(void)
436 dSP; /* access to Perl stack */
439 if (get_cv("main::trace_end", 0))
440 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
442 perl_destruct(my_perl);
448 static int perl_generate_script(struct pevent *pevent, const char *outfile)
450 struct event_format *event = NULL;
451 struct format_field *f;
452 char fname[PATH_MAX];
453 int not_first, count;
456 sprintf(fname, "%s.pl", outfile);
457 ofp = fopen(fname, "w");
459 fprintf(stderr, "couldn't open %s\n", fname);
463 fprintf(ofp, "# perf script event handlers, "
464 "generated by perf script -g perl\n");
466 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
467 " License version 2\n\n");
469 fprintf(ofp, "# The common_* event handler fields are the most useful "
470 "fields common to\n");
472 fprintf(ofp, "# all events. They don't necessarily correspond to "
473 "the 'common_*' fields\n");
475 fprintf(ofp, "# in the format files. Those fields not available as "
476 "handler params can\n");
478 fprintf(ofp, "# be retrieved using Perl functions of the form "
479 "common_*($context).\n");
481 fprintf(ofp, "# See Context.pm for the list of available "
484 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
485 "Perf-Trace-Util/lib\";\n");
487 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n");
488 fprintf(ofp, "use Perf::Trace::Core;\n");
489 fprintf(ofp, "use Perf::Trace::Context;\n");
490 fprintf(ofp, "use Perf::Trace::Util;\n\n");
492 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n");
493 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n\n");
495 while ((event = trace_find_next_event(pevent, event))) {
496 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
497 fprintf(ofp, "\tmy (");
499 fprintf(ofp, "$event_name, ");
500 fprintf(ofp, "$context, ");
501 fprintf(ofp, "$common_cpu, ");
502 fprintf(ofp, "$common_secs, ");
503 fprintf(ofp, "$common_nsecs,\n");
504 fprintf(ofp, "\t $common_pid, ");
505 fprintf(ofp, "$common_comm,\n\t ");
510 for (f = event->format.fields; f; f = f->next) {
513 if (++count % 5 == 0)
514 fprintf(ofp, "\n\t ");
516 fprintf(ofp, "$%s", f->name);
518 fprintf(ofp, ") = @_;\n\n");
520 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
521 "$common_secs, $common_nsecs,\n\t "
522 "$common_pid, $common_comm);\n\n");
524 fprintf(ofp, "\tprintf(\"");
529 for (f = event->format.fields; f; f = f->next) {
532 if (count && count % 4 == 0) {
533 fprintf(ofp, "\".\n\t \"");
537 fprintf(ofp, "%s=", f->name);
538 if (f->flags & FIELD_IS_STRING ||
539 f->flags & FIELD_IS_FLAG ||
540 f->flags & FIELD_IS_SYMBOLIC)
542 else if (f->flags & FIELD_IS_SIGNED)
548 fprintf(ofp, "\\n\",\n\t ");
553 for (f = event->format.fields; f; f = f->next) {
557 if (++count % 5 == 0)
558 fprintf(ofp, "\n\t ");
560 if (f->flags & FIELD_IS_FLAG) {
561 if ((count - 1) % 5 != 0) {
562 fprintf(ofp, "\n\t ");
565 fprintf(ofp, "flag_str(\"");
566 fprintf(ofp, "%s::%s\", ", event->system,
568 fprintf(ofp, "\"%s\", $%s)", f->name,
570 } else if (f->flags & FIELD_IS_SYMBOLIC) {
571 if ((count - 1) % 5 != 0) {
572 fprintf(ofp, "\n\t ");
575 fprintf(ofp, "symbol_str(\"");
576 fprintf(ofp, "%s::%s\", ", event->system,
578 fprintf(ofp, "\"%s\", $%s)", f->name,
581 fprintf(ofp, "$%s", f->name);
584 fprintf(ofp, ");\n");
585 fprintf(ofp, "}\n\n");
588 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
589 "$common_cpu, $common_secs, $common_nsecs,\n\t "
590 "$common_pid, $common_comm) = @_;\n\n");
592 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
593 "$common_secs, $common_nsecs,\n\t $common_pid, "
594 "$common_comm);\n}\n\n");
596 fprintf(ofp, "sub print_header\n{\n"
597 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
598 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
599 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}\n");
602 "\n# Packed byte string args of process_event():\n"
604 "# $event:\tunion perf_event\tutil/event.h\n"
605 "# $attr:\tstruct perf_event_attr\tlinux/perf_event.h\n"
606 "# $sample:\tstruct perf_sample\tutil/event.h\n"
607 "# $raw_data:\tperf_sample->raw_data\tutil/event.h\n"
609 "sub process_event\n"
611 "\tmy ($event, $attr, $sample, $raw_data) = @_;\n"
613 "\tmy @event\t= unpack(\"LSS\", $event);\n"
614 "\tmy @attr\t= unpack(\"LLQQQQQLLQQ\", $attr);\n"
615 "\tmy @sample\t= unpack(\"QLLQQQQQLL\", $sample);\n"
616 "\tmy @raw_data\t= unpack(\"C*\", $raw_data);\n"
618 "\tuse Data::Dumper;\n"
619 "\tprint Dumper \\@event, \\@attr, \\@sample, \\@raw_data;\n"
624 fprintf(stderr, "generated Perl script: %s\n", fname);
629 struct scripting_ops perl_scripting_ops = {
631 .start_script = perl_start_script,
632 .flush_script = perl_flush_script,
633 .stop_script = perl_stop_script,
634 .process_event = perl_process_event,
635 .generate_script = perl_generate_script,