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