]> git.saurik.com Git - apple/xnu.git/blame - bsd/sys/fcntl.h
xnu-2050.48.11.tar.gz
[apple/xnu.git] / bsd / sys / fcntl.h
CommitLineData
1c79356b 1/*
2d21ac55 2 * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
5d5c5d0d 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
A
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.
8f6c56a5 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
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
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
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.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
29/*-
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.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
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.
53 *
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
64 * SUCH DAMAGE.
65 *
66 * @(#)fcntl.h 8.3 (Berkeley) 1/21/94
67 */
68
69
70#ifndef _SYS_FCNTL_H_
71#define _SYS_FCNTL_H_
72
73/*
74 * This file includes the definitions for open and fcntl
75 * described by POSIX for <fcntl.h>; it also includes
76 * related kernel definitions.
77 */
91447636
A
78#include <sys/_types.h>
79#include <sys/cdefs.h>
6d2010ae
A
80#ifndef KERNEL
81#include <Availability.h>
82#endif
1c79356b 83
91447636
A
84/* We should not be exporting size_t here. Temporary for gcc bootstrapping. */
85#ifndef _SIZE_T
86#define _SIZE_T
87typedef __darwin_size_t size_t;
88#endif
89
90#ifndef _MODE_T
91typedef __darwin_mode_t mode_t;
92#define _MODE_T
93#endif
94
95#ifndef _OFF_T
96typedef __darwin_off_t off_t;
97#define _OFF_T
98#endif
99
100#ifndef _PID_T
101typedef __darwin_pid_t pid_t;
102#define _PID_T
1c79356b
A
103#endif
104
105/*
106 * File status flags: these are used by open(2), fcntl(2).
107 * They are also used (indirectly) in the kernel file structure f_flags,
108 * which is a superset of the open/fcntl flags. Open flags and f_flags
109 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
110 * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
111 */
112/* open-only flags */
113#define O_RDONLY 0x0000 /* open for reading only */
114#define O_WRONLY 0x0001 /* open for writing only */
115#define O_RDWR 0x0002 /* open for reading and writing */
116#define O_ACCMODE 0x0003 /* mask for above modes */
117
118/*
119 * Kernel encoding of open mode; separate read and write bits that are
120 * independently testable: 1 greater than the above.
121 *
122 * XXX
123 * FREAD and FWRITE are excluded from the #ifdef KERNEL so that TIOCFLUSH,
124 * which was documented to use FREAD/FWRITE, continues to work.
125 */
2d21ac55 126#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
127#define FREAD 0x0001
128#define FWRITE 0x0002
129#endif
130#define O_NONBLOCK 0x0004 /* no delay */
131#define O_APPEND 0x0008 /* set append mode */
b0d623f7
A
132#ifndef O_SYNC /* allow simultaneous inclusion of <aio.h> */
133#define O_SYNC 0x0080 /* synch I/O file integrity */
134#endif
2d21ac55 135#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
136#define O_SHLOCK 0x0010 /* open with shared file lock */
137#define O_EXLOCK 0x0020 /* open with exclusive file lock */
138#define O_ASYNC 0x0040 /* signal pgrp when data ready */
91447636 139#define O_FSYNC O_SYNC /* source compatibility: do not use */
9bccf70c 140#define O_NOFOLLOW 0x0100 /* don't follow symlinks */
2d21ac55 141#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b
A
142#define O_CREAT 0x0200 /* create if nonexistant */
143#define O_TRUNC 0x0400 /* truncate to zero length */
144#define O_EXCL 0x0800 /* error if already exists */
145#ifdef KERNEL
146#define FMARK 0x1000 /* mark during gc() */
147#define FDEFER 0x2000 /* defer for next gc pass */
148#define FHASLOCK 0x4000 /* descriptor holds advisory lock */
149#endif
2d21ac55 150#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
55e303ae
A
151#define O_EVTONLY 0x8000 /* descriptor requested for event notifications only */
152#endif
1c79356b 153
91447636
A
154#ifdef KERNEL
155#define FWASWRITTEN 0x10000 /* descriptor was written */
156#endif
157
2d21ac55
A
158#define O_NOCTTY 0x20000 /* don't assign controlling terminal */
159
160#ifdef KERNEL
161#define FNOCACHE 0x40000 /* fcntl(F_NOCACHE, 1) */
162#define FNORDAHEAD 0x80000 /* fcntl(F_RDAHEAD, 0) */
163#endif
164
165#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
166#define O_DIRECTORY 0x100000
167#define O_SYMLINK 0x200000 /* allow open of a symlink */
0c530ab8
A
168#endif
169
b0d623f7
A
170#ifndef O_DSYNC /* allow simultaneous inclusion of <aio.h> */
171#define O_DSYNC 0x400000 /* synch I/O data integrity */
172#endif
1c79356b 173
6d2010ae
A
174#ifdef KERNEL
175#define FNODIRECT 0x800000 /* fcntl(F_NODIRECT, 1) */
176#endif
177
178#if __DARWIN_C_LEVEL >= 200809L
179#define O_CLOEXEC 0x1000000 /* implicitly set FD_CLOEXEC */
180#endif
181
316670eb
A
182#ifdef KERNEL
183#define FENCRYPTED 0x2000000
184#endif
185
186#ifdef KERNEL
187#define FSINGLE_WRITER 0x4000000 /* fcntl(F_SINGLE_WRITER, 1) */
188#endif
189
190/* Data Protection Flags */
191#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
192#define O_DP_GETRAWENCRYPTED 0x0001
193#endif
194
195
1c79356b
A
196#ifdef KERNEL
197/* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
198#define FFLAGS(oflags) ((oflags) + 1)
199#define OFLAGS(fflags) ((fflags) - 1)
200
201/* bits to save after open */
b0d623f7 202#define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FFDSYNC|FNONBLOCK)
1c79356b 203/* bits settable by fcntl(F_SETFL, ...) */
b0d623f7 204#define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FFDSYNC|FNONBLOCK)
1c79356b
A
205#endif
206
207/*
208 * The O_* flags used to have only F* names, which were used in the kernel
209 * and by fcntl. We retain the F* names for the kernel f_flags field
210 * and for backward compatibility for fcntl.
211 */
2d21ac55 212#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
213#define FAPPEND O_APPEND /* kernel/compat */
214#define FASYNC O_ASYNC /* kernel/compat */
215#define FFSYNC O_FSYNC /* kernel */
b0d623f7 216#define FFDSYNC O_DSYNC /* kernel */
1c79356b
A
217#define FNONBLOCK O_NONBLOCK /* kernel */
218#define FNDELAY O_NONBLOCK /* compat */
219#define O_NDELAY O_NONBLOCK /* compat */
220#endif
221
222/*
223 * Flags used for copyfile(2)
224 */
225
2d21ac55 226#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
227#define CPF_OVERWRITE 1
228#define CPF_IGNORE_MODE 2
229#define CPF_MASK (CPF_OVERWRITE|CPF_IGNORE_MODE)
230#endif
231
232/*
233 * Constants used for fcntl(2)
234 */
235
236/* command values */
237#define F_DUPFD 0 /* duplicate file descriptor */
238#define F_GETFD 1 /* get file descriptor flags */
239#define F_SETFD 2 /* set file descriptor flags */
240#define F_GETFL 3 /* get file status flags */
241#define F_SETFL 4 /* set file status flags */
1c79356b
A
242#define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */
243#define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */
1c79356b
A
244#define F_GETLK 7 /* get record locking information */
245#define F_SETLK 8 /* set record locking information */
246#define F_SETLKW 9 /* F_SETLK; wait if blocked */
2d21ac55 247#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
6d2010ae 248#define F_FLUSH_DATA 40
55e303ae 249#define F_CHKCLEAN 41 /* Used for regression test */
1c79356b
A
250#define F_PREALLOCATE 42 /* Preallocate storage */
251#define F_SETSIZE 43 /* Truncate a file without zeroing space */
252#define F_RDADVISE 44 /* Issue an advisory read async with no copy to user */
2d21ac55 253#define F_RDAHEAD 45 /* turn read ahead off/on for this fd */
1c79356b
A
254#define F_READBOOTSTRAP 46 /* Read bootstrap from disk */
255#define F_WRITEBOOTSTRAP 47 /* Write bootstrap on disk */
2d21ac55 256#define F_NOCACHE 48 /* turn data caching off/on for this fd */
1c79356b 257#define F_LOG2PHYS 49 /* file offset to device offset */
55e303ae
A
258#define F_GETPATH 50 /* return the full path of the fd */
259#define F_FULLFSYNC 51 /* fsync + ask the drive to flush to the media */
91447636
A
260#define F_PATHPKG_CHECK 52 /* find which component (if any) is a package */
261#define F_FREEZE_FS 53 /* "freeze" all fs operations */
262#define F_THAW_FS 54 /* "thaw" all fs operations */
2d21ac55
A
263#define F_GLOBAL_NOCACHE 55 /* turn data caching off/on (globally) for this file */
264
265#ifdef PRIVATE
266#define F_OPENFROM 56 /* SPI: open a file relative to fd (must be a dir) */
267#define F_UNLINKFROM 57 /* SPI: open a file relative to fd (must be a dir) */
268#define F_CHECK_OPENEVT 58 /* SPI: if a process is marked OPENEVT, or in O_EVTONLY on opens of this vnode */
269#endif /* PRIVATE */
270
271#define F_ADDSIGS 59 /* add detached signatures */
272
273#define F_MARKDEPENDENCY 60 /* this process hosts the device supporting the fs backing this fd */
91447636 274
b0d623f7
A
275#define F_ADDFILESIGS 61 /* add signature from same file (used by dyld for shared libs) */
276
6d2010ae
A
277#define F_NODIRECT 62 /* used in conjunction with F_NOCACHE to indicate that DIRECT, synchonous writes */
278 /* should not be used (i.e. its ok to temporaily create cached pages) */
279
280#define F_GETPROTECTIONCLASS 63 /* Get the protection class of a file from the EA, returns int */
281#define F_SETPROTECTIONCLASS 64 /* Set the protection class of a file for the EA, requires int */
282
283#define F_LOG2PHYS_EXT 65 /* file offset to device offset, extended */
284
285#define F_GETLKPID 66 /* get record locking information, per-process */
286
316670eb
A
287/* See F_DUPFD_CLOEXEC below for 67 */
288
6d2010ae 289#ifdef PRIVATE
316670eb
A
290#define F_SETSTATICCONTENT 68 /*
291 * indicate to the filesystem/storage driver that the content to be
292 * written is usually static. a nonzero value enables it, 0 disables it.
293 */
294#define F_MOVEDATAEXTENTS 69 /* Swap only the data associated with two files */
6d2010ae
A
295#endif
296
297#define F_SETBACKINGSTORE 70 /* Mark the file as being the backing store for another filesystem */
298#define F_GETPATH_MTMINFO 71 /* return the full path of the FD, but error in specific mtmd circumstances */
299
316670eb
A
300/* 72 is free. It used to be F_GETENCRYPTEDDATA, which is now removed. */
301
6d2010ae
A
302#define F_SETNOSIGPIPE 73 /* No SIGPIPE generated on EPIPE */
303#define F_GETNOSIGPIPE 74 /* Status of SIGPIPE for this fd */
d1ecb069 304
316670eb
A
305#define F_TRANSCODEKEY 75 /* For some cases, we need to rewrap the key for AKS/MKB */
306
307#define F_SINGLE_WRITER 76 /* file being written to a by single writer... if throttling enabled, writes */
308 /* may be broken into smaller chunks with throttling in between */
309
310#define F_GETPROTECTIONLEVEL 77 /* Get the protection version number for this filesystem */
311
312
91447636
A
313// FS-specific fcntl()'s numbers begin at 0x00010000 and go up
314#define FCNTL_FS_SPECIFIC_BASE 0x00010000
2d21ac55
A
315
316#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b 317
6d2010ae
A
318#if __DARWIN_C_LEVEL >= 200809L
319#define F_DUPFD_CLOEXEC 67 /* mark the dup with FD_CLOEXEC */
320#endif
321
1c79356b
A
322/* file descriptor flags (F_GETFD, F_SETFD) */
323#define FD_CLOEXEC 1 /* close-on-exec flag */
324
325/* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
326#define F_RDLCK 1 /* shared or read lock */
327#define F_UNLCK 2 /* unlock */
328#define F_WRLCK 3 /* exclusive or write lock */
329#ifdef KERNEL
330#define F_WAIT 0x010 /* Wait until lock is granted */
331#define F_FLOCK 0x020 /* Use flock(2) semantics for lock */
332#define F_POSIX 0x040 /* Use POSIX semantics for lock */
316670eb 333#define F_PROV 0x080 /* Non-coalesced provisional lock */
c910b4d9 334#define F_WAKE1_SAFE 0x100 /* its safe to only wake one waiter */
316670eb 335#define F_ABORT 0x200 /* lock attempt aborted (force umount) */
1c79356b
A
336#endif
337
91447636
A
338/*
339 * [XSI] The values used for l_whence shall be defined as described
340 * in <unistd.h>
341 */
342#ifndef SEEK_SET
343#define SEEK_SET 0 /* set file offset to offset */
344#define SEEK_CUR 1 /* set file offset to current plus offset */
345#define SEEK_END 2 /* set file offset to EOF plus offset */
346#endif /* !SEEK_SET */
347
348/*
349 * [XSI] The symbolic names for file modes for use as values of mode_t
350 * shall be defined as described in <sys/stat.h>
351 */
352#ifndef S_IFMT
353/* File type */
354#define S_IFMT 0170000 /* [XSI] type of file mask */
355#define S_IFIFO 0010000 /* [XSI] named pipe (fifo) */
356#define S_IFCHR 0020000 /* [XSI] character special */
357#define S_IFDIR 0040000 /* [XSI] directory */
358#define S_IFBLK 0060000 /* [XSI] block special */
359#define S_IFREG 0100000 /* [XSI] regular */
360#define S_IFLNK 0120000 /* [XSI] symbolic link */
361#define S_IFSOCK 0140000 /* [XSI] socket */
2d21ac55 362#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
6d2010ae 363#define S_IFWHT 0160000 /* OBSOLETE: whiteout */
91447636
A
364#endif
365
366/* File mode */
367/* Read, write, execute/search by owner */
368#define S_IRWXU 0000700 /* [XSI] RWX mask for owner */
369#define S_IRUSR 0000400 /* [XSI] R for owner */
370#define S_IWUSR 0000200 /* [XSI] W for owner */
371#define S_IXUSR 0000100 /* [XSI] X for owner */
372/* Read, write, execute/search by group */
373#define S_IRWXG 0000070 /* [XSI] RWX mask for group */
374#define S_IRGRP 0000040 /* [XSI] R for group */
375#define S_IWGRP 0000020 /* [XSI] W for group */
376#define S_IXGRP 0000010 /* [XSI] X for group */
377/* Read, write, execute/search by others */
378#define S_IRWXO 0000007 /* [XSI] RWX mask for other */
379#define S_IROTH 0000004 /* [XSI] R for other */
380#define S_IWOTH 0000002 /* [XSI] W for other */
381#define S_IXOTH 0000001 /* [XSI] X for other */
382
383#define S_ISUID 0004000 /* [XSI] set user id on execution */
384#define S_ISGID 0002000 /* [XSI] set group id on execution */
385#define S_ISVTX 0001000 /* [XSI] directory restrcted delete */
386
2d21ac55 387#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
91447636
A
388#define S_ISTXT S_ISVTX /* sticky bit: not supported */
389#define S_IREAD S_IRUSR /* backward compatability */
390#define S_IWRITE S_IWUSR /* backward compatability */
391#define S_IEXEC S_IXUSR /* backward compatability */
392#endif
393#endif /* !S_IFMT */
394
2d21ac55 395#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
396/* allocate flags (F_PREALLOCATE) */
397
398#define F_ALLOCATECONTIG 0x00000002 /* allocate contigious space */
399#define F_ALLOCATEALL 0x00000004 /* allocate all requested space or no space at all */
400
401/* Position Modes (fst_posmode) for F_PREALLOCATE */
402
403#define F_PEOFPOSMODE 3 /* Make it past all of the SEEK pos modes so that */
404 /* we can keep them in sync should we desire */
0b4e3aa0 405#define F_VOLPOSMODE 4 /* specify volume starting postion */
2d21ac55 406#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b
A
407
408/*
409 * Advisory file segment locking data type -
410 * information passed to system by user
411 */
412struct flock {
413 off_t l_start; /* starting offset */
414 off_t l_len; /* len = 0 means until end of file */
415 pid_t l_pid; /* lock owner */
416 short l_type; /* lock type: read/write, etc. */
417 short l_whence; /* type of l_start */
418};
419
2d21ac55 420#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
421/*
422 * advisory file read data type -
423 * information passed by user to system
424 */
b0d623f7
A
425
426#ifdef KERNEL
427#pragma pack(4) /* prevent structure padding in kernel */
428#endif /* KERNEL */
429
1c79356b
A
430struct radvisory {
431 off_t ra_offset;
432 int ra_count;
433};
434
b0d623f7
A
435#ifdef KERNEL
436#pragma pack()
437#endif /* KERNEL */
438
2d21ac55
A
439/*
440 * detached code signatures data type -
b0d623f7
A
441 * information passed by user to system used by F_ADDSIGS and F_ADDFILESIGS.
442 * F_ADDFILESIGS is a shortcut for files that contain their own signature and
443 * doesn't require mapping of the file in order to load the signature.
2d21ac55
A
444 */
445typedef struct fsignatures {
446 off_t fs_file_start;
447 void *fs_blob_start;
448 size_t fs_blob_size;
449} fsignatures_t;
450#ifdef KERNEL
451/* LP64 version of fsignatures. all pointers
452 * grow when we're dealing with a 64-bit process.
453 * WARNING - keep in sync with fsignatures
454 */
b0d623f7
A
455
456typedef struct user32_fsignatures {
2d21ac55 457 off_t fs_file_start;
b0d623f7
A
458 user32_addr_t fs_blob_start;
459 user32_size_t fs_blob_size;
460} user32_fsignatures_t;
461
462typedef struct user_fsignatures {
463 off_t fs_file_start; /* offset of Mach-O image in FAT file */
464 user_addr_t fs_blob_start; /* F_ADDSIGS: mem address of signature*/
465 /* F_ADDFILESIGS: offset of signature */
466 /* in Mach-O image */
467 user_size_t fs_blob_size; /* size of signature blob */
2d21ac55
A
468} user_fsignatures_t;
469#endif /* KERNEL */
1c79356b 470
1c79356b
A
471/* lock operations for flock(2) */
472#define LOCK_SH 0x01 /* shared file lock */
473#define LOCK_EX 0x02 /* exclusive file lock */
474#define LOCK_NB 0x04 /* don't block when locking */
475#define LOCK_UN 0x08 /* unlock file */
1c79356b 476
0b4e3aa0 477/* fstore_t type used by F_DEALLOCATE and F_PREALLOCATE commands */
1c79356b
A
478
479typedef struct fstore {
91447636 480 unsigned int fst_flags; /* IN: flags word */
1c79356b
A
481 int fst_posmode; /* IN: indicates use of offset field */
482 off_t fst_offset; /* IN: start of the region */
483 off_t fst_length; /* IN: size of the region */
484 off_t fst_bytesalloc; /* OUT: number of bytes allocated */
485} fstore_t;
486
487/* fbootstraptransfer_t used by F_READBOOTSTRAP and F_WRITEBOOTSTRAP commands */
488
489typedef struct fbootstraptransfer {
490 off_t fbt_offset; /* IN: offset to start read/write */
91447636 491 size_t fbt_length; /* IN: number of bytes to transfer */
1c79356b
A
492 void *fbt_buffer; /* IN: buffer to be read/written */
493} fbootstraptransfer_t;
494
91447636
A
495#ifdef KERNEL
496/* LP64 version of fbootstraptransfer. all pointers
497 * grow when we're dealing with a 64-bit process.
498 * WARNING - keep in sync with fbootstraptransfer
499 */
500
b0d623f7
A
501typedef struct user32_fbootstraptransfer {
502 off_t fbt_offset; /* IN: offset to start read/write */
503 user32_size_t fbt_length; /* IN: number of bytes to transfer */
504 user32_addr_t fbt_buffer; /* IN: buffer to be read/written */
505} user32_fbootstraptransfer_t;
506
91447636
A
507typedef struct user_fbootstraptransfer {
508 off_t fbt_offset; /* IN: offset to start read/write */
509 user_size_t fbt_length; /* IN: number of bytes to transfer */
510 user_addr_t fbt_buffer; /* IN: buffer to be read/written */
511} user_fbootstraptransfer_t;
512
91447636
A
513#endif // KERNEL
514
1c79356b
A
515/*
516 * For F_LOG2PHYS this information is passed back to user
517 * Currently only devoffset is returned - that is the VOP_BMAP
518 * result - the disk device address corresponding to the
519 * current file offset (likely set with an lseek).
520 *
521 * The flags could hold an indication of whether the # of
522 * contiguous bytes reflects the true extent length on disk,
523 * or is an advisory value that indicates there is at least that
524 * many bytes contiguous. For some filesystems it might be too
525 * inefficient to provide anything beyond the advisory value.
526 * Flags and contiguous bytes return values are not yet implemented.
527 * For them the fcntl will nedd to switch from using BMAP to CMAP
528 * and a per filesystem type flag will be needed to interpret the
529 * contiguous bytes count result from CMAP.
6d2010ae
A
530 *
531 * F_LOG2PHYS_EXT is a variant of F_LOG2PHYS that uses a passed in
532 * file offset and length instead of the current file offset.
533 * F_LOG2PHYS_EXT operates on the same structure as F_LOG2PHYS, but
534 * treats it as an in/out.
1c79356b 535 */
0c530ab8 536#pragma pack(4)
91447636 537
1c79356b 538struct log2phys {
6d2010ae
A
539 unsigned int l2p_flags; /* unused so far */
540 off_t l2p_contigbytes; /* F_LOG2PHYS: unused so far */
541 /* F_LOG2PHYS_EXT: IN: number of bytes to be queried */
542 /* OUT: number of contiguous bytes at this position */
543 off_t l2p_devoffset; /* F_LOG2PHYS: OUT: bytes into device */
544 /* F_LOG2PHYS_EXT: IN: bytes into file */
545 /* OUT: bytes into device */
1c79356b
A
546};
547
0c530ab8 548#pragma pack()
91447636 549
1c79356b
A
550#define O_POPUP 0x80000000 /* force window to popup on open */
551#define O_ALERT 0x20000000 /* small, clean popup window */
2d21ac55
A
552
553#ifdef PRIVATE
554/*
555 * SPI: Argument data for F_OPENFROM
556 */
557struct fopenfrom {
558 unsigned int o_flags; /* same as open(2) */
559 mode_t o_mode; /* same as open(2) */
560 char * o_pathname; /* relative pathname */
561};
562
563#ifdef KERNEL
564/*
565 * LP64 version of fopenfrom. Memory pointers
566 * grow when we're dealing with a 64-bit process.
567 *
568 * WARNING - keep in sync with fopenfrom (above)
569 */
b0d623f7
A
570struct user32_fopenfrom {
571 unsigned int o_flags;
572 mode_t o_mode;
573 user32_addr_t o_pathname;
574};
575
2d21ac55
A
576struct user_fopenfrom {
577 unsigned int o_flags;
578 mode_t o_mode;
579 user_addr_t o_pathname;
580};
581#endif /* KERNEL */
582
583#endif /* PRIVATE */
584
585#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b
A
586
587#ifndef KERNEL
91447636 588
2d21ac55 589#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
91447636
A
590#ifndef _FILESEC_T
591struct _filesec;
592typedef struct _filesec *filesec_t;
593#define _FILESEC_T
594#endif
595typedef enum {
596 FILESEC_OWNER = 1,
597 FILESEC_GROUP = 2,
598 FILESEC_UUID = 3,
599 FILESEC_MODE = 4,
600 FILESEC_ACL = 5,
601 FILESEC_GRPUUID = 6,
602
603/* XXX these are private to the implementation */
604 FILESEC_ACL_RAW = 100,
605 FILESEC_ACL_ALLOCSIZE = 101
606} filesec_property_t;
607
608/* XXX backwards compatibility */
609#define FILESEC_GUID FILESEC_UUID
2d21ac55 610#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b
A
611
612__BEGIN_DECLS
2d21ac55
A
613int open(const char *, int, ...) __DARWIN_ALIAS_C(open);
614int creat(const char *, mode_t) __DARWIN_ALIAS_C(creat);
615int fcntl(int, int, ...) __DARWIN_ALIAS_C(fcntl);
616#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
d1ecb069
A
617
618#ifdef PRIVATE
6d2010ae
A
619/*
620 * These definitions are retained temporarily for compatibility.
621 * If you want to use fileports, please use
622 * #include <sys/fileport.h>
623 * or
624 * #include <System/sys/fileport.h>
625 */
d1ecb069
A
626#ifndef _FILEPORT_T
627#define _FILEPORT_T
628typedef __darwin_mach_port_t fileport_t;
629#define FILEPORT_NULL ((fileport_t)0)
630#endif /* _FILEPORT_T */
631
632int fileport_makeport(int, fileport_t*);
633int fileport_makefd(fileport_t);
634#endif /* PRIVATE */
91447636 635int openx_np(const char *, int, filesec_t);
316670eb
A
636/* data-protected non-portable open(2) */
637int open_dprotected_np ( const char *, int, int, int, ...);
91447636
A
638int flock(int, int);
639filesec_t filesec_init(void);
640filesec_t filesec_dup(filesec_t);
641void filesec_free(filesec_t);
642int filesec_get_property(filesec_t, filesec_property_t, void *);
91447636 643int filesec_query_property(filesec_t, filesec_property_t, int *);
b0d623f7 644int filesec_set_property(filesec_t, filesec_property_t, const void *);
6d2010ae 645int filesec_unset_property(filesec_t, filesec_property_t) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
91447636
A
646#define _FILESEC_UNSET_PROPERTY ((void *)0)
647#define _FILESEC_REMOVE_ACL ((void *)1)
2d21ac55 648#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
1c79356b
A
649__END_DECLS
650#endif
651
652#endif /* !_SYS_FCNTL_H_ */