1 /* O_*, F_*, FD_* bit values for Linux/x86-64.
2 Copyright (C) 2001,2002,2004,2006,2007,2009,2010,2011
3 Free Software Foundation, Inc.
4 This file is part of the GNU C Library.
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.
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.
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/>. */
21 # error "Never use <bits/fcntl.h> directly; include <fcntl.h> instead."
24 #include <sys/types.h>
25 #include <bits/wordsize.h>
27 # include <bits/uio.h>
31 /* open/fcntl - O_SYNC is only implemented on blocks devices and on files
32 located on a few file systems. */
33 #define O_ACCMODE 0003
37 #define O_CREAT 0100 /* not fcntl */
38 #define O_EXCL 0200 /* not fcntl */
39 #define O_NOCTTY 0400 /* not fcntl */
40 #define O_TRUNC 01000 /* not fcntl */
41 #define O_APPEND 02000
42 #define O_NONBLOCK 04000
43 #define O_NDELAY O_NONBLOCK
44 #define O_SYNC 04010000
45 #define O_FSYNC O_SYNC
46 #define O_ASYNC 020000
49 # define O_DIRECTORY 0200000 /* Must be a directory. */
50 # define O_NOFOLLOW 0400000 /* Do not follow links. */
51 # define O_CLOEXEC 02000000 /* Set close_on_exec. */
54 # define O_DIRECT 040000 /* Direct disk access. */
55 # define O_NOATIME 01000000 /* Do not set atime. */
56 # define O_PATH 010000000 /* Resolve pathname but do not open file. */
59 /* For now Linux has synchronisity options for data and read operations.
60 We define the symbols here but let them do the same as O_SYNC since
61 this is a superset. */
62 #if defined __USE_POSIX199309 || defined __USE_UNIX98
63 # define O_DSYNC 010000 /* Synchronize data. */
64 # define O_RSYNC O_SYNC /* Synchronize read operations. */
67 #ifdef __USE_LARGEFILE64
69 # define O_LARGEFILE 0
71 # define O_LARGEFILE 0100000
75 /* Values for the second argument to `fcntl'. */
76 #define F_DUPFD 0 /* Duplicate file descriptor. */
77 #define F_GETFD 1 /* Get file descriptor flags. */
78 #define F_SETFD 2 /* Set file descriptor flags. */
79 #define F_GETFL 3 /* Get file status flags. */
80 #define F_SETFL 4 /* Set file status flags. */
82 # define F_GETLK 5 /* Get record locking info. */
83 # define F_SETLK 6 /* Set record locking info (non-blocking). */
84 # define F_SETLKW 7 /* Set record locking info (blocking). */
85 /* Not necessary, we always have 64-bit offsets. */
86 # define F_GETLK64 5 /* Get record locking info. */
87 # define F_SETLK64 6 /* Set record locking info (non-blocking). */
88 # define F_SETLKW64 7 /* Set record locking info (blocking). */
90 # ifndef __USE_FILE_OFFSET64
91 # define F_GETLK 5 /* Get record locking info. */
92 # define F_SETLK 6 /* Set record locking info (non-blocking). */
93 # define F_SETLKW 7 /* Set record locking info (blocking). */
95 # define F_GETLK F_GETLK64 /* Get record locking info. */
96 # define F_SETLK F_SETLK64 /* Set record locking info (non-blocking).*/
97 # define F_SETLKW F_SETLKW64 /* Set record locking info (blocking). */
99 # define F_GETLK64 12 /* Get record locking info. */
100 # define F_SETLK64 13 /* Set record locking info (non-blocking). */
101 # define F_SETLKW64 14 /* Set record locking info (blocking). */
104 #if defined __USE_BSD || defined __USE_UNIX98 || defined __USE_XOPEN2K8
105 # define F_SETOWN 8 /* Get owner (process receiving SIGIO). */
106 # define F_GETOWN 9 /* Set owner (process receiving SIGIO). */
110 # define F_SETSIG 10 /* Set number of signal to be sent. */
111 # define F_GETSIG 11 /* Get number of signal to be sent. */
112 # define F_SETOWN_EX 15 /* Get owner (thread receiving SIGIO). */
113 # define F_GETOWN_EX 16 /* Set owner (thread receiving SIGIO). */
117 # define F_SETLEASE 1024 /* Set a lease. */
118 # define F_GETLEASE 1025 /* Enquire what lease is active. */
119 # define F_NOTIFY 1026 /* Request notfications on a directory. */
120 # define F_SETPIPE_SZ 1031 /* Set pipe page size array. */
121 # define F_GETPIPE_SZ 1032 /* Set pipe page size array. */
123 #ifdef __USE_XOPEN2K8
124 # define F_DUPFD_CLOEXEC 1030 /* Duplicate file descriptor with
125 close-on-exit set. */
128 /* For F_[GET|SET]FD. */
129 #define FD_CLOEXEC 1 /* actually anything with low bit set goes */
131 /* For posix fcntl() and `l_type' field of a `struct flock' for lockf(). */
132 #define F_RDLCK 0 /* Read lock. */
133 #define F_WRLCK 1 /* Write lock. */
134 #define F_UNLCK 2 /* Remove lock. */
136 /* For old implementation of bsd flock(). */
137 #define F_EXLCK 4 /* or 3 */
138 #define F_SHLCK 8 /* or 4 */
141 /* Operations for bsd flock(), also used by the kernel implementation. */
142 # define LOCK_SH 1 /* shared lock */
143 # define LOCK_EX 2 /* exclusive lock */
144 # define LOCK_NB 4 /* or'd with one of the above to prevent
146 # define LOCK_UN 8 /* remove lock */
150 # define LOCK_MAND 32 /* This is a mandatory flock: */
151 # define LOCK_READ 64 /* ... which allows concurrent read operations. */
152 # define LOCK_WRITE 128 /* ... which allows concurrent write operations. */
153 # define LOCK_RW 192 /* ... Which allows concurrent read & write operations. */
157 /* Types of directory notifications that may be requested with F_NOTIFY. */
158 # define DN_ACCESS 0x00000001 /* File accessed. */
159 # define DN_MODIFY 0x00000002 /* File modified. */
160 # define DN_CREATE 0x00000004 /* File created. */
161 # define DN_DELETE 0x00000008 /* File removed. */
162 # define DN_RENAME 0x00000010 /* File renamed. */
163 # define DN_ATTRIB 0x00000020 /* File changed attibutes. */
164 # define DN_MULTISHOT 0x80000000 /* Don't remove notifier. */
169 short int l_type
; /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK. */
170 short int l_whence
; /* Where `l_start' is relative to (like `lseek'). */
171 #ifndef __USE_FILE_OFFSET64
172 __off_t l_start
; /* Offset where the lock begins. */
173 __off_t l_len
; /* Size of the locked area; zero means until EOF. */
175 __off64_t l_start
; /* Offset where the lock begins. */
176 __off64_t l_len
; /* Size of the locked area; zero means until EOF. */
178 __pid_t l_pid
; /* Process holding the lock. */
181 #ifdef __USE_LARGEFILE64
184 short int l_type
; /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK. */
185 short int l_whence
; /* Where `l_start' is relative to (like `lseek'). */
186 __off64_t l_start
; /* Offset where the lock begins. */
187 __off64_t l_len
; /* Size of the locked area; zero means until EOF. */
188 __pid_t l_pid
; /* Process holding the lock. */
196 F_OWNER_TID
= 0, /* Kernel thread. */
197 F_OWNER_PID
, /* Process. */
198 F_OWNER_PGRP
, /* Process group. */
199 F_OWNER_GID
= F_OWNER_PGRP
/* Alternative, obsolete name. */
202 /* Structure to use with F_GETOWN_EX and F_SETOWN_EX. */
205 enum __pid_type type
; /* Owner type of ID. */
206 __pid_t pid
; /* ID of owner. */
210 /* Define some more compatibility macros to be backward compatible with
211 BSD systems which did not managed to hide these kernel macros. */
213 # define FAPPEND O_APPEND
214 # define FFSYNC O_FSYNC
215 # define FASYNC O_ASYNC
216 # define FNONBLOCK O_NONBLOCK
217 # define FNDELAY O_NDELAY
218 #endif /* Use BSD. */
220 /* Advise to `posix_fadvise'. */
222 # define POSIX_FADV_NORMAL 0 /* No further special treatment. */
223 # define POSIX_FADV_RANDOM 1 /* Expect random page references. */
224 # define POSIX_FADV_SEQUENTIAL 2 /* Expect sequential page references. */
225 # define POSIX_FADV_WILLNEED 3 /* Will need these pages. */
226 # define POSIX_FADV_DONTNEED 4 /* Don't need these pages. */
227 # define POSIX_FADV_NOREUSE 5 /* Data will be accessed once. */
232 /* Flags for SYNC_FILE_RANGE. */
233 # define SYNC_FILE_RANGE_WAIT_BEFORE 1 /* Wait upon writeout of all pages
234 in the range before performing the
236 # define SYNC_FILE_RANGE_WRITE 2 /* Initiate writeout of all those
237 dirty pages in the range which are
238 not presently under writeback. */
239 # define SYNC_FILE_RANGE_WAIT_AFTER 4 /* Wait upon writeout of all pages in
240 the range after performing the
243 /* Flags for SPLICE and VMSPLICE. */
244 # define SPLICE_F_MOVE 1 /* Move pages instead of copying. */
245 # define SPLICE_F_NONBLOCK 2 /* Don't block on the pipe splicing
246 (but we may still block on the fd
247 we splice from/to). */
248 # define SPLICE_F_MORE 4 /* Expect more data. */
249 # define SPLICE_F_GIFT 8 /* Pages passed in are a gift. */
252 /* File handle structure. */
255 unsigned int handle_bytes
;
257 /* File identifier. */
258 unsigned char f_handle
[0];
261 /* Maximum handle size (for now). */
262 # define MAX_HANDLE_SZ 128
269 /* Provide kernel hint to read ahead. */
270 extern ssize_t
readahead (int __fd
, __off64_t __offset
, size_t __count
)
274 /* Selective file content synch'ing.
276 This function is a possible cancellation point and therefore not
277 marked with __THROW. */
278 extern int sync_file_range (int __fd
, __off64_t __offset
, __off64_t __count
,
279 unsigned int __flags
);
282 /* Splice address range into a pipe.
284 This function is a possible cancellation point and therefore not
285 marked with __THROW. */
286 extern ssize_t
vmsplice (int __fdout
, const struct iovec
*__iov
,
287 size_t __count
, unsigned int __flags
);
289 /* Splice two files together.
291 This function is a possible cancellation point and therefore not
292 marked with __THROW. */
293 extern ssize_t
splice (int __fdin
, __off64_t
*__offin
, int __fdout
,
294 __off64_t
*__offout
, size_t __len
,
295 unsigned int __flags
);
297 /* In-kernel implementation of tee for pipe buffers.
299 This function is a possible cancellation point and therefore not
300 marked with __THROW. */
301 extern ssize_t
tee (int __fdin
, int __fdout
, size_t __len
,
302 unsigned int __flags
);
304 /* Reserve storage for the data of the file associated with FD.
306 This function is a possible cancellation point and therefore not
307 marked with __THROW. */
308 # ifndef __USE_FILE_OFFSET64
309 extern int fallocate (int __fd
, int __mode
, __off_t __offset
, __off_t __len
);
312 extern int __REDIRECT (fallocate
, (int __fd
, int __mode
, __off64_t __offset
,
316 # define fallocate fallocate64
319 # ifdef __USE_LARGEFILE64
320 extern int fallocate64 (int __fd
, int __mode
, __off64_t __offset
,
325 /* Map file name to file handle. */
326 extern int name_to_handle_at (int __dfd
, const char *__name
,
327 struct file_handle
*__handle
, int *__mnt_id
,
328 int __flags
) __THROW
;
330 /* Open file using the file handle.
332 This function is a possible cancellation point and therefore not
333 marked with __THROW. */
334 extern int open_by_handle_at (int __mountdirfd
, struct file_handle
*__handle
,