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