libc/sysdeps/linux/i386/bits/fcntl.h

   1 /* O_*, F_*, FD_* bit values for Linux.
   2    Copyright (C) 1995, 1996, 1997, 1998, 2000, 2004, 2006, 2007, 2008
   3    Free Software Foundation, Inc.
   4    This file is part of the GNU C Library.
   5
   6    The GNU C Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    The GNU C Library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with the GNU C Library; if not, see
  18    <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef _FCNTL_H
  21 # error "Never use <bits/fcntl.h> directly; include <fcntl.h> instead."
  22 #endif
  23
  24 #include <sys/types.h>
  25 #ifdef __USE_GNU
  26 # include <bits/uio.h>
  27 #endif
  28
  29
  30 /* open/fcntl - O_SYNC is only implemented on blocks devices and on files
  31    located on an ext2 file system */
  32 #define O_ACCMODE          0003
  33 #define O_RDONLY             00
  34 #define O_WRONLY             01
  35 #define O_RDWR               02
  36 #define O_CREAT            0100 /* not fcntl */
  37 #define O_EXCL             0200 /* not fcntl */
  38 #define O_NOCTTY           0400 /* not fcntl */
  39 #define O_TRUNC           01000 /* not fcntl */
  40 #define O_APPEND          02000
  41 #define O_NONBLOCK        04000
  42 #define O_NDELAY        O_NONBLOCK
  43 #define O_SYNC           010000
  44 #define O_FSYNC          O_SYNC
  45 #define O_ASYNC          020000
  46
  47 #ifdef __USE_XOPEN2K8
  48 # define O_DIRECTORY    0200000 /* Must be a directory.  */
  49 # define O_NOFOLLOW     0400000 /* Do not follow links.  */
  50 # define O_CLOEXEC     02000000 /* Set close_on_exec.  */
  51 #endif
  52
  53 #ifdef __USE_GNU
  54 # define O_DIRECT        040000 /* Direct disk access.  */
  55 # define O_NOATIME     01000000 /* Do not set atime.  */
  56 # define O_PATH       010000000 /* Resolve pathname but do not open file.  */
  57 #endif
  58
  59 /* For now Linux has synchronisity options for data and read operations.
  60    We define the symbols here but let them do the same as O_SYNC since
  61    this is a superset.  */
  62 #if defined __USE_POSIX199309 || defined __USE_UNIX98
  63 # define O_DSYNC        O_SYNC  /* Synchronize data.  */
  64 # define O_RSYNC        O_SYNC  /* Synchronize read operations.  */
  65 #endif
  66
  67 #ifdef __USE_LARGEFILE64
  68 # define O_LARGEFILE    0100000
  69 #endif
  70
  71 /* Values for the second argument to `fcntl'.  */
  72 #define F_DUPFD         0       /* Duplicate file descriptor.  */
  73 #define F_GETFD         1       /* Get file descriptor flags.  */
  74 #define F_SETFD         2       /* Set file descriptor flags.  */
  75 #define F_GETFL         3       /* Get file status flags.  */
  76 #define F_SETFL         4       /* Set file status flags.  */
  77 #ifndef __USE_FILE_OFFSET64
  78 # define F_GETLK        5       /* Get record locking info.  */
  79 # define F_SETLK        6       /* Set record locking info (non-blocking).  */
  80 # define F_SETLKW       7       /* Set record locking info (blocking).  */
  81 #else
  82 # define F_GETLK        F_GETLK64  /* Get record locking info.  */
  83 # define F_SETLK        F_SETLK64  /* Set record locking info (non-blocking).*/
  84 # define F_SETLKW       F_SETLKW64 /* Set record locking info (blocking).  */
  85 #endif
  86 #define F_GETLK64       12      /* Get record locking info.  */
  87 #define F_SETLK64       13      /* Set record locking info (non-blocking).  */
  88 #define F_SETLKW64      14      /* Set record locking info (blocking).  */
  89
  90 #if defined __USE_BSD || defined __USE_UNIX98
  91 # define F_SETOWN       8       /* Get owner of socket (receiver of SIGIO).  */
  92 # define F_GETOWN       9       /* Set owner of socket (receiver of SIGIO).  */
  93 #endif
  94
  95 #ifdef __USE_GNU
  96 # define F_SETSIG       10      /* Set number of signal to be sent.  */
  97 # define F_GETSIG       11      /* Get number of signal to be sent.  */
  98 #endif
  99
 100 #ifdef __USE_GNU
 101 # define F_SETLEASE     1024    /* Set a lease.  */
 102 # define F_GETLEASE     1025    /* Enquire what lease is active.  */
 103 # define F_NOTIFY       1026    /* Request notfications on a directory.  */
 104 # define F_DUPFD_CLOEXEC 1030   /* Duplicate file descriptor with
 105                                    close-on-exit set on new fd.  */
 106 # define F_SETPIPE_SZ   1031    /* Set pipe page size array.  */
 107 # define F_GETPIPE_SZ   1032    /* Get pipe page size array.  */
 108 #endif
 109
 110 /* For F_[GET|SET]FD.  */
 111 #define FD_CLOEXEC      1       /* actually anything with low bit set goes */
 112
 113 /* For posix fcntl() and `l_type' field of a `struct flock' for lockf().  */
 114 #define F_RDLCK         0       /* Read lock.  */
 115 #define F_WRLCK         1       /* Write lock.  */
 116 #define F_UNLCK         2       /* Remove lock.  */
 117
 118 /* For old implementation of bsd flock().  */
 119 #define F_EXLCK         4       /* or 3 */
 120 #define F_SHLCK         8       /* or 4 */
 121
 122 #ifdef __USE_BSD
 123 /* Operations for bsd flock(), also used by the kernel implementation.  */
 124 # define LOCK_SH        1       /* shared lock */
 125 # define LOCK_EX        2       /* exclusive lock */
 126 # define LOCK_NB        4       /* or'd with one of the above to prevent
 127                                    blocking */
 128 # define LOCK_UN        8       /* remove lock */
 129 #endif
 130
 131 #ifdef __USE_GNU
 132 # define LOCK_MAND      32      /* This is a mandatory flock:   */
 133 # define LOCK_READ      64      /* ... which allows concurrent read operations.  */
 134 # define LOCK_WRITE     128     /* ... which allows concurrent write operations.  */
 135 # define LOCK_RW        192     /* ... Which allows concurrent read & write operations.  */
 136 #endif
 137
 138 #ifdef __USE_GNU
 139 /* Types of directory notifications that may be requested with F_NOTIFY.  */
 140 # define DN_ACCESS      0x00000001      /* File accessed.  */
 141 # define DN_MODIFY      0x00000002      /* File modified.  */
 142 # define DN_CREATE      0x00000004      /* File created.  */
 143 # define DN_DELETE      0x00000008      /* File removed.  */
 144 # define DN_RENAME      0x00000010      /* File renamed.  */
 145 # define DN_ATTRIB      0x00000020      /* File changed attibutes.  */
 146 # define DN_MULTISHOT   0x80000000      /* Don't remove notifier.  */
 147 #endif
 148
 149 struct flock
 150   {
 151     short int l_type;   /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.  */
 152     short int l_whence; /* Where `l_start' is relative to (like `lseek').  */
 153 #ifndef __USE_FILE_OFFSET64
 154     __off_t l_start;    /* Offset where the lock begins.  */
 155     __off_t l_len;      /* Size of the locked area; zero means until EOF.  */
 156 #else
 157     __off64_t l_start;  /* Offset where the lock begins.  */
 158     __off64_t l_len;    /* Size of the locked area; zero means until EOF.  */
 159 #endif
 160     __pid_t l_pid;      /* Process holding the lock.  */
 161   };
 162
 163 #ifdef __USE_LARGEFILE64
 164 struct flock64
 165   {
 166     short int l_type;   /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.  */
 167     short int l_whence; /* Where `l_start' is relative to (like `lseek').  */
 168     __off64_t l_start;  /* Offset where the lock begins.  */
 169     __off64_t l_len;    /* Size of the locked area; zero means until EOF.  */
 170     __pid_t l_pid;      /* Process holding the lock.  */
 171   };
 172 #endif
 173
 174 /* Define some more compatibility macros to be backward compatible with
 175    BSD systems which did not managed to hide these kernel macros.  */
 176 #ifdef  __USE_BSD
 177 # define FAPPEND        O_APPEND
 178 # define FFSYNC         O_FSYNC
 179 # define FASYNC         O_ASYNC
 180 # define FNONBLOCK      O_NONBLOCK
 181 # define FNDELAY        O_NDELAY
 182 #endif /* Use BSD.  */
 183
 184 /* Advise to `posix_fadvise'.  */
 185 #ifdef __USE_XOPEN2K
 186 # define POSIX_FADV_NORMAL      0 /* No further special treatment.  */
 187 # define POSIX_FADV_RANDOM      1 /* Expect random page references.  */
 188 # define POSIX_FADV_SEQUENTIAL  2 /* Expect sequential page references.  */
 189 # define POSIX_FADV_WILLNEED    3 /* Will need these pages.  */
 190 # define POSIX_FADV_DONTNEED    4 /* Don't need these pages.  */
 191 # define POSIX_FADV_NOREUSE     5 /* Data will be accessed once.  */
 192 #endif
 193
 194
 195 #if defined __USE_GNU && defined __UCLIBC_LINUX_SPECIFIC__
 196 /* Flags for SYNC_FILE_RANGE.  */
 197 # define SYNC_FILE_RANGE_WAIT_BEFORE    1 /* Wait upon writeout of all pages
 198                                              in the range before performing the
 199                                              write.  */
 200 # define SYNC_FILE_RANGE_WRITE          2 /* Initiate writeout of all those
 201                                              dirty pages in the range which are
 202                                              not presently under writeback.  */
 203 # define SYNC_FILE_RANGE_WAIT_AFTER     4 /* Wait upon writeout of all pages in
 204                                              the range after performing the
 205                                              write.  */
 206
 207 /* Flags for SPLICE and VMSPLICE.  */
 208 # define SPLICE_F_MOVE          1       /* Move pages instead of copying.  */
 209 # define SPLICE_F_NONBLOCK      2       /* Don't block on the pipe splicing
 210                                            (but we may still block on the fd
 211                                            we splice from/to).  */
 212 # define SPLICE_F_MORE          4       /* Expect more data.  */
 213 # define SPLICE_F_GIFT          8       /* Pages passed in are a gift.  */
 214 #endif
 215
 216 __BEGIN_DECLS
 217
 218 #if defined __USE_GNU && defined __UCLIBC_LINUX_SPECIFIC__
 219
 220 /* Provide kernel hint to read ahead.  */
 221 extern ssize_t readahead (int __fd, __off64_t __offset, size_t __count)
 222     __THROW;
 223
 224
 225 /* Selective file content synch'ing.  */
 226 extern int sync_file_range (int __fd, __off64_t __from, __off64_t __to,
 227                             unsigned int __flags);
 228
 229 /* Splice address range into a pipe.  */
 230 extern ssize_t vmsplice (int __fdout, const struct iovec *__iov,
 231                          size_t __count, unsigned int __flags);
 232
 233 /* Splice two files together.  */
 234 extern ssize_t splice (int __fdin, __off64_t *__offin, int __fdout,
 235                        __off64_t *__offout, size_t __len,
 236                        unsigned int __flags);
 237
 238 /* In-kernel implementation of tee for pipe buffers.  */
 239 extern ssize_t tee (int __fdin, int __fdout, size_t __len,
 240                     unsigned int __flags);
 241
 242 #endif
 243 __END_DECLS
 244