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

   1 /* O_*, F_*, FD_* bit values for Linux.
   2    Copyright (C) 2000, 2004, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library.  If not, see
  17    <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef _FCNTL_H
  20 # error "Never use <bits/fcntl.h> directly; include <fcntl.h> instead."
  21 #endif
  22
  23 #include <sys/types.h>
  24 #ifdef __USE_GNU
  25 # include <bits/uio.h>
  26 #endif
  27
  28
  29 /* open/fcntl - O_SYNC is only implemented on blocks devices and on files
  30    located on a few file systems.  */
  31 #define O_ACCMODE          0003
  32 #define O_RDONLY             00
  33 #define O_WRONLY             01
  34 #define O_RDWR               02
  35 #define O_CREAT            0100 /* not fcntl */
  36 #define O_EXCL             0200 /* not fcntl */
  37 #define O_NOCTTY           0400 /* not fcntl */
  38 #define O_TRUNC           01000 /* not fcntl */
  39 #define O_APPEND          02000
  40 #define O_NONBLOCK        04000
  41 #define O_NDELAY        O_NONBLOCK
  42 #define O_SYNC         04010000
  43 #define O_FSYNC          O_SYNC
  44 #define O_ASYNC          020000
  45
  46 #ifdef __USE_XOPEN2K8
  47 # define O_DIRECTORY     040000 /* Must be a directory.  */
  48 # define O_NOFOLLOW     0100000 /* Do not follow links.  */
  49 # define O_CLOEXEC     02000000 /* Set close_on_exec.  */
  50 #endif
  51 #ifdef __USE_GNU
  52 # define O_DIRECT       0200000 /* Direct disk access.  */
  53 # define O_NOATIME     01000000 /* Do not set atime.  */
  54 # define O_PATH       010000000 /* Resolve pathname but do not open file.  */
  55 #endif
  56
  57 /* For now Linux has 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        010000  /* Synchronize data.  */
  62 # define O_RSYNC        O_SYNC  /* Synchronize read operations.  */
  63 #endif
  64
  65 #ifdef __USE_LARGEFILE64
  66 # define O_LARGEFILE    0400000
  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        5       /* 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 #define F_GETLK64       12      /* Get record locking info.  */
  85 #define F_SETLK64       13      /* Set record locking info (non-blocking).  */
  86 #define F_SETLKW64      14      /* Set record locking info (blocking).  */
  87
  88 #if defined __USE_BSD || defined __USE_UNIX98 || defined __USE_XOPEN2K8
  89 # define F_SETOWN       8       /* Get owner of socket (receiver of SIGIO).  */
  90 # define F_GETOWN       9       /* Set owner of socket (receiver of SIGIO).  */
  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      /* Get owner (thread receiving SIGIO).  */
  97 # define F_GETOWN_EX    16      /* Set 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 /* For F_[GET|SET]FD.  */
 113 #define FD_CLOEXEC      1       /* actually anything with low bit set goes */
 114
 115 /* For posix fcntl() and `l_type' field of a `struct flock' for lockf().  */
 116 #define F_RDLCK         0       /* Read lock.  */
 117 #define F_WRLCK         1       /* Write lock.  */
 118 #define F_UNLCK         2       /* Remove lock.  */
 119
 120 /* For old implementation of bsd flock().  */
 121 #define F_EXLCK         4       /* or 3 */
 122 #define F_SHLCK         8       /* or 4 */
 123
 124 #ifdef __USE_BSD
 125 /* Operations for bsd flock(), also used by the kernel implementation.  */
 126 # define LOCK_SH        1       /* shared lock */
 127 # define LOCK_EX        2       /* exclusive lock */
 128 # define LOCK_NB        4       /* or'd with one of the above to prevent
 129                                    blocking */
 130 # define LOCK_UN        8       /* remove lock */
 131 #endif
 132
 133 #ifdef __USE_GNU
 134 # define LOCK_MAND      32      /* This is a mandatory flock:   */
 135 # define LOCK_READ      64      /* ... which allows concurrent read operations.  */
 136 # define LOCK_WRITE     128     /* ... which allows concurrent write operations.  */
 137 # define LOCK_RW        192     /* ... Which allows concurrent read & write operations.  */
 138 #endif
 139
 140 #ifdef __USE_GNU
 141 /* Types of directory notifications that may be requested with F_NOTIFY.  */
 142 # define DN_ACCESS      0x00000001      /* File accessed.  */
 143 # define DN_MODIFY      0x00000002      /* File modified.  */
 144 # define DN_CREATE      0x00000004      /* File created.  */
 145 # define DN_DELETE      0x00000008      /* File removed.  */
 146 # define DN_RENAME      0x00000010      /* File renamed.  */
 147 # define DN_ATTRIB      0x00000020      /* File changed attibutes.  */
 148 # define DN_MULTISHOT   0x80000000      /* Don't remove notifier.  */
 149 #endif
 150
 151 struct flock
 152   {
 153     short int l_type;   /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.  */
 154     short int l_whence; /* Where `l_start' is relative to (like `lseek').  */
 155 #ifndef __USE_FILE_OFFSET64
 156     __off_t l_start;    /* Offset where the lock begins.  */
 157     __off_t l_len;      /* Size of the locked area; zero means until EOF.  */
 158 #else
 159     __off64_t l_start;  /* Offset where the lock begins.  */
 160     __off64_t l_len;    /* Size of the locked area; zero means until EOF.  */
 161 #endif
 162     __pid_t l_pid;      /* Process holding the lock.  */
 163   };
 164
 165 #ifdef __USE_LARGEFILE64
 166 struct flock64
 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     __off64_t l_start;  /* Offset where the lock begins.  */
 171     __off64_t l_len;    /* Size of the locked area; zero means until EOF.  */
 172     __pid_t l_pid;      /* Process holding the lock.  */
 173   };
 174 #endif
 175
 176 #ifdef __USE_GNU
 177 /* Owner types.  */
 178 enum __pid_type
 179   {
 180     F_OWNER_TID = 0,            /* Kernel thread.  */
 181     F_OWNER_PID,                /* Process.  */
 182     F_OWNER_PGRP,               /* Process group.  */
 183     F_OWNER_GID = F_OWNER_PGRP  /* Alternative, obsolete name.  */
 184   };
 185
 186 /* Structure to use with F_GETOWN_EX and F_SETOWN_EX.  */
 187 struct f_owner_ex
 188   {
 189     enum __pid_type type;       /* Owner type of ID.  */
 190     __pid_t pid;                /* ID of owner.  */
 191   };
 192 #endif
 193
 194 /* Define some more compatibility macros to be backward compatible with
 195    BSD systems which did not managed to hide these kernel macros.  */
 196 #ifdef  __USE_BSD
 197 # define FAPPEND        O_APPEND
 198 # define FFSYNC         O_FSYNC
 199 # define FASYNC         O_ASYNC
 200 # define FNONBLOCK      O_NONBLOCK
 201 # define FNDELAY        O_NDELAY
 202 #endif /* Use BSD.  */
 203
 204 /* Advise to `posix_fadvise'.  */
 205 #ifdef __USE_XOPEN2K
 206 # define POSIX_FADV_NORMAL      0 /* No further special treatment.  */
 207 # define POSIX_FADV_RANDOM      1 /* Expect random page references.  */
 208 # define POSIX_FADV_SEQUENTIAL  2 /* Expect sequential page references.  */
 209 # define POSIX_FADV_WILLNEED    3 /* Will need these pages.  */
 210 # define POSIX_FADV_DONTNEED    4 /* Don't need these pages.  */
 211 # define POSIX_FADV_NOREUSE     5 /* Data will be accessed once.  */
 212 #endif
 213
 214
 215 #ifdef __USE_GNU
 216 /* Flags for SYNC_FILE_RANGE.  */
 217 # define SYNC_FILE_RANGE_WAIT_BEFORE    1 /* Wait upon writeout of all pages
 218                                              in the range before performing the
 219                                              write.  */
 220 # define SYNC_FILE_RANGE_WRITE          2 /* Initiate writeout of all those
 221                                              dirty pages in the range which are
 222                                              not presently under writeback.  */
 223 # define SYNC_FILE_RANGE_WAIT_AFTER     4 /* Wait upon writeout of all pages in
 224                                              the range after performing the
 225                                              write.  */
 226
 227 /* Flags for SPLICE and VMSPLICE.  */
 228 # define SPLICE_F_MOVE          1       /* Move pages instead of copying.  */
 229 # define SPLICE_F_NONBLOCK      2       /* Don't block on the pipe splicing
 230                                            (but we may still block on the fd
 231                                            we splice from/to).  */
 232 # define SPLICE_F_MORE          4       /* Expect more data.  */
 233 # define SPLICE_F_GIFT          8       /* Pages passed in are a gift.  */
 234
 235
 236 /* File handle structure.  */
 237 struct file_handle
 238 {
 239   unsigned int handle_bytes;
 240   int handle_type;
 241   /* File identifier.  */
 242   unsigned char f_handle[0];
 243 };
 244
 245 /* Maximum handle size (for now).  */
 246 # define MAX_HANDLE_SZ  128
 247 #endif
 248
 249 __BEGIN_DECLS
 250
 251 #ifdef __USE_GNU
 252
 253 /* Provide kernel hint to read ahead.  */
 254 extern ssize_t readahead (int __fd, __off64_t __offset, size_t __count)
 255     __THROW;
 256
 257
 258 /* Selective file content synch'ing.  */
 259 extern int sync_file_range (int __fd, __off64_t __offset, __off64_t __count,
 260                             unsigned int __flags);
 261
 262
 263 /* Splice address range into a pipe.
 264
 265    This function is a possible cancellation point and therefore not
 266    marked with __THROW.  */
 267 extern ssize_t vmsplice (int __fdout, const struct iovec *__iov,
 268                          size_t __count, unsigned int __flags);
 269
 270 /* Splice two files together.
 271
 272    This function is a possible cancellation point and therefore not
 273    marked with __THROW.  */
 274 extern ssize_t splice (int __fdin, __off64_t *__offin, int __fdout,
 275                        __off64_t *__offout, size_t __len,
 276                        unsigned int __flags);
 277
 278 /* In-kernel implementation of tee for pipe buffers.
 279
 280    This function is a possible cancellation point and therefore not
 281    marked with __THROW.  */
 282 extern ssize_t tee (int __fdin, int __fdout, size_t __len,
 283                     unsigned int __flags);
 284
 285 /* Reserve storage for the data of the file associated with FD.
 286
 287    This function is a possible cancellation point and therefore not
 288    marked with __THROW.  */
 289 # ifndef __USE_FILE_OFFSET64
 290 extern int fallocate (int __fd, int __mode, __off_t __offset, __off_t __len);
 291 # else
 292 #  ifdef __REDIRECT
 293 extern int __REDIRECT (fallocate, (int __fd, int __mode, __off64_t __offset,
 294                                    __off64_t __len),
 295                        fallocate64);
 296 #  else
 297 #   define fallocate fallocate64
 298 #  endif
 299 # endif
 300 # ifdef __USE_LARGEFILE64
 301 extern int fallocate64 (int __fd, int __mode, __off64_t __offset,
 302                         __off64_t __len);
 303 # endif
 304
 305
 306 /* Map file name to file handle.  */
 307 extern int name_to_handle_at (int __dfd, const char *__name,
 308                               struct file_handle *__handle, int *__mnt_id,
 309                               int __flags) __THROW;
 310
 311 /* Open file using the file handle.
 312
 313    This function is a possible cancellation point and therefore not
 314    marked with __THROW.  */
 315 extern int open_by_handle_at (int __mountdirfd, struct file_handle *__handle,
 316                               int __flags);
 317
 318 #endif
 319
 320 __END_DECLS