1 /* Copyright (C) 1991-2018 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) any later version.
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Lesser General Public License for more details.
14 You should have received a copy of the GNU Lesser General Public
15 License along with the GNU C Library; if not, see
16 <http://www.gnu.org/licenses/>. */
19 * POSIX Standard: 6.5 File Control Operations <fcntl.h>
27 /* This must be early so <bits/fcntl.h> can define types winningly. */
30 /* Get __mode_t, __dev_t and __off_t .*/
31 #include <bits/types.h>
33 /* Get the definitions of O_*, F_*, FD_*: all the
34 numbers and flag bits for `open', `fcntl', et al. */
35 #include <bits/fcntl.h>
37 /* Detect if open needs mode as a third argument (or for openat as a fourth
40 # define __OPEN_NEEDS_MODE(oflag) \
41 (((oflag) & O_CREAT) != 0 || ((oflag) & __O_TMPFILE) == __O_TMPFILE)
43 # define __OPEN_NEEDS_MODE(oflag) (((oflag) & O_CREAT) != 0)
46 /* POSIX.1-2001 specifies that these types are defined by <fcntl.h>.
47 Earlier POSIX standards permitted any type ending in `_t' to be defined
48 by any POSIX header, so we don't conditionalize the definitions here. */
49 #ifndef __mode_t_defined
50 typedef __mode_t mode_t;
51 # define __mode_t_defined
54 #ifndef __off_t_defined
55 # ifndef __USE_FILE_OFFSET64
56 typedef __off_t off_t;
58 typedef __off64_t off_t;
60 # define __off_t_defined
63 #if defined __USE_LARGEFILE64 && !defined __off64_t_defined
64 typedef __off64_t off64_t;
65 # define __off64_t_defined
68 #ifndef __pid_t_defined
69 typedef __pid_t pid_t;
70 # define __pid_t_defined
73 /* For XPG all symbols from <sys/stat.h> should also be available. */
75 # include <bits/types/struct_timespec.h>
77 #if defined __USE_XOPEN || defined __USE_XOPEN2K8
78 # include <bits/stat.h>
80 # define S_IFMT __S_IFMT
81 # define S_IFDIR __S_IFDIR
82 # define S_IFCHR __S_IFCHR
83 # define S_IFBLK __S_IFBLK
84 # define S_IFREG __S_IFREG
86 # define S_IFIFO __S_IFIFO
89 # define S_IFLNK __S_IFLNK
91 # if (defined __USE_UNIX98 || defined __USE_XOPEN2K8) && defined __S_IFSOCK
92 # define S_IFSOCK __S_IFSOCK
95 /* Protection bits. */
97 # define S_ISUID __S_ISUID /* Set user ID on execution. */
98 # define S_ISGID __S_ISGID /* Set group ID on execution. */
100 # if defined __USE_MISC || defined __USE_XOPEN
101 /* Save swapped text after use (sticky bit). This is pretty well obsolete. */
102 # define S_ISVTX __S_ISVTX
105 # define S_IRUSR __S_IREAD /* Read by owner. */
106 # define S_IWUSR __S_IWRITE /* Write by owner. */
107 # define S_IXUSR __S_IEXEC /* Execute by owner. */
108 /* Read, write, and execute by owner. */
109 # define S_IRWXU (__S_IREAD|__S_IWRITE|__S_IEXEC)
111 # define S_IRGRP (S_IRUSR >> 3) /* Read by group. */
112 # define S_IWGRP (S_IWUSR >> 3) /* Write by group. */
113 # define S_IXGRP (S_IXUSR >> 3) /* Execute by group. */
114 /* Read, write, and execute by group. */
115 # define S_IRWXG (S_IRWXU >> 3)
117 # define S_IROTH (S_IRGRP >> 3) /* Read by others. */
118 # define S_IWOTH (S_IWGRP >> 3) /* Write by others. */
119 # define S_IXOTH (S_IXGRP >> 3) /* Execute by others. */
120 /* Read, write, and execute by others. */
121 # define S_IRWXO (S_IRWXG >> 3)
125 # ifndef R_OK /* Verbatim from <unistd.h>. Ugh. */
126 /* Values for the second argument to access.
127 These may be OR'd together. */
128 # define R_OK 4 /* Test for read permission. */
129 # define W_OK 2 /* Test for write permission. */
130 # define X_OK 1 /* Test for execute permission. */
131 # define F_OK 0 /* Test for existence. */
133 #endif /* Use misc. */
135 /* XPG wants the following symbols. <stdio.h> has the same definitions. */
136 #if defined __USE_XOPEN || defined __USE_XOPEN2K8
137 # define SEEK_SET 0 /* Seek from beginning of file. */
138 # define SEEK_CUR 1 /* Seek from current position. */
139 # define SEEK_END 2 /* Seek from end of file. */
142 /* Do the file control operation described by CMD on FD.
143 The remaining arguments are interpreted depending on CMD.
145 This function is a cancellation point and therefore not marked with
147 #ifndef __USE_FILE_OFFSET64
148 extern int fcntl (int __fd, int __cmd, ...);
151 extern int __REDIRECT (fcntl, (int __fd, int __cmd, ...), fcntl64);
153 # define fcntl fcntl64
156 #ifdef __USE_LARGEFILE64
157 extern int fcntl64 (int __fd, int __cmd, ...);
160 /* Open FILE and return a new file descriptor for it, or -1 on error.
161 OFLAG determines the type of access used. If O_CREAT or O_TMPFILE is set
162 in OFLAG, the third argument is taken as a `mode_t', the mode of the
165 This function is a cancellation point and therefore not marked with
167 #ifndef __USE_FILE_OFFSET64
168 extern int open (const char *__file, int __oflag, ...) __nonnull ((1));
171 extern int __REDIRECT (open, (const char *__file, int __oflag, ...), open64)
177 #ifdef __USE_LARGEFILE64
178 extern int open64 (const char *__file, int __oflag, ...) __nonnull ((1));
182 /* Similar to `open' but a relative path name is interpreted relative to
183 the directory for which FD is a descriptor.
185 NOTE: some other `openat' implementation support additional functionality
186 through this interface, especially using the O_XATTR flag. This is not
189 This function is a cancellation point and therefore not marked with
191 # ifndef __USE_FILE_OFFSET64
192 extern int openat (int __fd, const char *__file, int __oflag, ...)
196 extern int __REDIRECT (openat, (int __fd, const char *__file, int __oflag,
197 ...), openat64) __nonnull ((2));
199 # define openat openat64
202 # ifdef __USE_LARGEFILE64
203 extern int openat64 (int __fd, const char *__file, int __oflag, ...)
208 /* Create and open FILE, with mode MODE. This takes an `int' MODE
209 argument because that is what `mode_t' will be widened to.
211 This function is a cancellation point and therefore not marked with
213 #ifndef __USE_FILE_OFFSET64
214 extern int creat (const char *__file, mode_t __mode) __nonnull ((1));
217 extern int __REDIRECT (creat, (const char *__file, mode_t __mode),
218 creat64) __nonnull ((1));
220 # define creat creat64
223 #ifdef __USE_LARGEFILE64
224 extern int creat64 (const char *__file, mode_t __mode) __nonnull ((1));
227 #if !defined F_LOCK && (defined __USE_MISC || (defined __USE_XOPEN_EXTENDED \
228 && !defined __USE_POSIX))
229 /* NOTE: These declarations also appear in <unistd.h>; be sure to keep both
230 files consistent. Some systems have them there and some here, and some
231 software depends on the macros being defined without including both. */
233 /* `lockf' is a simpler interface to the locking facilities of `fcntl'.
234 LEN is always relative to the current file position.
235 The CMD argument is one of the following. */
237 # define F_ULOCK 0 /* Unlock a previously locked region. */
238 # define F_LOCK 1 /* Lock a region for exclusive use. */
239 # define F_TLOCK 2 /* Test and lock a region for exclusive use. */
240 # define F_TEST 3 /* Test a region for other processes locks. */
242 # ifndef __USE_FILE_OFFSET64
243 extern int lockf (int __fd, int __cmd, off_t __len);
246 extern int __REDIRECT (lockf, (int __fd, int __cmd, __off64_t __len), lockf64);
248 # define lockf lockf64
251 # ifdef __USE_LARGEFILE64
252 extern int lockf64 (int __fd, int __cmd, off64_t __len);
257 /* Advice the system about the expected behaviour of the application with
258 respect to the file associated with FD. */
259 # ifndef __USE_FILE_OFFSET64
260 extern int posix_fadvise (int __fd, off_t __offset, off_t __len,
261 int __advise) __THROW;
263 # ifdef __REDIRECT_NTH
264 extern int __REDIRECT_NTH (posix_fadvise, (int __fd, __off64_t __offset,
265 __off64_t __len, int __advise),
268 # define posix_fadvise posix_fadvise64
271 # ifdef __USE_LARGEFILE64
272 extern int posix_fadvise64 (int __fd, off64_t __offset, off64_t __len,
273 int __advise) __THROW;
277 /* Reserve storage for the data of the file associated with FD.
279 This function is a possible cancellation point and therefore not
280 marked with __THROW. */
281 # ifndef __USE_FILE_OFFSET64
282 extern int posix_fallocate (int __fd, off_t __offset, off_t __len);
285 extern int __REDIRECT (posix_fallocate, (int __fd, __off64_t __offset,
289 # define posix_fallocate posix_fallocate64
292 # ifdef __USE_LARGEFILE64
293 extern int posix_fallocate64 (int __fd, off64_t __offset, off64_t __len);
298 /* Define some inlines helping to catch common problems. */
299 #if __USE_FORTIFY_LEVEL > 0 && defined __fortify_function \
300 && defined __va_arg_pack_len
301 # include <bits/fcntl2.h>