Loading...
1/*
2 * trace-event-perl. Feed perf script events to an embedded Perl interpreter.
3 *
4 * Copyright (C) 2009 Tom Zanussi <tzanussi@gmail.com>
5 *
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.
10 *
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.
15 *
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
19 *
20 */
21
22#include <inttypes.h>
23#include <stdio.h>
24#include <stdlib.h>
25#include <string.h>
26#include <ctype.h>
27#include <errno.h>
28#include <linux/bitmap.h>
29#include <linux/time64.h>
30#include <traceevent/event-parse.h>
31
32#include <stdbool.h>
33/* perl needs the following define, right after including stdbool.h */
34#define HAS_BOOL
35#include <EXTERN.h>
36#include <perl.h>
37
38#include "../callchain.h"
39#include "../dso.h"
40#include "../machine.h"
41#include "../map.h"
42#include "../symbol.h"
43#include "../thread.h"
44#include "../event.h"
45#include "../trace-event.h"
46#include "../evsel.h"
47#include "../debug.h"
48
49void boot_Perf__Trace__Context(pTHX_ CV *cv);
50void boot_DynaLoader(pTHX_ CV *cv);
51typedef PerlInterpreter * INTERP;
52
53void xs_init(pTHX);
54
55void xs_init(pTHX)
56{
57 const char *file = __FILE__;
58 dXSUB_SYS;
59
60 newXS("Perf::Trace::Context::bootstrap", boot_Perf__Trace__Context,
61 file);
62 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
63}
64
65INTERP my_perl;
66
67#define TRACE_EVENT_TYPE_MAX \
68 ((1 << (sizeof(unsigned short) * 8)) - 1)
69
70static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
71
72extern struct scripting_context *scripting_context;
73
74static char *cur_field_name;
75static int zero_flag_atom;
76
77static void define_symbolic_value(const char *ev_name,
78 const char *field_name,
79 const char *field_value,
80 const char *field_str)
81{
82 unsigned long long value;
83 dSP;
84
85 value = eval_flag(field_value);
86
87 ENTER;
88 SAVETMPS;
89 PUSHMARK(SP);
90
91 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
92 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
93 XPUSHs(sv_2mortal(newSVuv(value)));
94 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
95
96 PUTBACK;
97 if (get_cv("main::define_symbolic_value", 0))
98 call_pv("main::define_symbolic_value", G_SCALAR);
99 SPAGAIN;
100 PUTBACK;
101 FREETMPS;
102 LEAVE;
103}
104
105static void define_symbolic_values(struct tep_print_flag_sym *field,
106 const char *ev_name,
107 const char *field_name)
108{
109 define_symbolic_value(ev_name, field_name, field->value, field->str);
110 if (field->next)
111 define_symbolic_values(field->next, ev_name, field_name);
112}
113
114static void define_symbolic_field(const char *ev_name,
115 const char *field_name)
116{
117 dSP;
118
119 ENTER;
120 SAVETMPS;
121 PUSHMARK(SP);
122
123 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
124 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
125
126 PUTBACK;
127 if (get_cv("main::define_symbolic_field", 0))
128 call_pv("main::define_symbolic_field", G_SCALAR);
129 SPAGAIN;
130 PUTBACK;
131 FREETMPS;
132 LEAVE;
133}
134
135static void define_flag_value(const char *ev_name,
136 const char *field_name,
137 const char *field_value,
138 const char *field_str)
139{
140 unsigned long long value;
141 dSP;
142
143 value = eval_flag(field_value);
144
145 ENTER;
146 SAVETMPS;
147 PUSHMARK(SP);
148
149 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
150 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
151 XPUSHs(sv_2mortal(newSVuv(value)));
152 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
153
154 PUTBACK;
155 if (get_cv("main::define_flag_value", 0))
156 call_pv("main::define_flag_value", G_SCALAR);
157 SPAGAIN;
158 PUTBACK;
159 FREETMPS;
160 LEAVE;
161}
162
163static void define_flag_values(struct tep_print_flag_sym *field,
164 const char *ev_name,
165 const char *field_name)
166{
167 define_flag_value(ev_name, field_name, field->value, field->str);
168 if (field->next)
169 define_flag_values(field->next, ev_name, field_name);
170}
171
172static void define_flag_field(const char *ev_name,
173 const char *field_name,
174 const char *delim)
175{
176 dSP;
177
178 ENTER;
179 SAVETMPS;
180 PUSHMARK(SP);
181
182 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
183 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
184 XPUSHs(sv_2mortal(newSVpv(delim, 0)));
185
186 PUTBACK;
187 if (get_cv("main::define_flag_field", 0))
188 call_pv("main::define_flag_field", G_SCALAR);
189 SPAGAIN;
190 PUTBACK;
191 FREETMPS;
192 LEAVE;
193}
194
195static void define_event_symbols(struct tep_event *event,
196 const char *ev_name,
197 struct tep_print_arg *args)
198{
199 if (args == NULL)
200 return;
201
202 switch (args->type) {
203 case TEP_PRINT_NULL:
204 break;
205 case TEP_PRINT_ATOM:
206 define_flag_value(ev_name, cur_field_name, "0",
207 args->atom.atom);
208 zero_flag_atom = 0;
209 break;
210 case TEP_PRINT_FIELD:
211 free(cur_field_name);
212 cur_field_name = strdup(args->field.name);
213 break;
214 case TEP_PRINT_FLAGS:
215 define_event_symbols(event, ev_name, args->flags.field);
216 define_flag_field(ev_name, cur_field_name, args->flags.delim);
217 define_flag_values(args->flags.flags, ev_name, cur_field_name);
218 break;
219 case TEP_PRINT_SYMBOL:
220 define_event_symbols(event, ev_name, args->symbol.field);
221 define_symbolic_field(ev_name, cur_field_name);
222 define_symbolic_values(args->symbol.symbols, ev_name,
223 cur_field_name);
224 break;
225 case TEP_PRINT_HEX:
226 case TEP_PRINT_HEX_STR:
227 define_event_symbols(event, ev_name, args->hex.field);
228 define_event_symbols(event, ev_name, args->hex.size);
229 break;
230 case TEP_PRINT_INT_ARRAY:
231 define_event_symbols(event, ev_name, args->int_array.field);
232 define_event_symbols(event, ev_name, args->int_array.count);
233 define_event_symbols(event, ev_name, args->int_array.el_size);
234 break;
235 case TEP_PRINT_BSTRING:
236 case TEP_PRINT_DYNAMIC_ARRAY:
237 case TEP_PRINT_DYNAMIC_ARRAY_LEN:
238 case TEP_PRINT_STRING:
239 case TEP_PRINT_BITMASK:
240 break;
241 case TEP_PRINT_TYPE:
242 define_event_symbols(event, ev_name, args->typecast.item);
243 break;
244 case TEP_PRINT_OP:
245 if (strcmp(args->op.op, ":") == 0)
246 zero_flag_atom = 1;
247 define_event_symbols(event, ev_name, args->op.left);
248 define_event_symbols(event, ev_name, args->op.right);
249 break;
250 case TEP_PRINT_FUNC:
251 default:
252 pr_err("Unsupported print arg type\n");
253 /* we should warn... */
254 return;
255 }
256
257 if (args->next)
258 define_event_symbols(event, ev_name, args->next);
259}
260
261static SV *perl_process_callchain(struct perf_sample *sample,
262 struct evsel *evsel,
263 struct addr_location *al)
264{
265 AV *list;
266
267 list = newAV();
268 if (!list)
269 goto exit;
270
271 if (!symbol_conf.use_callchain || !sample->callchain)
272 goto exit;
273
274 if (thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
275 sample, NULL, NULL, scripting_max_stack) != 0) {
276 pr_err("Failed to resolve callchain. Skipping\n");
277 goto exit;
278 }
279 callchain_cursor_commit(&callchain_cursor);
280
281
282 while (1) {
283 HV *elem;
284 struct callchain_cursor_node *node;
285 node = callchain_cursor_current(&callchain_cursor);
286 if (!node)
287 break;
288
289 elem = newHV();
290 if (!elem)
291 goto exit;
292
293 if (!hv_stores(elem, "ip", newSVuv(node->ip))) {
294 hv_undef(elem);
295 goto exit;
296 }
297
298 if (node->ms.sym) {
299 HV *sym = newHV();
300 if (!sym) {
301 hv_undef(elem);
302 goto exit;
303 }
304 if (!hv_stores(sym, "start", newSVuv(node->ms.sym->start)) ||
305 !hv_stores(sym, "end", newSVuv(node->ms.sym->end)) ||
306 !hv_stores(sym, "binding", newSVuv(node->ms.sym->binding)) ||
307 !hv_stores(sym, "name", newSVpvn(node->ms.sym->name,
308 node->ms.sym->namelen)) ||
309 !hv_stores(elem, "sym", newRV_noinc((SV*)sym))) {
310 hv_undef(sym);
311 hv_undef(elem);
312 goto exit;
313 }
314 }
315
316 if (node->ms.map) {
317 struct map *map = node->ms.map;
318 const char *dsoname = "[unknown]";
319 if (map && map->dso) {
320 if (symbol_conf.show_kernel_path && map->dso->long_name)
321 dsoname = map->dso->long_name;
322 else
323 dsoname = map->dso->name;
324 }
325 if (!hv_stores(elem, "dso", newSVpv(dsoname,0))) {
326 hv_undef(elem);
327 goto exit;
328 }
329 }
330
331 callchain_cursor_advance(&callchain_cursor);
332 av_push(list, newRV_noinc((SV*)elem));
333 }
334
335exit:
336 return newRV_noinc((SV*)list);
337}
338
339static void perl_process_tracepoint(struct perf_sample *sample,
340 struct evsel *evsel,
341 struct addr_location *al)
342{
343 struct thread *thread = al->thread;
344 struct tep_event *event = evsel->tp_format;
345 struct tep_format_field *field;
346 static char handler[256];
347 unsigned long long val;
348 unsigned long s, ns;
349 int pid;
350 int cpu = sample->cpu;
351 void *data = sample->raw_data;
352 unsigned long long nsecs = sample->time;
353 const char *comm = thread__comm_str(thread);
354
355 dSP;
356
357 if (evsel->core.attr.type != PERF_TYPE_TRACEPOINT)
358 return;
359
360 if (!event) {
361 pr_debug("ug! no event found for type %" PRIu64, (u64)evsel->core.attr.config);
362 return;
363 }
364
365 pid = raw_field_value(event, "common_pid", data);
366
367 sprintf(handler, "%s::%s", event->system, event->name);
368
369 if (!__test_and_set_bit(event->id, events_defined))
370 define_event_symbols(event, handler, event->print_fmt.args);
371
372 s = nsecs / NSEC_PER_SEC;
373 ns = nsecs - s * NSEC_PER_SEC;
374
375 ENTER;
376 SAVETMPS;
377 PUSHMARK(SP);
378
379 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
380 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
381 XPUSHs(sv_2mortal(newSVuv(cpu)));
382 XPUSHs(sv_2mortal(newSVuv(s)));
383 XPUSHs(sv_2mortal(newSVuv(ns)));
384 XPUSHs(sv_2mortal(newSViv(pid)));
385 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
386 XPUSHs(sv_2mortal(perl_process_callchain(sample, evsel, al)));
387
388 /* common fields other than pid can be accessed via xsub fns */
389
390 for (field = event->format.fields; field; field = field->next) {
391 if (field->flags & TEP_FIELD_IS_STRING) {
392 int offset;
393 if (field->flags & TEP_FIELD_IS_DYNAMIC) {
394 offset = *(int *)(data + field->offset);
395 offset &= 0xffff;
396#ifdef HAVE_LIBTRACEEVENT_TEP_FIELD_IS_RELATIVE
397 if (field->flags & TEP_FIELD_IS_RELATIVE)
398 offset += field->offset + field->size;
399#endif
400 } else
401 offset = field->offset;
402 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0)));
403 } else { /* FIELD_IS_NUMERIC */
404 val = read_size(event, data + field->offset,
405 field->size);
406 if (field->flags & TEP_FIELD_IS_SIGNED) {
407 XPUSHs(sv_2mortal(newSViv(val)));
408 } else {
409 XPUSHs(sv_2mortal(newSVuv(val)));
410 }
411 }
412 }
413
414 PUTBACK;
415
416 if (get_cv(handler, 0))
417 call_pv(handler, G_SCALAR);
418 else if (get_cv("main::trace_unhandled", 0)) {
419 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
420 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
421 XPUSHs(sv_2mortal(newSVuv(cpu)));
422 XPUSHs(sv_2mortal(newSVuv(nsecs)));
423 XPUSHs(sv_2mortal(newSViv(pid)));
424 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
425 XPUSHs(sv_2mortal(perl_process_callchain(sample, evsel, al)));
426 call_pv("main::trace_unhandled", G_SCALAR);
427 }
428 SPAGAIN;
429 PUTBACK;
430 FREETMPS;
431 LEAVE;
432}
433
434static void perl_process_event_generic(union perf_event *event,
435 struct perf_sample *sample,
436 struct evsel *evsel)
437{
438 dSP;
439
440 if (!get_cv("process_event", 0))
441 return;
442
443 ENTER;
444 SAVETMPS;
445 PUSHMARK(SP);
446 XPUSHs(sv_2mortal(newSVpvn((const char *)event, event->header.size)));
447 XPUSHs(sv_2mortal(newSVpvn((const char *)&evsel->core.attr, sizeof(evsel->core.attr))));
448 XPUSHs(sv_2mortal(newSVpvn((const char *)sample, sizeof(*sample))));
449 XPUSHs(sv_2mortal(newSVpvn((const char *)sample->raw_data, sample->raw_size)));
450 PUTBACK;
451 call_pv("process_event", G_SCALAR);
452 SPAGAIN;
453 PUTBACK;
454 FREETMPS;
455 LEAVE;
456}
457
458static void perl_process_event(union perf_event *event,
459 struct perf_sample *sample,
460 struct evsel *evsel,
461 struct addr_location *al,
462 struct addr_location *addr_al)
463{
464 scripting_context__update(scripting_context, event, sample, evsel, al, addr_al);
465 perl_process_tracepoint(sample, evsel, al);
466 perl_process_event_generic(event, sample, evsel);
467}
468
469static void run_start_sub(void)
470{
471 dSP; /* access to Perl stack */
472 PUSHMARK(SP);
473
474 if (get_cv("main::trace_begin", 0))
475 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
476}
477
478/*
479 * Start trace script
480 */
481static int perl_start_script(const char *script, int argc, const char **argv,
482 struct perf_session *session)
483{
484 const char **command_line;
485 int i, err = 0;
486
487 scripting_context->session = session;
488
489 command_line = malloc((argc + 2) * sizeof(const char *));
490 command_line[0] = "";
491 command_line[1] = script;
492 for (i = 2; i < argc + 2; i++)
493 command_line[i] = argv[i - 2];
494
495 my_perl = perl_alloc();
496 perl_construct(my_perl);
497
498 if (perl_parse(my_perl, xs_init, argc + 2, (char **)command_line,
499 (char **)NULL)) {
500 err = -1;
501 goto error;
502 }
503
504 if (perl_run(my_perl)) {
505 err = -1;
506 goto error;
507 }
508
509 if (SvTRUE(ERRSV)) {
510 err = -1;
511 goto error;
512 }
513
514 run_start_sub();
515
516 free(command_line);
517 return 0;
518error:
519 perl_free(my_perl);
520 free(command_line);
521
522 return err;
523}
524
525static int perl_flush_script(void)
526{
527 return 0;
528}
529
530/*
531 * Stop trace script
532 */
533static int perl_stop_script(void)
534{
535 dSP; /* access to Perl stack */
536 PUSHMARK(SP);
537
538 if (get_cv("main::trace_end", 0))
539 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
540
541 perl_destruct(my_perl);
542 perl_free(my_perl);
543
544 return 0;
545}
546
547static int perl_generate_script(struct tep_handle *pevent, const char *outfile)
548{
549 int i, not_first, count, nr_events;
550 struct tep_event **all_events;
551 struct tep_event *event = NULL;
552 struct tep_format_field *f;
553 char fname[PATH_MAX];
554 FILE *ofp;
555
556 sprintf(fname, "%s.pl", outfile);
557 ofp = fopen(fname, "w");
558 if (ofp == NULL) {
559 fprintf(stderr, "couldn't open %s\n", fname);
560 return -1;
561 }
562
563 fprintf(ofp, "# perf script event handlers, "
564 "generated by perf script -g perl\n");
565
566 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
567 " License version 2\n\n");
568
569 fprintf(ofp, "# The common_* event handler fields are the most useful "
570 "fields common to\n");
571
572 fprintf(ofp, "# all events. They don't necessarily correspond to "
573 "the 'common_*' fields\n");
574
575 fprintf(ofp, "# in the format files. Those fields not available as "
576 "handler params can\n");
577
578 fprintf(ofp, "# be retrieved using Perl functions of the form "
579 "common_*($context).\n");
580
581 fprintf(ofp, "# See Context.pm for the list of available "
582 "functions.\n\n");
583
584 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
585 "Perf-Trace-Util/lib\";\n");
586
587 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n");
588 fprintf(ofp, "use Perf::Trace::Core;\n");
589 fprintf(ofp, "use Perf::Trace::Context;\n");
590 fprintf(ofp, "use Perf::Trace::Util;\n\n");
591
592 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n");
593 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n");
594
595
596 fprintf(ofp, "\n\
597sub print_backtrace\n\
598{\n\
599 my $callchain = shift;\n\
600 for my $node (@$callchain)\n\
601 {\n\
602 if(exists $node->{sym})\n\
603 {\n\
604 printf( \"\\t[\\%%x] \\%%s\\n\", $node->{ip}, $node->{sym}{name});\n\
605 }\n\
606 else\n\
607 {\n\
608 printf( \"\\t[\\%%x]\\n\", $node{ip});\n\
609 }\n\
610 }\n\
611}\n\n\
612");
613
614 nr_events = tep_get_events_count(pevent);
615 all_events = tep_list_events(pevent, TEP_EVENT_SORT_ID);
616
617 for (i = 0; all_events && i < nr_events; i++) {
618 event = all_events[i];
619 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
620 fprintf(ofp, "\tmy (");
621
622 fprintf(ofp, "$event_name, ");
623 fprintf(ofp, "$context, ");
624 fprintf(ofp, "$common_cpu, ");
625 fprintf(ofp, "$common_secs, ");
626 fprintf(ofp, "$common_nsecs,\n");
627 fprintf(ofp, "\t $common_pid, ");
628 fprintf(ofp, "$common_comm, ");
629 fprintf(ofp, "$common_callchain,\n\t ");
630
631 not_first = 0;
632 count = 0;
633
634 for (f = event->format.fields; f; f = f->next) {
635 if (not_first++)
636 fprintf(ofp, ", ");
637 if (++count % 5 == 0)
638 fprintf(ofp, "\n\t ");
639
640 fprintf(ofp, "$%s", f->name);
641 }
642 fprintf(ofp, ") = @_;\n\n");
643
644 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
645 "$common_secs, $common_nsecs,\n\t "
646 "$common_pid, $common_comm, $common_callchain);\n\n");
647
648 fprintf(ofp, "\tprintf(\"");
649
650 not_first = 0;
651 count = 0;
652
653 for (f = event->format.fields; f; f = f->next) {
654 if (not_first++)
655 fprintf(ofp, ", ");
656 if (count && count % 4 == 0) {
657 fprintf(ofp, "\".\n\t \"");
658 }
659 count++;
660
661 fprintf(ofp, "%s=", f->name);
662 if (f->flags & TEP_FIELD_IS_STRING ||
663 f->flags & TEP_FIELD_IS_FLAG ||
664 f->flags & TEP_FIELD_IS_SYMBOLIC)
665 fprintf(ofp, "%%s");
666 else if (f->flags & TEP_FIELD_IS_SIGNED)
667 fprintf(ofp, "%%d");
668 else
669 fprintf(ofp, "%%u");
670 }
671
672 fprintf(ofp, "\\n\",\n\t ");
673
674 not_first = 0;
675 count = 0;
676
677 for (f = event->format.fields; f; f = f->next) {
678 if (not_first++)
679 fprintf(ofp, ", ");
680
681 if (++count % 5 == 0)
682 fprintf(ofp, "\n\t ");
683
684 if (f->flags & TEP_FIELD_IS_FLAG) {
685 if ((count - 1) % 5 != 0) {
686 fprintf(ofp, "\n\t ");
687 count = 4;
688 }
689 fprintf(ofp, "flag_str(\"");
690 fprintf(ofp, "%s::%s\", ", event->system,
691 event->name);
692 fprintf(ofp, "\"%s\", $%s)", f->name,
693 f->name);
694 } else if (f->flags & TEP_FIELD_IS_SYMBOLIC) {
695 if ((count - 1) % 5 != 0) {
696 fprintf(ofp, "\n\t ");
697 count = 4;
698 }
699 fprintf(ofp, "symbol_str(\"");
700 fprintf(ofp, "%s::%s\", ", event->system,
701 event->name);
702 fprintf(ofp, "\"%s\", $%s)", f->name,
703 f->name);
704 } else
705 fprintf(ofp, "$%s", f->name);
706 }
707
708 fprintf(ofp, ");\n\n");
709
710 fprintf(ofp, "\tprint_backtrace($common_callchain);\n");
711
712 fprintf(ofp, "}\n\n");
713 }
714
715 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
716 "$common_cpu, $common_secs, $common_nsecs,\n\t "
717 "$common_pid, $common_comm, $common_callchain) = @_;\n\n");
718
719 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
720 "$common_secs, $common_nsecs,\n\t $common_pid, "
721 "$common_comm, $common_callchain);\n");
722 fprintf(ofp, "\tprint_backtrace($common_callchain);\n");
723 fprintf(ofp, "}\n\n");
724
725 fprintf(ofp, "sub print_header\n{\n"
726 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
727 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
728 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}\n");
729
730 fprintf(ofp,
731 "\n# Packed byte string args of process_event():\n"
732 "#\n"
733 "# $event:\tunion perf_event\tutil/event.h\n"
734 "# $attr:\tstruct perf_event_attr\tlinux/perf_event.h\n"
735 "# $sample:\tstruct perf_sample\tutil/event.h\n"
736 "# $raw_data:\tperf_sample->raw_data\tutil/event.h\n"
737 "\n"
738 "sub process_event\n"
739 "{\n"
740 "\tmy ($event, $attr, $sample, $raw_data) = @_;\n"
741 "\n"
742 "\tmy @event\t= unpack(\"LSS\", $event);\n"
743 "\tmy @attr\t= unpack(\"LLQQQQQLLQQ\", $attr);\n"
744 "\tmy @sample\t= unpack(\"QLLQQQQQLL\", $sample);\n"
745 "\tmy @raw_data\t= unpack(\"C*\", $raw_data);\n"
746 "\n"
747 "\tuse Data::Dumper;\n"
748 "\tprint Dumper \\@event, \\@attr, \\@sample, \\@raw_data;\n"
749 "}\n");
750
751 fclose(ofp);
752
753 fprintf(stderr, "generated Perl script: %s\n", fname);
754
755 return 0;
756}
757
758struct scripting_ops perl_scripting_ops = {
759 .name = "Perl",
760 .dirname = "perl",
761 .start_script = perl_start_script,
762 .flush_script = perl_flush_script,
763 .stop_script = perl_stop_script,
764 .process_event = perl_process_event,
765 .generate_script = perl_generate_script,
766};
1/*
2 * trace-event-perl. Feed perf script events to an embedded Perl interpreter.
3 *
4 * Copyright (C) 2009 Tom Zanussi <tzanussi@gmail.com>
5 *
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.
10 *
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.
15 *
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
19 *
20 */
21
22#include <stdio.h>
23#include <stdlib.h>
24#include <string.h>
25#include <ctype.h>
26#include <errno.h>
27
28#include "../../perf.h"
29#include "../util.h"
30#include "../thread.h"
31#include "../event.h"
32#include "../trace-event.h"
33#include "../evsel.h"
34
35#include <EXTERN.h>
36#include <perl.h>
37
38void boot_Perf__Trace__Context(pTHX_ CV *cv);
39void boot_DynaLoader(pTHX_ CV *cv);
40typedef PerlInterpreter * INTERP;
41
42void xs_init(pTHX);
43
44void xs_init(pTHX)
45{
46 const char *file = __FILE__;
47 dXSUB_SYS;
48
49 newXS("Perf::Trace::Context::bootstrap", boot_Perf__Trace__Context,
50 file);
51 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
52}
53
54INTERP my_perl;
55
56#define FTRACE_MAX_EVENT \
57 ((1 << (sizeof(unsigned short) * 8)) - 1)
58
59struct event_format *events[FTRACE_MAX_EVENT];
60
61extern struct scripting_context *scripting_context;
62
63static char *cur_field_name;
64static int zero_flag_atom;
65
66static void define_symbolic_value(const char *ev_name,
67 const char *field_name,
68 const char *field_value,
69 const char *field_str)
70{
71 unsigned long long value;
72 dSP;
73
74 value = eval_flag(field_value);
75
76 ENTER;
77 SAVETMPS;
78 PUSHMARK(SP);
79
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)));
84
85 PUTBACK;
86 if (get_cv("main::define_symbolic_value", 0))
87 call_pv("main::define_symbolic_value", G_SCALAR);
88 SPAGAIN;
89 PUTBACK;
90 FREETMPS;
91 LEAVE;
92}
93
94static void define_symbolic_values(struct print_flag_sym *field,
95 const char *ev_name,
96 const char *field_name)
97{
98 define_symbolic_value(ev_name, field_name, field->value, field->str);
99 if (field->next)
100 define_symbolic_values(field->next, ev_name, field_name);
101}
102
103static void define_symbolic_field(const char *ev_name,
104 const char *field_name)
105{
106 dSP;
107
108 ENTER;
109 SAVETMPS;
110 PUSHMARK(SP);
111
112 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
113 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
114
115 PUTBACK;
116 if (get_cv("main::define_symbolic_field", 0))
117 call_pv("main::define_symbolic_field", G_SCALAR);
118 SPAGAIN;
119 PUTBACK;
120 FREETMPS;
121 LEAVE;
122}
123
124static void define_flag_value(const char *ev_name,
125 const char *field_name,
126 const char *field_value,
127 const char *field_str)
128{
129 unsigned long long value;
130 dSP;
131
132 value = eval_flag(field_value);
133
134 ENTER;
135 SAVETMPS;
136 PUSHMARK(SP);
137
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)));
142
143 PUTBACK;
144 if (get_cv("main::define_flag_value", 0))
145 call_pv("main::define_flag_value", G_SCALAR);
146 SPAGAIN;
147 PUTBACK;
148 FREETMPS;
149 LEAVE;
150}
151
152static void define_flag_values(struct print_flag_sym *field,
153 const char *ev_name,
154 const char *field_name)
155{
156 define_flag_value(ev_name, field_name, field->value, field->str);
157 if (field->next)
158 define_flag_values(field->next, ev_name, field_name);
159}
160
161static void define_flag_field(const char *ev_name,
162 const char *field_name,
163 const char *delim)
164{
165 dSP;
166
167 ENTER;
168 SAVETMPS;
169 PUSHMARK(SP);
170
171 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
172 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
173 XPUSHs(sv_2mortal(newSVpv(delim, 0)));
174
175 PUTBACK;
176 if (get_cv("main::define_flag_field", 0))
177 call_pv("main::define_flag_field", G_SCALAR);
178 SPAGAIN;
179 PUTBACK;
180 FREETMPS;
181 LEAVE;
182}
183
184static void define_event_symbols(struct event_format *event,
185 const char *ev_name,
186 struct print_arg *args)
187{
188 switch (args->type) {
189 case PRINT_NULL:
190 break;
191 case PRINT_ATOM:
192 define_flag_value(ev_name, cur_field_name, "0",
193 args->atom.atom);
194 zero_flag_atom = 0;
195 break;
196 case PRINT_FIELD:
197 if (cur_field_name)
198 free(cur_field_name);
199 cur_field_name = strdup(args->field.name);
200 break;
201 case PRINT_FLAGS:
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);
205 break;
206 case PRINT_SYMBOL:
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,
210 cur_field_name);
211 break;
212 case PRINT_BSTRING:
213 case PRINT_DYNAMIC_ARRAY:
214 case PRINT_STRING:
215 break;
216 case PRINT_TYPE:
217 define_event_symbols(event, ev_name, args->typecast.item);
218 break;
219 case PRINT_OP:
220 if (strcmp(args->op.op, ":") == 0)
221 zero_flag_atom = 1;
222 define_event_symbols(event, ev_name, args->op.left);
223 define_event_symbols(event, ev_name, args->op.right);
224 break;
225 case PRINT_FUNC:
226 default:
227 pr_err("Unsupported print arg type\n");
228 /* we should warn... */
229 return;
230 }
231
232 if (args->next)
233 define_event_symbols(event, ev_name, args->next);
234}
235
236static inline struct event_format *find_cache_event(int type)
237{
238 static char ev_name[256];
239 struct event_format *event;
240
241 if (events[type])
242 return events[type];
243
244 events[type] = event = trace_find_event(type);
245 if (!event)
246 return NULL;
247
248 sprintf(ev_name, "%s::%s", event->system, event->name);
249
250 define_event_symbols(event, ev_name, event->print_fmt.args);
251
252 return event;
253}
254
255static 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)
260{
261 struct format_field *field;
262 static char handler[256];
263 unsigned long long val;
264 unsigned long s, ns;
265 struct event_format *event;
266 int type;
267 int pid;
268 int cpu = sample->cpu;
269 void *data = sample->raw_data;
270 unsigned long long nsecs = sample->time;
271 char *comm = thread->comm;
272
273 dSP;
274
275 if (evsel->attr.type != PERF_TYPE_TRACEPOINT)
276 return;
277
278 type = trace_parse_common_type(data);
279
280 event = find_cache_event(type);
281 if (!event)
282 die("ug! no event found for type %d", type);
283
284 pid = trace_parse_common_pid(data);
285
286 sprintf(handler, "%s::%s", event->system, event->name);
287
288 s = nsecs / NSECS_PER_SEC;
289 ns = nsecs - s * NSECS_PER_SEC;
290
291 scripting_context->event_data = data;
292
293 ENTER;
294 SAVETMPS;
295 PUSHMARK(SP);
296
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)));
304
305 /* common fields other than pid can be accessed via xsub fns */
306
307 for (field = event->format.fields; field; field = field->next) {
308 if (field->flags & FIELD_IS_STRING) {
309 int offset;
310 if (field->flags & FIELD_IS_DYNAMIC) {
311 offset = *(int *)(data + field->offset);
312 offset &= 0xffff;
313 } else
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)));
320 } else {
321 XPUSHs(sv_2mortal(newSVuv(val)));
322 }
323 }
324 }
325
326 PUTBACK;
327
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);
338 }
339 SPAGAIN;
340 PUTBACK;
341 FREETMPS;
342 LEAVE;
343}
344
345static 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)
350{
351 dSP;
352
353 if (!get_cv("process_event", 0))
354 return;
355
356 ENTER;
357 SAVETMPS;
358 PUSHMARK(SP);
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)));
363 PUTBACK;
364 call_pv("process_event", G_SCALAR);
365 SPAGAIN;
366 PUTBACK;
367 FREETMPS;
368 LEAVE;
369}
370
371static 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)
376{
377 perl_process_tracepoint(pevent, sample, evsel, machine, thread);
378 perl_process_event_generic(pevent, sample, evsel, machine, thread);
379}
380
381static void run_start_sub(void)
382{
383 dSP; /* access to Perl stack */
384 PUSHMARK(SP);
385
386 if (get_cv("main::trace_begin", 0))
387 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
388}
389
390/*
391 * Start trace script
392 */
393static int perl_start_script(const char *script, int argc, const char **argv)
394{
395 const char **command_line;
396 int i, err = 0;
397
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];
403
404 my_perl = perl_alloc();
405 perl_construct(my_perl);
406
407 if (perl_parse(my_perl, xs_init, argc + 2, (char **)command_line,
408 (char **)NULL)) {
409 err = -1;
410 goto error;
411 }
412
413 if (perl_run(my_perl)) {
414 err = -1;
415 goto error;
416 }
417
418 if (SvTRUE(ERRSV)) {
419 err = -1;
420 goto error;
421 }
422
423 run_start_sub();
424
425 free(command_line);
426 return 0;
427error:
428 perl_free(my_perl);
429 free(command_line);
430
431 return err;
432}
433
434/*
435 * Stop trace script
436 */
437static int perl_stop_script(void)
438{
439 dSP; /* access to Perl stack */
440 PUSHMARK(SP);
441
442 if (get_cv("main::trace_end", 0))
443 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
444
445 perl_destruct(my_perl);
446 perl_free(my_perl);
447
448 return 0;
449}
450
451static int perl_generate_script(const char *outfile)
452{
453 struct event_format *event = NULL;
454 struct format_field *f;
455 char fname[PATH_MAX];
456 int not_first, count;
457 FILE *ofp;
458
459 sprintf(fname, "%s.pl", outfile);
460 ofp = fopen(fname, "w");
461 if (ofp == NULL) {
462 fprintf(stderr, "couldn't open %s\n", fname);
463 return -1;
464 }
465
466 fprintf(ofp, "# perf script event handlers, "
467 "generated by perf script -g perl\n");
468
469 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
470 " License version 2\n\n");
471
472 fprintf(ofp, "# The common_* event handler fields are the most useful "
473 "fields common to\n");
474
475 fprintf(ofp, "# all events. They don't necessarily correspond to "
476 "the 'common_*' fields\n");
477
478 fprintf(ofp, "# in the format files. Those fields not available as "
479 "handler params can\n");
480
481 fprintf(ofp, "# be retrieved using Perl functions of the form "
482 "common_*($context).\n");
483
484 fprintf(ofp, "# See Context.pm for the list of available "
485 "functions.\n\n");
486
487 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
488 "Perf-Trace-Util/lib\";\n");
489
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");
494
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");
497
498 while ((event = trace_find_next_event(event))) {
499 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
500 fprintf(ofp, "\tmy (");
501
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 ");
509
510 not_first = 0;
511 count = 0;
512
513 for (f = event->format.fields; f; f = f->next) {
514 if (not_first++)
515 fprintf(ofp, ", ");
516 if (++count % 5 == 0)
517 fprintf(ofp, "\n\t ");
518
519 fprintf(ofp, "$%s", f->name);
520 }
521 fprintf(ofp, ") = @_;\n\n");
522
523 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
524 "$common_secs, $common_nsecs,\n\t "
525 "$common_pid, $common_comm);\n\n");
526
527 fprintf(ofp, "\tprintf(\"");
528
529 not_first = 0;
530 count = 0;
531
532 for (f = event->format.fields; f; f = f->next) {
533 if (not_first++)
534 fprintf(ofp, ", ");
535 if (count && count % 4 == 0) {
536 fprintf(ofp, "\".\n\t \"");
537 }
538 count++;
539
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)
544 fprintf(ofp, "%%s");
545 else if (f->flags & FIELD_IS_SIGNED)
546 fprintf(ofp, "%%d");
547 else
548 fprintf(ofp, "%%u");
549 }
550
551 fprintf(ofp, "\\n\",\n\t ");
552
553 not_first = 0;
554 count = 0;
555
556 for (f = event->format.fields; f; f = f->next) {
557 if (not_first++)
558 fprintf(ofp, ", ");
559
560 if (++count % 5 == 0)
561 fprintf(ofp, "\n\t ");
562
563 if (f->flags & FIELD_IS_FLAG) {
564 if ((count - 1) % 5 != 0) {
565 fprintf(ofp, "\n\t ");
566 count = 4;
567 }
568 fprintf(ofp, "flag_str(\"");
569 fprintf(ofp, "%s::%s\", ", event->system,
570 event->name);
571 fprintf(ofp, "\"%s\", $%s)", f->name,
572 f->name);
573 } else if (f->flags & FIELD_IS_SYMBOLIC) {
574 if ((count - 1) % 5 != 0) {
575 fprintf(ofp, "\n\t ");
576 count = 4;
577 }
578 fprintf(ofp, "symbol_str(\"");
579 fprintf(ofp, "%s::%s\", ", event->system,
580 event->name);
581 fprintf(ofp, "\"%s\", $%s)", f->name,
582 f->name);
583 } else
584 fprintf(ofp, "$%s", f->name);
585 }
586
587 fprintf(ofp, ");\n");
588 fprintf(ofp, "}\n\n");
589 }
590
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");
594
595 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
596 "$common_secs, $common_nsecs,\n\t $common_pid, "
597 "$common_comm);\n}\n\n");
598
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");
603
604 fprintf(ofp,
605 "\n# Packed byte string args of process_event():\n"
606 "#\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"
611 "\n"
612 "sub process_event\n"
613 "{\n"
614 "\tmy ($event, $attr, $sample, $raw_data) = @_;\n"
615 "\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"
620 "\n"
621 "\tuse Data::Dumper;\n"
622 "\tprint Dumper \\@event, \\@attr, \\@sample, \\@raw_data;\n"
623 "}\n");
624
625 fclose(ofp);
626
627 fprintf(stderr, "generated Perl script: %s\n", fname);
628
629 return 0;
630}
631
632struct scripting_ops perl_scripting_ops = {
633 .name = "Perl",
634 .start_script = perl_start_script,
635 .stop_script = perl_stop_script,
636 .process_event = perl_process_event,
637 .generate_script = perl_generate_script,
638};