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
30 #include <linux/bitmap.h>
31 #include <linux/compiler.h>
32 #include <linux/time64.h>
34 #include "../build-id.h"
35 #include "../counts.h"
38 #include "../callchain.h"
41 #include "../thread.h"
43 #include "../machine.h"
44 #include "../db-export.h"
45 #include "../thread-stack.h"
46 #include "../trace-event.h"
47 #include "../call-path.h"
50 #include "thread_map.h"
51 #include "print_binary.h"
53 #include "mem-events.h"
55 #if PY_MAJOR_VERSION < 3
56 #define _PyUnicode_FromString(arg) \
57 PyString_FromString(arg)
58 #define _PyUnicode_FromStringAndSize(arg1, arg2) \
59 PyString_FromStringAndSize((arg1), (arg2))
60 #define _PyBytes_FromStringAndSize(arg1, arg2) \
61 PyString_FromStringAndSize((arg1), (arg2))
62 #define _PyLong_FromLong(arg) \
64 #define _PyLong_AsLong(arg) \
66 #define _PyCapsule_New(arg1, arg2, arg3) \
67 PyCObject_FromVoidPtr((arg1), (arg2))
69 PyMODINIT_FUNC initperf_trace_context(void);
71 #define _PyUnicode_FromString(arg) \
72 PyUnicode_FromString(arg)
73 #define _PyUnicode_FromStringAndSize(arg1, arg2) \
74 PyUnicode_FromStringAndSize((arg1), (arg2))
75 #define _PyBytes_FromStringAndSize(arg1, arg2) \
76 PyBytes_FromStringAndSize((arg1), (arg2))
77 #define _PyLong_FromLong(arg) \
79 #define _PyLong_AsLong(arg) \
81 #define _PyCapsule_New(arg1, arg2, arg3) \
82 PyCapsule_New((arg1), (arg2), (arg3))
84 PyMODINIT_FUNC PyInit_perf_trace_context(void);
87 #define TRACE_EVENT_TYPE_MAX \
88 ((1 << (sizeof(unsigned short) * 8)) - 1)
90 static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
93 #define N_COMMON_FIELDS 7
95 extern struct scripting_context *scripting_context;
97 static char *cur_field_name;
98 static int zero_flag_atom;
100 static PyObject *main_module, *main_dict;
103 struct db_export dbe;
104 PyObject *evsel_handler;
105 PyObject *machine_handler;
106 PyObject *thread_handler;
107 PyObject *comm_handler;
108 PyObject *comm_thread_handler;
109 PyObject *dso_handler;
110 PyObject *symbol_handler;
111 PyObject *branch_type_handler;
112 PyObject *sample_handler;
113 PyObject *call_path_handler;
114 PyObject *call_return_handler;
115 PyObject *synth_handler;
116 PyObject *context_switch_handler;
120 static struct tables tables_global;
122 static void handler_call_die(const char *handler_name) __noreturn;
123 static void handler_call_die(const char *handler_name)
126 Py_FatalError("problem in Python trace event handler");
127 // Py_FatalError does not return
128 // but we have to make the compiler happy
133 * Insert val into into the dictionary and decrement the reference counter.
134 * This is necessary for dictionaries since PyDict_SetItemString() does not
135 * steal a reference, as opposed to PyTuple_SetItem().
137 static void pydict_set_item_string_decref(PyObject *dict, const char *key, PyObject *val)
139 PyDict_SetItemString(dict, key, val);
143 static PyObject *get_handler(const char *handler_name)
147 handler = PyDict_GetItemString(main_dict, handler_name);
148 if (handler && !PyCallable_Check(handler))
153 static int get_argument_count(PyObject *handler)
158 * The attribute for the code object is func_code in Python 2,
159 * whereas it is __code__ in Python 3.0+.
161 PyObject *code_obj = PyObject_GetAttrString(handler,
163 if (PyErr_Occurred()) {
165 code_obj = PyObject_GetAttrString(handler,
170 PyObject *arg_count_obj = PyObject_GetAttrString(code_obj,
173 arg_count = (int) _PyLong_AsLong(arg_count_obj);
174 Py_DECREF(arg_count_obj);
181 static void call_object(PyObject *handler, PyObject *args, const char *die_msg)
185 retval = PyObject_CallObject(handler, args);
187 handler_call_die(die_msg);
191 static void try_call_object(const char *handler_name, PyObject *args)
195 handler = get_handler(handler_name);
197 call_object(handler, args, handler_name);
200 static void define_value(enum tep_print_arg_type field_type,
202 const char *field_name,
203 const char *field_value,
204 const char *field_str)
206 const char *handler_name = "define_flag_value";
208 unsigned long long value;
211 if (field_type == TEP_PRINT_SYMBOL)
212 handler_name = "define_symbolic_value";
216 Py_FatalError("couldn't create Python tuple");
218 value = eval_flag(field_value);
220 PyTuple_SetItem(t, n++, _PyUnicode_FromString(ev_name));
221 PyTuple_SetItem(t, n++, _PyUnicode_FromString(field_name));
222 PyTuple_SetItem(t, n++, _PyLong_FromLong(value));
223 PyTuple_SetItem(t, n++, _PyUnicode_FromString(field_str));
225 try_call_object(handler_name, t);
230 static void define_values(enum tep_print_arg_type field_type,
231 struct tep_print_flag_sym *field,
233 const char *field_name)
235 define_value(field_type, ev_name, field_name, field->value,
239 define_values(field_type, field->next, ev_name, field_name);
242 static void define_field(enum tep_print_arg_type field_type,
244 const char *field_name,
247 const char *handler_name = "define_flag_field";
251 if (field_type == TEP_PRINT_SYMBOL)
252 handler_name = "define_symbolic_field";
254 if (field_type == TEP_PRINT_FLAGS)
259 Py_FatalError("couldn't create Python tuple");
261 PyTuple_SetItem(t, n++, _PyUnicode_FromString(ev_name));
262 PyTuple_SetItem(t, n++, _PyUnicode_FromString(field_name));
263 if (field_type == TEP_PRINT_FLAGS)
264 PyTuple_SetItem(t, n++, _PyUnicode_FromString(delim));
266 try_call_object(handler_name, t);
271 static void define_event_symbols(struct tep_event *event,
273 struct tep_print_arg *args)
278 switch (args->type) {
282 define_value(TEP_PRINT_FLAGS, ev_name, cur_field_name, "0",
286 case TEP_PRINT_FIELD:
287 free(cur_field_name);
288 cur_field_name = strdup(args->field.name);
290 case TEP_PRINT_FLAGS:
291 define_event_symbols(event, ev_name, args->flags.field);
292 define_field(TEP_PRINT_FLAGS, ev_name, cur_field_name,
294 define_values(TEP_PRINT_FLAGS, args->flags.flags, ev_name,
297 case TEP_PRINT_SYMBOL:
298 define_event_symbols(event, ev_name, args->symbol.field);
299 define_field(TEP_PRINT_SYMBOL, ev_name, cur_field_name, NULL);
300 define_values(TEP_PRINT_SYMBOL, args->symbol.symbols, ev_name,
304 case TEP_PRINT_HEX_STR:
305 define_event_symbols(event, ev_name, args->hex.field);
306 define_event_symbols(event, ev_name, args->hex.size);
308 case TEP_PRINT_INT_ARRAY:
309 define_event_symbols(event, ev_name, args->int_array.field);
310 define_event_symbols(event, ev_name, args->int_array.count);
311 define_event_symbols(event, ev_name, args->int_array.el_size);
313 case TEP_PRINT_STRING:
316 define_event_symbols(event, ev_name, args->typecast.item);
319 if (strcmp(args->op.op, ":") == 0)
321 define_event_symbols(event, ev_name, args->op.left);
322 define_event_symbols(event, ev_name, args->op.right);
325 /* gcc warns for these? */
326 case TEP_PRINT_BSTRING:
327 case TEP_PRINT_DYNAMIC_ARRAY:
328 case TEP_PRINT_DYNAMIC_ARRAY_LEN:
330 case TEP_PRINT_BITMASK:
331 /* we should warn... */
336 define_event_symbols(event, ev_name, args->next);
339 static PyObject *get_field_numeric_entry(struct tep_event *event,
340 struct tep_format_field *field, void *data)
342 bool is_array = field->flags & TEP_FIELD_IS_ARRAY;
343 PyObject *obj = NULL, *list = NULL;
344 unsigned long long val;
345 unsigned int item_size, n_items, i;
348 list = PyList_New(field->arraylen);
349 item_size = field->size / field->arraylen;
350 n_items = field->arraylen;
352 item_size = field->size;
356 for (i = 0; i < n_items; i++) {
358 val = read_size(event, data + field->offset + i * item_size,
360 if (field->flags & TEP_FIELD_IS_SIGNED) {
361 if ((long long)val >= LONG_MIN &&
362 (long long)val <= LONG_MAX)
363 obj = _PyLong_FromLong(val);
365 obj = PyLong_FromLongLong(val);
368 obj = _PyLong_FromLong(val);
370 obj = PyLong_FromUnsignedLongLong(val);
373 PyList_SET_ITEM(list, i, obj);
380 static const char *get_dsoname(struct map *map)
382 const char *dsoname = "[unknown]";
384 if (map && map->dso) {
385 if (symbol_conf.show_kernel_path && map->dso->long_name)
386 dsoname = map->dso->long_name;
388 dsoname = map->dso->name;
394 static PyObject *python_process_callchain(struct perf_sample *sample,
396 struct addr_location *al)
400 pylist = PyList_New(0);
402 Py_FatalError("couldn't create Python list");
404 if (!symbol_conf.use_callchain || !sample->callchain)
407 if (thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
409 scripting_max_stack) != 0) {
410 pr_err("Failed to resolve callchain. Skipping\n");
413 callchain_cursor_commit(&callchain_cursor);
418 struct callchain_cursor_node *node;
419 node = callchain_cursor_current(&callchain_cursor);
423 pyelem = PyDict_New();
425 Py_FatalError("couldn't create Python dictionary");
428 pydict_set_item_string_decref(pyelem, "ip",
429 PyLong_FromUnsignedLongLong(node->ip));
432 PyObject *pysym = PyDict_New();
434 Py_FatalError("couldn't create Python dictionary");
435 pydict_set_item_string_decref(pysym, "start",
436 PyLong_FromUnsignedLongLong(node->ms.sym->start));
437 pydict_set_item_string_decref(pysym, "end",
438 PyLong_FromUnsignedLongLong(node->ms.sym->end));
439 pydict_set_item_string_decref(pysym, "binding",
440 _PyLong_FromLong(node->ms.sym->binding));
441 pydict_set_item_string_decref(pysym, "name",
442 _PyUnicode_FromStringAndSize(node->ms.sym->name,
443 node->ms.sym->namelen));
444 pydict_set_item_string_decref(pyelem, "sym", pysym);
448 const char *dsoname = get_dsoname(node->ms.map);
450 pydict_set_item_string_decref(pyelem, "dso",
451 _PyUnicode_FromString(dsoname));
454 callchain_cursor_advance(&callchain_cursor);
455 PyList_Append(pylist, pyelem);
463 static PyObject *python_process_brstack(struct perf_sample *sample,
464 struct thread *thread)
466 struct branch_stack *br = sample->branch_stack;
467 struct branch_entry *entries = perf_sample__branch_entries(sample);
471 pylist = PyList_New(0);
473 Py_FatalError("couldn't create Python list");
478 for (i = 0; i < br->nr; i++) {
480 struct addr_location al;
483 pyelem = PyDict_New();
485 Py_FatalError("couldn't create Python dictionary");
487 pydict_set_item_string_decref(pyelem, "from",
488 PyLong_FromUnsignedLongLong(entries[i].from));
489 pydict_set_item_string_decref(pyelem, "to",
490 PyLong_FromUnsignedLongLong(entries[i].to));
491 pydict_set_item_string_decref(pyelem, "mispred",
492 PyBool_FromLong(entries[i].flags.mispred));
493 pydict_set_item_string_decref(pyelem, "predicted",
494 PyBool_FromLong(entries[i].flags.predicted));
495 pydict_set_item_string_decref(pyelem, "in_tx",
496 PyBool_FromLong(entries[i].flags.in_tx));
497 pydict_set_item_string_decref(pyelem, "abort",
498 PyBool_FromLong(entries[i].flags.abort));
499 pydict_set_item_string_decref(pyelem, "cycles",
500 PyLong_FromUnsignedLongLong(entries[i].flags.cycles));
502 thread__find_map_fb(thread, sample->cpumode,
503 entries[i].from, &al);
504 dsoname = get_dsoname(al.map);
505 pydict_set_item_string_decref(pyelem, "from_dsoname",
506 _PyUnicode_FromString(dsoname));
508 thread__find_map_fb(thread, sample->cpumode,
510 dsoname = get_dsoname(al.map);
511 pydict_set_item_string_decref(pyelem, "to_dsoname",
512 _PyUnicode_FromString(dsoname));
514 PyList_Append(pylist, pyelem);
522 static unsigned long get_offset(struct symbol *sym, struct addr_location *al)
524 unsigned long offset;
526 if (al->addr < sym->end)
527 offset = al->addr - sym->start;
529 offset = al->addr - al->map->start - sym->start;
534 static int get_symoff(struct symbol *sym, struct addr_location *al,
535 bool print_off, char *bf, int size)
537 unsigned long offset;
539 if (!sym || !sym->name[0])
540 return scnprintf(bf, size, "%s", "[unknown]");
543 return scnprintf(bf, size, "%s", sym->name);
545 offset = get_offset(sym, al);
547 return scnprintf(bf, size, "%s+0x%x", sym->name, offset);
550 static int get_br_mspred(struct branch_flags *flags, char *bf, int size)
552 if (!flags->mispred && !flags->predicted)
553 return scnprintf(bf, size, "%s", "-");
556 return scnprintf(bf, size, "%s", "M");
558 return scnprintf(bf, size, "%s", "P");
561 static PyObject *python_process_brstacksym(struct perf_sample *sample,
562 struct thread *thread)
564 struct branch_stack *br = sample->branch_stack;
565 struct branch_entry *entries = perf_sample__branch_entries(sample);
569 struct addr_location al;
571 pylist = PyList_New(0);
573 Py_FatalError("couldn't create Python list");
578 for (i = 0; i < br->nr; i++) {
581 pyelem = PyDict_New();
583 Py_FatalError("couldn't create Python dictionary");
585 thread__find_symbol_fb(thread, sample->cpumode,
586 entries[i].from, &al);
587 get_symoff(al.sym, &al, true, bf, sizeof(bf));
588 pydict_set_item_string_decref(pyelem, "from",
589 _PyUnicode_FromString(bf));
591 thread__find_symbol_fb(thread, sample->cpumode,
593 get_symoff(al.sym, &al, true, bf, sizeof(bf));
594 pydict_set_item_string_decref(pyelem, "to",
595 _PyUnicode_FromString(bf));
597 get_br_mspred(&entries[i].flags, bf, sizeof(bf));
598 pydict_set_item_string_decref(pyelem, "pred",
599 _PyUnicode_FromString(bf));
601 if (entries[i].flags.in_tx) {
602 pydict_set_item_string_decref(pyelem, "in_tx",
603 _PyUnicode_FromString("X"));
605 pydict_set_item_string_decref(pyelem, "in_tx",
606 _PyUnicode_FromString("-"));
609 if (entries[i].flags.abort) {
610 pydict_set_item_string_decref(pyelem, "abort",
611 _PyUnicode_FromString("A"));
613 pydict_set_item_string_decref(pyelem, "abort",
614 _PyUnicode_FromString("-"));
617 PyList_Append(pylist, pyelem);
625 static PyObject *get_sample_value_as_tuple(struct sample_read_value *value)
631 Py_FatalError("couldn't create Python tuple");
632 PyTuple_SetItem(t, 0, PyLong_FromUnsignedLongLong(value->id));
633 PyTuple_SetItem(t, 1, PyLong_FromUnsignedLongLong(value->value));
637 static void set_sample_read_in_dict(PyObject *dict_sample,
638 struct perf_sample *sample,
641 u64 read_format = evsel->core.attr.read_format;
645 if (read_format & PERF_FORMAT_TOTAL_TIME_ENABLED) {
646 pydict_set_item_string_decref(dict_sample, "time_enabled",
647 PyLong_FromUnsignedLongLong(sample->read.time_enabled));
650 if (read_format & PERF_FORMAT_TOTAL_TIME_RUNNING) {
651 pydict_set_item_string_decref(dict_sample, "time_running",
652 PyLong_FromUnsignedLongLong(sample->read.time_running));
655 if (read_format & PERF_FORMAT_GROUP)
656 values = PyList_New(sample->read.group.nr);
658 values = PyList_New(1);
661 Py_FatalError("couldn't create Python list");
663 if (read_format & PERF_FORMAT_GROUP) {
664 for (i = 0; i < sample->read.group.nr; i++) {
665 PyObject *t = get_sample_value_as_tuple(&sample->read.group.values[i]);
666 PyList_SET_ITEM(values, i, t);
669 PyObject *t = get_sample_value_as_tuple(&sample->read.one);
670 PyList_SET_ITEM(values, 0, t);
672 pydict_set_item_string_decref(dict_sample, "values", values);
675 static void set_sample_datasrc_in_dict(PyObject *dict,
676 struct perf_sample *sample)
678 struct mem_info mi = { .data_src.val = sample->data_src };
681 pydict_set_item_string_decref(dict, "datasrc",
682 PyLong_FromUnsignedLongLong(sample->data_src));
684 perf_script__meminfo_scnprintf(decode, 100, &mi);
686 pydict_set_item_string_decref(dict, "datasrc_decode",
687 _PyUnicode_FromString(decode));
690 static int regs_map(struct regs_dump *regs, uint64_t mask, char *bf, int size)
692 unsigned int i = 0, r;
697 if (!regs || !regs->regs)
700 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
701 u64 val = regs->regs[i++];
703 printed += scnprintf(bf + printed, size - printed,
704 "%5s:0x%" PRIx64 " ",
705 perf_reg_name(r), val);
711 static void set_regs_in_dict(PyObject *dict,
712 struct perf_sample *sample,
715 struct perf_event_attr *attr = &evsel->core.attr;
718 regs_map(&sample->intr_regs, attr->sample_regs_intr, bf, sizeof(bf));
720 pydict_set_item_string_decref(dict, "iregs",
721 _PyUnicode_FromString(bf));
723 regs_map(&sample->user_regs, attr->sample_regs_user, bf, sizeof(bf));
725 pydict_set_item_string_decref(dict, "uregs",
726 _PyUnicode_FromString(bf));
729 static void set_sym_in_dict(PyObject *dict, struct addr_location *al,
730 const char *dso_field, const char *sym_field,
731 const char *symoff_field)
734 pydict_set_item_string_decref(dict, dso_field,
735 _PyUnicode_FromString(al->map->dso->name));
738 pydict_set_item_string_decref(dict, sym_field,
739 _PyUnicode_FromString(al->sym->name));
740 pydict_set_item_string_decref(dict, symoff_field,
741 PyLong_FromUnsignedLong(get_offset(al->sym, al)));
745 static void set_sample_flags(PyObject *dict, u32 flags)
747 const char *ch = PERF_IP_FLAG_CHARS;
750 for (p = str; *ch; ch++, flags >>= 1) {
755 pydict_set_item_string_decref(dict, "flags", _PyUnicode_FromString(str));
758 static void python_process_sample_flags(struct perf_sample *sample, PyObject *dict_sample)
760 char flags_disp[SAMPLE_FLAGS_BUF_SIZE];
762 set_sample_flags(dict_sample, sample->flags);
763 perf_sample__sprintf_flags(sample->flags, flags_disp, sizeof(flags_disp));
764 pydict_set_item_string_decref(dict_sample, "flags_disp",
765 _PyUnicode_FromString(flags_disp));
768 static PyObject *get_perf_sample_dict(struct perf_sample *sample,
770 struct addr_location *al,
771 struct addr_location *addr_al,
774 PyObject *dict, *dict_sample, *brstack, *brstacksym;
778 Py_FatalError("couldn't create Python dictionary");
780 dict_sample = PyDict_New();
782 Py_FatalError("couldn't create Python dictionary");
784 pydict_set_item_string_decref(dict, "ev_name", _PyUnicode_FromString(evsel__name(evsel)));
785 pydict_set_item_string_decref(dict, "attr", _PyBytes_FromStringAndSize((const char *)&evsel->core.attr, sizeof(evsel->core.attr)));
787 pydict_set_item_string_decref(dict_sample, "pid",
788 _PyLong_FromLong(sample->pid));
789 pydict_set_item_string_decref(dict_sample, "tid",
790 _PyLong_FromLong(sample->tid));
791 pydict_set_item_string_decref(dict_sample, "cpu",
792 _PyLong_FromLong(sample->cpu));
793 pydict_set_item_string_decref(dict_sample, "ip",
794 PyLong_FromUnsignedLongLong(sample->ip));
795 pydict_set_item_string_decref(dict_sample, "time",
796 PyLong_FromUnsignedLongLong(sample->time));
797 pydict_set_item_string_decref(dict_sample, "period",
798 PyLong_FromUnsignedLongLong(sample->period));
799 pydict_set_item_string_decref(dict_sample, "phys_addr",
800 PyLong_FromUnsignedLongLong(sample->phys_addr));
801 pydict_set_item_string_decref(dict_sample, "addr",
802 PyLong_FromUnsignedLongLong(sample->addr));
803 set_sample_read_in_dict(dict_sample, sample, evsel);
804 pydict_set_item_string_decref(dict_sample, "weight",
805 PyLong_FromUnsignedLongLong(sample->weight));
806 pydict_set_item_string_decref(dict_sample, "transaction",
807 PyLong_FromUnsignedLongLong(sample->transaction));
808 set_sample_datasrc_in_dict(dict_sample, sample);
809 pydict_set_item_string_decref(dict, "sample", dict_sample);
811 pydict_set_item_string_decref(dict, "raw_buf", _PyBytes_FromStringAndSize(
812 (const char *)sample->raw_data, sample->raw_size));
813 pydict_set_item_string_decref(dict, "comm",
814 _PyUnicode_FromString(thread__comm_str(al->thread)));
815 set_sym_in_dict(dict, al, "dso", "symbol", "symoff");
817 pydict_set_item_string_decref(dict, "callchain", callchain);
819 brstack = python_process_brstack(sample, al->thread);
820 pydict_set_item_string_decref(dict, "brstack", brstack);
822 brstacksym = python_process_brstacksym(sample, al->thread);
823 pydict_set_item_string_decref(dict, "brstacksym", brstacksym);
825 pydict_set_item_string_decref(dict_sample, "cpumode",
826 _PyLong_FromLong((unsigned long)sample->cpumode));
829 pydict_set_item_string_decref(dict_sample, "addr_correlates_sym",
831 set_sym_in_dict(dict_sample, addr_al, "addr_dso", "addr_symbol", "addr_symoff");
835 python_process_sample_flags(sample, dict_sample);
837 /* Instructions per cycle (IPC) */
838 if (sample->insn_cnt && sample->cyc_cnt) {
839 pydict_set_item_string_decref(dict_sample, "insn_cnt",
840 PyLong_FromUnsignedLongLong(sample->insn_cnt));
841 pydict_set_item_string_decref(dict_sample, "cyc_cnt",
842 PyLong_FromUnsignedLongLong(sample->cyc_cnt));
845 set_regs_in_dict(dict, sample, evsel);
850 static void python_process_tracepoint(struct perf_sample *sample,
852 struct addr_location *al,
853 struct addr_location *addr_al)
855 struct tep_event *event = evsel->tp_format;
856 PyObject *handler, *context, *t, *obj = NULL, *callchain;
857 PyObject *dict = NULL, *all_entries_dict = NULL;
858 static char handler_name[256];
859 struct tep_format_field *field;
863 int cpu = sample->cpu;
864 void *data = sample->raw_data;
865 unsigned long long nsecs = sample->time;
866 const char *comm = thread__comm_str(al->thread);
867 const char *default_handler_name = "trace_unhandled";
870 snprintf(handler_name, sizeof(handler_name),
871 "ug! no event found for type %" PRIu64, (u64)evsel->core.attr.config);
872 Py_FatalError(handler_name);
875 pid = raw_field_value(event, "common_pid", data);
877 sprintf(handler_name, "%s__%s", event->system, event->name);
879 if (!test_and_set_bit(event->id, events_defined))
880 define_event_symbols(event, handler_name, event->print_fmt.args);
882 handler = get_handler(handler_name);
884 handler = get_handler(default_handler_name);
889 Py_FatalError("couldn't create Python dict");
892 t = PyTuple_New(MAX_FIELDS);
894 Py_FatalError("couldn't create Python tuple");
897 s = nsecs / NSEC_PER_SEC;
898 ns = nsecs - s * NSEC_PER_SEC;
900 context = _PyCapsule_New(scripting_context, NULL, NULL);
902 PyTuple_SetItem(t, n++, _PyUnicode_FromString(handler_name));
903 PyTuple_SetItem(t, n++, context);
906 callchain = python_process_callchain(sample, evsel, al);
907 /* Need an additional reference for the perf_sample dict */
908 Py_INCREF(callchain);
911 PyTuple_SetItem(t, n++, _PyLong_FromLong(cpu));
912 PyTuple_SetItem(t, n++, _PyLong_FromLong(s));
913 PyTuple_SetItem(t, n++, _PyLong_FromLong(ns));
914 PyTuple_SetItem(t, n++, _PyLong_FromLong(pid));
915 PyTuple_SetItem(t, n++, _PyUnicode_FromString(comm));
916 PyTuple_SetItem(t, n++, callchain);
918 pydict_set_item_string_decref(dict, "common_cpu", _PyLong_FromLong(cpu));
919 pydict_set_item_string_decref(dict, "common_s", _PyLong_FromLong(s));
920 pydict_set_item_string_decref(dict, "common_ns", _PyLong_FromLong(ns));
921 pydict_set_item_string_decref(dict, "common_pid", _PyLong_FromLong(pid));
922 pydict_set_item_string_decref(dict, "common_comm", _PyUnicode_FromString(comm));
923 pydict_set_item_string_decref(dict, "common_callchain", callchain);
925 for (field = event->format.fields; field; field = field->next) {
926 unsigned int offset, len;
927 unsigned long long val;
929 if (field->flags & TEP_FIELD_IS_ARRAY) {
930 offset = field->offset;
932 if (field->flags & TEP_FIELD_IS_DYNAMIC) {
933 val = tep_read_number(scripting_context->pevent,
939 if (field->flags & TEP_FIELD_IS_STRING &&
940 is_printable_array(data + offset, len)) {
941 obj = _PyUnicode_FromString((char *) data + offset);
943 obj = PyByteArray_FromStringAndSize((const char *) data + offset, len);
944 field->flags &= ~TEP_FIELD_IS_STRING;
946 } else { /* FIELD_IS_NUMERIC */
947 obj = get_field_numeric_entry(event, field, data);
950 PyTuple_SetItem(t, n++, obj);
952 pydict_set_item_string_decref(dict, field->name, obj);
957 PyTuple_SetItem(t, n++, dict);
959 if (get_argument_count(handler) == (int) n + 1) {
960 all_entries_dict = get_perf_sample_dict(sample, evsel, al, addr_al,
962 PyTuple_SetItem(t, n++, all_entries_dict);
964 Py_DECREF(callchain);
967 if (_PyTuple_Resize(&t, n) == -1)
968 Py_FatalError("error resizing Python tuple");
971 call_object(handler, t, handler_name);
973 call_object(handler, t, default_handler_name);
978 static PyObject *tuple_new(unsigned int sz)
984 Py_FatalError("couldn't create Python tuple");
988 static int tuple_set_s64(PyObject *t, unsigned int pos, s64 val)
990 #if BITS_PER_LONG == 64
991 return PyTuple_SetItem(t, pos, _PyLong_FromLong(val));
993 #if BITS_PER_LONG == 32
994 return PyTuple_SetItem(t, pos, PyLong_FromLongLong(val));
999 * Databases support only signed 64-bit numbers, so even though we are
1000 * exporting a u64, it must be as s64.
1002 #define tuple_set_d64 tuple_set_s64
1004 static int tuple_set_u64(PyObject *t, unsigned int pos, u64 val)
1006 #if BITS_PER_LONG == 64
1007 return PyTuple_SetItem(t, pos, PyLong_FromUnsignedLong(val));
1009 #if BITS_PER_LONG == 32
1010 return PyTuple_SetItem(t, pos, PyLong_FromUnsignedLongLong(val));
1014 static int tuple_set_u32(PyObject *t, unsigned int pos, u32 val)
1016 return PyTuple_SetItem(t, pos, PyLong_FromUnsignedLong(val));
1019 static int tuple_set_s32(PyObject *t, unsigned int pos, s32 val)
1021 return PyTuple_SetItem(t, pos, _PyLong_FromLong(val));
1024 static int tuple_set_bool(PyObject *t, unsigned int pos, bool val)
1026 return PyTuple_SetItem(t, pos, PyBool_FromLong(val));
1029 static int tuple_set_string(PyObject *t, unsigned int pos, const char *s)
1031 return PyTuple_SetItem(t, pos, _PyUnicode_FromString(s));
1034 static int tuple_set_bytes(PyObject *t, unsigned int pos, void *bytes,
1037 return PyTuple_SetItem(t, pos, _PyBytes_FromStringAndSize(bytes, sz));
1040 static int python_export_evsel(struct db_export *dbe, struct evsel *evsel)
1042 struct tables *tables = container_of(dbe, struct tables, dbe);
1047 tuple_set_d64(t, 0, evsel->db_id);
1048 tuple_set_string(t, 1, evsel__name(evsel));
1050 call_object(tables->evsel_handler, t, "evsel_table");
1057 static int python_export_machine(struct db_export *dbe,
1058 struct machine *machine)
1060 struct tables *tables = container_of(dbe, struct tables, dbe);
1065 tuple_set_d64(t, 0, machine->db_id);
1066 tuple_set_s32(t, 1, machine->pid);
1067 tuple_set_string(t, 2, machine->root_dir ? machine->root_dir : "");
1069 call_object(tables->machine_handler, t, "machine_table");
1076 static int python_export_thread(struct db_export *dbe, struct thread *thread,
1077 u64 main_thread_db_id, struct machine *machine)
1079 struct tables *tables = container_of(dbe, struct tables, dbe);
1084 tuple_set_d64(t, 0, thread->db_id);
1085 tuple_set_d64(t, 1, machine->db_id);
1086 tuple_set_d64(t, 2, main_thread_db_id);
1087 tuple_set_s32(t, 3, thread->pid_);
1088 tuple_set_s32(t, 4, thread->tid);
1090 call_object(tables->thread_handler, t, "thread_table");
1097 static int python_export_comm(struct db_export *dbe, struct comm *comm,
1098 struct thread *thread)
1100 struct tables *tables = container_of(dbe, struct tables, dbe);
1105 tuple_set_d64(t, 0, comm->db_id);
1106 tuple_set_string(t, 1, comm__str(comm));
1107 tuple_set_d64(t, 2, thread->db_id);
1108 tuple_set_d64(t, 3, comm->start);
1109 tuple_set_s32(t, 4, comm->exec);
1111 call_object(tables->comm_handler, t, "comm_table");
1118 static int python_export_comm_thread(struct db_export *dbe, u64 db_id,
1119 struct comm *comm, struct thread *thread)
1121 struct tables *tables = container_of(dbe, struct tables, dbe);
1126 tuple_set_d64(t, 0, db_id);
1127 tuple_set_d64(t, 1, comm->db_id);
1128 tuple_set_d64(t, 2, thread->db_id);
1130 call_object(tables->comm_thread_handler, t, "comm_thread_table");
1137 static int python_export_dso(struct db_export *dbe, struct dso *dso,
1138 struct machine *machine)
1140 struct tables *tables = container_of(dbe, struct tables, dbe);
1141 char sbuild_id[SBUILD_ID_SIZE];
1144 build_id__sprintf(&dso->bid, sbuild_id);
1148 tuple_set_d64(t, 0, dso->db_id);
1149 tuple_set_d64(t, 1, machine->db_id);
1150 tuple_set_string(t, 2, dso->short_name);
1151 tuple_set_string(t, 3, dso->long_name);
1152 tuple_set_string(t, 4, sbuild_id);
1154 call_object(tables->dso_handler, t, "dso_table");
1161 static int python_export_symbol(struct db_export *dbe, struct symbol *sym,
1164 struct tables *tables = container_of(dbe, struct tables, dbe);
1165 u64 *sym_db_id = symbol__priv(sym);
1170 tuple_set_d64(t, 0, *sym_db_id);
1171 tuple_set_d64(t, 1, dso->db_id);
1172 tuple_set_d64(t, 2, sym->start);
1173 tuple_set_d64(t, 3, sym->end);
1174 tuple_set_s32(t, 4, sym->binding);
1175 tuple_set_string(t, 5, sym->name);
1177 call_object(tables->symbol_handler, t, "symbol_table");
1184 static int python_export_branch_type(struct db_export *dbe, u32 branch_type,
1187 struct tables *tables = container_of(dbe, struct tables, dbe);
1192 tuple_set_s32(t, 0, branch_type);
1193 tuple_set_string(t, 1, name);
1195 call_object(tables->branch_type_handler, t, "branch_type_table");
1202 static void python_export_sample_table(struct db_export *dbe,
1203 struct export_sample *es)
1205 struct tables *tables = container_of(dbe, struct tables, dbe);
1210 tuple_set_d64(t, 0, es->db_id);
1211 tuple_set_d64(t, 1, es->evsel->db_id);
1212 tuple_set_d64(t, 2, es->al->maps->machine->db_id);
1213 tuple_set_d64(t, 3, es->al->thread->db_id);
1214 tuple_set_d64(t, 4, es->comm_db_id);
1215 tuple_set_d64(t, 5, es->dso_db_id);
1216 tuple_set_d64(t, 6, es->sym_db_id);
1217 tuple_set_d64(t, 7, es->offset);
1218 tuple_set_d64(t, 8, es->sample->ip);
1219 tuple_set_d64(t, 9, es->sample->time);
1220 tuple_set_s32(t, 10, es->sample->cpu);
1221 tuple_set_d64(t, 11, es->addr_dso_db_id);
1222 tuple_set_d64(t, 12, es->addr_sym_db_id);
1223 tuple_set_d64(t, 13, es->addr_offset);
1224 tuple_set_d64(t, 14, es->sample->addr);
1225 tuple_set_d64(t, 15, es->sample->period);
1226 tuple_set_d64(t, 16, es->sample->weight);
1227 tuple_set_d64(t, 17, es->sample->transaction);
1228 tuple_set_d64(t, 18, es->sample->data_src);
1229 tuple_set_s32(t, 19, es->sample->flags & PERF_BRANCH_MASK);
1230 tuple_set_s32(t, 20, !!(es->sample->flags & PERF_IP_FLAG_IN_TX));
1231 tuple_set_d64(t, 21, es->call_path_id);
1232 tuple_set_d64(t, 22, es->sample->insn_cnt);
1233 tuple_set_d64(t, 23, es->sample->cyc_cnt);
1235 call_object(tables->sample_handler, t, "sample_table");
1240 static void python_export_synth(struct db_export *dbe, struct export_sample *es)
1242 struct tables *tables = container_of(dbe, struct tables, dbe);
1247 tuple_set_d64(t, 0, es->db_id);
1248 tuple_set_d64(t, 1, es->evsel->core.attr.config);
1249 tuple_set_bytes(t, 2, es->sample->raw_data, es->sample->raw_size);
1251 call_object(tables->synth_handler, t, "synth_data");
1256 static int python_export_sample(struct db_export *dbe,
1257 struct export_sample *es)
1259 struct tables *tables = container_of(dbe, struct tables, dbe);
1261 python_export_sample_table(dbe, es);
1263 if (es->evsel->core.attr.type == PERF_TYPE_SYNTH && tables->synth_handler)
1264 python_export_synth(dbe, es);
1269 static int python_export_call_path(struct db_export *dbe, struct call_path *cp)
1271 struct tables *tables = container_of(dbe, struct tables, dbe);
1273 u64 parent_db_id, sym_db_id;
1275 parent_db_id = cp->parent ? cp->parent->db_id : 0;
1276 sym_db_id = cp->sym ? *(u64 *)symbol__priv(cp->sym) : 0;
1280 tuple_set_d64(t, 0, cp->db_id);
1281 tuple_set_d64(t, 1, parent_db_id);
1282 tuple_set_d64(t, 2, sym_db_id);
1283 tuple_set_d64(t, 3, cp->ip);
1285 call_object(tables->call_path_handler, t, "call_path_table");
1292 static int python_export_call_return(struct db_export *dbe,
1293 struct call_return *cr)
1295 struct tables *tables = container_of(dbe, struct tables, dbe);
1296 u64 comm_db_id = cr->comm ? cr->comm->db_id : 0;
1301 tuple_set_d64(t, 0, cr->db_id);
1302 tuple_set_d64(t, 1, cr->thread->db_id);
1303 tuple_set_d64(t, 2, comm_db_id);
1304 tuple_set_d64(t, 3, cr->cp->db_id);
1305 tuple_set_d64(t, 4, cr->call_time);
1306 tuple_set_d64(t, 5, cr->return_time);
1307 tuple_set_d64(t, 6, cr->branch_count);
1308 tuple_set_d64(t, 7, cr->call_ref);
1309 tuple_set_d64(t, 8, cr->return_ref);
1310 tuple_set_d64(t, 9, cr->cp->parent->db_id);
1311 tuple_set_s32(t, 10, cr->flags);
1312 tuple_set_d64(t, 11, cr->parent_db_id);
1313 tuple_set_d64(t, 12, cr->insn_count);
1314 tuple_set_d64(t, 13, cr->cyc_count);
1316 call_object(tables->call_return_handler, t, "call_return_table");
1323 static int python_export_context_switch(struct db_export *dbe, u64 db_id,
1324 struct machine *machine,
1325 struct perf_sample *sample,
1326 u64 th_out_id, u64 comm_out_id,
1327 u64 th_in_id, u64 comm_in_id, int flags)
1329 struct tables *tables = container_of(dbe, struct tables, dbe);
1334 tuple_set_d64(t, 0, db_id);
1335 tuple_set_d64(t, 1, machine->db_id);
1336 tuple_set_d64(t, 2, sample->time);
1337 tuple_set_s32(t, 3, sample->cpu);
1338 tuple_set_d64(t, 4, th_out_id);
1339 tuple_set_d64(t, 5, comm_out_id);
1340 tuple_set_d64(t, 6, th_in_id);
1341 tuple_set_d64(t, 7, comm_in_id);
1342 tuple_set_s32(t, 8, flags);
1344 call_object(tables->context_switch_handler, t, "context_switch");
1351 static int python_process_call_return(struct call_return *cr, u64 *parent_db_id,
1354 struct db_export *dbe = data;
1356 return db_export__call_return(dbe, cr, parent_db_id);
1359 static void python_process_general_event(struct perf_sample *sample,
1360 struct evsel *evsel,
1361 struct addr_location *al,
1362 struct addr_location *addr_al)
1364 PyObject *handler, *t, *dict, *callchain;
1365 static char handler_name[64];
1368 snprintf(handler_name, sizeof(handler_name), "%s", "process_event");
1370 handler = get_handler(handler_name);
1375 * Use the MAX_FIELDS to make the function expandable, though
1376 * currently there is only one item for the tuple.
1378 t = PyTuple_New(MAX_FIELDS);
1380 Py_FatalError("couldn't create Python tuple");
1383 callchain = python_process_callchain(sample, evsel, al);
1384 dict = get_perf_sample_dict(sample, evsel, al, addr_al, callchain);
1386 PyTuple_SetItem(t, n++, dict);
1387 if (_PyTuple_Resize(&t, n) == -1)
1388 Py_FatalError("error resizing Python tuple");
1390 call_object(handler, t, handler_name);
1395 static void python_process_event(union perf_event *event,
1396 struct perf_sample *sample,
1397 struct evsel *evsel,
1398 struct addr_location *al,
1399 struct addr_location *addr_al)
1401 struct tables *tables = &tables_global;
1403 scripting_context__update(scripting_context, event, sample, evsel, al, addr_al);
1405 switch (evsel->core.attr.type) {
1406 case PERF_TYPE_TRACEPOINT:
1407 python_process_tracepoint(sample, evsel, al, addr_al);
1409 /* Reserve for future process_hw/sw/raw APIs */
1411 if (tables->db_export_mode)
1412 db_export__sample(&tables->dbe, event, sample, evsel, al, addr_al);
1414 python_process_general_event(sample, evsel, al, addr_al);
1418 static void python_do_process_switch(union perf_event *event,
1419 struct perf_sample *sample,
1420 struct machine *machine)
1422 const char *handler_name = "context_switch";
1423 bool out = event->header.misc & PERF_RECORD_MISC_SWITCH_OUT;
1424 bool out_preempt = out && (event->header.misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT);
1425 pid_t np_pid = -1, np_tid = -1;
1426 PyObject *handler, *t;
1428 handler = get_handler(handler_name);
1432 if (event->header.type == PERF_RECORD_SWITCH_CPU_WIDE) {
1433 np_pid = event->context_switch.next_prev_pid;
1434 np_tid = event->context_switch.next_prev_tid;
1441 tuple_set_u64(t, 0, sample->time);
1442 tuple_set_s32(t, 1, sample->cpu);
1443 tuple_set_s32(t, 2, sample->pid);
1444 tuple_set_s32(t, 3, sample->tid);
1445 tuple_set_s32(t, 4, np_pid);
1446 tuple_set_s32(t, 5, np_tid);
1447 tuple_set_s32(t, 6, machine->pid);
1448 tuple_set_bool(t, 7, out);
1449 tuple_set_bool(t, 8, out_preempt);
1451 call_object(handler, t, handler_name);
1456 static void python_process_switch(union perf_event *event,
1457 struct perf_sample *sample,
1458 struct machine *machine)
1460 struct tables *tables = &tables_global;
1462 if (tables->db_export_mode)
1463 db_export__switch(&tables->dbe, event, sample, machine);
1465 python_do_process_switch(event, sample, machine);
1468 static void python_process_auxtrace_error(struct perf_session *session __maybe_unused,
1469 union perf_event *event)
1471 struct perf_record_auxtrace_error *e = &event->auxtrace_error;
1472 u8 cpumode = e->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
1473 const char *handler_name = "auxtrace_error";
1474 unsigned long long tm = e->time;
1475 const char *msg = e->msg;
1476 PyObject *handler, *t;
1478 handler = get_handler(handler_name);
1484 msg = (const char *)&e->time;
1489 tuple_set_u32(t, 0, e->type);
1490 tuple_set_u32(t, 1, e->code);
1491 tuple_set_s32(t, 2, e->cpu);
1492 tuple_set_s32(t, 3, e->pid);
1493 tuple_set_s32(t, 4, e->tid);
1494 tuple_set_u64(t, 5, e->ip);
1495 tuple_set_u64(t, 6, tm);
1496 tuple_set_string(t, 7, msg);
1497 tuple_set_u32(t, 8, cpumode);
1499 call_object(handler, t, handler_name);
1504 static void get_handler_name(char *str, size_t size,
1505 struct evsel *evsel)
1509 scnprintf(str, size, "stat__%s", evsel__name(evsel));
1511 while ((p = strchr(p, ':'))) {
1518 process_stat(struct evsel *counter, int cpu, int thread, u64 tstamp,
1519 struct perf_counts_values *count)
1521 PyObject *handler, *t;
1522 static char handler_name[256];
1525 t = PyTuple_New(MAX_FIELDS);
1527 Py_FatalError("couldn't create Python tuple");
1529 get_handler_name(handler_name, sizeof(handler_name),
1532 handler = get_handler(handler_name);
1534 pr_debug("can't find python handler %s\n", handler_name);
1538 PyTuple_SetItem(t, n++, _PyLong_FromLong(cpu));
1539 PyTuple_SetItem(t, n++, _PyLong_FromLong(thread));
1541 tuple_set_u64(t, n++, tstamp);
1542 tuple_set_u64(t, n++, count->val);
1543 tuple_set_u64(t, n++, count->ena);
1544 tuple_set_u64(t, n++, count->run);
1546 if (_PyTuple_Resize(&t, n) == -1)
1547 Py_FatalError("error resizing Python tuple");
1549 call_object(handler, t, handler_name);
1554 static void python_process_stat(struct perf_stat_config *config,
1555 struct evsel *counter, u64 tstamp)
1557 struct perf_thread_map *threads = counter->core.threads;
1558 struct perf_cpu_map *cpus = counter->core.cpus;
1561 if (config->aggr_mode == AGGR_GLOBAL) {
1562 process_stat(counter, -1, -1, tstamp,
1563 &counter->counts->aggr);
1567 for (thread = 0; thread < threads->nr; thread++) {
1568 for (cpu = 0; cpu < cpus->nr; cpu++) {
1569 process_stat(counter, cpus->map[cpu],
1570 perf_thread_map__pid(threads, thread), tstamp,
1571 perf_counts(counter->counts, cpu, thread));
1576 static void python_process_stat_interval(u64 tstamp)
1578 PyObject *handler, *t;
1579 static const char handler_name[] = "stat__interval";
1582 t = PyTuple_New(MAX_FIELDS);
1584 Py_FatalError("couldn't create Python tuple");
1586 handler = get_handler(handler_name);
1588 pr_debug("can't find python handler %s\n", handler_name);
1592 tuple_set_u64(t, n++, tstamp);
1594 if (_PyTuple_Resize(&t, n) == -1)
1595 Py_FatalError("error resizing Python tuple");
1597 call_object(handler, t, handler_name);
1602 static int perf_script_context_init(void)
1604 PyObject *perf_script_context;
1605 PyObject *perf_trace_context;
1609 perf_trace_context = PyImport_AddModule("perf_trace_context");
1610 if (!perf_trace_context)
1612 dict = PyModule_GetDict(perf_trace_context);
1616 perf_script_context = _PyCapsule_New(scripting_context, NULL, NULL);
1617 if (!perf_script_context)
1620 ret = PyDict_SetItemString(dict, "perf_script_context", perf_script_context);
1622 ret = PyDict_SetItemString(main_dict, "perf_script_context", perf_script_context);
1623 Py_DECREF(perf_script_context);
1627 static int run_start_sub(void)
1629 main_module = PyImport_AddModule("__main__");
1630 if (main_module == NULL)
1632 Py_INCREF(main_module);
1634 main_dict = PyModule_GetDict(main_module);
1635 if (main_dict == NULL)
1637 Py_INCREF(main_dict);
1639 if (perf_script_context_init())
1642 try_call_object("trace_begin", NULL);
1647 Py_XDECREF(main_dict);
1648 Py_XDECREF(main_module);
1652 #define SET_TABLE_HANDLER_(name, handler_name, table_name) do { \
1653 tables->handler_name = get_handler(#table_name); \
1654 if (tables->handler_name) \
1655 tables->dbe.export_ ## name = python_export_ ## name; \
1658 #define SET_TABLE_HANDLER(name) \
1659 SET_TABLE_HANDLER_(name, name ## _handler, name ## _table)
1661 static void set_table_handlers(struct tables *tables)
1663 const char *perf_db_export_mode = "perf_db_export_mode";
1664 const char *perf_db_export_calls = "perf_db_export_calls";
1665 const char *perf_db_export_callchains = "perf_db_export_callchains";
1666 PyObject *db_export_mode, *db_export_calls, *db_export_callchains;
1667 bool export_calls = false;
1668 bool export_callchains = false;
1671 memset(tables, 0, sizeof(struct tables));
1672 if (db_export__init(&tables->dbe))
1673 Py_FatalError("failed to initialize export");
1675 db_export_mode = PyDict_GetItemString(main_dict, perf_db_export_mode);
1676 if (!db_export_mode)
1679 ret = PyObject_IsTrue(db_export_mode);
1681 handler_call_die(perf_db_export_mode);
1685 /* handle export calls */
1686 tables->dbe.crp = NULL;
1687 db_export_calls = PyDict_GetItemString(main_dict, perf_db_export_calls);
1688 if (db_export_calls) {
1689 ret = PyObject_IsTrue(db_export_calls);
1691 handler_call_die(perf_db_export_calls);
1692 export_calls = !!ret;
1697 call_return_processor__new(python_process_call_return,
1699 if (!tables->dbe.crp)
1700 Py_FatalError("failed to create calls processor");
1703 /* handle export callchains */
1704 tables->dbe.cpr = NULL;
1705 db_export_callchains = PyDict_GetItemString(main_dict,
1706 perf_db_export_callchains);
1707 if (db_export_callchains) {
1708 ret = PyObject_IsTrue(db_export_callchains);
1710 handler_call_die(perf_db_export_callchains);
1711 export_callchains = !!ret;
1714 if (export_callchains) {
1716 * Attempt to use the call path root from the call return
1717 * processor, if the call return processor is in use. Otherwise,
1718 * we allocate a new call path root. This prevents exporting
1719 * duplicate call path ids when both are in use simultaneously.
1721 if (tables->dbe.crp)
1722 tables->dbe.cpr = tables->dbe.crp->cpr;
1724 tables->dbe.cpr = call_path_root__new();
1726 if (!tables->dbe.cpr)
1727 Py_FatalError("failed to create call path root");
1730 tables->db_export_mode = true;
1732 * Reserve per symbol space for symbol->db_id via symbol__priv()
1734 symbol_conf.priv_size = sizeof(u64);
1736 SET_TABLE_HANDLER(evsel);
1737 SET_TABLE_HANDLER(machine);
1738 SET_TABLE_HANDLER(thread);
1739 SET_TABLE_HANDLER(comm);
1740 SET_TABLE_HANDLER(comm_thread);
1741 SET_TABLE_HANDLER(dso);
1742 SET_TABLE_HANDLER(symbol);
1743 SET_TABLE_HANDLER(branch_type);
1744 SET_TABLE_HANDLER(sample);
1745 SET_TABLE_HANDLER(call_path);
1746 SET_TABLE_HANDLER(call_return);
1747 SET_TABLE_HANDLER(context_switch);
1750 * Synthesized events are samples but with architecture-specific data
1751 * stored in sample->raw_data. They are exported via
1752 * python_export_sample() and consequently do not need a separate export
1755 tables->synth_handler = get_handler("synth_data");
1758 #if PY_MAJOR_VERSION < 3
1759 static void _free_command_line(const char **command_line, int num)
1764 static void _free_command_line(wchar_t **command_line, int num)
1767 for (i = 0; i < num; i++)
1768 PyMem_RawFree(command_line[i]);
1775 * Start trace script
1777 static int python_start_script(const char *script, int argc, const char **argv,
1778 struct perf_session *session)
1780 struct tables *tables = &tables_global;
1781 #if PY_MAJOR_VERSION < 3
1782 const char **command_line;
1784 wchar_t **command_line;
1787 * Use a non-const name variable to cope with python 2.6's
1788 * PyImport_AppendInittab prototype
1790 char buf[PATH_MAX], name[19] = "perf_trace_context";
1794 scripting_context->session = session;
1795 #if PY_MAJOR_VERSION < 3
1796 command_line = malloc((argc + 1) * sizeof(const char *));
1797 command_line[0] = script;
1798 for (i = 1; i < argc + 1; i++)
1799 command_line[i] = argv[i - 1];
1800 PyImport_AppendInittab(name, initperf_trace_context);
1802 command_line = malloc((argc + 1) * sizeof(wchar_t *));
1803 command_line[0] = Py_DecodeLocale(script, NULL);
1804 for (i = 1; i < argc + 1; i++)
1805 command_line[i] = Py_DecodeLocale(argv[i - 1], NULL);
1806 PyImport_AppendInittab(name, PyInit_perf_trace_context);
1810 #if PY_MAJOR_VERSION < 3
1811 PySys_SetArgv(argc + 1, (char **)command_line);
1813 PySys_SetArgv(argc + 1, command_line);
1816 fp = fopen(script, "r");
1818 sprintf(buf, "Can't open python script \"%s\"", script);
1824 err = PyRun_SimpleFile(fp, script);
1826 fprintf(stderr, "Error running python script %s\n", script);
1830 err = run_start_sub();
1832 fprintf(stderr, "Error starting python script %s\n", script);
1836 set_table_handlers(tables);
1838 if (tables->db_export_mode) {
1839 err = db_export__branch_types(&tables->dbe);
1844 _free_command_line(command_line, argc + 1);
1849 _free_command_line(command_line, argc + 1);
1854 static int python_flush_script(void)
1862 static int python_stop_script(void)
1864 struct tables *tables = &tables_global;
1866 try_call_object("trace_end", NULL);
1868 db_export__exit(&tables->dbe);
1870 Py_XDECREF(main_dict);
1871 Py_XDECREF(main_module);
1877 static int python_generate_script(struct tep_handle *pevent, const char *outfile)
1879 int i, not_first, count, nr_events;
1880 struct tep_event **all_events;
1881 struct tep_event *event = NULL;
1882 struct tep_format_field *f;
1883 char fname[PATH_MAX];
1886 sprintf(fname, "%s.py", outfile);
1887 ofp = fopen(fname, "w");
1889 fprintf(stderr, "couldn't open %s\n", fname);
1892 fprintf(ofp, "# perf script event handlers, "
1893 "generated by perf script -g python\n");
1895 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
1896 " License version 2\n\n");
1898 fprintf(ofp, "# The common_* event handler fields are the most useful "
1899 "fields common to\n");
1901 fprintf(ofp, "# all events. They don't necessarily correspond to "
1902 "the 'common_*' fields\n");
1904 fprintf(ofp, "# in the format files. Those fields not available as "
1905 "handler params can\n");
1907 fprintf(ofp, "# be retrieved using Python functions of the form "
1908 "common_*(context).\n");
1910 fprintf(ofp, "# See the perf-script-python Documentation for the list "
1911 "of available functions.\n\n");
1913 fprintf(ofp, "from __future__ import print_function\n\n");
1914 fprintf(ofp, "import os\n");
1915 fprintf(ofp, "import sys\n\n");
1917 fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
1918 fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
1919 fprintf(ofp, "\nfrom perf_trace_context import *\n");
1920 fprintf(ofp, "from Core import *\n\n\n");
1922 fprintf(ofp, "def trace_begin():\n");
1923 fprintf(ofp, "\tprint(\"in trace_begin\")\n\n");
1925 fprintf(ofp, "def trace_end():\n");
1926 fprintf(ofp, "\tprint(\"in trace_end\")\n\n");
1928 nr_events = tep_get_events_count(pevent);
1929 all_events = tep_list_events(pevent, TEP_EVENT_SORT_ID);
1931 for (i = 0; all_events && i < nr_events; i++) {
1932 event = all_events[i];
1933 fprintf(ofp, "def %s__%s(", event->system, event->name);
1934 fprintf(ofp, "event_name, ");
1935 fprintf(ofp, "context, ");
1936 fprintf(ofp, "common_cpu,\n");
1937 fprintf(ofp, "\tcommon_secs, ");
1938 fprintf(ofp, "common_nsecs, ");
1939 fprintf(ofp, "common_pid, ");
1940 fprintf(ofp, "common_comm,\n\t");
1941 fprintf(ofp, "common_callchain, ");
1946 for (f = event->format.fields; f; f = f->next) {
1949 if (++count % 5 == 0)
1950 fprintf(ofp, "\n\t");
1952 fprintf(ofp, "%s", f->name);
1956 if (++count % 5 == 0)
1957 fprintf(ofp, "\n\t\t");
1958 fprintf(ofp, "perf_sample_dict");
1960 fprintf(ofp, "):\n");
1962 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
1963 "common_secs, common_nsecs,\n\t\t\t"
1964 "common_pid, common_comm)\n\n");
1966 fprintf(ofp, "\t\tprint(\"");
1971 for (f = event->format.fields; f; f = f->next) {
1974 if (count && count % 3 == 0) {
1975 fprintf(ofp, "\" \\\n\t\t\"");
1979 fprintf(ofp, "%s=", f->name);
1980 if (f->flags & TEP_FIELD_IS_STRING ||
1981 f->flags & TEP_FIELD_IS_FLAG ||
1982 f->flags & TEP_FIELD_IS_ARRAY ||
1983 f->flags & TEP_FIELD_IS_SYMBOLIC)
1984 fprintf(ofp, "%%s");
1985 else if (f->flags & TEP_FIELD_IS_SIGNED)
1986 fprintf(ofp, "%%d");
1988 fprintf(ofp, "%%u");
1991 fprintf(ofp, "\" %% \\\n\t\t(");
1996 for (f = event->format.fields; f; f = f->next) {
2000 if (++count % 5 == 0)
2001 fprintf(ofp, "\n\t\t");
2003 if (f->flags & TEP_FIELD_IS_FLAG) {
2004 if ((count - 1) % 5 != 0) {
2005 fprintf(ofp, "\n\t\t");
2008 fprintf(ofp, "flag_str(\"");
2009 fprintf(ofp, "%s__%s\", ", event->system,
2011 fprintf(ofp, "\"%s\", %s)", f->name,
2013 } else if (f->flags & TEP_FIELD_IS_SYMBOLIC) {
2014 if ((count - 1) % 5 != 0) {
2015 fprintf(ofp, "\n\t\t");
2018 fprintf(ofp, "symbol_str(\"");
2019 fprintf(ofp, "%s__%s\", ", event->system,
2021 fprintf(ofp, "\"%s\", %s)", f->name,
2024 fprintf(ofp, "%s", f->name);
2027 fprintf(ofp, "))\n\n");
2029 fprintf(ofp, "\t\tprint('Sample: {'+"
2030 "get_dict_as_string(perf_sample_dict['sample'], ', ')+'}')\n\n");
2032 fprintf(ofp, "\t\tfor node in common_callchain:");
2033 fprintf(ofp, "\n\t\t\tif 'sym' in node:");
2034 fprintf(ofp, "\n\t\t\t\tprint(\"\\t[%%x] %%s\" %% (node['ip'], node['sym']['name']))");
2035 fprintf(ofp, "\n\t\t\telse:");
2036 fprintf(ofp, "\n\t\t\t\tprint(\"\t[%%x]\" %% (node['ip']))\n\n");
2037 fprintf(ofp, "\t\tprint()\n\n");
2041 fprintf(ofp, "def trace_unhandled(event_name, context, "
2042 "event_fields_dict, perf_sample_dict):\n");
2044 fprintf(ofp, "\t\tprint(get_dict_as_string(event_fields_dict))\n");
2045 fprintf(ofp, "\t\tprint('Sample: {'+"
2046 "get_dict_as_string(perf_sample_dict['sample'], ', ')+'}')\n\n");
2048 fprintf(ofp, "def print_header("
2049 "event_name, cpu, secs, nsecs, pid, comm):\n"
2050 "\tprint(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
2051 "(event_name, cpu, secs, nsecs, pid, comm), end=\"\")\n\n");
2053 fprintf(ofp, "def get_dict_as_string(a_dict, delimiter=' '):\n"
2054 "\treturn delimiter.join"
2055 "(['%%s=%%s'%%(k,str(v))for k,v in sorted(a_dict.items())])\n");
2059 fprintf(stderr, "generated Python script: %s\n", fname);
2064 struct scripting_ops python_scripting_ops = {
2066 .dirname = "python",
2067 .start_script = python_start_script,
2068 .flush_script = python_flush_script,
2069 .stop_script = python_stop_script,
2070 .process_event = python_process_event,
2071 .process_switch = python_process_switch,
2072 .process_auxtrace_error = python_process_auxtrace_error,
2073 .process_stat = python_process_stat,
2074 .process_stat_interval = python_process_stat_interval,
2075 .generate_script = python_generate_script,