release/man2/mlock.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright (C) Michael Kerrisk, 2004
   4 .\"     using some material drawn from earlier man pages
   5 .\"     written by Thomas Kuhn, Copyright 1996
   6 .\"
   7 .\" This is free documentation; you can redistribute it and/or
   8 .\" modify it under the terms of the GNU General Public License as
   9 .\" published by the Free Software Foundation; either version 2 of
  10 .\" the License, or (at your option) any later version.
  11 .\"
  12 .\" The GNU General Public License's references to "object code"
  13 .\" and "executables" are to be interpreted as the output of any
  14 .\" document formatting or typesetting system, including
  15 .\" intermediate and printed output.
  16 .\"
  17 .\" This manual is distributed in the hope that it will be useful,
  18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 .\" GNU General Public License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public
  23 .\" License along with this manual; if not, write to the Free
  24 .\" Software Foundation, Inc., 59 Temple Place, Suite 330,
  25 .\" Boston, MA 02111, USA.
  26 .\"
  27 .\"*******************************************************************
  28 .\"
  29 .\" This file was generated with po4a. Translate the source file.
  30 .\"
  31 .\"*******************************************************************
  32 .TH MLOCK 2 2011\-09\-14 Linux "Linux Programmer's Manual"
  33 .SH 名前
  34 mlock \- メモリのロックとロック解除を行う
  35 .SH 書式
  36 .nf
  37 \fB#include <sys/mman.h>\fP
  38 .sp
  39 \fBint mlock(const void *\fP\fIaddr\fP\fB, size_t \fP\fIlen\fP\fB);\fP
  40 \fBint munlock(const void *\fP\fIaddr\fP\fB, size_t \fP\fIlen\fP\fB);\fP
  41 .sp
  42 \fBint mlockall(int \fP\fIflags\fP\fB);\fP
  43 \fBint munlockall(void);\fP
  44 .fi
  45 .SH 説明
  46 \fBmlock\fP()  と \fBmlockall\fP()  はそれぞれ、呼び出し元プロセスの仮想アドレス空間の一部または全部を RAM
  47 上にロックし、メモリがスワップエリアにページングされるのを防ぐ。 \fBmunlock\fP()  と \fBmunlockall\fP()
  48 は逆の操作で、それぞれ呼び出し元プロセスの仮想アドレス空間の一部または全部を ロック解除する。つまり、指定された仮想アドレス範囲のページは
  49 カーネルメモリマネージャーから要求されればスワップアウトするようになる。 メモリのロックとロック解除はページ単位で行われる。
  50 .SS "mlock() と munlock()"
  51 \fBmlock\fP()  は \fIaddr\fP から始まる長さ \fIlen\fP バイトのアドレス範囲のページをロックする。 呼び出しが成功した場合には、
  52 指定されたアドレス範囲を含む全てのページは RAM に残り続けることが保証される。 これらのページは後でロック解除されるまで RAM
  53 に残り続けることが保証される。
  54
  55 \fBmunlock\fP()  は、 \fIaddr\fP から始まる長さ \fIlen\fP バイトのアドレス範囲のページのロックを解除する。
  56 この呼び出しを行った後は、カーネルが、指定されたメモリ範囲を含む 全てのページを外部のスワップ空間に移動できるようになる。
  57 .SS "mlockall() と munlockall()"
  58 \fBmlockall\fP()  は呼び出し元プロセスのアドレス空間にマップされている全てのページを ロックする。これにはコード、データ、スタックの
  59 各セグメント、共有ライブラリ、カーネルのユーザー空間データ、 共有メモリ、メモリ・マップされたファイルが含まれる。
  60 システム・コールが成功した場合には全てのマップされたページは RAM に 残ることを保証される。 これらのページは後でロック解除されるまで RAM
  61 に残り続けることが保証される。
  62
  63 \fIflags\fP 引数は以下の内容の一つまたは複数のビット OR から構成される:
  64 .TP  1.2i
  65 \fBMCL_CURRENT\fP
  66 現在、プロセスのアドレス空間にマップされている全てのページをロックする。
  67 .TP
  68 \fBMCL_FUTURE\fP
  69 将来、プロセスのアドレス空間にマップされる全てのページをロックする。 例えば、ヒープ (heap) やスタックの成長により新しく必要になったページだけで
  70 なく、新しくメモリマップされたファイルや共有メモリ領域もロックされる。
  71 .PP
  72 \fBMCL_FUTURE\fP が指定されていると、以後のシステムコール (例えば、 \fBmmap\fP(2), \fBsbrk\fP(2),
  73 \fBmalloc\fP(3))  は、ロックするバイト数が許可された最大値 (下記参照) を超えた場合に 失敗する可能性がある。
  74 同様に、スタックの成長も失敗する可能性がある。 その場合、カーネルはスタックの拡張を拒否し、 \fBSIGSEGV\fP をプロセスに送る。
  75
  76 \fBmunlockall\fP()  は、呼び出し元プロセスのアドレス空間にマッピングされている 全てのページをロック解除する。
  77 .SH 返り値
  78 成功した場合は、これらのシステムコールはゼロを返す。 エラーの場合は \-1 が返され、 \fIerrno\fP
  79 が適切に設定され、プロセスのアドレス空間におけるロックは変更されない。
  80 .SH エラー
  81 .TP
  82 \fBENOMEM\fP
  83 (Linux 2.6.9 以降) 呼び出し元は非ゼロの ソフト資源制限 \fBRLIMIT_MEMLOCK\fP
  84 を持つが、制限が許可している以上のメモリをロックしようとした。 この制限は、プロセスが特権 (\fBCAP_IPC_LOCK\fP)
  85 を持っている場合は適用されない。
  86 .TP
  87 \fBENOMEM\fP
  88 .\" In the case of mlock(), this check is somewhat buggy: it doesn't
  89 .\" take into account whether the to-be-locked range overlaps with
  90 .\" already locked pages.  Thus, suppose we allocate
  91 .\" (num_physpages / 4 + 1) of memory, and lock those pages once using
  92 .\" mlock(), and then lock the *same* page range a second time.
  93 .\" In the case, the second mlock() call will fail, since the check
  94 .\" calculates that the process is trying to lock (num_physpages / 2 + 2)
  95 .\" pages, which of course is not true.  (MTK, Nov 04, kernel 2.4.28)
  96 (Linux 2.4 以前) 呼び出し元プロセスが RAM の半分以上をロックしようとした。
  97 .TP
  98 \fBEPERM\fP
  99 .\"SVr4 documents an additional EAGAIN error code.
 100 呼び出し側が特権を持っていないが、
 101 要求された操作を実行するには特権 (\fBCAP_IPC_LOCK\fP) が必要である。
 102 .LP
 103 \fBmlock\fP()  と \fBmunlock\fP()  用として:
 104 .TP
 105 \fBEAGAIN\fP
 106 指定されたアドレス範囲の一部または全てをロックすることができなかった。
 107 .TP
 108 \fBEINVAL\fP
 109 \fIstart\fP+\fIlen\fP の加算の結果が \fIstart\fP よりも小さかった
 110 (例えば、加算でオーバーフローが発生したなど)。
 111 .TP
 112 \fBEINVAL\fP
 113 (Linux ではこの意味で使われない)  \fIaddr\fP がページサイズの倍数ではない。
 114 .TP
 115 \fBENOMEM\fP
 116 指定されたアドレス範囲がプロセスのアドレス空間にマップされたページと 一致しない。
 117 .LP
 118 \fBmlockall\fP()  用として:
 119 .TP
 120 \fBEINVAL\fP
 121 未知の \fIflags\fP が指定された。
 122 .LP
 123 \fBmunlockall\fP()  用として:
 124 .TP
 125 \fBEPERM\fP
 126 (Linux 2.6.8 以前) 呼び出し元が権限 (\fBCAP_IPC_LOCK\fP)  を持っていない。
 127 .SH 準拠
 128 POSIX.1\-2001, SVr4.
 129 .SH 可用性
 130 \fBmlock\fP()  と \fBmunlock\fP()  が使用可能な POSIX システムでは \fB_POSIX_MEMLOCK_RANGE\fP が
 131 \fI<unistd.h>\fP で定義されている。 また、ページあたりのバイト数は、 \fI<limits.h>\fP
 132 で定義される定数 \fBPAGESIZE\fP から (定義されている場合)、もしくは \fIsysconf(_SC_PAGESIZE)\fP
 133 を呼び出すことで決定できる。
 134
 135 .\" POSIX.1-2001: It shall be defined to -1 or 0 or 200112L.
 136 .\" -1: unavailable, 0: ask using sysconf().
 137 .\" glibc defines it to 1.
 138 \fBmlockall\fP()  と \fBmunlockall\fP()  が利用可能な POSIX システムでは、 \fB_POSIX_MEMLOCK\fP は
 139 \fI<unistd.h>\fP で 0 より大きい値に定義されている (\fBsysconf\fP(3)  も参照のこと)。
 140 .SH 注意
 141 メモリのロックの用途としては主に二つある: リアルタイム アルゴリズムと高いセキュリティの必要なデータ処理である。リアルタイムの
 142 アプリケーションは決定的なタイミングやスケジューリングを必要とするが、 ページングは予期しないプログラムの実行遅延をもたらす主要な要因となる。
 143 リアルタイムのアプリケーションはたいていは \fBsched_setscheduler\fP(2)  でリアルタイムスケジューラに変更される。
 144 暗号やセキュリティのソフトウェアはしばしばパスワードや秘密鍵のデータの ような重要なバイト列を扱う。ページングの結果、これらの秘密が
 145 スワップ用の固定媒体に転送されるかもしれない。そして、セキュリティ・ ソフトウェアが RAM 上の秘密を削除して終了したずっと後になっても、
 146 このスワップされたデータには敵がアクセスできる可能性がある (しかし、ラップトップといくつかのデスクトップコンピュータの サスペンドモードはシステムの
 147 RAM の内容をメモリのロックに関わらず ディスクに保存することに注意)。
 148
 149 リアルタイムプロセスが \fBmlockall\fP()  を使ってページフォールトによる遅延を防ごうとする場合、
 150 関数呼び出しによってページフォールトが発生しないように、 時間制限の厳しい部分 (time\-critical section) に入る前に
 151 十分な量のロックされたスタックを確保しておく必要がある。 これを実現するには、十分な大きさの自動変数 (の配列) を確保し、
 152 これらのスタック用のページがメモリ上に確保されるようにこの配列に 書き込みを行う関数を用意し、これを呼び出せばよい。こうすることで、
 153 十分な量のページがスタックにマッピングされ、RAM にロックされる。 ダミーの書き込みを行うことによって、 時間制限の厳しい部分 (critical
 154 section) 内では書き込み時コピーによる ページフォールトさえも発生しないことが保証される。
 155
 156 メモリロックは \fBfork\fP(2)  で作成された子プロセスには継承されず、 \fBexecve\fP(2)  が呼ばれたり、プロセスが終了した場合は
 157 自動的に削除される (ロック解除される)。
 158
 159 あるアドレス範囲に対するメモリロックは、そのアドレス範囲が \fBmunmap\fP(2)  によってアンマップされた場合は削除される。
 160
 161 メモリのロックは累積しない。 すなわち複数回 \fBmlock\fP()  や \fBmlockall\fP()  を呼び出してロックされたページでも、
 162 対応する範囲に対して \fBmunlock\fP()  を 1 回呼び出したり \fBmunlockall\fP()  を呼び出したりするだけでロック解除される。
 163 複数の場所や複数のプロセスにマップされているページは、少なくとも一つの場所、 一つのプロセスでロックされている限りは RAM に残り続ける。
 164 .SS "Linux での注意"
 165 Linux では、 \fBmlock\fP()  と \fBmunlock\fP()  は自動的に \fIaddr\fP
 166 を端数切り捨てにより一番近いページ境界へと丸める。 しかし POSIX.1\-2001 は \fIaddr\fP
 167 がページ境界に合っていることを要求する実装も許している。 そのため移植性を意図したアプリケーションではきちんと境界に合わせた方が良い。
 168
 169 Linux 固有の \fI/proc/PID/status\fP ファイルの \fIVmLck\fP フィールドには、
 170 \fBmlock\fP(), \fBmlockall\fP() および \fBmmap\fP(2) \fBMAP_LOCKED\fP を使って、
 171 ID が \fIPID\fP のプロセスがロックしているメモリ量 (キロバイト単位) が
 172 表示される。
 173 .SS 制限と権限
 174 Linux 2.6.8 以前では、メモリをロックするためには特権 (\fBCAP_IPC_LOCK\fP)  が必要で、 ソフト資源制限
 175 \fBRLIMIT_MEMLOCK\fP はプロセスがどれだけのメモリをロックできるかの制限を定義する。
 176
 177 Linux 2.6.9 以降では、特権を持つプロセスがロックできるメモリ量は無制限となり、 代わりにソフト資源制限 \fBRLIMIT_MEMLOCK\fP
 178 は特権を持たないプロセスがロックできるメモリ量の制限を定義する。
 179 .SH バグ
 180 2.4.17 までの 2.4 シリーズの Linux カーネルには、 \fBmlockall\fP()  \fBMCL_FUTURE\fP フラグが
 181 \fBfork\fP(2)  で継承されると言うバグがある。 これはカーネル 2.4.18 で修正された。
 182
 183 .\" See the following LKML thread:
 184 .\" http://marc.theaimsgroup.com/?l=linux-kernel&m=113801392825023&w=2
 185 .\" "Rationale for RLIMIT_MEMLOCK"
 186 .\" 23 Jan 2006
 187 カーネル 2.6.9 以降では、特権を持ったプロセスが \fImlockall(MCL_FUTURE)\fP を呼び出した後で、特権をなくした場合 (例えば、
 188 実効 UID を 0 以外の値に変更するなどにより、 \fBCAP_IPC_LOCK\fP ケーパビリティを失った場合)、リソース上限
 189 \fBRLIMIT_MEMLOCK\fP に達すると、それ以降のメモリ割り当て (例えば \fBmmap\fP(2), \fBbrk\fP(2))  は失敗する。
 190 .SH 関連項目
 191 \fBmmap\fP(2), \fBsetrlimit\fP(2), \fBshmctl\fP(2), \fBsysconf\fP(3), \fBproc\fP(5),
 192 \fBcapabilities\fP(7)