Управление памятью¶Memory Management

Обзор¶Overview

Управление памятью в Python включает приватную кучу, содержащую все объекты и структуры данных Python. Управление этой приватной кучей внутренне обеспечивается менеджером памяти Python. Менеджер памяти Python имеет различные компоненты, которые занимаются разными аспектами управления динамической памятью, такими как совместное использование, сегментация, предварительное выделение или кеширование.

На нижнем уровне сырой распределитель памяти гарантирует, что в приватной куче достаточно места для хранения всех данных Python, взаимодействуя с менеджером памяти операционной системы. Поверх сырого распределителя памяти несколько объектно-специфичных распределителей работают с той же кучей и реализуют различные политики управления памятью, адаптированные к особенностям каждого типа объектов. Например, целочисленные объекты управляются в куче иначе, чем строки, кортежи или словари, поскольку целые числа подразумевают другие требования к хранению и компромиссы между скоростью и объёмом. Таким образом, менеджер памяти Python делегирует часть работы объектно-специфичным распределителям, но следит, чтобы последние работали в границах приватной кучи.

Важно понимать, что управление кучей Python выполняется самим интерпретатором, и пользователь не может на него повлиять, даже если регулярно манипулирует указателями на объекты в этой куче. Выделение памяти в куче для объектов Python и других внутренних буферов выполняется по требованию менеджером памяти Python через функции Python/C API, перечисленные в этом документе.

Чтобы избежать повреждения памяти, разработчики расширений никогда не должны пытаться работать с объектами Python с помощью функций, экспортируемых библиотекой C: malloc(), calloc(), realloc() и free(). Это приведёт к смешанным вызовам между распределителем C и менеджером памяти Python с фатальными последствиями, поскольку они реализуют разные алгоритмы и работают с разными кучами. Однако можно безопасно выделять и освобождать блоки памяти с помощью распределителя библиотеки C для отдельных целей, как показано в следующем примере:

PyObject *res;
char *buf = (char *) malloc(BUFSIZ); /* для ввода-вывода */

if (buf == NULL)
    return PyErr_NoMemory();
...Do some I/O operation involving buf...
res = PyBytes_FromString(buf);
free(buf); /* выделено через malloc */
return res;

В этом примере запрос памяти для буфера ввода-вывода обрабатывается распределителем библиотеки C. Менеджер памяти Python участвует только в выделении объекта bytes, возвращаемого в результате.

Однако в большинстве ситуаций рекомендуется выделять память из кучи Python, поскольку она находится под управлением менеджера памяти Python. Например, это необходимо при расширении интерпретатора новыми типами объектов, написанными на C. Ещё одна причина использования кучи Python – желание уведомить менеджер памяти Python о потребностях модуля расширения в памяти. Даже если запрашиваемая память используется исключительно для внутренних узкоспециализированных целей, передача всех запросов на память менеджеру памяти Python позволяет интерпретатору получить более точную картину общего объёма используемой памяти. Следовательно, при определённых обстоятельствах менеджер памяти Python может запустить или не запустить соответствующие действия, такие как сборка мусора, уплотнение памяти или другие профилактические процедуры. Обратите внимание, что при использовании аллокатора библиотеки C, как показано в предыдущем примере, выделенная для буфера ввода-вывода память полностью выходит из-под контроля менеджера памяти Python.

Домены распределителей¶Allocator Domains

Все функции выделения памяти относятся к одной из трёх различных «областей» (см. также PyMemAllocatorDomain). Эти области представляют разные стратегии выделения и оптимизированы для разных целей. Конкретные детали того, как каждая область выделяет память или какие внутренние функции при этом вызываются, считаются деталью реализации, однако для целей отладки упрощённая таблица доступна здесь. Нет строгого требования использовать память, возвращённую функциями выделения из данной области, только для целей, на которые эта область намекает (хотя это рекомендуемая практика). Например, можно использовать память, возвращённую PyMem_RawMalloc(), для выделения объектов Python, или память, возвращённую PyObject_Malloc(), для выделения буферов.

Три домена выделения:

• Область Raw: предназначена для выделения памяти под буферы общего назначения, когда выделение должно производиться системным аллокатором или когда аллокатор может работать без GIL. Память запрашивается напрямую у системы.

