1 /* $NetBSD: fcntl.h,v 1.22 2002/12/06 22:43:35 christos Exp $ */ 2 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. All advertising materials mentioning features or use of this software 21 * must display the following acknowledgement: 22 * This product includes software developed by the University of 23 * California, Berkeley and its contributors. 24 * 4. Neither the name of the University nor the names of its contributors 25 * may be used to endorse or promote products derived from this software 26 * without specific prior written permission. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 38 * SUCH DAMAGE. 39 * 40 * @(#)fcntl.h 8.3 (Berkeley) 1/21/94 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/featuretest.h> 54 #include <sys/types.h> 55 #if !defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) 56 #include <sys/stat.h> 57 #endif /* !_POSIX_C_SOURCE */ 58 #endif /* !_KERNEL */ 59 60 /* 61 * File status flags: these are used by open(2), fcntl(2). 62 * They are also used (indirectly) in the kernel file structure f_flags, 63 * which is a superset of the open/fcntl flags. Open flags and f_flags 64 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags). 65 * Open/fcntl flags begin with O_; kernel-internal flags begin with F. 66 */ 67 /* open-only flags */ 68 #define O_RDONLY 0x00000000 /* open for reading only */ 69 #define O_WRONLY 0x00000001 /* open for writing only */ 70 #define O_RDWR 0x00000002 /* open for reading and writing */ 71 #define O_ACCMODE 0x00000003 /* mask for above modes */ 72 73 /* 74 * Kernel encoding of open mode; separate read and write bits that are 75 * independently testable: 1 greater than the above. 76 * 77 * XXX 78 * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH, 79 * which was documented to use FREAD/FWRITE, continues to work. 80 */ 81 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) 82 #define FREAD 0x00000001 83 #define FWRITE 0x00000002 84 #endif 85 #define O_NONBLOCK 0x00000004 /* no delay */ 86 #define O_APPEND 0x00000008 /* set append mode */ 87 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) 88 #define O_SHLOCK 0x00000010 /* open with shared file lock */ 89 #define O_EXLOCK 0x00000020 /* open with exclusive file lock */ 90 #define O_ASYNC 0x00000040 /* signal pgrp when data ready */ 91 #endif 92 #if (!defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)) || \ 93 (_POSIX_C_SOURCE - 0) >= 199309L || \ 94 (defined(_XOPEN_SOURCE) && defined(_XOPEN_SOURCE_EXTENDED)) || \ 95 (_XOPEN_SOURCE - 0) >= 500 96 #define O_SYNC 0x00000080 /* synchronous writes */ 97 #endif 98 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) 99 #define O_NOFOLLOW 0x00000100 /* don't follow symlinks on the last */ 100 /* path component */ 101 #endif 102 #define O_CREAT 0x00000200 /* create if nonexistent */ 103 #define O_TRUNC 0x00000400 /* truncate to zero length */ 104 #define O_EXCL 0x00000800 /* error if already exists */ 105 106 #if (!defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)) || \ 107 (_POSIX_C_SOURCE - 0) >= 199309L || (_XOPEN_SOURCE - 0) >= 500 108 #define O_DSYNC 0x00010000 /* write: I/O data completion */ 109 #define O_RSYNC 0x00020000 /* read: I/O completion as for write */ 110 #endif 111 112 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) 113 #define O_ALT_IO 0x00040000 /* use alternate i/o semantics */ 114 #endif 115 116 /* defined by POSIX 1003.1; BSD default, but required to be bitwise distinct */ 117 #define O_NOCTTY 0x00008000 /* don't assign controlling terminal */ 118 119 #ifdef _KERNEL 120 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */ 121 #define FFLAGS(oflags) ((oflags) + 1) 122 #define OFLAGS(fflags) ((fflags) - 1) 123 124 /* all bits settable during open(2) */ 125 #define O_MASK (O_ACCMODE|O_NONBLOCK|O_APPEND|O_SHLOCK|O_EXLOCK|\ 126 O_ASYNC|O_SYNC|O_CREAT|O_TRUNC|O_EXCL|O_DSYNC|\ 127 O_RSYNC|O_NOCTTY|O_ALT_IO|O_NOFOLLOW) 128 129 #define FMARK 0x00001000 /* mark during gc() */ 130 #define FDEFER 0x00002000 /* defer for next gc pass */ 131 #define FHASLOCK 0x00004000 /* descriptor holds advisory lock */ 132 /* bits to save after open(2) */ 133 #define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FDSYNC|\ 134 FRSYNC|FALTIO) 135 /* bits settable by fcntl(F_SETFL, ...) */ 136 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FDSYNC|FRSYNC|FALTIO) 137 #endif /* _KERNEL */ 138 139 /* 140 * The O_* flags used to have only F* names, which were used in the kernel 141 * and by fcntl. We retain the F* names for the kernel f_flags field 142 * and for backward compatibility for fcntl. 143 */ 144 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) 145 #define FAPPEND O_APPEND /* kernel/compat */ 146 #define FASYNC O_ASYNC /* kernel/compat */ 147 #define O_FSYNC O_SYNC /* compat */ 148 #define FNDELAY O_NONBLOCK /* compat */ 149 #define O_NDELAY O_NONBLOCK /* compat */ 150 #endif 151 #if defined(_KERNEL) 152 #define FNONBLOCK O_NONBLOCK /* kernel */ 153 #define FFSYNC O_SYNC /* kernel */ 154 #define FDSYNC O_DSYNC /* kernel */ 155 #define FRSYNC O_RSYNC /* kernel */ 156 #define FALTIO O_ALT_IO /* kernel */ 157 #endif 158 159 /* 160 * Constants used for fcntl(2) 161 */ 162 163 /* command values */ 164 #define F_DUPFD 0 /* duplicate file descriptor */ 165 #define F_GETFD 1 /* get file descriptor flags */ 166 #define F_SETFD 2 /* set file descriptor flags */ 167 #define F_GETFL 3 /* get file status flags */ 168 #define F_SETFL 4 /* set file status flags */ 169 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) 170 #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */ 171 #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */ 172 #endif 173 #define F_GETLK 7 /* get record locking information */ 174 #define F_SETLK 8 /* set record locking information */ 175 #define F_SETLKW 9 /* F_SETLK; wait if blocked */ 176 177 /* file descriptor flags (F_GETFD, F_SETFD) */ 178 #define FD_CLOEXEC 1 /* close-on-exec flag */ 179 180 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */ 181 #define F_RDLCK 1 /* shared or read lock */ 182 #define F_UNLCK 2 /* unlock */ 183 #define F_WRLCK 3 /* exclusive or write lock */ 184 #ifdef _KERNEL 185 #define F_WAIT 0x010 /* Wait until lock is granted */ 186 #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */ 187 #define F_POSIX 0x040 /* Use POSIX semantics for lock */ 188 #endif 189 190 /* Constants for fcntl's passed to the underlying fs - like ioctl's. */ 191 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) 192 #define F_PARAM_MASK 0xfff 193 #define F_PARAM_LEN(x) (((x) >> 16) & F_PARAM_MASK) 194 #define F_PARAM_MAX 4095 195 #define F_FSCTL (int)0x80000000 /* This fcntl goes to the fs */ 196 #define F_FSVOID (int)0x40000000 /* no parameters */ 197 #define F_FSOUT (int)0x20000000 /* copy out parameter */ 198 #define F_FSIN (int)0x10000000 /* copy in parameter */ 199 #define F_FSINOUT (F_FSIN | F_FSOUT) 200 #define F_FSDIRMASK (int)0x70000000 /* mask for IN/OUT/VOID */ 201 #define F_FSPRIV (int)0x00008000 /* command is fs-specific */ 202 203 /* 204 * Define command macros for operations which, if implemented, must be 205 * the same for all fs's. 206 */ 207 #define _FCN(inout, num, len) \ 208 (F_FSCTL | inout | ((len & F_PARAM_MASK) << 16) | (num)) 209 #define _FCNO(c) _FCN(F_FSVOID, (c), 0) 210 #define _FCNR(c, t) _FCN(F_FSIN, (c), (int)sizeof(t)) 211 #define _FCNW(c, t) _FCN(F_FSOUT, (c), (int)sizeof(t)) 212 #define _FCNRW(c, t) _FCN(F_FSINOUT, (c), (int)sizeof(t)) 213 214 /* 215 * Define command macros for fs-specific commands. 216 */ 217 #define _FCN_FSPRIV(inout, num, len) \ 218 (F_FSCTL | F_FSPRIV | inout | ((len & F_PARAM_MASK) << 16) | (num)) 219 #define _FCNO_FSPRIV(c) _FCN_FSPRIV(F_FSVOID, (c), 0) 220 #define _FCNR_FSPRIV(c, t) _FCN_FSPRIV(F_FSIN, (c), (int)sizeof(t)) 221 #define _FCNW_FSPRIV(c, t) _FCN_FSPRIV(F_FSOUT, (c), (int)sizeof(t)) 222 #define _FCNRW_FSPRIV(c, t) _FCN_FSPRIV(F_FSINOUT, (c), (int)sizeof(t)) 223 224 #endif /* neither POSIX nor _XOPEN_SOURCE */ 225 226 /* 227 * Advisory file segment locking data type - 228 * information passed to system by user 229 */ 230 struct flock { 231 off_t l_start; /* starting offset */ 232 off_t l_len; /* len = 0 means until end of file */ 233 pid_t l_pid; /* lock owner */ 234 short l_type; /* lock type: read/write, etc. */ 235 short l_whence; /* type of l_start */ 236 }; 237 238 239 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) 240 /* lock operations for flock(2) */ 241 #define LOCK_SH 0x01 /* shared file lock */ 242 #define LOCK_EX 0x02 /* exclusive file lock */ 243 #define LOCK_NB 0x04 /* don't block when locking */ 244 #define LOCK_UN 0x08 /* unlock file */ 245 #endif 246 247 /* Always ensure that these are consistent with <stdio.h> and <unistd.h>! */ 248 #ifndef SEEK_SET 249 #define SEEK_SET 0 /* set file offset to offset */ 250 #endif 251 #ifndef SEEK_CUR 252 #define SEEK_CUR 1 /* set file offset to current plus offset */ 253 #endif 254 #ifndef SEEK_END 255 #define SEEK_END 2 /* set file offset to EOF plus offset */ 256 #endif 257 258 #ifndef _KERNEL 259 #include <sys/cdefs.h> 260 261 __BEGIN_DECLS 262 int open __P((const char *, int, ...)); 263 int creat __P((const char *, mode_t)); 264 int fcntl __P((int, int, ...)); 265 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) 266 int flock __P((int, int)); 267 #endif /* !_POSIX_C_SOURCE && !_XOPEN_SOURCE */ 268 __END_DECLS 269 #endif /* !_KERNEL */ 270 271 #endif /* !_SYS_FCNTL_H_ */ 272