gh-134009: Expose `PyMutex_IsLocked` in the public C API (gh-134365) · python/cpython@f41e9c7 · GitHub
Skip to content

Commit f41e9c7

Browse files
colesburycolesbury
authored
gh-134009: Expose PyMutex_IsLocked in the public C API (gh-134365)
The `PyMutex_IsLocked()` function is useful in assertions for verifying that code maintains certain locking invariants.
1 parent 86c3316 commit f41e9c7

6 files changed

Lines changed: 39 additions & 7 deletions

File tree

‎Doc/c-api/init.rst‎

Lines changed: 12 additions & 0 deletions

‎Doc/whatsnew/3.15.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,13 @@ Porting to Python 3.15
346346

347347
(Contributed by Serhiy Storchaka in :gh:`133595`.)
348348

349+
* Private functions promoted to public C APIs:
350+
351+
* ``PyMutex_IsLocked()`` : :c:func:`PyMutex_IsLocked`
352+
353+
The |pythoncapi_compat_project| can be used to get most of these new
354+
functions on Python 3.14 and older.
355+
349356
Deprecated C APIs
350357
-----------------
351358

‎Include/cpython/lock.h‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ PyAPI_FUNC(void) PyMutex_Lock(PyMutex *m);
3636
// exported function for unlocking the mutex
3737
PyAPI_FUNC(void) PyMutex_Unlock(PyMutex *m);
3838

39+
// exported function for checking if the mutex is locked
40+
PyAPI_FUNC(int) PyMutex_IsLocked(PyMutex *m);
41+
3942
// Locks the mutex.
4043
//
4144
// If the mutex is currently locked, the calling thread will be parked until
@@ -61,3 +64,11 @@ _PyMutex_Unlock(PyMutex *m)
6164
}
6265
}
6366
#define PyMutex_Unlock _PyMutex_Unlock
67+
68+
// Checks if the mutex is currently locked.
69+
static inline int
70+
_PyMutex_IsLocked(PyMutex *m)
71+
{
72+
return (_Py_atomic_load_uint8(&m->_bits) & _Py_LOCKED) != 0;
73+
}
74+
#define PyMutex_IsLocked _PyMutex_IsLocked

‎Include/internal/pycore_lock.h‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,6 @@ PyMutex_LockFast(PyMutex *m)
2525
return _Py_atomic_compare_exchange_uint8(lock_bits, &expected, _Py_LOCKED);
2626
}
2727

28-
// Checks if the mutex is currently locked.
29-
static inline int
30-
PyMutex_IsLocked(PyMutex *m)
31-
{
32-
return (_Py_atomic_load_uint8(&m->_bits) & _Py_LOCKED) != 0;
33-
}
34-
3528
// Re-initializes the mutex after a fork to the unlocked state.
3629
static inline void
3730
_PyMutex_at_fork_reinit(PyMutex *m)

‎Misc/NEWS.d/next/C_API/2025-05-20-17-13-51.gh-issue-134009.CpCmry.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Expose :c:func:`PyMutex_IsLocked` as part of the public C API.

‎Python/lock.c‎

Lines changed: 8 additions & 0 deletions

0 commit comments

Comments
 (0)