• Область «Mem»: предназначена для выделения памяти под буферы Python и буферы общего назначения, когда выделение должно выполняться при удерживаемом GIL. Память берётся из частной кучи Python.

• Область Object: предназначена для выделения памяти, принадлежащей объектам Python. Память берётся из частной кучи Python.

При освобождении памяти, ранее выделенной функциями распределения, принадлежащими данной области, должны использоваться соответствующие специальные функции освобождения. Например, PyMem_Free() должна использоваться для освобождения памяти, выделенной с помощью PyMem_Malloc().

Сырой интерфейс памяти¶Raw Memory Interface

Следующие наборы функций являются обёртками вокруг системного аллокатора. Эти функции потокобезопасны, удерживать GIL не требуется.

Стандартный сырой распределитель памяти использует следующие функции: malloc(), calloc(), realloc() и free(); вызывайте malloc(1) (или calloc(1, 1)) при запросе нулевого количества байтов.

void *PyMem_RawMalloc(size_t n)¶

Выделяет n байт и возвращает указатель типа void* на выделенную память или NULL, если запрос не удался.

Запрос нуля байт возвращает отличный от NULL указатель, если это возможно, как если бы вместо этого была вызвана PyMem_RawMalloc(1). Память не будет инициализирована каким-либо образом.

void *PyMem_RawCalloc(size_t nelem, size_t elsize)¶

Выделяет память для nelem элементов, каждый размером elsize байт, и возвращает указатель типа void* на выделенную память или NULL в случае неудачи. Память инициализируется нулями.

Запрос нулевого количества элементов или элементов размером ноль байтов возвращает отличный от NULL указатель, если это возможно, как если бы вместо него был вызван PyMem_RawCalloc(1, 1).

Добавлено в версии 3.5.

void *PyMem_RawRealloc(void *p, size_t n)¶

Изменяет размер блока памяти, на который указывает p, до n байт. Содержимое останется неизменным в объеме, равном минимальному из старого и нового размеров.

Если p равен NULL, вызов эквивалентен PyMem_RawMalloc(n); иначе если n равен нулю, блок памяти изменяет размер, но не освобождается, и возвращаемый указатель отличен от NULL.

Если p не равен NULL, он должен быть возвращен предыдущим вызовом PyMem_RawMalloc(), PyMem_RawRealloc() или PyMem_RawCalloc().

В случае ошибки PyMem_RawRealloc() возвращает NULL, и p остается действующим указателем на предыдущую область памяти.

void PyMem_RawFree(void *p)¶

Освобождает блок памяти, на который указывает p. Этот указатель должен быть возвращен предыдущим вызовом PyMem_RawMalloc(), PyMem_RawRealloc() или PyMem_RawCalloc(). В противном случае, или если PyMem_RawFree(p) уже вызывался, поведение не определено.

Если p равен NULL, то никаких действий не выполняется.

Интерфейс памяти¶Memory Interface

Следующие наборы функций, основанные на стандарте ANSI C, но определяющие поведение при запросе нуля байт, доступны для выделения и освобождения памяти из кучи Python.

Аллокатор памяти по умолчанию использует аллокатор памяти pymalloc.

void *PyMem_Malloc(size_t n)¶

Часть Stable ABI.

Выделяет n байт и возвращает указатель типа void* на выделенную память или NULL, если запрос не удался.

Запрос нуля байт возвращает отличный от NULL указатель, если это возможно, как если бы вместо этого была вызвана PyMem_Malloc(1). Память не будет инициализирована каким-либо образом.

void *PyMem_Calloc(size_t nelem, size_t elsize)¶

Часть Stable ABI начиная с версии 3.7.

Выделяет память для nelem элементов, каждый размером elsize байт, и возвращает указатель типа void* на выделенную память или NULL в случае неудачи. Память инициализируется нулями.

Запрос нуля элементов или элементов размером ноль байт возвращает отличный от NULL указатель, если это возможно, как если бы вместо этого была вызвана PyMem_Calloc(1, 1).

Добавлено в версии 3.5.

void *PyMem_Realloc(void *p, size_t n)¶

Часть Stable ABI.

Изменяет размер блока памяти, на который указывает p, до n байт. Содержимое останется неизменным в пределах меньшего из старого и нового размеров.

