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 "thread_map.h"
48 PyMODINIT_FUNC
initperf_trace_context(void);
50 #define TRACE_EVENT_TYPE_MAX \
51 ((1 << (sizeof(unsigned short) * 8)) - 1)
53 static DECLARE_BITMAP(events_defined
, TRACE_EVENT_TYPE_MAX
);
56 #define N_COMMON_FIELDS 7
58 extern struct scripting_context
*scripting_context
;
60 static char *cur_field_name
;
61 static int zero_flag_atom
;
63 static PyObject
*main_module
, *main_dict
;
67 PyObject
*evsel_handler
;
68 PyObject
*machine_handler
;
69 PyObject
*thread_handler
;
70 PyObject
*comm_handler
;
71 PyObject
*comm_thread_handler
;
72 PyObject
*dso_handler
;
73 PyObject
*symbol_handler
;
74 PyObject
*branch_type_handler
;
75 PyObject
*sample_handler
;
76 PyObject
*call_path_handler
;
77 PyObject
*call_return_handler
;
81 static struct tables tables_global
;
83 static void handler_call_die(const char *handler_name
) NORETURN
;
84 static void handler_call_die(const char *handler_name
)
87 Py_FatalError("problem in Python trace event handler");
88 // Py_FatalError does not return
89 // but we have to make the compiler happy
94 * Insert val into into the dictionary and decrement the reference counter.
95 * This is necessary for dictionaries since PyDict_SetItemString() does not
96 * steal a reference, as opposed to PyTuple_SetItem().
98 static void pydict_set_item_string_decref(PyObject
*dict
, const char *key
, PyObject
*val
)
100 PyDict_SetItemString(dict
, key
, val
);
104 static PyObject
*get_handler(const char *handler_name
)
108 handler
= PyDict_GetItemString(main_dict
, handler_name
);
109 if (handler
&& !PyCallable_Check(handler
))
114 static void call_object(PyObject
*handler
, PyObject
*args
, const char *die_msg
)
118 retval
= PyObject_CallObject(handler
, args
);
120 handler_call_die(die_msg
);
124 static void try_call_object(const char *handler_name
, PyObject
*args
)
128 handler
= get_handler(handler_name
);
130 call_object(handler
, args
, handler_name
);
133 static void define_value(enum print_arg_type field_type
,
135 const char *field_name
,
136 const char *field_value
,
137 const char *field_str
)
139 const char *handler_name
= "define_flag_value";
141 unsigned long long value
;
144 if (field_type
== PRINT_SYMBOL
)
145 handler_name
= "define_symbolic_value";
149 Py_FatalError("couldn't create Python tuple");
151 value
= eval_flag(field_value
);
153 PyTuple_SetItem(t
, n
++, PyString_FromString(ev_name
));
154 PyTuple_SetItem(t
, n
++, PyString_FromString(field_name
));
155 PyTuple_SetItem(t
, n
++, PyInt_FromLong(value
));
156 PyTuple_SetItem(t
, n
++, PyString_FromString(field_str
));
158 try_call_object(handler_name
, t
);
163 static void define_values(enum print_arg_type field_type
,
164 struct print_flag_sym
*field
,
166 const char *field_name
)
168 define_value(field_type
, ev_name
, field_name
, field
->value
,
172 define_values(field_type
, field
->next
, ev_name
, field_name
);
175 static void define_field(enum print_arg_type field_type
,
177 const char *field_name
,
180 const char *handler_name
= "define_flag_field";
184 if (field_type
== PRINT_SYMBOL
)
185 handler_name
= "define_symbolic_field";
187 if (field_type
== PRINT_FLAGS
)
192 Py_FatalError("couldn't create Python tuple");
194 PyTuple_SetItem(t
, n
++, PyString_FromString(ev_name
));
195 PyTuple_SetItem(t
, n
++, PyString_FromString(field_name
));
196 if (field_type
== PRINT_FLAGS
)
197 PyTuple_SetItem(t
, n
++, PyString_FromString(delim
));
199 try_call_object(handler_name
, t
);
204 static void define_event_symbols(struct event_format
*event
,
206 struct print_arg
*args
)
211 switch (args
->type
) {
215 define_value(PRINT_FLAGS
, ev_name
, cur_field_name
, "0",
220 free(cur_field_name
);
221 cur_field_name
= strdup(args
->field
.name
);
224 define_event_symbols(event
, ev_name
, args
->flags
.field
);
225 define_field(PRINT_FLAGS
, ev_name
, cur_field_name
,
227 define_values(PRINT_FLAGS
, args
->flags
.flags
, ev_name
,
231 define_event_symbols(event
, ev_name
, args
->symbol
.field
);
232 define_field(PRINT_SYMBOL
, ev_name
, cur_field_name
, NULL
);
233 define_values(PRINT_SYMBOL
, args
->symbol
.symbols
, ev_name
,
237 define_event_symbols(event
, ev_name
, args
->hex
.field
);
238 define_event_symbols(event
, ev_name
, args
->hex
.size
);
240 case PRINT_INT_ARRAY
:
241 define_event_symbols(event
, ev_name
, args
->int_array
.field
);
242 define_event_symbols(event
, ev_name
, args
->int_array
.count
);
243 define_event_symbols(event
, ev_name
, args
->int_array
.el_size
);
248 define_event_symbols(event
, ev_name
, args
->typecast
.item
);
251 if (strcmp(args
->op
.op
, ":") == 0)
253 define_event_symbols(event
, ev_name
, args
->op
.left
);
254 define_event_symbols(event
, ev_name
, args
->op
.right
);
257 /* gcc warns for these? */
259 case PRINT_DYNAMIC_ARRAY
:
260 case PRINT_DYNAMIC_ARRAY_LEN
:
263 /* we should warn... */
268 define_event_symbols(event
, ev_name
, args
->next
);
271 static PyObject
*get_field_numeric_entry(struct event_format
*event
,
272 struct format_field
*field
, void *data
)
274 bool is_array
= field
->flags
& FIELD_IS_ARRAY
;
275 PyObject
*obj
, *list
= NULL
;
276 unsigned long long val
;
277 unsigned int item_size
, n_items
, i
;
280 list
= PyList_New(field
->arraylen
);
281 item_size
= field
->size
/ field
->arraylen
;
282 n_items
= field
->arraylen
;
284 item_size
= field
->size
;
288 for (i
= 0; i
< n_items
; i
++) {
290 val
= read_size(event
, data
+ field
->offset
+ i
* item_size
,
292 if (field
->flags
& FIELD_IS_SIGNED
) {
293 if ((long long)val
>= LONG_MIN
&&
294 (long long)val
<= LONG_MAX
)
295 obj
= PyInt_FromLong(val
);
297 obj
= PyLong_FromLongLong(val
);
300 obj
= PyInt_FromLong(val
);
302 obj
= PyLong_FromUnsignedLongLong(val
);
305 PyList_SET_ITEM(list
, i
, obj
);
313 static PyObject
*python_process_callchain(struct perf_sample
*sample
,
314 struct perf_evsel
*evsel
,
315 struct addr_location
*al
)
319 pylist
= PyList_New(0);
321 Py_FatalError("couldn't create Python list");
323 if (!symbol_conf
.use_callchain
|| !sample
->callchain
)
326 if (thread__resolve_callchain(al
->thread
, evsel
,
328 scripting_max_stack
) != 0) {
329 pr_err("Failed to resolve callchain. Skipping\n");
332 callchain_cursor_commit(&callchain_cursor
);
337 struct callchain_cursor_node
*node
;
338 node
= callchain_cursor_current(&callchain_cursor
);
342 pyelem
= PyDict_New();
344 Py_FatalError("couldn't create Python dictionary");
347 pydict_set_item_string_decref(pyelem
, "ip",
348 PyLong_FromUnsignedLongLong(node
->ip
));
351 PyObject
*pysym
= PyDict_New();
353 Py_FatalError("couldn't create Python dictionary");
354 pydict_set_item_string_decref(pysym
, "start",
355 PyLong_FromUnsignedLongLong(node
->sym
->start
));
356 pydict_set_item_string_decref(pysym
, "end",
357 PyLong_FromUnsignedLongLong(node
->sym
->end
));
358 pydict_set_item_string_decref(pysym
, "binding",
359 PyInt_FromLong(node
->sym
->binding
));
360 pydict_set_item_string_decref(pysym
, "name",
361 PyString_FromStringAndSize(node
->sym
->name
,
362 node
->sym
->namelen
));
363 pydict_set_item_string_decref(pyelem
, "sym", pysym
);
367 struct map
*map
= node
->map
;
368 const char *dsoname
= "[unknown]";
369 if (map
&& map
->dso
&& (map
->dso
->name
|| map
->dso
->long_name
)) {
370 if (symbol_conf
.show_kernel_path
&& map
->dso
->long_name
)
371 dsoname
= map
->dso
->long_name
;
372 else if (map
->dso
->name
)
373 dsoname
= map
->dso
->name
;
375 pydict_set_item_string_decref(pyelem
, "dso",
376 PyString_FromString(dsoname
));
379 callchain_cursor_advance(&callchain_cursor
);
380 PyList_Append(pylist
, pyelem
);
389 static void python_process_tracepoint(struct perf_sample
*sample
,
390 struct perf_evsel
*evsel
,
391 struct addr_location
*al
)
393 struct event_format
*event
= evsel
->tp_format
;
394 PyObject
*handler
, *context
, *t
, *obj
, *callchain
;
395 PyObject
*dict
= NULL
;
396 static char handler_name
[256];
397 struct format_field
*field
;
401 int cpu
= sample
->cpu
;
402 void *data
= sample
->raw_data
;
403 unsigned long long nsecs
= sample
->time
;
404 const char *comm
= thread__comm_str(al
->thread
);
406 t
= PyTuple_New(MAX_FIELDS
);
408 Py_FatalError("couldn't create Python tuple");
411 die("ug! no event found for type %d", (int)evsel
->attr
.config
);
413 pid
= raw_field_value(event
, "common_pid", data
);
415 sprintf(handler_name
, "%s__%s", event
->system
, event
->name
);
417 if (!test_and_set_bit(event
->id
, events_defined
))
418 define_event_symbols(event
, handler_name
, event
->print_fmt
.args
);
420 handler
= get_handler(handler_name
);
424 Py_FatalError("couldn't create Python dict");
426 s
= nsecs
/ NSECS_PER_SEC
;
427 ns
= nsecs
- s
* NSECS_PER_SEC
;
429 scripting_context
->event_data
= data
;
430 scripting_context
->pevent
= evsel
->tp_format
->pevent
;
432 context
= PyCObject_FromVoidPtr(scripting_context
, NULL
);
434 PyTuple_SetItem(t
, n
++, PyString_FromString(handler_name
));
435 PyTuple_SetItem(t
, n
++, context
);
438 callchain
= python_process_callchain(sample
, evsel
, al
);
441 PyTuple_SetItem(t
, n
++, PyInt_FromLong(cpu
));
442 PyTuple_SetItem(t
, n
++, PyInt_FromLong(s
));
443 PyTuple_SetItem(t
, n
++, PyInt_FromLong(ns
));
444 PyTuple_SetItem(t
, n
++, PyInt_FromLong(pid
));
445 PyTuple_SetItem(t
, n
++, PyString_FromString(comm
));
446 PyTuple_SetItem(t
, n
++, callchain
);
448 pydict_set_item_string_decref(dict
, "common_cpu", PyInt_FromLong(cpu
));
449 pydict_set_item_string_decref(dict
, "common_s", PyInt_FromLong(s
));
450 pydict_set_item_string_decref(dict
, "common_ns", PyInt_FromLong(ns
));
451 pydict_set_item_string_decref(dict
, "common_pid", PyInt_FromLong(pid
));
452 pydict_set_item_string_decref(dict
, "common_comm", PyString_FromString(comm
));
453 pydict_set_item_string_decref(dict
, "common_callchain", callchain
);
455 for (field
= event
->format
.fields
; field
; field
= field
->next
) {
456 if (field
->flags
& FIELD_IS_STRING
) {
458 if (field
->flags
& FIELD_IS_DYNAMIC
) {
459 offset
= *(int *)(data
+ field
->offset
);
462 offset
= field
->offset
;
463 obj
= PyString_FromString((char *)data
+ offset
);
464 } else { /* FIELD_IS_NUMERIC */
465 obj
= get_field_numeric_entry(event
, field
, data
);
468 PyTuple_SetItem(t
, n
++, obj
);
470 pydict_set_item_string_decref(dict
, field
->name
, obj
);
475 PyTuple_SetItem(t
, n
++, dict
);
477 if (_PyTuple_Resize(&t
, n
) == -1)
478 Py_FatalError("error resizing Python tuple");
481 call_object(handler
, t
, handler_name
);
483 try_call_object("trace_unhandled", t
);
490 static PyObject
*tuple_new(unsigned int sz
)
496 Py_FatalError("couldn't create Python tuple");
500 static int tuple_set_u64(PyObject
*t
, unsigned int pos
, u64 val
)
502 #if BITS_PER_LONG == 64
503 return PyTuple_SetItem(t
, pos
, PyInt_FromLong(val
));
505 #if BITS_PER_LONG == 32
506 return PyTuple_SetItem(t
, pos
, PyLong_FromLongLong(val
));
510 static int tuple_set_s32(PyObject
*t
, unsigned int pos
, s32 val
)
512 return PyTuple_SetItem(t
, pos
, PyInt_FromLong(val
));
515 static int tuple_set_string(PyObject
*t
, unsigned int pos
, const char *s
)
517 return PyTuple_SetItem(t
, pos
, PyString_FromString(s
));
520 static int python_export_evsel(struct db_export
*dbe
, struct perf_evsel
*evsel
)
522 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
527 tuple_set_u64(t
, 0, evsel
->db_id
);
528 tuple_set_string(t
, 1, perf_evsel__name(evsel
));
530 call_object(tables
->evsel_handler
, t
, "evsel_table");
537 static int python_export_machine(struct db_export
*dbe
,
538 struct machine
*machine
)
540 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
545 tuple_set_u64(t
, 0, machine
->db_id
);
546 tuple_set_s32(t
, 1, machine
->pid
);
547 tuple_set_string(t
, 2, machine
->root_dir
? machine
->root_dir
: "");
549 call_object(tables
->machine_handler
, t
, "machine_table");
556 static int python_export_thread(struct db_export
*dbe
, struct thread
*thread
,
557 u64 main_thread_db_id
, struct machine
*machine
)
559 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
564 tuple_set_u64(t
, 0, thread
->db_id
);
565 tuple_set_u64(t
, 1, machine
->db_id
);
566 tuple_set_u64(t
, 2, main_thread_db_id
);
567 tuple_set_s32(t
, 3, thread
->pid_
);
568 tuple_set_s32(t
, 4, thread
->tid
);
570 call_object(tables
->thread_handler
, t
, "thread_table");
577 static int python_export_comm(struct db_export
*dbe
, struct comm
*comm
)
579 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
584 tuple_set_u64(t
, 0, comm
->db_id
);
585 tuple_set_string(t
, 1, comm__str(comm
));
587 call_object(tables
->comm_handler
, t
, "comm_table");
594 static int python_export_comm_thread(struct db_export
*dbe
, u64 db_id
,
595 struct comm
*comm
, struct thread
*thread
)
597 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
602 tuple_set_u64(t
, 0, db_id
);
603 tuple_set_u64(t
, 1, comm
->db_id
);
604 tuple_set_u64(t
, 2, thread
->db_id
);
606 call_object(tables
->comm_thread_handler
, t
, "comm_thread_table");
613 static int python_export_dso(struct db_export
*dbe
, struct dso
*dso
,
614 struct machine
*machine
)
616 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
617 char sbuild_id
[BUILD_ID_SIZE
* 2 + 1];
620 build_id__sprintf(dso
->build_id
, sizeof(dso
->build_id
), sbuild_id
);
624 tuple_set_u64(t
, 0, dso
->db_id
);
625 tuple_set_u64(t
, 1, machine
->db_id
);
626 tuple_set_string(t
, 2, dso
->short_name
);
627 tuple_set_string(t
, 3, dso
->long_name
);
628 tuple_set_string(t
, 4, sbuild_id
);
630 call_object(tables
->dso_handler
, t
, "dso_table");
637 static int python_export_symbol(struct db_export
*dbe
, struct symbol
*sym
,
640 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
641 u64
*sym_db_id
= symbol__priv(sym
);
646 tuple_set_u64(t
, 0, *sym_db_id
);
647 tuple_set_u64(t
, 1, dso
->db_id
);
648 tuple_set_u64(t
, 2, sym
->start
);
649 tuple_set_u64(t
, 3, sym
->end
);
650 tuple_set_s32(t
, 4, sym
->binding
);
651 tuple_set_string(t
, 5, sym
->name
);
653 call_object(tables
->symbol_handler
, t
, "symbol_table");
660 static int python_export_branch_type(struct db_export
*dbe
, u32 branch_type
,
663 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
668 tuple_set_s32(t
, 0, branch_type
);
669 tuple_set_string(t
, 1, name
);
671 call_object(tables
->branch_type_handler
, t
, "branch_type_table");
678 static int python_export_sample(struct db_export
*dbe
,
679 struct export_sample
*es
)
681 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
686 tuple_set_u64(t
, 0, es
->db_id
);
687 tuple_set_u64(t
, 1, es
->evsel
->db_id
);
688 tuple_set_u64(t
, 2, es
->al
->machine
->db_id
);
689 tuple_set_u64(t
, 3, es
->al
->thread
->db_id
);
690 tuple_set_u64(t
, 4, es
->comm_db_id
);
691 tuple_set_u64(t
, 5, es
->dso_db_id
);
692 tuple_set_u64(t
, 6, es
->sym_db_id
);
693 tuple_set_u64(t
, 7, es
->offset
);
694 tuple_set_u64(t
, 8, es
->sample
->ip
);
695 tuple_set_u64(t
, 9, es
->sample
->time
);
696 tuple_set_s32(t
, 10, es
->sample
->cpu
);
697 tuple_set_u64(t
, 11, es
->addr_dso_db_id
);
698 tuple_set_u64(t
, 12, es
->addr_sym_db_id
);
699 tuple_set_u64(t
, 13, es
->addr_offset
);
700 tuple_set_u64(t
, 14, es
->sample
->addr
);
701 tuple_set_u64(t
, 15, es
->sample
->period
);
702 tuple_set_u64(t
, 16, es
->sample
->weight
);
703 tuple_set_u64(t
, 17, es
->sample
->transaction
);
704 tuple_set_u64(t
, 18, es
->sample
->data_src
);
705 tuple_set_s32(t
, 19, es
->sample
->flags
& PERF_BRANCH_MASK
);
706 tuple_set_s32(t
, 20, !!(es
->sample
->flags
& PERF_IP_FLAG_IN_TX
));
708 call_object(tables
->sample_handler
, t
, "sample_table");
715 static int python_export_call_path(struct db_export
*dbe
, struct call_path
*cp
)
717 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
719 u64 parent_db_id
, sym_db_id
;
721 parent_db_id
= cp
->parent
? cp
->parent
->db_id
: 0;
722 sym_db_id
= cp
->sym
? *(u64
*)symbol__priv(cp
->sym
) : 0;
726 tuple_set_u64(t
, 0, cp
->db_id
);
727 tuple_set_u64(t
, 1, parent_db_id
);
728 tuple_set_u64(t
, 2, sym_db_id
);
729 tuple_set_u64(t
, 3, cp
->ip
);
731 call_object(tables
->call_path_handler
, t
, "call_path_table");
738 static int python_export_call_return(struct db_export
*dbe
,
739 struct call_return
*cr
)
741 struct tables
*tables
= container_of(dbe
, struct tables
, dbe
);
742 u64 comm_db_id
= cr
->comm
? cr
->comm
->db_id
: 0;
747 tuple_set_u64(t
, 0, cr
->db_id
);
748 tuple_set_u64(t
, 1, cr
->thread
->db_id
);
749 tuple_set_u64(t
, 2, comm_db_id
);
750 tuple_set_u64(t
, 3, cr
->cp
->db_id
);
751 tuple_set_u64(t
, 4, cr
->call_time
);
752 tuple_set_u64(t
, 5, cr
->return_time
);
753 tuple_set_u64(t
, 6, cr
->branch_count
);
754 tuple_set_u64(t
, 7, cr
->call_ref
);
755 tuple_set_u64(t
, 8, cr
->return_ref
);
756 tuple_set_u64(t
, 9, cr
->cp
->parent
->db_id
);
757 tuple_set_s32(t
, 10, cr
->flags
);
759 call_object(tables
->call_return_handler
, t
, "call_return_table");
766 static int python_process_call_return(struct call_return
*cr
, void *data
)
768 struct db_export
*dbe
= data
;
770 return db_export__call_return(dbe
, cr
);
773 static void python_process_general_event(struct perf_sample
*sample
,
774 struct perf_evsel
*evsel
,
775 struct addr_location
*al
)
777 PyObject
*handler
, *t
, *dict
, *callchain
, *dict_sample
;
778 static char handler_name
[64];
782 * Use the MAX_FIELDS to make the function expandable, though
783 * currently there is only one item for the tuple.
785 t
= PyTuple_New(MAX_FIELDS
);
787 Py_FatalError("couldn't create Python tuple");
791 Py_FatalError("couldn't create Python dictionary");
793 dict_sample
= PyDict_New();
795 Py_FatalError("couldn't create Python dictionary");
797 snprintf(handler_name
, sizeof(handler_name
), "%s", "process_event");
799 handler
= get_handler(handler_name
);
803 pydict_set_item_string_decref(dict
, "ev_name", PyString_FromString(perf_evsel__name(evsel
)));
804 pydict_set_item_string_decref(dict
, "attr", PyString_FromStringAndSize(
805 (const char *)&evsel
->attr
, sizeof(evsel
->attr
)));
807 pydict_set_item_string_decref(dict_sample
, "pid",
808 PyInt_FromLong(sample
->pid
));
809 pydict_set_item_string_decref(dict_sample
, "tid",
810 PyInt_FromLong(sample
->tid
));
811 pydict_set_item_string_decref(dict_sample
, "cpu",
812 PyInt_FromLong(sample
->cpu
));
813 pydict_set_item_string_decref(dict_sample
, "ip",
814 PyLong_FromUnsignedLongLong(sample
->ip
));
815 pydict_set_item_string_decref(dict_sample
, "time",
816 PyLong_FromUnsignedLongLong(sample
->time
));
817 pydict_set_item_string_decref(dict_sample
, "period",
818 PyLong_FromUnsignedLongLong(sample
->period
));
819 pydict_set_item_string_decref(dict
, "sample", dict_sample
);
821 pydict_set_item_string_decref(dict
, "raw_buf", PyString_FromStringAndSize(
822 (const char *)sample
->raw_data
, sample
->raw_size
));
823 pydict_set_item_string_decref(dict
, "comm",
824 PyString_FromString(thread__comm_str(al
->thread
)));
826 pydict_set_item_string_decref(dict
, "dso",
827 PyString_FromString(al
->map
->dso
->name
));
830 pydict_set_item_string_decref(dict
, "symbol",
831 PyString_FromString(al
->sym
->name
));
835 callchain
= python_process_callchain(sample
, evsel
, al
);
836 pydict_set_item_string_decref(dict
, "callchain", callchain
);
838 PyTuple_SetItem(t
, n
++, dict
);
839 if (_PyTuple_Resize(&t
, n
) == -1)
840 Py_FatalError("error resizing Python tuple");
842 call_object(handler
, t
, handler_name
);
848 static void python_process_event(union perf_event
*event
,
849 struct perf_sample
*sample
,
850 struct perf_evsel
*evsel
,
851 struct addr_location
*al
)
853 struct tables
*tables
= &tables_global
;
855 switch (evsel
->attr
.type
) {
856 case PERF_TYPE_TRACEPOINT
:
857 python_process_tracepoint(sample
, evsel
, al
);
859 /* Reserve for future process_hw/sw/raw APIs */
861 if (tables
->db_export_mode
)
862 db_export__sample(&tables
->dbe
, event
, sample
, evsel
, al
);
864 python_process_general_event(sample
, evsel
, al
);
868 static void get_handler_name(char *str
, size_t size
,
869 struct perf_evsel
*evsel
)
873 scnprintf(str
, size
, "stat__%s", perf_evsel__name(evsel
));
875 while ((p
= strchr(p
, ':'))) {
882 process_stat(struct perf_evsel
*counter
, int cpu
, int thread
, u64 tstamp
,
883 struct perf_counts_values
*count
)
885 PyObject
*handler
, *t
;
886 static char handler_name
[256];
889 t
= PyTuple_New(MAX_FIELDS
);
891 Py_FatalError("couldn't create Python tuple");
893 get_handler_name(handler_name
, sizeof(handler_name
),
896 handler
= get_handler(handler_name
);
898 pr_debug("can't find python handler %s\n", handler_name
);
902 PyTuple_SetItem(t
, n
++, PyInt_FromLong(cpu
));
903 PyTuple_SetItem(t
, n
++, PyInt_FromLong(thread
));
905 tuple_set_u64(t
, n
++, tstamp
);
906 tuple_set_u64(t
, n
++, count
->val
);
907 tuple_set_u64(t
, n
++, count
->ena
);
908 tuple_set_u64(t
, n
++, count
->run
);
910 if (_PyTuple_Resize(&t
, n
) == -1)
911 Py_FatalError("error resizing Python tuple");
913 call_object(handler
, t
, handler_name
);
918 static void python_process_stat(struct perf_stat_config
*config
,
919 struct perf_evsel
*counter
, u64 tstamp
)
921 struct thread_map
*threads
= counter
->threads
;
922 struct cpu_map
*cpus
= counter
->cpus
;
925 if (config
->aggr_mode
== AGGR_GLOBAL
) {
926 process_stat(counter
, -1, -1, tstamp
,
927 &counter
->counts
->aggr
);
931 for (thread
= 0; thread
< threads
->nr
; thread
++) {
932 for (cpu
= 0; cpu
< cpus
->nr
; cpu
++) {
933 process_stat(counter
, cpus
->map
[cpu
],
934 thread_map__pid(threads
, thread
), tstamp
,
935 perf_counts(counter
->counts
, cpu
, thread
));
940 static void python_process_stat_interval(u64 tstamp
)
942 PyObject
*handler
, *t
;
943 static const char handler_name
[] = "stat__interval";
946 t
= PyTuple_New(MAX_FIELDS
);
948 Py_FatalError("couldn't create Python tuple");
950 handler
= get_handler(handler_name
);
952 pr_debug("can't find python handler %s\n", handler_name
);
956 tuple_set_u64(t
, n
++, tstamp
);
958 if (_PyTuple_Resize(&t
, n
) == -1)
959 Py_FatalError("error resizing Python tuple");
961 call_object(handler
, t
, handler_name
);
966 static int run_start_sub(void)
968 main_module
= PyImport_AddModule("__main__");
969 if (main_module
== NULL
)
971 Py_INCREF(main_module
);
973 main_dict
= PyModule_GetDict(main_module
);
974 if (main_dict
== NULL
)
976 Py_INCREF(main_dict
);
978 try_call_object("trace_begin", NULL
);
983 Py_XDECREF(main_dict
);
984 Py_XDECREF(main_module
);
988 #define SET_TABLE_HANDLER_(name, handler_name, table_name) do { \
989 tables->handler_name = get_handler(#table_name); \
990 if (tables->handler_name) \
991 tables->dbe.export_ ## name = python_export_ ## name; \
994 #define SET_TABLE_HANDLER(name) \
995 SET_TABLE_HANDLER_(name, name ## _handler, name ## _table)
997 static void set_table_handlers(struct tables
*tables
)
999 const char *perf_db_export_mode
= "perf_db_export_mode";
1000 const char *perf_db_export_calls
= "perf_db_export_calls";
1001 PyObject
*db_export_mode
, *db_export_calls
;
1002 bool export_calls
= false;
1005 memset(tables
, 0, sizeof(struct tables
));
1006 if (db_export__init(&tables
->dbe
))
1007 Py_FatalError("failed to initialize export");
1009 db_export_mode
= PyDict_GetItemString(main_dict
, perf_db_export_mode
);
1010 if (!db_export_mode
)
1013 ret
= PyObject_IsTrue(db_export_mode
);
1015 handler_call_die(perf_db_export_mode
);
1019 tables
->dbe
.crp
= NULL
;
1020 db_export_calls
= PyDict_GetItemString(main_dict
, perf_db_export_calls
);
1021 if (db_export_calls
) {
1022 ret
= PyObject_IsTrue(db_export_calls
);
1024 handler_call_die(perf_db_export_calls
);
1025 export_calls
= !!ret
;
1030 call_return_processor__new(python_process_call_return
,
1032 if (!tables
->dbe
.crp
)
1033 Py_FatalError("failed to create calls processor");
1036 tables
->db_export_mode
= true;
1038 * Reserve per symbol space for symbol->db_id via symbol__priv()
1040 symbol_conf
.priv_size
= sizeof(u64
);
1042 SET_TABLE_HANDLER(evsel
);
1043 SET_TABLE_HANDLER(machine
);
1044 SET_TABLE_HANDLER(thread
);
1045 SET_TABLE_HANDLER(comm
);
1046 SET_TABLE_HANDLER(comm_thread
);
1047 SET_TABLE_HANDLER(dso
);
1048 SET_TABLE_HANDLER(symbol
);
1049 SET_TABLE_HANDLER(branch_type
);
1050 SET_TABLE_HANDLER(sample
);
1051 SET_TABLE_HANDLER(call_path
);
1052 SET_TABLE_HANDLER(call_return
);
1056 * Start trace script
1058 static int python_start_script(const char *script
, int argc
, const char **argv
)
1060 struct tables
*tables
= &tables_global
;
1061 const char **command_line
;
1066 command_line
= malloc((argc
+ 1) * sizeof(const char *));
1067 command_line
[0] = script
;
1068 for (i
= 1; i
< argc
+ 1; i
++)
1069 command_line
[i
] = argv
[i
- 1];
1073 initperf_trace_context();
1075 PySys_SetArgv(argc
+ 1, (char **)command_line
);
1077 fp
= fopen(script
, "r");
1079 sprintf(buf
, "Can't open python script \"%s\"", script
);
1085 err
= PyRun_SimpleFile(fp
, script
);
1087 fprintf(stderr
, "Error running python script %s\n", script
);
1091 err
= run_start_sub();
1093 fprintf(stderr
, "Error starting python script %s\n", script
);
1097 set_table_handlers(tables
);
1099 if (tables
->db_export_mode
) {
1100 err
= db_export__branch_types(&tables
->dbe
);
1115 static int python_flush_script(void)
1117 struct tables
*tables
= &tables_global
;
1119 return db_export__flush(&tables
->dbe
);
1125 static int python_stop_script(void)
1127 struct tables
*tables
= &tables_global
;
1129 try_call_object("trace_end", NULL
);
1131 db_export__exit(&tables
->dbe
);
1133 Py_XDECREF(main_dict
);
1134 Py_XDECREF(main_module
);
1140 static int python_generate_script(struct pevent
*pevent
, const char *outfile
)
1142 struct event_format
*event
= NULL
;
1143 struct format_field
*f
;
1144 char fname
[PATH_MAX
];
1145 int not_first
, count
;
1148 sprintf(fname
, "%s.py", outfile
);
1149 ofp
= fopen(fname
, "w");
1151 fprintf(stderr
, "couldn't open %s\n", fname
);
1154 fprintf(ofp
, "# perf script event handlers, "
1155 "generated by perf script -g python\n");
1157 fprintf(ofp
, "# Licensed under the terms of the GNU GPL"
1158 " License version 2\n\n");
1160 fprintf(ofp
, "# The common_* event handler fields are the most useful "
1161 "fields common to\n");
1163 fprintf(ofp
, "# all events. They don't necessarily correspond to "
1164 "the 'common_*' fields\n");
1166 fprintf(ofp
, "# in the format files. Those fields not available as "
1167 "handler params can\n");
1169 fprintf(ofp
, "# be retrieved using Python functions of the form "
1170 "common_*(context).\n");
1172 fprintf(ofp
, "# See the perf-trace-python Documentation for the list "
1173 "of available functions.\n\n");
1175 fprintf(ofp
, "import os\n");
1176 fprintf(ofp
, "import sys\n\n");
1178 fprintf(ofp
, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
1179 fprintf(ofp
, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
1180 fprintf(ofp
, "\nfrom perf_trace_context import *\n");
1181 fprintf(ofp
, "from Core import *\n\n\n");
1183 fprintf(ofp
, "def trace_begin():\n");
1184 fprintf(ofp
, "\tprint \"in trace_begin\"\n\n");
1186 fprintf(ofp
, "def trace_end():\n");
1187 fprintf(ofp
, "\tprint \"in trace_end\"\n\n");
1189 while ((event
= trace_find_next_event(pevent
, event
))) {
1190 fprintf(ofp
, "def %s__%s(", event
->system
, event
->name
);
1191 fprintf(ofp
, "event_name, ");
1192 fprintf(ofp
, "context, ");
1193 fprintf(ofp
, "common_cpu,\n");
1194 fprintf(ofp
, "\tcommon_secs, ");
1195 fprintf(ofp
, "common_nsecs, ");
1196 fprintf(ofp
, "common_pid, ");
1197 fprintf(ofp
, "common_comm,\n\t");
1198 fprintf(ofp
, "common_callchain, ");
1203 for (f
= event
->format
.fields
; f
; f
= f
->next
) {
1206 if (++count
% 5 == 0)
1207 fprintf(ofp
, "\n\t");
1209 fprintf(ofp
, "%s", f
->name
);
1211 fprintf(ofp
, "):\n");
1213 fprintf(ofp
, "\t\tprint_header(event_name, common_cpu, "
1214 "common_secs, common_nsecs,\n\t\t\t"
1215 "common_pid, common_comm)\n\n");
1217 fprintf(ofp
, "\t\tprint \"");
1222 for (f
= event
->format
.fields
; f
; f
= f
->next
) {
1225 if (count
&& count
% 3 == 0) {
1226 fprintf(ofp
, "\" \\\n\t\t\"");
1230 fprintf(ofp
, "%s=", f
->name
);
1231 if (f
->flags
& FIELD_IS_STRING
||
1232 f
->flags
& FIELD_IS_FLAG
||
1233 f
->flags
& FIELD_IS_ARRAY
||
1234 f
->flags
& FIELD_IS_SYMBOLIC
)
1235 fprintf(ofp
, "%%s");
1236 else if (f
->flags
& FIELD_IS_SIGNED
)
1237 fprintf(ofp
, "%%d");
1239 fprintf(ofp
, "%%u");
1242 fprintf(ofp
, "\" %% \\\n\t\t(");
1247 for (f
= event
->format
.fields
; f
; f
= f
->next
) {
1251 if (++count
% 5 == 0)
1252 fprintf(ofp
, "\n\t\t");
1254 if (f
->flags
& FIELD_IS_FLAG
) {
1255 if ((count
- 1) % 5 != 0) {
1256 fprintf(ofp
, "\n\t\t");
1259 fprintf(ofp
, "flag_str(\"");
1260 fprintf(ofp
, "%s__%s\", ", event
->system
,
1262 fprintf(ofp
, "\"%s\", %s)", f
->name
,
1264 } else if (f
->flags
& FIELD_IS_SYMBOLIC
) {
1265 if ((count
- 1) % 5 != 0) {
1266 fprintf(ofp
, "\n\t\t");
1269 fprintf(ofp
, "symbol_str(\"");
1270 fprintf(ofp
, "%s__%s\", ", event
->system
,
1272 fprintf(ofp
, "\"%s\", %s)", f
->name
,
1275 fprintf(ofp
, "%s", f
->name
);
1278 fprintf(ofp
, ")\n\n");
1280 fprintf(ofp
, "\t\tfor node in common_callchain:");
1281 fprintf(ofp
, "\n\t\t\tif 'sym' in node:");
1282 fprintf(ofp
, "\n\t\t\t\tprint \"\\t[%%x] %%s\" %% (node['ip'], node['sym']['name'])");
1283 fprintf(ofp
, "\n\t\t\telse:");
1284 fprintf(ofp
, "\n\t\t\t\tprint \"\t[%%x]\" %% (node['ip'])\n\n");
1285 fprintf(ofp
, "\t\tprint \"\\n\"\n\n");
1289 fprintf(ofp
, "def trace_unhandled(event_name, context, "
1290 "event_fields_dict):\n");
1292 fprintf(ofp
, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
1293 "for k,v in sorted(event_fields_dict.items())])\n\n");
1295 fprintf(ofp
, "def print_header("
1296 "event_name, cpu, secs, nsecs, pid, comm):\n"
1297 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
1298 "(event_name, cpu, secs, nsecs, pid, comm),\n");
1302 fprintf(stderr
, "generated Python script: %s\n", fname
);
1307 struct scripting_ops python_scripting_ops
= {
1309 .start_script
= python_start_script
,
1310 .flush_script
= python_flush_script
,
1311 .stop_script
= python_stop_script
,
1312 .process_event
= python_process_event
,
1313 .process_stat
= python_process_stat
,
1314 .process_stat_interval
= python_process_stat_interval
,
1315 .generate_script
= python_generate_script
,