1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
|
#include <Python.h>
#include <structmember.h>
#include <frameobject.h>
#include "pyi_floatclock.h"
#include "pyi_timing_thread.h"
#include <float.h>
////////////////////////////
// Version/Platform shims //
////////////////////////////
/* Python 2 shim */
#if PY_MAJOR_VERSION < 3
#define PyUnicode_InternFromString PyString_InternFromString
#endif
#if PY_VERSION_HEX >= 0x030b0000 // Python 3.11.0
#define PyFrame_GETBACK(f) PyFrame_GetBack(f)
#else
static PyFrameObject *
_PyFrame_GetBack(PyFrameObject *frame) {
Py_XINCREF(frame->f_back);
return frame->f_back;
}
#define PyFrame_GETBACK(f) _PyFrame_GetBack(f)
#endif
///////////////////
// ProfilerState //
///////////////////
typedef struct profiler_state {
PyObject_HEAD
PyObject *target;
double interval;
double last_invocation;
PyObject *context_var;
PyObject *last_context_var_value;
PyObject *await_stack_list;
PyObject *timer_func;
int timer_thread_subscription_id;
PYIFloatClockType floatclock_type;
} ProfilerState;
static void ProfilerState_SetTarget(ProfilerState *self, PyObject *target) {
PyObject *tmp = self->target;
Py_XINCREF(target);
self->target = target;
Py_XDECREF(tmp);
}
/**
* Updates last_context_var_value.
*
* Returns true on success, sets an exception and returns false on failure.
* */
static int ProfilerState_UpdateContextVar(ProfilerState *self) {
PyObject *old = self->last_context_var_value;
PyObject *new = NULL;
int status = PyContextVar_Get(self->context_var, NULL, &new);
if (status == -1) {
PyErr_SetString(PyExc_Exception, "failed to get value of the context var");
return 0;
}
if (old == new) {
// The object is the same, so we don't need the new reference.
Py_DECREF(new);
return 1;
}
self->last_context_var_value = new;
Py_XDECREF(old);
return 1;
}
/**
* Returns the current time for this profiler. On error, returns -1.0.
*/
static double ProfilerState_GetTime(ProfilerState *self) {
if (self->timer_func != NULL) {
// when a self->timer_func is set, call that.
#if PY_VERSION_HEX >= 0x03090000
PyObject *result = PyObject_CallNoArgs(self->timer_func);
#else
PyObject *result = PyObject_CallObject(self->timer_func, NULL);
#endif
if (result == NULL) {
return -1.0;
}
if (!PyFloat_Check(result)) {
PyErr_SetString(PyExc_RuntimeError, "custom time function must return a float");
return -1.0;
}
double resultDouble = PyFloat_AsDouble(result);
Py_DECREF(result);
return resultDouble;
} else if (self->timer_thread_subscription_id >= 0) {
// when a self->timer_thread_subscription_id is set, use the timing thread.
return pyi_timing_thread_get_time();
} else {
// otherwise as normal, call the synchronous C timer function.
return pyi_floatclock(self->floatclock_type);
}
}
static void ProfilerState_Dealloc(ProfilerState *self) {
ProfilerState_SetTarget(self, NULL);
Py_XDECREF(self->context_var);
Py_XDECREF(self->last_context_var_value);
Py_XDECREF(self->await_stack_list);
Py_XDECREF(self->timer_func);
if (self->timer_thread_subscription_id >= 0) {
pyi_timing_thread_unsubscribe(self->timer_thread_subscription_id);
}
Py_TYPE(self)->tp_free(self);
}
static PyTypeObject ProfilerState_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
"pyinstrument.stat_profile.ProfilerState", /* tp_name */
sizeof(ProfilerState), /* tp_basicsize */
0, /* tp_itemsize */
(destructor)ProfilerState_Dealloc, /* tp_dealloc */
0, /* tp_print */
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_reserved */
0, /* tp_repr */
0, /* tp_as_number */
0, /* tp_as_sequence */
0, /* tp_as_mapping */
0, /* tp_hash */
0, /* tp_call */
0, /* tp_str */
0, /* tp_getattro */
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
0, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
0, /* tp_methods */
0, /* tp_members */
0, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
0, /* tp_init */
PyType_GenericAlloc, /* tp_alloc */
PyType_GenericNew, /* tp_new */
PyObject_Del, /* tp_free */
};
static ProfilerState *ProfilerState_New(void) {
ProfilerState *op = PyObject_New(ProfilerState, &ProfilerState_Type);
op->target = NULL;
op->interval = 0.0;
op->last_invocation = 0.0;
op->context_var = NULL;
op->last_context_var_value = NULL;
op->await_stack_list = PyList_New(0);
op->timer_func = NULL;
op->timer_thread_subscription_id = -1;
op->floatclock_type = PYI_FLOATCLOCK_DEFAULT;
return op;
}
////////////////////////
// Internal functions //
////////////////////////
static PyObject *whatstrings[8] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL};
static PyObject *SELF_STRING = NULL;
static PyObject *CLS_STRING = NULL;
static PyObject *TRACEBACKHIDE_STRING = NULL;
#define TIMER_TYPE_WALLTIME 0
#define TIMER_TYPE_WALLTIME_THREAD 1
#define TIMER_TYPE_TIMER_FUNC 2
#define TIMER_TYPE_WALLTIME_COARSE 3
#define WHAT_CALL 0
#define WHAT_EXCEPTION 1
#define WHAT_LINE 2
#define WHAT_RETURN 3
#define WHAT_C_CALL 4
#define WHAT_C_EXCEPTION 5
#define WHAT_C_RETURN 6
#define WHAT_CONTEXT_CHANGED 7
static int
stat_profile_init(void)
{
static char *whatnames[8] = {"call", "exception", "line", "return",
"c_call", "c_exception", "c_return",
"context_changed"};
PyObject *name;
int i;
for (i = 0; i < 8; ++i) {
if (whatstrings[i] == NULL) {
name = PyUnicode_InternFromString(whatnames[i]);
if (name == NULL)
return -1;
whatstrings[i] = name;
}
}
SELF_STRING = PyUnicode_InternFromString("self");
if (SELF_STRING == NULL) return -1;
CLS_STRING = PyUnicode_InternFromString("cls");
if (CLS_STRING == NULL) return -1;
TRACEBACKHIDE_STRING = PyUnicode_InternFromString("__tracebackhide__");
if (TRACEBACKHIDE_STRING == NULL) return -1;
return 0;
}
static PyObject *
call_target(ProfilerState *pState, PyFrameObject *frame, int what, PyObject *arg)
{
// note: we no longer call PyFrame_FastToLocals and PyFrame_LocalsToFast
// here, as it's only needed for python-level modification of locals,
// which a profiler doesn't need to do.
#if PY_VERSION_HEX >= 0x03090000
// vectorcall implementation could be faster, is available in Python 3.9
PyObject *callargs[4] = { NULL, (PyObject *) frame, whatstrings[what], arg == NULL ? Py_None : arg };
PyObject *result = PyObject_Vectorcall(pState->target, callargs + 1, 3 | PY_VECTORCALL_ARGUMENTS_OFFSET, NULL);
#else
PyObject *result = PyObject_CallFunctionObjArgs(pState->target, (PyObject *) frame, whatstrings[what], arg == NULL ? Py_None : arg, NULL);
#endif
if (result == NULL) {
PyTraceBack_Here(frame);
}
return result;
}
/**
* Returns a new reference to a PyCodeObject for the given frame.
*/
static PyCodeObject *
code_from_frame(PyFrameObject* frame)
{
#if PY_VERSION_HEX >= 0x03090000
return PyFrame_GetCode(frame);
#else
PyCodeObject *result = frame->f_code;
Py_XINCREF(result);
return result;
#endif
}
/**
* Returns a new reference to a PyTupleObject containing the names of the
* local variables.
*/
static PyObject *
local_names_from_code(PyCodeObject *code)
{
#if PY_VERSION_HEX >= 0x030b0000
return PyCode_GetVarnames(code);
#else
PyObject *result = code->co_varnames;
Py_XINCREF(result);
return result;
#endif
}
#if PY_VERSION_HEX >= 0x030b0000 // Python 3.11.0
/**
* Returns a C-string containing the name of the class in the frame. The
* memory belongs to the type object, so it should not be freed.
*/
static const char *
_get_class_name_of_frame(PyFrameObject *frame, PyCodeObject *code) {
PyObject *localsNames = PyCode_GetVarnames(code);
if (localsNames == NULL) {
return NULL;
}
PyObject *firstArgName = PyTuple_GET_ITEM(localsNames, 0);
if (firstArgName == NULL) {
Py_DECREF(localsNames);
return NULL;
}
int has_self = PyUnicode_Compare(firstArgName, SELF_STRING) == 0;
int has_cls = PyUnicode_Compare(firstArgName, CLS_STRING) == 0;
Py_DECREF(localsNames);
if (!has_self && !has_cls) {
// PyFrame_GetLocals is expensive and changes the frame, so we don't
// want to call it unless we have to.
return NULL;
}
const char *result = NULL;
PyObject *locals = PyFrame_GetLocals(frame);
if (!PyMapping_Check(locals)) {
Py_DECREF(locals);
return NULL;
}
// we still have to check the locals has the key, because it could have
// been "del'd"
if (has_self && PyMapping_HasKey(locals, SELF_STRING)) {
PyObject *self = PyObject_GetItem(locals, SELF_STRING);
if (!self) {
PyErr_Clear();
Py_DECREF(locals);
return NULL;
}
result = _PyType_Name(self->ob_type);
Py_DECREF(self);
}
else if (has_cls && PyMapping_HasKey(locals, CLS_STRING)) {
PyObject *cls = PyObject_GetItem(locals, CLS_STRING);
if (!cls) {
PyErr_Clear();
Py_DECREF(locals);
return NULL;
}
if (PyType_Check(cls)) {
PyTypeObject *type = (PyTypeObject *)cls;
result = _PyType_Name(type);
}
Py_DECREF(cls);
}
Py_DECREF(locals);
return result;
}
#else
static PyObject *
_get_first_arg_from_cell_variables(PyFrameObject *frame, PyCodeObject *code) {
if (!code->co_cell2arg) {
// we don't have args in cell variables
return NULL;
}
Py_ssize_t ncells = PyTuple_GET_SIZE(code->co_cellvars);
for (int i = 0; i < ncells; i++) {
if (code->co_cell2arg[i] == CO_CELL_NOT_AN_ARG) {
// this cell is not an argument
continue;
}
// get the cell value
// the cells are after the local variables
PyObject *cell = frame->f_localsplus[code->co_nlocals + i];
// return the value inside the cell
if (!PyCell_Check(cell)) {
continue;
}
return PyCell_GET(cell);
}
// cell variable not found
return NULL;
}
static const char *
_get_class_name_of_frame(PyFrameObject *frame, PyCodeObject *code) {
// This code looks only at the first 'fast' frame local.
//
// A generalisable way to get a local variable would be to look at every
// local for one with the name 'self' or 'cls'. And such a general method
// should also prefer f_locals, if it exists.
//
// But, function args are always be the first locals, self/cls is always
// be the first arg, and f_localsplus is always set, even if f_locals
// exists. So we only look at the first f_localsplus entry.
if (code->co_argcount < 1) {
return NULL;
}
if (!PyTuple_Check(code->co_varnames)) {
// co_varnames must be a tuple
return NULL;
}
if (code->co_nlocals < 1 || PyTuple_Size(code->co_varnames) < 1) {
return NULL;
}
PyObject *first_var_name = PyTuple_GetItem(code->co_varnames, 0);
int first_var_is_self = (PyUnicode_Compare(first_var_name, SELF_STRING) == 0);
int first_var_is_cls = (PyUnicode_Compare(first_var_name, CLS_STRING) == 0);
if (!(first_var_is_self || first_var_is_cls)) {
return NULL;
}
PyObject *first_var = frame->f_localsplus[0];
if (first_var == NULL) {
// Sometimes arguments are in cells, if they're accessible from other
// scopes, for example an inner function that captures self. In that
// case, the local var is NULL, and it's stored as a cell instead.
first_var = _get_first_arg_from_cell_variables(frame, code);
}
if (first_var == NULL) {
// not sure why this would happen, but as a failsafe.
return NULL;
}
if (first_var_is_self) {
PyTypeObject *type = first_var->ob_type;
return _PyType_Name(type);
} else if (first_var_is_cls) {
if (!PyType_Check(first_var)) {
return NULL;
}
PyTypeObject *type = (PyTypeObject *)first_var;
return _PyType_Name(type);
} else {
Py_FatalError("unreachable code");
}
return NULL;
}
#endif
/**
* returns `1` if any variable named `"__trackbackhide__"` is defined in frame
* locals, returns `0` otherwise
*/
static const int
_get_tracebackhide(PyFrameObject *frame, PyCodeObject *code) {
PyObject *locals_names = local_names_from_code(code);
if (locals_names == NULL) {
return 0;
}
if (!PySequence_Check(locals_names)) {
// locals_names must be a sequence
Py_DECREF(locals_names);
return 0;
}
int tracebackhide = PySequence_Contains(locals_names, TRACEBACKHIDE_STRING);
Py_DECREF(locals_names);
if (tracebackhide < 0) {
// in this case the PySequence_Contains function encountered an error
Py_FatalError("could not determine names of frame local variables");
} else {
return tracebackhide;
}
}
/**
* Returns a new reference to pyinstrument's frame info string for the given frame.
*/
static PyObject *
_get_frame_info(PyFrameObject *frame) {
PyCodeObject *code = code_from_frame(frame);
PyObject *class_name_attribute;
const char *class_name = _get_class_name_of_frame(frame, code);
if (class_name == NULL) {
class_name_attribute = PyUnicode_New(0, 127); // empty string
} else {
class_name_attribute = PyUnicode_FromFormat(
"%c%c%s",
1, // 0x01 char denotes 'attribute'
'c', // 'c' char denotes 'class name'
class_name
);
}
PyObject *line_number_attribute;
int line_number = PyFrame_GetLineNumber(frame);
if (line_number < 1) {
line_number_attribute = PyUnicode_New(0, 127);
} else {
line_number_attribute = PyUnicode_FromFormat(
"%c%c%d",
1,
'l', // 'l' char denotes 'line number'
line_number
);
}
PyObject *frame_hidden_attribute;
int tracebackhide = _get_tracebackhide(frame, code);
if (tracebackhide <= 0) {
frame_hidden_attribute = PyUnicode_New(0, 127);
} else {
frame_hidden_attribute = PyUnicode_FromFormat(
"%c%c%c",
1,
'h', // 'h' char denotes 'frame hidden'
'1' // '1' char denotes 'true'
);
}
PyObject *result = PyUnicode_FromFormat(
"%U%c%U%c%i%U%U%U",
code->co_name,
0, // NULL char
code->co_filename,
0, // NULL char
code->co_firstlineno,
class_name_attribute,
line_number_attribute,
frame_hidden_attribute
);
Py_DECREF(code);
Py_DECREF(class_name_attribute);
Py_DECREF(line_number_attribute);
Py_DECREF(frame_hidden_attribute);
return result;
}
static int
_parse_timer_type(PyObject *timer_type, int defaultValue) {
if (timer_type == NULL || timer_type == Py_None) {
return defaultValue;
}
if (!PyUnicode_Check(timer_type)) {
PyErr_SetString(PyExc_TypeError, "timer_type must be a string");
return -1;
}
if (PyUnicode_CompareWithASCIIString(timer_type, "walltime") == 0) {
return TIMER_TYPE_WALLTIME;
} else if (PyUnicode_CompareWithASCIIString(timer_type, "walltime_thread") == 0) {
return TIMER_TYPE_WALLTIME_THREAD;
} else if (PyUnicode_CompareWithASCIIString(timer_type, "timer_func") == 0) {
return TIMER_TYPE_TIMER_FUNC;
} else if (PyUnicode_CompareWithASCIIString(timer_type, "walltime_coarse") == 0) {
return TIMER_TYPE_WALLTIME_COARSE;
} else {
PyErr_SetString(PyExc_TypeError, "timer_type must be 'walltime', 'walltime_thread', 'walltime_coarse', or 'timer_func'");
return -1;
}
}
//////////////////////
// Public functions //
//////////////////////
/**
* The profile function. Passed to PyEval_SetProfile, and called with
* function frames as the program executes by Python
*/
static int
profile(PyObject *op, PyFrameObject *frame, int what, PyObject *arg)
{
ProfilerState *pState = (ProfilerState *)op;
PyObject *result;
double now = ProfilerState_GetTime(pState);
if (now == -1.0) {
PyEval_SetProfile(NULL, NULL);
return -1;
}
// check for context var change, send context_changed event if seen
if (pState->context_var) {
PyObject *old_context_var_value = pState->last_context_var_value;
Py_XINCREF(old_context_var_value);
if (!ProfilerState_UpdateContextVar(pState)) {
PyEval_SetProfile(NULL, NULL);
return -1;
}
if (old_context_var_value != pState->last_context_var_value) {
PyFrameObject *context_change_frame; // borrowed reference
PyFrameObject *parent_frame = PyFrame_GETBACK(frame); // strong reference, maybe null
if (what == WHAT_CALL && parent_frame) {
context_change_frame = parent_frame;
} else {
context_change_frame = frame;
}
PyObject *context_change_arg = PyTuple_Pack(
3,
pState->last_context_var_value,
old_context_var_value,
pState->await_stack_list
);
result = call_target(pState, context_change_frame, WHAT_CONTEXT_CHANGED, context_change_arg);
Py_DECREF(context_change_arg);
Py_XDECREF(parent_frame);
if (result == NULL) {
PyEval_SetProfile(NULL, NULL);
return -1;
}
Py_DECREF(result);
}
Py_XDECREF(old_context_var_value);
}
// if we're returning from a coroutine, add that to the await stack
PyCodeObject* code = code_from_frame(frame);
if ((what == WHAT_RETURN) && (code->co_flags & 0x80)) {
PyObject *frame_identifier = _get_frame_info(frame);
int status = PyList_Append(pState->await_stack_list, frame_identifier);
Py_DECREF(frame_identifier);
Py_DECREF(code);
if (status == -1) {
PyEval_SetProfile(NULL, NULL);
return -1;
}
} else {
Py_DECREF(code);
// clear the list
int status = PyList_SetSlice(
pState->await_stack_list,
0,
PyList_GET_SIZE(pState->await_stack_list),
NULL
);
if (status == -1) {
PyEval_SetProfile(NULL, NULL);
return -1;
}
}
// stat profile
if (now < pState->last_invocation + pState->interval) {
return 0;
}
pState->last_invocation = now;
result = call_target(pState, frame, what, arg);
if (result == NULL) {
PyEval_SetProfile(NULL, NULL);
return -1;
}
Py_DECREF(result);
return 0;
}
/**
* The 'setprofile' function. This is the public API that can be called
* from Python code.
*/
static PyObject *
setstatprofile(PyObject *m, PyObject *args, PyObject *kwds)
{
static char *kwlist[] = {"target", "interval", "context_var", "timer_type", "timer_func", NULL};
ProfilerState *pState = NULL;
double interval = 0.0;
PyObject *target = NULL;
PyObject *context_var = NULL;
PyObject *timer_type = NULL;
PyObject *timer_func = NULL;
if (! PyArg_ParseTupleAndKeywords(args, kwds, "O|dO!UO", kwlist, &target, &interval, &PyContextVar_Type, &context_var, &timer_type, &timer_func))
return NULL;
if (target == Py_None) {
target = NULL;
}
if (target) {
if (!PyCallable_Check(target)) {
PyErr_SetString(PyExc_TypeError, "target must be callable");
return NULL;
}
pState = ProfilerState_New();
if (pState == NULL) { // Check if allocation failed
return NULL;
}
ProfilerState_SetTarget(pState, target);
// default interval is 1 ms
pState->interval = (interval > 0) ? interval : 0.001;
int timer_type_int = _parse_timer_type(timer_type, TIMER_TYPE_WALLTIME);
if (timer_type_int == -1) {
goto error;
}
if (timer_func == Py_None) {
timer_func = NULL;
}
if (timer_type_int == TIMER_TYPE_TIMER_FUNC && timer_func == NULL) {
PyErr_SetString(PyExc_TypeError, "timer_func must be set if timer_type is 'timer_func'");
goto error;
}
if (timer_func && timer_type_int != TIMER_TYPE_TIMER_FUNC) {
PyErr_SetString(PyExc_TypeError, "timer_type must be 'timer_func' if timer_func is set");
goto error;
}
if (timer_func) {
Py_INCREF(timer_func);
pState->timer_func = timer_func;
} else if (timer_type_int == TIMER_TYPE_WALLTIME_THREAD) {
pState->timer_thread_subscription_id = pyi_timing_thread_subscribe(pState->interval);
if (pState->timer_thread_subscription_id < 0) {
PyErr_Format(PyExc_RuntimeError, "failed to subscribe to timing thread: error %d", pState->timer_thread_subscription_id);
goto error;
}
} else if (timer_type_int == TIMER_TYPE_WALLTIME_COARSE) {
pState->floatclock_type = PYI_FLOATCLOCK_MONOTONIC_COARSE;
} else {
pState->floatclock_type = PYI_FLOATCLOCK_DEFAULT;
}
// initialise the last invocation to avoid immediate callback
pState->last_invocation = ProfilerState_GetTime(pState);
if (context_var) {
Py_INCREF(context_var);
pState->context_var = context_var;
if (!ProfilerState_UpdateContextVar(pState)) {
goto error;
}
}
PyEval_SetProfile(profile, (PyObject *)pState);
Py_DECREF(pState); // We've given a reference to SetProfile, so we release ours.
} else {
PyEval_SetProfile(NULL, NULL);
}
Py_RETURN_NONE;
error:
Py_XDECREF(pState);
return NULL;
}
static PyObject *
get_frame_info(PyObject *m, PyObject *const *args, Py_ssize_t nargs)
{
if (nargs != 1) {
PyErr_SetString(PyExc_TypeError, "get_frame_info takes exactly 1 argument");
return NULL;
}
if (!PyFrame_Check(args[0])) {
PyErr_SetString(PyExc_TypeError, "get_frame_info should be called with a Frame object");
return NULL;
}
PyFrameObject *frame = (PyFrameObject *)args[0];
return _get_frame_info(frame);
}
static inline double
measure_timing_overhead_for_timer(PYIFloatClockType timer) {
int n = 1000;
int num_iterations = 0;
pyi_floatclock(timer); // warmup
double start = pyi_floatclock(timer);
double end = start;
double duration = 0;
for (int i = 0; i < n; i++) {
end = pyi_floatclock(timer);
duration = end - start;
num_iterations += 1;
if (duration > 0.0001) {
// dont run this for more than 100us
break;
}
}
return duration / num_iterations;
}
static PyObject *
measure_timing_overhead(PyObject *m, PyObject * Py_UNUSED(args))
{
double monotonic_coarse_resolution = pyi_monotonic_coarse_resolution();
int is_course_timer_available = monotonic_coarse_resolution != DBL_MAX;
PyObject *result = PyDict_New();
PyObject *value = PyFloat_FromDouble(measure_timing_overhead_for_timer(PYI_FLOATCLOCK_DEFAULT));
PyDict_SetItemString(result, "walltime", value);
Py_DECREF(value);
if (is_course_timer_available) {
value = PyFloat_FromDouble(measure_timing_overhead_for_timer(PYI_FLOATCLOCK_MONOTONIC_COARSE));
PyDict_SetItemString(result, "walltime_coarse", value);
Py_DECREF(value);
}
return result;
}
static PyObject *
walltime_coarse_resolution(PyObject *m, PyObject * Py_UNUSED(args))
{
double resolution = pyi_monotonic_coarse_resolution();
if (resolution == DBL_MAX) {
Py_RETURN_NONE;
}
return PyFloat_FromDouble(resolution);
}
///////////////////////////
// Module initialization //
///////////////////////////
static PyMethodDef module_methods[] = {
{"setstatprofile", (PyCFunction)setstatprofile, METH_VARARGS | METH_KEYWORDS,
"Sets the statistical profiler callback. The function in the same manner as setprofile, but "
"instead of being called every on every call and return, the function is called every "
"<interval> seconds with the current stack."},
{"get_frame_info", (PyCFunction)get_frame_info, METH_FASTCALL,
"Returns the frame identifier string for the given Frame object."},
{"measure_timing_overhead", (PyCFunction)measure_timing_overhead, METH_NOARGS,
"Returns a dict showing how much overhead the timing options have."},
{"walltime_coarse_resolution", (PyCFunction)walltime_coarse_resolution, METH_NOARGS,
"Returns the resolution of the monotonic coarse clock. Returns None if the clock is not available."},
{NULL} /* Sentinel */
};
PyMODINIT_FUNC PyInit_stat_profile(void)
{
PyType_Ready(&ProfilerState_Type);
static struct PyModuleDef moduledef = {
PyModuleDef_HEAD_INIT,
"stat_profile",
"Module that implements the backend to a statistical profiler",
-1,
module_methods
};
if (stat_profile_init() == -1)
return NULL;
return PyModule_Create(&moduledef);
}
|