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, 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 <sys/types.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 /* For now Linux has synchronisity options for data and read operations.
00057    We define the symbols here but let them do the same as O_SYNC since
00058    this is a superset.      */
00059 #if defined __USE_POSIX199309 || defined __USE_UNIX98
00060 # define O_DSYNC     O_SYNC /* Synchronize data.  */
00061 # define O_RSYNC     O_SYNC /* Synchronize read operations.     */
00062 #endif
00063 
00064 #ifdef __USE_LARGEFILE64
00065 # define O_LARGEFILE 0100000
00066 #endif
00067 
00068 /* Values for the second argument to `fcntl'.  */
00069 #define F_DUPFD             0      /* Duplicate file descriptor.  */
00070 #define F_GETFD             1      /* Get file descriptor flags.  */
00071 #define F_SETFD             2      /* Set file descriptor flags.  */
00072 #define F_GETFL             3      /* Get file status flags.  */
00073 #define F_SETFL             4      /* Set file status flags.  */
00074 #ifndef __USE_FILE_OFFSET64
00075 # define F_GETLK     5      /* Get record locking info.  */
00076 # define F_SETLK     6      /* Set record locking info (non-blocking).  */
00077 # define F_SETLKW    7      /* Set record locking info (blocking).    */
00078 #else
00079 # define F_GETLK     F_GETLK64  /* Get record locking info.    */
00080 # define F_SETLK     F_SETLK64  /* Set record locking info (non-blocking).*/
00081 # define F_SETLKW    F_SETLKW64 /* Set record locking info (blocking).  */
00082 #endif
00083 #define F_GETLK64    12     /* Get record locking info.  */
00084 #define F_SETLK64    13     /* Set record locking info (non-blocking).  */
00085 #define F_SETLKW64   14     /* Set record locking info (blocking).    */
00086 
00087 #if defined __USE_BSD || defined __USE_UNIX98
00088 # define F_SETOWN    8      /* Get owner of socket (receiver of SIGIO).  */
00089 # define F_GETOWN    9      /* Set owner of socket (receiver of SIGIO).  */
00090 #endif
00091 
00092 #ifdef __USE_GNU
00093 # define F_SETSIG    10     /* Set number of signal to be sent.  */
00094 # define F_GETSIG    11     /* Get number of signal to be sent.  */
00095 #endif
00096 
00097 #ifdef __USE_GNU
00098 # define F_SETLEASE  1024   /* Set a lease.       */
00099 # define F_GETLEASE  1025   /* Enquire what lease is active.  */
00100 # define F_NOTIFY    1026   /* Request notfications on a directory.    */
00101 # define F_DUPFD_CLOEXEC 1030      /* Duplicate file descriptor with
00102                                close-on-exit set.  */
00103 #endif
00104 
00105 /* For F_[GET|SET]FD.  */
00106 #define FD_CLOEXEC   1      /* actually anything with low bit set goes */
00107 
00108 /* For posix fcntl() and `l_type' field of a `struct flock' for lockf().  */
00109 #define F_RDLCK             0      /* Read lock.  */
00110 #define F_WRLCK             1      /* Write lock.       */
00111 #define F_UNLCK             2      /* Remove lock.       */
00112 
00113 /* For old implementation of bsd flock().  */
00114 #define F_EXLCK             4      /* or 3 */
00115 #define F_SHLCK             8      /* or 4 */
00116 
00117 #ifdef __USE_BSD
00118 /* Operations for bsd flock(), also used by the kernel implementation.       */
00119 # define LOCK_SH     1      /* shared lock */
00120 # define LOCK_EX     2      /* exclusive lock */
00121 # define LOCK_NB     4      /* or'd with one of the above to prevent
00122                                blocking */
00123 # define LOCK_UN     8      /* remove lock */
00124 #endif
00125 
00126 #ifdef __USE_GNU
00127 # define LOCK_MAND   32     /* This is a mandatory flock:      */
00128 # define LOCK_READ   64     /* ... which allows concurrent read operations.   */
00129 # define LOCK_WRITE  128    /* ... which allows concurrent write operations.  */
00130 # define LOCK_RW     192    /* ... Which allows concurrent read & write operations.  */
00131 #endif
00132 
00133 #ifdef __USE_GNU
00134 /* Types of directory notifications that may be requested with F_NOTIFY.  */
00135 # define DN_ACCESS   0x00000001    /* File accessed.  */
00136 # define DN_MODIFY   0x00000002    /* File modified.  */
00137 # define DN_CREATE   0x00000004    /* File created.  */
00138 # define DN_DELETE   0x00000008    /* File removed.  */
00139 # define DN_RENAME   0x00000010    /* File renamed.  */
00140 # define DN_ATTRIB   0x00000020    /* File changed attibutes.  */
00141 # define DN_MULTISHOT       0x80000000    /* Don't remove notifier.  */
00142 #endif
00143 
00144 struct flock
00145   {
00146     short int l_type;       /* Type of lock: F_RDLCK, F_WRLCK, or F_UNLCK.   */
00147     short int l_whence;     /* Where `l_start' is relative to (like `lseek').  */
00148 #ifndef __USE_FILE_OFFSET64
00149     __off_t l_start; /* Offset where the lock begins.  */
00150     __off_t l_len;   /* Size of the locked area; zero means until EOF.  */
00151 #else
00152     __off64_t l_start;      /* Offset where the lock begins.  */
00153     __off64_t l_len; /* Size of the locked area; zero means until EOF.  */
00154 #endif
00155     __pid_t l_pid;   /* Process holding the lock.  */
00156   };
00157 
00158 #ifdef __USE_LARGEFILE64
00159 struct flock64
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     __off64_t l_start;      /* Offset where the lock begins.  */
00164     __off64_t l_len; /* Size of the locked area; zero means until EOF.  */
00165     __pid_t l_pid;   /* Process holding the lock.  */
00166   };
00167 #endif
00168 
00169 /* Define some more compatibility macros to be backward compatible with
00170    BSD systems which did not managed to hide these kernel macros.  */
00171 #ifdef __USE_BSD
00172 # define FAPPEND     O_APPEND
00173 # define FFSYNC             O_FSYNC
00174 # define FASYNC             O_ASYNC
00175 # define FNONBLOCK   O_NONBLOCK
00176 # define FNDELAY     O_NDELAY
00177 #endif /* Use BSD.  */
00178 
00179 /* Advise to `posix_fadvise'.  */
00180 #ifdef __USE_XOPEN2K
00181 # define POSIX_FADV_NORMAL  0 /* No further special treatment.  */
00182 # define POSIX_FADV_RANDOM  1 /* Expect random page references.  */
00183 # define POSIX_FADV_SEQUENTIAL     2 /* Expect sequential page references.    */
00184 # define POSIX_FADV_WILLNEED       3 /* Will need these pages.  */
00185 # define POSIX_FADV_DONTNEED       4 /* Don't need these pages.  */
00186 # define POSIX_FADV_NOREUSE 5 /* Data will be accessed once.  */
00187 #endif
00188 
00189 
00190 #ifdef __USE_GNU
00191 /* Flags for SYNC_FILE_RANGE.  */
00192 # define SYNC_FILE_RANGE_WAIT_BEFORE      1 /* Wait upon writeout of all pages
00193                                         in the range before performing the
00194                                         write.  */
00195 # define SYNC_FILE_RANGE_WRITE            2 /* Initiate writeout of all those
00196                                         dirty pages in the range which are
00197                                         not presently under writeback.  */
00198 # define SYNC_FILE_RANGE_WAIT_AFTER       4 /* Wait upon writeout of all pages in
00199                                         the range after performing the
00200                                         write.  */
00201 
00202 /* Flags for SPLICE and VMSPLICE.  */
00203 # define SPLICE_F_MOVE             1      /* Move pages instead of copying.  */
00204 # define SPLICE_F_NONBLOCK  2      /* Don't block on the pipe splicing
00205                                       (but we may still block on the fd
00206                                       we splice from/to).  */
00207 # define SPLICE_F_MORE             4      /* Expect more data.  */
00208 # define SPLICE_F_GIFT             8      /* Pages passed in are a gift.  */
00209 #endif
00210 
00211 __BEGIN_DECLS
00212 
00213 #ifdef __USE_GNU
00214 
00215 /* Provide kernel hint to read ahead.  */
00216 extern ssize_t readahead (int __fd, __off64_t __offset, size_t __count)
00217     __THROW;
00218 
00219 
00220 /* Selective file content synch'ing.  */
00221 extern int sync_file_range (int __fd, __off64_t __from, __off64_t __to,
00222                          unsigned int __flags);
00223 
00224 
00225 /* Splice address range into a pipe.  */
00226 extern ssize_t vmsplice (int __fdout, const struct iovec *__iov,
00227                       size_t __count, unsigned int __flags);
00228 
00229 /* Splice two files together.  */
00230 extern ssize_t splice (int __fdin, __off64_t *__offin, int __fdout,
00231                      __off64_t *__offout, size_t __len,
00232                      unsigned int __flags);
00233 
00234 /* In-kernel implementation of tee for pipe buffers.  */
00235 extern ssize_t tee (int __fdin, int __fdout, size_t __len,
00236                   unsigned int __flags);
00237 
00238 #endif
00239 
00240 __END_DECLS