58c0f85af6f3b9897e47539bf998cc0a4b1ee7db
[dragonfly.git] / sys / sys / fcntl.h
1 /*-
2  * Copyright (c) 1983, 1990, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by the University of
21  *      California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *      @(#)fcntl.h     8.3 (Berkeley) 1/21/94
39  * $FreeBSD: src/sys/sys/fcntl.h,v 1.9.2.2 2001/06/03 05:00:10 dillon Exp $
40  */
41
42 #ifndef _SYS_FCNTL_H_
43 #define _SYS_FCNTL_H_
44
45 #ifndef _SYS_TYPES_H_
46 #include <sys/types.h>
47 #endif
48
49 /*
50  * File status flags: these are used by open(2), fcntl(2).
51  * They are also used (indirectly) in the kernel file structure f_flags,
52  * which is a superset of the open/fcntl flags.  Open flags and f_flags
53  * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
54  * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
55  */
56 /* open-only flags */
57 #define O_RDONLY        0x0000          /* open for reading only */
58 #define O_WRONLY        0x0001          /* open for writing only */
59 #define O_RDWR          0x0002          /* open for reading and writing */
60 #define O_ACCMODE       0x0003          /* mask for above modes */
61
62 /*
63  * Kernel encoding of open mode; separate read and write bits that are
64  * independently testable: 1 greater than the above.
65  *
66  * XXX
67  * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH,
68  * which was documented to use FREAD/FWRITE, continues to work.
69  */
70 #ifndef _POSIX_SOURCE
71 #define FREAD           0x0001
72 #define FWRITE          0x0002
73 #endif
74 #define O_NONBLOCK      0x0004          /* no delay */
75 #define O_APPEND        0x0008          /* set append mode */
76 #ifndef _POSIX_SOURCE
77 #define O_SHLOCK        0x0010          /* open with shared file lock */
78 #define O_EXLOCK        0x0020          /* open with exclusive file lock */
79 #define O_ASYNC         0x0040          /* signal pgrp when data ready */
80 #define O_FSYNC         0x0080          /* synchronous writes */
81 #define O_NOFOLLOW      0x0100          /* don't follow symlinks */
82 #endif
83 #define O_SYNC          0x0080          /* Same as O_FSYNC, but POSIX */
84 #define O_CREAT         0x0200          /* create if nonexistent */
85 #define O_TRUNC         0x0400          /* truncate to zero length */
86 #define O_EXCL          0x0800          /* error if already exists */
87 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
88 #define FMARK           0x1000          /* mark during gc() */
89 #define FDEFER          0x2000          /* defer for next gc pass */
90 #define FHASLOCK        0x4000          /* descriptor holds advisory lock */
91 #endif
92
93 /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */
94 #define O_NOCTTY        0x8000          /* don't assign controlling terminal */
95
96 /* Attempt to bypass the buffer cache */
97 #define O_DIRECT        0x00010000
98
99 #if __POSIX_VISIBLE >= 200809
100 #define O_CLOEXEC       0x00020000      /* atomically set FD_CLOEXEC */
101 #endif
102 #define O_FBLOCKING     0x00040000      /* force blocking I/O */
103 #define O_FNONBLOCKING  0x00080000      /* force non-blocking I/O */
104 #define O_FAPPEND       0x00100000      /* force append mode for write */
105 #define O_FOFFSET       0x00200000      /* force specific offset */
106 #define O_FSYNCWRITE    0x00400000      /* force synchronous write */
107 #define O_FASYNCWRITE   0x00800000      /* force asynchronous write */
108 #define FCDEVPRIV       0x01000000      /* f_data1 used for cdevpriv */
109 #define O_UNUSED25      0x02000000
110 #define O_MAPONREAD     0x04000000      /* memory map read buffer */
111
112 #if __POSIX_VISIBLE >= 200809
113 #define O_DIRECTORY     0x08000000      /* error if not a directory */
114 #endif
115
116 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
117 #define FREVOKED        0x10000000      /* revoked by fdrevoke() */
118 #define FAPPENDONLY     0x20000000      /* O_APPEND cannot be changed */
119 #define FOFFSETLOCK     0x40000000      /* f_offset locked */
120 #define FOFFSETWAKE     0x80000000      /* f_offset wakeup */
121 #endif
122
123 #define O_FMASK         (O_FBLOCKING|O_FNONBLOCKING|O_FAPPEND|O_FOFFSET|\
124                          O_FSYNCWRITE|O_FASYNCWRITE|O_MAPONREAD)
125
126 #ifdef _KERNEL
127 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
128 #define FFLAGS(oflags)  ((oflags) + 1)
129 #define OFLAGS(fflags)  ((fflags) - 1)
130
131 /* bits to save after open */
132 #define FMASK           (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|\
133                          FAPPENDONLY|FREVOKED|O_DIRECT|O_MAPONREAD)
134 /* bits settable by fcntl(F_SETFL, ...) */
135 #define FCNTLFLAGS      (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|\
136                          O_DIRECT|O_MAPONREAD)
137 #endif
138
139 /*
140  * The O_* flags used to have only F* names, which were used in the kernel
141  * and by fcntl.  We retain the F* names for the kernel f_flag field
142  * and for backward compatibility for fcntl.
143  */
144 #ifndef _POSIX_SOURCE
145 #define FAPPEND         O_APPEND        /* kernel/compat */
146 #define FASYNC          O_ASYNC         /* kernel/compat */
147 #define FFSYNC          O_FSYNC         /* kernel */
148 #define FNONBLOCK       O_NONBLOCK      /* kernel */
149 #define FNDELAY         O_NONBLOCK      /* compat */
150 #define O_NDELAY        O_NONBLOCK      /* compat */
151 #endif
152
153 /*
154  * We are out of bits in f_flag (which is a short).  However,
155  * the flag bits not set in FMASK are only meaningful in the
156  * initial open syscall.  Those bits can thus be given a
157  * different meaning for fcntl(2).
158  */
159 #ifndef _POSIX_SOURCE
160
161 /*
162  * Set by shm_open(3) to get automatic MAP_ASYNC behavior
163  * for POSIX shared memory objects (which are otherwise
164  * implemented as plain files).
165  */
166 #define FPOSIXSHM       O_NOFOLLOW
167 #endif
168
169 /*
170  * Constants used by "at" family of system calls.
171  */
172 #define AT_FDCWD                0xFFFAFDCD      /* invalid file descriptor */
173 #define AT_SYMLINK_NOFOLLOW     1
174 #define AT_REMOVEDIR            2
175 #define AT_EACCESS              4
176 #define AT_SYMLINK_FOLLOW       8
177
178 /*
179  * Constants used for fcntl(2)
180  */
181
182 /* command values */
183 #define F_DUPFD         0               /* duplicate file descriptor */
184 #define F_GETFD         1               /* get file descriptor flags */
185 #define F_SETFD         2               /* set file descriptor flags */
186 #define F_GETFL         3               /* get file status flags */
187 #define F_SETFL         4               /* set file status flags */
188 #ifndef _POSIX_SOURCE
189 #define F_GETOWN        5               /* get SIGIO/SIGURG proc/pgrp */
190 #define F_SETOWN        6               /* set SIGIO/SIGURG proc/pgrp */
191 #endif
192 #define F_GETLK         7               /* get record locking information */
193 #define F_SETLK         8               /* set record locking information */
194 #define F_SETLKW        9               /* F_SETLK; wait if blocked */
195 #define F_DUP2FD        10              /* duplicate file descriptor to arg */
196 #if __POSIX_VISIBLE >= 200809
197 #define F_DUPFD_CLOEXEC 17              /* Like F_DUPFD with FD_CLOEXEC set */
198 #endif
199 #if __BSD_VISIBLE
200 #define F_DUP2FD_CLOEXEC 18             /* Like F_DUP2FD with FD_CLOEXEC set */
201 #endif
202
203 /* file descriptor flags (F_GETFD, F_SETFD) */
204 #define FD_CLOEXEC      1               /* close-on-exec flag */
205
206 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
207 #define F_RDLCK         1               /* shared or read lock */
208 #define F_UNLCK         2               /* unlock */
209 #define F_WRLCK         3               /* exclusive or write lock */
210 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
211 #define F_WAIT          0x010           /* Wait until lock is granted */
212 #define F_UNUSED020     0x020
213 #define F_POSIX         0x040           /* Use POSIX semantics for lock */
214 #define F_NOEND         0x080           /* l_len = 0, internally used */
215 #endif
216
217
218 /*
219  * Advisory file segment locking data type -
220  * information passed to system by user
221  */
222 struct flock {
223         off_t   l_start;        /* starting offset */
224         off_t   l_len;          /* len = 0 means until end of file */
225         pid_t   l_pid;          /* lock owner */
226         short   l_type;         /* lock type: read/write, etc. */
227         short   l_whence;       /* type of l_start */
228 };
229
230 #ifdef _KERNEL
231 union fcntl_dat {
232         int             fc_fd;          /* F_DUPFD */
233         int             fc_cloexec;     /* F_GETFD/F_SETFD */
234         int             fc_flags;       /* F_GETFL/F_SETFL */
235         int             fc_owner;       /* F_GETOWN/F_SETOWN */
236         struct flock    fc_flock;       /* F_GETLK/F_SETLK */
237 };
238 #endif /* _KERNEL */
239
240
241 #ifndef _POSIX_SOURCE
242 /* lock operations for flock(2) */
243 #define LOCK_SH         0x01            /* shared file lock */
244 #define LOCK_EX         0x02            /* exclusive file lock */
245 #define LOCK_NB         0x04            /* don't block when locking */
246 #define LOCK_UN         0x08            /* unlock file */
247 #endif
248
249 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
250 #include <sys/cdefs.h>
251
252 __BEGIN_DECLS
253 int     open (const char *, int, ...);
254 #if __POSIX_VISIBLE >= 200809
255 int     openat (int, const char *, int, ...);
256 #endif
257 int     creat (const char *, mode_t);
258 int     fcntl (int, int, ...);
259 #ifndef _POSIX_SOURCE
260 int     flock (int, int);
261 #endif /* !_POSIX_SOURCE */
262 __END_DECLS
263 #endif
264
265 #endif /* !_SYS_FCNTL_H_ */