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 <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 extern struct scripting_context *scripting_context;
72 static char *cur_field_name;
73 static int zero_flag_atom;
75 static void define_symbolic_value(const char *ev_name,
76 const char *field_name,
77 const char *field_value,
78 const char *field_str)
80 unsigned long long value;
83 value = eval_flag(field_value);
89 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
90 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
91 XPUSHs(sv_2mortal(newSVuv(value)));
92 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
95 if (get_cv("main::define_symbolic_value", 0))
96 call_pv("main::define_symbolic_value", G_SCALAR);
103 static void define_symbolic_values(struct tep_print_flag_sym *field,
105 const char *field_name)
107 define_symbolic_value(ev_name, field_name, field->value, field->str);
109 define_symbolic_values(field->next, ev_name, field_name);
112 static void define_symbolic_field(const char *ev_name,
113 const char *field_name)
121 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
122 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
125 if (get_cv("main::define_symbolic_field", 0))
126 call_pv("main::define_symbolic_field", G_SCALAR);
133 static void define_flag_value(const char *ev_name,
134 const char *field_name,
135 const char *field_value,
136 const char *field_str)
138 unsigned long long value;
141 value = eval_flag(field_value);
147 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
148 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
149 XPUSHs(sv_2mortal(newSVuv(value)));
150 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
153 if (get_cv("main::define_flag_value", 0))
154 call_pv("main::define_flag_value", G_SCALAR);
161 static void define_flag_values(struct tep_print_flag_sym *field,
163 const char *field_name)
165 define_flag_value(ev_name, field_name, field->value, field->str);
167 define_flag_values(field->next, ev_name, field_name);
170 static void define_flag_field(const char *ev_name,
171 const char *field_name,
180 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
181 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
182 XPUSHs(sv_2mortal(newSVpv(delim, 0)));
185 if (get_cv("main::define_flag_field", 0))
186 call_pv("main::define_flag_field", G_SCALAR);
193 static void define_event_symbols(struct tep_event *event,
195 struct tep_print_arg *args)
200 switch (args->type) {
204 define_flag_value(ev_name, cur_field_name, "0",
208 case TEP_PRINT_FIELD:
209 free(cur_field_name);
210 cur_field_name = strdup(args->field.name);
212 case TEP_PRINT_FLAGS:
213 define_event_symbols(event, ev_name, args->flags.field);
214 define_flag_field(ev_name, cur_field_name, args->flags.delim);
215 define_flag_values(args->flags.flags, ev_name, cur_field_name);
217 case TEP_PRINT_SYMBOL:
218 define_event_symbols(event, ev_name, args->symbol.field);
219 define_symbolic_field(ev_name, cur_field_name);
220 define_symbolic_values(args->symbol.symbols, ev_name,
224 case TEP_PRINT_HEX_STR:
225 define_event_symbols(event, ev_name, args->hex.field);
226 define_event_symbols(event, ev_name, args->hex.size);
228 case TEP_PRINT_INT_ARRAY:
229 define_event_symbols(event, ev_name, args->int_array.field);
230 define_event_symbols(event, ev_name, args->int_array.count);
231 define_event_symbols(event, ev_name, args->int_array.el_size);
233 case TEP_PRINT_BSTRING:
234 case TEP_PRINT_DYNAMIC_ARRAY:
235 case TEP_PRINT_DYNAMIC_ARRAY_LEN:
236 case TEP_PRINT_STRING:
237 case TEP_PRINT_BITMASK:
240 define_event_symbols(event, ev_name, args->typecast.item);
243 if (strcmp(args->op.op, ":") == 0)
245 define_event_symbols(event, ev_name, args->op.left);
246 define_event_symbols(event, ev_name, args->op.right);
250 pr_err("Unsupported print arg type\n");
251 /* we should warn... */
256 define_event_symbols(event, ev_name, args->next);
259 static SV *perl_process_callchain(struct perf_sample *sample,
261 struct addr_location *al)
263 struct callchain_cursor *cursor;
270 if (!symbol_conf.use_callchain || !sample->callchain)
273 cursor = get_tls_callchain_cursor();
275 if (thread__resolve_callchain(al->thread, cursor, evsel,
276 sample, NULL, NULL, scripting_max_stack) != 0) {
277 pr_err("Failed to resolve callchain. Skipping\n");
280 callchain_cursor_commit(cursor);
285 struct callchain_cursor_node *node;
286 node = callchain_cursor_current(cursor);
294 if (!hv_stores(elem, "ip", newSVuv(node->ip))) {
305 if (!hv_stores(sym, "start", newSVuv(node->ms.sym->start)) ||
306 !hv_stores(sym, "end", newSVuv(node->ms.sym->end)) ||
307 !hv_stores(sym, "binding", newSVuv(node->ms.sym->binding)) ||
308 !hv_stores(sym, "name", newSVpvn(node->ms.sym->name,
309 node->ms.sym->namelen)) ||
310 !hv_stores(elem, "sym", newRV_noinc((SV*)sym))) {
318 struct map *map = node->ms.map;
319 struct dso *dso = map ? map__dso(map) : NULL;
320 const char *dsoname = "[unknown]";
323 if (symbol_conf.show_kernel_path && dso__long_name(dso))
324 dsoname = dso__long_name(dso);
326 dsoname = dso__name(dso);
328 if (!hv_stores(elem, "dso", newSVpv(dsoname,0))) {
334 callchain_cursor_advance(cursor);
335 av_push(list, newRV_noinc((SV*)elem));
339 return newRV_noinc((SV*)list);
342 static void perl_process_tracepoint(struct perf_sample *sample,
344 struct addr_location *al)
346 struct thread *thread = al->thread;
347 struct tep_event *event;
348 struct tep_format_field *field;
349 static char handler[256];
350 unsigned long long val;
353 int cpu = sample->cpu;
354 void *data = sample->raw_data;
355 unsigned long long nsecs = sample->time;
356 const char *comm = thread__comm_str(thread);
357 DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
359 bitmap_zero(events_defined, TRACE_EVENT_TYPE_MAX);
362 if (evsel->core.attr.type != PERF_TYPE_TRACEPOINT)
365 event = evsel__tp_format(evsel);
367 pr_debug("ug! no event found for type %" PRIu64, (u64)evsel->core.attr.config);
371 pid = raw_field_value(event, "common_pid", data);
373 sprintf(handler, "%s::%s", event->system, event->name);
375 if (!__test_and_set_bit(event->id, events_defined))
376 define_event_symbols(event, handler, event->print_fmt.args);
378 s = nsecs / NSEC_PER_SEC;
379 ns = nsecs - s * NSEC_PER_SEC;
385 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
386 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
387 XPUSHs(sv_2mortal(newSVuv(cpu)));
388 XPUSHs(sv_2mortal(newSVuv(s)));
389 XPUSHs(sv_2mortal(newSVuv(ns)));
390 XPUSHs(sv_2mortal(newSViv(pid)));
391 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
392 XPUSHs(sv_2mortal(perl_process_callchain(sample, evsel, al)));
394 /* common fields other than pid can be accessed via xsub fns */
396 for (field = event->format.fields; field; field = field->next) {
397 if (field->flags & TEP_FIELD_IS_STRING) {
399 if (field->flags & TEP_FIELD_IS_DYNAMIC) {
400 offset = *(int *)(data + field->offset);
402 if (tep_field_is_relative(field->flags))
403 offset += field->offset + field->size;
405 offset = field->offset;
406 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0)));
407 } else { /* FIELD_IS_NUMERIC */
408 val = read_size(event, data + field->offset,
410 if (field->flags & TEP_FIELD_IS_SIGNED) {
411 XPUSHs(sv_2mortal(newSViv(val)));
413 XPUSHs(sv_2mortal(newSVuv(val)));
420 if (get_cv(handler, 0))
421 call_pv(handler, G_SCALAR);
422 else if (get_cv("main::trace_unhandled", 0)) {
423 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
424 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
425 XPUSHs(sv_2mortal(newSVuv(cpu)));
426 XPUSHs(sv_2mortal(newSVuv(nsecs)));
427 XPUSHs(sv_2mortal(newSViv(pid)));
428 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
429 XPUSHs(sv_2mortal(perl_process_callchain(sample, evsel, al)));
430 call_pv("main::trace_unhandled", G_SCALAR);
438 static void perl_process_event_generic(union perf_event *event,
439 struct perf_sample *sample,
444 if (!get_cv("process_event", 0))
450 XPUSHs(sv_2mortal(newSVpvn((const char *)event, event->header.size)));
451 XPUSHs(sv_2mortal(newSVpvn((const char *)&evsel->core.attr, sizeof(evsel->core.attr))));
452 XPUSHs(sv_2mortal(newSVpvn((const char *)sample, sizeof(*sample))));
453 XPUSHs(sv_2mortal(newSVpvn((const char *)sample->raw_data, sample->raw_size)));
455 call_pv("process_event", G_SCALAR);
462 static void perl_process_event(union perf_event *event,
463 struct perf_sample *sample,
465 struct addr_location *al,
466 struct addr_location *addr_al)
468 scripting_context__update(scripting_context, event, sample, evsel, al, addr_al);
469 perl_process_tracepoint(sample, evsel, al);
470 perl_process_event_generic(event, sample, evsel);
473 static void run_start_sub(void)
475 dSP; /* access to Perl stack */
478 if (get_cv("main::trace_begin", 0))
479 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
485 static int perl_start_script(const char *script, int argc, const char **argv,
486 struct perf_session *session)
488 const char **command_line;
491 scripting_context->session = session;
493 command_line = malloc((argc + 2) * sizeof(const char *));
497 command_line[0] = "";
498 command_line[1] = script;
499 for (i = 2; i < argc + 2; i++)
500 command_line[i] = argv[i - 2];
502 my_perl = perl_alloc();
503 perl_construct(my_perl);
505 if (perl_parse(my_perl, xs_init, argc + 2, (char **)command_line,
511 if (perl_run(my_perl)) {
532 static int perl_flush_script(void)
540 static int perl_stop_script(void)
542 dSP; /* access to Perl stack */
545 if (get_cv("main::trace_end", 0))
546 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
548 perl_destruct(my_perl);
554 static int perl_generate_script(struct tep_handle *pevent, const char *outfile)
556 int i, not_first, count, nr_events;
557 struct tep_event **all_events;
558 struct tep_event *event = NULL;
559 struct tep_format_field *f;
560 char fname[PATH_MAX];
563 sprintf(fname, "%s.pl", outfile);
564 ofp = fopen(fname, "w");
566 fprintf(stderr, "couldn't open %s\n", fname);
570 fprintf(ofp, "# perf script event handlers, "
571 "generated by perf script -g perl\n");
573 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
574 " License version 2\n\n");
576 fprintf(ofp, "# The common_* event handler fields are the most useful "
577 "fields common to\n");
579 fprintf(ofp, "# all events. They don't necessarily correspond to "
580 "the 'common_*' fields\n");
582 fprintf(ofp, "# in the format files. Those fields not available as "
583 "handler params can\n");
585 fprintf(ofp, "# be retrieved using Perl functions of the form "
586 "common_*($context).\n");
588 fprintf(ofp, "# See Context.pm for the list of available "
591 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
592 "Perf-Trace-Util/lib\";\n");
594 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n");
595 fprintf(ofp, "use Perf::Trace::Core;\n");
596 fprintf(ofp, "use Perf::Trace::Context;\n");
597 fprintf(ofp, "use Perf::Trace::Util;\n\n");
599 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n");
600 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n");
604 sub print_backtrace\n\
606 my $callchain = shift;\n\
607 for my $node (@$callchain)\n\
609 if(exists $node->{sym})\n\
611 printf( \"\\t[\\%%x] \\%%s\\n\", $node->{ip}, $node->{sym}{name});\n\
615 printf( \"\\t[\\%%x]\\n\", $node{ip});\n\
621 nr_events = tep_get_events_count(pevent);
622 all_events = tep_list_events(pevent, TEP_EVENT_SORT_ID);
624 for (i = 0; all_events && i < nr_events; i++) {
625 event = all_events[i];
626 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
627 fprintf(ofp, "\tmy (");
629 fprintf(ofp, "$event_name, ");
630 fprintf(ofp, "$context, ");
631 fprintf(ofp, "$common_cpu, ");
632 fprintf(ofp, "$common_secs, ");
633 fprintf(ofp, "$common_nsecs,\n");
634 fprintf(ofp, "\t $common_pid, ");
635 fprintf(ofp, "$common_comm, ");
636 fprintf(ofp, "$common_callchain,\n\t ");
641 for (f = event->format.fields; f; f = f->next) {
644 if (++count % 5 == 0)
645 fprintf(ofp, "\n\t ");
647 fprintf(ofp, "$%s", f->name);
649 fprintf(ofp, ") = @_;\n\n");
651 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
652 "$common_secs, $common_nsecs,\n\t "
653 "$common_pid, $common_comm, $common_callchain);\n\n");
655 fprintf(ofp, "\tprintf(\"");
660 for (f = event->format.fields; f; f = f->next) {
663 if (count && count % 4 == 0) {
664 fprintf(ofp, "\".\n\t \"");
668 fprintf(ofp, "%s=", f->name);
669 if (f->flags & TEP_FIELD_IS_STRING ||
670 f->flags & TEP_FIELD_IS_FLAG ||
671 f->flags & TEP_FIELD_IS_SYMBOLIC)
673 else if (f->flags & TEP_FIELD_IS_SIGNED)
679 fprintf(ofp, "\\n\",\n\t ");
684 for (f = event->format.fields; f; f = f->next) {
688 if (++count % 5 == 0)
689 fprintf(ofp, "\n\t ");
691 if (f->flags & TEP_FIELD_IS_FLAG) {
692 if ((count - 1) % 5 != 0) {
693 fprintf(ofp, "\n\t ");
696 fprintf(ofp, "flag_str(\"");
697 fprintf(ofp, "%s::%s\", ", event->system,
699 fprintf(ofp, "\"%s\", $%s)", f->name,
701 } else if (f->flags & TEP_FIELD_IS_SYMBOLIC) {
702 if ((count - 1) % 5 != 0) {
703 fprintf(ofp, "\n\t ");
706 fprintf(ofp, "symbol_str(\"");
707 fprintf(ofp, "%s::%s\", ", event->system,
709 fprintf(ofp, "\"%s\", $%s)", f->name,
712 fprintf(ofp, "$%s", f->name);
715 fprintf(ofp, ");\n\n");
717 fprintf(ofp, "\tprint_backtrace($common_callchain);\n");
719 fprintf(ofp, "}\n\n");
722 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
723 "$common_cpu, $common_secs, $common_nsecs,\n\t "
724 "$common_pid, $common_comm, $common_callchain) = @_;\n\n");
726 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
727 "$common_secs, $common_nsecs,\n\t $common_pid, "
728 "$common_comm, $common_callchain);\n");
729 fprintf(ofp, "\tprint_backtrace($common_callchain);\n");
730 fprintf(ofp, "}\n\n");
732 fprintf(ofp, "sub print_header\n{\n"
733 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
734 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
735 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}\n");
738 "\n# Packed byte string args of process_event():\n"
740 "# $event:\tunion perf_event\tutil/event.h\n"
741 "# $attr:\tstruct perf_event_attr\tlinux/perf_event.h\n"
742 "# $sample:\tstruct perf_sample\tutil/event.h\n"
743 "# $raw_data:\tperf_sample->raw_data\tutil/event.h\n"
745 "sub process_event\n"
747 "\tmy ($event, $attr, $sample, $raw_data) = @_;\n"
749 "\tmy @event\t= unpack(\"LSS\", $event);\n"
750 "\tmy @attr\t= unpack(\"LLQQQQQLLQQ\", $attr);\n"
751 "\tmy @sample\t= unpack(\"QLLQQQQQLL\", $sample);\n"
752 "\tmy @raw_data\t= unpack(\"C*\", $raw_data);\n"
754 "\tuse Data::Dumper;\n"
755 "\tprint Dumper \\@event, \\@attr, \\@sample, \\@raw_data;\n"
760 fprintf(stderr, "generated Perl script: %s\n", fname);
765 struct scripting_ops perl_scripting_ops = {
768 .start_script = perl_start_script,
769 .flush_script = perl_flush_script,
770 .stop_script = perl_stop_script,
771 .process_event = perl_process_event,
772 .generate_script = perl_generate_script,