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