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
, *obj
, *dict
= NULL
;
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 handler
= PyDict_GetItemString(main_dict
, handler_name
);
236 if (handler
&& !PyCallable_Check(handler
))
241 Py_FatalError("couldn't create Python dict");
243 s
= nsecs
/ NSECS_PER_SEC
;
244 ns
= nsecs
- s
* NSECS_PER_SEC
;
246 scripting_context
->event_data
= data
;
248 context
= PyCObject_FromVoidPtr(scripting_context
, NULL
);
250 PyTuple_SetItem(t
, n
++, PyString_FromString(handler_name
));
251 PyTuple_SetItem(t
, n
++, context
);
254 PyTuple_SetItem(t
, n
++, PyInt_FromLong(cpu
));
255 PyTuple_SetItem(t
, n
++, PyInt_FromLong(s
));
256 PyTuple_SetItem(t
, n
++, PyInt_FromLong(ns
));
257 PyTuple_SetItem(t
, n
++, PyInt_FromLong(pid
));
258 PyTuple_SetItem(t
, n
++, PyString_FromString(comm
));
260 PyDict_SetItemString(dict
, "common_cpu", PyInt_FromLong(cpu
));
261 PyDict_SetItemString(dict
, "common_s", PyInt_FromLong(s
));
262 PyDict_SetItemString(dict
, "common_ns", PyInt_FromLong(ns
));
263 PyDict_SetItemString(dict
, "common_pid", PyInt_FromLong(pid
));
264 PyDict_SetItemString(dict
, "common_comm", PyString_FromString(comm
));
266 for (field
= event
->format
.fields
; field
; field
= field
->next
) {
267 if (field
->flags
& FIELD_IS_STRING
) {
269 if (field
->flags
& FIELD_IS_DYNAMIC
) {
270 offset
= *(int *)(data
+ field
->offset
);
273 offset
= field
->offset
;
274 obj
= PyString_FromString((char *)data
+ offset
);
275 } else { /* FIELD_IS_NUMERIC */
276 val
= read_size(data
+ field
->offset
, field
->size
);
277 if (field
->flags
& FIELD_IS_SIGNED
) {
278 if ((long long)val
>= LONG_MIN
&&
279 (long long)val
<= LONG_MAX
)
280 obj
= PyInt_FromLong(val
);
282 obj
= PyLong_FromLongLong(val
);
285 obj
= PyInt_FromLong(val
);
287 obj
= PyLong_FromUnsignedLongLong(val
);
291 PyTuple_SetItem(t
, n
++, obj
);
293 PyDict_SetItemString(dict
, field
->name
, obj
);
297 PyTuple_SetItem(t
, n
++, dict
);
299 if (_PyTuple_Resize(&t
, n
) == -1)
300 Py_FatalError("error resizing Python tuple");
303 retval
= PyObject_CallObject(handler
, t
);
305 handler_call_die(handler_name
);
307 handler
= PyDict_GetItemString(main_dict
, "trace_unhandled");
308 if (handler
&& PyCallable_Check(handler
)) {
310 retval
= PyObject_CallObject(handler
, t
);
312 handler_call_die("trace_unhandled");
320 static int run_start_sub(void)
322 PyObject
*handler
, *retval
;
325 main_module
= PyImport_AddModule("__main__");
326 if (main_module
== NULL
)
328 Py_INCREF(main_module
);
330 main_dict
= PyModule_GetDict(main_module
);
331 if (main_dict
== NULL
) {
335 Py_INCREF(main_dict
);
337 handler
= PyDict_GetItemString(main_dict
, "trace_begin");
338 if (handler
== NULL
|| !PyCallable_Check(handler
))
341 retval
= PyObject_CallObject(handler
, NULL
);
343 handler_call_die("trace_begin");
348 Py_XDECREF(main_dict
);
349 Py_XDECREF(main_module
);
357 static int python_start_script(const char *script
, int argc
, const char **argv
)
359 const char **command_line
;
364 command_line
= malloc((argc
+ 1) * sizeof(const char *));
365 command_line
[0] = script
;
366 for (i
= 1; i
< argc
+ 1; i
++)
367 command_line
[i
] = argv
[i
- 1];
371 initperf_trace_context();
373 PySys_SetArgv(argc
+ 1, (char **)command_line
);
375 fp
= fopen(script
, "r");
377 sprintf(buf
, "Can't open python script \"%s\"", script
);
383 err
= PyRun_SimpleFile(fp
, script
);
385 fprintf(stderr
, "Error running python script %s\n", script
);
389 err
= run_start_sub();
391 fprintf(stderr
, "Error starting python script %s\n", script
);
408 static int python_stop_script(void)
410 PyObject
*handler
, *retval
;
413 handler
= PyDict_GetItemString(main_dict
, "trace_end");
414 if (handler
== NULL
|| !PyCallable_Check(handler
))
417 retval
= PyObject_CallObject(handler
, NULL
);
419 handler_call_die("trace_end");
423 Py_XDECREF(main_dict
);
424 Py_XDECREF(main_module
);
430 static int python_generate_script(const char *outfile
)
432 struct event
*event
= NULL
;
433 struct format_field
*f
;
434 char fname
[PATH_MAX
];
435 int not_first
, count
;
438 sprintf(fname
, "%s.py", outfile
);
439 ofp
= fopen(fname
, "w");
441 fprintf(stderr
, "couldn't open %s\n", fname
);
444 fprintf(ofp
, "# perf script event handlers, "
445 "generated by perf script -g python\n");
447 fprintf(ofp
, "# Licensed under the terms of the GNU GPL"
448 " License version 2\n\n");
450 fprintf(ofp
, "# The common_* event handler fields are the most useful "
451 "fields common to\n");
453 fprintf(ofp
, "# all events. They don't necessarily correspond to "
454 "the 'common_*' fields\n");
456 fprintf(ofp
, "# in the format files. Those fields not available as "
457 "handler params can\n");
459 fprintf(ofp
, "# be retrieved using Python functions of the form "
460 "common_*(context).\n");
462 fprintf(ofp
, "# See the perf-trace-python Documentation for the list "
463 "of available functions.\n\n");
465 fprintf(ofp
, "import os\n");
466 fprintf(ofp
, "import sys\n\n");
468 fprintf(ofp
, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
469 fprintf(ofp
, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
470 fprintf(ofp
, "\nfrom perf_trace_context import *\n");
471 fprintf(ofp
, "from Core import *\n\n\n");
473 fprintf(ofp
, "def trace_begin():\n");
474 fprintf(ofp
, "\tprint \"in trace_begin\"\n\n");
476 fprintf(ofp
, "def trace_end():\n");
477 fprintf(ofp
, "\tprint \"in trace_end\"\n\n");
479 while ((event
= trace_find_next_event(event
))) {
480 fprintf(ofp
, "def %s__%s(", event
->system
, event
->name
);
481 fprintf(ofp
, "event_name, ");
482 fprintf(ofp
, "context, ");
483 fprintf(ofp
, "common_cpu,\n");
484 fprintf(ofp
, "\tcommon_secs, ");
485 fprintf(ofp
, "common_nsecs, ");
486 fprintf(ofp
, "common_pid, ");
487 fprintf(ofp
, "common_comm,\n\t");
492 for (f
= event
->format
.fields
; f
; f
= f
->next
) {
495 if (++count
% 5 == 0)
496 fprintf(ofp
, "\n\t");
498 fprintf(ofp
, "%s", f
->name
);
500 fprintf(ofp
, "):\n");
502 fprintf(ofp
, "\t\tprint_header(event_name, common_cpu, "
503 "common_secs, common_nsecs,\n\t\t\t"
504 "common_pid, common_comm)\n\n");
506 fprintf(ofp
, "\t\tprint \"");
511 for (f
= event
->format
.fields
; f
; f
= f
->next
) {
514 if (count
&& count
% 3 == 0) {
515 fprintf(ofp
, "\" \\\n\t\t\"");
519 fprintf(ofp
, "%s=", f
->name
);
520 if (f
->flags
& FIELD_IS_STRING
||
521 f
->flags
& FIELD_IS_FLAG
||
522 f
->flags
& FIELD_IS_SYMBOLIC
)
524 else if (f
->flags
& FIELD_IS_SIGNED
)
530 fprintf(ofp
, "\\n\" %% \\\n\t\t(");
535 for (f
= event
->format
.fields
; f
; f
= f
->next
) {
539 if (++count
% 5 == 0)
540 fprintf(ofp
, "\n\t\t");
542 if (f
->flags
& FIELD_IS_FLAG
) {
543 if ((count
- 1) % 5 != 0) {
544 fprintf(ofp
, "\n\t\t");
547 fprintf(ofp
, "flag_str(\"");
548 fprintf(ofp
, "%s__%s\", ", event
->system
,
550 fprintf(ofp
, "\"%s\", %s)", f
->name
,
552 } else if (f
->flags
& FIELD_IS_SYMBOLIC
) {
553 if ((count
- 1) % 5 != 0) {
554 fprintf(ofp
, "\n\t\t");
557 fprintf(ofp
, "symbol_str(\"");
558 fprintf(ofp
, "%s__%s\", ", event
->system
,
560 fprintf(ofp
, "\"%s\", %s)", f
->name
,
563 fprintf(ofp
, "%s", f
->name
);
566 fprintf(ofp
, "),\n\n");
569 fprintf(ofp
, "def trace_unhandled(event_name, context, "
570 "event_fields_dict):\n");
572 fprintf(ofp
, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
573 "for k,v in sorted(event_fields_dict.items())])\n\n");
575 fprintf(ofp
, "def print_header("
576 "event_name, cpu, secs, nsecs, pid, comm):\n"
577 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
578 "(event_name, cpu, secs, nsecs, pid, comm),\n");
582 fprintf(stderr
, "generated Python script: %s\n", fname
);
587 struct scripting_ops python_scripting_ops
= {
589 .start_script
= python_start_script
,
590 .stop_script
= python_stop_script
,
591 .process_event
= python_process_event
,
592 .generate_script
= python_generate_script
,