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

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