Skip to content

Commit 2effea4

Browse files
markshannonmarkshannon
authored
GH-128682: Spill the stack pointer in labels, as well as instructions (GH-129618)
1 parent d3c54f3 commit 2effea4

15 files changed

+277
-102
lines changed

‎Include/internal/pycore_optimizer.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ extern int _Py_uop_frame_pop(JitOptContext *ctx);
282282

283283
PyAPI_FUNC(PyObject *) _Py_uop_symbols_test(PyObject *self, PyObject *ignored);
284284

285-
PyAPI_FUNC(int) _PyOptimizer_Optimize(struct _PyInterpreterFrame *frame, _Py_CODEUNIT *start, _PyStackRef *stack_pointer, _PyExecutorObject **exec_ptr, int chain_depth);
285+
PyAPI_FUNC(int) _PyOptimizer_Optimize(struct _PyInterpreterFrame *frame, _Py_CODEUNIT *start, _PyExecutorObject **exec_ptr, int chain_depth);
286286

287287
static inline int is_terminator(const _PyUOpInstruction *uop)
288288
{

‎Lib/test/test_generated_cases.py

+85-5
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ def run_cases_test(self, input: str, expected: str):
286286
instructions, labels_with_prelude_and_postlude = rest.split(tier1_generator.INSTRUCTION_END_MARKER)
287287
_, labels_with_postlude = labels_with_prelude_and_postlude.split(tier1_generator.LABEL_START_MARKER)
288288
labels, _ = labels_with_postlude.split(tier1_generator.LABEL_END_MARKER)
289-
actual = instructions + labels
289+
actual = instructions.strip() + "\n\n " + labels.strip()
290290
# if actual.strip() != expected.strip():
291291
# print("Actual:")
292292
# print(actual)
@@ -652,6 +652,9 @@ def test_cache_effect(self):
652652

653653
def test_suppress_dispatch(self):
654654
input = """
655+
label(somewhere) {
656+
}
657+
655658
inst(OP, (--)) {
656659
goto somewhere;
657660
}
@@ -663,6 +666,11 @@ def test_suppress_dispatch(self):
663666
INSTRUCTION_STATS(OP);
664667
goto somewhere;
665668
}
669+
670+
somewhere:
671+
{
672+
673+
}
666674
"""
667675
self.run_cases_test(input, output)
668676

@@ -1768,9 +1776,15 @@ def test_kill_in_wrong_order(self):
17681776

17691777
def test_complex_label(self):
17701778
input = """
1779+
label(other_label) {
1780+
}
1781+
1782+
label(other_label2) {
1783+
}
1784+
17711785
label(my_label) {
17721786
// Comment
1773-
do_thing()
1787+
do_thing();
17741788
if (complex) {
17751789
goto other_label;
17761790
}
@@ -1779,10 +1793,22 @@ def test_complex_label(self):
17791793
"""
17801794

17811795
output = """
1796+
other_label:
1797+
{
1798+
1799+
}
1800+
1801+
other_label2:
1802+
{
1803+
1804+
}
1805+
17821806
my_label:
17831807
{
17841808
// Comment
1785-
do_thing()
1809+
_PyFrame_SetStackPointer(frame, stack_pointer);
1810+
do_thing();
1811+
stack_pointer = _PyFrame_GetStackPointer(frame);
17861812
if (complex) {
17871813
goto other_label;
17881814
}
@@ -1791,6 +1817,60 @@ def test_complex_label(self):
17911817
"""
17921818
self.run_cases_test(input, output)
17931819

1820+
def test_spilled_label(self):
1821+
input = """
1822+
spilled label(one) {
1823+
RELOAD_STACK();
1824+
goto two;
1825+
}
1826+
1827+
label(two) {
1828+
SAVE_STACK();
1829+
goto one;
1830+
}
1831+
"""
1832+
1833+
output = """
1834+
one:
1835+
{
1836+
/* STACK SPILLED */
1837+
stack_pointer = _PyFrame_GetStackPointer(frame);
1838+
goto two;
1839+
}
1840+
1841+
two:
1842+
{
1843+
_PyFrame_SetStackPointer(frame, stack_pointer);
1844+
goto one;
1845+
}
1846+
"""
1847+
self.run_cases_test(input, output)
1848+
1849+
1850+
def test_incorrect_spills(self):
1851+
input1 = """
1852+
spilled label(one) {
1853+
goto two;
1854+
}
1855+
1856+
label(two) {
1857+
}
1858+
"""
1859+
1860+
input2 = """
1861+
spilled label(one) {
1862+
}
1863+
1864+
label(two) {
1865+
goto one;
1866+
}
1867+
"""
1868+
with self.assertRaisesRegex(SyntaxError, ".*reload.*"):
1869+
self.run_cases_test(input1, "")
1870+
with self.assertRaisesRegex(SyntaxError, ".*spill.*"):
1871+
self.run_cases_test(input2, "")
1872+
1873+
17941874
def test_multiple_labels(self):
17951875
input = """
17961876
label(my_label_1) {
@@ -1802,7 +1882,7 @@ def test_multiple_labels(self):
18021882
label(my_label_2) {
18031883
// Comment
18041884
do_thing2();
1805-
goto my_label_3;
1885+
goto my_label_1;
18061886
}
18071887
"""
18081888

@@ -1818,7 +1898,7 @@ def test_multiple_labels(self):
18181898
{
18191899
// Comment
18201900
do_thing2();
1821-
goto my_label_3;
1901+
goto my_label_1;
18221902
}
18231903
"""
18241904

‎Python/bytecodes.c

+24-21
Original file line numberDiff line numberDiff line change
@@ -2808,7 +2808,7 @@ dummy_func(
28082808
start--;
28092809
}
28102810
_PyExecutorObject *executor;
2811-
int optimized = _PyOptimizer_Optimize(frame, start, stack_pointer, &executor, 0);
2811+
int optimized = _PyOptimizer_Optimize(frame, start, &executor, 0);
28122812
if (optimized <= 0) {
28132813
this_instr[1].counter = restart_backoff_counter(counter);
28142814
ERROR_IF(optimized < 0, error);
@@ -5033,7 +5033,7 @@ dummy_func(
50335033
}
50345034
else {
50355035
int chain_depth = current_executor->vm_data.chain_depth + 1;
5036-
int optimized = _PyOptimizer_Optimize(frame, target, stack_pointer, &executor, chain_depth);
5036+
int optimized = _PyOptimizer_Optimize(frame, target, &executor, chain_depth);
50375037
if (optimized <= 0) {
50385038
exit->temperature = restart_backoff_counter(temperature);
50395039
if (optimized < 0) {
@@ -5134,7 +5134,7 @@ dummy_func(
51345134
exit->temperature = advance_backoff_counter(exit->temperature);
51355135
GOTO_TIER_ONE(target);
51365136
}
5137-
int optimized = _PyOptimizer_Optimize(frame, target, stack_pointer, &executor, 0);
5137+
int optimized = _PyOptimizer_Optimize(frame, target, &executor, 0);
51385138
if (optimized <= 0) {
51395139
exit->temperature = restart_backoff_counter(exit->temperature);
51405140
if (optimized < 0) {
@@ -5242,48 +5242,49 @@ dummy_func(
52425242
goto exception_unwind;
52435243
}
52445244

5245-
label(exception_unwind) {
5245+
spilled label(exception_unwind) {
52465246
/* We can't use frame->instr_ptr here, as RERAISE may have set it */
52475247
int offset = INSTR_OFFSET()-1;
52485248
int level, handler, lasti;
5249-
if (get_exception_handler(_PyFrame_GetCode(frame), offset, &level, &handler, &lasti) == 0) {
5249+
int handled = get_exception_handler(_PyFrame_GetCode(frame), offset, &level, &handler, &lasti);
5250+
if (handled == 0) {
52505251
// No handlers, so exit.
52515252
assert(_PyErr_Occurred(tstate));
5252-
52535253
/* Pop remaining stack entries. */
52545254
_PyStackRef *stackbase = _PyFrame_Stackbase(frame);
5255-
while (stack_pointer > stackbase) {
5256-
PyStackRef_XCLOSE(POP());
5255+
while (frame->stackpointer > stackbase) {
5256+
_PyStackRef ref = _PyFrame_StackPop(frame);
5257+
PyStackRef_XCLOSE(ref);
52575258
}
5258-
assert(STACK_LEVEL() == 0);
5259-
_PyFrame_SetStackPointer(frame, stack_pointer);
52605259
monitor_unwind(tstate, frame, next_instr-1);
52615260
goto exit_unwind;
52625261
}
5263-
52645262
assert(STACK_LEVEL() >= level);
52655263
_PyStackRef *new_top = _PyFrame_Stackbase(frame) + level;
5266-
while (stack_pointer > new_top) {
5267-
PyStackRef_XCLOSE(POP());
5264+
assert(frame->stackpointer >= new_top);
5265+
while (frame->stackpointer > new_top) {
5266+
_PyStackRef ref = _PyFrame_StackPop(frame);
5267+
PyStackRef_XCLOSE(ref);
52685268
}
52695269
if (lasti) {
52705270
int frame_lasti = _PyInterpreterFrame_LASTI(frame);
52715271
PyObject *lasti = PyLong_FromLong(frame_lasti);
52725272
if (lasti == NULL) {
52735273
goto exception_unwind;
52745274
}
5275-
PUSH(PyStackRef_FromPyObjectSteal(lasti));
5275+
_PyFrame_StackPush(frame, PyStackRef_FromPyObjectSteal(lasti));
52765276
}
52775277

52785278
/* Make the raw exception data
52795279
available to the handler,
52805280
so a program can emulate the
52815281
Python main loop. */
52825282
PyObject *exc = _PyErr_GetRaisedException(tstate);
5283-
PUSH(PyStackRef_FromPyObjectSteal(exc));
5283+
_PyFrame_StackPush(frame, PyStackRef_FromPyObjectSteal(exc));
52845284
next_instr = _PyFrame_GetBytecode(frame) + handler;
52855285

5286-
if (monitor_handled(tstate, frame, next_instr, exc) < 0) {
5286+
int err = monitor_handled(tstate, frame, next_instr, exc);
5287+
if (err < 0) {
52875288
goto exception_unwind;
52885289
}
52895290
/* Resume normal execution */
@@ -5292,10 +5293,11 @@ dummy_func(
52925293
lltrace_resume_frame(frame);
52935294
}
52945295
#endif
5296+
RELOAD_STACK();
52955297
DISPATCH();
52965298
}
52975299

5298-
label(exit_unwind) {
5300+
spilled label(exit_unwind) {
52995301
assert(_PyErr_Occurred(tstate));
53005302
_Py_LeaveRecursiveCallPy(tstate);
53015303
assert(frame->owner != FRAME_OWNED_BY_INTERPRETER);
@@ -5311,16 +5313,16 @@ dummy_func(
53115313
return NULL;
53125314
}
53135315
next_instr = frame->instr_ptr;
5314-
stack_pointer = _PyFrame_GetStackPointer(frame);
5316+
RELOAD_STACK();
53155317
goto error;
53165318
}
53175319

5318-
label(start_frame) {
5319-
if (_Py_EnterRecursivePy(tstate)) {
5320+
spilled label(start_frame) {
5321+
int too_deep = _Py_EnterRecursivePy(tstate);
5322+
if (too_deep) {
53205323
goto exit_unwind;
53215324
}
53225325
next_instr = frame->instr_ptr;
5323-
stack_pointer = _PyFrame_GetStackPointer(frame);
53245326

53255327
#ifdef LLTRACE
53265328
{
@@ -5339,6 +5341,7 @@ dummy_func(
53395341
assert(!_PyErr_Occurred(tstate));
53405342
#endif
53415343

5344+
RELOAD_STACK();
53425345
DISPATCH();
53435346
}
53445347

‎Python/executor_cases.c.h

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)