sysdeps/unix/sysv/linux/sh/bits/fcntl.h

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