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

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