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.6 2004/05/03 16:06:26 joerg Exp $ 41 */ 42 43 #ifndef _SYS_FCNTL_H_ 44 #define _SYS_FCNTL_H_ 45 46 /* 47 * This file includes the definitions for open and fcntl 48 * described by POSIX for <fcntl.h>; it also includes 49 * related kernel definitions. 50 */ 51 52 #ifndef _KERNEL 53 #include <sys/types.h> 54 #endif 55 56 /* 57 * File status flags: these are used by open(2), fcntl(2). 58 * They are also used (indirectly) in the kernel file structure f_flags, 59 * which is a superset of the open/fcntl flags. Open flags and f_flags 60 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags). 61 * Open/fcntl flags begin with O_; kernel-internal flags begin with F. 62 */ 63 /* open-only flags */ 64 #define O_RDONLY 0x0000 /* open for reading only */ 65 #define O_WRONLY 0x0001 /* open for writing only */ 66 #define O_RDWR 0x0002 /* open for reading and writing */ 67 #define O_ACCMODE 0x0003 /* mask for above modes */ 68 69 /* 70 * Kernel encoding of open mode; separate read and write bits that are 71 * independently testable: 1 greater than the above. 72 * 73 * XXX 74 * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH, 75 * which was documented to use FREAD/FWRITE, continues to work. 76 */ 77 #ifndef _POSIX_SOURCE 78 #define FREAD 0x0001 79 #define FWRITE 0x0002 80 #endif 81 #define O_NONBLOCK 0x0004 /* no delay */ 82 #define O_APPEND 0x0008 /* set append mode */ 83 #ifndef _POSIX_SOURCE 84 #define O_SHLOCK 0x0010 /* open with shared file lock */ 85 #define O_EXLOCK 0x0020 /* open with exclusive file lock */ 86 #define O_ASYNC 0x0040 /* signal pgrp when data ready */ 87 #define O_FSYNC 0x0080 /* synchronous writes */ 88 #define O_NOFOLLOW 0x0100 /* don't follow symlinks */ 89 #endif 90 #define O_CREAT 0x0200 /* create if nonexistent */ 91 #define O_TRUNC 0x0400 /* truncate to zero length */ 92 #define O_EXCL 0x0800 /* error if already exists */ 93 #ifdef _KERNEL 94 #define FMARK 0x1000 /* mark during gc() */ 95 #define FDEFER 0x2000 /* defer for next gc pass */ 96 #define FHASLOCK 0x4000 /* descriptor holds advisory lock */ 97 #endif 98 99 /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */ 100 #define O_NOCTTY 0x8000 /* don't assign controlling terminal */ 101 102 /* Attempt to bypass buffer cache */ 103 #define O_DIRECT 0x00010000 104 105 #ifdef _KERNEL 106 #define O_ROOTCRED 0x00020000 /* fp_open */ 107 #endif 108 109 #ifdef _KERNEL 110 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */ 111 #define FFLAGS(oflags) ((oflags) + 1) 112 #define OFLAGS(fflags) ((fflags) - 1) 113 114 /* bits to save after open */ 115 #define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|O_DIRECT) 116 /* bits settable by fcntl(F_SETFL, ...) */ 117 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|O_DIRECT) 118 #endif 119 120 /* 121 * The O_* flags used to have only F* names, which were used in the kernel 122 * and by fcntl. We retain the F* names for the kernel f_flag field 123 * and for backward compatibility for fcntl. 124 */ 125 #ifndef _POSIX_SOURCE 126 #define FAPPEND O_APPEND /* kernel/compat */ 127 #define FASYNC O_ASYNC /* kernel/compat */ 128 #define FFSYNC O_FSYNC /* kernel */ 129 #define FNONBLOCK O_NONBLOCK /* kernel */ 130 #define FNDELAY O_NONBLOCK /* compat */ 131 #define O_NDELAY O_NONBLOCK /* compat */ 132 #endif 133 134 /* 135 * We are out of bits in f_flag (which is a short). However, 136 * the flag bits not set in FMASK are only meaningful in the 137 * initial open syscall. Those bits can thus be given a 138 * different meaning for fcntl(2). 139 */ 140 #ifndef _POSIX_SOURCE 141 142 /* 143 * Set by shm_open(3) to get automatic MAP_ASYNC behavior 144 * for POSIX shared memory objects (which are otherwise 145 * implemented as plain files). 146 */ 147 #define FPOSIXSHM O_NOFOLLOW 148 #endif 149 150 /* 151 * Constants used for fcntl(2) 152 */ 153 154 /* command values */ 155 #define F_DUPFD 0 /* duplicate file descriptor */ 156 #define F_GETFD 1 /* get file descriptor flags */ 157 #define F_SETFD 2 /* set file descriptor flags */ 158 #define F_GETFL 3 /* get file status flags */ 159 #define F_SETFL 4 /* set file status flags */ 160 #ifndef _POSIX_SOURCE 161 #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */ 162 #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */ 163 #endif 164 #define F_GETLK 7 /* get record locking information */ 165 #define F_SETLK 8 /* set record locking information */ 166 #define F_SETLKW 9 /* F_SETLK; wait if blocked */ 167 168 /* file descriptor flags (F_GETFD, F_SETFD) */ 169 #define FD_CLOEXEC 1 /* close-on-exec flag */ 170 171 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */ 172 #define F_RDLCK 1 /* shared or read lock */ 173 #define F_UNLCK 2 /* unlock */ 174 #define F_WRLCK 3 /* exclusive or write lock */ 175 #ifdef _KERNEL 176 #define F_WAIT 0x010 /* Wait until lock is granted */ 177 #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */ 178 #define F_POSIX 0x040 /* Use POSIX semantics for lock */ 179 #define F_NOEND 0x080 /* l_len = 0, internally used */ 180 #endif 181 182 /* 183 * Advisory file segment locking data type - 184 * information passed to system by user 185 */ 186 struct flock { 187 off_t l_start; /* starting offset */ 188 off_t l_len; /* len = 0 means until end of file */ 189 pid_t l_pid; /* lock owner */ 190 short l_type; /* lock type: read/write, etc. */ 191 short l_whence; /* type of l_start */ 192 }; 193 194 #ifdef _KERNEL 195 union fcntl_dat { 196 int fc_fd; /* F_DUPFD */ 197 int fc_cloexec; /* F_GETFD/F_SETFD */ 198 int fc_flags; /* F_GETFL/F_SETFL */ 199 int fc_owner; /* F_GETOWN/F_SETOWN */ 200 struct flock fc_flock; /* F_GETLK/F_SETLK */ 201 }; 202 #endif /* _KERNEL */ 203 204 205 #ifndef _POSIX_SOURCE 206 /* lock operations for flock(2) */ 207 #define LOCK_SH 0x01 /* shared file lock */ 208 #define LOCK_EX 0x02 /* exclusive file lock */ 209 #define LOCK_NB 0x04 /* don't block when locking */ 210 #define LOCK_UN 0x08 /* unlock file */ 211 #endif 212 213 214 #ifndef _KERNEL 215 #include <sys/cdefs.h> 216 217 __BEGIN_DECLS 218 int open (const char *, int, ...); 219 int creat (const char *, mode_t); 220 int fcntl (int, int, ...); 221 #ifndef _POSIX_SOURCE 222 int flock (int, int); 223 #endif /* !_POSIX_SOURCE */ 224 __END_DECLS 225 #endif 226 227 #endif /* !_SYS_FCNTL_H_ */ 228