1 /* O_*, F_*, FD_* bit values for Linux.
2    Copyright (C) 1995, 1996, 1997, 1998, 2000, 2002, 2003, 2004, 2006
3 	Free Software Foundation, Inc.
4    This file is part of the GNU C Library.
5 
6    The GNU C Library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10 
11    The GNU C Library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15 
16    You should have received a copy of the GNU Lesser General Public
17    License along with the GNU C Library; if not, see
18    <http://www.gnu.org/licenses/>.  */
19 
20 #ifndef	_FCNTL_H
21 # error "Never use <bits/fcntl.h> directly; include <fcntl.h> instead."
22 #endif
23 
24 #include <sgidefs.h>
25 #include <sys/types.h>
26 #ifdef __USE_GNU
27 # include <bits/uio.h>
28 #endif
29 
30 
31 /* open/fcntl - O_SYNC is only implemented on blocks devices and on files
32    located on an ext2 file system */
33 #define O_ACCMODE	   0003
34 #define O_RDONLY	     00
35 #define O_WRONLY	     01
36 #define O_RDWR		     02
37 #define O_APPEND	 0x0008
38 #define O_SYNC		 0x0010
39 #define O_NONBLOCK	 0x0080
40 #define O_NDELAY	O_NONBLOCK
41 #define O_CREAT		 0x0100	/* not fcntl */
42 #define O_TRUNC		 0x0200	/* not fcntl */
43 #define O_EXCL		 0x0400	/* not fcntl */
44 #define O_NOCTTY	 0x0800	/* not fcntl */
45 #define O_FSYNC		 O_SYNC
46 #define O_ASYNC		 0x1000
47 
48 #ifdef __USE_XOPEN2K8
49 # define O_NOFOLLOW	0x20000	/* Do not follow links.	 */
50 # define O_DIRECTORY	0x10000	/* Must be a directory.	 */
51 # define O_CLOEXEC     02000000 /* set close_on_exec */
52 #endif
53 
54 #ifdef __USE_GNU
55 # define O_DIRECT	0x8000	/* Direct disk access hint.  */
56 # define O_NOATIME	0x40000	/* Do not set atime.  */
57 # define O_PATH       010000000 /* Resolve pathname but do not open file.  */
58 # define O_TMPFILE     0x410000 /* Atomically create nameless file.  */
59 #endif
60 
61 /* For now Linux has no synchronisity options for data and read operations.
62    We define the symbols here but let them do the same as O_SYNC since
63    this is a superset.	*/
64 #if defined __USE_POSIX199309 || defined __USE_UNIX98
65 # define O_DSYNC	O_SYNC	/* Synchronize data.  */
66 # define O_RSYNC	O_SYNC	/* Synchronize read operations.	 */
67 #endif
68 
69 #ifdef __USE_LARGEFILE64
70 # if __WORDSIZE == 64
71 #  define O_LARGEFILE	0
72 # else
73 #  define O_LARGEFILE	0x2000	/* Allow large file opens.  */
74 # endif
75 #endif
76 
77 /* Values for the second argument to `fcntl'.  */
78 #define F_DUPFD		0	/* Duplicate file descriptor.  */
79 #define F_GETFD		1	/* Get file descriptor flags.  */
80 #define F_SETFD		2	/* Set file descriptor flags.  */
81 #define F_GETFL		3	/* Get file status flags.  */
82 #define F_SETFL		4	/* Set file status flags.  */
83 #ifndef __USE_FILE_OFFSET64
84 # define F_GETLK	14	/* Get record locking info.  */
85 # define F_SETLK	6	/* Set record locking info (non-blocking).  */
86 # define F_SETLKW	7	/* Set record locking info (blocking).	*/
87 #else
88 # define F_GETLK	F_GETLK64  /* Get record locking info.	*/
89 # define F_SETLK	F_SETLK64  /* Set record locking info (non-blocking).*/
90 # define F_SETLKW	F_SETLKW64 /* Set record locking info (blocking).  */
91 #endif
92 
93 #if __WORDSIZE == 64
94 # define F_GETLK64	14	/* Get record locking info.  */
95 # define F_SETLK64	6	/* Set record locking info (non-blocking).  */
96 # define F_SETLKW64	7	/* Set record locking info (blocking).	*/
97 #else
98 # define F_GETLK64	33	/* Get record locking info.  */
99 # define F_SETLK64	34	/* Set record locking info (non-blocking).  */
100 # define F_SETLKW64	35	/* Set record locking info (blocking).	*/
101 #endif
102 
103 #if defined __USE_BSD || defined __USE_UNIX98
104 # define F_SETOWN	24	/* Get owner of socket (receiver of SIGIO).  */
105 # define F_GETOWN	23	/* Set owner of socket (receiver of SIGIO).  */
106 #endif
107 
108 #ifdef __USE_GNU
109 # define F_SETSIG	10	/* Set number of signal to be sent.  */
110 # define F_GETSIG	11	/* Get number of signal to be sent.  */
111 #endif
112 
113 #ifdef __USE_GNU
114 # define F_SETLEASE	1024	/* Set a lease.	 */
115 # define F_GETLEASE	1025	/* Enquire what lease is active.  */
116 # define F_NOTIFY	1026	/* Request notfications on a directory.	 */
117 # define F_SETPIPE_SZ	1031    /* Set pipe page size array.  */
118 # define F_GETPIPE_SZ	1032    /* Get pipe page size array.  */
119 #endif
120 #if defined __USE_XOPEN2K8 || defined __USE_GNU
121 # define F_DUPFD_CLOEXEC 1030	/* Duplicate file descriptor with
122 				   close-on-exit set on new fd.  */
123 #endif
124 
125 /* For F_[GET|SET]FL.  */
126 #define FD_CLOEXEC	1	/* actually anything with low bit set goes */
127 
128 /* For posix fcntl() and `l_type' field of a `struct flock' for lockf().  */
129 #define F_RDLCK		0	/* Read lock.  */
130 #define F_WRLCK		1	/* Write lock.	*/
131 #define F_UNLCK		2	/* Remove lock.	 */
132 
133 /* For old implementation of bsd flock().  */
134 #define F_EXLCK		4	/* or 3 */
135 #define F_SHLCK		8	/* or 4 */
136 
137 #ifdef __USE_BSD
138 /* Operations for bsd flock(), also used by the kernel implementation.	*/
139 # define LOCK_SH	1	/* shared lock */
140 # define LOCK_EX	2	/* exclusive lock */
141 # define LOCK_NB	4	/* or'd with one of the above to prevent
142 				   blocking */
143 # define LOCK_UN	8	/* remove lock */
144 #endif
145 
146 #ifdef __USE_GNU
147 # define LOCK_MAND	32	/* This is a mandatory flock:	*/
148 # define LOCK_READ	64	/* ... which allows concurrent read operations.	 */
149 # define LOCK_WRITE	128	/* ... which allows concurrent write operations.  */
150 # define LOCK_RW	192	/* ... Which allows concurrent read & write operations.	 */
151 #endif
152 
153 #ifdef __USE_GNU
154 /* Types of directory notifications that may be requested with F_NOTIFY.  */
155 # define DN_ACCESS	0x00000001	/* File accessed.  */
156 # define DN_MODIFY	0x00000002	/* File modified.  */
157 # define DN_CREATE	0x00000004	/* File created.  */
158 # define DN_DELETE	0x00000008	/* File removed.  */
159 # define DN_RENAME	0x00000010	/* File renamed.  */
160 # define DN_ATTRIB	0x00000020	/* File changed attibutes.  */
161 # define DN_MULTISHOT	0x80000000	/* Don't remove notifier.  */
162 #endif
163 
164 struct flock
165   {
166     short int l_type;	/* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.	*/
167     short int l_whence;	/* Where `l_start' is relative to (like `lseek').  */
168 #ifndef __USE_FILE_OFFSET64
169     __off_t l_start;	/* Offset where the lock begins.  */
170     __off_t l_len;	/* Size of the locked area; zero means until EOF.  */
171 #if _MIPS_SIM != _ABI64
172     /* The 64-bit flock structure, used by the n64 ABI, and for 64-bit
173        fcntls in o32 and n32, never has this field.  */
174     long int l_sysid;
175 #endif
176 #else
177     __off64_t l_start;	/* Offset where the lock begins.  */
178     __off64_t l_len;	/* Size of the locked area; zero means until EOF.  */
179 #endif
180     __pid_t l_pid;	/* Process holding the lock.  */
181 #if ! defined __USE_FILE_OFFSET64 && _MIPS_SIM != _ABI64
182     /* The 64-bit flock structure, used by the n64 ABI, and for 64-bit
183        flock in o32 and n32, never has this field.  */
184     long int pad[4];
185 #endif
186   };
187 typedef struct flock flock_t;
188 
189 #ifdef __USE_LARGEFILE64
190 struct flock64
191   {
192     short int l_type;	/* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.	*/
193     short int l_whence;	/* Where `l_start' is relative to (like `lseek').  */
194     __off64_t l_start;	/* Offset where the lock begins.  */
195     __off64_t l_len;	/* Size of the locked area; zero means until EOF.  */
196     __pid_t l_pid;	/* Process holding the lock.  */
197   };
198 #endif
199 
200 /* Define some more compatibility macros to be backward compatible with
201    BSD systems which did not managed to hide these kernel macros.  */
202 #ifdef	__USE_BSD
203 # define FAPPEND	O_APPEND
204 # define FFSYNC		O_FSYNC
205 # define FASYNC		O_ASYNC
206 # define FNONBLOCK	O_NONBLOCK
207 # define FNDELAY	O_NDELAY
208 #endif /* Use BSD.  */
209 
210 /* Advise to `posix_fadvise'.  */
211 #ifdef __USE_XOPEN2K
212 # define POSIX_FADV_NORMAL	0 /* No further special treatment.  */
213 # define POSIX_FADV_RANDOM	1 /* Expect random page references.  */
214 # define POSIX_FADV_SEQUENTIAL	2 /* Expect sequential page references.	 */
215 # define POSIX_FADV_WILLNEED	3 /* Will need these pages.  */
216 # define POSIX_FADV_DONTNEED	4 /* Don't need these pages.  */
217 # define POSIX_FADV_NOREUSE	5 /* Data will be accessed once.  */
218 #endif
219 
220 
221 #if defined __USE_GNU && defined __UCLIBC_LINUX_SPECIFIC__
222 /* Flags for SYNC_FILE_RANGE.  */
223 # define SYNC_FILE_RANGE_WAIT_BEFORE	1 /* Wait upon writeout of all pages
224 					     in the range before performing the
225 					     write.  */
226 # define SYNC_FILE_RANGE_WRITE		2 /* Initiate writeout of all those
227 					     dirty pages in the range which are
228 					     not presently under writeback.  */
229 # define SYNC_FILE_RANGE_WAIT_AFTER	4 /* Wait upon writeout of all pages in
230 					     the range after performing the
231 					     write.  */
232 
233 /* Flags for SPLICE and VMSPLICE.  */
234 # define SPLICE_F_MOVE		1	/* Move pages instead of copying.  */
235 # define SPLICE_F_NONBLOCK	2	/* Don't block on the pipe splicing
236 					   (but we may still block on the fd
237 					   we splice from/to).  */
238 # define SPLICE_F_MORE		4	/* Expect more data.  */
239 # define SPLICE_F_GIFT		8	/* Pages passed in are a gift.  */
240 #endif
241 
242 __BEGIN_DECLS
243 
244 #if defined __USE_GNU && defined __UCLIBC_LINUX_SPECIFIC__
245 
246 /* Provide kernel hint to read ahead.  */
247 extern ssize_t readahead (int __fd, __off64_t __offset, size_t __count)
248     __THROW;
249 
250 
251 /* Selective file content synch'ing.  */
252 extern int sync_file_range (int __fd, __off64_t __from, __off64_t __to,
253 			    unsigned int __flags);
254 
255 /* Splice address range into a pipe.  */
256 extern ssize_t vmsplice (int __fdout, const struct iovec *__iov,
257 			 size_t __count, unsigned int __flags);
258 
259 /* Splice two files together.  */
260 extern ssize_t splice (int __fdin, __off64_t *__offin, int __fdout,
261 		       __off64_t *__offout, size_t __len,
262 		       unsigned int __flags);
263 
264 /* In-kernel implementation of tee for pipe buffers.  */
265 extern ssize_t tee (int __fdin, int __fdout, size_t __len,
266 		    unsigned int __flags);
267 
268 #endif
269 __END_DECLS
270 
271 /* Include generic Linux declarations.  */
272 #include <bits/fcntl-linux.h>
273