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 PyObject *get_field_numeric_entry(struct event_format *event,
235 struct format_field *field, void *data)
238 unsigned long long val;
240 val = read_size(event, data + field->offset, field->size);
241 if (field->flags & FIELD_IS_SIGNED) {
242 if ((long long)val >= LONG_MIN &&
243 (long long)val <= LONG_MAX)
244 obj = PyInt_FromLong(val);
246 obj = PyLong_FromLongLong(val);
249 obj = PyInt_FromLong(val);
251 obj = PyLong_FromUnsignedLongLong(val);
256 static void python_process_tracepoint(struct perf_sample *sample,
257 struct perf_evsel *evsel,
258 struct thread *thread,
259 struct addr_location *al)
261 PyObject *handler, *retval, *context, *t, *obj, *dict = NULL;
262 static char handler_name[256];
263 struct format_field *field;
265 struct event_format *event;
268 int cpu = sample->cpu;
269 void *data = sample->raw_data;
270 unsigned long long nsecs = sample->time;
271 const char *comm = thread__comm_str(thread);
273 t = PyTuple_New(MAX_FIELDS);
275 Py_FatalError("couldn't create Python tuple");
277 event = find_cache_event(evsel);
279 die("ug! no event found for type %d", (int)evsel->attr.config);
281 pid = raw_field_value(event, "common_pid", data);
283 sprintf(handler_name, "%s__%s", event->system, event->name);
285 handler = PyDict_GetItemString(main_dict, handler_name);
286 if (handler && !PyCallable_Check(handler))
291 Py_FatalError("couldn't create Python dict");
293 s = nsecs / NSECS_PER_SEC;
294 ns = nsecs - s * NSECS_PER_SEC;
296 scripting_context->event_data = data;
297 scripting_context->pevent = evsel->tp_format->pevent;
299 context = PyCObject_FromVoidPtr(scripting_context, NULL);
301 PyTuple_SetItem(t, n++, PyString_FromString(handler_name));
302 PyTuple_SetItem(t, n++, context);
305 PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
306 PyTuple_SetItem(t, n++, PyInt_FromLong(s));
307 PyTuple_SetItem(t, n++, PyInt_FromLong(ns));
308 PyTuple_SetItem(t, n++, PyInt_FromLong(pid));
309 PyTuple_SetItem(t, n++, PyString_FromString(comm));
311 pydict_set_item_string_decref(dict, "common_cpu", PyInt_FromLong(cpu));
312 pydict_set_item_string_decref(dict, "common_s", PyInt_FromLong(s));
313 pydict_set_item_string_decref(dict, "common_ns", PyInt_FromLong(ns));
314 pydict_set_item_string_decref(dict, "common_pid", PyInt_FromLong(pid));
315 pydict_set_item_string_decref(dict, "common_comm", PyString_FromString(comm));
317 for (field = event->format.fields; field; field = field->next) {
318 if (field->flags & FIELD_IS_STRING) {
320 if (field->flags & FIELD_IS_DYNAMIC) {
321 offset = *(int *)(data + field->offset);
324 offset = field->offset;
325 obj = PyString_FromString((char *)data + offset);
326 } else { /* FIELD_IS_NUMERIC */
327 obj = get_field_numeric_entry(event, field, data);
330 PyTuple_SetItem(t, n++, obj);
332 pydict_set_item_string_decref(dict, field->name, obj);
336 PyTuple_SetItem(t, n++, dict);
338 if (_PyTuple_Resize(&t, n) == -1)
339 Py_FatalError("error resizing Python tuple");
342 retval = PyObject_CallObject(handler, t);
344 handler_call_die(handler_name);
346 handler = PyDict_GetItemString(main_dict, "trace_unhandled");
347 if (handler && PyCallable_Check(handler)) {
349 retval = PyObject_CallObject(handler, t);
351 handler_call_die("trace_unhandled");
359 static void python_process_general_event(struct perf_sample *sample,
360 struct perf_evsel *evsel,
361 struct thread *thread,
362 struct addr_location *al)
364 PyObject *handler, *retval, *t, *dict;
365 static char handler_name[64];
369 * Use the MAX_FIELDS to make the function expandable, though
370 * currently there is only one item for the tuple.
372 t = PyTuple_New(MAX_FIELDS);
374 Py_FatalError("couldn't create Python tuple");
378 Py_FatalError("couldn't create Python dictionary");
380 snprintf(handler_name, sizeof(handler_name), "%s", "process_event");
382 handler = PyDict_GetItemString(main_dict, handler_name);
383 if (!handler || !PyCallable_Check(handler))
386 pydict_set_item_string_decref(dict, "ev_name", PyString_FromString(perf_evsel__name(evsel)));
387 pydict_set_item_string_decref(dict, "attr", PyString_FromStringAndSize(
388 (const char *)&evsel->attr, sizeof(evsel->attr)));
389 pydict_set_item_string_decref(dict, "sample", PyString_FromStringAndSize(
390 (const char *)sample, sizeof(*sample)));
391 pydict_set_item_string_decref(dict, "raw_buf", PyString_FromStringAndSize(
392 (const char *)sample->raw_data, sample->raw_size));
393 pydict_set_item_string_decref(dict, "comm",
394 PyString_FromString(thread__comm_str(thread)));
396 pydict_set_item_string_decref(dict, "dso",
397 PyString_FromString(al->map->dso->name));
400 pydict_set_item_string_decref(dict, "symbol",
401 PyString_FromString(al->sym->name));
404 PyTuple_SetItem(t, n++, dict);
405 if (_PyTuple_Resize(&t, n) == -1)
406 Py_FatalError("error resizing Python tuple");
408 retval = PyObject_CallObject(handler, t);
410 handler_call_die(handler_name);
416 static void python_process_event(union perf_event *event __maybe_unused,
417 struct perf_sample *sample,
418 struct perf_evsel *evsel,
419 struct thread *thread,
420 struct addr_location *al)
422 switch (evsel->attr.type) {
423 case PERF_TYPE_TRACEPOINT:
424 python_process_tracepoint(sample, evsel, thread, al);
426 /* Reserve for future process_hw/sw/raw APIs */
428 python_process_general_event(sample, evsel, thread, al);
432 static int run_start_sub(void)
434 PyObject *handler, *retval;
437 main_module = PyImport_AddModule("__main__");
438 if (main_module == NULL)
440 Py_INCREF(main_module);
442 main_dict = PyModule_GetDict(main_module);
443 if (main_dict == NULL) {
447 Py_INCREF(main_dict);
449 handler = PyDict_GetItemString(main_dict, "trace_begin");
450 if (handler == NULL || !PyCallable_Check(handler))
453 retval = PyObject_CallObject(handler, NULL);
455 handler_call_die("trace_begin");
460 Py_XDECREF(main_dict);
461 Py_XDECREF(main_module);
469 static int python_start_script(const char *script, int argc, const char **argv)
471 const char **command_line;
476 command_line = malloc((argc + 1) * sizeof(const char *));
477 command_line[0] = script;
478 for (i = 1; i < argc + 1; i++)
479 command_line[i] = argv[i - 1];
483 initperf_trace_context();
485 PySys_SetArgv(argc + 1, (char **)command_line);
487 fp = fopen(script, "r");
489 sprintf(buf, "Can't open python script \"%s\"", script);
495 err = PyRun_SimpleFile(fp, script);
497 fprintf(stderr, "Error running python script %s\n", script);
501 err = run_start_sub();
503 fprintf(stderr, "Error starting python script %s\n", script);
520 static int python_stop_script(void)
522 PyObject *handler, *retval;
525 handler = PyDict_GetItemString(main_dict, "trace_end");
526 if (handler == NULL || !PyCallable_Check(handler))
529 retval = PyObject_CallObject(handler, NULL);
531 handler_call_die("trace_end");
535 Py_XDECREF(main_dict);
536 Py_XDECREF(main_module);
542 static int python_generate_script(struct pevent *pevent, const char *outfile)
544 struct event_format *event = NULL;
545 struct format_field *f;
546 char fname[PATH_MAX];
547 int not_first, count;
550 sprintf(fname, "%s.py", outfile);
551 ofp = fopen(fname, "w");
553 fprintf(stderr, "couldn't open %s\n", fname);
556 fprintf(ofp, "# perf script event handlers, "
557 "generated by perf script -g python\n");
559 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
560 " License version 2\n\n");
562 fprintf(ofp, "# The common_* event handler fields are the most useful "
563 "fields common to\n");
565 fprintf(ofp, "# all events. They don't necessarily correspond to "
566 "the 'common_*' fields\n");
568 fprintf(ofp, "# in the format files. Those fields not available as "
569 "handler params can\n");
571 fprintf(ofp, "# be retrieved using Python functions of the form "
572 "common_*(context).\n");
574 fprintf(ofp, "# See the perf-trace-python Documentation for the list "
575 "of available functions.\n\n");
577 fprintf(ofp, "import os\n");
578 fprintf(ofp, "import sys\n\n");
580 fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
581 fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
582 fprintf(ofp, "\nfrom perf_trace_context import *\n");
583 fprintf(ofp, "from Core import *\n\n\n");
585 fprintf(ofp, "def trace_begin():\n");
586 fprintf(ofp, "\tprint \"in trace_begin\"\n\n");
588 fprintf(ofp, "def trace_end():\n");
589 fprintf(ofp, "\tprint \"in trace_end\"\n\n");
591 while ((event = trace_find_next_event(pevent, event))) {
592 fprintf(ofp, "def %s__%s(", event->system, event->name);
593 fprintf(ofp, "event_name, ");
594 fprintf(ofp, "context, ");
595 fprintf(ofp, "common_cpu,\n");
596 fprintf(ofp, "\tcommon_secs, ");
597 fprintf(ofp, "common_nsecs, ");
598 fprintf(ofp, "common_pid, ");
599 fprintf(ofp, "common_comm,\n\t");
604 for (f = event->format.fields; f; f = f->next) {
607 if (++count % 5 == 0)
608 fprintf(ofp, "\n\t");
610 fprintf(ofp, "%s", f->name);
612 fprintf(ofp, "):\n");
614 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
615 "common_secs, common_nsecs,\n\t\t\t"
616 "common_pid, common_comm)\n\n");
618 fprintf(ofp, "\t\tprint \"");
623 for (f = event->format.fields; f; f = f->next) {
626 if (count && count % 3 == 0) {
627 fprintf(ofp, "\" \\\n\t\t\"");
631 fprintf(ofp, "%s=", f->name);
632 if (f->flags & FIELD_IS_STRING ||
633 f->flags & FIELD_IS_FLAG ||
634 f->flags & FIELD_IS_ARRAY ||
635 f->flags & FIELD_IS_SYMBOLIC)
637 else if (f->flags & FIELD_IS_SIGNED)
643 fprintf(ofp, "\\n\" %% \\\n\t\t(");
648 for (f = event->format.fields; f; f = f->next) {
652 if (++count % 5 == 0)
653 fprintf(ofp, "\n\t\t");
655 if (f->flags & FIELD_IS_FLAG) {
656 if ((count - 1) % 5 != 0) {
657 fprintf(ofp, "\n\t\t");
660 fprintf(ofp, "flag_str(\"");
661 fprintf(ofp, "%s__%s\", ", event->system,
663 fprintf(ofp, "\"%s\", %s)", f->name,
665 } else if (f->flags & FIELD_IS_SYMBOLIC) {
666 if ((count - 1) % 5 != 0) {
667 fprintf(ofp, "\n\t\t");
670 fprintf(ofp, "symbol_str(\"");
671 fprintf(ofp, "%s__%s\", ", event->system,
673 fprintf(ofp, "\"%s\", %s)", f->name,
676 fprintf(ofp, "%s", f->name);
679 fprintf(ofp, "),\n\n");
682 fprintf(ofp, "def trace_unhandled(event_name, context, "
683 "event_fields_dict):\n");
685 fprintf(ofp, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
686 "for k,v in sorted(event_fields_dict.items())])\n\n");
688 fprintf(ofp, "def print_header("
689 "event_name, cpu, secs, nsecs, pid, comm):\n"
690 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
691 "(event_name, cpu, secs, nsecs, pid, comm),\n");
695 fprintf(stderr, "generated Python script: %s\n", fname);
700 struct scripting_ops python_scripting_ops = {
702 .start_script = python_start_script,
703 .stop_script = python_stop_script,
704 .process_event = python_process_event,
705 .generate_script = python_generate_script,