| 1 | /*- |
| 2 | * Copyright (c) 1983, 1990, 1993 |
| 3 | * The Regents of the University of California. All rights reserved. |
| 4 | * (c) UNIX System Laboratories, Inc. |
| 5 | * All or some portions of this file are derived from material licensed |
| 6 | * to the University of California by American Telephone and Telegraph |
| 7 | * Co. or Unix System Laboratories, Inc. and are reproduced herein with |
| 8 | * the permission of UNIX System Laboratories, Inc. |
| 9 | * |
| 10 | * Redistribution and use in source and binary forms, with or without |
| 11 | * modification, are permitted provided that the following conditions |
| 12 | * are met: |
| 13 | * 1. Redistributions of source code must retain the above copyright |
| 14 | * notice, this list of conditions and the following disclaimer. |
| 15 | * 2. Redistributions in binary form must reproduce the above copyright |
| 16 | * notice, this list of conditions and the following disclaimer in the |
| 17 | * documentation and/or other materials provided with the distribution. |
| 18 | * 3. All advertising materials mentioning features or use of this software |
| 19 | * must display the following acknowledgement: |
| 20 | * This product includes software developed by the University of |
| 21 | * California, Berkeley and its contributors. |
| 22 | * 4. Neither the name of the University nor the names of its contributors |
| 23 | * may be used to endorse or promote products derived from this software |
| 24 | * without specific prior written permission. |
| 25 | * |
| 26 | * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND |
| 27 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 28 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 29 | * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE |
| 30 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 31 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 32 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 33 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| 34 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| 35 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 36 | * SUCH DAMAGE. |
| 37 | * |
| 38 | * @(#)fcntl.h 8.3 (Berkeley) 1/21/94 |
| 39 | * $FreeBSD: src/sys/sys/fcntl.h,v 1.9.2.2 2001/06/03 05:00:10 dillon Exp $ |
| 40 | * $DragonFly: src/sys/sys/fcntl.h,v 1.14 2008/02/12 20:00:38 corecode Exp $ |
| 41 | */ |
| 42 | |
| 43 | #ifndef _SYS_FCNTL_H_ |
| 44 | #define _SYS_FCNTL_H_ |
| 45 | |
| 46 | #ifndef _SYS_TYPES_H_ |
| 47 | #include <sys/types.h> |
| 48 | #endif |
| 49 | |
| 50 | /* |
| 51 | * File status flags: these are used by open(2), fcntl(2). |
| 52 | * They are also used (indirectly) in the kernel file structure f_flags, |
| 53 | * which is a superset of the open/fcntl flags. Open flags and f_flags |
| 54 | * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags). |
| 55 | * Open/fcntl flags begin with O_; kernel-internal flags begin with F. |
| 56 | */ |
| 57 | /* open-only flags */ |
| 58 | #define O_RDONLY 0x0000 /* open for reading only */ |
| 59 | #define O_WRONLY 0x0001 /* open for writing only */ |
| 60 | #define O_RDWR 0x0002 /* open for reading and writing */ |
| 61 | #define O_ACCMODE 0x0003 /* mask for above modes */ |
| 62 | |
| 63 | /* |
| 64 | * Kernel encoding of open mode; separate read and write bits that are |
| 65 | * independently testable: 1 greater than the above. |
| 66 | * |
| 67 | * XXX |
| 68 | * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH, |
| 69 | * which was documented to use FREAD/FWRITE, continues to work. |
| 70 | */ |
| 71 | #ifndef _POSIX_SOURCE |
| 72 | #define FREAD 0x0001 |
| 73 | #define FWRITE 0x0002 |
| 74 | #endif |
| 75 | #define O_NONBLOCK 0x0004 /* no delay */ |
| 76 | #define O_APPEND 0x0008 /* set append mode */ |
| 77 | #ifndef _POSIX_SOURCE |
| 78 | #define O_SHLOCK 0x0010 /* open with shared file lock */ |
| 79 | #define O_EXLOCK 0x0020 /* open with exclusive file lock */ |
| 80 | #define O_ASYNC 0x0040 /* signal pgrp when data ready */ |
| 81 | #define O_FSYNC 0x0080 /* synchronous writes */ |
| 82 | #define O_NOFOLLOW 0x0100 /* don't follow symlinks */ |
| 83 | #endif |
| 84 | #define O_SYNC 0x0080 /* Same as O_FSYNC, but POSIX */ |
| 85 | #define O_CREAT 0x0200 /* create if nonexistent */ |
| 86 | #define O_TRUNC 0x0400 /* truncate to zero length */ |
| 87 | #define O_EXCL 0x0800 /* error if already exists */ |
| 88 | #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) |
| 89 | #define FMARK 0x1000 /* mark during gc() */ |
| 90 | #define FDEFER 0x2000 /* defer for next gc pass */ |
| 91 | #define FHASLOCK 0x4000 /* descriptor holds advisory lock */ |
| 92 | #endif |
| 93 | |
| 94 | /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */ |
| 95 | #define O_NOCTTY 0x8000 /* don't assign controlling terminal */ |
| 96 | |
| 97 | /* Attempt to bypass the buffer cache */ |
| 98 | #define O_DIRECT 0x00010000 |
| 99 | |
| 100 | #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) |
| 101 | #define O_ROOTCRED 0x00020000 /* fp_open */ |
| 102 | #endif |
| 103 | |
| 104 | #define O_FBLOCKING 0x00040000 /* force blocking I/O */ |
| 105 | #define O_FNONBLOCKING 0x00080000 /* force non-blocking I/O */ |
| 106 | #define O_FAPPEND 0x00100000 /* force append mode for write */ |
| 107 | #define O_FOFFSET 0x00200000 /* force specific offset */ |
| 108 | #define O_FSYNCWRITE 0x00400000 /* force synchronous write */ |
| 109 | #define O_FASYNCWRITE 0x00800000 /* force asynchronous write */ |
| 110 | #define O_FUNBUFFERED 0x01000000 /* force unbuffered (direct) I/O */ |
| 111 | #define O_FBUFFERED 0x02000000 /* force buffered I/O */ |
| 112 | #define O_MAPONREAD 0x04000000 /* memory map read buffer */ |
| 113 | |
| 114 | #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) |
| 115 | #define FREVOKED 0x10000000 /* revoked by fdrevoke() */ |
| 116 | #define FAPPENDONLY 0x20000000 /* O_APPEND cannot be changed */ |
| 117 | #endif |
| 118 | |
| 119 | #define O_FMASK (O_FBLOCKING|O_FNONBLOCKING|O_FAPPEND|O_FOFFSET|\ |
| 120 | O_FSYNCWRITE|O_FASYNCWRITE|O_FUNBUFFERED|O_FBUFFERED|\ |
| 121 | O_MAPONREAD) |
| 122 | |
| 123 | #ifdef _KERNEL |
| 124 | /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */ |
| 125 | #define FFLAGS(oflags) ((oflags) + 1) |
| 126 | #define OFLAGS(fflags) ((fflags) - 1) |
| 127 | |
| 128 | /* bits to save after open */ |
| 129 | #define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|\ |
| 130 | FAPPENDONLY|FREVOKED|O_DIRECT|O_MAPONREAD) |
| 131 | /* bits settable by fcntl(F_SETFL, ...) */ |
| 132 | #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|\ |
| 133 | O_DIRECT|O_MAPONREAD) |
| 134 | #endif |
| 135 | |
| 136 | /* |
| 137 | * The O_* flags used to have only F* names, which were used in the kernel |
| 138 | * and by fcntl. We retain the F* names for the kernel f_flag field |
| 139 | * and for backward compatibility for fcntl. |
| 140 | */ |
| 141 | #ifndef _POSIX_SOURCE |
| 142 | #define FAPPEND O_APPEND /* kernel/compat */ |
| 143 | #define FASYNC O_ASYNC /* kernel/compat */ |
| 144 | #define FFSYNC O_FSYNC /* kernel */ |
| 145 | #define FNONBLOCK O_NONBLOCK /* kernel */ |
| 146 | #define FNDELAY O_NONBLOCK /* compat */ |
| 147 | #define O_NDELAY O_NONBLOCK /* compat */ |
| 148 | #endif |
| 149 | |
| 150 | /* |
| 151 | * We are out of bits in f_flag (which is a short). However, |
| 152 | * the flag bits not set in FMASK are only meaningful in the |
| 153 | * initial open syscall. Those bits can thus be given a |
| 154 | * different meaning for fcntl(2). |
| 155 | */ |
| 156 | #ifndef _POSIX_SOURCE |
| 157 | |
| 158 | /* |
| 159 | * Set by shm_open(3) to get automatic MAP_ASYNC behavior |
| 160 | * for POSIX shared memory objects (which are otherwise |
| 161 | * implemented as plain files). |
| 162 | */ |
| 163 | #define FPOSIXSHM O_NOFOLLOW |
| 164 | #endif |
| 165 | |
| 166 | /* |
| 167 | * Constants used for fcntl(2) |
| 168 | */ |
| 169 | |
| 170 | /* command values */ |
| 171 | #define F_DUPFD 0 /* duplicate file descriptor */ |
| 172 | #define F_GETFD 1 /* get file descriptor flags */ |
| 173 | #define F_SETFD 2 /* set file descriptor flags */ |
| 174 | #define F_GETFL 3 /* get file status flags */ |
| 175 | #define F_SETFL 4 /* set file status flags */ |
| 176 | #ifndef _POSIX_SOURCE |
| 177 | #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */ |
| 178 | #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */ |
| 179 | #endif |
| 180 | #define F_GETLK 7 /* get record locking information */ |
| 181 | #define F_SETLK 8 /* set record locking information */ |
| 182 | #define F_SETLKW 9 /* F_SETLK; wait if blocked */ |
| 183 | |
| 184 | /* file descriptor flags (F_GETFD, F_SETFD) */ |
| 185 | #define FD_CLOEXEC 1 /* close-on-exec flag */ |
| 186 | |
| 187 | /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */ |
| 188 | #define F_RDLCK 1 /* shared or read lock */ |
| 189 | #define F_UNLCK 2 /* unlock */ |
| 190 | #define F_WRLCK 3 /* exclusive or write lock */ |
| 191 | #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) |
| 192 | #define F_WAIT 0x010 /* Wait until lock is granted */ |
| 193 | #define F_UNUSED020 0x020 |
| 194 | #define F_POSIX 0x040 /* Use POSIX semantics for lock */ |
| 195 | #define F_NOEND 0x080 /* l_len = 0, internally used */ |
| 196 | #endif |
| 197 | |
| 198 | /* |
| 199 | * Advisory file segment locking data type - |
| 200 | * information passed to system by user |
| 201 | */ |
| 202 | struct flock { |
| 203 | off_t l_start; /* starting offset */ |
| 204 | off_t l_len; /* len = 0 means until end of file */ |
| 205 | pid_t l_pid; /* lock owner */ |
| 206 | short l_type; /* lock type: read/write, etc. */ |
| 207 | short l_whence; /* type of l_start */ |
| 208 | }; |
| 209 | |
| 210 | #ifdef _KERNEL |
| 211 | union fcntl_dat { |
| 212 | int fc_fd; /* F_DUPFD */ |
| 213 | int fc_cloexec; /* F_GETFD/F_SETFD */ |
| 214 | int fc_flags; /* F_GETFL/F_SETFL */ |
| 215 | int fc_owner; /* F_GETOWN/F_SETOWN */ |
| 216 | struct flock fc_flock; /* F_GETLK/F_SETLK */ |
| 217 | }; |
| 218 | #endif /* _KERNEL */ |
| 219 | |
| 220 | |
| 221 | #ifndef _POSIX_SOURCE |
| 222 | /* lock operations for flock(2) */ |
| 223 | #define LOCK_SH 0x01 /* shared file lock */ |
| 224 | #define LOCK_EX 0x02 /* exclusive file lock */ |
| 225 | #define LOCK_NB 0x04 /* don't block when locking */ |
| 226 | #define LOCK_UN 0x08 /* unlock file */ |
| 227 | #endif |
| 228 | |
| 229 | #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL) |
| 230 | #include <sys/cdefs.h> |
| 231 | |
| 232 | __BEGIN_DECLS |
| 233 | int open (const char *, int, ...); |
| 234 | int creat (const char *, mode_t); |
| 235 | int fcntl (int, int, ...); |
| 236 | #ifndef _POSIX_SOURCE |
| 237 | int flock (int, int); |
| 238 | #endif /* !_POSIX_SOURCE */ |
| 239 | __END_DECLS |
| 240 | #endif |
| 241 | |
| 242 | #endif /* !_SYS_FCNTL_H_ */ |