2 * trace-event-perl. Feed perf script events to an embedded Perl interpreter.
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 <linux/bitmap.h>
29 #include <linux/time64.h>
30 #include <traceevent/event-parse.h>
33 /* perl needs the following define, right after including stdbool.h */
38 #include "../callchain.h"
40 #include "../machine.h"
42 #include "../symbol.h"
43 #include "../thread.h"
45 #include "../trace-event.h"
49 void boot_Perf__Trace__Context(pTHX_ CV *cv);
50 void boot_DynaLoader(pTHX_ CV *cv);
51 typedef PerlInterpreter * INTERP;
57 const char *file = __FILE__;
60 newXS("Perf::Trace::Context::bootstrap", boot_Perf__Trace__Context,
62 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
67 #define TRACE_EVENT_TYPE_MAX \
68 ((1 << (sizeof(unsigned short) * 8)) - 1)
70 static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
72 extern struct scripting_context *scripting_context;
74 static char *cur_field_name;
75 static int zero_flag_atom;
77 static void define_symbolic_value(const char *ev_name,
78 const char *field_name,
79 const char *field_value,
80 const char *field_str)
82 unsigned long long value;
85 value = eval_flag(field_value);
91 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
92 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
93 XPUSHs(sv_2mortal(newSVuv(value)));
94 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
97 if (get_cv("main::define_symbolic_value", 0))
98 call_pv("main::define_symbolic_value", G_SCALAR);
105 static void define_symbolic_values(struct tep_print_flag_sym *field,
107 const char *field_name)
109 define_symbolic_value(ev_name, field_name, field->value, field->str);
111 define_symbolic_values(field->next, ev_name, field_name);
114 static void define_symbolic_field(const char *ev_name,
115 const char *field_name)
123 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
124 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
127 if (get_cv("main::define_symbolic_field", 0))
128 call_pv("main::define_symbolic_field", G_SCALAR);
135 static void define_flag_value(const char *ev_name,
136 const char *field_name,
137 const char *field_value,
138 const char *field_str)
140 unsigned long long value;
143 value = eval_flag(field_value);
149 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
150 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
151 XPUSHs(sv_2mortal(newSVuv(value)));
152 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
155 if (get_cv("main::define_flag_value", 0))
156 call_pv("main::define_flag_value", G_SCALAR);
163 static void define_flag_values(struct tep_print_flag_sym *field,
165 const char *field_name)
167 define_flag_value(ev_name, field_name, field->value, field->str);
169 define_flag_values(field->next, ev_name, field_name);
172 static void define_flag_field(const char *ev_name,
173 const char *field_name,
182 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
183 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
184 XPUSHs(sv_2mortal(newSVpv(delim, 0)));
187 if (get_cv("main::define_flag_field", 0))
188 call_pv("main::define_flag_field", G_SCALAR);
195 static void define_event_symbols(struct tep_event *event,
197 struct tep_print_arg *args)
202 switch (args->type) {
206 define_flag_value(ev_name, cur_field_name, "0",
210 case TEP_PRINT_FIELD:
211 free(cur_field_name);
212 cur_field_name = strdup(args->field.name);
214 case TEP_PRINT_FLAGS:
215 define_event_symbols(event, ev_name, args->flags.field);
216 define_flag_field(ev_name, cur_field_name, args->flags.delim);
217 define_flag_values(args->flags.flags, ev_name, cur_field_name);
219 case TEP_PRINT_SYMBOL:
220 define_event_symbols(event, ev_name, args->symbol.field);
221 define_symbolic_field(ev_name, cur_field_name);
222 define_symbolic_values(args->symbol.symbols, ev_name,
226 case TEP_PRINT_HEX_STR:
227 define_event_symbols(event, ev_name, args->hex.field);
228 define_event_symbols(event, ev_name, args->hex.size);
230 case TEP_PRINT_INT_ARRAY:
231 define_event_symbols(event, ev_name, args->int_array.field);
232 define_event_symbols(event, ev_name, args->int_array.count);
233 define_event_symbols(event, ev_name, args->int_array.el_size);
235 case TEP_PRINT_BSTRING:
236 case TEP_PRINT_DYNAMIC_ARRAY:
237 case TEP_PRINT_DYNAMIC_ARRAY_LEN:
238 case TEP_PRINT_STRING:
239 case TEP_PRINT_BITMASK:
242 define_event_symbols(event, ev_name, args->typecast.item);
245 if (strcmp(args->op.op, ":") == 0)
247 define_event_symbols(event, ev_name, args->op.left);
248 define_event_symbols(event, ev_name, args->op.right);
252 pr_err("Unsupported print arg type\n");
253 /* we should warn... */
258 define_event_symbols(event, ev_name, args->next);
261 static SV *perl_process_callchain(struct perf_sample *sample,
263 struct addr_location *al)
271 if (!symbol_conf.use_callchain || !sample->callchain)
274 if (thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
275 sample, NULL, NULL, scripting_max_stack) != 0) {
276 pr_err("Failed to resolve callchain. Skipping\n");
279 callchain_cursor_commit(&callchain_cursor);
284 struct callchain_cursor_node *node;
285 node = callchain_cursor_current(&callchain_cursor);
293 if (!hv_stores(elem, "ip", newSVuv(node->ip))) {
304 if (!hv_stores(sym, "start", newSVuv(node->ms.sym->start)) ||
305 !hv_stores(sym, "end", newSVuv(node->ms.sym->end)) ||
306 !hv_stores(sym, "binding", newSVuv(node->ms.sym->binding)) ||
307 !hv_stores(sym, "name", newSVpvn(node->ms.sym->name,
308 node->ms.sym->namelen)) ||
309 !hv_stores(elem, "sym", newRV_noinc((SV*)sym))) {
317 struct map *map = node->ms.map;
318 const char *dsoname = "[unknown]";
319 if (map && map->dso) {
320 if (symbol_conf.show_kernel_path && map->dso->long_name)
321 dsoname = map->dso->long_name;
323 dsoname = map->dso->name;
325 if (!hv_stores(elem, "dso", newSVpv(dsoname,0))) {
331 callchain_cursor_advance(&callchain_cursor);
332 av_push(list, newRV_noinc((SV*)elem));
336 return newRV_noinc((SV*)list);
339 static void perl_process_tracepoint(struct perf_sample *sample,
341 struct addr_location *al)
343 struct thread *thread = al->thread;
344 struct tep_event *event = evsel->tp_format;
345 struct tep_format_field *field;
346 static char handler[256];
347 unsigned long long val;
350 int cpu = sample->cpu;
351 void *data = sample->raw_data;
352 unsigned long long nsecs = sample->time;
353 const char *comm = thread__comm_str(thread);
357 if (evsel->core.attr.type != PERF_TYPE_TRACEPOINT)
361 pr_debug("ug! no event found for type %" PRIu64, (u64)evsel->core.attr.config);
365 pid = raw_field_value(event, "common_pid", data);
367 sprintf(handler, "%s::%s", event->system, event->name);
369 if (!__test_and_set_bit(event->id, events_defined))
370 define_event_symbols(event, handler, event->print_fmt.args);
372 s = nsecs / NSEC_PER_SEC;
373 ns = nsecs - s * NSEC_PER_SEC;
379 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
380 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
381 XPUSHs(sv_2mortal(newSVuv(cpu)));
382 XPUSHs(sv_2mortal(newSVuv(s)));
383 XPUSHs(sv_2mortal(newSVuv(ns)));
384 XPUSHs(sv_2mortal(newSViv(pid)));
385 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
386 XPUSHs(sv_2mortal(perl_process_callchain(sample, evsel, al)));
388 /* common fields other than pid can be accessed via xsub fns */
390 for (field = event->format.fields; field; field = field->next) {
391 if (field->flags & TEP_FIELD_IS_STRING) {
393 if (field->flags & TEP_FIELD_IS_DYNAMIC) {
394 offset = *(int *)(data + field->offset);
396 #ifdef HAVE_LIBTRACEEVENT_TEP_FIELD_IS_RELATIVE
397 if (field->flags & TEP_FIELD_IS_RELATIVE)
398 offset += field->offset + field->size;
401 offset = field->offset;
402 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0)));
403 } else { /* FIELD_IS_NUMERIC */
404 val = read_size(event, data + field->offset,
406 if (field->flags & TEP_FIELD_IS_SIGNED) {
407 XPUSHs(sv_2mortal(newSViv(val)));
409 XPUSHs(sv_2mortal(newSVuv(val)));
416 if (get_cv(handler, 0))
417 call_pv(handler, G_SCALAR);
418 else if (get_cv("main::trace_unhandled", 0)) {
419 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
420 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
421 XPUSHs(sv_2mortal(newSVuv(cpu)));
422 XPUSHs(sv_2mortal(newSVuv(nsecs)));
423 XPUSHs(sv_2mortal(newSViv(pid)));
424 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
425 XPUSHs(sv_2mortal(perl_process_callchain(sample, evsel, al)));
426 call_pv("main::trace_unhandled", G_SCALAR);
434 static void perl_process_event_generic(union perf_event *event,
435 struct perf_sample *sample,
440 if (!get_cv("process_event", 0))
446 XPUSHs(sv_2mortal(newSVpvn((const char *)event, event->header.size)));
447 XPUSHs(sv_2mortal(newSVpvn((const char *)&evsel->core.attr, sizeof(evsel->core.attr))));
448 XPUSHs(sv_2mortal(newSVpvn((const char *)sample, sizeof(*sample))));
449 XPUSHs(sv_2mortal(newSVpvn((const char *)sample->raw_data, sample->raw_size)));
451 call_pv("process_event", G_SCALAR);
458 static void perl_process_event(union perf_event *event,
459 struct perf_sample *sample,
461 struct addr_location *al,
462 struct addr_location *addr_al)
464 scripting_context__update(scripting_context, event, sample, evsel, al, addr_al);
465 perl_process_tracepoint(sample, evsel, al);
466 perl_process_event_generic(event, sample, evsel);
469 static void run_start_sub(void)
471 dSP; /* access to Perl stack */
474 if (get_cv("main::trace_begin", 0))
475 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
481 static int perl_start_script(const char *script, int argc, const char **argv,
482 struct perf_session *session)
484 const char **command_line;
487 scripting_context->session = session;
489 command_line = malloc((argc + 2) * sizeof(const char *));
490 command_line[0] = "";
491 command_line[1] = script;
492 for (i = 2; i < argc + 2; i++)
493 command_line[i] = argv[i - 2];
495 my_perl = perl_alloc();
496 perl_construct(my_perl);
498 if (perl_parse(my_perl, xs_init, argc + 2, (char **)command_line,
504 if (perl_run(my_perl)) {
525 static int perl_flush_script(void)
533 static int perl_stop_script(void)
535 dSP; /* access to Perl stack */
538 if (get_cv("main::trace_end", 0))
539 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
541 perl_destruct(my_perl);
547 static int perl_generate_script(struct tep_handle *pevent, const char *outfile)
549 int i, not_first, count, nr_events;
550 struct tep_event **all_events;
551 struct tep_event *event = NULL;
552 struct tep_format_field *f;
553 char fname[PATH_MAX];
556 sprintf(fname, "%s.pl", outfile);
557 ofp = fopen(fname, "w");
559 fprintf(stderr, "couldn't open %s\n", fname);
563 fprintf(ofp, "# perf script event handlers, "
564 "generated by perf script -g perl\n");
566 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
567 " License version 2\n\n");
569 fprintf(ofp, "# The common_* event handler fields are the most useful "
570 "fields common to\n");
572 fprintf(ofp, "# all events. They don't necessarily correspond to "
573 "the 'common_*' fields\n");
575 fprintf(ofp, "# in the format files. Those fields not available as "
576 "handler params can\n");
578 fprintf(ofp, "# be retrieved using Perl functions of the form "
579 "common_*($context).\n");
581 fprintf(ofp, "# See Context.pm for the list of available "
584 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
585 "Perf-Trace-Util/lib\";\n");
587 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n");
588 fprintf(ofp, "use Perf::Trace::Core;\n");
589 fprintf(ofp, "use Perf::Trace::Context;\n");
590 fprintf(ofp, "use Perf::Trace::Util;\n\n");
592 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n");
593 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n");
597 sub print_backtrace\n\
599 my $callchain = shift;\n\
600 for my $node (@$callchain)\n\
602 if(exists $node->{sym})\n\
604 printf( \"\\t[\\%%x] \\%%s\\n\", $node->{ip}, $node->{sym}{name});\n\
608 printf( \"\\t[\\%%x]\\n\", $node{ip});\n\
614 nr_events = tep_get_events_count(pevent);
615 all_events = tep_list_events(pevent, TEP_EVENT_SORT_ID);
617 for (i = 0; all_events && i < nr_events; i++) {
618 event = all_events[i];
619 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
620 fprintf(ofp, "\tmy (");
622 fprintf(ofp, "$event_name, ");
623 fprintf(ofp, "$context, ");
624 fprintf(ofp, "$common_cpu, ");
625 fprintf(ofp, "$common_secs, ");
626 fprintf(ofp, "$common_nsecs,\n");
627 fprintf(ofp, "\t $common_pid, ");
628 fprintf(ofp, "$common_comm, ");
629 fprintf(ofp, "$common_callchain,\n\t ");
634 for (f = event->format.fields; f; f = f->next) {
637 if (++count % 5 == 0)
638 fprintf(ofp, "\n\t ");
640 fprintf(ofp, "$%s", f->name);
642 fprintf(ofp, ") = @_;\n\n");
644 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
645 "$common_secs, $common_nsecs,\n\t "
646 "$common_pid, $common_comm, $common_callchain);\n\n");
648 fprintf(ofp, "\tprintf(\"");
653 for (f = event->format.fields; f; f = f->next) {
656 if (count && count % 4 == 0) {
657 fprintf(ofp, "\".\n\t \"");
661 fprintf(ofp, "%s=", f->name);
662 if (f->flags & TEP_FIELD_IS_STRING ||
663 f->flags & TEP_FIELD_IS_FLAG ||
664 f->flags & TEP_FIELD_IS_SYMBOLIC)
666 else if (f->flags & TEP_FIELD_IS_SIGNED)
672 fprintf(ofp, "\\n\",\n\t ");
677 for (f = event->format.fields; f; f = f->next) {
681 if (++count % 5 == 0)
682 fprintf(ofp, "\n\t ");
684 if (f->flags & TEP_FIELD_IS_FLAG) {
685 if ((count - 1) % 5 != 0) {
686 fprintf(ofp, "\n\t ");
689 fprintf(ofp, "flag_str(\"");
690 fprintf(ofp, "%s::%s\", ", event->system,
692 fprintf(ofp, "\"%s\", $%s)", f->name,
694 } else if (f->flags & TEP_FIELD_IS_SYMBOLIC) {
695 if ((count - 1) % 5 != 0) {
696 fprintf(ofp, "\n\t ");
699 fprintf(ofp, "symbol_str(\"");
700 fprintf(ofp, "%s::%s\", ", event->system,
702 fprintf(ofp, "\"%s\", $%s)", f->name,
705 fprintf(ofp, "$%s", f->name);
708 fprintf(ofp, ");\n\n");
710 fprintf(ofp, "\tprint_backtrace($common_callchain);\n");
712 fprintf(ofp, "}\n\n");
715 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
716 "$common_cpu, $common_secs, $common_nsecs,\n\t "
717 "$common_pid, $common_comm, $common_callchain) = @_;\n\n");
719 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
720 "$common_secs, $common_nsecs,\n\t $common_pid, "
721 "$common_comm, $common_callchain);\n");
722 fprintf(ofp, "\tprint_backtrace($common_callchain);\n");
723 fprintf(ofp, "}\n\n");
725 fprintf(ofp, "sub print_header\n{\n"
726 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
727 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
728 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}\n");
731 "\n# Packed byte string args of process_event():\n"
733 "# $event:\tunion perf_event\tutil/event.h\n"
734 "# $attr:\tstruct perf_event_attr\tlinux/perf_event.h\n"
735 "# $sample:\tstruct perf_sample\tutil/event.h\n"
736 "# $raw_data:\tperf_sample->raw_data\tutil/event.h\n"
738 "sub process_event\n"
740 "\tmy ($event, $attr, $sample, $raw_data) = @_;\n"
742 "\tmy @event\t= unpack(\"LSS\", $event);\n"
743 "\tmy @attr\t= unpack(\"LLQQQQQLLQQ\", $attr);\n"
744 "\tmy @sample\t= unpack(\"QLLQQQQQLL\", $sample);\n"
745 "\tmy @raw_data\t= unpack(\"C*\", $raw_data);\n"
747 "\tuse Data::Dumper;\n"
748 "\tprint Dumper \\@event, \\@attr, \\@sample, \\@raw_data;\n"
753 fprintf(stderr, "generated Perl script: %s\n", fname);
758 struct scripting_ops perl_scripting_ops = {
761 .start_script = perl_start_script,
762 .flush_script = perl_flush_script,
763 .stop_script = perl_stop_script,
764 .process_event = perl_process_event,
765 .generate_script = perl_generate_script,