Если p равен NULL, вызов эквивалентен PyMem_Malloc(n); в противном случае, если n равен нулю, размер блока памяти изменяется, но он не освобождается, и возвращаемый указатель не равен NULL.

Если p не равен NULL, он должен быть возвращён предыдущим вызовом PyMem_Malloc(), PyMem_Realloc() или PyMem_Calloc().

Если запрос не удался, PyMem_Realloc() возвращает NULL, а p остаётся корректным указателем на предыдущую область памяти.

void PyMem_Free(void *p)¶

Часть Stable ABI.

Освобождает блок памяти, на который указывает p. Этот блок должен быть возвращён предыдущим вызовом PyMem_Malloc(), PyMem_Realloc() или PyMem_Calloc(). В противном случае, или если до этого был вызван PyMem_Free(p), поведение не определено.

Если p равен NULL, то никаких действий не выполняется.

Для удобства предоставлены следующие макросы, ориентированные на типы. Обратите внимание, что TYPE относится к любому типу C.

PyMem_New(TYPE, n)¶

То же, что и PyMem_Malloc(), но выделяет (n * sizeof(TYPE)) байт памяти. Возвращает указатель, приведенный к TYPE*. Память не будет инициализирована каким-либо образом.

PyMem_Resize(p, TYPE, n)¶

То же, что PyMem_Realloc(), но блок памяти изменяется до (n * sizeof(TYPE)) байт. Возвращает указатель, приведённый к TYPE*. При возврате p будет указателем на новую область памяти или NULL в случае ошибки.

Это макрос препроцессора C; p всегда переназначается. Сохраняйте исходное значение p, чтобы не потерять память при обработке ошибок.

void PyMem_Del(void *p)¶

То же, что и PyMem_Free().

Кроме того, для прямого вызова аллокатора памяти Python, без использования перечисленных выше функций C API, предоставляются следующие наборы макросов. Однако следует учитывать, что их использование не гарантирует двоичной совместимости между версиями Python, поэтому в модулях расширения они считаются устаревшими.

• PyMem_MALLOC(size)

• PyMem_NEW(type, size)

• PyMem_REALLOC(ptr, size)

• PyMem_RESIZE(ptr, type, size)

• PyMem_FREE(ptr)

• PyMem_DEL(ptr)

Аллокаторы объектов¶Object allocators

Следующие наборы функций, основанные на стандарте ANSI C, но определяющие поведение при запросе нуля байт, доступны для выделения и освобождения памяти из кучи Python.

Аллокатор объектов по умолчанию использует аллокатор памяти pymalloc.

void *PyObject_Malloc(size_t n)¶

Часть Stable ABI.

Выделяет n байт и возвращает указатель типа void* на выделенную память или NULL, если запрос не удался.

Запрос нуля байт возвращает отличный от NULL указатель, если это возможно, как если бы вместо этого была вызвана PyObject_Malloc(1). Память не будет инициализирована каким-либо образом.

void *PyObject_Calloc(size_t nelem, size_t elsize)¶

Часть Stable ABI начиная с версии 3.7.

Выделяет память для nelem элементов, каждый размером elsize байт, и возвращает указатель типа void* на выделенную память или NULL в случае неудачи. Память инициализируется нулями.

Запрос нуля элементов или элементов размером ноль байт возвращает отличный от NULL указатель, если это возможно, как если бы вместо этого была вызвана PyObject_Calloc(1, 1).

Добавлено в версии 3.5.

void *PyObject_Realloc(void *p, size_t n)¶

Часть Stable ABI.

Изменяет размер блока памяти, на который указывает p, до n байт. Содержимое останется неизменным в пределах меньшего из старого и нового размеров.

Если p равен NULL, вызов эквивалентен PyObject_Malloc(n); в противном случае, если n равен нулю, размер блока памяти изменяется, но он не освобождается, и возвращаемый указатель не равен NULL.

Если p не равен NULL, он должен быть возвращён предыдущим вызовом PyObject_Malloc(), PyObject_Realloc() или PyObject_Calloc().

Если запрос не удался, PyObject_Realloc() возвращает NULL, а p остаётся корректным указателем на предыдущую область памяти.

void PyObject_Free(void *p)¶

