include/fcntl.h

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