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