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