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