[Python-checkins] GH-104584: Allow optimizers to opt out of optimizing. (GH-105244)

[markshannon]

https://github.com/python/cpython/commit/e8ecb9ee6bec03d0c4490f3e7f1524e56e2f6a0f
commit: e8ecb9ee6bec03d0c4490f3e7f1524e56e2f6a0f
branch: main
author: Mark Shannon <mark at hotpy.org>
committer: markshannon <mark at hotpy.org>
date: 2023-06-05T09:44:23+01:00
summary:

GH-104584: Allow optimizers to opt out of optimizing. (GH-105244)

files:
M Include/cpython/optimizer.h
M Python/optimizer.c

diff --git a/Include/cpython/optimizer.h b/Include/cpython/optimizer.h
index eb257d73f934..b2d173fb913e 100644
--- a/Include/cpython/optimizer.h
+++ b/Include/cpython/optimizer.h
@@ -21,7 +21,8 @@ typedef struct _PyExecutorObject {
 
 typedef struct _PyOptimizerObject _PyOptimizerObject;
 
-typedef _PyExecutorObject *(*optimize_func)(_PyOptimizerObject* self, PyCodeObject *code, _Py_CODEUNIT *instr);
+/* Should return > 0 if a new executor is created. O if no executor is produced and < 0 if an error occurred. */
+typedef int (*optimize_func)(_PyOptimizerObject* self, PyCodeObject *code, _Py_CODEUNIT *instr, _PyExecutorObject **);
 
 typedef struct _PyOptimizerObject {
     PyObject_HEAD
diff --git a/Python/optimizer.c b/Python/optimizer.c
index f29e072410e5..d721bfa2b2de 100644
--- a/Python/optimizer.c
+++ b/Python/optimizer.c
@@ -93,14 +93,15 @@ PyUnstable_Replace_Executor(PyCodeObject *code, _Py_CODEUNIT *instr, _PyExecutor
     return 0;
 }
 
-static _PyExecutorObject *
+static int
 error_optimize(
     _PyOptimizerObject* self,
     PyCodeObject *code,
-    _Py_CODEUNIT *instr)
+    _Py_CODEUNIT *instr,
+    _PyExecutorObject **exec)
 {
     PyErr_Format(PyExc_SystemError, "Should never call error_optimize");
-    return NULL;
+    return -1;
 }
 
 static PyTypeObject DefaultOptimizer_Type = {
@@ -154,15 +155,19 @@ _PyOptimizer_BackEdge(_PyInterpreterFrame *frame, _Py_CODEUNIT *src, _Py_CODEUNI
         return frame;
     }
     _PyOptimizerObject *opt = interp->optimizer;
-    _PyExecutorObject *executor = opt->optimize(opt, frame->f_code, dest);
-    if (executor == NULL) {
-        return NULL;
+    _PyExecutorObject *executor;
+    int err = opt->optimize(opt, frame->f_code, dest, &executor);
+    if (err <= 0) {
+        if (err < 0) {
+            return NULL;
+        }
+        _PyFrame_SetStackPointer(frame, stack_pointer);
+        return frame;
     }
     insert_executor(frame->f_code, src, index, executor);
     return executor->execute(executor, frame, stack_pointer);
 }
 
-
 /** Test support **/
 
 
@@ -202,21 +207,23 @@ counter_execute(_PyExecutorObject *self, _PyInterpreterFrame *frame, PyObject **
     return frame;
 }
 
-static _PyExecutorObject *
+static int
 counter_optimize(
     _PyOptimizerObject* self,
     PyCodeObject *code,
-    _Py_CODEUNIT *instr)
+    _Py_CODEUNIT *instr,
+    _PyExecutorObject **exec_ptr)
 {
     _PyCounterExecutorObject *executor = (_PyCounterExecutorObject *)_PyObject_New(&CounterExecutor_Type);
     if (executor == NULL) {
-        return NULL;
+        return -1;
     }
     executor->executor.execute = counter_execute;
     Py_INCREF(self);
     executor->optimizer = (_PyCounterOptimizerObject *)self;
     executor->next_instr = instr;
-    return (_PyExecutorObject *)executor;
+    *exec_ptr = (_PyExecutorObject *)executor;
+    return 1;
 }
 
 static PyObject *