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