Back to index

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