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 <linux/bitmap.h>
31 #include "../../perf.h"
33 #include "../callchain.h"
37 #include "../thread.h"
39 #include "../machine.h"
40 #include "../db-export.h"
41 #include "../thread-stack.h"
42 #include "../trace-event.h"
43 #include "../machine.h"
45 PyMODINIT_FUNC initperf_trace_context(void);
47 #define TRACE_EVENT_TYPE_MAX \
48 ((1 << (sizeof(unsigned short) * 8)) - 1)
50 static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
53 #define N_COMMON_FIELDS 7
55 extern struct scripting_context *scripting_context;
57 static char *cur_field_name;
58 static int zero_flag_atom;
60 static PyObject *main_module, *main_dict;
64 PyObject *evsel_handler;
65 PyObject *machine_handler;
66 PyObject *thread_handler;
67 PyObject *comm_handler;
68 PyObject *comm_thread_handler;
69 PyObject *dso_handler;
70 PyObject *symbol_handler;
71 PyObject *branch_type_handler;
72 PyObject *sample_handler;
73 PyObject *call_path_handler;
74 PyObject *call_return_handler;
78 static struct tables tables_global;
80 static void handler_call_die(const char *handler_name) NORETURN;
81 static void handler_call_die(const char *handler_name)
84 Py_FatalError("problem in Python trace event handler");
85 // Py_FatalError does not return
86 // but we have to make the compiler happy
91 * Insert val into into the dictionary and decrement the reference counter.
92 * This is necessary for dictionaries since PyDict_SetItemString() does not
93 * steal a reference, as opposed to PyTuple_SetItem().
95 static void pydict_set_item_string_decref(PyObject *dict, const char *key, PyObject *val)
97 PyDict_SetItemString(dict, key, val);
101 static PyObject *get_handler(const char *handler_name)
105 handler = PyDict_GetItemString(main_dict, handler_name);
106 if (handler && !PyCallable_Check(handler))
111 static void call_object(PyObject *handler, PyObject *args, const char *die_msg)
115 retval = PyObject_CallObject(handler, args);
117 handler_call_die(die_msg);
121 static void try_call_object(const char *handler_name, PyObject *args)
125 handler = get_handler(handler_name);
127 call_object(handler, args, handler_name);
130 static void define_value(enum print_arg_type field_type,
132 const char *field_name,
133 const char *field_value,
134 const char *field_str)
136 const char *handler_name = "define_flag_value";
138 unsigned long long value;
141 if (field_type == PRINT_SYMBOL)
142 handler_name = "define_symbolic_value";
146 Py_FatalError("couldn't create Python tuple");
148 value = eval_flag(field_value);
150 PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
151 PyTuple_SetItem(t, n++, PyString_FromString(field_name));
152 PyTuple_SetItem(t, n++, PyInt_FromLong(value));
153 PyTuple_SetItem(t, n++, PyString_FromString(field_str));
155 try_call_object(handler_name, t);
160 static void define_values(enum print_arg_type field_type,
161 struct print_flag_sym *field,
163 const char *field_name)
165 define_value(field_type, ev_name, field_name, field->value,
169 define_values(field_type, field->next, ev_name, field_name);
172 static void define_field(enum print_arg_type field_type,
174 const char *field_name,
177 const char *handler_name = "define_flag_field";
181 if (field_type == PRINT_SYMBOL)
182 handler_name = "define_symbolic_field";
184 if (field_type == PRINT_FLAGS)
189 Py_FatalError("couldn't create Python tuple");
191 PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
192 PyTuple_SetItem(t, n++, PyString_FromString(field_name));
193 if (field_type == PRINT_FLAGS)
194 PyTuple_SetItem(t, n++, PyString_FromString(delim));
196 try_call_object(handler_name, t);
201 static void define_event_symbols(struct event_format *event,
203 struct print_arg *args)
205 switch (args->type) {
209 define_value(PRINT_FLAGS, ev_name, cur_field_name, "0",
214 free(cur_field_name);
215 cur_field_name = strdup(args->field.name);
218 define_event_symbols(event, ev_name, args->flags.field);
219 define_field(PRINT_FLAGS, ev_name, cur_field_name,
221 define_values(PRINT_FLAGS, args->flags.flags, ev_name,
225 define_event_symbols(event, ev_name, args->symbol.field);
226 define_field(PRINT_SYMBOL, ev_name, cur_field_name, NULL);
227 define_values(PRINT_SYMBOL, args->symbol.symbols, ev_name,
231 define_event_symbols(event, ev_name, args->hex.field);
232 define_event_symbols(event, ev_name, args->hex.size);
234 case PRINT_INT_ARRAY:
235 define_event_symbols(event, ev_name, args->int_array.field);
236 define_event_symbols(event, ev_name, args->int_array.count);
237 define_event_symbols(event, ev_name, args->int_array.el_size);
242 define_event_symbols(event, ev_name, args->typecast.item);
245 if (strcmp(args->op.op, ":") == 0)
247 define_event_symbols(event, ev_name, args->op.left);
248 define_event_symbols(event, ev_name, args->op.right);
251 /* gcc warns for these? */
253 case PRINT_DYNAMIC_ARRAY:
256 /* we should warn... */
261 define_event_symbols(event, ev_name, args->next);
264 static PyObject *get_field_numeric_entry(struct event_format *event,
265 struct format_field *field, void *data)
267 bool is_array = field->flags & FIELD_IS_ARRAY;
268 PyObject *obj, *list = NULL;
269 unsigned long long val;
270 unsigned int item_size, n_items, i;
273 list = PyList_New(field->arraylen);
274 item_size = field->size / field->arraylen;
275 n_items = field->arraylen;
277 item_size = field->size;
281 for (i = 0; i < n_items; i++) {
283 val = read_size(event, data + field->offset + i * item_size,
285 if (field->flags & FIELD_IS_SIGNED) {
286 if ((long long)val >= LONG_MIN &&
287 (long long)val <= LONG_MAX)
288 obj = PyInt_FromLong(val);
290 obj = PyLong_FromLongLong(val);
293 obj = PyInt_FromLong(val);
295 obj = PyLong_FromUnsignedLongLong(val);
298 PyList_SET_ITEM(list, i, obj);
306 static PyObject *python_process_callchain(struct perf_sample *sample,
307 struct perf_evsel *evsel,
308 struct addr_location *al)
312 pylist = PyList_New(0);
314 Py_FatalError("couldn't create Python list");
316 if (!symbol_conf.use_callchain || !sample->callchain)
319 if (thread__resolve_callchain(al->thread, evsel,
321 PERF_MAX_STACK_DEPTH) != 0) {
322 pr_err("Failed to resolve callchain. Skipping\n");
325 callchain_cursor_commit(&callchain_cursor);
330 struct callchain_cursor_node *node;
331 node = callchain_cursor_current(&callchain_cursor);
335 pyelem = PyDict_New();
337 Py_FatalError("couldn't create Python dictionary");
340 pydict_set_item_string_decref(pyelem, "ip",
341 PyLong_FromUnsignedLongLong(node->ip));
344 PyObject *pysym = PyDict_New();
346 Py_FatalError("couldn't create Python dictionary");
347 pydict_set_item_string_decref(pysym, "start",
348 PyLong_FromUnsignedLongLong(node->sym->start));
349 pydict_set_item_string_decref(pysym, "end",
350 PyLong_FromUnsignedLongLong(node->sym->end));
351 pydict_set_item_string_decref(pysym, "binding",
352 PyInt_FromLong(node->sym->binding));
353 pydict_set_item_string_decref(pysym, "name",
354 PyString_FromStringAndSize(node->sym->name,
355 node->sym->namelen));
356 pydict_set_item_string_decref(pyelem, "sym", pysym);
360 struct map *map = node->map;
361 const char *dsoname = "[unknown]";
362 if (map && map->dso && (map->dso->name || map->dso->long_name)) {
363 if (symbol_conf.show_kernel_path && map->dso->long_name)
364 dsoname = map->dso->long_name;
365 else if (map->dso->name)
366 dsoname = map->dso->name;
368 pydict_set_item_string_decref(pyelem, "dso",
369 PyString_FromString(dsoname));
372 callchain_cursor_advance(&callchain_cursor);
373 PyList_Append(pylist, pyelem);
382 static void python_process_tracepoint(struct perf_sample *sample,
383 struct perf_evsel *evsel,
384 struct addr_location *al)
386 struct event_format *event = evsel->tp_format;
387 PyObject *handler, *context, *t, *obj, *callchain;
388 PyObject *dict = NULL;
389 static char handler_name[256];
390 struct format_field *field;
394 int cpu = sample->cpu;
395 void *data = sample->raw_data;
396 unsigned long long nsecs = sample->time;
397 const char *comm = thread__comm_str(al->thread);
399 t = PyTuple_New(MAX_FIELDS);
401 Py_FatalError("couldn't create Python tuple");
404 die("ug! no event found for type %d", (int)evsel->attr.config);
406 pid = raw_field_value(event, "common_pid", data);
408 sprintf(handler_name, "%s__%s", event->system, event->name);
410 if (!test_and_set_bit(event->id, events_defined))
411 define_event_symbols(event, handler_name, event->print_fmt.args);
413 handler = get_handler(handler_name);
417 Py_FatalError("couldn't create Python dict");
419 s = nsecs / NSECS_PER_SEC;
420 ns = nsecs - s * NSECS_PER_SEC;
422 scripting_context->event_data = data;
423 scripting_context->pevent = evsel->tp_format->pevent;
425 context = PyCObject_FromVoidPtr(scripting_context, NULL);
427 PyTuple_SetItem(t, n++, PyString_FromString(handler_name));
428 PyTuple_SetItem(t, n++, context);
431 callchain = python_process_callchain(sample, evsel, al);
434 PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
435 PyTuple_SetItem(t, n++, PyInt_FromLong(s));
436 PyTuple_SetItem(t, n++, PyInt_FromLong(ns));
437 PyTuple_SetItem(t, n++, PyInt_FromLong(pid));
438 PyTuple_SetItem(t, n++, PyString_FromString(comm));
439 PyTuple_SetItem(t, n++, callchain);
441 pydict_set_item_string_decref(dict, "common_cpu", PyInt_FromLong(cpu));
442 pydict_set_item_string_decref(dict, "common_s", PyInt_FromLong(s));
443 pydict_set_item_string_decref(dict, "common_ns", PyInt_FromLong(ns));
444 pydict_set_item_string_decref(dict, "common_pid", PyInt_FromLong(pid));
445 pydict_set_item_string_decref(dict, "common_comm", PyString_FromString(comm));
446 pydict_set_item_string_decref(dict, "common_callchain", callchain);
448 for (field = event->format.fields; field; field = field->next) {
449 if (field->flags & FIELD_IS_STRING) {
451 if (field->flags & FIELD_IS_DYNAMIC) {
452 offset = *(int *)(data + field->offset);
455 offset = field->offset;
456 obj = PyString_FromString((char *)data + offset);
457 } else { /* FIELD_IS_NUMERIC */
458 obj = get_field_numeric_entry(event, field, data);
461 PyTuple_SetItem(t, n++, obj);
463 pydict_set_item_string_decref(dict, field->name, obj);
468 PyTuple_SetItem(t, n++, dict);
470 if (_PyTuple_Resize(&t, n) == -1)
471 Py_FatalError("error resizing Python tuple");
474 call_object(handler, t, handler_name);
476 try_call_object("trace_unhandled", t);
483 static PyObject *tuple_new(unsigned int sz)
489 Py_FatalError("couldn't create Python tuple");
493 static int tuple_set_u64(PyObject *t, unsigned int pos, u64 val)
495 #if BITS_PER_LONG == 64
496 return PyTuple_SetItem(t, pos, PyInt_FromLong(val));
498 #if BITS_PER_LONG == 32
499 return PyTuple_SetItem(t, pos, PyLong_FromLongLong(val));
503 static int tuple_set_s32(PyObject *t, unsigned int pos, s32 val)
505 return PyTuple_SetItem(t, pos, PyInt_FromLong(val));
508 static int tuple_set_string(PyObject *t, unsigned int pos, const char *s)
510 return PyTuple_SetItem(t, pos, PyString_FromString(s));
513 static int python_export_evsel(struct db_export *dbe, struct perf_evsel *evsel)
515 struct tables *tables = container_of(dbe, struct tables, dbe);
520 tuple_set_u64(t, 0, evsel->db_id);
521 tuple_set_string(t, 1, perf_evsel__name(evsel));
523 call_object(tables->evsel_handler, t, "evsel_table");
530 static int python_export_machine(struct db_export *dbe,
531 struct machine *machine)
533 struct tables *tables = container_of(dbe, struct tables, dbe);
538 tuple_set_u64(t, 0, machine->db_id);
539 tuple_set_s32(t, 1, machine->pid);
540 tuple_set_string(t, 2, machine->root_dir ? machine->root_dir : "");
542 call_object(tables->machine_handler, t, "machine_table");
549 static int python_export_thread(struct db_export *dbe, struct thread *thread,
550 u64 main_thread_db_id, struct machine *machine)
552 struct tables *tables = container_of(dbe, struct tables, dbe);
557 tuple_set_u64(t, 0, thread->db_id);
558 tuple_set_u64(t, 1, machine->db_id);
559 tuple_set_u64(t, 2, main_thread_db_id);
560 tuple_set_s32(t, 3, thread->pid_);
561 tuple_set_s32(t, 4, thread->tid);
563 call_object(tables->thread_handler, t, "thread_table");
570 static int python_export_comm(struct db_export *dbe, struct comm *comm)
572 struct tables *tables = container_of(dbe, struct tables, dbe);
577 tuple_set_u64(t, 0, comm->db_id);
578 tuple_set_string(t, 1, comm__str(comm));
580 call_object(tables->comm_handler, t, "comm_table");
587 static int python_export_comm_thread(struct db_export *dbe, u64 db_id,
588 struct comm *comm, struct thread *thread)
590 struct tables *tables = container_of(dbe, struct tables, dbe);
595 tuple_set_u64(t, 0, db_id);
596 tuple_set_u64(t, 1, comm->db_id);
597 tuple_set_u64(t, 2, thread->db_id);
599 call_object(tables->comm_thread_handler, t, "comm_thread_table");
606 static int python_export_dso(struct db_export *dbe, struct dso *dso,
607 struct machine *machine)
609 struct tables *tables = container_of(dbe, struct tables, dbe);
610 char sbuild_id[BUILD_ID_SIZE * 2 + 1];
613 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
617 tuple_set_u64(t, 0, dso->db_id);
618 tuple_set_u64(t, 1, machine->db_id);
619 tuple_set_string(t, 2, dso->short_name);
620 tuple_set_string(t, 3, dso->long_name);
621 tuple_set_string(t, 4, sbuild_id);
623 call_object(tables->dso_handler, t, "dso_table");
630 static int python_export_symbol(struct db_export *dbe, struct symbol *sym,
633 struct tables *tables = container_of(dbe, struct tables, dbe);
634 u64 *sym_db_id = symbol__priv(sym);
639 tuple_set_u64(t, 0, *sym_db_id);
640 tuple_set_u64(t, 1, dso->db_id);
641 tuple_set_u64(t, 2, sym->start);
642 tuple_set_u64(t, 3, sym->end);
643 tuple_set_s32(t, 4, sym->binding);
644 tuple_set_string(t, 5, sym->name);
646 call_object(tables->symbol_handler, t, "symbol_table");
653 static int python_export_branch_type(struct db_export *dbe, u32 branch_type,
656 struct tables *tables = container_of(dbe, struct tables, dbe);
661 tuple_set_s32(t, 0, branch_type);
662 tuple_set_string(t, 1, name);
664 call_object(tables->branch_type_handler, t, "branch_type_table");
671 static int python_export_sample(struct db_export *dbe,
672 struct export_sample *es)
674 struct tables *tables = container_of(dbe, struct tables, dbe);
679 tuple_set_u64(t, 0, es->db_id);
680 tuple_set_u64(t, 1, es->evsel->db_id);
681 tuple_set_u64(t, 2, es->al->machine->db_id);
682 tuple_set_u64(t, 3, es->al->thread->db_id);
683 tuple_set_u64(t, 4, es->comm_db_id);
684 tuple_set_u64(t, 5, es->dso_db_id);
685 tuple_set_u64(t, 6, es->sym_db_id);
686 tuple_set_u64(t, 7, es->offset);
687 tuple_set_u64(t, 8, es->sample->ip);
688 tuple_set_u64(t, 9, es->sample->time);
689 tuple_set_s32(t, 10, es->sample->cpu);
690 tuple_set_u64(t, 11, es->addr_dso_db_id);
691 tuple_set_u64(t, 12, es->addr_sym_db_id);
692 tuple_set_u64(t, 13, es->addr_offset);
693 tuple_set_u64(t, 14, es->sample->addr);
694 tuple_set_u64(t, 15, es->sample->period);
695 tuple_set_u64(t, 16, es->sample->weight);
696 tuple_set_u64(t, 17, es->sample->transaction);
697 tuple_set_u64(t, 18, es->sample->data_src);
698 tuple_set_s32(t, 19, es->sample->flags & PERF_BRANCH_MASK);
699 tuple_set_s32(t, 20, !!(es->sample->flags & PERF_IP_FLAG_IN_TX));
701 call_object(tables->sample_handler, t, "sample_table");
708 static int python_export_call_path(struct db_export *dbe, struct call_path *cp)
710 struct tables *tables = container_of(dbe, struct tables, dbe);
712 u64 parent_db_id, sym_db_id;
714 parent_db_id = cp->parent ? cp->parent->db_id : 0;
715 sym_db_id = cp->sym ? *(u64 *)symbol__priv(cp->sym) : 0;
719 tuple_set_u64(t, 0, cp->db_id);
720 tuple_set_u64(t, 1, parent_db_id);
721 tuple_set_u64(t, 2, sym_db_id);
722 tuple_set_u64(t, 3, cp->ip);
724 call_object(tables->call_path_handler, t, "call_path_table");
731 static int python_export_call_return(struct db_export *dbe,
732 struct call_return *cr)
734 struct tables *tables = container_of(dbe, struct tables, dbe);
735 u64 comm_db_id = cr->comm ? cr->comm->db_id : 0;
740 tuple_set_u64(t, 0, cr->db_id);
741 tuple_set_u64(t, 1, cr->thread->db_id);
742 tuple_set_u64(t, 2, comm_db_id);
743 tuple_set_u64(t, 3, cr->cp->db_id);
744 tuple_set_u64(t, 4, cr->call_time);
745 tuple_set_u64(t, 5, cr->return_time);
746 tuple_set_u64(t, 6, cr->branch_count);
747 tuple_set_u64(t, 7, cr->call_ref);
748 tuple_set_u64(t, 8, cr->return_ref);
749 tuple_set_u64(t, 9, cr->cp->parent->db_id);
750 tuple_set_s32(t, 10, cr->flags);
752 call_object(tables->call_return_handler, t, "call_return_table");
759 static int python_process_call_return(struct call_return *cr, void *data)
761 struct db_export *dbe = data;
763 return db_export__call_return(dbe, cr);
766 static void python_process_general_event(struct perf_sample *sample,
767 struct perf_evsel *evsel,
768 struct addr_location *al)
770 PyObject *handler, *t, *dict, *callchain, *dict_sample;
771 static char handler_name[64];
775 * Use the MAX_FIELDS to make the function expandable, though
776 * currently there is only one item for the tuple.
778 t = PyTuple_New(MAX_FIELDS);
780 Py_FatalError("couldn't create Python tuple");
784 Py_FatalError("couldn't create Python dictionary");
786 dict_sample = PyDict_New();
788 Py_FatalError("couldn't create Python dictionary");
790 snprintf(handler_name, sizeof(handler_name), "%s", "process_event");
792 handler = get_handler(handler_name);
796 pydict_set_item_string_decref(dict, "ev_name", PyString_FromString(perf_evsel__name(evsel)));
797 pydict_set_item_string_decref(dict, "attr", PyString_FromStringAndSize(
798 (const char *)&evsel->attr, sizeof(evsel->attr)));
800 pydict_set_item_string_decref(dict_sample, "pid",
801 PyInt_FromLong(sample->pid));
802 pydict_set_item_string_decref(dict_sample, "tid",
803 PyInt_FromLong(sample->tid));
804 pydict_set_item_string_decref(dict_sample, "cpu",
805 PyInt_FromLong(sample->cpu));
806 pydict_set_item_string_decref(dict_sample, "ip",
807 PyLong_FromUnsignedLongLong(sample->ip));
808 pydict_set_item_string_decref(dict_sample, "time",
809 PyLong_FromUnsignedLongLong(sample->time));
810 pydict_set_item_string_decref(dict_sample, "period",
811 PyLong_FromUnsignedLongLong(sample->period));
812 pydict_set_item_string_decref(dict, "sample", dict_sample);
814 pydict_set_item_string_decref(dict, "raw_buf", PyString_FromStringAndSize(
815 (const char *)sample->raw_data, sample->raw_size));
816 pydict_set_item_string_decref(dict, "comm",
817 PyString_FromString(thread__comm_str(al->thread)));
819 pydict_set_item_string_decref(dict, "dso",
820 PyString_FromString(al->map->dso->name));
823 pydict_set_item_string_decref(dict, "symbol",
824 PyString_FromString(al->sym->name));
828 callchain = python_process_callchain(sample, evsel, al);
829 pydict_set_item_string_decref(dict, "callchain", callchain);
831 PyTuple_SetItem(t, n++, dict);
832 if (_PyTuple_Resize(&t, n) == -1)
833 Py_FatalError("error resizing Python tuple");
835 call_object(handler, t, handler_name);
841 static void python_process_event(union perf_event *event,
842 struct perf_sample *sample,
843 struct perf_evsel *evsel,
844 struct addr_location *al)
846 struct tables *tables = &tables_global;
848 switch (evsel->attr.type) {
849 case PERF_TYPE_TRACEPOINT:
850 python_process_tracepoint(sample, evsel, al);
852 /* Reserve for future process_hw/sw/raw APIs */
854 if (tables->db_export_mode)
855 db_export__sample(&tables->dbe, event, sample, evsel, al);
857 python_process_general_event(sample, evsel, al);
861 static int run_start_sub(void)
863 main_module = PyImport_AddModule("__main__");
864 if (main_module == NULL)
866 Py_INCREF(main_module);
868 main_dict = PyModule_GetDict(main_module);
869 if (main_dict == NULL)
871 Py_INCREF(main_dict);
873 try_call_object("trace_begin", NULL);
878 Py_XDECREF(main_dict);
879 Py_XDECREF(main_module);
883 #define SET_TABLE_HANDLER_(name, handler_name, table_name) do { \
884 tables->handler_name = get_handler(#table_name); \
885 if (tables->handler_name) \
886 tables->dbe.export_ ## name = python_export_ ## name; \
889 #define SET_TABLE_HANDLER(name) \
890 SET_TABLE_HANDLER_(name, name ## _handler, name ## _table)
892 static void set_table_handlers(struct tables *tables)
894 const char *perf_db_export_mode = "perf_db_export_mode";
895 const char *perf_db_export_calls = "perf_db_export_calls";
896 PyObject *db_export_mode, *db_export_calls;
897 bool export_calls = false;
900 memset(tables, 0, sizeof(struct tables));
901 if (db_export__init(&tables->dbe))
902 Py_FatalError("failed to initialize export");
904 db_export_mode = PyDict_GetItemString(main_dict, perf_db_export_mode);
908 ret = PyObject_IsTrue(db_export_mode);
910 handler_call_die(perf_db_export_mode);
914 tables->dbe.crp = NULL;
915 db_export_calls = PyDict_GetItemString(main_dict, perf_db_export_calls);
916 if (db_export_calls) {
917 ret = PyObject_IsTrue(db_export_calls);
919 handler_call_die(perf_db_export_calls);
920 export_calls = !!ret;
925 call_return_processor__new(python_process_call_return,
927 if (!tables->dbe.crp)
928 Py_FatalError("failed to create calls processor");
931 tables->db_export_mode = true;
933 * Reserve per symbol space for symbol->db_id via symbol__priv()
935 symbol_conf.priv_size = sizeof(u64);
937 SET_TABLE_HANDLER(evsel);
938 SET_TABLE_HANDLER(machine);
939 SET_TABLE_HANDLER(thread);
940 SET_TABLE_HANDLER(comm);
941 SET_TABLE_HANDLER(comm_thread);
942 SET_TABLE_HANDLER(dso);
943 SET_TABLE_HANDLER(symbol);
944 SET_TABLE_HANDLER(branch_type);
945 SET_TABLE_HANDLER(sample);
946 SET_TABLE_HANDLER(call_path);
947 SET_TABLE_HANDLER(call_return);
953 static int python_start_script(const char *script, int argc, const char **argv)
955 struct tables *tables = &tables_global;
956 const char **command_line;
961 command_line = malloc((argc + 1) * sizeof(const char *));
962 command_line[0] = script;
963 for (i = 1; i < argc + 1; i++)
964 command_line[i] = argv[i - 1];
968 initperf_trace_context();
970 PySys_SetArgv(argc + 1, (char **)command_line);
972 fp = fopen(script, "r");
974 sprintf(buf, "Can't open python script \"%s\"", script);
980 err = PyRun_SimpleFile(fp, script);
982 fprintf(stderr, "Error running python script %s\n", script);
986 err = run_start_sub();
988 fprintf(stderr, "Error starting python script %s\n", script);
994 set_table_handlers(tables);
996 if (tables->db_export_mode) {
997 err = db_export__branch_types(&tables->dbe);
1010 static int python_flush_script(void)
1012 struct tables *tables = &tables_global;
1014 return db_export__flush(&tables->dbe);
1020 static int python_stop_script(void)
1022 struct tables *tables = &tables_global;
1024 try_call_object("trace_end", NULL);
1026 db_export__exit(&tables->dbe);
1028 Py_XDECREF(main_dict);
1029 Py_XDECREF(main_module);
1035 static int python_generate_script(struct pevent *pevent, const char *outfile)
1037 struct event_format *event = NULL;
1038 struct format_field *f;
1039 char fname[PATH_MAX];
1040 int not_first, count;
1043 sprintf(fname, "%s.py", outfile);
1044 ofp = fopen(fname, "w");
1046 fprintf(stderr, "couldn't open %s\n", fname);
1049 fprintf(ofp, "# perf script event handlers, "
1050 "generated by perf script -g python\n");
1052 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
1053 " License version 2\n\n");
1055 fprintf(ofp, "# The common_* event handler fields are the most useful "
1056 "fields common to\n");
1058 fprintf(ofp, "# all events. They don't necessarily correspond to "
1059 "the 'common_*' fields\n");
1061 fprintf(ofp, "# in the format files. Those fields not available as "
1062 "handler params can\n");
1064 fprintf(ofp, "# be retrieved using Python functions of the form "
1065 "common_*(context).\n");
1067 fprintf(ofp, "# See the perf-trace-python Documentation for the list "
1068 "of available functions.\n\n");
1070 fprintf(ofp, "import os\n");
1071 fprintf(ofp, "import sys\n\n");
1073 fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
1074 fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
1075 fprintf(ofp, "\nfrom perf_trace_context import *\n");
1076 fprintf(ofp, "from Core import *\n\n\n");
1078 fprintf(ofp, "def trace_begin():\n");
1079 fprintf(ofp, "\tprint \"in trace_begin\"\n\n");
1081 fprintf(ofp, "def trace_end():\n");
1082 fprintf(ofp, "\tprint \"in trace_end\"\n\n");
1084 while ((event = trace_find_next_event(pevent, event))) {
1085 fprintf(ofp, "def %s__%s(", event->system, event->name);
1086 fprintf(ofp, "event_name, ");
1087 fprintf(ofp, "context, ");
1088 fprintf(ofp, "common_cpu,\n");
1089 fprintf(ofp, "\tcommon_secs, ");
1090 fprintf(ofp, "common_nsecs, ");
1091 fprintf(ofp, "common_pid, ");
1092 fprintf(ofp, "common_comm,\n\t");
1093 fprintf(ofp, "common_callchain, ");
1098 for (f = event->format.fields; f; f = f->next) {
1101 if (++count % 5 == 0)
1102 fprintf(ofp, "\n\t");
1104 fprintf(ofp, "%s", f->name);
1106 fprintf(ofp, "):\n");
1108 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
1109 "common_secs, common_nsecs,\n\t\t\t"
1110 "common_pid, common_comm)\n\n");
1112 fprintf(ofp, "\t\tprint \"");
1117 for (f = event->format.fields; f; f = f->next) {
1120 if (count && count % 3 == 0) {
1121 fprintf(ofp, "\" \\\n\t\t\"");
1125 fprintf(ofp, "%s=", f->name);
1126 if (f->flags & FIELD_IS_STRING ||
1127 f->flags & FIELD_IS_FLAG ||
1128 f->flags & FIELD_IS_ARRAY ||
1129 f->flags & FIELD_IS_SYMBOLIC)
1130 fprintf(ofp, "%%s");
1131 else if (f->flags & FIELD_IS_SIGNED)
1132 fprintf(ofp, "%%d");
1134 fprintf(ofp, "%%u");
1137 fprintf(ofp, "\" %% \\\n\t\t(");
1142 for (f = event->format.fields; f; f = f->next) {
1146 if (++count % 5 == 0)
1147 fprintf(ofp, "\n\t\t");
1149 if (f->flags & FIELD_IS_FLAG) {
1150 if ((count - 1) % 5 != 0) {
1151 fprintf(ofp, "\n\t\t");
1154 fprintf(ofp, "flag_str(\"");
1155 fprintf(ofp, "%s__%s\", ", event->system,
1157 fprintf(ofp, "\"%s\", %s)", f->name,
1159 } else if (f->flags & FIELD_IS_SYMBOLIC) {
1160 if ((count - 1) % 5 != 0) {
1161 fprintf(ofp, "\n\t\t");
1164 fprintf(ofp, "symbol_str(\"");
1165 fprintf(ofp, "%s__%s\", ", event->system,
1167 fprintf(ofp, "\"%s\", %s)", f->name,
1170 fprintf(ofp, "%s", f->name);
1173 fprintf(ofp, ")\n\n");
1175 fprintf(ofp, "\t\tfor node in common_callchain:");
1176 fprintf(ofp, "\n\t\t\tif 'sym' in node:");
1177 fprintf(ofp, "\n\t\t\t\tprint \"\\t[%%x] %%s\" %% (node['ip'], node['sym']['name'])");
1178 fprintf(ofp, "\n\t\t\telse:");
1179 fprintf(ofp, "\n\t\t\t\tprint \"\t[%%x]\" %% (node['ip'])\n\n");
1180 fprintf(ofp, "\t\tprint \"\\n\"\n\n");
1184 fprintf(ofp, "def trace_unhandled(event_name, context, "
1185 "event_fields_dict):\n");
1187 fprintf(ofp, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
1188 "for k,v in sorted(event_fields_dict.items())])\n\n");
1190 fprintf(ofp, "def print_header("
1191 "event_name, cpu, secs, nsecs, pid, comm):\n"
1192 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
1193 "(event_name, cpu, secs, nsecs, pid, comm),\n");
1197 fprintf(stderr, "generated Python script: %s\n", fname);
1202 struct scripting_ops python_scripting_ops = {
1204 .start_script = python_start_script,
1205 .flush_script = python_flush_script,
1206 .stop_script = python_stop_script,
1207 .process_event = python_process_event,
1208 .generate_script = python_generate_script,