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