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>
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.
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.
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
24 .\" Formatted or processed versions of this manual, if unaccompanied by
25 .\" the source, must acknowledge the copyright and authors of this work.
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
46 .\" 2008-02-26, Michael Haardt: Reorganized text for O_CREAT and mode
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
51 .TH OPEN 2 2014-04-06 "Linux" "Linux Programmer's Manual"
53 open, openat, creat \- open and possibly create a file
56 .B #include <sys/types.h>
57 .B #include <sys/stat.h>
60 .BI "int open(const char *" pathname ", int " flags );
61 .BI "int open(const char *" pathname ", int " flags ", mode_t " mode );
63 .BI "int creat(const char *" pathname ", mode_t " mode );
65 .BI "int openat(int " dirfd ", const char *" pathname ", int " flags );
66 .BI "int openat(int " dirfd ", const char *" pathname ", int " flags \
71 Feature Test Macro Requirements for glibc (see
72 .BR feature_test_macros (7)):
81 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
93 returns a file descriptor, a small, nonnegative integer
94 for use in subsequent system calls
95 .RB ( read "(2), " write "(2), " lseek "(2), " fcntl "(2), etc.)."
96 The file descriptor returned by a successful call will be
97 the lowest-numbered file descriptor not currently open for the process.
99 By default, the new file descriptor is set to remain open across an
103 file descriptor flag described in
105 is initially disabled; the
107 flag, described below, can be used to change this default).
108 The file offset is set to the beginning of the file (see
114 .IR "open file description" ,
115 an entry in the system-wide table of open files.
116 This entry records the file offset and the file status flags
121 A file descriptor is a reference to one of these entries;
122 this reference is unaffected if
124 is subsequently removed or modified to refer to a different file.
125 The new open file description is initially not shared
126 with any other process,
127 but sharing may arise via
132 must include one of the following
134 .BR O_RDONLY ", " O_WRONLY ", or " O_RDWR .
135 These request opening the file read-only, write-only, or read/write,
138 In addition, zero or more file creation flags and file status flags
144 .I file creation flags
158 are all of the remaining flags listed below.
159 .\" SUSv4 divides the flags into:
163 .\" * Other (O_CLOEXEC, O_DIRECTORY, O_NOFOLLOW)
164 .\" though it's not clear what the difference between "other" and
165 .\" "File creation" flags is. I raised an Aardvark to see if this
166 .\" can be clarified in SUSv4; 10 Oct 2008.
167 .\" http://thread.gmane.org/gmane.comp.standards.posix.austin.general/64/focus=67
168 .\" TC1 (balloted in 2013), resolved this, so that those three constants
169 .\" are also categorized" as file status flags.
171 The distinction between these two groups of flags is that
172 the file status flags can be retrieved and (in some cases)
177 The full list of file creation flags and file status flags is as follows:
180 The file is opened in append mode.
183 the file offset is positioned at the end of the file,
187 may lead to corrupted files on NFS filesystems if more than one process
188 appends data to a file at once.
189 .\" For more background, see
190 .\" http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=453946
191 .\" http://nfs.sourceforge.net/
192 This is because NFS does not support
193 appending to a file, so the client kernel has to simulate it, which
194 can't be done without a race condition.
197 Enable signal-driven I/O:
200 by default, but this can be changed via
202 when input or output becomes possible on this file descriptor.
203 This feature is available only for terminals, pseudoterminals,
204 sockets, and (since Linux 2.6) pipes and FIFOs.
208 See also BUGS, below.
210 .BR O_CLOEXEC " (since Linux 2.6.23)"
211 Enable the close-on-exec flag for the new file descriptor.
212 Specifying this flag permits a program to avoid additional
215 operations to set the
219 use of this flag is essential in some multithreaded programs
220 since using a separate
225 flag does not suffice to avoid race conditions
226 where one thread opens a file descriptor at the same
227 time as another thread does a
231 .\" This flag fixes only one form of the race condition;
232 .\" The race can also occur with, for example, descriptors
233 .\" returned by accept(), pipe(), etc.
236 If the file does not exist, it will be created.
237 The owner (user ID) of the file is set to the effective user ID
239 The group ownership (group ID) is set either to
240 the effective group ID of the process or to the group ID of the
241 parent directory (depending on filesystem type and mount options,
242 and the mode of the parent directory; see the mount options
248 .\" As at 2.6.25, bsdgroups is supported by ext2, ext3, ext4, and
249 .\" XFS (since 2.6.14).
253 specifies the permissions to use in case a new file is created.
254 This argument must be supplied when
267 The effective permissions are modified by
270 in the usual way: The permissions of the created file are
271 .IR "(mode\ &\ ~umask)" .
272 Note that this mode applies only to future accesses of the
273 newly created file; the
275 call that creates a read-only file may well return a read/write
278 The following symbolic constants are provided for
282 00700 user (file owner) has read, write and execute permission
285 00400 user has read permission
288 00200 user has write permission
291 00100 user has execute permission
294 00070 group has read, write and execute permission
297 00040 group has read permission
300 00020 group has write permission
303 00010 group has execute permission
306 00007 others have read, write and execute permission
309 00004 others have read permission
312 00002 others have write permission
315 00001 others have execute permission
318 .BR O_DIRECT " (since Linux 2.4.10)"
319 Try to minimize cache effects of the I/O to and from this file.
320 In general this will degrade performance, but it is useful in
321 special situations, such as when applications do their own caching.
322 File I/O is done directly to/from user-space buffers.
325 flag on its own makes an effort to transfer data synchronously,
326 but does not give the guarantees of the
328 flag that data and necessary metadata are transferred.
329 To guarantee synchronous I/O,
331 must be used in addition to
333 See NOTES below for further discussion.
335 A semantically similar (but deprecated) interface for block devices
340 If \fIpathname\fP is not a directory, cause the open to fail.
341 .\" But see the following and its replies:
342 .\" http://marc.theaimsgroup.com/?t=112748702800001&r=1&w=2
343 .\" [PATCH] open: O_DIRECTORY and O_CREAT together should fail
344 .\" O_DIRECTORY | O_CREAT causes O_DIRECTORY to be ignored.
345 This flag is Linux-specific, and was added in kernel version 2.1.126, to
346 avoid denial-of-service problems if
352 Write operations on the file will complete according to the requirements of
355 integrity completion.
360 return, the output data
361 has been transferred to the underlying hardware,
362 along with any file metadata that would be required to retrieve that data
363 (i.e., as though each
365 was followed by a call to
367 .IR "See NOTES below" .
370 Ensure that this call creates the file:
371 if this flag is specified in conjunction with
379 When these two flags are specified, symbolic links are not followed:
380 .\" POSIX.1-2001 explicitly requires this behavior.
383 is a symbolic link, then
385 fails regardless of where the symbolic link points to.
387 In general, the behavior of
389 is undefined if it is used without
391 There is one exception: on Linux 2.6 and later,
397 refers to a block device.
398 If the block device is in use by the system (e.g., mounted),
405 is supported only when using NFSv3 or later on kernel 2.6 or later.
406 In NFS environments where
408 support is not provided, programs that rely on it
409 for performing locking tasks will contain a race condition.
410 Portable programs that want to perform atomic file locking using a lockfile,
411 and need to avoid reliance on NFS support for
413 can create a unique file on
414 the same filesystem (e.g., incorporating hostname and PID), and use
416 to make a link to the lockfile.
419 returns 0, the lock is successful.
422 on the unique file to check if its link count has increased to 2,
423 in which case the lock is also successful.
427 Allow files whose sizes cannot be represented in an
429 (but can be represented in an
433 .B _LARGEFILE64_SOURCE
434 macro must be defined
438 in order to obtain this definition.
441 feature test macro to 64 (rather than using
444 method of accessing large files on 32-bit systems (see
445 .BR feature_test_macros (7)).
447 .BR O_NOATIME " (since Linux 2.6.8)"
448 Do not update the file last access time
453 This flag is intended for use by indexing or backup programs,
454 where its use can significantly reduce the amount of disk activity.
455 This flag may not be effective on all filesystems.
456 One example is NFS, where the server maintains the access time.
457 .\" The O_NOATIME flag also affects the treatment of st_atime
458 .\" by mmap() and readdir(2), MTK, Dec 04.
463 refers to a terminal device\(emsee
465 will not become the process's controlling terminal even if the
466 process does not have one.
469 If \fIpathname\fP is a symbolic link, then the open fails.
470 This is a FreeBSD extension, which was added to Linux in version 2.1.126.
471 Symbolic links in earlier components of the pathname will still be
476 .\" The headers from glibc 2.0.100 and later include a
477 .\" definition of this flag; \fIkernels before 2.1.126 will ignore it if
480 .BR O_NONBLOCK " or " O_NDELAY
481 When possible, the file is opened in nonblocking mode.
484 nor any subsequent operations on the file descriptor which is
485 returned will cause the calling process to wait.
486 For the handling of FIFOs (named pipes), see also
488 For a discussion of the effect of
490 in conjunction with mandatory file locks and with file leases, see
493 .BR O_PATH " (since Linux 2.6.39)"
494 .\" commit 1abf0c718f15a56a0a435588d1b104c7a37dc9bd
495 .\" commit 326be7b484843988afe57566b627fb7a70beac56
496 .\" commit 65cfc6722361570bfe255698d9cd4dccaf47570d
498 .\" http://thread.gmane.org/gmane.linux.man/2790/focus=3496
499 .\" Subject: Re: [PATCH] open(2): document O_PATH
500 .\" Newsgroups: gmane.linux.man, gmane.linux.kernel
502 Obtain a file descriptor that can be used for two purposes:
503 to indicate a location in the filesystem tree and
504 to perform operations that act purely at the file descriptor level.
505 The file itself is not opened, and other file operations (e.g.,
515 The following operations
517 be performed on the resulting file descriptor:
523 .\" commit 332a2e1244bd08b9e3ecd378028513396a004a24
526 .\" fstat(): commit 55815f70147dcfa3ead5738fd56d3574e2e3c1c2
528 Duplicating the file descriptor
534 Getting and setting file descriptor flags
540 Retrieving open file status flags using the
543 operation: the returned flags will include the bit
547 Passing the file descriptor as the
551 and the other "*at()" system calls.
553 Passing the file descriptor to another process via a UNIX domain socket
572 is a symbolic link and the
574 flag is also specified,
575 then the call returns a file descriptor referring to the symbolic link.
576 This file descriptor can be used as the
584 with an empty pathname to have the calls operate on the symbolic link.
587 Write operations on the file will complete according to the requirements of
591 (by contrast with contrast with the
601 return, the output data and associated file metadata
602 have been transferred to the underlying hardware
603 (i.e., as though each
605 was followed by a call to
607 .IR "See NOTES below" .
609 .BR O_TMPFILE " (since Linux 3.11)"
610 .\" commit 60545d0d4610b02e55f65d141c95b18ccf855b6e
611 .\" commit f4e0c30c191f87851c4a53454abb55ee276f4a7e
612 .\" commit bb458c644a59dbba3a1fe59b27106c5e68e1c4bd
613 Create an unnamed temporary file.
616 argument specifies a directory;
617 an unnamed inode will be created in that directory's filesystem.
618 Anything written to the resulting file will be lost when
619 the last file descriptor is closed, unless the file is given a name.
622 must be specified with one of
630 is not specified, then
632 can be used to link the temporary file into the filesystem, making it
633 permanent, using code like the following:
638 fd = open("/path/to/dir", O_TMPFILE | O_RDWR,
641 /* File I/O on 'fd'... */
643 snprintf(path, PATH_MAX, "/proc/self/fd/%d", fd);
644 linkat(AT_FDCWD, path, AT_FDCWD, "/path/for/file",
653 argument determines the file permission mode, as with
660 prevents a temporary file from being linked into the filesystem
662 (Note that the meaning of
664 in this case is different from the meaning of
669 There are two main use cases for
670 .\" Inspired by http://lwn.net/Articles/559147/
676 functionality: race-free creation of temporary files that
677 (1) are automatically deleted when closed;
678 (2) can never be reached via any pathname;
679 (3) are not subject to symlink attacks; and
680 (4) do not require the caller to devise unique names.
682 Creating a file that is initially invisible, which is then populated
683 with data and adjusted to have appropriate filesystem attributes
688 before being atomically linked into the filesystem
689 in a fully formed state (using
695 requires support by the underlying filesystem;
696 .\" As at 3.13, there's support for at least ext2, ext3, ext4
697 only a subset of Linux filesystems provide that support.
700 If the file already exists and is a regular file and the access mode allows
705 it will be truncated to length 0.
706 If the file is a FIFO or terminal device file, the
709 Otherwise the effect of
719 .BR O_CREAT|O_WRONLY|O_TRUNC .
723 system call operates in exactly the same way as
725 except for the differences described here.
727 If the pathname given in
729 is relative, then it is interpreted relative to the directory
730 relative to by the file descriptor
732 (rather than relative to the current working directory of
733 the calling process, as is done by
735 for a relative pathname).
745 is interpreted relative to the current working
746 directory of the calling process (like
759 return the new file descriptor, or \-1 if an error occurred
762 is set appropriately).
768 can fail with the following errors:
771 The requested access to the file is not allowed, or search permission
772 is denied for one of the directories in the path prefix of
774 or the file did not exist yet and write access to the parent directory
777 .BR path_resolution (7).)
782 is specified, the file does not exist, and the user's quota of disk
783 blocks or inodes on the filesystem has been exhausted.
788 .BR O_CREAT " and " O_EXCL
793 points outside your accessible address space.
800 While blocked waiting to complete an open of a slow device
803 the call was interrupted by a signal handler; see
807 The filesystem does not support the
812 for more information.
816 .\" In particular, __O_TMPFILE instead of O_TMPFILE
831 refers to a directory and the access requested involved writing
840 refers to an existing directory,
848 but this kernel version does not provide the
853 Too many symbolic links were encountered in resolving
858 was a symbolic link, and
866 The process already has the maximum number of files open.
873 The system limit on the total number of open files has been reached.
877 refers to a device special file and no corresponding device exists.
878 (This is a Linux kernel bug; in this situation
884 is not set and the named file does not exist.
885 Or, a directory component in
887 does not exist or is a dangling symbolic link.
891 refers to a nonexistent directory,
899 but this kernel version does not provide the
904 Insufficient kernel memory was available.
908 was to be created but the device containing
910 has no room for the new file.
913 A component used as a directory in
915 is not, in fact, a directory, or \fBO_DIRECTORY\fP was specified and
920 .BR O_NONBLOCK " | " O_WRONLY
921 is set, the named file is a FIFO and
922 no process has the file open for reading.
923 Or, the file is a device special file and no corresponding device exists.
926 The filesystem containing
933 refers to a regular file that is too large to be opened.
934 The usual scenario here is that an application compiled
935 on a 32-bit platform without
936 .I -D_FILE_OFFSET_BITS=64
937 tried to open a file whose size exceeds
943 This is the error specified by POSIX.1-2001;
944 in kernels before 2.6.24, Linux gave the error
947 .\" See http://bugzilla.kernel.org/show_bug.cgi?id=7253
948 .\" "Open of a large file on 32-bit fails with EFBIG, should be EOVERFLOW"
949 .\" Reported 2006-10-03
954 flag was specified, but the effective user ID of the caller
955 .\" Strictly speaking, it's the filesystem UID... (MTK)
956 did not match the owner of the file and the caller was not privileged
961 refers to a file on a read-only filesystem and write access was
966 refers to an executable image which is currently being executed and
967 write access was requested.
972 flag was specified, and an incompatible lease was held on the file
976 The following additional errors can occur for
981 is not a valid file descriptor.
987 is a file descriptor referring to a file other than a directory.
990 was added to Linux in kernel 2.6.16;
991 library support was added to glibc in version 2.4.
995 SVr4, 4.3BSD, POSIX.1-2001, POSIX.1-2008.
1006 flags are Linux-specific.
1009 to obtain their definitions.
1016 flags are not specified in POSIX.1-2001,
1017 but are specified in POSIX.1-2008.
1018 Since glibc 2.12, one can obtain their definitions by defining either
1020 with a value greater than or equal to 200809L or
1022 with a value greater than or equal to 700.
1023 In glibc 2.11 and earlier, one obtains the definitions by defining
1027 .BR feature_test_macros (7),
1028 feature test macros such as
1029 .BR _POSIX_C_SOURCE ,
1033 must be defined before including
1039 flag indicates that one wants to open
1040 but does not necessarily have the intention to read or write.
1041 This is typically used to open devices in order to get a file descriptor
1046 The (undefined) effect of
1047 .B O_RDONLY | O_TRUNC
1048 varies among implementations.
1049 On many systems the file is actually truncated.
1050 .\" Linux 2.0, 2.5: truncate
1051 .\" Solaris 5.7, 5.8: truncate
1052 .\" Irix 6.5: truncate
1053 .\" Tru64 5.1B: truncate
1054 .\" HP-UX 11.22: truncate
1055 .\" FreeBSD 4.7: truncate
1059 can open device special files, but
1061 cannot create them; use
1065 If the file is newly created, its
1070 (respectively, time of last access, time of last status change, and
1071 time of last modification; see
1074 to the current time, and so are the
1080 Otherwise, if the file is modified because of the
1082 flag, its st_ctime and st_mtime fields are set to the current time.
1085 .SS Synchronized I/O
1086 The POSIX.1-2008 "synchronized I/O" option
1087 specifies different variants of synchronized I/O,
1095 for controlling the behavior.
1096 Regardless of whether an implementation supports this option,
1097 it must at least support the use of
1107 (Somewhat incorrectly, glibc defines
1109 to have the same value as
1113 provides synchronized I/O
1115 integrity completion,
1116 meaning write operations will flush data and all associated metadata
1117 to the underlying hardware.
1119 provides synchronized I/O
1121 integrity completion,
1122 meaning write operations will flush data
1123 to the underlying hardware,
1124 but will only flush metadata updates that are required
1125 to allow a subsequent read operation to complete successfully.
1126 Data integrity completion can reduce the number of disk operations
1127 that are required for applications that don't need the guarantees
1128 of file integrity completion.
1130 To understand the difference between the the two types of completion,
1131 consider two pieces of file metadata:
1132 the file last modification timestamp
1134 and the file length.
1135 All write operations will update the last file modification timestamp,
1136 but only writes that add data to the end of the
1137 file will change the file length.
1138 The last modification timestamp is not needed to ensure that
1139 a read completes successfully, but the file length is.
1142 would only guarantee to flush updates to the file length metadata
1145 would also always flush the last modification timestamp metadata).
1147 Before Linux 2.6.33, Linux implemented only the
1151 However, when that flag was specified,
1152 most filesystems actually provided the equivalent of synchronized I/O
1154 integrity completion (i.e.,
1156 was actually implemented as the equivalent of
1159 Since Linux 2.6.33, proper
1161 support is provided.
1162 However, to ensure backward binary compatibility,
1164 was defined with the same value as the historical
1168 was defined as a new (two-bit) flag value that includes the
1171 This ensures that applications compiled against
1172 new headers get at least
1174 semantics on pre-2.6.33 kernels.
1178 There are many infelicities in the protocol underlying NFS, affecting
1180 .BR O_SYNC " and " O_NDELAY .
1182 On NFS filesystems with UID mapping enabled,
1185 return a file descriptor but, for example,
1189 This is because the client performs
1192 permissions, but UID mapping is performed by the server upon
1193 read and write requests.
1196 .SS File access mode
1197 Unlike the other values that can be specified in
1202 .BR O_RDONLY ", " O_WRONLY ", and " O_RDWR
1203 do not specify individual bits.
1204 Rather, they define the low order two bits of
1206 and are defined respectively as 0, 1, and 2.
1207 In other words, the combination
1208 .B "O_RDONLY | O_WRONLY"
1209 is a logical error, and certainly does not have the same meaning as
1212 Linux reserves the special, nonstandard access mode 3 (binary 11) in
1215 check for read and write permission on the file and return a descriptor
1216 that can't be used for reading or writing.
1217 This nonstandard access mode is used by some Linux drivers to return a
1218 descriptor that is to be used only for device-specific
1221 .\" See for example util-linux's disk-utils/setfdprm.c
1222 .\" For some background on access mode 3, see
1223 .\" http://thread.gmane.org/gmane.linux.kernel/653123
1224 .\" "[RFC] correct flags to f_mode conversion in __dentry_open"
1225 .\" LKML, 12 Mar 2008
1228 .SS Rationale for openat() and other "directory file descriptor" APIs
1230 and the other system calls and library functions that take
1231 a directory file descriptor argument
1234 .BR fanotify_mark (2),
1242 .BR name_to_handle_at (2),
1253 Here, the explanation is in terms of the
1255 call, but the rationale is analogous for the other interfaces.
1259 allows an application to avoid race conditions that could
1262 to open files in directories other than the current working directory.
1263 These race conditions result from the fact that some component
1264 of the directory prefix given to
1266 could be changed in parallel with the call to
1268 Such races can be avoided by
1269 opening a file descriptor for the target directory,
1270 and then specifying that file descriptor as the
1277 allows the implementation of a per-thread "current working
1278 directory", via file descriptor(s) maintained by the application.
1279 (This functionality can also be obtained by tricks based
1281 .IR /proc/self/fd/ dirfd,
1282 but less efficiently.)
1289 flag may impose alignment restrictions on the length and address
1290 of user-space buffers and the file offset of I/Os.
1292 restrictions vary by filesystem and kernel version and might be
1294 However there is currently no filesystem\-independent
1295 interface for an application to discover these restrictions for a given
1297 Some filesystems provide their own interfaces
1298 for doing so, for example the
1303 Under Linux 2.4, transfer sizes, and the alignment of the user buffer
1304 and the file offset must all be multiples of the logical block size
1306 Under Linux 2.6, alignment to 512-byte boundaries suffices.
1309 I/Os should never be run concurrently with the
1312 if the memory buffer is a private mapping
1313 (i.e., any mapping created with the
1317 this includes memory allocated on the heap and statically allocated buffers).
1318 Any such I/Os, whether submitted via an asynchronous I/O interface or from
1319 another thread in the process,
1320 should be completed before
1323 Failure to do so can result in data corruption and undefined behavior in
1324 parent and child processes.
1325 This restriction does not apply when the memory buffer for the
1327 I/Os was created using
1334 Nor does this restriction apply when the memory buffer has been advised as
1338 ensuring that it will not be available
1344 flag was introduced in SGI IRIX, where it has alignment
1345 restrictions similar to those of Linux 2.4.
1348 call to query appropriate alignments, and sizes.
1349 FreeBSD 4.x introduced
1350 a flag of the same name, but without alignment restrictions.
1353 support was added under Linux in kernel version 2.4.10.
1354 Older Linux kernels simply ignore this flag.
1355 Some filesystems may not implement the flag and
1361 Applications should avoid mixing
1363 and normal I/O to the same file,
1364 and especially to overlapping byte regions in the same file.
1365 Even when the filesystem correctly handles the coherency issues in
1366 this situation, overall I/O throughput is likely to be slower than
1367 using either mode alone.
1368 Likewise, applications should avoid mixing
1370 of files with direct I/O to the same files.
1374 with NFS will differ from local filesystems.
1376 kernels configured in certain ways, may not support this combination.
1377 The NFS protocol does not support passing the flag to the server, so
1379 I/O will bypass the page cache only on the client; the server may
1380 still cache the I/O.
1381 The client asks the server to make the I/O
1382 synchronous to preserve the synchronous semantics of
1384 Some servers will perform poorly under these circumstances, especially
1385 if the I/O size is small.
1386 Some servers may also be configured to
1387 lie to clients about the I/O having reached stable storage; this
1388 will avoid the performance penalty at some risk to data integrity
1389 in the event of server power failure.
1390 The Linux NFS client places no alignment restrictions on
1396 is a potentially powerful tool that should be used with caution.
1397 It is recommended that applications treat use of
1399 as a performance option which is disabled by default.
1402 "The thing that has always disturbed me about O_DIRECT is that the whole
1403 interface is just stupid, and was probably designed by a deranged monkey
1404 on some serious mind-controlling substances."\(emLinus
1407 Currently, it is not possible to enable signal-driven
1414 to enable this flag.
1415 .\" FIXME . Check bugzilla report on open(O_ASYNC)
1416 .\" See http://bugzilla.kernel.org/show_bug.cgi?id=5993
1418 One must check for two different error codes,
1422 when trying to determine whether the kernel supports
1436 .BR open_by_name_at (2),
1445 .BR path_resolution (7),
1448 This page is part of release 3.64 of the Linux
1451 A description of the project,
1452 and information about reporting bugs,
1454 \%http://www.kernel.org/doc/man\-pages/.