[mirror_ubuntu-focal-kernel.git] / tools / perf / util / scripting-engines / trace-event-python.c

/*
 * trace-event-python.  Feed trace events to an embedded Python interpreter.
 *
 * Copyright (C) 2010 Tom Zanussi <tzanussi@gmail.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#include <Python.h>

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>

#include "../../perf.h"
#include "../util.h"
#include "../event.h"
#include "../thread.h"
#include "../trace-event.h"

PyMODINIT_FUNC initperf_trace_context(void);

#define FTRACE_MAX_EVENT				\
	((1 << (sizeof(unsigned short) * 8)) - 1)

struct event *events[FTRACE_MAX_EVENT];

#define MAX_FIELDS	64
#define N_COMMON_FIELDS	7

extern struct scripting_context *scripting_context;

static char *cur_field_name;
static int zero_flag_atom;

static PyObject *main_module, *main_dict;

static void handler_call_die(const char *handler_name)
{
	PyErr_Print();
	Py_FatalError("problem in Python trace event handler");
}

static void define_value(enum print_arg_type field_type,
			 const char *ev_name,
			 const char *field_name,
			 const char *field_value,
			 const char *field_str)
{
	const char *handler_name = "define_flag_value";
	PyObject *handler, *t, *retval;
	unsigned long long value;
	unsigned n = 0;

	if (field_type == PRINT_SYMBOL)
		handler_name = "define_symbolic_value";

	t = PyTuple_New(4);
	if (!t)
		Py_FatalError("couldn't create Python tuple");

	value = eval_flag(field_value);

	PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
	PyTuple_SetItem(t, n++, PyString_FromString(field_name));
	PyTuple_SetItem(t, n++, PyInt_FromLong(value));
	PyTuple_SetItem(t, n++, PyString_FromString(field_str));

	handler = PyDict_GetItemString(main_dict, handler_name);
	if (handler && PyCallable_Check(handler)) {
		retval = PyObject_CallObject(handler, t);
		if (retval == NULL)
			handler_call_die(handler_name);
	}

	Py_DECREF(t);
}

static void define_values(enum print_arg_type field_type,
			  struct print_flag_sym *field,
			  const char *ev_name,
			  const char *field_name)
{
	define_value(field_type, ev_name, field_name, field->value,
		     field->str);

	if (field->next)
		define_values(field_type, field->next, ev_name, field_name);
}

static void define_field(enum print_arg_type field_type,
			 const char *ev_name,
			 const char *field_name,
			 const char *delim)
{
	const char *handler_name = "define_flag_field";
	PyObject *handler, *t, *retval;
	unsigned n = 0;

	if (field_type == PRINT_SYMBOL)
		handler_name = "define_symbolic_field";

	if (field_type == PRINT_FLAGS)
		t = PyTuple_New(3);
	else
		t = PyTuple_New(2);
	if (!t)
		Py_FatalError("couldn't create Python tuple");

	PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
	PyTuple_SetItem(t, n++, PyString_FromString(field_name));
	if (field_type == PRINT_FLAGS)
		PyTuple_SetItem(t, n++, PyString_FromString(delim));

	handler = PyDict_GetItemString(main_dict, handler_name);
	if (handler && PyCallable_Check(handler)) {
		retval = PyObject_CallObject(handler, t);
		if (retval == NULL)
			handler_call_die(handler_name);
	}

	Py_DECREF(t);
}

static void define_event_symbols(struct event *event,
				 const char *ev_name,
				 struct print_arg *args)
{
	switch (args->type) {
	case PRINT_NULL:
		break;
	case PRINT_ATOM:
		define_value(PRINT_FLAGS, ev_name, cur_field_name, "0",
			     args->atom.atom);
		zero_flag_atom = 0;
		break;
	case PRINT_FIELD:
		if (cur_field_name)
			free(cur_field_name);
		cur_field_name = strdup(args->field.name);
		break;
	case PRINT_FLAGS:
		define_event_symbols(event, ev_name, args->flags.field);
		define_field(PRINT_FLAGS, ev_name, cur_field_name,
			     args->flags.delim);
		define_values(PRINT_FLAGS, args->flags.flags, ev_name,
			      cur_field_name);
		break;
	case PRINT_SYMBOL:
		define_event_symbols(event, ev_name, args->symbol.field);
		define_field(PRINT_SYMBOL, ev_name, cur_field_name, NULL);
		define_values(PRINT_SYMBOL, args->symbol.symbols, ev_name,
			      cur_field_name);
		break;
	case PRINT_STRING:
		break;
	case PRINT_TYPE:
		define_event_symbols(event, ev_name, args->typecast.item);
		break;
	case PRINT_OP:
		if (strcmp(args->op.op, ":") == 0)
			zero_flag_atom = 1;
		define_event_symbols(event, ev_name, args->op.left);
		define_event_symbols(event, ev_name, args->op.right);
		break;
	default:
		/* we should warn... */
		return;
	}

	if (args->next)
		define_event_symbols(event, ev_name, args->next);
}

