Stackless issue python#185: various cleanups

Move type definitions to stackless_structs.h
Move API declarations to stackless_api.h
Move declarations of pickle functions to prickelpit.h
Include frameobject.h only if needed.

Author: Anselm Kruis

Modules/_pickle.c

@@ -10,12 +10,9 @@
 
 #ifdef STACKLESS
 #define SLP_BUILD_CORE
-#include "core/stackless_impl.h"
+#include "stackless_api.h"
+#include "pickling/prickelpit.h"
 #include "platf/slp_platformselect.h" /* for stack saving */
-/* rename these because otherwise we will conflict with windows.h */
-#define FLOAT OP_FLOAT
-#define INT OP_INT
-#define LONG OP_LONG
 #endif
 
 PyDoc_STRVAR(pickle_module_doc,

Stackless/core/slp_transfer.c

@@ -1,18 +1,8 @@
-
 #include "Python.h"
 #include <stddef.h> /* For ptrdiff_t */
 
 #ifdef STACKLESS
 
-#ifndef STACKLESS
-**********
-If you see this error message,
-your operating system is not supported yet.
-Please provide an implementation of the switch_XXX.h
-or disable the STACKLESS flag.
-**********
-#endif
-
 #include "stackless_impl.h"
 
 /*
@@ -51,6 +41,15 @@ or disable the STACKLESS flag.
 #endif
 #include "platf/slp_platformselect.h"
 
+#ifndef STACKLESS
+**********
+If you see this error message,
+your operating system is not supported yet.
+Please provide an implementation of the switch_XXX.h
+or disable the STACKLESS flag.
+**********
+#endif
+
 SLP_DO_NOT_OPTIMIZE_AWAY_DEFINITIONS
 
 #ifdef EXTERNAL_ASM

Stackless/core/stackless_impl.h

@@ -7,39 +7,19 @@
 extern "C" {
 #endif
 
+#ifdef STACKLESS
+
 #if defined(Py_BUILD_CORE) && !defined(SLP_BUILD_CORE)
 #define SLP_BUILD_CORE
 #endif
 
-#ifdef STACKLESS
-
-#ifdef Py_BUILD_CORE
-#include "internal/pystate.h"  /* for _PyRuntime */
-#endif /* #ifdef Py_BUILD_CORE */
-
-#include "core/stackless_structs.h"
 #include "stackless_api.h"
 
-/* CPython added these two macros in object.h for 2.7 and 3.5 */
-#ifndef Py_SETREF
-#define Py_SETREF(op, op2)                      \
-    do {                                        \
-        PyObject *_py_tmp = (PyObject *)(op);   \
-        (op) = (op2);                           \
-        Py_DECREF(_py_tmp);                     \
-    } while (0)
-#endif
+#ifdef SLP_BUILD_CORE
 
-#ifndef Py_XSETREF
-#define Py_XSETREF(op, op2)                     \
-    do {                                        \
-        PyObject *_py_tmp = (PyObject *)(op);   \
-        (op) = (op2);                           \
-        Py_XDECREF(_py_tmp);                    \
-    } while (0)
+#ifdef Py_BUILD_CORE
+#include "internal/pystate.h"  /* for _PyRuntime */
 #endif
-
-#ifdef SLP_BUILD_CORE
 #include "pickling/prickelpit.h"
 
 #undef STACKLESS_SPY
@@ -405,22 +385,6 @@ PyObject * slp_tp_init_callback(PyFrameObject *f, int exc, PyObject *retval);
 /* functions related to pickling */
 PyObject * slp_reduce_frame(PyFrameObject * frame);
 
-/* rebirth of software stack avoidance */
-
-typedef struct _unwindobject {
-    PyObject_HEAD
-} PyUnwindObject;
-
-#else /* #ifdef SLP_BUILD_CORE */
-
-typedef struct _unwindobject PyUnwindObject;
-
-#endif /* #ifdef SLP_BUILD_CORE */
-
-PyAPI_DATA(PyUnwindObject *) Py_UnwindToken;
-
-#ifdef SLP_BUILD_CORE
-
 /* frame cloning both needed in tasklets and generators */
 
 struct _frame * slp_clone_frame(struct _frame *f);
@@ -443,12 +407,10 @@ PyTaskletObject * slp_get_watchdog(PyThreadState *ts, int interrupt);
      retval = (tstate)->st.unwinding_retval, \
      (tstate)->st.unwinding_retval = NULL, retval))
 
-#endif /* #ifdef SLP_BUILD_CORE */
-
+#if 0 /* defined in stackless_api.h */
 #define STACKLESS_UNWINDING(obj) \
     ((PyObject *) (obj) == (PyObject *) Py_UnwindToken)
-
-#ifdef SLP_BUILD_CORE
+#endif
 
 /* an arbitrary positive number */
 #define STACKLESS_UNWINDING_MAGIC 0x7fedcba9
@@ -757,17 +719,6 @@ PyObject * slp_runtime_error(const char *msg);
 PyObject * slp_value_error(const char *msg);
 PyObject * slp_null_error(void);
 
-/* this seems to be needed for gcc */
-
-/* Define NULL pointer value */
-
-#undef NULL
-#ifdef  __cplusplus
-#define NULL    0
-#else
-#define NULL    ((void *)0)
-#endif
-
 #define TYPE_ERROR(str, ret) return (slp_type_error(str), ret)
 #define RUNTIME_ERROR(str, ret) return (slp_runtime_error(str), ret)
 #define VALUE_ERROR(str, ret) return (slp_value_error(str), ret)
@@ -790,11 +741,6 @@ int slp_resurrect_and_kill(PyObject *self,
                            void(*killer)(PyObject *));
 
 /* stackless pickling support */
