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