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"
33 #include "../thread.h"
34 #include "../trace-event.h"
36 PyMODINIT_FUNC initperf_trace_context(void);
38 #define FTRACE_MAX_EVENT \
39 ((1 << (sizeof(unsigned short) * 8)) - 1)
41 struct event_format *events[FTRACE_MAX_EVENT];
44 #define N_COMMON_FIELDS 7
46 extern struct scripting_context *scripting_context;
48 static char *cur_field_name;
49 static int zero_flag_atom;
51 static PyObject *main_module, *main_dict;
53 static void handler_call_die(const char *handler_name)
56 Py_FatalError("problem in Python trace event handler");
60 * Insert val into into the dictionary and decrement the reference counter.
61 * This is necessary for dictionaries since PyDict_SetItemString() does not
62 * steal a reference, as opposed to PyTuple_SetItem().
64 static void pydict_set_item_string_decref(PyObject *dict, const char *key, PyObject *val)
66 PyDict_SetItemString(dict, key, val);
70 static void define_value(enum print_arg_type field_type,
72 const char *field_name,
73 const char *field_value,
74 const char *field_str)
76 const char *handler_name = "define_flag_value";
77 PyObject *handler, *t, *retval;
78 unsigned long long value;
81 if (field_type == PRINT_SYMBOL)
82 handler_name = "define_symbolic_value";
86 Py_FatalError("couldn't create Python tuple");
88 value = eval_flag(field_value);
90 PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
91 PyTuple_SetItem(t, n++, PyString_FromString(field_name));
92 PyTuple_SetItem(t, n++, PyInt_FromLong(value));
93 PyTuple_SetItem(t, n++, PyString_FromString(field_str));
95 handler = PyDict_GetItemString(main_dict, handler_name);
96 if (handler && PyCallable_Check(handler)) {
97 retval = PyObject_CallObject(handler, t);
99 handler_call_die(handler_name);
105 static void define_values(enum print_arg_type field_type,
106 struct print_flag_sym *field,
108 const char *field_name)
110 define_value(field_type, ev_name, field_name, field->value,
114 define_values(field_type, field->next, ev_name, field_name);
117 static void define_field(enum print_arg_type field_type,
119 const char *field_name,
122 const char *handler_name = "define_flag_field";
123 PyObject *handler, *t, *retval;
126 if (field_type == PRINT_SYMBOL)
127 handler_name = "define_symbolic_field";
129 if (field_type == PRINT_FLAGS)
134 Py_FatalError("couldn't create Python tuple");
136 PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
137 PyTuple_SetItem(t, n++, PyString_FromString(field_name));
138 if (field_type == PRINT_FLAGS)
139 PyTuple_SetItem(t, n++, PyString_FromString(delim));
141 handler = PyDict_GetItemString(main_dict, handler_name);
142 if (handler && PyCallable_Check(handler)) {
143 retval = PyObject_CallObject(handler, t);
145 handler_call_die(handler_name);
151 static void define_event_symbols(struct event_format *event,
153 struct print_arg *args)
155 switch (args->type) {
159 define_value(PRINT_FLAGS, ev_name, cur_field_name, "0",
164 free(cur_field_name);
165 cur_field_name = strdup(args->field.name);
168 define_event_symbols(event, ev_name, args->flags.field);
169 define_field(PRINT_FLAGS, ev_name, cur_field_name,
171 define_values(PRINT_FLAGS, args->flags.flags, ev_name,
175 define_event_symbols(event, ev_name, args->symbol.field);
176 define_field(PRINT_SYMBOL, ev_name, cur_field_name, NULL);
177 define_values(PRINT_SYMBOL, args->symbol.symbols, ev_name,
181 define_event_symbols(event, ev_name, args->hex.field);
182 define_event_symbols(event, ev_name, args->hex.size);
187 define_event_symbols(event, ev_name, args->typecast.item);
190 if (strcmp(args->op.op, ":") == 0)
192 define_event_symbols(event, ev_name, args->op.left);
193 define_event_symbols(event, ev_name, args->op.right);
196 /* gcc warns for these? */
198 case PRINT_DYNAMIC_ARRAY:
201 /* we should warn... */
206 define_event_symbols(event, ev_name, args->next);
209 static inline struct event_format *find_cache_event(struct perf_evsel *evsel)
211 static char ev_name[256];
212 struct event_format *event;
213 int type = evsel->attr.config;
216 * XXX: Do we really need to cache this since now we have evsel->tp_format
217 * cached already? Need to re-read this "cache" routine that as well calls
218 * define_event_symbols() :-\
223 events[type] = event = evsel->tp_format;
227 sprintf(ev_name, "%s__%s", event->system, event->name);
229 define_event_symbols(event, ev_name, event->print_fmt.args);
234 static void python_process_tracepoint(struct perf_sample *sample,
235 struct perf_evsel *evsel,
236 struct thread *thread,
237 struct addr_location *al)
239 PyObject *handler, *retval, *context, *t, *obj, *dict = NULL;
240 static char handler_name[256];
241 struct format_field *field;
242 unsigned long long val;
244 struct event_format *event;
247 int cpu = sample->cpu;
248 void *data = sample->raw_data;
249 unsigned long long nsecs = sample->time;
250 const char *comm = thread__comm_str(thread);
252 t = PyTuple_New(MAX_FIELDS);
254 Py_FatalError("couldn't create Python tuple");
256 event = find_cache_event(evsel);
258 die("ug! no event found for type %d", (int)evsel->attr.config);
260 pid = raw_field_value(event, "common_pid", data);
262 sprintf(handler_name, "%s__%s", event->system, event->name);
264 handler = PyDict_GetItemString(main_dict, handler_name);
265 if (handler && !PyCallable_Check(handler))
270 Py_FatalError("couldn't create Python dict");
272 s = nsecs / NSECS_PER_SEC;
273 ns = nsecs - s * NSECS_PER_SEC;
275 scripting_context->event_data = data;
276 scripting_context->pevent = evsel->tp_format->pevent;
278 context = PyCObject_FromVoidPtr(scripting_context, NULL);
280 PyTuple_SetItem(t, n++, PyString_FromString(handler_name));
281 PyTuple_SetItem(t, n++, context);
284 PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
285 PyTuple_SetItem(t, n++, PyInt_FromLong(s));
286 PyTuple_SetItem(t, n++, PyInt_FromLong(ns));
287 PyTuple_SetItem(t, n++, PyInt_FromLong(pid));
288 PyTuple_SetItem(t, n++, PyString_FromString(comm));
290 pydict_set_item_string_decref(dict, "common_cpu", PyInt_FromLong(cpu));
291 pydict_set_item_string_decref(dict, "common_s", PyInt_FromLong(s));
292 pydict_set_item_string_decref(dict, "common_ns", PyInt_FromLong(ns));
293 pydict_set_item_string_decref(dict, "common_pid", PyInt_FromLong(pid));
294 pydict_set_item_string_decref(dict, "common_comm", PyString_FromString(comm));
296 for (field = event->format.fields; field; field = field->next) {
297 if (field->flags & FIELD_IS_STRING) {
299 if (field->flags & FIELD_IS_DYNAMIC) {
300 offset = *(int *)(data + field->offset);
303 offset = field->offset;
304 obj = PyString_FromString((char *)data + offset);
305 } else { /* FIELD_IS_NUMERIC */
306 val = read_size(event, data + field->offset,
308 if (field->flags & FIELD_IS_SIGNED) {
309 if ((long long)val >= LONG_MIN &&
310 (long long)val <= LONG_MAX)
311 obj = PyInt_FromLong(val);
313 obj = PyLong_FromLongLong(val);
316 obj = PyInt_FromLong(val);
318 obj = PyLong_FromUnsignedLongLong(val);
322 PyTuple_SetItem(t, n++, obj);
324 pydict_set_item_string_decref(dict, field->name, obj);
328 PyTuple_SetItem(t, n++, dict);
330 if (_PyTuple_Resize(&t, n) == -1)
331 Py_FatalError("error resizing Python tuple");
334 retval = PyObject_CallObject(handler, t);
336 handler_call_die(handler_name);
338 handler = PyDict_GetItemString(main_dict, "trace_unhandled");
339 if (handler && PyCallable_Check(handler)) {
341 retval = PyObject_CallObject(handler, t);
343 handler_call_die("trace_unhandled");
351 static void python_process_general_event(struct perf_sample *sample,
352 struct perf_evsel *evsel,
353 struct thread *thread,
354 struct addr_location *al)
356 PyObject *handler, *retval, *t, *dict;
357 static char handler_name[64];
361 * Use the MAX_FIELDS to make the function expandable, though
362 * currently there is only one item for the tuple.
364 t = PyTuple_New(MAX_FIELDS);
366 Py_FatalError("couldn't create Python tuple");
370 Py_FatalError("couldn't create Python dictionary");
372 snprintf(handler_name, sizeof(handler_name), "%s", "process_event");
374 handler = PyDict_GetItemString(main_dict, handler_name);
375 if (!handler || !PyCallable_Check(handler))
378 pydict_set_item_string_decref(dict, "ev_name", PyString_FromString(perf_evsel__name(evsel)));
379 pydict_set_item_string_decref(dict, "attr", PyString_FromStringAndSize(
380 (const char *)&evsel->attr, sizeof(evsel->attr)));
381 pydict_set_item_string_decref(dict, "sample", PyString_FromStringAndSize(
382 (const char *)sample, sizeof(*sample)));
383 pydict_set_item_string_decref(dict, "raw_buf", PyString_FromStringAndSize(
384 (const char *)sample->raw_data, sample->raw_size));
385 pydict_set_item_string_decref(dict, "comm",
386 PyString_FromString(thread__comm_str(thread)));
388 pydict_set_item_string_decref(dict, "dso",
389 PyString_FromString(al->map->dso->name));
392 pydict_set_item_string_decref(dict, "symbol",
393 PyString_FromString(al->sym->name));
396 PyTuple_SetItem(t, n++, dict);
397 if (_PyTuple_Resize(&t, n) == -1)
398 Py_FatalError("error resizing Python tuple");
400 retval = PyObject_CallObject(handler, t);
402 handler_call_die(handler_name);
408 static void python_process_event(union perf_event *event __maybe_unused,
409 struct perf_sample *sample,
410 struct perf_evsel *evsel,
411 struct thread *thread,
412 struct addr_location *al)
414 switch (evsel->attr.type) {
415 case PERF_TYPE_TRACEPOINT:
416 python_process_tracepoint(sample, evsel, thread, al);
418 /* Reserve for future process_hw/sw/raw APIs */
420 python_process_general_event(sample, evsel, thread, al);
424 static int run_start_sub(void)
426 PyObject *handler, *retval;
429 main_module = PyImport_AddModule("__main__");
430 if (main_module == NULL)
432 Py_INCREF(main_module);
434 main_dict = PyModule_GetDict(main_module);
435 if (main_dict == NULL) {
439 Py_INCREF(main_dict);
441 handler = PyDict_GetItemString(main_dict, "trace_begin");
442 if (handler == NULL || !PyCallable_Check(handler))
445 retval = PyObject_CallObject(handler, NULL);
447 handler_call_die("trace_begin");
452 Py_XDECREF(main_dict);
453 Py_XDECREF(main_module);
461 static int python_start_script(const char *script, int argc, const char **argv)
463 const char **command_line;
468 command_line = malloc((argc + 1) * sizeof(const char *));
469 command_line[0] = script;
470 for (i = 1; i < argc + 1; i++)
471 command_line[i] = argv[i - 1];
475 initperf_trace_context();
477 PySys_SetArgv(argc + 1, (char **)command_line);
479 fp = fopen(script, "r");
481 sprintf(buf, "Can't open python script \"%s\"", script);
487 err = PyRun_SimpleFile(fp, script);
489 fprintf(stderr, "Error running python script %s\n", script);
493 err = run_start_sub();
495 fprintf(stderr, "Error starting python script %s\n", script);
512 static int python_stop_script(void)
514 PyObject *handler, *retval;
517 handler = PyDict_GetItemString(main_dict, "trace_end");
518 if (handler == NULL || !PyCallable_Check(handler))
521 retval = PyObject_CallObject(handler, NULL);
523 handler_call_die("trace_end");
527 Py_XDECREF(main_dict);
528 Py_XDECREF(main_module);
534 static int python_generate_script(struct pevent *pevent, const char *outfile)
536 struct event_format *event = NULL;
537 struct format_field *f;
538 char fname[PATH_MAX];
539 int not_first, count;
542 sprintf(fname, "%s.py", outfile);
543 ofp = fopen(fname, "w");
545 fprintf(stderr, "couldn't open %s\n", fname);
548 fprintf(ofp, "# perf script event handlers, "
549 "generated by perf script -g python\n");
551 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
552 " License version 2\n\n");
554 fprintf(ofp, "# The common_* event handler fields are the most useful "
555 "fields common to\n");
557 fprintf(ofp, "# all events. They don't necessarily correspond to "
558 "the 'common_*' fields\n");
560 fprintf(ofp, "# in the format files. Those fields not available as "
561 "handler params can\n");
563 fprintf(ofp, "# be retrieved using Python functions of the form "
564 "common_*(context).\n");
566 fprintf(ofp, "# See the perf-trace-python Documentation for the list "
567 "of available functions.\n\n");
569 fprintf(ofp, "import os\n");
570 fprintf(ofp, "import sys\n\n");
572 fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
573 fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
574 fprintf(ofp, "\nfrom perf_trace_context import *\n");
575 fprintf(ofp, "from Core import *\n\n\n");
577 fprintf(ofp, "def trace_begin():\n");
578 fprintf(ofp, "\tprint \"in trace_begin\"\n\n");
580 fprintf(ofp, "def trace_end():\n");
581 fprintf(ofp, "\tprint \"in trace_end\"\n\n");
583 while ((event = trace_find_next_event(pevent, event))) {
584 fprintf(ofp, "def %s__%s(", event->system, event->name);
585 fprintf(ofp, "event_name, ");
586 fprintf(ofp, "context, ");
587 fprintf(ofp, "common_cpu,\n");
588 fprintf(ofp, "\tcommon_secs, ");
589 fprintf(ofp, "common_nsecs, ");
590 fprintf(ofp, "common_pid, ");
591 fprintf(ofp, "common_comm,\n\t");
596 for (f = event->format.fields; f; f = f->next) {
599 if (++count % 5 == 0)
600 fprintf(ofp, "\n\t");
602 fprintf(ofp, "%s", f->name);
604 fprintf(ofp, "):\n");
606 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
607 "common_secs, common_nsecs,\n\t\t\t"
608 "common_pid, common_comm)\n\n");
610 fprintf(ofp, "\t\tprint \"");
615 for (f = event->format.fields; f; f = f->next) {
618 if (count && count % 3 == 0) {
619 fprintf(ofp, "\" \\\n\t\t\"");
623 fprintf(ofp, "%s=", f->name);
624 if (f->flags & FIELD_IS_STRING ||
625 f->flags & FIELD_IS_FLAG ||
626 f->flags & FIELD_IS_ARRAY ||
627 f->flags & FIELD_IS_SYMBOLIC)
629 else if (f->flags & FIELD_IS_SIGNED)
635 fprintf(ofp, "\\n\" %% \\\n\t\t(");
640 for (f = event->format.fields; f; f = f->next) {
644 if (++count % 5 == 0)
645 fprintf(ofp, "\n\t\t");
647 if (f->flags & FIELD_IS_FLAG) {
648 if ((count - 1) % 5 != 0) {
649 fprintf(ofp, "\n\t\t");
652 fprintf(ofp, "flag_str(\"");
653 fprintf(ofp, "%s__%s\", ", event->system,
655 fprintf(ofp, "\"%s\", %s)", f->name,
657 } else if (f->flags & FIELD_IS_SYMBOLIC) {
658 if ((count - 1) % 5 != 0) {
659 fprintf(ofp, "\n\t\t");
662 fprintf(ofp, "symbol_str(\"");
663 fprintf(ofp, "%s__%s\", ", event->system,
665 fprintf(ofp, "\"%s\", %s)", f->name,
668 fprintf(ofp, "%s", f->name);
671 fprintf(ofp, "),\n\n");
674 fprintf(ofp, "def trace_unhandled(event_name, context, "
675 "event_fields_dict):\n");
677 fprintf(ofp, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
678 "for k,v in sorted(event_fields_dict.items())])\n\n");
680 fprintf(ofp, "def print_header("
681 "event_name, cpu, secs, nsecs, pid, comm):\n"
682 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
683 "(event_name, cpu, secs, nsecs, pid, comm),\n");
687 fprintf(stderr, "generated Python script: %s\n", fname);
692 struct scripting_ops python_scripting_ops = {
694 .start_script = python_start_script,
695 .stop_script = python_stop_script,
696 .process_event = python_process_event,
697 .generate_script = python_generate_script,