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