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