tools/perf/util/trace-event-perl.c

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