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