2 * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
30 * Copyright (c) 1983, 1990, 1993
31 * The Regents of the University of California. All rights reserved.
32 * (c) UNIX System Laboratories, Inc.
33 * All or some portions of this file are derived from material licensed
34 * to the University of California by American Telephone and Telegraph
35 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
36 * the permission of UNIX System Laboratories, Inc.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * 3. All advertising materials mentioning features or use of this software
47 * must display the following acknowledgement:
48 * This product includes software developed by the University of
49 * California, Berkeley and its contributors.
50 * 4. Neither the name of the University nor the names of its contributors
51 * may be used to endorse or promote products derived from this software
52 * without specific prior written permission.
54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
66 * @(#)fcntl.h 8.3 (Berkeley) 1/21/94
74 * This file includes the definitions for open and fcntl
75 * described by POSIX for <fcntl.h>; it also includes
76 * related kernel definitions.
78 #include <sys/_types.h>
79 #include <sys/cdefs.h>
81 /* We should not be exporting size_t here. Temporary for gcc bootstrapping. */
84 typedef __darwin_size_t
size_t;
88 typedef __darwin_mode_t mode_t
;
93 typedef __darwin_off_t off_t
;
98 typedef __darwin_pid_t pid_t
;
103 * File status flags: these are used by open(2), fcntl(2).
104 * They are also used (indirectly) in the kernel file structure f_flags,
105 * which is a superset of the open/fcntl flags. Open flags and f_flags
106 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
107 * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
109 /* open-only flags */
110 #define O_RDONLY 0x0000 /* open for reading only */
111 #define O_WRONLY 0x0001 /* open for writing only */
112 #define O_RDWR 0x0002 /* open for reading and writing */
113 #define O_ACCMODE 0x0003 /* mask for above modes */
116 * Kernel encoding of open mode; separate read and write bits that are
117 * independently testable: 1 greater than the above.
120 * FREAD and FWRITE are excluded from the #ifdef KERNEL so that TIOCFLUSH,
121 * which was documented to use FREAD/FWRITE, continues to work.
123 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
125 #define FWRITE 0x0002
127 #define O_NONBLOCK 0x0004 /* no delay */
128 #define O_APPEND 0x0008 /* set append mode */
129 #ifndef O_SYNC /* allow simultaneous inclusion of <aio.h> */
130 #define O_SYNC 0x0080 /* synch I/O file integrity */
132 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
133 #define O_SHLOCK 0x0010 /* open with shared file lock */
134 #define O_EXLOCK 0x0020 /* open with exclusive file lock */
135 #define O_ASYNC 0x0040 /* signal pgrp when data ready */
136 #define O_FSYNC O_SYNC /* source compatibility: do not use */
137 #define O_NOFOLLOW 0x0100 /* don't follow symlinks */
138 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
139 #define O_CREAT 0x0200 /* create if nonexistant */
140 #define O_TRUNC 0x0400 /* truncate to zero length */
141 #define O_EXCL 0x0800 /* error if already exists */
143 #define FMARK 0x1000 /* mark during gc() */
144 #define FDEFER 0x2000 /* defer for next gc pass */
145 #define FHASLOCK 0x4000 /* descriptor holds advisory lock */
147 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
148 #define O_EVTONLY 0x8000 /* descriptor requested for event notifications only */
152 #define FWASWRITTEN 0x10000 /* descriptor was written */
155 #define O_NOCTTY 0x20000 /* don't assign controlling terminal */
158 #define FNOCACHE 0x40000 /* fcntl(F_NOCACHE, 1) */
159 #define FNORDAHEAD 0x80000 /* fcntl(F_RDAHEAD, 0) */
162 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
163 #define O_DIRECTORY 0x100000
164 #define O_SYMLINK 0x200000 /* allow open of a symlink */
167 #ifndef O_DSYNC /* allow simultaneous inclusion of <aio.h> */
168 #define O_DSYNC 0x400000 /* synch I/O data integrity */
172 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
173 #define FFLAGS(oflags) ((oflags) + 1)
174 #define OFLAGS(fflags) ((fflags) - 1)
176 /* bits to save after open */
177 #define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FFDSYNC|FNONBLOCK)
178 /* bits settable by fcntl(F_SETFL, ...) */
179 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FFDSYNC|FNONBLOCK)
183 * The O_* flags used to have only F* names, which were used in the kernel
184 * and by fcntl. We retain the F* names for the kernel f_flags field
185 * and for backward compatibility for fcntl.
187 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
188 #define FAPPEND O_APPEND /* kernel/compat */
189 #define FASYNC O_ASYNC /* kernel/compat */
190 #define FFSYNC O_FSYNC /* kernel */
191 #define FFDSYNC O_DSYNC /* kernel */
192 #define FNONBLOCK O_NONBLOCK /* kernel */
193 #define FNDELAY O_NONBLOCK /* compat */
194 #define O_NDELAY O_NONBLOCK /* compat */
198 * Flags used for copyfile(2)
201 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
202 #define CPF_OVERWRITE 1
203 #define CPF_IGNORE_MODE 2
204 #define CPF_MASK (CPF_OVERWRITE|CPF_IGNORE_MODE)
208 * Constants used for fcntl(2)
212 #define F_DUPFD 0 /* duplicate file descriptor */
213 #define F_GETFD 1 /* get file descriptor flags */
214 #define F_SETFD 2 /* set file descriptor flags */
215 #define F_GETFL 3 /* get file status flags */
216 #define F_SETFL 4 /* set file status flags */
217 #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */
218 #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */
219 #define F_GETLK 7 /* get record locking information */
220 #define F_SETLK 8 /* set record locking information */
221 #define F_SETLKW 9 /* F_SETLK; wait if blocked */
222 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
223 #define F_CHKCLEAN 41 /* Used for regression test */
224 #define F_PREALLOCATE 42 /* Preallocate storage */
225 #define F_SETSIZE 43 /* Truncate a file without zeroing space */
226 #define F_RDADVISE 44 /* Issue an advisory read async with no copy to user */
227 #define F_RDAHEAD 45 /* turn read ahead off/on for this fd */
228 #define F_READBOOTSTRAP 46 /* Read bootstrap from disk */
229 #define F_WRITEBOOTSTRAP 47 /* Write bootstrap on disk */
230 #define F_NOCACHE 48 /* turn data caching off/on for this fd */
231 #define F_LOG2PHYS 49 /* file offset to device offset */
232 #define F_GETPATH 50 /* return the full path of the fd */
233 #define F_FULLFSYNC 51 /* fsync + ask the drive to flush to the media */
234 #define F_PATHPKG_CHECK 52 /* find which component (if any) is a package */
235 #define F_FREEZE_FS 53 /* "freeze" all fs operations */
236 #define F_THAW_FS 54 /* "thaw" all fs operations */
237 #define F_GLOBAL_NOCACHE 55 /* turn data caching off/on (globally) for this file */
240 #define F_OPENFROM 56 /* SPI: open a file relative to fd (must be a dir) */
241 #define F_UNLINKFROM 57 /* SPI: open a file relative to fd (must be a dir) */
242 #define F_CHECK_OPENEVT 58 /* SPI: if a process is marked OPENEVT, or in O_EVTONLY on opens of this vnode */
245 #define F_ADDSIGS 59 /* add detached signatures */
247 #define F_MARKDEPENDENCY 60 /* this process hosts the device supporting the fs backing this fd */
249 #define F_ADDFILESIGS 61 /* add signature from same file (used by dyld for shared libs) */
251 #define F_GETPROTECTIONCLASS 62 /* Get the protection class of a file from the EA, returns int */
252 #define F_SETPROTECTIONCLASS 63 /* Set the protection class of a file for the EA, requires int */
254 // FS-specific fcntl()'s numbers begin at 0x00010000 and go up
255 #define FCNTL_FS_SPECIFIC_BASE 0x00010000
257 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
259 /* file descriptor flags (F_GETFD, F_SETFD) */
260 #define FD_CLOEXEC 1 /* close-on-exec flag */
262 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
263 #define F_RDLCK 1 /* shared or read lock */
264 #define F_UNLCK 2 /* unlock */
265 #define F_WRLCK 3 /* exclusive or write lock */
267 #define F_WAIT 0x010 /* Wait until lock is granted */
268 #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */
269 #define F_POSIX 0x040 /* Use POSIX semantics for lock */
270 #define F_PROV 0x080 /* Non-coelesced provisional lock */
271 #define F_WAKE1_SAFE 0x100 /* its safe to only wake one waiter */
275 * [XSI] The values used for l_whence shall be defined as described
279 #define SEEK_SET 0 /* set file offset to offset */
280 #define SEEK_CUR 1 /* set file offset to current plus offset */
281 #define SEEK_END 2 /* set file offset to EOF plus offset */
282 #endif /* !SEEK_SET */
285 * [XSI] The symbolic names for file modes for use as values of mode_t
286 * shall be defined as described in <sys/stat.h>
290 #define S_IFMT 0170000 /* [XSI] type of file mask */
291 #define S_IFIFO 0010000 /* [XSI] named pipe (fifo) */
292 #define S_IFCHR 0020000 /* [XSI] character special */
293 #define S_IFDIR 0040000 /* [XSI] directory */
294 #define S_IFBLK 0060000 /* [XSI] block special */
295 #define S_IFREG 0100000 /* [XSI] regular */
296 #define S_IFLNK 0120000 /* [XSI] symbolic link */
297 #define S_IFSOCK 0140000 /* [XSI] socket */
298 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
299 #define S_IFWHT 0160000 /* whiteout */
303 /* Read, write, execute/search by owner */
304 #define S_IRWXU 0000700 /* [XSI] RWX mask for owner */
305 #define S_IRUSR 0000400 /* [XSI] R for owner */
306 #define S_IWUSR 0000200 /* [XSI] W for owner */
307 #define S_IXUSR 0000100 /* [XSI] X for owner */
308 /* Read, write, execute/search by group */
309 #define S_IRWXG 0000070 /* [XSI] RWX mask for group */
310 #define S_IRGRP 0000040 /* [XSI] R for group */
311 #define S_IWGRP 0000020 /* [XSI] W for group */
312 #define S_IXGRP 0000010 /* [XSI] X for group */
313 /* Read, write, execute/search by others */
314 #define S_IRWXO 0000007 /* [XSI] RWX mask for other */
315 #define S_IROTH 0000004 /* [XSI] R for other */
316 #define S_IWOTH 0000002 /* [XSI] W for other */
317 #define S_IXOTH 0000001 /* [XSI] X for other */
319 #define S_ISUID 0004000 /* [XSI] set user id on execution */
320 #define S_ISGID 0002000 /* [XSI] set group id on execution */
321 #define S_ISVTX 0001000 /* [XSI] directory restrcted delete */
323 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
324 #define S_ISTXT S_ISVTX /* sticky bit: not supported */
325 #define S_IREAD S_IRUSR /* backward compatability */
326 #define S_IWRITE S_IWUSR /* backward compatability */
327 #define S_IEXEC S_IXUSR /* backward compatability */
331 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
332 /* allocate flags (F_PREALLOCATE) */
334 #define F_ALLOCATECONTIG 0x00000002 /* allocate contigious space */
335 #define F_ALLOCATEALL 0x00000004 /* allocate all requested space or no space at all */
337 /* Position Modes (fst_posmode) for F_PREALLOCATE */
339 #define F_PEOFPOSMODE 3 /* Make it past all of the SEEK pos modes so that */
340 /* we can keep them in sync should we desire */
341 #define F_VOLPOSMODE 4 /* specify volume starting postion */
342 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
345 * Advisory file segment locking data type -
346 * information passed to system by user
349 off_t l_start
; /* starting offset */
350 off_t l_len
; /* len = 0 means until end of file */
351 pid_t l_pid
; /* lock owner */
352 short l_type
; /* lock type: read/write, etc. */
353 short l_whence
; /* type of l_start */
357 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
359 * advisory file read data type -
360 * information passed by user to system
364 #pragma pack(4) /* prevent structure padding in kernel */
377 * detached code signatures data type -
378 * information passed by user to system used by F_ADDSIGS and F_ADDFILESIGS.
379 * F_ADDFILESIGS is a shortcut for files that contain their own signature and
380 * doesn't require mapping of the file in order to load the signature.
382 typedef struct fsignatures
{
388 /* LP64 version of fsignatures. all pointers
389 * grow when we're dealing with a 64-bit process.
390 * WARNING - keep in sync with fsignatures
393 typedef struct user32_fsignatures
{
395 user32_addr_t fs_blob_start
;
396 user32_size_t fs_blob_size
;
397 } user32_fsignatures_t
;
399 typedef struct user_fsignatures
{
400 off_t fs_file_start
; /* offset of Mach-O image in FAT file */
401 user_addr_t fs_blob_start
; /* F_ADDSIGS: mem address of signature*/
402 /* F_ADDFILESIGS: offset of signature */
403 /* in Mach-O image */
404 user_size_t fs_blob_size
; /* size of signature blob */
405 } user_fsignatures_t
;
408 /* lock operations for flock(2) */
409 #define LOCK_SH 0x01 /* shared file lock */
410 #define LOCK_EX 0x02 /* exclusive file lock */
411 #define LOCK_NB 0x04 /* don't block when locking */
412 #define LOCK_UN 0x08 /* unlock file */
414 /* fstore_t type used by F_DEALLOCATE and F_PREALLOCATE commands */
416 typedef struct fstore
{
417 unsigned int fst_flags
; /* IN: flags word */
418 int fst_posmode
; /* IN: indicates use of offset field */
419 off_t fst_offset
; /* IN: start of the region */
420 off_t fst_length
; /* IN: size of the region */
421 off_t fst_bytesalloc
; /* OUT: number of bytes allocated */
424 /* fbootstraptransfer_t used by F_READBOOTSTRAP and F_WRITEBOOTSTRAP commands */
426 typedef struct fbootstraptransfer
{
427 off_t fbt_offset
; /* IN: offset to start read/write */
428 size_t fbt_length
; /* IN: number of bytes to transfer */
429 void *fbt_buffer
; /* IN: buffer to be read/written */
430 } fbootstraptransfer_t
;
433 /* LP64 version of fbootstraptransfer. all pointers
434 * grow when we're dealing with a 64-bit process.
435 * WARNING - keep in sync with fbootstraptransfer
438 typedef struct user32_fbootstraptransfer
{
439 off_t fbt_offset
; /* IN: offset to start read/write */
440 user32_size_t fbt_length
; /* IN: number of bytes to transfer */
441 user32_addr_t fbt_buffer
; /* IN: buffer to be read/written */
442 } user32_fbootstraptransfer_t
;
444 typedef struct user_fbootstraptransfer
{
445 off_t fbt_offset
; /* IN: offset to start read/write */
446 user_size_t fbt_length
; /* IN: number of bytes to transfer */
447 user_addr_t fbt_buffer
; /* IN: buffer to be read/written */
448 } user_fbootstraptransfer_t
;
453 * For F_LOG2PHYS this information is passed back to user
454 * Currently only devoffset is returned - that is the VOP_BMAP
455 * result - the disk device address corresponding to the
456 * current file offset (likely set with an lseek).
458 * The flags could hold an indication of whether the # of
459 * contiguous bytes reflects the true extent length on disk,
460 * or is an advisory value that indicates there is at least that
461 * many bytes contiguous. For some filesystems it might be too
462 * inefficient to provide anything beyond the advisory value.
463 * Flags and contiguous bytes return values are not yet implemented.
464 * For them the fcntl will nedd to switch from using BMAP to CMAP
465 * and a per filesystem type flag will be needed to interpret the
466 * contiguous bytes count result from CMAP.
471 unsigned int l2p_flags
; /* unused so far */
472 off_t l2p_contigbytes
; /* unused so far */
473 off_t l2p_devoffset
; /* bytes into device */
478 #define O_POPUP 0x80000000 /* force window to popup on open */
479 #define O_ALERT 0x20000000 /* small, clean popup window */
483 * SPI: Argument data for F_OPENFROM
486 unsigned int o_flags
; /* same as open(2) */
487 mode_t o_mode
; /* same as open(2) */
488 char * o_pathname
; /* relative pathname */
493 * LP64 version of fopenfrom. Memory pointers
494 * grow when we're dealing with a 64-bit process.
496 * WARNING - keep in sync with fopenfrom (above)
498 struct user32_fopenfrom
{
499 unsigned int o_flags
;
501 user32_addr_t o_pathname
;
504 struct user_fopenfrom
{
505 unsigned int o_flags
;
507 user_addr_t o_pathname
;
513 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
517 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
520 typedef struct _filesec
*filesec_t
;
531 /* XXX these are private to the implementation */
532 FILESEC_ACL_RAW
= 100,
533 FILESEC_ACL_ALLOCSIZE
= 101
534 } filesec_property_t
;
536 /* XXX backwards compatibility */
537 #define FILESEC_GUID FILESEC_UUID
538 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
541 int open(const char *, int, ...) __DARWIN_ALIAS_C(open
);
542 int creat(const char *, mode_t
) __DARWIN_ALIAS_C(creat
);
543 int fcntl(int, int, ...) __DARWIN_ALIAS_C(fcntl
);
544 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
549 typedef __darwin_mach_port_t fileport_t
;
550 #define FILEPORT_NULL ((fileport_t)0)
551 #endif /* _FILEPORT_T */
553 int fileport_makeport(int, fileport_t
*);
554 int fileport_makefd(fileport_t
);
556 int openx_np(const char *, int, filesec_t
);
558 filesec_t
filesec_init(void);
559 filesec_t
filesec_dup(filesec_t
);
560 void filesec_free(filesec_t
);
561 int filesec_get_property(filesec_t
, filesec_property_t
, void *);
562 int filesec_query_property(filesec_t
, filesec_property_t
, int *);
563 int filesec_set_property(filesec_t
, filesec_property_t
, const void *);
564 int filesec_unset_property(filesec_t
, filesec_property_t
);
565 #define _FILESEC_UNSET_PROPERTY ((void *)0)
566 #define _FILESEC_REMOVE_ACL ((void *)1)
567 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
571 #endif /* !_SYS_FCNTL_H_ */