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