OSDN Git Service

(split) LDP: Restore and add Copyrights for draft pages
[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 .\"
5 .\" %%%LICENSE_START(VERBATIM)
6 .\" Permission is granted to make and distribute verbatim copies of this
7 .\" manual provided the copyright notice and this permission notice are
8 .\" preserved on all copies.
9 .\"
10 .\" Permission is granted to copy and distribute modified versions of this
11 .\" manual under the conditions for verbatim copying, provided that the
12 .\" entire resulting derived work is distributed under the terms of a
13 .\" permission notice identical to this one.
14 .\"
15 .\" Since the Linux kernel and libraries are constantly changing, this
16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
17 .\" responsibility for errors or omissions, or for damages resulting from
18 .\" the use of the information contained herein.  The author(s) may not
19 .\" have taken the same level of care in the production of this manual,
20 .\" which is licensed free of charge, as they might when working
21 .\" professionally.
22 .\"
23 .\" Formatted or processed versions of this manual, if unaccompanied by
24 .\" the source, must acknowledge the copyright and authors of this work.
25 .\" %%%LICENSE_END
26 .\"
27 .\" Modified 1993-07-21 by Rik Faith <faith@cs.unc.edu>
28 .\" Modified 1994-08-21 by Michael Haardt
29 .\" Modified 1996-04-13 by Andries Brouwer <aeb@cwi.nl>
30 .\" Modified 1996-05-13 by Thomas Koenig
31 .\" Modified 1996-12-20 by Michael Haardt
32 .\" Modified 1999-02-19 by Andries Brouwer <aeb@cwi.nl>
33 .\" Modified 1998-11-28 by Joseph S. Myers <jsm28@hermes.cam.ac.uk>
34 .\" Modified 1999-06-03 by Michael Haardt
35 .\" Modified 2002-05-07 by Michael Kerrisk <mtk.manpages@gmail.com>
36 .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
37 .\" 2004-12-08, mtk, reordered flags list alphabetically
38 .\" 2004-12-08, Martin Pool <mbp@sourcefrog.net> (& mtk), added O_NOATIME
39 .\" 2007-09-18, mtk, Added description of O_CLOEXEC + other minor edits
40 .\" 2008-01-03, mtk, with input from Trond Myklebust
41 .\"     <trond.myklebust@fys.uio.no> and Timo Sirainen <tss@iki.fi>
42 .\"     Rewrite description of O_EXCL.
43 .\" 2008-01-11, Greg Banks <gnb@melbourne.sgi.com>: add more detail
44 .\"     on O_DIRECT.
45 .\" 2008-02-26, Michael Haardt: Reorganized text for O_CREAT and mode
46 .\"
47 .\" FIXME . Apr 08: The next POSIX revision has O_EXEC, O_SEARCH, and
48 .\" O_TTYINIT.  Eventually these may need to be documented.  --mtk
49 .\" FIXME Linux 2.6.33 has O_DSYNC, and a hidden __O_SYNC.
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 2013\-07\-21 Linux "Linux Programmer's Manual"
84 .SH 名前
85 open, 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 .fi
97 .SH 説明
98 ファイルの \fIpathname\fP を与えると、 \fBopen\fP()  はファイルディスクリプタを返す。
99 ファイルディスクリプタは、この後に続くシステムコール (\fBread\fP(2), \fBwrite\fP(2), \fBlseek\fP(2),
100 \fBfcntl\fP(2) など)  で使用される小さな非負の整数である。 このシステムコールが成功した場合に返されるファイルディスクリプタは
101 そのプロセスがその時点でオープンしていないファイルディスクリプタの うち最小の数字のものとなる。
102 .PP
103 デフォルトでは、新しいファイルディスクリプタは \fBexecve\fP(2) を実行した後も
104 オープンされたままとなる (つまり、 \fBfcntl\fP(2) に説明がある \fBFD_CLOEXEC\fP
105 ファイルディスクリプタフラグは最初は無効である; 後述の \fBO_CLOEXEC\fP フラグ
106 を使うとこのデフォルトを変更することができる)。 ファイルオフセット
107 (file offset) はファイルの先頭に設定される (\fBlseek\fP(2) 参照)。
108 .PP
109 \fBopen\fP()  を呼び出すと、「オープンファイル記述」 \fI(open file description)\fP
110 が作成される。ファイル記述とは、システム全体の オープン中のファイルのテーブルのエントリである。 このエントリは、ファイルオフセットとファイル状態フラグ
111 (\fBfcntl\fP(2)  \fBF_SETFL\fP 操作により変更可能) が保持する。 ファイルディスクリプタはこれらのエントリの一つへの参照である。
112 この後で \fIpathname\fP が削除されたり、他のファイルを参照するように変更されたりしても、 この参照は影響を受けない。
113 新しいオープンファイル記述は最初は他のどのプロセスとも 共有されていないが、 \fBfork\fP(2)  で共有が起こる場合がある。
114 .PP
115 引き数 \fIflags\fP には、アクセスモード \fBO_RDONLY\fP, \fBO_WRONLY\fP, \fBO_RDWR\fP
116 のどれかひとつが入っていなければならない。 これらはそれぞれ読み込み専用、書き込み専用、読み書き用に ファイルをオープンすることを要求するものである。
117
118 .\" SUSv4 divides the flags into:
119 .\" * Access mode
120 .\" * File creation
121 .\" * File status
122 .\" * Other (O_CLOEXEC, O_DIRECTORY, O_NOFOLLOW)
123 .\" though it's not clear what the difference between "other" and
124 .\" "File creation" flags is.  I raised an Aardvark to see if this
125 .\" can be clarified in SUSv4; 10 Oct 2008.
126 .\" http://thread.gmane.org/gmane.comp.standards.posix.austin.general/64/focus=67
127 .\" TC1 (balloted in 2013), resolved this, so that those three constants
128 .\" are also categorized" as file status flags.
129 .\"
130 さらに、 \fIflags\fP には、ファイル作成フラグ (file creation flag) とファイル状態フラグ (file status
131 flag) を 0 個以上「ビット単位の OR (bitwise\-or)」で 指定することができる。 \fIファイル作成フラグ\fP は
132 \fBO_CLOEXEC\fP, \fBO_CREAT\fP, \fBO_DIRECTORY\fP, \fBO_EXCL\fP, \fBO_NOCTTY\fP,
133 \fBO_NOFOLLOW\fP, \fBO_TRUNC\fP, \fBO_TTY_INIT\fP である。 \fIファイル状態フラグ\fP
134 は以下のリストのうち上記以外の残りのものである。 二種類のフラグの違いは、ファイル状態フラグの方は \fBfcntl\fP(2)
135 を使ってその内容を取得したり (場合によっては) 変更したりできる点にある。 ファイル作成フラグとファイル状態フラグの全リストを以下に示す:
136 .TP 
137 \fBO_APPEND\fP
138 .\" For more background, see
139 .\" http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=453946
140 .\" http://nfs.sourceforge.net/
141 ファイルを追加 (append) モードでオープンする。 毎回の \fBwrite\fP(2)  の前に \fBlseek\fP(2)
142 を行ったかのように、ファイルポインタをファイルの最後に移動する。 NFS ファイルシステムで、 \fBO_APPEND\fP
143 を使用すると、複数のプロセスがひとつのファイルに同時にデータを追加した場合、 ファイルが壊れてしまうことがある。 これは NFS
144 が追加モードをサポートしていないため、 クライアントのカーネル (kernel) がそれをシミュレートしなければならないのだが、
145 競合状態を避けることはできないからである。
146 .TP 
147 \fBO_ASYNC\fP
148 シグナル駆動 I/O (signal\-driven I/O) を有効にする: このファイルディスクリプタへの
149 入力または出力が可能になった場合に、シグナルを生成する (デフォルトは \fBSIGIO\fP であるが、 \fBfcntl\fP(2)
150 によって変更可能である)。 この機能が使用可能なのは端末、疑似端末、ソケットのみであり、 (Linux 2.6 以降では) パイプと FIFO
151 に対しても使用できる。 さらに詳しい説明は \fBfcntl\fP(2)  を参照すること。
152 .TP 
153 \fBO_CLOEXEC\fP (Linux 2.6.23 以降)
154 .\" This flag fixes only one form of the race condition;
155 .\" The race can also occur with, for example, descriptors
156 .\" returned by accept(), pipe(), etc.
157 新しいファイルディスクリプタに対して close\-on\-exec フラグを有効にする。 このフラグを指定することで、プログラムは
158 \fBFD_CLOEXEC\fP フラグをセットするための \fBfcntl\fP(2)  \fBF_SETFD\fP 操作を別途呼び出す必要がなくなる。
159 また、ある種のマルチスレッドのプログラムはこのフラグの使用は 不可欠である。なぜなら、個別に \fBFD_CLOEXEC\fP フラグを設定する
160 \fBfcntl\fP(2)  \fBF_SETFD\fP 操作を呼び出したとしても、あるスレッドがファイルディスクリプタを オープンするのと同時に別のスレッドが
161 \fBfork\fP(2)  と \fBexecve\fP(2)  を実行するという競合条件を避けるのには十分ではないからである。
162 .TP 
163 \fBO_CREAT\fP
164 .\" As at 2.6.25, bsdgroups is supported by ext2, ext3, ext4, and
165 .\" XFS (since 2.6.14).
166 ファイルが存在しなかった場合は作成 (create) する。 ファイルの所有者 (ユーザー ID) は、プロセスの実効ユーザー ID に設定される。
167 グループ所有権 (グループ ID) は、プロセスの実効グループ ID または親ディレクトリのグループ ID に設定される
168 (これは、ファイルシステムタイプ、マウントオプション、 親ディレクトリのモードに依存する。 \fBmount\fP(8)  で説明されているマウントオプション
169 \fIbsdgroups\fP と \fIsysvgroups\fP を参照)。
170 .RS
171 .PP
172 \fImode\fP は新しいファイルを作成する場合に使用するアクセス許可 (permission) を指定する。 \fIflags\fP に \fBO_CREAT\fP
173 が指定されている場合、 \fImode\fP を指定しなければならない。 \fBO_CREAT\fP が指定されていない場合、 \fImode\fP は無視される。
174 有効なアクセス許可は、普段と同じようにプロセスの \fIumask\fP によって修正され、作成されたファイルの許可は \fI(mode\ &\ ~umask)\fP となる。 このモードは、新しく作成されたファイルに対するそれ以降のアクセス にのみ適用される点に注意すること。
175 読み取り専用のファイルを作成する \fBopen\fP()  コールであっても、 読み書き可能なファイルディスクリプタを返すことがありうる。
176 .PP
177 \fImode\fP のために以下のシンボル定数が提供されている :
178 .TP  9
179 \fBS_IRWXU\fP
180 00700 ユーザー (ファイルの所有者) に読み込み、書き込み、 実行の許可がある。
181 .TP 
182 \fBS_IRUSR\fP
183 00400 ユーザーに読み込みの許可がある。
184 .TP 
185 \fBS_IWUSR\fP
186 00200 ユーザーに書き込みの許可がある。
187 .TP 
188 \fBS_IXUSR\fP
189 00100 ユーザーに実行の許可がある。
190 .TP 
191 \fBS_IRWXG\fP
192 00070 グループに読み込み、書き込み、実行の許可がある。
193 .TP 
194 \fBS_IRGRP\fP
195 00040 グループに読み込みの許可がある。
196 .TP 
197 \fBS_IWGRP\fP
198 00020 グループに書き込みの許可がある。
199 .TP 
200 \fBS_IXGRP\fP
201 00010 グループに実行の許可がある。
202 .TP 
203 \fBS_IRWXO\fP
204 00007 他人 (others) に読み込み、書き込み、実行の許可がある。
205 .TP 
206 \fBS_IROTH\fP
207 00004 他人に読み込みの許可がある。
208 .TP 
209 \fBS_IWOTH\fP
210 00002 他人に書き込みの許可がある。
211 .TP 
212 \fBS_IXOTH\fP
213 00001 他人に実行の許可がある。
214 .RE
215 .TP 
216 \fBO_DIRECT\fP (Linux 2.4.10 以降)
217 このファイルに対する I/O のキャッシュの効果を最小化しようとする。このフラグを使うと、一般的に性能が低下する。
218 しかしアプリケーションが独自にキャッシングを行っているような 特別な場合には役に立つ。 ファイルの I/O はユーザー空間バッファに対して直接行われる。
219 \fBO_DIRECT\fP フラグ自身はデータを同期で転送しようとはするが、 \fBO_SYNC\fP
220 フラグのようにデータと必要なメタデータの転送が保証されるわけではない。同期 I/O を保証するためには、 \fBO_DIRECT\fP に加えて
221 \fBO_SYNC\fP を使用しなければならない。下記の「注意」の節の議論も参照。
222 .sp
223 ブロックデバイスに対する似通った意味のインターフェースが \fBraw\fP(8)  で説明されている (但し、このインタフェースは非推奨である)。
224 .TP 
225 \fBO_DIRECTORY\fP
226 .\" But see the following and its replies:
227 .\" http://marc.theaimsgroup.com/?t=112748702800001&r=1&w=2
228 .\" [PATCH] open: O_DIRECTORY and O_CREAT together should fail
229 .\" O_DIRECTORY | O_CREAT causes O_DIRECTORY to be ignored.
230 \fIpathname\fP がディレクトリでなければオープンは失敗する。 このフラグは Linux 特有であり、 \fBopendir\fP(3)  が FIFO
231 やテープデバイスに対してコールされた場合の サービス不能 (denial\-of\-service) 攻撃を避けるために カーネル 2.1.126
232 で追加された。
233 .TP 
234 \fBO_EXCL\fP
235 この呼び出しでファイルが作成されることを保証する。このフラグが \fBO_CREAT\fP と
236 一緒に指定され、 \fIpathname\fP のファイルが既に存在した場合、 \fBopen\fP() は失敗
237 する。
238
239 .\" POSIX.1-2001 explicitly requires this behavior.
240 これら二つのフラグが指定された際、シンボリックリンクは辿られない。 \fIpathname\fP がシンボリックリンクの場合、
241 シンボリックリンクがどこを指しているかに関わらず \fBopen\fP()  は失敗する。
242
243 一般的には、 \fBO_CREAT\fP を指定せずに \fBO_EXCL\fP を使用した場合の
244 \fBO_EXCL\fP の動作は規定されていない。
245 これには一つ例外があり、Linux 2.6 以降では、
246 \fIpathname\fP がブロックデバイスを参照している場合、
247 \fBO_CREAT\fP なしで \fBO_EXCL\fP を使用することができる。
248 システムがそのブロックデバイスを使用中の場合 (例えば、
249 マウントされているなど)、 \fBopen\fP() はエラー \fBEBUSY\fP で失敗する。
250
251 NFS では、 \fBO_EXCL\fP は、Linux 2.6 以降で NFSv3 以降を使っている場合でのみサポートされる。 \fBO_EXCL\fP
252 サポートが提供されていない NFS 環境では、このフラグに頼って ロック処理を実行するプログラムは競合状態 (race condition) に出会う
253 可能性がある。 ロックファイルを使用して不可分 (atomic) なファイルロックを実現し、 NFS が \fBO_EXCL\fP
254 をサポートしているかに依存しないようにしたい場合、 移植性のある方法は、同じファイルシステム上に他と名前の重ならない ファイル (例えばホスト名と
255 PID を組み合わせた名前) を作成し、 \fBlink\fP(2)  を使用してそのロックファイルへのリンクを作成することである。 \fBlink\fP(2)
256 コールの返り値が 0 ならばロックに成功している。 あるいは、そのファイルに \fBstat\fP(2)  を使用してリンク数 (link count) が
257 2 になっているかをチェックする。 そうなっていれば、同じくロックに成功しているということである。
258 .TP 
259 \fBO_LARGEFILE\fP
260 (LFS) \fIoff_t\fP ではサイズを表せない (だだし \fIoff64_t\fP ではサイズを表せる)ファ
261 イルをオープン可能にする。この定義を有効にするためには、(\fIどの\fPヘッダファイ
262 ルをインクルードするよりも前に) \fB_LARGEFILE64_SOURCE\fP マクロを定義しなければ
263 ならない。
264 32 ビットシステムにおいて大きなファイルにアクセスしたい場合、
265 (\fBO_LARGEFILE\fP を使うよりも) \fB_FILE_OFFSET_BITS\fP 機能検査マクロを 64 に
266 セットする方が望ましい方法である (\fBfeature_test_macros\fP(7) を参照)。
267 .TP 
268 \fBO_NOATIME\fP (Linux 2.6.8 以降)
269 .\" The O_NOATIME flag also affects the treatment of st_atime
270 .\" by mmap() and readdir(2), MTK, Dec 04.
271 ファイルに対して \fBread\fP(2)  が実行されたときに、最終アクセス時刻 (inode の \fIst_atime\fP) を更新しない。
272 このフラグはインデックス作成やバックアッププログラムで使うことを意図している。 これを使うとディスクに対する操作を大幅に減らすことができる。
273 このフラグは全てのファイルシステムに対して有効であるわけではない。 その一例が NFS であり、サーバがアクセス時刻を管理している。
274 .TP 
275 \fBO_NOCTTY\fP
276 \fIpathname\fP が端末 (terminal) デバイス \(em \fBtty\fP(4) 参照 \(em を指している
277 場合に、たとえそのプロセスが制御端末を持っていなくても、オープンしたファイル
278 は制御端末にはならない。
279 .TP 
280 \fBO_NOFOLLOW\fP
281 .\" The headers from glibc 2.0.100 and later include a
282 .\" definition of this flag; \fIkernels before 2.1.126 will ignore it if
283 .\" used\fP.
284 \fIpathname\fP がシンボリックリンクだった場合、オープンは失敗する。 これは FreeBSD の拡張で、Linux には バージョン
285 2.1.126 で追加された。 このフラグが指定された場合でも \fIpathname\fP の前の方の要素 (最後のディレクトリセパレータより前の部分)
286 にあるシンボリックリンクについてはリンクが辿られる。 下記の \fBO_PATH\fP も参照のこと。
287 .TP 
288 \fBO_NONBLOCK\fP または \fBO_NDELAY\fP
289 可能ならば、ファイルは非停止 (nonblocking) モードでオープンされる。
290 \fBopen\fP() も、返したファイルディスクリプタに対する以後のすべての操作も呼び出
291 したプロセスを待たせることはない。 FIFO (名前付きパイプ) を扱う場合には
292 \fBfifo\fP(7) も参照すること。 強制ファイルロック (mandatory file lock) やファイ
293 ルリース (file lease) と組み合わせた場合の、 \fBO_NONBLOCK\fP の効果についての
294 議論は、 \fBfcntl\fP(2) を参照すること。
295 .TP 
296 \fBO_PATH\fP (Linux 2.6.39 以降)
297 .\" commit 1abf0c718f15a56a0a435588d1b104c7a37dc9bd
298 .\" commit 326be7b484843988afe57566b627fb7a70beac56
299 .\" commit 65cfc6722361570bfe255698d9cd4dccaf47570d
300 .\"
301 .\" http://thread.gmane.org/gmane.linux.man/2790/focus=3496
302 .\"     Subject: Re: [PATCH] open(2): document O_PATH
303 .\"     Newsgroups: gmane.linux.man, gmane.linux.kernel
304 .\"
305 Obtain a file descriptor that can be used for two purposes: to indicate a
306 location in the file\-system tree and to perform operations that act purely
307 at the file descriptor level.  The file itself is not opened, and other file
308 operations (e.g., \fBread\fP(2), \fBwrite\fP(2), \fBfchmod\fP(2), \fBfchown\fP(2),
309 \fBfgetxattr\fP(2))  fail with the error \fBEBADF\fP.
310
311 The following operations \fIcan\fP be performed on the resulting file
312 descriptor:
313 .RS
314 .IP * 3
315 .\" commit 332a2e1244bd08b9e3ecd378028513396a004a24
316 .\" fstat(): commit 55815f70147dcfa3ead5738fd56d3574e2e3c1c2
317 \fBclose\fP(2); \fBfchdir\fP(2)  (since Linux 3.5); \fBfstat\fP(2)  (since Linux
318 3.6).
319 .IP *
320 Duplicating the file descriptor (\fBdup\fP(2), \fBfcntl\fP(2)  \fBF_DUPFD\fP, etc.).
321 .IP *
322 Getting and setting file descriptor flags (\fBfcntl\fP(2)  \fBF_GETFD\fP and
323 \fBF_SETFD\fP).
324 .IP *
325 Retrieving open file status flags using the \fBfcntl\fP(2)  \fBF_GETFL\fP
326 operation: the returned flags will include the bit \fBO_PATH\fP.
327
328 .IP *
329 Passing the file descriptor as the \fIdirfd\fP argument of \fBopenat\fP(2)  and
330 the other "*at()" system calls.
331 .IP *
332 Passing the file descriptor to another process via a UNIX domain socket (see
333 \fBSCM_RIGHTS\fP in \fBunix\fP(7)).
334 .RE
335 .IP
336 When \fBO_PATH\fP is specified in \fIflags\fP, flag bits other than \fBO_DIRECTORY\fP
337 and \fBO_NOFOLLOW\fP are ignored.
338
339 If the \fBO_NOFOLLOW\fP flag is also specified, then the call returns a file
340 descriptor referring to the symbolic link.  This file descriptor can be used
341 as the \fIdirfd\fP argument in calls to \fBfchownat\fP(2), \fBfstatat\fP(2),
342 \fBlinkat\fP(2), and \fBreadlinkat\fP(2)  with an empty pathname to have the calls
343 operate on the symbolic link.
344 .TP 
345 \fBO_SYNC\fP
346 ファイルは同期 (synchronous) I/O モードでオープンされる。 \fBopen\fP()  が返したファイルディスクリプタに対して
347 \fBwrite\fP(2)  を行うと、必ず呼び出したプロセスをブロックし、 該当ハードウェアに物理的に書き込まれるまで返らない。
348 \fI以下の「注意」の章も参照。\fP
349 .TP 
350 \fBO_TRUNC\fP
351 ファイルが既に存在し、通常ファイルであり、 書き込み可モードでオープンされている (つまり、 \fBO_RDWR\fPまたは\fBO_WRONLY\fP の)
352 場合、長さ 0 に切り詰め (truncate) られる。 ファイルが FIFO または端末デバイスファイルの場合、 \fBO_TRUNC\fP
353 フラグは無視される。 それ以外の場合、 \fBO_TRUNC\fP の効果は未定義である。
354 .PP
355 これらの選択フラグのいくつかはファイルをオープンした後でも \fBfcntl\fP(2)  を使用して変更することができる。
356
357 \fBcreat\fP()  は \fIflags\fP に \fBO_CREAT|O_WRONLY|O_TRUNC\fP を指定して \fBopen\fP()
358 を行うのと等価である。
359 .SH 返り値
360 \fBopen\fP()  と \fBcreat\fP()  は新しいファイルディスクリプタを返す。 エラーが発生した場合は \-1 を返す (その場合は
361 \fIerrno\fP が適切に設定される)。
362 .SH エラー
363 .TP 
364 \fBEACCES\fP
365 ファイルに対する要求されたアクセスが許されていないか、 \fIpathname\fP のディレクトリ部分の何れかのディレクトリに検索許可がなかった。
366 またはファイルが存在せず、親ディレクトリへの書き込み許可がなかった。 (\fBpath_resolution\fP(7)  も参照すること。)
367 .TP 
368 \fBEDQUOT\fP
369 \fBO_CREAT\fP が指定された場合で、そのファイルが存在せず、ディスクブロックか inode がそのファイルシステムのユーザクォータに達していた。
370 .TP 
371 \fBEEXIST\fP
372 \fIpathname\fP は既に存在し、 \fBO_CREAT\fP と \fBO_EXCL\fP が使用された。
373 .TP 
374 \fBEFAULT\fP
375 \fIpathname\fP がアクセス可能なアドレス空間の外を指している。
376 .TP 
377 \fBEFBIG\fP
378 \fBEOVERFLOW\fP 参照。
379 .TP 
380 \fBEINTR\fP
381 遅いデバイス (例えば FIFO、 \fBfifo\fP(7)  参照) のオープンが完了するのを待って停止している間に
382 システムコールがシグナルハンドラにより割り込まれた。 \fBsignal\fP(7)  参照。
383 .TP 
384 \fBEISDIR\fP
385 \fIpathname\fP はディレクトリを参照しており、書き込み要求が含まれていた (つまり \fBO_WRONLY\fP または \fBO_RDWR\fP
386 が設定されている)。
387 .TP 
388 \fBELOOP\fP
389 \fIpathname\fP を解決する際に遭遇したシンボリックリンクが多過ぎる。 または \fBO_NOFOLLOW\fP が指定されており、
390 \fIpathname\fP がシンボリックリンクだった。
391 .TP 
392 \fBEMFILE\fP
393 プロセスがオープンしているファイル数がすでに最大数に達している。
394 .TP 
395 \fBENAMETOOLONG\fP
396 \fIpathname\fP が長過ぎる。
397 .TP 
398 \fBENFILE\fP
399 オープンされているファイルの総数がシステムの制限に達している。
400 .TP 
401 \fBENODEV\fP
402 \fIpathname\fP がデバイススペシャルファイルを参照しており、対応するデバイスが存在しない。 (これは Linux
403 カーネルのバグであり、この場合には \fBENXIO\fP が返されるべきである)
404 .TP 
405 \fBENOENT\fP
406 \fBO_CREAT\fP が設定されておらず、かつ指定されたファイルが存在しない。 または、 \fIpathname\fP のディレクトリ部分が存在しないか壊れた
407 (dangling) シンボリックリンクである。
408 .TP 
409 \fBENOMEM\fP
410 十分なカーネルメモリーがない。
411 .TP 
412 \fBENOSPC\fP
413 \fIpathname\fP を作成する必要があるが、 \fIpathname\fP を含んでいるデバイスに新しいファイルのための空き容量がない。
414 .TP 
415 \fBENOTDIR\fP
416 \fIpathname\fP に含まれるディレクトリ部分のどれかが実際にはディレクトリでない。 または \fBO_DIRECTORY\fP が指定されており、
417 \fIpathname\fP がディレクトリでない。
418 .TP 
419 \fBENXIO\fP
420 \fBO_NONBLOCK\fP | \fBO_WRONLY\fP が設定されており、指定したファイルが FIFO で
421 そのファイルを読み込みのためにオープンしているプロセスが存在しない。 または、ファイルがデバイススペシャルファイルで 対応するデバイスが存在しない。
422 .TP 
423 \fBEOVERFLOW\fP
424 .\" See http://bugzilla.kernel.org/show_bug.cgi?id=7253
425 .\" "Open of a large file on 32-bit fails with EFBIG, should be EOVERFLOW"
426 .\" Reported 2006-10-03
427 \fIpathname\fP が参照しているのが、大き過ぎてオープンできない通常のファイルである。 通常、このエラーが発生するは、32
428 ビットプラットフォーム上で \fI\-D_FILE_OFFSET_BITS=64\fP を指定せずにコンパイルされたアプリケーションが、ファイルサイズが
429 \fI(2<31)\-1\fP ビットを超えるファイルを開こうとした場合である。 上記の \fBO_LARGEFILE\fP も参照。 これは
430 POSIX.1\-2001 で規定されているエラーである。 2.6.24 より前のカーネルでは、Linux はこの場合にエラー \fBEFBIG\fP
431 を返していた。
432 .TP 
433 \fBEPERM\fP
434 .\" Strictly speaking, it's the file system UID... (MTK)
435 \fBO_NOATIME\fP フラグが指定されたが、呼び出し元の実効ユーザー ID が ファイルの所有者と一致せず、かつ呼び出し元に特権
436 (\fBCAP_FOWNER\fP)  がない。
437 .TP 
438 \fBEROFS\fP
439 \fIpathname\fP が読み込み専用のファイルシステム上のファイルを参照しており、 書き込みアクセスが要求された。
440 .TP 
441 \fBETXTBSY\fP
442 \fIpathname\fP が現在実行中の実行イメージを参照しており、書き込みが要求された。
443 .TP 
444 \fBEWOULDBLOCK\fP
445 \fBO_NONBLOCK\fP フラグが指定されたが、そのファイルには矛盾するリースが設定されていた (\fBfcntl\fP(2)  参照)。
446 .SH 準拠
447 SVr4, 4.3BSD, POSIX.1\-2001.  フラグ \fBO_DIRECTORY\fP, \fBO_NOATIME\fP,
448 \fBO_NOFOLLOW\fP, \fBO_PATH\fP は Linux 特有のものであり、 これらのフラグの定義を得るためには、
449 (「どの」ヘッダファイルをインクルードするよりも前に)  \fB_GNU_SOURCE\fP を定義する必要があるかもしれない。
450
451 \fBO_CLOEXEC\fP フラグは POSIX.1\-2001 では規定されていないが、 POSIX.1\-2008 で規定されている。
452
453 \fBO_DIRECT\fP は POSIX では規定されていない。 \fBO_DIRECT\fP の定義を得るには
454 (「どの」ヘッダファイルをインクルードするよりも前に)  \fB_GNU_SOURCE\fP を定義しなければならない。
455 .SH 注意
456 Linux では、 \fBO_NONBLOCK\fP フラグは、 open を実行したいが read または write を実行する意図は
457 必ずしもないことを意味する。 これは \fBioctl\fP(2)  のためのファイルディスクリプタを取得するために、
458 デバイスをオープンするときによく用いられる。
459
460 .\" See for example util-linux's disk-utils/setfdprm.c
461 .\" For some background on access mode 3, see
462 .\" http://thread.gmane.org/gmane.linux.kernel/653123
463 .\" "[RFC] correct flags to f_mode conversion in __dentry_open"
464 .\" LKML, 12 Mar 2008
465 「アクセスモード」の値 \fBO_RDONLY\fP, \fBO_WRONLY\fP, \fBO_RDWR\fP は、 \fIflags\fP
466 に指定できる他の値と違い、個々のビットを指定するものではなく、 これらの値は \fIflags\fP の下位 2 ビットを定義する。 \fBO_RDONLY\fP,
467 \fBO_WRONLY\fP, \fBO_RDWR\fP はそれぞれ 0, 1, 2 に定義されている。 言い換えると、 \fBO_RDONLY |
468 O_WRONLY\fP の組み合わせは論理的に間違いであり、確かに \fBO_RDWR\fP と同じ意味ではない。 Linux
469 では、特別な、非標準なアクセスモードとして 3 (バイナリでは 11) が 予約されており \fIflags\fP に指定できる。
470 このアクセスモードを指定すると、ファイルの読み出し/書き込み許可をチェックし、 読み出しにも書き込みにも使用できないディスクリプタを返す。
471 この非標準のアクセスモードはいくつかの Linux ドライバで、デバイス固有の \fBioctl\fP(2)
472 操作にのみ使用されるディスクリプタを返すために使われている。
473 .LP
474 .\" Linux 2.0, 2.5: truncate
475 .\" Solaris 5.7, 5.8: truncate
476 .\" Irix 6.5: truncate
477 .\" Tru64 5.1B: truncate
478 .\" HP-UX 11.22: truncate
479 .\" FreeBSD 4.7: truncate
480 \fBO_RDONLY | O_TRUNC\fP の影響は未定義であり、その動作は実装によって異なる。 多くのシステムではファイルは実際に切り詰められる。
481 .PP
482 NFS を実現しているプロトコルには多くの不備があり、特に \fBO_SYNC\fP と \fBO_NDELAY\fP に影響する。
483
484 POSIX では、3 種類の同期 I/O が提供されており、 \fBO_SYNC\fP, \fBO_DSYNC\fP, \fBO_RSYNC\fP
485 フラグがこれに対応するものである。 今のところ (カーネル 2.6.31)、 Linux では \fBO_SYNC\fP だけが実装されているが、 glibc
486 は \fBO_DSYNC\fP と \fBO_RSYNC\fP に \fBO_SYNC\fP と同じ数値を割り当てている。 ほとんどの Linux
487 のファイルシステムは、実際には POSIX の \fBO_SYNC\fP の動作ではなく \fBO_DSYNC\fP の動作だけを実装している。 POSIX の
488 \fBO_SYNC\fP では、 \fBopen\fP()  がユーザ空間に返る際に、書き込みに関する全てのメタデータの
489 更新がディスクに書き込まれている必要がある。 一方、 \fBO_DSYNC\fP では、 \fBopen\fP()
490 が返るまでに、実際のファイルのデータとそのデータを取得するために 必要なメタデータだけがディスクに書き込まれていればよい。
491
492 \fBopen\fP()  はスペシャルファイルをオープンすることができるが、 \fBcreat\fP()  でスペシャルファイルを作成できない点に注意すること。
493 代わりに \fBmknod\fP(2)  を使用する。
494 .LP
495 UID マッピングを使用している NFS ファイルシステムでは、 \fBopen\fP()  がファイルディスクリプタを返した場合でも \fBread\fP(2)
496 が \fBEACCES\fP で拒否される場合がある。 これはクライアントがアクセス許可のチェックを行って \fBopen\fP()
497 を実行するが、読み込みや書き込みの際には サーバーで UID マッピングが行われるためである。
498
499 ファイルが新しく作成されると、 ファイルの \fIst_atime\fP, \fIst_ctime\fP, \fIst_mtime\fP フィールド
500 (それぞれ最終アクセス時刻、最終状態変更時刻、最終修正時刻である。 \fBstat\fP(2)  参照) が現在時刻に設定される。 さらに親ディレクトリの
501 \fIst_ctime\fP と \fIst_mtime\fP も現在時刻に設定される。 それ以外の場合で、O_TRUNC フラグでファイルが修正されたときは、
502 ファイルの \fIst_ctime\fP と \fIst_mtime\fP フィールドが現在時刻に設定される。
503 .SS O_DIRECT
504 .LP
505 \fBO_DIRECT\fP フラグを使用する場合、ユーザ空間バッファの長さやアドレス、 I/O
506 のファイルオフセットに関してアラインメントの制限が課されることがある。 Linux では、アラインメントの制限はファイルシステムやカーネルのバージョンに
507 よって異なり、全く制限が存在しない場合もある。 しかしながら、現在のところ、指定されたファイルやファイルシステムに対して
508 こうした制限があるかを見つけるための、アプリケーション向けのインタフェースで ファイルシステム非依存のものは存在しない。
509 いくつかのファイルシステムでは、制限を確認するための独自のインタフェースが 提供されている。例えば、 \fBxfsctl\fP(3)  の
510 \fBXFS_IOC_DIOINFO\fP 命令である。
511 .LP
512 Linux 2.4 では、転送サイズ、 ユーザーバッファのアラインメント、ファイルオフセットは、
513 ファイルシステムの論理ブロックサイズの倍数でなければならない。 Linux 2.6 では、512 バイトごとの境界に配置されていれば充分である。
514 .LP
515 メモリバッファがプライベートマッピング (\fBmmap\fP(2) の \fBMAP_PRIVATE\fP
516 フラグで作成されたマッピング) の場合には、\fBO_DIRECT\fP I/O は
517 \fBfork\fP(2) システムコールと同時に決して実行すべきではない
518 (プライベートマッピングには、ヒープ領域に割り当てられたメモリや静的に
519 割り当てたバッファも含まれる)。非同期 I/O インターフェース (AIO) 経由
520 やプロセス内の他のスレッドから発行された、このような I/O は、
521 \fBfork\fP(2) が呼び出される前に完了されるべきである。
522 そうしなかった場合、データ破壊や、親プロセスや子プロセスでの予期しない
523 動作が起こる可能性がある。
524 \fBO_DIRECT\fP I/O 用のメモリバッファが \fBshmat\fP(2) や\fBMAP_SHARED\fP フラグ
525 付きの \fBmmap\fP(2) で作成された場合には、この制限はあてはまらない。
526 \fBmadvise\fP(2) でメモリバッファにアドバイス \fBMADV_DONTFORK\fP が設定され
527 ている場合にも、この制限はあてはまらない(\fBMADV_DONTFORK\fP はそのメモリ
528 バッファが \fBfork\fP(2) 後に子プロセスからは利用できないことを保証するも
529 のである)。
530 .LP
531 \fBO_DIRECT\fP フラグは SGI IRIX で導入された。SGI IRIX にも Linux 2.4 と同様の (ユーザーバッファの)
532 アラインメントの制限がある。 また、IRIX には適切な配置とサイズを取得するための \fBfcntl\fP(2)  コールがある。 FreeBSD 4.x
533 も同じ名前のフラグを導入したが、アラインメントの制限はない。
534 .LP
535 \fBO_DIRECT\fP が Linux でサポートされたのは、カーネルバージョン 2.4.10 である。 古い Linux
536 カーネルは、このフラグを単に無視する。 \fBO_DIRECT\fP フラグをサポートしていないファイルシステムもあり、その場合は、 \fBO_DIRECT\fP
537 を使用すると \fBopen\fP()  は \fBEINVAL\fP で失敗する。
538 .LP
539 アプリケーションは、同じファイル、 特に同じファイルの重複するバイト領域に対して、 \fBO_DIRECT\fP と通常の I/O
540 を混ぜて使うのは避けるべきである。 ファイルシステムがこのような状況において一貫性の問題を正しく 扱うことができる場合であっても、全体の I/O
541 スループットは どちらか一方を使用するときと比べて低速になるであろう。 同様に、アプリケーションは、同じファイルに対して \fBmmap\fP(2)  と直接
542 I/O (\fBO_DIRECT\fP)  を混ぜて使うのも避けるべきである。
543 .LP
544 NFS で \fBO_DIRECT\fP を使った場合の動作はローカルのファイルシステムの場合と違う。
545 古いカーネルや、ある種の設定でコンパイルされたカーネルは、 \fBO_DIRECT\fP と NFS の組み合わせをサポートしていないかもしれない。 NFS
546 プロトコル自体はサーバにフラグを渡す機能は持っていないので、 \fBO_DIRECT\fP I/O
547 はクライアント上のページキャッシュをバイパスするだけになり、 サーバは I/O をキャッシュしているかもしれない。 クライアントは、
548 \fBO_DIRECT\fP の同期機構を保持するため、サーバに対して I/O を同期して行うように依頼する。 サーバによっては、こうした状況下、特に I/O
549 サイズが小さい場合に 性能が大きく劣化する。 また、サーバによっては、I/O が安定したストレージにまで行われたと、
550 クライアントに対して嘘をつくものもある。 これは、サーバの電源故障が起こった際にデータの完全性が保たれない
551 危険は少しあるが、性能面での不利な条件を回避するために行われている。 Linux の NFS クライアントでは \fBO_DIRECT\fP I/O
552 でのアラインメントの制限はない。
553 .PP
554 まとめると、 \fBO_DIRECT\fP は、注意して使うべきであるが、強力なツールとなる可能性を持っている。 アプリケーションは \fBO_DIRECT\fP
555 をデフォルトでは無効になっている性能向上のためのオプションと 考えておくのがよいであろう。
556 .PP
557 .RS
558 「O_DIRECT でいつも困るのは、インタフェース全部が本当にお馬鹿な点だ。 たぶん危ないマインドコントロール剤で
559 頭がおかしくなったサルが設計したんじゃないかな」 \(em Linus
560 .RE
561 .SH バグ
562 .\" FIXME . Check bugzilla report on open(O_ASYNC)
563 .\" See http://bugzilla.kernel.org/show_bug.cgi?id=5993
564 現在のところ、 \fBopen\fP()  の呼び出し時に \fBO_ASYNC\fP を指定してシグナル駆動 I/O を有効にすることはできない。
565 このフラグを有効にするには \fBfcntl\fP(2)  を使用すること。
566 .SH 関連項目
567 \fBchmod\fP(2), \fBchown\fP(2), \fBclose\fP(2), \fBdup\fP(2), \fBfcntl\fP(2), \fBlink\fP(2),
568 \fBlseek\fP(2), \fBmknod\fP(2), \fBmmap\fP(2), \fBmount\fP(2), \fBopenat\fP(2), \fBread\fP(2),
569 \fBsocket\fP(2), \fBstat\fP(2), \fBumask\fP(2), \fBunlink\fP(2), \fBwrite\fP(2),
570 \fBfopen\fP(3), \fBfifo\fP(7), \fBpath_resolution\fP(7), \fBsymlink\fP(7)
571 .SH この文書について
572 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
573 である。プロジェクトの説明とバグ報告に関する情報は
574 http://www.kernel.org/doc/man\-pages/ に書かれている。