Back to index

glibc  2.9
fcntl.h
Go to the documentation of this file.
00001 /* O_*, F_*, FD_* bit values for Linux.
00002    Copyright (C) 1995, 1996, 1997, 1998, 2000, 2002, 2003, 2004, 2006, 2007
00003        Free Software Foundation, Inc.
00004    This file is part of the GNU C Library.
00005 
00006    The GNU C Library is free software; you can redistribute it and/or
00007    modify it under the terms of the GNU Lesser General Public
00008    License as published by the Free Software Foundation; either
00009    version 2.1 of the License, or (at your option) any later version.
00010 
00011    The GNU C Library is distributed in the hope that it will be useful,
00012    but WITHOUT ANY WARRANTY; without even the implied warranty of
00013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014    Lesser General Public License for more details.
00015 
00016    You should have received a copy of the GNU Lesser General Public
00017    License along with the GNU C Library; if not, write to the Free
00018    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
00019    02111-1307 USA.  */
00020 
00021 #ifndef       _FCNTL_H
00022 # error "Never use <bits/fcntl.h> directly; include <fcntl.h> instead."
00023 #endif
00024 
00025 #include <sgidefs.h>
00026 #include <sys/types.h>
00027 #ifdef __USE_GNU
00028 # include <bits/uio.h>
00029 #endif
00030 
00031 
00032 /* open/fcntl - O_SYNC is only implemented on blocks devices and on files
00033    located on an ext2 file system */
00034 #define O_ACCMODE       0003
00035 #define O_RDONLY          00
00036 #define O_WRONLY          01
00037 #define O_RDWR                   02
00038 #define O_APPEND      0x0008
00039 #define O_SYNC               0x0010
00040 #define O_NONBLOCK    0x0080
00041 #define O_NDELAY     O_NONBLOCK
00042 #define O_CREAT              0x0100       /* not fcntl */
00043 #define O_TRUNC              0x0200       /* not fcntl */
00044 #define O_EXCL               0x0400       /* not fcntl */
00045 #define O_NOCTTY      0x0800       /* not fcntl */
00046 #define O_FSYNC              O_SYNC
00047 #define O_ASYNC              0x1000
00048 
00049 #ifdef __USE_GNU
00050 # define O_NOFOLLOW  0x20000       /* Do not follow links.      */
00051 # define O_DIRECT    0x8000 /* Direct disk access hint.  */
00052 # define O_DIRECTORY 0x10000       /* Must be a directory.      */
00053 # define O_NOATIME   0x40000       /* Do not set atime.  */
00054 # define O_CLOEXEC     02000000 /* Set close_on_exec.  */
00055 #endif
00056 
00057 /* For now Linux has no synchronisity options for data and read operations.
00058    We define the symbols here but let them do the same as O_SYNC since
00059    this is a superset.      */
00060 #if defined __USE_POSIX199309 || defined __USE_UNIX98
00061 # define O_DSYNC     O_SYNC /* Synchronize data.  */
00062 # define O_RSYNC     O_SYNC /* Synchronize read operations.     */
00063 #endif
00064 
00065 #ifdef __USE_LARGEFILE64
00066 # define O_LARGEFILE 0x2000 /* Allow large file opens.  */
00067 #endif
00068 
00069 /* Values for the second argument to `fcntl'.  */
00070 #define F_DUPFD             0      /* Duplicate file descriptor.  */
00071 #define F_GETFD             1      /* Get file descriptor flags.  */
00072 #define F_SETFD             2      /* Set file descriptor flags.  */
00073 #define F_GETFL             3      /* Get file status flags.  */
00074 #define F_SETFL             4      /* Set file status flags.  */
00075 #ifndef __USE_FILE_OFFSET64
00076 # define F_GETLK     14     /* Get record locking info.  */
00077 # define F_SETLK     6      /* Set record locking info (non-blocking).  */
00078 # define F_SETLKW    7      /* Set record locking info (blocking).    */
00079 #else
00080 # define F_GETLK     F_GETLK64  /* Get record locking info.    */
00081 # define F_SETLK     F_SETLK64  /* Set record locking info (non-blocking).*/
00082 # define F_SETLKW    F_SETLKW64 /* Set record locking info (blocking).  */
00083 #endif
00084 
00085 #define F_GETLK64    33     /* Get record locking info.  */
00086 #define F_SETLK64    34     /* Set record locking info (non-blocking).  */
00087 #define F_SETLKW64   35     /* Set record locking info (blocking).    */
00088 
00089 #if defined __USE_BSD || defined __USE_UNIX98
00090 # define F_SETOWN    24     /* Get owner of socket (receiver of SIGIO).  */
00091 # define F_GETOWN    23     /* Set owner of socket (receiver of SIGIO).  */
00092 #endif
00093 
00094 #ifdef __USE_GNU
00095 # define F_SETSIG    10     /* Set number of signal to be sent.  */
00096 # define F_GETSIG    11     /* Get number of signal to be sent.  */
00097 #endif
00098 
00099 #ifdef __USE_GNU
00100 # define F_SETLEASE  1024   /* Set a lease.       */
00101 # define F_GETLEASE  1025   /* Enquire what lease is active.  */
00102 # define F_NOTIFY    1026   /* Request notfications on a directory.    */
00103 # define F_DUPFD_CLOEXEC 1030      /* Duplicate file descriptor with
00104                                close-on-exit set.  */
00105 #endif
00106 
00107 /* For F_[GET|SET]FD.  */
00108 #define FD_CLOEXEC   1      /* actually anything with low bit set goes */
00109 
00110 /* For posix fcntl() and `l_type' field of a `struct flock' for lockf().  */
00111 #define F_RDLCK             0      /* Read lock.  */
00112 #define F_WRLCK             1      /* Write lock.       */
00113 #define F_UNLCK             2      /* Remove lock.       */
00114 
00115 /* For old implementation of bsd flock().  */
00116 #define F_EXLCK             4      /* or 3 */
00117 #define F_SHLCK             8      /* or 4 */
00118 
00119 #ifdef __USE_BSD
00120 /* Operations for bsd flock(), also used by the kernel implementation.       */
00121 # define LOCK_SH     1      /* shared lock */
00122 # define LOCK_EX     2      /* exclusive lock */
00123 # define LOCK_NB     4      /* or'd with one of the above to prevent
00124                                blocking */
00125 # define LOCK_UN     8      /* remove lock */
00126 #endif
00127 
00128 #ifdef __USE_GNU
00129 # define LOCK_MAND   32     /* This is a mandatory flock:      */
00130 # define LOCK_READ   64     /* ... which allows concurrent read operations.   */
00131 # define LOCK_WRITE  128    /* ... which allows concurrent write operations.  */
00132 # define LOCK_RW     192    /* ... Which allows concurrent read & write operations.  */
00133 #endif
00134 
00135 #ifdef __USE_GNU
00136 /* Types of directory notifications that may be requested with F_NOTIFY.  */
00137 # define DN_ACCESS   0x00000001    /* File accessed.  */
00138 # define DN_MODIFY   0x00000002    /* File modified.  */
00139 # define DN_CREATE   0x00000004    /* File created.  */
00140 # define DN_DELETE   0x00000008    /* File removed.  */
00141 # define DN_RENAME   0x00000010    /* File renamed.  */
00142 # define DN_ATTRIB   0x00000020    /* File changed attibutes.  */
00143 # define DN_MULTISHOT       0x80000000    /* Don't remove notifier.  */
00144 #endif
00145 
00146 struct flock
00147   {
00148     short int l_type;       /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.   */
00149     short int l_whence;     /* Where `l_start' is relative to (like `lseek').  */
00150 #ifndef __USE_FILE_OFFSET64
00151     __off_t l_start; /* Offset where the lock begins.  */
00152     __off_t l_len;   /* Size of the locked area; zero means until EOF.  */
00153 #if _MIPS_SIM != _ABI64
00154     /* The 64-bit flock structure, used by the n64 ABI, and for 64-bit
00155        fcntls in o32 and n32, never has this field.  */
00156     long int l_sysid;
00157 #endif
00158 #else
00159     __off64_t l_start;      /* Offset where the lock begins.  */
00160     __off64_t l_len; /* Size of the locked area; zero means until EOF.  */
00161 #endif
00162     __pid_t l_pid;   /* Process holding the lock.  */
00163 #if ! defined __USE_FILE_OFFSET64 && _MIPS_SIM != _ABI64
00164     /* The 64-bit flock structure, used by the n64 ABI, and for 64-bit
00165        flock in o32 and n32, never has this field.  */
00166     long int pad[4];
00167 #endif
00168   };
00169 typedef struct flock flock_t;
00170 
00171 #ifdef __USE_LARGEFILE64
00172 struct flock64
00173   {
00174     short int l_type;       /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.   */
00175     short int l_whence;     /* Where `l_start' is relative to (like `lseek').  */
00176     __off64_t l_start;      /* Offset where the lock begins.  */
00177     __off64_t l_len; /* Size of the locked area; zero means until EOF.  */
00178     __pid_t l_pid;   /* Process holding the lock.  */
00179   };
00180 #endif
00181 
00182 /* Define some more compatibility macros to be backward compatible with
00183    BSD systems which did not managed to hide these kernel macros.  */
00184 #ifdef __USE_BSD
00185 # define FAPPEND     O_APPEND
00186 # define FFSYNC             O_FSYNC
00187 # define FASYNC             O_ASYNC
00188 # define FNONBLOCK   O_NONBLOCK
00189 # define FNDELAY     O_NDELAY
00190 #endif /* Use BSD.  */
00191 
00192 /* Advise to `posix_fadvise'.  */
00193 #ifdef __USE_XOPEN2K
00194 # define POSIX_FADV_NORMAL  0 /* No further special treatment.  */
00195 # define POSIX_FADV_RANDOM  1 /* Expect random page references.  */
00196 # define POSIX_FADV_SEQUENTIAL     2 /* Expect sequential page references.    */
00197 # define POSIX_FADV_WILLNEED       3 /* Will need these pages.  */
00198 # define POSIX_FADV_DONTNEED       4 /* Don't need these pages.  */
00199 # define POSIX_FADV_NOREUSE 5 /* Data will be accessed once.  */
00200 #endif
00201 
00202 
00203 #ifdef __USE_GNU
00204 /* Flags for SYNC_FILE_RANGE.  */
00205 # define SYNC_FILE_RANGE_WAIT_BEFORE      1 /* Wait upon writeout of all pages
00206                                         in the range before performing the
00207                                         write.  */
00208 # define SYNC_FILE_RANGE_WRITE            2 /* Initiate writeout of all those
00209                                         dirty pages in the range which are
00210                                         not presently under writeback.  */
00211 # define SYNC_FILE_RANGE_WAIT_AFTER       4 /* Wait upon writeout of all pages in
00212                                         the range after performing the
00213                                         write.  */
00214 
00215 /* Flags for SPLICE and VMSPLICE.  */
00216 # define SPLICE_F_MOVE             1      /* Move pages instead of copying.  */
00217 # define SPLICE_F_NONBLOCK  2      /* Don't block on the pipe splicing
00218                                       (but we may still block on the fd
00219                                       we splice from/to).  */
00220 # define SPLICE_F_MORE             4      /* Expect more data.  */
00221 # define SPLICE_F_GIFT             8      /* Pages passed in are a gift.  */
00222 #endif
00223 
00224 __BEGIN_DECLS
00225 
00226 #ifdef __USE_GNU
00227 
00228 /* Provide kernel hint to read ahead.  */
00229 extern ssize_t readahead (int __fd, __off64_t __offset, size_t __count)
00230     __THROW;
00231 
00232 
00233 /* Selective file content synch'ing.  */
00234 extern int sync_file_range (int __fd, __off64_t __from, __off64_t __to,
00235                          unsigned int __flags);
00236 
00237 
00238 /* Splice address range into a pipe.  */
00239 extern ssize_t vmsplice (int __fdout, const struct iovec *__iov,
00240                       size_t __count, unsigned int __flags);
00241 
00242 /* Splice two files together.  */
00243 extern ssize_t splice (int __fdin, __off64_t *__offin, int __fdout,
00244                      __off64_t *__offout, size_t __len,
00245                      unsigned int __flags);
00246 
00247 /* In-kernel implementation of tee for pipe buffers.  */
00248 extern ssize_t tee (int __fdin, int __fdout, size_t __len,
00249                   unsigned int __flags);
00250 
00251 #endif
00252 
00253 __END_DECLS