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