Skip to content

WIP: gh-91371: Add PyFrameStack C API #119596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

WIP: gh-91371: Add PyFrameStack C API #119596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Include/cpython/pystate.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,3 +266,10 @@ PyAPI_FUNC(_PyFrameEvalFunction) _PyInterpreterState_GetEvalFrameFunc(
PyAPI_FUNC(void) _PyInterpreterState_SetEvalFrameFunc(
PyInterpreterState *interp,
_PyFrameEvalFunction eval_frame);

// --- Frame Stack API ------------------------------------------------------

typedef struct PyFrameStack PyFrameStack;
PyAPI_FUNC(PyFrameStack*) PyFrameStack_Init(void);
PyAPI_FUNC(void) PyFrameStack_Swap(PyFrameStack *fs);
PyAPI_FUNC(void) PyFrameStack_Free(PyFrameStack *fs);
83 changes: 74 additions & 9 deletions Modules/_testinternalcapi.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ _get_current_module(void)

typedef struct {
PyObject *record_list;
PyTypeObject *pyframestack_type;
} module_state;

static inline module_state *
Expand All @@ -78,13 +79,15 @@ static int
traverse_module_state(module_state *state, visitproc visit, void *arg)
{
Py_VISIT(state->record_list);
Py_VISIT(state->pyframestack_type);
return 0;
}

static int
clear_module_state(module_state *state)
{
Py_CLEAR(state->record_list);
Py_CLEAR(state->pyframestack_type);
return 0;
}

Expand Down Expand Up @@ -2024,6 +2027,61 @@ gh_119213_getargs_impl(PyObject *module, PyObject *spam)
return Py_NewRef(spam);
}

typedef struct {
PyObject_HEAD
PyFrameStack *fs;
} PyFrameStackObject;

static void
pyframestack_dealloc(PyObject *ob)
{
PyFrameStackObject *self = (PyFrameStackObject *)ob;
PyTypeObject *tp = Py_TYPE(self);
PyFrameStack_Free(self->fs);
tp->tp_free(self);
Py_DECREF(tp);
}

static PyObject*
pyframestack_swap(PyObject *module, PyObject *Py_UNUSED(args))
{
Py_RETURN_NONE;
}

static PyMethodDef PyFrameStack_methods[] = {
{"swap", pyframestack_swap, METH_NOARGS},
{NULL, NULL}
};
static PyType_Slot PyFrameStack_slots[] = {
{Py_tp_dealloc, pyframestack_dealloc},
{Py_tp_methods, PyFrameStack_methods},
{0, NULL},
};

static PyType_Spec PyFrameStackType_Spec = {
.name = "_testinternalcapi.FrameStack",
.basicsize = sizeof(PyFrameStackObject),
.flags = Py_TPFLAGS_DEFAULT,
.slots = PyFrameStack_slots,
};

static PyObject*
pyframestack(PyObject *module, PyObject *Py_UNUSED(args))
{
module_state *state = get_module_state(module);
PyTypeObject *type = state->pyframestack_type;
PyFrameStackObject *self = (PyFrameStackObject *) type->tp_alloc(type, 0);
if (self == NULL) {
return NULL;
}

self->fs = PyFrameStack_Init();
if (self->fs == NULL) {
Py_DECREF(self);
}
return (PyObject *) self;
}


