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 February 23, 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 .Ed
 172 .Pp
 173 Opening a file with
 174 .Dv O_APPEND
 175 set causes each write on the file
 176 to be appended to the end.
 177 If
 178 .Dv O_TRUNC
 179 is specified and the
 180 file exists, the file is truncated to zero length.
 181 If
 182 .Dv O_EXCL
 183 is set with
 184 .Dv O_CREAT
 185 and the file already
 186 exists,
 187 .Fn open
 188 returns an error.
 189 This may be used to
 190 implement a simple exclusive access locking mechanism.
 191 If
 192 .Dv O_EXCL
 193 is set and the last component of the pathname is
 194 a symbolic link,
 195 .Fn open
 196 will fail even if the symbolic
 197 link points to a non-existent name.
 198 If the
 199 .Dv O_NONBLOCK
 200 flag is specified and the
 201 .Fn open
 202 system call would result
 203 in the process being blocked for some reason (e.g., waiting for
 204 carrier on a dialup line),
 205 .Fn open
 206 returns immediately.
 207 The descriptor remains in non-blocking mode for subsequent operations.
 208 .Pp
 209 If
 210 .Dv O_SYNC
 211 is used in the mask, all writes will
 212 immediately and synchronously be written to disk.
 213 .Dv O_FSYNC
 214 is an historical synonym for
 215 .Dv O_SYNC .
 216 .Pp
 217 If
 218 .Dv O_DSYNC
 219 is used in the mask, all data and metadata required to read the data will be
 220 synchronously written to disk, but changes to metadata such as file access and
 221 modification timestamps may be written later.
 222 .Pp
 223 If
 224 .Dv O_NOFOLLOW
 225 is used in the mask and the target file passed to
 226 .Fn open
 227 is a symbolic link then the
 228 .Fn open
 229 will fail.
 230 .Pp
 231 When opening a file, a lock with
 232 .Xr flock 2
 233 semantics can be obtained by setting
 234 .Dv O_SHLOCK
 235 for a shared lock, or
 236 .Dv O_EXLOCK
 237 for an exclusive lock.
 238 If creating a file with
 239 .Dv O_CREAT ,
 240 the request for the lock will never fail
 241 (provided that the underlying file system supports locking).
 242 .Pp
 243 .Dv O_DIRECT
 244 may be used to minimize or eliminate the cache effects of reading and writing.
 245 The system will attempt to avoid caching the data you read or write.
 246 If it cannot avoid caching the data,
 247 it will minimize the impact the data has on the cache.
 248 Use of this flag can drastically reduce performance if not used with care.
 249 .Pp
 250 .Dv O_NOCTTY
 251 may be used to ensure the OS does not assign this file as the
 252 controlling terminal when it opens a tty device.
 253 This is the default on
 254 .Fx ,
 255 but is present for
 256 .Tn POSIX
 257 compatibility.
 258 The
 259 .Fn open
 260 system call will not assign controlling terminals on
 261 .Fx .
 262 .Pp
 263 .Dv O_TTY_INIT
 264 may be used to ensure the OS restores the terminal attributes when
 265 initially opening a TTY.
 266 This is the default on
 267 .Fx ,
 268 but is present for
 269 .Tn POSIX
 270 compatibility.
 271 The initial call to
 272 .Fn open
 273 on a TTY will always restore default terminal attributes on
 274 .Fx .
 275 .Pp
 276 .Dv O_DIRECTORY
 277 may be used to ensure the resulting file descriptor refers to a
 278 directory.
 279 This flag can be used to prevent applications with elevated privileges
 280 from opening files which are even unsafe to open with
 281 .Dv O_RDONLY ,
 282 such as device nodes.
 283 .Pp
 284 .Dv O_CLOEXEC
 285 may be used to set
 286 .Dv FD_CLOEXEC
 287 flag for the newly returned file descriptor.
 288 .Pp
 289 .Dv O_VERIFY
 290 may be used to indicate to the kernel that the contents of the file should
 291 be verified before allowing the open to proceed.
 292 The details of what
 293 .Dq verified
 294 means is implementation specific.
 295 The run-time linker (rtld) uses this flag to ensure shared objects have
 296 been verified before operating on them.
 297 .Pp
 298 .Dv O_RESOLVE_BENEATH
 299 returns
 300 .Er ENOTCAPABLE
 301 if any intermediate component of the specified relative path does not
 302 reside in the directory hierarchy beneath the starting directory.
 303 Absolute paths or even the temporal escape from beneath of the starting
 304 directory is not allowed.
 305 .Pp
 306 When
 307 .Fa fd
 308 is opened with
 309 .Dv O_SEARCH ,
 310 execute permissions are checked at open time.
 311 The
 312 .Fa fd
 313 may not be used for any read operations like
 314 .Xr getdirentries 2 .
 315 The primary use for this descriptor will be as the lookup descriptor for the
 316 .Fn *at
 317 family of functions.
 318 .Pp
 319 If successful,
 320 .Fn open
 321 returns a non-negative integer, termed a file descriptor.
 322 It returns \-1 on failure.
 323 The file pointer used to mark the current position within the
 324 file is set to the beginning of the file.
 325 .Pp
 326 If a sleeping open of a device node from
 327 .Xr devfs 5
 328 is interrupted by a signal, the call always fails with
 329 .Er EINTR ,
 330 even if the
 331 .Dv SA_RESTART
 332 flag is set for the signal.
 333 A sleeping open of a fifo (see
 334 .Xr mkfifo 2 )
 335 is restarted as normal.
 336 .Pp
 337 When a new file is created it is given the group of the directory
 338 which contains it.
 339 .Pp
 340 Unless
 341 .Dv O_CLOEXEC
 342 flag was specified,
 343 the new descriptor is set to remain open across
 344 .Xr execve 2
 345 system calls; see
 346 .Xr close 2 ,
 347 .Xr fcntl 2
 348 and
 349 .Dv O_CLOEXEC
 350 description.
 351 .Pp
 352 The system imposes a limit on the number of file descriptors
 353 open simultaneously by one process.
 354 The
 355 .Xr getdtablesize 2
 356 system call returns the current system limit.
 357 .Sh RETURN VALUES
 358 If successful,
 359 .Fn open
 360 and
 361 .Fn openat
 362 return a non-negative integer, termed a file descriptor.
 363 They return \-1 on failure, and set
 364 .Va errno
 365 to indicate the error.
 366 .Sh ERRORS
 367 The named file is opened unless:
 368 .Bl -tag -width Er
 369 .It Bq Er ENOTDIR
 370 A component of the path prefix is not a directory.
 371 .It Bq Er ENAMETOOLONG
 372 A component of a pathname exceeded 255 characters,
 373 or an entire path name exceeded 1023 characters.
 374 .It Bq Er ENOENT
 375 .Dv O_CREAT
 376 is not set and the named file does not exist.
 377 .It Bq Er ENOENT
 378 A component of the path name that must exist does not exist.
 379 .It Bq Er EACCES
 380 Search permission is denied for a component of the path prefix.
 381 .It Bq Er EACCES
 382 The required permissions (for reading and/or writing)
 383 are denied for the given flags.
 384 .It Bq Er EACCES
 385 .Dv O_TRUNC
 386 is specified and write permission is denied.
 387 .It Bq Er EACCES
 388 .Dv O_CREAT
 389 is specified,
 390 the file does not exist,
 391 and the directory in which it is to be created
 392 does not permit writing.
 393 .It Bq Er EPERM
 394 .Dv O_CREAT
 395 is specified, the file does not exist, and the directory in which it is to be
 396 created has its immutable flag set, see the
 397 .Xr chflags 2
 398 manual page for more information.
 399 .It Bq Er EPERM
 400 The named file has its immutable flag set and the file is to be modified.
 401 .It Bq Er EPERM
 402 The named file has its append-only flag set, the file is to be modified, and
 403 .Dv O_TRUNC
 404 is specified or
 405 .Dv O_APPEND
 406 is not specified.
 407 .It Bq Er ELOOP
 408 Too many symbolic links were encountered in translating the pathname.
 409 .It Bq Er EISDIR
 410 The named file is a directory, and the arguments specify
 411 it is to be modified.
 412 .It Bq Er EISDIR
 413 The named file is a directory, and the flags specified
 414 .Dv O_CREAT
 415 without
 416 .Dv O_DIRECTORY .
 417 .It Bq Er EROFS
 418 The named file resides on a read-only file system,
 419 and the file is to be modified.
 420 .It Bq Er EROFS
 421 .Dv O_CREAT
 422 is specified and the named file would reside on a read-only file system.
 423 .It Bq Er EMFILE
 424 The process has already reached its limit for open file descriptors.
 425 .It Bq Er ENFILE
 426 The system file table is full.
 427 .It Bq Er EMLINK
 428 .Dv O_NOFOLLOW
 429 was specified and the target is a symbolic link.
 430 .It Bq Er ENXIO
 431 The named file is a character special or block
 432 special file, and the device associated with this special file
 433 does not exist.
 434 .It Bq Er ENXIO
 435 .Dv O_NONBLOCK
 436 is set, the named file is a fifo,
 437 .Dv O_WRONLY
 438 is set, and no process has the file open for reading.
 439 .It Bq Er EINTR
 440 The
 441 .Fn open
 442 operation was interrupted by a signal.
 443 .It Bq Er EOPNOTSUPP
 444 .Dv O_SHLOCK
 445 or
 446 .Dv O_EXLOCK
 447 is specified but the underlying file system does not support locking.
 448 .It Bq Er EOPNOTSUPP
 449 The named file is a special file mounted through a file system that
 450 does not support access to it (e.g.\& NFS).
 451 .It Bq Er EWOULDBLOCK
 452 .Dv O_NONBLOCK
 453 and one of
 454 .Dv O_SHLOCK
 455 or
 456 .Dv O_EXLOCK
 457 is specified and the file is locked.
 458 .It Bq Er ENOSPC
 459 .Dv O_CREAT
 460 is specified,
 461 the file does not exist,
 462 and the directory in which the entry for the new file is being placed
 463 cannot be extended because there is no space left on the file
 464 system containing the directory.
 465 .It Bq Er ENOSPC
 466 .Dv O_CREAT
 467 is specified,
 468 the file does not exist,
 469 and there are no free inodes on the file system on which the
 470 file is being created.
 471 .It Bq Er EDQUOT
 472 .Dv O_CREAT
 473 is specified,
 474 the file does not exist,
 475 and the directory in which the entry for the new file
 476 is being placed cannot be extended because the
 477 user's quota of disk blocks on the file system
 478 containing the directory has been exhausted.
 479 .It Bq Er EDQUOT
 480 .Dv O_CREAT
 481 is specified,
 482 the file does not exist,
 483 and the user's quota of inodes on the file system on
 484 which the file is being created has been exhausted.
 485 .It Bq Er EIO
 486 An I/O error occurred while making the directory entry or
 487 allocating the inode for
 488 .Dv O_CREAT .
 489 .It Bq Er EINTEGRITY
 490 Corrupted data was detected while reading from the file system.
 491 .It Bq Er ETXTBSY
 492 The file is a pure procedure (shared text) file that is being
 493 executed and the
 494 .Fn open
 495 system call requests write access.
 496 .It Bq Er EFAULT
 497 The
 498 .Fa path
 499 argument
 500 points outside the process's allocated address space.
 501 .It Bq Er EEXIST
 502 .Dv O_CREAT
 503 and
 504 .Dv O_EXCL
 505 were specified and the file exists.
 506 .It Bq Er EOPNOTSUPP
 507 An attempt was made to open a socket (not currently implemented).
 508 .It Bq Er EINVAL
 509 An attempt was made to open a descriptor with an illegal combination
 510 of
 511 .Dv O_RDONLY ,
 512 .Dv O_WRONLY ,
 513 or
 514 .Dv O_RDWR ,
 515 and
 516 .Dv O_EXEC
 517 or
 518 .Dv O_SEARCH .
 519 .It Bq Er EINVAL
 520 The
 521 .Dv O_RESOLVE_BENEATH
 522 flag is specified and
 523 .Dv path
 524 is absolute.
 525 .It Bq Er EBADF
 526 The
 527 .Fa path
 528 argument does not specify an absolute path and the
 529 .Fa fd
 530 argument is
 531 neither
 532 .Dv AT_FDCWD
 533 nor a valid file descriptor open for searching.
 534 .It Bq Er ENOTDIR
 535 The
 536 .Fa path
 537 argument is not an absolute path and
 538 .Fa fd
 539 is neither
 540 .Dv AT_FDCWD
 541 nor a file descriptor associated with a directory.
 542 .It Bq Er ENOTDIR
 543 .Dv O_DIRECTORY
 544 is specified and the file is not a directory.
 545 .It Bq Er ECAPMODE
 546 .Dv AT_FDCWD
 547 is specified and the process is in capability mode.
 548 .It Bq Er ECAPMODE
 549 .Fn open
 550 was called and the process is in capability mode.
 551 .It Bq Er ENOTCAPABLE
 552 .Fa path
 553 is an absolute path,
 554 or contained a ".." component leading to a
 555 directory outside of the directory hierarchy specified by
 556 .Fa fd ,
 557 and the process is in capability mode.
 558 .It Bq Er ENOTCAPABLE
 559 The
 560 .Dv O_RESOLVE_BENEATH
 561 flag was provided, and the relative
 562 .Fa path
 563 escapes the
 564 .Ar fd
 565 directory.
 566 .El
 567 .Sh SEE ALSO
 568 .Xr chmod 2 ,
 569 .Xr close 2 ,
 570 .Xr dup 2 ,
 571 .Xr fexecve 2 ,
 572 .Xr fhopen 2 ,
 573 .Xr getdtablesize 2 ,
 574 .Xr getfh 2 ,
 575 .Xr lgetfh 2 ,
 576 .Xr lseek 2 ,
 577 .Xr read 2 ,
 578 .Xr umask 2 ,
 579 .Xr write 2 ,
 580 .Xr fopen 3 ,
 581 .Xr capsicum 4
 582 .Sh STANDARDS
 583 These functions are specified by
 584 .St -p1003.1-2008 .
 585 .Fx
 586 sets
 587 .Va errno
 588 to
 589 .Er EMLINK instead of
 590 .Er ELOOP
 591 as specified by
 592 .Tn POSIX
 593 when
 594 .Dv O_NOFOLLOW
 595 is set in flags and the final component of pathname is a symbolic link
 596 to distinguish it from the case of too many symbolic link traversals
 597 in one of its non-final components.
 598 .Sh HISTORY
 599 The
 600 .Fn open
 601 function appeared in
 602 .At v1 .
 603 The
 604 .Fn openat
 605 function was introduced in
 606 .Fx 8.0 .
 607 .Dv O_DSYNC
 608 appeared in 13.0.
 609 .Sh BUGS
 610 The Open Group Extended API Set 2 specification requires that the test
 611 for whether
 612 .Fa fd
 613 is searchable is based on whether
 614 .Fa fd
 615 is open for searching, not whether the underlying directory currently
 616 permits searches.
 617 The present implementation of the
 618 .Fa openat
 619 checks the current permissions of directory instead.
 620 .Pp
 621 The
 622 .Fa mode
 623 argument is variadic and may result in different calling conventions
 624 than might otherwise be expected.