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

   1 /*
   2  * trace-event-python.  Feed trace events to an embedded Python interpreter.
   3  *
   4  * Copyright (C) 2010 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 <Python.h>
  23
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <stdbool.h>
  28 #include <errno.h>
  29 #include <linux/bitmap.h>
  30
  31 #include "../../perf.h"
  32 #include "../debug.h"
  33 #include "../callchain.h"
  34 #include "../evsel.h"
  35 #include "../util.h"
  36 #include "../event.h"
  37 #include "../thread.h"
  38 #include "../comm.h"
  39 #include "../machine.h"
  40 #include "../db-export.h"
  41 #include "../thread-stack.h"
  42 #include "../trace-event.h"
  43 #include "../machine.h"
  44 #include "../call-path.h"
  45 #include "thread_map.h"
  46 #include "cpumap.h"
  47 #include "stat.h"
  48
  49 PyMODINIT_FUNC initperf_trace_context(void);
  50
  51 #define TRACE_EVENT_TYPE_MAX                            \
  52         ((1 << (sizeof(unsigned short) * 8)) - 1)
  53
  54 static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
  55
  56 #define MAX_FIELDS      64
  57 #define N_COMMON_FIELDS 7
  58
  59 extern struct scripting_context *scripting_context;
  60
  61 static char *cur_field_name;
  62 static int zero_flag_atom;
  63
  64 static PyObject *main_module, *main_dict;
  65
  66 struct tables {
  67         struct db_export        dbe;
  68         PyObject                *evsel_handler;
  69         PyObject                *machine_handler;
  70         PyObject                *thread_handler;
  71         PyObject                *comm_handler;
  72         PyObject                *comm_thread_handler;
  73         PyObject                *dso_handler;
  74         PyObject                *symbol_handler;
  75         PyObject                *branch_type_handler;
  76         PyObject                *sample_handler;
  77         PyObject                *call_path_handler;
  78         PyObject                *call_return_handler;
  79         bool                    db_export_mode;
  80 };
  81
  82 static struct tables tables_global;
  83
  84 static void handler_call_die(const char *handler_name) NORETURN;
  85 static void handler_call_die(const char *handler_name)
  86 {
  87         PyErr_Print();
  88         Py_FatalError("problem in Python trace event handler");
  89         // Py_FatalError does not return
  90         // but we have to make the compiler happy
  91         abort();
  92 }
  93
  94 /*
  95  * Insert val into into the dictionary and decrement the reference counter.
  96  * This is necessary for dictionaries since PyDict_SetItemString() does not
  97  * steal a reference, as opposed to PyTuple_SetItem().
  98  */
  99 static void pydict_set_item_string_decref(PyObject *dict, const char *key, PyObject *val)
 100 {
 101         PyDict_SetItemString(dict, key, val);
 102         Py_DECREF(val);
 103 }
 104
 105 static PyObject *get_handler(const char *handler_name)
 106 {
 107         PyObject *handler;
 108
 109         handler = PyDict_GetItemString(main_dict, handler_name);
 110         if (handler && !PyCallable_Check(handler))
 111                 return NULL;
 112         return handler;
 113 }
 114
 115 static void call_object(PyObject *handler, PyObject *args, const char *die_msg)
 116 {
 117         PyObject *retval;
 118
 119         retval = PyObject_CallObject(handler, args);
 120         if (retval == NULL)
 121                 handler_call_die(die_msg);
 122         Py_DECREF(retval);
 123 }
 124
 125 static void try_call_object(const char *handler_name, PyObject *args)
 126 {
 127         PyObject *handler;
 128
 129         handler = get_handler(handler_name);
 130         if (handler)
 131                 call_object(handler, args, handler_name);
 132 }
 133
 134 static void define_value(enum print_arg_type field_type,
 135                          const char *ev_name,
 136                          const char *field_name,
 137                          const char *field_value,
 138                          const char *field_str)
 139 {
 140         const char *handler_name = "define_flag_value";
 141         PyObject *t;
 142         unsigned long long value;
 143         unsigned n = 0;
 144
 145         if (field_type == PRINT_SYMBOL)
 146                 handler_name = "define_symbolic_value";
 147
 148         t = PyTuple_New(4);
 149         if (!t)
 150                 Py_FatalError("couldn't create Python tuple");
 151
 152         value = eval_flag(field_value);
 153
 154         PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
 155         PyTuple_SetItem(t, n++, PyString_FromString(field_name));
 156         PyTuple_SetItem(t, n++, PyInt_FromLong(value));
 157         PyTuple_SetItem(t, n++, PyString_FromString(field_str));
 158
 159         try_call_object(handler_name, t);
 160
 161         Py_DECREF(t);
 162 }
 163
 164 static void define_values(enum print_arg_type field_type,
 165                           struct print_flag_sym *field,
 166                           const char *ev_name,
 167                           const char *field_name)
 168 {
 169         define_value(field_type, ev_name, field_name, field->value,
 170                      field->str);
 171
 172         if (field->next)
 173                 define_values(field_type, field->next, ev_name, field_name);
 174 }
 175
 176 static void define_field(enum print_arg_type field_type,
 177                          const char *ev_name,
 178                          const char *field_name,
 179                          const char *delim)
 180 {
 181         const char *handler_name = "define_flag_field";
 182         PyObject *t;
 183         unsigned n = 0;
 184
 185         if (field_type == PRINT_SYMBOL)
 186                 handler_name = "define_symbolic_field";
 187
 188         if (field_type == PRINT_FLAGS)
 189                 t = PyTuple_New(3);
 190         else
 191                 t = PyTuple_New(2);
 192         if (!t)
 193                 Py_FatalError("couldn't create Python tuple");
 194
 195         PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
 196         PyTuple_SetItem(t, n++, PyString_FromString(field_name));
 197         if (field_type == PRINT_FLAGS)
 198                 PyTuple_SetItem(t, n++, PyString_FromString(delim));
 199
 200         try_call_object(handler_name, t);
 201
 202         Py_DECREF(t);
 203 }
 204
 205 static void define_event_symbols(struct event_format *event,
 206                                  const char *ev_name,
 207                                  struct print_arg *args)
 208 {
 209         if (args == NULL)
 210                 return;
 211
 212         switch (args->type) {
 213         case PRINT_NULL:
 214                 break;
 215         case PRINT_ATOM:
 216                 define_value(PRINT_FLAGS, ev_name, cur_field_name, "0",
 217                              args->atom.atom);
 218                 zero_flag_atom = 0;
 219                 break;
 220         case PRINT_FIELD:
 221                 free(cur_field_name);
 222                 cur_field_name = strdup(args->field.name);
 223                 break;
 224         case PRINT_FLAGS:
 225                 define_event_symbols(event, ev_name, args->flags.field);
 226                 define_field(PRINT_FLAGS, ev_name, cur_field_name,
 227                              args->flags.delim);
 228                 define_values(PRINT_FLAGS, args->flags.flags, ev_name,
 229                               cur_field_name);
 230                 break;
 231         case PRINT_SYMBOL:
 232                 define_event_symbols(event, ev_name, args->symbol.field);
 233                 define_field(PRINT_SYMBOL, ev_name, cur_field_name, NULL);
 234                 define_values(PRINT_SYMBOL, args->symbol.symbols, ev_name,
 235                               cur_field_name);
 236                 break;
 237         case PRINT_HEX:
 238                 define_event_symbols(event, ev_name, args->hex.field);
 239                 define_event_symbols(event, ev_name, args->hex.size);
 240                 break;
 241         case PRINT_INT_ARRAY:
 242                 define_event_symbols(event, ev_name, args->int_array.field);
 243                 define_event_symbols(event, ev_name, args->int_array.count);
 244                 define_event_symbols(event, ev_name, args->int_array.el_size);
 245                 break;
 246         case PRINT_STRING:
 247                 break;
 248         case PRINT_TYPE:
 249                 define_event_symbols(event, ev_name, args->typecast.item);
 250                 break;
 251         case PRINT_OP:
 252                 if (strcmp(args->op.op, ":") == 0)
 253                         zero_flag_atom = 1;
 254                 define_event_symbols(event, ev_name, args->op.left);
 255                 define_event_symbols(event, ev_name, args->op.right);
 256                 break;
 257         default:
 258                 /* gcc warns for these? */
 259         case PRINT_BSTRING:
 260         case PRINT_DYNAMIC_ARRAY:
 261         case PRINT_DYNAMIC_ARRAY_LEN:
 262         case PRINT_FUNC:
 263         case PRINT_BITMASK:
 264                 /* we should warn... */
 265                 return;
 266         }
 267
 268         if (args->next)
 269                 define_event_symbols(event, ev_name, args->next);
 270 }
 271
 272 static PyObject *get_field_numeric_entry(struct event_format *event,
 273                 struct format_field *field, void *data)
 274 {
 275         bool is_array = field->flags & FIELD_IS_ARRAY;
 276         PyObject *obj, *list = NULL;
 277         unsigned long long val;
 278         unsigned int item_size, n_items, i;
 279
 280         if (is_array) {
 281                 list = PyList_New(field->arraylen);
 282                 item_size = field->size / field->arraylen;
 283                 n_items = field->arraylen;
 284         } else {
 285                 item_size = field->size;
 286                 n_items = 1;
 287         }
 288
 289         for (i = 0; i < n_items; i++) {
 290
 291                 val = read_size(event, data + field->offset + i * item_size,
 292                                 item_size);
 293                 if (field->flags & FIELD_IS_SIGNED) {
 294                         if ((long long)val >= LONG_MIN &&
 295                                         (long long)val <= LONG_MAX)
 296                                 obj = PyInt_FromLong(val);
 297                         else
 298                                 obj = PyLong_FromLongLong(val);
 299                 } else {
 300                         if (val <= LONG_MAX)
 301                                 obj = PyInt_FromLong(val);
 302                         else
 303                                 obj = PyLong_FromUnsignedLongLong(val);
 304                 }
 305                 if (is_array)
 306                         PyList_SET_ITEM(list, i, obj);
 307         }
 308         if (is_array)
 309                 obj = list;
 310         return obj;
 311 }
 312
 313
 314 static PyObject *python_process_callchain(struct perf_sample *sample,
 315                                          struct perf_evsel *evsel,
 316                                          struct addr_location *al)
 317 {
 318         PyObject *pylist;
 319
 320         pylist = PyList_New(0);
 321         if (!pylist)
 322                 Py_FatalError("couldn't create Python list");
 323
 324         if (!symbol_conf.use_callchain || !sample->callchain)
 325                 goto exit;
 326
 327         if (thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
 328                                       sample, NULL, NULL,
 329                                       scripting_max_stack) != 0) {
 330                 pr_err("Failed to resolve callchain. Skipping\n");
 331                 goto exit;
 332         }
 333         callchain_cursor_commit(&callchain_cursor);
 334
 335
 336         while (1) {
 337                 PyObject *pyelem;
 338                 struct callchain_cursor_node *node;
 339                 node = callchain_cursor_current(&callchain_cursor);
 340                 if (!node)
 341                         break;
 342
 343                 pyelem = PyDict_New();
 344                 if (!pyelem)
 345                         Py_FatalError("couldn't create Python dictionary");
 346
 347
 348                 pydict_set_item_string_decref(pyelem, "ip",
 349                                 PyLong_FromUnsignedLongLong(node->ip));
 350
 351                 if (node->sym) {
 352                         PyObject *pysym  = PyDict_New();
 353                         if (!pysym)
 354                                 Py_FatalError("couldn't create Python dictionary");
 355                         pydict_set_item_string_decref(pysym, "start",
 356                                         PyLong_FromUnsignedLongLong(node->sym->start));
 357                         pydict_set_item_string_decref(pysym, "end",
 358                                         PyLong_FromUnsignedLongLong(node->sym->end));
 359                         pydict_set_item_string_decref(pysym, "binding",
 360                                         PyInt_FromLong(node->sym->binding));
 361                         pydict_set_item_string_decref(pysym, "name",
 362                                         PyString_FromStringAndSize(node->sym->name,
 363                                                         node->sym->namelen));
 364                         pydict_set_item_string_decref(pyelem, "sym", pysym);
 365                 }
 366
 367                 if (node->map) {
 368                         struct map *map = node->map;
 369                         const char *dsoname = "[unknown]";
 370                         if (map && map->dso && (map->dso->name || map->dso->long_name)) {
 371                                 if (symbol_conf.show_kernel_path && map->dso->long_name)
 372                                         dsoname = map->dso->long_name;
 373                                 else if (map->dso->name)
 374                                         dsoname = map->dso->name;
 375                         }
 376                         pydict_set_item_string_decref(pyelem, "dso",
 377                                         PyString_FromString(dsoname));
 378                 }
 379
 380                 callchain_cursor_advance(&callchain_cursor);
 381                 PyList_Append(pylist, pyelem);
 382                 Py_DECREF(pyelem);
 383         }
 384
 385 exit:
 386         return pylist;
 387 }
 388
 389
 390 static void python_process_tracepoint(struct perf_sample *sample,
 391                                       struct perf_evsel *evsel,
 392                                       struct addr_location *al)
 393 {
 394         struct event_format *event = evsel->tp_format;
 395         PyObject *handler, *context, *t, *obj, *callchain;
 396         PyObject *dict = NULL;
 397         static char handler_name[256];
 398         struct format_field *field;
 399         unsigned long s, ns;
 400         unsigned n = 0;
 401         int pid;
 402         int cpu = sample->cpu;
 403         void *data = sample->raw_data;
 404         unsigned long long nsecs = sample->time;
 405         const char *comm = thread__comm_str(al->thread);
 406
 407         t = PyTuple_New(MAX_FIELDS);
 408         if (!t)
 409                 Py_FatalError("couldn't create Python tuple");
 410
 411         if (!event)
 412                 die("ug! no event found for type %d", (int)evsel->attr.config);
 413
 414         pid = raw_field_value(event, "common_pid", data);
 415
 416         sprintf(handler_name, "%s__%s", event->system, event->name);
 417
 418         if (!test_and_set_bit(event->id, events_defined))
 419                 define_event_symbols(event, handler_name, event->print_fmt.args);
 420
 421         handler = get_handler(handler_name);
 422         if (!handler) {
 423                 dict = PyDict_New();
 424                 if (!dict)
 425                         Py_FatalError("couldn't create Python dict");
 426         }
 427         s = nsecs / NSECS_PER_SEC;
 428         ns = nsecs - s * NSECS_PER_SEC;
 429
 430         scripting_context->event_data = data;
 431         scripting_context->pevent = evsel->tp_format->pevent;
 432
 433         context = PyCObject_FromVoidPtr(scripting_context, NULL);
 434
 435         PyTuple_SetItem(t, n++, PyString_FromString(handler_name));
 436         PyTuple_SetItem(t, n++, context);
 437
 438         /* ip unwinding */
 439         callchain = python_process_callchain(sample, evsel, al);
 440
 441         if (handler) {
 442                 PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
 443                 PyTuple_SetItem(t, n++, PyInt_FromLong(s));
 444                 PyTuple_SetItem(t, n++, PyInt_FromLong(ns));
 445                 PyTuple_SetItem(t, n++, PyInt_FromLong(pid));
 446                 PyTuple_SetItem(t, n++, PyString_FromString(comm));
 447                 PyTuple_SetItem(t, n++, callchain);
 448         } else {
 449                 pydict_set_item_string_decref(dict, "common_cpu", PyInt_FromLong(cpu));
 450                 pydict_set_item_string_decref(dict, "common_s", PyInt_FromLong(s));
 451                 pydict_set_item_string_decref(dict, "common_ns", PyInt_FromLong(ns));
 452                 pydict_set_item_string_decref(dict, "common_pid", PyInt_FromLong(pid));
 453                 pydict_set_item_string_decref(dict, "common_comm", PyString_FromString(comm));
 454                 pydict_set_item_string_decref(dict, "common_callchain", callchain);
 455         }
 456         for (field = event->format.fields; field; field = field->next) {
 457                 if (field->flags & FIELD_IS_STRING) {
 458                         int offset;
 459                         if (field->flags & FIELD_IS_DYNAMIC) {
 460                                 offset = *(int *)(data + field->offset);
 461                                 offset &= 0xffff;
 462                         } else
 463                                 offset = field->offset;
 464                         obj = PyString_FromString((char *)data + offset);
 465                 } else { /* FIELD_IS_NUMERIC */
 466                         obj = get_field_numeric_entry(event, field, data);
 467                 }
 468                 if (handler)
 469                         PyTuple_SetItem(t, n++, obj);
 470                 else
 471                         pydict_set_item_string_decref(dict, field->name, obj);
 472
 473         }
 474
 475         if (!handler)
 476                 PyTuple_SetItem(t, n++, dict);
 477
 478         if (_PyTuple_Resize(&t, n) == -1)
 479                 Py_FatalError("error resizing Python tuple");
 480
 481         if (handler) {
 482                 call_object(handler, t, handler_name);
 483         } else {
 484                 try_call_object("trace_unhandled", t);
 485                 Py_DECREF(dict);
 486         }
 487
 488         Py_DECREF(t);
 489 }
 490
 491 static PyObject *tuple_new(unsigned int sz)
 492 {
 493         PyObject *t;
 494
 495         t = PyTuple_New(sz);
 496         if (!t)
 497                 Py_FatalError("couldn't create Python tuple");
 498         return t;
 499 }
 500
 501 static int tuple_set_u64(PyObject *t, unsigned int pos, u64 val)
 502 {
 503 #if BITS_PER_LONG == 64
 504         return PyTuple_SetItem(t, pos, PyInt_FromLong(val));
 505 #endif
 506 #if BITS_PER_LONG == 32
 507         return PyTuple_SetItem(t, pos, PyLong_FromLongLong(val));
 508 #endif
 509 }
 510
 511 static int tuple_set_s32(PyObject *t, unsigned int pos, s32 val)
 512 {
 513         return PyTuple_SetItem(t, pos, PyInt_FromLong(val));
 514 }
 515
 516 static int tuple_set_string(PyObject *t, unsigned int pos, const char *s)
 517 {
 518         return PyTuple_SetItem(t, pos, PyString_FromString(s));
 519 }
 520
 521 static int python_export_evsel(struct db_export *dbe, struct perf_evsel *evsel)
 522 {
 523         struct tables *tables = container_of(dbe, struct tables, dbe);
 524         PyObject *t;
 525
 526         t = tuple_new(2);
 527
 528         tuple_set_u64(t, 0, evsel->db_id);
 529         tuple_set_string(t, 1, perf_evsel__name(evsel));
 530
 531         call_object(tables->evsel_handler, t, "evsel_table");
 532
 533         Py_DECREF(t);
 534
 535         return 0;
 536 }
 537
 538 static int python_export_machine(struct db_export *dbe,
 539                                  struct machine *machine)
 540 {
 541         struct tables *tables = container_of(dbe, struct tables, dbe);
 542         PyObject *t;
 543
 544         t = tuple_new(3);
 545
 546         tuple_set_u64(t, 0, machine->db_id);
 547         tuple_set_s32(t, 1, machine->pid);
 548         tuple_set_string(t, 2, machine->root_dir ? machine->root_dir : "");
 549
 550         call_object(tables->machine_handler, t, "machine_table");
 551
 552         Py_DECREF(t);
 553
 554         return 0;
 555 }
 556
 557 static int python_export_thread(struct db_export *dbe, struct thread *thread,
 558                                 u64 main_thread_db_id, struct machine *machine)
 559 {
 560         struct tables *tables = container_of(dbe, struct tables, dbe);
 561         PyObject *t;
 562
 563         t = tuple_new(5);
 564
 565         tuple_set_u64(t, 0, thread->db_id);
 566         tuple_set_u64(t, 1, machine->db_id);
 567         tuple_set_u64(t, 2, main_thread_db_id);
 568         tuple_set_s32(t, 3, thread->pid_);
 569         tuple_set_s32(t, 4, thread->tid);
 570
 571         call_object(tables->thread_handler, t, "thread_table");
 572
 573         Py_DECREF(t);
 574
 575         return 0;
 576 }
 577
 578 static int python_export_comm(struct db_export *dbe, struct comm *comm)
 579 {
 580         struct tables *tables = container_of(dbe, struct tables, dbe);
 581         PyObject *t;
 582
 583         t = tuple_new(2);
 584
 585         tuple_set_u64(t, 0, comm->db_id);
 586         tuple_set_string(t, 1, comm__str(comm));
 587
 588         call_object(tables->comm_handler, t, "comm_table");
 589
 590         Py_DECREF(t);
 591
 592         return 0;
 593 }
 594
 595 static int python_export_comm_thread(struct db_export *dbe, u64 db_id,
 596                                      struct comm *comm, struct thread *thread)
 597 {
 598         struct tables *tables = container_of(dbe, struct tables, dbe);
 599         PyObject *t;
 600
 601         t = tuple_new(3);
 602
 603         tuple_set_u64(t, 0, db_id);
 604         tuple_set_u64(t, 1, comm->db_id);
 605         tuple_set_u64(t, 2, thread->db_id);
 606
 607         call_object(tables->comm_thread_handler, t, "comm_thread_table");
 608
 609         Py_DECREF(t);
 610
 611         return 0;
 612 }
 613
 614 static int python_export_dso(struct db_export *dbe, struct dso *dso,
 615                              struct machine *machine)
 616 {
 617         struct tables *tables = container_of(dbe, struct tables, dbe);
 618         char sbuild_id[BUILD_ID_SIZE * 2 + 1];
 619         PyObject *t;
 620
 621         build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
 622
 623         t = tuple_new(5);
 624
 625         tuple_set_u64(t, 0, dso->db_id);
 626         tuple_set_u64(t, 1, machine->db_id);
 627         tuple_set_string(t, 2, dso->short_name);
 628         tuple_set_string(t, 3, dso->long_name);
 629         tuple_set_string(t, 4, sbuild_id);
 630
 631         call_object(tables->dso_handler, t, "dso_table");
 632
 633         Py_DECREF(t);
 634
 635         return 0;
 636 }
 637
 638 static int python_export_symbol(struct db_export *dbe, struct symbol *sym,
 639                                 struct dso *dso)
 640 {
 641         struct tables *tables = container_of(dbe, struct tables, dbe);
 642         u64 *sym_db_id = symbol__priv(sym);
 643         PyObject *t;
 644
 645         t = tuple_new(6);
 646
 647         tuple_set_u64(t, 0, *sym_db_id);
 648         tuple_set_u64(t, 1, dso->db_id);
 649         tuple_set_u64(t, 2, sym->start);
 650         tuple_set_u64(t, 3, sym->end);
 651         tuple_set_s32(t, 4, sym->binding);
 652         tuple_set_string(t, 5, sym->name);
 653
 654         call_object(tables->symbol_handler, t, "symbol_table");
 655
 656         Py_DECREF(t);
 657
 658         return 0;
 659 }
 660
 661 static int python_export_branch_type(struct db_export *dbe, u32 branch_type,
 662                                      const char *name)
 663 {
 664         struct tables *tables = container_of(dbe, struct tables, dbe);
 665         PyObject *t;
 666
 667         t = tuple_new(2);
 668
 669         tuple_set_s32(t, 0, branch_type);
 670         tuple_set_string(t, 1, name);
 671
 672         call_object(tables->branch_type_handler, t, "branch_type_table");
 673
 674         Py_DECREF(t);
 675
 676         return 0;
 677 }
 678
 679 static int python_export_sample(struct db_export *dbe,
 680                                 struct export_sample *es)
 681 {
 682         struct tables *tables = container_of(dbe, struct tables, dbe);
 683         PyObject *t;
 684
 685         t = tuple_new(21);
 686
 687         tuple_set_u64(t, 0, es->db_id);
 688         tuple_set_u64(t, 1, es->evsel->db_id);
 689         tuple_set_u64(t, 2, es->al->machine->db_id);
 690         tuple_set_u64(t, 3, es->al->thread->db_id);
 691         tuple_set_u64(t, 4, es->comm_db_id);
 692         tuple_set_u64(t, 5, es->dso_db_id);
 693         tuple_set_u64(t, 6, es->sym_db_id);
 694         tuple_set_u64(t, 7, es->offset);
 695         tuple_set_u64(t, 8, es->sample->ip);
 696         tuple_set_u64(t, 9, es->sample->time);
 697         tuple_set_s32(t, 10, es->sample->cpu);
 698         tuple_set_u64(t, 11, es->addr_dso_db_id);
 699         tuple_set_u64(t, 12, es->addr_sym_db_id);
 700         tuple_set_u64(t, 13, es->addr_offset);
 701         tuple_set_u64(t, 14, es->sample->addr);
 702         tuple_set_u64(t, 15, es->sample->period);
 703         tuple_set_u64(t, 16, es->sample->weight);
 704         tuple_set_u64(t, 17, es->sample->transaction);
 705         tuple_set_u64(t, 18, es->sample->data_src);
 706         tuple_set_s32(t, 19, es->sample->flags & PERF_BRANCH_MASK);
 707         tuple_set_s32(t, 20, !!(es->sample->flags & PERF_IP_FLAG_IN_TX));
 708
 709         call_object(tables->sample_handler, t, "sample_table");
 710
 711         Py_DECREF(t);
 712
 713         return 0;
 714 }
 715
 716 static int python_export_call_path(struct db_export *dbe, struct call_path *cp)
 717 {
 718         struct tables *tables = container_of(dbe, struct tables, dbe);
 719         PyObject *t;
 720         u64 parent_db_id, sym_db_id;
 721
 722         parent_db_id = cp->parent ? cp->parent->db_id : 0;
 723         sym_db_id = cp->sym ? *(u64 *)symbol__priv(cp->sym) : 0;
 724
 725         t = tuple_new(4);
 726
 727         tuple_set_u64(t, 0, cp->db_id);
 728         tuple_set_u64(t, 1, parent_db_id);
 729         tuple_set_u64(t, 2, sym_db_id);
 730         tuple_set_u64(t, 3, cp->ip);
 731
 732         call_object(tables->call_path_handler, t, "call_path_table");
 733
 734         Py_DECREF(t);
 735
 736         return 0;
 737 }
 738
 739 static int python_export_call_return(struct db_export *dbe,
 740                                      struct call_return *cr)
 741 {
 742         struct tables *tables = container_of(dbe, struct tables, dbe);
 743         u64 comm_db_id = cr->comm ? cr->comm->db_id : 0;
 744         PyObject *t;
 745
 746         t = tuple_new(11);
 747
 748         tuple_set_u64(t, 0, cr->db_id);
 749         tuple_set_u64(t, 1, cr->thread->db_id);
 750         tuple_set_u64(t, 2, comm_db_id);
 751         tuple_set_u64(t, 3, cr->cp->db_id);
 752         tuple_set_u64(t, 4, cr->call_time);
 753         tuple_set_u64(t, 5, cr->return_time);
 754         tuple_set_u64(t, 6, cr->branch_count);
 755         tuple_set_u64(t, 7, cr->call_ref);
 756         tuple_set_u64(t, 8, cr->return_ref);
 757         tuple_set_u64(t, 9, cr->cp->parent->db_id);
 758         tuple_set_s32(t, 10, cr->flags);
 759
 760         call_object(tables->call_return_handler, t, "call_return_table");
 761
 762         Py_DECREF(t);
 763
 764         return 0;
 765 }
 766
 767 static int python_process_call_return(struct call_return *cr, void *data)
 768 {
 769         struct db_export *dbe = data;
 770
 771         return db_export__call_return(dbe, cr);
 772 }
 773
 774 static void python_process_general_event(struct perf_sample *sample,
 775                                          struct perf_evsel *evsel,
 776                                          struct addr_location *al)
 777 {
 778         PyObject *handler, *t, *dict, *callchain, *dict_sample;
 779         static char handler_name[64];
 780         unsigned n = 0;
 781
 782         /*
 783          * Use the MAX_FIELDS to make the function expandable, though
 784          * currently there is only one item for the tuple.
 785          */
 786         t = PyTuple_New(MAX_FIELDS);
 787         if (!t)
 788                 Py_FatalError("couldn't create Python tuple");
 789
 790         dict = PyDict_New();
 791         if (!dict)
 792                 Py_FatalError("couldn't create Python dictionary");
 793
 794         dict_sample = PyDict_New();
 795         if (!dict_sample)
 796                 Py_FatalError("couldn't create Python dictionary");
 797
 798         snprintf(handler_name, sizeof(handler_name), "%s", "process_event");
 799
 800         handler = get_handler(handler_name);
 801         if (!handler)
 802                 goto exit;
 803
 804         pydict_set_item_string_decref(dict, "ev_name", PyString_FromString(perf_evsel__name(evsel)));
 805         pydict_set_item_string_decref(dict, "attr", PyString_FromStringAndSize(
 806                         (const char *)&evsel->attr, sizeof(evsel->attr)));
 807
 808         pydict_set_item_string_decref(dict_sample, "pid",
 809                         PyInt_FromLong(sample->pid));
 810         pydict_set_item_string_decref(dict_sample, "tid",
 811                         PyInt_FromLong(sample->tid));
 812         pydict_set_item_string_decref(dict_sample, "cpu",
 813                         PyInt_FromLong(sample->cpu));
 814         pydict_set_item_string_decref(dict_sample, "ip",
 815                         PyLong_FromUnsignedLongLong(sample->ip));
 816         pydict_set_item_string_decref(dict_sample, "time",
 817                         PyLong_FromUnsignedLongLong(sample->time));
 818         pydict_set_item_string_decref(dict_sample, "period",
 819                         PyLong_FromUnsignedLongLong(sample->period));
 820         pydict_set_item_string_decref(dict, "sample", dict_sample);
 821
 822         pydict_set_item_string_decref(dict, "raw_buf", PyString_FromStringAndSize(
 823                         (const char *)sample->raw_data, sample->raw_size));
 824         pydict_set_item_string_decref(dict, "comm",
 825                         PyString_FromString(thread__comm_str(al->thread)));
 826         if (al->map) {
 827                 pydict_set_item_string_decref(dict, "dso",
 828                         PyString_FromString(al->map->dso->name));
 829         }
 830         if (al->sym) {
 831                 pydict_set_item_string_decref(dict, "symbol",
 832                         PyString_FromString(al->sym->name));
 833         }
 834
 835         /* ip unwinding */
 836         callchain = python_process_callchain(sample, evsel, al);
 837         pydict_set_item_string_decref(dict, "callchain", callchain);
 838
 839         PyTuple_SetItem(t, n++, dict);
 840         if (_PyTuple_Resize(&t, n) == -1)
 841                 Py_FatalError("error resizing Python tuple");
 842
 843         call_object(handler, t, handler_name);
 844 exit:
 845         Py_DECREF(dict);
 846         Py_DECREF(t);
 847 }
 848
 849 static void python_process_event(union perf_event *event,
 850                                  struct perf_sample *sample,
 851                                  struct perf_evsel *evsel,
 852                                  struct addr_location *al)
 853 {
 854         struct tables *tables = &tables_global;
 855
 856         switch (evsel->attr.type) {
 857         case PERF_TYPE_TRACEPOINT:
 858                 python_process_tracepoint(sample, evsel, al);
 859                 break;
 860         /* Reserve for future process_hw/sw/raw APIs */
 861         default:
 862                 if (tables->db_export_mode)
 863                         db_export__sample(&tables->dbe, event, sample, evsel, al);
 864                 else
 865                         python_process_general_event(sample, evsel, al);
 866         }
 867 }
 868
 869 static void get_handler_name(char *str, size_t size,
 870                              struct perf_evsel *evsel)
 871 {
 872         char *p = str;
 873
 874         scnprintf(str, size, "stat__%s", perf_evsel__name(evsel));
 875
 876         while ((p = strchr(p, ':'))) {
 877                 *p = '_';
 878                 p++;
 879         }
 880 }
 881
 882 static void
 883 process_stat(struct perf_evsel *counter, int cpu, int thread, u64 tstamp,
 884              struct perf_counts_values *count)
 885 {
 886         PyObject *handler, *t;
 887         static char handler_name[256];
 888         int n = 0;
 889
 890         t = PyTuple_New(MAX_FIELDS);
 891         if (!t)
 892                 Py_FatalError("couldn't create Python tuple");
 893
 894         get_handler_name(handler_name, sizeof(handler_name),
 895                          counter);
 896
 897         handler = get_handler(handler_name);
 898         if (!handler) {
 899                 pr_debug("can't find python handler %s\n", handler_name);
 900                 return;
 901         }
 902
 903         PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
 904         PyTuple_SetItem(t, n++, PyInt_FromLong(thread));
 905
 906         tuple_set_u64(t, n++, tstamp);
 907         tuple_set_u64(t, n++, count->val);
 908         tuple_set_u64(t, n++, count->ena);
 909         tuple_set_u64(t, n++, count->run);
 910
 911         if (_PyTuple_Resize(&t, n) == -1)
 912                 Py_FatalError("error resizing Python tuple");
 913
 914         call_object(handler, t, handler_name);
 915
 916         Py_DECREF(t);
 917 }
 918
 919 static void python_process_stat(struct perf_stat_config *config,
 920                                 struct perf_evsel *counter, u64 tstamp)
 921 {
 922         struct thread_map *threads = counter->threads;
 923         struct cpu_map *cpus = counter->cpus;
 924         int cpu, thread;
 925
 926         if (config->aggr_mode == AGGR_GLOBAL) {
 927                 process_stat(counter, -1, -1, tstamp,
 928                              &counter->counts->aggr);
 929                 return;
 930         }
 931
 932         for (thread = 0; thread < threads->nr; thread++) {
 933                 for (cpu = 0; cpu < cpus->nr; cpu++) {
 934                         process_stat(counter, cpus->map[cpu],
 935                                      thread_map__pid(threads, thread), tstamp,
 936                                      perf_counts(counter->counts, cpu, thread));
 937                 }
 938         }
 939 }
 940
 941 static void python_process_stat_interval(u64 tstamp)
 942 {
 943         PyObject *handler, *t;
 944         static const char handler_name[] = "stat__interval";
 945         int n = 0;
 946
 947         t = PyTuple_New(MAX_FIELDS);
 948         if (!t)
 949                 Py_FatalError("couldn't create Python tuple");
 950
 951         handler = get_handler(handler_name);
 952         if (!handler) {
 953                 pr_debug("can't find python handler %s\n", handler_name);
 954                 return;
 955         }
 956
 957         tuple_set_u64(t, n++, tstamp);
 958
 959         if (_PyTuple_Resize(&t, n) == -1)
 960                 Py_FatalError("error resizing Python tuple");
 961
 962         call_object(handler, t, handler_name);
 963
 964         Py_DECREF(t);
 965 }
 966
 967 static int run_start_sub(void)
 968 {
 969         main_module = PyImport_AddModule("__main__");
 970         if (main_module == NULL)
 971                 return -1;
 972         Py_INCREF(main_module);
 973
 974         main_dict = PyModule_GetDict(main_module);
 975         if (main_dict == NULL)
 976                 goto error;
 977         Py_INCREF(main_dict);
 978
 979         try_call_object("trace_begin", NULL);
 980
 981         return 0;
 982
 983 error:
 984         Py_XDECREF(main_dict);
 985         Py_XDECREF(main_module);
 986         return -1;
 987 }
 988
 989 #define SET_TABLE_HANDLER_(name, handler_name, table_name) do {         \
 990         tables->handler_name = get_handler(#table_name);                \
 991         if (tables->handler_name)                                       \
 992                 tables->dbe.export_ ## name = python_export_ ## name;   \
 993 } while (0)
 994
 995 #define SET_TABLE_HANDLER(name) \
 996         SET_TABLE_HANDLER_(name, name ## _handler, name ## _table)
 997
 998 static void set_table_handlers(struct tables *tables)
 999 {
1000         const char *perf_db_export_mode = "perf_db_export_mode";
1001         const char *perf_db_export_calls = "perf_db_export_calls";
1002         PyObject *db_export_mode, *db_export_calls;
1003         bool export_calls = false;
1004         int ret;
1005
1006         memset(tables, 0, sizeof(struct tables));
1007         if (db_export__init(&tables->dbe))
1008                 Py_FatalError("failed to initialize export");
1009
1010         db_export_mode = PyDict_GetItemString(main_dict, perf_db_export_mode);
1011         if (!db_export_mode)
1012                 return;
1013
1014         ret = PyObject_IsTrue(db_export_mode);
1015         if (ret == -1)
1016                 handler_call_die(perf_db_export_mode);
1017         if (!ret)
1018                 return;
1019
1020         tables->dbe.crp = NULL;
1021         db_export_calls = PyDict_GetItemString(main_dict, perf_db_export_calls);
1022         if (db_export_calls) {
1023                 ret = PyObject_IsTrue(db_export_calls);
1024                 if (ret == -1)
1025                         handler_call_die(perf_db_export_calls);
1026                 export_calls = !!ret;
1027         }
1028
1029         if (export_calls) {
1030                 tables->dbe.crp =
1031                         call_return_processor__new(python_process_call_return,
1032                                                    &tables->dbe);
1033                 if (!tables->dbe.crp)
1034                         Py_FatalError("failed to create calls processor");
1035         }
1036
1037         tables->db_export_mode = true;
1038         /*
1039          * Reserve per symbol space for symbol->db_id via symbol__priv()
1040          */
1041         symbol_conf.priv_size = sizeof(u64);
1042
1043         SET_TABLE_HANDLER(evsel);
1044         SET_TABLE_HANDLER(machine);
1045         SET_TABLE_HANDLER(thread);
1046         SET_TABLE_HANDLER(comm);
1047         SET_TABLE_HANDLER(comm_thread);
1048         SET_TABLE_HANDLER(dso);
1049         SET_TABLE_HANDLER(symbol);
1050         SET_TABLE_HANDLER(branch_type);
1051         SET_TABLE_HANDLER(sample);
1052         SET_TABLE_HANDLER(call_path);
1053         SET_TABLE_HANDLER(call_return);
1054 }
1055
1056 /*
1057  * Start trace script
1058  */
1059 static int python_start_script(const char *script, int argc, const char **argv)
1060 {
1061         struct tables *tables = &tables_global;
1062         const char **command_line;
1063         char buf[PATH_MAX];
1064         int i, err = 0;
1065         FILE *fp;
1066
1067         command_line = malloc((argc + 1) * sizeof(const char *));
1068         command_line[0] = script;
1069         for (i = 1; i < argc + 1; i++)
1070                 command_line[i] = argv[i - 1];
1071
1072         Py_Initialize();
1073
1074         initperf_trace_context();
1075
1076         PySys_SetArgv(argc + 1, (char **)command_line);
1077
1078         fp = fopen(script, "r");
1079         if (!fp) {
1080                 sprintf(buf, "Can't open python script \"%s\"", script);
1081                 perror(buf);
1082                 err = -1;
1083                 goto error;
1084         }
1085
1086         err = PyRun_SimpleFile(fp, script);
1087         if (err) {
1088                 fprintf(stderr, "Error running python script %s\n", script);
1089                 goto error;
1090         }
1091
1092         err = run_start_sub();
1093         if (err) {
1094                 fprintf(stderr, "Error starting python script %s\n", script);
1095                 goto error;
1096         }
1097
1098         set_table_handlers(tables);
1099
1100         if (tables->db_export_mode) {
1101                 err = db_export__branch_types(&tables->dbe);
1102                 if (err)
1103                         goto error;
1104         }
1105
1106         free(command_line);
1107
1108         return err;
1109 error:
1110         Py_Finalize();
1111         free(command_line);
1112
1113         return err;
1114 }
1115
1116 static int python_flush_script(void)
1117 {
1118         struct tables *tables = &tables_global;
1119
1120         return db_export__flush(&tables->dbe);
1121 }
1122
1123 /*
1124  * Stop trace script
1125  */
1126 static int python_stop_script(void)
1127 {
1128         struct tables *tables = &tables_global;
1129
1130         try_call_object("trace_end", NULL);
1131
1132         db_export__exit(&tables->dbe);
1133
1134         Py_XDECREF(main_dict);
1135         Py_XDECREF(main_module);
1136         Py_Finalize();
1137
1138         return 0;
1139 }
1140
1141 static int python_generate_script(struct pevent *pevent, const char *outfile)
1142 {
1143         struct event_format *event = NULL;
1144         struct format_field *f;
1145         char fname[PATH_MAX];
1146         int not_first, count;
1147         FILE *ofp;
1148
1149         sprintf(fname, "%s.py", outfile);
1150         ofp = fopen(fname, "w");
1151         if (ofp == NULL) {
1152                 fprintf(stderr, "couldn't open %s\n", fname);
1153                 return -1;
1154         }
1155         fprintf(ofp, "# perf script event handlers, "
1156                 "generated by perf script -g python\n");
1157
1158         fprintf(ofp, "# Licensed under the terms of the GNU GPL"
1159                 " License version 2\n\n");
1160
1161         fprintf(ofp, "# The common_* event handler fields are the most useful "
1162                 "fields common to\n");
1163
1164         fprintf(ofp, "# all events.  They don't necessarily correspond to "
1165                 "the 'common_*' fields\n");
1166
1167         fprintf(ofp, "# in the format files.  Those fields not available as "
1168                 "handler params can\n");
1169
1170         fprintf(ofp, "# be retrieved using Python functions of the form "
1171                 "common_*(context).\n");
1172
1173         fprintf(ofp, "# See the perf-trace-python Documentation for the list "
1174                 "of available functions.\n\n");
1175
1176         fprintf(ofp, "import os\n");
1177         fprintf(ofp, "import sys\n\n");
1178
1179         fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
1180         fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
1181         fprintf(ofp, "\nfrom perf_trace_context import *\n");
1182         fprintf(ofp, "from Core import *\n\n\n");
1183
1184         fprintf(ofp, "def trace_begin():\n");
1185         fprintf(ofp, "\tprint \"in trace_begin\"\n\n");
1186
1187         fprintf(ofp, "def trace_end():\n");
1188         fprintf(ofp, "\tprint \"in trace_end\"\n\n");
1189
1190         while ((event = trace_find_next_event(pevent, event))) {
1191                 fprintf(ofp, "def %s__%s(", event->system, event->name);
1192                 fprintf(ofp, "event_name, ");
1193                 fprintf(ofp, "context, ");
1194                 fprintf(ofp, "common_cpu,\n");
1195                 fprintf(ofp, "\tcommon_secs, ");
1196                 fprintf(ofp, "common_nsecs, ");
1197                 fprintf(ofp, "common_pid, ");
1198                 fprintf(ofp, "common_comm,\n\t");
1199                 fprintf(ofp, "common_callchain, ");
1200
1201                 not_first = 0;
1202                 count = 0;
1203
1204                 for (f = event->format.fields; f; f = f->next) {
1205                         if (not_first++)
1206                                 fprintf(ofp, ", ");
1207                         if (++count % 5 == 0)
1208                                 fprintf(ofp, "\n\t");
1209
1210                         fprintf(ofp, "%s", f->name);
1211                 }
1212                 fprintf(ofp, "):\n");
1213
1214                 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
1215                         "common_secs, common_nsecs,\n\t\t\t"
1216                         "common_pid, common_comm)\n\n");
1217
1218                 fprintf(ofp, "\t\tprint \"");
1219
1220                 not_first = 0;
1221                 count = 0;
1222
1223                 for (f = event->format.fields; f; f = f->next) {
1224                         if (not_first++)
1225                                 fprintf(ofp, ", ");
1226                         if (count && count % 3 == 0) {
1227                                 fprintf(ofp, "\" \\\n\t\t\"");
1228                         }
1229                         count++;
1230
1231                         fprintf(ofp, "%s=", f->name);
1232                         if (f->flags & FIELD_IS_STRING ||
1233                             f->flags & FIELD_IS_FLAG ||
1234                             f->flags & FIELD_IS_ARRAY ||
1235                             f->flags & FIELD_IS_SYMBOLIC)
1236                                 fprintf(ofp, "%%s");
1237                         else if (f->flags & FIELD_IS_SIGNED)
1238                                 fprintf(ofp, "%%d");
1239                         else
1240                                 fprintf(ofp, "%%u");
1241                 }
1242
1243                 fprintf(ofp, "\" %% \\\n\t\t(");
1244
1245                 not_first = 0;
1246                 count = 0;
1247
1248                 for (f = event->format.fields; f; f = f->next) {
1249                         if (not_first++)
1250                                 fprintf(ofp, ", ");
1251
1252                         if (++count % 5 == 0)
1253                                 fprintf(ofp, "\n\t\t");
1254
1255                         if (f->flags & FIELD_IS_FLAG) {
1256                                 if ((count - 1) % 5 != 0) {
1257                                         fprintf(ofp, "\n\t\t");
1258                                         count = 4;
1259                                 }
1260                                 fprintf(ofp, "flag_str(\"");
1261                                 fprintf(ofp, "%s__%s\", ", event->system,
1262                                         event->name);
1263                                 fprintf(ofp, "\"%s\", %s)", f->name,
1264                                         f->name);
1265                         } else if (f->flags & FIELD_IS_SYMBOLIC) {
1266                                 if ((count - 1) % 5 != 0) {
1267                                         fprintf(ofp, "\n\t\t");
1268                                         count = 4;
1269                                 }
1270                                 fprintf(ofp, "symbol_str(\"");
1271                                 fprintf(ofp, "%s__%s\", ", event->system,
1272                                         event->name);
1273                                 fprintf(ofp, "\"%s\", %s)", f->name,
1274                                         f->name);
1275                         } else
1276                                 fprintf(ofp, "%s", f->name);
1277                 }
1278
1279                 fprintf(ofp, ")\n\n");
1280
1281                 fprintf(ofp, "\t\tfor node in common_callchain:");
1282                 fprintf(ofp, "\n\t\t\tif 'sym' in node:");
1283                 fprintf(ofp, "\n\t\t\t\tprint \"\\t[%%x] %%s\" %% (node['ip'], node['sym']['name'])");
1284                 fprintf(ofp, "\n\t\t\telse:");
1285                 fprintf(ofp, "\n\t\t\t\tprint \"\t[%%x]\" %% (node['ip'])\n\n");
1286                 fprintf(ofp, "\t\tprint \"\\n\"\n\n");
1287
1288         }
1289
1290         fprintf(ofp, "def trace_unhandled(event_name, context, "
1291                 "event_fields_dict):\n");
1292
1293         fprintf(ofp, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
1294                 "for k,v in sorted(event_fields_dict.items())])\n\n");
1295
1296         fprintf(ofp, "def print_header("
1297                 "event_name, cpu, secs, nsecs, pid, comm):\n"
1298                 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
1299                 "(event_name, cpu, secs, nsecs, pid, comm),\n");
1300
1301         fclose(ofp);
1302
1303         fprintf(stderr, "generated Python script: %s\n", fname);
1304
1305         return 0;
1306 }
1307
1308 struct scripting_ops python_scripting_ops = {
1309         .name                   = "Python",
1310         .start_script           = python_start_script,
1311         .flush_script           = python_flush_script,
1312         .stop_script            = python_stop_script,
1313         .process_event          = python_process_event,
1314         .process_stat           = python_process_stat,
1315         .process_stat_interval  = python_process_stat_interval,
1316         .generate_script        = python_generate_script,
1317 };