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 <inttypes.h>
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <stdbool.h>
  29 #include <errno.h>
  30 #include <linux/bitmap.h>
  31 #include <linux/compiler.h>
  32 #include <linux/time64.h>
  33
  34 #include "../build-id.h"
  35 #include "../counts.h"
  36 #include "../debug.h"
  37 #include "../dso.h"
  38 #include "../callchain.h"
  39 #include "../evsel.h"
  40 #include "../event.h"
  41 #include "../thread.h"
  42 #include "../comm.h"
  43 #include "../machine.h"
  44 #include "../db-export.h"
  45 #include "../thread-stack.h"
  46 #include "../trace-event.h"
  47 #include "../call-path.h"
  48 #include "map.h"
  49 #include "symbol.h"
  50 #include "thread_map.h"
  51 #include "print_binary.h"
  52 #include "stat.h"
  53 #include "mem-events.h"
  54
  55 #if PY_MAJOR_VERSION < 3
  56 #define _PyUnicode_FromString(arg) \
  57   PyString_FromString(arg)
  58 #define _PyUnicode_FromStringAndSize(arg1, arg2) \
  59   PyString_FromStringAndSize((arg1), (arg2))
  60 #define _PyBytes_FromStringAndSize(arg1, arg2) \
  61   PyString_FromStringAndSize((arg1), (arg2))
  62 #define _PyLong_FromLong(arg) \
  63   PyInt_FromLong(arg)
  64 #define _PyLong_AsLong(arg) \
  65   PyInt_AsLong(arg)
  66 #define _PyCapsule_New(arg1, arg2, arg3) \
  67   PyCObject_FromVoidPtr((arg1), (arg2))
  68
  69 PyMODINIT_FUNC initperf_trace_context(void);
  70 #else
  71 #define _PyUnicode_FromString(arg) \
  72   PyUnicode_FromString(arg)
  73 #define _PyUnicode_FromStringAndSize(arg1, arg2) \
  74   PyUnicode_FromStringAndSize((arg1), (arg2))
  75 #define _PyBytes_FromStringAndSize(arg1, arg2) \
  76   PyBytes_FromStringAndSize((arg1), (arg2))
  77 #define _PyLong_FromLong(arg) \
  78   PyLong_FromLong(arg)
  79 #define _PyLong_AsLong(arg) \
  80   PyLong_AsLong(arg)
  81 #define _PyCapsule_New(arg1, arg2, arg3) \
  82   PyCapsule_New((arg1), (arg2), (arg3))
  83
  84 PyMODINIT_FUNC PyInit_perf_trace_context(void);
  85 #endif
  86
  87 #define TRACE_EVENT_TYPE_MAX                            \
  88         ((1 << (sizeof(unsigned short) * 8)) - 1)
  89
  90 static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
  91
  92 #define MAX_FIELDS      64
  93 #define N_COMMON_FIELDS 7
  94
  95 extern struct scripting_context *scripting_context;
  96
  97 static char *cur_field_name;
  98 static int zero_flag_atom;
  99
 100 static PyObject *main_module, *main_dict;
 101
 102 struct tables {
 103         struct db_export        dbe;
 104         PyObject                *evsel_handler;
 105         PyObject                *machine_handler;
 106         PyObject                *thread_handler;
 107         PyObject                *comm_handler;
 108         PyObject                *comm_thread_handler;
 109         PyObject                *dso_handler;
 110         PyObject                *symbol_handler;
 111         PyObject                *branch_type_handler;
 112         PyObject                *sample_handler;
 113         PyObject                *call_path_handler;
 114         PyObject                *call_return_handler;
 115         PyObject                *synth_handler;
 116         PyObject                *context_switch_handler;
 117         bool                    db_export_mode;
 118 };
 119
 120 static struct tables tables_global;
 121
 122 static void handler_call_die(const char *handler_name) __noreturn;
 123 static void handler_call_die(const char *handler_name)
 124 {
 125         PyErr_Print();
 126         Py_FatalError("problem in Python trace event handler");
 127         // Py_FatalError does not return
 128         // but we have to make the compiler happy
 129         abort();
 130 }
 131
 132 /*
 133  * Insert val into into the dictionary and decrement the reference counter.
 134  * This is necessary for dictionaries since PyDict_SetItemString() does not
 135  * steal a reference, as opposed to PyTuple_SetItem().
 136  */
 137 static void pydict_set_item_string_decref(PyObject *dict, const char *key, PyObject *val)
 138 {
 139         PyDict_SetItemString(dict, key, val);
 140         Py_DECREF(val);
 141 }
 142
 143 static PyObject *get_handler(const char *handler_name)
 144 {
 145         PyObject *handler;
 146
 147         handler = PyDict_GetItemString(main_dict, handler_name);
 148         if (handler && !PyCallable_Check(handler))
 149                 return NULL;
 150         return handler;
 151 }
 152
 153 static int get_argument_count(PyObject *handler)
 154 {
 155         int arg_count = 0;
 156
 157         /*
 158          * The attribute for the code object is func_code in Python 2,
 159          * whereas it is __code__ in Python 3.0+.
 160          */
 161         PyObject *code_obj = PyObject_GetAttrString(handler,
 162                 "func_code");
 163         if (PyErr_Occurred()) {
 164                 PyErr_Clear();
 165                 code_obj = PyObject_GetAttrString(handler,
 166                         "__code__");
 167         }
 168         PyErr_Clear();
 169         if (code_obj) {
 170                 PyObject *arg_count_obj = PyObject_GetAttrString(code_obj,
 171                         "co_argcount");
 172                 if (arg_count_obj) {
 173                         arg_count = (int) _PyLong_AsLong(arg_count_obj);
 174                         Py_DECREF(arg_count_obj);
 175                 }
 176                 Py_DECREF(code_obj);
 177         }
 178         return arg_count;
 179 }
 180
 181 static void call_object(PyObject *handler, PyObject *args, const char *die_msg)
 182 {
 183         PyObject *retval;
 184
 185         retval = PyObject_CallObject(handler, args);
 186         if (retval == NULL)
 187                 handler_call_die(die_msg);
 188         Py_DECREF(retval);
 189 }
 190
 191 static void try_call_object(const char *handler_name, PyObject *args)
 192 {
 193         PyObject *handler;
 194
 195         handler = get_handler(handler_name);
 196         if (handler)
 197                 call_object(handler, args, handler_name);
 198 }
 199
 200 static void define_value(enum tep_print_arg_type field_type,
 201                          const char *ev_name,
 202                          const char *field_name,
 203                          const char *field_value,
 204                          const char *field_str)
 205 {
 206         const char *handler_name = "define_flag_value";
 207         PyObject *t;
 208         unsigned long long value;
 209         unsigned n = 0;
 210
 211         if (field_type == TEP_PRINT_SYMBOL)
 212                 handler_name = "define_symbolic_value";
 213
 214         t = PyTuple_New(4);
 215         if (!t)
 216                 Py_FatalError("couldn't create Python tuple");
 217
 218         value = eval_flag(field_value);
 219
 220         PyTuple_SetItem(t, n++, _PyUnicode_FromString(ev_name));
 221         PyTuple_SetItem(t, n++, _PyUnicode_FromString(field_name));
 222         PyTuple_SetItem(t, n++, _PyLong_FromLong(value));
 223         PyTuple_SetItem(t, n++, _PyUnicode_FromString(field_str));
 224
 225         try_call_object(handler_name, t);
 226
 227         Py_DECREF(t);
 228 }
 229
 230 static void define_values(enum tep_print_arg_type field_type,
 231                           struct tep_print_flag_sym *field,
 232                           const char *ev_name,
 233                           const char *field_name)
 234 {
 235         define_value(field_type, ev_name, field_name, field->value,
 236                      field->str);
 237
 238         if (field->next)
 239                 define_values(field_type, field->next, ev_name, field_name);
 240 }
 241
 242 static void define_field(enum tep_print_arg_type field_type,
 243                          const char *ev_name,
 244                          const char *field_name,
 245                          const char *delim)
 246 {
 247         const char *handler_name = "define_flag_field";
 248         PyObject *t;
 249         unsigned n = 0;
 250
 251         if (field_type == TEP_PRINT_SYMBOL)
 252                 handler_name = "define_symbolic_field";
 253
 254         if (field_type == TEP_PRINT_FLAGS)
 255                 t = PyTuple_New(3);
 256         else
 257                 t = PyTuple_New(2);
 258         if (!t)
 259                 Py_FatalError("couldn't create Python tuple");
 260
 261         PyTuple_SetItem(t, n++, _PyUnicode_FromString(ev_name));
 262         PyTuple_SetItem(t, n++, _PyUnicode_FromString(field_name));
 263         if (field_type == TEP_PRINT_FLAGS)
 264                 PyTuple_SetItem(t, n++, _PyUnicode_FromString(delim));
 265
 266         try_call_object(handler_name, t);
 267
 268         Py_DECREF(t);
 269 }
 270
 271 static void define_event_symbols(struct tep_event *event,
 272                                  const char *ev_name,
 273                                  struct tep_print_arg *args)
 274 {
 275         if (args == NULL)
 276                 return;
 277
 278         switch (args->type) {
 279         case TEP_PRINT_NULL:
 280                 break;
 281         case TEP_PRINT_ATOM:
 282                 define_value(TEP_PRINT_FLAGS, ev_name, cur_field_name, "0",
 283                              args->atom.atom);
 284                 zero_flag_atom = 0;
 285                 break;
 286         case TEP_PRINT_FIELD:
 287                 free(cur_field_name);
 288                 cur_field_name = strdup(args->field.name);
 289                 break;
 290         case TEP_PRINT_FLAGS:
 291                 define_event_symbols(event, ev_name, args->flags.field);
 292                 define_field(TEP_PRINT_FLAGS, ev_name, cur_field_name,
 293                              args->flags.delim);
 294                 define_values(TEP_PRINT_FLAGS, args->flags.flags, ev_name,
 295                               cur_field_name);
 296                 break;
 297         case TEP_PRINT_SYMBOL:
 298                 define_event_symbols(event, ev_name, args->symbol.field);
 299                 define_field(TEP_PRINT_SYMBOL, ev_name, cur_field_name, NULL);
 300                 define_values(TEP_PRINT_SYMBOL, args->symbol.symbols, ev_name,
 301                               cur_field_name);
 302                 break;
 303         case TEP_PRINT_HEX:
 304         case TEP_PRINT_HEX_STR:
 305                 define_event_symbols(event, ev_name, args->hex.field);
 306                 define_event_symbols(event, ev_name, args->hex.size);
 307                 break;
 308         case TEP_PRINT_INT_ARRAY:
 309                 define_event_symbols(event, ev_name, args->int_array.field);
 310                 define_event_symbols(event, ev_name, args->int_array.count);
 311                 define_event_symbols(event, ev_name, args->int_array.el_size);
 312                 break;
 313         case TEP_PRINT_STRING:
 314                 break;
 315         case TEP_PRINT_TYPE:
 316                 define_event_symbols(event, ev_name, args->typecast.item);
 317                 break;
 318         case TEP_PRINT_OP:
 319                 if (strcmp(args->op.op, ":") == 0)
 320                         zero_flag_atom = 1;
 321                 define_event_symbols(event, ev_name, args->op.left);
 322                 define_event_symbols(event, ev_name, args->op.right);
 323                 break;
 324         default:
 325                 /* gcc warns for these? */
 326         case TEP_PRINT_BSTRING:
 327         case TEP_PRINT_DYNAMIC_ARRAY:
 328         case TEP_PRINT_DYNAMIC_ARRAY_LEN:
 329         case TEP_PRINT_FUNC:
 330         case TEP_PRINT_BITMASK:
 331                 /* we should warn... */
 332                 return;
 333         }
 334
 335         if (args->next)
 336                 define_event_symbols(event, ev_name, args->next);
 337 }
 338
 339 static PyObject *get_field_numeric_entry(struct tep_event *event,
 340                 struct tep_format_field *field, void *data)
 341 {
 342         bool is_array = field->flags & TEP_FIELD_IS_ARRAY;
 343         PyObject *obj = NULL, *list = NULL;
 344         unsigned long long val;
 345         unsigned int item_size, n_items, i;
 346
 347         if (is_array) {
 348                 list = PyList_New(field->arraylen);
 349                 item_size = field->size / field->arraylen;
 350                 n_items = field->arraylen;
 351         } else {
 352                 item_size = field->size;
 353                 n_items = 1;
 354         }
 355
 356         for (i = 0; i < n_items; i++) {
 357
 358                 val = read_size(event, data + field->offset + i * item_size,
 359                                 item_size);
 360                 if (field->flags & TEP_FIELD_IS_SIGNED) {
 361                         if ((long long)val >= LONG_MIN &&
 362                                         (long long)val <= LONG_MAX)
 363                                 obj = _PyLong_FromLong(val);
 364                         else
 365                                 obj = PyLong_FromLongLong(val);
 366                 } else {
 367                         if (val <= LONG_MAX)
 368                                 obj = _PyLong_FromLong(val);
 369                         else
 370                                 obj = PyLong_FromUnsignedLongLong(val);
 371                 }
 372                 if (is_array)
 373                         PyList_SET_ITEM(list, i, obj);
 374         }
 375         if (is_array)
 376                 obj = list;
 377         return obj;
 378 }
 379
 380 static const char *get_dsoname(struct map *map)
 381 {
 382         const char *dsoname = "[unknown]";
 383
 384         if (map && map->dso) {
 385                 if (symbol_conf.show_kernel_path && map->dso->long_name)
 386                         dsoname = map->dso->long_name;
 387                 else
 388                         dsoname = map->dso->name;
 389         }
 390
 391         return dsoname;
 392 }
 393
 394 static PyObject *python_process_callchain(struct perf_sample *sample,
 395                                          struct evsel *evsel,
 396                                          struct addr_location *al)
 397 {
 398         PyObject *pylist;
 399
 400         pylist = PyList_New(0);
 401         if (!pylist)
 402                 Py_FatalError("couldn't create Python list");
 403
 404         if (!symbol_conf.use_callchain || !sample->callchain)
 405                 goto exit;
 406
 407         if (thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
 408                                       sample, NULL, NULL,
 409                                       scripting_max_stack) != 0) {
 410                 pr_err("Failed to resolve callchain. Skipping\n");
 411                 goto exit;
 412         }
 413         callchain_cursor_commit(&callchain_cursor);
 414
 415
 416         while (1) {
 417                 PyObject *pyelem;
 418                 struct callchain_cursor_node *node;
 419                 node = callchain_cursor_current(&callchain_cursor);
 420                 if (!node)
 421                         break;
 422
 423                 pyelem = PyDict_New();
 424                 if (!pyelem)
 425                         Py_FatalError("couldn't create Python dictionary");
 426
 427
 428                 pydict_set_item_string_decref(pyelem, "ip",
 429                                 PyLong_FromUnsignedLongLong(node->ip));
 430
 431                 if (node->ms.sym) {
 432                         PyObject *pysym  = PyDict_New();
 433                         if (!pysym)
 434                                 Py_FatalError("couldn't create Python dictionary");
 435                         pydict_set_item_string_decref(pysym, "start",
 436                                         PyLong_FromUnsignedLongLong(node->ms.sym->start));
 437                         pydict_set_item_string_decref(pysym, "end",
 438                                         PyLong_FromUnsignedLongLong(node->ms.sym->end));
 439                         pydict_set_item_string_decref(pysym, "binding",
 440                                         _PyLong_FromLong(node->ms.sym->binding));
 441                         pydict_set_item_string_decref(pysym, "name",
 442                                         _PyUnicode_FromStringAndSize(node->ms.sym->name,
 443                                                         node->ms.sym->namelen));
 444                         pydict_set_item_string_decref(pyelem, "sym", pysym);
 445                 }
 446
 447                 if (node->ms.map) {
 448                         const char *dsoname = get_dsoname(node->ms.map);
 449
 450                         pydict_set_item_string_decref(pyelem, "dso",
 451                                         _PyUnicode_FromString(dsoname));
 452                 }
 453
 454                 callchain_cursor_advance(&callchain_cursor);
 455                 PyList_Append(pylist, pyelem);
 456                 Py_DECREF(pyelem);
 457         }
 458
 459 exit:
 460         return pylist;
 461 }
 462
 463 static PyObject *python_process_brstack(struct perf_sample *sample,
 464                                         struct thread *thread)
 465 {
 466         struct branch_stack *br = sample->branch_stack;
 467         struct branch_entry *entries = perf_sample__branch_entries(sample);
 468         PyObject *pylist;
 469         u64 i;
 470
 471         pylist = PyList_New(0);
 472         if (!pylist)
 473                 Py_FatalError("couldn't create Python list");
 474
 475         if (!(br && br->nr))
 476                 goto exit;
 477
 478         for (i = 0; i < br->nr; i++) {
 479                 PyObject *pyelem;
 480                 struct addr_location al;
 481                 const char *dsoname;
 482
 483                 pyelem = PyDict_New();
 484                 if (!pyelem)
 485                         Py_FatalError("couldn't create Python dictionary");
 486
 487                 pydict_set_item_string_decref(pyelem, "from",
 488                     PyLong_FromUnsignedLongLong(entries[i].from));
 489                 pydict_set_item_string_decref(pyelem, "to",
 490                     PyLong_FromUnsignedLongLong(entries[i].to));
 491                 pydict_set_item_string_decref(pyelem, "mispred",
 492                     PyBool_FromLong(entries[i].flags.mispred));
 493                 pydict_set_item_string_decref(pyelem, "predicted",
 494                     PyBool_FromLong(entries[i].flags.predicted));
 495                 pydict_set_item_string_decref(pyelem, "in_tx",
 496                     PyBool_FromLong(entries[i].flags.in_tx));
 497                 pydict_set_item_string_decref(pyelem, "abort",
 498                     PyBool_FromLong(entries[i].flags.abort));
 499                 pydict_set_item_string_decref(pyelem, "cycles",
 500                     PyLong_FromUnsignedLongLong(entries[i].flags.cycles));
 501
 502                 thread__find_map_fb(thread, sample->cpumode,
 503                                     entries[i].from, &al);
 504                 dsoname = get_dsoname(al.map);
 505                 pydict_set_item_string_decref(pyelem, "from_dsoname",
 506                                               _PyUnicode_FromString(dsoname));
 507
 508                 thread__find_map_fb(thread, sample->cpumode,
 509                                     entries[i].to, &al);
 510                 dsoname = get_dsoname(al.map);
 511                 pydict_set_item_string_decref(pyelem, "to_dsoname",
 512                                               _PyUnicode_FromString(dsoname));
 513
 514                 PyList_Append(pylist, pyelem);
 515                 Py_DECREF(pyelem);
 516         }
 517
 518 exit:
 519         return pylist;
 520 }
 521
 522 static unsigned long get_offset(struct symbol *sym, struct addr_location *al)
 523 {
 524         unsigned long offset;
 525
 526         if (al->addr < sym->end)
 527                 offset = al->addr - sym->start;
 528         else
 529                 offset = al->addr - al->map->start - sym->start;
 530
 531         return offset;
 532 }
 533
 534 static int get_symoff(struct symbol *sym, struct addr_location *al,
 535                       bool print_off, char *bf, int size)
 536 {
 537         unsigned long offset;
 538
 539         if (!sym || !sym->name[0])
 540                 return scnprintf(bf, size, "%s", "[unknown]");
 541
 542         if (!print_off)
 543                 return scnprintf(bf, size, "%s", sym->name);
 544
 545         offset = get_offset(sym, al);
 546
 547         return scnprintf(bf, size, "%s+0x%x", sym->name, offset);
 548 }
 549
 550 static int get_br_mspred(struct branch_flags *flags, char *bf, int size)
 551 {
 552         if (!flags->mispred  && !flags->predicted)
 553                 return scnprintf(bf, size, "%s", "-");
 554
 555         if (flags->mispred)
 556                 return scnprintf(bf, size, "%s", "M");
 557
 558         return scnprintf(bf, size, "%s", "P");
 559 }
 560
 561 static PyObject *python_process_brstacksym(struct perf_sample *sample,
 562                                            struct thread *thread)
 563 {
 564         struct branch_stack *br = sample->branch_stack;
 565         struct branch_entry *entries = perf_sample__branch_entries(sample);
 566         PyObject *pylist;
 567         u64 i;
 568         char bf[512];
 569         struct addr_location al;
 570
 571         pylist = PyList_New(0);
 572         if (!pylist)
 573                 Py_FatalError("couldn't create Python list");
 574
 575         if (!(br && br->nr))
 576                 goto exit;
 577
 578         for (i = 0; i < br->nr; i++) {
 579                 PyObject *pyelem;
 580
 581                 pyelem = PyDict_New();
 582                 if (!pyelem)
 583                         Py_FatalError("couldn't create Python dictionary");
 584
 585                 thread__find_symbol_fb(thread, sample->cpumode,
 586                                        entries[i].from, &al);
 587                 get_symoff(al.sym, &al, true, bf, sizeof(bf));
 588                 pydict_set_item_string_decref(pyelem, "from",
 589                                               _PyUnicode_FromString(bf));
 590
 591                 thread__find_symbol_fb(thread, sample->cpumode,
 592                                        entries[i].to, &al);
 593                 get_symoff(al.sym, &al, true, bf, sizeof(bf));
 594                 pydict_set_item_string_decref(pyelem, "to",
 595                                               _PyUnicode_FromString(bf));
 596
 597                 get_br_mspred(&entries[i].flags, bf, sizeof(bf));
 598                 pydict_set_item_string_decref(pyelem, "pred",
 599                                               _PyUnicode_FromString(bf));
 600
 601                 if (entries[i].flags.in_tx) {
 602                         pydict_set_item_string_decref(pyelem, "in_tx",
 603                                               _PyUnicode_FromString("X"));
 604                 } else {
 605                         pydict_set_item_string_decref(pyelem, "in_tx",
 606                                               _PyUnicode_FromString("-"));
 607                 }
 608
 609                 if (entries[i].flags.abort) {
 610                         pydict_set_item_string_decref(pyelem, "abort",
 611                                               _PyUnicode_FromString("A"));
 612                 } else {
 613                         pydict_set_item_string_decref(pyelem, "abort",
 614                                               _PyUnicode_FromString("-"));
 615                 }
 616
 617                 PyList_Append(pylist, pyelem);
 618                 Py_DECREF(pyelem);
 619         }
 620
 621 exit:
 622         return pylist;
 623 }
 624
 625 static PyObject *get_sample_value_as_tuple(struct sample_read_value *value)
 626 {
 627         PyObject *t;
 628
 629         t = PyTuple_New(2);
 630         if (!t)
 631                 Py_FatalError("couldn't create Python tuple");
 632         PyTuple_SetItem(t, 0, PyLong_FromUnsignedLongLong(value->id));
 633         PyTuple_SetItem(t, 1, PyLong_FromUnsignedLongLong(value->value));
 634         return t;
 635 }
 636
 637 static void set_sample_read_in_dict(PyObject *dict_sample,
 638                                          struct perf_sample *sample,
 639                                          struct evsel *evsel)
 640 {
 641         u64 read_format = evsel->core.attr.read_format;
 642         PyObject *values;
 643         unsigned int i;
 644
 645         if (read_format & PERF_FORMAT_TOTAL_TIME_ENABLED) {
 646                 pydict_set_item_string_decref(dict_sample, "time_enabled",
 647                         PyLong_FromUnsignedLongLong(sample->read.time_enabled));
 648         }
 649
 650         if (read_format & PERF_FORMAT_TOTAL_TIME_RUNNING) {
 651                 pydict_set_item_string_decref(dict_sample, "time_running",
 652                         PyLong_FromUnsignedLongLong(sample->read.time_running));
 653         }
 654
 655         if (read_format & PERF_FORMAT_GROUP)
 656                 values = PyList_New(sample->read.group.nr);
 657         else
 658                 values = PyList_New(1);
 659
 660         if (!values)
 661                 Py_FatalError("couldn't create Python list");
 662
 663         if (read_format & PERF_FORMAT_GROUP) {
 664                 for (i = 0; i < sample->read.group.nr; i++) {
 665                         PyObject *t = get_sample_value_as_tuple(&sample->read.group.values[i]);
 666                         PyList_SET_ITEM(values, i, t);
 667                 }
 668         } else {
 669                 PyObject *t = get_sample_value_as_tuple(&sample->read.one);
 670                 PyList_SET_ITEM(values, 0, t);
 671         }
 672         pydict_set_item_string_decref(dict_sample, "values", values);
 673 }
 674
 675 static void set_sample_datasrc_in_dict(PyObject *dict,
 676                                        struct perf_sample *sample)
 677 {
 678         struct mem_info mi = { .data_src.val = sample->data_src };
 679         char decode[100];
 680
 681         pydict_set_item_string_decref(dict, "datasrc",
 682                         PyLong_FromUnsignedLongLong(sample->data_src));
 683
 684         perf_script__meminfo_scnprintf(decode, 100, &mi);
 685
 686         pydict_set_item_string_decref(dict, "datasrc_decode",
 687                         _PyUnicode_FromString(decode));
 688 }
 689
 690 static int regs_map(struct regs_dump *regs, uint64_t mask, char *bf, int size)
 691 {
 692         unsigned int i = 0, r;
 693         int printed = 0;
 694
 695         bf[0] = 0;
 696
 697         if (!regs || !regs->regs)
 698                 return 0;
 699
 700         for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
 701                 u64 val = regs->regs[i++];
 702
 703                 printed += scnprintf(bf + printed, size - printed,
 704                                      "%5s:0x%" PRIx64 " ",
 705                                      perf_reg_name(r), val);
 706         }
 707
 708         return printed;
 709 }
 710
 711 static void set_regs_in_dict(PyObject *dict,
 712                              struct perf_sample *sample,
 713                              struct evsel *evsel)
 714 {
 715         struct perf_event_attr *attr = &evsel->core.attr;
 716         char bf[512];
 717
 718         regs_map(&sample->intr_regs, attr->sample_regs_intr, bf, sizeof(bf));
 719
 720         pydict_set_item_string_decref(dict, "iregs",
 721                         _PyUnicode_FromString(bf));
 722
 723         regs_map(&sample->user_regs, attr->sample_regs_user, bf, sizeof(bf));
 724
 725         pydict_set_item_string_decref(dict, "uregs",
 726                         _PyUnicode_FromString(bf));
 727 }
 728
 729 static void set_sym_in_dict(PyObject *dict, struct addr_location *al,
 730                             const char *dso_field, const char *sym_field,
 731                             const char *symoff_field)
 732 {
 733         if (al->map) {
 734                 pydict_set_item_string_decref(dict, dso_field,
 735                         _PyUnicode_FromString(al->map->dso->name));
 736         }
 737         if (al->sym) {
 738                 pydict_set_item_string_decref(dict, sym_field,
 739                         _PyUnicode_FromString(al->sym->name));
 740                 pydict_set_item_string_decref(dict, symoff_field,
 741                         PyLong_FromUnsignedLong(get_offset(al->sym, al)));
 742         }
 743 }
 744
 745 static PyObject *get_perf_sample_dict(struct perf_sample *sample,
 746                                          struct evsel *evsel,
 747                                          struct addr_location *al,
 748                                          struct addr_location *addr_al,
 749                                          PyObject *callchain)
 750 {
 751         PyObject *dict, *dict_sample, *brstack, *brstacksym;
 752
 753         dict = PyDict_New();
 754         if (!dict)
 755                 Py_FatalError("couldn't create Python dictionary");
 756
 757         dict_sample = PyDict_New();
 758         if (!dict_sample)
 759                 Py_FatalError("couldn't create Python dictionary");
 760
 761         pydict_set_item_string_decref(dict, "ev_name", _PyUnicode_FromString(evsel__name(evsel)));
 762         pydict_set_item_string_decref(dict, "attr", _PyBytes_FromStringAndSize((const char *)&evsel->core.attr, sizeof(evsel->core.attr)));
 763
 764         pydict_set_item_string_decref(dict_sample, "pid",
 765                         _PyLong_FromLong(sample->pid));
 766         pydict_set_item_string_decref(dict_sample, "tid",
 767                         _PyLong_FromLong(sample->tid));
 768         pydict_set_item_string_decref(dict_sample, "cpu",
 769                         _PyLong_FromLong(sample->cpu));
 770         pydict_set_item_string_decref(dict_sample, "ip",
 771                         PyLong_FromUnsignedLongLong(sample->ip));
 772         pydict_set_item_string_decref(dict_sample, "time",
 773                         PyLong_FromUnsignedLongLong(sample->time));
 774         pydict_set_item_string_decref(dict_sample, "period",
 775                         PyLong_FromUnsignedLongLong(sample->period));
 776         pydict_set_item_string_decref(dict_sample, "phys_addr",
 777                         PyLong_FromUnsignedLongLong(sample->phys_addr));
 778         pydict_set_item_string_decref(dict_sample, "addr",
 779                         PyLong_FromUnsignedLongLong(sample->addr));
 780         set_sample_read_in_dict(dict_sample, sample, evsel);
 781         pydict_set_item_string_decref(dict_sample, "weight",
 782                         PyLong_FromUnsignedLongLong(sample->weight));
 783         pydict_set_item_string_decref(dict_sample, "transaction",
 784                         PyLong_FromUnsignedLongLong(sample->transaction));
 785         set_sample_datasrc_in_dict(dict_sample, sample);
 786         pydict_set_item_string_decref(dict, "sample", dict_sample);
 787
 788         pydict_set_item_string_decref(dict, "raw_buf", _PyBytes_FromStringAndSize(
 789                         (const char *)sample->raw_data, sample->raw_size));
 790         pydict_set_item_string_decref(dict, "comm",
 791                         _PyUnicode_FromString(thread__comm_str(al->thread)));
 792         set_sym_in_dict(dict, al, "dso", "symbol", "symoff");
 793
 794         pydict_set_item_string_decref(dict, "callchain", callchain);
 795
 796         brstack = python_process_brstack(sample, al->thread);
 797         pydict_set_item_string_decref(dict, "brstack", brstack);
 798
 799         brstacksym = python_process_brstacksym(sample, al->thread);
 800         pydict_set_item_string_decref(dict, "brstacksym", brstacksym);
 801
 802         if (addr_al) {
 803                 pydict_set_item_string_decref(dict_sample, "addr_correlates_sym",
 804                         PyBool_FromLong(1));
 805                 set_sym_in_dict(dict_sample, addr_al, "addr_dso", "addr_symbol", "addr_symoff");
 806         }
 807
 808         set_regs_in_dict(dict, sample, evsel);
 809
 810         return dict;
 811 }
 812
 813 static void python_process_tracepoint(struct perf_sample *sample,
 814                                       struct evsel *evsel,
 815                                       struct addr_location *al,
 816                                       struct addr_location *addr_al)
 817 {
 818         struct tep_event *event = evsel->tp_format;
 819         PyObject *handler, *context, *t, *obj = NULL, *callchain;
 820         PyObject *dict = NULL, *all_entries_dict = NULL;
 821         static char handler_name[256];
 822         struct tep_format_field *field;
 823         unsigned long s, ns;
 824         unsigned n = 0;
 825         int pid;
 826         int cpu = sample->cpu;
 827         void *data = sample->raw_data;
 828         unsigned long long nsecs = sample->time;
 829         const char *comm = thread__comm_str(al->thread);
 830         const char *default_handler_name = "trace_unhandled";
 831
 832         if (!event) {
 833                 snprintf(handler_name, sizeof(handler_name),
 834                          "ug! no event found for type %" PRIu64, (u64)evsel->core.attr.config);
 835                 Py_FatalError(handler_name);
 836         }
 837
 838         pid = raw_field_value(event, "common_pid", data);
 839
 840         sprintf(handler_name, "%s__%s", event->system, event->name);
 841
 842         if (!test_and_set_bit(event->id, events_defined))
 843                 define_event_symbols(event, handler_name, event->print_fmt.args);
 844
 845         handler = get_handler(handler_name);
 846         if (!handler) {
 847                 handler = get_handler(default_handler_name);
 848                 if (!handler)
 849                         return;
 850                 dict = PyDict_New();
 851                 if (!dict)
 852                         Py_FatalError("couldn't create Python dict");
 853         }
 854
 855         t = PyTuple_New(MAX_FIELDS);
 856         if (!t)
 857                 Py_FatalError("couldn't create Python tuple");
 858
 859
 860         s = nsecs / NSEC_PER_SEC;
 861         ns = nsecs - s * NSEC_PER_SEC;
 862
 863         scripting_context->event_data = data;
 864         scripting_context->pevent = evsel->tp_format->tep;
 865
 866         context = _PyCapsule_New(scripting_context, NULL, NULL);
 867
 868         PyTuple_SetItem(t, n++, _PyUnicode_FromString(handler_name));
 869         PyTuple_SetItem(t, n++, context);
 870
 871         /* ip unwinding */
 872         callchain = python_process_callchain(sample, evsel, al);
 873         /* Need an additional reference for the perf_sample dict */
 874         Py_INCREF(callchain);
 875
 876         if (!dict) {
 877                 PyTuple_SetItem(t, n++, _PyLong_FromLong(cpu));
 878                 PyTuple_SetItem(t, n++, _PyLong_FromLong(s));
 879                 PyTuple_SetItem(t, n++, _PyLong_FromLong(ns));
 880                 PyTuple_SetItem(t, n++, _PyLong_FromLong(pid));
 881                 PyTuple_SetItem(t, n++, _PyUnicode_FromString(comm));
 882                 PyTuple_SetItem(t, n++, callchain);
 883         } else {
 884                 pydict_set_item_string_decref(dict, "common_cpu", _PyLong_FromLong(cpu));
 885                 pydict_set_item_string_decref(dict, "common_s", _PyLong_FromLong(s));
 886                 pydict_set_item_string_decref(dict, "common_ns", _PyLong_FromLong(ns));
 887                 pydict_set_item_string_decref(dict, "common_pid", _PyLong_FromLong(pid));
 888                 pydict_set_item_string_decref(dict, "common_comm", _PyUnicode_FromString(comm));
 889                 pydict_set_item_string_decref(dict, "common_callchain", callchain);
 890         }
 891         for (field = event->format.fields; field; field = field->next) {
 892                 unsigned int offset, len;
 893                 unsigned long long val;
 894
 895                 if (field->flags & TEP_FIELD_IS_ARRAY) {
 896                         offset = field->offset;
 897                         len    = field->size;
 898                         if (field->flags & TEP_FIELD_IS_DYNAMIC) {
 899                                 val     = tep_read_number(scripting_context->pevent,
 900                                                           data + offset, len);
 901                                 offset  = val;
 902                                 len     = offset >> 16;
 903                                 offset &= 0xffff;
 904                         }
 905                         if (field->flags & TEP_FIELD_IS_STRING &&
 906                             is_printable_array(data + offset, len)) {
 907                                 obj = _PyUnicode_FromString((char *) data + offset);
 908                         } else {
 909                                 obj = PyByteArray_FromStringAndSize((const char *) data + offset, len);
 910                                 field->flags &= ~TEP_FIELD_IS_STRING;
 911                         }
 912                 } else { /* FIELD_IS_NUMERIC */
 913                         obj = get_field_numeric_entry(event, field, data);
 914                 }
 915                 if (!dict)
 916                         PyTuple_SetItem(t, n++, obj);
 917                 else
 918                         pydict_set_item_string_decref(dict, field->name, obj);
 919
 920         }
 921
 922         if (dict)
 923                 PyTuple_SetItem(t, n++, dict);
 924
 925         if (get_argument_count(handler) == (int) n + 1) {
 926                 all_entries_dict = get_perf_sample_dict(sample, evsel, al, addr_al,
 927                         callchain);
 928                 PyTuple_SetItem(t, n++, all_entries_dict);
 929         } else {
 930                 Py_DECREF(callchain);
 931         }
 932
 933         if (_PyTuple_Resize(&t, n) == -1)
 934                 Py_FatalError("error resizing Python tuple");
 935
 936         if (!dict)
 937                 call_object(handler, t, handler_name);
 938         else
 939                 call_object(handler, t, default_handler_name);
 940
 941         Py_DECREF(t);
 942 }
 943
 944 static PyObject *tuple_new(unsigned int sz)
 945 {
 946         PyObject *t;
 947
 948         t = PyTuple_New(sz);
 949         if (!t)
 950                 Py_FatalError("couldn't create Python tuple");
 951         return t;
 952 }
 953
 954 static int tuple_set_s64(PyObject *t, unsigned int pos, s64 val)
 955 {
 956 #if BITS_PER_LONG == 64
 957         return PyTuple_SetItem(t, pos, _PyLong_FromLong(val));
 958 #endif
 959 #if BITS_PER_LONG == 32
 960         return PyTuple_SetItem(t, pos, PyLong_FromLongLong(val));
 961 #endif
 962 }
 963
 964 /*
 965  * Databases support only signed 64-bit numbers, so even though we are
 966  * exporting a u64, it must be as s64.
 967  */
 968 #define tuple_set_d64 tuple_set_s64
 969
 970 static int tuple_set_u64(PyObject *t, unsigned int pos, u64 val)
 971 {
 972 #if BITS_PER_LONG == 64
 973         return PyTuple_SetItem(t, pos, PyLong_FromUnsignedLong(val));
 974 #endif
 975 #if BITS_PER_LONG == 32
 976         return PyTuple_SetItem(t, pos, PyLong_FromUnsignedLongLong(val));
 977 #endif
 978 }
 979
 980 static int tuple_set_s32(PyObject *t, unsigned int pos, s32 val)
 981 {
 982         return PyTuple_SetItem(t, pos, _PyLong_FromLong(val));
 983 }
 984
 985 static int tuple_set_string(PyObject *t, unsigned int pos, const char *s)
 986 {
 987         return PyTuple_SetItem(t, pos, _PyUnicode_FromString(s));
 988 }
 989
 990 static int tuple_set_bytes(PyObject *t, unsigned int pos, void *bytes,
 991                            unsigned int sz)
 992 {
 993         return PyTuple_SetItem(t, pos, _PyBytes_FromStringAndSize(bytes, sz));
 994 }
 995
 996 static int python_export_evsel(struct db_export *dbe, struct evsel *evsel)
 997 {
 998         struct tables *tables = container_of(dbe, struct tables, dbe);
 999         PyObject *t;
1000
1001         t = tuple_new(2);
1002
1003         tuple_set_d64(t, 0, evsel->db_id);
1004         tuple_set_string(t, 1, evsel__name(evsel));
1005
1006         call_object(tables->evsel_handler, t, "evsel_table");
1007
1008         Py_DECREF(t);
1009
1010         return 0;
1011 }
1012
1013 static int python_export_machine(struct db_export *dbe,
1014                                  struct machine *machine)
1015 {
1016         struct tables *tables = container_of(dbe, struct tables, dbe);
1017         PyObject *t;
1018
1019         t = tuple_new(3);
1020
1021         tuple_set_d64(t, 0, machine->db_id);
1022         tuple_set_s32(t, 1, machine->pid);
1023         tuple_set_string(t, 2, machine->root_dir ? machine->root_dir : "");
1024
1025         call_object(tables->machine_handler, t, "machine_table");
1026
1027         Py_DECREF(t);
1028
1029         return 0;
1030 }
1031
1032 static int python_export_thread(struct db_export *dbe, struct thread *thread,
1033                                 u64 main_thread_db_id, struct machine *machine)
1034 {
1035         struct tables *tables = container_of(dbe, struct tables, dbe);
1036         PyObject *t;
1037
1038         t = tuple_new(5);
1039
1040         tuple_set_d64(t, 0, thread->db_id);
1041         tuple_set_d64(t, 1, machine->db_id);
1042         tuple_set_d64(t, 2, main_thread_db_id);
1043         tuple_set_s32(t, 3, thread->pid_);
1044         tuple_set_s32(t, 4, thread->tid);
1045
1046         call_object(tables->thread_handler, t, "thread_table");
1047
1048         Py_DECREF(t);
1049
1050         return 0;
1051 }
1052
1053 static int python_export_comm(struct db_export *dbe, struct comm *comm,
1054                               struct thread *thread)
1055 {
1056         struct tables *tables = container_of(dbe, struct tables, dbe);
1057         PyObject *t;
1058
1059         t = tuple_new(5);
1060
1061         tuple_set_d64(t, 0, comm->db_id);
1062         tuple_set_string(t, 1, comm__str(comm));
1063         tuple_set_d64(t, 2, thread->db_id);
1064         tuple_set_d64(t, 3, comm->start);
1065         tuple_set_s32(t, 4, comm->exec);
1066
1067         call_object(tables->comm_handler, t, "comm_table");
1068
1069         Py_DECREF(t);
1070
1071         return 0;
1072 }
1073
1074 static int python_export_comm_thread(struct db_export *dbe, u64 db_id,
1075                                      struct comm *comm, struct thread *thread)
1076 {
1077         struct tables *tables = container_of(dbe, struct tables, dbe);
1078         PyObject *t;
1079
1080         t = tuple_new(3);
1081
1082         tuple_set_d64(t, 0, db_id);
1083         tuple_set_d64(t, 1, comm->db_id);
1084         tuple_set_d64(t, 2, thread->db_id);
1085
1086         call_object(tables->comm_thread_handler, t, "comm_thread_table");
1087
1088         Py_DECREF(t);
1089
1090         return 0;
1091 }
1092
1093 static int python_export_dso(struct db_export *dbe, struct dso *dso,
1094                              struct machine *machine)
1095 {
1096         struct tables *tables = container_of(dbe, struct tables, dbe);
1097         char sbuild_id[SBUILD_ID_SIZE];
1098         PyObject *t;
1099
1100         build_id__sprintf(&dso->bid, sbuild_id);
1101
1102         t = tuple_new(5);
1103
1104         tuple_set_d64(t, 0, dso->db_id);
1105         tuple_set_d64(t, 1, machine->db_id);
1106         tuple_set_string(t, 2, dso->short_name);
1107         tuple_set_string(t, 3, dso->long_name);
1108         tuple_set_string(t, 4, sbuild_id);
1109
1110         call_object(tables->dso_handler, t, "dso_table");
1111
1112         Py_DECREF(t);
1113
1114         return 0;
1115 }
1116
1117 static int python_export_symbol(struct db_export *dbe, struct symbol *sym,
1118                                 struct dso *dso)
1119 {
1120         struct tables *tables = container_of(dbe, struct tables, dbe);
1121         u64 *sym_db_id = symbol__priv(sym);
1122         PyObject *t;
1123
1124         t = tuple_new(6);
1125
1126         tuple_set_d64(t, 0, *sym_db_id);
1127         tuple_set_d64(t, 1, dso->db_id);
1128         tuple_set_d64(t, 2, sym->start);
1129         tuple_set_d64(t, 3, sym->end);
1130         tuple_set_s32(t, 4, sym->binding);
1131         tuple_set_string(t, 5, sym->name);
1132
1133         call_object(tables->symbol_handler, t, "symbol_table");
1134
1135         Py_DECREF(t);
1136
1137         return 0;
1138 }
1139
1140 static int python_export_branch_type(struct db_export *dbe, u32 branch_type,
1141                                      const char *name)
1142 {
1143         struct tables *tables = container_of(dbe, struct tables, dbe);
1144         PyObject *t;
1145
1146         t = tuple_new(2);
1147
1148         tuple_set_s32(t, 0, branch_type);
1149         tuple_set_string(t, 1, name);
1150
1151         call_object(tables->branch_type_handler, t, "branch_type_table");
1152
1153         Py_DECREF(t);
1154
1155         return 0;
1156 }
1157
1158 static void python_export_sample_table(struct db_export *dbe,
1159                                        struct export_sample *es)
1160 {
1161         struct tables *tables = container_of(dbe, struct tables, dbe);
1162         PyObject *t;
1163
1164         t = tuple_new(24);
1165
1166         tuple_set_d64(t, 0, es->db_id);
1167         tuple_set_d64(t, 1, es->evsel->db_id);
1168         tuple_set_d64(t, 2, es->al->maps->machine->db_id);
1169         tuple_set_d64(t, 3, es->al->thread->db_id);
1170         tuple_set_d64(t, 4, es->comm_db_id);
1171         tuple_set_d64(t, 5, es->dso_db_id);
1172         tuple_set_d64(t, 6, es->sym_db_id);
1173         tuple_set_d64(t, 7, es->offset);
1174         tuple_set_d64(t, 8, es->sample->ip);
1175         tuple_set_d64(t, 9, es->sample->time);
1176         tuple_set_s32(t, 10, es->sample->cpu);
1177         tuple_set_d64(t, 11, es->addr_dso_db_id);
1178         tuple_set_d64(t, 12, es->addr_sym_db_id);
1179         tuple_set_d64(t, 13, es->addr_offset);
1180         tuple_set_d64(t, 14, es->sample->addr);
1181         tuple_set_d64(t, 15, es->sample->period);
1182         tuple_set_d64(t, 16, es->sample->weight);
1183         tuple_set_d64(t, 17, es->sample->transaction);
1184         tuple_set_d64(t, 18, es->sample->data_src);
1185         tuple_set_s32(t, 19, es->sample->flags & PERF_BRANCH_MASK);
1186         tuple_set_s32(t, 20, !!(es->sample->flags & PERF_IP_FLAG_IN_TX));
1187         tuple_set_d64(t, 21, es->call_path_id);
1188         tuple_set_d64(t, 22, es->sample->insn_cnt);
1189         tuple_set_d64(t, 23, es->sample->cyc_cnt);
1190
1191         call_object(tables->sample_handler, t, "sample_table");
1192
1193         Py_DECREF(t);
1194 }
1195
1196 static void python_export_synth(struct db_export *dbe, struct export_sample *es)
1197 {
1198         struct tables *tables = container_of(dbe, struct tables, dbe);
1199         PyObject *t;
1200
1201         t = tuple_new(3);
1202
1203         tuple_set_d64(t, 0, es->db_id);
1204         tuple_set_d64(t, 1, es->evsel->core.attr.config);
1205         tuple_set_bytes(t, 2, es->sample->raw_data, es->sample->raw_size);
1206
1207         call_object(tables->synth_handler, t, "synth_data");
1208
1209         Py_DECREF(t);
1210 }
1211
1212 static int python_export_sample(struct db_export *dbe,
1213                                 struct export_sample *es)
1214 {
1215         struct tables *tables = container_of(dbe, struct tables, dbe);
1216
1217         python_export_sample_table(dbe, es);
1218
1219         if (es->evsel->core.attr.type == PERF_TYPE_SYNTH && tables->synth_handler)
1220                 python_export_synth(dbe, es);
1221
1222         return 0;
1223 }
1224
1225 static int python_export_call_path(struct db_export *dbe, struct call_path *cp)
1226 {
1227         struct tables *tables = container_of(dbe, struct tables, dbe);
1228         PyObject *t;
1229         u64 parent_db_id, sym_db_id;
1230
1231         parent_db_id = cp->parent ? cp->parent->db_id : 0;
1232         sym_db_id = cp->sym ? *(u64 *)symbol__priv(cp->sym) : 0;
1233
1234         t = tuple_new(4);
1235
1236         tuple_set_d64(t, 0, cp->db_id);
1237         tuple_set_d64(t, 1, parent_db_id);
1238         tuple_set_d64(t, 2, sym_db_id);
1239         tuple_set_d64(t, 3, cp->ip);
1240
1241         call_object(tables->call_path_handler, t, "call_path_table");
1242
1243         Py_DECREF(t);
1244
1245         return 0;
1246 }
1247
1248 static int python_export_call_return(struct db_export *dbe,
1249                                      struct call_return *cr)
1250 {
1251         struct tables *tables = container_of(dbe, struct tables, dbe);
1252         u64 comm_db_id = cr->comm ? cr->comm->db_id : 0;
1253         PyObject *t;
1254
1255         t = tuple_new(14);
1256
1257         tuple_set_d64(t, 0, cr->db_id);
1258         tuple_set_d64(t, 1, cr->thread->db_id);
1259         tuple_set_d64(t, 2, comm_db_id);
1260         tuple_set_d64(t, 3, cr->cp->db_id);
1261         tuple_set_d64(t, 4, cr->call_time);
1262         tuple_set_d64(t, 5, cr->return_time);
1263         tuple_set_d64(t, 6, cr->branch_count);
1264         tuple_set_d64(t, 7, cr->call_ref);
1265         tuple_set_d64(t, 8, cr->return_ref);
1266         tuple_set_d64(t, 9, cr->cp->parent->db_id);
1267         tuple_set_s32(t, 10, cr->flags);
1268         tuple_set_d64(t, 11, cr->parent_db_id);
1269         tuple_set_d64(t, 12, cr->insn_count);
1270         tuple_set_d64(t, 13, cr->cyc_count);
1271
1272         call_object(tables->call_return_handler, t, "call_return_table");
1273
1274         Py_DECREF(t);
1275
1276         return 0;
1277 }
1278
1279 static int python_export_context_switch(struct db_export *dbe, u64 db_id,
1280                                         struct machine *machine,
1281                                         struct perf_sample *sample,
1282                                         u64 th_out_id, u64 comm_out_id,
1283                                         u64 th_in_id, u64 comm_in_id, int flags)
1284 {
1285         struct tables *tables = container_of(dbe, struct tables, dbe);
1286         PyObject *t;
1287
1288         t = tuple_new(9);
1289
1290         tuple_set_d64(t, 0, db_id);
1291         tuple_set_d64(t, 1, machine->db_id);
1292         tuple_set_d64(t, 2, sample->time);
1293         tuple_set_s32(t, 3, sample->cpu);
1294         tuple_set_d64(t, 4, th_out_id);
1295         tuple_set_d64(t, 5, comm_out_id);
1296         tuple_set_d64(t, 6, th_in_id);
1297         tuple_set_d64(t, 7, comm_in_id);
1298         tuple_set_s32(t, 8, flags);
1299
1300         call_object(tables->context_switch_handler, t, "context_switch");
1301
1302         Py_DECREF(t);
1303
1304         return 0;
1305 }
1306
1307 static int python_process_call_return(struct call_return *cr, u64 *parent_db_id,
1308                                       void *data)
1309 {
1310         struct db_export *dbe = data;
1311
1312         return db_export__call_return(dbe, cr, parent_db_id);
1313 }
1314
1315 static void python_process_general_event(struct perf_sample *sample,
1316                                          struct evsel *evsel,
1317                                          struct addr_location *al,
1318                                          struct addr_location *addr_al)
1319 {
1320         PyObject *handler, *t, *dict, *callchain;
1321         static char handler_name[64];
1322         unsigned n = 0;
1323
1324         snprintf(handler_name, sizeof(handler_name), "%s", "process_event");
1325
1326         handler = get_handler(handler_name);
1327         if (!handler)
1328                 return;
1329
1330         /*
1331          * Use the MAX_FIELDS to make the function expandable, though
1332          * currently there is only one item for the tuple.
1333          */
1334         t = PyTuple_New(MAX_FIELDS);
1335         if (!t)
1336                 Py_FatalError("couldn't create Python tuple");
1337
1338         /* ip unwinding */
1339         callchain = python_process_callchain(sample, evsel, al);
1340         dict = get_perf_sample_dict(sample, evsel, al, addr_al, callchain);
1341
1342         PyTuple_SetItem(t, n++, dict);
1343         if (_PyTuple_Resize(&t, n) == -1)
1344                 Py_FatalError("error resizing Python tuple");
1345
1346         call_object(handler, t, handler_name);
1347
1348         Py_DECREF(t);
1349 }
1350
1351 static void python_process_event(union perf_event *event,
1352                                  struct perf_sample *sample,
1353                                  struct evsel *evsel,
1354                                  struct addr_location *al,
1355                                  struct addr_location *addr_al)
1356 {
1357         struct tables *tables = &tables_global;
1358
1359         switch (evsel->core.attr.type) {
1360         case PERF_TYPE_TRACEPOINT:
1361                 python_process_tracepoint(sample, evsel, al, addr_al);
1362                 break;
1363         /* Reserve for future process_hw/sw/raw APIs */
1364         default:
1365                 if (tables->db_export_mode)
1366                         db_export__sample(&tables->dbe, event, sample, evsel, al, addr_al);
1367                 else
1368                         python_process_general_event(sample, evsel, al, addr_al);
1369         }
1370 }
1371
1372 static void python_process_switch(union perf_event *event,
1373                                   struct perf_sample *sample,
1374                                   struct machine *machine)
1375 {
1376         struct tables *tables = &tables_global;
1377
1378         if (tables->db_export_mode)
1379                 db_export__switch(&tables->dbe, event, sample, machine);
1380 }
1381
1382 static void get_handler_name(char *str, size_t size,
1383                              struct evsel *evsel)
1384 {
1385         char *p = str;
1386
1387         scnprintf(str, size, "stat__%s", evsel__name(evsel));
1388
1389         while ((p = strchr(p, ':'))) {
1390                 *p = '_';
1391                 p++;
1392         }
1393 }
1394
1395 static void
1396 process_stat(struct evsel *counter, int cpu, int thread, u64 tstamp,
1397              struct perf_counts_values *count)
1398 {
1399         PyObject *handler, *t;
1400         static char handler_name[256];
1401         int n = 0;
1402
1403         t = PyTuple_New(MAX_FIELDS);
1404         if (!t)
1405                 Py_FatalError("couldn't create Python tuple");
1406
1407         get_handler_name(handler_name, sizeof(handler_name),
1408                          counter);
1409
1410         handler = get_handler(handler_name);
1411         if (!handler) {
1412                 pr_debug("can't find python handler %s\n", handler_name);
1413                 return;
1414         }
1415
1416         PyTuple_SetItem(t, n++, _PyLong_FromLong(cpu));
1417         PyTuple_SetItem(t, n++, _PyLong_FromLong(thread));
1418
1419         tuple_set_u64(t, n++, tstamp);
1420         tuple_set_u64(t, n++, count->val);
1421         tuple_set_u64(t, n++, count->ena);
1422         tuple_set_u64(t, n++, count->run);
1423
1424         if (_PyTuple_Resize(&t, n) == -1)
1425                 Py_FatalError("error resizing Python tuple");
1426
1427         call_object(handler, t, handler_name);
1428
1429         Py_DECREF(t);
1430 }
1431
1432 static void python_process_stat(struct perf_stat_config *config,
1433                                 struct evsel *counter, u64 tstamp)
1434 {
1435         struct perf_thread_map *threads = counter->core.threads;
1436         struct perf_cpu_map *cpus = counter->core.cpus;
1437         int cpu, thread;
1438
1439         if (config->aggr_mode == AGGR_GLOBAL) {
1440                 process_stat(counter, -1, -1, tstamp,
1441                              &counter->counts->aggr);
1442                 return;
1443         }
1444
1445         for (thread = 0; thread < threads->nr; thread++) {
1446                 for (cpu = 0; cpu < cpus->nr; cpu++) {
1447                         process_stat(counter, cpus->map[cpu],
1448                                      perf_thread_map__pid(threads, thread), tstamp,
1449                                      perf_counts(counter->counts, cpu, thread));
1450                 }
1451         }
1452 }
1453
1454 static void python_process_stat_interval(u64 tstamp)
1455 {
1456         PyObject *handler, *t;
1457         static const char handler_name[] = "stat__interval";
1458         int n = 0;
1459
1460         t = PyTuple_New(MAX_FIELDS);
1461         if (!t)
1462                 Py_FatalError("couldn't create Python tuple");
1463
1464         handler = get_handler(handler_name);
1465         if (!handler) {
1466                 pr_debug("can't find python handler %s\n", handler_name);
1467                 return;
1468         }
1469
1470         tuple_set_u64(t, n++, tstamp);
1471
1472         if (_PyTuple_Resize(&t, n) == -1)
1473                 Py_FatalError("error resizing Python tuple");
1474
1475         call_object(handler, t, handler_name);
1476
1477         Py_DECREF(t);
1478 }
1479
1480 static int run_start_sub(void)
1481 {
1482         main_module = PyImport_AddModule("__main__");
1483         if (main_module == NULL)
1484                 return -1;
1485         Py_INCREF(main_module);
1486
1487         main_dict = PyModule_GetDict(main_module);
1488         if (main_dict == NULL)
1489                 goto error;
1490         Py_INCREF(main_dict);
1491
1492         try_call_object("trace_begin", NULL);
1493
1494         return 0;
1495
1496 error:
1497         Py_XDECREF(main_dict);
1498         Py_XDECREF(main_module);
1499         return -1;
1500 }
1501
1502 #define SET_TABLE_HANDLER_(name, handler_name, table_name) do {         \
1503         tables->handler_name = get_handler(#table_name);                \
1504         if (tables->handler_name)                                       \
1505                 tables->dbe.export_ ## name = python_export_ ## name;   \
1506 } while (0)
1507
1508 #define SET_TABLE_HANDLER(name) \
1509         SET_TABLE_HANDLER_(name, name ## _handler, name ## _table)
1510
1511 static void set_table_handlers(struct tables *tables)
1512 {
1513         const char *perf_db_export_mode = "perf_db_export_mode";
1514         const char *perf_db_export_calls = "perf_db_export_calls";
1515         const char *perf_db_export_callchains = "perf_db_export_callchains";
1516         PyObject *db_export_mode, *db_export_calls, *db_export_callchains;
1517         bool export_calls = false;
1518         bool export_callchains = false;
1519         int ret;
1520
1521         memset(tables, 0, sizeof(struct tables));
1522         if (db_export__init(&tables->dbe))
1523                 Py_FatalError("failed to initialize export");
1524
1525         db_export_mode = PyDict_GetItemString(main_dict, perf_db_export_mode);
1526         if (!db_export_mode)
1527                 return;
1528
1529         ret = PyObject_IsTrue(db_export_mode);
1530         if (ret == -1)
1531                 handler_call_die(perf_db_export_mode);
1532         if (!ret)
1533                 return;
1534
1535         /* handle export calls */
1536         tables->dbe.crp = NULL;
1537         db_export_calls = PyDict_GetItemString(main_dict, perf_db_export_calls);
1538         if (db_export_calls) {
1539                 ret = PyObject_IsTrue(db_export_calls);
1540                 if (ret == -1)
1541                         handler_call_die(perf_db_export_calls);
1542                 export_calls = !!ret;
1543         }
1544
1545         if (export_calls) {
1546                 tables->dbe.crp =
1547                         call_return_processor__new(python_process_call_return,
1548                                                    &tables->dbe);
1549                 if (!tables->dbe.crp)
1550                         Py_FatalError("failed to create calls processor");
1551         }
1552
1553         /* handle export callchains */
1554         tables->dbe.cpr = NULL;
1555         db_export_callchains = PyDict_GetItemString(main_dict,
1556                                                     perf_db_export_callchains);
1557         if (db_export_callchains) {
1558                 ret = PyObject_IsTrue(db_export_callchains);
1559                 if (ret == -1)
1560                         handler_call_die(perf_db_export_callchains);
1561                 export_callchains = !!ret;
1562         }
1563
1564         if (export_callchains) {
1565                 /*
1566                  * Attempt to use the call path root from the call return
1567                  * processor, if the call return processor is in use. Otherwise,
1568                  * we allocate a new call path root. This prevents exporting
1569                  * duplicate call path ids when both are in use simultaneously.
1570                  */
1571                 if (tables->dbe.crp)
1572                         tables->dbe.cpr = tables->dbe.crp->cpr;
1573                 else
1574                         tables->dbe.cpr = call_path_root__new();
1575
1576                 if (!tables->dbe.cpr)
1577                         Py_FatalError("failed to create call path root");
1578         }
1579
1580         tables->db_export_mode = true;
1581         /*
1582          * Reserve per symbol space for symbol->db_id via symbol__priv()
1583          */
1584         symbol_conf.priv_size = sizeof(u64);
1585
1586         SET_TABLE_HANDLER(evsel);
1587         SET_TABLE_HANDLER(machine);
1588         SET_TABLE_HANDLER(thread);
1589         SET_TABLE_HANDLER(comm);
1590         SET_TABLE_HANDLER(comm_thread);
1591         SET_TABLE_HANDLER(dso);
1592         SET_TABLE_HANDLER(symbol);
1593         SET_TABLE_HANDLER(branch_type);
1594         SET_TABLE_HANDLER(sample);
1595         SET_TABLE_HANDLER(call_path);
1596         SET_TABLE_HANDLER(call_return);
1597         SET_TABLE_HANDLER(context_switch);
1598
1599         /*
1600          * Synthesized events are samples but with architecture-specific data
1601          * stored in sample->raw_data. They are exported via
1602          * python_export_sample() and consequently do not need a separate export
1603          * callback.
1604          */
1605         tables->synth_handler = get_handler("synth_data");
1606 }
1607
1608 #if PY_MAJOR_VERSION < 3
1609 static void _free_command_line(const char **command_line, int num)
1610 {
1611         free(command_line);
1612 }
1613 #else
1614 static void _free_command_line(wchar_t **command_line, int num)
1615 {
1616         int i;
1617         for (i = 0; i < num; i++)
1618                 PyMem_RawFree(command_line[i]);
1619         free(command_line);
1620 }
1621 #endif
1622
1623
1624 /*
1625  * Start trace script
1626  */
1627 static int python_start_script(const char *script, int argc, const char **argv)
1628 {
1629         struct tables *tables = &tables_global;
1630 #if PY_MAJOR_VERSION < 3
1631         const char **command_line;
1632 #else
1633         wchar_t **command_line;
1634 #endif
1635         /*
1636          * Use a non-const name variable to cope with python 2.6's
1637          * PyImport_AppendInittab prototype
1638          */
1639         char buf[PATH_MAX], name[19] = "perf_trace_context";
1640         int i, err = 0;
1641         FILE *fp;
1642
1643 #if PY_MAJOR_VERSION < 3
1644         command_line = malloc((argc + 1) * sizeof(const char *));
1645         command_line[0] = script;
1646         for (i = 1; i < argc + 1; i++)
1647                 command_line[i] = argv[i - 1];
1648         PyImport_AppendInittab(name, initperf_trace_context);
1649 #else
1650         command_line = malloc((argc + 1) * sizeof(wchar_t *));
1651         command_line[0] = Py_DecodeLocale(script, NULL);
1652         for (i = 1; i < argc + 1; i++)
1653                 command_line[i] = Py_DecodeLocale(argv[i - 1], NULL);
1654         PyImport_AppendInittab(name, PyInit_perf_trace_context);
1655 #endif
1656         Py_Initialize();
1657
1658 #if PY_MAJOR_VERSION < 3
1659         PySys_SetArgv(argc + 1, (char **)command_line);
1660 #else
1661         PySys_SetArgv(argc + 1, command_line);
1662 #endif
1663
1664         fp = fopen(script, "r");
1665         if (!fp) {
1666                 sprintf(buf, "Can't open python script \"%s\"", script);
1667                 perror(buf);
1668                 err = -1;
1669                 goto error;
1670         }
1671
1672         err = PyRun_SimpleFile(fp, script);
1673         if (err) {
1674                 fprintf(stderr, "Error running python script %s\n", script);
1675                 goto error;
1676         }
1677
1678         err = run_start_sub();
1679         if (err) {
1680                 fprintf(stderr, "Error starting python script %s\n", script);
1681                 goto error;
1682         }
1683
1684         set_table_handlers(tables);
1685
1686         if (tables->db_export_mode) {
1687                 err = db_export__branch_types(&tables->dbe);
1688                 if (err)
1689                         goto error;
1690         }
1691
1692         _free_command_line(command_line, argc + 1);
1693
1694         return err;
1695 error:
1696         Py_Finalize();
1697         _free_command_line(command_line, argc + 1);
1698
1699         return err;
1700 }
1701
1702 static int python_flush_script(void)
1703 {
1704         return 0;
1705 }
1706
1707 /*
1708  * Stop trace script
1709  */
1710 static int python_stop_script(void)
1711 {
1712         struct tables *tables = &tables_global;
1713
1714         try_call_object("trace_end", NULL);
1715
1716         db_export__exit(&tables->dbe);
1717
1718         Py_XDECREF(main_dict);
1719         Py_XDECREF(main_module);
1720         Py_Finalize();
1721
1722         return 0;
1723 }
1724
1725 static int python_generate_script(struct tep_handle *pevent, const char *outfile)
1726 {
1727         int i, not_first, count, nr_events;
1728         struct tep_event **all_events;
1729         struct tep_event *event = NULL;
1730         struct tep_format_field *f;
1731         char fname[PATH_MAX];
1732         FILE *ofp;
1733
1734         sprintf(fname, "%s.py", outfile);
1735         ofp = fopen(fname, "w");
1736         if (ofp == NULL) {
1737                 fprintf(stderr, "couldn't open %s\n", fname);
1738                 return -1;
1739         }
1740         fprintf(ofp, "# perf script event handlers, "
1741                 "generated by perf script -g python\n");
1742
1743         fprintf(ofp, "# Licensed under the terms of the GNU GPL"
1744                 " License version 2\n\n");
1745
1746         fprintf(ofp, "# The common_* event handler fields are the most useful "
1747                 "fields common to\n");
1748
1749         fprintf(ofp, "# all events.  They don't necessarily correspond to "
1750                 "the 'common_*' fields\n");
1751
1752         fprintf(ofp, "# in the format files.  Those fields not available as "
1753                 "handler params can\n");
1754
1755         fprintf(ofp, "# be retrieved using Python functions of the form "
1756                 "common_*(context).\n");
1757
1758         fprintf(ofp, "# See the perf-script-python Documentation for the list "
1759                 "of available functions.\n\n");
1760
1761         fprintf(ofp, "from __future__ import print_function\n\n");
1762         fprintf(ofp, "import os\n");
1763         fprintf(ofp, "import sys\n\n");
1764
1765         fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
1766         fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
1767         fprintf(ofp, "\nfrom perf_trace_context import *\n");
1768         fprintf(ofp, "from Core import *\n\n\n");
1769
1770         fprintf(ofp, "def trace_begin():\n");
1771         fprintf(ofp, "\tprint(\"in trace_begin\")\n\n");
1772
1773         fprintf(ofp, "def trace_end():\n");
1774         fprintf(ofp, "\tprint(\"in trace_end\")\n\n");
1775
1776         nr_events = tep_get_events_count(pevent);
1777         all_events = tep_list_events(pevent, TEP_EVENT_SORT_ID);
1778
1779         for (i = 0; all_events && i < nr_events; i++) {
1780                 event = all_events[i];
1781                 fprintf(ofp, "def %s__%s(", event->system, event->name);
1782                 fprintf(ofp, "event_name, ");
1783                 fprintf(ofp, "context, ");
1784                 fprintf(ofp, "common_cpu,\n");
1785                 fprintf(ofp, "\tcommon_secs, ");
1786                 fprintf(ofp, "common_nsecs, ");
1787                 fprintf(ofp, "common_pid, ");
1788                 fprintf(ofp, "common_comm,\n\t");
1789                 fprintf(ofp, "common_callchain, ");
1790
1791                 not_first = 0;
1792                 count = 0;
1793
1794                 for (f = event->format.fields; f; f = f->next) {
1795                         if (not_first++)
1796                                 fprintf(ofp, ", ");
1797                         if (++count % 5 == 0)
1798                                 fprintf(ofp, "\n\t");
1799
1800                         fprintf(ofp, "%s", f->name);
1801                 }
1802                 if (not_first++)
1803                         fprintf(ofp, ", ");
1804                 if (++count % 5 == 0)
1805                         fprintf(ofp, "\n\t\t");
1806                 fprintf(ofp, "perf_sample_dict");
1807
1808                 fprintf(ofp, "):\n");
1809
1810                 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
1811                         "common_secs, common_nsecs,\n\t\t\t"
1812                         "common_pid, common_comm)\n\n");
1813
1814                 fprintf(ofp, "\t\tprint(\"");
1815
1816                 not_first = 0;
1817                 count = 0;
1818
1819                 for (f = event->format.fields; f; f = f->next) {
1820                         if (not_first++)
1821                                 fprintf(ofp, ", ");
1822                         if (count && count % 3 == 0) {
1823                                 fprintf(ofp, "\" \\\n\t\t\"");
1824                         }
1825                         count++;
1826
1827                         fprintf(ofp, "%s=", f->name);
1828                         if (f->flags & TEP_FIELD_IS_STRING ||
1829                             f->flags & TEP_FIELD_IS_FLAG ||
1830                             f->flags & TEP_FIELD_IS_ARRAY ||
1831                             f->flags & TEP_FIELD_IS_SYMBOLIC)
1832                                 fprintf(ofp, "%%s");
1833                         else if (f->flags & TEP_FIELD_IS_SIGNED)
1834                                 fprintf(ofp, "%%d");
1835                         else
1836                                 fprintf(ofp, "%%u");
1837                 }
1838
1839                 fprintf(ofp, "\" %% \\\n\t\t(");
1840
1841                 not_first = 0;
1842                 count = 0;
1843
1844                 for (f = event->format.fields; f; f = f->next) {
1845                         if (not_first++)
1846                                 fprintf(ofp, ", ");
1847
1848                         if (++count % 5 == 0)
1849                                 fprintf(ofp, "\n\t\t");
1850
1851                         if (f->flags & TEP_FIELD_IS_FLAG) {
1852                                 if ((count - 1) % 5 != 0) {
1853                                         fprintf(ofp, "\n\t\t");
1854                                         count = 4;
1855                                 }
1856                                 fprintf(ofp, "flag_str(\"");
1857                                 fprintf(ofp, "%s__%s\", ", event->system,
1858                                         event->name);
1859                                 fprintf(ofp, "\"%s\", %s)", f->name,
1860                                         f->name);
1861                         } else if (f->flags & TEP_FIELD_IS_SYMBOLIC) {
1862                                 if ((count - 1) % 5 != 0) {
1863                                         fprintf(ofp, "\n\t\t");
1864                                         count = 4;
1865                                 }
1866                                 fprintf(ofp, "symbol_str(\"");
1867                                 fprintf(ofp, "%s__%s\", ", event->system,
1868                                         event->name);
1869                                 fprintf(ofp, "\"%s\", %s)", f->name,
1870                                         f->name);
1871                         } else
1872                                 fprintf(ofp, "%s", f->name);
1873                 }
1874
1875                 fprintf(ofp, "))\n\n");
1876
1877                 fprintf(ofp, "\t\tprint('Sample: {'+"
1878                         "get_dict_as_string(perf_sample_dict['sample'], ', ')+'}')\n\n");
1879
1880                 fprintf(ofp, "\t\tfor node in common_callchain:");
1881                 fprintf(ofp, "\n\t\t\tif 'sym' in node:");
1882                 fprintf(ofp, "\n\t\t\t\tprint(\"\\t[%%x] %%s\" %% (node['ip'], node['sym']['name']))");
1883                 fprintf(ofp, "\n\t\t\telse:");
1884                 fprintf(ofp, "\n\t\t\t\tprint(\"\t[%%x]\" %% (node['ip']))\n\n");
1885                 fprintf(ofp, "\t\tprint()\n\n");
1886
1887         }
1888
1889         fprintf(ofp, "def trace_unhandled(event_name, context, "
1890                 "event_fields_dict, perf_sample_dict):\n");
1891
1892         fprintf(ofp, "\t\tprint(get_dict_as_string(event_fields_dict))\n");
1893         fprintf(ofp, "\t\tprint('Sample: {'+"
1894                 "get_dict_as_string(perf_sample_dict['sample'], ', ')+'}')\n\n");
1895
1896         fprintf(ofp, "def print_header("
1897                 "event_name, cpu, secs, nsecs, pid, comm):\n"
1898                 "\tprint(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
1899                 "(event_name, cpu, secs, nsecs, pid, comm), end=\"\")\n\n");
1900
1901         fprintf(ofp, "def get_dict_as_string(a_dict, delimiter=' '):\n"
1902                 "\treturn delimiter.join"
1903                 "(['%%s=%%s'%%(k,str(v))for k,v in sorted(a_dict.items())])\n");
1904
1905         fclose(ofp);
1906
1907         fprintf(stderr, "generated Python script: %s\n", fname);
1908
1909         return 0;
1910 }
1911
1912 struct scripting_ops python_scripting_ops = {
1913         .name                   = "Python",
1914         .dirname                = "python",
1915         .start_script           = python_start_script,
1916         .flush_script           = python_flush_script,
1917         .stop_script            = python_stop_script,
1918         .process_event          = python_process_event,
1919         .process_switch         = python_process_switch,
1920         .process_stat           = python_process_stat,
1921         .process_stat_interval  = python_process_stat_interval,
1922         .generate_script        = python_generate_script,
1923 };