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