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 #define O_XATTR O_NAMEDATTR /* Solaris compatibility */ 145 146 /* 147 * Emulate MacOSX compatibility flag without consuming a flags bit. 148 * It is not fully correct since reads over regular files opened with 149 * this definition fail. 150 */ 151 #define O_SYMLINK (O_PATH | O_NOFOLLOW) 152 #endif 153 154 #if __POSIX_VISIBLE >= 202405 155 #define O_CLOFORK 0x08000000 156 #endif 157 158 /* 159 * !!! DANGER !!! 160 * 161 * There are very few bits left for O_* flags. Every bit we consume for 162 * local features is one bit we can't use for future source compatibility 163 * with other operating systems. 164 * 165 * All additions should be coordinated with srcmgr@. 166 */ 167 168 /* 169 * XXX missing O_RSYNC. 170 */ 171 172 #ifdef _KERNEL 173 174 /* Only for devfs d_close() flags. */ 175 #define FLASTCLOSE O_DIRECTORY 176 #define FREVOKE O_VERIFY 177 /* Only for fo_close() from half-succeeded open */ 178 #define FOPENFAILED O_TTY_INIT 179 /* Only for O_PATH files which passed ACCESS FREAD check on open */ 180 #define FKQALLOWED O_RESOLVE_BENEATH 181 /* Flags userspace is allowed to pass to openat() */ 182 #define FUSERALLOWED (O_ACCMODE | O_NONBLOCK | O_APPEND | O_SHLOCK | \ 183 O_EXLOCK | O_ASYNC | O_SYNC | O_NOFOLLOW | O_CREAT | O_TRUNC | \ 184 O_EXCL | O_NOCTTY | O_DIRECT | O_DIRECTORY | O_EXEC | O_TTY_INIT | \ 185 O_CLOEXEC | O_VERIFY | O_PATH | O_RESOLVE_BENEATH | O_DSYNC | \ 186 O_EMPTY_PATH | O_NAMEDATTR | O_CLOFORK) 187 188 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */ 189 #define FFLAGS(oflags) ((oflags) & O_EXEC ? (oflags) : (oflags) + 1) 190 #define OFLAGS(fflags) \ 191 (((fflags) & (O_EXEC | O_PATH)) != 0 ? (fflags) : (fflags) - 1) 192 193 /* bits to save after open */ 194 #define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FDSYNC|FNONBLOCK| \ 195 O_DIRECT|FEXEC|O_PATH) 196 /* bits settable by fcntl(F_SETFL, ...) */ 197 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FDSYNC|FNONBLOCK|FRDAHEAD|O_DIRECT) 198 199 #if defined(COMPAT_FREEBSD7) || defined(COMPAT_FREEBSD6) || \ 200 defined(COMPAT_FREEBSD5) || defined(COMPAT_FREEBSD4) 201 /* 202 * Set by shm_open(3) in older libc's to get automatic MAP_ASYNC 203 * behavior for POSIX shared memory objects (which are otherwise 204 * implemented as plain files). 205 */ 206 #define FPOSIXSHM O_NOFOLLOW 207 #undef FCNTLFLAGS 208 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|FRDAHEAD| \ 209 O_DIRECT) 210 #endif 211 #endif 212 213 /* 214 * The O_* flags used to have only F* names, which were used in the kernel 215 * and by fcntl. We retain the F* names for the kernel f_flag field 216 * and for backward compatibility for fcntl. These flags are deprecated. 217 */ 218 #if __BSD_VISIBLE 219 #define FAPPEND O_APPEND /* kernel/compat */ 220 #define FASYNC O_ASYNC /* kernel/compat */ 221 #define FFSYNC O_FSYNC /* kernel */ 222 #define FDSYNC O_DSYNC /* kernel */ 223 #define FNONBLOCK O_NONBLOCK /* kernel */ 224 #define FNDELAY O_NONBLOCK /* compat */ 225 #define O_NDELAY O_NONBLOCK /* compat */ 226 #endif 227 228 /* 229 * Historically, we ran out of bits in f_flag (which was once a short). 230 * However, the flag bits not set in FMASK are only meaningful in the 231 * initial open syscall. Those bits were thus given a 232 * different meaning for fcntl(2). 233 */ 234 #if __BSD_VISIBLE 235 /* Read ahead */ 236 #define FRDAHEAD O_CREAT 237 #endif 238 239 #if __POSIX_VISIBLE >= 200809 240 /* 241 * Magic value that specify the use of the current working directory 242 * to determine the target of relative file paths in the openat() and 243 * similar syscalls. 244 */ 245 #define AT_FDCWD -100 246 247 /* 248 * Miscellaneous flags for the *at() syscalls. 249 */ 250 #define AT_EACCESS 0x0100 /* Check access using effective user 251 and group ID */ 252 #define AT_SYMLINK_NOFOLLOW 0x0200 /* Do not follow symbolic links */ 253 #define AT_SYMLINK_FOLLOW 0x0400 /* Follow symbolic link */ 254 #define AT_REMOVEDIR 0x0800 /* Remove directory instead of file */ 255 #endif /* __POSIX_VISIBLE >= 200809 */ 256 #if __BSD_VISIBLE 257 /* #define AT_UNUSED1 0x1000 *//* Was AT_BENEATH */ 258 #define AT_RESOLVE_BENEATH 0x2000 /* Do not allow name resolution 259 to walk out of dirfd */ 260 #define AT_EMPTY_PATH 0x4000 /* Operate on dirfd if path is empty */ 261 262 #define AT_RENAME_NOREPLACE 0x0001 /* Fail rename if target exists */ 263 #define RENAME_NOREPLACE AT_RENAME_NOREPLACE 264 #endif /* __BSD_VISIBLE */ 265 266 /* 267 * Constants used for fcntl(2) 268 */ 269 270 /* command values */ 271 #define F_DUPFD 0 /* duplicate file descriptor */ 272 #define F_GETFD 1 /* get file descriptor flags */ 273 #define F_SETFD 2 /* set file descriptor flags */ 274 #define F_GETFL 3 /* get file status flags */ 275 #define F_SETFL 4 /* set file status flags */ 276 #if __XSI_VISIBLE || __POSIX_VISIBLE >= 200112 277 #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */ 278 #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */ 279 #endif 280 #if __BSD_VISIBLE 281 #define F_OGETLK 7 /* get record locking information */ 282 #define F_OSETLK 8 /* set record locking information */ 283 #define F_OSETLKW 9 /* F_SETLK; wait if blocked */ 284 #define F_DUP2FD 10 /* duplicate file descriptor to arg */ 285 #endif 286 #define F_GETLK 11 /* get record locking information */ 287 #define F_SETLK 12 /* set record locking information */ 288 #define F_SETLKW 13 /* F_SETLK; wait if blocked */ 289 #if __BSD_VISIBLE 290 #define F_SETLK_REMOTE 14 /* debugging support for remote locks */ 291 #define F_READAHEAD 15 /* read ahead */ 292 #define F_RDAHEAD 16 /* Darwin compatible read ahead */ 293 #endif 294 #if __POSIX_VISIBLE >= 200809 295 #define F_DUPFD_CLOEXEC 17 /* Like F_DUPFD, but FD_CLOEXEC is set */ 296 #endif 297 #if __BSD_VISIBLE 298 #define F_DUP2FD_CLOEXEC 18 /* Like F_DUP2FD, but FD_CLOEXEC is set */ 299 #define F_ADD_SEALS 19 300 #define F_GET_SEALS 20 301 #define F_ISUNIONSTACK 21 /* Kludge for libc, don't use it. */ 302 #define F_KINFO 22 /* Return kinfo_file for this fd */ 303 #endif /* __BSD_VISIBLE */ 304 305 #if __POSIX_VISIBLE >= 202405 306 #define F_DUPFD_CLOFORK 23 /* Like F_DUPFD, but FD_CLOFORK is set */ 307 #endif 308 309 #if __BSD_VISIBLE 310 #define F_DUP3FD 24 /* Used with dup3() */ 311 312 #define F_DUP3FD_SHIFT 16 /* Shift used for F_DUP3FD */ 313 314 /* Seals (F_ADD_SEALS, F_GET_SEALS). */ 315 #define F_SEAL_SEAL 0x0001 /* Prevent adding sealings */ 316 #define F_SEAL_SHRINK 0x0002 /* May not shrink */ 317 #define F_SEAL_GROW 0x0004 /* May not grow */ 318 #define F_SEAL_WRITE 0x0008 /* May not write */ 319 #endif /* __BSD_VISIBLE */ 320 321 /* file descriptor flags (F_GETFD, F_SETFD) */ 322 #define FD_CLOEXEC 1 /* close-on-exec flag */ 323 #define FD_RESOLVE_BENEATH 2 /* all lookups relative to fd have 324 O_RESOLVE_BENEATH semantics */ 325 #if __POSIX_VISIBLE >= 202405 326 #define FD_CLOFORK 4 /* close-on-fork flag */ 327 #endif 328 329 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */ 330 #define F_RDLCK 1 /* shared or read lock */ 331 #define F_UNLCK 2 /* unlock */ 332 #define F_WRLCK 3 /* exclusive or write lock */ 333 #if __BSD_VISIBLE 334 #define F_UNLCKSYS 4 /* purge locks for a given system ID */ 335 #define F_CANCEL 5 /* cancel an async lock request */ 336 #endif 337 #ifdef _KERNEL 338 #define F_WAIT 0x010 /* Wait until lock is granted */ 339 #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */ 340 #define F_POSIX 0x040 /* Use POSIX semantics for lock */ 341 #define F_REMOTE 0x080 /* Lock owner is remote NFS client */ 342 #define F_NOINTR 0x100 /* Ignore signals when waiting */ 343 #define F_FIRSTOPEN 0x200 /* First right to advlock file */ 344 #endif 345 346 /* 347 * Advisory file segment locking data type - 348 * information passed to system by user 349 */ 350 struct flock { 351 off_t l_start; /* starting offset */ 352 off_t l_len; /* len = 0 means until end of file */ 353 pid_t l_pid; /* lock owner */ 354 short l_type; /* lock type: read/write, etc. */ 355 short l_whence; /* type of l_start */ 356 int l_sysid; /* remote system id or zero for local */ 357 }; 358 359 #if __BSD_VISIBLE 360 /* 361 * Old advisory file segment locking data type, 362 * before adding l_sysid. 363 */ 364 struct __oflock { 365 off_t l_start; /* starting offset */ 366 off_t l_len; /* len = 0 means until end of file */ 367 pid_t l_pid; /* lock owner */ 368 short l_type; /* lock type: read/write, etc. */ 369 short l_whence; /* type of l_start */ 370 }; 371 372 /* 373 * Space control offset/length description 374 */ 375 struct spacectl_range { 376 off_t r_offset; /* starting offset */ 377 off_t r_len; /* length */ 378 }; 379 #endif 380 381 #if __BSD_VISIBLE 382 /* lock operations for flock(2) */ 383 #define LOCK_SH 0x01 /* shared file lock */ 384 #define LOCK_EX 0x02 /* exclusive file lock */ 385 #define LOCK_NB 0x04 /* don't block when locking */ 386 #define LOCK_UN 0x08 /* unlock file */ 387 #endif 388 389 #if __POSIX_VISIBLE >= 200112 390 /* 391 * Advice to posix_fadvise 392 */ 393 #define POSIX_FADV_NORMAL 0 /* no special treatment */ 394 #define POSIX_FADV_RANDOM 1 /* expect random page references */ 395 #define POSIX_FADV_SEQUENTIAL 2 /* expect sequential page references */ 396 #define POSIX_FADV_WILLNEED 3 /* will need these pages */ 397 #define POSIX_FADV_DONTNEED 4 /* dont need these pages */ 398 #define POSIX_FADV_NOREUSE 5 /* access data only once */ 399 #endif 400 401 #ifdef __BSD_VISIBLE 402 /* 403 * Magic value that specify that corresponding file descriptor to filename 404 * is unknown and sanitary check should be omitted in the funlinkat() and 405 * similar syscalls. 406 */ 407 #define FD_NONE -200 408 409 /* 410 * Commands for fspacectl(2) 411 */ 412 #define SPACECTL_DEALLOC 1 /* deallocate space */ 413 414 /* 415 * fspacectl(2) flags 416 */ 417 #define SPACECTL_F_SUPPORTED 0 418 #endif 419 420 #ifndef _KERNEL 421 __BEGIN_DECLS 422 int open(const char *, int, ...); 423 int creat(const char *, mode_t); 424 int fcntl(int, int, ...); 425 #if __BSD_VISIBLE 426 int flock(int, int); 427 int fspacectl(int, int, const struct spacectl_range *, int, 428 struct spacectl_range *); 429 #endif 430 #if __POSIX_VISIBLE >= 200809 431 int openat(int, const char *, int, ...); 432 #endif 433 #if __POSIX_VISIBLE >= 200112 434 int posix_fadvise(int, off_t, off_t, int); 435 int posix_fallocate(int, off_t, off_t); 436 #endif 437 __END_DECLS 438 #endif 439 440 #endif /* !_SYS_FCNTL_H_ */ 441