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 "../../perf.h"
30 #include "../thread.h"
32 #include "../trace-event.h"
38 void boot_Perf__Trace__Context(pTHX_ CV *cv);
39 void boot_DynaLoader(pTHX_ CV *cv);
40 typedef PerlInterpreter * INTERP;
46 const char *file = __FILE__;
49 newXS("Perf::Trace::Context::bootstrap", boot_Perf__Trace__Context,
51 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
56 #define FTRACE_MAX_EVENT \
57 ((1 << (sizeof(unsigned short) * 8)) - 1)
59 struct event_format *events[FTRACE_MAX_EVENT];
61 extern struct scripting_context *scripting_context;
63 static char *cur_field_name;
64 static int zero_flag_atom;
66 static void define_symbolic_value(const char *ev_name,
67 const char *field_name,
68 const char *field_value,
69 const char *field_str)
71 unsigned long long value;
74 value = eval_flag(field_value);
80 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
81 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
82 XPUSHs(sv_2mortal(newSVuv(value)));
83 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
86 if (get_cv("main::define_symbolic_value", 0))
87 call_pv("main::define_symbolic_value", G_SCALAR);
94 static void define_symbolic_values(struct print_flag_sym *field,
96 const char *field_name)
98 define_symbolic_value(ev_name, field_name, field->value, field->str);
100 define_symbolic_values(field->next, ev_name, field_name);
103 static void define_symbolic_field(const char *ev_name,
104 const char *field_name)
112 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
113 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
116 if (get_cv("main::define_symbolic_field", 0))
117 call_pv("main::define_symbolic_field", G_SCALAR);
124 static void define_flag_value(const char *ev_name,
125 const char *field_name,
126 const char *field_value,
127 const char *field_str)
129 unsigned long long value;
132 value = eval_flag(field_value);
138 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
139 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
140 XPUSHs(sv_2mortal(newSVuv(value)));
141 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
144 if (get_cv("main::define_flag_value", 0))
145 call_pv("main::define_flag_value", G_SCALAR);
152 static void define_flag_values(struct print_flag_sym *field,
154 const char *field_name)
156 define_flag_value(ev_name, field_name, field->value, field->str);
158 define_flag_values(field->next, ev_name, field_name);
161 static void define_flag_field(const char *ev_name,
162 const char *field_name,
171 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
172 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
173 XPUSHs(sv_2mortal(newSVpv(delim, 0)));
176 if (get_cv("main::define_flag_field", 0))
177 call_pv("main::define_flag_field", G_SCALAR);
184 static void define_event_symbols(struct event_format *event,
186 struct print_arg *args)
188 switch (args->type) {
192 define_flag_value(ev_name, cur_field_name, "0",
198 free(cur_field_name);
199 cur_field_name = strdup(args->field.name);
202 define_event_symbols(event, ev_name, args->flags.field);
203 define_flag_field(ev_name, cur_field_name, args->flags.delim);
204 define_flag_values(args->flags.flags, ev_name, cur_field_name);
207 define_event_symbols(event, ev_name, args->symbol.field);
208 define_symbolic_field(ev_name, cur_field_name);
209 define_symbolic_values(args->symbol.symbols, ev_name,
213 case PRINT_DYNAMIC_ARRAY:
217 define_event_symbols(event, ev_name, args->typecast.item);
220 if (strcmp(args->op.op, ":") == 0)
222 define_event_symbols(event, ev_name, args->op.left);
223 define_event_symbols(event, ev_name, args->op.right);
227 pr_err("Unsupported print arg type\n");
228 /* we should warn... */
233 define_event_symbols(event, ev_name, args->next);
236 static inline struct event_format *find_cache_event(int type)
238 static char ev_name[256];
239 struct event_format *event;
244 events[type] = event = trace_find_event(type);
248 sprintf(ev_name, "%s::%s", event->system, event->name);
250 define_event_symbols(event, ev_name, event->print_fmt.args);
255 static void perl_process_tracepoint(union perf_event *pevent __unused,
256 struct perf_sample *sample,
257 struct perf_evsel *evsel,
258 struct machine *machine __unused,
259 struct thread *thread)
261 struct format_field *field;
262 static char handler[256];
263 unsigned long long val;
265 struct event_format *event;
268 int cpu = sample->cpu;
269 void *data = sample->raw_data;
270 unsigned long long nsecs = sample->time;
271 char *comm = thread->comm;
275 if (evsel->attr.type != PERF_TYPE_TRACEPOINT)
278 type = trace_parse_common_type(data);
280 event = find_cache_event(type);
282 die("ug! no event found for type %d", type);
284 pid = trace_parse_common_pid(data);
286 sprintf(handler, "%s::%s", event->system, event->name);
288 s = nsecs / NSECS_PER_SEC;
289 ns = nsecs - s * NSECS_PER_SEC;
291 scripting_context->event_data = data;
297 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
298 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
299 XPUSHs(sv_2mortal(newSVuv(cpu)));
300 XPUSHs(sv_2mortal(newSVuv(s)));
301 XPUSHs(sv_2mortal(newSVuv(ns)));
302 XPUSHs(sv_2mortal(newSViv(pid)));
303 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
305 /* common fields other than pid can be accessed via xsub fns */
307 for (field = event->format.fields; field; field = field->next) {
308 if (field->flags & FIELD_IS_STRING) {
310 if (field->flags & FIELD_IS_DYNAMIC) {
311 offset = *(int *)(data + field->offset);
314 offset = field->offset;
315 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0)));
316 } else { /* FIELD_IS_NUMERIC */
317 val = read_size(data + field->offset, field->size);
318 if (field->flags & FIELD_IS_SIGNED) {
319 XPUSHs(sv_2mortal(newSViv(val)));
321 XPUSHs(sv_2mortal(newSVuv(val)));
328 if (get_cv(handler, 0))
329 call_pv(handler, G_SCALAR);
330 else if (get_cv("main::trace_unhandled", 0)) {
331 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
332 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
333 XPUSHs(sv_2mortal(newSVuv(cpu)));
334 XPUSHs(sv_2mortal(newSVuv(nsecs)));
335 XPUSHs(sv_2mortal(newSViv(pid)));
336 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
337 call_pv("main::trace_unhandled", G_SCALAR);
345 static void perl_process_event_generic(union perf_event *pevent __unused,
346 struct perf_sample *sample,
347 struct perf_evsel *evsel __unused,
348 struct machine *machine __unused,
349 struct thread *thread __unused)
353 if (!get_cv("process_event", 0))
359 XPUSHs(sv_2mortal(newSVpvn((const char *)pevent, pevent->header.size)));
360 XPUSHs(sv_2mortal(newSVpvn((const char *)&evsel->attr, sizeof(evsel->attr))));
361 XPUSHs(sv_2mortal(newSVpvn((const char *)sample, sizeof(*sample))));
362 XPUSHs(sv_2mortal(newSVpvn((const char *)sample->raw_data, sample->raw_size)));
364 call_pv("process_event", G_SCALAR);
371 static void perl_process_event(union perf_event *pevent,
372 struct perf_sample *sample,
373 struct perf_evsel *evsel,
374 struct machine *machine,
375 struct thread *thread)
377 perl_process_tracepoint(pevent, sample, evsel, machine, thread);
378 perl_process_event_generic(pevent, sample, evsel, machine, thread);
381 static void run_start_sub(void)
383 dSP; /* access to Perl stack */
386 if (get_cv("main::trace_begin", 0))
387 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
393 static int perl_start_script(const char *script, int argc, const char **argv)
395 const char **command_line;
398 command_line = malloc((argc + 2) * sizeof(const char *));
399 command_line[0] = "";
400 command_line[1] = script;
401 for (i = 2; i < argc + 2; i++)
402 command_line[i] = argv[i - 2];
404 my_perl = perl_alloc();
405 perl_construct(my_perl);
407 if (perl_parse(my_perl, xs_init, argc + 2, (char **)command_line,
413 if (perl_run(my_perl)) {
437 static int perl_stop_script(void)
439 dSP; /* access to Perl stack */
442 if (get_cv("main::trace_end", 0))
443 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
445 perl_destruct(my_perl);
451 static int perl_generate_script(const char *outfile)
453 struct event_format *event = NULL;
454 struct format_field *f;
455 char fname[PATH_MAX];
456 int not_first, count;
459 sprintf(fname, "%s.pl", outfile);
460 ofp = fopen(fname, "w");
462 fprintf(stderr, "couldn't open %s\n", fname);
466 fprintf(ofp, "# perf script event handlers, "
467 "generated by perf script -g perl\n");
469 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
470 " License version 2\n\n");
472 fprintf(ofp, "# The common_* event handler fields are the most useful "
473 "fields common to\n");
475 fprintf(ofp, "# all events. They don't necessarily correspond to "
476 "the 'common_*' fields\n");
478 fprintf(ofp, "# in the format files. Those fields not available as "
479 "handler params can\n");
481 fprintf(ofp, "# be retrieved using Perl functions of the form "
482 "common_*($context).\n");
484 fprintf(ofp, "# See Context.pm for the list of available "
487 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
488 "Perf-Trace-Util/lib\";\n");
490 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n");
491 fprintf(ofp, "use Perf::Trace::Core;\n");
492 fprintf(ofp, "use Perf::Trace::Context;\n");
493 fprintf(ofp, "use Perf::Trace::Util;\n\n");
495 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n");
496 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n\n");
498 while ((event = trace_find_next_event(event))) {
499 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
500 fprintf(ofp, "\tmy (");
502 fprintf(ofp, "$event_name, ");
503 fprintf(ofp, "$context, ");
504 fprintf(ofp, "$common_cpu, ");
505 fprintf(ofp, "$common_secs, ");
506 fprintf(ofp, "$common_nsecs,\n");
507 fprintf(ofp, "\t $common_pid, ");
508 fprintf(ofp, "$common_comm,\n\t ");
513 for (f = event->format.fields; f; f = f->next) {
516 if (++count % 5 == 0)
517 fprintf(ofp, "\n\t ");
519 fprintf(ofp, "$%s", f->name);
521 fprintf(ofp, ") = @_;\n\n");
523 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
524 "$common_secs, $common_nsecs,\n\t "
525 "$common_pid, $common_comm);\n\n");
527 fprintf(ofp, "\tprintf(\"");
532 for (f = event->format.fields; f; f = f->next) {
535 if (count && count % 4 == 0) {
536 fprintf(ofp, "\".\n\t \"");
540 fprintf(ofp, "%s=", f->name);
541 if (f->flags & FIELD_IS_STRING ||
542 f->flags & FIELD_IS_FLAG ||
543 f->flags & FIELD_IS_SYMBOLIC)
545 else if (f->flags & FIELD_IS_SIGNED)
551 fprintf(ofp, "\\n\",\n\t ");
556 for (f = event->format.fields; f; f = f->next) {
560 if (++count % 5 == 0)
561 fprintf(ofp, "\n\t ");
563 if (f->flags & FIELD_IS_FLAG) {
564 if ((count - 1) % 5 != 0) {
565 fprintf(ofp, "\n\t ");
568 fprintf(ofp, "flag_str(\"");
569 fprintf(ofp, "%s::%s\", ", event->system,
571 fprintf(ofp, "\"%s\", $%s)", f->name,
573 } else if (f->flags & FIELD_IS_SYMBOLIC) {
574 if ((count - 1) % 5 != 0) {
575 fprintf(ofp, "\n\t ");
578 fprintf(ofp, "symbol_str(\"");
579 fprintf(ofp, "%s::%s\", ", event->system,
581 fprintf(ofp, "\"%s\", $%s)", f->name,
584 fprintf(ofp, "$%s", f->name);
587 fprintf(ofp, ");\n");
588 fprintf(ofp, "}\n\n");
591 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
592 "$common_cpu, $common_secs, $common_nsecs,\n\t "
593 "$common_pid, $common_comm) = @_;\n\n");
595 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
596 "$common_secs, $common_nsecs,\n\t $common_pid, "
597 "$common_comm);\n}\n\n");
599 fprintf(ofp, "sub print_header\n{\n"
600 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
601 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
602 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}\n");
605 "\n# Packed byte string args of process_event():\n"
607 "# $event:\tunion perf_event\tutil/event.h\n"
608 "# $attr:\tstruct perf_event_attr\tlinux/perf_event.h\n"
609 "# $sample:\tstruct perf_sample\tutil/event.h\n"
610 "# $raw_data:\tperf_sample->raw_data\tutil/event.h\n"
612 "sub process_event\n"
614 "\tmy ($event, $attr, $sample, $raw_data) = @_;\n"
616 "\tmy @event\t= unpack(\"LSS\", $event);\n"
617 "\tmy @attr\t= unpack(\"LLQQQQQLLQQ\", $attr);\n"
618 "\tmy @sample\t= unpack(\"QLLQQQQQLL\", $sample);\n"
619 "\tmy @raw_data\t= unpack(\"C*\", $raw_data);\n"
621 "\tuse Data::Dumper;\n"
622 "\tprint Dumper \\@event, \\@attr, \\@sample, \\@raw_data;\n"
627 fprintf(stderr, "generated Perl script: %s\n", fname);
632 struct scripting_ops perl_scripting_ops = {
634 .start_script = perl_start_script,
635 .stop_script = perl_stop_script,
636 .process_event = perl_process_event,
637 .generate_script = perl_generate_script,