Skip to content

gh-107265: Fix code_richcompare for ENTER_EXECUTOR case #108165

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

Merged
merged 4 commits into from
Aug 21, 2023
Merged

gh-107265: Fix code_richcompare for ENTER_EXECUTOR case #108165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e38c553
gh-107265: Fix code_richcompare to lookup actual opcode when ENTER_EX…
corona10 Aug 20, 2023
25d3f5b
Merge remote-tracking branch 'upstream/main' into gh-107265
corona10 Aug 20, 2023
fb0ab4e
Add test and compare oparg too
corona10 Aug 21, 2023
70a29b9
Merge remote-tracking branch 'upstream/main' into gh-107265
corona10 Aug 21, 2023
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
11 changes: 11 additions & 0 deletions Lib/test/test_capi/test_misc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2341,6 +2341,17 @@ def long_loop():
long_loop()
self.assertEqual(opt.get_count(), 10)

def test_code_richcompare(self):
def testfunc(x):
i = 0
while i < x:
i += 1

opt = _testinternalcapi.get_counter_optimizer()
with temporary_optimizer(opt):
testfunc(1000)
self.assertEqual(testfunc.__code__, testfunc.__code__.replace())


def get_first_executor(func):
code = func.__code__
Expand Down
17 changes: 17 additions & 0 deletions Objects/codeobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1781,8 +1781,25 @@ code_richcompare(PyObject *self, PyObject *other, int op)
for (int i = 0; i < Py_SIZE(co); i++) {
_Py_CODEUNIT co_instr = _PyCode_CODE(co)[i];
_Py_CODEUNIT cp_instr = _PyCode_CODE(cp)[i];

if (co_instr.op.code == ENTER_EXECUTOR) {
const int exec_index = co_instr.op.arg;
_PyExecutorObject *exec = co->co_executors->executors[exec_index];
co_instr.op.code = exec->vm_data.opcode;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comparing two code objects must not modify the code object.

The interaction between executor, the specializer and instrumentation is subtle and likely to break without care.
This will leak executors, as it flip-flops between JUMP_BACKWARDS and ENTER_EXECUTOR, or worse if an optimizer assumes that a single instruction will only be seen once.

co_instr.op.arg = exec->vm_data.oparg;
}
assert(co_instr.op.code != ENTER_EXECUTOR);
co_instr.op.code = _PyOpcode_Deopt[co_instr.op.code];

if (cp_instr.op.code == ENTER_EXECUTOR) {
const int exec_index = cp_instr.op.arg;
_PyExecutorObject *exec = cp->co_executors->executors[exec_index];
cp_instr.op.code = exec->vm_data.opcode;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likewise

cp_instr.op.arg = exec->vm_data.oparg;
}
assert(cp_instr.op.code != ENTER_EXECUTOR);
cp_instr.op.code = _PyOpcode_Deopt[cp_instr.op.code];

eq = co_instr.cache == cp_instr.cache;
if (!eq) {
goto unequal;
Expand Down