[Python-checkins] gh-79315: Add Include/cpython/pythread.h header (#91798)
vstinner
webhook-mailer at python.org
Thu Apr 21 17:00:47 EDT 2022
https://github.com/python/cpython/commit/8a4e519e7822d17ce062f55ba68e13bfeaf450de
commit: 8a4e519e7822d17ce062f55ba68e13bfeaf450de
branch: main
author: Victor Stinner <vstinner at python.org>
committer: vstinner <vstinner at python.org>
date: 2022-04-21T23:00:42+02:00
summary:
gh-79315: Add Include/cpython/pythread.h header (#91798)
files:
A Include/cpython/pythread.h
M Include/pythread.h
M Makefile.pre.in
M PCbuild/pythoncore.vcxproj
M PCbuild/pythoncore.vcxproj.filters
diff --git a/Include/cpython/pythread.h b/Include/cpython/pythread.h
new file mode 100644
index 0000000000000..1fd86a6a90f9a
--- /dev/null
+++ b/Include/cpython/pythread.h
@@ -0,0 +1,39 @@
+#ifndef Py_CPYTHON_PYTHREAD_H
+# error "this header file must not be included directly"
+#endif
+
+#define PYTHREAD_INVALID_THREAD_ID ((unsigned long)-1)
+
+#ifdef HAVE_FORK
+/* Private function to reinitialize a lock at fork in the child process.
+ Reset the lock to the unlocked state.
+ Return 0 on success, return -1 on error. */
+PyAPI_FUNC(int) _PyThread_at_fork_reinit(PyThread_type_lock *lock);
+#endif /* HAVE_FORK */
+
+#ifdef HAVE_PTHREAD_H
+ /* Darwin needs pthread.h to know type name the pthread_key_t. */
+# include <pthread.h>
+# define NATIVE_TSS_KEY_T pthread_key_t
+#elif defined(NT_THREADS)
+ /* In Windows, native TSS key type is DWORD,
+ but hardcode the unsigned long to avoid errors for include directive.
+ */
+# define NATIVE_TSS_KEY_T unsigned long
+#else
+# error "Require native threads. See https://bugs.python.org/issue31370"
+#endif
+
+/* When Py_LIMITED_API is not defined, the type layout of Py_tss_t is
+ exposed to allow static allocation in the API clients. Even in this case,
+ you must handle TSS keys through API functions due to compatibility.
+*/
+struct _Py_tss_t {
+ int _is_initialized;
+ NATIVE_TSS_KEY_T _key;
+};
+
+#undef NATIVE_TSS_KEY_T
+
+/* When static allocation, you must initialize with Py_tss_NEEDS_INIT. */
+#define Py_tss_NEEDS_INIT {0}
diff --git a/Include/pythread.h b/Include/pythread.h
index 034e660551531..a48329085fac5 100644
--- a/Include/pythread.h
+++ b/Include/pythread.h
@@ -1,4 +1,3 @@
-
#ifndef Py_PYTHREAD_H
#define Py_PYTHREAD_H
@@ -16,10 +15,6 @@ typedef enum PyLockStatus {
PY_LOCK_INTR
} PyLockStatus;
-#ifndef Py_LIMITED_API
-#define PYTHREAD_INVALID_THREAD_ID ((unsigned long)-1)
-#endif
-
PyAPI_FUNC(void) PyThread_init_thread(void);
PyAPI_FUNC(unsigned long) PyThread_start_new_thread(void (*)(void *), void *);
PyAPI_FUNC(void) _Py_NO_RETURN PyThread_exit_thread(void);
@@ -36,15 +31,6 @@ PyAPI_FUNC(int) PyThread_acquire_lock(PyThread_type_lock, int);
#define WAIT_LOCK 1
#define NOWAIT_LOCK 0
-#ifndef Py_LIMITED_API
-#ifdef HAVE_FORK
-/* Private function to reinitialize a lock at fork in the child process.
- Reset the lock to the unlocked state.
- Return 0 on success, return -1 on error. */
-PyAPI_FUNC(int) _PyThread_at_fork_reinit(PyThread_type_lock *lock);
-#endif /* HAVE_FORK */
-#endif /* !Py_LIMITED_API */
-
/* PY_TIMEOUT_T is the integral type used to specify timeouts when waiting
on a lock (see PyThread_acquire_lock_timed() below).
PY_TIMEOUT_MAX is the highest usable value (in microseconds) of that
@@ -124,35 +110,6 @@ Py_DEPRECATED(3.7) PyAPI_FUNC(void) PyThread_ReInitTLS(void);
typedef struct _Py_tss_t Py_tss_t; /* opaque */
-#ifndef Py_LIMITED_API
-#ifdef HAVE_PTHREAD_H
- /* Darwin needs pthread.h to know type name the pthread_key_t. */
-# include <pthread.h>
-# define NATIVE_TSS_KEY_T pthread_key_t
-#elif defined(NT_THREADS)
- /* In Windows, native TSS key type is DWORD,
- but hardcode the unsigned long to avoid errors for include directive.
- */
-# define NATIVE_TSS_KEY_T unsigned long
-#else
-# error "Require native threads. See https://bugs.python.org/issue31370"
-#endif
-
-/* When Py_LIMITED_API is not defined, the type layout of Py_tss_t is
- exposed to allow static allocation in the API clients. Even in this case,
- you must handle TSS keys through API functions due to compatibility.
-*/
-struct _Py_tss_t {
- int _is_initialized;
- NATIVE_TSS_KEY_T _key;
-};
-
-#undef NATIVE_TSS_KEY_T
-
-/* When static allocation, you must initialize with Py_tss_NEEDS_INIT. */
-#define Py_tss_NEEDS_INIT {0}
-#endif /* !Py_LIMITED_API */
-
PyAPI_FUNC(Py_tss_t *) PyThread_tss_alloc(void);
PyAPI_FUNC(void) PyThread_tss_free(Py_tss_t *key);
@@ -164,8 +121,13 @@ PyAPI_FUNC(int) PyThread_tss_set(Py_tss_t *key, void *value);
PyAPI_FUNC(void *) PyThread_tss_get(Py_tss_t *key);
#endif /* New in 3.7 */
+#ifndef Py_LIMITED_API
+# define Py_CPYTHON_PYTHREAD_H
+# include "cpython/pythread.h"
+# undef Py_CPYTHON_PYTHREAD_H
+#endif
+
#ifdef __cplusplus
}
#endif
-
#endif /* !Py_PYTHREAD_H */
diff --git a/Makefile.pre.in b/Makefile.pre.in
index 991d69815b2da..04a371ddff72f 100644
--- a/Makefile.pre.in
+++ b/Makefile.pre.in
@@ -1559,6 +1559,7 @@ PYTHON_HEADERS= \
$(srcdir)/Include/cpython/pymem.h \
$(srcdir)/Include/cpython/pystate.h \
$(srcdir)/Include/cpython/pythonrun.h \
+ $(srcdir)/Include/cpython/pythread.h \
$(srcdir)/Include/cpython/pytime.h \
$(srcdir)/Include/cpython/setobject.h \
$(srcdir)/Include/cpython/sysmodule.h \
diff --git a/PCbuild/pythoncore.vcxproj b/PCbuild/pythoncore.vcxproj
index 189510a10c6ea..78bbec1e104e4 100644
--- a/PCbuild/pythoncore.vcxproj
+++ b/PCbuild/pythoncore.vcxproj
@@ -171,6 +171,7 @@
<ClInclude Include="..\Include\cpython\pymem.h" />
<ClInclude Include="..\Include\cpython\pystate.h" />
<ClInclude Include="..\Include\cpython\pythonrun.h" />
+ <ClInclude Include="..\Include\cpython\pythread.h" />
<ClInclude Include="..\Include\cpython\pytime.h" />
<ClInclude Include="..\Include\cpython\setobject.h" />
<ClInclude Include="..\Include\cpython\sysmodule.h" />
diff --git a/PCbuild/pythoncore.vcxproj.filters b/PCbuild/pythoncore.vcxproj.filters
index 1ed52a776ca36..0a9d5454ba957 100644
--- a/PCbuild/pythoncore.vcxproj.filters
+++ b/PCbuild/pythoncore.vcxproj.filters
@@ -459,6 +459,9 @@
<ClInclude Include="..\Include\cpython\pythonrun.h">
<Filter>Include\cpython</Filter>
</ClInclude>
+ <ClInclude Include="..\Include\cpython\pythread.h">
+ <Filter>Include\cpython</Filter>
+ </ClInclude>
<ClInclude Include="..\Include\cpython\setobject.h">
<Filter>Include\cpython</Filter>
</ClInclude>
More information about the Python-checkins
mailing list