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 <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};