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

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