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

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