sys/sys/fcntl.h

   1 /*-
   2  * Copyright (c) 1983, 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * (c) UNIX System Laboratories, Inc.
   5  * All or some portions of this file are derived from material licensed
   6  * to the University of California by American Telephone and Telegraph
   7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   8  * the permission of UNIX System Laboratories, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)fcntl.h     8.3 (Berkeley) 1/21/94
  39  * $FreeBSD: src/sys/sys/fcntl.h,v 1.9.2.2 2001/06/03 05:00:10 dillon Exp $
  40  */
  41
  42 #ifndef _SYS_FCNTL_H_
  43 #define _SYS_FCNTL_H_
  44
  45 #include <sys/cdefs.h>
  46 #ifndef _SYS_TYPES_H_
  47 #include <sys/types.h>
  48 #endif
  49
  50 /*
  51  * File status flags: these are used by open(2), fcntl(2).
  52  * They are also used (indirectly) in the kernel file structure f_flags,
  53  * which is a superset of the open/fcntl flags.  Open flags and f_flags
  54  * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
  55  * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
  56  */
  57 /* open-only flags */
  58 #define O_RDONLY        0x0000          /* open for reading only */
  59 #define O_WRONLY        0x0001          /* open for writing only */
  60 #define O_RDWR          0x0002          /* open for reading and writing */
  61 #define O_ACCMODE       0x0003          /* mask for above modes */
  62
  63 /*
  64  * Kernel encoding of open mode; separate read and write bits that are
  65  * independently testable: 1 greater than the above.
  66  *
  67  * XXX
  68  * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH,
  69  * which was documented to use FREAD/FWRITE, continues to work.
  70  */
  71 #if __BSD_VISIBLE
  72 #define FREAD           0x0001
  73 #define FWRITE          0x0002
  74 #endif
  75 #define O_NONBLOCK      0x0004          /* no delay */
  76 #define O_APPEND        0x0008          /* set append mode */
  77 #if __BSD_VISIBLE
  78 #define O_SHLOCK        0x0010          /* open with shared file lock */
  79 #define O_EXLOCK        0x0020          /* open with exclusive file lock */
  80 #define O_ASYNC         0x0040          /* signal pgrp when data ready */
  81 #define O_FSYNC         0x0080          /* synchronous writes */
  82 #endif
  83 #define O_SYNC          0x0080          /* Same as O_FSYNC, but POSIX */
  84 #if __POSIX_VISIBLE >= 200809
  85 #define O_NOFOLLOW      0x0100          /* don't follow symlinks */
  86 #endif
  87 #define O_CREAT         0x0200          /* create if nonexistent */
  88 #define O_TRUNC         0x0400          /* truncate to zero length */
  89 #define O_EXCL          0x0800          /* error if already exists */
  90 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  91 #define FMARK           0x1000          /* mark during gc() */
  92 #define FDEFER          0x2000          /* defer for next gc pass */
  93 #define FHASLOCK        0x4000          /* descriptor holds advisory lock */
  94 #endif
  95
  96 /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */
  97 #define O_NOCTTY        0x8000          /* don't assign controlling terminal */
  98
  99 #if __BSD_VISIBLE
 100 /* Attempt to bypass the buffer cache */
 101 #define O_DIRECT        0x00010000
 102 #endif
 103
 104 #if __POSIX_VISIBLE >= 200809
 105 #define O_CLOEXEC       0x00020000      /* atomically set FD_CLOEXEC */
 106 #endif
 107 #define O_FBLOCKING     0x00040000      /* force blocking I/O */
 108 #define O_FNONBLOCKING  0x00080000      /* force non-blocking I/O */
 109 #define O_FAPPEND       0x00100000      /* force append mode for write */
 110 #define O_FOFFSET       0x00200000      /* force specific offset */
 111 #define O_FSYNCWRITE    0x00400000      /* force synchronous write */
 112 #define O_FASYNCWRITE   0x00800000      /* force asynchronous write */
 113 #define FCDEVPRIV       0x01000000      /* f_data1 used for cdevpriv */
 114 #define O_UNUSED25      0x02000000
 115 #define O_MAPONREAD     0x04000000      /* memory map read buffer */
 116
 117 #if __POSIX_VISIBLE >= 200809
 118 #define O_DIRECTORY     0x08000000      /* error if not a directory */
 119 #endif
 120
 121 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 122 #define FREVOKED        0x10000000      /* revoked by fdrevoke() */
 123 #define FAPPENDONLY     0x20000000      /* O_APPEND cannot be changed */
 124 #define FOFFSETLOCK     0x40000000      /* f_offset locked */
 125 #define FOFFSETWAKE     0x80000000      /* f_offset wakeup */
 126 #endif
 127
 128 #define O_FMASK         (O_FBLOCKING|O_FNONBLOCKING|O_FAPPEND|O_FOFFSET|\
 129                          O_FSYNCWRITE|O_FASYNCWRITE|O_MAPONREAD)
 130
 131 #ifdef _KERNEL
 132 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
 133 #define FFLAGS(oflags)  ((oflags) + 1)
 134 #define OFLAGS(fflags)  ((fflags) - 1)
 135
 136 /*
 137  * Bits to save after open from the ap.  Remaining bits are retained.
 138  */
 139 #define FMASK           (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|\
 140                          FAPPENDONLY|FREVOKED|O_DIRECT|O_MAPONREAD)
 141 /* bits settable by fcntl(F_SETFL, ...) */
 142 #define FCNTLFLAGS      (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|\
 143                          O_DIRECT|O_MAPONREAD)
 144 #endif
 145
 146 /*
 147  * The O_* flags used to have only F* names, which were used in the kernel
 148  * and by fcntl.  We retain the F* names for the kernel f_flag field
 149  * and for backward compatibility for fcntl.
 150  */
 151 #if __BSD_VISIBLE
 152 #define FAPPEND         O_APPEND        /* kernel/compat */
 153 #define FASYNC          O_ASYNC         /* kernel/compat */
 154 #define FFSYNC          O_FSYNC         /* kernel */
 155 #define FNONBLOCK       O_NONBLOCK      /* kernel */
 156 #define FNDELAY         O_NONBLOCK      /* compat */
 157 #define O_NDELAY        O_NONBLOCK      /* compat */
 158 #endif
 159
 160 /*
 161  * We are out of bits in f_flag (which is a short).  However,
 162  * the flag bits not set in FMASK are only meaningful in the
 163  * initial open syscall.  Those bits can thus be given a
 164  * different meaning for fcntl(2).
 165  */
 166 #if __BSD_VISIBLE
 167
 168 /*
 169  * Set by shm_open(3) to get automatic MAP_ASYNC behavior
 170  * for POSIX shared memory objects (which are otherwise
 171  * implemented as plain files).
 172  */
 173 #define FPOSIXSHM       O_NOFOLLOW
 174 #endif
 175
 176 #if __POSIX_VISIBLE >= 200809
 177 /*
 178  * Constants used by "at" family of system calls.
 179  */
 180 #define AT_FDCWD                0xFFFAFDCD      /* invalid file descriptor */
 181 #define AT_SYMLINK_NOFOLLOW     1
 182 #define AT_REMOVEDIR            2
 183 #define AT_EACCESS              4
 184 #define AT_SYMLINK_FOLLOW       8
 185 #endif
 186
 187 /*
 188  * Constants used for fcntl(2)
 189  */
 190
 191 /* command values */
 192 #define F_DUPFD         0               /* duplicate file descriptor */
 193 #define F_GETFD         1               /* get file descriptor flags */
 194 #define F_SETFD         2               /* set file descriptor flags */
 195 #define F_GETFL         3               /* get file status flags */
 196 #define F_SETFL         4               /* set file status flags */
 197 #if __XSI_VISIBLE || __POSIX_VISIBLE >= 200112
 198 #define F_GETOWN        5               /* get SIGIO/SIGURG proc/pgrp */
 199 #define F_SETOWN        6               /* set SIGIO/SIGURG proc/pgrp */
 200 #endif
 201 #define F_GETLK         7               /* get record locking information */
 202 #define F_SETLK         8               /* set record locking information */
 203 #define F_SETLKW        9               /* F_SETLK; wait if blocked */
 204 #if __BSD_VISIBLE
 205 #define F_DUP2FD        10              /* duplicate file descriptor to arg */
 206 #endif
 207 #if __POSIX_VISIBLE >= 200809
 208 #define F_DUPFD_CLOEXEC 17              /* Like F_DUPFD with FD_CLOEXEC set */
 209 #endif
 210 #if __BSD_VISIBLE
 211 #define F_DUP2FD_CLOEXEC 18             /* Like F_DUP2FD with FD_CLOEXEC set */
 212 #endif
 213
 214 /* file descriptor flags (F_GETFD, F_SETFD) */
 215 #define FD_CLOEXEC      1               /* close-on-exec flag */
 216
 217 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
 218 #define F_RDLCK         1               /* shared or read lock */
 219 #define F_UNLCK         2               /* unlock */
 220 #define F_WRLCK         3               /* exclusive or write lock */
 221 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 222 #define F_WAIT          0x010           /* Wait until lock is granted */
 223 #define F_UNUSED020     0x020
 224 #define F_POSIX         0x040           /* Use POSIX semantics for lock */
 225 #define F_NOEND         0x080           /* l_len = 0, internally used */
 226 #endif
 227
 228
 229 /*
 230  * Advisory file segment locking data type -
 231  * information passed to system by user
 232  */
 233 struct flock {
 234         off_t   l_start;        /* starting offset */
 235         off_t   l_len;          /* len = 0 means until end of file */
 236         pid_t   l_pid;          /* lock owner */
 237         short   l_type;         /* lock type: read/write, etc. */
 238         short   l_whence;       /* type of l_start */
 239 };
 240
 241 #ifdef _KERNEL
 242 union fcntl_dat {
 243         int             fc_fd;          /* F_DUPFD */
 244         int             fc_cloexec;     /* F_GETFD/F_SETFD */
 245         int             fc_flags;       /* F_GETFL/F_SETFL */
 246         int             fc_owner;       /* F_GETOWN/F_SETOWN */
 247         struct flock    fc_flock;       /* F_GETLK/F_SETLK */
 248 };
 249 #endif /* _KERNEL */
 250
 251
 252 #if __BSD_VISIBLE
 253 /* lock operations for flock(2) */
 254 #define LOCK_SH         0x01            /* shared file lock */
 255 #define LOCK_EX         0x02            /* exclusive file lock */
 256 #define LOCK_NB         0x04            /* don't block when locking */
 257 #define LOCK_UN         0x08            /* unlock file */
 258 #endif
 259
 260 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
 261 __BEGIN_DECLS
 262 int     open(const char *, int, ...);
 263 #if __POSIX_VISIBLE >= 200809
 264 int     openat(int, const char *, int, ...);
 265 #endif
 266 int     creat(const char *, mode_t);
 267 int     fcntl(int, int, ...);
 268 #if __BSD_VISIBLE
 269 int     flock(int, int);
 270 #endif /* !_POSIX_SOURCE */
 271 __END_DECLS
 272 #endif
 273
 274 #endif /* !_SYS_FCNTL_H_ */