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