1199767fToomas Soome/*-
2199767fToomas Soome * Copyright (c) 1983, 1990, 1993
3199767fToomas Soome *	The Regents of the University of California.  All rights reserved.
4199767fToomas Soome * (c) UNIX System Laboratories, Inc.
5199767fToomas Soome * All or some portions of this file are derived from material licensed
6199767fToomas Soome * to the University of California by American Telephone and Telegraph
7199767fToomas Soome * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8199767fToomas Soome * the permission of UNIX System Laboratories, Inc.
9199767fToomas Soome *
10199767fToomas Soome * Redistribution and use in source and binary forms, with or without
11199767fToomas Soome * modification, are permitted provided that the following conditions
12199767fToomas Soome * are met:
13199767fToomas Soome * 1. Redistributions of source code must retain the above copyright
14199767fToomas Soome *    notice, this list of conditions and the following disclaimer.
15199767fToomas Soome * 2. Redistributions in binary form must reproduce the above copyright
16199767fToomas Soome *    notice, this list of conditions and the following disclaimer in the
17199767fToomas Soome *    documentation and/or other materials provided with the distribution.
18199767fToomas Soome * 4. Neither the name of the University nor the names of its contributors
19199767fToomas Soome *    may be used to endorse or promote products derived from this software
20199767fToomas Soome *    without specific prior written permission.
21199767fToomas Soome *
22199767fToomas Soome * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23199767fToomas Soome * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24199767fToomas Soome * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25199767fToomas Soome * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26199767fToomas Soome * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27199767fToomas Soome * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28199767fToomas Soome * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29199767fToomas Soome * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30199767fToomas Soome * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31199767fToomas Soome * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32199767fToomas Soome * SUCH DAMAGE.
33199767fToomas Soome *
34199767fToomas Soome *	@(#)fcntl.h	8.3 (Berkeley) 1/21/94
35199767fToomas Soome * $FreeBSD$
36199767fToomas Soome */
37199767fToomas Soome
38199767fToomas Soome#ifndef _SYS_FCNTL_H_
39199767fToomas Soome#define	_SYS_FCNTL_H_
40199767fToomas Soome
41199767fToomas Soome/*
42199767fToomas Soome * This file includes the definitions for open and fcntl
43199767fToomas Soome * described by POSIX for <fcntl.h>; it also includes
44199767fToomas Soome * related kernel definitions.
45199767fToomas Soome */
46199767fToomas Soome
47199767fToomas Soome#include <sys/cdefs.h>
48199767fToomas Soome#include <sys/_types.h>
49199767fToomas Soome
50199767fToomas Soome#ifndef _MODE_T_DECLARED
51199767fToomas Soometypedef	__mode_t	mode_t;
52199767fToomas Soome#define	_MODE_T_DECLARED
53199767fToomas Soome#endif
54199767fToomas Soome
55199767fToomas Soome#ifndef _OFF_T_DECLARED
56199767fToomas Soometypedef	__off_t		off_t;
57199767fToomas Soome#define	_OFF_T_DECLARED
58199767fToomas Soome#endif
59199767fToomas Soome
60199767fToomas Soome#ifndef _PID_T_DECLARED
61199767fToomas Soometypedef	__pid_t		pid_t;
62199767fToomas Soome#define	_PID_T_DECLARED
63199767fToomas Soome#endif
64199767fToomas Soome
65199767fToomas Soome/*
66199767fToomas Soome * File status flags: these are used by open(2), fcntl(2).
67199767fToomas Soome * They are also used (indirectly) in the kernel file structure f_flags,
68199767fToomas Soome * which is a superset of the open/fcntl flags.  Open flags and f_flags
69199767fToomas Soome * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
70199767fToomas Soome * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
71199767fToomas Soome */
72199767fToomas Soome/* open-only flags */
73199767fToomas Soome#define	O_RDONLY	0x0000		/* open for reading only */
74199767fToomas Soome#define	O_WRONLY	0x0001		/* open for writing only */
75199767fToomas Soome#define	O_RDWR		0x0002		/* open for reading and writing */
76199767fToomas Soome#define	O_ACCMODE	0x0003		/* mask for above modes */
77199767fToomas Soome
78199767fToomas Soome/*
79199767fToomas Soome * Kernel encoding of open mode; separate read and write bits that are
80199767fToomas Soome * independently testable: 1 greater than the above.
81199767fToomas Soome *
82199767fToomas Soome * XXX
83199767fToomas Soome * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH,
84199767fToomas Soome * which was documented to use FREAD/FWRITE, continues to work.
85199767fToomas Soome */
86199767fToomas Soome#if __BSD_VISIBLE
87199767fToomas Soome#define	FREAD		0x0001
88199767fToomas Soome#define	FWRITE		0x0002
89199767fToomas Soome#endif
90199767fToomas Soome#define	O_NONBLOCK	0x0004		/* no delay */
91199767fToomas Soome#define	O_APPEND	0x0008		/* set append mode */
92199767fToomas Soome#if __BSD_VISIBLE
93199767fToomas Soome#define	O_SHLOCK	0x0010		/* open with shared file lock */
94199767fToomas Soome#define	O_EXLOCK	0x0020		/* open with exclusive file lock */
95199767fToomas Soome#define	O_ASYNC		0x0040		/* signal pgrp when data ready */
96199767fToomas Soome#define	O_FSYNC		0x0080		/* synchronous writes */
97199767fToomas Soome#endif
98199767fToomas Soome#define	O_SYNC		0x0080		/* POSIX synonym for O_FSYNC */
99199767fToomas Soome#if __POSIX_VISIBLE >= 200809
100199767fToomas Soome#define	O_NOFOLLOW	0x0100		/* don't follow symlinks */
101199767fToomas Soome#endif
102199767fToomas Soome#define	O_CREAT		0x0200		/* create if nonexistent */
103199767fToomas Soome#define	O_TRUNC		0x0400		/* truncate to zero length */
104199767fToomas Soome#define	O_EXCL		0x0800		/* error if already exists */
105199767fToomas Soome#ifdef _KERNEL
106199767fToomas Soome#define	FHASLOCK	0x4000		/* descriptor holds advisory lock */
107199767fToomas Soome#endif
108199767fToomas Soome
109199767fToomas Soome/* Defined by POSIX 1003.1; BSD default, but must be distinct from O_RDONLY. */
110199767fToomas Soome#define	O_NOCTTY	0x8000		/* don't assign controlling terminal */
111199767fToomas Soome
112199767fToomas Soome#if __BSD_VISIBLE
113199767fToomas Soome/* Attempt to bypass buffer cache */
114199767fToomas Soome#define	O_DIRECT	0x00010000
115199767fToomas Soome#endif
116199767fToomas Soome
117199767fToomas Soome#if __POSIX_VISIBLE >= 200809
118199767fToomas Soome#define	O_DIRECTORY	0x00020000	/* Fail if not directory */
119199767fToomas Soome#define	O_EXEC		0x00040000	/* Open for execute only */
120199767fToomas Soome#endif
121199767fToomas Soome#ifdef	_KERNEL
122199767fToomas Soome#define	FEXEC		O_EXEC
123199767fToomas Soome#endif
124199767fToomas Soome
125199767fToomas Soome#if __POSIX_VISIBLE >= 200809
126199767fToomas Soome/* Defined by POSIX 1003.1-2008; BSD default, but reserve for future use. */
127199767fToomas Soome#define	O_TTY_INIT	0x00080000	/* Restore default termios attributes */
128199767fToomas Soome
129199767fToomas Soome#define	O_CLOEXEC	0x00100000
130199767fToomas Soome#endif
131199767fToomas Soome
132199767fToomas Soome#if __BSD_VISIBLE
133199767fToomas Soome#define	O_VERIFY	0x00200000	/* open only after verification */
134199767fToomas Soome#endif
135199767fToomas Soome
136199767fToomas Soome/*
137199767fToomas Soome * XXX missing O_DSYNC, O_RSYNC.
138199767fToomas Soome */
139199767fToomas Soome
140199767fToomas Soome#ifdef _KERNEL
141199767fToomas Soome
142199767fToomas Soome/* Only for devfs d_close() flags. */
143199767fToomas Soome#define	FLASTCLOSE	O_DIRECTORY
144199767fToomas Soome#define	FREVOKE		O_VERIFY
145199767fToomas Soome/* Only for fo_close() from half-succeeded open */
146199767fToomas Soome#define	FOPENFAILED	O_TTY_INIT
147199767fToomas Soome
148199767fToomas Soome/* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
149199767fToomas Soome#define	FFLAGS(oflags)	((oflags) & O_EXEC ? (oflags) : (oflags) + 1)
150199767fToomas Soome#define	OFLAGS(fflags)	((fflags) & O_EXEC ? (fflags) : (fflags) - 1)
151199767fToomas Soome
152199767fToomas Soome/* bits to save after open */
153199767fToomas Soome#define	FMASK	(FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK|O_DIRECT|FEXEC)
154199767fToomas Soome/* bits settable by fcntl(F_SETFL, ...) */
155199767fToomas Soome#define	FCNTLFLAGS	(FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FRDAHEAD|O_DIRECT)
156199767fToomas Soome
157199767fToomas Soome#if defined(COMPAT_FREEBSD7) || defined(COMPAT_FREEBSD6) || \
158199767fToomas Soome    defined(COMPAT_FREEBSD5) || defined(COMPAT_FREEBSD4)
159199767fToomas Soome/*
160199767fToomas Soome * Set by shm_open(3) in older libc's to get automatic MAP_ASYNC
161199767fToomas Soome * behavior for POSIX shared memory objects (which are otherwise
162199767fToomas Soome * implemented as plain files).
163199767fToomas Soome */
164199767fToomas Soome#define	FPOSIXSHM	O_NOFOLLOW
165199767fToomas Soome#undef FCNTLFLAGS
166199767fToomas Soome#define	FCNTLFLAGS	(FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FPOSIXSHM|FRDAHEAD| \
167199767fToomas Soome			 O_DIRECT)
168199767fToomas Soome#endif
169199767fToomas Soome#endif
170199767fToomas Soome
171199767fToomas Soome/*
172199767fToomas Soome * The O_* flags used to have only F* names, which were used in the kernel
173199767fToomas Soome * and by fcntl.  We retain the F* names for the kernel f_flag field
174199767fToomas Soome * and for backward compatibility for fcntl.  These flags are deprecated.
175199767fToomas Soome */
176199767fToomas Soome#if __BSD_VISIBLE
177199767fToomas Soome#define	FAPPEND		O_APPEND	/* kernel/compat */
178199767fToomas Soome#define	FASYNC		O_ASYNC		/* kernel/compat */
179199767fToomas Soome#define	FFSYNC		O_FSYNC		/* kernel */
180199767fToomas Soome#define	FNONBLOCK	O_NONBLOCK	/* kernel */
181199767fToomas Soome#define	FNDELAY		O_NONBLOCK	/* compat */
182199767fToomas Soome#define	O_NDELAY	O_NONBLOCK	/* compat */
183199767fToomas Soome#endif
184199767fToomas Soome
185199767fToomas Soome/*
186199767fToomas Soome * We are out of bits in f_flag (which is a short).  However,
187199767fToomas Soome * the flag bits not set in FMASK are only meaningful in the
188199767fToomas Soome * initial open syscall.  Those bits can thus be given a
189199767fToomas Soome * different meaning for fcntl(2).
190199767fToomas Soome */
191199767fToomas Soome#if __BSD_VISIBLE
192199767fToomas Soome/* Read ahead */
193199767fToomas Soome#define	FRDAHEAD	O_CREAT
194199767fToomas Soome#endif
195199767fToomas Soome
196199767fToomas Soome#if __POSIX_VISIBLE >= 200809
197199767fToomas Soome/*
198199767fToomas Soome * Magic value that specify the use of the current working directory
199199767fToomas Soome * to determine the target of relative file paths in the openat() and
200199767fToomas Soome * similar syscalls.
201199767fToomas Soome */
202199767fToomas Soome#define	AT_FDCWD		-100
203199767fToomas Soome
204199767fToomas Soome/*
205199767fToomas Soome * Miscellaneous flags for the *at() syscalls.
206199767fToomas Soome */
207199767fToomas Soome#define	AT_EACCESS		0x100	/* Check access using effective user and group ID */
208199767fToomas Soome#define	AT_SYMLINK_NOFOLLOW	0x200   /* Do not follow symbolic links */
209199767fToomas Soome#define	AT_SYMLINK_FOLLOW	0x400	/* Follow symbolic link */
210199767fToomas Soome#define	AT_REMOVEDIR		0x800	/* Remove directory instead of file */
211199767fToomas Soome#endif
212199767fToomas Soome
213199767fToomas Soome/*
214199767fToomas Soome * Constants used for fcntl(2)
215199767fToomas Soome */
216199767fToomas Soome
217199767fToomas Soome/* command values */
218199767fToomas Soome#define	F_DUPFD		0		/* duplicate file descriptor */
219199767fToomas Soome#define	F_GETFD		1		/* get file descriptor flags */
220199767fToomas Soome#define	F_SETFD		2		/* set file descriptor flags */
221199767fToomas Soome#define	F_GETFL		3		/* get file status flags */
222199767fToomas Soome#define	F_SETFL		4		/* set file status flags */
223199767fToomas Soome#if __XSI_VISIBLE || __POSIX_VISIBLE >= 200112
224199767fToomas Soome#define	F_GETOWN	5		/* get SIGIO/SIGURG proc/pgrp */
225199767fToomas Soome#define	F_SETOWN	6		/* set SIGIO/SIGURG proc/pgrp */
226199767fToomas Soome#endif
227199767fToomas Soome#if __BSD_VISIBLE
228199767fToomas Soome#define	F_OGETLK	7		/* get record locking information */
229199767fToomas Soome#define	F_OSETLK	8		/* set record locking information */
230199767fToomas Soome#define	F_OSETLKW	9		/* F_SETLK; wait if blocked */
231199767fToomas Soome#define	F_DUP2FD	10		/* duplicate file descriptor to arg */
232199767fToomas Soome#endif
233199767fToomas Soome#define	F_GETLK		11		/* get record locking information */
234199767fToomas Soome#define	F_SETLK		12		/* set record locking information */
235199767fToomas Soome#define	F_SETLKW	13		/* F_SETLK; wait if blocked */
236199767fToomas Soome#if __BSD_VISIBLE
237199767fToomas Soome#define	F_SETLK_REMOTE	14		/* debugging support for remote locks */
238199767fToomas Soome#define	F_READAHEAD	15		/* read ahead */
239199767fToomas Soome#define	F_RDAHEAD	16		/* Darwin compatible read ahead */
240199767fToomas Soome#endif
241199767fToomas Soome#if __POSIX_VISIBLE >= 200809
242199767fToomas Soome#define	F_DUPFD_CLOEXEC	17		/* Like F_DUPFD, but FD_CLOEXEC is set */
243199767fToomas Soome#endif
244199767fToomas Soome#if __BSD_VISIBLE
245199767fToomas Soome#define	F_DUP2FD_CLOEXEC 18		/* Like F_DUP2FD, but FD_CLOEXEC is set */
246199767fToomas Soome#endif
247199767fToomas Soome
248199767fToomas Soome/* file descriptor flags (F_GETFD, F_SETFD) */
249199767fToomas Soome#define	FD_CLOEXEC	1		/* close-on-exec flag */
250199767fToomas Soome
251199767fToomas Soome/* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
252199767fToomas Soome#define	F_RDLCK		1		/* shared or read lock */
253199767fToomas Soome#define	F_UNLCK		2		/* unlock */
254199767fToomas Soome#define	F_WRLCK		3		/* exclusive or write lock */
255199767fToomas Soome#if __BSD_VISIBLE
256199767fToomas Soome#define	F_UNLCKSYS	4		/* purge locks for a given system ID */
257199767fToomas Soome#define	F_CANCEL	5		/* cancel an async lock request */
258199767fToomas Soome#endif
259199767fToomas Soome#ifdef _KERNEL
260199767fToomas Soome#define	F_WAIT		0x010		/* Wait until lock is granted */
261199767fToomas Soome#define	F_FLOCK		0x020	 	/* Use flock(2) semantics for lock */
262199767fToomas Soome#define	F_POSIX		0x040	 	/* Use POSIX semantics for lock */
263199767fToomas Soome#define	F_REMOTE	0x080		/* Lock owner is remote NFS client */
264199767fToomas Soome#define	F_NOINTR	0x100		/* Ignore signals when waiting */
265199767fToomas Soome#endif
266199767fToomas Soome
267199767fToomas Soome/*
268199767fToomas Soome * Advisory file segment locking data type -
269199767fToomas Soome * information passed to system by user
270199767fToomas Soome */
271199767fToomas Soomestruct flock {
272199767fToomas Soome	off_t	l_start;	/* starting offset */
273199767fToomas Soome	off_t	l_len;		/* len = 0 means until end of file */
274199767fToomas Soome	pid_t	l_pid;		/* lock owner */
275199767fToomas Soome	short	l_type;		/* lock type: read/write, etc. */
276199767fToomas Soome	short	l_whence;	/* type of l_start */
277199767fToomas Soome	int	l_sysid;	/* remote system id or zero for local */
278199767fToomas Soome};
279199767fToomas Soome
280199767fToomas Soome#if __BSD_VISIBLE
281199767fToomas Soome/*
282199767fToomas Soome * Old advisory file segment locking data type,
283199767fToomas Soome * before adding l_sysid.
284199767fToomas Soome */
285199767fToomas Soomestruct __oflock {
286199767fToomas Soome	off_t	l_start;	/* starting offset */
287199767fToomas Soome	off_t	l_len;		/* len = 0 means until end of file */
288199767fToomas Soome	pid_t	l_pid;		/* lock owner */
289199767fToomas Soome	short	l_type;		/* lock type: read/write, etc. */
290199767fToomas Soome	short	l_whence;	/* type of l_start */
291199767fToomas Soome};
292199767fToomas Soome#endif
293199767fToomas Soome
294199767fToomas Soome#if __BSD_VISIBLE
295199767fToomas Soome/* lock operations for flock(2) */
296199767fToomas Soome#define	LOCK_SH		0x01		/* shared file lock */
297199767fToomas Soome#define	LOCK_EX		0x02		/* exclusive file lock */
298199767fToomas Soome#define	LOCK_NB		0x04		/* don't block when locking */
299199767fToomas Soome#define	LOCK_UN		0x08		/* unlock file */
300199767fToomas Soome#endif
301199767fToomas Soome
302199767fToomas Soome#if __POSIX_VISIBLE >= 200112
303199767fToomas Soome/*
304199767fToomas Soome * Advice to posix_fadvise
305199767fToomas Soome */
306199767fToomas Soome#define	POSIX_FADV_NORMAL	0	/* no special treatment */
307199767fToomas Soome#define	POSIX_FADV_RANDOM	1	/* expect random page references */
308199767fToomas Soome#define	POSIX_FADV_SEQUENTIAL	2	/* expect sequential page references */
309199767fToomas Soome#define	POSIX_FADV_WILLNEED	3	/* will need these pages */
310199767fToomas Soome#define	POSIX_FADV_DONTNEED	4	/* dont need these pages */
311199767fToomas Soome#define	POSIX_FADV_NOREUSE	5	/* access data only once */
312199767fToomas Soome#endif
313199767fToomas Soome
314199767fToomas Soome#ifndef _KERNEL
315199767fToomas Soome__BEGIN_DECLS
316199767fToomas Soomeint	open(const char *, int, ...);
317199767fToomas Soomeint	creat(const char *, mode_t);
318199767fToomas Soomeint	fcntl(int, int, ...);
319199767fToomas Soome#if __BSD_VISIBLE
320199767fToomas Soomeint	flock(int, int);
321199767fToomas Soome#endif
322199767fToomas Soome#if __POSIX_VISIBLE >= 200809
323199767fToomas Soomeint	openat(int, const char *, int, ...);
324199767fToomas Soome#endif
325199767fToomas Soome#if __POSIX_VISIBLE >= 200112
326199767fToomas Soomeint	posix_fadvise(int, off_t, off_t, int);
327199767fToomas Soomeint	posix_fallocate(int, off_t, off_t);
328199767fToomas Soome#endif
329199767fToomas Soome__END_DECLS
330199767fToomas Soome#endif
331199767fToomas Soome
332199767fToomas Soome#endif /* !_SYS_FCNTL_H_ */
333