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
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,
221 define_event_symbols(event, ev_name, args->hex.field);
222 define_event_symbols(event, ev_name, args->hex.size);
224 case PRINT_INT_ARRAY:
225 define_event_symbols(event, ev_name, args->int_array.field);
226 define_event_symbols(event, ev_name, args->int_array.count);
227 define_event_symbols(event, ev_name, args->int_array.el_size);
230 case PRINT_DYNAMIC_ARRAY:
231 case PRINT_DYNAMIC_ARRAY_LEN:
236 define_event_symbols(event, ev_name, args->typecast.item);
239 if (strcmp(args->op.op, ":") == 0)
241 define_event_symbols(event, ev_name, args->op.left);
242 define_event_symbols(event, ev_name, args->op.right);
246 pr_err("Unsupported print arg type\n");
247 /* we should warn... */
252 define_event_symbols(event, ev_name, args->next);
255 static SV *perl_process_callchain(struct perf_sample *sample,
256 struct perf_evsel *evsel,
257 struct addr_location *al)
265 if (!symbol_conf.use_callchain || !sample->callchain)
268 if (thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
269 sample, NULL, NULL, scripting_max_stack) != 0) {
270 pr_err("Failed to resolve callchain. Skipping\n");
273 callchain_cursor_commit(&callchain_cursor);
278 struct callchain_cursor_node *node;
279 node = callchain_cursor_current(&callchain_cursor);
287 if (!hv_stores(elem, "ip", newSVuv(node->ip))) {
298 if (!hv_stores(sym, "start", newSVuv(node->sym->start)) ||
299 !hv_stores(sym, "end", newSVuv(node->sym->end)) ||
300 !hv_stores(sym, "binding", newSVuv(node->sym->binding)) ||
301 !hv_stores(sym, "name", newSVpvn(node->sym->name,
302 node->sym->namelen)) ||
303 !hv_stores(elem, "sym", newRV_noinc((SV*)sym))) {
311 struct map *map = node->map;
312 const char *dsoname = "[unknown]";
313 if (map && map->dso) {
314 if (symbol_conf.show_kernel_path && map->dso->long_name)
315 dsoname = map->dso->long_name;
317 dsoname = map->dso->name;
319 if (!hv_stores(elem, "dso", newSVpv(dsoname,0))) {
325 callchain_cursor_advance(&callchain_cursor);
326 av_push(list, newRV_noinc((SV*)elem));
330 return newRV_noinc((SV*)list);
333 static void perl_process_tracepoint(struct perf_sample *sample,
334 struct perf_evsel *evsel,
335 struct addr_location *al)
337 struct thread *thread = al->thread;
338 struct event_format *event = evsel->tp_format;
339 struct format_field *field;
340 static char handler[256];
341 unsigned long long val;
344 int cpu = sample->cpu;
345 void *data = sample->raw_data;
346 unsigned long long nsecs = sample->time;
347 const char *comm = thread__comm_str(thread);
351 if (evsel->attr.type != PERF_TYPE_TRACEPOINT)
355 pr_debug("ug! no event found for type %" PRIu64, (u64)evsel->attr.config);
359 pid = raw_field_value(event, "common_pid", data);
361 sprintf(handler, "%s::%s", event->system, event->name);
363 if (!test_and_set_bit(event->id, events_defined))
364 define_event_symbols(event, handler, event->print_fmt.args);
366 s = nsecs / NSEC_PER_SEC;
367 ns = nsecs - s * NSEC_PER_SEC;
369 scripting_context->event_data = data;
370 scripting_context->pevent = evsel->tp_format->pevent;
376 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
377 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
378 XPUSHs(sv_2mortal(newSVuv(cpu)));
379 XPUSHs(sv_2mortal(newSVuv(s)));
380 XPUSHs(sv_2mortal(newSVuv(ns)));
381 XPUSHs(sv_2mortal(newSViv(pid)));
382 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
383 XPUSHs(sv_2mortal(perl_process_callchain(sample, evsel, al)));
385 /* common fields other than pid can be accessed via xsub fns */
387 for (field = event->format.fields; field; field = field->next) {
388 if (field->flags & FIELD_IS_STRING) {
390 if (field->flags & FIELD_IS_DYNAMIC) {
391 offset = *(int *)(data + field->offset);
394 offset = field->offset;
395 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0)));
396 } else { /* FIELD_IS_NUMERIC */
397 val = read_size(event, data + field->offset,
399 if (field->flags & FIELD_IS_SIGNED) {
400 XPUSHs(sv_2mortal(newSViv(val)));
402 XPUSHs(sv_2mortal(newSVuv(val)));
409 if (get_cv(handler, 0))
410 call_pv(handler, G_SCALAR);
411 else if (get_cv("main::trace_unhandled", 0)) {
412 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
413 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
414 XPUSHs(sv_2mortal(newSVuv(cpu)));
415 XPUSHs(sv_2mortal(newSVuv(nsecs)));
416 XPUSHs(sv_2mortal(newSViv(pid)));
417 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
418 XPUSHs(sv_2mortal(perl_process_callchain(sample, evsel, al)));
419 call_pv("main::trace_unhandled", G_SCALAR);
427 static void perl_process_event_generic(union perf_event *event,
428 struct perf_sample *sample,
429 struct perf_evsel *evsel)
433 if (!get_cv("process_event", 0))
439 XPUSHs(sv_2mortal(newSVpvn((const char *)event, event->header.size)));
440 XPUSHs(sv_2mortal(newSVpvn((const char *)&evsel->attr, sizeof(evsel->attr))));
441 XPUSHs(sv_2mortal(newSVpvn((const char *)sample, sizeof(*sample))));
442 XPUSHs(sv_2mortal(newSVpvn((const char *)sample->raw_data, sample->raw_size)));
444 call_pv("process_event", G_SCALAR);
451 static void perl_process_event(union perf_event *event,
452 struct perf_sample *sample,
453 struct perf_evsel *evsel,
454 struct addr_location *al)
456 perl_process_tracepoint(sample, evsel, al);
457 perl_process_event_generic(event, sample, evsel);
460 static void run_start_sub(void)
462 dSP; /* access to Perl stack */
465 if (get_cv("main::trace_begin", 0))
466 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
472 static int perl_start_script(const char *script, int argc, const char **argv)
474 const char **command_line;
477 command_line = malloc((argc + 2) * sizeof(const char *));
478 command_line[0] = "";
479 command_line[1] = script;
480 for (i = 2; i < argc + 2; i++)
481 command_line[i] = argv[i - 2];
483 my_perl = perl_alloc();
484 perl_construct(my_perl);
486 if (perl_parse(my_perl, xs_init, argc + 2, (char **)command_line,
492 if (perl_run(my_perl)) {
513 static int perl_flush_script(void)
521 static int perl_stop_script(void)
523 dSP; /* access to Perl stack */
526 if (get_cv("main::trace_end", 0))
527 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
529 perl_destruct(my_perl);
535 static int perl_generate_script(struct pevent *pevent, const char *outfile)
537 struct event_format *event = NULL;
538 struct format_field *f;
539 char fname[PATH_MAX];
540 int not_first, count;
543 sprintf(fname, "%s.pl", outfile);
544 ofp = fopen(fname, "w");
546 fprintf(stderr, "couldn't open %s\n", fname);
550 fprintf(ofp, "# perf script event handlers, "
551 "generated by perf script -g perl\n");
553 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
554 " License version 2\n\n");
556 fprintf(ofp, "# The common_* event handler fields are the most useful "
557 "fields common to\n");
559 fprintf(ofp, "# all events. They don't necessarily correspond to "
560 "the 'common_*' fields\n");
562 fprintf(ofp, "# in the format files. Those fields not available as "
563 "handler params can\n");
565 fprintf(ofp, "# be retrieved using Perl functions of the form "
566 "common_*($context).\n");
568 fprintf(ofp, "# See Context.pm for the list of available "
571 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
572 "Perf-Trace-Util/lib\";\n");
574 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n");
575 fprintf(ofp, "use Perf::Trace::Core;\n");
576 fprintf(ofp, "use Perf::Trace::Context;\n");
577 fprintf(ofp, "use Perf::Trace::Util;\n\n");
579 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n");
580 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n");
584 sub print_backtrace\n\
586 my $callchain = shift;\n\
587 for my $node (@$callchain)\n\
589 if(exists $node->{sym})\n\
591 printf( \"\\t[\\%%x] \\%%s\\n\", $node->{ip}, $node->{sym}{name});\n\
595 printf( \"\\t[\\%%x]\\n\", $node{ip});\n\
602 while ((event = trace_find_next_event(pevent, event))) {
603 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
604 fprintf(ofp, "\tmy (");
606 fprintf(ofp, "$event_name, ");
607 fprintf(ofp, "$context, ");
608 fprintf(ofp, "$common_cpu, ");
609 fprintf(ofp, "$common_secs, ");
610 fprintf(ofp, "$common_nsecs,\n");
611 fprintf(ofp, "\t $common_pid, ");
612 fprintf(ofp, "$common_comm, ");
613 fprintf(ofp, "$common_callchain,\n\t ");
618 for (f = event->format.fields; f; f = f->next) {
621 if (++count % 5 == 0)
622 fprintf(ofp, "\n\t ");
624 fprintf(ofp, "$%s", f->name);
626 fprintf(ofp, ") = @_;\n\n");
628 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
629 "$common_secs, $common_nsecs,\n\t "
630 "$common_pid, $common_comm, $common_callchain);\n\n");
632 fprintf(ofp, "\tprintf(\"");
637 for (f = event->format.fields; f; f = f->next) {
640 if (count && count % 4 == 0) {
641 fprintf(ofp, "\".\n\t \"");
645 fprintf(ofp, "%s=", f->name);
646 if (f->flags & FIELD_IS_STRING ||
647 f->flags & FIELD_IS_FLAG ||
648 f->flags & FIELD_IS_SYMBOLIC)
650 else if (f->flags & FIELD_IS_SIGNED)
656 fprintf(ofp, "\\n\",\n\t ");
661 for (f = event->format.fields; f; f = f->next) {
665 if (++count % 5 == 0)
666 fprintf(ofp, "\n\t ");
668 if (f->flags & FIELD_IS_FLAG) {
669 if ((count - 1) % 5 != 0) {
670 fprintf(ofp, "\n\t ");
673 fprintf(ofp, "flag_str(\"");
674 fprintf(ofp, "%s::%s\", ", event->system,
676 fprintf(ofp, "\"%s\", $%s)", f->name,
678 } else if (f->flags & FIELD_IS_SYMBOLIC) {
679 if ((count - 1) % 5 != 0) {
680 fprintf(ofp, "\n\t ");
683 fprintf(ofp, "symbol_str(\"");
684 fprintf(ofp, "%s::%s\", ", event->system,
686 fprintf(ofp, "\"%s\", $%s)", f->name,
689 fprintf(ofp, "$%s", f->name);
692 fprintf(ofp, ");\n\n");
694 fprintf(ofp, "\tprint_backtrace($common_callchain);\n");
696 fprintf(ofp, "}\n\n");
699 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
700 "$common_cpu, $common_secs, $common_nsecs,\n\t "
701 "$common_pid, $common_comm, $common_callchain) = @_;\n\n");
703 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
704 "$common_secs, $common_nsecs,\n\t $common_pid, "
705 "$common_comm, $common_callchain);\n");
706 fprintf(ofp, "\tprint_backtrace($common_callchain);\n");
707 fprintf(ofp, "}\n\n");
709 fprintf(ofp, "sub print_header\n{\n"
710 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
711 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
712 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}\n");
715 "\n# Packed byte string args of process_event():\n"
717 "# $event:\tunion perf_event\tutil/event.h\n"
718 "# $attr:\tstruct perf_event_attr\tlinux/perf_event.h\n"
719 "# $sample:\tstruct perf_sample\tutil/event.h\n"
720 "# $raw_data:\tperf_sample->raw_data\tutil/event.h\n"
722 "sub process_event\n"
724 "\tmy ($event, $attr, $sample, $raw_data) = @_;\n"
726 "\tmy @event\t= unpack(\"LSS\", $event);\n"
727 "\tmy @attr\t= unpack(\"LLQQQQQLLQQ\", $attr);\n"
728 "\tmy @sample\t= unpack(\"QLLQQQQQLL\", $sample);\n"
729 "\tmy @raw_data\t= unpack(\"C*\", $raw_data);\n"
731 "\tuse Data::Dumper;\n"
732 "\tprint Dumper \\@event, \\@attr, \\@sample, \\@raw_data;\n"
737 fprintf(stderr, "generated Perl script: %s\n", fname);
742 struct scripting_ops perl_scripting_ops = {
744 .start_script = perl_start_script,
745 .flush_script = perl_flush_script,
746 .stop_script = perl_stop_script,
747 .process_event = perl_process_event,
748 .generate_script = perl_generate_script,