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
124 #define F_ISSTREAM 13 /* Is the file desc. a stream ? */
125 #define F_PRIV 15 /* Turn on private access to file */
126 #define F_NPRIV 16 /* Turn off private access to file */
127 #define F_QUOTACTL 17 /* UFS quota call */
128 #define F_BLOCKS 18 /* Get number of BLKSIZE blocks allocated */
129 #define F_BLKSIZE 19 /* Get optimal I/O block size */
130 /*
131 * Numbers 20-22 have been removed and should not be reused.
132 */
133 #define F_GETOWN 23 /* Get owner (socket emulation) */
134 #define F_SETOWN 24 /* Set owner (socket emulation) */
135 #define F_REVOKE 25 /* Object reuse revoke access to file desc. */
136
137 #define F_HASREMOTELOCKS 26 /* Does vp have NFS locks; private to lock */
138 /* manager */
139
140 /*
141 * Commands that refer to flock structures. The argument types differ between
142 * the large and small file environments; therefore, the #defined values must
143 * as well.
144 * The NBMAND forms are private and should not be used.
145 */
146
147 #if defined(_LP64) || _FILE_OFFSET_BITS == 32
148 /* "Native" application compilation environment */
149 #define F_SETLK 6 /* Set file lock */
150 #define F_SETLKW 7 /* Set file lock and wait */
151 #define F_ALLOCSP 10 /* Allocate file space */
152 #define F_FREESP 11 /* Free file space */
153 #define F_GETLK 14 /* Get file lock */
154 #define F_SETLK_NBMAND 42 /* private */
155 #else
156 /* ILP32 large file application compilation environment version */
157 #define F_SETLK 34 /* Set file lock */
158 #define F_SETLKW 35 /* Set file lock and wait */
159 #define F_ALLOCSP 28 /* Alllocate file space */
160 #define F_FREESP 27 /* Free file space */
161 #define F_GETLK 33 /* Get file lock */
162 #define F_SETLK_NBMAND 44 /* private */
163 #endif /* _LP64 || _FILE_OFFSET_BITS == 32 */
164
165 #if defined(_LARGEFILE64_SOURCE)
166
167 #if !defined(_LP64) || defined(_KERNEL)
168 /*
169 * transitional large file interface version
170 * These are only valid in a 32 bit application compiled with large files
171 * option, for source compatibility, the 64-bit versions are mapped back
172 * to the native versions.
173 */
174 #define F_SETLK64 34 /* Set file lock */
175 #define F_SETLKW64 35 /* Set file lock and wait */
176 #define F_ALLOCSP64 28 /* Allocate file space */
177 #define F_FREESP64 27 /* Free file space */
178 #define F_GETLK64 33 /* Get file lock */
179 #define F_SETLK64_NBMAND 44 /* private */
180 #else
181 #define F_SETLK64 6 /* Set file lock */
182 #define F_SETLKW64 7 /* Set file lock and wait */
183 #define F_ALLOCSP64 10 /* Allocate file space */
184 #define F_FREESP64 11 /* Free file space */
185 #define F_GETLK64 14 /* Get file lock */
186 #define F_SETLK64_NBMAND 42 /* private */
187 #endif /* !_LP64 || _KERNEL */
188
189 #endif /* _LARGEFILE64_SOURCE */
190
191 #define F_SHARE 40 /* Set a file share reservation */
192 #define F_UNSHARE 41 /* Remove a file share reservation */
193 #define F_SHARE_NBMAND 43 /* private */
194
195 #define F_BADFD 46 /* Create Poison FD */
196
197 /*
198 * File segment locking set data type - information passed to system by user.
199 */
200
201 /* regular version, for both small and large file compilation environment */
202 typedef struct flock {
203 short l_type;
204 short l_whence;
205 off_t l_start;
206 off_t l_len; /* len == 0 means until end of file */
207 int l_sysid;
208 pid_t l_pid;
209 long l_pad[4]; /* reserve area */
210 } flock_t;
211
212 #if defined(_SYSCALL32)
213
214 /* Kernel's view of ILP32 flock structure */
215
216 typedef struct flock32 {
217 int16_t l_type;
218 int16_t l_whence;
219 off32_t l_start;
220 off32_t l_len; /* len == 0 means until end of file */
221 int32_t l_sysid;
222 pid32_t l_pid;
223 int32_t l_pad[4]; /* reserve area */
224 } flock32_t;
225
226 #endif /* _SYSCALL32 */
227
228 /* transitional large file interface version */
229
230 #if defined(_LARGEFILE64_SOURCE)
231
232 typedef struct flock64 {
233 short l_type;
234 short l_whence;
235 off64_t l_start;
236 off64_t l_len; /* len == 0 means until end of file */
237 int l_sysid;
238 pid_t l_pid;
239 long l_pad[4]; /* reserve area */
240 } flock64_t;
241
242 #if defined(_SYSCALL32)
243
244 /* Kernel's view of ILP32 flock64 */
245
246 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
247 #pragma pack(4)
248 #endif
249
250 typedef struct flock64_32 {
251 int16_t l_type;
252 int16_t l_whence;
253 off64_t l_start;
254 off64_t l_len; /* len == 0 means until end of file */
255 int32_t l_sysid;
256 pid32_t l_pid;
257 int32_t l_pad[4]; /* reserve area */
258 } flock64_32_t;
259
260 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
261 #pragma pack()
262 #endif
263
264 /* Kernel's view of LP64 flock64 */
265
266 typedef struct flock64_64 {
267 int16_t l_type;
268 int16_t l_whence;
269 off64_t l_start;
270 off64_t l_len; /* len == 0 means until end of file */
271 int32_t l_sysid;
272 pid32_t l_pid;
273 int64_t l_pad[4]; /* reserve area */
274 } flock64_64_t;
275
276 #endif /* _SYSCALL32 */
277
278 #endif /* _LARGEFILE64_SOURCE */
279
280 #if defined(_KERNEL) || defined(_KMEMUSER)
281 /* SVr3 flock type; needed for rfs across the wire compatibility */
282 typedef struct o_flock {
283 int16_t l_type;
284 int16_t l_whence;
285 int32_t l_start;
286 int32_t l_len; /* len == 0 means until end of file */
287 int16_t l_sysid;
288 int16_t l_pid;
289 } o_flock_t;
290 #endif /* defined(_KERNEL) */
291
292 /*
293 * File segment locking types.
294 */
295 #define F_RDLCK 01 /* Read lock */
296 #define F_WRLCK 02 /* Write lock */
297 #define F_UNLCK 03 /* Remove lock(s) */
298 #define F_UNLKSYS 04 /* remove remote locks for a given system */
299
300 /*
301 * POSIX constants
302 */
303
304 /* Mask for file access modes */
305 #define O_ACCMODE (O_SEARCH | O_EXEC | 0x3)
306 #define FD_CLOEXEC 1 /* close on exec flag */
307
308 /*
309 * DIRECTIO
310 */
311 #if defined(__EXTENSIONS__) || !defined(__XOPEN_OR_POSIX)
312 #define DIRECTIO_OFF (0)
313 #define DIRECTIO_ON (1)
314
315 /*
316 * File share reservation type
317 */
318 typedef struct fshare {
319 short f_access;
320 short f_deny;
321 int f_id;
322 } fshare_t;
323
324 /*
325 * f_access values
326 */
327 #define F_RDACC 0x1 /* Read-only share access */
328 #define F_WRACC 0x2 /* Write-only share access */
329 #define F_RWACC 0x3 /* Read-Write share access */
330 #define F_RMACC 0x4 /* private flag: Delete share access */
331 #define F_MDACC 0x20 /* private flag: Metadata share access */
332
333 /*
334 * f_deny values
335 */
336 #define F_NODNY 0x0 /* Don't deny others access */
337 #define F_RDDNY 0x1 /* Deny others read share access */
338 #define F_WRDNY 0x2 /* Deny others write share access */
339 #define F_RWDNY 0x3 /* Deny others read or write share access */
340 #define F_RMDNY 0x4 /* private flag: Deny delete share access */
341 #define F_COMPAT 0x8 /* Set share to old DOS compatibility mode */
342 #define F_MANDDNY 0x10 /* private flag: mandatory enforcement */
343 #endif /* defined(__EXTENSIONS__) || !defined(__XOPEN_OR_POSIX) */
344
345 /*
346 * Special flags for functions such as openat(), fstatat()....
347 */
348 #if !defined(__XOPEN_OR_POSIX) || defined(_ATFILE_SOURCE) || \
349 defined(__EXTENSIONS__)
350 /* || defined(_XPG7) */
351 #define AT_FDCWD 0xffd19553
352 #define AT_SYMLINK_NOFOLLOW 0x1000
353 #define AT_SYMLINK_FOLLOW 0x2000 /* only for linkat() */
354 #define AT_REMOVEDIR 0x1
355 #define _AT_TRIGGER 0x2
356 #define AT_EACCESS 0x4 /* use EUID/EGID for access */
357 #endif
358
359 #if !defined(__XOPEN_OR_POSIX) || defined(_XPG6) || defined(__EXTENSIONS__)
360 /* advice for posix_fadvise */
361 #define POSIX_FADV_NORMAL 0
362 #define POSIX_FADV_RANDOM 1
363 #define POSIX_FADV_SEQUENTIAL 2
364 #define POSIX_FADV_WILLNEED 3
365 #define POSIX_FADV_DONTNEED 4
366 #define POSIX_FADV_NOREUSE 5
367 #endif
368
369 #ifdef __cplusplus
370 }
371 #endif
372
373 #endif /* _SYS_FCNTL_H */