Часть Stable ABI.

Освобождает блок памяти, на который указывает p. Этот блок должен быть возвращён предыдущим вызовом PyObject_Malloc(), PyObject_Realloc() или PyObject_Calloc(). В противном случае, или если до этого был вызван PyObject_Free(p), поведение не определено.

Если p равен NULL, то никаких действий не выполняется.

Аллокаторы памяти по умолчанию¶Default Memory Allocators

Аллокаторы памяти по умолчанию:

Условные обозначения:

• Имя: значение для переменной окружения PYTHONMALLOC.

• malloc: системные аллокаторы из стандартной библиотеки C, функции языка C: malloc(), calloc(), realloc() и free().

• pymalloc: аллокатор памяти pymalloc.

• «+ отладка»: с отладочными перехватчиками на аллокаторах памяти Python.

• “Debug build”: сборка Python в режиме отладки.

Настройка распределителей памяти¶Customize Memory Allocators

type PyMemAllocatorEx¶

Структура, используемая для описания распределителя блоков памяти. Структура содержит следующие поля:

Поле	Значение
void *ctx	контекст пользователя, передаваемый первым аргументом
void* malloc(void *ctx, size_t size)	выделить блок памяти
void* calloc(void *ctx, size_t nelem, size_t elsize)	выделить блок памяти, инициализированный нулями
void* realloc(void *ctx, void *ptr, size_t new_size)	выделить или изменить размер блока памяти
void free(void *ctx, void *ptr)	освободить блок памяти

Изменено в версии 3.5: Структура PyMemAllocator была переименована в PyMemAllocatorEx, и добавлено новое поле calloc.

type PyMemAllocatorDomain¶

Перечисление, используемое для идентификации домена распределителя. Домены:

PYMEM_DOMAIN_RAW¶

Функции:

• PyMem_RawMalloc()

• PyMem_RawRealloc()

• PyMem_RawCalloc()

• PyMem_RawFree()

PYMEM_DOMAIN_MEM¶

Функции:

• PyMem_Malloc(),

• PyMem_Realloc()

• PyMem_Calloc()

• PyMem_Free()

PYMEM_DOMAIN_OBJ¶

Функции:

• PyObject_Malloc()

• PyObject_Realloc()

• PyObject_Calloc()

• PyObject_Free()

void PyMem_GetAllocator(PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)¶

Получить распределитель блоков памяти для указанного домена.

void PyMem_SetAllocator(PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)¶

Установить распределитель блоков памяти для указанного домена.

Новый распределитель должен возвращать отличный от NULL указатель при запросе нулевого количества байт.

Для области PYMEM_DOMAIN_RAW распределитель должен быть потокобезопасным: GIL не удерживается, когда вызывается распределитель.

Для остальных областей распределитель также должен быть потокобезопасным: распределитель может вызываться в разных интерпретаторах, которые не используют общий GIL.

Если новый распределитель не является перехватчиком (не вызывает предыдущий распределитель), необходимо вызвать функцию PyMem_SetupDebugHooks(), чтобы переустановить отладочные перехватчики поверх нового распределителя.

См. также PyPreConfig.allocator и предварительную инициализацию Python с помощью PyPreConfig.

Предупреждение

PyMem_SetAllocator() имеет следующее контрактное соглашение:

• Его можно вызывать после Py_PreInitialize() и до Py_InitializeFromConfig() для установки пользовательского распределителя памяти. На установленный распределитель не накладывается никаких ограничений, кроме тех, что накладываются областью (например, Raw Domain позволяет вызывать распределитель без удержания GIL). См. раздел об областях распределителя для получения дополнительной информации.

• Если вызывается после завершения инициализации Python (после вызова Py_InitializeFromConfig()), распределитель должен оборачивать существующий распределитель. Замена текущего распределителя на произвольный другой не поддерживается.

Изменено в версии 3.12: Все распределители должны быть потокобезопасными.

void PyMem_SetupDebugHooks(void)¶

Устанавливает отладочные ловушки в распределителях памяти Python для обнаружения ошибок памяти.

Отладочные ловушки в распределителях памяти Python¶Debug hooks on the Python memory allocators