static inline struct event *find_cache_event(int type)
{
	static char ev_name[256];
	struct event *event;

	if (events[type])
		return events[type];

	events[type] = event = trace_find_event(type);
	if (!event)
		return NULL;

	sprintf(ev_name, "%s__%s", event->system, event->name);

	define_event_symbols(event, ev_name, event->print_fmt.args);

	return event;
}

static void python_process_event(union perf_event *pevent __unused,
				 struct perf_sample *sample,
				 struct perf_evsel *evsel __unused,
				 struct machine *machine __unused,
				 struct thread *thread)
{
	PyObject *handler, *retval, *context, *t, *obj, *dict = NULL;
	static char handler_name[256];
	struct format_field *field;
	unsigned long long val;
	unsigned long s, ns;
	struct event *event;
	unsigned n = 0;
	int type;
	int pid;
	int cpu = sample->cpu;
	void *data = sample->raw_data;
	unsigned long long nsecs = sample->time;
	char *comm = thread->comm;

	t = PyTuple_New(MAX_FIELDS);
	if (!t)
		Py_FatalError("couldn't create Python tuple");

	type = trace_parse_common_type(data);

	event = find_cache_event(type);
	if (!event)
		die("ug! no event found for type %d", type);

	pid = trace_parse_common_pid(data);

	sprintf(handler_name, "%s__%s", event->system, event->name);

	handler = PyDict_GetItemString(main_dict, handler_name);
	if (handler && !PyCallable_Check(handler))
		handler = NULL;
	if (!handler) {
		dict = PyDict_New();
		if (!dict)
			Py_FatalError("couldn't create Python dict");
	}
	s = nsecs / NSECS_PER_SEC;
	ns = nsecs - s * NSECS_PER_SEC;

	scripting_context->event_data = data;

	context = PyCObject_FromVoidPtr(scripting_context, NULL);

	PyTuple_SetItem(t, n++, PyString_FromString(handler_name));
	PyTuple_SetItem(t, n++, context);

	if (handler) {
		PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
		PyTuple_SetItem(t, n++, PyInt_FromLong(s));
		PyTuple_SetItem(t, n++, PyInt_FromLong(ns));
		PyTuple_SetItem(t, n++, PyInt_FromLong(pid));
		PyTuple_SetItem(t, n++, PyString_FromString(comm));
	} else {
		PyDict_SetItemString(dict, "common_cpu", PyInt_FromLong(cpu));
		PyDict_SetItemString(dict, "common_s", PyInt_FromLong(s));
		PyDict_SetItemString(dict, "common_ns", PyInt_FromLong(ns));
		PyDict_SetItemString(dict, "common_pid", PyInt_FromLong(pid));
		PyDict_SetItemString(dict, "common_comm", PyString_FromString(comm));
	}
	for (field = event->format.fields; field; field = field->next) {
		if (field->flags & FIELD_IS_STRING) {
			int offset;
			if (field->flags & FIELD_IS_DYNAMIC) {
				offset = *(int *)(data + field->offset);
				offset &= 0xffff;
			} else
				offset = field->offset;
			obj = PyString_FromString((char *)data + offset);
		} else { /* FIELD_IS_NUMERIC */
			val = read_size(data + field->offset, field->size);
			if (field->flags & FIELD_IS_SIGNED) {
				if ((long long)val >= LONG_MIN &&
				    (long long)val <= LONG_MAX)
					obj = PyInt_FromLong(val);
				else
					obj = PyLong_FromLongLong(val);
			} else {
				if (val <= LONG_MAX)
					obj = PyInt_FromLong(val);
				else
					obj = PyLong_FromUnsignedLongLong(val);
			}
		}
		if (handler)
			PyTuple_SetItem(t, n++, obj);
		else
			PyDict_SetItemString(dict, field->name, obj);

	}
	if (!handler)
		PyTuple_SetItem(t, n++, dict);

	if (_PyTuple_Resize(&t, n) == -1)
		Py_FatalError("error resizing Python tuple");

	if (handler) {
		retval = PyObject_CallObject(handler, t);
		if (retval == NULL)
			handler_call_die(handler_name);
	} else {
		handler = PyDict_GetItemString(main_dict, "trace_unhandled");
		if (handler && PyCallable_Check(handler)) {

			retval = PyObject_CallObject(handler, t);
			if (retval == NULL)
				handler_call_die("trace_unhandled");
		}
		Py_DECREF(dict);
	}

	Py_DECREF(t);
}

