1/*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22/*
23 * Copyright (c) 1989, 2010, Oracle and/or its affiliates. All rights reserved.
24 */
25
26/*	Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T	*/
27/*	  All Rights Reserved	*/
28
29/*
30 * University Copyright- Copyright (c) 1982, 1986, 1988
31 * The Regents of the University of California
32 * All Rights Reserved
33 *
34 * University Acknowledgment- Portions of this document are derived from
35 * software developed by the University of California, Berkeley, and its
36 * contributors.
37 */
38
39/* Copyright (c) 2013, OmniTI Computer Consulting, Inc. All rights reserved. */
40/* Copyright 2015, Joyent, Inc. */
41
42#ifndef	_SYS_FCNTL_H
43#define	_SYS_FCNTL_H
44
45#include <sys/feature_tests.h>
46
47#include <sys/types.h>
48
49#ifdef	__cplusplus
50extern "C" {
51#endif
52
53/*
54 * Flag values accessible to open(2) and fcntl(2)
55 * The first five can only be set (exclusively) by open(2).
56 */
57#define	O_RDONLY	0
58#define	O_WRONLY	1
59#define	O_RDWR		2
60#define	O_SEARCH	0x200000
61#define	O_EXEC		0x400000
62#if defined(__EXTENSIONS__) || !defined(_POSIX_C_SOURCE)
63#define	O_NDELAY	0x04	/* non-blocking I/O */
64#endif /* defined(__EXTENSIONS__) || !defined(_POSIX_C_SOURCE) */
65#define	O_APPEND	0x08	/* append (writes guaranteed at the end) */
66#if defined(__EXTENSIONS__) || !defined(_POSIX_C_SOURCE) || \
67	(_POSIX_C_SOURCE > 2) || defined(_XOPEN_SOURCE)
68#define	O_SYNC		0x10	/* synchronized file update option */
69#define	O_DSYNC		0x40	/* synchronized data update option */
70#define	O_RSYNC		0x8000	/* synchronized file update option */
71				/* defines read/write file integrity */
72#endif /* defined(__EXTENSIONS__) || !defined(_POSIX_C_SOURCE) ... */
73#define	O_NONBLOCK	0x80	/* non-blocking I/O (POSIX) */
74#ifdef	_LARGEFILE_SOURCE
75#define	O_LARGEFILE	0x2000
76#endif
77
78/*
79 * Flag values accessible only to open(2).
80 */
81#define	O_CREAT		0x100	/* open with file create (uses third arg) */
82#define	O_TRUNC		0x200	/* open with truncation */
83#define	O_EXCL		0x400	/* exclusive open */
84#define	O_NOCTTY	0x800	/* don't allocate controlling tty (POSIX) */
85#define	O_XATTR		0x4000	/* extended attribute */
86#define	O_NOFOLLOW	0x20000	/* don't follow symlinks */
87#define	O_NOLINKS	0x40000	/* don't allow multiple hard links */
88#define	O_CLOEXEC	0x800000	/* set the close-on-exec flag */
89#if !defined(_STRICT_SYMBOLS) || defined(_XPG7)
90#define	O_DIRECTORY	0x1000000	/* fail if not a directory */
91#endif
92
93/*
94 * fcntl(2) requests
95 *
96 * N.B.: values are not necessarily assigned sequentially below.
97 */
98#define	F_DUPFD		0	/* Duplicate fildes */
99#define	F_GETFD		1	/* Get fildes flags */
100#define	F_SETFD		2	/* Set fildes flags */
101#define	F_GETFL		3	/* Get file flags */
102#define	F_GETXFL	45	/* Get file flags including open-only flags */
103#define	F_SETFL		4	/* Set file flags */
104
105/*
106 * Applications that read /dev/mem must be built like the kernel.  A
107 * new symbol "_KMEMUSER" is defined for this purpose.
108 */
109#if defined(_KERNEL) || defined(_KMEMUSER)
110#define	F_O_GETLK	5	/* SVR3 Get file lock (need for rfs, across */
111				/* the wire compatibility */
112/* clustering: lock id contains both per-node sysid and node id */
113#define	SYSIDMASK		0x0000ffff
114#define	GETSYSID(id)		(id & SYSIDMASK)
115#define	NODEIDMASK		0xffff0000
116#define	BITS_IN_SYSID		16
117#define	GETNLMID(sysid)		((int)(((uint_t)(sysid) & NODEIDMASK) >> \
118				    BITS_IN_SYSID))
119
120/* Clustering: Macro used for PXFS locks */
121#define	GETPXFSID(sysid)	((int)(((uint_t)(sysid) & NODEIDMASK) >> \
122				    BITS_IN_SYSID))
123#endif	/* defined(_KERNEL) */
124
125#define	F_CHKFL		8	/* Unused */
126#define	F_DUP2FD	9	/* Duplicate fildes at third arg */
127#define	F_DUP2FD_CLOEXEC	36	/* Like F_DUP2FD with O_CLOEXEC set */
128					/* EINVAL is fildes matches arg1 */
129#define	F_DUPFD_CLOEXEC	37	/* Like F_DUPFD with O_CLOEXEC set */
130
131#define	F_ISSTREAM	13	/* Is the file desc. a stream ? */
132#define	F_PRIV		15	/* Turn on private access to file */
133#define	F_NPRIV		16	/* Turn off private access to file */
134#define	F_QUOTACTL	17	/* UFS quota call */
135#define	F_BLOCKS	18	/* Get number of BLKSIZE blocks allocated */
136#define	F_BLKSIZE	19	/* Get optimal I/O block size */
137/*
138 * Numbers 20-22 have been removed and should not be reused.
139 */
140#define	F_GETOWN	23	/* Get owner (socket emulation) */
141#define	F_SETOWN	24	/* Set owner (socket emulation) */
142#define	F_REVOKE	25	/* Object reuse revoke access to file desc. */
143
144#define	F_HASREMOTELOCKS 26	/* Does vp have NFS locks; private to lock */
145				/* manager */
146
147/*
148 * Commands that refer to flock structures.  The argument types differ between
149 * the large and small file environments; therefore, the #defined values must
150 * as well.
151 * The NBMAND forms are private and should not be used.
152 * The FLOCK forms are also private and should not be used.
153 */
154
155#if defined(_LP64) || _FILE_OFFSET_BITS == 32
156/* "Native" application compilation environment */
157#define	F_SETLK		6	/* Set file lock */
158#define	F_SETLKW	7	/* Set file lock and wait */
159#define	F_ALLOCSP	10	/* Allocate file space */
160#define	F_FREESP	11	/* Free file space */
161#define	F_GETLK		14	/* Get file lock */
162#define	F_SETLK_NBMAND	42	/* private */
163#if !defined(_STRICT_SYMBOLS)
164#define	F_OFD_GETLK	47	/* Get file lock owned by file */
165#define	F_OFD_SETLK	48	/* Set file lock owned by file */
166#define	F_OFD_SETLKW	49	/* Set file lock owned by file and wait */
167#define	F_FLOCK		53	/* private - set flock owned by file */
168#define	F_FLOCKW	54	/* private - set flock owned by file and wait */
169#endif	/* _STRICT_SYMBOLS */
170#else
171/* ILP32 large file application compilation environment version */
172#define	F_SETLK		34	/* Set file lock */
173#define	F_SETLKW	35	/* Set file lock and wait */
174#define	F_ALLOCSP	28	/* Alllocate file space */
175#define	F_FREESP	27	/* Free file space */
176#define	F_GETLK		33	/* Get file lock */
177#define	F_SETLK_NBMAND	44	/* private */
178#if !defined(_STRICT_SYMBOLS)
179#define	F_OFD_GETLK	50	/* Get file lock owned by file */
180#define	F_OFD_SETLK	51	/* Set file lock owned by file */
181#define	F_OFD_SETLKW	52	/* Set file lock owned by file and wait */
182#define	F_FLOCK		55	/* private - set flock owned by file */
183#define	F_FLOCKW	56	/* private - set flock owned by file and wait */
184#endif	/* _STRICT_SYMBOLS */
185#endif /* _LP64 || _FILE_OFFSET_BITS == 32 */
186
187#if	defined(_LARGEFILE64_SOURCE)
188
189#if !defined(_LP64) || defined(_KERNEL)
190/*
191 * transitional large file interface version
192 * These are only valid in a 32 bit application compiled with large files
193 * option, for source compatibility, the 64-bit versions are mapped back
194 * to the native versions.
195 */
196#define	F_SETLK64	34	/* Set file lock */
197#define	F_SETLKW64	35	/* Set file lock and wait */
198#define	F_ALLOCSP64	28	/* Allocate file space */
199#define	F_FREESP64	27	/* Free file space */
200#define	F_GETLK64	33	/* Get file lock */
201#define	F_SETLK64_NBMAND	44	/* private */
202#if !defined(_STRICT_SYMBOLS)
203#define	F_OFD_GETLK64	50	/* Get file lock owned by file */
204#define	F_OFD_SETLK64	51	/* Set file lock owned by file */
205#define	F_OFD_SETLKW64	52	/* Set file lock owned by file and wait */
206#define	F_FLOCK64	55	/* private - set flock owned by file */
207#define	F_FLOCKW64	56	/* private - set flock owned by file and wait */
208#endif	/* _STRICT_SYMBOLS */
209#else
210#define	F_SETLK64	6	/* Set file lock */
211#define	F_SETLKW64	7	/* Set file lock and wait */
212#define	F_ALLOCSP64	10	/* Allocate file space */
213#define	F_FREESP64	11	/* Free file space */
214#define	F_GETLK64	14	/* Get file lock */
215#define	F_SETLK64_NBMAND	42	/* private */
216#if !defined(_STRICT_SYMBOLS)
217#define	F_OFD_GETLK64	47	/* Get file lock owned by file */
218#define	F_OFD_SETLK64	48	/* Set file lock owned by file */
219#define	F_OFD_SETLKW64	49	/* Set file lock owned by file and wait */
220#define	F_FLOCK64	53	/* private - set flock owned by file */
221#define	F_FLOCKW64	54	/* private - set flock owned by file and wait */
222#endif /* _STRICT_SYMBOLS */
223#endif /* !_LP64 || _KERNEL */
224
225#endif /* _LARGEFILE64_SOURCE */
226
227#define	F_SHARE		40	/* Set a file share reservation */
228#define	F_UNSHARE	41	/* Remove a file share reservation */
229#define	F_SHARE_NBMAND	43	/* private */
230
231#define	F_BADFD		46	/* Create Poison FD */
232
233/*
234 * File segment locking set data type - information passed to system by user.
235 */
236
237/* regular version, for both small and large file compilation environment */
238typedef struct flock {
239	short	l_type;
240	short	l_whence;
241	off_t	l_start;
242	off_t	l_len;		/* len == 0 means until end of file */
243	int	l_sysid;
244	pid_t	l_pid;
245	long	l_pad[4];		/* reserve area */
246} flock_t;
247
248#if defined(_SYSCALL32)
249
250/* Kernel's view of ILP32 flock structure */
251
252typedef struct flock32 {
253	int16_t	l_type;
254	int16_t	l_whence;
255	off32_t	l_start;
256	off32_t	l_len;		/* len == 0 means until end of file */
257	int32_t	l_sysid;
258	pid32_t	l_pid;
259	int32_t	l_pad[4];		/* reserve area */
260} flock32_t;
261
262#endif /* _SYSCALL32 */
263
264/* transitional large file interface version */
265
266#if	defined(_LARGEFILE64_SOURCE)
267
268typedef struct flock64 {
269	short	l_type;
270	short	l_whence;
271	off64_t	l_start;
272	off64_t	l_len;		/* len == 0 means until end of file */
273	int	l_sysid;
274	pid_t	l_pid;
275	long	l_pad[4];		/* reserve area */
276} flock64_t;
277
278#if defined(_SYSCALL32)
279
280/* Kernel's view of ILP32 flock64 */
281
282#if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
283#pragma	pack(4)
284#endif
285
286typedef struct flock64_32 {
287	int16_t	l_type;
288	int16_t	l_whence;
289	off64_t	l_start;
290	off64_t	l_len;		/* len == 0 means until end of file */
291	int32_t	l_sysid;
292	pid32_t	l_pid;
293	int32_t	l_pad[4];		/* reserve area */
294} flock64_32_t;
295
296#if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
297#pragma pack()
298#endif
299
300/* Kernel's view of LP64 flock64 */
301
302typedef struct flock64_64 {
303	int16_t	l_type;
304	int16_t	l_whence;
305	off64_t	l_start;
306	off64_t	l_len;		/* len == 0 means until end of file */
307	int32_t	l_sysid;
308	pid32_t	l_pid;
309	int64_t	l_pad[4];		/* reserve area */
310} flock64_64_t;
311
312#endif	/* _SYSCALL32 */
313
314#endif /* _LARGEFILE64_SOURCE */
315
316#if defined(_KERNEL) || defined(_KMEMUSER)
317/* SVr3 flock type; needed for rfs across the wire compatibility */
318typedef struct o_flock {
319	int16_t	l_type;
320	int16_t	l_whence;
321	int32_t	l_start;
322	int32_t	l_len;		/* len == 0 means until end of file */
323	int16_t	l_sysid;
324	int16_t	l_pid;
325} o_flock_t;
326#endif	/* defined(_KERNEL) */
327
328/*
329 * File segment locking types.
330 */
331#define	F_RDLCK		01	/* Read lock */
332#define	F_WRLCK		02	/* Write lock */
333#define	F_UNLCK		03	/* Remove lock(s) */
334#define	F_UNLKSYS	04	/* remove remote locks for a given system */
335
336/*
337 * POSIX constants
338 */
339
340/* Mask for file access modes */
341#define	O_ACCMODE	(O_SEARCH | O_EXEC | 0x3)
342#define	FD_CLOEXEC	1	/* close on exec flag */
343
344/*
345 * DIRECTIO
346 */
347#if defined(__EXTENSIONS__) || !defined(__XOPEN_OR_POSIX)
348#define	DIRECTIO_OFF	(0)
349#define	DIRECTIO_ON	(1)
350
351/*
352 * File share reservation type
353 */
354typedef struct fshare {
355	short	f_access;
356	short	f_deny;
357	int	f_id;
358} fshare_t;
359
360/*
361 * f_access values
362 */
363#define	F_RDACC		0x1	/* Read-only share access */
364#define	F_WRACC		0x2	/* Write-only share access */
365#define	F_RWACC		0x3	/* Read-Write share access */
366#define	F_RMACC		0x4	/* private flag: Delete share access */
367#define	F_MDACC		0x20	/* private flag: Metadata share access */
368
369/*
370 * f_deny values
371 */
372#define	F_NODNY		0x0	/* Don't deny others access */
373#define	F_RDDNY		0x1	/* Deny others read share access */
374#define	F_WRDNY		0x2	/* Deny others write share access */
375#define	F_RWDNY		0x3	/* Deny others read or write share access */
376#define	F_RMDNY		0x4	/* private flag: Deny delete share access */
377#define	F_COMPAT	0x8	/* Set share to old DOS compatibility mode */
378#define	F_MANDDNY	0x10	/* private flag: mandatory enforcement */
379#endif /* defined(__EXTENSIONS__) || !defined(__XOPEN_OR_POSIX) */
380
381/*
382 * Special flags for functions such as openat(), fstatat()....
383 */
384#if !defined(__XOPEN_OR_POSIX) || defined(_ATFILE_SOURCE) || \
385	defined(__EXTENSIONS__)
386	/* || defined(_XPG7) */
387#define	AT_FDCWD			0xffd19553
388#define	AT_SYMLINK_NOFOLLOW		0x1000
389#define	AT_SYMLINK_FOLLOW		0x2000	/* only for linkat() */
390#define	AT_REMOVEDIR			0x1
391#define	_AT_TRIGGER			0x2
392#define	AT_EACCESS			0x4	/* use EUID/EGID for access */
393#endif
394
395#if !defined(__XOPEN_OR_POSIX) || defined(_XPG6) || defined(__EXTENSIONS__)
396/* advice for posix_fadvise */
397#define	POSIX_FADV_NORMAL	0
398#define	POSIX_FADV_RANDOM	1
399#define	POSIX_FADV_SEQUENTIAL	2
400#define	POSIX_FADV_WILLNEED	3
401#define	POSIX_FADV_DONTNEED	4
402#define	POSIX_FADV_NOREUSE	5
403#endif
404
405#ifdef	__cplusplus
406}
407#endif
408
409#endif	/* _SYS_FCNTL_H */
410