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 74 PyMODINIT_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 89 PyMODINIT_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 98 static char *cur_field_name; 99 static int zero_flag_atom; 100 #endif 101 102 #define MAX_FIELDS 64 103 104 extern struct scripting_context *scripting_context; 105 106 static PyObject *main_module, *main_dict; 107 108 struct 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 126 static struct tables tables_global; 127 128 static void handler_call_die(const char *handler_name) __noreturn; 129 static 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 */ 143 static 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 149 static 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 159 static 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 169 static 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 179 static 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 207 static 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 237 static 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 249 static 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 278 static 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 346 static 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 390 static 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 405 static 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 417 static 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 505 exit: 506 return pylist; 507 } 508 509 static 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 566 exit: 567 return pylist; 568 } 569 570 static 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 586 static 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 597 static 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 659 exit: 660 return pylist; 661 } 662 663 static 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 679 static 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 722 static 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 737 static 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 759 static 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 792 static 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 819 static 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 832 static 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 842 static 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, "pid", 862 _PyLong_FromLong(sample->pid)); 863 pydict_set_item_string_decref(dict_sample, "tid", 864 _PyLong_FromLong(sample->tid)); 865 pydict_set_item_string_decref(dict_sample, "cpu", 866 _PyLong_FromLong(sample->cpu)); 867 pydict_set_item_string_decref(dict_sample, "ip", 868 PyLong_FromUnsignedLongLong(sample->ip)); 869 pydict_set_item_string_decref(dict_sample, "time", 870 PyLong_FromUnsignedLongLong(sample->time)); 871 pydict_set_item_string_decref(dict_sample, "period", 872 PyLong_FromUnsignedLongLong(sample->period)); 873 pydict_set_item_string_decref(dict_sample, "phys_addr", 874 PyLong_FromUnsignedLongLong(sample->phys_addr)); 875 pydict_set_item_string_decref(dict_sample, "addr", 876 PyLong_FromUnsignedLongLong(sample->addr)); 877 set_sample_read_in_dict(dict_sample, sample, evsel); 878 pydict_set_item_string_decref(dict_sample, "weight", 879 PyLong_FromUnsignedLongLong(sample->weight)); 880 pydict_set_item_string_decref(dict_sample, "transaction", 881 PyLong_FromUnsignedLongLong(sample->transaction)); 882 set_sample_datasrc_in_dict(dict_sample, sample); 883 pydict_set_item_string_decref(dict, "sample", dict_sample); 884 885 pydict_set_item_string_decref(dict, "raw_buf", _PyBytes_FromStringAndSize( 886 (const char *)sample->raw_data, sample->raw_size)); 887 pydict_set_item_string_decref(dict, "comm", 888 _PyUnicode_FromString(thread__comm_str(al->thread))); 889 set_sym_in_dict(dict, al, "dso", "dso_bid", "dso_map_start", "dso_map_end", 890 "symbol", "symoff"); 891 892 pydict_set_item_string_decref(dict, "callchain", callchain); 893 894 brstack = python_process_brstack(sample, al->thread); 895 pydict_set_item_string_decref(dict, "brstack", brstack); 896 897 brstacksym = python_process_brstacksym(sample, al->thread); 898 pydict_set_item_string_decref(dict, "brstacksym", brstacksym); 899 900 if (sample->machine_pid) { 901 pydict_set_item_string_decref(dict_sample, "machine_pid", 902 _PyLong_FromLong(sample->machine_pid)); 903 pydict_set_item_string_decref(dict_sample, "vcpu", 904 _PyLong_FromLong(sample->vcpu)); 905 } 906 907 pydict_set_item_string_decref(dict_sample, "cpumode", 908 _PyLong_FromLong((unsigned long)sample->cpumode)); 909 910 if (addr_al) { 911 pydict_set_item_string_decref(dict_sample, "addr_correlates_sym", 912 PyBool_FromLong(1)); 913 set_sym_in_dict(dict_sample, addr_al, "addr_dso", "addr_dso_bid", 914 "addr_dso_map_start", "addr_dso_map_end", 915 "addr_symbol", "addr_symoff"); 916 } 917 918 if (sample->flags) 919 python_process_sample_flags(sample, dict_sample); 920 921 /* Instructions per cycle (IPC) */ 922 if (sample->insn_cnt && sample->cyc_cnt) { 923 pydict_set_item_string_decref(dict_sample, "insn_cnt", 924 PyLong_FromUnsignedLongLong(sample->insn_cnt)); 925 pydict_set_item_string_decref(dict_sample, "cyc_cnt", 926 PyLong_FromUnsignedLongLong(sample->cyc_cnt)); 927 } 928 929 if (set_regs_in_dict(dict, sample, evsel)) 930 Py_FatalError("Failed to setting regs in dict"); 931 932 return dict; 933 } 934 935 #ifdef HAVE_LIBTRACEEVENT 936 static void python_process_tracepoint(struct perf_sample *sample, 937 struct evsel *evsel, 938 struct addr_location *al, 939 struct addr_location *addr_al) 940 { 941 struct tep_event *event = evsel->tp_format; 942 PyObject *handler, *context, *t, *obj = NULL, *callchain; 943 PyObject *dict = NULL, *all_entries_dict = NULL; 944 static char handler_name[256]; 945 struct tep_format_field *field; 946 unsigned long s, ns; 947 unsigned n = 0; 948 int pid; 949 int cpu = sample->cpu; 950 void *data = sample->raw_data; 951 unsigned long long nsecs = sample->time; 952 const char *comm = thread__comm_str(al->thread); 953 const char *default_handler_name = "trace_unhandled"; 954 DECLARE_BITMAP(events_defined, TRACE_EVENT_TYPE_MAX); 955 956 bitmap_zero(events_defined, TRACE_EVENT_TYPE_MAX); 957 958 if (!event) { 959 snprintf(handler_name, sizeof(handler_name), 960 "ug! no event found for type %" PRIu64, (u64)evsel->core.attr.config); 961 Py_FatalError(handler_name); 962 } 963 964 pid = raw_field_value(event, "common_pid", data); 965 966 sprintf(handler_name, "%s__%s", event->system, event->name); 967 968 if (!__test_and_set_bit(event->id, events_defined)) 969 define_event_symbols(event, handler_name, event->print_fmt.args); 970 971 handler = get_handler(handler_name); 972 if (!handler) { 973 handler = get_handler(default_handler_name); 974 if (!handler) 975 return; 976 dict = PyDict_New(); 977 if (!dict) 978 Py_FatalError("couldn't create Python dict"); 979 } 980 981 t = PyTuple_New(MAX_FIELDS); 982 if (!t) 983 Py_FatalError("couldn't create Python tuple"); 984 985 986 s = nsecs / NSEC_PER_SEC; 987 ns = nsecs - s * NSEC_PER_SEC; 988 989 context = _PyCapsule_New(scripting_context, NULL, NULL); 990 991 PyTuple_SetItem(t, n++, _PyUnicode_FromString(handler_name)); 992 PyTuple_SetItem(t, n++, context); 993 994 /* ip unwinding */ 995 callchain = python_process_callchain(sample, evsel, al); 996 /* Need an additional reference for the perf_sample dict */ 997 Py_INCREF(callchain); 998 999 if (!dict) { 1000 PyTuple_SetItem(t, n++, _PyLong_FromLong(cpu)); 1001 PyTuple_SetItem(t, n++, _PyLong_FromLong(s)); 1002 PyTuple_SetItem(t, n++, _PyLong_FromLong(ns)); 1003 PyTuple_SetItem(t, n++, _PyLong_FromLong(pid)); 1004 PyTuple_SetItem(t, n++, _PyUnicode_FromString(comm)); 1005 PyTuple_SetItem(t, n++, callchain); 1006 } else { 1007 pydict_set_item_string_decref(dict, "common_cpu", _PyLong_FromLong(cpu)); 1008 pydict_set_item_string_decref(dict, "common_s", _PyLong_FromLong(s)); 1009 pydict_set_item_string_decref(dict, "common_ns", _PyLong_FromLong(ns)); 1010 pydict_set_item_string_decref(dict, "common_pid", _PyLong_FromLong(pid)); 1011 pydict_set_item_string_decref(dict, "common_comm", _PyUnicode_FromString(comm)); 1012 pydict_set_item_string_decref(dict, "common_callchain", callchain); 1013 } 1014 for (field = event->format.fields; field; field = field->next) { 1015 unsigned int offset, len; 1016 unsigned long long val; 1017 1018 if (field->flags & TEP_FIELD_IS_ARRAY) { 1019 offset = field->offset; 1020 len = field->size; 1021 if (field->flags & TEP_FIELD_IS_DYNAMIC) { 1022 val = tep_read_number(scripting_context->pevent, 1023 data + offset, len); 1024 offset = val; 1025 len = offset >> 16; 1026 offset &= 0xffff; 1027 if (tep_field_is_relative(field->flags)) 1028 offset += field->offset + field->size; 1029 } 1030 if (field->flags & TEP_FIELD_IS_STRING && 1031 is_printable_array(data + offset, len)) { 1032 obj = _PyUnicode_FromString((char *) data + offset); 1033 } else { 1034 obj = PyByteArray_FromStringAndSize((const char *) data + offset, len); 1035 field->flags &= ~TEP_FIELD_IS_STRING; 1036 } 1037 } else { /* FIELD_IS_NUMERIC */ 1038 obj = get_field_numeric_entry(event, field, data); 1039 } 1040 if (!dict) 1041 PyTuple_SetItem(t, n++, obj); 1042 else 1043 pydict_set_item_string_decref(dict, field->name, obj); 1044 1045 } 1046 1047 if (dict) 1048 PyTuple_SetItem(t, n++, dict); 1049 1050 if (get_argument_count(handler) == (int) n + 1) { 1051 all_entries_dict = get_perf_sample_dict(sample, evsel, al, addr_al, 1052 callchain); 1053 PyTuple_SetItem(t, n++, all_entries_dict); 1054 } else { 1055 Py_DECREF(callchain); 1056 } 1057 1058 if (_PyTuple_Resize(&t, n) == -1) 1059 Py_FatalError("error resizing Python tuple"); 1060 1061 if (!dict) 1062 call_object(handler, t, handler_name); 1063 else 1064 call_object(handler, t, default_handler_name); 1065 1066 Py_DECREF(t); 1067 } 1068 #else 1069 static void python_process_tracepoint(struct perf_sample *sample __maybe_unused, 1070 struct evsel *evsel __maybe_unused, 1071 struct addr_location *al __maybe_unused, 1072 struct addr_location *addr_al __maybe_unused) 1073 { 1074 fprintf(stderr, "Tracepoint events are not supported because " 1075 "perf is not linked with libtraceevent.\n"); 1076 } 1077 #endif 1078 1079 static PyObject *tuple_new(unsigned int sz) 1080 { 1081 PyObject *t; 1082 1083 t = PyTuple_New(sz); 1084 if (!t) 1085 Py_FatalError("couldn't create Python tuple"); 1086 return t; 1087 } 1088 1089 static int tuple_set_s64(PyObject *t, unsigned int pos, s64 val) 1090 { 1091 #if BITS_PER_LONG == 64 1092 return PyTuple_SetItem(t, pos, _PyLong_FromLong(val)); 1093 #endif 1094 #if BITS_PER_LONG == 32 1095 return PyTuple_SetItem(t, pos, PyLong_FromLongLong(val)); 1096 #endif 1097 } 1098 1099 /* 1100 * Databases support only signed 64-bit numbers, so even though we are 1101 * exporting a u64, it must be as s64. 1102 */ 1103 #define tuple_set_d64 tuple_set_s64 1104 1105 static int tuple_set_u64(PyObject *t, unsigned int pos, u64 val) 1106 { 1107 #if BITS_PER_LONG == 64 1108 return PyTuple_SetItem(t, pos, PyLong_FromUnsignedLong(val)); 1109 #endif 1110 #if BITS_PER_LONG == 32 1111 return PyTuple_SetItem(t, pos, PyLong_FromUnsignedLongLong(val)); 1112 #endif 1113 } 1114 1115 static int tuple_set_u32(PyObject *t, unsigned int pos, u32 val) 1116 { 1117 return PyTuple_SetItem(t, pos, PyLong_FromUnsignedLong(val)); 1118 } 1119 1120 static int tuple_set_s32(PyObject *t, unsigned int pos, s32 val) 1121 { 1122 return PyTuple_SetItem(t, pos, _PyLong_FromLong(val)); 1123 } 1124 1125 static int tuple_set_bool(PyObject *t, unsigned int pos, bool val) 1126 { 1127 return PyTuple_SetItem(t, pos, PyBool_FromLong(val)); 1128 } 1129 1130 static int tuple_set_string(PyObject *t, unsigned int pos, const char *s) 1131 { 1132 return PyTuple_SetItem(t, pos, _PyUnicode_FromString(s)); 1133 } 1134 1135 static int tuple_set_bytes(PyObject *t, unsigned int pos, void *bytes, 1136 unsigned int sz) 1137 { 1138 return PyTuple_SetItem(t, pos, _PyBytes_FromStringAndSize(bytes, sz)); 1139 } 1140 1141 static int python_export_evsel(struct db_export *dbe, struct evsel *evsel) 1142 { 1143 struct tables *tables = container_of(dbe, struct tables, dbe); 1144 PyObject *t; 1145 1146 t = tuple_new(2); 1147 1148 tuple_set_d64(t, 0, evsel->db_id); 1149 tuple_set_string(t, 1, evsel__name(evsel)); 1150 1151 call_object(tables->evsel_handler, t, "evsel_table"); 1152 1153 Py_DECREF(t); 1154 1155 return 0; 1156 } 1157 1158 static int python_export_machine(struct db_export *dbe, 1159 struct machine *machine) 1160 { 1161 struct tables *tables = container_of(dbe, struct tables, dbe); 1162 PyObject *t; 1163 1164 t = tuple_new(3); 1165 1166 tuple_set_d64(t, 0, machine->db_id); 1167 tuple_set_s32(t, 1, machine->pid); 1168 tuple_set_string(t, 2, machine->root_dir ? machine->root_dir : ""); 1169 1170 call_object(tables->machine_handler, t, "machine_table"); 1171 1172 Py_DECREF(t); 1173 1174 return 0; 1175 } 1176 1177 static int python_export_thread(struct db_export *dbe, struct thread *thread, 1178 u64 main_thread_db_id, struct machine *machine) 1179 { 1180 struct tables *tables = container_of(dbe, struct tables, dbe); 1181 PyObject *t; 1182 1183 t = tuple_new(5); 1184 1185 tuple_set_d64(t, 0, thread__db_id(thread)); 1186 tuple_set_d64(t, 1, machine->db_id); 1187 tuple_set_d64(t, 2, main_thread_db_id); 1188 tuple_set_s32(t, 3, thread__pid(thread)); 1189 tuple_set_s32(t, 4, thread__tid(thread)); 1190 1191 call_object(tables->thread_handler, t, "thread_table"); 1192 1193 Py_DECREF(t); 1194 1195 return 0; 1196 } 1197 1198 static int python_export_comm(struct db_export *dbe, struct comm *comm, 1199 struct thread *thread) 1200 { 1201 struct tables *tables = container_of(dbe, struct tables, dbe); 1202 PyObject *t; 1203 1204 t = tuple_new(5); 1205 1206 tuple_set_d64(t, 0, comm->db_id); 1207 tuple_set_string(t, 1, comm__str(comm)); 1208 tuple_set_d64(t, 2, thread__db_id(thread)); 1209 tuple_set_d64(t, 3, comm->start); 1210 tuple_set_s32(t, 4, comm->exec); 1211 1212 call_object(tables->comm_handler, t, "comm_table"); 1213 1214 Py_DECREF(t); 1215 1216 return 0; 1217 } 1218 1219 static int python_export_comm_thread(struct db_export *dbe, u64 db_id, 1220 struct comm *comm, struct thread *thread) 1221 { 1222 struct tables *tables = container_of(dbe, struct tables, dbe); 1223 PyObject *t; 1224 1225 t = tuple_new(3); 1226 1227 tuple_set_d64(t, 0, db_id); 1228 tuple_set_d64(t, 1, comm->db_id); 1229 tuple_set_d64(t, 2, thread__db_id(thread)); 1230 1231 call_object(tables->comm_thread_handler, t, "comm_thread_table"); 1232 1233 Py_DECREF(t); 1234 1235 return 0; 1236 } 1237 1238 static int python_export_dso(struct db_export *dbe, struct dso *dso, 1239 struct machine *machine) 1240 { 1241 struct tables *tables = container_of(dbe, struct tables, dbe); 1242 char sbuild_id[SBUILD_ID_SIZE]; 1243 PyObject *t; 1244 1245 build_id__sprintf(&dso->bid, sbuild_id); 1246 1247 t = tuple_new(5); 1248 1249 tuple_set_d64(t, 0, dso->db_id); 1250 tuple_set_d64(t, 1, machine->db_id); 1251 tuple_set_string(t, 2, dso->short_name); 1252 tuple_set_string(t, 3, dso->long_name); 1253 tuple_set_string(t, 4, sbuild_id); 1254 1255 call_object(tables->dso_handler, t, "dso_table"); 1256 1257 Py_DECREF(t); 1258 1259 return 0; 1260 } 1261 1262 static int python_export_symbol(struct db_export *dbe, struct symbol *sym, 1263 struct dso *dso) 1264 { 1265 struct tables *tables = container_of(dbe, struct tables, dbe); 1266 u64 *sym_db_id = symbol__priv(sym); 1267 PyObject *t; 1268 1269 t = tuple_new(6); 1270 1271 tuple_set_d64(t, 0, *sym_db_id); 1272 tuple_set_d64(t, 1, dso->db_id); 1273 tuple_set_d64(t, 2, sym->start); 1274 tuple_set_d64(t, 3, sym->end); 1275 tuple_set_s32(t, 4, sym->binding); 1276 tuple_set_string(t, 5, sym->name); 1277 1278 call_object(tables->symbol_handler, t, "symbol_table"); 1279 1280 Py_DECREF(t); 1281 1282 return 0; 1283 } 1284 1285 static int python_export_branch_type(struct db_export *dbe, u32 branch_type, 1286 const char *name) 1287 { 1288 struct tables *tables = container_of(dbe, struct tables, dbe); 1289 PyObject *t; 1290 1291 t = tuple_new(2); 1292 1293 tuple_set_s32(t, 0, branch_type); 1294 tuple_set_string(t, 1, name); 1295 1296 call_object(tables->branch_type_handler, t, "branch_type_table"); 1297 1298 Py_DECREF(t); 1299 1300 return 0; 1301 } 1302 1303 static void python_export_sample_table(struct db_export *dbe, 1304 struct export_sample *es) 1305 { 1306 struct tables *tables = container_of(dbe, struct tables, dbe); 1307 PyObject *t; 1308 1309 t = tuple_new(25); 1310 1311 tuple_set_d64(t, 0, es->db_id); 1312 tuple_set_d64(t, 1, es->evsel->db_id); 1313 tuple_set_d64(t, 2, maps__machine(es->al->maps)->db_id); 1314 tuple_set_d64(t, 3, thread__db_id(es->al->thread)); 1315 tuple_set_d64(t, 4, es->comm_db_id); 1316 tuple_set_d64(t, 5, es->dso_db_id); 1317 tuple_set_d64(t, 6, es->sym_db_id); 1318 tuple_set_d64(t, 7, es->offset); 1319 tuple_set_d64(t, 8, es->sample->ip); 1320 tuple_set_d64(t, 9, es->sample->time); 1321 tuple_set_s32(t, 10, es->sample->cpu); 1322 tuple_set_d64(t, 11, es->addr_dso_db_id); 1323 tuple_set_d64(t, 12, es->addr_sym_db_id); 1324 tuple_set_d64(t, 13, es->addr_offset); 1325 tuple_set_d64(t, 14, es->sample->addr); 1326 tuple_set_d64(t, 15, es->sample->period); 1327 tuple_set_d64(t, 16, es->sample->weight); 1328 tuple_set_d64(t, 17, es->sample->transaction); 1329 tuple_set_d64(t, 18, es->sample->data_src); 1330 tuple_set_s32(t, 19, es->sample->flags & PERF_BRANCH_MASK); 1331 tuple_set_s32(t, 20, !!(es->sample->flags & PERF_IP_FLAG_IN_TX)); 1332 tuple_set_d64(t, 21, es->call_path_id); 1333 tuple_set_d64(t, 22, es->sample->insn_cnt); 1334 tuple_set_d64(t, 23, es->sample->cyc_cnt); 1335 tuple_set_s32(t, 24, es->sample->flags); 1336 1337 call_object(tables->sample_handler, t, "sample_table"); 1338 1339 Py_DECREF(t); 1340 } 1341 1342 static void python_export_synth(struct db_export *dbe, struct export_sample *es) 1343 { 1344 struct tables *tables = container_of(dbe, struct tables, dbe); 1345 PyObject *t; 1346 1347 t = tuple_new(3); 1348 1349 tuple_set_d64(t, 0, es->db_id); 1350 tuple_set_d64(t, 1, es->evsel->core.attr.config); 1351 tuple_set_bytes(t, 2, es->sample->raw_data, es->sample->raw_size); 1352 1353 call_object(tables->synth_handler, t, "synth_data"); 1354 1355 Py_DECREF(t); 1356 } 1357 1358 static int python_export_sample(struct db_export *dbe, 1359 struct export_sample *es) 1360 { 1361 struct tables *tables = container_of(dbe, struct tables, dbe); 1362 1363 python_export_sample_table(dbe, es); 1364 1365 if (es->evsel->core.attr.type == PERF_TYPE_SYNTH && tables->synth_handler) 1366 python_export_synth(dbe, es); 1367 1368 return 0; 1369 } 1370 1371 static int python_export_call_path(struct db_export *dbe, struct call_path *cp) 1372 { 1373 struct tables *tables = container_of(dbe, struct tables, dbe); 1374 PyObject *t; 1375 u64 parent_db_id, sym_db_id; 1376 1377 parent_db_id = cp->parent ? cp->parent->db_id : 0; 1378 sym_db_id = cp->sym ? *(u64 *)symbol__priv(cp->sym) : 0; 1379 1380 t = tuple_new(4); 1381 1382 tuple_set_d64(t, 0, cp->db_id); 1383 tuple_set_d64(t, 1, parent_db_id); 1384 tuple_set_d64(t, 2, sym_db_id); 1385 tuple_set_d64(t, 3, cp->ip); 1386 1387 call_object(tables->call_path_handler, t, "call_path_table"); 1388 1389 Py_DECREF(t); 1390 1391 return 0; 1392 } 1393 1394 static int python_export_call_return(struct db_export *dbe, 1395 struct call_return *cr) 1396 { 1397 struct tables *tables = container_of(dbe, struct tables, dbe); 1398 u64 comm_db_id = cr->comm ? cr->comm->db_id : 0; 1399 PyObject *t; 1400 1401 t = tuple_new(14); 1402 1403 tuple_set_d64(t, 0, cr->db_id); 1404 tuple_set_d64(t, 1, thread__db_id(cr->thread)); 1405 tuple_set_d64(t, 2, comm_db_id); 1406 tuple_set_d64(t, 3, cr->cp->db_id); 1407 tuple_set_d64(t, 4, cr->call_time); 1408 tuple_set_d64(t, 5, cr->return_time); 1409 tuple_set_d64(t, 6, cr->branch_count); 1410 tuple_set_d64(t, 7, cr->call_ref); 1411 tuple_set_d64(t, 8, cr->return_ref); 1412 tuple_set_d64(t, 9, cr->cp->parent->db_id); 1413 tuple_set_s32(t, 10, cr->flags); 1414 tuple_set_d64(t, 11, cr->parent_db_id); 1415 tuple_set_d64(t, 12, cr->insn_count); 1416 tuple_set_d64(t, 13, cr->cyc_count); 1417 1418 call_object(tables->call_return_handler, t, "call_return_table"); 1419 1420 Py_DECREF(t); 1421 1422 return 0; 1423 } 1424 1425 static int python_export_context_switch(struct db_export *dbe, u64 db_id, 1426 struct machine *machine, 1427 struct perf_sample *sample, 1428 u64 th_out_id, u64 comm_out_id, 1429 u64 th_in_id, u64 comm_in_id, int flags) 1430 { 1431 struct tables *tables = container_of(dbe, struct tables, dbe); 1432 PyObject *t; 1433 1434 t = tuple_new(9); 1435 1436 tuple_set_d64(t, 0, db_id); 1437 tuple_set_d64(t, 1, machine->db_id); 1438 tuple_set_d64(t, 2, sample->time); 1439 tuple_set_s32(t, 3, sample->cpu); 1440 tuple_set_d64(t, 4, th_out_id); 1441 tuple_set_d64(t, 5, comm_out_id); 1442 tuple_set_d64(t, 6, th_in_id); 1443 tuple_set_d64(t, 7, comm_in_id); 1444 tuple_set_s32(t, 8, flags); 1445 1446 call_object(tables->context_switch_handler, t, "context_switch"); 1447 1448 Py_DECREF(t); 1449 1450 return 0; 1451 } 1452 1453 static int python_process_call_return(struct call_return *cr, u64 *parent_db_id, 1454 void *data) 1455 { 1456 struct db_export *dbe = data; 1457 1458 return db_export__call_return(dbe, cr, parent_db_id); 1459 } 1460 1461 static void python_process_general_event(struct perf_sample *sample, 1462 struct evsel *evsel, 1463 struct addr_location *al, 1464 struct addr_location *addr_al) 1465 { 1466 PyObject *handler, *t, *dict, *callchain; 1467 static char handler_name[64]; 1468 unsigned n = 0; 1469 1470 snprintf(handler_name, sizeof(handler_name), "%s", "process_event"); 1471 1472 handler = get_handler(handler_name); 1473 if (!handler) 1474 return; 1475 1476 /* 1477 * Use the MAX_FIELDS to make the function expandable, though 1478 * currently there is only one item for the tuple. 1479 */ 1480 t = PyTuple_New(MAX_FIELDS); 1481 if (!t) 1482 Py_FatalError("couldn't create Python tuple"); 1483 1484 /* ip unwinding */ 1485 callchain = python_process_callchain(sample, evsel, al); 1486 dict = get_perf_sample_dict(sample, evsel, al, addr_al, callchain); 1487 1488 PyTuple_SetItem(t, n++, dict); 1489 if (_PyTuple_Resize(&t, n) == -1) 1490 Py_FatalError("error resizing Python tuple"); 1491 1492 call_object(handler, t, handler_name); 1493 1494 Py_DECREF(t); 1495 } 1496 1497 static void python_process_event(union perf_event *event, 1498 struct perf_sample *sample, 1499 struct evsel *evsel, 1500 struct addr_location *al, 1501 struct addr_location *addr_al) 1502 { 1503 struct tables *tables = &tables_global; 1504 1505 scripting_context__update(scripting_context, event, sample, evsel, al, addr_al); 1506 1507 switch (evsel->core.attr.type) { 1508 case PERF_TYPE_TRACEPOINT: 1509 python_process_tracepoint(sample, evsel, al, addr_al); 1510 break; 1511 /* Reserve for future process_hw/sw/raw APIs */ 1512 default: 1513 if (tables->db_export_mode) 1514 db_export__sample(&tables->dbe, event, sample, evsel, al, addr_al); 1515 else 1516 python_process_general_event(sample, evsel, al, addr_al); 1517 } 1518 } 1519 1520 static void python_process_throttle(union perf_event *event, 1521 struct perf_sample *sample, 1522 struct machine *machine) 1523 { 1524 const char *handler_name; 1525 PyObject *handler, *t; 1526 1527 if (event->header.type == PERF_RECORD_THROTTLE) 1528 handler_name = "throttle"; 1529 else 1530 handler_name = "unthrottle"; 1531 handler = get_handler(handler_name); 1532 if (!handler) 1533 return; 1534 1535 t = tuple_new(6); 1536 if (!t) 1537 return; 1538 1539 tuple_set_u64(t, 0, event->throttle.time); 1540 tuple_set_u64(t, 1, event->throttle.id); 1541 tuple_set_u64(t, 2, event->throttle.stream_id); 1542 tuple_set_s32(t, 3, sample->cpu); 1543 tuple_set_s32(t, 4, sample->pid); 1544 tuple_set_s32(t, 5, sample->tid); 1545 1546 call_object(handler, t, handler_name); 1547 1548 Py_DECREF(t); 1549 } 1550 1551 static void python_do_process_switch(union perf_event *event, 1552 struct perf_sample *sample, 1553 struct machine *machine) 1554 { 1555 const char *handler_name = "context_switch"; 1556 bool out = event->header.misc & PERF_RECORD_MISC_SWITCH_OUT; 1557 bool out_preempt = out && (event->header.misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT); 1558 pid_t np_pid = -1, np_tid = -1; 1559 PyObject *handler, *t; 1560 1561 handler = get_handler(handler_name); 1562 if (!handler) 1563 return; 1564 1565 if (event->header.type == PERF_RECORD_SWITCH_CPU_WIDE) { 1566 np_pid = event->context_switch.next_prev_pid; 1567 np_tid = event->context_switch.next_prev_tid; 1568 } 1569 1570 t = tuple_new(11); 1571 if (!t) 1572 return; 1573 1574 tuple_set_u64(t, 0, sample->time); 1575 tuple_set_s32(t, 1, sample->cpu); 1576 tuple_set_s32(t, 2, sample->pid); 1577 tuple_set_s32(t, 3, sample->tid); 1578 tuple_set_s32(t, 4, np_pid); 1579 tuple_set_s32(t, 5, np_tid); 1580 tuple_set_s32(t, 6, machine->pid); 1581 tuple_set_bool(t, 7, out); 1582 tuple_set_bool(t, 8, out_preempt); 1583 tuple_set_s32(t, 9, sample->machine_pid); 1584 tuple_set_s32(t, 10, sample->vcpu); 1585 1586 call_object(handler, t, handler_name); 1587 1588 Py_DECREF(t); 1589 } 1590 1591 static void python_process_switch(union perf_event *event, 1592 struct perf_sample *sample, 1593 struct machine *machine) 1594 { 1595 struct tables *tables = &tables_global; 1596 1597 if (tables->db_export_mode) 1598 db_export__switch(&tables->dbe, event, sample, machine); 1599 else 1600 python_do_process_switch(event, sample, machine); 1601 } 1602 1603 static void python_process_auxtrace_error(struct perf_session *session __maybe_unused, 1604 union perf_event *event) 1605 { 1606 struct perf_record_auxtrace_error *e = &event->auxtrace_error; 1607 u8 cpumode = e->header.misc & PERF_RECORD_MISC_CPUMODE_MASK; 1608 const char *handler_name = "auxtrace_error"; 1609 unsigned long long tm = e->time; 1610 const char *msg = e->msg; 1611 PyObject *handler, *t; 1612 1613 handler = get_handler(handler_name); 1614 if (!handler) 1615 return; 1616 1617 if (!e->fmt) { 1618 tm = 0; 1619 msg = (const char *)&e->time; 1620 } 1621 1622 t = tuple_new(11); 1623 1624 tuple_set_u32(t, 0, e->type); 1625 tuple_set_u32(t, 1, e->code); 1626 tuple_set_s32(t, 2, e->cpu); 1627 tuple_set_s32(t, 3, e->pid); 1628 tuple_set_s32(t, 4, e->tid); 1629 tuple_set_u64(t, 5, e->ip); 1630 tuple_set_u64(t, 6, tm); 1631 tuple_set_string(t, 7, msg); 1632 tuple_set_u32(t, 8, cpumode); 1633 tuple_set_s32(t, 9, e->machine_pid); 1634 tuple_set_s32(t, 10, e->vcpu); 1635 1636 call_object(handler, t, handler_name); 1637 1638 Py_DECREF(t); 1639 } 1640 1641 static void get_handler_name(char *str, size_t size, 1642 struct evsel *evsel) 1643 { 1644 char *p = str; 1645 1646 scnprintf(str, size, "stat__%s", evsel__name(evsel)); 1647 1648 while ((p = strchr(p, ':'))) { 1649 *p = '_'; 1650 p++; 1651 } 1652 } 1653 1654 static void 1655 process_stat(struct evsel *counter, struct perf_cpu cpu, int thread, u64 tstamp, 1656 struct perf_counts_values *count) 1657 { 1658 PyObject *handler, *t; 1659 static char handler_name[256]; 1660 int n = 0; 1661 1662 t = PyTuple_New(MAX_FIELDS); 1663 if (!t) 1664 Py_FatalError("couldn't create Python tuple"); 1665 1666 get_handler_name(handler_name, sizeof(handler_name), 1667 counter); 1668 1669 handler = get_handler(handler_name); 1670 if (!handler) { 1671 pr_debug("can't find python handler %s\n", handler_name); 1672 return; 1673 } 1674 1675 PyTuple_SetItem(t, n++, _PyLong_FromLong(cpu.cpu)); 1676 PyTuple_SetItem(t, n++, _PyLong_FromLong(thread)); 1677 1678 tuple_set_u64(t, n++, tstamp); 1679 tuple_set_u64(t, n++, count->val); 1680 tuple_set_u64(t, n++, count->ena); 1681 tuple_set_u64(t, n++, count->run); 1682 1683 if (_PyTuple_Resize(&t, n) == -1) 1684 Py_FatalError("error resizing Python tuple"); 1685 1686 call_object(handler, t, handler_name); 1687 1688 Py_DECREF(t); 1689 } 1690 1691 static void python_process_stat(struct perf_stat_config *config, 1692 struct evsel *counter, u64 tstamp) 1693 { 1694 struct perf_thread_map *threads = counter->core.threads; 1695 struct perf_cpu_map *cpus = counter->core.cpus; 1696 int cpu, thread; 1697 1698 for (thread = 0; thread < perf_thread_map__nr(threads); thread++) { 1699 for (cpu = 0; cpu < perf_cpu_map__nr(cpus); cpu++) { 1700 process_stat(counter, perf_cpu_map__cpu(cpus, cpu), 1701 perf_thread_map__pid(threads, thread), tstamp, 1702 perf_counts(counter->counts, cpu, thread)); 1703 } 1704 } 1705 } 1706 1707 static void python_process_stat_interval(u64 tstamp) 1708 { 1709 PyObject *handler, *t; 1710 static const char handler_name[] = "stat__interval"; 1711 int n = 0; 1712 1713 t = PyTuple_New(MAX_FIELDS); 1714 if (!t) 1715 Py_FatalError("couldn't create Python tuple"); 1716 1717 handler = get_handler(handler_name); 1718 if (!handler) { 1719 pr_debug("can't find python handler %s\n", handler_name); 1720 return; 1721 } 1722 1723 tuple_set_u64(t, n++, tstamp); 1724 1725 if (_PyTuple_Resize(&t, n) == -1) 1726 Py_FatalError("error resizing Python tuple"); 1727 1728 call_object(handler, t, handler_name); 1729 1730 Py_DECREF(t); 1731 } 1732 1733 static int perf_script_context_init(void) 1734 { 1735 PyObject *perf_script_context; 1736 PyObject *perf_trace_context; 1737 PyObject *dict; 1738 int ret; 1739 1740 perf_trace_context = PyImport_AddModule("perf_trace_context"); 1741 if (!perf_trace_context) 1742 return -1; 1743 dict = PyModule_GetDict(perf_trace_context); 1744 if (!dict) 1745 return -1; 1746 1747 perf_script_context = _PyCapsule_New(scripting_context, NULL, NULL); 1748 if (!perf_script_context) 1749 return -1; 1750 1751 ret = PyDict_SetItemString(dict, "perf_script_context", perf_script_context); 1752 if (!ret) 1753 ret = PyDict_SetItemString(main_dict, "perf_script_context", perf_script_context); 1754 Py_DECREF(perf_script_context); 1755 return ret; 1756 } 1757 1758 static int run_start_sub(void) 1759 { 1760 main_module = PyImport_AddModule("__main__"); 1761 if (main_module == NULL) 1762 return -1; 1763 Py_INCREF(main_module); 1764 1765 main_dict = PyModule_GetDict(main_module); 1766 if (main_dict == NULL) 1767 goto error; 1768 Py_INCREF(main_dict); 1769 1770 if (perf_script_context_init()) 1771 goto error; 1772 1773 try_call_object("trace_begin", NULL); 1774 1775 return 0; 1776 1777 error: 1778 Py_XDECREF(main_dict); 1779 Py_XDECREF(main_module); 1780 return -1; 1781 } 1782 1783 #define SET_TABLE_HANDLER_(name, handler_name, table_name) do { \ 1784 tables->handler_name = get_handler(#table_name); \ 1785 if (tables->handler_name) \ 1786 tables->dbe.export_ ## name = python_export_ ## name; \ 1787 } while (0) 1788 1789 #define SET_TABLE_HANDLER(name) \ 1790 SET_TABLE_HANDLER_(name, name ## _handler, name ## _table) 1791 1792 static void set_table_handlers(struct tables *tables) 1793 { 1794 const char *perf_db_export_mode = "perf_db_export_mode"; 1795 const char *perf_db_export_calls = "perf_db_export_calls"; 1796 const char *perf_db_export_callchains = "perf_db_export_callchains"; 1797 PyObject *db_export_mode, *db_export_calls, *db_export_callchains; 1798 bool export_calls = false; 1799 bool export_callchains = false; 1800 int ret; 1801 1802 memset(tables, 0, sizeof(struct tables)); 1803 if (db_export__init(&tables->dbe)) 1804 Py_FatalError("failed to initialize export"); 1805 1806 db_export_mode = PyDict_GetItemString(main_dict, perf_db_export_mode); 1807 if (!db_export_mode) 1808 return; 1809 1810 ret = PyObject_IsTrue(db_export_mode); 1811 if (ret == -1) 1812 handler_call_die(perf_db_export_mode); 1813 if (!ret) 1814 return; 1815 1816 /* handle export calls */ 1817 tables->dbe.crp = NULL; 1818 db_export_calls = PyDict_GetItemString(main_dict, perf_db_export_calls); 1819 if (db_export_calls) { 1820 ret = PyObject_IsTrue(db_export_calls); 1821 if (ret == -1) 1822 handler_call_die(perf_db_export_calls); 1823 export_calls = !!ret; 1824 } 1825 1826 if (export_calls) { 1827 tables->dbe.crp = 1828 call_return_processor__new(python_process_call_return, 1829 &tables->dbe); 1830 if (!tables->dbe.crp) 1831 Py_FatalError("failed to create calls processor"); 1832 } 1833 1834 /* handle export callchains */ 1835 tables->dbe.cpr = NULL; 1836 db_export_callchains = PyDict_GetItemString(main_dict, 1837 perf_db_export_callchains); 1838 if (db_export_callchains) { 1839 ret = PyObject_IsTrue(db_export_callchains); 1840 if (ret == -1) 1841 handler_call_die(perf_db_export_callchains); 1842 export_callchains = !!ret; 1843 } 1844 1845 if (export_callchains) { 1846 /* 1847 * Attempt to use the call path root from the call return 1848 * processor, if the call return processor is in use. Otherwise, 1849 * we allocate a new call path root. This prevents exporting 1850 * duplicate call path ids when both are in use simultaneously. 1851 */ 1852 if (tables->dbe.crp) 1853 tables->dbe.cpr = tables->dbe.crp->cpr; 1854 else 1855 tables->dbe.cpr = call_path_root__new(); 1856 1857 if (!tables->dbe.cpr) 1858 Py_FatalError("failed to create call path root"); 1859 } 1860 1861 tables->db_export_mode = true; 1862 /* 1863 * Reserve per symbol space for symbol->db_id via symbol__priv() 1864 */ 1865 symbol_conf.priv_size = sizeof(u64); 1866 1867 SET_TABLE_HANDLER(evsel); 1868 SET_TABLE_HANDLER(machine); 1869 SET_TABLE_HANDLER(thread); 1870 SET_TABLE_HANDLER(comm); 1871 SET_TABLE_HANDLER(comm_thread); 1872 SET_TABLE_HANDLER(dso); 1873 SET_TABLE_HANDLER(symbol); 1874 SET_TABLE_HANDLER(branch_type); 1875 SET_TABLE_HANDLER(sample); 1876 SET_TABLE_HANDLER(call_path); 1877 SET_TABLE_HANDLER(call_return); 1878 SET_TABLE_HANDLER(context_switch); 1879 1880 /* 1881 * Synthesized events are samples but with architecture-specific data 1882 * stored in sample->raw_data. They are exported via 1883 * python_export_sample() and consequently do not need a separate export 1884 * callback. 1885 */ 1886 tables->synth_handler = get_handler("synth_data"); 1887 } 1888 1889 #if PY_MAJOR_VERSION < 3 1890 static void _free_command_line(const char **command_line, int num) 1891 { 1892 free(command_line); 1893 } 1894 #else 1895 static void _free_command_line(wchar_t **command_line, int num) 1896 { 1897 int i; 1898 for (i = 0; i < num; i++) 1899 PyMem_RawFree(command_line[i]); 1900 free(command_line); 1901 } 1902 #endif 1903 1904 1905 /* 1906 * Start trace script 1907 */ 1908 static int python_start_script(const char *script, int argc, const char **argv, 1909 struct perf_session *session) 1910 { 1911 struct tables *tables = &tables_global; 1912 #if PY_MAJOR_VERSION < 3 1913 const char **command_line; 1914 #else 1915 wchar_t **command_line; 1916 #endif 1917 /* 1918 * Use a non-const name variable to cope with python 2.6's 1919 * PyImport_AppendInittab prototype 1920 */ 1921 char buf[PATH_MAX], name[19] = "perf_trace_context"; 1922 int i, err = 0; 1923 FILE *fp; 1924 1925 scripting_context->session = session; 1926 #if PY_MAJOR_VERSION < 3 1927 command_line = malloc((argc + 1) * sizeof(const char *)); 1928 if (!command_line) 1929 return -1; 1930 1931 command_line[0] = script; 1932 for (i = 1; i < argc + 1; i++) 1933 command_line[i] = argv[i - 1]; 1934 PyImport_AppendInittab(name, initperf_trace_context); 1935 #else 1936 command_line = malloc((argc + 1) * sizeof(wchar_t *)); 1937 if (!command_line) 1938 return -1; 1939 1940 command_line[0] = Py_DecodeLocale(script, NULL); 1941 for (i = 1; i < argc + 1; i++) 1942 command_line[i] = Py_DecodeLocale(argv[i - 1], NULL); 1943 PyImport_AppendInittab(name, PyInit_perf_trace_context); 1944 #endif 1945 Py_Initialize(); 1946 1947 #if PY_MAJOR_VERSION < 3 1948 PySys_SetArgv(argc + 1, (char **)command_line); 1949 #else 1950 PySys_SetArgv(argc + 1, command_line); 1951 #endif 1952 1953 fp = fopen(script, "r"); 1954 if (!fp) { 1955 sprintf(buf, "Can't open python script \"%s\"", script); 1956 perror(buf); 1957 err = -1; 1958 goto error; 1959 } 1960 1961 err = PyRun_SimpleFile(fp, script); 1962 if (err) { 1963 fprintf(stderr, "Error running python script %s\n", script); 1964 goto error; 1965 } 1966 1967 err = run_start_sub(); 1968 if (err) { 1969 fprintf(stderr, "Error starting python script %s\n", script); 1970 goto error; 1971 } 1972 1973 set_table_handlers(tables); 1974 1975 if (tables->db_export_mode) { 1976 err = db_export__branch_types(&tables->dbe); 1977 if (err) 1978 goto error; 1979 } 1980 1981 _free_command_line(command_line, argc + 1); 1982 1983 return err; 1984 error: 1985 Py_Finalize(); 1986 _free_command_line(command_line, argc + 1); 1987 1988 return err; 1989 } 1990 1991 static int python_flush_script(void) 1992 { 1993 return 0; 1994 } 1995 1996 /* 1997 * Stop trace script 1998 */ 1999 static int python_stop_script(void) 2000 { 2001 struct tables *tables = &tables_global; 2002 2003 try_call_object("trace_end", NULL); 2004 2005 db_export__exit(&tables->dbe); 2006 2007 Py_XDECREF(main_dict); 2008 Py_XDECREF(main_module); 2009 Py_Finalize(); 2010 2011 return 0; 2012 } 2013 2014 #ifdef HAVE_LIBTRACEEVENT 2015 static int python_generate_script(struct tep_handle *pevent, const char *outfile) 2016 { 2017 int i, not_first, count, nr_events; 2018 struct tep_event **all_events; 2019 struct tep_event *event = NULL; 2020 struct tep_format_field *f; 2021 char fname[PATH_MAX]; 2022 FILE *ofp; 2023 2024 sprintf(fname, "%s.py", outfile); 2025 ofp = fopen(fname, "w"); 2026 if (ofp == NULL) { 2027 fprintf(stderr, "couldn't open %s\n", fname); 2028 return -1; 2029 } 2030 fprintf(ofp, "# perf script event handlers, " 2031 "generated by perf script -g python\n"); 2032 2033 fprintf(ofp, "# Licensed under the terms of the GNU GPL" 2034 " License version 2\n\n"); 2035 2036 fprintf(ofp, "# The common_* event handler fields are the most useful " 2037 "fields common to\n"); 2038 2039 fprintf(ofp, "# all events. They don't necessarily correspond to " 2040 "the 'common_*' fields\n"); 2041 2042 fprintf(ofp, "# in the format files. Those fields not available as " 2043 "handler params can\n"); 2044 2045 fprintf(ofp, "# be retrieved using Python functions of the form " 2046 "common_*(context).\n"); 2047 2048 fprintf(ofp, "# See the perf-script-python Documentation for the list " 2049 "of available functions.\n\n"); 2050 2051 fprintf(ofp, "from __future__ import print_function\n\n"); 2052 fprintf(ofp, "import os\n"); 2053 fprintf(ofp, "import sys\n\n"); 2054 2055 fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n"); 2056 fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n"); 2057 fprintf(ofp, "\nfrom perf_trace_context import *\n"); 2058 fprintf(ofp, "from Core import *\n\n\n"); 2059 2060 fprintf(ofp, "def trace_begin():\n"); 2061 fprintf(ofp, "\tprint(\"in trace_begin\")\n\n"); 2062 2063 fprintf(ofp, "def trace_end():\n"); 2064 fprintf(ofp, "\tprint(\"in trace_end\")\n\n"); 2065 2066 nr_events = tep_get_events_count(pevent); 2067 all_events = tep_list_events(pevent, TEP_EVENT_SORT_ID); 2068 2069 for (i = 0; all_events && i < nr_events; i++) { 2070 event = all_events[i]; 2071 fprintf(ofp, "def %s__%s(", event->system, event->name); 2072 fprintf(ofp, "event_name, "); 2073 fprintf(ofp, "context, "); 2074 fprintf(ofp, "common_cpu,\n"); 2075 fprintf(ofp, "\tcommon_secs, "); 2076 fprintf(ofp, "common_nsecs, "); 2077 fprintf(ofp, "common_pid, "); 2078 fprintf(ofp, "common_comm,\n\t"); 2079 fprintf(ofp, "common_callchain, "); 2080 2081 not_first = 0; 2082 count = 0; 2083 2084 for (f = event->format.fields; f; f = f->next) { 2085 if (not_first++) 2086 fprintf(ofp, ", "); 2087 if (++count % 5 == 0) 2088 fprintf(ofp, "\n\t"); 2089 2090 fprintf(ofp, "%s", f->name); 2091 } 2092 if (not_first++) 2093 fprintf(ofp, ", "); 2094 if (++count % 5 == 0) 2095 fprintf(ofp, "\n\t\t"); 2096 fprintf(ofp, "perf_sample_dict"); 2097 2098 fprintf(ofp, "):\n"); 2099 2100 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, " 2101 "common_secs, common_nsecs,\n\t\t\t" 2102 "common_pid, common_comm)\n\n"); 2103 2104 fprintf(ofp, "\t\tprint(\""); 2105 2106 not_first = 0; 2107 count = 0; 2108 2109 for (f = event->format.fields; f; f = f->next) { 2110 if (not_first++) 2111 fprintf(ofp, ", "); 2112 if (count && count % 3 == 0) { 2113 fprintf(ofp, "\" \\\n\t\t\""); 2114 } 2115 count++; 2116 2117 fprintf(ofp, "%s=", f->name); 2118 if (f->flags & TEP_FIELD_IS_STRING || 2119 f->flags & TEP_FIELD_IS_FLAG || 2120 f->flags & TEP_FIELD_IS_ARRAY || 2121 f->flags & TEP_FIELD_IS_SYMBOLIC) 2122 fprintf(ofp, "%%s"); 2123 else if (f->flags & TEP_FIELD_IS_SIGNED) 2124 fprintf(ofp, "%%d"); 2125 else 2126 fprintf(ofp, "%%u"); 2127 } 2128 2129 fprintf(ofp, "\" %% \\\n\t\t("); 2130 2131 not_first = 0; 2132 count = 0; 2133 2134 for (f = event->format.fields; f; f = f->next) { 2135 if (not_first++) 2136 fprintf(ofp, ", "); 2137 2138 if (++count % 5 == 0) 2139 fprintf(ofp, "\n\t\t"); 2140 2141 if (f->flags & TEP_FIELD_IS_FLAG) { 2142 if ((count - 1) % 5 != 0) { 2143 fprintf(ofp, "\n\t\t"); 2144 count = 4; 2145 } 2146 fprintf(ofp, "flag_str(\""); 2147 fprintf(ofp, "%s__%s\", ", event->system, 2148 event->name); 2149 fprintf(ofp, "\"%s\", %s)", f->name, 2150 f->name); 2151 } else if (f->flags & TEP_FIELD_IS_SYMBOLIC) { 2152 if ((count - 1) % 5 != 0) { 2153 fprintf(ofp, "\n\t\t"); 2154 count = 4; 2155 } 2156 fprintf(ofp, "symbol_str(\""); 2157 fprintf(ofp, "%s__%s\", ", event->system, 2158 event->name); 2159 fprintf(ofp, "\"%s\", %s)", f->name, 2160 f->name); 2161 } else 2162 fprintf(ofp, "%s", f->name); 2163 } 2164 2165 fprintf(ofp, "))\n\n"); 2166 2167 fprintf(ofp, "\t\tprint('Sample: {'+" 2168 "get_dict_as_string(perf_sample_dict['sample'], ', ')+'}')\n\n"); 2169 2170 fprintf(ofp, "\t\tfor node in common_callchain:"); 2171 fprintf(ofp, "\n\t\t\tif 'sym' in node:"); 2172 fprintf(ofp, "\n\t\t\t\tprint(\"\t[%%x] %%s%%s%%s%%s\" %% ("); 2173 fprintf(ofp, "\n\t\t\t\t\tnode['ip'], node['sym']['name'],"); 2174 fprintf(ofp, "\n\t\t\t\t\t\"+0x{:x}\".format(node['sym_off']) if 'sym_off' in node else \"\","); 2175 fprintf(ofp, "\n\t\t\t\t\t\" ({})\".format(node['dso']) if 'dso' in node else \"\","); 2176 fprintf(ofp, "\n\t\t\t\t\t\" \" + node['sym_srcline'] if 'sym_srcline' in node else \"\"))"); 2177 fprintf(ofp, "\n\t\t\telse:"); 2178 fprintf(ofp, "\n\t\t\t\tprint(\"\t[%%x]\" %% (node['ip']))\n\n"); 2179 fprintf(ofp, "\t\tprint()\n\n"); 2180 2181 } 2182 2183 fprintf(ofp, "def trace_unhandled(event_name, context, " 2184 "event_fields_dict, perf_sample_dict):\n"); 2185 2186 fprintf(ofp, "\t\tprint(get_dict_as_string(event_fields_dict))\n"); 2187 fprintf(ofp, "\t\tprint('Sample: {'+" 2188 "get_dict_as_string(perf_sample_dict['sample'], ', ')+'}')\n\n"); 2189 2190 fprintf(ofp, "def print_header(" 2191 "event_name, cpu, secs, nsecs, pid, comm):\n" 2192 "\tprint(\"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t" 2193 "(event_name, cpu, secs, nsecs, pid, comm), end=\"\")\n\n"); 2194 2195 fprintf(ofp, "def get_dict_as_string(a_dict, delimiter=' '):\n" 2196 "\treturn delimiter.join" 2197 "(['%%s=%%s'%%(k,str(v))for k,v in sorted(a_dict.items())])\n"); 2198 2199 fclose(ofp); 2200 2201 fprintf(stderr, "generated Python script: %s\n", fname); 2202 2203 return 0; 2204 } 2205 #else 2206 static int python_generate_script(struct tep_handle *pevent __maybe_unused, 2207 const char *outfile __maybe_unused) 2208 { 2209 fprintf(stderr, "Generating Python perf-script is not supported." 2210 " Install libtraceevent and rebuild perf to enable it.\n" 2211 "For example:\n # apt install libtraceevent-dev (ubuntu)" 2212 "\n # yum install libtraceevent-devel (Fedora)" 2213 "\n etc.\n"); 2214 return -1; 2215 } 2216 #endif 2217 2218 struct scripting_ops python_scripting_ops = { 2219 .name = "Python", 2220 .dirname = "python", 2221 .start_script = python_start_script, 2222 .flush_script = python_flush_script, 2223 .stop_script = python_stop_script, 2224 .process_event = python_process_event, 2225 .process_switch = python_process_switch, 2226 .process_auxtrace_error = python_process_auxtrace_error, 2227 .process_stat = python_process_stat, 2228 .process_stat_interval = python_process_stat_interval, 2229 .process_throttle = python_process_throttle, 2230 .generate_script = python_generate_script, 2231 }; 2232