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