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

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