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