2 * trace-event-python. Feed trace events to an embedded Python interpreter.
4 * Copyright (C) 2010 Tom Zanussi <tzanussi@gmail.com>
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.
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.
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
30 #include "../../perf.h"
32 #include "../trace-event.h"
34 PyMODINIT_FUNC initperf_trace_context(void);
36 #define FTRACE_MAX_EVENT \
37 ((1 << (sizeof(unsigned short) * 8)) - 1)
39 struct event *events[FTRACE_MAX_EVENT];
42 #define N_COMMON_FIELDS 7
44 extern struct scripting_context *scripting_context;
46 static char *cur_field_name;
47 static int zero_flag_atom;
49 static PyObject *main_module, *main_dict;
51 static void handler_call_die(const char *handler_name)
54 Py_FatalError("problem in Python trace event handler");
57 static void define_value(enum print_arg_type field_type,
59 const char *field_name,
60 const char *field_value,
61 const char *field_str)
63 const char *handler_name = "define_flag_value";
64 PyObject *handler, *t, *retval;
65 unsigned long long value;
68 if (field_type == PRINT_SYMBOL)
69 handler_name = "define_symbolic_value";
73 Py_FatalError("couldn't create Python tuple");
75 value = eval_flag(field_value);
77 PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
78 PyTuple_SetItem(t, n++, PyString_FromString(field_name));
79 PyTuple_SetItem(t, n++, PyInt_FromLong(value));
80 PyTuple_SetItem(t, n++, PyString_FromString(field_str));
82 handler = PyDict_GetItemString(main_dict, handler_name);
83 if (handler && PyCallable_Check(handler)) {
84 retval = PyObject_CallObject(handler, t);
86 handler_call_die(handler_name);
92 static void define_values(enum print_arg_type field_type,
93 struct print_flag_sym *field,
95 const char *field_name)
97 define_value(field_type, ev_name, field_name, field->value,
101 define_values(field_type, field->next, ev_name, field_name);
104 static void define_field(enum print_arg_type field_type,
106 const char *field_name,
109 const char *handler_name = "define_flag_field";
110 PyObject *handler, *t, *retval;
113 if (field_type == PRINT_SYMBOL)
114 handler_name = "define_symbolic_field";
116 if (field_type == PRINT_FLAGS)
121 Py_FatalError("couldn't create Python tuple");
123 PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
124 PyTuple_SetItem(t, n++, PyString_FromString(field_name));
125 if (field_type == PRINT_FLAGS)
126 PyTuple_SetItem(t, n++, PyString_FromString(delim));
128 handler = PyDict_GetItemString(main_dict, handler_name);
129 if (handler && PyCallable_Check(handler)) {
130 retval = PyObject_CallObject(handler, t);
132 handler_call_die(handler_name);
138 static void define_event_symbols(struct event *event,
140 struct print_arg *args)
142 switch (args->type) {
146 define_value(PRINT_FLAGS, ev_name, cur_field_name, "0",
152 free(cur_field_name);
153 cur_field_name = strdup(args->field.name);
156 define_event_symbols(event, ev_name, args->flags.field);
157 define_field(PRINT_FLAGS, ev_name, cur_field_name,
159 define_values(PRINT_FLAGS, args->flags.flags, ev_name,
163 define_event_symbols(event, ev_name, args->symbol.field);
164 define_field(PRINT_SYMBOL, ev_name, cur_field_name, NULL);
165 define_values(PRINT_SYMBOL, args->symbol.symbols, ev_name,
171 define_event_symbols(event, ev_name, args->typecast.item);
174 if (strcmp(args->op.op, ":") == 0)
176 define_event_symbols(event, ev_name, args->op.left);
177 define_event_symbols(event, ev_name, args->op.right);
180 /* we should warn... */
185 define_event_symbols(event, ev_name, args->next);
188 static inline struct event *find_cache_event(int type)
190 static char ev_name[256];
196 events[type] = event = trace_find_event(type);
200 sprintf(ev_name, "%s__%s", event->system, event->name);
202 define_event_symbols(event, ev_name, event->print_fmt.args);
207 static void python_process_event(int cpu, void *data,
209 unsigned long long nsecs, char *comm)
211 PyObject *handler, *retval, *context, *t;
212 static char handler_name[256];
213 struct format_field *field;
214 unsigned long long val;
221 t = PyTuple_New(MAX_FIELDS);
223 Py_FatalError("couldn't create Python tuple");
225 type = trace_parse_common_type(data);
227 event = find_cache_event(type);
229 die("ug! no event found for type %d", type);
231 pid = trace_parse_common_pid(data);
233 sprintf(handler_name, "%s__%s", event->system, event->name);
235 s = nsecs / NSECS_PER_SEC;
236 ns = nsecs - s * NSECS_PER_SEC;
238 scripting_context->event_data = data;
240 context = PyCObject_FromVoidPtr(scripting_context, NULL);
242 PyTuple_SetItem(t, n++, PyString_FromString(handler_name));
243 PyTuple_SetItem(t, n++,
244 PyCObject_FromVoidPtr(scripting_context, NULL));
245 PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
246 PyTuple_SetItem(t, n++, PyInt_FromLong(s));
247 PyTuple_SetItem(t, n++, PyInt_FromLong(ns));
248 PyTuple_SetItem(t, n++, PyInt_FromLong(pid));
249 PyTuple_SetItem(t, n++, PyString_FromString(comm));
251 for (field = event->format.fields; field; field = field->next) {
252 if (field->flags & FIELD_IS_STRING) {
254 if (field->flags & FIELD_IS_DYNAMIC) {
255 offset = *(int *)(data + field->offset);
258 offset = field->offset;
259 PyTuple_SetItem(t, n++,
260 PyString_FromString((char *)data + offset));
261 } else { /* FIELD_IS_NUMERIC */
262 val = read_size(data + field->offset, field->size);
263 if (field->flags & FIELD_IS_SIGNED) {
264 PyTuple_SetItem(t, n++, PyInt_FromLong(val));
266 PyTuple_SetItem(t, n++, PyInt_FromLong(val));
271 if (_PyTuple_Resize(&t, n) == -1)
272 Py_FatalError("error resizing Python tuple");
274 handler = PyDict_GetItemString(main_dict, handler_name);
275 if (handler && PyCallable_Check(handler)) {
276 retval = PyObject_CallObject(handler, t);
278 handler_call_die(handler_name);
280 handler = PyDict_GetItemString(main_dict, "trace_unhandled");
281 if (handler && PyCallable_Check(handler)) {
282 if (_PyTuple_Resize(&t, N_COMMON_FIELDS) == -1)
283 Py_FatalError("error resizing Python tuple");
285 retval = PyObject_CallObject(handler, t);
287 handler_call_die("trace_unhandled");
294 static int run_start_sub(void)
296 PyObject *handler, *retval;
299 main_module = PyImport_AddModule("__main__");
300 if (main_module == NULL)
302 Py_INCREF(main_module);
304 main_dict = PyModule_GetDict(main_module);
305 if (main_dict == NULL) {
309 Py_INCREF(main_dict);
311 handler = PyDict_GetItemString(main_dict, "trace_begin");
312 if (handler == NULL || !PyCallable_Check(handler))
315 retval = PyObject_CallObject(handler, NULL);
317 handler_call_die("trace_begin");
322 Py_XDECREF(main_dict);
323 Py_XDECREF(main_module);
331 static int python_start_script(const char *script, int argc, const char **argv)
333 const char **command_line;
338 command_line = malloc((argc + 1) * sizeof(const char *));
339 command_line[0] = script;
340 for (i = 1; i < argc + 1; i++)
341 command_line[i] = argv[i - 1];
345 initperf_trace_context();
347 PySys_SetArgv(argc + 1, (char **)command_line);
349 fp = fopen(script, "r");
351 sprintf(buf, "Can't open python script \"%s\"", script);
357 err = PyRun_SimpleFile(fp, script);
359 fprintf(stderr, "Error running python script %s\n", script);
363 err = run_start_sub();
365 fprintf(stderr, "Error starting python script %s\n", script);
370 fprintf(stderr, "perf trace started with Python script %s\n\n",
384 static int python_stop_script(void)
386 PyObject *handler, *retval;
389 handler = PyDict_GetItemString(main_dict, "trace_end");
390 if (handler == NULL || !PyCallable_Check(handler))
393 retval = PyObject_CallObject(handler, NULL);
395 handler_call_die("trace_end");
399 Py_XDECREF(main_dict);
400 Py_XDECREF(main_module);
403 fprintf(stderr, "\nperf trace Python script stopped\n");
408 static int python_generate_script(const char *outfile)
410 struct event *event = NULL;
411 struct format_field *f;
412 char fname[PATH_MAX];
413 int not_first, count;
416 sprintf(fname, "%s.py", outfile);
417 ofp = fopen(fname, "w");
419 fprintf(stderr, "couldn't open %s\n", fname);
422 fprintf(ofp, "# perf trace event handlers, "
423 "generated by perf trace -g python\n");
425 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
426 " License version 2\n\n");
428 fprintf(ofp, "# The common_* event handler fields are the most useful "
429 "fields common to\n");
431 fprintf(ofp, "# all events. They don't necessarily correspond to "
432 "the 'common_*' fields\n");
434 fprintf(ofp, "# in the format files. Those fields not available as "
435 "handler params can\n");
437 fprintf(ofp, "# be retrieved using Python functions of the form "
438 "common_*(context).\n");
440 fprintf(ofp, "# See the perf-trace-python Documentation for the list "
441 "of available functions.\n\n");
443 fprintf(ofp, "import os\n");
444 fprintf(ofp, "import sys\n\n");
446 fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
447 fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
448 fprintf(ofp, "\nfrom perf_trace_context import *\n");
449 fprintf(ofp, "from Core import *\n\n\n");
451 fprintf(ofp, "def trace_begin():\n");
452 fprintf(ofp, "\tprint \"in trace_begin\"\n\n");
454 fprintf(ofp, "def trace_end():\n");
455 fprintf(ofp, "\tprint \"in trace_end\"\n\n");
457 while ((event = trace_find_next_event(event))) {
458 fprintf(ofp, "def %s__%s(", event->system, event->name);
459 fprintf(ofp, "event_name, ");
460 fprintf(ofp, "context, ");
461 fprintf(ofp, "common_cpu,\n");
462 fprintf(ofp, "\tcommon_secs, ");
463 fprintf(ofp, "common_nsecs, ");
464 fprintf(ofp, "common_pid, ");
465 fprintf(ofp, "common_comm,\n\t");
470 for (f = event->format.fields; f; f = f->next) {
473 if (++count % 5 == 0)
474 fprintf(ofp, "\n\t");
476 fprintf(ofp, "%s", f->name);
478 fprintf(ofp, "):\n");
480 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
481 "common_secs, common_nsecs,\n\t\t\t"
482 "common_pid, common_comm)\n\n");
484 fprintf(ofp, "\t\tprint \"");
489 for (f = event->format.fields; f; f = f->next) {
492 if (count && count % 3 == 0) {
493 fprintf(ofp, "\" \\\n\t\t\"");
497 fprintf(ofp, "%s=", f->name);
498 if (f->flags & FIELD_IS_STRING ||
499 f->flags & FIELD_IS_FLAG ||
500 f->flags & FIELD_IS_SYMBOLIC)
502 else if (f->flags & FIELD_IS_SIGNED)
508 fprintf(ofp, "\\n\" %% \\\n\t\t(");
513 for (f = event->format.fields; f; f = f->next) {
517 if (++count % 5 == 0)
518 fprintf(ofp, "\n\t\t");
520 if (f->flags & FIELD_IS_FLAG) {
521 if ((count - 1) % 5 != 0) {
522 fprintf(ofp, "\n\t\t");
525 fprintf(ofp, "flag_str(\"");
526 fprintf(ofp, "%s__%s\", ", event->system,
528 fprintf(ofp, "\"%s\", %s)", f->name,
530 } else if (f->flags & FIELD_IS_SYMBOLIC) {
531 if ((count - 1) % 5 != 0) {
532 fprintf(ofp, "\n\t\t");
535 fprintf(ofp, "symbol_str(\"");
536 fprintf(ofp, "%s__%s\", ", event->system,
538 fprintf(ofp, "\"%s\", %s)", f->name,
541 fprintf(ofp, "%s", f->name);
544 fprintf(ofp, "),\n\n");
547 fprintf(ofp, "def trace_unhandled(event_name, context, "
548 "common_cpu, common_secs, common_nsecs,\n\t\t"
549 "common_pid, common_comm):\n");
551 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
552 "common_secs, common_nsecs,\n\t\tcommon_pid, "
555 fprintf(ofp, "def print_header("
556 "event_name, cpu, secs, nsecs, pid, comm):\n"
557 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
558 "(event_name, cpu, secs, nsecs, pid, comm),\n");
562 fprintf(stderr, "generated Python script: %s\n", fname);
567 struct scripting_ops python_scripting_ops = {
569 .start_script = python_start_script,
570 .stop_script = python_stop_script,
571 .process_event = python_process_event,
572 .generate_script = python_generate_script,