mlock(2)

ИМЯ
mlock, mlock2, munlock, mlockall, munlockall - блокируют и разблокируют память

LIBRARY
Standard C library (libc, -lc)

СИНТАКСИС
#include <sys/mman.h>

int mlock(const void addr[.len], size_t len);
int mlock2(const void addr[.len], size_t len, unsigned int flags);
int munlock(const void addr[.len], size_t len);

int mlockall(int flags);
int munlockall(void);

ОПИСАНИЕ
Вызовы mlock(), mlock2() и mlockall() блокируют часть или всё виртуальное адресное пространство процесса в ОЗУ, запрещая эту память перемещать в пространство подкачки.

Вызовы munlock() и munlockall() выполняют обратную операцию, разблокируя часть или всё виртуальное адресное пространство процесса, после чего страницы в этом диапазоне виртуальных адресов могут вытесняться в пространство подкачки, если того потребуется менеджеру памяти ядра.

Размер блокировки и разблокировки памяти округляется до целых страниц.

  mlock(), mlock2() и munlock()
Вызов mlock() блокирует страницы в адресном диапазоне, начиная с addr и длиной len байтов. Все страницы, попадающие, даже частично, в заданную область, будут гарантировано помещены в ОЗУ, если системный вызов выполнился успешно; страницы гарантировано останутся в ОЗУ пока не будут разблокированы.

Вызов mlock2() также блокирует страницы в адресном диапазоне, начиная с addr и длиной len байтов. Однако состояние страниц в этом диапазоне после успешного выполнения вызова будет зависеть от значения аргумента flags.

Параметр flags может принимать значение 0 или одну из следующих констант:

MLOCK_ONFAULT
    Блокировать страницы, которые в настоящее время уже есть в памяти и пометить весь диапазон так, чтобы оставшиеся вне памяти страницы блокировались, когда они будут заполнены из-за страничного промаха (fault).

Если параметр flags равен 0, то mlock2() ведёт себя точно так же как mlock().

Вызов munlock() разблокирует страницы в области, начинающейся с адреса addr и длиной len байтов. После этого вызова все страницы, попадающие, даже частично, в заданную область, снова могут быть помещены ядром во внешнее пространство подкачки.

  mlockall() и munlockall()
Вызов mlockall() блокирует все страницы, отображённые в адресное пространство вызывающего процесса. Сюда входят страницы сегмента кода, данных и стека, а также общих библиотек, страницы с данными пользовательского пространства ядра, общей памяти и файлов, отображённых в память. Все отображённые страницы гарантировано останутся в ОЗУ, если системный вызов выполнился успешно; страницы гарантировано останутся в ОЗУ пока не будут разблокированы.

Аргумент flags создаётся побитовым сложением одной или более следующих констант:

MCL_CURRENT
    Блокировать все страницы, которые в данный момент отображены в адресное пространство процесса.

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

MCL_ONFAULT (начиная с Linux 4.4)
    Используется вместе с MCL_CURRENT, MCL_FUTURE или обоими. Пометить все текущие (с MCL_CURRENT) или будущие (с MCL_FUTURE) отображения для блокировки страниц, когда они получаются при сбое (faulted in). При использовании с MCL_CURRENT все существующие страницы блокируются, но mlockall() не будет сбоить на несуществующих страницах. При использовании с MCL_FUTURE все будущие отображения будут помечены для блокировки страниц при сбое, но они не будут заполнены из-за блокировки при создании отображения. Флаг MCL_ONFAULT должен использовать одновременно с MCL_CURRENT или MCL_FUTURE или обоими.

Если указан флаг MCL_FUTURE, то последующий системный вызов (например, mmap(2), sbrk(2), malloc(3)), может завершиться с ошибкой, если бы его работа приводит к превышению разрешённого максимального числа блокируемых байт (см. ниже). Также этот флаг может остановить увеличение стека: ядро будет отказывать в увеличении стека и будет посылать процессу сигнал SIGSEGV.

Вызов munlockall() разблокирует все страницы, отображённые в адресное пространство вызывающего процесса.

ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ
On success, these system calls return 0. On error, -1 is returned, errno is set to indicate the error, and no changes are made to any locks in the address space of the process.

ОШИБКИ

EAGAIN
    (mlock(), mlock2() и munlock()) Невозможно заблокировать некоторую часть или весь диапазон адресов.

EINVAL
    (mlock(), mlock2() и munlock()) Результат добавления addr+len стал меньше чем addr (например, добавление могло привести к переполнению).

EINVAL
    (mlock2()) Указан неизвестный флаг в flags.

