Управление памятью¶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 = PyString_FromString(buf);
free(buf); /* выделено через malloc */
return res;

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

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

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

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

void* PyMem_Malloc(size_t n)¶

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

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

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

void PyMem_Free(void *p)¶

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

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

TYPE* PyMem_New(TYPE, size_t n)¶

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

TYPE* PyMem_Resize(void *p, TYPE, size_t 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, PyMem_REALLOC, PyMem_FREE.

PyMem_NEW, PyMem_RESIZE, PyMem_DEL.

Примеры¶Examples

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

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

if (buf == NULL)
    return PyErr_NoMemory();
/* ...Выполнить некоторые операции ввода-вывода с buf... */
res = PyString_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 = PyString_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.