static int run_start_sub(void)
{
	PyObject *handler, *retval;
	int err = 0;

	main_module = PyImport_AddModule("__main__");
	if (main_module == NULL)
		return -1;
	Py_INCREF(main_module);

	main_dict = PyModule_GetDict(main_module);
	if (main_dict == NULL) {
		err = -1;
		goto error;
	}
	Py_INCREF(main_dict);

	handler = PyDict_GetItemString(main_dict, "trace_begin");
	if (handler == NULL || !PyCallable_Check(handler))
		goto out;

	retval = PyObject_CallObject(handler, NULL);
	if (retval == NULL)
		handler_call_die("trace_begin");

	Py_DECREF(retval);
	return err;
error:
	Py_XDECREF(main_dict);
	Py_XDECREF(main_module);
out:
	return err;
}

/*
 * Start trace script
 */
static int python_start_script(const char *script, int argc, const char **argv)
{
	const char **command_line;
	char buf[PATH_MAX];
	int i, err = 0;
	FILE *fp;

	command_line = malloc((argc + 1) * sizeof(const char *));
	command_line[0] = script;
	for (i = 1; i < argc + 1; i++)
		command_line[i] = argv[i - 1];

	Py_Initialize();

	initperf_trace_context();

	PySys_SetArgv(argc + 1, (char **)command_line);

	fp = fopen(script, "r");
	if (!fp) {
		sprintf(buf, "Can't open python script \"%s\"", script);
		perror(buf);
		err = -1;
		goto error;
	}

	err = PyRun_SimpleFile(fp, script);
	if (err) {
		fprintf(stderr, "Error running python script %s\n", script);
		goto error;
	}

	err = run_start_sub();
	if (err) {
		fprintf(stderr, "Error starting python script %s\n", script);
		goto error;
	}

	free(command_line);

	return err;
error:
	Py_Finalize();
	free(command_line);

	return err;
}

/*
 * Stop trace script
 */
static int python_stop_script(void)
{
	PyObject *handler, *retval;
	int err = 0;

	handler = PyDict_GetItemString(main_dict, "trace_end");
	if (handler == NULL || !PyCallable_Check(handler))
		goto out;

	retval = PyObject_CallObject(handler, NULL);
	if (retval == NULL)
		handler_call_die("trace_end");
	else
		Py_DECREF(retval);
out:
	Py_XDECREF(main_dict);
	Py_XDECREF(main_module);
	Py_Finalize();

	return err;
}

