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

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