Skip to content

Commit 65a12c5

Browse files
iritkatrieliritkatriel
authored
pythongh-120834: fix type of *_iframe field in _PyGenObject_HEAD declaration (python#120835)
1 parent c38e2f6 commit 65a12c5

12 files changed

+81
-79
lines changed

‎Include/cpython/genobject.h

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,7 @@ extern "C" {
99

1010
/* --- Generators --------------------------------------------------------- */
1111

12-
/* _PyGenObject_HEAD defines the initial segment of generator
13-
and coroutine objects. */
14-
#define _PyGenObject_HEAD(prefix) \
15-
PyObject_HEAD \
16-
/* List of weak reference. */ \
17-
PyObject *prefix##_weakreflist; \
18-
/* Name of the generator. */ \
19-
PyObject *prefix##_name; \
20-
/* Qualified name of the generator. */ \
21-
PyObject *prefix##_qualname; \
22-
_PyErr_StackItem prefix##_exc_state; \
23-
PyObject *prefix##_origin_or_finalizer; \
24-
char prefix##_hooks_inited; \
25-
char prefix##_closed; \
26-
char prefix##_running_async; \
27-
/* The frame */ \
28-
int8_t prefix##_frame_state; \
29-
PyObject *prefix##_iframe[1]; \
30-
31-
typedef struct {
32-
/* The gi_ prefix is intended to remind of generator-iterator. */
33-
_PyGenObject_HEAD(gi)
34-
} PyGenObject;
12+
typedef struct _PyGenObject PyGenObject;
3513

3614
PyAPI_DATA(PyTypeObject) PyGen_Type;
3715

@@ -46,9 +24,7 @@ PyAPI_FUNC(PyCodeObject *) PyGen_GetCode(PyGenObject *gen);
4624

4725
/* --- PyCoroObject ------------------------------------------------------- */
4826

49-
typedef struct {
50-
_PyGenObject_HEAD(cr)
51-
} PyCoroObject;
27+
typedef struct _PyCoroObject PyCoroObject;
5228

5329
PyAPI_DATA(PyTypeObject) PyCoro_Type;
5430

@@ -59,9 +35,7 @@ PyAPI_FUNC(PyObject *) PyCoro_New(PyFrameObject *,
5935

6036
/* --- Asynchronous Generators -------------------------------------------- */
6137

62-
typedef struct {
63-
_PyGenObject_HEAD(ag)
64-
} PyAsyncGenObject;
38+
typedef struct _PyAsyncGenObject PyAsyncGenObject;
6539

6640
PyAPI_DATA(PyTypeObject) PyAsyncGen_Type;
6741
PyAPI_DATA(PyTypeObject) _PyAsyncGenASend_Type;
@@ -73,7 +47,6 @@ PyAPI_FUNC(PyObject *) PyAsyncGen_New(PyFrameObject *,
7347

7448
#define PyAsyncGenASend_CheckExact(op) Py_IS_TYPE((op), &_PyAsyncGenASend_Type)
7549

76-
7750
#undef _PyGenObject_HEAD
7851

7952
#ifdef __cplusplus

‎Include/internal/pycore_frame.h

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -307,14 +307,6 @@ _PyFrame_PushTrampolineUnchecked(PyThreadState *tstate, PyCodeObject *code, int
307307
return frame;
308308
}
309309

310-
static inline
311-
PyGenObject *_PyFrame_GetGenerator(_PyInterpreterFrame *frame)
312-
{
313-
assert(frame->owner == FRAME_OWNED_BY_GENERATOR);
314-
size_t offset_in_gen = offsetof(PyGenObject, gi_iframe);
315-
return (PyGenObject *)(((char *)frame) - offset_in_gen);
316-
}
317-
318310
PyAPI_FUNC(_PyInterpreterFrame *)
319311
_PyEvalFramePushAndInit(PyThreadState *tstate, PyFunctionObject *func,
320312
PyObject *locals, PyObject* const* args,

‎Include/internal/pycore_genobject.h

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,49 @@ extern "C" {
88
# error "this header requires Py_BUILD_CORE define"
99
#endif
1010

11-
#include "pycore_freelist.h"
11+
#include "pycore_frame.h"
12+
13+
/* _PyGenObject_HEAD defines the initial segment of generator
14+
and coroutine objects. */
15+
#define _PyGenObject_HEAD(prefix) \
16+
PyObject_HEAD \
17+
/* List of weak reference. */ \
18+
PyObject *prefix##_weakreflist; \
19+
/* Name of the generator. */ \
20+
PyObject *prefix##_name; \
21+
/* Qualified name of the generator. */ \
22+
PyObject *prefix##_qualname; \
23+
_PyErr_StackItem prefix##_exc_state; \
24+
PyObject *prefix##_origin_or_finalizer; \
25+
char prefix##_hooks_inited; \
26+
char prefix##_closed; \
27+
char prefix##_running_async; \
28+
/* The frame */ \
29+
int8_t prefix##_frame_state; \
30+
struct _PyInterpreterFrame prefix##_iframe; \
31+
32+
struct _PyGenObject {
33+
/* The gi_ prefix is intended to remind of generator-iterator. */
34+
_PyGenObject_HEAD(gi)
35+
};
36+
37+
struct _PyCoroObject {
38+
_PyGenObject_HEAD(cr)
39+
};
40+
41+
struct _PyAsyncGenObject {
42+
_PyGenObject_HEAD(ag)
43+
};
44+
45+
#undef _PyGenObject_HEAD
46+
47+
static inline
48+
PyGenObject *_PyGen_GetGeneratorFromFrame(_PyInterpreterFrame *frame)
49+
{
50+
assert(frame->owner == FRAME_OWNED_BY_GENERATOR);
51+
size_t offset_in_gen = offsetof(PyGenObject, gi_iframe);
52+
return (PyGenObject *)(((char *)frame) - offset_in_gen);
53+
}
1254

1355
PyAPI_FUNC(PyObject *)_PyGen_yf(PyGenObject *);
1456
extern void _PyGen_Finalize(PyObject *self);

‎Include/internal/pycore_interp.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ extern "C" {
2323
#include "pycore_floatobject.h" // struct _Py_float_state
2424
#include "pycore_function.h" // FUNC_MAX_WATCHERS
2525
#include "pycore_gc.h" // struct _gc_runtime_state
26-
#include "pycore_genobject.h" // struct _Py_async_gen_state
26+
#include "pycore_genobject.h" // _PyGen_FetchStopIterationValue
2727
#include "pycore_global_objects.h"// struct _Py_interp_cached_objects
2828
#include "pycore_import.h" // struct _import_state
2929
#include "pycore_instruments.h" // _PY_MONITORING_EVENTS

‎Objects/frameobject.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1338,7 +1338,7 @@ static bool frame_is_suspended(PyFrameObject *frame)
13381338
{
13391339
assert(!_PyFrame_IsIncomplete(frame->f_frame));
13401340
if (frame->f_frame->owner == FRAME_OWNED_BY_GENERATOR) {
1341-
PyGenObject *gen = _PyFrame_GetGenerator(frame->f_frame);
1341+
PyGenObject *gen = _PyGen_GetGeneratorFromFrame(frame->f_frame);
13421342
return FRAME_STATE_SUSPENDED(gen->gi_frame_state);
13431343
}
13441344
return false;
@@ -1665,7 +1665,7 @@ static PyObject *
16651665
frame_clear(PyFrameObject *f, PyObject *Py_UNUSED(ignored))
16661666
{
16671667
if (f->f_frame->owner == FRAME_OWNED_BY_GENERATOR) {
1668-
PyGenObject *gen = _PyFrame_GetGenerator(f->f_frame);
1668+
PyGenObject *gen = _PyGen_GetGeneratorFromFrame(f->f_frame);
16691669
if (gen->gi_frame_state == FRAME_EXECUTING) {
16701670
goto running;
16711671
}
@@ -2097,7 +2097,7 @@ PyFrame_GetGenerator(PyFrameObject *frame)
20972097
if (frame->f_frame->owner != FRAME_OWNED_BY_GENERATOR) {
20982098
return NULL;
20992099
}
2100-
PyGenObject *gen = _PyFrame_GetGenerator(frame->f_frame);
2100+
PyGenObject *gen = _PyGen_GetGeneratorFromFrame(frame->f_frame);
21012101
return Py_NewRef(gen);
21022102
}
21032103

‎Objects/genobject.c

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
#include "pycore_call.h" // _PyObject_CallNoArgs()
77
#include "pycore_ceval.h" // _PyEval_EvalFrame()
88
#include "pycore_frame.h" // _PyInterpreterFrame
9+
#include "pycore_freelist.h" // struct _Py_async_gen_freelist
910
#include "pycore_gc.h" // _PyGC_CLEAR_FINALIZED()
10-
#include "pycore_genobject.h" // struct _Py_async_gen_freelist
1111
#include "pycore_modsupport.h" // _PyArg_CheckPositional()
1212
#include "pycore_object.h" // _PyObject_GC_UNTRACK()
1313
#include "pycore_opcode_utils.h" // RESUME_AFTER_YIELD_FROM
@@ -30,8 +30,7 @@ static const char *ASYNC_GEN_IGNORED_EXIT_MSG =
3030
/* Returns a borrowed reference */
3131
static inline PyCodeObject *
3232
_PyGen_GetCode(PyGenObject *gen) {
33-
_PyInterpreterFrame *frame = (_PyInterpreterFrame *)(gen->gi_iframe);
34-
return _PyFrame_GetCode(frame);
33+
return _PyFrame_GetCode(&gen->gi_iframe);
3534
}
3635

3736
PyCodeObject *
@@ -48,7 +47,7 @@ gen_traverse(PyGenObject *gen, visitproc visit, void *arg)
4847
Py_VISIT(gen->gi_name);
4948
Py_VISIT(gen->gi_qualname);
5049
if (gen->gi_frame_state != FRAME_CLEARED) {
51-
_PyInterpreterFrame *frame = (_PyInterpreterFrame *)(gen->gi_iframe);
50+
_PyInterpreterFrame *frame = &gen->gi_iframe;
5251
assert(frame->frame_obj == NULL ||
5352
frame->frame_obj->f_frame->owner == FRAME_OWNED_BY_GENERATOR);
5453
int err = _PyFrame_Traverse(frame, visit, arg);
@@ -141,7 +140,7 @@ gen_dealloc(PyGenObject *gen)
141140
Py_CLEAR(((PyAsyncGenObject*)gen)->ag_origin_or_finalizer);
142141
}
143142
if (gen->gi_frame_state != FRAME_CLEARED) {
144-
_PyInterpreterFrame *frame = (_PyInterpreterFrame *)gen->gi_iframe;
143+
_PyInterpreterFrame *frame = &gen->gi_iframe;
145144
gen->gi_frame_state = FRAME_CLEARED;
146145
frame->previous = NULL;
147146
_PyFrame_ClearExceptCode(frame);
@@ -163,7 +162,7 @@ gen_send_ex2(PyGenObject *gen, PyObject *arg, PyObject **presult,
163162
int exc, int closing)
164163
{
165164
PyThreadState *tstate = _PyThreadState_GET();
166-
_PyInterpreterFrame *frame = (_PyInterpreterFrame *)gen->gi_iframe;
165+
_PyInterpreterFrame *frame = &gen->gi_iframe;
167166

168167
*presult = NULL;
169168
if (gen->gi_frame_state == FRAME_CREATED && arg && arg != Py_None) {
@@ -342,7 +341,7 @@ PyObject *
342341
_PyGen_yf(PyGenObject *gen)
343342
{
344343
if (gen->gi_frame_state == FRAME_SUSPENDED_YIELD_FROM) {
345-
_PyInterpreterFrame *frame = (_PyInterpreterFrame *)gen->gi_iframe;
344+
_PyInterpreterFrame *frame = &gen->gi_iframe;
346345
assert(is_resume(frame->instr_ptr));
347346
assert((frame->instr_ptr->op.arg & RESUME_OPARG_LOCATION_MASK) >= RESUME_AFTER_YIELD_FROM);
348347
return Py_NewRef(_PyFrame_StackPeek(frame));
@@ -372,7 +371,7 @@ gen_close(PyGenObject *gen, PyObject *args)
372371
gen->gi_frame_state = state;
373372
Py_DECREF(yf);
374373
}
375-
_PyInterpreterFrame *frame = (_PyInterpreterFrame *)gen->gi_iframe;
374+
_PyInterpreterFrame *frame = &gen->gi_iframe;
376375
if (is_resume(frame->instr_ptr)) {
377376
/* We can safely ignore the outermost try block
378377
* as it is automatically generated to handle
@@ -382,7 +381,7 @@ gen_close(PyGenObject *gen, PyObject *args)
382381
// RESUME after YIELD_VALUE and exception depth is 1
383382
assert((oparg & RESUME_OPARG_LOCATION_MASK) != RESUME_AT_FUNC_START);
384383
gen->gi_frame_state = FRAME_COMPLETED;
385-
_PyFrame_ClearLocals((_PyInterpreterFrame *)gen->gi_iframe);
384+
_PyFrame_ClearLocals(&gen->gi_iframe);
386385
Py_RETURN_NONE;
387386
}
388387
}
@@ -431,7 +430,7 @@ _gen_throw(PyGenObject *gen, int close_on_genexit,
431430
PyObject *yf = _PyGen_yf(gen);
432431

433432
if (yf) {
434-
_PyInterpreterFrame *frame = (_PyInterpreterFrame *)gen->gi_iframe;
433+
_PyInterpreterFrame *frame = &gen->gi_iframe;
435434
PyObject *ret;
436435
int err;
437436
if (PyErr_GivenExceptionMatches(typ, PyExc_GeneratorExit) &&
@@ -739,7 +738,7 @@ _gen_getframe(PyGenObject *gen, const char *const name)
739738
if (FRAME_STATE_FINISHED(gen->gi_frame_state)) {
740739
Py_RETURN_NONE;
741740
}
742-
return _Py_XNewRef((PyObject *)_PyFrame_GetFrameObject((_PyInterpreterFrame *)gen->gi_iframe));
741+
return _Py_XNewRef((PyObject *)_PyFrame_GetFrameObject(&gen->gi_iframe));
743742
}
744743

745744
static PyObject *
@@ -814,8 +813,7 @@ static PyAsyncMethods gen_as_async = {
814813
PyTypeObject PyGen_Type = {
815814
PyVarObject_HEAD_INIT(&PyType_Type, 0)
816815
"generator", /* tp_name */
817-
offsetof(PyGenObject, gi_iframe) +
818-
offsetof(_PyInterpreterFrame, localsplus), /* tp_basicsize */
816+
sizeof(PyGenObject), /* tp_basicsize */
819817
sizeof(PyObject *), /* tp_itemsize */
820818
/* methods */
821819
(destructor)gen_dealloc, /* tp_dealloc */
@@ -949,7 +947,7 @@ gen_new_with_qualname(PyTypeObject *type, PyFrameObject *f,
949947
/* Copy the frame */
950948
assert(f->f_frame->frame_obj == NULL);
951949
assert(f->f_frame->owner == FRAME_OWNED_BY_FRAME_OBJECT);
952-
_PyInterpreterFrame *frame = (_PyInterpreterFrame *)gen->gi_iframe;
950+
_PyInterpreterFrame *frame = &gen->gi_iframe;
953951
_PyFrame_Copy((_PyInterpreterFrame *)f->_f_frame_data, frame);
954952
gen->gi_frame_state = FRAME_CREATED;
955953
assert(frame->frame_obj == f);
@@ -1166,8 +1164,7 @@ static PyAsyncMethods coro_as_async = {
11661164
PyTypeObject PyCoro_Type = {
11671165
PyVarObject_HEAD_INIT(&PyType_Type, 0)
11681166
"coroutine", /* tp_name */
1169-
offsetof(PyCoroObject, cr_iframe) +
1170-
offsetof(_PyInterpreterFrame, localsplus), /* tp_basicsize */
1167+
sizeof(PyCoroObject), /* tp_basicsize */
11711168
sizeof(PyObject *), /* tp_itemsize */
11721169
/* methods */
11731170
(destructor)gen_dealloc, /* tp_dealloc */
@@ -1582,8 +1579,7 @@ static PyAsyncMethods async_gen_as_async = {
15821579
PyTypeObject PyAsyncGen_Type = {
15831580
PyVarObject_HEAD_INIT(&PyType_Type, 0)
15841581
"async_generator", /* tp_name */
1585-
offsetof(PyAsyncGenObject, ag_iframe) +
1586-
offsetof(_PyInterpreterFrame, localsplus), /* tp_basicsize */
1582+
sizeof(PyAsyncGenObject), /* tp_basicsize */
15871583
sizeof(PyObject *), /* tp_itemsize */
15881584
/* methods */
15891585
(destructor)gen_dealloc, /* tp_dealloc */

‎Python/bytecodes.c

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1015,7 +1015,7 @@ dummy_func(
10151015
((PyGenObject *)receiver)->gi_frame_state < FRAME_EXECUTING)
10161016
{
10171017
PyGenObject *gen = (PyGenObject *)receiver;
1018-
_PyInterpreterFrame *gen_frame = (_PyInterpreterFrame *)gen->gi_iframe;
1018+
_PyInterpreterFrame *gen_frame = &gen->gi_iframe;
10191019
STACK_SHRINK(1);
10201020
_PyFrame_StackPush(gen_frame, v);
10211021
gen->gi_frame_state = FRAME_EXECUTING;
@@ -1055,7 +1055,7 @@ dummy_func(
10551055
DEOPT_IF(Py_TYPE(gen) != &PyGen_Type && Py_TYPE(gen) != &PyCoro_Type);
10561056
DEOPT_IF(gen->gi_frame_state >= FRAME_EXECUTING);
10571057
STAT_INC(SEND, hit);
1058-
_PyInterpreterFrame *gen_frame = (_PyInterpreterFrame *)gen->gi_iframe;
1058+
_PyInterpreterFrame *gen_frame = &gen->gi_iframe;
10591059
STACK_SHRINK(1);
10601060
_PyFrame_StackPush(gen_frame, v);
10611061
gen->gi_frame_state = FRAME_EXECUTING;
@@ -1069,7 +1069,7 @@ dummy_func(
10691069
inst(INSTRUMENTED_YIELD_VALUE, (retval -- unused)) {
10701070
assert(frame != &entry_frame);
10711071
frame->instr_ptr = next_instr;
1072-
PyGenObject *gen = _PyFrame_GetGenerator(frame);
1072+
PyGenObject *gen = _PyGen_GetGeneratorFromFrame(frame);
10731073
assert(FRAME_SUSPENDED_YIELD_FROM == FRAME_SUSPENDED + 1);
10741074
assert(oparg == 0 || oparg == 1);
10751075
gen->gi_frame_state = FRAME_SUSPENDED + oparg;
@@ -1099,7 +1099,7 @@ dummy_func(
10991099
assert(frame != &entry_frame);
11001100
#endif
11011101
frame->instr_ptr++;
1102-
PyGenObject *gen = _PyFrame_GetGenerator(frame);
1102+
PyGenObject *gen = _PyGen_GetGeneratorFromFrame(frame);
11031103
assert(FRAME_SUSPENDED_YIELD_FROM == FRAME_SUSPENDED + 1);
11041104
assert(oparg == 0 || oparg == 1);
11051105
gen->gi_frame_state = FRAME_SUSPENDED + oparg;
@@ -2799,7 +2799,7 @@ dummy_func(
27992799
DEOPT_IF(Py_TYPE(gen) != &PyGen_Type);
28002800
DEOPT_IF(gen->gi_frame_state >= FRAME_EXECUTING);
28012801
STAT_INC(FOR_ITER, hit);
2802-
gen_frame = (_PyInterpreterFrame *)gen->gi_iframe;
2802+
gen_frame = &gen->gi_iframe;
28032803
_PyFrame_StackPush(gen_frame, Py_None);
28042804
gen->gi_frame_state = FRAME_EXECUTING;
28052805
gen->gi_exc_state.previous_item = tstate->exc_info;
@@ -3940,7 +3940,7 @@ dummy_func(
39403940
}
39413941
assert(EMPTY());
39423942
_PyFrame_SetStackPointer(frame, stack_pointer);
3943-
_PyInterpreterFrame *gen_frame = (_PyInterpreterFrame *)gen->gi_iframe;
3943+
_PyInterpreterFrame *gen_frame = &gen->gi_iframe;
39443944
frame->instr_ptr++;
39453945
_PyFrame_Copy(frame, gen_frame);
39463946
assert(frame->frame_obj == NULL);

‎Python/ceval.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1711,7 +1711,7 @@ static void
17111711
clear_gen_frame(PyThreadState *tstate, _PyInterpreterFrame * frame)
17121712
{
17131713
assert(frame->owner == FRAME_OWNED_BY_GENERATOR);
1714-
PyGenObject *gen = _PyFrame_GetGenerator(frame);
1714+
PyGenObject *gen = _PyGen_GetGeneratorFromFrame(frame);
17151715
gen->gi_frame_state = FRAME_CLEARED;
17161716
assert(tstate->exc_info == &gen->gi_exc_state);
17171717
tstate->exc_info = gen->gi_exc_state.previous_item;

‎Python/executor_cases.c.h

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Python/frame.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ _PyFrame_ClearExceptCode(_PyInterpreterFrame *frame)
112112
/* It is the responsibility of the owning generator/coroutine
113113
* to have cleared the enclosing generator, if any. */
114114
assert(frame->owner != FRAME_OWNED_BY_GENERATOR ||
115-
_PyFrame_GetGenerator(frame)->gi_frame_state == FRAME_CLEARED);
115+
_PyGen_GetGeneratorFromFrame(frame)->gi_frame_state == FRAME_CLEARED);
116116
// GH-99729: Clearing this frame can expose the stack (via finalizers). It's
117117
// crucial that this frame has been unlinked, and is no longer visible:
118118
assert(_PyThreadState_GET()->current_frame != frame);

0 commit comments

Comments
 (0)