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 #endif 123 #ifdef _KERNEL 124 #define FEXEC O_EXEC 125 #endif 126 127 #if __POSIX_VISIBLE >= 200809 128 /* Defined by POSIX 1003.1-2008; BSD default, but reserve for future use. */ 129 #define O_TTY_INIT 0x00080000 /* Restore default termios attributes */ 130 131 #define O_CLOEXEC 0x00100000 132 #endif 133 134 #if __BSD_VISIBLE 135 #define O_VERIFY 0x00200000 /* open only after verification */ 136 #define O_BENEATH 0x00400000 /* Fail if not under cwd */ 137 #endif 138 139 /* 140 * XXX missing O_DSYNC, O_RSYNC. 141 */ 142 143 #ifdef _KERNEL 144 145 /* Only for devfs d_close() flags. */ 146 #define FLASTCLOSE O_DIRECTORY 147 #define FREVOKE O_VERIFY 148 /* Only for fo_close() from half-succeeded open */ 149 #define FOPENFAILED O_TTY_INIT 150 151 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */ 152 #define FFLAGS(oflags) ((oflags) & O_EXEC ? (oflags) : (oflags) + 1) 153 #define OFLAGS(fflags) ((fflags) & O_EXEC ? (fflags) : (fflags) - 1) 154 155 /* bits to save after open */ 156 #define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|O_DIRECT|FEXEC) 157 /* bits settable by fcntl(F_SETFL, ...) */ 158 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FRDAHEAD|O_DIRECT) 159 160 #if defined(COMPAT_FREEBSD7) || defined(COMPAT_FREEBSD6) || \ 161 defined(COMPAT_FREEBSD5) || defined(COMPAT_FREEBSD4) 162 /* 163 * Set by shm_open(3) in older libc's to get automatic MAP_ASYNC 164 * behavior for POSIX shared memory objects (which are otherwise 165 * implemented as plain files). 166 */ 167 #define FPOSIXSHM O_NOFOLLOW 168 #undef FCNTLFLAGS 169 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|FRDAHEAD| \ 170 O_DIRECT) 171 #endif 172 #endif 173 174 /* 175 * The O_* flags used to have only F* names, which were used in the kernel 176 * and by fcntl. We retain the F* names for the kernel f_flag field 177 * and for backward compatibility for fcntl. These flags are deprecated. 178 */ 179 #if __BSD_VISIBLE 180 #define FAPPEND O_APPEND /* kernel/compat */ 181 #define FASYNC O_ASYNC /* kernel/compat */ 182 #define FFSYNC O_FSYNC /* kernel */ 183 #define FNONBLOCK O_NONBLOCK /* kernel */ 184 #define FNDELAY O_NONBLOCK /* compat */ 185 #define O_NDELAY O_NONBLOCK /* compat */ 186 #endif 187 188 /* 189 * We are out of bits in f_flag (which is a short). However, 190 * the flag bits not set in FMASK are only meaningful in the 191 * initial open syscall. Those bits can thus be given a 192 * different meaning for fcntl(2). 193 */ 194 #if __BSD_VISIBLE 195 /* Read ahead */ 196 #define FRDAHEAD O_CREAT 197 #endif 198 199 #if __POSIX_VISIBLE >= 200809 200 /* 201 * Magic value that specify the use of the current working directory 202 * to determine the target of relative file paths in the openat() and 203 * similar syscalls. 204 */ 205 #define AT_FDCWD -100 206 207 /* 208 * Miscellaneous flags for the *at() syscalls. 209 */ 210 #define AT_EACCESS 0x0100 /* Check access using effective user 211 and group ID */ 212 #define AT_SYMLINK_NOFOLLOW 0x0200 /* Do not follow symbolic links */ 213 #define AT_SYMLINK_FOLLOW 0x0400 /* Follow symbolic link */ 214 #define AT_REMOVEDIR 0x0800 /* Remove directory instead of file */ 215 #define AT_BENEATH 0x1000 /* Fail if not under dirfd */ 216 #endif 217 218 /* 219 * Constants used for fcntl(2) 220 */ 221 222 /* command values */ 223 #define F_DUPFD 0 /* duplicate file descriptor */ 224 #define F_GETFD 1 /* get file descriptor flags */ 225 #define F_SETFD 2 /* set file descriptor flags */ 226 #define F_GETFL 3 /* get file status flags */ 227 #define F_SETFL 4 /* set file status flags */ 228 #if __XSI_VISIBLE || __POSIX_VISIBLE >= 200112 229 #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */ 230 #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */ 231 #endif 232 #if __BSD_VISIBLE 233 #define F_OGETLK 7 /* get record locking information */ 234 #define F_OSETLK 8 /* set record locking information */ 235 #define F_OSETLKW 9 /* F_SETLK; wait if blocked */ 236 #define F_DUP2FD 10 /* duplicate file descriptor to arg */ 237 #endif 238 #define F_GETLK 11 /* get record locking information */ 239 #define F_SETLK 12 /* set record locking information */ 240 #define F_SETLKW 13 /* F_SETLK; wait if blocked */ 241 #if __BSD_VISIBLE 242 #define F_SETLK_REMOTE 14 /* debugging support for remote locks */ 243 #define F_READAHEAD 15 /* read ahead */ 244 #define F_RDAHEAD 16 /* Darwin compatible read ahead */ 245 #endif 246 #if __POSIX_VISIBLE >= 200809 247 #define F_DUPFD_CLOEXEC 17 /* Like F_DUPFD, but FD_CLOEXEC is set */ 248 #endif 249 #if __BSD_VISIBLE 250 #define F_DUP2FD_CLOEXEC 18 /* Like F_DUP2FD, but FD_CLOEXEC is set */ 251 #endif 252 253 /* file descriptor flags (F_GETFD, F_SETFD) */ 254 #define FD_CLOEXEC 1 /* close-on-exec flag */ 255 256 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */ 257 #define F_RDLCK 1 /* shared or read lock */ 258 #define F_UNLCK 2 /* unlock */ 259 #define F_WRLCK 3 /* exclusive or write lock */ 260 #if __BSD_VISIBLE 261 #define F_UNLCKSYS 4 /* purge locks for a given system ID */ 262 #define F_CANCEL 5 /* cancel an async lock request */ 263 #endif 264 #ifdef _KERNEL 265 #define F_WAIT 0x010 /* Wait until lock is granted */ 266 #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */ 267 #define F_POSIX 0x040 /* Use POSIX semantics for lock */ 268 #define F_REMOTE 0x080 /* Lock owner is remote NFS client */ 269 #define F_NOINTR 0x100 /* Ignore signals when waiting */ 270 #endif 271 272 /* 273 * Advisory file segment locking data type - 274 * information passed to system by user 275 */ 276 struct flock { 277 off_t l_start; /* starting offset */ 278 off_t l_len; /* len = 0 means until end of file */ 279 pid_t l_pid; /* lock owner */ 280 short l_type; /* lock type: read/write, etc. */ 281 short l_whence; /* type of l_start */ 282 int l_sysid; /* remote system id or zero for local */ 283 }; 284 285 #if __BSD_VISIBLE 286 /* 287 * Old advisory file segment locking data type, 288 * before adding l_sysid. 289 */ 290 struct __oflock { 291 off_t l_start; /* starting offset */ 292 off_t l_len; /* len = 0 means until end of file */ 293 pid_t l_pid; /* lock owner */ 294 short l_type; /* lock type: read/write, etc. */ 295 short l_whence; /* type of l_start */ 296 }; 297 #endif 298 299 #if __BSD_VISIBLE 300 /* lock operations for flock(2) */ 301 #define LOCK_SH 0x01 /* shared file lock */ 302 #define LOCK_EX 0x02 /* exclusive file lock */ 303 #define LOCK_NB 0x04 /* don't block when locking */ 304 #define LOCK_UN 0x08 /* unlock file */ 305 #endif 306 307 #if __POSIX_VISIBLE >= 200112 308 /* 309 * Advice to posix_fadvise 310 */ 311 #define POSIX_FADV_NORMAL 0 /* no special treatment */ 312 #define POSIX_FADV_RANDOM 1 /* expect random page references */ 313 #define POSIX_FADV_SEQUENTIAL 2 /* expect sequential page references */ 314 #define POSIX_FADV_WILLNEED 3 /* will need these pages */ 315 #define POSIX_FADV_DONTNEED 4 /* dont need these pages */ 316 #define POSIX_FADV_NOREUSE 5 /* access data only once */ 317 #endif 318 319 #ifndef _KERNEL 320 __BEGIN_DECLS 321 int open(const char *, int, ...); 322 int creat(const char *, mode_t); 323 int fcntl(int, int, ...); 324 #if __BSD_VISIBLE 325 int flock(int, int); 326 #endif 327 #if __POSIX_VISIBLE >= 200809 328 int openat(int, const char *, int, ...); 329 #endif 330 #if __POSIX_VISIBLE >= 200112 331 int posix_fadvise(int, off_t, off_t, int); 332 int posix_fallocate(int, off_t, off_t); 333 #endif 334 __END_DECLS 335 #endif 336 337 #endif /* !_SYS_FCNTL_H_ */ 338