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
);
237 struct event_format
*find_cache_event(struct pevent
*pevent
, int type
)
239 static char ev_name
[256];
240 struct event_format
*event
;
245 events
[type
] = event
= pevent_find_event(pevent
, type
);
249 sprintf(ev_name
, "%s::%s", event
->system
, event
->name
);
251 define_event_symbols(event
, ev_name
, event
->print_fmt
.args
);
256 static void perl_process_tracepoint(union perf_event
*perf_event __unused
,
257 struct pevent
*pevent
,
258 struct perf_sample
*sample
,
259 struct perf_evsel
*evsel
,
260 struct machine
*machine __unused
,
261 struct thread
*thread
)
263 struct format_field
*field
;
264 static char handler
[256];
265 unsigned long long val
;
267 struct event_format
*event
;
270 int cpu
= sample
->cpu
;
271 void *data
= sample
->raw_data
;
272 unsigned long long nsecs
= sample
->time
;
273 char *comm
= thread
->comm
;
277 if (evsel
->attr
.type
!= PERF_TYPE_TRACEPOINT
)
280 type
= trace_parse_common_type(pevent
, data
);
282 event
= find_cache_event(pevent
, type
);
284 die("ug! no event found for type %d", type
);
286 pid
= trace_parse_common_pid(pevent
, data
);
288 sprintf(handler
, "%s::%s", event
->system
, event
->name
);
290 s
= nsecs
/ NSECS_PER_SEC
;
291 ns
= nsecs
- s
* NSECS_PER_SEC
;
293 scripting_context
->event_data
= data
;
299 XPUSHs(sv_2mortal(newSVpv(handler
, 0)));
300 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context
))));
301 XPUSHs(sv_2mortal(newSVuv(cpu
)));
302 XPUSHs(sv_2mortal(newSVuv(s
)));
303 XPUSHs(sv_2mortal(newSVuv(ns
)));
304 XPUSHs(sv_2mortal(newSViv(pid
)));
305 XPUSHs(sv_2mortal(newSVpv(comm
, 0)));
307 /* common fields other than pid can be accessed via xsub fns */
309 for (field
= event
->format
.fields
; field
; field
= field
->next
) {
310 if (field
->flags
& FIELD_IS_STRING
) {
312 if (field
->flags
& FIELD_IS_DYNAMIC
) {
313 offset
= *(int *)(data
+ field
->offset
);
316 offset
= field
->offset
;
317 XPUSHs(sv_2mortal(newSVpv((char *)data
+ offset
, 0)));
318 } else { /* FIELD_IS_NUMERIC */
319 val
= read_size(pevent
, data
+ field
->offset
,
321 if (field
->flags
& FIELD_IS_SIGNED
) {
322 XPUSHs(sv_2mortal(newSViv(val
)));
324 XPUSHs(sv_2mortal(newSVuv(val
)));
331 if (get_cv(handler
, 0))
332 call_pv(handler
, G_SCALAR
);
333 else if (get_cv("main::trace_unhandled", 0)) {
334 XPUSHs(sv_2mortal(newSVpv(handler
, 0)));
335 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context
))));
336 XPUSHs(sv_2mortal(newSVuv(cpu
)));
337 XPUSHs(sv_2mortal(newSVuv(nsecs
)));
338 XPUSHs(sv_2mortal(newSViv(pid
)));
339 XPUSHs(sv_2mortal(newSVpv(comm
, 0)));
340 call_pv("main::trace_unhandled", G_SCALAR
);
348 static void perl_process_event_generic(union perf_event
*pevent __unused
,
349 struct perf_sample
*sample
,
350 struct perf_evsel
*evsel __unused
,
351 struct machine
*machine __unused
,
352 struct thread
*thread __unused
)
356 if (!get_cv("process_event", 0))
362 XPUSHs(sv_2mortal(newSVpvn((const char *)pevent
, pevent
->header
.size
)));
363 XPUSHs(sv_2mortal(newSVpvn((const char *)&evsel
->attr
, sizeof(evsel
->attr
))));
364 XPUSHs(sv_2mortal(newSVpvn((const char *)sample
, sizeof(*sample
))));
365 XPUSHs(sv_2mortal(newSVpvn((const char *)sample
->raw_data
, sample
->raw_size
)));
367 call_pv("process_event", G_SCALAR
);
374 static void perl_process_event(union perf_event
*event
,
375 struct pevent
*pevent
,
376 struct perf_sample
*sample
,
377 struct perf_evsel
*evsel
,
378 struct machine
*machine
,
379 struct thread
*thread
)
381 perl_process_tracepoint(event
, pevent
, sample
, evsel
, machine
, thread
);
382 perl_process_event_generic(event
, sample
, evsel
, machine
, thread
);
385 static void run_start_sub(void)
387 dSP
; /* access to Perl stack */
390 if (get_cv("main::trace_begin", 0))
391 call_pv("main::trace_begin", G_DISCARD
| G_NOARGS
);
397 static int perl_start_script(const char *script
, int argc
, const char **argv
)
399 const char **command_line
;
402 command_line
= malloc((argc
+ 2) * sizeof(const char *));
403 command_line
[0] = "";
404 command_line
[1] = script
;
405 for (i
= 2; i
< argc
+ 2; i
++)
406 command_line
[i
] = argv
[i
- 2];
408 my_perl
= perl_alloc();
409 perl_construct(my_perl
);
411 if (perl_parse(my_perl
, xs_init
, argc
+ 2, (char **)command_line
,
417 if (perl_run(my_perl
)) {
441 static int perl_stop_script(void)
443 dSP
; /* access to Perl stack */
446 if (get_cv("main::trace_end", 0))
447 call_pv("main::trace_end", G_DISCARD
| G_NOARGS
);
449 perl_destruct(my_perl
);
455 static int perl_generate_script(struct pevent
*pevent
, const char *outfile
)
457 struct event_format
*event
= NULL
;
458 struct format_field
*f
;
459 char fname
[PATH_MAX
];
460 int not_first
, count
;
463 sprintf(fname
, "%s.pl", outfile
);
464 ofp
= fopen(fname
, "w");
466 fprintf(stderr
, "couldn't open %s\n", fname
);
470 fprintf(ofp
, "# perf script event handlers, "
471 "generated by perf script -g perl\n");
473 fprintf(ofp
, "# Licensed under the terms of the GNU GPL"
474 " License version 2\n\n");
476 fprintf(ofp
, "# The common_* event handler fields are the most useful "
477 "fields common to\n");
479 fprintf(ofp
, "# all events. They don't necessarily correspond to "
480 "the 'common_*' fields\n");
482 fprintf(ofp
, "# in the format files. Those fields not available as "
483 "handler params can\n");
485 fprintf(ofp
, "# be retrieved using Perl functions of the form "
486 "common_*($context).\n");
488 fprintf(ofp
, "# See Context.pm for the list of available "
491 fprintf(ofp
, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
492 "Perf-Trace-Util/lib\";\n");
494 fprintf(ofp
, "use lib \"./Perf-Trace-Util/lib\";\n");
495 fprintf(ofp
, "use Perf::Trace::Core;\n");
496 fprintf(ofp
, "use Perf::Trace::Context;\n");
497 fprintf(ofp
, "use Perf::Trace::Util;\n\n");
499 fprintf(ofp
, "sub trace_begin\n{\n\t# optional\n}\n\n");
500 fprintf(ofp
, "sub trace_end\n{\n\t# optional\n}\n\n");
502 while ((event
= trace_find_next_event(pevent
, event
))) {
503 fprintf(ofp
, "sub %s::%s\n{\n", event
->system
, event
->name
);
504 fprintf(ofp
, "\tmy (");
506 fprintf(ofp
, "$event_name, ");
507 fprintf(ofp
, "$context, ");
508 fprintf(ofp
, "$common_cpu, ");
509 fprintf(ofp
, "$common_secs, ");
510 fprintf(ofp
, "$common_nsecs,\n");
511 fprintf(ofp
, "\t $common_pid, ");
512 fprintf(ofp
, "$common_comm,\n\t ");
517 for (f
= event
->format
.fields
; f
; f
= f
->next
) {
520 if (++count
% 5 == 0)
521 fprintf(ofp
, "\n\t ");
523 fprintf(ofp
, "$%s", f
->name
);
525 fprintf(ofp
, ") = @_;\n\n");
527 fprintf(ofp
, "\tprint_header($event_name, $common_cpu, "
528 "$common_secs, $common_nsecs,\n\t "
529 "$common_pid, $common_comm);\n\n");
531 fprintf(ofp
, "\tprintf(\"");
536 for (f
= event
->format
.fields
; f
; f
= f
->next
) {
539 if (count
&& count
% 4 == 0) {
540 fprintf(ofp
, "\".\n\t \"");
544 fprintf(ofp
, "%s=", f
->name
);
545 if (f
->flags
& FIELD_IS_STRING
||
546 f
->flags
& FIELD_IS_FLAG
||
547 f
->flags
& FIELD_IS_SYMBOLIC
)
549 else if (f
->flags
& FIELD_IS_SIGNED
)
555 fprintf(ofp
, "\\n\",\n\t ");
560 for (f
= event
->format
.fields
; f
; f
= f
->next
) {
564 if (++count
% 5 == 0)
565 fprintf(ofp
, "\n\t ");
567 if (f
->flags
& FIELD_IS_FLAG
) {
568 if ((count
- 1) % 5 != 0) {
569 fprintf(ofp
, "\n\t ");
572 fprintf(ofp
, "flag_str(\"");
573 fprintf(ofp
, "%s::%s\", ", event
->system
,
575 fprintf(ofp
, "\"%s\", $%s)", f
->name
,
577 } else if (f
->flags
& FIELD_IS_SYMBOLIC
) {
578 if ((count
- 1) % 5 != 0) {
579 fprintf(ofp
, "\n\t ");
582 fprintf(ofp
, "symbol_str(\"");
583 fprintf(ofp
, "%s::%s\", ", event
->system
,
585 fprintf(ofp
, "\"%s\", $%s)", f
->name
,
588 fprintf(ofp
, "$%s", f
->name
);
591 fprintf(ofp
, ");\n");
592 fprintf(ofp
, "}\n\n");
595 fprintf(ofp
, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
596 "$common_cpu, $common_secs, $common_nsecs,\n\t "
597 "$common_pid, $common_comm) = @_;\n\n");
599 fprintf(ofp
, "\tprint_header($event_name, $common_cpu, "
600 "$common_secs, $common_nsecs,\n\t $common_pid, "
601 "$common_comm);\n}\n\n");
603 fprintf(ofp
, "sub print_header\n{\n"
604 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
605 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
606 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}\n");
609 "\n# Packed byte string args of process_event():\n"
611 "# $event:\tunion perf_event\tutil/event.h\n"
612 "# $attr:\tstruct perf_event_attr\tlinux/perf_event.h\n"
613 "# $sample:\tstruct perf_sample\tutil/event.h\n"
614 "# $raw_data:\tperf_sample->raw_data\tutil/event.h\n"
616 "sub process_event\n"
618 "\tmy ($event, $attr, $sample, $raw_data) = @_;\n"
620 "\tmy @event\t= unpack(\"LSS\", $event);\n"
621 "\tmy @attr\t= unpack(\"LLQQQQQLLQQ\", $attr);\n"
622 "\tmy @sample\t= unpack(\"QLLQQQQQLL\", $sample);\n"
623 "\tmy @raw_data\t= unpack(\"C*\", $raw_data);\n"
625 "\tuse Data::Dumper;\n"
626 "\tprint Dumper \\@event, \\@attr, \\@sample, \\@raw_data;\n"
631 fprintf(stderr
, "generated Perl script: %s\n", fname
);
636 struct scripting_ops perl_scripting_ops
= {
638 .start_script
= perl_start_script
,
639 .stop_script
= perl_stop_script
,
640 .process_event
= perl_process_event
,
641 .generate_script
= perl_generate_script
,