sys/sys/fcntl.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1983, 1990, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)fcntl.h     8.3 (Berkeley) 1/21/94
  37  * $FreeBSD$
  38  */
  39
  40 #ifndef _SYS_FCNTL_H_
  41 #define _SYS_FCNTL_H_
  42
  43 /*
  44  * This file includes the definitions for open and fcntl
  45  * described by POSIX for <fcntl.h>; it also includes
  46  * related kernel definitions.
  47  */
  48
  49 #include <sys/cdefs.h>
  50 #include <sys/_types.h>
  51
  52 #ifndef _MODE_T_DECLARED
  53 typedef __mode_t        mode_t;
  54 #define _MODE_T_DECLARED
  55 #endif
  56
  57 #ifndef _OFF_T_DECLARED
  58 typedef __off_t         off_t;
  59 #define _OFF_T_DECLARED
  60 #endif
  61
  62 #ifndef _PID_T_DECLARED
  63 typedef __pid_t         pid_t;
  64 #define _PID_T_DECLARED
  65 #endif
  66
  67 /*
  68  * File status flags: these are used by open(2), fcntl(2).
  69  * They are also used (indirectly) in the kernel file structure f_flags,
  70  * which is a superset of the open/fcntl flags.  Open flags and f_flags
  71  * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
  72  * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
  73  */
  74 /* open-only flags */
  75 #define O_RDONLY        0x0000          /* open for reading only */
  76 #define O_WRONLY        0x0001          /* open for writing only */
  77 #define O_RDWR          0x0002          /* open for reading and writing */
  78 #define O_ACCMODE       0x0003          /* mask for above modes */
  79
  80 /*
  81  * Kernel encoding of open mode; separate read and write bits that are
  82  * independently testable: 1 greater than the above.
  83  *
  84  * XXX
  85  * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH,
  86  * which was documented to use FREAD/FWRITE, continues to work.
  87  */
  88 #if __BSD_VISIBLE
  89 #define FREAD           0x0001
  90 #define FWRITE          0x0002
  91 #endif
  92 #define O_NONBLOCK      0x0004          /* no delay */
  93 #define O_APPEND        0x0008          /* set append mode */
  94 #if __BSD_VISIBLE
  95 #define O_SHLOCK        0x0010          /* open with shared file lock */
  96 #define O_EXLOCK        0x0020          /* open with exclusive file lock */
  97 #define O_ASYNC         0x0040          /* signal pgrp when data ready */
  98 #define O_FSYNC         0x0080          /* synchronous writes */
  99 #endif
 100 #define O_SYNC          0x0080          /* POSIX synonym for O_FSYNC */
 101 #if __POSIX_VISIBLE >= 200809
 102 #define O_NOFOLLOW      0x0100          /* don't follow symlinks */
 103 #endif
 104 #define O_CREAT         0x0200          /* create if nonexistent */
 105 #define O_TRUNC         0x0400          /* truncate to zero length */
 106 #define O_EXCL          0x0800          /* error if already exists */
 107 #ifdef _KERNEL
 108 #define FHASLOCK        0x4000          /* descriptor holds advisory lock */
 109 #endif
 110
 111 /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */
 112 #define O_NOCTTY        0x8000          /* don't assign controlling terminal */
 113
 114 #if __BSD_VISIBLE
 115 /* Attempt to bypass buffer cache */
 116 #define O_DIRECT        0x00010000
 117 #endif
 118
 119 #if __POSIX_VISIBLE >= 200809
 120 #define O_DIRECTORY     0x00020000      /* Fail if not directory */
 121 #define O_EXEC          0x00040000      /* Open for execute only */
 122 #define O_SEARCH        O_EXEC
 123 #endif
 124 #ifdef  _KERNEL
 125 #define FEXEC           O_EXEC
 126 #define FSEARCH         O_SEARCH
 127 #endif
 128
 129 #if __POSIX_VISIBLE >= 200809
 130 /* Defined by POSIX 1003.1-2008; BSD default, but reserve for future use. */
 131 #define O_TTY_INIT      0x00080000      /* Restore default termios attributes */
 132
 133 #define O_CLOEXEC       0x00100000
 134 #endif
 135
 136 #if __BSD_VISIBLE
 137 #define O_VERIFY        0x00200000      /* open only after verification */
 138 #define O_BENEATH       0x00400000      /* Fail if not under cwd */
 139 #define O_RESOLVE_BENEATH 0x00800000    /* As O_BENEATH, but do not allow
 140                                            resolve to walk out of cwd even to
 141                                            return back */
 142 #endif
 143
 144 #define O_DSYNC         0x01000000      /* POSIX data sync */
 145
 146 /*
 147  * XXX missing O_RSYNC.
 148  */
 149
 150 #ifdef _KERNEL
 151
 152 /* Only for devfs d_close() flags. */
 153 #define FLASTCLOSE      O_DIRECTORY
 154 #define FREVOKE         O_VERIFY
 155 /* Only for fo_close() from half-succeeded open */
 156 #define FOPENFAILED     O_TTY_INIT
 157
 158 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
 159 #define FFLAGS(oflags)  ((oflags) & O_EXEC ? (oflags) : (oflags) + 1)
 160 #define OFLAGS(fflags)  ((fflags) & O_EXEC ? (fflags) : (fflags) - 1)
 161
 162 /* bits to save after open */
 163 #define FMASK   (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FDSYNC|FNONBLOCK|O_DIRECT|FEXEC)
 164 /* bits settable by fcntl(F_SETFL, ...) */
 165 #define FCNTLFLAGS      (FAPPEND|FASYNC|FFSYNC|FDSYNC|FNONBLOCK|FRDAHEAD|O_DIRECT)
 166
 167 #if defined(COMPAT_FREEBSD7) || defined(COMPAT_FREEBSD6) || \
 168     defined(COMPAT_FREEBSD5) || defined(COMPAT_FREEBSD4)
 169 /*
 170  * Set by shm_open(3) in older libc's to get automatic MAP_ASYNC
 171  * behavior for POSIX shared memory objects (which are otherwise
 172  * implemented as plain files).
 173  */
 174 #define FPOSIXSHM       O_NOFOLLOW
 175 #undef FCNTLFLAGS
 176 #define FCNTLFLAGS      (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|FRDAHEAD| \
 177                          O_DIRECT)
 178 #endif
 179 #endif
 180
 181 /*
 182  * The O_* flags used to have only F* names, which were used in the kernel
 183  * and by fcntl.  We retain the F* names for the kernel f_flag field
 184  * and for backward compatibility for fcntl.  These flags are deprecated.
 185  */
 186 #if __BSD_VISIBLE
 187 #define FAPPEND         O_APPEND        /* kernel/compat */
 188 #define FASYNC          O_ASYNC         /* kernel/compat */
 189 #define FFSYNC          O_FSYNC         /* kernel */
 190 #define FDSYNC          O_DSYNC         /* kernel */
 191 #define FNONBLOCK       O_NONBLOCK      /* kernel */
 192 #define FNDELAY         O_NONBLOCK      /* compat */
 193 #define O_NDELAY        O_NONBLOCK      /* compat */
 194 #endif
 195
 196 /*
 197  * Historically, we ran out of bits in f_flag (which was once a short).
 198  * However, the flag bits not set in FMASK are only meaningful in the
 199  * initial open syscall.  Those bits were thus given a
 200  * different meaning for fcntl(2).
 201  */
 202 #if __BSD_VISIBLE
 203 /* Read ahead */
 204 #define FRDAHEAD        O_CREAT
 205 #endif
 206
 207 #if __POSIX_VISIBLE >= 200809
 208 /*
 209  * Magic value that specify the use of the current working directory
 210  * to determine the target of relative file paths in the openat() and
 211  * similar syscalls.
 212  */
 213 #define AT_FDCWD                -100
 214
 215 /*
 216  * Miscellaneous flags for the *at() syscalls.
 217  */
 218 #define AT_EACCESS              0x0100  /* Check access using effective user
 219                                            and group ID */
 220 #define AT_SYMLINK_NOFOLLOW     0x0200  /* Do not follow symbolic links */
 221 #define AT_SYMLINK_FOLLOW       0x0400  /* Follow symbolic link */
 222 #define AT_REMOVEDIR            0x0800  /* Remove directory instead of file */
 223 #define AT_BENEATH              0x1000  /* Fail if not under dirfd */
 224 #define AT_RESOLVE_BENEATH      0x2000  /* As AT_BENEATH, but do not allow
 225                                            resolve to walk out of dirfd even
 226                                            to return back */
 227 #endif
 228
 229 /*
 230  * Constants used for fcntl(2)
 231  */
 232
 233 /* command values */
 234 #define F_DUPFD         0               /* duplicate file descriptor */
 235 #define F_GETFD         1               /* get file descriptor flags */
 236 #define F_SETFD         2               /* set file descriptor flags */
 237 #define F_GETFL         3               /* get file status flags */
 238 #define F_SETFL         4               /* set file status flags */
 239 #if __XSI_VISIBLE || __POSIX_VISIBLE >= 200112
 240 #define F_GETOWN        5               /* get SIGIO/SIGURG proc/pgrp */
 241 #define F_SETOWN        6               /* set SIGIO/SIGURG proc/pgrp */
 242 #endif
 243 #if __BSD_VISIBLE
 244 #define F_OGETLK        7               /* get record locking information */
 245 #define F_OSETLK        8               /* set record locking information */
 246 #define F_OSETLKW       9               /* F_SETLK; wait if blocked */
 247 #define F_DUP2FD        10              /* duplicate file descriptor to arg */
 248 #endif
 249 #define F_GETLK         11              /* get record locking information */
 250 #define F_SETLK         12              /* set record locking information */
 251 #define F_SETLKW        13              /* F_SETLK; wait if blocked */
 252 #if __BSD_VISIBLE
 253 #define F_SETLK_REMOTE  14              /* debugging support for remote locks */
 254 #define F_READAHEAD     15              /* read ahead */
 255 #define F_RDAHEAD       16              /* Darwin compatible read ahead */
 256 #endif
 257 #if __POSIX_VISIBLE >= 200809
 258 #define F_DUPFD_CLOEXEC 17              /* Like F_DUPFD, but FD_CLOEXEC is set */
 259 #endif
 260 #if __BSD_VISIBLE
 261 #define F_DUP2FD_CLOEXEC 18             /* Like F_DUP2FD, but FD_CLOEXEC is set */
 262 #define F_ADD_SEALS     19
 263 #define F_GET_SEALS     20
 264 #define F_ISUNIONSTACK  21              /* Kludge for libc, don't use it. */
 265
 266 /* Seals (F_ADD_SEALS, F_GET_SEALS). */
 267 #define F_SEAL_SEAL     0x0001          /* Prevent adding sealings */
 268 #define F_SEAL_SHRINK   0x0002          /* May not shrink */
 269 #define F_SEAL_GROW     0x0004          /* May not grow */
 270 #define F_SEAL_WRITE    0x0008          /* May not write */
 271 #endif  /* __BSD_VISIBLE */
 272
 273 /* file descriptor flags (F_GETFD, F_SETFD) */
 274 #define FD_CLOEXEC      1               /* close-on-exec flag */
 275
 276 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
 277 #define F_RDLCK         1               /* shared or read lock */
 278 #define F_UNLCK         2               /* unlock */
 279 #define F_WRLCK         3               /* exclusive or write lock */
 280 #if __BSD_VISIBLE
 281 #define F_UNLCKSYS      4               /* purge locks for a given system ID */
 282 #define F_CANCEL        5               /* cancel an async lock request */
 283 #endif
 284 #ifdef _KERNEL
 285 #define F_WAIT          0x010           /* Wait until lock is granted */
 286 #define F_FLOCK         0x020           /* Use flock(2) semantics for lock */
 287 #define F_POSIX         0x040           /* Use POSIX semantics for lock */
 288 #define F_REMOTE        0x080           /* Lock owner is remote NFS client */
 289 #define F_NOINTR        0x100           /* Ignore signals when waiting */
 290 #define F_FIRSTOPEN     0x200           /* First right to advlock file */
 291 #endif
 292
 293 /*
 294  * Advisory file segment locking data type -
 295  * information passed to system by user
 296  */
 297 struct flock {
 298         off_t   l_start;        /* starting offset */
 299         off_t   l_len;          /* len = 0 means until end of file */
 300         pid_t   l_pid;          /* lock owner */
 301         short   l_type;         /* lock type: read/write, etc. */
 302         short   l_whence;       /* type of l_start */
 303         int     l_sysid;        /* remote system id or zero for local */
 304 };
 305
 306 #if __BSD_VISIBLE
 307 /*
 308  * Old advisory file segment locking data type,
 309  * before adding l_sysid.
 310  */
 311 struct __oflock {
 312         off_t   l_start;        /* starting offset */
 313         off_t   l_len;          /* len = 0 means until end of file */
 314         pid_t   l_pid;          /* lock owner */
 315         short   l_type;         /* lock type: read/write, etc. */
 316         short   l_whence;       /* type of l_start */
 317 };
 318 #endif
 319
 320 #if __BSD_VISIBLE
 321 /* lock operations for flock(2) */
 322 #define LOCK_SH         0x01            /* shared file lock */
 323 #define LOCK_EX         0x02            /* exclusive file lock */
 324 #define LOCK_NB         0x04            /* don't block when locking */
 325 #define LOCK_UN         0x08            /* unlock file */
 326 #endif
 327
 328 #if __POSIX_VISIBLE >= 200112
 329 /*
 330  * Advice to posix_fadvise
 331  */
 332 #define POSIX_FADV_NORMAL       0       /* no special treatment */
 333 #define POSIX_FADV_RANDOM       1       /* expect random page references */
 334 #define POSIX_FADV_SEQUENTIAL   2       /* expect sequential page references */
 335 #define POSIX_FADV_WILLNEED     3       /* will need these pages */
 336 #define POSIX_FADV_DONTNEED     4       /* dont need these pages */
 337 #define POSIX_FADV_NOREUSE      5       /* access data only once */
 338 #endif
 339
 340 #ifdef __BSD_VISIBLE
 341 /*
 342  * Magic value that specify that corresponding file descriptor to filename
 343  * is unknown and sanitary check should be omitted in the funlinkat() and
 344  * similar syscalls.
 345  */
 346 #define FD_NONE                 -200
 347 #endif
 348
 349 #ifndef _KERNEL
 350 __BEGIN_DECLS
 351 int     open(const char *, int, ...);
 352 int     creat(const char *, mode_t);
 353 int     fcntl(int, int, ...);
 354 #if __BSD_VISIBLE
 355 int     flock(int, int);
 356 #endif
 357 #if __POSIX_VISIBLE >= 200809
 358 int     openat(int, const char *, int, ...);
 359 #endif
 360 #if __POSIX_VISIBLE >= 200112
 361 int     posix_fadvise(int, off_t, off_t, int);
 362 int     posix_fallocate(int, off_t, off_t);
 363 #endif
 364 __END_DECLS
 365 #endif
 366
 367 #endif /* !_SYS_FCNTL_H_ */