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