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
28 #include <linux/bitmap.h>
29 #include <linux/time64.h>
32 /* perl needs the following define, right after including stdbool.h */
37 #include "../callchain.h"
39 #include "../machine.h"
41 #include "../symbol.h"
42 #include "../thread.h"
44 #include "../trace-event.h"
48 void boot_Perf__Trace__Context(pTHX_ CV *cv);
49 void boot_DynaLoader(pTHX_ CV *cv);
50 typedef PerlInterpreter * INTERP;
56 const char *file = __FILE__;
59 newXS("Perf::Trace::Context::bootstrap", boot_Perf__Trace__Context,
61 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
66 #define TRACE_EVENT_TYPE_MAX \
67 ((1 << (sizeof(unsigned short) * 8)) - 1)
69 static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
71 extern struct scripting_context *scripting_context;
73 static char *cur_field_name;
74 static int zero_flag_atom;
76 static void define_symbolic_value(const char *ev_name,
77 const char *field_name,
78 const char *field_value,
79 const char *field_str)
81 unsigned long long value;
84 value = eval_flag(field_value);
90 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
91 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
92 XPUSHs(sv_2mortal(newSVuv(value)));
93 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
96 if (get_cv("main::define_symbolic_value", 0))
97 call_pv("main::define_symbolic_value", G_SCALAR);
104 static void define_symbolic_values(struct tep_print_flag_sym *field,
106 const char *field_name)
108 define_symbolic_value(ev_name, field_name, field->value, field->str);
110 define_symbolic_values(field->next, ev_name, field_name);
113 static void define_symbolic_field(const char *ev_name,
114 const char *field_name)
122 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
123 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
126 if (get_cv("main::define_symbolic_field", 0))
127 call_pv("main::define_symbolic_field", G_SCALAR);
134 static void define_flag_value(const char *ev_name,
135 const char *field_name,
136 const char *field_value,
137 const char *field_str)
139 unsigned long long value;
142 value = eval_flag(field_value);
148 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
149 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
150 XPUSHs(sv_2mortal(newSVuv(value)));
151 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
154 if (get_cv("main::define_flag_value", 0))
155 call_pv("main::define_flag_value", G_SCALAR);
162 static void define_flag_values(struct tep_print_flag_sym *field,
164 const char *field_name)
166 define_flag_value(ev_name, field_name, field->value, field->str);
168 define_flag_values(field->next, ev_name, field_name);
171 static void define_flag_field(const char *ev_name,
172 const char *field_name,
181 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
182 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
183 XPUSHs(sv_2mortal(newSVpv(delim, 0)));
186 if (get_cv("main::define_flag_field", 0))
187 call_pv("main::define_flag_field", G_SCALAR);
194 static void define_event_symbols(struct tep_event *event,
196 struct tep_print_arg *args)
201 switch (args->type) {
205 define_flag_value(ev_name, cur_field_name, "0",
209 case TEP_PRINT_FIELD:
210 free(cur_field_name);
211 cur_field_name = strdup(args->field.name);
213 case TEP_PRINT_FLAGS:
214 define_event_symbols(event, ev_name, args->flags.field);
215 define_flag_field(ev_name, cur_field_name, args->flags.delim);
216 define_flag_values(args->flags.flags, ev_name, cur_field_name);
218 case TEP_PRINT_SYMBOL:
219 define_event_symbols(event, ev_name, args->symbol.field);
220 define_symbolic_field(ev_name, cur_field_name);
221 define_symbolic_values(args->symbol.symbols, ev_name,
225 case TEP_PRINT_HEX_STR:
226 define_event_symbols(event, ev_name, args->hex.field);
227 define_event_symbols(event, ev_name, args->hex.size);
229 case TEP_PRINT_INT_ARRAY:
230 define_event_symbols(event, ev_name, args->int_array.field);
231 define_event_symbols(event, ev_name, args->int_array.count);
232 define_event_symbols(event, ev_name, args->int_array.el_size);
234 case TEP_PRINT_BSTRING:
235 case TEP_PRINT_DYNAMIC_ARRAY:
236 case TEP_PRINT_DYNAMIC_ARRAY_LEN:
237 case TEP_PRINT_STRING:
238 case TEP_PRINT_BITMASK:
241 define_event_symbols(event, ev_name, args->typecast.item);
244 if (strcmp(args->op.op, ":") == 0)
246 define_event_symbols(event, ev_name, args->op.left);
247 define_event_symbols(event, ev_name, args->op.right);
251 pr_err("Unsupported print arg type\n");
252 /* we should warn... */
257 define_event_symbols(event, ev_name, args->next);
260 static SV *perl_process_callchain(struct perf_sample *sample,
262 struct addr_location *al)
270 if (!symbol_conf.use_callchain || !sample->callchain)
273 if (thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
274 sample, NULL, NULL, scripting_max_stack) != 0) {
275 pr_err("Failed to resolve callchain. Skipping\n");
278 callchain_cursor_commit(&callchain_cursor);
283 struct callchain_cursor_node *node;
284 node = callchain_cursor_current(&callchain_cursor);
292 if (!hv_stores(elem, "ip", newSVuv(node->ip))) {
303 if (!hv_stores(sym, "start", newSVuv(node->ms.sym->start)) ||
304 !hv_stores(sym, "end", newSVuv(node->ms.sym->end)) ||
305 !hv_stores(sym, "binding", newSVuv(node->ms.sym->binding)) ||
306 !hv_stores(sym, "name", newSVpvn(node->ms.sym->name,
307 node->ms.sym->namelen)) ||
308 !hv_stores(elem, "sym", newRV_noinc((SV*)sym))) {
316 struct map *map = node->ms.map;
317 const char *dsoname = "[unknown]";
318 if (map && map->dso) {
319 if (symbol_conf.show_kernel_path && map->dso->long_name)
320 dsoname = map->dso->long_name;
322 dsoname = map->dso->name;
324 if (!hv_stores(elem, "dso", newSVpv(dsoname,0))) {
330 callchain_cursor_advance(&callchain_cursor);
331 av_push(list, newRV_noinc((SV*)elem));
335 return newRV_noinc((SV*)list);
338 static void perl_process_tracepoint(struct perf_sample *sample,
340 struct addr_location *al)
342 struct thread *thread = al->thread;
343 struct tep_event *event = evsel->tp_format;
344 struct tep_format_field *field;
345 static char handler[256];
346 unsigned long long val;
349 int cpu = sample->cpu;
350 void *data = sample->raw_data;
351 unsigned long long nsecs = sample->time;
352 const char *comm = thread__comm_str(thread);
356 if (evsel->core.attr.type != PERF_TYPE_TRACEPOINT)
360 pr_debug("ug! no event found for type %" PRIu64, (u64)evsel->core.attr.config);
364 pid = raw_field_value(event, "common_pid", data);
366 sprintf(handler, "%s::%s", event->system, event->name);
368 if (!test_and_set_bit(event->id, events_defined))
369 define_event_symbols(event, handler, event->print_fmt.args);
371 s = nsecs / NSEC_PER_SEC;
372 ns = nsecs - s * NSEC_PER_SEC;
378 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
379 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
380 XPUSHs(sv_2mortal(newSVuv(cpu)));
381 XPUSHs(sv_2mortal(newSVuv(s)));
382 XPUSHs(sv_2mortal(newSVuv(ns)));
383 XPUSHs(sv_2mortal(newSViv(pid)));
384 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
385 XPUSHs(sv_2mortal(perl_process_callchain(sample, evsel, al)));
387 /* common fields other than pid can be accessed via xsub fns */
389 for (field = event->format.fields; field; field = field->next) {
390 if (field->flags & TEP_FIELD_IS_STRING) {
392 if (field->flags & TEP_FIELD_IS_DYNAMIC) {
393 offset = *(int *)(data + field->offset);
395 if (field->flags & TEP_FIELD_IS_RELATIVE)
396 offset += field->offset + field->size;
398 offset = field->offset;
399 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0)));
400 } else { /* FIELD_IS_NUMERIC */
401 val = read_size(event, data + field->offset,
403 if (field->flags & TEP_FIELD_IS_SIGNED) {
404 XPUSHs(sv_2mortal(newSViv(val)));
406 XPUSHs(sv_2mortal(newSVuv(val)));
413 if (get_cv(handler, 0))
414 call_pv(handler, G_SCALAR);
415 else if (get_cv("main::trace_unhandled", 0)) {
416 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
417 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
418 XPUSHs(sv_2mortal(newSVuv(cpu)));
419 XPUSHs(sv_2mortal(newSVuv(nsecs)));
420 XPUSHs(sv_2mortal(newSViv(pid)));
421 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
422 XPUSHs(sv_2mortal(perl_process_callchain(sample, evsel, al)));
423 call_pv("main::trace_unhandled", G_SCALAR);
431 static void perl_process_event_generic(union perf_event *event,
432 struct perf_sample *sample,
437 if (!get_cv("process_event", 0))
443 XPUSHs(sv_2mortal(newSVpvn((const char *)event, event->header.size)));
444 XPUSHs(sv_2mortal(newSVpvn((const char *)&evsel->core.attr, sizeof(evsel->core.attr))));
445 XPUSHs(sv_2mortal(newSVpvn((const char *)sample, sizeof(*sample))));
446 XPUSHs(sv_2mortal(newSVpvn((const char *)sample->raw_data, sample->raw_size)));
448 call_pv("process_event", G_SCALAR);
455 static void perl_process_event(union perf_event *event,
456 struct perf_sample *sample,
458 struct addr_location *al,
459 struct addr_location *addr_al)
461 scripting_context__update(scripting_context, event, sample, evsel, al, addr_al);
462 perl_process_tracepoint(sample, evsel, al);
463 perl_process_event_generic(event, sample, evsel);
466 static void run_start_sub(void)
468 dSP; /* access to Perl stack */
471 if (get_cv("main::trace_begin", 0))
472 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
478 static int perl_start_script(const char *script, int argc, const char **argv,
479 struct perf_session *session)
481 const char **command_line;
484 scripting_context->session = session;
486 command_line = malloc((argc + 2) * sizeof(const char *));
487 command_line[0] = "";
488 command_line[1] = script;
489 for (i = 2; i < argc + 2; i++)
490 command_line[i] = argv[i - 2];
492 my_perl = perl_alloc();
493 perl_construct(my_perl);
495 if (perl_parse(my_perl, xs_init, argc + 2, (char **)command_line,
501 if (perl_run(my_perl)) {
522 static int perl_flush_script(void)
530 static int perl_stop_script(void)
532 dSP; /* access to Perl stack */
535 if (get_cv("main::trace_end", 0))
536 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
538 perl_destruct(my_perl);
544 static int perl_generate_script(struct tep_handle *pevent, const char *outfile)
546 int i, not_first, count, nr_events;
547 struct tep_event **all_events;
548 struct tep_event *event = NULL;
549 struct tep_format_field *f;
550 char fname[PATH_MAX];
553 sprintf(fname, "%s.pl", outfile);
554 ofp = fopen(fname, "w");
556 fprintf(stderr, "couldn't open %s\n", fname);
560 fprintf(ofp, "# perf script event handlers, "
561 "generated by perf script -g perl\n");
563 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
564 " License version 2\n\n");
566 fprintf(ofp, "# The common_* event handler fields are the most useful "
567 "fields common to\n");
569 fprintf(ofp, "# all events. They don't necessarily correspond to "
570 "the 'common_*' fields\n");
572 fprintf(ofp, "# in the format files. Those fields not available as "
573 "handler params can\n");
575 fprintf(ofp, "# be retrieved using Perl functions of the form "
576 "common_*($context).\n");
578 fprintf(ofp, "# See Context.pm for the list of available "
581 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
582 "Perf-Trace-Util/lib\";\n");
584 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n");
585 fprintf(ofp, "use Perf::Trace::Core;\n");
586 fprintf(ofp, "use Perf::Trace::Context;\n");
587 fprintf(ofp, "use Perf::Trace::Util;\n\n");
589 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n");
590 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n");
594 sub print_backtrace\n\
596 my $callchain = shift;\n\
597 for my $node (@$callchain)\n\
599 if(exists $node->{sym})\n\
601 printf( \"\\t[\\%%x] \\%%s\\n\", $node->{ip}, $node->{sym}{name});\n\
605 printf( \"\\t[\\%%x]\\n\", $node{ip});\n\
611 nr_events = tep_get_events_count(pevent);
612 all_events = tep_list_events(pevent, TEP_EVENT_SORT_ID);
614 for (i = 0; all_events && i < nr_events; i++) {
615 event = all_events[i];
616 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
617 fprintf(ofp, "\tmy (");
619 fprintf(ofp, "$event_name, ");
620 fprintf(ofp, "$context, ");
621 fprintf(ofp, "$common_cpu, ");
622 fprintf(ofp, "$common_secs, ");
623 fprintf(ofp, "$common_nsecs,\n");
624 fprintf(ofp, "\t $common_pid, ");
625 fprintf(ofp, "$common_comm, ");
626 fprintf(ofp, "$common_callchain,\n\t ");
631 for (f = event->format.fields; f; f = f->next) {
634 if (++count % 5 == 0)
635 fprintf(ofp, "\n\t ");
637 fprintf(ofp, "$%s", f->name);
639 fprintf(ofp, ") = @_;\n\n");
641 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
642 "$common_secs, $common_nsecs,\n\t "
643 "$common_pid, $common_comm, $common_callchain);\n\n");
645 fprintf(ofp, "\tprintf(\"");
650 for (f = event->format.fields; f; f = f->next) {
653 if (count && count % 4 == 0) {
654 fprintf(ofp, "\".\n\t \"");
658 fprintf(ofp, "%s=", f->name);
659 if (f->flags & TEP_FIELD_IS_STRING ||
660 f->flags & TEP_FIELD_IS_FLAG ||
661 f->flags & TEP_FIELD_IS_SYMBOLIC)
663 else if (f->flags & TEP_FIELD_IS_SIGNED)
669 fprintf(ofp, "\\n\",\n\t ");
674 for (f = event->format.fields; f; f = f->next) {
678 if (++count % 5 == 0)
679 fprintf(ofp, "\n\t ");
681 if (f->flags & TEP_FIELD_IS_FLAG) {
682 if ((count - 1) % 5 != 0) {
683 fprintf(ofp, "\n\t ");
686 fprintf(ofp, "flag_str(\"");
687 fprintf(ofp, "%s::%s\", ", event->system,
689 fprintf(ofp, "\"%s\", $%s)", f->name,
691 } else if (f->flags & TEP_FIELD_IS_SYMBOLIC) {
692 if ((count - 1) % 5 != 0) {
693 fprintf(ofp, "\n\t ");
696 fprintf(ofp, "symbol_str(\"");
697 fprintf(ofp, "%s::%s\", ", event->system,
699 fprintf(ofp, "\"%s\", $%s)", f->name,
702 fprintf(ofp, "$%s", f->name);
705 fprintf(ofp, ");\n\n");
707 fprintf(ofp, "\tprint_backtrace($common_callchain);\n");
709 fprintf(ofp, "}\n\n");
712 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
713 "$common_cpu, $common_secs, $common_nsecs,\n\t "
714 "$common_pid, $common_comm, $common_callchain) = @_;\n\n");
716 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
717 "$common_secs, $common_nsecs,\n\t $common_pid, "
718 "$common_comm, $common_callchain);\n");
719 fprintf(ofp, "\tprint_backtrace($common_callchain);\n");
720 fprintf(ofp, "}\n\n");
722 fprintf(ofp, "sub print_header\n{\n"
723 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
724 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
725 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}\n");
728 "\n# Packed byte string args of process_event():\n"
730 "# $event:\tunion perf_event\tutil/event.h\n"
731 "# $attr:\tstruct perf_event_attr\tlinux/perf_event.h\n"
732 "# $sample:\tstruct perf_sample\tutil/event.h\n"
733 "# $raw_data:\tperf_sample->raw_data\tutil/event.h\n"
735 "sub process_event\n"
737 "\tmy ($event, $attr, $sample, $raw_data) = @_;\n"
739 "\tmy @event\t= unpack(\"LSS\", $event);\n"
740 "\tmy @attr\t= unpack(\"LLQQQQQLLQQ\", $attr);\n"
741 "\tmy @sample\t= unpack(\"QLLQQQQQLL\", $sample);\n"
742 "\tmy @raw_data\t= unpack(\"C*\", $raw_data);\n"
744 "\tuse Data::Dumper;\n"
745 "\tprint Dumper \\@event, \\@attr, \\@sample, \\@raw_data;\n"
750 fprintf(stderr, "generated Perl script: %s\n", fname);
755 struct scripting_ops perl_scripting_ops = {
758 .start_script = perl_start_script,
759 .flush_script = perl_flush_script,
760 .stop_script = perl_stop_script,
761 .process_event = perl_process_event,
762 .generate_script = perl_generate_script,