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