Когда Python собран в режиме отладки, функция PyMem_SetupDebugHooks() вызывается во время преинициализации Python для установки отладочных ловушек в распределителях памяти Python для обнаружения ошибок памяти.

Переменная окружения PYTHONMALLOC может использоваться для установки отладочных ловушек в Python, скомпилированном в релизном режиме (например: PYTHONMALLOC=debug).

Функция PyMem_SetupDebugHooks() может использоваться для установки отладочных ловушек после вызова PyMem_SetAllocator().

Эти отладочные ловушки заполняют динамически выделенные блоки памяти специальными, распознаваемыми битовыми шаблонами. Вновь выделенная память заполняется байтом 0xCD (PYMEM_CLEANBYTE), освобождённая память – байтом 0xDD (PYMEM_DEADBYTE). Блоки памяти окружены «запрещёнными байтами», заполненными байтом 0xFD (PYMEM_FORBIDDENBYTE). Строки из этих байтов вряд ли являются допустимыми адресами, числами с плавающей точкой или строками ASCII.

Проверки во время выполнения:

• Обнаруживает нарушения API. Например, определяет, была ли PyObject_Free() вызвана для блока памяти, выделенного функцией PyMem_Malloc().

• Обнаруживает запись перед началом буфера (недополнение буфера).

• Обнаруживает запись после конца буфера (переполнение буфера).

• Проверяет, что GIL удерживается при вызове функций распределителя областей PYMEM_DOMAIN_OBJ (например: PyObject_Malloc()) и PYMEM_DOMAIN_MEM (например: PyMem_Malloc()).

При ошибке отладочные ловушки используют модуль tracemalloc для получения traceback'а места, где был выделен блок памяти. Traceback отображается только в том случае, если tracemalloc отслеживает выделения памяти Python, и блок памяти был отслежен.

Пусть S = sizeof(size_t). 2*S байтов добавляется с каждого конца каждого блока из N запрошенных байтов. Расположение в памяти выглядит следующим образом, где p представляет адрес, возвращаемый функцией типа malloc или realloc (p[i:j] означает срез байтов от *(p+i) включительно до *(p+j) исключительно; обратите внимание, что обработка отрицательных индексов отличается от среза Python):

p[-2*S:-S]

Количество байтов, первоначально запрошенное. Это size_t с прямым порядком байтов (легче читать в дампе памяти).

p[-S]

Идентификатор API (символ ASCII):

• 'r' для PYMEM_DOMAIN_RAW.

• 'm' для PYMEM_DOMAIN_MEM.

• 'o' для PYMEM_DOMAIN_OBJ.

p[-S+1:0]

Копии PYMEM_FORBIDDENBYTE. Используются для обнаружения записи и чтения до начала буфера.

p[0:N]

Запрошенная память, заполненная копиями PYMEM_CLEANBYTE, используется для обнаружения ссылок на неинициализированную память. При вызове функции типа realloc с запросом большего блока памяти новые избыточные байты также заполняются PYMEM_CLEANBYTE. При вызове функции типа free эти байты перезаписываются PYMEM_DEADBYTE для обнаружения ссылок на освобождённую память. При вызове функции типа realloc с запросом меньшего блока памяти избыточные старые байты также заполняются PYMEM_DEADBYTE.

p[N:N+S]

Копии PYMEM_FORBIDDENBYTE. Используются для обнаружения записи и чтения после конца буфера.

p[N+S:N+2*S]

Используется только если определён макрос PYMEM_DEBUG_SERIALNO (по умолчанию не определён).

Серийный номер, увеличиваемый на 1 при каждом вызове функции типа malloc или realloc. Big-endian size_t. Если позже будет обнаружена «плохая память», серийный номер даёт отличный способ установить точку останова при следующем запуске, чтобы зафиксировать момент, когда этот блок был выдан. Статическая функция bumpserialno() в obmalloc.c – единственное место, где серийный номер увеличивается, и она существует, чтобы можно было легко установить такую точку останова.

Функция типа realloc или free сначала проверяет, что байты PYMEM_FORBIDDENBYTE на каждом конце не повреждены. Если они были изменены, диагностический вывод записывается в stderr, и программа аварийно завершается через Py_FatalError(). Другой основной режим отказа – провоцирование ошибки памяти, когда программа читает один из специальных битовых шаблонов и пытается использовать его как адрес. Если затем войти в отладчик и посмотреть на объект, скорее всего, можно увидеть, что он полностью заполнен PYMEM_DEADBYTE (что означает использование освобождённой памяти) или PYMEM_CLEANBYTE (что означает использование неинициализированной памяти).

