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