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>
28 #include <linux/time64.h>
34 #include "../../perf.h"
35 #include "../callchain.h"
36 #include "../machine.h"
37 #include "../thread.h"
39 #include "../trace-event.h"
43 void boot_Perf__Trace__Context(pTHX_ CV *cv);
44 void boot_DynaLoader(pTHX_ CV *cv);
45 typedef PerlInterpreter * INTERP;
51 const char *file = __FILE__;
54 newXS("Perf::Trace::Context::bootstrap", boot_Perf__Trace__Context,
56 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
61 #define TRACE_EVENT_TYPE_MAX \
62 ((1 << (sizeof(unsigned short) * 8)) - 1)
64 static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
66 extern struct scripting_context *scripting_context;
68 static char *cur_field_name;
69 static int zero_flag_atom;
71 static void define_symbolic_value(const char *ev_name,
72 const char *field_name,
73 const char *field_value,
74 const char *field_str)
76 unsigned long long value;
79 value = eval_flag(field_value);
85 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
86 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
87 XPUSHs(sv_2mortal(newSVuv(value)));
88 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
91 if (get_cv("main::define_symbolic_value", 0))
92 call_pv("main::define_symbolic_value", G_SCALAR);
99 static void define_symbolic_values(struct print_flag_sym *field,
101 const char *field_name)
103 define_symbolic_value(ev_name, field_name, field->value, field->str);
105 define_symbolic_values(field->next, ev_name, field_name);
108 static void define_symbolic_field(const char *ev_name,
109 const char *field_name)
117 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
118 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
121 if (get_cv("main::define_symbolic_field", 0))
122 call_pv("main::define_symbolic_field", G_SCALAR);
129 static void define_flag_value(const char *ev_name,
130 const char *field_name,
131 const char *field_value,
132 const char *field_str)
134 unsigned long long value;
137 value = eval_flag(field_value);
143 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
144 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
145 XPUSHs(sv_2mortal(newSVuv(value)));
146 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
149 if (get_cv("main::define_flag_value", 0))
150 call_pv("main::define_flag_value", G_SCALAR);
157 static void define_flag_values(struct print_flag_sym *field,
159 const char *field_name)
161 define_flag_value(ev_name, field_name, field->value, field->str);
163 define_flag_values(field->next, ev_name, field_name);
166 static void define_flag_field(const char *ev_name,
167 const char *field_name,
176 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
177 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
178 XPUSHs(sv_2mortal(newSVpv(delim, 0)));
181 if (get_cv("main::define_flag_field", 0))
182 call_pv("main::define_flag_field", G_SCALAR);
189 static void define_event_symbols(struct event_format *event,
191 struct print_arg *args)
196 switch (args->type) {
200 define_flag_value(ev_name, cur_field_name, "0",
205 free(cur_field_name);
206 cur_field_name = strdup(args->field.name);
209 define_event_symbols(event, ev_name, args->flags.field);
210 define_flag_field(ev_name, cur_field_name, args->flags.delim);
211 define_flag_values(args->flags.flags, ev_name, cur_field_name);
214 define_event_symbols(event, ev_name, args->symbol.field);
215 define_symbolic_field(ev_name, cur_field_name);
216 define_symbolic_values(args->symbol.symbols, ev_name,
220 define_event_symbols(event, ev_name, args->hex.field);
221 define_event_symbols(event, ev_name, args->hex.size);
223 case PRINT_INT_ARRAY:
224 define_event_symbols(event, ev_name, args->int_array.field);
225 define_event_symbols(event, ev_name, args->int_array.count);
226 define_event_symbols(event, ev_name, args->int_array.el_size);
229 case PRINT_DYNAMIC_ARRAY:
230 case PRINT_DYNAMIC_ARRAY_LEN:
235 define_event_symbols(event, ev_name, args->typecast.item);
238 if (strcmp(args->op.op, ":") == 0)
240 define_event_symbols(event, ev_name, args->op.left);
241 define_event_symbols(event, ev_name, args->op.right);
245 pr_err("Unsupported print arg type\n");
246 /* we should warn... */
251 define_event_symbols(event, ev_name, args->next);
254 static SV *perl_process_callchain(struct perf_sample *sample,
255 struct perf_evsel *evsel,
256 struct addr_location *al)
264 if (!symbol_conf.use_callchain || !sample->callchain)
267 if (thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
268 sample, NULL, NULL, scripting_max_stack) != 0) {
269 pr_err("Failed to resolve callchain. Skipping\n");
272 callchain_cursor_commit(&callchain_cursor);
277 struct callchain_cursor_node *node;
278 node = callchain_cursor_current(&callchain_cursor);
286 if (!hv_stores(elem, "ip", newSVuv(node->ip))) {
297 if (!hv_stores(sym, "start", newSVuv(node->sym->start)) ||
298 !hv_stores(sym, "end", newSVuv(node->sym->end)) ||
299 !hv_stores(sym, "binding", newSVuv(node->sym->binding)) ||
300 !hv_stores(sym, "name", newSVpvn(node->sym->name,
301 node->sym->namelen)) ||
302 !hv_stores(elem, "sym", newRV_noinc((SV*)sym))) {
310 struct map *map = node->map;
311 const char *dsoname = "[unknown]";
312 if (map && map->dso && (map->dso->name || map->dso->long_name)) {
313 if (symbol_conf.show_kernel_path && map->dso->long_name)
314 dsoname = map->dso->long_name;
315 else if (map->dso->name)
316 dsoname = map->dso->name;
318 if (!hv_stores(elem, "dso", newSVpv(dsoname,0))) {
324 callchain_cursor_advance(&callchain_cursor);
325 av_push(list, newRV_noinc((SV*)elem));
329 return newRV_noinc((SV*)list);
332 static void perl_process_tracepoint(struct perf_sample *sample,
333 struct perf_evsel *evsel,
334 struct addr_location *al)
336 struct thread *thread = al->thread;
337 struct event_format *event = evsel->tp_format;
338 struct format_field *field;
339 static char handler[256];
340 unsigned long long val;
343 int cpu = sample->cpu;
344 void *data = sample->raw_data;
345 unsigned long long nsecs = sample->time;
346 const char *comm = thread__comm_str(thread);
350 if (evsel->attr.type != PERF_TYPE_TRACEPOINT)
354 die("ug! no event found for type %" PRIu64, (u64)evsel->attr.config);
356 pid = raw_field_value(event, "common_pid", data);
358 sprintf(handler, "%s::%s", event->system, event->name);
360 if (!test_and_set_bit(event->id, events_defined))
361 define_event_symbols(event, handler, event->print_fmt.args);
363 s = nsecs / NSEC_PER_SEC;
364 ns = nsecs - s * NSEC_PER_SEC;
366 scripting_context->event_data = data;
367 scripting_context->pevent = evsel->tp_format->pevent;
373 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
374 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
375 XPUSHs(sv_2mortal(newSVuv(cpu)));
376 XPUSHs(sv_2mortal(newSVuv(s)));
377 XPUSHs(sv_2mortal(newSVuv(ns)));
378 XPUSHs(sv_2mortal(newSViv(pid)));
379 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
380 XPUSHs(sv_2mortal(perl_process_callchain(sample, evsel, al)));
382 /* common fields other than pid can be accessed via xsub fns */
384 for (field = event->format.fields; field; field = field->next) {
385 if (field->flags & FIELD_IS_STRING) {
387 if (field->flags & FIELD_IS_DYNAMIC) {
388 offset = *(int *)(data + field->offset);
391 offset = field->offset;
392 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0)));
393 } else { /* FIELD_IS_NUMERIC */
394 val = read_size(event, data + field->offset,
396 if (field->flags & FIELD_IS_SIGNED) {
397 XPUSHs(sv_2mortal(newSViv(val)));
399 XPUSHs(sv_2mortal(newSVuv(val)));
406 if (get_cv(handler, 0))
407 call_pv(handler, G_SCALAR);
408 else if (get_cv("main::trace_unhandled", 0)) {
409 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
410 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
411 XPUSHs(sv_2mortal(newSVuv(cpu)));
412 XPUSHs(sv_2mortal(newSVuv(nsecs)));
413 XPUSHs(sv_2mortal(newSViv(pid)));
414 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
415 XPUSHs(sv_2mortal(perl_process_callchain(sample, evsel, al)));
416 call_pv("main::trace_unhandled", G_SCALAR);
424 static void perl_process_event_generic(union perf_event *event,
425 struct perf_sample *sample,
426 struct perf_evsel *evsel)
430 if (!get_cv("process_event", 0))
436 XPUSHs(sv_2mortal(newSVpvn((const char *)event, event->header.size)));
437 XPUSHs(sv_2mortal(newSVpvn((const char *)&evsel->attr, sizeof(evsel->attr))));
438 XPUSHs(sv_2mortal(newSVpvn((const char *)sample, sizeof(*sample))));
439 XPUSHs(sv_2mortal(newSVpvn((const char *)sample->raw_data, sample->raw_size)));
441 call_pv("process_event", G_SCALAR);
448 static void perl_process_event(union perf_event *event,
449 struct perf_sample *sample,
450 struct perf_evsel *evsel,
451 struct addr_location *al)
453 perl_process_tracepoint(sample, evsel, al);
454 perl_process_event_generic(event, sample, evsel);
457 static void run_start_sub(void)
459 dSP; /* access to Perl stack */
462 if (get_cv("main::trace_begin", 0))
463 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
469 static int perl_start_script(const char *script, int argc, const char **argv)
471 const char **command_line;
474 command_line = malloc((argc + 2) * sizeof(const char *));
475 command_line[0] = "";
476 command_line[1] = script;
477 for (i = 2; i < argc + 2; i++)
478 command_line[i] = argv[i - 2];
480 my_perl = perl_alloc();
481 perl_construct(my_perl);
483 if (perl_parse(my_perl, xs_init, argc + 2, (char **)command_line,
489 if (perl_run(my_perl)) {
510 static int perl_flush_script(void)
518 static int perl_stop_script(void)
520 dSP; /* access to Perl stack */
523 if (get_cv("main::trace_end", 0))
524 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
526 perl_destruct(my_perl);
532 static int perl_generate_script(struct pevent *pevent, const char *outfile)
534 struct event_format *event = NULL;
535 struct format_field *f;
536 char fname[PATH_MAX];
537 int not_first, count;
540 sprintf(fname, "%s.pl", outfile);
541 ofp = fopen(fname, "w");
543 fprintf(stderr, "couldn't open %s\n", fname);
547 fprintf(ofp, "# perf script event handlers, "
548 "generated by perf script -g perl\n");
550 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
551 " License version 2\n\n");
553 fprintf(ofp, "# The common_* event handler fields are the most useful "
554 "fields common to\n");
556 fprintf(ofp, "# all events. They don't necessarily correspond to "
557 "the 'common_*' fields\n");
559 fprintf(ofp, "# in the format files. Those fields not available as "
560 "handler params can\n");
562 fprintf(ofp, "# be retrieved using Perl functions of the form "
563 "common_*($context).\n");
565 fprintf(ofp, "# See Context.pm for the list of available "
568 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
569 "Perf-Trace-Util/lib\";\n");
571 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n");
572 fprintf(ofp, "use Perf::Trace::Core;\n");
573 fprintf(ofp, "use Perf::Trace::Context;\n");
574 fprintf(ofp, "use Perf::Trace::Util;\n\n");
576 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n");
577 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n");
581 sub print_backtrace\n\
583 my $callchain = shift;\n\
584 for my $node (@$callchain)\n\
586 if(exists $node->{sym})\n\
588 printf( \"\\t[\\%%x] \\%%s\\n\", $node->{ip}, $node->{sym}{name});\n\
592 printf( \"\\t[\\%%x]\\n\", $node{ip});\n\
599 while ((event = trace_find_next_event(pevent, event))) {
600 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
601 fprintf(ofp, "\tmy (");
603 fprintf(ofp, "$event_name, ");
604 fprintf(ofp, "$context, ");
605 fprintf(ofp, "$common_cpu, ");
606 fprintf(ofp, "$common_secs, ");
607 fprintf(ofp, "$common_nsecs,\n");
608 fprintf(ofp, "\t $common_pid, ");
609 fprintf(ofp, "$common_comm, ");
610 fprintf(ofp, "$common_callchain,\n\t ");
615 for (f = event->format.fields; f; f = f->next) {
618 if (++count % 5 == 0)
619 fprintf(ofp, "\n\t ");
621 fprintf(ofp, "$%s", f->name);
623 fprintf(ofp, ") = @_;\n\n");
625 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
626 "$common_secs, $common_nsecs,\n\t "
627 "$common_pid, $common_comm, $common_callchain);\n\n");
629 fprintf(ofp, "\tprintf(\"");
634 for (f = event->format.fields; f; f = f->next) {
637 if (count && count % 4 == 0) {
638 fprintf(ofp, "\".\n\t \"");
642 fprintf(ofp, "%s=", f->name);
643 if (f->flags & FIELD_IS_STRING ||
644 f->flags & FIELD_IS_FLAG ||
645 f->flags & FIELD_IS_SYMBOLIC)
647 else if (f->flags & FIELD_IS_SIGNED)
653 fprintf(ofp, "\\n\",\n\t ");
658 for (f = event->format.fields; f; f = f->next) {
662 if (++count % 5 == 0)
663 fprintf(ofp, "\n\t ");
665 if (f->flags & FIELD_IS_FLAG) {
666 if ((count - 1) % 5 != 0) {
667 fprintf(ofp, "\n\t ");
670 fprintf(ofp, "flag_str(\"");
671 fprintf(ofp, "%s::%s\", ", event->system,
673 fprintf(ofp, "\"%s\", $%s)", f->name,
675 } else if (f->flags & FIELD_IS_SYMBOLIC) {
676 if ((count - 1) % 5 != 0) {
677 fprintf(ofp, "\n\t ");
680 fprintf(ofp, "symbol_str(\"");
681 fprintf(ofp, "%s::%s\", ", event->system,
683 fprintf(ofp, "\"%s\", $%s)", f->name,
686 fprintf(ofp, "$%s", f->name);
689 fprintf(ofp, ");\n\n");
691 fprintf(ofp, "\tprint_backtrace($common_callchain);\n");
693 fprintf(ofp, "}\n\n");
696 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
697 "$common_cpu, $common_secs, $common_nsecs,\n\t "
698 "$common_pid, $common_comm, $common_callchain) = @_;\n\n");
700 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
701 "$common_secs, $common_nsecs,\n\t $common_pid, "
702 "$common_comm, $common_callchain);\n");
703 fprintf(ofp, "\tprint_backtrace($common_callchain);\n");
704 fprintf(ofp, "}\n\n");
706 fprintf(ofp, "sub print_header\n{\n"
707 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
708 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
709 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}\n");
712 "\n# Packed byte string args of process_event():\n"
714 "# $event:\tunion perf_event\tutil/event.h\n"
715 "# $attr:\tstruct perf_event_attr\tlinux/perf_event.h\n"
716 "# $sample:\tstruct perf_sample\tutil/event.h\n"
717 "# $raw_data:\tperf_sample->raw_data\tutil/event.h\n"
719 "sub process_event\n"
721 "\tmy ($event, $attr, $sample, $raw_data) = @_;\n"
723 "\tmy @event\t= unpack(\"LSS\", $event);\n"
724 "\tmy @attr\t= unpack(\"LLQQQQQLLQQ\", $attr);\n"
725 "\tmy @sample\t= unpack(\"QLLQQQQQLL\", $sample);\n"
726 "\tmy @raw_data\t= unpack(\"C*\", $raw_data);\n"
728 "\tuse Data::Dumper;\n"
729 "\tprint Dumper \\@event, \\@attr, \\@sample, \\@raw_data;\n"
734 fprintf(stderr, "generated Perl script: %s\n", fname);
739 struct scripting_ops perl_scripting_ops = {
741 .start_script = perl_start_script,
742 .flush_script = perl_flush_script,
743 .stop_script = perl_stop_script,
744 .process_event = perl_process_event,
745 .generate_script = perl_generate_script,