diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2023-07-31 23:25:18 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-07-31 23:25:18 (GMT) |
| commit | fc4532a55d23887bae49350d2f939c597d6b5b98 (patch) | |
| tree | f6875ce182ffa802963298104476841db3e28744 | |
| parent | 31cd12ab21b305f19732372634cb50940f353e6e (diff) | |
| download | cpython-fc4532a55d23887bae49350d2f939c597d6b5b98.zip cpython-fc4532a55d23887bae49350d2f939c597d6b5b98.tar.gz cpython-fc4532a55d23887bae49350d2f939c597d6b5b98.tar.bz2 | |
[3.12] gh-105766: Document that Custom Allocators Must Be Thread-Safe (gh-107519) (gh-107522)
gh-105766: Document that Custom Allocators Must Be Thread-Safe (gh-107519)
(cherry picked from commit db361a340af3970c279908c8746a6b9ed45f47b8)
Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
| -rw-r--r-- | Doc/c-api/memory.rst | 6 | ||||
| -rw-r--r-- | Doc/whatsnew/3.12.rst | 7 |
2 files changed, 13 insertions, 0 deletions
diff --git a/Doc/c-api/memory.rst b/Doc/c-api/memory.rst index 8968b26..1df8c2b 100644 --- a/Doc/c-api/memory.rst +++ b/Doc/c-api/memory.rst @@ -476,6 +476,10 @@ Customize Memory Allocators thread-safe: the :term:`GIL <global interpreter lock>` is not held when the allocator is called. + For the remaining domains, the allocator must also be thread-safe: + the allocator may be called in different interpreters that do not + share a ``GIL``. + If the new allocator is not a hook (does not call the previous allocator), the :c:func:`PyMem_SetupDebugHooks` function must be called to reinstall the debug hooks on top on the new allocator. @@ -500,6 +504,8 @@ Customize Memory Allocators **must** wrap the existing allocator. Substituting the current allocator for some other arbitrary one is **not supported**. + .. versionchanged:: 3.12 + All allocators must be thread-safe. .. c:function:: void PyMem_SetupDebugHooks(void) diff --git a/Doc/whatsnew/3.12.rst b/Doc/whatsnew/3.12.rst index cbf47e4..39e702b 100644 --- a/Doc/whatsnew/3.12.rst +++ b/Doc/whatsnew/3.12.rst @@ -1922,6 +1922,13 @@ Porting to Python 3.12 * :c:func:`PyUnstable_Long_IsCompact` * :c:func:`PyUnstable_Long_CompactValue` +* Custom allocators, set via :c:func:`PyMem_SetAllocator`, are now + required to be thread-safe, regardless of memory domain. Allocators + that don't have their own state, including "hooks", are not affected. + If your custom allocator is not already thread-safe and you need + guidance then please create a new GitHub issue + and CC ``@ericsnowcurrently``. + Deprecated ---------- |