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