1/* 2 * Copyright (c) 2000-2007 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 81/* We should not be exporting size_t here. Temporary for gcc bootstrapping. */ 82#ifndef _SIZE_T 83#define _SIZE_T 84typedef __darwin_size_t size_t; 85#endif 86 87#ifndef _MODE_T 88typedef __darwin_mode_t mode_t; 89#define _MODE_T 90#endif 91 92#ifndef _OFF_T 93typedef __darwin_off_t off_t; 94#define _OFF_T 95#endif 96 97#ifndef _PID_T 98typedef __darwin_pid_t pid_t; 99#define _PID_T 100#endif 101 102/* 103 * File status flags: these are used by open(2), fcntl(2). 104 * They are also used (indirectly) in the kernel file structure f_flags, 105 * which is a superset of the open/fcntl flags. Open flags and f_flags 106 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags). 107 * Open/fcntl flags begin with O_; kernel-internal flags begin with F. 108 */ 109/* open-only flags */ 110#define O_RDONLY 0x0000 /* open for reading only */ 111#define O_WRONLY 0x0001 /* open for writing only */ 112#define O_RDWR 0x0002 /* open for reading and writing */ 113#define O_ACCMODE 0x0003 /* mask for above modes */ 114 115/* 116 * Kernel encoding of open mode; separate read and write bits that are 117 * independently testable: 1 greater than the above. 118 * 119 * XXX 120 * FREAD and FWRITE are excluded from the #ifdef KERNEL so that TIOCFLUSH, 121 * which was documented to use FREAD/FWRITE, continues to work. 122 */ 123#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 124#define FREAD 0x0001 125#define FWRITE 0x0002 126#endif 127#define O_NONBLOCK 0x0004 /* no delay */ 128#define O_APPEND 0x0008 /* set append mode */ 129#define O_SYNC 0x0080 /* synchronous writes */ 130#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 131#define O_SHLOCK 0x0010 /* open with shared file lock */ 132#define O_EXLOCK 0x0020 /* open with exclusive file lock */ 133#define O_ASYNC 0x0040 /* signal pgrp when data ready */ 134#define O_FSYNC O_SYNC /* source compatibility: do not use */ 135#define O_NOFOLLOW 0x0100 /* don't follow symlinks */ 136#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 137#define O_CREAT 0x0200 /* create if nonexistant */ 138#define O_TRUNC 0x0400 /* truncate to zero length */ 139#define O_EXCL 0x0800 /* error if already exists */ 140#ifdef KERNEL 141#define FMARK 0x1000 /* mark during gc() */ 142#define FDEFER 0x2000 /* defer for next gc pass */ 143#define FHASLOCK 0x4000 /* descriptor holds advisory lock */ 144#endif 145#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 146#define O_EVTONLY 0x8000 /* descriptor requested for event notifications only */ 147#endif 148 149#ifdef KERNEL 150#define FWASWRITTEN 0x10000 /* descriptor was written */ 151#endif 152 153#define O_NOCTTY 0x20000 /* don't assign controlling terminal */ 154 155#ifdef KERNEL 156#define FNOCACHE 0x40000 /* fcntl(F_NOCACHE, 1) */ 157#define FNORDAHEAD 0x80000 /* fcntl(F_RDAHEAD, 0) */ 158#endif 159 160#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 161#define O_DIRECTORY 0x100000 162#define O_SYMLINK 0x200000 /* allow open of a symlink */ 163#endif 164 165//#define O_SYNC /* ??? POSIX: Write according to synchronized I/O file integrity completion */ 166 167#ifdef KERNEL 168/* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */ 169#define FFLAGS(oflags) ((oflags) + 1) 170#define OFLAGS(fflags) ((fflags) - 1) 171 172/* bits to save after open */ 173#define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK) 174/* bits settable by fcntl(F_SETFL, ...) */ 175#define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK) 176#endif 177 178/* 179 * The O_* flags used to have only F* names, which were used in the kernel 180 * and by fcntl. We retain the F* names for the kernel f_flags field 181 * and for backward compatibility for fcntl. 182 */ 183#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 184#define FAPPEND O_APPEND /* kernel/compat */ 185#define FASYNC O_ASYNC /* kernel/compat */ 186#define FFSYNC O_FSYNC /* kernel */ 187#define FNONBLOCK O_NONBLOCK /* kernel */ 188#define FNDELAY O_NONBLOCK /* compat */ 189#define O_NDELAY O_NONBLOCK /* compat */ 190#endif 191 192/* 193 * Flags used for copyfile(2) 194 */ 195 196#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 197#define CPF_OVERWRITE 1 198#define CPF_IGNORE_MODE 2 199#define CPF_MASK (CPF_OVERWRITE|CPF_IGNORE_MODE) 200#endif 201 202/* 203 * Constants used for fcntl(2) 204 */ 205 206/* command values */ 207#define F_DUPFD 0 /* duplicate file descriptor */ 208#define F_GETFD 1 /* get file descriptor flags */ 209#define F_SETFD 2 /* set file descriptor flags */ 210#define F_GETFL 3 /* get file status flags */ 211#define F_SETFL 4 /* set file status flags */ 212#define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */ 213#define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */ 214#define F_GETLK 7 /* get record locking information */ 215#define F_SETLK 8 /* set record locking information */ 216#define F_SETLKW 9 /* F_SETLK; wait if blocked */ 217#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 218#define F_CHKCLEAN 41 /* Used for regression test */ 219#define F_PREALLOCATE 42 /* Preallocate storage */ 220#define F_SETSIZE 43 /* Truncate a file without zeroing space */ 221#define F_RDADVISE 44 /* Issue an advisory read async with no copy to user */ 222#define F_RDAHEAD 45 /* turn read ahead off/on for this fd */ 223#define F_READBOOTSTRAP 46 /* Read bootstrap from disk */ 224#define F_WRITEBOOTSTRAP 47 /* Write bootstrap on disk */ 225#define F_NOCACHE 48 /* turn data caching off/on for this fd */ 226#define F_LOG2PHYS 49 /* file offset to device offset */ 227#define F_GETPATH 50 /* return the full path of the fd */ 228#define F_FULLFSYNC 51 /* fsync + ask the drive to flush to the media */ 229#define F_PATHPKG_CHECK 52 /* find which component (if any) is a package */ 230#define F_FREEZE_FS 53 /* "freeze" all fs operations */ 231#define F_THAW_FS 54 /* "thaw" all fs operations */ 232#define F_GLOBAL_NOCACHE 55 /* turn data caching off/on (globally) for this file */ 233 234#ifdef PRIVATE 235#define F_OPENFROM 56 /* SPI: open a file relative to fd (must be a dir) */ 236#define F_UNLINKFROM 57 /* SPI: open a file relative to fd (must be a dir) */ 237#define F_CHECK_OPENEVT 58 /* SPI: if a process is marked OPENEVT, or in O_EVTONLY on opens of this vnode */ 238#endif /* PRIVATE */ 239 240#define F_ADDSIGS 59 /* add detached signatures */ 241 242#define F_MARKDEPENDENCY 60 /* this process hosts the device supporting the fs backing this fd */ 243 244// FS-specific fcntl()'s numbers begin at 0x00010000 and go up 245#define FCNTL_FS_SPECIFIC_BASE 0x00010000 246 247#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 248 249/* file descriptor flags (F_GETFD, F_SETFD) */ 250#define FD_CLOEXEC 1 /* close-on-exec flag */ 251 252/* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */ 253#define F_RDLCK 1 /* shared or read lock */ 254#define F_UNLCK 2 /* unlock */ 255#define F_WRLCK 3 /* exclusive or write lock */ 256#ifdef KERNEL 257#define F_WAIT 0x010 /* Wait until lock is granted */ 258#define F_FLOCK 0x020 /* Use flock(2) semantics for lock */ 259#define F_POSIX 0x040 /* Use POSIX semantics for lock */ 260#define F_PROV 0x080 /* Non-coelesced provisional lock */ 261#define F_WAKE1_SAFE 0x100 /* its safe to only wake one waiter */ 262#endif 263 264/* 265 * [XSI] The values used for l_whence shall be defined as described 266 * in <unistd.h> 267 */ 268#ifndef SEEK_SET 269#define SEEK_SET 0 /* set file offset to offset */ 270#define SEEK_CUR 1 /* set file offset to current plus offset */ 271#define SEEK_END 2 /* set file offset to EOF plus offset */ 272#endif /* !SEEK_SET */ 273 274/* 275 * [XSI] The symbolic names for file modes for use as values of mode_t 276 * shall be defined as described in <sys/stat.h> 277 */ 278#ifndef S_IFMT 279/* File type */ 280#define S_IFMT 0170000 /* [XSI] type of file mask */ 281#define S_IFIFO 0010000 /* [XSI] named pipe (fifo) */ 282#define S_IFCHR 0020000 /* [XSI] character special */ 283#define S_IFDIR 0040000 /* [XSI] directory */ 284#define S_IFBLK 0060000 /* [XSI] block special */ 285#define S_IFREG 0100000 /* [XSI] regular */ 286#define S_IFLNK 0120000 /* [XSI] symbolic link */ 287#define S_IFSOCK 0140000 /* [XSI] socket */ 288#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 289#define S_IFWHT 0160000 /* whiteout */ 290#define S_IFXATTR 0200000 /* extended attribute */ 291#endif 292 293/* File mode */ 294/* Read, write, execute/search by owner */ 295#define S_IRWXU 0000700 /* [XSI] RWX mask for owner */ 296#define S_IRUSR 0000400 /* [XSI] R for owner */ 297#define S_IWUSR 0000200 /* [XSI] W for owner */ 298#define S_IXUSR 0000100 /* [XSI] X for owner */ 299/* Read, write, execute/search by group */ 300#define S_IRWXG 0000070 /* [XSI] RWX mask for group */ 301#define S_IRGRP 0000040 /* [XSI] R for group */ 302#define S_IWGRP 0000020 /* [XSI] W for group */ 303#define S_IXGRP 0000010 /* [XSI] X for group */ 304/* Read, write, execute/search by others */ 305#define S_IRWXO 0000007 /* [XSI] RWX mask for other */ 306#define S_IROTH 0000004 /* [XSI] R for other */ 307#define S_IWOTH 0000002 /* [XSI] W for other */ 308#define S_IXOTH 0000001 /* [XSI] X for other */ 309 310#define S_ISUID 0004000 /* [XSI] set user id on execution */ 311#define S_ISGID 0002000 /* [XSI] set group id on execution */ 312#define S_ISVTX 0001000 /* [XSI] directory restrcted delete */ 313 314#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 315#define S_ISTXT S_ISVTX /* sticky bit: not supported */ 316#define S_IREAD S_IRUSR /* backward compatability */ 317#define S_IWRITE S_IWUSR /* backward compatability */ 318#define S_IEXEC S_IXUSR /* backward compatability */ 319#endif 320#endif /* !S_IFMT */ 321 322#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 323/* allocate flags (F_PREALLOCATE) */ 324 325#define F_ALLOCATECONTIG 0x00000002 /* allocate contigious space */ 326#define F_ALLOCATEALL 0x00000004 /* allocate all requested space or no space at all */ 327 328/* Position Modes (fst_posmode) for F_PREALLOCATE */ 329 330#define F_PEOFPOSMODE 3 /* Make it past all of the SEEK pos modes so that */ 331 /* we can keep them in sync should we desire */ 332#define F_VOLPOSMODE 4 /* specify volume starting postion */ 333#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 334 335/* 336 * Advisory file segment locking data type - 337 * information passed to system by user 338 */ 339struct flock { 340 off_t l_start; /* starting offset */ 341 off_t l_len; /* len = 0 means until end of file */ 342 pid_t l_pid; /* lock owner */ 343 short l_type; /* lock type: read/write, etc. */ 344 short l_whence; /* type of l_start */ 345}; 346 347 348#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 349/* 350 * advisory file read data type - 351 * information passed by user to system 352 */ 353struct radvisory { 354 off_t ra_offset; 355 int ra_count; 356}; 357 358/* 359 * detached code signatures data type - 360 * information passed by user to system 361 * used by F_ADDSIGS 362 */ 363typedef struct fsignatures { 364 off_t fs_file_start; 365 void *fs_blob_start; 366 size_t fs_blob_size; 367} fsignatures_t; 368#ifdef KERNEL 369/* LP64 version of fsignatures. all pointers 370 * grow when we're dealing with a 64-bit process. 371 * WARNING - keep in sync with fsignatures 372 */ 373typedef struct user_fsignatures { 374 off_t fs_file_start; 375 user_addr_t fs_blob_start; 376 user_size_t fs_blob_size; 377} user_fsignatures_t; 378#endif /* KERNEL */ 379 380/* lock operations for flock(2) */ 381#define LOCK_SH 0x01 /* shared file lock */ 382#define LOCK_EX 0x02 /* exclusive file lock */ 383#define LOCK_NB 0x04 /* don't block when locking */ 384#define LOCK_UN 0x08 /* unlock file */ 385 386/* fstore_t type used by F_DEALLOCATE and F_PREALLOCATE commands */ 387 388typedef struct fstore { 389 unsigned int fst_flags; /* IN: flags word */ 390 int fst_posmode; /* IN: indicates use of offset field */ 391 off_t fst_offset; /* IN: start of the region */ 392 off_t fst_length; /* IN: size of the region */ 393 off_t fst_bytesalloc; /* OUT: number of bytes allocated */ 394} fstore_t; 395 396/* fbootstraptransfer_t used by F_READBOOTSTRAP and F_WRITEBOOTSTRAP commands */ 397 398typedef struct fbootstraptransfer { 399 off_t fbt_offset; /* IN: offset to start read/write */ 400 size_t fbt_length; /* IN: number of bytes to transfer */ 401 void *fbt_buffer; /* IN: buffer to be read/written */ 402} fbootstraptransfer_t; 403 404 405#ifdef KERNEL 406/* LP64 version of fbootstraptransfer. all pointers 407 * grow when we're dealing with a 64-bit process. 408 * WARNING - keep in sync with fbootstraptransfer 409 */ 410 411typedef struct user_fbootstraptransfer { 412 off_t fbt_offset; /* IN: offset to start read/write */ 413 user_size_t fbt_length; /* IN: number of bytes to transfer */ 414 user_addr_t fbt_buffer; /* IN: buffer to be read/written */ 415} user_fbootstraptransfer_t; 416 417#endif // KERNEL 418 419/* 420 * For F_LOG2PHYS this information is passed back to user 421 * Currently only devoffset is returned - that is the VOP_BMAP 422 * result - the disk device address corresponding to the 423 * current file offset (likely set with an lseek). 424 * 425 * The flags could hold an indication of whether the # of 426 * contiguous bytes reflects the true extent length on disk, 427 * or is an advisory value that indicates there is at least that 428 * many bytes contiguous. For some filesystems it might be too 429 * inefficient to provide anything beyond the advisory value. 430 * Flags and contiguous bytes return values are not yet implemented. 431 * For them the fcntl will nedd to switch from using BMAP to CMAP 432 * and a per filesystem type flag will be needed to interpret the 433 * contiguous bytes count result from CMAP. 434 */ 435#pragma pack(4) 436 437struct log2phys { 438 unsigned int l2p_flags; /* unused so far */ 439 off_t l2p_contigbytes; /* unused so far */ 440 off_t l2p_devoffset; /* bytes into device */ 441}; 442 443#pragma pack() 444 445#define O_POPUP 0x80000000 /* force window to popup on open */ 446#define O_ALERT 0x20000000 /* small, clean popup window */ 447 448#ifdef PRIVATE 449/* 450 * SPI: Argument data for F_OPENFROM 451 */ 452struct fopenfrom { 453 unsigned int o_flags; /* same as open(2) */ 454 mode_t o_mode; /* same as open(2) */ 455 char * o_pathname; /* relative pathname */ 456}; 457 458#ifdef KERNEL 459/* 460 * LP64 version of fopenfrom. Memory pointers 461 * grow when we're dealing with a 64-bit process. 462 * 463 * WARNING - keep in sync with fopenfrom (above) 464 */ 465struct user_fopenfrom { 466 unsigned int o_flags; 467 mode_t o_mode; 468 user_addr_t o_pathname; 469}; 470#endif /* KERNEL */ 471 472#endif /* PRIVATE */ 473 474#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 475 476#ifndef KERNEL 477 478#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 479#ifndef _FILESEC_T 480struct _filesec; 481typedef struct _filesec *filesec_t; 482#define _FILESEC_T 483#endif 484typedef enum { 485 FILESEC_OWNER = 1, 486 FILESEC_GROUP = 2, 487 FILESEC_UUID = 3, 488 FILESEC_MODE = 4, 489 FILESEC_ACL = 5, 490 FILESEC_GRPUUID = 6, 491 492/* XXX these are private to the implementation */ 493 FILESEC_ACL_RAW = 100, 494 FILESEC_ACL_ALLOCSIZE = 101 495} filesec_property_t; 496 497/* XXX backwards compatibility */ 498#define FILESEC_GUID FILESEC_UUID 499#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 500 501__BEGIN_DECLS 502int open(const char *, int, ...) __DARWIN_ALIAS_C(open); 503int creat(const char *, mode_t) __DARWIN_ALIAS_C(creat); 504int fcntl(int, int, ...) __DARWIN_ALIAS_C(fcntl); 505#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 506int openx_np(const char *, int, filesec_t); 507int flock(int, int); 508filesec_t filesec_init(void); 509filesec_t filesec_dup(filesec_t); 510void filesec_free(filesec_t); 511int filesec_get_property(filesec_t, filesec_property_t, void *); 512int filesec_set_property(filesec_t, filesec_property_t, const void *); 513int filesec_query_property(filesec_t, filesec_property_t, int *); 514#define _FILESEC_UNSET_PROPERTY ((void *)0) 515#define _FILESEC_REMOVE_ACL ((void *)1) 516#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */ 517__END_DECLS 518#endif 519 520#endif /* !_SYS_FCNTL_H_ */ 521