1*199767f8SToomas Soome /*- 2*199767f8SToomas Soome * Copyright (c) 1983, 1990, 1993 3*199767f8SToomas Soome * The Regents of the University of California. All rights reserved. 4*199767f8SToomas Soome * (c) UNIX System Laboratories, Inc. 5*199767f8SToomas Soome * All or some portions of this file are derived from material licensed 6*199767f8SToomas Soome * to the University of California by American Telephone and Telegraph 7*199767f8SToomas Soome * Co. or Unix System Laboratories, Inc. and are reproduced herein with 8*199767f8SToomas Soome * the permission of UNIX System Laboratories, Inc. 9*199767f8SToomas Soome * 10*199767f8SToomas Soome * Redistribution and use in source and binary forms, with or without 11*199767f8SToomas Soome * modification, are permitted provided that the following conditions 12*199767f8SToomas Soome * are met: 13*199767f8SToomas Soome * 1. Redistributions of source code must retain the above copyright 14*199767f8SToomas Soome * notice, this list of conditions and the following disclaimer. 15*199767f8SToomas Soome * 2. Redistributions in binary form must reproduce the above copyright 16*199767f8SToomas Soome * notice, this list of conditions and the following disclaimer in the 17*199767f8SToomas Soome * documentation and/or other materials provided with the distribution. 18*199767f8SToomas Soome * 4. Neither the name of the University nor the names of its contributors 19*199767f8SToomas Soome * may be used to endorse or promote products derived from this software 20*199767f8SToomas Soome * without specific prior written permission. 21*199767f8SToomas Soome * 22*199767f8SToomas Soome * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23*199767f8SToomas Soome * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24*199767f8SToomas Soome * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25*199767f8SToomas Soome * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26*199767f8SToomas Soome * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27*199767f8SToomas Soome * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28*199767f8SToomas Soome * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29*199767f8SToomas Soome * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30*199767f8SToomas Soome * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31*199767f8SToomas Soome * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32*199767f8SToomas Soome * SUCH DAMAGE. 33*199767f8SToomas Soome * 34*199767f8SToomas Soome * @(#)fcntl.h 8.3 (Berkeley) 1/21/94 35*199767f8SToomas Soome * $FreeBSD$ 36*199767f8SToomas Soome */ 37*199767f8SToomas Soome 38*199767f8SToomas Soome #ifndef _SYS_FCNTL_H_ 39*199767f8SToomas Soome #define _SYS_FCNTL_H_ 40*199767f8SToomas Soome 41*199767f8SToomas Soome /* 42*199767f8SToomas Soome * This file includes the definitions for open and fcntl 43*199767f8SToomas Soome * described by POSIX for <fcntl.h>; it also includes 44*199767f8SToomas Soome * related kernel definitions. 45*199767f8SToomas Soome */ 46*199767f8SToomas Soome 47*199767f8SToomas Soome #include <sys/cdefs.h> 48*199767f8SToomas Soome #include <sys/_types.h> 49*199767f8SToomas Soome 50*199767f8SToomas Soome #ifndef _MODE_T_DECLARED 51*199767f8SToomas Soome typedef __mode_t mode_t; 52*199767f8SToomas Soome #define _MODE_T_DECLARED 53*199767f8SToomas Soome #endif 54*199767f8SToomas Soome 55*199767f8SToomas Soome #ifndef _OFF_T_DECLARED 56*199767f8SToomas Soome typedef __off_t off_t; 57*199767f8SToomas Soome #define _OFF_T_DECLARED 58*199767f8SToomas Soome #endif 59*199767f8SToomas Soome 60*199767f8SToomas Soome #ifndef _PID_T_DECLARED 61*199767f8SToomas Soome typedef __pid_t pid_t; 62*199767f8SToomas Soome #define _PID_T_DECLARED 63*199767f8SToomas Soome #endif 64*199767f8SToomas Soome 65*199767f8SToomas Soome /* 66*199767f8SToomas Soome * File status flags: these are used by open(2), fcntl(2). 67*199767f8SToomas Soome * They are also used (indirectly) in the kernel file structure f_flags, 68*199767f8SToomas Soome * which is a superset of the open/fcntl flags. Open flags and f_flags 69*199767f8SToomas Soome * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags). 70*199767f8SToomas Soome * Open/fcntl flags begin with O_; kernel-internal flags begin with F. 71*199767f8SToomas Soome */ 72*199767f8SToomas Soome /* open-only flags */ 73*199767f8SToomas Soome #define O_RDONLY 0x0000 /* open for reading only */ 74*199767f8SToomas Soome #define O_WRONLY 0x0001 /* open for writing only */ 75*199767f8SToomas Soome #define O_RDWR 0x0002 /* open for reading and writing */ 76*199767f8SToomas Soome #define O_ACCMODE 0x0003 /* mask for above modes */ 77*199767f8SToomas Soome 78*199767f8SToomas Soome /* 79*199767f8SToomas Soome * Kernel encoding of open mode; separate read and write bits that are 80*199767f8SToomas Soome * independently testable: 1 greater than the above. 81*199767f8SToomas Soome * 82*199767f8SToomas Soome * XXX 83*199767f8SToomas Soome * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH, 84*199767f8SToomas Soome * which was documented to use FREAD/FWRITE, continues to work. 85*199767f8SToomas Soome */ 86*199767f8SToomas Soome #if __BSD_VISIBLE 87*199767f8SToomas Soome #define FREAD 0x0001 88*199767f8SToomas Soome #define FWRITE 0x0002 89*199767f8SToomas Soome #endif 90*199767f8SToomas Soome #define O_NONBLOCK 0x0004 /* no delay */ 91*199767f8SToomas Soome #define O_APPEND 0x0008 /* set append mode */ 92*199767f8SToomas Soome #if __BSD_VISIBLE 93*199767f8SToomas Soome #define O_SHLOCK 0x0010 /* open with shared file lock */ 94*199767f8SToomas Soome #define O_EXLOCK 0x0020 /* open with exclusive file lock */ 95*199767f8SToomas Soome #define O_ASYNC 0x0040 /* signal pgrp when data ready */ 96*199767f8SToomas Soome #define O_FSYNC 0x0080 /* synchronous writes */ 97*199767f8SToomas Soome #endif 98*199767f8SToomas Soome #define O_SYNC 0x0080 /* POSIX synonym for O_FSYNC */ 99*199767f8SToomas Soome #if __POSIX_VISIBLE >= 200809 100*199767f8SToomas Soome #define O_NOFOLLOW 0x0100 /* don't follow symlinks */ 101*199767f8SToomas Soome #endif 102*199767f8SToomas Soome #define O_CREAT 0x0200 /* create if nonexistent */ 103*199767f8SToomas Soome #define O_TRUNC 0x0400 /* truncate to zero length */ 104*199767f8SToomas Soome #define O_EXCL 0x0800 /* error if already exists */ 105*199767f8SToomas Soome #ifdef _KERNEL 106*199767f8SToomas Soome #define FHASLOCK 0x4000 /* descriptor holds advisory lock */ 107*199767f8SToomas Soome #endif 108*199767f8SToomas Soome 109*199767f8SToomas Soome /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */ 110*199767f8SToomas Soome #define O_NOCTTY 0x8000 /* don't assign controlling terminal */ 111*199767f8SToomas Soome 112*199767f8SToomas Soome #if __BSD_VISIBLE 113*199767f8SToomas Soome /* Attempt to bypass buffer cache */ 114*199767f8SToomas Soome #define O_DIRECT 0x00010000 115*199767f8SToomas Soome #endif 116*199767f8SToomas Soome 117*199767f8SToomas Soome #if __POSIX_VISIBLE >= 200809 118*199767f8SToomas Soome #define O_DIRECTORY 0x00020000 /* Fail if not directory */ 119*199767f8SToomas Soome #define O_EXEC 0x00040000 /* Open for execute only */ 120*199767f8SToomas Soome #endif 121*199767f8SToomas Soome #ifdef _KERNEL 122*199767f8SToomas Soome #define FEXEC O_EXEC 123*199767f8SToomas Soome #endif 124*199767f8SToomas Soome 125*199767f8SToomas Soome #if __POSIX_VISIBLE >= 200809 126*199767f8SToomas Soome /* Defined by POSIX 1003.1-2008; BSD default, but reserve for future use. */ 127*199767f8SToomas Soome #define O_TTY_INIT 0x00080000 /* Restore default termios attributes */ 128*199767f8SToomas Soome 129*199767f8SToomas Soome #define O_CLOEXEC 0x00100000 130*199767f8SToomas Soome #endif 131*199767f8SToomas Soome 132*199767f8SToomas Soome #if __BSD_VISIBLE 133*199767f8SToomas Soome #define O_VERIFY 0x00200000 /* open only after verification */ 134*199767f8SToomas Soome #endif 135*199767f8SToomas Soome 136*199767f8SToomas Soome /* 137*199767f8SToomas Soome * XXX missing O_DSYNC, O_RSYNC. 138*199767f8SToomas Soome */ 139*199767f8SToomas Soome 140*199767f8SToomas Soome #ifdef _KERNEL 141*199767f8SToomas Soome 142*199767f8SToomas Soome /* Only for devfs d_close() flags. */ 143*199767f8SToomas Soome #define FLASTCLOSE O_DIRECTORY 144*199767f8SToomas Soome #define FREVOKE O_VERIFY 145*199767f8SToomas Soome /* Only for fo_close() from half-succeeded open */ 146*199767f8SToomas Soome #define FOPENFAILED O_TTY_INIT 147*199767f8SToomas Soome 148*199767f8SToomas Soome /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */ 149*199767f8SToomas Soome #define FFLAGS(oflags) ((oflags) & O_EXEC ? (oflags) : (oflags) + 1) 150*199767f8SToomas Soome #define OFLAGS(fflags) ((fflags) & O_EXEC ? (fflags) : (fflags) - 1) 151*199767f8SToomas Soome 152*199767f8SToomas Soome /* bits to save after open */ 153*199767f8SToomas Soome #define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|O_DIRECT|FEXEC) 154*199767f8SToomas Soome /* bits settable by fcntl(F_SETFL, ...) */ 155*199767f8SToomas Soome #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FRDAHEAD|O_DIRECT) 156*199767f8SToomas Soome 157*199767f8SToomas Soome #if defined(COMPAT_FREEBSD7) || defined(COMPAT_FREEBSD6) || \ 158*199767f8SToomas Soome defined(COMPAT_FREEBSD5) || defined(COMPAT_FREEBSD4) 159*199767f8SToomas Soome /* 160*199767f8SToomas Soome * Set by shm_open(3) in older libc's to get automatic MAP_ASYNC 161*199767f8SToomas Soome * behavior for POSIX shared memory objects (which are otherwise 162*199767f8SToomas Soome * implemented as plain files). 163*199767f8SToomas Soome */ 164*199767f8SToomas Soome #define FPOSIXSHM O_NOFOLLOW 165*199767f8SToomas Soome #undef FCNTLFLAGS 166*199767f8SToomas Soome #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|FRDAHEAD| \ 167*199767f8SToomas Soome O_DIRECT) 168*199767f8SToomas Soome #endif 169*199767f8SToomas Soome #endif 170*199767f8SToomas Soome 171*199767f8SToomas Soome /* 172*199767f8SToomas Soome * The O_* flags used to have only F* names, which were used in the kernel 173*199767f8SToomas Soome * and by fcntl. We retain the F* names for the kernel f_flag field 174*199767f8SToomas Soome * and for backward compatibility for fcntl. These flags are deprecated. 175*199767f8SToomas Soome */ 176*199767f8SToomas Soome #if __BSD_VISIBLE 177*199767f8SToomas Soome #define FAPPEND O_APPEND /* kernel/compat */ 178*199767f8SToomas Soome #define FASYNC O_ASYNC /* kernel/compat */ 179*199767f8SToomas Soome #define FFSYNC O_FSYNC /* kernel */ 180*199767f8SToomas Soome #define FNONBLOCK O_NONBLOCK /* kernel */ 181*199767f8SToomas Soome #define FNDELAY O_NONBLOCK /* compat */ 182*199767f8SToomas Soome #define O_NDELAY O_NONBLOCK /* compat */ 183*199767f8SToomas Soome #endif 184*199767f8SToomas Soome 185*199767f8SToomas Soome /* 186*199767f8SToomas Soome * We are out of bits in f_flag (which is a short). However, 187*199767f8SToomas Soome * the flag bits not set in FMASK are only meaningful in the 188*199767f8SToomas Soome * initial open syscall. Those bits can thus be given a 189*199767f8SToomas Soome * different meaning for fcntl(2). 190*199767f8SToomas Soome */ 191*199767f8SToomas Soome #if __BSD_VISIBLE 192*199767f8SToomas Soome /* Read ahead */ 193*199767f8SToomas Soome #define FRDAHEAD O_CREAT 194*199767f8SToomas Soome #endif 195*199767f8SToomas Soome 196*199767f8SToomas Soome #if __POSIX_VISIBLE >= 200809 197*199767f8SToomas Soome /* 198*199767f8SToomas Soome * Magic value that specify the use of the current working directory 199*199767f8SToomas Soome * to determine the target of relative file paths in the openat() and 200*199767f8SToomas Soome * similar syscalls. 201*199767f8SToomas Soome */ 202*199767f8SToomas Soome #define AT_FDCWD -100 203*199767f8SToomas Soome 204*199767f8SToomas Soome /* 205*199767f8SToomas Soome * Miscellaneous flags for the *at() syscalls. 206*199767f8SToomas Soome */ 207*199767f8SToomas Soome #define AT_EACCESS 0x100 /* Check access using effective user and group ID */ 208*199767f8SToomas Soome #define AT_SYMLINK_NOFOLLOW 0x200 /* Do not follow symbolic links */ 209*199767f8SToomas Soome #define AT_SYMLINK_FOLLOW 0x400 /* Follow symbolic link */ 210*199767f8SToomas Soome #define AT_REMOVEDIR 0x800 /* Remove directory instead of file */ 211*199767f8SToomas Soome #endif 212*199767f8SToomas Soome 213*199767f8SToomas Soome /* 214*199767f8SToomas Soome * Constants used for fcntl(2) 215*199767f8SToomas Soome */ 216*199767f8SToomas Soome 217*199767f8SToomas Soome /* command values */ 218*199767f8SToomas Soome #define F_DUPFD 0 /* duplicate file descriptor */ 219*199767f8SToomas Soome #define F_GETFD 1 /* get file descriptor flags */ 220*199767f8SToomas Soome #define F_SETFD 2 /* set file descriptor flags */ 221*199767f8SToomas Soome #define F_GETFL 3 /* get file status flags */ 222*199767f8SToomas Soome #define F_SETFL 4 /* set file status flags */ 223*199767f8SToomas Soome #if __XSI_VISIBLE || __POSIX_VISIBLE >= 200112 224*199767f8SToomas Soome #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */ 225*199767f8SToomas Soome #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */ 226*199767f8SToomas Soome #endif 227*199767f8SToomas Soome #if __BSD_VISIBLE 228*199767f8SToomas Soome #define F_OGETLK 7 /* get record locking information */ 229*199767f8SToomas Soome #define F_OSETLK 8 /* set record locking information */ 230*199767f8SToomas Soome #define F_OSETLKW 9 /* F_SETLK; wait if blocked */ 231*199767f8SToomas Soome #define F_DUP2FD 10 /* duplicate file descriptor to arg */ 232*199767f8SToomas Soome #endif 233*199767f8SToomas Soome #define F_GETLK 11 /* get record locking information */ 234*199767f8SToomas Soome #define F_SETLK 12 /* set record locking information */ 235*199767f8SToomas Soome #define F_SETLKW 13 /* F_SETLK; wait if blocked */ 236*199767f8SToomas Soome #if __BSD_VISIBLE 237*199767f8SToomas Soome #define F_SETLK_REMOTE 14 /* debugging support for remote locks */ 238*199767f8SToomas Soome #define F_READAHEAD 15 /* read ahead */ 239*199767f8SToomas Soome #define F_RDAHEAD 16 /* Darwin compatible read ahead */ 240*199767f8SToomas Soome #endif 241*199767f8SToomas Soome #if __POSIX_VISIBLE >= 200809 242*199767f8SToomas Soome #define F_DUPFD_CLOEXEC 17 /* Like F_DUPFD, but FD_CLOEXEC is set */ 243*199767f8SToomas Soome #endif 244*199767f8SToomas Soome #if __BSD_VISIBLE 245*199767f8SToomas Soome #define F_DUP2FD_CLOEXEC 18 /* Like F_DUP2FD, but FD_CLOEXEC is set */ 246*199767f8SToomas Soome #endif 247*199767f8SToomas Soome 248*199767f8SToomas Soome /* file descriptor flags (F_GETFD, F_SETFD) */ 249*199767f8SToomas Soome #define FD_CLOEXEC 1 /* close-on-exec flag */ 250*199767f8SToomas Soome 251*199767f8SToomas Soome /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */ 252*199767f8SToomas Soome #define F_RDLCK 1 /* shared or read lock */ 253*199767f8SToomas Soome #define F_UNLCK 2 /* unlock */ 254*199767f8SToomas Soome #define F_WRLCK 3 /* exclusive or write lock */ 255*199767f8SToomas Soome #if __BSD_VISIBLE 256*199767f8SToomas Soome #define F_UNLCKSYS 4 /* purge locks for a given system ID */ 257*199767f8SToomas Soome #define F_CANCEL 5 /* cancel an async lock request */ 258*199767f8SToomas Soome #endif 259*199767f8SToomas Soome #ifdef _KERNEL 260*199767f8SToomas Soome #define F_WAIT 0x010 /* Wait until lock is granted */ 261*199767f8SToomas Soome #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */ 262*199767f8SToomas Soome #define F_POSIX 0x040 /* Use POSIX semantics for lock */ 263*199767f8SToomas Soome #define F_REMOTE 0x080 /* Lock owner is remote NFS client */ 264*199767f8SToomas Soome #define F_NOINTR 0x100 /* Ignore signals when waiting */ 265*199767f8SToomas Soome #endif 266*199767f8SToomas Soome 267*199767f8SToomas Soome /* 268*199767f8SToomas Soome * Advisory file segment locking data type - 269*199767f8SToomas Soome * information passed to system by user 270*199767f8SToomas Soome */ 271*199767f8SToomas Soome struct flock { 272*199767f8SToomas Soome off_t l_start; /* starting offset */ 273*199767f8SToomas Soome off_t l_len; /* len = 0 means until end of file */ 274*199767f8SToomas Soome pid_t l_pid; /* lock owner */ 275*199767f8SToomas Soome short l_type; /* lock type: read/write, etc. */ 276*199767f8SToomas Soome short l_whence; /* type of l_start */ 277*199767f8SToomas Soome int l_sysid; /* remote system id or zero for local */ 278*199767f8SToomas Soome }; 279*199767f8SToomas Soome 280*199767f8SToomas Soome #if __BSD_VISIBLE 281*199767f8SToomas Soome /* 282*199767f8SToomas Soome * Old advisory file segment locking data type, 283*199767f8SToomas Soome * before adding l_sysid. 284*199767f8SToomas Soome */ 285*199767f8SToomas Soome struct __oflock { 286*199767f8SToomas Soome off_t l_start; /* starting offset */ 287*199767f8SToomas Soome off_t l_len; /* len = 0 means until end of file */ 288*199767f8SToomas Soome pid_t l_pid; /* lock owner */ 289*199767f8SToomas Soome short l_type; /* lock type: read/write, etc. */ 290*199767f8SToomas Soome short l_whence; /* type of l_start */ 291*199767f8SToomas Soome }; 292*199767f8SToomas Soome #endif 293*199767f8SToomas Soome 294*199767f8SToomas Soome #if __BSD_VISIBLE 295*199767f8SToomas Soome /* lock operations for flock(2) */ 296*199767f8SToomas Soome #define LOCK_SH 0x01 /* shared file lock */ 297*199767f8SToomas Soome #define LOCK_EX 0x02 /* exclusive file lock */ 298*199767f8SToomas Soome #define LOCK_NB 0x04 /* don't block when locking */ 299*199767f8SToomas Soome #define LOCK_UN 0x08 /* unlock file */ 300*199767f8SToomas Soome #endif 301*199767f8SToomas Soome 302*199767f8SToomas Soome #if __POSIX_VISIBLE >= 200112 303*199767f8SToomas Soome /* 304*199767f8SToomas Soome * Advice to posix_fadvise 305*199767f8SToomas Soome */ 306*199767f8SToomas Soome #define POSIX_FADV_NORMAL 0 /* no special treatment */ 307*199767f8SToomas Soome #define POSIX_FADV_RANDOM 1 /* expect random page references */ 308*199767f8SToomas Soome #define POSIX_FADV_SEQUENTIAL 2 /* expect sequential page references */ 309*199767f8SToomas Soome #define POSIX_FADV_WILLNEED 3 /* will need these pages */ 310*199767f8SToomas Soome #define POSIX_FADV_DONTNEED 4 /* dont need these pages */ 311*199767f8SToomas Soome #define POSIX_FADV_NOREUSE 5 /* access data only once */ 312*199767f8SToomas Soome #endif 313*199767f8SToomas Soome 314*199767f8SToomas Soome #ifndef _KERNEL 315*199767f8SToomas Soome __BEGIN_DECLS 316*199767f8SToomas Soome int open(const char *, int, ...); 317*199767f8SToomas Soome int creat(const char *, mode_t); 318*199767f8SToomas Soome int fcntl(int, int, ...); 319*199767f8SToomas Soome #if __BSD_VISIBLE 320*199767f8SToomas Soome int flock(int, int); 321*199767f8SToomas Soome #endif 322*199767f8SToomas Soome #if __POSIX_VISIBLE >= 200809 323*199767f8SToomas Soome int openat(int, const char *, int, ...); 324*199767f8SToomas Soome #endif 325*199767f8SToomas Soome #if __POSIX_VISIBLE >= 200112 326*199767f8SToomas Soome int posix_fadvise(int, off_t, off_t, int); 327*199767f8SToomas Soome int posix_fallocate(int, off_t, off_t); 328*199767f8SToomas Soome #endif 329*199767f8SToomas Soome __END_DECLS 330*199767f8SToomas Soome #endif 331*199767f8SToomas Soome 332*199767f8SToomas Soome #endif /* !_SYS_FCNTL_H_ */ 333