8000 GH-100923: Embed jump mask in `COMPARE_OP` oparg (GH-100924) · python/cpython@6e4e14d · GitHub
[go: up one dir, main page]
Skip to content

Commit 6e4e14d

Browse files
markshannonmarkshannon
authored
GH-100923: Embed jump mask in COMPARE_OP oparg (GH-100924)
1 parent 61f12b8 commit 6e4e14d

File tree

12 files changed

+200
-177
lines changed

12 files changed

+200
-177
lines changed

‎Include/internal/pycore_code.h

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ typedef struct {
4141

4242
typedef struct {
4343
uint16_t counter;
44-
uint16_t mask;
4544
} _PyCompareOpCache;
4645

4746
#define INLINE_CACHE_ENTRIES_COMPARE_OP CACHE_ENTRIES(_PyCompareOpCache)
@@ -477,6 +476,27 @@ _Py_MakeShimCode(const _PyShimCodeDef *code);
477476
extern uint32_t _Py_next_func_version;
478477

479478

479+
/* Comparison bit masks. */
480+
481+
/* Note this evaluates its arguments twice each */
482+
#define COMPARISON_BIT(x, y) (1 << (2 * ((x) >= (y)) + ((x) <= (y))))
483+
484+
/*
485+
* The following bits are chosen so that the value of
486+
* COMPARSION_BIT(left, right)
487+
* masked by the values below will be non-zero if the
488+
* comparison is true, and zero if it is false */
489+
490+
/* This is for values that are unordered, ie. NaN, not types that are unordered, e.g. sets */
491+
#define COMPARISON_UNORDERED 1
492+
493+
#define COMPARISON_LESS_THAN 2
494+
#define COMPARISON_GREATER_THAN 4
495+
#define COMPARISON_EQUALS 8
496+
497+
#define COMPARISON_NOT_EQUALS (COMPARISON_UNORDERED | COMPARISON_LESS_THAN | COMPARISON_GREATER_THAN)
498+
499+
480500
#ifdef __cplusplus
481501
}
482502
#endif

