master
  1/*
  2 * Copyright (c) 2000-2025 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#include <Availability.h>
 81
 82/* We should not be exporting size_t here.  Temporary for gcc bootstrapping. */
 83#include <sys/_types/_size_t.h>
 84#include <sys/_types/_mode_t.h>
 85#include <sys/_types/_off_t.h>
 86#include <sys/_types/_pid_t.h>
 87
 88/*
 89 * File status flags: these are used by open(2), fcntl(2).
 90 * They are also used (indirectly) in the kernel file structure f_flags,
 91 * which is a superset of the open/fcntl flags.  Open flags and f_flags
 92 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
 93 * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
 94 */
 95/* open-only flags */
 96#define O_RDONLY        0x0000          /* open for reading only */
 97#define O_WRONLY        0x0001          /* open for writing only */
 98#define O_RDWR          0x0002          /* open for reading and writing */
 99#define O_ACCMODE       0x0003          /* mask for above modes */
100
101/*
102 * Kernel encoding of open mode; separate read and write bits that are
103 * independently testable: 1 greater than the above.
104 *
105 * XXX
106 * FREAD and FWRITE are excluded from the #ifdef KERNEL so that TIOCFLUSH,
107 * which was documented to use FREAD/FWRITE, continues to work.
108 */
109#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
110#define FREAD           0x00000001
111#define FWRITE          0x00000002
112#endif
113#define O_NONBLOCK      0x00000004      /* no delay */
114#define O_APPEND        0x00000008      /* set append mode */
115
116#include <sys/_types/_o_sync.h>
117
118#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
119#define O_SHLOCK        0x00000010      /* open with shared file lock */
120#define O_EXLOCK        0x00000020      /* open with exclusive file lock */
121#define O_ASYNC         0x00000040      /* signal pgrp when data ready */
122#define O_FSYNC         O_SYNC          /* source compatibility: do not use */
123#define O_NOFOLLOW      0x00000100      /* don't follow symlinks */
124#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
125#define O_CREAT         0x00000200      /* create if nonexistant */
126#define O_TRUNC         0x00000400      /* truncate to zero length */
127#define O_EXCL          0x00000800      /* error if already exists */
128#define O_RESOLVE_BENEATH 0x00001000    /* only for open(2), same value as FMARK */
129#define O_UNIQUE        0x00002000      /* only for open(2), same value as FDEFER */
130
131
132#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
133#define O_EVTONLY       0x00008000      /* descriptor requested for event notifications only */
134#endif
135
136
137#define O_NOCTTY        0x00020000      /* don't assign controlling terminal */
138
139
140#if __DARWIN_C_LEVEL >= 200809L
141#define O_DIRECTORY     0x00100000
142#endif
143
144#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
145#define O_SYMLINK       0x00200000      /* allow open of a symlink */
146#endif
147
148//      O_DSYNC         0x00400000      /* synch I/O data integrity */
149#include <sys/_types/_o_dsync.h>
150
151
152#if __DARWIN_C_LEVEL >= 200809L
153#define O_CLOEXEC       0x01000000      /* implicitly set FD_CLOEXEC */
154#endif
155
156
157#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
158#define O_NOFOLLOW_ANY  0x20000000      /* no symlinks allowed in path */
159#endif
160
161#if __DARWIN_C_LEVEL >= 200809L
162#define O_EXEC          0x40000000               /* open file for execute only */
163#define O_SEARCH        (O_EXEC | O_DIRECTORY)   /* open directory for search only */
164#endif
165
166
167
168#if __DARWIN_C_LEVEL >= 200809L
169/*
170 * Descriptor value for the current working directory
171 */
172#define AT_FDCWD        -2
173
174/*
175 * Flags for the at functions
176 */
177#define AT_EACCESS              0x0010  /* Use effective ids in access check */
178#define AT_SYMLINK_NOFOLLOW     0x0020  /* Act on the symlink itself not the target */
179#define AT_SYMLINK_FOLLOW       0x0040  /* Act on target of symlink */
180#define AT_REMOVEDIR            0x0080  /* Path refers to directory */
181#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
182#define AT_REALDEV              0x0200  /* Return real device inodes resides on for fstatat(2) */
183#define AT_FDONLY               0x0400  /* Use only the fd and Ignore the path for fstatat(2) */
184#define AT_SYMLINK_NOFOLLOW_ANY 0x0800  /* Path should not contain any symlinks */
185#define AT_RESOLVE_BENEATH      0x2000  /* Path must reside in the hierarchy beneath the starting directory */
186#define AT_NODELETEBUSY         0x4000  /* Don't delete busy files */
187#define AT_UNIQUE               0x8000  /* prevent a path lookup from succeeding on a vnode with multiple links */
188#endif
189#endif
190
191#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
192/* Data Protection Flags */
193#define O_DP_GETRAWENCRYPTED    0x0001
194#define O_DP_GETRAWUNENCRYPTED  0x0002
195#define O_DP_AUTHENTICATE       0x0004
196
197/* Descriptor value for openat_authenticated_np() to skip authentication with another fd */
198#define AUTH_OPEN_NOAUTHFD      -1
199#endif
200
201
202
203/*
204 * The O_* flags used to have only F* names, which were used in the kernel
205 * and by fcntl.  We retain the F* names for the kernel f_flags field
206 * and for backward compatibility for fcntl.
207 */
208#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
209#define FAPPEND         O_APPEND        /* kernel/compat */
210#define FASYNC          O_ASYNC         /* kernel/compat */
211#define FFSYNC          O_FSYNC         /* kernel */
212#define FFDSYNC         O_DSYNC         /* kernel */
213#define FNONBLOCK       O_NONBLOCK      /* kernel */
214#define FNDELAY         O_NONBLOCK      /* compat */
215#define O_NDELAY        O_NONBLOCK      /* compat */
216#endif
217
218/*
219 * Flags used for copyfile(2)
220 */
221
222#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
223#define CPF_OVERWRITE    0x0001
224#define CPF_IGNORE_MODE  0x0002
225#define CPF_MASK (CPF_OVERWRITE|CPF_IGNORE_MODE)
226#endif
227
228/*
229 * Constants used for fcntl(2)
230 */
231
232/* command values */
233#define F_DUPFD         0               /* duplicate file descriptor */
234#define F_GETFD         1               /* get file descriptor flags */
235#define F_SETFD         2               /* set file descriptor flags */
236#define F_GETFL         3               /* get file status flags */
237#define F_SETFL         4               /* set file status flags */
238#define F_GETOWN        5               /* get SIGIO/SIGURG proc/pgrp */
239#define F_SETOWN        6               /* set SIGIO/SIGURG proc/pgrp */
240#define F_GETLK         7               /* get record locking information */
241#define F_SETLK         8               /* set record locking information */
242#define F_SETLKW        9               /* F_SETLK; wait if blocked */
243#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
244#define F_SETLKWTIMEOUT 10              /* F_SETLK; wait if blocked, return on timeout */
245#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
246#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
247#define F_FLUSH_DATA    40
248#define F_CHKCLEAN      41              /* Used for regression test */
249#define F_PREALLOCATE   42              /* Preallocate storage */
250#define F_SETSIZE       43              /* Truncate a file. Equivalent to calling truncate(2) */
251#define F_RDADVISE      44              /* Issue an advisory read async with no copy to user */
252#define F_RDAHEAD       45              /* turn read ahead off/on for this fd */
253/*
254 * 46,47 used to be F_READBOOTSTRAP and F_WRITEBOOTSTRAP
255 */
256#define F_NOCACHE       48              /* turn data caching off/on for this fd */
257#define F_LOG2PHYS      49              /* file offset to device offset */
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 */
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 */
263#define F_GLOBAL_NOCACHE 55             /* turn data caching off/on (globally) for this file */
264
265#define F_ADDSIGS       59              /* add detached signatures */
266
267#define F_ADDFILESIGS   61              /* add signature from same file (used by dyld for shared libs) */
268
269#define F_NODIRECT      62              /* used in conjunction with F_NOCACHE to indicate that DIRECT, synchonous writes */
270                                        /* should not be used (i.e. its ok to temporaily create cached pages) */
271
272#define F_GETPROTECTIONCLASS    63              /* Get the protection class of a file from the EA, returns int */
273#define F_SETPROTECTIONCLASS    64              /* Set the protection class of a file for the EA, requires int */
274
275#define F_LOG2PHYS_EXT  65              /* file offset to device offset, extended */
276
277#define F_GETLKPID              66      /* See man fcntl(2) F_GETLK
278	                                 * Similar to F_GETLK but in addition l_pid is treated as an input parameter
279	                                 * which is used as a matching value when searching locks on the file
280	                                 * so that only locks owned by the process with pid l_pid are returned.
281	                                 * However, any flock(2) type lock will also be found with the returned value
282	                                 * of l_pid set to -1 (as with F_GETLK).
283	                                 */
284
285/* See F_DUPFD_CLOEXEC below for 67 */
286
287#define F_SETBACKINGSTORE       70      /* Mark the file as being the backing store for another filesystem */
288#define F_GETPATH_MTMINFO       71      /* return the full path of the FD, but error in specific mtmd circumstances */
289
290#define F_GETCODEDIR            72      /* Returns the code directory, with associated hashes, to the caller */
291
292#define F_SETNOSIGPIPE          73      /* No SIGPIPE generated on EPIPE */
293#define F_GETNOSIGPIPE          74      /* Status of SIGPIPE for this fd */
294
295#define F_TRANSCODEKEY          75      /* For some cases, we need to rewrap the key for AKS/MKB */
296
297#define F_SINGLE_WRITER         76      /* file being written to a by single writer... if throttling enabled, writes */
298                                        /* may be broken into smaller chunks with throttling in between */
299
300#define F_GETPROTECTIONLEVEL    77      /* Get the protection version number for this filesystem */
301
302#define F_FINDSIGS              78      /* Add detached code signatures (used by dyld for shared libs) */
303
304#define F_ADDFILESIGS_FOR_DYLD_SIM 83   /* Add signature from same file, only if it is signed by Apple (used by dyld for simulator) */
305
306#define F_BARRIERFSYNC          85      /* fsync + issue barrier to drive */
307
308#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
309#define F_OFD_SETLK             90      /* Acquire or release open file description lock */
310#define F_OFD_SETLKW            91      /* (as F_OFD_SETLK but blocking if conflicting lock) */
311#define F_OFD_GETLK             92      /* Examine OFD lock */
312
313#define F_OFD_SETLKWTIMEOUT     93      /* (as F_OFD_SETLKW but return if timeout) */
314#endif
315
316#define F_ADDFILESIGS_RETURN    97      /* Add signature from same file, return end offset in structure on success */
317#define F_CHECK_LV              98      /* Check if Library Validation allows this Mach-O file to be mapped into the calling process */
318
319#define F_PUNCHHOLE     99              /* Deallocate a range of the file */
320
321#define F_TRIM_ACTIVE_FILE      100     /* Trim an active file */
322
323#define F_SPECULATIVE_READ      101     /* Asynchronous advisory read fcntl for regular and compressed file */
324
325#define F_GETPATH_NOFIRMLINK    102     /* return the full path without firmlinks of the fd */
326
327#define F_ADDFILESIGS_INFO      103     /* Add signature from same file, return information */
328#define F_ADDFILESUPPL          104     /* Add supplemental signature from same file with fd reference to original */
329#define F_GETSIGSINFO           105     /* Look up code signature information attached to a file or slice */
330
331#define F_SETLEASE              106      /* Acquire or release lease */
332#define F_GETLEASE              107      /* Retrieve lease information */
333
334#define F_SETLEASE_ARG(t, oc)   ((t) | ((oc) << 2))
335
336#define F_TRANSFEREXTENTS       110      /* Transfer allocated extents beyond leof to a different file */
337
338#define F_ATTRIBUTION_TAG       111      /* Based on flags, query/set/delete a file's attribution tag */
339#define F_NOCACHE_EXT           112      /* turn data caching off/on for this fd and relax size and alignment restrictions for write */
340
341#define F_ADDSIGS_MAIN_BINARY   113             /* add detached signatures for main binary -- development only */
342
343// FS-specific fcntl()'s numbers begin at 0x00010000 and go up
344#define FCNTL_FS_SPECIFIC_BASE  0x00010000
345
346#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
347
348#if __DARWIN_C_LEVEL >= 200809L
349#define F_DUPFD_CLOEXEC         67      /* mark the dup with FD_CLOEXEC */
350#endif
351
352/* file descriptor flags (F_GETFD, F_SETFD) */
353#define FD_CLOEXEC      1               /* close-on-exec flag */
354
355/* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
356#define F_RDLCK         1               /* shared or read lock */
357#define F_UNLCK         2               /* unlock */
358#define F_WRLCK         3               /* exclusive or write lock */
359
360/*
361 * [XSI] The values used for l_whence shall be defined as described
362 * in <unistd.h>
363 */
364#include <sys/_types/_seek_set.h>
365
366/*
367 * [XSI] The symbolic names for file modes for use as values of mode_t
368 * shall be defined as described in <sys/stat.h>
369 */
370#include <sys/_types/_s_ifmt.h>
371
372#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
373/* allocate flags (F_PREALLOCATE) */
374
375#define F_ALLOCATECONTIG  0x00000002    /* allocate contigious space */
376#define F_ALLOCATEALL     0x00000004    /* allocate all requested space or no space at all */
377#define F_ALLOCATEPERSIST 0x00000008    /* do not free space upon close(2) */
378
379/* Position Modes (fst_posmode) for F_PREALLOCATE */
380
381#define F_PEOFPOSMODE 3                 /* Make it past all of the SEEK pos modes so that */
382                                        /* we can keep them in sync should we desire */
383#define F_VOLPOSMODE    4               /* specify volume starting postion */
384#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
385
386/*
387 * Advisory file segment locking data type -
388 * information passed to system by user
389 */
390struct flock {
391	off_t   l_start;        /* starting offset */
392	off_t   l_len;          /* len = 0 means until end of file */
393	pid_t   l_pid;          /* lock owner */
394	short   l_type;         /* lock type: read/write, etc. */
395	short   l_whence;       /* type of l_start */
396};
397
398#include <sys/_types/_timespec.h>
399
400#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
401/*
402 * Advisory file segment locking with time out -
403 * Information passed to system by user for F_SETLKWTIMEOUT
404 */
405struct flocktimeout {
406	struct flock    fl;             /* flock passed for file locking */
407	struct timespec timeout;        /* timespec struct for timeout */
408};
409
410#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
411
412#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
413/*
414 * advisory file read data type -
415 * information passed by user to system
416 */
417
418
419struct radvisory {
420	off_t   ra_offset;
421	int     ra_count;
422};
423
424
425/*
426 * detached code signatures data type -
427 * information passed by user to system used by F_ADDSIGS and F_ADDFILESIGS.
428 * F_ADDFILESIGS is a shortcut for files that contain their own signature and
429 * doesn't require mapping of the file in order to load the signature.
430 */
431#define USER_FSIGNATURES_CDHASH_LEN 20
432typedef struct fsignatures {
433	off_t           fs_file_start;
434	void            *fs_blob_start;
435	size_t          fs_blob_size;
436
437	/* The following fields are only applicable to F_ADDFILESIGS_INFO (64bit only). */
438	/* Prior to F_ADDFILESIGS_INFO, this struct ended after fs_blob_size. */
439	size_t          fs_fsignatures_size;// input: size of this struct (for compatibility)
440	char            fs_cdhash[USER_FSIGNATURES_CDHASH_LEN];     // output: cdhash
441	int             fs_hash_type;// output: hash algorithm type for cdhash
442} fsignatures_t;
443
444typedef struct fsupplement {
445	off_t           fs_file_start;   /* offset of Mach-O image in FAT file  */
446	off_t           fs_blob_start;   /* offset of signature in Mach-O image */
447	size_t          fs_blob_size;    /* signature blob size                 */
448	int             fs_orig_fd;      /* address of original image           */
449} fsupplement_t;
450
451
452
453/*
454 * DYLD needs to check if the object is allowed to be combined
455 * into the main binary. This is done between the code signature
456 * is loaded and dyld is doing all the work to process the LOAD commands.
457 *
458 * While this could be done in F_ADDFILESIGS.* family the hook into
459 * the MAC module doesn't say no when LV isn't enabled and then that
460 * is cached on the vnode, and the MAC module never gets change once
461 * a process that library validation enabled.
462 */
463typedef struct fchecklv {
464	off_t           lv_file_start;
465	size_t          lv_error_message_size;
466	void            *lv_error_message;
467} fchecklv_t;
468
469
470/* At this time F_GETSIGSINFO can only indicate platformness.
471 *  As additional requestable information is defined, new keys will be added and the
472 *  fgetsigsinfo_t structure will be lengthened to add space for the additional information
473 */
474#define GETSIGSINFO_PLATFORM_BINARY 1
475
476/* fgetsigsinfo_t used by F_GETSIGSINFO command */
477typedef struct fgetsigsinfo {
478	off_t fg_file_start; /* IN: Offset in the file to look for a signature, -1 for any signature */
479	int   fg_info_request; /* IN: Key indicating the info requested */
480	int   fg_sig_is_platform; /* OUT: 1 if the signature is a plat form binary, 0 if not */
481} fgetsigsinfo_t;
482
483
484/* lock operations for flock(2) */
485#define LOCK_SH         0x01            /* shared file lock */
486#define LOCK_EX         0x02            /* exclusive file lock */
487#define LOCK_NB         0x04            /* don't block when locking */
488#define LOCK_UN         0x08            /* unlock file */
489
490/* fstore_t type used by F_PREALLOCATE command */
491
492typedef struct fstore {
493	unsigned int fst_flags; /* IN: flags word */
494	int     fst_posmode;    /* IN: indicates use of offset field */
495	off_t   fst_offset;     /* IN: start of the region */
496	off_t   fst_length;     /* IN: size of the region */
497	off_t   fst_bytesalloc; /* OUT: number of bytes allocated */
498} fstore_t;
499
500/* fpunchhole_t used by F_PUNCHHOLE */
501typedef struct fpunchhole {
502	unsigned int fp_flags; /* unused */
503	unsigned int reserved; /* (to maintain 8-byte alignment) */
504	off_t fp_offset; /* IN: start of the region */
505	off_t fp_length; /* IN: size of the region */
506} fpunchhole_t;
507
508/* factive_file_trim_t used by F_TRIM_ACTIVE_FILE */
509typedef struct ftrimactivefile {
510	off_t fta_offset;  /* IN: start of the region */
511	off_t fta_length; /* IN: size of the region */
512} ftrimactivefile_t;
513
514/* fspecread_t used by F_SPECULATIVE_READ */
515typedef struct fspecread {
516	unsigned int fsr_flags;  /* IN: flags word */
517	unsigned int reserved;   /* to maintain 8-byte alignment */
518	off_t fsr_offset;        /* IN: start of the region */
519	off_t fsr_length;        /* IN: size of the region */
520} fspecread_t;
521
522/* fattributiontag_t used by F_ATTRIBUTION_TAG */
523#define ATTRIBUTION_NAME_MAX 255
524typedef struct fattributiontag {
525	unsigned int ft_flags;  /* IN: flags word */
526	unsigned long long ft_hash; /* OUT: hash of attribution tag name */
527	char ft_attribution_name[ATTRIBUTION_NAME_MAX]; /* IN/OUT: attribution tag name associated with the file */
528} fattributiontag_t;
529
530/* ft_flags (F_ATTRIBUTION_TAG)*/
531#define F_CREATE_TAG  0x00000001
532#define F_DELETE_TAG  0x00000002
533#define F_QUERY_TAG   0x00000004
534
535/*
536 * For F_LOG2PHYS this information is passed back to user
537 * Currently only devoffset is returned - that is the VOP_BMAP
538 * result - the disk device address corresponding to the
539 * current file offset (likely set with an lseek).
540 *
541 * The flags could hold an indication of whether the # of
542 * contiguous bytes reflects the true extent length on disk,
543 * or is an advisory value that indicates there is at least that
544 * many bytes contiguous.  For some filesystems it might be too
545 * inefficient to provide anything beyond the advisory value.
546 * Flags and contiguous bytes return values are not yet implemented.
547 * For them the fcntl will nedd to switch from using BMAP to CMAP
548 * and a per filesystem type flag will be needed to interpret the
549 * contiguous bytes count result from CMAP.
550 *
551 * F_LOG2PHYS_EXT is a variant of F_LOG2PHYS that uses a passed in
552 * file offset and length instead of the current file offset.
553 * F_LOG2PHYS_EXT operates on the same structure as F_LOG2PHYS, but
554 * treats it as an in/out.
555 */
556#pragma pack(4)
557
558struct log2phys {
559	unsigned int    l2p_flags;       /* unused so far */
560	off_t           l2p_contigbytes; /* F_LOG2PHYS:     unused so far */
561	                                 /* F_LOG2PHYS_EXT: IN:  number of bytes to be queried */
562	                                 /*                 OUT: number of contiguous bytes at this position */
563	off_t           l2p_devoffset;   /* F_LOG2PHYS:     OUT: bytes into device */
564	                                 /* F_LOG2PHYS_EXT: IN:  bytes into file */
565	                                 /*                 OUT: bytes into device */
566};
567
568#pragma pack()
569
570#define O_POPUP    0x80000000   /* force window to popup on open */
571#define O_ALERT    0x20000000   /* small, clean popup window */
572
573#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
574
575
576#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
577
578#include <sys/_types/_filesec_t.h>
579
580typedef enum {
581	FILESEC_OWNER = 1,
582	FILESEC_GROUP = 2,
583	FILESEC_UUID = 3,
584	FILESEC_MODE = 4,
585	FILESEC_ACL = 5,
586	FILESEC_GRPUUID = 6,
587
588/* XXX these are private to the implementation */
589	FILESEC_ACL_RAW = 100,
590	FILESEC_ACL_ALLOCSIZE = 101
591} filesec_property_t;
592
593/* XXX backwards compatibility */
594#define FILESEC_GUID FILESEC_UUID
595#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
596
597__BEGIN_DECLS
598int     open(const char *, int, ...) __DARWIN_ALIAS_C(open);
599#if __DARWIN_C_LEVEL >= 200809L
600int     openat(int, const char *, int, ...) __DARWIN_NOCANCEL(openat) __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
601#endif
602int     creat(const char *, mode_t) __DARWIN_ALIAS_C(creat);
603int     fcntl(int, int, ...) __DARWIN_ALIAS_C(fcntl);
604#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
605
606int     openx_np(const char *, int, filesec_t);
607/*
608 * data-protected non-portable open(2) :
609 *  int open_dprotected_np(user_addr_t path, int flags, int class, int dpflags, int mode)
610 */
611int open_dprotected_np( const char *, int, int, int, ...);
612int openat_dprotected_np( int, const char *, int, int, int, ...);
613int openat_authenticated_np(int, const char *, int, int);
614int     flock(int, int);
615filesec_t filesec_init(void);
616filesec_t filesec_dup(filesec_t);
617void    filesec_free(filesec_t);
618int     filesec_get_property(filesec_t, filesec_property_t, void *);
619int     filesec_query_property(filesec_t, filesec_property_t, int *);
620int     filesec_set_property(filesec_t, filesec_property_t, const void *);
621int     filesec_unset_property(filesec_t, filesec_property_t) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
622#define _FILESEC_UNSET_PROPERTY ((void *)0)
623#define _FILESEC_REMOVE_ACL     ((void *)1)
624#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
625__END_DECLS
626
627
628#endif /* !_SYS_FCNTL_H_ */