]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Hey Emacs! This file is -*- nroff -*- source. |
2 | .\" | |
3 | .\" This manpage is Copyright (C) 1992 Drew Eckhardt; | |
4 | .\" 1993 Michael Haardt, Ian Jackson. | |
ddc4d339 | 5 | .\" 2008 Greg Banks |
fea681da MK |
6 | .\" |
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. | |
c13182ef | 15 | .\" |
fea681da MK |
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. | |
c13182ef | 23 | .\" |
fea681da MK |
24 | .\" Formatted or processed versions of this manual, if unaccompanied by |
25 | .\" the source, must acknowledge the copyright and authors of this work. | |
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 | |
c11b1abf MK |
35 | .\" Modified 2002-05-07 by Michael Kerrisk <mtk.manpages@gmail.com> |
36 | .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com> | |
1c1e15ed MK |
37 | .\" 2004-12-08, mtk, reordered flags list alphabetically |
38 | .\" 2004-12-08, Martin Pool <mbp@sourcefrog.net> (& mtk), added O_NOATIME | |
fe75ec04 | 39 | .\" 2007-09-18, mtk, Added description of O_CLOEXEC + other minor edits |
447bb15e | 40 | .\" 2008-01-03, mtk, with input from Trond Myklebust |
f4b9d6a5 MK |
41 | .\" <trond.myklebust@fys.uio.no> and Timo Sirainen <tss@iki.fi> |
42 | .\" Rewrite description of O_EXCL. | |
ddc4d339 MK |
43 | .\" 2008-01-11, Greg Banks <gnb@melbourne.sgi.com>: add more detail |
44 | .\" on O_DIRECT. | |
d77eb764 | 45 | .\" 2008-02-26, Michael Haardt: Reorganized text for O_CREAT and mode |
fea681da | 46 | .\" |
61b7c1e1 | 47 | .\" FIXME . Apr 08: The next POSIX revision has O_EXEC, O_SEARCH, and |
9f91e36c | 48 | .\" O_TTYINIT. Eventually these may need to be documented. --mtk |
803e1d2f | 49 | .\" FIXME Linux 2.6.33 has O_DSYNC, and a hidden __O_SYNC. |
54903f5e | 50 | .\" FIXME: Linux 2.6.39 added O_PATH |
9f91e36c | 51 | .\" |
fd3ac440 | 52 | .TH OPEN 2 2011-09-08 "Linux" "Linux Programmer's Manual" |
fea681da MK |
53 | .SH NAME |
54 | open, creat \- open and possibly create a file or device | |
55 | .SH SYNOPSIS | |
56 | .nf | |
57 | .B #include <sys/types.h> | |
58 | .B #include <sys/stat.h> | |
59 | .B #include <fcntl.h> | |
60 | .sp | |
61 | .BI "int open(const char *" pathname ", int " flags ); | |
62 | .BI "int open(const char *" pathname ", int " flags ", mode_t " mode ); | |
5895e7eb | 63 | |
fea681da MK |
64 | .BI "int creat(const char *" pathname ", mode_t " mode ); |
65 | .fi | |
66 | .SH DESCRIPTION | |
e366dbc4 | 67 | Given a |
0daa9e92 | 68 | .I pathname |
e366dbc4 | 69 | for a file, |
1f6ceb40 | 70 | .BR open () |
2fda57bd | 71 | returns a file descriptor, a small, nonnegative integer |
e366dbc4 MK |
72 | for use in subsequent system calls |
73 | .RB ( read "(2), " write "(2), " lseek "(2), " fcntl "(2), etc.)." | |
74 | The file descriptor returned by a successful call will be | |
2c4bff36 | 75 | the lowest-numbered file descriptor not currently open for the process. |
e366dbc4 | 76 | .PP |
fe75ec04 | 77 | By default, the new file descriptor is set to remain open across an |
e366dbc4 | 78 | .BR execve (2) |
1f6ceb40 MK |
79 | (i.e., the |
80 | .B FD_CLOEXEC | |
81 | file descriptor flag described in | |
82 | .BR fcntl (2) | |
fd3ac440 | 83 | is initially disabled; the |
fe75ec04 MK |
84 | .B O_CLOEXEC |
85 | flag, described below, can be used to change this default). | |
1f6ceb40 | 86 | The file offset is set to the beginning of the file (see |
c13182ef | 87 | .BR lseek (2)). |
e366dbc4 MK |
88 | .PP |
89 | A call to | |
90 | .BR open () | |
91 | creates a new | |
92 | .IR "open file description" , | |
93 | an entry in the system-wide table of open files. | |
e366dbc4 MK |
94 | This entry records the file offset and the file status flags |
95 | (modifiable via the | |
0bfa087b | 96 | .BR fcntl (2) |
e366dbc4 MK |
97 | .B F_SETFL |
98 | operation). | |
2c4bff36 MK |
99 | A file descriptor is a reference to one of these entries; |
100 | this reference is unaffected if | |
101 | .I pathname | |
102 | is subsequently removed or modified to refer to a different file. | |
e366dbc4 | 103 | The new open file description is initially not shared |
2c4bff36 MK |
104 | with any other process, |
105 | but sharing may arise via | |
106 | .BR fork (2). | |
e366dbc4 | 107 | .PP |
c4bb193f | 108 | The argument |
fea681da | 109 | .I flags |
e366dbc4 MK |
110 | must include one of the following |
111 | .IR "access modes" : | |
c7992edc | 112 | .BR O_RDONLY ", " O_WRONLY ", or " O_RDWR . |
e366dbc4 MK |
113 | These request opening the file read-only, write-only, or read/write, |
114 | respectively. | |
bfe9ba67 MK |
115 | |
116 | In addition, zero or more file creation flags and file status flags | |
c13182ef | 117 | can be |
fea681da | 118 | .RI bitwise- or 'd |
e366dbc4 | 119 | in |
bfe9ba67 | 120 | .IR flags . |
c13182ef MK |
121 | The |
122 | .I file creation flags | |
123 | are | |
bfe9ba67 | 124 | .BR O_CREAT ", " O_EXCL ", " O_NOCTTY ", and " O_TRUNC . |
c13182ef MK |
125 | The |
126 | .I file status flags | |
bfe9ba67 | 127 | are all of the remaining flags listed below. |
93ee8f96 MK |
128 | .\" FIXME . Actually is it true that the "file status flags" are all of the |
129 | .\" remaining flags listed below? SUSv4 divides the flags into: | |
130 | .\" * Access mode | |
131 | .\" * File creation | |
132 | .\" * File status | |
133 | .\" * Other (O_CLOEXEC, O_DIRECTORY, O_NOFOLLOW) | |
134 | .\" though it's not clear what the difference between "other" and | |
9502479b | 135 | .\" "File creation" flags is. (I've raised an Aardvark to see if this |
93ee8f96 | 136 | .\" can be clarified in SUSv4; 10 Oct 2008.) |
bfe9ba67 MK |
137 | The distinction between these two groups of flags is that |
138 | the file status flags can be retrieved and (in some cases) | |
139 | modified using | |
140 | .BR fcntl (2). | |
141 | The full list of file creation flags and file status flags is as follows: | |
fea681da | 142 | .TP |
1c1e15ed | 143 | .B O_APPEND |
c13182ef MK |
144 | The file is opened in append mode. |
145 | Before each | |
0bfa087b | 146 | .BR write (2), |
1e568304 | 147 | the file offset is positioned at the end of the file, |
1c1e15ed | 148 | as if with |
0bfa087b | 149 | .BR lseek (2). |
1c1e15ed MK |
150 | .B O_APPEND |
151 | may lead to corrupted files on NFS file systems if more than one process | |
c13182ef | 152 | appends data to a file at once. |
a4391429 MK |
153 | .\" For more background, see |
154 | .\" http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=453946 | |
155 | .\" http://nfs.sourceforge.net/ | |
c13182ef | 156 | This is because NFS does not support |
1c1e15ed MK |
157 | appending to a file, so the client kernel has to simulate it, which |
158 | can't be done without a race condition. | |
159 | .TP | |
160 | .B O_ASYNC | |
b50582eb | 161 | Enable signal-driven I/O: |
8bd58774 MK |
162 | generate a signal |
163 | .RB ( SIGIO | |
164 | by default, but this can be changed via | |
1c1e15ed MK |
165 | .BR fcntl (2)) |
166 | when input or output becomes possible on this file descriptor. | |
b218b023 | 167 | This feature is only available for terminals, pseudoterminals, |
1f6ceb40 MK |
168 | sockets, and (since Linux 2.6) pipes and FIFOs. |
169 | See | |
1c1e15ed MK |
170 | .BR fcntl (2) |
171 | for further details. | |
fe75ec04 MK |
172 | .TP |
173 | .BR O_CLOEXEC " (Since Linux 2.6.23)" | |
174 | Enable the close-on-exec flag for the new file descriptor. | |
24ec631f | 175 | Specifying this flag permits a program to avoid additional |
fe75ec04 MK |
176 | .BR fcntl (2) |
177 | .B F_SETFD | |
24ec631f | 178 | operations to set the |
0daa9e92 | 179 | .B FD_CLOEXEC |
fe75ec04 MK |
180 | flag. |
181 | Additionally, | |
182 | use of this flag is essential in some multithreaded programs | |
183 | since using a separate | |
184 | .BR fcntl (2) | |
185 | .B F_SETFD | |
186 | operation to set the | |
0daa9e92 | 187 | .B FD_CLOEXEC |
fe75ec04 MK |
188 | flag does not suffice to avoid race conditions |
189 | where one thread opens a file descriptor at the same | |
190 | time as another thread does a | |
191 | .BR fork (2) | |
192 | plus | |
193 | .BR execve (2). | |
194 | .\" This flag fixes only one form of the race condition; | |
195 | .\" The race can also occur with, for example, descriptors | |
196 | .\" returned by accept(), pipe(), etc. | |
1c1e15ed | 197 | .TP |
fea681da MK |
198 | .B O_CREAT |
199 | If the file does not exist it will be created. | |
200 | The owner (user ID) of the file is set to the effective user ID | |
c13182ef MK |
201 | of the process. |
202 | The group ownership (group ID) is set either to | |
fea681da | 203 | the effective group ID of the process or to the group ID of the |
24d01c53 | 204 | parent directory (depending on file system type and mount options, |
8b39ad66 | 205 | and the mode of the parent directory, see the mount options |
fea681da MK |
206 | .I bsdgroups |
207 | and | |
208 | .I sysvgroups | |
8b39ad66 | 209 | described in |
fea681da | 210 | .BR mount (8)). |
8b39ad66 MK |
211 | .\" As at 2.6.25, bsdgroups is supported by ext2, ext3, ext4, and |
212 | .\" XFS (since 2.6.14). | |
4e698277 MK |
213 | .RS |
214 | .PP | |
215 | .I mode | |
216 | specifies the permissions to use in case a new file is created. | |
217 | This argument must be supplied when | |
218 | .B O_CREAT | |
219 | is specified in | |
220 | .IR flags ; | |
221 | if | |
222 | .B O_CREAT | |
223 | is not specified, then | |
224 | .I mode | |
225 | is ignored. | |
226 | The effective permissions are modified by | |
227 | the process's | |
228 | .I umask | |
229 | in the usual way: The permissions of the created file are | |
84a275c4 | 230 | .IR "(mode\ &\ ~umask)" . |
4e698277 MK |
231 | Note that this mode only applies to future accesses of the |
232 | newly created file; the | |
233 | .BR open () | |
234 | call that creates a read-only file may well return a read/write | |
235 | file descriptor. | |
236 | .PP | |
237 | The following symbolic constants are provided for | |
238 | .IR mode : | |
239 | .TP 9 | |
240 | .B S_IRWXU | |
241 | 00700 user (file owner) has read, write and execute permission | |
242 | .TP | |
243 | .B S_IRUSR | |
244 | 00400 user has read permission | |
245 | .TP | |
246 | .B S_IWUSR | |
247 | 00200 user has write permission | |
248 | .TP | |
249 | .B S_IXUSR | |
250 | 00100 user has execute permission | |
251 | .TP | |
252 | .B S_IRWXG | |
253 | 00070 group has read, write and execute permission | |
254 | .TP | |
255 | .B S_IRGRP | |
256 | 00040 group has read permission | |
257 | .TP | |
258 | .B S_IWGRP | |
259 | 00020 group has write permission | |
260 | .TP | |
261 | .B S_IXGRP | |
262 | 00010 group has execute permission | |
263 | .TP | |
264 | .B S_IRWXO | |
265 | 00007 others have read, write and execute permission | |
266 | .TP | |
267 | .B S_IROTH | |
268 | 00004 others have read permission | |
269 | .TP | |
270 | .B S_IWOTH | |
271 | 00002 others have write permission | |
272 | .TP | |
273 | .B S_IXOTH | |
274 | 00001 others have execute permission | |
275 | .RE | |
fea681da | 276 | .TP |
ddc4d339 | 277 | .BR O_DIRECT " (Since Linux 2.4.10)" |
1c1e15ed MK |
278 | Try to minimize cache effects of the I/O to and from this file. |
279 | In general this will degrade performance, but it is useful in | |
280 | special situations, such as when applications do their own caching. | |
281 | File I/O is done directly to/from user space buffers. | |
015221ef CH |
282 | The |
283 | .B O_DIRECT | |
284 | flag on its own makes at an effort to transfer data synchronously, | |
285 | but does not give the guarantees of the | |
286 | .B O_SYNC | |
287 | that data and necessary metadata are transferred. | |
288 | To guarantee synchronous I/O the | |
289 | .B O_SYNC | |
290 | must be used in addition to | |
291 | .BR O_DIRECT . | |
c734b9f2 | 292 | See |
ddc4d339 MK |
293 | .B NOTES |
294 | below for further discussion. | |
9b54d4fa | 295 | .sp |
c13182ef | 296 | A semantically similar (but deprecated) interface for block devices |
9b54d4fa | 297 | is described in |
1c1e15ed MK |
298 | .BR raw (8). |
299 | .TP | |
300 | .B O_DIRECTORY | |
a8d55537 | 301 | If \fIpathname\fP is not a directory, cause the open to fail. |
9f8d688a MK |
302 | .\" But see the following and its replies: |
303 | .\" http://marc.theaimsgroup.com/?t=112748702800001&r=1&w=2 | |
304 | .\" [PATCH] open: O_DIRECTORY and O_CREAT together should fail | |
305 | .\" O_DIRECTORY | O_CREAT causes O_DIRECTORY to be ignored. | |
8382f16d | 306 | This flag is Linux-specific, and was added in kernel version 2.1.126, to |
60a90ecd MK |
307 | avoid denial-of-service problems if |
308 | .BR opendir (3) | |
309 | is called on a | |
1c1e15ed | 310 | FIFO or tape device, but should not be used outside of the |
9e370fba MK |
311 | implementation of |
312 | .BR opendir (3). | |
1c1e15ed | 313 | .TP |
fea681da | 314 | .B O_EXCL |
f4b9d6a5 MK |
315 | Ensure that this call creates the file: |
316 | if this flag is specified in conjunction with | |
fea681da | 317 | .BR O_CREAT , |
f4b9d6a5 MK |
318 | and |
319 | .I pathname | |
320 | already exists, then | |
1c1e15ed | 321 | .BR open () |
c13182ef | 322 | will fail. |
f4b9d6a5 MK |
323 | |
324 | When these two flags are specified, symbolic links are not followed: | |
325 | .\" POSIX.1-2001 explicitly requires this behavior. | |
326 | if | |
327 | .I pathname | |
328 | is a symbolic link, then | |
329 | .BR open () | |
330 | fails regardless of where the symbolic link points to. | |
331 | ||
10b7a945 IHV |
332 | In general, the behavior of |
333 | .B O_EXCL | |
334 | is undefined if it is used without | |
335 | .BR O_CREAT . | |
336 | There is one exception: on Linux 2.6 and later, | |
337 | .B O_EXCL | |
338 | can be used without | |
339 | .B O_CREAT | |
340 | if | |
341 | .I pathname | |
342 | refers to a block device. | |
6303d401 DB |
343 | If the block device is in use by the system (e.g., mounted), |
344 | .BR open () | |
10b7a945 IHV |
345 | fails with the error |
346 | .BR EBUSY . | |
347 | ||
efe08656 | 348 | On NFS, |
f4b9d6a5 | 349 | .B O_EXCL |
efe08656 MK |
350 | is only supported when using NFSv3 or later on kernel 2.6 or later. |
351 | In NFS environments where | |
fea681da | 352 | .B O_EXCL |
f4b9d6a5 MK |
353 | support is not provided, programs that rely on it |
354 | for performing locking tasks will contain a race condition. | |
355 | Portable programs that want to perform atomic file locking using a lockfile, | |
356 | and need to avoid reliance on NFS support for | |
357 | .BR O_EXCL , | |
358 | can create a unique file on | |
359 | the same file system (e.g., incorporating hostname and PID), and use | |
fea681da | 360 | .BR link (2) |
c13182ef | 361 | to make a link to the lockfile. |
60a90ecd MK |
362 | If |
363 | .BR link (2) | |
f4b9d6a5 | 364 | returns 0, the lock is successful. |
c13182ef | 365 | Otherwise, use |
fea681da MK |
366 | .BR stat (2) |
367 | on the unique file to check if its link count has increased to 2, | |
368 | in which case the lock is also successful. | |
369 | .TP | |
1c1e15ed MK |
370 | .B O_LARGEFILE |
371 | (LFS) | |
372 | Allow files whose sizes cannot be represented in an | |
8478ee02 | 373 | .I off_t |
1c1e15ed | 374 | (but can be represented in an |
8478ee02 | 375 | .IR off64_t ) |
1c1e15ed | 376 | to be opened. |
c13182ef | 377 | The |
bcdd964e | 378 | .B _LARGEFILE64_SOURCE |
e417acb0 MK |
379 | macro must be defined |
380 | (before including | |
381 | .I any | |
382 | header files) | |
383 | in order to obtain this definition. | |
c13182ef | 384 | Setting the |
bcdd964e | 385 | .B _FILE_OFFSET_BITS |
9f3d8b28 MK |
386 | feature test macro to 64 (rather than using |
387 | .BR O_LARGEFILE ) | |
12e263f1 | 388 | is the preferred |
9f3d8b28 | 389 | method of accessing large files on 32-bit systems (see |
2dcbf4f7 | 390 | .BR feature_test_macros (7)). |
1c1e15ed | 391 | .TP |
fe75ec04 | 392 | .BR O_NOATIME " (Since Linux 2.6.8)" |
310b7919 MK |
393 | Do not update the file last access time (st_atime in the inode) |
394 | when the file is | |
1c1e15ed MK |
395 | .BR read (2). |
396 | This flag is intended for use by indexing or backup programs, | |
397 | where its use can significantly reduce the amount of disk activity. | |
24d01c53 | 398 | This flag may not be effective on all file systems. |
1c1e15ed | 399 | One example is NFS, where the server maintains the access time. |
0e1ad98c | 400 | .\" The O_NOATIME flag also affects the treatment of st_atime |
92057f4d | 401 | .\" by mmap() and readdir(2), MTK, Dec 04. |
1c1e15ed | 402 | .TP |
fea681da MK |
403 | .B O_NOCTTY |
404 | If | |
405 | .I pathname | |
5503c85e MK |
406 | refers to a terminal device\(emsee |
407 | .BR tty (4)\(em | |
408 | it will not become the process's controlling terminal even if the | |
fea681da MK |
409 | process does not have one. |
410 | .TP | |
1c1e15ed | 411 | .B O_NOFOLLOW |
a8d55537 | 412 | If \fIpathname\fP is a symbolic link, then the open fails. |
c13182ef | 413 | This is a FreeBSD extension, which was added to Linux in version 2.1.126. |
1c1e15ed | 414 | Symbolic links in earlier components of the pathname will still be |
e366dbc4 MK |
415 | followed. |
416 | .\" The headers from glibc 2.0.100 and later include a | |
417 | .\" definition of this flag; \fIkernels before 2.1.126 will ignore it if | |
a8d55537 | 418 | .\" used\fP. |
fea681da MK |
419 | .TP |
420 | .BR O_NONBLOCK " or " O_NDELAY | |
ff40dbb3 | 421 | When possible, the file is opened in nonblocking mode. |
c13182ef | 422 | Neither the |
1c1e15ed | 423 | .BR open () |
fea681da MK |
424 | nor any subsequent operations on the file descriptor which is |
425 | returned will cause the calling process to wait. | |
426 | For the handling of FIFOs (named pipes), see also | |
af5b2ef2 | 427 | .BR fifo (7). |
db28bfac | 428 | For a discussion of the effect of |
0daa9e92 | 429 | .B O_NONBLOCK |
db28bfac MK |
430 | in conjunction with mandatory file locks and with file leases, see |
431 | .BR fcntl (2). | |
fea681da MK |
432 | .TP |
433 | .B O_SYNC | |
c13182ef MK |
434 | The file is opened for synchronous I/O. |
435 | Any | |
0bfa087b | 436 | .BR write (2)s |
fea681da MK |
437 | on the resulting file descriptor will block the calling process until |
438 | the data has been physically written to the underlying hardware. | |
b07cd0a9 | 439 | .IR "But see NOTES below" . |
fea681da | 440 | .TP |
1c1e15ed MK |
441 | .B O_TRUNC |
442 | If the file already exists and is a regular file and the open mode allows | |
682edefb MK |
443 | writing (i.e., is |
444 | .B O_RDWR | |
445 | or | |
446 | .BR O_WRONLY ) | |
447 | it will be truncated to length 0. | |
448 | If the file is a FIFO or terminal device file, the | |
449 | .B O_TRUNC | |
c13182ef | 450 | flag is ignored. |
682edefb MK |
451 | Otherwise the effect of |
452 | .B O_TRUNC | |
453 | is unspecified. | |
fea681da MK |
454 | .PP |
455 | Some of these optional flags can be altered using | |
0bfa087b | 456 | .BR fcntl (2) |
fea681da MK |
457 | after the file has been opened. |
458 | ||
1c1e15ed | 459 | .BR creat () |
fea681da | 460 | is equivalent to |
1c1e15ed | 461 | .BR open () |
fea681da MK |
462 | with |
463 | .I flags | |
464 | equal to | |
465 | .BR O_CREAT|O_WRONLY|O_TRUNC . | |
466 | .SH "RETURN VALUE" | |
c13182ef MK |
467 | .BR open () |
468 | and | |
e1d6264d | 469 | .BR creat () |
1c1e15ed MK |
470 | return the new file descriptor, or \-1 if an error occurred |
471 | (in which case, | |
fea681da MK |
472 | .I errno |
473 | is set appropriately). | |
fea681da MK |
474 | .SH ERRORS |
475 | .TP | |
476 | .B EACCES | |
477 | The requested access to the file is not allowed, or search permission | |
478 | is denied for one of the directories in the path prefix of | |
479 | .IR pathname , | |
480 | or the file did not exist yet and write access to the parent directory | |
481 | is not allowed. | |
482 | (See also | |
ad7cc990 | 483 | .BR path_resolution (7).) |
fea681da MK |
484 | .TP |
485 | .B EEXIST | |
486 | .I pathname | |
487 | already exists and | |
488 | .BR O_CREAT " and " O_EXCL | |
489 | were used. | |
490 | .TP | |
491 | .B EFAULT | |
0daa9e92 | 492 | .I pathname |
e1d6264d | 493 | points outside your accessible address space. |
fea681da | 494 | .TP |
9f5773f7 | 495 | .B EFBIG |
7c7fb552 MK |
496 | See |
497 | .BR EOVERFLOW . | |
9f5773f7 | 498 | .TP |
e51412ea MK |
499 | .B EINTR |
500 | While blocked waiting to complete an open of a slow device | |
501 | (e.g., a FIFO; see | |
502 | .BR fifo (7)), | |
503 | the call was interrupted by a signal handler; see | |
504 | .BR signal (7). | |
505 | .TP | |
fea681da MK |
506 | .B EISDIR |
507 | .I pathname | |
508 | refers to a directory and the access requested involved writing | |
509 | (that is, | |
510 | .B O_WRONLY | |
511 | or | |
512 | .B O_RDWR | |
513 | is set). | |
514 | .TP | |
515 | .B ELOOP | |
516 | Too many symbolic links were encountered in resolving | |
517 | .IR pathname , | |
a8d55537 | 518 | or \fBO_NOFOLLOW\fP was specified but |
fea681da MK |
519 | .I pathname |
520 | was a symbolic link. | |
521 | .TP | |
522 | .B EMFILE | |
523 | The process already has the maximum number of files open. | |
524 | .TP | |
525 | .B ENAMETOOLONG | |
0daa9e92 | 526 | .I pathname |
e1d6264d | 527 | was too long. |
fea681da MK |
528 | .TP |
529 | .B ENFILE | |
530 | The system limit on the total number of open files has been reached. | |
531 | .TP | |
532 | .B ENODEV | |
533 | .I pathname | |
534 | refers to a device special file and no corresponding device exists. | |
682edefb MK |
535 | (This is a Linux kernel bug; in this situation |
536 | .B ENXIO | |
537 | must be returned.) | |
fea681da MK |
538 | .TP |
539 | .B ENOENT | |
682edefb MK |
540 | .B O_CREAT |
541 | is not set and the named file does not exist. | |
fea681da MK |
542 | Or, a directory component in |
543 | .I pathname | |
544 | does not exist or is a dangling symbolic link. | |
545 | .TP | |
546 | .B ENOMEM | |
547 | Insufficient kernel memory was available. | |
548 | .TP | |
549 | .B ENOSPC | |
550 | .I pathname | |
551 | was to be created but the device containing | |
552 | .I pathname | |
553 | has no room for the new file. | |
554 | .TP | |
555 | .B ENOTDIR | |
556 | A component used as a directory in | |
557 | .I pathname | |
a8d55537 | 558 | is not, in fact, a directory, or \fBO_DIRECTORY\fP was specified and |
fea681da MK |
559 | .I pathname |
560 | was not a directory. | |
561 | .TP | |
562 | .B ENXIO | |
682edefb MK |
563 | .BR O_NONBLOCK " | " O_WRONLY |
564 | is set, the named file is a FIFO and | |
fea681da MK |
565 | no process has the file open for reading. |
566 | Or, the file is a device special file and no corresponding device exists. | |
567 | .TP | |
7c7fb552 MK |
568 | .B EOVERFLOW |
569 | .I pathname | |
570 | refers to a regular file that is too large to be opened. | |
571 | The usual scenario here is that an application compiled | |
572 | on a 32-bit platform without | |
5e4dc269 | 573 | .I -D_FILE_OFFSET_BITS=64 |
7c7fb552 MK |
574 | tried to open a file whose size exceeds |
575 | .I (2<<31)-1 | |
576 | bits; | |
577 | see also | |
578 | .B O_LARGEFILE | |
579 | above. | |
580 | This is the error specified by POSIX.1-2001; | |
581 | in kernels before 2.6.24, Linux gave the error | |
582 | .B EFBIG | |
583 | for this case. | |
584 | .\" See http://bugzilla.kernel.org/show_bug.cgi?id=7253 | |
585 | .\" "Open of a large file on 32-bit fails with EFBIG, should be EOVERFLOW" | |
586 | .\" Reported 2006-10-03 | |
587 | .TP | |
1c1e15ed MK |
588 | .B EPERM |
589 | The | |
590 | .B O_NOATIME | |
591 | flag was specified, but the effective user ID of the caller | |
592 | .\" Strictly speaking, it's the file system UID... (MTK) | |
593 | did not match the owner of the file and the caller was not privileged | |
594 | .RB ( CAP_FOWNER ). | |
595 | .TP | |
fea681da MK |
596 | .B EROFS |
597 | .I pathname | |
24d01c53 | 598 | refers to a file on a read-only file system and write access was |
fea681da MK |
599 | requested. |
600 | .TP | |
601 | .B ETXTBSY | |
602 | .I pathname | |
603 | refers to an executable image which is currently being executed and | |
604 | write access was requested. | |
d3952311 MK |
605 | .TP |
606 | .B EWOULDBLOCK | |
607 | The | |
608 | .B O_NONBLOCK | |
609 | flag was specified, and an incompatible lease was held on the file | |
610 | (see | |
611 | .BR fcntl (2)). | |
fea681da | 612 | .SH "CONFORMING TO" |
97c1eac8 | 613 | SVr4, 4.3BSD, POSIX.1-2001. |
fea681da | 614 | The |
fe75ec04 | 615 | .BR O_DIRECTORY , |
1c1e15ed | 616 | .BR O_NOATIME , |
fea681da | 617 | and |
0daa9e92 | 618 | .B O_NOFOLLOW |
9f91e36c | 619 | flags are Linux-specific, and one may need to define |
61b7c1e1 | 620 | .B _GNU_SOURCE |
e417acb0 MK |
621 | (before including |
622 | .I any | |
623 | header files) | |
61b7c1e1 | 624 | to obtain their definitions. |
9f91e36c MK |
625 | |
626 | The | |
627 | .BR O_CLOEXEC | |
628 | flag is not specified in POSIX.1-2001, | |
7c5f0513 | 629 | but is specified in POSIX.1-2008. |
9f91e36c | 630 | |
0daa9e92 | 631 | .B O_DIRECT |
fb7339df | 632 | is not specified in POSIX; one has to define |
fe75ec04 | 633 | .B _GNU_SOURCE |
e417acb0 MK |
634 | (before including |
635 | .I any | |
636 | header files) | |
fe75ec04 | 637 | to get its definition. |
a1d5f77c | 638 | .SH NOTES |
988db661 | 639 | Under Linux, the |
a1d5f77c MK |
640 | .B O_NONBLOCK |
641 | flag indicates that one wants to open | |
642 | but does not necessarily have the intention to read or write. | |
643 | This is typically used to open devices in order to get a file descriptor | |
644 | for use with | |
645 | .BR ioctl (2). | |
c734b9f2 MK |
646 | |
647 | Unlike the other values that can be specified in | |
648 | .IR flags , | |
649 | the | |
650 | .I "access mode" | |
651 | values | |
652 | .BR O_RDONLY ", " O_WRONLY ", and " O_RDWR , | |
653 | do not specify individual bits. | |
654 | Rather, they define the low order two bits of | |
655 | .IR flags , | |
656 | and are defined respectively as 0, 1, and 2. | |
657 | In other words, the combination | |
658 | .B "O_RDONLY | O_WRONLY" | |
659 | is a logical error, and certainly does not have the same meaning as | |
660 | .BR O_RDWR . | |
c8f2dd47 | 661 | Linux reserves the special, nonstandard access mode 3 (binary 11) in |
c734b9f2 MK |
662 | .I flags |
663 | to mean: | |
664 | check for read and write permission on the file and return a descriptor | |
665 | that can't be used for reading or writing. | |
c8f2dd47 | 666 | This nonstandard access mode is used by some Linux drivers to return a |
c734b9f2 MK |
667 | descriptor that is only to be used for device-specific |
668 | .BR ioctl (2) | |
669 | operations. | |
670 | .\" See for example util-linux's disk-utils/setfdprm.c | |
671 | .\" For some background on access mode 3, see | |
672 | .\" http://thread.gmane.org/gmane.linux.kernel/653123 | |
673 | .\" "[RFC] correct flags to f_mode conversion in __dentry_open" | |
674 | .\" LKML, 12 Mar 2008 | |
fea681da MK |
675 | .LP |
676 | The (undefined) effect of | |
677 | .B O_RDONLY | O_TRUNC | |
c13182ef | 678 | varies among implementations. |
bcdd964e | 679 | On many systems the file is actually truncated. |
fea681da MK |
680 | .\" Linux 2.0, 2.5: truncate |
681 | .\" Solaris 5.7, 5.8: truncate | |
682 | .\" Irix 6.5: truncate | |
683 | .\" Tru64 5.1B: truncate | |
684 | .\" HP-UX 11.22: truncate | |
685 | .\" FreeBSD 4.7: truncate | |
a1d5f77c MK |
686 | .PP |
687 | There are many infelicities in the protocol underlying NFS, affecting | |
688 | amongst others | |
689 | .BR O_SYNC " and " O_NDELAY . | |
690 | ||
d9bfdb9c | 691 | POSIX provides for three different variants of synchronized I/O, |
015221ef CH |
692 | corresponding to the flags |
693 | .BR O_SYNC , | |
694 | .BR O_DSYNC , | |
695 | and | |
696 | .BR O_RSYNC . | |
697 | Currently (2.6.31), Linux only implements | |
698 | .BR O_SYNC , | |
699 | but glibc maps | |
700 | .B O_DSYNC | |
701 | and | |
702 | .B O_RSYNC | |
703 | to the same numerical value as | |
0a598d26 | 704 | .BR O_SYNC . |
245dec52 | 705 | Most Linux file systems don't actually implement the POSIX |
015221ef CH |
706 | .B O_SYNC |
707 | semantics, which require all metadata updates of a write | |
708 | to be on disk on returning to userspace, but only the | |
709 | .B O_DSYNC | |
710 | semantics, which require only actual file data and metadata necessary | |
711 | to retrieve it to be on disk by the time the system call returns. | |
a1d5f77c MK |
712 | |
713 | Note that | |
714 | .BR open () | |
715 | can open device special files, but | |
716 | .BR creat () | |
717 | cannot create them; use | |
718 | .BR mknod (2) | |
719 | instead. | |
720 | .LP | |
721 | On NFS file systems with UID mapping enabled, | |
722 | .BR open () | |
723 | may | |
75b94dc3 | 724 | return a file descriptor but, for example, |
a1d5f77c MK |
725 | .BR read (2) |
726 | requests are denied | |
727 | with \fBEACCES\fP. | |
728 | This is because the client performs | |
729 | .BR open () | |
730 | by checking the | |
731 | permissions, but UID mapping is performed by the server upon | |
732 | read and write requests. | |
733 | ||
734 | If the file is newly created, its | |
988db661 | 735 | .IR st_atime , |
a1d5f77c MK |
736 | .IR st_ctime , |
737 | .I st_mtime | |
738 | fields | |
739 | (respectively, time of last access, time of last status change, and | |
740 | time of last modification; see | |
741 | .BR stat (2)) | |
742 | are set | |
743 | to the current time, and so are the | |
744 | .I st_ctime | |
988db661 | 745 | and |
a1d5f77c MK |
746 | .I st_mtime |
747 | fields of the | |
748 | parent directory. | |
988db661 | 749 | Otherwise, if the file is modified because of the |
a1d5f77c MK |
750 | .B O_TRUNC |
751 | flag, its st_ctime and st_mtime fields are set to the current time. | |
ddc4d339 MK |
752 | .SS O_DIRECT |
753 | .LP | |
754 | The | |
755 | .B O_DIRECT | |
756 | flag may impose alignment restrictions on the length and address | |
757 | of userspace buffers and the file offset of I/Os. | |
758 | In Linux alignment | |
24d01c53 | 759 | restrictions vary by file system and kernel version and might be |
ddc4d339 | 760 | absent entirely. |
24d01c53 | 761 | However there is currently no file system\-independent |
ddc4d339 | 762 | interface for an application to discover these restrictions for a given |
24d01c53 MK |
763 | file or file system. |
764 | Some file systems provide their own interfaces | |
ddc4d339 MK |
765 | for doing so, for example the |
766 | .B XFS_IOC_DIOINFO | |
767 | operation in | |
768 | .BR xfsctl (3). | |
769 | .LP | |
85c2bdba MK |
770 | Under Linux 2.4, transfer sizes, and the alignment of the user buffer |
771 | and the file offset must all be multiples of the logical block size | |
ddc4d339 MK |
772 | of the file system. |
773 | Under Linux 2.6, alignment to 512-byte boundaries | |
774 | suffices. | |
775 | .LP | |
776 | The | |
777 | .B O_DIRECT | |
778 | flag was introduced in SGI IRIX, where it has alignment | |
779 | restrictions similar to those of Linux 2.4. | |
780 | IRIX has also a | |
781 | .BR fcntl (2) | |
782 | call to query appropriate alignments, and sizes. | |
783 | FreeBSD 4.x introduced | |
784 | a flag of the same name, but without alignment restrictions. | |
785 | .LP | |
786 | .B O_DIRECT | |
787 | support was added under Linux in kernel version 2.4.10. | |
788 | Older Linux kernels simply ignore this flag. | |
24d01c53 | 789 | Some file systems may not implement the flag and |
ddc4d339 MK |
790 | .BR open () |
791 | will fail with | |
792 | .B EINVAL | |
793 | if it is used. | |
794 | .LP | |
795 | Applications should avoid mixing | |
796 | .B O_DIRECT | |
797 | and normal I/O to the same file, | |
798 | and especially to overlapping byte regions in the same file. | |
24d01c53 | 799 | Even when the file system correctly handles the coherency issues in |
ddc4d339 MK |
800 | this situation, overall I/O throughput is likely to be slower than |
801 | using either mode alone. | |
802 | Likewise, applications should avoid mixing | |
803 | .BR mmap (2) | |
804 | of files with direct I/O to the same files. | |
805 | .LP | |
806 | The behaviour of | |
807 | .B O_DIRECT | |
24d01c53 | 808 | with NFS will differ from local file systems. |
ddc4d339 MK |
809 | Older kernels, or |
810 | kernels configured in certain ways, may not support this combination. | |
811 | The NFS protocol does not support passing the flag to the server, so | |
812 | .B O_DIRECT | |
813 | I/O will only bypass the page cache on the client; the server may | |
814 | still cache the I/O. | |
815 | The client asks the server to make the I/O | |
816 | synchronous to preserve the synchronous semantics of | |
817 | .BR O_DIRECT . | |
818 | Some servers will perform poorly under these circumstances, especially | |
819 | if the I/O size is small. | |
820 | Some servers may also be configured to | |
821 | lie to clients about the I/O having reached stable storage; this | |
822 | will avoid the performance penalty at some risk to data integrity | |
823 | in the event of server power failure. | |
824 | The Linux NFS client places no alignment restrictions on | |
825 | .B O_DIRECT | |
826 | I/O. | |
827 | .PP | |
828 | In summary, | |
829 | .B O_DIRECT | |
830 | is a potentially powerful tool that should be used with caution. | |
831 | It is recommended that applications treat use of | |
832 | .B O_DIRECT | |
833 | as a performance option which is disabled by default. | |
834 | .PP | |
835 | .RS | |
fea681da MK |
836 | "The thing that has always disturbed me about O_DIRECT is that the whole |
837 | interface is just stupid, and was probably designed by a deranged monkey | |
5503c85e | 838 | on some serious mind-controlling substances."\(emLinus |
ddc4d339 MK |
839 | .RE |
840 | .SH BUGS | |
b50582eb MK |
841 | Currently, it is not possible to enable signal-driven |
842 | I/O by specifying | |
843 | .B O_ASYNC | |
c13182ef | 844 | when calling |
b50582eb MK |
845 | .BR open (); |
846 | use | |
847 | .BR fcntl (2) | |
848 | to enable this flag. | |
0e1ad98c | 849 | .\" FIXME . Check bugzilla report on open(O_ASYNC) |
92057f4d | 850 | .\" See http://bugzilla.kernel.org/show_bug.cgi?id=5993 |
fea681da | 851 | .SH "SEE ALSO" |
a3bf8022 MK |
852 | .BR chmod (2), |
853 | .BR chown (2), | |
fea681da | 854 | .BR close (2), |
e366dbc4 | 855 | .BR dup (2), |
fea681da MK |
856 | .BR fcntl (2), |
857 | .BR link (2), | |
1f6ceb40 | 858 | .BR lseek (2), |
fea681da | 859 | .BR mknod (2), |
e366dbc4 | 860 | .BR mmap (2), |
f0c34053 | 861 | .BR mount (2), |
28c54d45 | 862 | .BR openat (2), |
fea681da MK |
863 | .BR read (2), |
864 | .BR socket (2), | |
865 | .BR stat (2), | |
866 | .BR umask (2), | |
867 | .BR unlink (2), | |
868 | .BR write (2), | |
869 | .BR fopen (3), | |
f0c34053 | 870 | .BR fifo (7), |
a9cfde1d MK |
871 | .BR path_resolution (7), |
872 | .BR symlink (7) |