EINVAL
    (mlockall()) Неизвестное значение в flags или MCL_ONFAULT задан без MCL_FUTURE или MCL_CURRENT.

EINVAL
    (Не в Linux) Значение addr не кратно размеру страницы.

ENOMEM
    (mlock(), mlock2() и munlock()) Часть указанного адресного диапазона не соответствует отображённым страницам адресного пространства процесса.

ENOMEM
    (mlock(), mlock2() и munlock()) Блокировка и разблокировка области привела бы к превышению разрешённого максимума на количество отображений с различающимися атрибутами (блокированных и разблокированных). Например, разблокировка диапазона в середине области в данный момент блокированного отображения привела бы к трём отображениям: два блокированных отображения на концах и доступное разблокированное отображение посередине.

ENOMEM
    (Linux 2.6.9 и новее) У вызывающего процесса установлено ненулевое мягкое ограничение ресурса RLIMIT_MEMLOCK, но он пытается заблокировать больше памяти, чем это разрешено ограничением. Данное ограничение не учитывается у привилегированных процессов (CAP_IPC_LOCK).

ENOMEM
    (Linux 2.4 и в более ранних) Вызывающий процесс пытается заблокировать более половины ОЗУ.

EPERM
    Вызывающий не имеет прав (CAP_IPC_LOCK) для выполнения запрошенной операции.

EPERM
    (munlockall()) (Linux 2.6.8 и более ранних) Вызывающий процесс не имеет достаточно прав (CAP_IPC_LOCK).

ВЕРСИИ
mlock2() is available since Linux 4.4; glibc support was added in glibc 2.27.

СТАНДАРТЫ
mlock(), munlock(), mlockall() и munlockall(): POSIX.1-2001, POSIX.1-2008, SVr4.

mlock2() определена только в Linux.

В POSIX-системах, в которых доступны mlock() и munlock(), значение _POSIX_MEMLOCK_RANGE определено в <unistd.h>, а количество байт в странице можно определить из константы PAGESIZE (если определена) в <limits.h> или вызвав sysconf(_SC_PAGESIZE).

В POSIX-системах, в которых доступны mlockall() и munlockall(), значение _POSIX_MEMLOCK, определенное в <unistd.h>, больше нуля (см. также sysconf(3)).

ЗАМЕЧАНИЯ
Блокировка памяти используется, в основном, в двух случаях: в алгоритмах реального времени и при работе с секретными данными. Программам реального времени необходима предсказуемость времени выполнения, а страничный обмен (наряду с системой переключения процессов) может привести к неожиданным задержкам в работе. Такие приложения часто переключаются в режим реального времени при помощи вызовы sched_setscheduler(2). Криптографические системы защиты данных очень часто содержат важные данные, например, пароли или секретные ключи, в структурах данных. В результате страничного обмена эти данные могут попасть в область подкачки, находящуюся на устройстве длительного хранения, где к этим данным после того, как они пропадут из ОЗУ, может получить доступ практически кто угодно. (Помните, что в режиме приостановки (suspend) на ноутбуках и некоторых компьютерах на жёсткий диск сохраняется копия памяти ОЗУ системы, независимо от блокировок памяти).

Процессы реального времени, использующие mlockall() для устранения задержек при страничных прерываниях (page fault), должны зарезервировать достаточно заблокированных страниц стека до входа в критический ко времени участок, для того, чтобы вызов функции не мог привести к страничному прерыванию. Это можно выполнить с помощью вызова функции, которая выделит место под достаточно большую автоматическую переменную (массив) и выполнит запись в память для того, чтобы этот массив занял место в странице стека. Таким путём будет отображено достаточно страниц для стека, которые можно заблокировать в ОЗУ. Бесполезная запись нужна для того, чтобы в критическом участке не возникло страничное прерывание для копирования страницы при записи.

Блокировка памяти не наследуется дочерними процессами, созданными при помощи fork(2), и автоматически удаляется (разблокируется) при выполнении execve(2) или при завершении работы процесса. Установка MCL_FUTURE и MCL_FUTURE | MCL_ONFAULT в mlockall() не наследуется потомком, созданными при помощи fork(2), и автоматически стирается при выполнении execve(2).

Note that fork(2) will prepare the address space for a copy-on-write operation. The consequence is that any write access that follows will cause a page fault that in turn may cause high latencies for a real-time process. Therefore, it is crucial not to invoke fork(2) after an mlockall() or mlock() operation—not even from a thread which runs at a low priority within a process which also has a thread running at elevated priority.

Блокировка памяти адресного диапазона автоматически удаляется, если этот диапазон становится неотображаемым с помощью вызова munmap(2).

