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"
44 #include "../call-path.h"
45 #include "thread_map.h"
49 PyMODINIT_FUNC
initperf_trace_context(void);
51 #define TRACE_EVENT_TYPE_MAX \
52 ((1 << (sizeof(unsigned short) * 8)) - 1)
54 static DECLARE_BITMAP(events_defined
, TRACE_EVENT_TYPE_MAX
);
57 #define N_COMMON_FIELDS 7
59 extern struct scripting_context
*scripting_context
;
61 static char *cur_field_name
;
62 static int zero_flag_atom
;
64 static PyObject
*main_module
, *main_dict
;
68 PyObject
*evsel_handler
;
69 PyObject
*machine_handler
;
70 PyObject
*thread_handler
;
71 PyObject
*comm_handler
;
72 PyObject
*comm_thread_handler
;
73 PyObject
*dso_handler
;
74 PyObject
*symbol_handler
;
75 PyObject
*branch_type_handler
;
76 PyObject
*sample_handler
;
77 PyObject
*call_path_handler
;
78 PyObject
*call_return_handler
;
82 static struct tables tables_global
;
84 static void handler_call_die(const char *handler_name
) NORETURN
;
85 static void handler_call_die(const char *handler_name
)
88 Py_FatalError("problem in Python trace event handler");
89 // Py_FatalError does not return
90 // but we have to make the compiler happy
95 * Insert val into into the dictionary and decrement the reference counter.
96 * This is necessary for dictionaries since PyDict_SetItemString() does not
97 * steal a reference, as opposed to PyTuple_SetItem().
99 static void pydict_set_item_string_decref(PyObject
*dict
, const char *key
, PyObject
*val
)
101 PyDict_SetItemString(dict
, key
, val
);
105 static PyObject
*get_handler(const char *handler_name
)
109 handler
= PyDict_GetItemString(main_dict
, handler_name
);
110 if (handler
&& !PyCallable_Check(handler
))
115 static void call_object(PyObject
*handler
, PyObject
*args
, const char *die_msg
)
119 retval
= PyObject_CallObject(handler
, args
);
121 handler_call_die(die_msg
);
125 static void try_call_object(const char *handler_name
, PyObject
*args
)
129 handler
= get_handler(handler_name
);
131 call_object(handler
, args
, handler_name
);
134 static void define_value(enum print_arg_type field_type
,
136 const char *field_name
,
137 const char *field_value
,
138 const char *field_str
)
140 const char *handler_name
= "define_flag_value";
142 unsigned long long value
;
145 if (field_type
== PRINT_SYMBOL
)
146 handler_name
= "define_symbolic_value";
150 Py_FatalError("couldn't create Python tuple");
152 value
= eval_flag(field_value
);
154 PyTuple_SetItem(t
, n
++, PyString_FromString(ev_name
));
155 PyTuple_SetItem(t
, n
++, PyString_FromString(field_name
));
156 PyTuple_SetItem(t
, n
++, PyInt_FromLong(value
));
157 PyTuple_SetItem(t
, n
++, PyString_FromString(field_str
));
159 try_call_object(handler_name
, t
);
164 static void define_values(enum print_arg_type field_type
,
165 struct print_flag_sym
*field
,
167 const char *field_name
)
169 define_value(field_type
, ev_name
, field_name
, field
->value
,
173 define_values(field_type
, field
->next
, ev_name
, field_name
);
176 static void define_field(enum print_arg_type field_type
,
178 const char *field_name
,
181 const char *handler_name
= "define_flag_field";
185 if (field_type
== PRINT_SYMBOL
)
186 handler_name
= "define_symbolic_field";
188 if (field_type
== PRINT_FLAGS
)
193 Py_FatalError("couldn't create Python tuple");
195 PyTuple_SetItem(t
, n
++, PyString_FromString(ev_name
));
196 PyTuple_SetItem(t
, n
++, PyString_FromString(field_name
));
197 if (field_type
== PRINT_FLAGS
)
198 PyTuple_SetItem(t
, n
++, PyString_FromString(delim
));
200 try_call_object(handler_name
, t
);
205 static void define_event_symbols(struct event_format
*event
,
207 struct print_arg
*args
)
212 switch (args
->type
) {
216 define_value(PRINT_FLAGS
, ev_name
, cur_field_name
, "0",
221 free(cur_field_name
);
222 cur_field_name
= strdup(args
->field
.name
);
225 define_event_symbols(event
, ev_name
, args
->flags
.field
);
226 define_field(PRINT_FLAGS
, ev_name
, cur_field_name
,
228 define_values(PRINT_FLAGS
, args
->flags
.flags
, ev_name
,
232 define_event_symbols(event
, ev_name
, args
->symbol
.field
);
233 define_field(PRINT_SYMBOL
, ev_name
, cur_field_name
, NULL
);
234 define_values(PRINT_SYMBOL
, args
->symbol
.symbols
, ev_name
,
238 define_event_symbols(event
, ev_name
, args
->hex
.field
);
239 define_event_symbols(event
, ev_name
, args
->hex
.size
);
241 case PRINT_INT_ARRAY
:
242 define_event_symbols(event
, ev_name
, args
->int_array
.field
);
243 define_event_symbols(event
, ev_name
, args
->int_array
.count
);
244 define_event_symbols(event
, ev_name
, args
->int_array
.el_size
);
249 define_event_symbols(event
, ev_name
, args
->typecast
.item
);
252 if (strcmp(args
->op
.op
, ":") == 0)
254 define_event_symbols(event
, ev_name
, args
->op
.left
);
255 define_event_symbols(event
, ev_name
, args
->op
.right
);
258 /* gcc warns for these? */
260 case PRINT_DYNAMIC_ARRAY
:
261 case PRINT_DYNAMIC_ARRAY_LEN
:
264 /* we should warn... */
269 define_event_symbols(event
, ev_name
, args
->next
);
272 static PyObject
*get_field_numeric_entry(struct event_format
*event
,
273 struct format_field
*field
, void *data
)
275 bool is_array
= field
->flags
& FIELD_IS_ARRAY
;
276 PyObject
*obj
, *list
= NULL
;
277 unsigned long long val
;
278 unsigned int item_size
, n_items
, i
;
281 list
= PyList_New(field
->arraylen
);
282 item_size
= field
->size
/ field
->arraylen
;
283 n_items
= field
->arraylen
;
285 item_size
= field
->size
;
289 for (i
= 0; i
< n_items
; i
++) {
291 val
= read_size(event
, data
+ field
->offset
+ i
* item_size
,
293 if (field
->flags
& FIELD_IS_SIGNED
) {
294 if ((long long)val
>= LONG_MIN
&&
295 (long long)val
<= LONG_MAX
)
296 obj
= PyInt_FromLong(val
);
298 obj
= PyLong_FromLongLong(val
);
301 obj
= PyInt_FromLong(val
);
303 obj
= PyLong_FromUnsignedLongLong(val
);
306 PyList_SET_ITEM(list
, i
, obj
);
314 static PyObject
*python_process_callchain(struct perf_sample
*sample
,
315 struct perf_evsel
*evsel
,
316 struct addr_location
*al
)
320 pylist
= PyList_New(0);
322 Py_FatalError("couldn't create Python list");
324 if (!symbol_conf
.use_callchain
|| !sample
->callchain
)
327 if (thread__resolve_callchain(al
->thread
, &callchain_cursor
, evsel
,
329 scripting_max_stack
) != 0) {
330 pr_err("Failed to resolve callchain. Skipping\n");
333 callchain_cursor_commit(&callchain_cursor
);
338 struct callchain_cursor_node
*node
;
339 node
= callchain_cursor_current(&callchain_cursor
);
343 pyelem
= PyDict_New();
345 Py_FatalError("couldn't create Python dictionary");
348 pydict_set_item_string_decref(pyelem
, "ip",
349 PyLong_FromUnsignedLongLong(node
->ip
));
352 PyObject
*pysym
= PyDict_New();
354 Py_FatalError("couldn't create Python dictionary");
355 pydict_set_item_string_decref(pysym
, "start",
356 PyLong_FromUnsignedLongLong(node
->sym
->start
));
357 pydict_set_item_string_decref(pysym
, "end",
358 PyLong_FromUnsignedLongLong(node
->sym
->end
));
359 pydict_set_item_string_decref(pysym
, "binding",
360 PyInt_FromLong(node
->sym
->binding
));
361 pydict_set_item_string_decref(pysym
, "name",
362 PyString_FromStringAndSize(node
->sym
->name
,
363 node
->sym
->namelen
));
364 pydict_set_item_string_decref(pyelem
, "sym", pysym
);
368 struct map
*map
= node
->map
;
369 const char *dsoname
= "[unknown]";
370 if (map
&& map
->dso
&& (map
->dso
->name
|| map
->dso
->long_name
)) {
371 if (symbol_conf
.show_kernel_path
&& map
->dso
->long_name
)
372 dsoname
= map
->dso
->long_name
;
373 else if (map
->dso
->name
)
374 dsoname
= map
->dso
->name
;
376 pydict_set_item_string_decref(pyelem
, "dso",
377 PyString_FromString(dsoname
));
380 callchain_cursor_advance(&callchain_cursor
);
381 PyList_Append(pylist
, pyelem
);
390 static void python_process_tracepoint(struct perf_sample
*sample
,
391 struct perf_evsel
*evsel
,
392 struct addr_location
*al
)
394 struct event_format
*event
= evsel
->tp_format
;
395 PyObject
*handler
, *context
, *t
, *obj
, *callchain
;
396 PyObject
*dict
= NULL
;
397 static char handler_name
[256];
398 struct format_field
*field
;
402 int cpu
= sample
->cpu
;
403 void *data
= sample
->raw_data
;
404 unsigned long long nsecs
= sample
->time
;
405 const char *comm
= thread__comm_str(al
->thread
);
407 t
= PyTuple_New(MAX_FIELDS
);
409 Py_FatalError("couldn't create Python tuple");
412 snprintf(handler_name
, sizeof(handler_name
),
413 "ug! no event found for type %" PRIu64
, (u64
)evsel
->attr
.config
);
414 Py_FatalError(handler_name
);
417 pid
= raw_field_value(event
, "common_pid", data
);
419 sprintf(handler_name
, "%s__%s", event
->system
, event
->name
);
421 if (!test_and_set_bit(event
->id
, events_defined
))
422 define_event_symbols(event
, handler_name
, event
->print_fmt
.args
);
424 handler
= get_handler(handler_name
);
428 Py_FatalError("couldn't create Python dict");
430 s
= nsecs
/ NSECS_PER_SEC
;
431 ns
= nsecs
- s
* NSECS_PER_SEC
;
433 scripting_context
->event_data
= data
;
434 scripting_context
->pevent
= evsel
->tp_format
->pevent
;
436 context
= PyCObject_FromVoidPtr(scripting_context
, NULL
);
438 PyTuple_SetItem(t
, n
++, PyString_FromString(handler_name
));
439 PyTuple_SetItem(t
, n
++, context
);
442 callchain
= python_process_callchain(sample
, evsel
, al
);
445 PyTuple_SetItem(t
, n
++, PyInt_FromLong(cpu
));
446 PyTuple_SetItem(t
, n
++, PyInt_FromLong(s
));
447 PyTuple_SetItem(t
, n
++, PyInt_FromLong(ns
));
448 PyTuple_SetItem(t
, n
++, PyInt_FromLong(pid
));
449 PyTuple_SetItem(t
, n
++, PyString_FromString(comm
));
450 PyTuple_SetItem(t
, n
++, callchain
);
452 pydict_set_item_string_decref(dict
, "common_cpu", PyInt_FromLong(cpu
));
453 pydict_set_item_string_decref(dict
, "common_s", PyInt_FromLong(s
));
454 pydict_set_item_string_decref(dict
, "common_ns", PyInt_FromLong(ns
));
455 pydict_set_item_string_decref(dict
, "common_pid", PyInt_FromLong(pid
));
456 pydict_set_item_string_decref(dict
, "common_comm", PyString_FromString(comm
));
457 pydict_set_item_string_decref(dict
, "common_callchain", callchain
);
459 for (field
= event
->format
.fields
; field
; field
= field
->next
) {
460 if (field
->flags
& FIELD_IS_STRING
) {
462 if (field
->flags
& FIELD_IS_DYNAMIC
) {
463 offset
= *(int *)(data
+ field
->offset
);
466 offset
= field
->offset
;
467 obj
= PyString_FromString((char *)data
+ offset
);
468 } else { /* FIELD_IS_NUMERIC */
469 obj
= get_field_numeric_entry(event
, field
, data
);
472 PyTuple_SetItem(t
, n
++, obj
);
474 pydict_set_item_string_decref(dict
, field
->name
, obj
);
479 PyTuple_SetItem(t
, n
++, dict
);
481 if (_PyTuple_Resize(&t
, n
) == -1)
482 Py_FatalError("error resizing Python tuple");
485 call_object(handler
, t
, handler_name
);
487 try_call_object("trace_unhandled", t
);
494 static PyObject
*tuple_new(unsigned int sz
)
500 Py_FatalError("couldn't create Python tuple");
504 static int tuple_set_u64(PyObject
*t
, unsigned int pos
, u64 val
)
506 #if BITS_PER_LONG == 64
507 return PyTuple_SetItem(t
, pos
, PyInt_FromLong(val
));
509 #if BITS_PER_LONG == 32
510 return PyTuple_SetItem(t
, pos
, PyLong_FromLongLong(val
));
514 static int tuple_set_s32(PyObject
*t
, unsigned int pos
, s32 val
)
516 return PyTuple_SetItem(t
, pos
, PyInt_FromLong(val
));
519 static int tuple_set_string(PyObject
*t
, unsigned int pos
, const char *s
)
521 return PyTuple_SetItem(t
, pos
, PyString_FromString(s
));
524 static int python_export_evsel(struct db_export
*dbe
, struct perf_evsel
*evsel
)
526 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
531 tuple_set_u64(t
, 0, evsel
->db_id
);
532 tuple_set_string(t
, 1, perf_evsel__name(evsel
));
534 call_object(tables
->evsel_handler
, t
, "evsel_table");
541 static int python_export_machine(struct db_export
*dbe
,
542 struct machine
*machine
)
544 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
549 tuple_set_u64(t
, 0, machine
->db_id
);
550 tuple_set_s32(t
, 1, machine
->pid
);
551 tuple_set_string(t
, 2, machine
->root_dir
? machine
->root_dir
: "");
553 call_object(tables
->machine_handler
, t
, "machine_table");
560 static int python_export_thread(struct db_export
*dbe
, struct thread
*thread
,
561 u64 main_thread_db_id
, struct machine
*machine
)
563 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
568 tuple_set_u64(t
, 0, thread
->db_id
);
569 tuple_set_u64(t
, 1, machine
->db_id
);
570 tuple_set_u64(t
, 2, main_thread_db_id
);
571 tuple_set_s32(t
, 3, thread
->pid_
);
572 tuple_set_s32(t
, 4, thread
->tid
);
574 call_object(tables
->thread_handler
, t
, "thread_table");
581 static int python_export_comm(struct db_export
*dbe
, struct comm
*comm
)
583 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
588 tuple_set_u64(t
, 0, comm
->db_id
);
589 tuple_set_string(t
, 1, comm__str(comm
));
591 call_object(tables
->comm_handler
, t
, "comm_table");
598 static int python_export_comm_thread(struct db_export
*dbe
, u64 db_id
,
599 struct comm
*comm
, struct thread
*thread
)
601 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
606 tuple_set_u64(t
, 0, db_id
);
607 tuple_set_u64(t
, 1, comm
->db_id
);
608 tuple_set_u64(t
, 2, thread
->db_id
);
610 call_object(tables
->comm_thread_handler
, t
, "comm_thread_table");
617 static int python_export_dso(struct db_export
*dbe
, struct dso
*dso
,
618 struct machine
*machine
)
620 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
621 char sbuild_id
[SBUILD_ID_SIZE
];
624 build_id__sprintf(dso
->build_id
, sizeof(dso
->build_id
), sbuild_id
);
628 tuple_set_u64(t
, 0, dso
->db_id
);
629 tuple_set_u64(t
, 1, machine
->db_id
);
630 tuple_set_string(t
, 2, dso
->short_name
);
631 tuple_set_string(t
, 3, dso
->long_name
);
632 tuple_set_string(t
, 4, sbuild_id
);
634 call_object(tables
->dso_handler
, t
, "dso_table");
641 static int python_export_symbol(struct db_export
*dbe
, struct symbol
*sym
,
644 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
645 u64
*sym_db_id
= symbol__priv(sym
);
650 tuple_set_u64(t
, 0, *sym_db_id
);
651 tuple_set_u64(t
, 1, dso
->db_id
);
652 tuple_set_u64(t
, 2, sym
->start
);
653 tuple_set_u64(t
, 3, sym
->end
);
654 tuple_set_s32(t
, 4, sym
->binding
);
655 tuple_set_string(t
, 5, sym
->name
);
657 call_object(tables
->symbol_handler
, t
, "symbol_table");
664 static int python_export_branch_type(struct db_export
*dbe
, u32 branch_type
,
667 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
672 tuple_set_s32(t
, 0, branch_type
);
673 tuple_set_string(t
, 1, name
);
675 call_object(tables
->branch_type_handler
, t
, "branch_type_table");
682 static int python_export_sample(struct db_export
*dbe
,
683 struct export_sample
*es
)
685 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
690 tuple_set_u64(t
, 0, es
->db_id
);
691 tuple_set_u64(t
, 1, es
->evsel
->db_id
);
692 tuple_set_u64(t
, 2, es
->al
->machine
->db_id
);
693 tuple_set_u64(t
, 3, es
->al
->thread
->db_id
);
694 tuple_set_u64(t
, 4, es
->comm_db_id
);
695 tuple_set_u64(t
, 5, es
->dso_db_id
);
696 tuple_set_u64(t
, 6, es
->sym_db_id
);
697 tuple_set_u64(t
, 7, es
->offset
);
698 tuple_set_u64(t
, 8, es
->sample
->ip
);
699 tuple_set_u64(t
, 9, es
->sample
->time
);
700 tuple_set_s32(t
, 10, es
->sample
->cpu
);
701 tuple_set_u64(t
, 11, es
->addr_dso_db_id
);
702 tuple_set_u64(t
, 12, es
->addr_sym_db_id
);
703 tuple_set_u64(t
, 13, es
->addr_offset
);
704 tuple_set_u64(t
, 14, es
->sample
->addr
);
705 tuple_set_u64(t
, 15, es
->sample
->period
);
706 tuple_set_u64(t
, 16, es
->sample
->weight
);
707 tuple_set_u64(t
, 17, es
->sample
->transaction
);
708 tuple_set_u64(t
, 18, es
->sample
->data_src
);
709 tuple_set_s32(t
, 19, es
->sample
->flags
& PERF_BRANCH_MASK
);
710 tuple_set_s32(t
, 20, !!(es
->sample
->flags
& PERF_IP_FLAG_IN_TX
));
711 tuple_set_u64(t
, 21, es
->call_path_id
);
713 call_object(tables
->sample_handler
, t
, "sample_table");
720 static int python_export_call_path(struct db_export
*dbe
, struct call_path
*cp
)
722 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
724 u64 parent_db_id
, sym_db_id
;
726 parent_db_id
= cp
->parent
? cp
->parent
->db_id
: 0;
727 sym_db_id
= cp
->sym
? *(u64
*)symbol__priv(cp
->sym
) : 0;
731 tuple_set_u64(t
, 0, cp
->db_id
);
732 tuple_set_u64(t
, 1, parent_db_id
);
733 tuple_set_u64(t
, 2, sym_db_id
);
734 tuple_set_u64(t
, 3, cp
->ip
);
736 call_object(tables
->call_path_handler
, t
, "call_path_table");
743 static int python_export_call_return(struct db_export
*dbe
,
744 struct call_return
*cr
)
746 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
747 u64 comm_db_id
= cr
->comm
? cr
->comm
->db_id
: 0;
752 tuple_set_u64(t
, 0, cr
->db_id
);
753 tuple_set_u64(t
, 1, cr
->thread
->db_id
);
754 tuple_set_u64(t
, 2, comm_db_id
);
755 tuple_set_u64(t
, 3, cr
->cp
->db_id
);
756 tuple_set_u64(t
, 4, cr
->call_time
);
757 tuple_set_u64(t
, 5, cr
->return_time
);
758 tuple_set_u64(t
, 6, cr
->branch_count
);
759 tuple_set_u64(t
, 7, cr
->call_ref
);
760 tuple_set_u64(t
, 8, cr
->return_ref
);
761 tuple_set_u64(t
, 9, cr
->cp
->parent
->db_id
);
762 tuple_set_s32(t
, 10, cr
->flags
);
764 call_object(tables
->call_return_handler
, t
, "call_return_table");
771 static int python_process_call_return(struct call_return
*cr
, void *data
)
773 struct db_export
*dbe
= data
;
775 return db_export__call_return(dbe
, cr
);
778 static void python_process_general_event(struct perf_sample
*sample
,
779 struct perf_evsel
*evsel
,
780 struct addr_location
*al
)
782 PyObject
*handler
, *t
, *dict
, *callchain
, *dict_sample
;
783 static char handler_name
[64];
787 * Use the MAX_FIELDS to make the function expandable, though
788 * currently there is only one item for the tuple.
790 t
= PyTuple_New(MAX_FIELDS
);
792 Py_FatalError("couldn't create Python tuple");
796 Py_FatalError("couldn't create Python dictionary");
798 dict_sample
= PyDict_New();
800 Py_FatalError("couldn't create Python dictionary");
802 snprintf(handler_name
, sizeof(handler_name
), "%s", "process_event");
804 handler
= get_handler(handler_name
);
808 pydict_set_item_string_decref(dict
, "ev_name", PyString_FromString(perf_evsel__name(evsel
)));
809 pydict_set_item_string_decref(dict
, "attr", PyString_FromStringAndSize(
810 (const char *)&evsel
->attr
, sizeof(evsel
->attr
)));
812 pydict_set_item_string_decref(dict_sample
, "pid",
813 PyInt_FromLong(sample
->pid
));
814 pydict_set_item_string_decref(dict_sample
, "tid",
815 PyInt_FromLong(sample
->tid
));
816 pydict_set_item_string_decref(dict_sample
, "cpu",
817 PyInt_FromLong(sample
->cpu
));
818 pydict_set_item_string_decref(dict_sample
, "ip",
819 PyLong_FromUnsignedLongLong(sample
->ip
));
820 pydict_set_item_string_decref(dict_sample
, "time",
821 PyLong_FromUnsignedLongLong(sample
->time
));
822 pydict_set_item_string_decref(dict_sample
, "period",
823 PyLong_FromUnsignedLongLong(sample
->period
));
824 pydict_set_item_string_decref(dict
, "sample", dict_sample
);
826 pydict_set_item_string_decref(dict
, "raw_buf", PyString_FromStringAndSize(
827 (const char *)sample
->raw_data
, sample
->raw_size
));
828 pydict_set_item_string_decref(dict
, "comm",
829 PyString_FromString(thread__comm_str(al
->thread
)));
831 pydict_set_item_string_decref(dict
, "dso",
832 PyString_FromString(al
->map
->dso
->name
));
835 pydict_set_item_string_decref(dict
, "symbol",
836 PyString_FromString(al
->sym
->name
));
840 callchain
= python_process_callchain(sample
, evsel
, al
);
841 pydict_set_item_string_decref(dict
, "callchain", callchain
);
843 PyTuple_SetItem(t
, n
++, dict
);
844 if (_PyTuple_Resize(&t
, n
) == -1)
845 Py_FatalError("error resizing Python tuple");
847 call_object(handler
, t
, handler_name
);
853 static void python_process_event(union perf_event
*event
,
854 struct perf_sample
*sample
,
855 struct perf_evsel
*evsel
,
856 struct addr_location
*al
)
858 struct tables
*tables
= &tables_global
;
860 switch (evsel
->attr
.type
) {
861 case PERF_TYPE_TRACEPOINT
:
862 python_process_tracepoint(sample
, evsel
, al
);
864 /* Reserve for future process_hw/sw/raw APIs */
866 if (tables
->db_export_mode
)
867 db_export__sample(&tables
->dbe
, event
, sample
, evsel
, al
);
869 python_process_general_event(sample
, evsel
, al
);
873 static void get_handler_name(char *str
, size_t size
,
874 struct perf_evsel
*evsel
)
878 scnprintf(str
, size
, "stat__%s", perf_evsel__name(evsel
));
880 while ((p
= strchr(p
, ':'))) {
887 process_stat(struct perf_evsel
*counter
, int cpu
, int thread
, u64 tstamp
,
888 struct perf_counts_values
*count
)
890 PyObject
*handler
, *t
;
891 static char handler_name
[256];
894 t
= PyTuple_New(MAX_FIELDS
);
896 Py_FatalError("couldn't create Python tuple");
898 get_handler_name(handler_name
, sizeof(handler_name
),
901 handler
= get_handler(handler_name
);
903 pr_debug("can't find python handler %s\n", handler_name
);
907 PyTuple_SetItem(t
, n
++, PyInt_FromLong(cpu
));
908 PyTuple_SetItem(t
, n
++, PyInt_FromLong(thread
));
910 tuple_set_u64(t
, n
++, tstamp
);
911 tuple_set_u64(t
, n
++, count
->val
);
912 tuple_set_u64(t
, n
++, count
->ena
);
913 tuple_set_u64(t
, n
++, count
->run
);
915 if (_PyTuple_Resize(&t
, n
) == -1)
916 Py_FatalError("error resizing Python tuple");
918 call_object(handler
, t
, handler_name
);
923 static void python_process_stat(struct perf_stat_config
*config
,
924 struct perf_evsel
*counter
, u64 tstamp
)
926 struct thread_map
*threads
= counter
->threads
;
927 struct cpu_map
*cpus
= counter
->cpus
;
930 if (config
->aggr_mode
== AGGR_GLOBAL
) {
931 process_stat(counter
, -1, -1, tstamp
,
932 &counter
->counts
->aggr
);
936 for (thread
= 0; thread
< threads
->nr
; thread
++) {
937 for (cpu
= 0; cpu
< cpus
->nr
; cpu
++) {
938 process_stat(counter
, cpus
->map
[cpu
],
939 thread_map__pid(threads
, thread
), tstamp
,
940 perf_counts(counter
->counts
, cpu
, thread
));
945 static void python_process_stat_interval(u64 tstamp
)
947 PyObject
*handler
, *t
;
948 static const char handler_name
[] = "stat__interval";
951 t
= PyTuple_New(MAX_FIELDS
);
953 Py_FatalError("couldn't create Python tuple");
955 handler
= get_handler(handler_name
);
957 pr_debug("can't find python handler %s\n", handler_name
);
961 tuple_set_u64(t
, n
++, tstamp
);
963 if (_PyTuple_Resize(&t
, n
) == -1)
964 Py_FatalError("error resizing Python tuple");
966 call_object(handler
, t
, handler_name
);
971 static int run_start_sub(void)
973 main_module
= PyImport_AddModule("__main__");
974 if (main_module
== NULL
)
976 Py_INCREF(main_module
);
978 main_dict
= PyModule_GetDict(main_module
);
979 if (main_dict
== NULL
)
981 Py_INCREF(main_dict
);
983 try_call_object("trace_begin", NULL
);
988 Py_XDECREF(main_dict
);
989 Py_XDECREF(main_module
);
993 #define SET_TABLE_HANDLER_(name, handler_name, table_name) do { \
994 tables->handler_name = get_handler(#table_name); \
995 if (tables->handler_name) \
996 tables->dbe.export_ ## name = python_export_ ## name; \
999 #define SET_TABLE_HANDLER(name) \
1000 SET_TABLE_HANDLER_(name, name ## _handler, name ## _table)
1002 static void set_table_handlers(struct tables
*tables
)
1004 const char *perf_db_export_mode
= "perf_db_export_mode";
1005 const char *perf_db_export_calls
= "perf_db_export_calls";
1006 const char *perf_db_export_callchains
= "perf_db_export_callchains";
1007 PyObject
*db_export_mode
, *db_export_calls
, *db_export_callchains
;
1008 bool export_calls
= false;
1009 bool export_callchains
= false;
1012 memset(tables
, 0, sizeof(struct tables
));
1013 if (db_export__init(&tables
->dbe
))
1014 Py_FatalError("failed to initialize export");
1016 db_export_mode
= PyDict_GetItemString(main_dict
, perf_db_export_mode
);
1017 if (!db_export_mode
)
1020 ret
= PyObject_IsTrue(db_export_mode
);
1022 handler_call_die(perf_db_export_mode
);
1026 /* handle export calls */
1027 tables
->dbe
.crp
= NULL
;
1028 db_export_calls
= PyDict_GetItemString(main_dict
, perf_db_export_calls
);
1029 if (db_export_calls
) {
1030 ret
= PyObject_IsTrue(db_export_calls
);
1032 handler_call_die(perf_db_export_calls
);
1033 export_calls
= !!ret
;
1038 call_return_processor__new(python_process_call_return
,
1040 if (!tables
->dbe
.crp
)
1041 Py_FatalError("failed to create calls processor");
1044 /* handle export callchains */
1045 tables
->dbe
.cpr
= NULL
;
1046 db_export_callchains
= PyDict_GetItemString(main_dict
,
1047 perf_db_export_callchains
);
1048 if (db_export_callchains
) {
1049 ret
= PyObject_IsTrue(db_export_callchains
);
1051 handler_call_die(perf_db_export_callchains
);
1052 export_callchains
= !!ret
;
1055 if (export_callchains
) {
1057 * Attempt to use the call path root from the call return
1058 * processor, if the call return processor is in use. Otherwise,
1059 * we allocate a new call path root. This prevents exporting
1060 * duplicate call path ids when both are in use simultaniously.
1062 if (tables
->dbe
.crp
)
1063 tables
->dbe
.cpr
= tables
->dbe
.crp
->cpr
;
1065 tables
->dbe
.cpr
= call_path_root__new();
1067 if (!tables
->dbe
.cpr
)
1068 Py_FatalError("failed to create call path root");
1071 tables
->db_export_mode
= true;
1073 * Reserve per symbol space for symbol->db_id via symbol__priv()
1075 symbol_conf
.priv_size
= sizeof(u64
);
1077 SET_TABLE_HANDLER(evsel
);
1078 SET_TABLE_HANDLER(machine
);
1079 SET_TABLE_HANDLER(thread
);
1080 SET_TABLE_HANDLER(comm
);
1081 SET_TABLE_HANDLER(comm_thread
);
1082 SET_TABLE_HANDLER(dso
);
1083 SET_TABLE_HANDLER(symbol
);
1084 SET_TABLE_HANDLER(branch_type
);
1085 SET_TABLE_HANDLER(sample
);
1086 SET_TABLE_HANDLER(call_path
);
1087 SET_TABLE_HANDLER(call_return
);
1091 * Start trace script
1093 static int python_start_script(const char *script
, int argc
, const char **argv
)
1095 struct tables
*tables
= &tables_global
;
1096 const char **command_line
;
1101 command_line
= malloc((argc
+ 1) * sizeof(const char *));
1102 command_line
[0] = script
;
1103 for (i
= 1; i
< argc
+ 1; i
++)
1104 command_line
[i
] = argv
[i
- 1];
1108 initperf_trace_context();
1110 PySys_SetArgv(argc
+ 1, (char **)command_line
);
1112 fp
= fopen(script
, "r");
1114 sprintf(buf
, "Can't open python script \"%s\"", script
);
1120 err
= PyRun_SimpleFile(fp
, script
);
1122 fprintf(stderr
, "Error running python script %s\n", script
);
1126 err
= run_start_sub();
1128 fprintf(stderr
, "Error starting python script %s\n", script
);
1132 set_table_handlers(tables
);
1134 if (tables
->db_export_mode
) {
1135 err
= db_export__branch_types(&tables
->dbe
);
1150 static int python_flush_script(void)
1152 struct tables
*tables
= &tables_global
;
1154 return db_export__flush(&tables
->dbe
);
1160 static int python_stop_script(void)
1162 struct tables
*tables
= &tables_global
;
1164 try_call_object("trace_end", NULL
);
1166 db_export__exit(&tables
->dbe
);
1168 Py_XDECREF(main_dict
);
1169 Py_XDECREF(main_module
);
1175 static int python_generate_script(struct pevent
*pevent
, const char *outfile
)
1177 struct event_format
*event
= NULL
;
1178 struct format_field
*f
;
1179 char fname
[PATH_MAX
];
1180 int not_first
, count
;
1183 sprintf(fname
, "%s.py", outfile
);
1184 ofp
= fopen(fname
, "w");
1186 fprintf(stderr
, "couldn't open %s\n", fname
);
1189 fprintf(ofp
, "# perf script event handlers, "
1190 "generated by perf script -g python\n");
1192 fprintf(ofp
, "# Licensed under the terms of the GNU GPL"
1193 " License version 2\n\n");
1195 fprintf(ofp
, "# The common_* event handler fields are the most useful "
1196 "fields common to\n");
1198 fprintf(ofp
, "# all events. They don't necessarily correspond to "
1199 "the 'common_*' fields\n");
1201 fprintf(ofp
, "# in the format files. Those fields not available as "
1202 "handler params can\n");
1204 fprintf(ofp
, "# be retrieved using Python functions of the form "
1205 "common_*(context).\n");
1207 fprintf(ofp
, "# See the perf-trace-python Documentation for the list "
1208 "of available functions.\n\n");
1210 fprintf(ofp
, "import os\n");
1211 fprintf(ofp
, "import sys\n\n");
1213 fprintf(ofp
, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
1214 fprintf(ofp
, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
1215 fprintf(ofp
, "\nfrom perf_trace_context import *\n");
1216 fprintf(ofp
, "from Core import *\n\n\n");
1218 fprintf(ofp
, "def trace_begin():\n");
1219 fprintf(ofp
, "\tprint \"in trace_begin\"\n\n");
1221 fprintf(ofp
, "def trace_end():\n");
1222 fprintf(ofp
, "\tprint \"in trace_end\"\n\n");
1224 while ((event
= trace_find_next_event(pevent
, event
))) {
1225 fprintf(ofp
, "def %s__%s(", event
->system
, event
->name
);
1226 fprintf(ofp
, "event_name, ");
1227 fprintf(ofp
, "context, ");
1228 fprintf(ofp
, "common_cpu,\n");
1229 fprintf(ofp
, "\tcommon_secs, ");
1230 fprintf(ofp
, "common_nsecs, ");
1231 fprintf(ofp
, "common_pid, ");
1232 fprintf(ofp
, "common_comm,\n\t");
1233 fprintf(ofp
, "common_callchain, ");
1238 for (f
= event
->format
.fields
; f
; f
= f
->next
) {
1241 if (++count
% 5 == 0)
1242 fprintf(ofp
, "\n\t");
1244 fprintf(ofp
, "%s", f
->name
);
1246 fprintf(ofp
, "):\n");
1248 fprintf(ofp
, "\t\tprint_header(event_name, common_cpu, "
1249 "common_secs, common_nsecs,\n\t\t\t"
1250 "common_pid, common_comm)\n\n");
1252 fprintf(ofp
, "\t\tprint \"");
1257 for (f
= event
->format
.fields
; f
; f
= f
->next
) {
1260 if (count
&& count
% 3 == 0) {
1261 fprintf(ofp
, "\" \\\n\t\t\"");
1265 fprintf(ofp
, "%s=", f
->name
);
1266 if (f
->flags
& FIELD_IS_STRING
||
1267 f
->flags
& FIELD_IS_FLAG
||
1268 f
->flags
& FIELD_IS_ARRAY
||
1269 f
->flags
& FIELD_IS_SYMBOLIC
)
1270 fprintf(ofp
, "%%s");
1271 else if (f
->flags
& FIELD_IS_SIGNED
)
1272 fprintf(ofp
, "%%d");
1274 fprintf(ofp
, "%%u");
1277 fprintf(ofp
, "\" %% \\\n\t\t(");
1282 for (f
= event
->format
.fields
; f
; f
= f
->next
) {
1286 if (++count
% 5 == 0)
1287 fprintf(ofp
, "\n\t\t");
1289 if (f
->flags
& FIELD_IS_FLAG
) {
1290 if ((count
- 1) % 5 != 0) {
1291 fprintf(ofp
, "\n\t\t");
1294 fprintf(ofp
, "flag_str(\"");
1295 fprintf(ofp
, "%s__%s\", ", event
->system
,
1297 fprintf(ofp
, "\"%s\", %s)", f
->name
,
1299 } else if (f
->flags
& FIELD_IS_SYMBOLIC
) {
1300 if ((count
- 1) % 5 != 0) {
1301 fprintf(ofp
, "\n\t\t");
1304 fprintf(ofp
, "symbol_str(\"");
1305 fprintf(ofp
, "%s__%s\", ", event
->system
,
1307 fprintf(ofp
, "\"%s\", %s)", f
->name
,
1310 fprintf(ofp
, "%s", f
->name
);
1313 fprintf(ofp
, ")\n\n");
1315 fprintf(ofp
, "\t\tfor node in common_callchain:");
1316 fprintf(ofp
, "\n\t\t\tif 'sym' in node:");
1317 fprintf(ofp
, "\n\t\t\t\tprint \"\\t[%%x] %%s\" %% (node['ip'], node['sym']['name'])");
1318 fprintf(ofp
, "\n\t\t\telse:");
1319 fprintf(ofp
, "\n\t\t\t\tprint \"\t[%%x]\" %% (node['ip'])\n\n");
1320 fprintf(ofp
, "\t\tprint \"\\n\"\n\n");
1324 fprintf(ofp
, "def trace_unhandled(event_name, context, "
1325 "event_fields_dict):\n");
1327 fprintf(ofp
, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
1328 "for k,v in sorted(event_fields_dict.items())])\n\n");
1330 fprintf(ofp
, "def print_header("
1331 "event_name, cpu, secs, nsecs, pid, comm):\n"
1332 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
1333 "(event_name, cpu, secs, nsecs, pid, comm),\n");
1337 fprintf(stderr
, "generated Python script: %s\n", fname
);
1342 struct scripting_ops python_scripting_ops
= {
1344 .start_script
= python_start_script
,
1345 .flush_script
= python_flush_script
,
1346 .stop_script
= python_stop_script
,
1347 .process_event
= python_process_event
,
1348 .process_stat
= python_process_stat
,
1349 .process_stat_interval
= python_process_stat_interval
,
1350 .generate_script
= python_generate_script
,