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