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