static int python_generate_script(const char *outfile)
{
	struct event *event = NULL;
	struct format_field *f;
	char fname[PATH_MAX];
	int not_first, count;
	FILE *ofp;

	sprintf(fname, "%s.py", outfile);
	ofp = fopen(fname, "w");
	if (ofp == NULL) {
		fprintf(stderr, "couldn't open %s\n", fname);
		return -1;
	}
	fprintf(ofp, "# perf script event handlers, "
		"generated by perf script -g python\n");

	fprintf(ofp, "# Licensed under the terms of the GNU GPL"
		" License version 2\n\n");

	fprintf(ofp, "# The common_* event handler fields are the most useful "
		"fields common to\n");

	fprintf(ofp, "# all events.  They don't necessarily correspond to "
		"the 'common_*' fields\n");

	fprintf(ofp, "# in the format files.  Those fields not available as "
		"handler params can\n");

	fprintf(ofp, "# be retrieved using Python functions of the form "
		"common_*(context).\n");

	fprintf(ofp, "# See the perf-trace-python Documentation for the list "
		"of available functions.\n\n");

	fprintf(ofp, "import os\n");
	fprintf(ofp, "import sys\n\n");

	fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
	fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
	fprintf(ofp, "\nfrom perf_trace_context import *\n");
	fprintf(ofp, "from Core import *\n\n\n");

	fprintf(ofp, "def trace_begin():\n");
	fprintf(ofp, "\tprint \"in trace_begin\"\n\n");

	fprintf(ofp, "def trace_end():\n");
	fprintf(ofp, "\tprint \"in trace_end\"\n\n");

	while ((event = trace_find_next_event(event))) {
		fprintf(ofp, "def %s__%s(", event->system, event->name);
		fprintf(ofp, "event_name, ");
		fprintf(ofp, "context, ");
		fprintf(ofp, "common_cpu,\n");
		fprintf(ofp, "\tcommon_secs, ");
		fprintf(ofp, "common_nsecs, ");
		fprintf(ofp, "common_pid, ");
		fprintf(ofp, "common_comm,\n\t");

		not_first = 0;
		count = 0;

		for (f = event->format.fields; f; f = f->next) {
			if (not_first++)
				fprintf(ofp, ", ");
			if (++count % 5 == 0)
				fprintf(ofp, "\n\t");

			fprintf(ofp, "%s", f->name);
		}
		fprintf(ofp, "):\n");

		fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
			"common_secs, common_nsecs,\n\t\t\t"
			"common_pid, common_comm)\n\n");

		fprintf(ofp, "\t\tprint \"");

		not_first = 0;
		count = 0;

		for (f = event->format.fields; f; f = f->next) {
			if (not_first++)
				fprintf(ofp, ", ");
			if (count && count % 3 == 0) {
				fprintf(ofp, "\" \\\n\t\t\"");
			}
			count++;

			fprintf(ofp, "%s=", f->name);
			if (f->flags & FIELD_IS_STRING ||
			    f->flags & FIELD_IS_FLAG ||
			    f->flags & FIELD_IS_SYMBOLIC)
				fprintf(ofp, "%%s");
			else if (f->flags & FIELD_IS_SIGNED)
				fprintf(ofp, "%%d");
			else
				fprintf(ofp, "%%u");
		}

		fprintf(ofp, "\\n\" %% \\\n\t\t(");

		not_first = 0;
		count = 0;

		for (f = event->format.fields; f; f = f->next) {
			if (not_first++)
				fprintf(ofp, ", ");

			if (++count % 5 == 0)
				fprintf(ofp, "\n\t\t");

			if (f->flags & FIELD_IS_FLAG) {
				if ((count - 1) % 5 != 0) {
					fprintf(ofp, "\n\t\t");
					count = 4;
				}
				fprintf(ofp, "flag_str(\"");
				fprintf(ofp, "%s__%s\", ", event->system,
					event->name);
				fprintf(ofp, "\"%s\", %s)", f->name,
					f->name);
			} else if (f->flags & FIELD_IS_SYMBOLIC) {
				if ((count - 1) % 5 != 0) {
					fprintf(ofp, "\n\t\t");
					count = 4;
				}
				fprintf(ofp, "symbol_str(\"");
				fprintf(ofp, "%s__%s\", ", event->system,
					event->name);
				fprintf(ofp, "\"%s\", %s)", f->name,
					f->name);
			} else
				fprintf(ofp, "%s", f->name);
		}

		fprintf(ofp, "),\n\n");
	}

	fprintf(ofp, "def trace_unhandled(event_name, context, "
		"event_fields_dict):\n");

	fprintf(ofp, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
		"for k,v in sorted(event_fields_dict.items())])\n\n");

	fprintf(ofp, "def print_header("
		"event_name, cpu, secs, nsecs, pid, comm):\n"
		"\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
		"(event_name, cpu, secs, nsecs, pid, comm),\n");

	fclose(ofp);

	fprintf(stderr, "generated Python script: %s\n", fname);

	return 0;
}

struct scripting_ops python_scripting_ops = {
	.name = "Python",
	.start_script = python_start_script,
	.stop_script = python_stop_script,
	.process_event = python_process_event,
	.generate_script = python_generate_script,
};
Commit	Line	Data
7e4b21b8 TZ	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 <stdio.h>
	25	#include <stdlib.h>
	26	#include <string.h>
7e4b21b8 TZ	27	#include <errno.h>
	28
	29	#include "../../perf.h"
	30	#include "../util.h"
