]> git.saurik.com Git - apple/xnu.git/blob - bsd/sys/fcntl.h
xnu-3789.31.2.tar.gz
[apple/xnu.git] / bsd / sys / fcntl.h
1 /*
2 * Copyright (c) 2000-2013 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
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.
14 *
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
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.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
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 */
78 #include <sys/_types.h>
79 #include <sys/cdefs.h>
80 #ifndef KERNEL
81 #include <Availability.h>
82 #endif
83
84 /* We should not be exporting size_t here. Temporary for gcc bootstrapping. */
85 #include <sys/_types/_size_t.h>
86 #include <sys/_types/_mode_t.h>
87 #include <sys/_types/_off_t.h>
88 #include <sys/_types/_pid_t.h>
89
90 /*
91 * File status flags: these are used by open(2), fcntl(2).
92 * They are also used (indirectly) in the kernel file structure f_flags,
93 * which is a superset of the open/fcntl flags. Open flags and f_flags
94 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
95 * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
96 */
97 /* open-only flags */
98 #define O_RDONLY 0x0000 /* open for reading only */
99 #define O_WRONLY 0x0001 /* open for writing only */
100 #define O_RDWR 0x0002 /* open for reading and writing */
101 #define O_ACCMODE 0x0003 /* mask for above modes */
102
103 /*
104 * Kernel encoding of open mode; separate read and write bits that are
105 * independently testable: 1 greater than the above.
106 *
107 * XXX
108 * FREAD and FWRITE are excluded from the #ifdef KERNEL so that TIOCFLUSH,
109 * which was documented to use FREAD/FWRITE, continues to work.
110 */
111 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
112 #define FREAD 0x0001
113 #define FWRITE 0x0002
114 #endif
115 #define O_NONBLOCK 0x0004 /* no delay */
116 #define O_APPEND 0x0008 /* set append mode */
117
118 #include <sys/_types/_o_sync.h>
119
120 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
121 #define O_SHLOCK 0x0010 /* open with shared file lock */
122 #define O_EXLOCK 0x0020 /* open with exclusive file lock */
123 #define O_ASYNC 0x0040 /* signal pgrp when data ready */
124 #define O_FSYNC O_SYNC /* source compatibility: do not use */
125 #define O_NOFOLLOW 0x0100 /* don't follow symlinks */
126 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
127 #define O_CREAT 0x0200 /* create if nonexistant */
128 #define O_TRUNC 0x0400 /* truncate to zero length */
129 #define O_EXCL 0x0800 /* error if already exists */
130 #ifdef KERNEL
131 #define FMARK 0x1000 /* mark during gc() */
132 #define FDEFER 0x2000 /* defer for next gc pass */
133 #define FHASLOCK 0x4000 /* descriptor holds advisory lock */
134 #endif
135
136 #if __DARWIN_C_LEVEL >= 200809L
137 /*
138 * Descriptor value for the current working directory
139 */
140 #define AT_FDCWD -2
141
142 /*
143 * Flags for the at functions
144 */
145 #define AT_EACCESS 0x0010 /* Use effective ids in access check */
146 #define AT_SYMLINK_NOFOLLOW 0x0020 /* Act on the symlink itself not the target */
147 #define AT_SYMLINK_FOLLOW 0x0040 /* Act on target of symlink */
148 #define AT_REMOVEDIR 0x0080 /* Path refers to directory */
149 #endif
150
151 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
152 #define O_EVTONLY 0x8000 /* descriptor requested for event notifications only */
153 #endif
154
155 #ifdef KERNEL
156 #define FWASWRITTEN 0x10000 /* descriptor was written */
157 #endif
158
159 #define O_NOCTTY 0x20000 /* don't assign controlling terminal */
160
161 #ifdef KERNEL
162 #define FNOCACHE 0x40000 /* fcntl(F_NOCACHE, 1) */
163 #define FNORDAHEAD 0x80000 /* fcntl(F_RDAHEAD, 0) */
164 #endif
165
166 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
167 #define O_DIRECTORY 0x100000
168 #define O_SYMLINK 0x200000 /* allow open of a symlink */
169 #endif
170
171 #include <sys/_types/_o_dsync.h>
172
173 #ifdef KERNEL
174 #define FNODIRECT 0x800000 /* fcntl(F_NODIRECT, 1) */
175 #endif
176
177 #if __DARWIN_C_LEVEL >= 200809L
178 #define O_CLOEXEC 0x1000000 /* implicitly set FD_CLOEXEC */
179 #endif
180
181 #ifdef KERNEL
182 #define FENCRYPTED 0x2000000
183 #endif
184
185 #ifdef KERNEL
186 #define FSINGLE_WRITER 0x4000000 /* fcntl(F_SINGLE_WRITER, 1) */
187 #endif
188
189 #ifdef KERNEL
190 #define O_CLOFORK 0x8000000 /* implicitly set FD_CLOFORK */
191 #endif
192
193 #ifdef KERNEL
194 #define FUNENCRYPTED 0x10000000
195 #endif
196
197 /* Data Protection Flags */
198 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
199 #define O_DP_GETRAWENCRYPTED 0x0001
200 #define O_DP_GETRAWUNENCRYPTED 0x0002
201 #endif
202
203
204 #ifdef KERNEL
205 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
206 #define FFLAGS(oflags) ((oflags) + 1)
207 #define OFLAGS(fflags) ((fflags) - 1)
208
209 /* bits to save after open */
210 #define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FFDSYNC|FNONBLOCK)
211 /* bits settable by fcntl(F_SETFL, ...) */
212 #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FFDSYNC|FNONBLOCK)
213 #endif
214
215 /*
216 * The O_* flags used to have only F* names, which were used in the kernel
217 * and by fcntl. We retain the F* names for the kernel f_flags field
218 * and for backward compatibility for fcntl.
219 */
220 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
221 #define FAPPEND O_APPEND /* kernel/compat */
222 #define FASYNC O_ASYNC /* kernel/compat */
223 #define FFSYNC O_FSYNC /* kernel */
224 #define FFDSYNC O_DSYNC /* kernel */
225 #define FNONBLOCK O_NONBLOCK /* kernel */
226 #define FNDELAY O_NONBLOCK /* compat */
227 #define O_NDELAY O_NONBLOCK /* compat */
228 #endif
229
230 /*
231 * Flags used for copyfile(2)
232 */
233
234 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
235 #define CPF_OVERWRITE 0x0001
236 #define CPF_IGNORE_MODE 0x0002
237 #define CPF_MASK (CPF_OVERWRITE|CPF_IGNORE_MODE)
238 #endif
239
240 /*
241 * Constants used for fcntl(2)
242 */
243
244 /* command values */
245 #define F_DUPFD 0 /* duplicate file descriptor */
246 #define F_GETFD 1 /* get file descriptor flags */
247 #define F_SETFD 2 /* set file descriptor flags */
248 #define F_GETFL 3 /* get file status flags */
249 #define F_SETFL 4 /* set file status flags */
250 #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */
251 #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */
252 #define F_GETLK 7 /* get record locking information */
253 #define F_SETLK 8 /* set record locking information */
254 #define F_SETLKW 9 /* F_SETLK; wait if blocked */
255 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
256 #define F_SETLKWTIMEOUT 10 /* F_SETLK; wait if blocked, return on timeout */
257 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
258 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
259 #define F_FLUSH_DATA 40
260 #define F_CHKCLEAN 41 /* Used for regression test */
261 #define F_PREALLOCATE 42 /* Preallocate storage */
262 #define F_SETSIZE 43 /* Truncate a file without zeroing space */
263 #define F_RDADVISE 44 /* Issue an advisory read async with no copy to user */
264 #define F_RDAHEAD 45 /* turn read ahead off/on for this fd */
265 /*
266 * 46,47 used to be F_READBOOTSTRAP and F_WRITEBOOTSTRAP
267 */
268 #define F_NOCACHE 48 /* turn data caching off/on for this fd */
269 #define F_LOG2PHYS 49 /* file offset to device offset */
270 #define F_GETPATH 50 /* return the full path of the fd */
271 #define F_FULLFSYNC 51 /* fsync + ask the drive to flush to the media */
272 #define F_PATHPKG_CHECK 52 /* find which component (if any) is a package */
273 #define F_FREEZE_FS 53 /* "freeze" all fs operations */
274 #define F_THAW_FS 54 /* "thaw" all fs operations */
275 #define F_GLOBAL_NOCACHE 55 /* turn data caching off/on (globally) for this file */
276
277 #ifdef PRIVATE
278 #define F_OPENFROM 56 /* SPI: open a file relative to fd (must be a dir) */
279 #define F_UNLINKFROM 57 /* SPI: open a file relative to fd (must be a dir) */
280 #define F_CHECK_OPENEVT 58 /* SPI: if a process is marked OPENEVT, or in O_EVTONLY on opens of this vnode */
281 #endif /* PRIVATE */
282
283 #define F_ADDSIGS 59 /* add detached signatures */
284
285 #ifdef PRIVATE
286 /* Deprecated/Removed in 10.9 */
287 #define F_MARKDEPENDENCY 60 /* this process hosts the device supporting the fs backing this fd */
288 #endif
289
290 #define F_ADDFILESIGS 61 /* add signature from same file (used by dyld for shared libs) */
291
292 #define F_NODIRECT 62 /* used in conjunction with F_NOCACHE to indicate that DIRECT, synchonous writes */
293 /* should not be used (i.e. its ok to temporaily create cached pages) */
294
295 #define F_GETPROTECTIONCLASS 63 /* Get the protection class of a file from the EA, returns int */
296 #define F_SETPROTECTIONCLASS 64 /* Set the protection class of a file for the EA, requires int */
297
298 #define F_LOG2PHYS_EXT 65 /* file offset to device offset, extended */
299
300 #define F_GETLKPID 66 /* get record locking information, per-process */
301
302 /* See F_DUPFD_CLOEXEC below for 67 */
303
304 #ifdef PRIVATE
305 #define F_SETSTATICCONTENT 68 /*
306 * indicate to the filesystem/storage driver that the content to be
307 * written is usually static. a nonzero value enables it, 0 disables it.
308 */
309 #define F_MOVEDATAEXTENTS 69 /* Swap only the data associated with two files */
310 #endif
311
312 #define F_SETBACKINGSTORE 70 /* Mark the file as being the backing store for another filesystem */
313 #define F_GETPATH_MTMINFO 71 /* return the full path of the FD, but error in specific mtmd circumstances */
314
315 #define F_GETCODEDIR 72 /* Returns the code directory, with associated hashes, to the caller */
316
317 #define F_SETNOSIGPIPE 73 /* No SIGPIPE generated on EPIPE */
318 #define F_GETNOSIGPIPE 74 /* Status of SIGPIPE for this fd */
319
320 #define F_TRANSCODEKEY 75 /* For some cases, we need to rewrap the key for AKS/MKB */
321
322 #define F_SINGLE_WRITER 76 /* file being written to a by single writer... if throttling enabled, writes */
323 /* may be broken into smaller chunks with throttling in between */
324
325 #define F_GETPROTECTIONLEVEL 77 /* Get the protection version number for this filesystem */
326
327 #define F_FINDSIGS 78 /* Add detached code signatures (used by dyld for shared libs) */
328
329 #ifdef PRIVATE
330 #define F_GETDEFAULTPROTLEVEL 79 /* Get the default protection level for the filesystem */
331 #define F_MAKECOMPRESSED 80 /* Make the file compressed; truncate & toggle BSD bits */
332 #define F_SET_GREEDY_MODE 81 /*
333 * indicate to the filesystem/storage driver that the content to be
334 * written should be written in greedy mode for additional speed at
335 * the cost of storage efficiency. A nonzero value enables it, 0 disables it.
336 */
337
338 #define F_SETIOTYPE 82 /*
339 * Use parameters to describe content being written to the FD. See
340 * flag definitions below for argument bits.
341 */
342 #endif
343
344 #define F_ADDFILESIGS_FOR_DYLD_SIM 83 /* Add signature from same file, only if it is signed by Apple (used by dyld for simulator) */
345
346 #ifdef PRIVATE
347 #define F_RECYCLE 84 /* Recycle vnode; debug/development builds only */
348 #endif
349
350 #define F_BARRIERFSYNC 85 /* fsync + issue barrier to drive */
351
352 #ifdef PRIVATE
353 #define F_OFD_SETLK 90 /* Acquire or release open file description lock */
354 #define F_OFD_SETLKW 91 /* (as F_OFD_SETLK but blocking if conflicting lock) */
355 #define F_OFD_GETLK 92 /* Examine OFD lock */
356
357 #define F_OFD_SETLKWTIMEOUT 93 /* (as F_OFD_SETLKW but return if timeout) */
358 #define F_OFD_GETLKPID 94 /* get record locking information */
359
360 #define F_SETCONFINED 95 /* "confine" OFD to process */
361 #define F_GETCONFINED 96 /* is-fd-confined? */
362 #endif
363
364 #define F_ADDFILESIGS_RETURN 97 /* Add signature from same file, return end offset in structure on sucess */
365 #define F_CHECK_LV 98 /* Check if Library Validation allows this Mach-O file to be mapped into the calling process */
366
367
368 // FS-specific fcntl()'s numbers begin at 0x00010000 and go up
369 #define FCNTL_FS_SPECIFIC_BASE 0x00010000
370
371 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
372
373 #if __DARWIN_C_LEVEL >= 200809L
374 #define F_DUPFD_CLOEXEC 67 /* mark the dup with FD_CLOEXEC */
375 #endif
376
377 /* file descriptor flags (F_GETFD, F_SETFD) */
378 #define FD_CLOEXEC 1 /* close-on-exec flag */
379 #if PRIVATE
380 #define FD_CLOFORK 2 /* close-on-fork flag */
381 #endif
382
383 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
384 #define F_RDLCK 1 /* shared or read lock */
385 #define F_UNLCK 2 /* unlock */
386 #define F_WRLCK 3 /* exclusive or write lock */
387 #ifdef KERNEL
388 #define F_WAIT 0x010 /* Wait until lock is granted */
389 #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */
390 #define F_POSIX 0x040 /* Use POSIX semantics for lock */
391 #define F_PROV 0x080 /* Non-coalesced provisional lock */
392 #define F_WAKE1_SAFE 0x100 /* its safe to only wake one waiter */
393 #define F_ABORT 0x200 /* lock attempt aborted (force umount) */
394 #define F_OFD_LOCK 0x400 /* Use "OFD" semantics for lock */
395 #endif
396
397 #if PRIVATE
398 /*
399 * ISOCHRONOUS attempts to sustain a minimum platform-dependent throughput
400 * for the duration of the I/O delivered to the driver.
401 */
402 #define F_IOTYPE_ISOCHRONOUS 0x0001
403 #endif
404
405 /*
406 * [XSI] The values used for l_whence shall be defined as described
407 * in <unistd.h>
408 */
409 #include <sys/_types/_seek_set.h>
410
411 /*
412 * [XSI] The symbolic names for file modes for use as values of mode_t
413 * shall be defined as described in <sys/stat.h>
414 */
415 #include <sys/_types/_s_ifmt.h>
416
417 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
418 /* allocate flags (F_PREALLOCATE) */
419
420 #define F_ALLOCATECONTIG 0x00000002 /* allocate contigious space */
421 #define F_ALLOCATEALL 0x00000004 /* allocate all requested space or no space at all */
422
423 /* Position Modes (fst_posmode) for F_PREALLOCATE */
424
425 #define F_PEOFPOSMODE 3 /* Make it past all of the SEEK pos modes so that */
426 /* we can keep them in sync should we desire */
427 #define F_VOLPOSMODE 4 /* specify volume starting postion */
428 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
429
430 /*
431 * Advisory file segment locking data type -
432 * information passed to system by user
433 */
434 struct flock {
435 off_t l_start; /* starting offset */
436 off_t l_len; /* len = 0 means until end of file */
437 pid_t l_pid; /* lock owner */
438 short l_type; /* lock type: read/write, etc. */
439 short l_whence; /* type of l_start */
440 };
441
442 #include <sys/_types/_timespec.h>
443
444 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
445 /*
446 * Advisory file segment locking with time out -
447 * Information passed to system by user for F_SETLKWTIMEOUT
448 */
449 struct flocktimeout {
450 struct flock fl; /* flock passed for file locking */
451 struct timespec timeout; /* timespec struct for timeout */
452 };
453 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
454
455 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
456 /*
457 * advisory file read data type -
458 * information passed by user to system
459 */
460
461 #ifdef KERNEL
462 #pragma pack(4) /* prevent structure padding in kernel */
463 #endif /* KERNEL */
464
465 struct radvisory {
466 off_t ra_offset;
467 int ra_count;
468 };
469
470 #ifdef KERNEL
471 #pragma pack()
472 #endif /* KERNEL */
473
474 #ifndef KERNEL
475 /** Information the user passes in to get the codeblobs out of the kernel */
476 typedef struct fcodeblobs {
477 void *f_cd_hash;
478 size_t f_hash_size;
479 void *f_cd_buffer;
480 size_t f_cd_size;
481 unsigned int *f_out_size;
482 int f_arch;
483 int __padding;
484 } fcodeblobs_t;
485 #endif /* KERNEL */
486
487 #ifdef KERNEL
488 typedef struct user32_fcodeblobs {
489 user32_addr_t f_cd_hash;
490 user32_size_t f_hash_size;
491 user32_addr_t f_cd_buffer;
492 user32_size_t f_cd_size;
493 user32_addr_t f_out_size;
494 int f_arch;
495 } user32_fcodeblobs_t;
496
497 /* LP64 version of fcodeblobs */
498 typedef struct user64_fcodeblobs {
499 user64_addr_t f_cd_hash;
500 user64_size_t f_hash_size;
501 user64_addr_t f_cd_buffer;
502 user64_size_t f_cd_size;
503 user64_addr_t f_out_size;
504 int f_arch;
505 int __padding;
506 } user64_fcodeblobs_t;
507
508 /* kernel version of fcodeblobs */
509 typedef struct user_fcodeblobs {
510 user_addr_t f_cd_hash;
511 user_size_t f_hash_size;
512 user_addr_t f_cd_buffer;
513 user_size_t f_cd_size;
514 user_addr_t f_out_size;
515 int f_arch;
516 } user_fcodeblobs_t;
517 #endif /* KERNEL */
518
519 /*
520 * detached code signatures data type -
521 * information passed by user to system used by F_ADDSIGS and F_ADDFILESIGS.
522 * F_ADDFILESIGS is a shortcut for files that contain their own signature and
523 * doesn't require mapping of the file in order to load the signature.
524 */
525 typedef struct fsignatures {
526 off_t fs_file_start;
527 void *fs_blob_start;
528 size_t fs_blob_size;
529 } fsignatures_t;
530 #ifdef KERNEL
531 /* LP64 version of fsignatures. all pointers
532 * grow when we're dealing with a 64-bit process.
533 * WARNING - keep in sync with fsignatures
534 */
535
536 typedef struct user32_fsignatures {
537 off_t fs_file_start;
538 user32_addr_t fs_blob_start;
539 user32_size_t fs_blob_size;
540 } user32_fsignatures_t;
541
542 typedef struct user_fsignatures {
543 off_t fs_file_start; /* offset of Mach-O image in FAT file */
544 user_addr_t fs_blob_start; /* F_ADDSIGS: mem address of signature*/
545 /* F_ADDFILESIGS: offset of signature */
546 /* in Mach-O image */
547 user_size_t fs_blob_size; /* size of signature blob */
548 } user_fsignatures_t;
549 #endif /* KERNEL */
550
551 /*
552 * DYLD needs to check if the object is allowed to be combined
553 * into the main binary. This is done between the code signature
554 * is loaded and dyld is doing all the work to process the LOAD commands.
555 *
556 * While this could be done in F_ADDFILESIGS.* family the hook into
557 * the MAC module doesn't say no when LV isn't enabled and then that
558 * is cached on the vnode, and the MAC module never gets change once
559 * a process that library validation enabled.
560 */
561 typedef struct fchecklv {
562 off_t lv_file_start;
563 size_t lv_error_message_size;
564 void *lv_error_message;
565 } fchecklv_t;
566
567 #ifdef KERNEL
568 /* LP64 version of fchecklv. all pointers
569 * grow when we're dealing with a 64-bit process.
570 * WARNING - keep in sync with fsignatures
571 */
572
573 typedef struct user32_fchecklv {
574 user32_off_t lv_file_start;
575 user32_size_t lv_error_message_size;
576 user32_addr_t lv_error_message;
577 } user32_fchecklv_t;
578
579 typedef struct user_fchecklv {
580 off_t lv_file_start;
581 user_size_t lv_error_message_size;
582 user_addr_t lv_error_message;
583 } user_fchecklv_t;
584
585 #endif /* KERNEL */
586
587
588 /* lock operations for flock(2) */
589 #define LOCK_SH 0x01 /* shared file lock */
590 #define LOCK_EX 0x02 /* exclusive file lock */
591 #define LOCK_NB 0x04 /* don't block when locking */
592 #define LOCK_UN 0x08 /* unlock file */
593
594 /* fstore_t type used by F_DEALLOCATE and F_PREALLOCATE commands */
595
596 typedef struct fstore {
597 unsigned int fst_flags; /* IN: flags word */
598 int fst_posmode; /* IN: indicates use of offset field */
599 off_t fst_offset; /* IN: start of the region */
600 off_t fst_length; /* IN: size of the region */
601 off_t fst_bytesalloc; /* OUT: number of bytes allocated */
602 } fstore_t;
603
604 /* fbootstraptransfer_t used by F_READBOOTSTRAP and F_WRITEBOOTSTRAP commands */
605
606 typedef struct fbootstraptransfer {
607 off_t fbt_offset; /* IN: offset to start read/write */
608 size_t fbt_length; /* IN: number of bytes to transfer */
609 void *fbt_buffer; /* IN: buffer to be read/written */
610 } fbootstraptransfer_t;
611
612 #ifdef KERNEL
613 /* LP64 version of fbootstraptransfer. all pointers
614 * grow when we're dealing with a 64-bit process.
615 * WARNING - keep in sync with fbootstraptransfer
616 */
617
618 typedef struct user32_fbootstraptransfer {
619 off_t fbt_offset; /* IN: offset to start read/write */
620 user32_size_t fbt_length; /* IN: number of bytes to transfer */
621 user32_addr_t fbt_buffer; /* IN: buffer to be read/written */
622 } user32_fbootstraptransfer_t;
623
624 typedef struct user_fbootstraptransfer {
625 off_t fbt_offset; /* IN: offset to start read/write */
626 user_size_t fbt_length; /* IN: number of bytes to transfer */
627 user_addr_t fbt_buffer; /* IN: buffer to be read/written */
628 } user_fbootstraptransfer_t;
629
630 #endif // KERNEL
631
632 /*
633 * For F_LOG2PHYS this information is passed back to user
634 * Currently only devoffset is returned - that is the VOP_BMAP
635 * result - the disk device address corresponding to the
636 * current file offset (likely set with an lseek).
637 *
638 * The flags could hold an indication of whether the # of
639 * contiguous bytes reflects the true extent length on disk,
640 * or is an advisory value that indicates there is at least that
641 * many bytes contiguous. For some filesystems it might be too
642 * inefficient to provide anything beyond the advisory value.
643 * Flags and contiguous bytes return values are not yet implemented.
644 * For them the fcntl will nedd to switch from using BMAP to CMAP
645 * and a per filesystem type flag will be needed to interpret the
646 * contiguous bytes count result from CMAP.
647 *
648 * F_LOG2PHYS_EXT is a variant of F_LOG2PHYS that uses a passed in
649 * file offset and length instead of the current file offset.
650 * F_LOG2PHYS_EXT operates on the same structure as F_LOG2PHYS, but
651 * treats it as an in/out.
652 */
653 #pragma pack(4)
654
655 struct log2phys {
656 unsigned int l2p_flags; /* unused so far */
657 off_t l2p_contigbytes; /* F_LOG2PHYS: unused so far */
658 /* F_LOG2PHYS_EXT: IN: number of bytes to be queried */
659 /* OUT: number of contiguous bytes at this position */
660 off_t l2p_devoffset; /* F_LOG2PHYS: OUT: bytes into device */
661 /* F_LOG2PHYS_EXT: IN: bytes into file */
662 /* OUT: bytes into device */
663 };
664
665 #pragma pack()
666
667 #define O_POPUP 0x80000000 /* force window to popup on open */
668 #define O_ALERT 0x20000000 /* small, clean popup window */
669
670 #ifdef PRIVATE
671 /*
672 * SPI: Argument data for F_OPENFROM
673 */
674 struct fopenfrom {
675 unsigned int o_flags; /* same as open(2) */
676 mode_t o_mode; /* same as open(2) */
677 char * o_pathname; /* relative pathname */
678 };
679
680 #ifdef KERNEL
681 /*
682 * LP64 version of fopenfrom. Memory pointers
683 * grow when we're dealing with a 64-bit process.
684 *
685 * WARNING - keep in sync with fopenfrom (above)
686 */
687 struct user32_fopenfrom {
688 unsigned int o_flags;
689 mode_t o_mode;
690 user32_addr_t o_pathname;
691 };
692
693 struct user_fopenfrom {
694 unsigned int o_flags;
695 mode_t o_mode;
696 user_addr_t o_pathname;
697 };
698 #endif /* KERNEL */
699
700 #endif /* PRIVATE */
701
702 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
703
704 #ifndef KERNEL
705
706 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
707
708 #include <sys/_types/_filesec_t.h>
709
710 typedef enum {
711 FILESEC_OWNER = 1,
712 FILESEC_GROUP = 2,
713 FILESEC_UUID = 3,
714 FILESEC_MODE = 4,
715 FILESEC_ACL = 5,
716 FILESEC_GRPUUID = 6,
717
718 /* XXX these are private to the implementation */
719 FILESEC_ACL_RAW = 100,
720 FILESEC_ACL_ALLOCSIZE = 101
721 } filesec_property_t;
722
723 /* XXX backwards compatibility */
724 #define FILESEC_GUID FILESEC_UUID
725 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
726
727 __BEGIN_DECLS
728 int open(const char *, int, ...) __DARWIN_ALIAS_C(open);
729 #if __DARWIN_C_LEVEL >= 200809L
730 int openat(int, const char *, int, ...) __DARWIN_NOCANCEL(openat) __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
731 #endif
732 int creat(const char *, mode_t) __DARWIN_ALIAS_C(creat);
733 int fcntl(int, int, ...) __DARWIN_ALIAS_C(fcntl);
734 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
735
736 #ifdef PRIVATE
737 /*
738 * These definitions are retained temporarily for compatibility.
739 * If you want to use fileports, please use
740 * #include <sys/fileport.h>
741 * or
742 * #include <System/sys/fileport.h>
743 */
744 #ifndef _FILEPORT_T
745 #define _FILEPORT_T
746 typedef __darwin_mach_port_t fileport_t;
747 #define FILEPORT_NULL ((fileport_t)0)
748 #endif /* _FILEPORT_T */
749
750 int fileport_makeport(int, fileport_t*);
751 int fileport_makefd(fileport_t);
752 #endif /* PRIVATE */
753 int openx_np(const char *, int, filesec_t);
754 /*
755 * data-protected non-portable open(2) :
756 int open_dprotected_np(user_addr_t path, int flags, int class, int dpflags, int mode)
757 */
758 int open_dprotected_np ( const char *, int, int, int, ...);
759 int flock(int, int);
760 filesec_t filesec_init(void);
761 filesec_t filesec_dup(filesec_t);
762 void filesec_free(filesec_t);
763 int filesec_get_property(filesec_t, filesec_property_t, void *);
764 int filesec_query_property(filesec_t, filesec_property_t, int *);
765 int filesec_set_property(filesec_t, filesec_property_t, const void *);
766 int filesec_unset_property(filesec_t, filesec_property_t) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
767 #define _FILESEC_UNSET_PROPERTY ((void *)0)
768 #define _FILESEC_REMOVE_ACL ((void *)1)
769 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
770 __END_DECLS
771 #endif
772
773 #endif /* !_SYS_FCNTL_H_ */