‎Include/internal/pycore_opcode.h

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Lib/dis.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ def _get_instructions_bytes(code, varname_from_oparg=None,
483483
elif deop in haslocal or deop in hasfree:
484484
argval, argrepr = _get_name_info(arg, varname_from_oparg)
485485
elif deop in hascompare:
486-
argval = cmp_op[arg]
486+
argval = cmp_op[arg>>4]
487487
argrepr = argval
488488
elif deop == FORMAT_VALUE:
489489
argval, argrepr = FORMAT_VALUE_CONVERTERS[arg & 0x3]

‎Lib/importlib/_bootstrap_external.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,6 +428,7 @@ def _write_atomic(path, data, mode=0o666):
428428
# Python 3.12a1 3512 (Remove all unused consts from code objects)
429429
# Python 3.12a1 3513 (Add CALL_INTRINSIC_1 instruction, removed STOPITERATION_ERROR, PRINT_EXPR, IMPORT_STAR)
430430
# Python 3.12a1 3514 (Remove ASYNC_GEN_WRAP, LIST_TO_TUPLE, and UNARY_POSITIVE)
431+
# Python 3.12a1 3515 (Embed jump mask in COMPARE_OP oparg)
431432

432433
# Python 3.13 will start with 3550
433434

@@ -440,7 +441,7 @@ def _write_atomic(path, data, mode=0o666):
440441
# Whenever MAGIC_NUMBER is changed, the ranges in the magic_values array
441442
# in PC/launcher.c must also be updated.
442443

443-
MAGIC_NUMBER = (3514).to_bytes(2, 'little') + b'\r\n'
444+
MAGIC_NUMBER = (3515).to_bytes(2, 'little') + b'\r\n'
444445

445446
_RAW_MAGIC_NUMBER = int.from_bytes(MAGIC_NUMBER, 'little') # For import.c
446447

‎Lib/opcode.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,6 @@ def pseudo_op(name, op, real_ops):
391391
},
392392
"COMPARE_OP": {
393393
"counter": 1,
394-
"mask": 1,
395394
},
396395
"BINARY_SUBSCR": {
397396
"counter": 1,

‎Lib/test/test_dis.py

Lines changed: 105 additions & 105 deletions
Large diffs are not rendered by default.

‎Misc/NEWS.d/next/Core and Builtins/2023-01-10-16-59-33.gh-issue-100923.ypJAX-.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Remove the ``mask`` cache entry for the :opcode:`COMPARE_OP` instruction and
2+
embed the mask into the oparg.

‎Python/bytecodes.c

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ static PyObject *aiter, *awaitable, *iterable, *w, *exc_value, *bc;
8888
static PyObject *orig, *excs, *update, *b, *fromlist, *level, *from;
8989
static size_t jump;
9090
// Dummy variables for cache effects
91-
static uint16_t when_to_jump_mask, invert, counter, index, hint;
91+
static uint16_t invert, counter, index, hint;
9292
static uint32_t type_version;
9393
// Dummy opcode names for 'op' opcodes
9494
#define _COMPARE_OP_FLOAT 1003
@@ -1836,7 +1836,7 @@ dummy_func(
18361836
_COMPARE_OP_STR,
18371837
};
18381838

1839-
inst(COMPARE_OP, (unused/2, left, right -- res)) {
1839+
inst(COMPARE_OP, (unused/1, left, right -- res)) {
18401840
_PyCompareOpCache *cache = (_PyCompareOpCache *)next_instr;
18411841
if (ADAPTIVE_COUNTER_IS_ZERO(cache->counter)) {
18421842
assert(cframe.use_tracing == 0);
@@ -1846,27 +1846,27 @@ dummy_func(
18461846
}
18471847
STAT_INC(COMPARE_OP, deferred);
18481848
DECREMENT_ADAPTIVE_COUNTER(cache->counter);
1849-
assert(oparg <= Py_GE);
1850-
res = PyObject_RichCompare(left, right, oparg);
1849+
assert((oparg >> 4) <= Py_GE);
1850+
res = PyObject_RichCompare(left, right, oparg>>4);
18511851
Py_DECREF(left);
18521852
Py_DECREF(right);
18531853
ERROR_IF(res == NULL, error);
18541854
}
18551855

18561856
// The result is an int disguised as an object pointer.
1857-
op(_COMPARE_OP_FLOAT, (unused/1, when_to_jump_mask/1, left, right -- jump: size_t)) {
1857+
op(_COMPARE_OP_FLOAT, (unused/1, left, right -- jump: size_t)) {
18581858
assert(cframe.use_tracing == 0);
18591859
// Combined: COMPARE_OP (float ? float) + POP_JUMP_IF_(true/false)
18601860
DEOPT_IF(!PyFloat_CheckExact(left), COMPARE_OP);
18611861
DEOPT_IF(!PyFloat_CheckExact(right), COMPARE_OP);
18621862
STAT_INC(COMPARE_OP, hit);
18631863
double dleft = PyFloat_AS_DOUBLE(left);
18641864
double dright = PyFloat_AS_DOUBLE(right);
1865-
// 1 if NaN, 2 if <, 4 if >, 8 if ==; this matches when_to_jump_mask
1866-
int sign_ish = 1 << (2 * (dleft >= dright) + (dleft <= dright));
1865+
// 1 if NaN, 2 if <, 4 if >, 8 if ==; this matches low four bits of the oparg
1866+
int sign_ish = COMPARISON_BIT(dleft, dright);
18671867
_Py_DECREF_SPECIALIZED(left, _PyFloat_ExactDealloc);
18681868
_Py_DECREF_SPECIALIZED(right, _PyFloat_ExactDealloc);
1869-
jump = sign_ish & when_to_jump_mask;
1869+
jump = sign_ish & oparg;
18701870
}
18711871
// The input is an int disguised as an object pointer!
18721872
op(_JUMP_IF, (jump: size_t --)) {
@@ -1879,7 +1879,7 @@ dummy_func(
18791879
super(COMPARE_OP_FLOAT_JUMP) = _COMPARE_OP_FLOAT + _JUMP_IF;
18801880

18811881
// Similar to COMPARE_OP_FLOAT
1882-
op(_COMPARE_OP_INT, (unused/1, when_to_jump_mask/1, left, right -- jump: size_t)) {
1882+
op(_COMPARE_OP_INT, (unused/1, left, right -- jump: size_t)) {
18831883
assert(cframe.use_tracing == 0);
18841884
// Combined: COMPARE_OP (int ? int) + POP_JUMP_IF_(true/false)
18851885
DEOPT_IF(!PyLong_CheckExact(left), COMPARE_OP);
@@ -1890,29 +1890,31 @@ dummy_func(
18901890
assert(Py_ABS(Py_SIZE(left)) <= 1 && Py_ABS(Py_SIZE(right)) <= 1);
18911891
Py_ssize_t ileft = Py_SIZE(left) * ((PyLongObject *)left)->ob_digit[0];
18921892
Py_ssize_t iright = Py_SIZE(right) * ((PyLongObject *)right)->ob_digit[0];
1893-
// 2 if <, 4 if >, 8 if ==; this matches when_to_jump_mask
1894-
int sign_ish = 1 << (2 * (ileft >= iright) + (ileft <= iright));
1893+
// 2 if <, 4 if >, 8 if ==; this matches the low 4 bits of the oparg
1894+
int sign_ish = COMPARISON_BIT(ileft, iright);
18951895
_Py_DECREF_SPECIALIZED(left, (destructor)PyObject_Free);
18961896
_Py_DECREF_SPECIALIZED(right, (destructor)PyObject_Free);
1897-
jump = sign_ish & when_to_jump_mask;
1897+
jump = sign_ish & oparg;
18981898
}
18991899
super(COMPARE_OP_INT_JUMP) = _COMPARE_OP_INT + _JUMP_IF;
19001900

19011901
// Similar to COMPARE_OP_FLOAT, but for ==, != only
1902-
op(_COMPARE_OP_STR, (unused/1, invert/1, left, right -- jump: size_t)) {
1902+
op(_COMPARE_OP_STR, (unused/1, left, right -- jump: size_t)) {
19031903
assert(cframe.use_tracing == 0);
19041904
// Combined: COMPARE_OP (str == str or str != str) + POP_JUMP_IF_(true/false)
19051905
DEOPT_IF(!PyUnicode_CheckExact(left), COMPARE_OP);
19061906
DEOPT_IF(!PyUnicode_CheckExact(right), COMPARE_OP);
19071907
STAT_INC(COMPARE_OP, hit);
19081908
int res = _PyUnicode_Equal(left, right);
1909-
assert(oparg == Py_EQ || oparg == Py_NE);
1909+
assert((oparg >>4) == Py_EQ || (oparg >>4) == Py_NE);
19101910
_Py_DECREF_SPECIALIZED(left, _PyUnicode_ExactDealloc);
19111911
_Py_DECREF_SPECIALIZED(right, _PyUnicode_ExactDealloc);
19121912
assert(res == 0 || res == 1);
1913-
assert(invert == 0 || invert == 1);
1914-
jump = res ^ invert;
1913+
assert((oparg & 0xf) == COMPARISON_NOT_EQUALS || (oparg & 0xf) == COMPARISON_EQUALS);
1914+
assert(COMPARISON_NOT_EQUALS + 1 == COMPARISON_EQUALS);
1915+
jump = (res + COMPARISON_NOT_EQUALS) & oparg;
19151916
}
1917+
19161918
super(COMPARE_OP_STR_JUMP) = _COMPARE_OP_STR + _JUMP_IF;
19171919

19181920
inst(IS_OP, (left, right -- b)) {

‎Python/compile.c

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2887,7 +2887,9 @@ static int compiler_addcompare(struct compiler *c, location loc,
28872887
default:
28882888
Py_UNREACHABLE();
28892889
}
2890-
ADDOP_I(c, loc, COMPARE_OP, cmp);
2890+
/* cmp goes in top bits of the oparg, while the low bits are used by quickened
2891+
* versions of this opcode to store the comparison mask. */
2892+
ADDOP_I(c, loc, COMPARE_OP, cmp << 4);
28912893
return SUCCESS;
28922894
}
28932895

‎Python/generated_cases.c.h

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

‎Python/opcode_metadata.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// from Python/bytecodes.c
33
// Do not edit!
44
enum Direction { DIR_NONE, DIR_READ, DIR_WRITE };
5-
enum InstructionFormat { INSTR_FMT_IB, INSTR_FMT_IBC, INSTR_FMT_IBC0, INSTR_FMT_IBC000, INSTR_FMT_IBC0IB, INSTR_FMT_IBIB };
5+
enum InstructionFormat { INSTR_FMT_IB, INSTR_FMT_IBC, INSTR_FMT_IBC000, INSTR_FMT_IBCIB, INSTR_FMT_IBIB };
66
static const struct {
77
short n_popped;
88
short n_pushed;
@@ -112,10 +112,10 @@ static const struct {
112112
[STORE_ATTR_INSTANCE_VALUE] = { 2, 0, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IBC000 },
113113
[STORE_ATTR_WITH_HINT] = { 2, 0, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IBC000 },
114114
[STORE_ATTR_SLOT] = { 2, 0, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IBC000 },
115-
[COMPARE_OP] = { 2, 1, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IBC0 },
116-
[COMPARE_OP_FLOAT_JUMP] = { 3, 1, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IBC0IB },
117-
[COMPARE_OP_INT_JUMP] = { 3, 1, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IBC0IB },
118-
[COMPARE_OP_STR_JUMP] = { 3, 1, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IBC0IB },
115+
[COMPARE_OP] = { 2, 1, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IBC },
116+
[COMPARE_OP_FLOAT_JUMP] = { 3, 1, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IBCIB },
117+
[COMPARE_OP_INT_JUMP] = { 3, 1, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IBCIB },
118+
[COMPARE_OP_STR_JUMP] = { 3, 1, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IBCIB },
119119
[IS_OP] = { 2, 1, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IB },
120120
[CONTAINS_OP] = { 2, 1, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IB },
121121
[CHECK_EG_MATCH] = { -1, -1, DIR_NONE, DIR_NONE, DIR_NONE, true, INSTR_FMT_IB },

0 commit comments

Comments
 (0)
0