mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-09 06:01:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

gh-96997: Clarify the contract of PyMem_SetAllocator() (#98977)

Browse source
This commit is contained in:
Pablo Galindo Salgado 2022-11-02 21:49:12 +00:00 • committed by GitHub
parent 908e81f6c8
commit c053284e39
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

21
Doc/c-api/memory.rst
View file

@ -95,6 +95,8 @@ for the I/O buffer escapes completely the Python memory manager.
Allocator Domains Allocator Domains
================= =================
.. _allocator-domains:
All allocating functions belong to one of three different "domains" (see also All allocating functions belong to one of three different "domains" (see also
:c:type:`PyMemAllocatorDomain`). These domains represent different allocation :c:type:`PyMemAllocatorDomain`). These domains represent different allocation
strategies and are optimized for different purposes. The specific details on strategies and are optimized for different purposes. The specific details on
@ -479,6 +481,25 @@ Customize Memory Allocators
See also :c:member:`PyPreConfig.allocator` and :ref:`Preinitialize Python See also :c:member:`PyPreConfig.allocator` and :ref:`Preinitialize Python
with PyPreConfig <c-preinit>`. with PyPreConfig <c-preinit>`.
.. warning::
:c:func:`PyMem_SetAllocator` does have the following contract:
* It can be called after :c:func:`Py_PreInitialize` and before
:c:func:`Py_InitializeFromConfig` to install a custom memory
allocator. There are no restrictions over the installed allocator
other than the ones imposed by the domain (for instance, the Raw
Domain allows the allocator to be called without the GIL held). See
:ref:`the section on allocator domains <allocator-domains>` for more
information.
* If called after Python has finish initializing (after
:c:func:`Py_InitializeFromConfig` has been called) the allocator
**must** wrap the existing allocator. Substituting the current
allocator for some other arbitrary one is **not supported**.
.. c:function:: void PyMem_SetupDebugHooks(void) .. c:function:: void PyMem_SetupDebugHooks(void)
Setup :ref:`debug hooks in the Python memory allocators <pymem-debug-hooks>` Setup :ref:`debug hooks in the Python memory allocators <pymem-debug-hooks>`