Распределитель pymalloc¶The pymalloc allocator

В Python есть распределитель pymalloc, оптимизированный для небольших объектов (размером до 512 байт включительно) с коротким временем жизни. Он использует отображения памяти, называемые «аренами», фиксированного размера: 256 Кбайт на 32-разрядных платформах или 1 Мбайт на 64-разрядных платформах. Для выделений памяти размером более 512 байт он обращается к PyMem_RawMalloc() и PyMem_RawRealloc().

pymalloc – это распределитель по умолчанию для доменов PYMEM_DOMAIN_MEM (например: PyMem_Malloc()) и PYMEM_DOMAIN_OBJ (например: PyObject_Malloc()).

Распределитель арен использует следующие функции:

• VirtualAlloc() и VirtualFree() в Windows,

• mmap() и munmap(), если доступно,

• malloc() и free() в противном случае.

Этот аллокатор отключается, если Python собран с опцией --without-pymalloc. Его также можно отключить во время выполнения с помощью переменной окружения PYTHONMALLOC (например, PYTHONMALLOC=malloc).

C API tracemalloc¶tracemalloc C API

int PyTraceMalloc_Track(unsigned int domain, uintptr_t ptr, size_t size)¶

Отследить выделенный блок памяти в модуле tracemalloc.

Возвращает 0 в случае успеха, -1 в случае ошибки (не удалось выделить память для хранения трассировки). Возвращает -2, если tracemalloc отключен.

Если блок памяти уже отслеживается, обновить существующую трассировку.

int PyTraceMalloc_Untrack(unsigned int domain, uintptr_t ptr)¶

Перестать отслеживать выделенный блок памяти в модуле tracemalloc. Ничего не делать, если блок не отслеживался.

Возвращает -2, если tracemalloc отключен, в противном случае возвращает 0.

Примеры¶Examples

Вот пример из раздела Обзор, переписанный так, чтобы буфер ввода-вывода выделялся из кучи Python с помощью первого набора функций:

PyObject *res;
char *buf = (char *) PyMem_Malloc(BUFSIZ); /* для ввода-вывода */

if (buf == NULL)
    return PyErr_NoMemory();
/* ...Выполнить некоторые операции ввода-вывода с buf... */
res = PyBytes_FromString(buf);
PyMem_Free(buf); /* выделено с помощью PyMem_Malloc */
return res;

Тот же код с использованием тип-ориентированного набора функций:

PyObject *res;
char *buf = PyMem_New(char, BUFSIZ); /* для ввода-вывода */

if (buf == NULL)
    return PyErr_NoMemory();
/* ...Выполнить некоторые операции ввода-вывода с buf... */
res = PyBytes_FromString(buf);
PyMem_Del(buf); /* выделено с помощью PyMem_New */
return res;

Обратите внимание, что в двух приведённых выше примерах буфер всегда обрабатывается с помощью функций из одного и того же набора. Действительно, для данного блока памяти необходимо использовать одно и то же семейство API для работы с памятью, чтобы риск смешивания разных аллокаторов был сведён к минимуму. Следующая последовательность кода содержит две ошибки, одна из которых помечена как фатальная, поскольку она смешивает два разных аллокатора, работающих с разными кучами.

char *buf1 = PyMem_New(char, BUFSIZ);
char *buf2 = (char *) malloc(BUFSIZ);
char *buf3 = (char *) PyMem_Malloc(BUFSIZ);
...
PyMem_Del(buf3);  /* Неверно -- следует использовать PyMem_Free() */
free(buf2);       /* Верно -- выделено через malloc() */
free(buf1);       /* Фатальная ошибка – следует использовать PyMem_Del()  */

В дополнение к функциям, предназначенным для работы с сырыми блоками памяти из кучи Python, объекты в Python выделяются и освобождаются с помощью PyObject_New, PyObject_NewVar и PyObject_Del().

Они будут описаны в следующей главе, посвящённой определению и реализации новых типов объектов на C.