Блокировки памяти не накапливаются, то есть, если страница была заблокирована вызовами mlock(), mlock2() или mlockall() несколько раз, то она будет разблокирована единственным вызовом munlock() для соответствующего диапазона или с помощью вызова munlockall(). Страницы, которые были отображены в несколько мест или несколькими процессами, останутся заблокированными в ОЗУ до тех пор, пока они блокируются хотя бы в одном месте или хотя бы в одном процессе.

Если послед вызова mlockall() с флагом MCL_FUTURE идёт другой вызов, у которого нет этого флага, то изменения, сделанные вызовом с MCL_FUTURE будут потеряны.

Флаг MLOCK_ONFAULT у mlock2() и MCL_ONFAULT у mlockall() позволяют эффективно блокировать память в приложениях, которые работают с большим количеством отображений, где только задействуется часть (малая) страниц в отображении. В таких случаях блокировка всех страниц в отображении приводила бы к значительным простоям из-за блокировки памяти.

  Замечания, касающиеся Linux
В Linux, mlock(), mlock2() и munlock() автоматически округляют addr в меньшую сторону к размеру границы ближайшей страницы. Однако, в POSIX.1 указано, что реализации mlock() и munlock() разрешено требовать, чтобы значение addr было выровнено по размеру страницы, поэтому переносимые приложения должны выполнять выравнивание.

В поле VmLck, имеющемся только в Linux файле /proc/[pid]/status, показано сколько килобайт памяти заблокировал процесс с идентификатором PID с помощью mlock(), mlock2(), mlockall() и mmap(2) с флагом MAP_LOCKED.

  Ограничения и права доступа
В Linux версии 2.6.8 и более ранних для блокировки памяти процесс должен иметь мандат (CAP_IPC_LOCK), а мягкое ограничение ресурса RLIMIT_MEMLOCK определяет как много памяти можно заблокировать.

Начиная с Linux 2.6.9, привилегированный процесс не имеет ограничения на ограничиваемое количество памяти, а мягкое ограничение ресурса RLIMIT_MEMLOCK определяет предел ограничиваемой памяти для непривилегированных процессов.

ДЕФЕКТЫ
В Linux 4.8 и старее имеется дефект учёта блокированной памяти непривилегированных процессов (т. е., без CAP_IPC_LOCK) в ядре, состоящий в том, что если область, указанная addr и len перекрывает существующую блокировку, то при проверке ограничений уже заблокированные байты перекрывающей области учитываются дважды. Из-за такого двойного учёта может некорректно вычисляться значение «общего количества заблокированной памяти», и процесс, который превышает ограничение RLIMIT_MEMLOCK, в результате mlock() и mlock2() получит ошибку при запросах, которые должны выполняться успешно. Этот дефект был исправлен в Linux 4.9.

In Linux 2.4 series of kernels up to and including Linux 2.4.17, a bug caused the mlockall() MCL_FUTURE flag to be inherited across a fork(2). This was rectified in Linux 2.4.18.

Since Linux 2.6.9, if a privileged process calls mlockall(MCL_FUTURE) and later drops privileges (loses the CAP_IPC_LOCK capability by, for example, setting its effective UID to a nonzero value), then subsequent memory allocations (e.g., mmap(2), brk(2)) will fail if the RLIMIT_MEMLOCK resource limit is encountered.

СМ. ТАКЖЕ
mincore(2), mmap(2), setrlimit(2), shmctl(2), sysconf(3), proc(5), capabilities(7)

ПЕРЕВОД
Русский перевод этой страницы руководства был сделан aereiae <aereiae@gmail.com>, Alexey <a.chepugov@gmail.com>, Azamat Hackimov <azamat.hackimov@gmail.com>, Dmitriy S. Seregin <dseregin@59.ru>, Dmitry Bolkhovskikh <d20052005@yandex.ru>, ITriskTI <ITriskTI@gmail.com>, Max Is <ismax799@gmail.com>, Yuri Kozlov <yuray@komyakino.ru>, Иван Павлов <pavia00@gmail.com> и Малянов Евгений Викторович <maljanow@outlook.com>

Этот перевод является бесплатной документацией; прочитайте Стандартную общественную лицензию GNU версии 3 (https://www.gnu.org/licenses/gpl-3.0.html) или более позднюю, чтобы узнать об условиях авторского права. Мы не несем НИКАКОЙ ОТВЕТСТВЕННОСТИ.

Если вы обнаружите ошибки в переводе этой страницы руководства, пожалуйста, отправьте электронное письмо на man-pages-ru-talks@lists.sourceforge.net.