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 37 #ifndef _SYS_FCNTL_H_ 38 #define _SYS_FCNTL_H_ 39 40 /* 41 * This file includes the definitions for open and fcntl 42 * described by POSIX for <fcntl.h>; it also includes 43 * related kernel definitions. 44 */ 45 46 #include <sys/cdefs.h> 47 #include <sys/_types.h> 48 49 #ifndef _MODE_T_DECLARED 50 typedef __mode_t mode_t; 51 #define _MODE_T_DECLARED 52 #endif 53 54 #ifndef _OFF_T_DECLARED 55 typedef __off_t off_t; 56 #define _OFF_T_DECLARED 57 #endif 58 59 #ifndef _PID_T_DECLARED 60 typedef __pid_t pid_t; 61 #define _PID_T_DECLARED 62 #endif 63 64 /* 65 * File status flags: these are used by open(2), fcntl(2). 66 * They are also used (indirectly) in the kernel file structure f_flags, 67 * which is a superset of the open/fcntl flags. Open flags and f_flags 68 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags). 69 * Open/fcntl flags begin with O_; kernel-internal flags begin with F. 70 */ 71 /* open-only flags */ 72 #define O_RDONLY 0x0000 /* open for reading only */ 73 #define O_WRONLY 0x0001 /* open for writing only */ 74 #define O_RDWR 0x0002 /* open for reading and writing */ 75 #define O_ACCMODE 0x0003 /* mask for above modes */ 76 77 /* 78 * Kernel encoding of open mode; separate read and write bits that are 79 * independently testable: 1 greater than the above. 80 * 81 * XXX 82 * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH, 83 * which was documented to use FREAD/FWRITE, continues to work. 84 */ 85 #if __BSD_VISIBLE 86 #define FREAD 0x0001 87 #define FWRITE 0x0002 88 #endif 89 #define O_NONBLOCK 0x0004 /* no delay */ 90 #define O_APPEND 0x0008 /* set append mode */ 91 #if __BSD_VISIBLE 92 #define O_SHLOCK 0x0010 /* open with shared file lock */ 93 #define O_EXLOCK 0x0020 /* open with exclusive file lock */ 94 #define O_ASYNC 0x0040 /* signal pgrp when data ready */ 95 #define O_FSYNC 0x0080 /* synchronous writes */ 96 #endif 97 #define O_SYNC 0x0080 /* POSIX synonym for O_FSYNC */ 98 #if __POSIX_VISIBLE >= 200809 99 #define O_NOFOLLOW 0x0100 /* don't follow symlinks */ 100 #endif 101 #define O_CREAT 0x0200 /* create if nonexistent */ 102 #define O_TRUNC 0x0400 /* truncate to zero length */ 103 #define O_EXCL 0x0800 /* error if already exists */ 104 #ifdef _KERNEL 105 #define FHASLOCK 0x4000 /* descriptor holds advisory lock */ 106 #endif 107 108 /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */ 109 #define O_NOCTTY 0x8000 /* don't assign controlling terminal */ 110 111 #if __BSD_VISIBLE 112 /* Attempt to bypass buffer cache */ 113 #define O_DIRECT 0x00010000 114 #endif 115 116 #if __POSIX_VISIBLE >= 200809 117 #define O_DIRECTORY 0x00020000 /* Fail if not directory */ 118 #define O_EXEC 0x00040000 /* Open for execute only */ 119 #define O_SEARCH O_EXEC 120 #endif 121 #ifdef _KERNEL 122 #define FEXEC O_EXEC 123 #define FSEARCH O_SEARCH 124 #endif 125 126 #if __POSIX_VISIBLE >= 200809 127 /* Defined by POSIX 1003.1-2008; BSD default, but reserve for future use. */ 128 #define O_TTY_INIT 0x00080000 /* Restore default termios attributes */ 129 130 #define O_CLOEXEC 0x00100000 131 #endif 132 133 #if __BSD_VISIBLE 134 #define O_VERIFY 0x00200000 /* open only after verification */ 135 #define O_PATH 0x00400000 /* fd is only a path */ 136 #define O_RESOLVE_BENEATH 0x00800000 /* Do not allow name resolution to walk 137 out of cwd */ 138 #endif 139 140 #define O_DSYNC 0x01000000 /* POSIX data sync */ 141 #if __BSD_VISIBLE 142 #define O_EMPTY_PATH 0x02000000 143 #define O_NAMEDATTR 0x04000000 /* NFSv4 named attributes */ 144 #endif 145 146 /* 147 * !!! DANGER !!! 148 * 149 * There are very few bits left for O_* flags. Every bit we consume for 150 * local features is one bit we can't use for future source compatibility 151 * with other operating systems. 152 * 153 * All additions should be coordinated with srcmgr@. 154 */ 155 156 /* 157 * XXX missing O_RSYNC. 158 */ 159 160 #ifdef _KERNEL 161 162 /* Only for devfs d_close() flags. */ 163 #define FLASTCLOSE O_DIRECTORY 164 #define FREVOKE O_VERIFY 165 /* Only for fo_close() from half-succeeded open */ 166 #define FOPENFAILED O_TTY_INIT 167 /* Only for O_PATH files which passed ACCESS FREAD check on open */ 168 #define FKQALLOWED O_RESOLVE_BENEATH 169 170 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */ 171 #define FFLAGS(oflags) ((oflags) & O_EXEC ? (oflags) : (oflags) + 1) 172 #define OFLAGS(fflags) \ 173 (((fflags) & (O_EXEC | O_PATH)) != 0 ? (fflags) : (fflags) - 1) 174 175 /* bits to save after open */ 176 #define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FDSYNC|FNONBLOCK| \ 177 O_DIRECT|FEXEC|O_PATH) 178 /* bits settable by fcntl(F_SETFL, ...) */ 179 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FDSYNC|FNONBLOCK|FRDAHEAD|O_DIRECT) 180 181 #if defined(COMPAT_FREEBSD7) || defined(COMPAT_FREEBSD6) || \ 182 defined(COMPAT_FREEBSD5) || defined(COMPAT_FREEBSD4) 183 /* 184 * Set by shm_open(3) in older libc's to get automatic MAP_ASYNC 185 * behavior for POSIX shared memory objects (which are otherwise 186 * implemented as plain files). 187 */ 188 #define FPOSIXSHM O_NOFOLLOW 189 #undef FCNTLFLAGS 190 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|FRDAHEAD| \ 191 O_DIRECT) 192 #endif 193 #endif 194 195 /* 196 * The O_* flags used to have only F* names, which were used in the kernel 197 * and by fcntl. We retain the F* names for the kernel f_flag field 198 * and for backward compatibility for fcntl. These flags are deprecated. 199 */ 200 #if __BSD_VISIBLE 201 #define FAPPEND O_APPEND /* kernel/compat */ 202 #define FASYNC O_ASYNC /* kernel/compat */ 203 #define FFSYNC O_FSYNC /* kernel */ 204 #define FDSYNC O_DSYNC /* kernel */ 205 #define FNONBLOCK O_NONBLOCK /* kernel */ 206 #define FNDELAY O_NONBLOCK /* compat */ 207 #define O_NDELAY O_NONBLOCK /* compat */ 208 #endif 209 210 /* 211 * Historically, we ran out of bits in f_flag (which was once a short). 212 * However, the flag bits not set in FMASK are only meaningful in the 213 * initial open syscall. Those bits were thus given a 214 * different meaning for fcntl(2). 215 */ 216 #if __BSD_VISIBLE 217 /* Read ahead */ 218 #define FRDAHEAD O_CREAT 219 #endif 220 221 #if __POSIX_VISIBLE >= 200809 222 /* 223 * Magic value that specify the use of the current working directory 224 * to determine the target of relative file paths in the openat() and 225 * similar syscalls. 226 */ 227 #define AT_FDCWD -100 228 229 /* 230 * Miscellaneous flags for the *at() syscalls. 231 */ 232 #define AT_EACCESS 0x0100 /* Check access using effective user 233 and group ID */ 234 #define AT_SYMLINK_NOFOLLOW 0x0200 /* Do not follow symbolic links */ 235 #define AT_SYMLINK_FOLLOW 0x0400 /* Follow symbolic link */ 236 #define AT_REMOVEDIR 0x0800 /* Remove directory instead of file */ 237 #endif /* __POSIX_VISIBLE >= 200809 */ 238 #if __BSD_VISIBLE 239 /* #define AT_UNUSED1 0x1000 *//* Was AT_BENEATH */ 240 #define AT_RESOLVE_BENEATH 0x2000 /* Do not allow name resolution 241 to walk out of dirfd */ 242 #define AT_EMPTY_PATH 0x4000 /* Operate on dirfd if path is empty */ 243 #endif /* __BSD_VISIBLE */ 244 245 /* 246 * Constants used for fcntl(2) 247 */ 248 249 /* command values */ 250 #define F_DUPFD 0 /* duplicate file descriptor */ 251 #define F_GETFD 1 /* get file descriptor flags */ 252 #define F_SETFD 2 /* set file descriptor flags */ 253 #define F_GETFL 3 /* get file status flags */ 254 #define F_SETFL 4 /* set file status flags */ 255 #if __XSI_VISIBLE || __POSIX_VISIBLE >= 200112 256 #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */ 257 #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */ 258 #endif 259 #if __BSD_VISIBLE 260 #define F_OGETLK 7 /* get record locking information */ 261 #define F_OSETLK 8 /* set record locking information */ 262 #define F_OSETLKW 9 /* F_SETLK; wait if blocked */ 263 #define F_DUP2FD 10 /* duplicate file descriptor to arg */ 264 #endif 265 #define F_GETLK 11 /* get record locking information */ 266 #define F_SETLK 12 /* set record locking information */ 267 #define F_SETLKW 13 /* F_SETLK; wait if blocked */ 268 #if __BSD_VISIBLE 269 #define F_SETLK_REMOTE 14 /* debugging support for remote locks */ 270 #define F_READAHEAD 15 /* read ahead */ 271 #define F_RDAHEAD 16 /* Darwin compatible read ahead */ 272 #endif 273 #if __POSIX_VISIBLE >= 200809 274 #define F_DUPFD_CLOEXEC 17 /* Like F_DUPFD, but FD_CLOEXEC is set */ 275 #endif 276 #if __BSD_VISIBLE 277 #define F_DUP2FD_CLOEXEC 18 /* Like F_DUP2FD, but FD_CLOEXEC is set */ 278 #define F_ADD_SEALS 19 279 #define F_GET_SEALS 20 280 #define F_ISUNIONSTACK 21 /* Kludge for libc, don't use it. */ 281 #define F_KINFO 22 /* Return kinfo_file for this fd */ 282 283 /* Seals (F_ADD_SEALS, F_GET_SEALS). */ 284 #define F_SEAL_SEAL 0x0001 /* Prevent adding sealings */ 285 #define F_SEAL_SHRINK 0x0002 /* May not shrink */ 286 #define F_SEAL_GROW 0x0004 /* May not grow */ 287 #define F_SEAL_WRITE 0x0008 /* May not write */ 288 #endif /* __BSD_VISIBLE */ 289 290 /* file descriptor flags (F_GETFD, F_SETFD) */ 291 #define FD_CLOEXEC 1 /* close-on-exec flag */ 292 #define FD_RESOLVE_BENEATH 2 /* all lookups relative to fd have 293 O_RESOLVE_BENEATH semantics */ 294 295 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */ 296 #define F_RDLCK 1 /* shared or read lock */ 297 #define F_UNLCK 2 /* unlock */ 298 #define F_WRLCK 3 /* exclusive or write lock */ 299 #if __BSD_VISIBLE 300 #define F_UNLCKSYS 4 /* purge locks for a given system ID */ 301 #define F_CANCEL 5 /* cancel an async lock request */ 302 #endif 303 #ifdef _KERNEL 304 #define F_WAIT 0x010 /* Wait until lock is granted */ 305 #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */ 306 #define F_POSIX 0x040 /* Use POSIX semantics for lock */ 307 #define F_REMOTE 0x080 /* Lock owner is remote NFS client */ 308 #define F_NOINTR 0x100 /* Ignore signals when waiting */ 309 #define F_FIRSTOPEN 0x200 /* First right to advlock file */ 310 #endif 311 312 /* 313 * Advisory file segment locking data type - 314 * information passed to system by user 315 */ 316 struct flock { 317 off_t l_start; /* starting offset */ 318 off_t l_len; /* len = 0 means until end of file */ 319 pid_t l_pid; /* lock owner */ 320 short l_type; /* lock type: read/write, etc. */ 321 short l_whence; /* type of l_start */ 322 int l_sysid; /* remote system id or zero for local */ 323 }; 324 325 #if __BSD_VISIBLE 326 /* 327 * Old advisory file segment locking data type, 328 * before adding l_sysid. 329 */ 330 struct __oflock { 331 off_t l_start; /* starting offset */ 332 off_t l_len; /* len = 0 means until end of file */ 333 pid_t l_pid; /* lock owner */ 334 short l_type; /* lock type: read/write, etc. */ 335 short l_whence; /* type of l_start */ 336 }; 337 338 /* 339 * Space control offset/length description 340 */ 341 struct spacectl_range { 342 off_t r_offset; /* starting offset */ 343 off_t r_len; /* length */ 344 }; 345 #endif 346 347 #if __BSD_VISIBLE 348 /* lock operations for flock(2) */ 349 #define LOCK_SH 0x01 /* shared file lock */ 350 #define LOCK_EX 0x02 /* exclusive file lock */ 351 #define LOCK_NB 0x04 /* don't block when locking */ 352 #define LOCK_UN 0x08 /* unlock file */ 353 #endif 354 355 #if __POSIX_VISIBLE >= 200112 356 /* 357 * Advice to posix_fadvise 358 */ 359 #define POSIX_FADV_NORMAL 0 /* no special treatment */ 360 #define POSIX_FADV_RANDOM 1 /* expect random page references */ 361 #define POSIX_FADV_SEQUENTIAL 2 /* expect sequential page references */ 362 #define POSIX_FADV_WILLNEED 3 /* will need these pages */ 363 #define POSIX_FADV_DONTNEED 4 /* dont need these pages */ 364 #define POSIX_FADV_NOREUSE 5 /* access data only once */ 365 #endif 366 367 #ifdef __BSD_VISIBLE 368 /* 369 * Magic value that specify that corresponding file descriptor to filename 370 * is unknown and sanitary check should be omitted in the funlinkat() and 371 * similar syscalls. 372 */ 373 #define FD_NONE -200 374 375 /* 376 * Commands for fspacectl(2) 377 */ 378 #define SPACECTL_DEALLOC 1 /* deallocate space */ 379 380 /* 381 * fspacectl(2) flags 382 */ 383 #define SPACECTL_F_SUPPORTED 0 384 #endif 385 386 #ifndef _KERNEL 387 __BEGIN_DECLS 388 int open(const char *, int, ...); 389 int creat(const char *, mode_t); 390 int fcntl(int, int, ...); 391 #if __BSD_VISIBLE 392 int flock(int, int); 393 int fspacectl(int, int, const struct spacectl_range *, int, 394 struct spacectl_range *); 395 #endif 396 #if __POSIX_VISIBLE >= 200809 397 int openat(int, const char *, int, ...); 398 #endif 399 #if __POSIX_VISIBLE >= 200112 400 int posix_fadvise(int, off_t, off_t, int); 401 int posix_fallocate(int, off_t, off_t); 402 #endif 403 __END_DECLS 404 #endif 405 406 #endif /* !_SYS_FCNTL_H_ */ 407