1 /* $OpenBSD: fcntl.h,v 1.9 2003/06/02 23:28:21 millert Exp $ */ 2 /* $NetBSD: fcntl.h,v 1.8 1995/03/26 20:24:12 jtc Exp $ */ 3 4 /*- 5 * Copyright (c) 1983, 1990, 1993 6 * The Regents of the University of California. All rights reserved. 7 * (c) UNIX System Laboratories, Inc. 8 * All or some portions of this file are derived from material licensed 9 * to the University of California by American Telephone and Telegraph 10 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 11 * the permission of UNIX System Laboratories, Inc. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 3. Neither the name of the University nor the names of its contributors 22 * may be used to endorse or promote products derived from this software 23 * without specific prior written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35 * SUCH DAMAGE. 36 * 37 * @(#)fcntl.h 8.3 (Berkeley) 1/21/94 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 #ifndef _KERNEL 50 #include <sys/types.h> 51 #endif 52 53 /* 54 * File status flags: these are used by open(2), fcntl(2). 55 * They are also used (indirectly) in the kernel file structure f_flags, 56 * which is a superset of the open/fcntl flags. Open flags and f_flags 57 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags). 58 * Open/fcntl flags begin with O_; kernel-internal flags begin with F. 59 */ 60 /* open-only flags */ 61 #define O_RDONLY 0x0000 /* open for reading only */ 62 #define O_WRONLY 0x0001 /* open for writing only */ 63 #define O_RDWR 0x0002 /* open for reading and writing */ 64 #define O_ACCMODE 0x0003 /* mask for above modes */ 65 66 /* 67 * Kernel encoding of open mode; separate read and write bits that are 68 * independently testable: 1 greater than the above. 69 * 70 * XXX 71 * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH, 72 * which was documented to use FREAD/FWRITE, continues to work. 73 */ 74 #ifndef _POSIX_SOURCE 75 #define FREAD 0x0001 76 #define FWRITE 0x0002 77 #endif 78 #define O_NONBLOCK 0x0004 /* no delay */ 79 #define O_APPEND 0x0008 /* set append mode */ 80 #ifndef _POSIX_SOURCE 81 #define O_SHLOCK 0x0010 /* open with shared file lock */ 82 #define O_EXLOCK 0x0020 /* open with exclusive file lock */ 83 #define O_ASYNC 0x0040 /* signal pgrp when data ready */ 84 #define O_FSYNC O_SYNC /* backwards compatibility */ 85 #define O_NOFOLLOW 0x0100 /* if path is a symlink, don't follow */ 86 #endif 87 #define O_SYNC 0x0080 /* synchronous writes */ 88 #define O_CREAT 0x0200 /* create if nonexistant */ 89 #define O_TRUNC 0x0400 /* truncate to zero length */ 90 #define O_EXCL 0x0800 /* error if already exists */ 91 #ifdef _KERNEL 92 #define FMARK 0x1000 /* mark during gc() */ 93 #define FDEFER 0x2000 /* defer for next gc pass */ 94 #define FHASLOCK 0x4000 /* descriptor holds advisory lock */ 95 #endif 96 97 /* 98 * POSIX 1003.1 specifies a higher granularity for synchronous operations 99 * than we support. Since synchronicity is all or nothing in OpenBSD 100 * we just define these to be the same as O_SYNC. 101 */ 102 #define O_DSYNC O_SYNC /* synchronous data writes */ 103 #define O_RSYNC O_SYNC /* synchronous reads */ 104 105 /* defined by POSIX 1003.1; BSD default, this bit is not required */ 106 #define O_NOCTTY 0x8000 /* don't assign controlling terminal */ 107 108 #ifdef _KERNEL 109 /* 110 * convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE. 111 * For out-of-range values for the flags, be slightly careful (but lossy). 112 */ 113 #define FFLAGS(oflags) (((oflags) & ~O_ACCMODE) | (((oflags) + 1) & O_ACCMODE)) 114 #define OFLAGS(fflags) (((fflags) & ~O_ACCMODE) | (((fflags) - 1) & O_ACCMODE)) 115 116 /* bits to save after open */ 117 #define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK) 118 /* bits settable by fcntl(F_SETFL, ...) */ 119 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK) 120 #endif 121 122 /* 123 * The O_* flags used to have only F* names, which were used in the kernel 124 * and by fcntl. We retain the F* names for the kernel f_flags field 125 * and for backward compatibility for fcntl. 126 */ 127 #ifndef _POSIX_SOURCE 128 #define FAPPEND O_APPEND /* kernel/compat */ 129 #define FASYNC O_ASYNC /* kernel/compat */ 130 #define FFSYNC O_SYNC /* kernel */ 131 #define FNONBLOCK O_NONBLOCK /* kernel */ 132 #define FNDELAY O_NONBLOCK /* compat */ 133 #define O_NDELAY O_NONBLOCK /* compat */ 134 #endif 135 136 /* 137 * Constants used for fcntl(2) 138 */ 139 140 /* command values */ 141 #define F_DUPFD 0 /* duplicate file descriptor */ 142 #define F_GETFD 1 /* get file descriptor flags */ 143 #define F_SETFD 2 /* set file descriptor flags */ 144 #define F_GETFL 3 /* get file status flags */ 145 #define F_SETFL 4 /* set file status flags */ 146 #ifndef _POSIX_SOURCE 147 #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */ 148 #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */ 149 #endif 150 #define F_GETLK 7 /* get record locking information */ 151 #define F_SETLK 8 /* set record locking information */ 152 #define F_SETLKW 9 /* F_SETLK; wait if blocked */ 153 154 /* file descriptor flags (F_GETFD, F_SETFD) */ 155 #define FD_CLOEXEC 1 /* close-on-exec flag */ 156 157 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */ 158 #define F_RDLCK 1 /* shared or read lock */ 159 #define F_UNLCK 2 /* unlock */ 160 #define F_WRLCK 3 /* exclusive or write lock */ 161 #ifdef _KERNEL 162 #define F_WAIT 0x010 /* Wait until lock is granted */ 163 #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */ 164 #define F_POSIX 0x040 /* Use POSIX semantics for lock */ 165 #endif 166 167 /* 168 * Advisory file segment locking data type - 169 * information passed to system by user 170 */ 171 struct flock { 172 off_t l_start; /* starting offset */ 173 off_t l_len; /* len = 0 means until end of file */ 174 pid_t l_pid; /* lock owner */ 175 short l_type; /* lock type: read/write, etc. */ 176 short l_whence; /* type of l_start */ 177 }; 178 179 180 #ifndef _POSIX_SOURCE 181 /* lock operations for flock(2) */ 182 #define LOCK_SH 0x01 /* shared file lock */ 183 #define LOCK_EX 0x02 /* exclusive file lock */ 184 #define LOCK_NB 0x04 /* don't block when locking */ 185 #define LOCK_UN 0x08 /* unlock file */ 186 #endif 187 188 189 #ifndef _KERNEL 190 #include <sys/cdefs.h> 191 192 __BEGIN_DECLS 193 int open(const char *, int, ...); 194 int creat(const char *, mode_t); 195 int fcntl(int, int, ...); 196 #ifndef _POSIX_SOURCE 197 int flock(int, int); 198 #endif /* !_POSIX_SOURCE */ 199 __END_DECLS 200 #endif 201 202 #endif /* !_SYS_FCNTL_H_ */ 203