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