Stackless issue python#295: add prefix "_slp" to structure names

akruis · akruis · commit 9f4e976c0ccf · 2021-08-01T14:36:55.000+02:00
Add prefix "_slp" to structure names without a prefix. The following structs
were renamed: _channel, _cframe, _tasklet, _unwindobject and _bomb.
This fixes a build failure on Windows.
diff --git a/Include/cpython/slp_structs.h b/Include/cpython/slp_structs.h
@@ -91,7 +91,7 @@ extern "C" {
 #define SLP_TASKLET_FLAGS_OFFSET_pending_irq \
     (SLP_TASKLET_FLAGS_OFFSET_is_zombie + SLP_TASKLET_FLAGS_BITS_is_zombie)
 
-typedef struct _tasklet_flags {
+typedef struct _slp_tasklet_flags {
     signed int blocked: SLP_TASKLET_FLAGS_BITS_blocked;
     unsigned int atomic: SLP_TASKLET_FLAGS_BITS_atomic;
     unsigned int ignore_nesting: SLP_TASKLET_FLAGS_BITS_ignore_nesting;
@@ -101,16 +101,16 @@ typedef struct _tasklet_flags {
     unsigned int pending_irq: SLP_TASKLET_FLAGS_BITS_pending_irq;
 } PyTaskletFlagStruc;
 
-typedef struct _tasklet {
+typedef struct _slp_tasklet {
     PyObject_HEAD
-    struct _tasklet *next;
-    struct _tasklet *prev;
+    struct _slp_tasklet *next;
+    struct _slp_tasklet *prev;
     union {
         struct _frame *frame;
         struct _cframe *cframe;
     } f;
     PyObject *tempval;
-    struct _cstack *cstate;
+    struct _slp_cstack *cstate;
     /* Pointer to the top of the stack of the exceptions currently
      * being handled */
     _PyErr_StackItem *exc_info;
@@ -119,7 +119,7 @@ typedef struct _tasklet {
      */
     _PyErr_StackItem exc_state;
     /* bits stuff */
-    struct _tasklet_flags flags;
+    struct _slp_tasklet_flags flags;
     int recursion_depth;
     PyObject *def_globals;
     PyObject *tsk_weakreflist;
@@ -142,15 +142,15 @@ typedef struct _tasklet {
 
 /*** important structures: cstack ***/
 
-typedef struct _cstack {
+typedef struct _slp_cstack {
     PyObject_VAR_HEAD
-    struct _cstack *next;
-    struct _cstack *prev;
+    struct _slp_cstack *next;
+    struct _slp_cstack *prev;
     PY_LONG_LONG serial;
     /* A borrowed reference to the tasklet, that owns this cstack. NULL after
      * the stack has been restored. Always NULL for an initial stub.
      */
-    struct _tasklet *task;
+    struct _slp_tasklet *task;
     int nesting_level;
     PyThreadState *tstate;
 #ifdef SLP_SEH32
@@ -179,7 +179,7 @@ typedef struct _cstack {
 
 /*** important structures: bomb ***/
 
-typedef struct _bomb {
+typedef struct _slp_bomb {
     PyObject_HEAD
     PyObject *curexc_type;
     PyObject *curexc_value;
@@ -221,24 +221,24 @@ typedef struct _bomb {
 #define SLP_CHANNEL_FLAGS_OFFSET_schedule_all \
     (SLP_CHANNEL_FLAGS_OFFSET_preference + SLP_CHANNEL_FLAGS_BITS_preference)
 
-typedef struct _channel_flags {
+typedef struct _slp_channel_flags {
     unsigned int closing: SLP_CHANNEL_FLAGS_BITS_closing;
     signed int preference: SLP_CHANNEL_FLAGS_BITS_preference;
     unsigned int schedule_all: SLP_CHANNEL_FLAGS_BITS_schedule_all;
 } PyChannelFlagStruc;
 
-typedef struct _channel {
+typedef struct _slp_channel {
     PyObject_HEAD
     /* make sure that these fit tasklet's next/prev */
-    struct _tasklet *head;
-    struct _tasklet *tail;
+    struct _slp_tasklet *head;
+    struct _slp_tasklet *tail;
     int balance;
-    struct _channel_flags flags;
+    struct _slp_channel_flags flags;
     PyObject *chan_weakreflist;
 } PyChannelObject;
 
-struct _cframe;
-typedef PyObject *(PyFrame_ExecFunc) (struct _cframe *, int, PyObject *);
+struct _slp_cframe;
+typedef PyObject *(PyFrame_ExecFunc) (struct _slp_cframe *, int, PyObject *);
 /*
  * How to write frame execution functions:
  *
@@ -259,7 +259,7 @@ typedef PyObject *(PyFrame_ExecFunc) (struct _cframe *, int, PyObject *);
 
 /*** important stuctures: cframe ***/
 
-typedef struct _cframe {
+typedef struct _slp_cframe {
     PyObject_VAR_HEAD
     struct _frame *f_back;      /* previous frame, or NULL */
 
@@ -278,18 +278,18 @@ typedef struct _cframe {
     void *any2;
 } PyCFrameObject;
 
-typedef struct _unwindobject {
+typedef struct _slp_unwindobject {
     PyObject_HEAD
 } PyUnwindObject;
 
 
 #else /* #ifdef SLP_BUILD_CORE */
 
-typedef struct _channel PyChannelObject;
-typedef struct _cframe  PyCFrameObject;
-typedef struct _tasklet PyTaskletObject;
-typedef struct _unwindobject PyUnwindObject;
-typedef struct _bomb PyBombObject;
+typedef struct _slp_channel PyChannelObject;
+typedef struct _slp_cframe  PyCFrameObject;
+typedef struct _slp_tasklet PyTaskletObject;
+typedef struct _slp_unwindobject PyUnwindObject;
+typedef struct _slp_bomb PyBombObject;
 
 #endif /* #ifdef SLP_BUILD_CORE */
 
diff --git a/Include/cpython/slp_tstate.h b/Include/cpython/slp_tstate.h
@@ -3,12 +3,12 @@
 #ifndef Py_LIMITED_API
 
 /* forward declarations */
-struct _cstack;
-struct _bomb;
-struct _tasklet;
+struct _slp_cstack;
+struct _slp_bomb;
+struct _slp_tasklet;
 struct _ts;
 
-typedef int (slp_schedule_hook_func) (struct _tasklet *from, struct _tasklet *to);
+typedef int (slp_schedule_hook_func) (struct _slp_tasklet *from, struct _slp_tasklet *to);
 
 struct _frame; /* Avoid including frameobject.h */
 
@@ -22,15 +22,15 @@ typedef struct _sts {
     PY_LONG_LONG serial;
     PY_LONG_LONG serial_last_jump;
     /* the blueprint for new stacks */
-    struct _cstack *initial_stub;
+    struct _slp_cstack *initial_stub;
     /* the base address for hijacking stacks. XXX deprecating */
     intptr_t *cstack_base;
     /* stack overflow check and init flag */
     intptr_t *cstack_root;
     /* main tasklet */
-    struct _tasklet *main;
+    struct _slp_tasklet *main;
     /* runnable tasklets */
-    struct _tasklet *current;
+    struct _slp_tasklet *current;
 
     /* scheduling */
     long tick_counter;
diff --git a/Include/internal/pycore_slp_pystate.h b/Include/internal/pycore_slp_pystate.h
@@ -27,11 +27,11 @@
 #endif
 
 typedef struct {
-    struct _cstack * cstack_chain;              /* the chain of all C-stacks of this interpreter. This is an uncounted/borrowed ref. */
+    struct _slp_cstack * cstack_chain;          /* the chain of all C-stacks of this interpreter. This is an uncounted/borrowed ref. */
     PyObject * reduce_frame_func;               /* a function used to pickle frames */
     PyObject * error_handler;                   /* the Stackless error handler */
     PyObject * channel_hook;                    /* the channel callback function */
-    struct _bomb * mem_bomb;                    /* a permanent bomb to use for memory errors */
+    struct _slp_bomb * mem_bomb;                /* a permanent bomb to use for memory errors */
     PyObject * schedule_hook;                   /* the schedule callback function */
     slp_schedule_hook_func * schedule_fasthook; /* the fast C-only schedule_hook */
     struct _ts * initial_tstate;                /* recording the main thread state */
@@ -83,15 +83,15 @@ struct _stackless_runtime_state {
 
     /* Used to manage free C-stack objects, see stacklesseval.c */
     int cstack_cachecount;
-    struct _cstack *cstack_cache[SLP_CSTACK_SLOTS];
+    struct _slp_cstack *cstack_cache[SLP_CSTACK_SLOTS];
 
     /*
      * Used during a hard switch.
      */
     struct {
-        struct _cstack **cstprev;
-        struct _cstack *cst;
-        struct _tasklet *prev;
+        struct _slp_cstack **cstprev;
+        struct _slp_cstack *cst;
+        struct _slp_tasklet *prev;
     } transfer;
 };
 
diff --git a/Stackless/changelog.txt b/Stackless/changelog.txt
@@ -9,6 +9,10 @@ What's New in Stackless 3.X.X?
 
 *Release date: 20XX-XX-XX*
 
+- https://github.com/stackless-dev/stackless/issues/295
+  Add prefix "_slp" to structure names without a prefix. The following structs
+  were renamed: _channel, _cframe, _tasklet, _unwindobject and _bomb.
+
 - https://github.com/stackless-dev/stackless/issues/290
   The newly added PEP-590 Vectorcall protocol (bpo-36974) requires changes to
   the Stackless protocol. The new mcros STACKLESS_VECTORCALL_xxx() must be used
