https://github.com/python/cpython/commit/aab58a93efd09185e3622572d2624a31e0fe405b
commit: aab58a93efd09185e3622572d2624a31e0fe405b
branch: main
author: Tomas R. <[email protected]>
committer: markshannon <[email protected]>
date: 2024-10-29T17:25:05Z
summary:
gh-118423: Add `INSTRUCTION_SIZE` macro to code generator (GH-125467)
files:
A
Misc/NEWS.d/next/Core_and_Builtins/2024-10-14-17-13-12.gh-issue-118423.SkBoda.rst
M Lib/test/test_generated_cases.py
M Python/bytecodes.c
M Python/executor_cases.c.h
M Python/generated_cases.c.h
M Tools/cases_generator/analyzer.py
M Tools/cases_generator/generators_common.py
M Tools/cases_generator/interpreter_definition.md
M Tools/cases_generator/tier1_generator.py
diff --git a/Lib/test/test_generated_cases.py b/Lib/test/test_generated_cases.py
index 95813e1e32c7af..173e405b785ddc 100644
--- a/Lib/test/test_generated_cases.py
+++ b/Lib/test/test_generated_cases.py
@@ -1398,6 +1398,37 @@ def test_stack_save_only(self):
with self.assertRaises(SyntaxError):
self.run_cases_test(input, output)
+ def test_instruction_size_macro(self):
+ input = """
+ inst(OP, (--)) {
+ frame->return_offset = INSTRUCTION_SIZE;
+ }
+ """
+
+ output = """
+ TARGET(OP) {
+ frame->instr_ptr = next_instr;
+ next_instr += 1;
+ INSTRUCTION_STATS(OP);
+ frame->return_offset = 1 ;
+ DISPATCH();
+ }
+ """
+ self.run_cases_test(input, output)
+
+ # Two instructions of different sizes referencing the same
+ # uop containing the `INSTRUCTION_SIZE` macro is not allowed.
+ input = """
+ inst(OP, (--)) {
+ frame->return_offset = INSTRUCTION_SIZE;
+ }
+ macro(OP2) = unused/1 + OP;
+ """
+
+ output = "" # No output needed as this should raise an error.
+ with self.assertRaisesRegex(SyntaxError, "All instructions containing
a uop"):
+ self.run_cases_test(input, output)
+
class TestGeneratedAbstractCases(unittest.TestCase):
def setUp(self) -> None:
diff --git
a/Misc/NEWS.d/next/Core_and_Builtins/2024-10-14-17-13-12.gh-issue-118423.SkBoda.rst
b/Misc/NEWS.d/next/Core_and_Builtins/2024-10-14-17-13-12.gh-issue-118423.SkBoda.rst
new file mode 100644
index 00000000000000..8511a8de5530d6
--- /dev/null
+++
b/Misc/NEWS.d/next/Core_and_Builtins/2024-10-14-17-13-12.gh-issue-118423.SkBoda.rst
@@ -0,0 +1,2 @@
+Add a new ``INSTRUCTION_SIZE`` macro to the cases generator which returns
+the current instruction size.
diff --git a/Python/bytecodes.c b/Python/bytecodes.c
index b7469c2dd8d42e..fa98af12c69aef 100644
--- a/Python/bytecodes.c
+++ b/Python/bytecodes.c
@@ -859,7 +859,7 @@ dummy_func(
new_frame->localsplus[0] = container;
new_frame->localsplus[1] = sub;
INPUTS_DEAD();
- frame->return_offset = (uint16_t)(1 +
INLINE_CACHE_ENTRIES_BINARY_SUBSCR);
+ frame->return_offset = INSTRUCTION_SIZE;
}
macro(BINARY_SUBSCR_GETITEM) =
@@ -1111,8 +1111,8 @@ dummy_func(
gen->gi_frame_state = FRAME_EXECUTING;
gen->gi_exc_state.previous_item = tstate->exc_info;
tstate->exc_info = &gen->gi_exc_state;
- assert(next_instr - this_instr + oparg <= UINT16_MAX);
- frame->return_offset = (uint16_t)(next_instr - this_instr +
oparg);
+ assert(INSTRUCTION_SIZE + oparg <= UINT16_MAX);
+ frame->return_offset = (uint16_t)(INSTRUCTION_SIZE + oparg);
assert(gen_frame->previous == NULL);
gen_frame->previous = frame;
DISPATCH_INLINED(gen_frame);
@@ -1157,8 +1157,8 @@ dummy_func(
gen->gi_frame_state = FRAME_EXECUTING;
gen->gi_exc_state.previous_item = tstate->exc_info;
tstate->exc_info = &gen->gi_exc_state;
- assert(1 + INLINE_CACHE_ENTRIES_SEND + oparg <= UINT16_MAX);
- frame->return_offset = (uint16_t)(1 + INLINE_CACHE_ENTRIES_SEND +
oparg);
+ assert(INSTRUCTION_SIZE + oparg <= UINT16_MAX);
+ frame->return_offset = (uint16_t)(INSTRUCTION_SIZE + oparg);
gen_frame->previous = frame;
}
@@ -2265,7 +2265,7 @@ dummy_func(
new_frame->localsplus[0] = owner;
DEAD(owner);
new_frame->localsplus[1] = PyStackRef_FromPyObjectNew(name);
- frame->return_offset = (uint16_t)(next_instr - this_instr);
+ frame->return_offset = INSTRUCTION_SIZE;
DISPATCH_INLINED(new_frame);
}
@@ -3062,7 +3062,7 @@ dummy_func(
tstate->exc_info = &gen->gi_exc_state;
gen_frame->previous = frame;
// oparg is the return offset from the next instruction.
- frame->return_offset = (uint16_t)(1 +
INLINE_CACHE_ENTRIES_FOR_ITER + oparg);
+ frame->return_offset = (uint16_t)(INSTRUCTION_SIZE + oparg);
}
macro(FOR_ITER_GEN) =
@@ -3341,7 +3341,7 @@ dummy_func(
if (new_frame == NULL) {
ERROR_NO_POP();
}
- frame->return_offset = (uint16_t)(next_instr - this_instr);
+ frame->return_offset = INSTRUCTION_SIZE;
DISPATCH_INLINED(new_frame);
}
/* Callable is not a normal Python function */
@@ -4205,8 +4205,8 @@ dummy_func(
if (new_frame == NULL) {
ERROR_NO_POP();
}
- assert(next_instr - this_instr == 1 +
INLINE_CACHE_ENTRIES_CALL_KW);
- frame->return_offset = 1 + INLINE_CACHE_ENTRIES_CALL_KW;
+ assert(INSTRUCTION_SIZE == 1 + INLINE_CACHE_ENTRIES_CALL_KW);
+ frame->return_offset = INSTRUCTION_SIZE;
DISPATCH_INLINED(new_frame);
}
/* Callable is not a normal Python function */
@@ -4472,7 +4472,7 @@ dummy_func(
if (new_frame == NULL) {
ERROR_NO_POP();
}
- assert(next_instr - this_instr == 1);
+ assert(INSTRUCTION_SIZE == 1);
frame->return_offset = 1;
DISPATCH_INLINED(new_frame);
}
diff --git a/Python/executor_cases.c.h b/Python/executor_cases.c.h
index 27b7e324ebea37..ff4a0a52a0b445 100644
--- a/Python/executor_cases.c.h
+++ b/Python/executor_cases.c.h
@@ -1147,7 +1147,7 @@
new_frame = _PyFrame_PushUnchecked(tstate,
PyStackRef_FromPyObjectNew(getitem), 2, frame);
new_frame->localsplus[0] = container;
new_frame->localsplus[1] = sub;
- frame->return_offset = (uint16_t)(1 +
INLINE_CACHE_ENTRIES_BINARY_SUBSCR);
+ frame->return_offset = 2 ;
stack_pointer[-2].bits = (uintptr_t)new_frame;
stack_pointer += -1;
assert(WITHIN_STACK_BOUNDS());
@@ -1454,8 +1454,8 @@
gen->gi_frame_state = FRAME_EXECUTING;
gen->gi_exc_state.previous_item = tstate->exc_info;
tstate->exc_info = &gen->gi_exc_state;
- assert(1 + INLINE_CACHE_ENTRIES_SEND + oparg <= UINT16_MAX);
- frame->return_offset = (uint16_t)(1 + INLINE_CACHE_ENTRIES_SEND +
oparg);
+ assert( 2 + oparg <= UINT16_MAX);
+ frame->return_offset = (uint16_t)( 2 + oparg);
gen_frame->previous = frame;
stack_pointer[-1].bits = (uintptr_t)gen_frame;
break;
@@ -2826,7 +2826,7 @@
break;
}
- /* _LOAD_ATTR_GETATTRIBUTE_OVERRIDDEN is not a viable micro-op for
tier 2 because it uses the 'this_instr' variable */
+ /* _LOAD_ATTR_GETATTRIBUTE_OVERRIDDEN is not a viable micro-op for
tier 2 because it has unused cache entries */
case _GUARD_DORV_NO_DICT: {
_PyStackRef owner;
@@ -3644,7 +3644,7 @@
tstate->exc_info = &gen->gi_exc_state;
gen_frame->previous = frame;
// oparg is the return offset from the next instruction.
- frame->return_offset = (uint16_t)(1 +
INLINE_CACHE_ENTRIES_FOR_ITER + oparg);
+ frame->return_offset = (uint16_t)( 2 + oparg);
stack_pointer[0].bits = (uintptr_t)gen_frame;
stack_pointer += 1;
assert(WITHIN_STACK_BOUNDS());
diff --git a/Python/generated_cases.c.h b/Python/generated_cases.c.h
index a615f65c4133d3..632cbc7790a4d8 100644
--- a/Python/generated_cases.c.h
+++ b/Python/generated_cases.c.h
@@ -539,7 +539,7 @@
new_frame = _PyFrame_PushUnchecked(tstate,
PyStackRef_FromPyObjectNew(getitem), 2, frame);
new_frame->localsplus[0] = container;
new_frame->localsplus[1] = sub;
- frame->return_offset = (uint16_t)(1 +
INLINE_CACHE_ENTRIES_BINARY_SUBSCR);
+ frame->return_offset = 2 ;
}
// _PUSH_FRAME
{
@@ -935,7 +935,7 @@
if (new_frame == NULL) {
goto error;
}
- frame->return_offset = (uint16_t)(next_instr - this_instr);
+ frame->return_offset = 4 ;
DISPATCH_INLINED(new_frame);
}
/* Callable is not a normal Python function */
@@ -1737,7 +1737,7 @@
if (new_frame == NULL) {
goto error;
}
- assert(next_instr - this_instr == 1);
+ assert( 1 == 1);
frame->return_offset = 1;
DISPATCH_INLINED(new_frame);
}
@@ -1958,8 +1958,8 @@
if (new_frame == NULL) {
goto error;
}
- assert(next_instr - this_instr == 1 +
INLINE_CACHE_ENTRIES_CALL_KW);
- frame->return_offset = 1 + INLINE_CACHE_ENTRIES_CALL_KW;
+ assert( 4 == 1 + INLINE_CACHE_ENTRIES_CALL_KW);
+ frame->return_offset = 4 ;
DISPATCH_INLINED(new_frame);
}
/* Callable is not a normal Python function */
@@ -3986,7 +3986,7 @@
tstate->exc_info = &gen->gi_exc_state;
gen_frame->previous = frame;
// oparg is the return offset from the next instruction.
- frame->return_offset = (uint16_t)(1 +
INLINE_CACHE_ENTRIES_FOR_ITER + oparg);
+ frame->return_offset = (uint16_t)( 2 + oparg);
}
// _PUSH_FRAME
{
@@ -4448,7 +4448,7 @@
if (new_frame == NULL) {
goto error;
}
- frame->return_offset = (uint16_t)(next_instr - this_instr);
+ frame->return_offset = 4 ;
DISPATCH_INLINED(new_frame);
}
/* Callable is not a normal Python function */
@@ -5352,7 +5352,7 @@
STACK_SHRINK(1);
new_frame->localsplus[0] = owner;
new_frame->localsplus[1] = PyStackRef_FromPyObjectNew(name);
- frame->return_offset = (uint16_t)(next_instr - this_instr);
+ frame->return_offset = 10 ;
DISPATCH_INLINED(new_frame);
}
@@ -7035,8 +7035,8 @@
gen->gi_frame_state = FRAME_EXECUTING;
gen->gi_exc_state.previous_item = tstate->exc_info;
tstate->exc_info = &gen->gi_exc_state;
- assert(next_instr - this_instr + oparg <= UINT16_MAX);
- frame->return_offset = (uint16_t)(next_instr - this_instr
+ oparg);
+ assert( 2 + oparg <= UINT16_MAX);
+ frame->return_offset = (uint16_t)( 2 + oparg);
assert(gen_frame->previous == NULL);
gen_frame->previous = frame;
DISPATCH_INLINED(gen_frame);
@@ -7108,8 +7108,8 @@
gen->gi_frame_state = FRAME_EXECUTING;
gen->gi_exc_state.previous_item = tstate->exc_info;
tstate->exc_info = &gen->gi_exc_state;
- assert(1 + INLINE_CACHE_ENTRIES_SEND + oparg <= UINT16_MAX);
- frame->return_offset = (uint16_t)(1 +
INLINE_CACHE_ENTRIES_SEND + oparg);
+ assert( 2 + oparg <= UINT16_MAX);
+ frame->return_offset = (uint16_t)( 2 + oparg);
gen_frame->previous = frame;
}
// _PUSH_FRAME
diff --git a/Tools/cases_generator/analyzer.py
b/Tools/cases_generator/analyzer.py
index f41a8d161099df..66ead741b87a2b 100644
--- a/Tools/cases_generator/analyzer.py
+++ b/Tools/cases_generator/analyzer.py
@@ -173,6 +173,8 @@ class Uop:
implicitly_created: bool = False
replicated = 0
replicates: "Uop | None" = None
+ # Size of the instruction(s), only set for uops containing the
INSTRUCTION_SIZE macro
+ instruction_size: int | None = None
def dump(self, indent: str) -> None:
print(
@@ -1079,6 +1081,35 @@ def add_instruction(name: str) -> None:
return instmap, len(no_arg), min_instrumented
+def get_instruction_size_for_uop(instructions: dict[str, Instruction], uop:
Uop) -> int | None:
+ """Return the size of the instruction that contains the given uop or
+ `None` if the uop does not contains the `INSTRUCTION_SIZE` macro.
+
+ If there is more than one instruction that contains the uop,
+ ensure that they all have the same size.
+ """
+ for tkn in uop.body:
+ if tkn.text == "INSTRUCTION_SIZE":
+ break
+ else:
+ return None
+
+ size = None
+ for inst in instructions.values():
+ if uop in inst.parts:
+ if size is None:
+ size = inst.size
+ if size != inst.size:
+ raise analysis_error(
+ "All instructions containing a uop with the
`INSTRUCTION_SIZE` macro "
+ f"must have the same size: {size} != {inst.size}",
+ tkn
+ )
+ if size is None:
+ raise analysis_error(f"No instruction containing the uop '{uop.name}'
was found", tkn)
+ return size
+
+
def analyze_forest(forest: list[parser.AstNode]) -> Analysis:
instructions: dict[str, Instruction] = {}
uops: dict[str, Uop] = {}
@@ -1122,6 +1153,8 @@ def analyze_forest(forest: list[parser.AstNode]) ->
Analysis:
continue
if target.text in instructions:
instructions[target.text].is_target = True
+ for uop in uops.values():
+ uop.instruction_size = get_instruction_size_for_uop(instructions, uop)
# Special case BINARY_OP_INPLACE_ADD_UNICODE
# BINARY_OP_INPLACE_ADD_UNICODE is not a normal family member,
# as it is the wrong size, but we need it to maintain an
diff --git a/Tools/cases_generator/generators_common.py
b/Tools/cases_generator/generators_common.py
index 3b158f5ac4eb48..dad2557e97a948 100644
--- a/Tools/cases_generator/generators_common.py
+++ b/Tools/cases_generator/generators_common.py
@@ -9,9 +9,9 @@
analysis_error,
)
from cwriter import CWriter
-from typing import Callable, Mapping, TextIO, Iterator, Iterable
+from typing import Callable, TextIO, Iterator, Iterable
from lexer import Token
-from stack import Stack, Local, Storage, StackError
+from stack import Storage, StackError
# Set this to true for voluminous output showing state of stack and locals
PRINT_STACKS = False
@@ -118,7 +118,8 @@ def __init__(self, out: CWriter):
"PyStackRef_CLOSE": self.stackref_close,
"PyStackRef_CLOSE_SPECIALIZED": self.stackref_close,
"PyStackRef_AsPyObjectSteal": self.stackref_steal,
- "DISPATCH": self.dispatch
+ "DISPATCH": self.dispatch,
+ "INSTRUCTION_SIZE": self.instruction_size,
}
self.out = out
@@ -365,6 +366,19 @@ def reload_stack(
self.emit_reload(storage)
return True
+ def instruction_size(self,
+ tkn: Token,
+ tkn_iter: TokenIterator,
+ uop: Uop,
+ storage: Storage,
+ inst: Instruction | None,
+ ) -> bool:
+ """Replace the INSTRUCTION_SIZE macro with the size of the current
instruction."""
+ if uop.instruction_size is None:
+ raise analysis_error("The INSTRUCTION_SIZE macro requires
uop.instruction_size to be set", tkn)
+ self.out.emit(f" {uop.instruction_size} ")
+ return True
+
def _print_storage(self, storage: Storage) -> None:
if PRINT_STACKS:
self.out.start_line()
diff --git a/Tools/cases_generator/interpreter_definition.md
b/Tools/cases_generator/interpreter_definition.md
index 6cf36f343d5fa7..203286834e3e3f 100644
--- a/Tools/cases_generator/interpreter_definition.md
+++ b/Tools/cases_generator/interpreter_definition.md
@@ -178,15 +178,17 @@ list of annotations and their meanings are as follows:
### Special functions/macros
-The C code may include special functions that are understood by the tools as
+The C code may include special functions and macros that are understood by the
tools as
part of the DSL.
-Those functions include:
+Those include:
* `DEOPT_IF(cond, instruction)`. Deoptimize if `cond` is met.
* `ERROR_IF(cond, label)`. Jump to error handler at `label` if `cond` is true.
* `DECREF_INPUTS()`. Generate `Py_DECREF()` calls for the input stack effects.
* `SYNC_SP()`. Synchronizes the physical stack pointer with the stack effects.
+* `INSTRUCTION_SIZE`. Replaced with the size of the instruction which is equal
+to `1 + INLINE_CACHE_ENTRIES`.
Note that the use of `DECREF_INPUTS()` is optional -- manual calls
to `Py_DECREF()` or other approaches are also acceptable
diff --git a/Tools/cases_generator/tier1_generator.py
b/Tools/cases_generator/tier1_generator.py
index 8dadc5736c8889..fcdd3bdacd0e7a 100644
--- a/Tools/cases_generator/tier1_generator.py
+++ b/Tools/cases_generator/tier1_generator.py
@@ -22,7 +22,6 @@
write_header,
type_and_null,
Emitter,
- TokenIterator,
)
from cwriter import CWriter
from typing import TextIO
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
