Use PyStackRef_Borrow as the new API

Author: mpage

Include/internal/pycore_stackref.h

@@ -178,6 +178,12 @@ PyStackRef_MakeHeapSafe(_PyStackRef ref)
     return ref;
 }
 
+static inline _PyStackRef
+PyStackRef_Borrow(_PyStackRef ref)
+{
+    return PyStackRef_DUP(ref)
+}
+
 #define PyStackRef_CLEAR(REF) \
     do { \
         _PyStackRef *_tmp_op_ptr = &(REF); \
@@ -347,7 +353,7 @@ PyStackRef_DUP(_PyStackRef stackref)
 }
 
 static inline _PyStackRef
-PyStackRef_AsDeferred(_PyStackRef stackref)
+PyStackRef_Borrow(_PyStackRef stackref)
 {
     return (_PyStackRef){ .bits = stackref.bits | Py_TAG_DEFERRED };
 }
@@ -432,6 +438,8 @@ static inline void PyStackRef_CheckValid(_PyStackRef ref) {
 
 #endif
 
+#define PyStackRef_Borrow(ref) PyStackRef_DUP(ref)
+
 #ifdef _WIN32
 #define PyStackRef_RefcountOnObject(REF) (((REF).bits & Py_TAG_BITS) == 0)
 #define PyStackRef_AsPyObjectBorrow BITS_TO_PTR_MASKED

Lib/test/test_dis.py

@@ -877,7 +877,7 @@ def load_test(x, y=0):
 %3d           LOAD_FAST_LOAD_FAST      1 (x, y)
               STORE_FAST_STORE_FAST   50 (b, a)
 
-%3d           LOAD_FAST_LOAD_FAST     35 (a, b)
+%3d           LOAD_FAST_BORROW_LOAD_FAST_BORROW 35 (a, b)
               BUILD_TUPLE              2
               RETURN_VALUE
 """ % (load_test.__code__.co_firstlineno,
@@ -901,7 +901,7 @@ def loop_test():
               STORE_FAST               0 (i)
 
 %3d           LOAD_GLOBAL_MODULE       1 (load_test + NULL)
-              LOAD_FAST                0 (i)
+              LOAD_FAST_BORROW         0 (i)
               CALL_PY_GENERAL          1
               POP_TOP
               JUMP_BACKWARD_{: <6}    16 (to L1)

Programs/test_frozenmain.h

@@ -272,11 +272,7 @@ dummy_func(
 
         replicate(8) pure inst (LOAD_FAST_BORROW, (-- value)) {
             assert(!PyStackRef_IsNull(GETLOCAL(oparg)));
-            #ifdef Py_GIL_DISABLED
-            value = PyStackRef_AsDeferred(GETLOCAL(oparg));
-            #else
-            value = PyStackRef_DUP(GETLOCAL(oparg));
-            #endif
+            value = PyStackRef_Borrow(GETLOCAL(oparg));
         }
 
         inst(LOAD_FAST_AND_CLEAR, (-- value)) {
@@ -294,13 +290,8 @@ dummy_func(
         inst(LOAD_FAST_BORROW_LOAD_FAST_BORROW, ( -- value1, value2)) {
             uint32_t oparg1 = oparg >> 4;
             uint32_t oparg2 = oparg & 15;
-            #ifdef Py_GIL_DISABLED
-            value1 = PyStackRef_AsDeferred(GETLOCAL(oparg1));
-            value2 = PyStackRef_AsDeferred(GETLOCAL(oparg2));
-            #else
-            value1 = PyStackRef_DUP(GETLOCAL(oparg1));
-            value2 = PyStackRef_DUP(GETLOCAL(oparg2));
-            #endif
+            value1 = PyStackRef_Borrow(GETLOCAL(oparg1));
+            value2 = PyStackRef_Borrow(GETLOCAL(oparg2));
         }
 
         family(LOAD_CONST, 0) = {

Python/bytecodes.c

@@ -584,11 +584,11 @@ def has_error_without_pop(op: parser.CodeDef) -> bool:
     "PyLong_FromLong",
     "PyLong_FromSsize_t",
     "PySlice_New",
-    "PyStackRef_AsDeferred",
     "PyStackRef_AsPyObjectBorrow",
     "PyStackRef_AsPyObjectNew",
     "PyStackRef_FromPyObjectNewMortal",
     "PyStackRef_AsPyObjectSteal",
+    "PyStackRef_Borrow",
     "PyStackRef_CLEAR",
     "PyStackRef_CLOSE_SPECIALIZED",
     "PyStackRef_DUP",