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