`memory.md`

273 строк · 27.5 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.5/c-api/memory.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Управление памятью89## Обзор1011Управление памятью в Python включает приватную кучу, содержащую все объекты и структуры данных Python. Управление этой приватной кучей внутренне обеспечивается *менеджером памяти Python*. Менеджер памяти Python имеет различные компоненты, которые занимаются разными аспектами управления динамической памятью, такими как совместное использование, сегментация, предварительное выделение или кеширование.1213На нижнем уровне сырой распределитель памяти гарантирует, что в приватной куче достаточно места для хранения всех данных Python, взаимодействуя с менеджером памяти операционной системы. Поверх сырого распределителя памяти несколько объектно-специфичных распределителей работают с той же кучей и реализуют различные политики управления памятью, адаптированные к особенностям каждого типа объектов. Например, целочисленные объекты управляются в куче иначе, чем строки, кортежи или словари, поскольку целые числа подразумевают другие требования к хранению и компромиссы между скоростью и объёмом. Таким образом, менеджер памяти Python делегирует часть работы объектно-специфичным распределителям, но следит, чтобы последние работали в границах приватной кучи.1415Важно понимать, что управление кучей Python выполняется самим интерпретатором, и пользователь не может на него повлиять, даже если он регулярно манипулирует указателями на объекты в блоках памяти внутри этой кучи. Выделение памяти кучи для объектов Python и других внутренних буферов выполняется по требованию менеджером памяти Python через функции Python/C API, перечисленные в этом документе.1617Чтобы избежать повреждения памяти, разработчики расширений никогда не должны пытаться работать с объектами Python с помощью функций, экспортируемых библиотекой C: `malloc()`, `calloc()`, `realloc()` и `free()`. Это приведёт к смешанным вызовам между распределителем C и менеджером памяти Python с фатальными последствиями, поскольку они реализуют разные алгоритмы и работают с разными кучами. Однако можно безопасно выделять и освобождать блоки памяти с помощью распределителя библиотеки C для отдельных целей, как показано в следующем примере:1819```c20PyObject *res;21char *buf = (char *) malloc(BUFSIZ); /* для ввода-вывода */2223if (buf == NULL)24    return PyErr_NoMemory();25...Do some I/O operation involving buf...26res = PyBytes_FromString(buf);27free(buf); /* выделено через malloc */28return res;29```3031В этом примере запрос памяти для буфера ввода-вывода обрабатывается аллокатором библиотеки C. Менеджер памяти Python участвует только в выделении строкового объекта, возвращаемого в качестве результата.3233Однако в большинстве ситуаций рекомендуется выделять память из Python-кучи, поскольку она находится под управлением менеджера памяти Python. Например, это необходимо, когда интерпретатор расширяется новыми типами объектов, написанными на C. Ещё одна причина использовать Python-кучу – желание *информировать* менеджер памяти Python о потребностях модуля расширения в памяти. Даже если запрошенная память используется исключительно для внутренних, узкоспециализированных целей, передача всех запросов памяти менеджеру памяти Python позволяет интерпретатору получать более точную картину общего объёма используемой памяти. Как следствие, при определённых обстоятельствах менеджер памяти Python может запускать или не запускать соответствующие действия, такие как сборка мусора, уплотнение памяти или другие профилактические процедуры. Обратите внимание: при использовании аллокатора из библиотеки C, как показано в предыдущем примере, выделенная память для буфера ввода-вывода полностью уходит из-под контроля менеджера памяти Python.3435> **См. также**36>37> Переменная окружения [`PYTHONMALLOCSTATS`](https://python-all.ru/3.5/using/cmdline.html#envvar-PYTHONMALLOCSTATS) может использоваться для вывода статистики выделения памяти каждый раз при создании новой арены объектов, а также при завершении работы.3839## Сырой интерфейс памяти4041Следующие наборы функций являются обёртками вокруг системного аллокатора. Эти функции потокобезопасны, удерживать [GIL](https://python-all.ru/3.5/glossary.html#term-global-interpreter-lock) не требуется.4243Аллокатор сырых блоков памяти по умолчанию использует следующие функции: `malloc()`, `calloc()`, `realloc()` и `free()`; вызывайте `malloc(1)` (или `calloc(1, 1)`) при запросе нулевого количества байт.4445Новое в версии 3.4.4647#### `void* PyMem_RawMalloc(size_t n)`4849Выделяет *n* байт и возвращает указатель типа `void*` на выделенную память или *NULL* в случае неудачи.5051Запрос нулевого количества байт возвращает отличный от *NULL* указатель, если это возможно, как если бы вместо этого была вызвана `PyMem_RawMalloc(1)`. Память не будет инициализирована никаким образом.5253#### `void* PyMem_RawCalloc(size_t nelem, size_t elsize)`5455Выделяет *nelem* элементов, каждый размером в *elsize* байт, и возвращает указатель типа `void*` на выделенную память или *NULL* в случае неудачи. Память инициализируется нулями.5657Запрос нулевого количества элементов или элементов нулевого размера возвращает отличный от *NULL* указатель, если это возможно, как если бы вместо этого была вызвана `PyMem_RawCalloc(1, 1)`.5859Новое в версии 3.5.6061#### `void* PyMem_RawRealloc(void *p, size_t n)`6263Изменяет размер блока памяти, на который указывает *p*, до *n* байт. Содержимое останется неизменным в объеме, равном минимальному из старого и нового размеров.6465Если *p* равно *NULL*, вызов эквивалентен `PyMem_RawMalloc(n)`; в противном случае, если *n* равно нулю, блок памяти изменяет размер, но не освобождается, и возвращаемый указатель не равен *NULL*.6667Если *p* не равно *NULL*, то он должен быть возвращен предыдущим вызовом [`PyMem_RawMalloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawMalloc), [`PyMem_RawRealloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawRealloc) или [`PyMem_RawCalloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawCalloc).6869Если запрос не удался, [`PyMem_RawRealloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawRealloc) возвращает *NULL*, а *p* остается действительным указателем на предыдущую область памяти.7071#### `void PyMem_RawFree(void *p)`7273Освобождает блок памяти, на который указывает *p*. Этот указатель должен быть возвращен предыдущим вызовом [`PyMem_RawMalloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawMalloc), [`PyMem_RawRealloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawRealloc) или [`PyMem_RawCalloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawCalloc). В противном случае, или если `PyMem_Free(p)` уже вызывался, поведение не определено.7475Если *p* равно *NULL*, никаких действий не выполняется.7677## Интерфейс памяти7879Следующие наборы функций, основанные на стандарте ANSI C, но определяющие поведение при запросе нуля байт, доступны для выделения и освобождения памяти из кучи Python.8081Распределитель блоков памяти по умолчанию использует следующие функции: `malloc()`, `calloc()`, `realloc()` и `free()`; при запросе нулевого количества байтов вызывайте `malloc(1)` (или `calloc(1, 1)`).8283> **Предупреждение**84>85> При использовании этих функций необходимо удерживать [GIL](https://python-all.ru/3.5/glossary.html#term-global-interpreter-lock).8687#### `void* PyMem_Malloc(size_t n)`8889Выделяет *n* байт и возвращает указатель типа `void*` на выделенную память или *NULL* в случае неудачи.9091Запрос нулевого количества байт возвращает отличный от *NULL* указатель, если это возможно, как если бы вместо этого была вызвана `PyMem_Malloc(1)`. Память не будет инициализирована никаким образом.9293#### `void* PyMem_Calloc(size_t nelem, size_t elsize)`9495Выделяет *nelem* элементов, каждый размером в *elsize* байт, и возвращает указатель типа `void*` на выделенную память или *NULL* в случае неудачи. Память инициализируется нулями.9697Запрос нулевого количества элементов или элементов нулевого размера возвращает отличный от *NULL* указатель, если это возможно, как если бы вместо этого была вызвана `PyMem_Calloc(1, 1)`.9899Новое в версии 3.5.100101#### `void* PyMem_Realloc(void *p, size_t n)`102103Изменяет размер блока памяти, на который указывает *p*, до *n* байт. Содержимое останется неизменным в пределах меньшего из старого и нового размеров.104105Если *p* равно *NULL*, вызов эквивалентен `PyMem_Malloc(n)`; в противном случае, если *n* равно нулю, блок памяти изменяет размер, но не освобождается, и возвращаемый указатель не равен *NULL*.106107Если *p* не равно *NULL*, то он должен быть возвращен предыдущим вызовом [`PyMem_Malloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Malloc), [`PyMem_Realloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Realloc) или [`PyMem_Calloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Calloc).108109Если запрос не удался, [`PyMem_Realloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Realloc) возвращает *NULL*, а *p* остается действительным указателем на предыдущую область памяти.110111#### `void PyMem_Free(void *p)`112113Освобождает блок памяти, на который указывает *p*. Этот блок должен быть возвращён предыдущим вызовом [`PyMem_Malloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Malloc), [`PyMem_Realloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Realloc) или [`PyMem_Calloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Calloc). В противном случае, или если до этого был вызван `PyMem_Free(p)`, поведение не определено.114115Если *p* равно *NULL*, никаких действий не выполняется.116117Для удобства предоставлены следующие макросы, ориентированные на типы. Обратите внимание, что *TYPE* относится к любому типу C.118119#### `TYPE* PyMem_New(TYPE, size_t n)`120121То же, что и [`PyMem_Malloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Malloc), но выделяет `(n * sizeof(TYPE))` байт памяти. Возвращает указатель, приведенный к `TYPE*`. Память не будет инициализирована каким-либо образом.122123#### `TYPE* PyMem_Resize(void *p, TYPE, size_t n)`124125То же, что и [`PyMem_Realloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Realloc), но размер блока памяти изменяется до `(n * sizeof(TYPE))` байт. Возвращает указатель, приведенный к `TYPE*`. После возврата *p* будет указателем на новую область памяти или *NULL* в случае неудачи.126127Это макрос препроцессора C; *p* всегда переназначается. Сохраняйте исходное значение *p*, чтобы не потерять память при обработке ошибок.128129#### `void PyMem_Del(void *p)`130131То же, что и [`PyMem_Free()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Free).132133Кроме того, для прямого вызова аллокатора памяти Python, без использования перечисленных выше функций C API, предоставляются следующие наборы макросов. Однако следует учитывать, что их использование не гарантирует двоичной совместимости между версиями Python, поэтому в модулях расширения они считаются устаревшими.134135- `PyMem_MALLOC(size)`136- `PyMem_NEW(type, size)`137- `PyMem_REALLOC(ptr, size)`138- `PyMem_RESIZE(ptr, type, size)`139- `PyMem_FREE(ptr)`140- `PyMem_DEL(ptr)`141142## Настройка распределителей памяти143144Новое в версии 3.4.145146**`PyMemAllocatorEx`**147148Структура, используемая для описания распределителя блоков памяти. Структура содержит четыре поля:149150| Поле | Значение |151| --- | --- |152| `void *ctx` | контекст пользователя, передаваемый первым аргументом |153| `void* malloc(void *ctx, size_t size)` | выделить блок памяти |154| `void* calloc(void *ctx, size_t nelem, size_t elsize)` | выделить блок памяти, инициализированный нулями |155| `void* realloc(void *ctx, void *ptr, size_t new_size)` | выделить или изменить размер блока памяти |156| `void free(void *ctx, void *ptr)` | освободить блок памяти |157158Изменено в версии 3.5: Структура `PyMemAllocator` была переименована в [`PyMemAllocatorEx`](https://python-all.ru/3.5/c-api/memory.html#c.PyMemAllocatorEx), и добавлено новое поле `calloc`.159160**`PyMemAllocatorDomain`**161162Перечисление, используемое для идентификации домена распределителя. Домены:163164- `PYMEM_DOMAIN_RAW`: функции [`PyMem_RawMalloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawMalloc), [`PyMem_RawRealloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawRealloc), [`PyMem_RawCalloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawCalloc) и [`PyMem_RawFree()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawFree)165- `PYMEM_DOMAIN_MEM`: функции [`PyMem_Malloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Malloc), [`PyMem_Realloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Realloc), [`PyMem_Calloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Calloc) и [`PyMem_Free()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Free)166- `PYMEM_DOMAIN_OBJ`: функции `PyObject_Malloc()`, `PyObject_Realloc()`, `PyObject_Calloc()` и `PyObject_Free()`167168#### `void PyMem_GetAllocator(PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)`169170Получить распределитель блоков памяти для указанного домена.171172#### `void PyMem_SetAllocator(PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)`173174Установить распределитель блоков памяти для указанного домена.175176Новый аллокатор должен возвращать отличный от NULL указатель при запросе нулевого количества байт.177178Для области `PYMEM_DOMAIN_RAW` распределитель должен быть потокобезопасным: [GIL](https://python-all.ru/3.5/glossary.html#term-global-interpreter-lock) не удерживается, когда вызывается распределитель.179180Если новый распределитель не является перехватчиком (не вызывает предыдущий распределитель), необходимо вызвать функцию [`PyMem_SetupDebugHooks()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_SetupDebugHooks), чтобы переустановить отладочные перехватчики поверх нового распределителя.181182#### `void PyMem_SetupDebugHooks(void)`183184Настройка хуков для обнаружения ошибок в следующих функциях распределителя памяти Python:185186- [`PyMem_RawMalloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawMalloc), [`PyMem_RawRealloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawRealloc), [`PyMem_RawCalloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawCalloc), [`PyMem_RawFree()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawFree)187- [`PyMem_Malloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Malloc), [`PyMem_Realloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Realloc), [`PyMem_Calloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Calloc), [`PyMem_Free()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Free)188- `PyObject_Malloc()`, `PyObject_Realloc()`, `PyObject_Calloc()`, `PyObject_Free()`189190Недавно выделенная память заполняется байтом `0xCB`, освобождённая память заполняется байтом `0xDB`. Дополнительные проверки:191192- обнаружение нарушений API, например: `PyObject_Free()` вызвана для буфера, выделенного [`PyMem_Malloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_Malloc)193- обнаружение записи до начала буфера (недополнение буфера)194- обнаружение записи после конца буфера (переполнение буфера)195196Функция ничего не делает, если Python не скомпилирован в режиме отладки.197198## Настройка распределителя арен объектов PyObject199200Python имеет распределитель *pymalloc* для выделений размером менее 512 байт. Этот распределитель оптимизирован для маленьких объектов с коротким временем жизни. Он использует отображения памяти, называемые «аренами», фиксированного размера 256 КБ. Для выделений больше 512 байт он обращается к [`PyMem_RawMalloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawMalloc) и [`PyMem_RawRealloc()`](https://python-all.ru/3.5/c-api/memory.html#c.PyMem_RawRealloc). Распределитель *pymalloc* используется по умолчанию функцией `PyObject_Malloc()`.201202Распределитель арен по умолчанию использует следующие функции:203204- `VirtualAlloc()` и `VirtualFree()` в Windows,205- `mmap()` и `munmap()`, если доступно,206- `malloc()` и `free()` в противном случае.207208Новое в версии 3.4.209210**`PyObjectArenaAllocator`**211212Структура, используемая для описания аллокатора арен. Структура содержит три поля:213214| Поле | Значение |215| --- | --- |216| `void *ctx` | контекст пользователя, передаваемый первым аргументом |217| `void* alloc(void *ctx, size_t size)` | выделить арену размером bytes |218| `void free(void *ctx, size_t size, void *ptr)` | освободить арену |219220#### `PyObject_GetArenaAllocator(PyObjectArenaAllocator *allocator)`221222Получить аллокатор арен.223224#### `PyObject_SetArenaAllocator(PyObjectArenaAllocator *allocator)`225226Установить аллокатор арен.227228## Примеры229230Вот пример из раздела [Обзор](https://python-all.ru/3.5/c-api/memory.html#memoryoverview), переписанный так, чтобы буфер ввода-вывода выделялся из кучи Python с помощью первого набора функций:231232```c233PyObject *res;234char *buf = (char *) PyMem_Malloc(BUFSIZ); /* для ввода-вывода */235236if (buf == NULL)237    return PyErr_NoMemory();238/* ...Выполнить некоторые операции ввода-вывода с buf... */239res = PyBytes_FromString(buf);240PyMem_Free(buf); /* выделено с помощью PyMem_Malloc */241return res;242```243244Тот же код с использованием тип-ориентированного набора функций:245246```c247PyObject *res;248char *buf = PyMem_New(char, BUFSIZ); /* для ввода-вывода */249250if (buf == NULL)251    return PyErr_NoMemory();252/* ...Выполнить некоторые операции ввода-вывода с buf... */253res = PyBytes_FromString(buf);254PyMem_Del(buf); /* выделено с помощью PyMem_New */255return res;256```257258Обратите внимание, что в двух приведённых выше примерах буфер всегда обрабатывается с помощью функций из одного и того же набора. Действительно, для данного блока памяти необходимо использовать одно и то же семейство API для работы с памятью, чтобы риск смешивания разных аллокаторов был сведён к минимуму. Следующая последовательность кода содержит две ошибки, одна из которых помечена как *фатальная*, поскольку она смешивает два разных аллокатора, работающих с разными кучами.259260```c261char *buf1 = PyMem_New(char, BUFSIZ);262char *buf2 = (char *) malloc(BUFSIZ);263char *buf3 = (char *) PyMem_Malloc(BUFSIZ);264...265PyMem_Del(buf3);  /* Неверно -- следует использовать PyMem_Free() */266free(buf2);       /* Верно -- выделено через malloc() */267free(buf1);       /* Фатальная ошибка – следует использовать PyMem_Del()  */268```269270В дополнение к функциям, предназначенным для работы с сырыми блоками памяти из кучи Python, объекты в Python выделяются и освобождаются с помощью [`PyObject_New()`](https://python-all.ru/3.5/c-api/allocation.html#c.PyObject_New), [`PyObject_NewVar()`](https://python-all.ru/3.5/c-api/allocation.html#c.PyObject_NewVar) и [`PyObject_Del()`](https://python-all.ru/3.5/c-api/allocation.html#c.PyObject_Del).271272Они будут описаны в следующей главе, посвящённой определению и реализации новых типов объектов на C.273