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
69PyMODINIT_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
84PyMODINIT_FUNC PyInit_perf_trace_context(void);
85#endif
86
87#define TRACE_EVENT_TYPE_MAX				\
88	((1 << (sizeof(unsigned short) * 8)) - 1)
89
90static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
91
92#define MAX_FIELDS	64
93#define N_COMMON_FIELDS	7
94
95extern struct scripting_context *scripting_context;
96
97static char *cur_field_name;
98static int zero_flag_atom;
99
100static PyObject *main_module, *main_dict;
101
102struct 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
120static struct tables tables_global;
121
122static void handler_call_die(const char *handler_name) __noreturn;
123static 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 */
137static 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
143static 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
153static 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
181static 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
191static 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
200static 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
230static 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
242static 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
271static 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
339static 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
380static 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
394static 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
459exit:
460	return pylist;
461}
462
463static 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
518exit:
519	return pylist;
520}
521
522static 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
534static 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
550static 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
561static 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
621exit:
622	return pylist;
623}
624
625static 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
637static 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
675static 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
690static 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
711static 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
729static PyObject *get_perf_sample_dict(struct perf_sample *sample,
730					 struct evsel *evsel,
731					 struct addr_location *al,
732					 PyObject *callchain)
733{
734	PyObject *dict, *dict_sample, *brstack, *brstacksym;
735
736	dict = PyDict_New();
737	if (!dict)
738		Py_FatalError("couldn't create Python dictionary");
739
740	dict_sample = PyDict_New();
741	if (!dict_sample)
742		Py_FatalError("couldn't create Python dictionary");
743
744	pydict_set_item_string_decref(dict, "ev_name", _PyUnicode_FromString(evsel__name(evsel)));
745	pydict_set_item_string_decref(dict, "attr", _PyBytes_FromStringAndSize((const char *)&evsel->core.attr, sizeof(evsel->core.attr)));
746
747	pydict_set_item_string_decref(dict_sample, "pid",
748			_PyLong_FromLong(sample->pid));
749	pydict_set_item_string_decref(dict_sample, "tid",
750			_PyLong_FromLong(sample->tid));
751	pydict_set_item_string_decref(dict_sample, "cpu",
752			_PyLong_FromLong(sample->cpu));
753	pydict_set_item_string_decref(dict_sample, "ip",
754			PyLong_FromUnsignedLongLong(sample->ip));
755	pydict_set_item_string_decref(dict_sample, "time",
756			PyLong_FromUnsignedLongLong(sample->time));
757	pydict_set_item_string_decref(dict_sample, "period",
758			PyLong_FromUnsignedLongLong(sample->period));
759	pydict_set_item_string_decref(dict_sample, "phys_addr",
760			PyLong_FromUnsignedLongLong(sample->phys_addr));
761	pydict_set_item_string_decref(dict_sample, "addr",
762			PyLong_FromUnsignedLongLong(sample->addr));
763	set_sample_read_in_dict(dict_sample, sample, evsel);
764	pydict_set_item_string_decref(dict_sample, "weight",
765			PyLong_FromUnsignedLongLong(sample->weight));
766	pydict_set_item_string_decref(dict_sample, "transaction",
767			PyLong_FromUnsignedLongLong(sample->transaction));
768	set_sample_datasrc_in_dict(dict_sample, sample);
769	pydict_set_item_string_decref(dict, "sample", dict_sample);
770
771	pydict_set_item_string_decref(dict, "raw_buf", _PyBytes_FromStringAndSize(
772			(const char *)sample->raw_data, sample->raw_size));
773	pydict_set_item_string_decref(dict, "comm",
774			_PyUnicode_FromString(thread__comm_str(al->thread)));
775	if (al->map) {
776		pydict_set_item_string_decref(dict, "dso",
777			_PyUnicode_FromString(al->map->dso->name));
778	}
779	if (al->sym) {
780		pydict_set_item_string_decref(dict, "symbol",
781			_PyUnicode_FromString(al->sym->name));
782	}
783
784	pydict_set_item_string_decref(dict, "callchain", callchain);
785
786	brstack = python_process_brstack(sample, al->thread);
787	pydict_set_item_string_decref(dict, "brstack", brstack);
788
789	brstacksym = python_process_brstacksym(sample, al->thread);
790	pydict_set_item_string_decref(dict, "brstacksym", brstacksym);
791
792	set_regs_in_dict(dict, sample, evsel);
793
794	return dict;
795}
796
797static void python_process_tracepoint(struct perf_sample *sample,
798				      struct evsel *evsel,
799				      struct addr_location *al)
800{
801	struct tep_event *event = evsel->tp_format;
802	PyObject *handler, *context, *t, *obj = NULL, *callchain;
803	PyObject *dict = NULL, *all_entries_dict = NULL;
804	static char handler_name[256];
805	struct tep_format_field *field;
806	unsigned long s, ns;
807	unsigned n = 0;
808	int pid;
809	int cpu = sample->cpu;
810	void *data = sample->raw_data;
811	unsigned long long nsecs = sample->time;
812	const char *comm = thread__comm_str(al->thread);
813	const char *default_handler_name = "trace_unhandled";
814
815	if (!event) {
816		snprintf(handler_name, sizeof(handler_name),
817			 "ug! no event found for type %" PRIu64, (u64)evsel->core.attr.config);
818		Py_FatalError(handler_name);
819	}
820
821	pid = raw_field_value(event, "common_pid", data);
822
823	sprintf(handler_name, "%s__%s", event->system, event->name);
824
825	if (!test_and_set_bit(event->id, events_defined))
826		define_event_symbols(event, handler_name, event->print_fmt.args);
827
828	handler = get_handler(handler_name);
829	if (!handler) {
830		handler = get_handler(default_handler_name);
831		if (!handler)
832			return;
833		dict = PyDict_New();
834		if (!dict)
835			Py_FatalError("couldn't create Python dict");
836	}
837
838	t = PyTuple_New(MAX_FIELDS);
839	if (!t)
840		Py_FatalError("couldn't create Python tuple");
841
842
843	s = nsecs / NSEC_PER_SEC;
844	ns = nsecs - s * NSEC_PER_SEC;
845
846	scripting_context->event_data = data;
847	scripting_context->pevent = evsel->tp_format->tep;
848
849	context = _PyCapsule_New(scripting_context, NULL, NULL);
850
851	PyTuple_SetItem(t, n++, _PyUnicode_FromString(handler_name));
852	PyTuple_SetItem(t, n++, context);
853
854	/* ip unwinding */
855	callchain = python_process_callchain(sample, evsel, al);
856	/* Need an additional reference for the perf_sample dict */
857	Py_INCREF(callchain);
858
859	if (!dict) {
860		PyTuple_SetItem(t, n++, _PyLong_FromLong(cpu));
861		PyTuple_SetItem(t, n++, _PyLong_FromLong(s));
862		PyTuple_SetItem(t, n++, _PyLong_FromLong(ns));
863		PyTuple_SetItem(t, n++, _PyLong_FromLong(pid));
864		PyTuple_SetItem(t, n++, _PyUnicode_FromString(comm));
865		PyTuple_SetItem(t, n++, callchain);
866	} else {
867		pydict_set_item_string_decref(dict, "common_cpu", _PyLong_FromLong(cpu));
868		pydict_set_item_string_decref(dict, "common_s", _PyLong_FromLong(s));
869		pydict_set_item_string_decref(dict, "common_ns", _PyLong_FromLong(ns));
870		pydict_set_item_string_decref(dict, "common_pid", _PyLong_FromLong(pid));
871		pydict_set_item_string_decref(dict, "common_comm", _PyUnicode_FromString(comm));
872		pydict_set_item_string_decref(dict, "common_callchain", callchain);
873	}
874	for (field = event->format.fields; field; field = field->next) {
875		unsigned int offset, len;
876		unsigned long long val;
877
878		if (field->flags & TEP_FIELD_IS_ARRAY) {
879			offset = field->offset;
880			len    = field->size;
881			if (field->flags & TEP_FIELD_IS_DYNAMIC) {
882				val     = tep_read_number(scripting_context->pevent,
883							  data + offset, len);
884				offset  = val;
885				len     = offset >> 16;
886				offset &= 0xffff;
887			}
888			if (field->flags & TEP_FIELD_IS_STRING &&
889			    is_printable_array(data + offset, len)) {
890				obj = _PyUnicode_FromString((char *) data + offset);
891			} else {
892				obj = PyByteArray_FromStringAndSize((const char *) data + offset, len);
893				field->flags &= ~TEP_FIELD_IS_STRING;
894			}
895		} else { /* FIELD_IS_NUMERIC */
896			obj = get_field_numeric_entry(event, field, data);
897		}
898		if (!dict)
899			PyTuple_SetItem(t, n++, obj);
900		else
901			pydict_set_item_string_decref(dict, field->name, obj);
902
903	}
904
905	if (dict)
906		PyTuple_SetItem(t, n++, dict);
907
908	if (get_argument_count(handler) == (int) n + 1) {
909		all_entries_dict = get_perf_sample_dict(sample, evsel, al,
910			callchain);
911		PyTuple_SetItem(t, n++,	all_entries_dict);
912	} else {
913		Py_DECREF(callchain);
914	}
915
916	if (_PyTuple_Resize(&t, n) == -1)
917		Py_FatalError("error resizing Python tuple");
918
919	if (!dict)
920		call_object(handler, t, handler_name);
921	else
922		call_object(handler, t, default_handler_name);
923
924	Py_DECREF(t);
925}
926
927static PyObject *tuple_new(unsigned int sz)
928{
929	PyObject *t;
930
931	t = PyTuple_New(sz);
932	if (!t)
933		Py_FatalError("couldn't create Python tuple");
934	return t;
935}
936
937static int tuple_set_s64(PyObject *t, unsigned int pos, s64 val)
938{
939#if BITS_PER_LONG == 64
940	return PyTuple_SetItem(t, pos, _PyLong_FromLong(val));
941#endif
942#if BITS_PER_LONG == 32
943	return PyTuple_SetItem(t, pos, PyLong_FromLongLong(val));
944#endif
945}
946
947/*
948 * Databases support only signed 64-bit numbers, so even though we are
949 * exporting a u64, it must be as s64.
950 */
951#define tuple_set_d64 tuple_set_s64
952
953static int tuple_set_u64(PyObject *t, unsigned int pos, u64 val)
954{
955#if BITS_PER_LONG == 64
956	return PyTuple_SetItem(t, pos, PyLong_FromUnsignedLong(val));
957#endif
958#if BITS_PER_LONG == 32
959	return PyTuple_SetItem(t, pos, PyLong_FromUnsignedLongLong(val));
960#endif
961}
962
963static int tuple_set_s32(PyObject *t, unsigned int pos, s32 val)
964{
965	return PyTuple_SetItem(t, pos, _PyLong_FromLong(val));
966}
967
968static int tuple_set_string(PyObject *t, unsigned int pos, const char *s)
969{
970	return PyTuple_SetItem(t, pos, _PyUnicode_FromString(s));
971}
972
973static int tuple_set_bytes(PyObject *t, unsigned int pos, void *bytes,
974			   unsigned int sz)
975{
976	return PyTuple_SetItem(t, pos, _PyBytes_FromStringAndSize(bytes, sz));
977}
978
979static int python_export_evsel(struct db_export *dbe, struct evsel *evsel)
980{
981	struct tables *tables = container_of(dbe, struct tables, dbe);
982	PyObject *t;
983
984	t = tuple_new(2);
985
986	tuple_set_d64(t, 0, evsel->db_id);
987	tuple_set_string(t, 1, evsel__name(evsel));
988
989	call_object(tables->evsel_handler, t, "evsel_table");
990
991	Py_DECREF(t);
992
993	return 0;
994}
995
996static int python_export_machine(struct db_export *dbe,
997				 struct machine *machine)
998{
999	struct tables *tables = container_of(dbe, struct tables, dbe);
1000	PyObject *t;
1001
1002	t = tuple_new(3);
1003
1004	tuple_set_d64(t, 0, machine->db_id);
1005	tuple_set_s32(t, 1, machine->pid);
1006	tuple_set_string(t, 2, machine->root_dir ? machine->root_dir : "");
1007
1008	call_object(tables->machine_handler, t, "machine_table");
1009
1010	Py_DECREF(t);
1011
1012	return 0;
1013}
1014
1015static int python_export_thread(struct db_export *dbe, struct thread *thread,
1016				u64 main_thread_db_id, struct machine *machine)
1017{
1018	struct tables *tables = container_of(dbe, struct tables, dbe);
1019	PyObject *t;
1020
1021	t = tuple_new(5);
1022
1023	tuple_set_d64(t, 0, thread->db_id);
1024	tuple_set_d64(t, 1, machine->db_id);
1025	tuple_set_d64(t, 2, main_thread_db_id);
1026	tuple_set_s32(t, 3, thread->pid_);
1027	tuple_set_s32(t, 4, thread->tid);
1028
1029	call_object(tables->thread_handler, t, "thread_table");
1030
1031	Py_DECREF(t);
1032
1033	return 0;
1034}
1035
1036static int python_export_comm(struct db_export *dbe, struct comm *comm,
1037			      struct thread *thread)
1038{
1039	struct tables *tables = container_of(dbe, struct tables, dbe);
1040	PyObject *t;
1041
1042	t = tuple_new(5);
1043
1044	tuple_set_d64(t, 0, comm->db_id);
1045	tuple_set_string(t, 1, comm__str(comm));
1046	tuple_set_d64(t, 2, thread->db_id);
1047	tuple_set_d64(t, 3, comm->start);
1048	tuple_set_s32(t, 4, comm->exec);
1049
1050	call_object(tables->comm_handler, t, "comm_table");
1051
1052	Py_DECREF(t);
1053
1054	return 0;
1055}
1056
1057static int python_export_comm_thread(struct db_export *dbe, u64 db_id,
1058				     struct comm *comm, struct thread *thread)
1059{
1060	struct tables *tables = container_of(dbe, struct tables, dbe);
1061	PyObject *t;
1062
1063	t = tuple_new(3);
1064
1065	tuple_set_d64(t, 0, db_id);
1066	tuple_set_d64(t, 1, comm->db_id);
1067	tuple_set_d64(t, 2, thread->db_id);
1068
1069	call_object(tables->comm_thread_handler, t, "comm_thread_table");
1070
1071	Py_DECREF(t);
1072
1073	return 0;
1074}
1075
1076static int python_export_dso(struct db_export *dbe, struct dso *dso,
1077			     struct machine *machine)
1078{
1079	struct tables *tables = container_of(dbe, struct tables, dbe);
1080	char sbuild_id[SBUILD_ID_SIZE];
1081	PyObject *t;
1082
1083	build_id__sprintf(&dso->bid, sbuild_id);
1084
1085	t = tuple_new(5);
1086
1087	tuple_set_d64(t, 0, dso->db_id);
1088	tuple_set_d64(t, 1, machine->db_id);
1089	tuple_set_string(t, 2, dso->short_name);
1090	tuple_set_string(t, 3, dso->long_name);
1091	tuple_set_string(t, 4, sbuild_id);
1092
1093	call_object(tables->dso_handler, t, "dso_table");
1094
1095	Py_DECREF(t);
1096
1097	return 0;
1098}
1099
1100static int python_export_symbol(struct db_export *dbe, struct symbol *sym,
1101				struct dso *dso)
1102{
1103	struct tables *tables = container_of(dbe, struct tables, dbe);
1104	u64 *sym_db_id = symbol__priv(sym);
1105	PyObject *t;
1106
1107	t = tuple_new(6);
1108
1109	tuple_set_d64(t, 0, *sym_db_id);
1110	tuple_set_d64(t, 1, dso->db_id);
1111	tuple_set_d64(t, 2, sym->start);
1112	tuple_set_d64(t, 3, sym->end);
1113	tuple_set_s32(t, 4, sym->binding);
1114	tuple_set_string(t, 5, sym->name);
1115
1116	call_object(tables->symbol_handler, t, "symbol_table");
1117
1118	Py_DECREF(t);
1119
1120	return 0;
1121}
1122
1123static int python_export_branch_type(struct db_export *dbe, u32 branch_type,
1124				     const char *name)
1125{
1126	struct tables *tables = container_of(dbe, struct tables, dbe);
1127	PyObject *t;
1128
1129	t = tuple_new(2);
1130
1131	tuple_set_s32(t, 0, branch_type);
1132	tuple_set_string(t, 1, name);
1133
1134	call_object(tables->branch_type_handler, t, "branch_type_table");
1135
1136	Py_DECREF(t);
1137
1138	return 0;
1139}
1140
1141static void python_export_sample_table(struct db_export *dbe,
1142				       struct export_sample *es)
1143{
1144	struct tables *tables = container_of(dbe, struct tables, dbe);
1145	PyObject *t;
1146
1147	t = tuple_new(24);
1148
1149	tuple_set_d64(t, 0, es->db_id);
1150	tuple_set_d64(t, 1, es->evsel->db_id);
1151	tuple_set_d64(t, 2, es->al->maps->machine->db_id);
1152	tuple_set_d64(t, 3, es->al->thread->db_id);
1153	tuple_set_d64(t, 4, es->comm_db_id);
1154	tuple_set_d64(t, 5, es->dso_db_id);
1155	tuple_set_d64(t, 6, es->sym_db_id);
1156	tuple_set_d64(t, 7, es->offset);
1157	tuple_set_d64(t, 8, es->sample->ip);
1158	tuple_set_d64(t, 9, es->sample->time);
1159	tuple_set_s32(t, 10, es->sample->cpu);
1160	tuple_set_d64(t, 11, es->addr_dso_db_id);
1161	tuple_set_d64(t, 12, es->addr_sym_db_id);
1162	tuple_set_d64(t, 13, es->addr_offset);
1163	tuple_set_d64(t, 14, es->sample->addr);
1164	tuple_set_d64(t, 15, es->sample->period);
1165	tuple_set_d64(t, 16, es->sample->weight);
1166	tuple_set_d64(t, 17, es->sample->transaction);
1167	tuple_set_d64(t, 18, es->sample->data_src);
1168	tuple_set_s32(t, 19, es->sample->flags & PERF_BRANCH_MASK);
1169	tuple_set_s32(t, 20, !!(es->sample->flags & PERF_IP_FLAG_IN_TX));
1170	tuple_set_d64(t, 21, es->call_path_id);
1171	tuple_set_d64(t, 22, es->sample->insn_cnt);
1172	tuple_set_d64(t, 23, es->sample->cyc_cnt);
1173
1174	call_object(tables->sample_handler, t, "sample_table");
1175
1176	Py_DECREF(t);
1177}
1178
1179static void python_export_synth(struct db_export *dbe, struct export_sample *es)
1180{
1181	struct tables *tables = container_of(dbe, struct tables, dbe);
1182	PyObject *t;
1183
1184	t = tuple_new(3);
1185
1186	tuple_set_d64(t, 0, es->db_id);
1187	tuple_set_d64(t, 1, es->evsel->core.attr.config);
1188	tuple_set_bytes(t, 2, es->sample->raw_data, es->sample->raw_size);
1189
1190	call_object(tables->synth_handler, t, "synth_data");
1191
1192	Py_DECREF(t);
1193}
1194
1195static int python_export_sample(struct db_export *dbe,
1196				struct export_sample *es)
1197{
1198	struct tables *tables = container_of(dbe, struct tables, dbe);
1199
1200	python_export_sample_table(dbe, es);
1201
1202	if (es->evsel->core.attr.type == PERF_TYPE_SYNTH && tables->synth_handler)
1203		python_export_synth(dbe, es);
1204
1205	return 0;
1206}
1207
1208static int python_export_call_path(struct db_export *dbe, struct call_path *cp)
1209{
1210	struct tables *tables = container_of(dbe, struct tables, dbe);
1211	PyObject *t;
1212	u64 parent_db_id, sym_db_id;
1213
1214	parent_db_id = cp->parent ? cp->parent->db_id : 0;
1215	sym_db_id = cp->sym ? *(u64 *)symbol__priv(cp->sym) : 0;
1216
1217	t = tuple_new(4);
1218
1219	tuple_set_d64(t, 0, cp->db_id);
1220	tuple_set_d64(t, 1, parent_db_id);
1221	tuple_set_d64(t, 2, sym_db_id);
1222	tuple_set_d64(t, 3, cp->ip);
1223
1224	call_object(tables->call_path_handler, t, "call_path_table");
1225
1226	Py_DECREF(t);
1227
1228	return 0;
1229}
1230
1231static int python_export_call_return(struct db_export *dbe,
1232				     struct call_return *cr)
1233{
1234	struct tables *tables = container_of(dbe, struct tables, dbe);
1235	u64 comm_db_id = cr->comm ? cr->comm->db_id : 0;
1236	PyObject *t;
1237
1238	t = tuple_new(14);
1239
1240	tuple_set_d64(t, 0, cr->db_id);
1241	tuple_set_d64(t, 1, cr->thread->db_id);
1242	tuple_set_d64(t, 2, comm_db_id);
1243	tuple_set_d64(t, 3, cr->cp->db_id);
1244	tuple_set_d64(t, 4, cr->call_time);
1245	tuple_set_d64(t, 5, cr->return_time);
1246	tuple_set_d64(t, 6, cr->branch_count);
1247	tuple_set_d64(t, 7, cr->call_ref);
1248	tuple_set_d64(t, 8, cr->return_ref);
1249	tuple_set_d64(t, 9, cr->cp->parent->db_id);
1250	tuple_set_s32(t, 10, cr->flags);
1251	tuple_set_d64(t, 11, cr->parent_db_id);
1252	tuple_set_d64(t, 12, cr->insn_count);
1253	tuple_set_d64(t, 13, cr->cyc_count);
1254
1255	call_object(tables->call_return_handler, t, "call_return_table");
1256
1257	Py_DECREF(t);
1258
1259	return 0;
1260}
1261
1262static int python_export_context_switch(struct db_export *dbe, u64 db_id,
1263					struct machine *machine,
1264					struct perf_sample *sample,
1265					u64 th_out_id, u64 comm_out_id,
1266					u64 th_in_id, u64 comm_in_id, int flags)
1267{
1268	struct tables *tables = container_of(dbe, struct tables, dbe);
1269	PyObject *t;
1270
1271	t = tuple_new(9);
1272
1273	tuple_set_d64(t, 0, db_id);
1274	tuple_set_d64(t, 1, machine->db_id);
1275	tuple_set_d64(t, 2, sample->time);
1276	tuple_set_s32(t, 3, sample->cpu);
1277	tuple_set_d64(t, 4, th_out_id);
1278	tuple_set_d64(t, 5, comm_out_id);
1279	tuple_set_d64(t, 6, th_in_id);
1280	tuple_set_d64(t, 7, comm_in_id);
1281	tuple_set_s32(t, 8, flags);
1282
1283	call_object(tables->context_switch_handler, t, "context_switch");
1284
1285	Py_DECREF(t);
1286
1287	return 0;
1288}
1289
1290static int python_process_call_return(struct call_return *cr, u64 *parent_db_id,
1291				      void *data)
1292{
1293	struct db_export *dbe = data;
1294
1295	return db_export__call_return(dbe, cr, parent_db_id);
1296}
1297
1298static void python_process_general_event(struct perf_sample *sample,
1299					 struct evsel *evsel,
1300					 struct addr_location *al)
1301{
1302	PyObject *handler, *t, *dict, *callchain;
1303	static char handler_name[64];
1304	unsigned n = 0;
1305
1306	snprintf(handler_name, sizeof(handler_name), "%s", "process_event");
1307
1308	handler = get_handler(handler_name);
1309	if (!handler)
1310		return;
1311
1312	/*
1313	 * Use the MAX_FIELDS to make the function expandable, though
1314	 * currently there is only one item for the tuple.
1315	 */
1316	t = PyTuple_New(MAX_FIELDS);
1317	if (!t)
1318		Py_FatalError("couldn't create Python tuple");
1319
1320	/* ip unwinding */
1321	callchain = python_process_callchain(sample, evsel, al);
1322	dict = get_perf_sample_dict(sample, evsel, al, callchain);
1323
1324	PyTuple_SetItem(t, n++, dict);
1325	if (_PyTuple_Resize(&t, n) == -1)
1326		Py_FatalError("error resizing Python tuple");
1327
1328	call_object(handler, t, handler_name);
1329
1330	Py_DECREF(t);
1331}
1332
1333static void python_process_event(union perf_event *event,
1334				 struct perf_sample *sample,
1335				 struct evsel *evsel,
1336				 struct addr_location *al)
1337{
1338	struct tables *tables = &tables_global;
1339
1340	switch (evsel->core.attr.type) {
1341	case PERF_TYPE_TRACEPOINT:
1342		python_process_tracepoint(sample, evsel, al);
1343		break;
1344	/* Reserve for future process_hw/sw/raw APIs */
1345	default:
1346		if (tables->db_export_mode)
1347			db_export__sample(&tables->dbe, event, sample, evsel, al);
1348		else
1349			python_process_general_event(sample, evsel, al);
1350	}
1351}
1352
1353static void python_process_switch(union perf_event *event,
1354				  struct perf_sample *sample,
1355				  struct machine *machine)
1356{
1357	struct tables *tables = &tables_global;
1358
1359	if (tables->db_export_mode)
1360		db_export__switch(&tables->dbe, event, sample, machine);
1361}
1362
1363static void get_handler_name(char *str, size_t size,
1364			     struct evsel *evsel)
1365{
1366	char *p = str;
1367
1368	scnprintf(str, size, "stat__%s", evsel__name(evsel));
1369
1370	while ((p = strchr(p, ':'))) {
1371		*p = '_';
1372		p++;
1373	}
1374}
1375
1376static void
1377process_stat(struct evsel *counter, int cpu, int thread, u64 tstamp,
1378	     struct perf_counts_values *count)
1379{
1380	PyObject *handler, *t;
1381	static char handler_name[256];
1382	int n = 0;
1383
1384	t = PyTuple_New(MAX_FIELDS);
1385	if (!t)
1386		Py_FatalError("couldn't create Python tuple");
1387
1388	get_handler_name(handler_name, sizeof(handler_name),
1389			 counter);
1390
1391	handler = get_handler(handler_name);
1392	if (!handler) {
1393		pr_debug("can't find python handler %s\n", handler_name);
1394		return;
1395	}
1396
1397	PyTuple_SetItem(t, n++, _PyLong_FromLong(cpu));
1398	PyTuple_SetItem(t, n++, _PyLong_FromLong(thread));
1399
1400	tuple_set_u64(t, n++, tstamp);
1401	tuple_set_u64(t, n++, count->val);
1402	tuple_set_u64(t, n++, count->ena);
1403	tuple_set_u64(t, n++, count->run);
1404
1405	if (_PyTuple_Resize(&t, n) == -1)
1406		Py_FatalError("error resizing Python tuple");
1407
1408	call_object(handler, t, handler_name);
1409
1410	Py_DECREF(t);
1411}
1412
1413static void python_process_stat(struct perf_stat_config *config,
1414				struct evsel *counter, u64 tstamp)
1415{
1416	struct perf_thread_map *threads = counter->core.threads;
1417	struct perf_cpu_map *cpus = counter->core.cpus;
1418	int cpu, thread;
1419
1420	if (config->aggr_mode == AGGR_GLOBAL) {
1421		process_stat(counter, -1, -1, tstamp,
1422			     &counter->counts->aggr);
1423		return;
1424	}
1425
1426	for (thread = 0; thread < threads->nr; thread++) {
1427		for (cpu = 0; cpu < cpus->nr; cpu++) {
1428			process_stat(counter, cpus->map[cpu],
1429				     perf_thread_map__pid(threads, thread), tstamp,
1430				     perf_counts(counter->counts, cpu, thread));
1431		}
1432	}
1433}
1434
1435static void python_process_stat_interval(u64 tstamp)
1436{
1437	PyObject *handler, *t;
1438	static const char handler_name[] = "stat__interval";
1439	int n = 0;
1440
1441	t = PyTuple_New(MAX_FIELDS);
1442	if (!t)
1443		Py_FatalError("couldn't create Python tuple");
1444
1445	handler = get_handler(handler_name);
1446	if (!handler) {
1447		pr_debug("can't find python handler %s\n", handler_name);
1448		return;
1449	}
1450
1451	tuple_set_u64(t, n++, tstamp);
1452
1453	if (_PyTuple_Resize(&t, n) == -1)
1454		Py_FatalError("error resizing Python tuple");
1455
1456	call_object(handler, t, handler_name);
1457
1458	Py_DECREF(t);
1459}
1460
1461static int run_start_sub(void)
1462{
1463	main_module = PyImport_AddModule("__main__");
1464	if (main_module == NULL)
1465		return -1;
1466	Py_INCREF(main_module);
1467
1468	main_dict = PyModule_GetDict(main_module);
1469	if (main_dict == NULL)
1470		goto error;
1471	Py_INCREF(main_dict);
1472
1473	try_call_object("trace_begin", NULL);
1474
1475	return 0;
1476
1477error:
1478	Py_XDECREF(main_dict);
1479	Py_XDECREF(main_module);
1480	return -1;
1481}
1482
1483#define SET_TABLE_HANDLER_(name, handler_name, table_name) do {		\
1484	tables->handler_name = get_handler(#table_name);		\
1485	if (tables->handler_name)					\
1486		tables->dbe.export_ ## name = python_export_ ## name;	\
1487} while (0)
1488
1489#define SET_TABLE_HANDLER(name) \
1490	SET_TABLE_HANDLER_(name, name ## _handler, name ## _table)
1491
1492static void set_table_handlers(struct tables *tables)
1493{
1494	const char *perf_db_export_mode = "perf_db_export_mode";
1495	const char *perf_db_export_calls = "perf_db_export_calls";
1496	const char *perf_db_export_callchains = "perf_db_export_callchains";
1497	PyObject *db_export_mode, *db_export_calls, *db_export_callchains;
1498	bool export_calls = false;
1499	bool export_callchains = false;
1500	int ret;
1501
1502	memset(tables, 0, sizeof(struct tables));
1503	if (db_export__init(&tables->dbe))
1504		Py_FatalError("failed to initialize export");
1505
1506	db_export_mode = PyDict_GetItemString(main_dict, perf_db_export_mode);
1507	if (!db_export_mode)
1508		return;
1509
1510	ret = PyObject_IsTrue(db_export_mode);
1511	if (ret == -1)
1512		handler_call_die(perf_db_export_mode);
1513	if (!ret)
1514		return;
1515
1516	/* handle export calls */
1517	tables->dbe.crp = NULL;
1518	db_export_calls = PyDict_GetItemString(main_dict, perf_db_export_calls);
1519	if (db_export_calls) {
1520		ret = PyObject_IsTrue(db_export_calls);
1521		if (ret == -1)
1522			handler_call_die(perf_db_export_calls);
1523		export_calls = !!ret;
1524	}
1525
1526	if (export_calls) {
1527		tables->dbe.crp =
1528			call_return_processor__new(python_process_call_return,
1529						   &tables->dbe);
1530		if (!tables->dbe.crp)
1531			Py_FatalError("failed to create calls processor");
1532	}
1533
1534	/* handle export callchains */
1535	tables->dbe.cpr = NULL;
1536	db_export_callchains = PyDict_GetItemString(main_dict,
1537						    perf_db_export_callchains);
1538	if (db_export_callchains) {
1539		ret = PyObject_IsTrue(db_export_callchains);
1540		if (ret == -1)
1541			handler_call_die(perf_db_export_callchains);
1542		export_callchains = !!ret;
1543	}
1544
1545	if (export_callchains) {
1546		/*
1547		 * Attempt to use the call path root from the call return
1548		 * processor, if the call return processor is in use. Otherwise,
1549		 * we allocate a new call path root. This prevents exporting
1550		 * duplicate call path ids when both are in use simultaniously.
1551		 */
1552		if (tables->dbe.crp)
1553			tables->dbe.cpr = tables->dbe.crp->cpr;
1554		else
1555			tables->dbe.cpr = call_path_root__new();
1556
1557		if (!tables->dbe.cpr)
1558			Py_FatalError("failed to create call path root");
1559	}
1560
1561	tables->db_export_mode = true;
1562	/*
1563	 * Reserve per symbol space for symbol->db_id via symbol__priv()
1564	 */
1565	symbol_conf.priv_size = sizeof(u64);
1566
1567	SET_TABLE_HANDLER(evsel);
1568	SET_TABLE_HANDLER(machine);
1569	SET_TABLE_HANDLER(thread);
1570	SET_TABLE_HANDLER(comm);
1571	SET_TABLE_HANDLER(comm_thread);
1572	SET_TABLE_HANDLER(dso);
1573	SET_TABLE_HANDLER(symbol);
1574	SET_TABLE_HANDLER(branch_type);
1575	SET_TABLE_HANDLER(sample);
1576	SET_TABLE_HANDLER(call_path);
1577	SET_TABLE_HANDLER(call_return);
1578	SET_TABLE_HANDLER(context_switch);
1579
1580	/*
1581	 * Synthesized events are samples but with architecture-specific data
1582	 * stored in sample->raw_data. They are exported via
1583	 * python_export_sample() and consequently do not need a separate export
1584	 * callback.
1585	 */
1586	tables->synth_handler = get_handler("synth_data");
1587}
1588
1589#if PY_MAJOR_VERSION < 3
1590static void _free_command_line(const char **command_line, int num)
1591{
1592	free(command_line);
1593}
1594#else
1595static void _free_command_line(wchar_t **command_line, int num)
1596{
1597	int i;
1598	for (i = 0; i < num; i++)
1599		PyMem_RawFree(command_line[i]);
1600	free(command_line);
1601}
1602#endif
1603
1604
1605/*
1606 * Start trace script
1607 */
1608static int python_start_script(const char *script, int argc, const char **argv)
1609{
1610	struct tables *tables = &tables_global;
1611#if PY_MAJOR_VERSION < 3
1612	const char **command_line;
1613#else
1614	wchar_t **command_line;
1615#endif
1616	/*
1617	 * Use a non-const name variable to cope with python 2.6's
1618	 * PyImport_AppendInittab prototype
1619	 */
1620	char buf[PATH_MAX], name[19] = "perf_trace_context";
1621	int i, err = 0;
1622	FILE *fp;
1623
1624#if PY_MAJOR_VERSION < 3
1625	command_line = malloc((argc + 1) * sizeof(const char *));
1626	command_line[0] = script;
1627	for (i = 1; i < argc + 1; i++)
1628		command_line[i] = argv[i - 1];
1629	PyImport_AppendInittab(name, initperf_trace_context);
1630#else
1631	command_line = malloc((argc + 1) * sizeof(wchar_t *));
1632	command_line[0] = Py_DecodeLocale(script, NULL);
1633	for (i = 1; i < argc + 1; i++)
1634		command_line[i] = Py_DecodeLocale(argv[i - 1], NULL);
1635	PyImport_AppendInittab(name, PyInit_perf_trace_context);
1636#endif
1637	Py_Initialize();
1638
1639#if PY_MAJOR_VERSION < 3
1640	PySys_SetArgv(argc + 1, (char **)command_line);
1641#else
1642	PySys_SetArgv(argc + 1, command_line);
1643#endif
1644
1645	fp = fopen(script, "r");
1646	if (!fp) {
1647		sprintf(buf, "Can't open python script \"%s\"", script);
1648		perror(buf);
1649		err = -1;
1650		goto error;
1651	}
1652
1653	err = PyRun_SimpleFile(fp, script);
1654	if (err) {
1655		fprintf(stderr, "Error running python script %s\n", script);
1656		goto error;
1657	}
1658
1659	err = run_start_sub();
1660	if (err) {
1661		fprintf(stderr, "Error starting python script %s\n", script);
1662		goto error;
1663	}
1664
1665	set_table_handlers(tables);
1666
1667	if (tables->db_export_mode) {
1668		err = db_export__branch_types(&tables->dbe);
1669		if (err)
1670			goto error;
1671	}
1672
1673	_free_command_line(command_line, argc + 1);
1674
1675	return err;
1676error:
1677	Py_Finalize();
1678	_free_command_line(command_line, argc + 1);
1679
1680	return err;
1681}
1682
1683static int python_flush_script(void)
1684{
1685	return 0;
1686}
1687
1688/*
1689 * Stop trace script
1690 */
1691static int python_stop_script(void)
1692{
1693	struct tables *tables = &tables_global;
1694
1695	try_call_object("trace_end", NULL);
1696
1697	db_export__exit(&tables->dbe);
1698
1699	Py_XDECREF(main_dict);
1700	Py_XDECREF(main_module);
1701	Py_Finalize();
1702
1703	return 0;
1704}
1705
1706static int python_generate_script(struct tep_handle *pevent, const char *outfile)
1707{
1708	int i, not_first, count, nr_events;
1709	struct tep_event **all_events;
1710	struct tep_event *event = NULL;
1711	struct tep_format_field *f;
1712	char fname[PATH_MAX];
1713	FILE *ofp;
1714
1715	sprintf(fname, "%s.py", outfile);
1716	ofp = fopen(fname, "w");
1717	if (ofp == NULL) {
1718		fprintf(stderr, "couldn't open %s\n", fname);
1719		return -1;
1720	}
1721	fprintf(ofp, "# perf script event handlers, "
1722		"generated by perf script -g python\n");
1723
1724	fprintf(ofp, "# Licensed under the terms of the GNU GPL"
1725		" License version 2\n\n");
1726
1727	fprintf(ofp, "# The common_* event handler fields are the most useful "
1728		"fields common to\n");
1729
1730	fprintf(ofp, "# all events.  They don't necessarily correspond to "
1731		"the 'common_*' fields\n");
1732
1733	fprintf(ofp, "# in the format files.  Those fields not available as "
1734		"handler params can\n");
1735
1736	fprintf(ofp, "# be retrieved using Python functions of the form "
1737		"common_*(context).\n");
1738
1739	fprintf(ofp, "# See the perf-script-python Documentation for the list "
1740		"of available functions.\n\n");
1741
1742	fprintf(ofp, "from __future__ import print_function\n\n");
1743	fprintf(ofp, "import os\n");
1744	fprintf(ofp, "import sys\n\n");
1745
1746	fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
1747	fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
1748	fprintf(ofp, "\nfrom perf_trace_context import *\n");
1749	fprintf(ofp, "from Core import *\n\n\n");
1750
1751	fprintf(ofp, "def trace_begin():\n");
1752	fprintf(ofp, "\tprint(\"in trace_begin\")\n\n");
1753
1754	fprintf(ofp, "def trace_end():\n");
1755	fprintf(ofp, "\tprint(\"in trace_end\")\n\n");
1756
1757	nr_events = tep_get_events_count(pevent);
1758	all_events = tep_list_events(pevent, TEP_EVENT_SORT_ID);
1759
1760	for (i = 0; all_events && i < nr_events; i++) {
1761		event = all_events[i];
1762		fprintf(ofp, "def %s__%s(", event->system, event->name);
1763		fprintf(ofp, "event_name, ");
1764		fprintf(ofp, "context, ");
1765		fprintf(ofp, "common_cpu,\n");
1766		fprintf(ofp, "\tcommon_secs, ");
1767		fprintf(ofp, "common_nsecs, ");
1768		fprintf(ofp, "common_pid, ");
1769		fprintf(ofp, "common_comm,\n\t");
1770		fprintf(ofp, "common_callchain, ");
1771
1772		not_first = 0;
1773		count = 0;
1774
1775		for (f = event->format.fields; f; f = f->next) {
1776			if (not_first++)
1777				fprintf(ofp, ", ");
1778			if (++count % 5 == 0)
1779				fprintf(ofp, "\n\t");
1780
1781			fprintf(ofp, "%s", f->name);
1782		}
1783		if (not_first++)
1784			fprintf(ofp, ", ");
1785		if (++count % 5 == 0)
1786			fprintf(ofp, "\n\t\t");
1787		fprintf(ofp, "perf_sample_dict");
1788
1789		fprintf(ofp, "):\n");
1790
1791		fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
1792			"common_secs, common_nsecs,\n\t\t\t"
1793			"common_pid, common_comm)\n\n");
1794
1795		fprintf(ofp, "\t\tprint(\"");
1796
1797		not_first = 0;
1798		count = 0;
1799
1800		for (f = event->format.fields; f; f = f->next) {
1801			if (not_first++)
1802				fprintf(ofp, ", ");
1803			if (count && count % 3 == 0) {
1804				fprintf(ofp, "\" \\\n\t\t\"");
1805			}
1806			count++;
1807
1808			fprintf(ofp, "%s=", f->name);
1809			if (f->flags & TEP_FIELD_IS_STRING ||
1810			    f->flags & TEP_FIELD_IS_FLAG ||
1811			    f->flags & TEP_FIELD_IS_ARRAY ||
1812			    f->flags & TEP_FIELD_IS_SYMBOLIC)
1813				fprintf(ofp, "%%s");
1814			else if (f->flags & TEP_FIELD_IS_SIGNED)
1815				fprintf(ofp, "%%d");
1816			else
1817				fprintf(ofp, "%%u");
1818		}
1819
1820		fprintf(ofp, "\" %% \\\n\t\t(");
1821
1822		not_first = 0;
1823		count = 0;
1824
1825		for (f = event->format.fields; f; f = f->next) {
1826			if (not_first++)
1827				fprintf(ofp, ", ");
1828
1829			if (++count % 5 == 0)
1830				fprintf(ofp, "\n\t\t");
1831
1832			if (f->flags & TEP_FIELD_IS_FLAG) {
1833				if ((count - 1) % 5 != 0) {
1834					fprintf(ofp, "\n\t\t");
1835					count = 4;
1836				}
1837				fprintf(ofp, "flag_str(\"");
1838				fprintf(ofp, "%s__%s\", ", event->system,
1839					event->name);
1840				fprintf(ofp, "\"%s\", %s)", f->name,
1841					f->name);
1842			} else if (f->flags & TEP_FIELD_IS_SYMBOLIC) {
1843				if ((count - 1) % 5 != 0) {
1844					fprintf(ofp, "\n\t\t");
1845					count = 4;
1846				}
1847				fprintf(ofp, "symbol_str(\"");
1848				fprintf(ofp, "%s__%s\", ", event->system,
1849					event->name);
1850				fprintf(ofp, "\"%s\", %s)", f->name,
1851					f->name);
1852			} else
1853				fprintf(ofp, "%s", f->name);
1854		}
1855
1856		fprintf(ofp, "))\n\n");
1857
1858		fprintf(ofp, "\t\tprint('Sample: {'+"
1859			"get_dict_as_string(perf_sample_dict['sample'], ', ')+'}')\n\n");
1860
1861		fprintf(ofp, "\t\tfor node in common_callchain:");
1862		fprintf(ofp, "\n\t\t\tif 'sym' in node:");
1863		fprintf(ofp, "\n\t\t\t\tprint(\"\\t[%%x] %%s\" %% (node['ip'], node['sym']['name']))");
1864		fprintf(ofp, "\n\t\t\telse:");
1865		fprintf(ofp, "\n\t\t\t\tprint(\"\t[%%x]\" %% (node['ip']))\n\n");
1866		fprintf(ofp, "\t\tprint()\n\n");
1867
1868	}
1869
1870	fprintf(ofp, "def trace_unhandled(event_name, context, "
1871		"event_fields_dict, perf_sample_dict):\n");
1872
1873	fprintf(ofp, "\t\tprint(get_dict_as_string(event_fields_dict))\n");
1874	fprintf(ofp, "\t\tprint('Sample: {'+"
1875		"get_dict_as_string(perf_sample_dict['sample'], ', ')+'}')\n\n");
1876
1877	fprintf(ofp, "def print_header("
1878		"event_name, cpu, secs, nsecs, pid, comm):\n"
1879		"\tprint(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
1880		"(event_name, cpu, secs, nsecs, pid, comm), end=\"\")\n\n");
1881
1882	fprintf(ofp, "def get_dict_as_string(a_dict, delimiter=' '):\n"
1883		"\treturn delimiter.join"
1884		"(['%%s=%%s'%%(k,str(v))for k,v in sorted(a_dict.items())])\n");
1885
1886	fclose(ofp);
1887
1888	fprintf(stderr, "generated Python script: %s\n", fname);
1889
1890	return 0;
1891}
1892
1893struct scripting_ops python_scripting_ops = {
1894	.name			= "Python",
1895	.start_script		= python_start_script,
1896	.flush_script		= python_flush_script,
1897	.stop_script		= python_stop_script,
1898	.process_event		= python_process_event,
1899	.process_switch		= python_process_switch,
1900	.process_stat		= python_process_stat,
1901	.process_stat_interval	= python_process_stat_interval,
1902	.generate_script	= python_generate_script,
1903};
1904