OSDN Git Service

352f9dd46e910dd3687181a7b57bae08664ddf21
[linuxjm/LDP_man-pages.git] / draft / man2 / open.2
1 .\" This manpage is Copyright (C) 1992 Drew Eckhardt;
2 .\" and Copyright (C) 1993 Michael Haardt, Ian Jackson.
3 .\" and Copyright (C) 2008 Greg Banks
4 .\" and Copyright (C) 2006, 2008, 2013, 2014 Michael Kerrisk <mtk.manpages@gmail.com>
5 .\"
6 .\" %%%LICENSE_START(VERBATIM)
7 .\" Permission is granted to make and distribute verbatim copies of this
8 .\" manual provided the copyright notice and this permission notice are
9 .\" preserved on all copies.
10 .\"
11 .\" Permission is granted to copy and distribute modified versions of this
12 .\" manual under the conditions for verbatim copying, provided that the
13 .\" entire resulting derived work is distributed under the terms of a
14 .\" permission notice identical to this one.
15 .\"
16 .\" Since the Linux kernel and libraries are constantly changing, this
17 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
18 .\" responsibility for errors or omissions, or for damages resulting from
19 .\" the use of the information contained herein.  The author(s) may not
20 .\" have taken the same level of care in the production of this manual,
21 .\" which is licensed free of charge, as they might when working
22 .\" professionally.
23 .\"
24 .\" Formatted or processed versions of this manual, if unaccompanied by
25 .\" the source, must acknowledge the copyright and authors of this work.
26 .\" %%%LICENSE_END
27 .\"
28 .\" Modified 1993-07-21 by Rik Faith <faith@cs.unc.edu>
29 .\" Modified 1994-08-21 by Michael Haardt
30 .\" Modified 1996-04-13 by Andries Brouwer <aeb@cwi.nl>
31 .\" Modified 1996-05-13 by Thomas Koenig
32 .\" Modified 1996-12-20 by Michael Haardt
33 .\" Modified 1999-02-19 by Andries Brouwer <aeb@cwi.nl>
34 .\" Modified 1998-11-28 by Joseph S. Myers <jsm28@hermes.cam.ac.uk>
35 .\" Modified 1999-06-03 by Michael Haardt
36 .\" Modified 2002-05-07 by Michael Kerrisk <mtk.manpages@gmail.com>
37 .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
38 .\" 2004-12-08, mtk, reordered flags list alphabetically
39 .\" 2004-12-08, Martin Pool <mbp@sourcefrog.net> (& mtk), added O_NOATIME
40 .\" 2007-09-18, mtk, Added description of O_CLOEXEC + other minor edits
41 .\" 2008-01-03, mtk, with input from Trond Myklebust
42 .\"     <trond.myklebust@fys.uio.no> and Timo Sirainen <tss@iki.fi>
43 .\"     Rewrite description of O_EXCL.
44 .\" 2008-01-11, Greg Banks <gnb@melbourne.sgi.com>: add more detail
45 .\"     on O_DIRECT.
46 .\" 2008-02-26, Michael Haardt: Reorganized text for O_CREAT and mode
47 .\"
48 .\" FIXME . Apr 08: The next POSIX revision has O_EXEC, O_SEARCH, and
49 .\" O_TTYINIT.  Eventually these may need to be documented.  --mtk
50 .\"
51 .\"*******************************************************************
52 .\"
53 .\" This file was generated with po4a. Translate the source file.
54 .\"
55 .\"*******************************************************************
56 .\"
57 .\" Japanese Version Copyright (c) 1997-1999 HANATAKA Shinya
58 .\"         all rights reserved.
59 .\" Translated 1999-08-14, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
60 .\" Updated 2001-05-25, Yuichi SATO <ysato444@yahoo.co.jp>
61 .\" Updated & Modified 2002-01-02, Yuichi SATO
62 .\" Updated & Modified 2002-07-07, Yuichi SATO
63 .\" Updated & Modified 2002-09-19, Yuichi SATO
64 .\" Updated & Modified 2003-07-30, Yuichi SATO
65 .\" Updated & Modified 2003-11-27, Yuichi SATO
66 .\" Updated & Modified 2005-01-01, Yuichi SATO
67 .\" Updated & Modified 2005-09-14, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
68 .\" Updated & Modified 2005-10-14, Akihiro MOTOKI
69 .\" Updated & Modified 2006-01-18, Akihiro MOTOKI
70 .\" Updated & Modified 2006-04-15, Akihiro MOTOKI, LDP v2.29
71 .\" Updated 2007-01-07, Akihiro MOTOKI, LDP v2.43
72 .\" Updated 2007-05-01, Akihiro MOTOKI, LDP v2.46
73 .\" Updated 2007-10-12, Akihiro MOTOKI, LDP v2.66
74 .\" Updated 2008-02-12, Akihiro MOTOKI, LDP v2.77
75 .\" Updated 2008-04-04, Akihiro MOTOKI, LDP v2.79
76 .\" Updated 2008-08-08, Akihiro MOTOKI, LDP v3.05
77 .\" Updated 2010-04-23, Akihiro MOTOKI, LDP v3.24
78 .\" Updated 2012-05-08, Akihiro MOTOKI <amotoki@gmail.com>
79 .\" Updated 2012-05-30, Akihiro MOTOKI <amotoki@gmail.com>
80 .\" Updated 2013-05-06, Akihiro MOTOKI <amotoki@gmail.com>
81 .\" Updated 2013-08-16, Akihiro MOTOKI <amotoki@gmail.com>
82 .\"
83 .TH OPEN 2 2014\-12\-31 Linux "Linux Programmer's Manual"
84 .SH 名前
85 open, openat, creat \- ファイルのオープン、作成を行う
86 .SH 書式
87 .nf
88 \fB#include <sys/types.h>\fP
89 \fB#include <sys/stat.h>\fP
90 \fB#include <fcntl.h>\fP
91 .sp
92 \fBint open(const char *\fP\fIpathname\fP\fB, int \fP\fIflags\fP\fB);\fP
93 \fBint open(const char *\fP\fIpathname\fP\fB, int \fP\fIflags\fP\fB, mode_t \fP\fImode\fP\fB);\fP
94
95 \fBint creat(const char *\fP\fIpathname\fP\fB, mode_t \fP\fImode\fP\fB);\fP
96 .sp
97 \fBint openat(int \fP\fIdirfd\fP\fB, const char *\fP\fIpathname\fP\fB, int \fP\fIflags\fP\fB);\fP
98 \fBint openat(int \fP\fIdirfd\fP\fB, const char *\fP\fIpathname\fP\fB, int \fP\fIflags\fP\fB, mode_t \fP\fImode\fP\fB);\fP
99 .fi
100 .sp
101 .in -4n
102 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
103 .in
104 .sp
105 \fBopenat\fP():
106 .PD 0
107 .ad l
108 .RS 4
109 .TP  4
110 glibc 2.10 以降:
111 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
112 .TP 
113 glibc 2.10 より前:
114 _ATFILE_SOURCE
115 .RE
116 .ad
117 .PD
118 .SH 説明
119 ファイルの \fIpathname\fP を与えると、 \fBopen\fP()  はファイルディスクリプタを返す。
120 ファイルディスクリプタは、この後に続くシステムコール (\fBread\fP(2), \fBwrite\fP(2), \fBlseek\fP(2),
121 \fBfcntl\fP(2) など)  で使用される小さな非負の整数である。 このシステムコールが成功した場合に返されるファイルディスクリプタは
122 そのプロセスがその時点でオープンしていないファイルディスクリプタの うち最小の数字のものとなる。
123 .PP
124 デフォルトでは、新しいファイルディスクリプタは \fBexecve\fP(2) を実行した後も
125 オープンされたままとなる (つまり、 \fBfcntl\fP(2) に説明がある \fBFD_CLOEXEC\fP
126 ファイルディスクリプタフラグは最初は無効である); 後述の \fBO_CLOEXEC\fP フラグ
127 を使うとこのデフォルトを変更することができる。 ファイルオフセット
128 (file offset) はファイルの先頭に設定される (\fBlseek\fP(2) 参照)。
129 .PP
130 A call to \fBopen\fP()  creates a new \fIopen file description\fP, an entry in the
131 system\-wide table of open files.  The open file description records the file
132 offset and the file status flags (see below).  A file descriptor is a
133 reference to an open file description; this reference is unaffected if
134 \fIpathname\fP is subsequently removed or modified to refer to a different
135 file.  For further details on open file descriptions, see NOTES.
136 .PP
137 引き数 \fIflags\fP には、アクセスモード \fBO_RDONLY\fP, \fBO_WRONLY\fP, \fBO_RDWR\fP
138 のどれかひとつが入っていなければならない。 これらはそれぞれ読み込み専用、書き込み専用、読み書き用に ファイルをオープンすることを要求するものである。
139
140 .\" SUSv4 divides the flags into:
141 .\" * Access mode
142 .\" * File creation
143 .\" * File status
144 .\" * Other (O_CLOEXEC, O_DIRECTORY, O_NOFOLLOW)
145 .\" though it's not clear what the difference between "other" and
146 .\" "File creation" flags is.  I raised an Aardvark to see if this
147 .\" can be clarified in SUSv4; 10 Oct 2008.
148 .\" http://thread.gmane.org/gmane.comp.standards.posix.austin.general/64/focus=67
149 .\" TC1 (balloted in 2013), resolved this, so that those three constants
150 .\" are also categorized" as file status flags.
151 .\"
152 さらに、 \fIflags\fP には、ファイル作成フラグ (file creation flag) とファイル状態フラグ (file status
153 flag) を 0 個以上「ビット単位の OR (bitwise\-or)」で 指定することができる。 \fIファイル作成フラグ\fP は
154 \fBO_CLOEXEC\fP, \fBO_CREAT\fP, \fBO_DIRECTORY\fP, \fBO_EXCL\fP, \fBO_NOCTTY\fP,
155 \fBO_NOFOLLOW\fP, \fBO_TMPFILE\fP, \fBO_TRUNC\fP, \fBO_TTY_INIT\fP である。 \fIファイル状態フラグ\fP
156 は以下のリストのうち上記以外の残りのものである。 二種類のフラグの違いは、ファイル状態フラグの方はその内容を取得したり (場合によっては)
157 変更したりできる点にある。詳細は \fBfcntl\fP(2) を参照。
158
159 すべてのファイル作成フラグとファイル状態フラグを以下のリストに示す。
160 .TP 
161 \fBO_APPEND\fP
162 .\" For more background, see
163 .\" http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=453946
164 .\" http://nfs.sourceforge.net/
165 ファイルを追加 (append) モードでオープンする。 毎回の \fBwrite\fP(2)  の前に \fBlseek\fP(2)
166 を行ったかのように、ファイルポインタをファイルの最後に移動する。 NFS ファイルシステムで、 \fBO_APPEND\fP
167 を使用すると、複数のプロセスがひとつのファイルに同時にデータを追加した場合、 ファイルが壊れてしまうことがある。 これは NFS
168 が追加モードをサポートしていないため、 クライアントのカーネル (kernel) がそれをシミュレートしなければならないのだが、
169 競合状態を避けることはできないからである。
170 .TP 
171 \fBO_ASYNC\fP
172 シグナル駆動 I/O (signal\-driven I/O) を有効にする: このファイルディスクリプタへの
173 入力または出力が可能になった場合に、シグナルを生成する (デフォルトは \fBSIGIO\fP であるが、 \fBfcntl\fP(2)
174 によって変更可能である)。 この機能が使用可能なのは端末、疑似端末、ソケットのみであり、 (Linux 2.6 以降では) パイプと FIFO
175 に対しても使用できる。 さらに詳しい説明は \fBfcntl\fP(2)  を参照すること。 下記の「バグ」も参照。
176 .TP 
177 \fBO_CLOEXEC\fP (Linux 2.6.23 以降)
178 .\" NOTE! several other man pages refer to this text
179 新しいファイルディスクリプタに対して close\-on\-exec フラグを有効にする。 このフラグを指定することで、 プログラムは
180 \fBFD_CLOEXEC\fP フラグをセットするために \fBfcntl\fP(2) \fBF_SETFD\fP 操作を別途呼び出す必要がなくなる。
181
182 .\" This flag fixes only one form of the race condition;
183 .\" The race can also occur with, for example, descriptors
184 .\" returned by accept(), pipe(), etc.
185 ある種のマルチスレッドのプログラムはこのフラグの使用は不可欠である点に注意すること。 なぜなら、個別に \fBFD_CLOEXEC\fP フラグを設定する
186 \fBfcntl\fP(2) \fBF_SETFD\fP 操作を呼び出したとしても、あるスレッドがファイルディスクリプタを オープンするのと同時に別のスレッドが
187 \fBfork\fP(2) と \fBexecve\fP(2) を実行するという競合条件を避けるのには十分ではないからである。
188 実行の順序に依存して、この競合条件の結果、 \fBopen\fP() が返したファイルディスクリプタが \fBfork\fP(2)
189 で作成された子プロセスにより実行されるプログラムに意図せず見えてしまう可能性がある。 (この種の競合は、 本質的に、 close\-on\-exec
190 フラグをセットすべきファイルディスクリプタを作成するどのシステムコールでも起こり得るものであり、 他のいろいろな Linux
191 システムコールでこの問題に対処するために \fBO_CLOEXEC\fP と同等の機能が提供されている。)
192 .TP 
193 \fBO_CREAT\fP
194 .\" As at 2.6.25, bsdgroups is supported by ext2, ext3, ext4, and
195 .\" XFS (since 2.6.14).
196 ファイルが存在しなかった場合は作成 (create) する。 ファイルの所有者 (ユーザー ID) は、プロセスの実効ユーザー ID に設定される。
197 グループ所有権 (グループ ID) は、プロセスの実効グループ ID または親ディレクトリのグループ ID に設定される
198 (これは、ファイルシステムタイプ、マウントオプション、 親ディレクトリのモードに依存する。 \fBmount\fP(8)  で説明されているマウントオプション
199 \fIbsdgroups\fP と \fIsysvgroups\fP を参照)。
200 .RS
201 .PP
202 \fImode\fP は新しいファイルを作成する場合に使用するアクセス許可 (permission) を指定する。 \fIflags\fP に \fBO_CREAT\fP
203 か \fBO_TMPFILE\fP が指定されている場合、 \fImode\fP を指定しなければならない。 \fBO_CREAT\fP も \fBO_TMPFILE\fP
204 も指定されていない場合、 \fImode\fP は無視される。 有効なアクセス許可は、普段と同じようにプロセスの \fIumask\fP
205 によって修正され、作成されたファイルの許可は \fI(mode\ &\ ~umask)\fP となる。
206 このモードは、新しく作成されたファイルに対するそれ以降のアクセス にのみ適用される点に注意すること。 読み取り専用のファイルを作成する
207 \fBopen\fP()  コールであっても、 読み書き可能なファイルディスクリプタを返すことがありうる。
208 .PP
209 \fImode\fP のために以下のシンボル定数が提供されている :
210 .TP  9
211 \fBS_IRWXU\fP
212 00700 ユーザー (ファイルの所有者) に読み込み、書き込み、 実行の許可がある。
213 .TP 
214 \fBS_IRUSR\fP
215 00400 ユーザーに読み込みの許可がある。
216 .TP 
217 \fBS_IWUSR\fP
218 00200 ユーザーに書き込みの許可がある。
219 .TP 
220 \fBS_IXUSR\fP
221 00100 ユーザーに実行の許可がある。
222 .TP 
223 \fBS_IRWXG\fP
224 00070 グループに読み込み、書き込み、実行の許可がある。
225 .TP 
226 \fBS_IRGRP\fP
227 00040 グループに読み込みの許可がある。
228 .TP 
229 \fBS_IWGRP\fP
230 00020 グループに書き込みの許可がある。
231 .TP 
232 \fBS_IXGRP\fP
233 00010 グループに実行の許可がある。
234 .TP 
235 \fBS_IRWXO\fP
236 00007 他人 (others) に読み込み、書き込み、実行の許可がある。
237 .TP 
238 \fBS_IROTH\fP
239 00004 他人に読み込みの許可がある。
240 .TP 
241 \fBS_IWOTH\fP
242 00002 他人に書き込みの許可がある。
243 .TP 
244 \fBS_IXOTH\fP
245 00001 他人に実行の許可がある。
246 .RE
247 .TP 
248 \fBO_DIRECT\fP (Linux 2.4.10 以降)
249 このファイルに対する I/O のキャッシュの効果を最小化しようとする。このフラグを使うと、一般的に性能が低下する。
250 しかしアプリケーションが独自にキャッシングを行っているような 特別な場合には役に立つ。 ファイルの I/O はユーザー空間バッファに対して直接行われる。
251 \fBO_DIRECT\fP フラグ自身はデータを同期で転送しようとはするが、 \fBO_SYNC\fP
252 フラグのようにデータと必要なメタデータの転送が保証されるわけではない。同期 I/O を保証するためには、 \fBO_DIRECT\fP に加えて
253 \fBO_SYNC\fP を使用しなければならない。下記の「注意」の節の議論も参照。
254 .sp
255 ブロックデバイスに対する似通った意味のインターフェースが \fBraw\fP(8)  で説明されている (但し、このインタフェースは非推奨である)。
256 .TP 
257 \fBO_DIRECTORY\fP
258 .\" But see the following and its replies:
259 .\" http://marc.theaimsgroup.com/?t=112748702800001&r=1&w=2
260 .\" [PATCH] open: O_DIRECTORY and O_CREAT together should fail
261 .\" O_DIRECTORY | O_CREAT causes O_DIRECTORY to be ignored.
262 \fIpathname\fP がディレクトリでなければオープンは失敗する。 このフラグは、 \fBopendir\fP(3)  が FIFO
263 やテープデバイスに対してコールされた場合の サービス不能 (denial\-of\-service) 攻撃を避けるために カーネル 2.1.126
264 で追加された。
265 .TP 
266 \fBO_DSYNC\fP
267 ファイルに対する書き込み操作は、同期 I/O の\fIデータ\fP完全性完了の要件に基づいて行われる。
268
269 \fBwrite\fP(2) (や同様のコール) が返るまでに、
270 書き込まれたデータおよびデータを取得するのに必要なファイルメタデータが裏で利用されているハードウェアに転送される (つまり、\fBwrite\fP(2)
271 の後に \fBfdatasync\fP(2) を呼び出したのと同じようになる)。 \fI下記の「注意」も参照のこと\fP。
272 .TP 
273 \fBO_EXCL\fP
274 この呼び出しでファイルが作成されることを保証する。このフラグが \fBO_CREAT\fP と
275 一緒に指定され、 \fIpathname\fP のファイルが既に存在した場合、 \fBopen\fP() は失敗
276 する。
277
278 .\" POSIX.1-2001 explicitly requires this behavior.
279 これら二つのフラグが指定された際、シンボリックリンクは辿られない。 \fIpathname\fP がシンボリックリンクの場合、
280 シンボリックリンクがどこを指しているかに関わらず \fBopen\fP()  は失敗する。
281
282 一般的には、 \fBO_CREAT\fP を指定せずに \fBO_EXCL\fP を使用した場合の
283 \fBO_EXCL\fP の動作は規定されていない。
284 これには一つ例外があり、Linux 2.6 以降では、
285 \fIpathname\fP がブロックデバイスを参照している場合、
286 \fBO_CREAT\fP なしで \fBO_EXCL\fP を使用することができる。
287 システムがそのブロックデバイスを使用中の場合 (例えば、
288 マウントされているなど)、 \fBopen\fP() はエラー \fBEBUSY\fP で失敗する。
289
290 NFS では、 \fBO_EXCL\fP は、Linux 2.6 以降で NFSv3 以降を使っている場合でのみサポートされる。 \fBO_EXCL\fP
291 サポートが提供されていない NFS 環境では、このフラグに頼って ロック処理を実行するプログラムは競合状態 (race condition) に出会う
292 可能性がある。 ロックファイルを使用して不可分 (atomic) なファイルロックを実現し、 NFS が \fBO_EXCL\fP
293 をサポートしているかに依存しないようにしたい場合、 移植性のある方法は、同じファイルシステム上に他と名前の重ならない ファイル (例えばホスト名と
294 PID を組み合わせた名前) を作成し、 \fBlink\fP(2)  を使用してそのロックファイルへのリンクを作成することである。 \fBlink\fP(2)
295 コールの返り値が 0 ならばロックに成功している。 あるいは、そのファイルに \fBstat\fP(2)  を使用してリンク数 (link count) が
296 2 になっているかをチェックする。 そうなっていれば、同じくロックに成功しているということである。
297 .TP 
298 \fBO_LARGEFILE\fP
299 (LFS) \fIoff_t\fP ではサイズを表せない (だだし \fIoff64_t\fP ではサイズを表せる)ファ
300 イルをオープン可能にする。この定義を有効にするためには、(\fIどの\fPヘッダファイ
301 ルをインクルードするよりも前に) \fB_LARGEFILE64_SOURCE\fP マクロを定義しなければ
302 ならない。
303 32 ビットシステムにおいて大きなファイルにアクセスしたい場合、
304 (\fBO_LARGEFILE\fP を使うよりも) \fB_FILE_OFFSET_BITS\fP 機能検査マクロを 64 に
305 セットする方が望ましい方法である (\fBfeature_test_macros\fP(7) を参照)。
306 .TP 
307 \fBO_NOATIME\fP (Linux 2.6.8 以降)
308 .\" The O_NOATIME flag also affects the treatment of st_atime
309 .\" by mmap() and readdir(2), MTK, Dec 04.
310 ファイルに対して \fBread\fP(2)  が実行されたときに、最終アクセス時刻 (inode の \fIst_atime\fP) を更新しない。
311 このフラグはインデックス作成やバックアッププログラムで使うことを意図している。 これを使うとディスクに対する操作を大幅に減らすことができる。
312 このフラグは全てのファイルシステムに対して有効であるわけではない。 その一例が NFS であり、サーバがアクセス時刻を管理している。
313 .TP 
314 \fBO_NOCTTY\fP
315 \fIpathname\fP が端末 (terminal) デバイス \(em \fBtty\fP(4) 参照 \(em を指している
316 場合に、たとえそのプロセスが制御端末を持っていなくても、オープンしたファイル
317 は制御端末にはならない。
318 .TP 
319 \fBO_NOFOLLOW\fP
320 .\" The headers from glibc 2.0.100 and later include a
321 .\" definition of this flag; \fIkernels before 2.1.126 will ignore it if
322 .\" used\fP.
323 \fIpathname\fP がシンボリックリンクだった場合、オープンは失敗する。 これは FreeBSD の拡張で、Linux には バージョン
324 2.1.126 で追加された。 このフラグが指定された場合でも \fIpathname\fP の前の方の要素 (最後のディレクトリセパレータより前の部分)
325 にあるシンボリックリンクについてはリンクが辿られる。 下記の \fBO_PATH\fP も参照のこと。
326 .TP 
327 \fBO_NONBLOCK\fP または \fBO_NDELAY\fP
328 可能ならば、ファイルは非停止 (nonblocking) モードでオープンされる。
329 \fBopen\fP() も、返したファイルディスクリプタに対する以後のすべての操作も呼び出
330 したプロセスを待たせることはない。 FIFO (名前付きパイプ) を扱う場合には
331 \fBfifo\fP(7) も参照すること。 強制ファイルロック (mandatory file lock) やファイ
332 ルリース (file lease) と組み合わせた場合の、 \fBO_NONBLOCK\fP の効果についての
333 議論は、 \fBfcntl\fP(2) を参照すること。
334 .TP 
335 \fBO_PATH\fP (Linux 2.6.39 以降)
336 .\" commit 1abf0c718f15a56a0a435588d1b104c7a37dc9bd
337 .\" commit 326be7b484843988afe57566b627fb7a70beac56
338 .\" commit 65cfc6722361570bfe255698d9cd4dccaf47570d
339 .\"
340 .\" http://thread.gmane.org/gmane.linux.man/2790/focus=3496
341 .\"     Subject: Re: [PATCH] open(2): document O_PATH
342 .\"     Newsgroups: gmane.linux.man, gmane.linux.kernel
343 .\"
344 このフラグを指定して取得したファイルディスクリプタは、 ファイルシステムツリー内での場所を示すため、
345 純粋にファイルディスクリプタレベルでの作用する操作を実行するため、 の二つの目的で使用することができる。 ファイル自身はオープンされず、
346 他のファイル操作 (例えば \fBread\fP(2), \fBwrite\fP(2), \fBfchmod\fP(2), \fBfchown\fP(2),
347 \fBfgetxattr\fP(2), \fBmmap\fP(2)) はエラー \fBEBADF\fP で失敗する。
348
349 取得したファイルディスクリプタに対して以下の操作を行うことが「できる」。
350 .RS
351 .IP * 3
352 .\" commit 332a2e1244bd08b9e3ecd378028513396a004a24
353 .\" fstat(): commit 55815f70147dcfa3ead5738fd56d3574e2e3c1c2
354 \fBclose\fP(2); \fBfchdir\fP(2)  (Linux 3.5 以降); \fBfstat\fP(2)  (Linux 3.6 以降)
355 .IP *
356 ファイルディスクリプタの複製 (\fBdup\fP(2), \fBfcntl\fP(2)  \fBF_DUPFD\fP など)
357 .IP *
358 ファイルディスクリプタフラグの取得と設定 (\fBfcntl\fP(2) の \fBF_GETFD\fP と \fBF_SETFD\fP)
359 .IP *
360 \fBfcntl\fP(2) の \fBF_GETFL\fP 操作を使ったオープンされたファイルの状態フラグの取得。 返されるフラグには \fBO_PATH\fP
361 ビットが含まれる。
362 .IP *
363 Passing the file descriptor as the \fIdirfd\fP argument of \fBopenat\fP(2)  and
364 the other "*at()" system calls.  This includes \fBlinkat\fP(2)  with
365 \fBAT_EMPTY_PATH\fP (or via procfs using \fBAT_SYMLINK_FOLLOW\fP)  even if the
366 file is not a directory.
367 .IP *
368 そのファイルディスクリプタを別のプロセスに UNIX ドメインソケット経由で渡す。 (\fBunix\fP(7) の \fBSCM_RIGHTS\fP を参照)
369 .RE
370 .IP
371 \fIflags\fP に \fBO_PATH\fP が指定された場合、 \fBO_CLOEXEC\fP, \fBO_DIRECTORY\fP, \fBO_NOFOLLOW\fP
372 以外のフラグビットは無視される。
373
374 \fIpathname\fP がシンボリックリンクで \fBO_NOFOLLOW\fP フラグも合わせて指定された場合、
375 この呼び出しではシンボリックリンクを参照するファイルディスクリプタを返す。 このファイルディスクリプタは、 空のパス名を指定した
376 \fBfchownat\fP(2), \fBfstatat\fP(2), \fBlinkat\fP(2), \fBreadlinkat\fP(2) の呼び出しで
377 \fIdirfd\fP 引数として使うことで、 そのシンボリックリンクに対して操作を行うことができる。
378 .TP 
379 \fBO_SYNC\fP
380 ファイルに対する書き込み操作は、同期 I/O の\fIファイル\fP完全性完了の要件に基づいて行われる (これに対し \fBO_DSYNC\fP では同期 I/O
381 の\fIデータ\fP完全性完了が提供される)。
382
383 \fBwrite\fP(2) (や同様のコール) が返るまでに、 書き込まれたデータと関連するファイルメタデータが裏で利用されているハードウェアに転送される
384 (つまり、\fBwrite\fP(2) の後に \fBfsync\fP(2) を呼び出したのと同じようになる)。 \fI下記の「注意」も参照のこと\fP。
385 .TP 
386 \fBO_TMPFILE\fP (Linux 3.11 以降)
387 .\" commit 60545d0d4610b02e55f65d141c95b18ccf855b6e
388 .\" commit f4e0c30c191f87851c4a53454abb55ee276f4a7e
389 .\" commit bb458c644a59dbba3a1fe59b27106c5e68e1c4bd
390 名前なしの一時ファイルを作成する。 \fIpathname\fP 引き数はディレクトリを指定する。 名前なしの inode
391 がそのディレクトリが存在するファイルシステムに作成される。 そのファイルに名前を付与しない限り、 作成されたファイルに書き込まれた内容は、
392 最後のファイルディスクリプタがクローズされる際に失われる。
393
394 \fBO_TMPFILE\fP は必ず \fBO_RDWR\fP か \fBO_WRONLY\fP のいずれかと一緒に使わなければならない。 \fBO_EXCL\fP
395 も指定することができる。 \fBO_EXCL\fP が指定されなかった場合、 \fBlinkat\fP(2)
396 を使って、そのファイルシステムにこの一時ファイルへのリンクを作成し、ファイルを永続化することができる。 以下のコードのようにすればよい。
397
398 .in +4n
399 .nf
400 char path[PATH_MAX];
401 fd = open("/path/to/dir", O_TMPFILE | O_RDWR,
402                         S_IRUSR | S_IWUSR);
403
404 /* 'fd' に対するファイル I/O ... */
405
406 snprintf(path, PATH_MAX,  "/proc/self/fd/%d", fd);
407 linkat(AT_FDCWD, path, AT_FDCWD, "/path/for/file",
408                         AT_SYMLINK_FOLLOW);
409 .fi
410 .in
411
412 この場合、 \fBopen\fP() の \fImode\fP 引き数は \fBO_CREAT\fP と同様にファイルのアクセス許可モードの決定に使われる。
413
414 \fBO_TMPFILE\fP とともに \fBO_EXCL\fP を指定すると、
415 一時ファイルに対して上記の方法でファイルシステムへのリンクを行うことができなくなる (この場合の \fBO_EXCL\fP の意味は他の場合の
416 \fBO_EXCL\fP の意味とは異なる点に注意)。
417
418
419 .\" Inspired by http://lwn.net/Articles/559147/
420 \fBO_TMPFILE\fP には主に二つの用途がある。
421 .RS
422 .IP * 3
423 改善された \fBtmpfile\fP(3) の機能: (1) クローズ時に自動的に削除される、 (2) パス名では決して参照できない、 (3)
424 シンボリックリンク攻撃ができない、 (4) 呼び出し元が一意な名前を考える必要がない、 という特長を持つ競合のない一時ファイルの作成。
425 .IP *
426 最初は見えないファイルを作成し、 それからデータを書き込んだり、適切なファイルシステム属性を持つように調整したり (\fBchown\fP(2),
427 \fBchmod\fP(2), \fBfsetxattr\fP(2) など) した後、 準備が全て整った状態で (上述の \fBlinkat\fP(2) を使って)
428 ファイルシステム内にアトミックにリンクを行う。
429 .RE
430 .IP
431 .\" commit 99b6436bc29e4f10e4388c27a3e4810191cc4788
432 .\" commit ab29743117f9f4c22ac44c13c1647fb24fb2bafe
433 \fBO_TMPFILE\fP は、 裏で利用されるファイルシステムによるサポートが必要である。 一部の Linux
434 ファイルシステムだけがこの機能をサポートしている。 最初の実装では、 ext2, ext3, ext4, UDF, Minix, shmem
435 ファイルシステムがサポートしていた。 XFS でのサポートが Linux 3.15 で追加された。
436 .TP 
437 \fBO_TRUNC\fP
438 ファイルが既に存在し、通常ファイルであり、 アクセスモードで書き込みが許可されている (つまり、 \fBO_RDWR\fP または \fBO_WRONLY\fP
439 の) 場合、長さ 0 に切り詰め (truncate) られる。 ファイルが FIFO または端末デバイスファイルの場合、 \fBO_TRUNC\fP
440 フラグは無視される。 それ以外の場合、 \fBO_TRUNC\fP の効果は未定義である。
441 .SS creat()
442 \fBcreat\fP()  は \fIflags\fP に \fBO_CREAT|O_WRONLY|O_TRUNC\fP を指定して \fBopen\fP()
443 を行うのと等価である。
444 .SS openat()
445 \fBopenat\fP() システムコールは \fBopen\fP() と全く同様に動作するが、以下で説明する点が異なる。
446
447 \fIpathname\fP で指定されたパス名が相対パスの場合、このパス名はファイルディスクリプター \fIdirfd\fP
448 が参照するディレクトリに対する相対パスと解釈される (\fBopen\fP()
449 に相対パス名を渡した場合のように、呼び出したプロセスのカレントワーキングディレクトリに対する相対パスではない)。
450
451 \fIpathname\fP で指定されたパス名が相対パスで、 \fIdirfd\fP が特別な値 \fBAT_FDCWD\fP の場合、 (\fBopen\fP()
452 と同様に) \fIpathname\fP は呼び出したプロセスのカレントワーキングディレクトリに対する相対パスと解釈される。
453
454 \fIpathname\fP で指定されたパス名が絶対パスの場合、 \fIdirfd\fP は無視される。
455 .SH 返り値
456 \fBopen\fP(), \fBopenat\fP(), \fBcreat\fP() は新しいファイルディスクリプタを返す。 エラーが発生した場合は \-1 を返す
457 (その場合は \fIerrno\fP が適切に設定される)。
458 .SH エラー
459 \fBopen\fP(), \fBopenat\fP(), \fBcreat\fP() は以下のエラーで失敗する。
460 .TP 
461 \fBEACCES\fP
462 ファイルに対する要求されたアクセスが許されていないか、 \fIpathname\fP のディレクトリ部分の何れかのディレクトリに検索許可がなかった。
463 またはファイルが存在せず、親ディレクトリへの書き込み許可がなかった。 (\fBpath_resolution\fP(7)  も参照すること。)
464 .TP 
465 \fBEDQUOT\fP
466 \fBO_CREAT\fP が指定された場合で、そのファイルが存在せず、ディスクブロックか inode がそのファイルシステムのユーザクォータに達していた。
467 .TP 
468 \fBEEXIST\fP
469 \fIpathname\fP は既に存在し、 \fBO_CREAT\fP と \fBO_EXCL\fP が使用された。
470 .TP 
471 \fBEFAULT\fP
472 \fIpathname\fP がアクセス可能なアドレス空間の外を指している。
473 .TP 
474 \fBEFBIG\fP
475 \fBEOVERFLOW\fP 参照。
476 .TP 
477 \fBEINTR\fP
478 遅いデバイス (例えば FIFO、 \fBfifo\fP(7)  参照) のオープンが完了するのを待って停止している間に
479 システムコールがシグナルハンドラにより割り込まれた。 \fBsignal\fP(7)  参照。
480 .TP 
481 \fBEINVAL\fP
482 ファイルシステムが \fBO_DIRECT\fP フラグをサポートしていない。 詳細は\fB注意\fPを参照。
483 .TP 
484 \fBEINVAL\fP
485 .\" In particular, __O_TMPFILE instead of O_TMPFILE
486 \fIflags\fP に無効な値が入っている。
487 .TP 
488 \fBEINVAL\fP
489 \fIflags\fP に \fBO_TMPFILE\fP が指定されたが、 \fBO_WRONLY\fP も \fBO_RDWR\fP も指定されていなかった。
490 .TP 
491 \fBEISDIR\fP
492 \fIpathname\fP はディレクトリを参照しており、書き込み要求が含まれていた (つまり \fBO_WRONLY\fP または \fBO_RDWR\fP
493 が設定されている)。
494 .TP 
495 \fBEISDIR\fP
496 \fIpathname\fP が存在するディレクトリを参照していて、 \fBO_TMPFILE\fP および \fBO_WRONLY\fP と \fBO_RDWR\fP
497 の一方が \fIflags\fP に指定されていたが、 このカーネルバージョンでは \fBO_TMPFILE\fP 機能が提供されていない。
498 .TP 
499 \fBELOOP\fP
500 \fIpathname\fP を解決する際に遭遇したシンボリックリンクが多過ぎる。
501 .TP 
502 \fBELOOP\fP
503 \fIpathname\fP がシンボリックリンクで、 \fIflags\fP に \fBO_NOFOLLOW\fP が指定されたが、 \fBO_PATH\fP
504 が指定されていなかった。
505 .TP 
506 \fBEMFILE\fP
507 プロセスがオープンしているファイル数がすでに最大数に達している。
508 .TP 
509 \fBENAMETOOLONG\fP
510 \fIpathname\fP が長過ぎる。
511 .TP 
512 \fBENFILE\fP
513 オープンされているファイルの総数がシステムの制限に達している。
514 .TP 
515 \fBENODEV\fP
516 \fIpathname\fP がデバイススペシャルファイルを参照しており、対応するデバイスが存在しない。 (これは Linux
517 カーネルのバグであり、この場合には \fBENXIO\fP が返されるべきである)
518 .TP 
519 \fBENOENT\fP
520 \fBO_CREAT\fP が設定されておらず、かつ指定されたファイルが存在しない。 または、 \fIpathname\fP のディレクトリ部分が存在しないか壊れた
521 (dangling) シンボリックリンクである。
522 .TP 
523 \fBENOENT\fP
524 \fIpathname\fP が存在しないディレクトリを参照していて、 \fBO_TMPFILE\fP および \fBO_WRONLY\fP と \fBO_RDWR\fP
525 の一方が \fIflags\fP に指定されていたが、 このカーネルバージョンでは \fBO_TMPFILE\fP 機能が提供されていない。
526 .TP 
527 \fBENOMEM\fP
528 十分なカーネルメモリーがない。
529 .TP 
530 \fBENOSPC\fP
531 \fIpathname\fP を作成する必要があるが、 \fIpathname\fP を含んでいるデバイスに新しいファイルのための空き容量がない。
532 .TP 
533 \fBENOTDIR\fP
534 \fIpathname\fP に含まれるディレクトリ部分のどれかが実際にはディレクトリでない。 または \fBO_DIRECTORY\fP が指定されており、
535 \fIpathname\fP がディレクトリでない。
536 .TP 
537 \fBENXIO\fP
538 \fBO_NONBLOCK\fP | \fBO_WRONLY\fP が設定されており、指定したファイルが FIFO で そのファイルを読み込み用でオープンしている
539 FIFO が存在しない。 または、ファイルがデバイススペシャルファイルで 対応するデバイスが存在しない。
540 .TP 
541 \fBEOPNOTSUPP\fP
542 \fIpathname\fP を含んでいるファイルシステムが \fBO_TMPFILE\fP をサポートしていない。
543 .TP 
544 \fBEOVERFLOW\fP
545 .\" See http://bugzilla.kernel.org/show_bug.cgi?id=7253
546 .\" "Open of a large file on 32-bit fails with EFBIG, should be EOVERFLOW"
547 .\" Reported 2006-10-03
548 \fIpathname\fP が参照しているのが、大き過ぎてオープンできない通常のファイルである。 通常、このエラーが発生するは、32
549 ビットプラットフォーム上で \fI\-D_FILE_OFFSET_BITS=64\fP を指定せずにコンパイルされたアプリケーションが、ファイルサイズが
550 \fI(1<31)\-1\fP バイトを超えるファイルを開こうとした場合である。 上記の \fBO_LARGEFILE\fP も参照。 これは
551 POSIX.1\-2001 で規定されているエラーである。 2.6.24 より前のカーネルでは、Linux はこの場合にエラー \fBEFBIG\fP
552 を返していた。
553 .TP 
554 \fBEPERM\fP
555 .\" Strictly speaking, it's the filesystem UID... (MTK)
556 \fBO_NOATIME\fP フラグが指定されたが、呼び出し元の実効ユーザー ID が ファイルの所有者と一致せず、かつ呼び出し元に特権
557 (\fBCAP_FOWNER\fP)  がない。
558 .TP 
559 \fBEROFS\fP
560 \fIpathname\fP が読み込み専用のファイルシステム上のファイルを参照しており、 書き込みアクセスが要求された。
561 .TP 
562 \fBETXTBSY\fP
563 \fIpathname\fP が現在実行中の実行イメージを参照しており、書き込みが要求された。
564 .TP 
565 \fBEWOULDBLOCK\fP
566 \fBO_NONBLOCK\fP フラグが指定されたが、そのファイルには矛盾するリースが設定されていた (\fBfcntl\fP(2)  参照)。
567 .PP
568 \fBopenat\fP() では以下のエラーも発生する。
569 .TP 
570 \fBEBADF\fP
571 \fIdirfd\fP が有効なファイルディスクリプタではない。
572 .TP 
573 \fBENOTDIR\fP
574 \fIpathname\fP が相対パス名で、 \fIdirfd\fP がディレクトリ以外のファイルを参照しているファイルディスクリプタである。
575 .SH バージョン
576 \fBopenat\fP()  はカーネル 2.6.16 で Linux に追加された。 ライブラリによるサポートはバージョン 2.4 で glibc
577 に追加された。
578 .SH 準拠
579 \fBopen\fP(), \fBcreat\fP()  SVr4, 4.3BSD, POSIX.1\-2001, POSIX.1\-2008.
580
581 \fBopenat\fP(): POSIX.1\-2008.
582
583 フラグ \fBO_DIRECT\fP, \fBO_NOATIME\fP, \fBO_PATH\fP, \fBO_TMPFILE\fP は Linux 特有のものである。
584 これらのフラグの定義を得るためには \fB_GNU_SOURCE\fP を定義しなければならない。
585
586 フラグ \fBO_CLOEXEC\fP, \fBO_DIRECTORY\fP, \fBO_NOFOLLOW\fP は POSIX.1\-2001 では規定されていないが、
587 POSIX.1\-2008 では規定されている。 glibc 2.12 以降では、これらの定義を得るには、 \fB_POSIX_C_SOURCE\fP を
588 200809L 以上の値で定義するか、 \fB_XOPEN_SOURCE\fP を 700 以上の値で定義する。 glibc 2.11 以前では、
589 これらの定義を得るには \fB_GNU_SOURCE\fP を定義する。
590
591 \fBfeature_test_macros\fP(7) に注意書きがあるように、 \fB_POSIX_C_SOURCE\fP, \fB_XOPEN_SOURCE\fP,
592 \fB_GNU_SOURCE\fP などの機能検査マクロは\fIどの\fPヘッダーファイルをインクルードするより前に定義しなければならない。
593 .SH 注意
594 Linux では、 \fBO_NONBLOCK\fP フラグは、 open を実行したいが read または write を実行する意図は
595 必ずしもないことを意味する。 これは \fBioctl\fP(2)  のためのファイルディスクリプタを取得するために、
596 デバイスをオープンするときによく用いられる。
597
598 .LP
599 .\" Linux 2.0, 2.5: truncate
600 .\" Solaris 5.7, 5.8: truncate
601 .\" Irix 6.5: truncate
602 .\" Tru64 5.1B: truncate
603 .\" HP-UX 11.22: truncate
604 .\" FreeBSD 4.7: truncate
605 \fBO_RDONLY | O_TRUNC\fP の影響は未定義であり、その動作は実装によって異なる。 多くのシステムではファイルは実際に切り詰められる。
606
607 \fBopen\fP()  はスペシャルファイルをオープンすることができるが、 \fBcreat\fP()  でスペシャルファイルを作成できない点に注意すること。
608 代わりに \fBmknod\fP(2)  を使用する。
609
610 .\"
611 .\"
612 ファイルが新しく作成されると、 ファイルの \fIst_atime\fP, \fIst_ctime\fP, \fIst_mtime\fP フィールド
613 (それぞれ最終アクセス時刻、最終状態変更時刻、最終修正時刻である。 \fBstat\fP(2)  参照) が現在時刻に設定される。 さらに親ディレクトリの
614 \fIst_ctime\fP と \fIst_mtime\fP も現在時刻に設定される。 それ以外の場合で、O_TRUNC フラグでファイルが修正されたときは、
615 ファイルの \fIst_ctime\fP と \fIst_mtime\fP フィールドが現在時刻に設定される。
616 .SS オープンファイル記述
617 The term open file description is the one used by POSIX to refer to the
618 entries in the system\-wide table of open files.  In other contexts, this
619 object is variously also called an "open file object", a "file handle", an
620 "open file table entry", or\(emin kernel\-developer parlance\(ema \fIstruct
621 file\fP.
622
623 When a file descriptor is duplicated (using \fBdup\fP(2)  or similar), the
624 duplicate refers to the same open file description as the original file
625 descriptor, and the two file descriptors consequently share the file offset
626 and file status flags.  Such sharing can also occur between processes: a
627 child process created via \fBfork\fP(2)  inherits duplicates of its parent's
628 file descriptors, and those duplicates refer to the same open file
629 descriptions.
630
631 .\"
632 .\"
633 Each \fBopen\fP(2)  of a file creates a new open file description; thus, there
634 may be multiple open file descriptions corresponding to a file inode.
635 .SS "同期 I/O"
636 POSIX.1\-2008 の「同期 I/O」の選択肢として複数種類が規定されており、 動作を制御するために \fBopen\fP() フラグとして
637 \fBO_SYNC\fP, \fBO_DSYNC\fP, \fBO_RSYNC\fP が規定されている。 この選択肢を実装がサポートしているかに関わらず、
638 各実装では少なくとも通常のファイルに対して \fBO_SYNC\fP が利用できなければならない。
639
640 Linux は \fBO_SYNC\fP と \fBO_DSYNC\fP を実装しているが、 \fBO_RSYNC\fP は実装していない (少し間違っているのだが、
641 glibc では \fBO_RSYNC\fP が \fBO_SYNC\fP と同じ値で定義されている)。
642
643 \fBO_SYNC\fP は、 同期 I/O での\fIファイル\fP完全性完了を提供する。 つまり、
644 書き込み操作はデータとすべての関連メタデータを裏で利用されているハードウェアにフラッシュすることを意味する。 \fBO_DSYNC\fP は、 同期 I/O
645 での\fIデータ\fP完全性完了を提供する。 つまり、 書き込み操作はデータを裏で利用されているハードウェアにフラッシュするが、
646 それ以降の読み出し操作が正常に完了するのに必要なメタデータの更新のみをフラッシュする。 データ完全性完了は、
647 ファイル完全性完了を必要としないアプリケーションで、 ディスク操作の数を減らすことができる。
648
649 2 種類の完了の違いを理解するために、 ファイルメタデータの 2 つの要素、 ファイルの最終修正時刻 (\fIst_mtime\fP)
650 とファイル長、を考える。 すべての書き込み操作は最終修正時刻を更新するが、 ファイルの末尾にデータを追加する書き込み操作のみがファイル長を変更する。
651 最終修正時刻は、 読み出しが正常に完了するのに必要ではないが、 ファイル長は必要である。 したがって、 \fBO_DSYNC\fP
652 はファイル長のメタデータの更新がフラッシュされることだけを保証する (これに対して \fBO_SYNC\fP
653 では最終修正時刻のメタデータも常にフラッシュされる)。
654
655 Linux 2.6.33 より前では、 Linux は \fBopen\fP() では \fBO_SYNC\fP フラグのみを実装していた。 しかしながら、
656 このフラグが指定された場合、 ほとんどのファイルシステムで提供されていたのは実際には同期 I/O での\fIデータ\fP完全性完了と等価なものであった
657 (つまり、 \fBO_SYNC\fP は実際には \fBO_DSYNC\fP と等価なものとして実装されていた)。
658
659 .\"
660 .\"
661 Linux 2.6.33 行こう では、 正しい \fBO_SYNC\fP のサポートが提供されている。 しかしながら、
662 バイナリレベルの後方互換性を保証するため、 \fBO_DSYNC\fP は以前の \fBO_SYNC\fP と同じ値で定義されており、 \fBO_SYNC\fP は
663 \fBO_DSYNC\fP フラグの値を含む新しい (2 ビットの) フラグ値として定義されている。 これにより、
664 新しいヘッダを使ってコンパイルされたアプリケーションで、 2.6.33 より前のカーネルで少なくとも \fBO_DSYNC\fP
665 の動作は同じになることが保証される。
666 .SS NFS
667 NFS を実現しているプロトコルには多くの不備があり、特に \fBO_SYNC\fP と \fBO_NDELAY\fP に影響する。
668
669 .\"
670 .\"
671 UID マッピングを使用している NFS ファイルシステムでは、 \fBopen\fP()  がファイルディスクリプタを返した場合でも \fBread\fP(2)
672 が \fBEACCES\fP で拒否される場合がある。 これはクライアントがアクセス許可のチェックを行って \fBopen\fP()
673 を実行するが、読み込みや書き込みの際には サーバーで UID マッピングが行われるためである。
674 .SS ファイルアクセスモード
675 「アクセスモード」の値 \fBO_RDONLY\fP, \fBO_WRONLY\fP, \fBO_RDWR\fP は、 \fIflags\fP
676 に指定できる他の値と違い、個々のビットを指定するものではなく、 これらの値は \fIflags\fP の下位 2 ビットを定義する。 \fBO_RDONLY\fP,
677 \fBO_WRONLY\fP, \fBO_RDWR\fP はそれぞれ 0, 1, 2 に定義されている。 言い換えると、 \fBO_RDONLY |
678 O_WRONLY\fP の組み合わせは論理的に間違いであり、確かに \fBO_RDWR\fP と同じ意味ではない。
679
680 .\" See for example util-linux's disk-utils/setfdprm.c
681 .\" For some background on access mode 3, see
682 .\" http://thread.gmane.org/gmane.linux.kernel/653123
683 .\" "[RFC] correct flags to f_mode conversion in __dentry_open"
684 .\" LKML, 12 Mar 2008
685 .\"
686 .\"
687 Linux では、特別な、非標準なアクセスモードとして 3 (バイナリでは 11) が 予約されており \fIflags\fP に指定できる。
688 このアクセスモードを指定すると、ファイルの読み出し/書き込み許可をチェックし、 読み出しにも書き込みにも使用できないディスクリプタを返す。
689 この非標準のアクセスモードはいくつかの Linux ドライバで、デバイス固有の \fBioctl\fP(2)
690 操作にのみ使用されるディスクリプタを返すために使われている。
691 .SS "openat() や他のディレクトリファイルディスクリプタ API の基本原理"
692 \fBopenat\fP() やディレクトリファイルディスクリプタを引き数を取る他のシステムコールやライブラリ関数 (\fBfaccessat\fP(2),
693 \fBfanotify_mark\fP(2), \fBfchmodat\fP(2), \fBfchownat\fP(2), \fBfstatat\fP(2),
694 \fBfutimesat\fP(2), \fBlinkat\fP(2), \fBmkdirat\fP(2), \fBmknodat\fP(2),
695 \fBname_to_handle_at\fP(2), \fBreadlinkat\fP(2), \fBrenameat\fP(2), \fBsymlinkat\fP(2),
696 \fBunlinkat\fP(2), \fButimensat\fP(2) \fBmkfifoat\fP(3), \fBscandirat\fP(3))
697 は二つの理由から用意されている。 ここでは、 \fBopenat\fP コールに関して説明するが、この基本原理は他のインターフェースでも同じである。
698
699 First, \fBopenat\fP()  allows an application to avoid race conditions that
700 could occur when using \fBopen\fP()  to open files in directories other than
701 the current working directory.  These race conditions result from the fact
702 that some component of the directory prefix given to \fBopen\fP()  could be
703 changed in parallel with the call to \fBopen\fP().  Suppose, for example, that
704 we wish to create the file \fIpath/to/xxx.dep\fP if the file \fIpath/to/xxx\fP
705 exists.  The problem is that between the existence check and the file
706 creation step, \fIpath\fP or \fIto\fP (which might be symbolic links)  could be
707 modified to point to a different location.  Such races can be avoided by
708 opening a file descriptor for the target directory, and then specifying that
709 file descriptor as the \fIdirfd\fP argument of (say)  \fBfstatat\fP(2)  and
710 \fBopenat\fP().
711
712 .\"
713 .\"
714 二つ目として、 \fBopenat\fP() を使うと、アプリケーションが管理するファイルディスクリプタにより、
715 スレッド単位の「カレントワーキングディレクトリ」を実装することができる (この機能は、 \fI/proc/self/fd/dirfd\fP
716 を使った方法でも実現することができるが、 効率の面で落とる)。
717 .SS O_DIRECT
718 .LP
719 \fBO_DIRECT\fP フラグを使用する場合、ユーザ空間バッファの長さやアドレス、 I/O
720 のファイルオフセットに関してアラインメントの制限が課されることがある。 Linux では、アラインメントの制限はファイルシステムやカーネルのバージョンに
721 よって異なり、全く制限が存在しない場合もある。 しかしながら、現在のところ、指定されたファイルやファイルシステムに対して
722 こうした制限があるかを見つけるための、アプリケーション向けのインタフェースで ファイルシステム非依存のものは存在しない。
723 いくつかのファイルシステムでは、制限を確認するための独自のインタフェースが 提供されている。例えば、 \fBxfsctl\fP(3)  の
724 \fBXFS_IOC_DIOINFO\fP 命令である。
725 .LP
726 Under Linux 2.4, transfer sizes, and the alignment of the user buffer and
727 the file offset must all be multiples of the logical block size of the
728 filesystem.  Since Linux 2.6.0, alignment to the logical block size of the
729 underlying storage (typically 512 bytes) suffices.  The logical block size
730 can be determined using the \fBioctl\fP(2)  \fBBLKSSZGET\fP operation or from the
731 shell using the command:
732
733     blockdev \-\-getss
734 .LP
735 メモリバッファがプライベートマッピング (\fBmmap\fP(2) の \fBMAP_PRIVATE\fP
736 フラグで作成されたマッピング) の場合には、\fBO_DIRECT\fP I/O は
737 \fBfork\fP(2) システムコールと同時に決して実行すべきではない
738 (プライベートマッピングには、ヒープ領域に割り当てられたメモリや静的に
739 割り当てたバッファも含まれる)。非同期 I/O インターフェース (AIO) 経由
740 やプロセス内の他のスレッドから発行された、このような I/O は、
741 \fBfork\fP(2) が呼び出される前に完了されるべきである。
742 そうしなかった場合、データ破壊や、親プロセスや子プロセスでの予期しない
743 動作が起こる可能性がある。
744 \fBO_DIRECT\fP I/O 用のメモリバッファが \fBshmat\fP(2) や\fBMAP_SHARED\fP フラグ
745 付きの \fBmmap\fP(2) で作成された場合には、この制限はあてはまらない。
746 \fBmadvise\fP(2) でメモリバッファにアドバイス \fBMADV_DONTFORK\fP が設定され
747 ている場合にも、この制限はあてはまらない(\fBMADV_DONTFORK\fP はそのメモリ
748 バッファが \fBfork\fP(2) 後に子プロセスからは利用できないことを保証するも
749 のである)。
750 .LP
751 \fBO_DIRECT\fP フラグは SGI IRIX で導入された。SGI IRIX にも Linux 2.4 と同様の (ユーザーバッファの)
752 アラインメントの制限がある。 また、IRIX には適切な配置とサイズを取得するための \fBfcntl\fP(2)  コールがある。 FreeBSD 4.x
753 も同じ名前のフラグを導入したが、アラインメントの制限はない。
754 .LP
755 \fBO_DIRECT\fP が Linux でサポートされたのは、カーネルバージョン 2.4.10 である。 古い Linux
756 カーネルは、このフラグを単に無視する。 \fBO_DIRECT\fP フラグをサポートしていないファイルシステムもあり、その場合は、 \fBO_DIRECT\fP
757 を使用すると \fBopen\fP()  は \fBEINVAL\fP で失敗する。
758 .LP
759 アプリケーションは、同じファイル、 特に同じファイルの重複するバイト領域に対して、 \fBO_DIRECT\fP と通常の I/O
760 を混ぜて使うのは避けるべきである。 ファイルシステムがこのような状況において一貫性の問題を正しく 扱うことができる場合であっても、全体の I/O
761 スループットは どちらか一方を使用するときと比べて低速になるであろう。 同様に、アプリケーションは、同じファイルに対して \fBmmap\fP(2)  と直接
762 I/O (\fBO_DIRECT\fP)  を混ぜて使うのも避けるべきである。
763 .LP
764 NFS で \fBO_DIRECT\fP を使った場合の動作はローカルのファイルシステムの場合と違う。
765 古いカーネルや、ある種の設定でコンパイルされたカーネルは、 \fBO_DIRECT\fP と NFS の組み合わせをサポートしていないかもしれない。 NFS
766 プロトコル自体はサーバにフラグを渡す機能は持っていないので、 \fBO_DIRECT\fP I/O
767 はクライアント上のページキャッシュをバイパスするだけになり、 サーバは I/O をキャッシュしているかもしれない。 クライアントは、
768 \fBO_DIRECT\fP の同期機構を保持するため、サーバに対して I/O を同期して行うように依頼する。 サーバによっては、こうした状況下、特に I/O
769 サイズが小さい場合に 性能が大きく劣化する。 また、サーバによっては、I/O が安定したストレージにまで行われたと、
770 クライアントに対して嘘をつくものもある。 これは、サーバの電源故障が起こった際にデータの完全性が保たれない
771 危険は少しあるが、性能面での不利な条件を回避するために行われている。 Linux の NFS クライアントでは \fBO_DIRECT\fP I/O
772 でのアラインメントの制限はない。
773 .PP
774 まとめると、 \fBO_DIRECT\fP は、注意して使うべきであるが、強力なツールとなる可能性を持っている。 アプリケーションは \fBO_DIRECT\fP
775 をデフォルトでは無効になっている性能向上のためのオプションと 考えておくのがよいであろう。
776 .PP
777 .RS
778 「O_DIRECT でいつも困るのは、インタフェース全部が本当にお馬鹿な点だ。 たぶん危ないマインドコントロール剤で
779 頭がおかしくなったサルが設計したんじゃないかな」 \(em Linus
780 .RE
781 .SH バグ
782 .\" FIXME . Check bugzilla report on open(O_ASYNC)
783 .\" See http://bugzilla.kernel.org/show_bug.cgi?id=5993
784 現在のところ、 \fBopen\fP()  の呼び出し時に \fBO_ASYNC\fP を指定してシグナル駆動 I/O を有効にすることはできない。
785 このフラグを有効にするには \fBfcntl\fP(2)  を使用すること。
786
787 カーネルが \fBO_TMPFILE\fP 機能をサポートしているかを判定する際に、 \fBEISDIR\fP と \fBENOENT\fP の 2
788 つのエラーコードをチェックしなければならない。
789 .SH 関連項目
790 \fBchmod\fP(2), \fBchown\fP(2), \fBclose\fP(2), \fBdup\fP(2), \fBfcntl\fP(2), \fBlink\fP(2),
791 \fBlseek\fP(2), \fBmknod\fP(2), \fBmmap\fP(2), \fBmount\fP(2), \fBopen_by_handle_at\fP(2),
792 \fBread\fP(2), \fBsocket\fP(2), \fBstat\fP(2), \fBumask\fP(2), \fBunlink\fP(2),
793 \fBwrite\fP(2), \fBfopen\fP(3), \fBfifo\fP(7), \fBpath_resolution\fP(7), \fBsymlink\fP(7)
794 .SH この文書について
795 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.76 の一部
796 である。プロジェクトの説明とバグ報告に関する情報は
797 http://www.kernel.org/doc/man\-pages/ に書かれている。