-int slp_safe_pickling(int(*save)(PyObject *, PyObject *, int),
-                      PyObject *self, PyObject *args,
-                     int pers_save);
-
-PyObject * PyStackless_Pickle_ModuleDict(PyObject *pickler, PyObject *self);
 int slp_async_gen_init_hooks(PyAsyncGenObject *o);
 PyObject * slp_async_gen_asend_reduce(PyObject *o, PyTypeObject * wrapper_type);
 PyObject * slp_async_gen_asend_new(PyAsyncGenObject *gen);

Stackless/core/stackless_structs.h

@@ -5,15 +5,17 @@
 extern "C" {
 #endif
 
+#ifdef STACKLESS
+
 #if defined(Py_BUILD_CORE) && !defined(SLP_BUILD_CORE)
 #define SLP_BUILD_CORE
 #endif
 
-#include "frameobject.h"
-
-#ifdef STACKLESS
 #ifdef SLP_BUILD_CORE
 
+#include "frameobject.h"
+#include "platf/slp_platformselect.h"
+
 /*** important structures: tasklet ***/
 
 
@@ -148,10 +150,24 @@ typedef struct _cstack {
     int nesting_level;
     PyThreadState *tstate;
 #ifdef _SEH32
-    DWORD exception_list; /* SEH handler on Win32 */
+	/* SEH handler on Win32
+	 * The correct type is DWORD, but we do not want to include <windows.h>.
+	 * Instead we use a compile time assertion to ensure, that we use an
+	 * equivalent type.
+	 */
+    unsigned long exception_list;
 #endif
     intptr_t *startaddr;
-    intptr_t stack[1];
+    intptr_t stack[
+#if defined(_WINDOWS_) && defined(_SEH32)
+		/* Assert the equivalence of DWORD and unsigned long. If <windows.h>
+		 * is included, _WINDOWS_ is defined.
+		 * Py_BUILD_ASSERT_EXPR needs an expression and this is the only one.
+		 */
+		Py_BUILD_ASSERT_EXPR(sizeof(unsigned long) == sizeof(DWORD)) +
+		Py_BUILD_ASSERT_EXPR(((DWORD)-1) > 0) + /* signedness */
+#endif
+		1];
 } PyCStackObject;
 
 
@@ -239,6 +255,9 @@ typedef struct _cframe {
     void *any2;
 } PyCFrameObject;
 
+typedef struct _unwindobject {
+    PyObject_HEAD
+} PyUnwindObject;
 
 
 /*** associated type objects ***/
@@ -266,6 +285,7 @@ PyAPI_DATA(PyTypeObject) PyChannel_Type;
 typedef struct _channel PyChannelObject;
 typedef struct _cframe  PyCFrameObject;
 typedef struct _tasklet PyTaskletObject;
+typedef struct _unwindobject PyUnwindObject;
 
 #endif /* #ifdef SLP_BUILD_CORE */
 #endif /* #ifdef STACKLESS */

Stackless/core/stackless_tstate.h

@@ -36,6 +36,7 @@ typedef struct {
     uint8_t pickleflags;                        /* flags for pickling / unpickling */
 } PyStacklessInterpreterState;
 
+#ifdef Py_BUILD_CORE
 #define SLP_INITIAL_TSTATE(tstate) \
     (assert(tstate), \
      assert((tstate)->interp->st.initial_tstate), \
@@ -64,6 +65,8 @@ typedef struct {
     (interp)->st.enable_softswitch = 1;        \
     (interp)->st.pickleflags = 0;
 
+#endif /* #ifdef Py_BUILD_CORE */
+
 struct _frame; /* Avoid including frameobject.h */
 
 typedef struct _sts {

Stackless/module/_teststackless.c

@@ -16,6 +16,7 @@
  */
 
 #include "Python.h"
+#include "frameobject.h"
 #include "stackless_api.h"
 #ifdef MS_WINDOWS
 #include "malloc.h" /* for alloca */

Stackless/pickling/prickelpit.h

@@ -54,11 +54,19 @@ Py_ssize_t slp_from_tuple_with_nulls(PyObject **start, PyObject *tup);
 
 PyObject * slp_pickle_moduledict(PyObject *self, PyObject *args);
 extern char slp_pickle_moduledict__doc__[];
+PyObject * PyStackless_Pickle_ModuleDict(PyObject *pickler, PyObject *self);
 
 /* initialization */
 
 PyObject *slp_init_prickelpit(void);
 
+/* pickle with stack spilling */
+int slp_safe_pickling(int(*save)(PyObject *, PyObject *, int),
+                      PyObject *self, PyObject *args,
+                     int pers_save);
+
+
+
 #ifdef __cplusplus
 }
 #endif

Stackless/stackless_api.h

@@ -34,9 +34,10 @@ extern "C" {
 
  ******************************************************/
 
-#include "core/stackless_impl.h"
-
 #ifdef STACKLESS
+
+#include "core/stackless_structs.h"
+
 /*
  * create a new tasklet object.
  * type must be derived from PyTasklet_Type or NULL.
@@ -394,6 +395,20 @@ PyAPI_FUNC(int) PyStackless_SetScheduleCallback(PyObject *callable);
  */
 PyAPI_FUNC(void) PyStackless_SetScheduleFastcallback(slp_schedule_hook_func func);
 
+/******************************************************
+
+  other functions
+
+ ******************************************************/
+
+
+/*
+ * Stack unwinding
+ */
+PyAPI_DATA(PyUnwindObject *) Py_UnwindToken;
+#define STACKLESS_UNWINDING(obj) \
+    ((PyObject *) (obj) == (PyObject *) Py_UnwindToken)
+
 /******************************************************
 
   interface functions