bpo-37146: Allow to configure the opcode cache and fix huntleaks by presetting it to 1

Author: pablogsal

Include/internal/pycore_pystate.h

@@ -43,6 +43,10 @@ struct _pending_calls {
     int last;
 };
 
+struct _opcodecache_config {
+    int minruns;
+};
+
 struct _ceval_runtime_state {
     int recursion_limit;
     /* Records whether tracing is on for any thread.  Counts the number
@@ -60,6 +64,7 @@ struct _ceval_runtime_state {
     /* Request for checking signals. */
     _Py_atomic_int signals_pending;
     struct _gil_runtime_state gil;
+    struct _opcodecache_config opcodeconfig;
 };
 
 /* interpreter state */
@@ -312,6 +317,10 @@ PyAPI_FUNC(void) _PyInterpreterState_DeleteExceptMain(_PyRuntimeState *runtime);
 
 PyAPI_FUNC(void) _PyGILState_Reinit(_PyRuntimeState *runtime);
 
+PyAPI_FUNC(void) _PyEval_SetOpcodeCacheMinRuns(int minruns);
+
+PyAPI_FUNC(int) _PyEval_GetOpcodeCacheMinRuns();
+
 #ifdef __cplusplus
 }
 #endif

Lib/test/libregrtest/runtest.py

@@ -206,6 +206,8 @@ def _test_module(the_module):
 def _runtest_inner2(ns, test_name):
     # Load the test function, run the test function, handle huntrleaks
     # and findleaks to detect leaks
+    minruns = sys._getopcacheminruns()
+    sys._setopcacheminruns(1)
 
     abstest = get_abs_module(ns, test_name)
 
@@ -243,7 +245,7 @@ def _runtest_inner2(ns, test_name):
         gc.garbage.clear()
 
     support.reap_children()
-
+    sys._setopcacheminruns(1)
     return refleak
 
 

Misc/NEWS.d/next/Core and Builtins/2019-06-03-23-29-35.bpo-37146.5B7ZiD.rst

@@ -0,0 +1,3 @@
+Added ``sys._setopcacheminruns`` and ``sys._getopcacheminruns`` to allow
+configuring the minimum number of function executions to activate the global
+opcode cache.

Python/ceval.c

@@ -103,7 +103,6 @@ static long dxp[256];
 #endif
 
 /* per opcode cache */
-#define OPCACHE_MIN_RUNS 1024  /* create opcache when code executed this time */
 #define OPCACHE_STATS 0  /* Enable stats */
 
 #if OPCACHE_STATS
@@ -1152,9 +1151,10 @@ _PyEval_EvalFrameDefault(PyFrameObject *f, int throwflag)
     f->f_stacktop = NULL;       /* remains NULL unless yield suspends frame */
     f->f_executing = 1;
 
-    if (co->co_opcache_flag < OPCACHE_MIN_RUNS) {
+    int opcacheminruns = _PyEval_GetOpcodeCacheMinRuns();
+    if (co->co_opcache_flag < opcacheminruns) {
         co->co_opcache_flag++;
-        if (co->co_opcache_flag == OPCACHE_MIN_RUNS) {
+        if (co->co_opcache_flag == opcacheminruns) {
             if (_PyCode_InitOpcache(co) < 0) {
                 return NULL;
             }
@@ -5632,3 +5632,15 @@ maybe_dtrace_line(PyFrameObject *frame,
     }
     *instr_prev = frame->f_lasti;
 }
+
+void
+_PyEval_SetOpcodeCacheMinRuns(int minruns)
+{
+    _PyRuntime.ceval.opcodeconfig.minruns = minruns;
+}
+
+int
+_PyEval_GetOpcodeCacheMinRuns()
+{
+     return _PyRuntime.ceval.opcodeconfig.minruns;
+}

Python/clinic/sysmodule.c.h

@@ -737,6 +737,9 @@ _Py_PreInitializeFromPyArgv(const PyPreConfig *src_config, const _PyArgv *args)
         return status;
     }
 
+    // XXX: Add this properly to the commandline config
+    runtime->ceval.opcodeconfig.minruns = 1024;
+
     runtime->pre_initialized = 1;
     return _PyStatus_OK();
 }

Python/pylifecycle.c

@@ -1030,6 +1030,44 @@ sys_getcheckinterval_impl(PyObject *module)
     return PyLong_FromLong(interp->check_interval);
 }
 
+/*[clinic input]
+sys._setopcacheminruns
+
+    minruns: int
+    /
+
+Set the minimum value of runs to activate opcode cache.
+[clinic start generated code]*/
+
+static PyObject *
+sys__setopcacheminruns_impl(PyObject *module, int minruns)
+/*[clinic end generated code: output=e29d082b62b2aa8a input=169a982eee6595d5]*/
+{
+    if (minruns <= 0) {
+        PyErr_SetString(PyExc_ValueError,
+                        "opcache min runs must be strictly positive");
+        return NULL;
+    }
+    _PyEval_SetOpcodeCacheMinRuns(minruns);
+    Py_RETURN_NONE;
+}
+
+
+/*[clinic input]
+sys._getopcacheminruns -> int
+
+Return the current minimum value of runs to activate opcode cache.
+[clinic start generated code]*/
+
+static int
+sys__getopcacheminruns_impl(PyObject *module)
+/*[clinic end generated code: output=f25d23b7afd8512c input=93784822a3e883c9]*/
+{
+    return _PyEval_GetOpcodeCacheMinRuns();
+}
+
+
+
 /*[clinic input]
 sys.setswitchinterval
 
@@ -1936,6 +1974,8 @@ static PyMethodDef sys_methods[] = {
     SYS_MDEBUG_METHODDEF
     SYS_SETCHECKINTERVAL_METHODDEF
     SYS_GETCHECKINTERVAL_METHODDEF
+    SYS__SETOPCACHEMINRUNS_METHODDEF
+    SYS__GETOPCACHEMINRUNS_METHODDEF
     SYS_SETSWITCHINTERVAL_METHODDEF
     SYS_GETSWITCHINTERVAL_METHODDEF
     SYS_SETDLOPENFLAGS_METHODDEF