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