1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22#include <stdio.h>
23#include <stdlib.h>
24#include <string.h>
25#include <ctype.h>
26#include <errno.h>
27#include <linux/bitmap.h>
28
29#include "../util.h"
30#include <EXTERN.h>
31#include <perl.h>
32
33#include "../../perf.h"
34#include "../thread.h"
35#include "../event.h"
36#include "../trace-event.h"
37#include "../evsel.h"
38#include "../debug.h"
39
40void boot_Perf__Trace__Context(pTHX_ CV *cv);
41void boot_DynaLoader(pTHX_ CV *cv);
42typedef PerlInterpreter * INTERP;
43
44void xs_init(pTHX);
45
46void xs_init(pTHX)
47{
48 const char *file = __FILE__;
49 dXSUB_SYS;
50
51 newXS("Perf::Trace::Context::bootstrap", boot_Perf__Trace__Context,
52 file);
53 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
54}
55
56INTERP my_perl;
57
58#define FTRACE_MAX_EVENT \
59 ((1 << (sizeof(unsigned short) * 8)) - 1)
60
61static DECLARE_BITMAP(events_defined, FTRACE_MAX_EVENT);
62
63extern struct scripting_context *scripting_context;
64
65static char *cur_field_name;
66static int zero_flag_atom;
67
68static void define_symbolic_value(const char *ev_name,
69 const char *field_name,
70 const char *field_value,
71 const char *field_str)
72{
73 unsigned long long value;
74 dSP;
75
76 value = eval_flag(field_value);
77
78 ENTER;
79 SAVETMPS;
80 PUSHMARK(SP);
81
82 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
83 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
84 XPUSHs(sv_2mortal(newSVuv(value)));
85 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
86
87 PUTBACK;
88 if (get_cv("main::define_symbolic_value", 0))
89 call_pv("main::define_symbolic_value", G_SCALAR);
90 SPAGAIN;
91 PUTBACK;
92 FREETMPS;
93 LEAVE;
94}
95
96static void define_symbolic_values(struct print_flag_sym *field,
97 const char *ev_name,
98 const char *field_name)
99{
100 define_symbolic_value(ev_name, field_name, field->value, field->str);
101 if (field->next)
102 define_symbolic_values(field->next, ev_name, field_name);
103}
104
105static void define_symbolic_field(const char *ev_name,
106 const char *field_name)
107{
108 dSP;
109
110 ENTER;
111 SAVETMPS;
112 PUSHMARK(SP);
113
114 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
115 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
116
117 PUTBACK;
118 if (get_cv("main::define_symbolic_field", 0))
119 call_pv("main::define_symbolic_field", G_SCALAR);
120 SPAGAIN;
121 PUTBACK;
122 FREETMPS;
123 LEAVE;
124}
125
126static void define_flag_value(const char *ev_name,
127 const char *field_name,
128 const char *field_value,
129 const char *field_str)
130{
131 unsigned long long value;
132 dSP;
133
134 value = eval_flag(field_value);
135
136 ENTER;
137 SAVETMPS;
138 PUSHMARK(SP);
139
140 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
141 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
142 XPUSHs(sv_2mortal(newSVuv(value)));
143 XPUSHs(sv_2mortal(newSVpv(field_str, 0)));
144
145 PUTBACK;
146 if (get_cv("main::define_flag_value", 0))
147 call_pv("main::define_flag_value", G_SCALAR);
148 SPAGAIN;
149 PUTBACK;
150 FREETMPS;
151 LEAVE;
152}
153
154static void define_flag_values(struct print_flag_sym *field,
155 const char *ev_name,
156 const char *field_name)
157{
158 define_flag_value(ev_name, field_name, field->value, field->str);
159 if (field->next)
160 define_flag_values(field->next, ev_name, field_name);
161}
162
163static void define_flag_field(const char *ev_name,
164 const char *field_name,
165 const char *delim)
166{
167 dSP;
168
169 ENTER;
170 SAVETMPS;
171 PUSHMARK(SP);
172
173 XPUSHs(sv_2mortal(newSVpv(ev_name, 0)));
174 XPUSHs(sv_2mortal(newSVpv(field_name, 0)));
175 XPUSHs(sv_2mortal(newSVpv(delim, 0)));
176
177 PUTBACK;
178 if (get_cv("main::define_flag_field", 0))
179 call_pv("main::define_flag_field", G_SCALAR);
180 SPAGAIN;
181 PUTBACK;
182 FREETMPS;
183 LEAVE;
184}
185
186static void define_event_symbols(struct event_format *event,
187 const char *ev_name,
188 struct print_arg *args)
189{
190 switch (args->type) {
191 case PRINT_NULL:
192 break;
193 case PRINT_ATOM:
194 define_flag_value(ev_name, cur_field_name, "0",
195 args->atom.atom);
196 zero_flag_atom = 0;
197 break;
198 case PRINT_FIELD:
199 free(cur_field_name);
200 cur_field_name = strdup(args->field.name);
201 break;
202 case PRINT_FLAGS:
203 define_event_symbols(event, ev_name, args->flags.field);
204 define_flag_field(ev_name, cur_field_name, args->flags.delim);
205 define_flag_values(args->flags.flags, ev_name, cur_field_name);
206 break;
207 case PRINT_SYMBOL:
208 define_event_symbols(event, ev_name, args->symbol.field);
209 define_symbolic_field(ev_name, cur_field_name);
210 define_symbolic_values(args->symbol.symbols, ev_name,
211 cur_field_name);
212 break;
213 case PRINT_HEX:
214 define_event_symbols(event, ev_name, args->hex.field);
215 define_event_symbols(event, ev_name, args->hex.size);
216 break;
217 case PRINT_BSTRING:
218 case PRINT_DYNAMIC_ARRAY:
219 case PRINT_STRING:
220 case PRINT_BITMASK:
221 break;
222 case PRINT_TYPE:
223 define_event_symbols(event, ev_name, args->typecast.item);
224 break;
225 case PRINT_OP:
226 if (strcmp(args->op.op, ":") == 0)
227 zero_flag_atom = 1;
228 define_event_symbols(event, ev_name, args->op.left);
229 define_event_symbols(event, ev_name, args->op.right);
230 break;
231 case PRINT_FUNC:
232 default:
233 pr_err("Unsupported print arg type\n");
234
235 return;
236 }
237
238 if (args->next)
239 define_event_symbols(event, ev_name, args->next);
240}
241
242static void perl_process_tracepoint(struct perf_sample *sample,
243 struct perf_evsel *evsel,
244 struct thread *thread)
245{
246 struct event_format *event = evsel->tp_format;
247 struct format_field *field;
248 static char handler[256];
249 unsigned long long val;
250 unsigned long s, ns;
251 int pid;
252 int cpu = sample->cpu;
253 void *data = sample->raw_data;
254 unsigned long long nsecs = sample->time;
255 const char *comm = thread__comm_str(thread);
256
257 dSP;
258
259 if (evsel->attr.type != PERF_TYPE_TRACEPOINT)
260 return;
261
262 if (!event)
263 die("ug! no event found for type %" PRIu64, (u64)evsel->attr.config);
264
265 pid = raw_field_value(event, "common_pid", data);
266
267 sprintf(handler, "%s::%s", event->system, event->name);
268
269 if (!test_and_set_bit(event->id, events_defined))
270 define_event_symbols(event, handler, event->print_fmt.args);
271
272 s = nsecs / NSECS_PER_SEC;
273 ns = nsecs - s * NSECS_PER_SEC;
274
275 scripting_context->event_data = data;
276 scripting_context->pevent = evsel->tp_format->pevent;
277
278 ENTER;
279 SAVETMPS;
280 PUSHMARK(SP);
281
282 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
283 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
284 XPUSHs(sv_2mortal(newSVuv(cpu)));
285 XPUSHs(sv_2mortal(newSVuv(s)));
286 XPUSHs(sv_2mortal(newSVuv(ns)));
287 XPUSHs(sv_2mortal(newSViv(pid)));
288 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
289
290
291
292 for (field = event->format.fields; field; field = field->next) {
293 if (field->flags & FIELD_IS_STRING) {
294 int offset;
295 if (field->flags & FIELD_IS_DYNAMIC) {
296 offset = *(int *)(data + field->offset);
297 offset &= 0xffff;
298 } else
299 offset = field->offset;
300 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0)));
301 } else {
302 val = read_size(event, data + field->offset,
303 field->size);
304 if (field->flags & FIELD_IS_SIGNED) {
305 XPUSHs(sv_2mortal(newSViv(val)));
306 } else {
307 XPUSHs(sv_2mortal(newSVuv(val)));
308 }
309 }
310 }
311
312 PUTBACK;
313
314 if (get_cv(handler, 0))
315 call_pv(handler, G_SCALAR);
316 else if (get_cv("main::trace_unhandled", 0)) {
317 XPUSHs(sv_2mortal(newSVpv(handler, 0)));
318 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context))));
319 XPUSHs(sv_2mortal(newSVuv(cpu)));
320 XPUSHs(sv_2mortal(newSVuv(nsecs)));
321 XPUSHs(sv_2mortal(newSViv(pid)));
322 XPUSHs(sv_2mortal(newSVpv(comm, 0)));
323 call_pv("main::trace_unhandled", G_SCALAR);
324 }
325 SPAGAIN;
326 PUTBACK;
327 FREETMPS;
328 LEAVE;
329}
330
331static void perl_process_event_generic(union perf_event *event,
332 struct perf_sample *sample,
333 struct perf_evsel *evsel)
334{
335 dSP;
336
337 if (!get_cv("process_event", 0))
338 return;
339
340 ENTER;
341 SAVETMPS;
342 PUSHMARK(SP);
343 XPUSHs(sv_2mortal(newSVpvn((const char *)event, event->header.size)));
344 XPUSHs(sv_2mortal(newSVpvn((const char *)&evsel->attr, sizeof(evsel->attr))));
345 XPUSHs(sv_2mortal(newSVpvn((const char *)sample, sizeof(*sample))));
346 XPUSHs(sv_2mortal(newSVpvn((const char *)sample->raw_data, sample->raw_size)));
347 PUTBACK;
348 call_pv("process_event", G_SCALAR);
349 SPAGAIN;
350 PUTBACK;
351 FREETMPS;
352 LEAVE;
353}
354
355static void perl_process_event(union perf_event *event,
356 struct perf_sample *sample,
357 struct perf_evsel *evsel,
358 struct thread *thread,
359 struct addr_location *al __maybe_unused)
360{
361 perl_process_tracepoint(sample, evsel, thread);
362 perl_process_event_generic(event, sample, evsel);
363}
364
365static void run_start_sub(void)
366{
367 dSP;
368 PUSHMARK(SP);
369
370 if (get_cv("main::trace_begin", 0))
371 call_pv("main::trace_begin", G_DISCARD | G_NOARGS);
372}
373
374
375
376
377static int perl_start_script(const char *script, int argc, const char **argv)
378{
379 const char **command_line;
380 int i, err = 0;
381
382 command_line = malloc((argc + 2) * sizeof(const char *));
383 command_line[0] = "";
384 command_line[1] = script;
385 for (i = 2; i < argc + 2; i++)
386 command_line[i] = argv[i - 2];
387
388 my_perl = perl_alloc();
389 perl_construct(my_perl);
390
391 if (perl_parse(my_perl, xs_init, argc + 2, (char **)command_line,
392 (char **)NULL)) {
393 err = -1;
394 goto error;
395 }
396
397 if (perl_run(my_perl)) {
398 err = -1;
399 goto error;
400 }
401
402 if (SvTRUE(ERRSV)) {
403 err = -1;
404 goto error;
405 }
406
407 run_start_sub();
408
409 free(command_line);
410 return 0;
411error:
412 perl_free(my_perl);
413 free(command_line);
414
415 return err;
416}
417
418static int perl_flush_script(void)
419{
420 return 0;
421}
422
423
424
425
426static int perl_stop_script(void)
427{
428 dSP;
429 PUSHMARK(SP);
430
431 if (get_cv("main::trace_end", 0))
432 call_pv("main::trace_end", G_DISCARD | G_NOARGS);
433
434 perl_destruct(my_perl);
435 perl_free(my_perl);
436
437 return 0;
438}
439
440static int perl_generate_script(struct pevent *pevent, const char *outfile)
441{
442 struct event_format *event = NULL;
443 struct format_field *f;
444 char fname[PATH_MAX];
445 int not_first, count;
446 FILE *ofp;
447
448 sprintf(fname, "%s.pl", outfile);
449 ofp = fopen(fname, "w");
450 if (ofp == NULL) {
451 fprintf(stderr, "couldn't open %s\n", fname);
452 return -1;
453 }
454
455 fprintf(ofp, "# perf script event handlers, "
456 "generated by perf script -g perl\n");
457
458 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
459 " License version 2\n\n");
460
461 fprintf(ofp, "# The common_* event handler fields are the most useful "
462 "fields common to\n");
463
464 fprintf(ofp, "# all events. They don't necessarily correspond to "
465 "the 'common_*' fields\n");
466
467 fprintf(ofp, "# in the format files. Those fields not available as "
468 "handler params can\n");
469
470 fprintf(ofp, "# be retrieved using Perl functions of the form "
471 "common_*($context).\n");
472
473 fprintf(ofp, "# See Context.pm for the list of available "
474 "functions.\n\n");
475
476 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/"
477 "Perf-Trace-Util/lib\";\n");
478
479 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n");
480 fprintf(ofp, "use Perf::Trace::Core;\n");
481 fprintf(ofp, "use Perf::Trace::Context;\n");
482 fprintf(ofp, "use Perf::Trace::Util;\n\n");
483
484 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n");
485 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n\n");
486
487 while ((event = trace_find_next_event(pevent, event))) {
488 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name);
489 fprintf(ofp, "\tmy (");
490
491 fprintf(ofp, "$event_name, ");
492 fprintf(ofp, "$context, ");
493 fprintf(ofp, "$common_cpu, ");
494 fprintf(ofp, "$common_secs, ");
495 fprintf(ofp, "$common_nsecs,\n");
496 fprintf(ofp, "\t $common_pid, ");
497 fprintf(ofp, "$common_comm,\n\t ");
498
499 not_first = 0;
500 count = 0;
501
502 for (f = event->format.fields; f; f = f->next) {
503 if (not_first++)
504 fprintf(ofp, ", ");
505 if (++count % 5 == 0)
506 fprintf(ofp, "\n\t ");
507
508 fprintf(ofp, "$%s", f->name);
509 }
510 fprintf(ofp, ") = @_;\n\n");
511
512 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
513 "$common_secs, $common_nsecs,\n\t "
514 "$common_pid, $common_comm);\n\n");
515
516 fprintf(ofp, "\tprintf(\"");
517
518 not_first = 0;
519 count = 0;
520
521 for (f = event->format.fields; f; f = f->next) {
522 if (not_first++)
523 fprintf(ofp, ", ");
524 if (count && count % 4 == 0) {
525 fprintf(ofp, "\".\n\t \"");
526 }
527 count++;
528
529 fprintf(ofp, "%s=", f->name);
530 if (f->flags & FIELD_IS_STRING ||
531 f->flags & FIELD_IS_FLAG ||
532 f->flags & FIELD_IS_SYMBOLIC)
533 fprintf(ofp, "%%s");
534 else if (f->flags & FIELD_IS_SIGNED)
535 fprintf(ofp, "%%d");
536 else
537 fprintf(ofp, "%%u");
538 }
539
540 fprintf(ofp, "\\n\",\n\t ");
541
542 not_first = 0;
543 count = 0;
544
545 for (f = event->format.fields; f; f = f->next) {
546 if (not_first++)
547 fprintf(ofp, ", ");
548
549 if (++count % 5 == 0)
550 fprintf(ofp, "\n\t ");
551
552 if (f->flags & FIELD_IS_FLAG) {
553 if ((count - 1) % 5 != 0) {
554 fprintf(ofp, "\n\t ");
555 count = 4;
556 }
557 fprintf(ofp, "flag_str(\"");
558 fprintf(ofp, "%s::%s\", ", event->system,
559 event->name);
560 fprintf(ofp, "\"%s\", $%s)", f->name,
561 f->name);
562 } else if (f->flags & FIELD_IS_SYMBOLIC) {
563 if ((count - 1) % 5 != 0) {
564 fprintf(ofp, "\n\t ");
565 count = 4;
566 }
567 fprintf(ofp, "symbol_str(\"");
568 fprintf(ofp, "%s::%s\", ", event->system,
569 event->name);
570 fprintf(ofp, "\"%s\", $%s)", f->name,
571 f->name);
572 } else
573 fprintf(ofp, "$%s", f->name);
574 }
575
576 fprintf(ofp, ");\n");
577 fprintf(ofp, "}\n\n");
578 }
579
580 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, "
581 "$common_cpu, $common_secs, $common_nsecs,\n\t "
582 "$common_pid, $common_comm) = @_;\n\n");
583
584 fprintf(ofp, "\tprint_header($event_name, $common_cpu, "
585 "$common_secs, $common_nsecs,\n\t $common_pid, "
586 "$common_comm);\n}\n\n");
587
588 fprintf(ofp, "sub print_header\n{\n"
589 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n"
590 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t "
591 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}\n");
592
593 fprintf(ofp,
594 "\n# Packed byte string args of process_event():\n"
595 "#\n"
596 "# $event:\tunion perf_event\tutil/event.h\n"
597 "# $attr:\tstruct perf_event_attr\tlinux/perf_event.h\n"
598 "# $sample:\tstruct perf_sample\tutil/event.h\n"
599 "# $raw_data:\tperf_sample->raw_data\tutil/event.h\n"
600 "\n"
601 "sub process_event\n"
602 "{\n"
603 "\tmy ($event, $attr, $sample, $raw_data) = @_;\n"
604 "\n"
605 "\tmy @event\t= unpack(\"LSS\", $event);\n"
606 "\tmy @attr\t= unpack(\"LLQQQQQLLQQ\", $attr);\n"
607 "\tmy @sample\t= unpack(\"QLLQQQQQLL\", $sample);\n"
608 "\tmy @raw_data\t= unpack(\"C*\", $raw_data);\n"
609 "\n"
610 "\tuse Data::Dumper;\n"
611 "\tprint Dumper \\@event, \\@attr, \\@sample, \\@raw_data;\n"
612 "}\n");
613
614 fclose(ofp);
615
616 fprintf(stderr, "generated Perl script: %s\n", fname);
617
618 return 0;
619}
620
621struct scripting_ops perl_scripting_ops = {
622 .name = "Perl",
623 .start_script = perl_start_script,
624 .flush_script = perl_flush_script,
625 .stop_script = perl_stop_script,
626 .process_event = perl_process_event,
627 .generate_script = perl_generate_script,
628};
629
