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 #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 40 void boot_Perf__Trace__Context(pTHX_ CV *cv); 41 void boot_DynaLoader(pTHX_ CV *cv); 42 typedef PerlInterpreter * INTERP; 43 44 void xs_init(pTHX); 45 46 void 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 56 INTERP my_perl; 57 58 #define TRACE_EVENT_TYPE_MAX \ 59 ((1 << (sizeof(unsigned short) * 8)) - 1) 60 61 static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX); 62 63 extern struct scripting_context *scripting_context; 64 65 static char *cur_field_name; 66 static int zero_flag_atom; 67 68 static 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 96 static 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 105 static 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 126 static 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 154 static 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 163 static 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 186 static 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_INT_ARRAY: 218 define_event_symbols(event, ev_name, args->int_array.field); 219 define_event_symbols(event, ev_name, args->int_array.count); 220 define_event_symbols(event, ev_name, args->int_array.el_size); 221 break; 222 case PRINT_BSTRING: 223 case PRINT_DYNAMIC_ARRAY: 224 case PRINT_DYNAMIC_ARRAY_LEN: 225 case PRINT_STRING: 226 case PRINT_BITMASK: 227 break; 228 case PRINT_TYPE: 229 define_event_symbols(event, ev_name, args->typecast.item); 230 break; 231 case PRINT_OP: 232 if (strcmp(args->op.op, ":") == 0) 233 zero_flag_atom = 1; 234 define_event_symbols(event, ev_name, args->op.left); 235 define_event_symbols(event, ev_name, args->op.right); 236 break; 237 case PRINT_FUNC: 238 default: 239 pr_err("Unsupported print arg type\n"); 240 /* we should warn... */ 241 return; 242 } 243 244 if (args->next) 245 define_event_symbols(event, ev_name, args->next); 246 } 247 248 static void perl_process_tracepoint(struct perf_sample *sample, 249 struct perf_evsel *evsel, 250 struct thread *thread) 251 { 252 struct event_format *event = evsel->tp_format; 253 struct format_field *field; 254 static char handler[256]; 255 unsigned long long val; 256 unsigned long s, ns; 257 int pid; 258 int cpu = sample->cpu; 259 void *data = sample->raw_data; 260 unsigned long long nsecs = sample->time; 261 const char *comm = thread__comm_str(thread); 262 263 dSP; 264 265 if (evsel->attr.type != PERF_TYPE_TRACEPOINT) 266 return; 267 268 if (!event) 269 die("ug! no event found for type %" PRIu64, (u64)evsel->attr.config); 270 271 pid = raw_field_value(event, "common_pid", data); 272 273 sprintf(handler, "%s::%s", event->system, event->name); 274 275 if (!test_and_set_bit(event->id, events_defined)) 276 define_event_symbols(event, handler, event->print_fmt.args); 277 278 s = nsecs / NSECS_PER_SEC; 279 ns = nsecs - s * NSECS_PER_SEC; 280 281 scripting_context->event_data = data; 282 scripting_context->pevent = evsel->tp_format->pevent; 283 284 ENTER; 285 SAVETMPS; 286 PUSHMARK(SP); 287 288 XPUSHs(sv_2mortal(newSVpv(handler, 0))); 289 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context)))); 290 XPUSHs(sv_2mortal(newSVuv(cpu))); 291 XPUSHs(sv_2mortal(newSVuv(s))); 292 XPUSHs(sv_2mortal(newSVuv(ns))); 293 XPUSHs(sv_2mortal(newSViv(pid))); 294 XPUSHs(sv_2mortal(newSVpv(comm, 0))); 295 296 /* common fields other than pid can be accessed via xsub fns */ 297 298 for (field = event->format.fields; field; field = field->next) { 299 if (field->flags & FIELD_IS_STRING) { 300 int offset; 301 if (field->flags & FIELD_IS_DYNAMIC) { 302 offset = *(int *)(data + field->offset); 303 offset &= 0xffff; 304 } else 305 offset = field->offset; 306 XPUSHs(sv_2mortal(newSVpv((char *)data + offset, 0))); 307 } else { /* FIELD_IS_NUMERIC */ 308 val = read_size(event, data + field->offset, 309 field->size); 310 if (field->flags & FIELD_IS_SIGNED) { 311 XPUSHs(sv_2mortal(newSViv(val))); 312 } else { 313 XPUSHs(sv_2mortal(newSVuv(val))); 314 } 315 } 316 } 317 318 PUTBACK; 319 320 if (get_cv(handler, 0)) 321 call_pv(handler, G_SCALAR); 322 else if (get_cv("main::trace_unhandled", 0)) { 323 XPUSHs(sv_2mortal(newSVpv(handler, 0))); 324 XPUSHs(sv_2mortal(newSViv(PTR2IV(scripting_context)))); 325 XPUSHs(sv_2mortal(newSVuv(cpu))); 326 XPUSHs(sv_2mortal(newSVuv(nsecs))); 327 XPUSHs(sv_2mortal(newSViv(pid))); 328 XPUSHs(sv_2mortal(newSVpv(comm, 0))); 329 call_pv("main::trace_unhandled", G_SCALAR); 330 } 331 SPAGAIN; 332 PUTBACK; 333 FREETMPS; 334 LEAVE; 335 } 336 337 static void perl_process_event_generic(union perf_event *event, 338 struct perf_sample *sample, 339 struct perf_evsel *evsel) 340 { 341 dSP; 342 343 if (!get_cv("process_event", 0)) 344 return; 345 346 ENTER; 347 SAVETMPS; 348 PUSHMARK(SP); 349 XPUSHs(sv_2mortal(newSVpvn((const char *)event, event->header.size))); 350 XPUSHs(sv_2mortal(newSVpvn((const char *)&evsel->attr, sizeof(evsel->attr)))); 351 XPUSHs(sv_2mortal(newSVpvn((const char *)sample, sizeof(*sample)))); 352 XPUSHs(sv_2mortal(newSVpvn((const char *)sample->raw_data, sample->raw_size))); 353 PUTBACK; 354 call_pv("process_event", G_SCALAR); 355 SPAGAIN; 356 PUTBACK; 357 FREETMPS; 358 LEAVE; 359 } 360 361 static void perl_process_event(union perf_event *event, 362 struct perf_sample *sample, 363 struct perf_evsel *evsel, 364 struct addr_location *al) 365 { 366 perl_process_tracepoint(sample, evsel, al->thread); 367 perl_process_event_generic(event, sample, evsel); 368 } 369 370 static void run_start_sub(void) 371 { 372 dSP; /* access to Perl stack */ 373 PUSHMARK(SP); 374 375 if (get_cv("main::trace_begin", 0)) 376 call_pv("main::trace_begin", G_DISCARD | G_NOARGS); 377 } 378 379 /* 380 * Start trace script 381 */ 382 static int perl_start_script(const char *script, int argc, const char **argv) 383 { 384 const char **command_line; 385 int i, err = 0; 386 387 command_line = malloc((argc + 2) * sizeof(const char *)); 388 command_line[0] = ""; 389 command_line[1] = script; 390 for (i = 2; i < argc + 2; i++) 391 command_line[i] = argv[i - 2]; 392 393 my_perl = perl_alloc(); 394 perl_construct(my_perl); 395 396 if (perl_parse(my_perl, xs_init, argc + 2, (char **)command_line, 397 (char **)NULL)) { 398 err = -1; 399 goto error; 400 } 401 402 if (perl_run(my_perl)) { 403 err = -1; 404 goto error; 405 } 406 407 if (SvTRUE(ERRSV)) { 408 err = -1; 409 goto error; 410 } 411 412 run_start_sub(); 413 414 free(command_line); 415 return 0; 416 error: 417 perl_free(my_perl); 418 free(command_line); 419 420 return err; 421 } 422 423 static int perl_flush_script(void) 424 { 425 return 0; 426 } 427 428 /* 429 * Stop trace script 430 */ 431 static int perl_stop_script(void) 432 { 433 dSP; /* access to Perl stack */ 434 PUSHMARK(SP); 435 436 if (get_cv("main::trace_end", 0)) 437 call_pv("main::trace_end", G_DISCARD | G_NOARGS); 438 439 perl_destruct(my_perl); 440 perl_free(my_perl); 441 442 return 0; 443 } 444 445 static int perl_generate_script(struct pevent *pevent, const char *outfile) 446 { 447 struct event_format *event = NULL; 448 struct format_field *f; 449 char fname[PATH_MAX]; 450 int not_first, count; 451 FILE *ofp; 452 453 sprintf(fname, "%s.pl", outfile); 454 ofp = fopen(fname, "w"); 455 if (ofp == NULL) { 456 fprintf(stderr, "couldn't open %s\n", fname); 457 return -1; 458 } 459 460 fprintf(ofp, "# perf script event handlers, " 461 "generated by perf script -g perl\n"); 462 463 fprintf(ofp, "# Licensed under the terms of the GNU GPL" 464 " License version 2\n\n"); 465 466 fprintf(ofp, "# The common_* event handler fields are the most useful " 467 "fields common to\n"); 468 469 fprintf(ofp, "# all events. They don't necessarily correspond to " 470 "the 'common_*' fields\n"); 471 472 fprintf(ofp, "# in the format files. Those fields not available as " 473 "handler params can\n"); 474 475 fprintf(ofp, "# be retrieved using Perl functions of the form " 476 "common_*($context).\n"); 477 478 fprintf(ofp, "# See Context.pm for the list of available " 479 "functions.\n\n"); 480 481 fprintf(ofp, "use lib \"$ENV{'PERF_EXEC_PATH'}/scripts/perl/" 482 "Perf-Trace-Util/lib\";\n"); 483 484 fprintf(ofp, "use lib \"./Perf-Trace-Util/lib\";\n"); 485 fprintf(ofp, "use Perf::Trace::Core;\n"); 486 fprintf(ofp, "use Perf::Trace::Context;\n"); 487 fprintf(ofp, "use Perf::Trace::Util;\n\n"); 488 489 fprintf(ofp, "sub trace_begin\n{\n\t# optional\n}\n\n"); 490 fprintf(ofp, "sub trace_end\n{\n\t# optional\n}\n\n"); 491 492 while ((event = trace_find_next_event(pevent, event))) { 493 fprintf(ofp, "sub %s::%s\n{\n", event->system, event->name); 494 fprintf(ofp, "\tmy ("); 495 496 fprintf(ofp, "$event_name, "); 497 fprintf(ofp, "$context, "); 498 fprintf(ofp, "$common_cpu, "); 499 fprintf(ofp, "$common_secs, "); 500 fprintf(ofp, "$common_nsecs,\n"); 501 fprintf(ofp, "\t $common_pid, "); 502 fprintf(ofp, "$common_comm,\n\t "); 503 504 not_first = 0; 505 count = 0; 506 507 for (f = event->format.fields; f; f = f->next) { 508 if (not_first++) 509 fprintf(ofp, ", "); 510 if (++count % 5 == 0) 511 fprintf(ofp, "\n\t "); 512 513 fprintf(ofp, "$%s", f->name); 514 } 515 fprintf(ofp, ") = @_;\n\n"); 516 517 fprintf(ofp, "\tprint_header($event_name, $common_cpu, " 518 "$common_secs, $common_nsecs,\n\t " 519 "$common_pid, $common_comm);\n\n"); 520 521 fprintf(ofp, "\tprintf(\""); 522 523 not_first = 0; 524 count = 0; 525 526 for (f = event->format.fields; f; f = f->next) { 527 if (not_first++) 528 fprintf(ofp, ", "); 529 if (count && count % 4 == 0) { 530 fprintf(ofp, "\".\n\t \""); 531 } 532 count++; 533 534 fprintf(ofp, "%s=", f->name); 535 if (f->flags & FIELD_IS_STRING || 536 f->flags & FIELD_IS_FLAG || 537 f->flags & FIELD_IS_SYMBOLIC) 538 fprintf(ofp, "%%s"); 539 else if (f->flags & FIELD_IS_SIGNED) 540 fprintf(ofp, "%%d"); 541 else 542 fprintf(ofp, "%%u"); 543 } 544 545 fprintf(ofp, "\\n\",\n\t "); 546 547 not_first = 0; 548 count = 0; 549 550 for (f = event->format.fields; f; f = f->next) { 551 if (not_first++) 552 fprintf(ofp, ", "); 553 554 if (++count % 5 == 0) 555 fprintf(ofp, "\n\t "); 556 557 if (f->flags & FIELD_IS_FLAG) { 558 if ((count - 1) % 5 != 0) { 559 fprintf(ofp, "\n\t "); 560 count = 4; 561 } 562 fprintf(ofp, "flag_str(\""); 563 fprintf(ofp, "%s::%s\", ", event->system, 564 event->name); 565 fprintf(ofp, "\"%s\", $%s)", f->name, 566 f->name); 567 } else if (f->flags & FIELD_IS_SYMBOLIC) { 568 if ((count - 1) % 5 != 0) { 569 fprintf(ofp, "\n\t "); 570 count = 4; 571 } 572 fprintf(ofp, "symbol_str(\""); 573 fprintf(ofp, "%s::%s\", ", event->system, 574 event->name); 575 fprintf(ofp, "\"%s\", $%s)", f->name, 576 f->name); 577 } else 578 fprintf(ofp, "$%s", f->name); 579 } 580 581 fprintf(ofp, ");\n"); 582 fprintf(ofp, "}\n\n"); 583 } 584 585 fprintf(ofp, "sub trace_unhandled\n{\n\tmy ($event_name, $context, " 586 "$common_cpu, $common_secs, $common_nsecs,\n\t " 587 "$common_pid, $common_comm) = @_;\n\n"); 588 589 fprintf(ofp, "\tprint_header($event_name, $common_cpu, " 590 "$common_secs, $common_nsecs,\n\t $common_pid, " 591 "$common_comm);\n}\n\n"); 592 593 fprintf(ofp, "sub print_header\n{\n" 594 "\tmy ($event_name, $cpu, $secs, $nsecs, $pid, $comm) = @_;\n\n" 595 "\tprintf(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \",\n\t " 596 "$event_name, $cpu, $secs, $nsecs, $pid, $comm);\n}\n"); 597 598 fprintf(ofp, 599 "\n# Packed byte string args of process_event():\n" 600 "#\n" 601 "# $event:\tunion perf_event\tutil/event.h\n" 602 "# $attr:\tstruct perf_event_attr\tlinux/perf_event.h\n" 603 "# $sample:\tstruct perf_sample\tutil/event.h\n" 604 "# $raw_data:\tperf_sample->raw_data\tutil/event.h\n" 605 "\n" 606 "sub process_event\n" 607 "{\n" 608 "\tmy ($event, $attr, $sample, $raw_data) = @_;\n" 609 "\n" 610 "\tmy @event\t= unpack(\"LSS\", $event);\n" 611 "\tmy @attr\t= unpack(\"LLQQQQQLLQQ\", $attr);\n" 612 "\tmy @sample\t= unpack(\"QLLQQQQQLL\", $sample);\n" 613 "\tmy @raw_data\t= unpack(\"C*\", $raw_data);\n" 614 "\n" 615 "\tuse Data::Dumper;\n" 616 "\tprint Dumper \\@event, \\@attr, \\@sample, \\@raw_data;\n" 617 "}\n"); 618 619 fclose(ofp); 620 621 fprintf(stderr, "generated Perl script: %s\n", fname); 622 623 return 0; 624 } 625 626 struct scripting_ops perl_scripting_ops = { 627 .name = "Perl", 628 .start_script = perl_start_script, 629 .flush_script = perl_flush_script, 630 .stop_script = perl_stop_script, 631 .process_event = perl_process_event, 632 .generate_script = perl_generate_script, 633 }; 634