blob: f26be05e0faba97f212f842479b2a529cb374161 [file] [log] [blame]
Chih-Hung Hsieha5ef72f2014-11-05 10:47:59 -08001/* O_*, F_*, FD_* bit values for Linux.
2 Copyright (C) 1995-1998, 2000, 2004, 2006, 2007, 2009, 2010, 2011
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, write to the Free
18 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 02111-1307 USA. */
20
21#ifndef _FCNTL_H
22# error "Never use <bits/fcntl.h> directly; include <fcntl.h> instead."
23#endif
24
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 a few file systems. */
33#define O_ACCMODE 0003
34#define O_RDONLY 00
35#define O_WRONLY 01
36#define O_RDWR 02
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
47
48#ifdef __USE_XOPEN2K8
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. */
52#endif
53#ifdef __USE_GNU
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. */
57#endif
58
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. */
65#endif
66
67#ifdef __USE_LARGEFILE64
68# define O_LARGEFILE 0100000
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#ifndef __USE_FILE_OFFSET64
78# define F_GETLK 5 /* Get record locking info. */
79# define F_SETLK 6 /* Set record locking info (non-blocking). */
80# define F_SETLKW 7 /* Set record locking info (blocking). */
81#else
82# define F_GETLK F_GETLK64 /* Get record locking info. */
83# define F_SETLK F_SETLK64 /* Set record locking info (non-blocking).*/
84# define F_SETLKW F_SETLKW64 /* Set record locking info (blocking). */
85#endif
86#define F_GETLK64 12 /* Get record locking info. */
87#define F_SETLK64 13 /* Set record locking info (non-blocking). */
88#define F_SETLKW64 14 /* Set record locking info (blocking). */
89
90#if defined __USE_BSD || defined __USE_UNIX98 || defined __USE_XOPEN2K8
91# define F_SETOWN 8 /* Get owner (process receiving SIGIO). */
92# define F_GETOWN 9 /* Set owner (process receiving SIGIO). */
93#endif
94
95#ifdef __USE_GNU
96# define F_SETSIG 10 /* Set number of signal to be sent. */
97# define F_GETSIG 11 /* Get number of signal to be sent. */
98# define F_SETOWN_EX 15 /* Get owner (thread receiving SIGIO). */
99# define F_GETOWN_EX 16 /* Set owner (thread receiving SIGIO). */
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 /* Set pipe page size array. */
108#endif
109#ifdef __USE_XOPEN2K8
110# define F_DUPFD_CLOEXEC 1030 /* Duplicate file descriptor with
111 close-on-exit set. */
112#endif
113
114/* For F_[GET|SET]FD. */
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
153struct 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
168struct 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#ifdef __USE_GNU
179/* Owner types. */
180enum __pid_type
181 {
182 F_OWNER_TID = 0, /* Kernel thread. */
183 F_OWNER_PID, /* Process. */
184 F_OWNER_PGRP, /* Process group. */
185 F_OWNER_GID = F_OWNER_PGRP /* Alternative, obsolete name. */
186 };
187
188/* Structure to use with F_GETOWN_EX and F_SETOWN_EX. */
189struct f_owner_ex
190 {
191 enum __pid_type type; /* Owner type of ID. */
192 __pid_t pid; /* ID of owner. */
193 };
194#endif
195
196/* Define some more compatibility macros to be backward compatible with
197 BSD systems which did not managed to hide these kernel macros. */
198#ifdef __USE_BSD
199# define FAPPEND O_APPEND
200# define FFSYNC O_FSYNC
201# define FASYNC O_ASYNC
202# define FNONBLOCK O_NONBLOCK
203# define FNDELAY O_NDELAY
204#endif /* Use BSD. */
205
206/* Advise to `posix_fadvise'. */
207#ifdef __USE_XOPEN2K
208# define POSIX_FADV_NORMAL 0 /* No further special treatment. */
209# define POSIX_FADV_RANDOM 1 /* Expect random page references. */
210# define POSIX_FADV_SEQUENTIAL 2 /* Expect sequential page references. */
211# define POSIX_FADV_WILLNEED 3 /* Will need these pages. */
212# define POSIX_FADV_DONTNEED 4 /* Don't need these pages. */
213# define POSIX_FADV_NOREUSE 5 /* Data will be accessed once. */
214#endif
215
216
217#ifdef __USE_GNU
218/* Flags for SYNC_FILE_RANGE. */
219# define SYNC_FILE_RANGE_WAIT_BEFORE 1 /* Wait upon writeout of all pages
220 in the range before performing the
221 write. */
222# define SYNC_FILE_RANGE_WRITE 2 /* Initiate writeout of all those
223 dirty pages in the range which are
224 not presently under writeback. */
225# define SYNC_FILE_RANGE_WAIT_AFTER 4 /* Wait upon writeout of all pages in
226 the range after performing the
227 write. */
228
229/* Flags for SPLICE and VMSPLICE. */
230# define SPLICE_F_MOVE 1 /* Move pages instead of copying. */
231# define SPLICE_F_NONBLOCK 2 /* Don't block on the pipe splicing
232 (but we may still block on the fd
233 we splice from/to). */
234# define SPLICE_F_MORE 4 /* Expect more data. */
235# define SPLICE_F_GIFT 8 /* Pages passed in are a gift. */
236
237
238/* File handle structure. */
239struct file_handle
240{
241 unsigned int handle_bytes;
242 int handle_type;
243 /* File identifier. */
244 unsigned char f_handle[0];
245};
246
247/* Maximum handle size (for now). */
248# define MAX_HANDLE_SZ 128
249#endif
250
251/* Values for `*at' functions. */
252#ifdef __USE_ATFILE
253# define AT_FDCWD -100 /* Special value used to indicate
254 the *at functions should use the
255 current working directory. */
256# define AT_SYMLINK_NOFOLLOW 0x100 /* Do not follow symbolic links. */
257# define AT_REMOVEDIR 0x200 /* Remove directory instead of
258 unlinking file. */
259# define AT_SYMLINK_FOLLOW 0x400 /* Follow symbolic links. */
260# define AT_NO_AUTOMOUNT 0x800 /* Suppress terminal automount
261 traversal. */
262# define AT_EACCESS 0x200 /* Test access permitted for
263 effective IDs, not real IDs. */
264#endif
265
266__BEGIN_DECLS
267
268#ifdef __USE_GNU
269
270/* Provide kernel hint to read ahead. */
271extern ssize_t readahead (int __fd, __off64_t __offset, size_t __count)
272 __THROW;
273
274
275/* Selective file content synch'ing. */
276extern int sync_file_range (int __fd, __off64_t __offset, __off64_t __count,
277 unsigned int __flags);
278
279
280/* Splice address range into a pipe.
281
282 This function is a possible cancellation point and therefore not
283 marked with __THROW. */
284extern ssize_t vmsplice (int __fdout, const struct iovec *__iov,
285 size_t __count, unsigned int __flags);
286
287/* Splice two files together.
288
289 This function is a possible cancellation point and therefore not
290 marked with __THROW. */
291extern ssize_t splice (int __fdin, __off64_t *__offin, int __fdout,
292 __off64_t *__offout, size_t __len,
293 unsigned int __flags);
294
295/* In-kernel implementation of tee for pipe buffers.
296
297 This function is a possible cancellation point and therefore not
298 marked with __THROW. */
299extern ssize_t tee (int __fdin, int __fdout, size_t __len,
300 unsigned int __flags);
301
302/* Reserve storage for the data of the file associated with FD.
303
304 This function is a possible cancellation point and therefore not
305 marked with __THROW. */
306# ifndef __USE_FILE_OFFSET64
307extern int fallocate (int __fd, int __mode, __off_t __offset, __off_t __len);
308# else
309# ifdef __REDIRECT
310extern int __REDIRECT (fallocate, (int __fd, int __mode, __off64_t __offset,
311 __off64_t __len),
312 fallocate64);
313# else
314# define fallocate fallocate64
315# endif
316# endif
317# ifdef __USE_LARGEFILE64
318extern int fallocate64 (int __fd, int __mode, __off64_t __offset,
319 __off64_t __len);
320# endif
321
322
323/* Map file name to file handle. */
324extern int name_to_handle_at (int __dfd, const char *__name,
325 struct file_handle *__handle, int *__mnt_id,
326 int __flags) __THROW;
327
328/* Open file using the file handle.
329
330 This function is a possible cancellation point and therefore not
331 marked with __THROW. */
332extern int open_by_handle_at (int __mountdirfd, struct file_handle *__handle,
333 int __flags);
334
335#endif
336
337__END_DECLS