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