gh-119802: Update memory management docs for free-threaded build (gh-124006)

* gh-119802: Update memory management docs for free-threaded build

* nit

* nit

* Address code review

* nit

* Update Doc/c-api/memory.rst

Co-authored-by: Sam Gross <colesbury@gmail.com>

---------

Co-authored-by: Sam Gross <colesbury@gmail.com>
This commit is contained in:
Donghee Na 2024-09-14 00:15:44 +09:00 committed by GitHub
parent bb904e063d
commit e6bb1a2b28
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 24 additions and 12 deletions

View File

@ -102,30 +102,38 @@ All allocating functions belong to one of three different "domains" (see also
strategies and are optimized for different purposes. The specific details on strategies and are optimized for different purposes. The specific details on
how every domain allocates memory or what internal functions each domain calls how every domain allocates memory or what internal functions each domain calls
is considered an implementation detail, but for debugging purposes a simplified is considered an implementation detail, but for debugging purposes a simplified
table can be found at :ref:`here <default-memory-allocators>`. There is no hard table can be found at :ref:`here <default-memory-allocators>`.
requirement to use the memory returned by the allocation functions belonging to The APIs used to allocate and free a block of memory must be from the same domain.
a given domain for only the purposes hinted by that domain (although this is the For example, :c:func:`PyMem_Free` must be used to free memory allocated using :c:func:`PyMem_Malloc`.
recommended practice). For example, one could use the memory returned by
:c:func:`PyMem_RawMalloc` for allocating Python objects or the memory returned
by :c:func:`PyObject_Malloc` for allocating memory for buffers.
The three allocation domains are: The three allocation domains are:
* Raw domain: intended for allocating memory for general-purpose memory * Raw domain: intended for allocating memory for general-purpose memory
buffers where the allocation *must* go to the system allocator or where the buffers where the allocation *must* go to the system allocator or where the
allocator can operate without the :term:`GIL`. The memory is requested directly allocator can operate without the :term:`GIL`. The memory is requested directly
to the system. from the system. See :ref:`Raw Memory Interface <raw-memoryinterface>`.
* "Mem" domain: intended for allocating memory for Python buffers and * "Mem" domain: intended for allocating memory for Python buffers and
general-purpose memory buffers where the allocation must be performed with general-purpose memory buffers where the allocation must be performed with
the :term:`GIL` held. The memory is taken from the Python private heap. the :term:`GIL` held. The memory is taken from the Python private heap.
See :ref:`Memory Interface <memoryinterface>`.
* Object domain: intended for allocating memory belonging to Python objects. The * Object domain: intended for allocating memory for Python objects. The
memory is taken from the Python private heap. memory is taken from the Python private heap. See :ref:`Object allocators <objectinterface>`.
When freeing memory previously allocated by the allocating functions belonging to a .. note::
given domain,the matching specific deallocating functions must be used. For example,
:c:func:`PyMem_Free` must be used to free memory allocated using :c:func:`PyMem_Malloc`. The :term:`free-threaded <free threading>` build requires that only Python objects are allocated using the "object" domain
and that all Python objects are allocated using that domain. This differs from the prior Python versions,
where this was only a best practice and not a hard requirement.
For example, buffers (non-Python objects) should be allocated using :c:func:`PyMem_Malloc`,
:c:func:`PyMem_RawMalloc`, or :c:func:`malloc`, but not :c:func:`PyObject_Malloc`.
See :ref:`Memory Allocation APIs <free-threaded-memory-allocation>`.
.. _raw-memoryinterface:
Raw Memory Interface Raw Memory Interface
==================== ====================
@ -299,6 +307,8 @@ versions and is therefore deprecated in extension modules.
* ``PyMem_DEL(ptr)`` * ``PyMem_DEL(ptr)``
.. _objectinterface:
Object allocators Object allocators
================= =================

View File

@ -181,6 +181,8 @@ Some of these functions were added in Python 3.13. You can use the
to provide implementations of these functions for older Python versions. to provide implementations of these functions for older Python versions.
.. _free-threaded-memory-allocation:
Memory Allocation APIs Memory Allocation APIs
====================== ======================