1 /* O_*, F_*, FD_* bit values for Linux.
2    Copyright (C) 1995-1998, 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; see the file COPYING.LIB.  If
17    not, see <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	/* Do not follow links.	 */
49 # define O_CLOEXEC     02000000 /* Set close_on_exec.  */
50 #endif
51 
52 #ifdef __USE_GNU
53 # define O_DIRECT	 040000	/* Direct disk access.	*/
54 # define O_NOATIME     01000000 /* Do not set atime.  */
55 # define O_PATH       010000000 /* Resolve pathname but do not open file.  */
56 # define O_TMPFILE    020200000 /* Atomically create nameless file.  */
57 #endif
58 
59 #ifdef __USE_LARGEFILE64
60 # define O_LARGEFILE	0100000
61 #endif
62 
63 /* For now Linux has synchronisity options for data and read operations.
64    We define the symbols here but let them do the same as O_SYNC since
65    this is a superset.	*/
66 #if defined __USE_POSIX199309 || defined __USE_UNIX98
67 # define O_DSYNC	O_SYNC	/* Synchronize data.  */
68 # define O_RSYNC	O_SYNC	/* Synchronize read operations.	 */
69 #endif
70 
71 /* Values for the second argument to `fcntl'.  */
72 #define F_DUPFD		0	/* Duplicate file descriptor.  */
73 #define F_GETFD		1	/* Get file descriptor flags.  */
74 #define F_SETFD		2	/* Set file descriptor flags.  */
75 #define F_GETFL		3	/* Get file status flags.  */
76 #define F_SETFL		4	/* Set file status flags.  */
77 
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 
88 #define F_GETLK64	12	/* Get record locking info.  */
89 #define F_SETLK64	13	/* Set record locking info (non-blocking).  */
90 #define F_SETLKW64	14	/* Set record locking info (blocking).	*/
91 
92 #if defined __USE_BSD || defined __USE_XOPEN2K
93 # define F_SETOWN	8	/* Get owner of socket (receiver of SIGIO).  */
94 # define F_GETOWN	9	/* Set owner of socket (receiver of SIGIO).  */
95 #endif
96 
97 #ifdef __USE_GNU
98 # define F_SETSIG	10	/* Set number of signal to be sent.  */
99 # define F_GETSIG	11	/* Get number of signal to be sent.  */
100 #endif
101 
102 #ifdef __USE_GNU
103 # define F_SETLEASE	1024	/* Set a lease.	 */
104 # define F_GETLEASE	1025	/* Enquire what lease is active.  */
105 # define F_NOTIFY	1026	/* Request notfications on a directory.	 */
106 # define F_SETPIPE_SZ	1031    /* Set pipe page size array.  */
107 # define F_GETPIPE_SZ	1032    /* Get pipe page size array.  */
108 #endif
109 #if defined __USE_XOPEN2K8 || defined __USE_GNU
110 # define F_DUPFD_CLOEXEC 1030	/* Duplicate file descriptor with
111 				   close-on-exit set on new fd.  */
112 #endif
113 
114 /* For F_[GET|SET]FL.  */
115 #define FD_CLOEXEC	1	/* actually anything with low bit set goes */
116 
117 /* For posix fcntl() and `l_type' field of a `struct flock' for lockf().  */
118 #define F_RDLCK		0	/* Read lock.  */
119 #define F_WRLCK		1	/* Write lock.	*/
120 #define F_UNLCK		2	/* Remove lock.	 */
121 
122 /* for old implementation of bsd flock () */
123 #define F_EXLCK		4	/* or 3 */
124 #define F_SHLCK		8	/* or 4 */
125 
126 #ifdef __USE_BSD
127 /* Operations for bsd flock(), also used by the kernel implementation */
128 # define LOCK_SH	1	/* shared lock */
129 # define LOCK_EX	2	/* exclusive lock */
130 # define LOCK_NB	4	/* or'd with one of the above to prevent
131 				   blocking */
132 # define LOCK_UN	8	/* remove lock */
133 #endif
134 
135 #ifdef __USE_GNU
136 # define LOCK_MAND	32	/* This is a mandatory flock:	*/
137 # define LOCK_READ	64	/* ... which allows concurrent read operations.	 */
138 # define LOCK_WRITE	128	/* ... which allows concurrent write operations.  */
139 # define LOCK_RW	192	/* ... Which allows concurrent read & write operations.	 */
140 #endif
141 
142 #ifdef __USE_GNU
143 /* Types of directory notifications that may be requested with F_NOTIFY.  */
144 # define DN_ACCESS	0x00000001	/* File accessed.  */
145 # define DN_MODIFY	0x00000002	/* File modified.  */
146 # define DN_CREATE	0x00000004	/* File created.  */
147 # define DN_DELETE	0x00000008	/* File removed.  */
148 # define DN_RENAME	0x00000010	/* File renamed.  */
149 # define DN_ATTRIB	0x00000020	/* File changed attibutes.  */
150 # define DN_MULTISHOT	0x80000000	/* Don't remove notifier.  */
151 #endif
152 
153 struct flock
154   {
155     short int l_type;	/* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.	*/
156     short int l_whence;	/* Where `l_start' is relative to (like `lseek').  */
157 #ifndef __USE_FILE_OFFSET64
158     __off_t l_start;	/* Offset where the lock begins.  */
159     __off_t l_len;	/* Size of the locked area; zero means until EOF.  */
160 #else
161     __off64_t l_start;	/* Offset where the lock begins.  */
162     __off64_t l_len;	/* Size of the locked area; zero means until EOF.  */
163 #endif
164     __pid_t l_pid;	/* Process holding the lock.  */
165   };
166 
167 #ifdef __USE_LARGEFILE64
168 struct flock64
169   {
170     short int l_type;	/* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.	*/
171     short int l_whence;	/* Where `l_start' is relative to (like `lseek').  */
172     __off64_t l_start;	/* Offset where the lock begins.  */
173     __off64_t l_len;	/* Size of the locked area; zero means until EOF.  */
174     __pid_t l_pid;	/* Process holding the lock.  */
175   };
176 #endif
177 
178 /* Define some more compatibility macros to be backward compatible with
179    BSD systems which did not managed to hide these kernel macros.  */
180 #ifdef	__USE_BSD
181 # define FAPPEND	O_APPEND
182 # define FFSYNC		O_FSYNC
183 # define FASYNC		O_ASYNC
184 # define FNONBLOCK	O_NONBLOCK
185 # define FNDELAY	O_NDELAY
186 #endif /* Use BSD.  */
187 
188 /* Advise to `posix_fadvise'.  */
189 #ifdef __USE_XOPEN2K
190 # define POSIX_FADV_NORMAL	0 /* No further special treatment.  */
191 # define POSIX_FADV_RANDOM	1 /* Expect random page references.  */
192 # define POSIX_FADV_SEQUENTIAL	2 /* Expect sequential page references.	 */
193 # define POSIX_FADV_WILLNEED	3 /* Will need these pages.  */
194 # define POSIX_FADV_DONTNEED	4 /* Don't need these pages.  */
195 # define POSIX_FADV_NOREUSE	5 /* Data will be accessed once.  */
196 #endif
197 
198 #if defined __USE_GNU && defined __UCLIBC_LINUX_SPECIFIC__
199 /* Flags for SYNC_FILE_RANGE.  */
200 # define SYNC_FILE_RANGE_WAIT_BEFORE    1 /* Wait upon writeout of all pages
201                                              in the range before performing the
202                                              write.  */
203 # define SYNC_FILE_RANGE_WRITE          2 /* Initiate writeout of all those
204                                              dirty pages in the range which are
205                                              not presently under writeback.  */
206 # define SYNC_FILE_RANGE_WAIT_AFTER     4 /* Wait upon writeout of all pages in
207                                              the range after performing the
208                                              write.  */
209 
210 /* Flags for SPLICE and VMSPLICE.  */
211 # define SPLICE_F_MOVE          1       /* Move pages instead of copying.  */
212 # define SPLICE_F_NONBLOCK      2       /* Don't block on the pipe splicing
213                                            (but we may still block on the fd
214                                            we splice from/to).  */
215 # define SPLICE_F_MORE          4       /* Expect more data.  */
216 # define SPLICE_F_GIFT          8       /* Pages passed in are a gift.  */
217 #endif
218 
219 __BEGIN_DECLS
220 
221 #if defined __USE_GNU && defined __UCLIBC_LINUX_SPECIFIC__
222 
223 /* Provide kernel hint to read ahead.  */
224 extern ssize_t readahead (int __fd, __off64_t __offset, size_t __count)
225     __THROW;
226 
227 
228 /* Selective file content synch'ing.  */
229 extern int sync_file_range (int __fd, __off64_t __from, __off64_t __to,
230                             unsigned int __flags);
231 
232 /* Splice address range into a pipe.  */
233 extern ssize_t vmsplice (int __fdout, const struct iovec *__iov,
234                          size_t __count, unsigned int __flags);
235 
236 /* Splice two files together.  */
237 extern ssize_t splice (int __fdin, __off64_t *__offin, int __fdout,
238                        __off64_t *__offout, size_t __len,
239                        unsigned int __flags);
240 
241 /* In-kernel implementation of tee for pipe buffers.  */
242 extern ssize_t tee (int __fdin, int __fdout, size_t __len,
243                     unsigned int __flags);
244 
245 #endif
246 __END_DECLS
247 
248 /* Include generic Linux declarations.  */
249 #include <bits/fcntl-linux.h>
250