blob: 26ad1fe6d377c3d279256e807cd2fbb893b97f1b [file] [log] [blame]
lh9ed821d2023-04-07 01:36:19 -07001/* Copyright (C) 1991,1992,1994-2001,2003,2004,2005,2006,2007, 2009
2 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
9
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18 02111-1307 USA. */
19
20/*
21 * POSIX Standard: 6.5 File Control Operations <fcntl.h>
22 */
23
24#ifndef _FCNTL_H
25#define _FCNTL_H 1
26
27#include <features.h>
28
29/* This must be early so <bits/fcntl.h> can define types winningly. */
30__BEGIN_DECLS
31
32/* Get the definitions of O_*, F_*, FD_*: all the
33 numbers and flag bits for `open', `fcntl', et al. */
34#include <bits/fcntl.h>
35
36/* For XPG all symbols from <sys/stat.h> should also be available. */
37#ifdef __USE_XOPEN
38# include <sys/stat.h>
39#endif
40
41#ifdef __USE_MISC
42# ifndef R_OK /* Verbatim from <unistd.h>. Ugh. */
43/* Values for the second argument to access.
44 These may be OR'd together. */
45# define R_OK 4 /* Test for read permission. */
46# define W_OK 2 /* Test for write permission. */
47# define X_OK 1 /* Test for execute permission. */
48# define F_OK 0 /* Test for existence. */
49# endif
50#endif /* Use misc. */
51
52/* XPG wants the following symbols. */
53#ifdef __USE_XOPEN /* <stdio.h> has the same definitions. */
54# define SEEK_SET 0 /* Seek from beginning of file. */
55# define SEEK_CUR 1 /* Seek from current position. */
56# define SEEK_END 2 /* Seek from end of file. */
57#endif /* XPG */
58
59#ifdef __USE_ATFILE
60# define AT_FDCWD -100 /* Special value used to indicate
61 the *at functions should use the
62 current working directory. */
63# define AT_SYMLINK_NOFOLLOW 0x100 /* Do not follow symbolic links. */
64# define AT_REMOVEDIR 0x200 /* Remove directory instead of
65 unlinking file. */
66# define AT_SYMLINK_FOLLOW 0x400 /* Follow symbolic links. */
67# define AT_EACCESS 0x200 /* Test access permitted for
68 effective IDs, not real IDs. */
69#endif
70
71/* Do the file control operation described by CMD on FD.
72 The remaining arguments are interpreted depending on CMD.
73
74 This function is a cancellation point and therefore not marked with
75 __THROW. */
76#if !defined(__USE_FILE_OFFSET64) || defined(__LP64__)
77extern int fcntl (int __fd, int __cmd, ...);
78libc_hidden_proto(fcntl)
79#else
80# ifdef __REDIRECT
81extern int __REDIRECT (fcntl, (int __fd, int __cmd, ...), fcntl64);
82# else
83# define fcntl fcntl64
84# endif
85#endif
86#if defined(__USE_LARGEFILE64) && !defined(__LP64__)
87extern int fcntl64 (int __fd, int __cmd, ...);
88libc_hidden_proto(fcntl64)
89#endif
90
91/* Open FILE and return a new file descriptor for it, or -1 on error.
92 OFLAG determines the type of access used. If O_CREAT is on OFLAG,
93 the third argument is taken as a `mode_t', the mode of the created file.
94
95 This function is a cancellation point and therefore not marked with
96 __THROW. */
97#ifndef __USE_FILE_OFFSET64
98extern int open (__const char *__file, int __oflag, ...) __nonnull ((1));
99libc_hidden_proto(open)
100#else
101# ifdef __REDIRECT
102extern int __REDIRECT (open, (__const char *__file, int __oflag, ...), open64)
103 __nonnull ((1));
104# else
105# define open open64
106# endif
107#endif
108#ifdef __USE_LARGEFILE64
109extern int open64 (__const char *__file, int __oflag, ...) __nonnull ((1));
110libc_hidden_proto(open64)
111#endif
112
113#ifdef __USE_ATFILE
114/* Similar to `open' but a relative path name is interpreted relative to
115 the directory for which FD is a descriptor.
116
117 NOTE: some other `openat' implementation support additional functionality
118 through this interface, especially using the O_XATTR flag. This is not
119 yet supported here.
120
121 This function is a cancellation point and therefore not marked with
122 __THROW. */
123# ifndef __USE_FILE_OFFSET64
124extern int openat (int __fd, __const char *__file, int __oflag, ...)
125 __nonnull ((2));
126libc_hidden_proto(openat)
127# else
128# ifdef __REDIRECT
129extern int __REDIRECT (openat, (int __fd, __const char *__file, int __oflag,
130 ...), openat64) __nonnull ((2));
131# else
132# define openat openat64
133# endif
134# endif
135
136extern int openat64 (int __fd, __const char *__file, int __oflag, ...)
137 __nonnull ((2));
138libc_hidden_proto(openat64)
139#endif
140
141/* Create and open FILE, with mode MODE. This takes an `int' MODE
142 argument because that is what `mode_t' will be widened to.
143
144 This function is a cancellation point and therefore not marked with
145 __THROW. */
146#ifndef __USE_FILE_OFFSET64
147extern int creat (__const char *__file, __mode_t __mode) __nonnull ((1));
148#else
149# ifdef __REDIRECT
150extern int __REDIRECT (creat, (__const char *__file, __mode_t __mode),
151 creat64) __nonnull ((1));
152# else
153# define creat creat64
154# endif
155#endif
156#ifdef __USE_LARGEFILE64
157extern int creat64 (__const char *__file, __mode_t __mode) __nonnull ((1));
158#endif
159
160#if !defined F_LOCK && (defined __USE_MISC || (defined __USE_XOPEN_EXTENDED \
161 && !defined __USE_POSIX))
162/* NOTE: These declarations also appear in <unistd.h>; be sure to keep both
163 files consistent. Some systems have them there and some here, and some
164 software depends on the macros being defined without including both. */
165
166/* `lockf' is a simpler interface to the locking facilities of `fcntl'.
167 LEN is always relative to the current file position.
168 The CMD argument is one of the following. */
169
170# define F_ULOCK 0 /* Unlock a previously locked region. */
171# define F_LOCK 1 /* Lock a region for exclusive use. */
172# define F_TLOCK 2 /* Test and lock a region for exclusive use. */
173# define F_TEST 3 /* Test a region for other processes locks. */
174
175# ifndef __USE_FILE_OFFSET64
176extern int lockf (int __fd, int __cmd, __off_t __len);
177libc_hidden_proto(lockf)
178# else
179# ifdef __REDIRECT
180extern int __REDIRECT (lockf, (int __fd, int __cmd, __off64_t __len), lockf64);
181# else
182# define lockf lockf64
183# endif
184# endif
185# ifdef __USE_LARGEFILE64
186extern int lockf64 (int __fd, int __cmd, __off64_t __len);
187libc_hidden_proto(lockf64)
188# endif
189#endif
190
191#if defined __USE_XOPEN2K && defined __UCLIBC_HAS_ADVANCED_REALTIME__
192/* Advice the system about the expected behaviour of the application with
193 respect to the file associated with FD. */
194# ifndef __USE_FILE_OFFSET64
195extern int posix_fadvise (int __fd, __off_t __offset, __off_t __len,
196 int __advise) __THROW;
197# else
198# ifdef __REDIRECT_NTH
199extern int __REDIRECT_NTH (posix_fadvise, (int __fd, __off64_t __offset,
200 __off64_t __len, int __advise),
201 posix_fadvise64);
202# else
203# define posix_fadvise posix_fadvise64
204# endif
205# endif
206# ifdef __USE_LARGEFILE64
207extern int posix_fadvise64 (int __fd, __off64_t __offset, __off64_t __len,
208 int __advise) __THROW;
209# endif
210
211#endif
212
213#if 0 /* && defined __UCLIBC_HAS_ADVANCED_REALTIME__ */
214
215/* FIXME -- uClibc should probably implement these... */
216
217/* Reserve storage for the data of the file associated with FD.
218
219 This function is a possible cancellation points and therefore not
220 marked with __THROW. */
221# ifndef __USE_FILE_OFFSET64
222extern int posix_fallocate (int __fd, __off_t __offset, __off_t __len);
223# else
224# ifdef __REDIRECT
225extern int __REDIRECT (posix_fallocate, (int __fd, __off64_t __offset,
226 __off64_t __len),
227 posix_fallocate64);
228# else
229# define posix_fallocate posix_fallocate64
230# endif
231# endif
232# ifdef __USE_LARGEFILE64
233extern int posix_fallocate64 (int __fd, __off64_t __offset, __off64_t __len);
234# endif
235#endif
236
237#ifdef _LIBC
238extern int __fcntl_nocancel (int fd, int cmd, ...);
239libc_hidden_proto(__fcntl_nocancel)
240#endif
241
242__END_DECLS
243
244#endif /* fcntl.h */