/* Tagged pointer to top-most critical section, or zero if there is no
* active critical section. Critical sections are only used in
- * `--disable-gil` builds (i.e., when Py_NOGIL is defined to 1). In the
+ * `--disable-gil` builds (i.e., when Py_GIL_DISABLED is defined to 1). In the
* default build, this field is always zero.
*/
uintptr_t critical_section;
#define _Py_CRITICAL_SECTION_TWO_MUTEXES 0x2
#define _Py_CRITICAL_SECTION_MASK 0x3
-#ifdef Py_NOGIL
+#ifdef Py_GIL_DISABLED
# define Py_BEGIN_CRITICAL_SECTION(op) \
{ \
_PyCriticalSection _cs; \
# define Py_END_CRITICAL_SECTION2() \
_PyCriticalSection2_End(&_cs2); \
}
-#else /* !Py_NOGIL */
+#else /* !Py_GIL_DISABLED */
// The critical section APIs are no-ops with the GIL.
# define Py_BEGIN_CRITICAL_SECTION(op)
# define Py_END_CRITICAL_SECTION()
# define Py_BEGIN_CRITICAL_SECTION2(a, b)
# define Py_END_CRITICAL_SECTION2()
-#endif /* !Py_NOGIL */
+#endif /* !Py_GIL_DISABLED */
typedef struct {
// Tagged pointer to an outer active critical section (or 0).
# define PYD_DEBUG_SUFFIX ""
#endif
-#ifdef Py_NOGIL
+#ifdef Py_GIL_DISABLED
# define PYD_THREADING_TAG "t"
#else
# define PYD_THREADING_TAG ""
// ...
// PyMutex_Unlock(&m);
-// NOTE: In Py_NOGIL builds, `struct _PyMutex` is defined in Include/object.h.
-// The Py_NOGIL builds need the definition in Include/object.h for the
+// NOTE: In Py_GIL_DISABLED builds, `struct _PyMutex` is defined in Include/object.h.
+// The Py_GIL_DISABLED builds need the definition in Include/object.h for the
// `ob_mutex` field in PyObject. For the default (non-free-threaded) build,
// we define the struct here to avoid exposing it in the public API.
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
struct _PyMutex { uint8_t v; };
#endif
Furthermore, we can't use designated initializers in Extensions since these
are not supported pre-C++20. Thus, keeping an internal copy here is the most
backwards compatible solution */
-#if defined(Py_NOGIL)
+#if defined(Py_GIL_DISABLED)
#define _PyObject_HEAD_INIT(type) \
{ \
.ob_ref_local = _Py_IMMORTAL_REFCNT_LOCAL, \
#ifdef Py_REF_DEBUG
_Py_AddRefTotal(_PyInterpreterState_GET(), n);
#endif
-#if !defined(Py_NOGIL)
+#if !defined(Py_GIL_DISABLED)
op->ob_refcnt += n;
#else
if (_Py_IsOwnedByCurrentThread(op)) {
static inline void _Py_SetImmortal(PyObject *op)
{
if (op) {
-#ifdef Py_NOGIL
+#ifdef Py_GIL_DISABLED
op->ob_tid = _Py_UNOWNED_TID;
op->ob_ref_local = _Py_IMMORTAL_REFCNT_LOCAL;
op->ob_ref_shared = 0;
{
if (op) {
assert(_Py_IsImmortal(op));
-#ifdef Py_NOGIL
+#ifdef Py_GIL_DISABLED
op->ob_tid = _Py_UNOWNED_TID;
op->ob_ref_local = 0;
op->ob_ref_shared = _Py_REF_SHARED(refcnt, _Py_REF_MERGED);
op = NULL; \
} while (0)
-#if !defined(Py_NOGIL)
+#if !defined(Py_GIL_DISABLED)
static inline void
_Py_DECREF_SPECIALIZED(PyObject *op, const destructor destruct)
{
}
#else
-// TODO: implement Py_DECREF specializations for Py_NOGIL build
+// TODO: implement Py_DECREF specializations for Py_GIL_DISABLED build
static inline void
_Py_DECREF_SPECIALIZED(PyObject *op, const destructor destruct)
{
// Merge the local and shared reference count fields and add `extra` to the
// refcount when merging.
Py_ssize_t _Py_ExplicitMergeRefcount(PyObject *op, Py_ssize_t extra);
-#endif // !defined(Py_NOGIL)
+#endif // !defined(Py_GIL_DISABLED)
#ifdef Py_REF_DEBUG
# undef _Py_DEC_REFTOTAL
#define _Py_IMMORTAL_REFCNT (UINT_MAX >> 2)
#endif
-// Py_NOGIL builds indicate immortal objects using `ob_ref_local`, which is
+// Py_GIL_DISABLED builds indicate immortal objects using `ob_ref_local`, which is
// always 32-bits.
-#ifdef Py_NOGIL
+#ifdef Py_GIL_DISABLED
#define _Py_IMMORTAL_REFCNT_LOCAL UINT32_MAX
#endif
// Make all internal uses of PyObject_HEAD_INIT immortal while preserving the
// C-API expectation that the refcnt will be set to 1.
-#if defined(Py_NOGIL)
+#if defined(Py_GIL_DISABLED)
#define PyObject_HEAD_INIT(type) \
{ \
0, \
* by hand. Similarly every pointer to a variable-size Python object can,
* in addition, be cast to PyVarObject*.
*/
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
struct _object {
#if (defined(__GNUC__) || defined(__clang__)) \
&& !(defined __STDC_VERSION__ && __STDC_VERSION__ >= 201112L)
PyAPI_FUNC(int) Py_Is(PyObject *x, PyObject *y);
#define Py_Is(x, y) ((x) == (y))
-#if defined(Py_NOGIL) && !defined(Py_LIMITED_API)
+#if defined(Py_GIL_DISABLED) && !defined(Py_LIMITED_API)
static inline uintptr_t
_Py_ThreadId(void)
{
#endif
static inline Py_ssize_t Py_REFCNT(PyObject *ob) {
-#if !defined(Py_NOGIL)
+#if !defined(Py_GIL_DISABLED)
return ob->ob_refcnt;
#else
uint32_t local = _Py_atomic_load_uint32_relaxed(&ob->ob_ref_local);
static inline Py_ALWAYS_INLINE int _Py_IsImmortal(PyObject *op)
{
-#if defined(Py_NOGIL)
+#if defined(Py_GIL_DISABLED)
return op->ob_ref_local == _Py_IMMORTAL_REFCNT_LOCAL;
#elif SIZEOF_VOID_P > 4
return _Py_CAST(PY_INT32_T, op->ob_refcnt) < 0;
if (_Py_IsImmortal(ob)) {
return;
}
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
ob->ob_refcnt = refcnt;
#else
if (_Py_IsOwnedByCurrentThread(ob)) {
ob->ob_ref_local = 0;
ob->ob_ref_shared = _Py_REF_SHARED(refcnt, _Py_REF_MERGED);
}
-#endif // Py_NOGIL
+#endif // Py_GIL_DISABLED
#endif // Py_LIMITED_API+0 < 0x030d0000
}
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 < 0x030b0000
#else
// Non-limited C API and limited C API for Python 3.9 and older access
// directly PyObject.ob_refcnt.
-#if defined(Py_NOGIL)
+#if defined(Py_GIL_DISABLED)
uint32_t local = _Py_atomic_load_uint32_relaxed(&op->ob_ref_local);
uint32_t new_local = local + 1;
if (new_local == 0) {
#endif
-#if !defined(Py_LIMITED_API) && defined(Py_NOGIL)
+#if !defined(Py_LIMITED_API) && defined(Py_GIL_DISABLED)
// Implements Py_DECREF on objects not owned by the current thread.
PyAPI_FUNC(void) _Py_DecRefShared(PyObject *);
PyAPI_FUNC(void) _Py_DecRefSharedDebug(PyObject *, const char *, int);
}
#define Py_DECREF(op) Py_DECREF(_PyObject_CAST(op))
-#elif defined(Py_NOGIL) && defined(Py_REF_DEBUG)
+#elif defined(Py_GIL_DISABLED) && defined(Py_REF_DEBUG)
static inline void Py_DECREF(const char *filename, int lineno, PyObject *op)
{
uint32_t local = _Py_atomic_load_uint32_relaxed(&op->ob_ref_local);
}
#define Py_DECREF(op) Py_DECREF(__FILE__, __LINE__, _PyObject_CAST(op))
-#elif defined(Py_NOGIL)
+#elif defined(Py_GIL_DISABLED)
static inline void Py_DECREF(PyObject *op)
{
uint32_t local = _Py_atomic_load_uint32_relaxed(&op->ob_ref_local);
vars['BINLIBDEST'] = get_path('platstdlib')
vars['INCLUDEPY'] = get_path('include')
- # Add EXT_SUFFIX, SOABI, and Py_NOGIL
+ # Add EXT_SUFFIX, SOABI, and Py_GIL_DISABLED
vars.update(_sysconfig.config_vars())
vars['LIBDIR'] = _safe_realpath(os.path.join(get_config_var('installed_base'), 'libs'))
build = []
# --disable-gil
- if sysconfig.get_config_var('Py_NOGIL'):
+ if sysconfig.get_config_var('Py_GIL_DISABLED'):
build.append("nogil")
if hasattr(sys, 'gettotalrefcount'):
'PY_STDMODULE_CFLAGS',
'Py_DEBUG',
'Py_ENABLE_SHARED',
- 'Py_NOGIL',
+ 'Py_GIL_DISABLED',
'SHELL',
'SOABI',
'abs_builddir',
return any(option in cflags_nodist for option in pgo_options)
-if sysconfig.get_config_var('Py_NOGIL'):
+if sysconfig.get_config_var('Py_GIL_DISABLED'):
_header = 'PHBBInP'
else:
_header = 'nP'
# gh-110119: pip does not currently support 't' in the ABI flag use by
# --disable-gil builds. Once it does, we can remove this skip.
-@unittest.skipIf(sysconfig.get_config_var('Py_NOGIL') == 1,
+@unittest.skipIf(sysconfig.get_config_var('Py_GIL_DISABLED') == 1,
'test does not work with --disable-gil')
@support.requires_subprocess()
class TestCPPExt(unittest.TestCase):
class WindowsExtensionSuffixTests:
def test_tagged_suffix(self):
suffixes = self.machinery.EXTENSION_SUFFIXES
- abi_flags = "t" if sysconfig.get_config_var("Py_NOGIL") else ""
+ abi_flags = "t" if sysconfig.get_config_var("Py_GIL_DISABLED") else ""
ver = sys.version_info
platform = re.sub('[^a-zA-Z0-9]', '_', get_platform())
expected_tag = f".cp{ver.major}{ver.minor}{abi_flags}-{platform}.pyd"
@unittest.skipUnless(hasattr(sys, 'abiflags'), 'need sys.abiflags')
def test_disable_gil_abi(self):
abi_threaded = 't' in sys.abiflags
- py_nogil = (sysconfig.get_config_var('Py_NOGIL') == 1)
+ py_nogil = (sysconfig.get_config_var('Py_GIL_DISABLED') == 1)
self.assertEqual(py_nogil, abi_threaded)
--- /dev/null
+Rename ``Py_NOGIL`` to ``Py_GIL_DISABLED``. Patch by Hugo van Kemenade.
#ifndef _MSC_VER
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
#endif
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
// Need limited C API version 3.12 for Py_MOD_PER_INTERPRETER_GIL_SUPPORTED
#define Py_LIMITED_API 0x030c0000
#endif
posixshmem - A Python extension that provides shm_open() and shm_unlink()
*/
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
// Need limited C API version 3.12 for Py_MOD_PER_INTERPRETER_GIL_SUPPORTED
#define Py_LIMITED_API 0x030c0000
#endif
*/
#ifndef _MSC_VER
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
#endif
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
// Need limited C API version 3.12 for Py_MOD_PER_INTERPRETER_GIL_SUPPORTED
#define Py_LIMITED_API 0x030c0000
#endif
*/
#ifndef _MSC_VER
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
#endif
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
// Need limited C API version 3.13 for PyModule_Add() on Windows
#define Py_LIMITED_API 0x030d0000
#endif
}
#endif
-#ifdef Py_NOGIL
+#ifdef Py_GIL_DISABLED
PyObject *py_nogil = _PyLong_GetOne();
#else
PyObject *py_nogil = _PyLong_GetZero();
#endif
- if (PyDict_SetItemString(config, "Py_NOGIL", py_nogil) < 0) {
+ if (PyDict_SetItemString(config, "Py_GIL_DISABLED", py_nogil) < 0) {
Py_DECREF(config);
return NULL;
}
#ifndef _MSC_VER
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
#endif
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
#define Py_LIMITED_API 0x030c0000 // 3.12
#endif
/* Test Vectorcall in the limited API */
#ifndef _MSC_VER
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
#endif
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
#define Py_LIMITED_API 0x030c0000 // 3.12
#endif
#undef Py_BUILD_CORE_BUILTIN
#ifndef _MSC_VER
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
#endif
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
// For now, only limited C API 3.13 is supported
#define Py_LIMITED_API 0x030d0000
#endif
*/
#ifndef _MSC_VER
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
#endif
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
#define Py_LIMITED_API 0x03020000
#endif
#include "pycore_critical_section.h"
-#ifdef Py_NOGIL
+#ifdef Py_GIL_DISABLED
#define assert_nogil assert
#define assert_gil(x)
#else
assert(d2 != NULL);
// Beginning a critical section should lock the associated object and
- // push the critical section onto the thread's stack (in Py_NOGIL builds).
+ // push the critical section onto the thread's stack (in Py_GIL_DISABLED builds).
Py_BEGIN_CRITICAL_SECTION(d1);
assert_nogil(PyMutex_IsLocked(&d1->ob_mutex));
assert_nogil(_PyCriticalSection_IsActive(PyThreadState_GET()->critical_section));
*/
#ifndef _MSC_VER
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
#endif
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
// Need limited C API version 3.12 for Py_MOD_PER_INTERPRETER_GIL_SUPPORTED
#define Py_LIMITED_API 0x030c0000
#endif
/* Errno module */
#ifndef _MSC_VER
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
#endif
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
// Need limited C API version 3.12 for Py_MOD_PER_INTERPRETER_GIL_SUPPORTED
#define Py_LIMITED_API 0x030c0000
#endif
PyMutex_Unlock(&(obj)->mutex); \
}
-#ifdef Py_NOGIL
+#ifdef Py_GIL_DISABLED
#define HASHLIB_INIT_MUTEX(obj) \
do { \
(obj)->mutex = (PyMutex){0}; \
#ifndef _MSC_VER
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
#endif
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
// Need limited C API version 3.13 for PySys_Audit()
#define Py_LIMITED_API 0x030d0000
#endif
*/
#ifndef _MSC_VER
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
#endif
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
// Need limited C API version 3.12 for Py_MOD_PER_INTERPRETER_GIL_SUPPORTED
#define Py_LIMITED_API 0x030c0000
#endif
*/
#ifndef _MSC_VER
-#include "pyconfig.h" // Py_NOGIL
+#include "pyconfig.h" // Py_GIL_DISABLED
#endif
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
#define Py_LIMITED_API 0x03050000
#endif
Py_DECREF(o);
}
-#ifdef Py_NOGIL
+#ifdef Py_GIL_DISABLED
# ifdef Py_REF_DEBUG
static inline int
is_shared_refcnt_dead(Py_ssize_t shared)
_Py_atomic_store_uintptr_relaxed(&op->ob_tid, 0);
return refcnt;
}
-#endif /* Py_NOGIL */
+#endif /* Py_GIL_DISABLED */
/**************************************/
_PyTraceMalloc_NewReference(op);
}
// Skip the immortal object check in Py_SET_REFCNT; always set refcnt to 1
-#if !defined(Py_NOGIL)
+#if !defined(Py_GIL_DISABLED)
op->ob_refcnt = 1;
#else
op->ob_tid = _Py_ThreadId();
winsound.PlaySound(None, 0)
*/
-#ifndef Py_NOGIL
+#ifndef Py_GIL_DISABLED
// Need limited C API version 3.12 for Py_MOD_PER_INTERPRETER_GIL_SUPPORTED
#define Py_LIMITED_API 0x030c0000
#endif
<ClCompile>
<AdditionalIncludeDirectories>$(PySourcePath)Include;$(PySourcePath)Include\internal;$(PySourcePath)Include\internal\mimalloc;$(PySourcePath)PC;$(IntDir);%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
<PreprocessorDefinitions>WIN32;$(_Py3NamePreprocessorDefinition);$(_PlatformPreprocessorDefinition)$(_DebugPreprocessorDefinition)$(_PydPreprocessorDefinition)%(PreprocessorDefinitions)</PreprocessorDefinitions>
- <PreprocessorDefinitions Condition="'$(DisableGil)' == 'true'">Py_NOGIL=1;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+ <PreprocessorDefinitions Condition="'$(DisableGil)' == 'true'">Py_GIL_DISABLED=1;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<PreprocessorDefinitions Condition="'$(SupportPGO)' and ($(Configuration) == 'PGInstrument' or $(Configuration) == 'PGUpdate')">_Py_USING_PGO=1;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<Optimization>MaxSpeed</Optimization>
# error "ceval.c must be build with Py_BUILD_CORE define for best performance"
#endif
-#if !defined(Py_DEBUG) && !defined(Py_TRACE_REFS) && !defined(Py_NOGIL)
+#if !defined(Py_DEBUG) && !defined(Py_TRACE_REFS) && !defined(Py_GIL_DISABLED)
// GH-89279: The MSVC compiler does not inline these static inline functions
// in PGO build in _PyEval_EvalFrameDefault(), because this function is over
// the limit of PGO, and that limit cannot be configured.
// Define them as macros to make sure that they are always inlined by the
// preprocessor.
-// TODO: implement Py_DECREF macro for Py_NOGIL
+// TODO: implement Py_DECREF macro for Py_GIL_DISABLED
#undef Py_DECREF
#define Py_DECREF(arg) \
// Spin for a bit before parking the thread. This is only enabled for
// `--disable-gil` builds because it is unlikely to be helpful if the GIL is
// enabled.
-#if Py_NOGIL
+#if Py_GIL_DISABLED
static const int MAX_SPIN_COUNT = 40;
#else
static const int MAX_SPIN_COUNT = 0;
static int
tstate_try_attach(PyThreadState *tstate)
{
-#ifdef Py_NOGIL
+#ifdef Py_GIL_DISABLED
int expected = _Py_THREAD_DETACHED;
if (_Py_atomic_compare_exchange_int(
&tstate->state,
tstate_set_detached(PyThreadState *tstate)
{
assert(tstate->state == _Py_THREAD_ATTACHED);
-#ifdef Py_NOGIL
+#ifdef Py_GIL_DISABLED
_Py_atomic_store_int(&tstate->state, _Py_THREAD_DETACHED);
#else
tstate->state = _Py_THREAD_DETACHED;
if test "$disable_gil" = "yes"
then
-printf "%s\n" "#define Py_NOGIL 1" >>confdefs.h
+printf "%s\n" "#define Py_GIL_DISABLED 1" >>confdefs.h
# Add "t" for "threaded"
ABIFLAGS="${ABIFLAGS}t"
if test "$disable_gil" = "yes"
then
- AC_DEFINE([Py_NOGIL], [1],
+ AC_DEFINE([Py_GIL_DISABLED], [1],
[Define if you want to disable the GIL])
# Add "t" for "threaded"
ABIFLAGS="${ABIFLAGS}t"
/* Defined if Python is built as a shared library. */
#undef Py_ENABLE_SHARED
+/* Define if you want to disable the GIL */
+#undef Py_GIL_DISABLED
+
/* Define hash algorithm for str, bytes and memoryview. SipHash24: 1, FNV: 2,
SipHash13: 3, externally defined: 0 */
#undef Py_HASH_ALGORITHM
-/* Define if you want to disable the GIL */
-#undef Py_NOGIL
-
/* Define if you want to enable internal statistics gathering. */
#undef Py_STATS