2 * trace-event-python. Feed trace events to an embedded Python interpreter.
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 <linux/bitmap.h>
31 #include <linux/time64.h>
33 #include "../../perf.h"
35 #include "../callchain.h"
39 #include "../thread.h"
41 #include "../machine.h"
42 #include "../db-export.h"
43 #include "../thread-stack.h"
44 #include "../trace-event.h"
45 #include "../machine.h"
46 #include "../call-path.h"
47 #include "thread_map.h"
49 #include "print_binary.h"
52 PyMODINIT_FUNC initperf_trace_context(void);
54 #define TRACE_EVENT_TYPE_MAX \
55 ((1 << (sizeof(unsigned short) * 8)) - 1)
57 static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
60 #define N_COMMON_FIELDS 7
62 extern struct scripting_context *scripting_context;
64 static char *cur_field_name;
65 static int zero_flag_atom;
67 static PyObject *main_module, *main_dict;
71 PyObject *evsel_handler;
72 PyObject *machine_handler;
73 PyObject *thread_handler;
74 PyObject *comm_handler;
75 PyObject *comm_thread_handler;
76 PyObject *dso_handler;
77 PyObject *symbol_handler;
78 PyObject *branch_type_handler;
79 PyObject *sample_handler;
80 PyObject *call_path_handler;
81 PyObject *call_return_handler;
85 static struct tables tables_global;
87 static void handler_call_die(const char *handler_name) NORETURN;
88 static void handler_call_die(const char *handler_name)
91 Py_FatalError("problem in Python trace event handler");
92 // Py_FatalError does not return
93 // but we have to make the compiler happy
98 * Insert val into into the dictionary and decrement the reference counter.
99 * This is necessary for dictionaries since PyDict_SetItemString() does not
100 * steal a reference, as opposed to PyTuple_SetItem().
102 static void pydict_set_item_string_decref(PyObject *dict, const char *key, PyObject *val)
104 PyDict_SetItemString(dict, key, val);
108 static PyObject *get_handler(const char *handler_name)
112 handler = PyDict_GetItemString(main_dict, handler_name);
113 if (handler && !PyCallable_Check(handler))
118 static void call_object(PyObject *handler, PyObject *args, const char *die_msg)
122 retval = PyObject_CallObject(handler, args);
124 handler_call_die(die_msg);
128 static void try_call_object(const char *handler_name, PyObject *args)
132 handler = get_handler(handler_name);
134 call_object(handler, args, handler_name);
137 static void define_value(enum print_arg_type field_type,
139 const char *field_name,
140 const char *field_value,
141 const char *field_str)
143 const char *handler_name = "define_flag_value";
145 unsigned long long value;
148 if (field_type == PRINT_SYMBOL)
149 handler_name = "define_symbolic_value";
153 Py_FatalError("couldn't create Python tuple");
155 value = eval_flag(field_value);
157 PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
158 PyTuple_SetItem(t, n++, PyString_FromString(field_name));
159 PyTuple_SetItem(t, n++, PyInt_FromLong(value));
160 PyTuple_SetItem(t, n++, PyString_FromString(field_str));
162 try_call_object(handler_name, t);
167 static void define_values(enum print_arg_type field_type,
168 struct print_flag_sym *field,
170 const char *field_name)
172 define_value(field_type, ev_name, field_name, field->value,
176 define_values(field_type, field->next, ev_name, field_name);
179 static void define_field(enum print_arg_type field_type,
181 const char *field_name,
184 const char *handler_name = "define_flag_field";
188 if (field_type == PRINT_SYMBOL)
189 handler_name = "define_symbolic_field";
191 if (field_type == PRINT_FLAGS)
196 Py_FatalError("couldn't create Python tuple");
198 PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
199 PyTuple_SetItem(t, n++, PyString_FromString(field_name));
200 if (field_type == PRINT_FLAGS)
201 PyTuple_SetItem(t, n++, PyString_FromString(delim));
203 try_call_object(handler_name, t);
208 static void define_event_symbols(struct event_format *event,
210 struct print_arg *args)
215 switch (args->type) {
219 define_value(PRINT_FLAGS, ev_name, cur_field_name, "0",
224 free(cur_field_name);
225 cur_field_name = strdup(args->field.name);
228 define_event_symbols(event, ev_name, args->flags.field);
229 define_field(PRINT_FLAGS, ev_name, cur_field_name,
231 define_values(PRINT_FLAGS, args->flags.flags, ev_name,
235 define_event_symbols(event, ev_name, args->symbol.field);
236 define_field(PRINT_SYMBOL, ev_name, cur_field_name, NULL);
237 define_values(PRINT_SYMBOL, args->symbol.symbols, ev_name,
242 define_event_symbols(event, ev_name, args->hex.field);
243 define_event_symbols(event, ev_name, args->hex.size);
245 case PRINT_INT_ARRAY:
246 define_event_symbols(event, ev_name, args->int_array.field);
247 define_event_symbols(event, ev_name, args->int_array.count);
248 define_event_symbols(event, ev_name, args->int_array.el_size);
253 define_event_symbols(event, ev_name, args->typecast.item);
256 if (strcmp(args->op.op, ":") == 0)
258 define_event_symbols(event, ev_name, args->op.left);
259 define_event_symbols(event, ev_name, args->op.right);
262 /* gcc warns for these? */
264 case PRINT_DYNAMIC_ARRAY:
265 case PRINT_DYNAMIC_ARRAY_LEN:
268 /* we should warn... */
273 define_event_symbols(event, ev_name, args->next);
276 static PyObject *get_field_numeric_entry(struct event_format *event,
277 struct format_field *field, void *data)
279 bool is_array = field->flags & FIELD_IS_ARRAY;
280 PyObject *obj = NULL, *list = NULL;
281 unsigned long long val;
282 unsigned int item_size, n_items, i;
285 list = PyList_New(field->arraylen);
286 item_size = field->size / field->arraylen;
287 n_items = field->arraylen;
289 item_size = field->size;
293 for (i = 0; i < n_items; i++) {
295 val = read_size(event, data + field->offset + i * item_size,
297 if (field->flags & FIELD_IS_SIGNED) {
298 if ((long long)val >= LONG_MIN &&
299 (long long)val <= LONG_MAX)
300 obj = PyInt_FromLong(val);
302 obj = PyLong_FromLongLong(val);
305 obj = PyInt_FromLong(val);
307 obj = PyLong_FromUnsignedLongLong(val);
310 PyList_SET_ITEM(list, i, obj);
318 static PyObject *python_process_callchain(struct perf_sample *sample,
319 struct perf_evsel *evsel,
320 struct addr_location *al)
324 pylist = PyList_New(0);
326 Py_FatalError("couldn't create Python list");
328 if (!symbol_conf.use_callchain || !sample->callchain)
331 if (thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
333 scripting_max_stack) != 0) {
334 pr_err("Failed to resolve callchain. Skipping\n");
337 callchain_cursor_commit(&callchain_cursor);
342 struct callchain_cursor_node *node;
343 node = callchain_cursor_current(&callchain_cursor);
347 pyelem = PyDict_New();
349 Py_FatalError("couldn't create Python dictionary");
352 pydict_set_item_string_decref(pyelem, "ip",
353 PyLong_FromUnsignedLongLong(node->ip));
356 PyObject *pysym = PyDict_New();
358 Py_FatalError("couldn't create Python dictionary");
359 pydict_set_item_string_decref(pysym, "start",
360 PyLong_FromUnsignedLongLong(node->sym->start));
361 pydict_set_item_string_decref(pysym, "end",
362 PyLong_FromUnsignedLongLong(node->sym->end));
363 pydict_set_item_string_decref(pysym, "binding",
364 PyInt_FromLong(node->sym->binding));
365 pydict_set_item_string_decref(pysym, "name",
366 PyString_FromStringAndSize(node->sym->name,
367 node->sym->namelen));
368 pydict_set_item_string_decref(pyelem, "sym", pysym);
372 struct map *map = node->map;
373 const char *dsoname = "[unknown]";
374 if (map && map->dso) {
375 if (symbol_conf.show_kernel_path && map->dso->long_name)
376 dsoname = map->dso->long_name;
378 dsoname = map->dso->name;
380 pydict_set_item_string_decref(pyelem, "dso",
381 PyString_FromString(dsoname));
384 callchain_cursor_advance(&callchain_cursor);
385 PyList_Append(pylist, pyelem);
393 static void python_process_tracepoint(struct perf_sample *sample,
394 struct perf_evsel *evsel,
395 struct addr_location *al)
397 struct event_format *event = evsel->tp_format;
398 PyObject *handler, *context, *t, *obj = NULL, *callchain;
399 PyObject *dict = NULL;
400 static char handler_name[256];
401 struct format_field *field;
405 int cpu = sample->cpu;
406 void *data = sample->raw_data;
407 unsigned long long nsecs = sample->time;
408 const char *comm = thread__comm_str(al->thread);
410 t = PyTuple_New(MAX_FIELDS);
412 Py_FatalError("couldn't create Python tuple");
415 snprintf(handler_name, sizeof(handler_name),
416 "ug! no event found for type %" PRIu64, (u64)evsel->attr.config);
417 Py_FatalError(handler_name);
420 pid = raw_field_value(event, "common_pid", data);
422 sprintf(handler_name, "%s__%s", event->system, event->name);
424 if (!test_and_set_bit(event->id, events_defined))
425 define_event_symbols(event, handler_name, event->print_fmt.args);
427 handler = get_handler(handler_name);
431 Py_FatalError("couldn't create Python dict");
433 s = nsecs / NSEC_PER_SEC;
434 ns = nsecs - s * NSEC_PER_SEC;
436 scripting_context->event_data = data;
437 scripting_context->pevent = evsel->tp_format->pevent;
439 context = PyCObject_FromVoidPtr(scripting_context, NULL);
441 PyTuple_SetItem(t, n++, PyString_FromString(handler_name));
442 PyTuple_SetItem(t, n++, context);
445 callchain = python_process_callchain(sample, evsel, al);
448 PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
449 PyTuple_SetItem(t, n++, PyInt_FromLong(s));
450 PyTuple_SetItem(t, n++, PyInt_FromLong(ns));
451 PyTuple_SetItem(t, n++, PyInt_FromLong(pid));
452 PyTuple_SetItem(t, n++, PyString_FromString(comm));
453 PyTuple_SetItem(t, n++, callchain);
455 pydict_set_item_string_decref(dict, "common_cpu", PyInt_FromLong(cpu));
456 pydict_set_item_string_decref(dict, "common_s", PyInt_FromLong(s));
457 pydict_set_item_string_decref(dict, "common_ns", PyInt_FromLong(ns));
458 pydict_set_item_string_decref(dict, "common_pid", PyInt_FromLong(pid));
459 pydict_set_item_string_decref(dict, "common_comm", PyString_FromString(comm));
460 pydict_set_item_string_decref(dict, "common_callchain", callchain);
462 for (field = event->format.fields; field; field = field->next) {
463 unsigned int offset, len;
464 unsigned long long val;
466 if (field->flags & FIELD_IS_ARRAY) {
467 offset = field->offset;
469 if (field->flags & FIELD_IS_DYNAMIC) {
470 val = pevent_read_number(scripting_context->pevent,
476 if (field->flags & FIELD_IS_STRING &&
477 is_printable_array(data + offset, len)) {
478 obj = PyString_FromString((char *) data + offset);
480 obj = PyByteArray_FromStringAndSize((const char *) data + offset, len);
481 field->flags &= ~FIELD_IS_STRING;
483 } else { /* FIELD_IS_NUMERIC */
484 obj = get_field_numeric_entry(event, field, data);
487 PyTuple_SetItem(t, n++, obj);
489 pydict_set_item_string_decref(dict, field->name, obj);
494 PyTuple_SetItem(t, n++, dict);
496 if (_PyTuple_Resize(&t, n) == -1)
497 Py_FatalError("error resizing Python tuple");
500 call_object(handler, t, handler_name);
502 try_call_object("trace_unhandled", t);
509 static PyObject *tuple_new(unsigned int sz)
515 Py_FatalError("couldn't create Python tuple");
519 static int tuple_set_u64(PyObject *t, unsigned int pos, u64 val)
521 #if BITS_PER_LONG == 64
522 return PyTuple_SetItem(t, pos, PyInt_FromLong(val));
524 #if BITS_PER_LONG == 32
525 return PyTuple_SetItem(t, pos, PyLong_FromLongLong(val));
529 static int tuple_set_s32(PyObject *t, unsigned int pos, s32 val)
531 return PyTuple_SetItem(t, pos, PyInt_FromLong(val));
534 static int tuple_set_string(PyObject *t, unsigned int pos, const char *s)
536 return PyTuple_SetItem(t, pos, PyString_FromString(s));
539 static int python_export_evsel(struct db_export *dbe, struct perf_evsel *evsel)
541 struct tables *tables = container_of(dbe, struct tables, dbe);
546 tuple_set_u64(t, 0, evsel->db_id);
547 tuple_set_string(t, 1, perf_evsel__name(evsel));
549 call_object(tables->evsel_handler, t, "evsel_table");
556 static int python_export_machine(struct db_export *dbe,
557 struct machine *machine)
559 struct tables *tables = container_of(dbe, struct tables, dbe);
564 tuple_set_u64(t, 0, machine->db_id);
565 tuple_set_s32(t, 1, machine->pid);
566 tuple_set_string(t, 2, machine->root_dir ? machine->root_dir : "");
568 call_object(tables->machine_handler, t, "machine_table");
575 static int python_export_thread(struct db_export *dbe, struct thread *thread,
576 u64 main_thread_db_id, struct machine *machine)
578 struct tables *tables = container_of(dbe, struct tables, dbe);
583 tuple_set_u64(t, 0, thread->db_id);
584 tuple_set_u64(t, 1, machine->db_id);
585 tuple_set_u64(t, 2, main_thread_db_id);
586 tuple_set_s32(t, 3, thread->pid_);
587 tuple_set_s32(t, 4, thread->tid);
589 call_object(tables->thread_handler, t, "thread_table");
596 static int python_export_comm(struct db_export *dbe, struct comm *comm)
598 struct tables *tables = container_of(dbe, struct tables, dbe);
603 tuple_set_u64(t, 0, comm->db_id);
604 tuple_set_string(t, 1, comm__str(comm));
606 call_object(tables->comm_handler, t, "comm_table");
613 static int python_export_comm_thread(struct db_export *dbe, u64 db_id,
614 struct comm *comm, struct thread *thread)
616 struct tables *tables = container_of(dbe, struct tables, dbe);
621 tuple_set_u64(t, 0, db_id);
622 tuple_set_u64(t, 1, comm->db_id);
623 tuple_set_u64(t, 2, thread->db_id);
625 call_object(tables->comm_thread_handler, t, "comm_thread_table");
632 static int python_export_dso(struct db_export *dbe, struct dso *dso,
633 struct machine *machine)
635 struct tables *tables = container_of(dbe, struct tables, dbe);
636 char sbuild_id[SBUILD_ID_SIZE];
639 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
643 tuple_set_u64(t, 0, dso->db_id);
644 tuple_set_u64(t, 1, machine->db_id);
645 tuple_set_string(t, 2, dso->short_name);
646 tuple_set_string(t, 3, dso->long_name);
647 tuple_set_string(t, 4, sbuild_id);
649 call_object(tables->dso_handler, t, "dso_table");
656 static int python_export_symbol(struct db_export *dbe, struct symbol *sym,
659 struct tables *tables = container_of(dbe, struct tables, dbe);
660 u64 *sym_db_id = symbol__priv(sym);
665 tuple_set_u64(t, 0, *sym_db_id);
666 tuple_set_u64(t, 1, dso->db_id);
667 tuple_set_u64(t, 2, sym->start);
668 tuple_set_u64(t, 3, sym->end);
669 tuple_set_s32(t, 4, sym->binding);
670 tuple_set_string(t, 5, sym->name);
672 call_object(tables->symbol_handler, t, "symbol_table");
679 static int python_export_branch_type(struct db_export *dbe, u32 branch_type,
682 struct tables *tables = container_of(dbe, struct tables, dbe);
687 tuple_set_s32(t, 0, branch_type);
688 tuple_set_string(t, 1, name);
690 call_object(tables->branch_type_handler, t, "branch_type_table");
697 static int python_export_sample(struct db_export *dbe,
698 struct export_sample *es)
700 struct tables *tables = container_of(dbe, struct tables, dbe);
705 tuple_set_u64(t, 0, es->db_id);
706 tuple_set_u64(t, 1, es->evsel->db_id);
707 tuple_set_u64(t, 2, es->al->machine->db_id);
708 tuple_set_u64(t, 3, es->al->thread->db_id);
709 tuple_set_u64(t, 4, es->comm_db_id);
710 tuple_set_u64(t, 5, es->dso_db_id);
711 tuple_set_u64(t, 6, es->sym_db_id);
712 tuple_set_u64(t, 7, es->offset);
713 tuple_set_u64(t, 8, es->sample->ip);
714 tuple_set_u64(t, 9, es->sample->time);
715 tuple_set_s32(t, 10, es->sample->cpu);
716 tuple_set_u64(t, 11, es->addr_dso_db_id);
717 tuple_set_u64(t, 12, es->addr_sym_db_id);
718 tuple_set_u64(t, 13, es->addr_offset);
719 tuple_set_u64(t, 14, es->sample->addr);
720 tuple_set_u64(t, 15, es->sample->period);
721 tuple_set_u64(t, 16, es->sample->weight);
722 tuple_set_u64(t, 17, es->sample->transaction);
723 tuple_set_u64(t, 18, es->sample->data_src);
724 tuple_set_s32(t, 19, es->sample->flags & PERF_BRANCH_MASK);
725 tuple_set_s32(t, 20, !!(es->sample->flags & PERF_IP_FLAG_IN_TX));
726 tuple_set_u64(t, 21, es->call_path_id);
728 call_object(tables->sample_handler, t, "sample_table");
735 static int python_export_call_path(struct db_export *dbe, struct call_path *cp)
737 struct tables *tables = container_of(dbe, struct tables, dbe);
739 u64 parent_db_id, sym_db_id;
741 parent_db_id = cp->parent ? cp->parent->db_id : 0;
742 sym_db_id = cp->sym ? *(u64 *)symbol__priv(cp->sym) : 0;
746 tuple_set_u64(t, 0, cp->db_id);
747 tuple_set_u64(t, 1, parent_db_id);
748 tuple_set_u64(t, 2, sym_db_id);
749 tuple_set_u64(t, 3, cp->ip);
751 call_object(tables->call_path_handler, t, "call_path_table");
758 static int python_export_call_return(struct db_export *dbe,
759 struct call_return *cr)
761 struct tables *tables = container_of(dbe, struct tables, dbe);
762 u64 comm_db_id = cr->comm ? cr->comm->db_id : 0;
767 tuple_set_u64(t, 0, cr->db_id);
768 tuple_set_u64(t, 1, cr->thread->db_id);
769 tuple_set_u64(t, 2, comm_db_id);
770 tuple_set_u64(t, 3, cr->cp->db_id);
771 tuple_set_u64(t, 4, cr->call_time);
772 tuple_set_u64(t, 5, cr->return_time);
773 tuple_set_u64(t, 6, cr->branch_count);
774 tuple_set_u64(t, 7, cr->call_ref);
775 tuple_set_u64(t, 8, cr->return_ref);
776 tuple_set_u64(t, 9, cr->cp->parent->db_id);
777 tuple_set_s32(t, 10, cr->flags);
779 call_object(tables->call_return_handler, t, "call_return_table");
786 static int python_process_call_return(struct call_return *cr, void *data)
788 struct db_export *dbe = data;
790 return db_export__call_return(dbe, cr);
793 static void python_process_general_event(struct perf_sample *sample,
794 struct perf_evsel *evsel,
795 struct addr_location *al)
797 PyObject *handler, *t, *dict, *callchain, *dict_sample;
798 static char handler_name[64];
802 * Use the MAX_FIELDS to make the function expandable, though
803 * currently there is only one item for the tuple.
805 t = PyTuple_New(MAX_FIELDS);
807 Py_FatalError("couldn't create Python tuple");
811 Py_FatalError("couldn't create Python dictionary");
813 dict_sample = PyDict_New();
815 Py_FatalError("couldn't create Python dictionary");
817 snprintf(handler_name, sizeof(handler_name), "%s", "process_event");
819 handler = get_handler(handler_name);
823 pydict_set_item_string_decref(dict, "ev_name", PyString_FromString(perf_evsel__name(evsel)));
824 pydict_set_item_string_decref(dict, "attr", PyString_FromStringAndSize(
825 (const char *)&evsel->attr, sizeof(evsel->attr)));
827 pydict_set_item_string_decref(dict_sample, "pid",
828 PyInt_FromLong(sample->pid));
829 pydict_set_item_string_decref(dict_sample, "tid",
830 PyInt_FromLong(sample->tid));
831 pydict_set_item_string_decref(dict_sample, "cpu",
832 PyInt_FromLong(sample->cpu));
833 pydict_set_item_string_decref(dict_sample, "ip",
834 PyLong_FromUnsignedLongLong(sample->ip));
835 pydict_set_item_string_decref(dict_sample, "time",
836 PyLong_FromUnsignedLongLong(sample->time));
837 pydict_set_item_string_decref(dict_sample, "period",
838 PyLong_FromUnsignedLongLong(sample->period));
839 pydict_set_item_string_decref(dict, "sample", dict_sample);
841 pydict_set_item_string_decref(dict, "raw_buf", PyString_FromStringAndSize(
842 (const char *)sample->raw_data, sample->raw_size));
843 pydict_set_item_string_decref(dict, "comm",
844 PyString_FromString(thread__comm_str(al->thread)));
846 pydict_set_item_string_decref(dict, "dso",
847 PyString_FromString(al->map->dso->name));
850 pydict_set_item_string_decref(dict, "symbol",
851 PyString_FromString(al->sym->name));
855 callchain = python_process_callchain(sample, evsel, al);
856 pydict_set_item_string_decref(dict, "callchain", callchain);
858 PyTuple_SetItem(t, n++, dict);
859 if (_PyTuple_Resize(&t, n) == -1)
860 Py_FatalError("error resizing Python tuple");
862 call_object(handler, t, handler_name);
868 static void python_process_event(union perf_event *event,
869 struct perf_sample *sample,
870 struct perf_evsel *evsel,
871 struct addr_location *al)
873 struct tables *tables = &tables_global;
875 switch (evsel->attr.type) {
876 case PERF_TYPE_TRACEPOINT:
877 python_process_tracepoint(sample, evsel, al);
879 /* Reserve for future process_hw/sw/raw APIs */
881 if (tables->db_export_mode)
882 db_export__sample(&tables->dbe, event, sample, evsel, al);
884 python_process_general_event(sample, evsel, al);
888 static void get_handler_name(char *str, size_t size,
889 struct perf_evsel *evsel)
893 scnprintf(str, size, "stat__%s", perf_evsel__name(evsel));
895 while ((p = strchr(p, ':'))) {
902 process_stat(struct perf_evsel *counter, int cpu, int thread, u64 tstamp,
903 struct perf_counts_values *count)
905 PyObject *handler, *t;
906 static char handler_name[256];
909 t = PyTuple_New(MAX_FIELDS);
911 Py_FatalError("couldn't create Python tuple");
913 get_handler_name(handler_name, sizeof(handler_name),
916 handler = get_handler(handler_name);
918 pr_debug("can't find python handler %s\n", handler_name);
922 PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
923 PyTuple_SetItem(t, n++, PyInt_FromLong(thread));
925 tuple_set_u64(t, n++, tstamp);
926 tuple_set_u64(t, n++, count->val);
927 tuple_set_u64(t, n++, count->ena);
928 tuple_set_u64(t, n++, count->run);
930 if (_PyTuple_Resize(&t, n) == -1)
931 Py_FatalError("error resizing Python tuple");
933 call_object(handler, t, handler_name);
938 static void python_process_stat(struct perf_stat_config *config,
939 struct perf_evsel *counter, u64 tstamp)
941 struct thread_map *threads = counter->threads;
942 struct cpu_map *cpus = counter->cpus;
945 if (config->aggr_mode == AGGR_GLOBAL) {
946 process_stat(counter, -1, -1, tstamp,
947 &counter->counts->aggr);
951 for (thread = 0; thread < threads->nr; thread++) {
952 for (cpu = 0; cpu < cpus->nr; cpu++) {
953 process_stat(counter, cpus->map[cpu],
954 thread_map__pid(threads, thread), tstamp,
955 perf_counts(counter->counts, cpu, thread));
960 static void python_process_stat_interval(u64 tstamp)
962 PyObject *handler, *t;
963 static const char handler_name[] = "stat__interval";
966 t = PyTuple_New(MAX_FIELDS);
968 Py_FatalError("couldn't create Python tuple");
970 handler = get_handler(handler_name);
972 pr_debug("can't find python handler %s\n", handler_name);
976 tuple_set_u64(t, n++, tstamp);
978 if (_PyTuple_Resize(&t, n) == -1)
979 Py_FatalError("error resizing Python tuple");
981 call_object(handler, t, handler_name);
986 static int run_start_sub(void)
988 main_module = PyImport_AddModule("__main__");
989 if (main_module == NULL)
991 Py_INCREF(main_module);
993 main_dict = PyModule_GetDict(main_module);
994 if (main_dict == NULL)
996 Py_INCREF(main_dict);
998 try_call_object("trace_begin", NULL);
1003 Py_XDECREF(main_dict);
1004 Py_XDECREF(main_module);
1008 #define SET_TABLE_HANDLER_(name, handler_name, table_name) do { \
1009 tables->handler_name = get_handler(#table_name); \
1010 if (tables->handler_name) \
1011 tables->dbe.export_ ## name = python_export_ ## name; \
1014 #define SET_TABLE_HANDLER(name) \
1015 SET_TABLE_HANDLER_(name, name ## _handler, name ## _table)
1017 static void set_table_handlers(struct tables *tables)
1019 const char *perf_db_export_mode = "perf_db_export_mode";
1020 const char *perf_db_export_calls = "perf_db_export_calls";
1021 const char *perf_db_export_callchains = "perf_db_export_callchains";
1022 PyObject *db_export_mode, *db_export_calls, *db_export_callchains;
1023 bool export_calls = false;
1024 bool export_callchains = false;
1027 memset(tables, 0, sizeof(struct tables));
1028 if (db_export__init(&tables->dbe))
1029 Py_FatalError("failed to initialize export");
1031 db_export_mode = PyDict_GetItemString(main_dict, perf_db_export_mode);
1032 if (!db_export_mode)
1035 ret = PyObject_IsTrue(db_export_mode);
1037 handler_call_die(perf_db_export_mode);
1041 /* handle export calls */
1042 tables->dbe.crp = NULL;
1043 db_export_calls = PyDict_GetItemString(main_dict, perf_db_export_calls);
1044 if (db_export_calls) {
1045 ret = PyObject_IsTrue(db_export_calls);
1047 handler_call_die(perf_db_export_calls);
1048 export_calls = !!ret;
1053 call_return_processor__new(python_process_call_return,
1055 if (!tables->dbe.crp)
1056 Py_FatalError("failed to create calls processor");
1059 /* handle export callchains */
1060 tables->dbe.cpr = NULL;
1061 db_export_callchains = PyDict_GetItemString(main_dict,
1062 perf_db_export_callchains);
1063 if (db_export_callchains) {
1064 ret = PyObject_IsTrue(db_export_callchains);
1066 handler_call_die(perf_db_export_callchains);
1067 export_callchains = !!ret;
1070 if (export_callchains) {
1072 * Attempt to use the call path root from the call return
1073 * processor, if the call return processor is in use. Otherwise,
1074 * we allocate a new call path root. This prevents exporting
1075 * duplicate call path ids when both are in use simultaniously.
1077 if (tables->dbe.crp)
1078 tables->dbe.cpr = tables->dbe.crp->cpr;
1080 tables->dbe.cpr = call_path_root__new();
1082 if (!tables->dbe.cpr)
1083 Py_FatalError("failed to create call path root");
1086 tables->db_export_mode = true;
1088 * Reserve per symbol space for symbol->db_id via symbol__priv()
1090 symbol_conf.priv_size = sizeof(u64);
1092 SET_TABLE_HANDLER(evsel);
1093 SET_TABLE_HANDLER(machine);
1094 SET_TABLE_HANDLER(thread);
1095 SET_TABLE_HANDLER(comm);
1096 SET_TABLE_HANDLER(comm_thread);
1097 SET_TABLE_HANDLER(dso);
1098 SET_TABLE_HANDLER(symbol);
1099 SET_TABLE_HANDLER(branch_type);
1100 SET_TABLE_HANDLER(sample);
1101 SET_TABLE_HANDLER(call_path);
1102 SET_TABLE_HANDLER(call_return);
1106 * Start trace script
1108 static int python_start_script(const char *script, int argc, const char **argv)
1110 struct tables *tables = &tables_global;
1111 const char **command_line;
1116 command_line = malloc((argc + 1) * sizeof(const char *));
1117 command_line[0] = script;
1118 for (i = 1; i < argc + 1; i++)
1119 command_line[i] = argv[i - 1];
1123 initperf_trace_context();
1125 PySys_SetArgv(argc + 1, (char **)command_line);
1127 fp = fopen(script, "r");
1129 sprintf(buf, "Can't open python script \"%s\"", script);
1135 err = PyRun_SimpleFile(fp, script);
1137 fprintf(stderr, "Error running python script %s\n", script);
1141 err = run_start_sub();
1143 fprintf(stderr, "Error starting python script %s\n", script);
1147 set_table_handlers(tables);
1149 if (tables->db_export_mode) {
1150 err = db_export__branch_types(&tables->dbe);
1165 static int python_flush_script(void)
1167 struct tables *tables = &tables_global;
1169 return db_export__flush(&tables->dbe);
1175 static int python_stop_script(void)
1177 struct tables *tables = &tables_global;
1179 try_call_object("trace_end", NULL);
1181 db_export__exit(&tables->dbe);
1183 Py_XDECREF(main_dict);
1184 Py_XDECREF(main_module);
1190 static int python_generate_script(struct pevent *pevent, const char *outfile)
1192 struct event_format *event = NULL;
1193 struct format_field *f;
1194 char fname[PATH_MAX];
1195 int not_first, count;
1198 sprintf(fname, "%s.py", outfile);
1199 ofp = fopen(fname, "w");
1201 fprintf(stderr, "couldn't open %s\n", fname);
1204 fprintf(ofp, "# perf script event handlers, "
1205 "generated by perf script -g python\n");
1207 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
1208 " License version 2\n\n");
1210 fprintf(ofp, "# The common_* event handler fields are the most useful "
1211 "fields common to\n");
1213 fprintf(ofp, "# all events. They don't necessarily correspond to "
1214 "the 'common_*' fields\n");
1216 fprintf(ofp, "# in the format files. Those fields not available as "
1217 "handler params can\n");
1219 fprintf(ofp, "# be retrieved using Python functions of the form "
1220 "common_*(context).\n");
1222 fprintf(ofp, "# See the perf-script-python Documentation for the list "
1223 "of available functions.\n\n");
1225 fprintf(ofp, "import os\n");
1226 fprintf(ofp, "import sys\n\n");
1228 fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
1229 fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
1230 fprintf(ofp, "\nfrom perf_trace_context import *\n");
1231 fprintf(ofp, "from Core import *\n\n\n");
1233 fprintf(ofp, "def trace_begin():\n");
1234 fprintf(ofp, "\tprint \"in trace_begin\"\n\n");
1236 fprintf(ofp, "def trace_end():\n");
1237 fprintf(ofp, "\tprint \"in trace_end\"\n\n");
1239 while ((event = trace_find_next_event(pevent, event))) {
1240 fprintf(ofp, "def %s__%s(", event->system, event->name);
1241 fprintf(ofp, "event_name, ");
1242 fprintf(ofp, "context, ");
1243 fprintf(ofp, "common_cpu,\n");
1244 fprintf(ofp, "\tcommon_secs, ");
1245 fprintf(ofp, "common_nsecs, ");
1246 fprintf(ofp, "common_pid, ");
1247 fprintf(ofp, "common_comm,\n\t");
1248 fprintf(ofp, "common_callchain, ");
1253 for (f = event->format.fields; f; f = f->next) {
1256 if (++count % 5 == 0)
1257 fprintf(ofp, "\n\t");
1259 fprintf(ofp, "%s", f->name);
1261 fprintf(ofp, "):\n");
1263 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
1264 "common_secs, common_nsecs,\n\t\t\t"
1265 "common_pid, common_comm)\n\n");
1267 fprintf(ofp, "\t\tprint \"");
1272 for (f = event->format.fields; f; f = f->next) {
1275 if (count && count % 3 == 0) {
1276 fprintf(ofp, "\" \\\n\t\t\"");
1280 fprintf(ofp, "%s=", f->name);
1281 if (f->flags & FIELD_IS_STRING ||
1282 f->flags & FIELD_IS_FLAG ||
1283 f->flags & FIELD_IS_ARRAY ||
1284 f->flags & FIELD_IS_SYMBOLIC)
1285 fprintf(ofp, "%%s");
1286 else if (f->flags & FIELD_IS_SIGNED)
1287 fprintf(ofp, "%%d");
1289 fprintf(ofp, "%%u");
1292 fprintf(ofp, "\" %% \\\n\t\t(");
1297 for (f = event->format.fields; f; f = f->next) {
1301 if (++count % 5 == 0)
1302 fprintf(ofp, "\n\t\t");
1304 if (f->flags & FIELD_IS_FLAG) {
1305 if ((count - 1) % 5 != 0) {
1306 fprintf(ofp, "\n\t\t");
1309 fprintf(ofp, "flag_str(\"");
1310 fprintf(ofp, "%s__%s\", ", event->system,
1312 fprintf(ofp, "\"%s\", %s)", f->name,
1314 } else if (f->flags & FIELD_IS_SYMBOLIC) {
1315 if ((count - 1) % 5 != 0) {
1316 fprintf(ofp, "\n\t\t");
1319 fprintf(ofp, "symbol_str(\"");
1320 fprintf(ofp, "%s__%s\", ", event->system,
1322 fprintf(ofp, "\"%s\", %s)", f->name,
1325 fprintf(ofp, "%s", f->name);
1328 fprintf(ofp, ")\n\n");
1330 fprintf(ofp, "\t\tfor node in common_callchain:");
1331 fprintf(ofp, "\n\t\t\tif 'sym' in node:");
1332 fprintf(ofp, "\n\t\t\t\tprint \"\\t[%%x] %%s\" %% (node['ip'], node['sym']['name'])");
1333 fprintf(ofp, "\n\t\t\telse:");
1334 fprintf(ofp, "\n\t\t\t\tprint \"\t[%%x]\" %% (node['ip'])\n\n");
1335 fprintf(ofp, "\t\tprint \"\\n\"\n\n");
1339 fprintf(ofp, "def trace_unhandled(event_name, context, "
1340 "event_fields_dict):\n");
1342 fprintf(ofp, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
1343 "for k,v in sorted(event_fields_dict.items())])\n\n");
1345 fprintf(ofp, "def print_header("
1346 "event_name, cpu, secs, nsecs, pid, comm):\n"
1347 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
1348 "(event_name, cpu, secs, nsecs, pid, comm),\n");
1352 fprintf(stderr, "generated Python script: %s\n", fname);
1357 struct scripting_ops python_scripting_ops = {
1359 .start_script = python_start_script,
1360 .flush_script = python_flush_script,
1361 .stop_script = python_stop_script,
1362 .process_event = python_process_event,
1363 .process_stat = python_process_stat,
1364 .process_stat_interval = python_process_stat_interval,
1365 .generate_script = python_generate_script,