1 fcntl.h |
1 /*- |
|
2 * © Portions copyright (c) 2005 Nokia Corporation. All rights reserved. |
|
3 * © Portions copyright (c) 2006-2007 Symbian Software Ltd. All rights reserved. |
|
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 * 4. Neither the name of the University nor the names of its contributors |
|
21 * may be used to endorse or promote products derived from this software |
|
22 * without specific prior written permission. |
|
23 * |
|
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND |
|
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE |
|
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
|
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
|
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
|
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
|
34 * SUCH DAMAGE. |
|
35 * |
|
36 * @(#)fcntl.h 8.3 (Berkeley) 1/21/94 |
|
37 * $FreeBSD: src/sys/sys/fcntl.h,v 1.16 2004/04/07 04:19:49 imp Exp $ |
|
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 #include <sys/cdefs.h> |
|
50 #include <sys/_types.h> |
|
51 |
|
52 #ifndef _MODE_T_DECLARED |
|
53 typedef __mode_t mode_t; |
|
54 #define _MODE_T_DECLARED |
|
55 #endif |
|
56 |
|
57 #ifndef _OFF_T_DECLARED |
|
58 typedef __off_t off_t; |
|
59 #define _OFF_T_DECLARED |
|
60 #endif |
|
61 |
|
62 #ifndef _PID_T_DECLARED |
|
63 typedef __pid_t pid_t; |
|
64 #define _PID_T_DECLARED |
|
65 #endif |
|
66 |
|
67 /* |
|
68 * File status flags: these are used by open(2), fcntl(2). |
|
69 * They are also used (indirectly) in the kernel file structure f_flags, |
|
70 * which is a superset of the open/fcntl flags. Open flags and f_flags |
|
71 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags). |
|
72 * Open/fcntl flags begin with O_; kernel-internal flags begin with F. |
|
73 */ |
|
74 /* open-only flags */ |
|
75 #define O_RDONLY 0x0000 /* open for reading only */ |
|
76 #define O_WRONLY 0x0001 /* open for writing only */ |
|
77 #define O_RDWR 0x0002 /* open for reading and writing */ |
|
78 #define O_ACCMODE 0x0003 /* mask for above modes */ |
|
79 |
|
80 /* |
|
81 * Kernel encoding of open mode; separate read and write bits that are |
|
82 * independently testable: 1 greater than the above. |
|
83 * |
|
84 * XXX |
|
85 * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH, |
|
86 * which was documented to use FREAD/FWRITE, continues to work. |
|
87 */ |
|
88 #if __BSD_VISIBLE |
|
89 #define FREAD 0x0001 |
|
90 #define FWRITE 0x0002 |
|
91 #endif |
|
92 #define O_NONBLOCK 0x0004 /* no delay */ |
|
93 #define O_APPEND 0x0008 /* set append mode */ |
|
94 #if __BSD_VISIBLE |
|
95 #define O_SHLOCK 0x0010 /* open with shared file lock */ |
|
96 #define O_EXLOCK 0x0020 /* open with exclusive file lock */ |
|
97 #define O_ASYNC 0x0040 /* signal pgrp when data ready */ |
|
98 #define O_FSYNC 0x0080 /* synchronous writes */ |
|
99 #endif |
|
100 #define O_SYNC 0x0080 /* POSIX synonym for O_FSYNC */ |
|
101 #if __BSD_VISIBLE |
|
102 #define O_NOFOLLOW 0x0100 /* don't follow symlinks */ |
|
103 #endif |
|
104 #define O_CREAT 0x0200 /* create if nonexistent */ |
|
105 #define O_TRUNC 0x0400 /* truncate to zero length */ |
|
106 #define O_EXCL 0x0800 /* error if already exists */ |
|
107 #ifdef _KERNEL |
|
108 #define FHASLOCK 0x4000 /* descriptor holds advisory lock */ |
|
109 #endif |
|
110 |
|
111 /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */ |
|
112 #define O_NOCTTY 0x8000 /* don't assign controlling terminal */ |
|
113 |
|
114 #if __BSD_VISIBLE |
|
115 /* Attempt to bypass buffer cache */ |
|
116 #define O_DIRECT 0x00010000 |
|
117 #endif |
|
118 |
|
119 //Copied from MRT1.0 fcntl.h header |
|
120 #define _FBUFFERED 0x10000 /* buffer at the interface to the file system */ |
|
121 #define _FBINARY 0x10000 |
|
122 #define _FTEXT 0x20000 |
|
123 #define O_BINARY _FBINARY |
|
124 #define O_TEXT _FTEXT |
|
125 #define O_BUFFERED _FBUFFERED |
|
126 |
|
127 /* |
|
128 * XXX missing O_DSYNC, O_RSYNC. |
|
129 */ |
|
130 |
|
131 #ifdef _KERNEL |
|
132 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */ |
|
133 #define FFLAGS(oflags) ((oflags) + 1) |
|
134 #define OFLAGS(fflags) ((fflags) - 1) |
|
135 |
|
136 /* bits to save after open */ |
|
137 #define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|O_DIRECT) |
|
138 /* bits settable by fcntl(F_SETFL, ...) */ |
|
139 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|O_DIRECT) |
|
140 #endif |
|
141 |
|
142 /* |
|
143 * The O_* flags used to have only F* names, which were used in the kernel |
|
144 * and by fcntl. We retain the F* names for the kernel f_flag field |
|
145 * and for backward compatibility for fcntl. These flags are deprecated. |
|
146 */ |
|
147 #if __BSD_VISIBLE |
|
148 #define FAPPEND O_APPEND /* kernel/compat */ |
|
149 #define FASYNC O_ASYNC /* kernel/compat */ |
|
150 #define FFSYNC O_FSYNC /* kernel */ |
|
151 #define FNONBLOCK O_NONBLOCK /* kernel */ |
|
152 #define FNDELAY O_NONBLOCK /* compat */ |
|
153 #define O_NDELAY O_NONBLOCK /* compat */ |
|
154 #endif |
|
155 |
|
156 /* |
|
157 * We are out of bits in f_flag (which is a short). However, |
|
158 * the flag bits not set in FMASK are only meaningful in the |
|
159 * initial open syscall. Those bits can thus be given a |
|
160 * different meaning for fcntl(2). |
|
161 */ |
|
162 #if __BSD_VISIBLE |
|
163 |
|
164 /* |
|
165 * Set by shm_open(3) to get automatic MAP_ASYNC behavior |
|
166 * for POSIX shared memory objects (which are otherwise |
|
167 * implemented as plain files). |
|
168 */ |
|
169 #define FPOSIXSHM O_NOFOLLOW |
|
170 #endif |
|
171 |
|
172 /*SYMBIAN Flag for tmpfile removal*/ |
|
173 #ifdef __SYMBIAN32__ |
|
174 #define O_TMPFILE 0x10000000 /* flag for cleanup of tmpfiles*/ |
|
175 #endif //__SYMBIAN32__ |
|
176 |
|
177 /* |
|
178 * Constants used for fcntl(2) |
|
179 */ |
|
180 |
|
181 /* command values */ |
|
182 #define F_DUPFD 0 /* duplicate file descriptor */ |
|
183 #define F_GETFD 1 /* get file descriptor flags */ |
|
184 #define F_SETFD 2 /* set file descriptor flags */ |
|
185 #define F_GETFL 3 /* get file status flags */ |
|
186 #define F_SETFL 4 /* set file status flags */ |
|
187 #if __BSD_VISIBLE || __XSI_VISIBLE || __POSIX_VISIBLE >= 200112 |
|
188 #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */ |
|
189 #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */ |
|
190 #endif |
|
191 #define F_GETLK 7 /* get record locking information */ |
|
192 #define F_SETLK 8 /* set record locking information */ |
|
193 #define F_SETLKW 9 /* F_SETLK; wait if blocked */ |
|
194 |
|
195 /* file descriptor flags (F_GETFD, F_SETFD) */ |
|
196 #define FD_CLOEXEC 1 /* close-on-exec flag */ |
|
197 |
|
198 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */ |
|
199 #define F_RDLCK 1 /* shared or read lock */ |
|
200 #define F_UNLCK 2 /* unlock */ |
|
201 #define F_WRLCK 3 /* exclusive or write lock */ |
|
202 #ifdef _KERNEL |
|
203 #define F_WAIT 0x010 /* Wait until lock is granted */ |
|
204 #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */ |
|
205 #define F_POSIX 0x040 /* Use POSIX semantics for lock */ |
|
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 }; |
|
219 |
|
220 |
|
221 #if __BSD_VISIBLE |
|
222 /* lock operations for flock(2) */ |
|
223 #define LOCK_SH 0x01 /* shared file lock */ |
|
224 #define LOCK_EX 0x02 /* exclusive file lock */ |
|
225 #define LOCK_NB 0x04 /* don't block when locking */ |
|
226 #define LOCK_UN 0x08 /* unlock file */ |
|
227 #endif |
|
228 |
|
229 /* |
|
230 * XXX missing posix_fadvise() and posix_fallocate(), and POSIX_FADV_* macros. |
|
231 */ |
|
232 |
|
233 #ifndef _KERNEL |
|
234 __BEGIN_DECLS |
|
235 IMPORT_C int open(const char *, int, ...); |
|
236 IMPORT_C int creat(const char *, mode_t); |
|
237 IMPORT_C int fcntl(int, int, ...); |
|
238 #if __BSD_VISIBLE |
|
239 int flock(int, int); |
|
240 #endif |
|
241 __END_DECLS |
|
242 #endif |
|
243 |
|
244 #endif /* !_SYS_FCNTL_H_ */ |