lib/libc/sys/open.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  15 .\"
  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
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)open.2      8.2 (Berkeley) 11/16/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd October 9, 2021
  32 .Dt OPEN 2
  33 .Os
  34 .Sh NAME
  35 .Nm open , openat
  36 .Nd open or create a file for reading, writing or executing
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In fcntl.h
  41 .Ft int
  42 .Fn open "const char *path" "int flags" "..."
  43 .Ft int
  44 .Fn openat "int fd" "const char *path" "int flags" "..."
  45 .Sh DESCRIPTION
  46 The file name specified by
  47 .Fa path
  48 is opened
  49 for either execution or reading and/or writing as specified by the
  50 argument
  51 .Fa flags
  52 and the file descriptor returned to the calling process.
  53 The
  54 .Fa flags
  55 argument may indicate the file is to be
  56 created if it does not exist (by specifying the
  57 .Dv O_CREAT
  58 flag).
  59 In this case
  60 .Fn open
  61 and
  62 .Fn openat
  63 require an additional argument
  64 .Fa "mode_t mode" ,
  65 and the file is created with mode
  66 .Fa mode
  67 as described in
  68 .Xr chmod 2
  69 and modified by the process' umask value (see
  70 .Xr umask 2 ) .
  71 .Pp
  72 The
  73 .Fn openat
  74 function is equivalent to the
  75 .Fn open
  76 function except in the case where the
  77 .Fa path
  78 specifies a relative path.
  79 For
  80 .Fn openat
  81 and relative
  82 .Fa path ,
  83 the file to be opened is determined relative to the directory
  84 associated with the file descriptor
  85 .Fa fd
  86 instead of the current working directory.
  87 The
  88 .Fa flag
  89 parameter and the optional fourth parameter correspond exactly to
  90 the parameters of
  91 .Fn open .
  92 If
  93 .Fn openat
  94 is passed the special value
  95 .Dv AT_FDCWD
  96 in the
  97 .Fa fd
  98 parameter, the current working directory is used
  99 and the behavior is identical to a call to
 100 .Fn open .
 101 .Pp
 102 When
 103 .Fn openat
 104 is called with an absolute
 105 .Fa path ,
 106 it ignores the
 107 .Fa fd
 108 argument.
 109 .Pp
 110 In
 111 .Xr capsicum 4
 112 capability mode,
 113 .Fn open
 114 is not permitted.
 115 The
 116 .Fa path
 117 argument to
 118 .Fn openat
 119 must be strictly relative to a file descriptor
 120 .Fa fd .
 121 .Fa path
 122 must not be an absolute path and must not contain ".." components
 123 which cause the path resolution to escape the directory hierarchy
 124 starting at
 125 .Fa fd .
 126 Additionally, no symbolic link in
 127 .Fa path
 128 may target absolute path or contain escaping ".." components.
 129 .Fa fd
 130 must not be
 131 .Dv AT_FDCWD .
 132 .Pp
 133 If the
 134 .Dv vfs.lookup_cap_dotdot
 135 .Xr sysctl 3
 136 MIB is set to zero, ".." components in the paths,
 137 used in capability mode,
 138 are completely disabled.
 139 If the
 140 .Dv vfs.lookup_cap_dotdot_nonlocal
 141 MIB is set to zero, ".." is not allowed if found on non-local filesystem.
 142 .Pp
 143 The flags specified are formed by
 144 .Em or Ns 'ing
 145 the following values
 146 .Pp
 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
 165 O_NOCTTY        ignored
 166 O_TTY_INIT      ignored
 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
 173 .Ed
 174 .Pp
 175 Opening a file with
 176 .Dv O_APPEND
 177 set causes each write on the file
 178 to be appended to the end.
 179 If
 180 .Dv O_TRUNC
 181 is specified and the
 182 file exists, the file is truncated to zero length.
 183 If
 184 .Dv O_EXCL
 185 is set with
 186 .Dv O_CREAT
 187 and the file already
 188 exists,
 189 .Fn open
 190 returns an error.
 191 This may be used to
 192 implement a simple exclusive access locking mechanism.
 193 If
 194 .Dv O_EXCL
 195 is set and the last component of the pathname is
 196 a symbolic link,
 197 .Fn open
 198 will fail even if the symbolic
 199 link points to a non-existent name.
 200 If the
 201 .Dv O_NONBLOCK
 202 flag is specified and the
 203 .Fn open
 204 system call would result
 205 in the process being blocked for some reason (e.g., waiting for
 206 carrier on a dialup line),
 207 .Fn open
 208 returns immediately.
 209 The descriptor remains in non-blocking mode for subsequent operations.
 210 .Pp
 211 If
 212 .Dv O_SYNC
 213 is used in the mask, all writes will
 214 immediately and synchronously be written to disk.
 215 .Dv O_FSYNC
 216 is an historical synonym for
 217 .Dv O_SYNC .
 218 .Pp
 219 If
 220 .Dv O_DSYNC
 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.
 224 .Pp
 225 If
 226 .Dv O_NOFOLLOW
 227 is used in the mask and the target file passed to
 228 .Fn open
 229 is a symbolic link then the
 230 .Fn open
 231 will fail.
 232 .Pp
 233 When opening a file, a lock with
 234 .Xr flock 2
 235 semantics can be obtained by setting
 236 .Dv O_SHLOCK
 237 for a shared lock, or
 238 .Dv O_EXLOCK
 239 for an exclusive lock.
 240 If creating a file with
 241 .Dv O_CREAT ,
 242 the request for the lock will never fail
 243 (provided that the underlying file system supports locking).
 244 .Pp
 245 .Dv O_DIRECT
 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.
 251 .Pp
 252 .Dv O_NOCTTY
 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
 256 .Fx ,
 257 but is present for
 258 .Tn POSIX
 259 compatibility.
 260 The
 261 .Fn open
 262 system call will not assign controlling terminals on
 263 .Fx .
 264 .Pp
 265 .Dv O_TTY_INIT
 266 may be used to ensure the OS restores the terminal attributes when
 267 initially opening a TTY.
 268 This is the default on
 269 .Fx ,
 270 but is present for
 271 .Tn POSIX
 272 compatibility.
 273 The initial call to
 274 .Fn open
 275 on a TTY will always restore default terminal attributes on
 276 .Fx .
 277 .Pp
 278 .Dv O_DIRECTORY
 279 may be used to ensure the resulting file descriptor refers to a
 280 directory.
 281 This flag can be used to prevent applications with elevated privileges
 282 from opening files which are even unsafe to open with
 283 .Dv O_RDONLY ,
 284 such as device nodes.
 285 .Pp
 286 .Dv O_CLOEXEC
 287 may be used to set
 288 .Dv FD_CLOEXEC
 289 flag for the newly returned file descriptor.
 290 .Pp
 291 .Dv O_VERIFY
 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.
 294 The details of what
 295 .Dq verified
 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.
 299 .Pp
 300 .Dv O_RESOLVE_BENEATH
 301 returns
 302 .Er ENOTCAPABLE
 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.
 307 .Pp
 308 When
 309 .Fa fd
 310 is opened with
 311 .Dv O_SEARCH ,
 312 execute permissions are checked at open time.
 313 The
 314 .Fa fd
 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
 318 .Fn *at
 319 family of functions.
 320 .Pp
 321 .Dv O_PATH
 322 returns a file descriptor that can be used as a directory file descriptor for
 323 .Xr openat 2
 324 and other system calls taking a file descriptor argument, like
 325 .Xr fstatat 2
 326 and others.
 327 The other functionality of the returned file descriptor is limited to
 328 the descriptor-level operations.
 329 It can be used for
 330 .Bl -tag -width readlinkat(2) -offset indent -compact
 331 .It Xr fcntl 2
 332 but advisory locking is not allowed
 333 .It Xr dup 2
 334 .It Xr close 2
 335 .It Xr fstat 2
 336 .It Xr fexecve 2
 337 requires that
 338 .Dv O_EXEC
 339 was also specified at open time
 340 .It Dv SCM_RIGHTS
 341 can be passed over a
 342 .Xr unix 4
 343 socket using a
 344 .Dv SCM_RIGHTS
 345 message
 346 .It Xr kqueue 2
 347 using for
 348 .Dv EVFILT_VNODE
 349 .It Xr readlinkat 2
 350 .El
 351 But operations like
 352 .Xr read 2 ,
 353 .Xr ftruncate 2 ,
 354 and any other that operate on file and not on file descriptor (except
 355 .Xr fstat 2 ),
 356 are not allowed.
 357 File opened with the
 358 .Dv O_PATH
 359 flag does not prevent non-forced unmount of the volume it belongs to.
 360 .Pp
 361 A file descriptor created with the
 362 .Dv O_PATH
 363 flag can be opened into normal (operable) file descriptor by
 364 specifying it as the
 365 .Fa fd
 366 argument to
 367 .Fn openat
 368 with empty
 369 .Fa path
 370 and flag
 371 .Dv O_EMPTY_PATH .
 372 Such an open behaves as if the current path of the file referenced by
 373 .Fa fd
 374 is passed, except that the path walk permissions are not checked.
 375 See also the description of
 376 .Dv AT_EMPTY_PATH
 377 flag for
 378 .Xr fstatat 2
 379 and related syscalls.
 380 .Pp
 381 If successful,
 382 .Fn open
 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.
 387 .Pp
 388 If a sleeping open of a device node from
 389 .Xr devfs 5
 390 is interrupted by a signal, the call always fails with
 391 .Er EINTR ,
 392 even if the
 393 .Dv SA_RESTART
 394 flag is set for the signal.
 395 A sleeping open of a fifo (see
 396 .Xr mkfifo 2 )
 397 is restarted as normal.
 398 .Pp
 399 When a new file is created it is given the group of the directory
 400 which contains it.
 401 .Pp
 402 Unless
 403 .Dv O_CLOEXEC
 404 flag was specified,
 405 the new descriptor is set to remain open across
 406 .Xr execve 2
 407 system calls; see
 408 .Xr close 2 ,
 409 .Xr fcntl 2
 410 and
 411 .Dv O_CLOEXEC
 412 description.
 413 .Pp
 414 The system imposes a limit on the number of file descriptors
 415 open simultaneously by one process.
 416 The
 417 .Xr getdtablesize 2
 418 system call returns the current system limit.
 419 .Sh RETURN VALUES
 420 If successful,
 421 .Fn open
 422 and
 423 .Fn openat
 424 return a non-negative integer, termed a file descriptor.
 425 They return \-1 on failure, and set
 426 .Va errno
 427 to indicate the error.
 428 .Sh ERRORS
 429 The named file is opened unless:
 430 .Bl -tag -width Er
 431 .It Bq Er ENOTDIR
 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.
 436 .It Bq Er ENOENT
 437 .Dv O_CREAT
 438 is not set and the named file does not exist.
 439 .It Bq Er ENOENT
 440 A component of the path name that must exist does not exist.
 441 .It Bq Er EACCES
 442 Search permission is denied for a component of the path prefix.
 443 .It Bq Er EACCES
 444 The required permissions (for reading and/or writing)
 445 are denied for the given flags.
 446 .It Bq Er EACCES
 447 .Dv O_TRUNC
 448 is specified and write permission is denied.
 449 .It Bq Er EACCES
 450 .Dv O_CREAT
 451 is specified,
 452 the file does not exist,
 453 and the directory in which it is to be created
 454 does not permit writing.
 455 .It Bq Er EPERM
 456 .Dv O_CREAT
 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
 459 .Xr chflags 2
 460 manual page for more information.
 461 .It Bq Er EPERM
 462 The named file has its immutable flag set and the file is to be modified.
 463 .It Bq Er EPERM
 464 The named file has its append-only flag set, the file is to be modified, and
 465 .Dv O_TRUNC
 466 is specified or
 467 .Dv O_APPEND
 468 is not specified.
 469 .It Bq Er ELOOP
 470 Too many symbolic links were encountered in translating the pathname.
 471 .It Bq Er EISDIR
 472 The named file is a directory, and the arguments specify
 473 it is to be modified.
 474 .It Bq Er EISDIR
 475 The named file is a directory, and the flags specified
 476 .Dv O_CREAT
 477 without
 478 .Dv O_DIRECTORY .
 479 .It Bq Er EROFS
 480 The named file resides on a read-only file system,
 481 and the file is to be modified.
 482 .It Bq Er EROFS
 483 .Dv O_CREAT
 484 is specified and the named file would reside on a read-only file system.
 485 .It Bq Er EMFILE
 486 The process has already reached its limit for open file descriptors.
 487 .It Bq Er ENFILE
 488 The system file table is full.
 489 .It Bq Er EMLINK
 490 .Dv O_NOFOLLOW
 491 was specified and the target is a symbolic link.
 492 .It Bq Er ENXIO
 493 The named file is a character special or block
 494 special file, and the device associated with this special file
 495 does not exist.
 496 .It Bq Er ENXIO
 497 .Dv O_NONBLOCK
 498 is set, the named file is a fifo,
 499 .Dv O_WRONLY
 500 is set, and no process has the file open for reading.
 501 .It Bq Er EINTR
 502 The
 503 .Fn open
 504 operation was interrupted by a signal.
 505 .It Bq Er EOPNOTSUPP
 506 .Dv O_SHLOCK
 507 or
 508 .Dv O_EXLOCK
 509 is specified but the underlying file system does not support locking.
 510 .It Bq Er EOPNOTSUPP
 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
 514 .Dv O_NONBLOCK
 515 and one of
 516 .Dv O_SHLOCK
 517 or
 518 .Dv O_EXLOCK
 519 is specified and the file is locked.
 520 .It Bq Er ENOSPC
 521 .Dv O_CREAT
 522 is specified,
 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.
 527 .It Bq Er ENOSPC
 528 .Dv O_CREAT
 529 is specified,
 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.
 533 .It Bq Er EDQUOT
 534 .Dv O_CREAT
 535 is specified,
 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.
 541 .It Bq Er EDQUOT
 542 .Dv O_CREAT
 543 is specified,
 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.
 547 .It Bq Er EIO
 548 An I/O error occurred while making the directory entry or
 549 allocating the inode for
 550 .Dv O_CREAT .
 551 .It Bq Er EINTEGRITY
 552 Corrupted data was detected while reading from the file system.
 553 .It Bq Er ETXTBSY
 554 The file is a pure procedure (shared text) file that is being
 555 executed and the
 556 .Fn open
 557 system call requests write access.
 558 .It Bq Er EFAULT
 559 The
 560 .Fa path
 561 argument
 562 points outside the process's allocated address space.
 563 .It Bq Er EEXIST
 564 .Dv O_CREAT
 565 and
 566 .Dv O_EXCL
 567 were specified and the file exists.
 568 .It Bq Er EOPNOTSUPP
 569 An attempt was made to open a socket (not currently implemented).
 570 .It Bq Er EINVAL
 571 An attempt was made to open a descriptor with an illegal combination
 572 of
 573 .Dv O_RDONLY ,
 574 .Dv O_WRONLY ,
 575 or
 576 .Dv O_RDWR ,
 577 and
 578 .Dv O_EXEC
 579 or
 580 .Dv O_SEARCH .
 581 .It Bq Er EINVAL
 582 The
 583 .Dv O_RESOLVE_BENEATH
 584 flag is specified and
 585 .Dv path
 586 is absolute.
 587 .It Bq Er EBADF
 588 The
 589 .Fa path
 590 argument does not specify an absolute path and the
 591 .Fa fd
 592 argument is
 593 neither
 594 .Dv AT_FDCWD
 595 nor a valid file descriptor open for searching.
 596 .It Bq Er ENOTDIR
 597 The
 598 .Fa path
 599 argument is not an absolute path and
 600 .Fa fd
 601 is neither
 602 .Dv AT_FDCWD
 603 nor a file descriptor associated with a directory.
 604 .It Bq Er ENOTDIR
 605 .Dv O_DIRECTORY
 606 is specified and the file is not a directory.
 607 .It Bq Er ECAPMODE
 608 .Dv AT_FDCWD
 609 is specified and the process is in capability mode.
 610 .It Bq Er ECAPMODE
 611 .Fn open
 612 was called and the process is in capability mode.
 613 .It Bq Er ENOTCAPABLE
 614 .Fa path
 615 is an absolute path,
 616 or contained a ".." component leading to a
 617 directory outside of the directory hierarchy specified by
 618 .Fa fd ,
 619 and the process is in capability mode.
 620 .It Bq Er ENOTCAPABLE
 621 The
 622 .Dv O_RESOLVE_BENEATH
 623 flag was provided, and the relative
 624 .Fa path
 625 escapes the
 626 .Ar fd
 627 directory.
 628 .El
 629 .Sh SEE ALSO
 630 .Xr chmod 2 ,
 631 .Xr close 2 ,
 632 .Xr dup 2 ,
 633 .Xr fexecve 2 ,
 634 .Xr fhopen 2 ,
 635 .Xr getdtablesize 2 ,
 636 .Xr getfh 2 ,
 637 .Xr lgetfh 2 ,
 638 .Xr lseek 2 ,
 639 .Xr read 2 ,
 640 .Xr umask 2 ,
 641 .Xr write 2 ,
 642 .Xr fopen 3 ,
 643 .Xr capsicum 4
 644 .Sh STANDARDS
 645 These functions are specified by
 646 .St -p1003.1-2008 .
 647 .Fx
 648 sets
 649 .Va errno
 650 to
 651 .Er EMLINK instead of
 652 .Er ELOOP
 653 as specified by
 654 .Tn POSIX
 655 when
 656 .Dv O_NOFOLLOW
 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.
 660 .Sh HISTORY
 661 The
 662 .Fn open
 663 function appeared in
 664 .At v1 .
 665 The
 666 .Fn openat
 667 function was introduced in
 668 .Fx 8.0 .
 669 .Dv O_DSYNC
 670 appeared in 13.0.
 671 .Sh BUGS
 672 The Open Group Extended API Set 2 specification requires that the test
 673 for whether
 674 .Fa fd
 675 is searchable is based on whether
 676 .Fa fd
 677 is open for searching, not whether the underlying directory currently
 678 permits searches.
 679 The present implementation of the
 680 .Fa openat
 681 checks the current permissions of directory instead.
 682 .Pp
 683 The
 684 .Fa mode
 685 argument is variadic and may result in different calling conventions
 686 than might otherwise be expected.