static PyMethodDef module_functions[] = {
{"get_configs", get_configs, METH_NOARGS},
Expand Down Expand Up @@ -2116,6 +2174,7 @@ static PyMethodDef module_functions[] = {
{"uop_symbols_test", _Py_uop_symbols_test, METH_NOARGS},
#endif
GH_119213_GETARGS_METHODDEF
{"pyframestack", pyframestack, METH_NOARGS},
{NULL, NULL} /* sentinel */
};

Expand All @@ -2126,16 +2185,16 @@ static int
module_exec(PyObject *module)
{
if (_PyTestInternalCapi_Init_Lock(module) < 0) {
return 1;
return -1;
}
if (_PyTestInternalCapi_Init_PyTime(module) < 0) {
return 1;
return -1;
}
if (_PyTestInternalCapi_Init_Set(module) < 0) {
return 1;
return -1;
}
if (_PyTestInternalCapi_Init_CriticalSection(module) < 0) {
return 1;
return -1;
}

Py_ssize_t sizeof_gc_head = 0;
Expand All @@ -2145,27 +2204,33 @@ module_exec(PyObject *module)

if (PyModule_Add(module, "SIZEOF_PYGC_HEAD",
PyLong_FromSsize_t(sizeof_gc_head)) < 0) {
return 1;
return -1;
}

if (PyModule_Add(module, "SIZEOF_MANAGED_PRE_HEADER",
PyLong_FromSsize_t(2 * sizeof(PyObject*))) < 0) {
return 1;
return -1;
}

if (PyModule_Add(module, "SIZEOF_PYOBJECT",
PyLong_FromSsize_t(sizeof(PyObject))) < 0) {
return 1;
return -1;
}

if (PyModule_Add(module, "SIZEOF_TIME_T",
PyLong_FromSsize_t(sizeof(time_t))) < 0) {
return 1;
return -1;
}

if (PyModule_Add(module, "TIER2_THRESHOLD",
PyLong_FromLong(JUMP_BACKWARD_INITIAL_VALUE)) < 0) {
return 1;
return -1;
}

module_state *state = get_module_state(module);
state->pyframestack_type = (PyTypeObject*)PyType_FromSpec(&PyFrameStackType_Spec);
if (state->pyframestack_type == NULL) {
return -1;
}

return 0;
Expand Down
69 changes: 69 additions & 0 deletions Python/pystate.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3089,3 +3089,72 @@ _PyThreadState_ClearMimallocHeaps(PyThreadState *tstate)
}
#endif
}


// --- Frame Stack API ------------------------------------------------------

struct PyFrameStack {
_PyInterpreterFrame *current_frame;
_PyStackChunk *datastack_chunk;
PyObject **datastack_top;
PyObject **datastack_limit;
int py_recursion_depth;
int c_recursion_depth;
PyFrameObject *top_frame; // strong reference
PyObject *delete_later; // strong reference
PyObject *context; // strong reference
} PythonState;

PyFrameStack *PyFrameStack_Init(void)
{
PyFrameStack *fs = PyMem_Malloc(sizeof(PyFrameStack));
if (fs == NULL) {
return NULL;
}

PyThreadState* tstate = _PyThreadState_GET();
//fs->cframe = tstate->cframe;
//fs->current_frame = tstate->cframe->current_frame;
fs->datastack_chunk = tstate->datastack_chunk;
fs->datastack_top = tstate->datastack_top;
fs->datastack_limit = tstate->datastack_limit;
tstate->datastack_chunk = NULL;
tstate->datastack_top = NULL;
tstate->datastack_limit = NULL;

fs->py_recursion_depth = (tstate->py_recursion_limit - tstate->py_recursion_remaining);
fs->c_recursion_depth = (Py_C_RECURSION_LIMIT - tstate->c_recursion_remaining);
fs->top_frame = PyThreadState_GetFrame((PyThreadState*)tstate);

fs->delete_later = Py_XNewRef(tstate->delete_later);

fs->context = Py_XNewRef(tstate->context);
return fs;
}


void PyFrameStack_Swap(PyFrameStack *fs)
{
PyThreadState* tstate = _PyThreadState_GET();
//tstate->cframe = fs->cframe;
//tstate->cframe->current_frame = fs->current_frame;
tstate->datastack_chunk = fs->datastack_chunk;
tstate->datastack_top = fs->datastack_top;
tstate->datastack_limit = fs->datastack_limit;

tstate->py_recursion_remaining = tstate->py_recursion_limit - fs->py_recursion_depth;
tstate->c_recursion_remaining = Py_C_RECURSION_LIMIT - fs->c_recursion_depth;

tstate->delete_later = fs->delete_later;

tstate->context = fs->context;
}


void PyFrameStack_Free(PyFrameStack *fs)
{
Py_XDECREF(fs->top_frame);
Py_XDECREF(fs->delete_later);
Py_XDECREF(fs->context);
PyMem_Free(fs);
}
Loading