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