.\" Copyright (C) Michael Kerrisk, 2004
.\"	using some material drawn from earlier man pages
.\"	written by Thomas Kuhn, Copyright 1996
.\"
.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, see
.\" <http://www.gnu.org/licenses/>.
.\" %%%LICENSE_END
.\"
.\"*******************************************************************
.\"
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.\"
.\" Japanese Version Copyright (c) 1997 HANATAKA Shinya
.\"         all rights reserved.
.\" Translated 1997-02-23, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
.\" Updated 2003-10-12, Kentaro Shirakata <argrath@ub32.org>
.\" Updated 2004-05-23, kentaro Shirakata <argrath@ub32.org>
.\" Updated 2005-03-29, kentaro Shirakata <argrath@ub32.org>
.\" Updated 2005-11-04, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\" Updated 2006-02-14, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\" Updated 2008-11-10, Akihiro MOTOKI, LDP v3.13
.\" Updated 2012-05-01, Akihiro MOTOKI <amotoki@gmail.com>
.\" Updated 2013-03-26, Akihiro MOTOKI <amotoki@gmail.com>
.\"
.TH MLOCK 2 2020\-04\-11 Linux "Linux Programmer's Manual"
.SH 名前
mlock, mlock2, munlock, mlockall, munlockall \- メモリーのロックとロック解除を行う
.SH 書式
.nf
\fB#include <sys/mman.h>\fP
.PP
\fBint mlock(const void *\fP\fIaddr\fP\fB, size_t \fP\fIlen\fP\fB);\fP
\fBint mlock2(const void *\fP\fIaddr\fP\fB, size_t \fP\fIlen\fP\fB, int \fP\fIflags\fP\fB);\fP
\fBint munlock(const void *\fP\fIaddr\fP\fB, size_t \fP\fIlen\fP\fB);\fP
.PP
\fBint mlockall(int \fP\fIflags\fP\fB);\fP
\fBint munlockall(void);\fP
.fi
.SH 説明
\fBmlock\fP() と \fBmlockall\fP() は、呼び出し元プロセスの仮想アドレス空間の一部または全部を RAM
上にロックし、メモリーがスワップエリアにページングされるのを防ぐ。
.PP
\fBmunlock\fP()  と \fBmunlockall\fP()  は逆の操作で、それぞれ呼び出し元プロセスの仮想アドレス空間の一部または全部を
ロック解除する。つまり、指定された仮想アドレス範囲のページは カーネルメモリーマネージャーから要求されればスワップアウトするようになる。
メモリーのロックとロック解除はページ単位で行われる。
.PP
メモリーのロックとロック解除はページ単位で行われる。
.SS "mlock(), mlock2(), munlock()"
\fBmlock\fP()  は \fIaddr\fP から始まる長さ \fIlen\fP バイトのアドレス範囲のページをロックする。 呼び出しが成功した場合には、
指定されたアドレス範囲を含む全てのページは RAM に残り続けることが保証される。 これらのページは後でロック解除されるまで RAM
に残り続けることが保証される。
.PP
.\" commit a8ca5d0ecbdde5cc3d7accacbd69968b0c98764e
.\" commit de60f5f10c58d4f34b68622442c0e04180367f3f
.\" commit b0f205c2a3082dd9081f9a94e50658c5fa906ff1
\fBmlock2\fP()  also locks pages in the specified range starting at \fIaddr\fP and
continuing for \fIlen\fP bytes.  However, the state of the pages contained in
that range after the call returns successfully will depend on the value in
the \fIflags\fP argument.
.PP
The \fIflags\fP argument can be either 0 or the following constant:
.TP 
\fBMLOCK_ONFAULT\fP
Lock pages that are currently resident and mark the entire range so that the
remaining nonresident pages are locked when they are populated by a page
fault.
.PP
If \fIflags\fP is 0, \fBmlock2\fP()  behaves exactly the same as \fBmlock\fP().
.PP
\fBmunlock\fP()  は、 \fIaddr\fP から始まる長さ \fIlen\fP バイトのアドレス範囲のページのロックを解除する。
この呼び出しを行った後は、カーネルが、指定されたメモリー範囲を含む 全てのページを外部のスワップ空間に移動できるようになる。
.SS "mlockall() と munlockall()"
\fBmlockall\fP()  は呼び出し元プロセスのアドレス空間にマップされている全てのページを ロックする。これにはコード、データ、スタックの
各セグメント、共有ライブラリ、カーネルのユーザー空間データ、 共有メモリー、メモリーマップされたファイルが含まれる。
システムコールが成功した場合には全てのマップされたページは RAM に 残ることを保証される。 これらのページは後でロック解除されるまで RAM
に残り続けることが保証される。
.PP
\fIflags\fP 引数は以下の内容の一つまたは複数のビット OR から構成される:
.TP 
\fBMCL_CURRENT\fP
現在、プロセスのアドレス空間にマップされている全てのページをロックする。
.TP 
\fBMCL_FUTURE\fP
将来、プロセスのアドレス空間にマップされる全てのページをロックする。 例えば、ヒープ (heap) やスタックの成長により新しく必要になったページだけで
なく、新しくメモリーマップされたファイルや共有メモリー領域もロックされる。
.TP 
\fBMCL_ONFAULT\fP (Linux 4.4 以降)
Used together with \fBMCL_CURRENT\fP, \fBMCL_FUTURE\fP, or both.  Mark all current
(with \fBMCL_CURRENT\fP)  or future (with \fBMCL_FUTURE\fP)  mappings to lock
pages when they are faulted in.  When used with \fBMCL_CURRENT\fP, all present
pages are locked, but \fBmlockall\fP()  will not fault in non\-present pages.
When used with \fBMCL_FUTURE\fP, all future mappings will be marked to lock
pages when they are faulted in, but they will not be populated by the lock
when the mapping is created.  \fBMCL_ONFAULT\fP must be used with either
\fBMCL_CURRENT\fP or \fBMCL_FUTURE\fP or both.
.PP
\fBMCL_FUTURE\fP が指定されていると、以後のシステムコール (例えば、 \fBmmap\fP(2), \fBsbrk\fP(2),
\fBmalloc\fP(3))  は、ロックするバイト数が許可された最大値 (下記参照) を超えた場合に 失敗する可能性がある。
同様に、スタックの成長も失敗する可能性がある。 その場合、カーネルはスタックの拡張を拒否し、 \fBSIGSEGV\fP をプロセスに送る。
.PP
\fBmunlockall\fP()  は、呼び出し元プロセスのアドレス空間にマッピングされている 全てのページをロック解除する。
.SH 返り値
成功した場合は、これらのシステムコールはゼロを返す。 エラーの場合は \-1 が返され、 \fIerrno\fP
が適切に設定され、プロセスのアドレス空間におけるロックは変更されない。
.SH エラー
.TP 
\fBENOMEM\fP
(Linux 2.6.9 以降) 呼び出し元は非ゼロの ソフト資源制限 \fBRLIMIT_MEMLOCK\fP
を持つが、制限が許可している以上のメモリーをロックしようとした。 この制限は、プロセスが特権 (\fBCAP_IPC_LOCK\fP)
を持っている場合は適用されない。
.TP 
\fBENOMEM\fP
.\" In the case of mlock(), this check is somewhat buggy: it doesn't
.\" take into account whether the to-be-locked range overlaps with
.\" already locked pages.  Thus, suppose we allocate
.\" (num_physpages / 4 + 1) of memory, and lock those pages once using
.\" mlock(), and then lock the *same* page range a second time.
.\" In the case, the second mlock() call will fail, since the check
.\" calculates that the process is trying to lock (num_physpages / 2 + 2)
.\" pages, which of course is not true.  (MTK, Nov 04, kernel 2.4.28)
(Linux 2.4 以前) 呼び出し元プロセスが RAM の半分以上をロックしようとした。
.TP 
\fBEPERM\fP
.\"SVr4 documents an additional EAGAIN error code.
呼び出し側が特権を持っていないが、
要求された操作を実行するには特権 (\fBCAP_IPC_LOCK\fP) が必要である。
.PP
For \fBmlock\fP(), \fBmlock2\fP(), and \fBmunlock\fP():
.TP 
\fBEAGAIN\fP
指定されたアドレス範囲の一部または全てをロックすることができなかった。
.TP 
\fBEINVAL\fP
\fIaddr\fP+\fIlen\fP の加算の結果が \fIaddr\fP よりも小さかった (例えば、加算でオーバーフローが発生したなど)。
.TP 
\fBEINVAL\fP
(Linux ではこの意味で使われない)  \fIaddr\fP がページサイズの倍数ではない。
.TP 
\fBENOMEM\fP
指定されたアドレス範囲がプロセスのアドレス空間にマップされたページと 一致しない。
.TP 
\fBENOMEM\fP
.\" I.e., the number of VMAs would exceed the 64kB maximum
Locking or unlocking a region would result in the total number of mappings
with distinct attributes (e.g., locked versus unlocked)  exceeding the
allowed maximum.  (For example, unlocking a range in the middle of a
currently locked mapping would result in three mappings: two locked mappings
at each end and an unlocked mapping in the middle.)
.PP
For \fBmlock2\fP():
.TP 
\fBEINVAL\fP
未知の \fIflags\fP が指定された。
.PP
\fBmlockall\fP()  用として:
.TP 
\fBEINVAL\fP
Unknown \fIflags\fP were specified or \fBMCL_ONFAULT\fP was specified without
either \fBMCL_FUTURE\fP or \fBMCL_CURRENT\fP.
.PP
\fBmunlockall\fP()  用として:
.TP 
\fBEPERM\fP
(Linux 2.6.8 以前) 呼び出し元が権限 (\fBCAP_IPC_LOCK\fP)  を持っていない。
.SH バージョン
\fBmlock2\fP()  is available since Linux 4.4; glibc support was added in
version 2.27.
.SH 準拠
POSIX.1\-2001, POSIX.1\-2008, SVr4.
.PP
\fBmlock2\fP() は Linux 固有である。
.PP
\fBmlock\fP()  と \fBmunlock\fP()  が使用可能な POSIX システムでは \fB_POSIX_MEMLOCK_RANGE\fP が
\fI<unistd.h>\fP で定義されている。 また、ページあたりのバイト数は、 \fI<limits.h>\fP
で定義される定数 \fBPAGESIZE\fP から (定義されている場合)、もしくは \fIsysconf(_SC_PAGESIZE)\fP
を呼び出すことで決定できる。
.PP
.\" POSIX.1-2001: It shall be defined to -1 or 0 or 200112L.
.\" -1: unavailable, 0: ask using sysconf().
.\" glibc defines it to 1.
\fBmlockall\fP()  と \fBmunlockall\fP()  が利用可能な POSIX システムでは、 \fB_POSIX_MEMLOCK\fP は
\fI<unistd.h>\fP で 0 より大きい値に定義されている (\fBsysconf\fP(3)  も参照のこと)。
.SH 注意
メモリーのロックの用途としては主に二つある: リアルタイム アルゴリズムと高いセキュリティの必要なデータ処理である。リアルタイムの
アプリケーションは決定的なタイミングやスケジューリングを必要とするが、 ページングは予期しないプログラムの実行遅延をもたらす主要な要因となる。
リアルタイムのアプリケーションはたいていは \fBsched_setscheduler\fP(2)  でリアルタイムスケジューラに変更される。
暗号やセキュリティのソフトウェアはしばしばパスワードや秘密鍵のデータの ような重要なバイト列を扱う。ページングの結果、これらの秘密が
スワップ用の固定媒体に転送されるかもしれない。そして、セキュリティ ソフトウェアが RAM 上の秘密を削除して終了したずっと後になっても、
このスワップされたデータには敵がアクセスできる可能性がある (しかし、ラップトップといくつかのデスクトップコンピュータの サスペンドモードはシステムの
RAM の内容をメモリーのロックに関わらず ディスクに保存することに注意)。
.PP
リアルタイムプロセスが \fBmlockall\fP()  を使ってページフォールトによる遅延を防ごうとする場合、
関数呼び出しによってページフォールトが発生しないように、 時間制限の厳しい部分 (time\-critical section) に入る前に
十分な量のロックされたスタックを確保しておく必要がある。 これを実現するには、十分な大きさの自動変数 (の配列) を確保し、
これらのスタック用のページがメモリー上に確保されるようにこの配列に 書き込みを行う関数を用意し、これを呼び出せばよい。こうすることで、
十分な量のページがスタックにマッピングされ、RAM にロックされる。 ダミーの書き込みを行うことによって、 時間制限の厳しい部分 (critical
section) 内では書き込み時コピーによる ページフォールトさえも発生しないことが保証される。
.PP
Memory locks are not inherited by a child created via \fBfork\fP(2)  and are
automatically removed (unlocked) during an \fBexecve\fP(2)  or when the process
terminates.  The \fBmlockall\fP()  \fBMCL_FUTURE\fP and \fBMCL_FUTURE |
MCL_ONFAULT\fP settings are not inherited by a child created via \fBfork\fP(2)
and are cleared during an \fBexecve\fP(2).
.PP
Note that \fBfork\fP(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 \fBfork\fP(2)  after an \fBmlockall\fP()
or \fBmlock\fP()  operation\(emnot even from a thread which runs at a low
priority within a process which also has a thread running at elevated
priority.
.PP
あるアドレス範囲に対するメモリーロックは、そのアドレス範囲が \fBmunmap\fP(2)  によってアンマップされた場合は削除される。
.PP
メモリーのロックは累積しない。 すなわち複数回 \fBmlock\fP(), \fBmlock2\fP(), \fBmlockall\fP()
を呼び出してロックされたページでも、 対応する範囲に対して \fBmunlock\fP()  を 1 回呼び出したり \fBmunlockall\fP()
を呼び出したりするだけでロック解除される。 複数の場所や複数のプロセスにマップされているページは、少なくとも一つの場所、
一つのプロセスでロックされている限りは RAM に残り続ける。
.PP
If a call to \fBmlockall\fP()  which uses the \fBMCL_FUTURE\fP flag is followed by
another call that does not specify this flag, the changes made by the
\fBMCL_FUTURE\fP call will be lost.
.PP
The \fBmlock2\fP()  \fBMLOCK_ONFAULT\fP flag and the \fBmlockall\fP()  \fBMCL_ONFAULT\fP
flag allow efficient memory locking for applications that deal with large
mappings where only a (small) portion of pages in the mapping are touched.
In such cases, locking all of the pages in a mapping would incur a
significant penalty for memory locking.
.SS "Linux での注意"
Linux では、 \fBmlock\fP(), \fBmlock2\fP(), \fBmunlock\fP() は自動的に \fIaddr\fP
を端数切り捨てにより一番近いページ境界へと丸める。 しかし POSIX.1 仕様の \fBmlock\fP() と \fBmunlock\fP() は
\fIaddr\fP がページ境界に合っていることを要求する実装も許している。 そのため移植性を意図したアプリケーションではきちんと境界に合わせた方が良い。
.PP
Linux 固有の \fI/proc/[pid]/status\fP ファイルの \fIVmLck\fP フィールドには、 \fBmlock\fP(),
\fBmlock2\fP(), \fBmlockall\fP() および \fBmmap\fP(2) \fBMAP_LOCKED\fP を使って、 ID が \fIPID\fP
のプロセスがロックしているメモリー量 (キロバイト単位) が表示される。
.SS 制限と権限
Linux 2.6.8 以前では、メモリーをロックするためには特権 (\fBCAP_IPC_LOCK\fP)  が必要で、 ソフト資源制限
\fBRLIMIT_MEMLOCK\fP はプロセスがどれだけのメモリーをロックできるかの制限を定義する。
.PP
Linux 2.6.9 以降では、特権を持つプロセスがロックできるメモリー量は無制限となり、 代わりにソフト資源制限 \fBRLIMIT_MEMLOCK\fP
は特権を持たないプロセスがロックできるメモリー量の制限を定義する。
.SH バグ
.\" commit 0cf2f6f6dc605e587d2c1120f295934c77e810e8
In Linux 4.8 and earlier, a bug in the kernel's accounting of locked memory
for unprivileged processes (i.e., without \fBCAP_IPC_LOCK\fP)  meant that if
the region specified by \fIaddr\fP and \fIlen\fP overlapped an existing lock, then
the already locked bytes in the overlapping region were counted twice when
checking against the limit.  Such double accounting could incorrectly
calculate a "total locked memory" value for the process that exceeded the
\fBRLIMIT_MEMLOCK\fP limit, with the result that \fBmlock\fP()  and \fBmlock2\fP()
would fail on requests that should have succeeded.  This bug was fixed in
Linux 4.9.
.PP
2.4.17 までの 2.4 シリーズの Linux カーネルには、 \fBmlockall\fP()  \fBMCL_FUTURE\fP フラグが
\fBfork\fP(2)  で継承されると言うバグがある。 これはカーネル 2.4.18 で修正された。
.PP
.\" See the following LKML thread:
.\" http://marc.theaimsgroup.com/?l=linux-kernel&m=113801392825023&w=2
.\" "Rationale for RLIMIT_MEMLOCK"
.\" 23 Jan 2006
カーネル 2.6.9 以降では、特権を持ったプロセスが \fImlockall(MCL_FUTURE)\fP を呼び出した後で、特権をなくした場合 (例えば、
実効 UID を 0 以外の値に変更するなどにより、 \fBCAP_IPC_LOCK\fP ケーパビリティを失った場合)、リソース上限
\fBRLIMIT_MEMLOCK\fP に達すると、それ以降のメモリー割り当て (例えば \fBmmap\fP(2), \fBbrk\fP(2))  は失敗する。
.SH 関連項目
\fBmincore\fP(2), \fBmmap\fP(2), \fBsetrlimit\fP(2), \fBshmctl\fP(2), \fBsysconf\fP(3),
\fBproc\fP(5), \fBcapabilities\fP(7)
.SH この文書について
この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 5.10 の一部である。プロジェクトの説明とバグ報告に関する情報は
\%https://www.kernel.org/doc/man\-pages/ に書かれている。