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