OSDN Git Service

Update README
[linuxjm/LDP_man-pages.git] / release / man2 / mmap.2
1 .\" Copyright (C) 1996 Andries Brouwer <aeb@cwi.nl>
2 .\" and Copyright (C) 2006, 2007 Michael Kerrisk <mtk.manpages@gmail.com>
3 .\"
4 .\" %%%LICENSE_START(VERBATIM)
5 .\" Permission is granted to make and distribute verbatim copies of this
6 .\" manual provided the copyright notice and this permission notice are
7 .\" preserved on all copies.
8 .\"
9 .\" Permission is granted to copy and distribute modified versions of this
10 .\" manual under the conditions for verbatim copying, provided that the
11 .\" entire resulting derived work is distributed under the terms of a
12 .\" permission notice identical to this one.
13 .\"
14 .\" Since the Linux kernel and libraries are constantly changing, this
15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
16 .\" responsibility for errors or omissions, or for damages resulting from
17 .\" the use of the information contained herein.  The author(s) may not
18 .\" have taken the same level of care in the production of this manual,
19 .\" which is licensed free of charge, as they might when working
20 .\" professionally.
21 .\"
22 .\" Formatted or processed versions of this manual, if unaccompanied by
23 .\" the source, must acknowledge the copyright and authors of this work.
24 .\" %%%LICENSE_END
25 .\"
26 .\" Modified 1997-01-31 by Eric S. Raymond <esr@thyrsus.com>
27 .\" Modified 2000-03-25 by Jim Van Zandt <jrv@vanzandt.mv.com>
28 .\" Modified 2001-10-04 by John Levon <moz@compsoc.man.ac.uk>
29 .\" Modified 2003-02-02 by Andi Kleen <ak@muc.de>
30 .\" Modified 2003-05-21 by Michael Kerrisk <mtk.manpages@gmail.com>
31 .\"     MAP_LOCKED works from 2.5.37
32 .\" Modified 2004-06-17 by Michael Kerrisk <mtk.manpages@gmail.com>
33 .\" Modified 2004-09-11 by aeb
34 .\" Modified 2004-12-08, from Eric Estievenart <eric.estievenart@free.fr>
35 .\" Modified 2004-12-08, mtk, formatting tidy-ups
36 .\" Modified 2006-12-04, mtk, various parts rewritten
37 .\" 2007-07-10, mtk, Added an example program.
38 .\" 2008-11-18, mtk, document MAP_STACK
39 .\"
40 .\"*******************************************************************
41 .\"
42 .\" This file was generated with po4a. Translate the source file.
43 .\"
44 .\"*******************************************************************
45 .\"
46 .\" Japanese Version Copyright (c) 1997-2000 SUTO, Mitsuaki and NAKANO Takeo
47 .\"         all rights reserved.
48 .\" Translated 1997-06-26, SUTO, Mitsuaki <suto@av.crl.sony.co.jp>
49 .\" Updated & Modified 1999-03-01, NAKANO Takeo <nakano@apm.seikei.ac.jp>
50 .\" Updated 2000-10-12, Nakano Takeo
51 .\" Updated 2001-08-16, Nakano Takeo
52 .\" Updated 2001-11-11, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
53 .\" Updated 2002-08-13, Akihiro MOTOKI
54 .\" Updated 2003-07- 2, Akihiro MOTOKI
55 .\" Updated 2003-09-14, Akihiro MOTOKI
56 .\" Updated & Modified 2004-12-28, Yuichi SATO <ysato444@yahoo.co.jp>
57 .\" Updated 2005-09-06, Akihiro MOTOKI
58 .\" Updated 2005-10-05, Akihiro MOTOKI
59 .\" Updated 2006-07-23, Akihiro MOTOKI, LDP v2.36
60 .\" Updated 2007-01-07, Akihiro MOTOKI, LDP v2.43
61 .\" Updated 2007-05-04, Akihiro MOTOKI, LDP v2.46
62 .\" Updated 2007-09-03, Akihiro MOTOKI, LDP v2.64
63 .\" Updated 2008-08-05, Akihiro MOTOKI, LDP v3.05
64 .\" Updated 2008-09-02, Akihiro MOTOKI, LDP v3.08
65 .\" Updated 2008-12-24, Akihiro MOTOKI, LDP v3.15
66 .\" Updated 2010-04-18, Akihiro MOTOKI, LDP v3.24
67 .\" Updated 2012-05-01, Akihiro MOTOKI <amotoki@gmail.com>
68 .\" Updated 2013-05-01, Akihiro MOTOKI <amotoki@gmail.com>
69 .\" Updated 2013-05-07, Akihiro MOTOKI <amotoki@gmail.com>
70 .\"
71 .TH MMAP 2 2015\-01\-22 Linux "Linux Programmer's Manual"
72 .SH 名前
73 mmap, munmap \- ファイルやデバイスをメモリーにマップ/アンマップする
74 .SH 書式
75 .nf
76 \fB#include <sys/mman.h>\fP
77 .sp
78 \fBvoid *mmap(void *\fP\fIaddr\fP\fB, size_t \fP\fIlength\fP\fB, int \fP\fIprot\fP\fB, int \fP\fIflags\fP\fB,\fP
79 \fB           int \fP\fIfd\fP\fB, off_t \fP\fIoffset\fP\fB);\fP
80 \fBint munmap(void *\fP\fIaddr\fP\fB, size_t \fP\fIlength\fP\fB);\fP
81 .fi
82
83 機能検査マクロの要件に関する情報は「注意」の節を参照。
84 .SH 説明
85 \fBmmap\fP()  は、新しいマッピングを呼び出し元プロセスの仮想アドレス空間に作成する。 新しいマッピングの開始アドレスは \fIaddr\fP
86 で指定される。マッピングの長さは \fIlength\fP 引き数で指定される。
87
88 .\" Before Linux 2.6.24, the address was rounded up to the next page
89 .\" boundary; since 2.6.24, it is rounded down!
90 \fIaddr\fP が NULL の場合、カーネルがマッピングを作成するアドレスを選択する。 この方法は最も移植性のある新しいマッピングの作成方法である。
91 \fIaddr\fP が NULL でない場合、カーネルはマッピングをどこに配置するかのヒントとして \fIaddr\fP を使用する。Linux
92 では、マッピングはすぐ近くのページ境界に作成される。 新しいマッピングのアドレスは、呼び出しの返り値として返される。
93
94 ファイルマッピングの内容は、 ファイルディスクリプター \fIfd\fP で参照されるファイル (もしくは他のオブジェクト) のオフセット \fIoffset\fP
95 から開始される \fIlength\fP バイトのデータで初期化される (ファイルマッピングは無名マッピングの反対語である。 \fBMAP_ANONYMOUS\fP
96 を参照)。 \fIoffset\fP は \fIsysconf(_SC_PAGE_SIZE)\fP が返すページサイズの倍数でなければならない。
97 .LP
98 引き数 \fIprot\fP には、マッピングのメモリー保護をどのように行なうかを指定する (ファイルのオープンモードと矛盾してはいけない)。 \fIprot\fP
99 には、 \fBPROT_NONE\fP か、以下のフラグをひとつ以上ビット毎の論理和 (OR) をとったものを 指定できる。
100 .TP  1.1i
101 \fBPROT_EXEC\fP
102 ページは実行可能である。
103 .TP 
104 \fBPROT_READ\fP
105 ページは読み込み可能である。
106 .TP 
107 \fBPROT_WRITE\fP
108 ページに書き込み可能である。
109 .TP 
110 \fBPROT_NONE\fP
111 ページにはアクセスできない。
112 .LP
113 \fIflags\fP 引き数により、マッピングに対する更新が同じ領域をマッピングしている 他のプロセスに見えるか、更新がマッピング元のファイルを通じて
114 伝えられるか、が決定される。この動作は、以下の値のいずれか一つだけ (複数は指定できない) を \fIflags\fP に含めることで指定する。
115 .TP  1.1i
116 \fBMAP_SHARED\fP
117 このマッピングを共有する。 マッピングに対する更新はこのファイルをマッピングしている他のプロセス
118 から見える。更新はマッピング元のファイルを通じて伝えられる。 ただし、ファイルの実際の更新は \fBmsync\fP(2)  または \fBmunmap\fP()
119 が呼ばれるまで行われないこともある。
120 .TP 
121 \fBMAP_PRIVATE\fP
122 プライベートな copy\-on\-write (書き込み時コピー) マップを生成する。
123 マッピングに対する更新は同じファイルをマッピングしている他のプロセス には見えず、更新がマッピング元のファイルを通じて伝えられることもない。
124 \fBmmap\fP()  の呼び出し後にマッピング元のファイルに対して行われた変更が、 マップ領域に反映されるかどうかは規定されていない。
125 .LP
126 上記の二つのフラグは POSIX.1\-2001 で規定されている。
127
128 さらに、以下の値のうち 0 個以上をビット毎の論理和 (OR) で \fIflags\fP に指定することができる。
129 .TP 
130 \fBMAP_32BIT\fP (Linux 2.4.20, 2.6 以降)
131 .\" See http://lwn.net/Articles/294642 "Tangled up in threads", 19 Aug 08
132 マッピングをプロセスのアドレス空間の先頭 2 ギガバイト以内に配置する。 このフラグがサポートされているのは x86\-64 アーキテクチャー上の 64
133 ビットプログラムのみである。 このフラグが追加されたのは、スレッドのスタックをメモリーの先頭 2GB 以内の どこかに割り当てることで、初期のいくつかの
134 64 ビットプロセッサにおける コンテキストスイッチの性能問題を改善するためである。 最近の x86\-64 プロセッサではこの性能問題はもはや存在せず、
135 そのようなシステムではこのフラグを使用する必要はない。 \fBMAP_FIXED\fP がセットされている場合は、 \fBMAP_32BIT\fP
136 フラグは無視される。
137 .TP 
138 \fBMAP_ANON\fP
139 \fBMAP_ANONYMOUS\fP の同義語。非推奨。
140 .TP 
141 \fBMAP_ANONYMOUS\fP
142 マッピングはどのファイルとも関連付けされない。 マッピングの内容は 0 で初期化される。 引き数 \fIfd\fP と \fIoffset\fP は無視される。
143 ただし、実装によっては \fBMAP_ANONYMOUS\fP (もしくは \fBMAP_ANON\fP)  が指定された場合、 \fIfd\fP を \-1
144 にする必要があり、 移植性が必要なアプリケーションでは必ず \fIfd\fP を \-1 にすべきである。 \fBMAP_ANONYMOUS\fP と
145 \fBMAP_SHARED\fP を組み合わせての利用は カーネル 2.4 以降の Linux でのみサポートされている。
146 .TP 
147 \fBMAP_DENYWRITE\fP
148 .\" Introduced in 1.1.36, removed in 1.3.24.
149 このフラグは無視される (ずっと前は、マップ元のファイルへの書き込みを行おうとすると、エラー \fBETXTBUSY\fP
150 で失敗するようにシグナルが設定されていたが、これは denial\-of\-service (サービス拒否) 攻撃の原因となった)。
151 .TP 
152 \fBMAP_EXECUTABLE\fP
153 .\" Introduced in 1.1.38, removed in 1.3.24. Flag tested in proc_follow_link.
154 .\" (Long ago, it signaled that the underlying file is an executable.
155 .\" However, that information was not really used anywhere.)
156 .\" Linus talked about DOS related to MAP_EXECUTABLE, but he was thinking of
157 .\" MAP_DENYWRITE?
158 このフラグは無視される。
159 .TP 
160 \fBMAP_FILE\fP
161 .\" On some systems, this was required as the opposite of
162 .\" MAP_ANONYMOUS -- mtk, 1 May 2007
163 互換性のためのフラグ。無視される。
164 .TP 
165 \fBMAP_FIXED\fP
166 \fIaddr\fP をアドレスのヒントとして使用するのではなく、 \fIaddr\fP で指定されたアドレスをそのまま使用してマッピングを配置する。
167 \fIaddr\fP はページサイズの倍数でなければならない。 \fIaddr\fP と \fIlen\fP
168 で指定されたメモリー領域が既存のマッピングのページと重なる場合、 既存のマッピングの重なった部分は捨てられる。
169 もし指定されたアドレスが使用できない場合、 \fBmmap\fP()  は失敗する。 マッピングに対して固定アドレスを要求するのは移植性の面で劣るので、
170 このオプションは使用しないことを推奨する。
171 .TP 
172 \fBMAP_GROWSDOWN\fP
173 スタック用に使用される。マッピングをメモリー内で逆向きに行うことを カーネル仮想メモリーシステムに指示する。
174 (訳注:マッピングは通常はメモリーアドレスが増加する向きに行うが、 このオプションを指定すると逆向きにマッピングを行う)
175 .TP 
176 \fBMAP_HUGETLB\fP (Linux 2.6.32 以降)
177 "huge page" を使ってマッピングを割り当てる。詳しい情報は、Linux カーネルソースの
178 \fIDocumentation/vm/hugetlbpage.txt\fP を参照。
179 .TP 
180 \fBMAP_LOCKED\fP (Linux 2.5.37 以降)
181 .\" If set, the mapped pages will not be swapped out.
182 マップされた領域のページを \fBmlock\fP(2)  の方法でメモリー内にロックする。 それ以前のカーネルでは、このフラグは無視される。
183 .TP 
184 \fBMAP_NONBLOCK\fP (Linux 2.5.46 以降)
185 \fBMAP_POPULATE\fP と組み合わせた場合のみ意味を持つ。 read\-ahead (前もって読み込むこと) を実行しない。 単に、すでに RAM
186 上に存在するページに対してのみページテーブルエントリーを作成する。 Linux 2.6.23 以降では、このフラグは \fBMAP_POPULATE\fP
187 に何の影響も与えない。 いつか \fBMAP_POPULATE\fP と \fBMAP_NONBLOCK\fP
188 を組み合わせた場合の動作は実装し直されるかもしれない。
189 .TP 
190 \fBMAP_NORESERVE\fP
191 このマッピングに対するスワップ空間の予約を行わない。 スワップ空間を予約した場合は、このマッピングの変更が必ず可能なことが
192 保証される。予約を行わなかった場合、物理メモリーに空きがないと 書き込み時に \fBSIGSEGV\fP エラーを受け取ることがある。 \fBproc\fP(5)
193 の \fI/proc/sys/vm/overcommit_memory\fP ファイルについての議論も参照。 バージョン 2.6
194 より前のカーネルでは、このフラグは書き込み可能な プライベートマッピングについてのみ効果があった。
195 .TP 
196 \fBMAP_POPULATE\fP (Linux 2.5.46 以降)
197 マッピング用のページテーブルを配置 (populate) する ファイルマッピングの場合には、これによりファイルが先読み (read\-ahead)
198 が行われる。この以後は、マッピングに対するアクセスがページフォールトで ブロックされることがなくなる。 Linux 2.6.23
199 以降でのみプライベートマッピングについて \fBMAP_POPULATE\fP がサポートされている。
200 .TP 
201 \fBMAP_STACK\fP (Linux 2.6.27 以降)
202 .\" See http://lwn.net/Articles/294642 "Tangled up in threads", 19 Aug 08
203 .\" commit cd98a04a59e2f94fa64d5bf1e26498d27427d5e7
204 .\" http://thread.gmane.org/gmane.linux.kernel/720412
205 .\" "pthread_create() slow for many threads; also time to revisit 64b
206 .\"  context switch optimization?"
207 プロセスやスレッドのスタックに適したアドレスにマッピングを割り当てる。 現在のところ、このフラグは何もしないが、 glibc
208 のスレッド実装では使用されている。 これは、いくつかのアーキテクチャーではスタックの割り当てに関して特別な扱い が必要な場合に、glibc
209 にそのサポートを後で透過的に実装できるようにする ためである。
210 .TP 
211 \fBMAP_UNINITIALIZED\fP (Linux 2.6.33 以降)
212 無名ページ (anonymous page) のクリアを行わない。このフラグは組み込みデバイス
213 での性能向上を目的に作られてものである。カーネルの設定で
214 \fBCONFIG_MMAP_ALLOW_UNINITIALIZED\fP オプションが有効になっている場合のみ、
215 このフラグは効果を持つ。
216 セキュリティ面の考慮から、このオプションは通常組み込みデバイス (すなわち、
217 ユーザーメモリーの内容を完全に制御化におけるデバイス) においてのみ有効にされる。
218 .LP
219 上記のフラグの中では、 \fBMAP_FIXED\fP だけが POSIX.1\-2001 で規定されている。 しかしながら、ほとんどのシステムで
220 \fBMAP_ANONYMOUS\fP (またはその同義語である \fBMAP_ANON\fP)  もサポートされている。
221 .LP
222 いくつかのシステムでは、上記以外にフラグとして \fBMAP_AUTOGROW\fP, \fBMAP_AUTORESRV\fP, \fBMAP_COPY\fP,
223 \fBMAP_LOCAL\fP が規定されている。
224 .LP
225 \fBmmap\fP()  によってマップされたメモリーの属性は \fBfork\fP(2)  の際に継承される。
226 .LP
227 ファイルはページサイズの整数倍の領域にマップされる。サイズがページサイズの 整数倍でないファイルの場合、マップ時に残りの領域は 0
228 で埋められ、この領域へ 書きこみを行ってもファイルに書き出されることはない。マッピングを行った元
229 ファイルのサイズを変更した場合、元ファイルの追加されたり削除された領域に対応 するマップされたページに対してどのような影響があるかは規定されていない。
230 .SS munmap()
231 システムコール \fBmunmap\fP()  は指定されたアドレス範囲のマップを消去し、 これ以降のその範囲内へのメモリー参照は不正となる。
232 この領域は、プロセスが終了したときにも自動的にアンマップされる。 一方、ファイルディスクリプターをクローズしても、この領域はアンマップされない。
233 .LP
234 \fIaddr\fP アドレスはページサイズの整数倍でなければならない。指定された範囲の一部分を
235 含む全てのページはアンマップされ、これ以降にこれらのページへの参照があると \fBSIGSEGV\fP が発生する。
236 指定した範囲内にマップされたページが一つも含まれていない場合でも エラーにならない。
237 .SS ファイルと関連付けられたマッピングに対するタイムスタンプの更新
238 ファイルと関連付けられたマッピングの場合、マッピングされたファイルの \fIst_atime\fP フィールドは、 \fBmmap\fP()  されてからアンマップ
239 (unmap) されるまでの間に更新されることがある。 それまでに更新が行われていなければ、マップされたページへの最初の参照があった 際に更新される。
240 .LP
241 \fBPROT_WRITE\fP と \fBMAP_SHARED\fP の両方を指定してマップされたファイルの場合、書き込みがあると、 \fIst_ctime\fP と
242 \fIst_mtime\fP の両フィールドは、マップされた領域への書き込みより後で、 \fBMS_SYNC\fP または \fBMS_ASYNC\fP フラグを指定して
243 \fBmsync\fP(2)  が呼ばれる前までに更新される。
244 .SH 返り値
245 \fBmmap\fP()  は成功するとマップされた領域へのポインターを返す。 失敗すると値 \fBMAP_FAILED\fP (つまり \fI(void\ *)\ \-1\fP)  を返し、 \fIerrno\fP がエラーの内容にしたがってセットされる。 \fBmunmap\fP()  は成功すると 0 を返す。失敗すると \-1
246 を返し、 \fIerrno\fP がセットされる (多くの場合 \fBEINVAL\fP になるだろう)。
247 .SH エラー
248 .TP 
249 \fBEACCES\fP
250 以下のいずれかの場合。 ファイルディスクリプターの参照先が通常のファイルではない (non\-regular file) 。
251 ファイルマッピングを要求したが \fIfd\fP は読み込み用にオープンされていない。 \fBMAP_SHARED\fP を要求して \fBPROT_WRITE\fP
252 をセットしたが \fIfd\fP は読み書きモード (\fBO_RDWR\fP)  でオープンされていない、 \fBPROT_WRITE\fP
253 をセットしたが、ファイルは追加 (append) 専用である。
254 .TP 
255 \fBEAGAIN\fP
256 ファイルがロックされている。またはロックされているメモリーが多すぎる (\fBsetrlimit\fP(2)  を参照)。
257 .TP 
258 \fBEBADF\fP
259 \fIfd\fP が有効なファイルディスクリプター (file descriptor) ではない (かつ \fBMAP_ANONYMOUS\fP
260 がセットされていない)。
261 .TP 
262 \fBEINVAL\fP
263 \fIaddr\fP か \fIlength\fP か \fIoffset\fP が適切でない (例えば、大きすぎるとか、ページ境界にアラインメントされていない)。
264 .TP 
265 \fBEINVAL\fP
266 (Linux 2.6.12 以降)  \fIlength\fP が 0 であった。
267 .TP 
268 \fBEINVAL\fP
269 \fIflags\fP に \fBMAP_PRIVATE\fP と \fBMAP_SHARED\fP のどちらも含まれていなかった、もしくは その両方が含まれていた。
270 .TP 
271 \fBENFILE\fP
272 .\" This is for shared anonymous segments
273 .\" [2.6.7] shmem_zero_setup()-->shmem_file_setup()-->get_empty_filp()
274 .\" .TP
275 .\" .B ENOEXEC
276 .\" A file could not be mapped for reading.
277 システム全体でオープンされているファイルの総数が上限に達した。
278 .TP 
279 \fBENODEV\fP
280 指定されたファイルが置かれているファイルシステムがメモリーマッピングをサポート していない。
281 .TP 
282 \fBENOMEM\fP
283 メモリーに空きがない、または処理中のプロセスのマッピング数が最大数を超過した。
284 .TP 
285 \fBEPERM\fP
286 .\" (Since 2.4.25 / 2.6.0.)
287 \fIprot\fP 引き数は \fBPROT_EXEC\fP を行うように指定されているが、 no\-exec でマウントされたファイルシステム上のファイルに
288 マップ領域が対応している。
289 .TP 
290 \fBEPERM\fP
291 操作が file seal により禁止されている。 \fBfcntl\fP(2) 参照。
292 .TP 
293 \fBETXTBSY\fP
294 \fBMAP_DENYWRITE\fP がセットされているが \fIfd\fP で指定されているオブジェクトは書き込み用に開かれている。
295 .TP 
296 \fBEOVERFLOW\fP
297 32 ビットアーキテクチャーで large file 拡張を使っている場合 (つまり 64 ビットの \fIoff_t\fP を使う場合)、
298 \fIlength\fP で使うページ数と \fIoffset\fP で使うページ数を足した値は \fIunsigned long\fP (32 ビット) を超えてしまう
299 (オーバーフローしてしまう) 場合がある。
300 .LP
301 マップ領域を利用する際に、以下のシグナルが発生することがある:
302 .TP 
303 \fBSIGSEGV\fP
304 読み込み専用で mmap された領域へ書き込みを行おうとした。
305 .TP 
306 \fBSIGBUS\fP
307 バッファーのうち、ファイルに関連づけられていない部分 (例えばファイル末尾を越えた部分など。これには
308 他のプロセスがファイルを切り詰めた場合なども含まれる)  にアクセスしようとした。
309 .SH 準拠
310 .\" SVr4 documents additional error codes ENXIO and ENODEV.
311 .\" SUSv2 documents additional error codes EMFILE and EOVERFLOW.
312 SVr4, 4.4BSD, POSIX.1\-2001.
313 .SH 可用性
314 .\" POSIX.1-2001: It shall be defined to -1 or 0 or 200112L.
315 .\" -1: unavailable, 0: ask using sysconf().
316 .\" glibc defines it to 1.
317 \fBmmap\fP(), \fBmsync\fP(2)  \fBmunmap\fP()  が利用可能な POSIX システムでは、
318 \fB_POSIX_MAPPED_FILES\fP は <unistd.h> で 0 より大きな値に定義される (\fBsysconf\fP(3)
319 も参照のこと)。
320 .SH 注意
321 (i386 などの) いくつかのアーキテクチャーでは、 \fBPROT_WRITE\fP をセットすると、暗黙のうちに \fBPROT_READ\fP
322 がセットされる。 \fBPROT_READ\fP をセットした際に暗黙のうちに \fBPROT_EXEC\fP
323 がセットされるかどうかは、アーキテクチャー依存である。 移植性を考慮したプログラムでは、 新規にマップした領域でコードを実行したい場合は、常に
324 \fBPROT_EXEC\fP をセットすべきである。
325
326 マッピングを作成する移植性のある方法は、 \fIaddr\fP に 0 (NULL) を指定し、 \fIflags\fP から \fBMAP_FIXED\fP
327 を外すことである。 この場合、システムがマッピング用のアドレスの選択を行う。 アドレスは既存のマッピングと衝突しないように、 かつ 0
328 にならないように選択される。 \fBMAP_FIXED\fP フラグが指定され、かつ \fIaddr\fP が 0 (NULL)
329 の場合には、マップされるアドレスが 0 (NULL) になる。
330
331 .\"
332 特定の \fIflags\fP 定数は \fB_BSD_SOURCE\fP か \fB_SVID_SOURCE\fP のいずれかが定義された場合にのみ定義される。
333 (\fB_GNU_SOURCE\fP も定義されている必要がある。これらのフラグはすべて Linux 固有のものなので、 特に \fB_GNU_SOURCE\fP
334 を必要とする点はもっと論理的に決められるべきであった。) 関係するフラグは \fBMAP_32BIT\fP, \fBMAP_ANONYMOUS\fP
335 (とその同義語の \fBMAP_ANON\fP), \fBMAP_DENYWRITE\fP, \fBMAP_EXECUTABLE\fP, \fBMAP_FILE\fP,
336 \fBMAP_GROWSDOWN\fP, \fBMAP_HUGETLB\fP, \fBMAP_LOCKED\fP, \fBMAP_NONBLOCK\fP,
337 \fBMAP_NORESERVE\fP, \fBMAP_POPULATE\fP, \fBMAP_STACK\fP である。
338 .SS "C ライブラリとカーネル ABI の違い"
339 .\" Since around glibc 2.1/2.2, depending on the platform.
340 このページでは glibc の \fBmmap\fP() のラッパー関数が提供するインターフェースに
341 ついて説明している。元々は、この関数は同じ名前のシステムコールを起動していた。
342 カーネル 2.4 以降、このシステムコールは \fBmmap2\fP(2) に取って代わられ、現在
343 では、 glibc の \fBmmap\fP() のラッパー関数は \fIoffset\fP を適切に調整してから
344 \fBmmap2\fP(2) を起動する。
345 .SH バグ
346 Linux においては、上記の \fBMAP_NORESERVE\fP で述べられているような保証はない。
347 デフォルトでは、システムがメモリーを使い切った場合には、 どのプロセスがいつ強制終了されるか分からないからである。
348
349 2.6.7 より前のカーネルでは、 \fIprot\fP に \fBPROT_NONE\fP が指定された場合にのみ、 \fBMAP_POPULATE\fP
350 フラグが効力を持つ。
351
352 SUSv3 では、 \fIlength\fP が 0 の場合、 \fBmmap\fP()  は失敗すると規定されている。しかしながら、2.6.12
353 より前のカーネルでは、 この場合に \fBmmap\fP()  は成功していた (マッピングは作成されず、 \fIaddr\fP が返されていた)。 カーネル
354 2.6.12 以降では、 \fBmmap\fP()  はエラー \fBEINVAL\fP で失敗する。
355
356 POSIX では、 システムはオブジェクト末尾の部分ページを常に 0 で埋め、 末尾より後ろのオブジェクトを決して変更してはならない、と規定している。
357 Linux では、 オブジェクト末尾より後ろの部分ページにデータを書き込んだ場合、
358 そのファイルをクローズしてアンマップした後であってもページキャッシュにデータが残り続け、 データがファイル自体に書き込まれていなくても、
359 それ以降のマッピングで変更された内容が見える可能性がある。 いくつかの場合では、 アンマップを行う前に \fBmsync\fP(2) を呼び出すことで、
360 この状況を修正することができる。 しかし、 これは tmpfs では機能しない (例えば、 \fBshm_overview\fP(7) で説明されている
361 POSIX 共有メモリーインターフェースを使った場合)。
362 .SH 例
363 .\" FIXME . Add an example here that uses an anonymous shared region for
364 .\" IPC between parent and child.
365 .PP
366 以下のプログラムは、一番目のコマンドライン引き数で指定された ファイルの一部を標準出力に表示する。
367 表示する範囲は、二番目、三番目のコマンドライン引き数で渡される オフセットと長さで指定される。
368 このプログラムは、指定されたファイルの必要なページのメモリー マッピングを作成し、 \fBwrite\fP(2)  を使って所望のバイトを出力する。
369 .SS プログラムのソース
370 .nf
371 #include <sys/mman.h>
372 #include <sys/stat.h>
373 #include <fcntl.h>
374 #include <stdio.h>
375 #include <stdlib.h>
376 #include <unistd.h>
377
378 #define handle_error(msg) \e
379     do { perror(msg); exit(EXIT_FAILURE); } while (0)
380
381 int
382 main(int argc, char *argv[])
383 {
384     char *addr;
385     int fd;
386     struct stat sb;
387     off_t offset, pa_offset;
388     size_t length;
389     ssize_t s;
390
391     if (argc < 3 || argc > 4) {
392         fprintf(stderr, "%s file offset [length]\en", argv[0]);
393         exit(EXIT_FAILURE);
394     }
395
396     fd = open(argv[1], O_RDONLY);
397     if (fd == \-1)
398         handle_error("open");
399
400     if (fstat(fd, &sb) == \-1)           /* To obtain file size */
401         handle_error("fstat");
402
403     offset = atoi(argv[2]);
404     pa_offset = offset & ~(sysconf(_SC_PAGE_SIZE) \- 1);
405         /* offset for mmap() must be page aligned */
406
407     if (offset >= sb.st_size) {
408         fprintf(stderr, "offset is past end of file\en");
409         exit(EXIT_FAILURE);
410     }
411
412     if (argc == 4) {
413         length = atoi(argv[3]);
414         if (offset + length > sb.st_size)
415             length = sb.st_size \- offset;
416                 /* Can\(aqt display bytes past end of file */
417
418     } else {    /* No length arg ==> display to end of file */
419         length = sb.st_size \- offset;
420     }
421
422     addr = mmap(NULL, length + offset \- pa_offset, PROT_READ,
423                 MAP_PRIVATE, fd, pa_offset);
424     if (addr == MAP_FAILED)
425         handle_error("mmap");
426
427     s = write(STDOUT_FILENO, addr + offset \- pa_offset, length);
428     if (s != length) {
429         if (s == \-1)
430             handle_error("write");
431
432         fprintf(stderr, "partial write");
433         exit(EXIT_FAILURE);
434     }
435
436     exit(EXIT_SUCCESS);
437 }
438 .fi
439 .SH 関連項目
440 \fBgetpagesize\fP(2), \fBmemfd_create\fP(2), \fBmincore\fP(2), \fBmlock\fP(2),
441 \fBmmap2\fP(2), \fBmprotect\fP(2), \fBmremap\fP(2), \fBmsync\fP(2),
442 \fBremap_file_pages\fP(2), \fBsetrlimit\fP(2), \fBshmat\fP(2), \fBshm_open\fP(3),
443 \fBshm_overview\fP(7)
444
445 \fBproc\fP(5) の \fI/proc/[pid]/maps\fP, \fI/proc/[pid]/map_files\fP,
446 \fI/proc/[pid]/smaps\fP の説明。
447
448 .\"
449 .\" Repeat after me: private read-only mappings are 100% equivalent to
450 .\" shared read-only mappings. No ifs, buts, or maybes. -- Linus
451 B.O. Gallmeister, POSIX.4, O'Reilly, pp. 128\-129 and 389\-391.
452 .SH この文書について
453 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.79 の一部
454 である。プロジェクトの説明とバグ報告に関する情報は
455 http://www.kernel.org/doc/man\-pages/ に書かれている。