OSDN Git Service

Update release for LDP 3.67
[linuxjm/LDP_man-pages.git] / release / 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\-05\-10 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.  (This object is variously also called an
132 "open file object", a "file handle", an "open file table entry", or\(emin
133 kernel\-developer parlance\(ema \fIstruct file\fP.  The term "open file
134 description" is used by POSIX.)  The open file description records the file
135 offset and the file status flags (see below).  A file descriptor is a
136 reference to an open file description; this reference is unaffected if
137 \fIpathname\fP is subsequently removed or modified to refer to a different
138 file.  The new open file description is initially not shared with any other
139 process, but sharing may arise via \fBfork\fP(2).
140 .PP
141 引き数 \fIflags\fP には、アクセスモード \fBO_RDONLY\fP, \fBO_WRONLY\fP, \fBO_RDWR\fP
142 のどれかひとつが入っていなければならない。 これらはそれぞれ読み込み専用、書き込み専用、読み書き用に ファイルをオープンすることを要求するものである。
143
144 .\" SUSv4 divides the flags into:
145 .\" * Access mode
146 .\" * File creation
147 .\" * File status
148 .\" * Other (O_CLOEXEC, O_DIRECTORY, O_NOFOLLOW)
149 .\" though it's not clear what the difference between "other" and
150 .\" "File creation" flags is.  I raised an Aardvark to see if this
151 .\" can be clarified in SUSv4; 10 Oct 2008.
152 .\" http://thread.gmane.org/gmane.comp.standards.posix.austin.general/64/focus=67
153 .\" TC1 (balloted in 2013), resolved this, so that those three constants
154 .\" are also categorized" as file status flags.
155 .\"
156 さらに、 \fIflags\fP には、ファイル作成フラグ (file creation flag) とファイル状態フラグ (file status
157 flag) を 0 個以上「ビット単位の OR (bitwise\-or)」で 指定することができる。 \fIファイル作成フラグ\fP は
158 \fBO_CLOEXEC\fP, \fBO_CREAT\fP, \fBO_DIRECTORY\fP, \fBO_EXCL\fP, \fBO_NOCTTY\fP,
159 \fBO_NOFOLLOW\fP, \fBO_TMPFILE\fP, \fBO_TRUNC\fP, \fBO_TTY_INIT\fP である。 \fIファイル状態フラグ\fP
160 は以下のリストのうち上記以外の残りのものである。 二種類のフラグの違いは、ファイル状態フラグの方はその内容を取得したり (場合によっては)
161 変更したりできる点にある。詳細は \fBfcntl\fP(2) を参照。
162
163 すべてのファイル作成フラグとファイル状態フラグを以下のリストに示す。
164 .TP 
165 \fBO_APPEND\fP
166 .\" For more background, see
167 .\" http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=453946
168 .\" http://nfs.sourceforge.net/
169 ファイルを追加 (append) モードでオープンする。 毎回の \fBwrite\fP(2)  の前に \fBlseek\fP(2)
170 を行ったかのように、ファイルポインタをファイルの最後に移動する。 NFS ファイルシステムで、 \fBO_APPEND\fP
171 を使用すると、複数のプロセスがひとつのファイルに同時にデータを追加した場合、 ファイルが壊れてしまうことがある。 これは NFS
172 が追加モードをサポートしていないため、 クライアントのカーネル (kernel) がそれをシミュレートしなければならないのだが、
173 競合状態を避けることはできないからである。
174 .TP 
175 \fBO_ASYNC\fP
176 シグナル駆動 I/O (signal\-driven I/O) を有効にする: このファイルディスクリプタへの
177 入力または出力が可能になった場合に、シグナルを生成する (デフォルトは \fBSIGIO\fP であるが、 \fBfcntl\fP(2)
178 によって変更可能である)。 この機能が使用可能なのは端末、疑似端末、ソケットのみであり、 (Linux 2.6 以降では) パイプと FIFO
179 に対しても使用できる。 さらに詳しい説明は \fBfcntl\fP(2)  を参照すること。 下記の「バグ」も参照。
180 .TP 
181 \fBO_CLOEXEC\fP (Linux 2.6.23 以降)
182 .\" NOTE! several other man pages refer to this text
183 新しいファイルディスクリプタに対して close\-on\-exec フラグを有効にする。 このフラグを指定することで、 プログラムは
184 \fBFD_CLOEXEC\fP フラグをセットするために \fBfcntl\fP(2) \fBF_SETFD\fP 操作を別途呼び出す必要がなくなる。
185
186 .\" This flag fixes only one form of the race condition;
187 .\" The race can also occur with, for example, descriptors
188 .\" returned by accept(), pipe(), etc.
189 ある種のマルチスレッドのプログラムはこのフラグの使用は不可欠である点に注意すること。 なぜなら、個別に \fBFD_CLOEXEC\fP フラグを設定する
190 \fBfcntl\fP(2) \fBF_SETFD\fP 操作を呼び出したとしても、あるスレッドがファイルディスクリプタを オープンするのと同時に別のスレッドが
191 \fBfork\fP(2) と \fBexecve\fP(2) を実行するという競合条件を避けるのには十分ではないからである。
192 実行の順序に依存して、この競合条件の結果、 \fBopen\fP() が返したファイルディスクリプタが \fBfork\fP(2)
193 で作成された子プロセスにより実行されるプログラムに意図せず見えてしまう可能性がある。 (この種の競合は、 本質的に、 close\-on\-exec
194 フラグをセットすべきファイルディスクリプタを作成するどのシステムコールでも起こり得るものであり、 他のいろいろな Linux
195 システムコールでこの問題に対処するために \fBO_CLOEXEC\fP と同等の機能が提供されている。)
196 .TP 
197 \fBO_CREAT\fP
198 .\" As at 2.6.25, bsdgroups is supported by ext2, ext3, ext4, and
199 .\" XFS (since 2.6.14).
200 ファイルが存在しなかった場合は作成 (create) する。 ファイルの所有者 (ユーザー ID) は、プロセスの実効ユーザー ID に設定される。
201 グループ所有権 (グループ ID) は、プロセスの実効グループ ID または親ディレクトリのグループ ID に設定される
202 (これは、ファイルシステムタイプ、マウントオプション、 親ディレクトリのモードに依存する。 \fBmount\fP(8)  で説明されているマウントオプション
203 \fIbsdgroups\fP と \fIsysvgroups\fP を参照)。
204 .RS
205 .PP
206 \fImode\fP は新しいファイルを作成する場合に使用するアクセス許可 (permission) を指定する。 \fIflags\fP に \fBO_CREAT\fP
207 か \fBO_TMPFILE\fP が指定されている場合、 \fImode\fP を指定しなければならない。 \fBO_CREAT\fP も \fBO_TMPFILE\fP
208 も指定されていない場合、 \fImode\fP は無視される。 有効なアクセス許可は、普段と同じようにプロセスの \fIumask\fP
209 によって修正され、作成されたファイルの許可は \fI(mode\ &\ ~umask)\fP となる。
210 このモードは、新しく作成されたファイルに対するそれ以降のアクセス にのみ適用される点に注意すること。 読み取り専用のファイルを作成する
211 \fBopen\fP()  コールであっても、 読み書き可能なファイルディスクリプタを返すことがありうる。
212 .PP
213 \fImode\fP のために以下のシンボル定数が提供されている :
214 .TP  9
215 \fBS_IRWXU\fP
216 00700 ユーザー (ファイルの所有者) に読み込み、書き込み、 実行の許可がある。
217 .TP 
218 \fBS_IRUSR\fP
219 00400 ユーザーに読み込みの許可がある。
220 .TP 
221 \fBS_IWUSR\fP
222 00200 ユーザーに書き込みの許可がある。
223 .TP 
224 \fBS_IXUSR\fP
225 00100 ユーザーに実行の許可がある。
226 .TP 
227 \fBS_IRWXG\fP
228 00070 グループに読み込み、書き込み、実行の許可がある。
229 .TP 
230 \fBS_IRGRP\fP
231 00040 グループに読み込みの許可がある。
232 .TP 
233 \fBS_IWGRP\fP
234 00020 グループに書き込みの許可がある。
235 .TP 
236 \fBS_IXGRP\fP
237 00010 グループに実行の許可がある。
238 .TP 
239 \fBS_IRWXO\fP
240 00007 他人 (others) に読み込み、書き込み、実行の許可がある。
241 .TP 
242 \fBS_IROTH\fP
243 00004 他人に読み込みの許可がある。
244 .TP 
245 \fBS_IWOTH\fP
246 00002 他人に書き込みの許可がある。
247 .TP 
248 \fBS_IXOTH\fP
249 00001 他人に実行の許可がある。
250 .RE
251 .TP 
252 \fBO_DIRECT\fP (Linux 2.4.10 以降)
253 このファイルに対する I/O のキャッシュの効果を最小化しようとする。このフラグを使うと、一般的に性能が低下する。
254 しかしアプリケーションが独自にキャッシングを行っているような 特別な場合には役に立つ。 ファイルの I/O はユーザー空間バッファに対して直接行われる。
255 \fBO_DIRECT\fP フラグ自身はデータを同期で転送しようとはするが、 \fBO_SYNC\fP
256 フラグのようにデータと必要なメタデータの転送が保証されるわけではない。同期 I/O を保証するためには、 \fBO_DIRECT\fP に加えて
257 \fBO_SYNC\fP を使用しなければならない。下記の「注意」の節の議論も参照。
258 .sp
259 ブロックデバイスに対する似通った意味のインターフェースが \fBraw\fP(8)  で説明されている (但し、このインタフェースは非推奨である)。
260 .TP 
261 \fBO_DIRECTORY\fP
262 .\" But see the following and its replies:
263 .\" http://marc.theaimsgroup.com/?t=112748702800001&r=1&w=2
264 .\" [PATCH] open: O_DIRECTORY and O_CREAT together should fail
265 .\" O_DIRECTORY | O_CREAT causes O_DIRECTORY to be ignored.
266 \fIpathname\fP がディレクトリでなければオープンは失敗する。 このフラグは、 \fBopendir\fP(3)  が FIFO
267 やテープデバイスに対してコールされた場合の サービス不能 (denial\-of\-service) 攻撃を避けるために カーネル 2.1.126
268 で追加された。
269 .TP 
270 \fBO_DSYNC\fP
271 ファイルに対する書き込み操作は、同期 I/O の\fIデータ\fP完全性完了の要件に基づいて行われる。
272
273 \fBwrite\fP(2) (や同様のコール) が返るまでに、
274 書き込まれたデータおよびデータを取得するのに必要なファイルメタデータが裏で利用されているハードウェアに転送される (つまり、\fBwrite\fP(2)
275 の後に \fBfdatasync\fP(2) を呼び出したのと同じようになる)。 \fI下記の「注意」も参照のこと\fP。
276 .TP 
277 \fBO_EXCL\fP
278 この呼び出しでファイルが作成されることを保証する。このフラグが \fBO_CREAT\fP と
279 一緒に指定され、 \fIpathname\fP のファイルが既に存在した場合、 \fBopen\fP() は失敗
280 する。
281
282 .\" POSIX.1-2001 explicitly requires this behavior.
283 これら二つのフラグが指定された際、シンボリックリンクは辿られない。 \fIpathname\fP がシンボリックリンクの場合、
284 シンボリックリンクがどこを指しているかに関わらず \fBopen\fP()  は失敗する。
285
286 一般的には、 \fBO_CREAT\fP を指定せずに \fBO_EXCL\fP を使用した場合の
287 \fBO_EXCL\fP の動作は規定されていない。
288 これには一つ例外があり、Linux 2.6 以降では、
289 \fIpathname\fP がブロックデバイスを参照している場合、
290 \fBO_CREAT\fP なしで \fBO_EXCL\fP を使用することができる。
291 システムがそのブロックデバイスを使用中の場合 (例えば、
292 マウントされているなど)、 \fBopen\fP() はエラー \fBEBUSY\fP で失敗する。
293
294 NFS では、 \fBO_EXCL\fP は、Linux 2.6 以降で NFSv3 以降を使っている場合でのみサポートされる。 \fBO_EXCL\fP
295 サポートが提供されていない NFS 環境では、このフラグに頼って ロック処理を実行するプログラムは競合状態 (race condition) に出会う
296 可能性がある。 ロックファイルを使用して不可分 (atomic) なファイルロックを実現し、 NFS が \fBO_EXCL\fP
297 をサポートしているかに依存しないようにしたい場合、 移植性のある方法は、同じファイルシステム上に他と名前の重ならない ファイル (例えばホスト名と
298 PID を組み合わせた名前) を作成し、 \fBlink\fP(2)  を使用してそのロックファイルへのリンクを作成することである。 \fBlink\fP(2)
299 コールの返り値が 0 ならばロックに成功している。 あるいは、そのファイルに \fBstat\fP(2)  を使用してリンク数 (link count) が
300 2 になっているかをチェックする。 そうなっていれば、同じくロックに成功しているということである。
301 .TP 
302 \fBO_LARGEFILE\fP
303 (LFS) \fIoff_t\fP ではサイズを表せない (だだし \fIoff64_t\fP ではサイズを表せる)ファ
304 イルをオープン可能にする。この定義を有効にするためには、(\fIどの\fPヘッダファイ
305 ルをインクルードするよりも前に) \fB_LARGEFILE64_SOURCE\fP マクロを定義しなければ
306 ならない。
307 32 ビットシステムにおいて大きなファイルにアクセスしたい場合、
308 (\fBO_LARGEFILE\fP を使うよりも) \fB_FILE_OFFSET_BITS\fP 機能検査マクロを 64 に
309 セットする方が望ましい方法である (\fBfeature_test_macros\fP(7) を参照)。
310 .TP 
311 \fBO_NOATIME\fP (Linux 2.6.8 以降)
312 .\" The O_NOATIME flag also affects the treatment of st_atime
313 .\" by mmap() and readdir(2), MTK, Dec 04.
314 ファイルに対して \fBread\fP(2)  が実行されたときに、最終アクセス時刻 (inode の \fIst_atime\fP) を更新しない。
315 このフラグはインデックス作成やバックアッププログラムで使うことを意図している。 これを使うとディスクに対する操作を大幅に減らすことができる。
316 このフラグは全てのファイルシステムに対して有効であるわけではない。 その一例が NFS であり、サーバがアクセス時刻を管理している。
317 .TP 
318 \fBO_NOCTTY\fP
319 \fIpathname\fP が端末 (terminal) デバイス \(em \fBtty\fP(4) 参照 \(em を指している
320 場合に、たとえそのプロセスが制御端末を持っていなくても、オープンしたファイル
321 は制御端末にはならない。
322 .TP 
323 \fBO_NOFOLLOW\fP
324 .\" The headers from glibc 2.0.100 and later include a
325 .\" definition of this flag; \fIkernels before 2.1.126 will ignore it if
326 .\" used\fP.
327 \fIpathname\fP がシンボリックリンクだった場合、オープンは失敗する。 これは FreeBSD の拡張で、Linux には バージョン
328 2.1.126 で追加された。 このフラグが指定された場合でも \fIpathname\fP の前の方の要素 (最後のディレクトリセパレータより前の部分)
329 にあるシンボリックリンクについてはリンクが辿られる。 下記の \fBO_PATH\fP も参照のこと。
330 .TP 
331 \fBO_NONBLOCK\fP または \fBO_NDELAY\fP
332 可能ならば、ファイルは非停止 (nonblocking) モードでオープンされる。
333 \fBopen\fP() も、返したファイルディスクリプタに対する以後のすべての操作も呼び出
334 したプロセスを待たせることはない。 FIFO (名前付きパイプ) を扱う場合には
335 \fBfifo\fP(7) も参照すること。 強制ファイルロック (mandatory file lock) やファイ
336 ルリース (file lease) と組み合わせた場合の、 \fBO_NONBLOCK\fP の効果についての
337 議論は、 \fBfcntl\fP(2) を参照すること。
338 .TP 
339 \fBO_PATH\fP (Linux 2.6.39 以降)
340 .\" commit 1abf0c718f15a56a0a435588d1b104c7a37dc9bd
341 .\" commit 326be7b484843988afe57566b627fb7a70beac56
342 .\" commit 65cfc6722361570bfe255698d9cd4dccaf47570d
343 .\"
344 .\" http://thread.gmane.org/gmane.linux.man/2790/focus=3496
345 .\"     Subject: Re: [PATCH] open(2): document O_PATH
346 .\"     Newsgroups: gmane.linux.man, gmane.linux.kernel
347 .\"
348 このフラグを指定して取得したファイルディスクリプタは、 ファイルシステムツリー内での場所を示すため、
349 純粋にファイルディスクリプタレベルでの作用する操作を実行するため、 の二つの目的で使用することができる。 ファイル自身はオープンされず、
350 他のファイル操作 (例えば \fBread\fP(2), \fBwrite\fP(2), \fBfchmod\fP(2), \fBfchown\fP(2),
351 \fBfgetxattr\fP(2), \fBmmap\fP(2)) はエラー \fBEBADF\fP で失敗する。
352
353 取得したファイルディスクリプタに対して以下の操作を行うことが「できる」。
354 .RS
355 .IP * 3
356 .\" commit 332a2e1244bd08b9e3ecd378028513396a004a24
357 .\" fstat(): commit 55815f70147dcfa3ead5738fd56d3574e2e3c1c2
358 \fBclose\fP(2); \fBfchdir\fP(2)  (Linux 3.5 以降); \fBfstat\fP(2)  (Linux 3.6 以降)
359 .IP *
360 ファイルディスクリプタの複製 (\fBdup\fP(2), \fBfcntl\fP(2)  \fBF_DUPFD\fP など)
361 .IP *
362 ファイルディスクリプタフラグの取得と設定 (\fBfcntl\fP(2) の \fBF_GETFD\fP と \fBF_SETFD\fP)
363 .IP *
364 \fBfcntl\fP(2) の \fBF_GETFL\fP 操作を使ったオープンされたファイルの状態フラグの取得。 返されるフラグには \fBO_PATH\fP
365 ビットが含まれる。
366 .IP *
367 Passing the file descriptor as the \fIdirfd\fP argument of \fBopenat\fP(2)  and
368 the other "*at()" system calls.  This includes \fBlinkat\fP(2)  with
369 \fBAT_EMPTY_PATH\fP (or via procfs using \fBAT_SYMLINK_FOLLOW\fP)  even if the
370 file is not a directory.
371 .IP *
372 そのファイルディスクリプタを別のプロセスに UNIX ドメインソケット経由で渡す。 (\fBunix\fP(7) の \fBSCM_RIGHTS\fP を参照)
373 .RE
374 .IP
375 \fIflags\fP に \fBO_PATH\fP が指定された場合、 \fBO_DIRECTORY\fP と \fBO_NOFOLLOW\fP
376 以外のフラグビットは無視される。
377
378 \fIpathname\fP がシンボリックリンクで \fBO_NOFOLLOW\fP フラグも合わせて指定された場合、
379 この呼び出しではシンボリックリンクを参照するファイルディスクリプタを返す。 このファイルディスクリプタは、 空のパス名を指定した
380 \fBfchownat\fP(2), \fBfstatat\fP(2), \fBlinkat\fP(2), \fBreadlinkat\fP(2) の呼び出しで
381 \fIdirfd\fP 引数として使うことで、 そのシンボリックリンクに対して操作を行うことができる。
382 .TP 
383 \fBO_SYNC\fP
384 ファイルに対する書き込み操作は、同期 I/O の\fIファイル\fP完全性完了の要件に基づいて行われる (これに対し \fBO_DSYNC\fP では同期 I/O
385 の\fIデータ\fP完全性完了が提供される)。
386
387 \fBwrite\fP(2) (や同様のコール) が返るまでに、 書き込まれたデータと関連するファイルメタデータが裏で利用されているハードウェアに転送される
388 (つまり、\fBwrite\fP(2) の後に \fBfsync\fP(2) を呼び出したのと同じようになる)。 \fI下記の「注意」も参照のこと\fP。
389 .TP 
390 \fBO_TMPFILE\fP (Linux 3.11 以降)
391 .\" commit 60545d0d4610b02e55f65d141c95b18ccf855b6e
392 .\" commit f4e0c30c191f87851c4a53454abb55ee276f4a7e
393 .\" commit bb458c644a59dbba3a1fe59b27106c5e68e1c4bd
394 名前なしの一時ファイルを作成する。 \fIpathname\fP 引き数はディレクトリを指定する。 名前なしの inode
395 がそのディレクトリが存在するファイルシステムに作成される。 そのファイルに名前を付与しない限り、 作成されたファイルに書き込まれた内容は、
396 最後のファイルディスクリプタがクローズされる際に失われる。
397
398 \fBO_TMPFILE\fP は必ず \fBO_RDWR\fP か \fBO_WRONLY\fP のいずれかと一緒に使わなければならない。 \fBO_EXCL\fP
399 も指定することができる。 \fBO_EXCL\fP が指定されなかった場合、 \fBlinkat\fP(2)
400 を使って、そのファイルシステムにこの一時ファイルへのリンクを作成し、ファイルを永続化することができる。 以下のコードのようにすればよい。
401
402 .in +4n
403 .nf
404 char path[PATH_MAX];
405 fd = open("/path/to/dir", O_TMPFILE | O_RDWR,
406                         S_IRUSR | S_IWUSR);
407
408 /* 'fd' に対するファイル I/O ... */
409
410 snprintf(path, PATH_MAX,  "/proc/self/fd/%d", fd);
411 linkat(AT_FDCWD, path, AT_FDCWD, "/path/for/file",
412                         AT_SYMLINK_FOLLOW);
413 .fi
414 .in
415
416 この場合、 \fBopen\fP() の \fImode\fP 引き数は \fBO_CREAT\fP と同様にファイルのアクセス許可モードの決定に使われる。
417
418 \fBO_TMPFILE\fP とともに \fBO_EXCL\fP を指定すると、
419 一時ファイルに対して上記の方法でファイルシステムへのリンクを行うことができなくなる (この場合の \fBO_EXCL\fP の意味は他の場合の
420 \fBO_EXCL\fP の意味とは異なる点に注意)。
421
422
423 .\" Inspired by http://lwn.net/Articles/559147/
424 \fBO_TMPFILE\fP には主に二つの用途がある。
425 .RS
426 .IP * 3
427 改善された \fBtmpfile\fP(3) の機能: (1) クローズ時に自動的に削除される、 (2) パス名では決して参照できない、 (3)
428 シンボリックリンク攻撃ができない、 (4) 呼び出し元が一意な名前を考える必要がない、 という特長を持つ競合のない一時ファイルの作成。
429 .IP *
430 最初は見えないファイルを作成し、 それからデータを書き込んだり、適切なファイルシステム属性を持つように調整したり (\fBchown\fP(2),
431 \fBchmod\fP(2), \fBfsetxattr\fP(2) など) した後、 準備が全て整った状態で (上述の \fBlinkat\fP(2) を使って)
432 ファイルシステム内にアトミックにリンクを行う。
433 .RE
434 .IP
435 .\" commit 99b6436bc29e4f10e4388c27a3e4810191cc4788
436 .\" commit ab29743117f9f4c22ac44c13c1647fb24fb2bafe
437 \fBO_TMPFILE\fP は、 裏で利用されるファイルシステムによるサポートが必要である。 一部の Linux
438 ファイルシステムだけがこの機能をサポートしている。 最初の実装では、 ext2, ext3, ext4, UDF, Minix, shmem
439 ファイルシステムがサポートしていた。 XFS でのサポートが Linux 3.15 で追加された。
440 .TP 
441 \fBO_TRUNC\fP
442 ファイルが既に存在し、通常ファイルであり、 アクセスモードで書き込みが許可されている (つまり、 \fBO_RDWR\fP または \fBO_WRONLY\fP
443 の) 場合、長さ 0 に切り詰め (truncate) られる。 ファイルが FIFO または端末デバイスファイルの場合、 \fBO_TRUNC\fP
444 フラグは無視される。 それ以外の場合、 \fBO_TRUNC\fP の効果は未定義である。
445 .SS creat()
446 \fBcreat\fP()  は \fIflags\fP に \fBO_CREAT|O_WRONLY|O_TRUNC\fP を指定して \fBopen\fP()
447 を行うのと等価である。
448 .SS openat()
449 \fBopenat\fP() システムコールは \fBopen\fP() と全く同様に動作するが、以下で説明する点が異なる。
450
451 \fIpathname\fP で指定されたパス名が相対パスの場合、このパス名はファイルディスクリプター \fIdirfd\fP
452 が参照するディレクトリに対する相対パスと解釈される (\fBopen\fP()
453 に相対パス名を渡した場合のように、呼び出したプロセスのカレントワーキングディレクトリに対する相対パスではない)。
454
455 \fIpathname\fP で指定されたパス名が相対パスで、 \fIdirfd\fP が特別な値 \fBAT_FDCWD\fP の場合、 (\fBopen\fP()
456 と同様に) \fIpathname\fP は呼び出したプロセスのカレントワーキングディレクトリに対する相対パスと解釈される。
457
458 \fIpathname\fP で指定されたパス名が絶対パスの場合、 \fIdirfd\fP は無視される。
459 .SH 返り値
460 \fBopen\fP(), \fBopenat\fP(), \fBcreat\fP() は新しいファイルディスクリプタを返す。 エラーが発生した場合は \-1 を返す
461 (その場合は \fIerrno\fP が適切に設定される)。
462 .SH エラー
463 \fBopen\fP(), \fBopenat\fP(), \fBcreat\fP() は以下のエラーで失敗する。
464 .TP 
465 \fBEACCES\fP
466 ファイルに対する要求されたアクセスが許されていないか、 \fIpathname\fP のディレクトリ部分の何れかのディレクトリに検索許可がなかった。
467 またはファイルが存在せず、親ディレクトリへの書き込み許可がなかった。 (\fBpath_resolution\fP(7)  も参照すること。)
468 .TP 
469 \fBEDQUOT\fP
470 \fBO_CREAT\fP が指定された場合で、そのファイルが存在せず、ディスクブロックか inode がそのファイルシステムのユーザクォータに達していた。
471 .TP 
472 \fBEEXIST\fP
473 \fIpathname\fP は既に存在し、 \fBO_CREAT\fP と \fBO_EXCL\fP が使用された。
474 .TP 
475 \fBEFAULT\fP
476 \fIpathname\fP がアクセス可能なアドレス空間の外を指している。
477 .TP 
478 \fBEFBIG\fP
479 \fBEOVERFLOW\fP 参照。
480 .TP 
481 \fBEINTR\fP
482 遅いデバイス (例えば FIFO、 \fBfifo\fP(7)  参照) のオープンが完了するのを待って停止している間に
483 システムコールがシグナルハンドラにより割り込まれた。 \fBsignal\fP(7)  参照。
484 .TP 
485 \fBEINVAL\fP
486 ファイルシステムが \fBO_DIRECT\fP フラグをサポートしていない。 詳細は\fB注意\fPを参照。
487 .TP 
488 \fBEINVAL\fP
489 .\" In particular, __O_TMPFILE instead of O_TMPFILE
490 \fIflags\fP に無効な値が入っている。
491 .TP 
492 \fBEINVAL\fP
493 \fIflags\fP に \fBO_TMPFILE\fP が指定されたが、 \fBO_WRONLY\fP も \fBO_RDWR\fP も指定されていなかった。
494 .TP 
495 \fBEISDIR\fP
496 \fIpathname\fP はディレクトリを参照しており、書き込み要求が含まれていた (つまり \fBO_WRONLY\fP または \fBO_RDWR\fP
497 が設定されている)。
498 .TP 
499 \fBEISDIR\fP
500 \fIpathname\fP が存在するディレクトリを参照していて、 \fBO_TMPFILE\fP および \fBO_WRONLY\fP と \fBO_RDWR\fP
501 の一方が \fIflags\fP に指定されていたが、 このカーネルバージョンでは \fBO_TMPFILE\fP 機能が提供されていない。
502 .TP 
503 \fBELOOP\fP
504 \fIpathname\fP を解決する際に遭遇したシンボリックリンクが多過ぎる。
505 .TP 
506 \fBELOOP\fP
507 \fIpathname\fP がシンボリックリンクで、 \fIflags\fP に \fBO_NOFOLLOW\fP が指定されたが、 \fBO_PATH\fP
508 が指定されていなかった。
509 .TP 
510 \fBEMFILE\fP
511 プロセスがオープンしているファイル数がすでに最大数に達している。
512 .TP 
513 \fBENAMETOOLONG\fP
514 \fIpathname\fP が長過ぎる。
515 .TP 
516 \fBENFILE\fP
517 オープンされているファイルの総数がシステムの制限に達している。
518 .TP 
519 \fBENODEV\fP
520 \fIpathname\fP がデバイススペシャルファイルを参照しており、対応するデバイスが存在しない。 (これは Linux
521 カーネルのバグであり、この場合には \fBENXIO\fP が返されるべきである)
522 .TP 
523 \fBENOENT\fP
524 \fBO_CREAT\fP が設定されておらず、かつ指定されたファイルが存在しない。 または、 \fIpathname\fP のディレクトリ部分が存在しないか壊れた
525 (dangling) シンボリックリンクである。
526 .TP 
527 \fBENOENT\fP
528 \fIpathname\fP が存在しないディレクトリを参照していて、 \fBO_TMPFILE\fP および \fBO_WRONLY\fP と \fBO_RDWR\fP
529 の一方が \fIflags\fP に指定されていたが、 このカーネルバージョンでは \fBO_TMPFILE\fP 機能が提供されていない。
530 .TP 
531 \fBENOMEM\fP
532 十分なカーネルメモリーがない。
533 .TP 
534 \fBENOSPC\fP
535 \fIpathname\fP を作成する必要があるが、 \fIpathname\fP を含んでいるデバイスに新しいファイルのための空き容量がない。
536 .TP 
537 \fBENOTDIR\fP
538 \fIpathname\fP に含まれるディレクトリ部分のどれかが実際にはディレクトリでない。 または \fBO_DIRECTORY\fP が指定されており、
539 \fIpathname\fP がディレクトリでない。
540 .TP 
541 \fBENXIO\fP
542 \fBO_NONBLOCK\fP | \fBO_WRONLY\fP が設定されており、指定したファイルが FIFO で そのファイルを読み込み用でオープンしている
543 FIFO が存在しない。 または、ファイルがデバイススペシャルファイルで 対応するデバイスが存在しない。
544 .TP 
545 \fBEOPNOTSUPP\fP
546 \fIpathname\fP を含んでいるファイルシステムが \fBO_TMPFILE\fP をサポートしていない。
547 .TP 
548 \fBEOVERFLOW\fP
549 .\" See http://bugzilla.kernel.org/show_bug.cgi?id=7253
550 .\" "Open of a large file on 32-bit fails with EFBIG, should be EOVERFLOW"
551 .\" Reported 2006-10-03
552 \fIpathname\fP が参照しているのが、大き過ぎてオープンできない通常のファイルである。 通常、このエラーが発生するは、32
553 ビットプラットフォーム上で \fI\-D_FILE_OFFSET_BITS=64\fP を指定せずにコンパイルされたアプリケーションが、ファイルサイズが
554 \fI(2<31)\-1\fP ビットを超えるファイルを開こうとした場合である。 上記の \fBO_LARGEFILE\fP も参照。 これは
555 POSIX.1\-2001 で規定されているエラーである。 2.6.24 より前のカーネルでは、Linux はこの場合にエラー \fBEFBIG\fP
556 を返していた。
557 .TP 
558 \fBEPERM\fP
559 .\" Strictly speaking, it's the filesystem UID... (MTK)
560 \fBO_NOATIME\fP フラグが指定されたが、呼び出し元の実効ユーザー ID が ファイルの所有者と一致せず、かつ呼び出し元に特権
561 (\fBCAP_FOWNER\fP)  がない。
562 .TP 
563 \fBEROFS\fP
564 \fIpathname\fP が読み込み専用のファイルシステム上のファイルを参照しており、 書き込みアクセスが要求された。
565 .TP 
566 \fBETXTBSY\fP
567 \fIpathname\fP が現在実行中の実行イメージを参照しており、書き込みが要求された。
568 .TP 
569 \fBEWOULDBLOCK\fP
570 \fBO_NONBLOCK\fP フラグが指定されたが、そのファイルには矛盾するリースが設定されていた (\fBfcntl\fP(2)  参照)。
571 .PP
572 \fBopenat\fP() では以下のエラーも発生する。
573 .TP 
574 \fBEBADF\fP
575 \fIdirfd\fP が有効なファイルディスクリプタではない。
576 .TP 
577 \fBENOTDIR\fP
578 \fIpathname\fP が相対パス名で、 \fIdirfd\fP がディレクトリ以外のファイルを参照しているファイルディスクリプタである。
579 .SH バージョン
580 \fBopenat\fP()  はカーネル 2.6.16 で Linux に追加された。 ライブラリによるサポートはバージョン 2.4 で glibc
581 に追加された。
582 .SH 準拠
583 \fBopen\fP(), \fBcreat\fP()  SVr4, 4.3BSD, POSIX.1\-2001, POSIX.1\-2008.
584
585 \fBopenat\fP(): POSIX.1\-2008.
586
587 フラグ \fBO_DIRECT\fP, \fBO_NOATIME\fP, \fBO_PATH\fP, \fBO_TMPFILE\fP は Linux 特有のものである。
588 これらのフラグの定義を得るためには \fB_GNU_SOURCE\fP を定義しなければならない。
589
590 フラグ \fBO_CLOEXEC\fP, \fBO_DIRECTORY\fP, \fBO_NOFOLLOW\fP は POSIX.1\-2001 では規定されていないが、
591 POSIX.1\-2008 では規定されている。 glibc 2.12 以降では、これらの定義を得るには、 \fB_POSIX_C_SOURCE\fP を
592 200809L 以上の値で定義するか、 \fB_XOPEN_SOURCE\fP を 700 以上の値で定義する。 glibc 2.11 以前では、
593 これらの定義を得るには \fB_GNU_SOURCE\fP を定義する。
594
595 \fBfeature_test_macros\fP(7) に注意書きがあるように、 \fB_POSIX_C_SOURCE\fP, \fB_XOPEN_SOURCE\fP,
596 \fB_GNU_SOURCE\fP などの機能検査マクロは\fIどの\fPヘッダーファイルをインクルードするより前に定義しなければならない。
597 .SH 注意
598 Linux では、 \fBO_NONBLOCK\fP フラグは、 open を実行したいが read または write を実行する意図は
599 必ずしもないことを意味する。 これは \fBioctl\fP(2)  のためのファイルディスクリプタを取得するために、
600 デバイスをオープンするときによく用いられる。
601
602 .LP
603 .\" Linux 2.0, 2.5: truncate
604 .\" Solaris 5.7, 5.8: truncate
605 .\" Irix 6.5: truncate
606 .\" Tru64 5.1B: truncate
607 .\" HP-UX 11.22: truncate
608 .\" FreeBSD 4.7: truncate
609 \fBO_RDONLY | O_TRUNC\fP の影響は未定義であり、その動作は実装によって異なる。 多くのシステムではファイルは実際に切り詰められる。
610
611 \fBopen\fP()  はスペシャルファイルをオープンすることができるが、 \fBcreat\fP()  でスペシャルファイルを作成できない点に注意すること。
612 代わりに \fBmknod\fP(2)  を使用する。
613
614 .\"
615 .\"
616 ファイルが新しく作成されると、 ファイルの \fIst_atime\fP, \fIst_ctime\fP, \fIst_mtime\fP フィールド
617 (それぞれ最終アクセス時刻、最終状態変更時刻、最終修正時刻である。 \fBstat\fP(2)  参照) が現在時刻に設定される。 さらに親ディレクトリの
618 \fIst_ctime\fP と \fIst_mtime\fP も現在時刻に設定される。 それ以外の場合で、O_TRUNC フラグでファイルが修正されたときは、
619 ファイルの \fIst_ctime\fP と \fIst_mtime\fP フィールドが現在時刻に設定される。
620 .SS "同期 I/O"
621 POSIX.1\-2008 の「同期 I/O」の選択肢として複数種類が規定されており、 動作を制御するために \fBopen\fP() フラグとして
622 \fBO_SYNC\fP, \fBO_DSYNC\fP, \fBO_RSYNC\fP が規定されている。 この選択肢を実装がサポートしているかに関わらず、
623 各実装では少なくとも通常のファイルに対して \fBO_SYNC\fP が利用できなければならない。
624
625 Linux は \fBO_SYNC\fP と \fBO_DSYNC\fP を実装しているが、 \fBO_RSYNC\fP は実装していない (少し間違っているのだが、
626 glibc では \fBO_RSYNC\fP が \fBO_SYNC\fP と同じ値で定義されている)。
627
628 \fBO_SYNC\fP は、 同期 I/O での\fIファイル\fP完全性完了を提供する。 つまり、
629 書き込み操作はデータとすべての関連メタデータを裏で利用されているハードウェアにフラッシュすることを意味する。 \fBO_DSYNC\fP は、 同期 I/O
630 での\fIデータ\fP完全性完了を提供する。 つまり、 書き込み操作はデータを裏で利用されているハードウェアにフラッシュするが、
631 それ以降の読み出し操作が正常に完了するのに必要なメタデータの更新のみをフラッシュする。 データ完全性完了は、
632 ファイル完全性完了を必要としないアプリケーションで、 ディスク操作の数を減らすことができる。
633
634 2 種類の完了の違いを理解するために、 ファイルメタデータの 2 つの要素、 ファイルの最終修正時刻 (\fIst_mtime\fP)
635 とファイル長、を考える。 すべての書き込み操作は最終修正時刻を更新するが、 ファイルの末尾にデータを追加する書き込み操作のみがファイル長を変更する。
636 最終修正時刻は、 読み出しが正常に完了するのに必要ではないが、 ファイル長は必要である。 したがって、 \fBO_DSYNC\fP
637 はファイル長のメタデータの更新がフラッシュされることだけを保証する (これに対して \fBO_SYNC\fP
638 では最終修正時刻のメタデータも常にフラッシュされる)。
639
640 Linux 2.6.33 より前では、 Linux は \fBopen\fP() では \fBO_SYNC\fP フラグのみを実装していた。 しかしながら、
641 このフラグが指定された場合、 ほとんどのファイルシステムで提供されていたのは実際には同期 I/O での\fIデータ\fP完全性完了と等価なものであった
642 (つまり、 \fBO_SYNC\fP は実際には \fBO_DSYNC\fP と等価なものとして実装されていた)。
643
644 .\"
645 .\"
646 Linux 2.6.33 行こう では、 正しい \fBO_SYNC\fP のサポートが提供されている。 しかしながら、
647 バイナリレベルの後方互換性を保証するため、 \fBO_DSYNC\fP は以前の \fBO_SYNC\fP と同じ値で定義されており、 \fBO_SYNC\fP は
648 \fBO_DSYNC\fP フラグの値を含む新しい (2 ビットの) フラグ値として定義されている。 これにより、
649 新しいヘッダを使ってコンパイルされたアプリケーションで、 2.6.33 より前のカーネルで少なくとも \fBO_DSYNC\fP
650 の動作は同じになることが保証される。
651 .SS NFS
652 NFS を実現しているプロトコルには多くの不備があり、特に \fBO_SYNC\fP と \fBO_NDELAY\fP に影響する。
653
654 .\"
655 .\"
656 UID マッピングを使用している NFS ファイルシステムでは、 \fBopen\fP()  がファイルディスクリプタを返した場合でも \fBread\fP(2)
657 が \fBEACCES\fP で拒否される場合がある。 これはクライアントがアクセス許可のチェックを行って \fBopen\fP()
658 を実行するが、読み込みや書き込みの際には サーバーで UID マッピングが行われるためである。
659 .SS ファイルアクセスモード
660 「アクセスモード」の値 \fBO_RDONLY\fP, \fBO_WRONLY\fP, \fBO_RDWR\fP は、 \fIflags\fP
661 に指定できる他の値と違い、個々のビットを指定するものではなく、 これらの値は \fIflags\fP の下位 2 ビットを定義する。 \fBO_RDONLY\fP,
662 \fBO_WRONLY\fP, \fBO_RDWR\fP はそれぞれ 0, 1, 2 に定義されている。 言い換えると、 \fBO_RDONLY |
663 O_WRONLY\fP の組み合わせは論理的に間違いであり、確かに \fBO_RDWR\fP と同じ意味ではない。
664
665 .\" See for example util-linux's disk-utils/setfdprm.c
666 .\" For some background on access mode 3, see
667 .\" http://thread.gmane.org/gmane.linux.kernel/653123
668 .\" "[RFC] correct flags to f_mode conversion in __dentry_open"
669 .\" LKML, 12 Mar 2008
670 .\"
671 .\"
672 Linux では、特別な、非標準なアクセスモードとして 3 (バイナリでは 11) が 予約されており \fIflags\fP に指定できる。
673 このアクセスモードを指定すると、ファイルの読み出し/書き込み許可をチェックし、 読み出しにも書き込みにも使用できないディスクリプタを返す。
674 この非標準のアクセスモードはいくつかの Linux ドライバで、デバイス固有の \fBioctl\fP(2)
675 操作にのみ使用されるディスクリプタを返すために使われている。
676 .SS "openat() や他のディレクトリファイルディスクリプタ API の基本原理"
677 \fBopenat\fP() やディレクトリファイルディスクリプタを引き数を取る他のシステムコールやライブラリ関数 (\fBfaccessat\fP(2),
678 \fBfanotify_mark\fP(2), \fBfchmodat\fP(2), \fBfchownat\fP(2), \fBfstatat\fP(2),
679 \fBfutimesat\fP(2), \fBlinkat\fP(2), \fBmkdirat\fP(2), \fBmknodat\fP(2),
680 \fBname_to_handle_at\fP(2), \fBreadlinkat\fP(2), \fBrenameat\fP(2), \fBsymlinkat\fP(2),
681 \fBunlinkat\fP(2), \fButimensat\fP(2) \fBmkfifoat\fP(3), \fBscandirat\fP(3))
682 は二つの理由から用意されている。 ここでは、 \fBopenat\fP コールに関して説明するが、この基本原理は他のインターフェースでも同じである。
683
684 最初の理由として、 \fBopenat\fP() を使うと、 アプリケーションは、 カレントワーキングディレクトリ以外のディレクトリで \fBopen\fP()
685 を使ってファイルをオープンする際に起こり得る競合条件を避けることができる。 これらの競合条件は、 \fBopen\fP()
686 に渡されたディレクトリプレフィックスの構成要素が \fBopen\fP() の呼び出しと並行して変化する可能性があるという点に由来している。
687 このような競合条件は、 対象のディレクトリに対するファイルディスクリプタをオープンし、 それから \fBopenat\fP() の \fIdirfd\fP
688 引き数としてそのファイルディスクリプタを指定することで、 避けることができる。
689
690 .\"
691 .\"
692 二つ目として、 \fBopenat\fP() を使うと、アプリケーションが管理するファイルディスクリプタにより、
693 スレッド単位の「カレントワーキングディレクトリ」を実装することができる (この機能は、 \fI/proc/self/fd/dirfd\fP
694 を使った方法でも実現することができるが、 効率の面で落とる)。
695 .SS O_DIRECT
696 .LP
697 \fBO_DIRECT\fP フラグを使用する場合、ユーザ空間バッファの長さやアドレス、 I/O
698 のファイルオフセットに関してアラインメントの制限が課されることがある。 Linux では、アラインメントの制限はファイルシステムやカーネルのバージョンに
699 よって異なり、全く制限が存在しない場合もある。 しかしながら、現在のところ、指定されたファイルやファイルシステムに対して
700 こうした制限があるかを見つけるための、アプリケーション向けのインタフェースで ファイルシステム非依存のものは存在しない。
701 いくつかのファイルシステムでは、制限を確認するための独自のインタフェースが 提供されている。例えば、 \fBxfsctl\fP(3)  の
702 \fBXFS_IOC_DIOINFO\fP 命令である。
703 .LP
704 Under Linux 2.4, transfer sizes, and the alignment of the user buffer and
705 the file offset must all be multiples of the logical block size of the
706 filesystem.  Since Linux 2.6.0, alignment to the logical block size of the
707 underlying storage (typically 512 bytes) suffices.  The logical block size
708 can be determined using the \fBioctl\fP(2)  \fBBLKSSZGET\fP operation or from the
709 shell using the command:
710
711     blockdev \-\-getss
712 .LP
713 メモリバッファがプライベートマッピング (\fBmmap\fP(2) の \fBMAP_PRIVATE\fP
714 フラグで作成されたマッピング) の場合には、\fBO_DIRECT\fP I/O は
715 \fBfork\fP(2) システムコールと同時に決して実行すべきではない
716 (プライベートマッピングには、ヒープ領域に割り当てられたメモリや静的に
717 割り当てたバッファも含まれる)。非同期 I/O インターフェース (AIO) 経由
718 やプロセス内の他のスレッドから発行された、このような I/O は、
719 \fBfork\fP(2) が呼び出される前に完了されるべきである。
720 そうしなかった場合、データ破壊や、親プロセスや子プロセスでの予期しない
721 動作が起こる可能性がある。
722 \fBO_DIRECT\fP I/O 用のメモリバッファが \fBshmat\fP(2) や\fBMAP_SHARED\fP フラグ
723 付きの \fBmmap\fP(2) で作成された場合には、この制限はあてはまらない。
724 \fBmadvise\fP(2) でメモリバッファにアドバイス \fBMADV_DONTFORK\fP が設定され
725 ている場合にも、この制限はあてはまらない(\fBMADV_DONTFORK\fP はそのメモリ
726 バッファが \fBfork\fP(2) 後に子プロセスからは利用できないことを保証するも
727 のである)。
728 .LP
729 \fBO_DIRECT\fP フラグは SGI IRIX で導入された。SGI IRIX にも Linux 2.4 と同様の (ユーザーバッファの)
730 アラインメントの制限がある。 また、IRIX には適切な配置とサイズを取得するための \fBfcntl\fP(2)  コールがある。 FreeBSD 4.x
731 も同じ名前のフラグを導入したが、アラインメントの制限はない。
732 .LP
733 \fBO_DIRECT\fP が Linux でサポートされたのは、カーネルバージョン 2.4.10 である。 古い Linux
734 カーネルは、このフラグを単に無視する。 \fBO_DIRECT\fP フラグをサポートしていないファイルシステムもあり、その場合は、 \fBO_DIRECT\fP
735 を使用すると \fBopen\fP()  は \fBEINVAL\fP で失敗する。
736 .LP
737 アプリケーションは、同じファイル、 特に同じファイルの重複するバイト領域に対して、 \fBO_DIRECT\fP と通常の I/O
738 を混ぜて使うのは避けるべきである。 ファイルシステムがこのような状況において一貫性の問題を正しく 扱うことができる場合であっても、全体の I/O
739 スループットは どちらか一方を使用するときと比べて低速になるであろう。 同様に、アプリケーションは、同じファイルに対して \fBmmap\fP(2)  と直接
740 I/O (\fBO_DIRECT\fP)  を混ぜて使うのも避けるべきである。
741 .LP
742 NFS で \fBO_DIRECT\fP を使った場合の動作はローカルのファイルシステムの場合と違う。
743 古いカーネルや、ある種の設定でコンパイルされたカーネルは、 \fBO_DIRECT\fP と NFS の組み合わせをサポートしていないかもしれない。 NFS
744 プロトコル自体はサーバにフラグを渡す機能は持っていないので、 \fBO_DIRECT\fP I/O
745 はクライアント上のページキャッシュをバイパスするだけになり、 サーバは I/O をキャッシュしているかもしれない。 クライアントは、
746 \fBO_DIRECT\fP の同期機構を保持するため、サーバに対して I/O を同期して行うように依頼する。 サーバによっては、こうした状況下、特に I/O
747 サイズが小さい場合に 性能が大きく劣化する。 また、サーバによっては、I/O が安定したストレージにまで行われたと、
748 クライアントに対して嘘をつくものもある。 これは、サーバの電源故障が起こった際にデータの完全性が保たれない
749 危険は少しあるが、性能面での不利な条件を回避するために行われている。 Linux の NFS クライアントでは \fBO_DIRECT\fP I/O
750 でのアラインメントの制限はない。
751 .PP
752 まとめると、 \fBO_DIRECT\fP は、注意して使うべきであるが、強力なツールとなる可能性を持っている。 アプリケーションは \fBO_DIRECT\fP
753 をデフォルトでは無効になっている性能向上のためのオプションと 考えておくのがよいであろう。
754 .PP
755 .RS
756 「O_DIRECT でいつも困るのは、インタフェース全部が本当にお馬鹿な点だ。 たぶん危ないマインドコントロール剤で
757 頭がおかしくなったサルが設計したんじゃないかな」 \(em Linus
758 .RE
759 .SH バグ
760 .\" FIXME . Check bugzilla report on open(O_ASYNC)
761 .\" See http://bugzilla.kernel.org/show_bug.cgi?id=5993
762 現在のところ、 \fBopen\fP()  の呼び出し時に \fBO_ASYNC\fP を指定してシグナル駆動 I/O を有効にすることはできない。
763 このフラグを有効にするには \fBfcntl\fP(2)  を使用すること。
764
765 カーネルが \fBO_TMPFILE\fP 機能をサポートしているかを判定する際に、 \fBEISDIR\fP と \fBENOENT\fP の 2
766 つのエラーコードをチェックしなければならない。
767 .SH 関連項目
768 \fBchmod\fP(2), \fBchown\fP(2), \fBclose\fP(2), \fBdup\fP(2), \fBfcntl\fP(2), \fBlink\fP(2),
769 \fBlseek\fP(2), \fBmknod\fP(2), \fBmmap\fP(2), \fBmount\fP(2), \fBopen_by_handle_at\fP(2),
770 \fBread\fP(2), \fBsocket\fP(2), \fBstat\fP(2), \fBumask\fP(2), \fBunlink\fP(2),
771 \fBwrite\fP(2), \fBfopen\fP(3), \fBfifo\fP(7), \fBpath_resolution\fP(7), \fBsymlink\fP(7)
772 .SH この文書について
773 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.67 の一部
774 である。プロジェクトの説明とバグ報告に関する情報は
775 http://www.kernel.org/doc/man\-pages/ に書かれている。