1 /* 2 * Copyright (c) 2000-2022 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 132 #ifdef KERNEL 133 #define FMARK 0x00001000 /* mark during gc(), same value as O_RESOLVE_BENEATH */ 134 #define FDEFER 0x00002000 /* defer for next gc pass */ 135 #define FWASLOCKED 0x00004000 /* has or has had an advisory fcntl lock */ 136 #define FHASLOCK FWASLOCKED /* obsolete compatibility name */ 137 #endif 138 139 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 140 #define O_EVTONLY 0x00008000 /* descriptor requested for event notifications only */ 141 #endif 142 143 #ifdef KERNEL 144 #define FWASWRITTEN 0x00010000 /* descriptor was written */ 145 #endif 146 147 #define O_NOCTTY 0x00020000 /* don't assign controlling terminal */ 148 149 #ifdef KERNEL 150 #define FNOCACHE 0x00040000 /* fcntl(F_NOCACHE, 1) */ 151 #define FNORDAHEAD 0x00080000 /* fcntl(F_RDAHEAD, 0) */ 152 #endif 153 154 #if __DARWIN_C_LEVEL >= 200809L 155 #define O_DIRECTORY 0x00100000 156 #endif 157 158 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 159 #define O_SYMLINK 0x00200000 /* allow open of a symlink */ 160 #endif 161 162 // O_DSYNC 0x00400000 /* synch I/O data integrity */ 163 #include <sys/_types/_o_dsync.h> 164 165 #ifdef KERNEL 166 #define FNODIRECT 0x00800000 /* fcntl(F_NODIRECT, 1) */ 167 #endif 168 169 #if __DARWIN_C_LEVEL >= 200809L 170 #define O_CLOEXEC 0x01000000 /* implicitly set FD_CLOEXEC */ 171 #endif 172 173 #ifdef KERNEL 174 #define FENCRYPTED 0x02000000 175 #define FSINGLE_WRITER 0x04000000 /* fcntl(F_SINGLE_WRITER, 1) */ 176 #define O_CLOFORK 0x08000000 /* implicitly set FD_CLOFORK */ 177 #define FUNENCRYPTED 0x10000000 178 #endif 179 180 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL 181 #define O_NOFOLLOW_ANY 0x20000000 /* no symlinks allowed in path */ 182 #endif 183 184 #if __DARWIN_C_LEVEL >= 200809L 185 #define O_EXEC 0x40000000 /* open file for execute only */ 186 #define O_SEARCH (O_EXEC | O_DIRECTORY) /* open directory for search only */ 187 #endif 188 189 #ifdef KERNEL 190 #define FEXEC O_EXEC 191 #define FSEARCH FEXEC 192 #endif 193 194 #ifdef KERNEL 195 /* End of File status flags (fileglob::fg_flag) */ 196 #endif 197 198 #if __DARWIN_C_LEVEL >= 200809L 199 /* 200 * Descriptor value for the current working directory 201 */ 202 #define AT_FDCWD -2 203 204 /* 205 * Flags for the at functions 206 */ 207 #define AT_EACCESS 0x0010 /* Use effective ids in access check */ 208 #define AT_SYMLINK_NOFOLLOW 0x0020 /* Act on the symlink itself not the target */ 209 #define AT_SYMLINK_FOLLOW 0x0040 /* Act on target of symlink */ 210 #define AT_REMOVEDIR 0x0080 /* Path refers to directory */ 211 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL 212 #ifdef PRIVATE 213 #define AT_REMOVEDIR_DATALESS 0x0100 /* Remove a dataless directory without materializing first */ 214 #endif 215 #define AT_REALDEV 0x0200 /* Return real device inodes resides on for fstatat(2) */ 216 #define AT_FDONLY 0x0400 /* Use only the fd and Ignore the path for fstatat(2) */ 217 #define AT_SYMLINK_NOFOLLOW_ANY 0x0800 /* Path should not contain any symlinks */ 218 #ifdef PRIVATE 219 #define AT_SYSTEM_DISCARDED 0x1000 /* Indicated file/folder was discarded by system */ 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 #ifdef PRIVATE 311 #define F_OPENFROM 56 /* SPI: open a file relative to fd (must be a dir) */ 312 #define F_UNLINKFROM 57 /* SPI: open a file relative to fd (must be a dir) */ 313 #define F_CHECK_OPENEVT 58 /* SPI: if a process is marked OPENEVT, or in O_EVTONLY on opens of this vnode */ 314 #endif /* PRIVATE */ 315 316 #define F_ADDSIGS 59 /* add detached signatures */ 317 318 #ifdef PRIVATE 319 /* Deprecated/Removed in 10.9 */ 320 #define F_MARKDEPENDENCY 60 /* this process hosts the device supporting the fs backing this fd */ 321 #endif 322 323 #define F_ADDFILESIGS 61 /* add signature from same file (used by dyld for shared libs) */ 324 325 #define F_NODIRECT 62 /* used in conjunction with F_NOCACHE to indicate that DIRECT, synchonous writes */ 326 /* should not be used (i.e. its ok to temporaily create cached pages) */ 327 328 #define F_GETPROTECTIONCLASS 63 /* Get the protection class of a file from the EA, returns int */ 329 #define F_SETPROTECTIONCLASS 64 /* Set the protection class of a file for the EA, requires int */ 330 331 #define F_LOG2PHYS_EXT 65 /* file offset to device offset, extended */ 332 333 #define F_GETLKPID 66 /* See man fcntl(2) F_GETLK 334 * Similar to F_GETLK but in addition l_pid is treated as an input parameter 335 * which is used as a matching value when searching locks on the file 336 * so that only locks owned by the process with pid l_pid are returned. 337 * However, any flock(2) type lock will also be found with the returned value 338 * of l_pid set to -1 (as with F_GETLK). 339 */ 340 341 /* See F_DUPFD_CLOEXEC below for 67 */ 342 343 #ifdef PRIVATE 344 #define F_SETSTATICCONTENT 68 /* 345 * indicate to the filesystem/storage driver that the content to be 346 * written is usually static. a nonzero value enables it, 0 disables it. 347 */ 348 #define F_MOVEDATAEXTENTS 69 /* Swap only the data associated with two files */ 349 #endif 350 351 #define F_SETBACKINGSTORE 70 /* Mark the file as being the backing store for another filesystem */ 352 #define F_GETPATH_MTMINFO 71 /* return the full path of the FD, but error in specific mtmd circumstances */ 353 354 #define F_GETCODEDIR 72 /* Returns the code directory, with associated hashes, to the caller */ 355 356 #define F_SETNOSIGPIPE 73 /* No SIGPIPE generated on EPIPE */ 357 #define F_GETNOSIGPIPE 74 /* Status of SIGPIPE for this fd */ 358 359 #define F_TRANSCODEKEY 75 /* For some cases, we need to rewrap the key for AKS/MKB */ 360 361 #define F_SINGLE_WRITER 76 /* file being written to a by single writer... if throttling enabled, writes */ 362 /* may be broken into smaller chunks with throttling in between */ 363 364 #define F_GETPROTECTIONLEVEL 77 /* Get the protection version number for this filesystem */ 365 366 #define F_FINDSIGS 78 /* Add detached code signatures (used by dyld for shared libs) */ 367 368 #ifdef PRIVATE 369 #define F_GETDEFAULTPROTLEVEL 79 /* Get the default protection level for the filesystem */ 370 #define F_MAKECOMPRESSED 80 /* Make the file compressed; truncate & toggle BSD bits */ 371 #define F_SET_GREEDY_MODE 81 /* 372 * indicate to the filesystem/storage driver that the content to be 373 * written should be written in greedy mode for additional speed at 374 * the cost of storage efficiency. A nonzero value enables it, 0 disables it. 375 */ 376 377 #define F_SETIOTYPE 82 /* 378 * Use parameters to describe content being written to the FD. See 379 * flag definitions below for argument bits. 380 */ 381 #endif 382 383 #define F_ADDFILESIGS_FOR_DYLD_SIM 83 /* Add signature from same file, only if it is signed by Apple (used by dyld for simulator) */ 384 385 #ifdef PRIVATE 386 #define F_RECYCLE 84 /* Recycle vnode; debug/development builds only */ 387 #endif 388 389 #define F_BARRIERFSYNC 85 /* fsync + issue barrier to drive */ 390 391 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL 392 #define F_OFD_SETLK 90 /* Acquire or release open file description lock */ 393 #define F_OFD_SETLKW 91 /* (as F_OFD_SETLK but blocking if conflicting lock) */ 394 #define F_OFD_GETLK 92 /* Examine OFD lock */ 395 396 #define F_OFD_SETLKWTIMEOUT 93 /* (as F_OFD_SETLKW but return if timeout) */ 397 #endif 398 399 #ifdef PRIVATE 400 #define F_OFD_GETLKPID 94 /* get record locking information */ 401 402 #define F_SETCONFINED 95 /* "confine" OFD to process */ 403 #define F_GETCONFINED 96 /* is-fd-confined? */ 404 #endif 405 406 #define F_ADDFILESIGS_RETURN 97 /* Add signature from same file, return end offset in structure on success */ 407 #define F_CHECK_LV 98 /* Check if Library Validation allows this Mach-O file to be mapped into the calling process */ 408 409 #define F_PUNCHHOLE 99 /* Deallocate a range of the file */ 410 411 #define F_TRIM_ACTIVE_FILE 100 /* Trim an active file */ 412 413 #define F_SPECULATIVE_READ 101 /* Asynchronous advisory read fcntl for regular and compressed file */ 414 415 #define F_GETPATH_NOFIRMLINK 102 /* return the full path without firmlinks of the fd */ 416 417 #define F_ADDFILESIGS_INFO 103 /* Add signature from same file, return information */ 418 #define F_ADDFILESUPPL 104 /* Add supplemental signature from same file with fd reference to original */ 419 #define F_GETSIGSINFO 105 /* Look up code signature information attached to a file or slice */ 420 421 #define F_SETLEASE 106 /* Acquire or release lease */ 422 #define F_GETLEASE 107 /* Retrieve lease information */ 423 424 #define F_SETLEASE_ARG(t, oc) ((t) | ((oc) << 2)) 425 426 #ifdef PRIVATE 427 #define F_ASSERT_BG_ACCESS 108 /* Assert background access to a file */ 428 #define F_RELEASE_BG_ACCESS 109 /* Release background access to a file */ 429 #endif // PRIVATE 430 431 #define F_TRANSFEREXTENTS 110 /* Transfer allocated extents beyond leof to a different file */ 432 433 #define F_ATTRIBUTION_TAG 111 /* Based on flags, query/set/delete a file's attribution tag */ 434 #if PRIVATE 435 #define F_NOCACHE_EXT 112 /* turn data caching off/on for this fd and relax size and alignment restrictions for write */ 436 #endif 437 438 #define F_ADDSIGS_MAIN_BINARY 113 /* add detached signatures for main binary -- development only */ 439 440 // FS-specific fcntl()'s numbers begin at 0x00010000 and go up 441 #define FCNTL_FS_SPECIFIC_BASE 0x00010000 442 443 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 444 445 #if __DARWIN_C_LEVEL >= 200809L 446 #define F_DUPFD_CLOEXEC 67 /* mark the dup with FD_CLOEXEC */ 447 #endif 448 449 /* file descriptor flags (F_GETFD, F_SETFD) */ 450 #define FD_CLOEXEC 1 /* close-on-exec flag */ 451 #if PRIVATE 452 #define FD_CLOFORK 2 /* close-on-fork flag */ 453 #endif 454 455 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */ 456 #define F_RDLCK 1 /* shared or read lock */ 457 #define F_UNLCK 2 /* unlock */ 458 #define F_WRLCK 3 /* exclusive or write lock */ 459 #ifdef KERNEL 460 #define F_WAIT 0x010 /* Wait until lock is granted */ 461 #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */ 462 #define F_POSIX 0x040 /* Use POSIX semantics for lock */ 463 #define F_PROV 0x080 /* Non-coalesced provisional lock */ 464 #define F_WAKE1_SAFE 0x100 /* its safe to only wake one waiter */ 465 #define F_ABORT 0x200 /* lock attempt aborted (force umount) */ 466 #define F_OFD_LOCK 0x400 /* Use "OFD" semantics for lock */ 467 #define F_TRANSFER 0x800 /* Transfer the lock to new proc */ 468 #define F_CONFINED 0x1000 /* fileglob cannot leave curproc */ 469 #endif 470 471 #if PRIVATE 472 /* 473 * ISOCHRONOUS attempts to sustain a minimum platform-dependent throughput 474 * for the duration of the I/O delivered to the driver. 475 */ 476 #define F_IOTYPE_ISOCHRONOUS 0x0001 477 #endif 478 479 /* 480 * [XSI] The values used for l_whence shall be defined as described 481 * in <unistd.h> 482 */ 483 #include <sys/_types/_seek_set.h> 484 485 /* 486 * [XSI] The symbolic names for file modes for use as values of mode_t 487 * shall be defined as described in <sys/stat.h> 488 */ 489 #include <sys/_types/_s_ifmt.h> 490 491 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 492 /* allocate flags (F_PREALLOCATE) */ 493 494 #define F_ALLOCATECONTIG 0x00000002 /* allocate contigious space */ 495 #define F_ALLOCATEALL 0x00000004 /* allocate all requested space or no space at all */ 496 #define F_ALLOCATEPERSIST 0x00000008 /* do not free space upon close(2) */ 497 498 /* Position Modes (fst_posmode) for F_PREALLOCATE */ 499 500 #define F_PEOFPOSMODE 3 /* Make it past all of the SEEK pos modes so that */ 501 /* we can keep them in sync should we desire */ 502 #define F_VOLPOSMODE 4 /* specify volume starting postion */ 503 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 504 505 /* 506 * Advisory file segment locking data type - 507 * information passed to system by user 508 */ 509 struct flock { 510 off_t l_start; /* starting offset */ 511 off_t l_len; /* len = 0 means until end of file */ 512 pid_t l_pid; /* lock owner */ 513 short l_type; /* lock type: read/write, etc. */ 514 short l_whence; /* type of l_start */ 515 }; 516 517 #include <sys/_types/_timespec.h> 518 519 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL 520 /* 521 * Advisory file segment locking with time out - 522 * Information passed to system by user for F_SETLKWTIMEOUT 523 */ 524 struct flocktimeout { 525 struct flock fl; /* flock passed for file locking */ 526 struct timespec timeout; /* timespec struct for timeout */ 527 }; 528 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */ 529 530 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 531 /* 532 * advisory file read data type - 533 * information passed by user to system 534 */ 535 536 #ifdef KERNEL 537 #pragma pack(4) /* prevent structure padding in kernel */ 538 #endif /* KERNEL */ 539 540 struct radvisory { 541 off_t ra_offset; 542 int ra_count; 543 }; 544 545 #ifdef KERNEL 546 #pragma pack() 547 #endif /* KERNEL */ 548 549 /* 550 * detached code signatures data type - 551 * information passed by user to system used by F_ADDSIGS and F_ADDFILESIGS. 552 * F_ADDFILESIGS is a shortcut for files that contain their own signature and 553 * doesn't require mapping of the file in order to load the signature. 554 */ 555 #define USER_FSIGNATURES_CDHASH_LEN 20 556 typedef struct fsignatures { 557 off_t fs_file_start; 558 void *fs_blob_start; 559 size_t fs_blob_size; 560 561 /* The following fields are only applicable to F_ADDFILESIGS_INFO (64bit only). */ 562 /* Prior to F_ADDFILESIGS_INFO, this struct ended after fs_blob_size. */ 563 size_t fs_fsignatures_size;// input: size of this struct (for compatibility) 564 char fs_cdhash[USER_FSIGNATURES_CDHASH_LEN]; // output: cdhash 565 int fs_hash_type;// output: hash algorithm type for cdhash 566 } fsignatures_t; 567 #ifdef KERNEL 568 /* LP64 version of fsignatures. 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_fsignatures { 574 off_t fs_file_start; 575 user32_addr_t fs_blob_start; 576 user32_size_t fs_blob_size; 577 } user32_fsignatures_t; 578 579 typedef struct user_fsignatures { 580 off_t fs_file_start; /* offset of Mach-O image in FAT file */ 581 user_addr_t fs_blob_start; /* F_ADDSIGS: mem address of signature*/ 582 /* F_ADDFILESIGS: offset of signature */ 583 /* in Mach-O image */ 584 user_size_t fs_blob_size; /* size of signature blob */ 585 586 /* The following fields are only applicable to F_ADDFILESIGS_INFO. */ 587 /* Prior to F_ADDFILESIGS_INFO, this struct ended after fs_blob_size. */ 588 user_size_t fs_fsignatures_size;// input: size of this struct (for compatibility) 589 char fs_cdhash[USER_FSIGNATURES_CDHASH_LEN]; // output: cdhash 590 int fs_hash_type;//output: hash algorithm type for cdhash 591 } user_fsignatures_t; 592 #endif /* KERNEL */ 593 594 typedef struct fsupplement { 595 off_t fs_file_start; /* offset of Mach-O image in FAT file */ 596 off_t fs_blob_start; /* offset of signature in Mach-O image */ 597 size_t fs_blob_size; /* signature blob size */ 598 int fs_orig_fd; /* address of original image */ 599 } fsupplement_t; 600 601 #ifdef KERNEL 602 /* LP64 version of fsupplement. 603 * Supplements are not supported for 32 bit. 604 * WARNING - keep in sync with fsupplement. 605 */ 606 607 typedef struct user_fsupplement { 608 off_t fs_file_start; /* offset of Mach-O image in FAT file */ 609 off_t fs_blob_start; /* offset of signature in Mach-O image */ 610 size_t fs_blob_size; /* signature blob size */ 611 int fs_orig_fd; /* file descriptor to original image */ 612 } user_fsupplement_t; 613 #endif /* KERNEL */ 614 615 616 /* 617 * DYLD needs to check if the object is allowed to be combined 618 * into the main binary. This is done between the code signature 619 * is loaded and dyld is doing all the work to process the LOAD commands. 620 * 621 * While this could be done in F_ADDFILESIGS.* family the hook into 622 * the MAC module doesn't say no when LV isn't enabled and then that 623 * is cached on the vnode, and the MAC module never gets change once 624 * a process that library validation enabled. 625 */ 626 typedef struct fchecklv { 627 off_t lv_file_start; 628 size_t lv_error_message_size; 629 void *lv_error_message; 630 } fchecklv_t; 631 632 #ifdef KERNEL 633 /* LP64 version of fchecklv. all pointers 634 * grow when we're dealing with a 64-bit process. 635 * WARNING - keep in sync with fsignatures 636 */ 637 638 typedef struct user32_fchecklv { 639 user32_off_t lv_file_start; 640 user32_size_t lv_error_message_size; 641 user32_addr_t lv_error_message; 642 } user32_fchecklv_t; 643 644 typedef struct user_fchecklv { 645 off_t lv_file_start; 646 user_size_t lv_error_message_size; 647 user_addr_t lv_error_message; 648 } user_fchecklv_t; 649 650 #endif /* KERNEL */ 651 652 /* At this time F_GETSIGSINFO can only indicate platformness. 653 * As additional requestable information is defined, new keys will be added and the 654 * fgetsigsinfo_t structure will be lengthened to add space for the additional information 655 */ 656 #define GETSIGSINFO_PLATFORM_BINARY 1 657 658 /* fgetsigsinfo_t used by F_GETSIGSINFO command */ 659 typedef struct fgetsigsinfo { 660 off_t fg_file_start; /* IN: Offset in the file to look for a signature, -1 for any signature */ 661 int fg_info_request; /* IN: Key indicating the info requested */ 662 int fg_sig_is_platform; /* OUT: 1 if the signature is a plat form binary, 0 if not */ 663 } fgetsigsinfo_t; 664 665 666 /* lock operations for flock(2) */ 667 #define LOCK_SH 0x01 /* shared file lock */ 668 #define LOCK_EX 0x02 /* exclusive file lock */ 669 #define LOCK_NB 0x04 /* don't block when locking */ 670 #define LOCK_UN 0x08 /* unlock file */ 671 672 /* fstore_t type used by F_PREALLOCATE command */ 673 674 typedef struct fstore { 675 unsigned int fst_flags; /* IN: flags word */ 676 int fst_posmode; /* IN: indicates use of offset field */ 677 off_t fst_offset; /* IN: start of the region */ 678 off_t fst_length; /* IN: size of the region */ 679 off_t fst_bytesalloc; /* OUT: number of bytes allocated */ 680 } fstore_t; 681 682 /* fpunchhole_t used by F_PUNCHHOLE */ 683 typedef struct fpunchhole { 684 unsigned int fp_flags; /* unused */ 685 unsigned int reserved; /* (to maintain 8-byte alignment) */ 686 off_t fp_offset; /* IN: start of the region */ 687 off_t fp_length; /* IN: size of the region */ 688 } fpunchhole_t; 689 690 /* factive_file_trim_t used by F_TRIM_ACTIVE_FILE */ 691 typedef struct ftrimactivefile { 692 off_t fta_offset; /* IN: start of the region */ 693 off_t fta_length; /* IN: size of the region */ 694 } ftrimactivefile_t; 695 696 /* fspecread_t used by F_SPECULATIVE_READ */ 697 typedef struct fspecread { 698 unsigned int fsr_flags; /* IN: flags word */ 699 unsigned int reserved; /* to maintain 8-byte alignment */ 700 off_t fsr_offset; /* IN: start of the region */ 701 off_t fsr_length; /* IN: size of the region */ 702 } fspecread_t; 703 704 #ifdef PRIVATE 705 /* fassertbgaccess_t used by F_ASSERT_BG_ACCESS */ 706 typedef struct fassertbgaccess { 707 unsigned int fbga_flags; /* unused */ 708 unsigned int reserved; /* (to maintain 8-byte alignment) */ 709 unsigned long long ttl; /* IN: time to live for the assertion (nanoseconds; continuous) */ 710 } fassertbgaccess_t; 711 #endif // PRIVATE 712 713 /* fattributiontag_t used by F_ATTRIBUTION_TAG */ 714 #define ATTRIBUTION_NAME_MAX 255 715 typedef struct fattributiontag { 716 unsigned int ft_flags; /* IN: flags word */ 717 unsigned long long ft_hash; /* OUT: hash of attribution tag name */ 718 char ft_attribution_name[ATTRIBUTION_NAME_MAX]; /* IN/OUT: attribution tag name associated with the file */ 719 } fattributiontag_t; 720 721 /* ft_flags (F_ATTRIBUTION_TAG)*/ 722 #define F_CREATE_TAG 0x00000001 723 #define F_DELETE_TAG 0x00000002 724 #define F_QUERY_TAG 0x00000004 725 726 /* 727 * For F_LOG2PHYS this information is passed back to user 728 * Currently only devoffset is returned - that is the VOP_BMAP 729 * result - the disk device address corresponding to the 730 * current file offset (likely set with an lseek). 731 * 732 * The flags could hold an indication of whether the # of 733 * contiguous bytes reflects the true extent length on disk, 734 * or is an advisory value that indicates there is at least that 735 * many bytes contiguous. For some filesystems it might be too 736 * inefficient to provide anything beyond the advisory value. 737 * Flags and contiguous bytes return values are not yet implemented. 738 * For them the fcntl will nedd to switch from using BMAP to CMAP 739 * and a per filesystem type flag will be needed to interpret the 740 * contiguous bytes count result from CMAP. 741 * 742 * F_LOG2PHYS_EXT is a variant of F_LOG2PHYS that uses a passed in 743 * file offset and length instead of the current file offset. 744 * F_LOG2PHYS_EXT operates on the same structure as F_LOG2PHYS, but 745 * treats it as an in/out. 746 */ 747 #pragma pack(4) 748 749 struct log2phys { 750 unsigned int l2p_flags; /* unused so far */ 751 off_t l2p_contigbytes; /* F_LOG2PHYS: unused so far */ 752 /* F_LOG2PHYS_EXT: IN: number of bytes to be queried */ 753 /* OUT: number of contiguous bytes at this position */ 754 off_t l2p_devoffset; /* F_LOG2PHYS: OUT: bytes into device */ 755 /* F_LOG2PHYS_EXT: IN: bytes into file */ 756 /* OUT: bytes into device */ 757 }; 758 759 #pragma pack() 760 761 #define O_POPUP 0x80000000 /* force window to popup on open */ 762 #define O_ALERT 0x20000000 /* small, clean popup window */ 763 764 #ifdef PRIVATE 765 /* 766 * SPI: Argument data for F_OPENFROM 767 */ 768 struct fopenfrom { 769 unsigned int o_flags; /* same as open(2) */ 770 mode_t o_mode; /* same as open(2) */ 771 char * o_pathname; /* relative pathname */ 772 }; 773 774 #ifdef KERNEL 775 /* 776 * LP64 version of fopenfrom. Memory pointers 777 * grow when we're dealing with a 64-bit process. 778 * 779 * WARNING - keep in sync with fopenfrom (above) 780 */ 781 struct user32_fopenfrom { 782 unsigned int o_flags; 783 mode_t o_mode; 784 user32_addr_t o_pathname; 785 }; 786 787 struct user_fopenfrom { 788 unsigned int o_flags; 789 mode_t o_mode; 790 user_addr_t o_pathname; 791 }; 792 #endif /* KERNEL */ 793 794 #endif /* PRIVATE */ 795 796 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 797 798 #ifndef KERNEL 799 800 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 801 802 #include <sys/_types/_filesec_t.h> 803 804 typedef enum { 805 FILESEC_OWNER = 1, 806 FILESEC_GROUP = 2, 807 FILESEC_UUID = 3, 808 FILESEC_MODE = 4, 809 FILESEC_ACL = 5, 810 FILESEC_GRPUUID = 6, 811 812 /* XXX these are private to the implementation */ 813 FILESEC_ACL_RAW = 100, 814 FILESEC_ACL_ALLOCSIZE = 101 815 } filesec_property_t; 816 817 /* XXX backwards compatibility */ 818 #define FILESEC_GUID FILESEC_UUID 819 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 820 821 __BEGIN_DECLS 822 int open(const char *, int, ...) __DARWIN_ALIAS_C(open); 823 #if __DARWIN_C_LEVEL >= 200809L 824 int openat(int, const char *, int, ...) __DARWIN_NOCANCEL(openat) __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0); 825 #endif 826 int creat(const char *, mode_t) __DARWIN_ALIAS_C(creat); 827 int fcntl(int, int, ...) __DARWIN_ALIAS_C(fcntl); 828 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 829 830 #ifdef PRIVATE 831 /* 832 * These definitions are retained temporarily for compatibility. 833 * If you want to use fileports, please use 834 * #include <sys/fileport.h> 835 * or 836 * #include <System/sys/fileport.h> 837 */ 838 #ifndef _FILEPORT_T 839 #define _FILEPORT_T 840 typedef __darwin_mach_port_t fileport_t; 841 #define FILEPORT_NULL ((fileport_t)0) 842 #endif /* _FILEPORT_T */ 843 844 int fileport_makeport(int, fileport_t*); 845 int fileport_makefd(fileport_t); 846 #endif /* PRIVATE */ 847 int openx_np(const char *, int, filesec_t); 848 /* 849 * data-protected non-portable open(2) : 850 * int open_dprotected_np(user_addr_t path, int flags, int class, int dpflags, int mode) 851 */ 852 int open_dprotected_np( const char *, int, int, int, ...); 853 int openat_dprotected_np( int, const char *, int, int, int, ...); 854 int openat_authenticated_np(int, const char *, int, int); 855 int flock(int, int); 856 filesec_t filesec_init(void); 857 filesec_t filesec_dup(filesec_t); 858 void filesec_free(filesec_t); 859 int filesec_get_property(filesec_t, filesec_property_t, void *); 860 int filesec_query_property(filesec_t, filesec_property_t, int *); 861 int filesec_set_property(filesec_t, filesec_property_t, const void *); 862 int filesec_unset_property(filesec_t, filesec_property_t) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2); 863 #define _FILESEC_UNSET_PROPERTY ((void *)0) 864 #define _FILESEC_REMOVE_ACL ((void *)1) 865 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */ 866 __END_DECLS 867 #endif 868 869 #endif /* !_SYS_FCNTL_H_ */ 870