Loading...
1/*
2 * trace-event-python. Feed trace events to an embedded Python interpreter.
3 *
4 * Copyright (C) 2010 Tom Zanussi <tzanussi@gmail.com>
5 *
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.
10 *
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.
15 *
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
19 *
20 */
21
22#include <Python.h>
23
24#include <inttypes.h>
25#include <stdio.h>
26#include <stdlib.h>
27#include <string.h>
28#include <stdbool.h>
29#include <errno.h>
30#include <linux/bitmap.h>
31#include <linux/compiler.h>
32#include <linux/time64.h>
33
34#include "../../perf.h"
35#include "../debug.h"
36#include "../callchain.h"
37#include "../evsel.h"
38#include "../util.h"
39#include "../event.h"
40#include "../thread.h"
41#include "../comm.h"
42#include "../machine.h"
43#include "../db-export.h"
44#include "../thread-stack.h"
45#include "../trace-event.h"
46#include "../call-path.h"
47#include "thread_map.h"
48#include "cpumap.h"
49#include "print_binary.h"
50#include "stat.h"
51
52#if PY_MAJOR_VERSION < 3
53#define _PyUnicode_FromString(arg) \
54 PyString_FromString(arg)
55#define _PyUnicode_FromStringAndSize(arg1, arg2) \
56 PyString_FromStringAndSize((arg1), (arg2))
57#define _PyBytes_FromStringAndSize(arg1, arg2) \
58 PyString_FromStringAndSize((arg1), (arg2))
59#define _PyLong_FromLong(arg) \
60 PyInt_FromLong(arg)
61#define _PyLong_AsLong(arg) \
62 PyInt_AsLong(arg)
63#define _PyCapsule_New(arg1, arg2, arg3) \
64 PyCObject_FromVoidPtr((arg1), (arg2))
65
66PyMODINIT_FUNC initperf_trace_context(void);
67#else
68#define _PyUnicode_FromString(arg) \
69 PyUnicode_FromString(arg)
70#define _PyUnicode_FromStringAndSize(arg1, arg2) \
71 PyUnicode_FromStringAndSize((arg1), (arg2))
72#define _PyBytes_FromStringAndSize(arg1, arg2) \
73 PyBytes_FromStringAndSize((arg1), (arg2))
74#define _PyLong_FromLong(arg) \
75 PyLong_FromLong(arg)
76#define _PyLong_AsLong(arg) \
77 PyLong_AsLong(arg)
78#define _PyCapsule_New(arg1, arg2, arg3) \
79 PyCapsule_New((arg1), (arg2), (arg3))
80
81PyMODINIT_FUNC PyInit_perf_trace_context(void);
82#endif
83
84#define TRACE_EVENT_TYPE_MAX \
85 ((1 << (sizeof(unsigned short) * 8)) - 1)
86
87static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
88
89#define MAX_FIELDS 64
90#define N_COMMON_FIELDS 7
91
92extern struct scripting_context *scripting_context;
93
94static char *cur_field_name;
95static int zero_flag_atom;
96
97static PyObject *main_module, *main_dict;
98
99struct tables {
100 struct db_export dbe;
101 PyObject *evsel_handler;
102 PyObject *machine_handler;
103 PyObject *thread_handler;
104 PyObject *comm_handler;
105 PyObject *comm_thread_handler;
106 PyObject *dso_handler;
107 PyObject *symbol_handler;
108 PyObject *branch_type_handler;
109 PyObject *sample_handler;
110 PyObject *call_path_handler;
111 PyObject *call_return_handler;
112 bool db_export_mode;
113};
114
115static struct tables tables_global;
116
117static void handler_call_die(const char *handler_name) __noreturn;
118static void handler_call_die(const char *handler_name)
119{
120 PyErr_Print();
121 Py_FatalError("problem in Python trace event handler");
122 // Py_FatalError does not return
123 // but we have to make the compiler happy
124 abort();
125}
126
127/*
128 * Insert val into into the dictionary and decrement the reference counter.
129 * This is necessary for dictionaries since PyDict_SetItemString() does not
130 * steal a reference, as opposed to PyTuple_SetItem().
131 */
132static void pydict_set_item_string_decref(PyObject *dict, const char *key, PyObject *val)
133{
134 PyDict_SetItemString(dict, key, val);
135 Py_DECREF(val);
136}
137
138static PyObject *get_handler(const char *handler_name)
139{
140 PyObject *handler;
141
142 handler = PyDict_GetItemString(main_dict, handler_name);
143 if (handler && !PyCallable_Check(handler))
144 return NULL;
145 return handler;
146}
147
148static int get_argument_count(PyObject *handler)
149{
150 int arg_count = 0;
151
152 /*
153 * The attribute for the code object is func_code in Python 2,
154 * whereas it is __code__ in Python 3.0+.
155 */
156 PyObject *code_obj = PyObject_GetAttrString(handler,
157 "func_code");
158 if (PyErr_Occurred()) {
159 PyErr_Clear();
160 code_obj = PyObject_GetAttrString(handler,
161 "__code__");
162 }
163 PyErr_Clear();
164 if (code_obj) {
165 PyObject *arg_count_obj = PyObject_GetAttrString(code_obj,
166 "co_argcount");
167 if (arg_count_obj) {
168 arg_count = (int) _PyLong_AsLong(arg_count_obj);
169 Py_DECREF(arg_count_obj);
170 }
171 Py_DECREF(code_obj);
172 }
173 return arg_count;
174}
175
176static void call_object(PyObject *handler, PyObject *args, const char *die_msg)
177{
178 PyObject *retval;
179
180 retval = PyObject_CallObject(handler, args);
181 if (retval == NULL)
182 handler_call_die(die_msg);
183 Py_DECREF(retval);
184}
185
186static void try_call_object(const char *handler_name, PyObject *args)
187{
188 PyObject *handler;
189
190 handler = get_handler(handler_name);
191 if (handler)
192 call_object(handler, args, handler_name);
193}
194
195static void define_value(enum print_arg_type field_type,
196 const char *ev_name,
197 const char *field_name,
198 const char *field_value,
199 const char *field_str)
200{
201 const char *handler_name = "define_flag_value";
202 PyObject *t;
203 unsigned long long value;
204 unsigned n = 0;
205
206 if (field_type == PRINT_SYMBOL)
207 handler_name = "define_symbolic_value";
208
209 t = PyTuple_New(4);
210 if (!t)
211 Py_FatalError("couldn't create Python tuple");
212
213 value = eval_flag(field_value);
214
215 PyTuple_SetItem(t, n++, _PyUnicode_FromString(ev_name));
216 PyTuple_SetItem(t, n++, _PyUnicode_FromString(field_name));
217 PyTuple_SetItem(t, n++, _PyLong_FromLong(value));
218 PyTuple_SetItem(t, n++, _PyUnicode_FromString(field_str));
219
220 try_call_object(handler_name, t);
221
222 Py_DECREF(t);
223}
224
225static void define_values(enum print_arg_type field_type,
226 struct print_flag_sym *field,
227 const char *ev_name,
228 const char *field_name)
229{
230 define_value(field_type, ev_name, field_name, field->value,
231 field->str);
232
233 if (field->next)
234 define_values(field_type, field->next, ev_name, field_name);
235}
236
237static void define_field(enum print_arg_type field_type,
238 const char *ev_name,
239 const char *field_name,
240 const char *delim)
241{
242 const char *handler_name = "define_flag_field";
243 PyObject *t;
244 unsigned n = 0;
245
246 if (field_type == PRINT_SYMBOL)
247 handler_name = "define_symbolic_field";
248
249 if (field_type == PRINT_FLAGS)
250 t = PyTuple_New(3);
251 else
252 t = PyTuple_New(2);
253 if (!t)
254 Py_FatalError("couldn't create Python tuple");
255
256 PyTuple_SetItem(t, n++, _PyUnicode_FromString(ev_name));
257 PyTuple_SetItem(t, n++, _PyUnicode_FromString(field_name));
258 if (field_type == PRINT_FLAGS)
259 PyTuple_SetItem(t, n++, _PyUnicode_FromString(delim));
260
261 try_call_object(handler_name, t);
262
263 Py_DECREF(t);
264}
265
266static void define_event_symbols(struct event_format *event,
267 const char *ev_name,
268 struct print_arg *args)
269{
270 if (args == NULL)
271 return;
272
273 switch (args->type) {
274 case PRINT_NULL:
275 break;
276 case PRINT_ATOM:
277 define_value(PRINT_FLAGS, ev_name, cur_field_name, "0",
278 args->atom.atom);
279 zero_flag_atom = 0;
280 break;
281 case PRINT_FIELD:
282 free(cur_field_name);
283 cur_field_name = strdup(args->field.name);
284 break;
285 case PRINT_FLAGS:
286 define_event_symbols(event, ev_name, args->flags.field);
287 define_field(PRINT_FLAGS, ev_name, cur_field_name,
288 args->flags.delim);
289 define_values(PRINT_FLAGS, args->flags.flags, ev_name,
290 cur_field_name);
291 break;
292 case PRINT_SYMBOL:
293 define_event_symbols(event, ev_name, args->symbol.field);
294 define_field(PRINT_SYMBOL, ev_name, cur_field_name, NULL);
295 define_values(PRINT_SYMBOL, args->symbol.symbols, ev_name,
296 cur_field_name);
297 break;
298 case PRINT_HEX:
299 case PRINT_HEX_STR:
300 define_event_symbols(event, ev_name, args->hex.field);
301 define_event_symbols(event, ev_name, args->hex.size);
302 break;
303 case PRINT_INT_ARRAY:
304 define_event_symbols(event, ev_name, args->int_array.field);
305 define_event_symbols(event, ev_name, args->int_array.count);
306 define_event_symbols(event, ev_name, args->int_array.el_size);
307 break;
308 case PRINT_STRING:
309 break;
310 case PRINT_TYPE:
311 define_event_symbols(event, ev_name, args->typecast.item);
312 break;
313 case PRINT_OP:
314 if (strcmp(args->op.op, ":") == 0)
315 zero_flag_atom = 1;
316 define_event_symbols(event, ev_name, args->op.left);
317 define_event_symbols(event, ev_name, args->op.right);
318 break;
319 default:
320 /* gcc warns for these? */
321 case PRINT_BSTRING:
322 case PRINT_DYNAMIC_ARRAY:
323 case PRINT_DYNAMIC_ARRAY_LEN:
324 case PRINT_FUNC:
325 case PRINT_BITMASK:
326 /* we should warn... */
327 return;
328 }
329
330 if (args->next)
331 define_event_symbols(event, ev_name, args->next);
332}
333
334static PyObject *get_field_numeric_entry(struct event_format *event,
335 struct format_field *field, void *data)
336{
337 bool is_array = field->flags & FIELD_IS_ARRAY;
338 PyObject *obj = NULL, *list = NULL;
339 unsigned long long val;
340 unsigned int item_size, n_items, i;
341
342 if (is_array) {
343 list = PyList_New(field->arraylen);
344 item_size = field->size / field->arraylen;
345 n_items = field->arraylen;
346 } else {
347 item_size = field->size;
348 n_items = 1;
349 }
350
351 for (i = 0; i < n_items; i++) {
352
353 val = read_size(event, data + field->offset + i * item_size,
354 item_size);
355 if (field->flags & FIELD_IS_SIGNED) {
356 if ((long long)val >= LONG_MIN &&
357 (long long)val <= LONG_MAX)
358 obj = _PyLong_FromLong(val);
359 else
360 obj = PyLong_FromLongLong(val);
361 } else {
362 if (val <= LONG_MAX)
363 obj = _PyLong_FromLong(val);
364 else
365 obj = PyLong_FromUnsignedLongLong(val);
366 }
367 if (is_array)
368 PyList_SET_ITEM(list, i, obj);
369 }
370 if (is_array)
371 obj = list;
372 return obj;
373}
374
375
376static PyObject *python_process_callchain(struct perf_sample *sample,
377 struct perf_evsel *evsel,
378 struct addr_location *al)
379{
380 PyObject *pylist;
381
382 pylist = PyList_New(0);
383 if (!pylist)
384 Py_FatalError("couldn't create Python list");
385
386 if (!symbol_conf.use_callchain || !sample->callchain)
387 goto exit;
388
389 if (thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
390 sample, NULL, NULL,
391 scripting_max_stack) != 0) {
392 pr_err("Failed to resolve callchain. Skipping\n");
393 goto exit;
394 }
395 callchain_cursor_commit(&callchain_cursor);
396
397
398 while (1) {
399 PyObject *pyelem;
400 struct callchain_cursor_node *node;
401 node = callchain_cursor_current(&callchain_cursor);
402 if (!node)
403 break;
404
405 pyelem = PyDict_New();
406 if (!pyelem)
407 Py_FatalError("couldn't create Python dictionary");
408
409
410 pydict_set_item_string_decref(pyelem, "ip",
411 PyLong_FromUnsignedLongLong(node->ip));
412
413 if (node->sym) {
414 PyObject *pysym = PyDict_New();
415 if (!pysym)
416 Py_FatalError("couldn't create Python dictionary");
417 pydict_set_item_string_decref(pysym, "start",
418 PyLong_FromUnsignedLongLong(node->sym->start));
419 pydict_set_item_string_decref(pysym, "end",
420 PyLong_FromUnsignedLongLong(node->sym->end));
421 pydict_set_item_string_decref(pysym, "binding",
422 _PyLong_FromLong(node->sym->binding));
423 pydict_set_item_string_decref(pysym, "name",
424 _PyUnicode_FromStringAndSize(node->sym->name,
425 node->sym->namelen));
426 pydict_set_item_string_decref(pyelem, "sym", pysym);
427 }
428
429 if (node->map) {
430 struct map *map = node->map;
431 const char *dsoname = "[unknown]";
432 if (map && map->dso) {
433 if (symbol_conf.show_kernel_path && map->dso->long_name)
434 dsoname = map->dso->long_name;
435 else
436 dsoname = map->dso->name;
437 }
438 pydict_set_item_string_decref(pyelem, "dso",
439 _PyUnicode_FromString(dsoname));
440 }
441
442 callchain_cursor_advance(&callchain_cursor);
443 PyList_Append(pylist, pyelem);
444 Py_DECREF(pyelem);
445 }
446
447exit:
448 return pylist;
449}
450
451static PyObject *get_sample_value_as_tuple(struct sample_read_value *value)
452{
453 PyObject *t;
454
455 t = PyTuple_New(2);
456 if (!t)
457 Py_FatalError("couldn't create Python tuple");
458 PyTuple_SetItem(t, 0, PyLong_FromUnsignedLongLong(value->id));
459 PyTuple_SetItem(t, 1, PyLong_FromUnsignedLongLong(value->value));
460 return t;
461}
462
463static void set_sample_read_in_dict(PyObject *dict_sample,
464 struct perf_sample *sample,
465 struct perf_evsel *evsel)
466{
467 u64 read_format = evsel->attr.read_format;
468 PyObject *values;
469 unsigned int i;
470
471 if (read_format & PERF_FORMAT_TOTAL_TIME_ENABLED) {
472 pydict_set_item_string_decref(dict_sample, "time_enabled",
473 PyLong_FromUnsignedLongLong(sample->read.time_enabled));
474 }
475
476 if (read_format & PERF_FORMAT_TOTAL_TIME_RUNNING) {
477 pydict_set_item_string_decref(dict_sample, "time_running",
478 PyLong_FromUnsignedLongLong(sample->read.time_running));
479 }
480
481 if (read_format & PERF_FORMAT_GROUP)
482 values = PyList_New(sample->read.group.nr);
483 else
484 values = PyList_New(1);
485
486 if (!values)
487 Py_FatalError("couldn't create Python list");
488
489 if (read_format & PERF_FORMAT_GROUP) {
490 for (i = 0; i < sample->read.group.nr; i++) {
491 PyObject *t = get_sample_value_as_tuple(&sample->read.group.values[i]);
492 PyList_SET_ITEM(values, i, t);
493 }
494 } else {
495 PyObject *t = get_sample_value_as_tuple(&sample->read.one);
496 PyList_SET_ITEM(values, 0, t);
497 }
498 pydict_set_item_string_decref(dict_sample, "values", values);
499}
500
501static PyObject *get_perf_sample_dict(struct perf_sample *sample,
502 struct perf_evsel *evsel,
503 struct addr_location *al,
504 PyObject *callchain)
505{
506 PyObject *dict, *dict_sample;
507
508 dict = PyDict_New();
509 if (!dict)
510 Py_FatalError("couldn't create Python dictionary");
511
512 dict_sample = PyDict_New();
513 if (!dict_sample)
514 Py_FatalError("couldn't create Python dictionary");
515
516 pydict_set_item_string_decref(dict, "ev_name", _PyUnicode_FromString(perf_evsel__name(evsel)));
517 pydict_set_item_string_decref(dict, "attr", _PyUnicode_FromStringAndSize(
518 (const char *)&evsel->attr, sizeof(evsel->attr)));
519
520 pydict_set_item_string_decref(dict_sample, "pid",
521 _PyLong_FromLong(sample->pid));
522 pydict_set_item_string_decref(dict_sample, "tid",
523 _PyLong_FromLong(sample->tid));
524 pydict_set_item_string_decref(dict_sample, "cpu",
525 _PyLong_FromLong(sample->cpu));
526 pydict_set_item_string_decref(dict_sample, "ip",
527 PyLong_FromUnsignedLongLong(sample->ip));
528 pydict_set_item_string_decref(dict_sample, "time",
529 PyLong_FromUnsignedLongLong(sample->time));
530 pydict_set_item_string_decref(dict_sample, "period",
531 PyLong_FromUnsignedLongLong(sample->period));
532 pydict_set_item_string_decref(dict_sample, "phys_addr",
533 PyLong_FromUnsignedLongLong(sample->phys_addr));
534 pydict_set_item_string_decref(dict_sample, "addr",
535 PyLong_FromUnsignedLongLong(sample->addr));
536 set_sample_read_in_dict(dict_sample, sample, evsel);
537 pydict_set_item_string_decref(dict, "sample", dict_sample);
538
539 pydict_set_item_string_decref(dict, "raw_buf", _PyBytes_FromStringAndSize(
540 (const char *)sample->raw_data, sample->raw_size));
541 pydict_set_item_string_decref(dict, "comm",
542 _PyUnicode_FromString(thread__comm_str(al->thread)));
543 if (al->map) {
544 pydict_set_item_string_decref(dict, "dso",
545 _PyUnicode_FromString(al->map->dso->name));
546 }
547 if (al->sym) {
548 pydict_set_item_string_decref(dict, "symbol",
549 _PyUnicode_FromString(al->sym->name));
550 }
551
552 pydict_set_item_string_decref(dict, "callchain", callchain);
553
554 return dict;
555}
556
557static void python_process_tracepoint(struct perf_sample *sample,
558 struct perf_evsel *evsel,
559 struct addr_location *al)
560{
561 struct event_format *event = evsel->tp_format;
562 PyObject *handler, *context, *t, *obj = NULL, *callchain;
563 PyObject *dict = NULL, *all_entries_dict = NULL;
564 static char handler_name[256];
565 struct format_field *field;
566 unsigned long s, ns;
567 unsigned n = 0;
568 int pid;
569 int cpu = sample->cpu;
570 void *data = sample->raw_data;
571 unsigned long long nsecs = sample->time;
572 const char *comm = thread__comm_str(al->thread);
573 const char *default_handler_name = "trace_unhandled";
574
575 if (!event) {
576 snprintf(handler_name, sizeof(handler_name),
577 "ug! no event found for type %" PRIu64, (u64)evsel->attr.config);
578 Py_FatalError(handler_name);
579 }
580
581 pid = raw_field_value(event, "common_pid", data);
582
583 sprintf(handler_name, "%s__%s", event->system, event->name);
584
585 if (!test_and_set_bit(event->id, events_defined))
586 define_event_symbols(event, handler_name, event->print_fmt.args);
587
588 handler = get_handler(handler_name);
589 if (!handler) {
590 handler = get_handler(default_handler_name);
591 if (!handler)
592 return;
593 dict = PyDict_New();
594 if (!dict)
595 Py_FatalError("couldn't create Python dict");
596 }
597
598 t = PyTuple_New(MAX_FIELDS);
599 if (!t)
600 Py_FatalError("couldn't create Python tuple");
601
602
603 s = nsecs / NSEC_PER_SEC;
604 ns = nsecs - s * NSEC_PER_SEC;
605
606 scripting_context->event_data = data;
607 scripting_context->pevent = evsel->tp_format->pevent;
608
609 context = _PyCapsule_New(scripting_context, NULL, NULL);
610
611 PyTuple_SetItem(t, n++, _PyUnicode_FromString(handler_name));
612 PyTuple_SetItem(t, n++, context);
613
614 /* ip unwinding */
615 callchain = python_process_callchain(sample, evsel, al);
616 /* Need an additional reference for the perf_sample dict */
617 Py_INCREF(callchain);
618
619 if (!dict) {
620 PyTuple_SetItem(t, n++, _PyLong_FromLong(cpu));
621 PyTuple_SetItem(t, n++, _PyLong_FromLong(s));
622 PyTuple_SetItem(t, n++, _PyLong_FromLong(ns));
623 PyTuple_SetItem(t, n++, _PyLong_FromLong(pid));
624 PyTuple_SetItem(t, n++, _PyUnicode_FromString(comm));
625 PyTuple_SetItem(t, n++, callchain);
626 } else {
627 pydict_set_item_string_decref(dict, "common_cpu", _PyLong_FromLong(cpu));
628 pydict_set_item_string_decref(dict, "common_s", _PyLong_FromLong(s));
629 pydict_set_item_string_decref(dict, "common_ns", _PyLong_FromLong(ns));
630 pydict_set_item_string_decref(dict, "common_pid", _PyLong_FromLong(pid));
631 pydict_set_item_string_decref(dict, "common_comm", _PyUnicode_FromString(comm));
632 pydict_set_item_string_decref(dict, "common_callchain", callchain);
633 }
634 for (field = event->format.fields; field; field = field->next) {
635 unsigned int offset, len;
636 unsigned long long val;
637
638 if (field->flags & FIELD_IS_ARRAY) {
639 offset = field->offset;
640 len = field->size;
641 if (field->flags & FIELD_IS_DYNAMIC) {
642 val = pevent_read_number(scripting_context->pevent,
643 data + offset, len);
644 offset = val;
645 len = offset >> 16;
646 offset &= 0xffff;
647 }
648 if (field->flags & FIELD_IS_STRING &&
649 is_printable_array(data + offset, len)) {
650 obj = _PyUnicode_FromString((char *) data + offset);
651 } else {
652 obj = PyByteArray_FromStringAndSize((const char *) data + offset, len);
653 field->flags &= ~FIELD_IS_STRING;
654 }
655 } else { /* FIELD_IS_NUMERIC */
656 obj = get_field_numeric_entry(event, field, data);
657 }
658 if (!dict)
659 PyTuple_SetItem(t, n++, obj);
660 else
661 pydict_set_item_string_decref(dict, field->name, obj);
662
663 }
664
665 if (dict)
666 PyTuple_SetItem(t, n++, dict);
667
668 if (get_argument_count(handler) == (int) n + 1) {
669 all_entries_dict = get_perf_sample_dict(sample, evsel, al,
670 callchain);
671 PyTuple_SetItem(t, n++, all_entries_dict);
672 } else {
673 Py_DECREF(callchain);
674 }
675
676 if (_PyTuple_Resize(&t, n) == -1)
677 Py_FatalError("error resizing Python tuple");
678
679 if (!dict) {
680 call_object(handler, t, handler_name);
681 } else {
682 call_object(handler, t, default_handler_name);
683 Py_DECREF(dict);
684 }
685
686 Py_XDECREF(all_entries_dict);
687 Py_DECREF(t);
688}
689
690static PyObject *tuple_new(unsigned int sz)
691{
692 PyObject *t;
693
694 t = PyTuple_New(sz);
695 if (!t)
696 Py_FatalError("couldn't create Python tuple");
697 return t;
698}
699
700static int tuple_set_u64(PyObject *t, unsigned int pos, u64 val)
701{
702#if BITS_PER_LONG == 64
703 return PyTuple_SetItem(t, pos, _PyLong_FromLong(val));
704#endif
705#if BITS_PER_LONG == 32
706 return PyTuple_SetItem(t, pos, PyLong_FromLongLong(val));
707#endif
708}
709
710static int tuple_set_s32(PyObject *t, unsigned int pos, s32 val)
711{
712 return PyTuple_SetItem(t, pos, _PyLong_FromLong(val));
713}
714
715static int tuple_set_string(PyObject *t, unsigned int pos, const char *s)
716{
717 return PyTuple_SetItem(t, pos, _PyUnicode_FromString(s));
718}
719
720static int python_export_evsel(struct db_export *dbe, struct perf_evsel *evsel)
721{
722 struct tables *tables = container_of(dbe, struct tables, dbe);
723 PyObject *t;
724
725 t = tuple_new(2);
726
727 tuple_set_u64(t, 0, evsel->db_id);
728 tuple_set_string(t, 1, perf_evsel__name(evsel));
729
730 call_object(tables->evsel_handler, t, "evsel_table");
731
732 Py_DECREF(t);
733
734 return 0;
735}
736
737static int python_export_machine(struct db_export *dbe,
738 struct machine *machine)
739{
740 struct tables *tables = container_of(dbe, struct tables, dbe);
741 PyObject *t;
742
743 t = tuple_new(3);
744
745 tuple_set_u64(t, 0, machine->db_id);
746 tuple_set_s32(t, 1, machine->pid);
747 tuple_set_string(t, 2, machine->root_dir ? machine->root_dir : "");
748
749 call_object(tables->machine_handler, t, "machine_table");
750
751 Py_DECREF(t);
752
753 return 0;
754}
755
756static int python_export_thread(struct db_export *dbe, struct thread *thread,
757 u64 main_thread_db_id, struct machine *machine)
758{
759 struct tables *tables = container_of(dbe, struct tables, dbe);
760 PyObject *t;
761
762 t = tuple_new(5);
763
764 tuple_set_u64(t, 0, thread->db_id);
765 tuple_set_u64(t, 1, machine->db_id);
766 tuple_set_u64(t, 2, main_thread_db_id);
767 tuple_set_s32(t, 3, thread->pid_);
768 tuple_set_s32(t, 4, thread->tid);
769
770 call_object(tables->thread_handler, t, "thread_table");
771
772 Py_DECREF(t);
773
774 return 0;
775}
776
777static int python_export_comm(struct db_export *dbe, struct comm *comm)
778{
779 struct tables *tables = container_of(dbe, struct tables, dbe);
780 PyObject *t;
781
782 t = tuple_new(2);
783
784 tuple_set_u64(t, 0, comm->db_id);
785 tuple_set_string(t, 1, comm__str(comm));
786
787 call_object(tables->comm_handler, t, "comm_table");
788
789 Py_DECREF(t);
790
791 return 0;
792}
793
794static int python_export_comm_thread(struct db_export *dbe, u64 db_id,
795 struct comm *comm, struct thread *thread)
796{
797 struct tables *tables = container_of(dbe, struct tables, dbe);
798 PyObject *t;
799
800 t = tuple_new(3);
801
802 tuple_set_u64(t, 0, db_id);
803 tuple_set_u64(t, 1, comm->db_id);
804 tuple_set_u64(t, 2, thread->db_id);
805
806 call_object(tables->comm_thread_handler, t, "comm_thread_table");
807
808 Py_DECREF(t);
809
810 return 0;
811}
812
813static int python_export_dso(struct db_export *dbe, struct dso *dso,
814 struct machine *machine)
815{
816 struct tables *tables = container_of(dbe, struct tables, dbe);
817 char sbuild_id[SBUILD_ID_SIZE];
818 PyObject *t;
819
820 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
821
822 t = tuple_new(5);
823
824 tuple_set_u64(t, 0, dso->db_id);
825 tuple_set_u64(t, 1, machine->db_id);
826 tuple_set_string(t, 2, dso->short_name);
827 tuple_set_string(t, 3, dso->long_name);
828 tuple_set_string(t, 4, sbuild_id);
829
830 call_object(tables->dso_handler, t, "dso_table");
831
832 Py_DECREF(t);
833
834 return 0;
835}
836
837static int python_export_symbol(struct db_export *dbe, struct symbol *sym,
838 struct dso *dso)
839{
840 struct tables *tables = container_of(dbe, struct tables, dbe);
841 u64 *sym_db_id = symbol__priv(sym);
842 PyObject *t;
843
844 t = tuple_new(6);
845
846 tuple_set_u64(t, 0, *sym_db_id);
847 tuple_set_u64(t, 1, dso->db_id);
848 tuple_set_u64(t, 2, sym->start);
849 tuple_set_u64(t, 3, sym->end);
850 tuple_set_s32(t, 4, sym->binding);
851 tuple_set_string(t, 5, sym->name);
852
853 call_object(tables->symbol_handler, t, "symbol_table");
854
855 Py_DECREF(t);
856
857 return 0;
858}
859
860static int python_export_branch_type(struct db_export *dbe, u32 branch_type,
861 const char *name)
862{
863 struct tables *tables = container_of(dbe, struct tables, dbe);
864 PyObject *t;
865
866 t = tuple_new(2);
867
868 tuple_set_s32(t, 0, branch_type);
869 tuple_set_string(t, 1, name);
870
871 call_object(tables->branch_type_handler, t, "branch_type_table");
872
873 Py_DECREF(t);
874
875 return 0;
876}
877
878static int python_export_sample(struct db_export *dbe,
879 struct export_sample *es)
880{
881 struct tables *tables = container_of(dbe, struct tables, dbe);
882 PyObject *t;
883
884 t = tuple_new(22);
885
886 tuple_set_u64(t, 0, es->db_id);
887 tuple_set_u64(t, 1, es->evsel->db_id);
888 tuple_set_u64(t, 2, es->al->machine->db_id);
889 tuple_set_u64(t, 3, es->al->thread->db_id);
890 tuple_set_u64(t, 4, es->comm_db_id);
891 tuple_set_u64(t, 5, es->dso_db_id);
892 tuple_set_u64(t, 6, es->sym_db_id);
893 tuple_set_u64(t, 7, es->offset);
894 tuple_set_u64(t, 8, es->sample->ip);
895 tuple_set_u64(t, 9, es->sample->time);
896 tuple_set_s32(t, 10, es->sample->cpu);
897 tuple_set_u64(t, 11, es->addr_dso_db_id);
898 tuple_set_u64(t, 12, es->addr_sym_db_id);
899 tuple_set_u64(t, 13, es->addr_offset);
900 tuple_set_u64(t, 14, es->sample->addr);
901 tuple_set_u64(t, 15, es->sample->period);
902 tuple_set_u64(t, 16, es->sample->weight);
903 tuple_set_u64(t, 17, es->sample->transaction);
904 tuple_set_u64(t, 18, es->sample->data_src);
905 tuple_set_s32(t, 19, es->sample->flags & PERF_BRANCH_MASK);
906 tuple_set_s32(t, 20, !!(es->sample->flags & PERF_IP_FLAG_IN_TX));
907 tuple_set_u64(t, 21, es->call_path_id);
908
909 call_object(tables->sample_handler, t, "sample_table");
910
911 Py_DECREF(t);
912
913 return 0;
914}
915
916static int python_export_call_path(struct db_export *dbe, struct call_path *cp)
917{
918 struct tables *tables = container_of(dbe, struct tables, dbe);
919 PyObject *t;
920 u64 parent_db_id, sym_db_id;
921
922 parent_db_id = cp->parent ? cp->parent->db_id : 0;
923 sym_db_id = cp->sym ? *(u64 *)symbol__priv(cp->sym) : 0;
924
925 t = tuple_new(4);
926
927 tuple_set_u64(t, 0, cp->db_id);
928 tuple_set_u64(t, 1, parent_db_id);
929 tuple_set_u64(t, 2, sym_db_id);
930 tuple_set_u64(t, 3, cp->ip);
931
932 call_object(tables->call_path_handler, t, "call_path_table");
933
934 Py_DECREF(t);
935
936 return 0;
937}
938
939static int python_export_call_return(struct db_export *dbe,
940 struct call_return *cr)
941{
942 struct tables *tables = container_of(dbe, struct tables, dbe);
943 u64 comm_db_id = cr->comm ? cr->comm->db_id : 0;
944 PyObject *t;
945
946 t = tuple_new(11);
947
948 tuple_set_u64(t, 0, cr->db_id);
949 tuple_set_u64(t, 1, cr->thread->db_id);
950 tuple_set_u64(t, 2, comm_db_id);
951 tuple_set_u64(t, 3, cr->cp->db_id);
952 tuple_set_u64(t, 4, cr->call_time);
953 tuple_set_u64(t, 5, cr->return_time);
954 tuple_set_u64(t, 6, cr->branch_count);
955 tuple_set_u64(t, 7, cr->call_ref);
956 tuple_set_u64(t, 8, cr->return_ref);
957 tuple_set_u64(t, 9, cr->cp->parent->db_id);
958 tuple_set_s32(t, 10, cr->flags);
959
960 call_object(tables->call_return_handler, t, "call_return_table");
961
962 Py_DECREF(t);
963
964 return 0;
965}
966
967static int python_process_call_return(struct call_return *cr, void *data)
968{
969 struct db_export *dbe = data;
970
971 return db_export__call_return(dbe, cr);
972}
973
974static void python_process_general_event(struct perf_sample *sample,
975 struct perf_evsel *evsel,
976 struct addr_location *al)
977{
978 PyObject *handler, *t, *dict, *callchain;
979 static char handler_name[64];
980 unsigned n = 0;
981
982 snprintf(handler_name, sizeof(handler_name), "%s", "process_event");
983
984 handler = get_handler(handler_name);
985 if (!handler)
986 return;
987
988 /*
989 * Use the MAX_FIELDS to make the function expandable, though
990 * currently there is only one item for the tuple.
991 */
992 t = PyTuple_New(MAX_FIELDS);
993 if (!t)
994 Py_FatalError("couldn't create Python tuple");
995
996 /* ip unwinding */
997 callchain = python_process_callchain(sample, evsel, al);
998 dict = get_perf_sample_dict(sample, evsel, al, callchain);
999
1000 PyTuple_SetItem(t, n++, dict);
1001 if (_PyTuple_Resize(&t, n) == -1)
1002 Py_FatalError("error resizing Python tuple");
1003
1004 call_object(handler, t, handler_name);
1005
1006 Py_DECREF(dict);
1007 Py_DECREF(t);
1008}
1009
1010static void python_process_event(union perf_event *event,
1011 struct perf_sample *sample,
1012 struct perf_evsel *evsel,
1013 struct addr_location *al)
1014{
1015 struct tables *tables = &tables_global;
1016
1017 switch (evsel->attr.type) {
1018 case PERF_TYPE_TRACEPOINT:
1019 python_process_tracepoint(sample, evsel, al);
1020 break;
1021 /* Reserve for future process_hw/sw/raw APIs */
1022 default:
1023 if (tables->db_export_mode)
1024 db_export__sample(&tables->dbe, event, sample, evsel, al);
1025 else
1026 python_process_general_event(sample, evsel, al);
1027 }
1028}
1029
1030static void get_handler_name(char *str, size_t size,
1031 struct perf_evsel *evsel)
1032{
1033 char *p = str;
1034
1035 scnprintf(str, size, "stat__%s", perf_evsel__name(evsel));
1036
1037 while ((p = strchr(p, ':'))) {
1038 *p = '_';
1039 p++;
1040 }
1041}
1042
1043static void
1044process_stat(struct perf_evsel *counter, int cpu, int thread, u64 tstamp,
1045 struct perf_counts_values *count)
1046{
1047 PyObject *handler, *t;
1048 static char handler_name[256];
1049 int n = 0;
1050
1051 t = PyTuple_New(MAX_FIELDS);
1052 if (!t)
1053 Py_FatalError("couldn't create Python tuple");
1054
1055 get_handler_name(handler_name, sizeof(handler_name),
1056 counter);
1057
1058 handler = get_handler(handler_name);
1059 if (!handler) {
1060 pr_debug("can't find python handler %s\n", handler_name);
1061 return;
1062 }
1063
1064 PyTuple_SetItem(t, n++, _PyLong_FromLong(cpu));
1065 PyTuple_SetItem(t, n++, _PyLong_FromLong(thread));
1066
1067 tuple_set_u64(t, n++, tstamp);
1068 tuple_set_u64(t, n++, count->val);
1069 tuple_set_u64(t, n++, count->ena);
1070 tuple_set_u64(t, n++, count->run);
1071
1072 if (_PyTuple_Resize(&t, n) == -1)
1073 Py_FatalError("error resizing Python tuple");
1074
1075 call_object(handler, t, handler_name);
1076
1077 Py_DECREF(t);
1078}
1079
1080static void python_process_stat(struct perf_stat_config *config,
1081 struct perf_evsel *counter, u64 tstamp)
1082{
1083 struct thread_map *threads = counter->threads;
1084 struct cpu_map *cpus = counter->cpus;
1085 int cpu, thread;
1086
1087 if (config->aggr_mode == AGGR_GLOBAL) {
1088 process_stat(counter, -1, -1, tstamp,
1089 &counter->counts->aggr);
1090 return;
1091 }
1092
1093 for (thread = 0; thread < threads->nr; thread++) {
1094 for (cpu = 0; cpu < cpus->nr; cpu++) {
1095 process_stat(counter, cpus->map[cpu],
1096 thread_map__pid(threads, thread), tstamp,
1097 perf_counts(counter->counts, cpu, thread));
1098 }
1099 }
1100}
1101
1102static void python_process_stat_interval(u64 tstamp)
1103{
1104 PyObject *handler, *t;
1105 static const char handler_name[] = "stat__interval";
1106 int n = 0;
1107
1108 t = PyTuple_New(MAX_FIELDS);
1109 if (!t)
1110 Py_FatalError("couldn't create Python tuple");
1111
1112 handler = get_handler(handler_name);
1113 if (!handler) {
1114 pr_debug("can't find python handler %s\n", handler_name);
1115 return;
1116 }
1117
1118 tuple_set_u64(t, n++, tstamp);
1119
1120 if (_PyTuple_Resize(&t, n) == -1)
1121 Py_FatalError("error resizing Python tuple");
1122
1123 call_object(handler, t, handler_name);
1124
1125 Py_DECREF(t);
1126}
1127
1128static int run_start_sub(void)
1129{
1130 main_module = PyImport_AddModule("__main__");
1131 if (main_module == NULL)
1132 return -1;
1133 Py_INCREF(main_module);
1134
1135 main_dict = PyModule_GetDict(main_module);
1136 if (main_dict == NULL)
1137 goto error;
1138 Py_INCREF(main_dict);
1139
1140 try_call_object("trace_begin", NULL);
1141
1142 return 0;
1143
1144error:
1145 Py_XDECREF(main_dict);
1146 Py_XDECREF(main_module);
1147 return -1;
1148}
1149
1150#define SET_TABLE_HANDLER_(name, handler_name, table_name) do { \
1151 tables->handler_name = get_handler(#table_name); \
1152 if (tables->handler_name) \
1153 tables->dbe.export_ ## name = python_export_ ## name; \
1154} while (0)
1155
1156#define SET_TABLE_HANDLER(name) \
1157 SET_TABLE_HANDLER_(name, name ## _handler, name ## _table)
1158
1159static void set_table_handlers(struct tables *tables)
1160{
1161 const char *perf_db_export_mode = "perf_db_export_mode";
1162 const char *perf_db_export_calls = "perf_db_export_calls";
1163 const char *perf_db_export_callchains = "perf_db_export_callchains";
1164 PyObject *db_export_mode, *db_export_calls, *db_export_callchains;
1165 bool export_calls = false;
1166 bool export_callchains = false;
1167 int ret;
1168
1169 memset(tables, 0, sizeof(struct tables));
1170 if (db_export__init(&tables->dbe))
1171 Py_FatalError("failed to initialize export");
1172
1173 db_export_mode = PyDict_GetItemString(main_dict, perf_db_export_mode);
1174 if (!db_export_mode)
1175 return;
1176
1177 ret = PyObject_IsTrue(db_export_mode);
1178 if (ret == -1)
1179 handler_call_die(perf_db_export_mode);
1180 if (!ret)
1181 return;
1182
1183 /* handle export calls */
1184 tables->dbe.crp = NULL;
1185 db_export_calls = PyDict_GetItemString(main_dict, perf_db_export_calls);
1186 if (db_export_calls) {
1187 ret = PyObject_IsTrue(db_export_calls);
1188 if (ret == -1)
1189 handler_call_die(perf_db_export_calls);
1190 export_calls = !!ret;
1191 }
1192
1193 if (export_calls) {
1194 tables->dbe.crp =
1195 call_return_processor__new(python_process_call_return,
1196 &tables->dbe);
1197 if (!tables->dbe.crp)
1198 Py_FatalError("failed to create calls processor");
1199 }
1200
1201 /* handle export callchains */
1202 tables->dbe.cpr = NULL;
1203 db_export_callchains = PyDict_GetItemString(main_dict,
1204 perf_db_export_callchains);
1205 if (db_export_callchains) {
1206 ret = PyObject_IsTrue(db_export_callchains);
1207 if (ret == -1)
1208 handler_call_die(perf_db_export_callchains);
1209 export_callchains = !!ret;
1210 }
1211
1212 if (export_callchains) {
1213 /*
1214 * Attempt to use the call path root from the call return
1215 * processor, if the call return processor is in use. Otherwise,
1216 * we allocate a new call path root. This prevents exporting
1217 * duplicate call path ids when both are in use simultaniously.
1218 */
1219 if (tables->dbe.crp)
1220 tables->dbe.cpr = tables->dbe.crp->cpr;
1221 else
1222 tables->dbe.cpr = call_path_root__new();
1223
1224 if (!tables->dbe.cpr)
1225 Py_FatalError("failed to create call path root");
1226 }
1227
1228 tables->db_export_mode = true;
1229 /*
1230 * Reserve per symbol space for symbol->db_id via symbol__priv()
1231 */
1232 symbol_conf.priv_size = sizeof(u64);
1233
1234 SET_TABLE_HANDLER(evsel);
1235 SET_TABLE_HANDLER(machine);
1236 SET_TABLE_HANDLER(thread);
1237 SET_TABLE_HANDLER(comm);
1238 SET_TABLE_HANDLER(comm_thread);
1239 SET_TABLE_HANDLER(dso);
1240 SET_TABLE_HANDLER(symbol);
1241 SET_TABLE_HANDLER(branch_type);
1242 SET_TABLE_HANDLER(sample);
1243 SET_TABLE_HANDLER(call_path);
1244 SET_TABLE_HANDLER(call_return);
1245}
1246
1247#if PY_MAJOR_VERSION < 3
1248static void _free_command_line(const char **command_line, int num)
1249{
1250 free(command_line);
1251}
1252#else
1253static void _free_command_line(wchar_t **command_line, int num)
1254{
1255 int i;
1256 for (i = 0; i < num; i++)
1257 PyMem_RawFree(command_line[i]);
1258 free(command_line);
1259}
1260#endif
1261
1262
1263/*
1264 * Start trace script
1265 */
1266static int python_start_script(const char *script, int argc, const char **argv)
1267{
1268 struct tables *tables = &tables_global;
1269#if PY_MAJOR_VERSION < 3
1270 const char **command_line;
1271#else
1272 wchar_t **command_line;
1273#endif
1274 char buf[PATH_MAX];
1275 int i, err = 0;
1276 FILE *fp;
1277
1278#if PY_MAJOR_VERSION < 3
1279 command_line = malloc((argc + 1) * sizeof(const char *));
1280 command_line[0] = script;
1281 for (i = 1; i < argc + 1; i++)
1282 command_line[i] = argv[i - 1];
1283#else
1284 command_line = malloc((argc + 1) * sizeof(wchar_t *));
1285 command_line[0] = Py_DecodeLocale(script, NULL);
1286 for (i = 1; i < argc + 1; i++)
1287 command_line[i] = Py_DecodeLocale(argv[i - 1], NULL);
1288#endif
1289
1290 Py_Initialize();
1291
1292#if PY_MAJOR_VERSION < 3
1293 initperf_trace_context();
1294 PySys_SetArgv(argc + 1, (char **)command_line);
1295#else
1296 PyInit_perf_trace_context();
1297 PySys_SetArgv(argc + 1, command_line);
1298#endif
1299
1300 fp = fopen(script, "r");
1301 if (!fp) {
1302 sprintf(buf, "Can't open python script \"%s\"", script);
1303 perror(buf);
1304 err = -1;
1305 goto error;
1306 }
1307
1308 err = PyRun_SimpleFile(fp, script);
1309 if (err) {
1310 fprintf(stderr, "Error running python script %s\n", script);
1311 goto error;
1312 }
1313
1314 err = run_start_sub();
1315 if (err) {
1316 fprintf(stderr, "Error starting python script %s\n", script);
1317 goto error;
1318 }
1319
1320 set_table_handlers(tables);
1321
1322 if (tables->db_export_mode) {
1323 err = db_export__branch_types(&tables->dbe);
1324 if (err)
1325 goto error;
1326 }
1327
1328 _free_command_line(command_line, argc + 1);
1329
1330 return err;
1331error:
1332 Py_Finalize();
1333 _free_command_line(command_line, argc + 1);
1334
1335 return err;
1336}
1337
1338static int python_flush_script(void)
1339{
1340 struct tables *tables = &tables_global;
1341
1342 return db_export__flush(&tables->dbe);
1343}
1344
1345/*
1346 * Stop trace script
1347 */
1348static int python_stop_script(void)
1349{
1350 struct tables *tables = &tables_global;
1351
1352 try_call_object("trace_end", NULL);
1353
1354 db_export__exit(&tables->dbe);
1355
1356 Py_XDECREF(main_dict);
1357 Py_XDECREF(main_module);
1358 Py_Finalize();
1359
1360 return 0;
1361}
1362
1363static int python_generate_script(struct pevent *pevent, const char *outfile)
1364{
1365 struct event_format *event = NULL;
1366 struct format_field *f;
1367 char fname[PATH_MAX];
1368 int not_first, count;
1369 FILE *ofp;
1370
1371 sprintf(fname, "%s.py", outfile);
1372 ofp = fopen(fname, "w");
1373 if (ofp == NULL) {
1374 fprintf(stderr, "couldn't open %s\n", fname);
1375 return -1;
1376 }
1377 fprintf(ofp, "# perf script event handlers, "
1378 "generated by perf script -g python\n");
1379
1380 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
1381 " License version 2\n\n");
1382
1383 fprintf(ofp, "# The common_* event handler fields are the most useful "
1384 "fields common to\n");
1385
1386 fprintf(ofp, "# all events. They don't necessarily correspond to "
1387 "the 'common_*' fields\n");
1388
1389 fprintf(ofp, "# in the format files. Those fields not available as "
1390 "handler params can\n");
1391
1392 fprintf(ofp, "# be retrieved using Python functions of the form "
1393 "common_*(context).\n");
1394
1395 fprintf(ofp, "# See the perf-script-python Documentation for the list "
1396 "of available functions.\n\n");
1397
1398 fprintf(ofp, "import os\n");
1399 fprintf(ofp, "import sys\n\n");
1400
1401 fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
1402 fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
1403 fprintf(ofp, "\nfrom perf_trace_context import *\n");
1404 fprintf(ofp, "from Core import *\n\n\n");
1405
1406 fprintf(ofp, "def trace_begin():\n");
1407 fprintf(ofp, "\tprint \"in trace_begin\"\n\n");
1408
1409 fprintf(ofp, "def trace_end():\n");
1410 fprintf(ofp, "\tprint \"in trace_end\"\n\n");
1411
1412 while ((event = trace_find_next_event(pevent, event))) {
1413 fprintf(ofp, "def %s__%s(", event->system, event->name);
1414 fprintf(ofp, "event_name, ");
1415 fprintf(ofp, "context, ");
1416 fprintf(ofp, "common_cpu,\n");
1417 fprintf(ofp, "\tcommon_secs, ");
1418 fprintf(ofp, "common_nsecs, ");
1419 fprintf(ofp, "common_pid, ");
1420 fprintf(ofp, "common_comm,\n\t");
1421 fprintf(ofp, "common_callchain, ");
1422
1423 not_first = 0;
1424 count = 0;
1425
1426 for (f = event->format.fields; f; f = f->next) {
1427 if (not_first++)
1428 fprintf(ofp, ", ");
1429 if (++count % 5 == 0)
1430 fprintf(ofp, "\n\t");
1431
1432 fprintf(ofp, "%s", f->name);
1433 }
1434 if (not_first++)
1435 fprintf(ofp, ", ");
1436 if (++count % 5 == 0)
1437 fprintf(ofp, "\n\t\t");
1438 fprintf(ofp, "perf_sample_dict");
1439
1440 fprintf(ofp, "):\n");
1441
1442 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
1443 "common_secs, common_nsecs,\n\t\t\t"
1444 "common_pid, common_comm)\n\n");
1445
1446 fprintf(ofp, "\t\tprint \"");
1447
1448 not_first = 0;
1449 count = 0;
1450
1451 for (f = event->format.fields; f; f = f->next) {
1452 if (not_first++)
1453 fprintf(ofp, ", ");
1454 if (count && count % 3 == 0) {
1455 fprintf(ofp, "\" \\\n\t\t\"");
1456 }
1457 count++;
1458
1459 fprintf(ofp, "%s=", f->name);
1460 if (f->flags & FIELD_IS_STRING ||
1461 f->flags & FIELD_IS_FLAG ||
1462 f->flags & FIELD_IS_ARRAY ||
1463 f->flags & FIELD_IS_SYMBOLIC)
1464 fprintf(ofp, "%%s");
1465 else if (f->flags & FIELD_IS_SIGNED)
1466 fprintf(ofp, "%%d");
1467 else
1468 fprintf(ofp, "%%u");
1469 }
1470
1471 fprintf(ofp, "\" %% \\\n\t\t(");
1472
1473 not_first = 0;
1474 count = 0;
1475
1476 for (f = event->format.fields; f; f = f->next) {
1477 if (not_first++)
1478 fprintf(ofp, ", ");
1479
1480 if (++count % 5 == 0)
1481 fprintf(ofp, "\n\t\t");
1482
1483 if (f->flags & FIELD_IS_FLAG) {
1484 if ((count - 1) % 5 != 0) {
1485 fprintf(ofp, "\n\t\t");
1486 count = 4;
1487 }
1488 fprintf(ofp, "flag_str(\"");
1489 fprintf(ofp, "%s__%s\", ", event->system,
1490 event->name);
1491 fprintf(ofp, "\"%s\", %s)", f->name,
1492 f->name);
1493 } else if (f->flags & FIELD_IS_SYMBOLIC) {
1494 if ((count - 1) % 5 != 0) {
1495 fprintf(ofp, "\n\t\t");
1496 count = 4;
1497 }
1498 fprintf(ofp, "symbol_str(\"");
1499 fprintf(ofp, "%s__%s\", ", event->system,
1500 event->name);
1501 fprintf(ofp, "\"%s\", %s)", f->name,
1502 f->name);
1503 } else
1504 fprintf(ofp, "%s", f->name);
1505 }
1506
1507 fprintf(ofp, ")\n\n");
1508
1509 fprintf(ofp, "\t\tprint 'Sample: {'+"
1510 "get_dict_as_string(perf_sample_dict['sample'], ', ')+'}'\n\n");
1511
1512 fprintf(ofp, "\t\tfor node in common_callchain:");
1513 fprintf(ofp, "\n\t\t\tif 'sym' in node:");
1514 fprintf(ofp, "\n\t\t\t\tprint \"\\t[%%x] %%s\" %% (node['ip'], node['sym']['name'])");
1515 fprintf(ofp, "\n\t\t\telse:");
1516 fprintf(ofp, "\n\t\t\t\tprint \"\t[%%x]\" %% (node['ip'])\n\n");
1517 fprintf(ofp, "\t\tprint \"\\n\"\n\n");
1518
1519 }
1520
1521 fprintf(ofp, "def trace_unhandled(event_name, context, "
1522 "event_fields_dict, perf_sample_dict):\n");
1523
1524 fprintf(ofp, "\t\tprint get_dict_as_string(event_fields_dict)\n");
1525 fprintf(ofp, "\t\tprint 'Sample: {'+"
1526 "get_dict_as_string(perf_sample_dict['sample'], ', ')+'}'\n\n");
1527
1528 fprintf(ofp, "def print_header("
1529 "event_name, cpu, secs, nsecs, pid, comm):\n"
1530 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
1531 "(event_name, cpu, secs, nsecs, pid, comm),\n\n");
1532
1533 fprintf(ofp, "def get_dict_as_string(a_dict, delimiter=' '):\n"
1534 "\treturn delimiter.join"
1535 "(['%%s=%%s'%%(k,str(v))for k,v in sorted(a_dict.items())])\n");
1536
1537 fclose(ofp);
1538
1539 fprintf(stderr, "generated Python script: %s\n", fname);
1540
1541 return 0;
1542}
1543
1544struct scripting_ops python_scripting_ops = {
1545 .name = "Python",
1546 .start_script = python_start_script,
1547 .flush_script = python_flush_script,
1548 .stop_script = python_stop_script,
1549 .process_event = python_process_event,
1550 .process_stat = python_process_stat,
1551 .process_stat_interval = python_process_stat_interval,
1552 .generate_script = python_generate_script,
1553};
1/*
2 * trace-event-python. Feed trace events to an embedded Python interpreter.
3 *
4 * Copyright (C) 2010 Tom Zanussi <tzanussi@gmail.com>
5 *
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.
10 *
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.
15 *
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
19 *
20 */
21
22#include <Python.h>
23
24#include <inttypes.h>
25#include <stdio.h>
26#include <stdlib.h>
27#include <string.h>
28#include <stdbool.h>
29#include <errno.h>
30#include <linux/bitmap.h>
31#include <linux/compiler.h>
32#include <linux/time64.h>
33
34#include "../build-id.h"
35#include "../counts.h"
36#include "../debug.h"
37#include "../dso.h"
38#include "../callchain.h"
39#include "../evsel.h"
40#include "../event.h"
41#include "../thread.h"
42#include "../comm.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"
48#include "map.h"
49#include "symbol.h"
50#include "thread_map.h"
51#include "print_binary.h"
52#include "stat.h"
53#include "mem-events.h"
54
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) \
63 PyInt_FromLong(arg)
64#define _PyLong_AsLong(arg) \
65 PyInt_AsLong(arg)
66#define _PyCapsule_New(arg1, arg2, arg3) \
67 PyCObject_FromVoidPtr((arg1), (arg2))
68
69PyMODINIT_FUNC initperf_trace_context(void);
70#else
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) \
78 PyLong_FromLong(arg)
79#define _PyLong_AsLong(arg) \
80 PyLong_AsLong(arg)
81#define _PyCapsule_New(arg1, arg2, arg3) \
82 PyCapsule_New((arg1), (arg2), (arg3))
83
84PyMODINIT_FUNC PyInit_perf_trace_context(void);
85#endif
86
87#define TRACE_EVENT_TYPE_MAX \
88 ((1 << (sizeof(unsigned short) * 8)) - 1)
89
90static DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX);
91
92#define MAX_FIELDS 64
93#define N_COMMON_FIELDS 7
94
95extern struct scripting_context *scripting_context;
96
97static char *cur_field_name;
98static int zero_flag_atom;
99
100static PyObject *main_module, *main_dict;
101
102struct tables {
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;
117 bool db_export_mode;
118};
119
120static struct tables tables_global;
121
122static void handler_call_die(const char *handler_name) __noreturn;
123static void handler_call_die(const char *handler_name)
124{
125 PyErr_Print();
126 Py_FatalError("problem in Python trace event handler");
127 // Py_FatalError does not return
128 // but we have to make the compiler happy
129 abort();
130}
131
132/*
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().
136 */
137static void pydict_set_item_string_decref(PyObject *dict, const char *key, PyObject *val)
138{
139 PyDict_SetItemString(dict, key, val);
140 Py_DECREF(val);
141}
142
143static PyObject *get_handler(const char *handler_name)
144{
145 PyObject *handler;
146
147 handler = PyDict_GetItemString(main_dict, handler_name);
148 if (handler && !PyCallable_Check(handler))
149 return NULL;
150 return handler;
151}
152
153static int get_argument_count(PyObject *handler)
154{
155 int arg_count = 0;
156
157 /*
158 * The attribute for the code object is func_code in Python 2,
159 * whereas it is __code__ in Python 3.0+.
160 */
161 PyObject *code_obj = PyObject_GetAttrString(handler,
162 "func_code");
163 if (PyErr_Occurred()) {
164 PyErr_Clear();
165 code_obj = PyObject_GetAttrString(handler,
166 "__code__");
167 }
168 PyErr_Clear();
169 if (code_obj) {
170 PyObject *arg_count_obj = PyObject_GetAttrString(code_obj,
171 "co_argcount");
172 if (arg_count_obj) {
173 arg_count = (int) _PyLong_AsLong(arg_count_obj);
174 Py_DECREF(arg_count_obj);
175 }
176 Py_DECREF(code_obj);
177 }
178 return arg_count;
179}
180
181static void call_object(PyObject *handler, PyObject *args, const char *die_msg)
182{
183 PyObject *retval;
184
185 retval = PyObject_CallObject(handler, args);
186 if (retval == NULL)
187 handler_call_die(die_msg);
188 Py_DECREF(retval);
189}
190
191static void try_call_object(const char *handler_name, PyObject *args)
192{
193 PyObject *handler;
194
195 handler = get_handler(handler_name);
196 if (handler)
197 call_object(handler, args, handler_name);
198}
199
200static void define_value(enum tep_print_arg_type field_type,
201 const char *ev_name,
202 const char *field_name,
203 const char *field_value,
204 const char *field_str)
205{
206 const char *handler_name = "define_flag_value";
207 PyObject *t;
208 unsigned long long value;
209 unsigned n = 0;
210
211 if (field_type == TEP_PRINT_SYMBOL)
212 handler_name = "define_symbolic_value";
213
214 t = PyTuple_New(4);
215 if (!t)
216 Py_FatalError("couldn't create Python tuple");
217
218 value = eval_flag(field_value);
219
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));
224
225 try_call_object(handler_name, t);
226
227 Py_DECREF(t);
228}
229
230static void define_values(enum tep_print_arg_type field_type,
231 struct tep_print_flag_sym *field,
232 const char *ev_name,
233 const char *field_name)
234{
235 define_value(field_type, ev_name, field_name, field->value,
236 field->str);
237
238 if (field->next)
239 define_values(field_type, field->next, ev_name, field_name);
240}
241
242static void define_field(enum tep_print_arg_type field_type,
243 const char *ev_name,
244 const char *field_name,
245 const char *delim)
246{
247 const char *handler_name = "define_flag_field";
248 PyObject *t;
249 unsigned n = 0;
250
251 if (field_type == TEP_PRINT_SYMBOL)
252 handler_name = "define_symbolic_field";
253
254 if (field_type == TEP_PRINT_FLAGS)
255 t = PyTuple_New(3);
256 else
257 t = PyTuple_New(2);
258 if (!t)
259 Py_FatalError("couldn't create Python tuple");
260
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));
265
266 try_call_object(handler_name, t);
267
268 Py_DECREF(t);
269}
270
271static void define_event_symbols(struct tep_event *event,
272 const char *ev_name,
273 struct tep_print_arg *args)
274{
275 if (args == NULL)
276 return;
277
278 switch (args->type) {
279 case TEP_PRINT_NULL:
280 break;
281 case TEP_PRINT_ATOM:
282 define_value(TEP_PRINT_FLAGS, ev_name, cur_field_name, "0",
283 args->atom.atom);
284 zero_flag_atom = 0;
285 break;
286 case TEP_PRINT_FIELD:
287 free(cur_field_name);
288 cur_field_name = strdup(args->field.name);
289 break;
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,
293 args->flags.delim);
294 define_values(TEP_PRINT_FLAGS, args->flags.flags, ev_name,
295 cur_field_name);
296 break;
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,
301 cur_field_name);
302 break;
303 case TEP_PRINT_HEX:
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);
307 break;
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);
312 break;
313 case TEP_PRINT_STRING:
314 break;
315 case TEP_PRINT_TYPE:
316 define_event_symbols(event, ev_name, args->typecast.item);
317 break;
318 case TEP_PRINT_OP:
319 if (strcmp(args->op.op, ":") == 0)
320 zero_flag_atom = 1;
321 define_event_symbols(event, ev_name, args->op.left);
322 define_event_symbols(event, ev_name, args->op.right);
323 break;
324 default:
325 /* gcc warns for these? */
326 case TEP_PRINT_BSTRING:
327 case TEP_PRINT_DYNAMIC_ARRAY:
328 case TEP_PRINT_DYNAMIC_ARRAY_LEN:
329 case TEP_PRINT_FUNC:
330 case TEP_PRINT_BITMASK:
331 /* we should warn... */
332 return;
333 }
334
335 if (args->next)
336 define_event_symbols(event, ev_name, args->next);
337}
338
339static PyObject *get_field_numeric_entry(struct tep_event *event,
340 struct tep_format_field *field, void *data)
341{
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;
346
347 if (is_array) {
348 list = PyList_New(field->arraylen);
349 item_size = field->size / field->arraylen;
350 n_items = field->arraylen;
351 } else {
352 item_size = field->size;
353 n_items = 1;
354 }
355
356 for (i = 0; i < n_items; i++) {
357
358 val = read_size(event, data + field->offset + i * item_size,
359 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);
364 else
365 obj = PyLong_FromLongLong(val);
366 } else {
367 if (val <= LONG_MAX)
368 obj = _PyLong_FromLong(val);
369 else
370 obj = PyLong_FromUnsignedLongLong(val);
371 }
372 if (is_array)
373 PyList_SET_ITEM(list, i, obj);
374 }
375 if (is_array)
376 obj = list;
377 return obj;
378}
379
380static const char *get_dsoname(struct map *map)
381{
382 const char *dsoname = "[unknown]";
383
384 if (map && map->dso) {
385 if (symbol_conf.show_kernel_path && map->dso->long_name)
386 dsoname = map->dso->long_name;
387 else
388 dsoname = map->dso->name;
389 }
390
391 return dsoname;
392}
393
394static PyObject *python_process_callchain(struct perf_sample *sample,
395 struct evsel *evsel,
396 struct addr_location *al)
397{
398 PyObject *pylist;
399
400 pylist = PyList_New(0);
401 if (!pylist)
402 Py_FatalError("couldn't create Python list");
403
404 if (!symbol_conf.use_callchain || !sample->callchain)
405 goto exit;
406
407 if (thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
408 sample, NULL, NULL,
409 scripting_max_stack) != 0) {
410 pr_err("Failed to resolve callchain. Skipping\n");
411 goto exit;
412 }
413 callchain_cursor_commit(&callchain_cursor);
414
415
416 while (1) {
417 PyObject *pyelem;
418 struct callchain_cursor_node *node;
419 node = callchain_cursor_current(&callchain_cursor);
420 if (!node)
421 break;
422
423 pyelem = PyDict_New();
424 if (!pyelem)
425 Py_FatalError("couldn't create Python dictionary");
426
427
428 pydict_set_item_string_decref(pyelem, "ip",
429 PyLong_FromUnsignedLongLong(node->ip));
430
431 if (node->ms.sym) {
432 PyObject *pysym = PyDict_New();
433 if (!pysym)
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);
445 }
446
447 if (node->ms.map) {
448 const char *dsoname = get_dsoname(node->ms.map);
449
450 pydict_set_item_string_decref(pyelem, "dso",
451 _PyUnicode_FromString(dsoname));
452 }
453
454 callchain_cursor_advance(&callchain_cursor);
455 PyList_Append(pylist, pyelem);
456 Py_DECREF(pyelem);
457 }
458
459exit:
460 return pylist;
461}
462
463static PyObject *python_process_brstack(struct perf_sample *sample,
464 struct thread *thread)
465{
466 struct branch_stack *br = sample->branch_stack;
467 struct branch_entry *entries = perf_sample__branch_entries(sample);
468 PyObject *pylist;
469 u64 i;
470
471 pylist = PyList_New(0);
472 if (!pylist)
473 Py_FatalError("couldn't create Python list");
474
475 if (!(br && br->nr))
476 goto exit;
477
478 for (i = 0; i < br->nr; i++) {
479 PyObject *pyelem;
480 struct addr_location al;
481 const char *dsoname;
482
483 pyelem = PyDict_New();
484 if (!pyelem)
485 Py_FatalError("couldn't create Python dictionary");
486
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));
501
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));
507
508 thread__find_map_fb(thread, sample->cpumode,
509 entries[i].to, &al);
510 dsoname = get_dsoname(al.map);
511 pydict_set_item_string_decref(pyelem, "to_dsoname",
512 _PyUnicode_FromString(dsoname));
513
514 PyList_Append(pylist, pyelem);
515 Py_DECREF(pyelem);
516 }
517
518exit:
519 return pylist;
520}
521
522static unsigned long get_offset(struct symbol *sym, struct addr_location *al)
523{
524 unsigned long offset;
525
526 if (al->addr < sym->end)
527 offset = al->addr - sym->start;
528 else
529 offset = al->addr - al->map->start - sym->start;
530
531 return offset;
532}
533
534static int get_symoff(struct symbol *sym, struct addr_location *al,
535 bool print_off, char *bf, int size)
536{
537 unsigned long offset;
538
539 if (!sym || !sym->name[0])
540 return scnprintf(bf, size, "%s", "[unknown]");
541
542 if (!print_off)
543 return scnprintf(bf, size, "%s", sym->name);
544
545 offset = get_offset(sym, al);
546
547 return scnprintf(bf, size, "%s+0x%x", sym->name, offset);
548}
549
550static int get_br_mspred(struct branch_flags *flags, char *bf, int size)
551{
552 if (!flags->mispred && !flags->predicted)
553 return scnprintf(bf, size, "%s", "-");
554
555 if (flags->mispred)
556 return scnprintf(bf, size, "%s", "M");
557
558 return scnprintf(bf, size, "%s", "P");
559}
560
561static PyObject *python_process_brstacksym(struct perf_sample *sample,
562 struct thread *thread)
563{
564 struct branch_stack *br = sample->branch_stack;
565 struct branch_entry *entries = perf_sample__branch_entries(sample);
566 PyObject *pylist;
567 u64 i;
568 char bf[512];
569 struct addr_location al;
570
571 pylist = PyList_New(0);
572 if (!pylist)
573 Py_FatalError("couldn't create Python list");
574
575 if (!(br && br->nr))
576 goto exit;
577
578 for (i = 0; i < br->nr; i++) {
579 PyObject *pyelem;
580
581 pyelem = PyDict_New();
582 if (!pyelem)
583 Py_FatalError("couldn't create Python dictionary");
584
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));
590
591 thread__find_symbol_fb(thread, sample->cpumode,
592 entries[i].to, &al);
593 get_symoff(al.sym, &al, true, bf, sizeof(bf));
594 pydict_set_item_string_decref(pyelem, "to",
595 _PyUnicode_FromString(bf));
596
597 get_br_mspred(&entries[i].flags, bf, sizeof(bf));
598 pydict_set_item_string_decref(pyelem, "pred",
599 _PyUnicode_FromString(bf));
600
601 if (entries[i].flags.in_tx) {
602 pydict_set_item_string_decref(pyelem, "in_tx",
603 _PyUnicode_FromString("X"));
604 } else {
605 pydict_set_item_string_decref(pyelem, "in_tx",
606 _PyUnicode_FromString("-"));
607 }
608
609 if (entries[i].flags.abort) {
610 pydict_set_item_string_decref(pyelem, "abort",
611 _PyUnicode_FromString("A"));
612 } else {
613 pydict_set_item_string_decref(pyelem, "abort",
614 _PyUnicode_FromString("-"));
615 }
616
617 PyList_Append(pylist, pyelem);
618 Py_DECREF(pyelem);
619 }
620
621exit:
622 return pylist;
623}
624
625static PyObject *get_sample_value_as_tuple(struct sample_read_value *value)
626{
627 PyObject *t;
628
629 t = PyTuple_New(2);
630 if (!t)
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));
634 return t;
635}
636
637static void set_sample_read_in_dict(PyObject *dict_sample,
638 struct perf_sample *sample,
639 struct evsel *evsel)
640{
641 u64 read_format = evsel->core.attr.read_format;
642 PyObject *values;
643 unsigned int i;
644
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));
648 }
649
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));
653 }
654
655 if (read_format & PERF_FORMAT_GROUP)
656 values = PyList_New(sample->read.group.nr);
657 else
658 values = PyList_New(1);
659
660 if (!values)
661 Py_FatalError("couldn't create Python list");
662
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);
667 }
668 } else {
669 PyObject *t = get_sample_value_as_tuple(&sample->read.one);
670 PyList_SET_ITEM(values, 0, t);
671 }
672 pydict_set_item_string_decref(dict_sample, "values", values);
673}
674
675static void set_sample_datasrc_in_dict(PyObject *dict,
676 struct perf_sample *sample)
677{
678 struct mem_info mi = { .data_src.val = sample->data_src };
679 char decode[100];
680
681 pydict_set_item_string_decref(dict, "datasrc",
682 PyLong_FromUnsignedLongLong(sample->data_src));
683
684 perf_script__meminfo_scnprintf(decode, 100, &mi);
685
686 pydict_set_item_string_decref(dict, "datasrc_decode",
687 _PyUnicode_FromString(decode));
688}
689
690static int regs_map(struct regs_dump *regs, uint64_t mask, char *bf, int size)
691{
692 unsigned int i = 0, r;
693 int printed = 0;
694
695 bf[0] = 0;
696
697 if (!regs || !regs->regs)
698 return 0;
699
700 for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
701 u64 val = regs->regs[i++];
702
703 printed += scnprintf(bf + printed, size - printed,
704 "%5s:0x%" PRIx64 " ",
705 perf_reg_name(r), val);
706 }
707
708 return printed;
709}
710
711static void set_regs_in_dict(PyObject *dict,
712 struct perf_sample *sample,
713 struct evsel *evsel)
714{
715 struct perf_event_attr *attr = &evsel->core.attr;
716 char bf[512];
717
718 regs_map(&sample->intr_regs, attr->sample_regs_intr, bf, sizeof(bf));
719
720 pydict_set_item_string_decref(dict, "iregs",
721 _PyUnicode_FromString(bf));
722
723 regs_map(&sample->user_regs, attr->sample_regs_user, bf, sizeof(bf));
724
725 pydict_set_item_string_decref(dict, "uregs",
726 _PyUnicode_FromString(bf));
727}
728
729static PyObject *get_perf_sample_dict(struct perf_sample *sample,
730 struct evsel *evsel,
731 struct addr_location *al,
732 PyObject *callchain)
733{
734 PyObject *dict, *dict_sample, *brstack, *brstacksym;
735
736 dict = PyDict_New();
737 if (!dict)
738 Py_FatalError("couldn't create Python dictionary");
739
740 dict_sample = PyDict_New();
741 if (!dict_sample)
742 Py_FatalError("couldn't create Python dictionary");
743
744 pydict_set_item_string_decref(dict, "ev_name", _PyUnicode_FromString(evsel__name(evsel)));
745 pydict_set_item_string_decref(dict, "attr", _PyBytes_FromStringAndSize((const char *)&evsel->core.attr, sizeof(evsel->core.attr)));
746
747 pydict_set_item_string_decref(dict_sample, "pid",
748 _PyLong_FromLong(sample->pid));
749 pydict_set_item_string_decref(dict_sample, "tid",
750 _PyLong_FromLong(sample->tid));
751 pydict_set_item_string_decref(dict_sample, "cpu",
752 _PyLong_FromLong(sample->cpu));
753 pydict_set_item_string_decref(dict_sample, "ip",
754 PyLong_FromUnsignedLongLong(sample->ip));
755 pydict_set_item_string_decref(dict_sample, "time",
756 PyLong_FromUnsignedLongLong(sample->time));
757 pydict_set_item_string_decref(dict_sample, "period",
758 PyLong_FromUnsignedLongLong(sample->period));
759 pydict_set_item_string_decref(dict_sample, "phys_addr",
760 PyLong_FromUnsignedLongLong(sample->phys_addr));
761 pydict_set_item_string_decref(dict_sample, "addr",
762 PyLong_FromUnsignedLongLong(sample->addr));
763 set_sample_read_in_dict(dict_sample, sample, evsel);
764 pydict_set_item_string_decref(dict_sample, "weight",
765 PyLong_FromUnsignedLongLong(sample->weight));
766 pydict_set_item_string_decref(dict_sample, "transaction",
767 PyLong_FromUnsignedLongLong(sample->transaction));
768 set_sample_datasrc_in_dict(dict_sample, sample);
769 pydict_set_item_string_decref(dict, "sample", dict_sample);
770
771 pydict_set_item_string_decref(dict, "raw_buf", _PyBytes_FromStringAndSize(
772 (const char *)sample->raw_data, sample->raw_size));
773 pydict_set_item_string_decref(dict, "comm",
774 _PyUnicode_FromString(thread__comm_str(al->thread)));
775 if (al->map) {
776 pydict_set_item_string_decref(dict, "dso",
777 _PyUnicode_FromString(al->map->dso->name));
778 }
779 if (al->sym) {
780 pydict_set_item_string_decref(dict, "symbol",
781 _PyUnicode_FromString(al->sym->name));
782 }
783
784 pydict_set_item_string_decref(dict, "callchain", callchain);
785
786 brstack = python_process_brstack(sample, al->thread);
787 pydict_set_item_string_decref(dict, "brstack", brstack);
788
789 brstacksym = python_process_brstacksym(sample, al->thread);
790 pydict_set_item_string_decref(dict, "brstacksym", brstacksym);
791
792 set_regs_in_dict(dict, sample, evsel);
793
794 return dict;
795}
796
797static void python_process_tracepoint(struct perf_sample *sample,
798 struct evsel *evsel,
799 struct addr_location *al)
800{
801 struct tep_event *event = evsel->tp_format;
802 PyObject *handler, *context, *t, *obj = NULL, *callchain;
803 PyObject *dict = NULL, *all_entries_dict = NULL;
804 static char handler_name[256];
805 struct tep_format_field *field;
806 unsigned long s, ns;
807 unsigned n = 0;
808 int pid;
809 int cpu = sample->cpu;
810 void *data = sample->raw_data;
811 unsigned long long nsecs = sample->time;
812 const char *comm = thread__comm_str(al->thread);
813 const char *default_handler_name = "trace_unhandled";
814
815 if (!event) {
816 snprintf(handler_name, sizeof(handler_name),
817 "ug! no event found for type %" PRIu64, (u64)evsel->core.attr.config);
818 Py_FatalError(handler_name);
819 }
820
821 pid = raw_field_value(event, "common_pid", data);
822
823 sprintf(handler_name, "%s__%s", event->system, event->name);
824
825 if (!test_and_set_bit(event->id, events_defined))
826 define_event_symbols(event, handler_name, event->print_fmt.args);
827
828 handler = get_handler(handler_name);
829 if (!handler) {
830 handler = get_handler(default_handler_name);
831 if (!handler)
832 return;
833 dict = PyDict_New();
834 if (!dict)
835 Py_FatalError("couldn't create Python dict");
836 }
837
838 t = PyTuple_New(MAX_FIELDS);
839 if (!t)
840 Py_FatalError("couldn't create Python tuple");
841
842
843 s = nsecs / NSEC_PER_SEC;
844 ns = nsecs - s * NSEC_PER_SEC;
845
846 scripting_context->event_data = data;
847 scripting_context->pevent = evsel->tp_format->tep;
848
849 context = _PyCapsule_New(scripting_context, NULL, NULL);
850
851 PyTuple_SetItem(t, n++, _PyUnicode_FromString(handler_name));
852 PyTuple_SetItem(t, n++, context);
853
854 /* ip unwinding */
855 callchain = python_process_callchain(sample, evsel, al);
856 /* Need an additional reference for the perf_sample dict */
857 Py_INCREF(callchain);
858
859 if (!dict) {
860 PyTuple_SetItem(t, n++, _PyLong_FromLong(cpu));
861 PyTuple_SetItem(t, n++, _PyLong_FromLong(s));
862 PyTuple_SetItem(t, n++, _PyLong_FromLong(ns));
863 PyTuple_SetItem(t, n++, _PyLong_FromLong(pid));
864 PyTuple_SetItem(t, n++, _PyUnicode_FromString(comm));
865 PyTuple_SetItem(t, n++, callchain);
866 } else {
867 pydict_set_item_string_decref(dict, "common_cpu", _PyLong_FromLong(cpu));
868 pydict_set_item_string_decref(dict, "common_s", _PyLong_FromLong(s));
869 pydict_set_item_string_decref(dict, "common_ns", _PyLong_FromLong(ns));
870 pydict_set_item_string_decref(dict, "common_pid", _PyLong_FromLong(pid));
871 pydict_set_item_string_decref(dict, "common_comm", _PyUnicode_FromString(comm));
872 pydict_set_item_string_decref(dict, "common_callchain", callchain);
873 }
874 for (field = event->format.fields; field; field = field->next) {
875 unsigned int offset, len;
876 unsigned long long val;
877
878 if (field->flags & TEP_FIELD_IS_ARRAY) {
879 offset = field->offset;
880 len = field->size;
881 if (field->flags & TEP_FIELD_IS_DYNAMIC) {
882 val = tep_read_number(scripting_context->pevent,
883 data + offset, len);
884 offset = val;
885 len = offset >> 16;
886 offset &= 0xffff;
887 }
888 if (field->flags & TEP_FIELD_IS_STRING &&
889 is_printable_array(data + offset, len)) {
890 obj = _PyUnicode_FromString((char *) data + offset);
891 } else {
892 obj = PyByteArray_FromStringAndSize((const char *) data + offset, len);
893 field->flags &= ~TEP_FIELD_IS_STRING;
894 }
895 } else { /* FIELD_IS_NUMERIC */
896 obj = get_field_numeric_entry(event, field, data);
897 }
898 if (!dict)
899 PyTuple_SetItem(t, n++, obj);
900 else
901 pydict_set_item_string_decref(dict, field->name, obj);
902
903 }
904
905 if (dict)
906 PyTuple_SetItem(t, n++, dict);
907
908 if (get_argument_count(handler) == (int) n + 1) {
909 all_entries_dict = get_perf_sample_dict(sample, evsel, al,
910 callchain);
911 PyTuple_SetItem(t, n++, all_entries_dict);
912 } else {
913 Py_DECREF(callchain);
914 }
915
916 if (_PyTuple_Resize(&t, n) == -1)
917 Py_FatalError("error resizing Python tuple");
918
919 if (!dict)
920 call_object(handler, t, handler_name);
921 else
922 call_object(handler, t, default_handler_name);
923
924 Py_DECREF(t);
925}
926
927static PyObject *tuple_new(unsigned int sz)
928{
929 PyObject *t;
930
931 t = PyTuple_New(sz);
932 if (!t)
933 Py_FatalError("couldn't create Python tuple");
934 return t;
935}
936
937static int tuple_set_u64(PyObject *t, unsigned int pos, u64 val)
938{
939#if BITS_PER_LONG == 64
940 return PyTuple_SetItem(t, pos, _PyLong_FromLong(val));
941#endif
942#if BITS_PER_LONG == 32
943 return PyTuple_SetItem(t, pos, PyLong_FromLongLong(val));
944#endif
945}
946
947static int tuple_set_s32(PyObject *t, unsigned int pos, s32 val)
948{
949 return PyTuple_SetItem(t, pos, _PyLong_FromLong(val));
950}
951
952static int tuple_set_string(PyObject *t, unsigned int pos, const char *s)
953{
954 return PyTuple_SetItem(t, pos, _PyUnicode_FromString(s));
955}
956
957static int tuple_set_bytes(PyObject *t, unsigned int pos, void *bytes,
958 unsigned int sz)
959{
960 return PyTuple_SetItem(t, pos, _PyBytes_FromStringAndSize(bytes, sz));
961}
962
963static int python_export_evsel(struct db_export *dbe, struct evsel *evsel)
964{
965 struct tables *tables = container_of(dbe, struct tables, dbe);
966 PyObject *t;
967
968 t = tuple_new(2);
969
970 tuple_set_u64(t, 0, evsel->db_id);
971 tuple_set_string(t, 1, evsel__name(evsel));
972
973 call_object(tables->evsel_handler, t, "evsel_table");
974
975 Py_DECREF(t);
976
977 return 0;
978}
979
980static int python_export_machine(struct db_export *dbe,
981 struct machine *machine)
982{
983 struct tables *tables = container_of(dbe, struct tables, dbe);
984 PyObject *t;
985
986 t = tuple_new(3);
987
988 tuple_set_u64(t, 0, machine->db_id);
989 tuple_set_s32(t, 1, machine->pid);
990 tuple_set_string(t, 2, machine->root_dir ? machine->root_dir : "");
991
992 call_object(tables->machine_handler, t, "machine_table");
993
994 Py_DECREF(t);
995
996 return 0;
997}
998
999static int python_export_thread(struct db_export *dbe, struct thread *thread,
1000 u64 main_thread_db_id, struct machine *machine)
1001{
1002 struct tables *tables = container_of(dbe, struct tables, dbe);
1003 PyObject *t;
1004
1005 t = tuple_new(5);
1006
1007 tuple_set_u64(t, 0, thread->db_id);
1008 tuple_set_u64(t, 1, machine->db_id);
1009 tuple_set_u64(t, 2, main_thread_db_id);
1010 tuple_set_s32(t, 3, thread->pid_);
1011 tuple_set_s32(t, 4, thread->tid);
1012
1013 call_object(tables->thread_handler, t, "thread_table");
1014
1015 Py_DECREF(t);
1016
1017 return 0;
1018}
1019
1020static int python_export_comm(struct db_export *dbe, struct comm *comm,
1021 struct thread *thread)
1022{
1023 struct tables *tables = container_of(dbe, struct tables, dbe);
1024 PyObject *t;
1025
1026 t = tuple_new(5);
1027
1028 tuple_set_u64(t, 0, comm->db_id);
1029 tuple_set_string(t, 1, comm__str(comm));
1030 tuple_set_u64(t, 2, thread->db_id);
1031 tuple_set_u64(t, 3, comm->start);
1032 tuple_set_s32(t, 4, comm->exec);
1033
1034 call_object(tables->comm_handler, t, "comm_table");
1035
1036 Py_DECREF(t);
1037
1038 return 0;
1039}
1040
1041static int python_export_comm_thread(struct db_export *dbe, u64 db_id,
1042 struct comm *comm, struct thread *thread)
1043{
1044 struct tables *tables = container_of(dbe, struct tables, dbe);
1045 PyObject *t;
1046
1047 t = tuple_new(3);
1048
1049 tuple_set_u64(t, 0, db_id);
1050 tuple_set_u64(t, 1, comm->db_id);
1051 tuple_set_u64(t, 2, thread->db_id);
1052
1053 call_object(tables->comm_thread_handler, t, "comm_thread_table");
1054
1055 Py_DECREF(t);
1056
1057 return 0;
1058}
1059
1060static int python_export_dso(struct db_export *dbe, struct dso *dso,
1061 struct machine *machine)
1062{
1063 struct tables *tables = container_of(dbe, struct tables, dbe);
1064 char sbuild_id[SBUILD_ID_SIZE];
1065 PyObject *t;
1066
1067 build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
1068
1069 t = tuple_new(5);
1070
1071 tuple_set_u64(t, 0, dso->db_id);
1072 tuple_set_u64(t, 1, machine->db_id);
1073 tuple_set_string(t, 2, dso->short_name);
1074 tuple_set_string(t, 3, dso->long_name);
1075 tuple_set_string(t, 4, sbuild_id);
1076
1077 call_object(tables->dso_handler, t, "dso_table");
1078
1079 Py_DECREF(t);
1080
1081 return 0;
1082}
1083
1084static int python_export_symbol(struct db_export *dbe, struct symbol *sym,
1085 struct dso *dso)
1086{
1087 struct tables *tables = container_of(dbe, struct tables, dbe);
1088 u64 *sym_db_id = symbol__priv(sym);
1089 PyObject *t;
1090
1091 t = tuple_new(6);
1092
1093 tuple_set_u64(t, 0, *sym_db_id);
1094 tuple_set_u64(t, 1, dso->db_id);
1095 tuple_set_u64(t, 2, sym->start);
1096 tuple_set_u64(t, 3, sym->end);
1097 tuple_set_s32(t, 4, sym->binding);
1098 tuple_set_string(t, 5, sym->name);
1099
1100 call_object(tables->symbol_handler, t, "symbol_table");
1101
1102 Py_DECREF(t);
1103
1104 return 0;
1105}
1106
1107static int python_export_branch_type(struct db_export *dbe, u32 branch_type,
1108 const char *name)
1109{
1110 struct tables *tables = container_of(dbe, struct tables, dbe);
1111 PyObject *t;
1112
1113 t = tuple_new(2);
1114
1115 tuple_set_s32(t, 0, branch_type);
1116 tuple_set_string(t, 1, name);
1117
1118 call_object(tables->branch_type_handler, t, "branch_type_table");
1119
1120 Py_DECREF(t);
1121
1122 return 0;
1123}
1124
1125static void python_export_sample_table(struct db_export *dbe,
1126 struct export_sample *es)
1127{
1128 struct tables *tables = container_of(dbe, struct tables, dbe);
1129 PyObject *t;
1130
1131 t = tuple_new(24);
1132
1133 tuple_set_u64(t, 0, es->db_id);
1134 tuple_set_u64(t, 1, es->evsel->db_id);
1135 tuple_set_u64(t, 2, es->al->maps->machine->db_id);
1136 tuple_set_u64(t, 3, es->al->thread->db_id);
1137 tuple_set_u64(t, 4, es->comm_db_id);
1138 tuple_set_u64(t, 5, es->dso_db_id);
1139 tuple_set_u64(t, 6, es->sym_db_id);
1140 tuple_set_u64(t, 7, es->offset);
1141 tuple_set_u64(t, 8, es->sample->ip);
1142 tuple_set_u64(t, 9, es->sample->time);
1143 tuple_set_s32(t, 10, es->sample->cpu);
1144 tuple_set_u64(t, 11, es->addr_dso_db_id);
1145 tuple_set_u64(t, 12, es->addr_sym_db_id);
1146 tuple_set_u64(t, 13, es->addr_offset);
1147 tuple_set_u64(t, 14, es->sample->addr);
1148 tuple_set_u64(t, 15, es->sample->period);
1149 tuple_set_u64(t, 16, es->sample->weight);
1150 tuple_set_u64(t, 17, es->sample->transaction);
1151 tuple_set_u64(t, 18, es->sample->data_src);
1152 tuple_set_s32(t, 19, es->sample->flags & PERF_BRANCH_MASK);
1153 tuple_set_s32(t, 20, !!(es->sample->flags & PERF_IP_FLAG_IN_TX));
1154 tuple_set_u64(t, 21, es->call_path_id);
1155 tuple_set_u64(t, 22, es->sample->insn_cnt);
1156 tuple_set_u64(t, 23, es->sample->cyc_cnt);
1157
1158 call_object(tables->sample_handler, t, "sample_table");
1159
1160 Py_DECREF(t);
1161}
1162
1163static void python_export_synth(struct db_export *dbe, struct export_sample *es)
1164{
1165 struct tables *tables = container_of(dbe, struct tables, dbe);
1166 PyObject *t;
1167
1168 t = tuple_new(3);
1169
1170 tuple_set_u64(t, 0, es->db_id);
1171 tuple_set_u64(t, 1, es->evsel->core.attr.config);
1172 tuple_set_bytes(t, 2, es->sample->raw_data, es->sample->raw_size);
1173
1174 call_object(tables->synth_handler, t, "synth_data");
1175
1176 Py_DECREF(t);
1177}
1178
1179static int python_export_sample(struct db_export *dbe,
1180 struct export_sample *es)
1181{
1182 struct tables *tables = container_of(dbe, struct tables, dbe);
1183
1184 python_export_sample_table(dbe, es);
1185
1186 if (es->evsel->core.attr.type == PERF_TYPE_SYNTH && tables->synth_handler)
1187 python_export_synth(dbe, es);
1188
1189 return 0;
1190}
1191
1192static int python_export_call_path(struct db_export *dbe, struct call_path *cp)
1193{
1194 struct tables *tables = container_of(dbe, struct tables, dbe);
1195 PyObject *t;
1196 u64 parent_db_id, sym_db_id;
1197
1198 parent_db_id = cp->parent ? cp->parent->db_id : 0;
1199 sym_db_id = cp->sym ? *(u64 *)symbol__priv(cp->sym) : 0;
1200
1201 t = tuple_new(4);
1202
1203 tuple_set_u64(t, 0, cp->db_id);
1204 tuple_set_u64(t, 1, parent_db_id);
1205 tuple_set_u64(t, 2, sym_db_id);
1206 tuple_set_u64(t, 3, cp->ip);
1207
1208 call_object(tables->call_path_handler, t, "call_path_table");
1209
1210 Py_DECREF(t);
1211
1212 return 0;
1213}
1214
1215static int python_export_call_return(struct db_export *dbe,
1216 struct call_return *cr)
1217{
1218 struct tables *tables = container_of(dbe, struct tables, dbe);
1219 u64 comm_db_id = cr->comm ? cr->comm->db_id : 0;
1220 PyObject *t;
1221
1222 t = tuple_new(14);
1223
1224 tuple_set_u64(t, 0, cr->db_id);
1225 tuple_set_u64(t, 1, cr->thread->db_id);
1226 tuple_set_u64(t, 2, comm_db_id);
1227 tuple_set_u64(t, 3, cr->cp->db_id);
1228 tuple_set_u64(t, 4, cr->call_time);
1229 tuple_set_u64(t, 5, cr->return_time);
1230 tuple_set_u64(t, 6, cr->branch_count);
1231 tuple_set_u64(t, 7, cr->call_ref);
1232 tuple_set_u64(t, 8, cr->return_ref);
1233 tuple_set_u64(t, 9, cr->cp->parent->db_id);
1234 tuple_set_s32(t, 10, cr->flags);
1235 tuple_set_u64(t, 11, cr->parent_db_id);
1236 tuple_set_u64(t, 12, cr->insn_count);
1237 tuple_set_u64(t, 13, cr->cyc_count);
1238
1239 call_object(tables->call_return_handler, t, "call_return_table");
1240
1241 Py_DECREF(t);
1242
1243 return 0;
1244}
1245
1246static int python_export_context_switch(struct db_export *dbe, u64 db_id,
1247 struct machine *machine,
1248 struct perf_sample *sample,
1249 u64 th_out_id, u64 comm_out_id,
1250 u64 th_in_id, u64 comm_in_id, int flags)
1251{
1252 struct tables *tables = container_of(dbe, struct tables, dbe);
1253 PyObject *t;
1254
1255 t = tuple_new(9);
1256
1257 tuple_set_u64(t, 0, db_id);
1258 tuple_set_u64(t, 1, machine->db_id);
1259 tuple_set_u64(t, 2, sample->time);
1260 tuple_set_s32(t, 3, sample->cpu);
1261 tuple_set_u64(t, 4, th_out_id);
1262 tuple_set_u64(t, 5, comm_out_id);
1263 tuple_set_u64(t, 6, th_in_id);
1264 tuple_set_u64(t, 7, comm_in_id);
1265 tuple_set_s32(t, 8, flags);
1266
1267 call_object(tables->context_switch_handler, t, "context_switch");
1268
1269 Py_DECREF(t);
1270
1271 return 0;
1272}
1273
1274static int python_process_call_return(struct call_return *cr, u64 *parent_db_id,
1275 void *data)
1276{
1277 struct db_export *dbe = data;
1278
1279 return db_export__call_return(dbe, cr, parent_db_id);
1280}
1281
1282static void python_process_general_event(struct perf_sample *sample,
1283 struct evsel *evsel,
1284 struct addr_location *al)
1285{
1286 PyObject *handler, *t, *dict, *callchain;
1287 static char handler_name[64];
1288 unsigned n = 0;
1289
1290 snprintf(handler_name, sizeof(handler_name), "%s", "process_event");
1291
1292 handler = get_handler(handler_name);
1293 if (!handler)
1294 return;
1295
1296 /*
1297 * Use the MAX_FIELDS to make the function expandable, though
1298 * currently there is only one item for the tuple.
1299 */
1300 t = PyTuple_New(MAX_FIELDS);
1301 if (!t)
1302 Py_FatalError("couldn't create Python tuple");
1303
1304 /* ip unwinding */
1305 callchain = python_process_callchain(sample, evsel, al);
1306 dict = get_perf_sample_dict(sample, evsel, al, callchain);
1307
1308 PyTuple_SetItem(t, n++, dict);
1309 if (_PyTuple_Resize(&t, n) == -1)
1310 Py_FatalError("error resizing Python tuple");
1311
1312 call_object(handler, t, handler_name);
1313
1314 Py_DECREF(t);
1315}
1316
1317static void python_process_event(union perf_event *event,
1318 struct perf_sample *sample,
1319 struct evsel *evsel,
1320 struct addr_location *al)
1321{
1322 struct tables *tables = &tables_global;
1323
1324 switch (evsel->core.attr.type) {
1325 case PERF_TYPE_TRACEPOINT:
1326 python_process_tracepoint(sample, evsel, al);
1327 break;
1328 /* Reserve for future process_hw/sw/raw APIs */
1329 default:
1330 if (tables->db_export_mode)
1331 db_export__sample(&tables->dbe, event, sample, evsel, al);
1332 else
1333 python_process_general_event(sample, evsel, al);
1334 }
1335}
1336
1337static void python_process_switch(union perf_event *event,
1338 struct perf_sample *sample,
1339 struct machine *machine)
1340{
1341 struct tables *tables = &tables_global;
1342
1343 if (tables->db_export_mode)
1344 db_export__switch(&tables->dbe, event, sample, machine);
1345}
1346
1347static void get_handler_name(char *str, size_t size,
1348 struct evsel *evsel)
1349{
1350 char *p = str;
1351
1352 scnprintf(str, size, "stat__%s", evsel__name(evsel));
1353
1354 while ((p = strchr(p, ':'))) {
1355 *p = '_';
1356 p++;
1357 }
1358}
1359
1360static void
1361process_stat(struct evsel *counter, int cpu, int thread, u64 tstamp,
1362 struct perf_counts_values *count)
1363{
1364 PyObject *handler, *t;
1365 static char handler_name[256];
1366 int n = 0;
1367
1368 t = PyTuple_New(MAX_FIELDS);
1369 if (!t)
1370 Py_FatalError("couldn't create Python tuple");
1371
1372 get_handler_name(handler_name, sizeof(handler_name),
1373 counter);
1374
1375 handler = get_handler(handler_name);
1376 if (!handler) {
1377 pr_debug("can't find python handler %s\n", handler_name);
1378 return;
1379 }
1380
1381 PyTuple_SetItem(t, n++, _PyLong_FromLong(cpu));
1382 PyTuple_SetItem(t, n++, _PyLong_FromLong(thread));
1383
1384 tuple_set_u64(t, n++, tstamp);
1385 tuple_set_u64(t, n++, count->val);
1386 tuple_set_u64(t, n++, count->ena);
1387 tuple_set_u64(t, n++, count->run);
1388
1389 if (_PyTuple_Resize(&t, n) == -1)
1390 Py_FatalError("error resizing Python tuple");
1391
1392 call_object(handler, t, handler_name);
1393
1394 Py_DECREF(t);
1395}
1396
1397static void python_process_stat(struct perf_stat_config *config,
1398 struct evsel *counter, u64 tstamp)
1399{
1400 struct perf_thread_map *threads = counter->core.threads;
1401 struct perf_cpu_map *cpus = counter->core.cpus;
1402 int cpu, thread;
1403
1404 if (config->aggr_mode == AGGR_GLOBAL) {
1405 process_stat(counter, -1, -1, tstamp,
1406 &counter->counts->aggr);
1407 return;
1408 }
1409
1410 for (thread = 0; thread < threads->nr; thread++) {
1411 for (cpu = 0; cpu < cpus->nr; cpu++) {
1412 process_stat(counter, cpus->map[cpu],
1413 perf_thread_map__pid(threads, thread), tstamp,
1414 perf_counts(counter->counts, cpu, thread));
1415 }
1416 }
1417}
1418
1419static void python_process_stat_interval(u64 tstamp)
1420{
1421 PyObject *handler, *t;
1422 static const char handler_name[] = "stat__interval";
1423 int n = 0;
1424
1425 t = PyTuple_New(MAX_FIELDS);
1426 if (!t)
1427 Py_FatalError("couldn't create Python tuple");
1428
1429 handler = get_handler(handler_name);
1430 if (!handler) {
1431 pr_debug("can't find python handler %s\n", handler_name);
1432 return;
1433 }
1434
1435 tuple_set_u64(t, n++, tstamp);
1436
1437 if (_PyTuple_Resize(&t, n) == -1)
1438 Py_FatalError("error resizing Python tuple");
1439
1440 call_object(handler, t, handler_name);
1441
1442 Py_DECREF(t);
1443}
1444
1445static int run_start_sub(void)
1446{
1447 main_module = PyImport_AddModule("__main__");
1448 if (main_module == NULL)
1449 return -1;
1450 Py_INCREF(main_module);
1451
1452 main_dict = PyModule_GetDict(main_module);
1453 if (main_dict == NULL)
1454 goto error;
1455 Py_INCREF(main_dict);
1456
1457 try_call_object("trace_begin", NULL);
1458
1459 return 0;
1460
1461error:
1462 Py_XDECREF(main_dict);
1463 Py_XDECREF(main_module);
1464 return -1;
1465}
1466
1467#define SET_TABLE_HANDLER_(name, handler_name, table_name) do { \
1468 tables->handler_name = get_handler(#table_name); \
1469 if (tables->handler_name) \
1470 tables->dbe.export_ ## name = python_export_ ## name; \
1471} while (0)
1472
1473#define SET_TABLE_HANDLER(name) \
1474 SET_TABLE_HANDLER_(name, name ## _handler, name ## _table)
1475
1476static void set_table_handlers(struct tables *tables)
1477{
1478 const char *perf_db_export_mode = "perf_db_export_mode";
1479 const char *perf_db_export_calls = "perf_db_export_calls";
1480 const char *perf_db_export_callchains = "perf_db_export_callchains";
1481 PyObject *db_export_mode, *db_export_calls, *db_export_callchains;
1482 bool export_calls = false;
1483 bool export_callchains = false;
1484 int ret;
1485
1486 memset(tables, 0, sizeof(struct tables));
1487 if (db_export__init(&tables->dbe))
1488 Py_FatalError("failed to initialize export");
1489
1490 db_export_mode = PyDict_GetItemString(main_dict, perf_db_export_mode);
1491 if (!db_export_mode)
1492 return;
1493
1494 ret = PyObject_IsTrue(db_export_mode);
1495 if (ret == -1)
1496 handler_call_die(perf_db_export_mode);
1497 if (!ret)
1498 return;
1499
1500 /* handle export calls */
1501 tables->dbe.crp = NULL;
1502 db_export_calls = PyDict_GetItemString(main_dict, perf_db_export_calls);
1503 if (db_export_calls) {
1504 ret = PyObject_IsTrue(db_export_calls);
1505 if (ret == -1)
1506 handler_call_die(perf_db_export_calls);
1507 export_calls = !!ret;
1508 }
1509
1510 if (export_calls) {
1511 tables->dbe.crp =
1512 call_return_processor__new(python_process_call_return,
1513 &tables->dbe);
1514 if (!tables->dbe.crp)
1515 Py_FatalError("failed to create calls processor");
1516 }
1517
1518 /* handle export callchains */
1519 tables->dbe.cpr = NULL;
1520 db_export_callchains = PyDict_GetItemString(main_dict,
1521 perf_db_export_callchains);
1522 if (db_export_callchains) {
1523 ret = PyObject_IsTrue(db_export_callchains);
1524 if (ret == -1)
1525 handler_call_die(perf_db_export_callchains);
1526 export_callchains = !!ret;
1527 }
1528
1529 if (export_callchains) {
1530 /*
1531 * Attempt to use the call path root from the call return
1532 * processor, if the call return processor is in use. Otherwise,
1533 * we allocate a new call path root. This prevents exporting
1534 * duplicate call path ids when both are in use simultaniously.
1535 */
1536 if (tables->dbe.crp)
1537 tables->dbe.cpr = tables->dbe.crp->cpr;
1538 else
1539 tables->dbe.cpr = call_path_root__new();
1540
1541 if (!tables->dbe.cpr)
1542 Py_FatalError("failed to create call path root");
1543 }
1544
1545 tables->db_export_mode = true;
1546 /*
1547 * Reserve per symbol space for symbol->db_id via symbol__priv()
1548 */
1549 symbol_conf.priv_size = sizeof(u64);
1550
1551 SET_TABLE_HANDLER(evsel);
1552 SET_TABLE_HANDLER(machine);
1553 SET_TABLE_HANDLER(thread);
1554 SET_TABLE_HANDLER(comm);
1555 SET_TABLE_HANDLER(comm_thread);
1556 SET_TABLE_HANDLER(dso);
1557 SET_TABLE_HANDLER(symbol);
1558 SET_TABLE_HANDLER(branch_type);
1559 SET_TABLE_HANDLER(sample);
1560 SET_TABLE_HANDLER(call_path);
1561 SET_TABLE_HANDLER(call_return);
1562 SET_TABLE_HANDLER(context_switch);
1563
1564 /*
1565 * Synthesized events are samples but with architecture-specific data
1566 * stored in sample->raw_data. They are exported via
1567 * python_export_sample() and consequently do not need a separate export
1568 * callback.
1569 */
1570 tables->synth_handler = get_handler("synth_data");
1571}
1572
1573#if PY_MAJOR_VERSION < 3
1574static void _free_command_line(const char **command_line, int num)
1575{
1576 free(command_line);
1577}
1578#else
1579static void _free_command_line(wchar_t **command_line, int num)
1580{
1581 int i;
1582 for (i = 0; i < num; i++)
1583 PyMem_RawFree(command_line[i]);
1584 free(command_line);
1585}
1586#endif
1587
1588
1589/*
1590 * Start trace script
1591 */
1592static int python_start_script(const char *script, int argc, const char **argv)
1593{
1594 struct tables *tables = &tables_global;
1595 PyMODINIT_FUNC (*initfunc)(void);
1596#if PY_MAJOR_VERSION < 3
1597 const char **command_line;
1598#else
1599 wchar_t **command_line;
1600#endif
1601 /*
1602 * Use a non-const name variable to cope with python 2.6's
1603 * PyImport_AppendInittab prototype
1604 */
1605 char buf[PATH_MAX], name[19] = "perf_trace_context";
1606 int i, err = 0;
1607 FILE *fp;
1608
1609#if PY_MAJOR_VERSION < 3
1610 initfunc = initperf_trace_context;
1611 command_line = malloc((argc + 1) * sizeof(const char *));
1612 command_line[0] = script;
1613 for (i = 1; i < argc + 1; i++)
1614 command_line[i] = argv[i - 1];
1615#else
1616 initfunc = PyInit_perf_trace_context;
1617 command_line = malloc((argc + 1) * sizeof(wchar_t *));
1618 command_line[0] = Py_DecodeLocale(script, NULL);
1619 for (i = 1; i < argc + 1; i++)
1620 command_line[i] = Py_DecodeLocale(argv[i - 1], NULL);
1621#endif
1622
1623 PyImport_AppendInittab(name, initfunc);
1624 Py_Initialize();
1625
1626#if PY_MAJOR_VERSION < 3
1627 PySys_SetArgv(argc + 1, (char **)command_line);
1628#else
1629 PySys_SetArgv(argc + 1, command_line);
1630#endif
1631
1632 fp = fopen(script, "r");
1633 if (!fp) {
1634 sprintf(buf, "Can't open python script \"%s\"", script);
1635 perror(buf);
1636 err = -1;
1637 goto error;
1638 }
1639
1640 err = PyRun_SimpleFile(fp, script);
1641 if (err) {
1642 fprintf(stderr, "Error running python script %s\n", script);
1643 goto error;
1644 }
1645
1646 err = run_start_sub();
1647 if (err) {
1648 fprintf(stderr, "Error starting python script %s\n", script);
1649 goto error;
1650 }
1651
1652 set_table_handlers(tables);
1653
1654 if (tables->db_export_mode) {
1655 err = db_export__branch_types(&tables->dbe);
1656 if (err)
1657 goto error;
1658 }
1659
1660 _free_command_line(command_line, argc + 1);
1661
1662 return err;
1663error:
1664 Py_Finalize();
1665 _free_command_line(command_line, argc + 1);
1666
1667 return err;
1668}
1669
1670static int python_flush_script(void)
1671{
1672 return 0;
1673}
1674
1675/*
1676 * Stop trace script
1677 */
1678static int python_stop_script(void)
1679{
1680 struct tables *tables = &tables_global;
1681
1682 try_call_object("trace_end", NULL);
1683
1684 db_export__exit(&tables->dbe);
1685
1686 Py_XDECREF(main_dict);
1687 Py_XDECREF(main_module);
1688 Py_Finalize();
1689
1690 return 0;
1691}
1692
1693static int python_generate_script(struct tep_handle *pevent, const char *outfile)
1694{
1695 int i, not_first, count, nr_events;
1696 struct tep_event **all_events;
1697 struct tep_event *event = NULL;
1698 struct tep_format_field *f;
1699 char fname[PATH_MAX];
1700 FILE *ofp;
1701
1702 sprintf(fname, "%s.py", outfile);
1703 ofp = fopen(fname, "w");
1704 if (ofp == NULL) {
1705 fprintf(stderr, "couldn't open %s\n", fname);
1706 return -1;
1707 }
1708 fprintf(ofp, "# perf script event handlers, "
1709 "generated by perf script -g python\n");
1710
1711 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
1712 " License version 2\n\n");
1713
1714 fprintf(ofp, "# The common_* event handler fields are the most useful "
1715 "fields common to\n");
1716
1717 fprintf(ofp, "# all events. They don't necessarily correspond to "
1718 "the 'common_*' fields\n");
1719
1720 fprintf(ofp, "# in the format files. Those fields not available as "
1721 "handler params can\n");
1722
1723 fprintf(ofp, "# be retrieved using Python functions of the form "
1724 "common_*(context).\n");
1725
1726 fprintf(ofp, "# See the perf-script-python Documentation for the list "
1727 "of available functions.\n\n");
1728
1729 fprintf(ofp, "from __future__ import print_function\n\n");
1730 fprintf(ofp, "import os\n");
1731 fprintf(ofp, "import sys\n\n");
1732
1733 fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
1734 fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
1735 fprintf(ofp, "\nfrom perf_trace_context import *\n");
1736 fprintf(ofp, "from Core import *\n\n\n");
1737
1738 fprintf(ofp, "def trace_begin():\n");
1739 fprintf(ofp, "\tprint(\"in trace_begin\")\n\n");
1740
1741 fprintf(ofp, "def trace_end():\n");
1742 fprintf(ofp, "\tprint(\"in trace_end\")\n\n");
1743
1744 nr_events = tep_get_events_count(pevent);
1745 all_events = tep_list_events(pevent, TEP_EVENT_SORT_ID);
1746
1747 for (i = 0; all_events && i < nr_events; i++) {
1748 event = all_events[i];
1749 fprintf(ofp, "def %s__%s(", event->system, event->name);
1750 fprintf(ofp, "event_name, ");
1751 fprintf(ofp, "context, ");
1752 fprintf(ofp, "common_cpu,\n");
1753 fprintf(ofp, "\tcommon_secs, ");
1754 fprintf(ofp, "common_nsecs, ");
1755 fprintf(ofp, "common_pid, ");
1756 fprintf(ofp, "common_comm,\n\t");
1757 fprintf(ofp, "common_callchain, ");
1758
1759 not_first = 0;
1760 count = 0;
1761
1762 for (f = event->format.fields; f; f = f->next) {
1763 if (not_first++)
1764 fprintf(ofp, ", ");
1765 if (++count % 5 == 0)
1766 fprintf(ofp, "\n\t");
1767
1768 fprintf(ofp, "%s", f->name);
1769 }
1770 if (not_first++)
1771 fprintf(ofp, ", ");
1772 if (++count % 5 == 0)
1773 fprintf(ofp, "\n\t\t");
1774 fprintf(ofp, "perf_sample_dict");
1775
1776 fprintf(ofp, "):\n");
1777
1778 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
1779 "common_secs, common_nsecs,\n\t\t\t"
1780 "common_pid, common_comm)\n\n");
1781
1782 fprintf(ofp, "\t\tprint(\"");
1783
1784 not_first = 0;
1785 count = 0;
1786
1787 for (f = event->format.fields; f; f = f->next) {
1788 if (not_first++)
1789 fprintf(ofp, ", ");
1790 if (count && count % 3 == 0) {
1791 fprintf(ofp, "\" \\\n\t\t\"");
1792 }
1793 count++;
1794
1795 fprintf(ofp, "%s=", f->name);
1796 if (f->flags & TEP_FIELD_IS_STRING ||
1797 f->flags & TEP_FIELD_IS_FLAG ||
1798 f->flags & TEP_FIELD_IS_ARRAY ||
1799 f->flags & TEP_FIELD_IS_SYMBOLIC)
1800 fprintf(ofp, "%%s");
1801 else if (f->flags & TEP_FIELD_IS_SIGNED)
1802 fprintf(ofp, "%%d");
1803 else
1804 fprintf(ofp, "%%u");
1805 }
1806
1807 fprintf(ofp, "\" %% \\\n\t\t(");
1808
1809 not_first = 0;
1810 count = 0;
1811
1812 for (f = event->format.fields; f; f = f->next) {
1813 if (not_first++)
1814 fprintf(ofp, ", ");
1815
1816 if (++count % 5 == 0)
1817 fprintf(ofp, "\n\t\t");
1818
1819 if (f->flags & TEP_FIELD_IS_FLAG) {
1820 if ((count - 1) % 5 != 0) {
1821 fprintf(ofp, "\n\t\t");
1822 count = 4;
1823 }
1824 fprintf(ofp, "flag_str(\"");
1825 fprintf(ofp, "%s__%s\", ", event->system,
1826 event->name);
1827 fprintf(ofp, "\"%s\", %s)", f->name,
1828 f->name);
1829 } else if (f->flags & TEP_FIELD_IS_SYMBOLIC) {
1830 if ((count - 1) % 5 != 0) {
1831 fprintf(ofp, "\n\t\t");
1832 count = 4;
1833 }
1834 fprintf(ofp, "symbol_str(\"");
1835 fprintf(ofp, "%s__%s\", ", event->system,
1836 event->name);
1837 fprintf(ofp, "\"%s\", %s)", f->name,
1838 f->name);
1839 } else
1840 fprintf(ofp, "%s", f->name);
1841 }
1842
1843 fprintf(ofp, "))\n\n");
1844
1845 fprintf(ofp, "\t\tprint('Sample: {'+"
1846 "get_dict_as_string(perf_sample_dict['sample'], ', ')+'}')\n\n");
1847
1848 fprintf(ofp, "\t\tfor node in common_callchain:");
1849 fprintf(ofp, "\n\t\t\tif 'sym' in node:");
1850 fprintf(ofp, "\n\t\t\t\tprint(\"\\t[%%x] %%s\" %% (node['ip'], node['sym']['name']))");
1851 fprintf(ofp, "\n\t\t\telse:");
1852 fprintf(ofp, "\n\t\t\t\tprint(\"\t[%%x]\" %% (node['ip']))\n\n");
1853 fprintf(ofp, "\t\tprint()\n\n");
1854
1855 }
1856
1857 fprintf(ofp, "def trace_unhandled(event_name, context, "
1858 "event_fields_dict, perf_sample_dict):\n");
1859
1860 fprintf(ofp, "\t\tprint(get_dict_as_string(event_fields_dict))\n");
1861 fprintf(ofp, "\t\tprint('Sample: {'+"
1862 "get_dict_as_string(perf_sample_dict['sample'], ', ')+'}')\n\n");
1863
1864 fprintf(ofp, "def print_header("
1865 "event_name, cpu, secs, nsecs, pid, comm):\n"
1866 "\tprint(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
1867 "(event_name, cpu, secs, nsecs, pid, comm), end=\"\")\n\n");
1868
1869 fprintf(ofp, "def get_dict_as_string(a_dict, delimiter=' '):\n"
1870 "\treturn delimiter.join"
1871 "(['%%s=%%s'%%(k,str(v))for k,v in sorted(a_dict.items())])\n");
1872
1873 fclose(ofp);
1874
1875 fprintf(stderr, "generated Python script: %s\n", fname);
1876
1877 return 0;
1878}
1879
1880struct scripting_ops python_scripting_ops = {
1881 .name = "Python",
1882 .start_script = python_start_script,
1883 .flush_script = python_flush_script,
1884 .stop_script = python_stop_script,
1885 .process_event = python_process_event,
1886 .process_switch = python_process_switch,
1887 .process_stat = python_process_stat,
1888 .process_stat_interval = python_process_stat_interval,
1889 .generate_script = python_generate_script,
1890};