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