fdwalk should return 0 on an empty directory
[kopensolaris-gnu/glibc.git] / io / fcntl.h
1 /* Copyright (C) 1991,1992,1994-2001,2003,2004,2005,2006,2007
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 # ifndef __AT_DEFINED
61 #  define AT_FDCWD              -100    /* Special value used to indicate
62                                            the *at functions should use the
63                                            current working directory. */
64 #  define AT_SYMLINK_NOFOLLOW   0x100   /* Do not follow symbolic links.  */
65 #  define AT_REMOVEDIR          0x200   /* Remove directory instead of
66                                            unlinking file.  */
67 #  define AT_SYMLINK_FOLLOW     0x400   /* Follow symbolic links.  */
68 #  define AT_EACCESS            0x200   /* Test access permitted for
69                                            effective IDs, not real IDs.  */
70 # endif
71 #endif
72
73 /* Do the file control operation described by CMD on FD.
74    The remaining arguments are interpreted depending on CMD.
75
76    This function is a cancellation point and therefore not marked with
77    __THROW.  */
78 extern int fcntl (int __fd, int __cmd, ...);
79
80 /* Open FILE and return a new file descriptor for it, or -1 on error.
81    OFLAG determines the type of access used.  If O_CREAT is on OFLAG,
82    the third argument is taken as a `mode_t', the mode of the created file.
83
84    This function is a cancellation point and therefore not marked with
85    __THROW.  */
86 #ifndef __USE_FILE_OFFSET64
87 extern int open (__const char *__file, int __oflag, ...) __nonnull ((1));
88 #else
89 # ifdef __REDIRECT
90 extern int __REDIRECT (open, (__const char *__file, int __oflag, ...), open64)
91      __nonnull ((1));
92 # else
93 #  define open open64
94 # endif
95 #endif
96 #ifdef __USE_LARGEFILE64
97 extern int open64 (__const char *__file, int __oflag, ...) __nonnull ((1));
98 #endif
99
100 #ifdef __USE_ATFILE
101 /* Similar to `open' but a relative path name is interpreted relative to
102    the directory for which FD is a descriptor.
103
104    NOTE: some other `openat' implementation support additional functionality
105    through this interface, especially using the O_XATTR flag.  This is not
106    yet supported here.
107
108    This function is a cancellation point and therefore not marked with
109    __THROW.  */
110 # ifndef __USE_FILE_OFFSET64
111 extern int openat (int __fd, __const char *__file, int __oflag, ...)
112      __nonnull ((2));
113 # else
114 #  ifdef __REDIRECT
115 extern int __REDIRECT (openat, (int __fd, __const char *__file, int __oflag,
116                                 ...), openat64) __nonnull ((2));
117 #  else
118 #   define openat openat64
119 #  endif
120 # endif
121
122 extern int openat64 (int __fd, __const char *__file, int __oflag, ...)
123      __nonnull ((2));
124 #endif
125
126 /* Create and open FILE, with mode MODE.  This takes an `int' MODE
127    argument because that is what `mode_t' will be widened to.
128
129    This function is a cancellation point and therefore not marked with
130    __THROW.  */
131 #ifndef __USE_FILE_OFFSET64
132 extern int creat (__const char *__file, __mode_t __mode) __nonnull ((1));
133 #else
134 # ifdef __REDIRECT
135 extern int __REDIRECT (creat, (__const char *__file, __mode_t __mode),
136                        creat64) __nonnull ((1));
137 # else
138 #  define creat creat64
139 # endif
140 #endif
141 #ifdef __USE_LARGEFILE64
142 extern int creat64 (__const char *__file, __mode_t __mode) __nonnull ((1));
143 #endif
144
145 #if !defined F_LOCK && (defined __USE_MISC || (defined __USE_XOPEN_EXTENDED \
146                                                && !defined __USE_POSIX))
147 /* NOTE: These declarations also appear in <unistd.h>; be sure to keep both
148    files consistent.  Some systems have them there and some here, and some
149    software depends on the macros being defined without including both.  */
150
151 /* `lockf' is a simpler interface to the locking facilities of `fcntl'.
152    LEN is always relative to the current file position.
153    The CMD argument is one of the following.  */
154
155 # define F_ULOCK 0      /* Unlock a previously locked region.  */
156 # define F_LOCK  1      /* Lock a region for exclusive use.  */
157 # define F_TLOCK 2      /* Test and lock a region for exclusive use.  */
158 # define F_TEST  3      /* Test a region for other processes locks.  */
159
160 # ifndef __USE_FILE_OFFSET64
161 extern int lockf (int __fd, int __cmd, __off_t __len);
162 # else
163 # ifdef __REDIRECT
164 extern int __REDIRECT (lockf, (int __fd, int __cmd, __off64_t __len), lockf64);
165 # else
166 #  define lockf lockf64
167 # endif
168 # endif
169 # ifdef __USE_LARGEFILE64
170 extern int lockf64 (int __fd, int __cmd, __off64_t __len);
171 # endif
172 #endif
173
174 #ifdef __USE_XOPEN2K
175 /* Advice the system about the expected behaviour of the application with
176    respect to the file associated with FD.  */
177 # ifndef __USE_FILE_OFFSET64
178 extern int posix_fadvise (int __fd, __off_t __offset, __off_t __len,
179                           int __advise) __THROW;
180 # else
181 # ifdef __REDIRECT_NTH
182 extern int __REDIRECT_NTH (posix_fadvise, (int __fd, __off64_t __offset,
183                                            __off64_t __len, int __advise),
184                            posix_fadvise64);
185 # else
186 #  define posix_fadvise posix_fadvise64
187 # endif
188 # endif
189 # ifdef __USE_LARGEFILE64
190 extern int posix_fadvise64 (int __fd, __off64_t __offset, __off64_t __len,
191                             int __advise) __THROW;
192 # endif
193
194
195 /* Reserve storage for the data of the file associated with FD.
196
197    This function is a possible cancellation points and therefore not
198    marked with __THROW.  */
199 # ifndef __USE_FILE_OFFSET64
200 extern int posix_fallocate (int __fd, __off_t __offset, __off_t __len);
201 # else
202 # ifdef __REDIRECT
203 extern int __REDIRECT (posix_fallocate, (int __fd, __off64_t __offset,
204                                          __off64_t __len),
205                        posix_fallocate64);
206 # else
207 #  define posix_fallocate posix_fallocate64
208 # endif
209 # endif
210 # ifdef __USE_LARGEFILE64
211 extern int posix_fallocate64 (int __fd, __off64_t __offset, __off64_t __len);
212 # endif
213 #endif
214
215
216 /* Define some inlines helping to catch common problems.  */
217 #if __USE_FORTIFY_LEVEL > 0 && defined __extern_always_inline \
218     && defined __va_arg_pack_len
219 # include <bits/fcntl2.h>
220 #endif
221
222 __END_DECLS
223
224 #endif /* fcntl.h  */