1 .\" Copyright (c) 1980, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)open.2 8.2 (Berkeley) 11/16/93
36 .Nd open or create a file for reading, writing or executing
42 .Fn open "const char *path" "int flags" "..."
44 .Fn openat "int fd" "const char *path" "int flags" "..."
46 The file name specified by
49 for either execution or reading and/or writing as specified by the
52 and the file descriptor returned to the calling process.
55 argument may indicate the file is to be
56 created if it does not exist (by specifying the
63 require an additional argument
65 and the file is created with mode
69 and modified by the process' umask value (see
74 function is equivalent to the
76 function except in the case where the
78 specifies a relative path.
83 the file to be opened is determined relative to the directory
84 associated with the file descriptor
86 instead of the current working directory.
89 parameter and the optional fourth parameter correspond exactly to
94 is passed the special value
98 parameter, the current working directory is used
99 and the behavior is identical to a call to
104 is called with an absolute
119 must be strictly relative to a file descriptor
122 must not be an absolute path and must not contain ".." components
123 which cause the path resolution to escape the directory hierarchy
126 Additionally, no symbolic link in
128 may target absolute path or contain escaping ".." components.
134 .Dv vfs.lookup_cap_dotdot
136 MIB is set to zero, ".." components in the paths,
137 used in capability mode,
138 are completely disabled.
140 .Dv vfs.lookup_cap_dotdot_nonlocal
141 MIB is set to zero, ".." is not allowed if found on non-local filesystem.
143 The flags specified are formed by
147 .Bd -literal -offset indent -compact
148 O_RDONLY open for reading only
149 O_WRONLY open for writing only
150 O_RDWR open for reading and writing
151 O_EXEC open for execute only
152 O_SEARCH open for search only, an alias for O_EXEC
153 O_NONBLOCK do not block on open
154 O_APPEND append on each write
155 O_CREAT create file if it does not exist
156 O_TRUNC truncate size to 0
157 O_EXCL error if create and file exists
158 O_SHLOCK atomically obtain a shared lock
159 O_EXLOCK atomically obtain an exclusive lock
160 O_DIRECT eliminate or reduce cache effects
161 O_FSYNC synchronous writes (historical synonym for O_SYNC)
162 O_SYNC synchronous writes
163 O_DSYNC synchronous data writes
164 O_NOFOLLOW do not follow symlinks
167 O_DIRECTORY error if file is not a directory
168 O_CLOEXEC set FD_CLOEXEC upon open
169 O_VERIFY verify the contents of the file
170 O_RESOLVE_BENEATH path resolution must not cross the fd directory
171 O_PATH record only the target path in the opened descriptor
172 O_EMPTY_PATH openat, open file referenced by fd if path is empty
177 set causes each write on the file
178 to be appended to the end.
182 file exists, the file is truncated to zero length.
192 implement a simple exclusive access locking mechanism.
195 is set and the last component of the pathname is
198 will fail even if the symbolic
199 link points to a non-existent name.
202 flag is specified and the
204 system call would result
205 in the process being blocked for some reason (e.g., waiting for
206 carrier on a dialup line),
209 The descriptor remains in non-blocking mode for subsequent operations.
213 is used in the mask, all writes will
214 immediately and synchronously be written to disk.
216 is an historical synonym for
221 is used in the mask, all data and metadata required to read the data will be
222 synchronously written to disk, but changes to metadata such as file access and
223 modification timestamps may be written later.
227 is used in the mask and the target file passed to
229 is a symbolic link then the
233 When opening a file, a lock with
235 semantics can be obtained by setting
237 for a shared lock, or
239 for an exclusive lock.
240 If creating a file with
242 the request for the lock will never fail
243 (provided that the underlying file system supports locking).
246 may be used to minimize or eliminate the cache effects of reading and writing.
247 The system will attempt to avoid caching the data you read or write.
248 If it cannot avoid caching the data,
249 it will minimize the impact the data has on the cache.
250 Use of this flag can drastically reduce performance if not used with care.
253 may be used to ensure the OS does not assign this file as the
254 controlling terminal when it opens a tty device.
255 This is the default on
262 system call will not assign controlling terminals on
266 may be used to ensure the OS restores the terminal attributes when
267 initially opening a TTY.
268 This is the default on
275 on a TTY will always restore default terminal attributes on
279 may be used to ensure the resulting file descriptor refers to a
281 This flag can be used to prevent applications with elevated privileges
282 from opening files which are even unsafe to open with
284 such as device nodes.
289 flag for the newly returned file descriptor.
292 may be used to indicate to the kernel that the contents of the file should
293 be verified before allowing the open to proceed.
296 means is implementation specific.
297 The run-time linker (rtld) uses this flag to ensure shared objects have
298 been verified before operating on them.
300 .Dv O_RESOLVE_BENEATH
303 if any intermediate component of the specified relative path does not
304 reside in the directory hierarchy beneath the starting directory.
305 Absolute paths or even the temporal escape from beneath of the starting
306 directory is not allowed.
312 execute permissions are checked at open time.
315 may not be used for any read operations like
316 .Xr getdirentries 2 .
317 The primary use for this descriptor will be as the lookup descriptor for the
322 returns a file descriptor that can be used as a directory file descriptor for
324 and other system calls taking a file descriptor argument, like
327 The other functionality of the returned file descriptor is limited to
328 the descriptor-level operations.
330 .Bl -tag -width readlinkat(2) -offset indent -compact
332 but advisory locking is not allowed
339 was also specified at open time
354 and any other that operate on file and not on file descriptor (except
359 flag does not prevent non-forced unmount of the volume it belongs to.
361 A file descriptor created with the
363 flag can be opened into normal (operable) file descriptor by
372 Such an open behaves as if the current path of the file referenced by
374 is passed, except that the path walk permissions are not checked.
375 See also the description of
379 and related syscalls.
383 returns a non-negative integer, termed a file descriptor.
384 It returns \-1 on failure.
385 The file pointer used to mark the current position within the
386 file is set to the beginning of the file.
388 If a sleeping open of a device node from
390 is interrupted by a signal, the call always fails with
394 flag is set for the signal.
395 A sleeping open of a fifo (see
397 is restarted as normal.
399 When a new file is created it is given the group of the directory
405 the new descriptor is set to remain open across
414 The system imposes a limit on the number of file descriptors
415 open simultaneously by one process.
418 system call returns the current system limit.
424 return a non-negative integer, termed a file descriptor.
425 They return \-1 on failure, and set
427 to indicate the error.
429 The named file is opened unless:
432 A component of the path prefix is not a directory.
433 .It Bq Er ENAMETOOLONG
434 A component of a pathname exceeded 255 characters,
435 or an entire path name exceeded 1023 characters.
438 is not set and the named file does not exist.
440 A component of the path name that must exist does not exist.
442 Search permission is denied for a component of the path prefix.
444 The required permissions (for reading and/or writing)
445 are denied for the given flags.
448 is specified and write permission is denied.
452 the file does not exist,
453 and the directory in which it is to be created
454 does not permit writing.
457 is specified, the file does not exist, and the directory in which it is to be
458 created has its immutable flag set, see the
460 manual page for more information.
462 The named file has its immutable flag set and the file is to be modified.
464 The named file has its append-only flag set, the file is to be modified, and
470 Too many symbolic links were encountered in translating the pathname.
472 The named file is a directory, and the arguments specify
473 it is to be modified.
475 The named file is a directory, and the flags specified
480 The named file resides on a read-only file system,
481 and the file is to be modified.
484 is specified and the named file would reside on a read-only file system.
486 The process has already reached its limit for open file descriptors.
488 The system file table is full.
491 was specified and the target is a symbolic link.
493 The named file is a character special or block
494 special file, and the device associated with this special file
498 is set, the named file is a fifo,
500 is set, and no process has the file open for reading.
504 operation was interrupted by a signal.
509 is specified but the underlying file system does not support locking.
511 The named file is a special file mounted through a file system that
512 does not support access to it (e.g.\& NFS).
513 .It Bq Er EWOULDBLOCK
519 is specified and the file is locked.
523 the file does not exist,
524 and the directory in which the entry for the new file is being placed
525 cannot be extended because there is no space left on the file
526 system containing the directory.
530 the file does not exist,
531 and there are no free inodes on the file system on which the
532 file is being created.
536 the file does not exist,
537 and the directory in which the entry for the new file
538 is being placed cannot be extended because the
539 user's quota of disk blocks on the file system
540 containing the directory has been exhausted.
544 the file does not exist,
545 and the user's quota of inodes on the file system on
546 which the file is being created has been exhausted.
548 An I/O error occurred while making the directory entry or
549 allocating the inode for
552 Corrupted data was detected while reading from the file system.
554 The file is a pure procedure (shared text) file that is being
557 system call requests write access.
562 points outside the process's allocated address space.
567 were specified and the file exists.
569 An attempt was made to open a socket (not currently implemented).
571 An attempt was made to open a descriptor with an illegal combination
583 .Dv O_RESOLVE_BENEATH
584 flag is specified and
590 argument does not specify an absolute path and the
595 nor a valid file descriptor open for searching.
599 argument is not an absolute path and
603 nor a file descriptor associated with a directory.
606 is specified and the file is not a directory.
609 is specified and the process is in capability mode.
612 was called and the process is in capability mode.
613 .It Bq Er ENOTCAPABLE
616 or contained a ".." component leading to a
617 directory outside of the directory hierarchy specified by
619 and the process is in capability mode.
620 .It Bq Er ENOTCAPABLE
622 .Dv O_RESOLVE_BENEATH
623 flag was provided, and the relative
635 .Xr getdtablesize 2 ,
645 These functions are specified by
651 .Er EMLINK instead of
657 is set in flags and the final component of pathname is a symbolic link
658 to distinguish it from the case of too many symbolic link traversals
659 in one of its non-final components.
667 function was introduced in
672 The Open Group Extended API Set 2 specification requires that the test
675 is searchable is based on whether
677 is open for searching, not whether the underlying directory currently
679 The present implementation of the
681 checks the current permissions of directory instead.
685 argument is variadic and may result in different calling conventions
686 than might otherwise be expected.