743eb868 ACM	31	#include "../event.h"
743eb868 ACM	32	#include "../thread.h"
7e4b21b8 TZ	33	#include "../trace-event.h"
	34
	35	PyMODINIT_FUNC initperf_trace_context(void);
	36
	37	#define FTRACE_MAX_EVENT \
	38	((1 << (sizeof(unsigned short) * 8)) - 1)
	39
	40	struct event *events[FTRACE_MAX_EVENT];
	41
	42	#define MAX_FIELDS 64
	43	#define N_COMMON_FIELDS 7
	44
	45	extern struct scripting_context *scripting_context;
	46
	47	static char *cur_field_name;
	48	static int zero_flag_atom;
	49
	50	static PyObject main_module, main_dict;
	51
	52	static void handler_call_die(const char *handler_name)
	53	{
	54	PyErr_Print();
	55	Py_FatalError("problem in Python trace event handler");
	56	}
	57
	58	static void define_value(enum print_arg_type field_type,
	59	const char *ev_name,
	60	const char *field_name,
	61	const char *field_value,
	62	const char *field_str)
	63	{
	64	const char *handler_name = "define_flag_value";
	65	PyObject handler, t, *retval;
	66	unsigned long long value;
	67	unsigned n = 0;
	68
	69	if (field_type == PRINT_SYMBOL)
	70	handler_name = "define_symbolic_value";
	71
44ad9cd8	72	t = PyTuple_New(4);
7e4b21b8 TZ	73	if (!t)
	74	Py_FatalError("couldn't create Python tuple");
	75
	76	value = eval_flag(field_value);
	77
	78	PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
	79	PyTuple_SetItem(t, n++, PyString_FromString(field_name));
	80	PyTuple_SetItem(t, n++, PyInt_FromLong(value));
	81	PyTuple_SetItem(t, n++, PyString_FromString(field_str));
	82
7e4b21b8 TZ	83	handler = PyDict_GetItemString(main_dict, handler_name);
	84	if (handler && PyCallable_Check(handler)) {
	85	retval = PyObject_CallObject(handler, t);
	86	if (retval == NULL)
	87	handler_call_die(handler_name);
	88	}
	89
	90	Py_DECREF(t);
	91	}
	92
	93	static void define_values(enum print_arg_type field_type,
	94	struct print_flag_sym *field,
	95	const char *ev_name,
	96	const char *field_name)
	97	{
	98	define_value(field_type, ev_name, field_name, field->value,
	99	field->str);
	100
	101	if (field->next)
	102	define_values(field_type, field->next, ev_name, field_name);
	103	}
	104
	105	static void define_field(enum print_arg_type field_type,
	106	const char *ev_name,
	107	const char *field_name,
	108	const char *delim)
	109	{
	110	const char *handler_name = "define_flag_field";
	111	PyObject handler, t, *retval;
	112	unsigned n = 0;
	113
	114	if (field_type == PRINT_SYMBOL)
	115	handler_name = "define_symbolic_field";
	116
44ad9cd8 TZ	117	if (field_type == PRINT_FLAGS)
	118	t = PyTuple_New(3);
	119	else
	120	t = PyTuple_New(2);
7e4b21b8 TZ	121	if (!t)
	122	Py_FatalError("couldn't create Python tuple");
	123
	124	PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
	125	PyTuple_SetItem(t, n++, PyString_FromString(field_name));
	126	if (field_type == PRINT_FLAGS)
	127	PyTuple_SetItem(t, n++, PyString_FromString(delim));
	128
7e4b21b8 TZ	129	handler = PyDict_GetItemString(main_dict, handler_name);
	130	if (handler && PyCallable_Check(handler)) {
	131	retval = PyObject_CallObject(handler, t);
	132	if (retval == NULL)
	133	handler_call_die(handler_name);
	134	}
	135
	136	Py_DECREF(t);
	137	}
	138
	139	static void define_event_symbols(struct event *event,
	140	const char *ev_name,
	141	struct print_arg *args)
	142	{
	143	switch (args->type) {
	144	case PRINT_NULL:
	145	break;
	146	case PRINT_ATOM:
	147	define_value(PRINT_FLAGS, ev_name, cur_field_name, "0",
	148	args->atom.atom);
	149	zero_flag_atom = 0;
	150	break;
	151	case PRINT_FIELD:
	152	if (cur_field_name)
	153	free(cur_field_name);
	154	cur_field_name = strdup(args->field.name);
	155	break;
	156	case PRINT_FLAGS:
	157	define_event_symbols(event, ev_name, args->flags.field);
	158	define_field(PRINT_FLAGS, ev_name, cur_field_name,
	159	args->flags.delim);
	160	define_values(PRINT_FLAGS, args->flags.flags, ev_name,
	161	cur_field_name);
	162	break;
	163	case PRINT_SYMBOL:
	164	define_event_symbols(event, ev_name, args->symbol.field);
	165	define_field(PRINT_SYMBOL, ev_name, cur_field_name, NULL);
	166	define_values(PRINT_SYMBOL, args->symbol.symbols, ev_name,
	167	cur_field_name);
	168	break;
	169	case PRINT_STRING:
	170	break;
	171	case PRINT_TYPE:
	172	define_event_symbols(event, ev_name, args->typecast.item);
	173	break;
	174	case PRINT_OP:
	175	if (strcmp(args->op.op, ":") == 0)
	176	zero_flag_atom = 1;
	177	define_event_symbols(event, ev_name, args->op.left);
	178	define_event_symbols(event, ev_name, args->op.right);
	179	break;
	180	default:
	181	/* we should warn... */
	182	return;
	183	}
	184
	185	if (args->next)
	186	define_event_symbols(event, ev_name, args->next);
	187	}
	188
	189	static inline struct event *find_cache_event(int type)
	190	{
	191	static char ev_name[256];
	192	struct event *event;
193
194	if (events[type])
195	return events[type];
196
197	events[type] = event = trace_find_event(type);
198	if (!event)
199	return NULL;
200
201	sprintf(ev_name, "%s__%s", event->system, event->name);
202
203	define_event_symbols(event, ev_name, event->print_fmt.args);
204
205	return event;
206	}
207
be6d842a DA	208	static void python_process_event(union perf_event *pevent __unused,
be6d842a DA	209	struct perf_sample *sample,
9e69c210	210	struct perf_evsel *evsel __unused,
743eb868	211	struct machine *machine __unused,
be6d842a	212	struct thread *thread)
7e4b21b8	213	{
c0251485	214	PyObject handler, retval, context, t, obj, dict = NULL;
7e4b21b8 TZ	215	static char handler_name[256];
	216	struct format_field *field;
	217	unsigned long long val;
	218	unsigned long s, ns;
	219	struct event *event;
	220	unsigned n = 0;
	221	int type;
	222	int pid;
be6d842a DA	223	int cpu = sample->cpu;
	224	void *data = sample->raw_data;
	225	unsigned long long nsecs = sample->time;
	226	char *comm = thread->comm;
7e4b21b8 TZ	227
	228	t = PyTuple_New(MAX_FIELDS);
	229	if (!t)
	230	Py_FatalError("couldn't create Python tuple");
	231
	232	type = trace_parse_common_type(data);
	233
	234	event = find_cache_event(type);
	235	if (!event)
	236	die("ug! no event found for type %d", type);
	237
	238	pid = trace_parse_common_pid(data);
	239
	240	sprintf(handler_name, "%s__%s", event->system, event->name);
	241
c0251485 PT	242	handler = PyDict_GetItemString(main_dict, handler_name);
	243	if (handler && !PyCallable_Check(handler))
	244	handler = NULL;
	245	if (!handler) {
	246	dict = PyDict_New();
	247	if (!dict)
	248	Py_FatalError("couldn't create Python dict");
	249	}
7e4b21b8 TZ	250	s = nsecs / NSECS_PER_SEC;
	251	ns = nsecs - s * NSECS_PER_SEC;
	252
	253	scripting_context->event_data = data;
	254
	255	context = PyCObject_FromVoidPtr(scripting_context, NULL);
	256
	257	PyTuple_SetItem(t, n++, PyString_FromString(handler_name));
fb7d0b3c	258	PyTuple_SetItem(t, n++, context);
7e4b21b8	259
c0251485 PT	260	if (handler) {
	261	PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
	262	PyTuple_SetItem(t, n++, PyInt_FromLong(s));
	263	PyTuple_SetItem(t, n++, PyInt_FromLong(ns));
	264	PyTuple_SetItem(t, n++, PyInt_FromLong(pid));
	265	PyTuple_SetItem(t, n++, PyString_FromString(comm));
	266	} else {
	267	PyDict_SetItemString(dict, "common_cpu", PyInt_FromLong(cpu));
	268	PyDict_SetItemString(dict, "common_s", PyInt_FromLong(s));
	269	PyDict_SetItemString(dict, "common_ns", PyInt_FromLong(ns));
	270	PyDict_SetItemString(dict, "common_pid", PyInt_FromLong(pid));
	271	PyDict_SetItemString(dict, "common_comm", PyString_FromString(comm));
	272	}
7e4b21b8 TZ	273	for (field = event->format.fields; field; field = field->next) {
	274	if (field->flags & FIELD_IS_STRING) {
	275	int offset;
	276	if (field->flags & FIELD_IS_DYNAMIC) {
	277	offset = (int )(data + field->offset);
	278	offset &= 0xffff;
	279	} else
	280	offset = field->offset;
b1dcc03c	281	obj = PyString_FromString((char *)data + offset);
7e4b21b8 TZ	282	} else { /* FIELD_IS_NUMERIC */
	283	val = read_size(data + field->offset, field->size);
	284	if (field->flags & FIELD_IS_SIGNED) {
b1dcc03c TZ	285	if ((long long)val >= LONG_MIN &&
	286	(long long)val <= LONG_MAX)
	287	obj = PyInt_FromLong(val);
	288	else
	289	obj = PyLong_FromLongLong(val);
7e4b21b8	290	} else {
b1dcc03c TZ	291	if (val <= LONG_MAX)
	292	obj = PyInt_FromLong(val);
	293	else
	294	obj = PyLong_FromUnsignedLongLong(val);
7e4b21b8 TZ	295	}
7e4b21b8 TZ	296	}
c0251485 PT	297	if (handler)
	298	PyTuple_SetItem(t, n++, obj);
	299	else
	300	PyDict_SetItemString(dict, field->name, obj);
	301
7e4b21b8	302	}
c0251485 PT	303	if (!handler)
c0251485 PT	304	PyTuple_SetItem(t, n++, dict);
7e4b21b8 TZ	305
	306	if (_PyTuple_Resize(&t, n) == -1)
	307	Py_FatalError("error resizing Python tuple");
	308
c0251485	309	if (handler) {
7e4b21b8 TZ	310	retval = PyObject_CallObject(handler, t);
	311	if (retval == NULL)
	312	handler_call_die(handler_name);
	313	} else {
	314	handler = PyDict_GetItemString(main_dict, "trace_unhandled");
	315	if (handler && PyCallable_Check(handler)) {
7e4b21b8 TZ	316
	317	retval = PyObject_CallObject(handler, t);
	318	if (retval == NULL)
	319	handler_call_die("trace_unhandled");
	320	}
c0251485	321	Py_DECREF(dict);
7e4b21b8 TZ	322	}
	323
	324	Py_DECREF(t);
	325	}
	326
	327	static int run_start_sub(void)
	328	{
	329	PyObject handler, retval;
	330	int err = 0;
	331
	332	main_module = PyImport_AddModule("__main__");
	333	if (main_module == NULL)
	334	return -1;
	335	Py_INCREF(main_module);
	336
	337	main_dict = PyModule_GetDict(main_module);
	338	if (main_dict == NULL) {
	339	err = -1;
	340	goto error;
	341	}
	342	Py_INCREF(main_dict);
	343
	344	handler = PyDict_GetItemString(main_dict, "trace_begin");
	345	if (handler == NULL \|\| !PyCallable_Check(handler))
	346	goto out;
	347
	348	retval = PyObject_CallObject(handler, NULL);
	349	if (retval == NULL)
	350	handler_call_die("trace_begin");
	351
	352	Py_DECREF(retval);
	353	return err;
	354	error:
	355	Py_XDECREF(main_dict);
	356	Py_XDECREF(main_module);
	357	out:
	358	return err;
	359	}
	360
	361	/*
	362	* Start trace script
	363	*/
	364	static int python_start_script(const char script, int argc, const char *argv)
	365	{
	366	const char **command_line;
	367	char buf[PATH_MAX];
	368	int i, err = 0;
	369	FILE *fp;
	370
	371	command_line = malloc((argc + 1) * sizeof(const char *));
	372	command_line[0] = script;
	373	for (i = 1; i < argc + 1; i++)
	374	command_line[i] = argv[i - 1];
	375
	376	Py_Initialize();
	377
	378	initperf_trace_context();
	379
	380	PySys_SetArgv(argc + 1, (char **)command_line);
	381
	382	fp = fopen(script, "r");
	383	if (!fp) {
	384	sprintf(buf, "Can't open python script \"%s\"", script);
	385	perror(buf);
386	err = -1;
387	goto error;
388	}
389
390	err = PyRun_SimpleFile(fp, script);
391	if (err) {
392	fprintf(stderr, "Error running python script %s\n", script);
393	goto error;
394	}
395
396	err = run_start_sub();
397	if (err) {
398	fprintf(stderr, "Error starting python script %s\n", script);
399	goto error;
400	}
401
402	free(command_line);
7e4b21b8 TZ	403
	404	return err;
	405	error:
	406	Py_Finalize();
	407	free(command_line);
	408
	409	return err;
	410	}
	411
	412	/*
	413	* Stop trace script
	414	*/
	415	static int python_stop_script(void)
	416	{
	417	PyObject handler, retval;
	418	int err = 0;
	419
	420	handler = PyDict_GetItemString(main_dict, "trace_end");
	421	if (handler == NULL \|\| !PyCallable_Check(handler))
	422	goto out;
	423
	424	retval = PyObject_CallObject(handler, NULL);
	425	if (retval == NULL)
	426	handler_call_die("trace_end");
	427	else
	428	Py_DECREF(retval);
	429	out:
	430	Py_XDECREF(main_dict);
	431	Py_XDECREF(main_module);
	432	Py_Finalize();
	433
7e4b21b8 TZ	434	return err;
	435	}
	436
	437	static int python_generate_script(const char *outfile)
	438	{
	439	struct event *event = NULL;
	440	struct format_field *f;
	441	char fname[PATH_MAX];
	442	int not_first, count;
	443	FILE *ofp;
	444
	445	sprintf(fname, "%s.py", outfile);
	446	ofp = fopen(fname, "w");
	447	if (ofp == NULL) {
	448	fprintf(stderr, "couldn't open %s\n", fname);
	449	return -1;
	450	}
133dc4c3 IM	451	fprintf(ofp, "# perf script event handlers, "
133dc4c3 IM	452	"generated by perf script -g python\n");
7e4b21b8 TZ	453
	454	fprintf(ofp, "# Licensed under the terms of the GNU GPL"
	455	" License version 2\n\n");
	456
	457	fprintf(ofp, "# The common_* event handler fields are the most useful "
	458	"fields common to\n");
	459
	460	fprintf(ofp, "# all events. They don't necessarily correspond to "
	461	"the 'common_*' fields\n");
	462
	463	fprintf(ofp, "# in the format files. Those fields not available as "
	464	"handler params can\n");
	465
	466	fprintf(ofp, "# be retrieved using Python functions of the form "
	467	"common_*(context).\n");
	468
	469	fprintf(ofp, "# See the perf-trace-python Documentation for the list "
	470	"of available functions.\n\n");
	471
	472	fprintf(ofp, "import os\n");
	473	fprintf(ofp, "import sys\n\n");
	474
	475	fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
	476	fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
	477	fprintf(ofp, "\nfrom perf_trace_context import *\n");
	478	fprintf(ofp, "from Core import *\n\n\n");
	479
	480	fprintf(ofp, "def trace_begin():\n");
	481	fprintf(ofp, "\tprint \"in trace_begin\"\n\n");
	482
	483	fprintf(ofp, "def trace_end():\n");
	484	fprintf(ofp, "\tprint \"in trace_end\"\n\n");
	485
	486	while ((event = trace_find_next_event(event))) {
	487	fprintf(ofp, "def %s__%s(", event->system, event->name);
	488	fprintf(ofp, "event_name, ");
	489	fprintf(ofp, "context, ");
	490	fprintf(ofp, "common_cpu,\n");
	491	fprintf(ofp, "\tcommon_secs, ");
	492	fprintf(ofp, "common_nsecs, ");
	493	fprintf(ofp, "common_pid, ");
	494	fprintf(ofp, "common_comm,\n\t");
	495
	496	not_first = 0;
	497	count = 0;
	498
	499	for (f = event->format.fields; f; f = f->next) {
	500	if (not_first++)
	501	fprintf(ofp, ", ");
	502	if (++count % 5 == 0)
	503	fprintf(ofp, "\n\t");
	504
	505	fprintf(ofp, "%s", f->name);
	506	}
	507	fprintf(ofp, "):\n");
	508
	509	fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
	510	"common_secs, common_nsecs,\n\t\t\t"
	511	"common_pid, common_comm)\n\n");
	512
	513	fprintf(ofp, "\t\tprint \"");
	514
	515	not_first = 0;
	516	count = 0;
517
518	for (f = event->format.fields; f; f = f->next) {
519	if (not_first++)
520	fprintf(ofp, ", ");
521	if (count && count % 3 == 0) {
522	fprintf(ofp, "\" \\\n\t\t\"");
523	}
524	count++;
525
526	fprintf(ofp, "%s=", f->name);
527	if (f->flags & FIELD_IS_STRING \|\|
528	f->flags & FIELD_IS_FLAG \|\|
529	f->flags & FIELD_IS_SYMBOLIC)
530	fprintf(ofp, "%%s");
531	else if (f->flags & FIELD_IS_SIGNED)
532	fprintf(ofp, "%%d");
533	else
534	fprintf(ofp, "%%u");
535	}
536
537	fprintf(ofp, "\\n\" %% \\\n\t\t(");
538
539	not_first = 0;
540	count = 0;
541
542	for (f = event->format.fields; f; f = f->next) {
543	if (not_first++)
544	fprintf(ofp, ", ");
545
546	if (++count % 5 == 0)
547	fprintf(ofp, "\n\t\t");
548
549	if (f->flags & FIELD_IS_FLAG) {
550	if ((count - 1) % 5 != 0) {
551	fprintf(ofp, "\n\t\t");
552	count = 4;
553	}
554	fprintf(ofp, "flag_str(\"");
555	fprintf(ofp, "%s__%s\", ", event->system,
556	event->name);
557	fprintf(ofp, "\"%s\", %s)", f->name,
558	f->name);
559	} else if (f->flags & FIELD_IS_SYMBOLIC) {
560	if ((count - 1) % 5 != 0) {
561	fprintf(ofp, "\n\t\t");
562	count = 4;
563	}
564	fprintf(ofp, "symbol_str(\"");
565	fprintf(ofp, "%s__%s\", ", event->system,
566	event->name);
567	fprintf(ofp, "\"%s\", %s)", f->name,
568	f->name);
569	} else
570	fprintf(ofp, "%s", f->name);
571	}
572
573	fprintf(ofp, "),\n\n");
574	}
575
576	fprintf(ofp, "def trace_unhandled(event_name, context, "
c0251485	577	"event_fields_dict):\n");
7e4b21b8	578
c0251485 PT	579	fprintf(ofp, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
c0251485 PT	580	"for k,v in sorted(event_fields_dict.items())])\n\n");
7e4b21b8 TZ	581
	582	fprintf(ofp, "def print_header("
	583	"event_name, cpu, secs, nsecs, pid, comm):\n"
	584	"\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
	585	"(event_name, cpu, secs, nsecs, pid, comm),\n");
	586
	587	fclose(ofp);
	588
	589	fprintf(stderr, "generated Python script: %s\n", fname);
	590
	591	return 0;
	592	}
	593
	594	struct scripting_ops python_scripting_ops = {
	595	.name = "Python",
	596	.start_script = python_start_script,
	597	.stop_script = python_stop_script,
	598	.process_event = python_process_event,
	599	.generate_script = python_generate_script,
	600	};