Stackless issue python#185: cleanup header files for runtime state.

Move the definition of struct _stackless_runtime_state from
stackless_tstate.h to the new file stackless_pystate.h.
Now internal/pystate.h includes stackless_pystate.h and
pystate.h includes stackless_tstate.h.

Author: Anselm Kruis

Include/internal/pystate.h

@@ -12,6 +12,9 @@ extern "C" {
 #include "internal/ceval.h"
 #include "internal/warnings.h"
 
+#ifdef STACKLESS
+#include "core/stackless_pystate.h"
+#endif
 
 /* GIL state */
 

Makefile.pre.in

@@ -1047,6 +1047,7 @@ PYTHON_HEADERS= \
 		$(srcdir)/Stackless/core/stackless_impl.h \
 		$(srcdir)/Stackless/core/stackless_structs.h \
 		$(srcdir)/Stackless/core/stackless_tstate.h \
+		$(srcdir)/Stackless/core/stackless_pystate.h \
 		$(srcdir)/Stackless/module/channelobject.h \
 		$(srcdir)/Stackless/pickling/prickelpit.h \
 		$(srcdir)/Stackless/platf/slp_platformselect.h \

PCbuild/pythoncore.vcxproj

@@ -219,6 +219,7 @@
     <ClInclude Include="..\Stackless\core\stackless_methods.h" />
     <ClInclude Include="..\Stackless\core\stackless_structs.h" />
     <ClInclude Include="..\Stackless\core\stackless_tstate.h" />
+    <ClInclude Include="..\Stackless\core\stackless_pystate.h" />
     <ClInclude Include="..\Stackless\module\channelobject.h" />
     <ClInclude Include="..\Stackless\pickling\prickelpit.h" />
     <ClInclude Include="..\Stackless\platf\slp_platformselect.h" />

PCbuild/pythoncore.vcxproj.filters

@@ -474,6 +474,9 @@
     <ClInclude Include="..\Stackless\core\stackless_tstate.h">
       <Filter>Stackless\core</Filter>
     </ClInclude>
+    <ClInclude Include="..\Stackless\core\stackless_pystate.h">
+      <Filter>Stackless\core</Filter>
+    </ClInclude>
     <ClInclude Include="..\Stackless\module\channelobject.h">
       <Filter>Stackless\module</Filter>
     </ClInclude>

Stackless/core/stackless_pystate.h

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2018 Anselm Kruis <[email protected]>
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+/* This include file is included from internal/pystate.h only */
+
+#include "platf/slp_platformselect.h"  /* for CSTACK_SLOTS */
+
+/*
+ * Stackless runtime state
+ *
+ * Initialized by
+ * void slp_initialize(struct _stackless_runtime_state * state)
+ * in stackless_util.c
+ */
+struct _stackless_runtime_state {
+    /*
+     * flag whether the next call should try to be stackless.
+     * The protocol is: This flag may be only set if the called
+     * thing supports it. It doesn't matter whether it uses the
+     * chance, but it *must* set it to zero before returning.
+     * This flags in a way serves as a parameter that we don't have.
+     *
+     * As long as the GIL is shared between sub-interpreters,
+     * try_stackless can be a field in the runtime state.
+     */
+    int try_stackless;
+
+    /* Used to manage free C-stack objects, see stacklesseval.c */
+    int cstack_cachecount;
+    struct _cstack *cstack_cache[CSTACK_SLOTS];
+
+    /*
+     * Used during a hard switch.
+     */
+    struct {
+        struct _cstack **cstprev;
+        struct _cstack *cst;
+        struct _tasklet *prev;
+    } transfer;
+};
+
+#ifdef Py_BUILD_CORE
+void slp_initialize(struct _stackless_runtime_state *);
+#endif /* #ifdef Py_BUILD_CORE */

Stackless/core/stackless_tstate.h

@@ -1,8 +1,6 @@
-#ifndef Py_LIMITED_API
+/* This include file is included from pystate.h only */
 
-#ifdef Py_BUILD_CORE
-#include "platf/slp_platformselect.h"
-#endif
+#ifndef Py_LIMITED_API
 
 /*** addition to tstate ***/
 #ifdef Py_DEBUG
@@ -187,41 +185,5 @@ void slp_kill_tasks_with_stacks(struct _ts *tstate);
     tstate->st.thread.is_blocked = 0; \
     tstate->st.thread.is_idle = 0;
 
-/*
- * Stackless runtime state
- *
- * Initialized by
- * void slp_initialize(struct _stackless_runtime_state * state)
- * in stackless_util.c
- */
-struct _stackless_runtime_state {
-    /*
-     * flag whether the next call should try to be stackless.
-     * The protocol is: This flag may be only set if the called
-     * thing supports it. It doesn't matter whether it uses the
-     * chance, but it *must* set it to zero before returning.
-     * This flags in a way serves as a parameter that we don't have.
-     *
-     * As long as the GIL is shared between sub-interpreters,
-     * try_stackless can be a field in the runtime state.
-     */
-    int try_stackless;
-
-    /* Used to manage free C-stack objects, see stacklesseval.c */
-    int cstack_cachecount;
-    struct _cstack *cstack_cache[CSTACK_SLOTS];
-
-    /*
-     * Used during a hard switch.
-     */
-    struct {
-        struct _cstack **cstprev;
-        struct _cstack *cst;
-        struct _tasklet *prev;
-    } transfer;
-};
-
-void slp_initialize(struct _stackless_runtime_state *);
-
 #endif /* #ifdef Py_BUILD_CORE */
 #endif /* #ifndef Py_LIMITED_API */

Tools/msi/dev/dev_files.wxs

@@ -63,7 +63,7 @@
             <?endforeach ?>
 
             <!-- Stackless\core\*.h -->
-            <?foreach header in cframeobject.h;slp_exttype.h;stackless_impl.h;stackless_methods.h;stackless_structs.h;stackless_tstate.h?>
+            <?foreach header in cframeobject.h;slp_exttype.h;stackless_impl.h;stackless_methods.h;stackless_structs.h;stackless_tstate.h;stackless_pystate.h?>
                 <Component Id="include_Stackless_core_$(var.header)" Directory="include_Stackless_core" Guid="*">
                     <File Id="include_Stackless_core_$(var.header)" Name="$(var.header)" Source="!(bindpath.src)Stackless\core\$(var.header)" />
                 </Component>