xref: /illumos-gate/usr/src/boot/sys/sys/fcntl.h (revision 55fea89d)
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  * 4. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)fcntl.h	8.3 (Berkeley) 1/21/94
35  * $FreeBSD$
36  */
37 
38 #ifndef _SYS_FCNTL_H_
39 #define	_SYS_FCNTL_H_
40 
41 /*
42  * This file includes the definitions for open and fcntl
43  * described by POSIX for <fcntl.h>; it also includes
44  * related kernel definitions.
45  */
46 
47 #include <sys/cdefs.h>
48 #include <sys/_types.h>
49 
50 #ifndef _MODE_T_DECLARED
51 typedef	__mode_t	mode_t;
52 #define	_MODE_T_DECLARED
53 #endif
54 
55 #ifndef _OFF_T_DECLARED
56 typedef	__off_t		off_t;
57 #define	_OFF_T_DECLARED
58 #endif
59 
60 #ifndef _PID_T_DECLARED
61 typedef	__pid_t		pid_t;
62 #define	_PID_T_DECLARED
63 #endif
64 
65 /*
66  * File status flags: these are used by open(2), fcntl(2).
67  * They are also used (indirectly) in the kernel file structure f_flags,
68  * which is a superset of the open/fcntl flags.  Open flags and f_flags
69  * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
70  * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
71  */
72 /* open-only flags */
73 #define	O_RDONLY	0x0000		/* open for reading only */
74 #define	O_WRONLY	0x0001		/* open for writing only */
75 #define	O_RDWR		0x0002		/* open for reading and writing */
76 #define	O_ACCMODE	0x0003		/* mask for above modes */
77 
78 /*
79  * Kernel encoding of open mode; separate read and write bits that are
80  * independently testable: 1 greater than the above.
81  *
82  * XXX
83  * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH,
84  * which was documented to use FREAD/FWRITE, continues to work.
85  */
86 #if __BSD_VISIBLE
87 #define	FREAD		0x0001
88 #define	FWRITE		0x0002
89 #endif
90 #define	O_NONBLOCK	0x0004		/* no delay */
91 #define	O_APPEND	0x0008		/* set append mode */
92 #if __BSD_VISIBLE
93 #define	O_SHLOCK	0x0010		/* open with shared file lock */
94 #define	O_EXLOCK	0x0020		/* open with exclusive file lock */
95 #define	O_ASYNC		0x0040		/* signal pgrp when data ready */
96 #define	O_FSYNC		0x0080		/* synchronous writes */
97 #endif
98 #define	O_SYNC		0x0080		/* POSIX synonym for O_FSYNC */
99 #if __POSIX_VISIBLE >= 200809
100 #define	O_NOFOLLOW	0x0100		/* don't follow symlinks */
101 #endif
102 #define	O_CREAT		0x0200		/* create if nonexistent */
103 #define	O_TRUNC		0x0400		/* truncate to zero length */
104 #define	O_EXCL		0x0800		/* error if already exists */
105 #ifdef _KERNEL
106 #define	FHASLOCK	0x4000		/* descriptor holds advisory lock */
107 #endif
108 
109 /* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */
110 #define	O_NOCTTY	0x8000		/* don't assign controlling terminal */
111 
112 #if __BSD_VISIBLE
113 /* Attempt to bypass buffer cache */
114 #define	O_DIRECT	0x00010000
115 #endif
116 
117 #if __POSIX_VISIBLE >= 200809
118 #define	O_DIRECTORY	0x00020000	/* Fail if not directory */
119 #define	O_EXEC		0x00040000	/* Open for execute only */
120 #endif
121 #ifdef	_KERNEL
122 #define	FEXEC		O_EXEC
123 #endif
124 
125 #if __POSIX_VISIBLE >= 200809
126 /* Defined by POSIX 1003.1-2008; BSD default, but reserve for future use. */
127 #define	O_TTY_INIT	0x00080000	/* Restore default termios attributes */
128 
129 #define	O_CLOEXEC	0x00100000
130 #endif
131 
132 #if __BSD_VISIBLE
133 #define	O_VERIFY	0x00200000	/* open only after verification */
134 #endif
135 
136 /*
137  * XXX missing O_DSYNC, O_RSYNC.
138  */
139 
140 #ifdef _KERNEL
141 
142 /* Only for devfs d_close() flags. */
143 #define	FLASTCLOSE	O_DIRECTORY
144 #define	FREVOKE		O_VERIFY
145 /* Only for fo_close() from half-succeeded open */
146 #define	FOPENFAILED	O_TTY_INIT
147 
148 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
149 #define	FFLAGS(oflags)	((oflags) & O_EXEC ? (oflags) : (oflags) + 1)
150 #define	OFLAGS(fflags)	((fflags) & O_EXEC ? (fflags) : (fflags) - 1)
151 
152 /* bits to save after open */
153 #define	FMASK	(FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|O_DIRECT|FEXEC)
154 /* bits settable by fcntl(F_SETFL, ...) */
155 #define	FCNTLFLAGS	(FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FRDAHEAD|O_DIRECT)
156 
157 #if defined(COMPAT_FREEBSD7) || defined(COMPAT_FREEBSD6) || \
158     defined(COMPAT_FREEBSD5) || defined(COMPAT_FREEBSD4)
159 /*
160  * Set by shm_open(3) in older libc's to get automatic MAP_ASYNC
161  * behavior for POSIX shared memory objects (which are otherwise
162  * implemented as plain files).
163  */
164 #define	FPOSIXSHM	O_NOFOLLOW
165 #undef FCNTLFLAGS
166 #define	FCNTLFLAGS	(FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|FRDAHEAD| \
167 			 O_DIRECT)
168 #endif
169 #endif
170 
171 /*
172  * The O_* flags used to have only F* names, which were used in the kernel
173  * and by fcntl.  We retain the F* names for the kernel f_flag field
174  * and for backward compatibility for fcntl.  These flags are deprecated.
175  */
176 #if __BSD_VISIBLE
177 #define	FAPPEND		O_APPEND	/* kernel/compat */
178 #define	FASYNC		O_ASYNC		/* kernel/compat */
179 #define	FFSYNC		O_FSYNC		/* kernel */
180 #define	FNONBLOCK	O_NONBLOCK	/* kernel */
181 #define	FNDELAY		O_NONBLOCK	/* compat */
182 #define	O_NDELAY	O_NONBLOCK	/* compat */
183 #endif
184 
185 /*
186  * We are out of bits in f_flag (which is a short).  However,
187  * the flag bits not set in FMASK are only meaningful in the
188  * initial open syscall.  Those bits can thus be given a
189  * different meaning for fcntl(2).
190  */
191 #if __BSD_VISIBLE
192 /* Read ahead */
193 #define	FRDAHEAD	O_CREAT
194 #endif
195 
196 #if __POSIX_VISIBLE >= 200809
197 /*
198  * Magic value that specify the use of the current working directory
199  * to determine the target of relative file paths in the openat() and
200  * similar syscalls.
201  */
202 #define	AT_FDCWD		-100
203 
204 /*
205  * Miscellaneous flags for the *at() syscalls.
206  */
207 #define	AT_EACCESS		0x100	/* Check access using effective user and group ID */
208 #define	AT_SYMLINK_NOFOLLOW	0x200   /* Do not follow symbolic links */
209 #define	AT_SYMLINK_FOLLOW	0x400	/* Follow symbolic link */
210 #define	AT_REMOVEDIR		0x800	/* Remove directory instead of file */
211 #endif
212 
213 /*
214  * Constants used for fcntl(2)
215  */
216 
217 /* command values */
218 #define	F_DUPFD		0		/* duplicate file descriptor */
219 #define	F_GETFD		1		/* get file descriptor flags */
220 #define	F_SETFD		2		/* set file descriptor flags */
221 #define	F_GETFL		3		/* get file status flags */
222 #define	F_SETFL		4		/* set file status flags */
223 #if __XSI_VISIBLE || __POSIX_VISIBLE >= 200112
224 #define	F_GETOWN	5		/* get SIGIO/SIGURG proc/pgrp */
225 #define	F_SETOWN	6		/* set SIGIO/SIGURG proc/pgrp */
226 #endif
227 #if __BSD_VISIBLE
228 #define	F_OGETLK	7		/* get record locking information */
229 #define	F_OSETLK	8		/* set record locking information */
230 #define	F_OSETLKW	9		/* F_SETLK; wait if blocked */
231 #define	F_DUP2FD	10		/* duplicate file descriptor to arg */
232 #endif
233 #define	F_GETLK		11		/* get record locking information */
234 #define	F_SETLK		12		/* set record locking information */
235 #define	F_SETLKW	13		/* F_SETLK; wait if blocked */
236 #if __BSD_VISIBLE
237 #define	F_SETLK_REMOTE	14		/* debugging support for remote locks */
238 #define	F_READAHEAD	15		/* read ahead */
239 #define	F_RDAHEAD	16		/* Darwin compatible read ahead */
240 #endif
241 #if __POSIX_VISIBLE >= 200809
242 #define	F_DUPFD_CLOEXEC	17		/* Like F_DUPFD, but FD_CLOEXEC is set */
243 #endif
244 #if __BSD_VISIBLE
245 #define	F_DUP2FD_CLOEXEC 18		/* Like F_DUP2FD, but FD_CLOEXEC is set */
246 #endif
247 
248 /* file descriptor flags (F_GETFD, F_SETFD) */
249 #define	FD_CLOEXEC	1		/* close-on-exec flag */
250 
251 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
252 #define	F_RDLCK		1		/* shared or read lock */
253 #define	F_UNLCK		2		/* unlock */
254 #define	F_WRLCK		3		/* exclusive or write lock */
255 #if __BSD_VISIBLE
256 #define	F_UNLCKSYS	4		/* purge locks for a given system ID */
257 #define	F_CANCEL	5		/* cancel an async lock request */
258 #endif
259 #ifdef _KERNEL
260 #define	F_WAIT		0x010		/* Wait until lock is granted */
261 #define	F_FLOCK		0x020	 	/* Use flock(2) semantics for lock */
262 #define	F_POSIX		0x040	 	/* Use POSIX semantics for lock */
263 #define	F_REMOTE	0x080		/* Lock owner is remote NFS client */
264 #define	F_NOINTR	0x100		/* Ignore signals when waiting */
265 #endif
266 
267 /*
268  * Advisory file segment locking data type -
269  * information passed to system by user
270  */
271 struct flock {
272 	off_t	l_start;	/* starting offset */
273 	off_t	l_len;		/* len = 0 means until end of file */
274 	pid_t	l_pid;		/* lock owner */
275 	short	l_type;		/* lock type: read/write, etc. */
276 	short	l_whence;	/* type of l_start */
277 	int	l_sysid;	/* remote system id or zero for local */
278 };
279 
280 #if __BSD_VISIBLE
281 /*
282  * Old advisory file segment locking data type,
283  * before adding l_sysid.
284  */
285 struct __oflock {
286 	off_t	l_start;	/* starting offset */
287 	off_t	l_len;		/* len = 0 means until end of file */
288 	pid_t	l_pid;		/* lock owner */
289 	short	l_type;		/* lock type: read/write, etc. */
290 	short	l_whence;	/* type of l_start */
291 };
292 #endif
293 
294 #if __BSD_VISIBLE
295 /* lock operations for flock(2) */
296 #define	LOCK_SH		0x01		/* shared file lock */
297 #define	LOCK_EX		0x02		/* exclusive file lock */
298 #define	LOCK_NB		0x04		/* don't block when locking */
299 #define	LOCK_UN		0x08		/* unlock file */
300 #endif
301 
302 #if __POSIX_VISIBLE >= 200112
303 /*
304  * Advice to posix_fadvise
305  */
306 #define	POSIX_FADV_NORMAL	0	/* no special treatment */
307 #define	POSIX_FADV_RANDOM	1	/* expect random page references */
308 #define	POSIX_FADV_SEQUENTIAL	2	/* expect sequential page references */
309 #define	POSIX_FADV_WILLNEED	3	/* will need these pages */
310 #define	POSIX_FADV_DONTNEED	4	/* dont need these pages */
311 #define	POSIX_FADV_NOREUSE	5	/* access data only once */
312 #endif
313 
314 #ifndef _KERNEL
315 __BEGIN_DECLS
316 int	open(const char *, int, ...);
317 int	creat(const char *, mode_t);
318 int	fcntl(int, int, ...);
319 #if __BSD_VISIBLE
320 int	flock(int, int);
321 #endif
322 #if __POSIX_VISIBLE >= 200809
323 int	openat(int, const char *, int, ...);
324 #endif
325 #if __POSIX_VISIBLE >= 200112
326 int	posix_fadvise(int, off_t, off_t, int);
327 int	posix_fallocate(int, off_t, off_t);
328 #endif
329 __END_DECLS
330 #endif
331 
332 #endif /* !_SYS_FCNTL_H_ */
333