1/* Copyright (C) 1991-2016 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3
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.
8
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.
13
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/>. */
17
18/*
19 * POSIX Standard: 6.5 File Control Operations <fcntl.h>
20 */
21
22#ifndef _FCNTL_H
23#define _FCNTL_H 1
24
25#include <features.h>
26
27/* This must be early so <bits/fcntl.h> can define types winningly. */
28__BEGIN_DECLS
29
30/* Get __mode_t, __dev_t and __off_t .*/
31#include <bits/types.h>
32
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>
36
37/* Detect if open needs mode as a third argument (or for openat as a fourth
38 argument). */
39#ifdef __O_TMPFILE
40# define __OPEN_NEEDS_MODE(oflag) \
41 (((oflag) & O_CREAT) != 0 || ((oflag) & __O_TMPFILE) == __O_TMPFILE)
42#else
43# define __OPEN_NEEDS_MODE(oflag) (((oflag) & O_CREAT) != 0)
44#endif
45
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
50typedef __mode_t mode_t;
51# define __mode_t_defined
52#endif
53
54#ifndef __off_t_defined
55# ifndef __USE_FILE_OFFSET64
56typedef __off_t off_t;
57# else
58typedef __off64_t off_t;
59# endif
60# define __off_t_defined
61#endif
62
63#if defined __USE_LARGEFILE64 && !defined __off64_t_defined
64typedef __off64_t off64_t;
65# define __off64_t_defined
66#endif
67
68#ifndef __pid_t_defined
69typedef __pid_t pid_t;
70# define __pid_t_defined
71#endif
72
73/* For XPG all symbols from <sys/stat.h> should also be available. */
74#if defined __USE_XOPEN || defined __USE_XOPEN2K8
75# define __need_timespec
76# include <time.h>
77# include <bits/stat.h>
78
79# define S_IFMT __S_IFMT
80# define S_IFDIR __S_IFDIR
81# define S_IFCHR __S_IFCHR
82# define S_IFBLK __S_IFBLK
83# define S_IFREG __S_IFREG
84# ifdef __S_IFIFO
85# define S_IFIFO __S_IFIFO
86# endif
87# ifdef __S_IFLNK
88# define S_IFLNK __S_IFLNK
89# endif
90# if (defined __USE_UNIX98 || defined __USE_XOPEN2K8) && defined __S_IFSOCK
91# define S_IFSOCK __S_IFSOCK
92# endif
93
94/* Protection bits. */
95
96# define S_ISUID __S_ISUID /* Set user ID on execution. */
97# define S_ISGID __S_ISGID /* Set group ID on execution. */
98
99# if defined __USE_MISC || defined __USE_XOPEN
100/* Save swapped text after use (sticky bit). This is pretty well obsolete. */
101# define S_ISVTX __S_ISVTX
102# endif
103
104# define S_IRUSR __S_IREAD /* Read by owner. */
105# define S_IWUSR __S_IWRITE /* Write by owner. */
106# define S_IXUSR __S_IEXEC /* Execute by owner. */
107/* Read, write, and execute by owner. */
108# define S_IRWXU (__S_IREAD|__S_IWRITE|__S_IEXEC)
109
110# define S_IRGRP (S_IRUSR >> 3) /* Read by group. */
111# define S_IWGRP (S_IWUSR >> 3) /* Write by group. */
112# define S_IXGRP (S_IXUSR >> 3) /* Execute by group. */
113/* Read, write, and execute by group. */
114# define S_IRWXG (S_IRWXU >> 3)
115
116# define S_IROTH (S_IRGRP >> 3) /* Read by others. */
117# define S_IWOTH (S_IWGRP >> 3) /* Write by others. */
118# define S_IXOTH (S_IXGRP >> 3) /* Execute by others. */
119/* Read, write, and execute by others. */
120# define S_IRWXO (S_IRWXG >> 3)
121#endif
122
123#ifdef __USE_MISC
124# ifndef R_OK /* Verbatim from <unistd.h>. Ugh. */
125/* Values for the second argument to access.
126 These may be OR'd together. */
127# define R_OK 4 /* Test for read permission. */
128# define W_OK 2 /* Test for write permission. */
129# define X_OK 1 /* Test for execute permission. */
130# define F_OK 0 /* Test for existence. */
131# endif
132#endif /* Use misc. */
133
134/* XPG wants the following symbols. <stdio.h> has the same definitions. */
135#if defined __USE_XOPEN || defined __USE_XOPEN2K8
136# define SEEK_SET 0 /* Seek from beginning of file. */
137# define SEEK_CUR 1 /* Seek from current position. */
138# define SEEK_END 2 /* Seek from end of file. */
139#endif /* XPG */
140
141/* Do the file control operation described by CMD on FD.
142 The remaining arguments are interpreted depending on CMD.
143
144 This function is a cancellation point and therefore not marked with
145 __THROW. */
146extern int fcntl (int __fd, int __cmd, ...);
147
148/* Open FILE and return a new file descriptor for it, or -1 on error.
149 OFLAG determines the type of access used. If O_CREAT or O_TMPFILE is set
150 in OFLAG, the third argument is taken as a `mode_t', the mode of the
151 created file.
152
153 This function is a cancellation point and therefore not marked with
154 __THROW. */
155#ifndef __USE_FILE_OFFSET64
156extern int open (const char *__file, int __oflag, ...) __nonnull ((1));
157#else
158# ifdef __REDIRECT
159extern int __REDIRECT (open, (const char *__file, int __oflag, ...), open64)
160 __nonnull ((1));
161# else
162# define open open64
163# endif
164#endif
165#ifdef __USE_LARGEFILE64
166extern int open64 (const char *__file, int __oflag, ...) __nonnull ((1));
167#endif
168
169#ifdef __USE_ATFILE
170/* Similar to `open' but a relative path name is interpreted relative to
171 the directory for which FD is a descriptor.
172
173 NOTE: some other `openat' implementation support additional functionality
174 through this interface, especially using the O_XATTR flag. This is not
175 yet supported here.
176
177 This function is a cancellation point and therefore not marked with
178 __THROW. */
179# ifndef __USE_FILE_OFFSET64
180extern int openat (int __fd, const char *__file, int __oflag, ...)
181 __nonnull ((2));
182# else
183# ifdef __REDIRECT
184extern int __REDIRECT (openat, (int __fd, const char *__file, int __oflag,
185 ...), openat64) __nonnull ((2));
186# else
187# define openat openat64
188# endif
189# endif
190# ifdef __USE_LARGEFILE64
191extern int openat64 (int __fd, const char *__file, int __oflag, ...)
192 __nonnull ((2));
193# endif
194#endif
195
196/* Create and open FILE, with mode MODE. This takes an `int' MODE
197 argument because that is what `mode_t' will be widened to.
198
199 This function is a cancellation point and therefore not marked with
200 __THROW. */
201#ifndef __USE_FILE_OFFSET64
202extern int creat (const char *__file, mode_t __mode) __nonnull ((1));
203#else
204# ifdef __REDIRECT
205extern int __REDIRECT (creat, (const char *__file, mode_t __mode),
206 creat64) __nonnull ((1));
207# else
208# define creat creat64
209# endif
210#endif
211#ifdef __USE_LARGEFILE64
212extern int creat64 (const char *__file, mode_t __mode) __nonnull ((1));
213#endif
214
215#if !defined F_LOCK && (defined __USE_MISC || (defined __USE_XOPEN_EXTENDED \
216 && !defined __USE_POSIX))
217/* NOTE: These declarations also appear in <unistd.h>; be sure to keep both
218 files consistent. Some systems have them there and some here, and some
219 software depends on the macros being defined without including both. */
220
221/* `lockf' is a simpler interface to the locking facilities of `fcntl'.
222 LEN is always relative to the current file position.
223 The CMD argument is one of the following. */
224
225# define F_ULOCK 0 /* Unlock a previously locked region. */
226# define F_LOCK 1 /* Lock a region for exclusive use. */
227# define F_TLOCK 2 /* Test and lock a region for exclusive use. */
228# define F_TEST 3 /* Test a region for other processes locks. */
229
230# ifndef __USE_FILE_OFFSET64
231extern int lockf (int __fd, int __cmd, off_t __len);
232# else
233# ifdef __REDIRECT
234extern int __REDIRECT (lockf, (int __fd, int __cmd, __off64_t __len), lockf64);
235# else
236# define lockf lockf64
237# endif
238# endif
239# ifdef __USE_LARGEFILE64
240extern int lockf64 (int __fd, int __cmd, off64_t __len);
241# endif
242#endif
243
244#ifdef __USE_XOPEN2K
245/* Advice the system about the expected behaviour of the application with
246 respect to the file associated with FD. */
247# ifndef __USE_FILE_OFFSET64
248extern int posix_fadvise (int __fd, off_t __offset, off_t __len,
249 int __advise) __THROW;
250# else
251 # ifdef __REDIRECT_NTH
252extern int __REDIRECT_NTH (posix_fadvise, (int __fd, __off64_t __offset,
253 __off64_t __len, int __advise),
254 posix_fadvise64);
255# else
256# define posix_fadvise posix_fadvise64
257# endif
258# endif
259# ifdef __USE_LARGEFILE64
260extern int posix_fadvise64 (int __fd, off64_t __offset, off64_t __len,
261 int __advise) __THROW;
262# endif
263
264
265/* Reserve storage for the data of the file associated with FD.
266
267 This function is a possible cancellation point and therefore not
268 marked with __THROW. */
269# ifndef __USE_FILE_OFFSET64
270extern int posix_fallocate (int __fd, off_t __offset, off_t __len);
271# else
272 # ifdef __REDIRECT
273extern int __REDIRECT (posix_fallocate, (int __fd, __off64_t __offset,
274 __off64_t __len),
275 posix_fallocate64);
276# else
277# define posix_fallocate posix_fallocate64
278# endif
279# endif
280# ifdef __USE_LARGEFILE64
281extern int posix_fallocate64 (int __fd, off64_t __offset, off64_t __len);
282# endif
283#endif
284
285
286/* Define some inlines helping to catch common problems. */
287#if __USE_FORTIFY_LEVEL > 0 && defined __fortify_function \
288 && defined __va_arg_pack_len
289# include <bits/fcntl2.h>
290#endif
291
292__END_DECLS
293
294#endif /* fcntl.h */
295