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
29 #include "../../perf.h"
32 #include "../thread.h"
33 #include "../trace-event.h"
35 PyMODINIT_FUNC initperf_trace_context(void);
37 #define FTRACE_MAX_EVENT \
38 ((1 << (sizeof(unsigned short) * 8)) - 1)
40 struct event_format *events[FTRACE_MAX_EVENT];
43 #define N_COMMON_FIELDS 7
45 extern struct scripting_context *scripting_context;
47 static char *cur_field_name;
48 static int zero_flag_atom;
50 static PyObject *main_module, *main_dict;
52 static void handler_call_die(const char *handler_name)
55 Py_FatalError("problem in Python trace event handler");
58 static void define_value(enum print_arg_type field_type,
60 const char *field_name,
61 const char *field_value,
62 const char *field_str)
64 const char *handler_name = "define_flag_value";
65 PyObject *handler, *t, *retval;
66 unsigned long long value;
69 if (field_type == PRINT_SYMBOL)
70 handler_name = "define_symbolic_value";
74 Py_FatalError("couldn't create Python tuple");
76 value = eval_flag(field_value);
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));
83 handler = PyDict_GetItemString(main_dict, handler_name);
84 if (handler && PyCallable_Check(handler)) {
85 retval = PyObject_CallObject(handler, t);
87 handler_call_die(handler_name);
93 static void define_values(enum print_arg_type field_type,
94 struct print_flag_sym *field,
96 const char *field_name)
98 define_value(field_type, ev_name, field_name, field->value,
102 define_values(field_type, field->next, ev_name, field_name);
105 static void define_field(enum print_arg_type field_type,
107 const char *field_name,
110 const char *handler_name = "define_flag_field";
111 PyObject *handler, *t, *retval;
114 if (field_type == PRINT_SYMBOL)
115 handler_name = "define_symbolic_field";
117 if (field_type == PRINT_FLAGS)
122 Py_FatalError("couldn't create Python tuple");
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));
129 handler = PyDict_GetItemString(main_dict, handler_name);
130 if (handler && PyCallable_Check(handler)) {
131 retval = PyObject_CallObject(handler, t);
133 handler_call_die(handler_name);
139 static void define_event_symbols(struct event_format *event,
141 struct print_arg *args)
143 switch (args->type) {
147 define_value(PRINT_FLAGS, ev_name, cur_field_name, "0",
153 free(cur_field_name);
154 cur_field_name = strdup(args->field.name);
157 define_event_symbols(event, ev_name, args->flags.field);
158 define_field(PRINT_FLAGS, ev_name, cur_field_name,
160 define_values(PRINT_FLAGS, args->flags.flags, ev_name,
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,
170 define_event_symbols(event, ev_name, args->hex.field);
171 define_event_symbols(event, ev_name, args->hex.size);
176 define_event_symbols(event, ev_name, args->typecast.item);
179 if (strcmp(args->op.op, ":") == 0)
181 define_event_symbols(event, ev_name, args->op.left);
182 define_event_symbols(event, ev_name, args->op.right);
185 /* gcc warns for these? */
187 case PRINT_DYNAMIC_ARRAY:
189 /* we should warn... */
194 define_event_symbols(event, ev_name, args->next);
198 struct event_format *find_cache_event(struct pevent *pevent, int type)
200 static char ev_name[256];
201 struct event_format *event;
206 events[type] = event = pevent_find_event(pevent, type);
210 sprintf(ev_name, "%s__%s", event->system, event->name);
212 define_event_symbols(event, ev_name, event->print_fmt.args);
217 static void python_process_event(union perf_event *perf_event __unused,
218 struct pevent *pevent,
219 struct perf_sample *sample,
220 struct perf_evsel *evsel __unused,
221 struct machine *machine __unused,
222 struct thread *thread)
224 PyObject *handler, *retval, *context, *t, *obj, *dict = NULL;
225 static char handler_name[256];
226 struct format_field *field;
227 unsigned long long val;
229 struct event_format *event;
233 int cpu = sample->cpu;
234 void *data = sample->raw_data;
235 unsigned long long nsecs = sample->time;
236 char *comm = thread->comm;
238 t = PyTuple_New(MAX_FIELDS);
240 Py_FatalError("couldn't create Python tuple");
242 type = trace_parse_common_type(pevent, data);
244 event = find_cache_event(pevent, type);
246 die("ug! no event found for type %d", type);
248 pid = trace_parse_common_pid(pevent, data);
250 sprintf(handler_name, "%s__%s", event->system, event->name);
252 handler = PyDict_GetItemString(main_dict, handler_name);
253 if (handler && !PyCallable_Check(handler))
258 Py_FatalError("couldn't create Python dict");
260 s = nsecs / NSECS_PER_SEC;
261 ns = nsecs - s * NSECS_PER_SEC;
263 scripting_context->event_data = data;
265 context = PyCObject_FromVoidPtr(scripting_context, NULL);
267 PyTuple_SetItem(t, n++, PyString_FromString(handler_name));
268 PyTuple_SetItem(t, n++, context);
271 PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
272 PyTuple_SetItem(t, n++, PyInt_FromLong(s));
273 PyTuple_SetItem(t, n++, PyInt_FromLong(ns));
274 PyTuple_SetItem(t, n++, PyInt_FromLong(pid));
275 PyTuple_SetItem(t, n++, PyString_FromString(comm));
277 PyDict_SetItemString(dict, "common_cpu", PyInt_FromLong(cpu));
278 PyDict_SetItemString(dict, "common_s", PyInt_FromLong(s));
279 PyDict_SetItemString(dict, "common_ns", PyInt_FromLong(ns));
280 PyDict_SetItemString(dict, "common_pid", PyInt_FromLong(pid));
281 PyDict_SetItemString(dict, "common_comm", PyString_FromString(comm));
283 for (field = event->format.fields; field; field = field->next) {
284 if (field->flags & FIELD_IS_STRING) {
286 if (field->flags & FIELD_IS_DYNAMIC) {
287 offset = *(int *)(data + field->offset);
290 offset = field->offset;
291 obj = PyString_FromString((char *)data + offset);
292 } else { /* FIELD_IS_NUMERIC */
293 val = read_size(pevent, data + field->offset,
295 if (field->flags & FIELD_IS_SIGNED) {
296 if ((long long)val >= LONG_MIN &&
297 (long long)val <= LONG_MAX)
298 obj = PyInt_FromLong(val);
300 obj = PyLong_FromLongLong(val);
303 obj = PyInt_FromLong(val);
305 obj = PyLong_FromUnsignedLongLong(val);
309 PyTuple_SetItem(t, n++, obj);
311 PyDict_SetItemString(dict, field->name, obj);
315 PyTuple_SetItem(t, n++, dict);
317 if (_PyTuple_Resize(&t, n) == -1)
318 Py_FatalError("error resizing Python tuple");
321 retval = PyObject_CallObject(handler, t);
323 handler_call_die(handler_name);
325 handler = PyDict_GetItemString(main_dict, "trace_unhandled");
326 if (handler && PyCallable_Check(handler)) {
328 retval = PyObject_CallObject(handler, t);
330 handler_call_die("trace_unhandled");
338 static int run_start_sub(void)
340 PyObject *handler, *retval;
343 main_module = PyImport_AddModule("__main__");
344 if (main_module == NULL)
346 Py_INCREF(main_module);
348 main_dict = PyModule_GetDict(main_module);
349 if (main_dict == NULL) {
353 Py_INCREF(main_dict);
355 handler = PyDict_GetItemString(main_dict, "trace_begin");
356 if (handler == NULL || !PyCallable_Check(handler))
359 retval = PyObject_CallObject(handler, NULL);
361 handler_call_die("trace_begin");
366 Py_XDECREF(main_dict);
367 Py_XDECREF(main_module);
375 static int python_start_script(const char *script, int argc, const char **argv)
377 const char **command_line;
382 command_line = malloc((argc + 1) * sizeof(const char *));
383 command_line[0] = script;
384 for (i = 1; i < argc + 1; i++)
385 command_line[i] = argv[i - 1];
389 initperf_trace_context();
391 PySys_SetArgv(argc + 1, (char **)command_line);
393 fp = fopen(script, "r");
395 sprintf(buf, "Can't open python script \"%s\"", script);
401 err = PyRun_SimpleFile(fp, script);
403 fprintf(stderr, "Error running python script %s\n", script);
407 err = run_start_sub();
409 fprintf(stderr, "Error starting python script %s\n", script);
426 static int python_stop_script(void)
428 PyObject *handler, *retval;
431 handler = PyDict_GetItemString(main_dict, "trace_end");
432 if (handler == NULL || !PyCallable_Check(handler))
435 retval = PyObject_CallObject(handler, NULL);
437 handler_call_die("trace_end");
441 Py_XDECREF(main_dict);
442 Py_XDECREF(main_module);
448 static int python_generate_script(struct pevent *pevent, const char *outfile)
450 struct event_format *event = NULL;
451 struct format_field *f;
452 char fname[PATH_MAX];
453 int not_first, count;
456 sprintf(fname, "%s.py", outfile);
457 ofp = fopen(fname, "w");
459 fprintf(stderr, "couldn't open %s\n", fname);
462 fprintf(ofp, "# perf script event handlers, "
463 "generated by perf script -g python\n");
465 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
466 " License version 2\n\n");
468 fprintf(ofp, "# The common_* event handler fields are the most useful "
469 "fields common to\n");
471 fprintf(ofp, "# all events. They don't necessarily correspond to "
472 "the 'common_*' fields\n");
474 fprintf(ofp, "# in the format files. Those fields not available as "
475 "handler params can\n");
477 fprintf(ofp, "# be retrieved using Python functions of the form "
478 "common_*(context).\n");
480 fprintf(ofp, "# See the perf-trace-python Documentation for the list "
481 "of available functions.\n\n");
483 fprintf(ofp, "import os\n");
484 fprintf(ofp, "import sys\n\n");
486 fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
487 fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
488 fprintf(ofp, "\nfrom perf_trace_context import *\n");
489 fprintf(ofp, "from Core import *\n\n\n");
491 fprintf(ofp, "def trace_begin():\n");
492 fprintf(ofp, "\tprint \"in trace_begin\"\n\n");
494 fprintf(ofp, "def trace_end():\n");
495 fprintf(ofp, "\tprint \"in trace_end\"\n\n");
497 while ((event = trace_find_next_event(pevent, event))) {
498 fprintf(ofp, "def %s__%s(", event->system, event->name);
499 fprintf(ofp, "event_name, ");
500 fprintf(ofp, "context, ");
501 fprintf(ofp, "common_cpu,\n");
502 fprintf(ofp, "\tcommon_secs, ");
503 fprintf(ofp, "common_nsecs, ");
504 fprintf(ofp, "common_pid, ");
505 fprintf(ofp, "common_comm,\n\t");
510 for (f = event->format.fields; f; f = f->next) {
513 if (++count % 5 == 0)
514 fprintf(ofp, "\n\t");
516 fprintf(ofp, "%s", f->name);
518 fprintf(ofp, "):\n");
520 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
521 "common_secs, common_nsecs,\n\t\t\t"
522 "common_pid, common_comm)\n\n");
524 fprintf(ofp, "\t\tprint \"");
529 for (f = event->format.fields; f; f = f->next) {
532 if (count && count % 3 == 0) {
533 fprintf(ofp, "\" \\\n\t\t\"");
537 fprintf(ofp, "%s=", f->name);
538 if (f->flags & FIELD_IS_STRING ||
539 f->flags & FIELD_IS_FLAG ||
540 f->flags & FIELD_IS_SYMBOLIC)
542 else if (f->flags & FIELD_IS_SIGNED)
548 fprintf(ofp, "\\n\" %% \\\n\t\t(");
553 for (f = event->format.fields; f; f = f->next) {
557 if (++count % 5 == 0)
558 fprintf(ofp, "\n\t\t");
560 if (f->flags & FIELD_IS_FLAG) {
561 if ((count - 1) % 5 != 0) {
562 fprintf(ofp, "\n\t\t");
565 fprintf(ofp, "flag_str(\"");
566 fprintf(ofp, "%s__%s\", ", event->system,
568 fprintf(ofp, "\"%s\", %s)", f->name,
570 } else if (f->flags & FIELD_IS_SYMBOLIC) {
571 if ((count - 1) % 5 != 0) {
572 fprintf(ofp, "\n\t\t");
575 fprintf(ofp, "symbol_str(\"");
576 fprintf(ofp, "%s__%s\", ", event->system,
578 fprintf(ofp, "\"%s\", %s)", f->name,
581 fprintf(ofp, "%s", f->name);
584 fprintf(ofp, "),\n\n");
587 fprintf(ofp, "def trace_unhandled(event_name, context, "
588 "event_fields_dict):\n");
590 fprintf(ofp, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
591 "for k,v in sorted(event_fields_dict.items())])\n\n");
593 fprintf(ofp, "def print_header("
594 "event_name, cpu, secs, nsecs, pid, comm):\n"
595 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
596 "(event_name, cpu, secs, nsecs, pid, comm),\n");
600 fprintf(stderr, "generated Python script: %s\n", fname);
605 struct scripting_ops python_scripting_ops = {
607 .start_script = python_start_script,
608 .stop_script = python_stop_script,
609 .process_event = python_process_event,
610 .generate_script = python_generate_script,