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 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * @(#)fcntl.h 8.3 (Berkeley) 1/21/94
35 * $FreeBSD$
36 */
37
38 #ifndef _SYS_FCNTL_H_
39 #define _SYS_FCNTL_H_
40
41 /*
42 * This file includes the definitions for open and fcntl
43 * described by POSIX for <fcntl.h>; it also includes
44 * related kernel definitions.
45 */
46
47 #include <sys/cdefs.h>
48 #include <sys/_types.h>
49
50 #ifndef _MODE_T_DECLARED
51 typedef __mode_t mode_t;
52 #define _MODE_T_DECLARED
53 #endif
54
55 #ifndef _OFF_T_DECLARED
56 typedef __off_t off_t;
57 #define _OFF_T_DECLARED
58 #endif
59
60 #ifndef _PID_T_DECLARED
61 typedef __pid_t pid_t;
62 #define _PID_T_DECLARED
63 #endif
64
65 /*
66 * File status flags: these are used by open(2), fcntl(2).
67 * They are also used (indirectly) in the kernel file structure f_flags,
68 * which is a superset of the open/fcntl flags. Open flags and f_flags
69 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
70 * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
71 */
72 /* open-only flags */
73 #define O_RDONLY 0x0000 /* open for reading only */
74 #define O_WRONLY 0x0001 /* open for writing only */
75 #define O_RDWR 0x0002 /* open for reading and writing */
76 #define O_ACCMODE 0x0003 /* mask for above modes */
77
78 /*
79 * Kernel encoding of open mode; separate read and write bits that are
80 * independently testable: 1 greater than the above.
81 *
82 * XXX
83 * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH,
84 * which was documented to use FREAD/FWRITE, continues to work.
85 */
86 #if __BSD_VISIBLE
87 #define FREAD 0x0001
88 #define FWRITE 0x0002
89 #endif
90 #define O_NONBLOCK 0x0004 /* no delay */
91 #define O_APPEND 0x0008 /* set append mode */
92 #if __BSD_VISIBLE
93 #define O_SHLOCK 0x0010 /* open with shared file lock */
94 #define O_EXLOCK 0x0020 /* open with exclusive file lock */
95 #define O_ASYNC 0x0040 /* signal pgrp when data ready */
96 #define O_FSYNC 0x0080 /* synchronous writes */
97 #endif
98 #define O_SYNC 0x0080 /* POSIX synonym for O_FSYNC */
99 #if __BSD_VISIBLE
100 #define O_NOFOLLOW 0x0100 /* don't follow symlinks */
101 #endif
102 #define O_CREAT 0x0200 /* create if nonexistent */
103 #define O_TRUNC 0x0400 /* truncate to zero length */
104 #define O_EXCL 0x0800 /* error if already exists */
105 #ifdef _KERNEL
106 #define FHASLOCK 0x4000 /* descriptor holds advisory lock */
107 #endif
108 /*
109 * Magic value that specify the use of the current working directory
110 * to determine the target of relative file paths in the openat() and
111 * similar syscalls.
112 */
113 #define AT_FDCWD_notyet -100
114
115 /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */
116 #define O_NOCTTY 0x8000 /* don't assign controlling terminal */
117
118 #if __BSD_VISIBLE
119 /* Attempt to bypass buffer cache */
120 #define O_DIRECT 0x00010000
121 #endif
122
123 /*
124 * XXX missing O_DSYNC, O_RSYNC.
125 */
126
127 #ifdef _KERNEL
128 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
129 #define FFLAGS(oflags) ((oflags) + 1)
130 #define OFLAGS(fflags) ((fflags) - 1)
131
132 /* bits to save after open */
133 #define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|O_DIRECT)
134 /* bits settable by fcntl(F_SETFL, ...) */
135 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|O_DIRECT)
136 #endif
137
138 /*
139 * The O_* flags used to have only F* names, which were used in the kernel
140 * and by fcntl. We retain the F* names for the kernel f_flag field
141 * and for backward compatibility for fcntl. These flags are deprecated.
142 */
143 #if __BSD_VISIBLE
144 #define FAPPEND O_APPEND /* kernel/compat */
145 #define FASYNC O_ASYNC /* kernel/compat */
146 #define FFSYNC O_FSYNC /* kernel */
147 #define FNONBLOCK O_NONBLOCK /* kernel */
148 #define FNDELAY O_NONBLOCK /* compat */
149 #define O_NDELAY O_NONBLOCK /* compat */
150 #endif
151
152 /*
153 * We are out of bits in f_flag (which is a short). However,
154 * the flag bits not set in FMASK are only meaningful in the
155 * initial open syscall. Those bits can thus be given a
156 * different meaning for fcntl(2).
157 */
158 #if __BSD_VISIBLE
159
160 /*
161 * Set by shm_open(3) to get automatic MAP_ASYNC behavior
162 * for POSIX shared memory objects (which are otherwise
163 * implemented as plain files).
164 */
165 #define FPOSIXSHM O_NOFOLLOW
166 #endif
167
168 /*
169 * Constants used for fcntl(2)
170 */
171
172 /* command values */
173 #define F_DUPFD 0 /* duplicate file descriptor */
174 #define F_GETFD 1 /* get file descriptor flags */
175 #define F_SETFD 2 /* set file descriptor flags */
176 #define F_GETFL 3 /* get file status flags */
177 #define F_SETFL 4 /* set file status flags */
178 #if __BSD_VISIBLE || __XSI_VISIBLE || __POSIX_VISIBLE >= 200112
179 #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */
180 #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */
181 #endif
182 #define F_OGETLK 7 /* get record locking information */
183 #define F_OSETLK 8 /* set record locking information */
184 #define F_OSETLKW 9 /* F_SETLK; wait if blocked */
185 #define F_DUP2FD 10 /* duplicate file descriptor to arg */
186 #define F_GETLK 11 /* get record locking information */
187 #define F_SETLK 12 /* set record locking information */
188 #define F_SETLKW 13 /* F_SETLK; wait if blocked */
189 #define F_SETLK_REMOTE 14 /* debugging support for remote locks */
190
191 /* file descriptor flags (F_GETFD, F_SETFD) */
192 #define FD_CLOEXEC 1 /* close-on-exec flag */
193
194 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
195 #define F_RDLCK 1 /* shared or read lock */
196 #define F_UNLCK 2 /* unlock */
197 #define F_WRLCK 3 /* exclusive or write lock */
198 #define F_UNLCKSYS 4 /* purge locks for a given system ID */
199 #define F_CANCEL 5 /* cancel an async lock request */
200 #ifdef _KERNEL
201 #define F_WAIT 0x010 /* Wait until lock is granted */
202 #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */
203 #define F_POSIX 0x040 /* Use POSIX semantics for lock */
204 #define F_REMOTE 0x080 /* Lock owner is remote NFS client */
205 #define F_NOINTR 0x100 /* Ignore signals when waiting */
206 #endif
207
208 /*
209 * Advisory file segment locking data type -
210 * information passed to system by user
211 */
212 struct flock {
213 off_t l_start; /* starting offset */
214 off_t l_len; /* len = 0 means until end of file */
215 pid_t l_pid; /* lock owner */
216 short l_type; /* lock type: read/write, etc. */
217 short l_whence; /* type of l_start */
218 int l_sysid; /* remote system id or zero for local */
219 };
220
221 /*
222 * Old advisory file segment locking data type,
223 * before adding l_sysid.
224 */
225 struct oflock {
226 off_t l_start; /* starting offset */
227 off_t l_len; /* len = 0 means until end of file */
228 pid_t l_pid; /* lock owner */
229 short l_type; /* lock type: read/write, etc. */
230 short l_whence; /* type of l_start */
231 };
232
233
234 #if __BSD_VISIBLE
235 /* lock operations for flock(2) */
236 #define LOCK_SH 0x01 /* shared file lock */
237 #define LOCK_EX 0x02 /* exclusive file lock */
238 #define LOCK_NB 0x04 /* don't block when locking */
239 #define LOCK_UN 0x08 /* unlock file */
240 #endif
241
242 /*
243 * XXX missing posix_fadvise() and posix_fallocate(), and POSIX_FADV_* macros.
244 */
245
246 #ifndef _KERNEL
247 __BEGIN_DECLS
248 int open(const char *, int, ...);
249 int creat(const char *, mode_t);
250 int fcntl(int, int, ...);
251 #if __BSD_VISIBLE
252 int flock(int, int);
253 #endif
254 __END_DECLS
255 #endif
256
257 #endif /* !_SYS_FCNTL_H_ */
Cache object: be9d69520966b3592890cd56b5a12804
|