]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/sys/fcntl.h
xnu-1699.24.8.tar.gz
[apple/xnu.git] / bsd / sys / fcntl.h
index 0519d9522b65b2aa59c62f6b06e7c4c99b0594aa..f6cbe9d5ac83153dd0c3e0cc72a04e6f81da92f3 100644 (file)
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
 /*-
@@ -71,6 +77,9 @@
  */
 #include <sys/_types.h>
 #include <sys/cdefs.h>
+#ifndef KERNEL
+#include <Availability.h>
+#endif
 
 /* We should not be exporting size_t here.  Temporary for gcc bootstrapping. */
 #ifndef _SIZE_T
@@ -114,20 +123,22 @@ typedef __darwin_pid_t    pid_t;
  * FREAD and FWRITE are excluded from the #ifdef KERNEL so that TIOCFLUSH,
  * which was documented to use FREAD/FWRITE, continues to work.
  */
-#ifndef _POSIX_C_SOURCE
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #define        FREAD           0x0001
 #define        FWRITE          0x0002
 #endif
 #define        O_NONBLOCK      0x0004          /* no delay */
 #define        O_APPEND        0x0008          /* set append mode */
-#define        O_SYNC          0x0080          /* synchronous writes */
-#ifndef _POSIX_C_SOURCE
+#ifndef O_SYNC         /* allow simultaneous inclusion of <aio.h> */
+#define        O_SYNC          0x0080          /* synch I/O file integrity */
+#endif
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #define        O_SHLOCK        0x0010          /* open with shared file lock */
 #define        O_EXLOCK        0x0020          /* open with exclusive file lock */
 #define        O_ASYNC         0x0040          /* signal pgrp when data ready */
 #define        O_FSYNC         O_SYNC          /* source compatibility: do not use */
 #define O_NOFOLLOW  0x0100      /* don't follow symlinks */
-#endif /* _POSIX_C_SOURCE */
+#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 #define        O_CREAT         0x0200          /* create if nonexistant */
 #define        O_TRUNC         0x0400          /* truncate to zero length */
 #define        O_EXCL          0x0800          /* error if already exists */
@@ -136,7 +147,7 @@ typedef __darwin_pid_t      pid_t;
 #define        FDEFER          0x2000          /* defer for next gc pass */
 #define        FHASLOCK        0x4000          /* descriptor holds advisory lock */
 #endif
-#ifndef _POSIX_C_SOURCE
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #define        O_EVTONLY       0x8000          /* descriptor requested for event notifications only */
 #endif
 
@@ -144,9 +155,29 @@ typedef __darwin_pid_t     pid_t;
 #define        FWASWRITTEN     0x10000         /* descriptor was written */
 #endif
 
-/* defined by POSIX 1003.1; BSD default, so no bit required */
-#define        O_NOCTTY        0               /* don't assign controlling terminal */
-//#define      O_SYNC  /* ??? POSIX: Write according to synchronized I/O file integrity completion */
+#define        O_NOCTTY        0x20000         /* don't assign controlling terminal */
+
+#ifdef KERNEL
+#define FNOCACHE       0x40000         /* fcntl(F_NOCACHE, 1) */
+#define FNORDAHEAD     0x80000         /* fcntl(F_RDAHEAD, 0) */
+#endif
+
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+#define O_DIRECTORY    0x100000
+#define O_SYMLINK      0x200000        /* allow open of a symlink */
+#endif
+
+#ifndef O_DSYNC                /* allow simultaneous inclusion of <aio.h> */
+#define                O_DSYNC 0x400000        /* synch I/O data integrity */
+#endif
+
+#ifdef KERNEL
+#define FNODIRECT      0x800000        /* fcntl(F_NODIRECT, 1) */
+#endif
+
+#if __DARWIN_C_LEVEL >= 200809L
+#define        O_CLOEXEC       0x1000000       /* implicitly set FD_CLOEXEC */
+#endif
 
 #ifdef KERNEL
 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
@@ -154,9 +185,9 @@ typedef __darwin_pid_t      pid_t;
 #define        OFLAGS(fflags)  ((fflags) - 1)
 
 /* bits to save after open */
-#define        FMASK           (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK)
+#define        FMASK           (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FFDSYNC|FNONBLOCK)
 /* bits settable by fcntl(F_SETFL, ...) */
-#define        FCNTLFLAGS      (FAPPEND|FASYNC|FFSYNC|FNONBLOCK)
+#define        FCNTLFLAGS      (FAPPEND|FASYNC|FFSYNC|FFDSYNC|FNONBLOCK)
 #endif
 
 /*
@@ -164,10 +195,11 @@ typedef __darwin_pid_t    pid_t;
  * and by fcntl.  We retain the F* names for the kernel f_flags field
  * and for backward compatibility for fcntl.
  */
-#ifndef _POSIX_C_SOURCE
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #define        FAPPEND         O_APPEND        /* kernel/compat */
 #define        FASYNC          O_ASYNC         /* kernel/compat */
 #define        FFSYNC          O_FSYNC         /* kernel */
+#define        FFDSYNC         O_DSYNC         /* kernel */
 #define        FNONBLOCK       O_NONBLOCK      /* kernel */
 #define        FNDELAY         O_NONBLOCK      /* compat */
 #define        O_NDELAY        O_NONBLOCK      /* compat */
@@ -177,7 +209,7 @@ typedef __darwin_pid_t      pid_t;
  * Flags used for copyfile(2)
  */
 
-#ifndef _POSIX_C_SOURCE
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #define CPF_OVERWRITE 1
 #define CPF_IGNORE_MODE 2
 #define CPF_MASK (CPF_OVERWRITE|CPF_IGNORE_MODE)
@@ -198,25 +230,64 @@ typedef __darwin_pid_t    pid_t;
 #define        F_GETLK         7               /* get record locking information */
 #define        F_SETLK         8               /* set record locking information */
 #define        F_SETLKW        9               /* F_SETLK; wait if blocked */
-#ifndef _POSIX_C_SOURCE
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+#define F_FLUSH_DATA    40
 #define F_CHKCLEAN      41              /* Used for regression test */
 #define F_PREALLOCATE   42             /* Preallocate storage */
 #define F_SETSIZE       43             /* Truncate a file without zeroing space */     
 #define F_RDADVISE      44              /* Issue an advisory read async with no copy to user */
-#define F_RDAHEAD       45              /* turn read ahead off/on */
+#define F_RDAHEAD       45              /* turn read ahead off/on for this fd */
 #define F_READBOOTSTRAP 46              /* Read bootstrap from disk */
 #define F_WRITEBOOTSTRAP 47             /* Write bootstrap on disk */
-#define F_NOCACHE       48              /* turning data caching off/on */
+#define F_NOCACHE       48              /* turn data caching off/on for this fd */
 #define F_LOG2PHYS     49              /* file offset to device offset */
 #define F_GETPATH       50              /* return the full path of the fd */
 #define F_FULLFSYNC     51             /* fsync + ask the drive to flush to the media */
 #define F_PATHPKG_CHECK 52              /* find which component (if any) is a package */
 #define F_FREEZE_FS     53              /* "freeze" all fs operations */
 #define F_THAW_FS       54              /* "thaw" all fs operations */
+#define        F_GLOBAL_NOCACHE 55             /* turn data caching off/on (globally) for this file */
+
+#ifdef PRIVATE
+#define        F_OPENFROM      56              /* SPI: open a file relative to fd (must be a dir) */
+#define        F_UNLINKFROM    57              /* SPI: open a file relative to fd (must be a dir) */
+#define        F_CHECK_OPENEVT 58              /* SPI: if a process is marked OPENEVT, or in O_EVTONLY on opens of this vnode */
+#endif /* PRIVATE */
+
+#define F_ADDSIGS      59              /* add detached signatures */
+
+#define F_MARKDEPENDENCY 60             /* this process hosts the device supporting the fs backing this fd */
+
+#define F_ADDFILESIGS  61              /* add signature from same file (used by dyld for shared libs) */
+
+#define F_NODIRECT     62              /* used in conjunction with F_NOCACHE to indicate that DIRECT, synchonous writes */
+                                        /* should not be used (i.e. its ok to temporaily create cached pages) */
+
+#define F_GETPROTECTIONCLASS   63              /* Get the protection class of a file from the EA, returns int */
+#define F_SETPROTECTIONCLASS   64              /* Set the protection class of a file for the EA, requires int */
+
+#define F_LOG2PHYS_EXT  65             /* file offset to device offset, extended */
+
+#define        F_GETLKPID              66              /* get record locking information, per-process */
+
+#ifdef PRIVATE
+#define F_MOVEDATAEXTENTS      69      /* Swap only the data associated with two files */
+#endif
+
+#define F_SETBACKINGSTORE      70      /* Mark the file as being the backing store for another filesystem */
+#define F_GETPATH_MTMINFO      71      /* return the full path of the FD, but error in specific mtmd circumstances */
+
+#define F_SETNOSIGPIPE         73      /* No SIGPIPE generated on EPIPE */
+#define F_GETNOSIGPIPE         74      /* Status of SIGPIPE for this fd */
 
 // FS-specific fcntl()'s numbers begin at 0x00010000 and go up
 #define FCNTL_FS_SPECIFIC_BASE  0x00010000
-#endif /* _POSIX_C_SOURCE */
+
+#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
+
+#if __DARWIN_C_LEVEL >= 200809L
+#define        F_DUPFD_CLOEXEC         67      /* mark the dup with FD_CLOEXEC */
+#endif
 
 /* file descriptor flags (F_GETFD, F_SETFD) */
 #define        FD_CLOEXEC      1               /* close-on-exec flag */
@@ -229,6 +300,8 @@ typedef __darwin_pid_t      pid_t;
 #define        F_WAIT          0x010           /* Wait until lock is granted */
 #define        F_FLOCK         0x020           /* Use flock(2) semantics for lock */
 #define        F_POSIX         0x040           /* Use POSIX semantics for lock */
+#define        F_PROV          0x080           /* Non-coelesced provisional lock */
+#define F_WAKE1_SAFE    0x100           /* its safe to only wake one waiter */
 #endif
 
 /*
@@ -255,9 +328,8 @@ typedef __darwin_pid_t      pid_t;
 #define        S_IFREG         0100000         /* [XSI] regular */
 #define        S_IFLNK         0120000         /* [XSI] symbolic link */
 #define        S_IFSOCK        0140000         /* [XSI] socket */
-#ifndef _POSIX_C_SOURCE
-#define        S_IFWHT         0160000         /* whiteout */
-#define S_IFXATTR      0200000         /* extended attribute */
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+#define        S_IFWHT         0160000         /* OBSOLETE: whiteout */
 #endif
 
 /* File mode */
@@ -281,7 +353,7 @@ typedef __darwin_pid_t      pid_t;
 #define        S_ISGID         0002000         /* [XSI] set group id on execution */
 #define        S_ISVTX         0001000         /* [XSI] directory restrcted delete */
 
-#ifndef _POSIX_C_SOURCE
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #define        S_ISTXT         S_ISVTX         /* sticky bit: not supported */
 #define        S_IREAD         S_IRUSR         /* backward compatability */
 #define        S_IWRITE        S_IWUSR         /* backward compatability */
@@ -289,7 +361,7 @@ typedef __darwin_pid_t      pid_t;
 #endif
 #endif /* !S_IFMT */
 
-#ifndef _POSIX_C_SOURCE
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 /* allocate flags (F_PREALLOCATE) */
 
 #define F_ALLOCATECONTIG  0x00000002    /* allocate contigious space */
@@ -300,7 +372,7 @@ typedef __darwin_pid_t      pid_t;
 #define F_PEOFPOSMODE 3                        /* Make it past all of the SEEK pos modes so that */
                                        /* we can keep them in sync should we desire */ 
 #define F_VOLPOSMODE   4               /* specify volume starting postion */
-#endif /* _POSIX_C_SOURCE */
+#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 
 /*
  * Advisory file segment locking data type -
@@ -315,16 +387,56 @@ struct flock {
 };
 
 
-#ifndef _POSIX_C_SOURCE
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 /*
  * advisory file read data type -
  * information passed by user to system
  */
+
+#ifdef KERNEL
+#pragma pack(4) /* prevent structure padding in kernel */
+#endif /* KERNEL */
+
 struct radvisory {
        off_t   ra_offset;
        int     ra_count;
 };
 
+#ifdef KERNEL
+#pragma pack()
+#endif /* KERNEL */
+
+/*
+ * detached code signatures data type -
+ * information passed by user to system used by F_ADDSIGS and F_ADDFILESIGS.
+ * F_ADDFILESIGS is a shortcut for files that contain their own signature and
+ * doesn't require mapping of the file in order to load the signature.
+ */
+typedef struct fsignatures {
+       off_t           fs_file_start;
+       void            *fs_blob_start;
+       size_t          fs_blob_size;
+} fsignatures_t;
+#ifdef KERNEL
+/* LP64 version of fsignatures.  all pointers 
+ * grow when we're dealing with a 64-bit process.
+ * WARNING - keep in sync with fsignatures
+ */
+
+typedef struct user32_fsignatures {
+       off_t           fs_file_start;
+       user32_addr_t   fs_blob_start;
+       user32_size_t   fs_blob_size;
+} user32_fsignatures_t;
+
+typedef struct user_fsignatures {
+       off_t           fs_file_start;  /* offset of Mach-O image in FAT file */
+       user_addr_t     fs_blob_start;  /* F_ADDSIGS: mem address of signature*/
+                                       /* F_ADDFILESIGS: offset of signature */
+                                       /*                in Mach-O image     */
+       user_size_t     fs_blob_size;   /* size of signature blob             */
+} user_fsignatures_t;
+#endif /* KERNEL */
 
 /* lock operations for flock(2) */
 #define        LOCK_SH         0x01            /* shared file lock */
@@ -350,17 +462,17 @@ typedef struct fbootstraptransfer {
   void *fbt_buffer;             /* IN: buffer to be read/written */
 } fbootstraptransfer_t;
 
-
-// LP64todo - should this move?
 #ifdef KERNEL
 /* LP64 version of fbootstraptransfer.  all pointers 
  * grow when we're dealing with a 64-bit process.
  * WARNING - keep in sync with fbootstraptransfer
  */
 
-#if __DARWIN_ALIGN_NATURAL
-#pragma options align=natural
-#endif
+typedef struct user32_fbootstraptransfer {
+  off_t fbt_offset;             /* IN: offset to start read/write */
+  user32_size_t fbt_length;          /* IN: number of bytes to transfer */
+  user32_addr_t fbt_buffer;             /* IN: buffer to be read/written */
+} user32_fbootstraptransfer_t;
 
 typedef struct user_fbootstraptransfer {
   off_t fbt_offset;             /* IN: offset to start read/write */
@@ -368,10 +480,6 @@ typedef struct user_fbootstraptransfer {
   user_addr_t fbt_buffer;              /* IN: buffer to be read/written */
 } user_fbootstraptransfer_t;
 
-#if __DARWIN_ALIGN_NATURAL
-#pragma options align=reset
-#endif
-
 #endif // KERNEL
 
 /*
@@ -389,28 +497,66 @@ typedef struct user_fbootstraptransfer {
  * For them the fcntl will nedd to switch from using BMAP to CMAP
  * and a per filesystem type flag will be needed to interpret the
  * contiguous bytes count result from CMAP.
+ *
+ * F_LOG2PHYS_EXT is a variant of F_LOG2PHYS that uses a passed in
+ * file offset and length instead of the current file offset.
+ * F_LOG2PHYS_EXT operates on the same structure as F_LOG2PHYS, but
+ * treats it as an in/out.
  */
-#if __DARWIN_ALIGN_POWER
-#pragma options align=power
-#endif
+#pragma pack(4)
 
 struct log2phys {
-       unsigned int    l2p_flags;              /* unused so far */
-       off_t           l2p_contigbytes;        /* unused so far */
-       off_t           l2p_devoffset;  /* bytes into device */
+       unsigned int    l2p_flags;       /* unused so far */
+       off_t           l2p_contigbytes; /* F_LOG2PHYS:     unused so far */
+                                        /* F_LOG2PHYS_EXT: IN:  number of bytes to be queried */
+                                        /*                 OUT: number of contiguous bytes at this position */
+       off_t           l2p_devoffset;   /* F_LOG2PHYS:     OUT: bytes into device */
+                                        /* F_LOG2PHYS_EXT: IN:  bytes into file */
+                                        /*                 OUT: bytes into device */
 };
 
-#if __DARWIN_ALIGN_POWER
-#pragma options align=reset
-#endif
+#pragma pack()
 
 #define        O_POPUP    0x80000000   /* force window to popup on open */
 #define        O_ALERT    0x20000000   /* small, clean popup window */
-#endif /* _POSIX_C_SOURCE */
+
+#ifdef PRIVATE
+/*
+ * SPI: Argument data for F_OPENFROM
+ */
+struct fopenfrom {
+       unsigned int    o_flags;        /* same as open(2) */
+       mode_t          o_mode;         /* same as open(2) */
+       char *          o_pathname;     /* relative pathname */
+};
+
+#ifdef KERNEL
+/*
+ * LP64 version of fopenfrom.  Memory pointers 
+ * grow when we're dealing with a 64-bit process.
+ *
+ * WARNING - keep in sync with fopenfrom (above)
+ */
+struct user32_fopenfrom {
+       unsigned int    o_flags;
+       mode_t          o_mode;
+       user32_addr_t   o_pathname;
+};
+
+struct user_fopenfrom {
+       unsigned int    o_flags;
+       mode_t          o_mode;
+       user_addr_t     o_pathname;
+};
+#endif /* KERNEL */
+
+#endif /* PRIVATE */
+
+#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 
 #ifndef KERNEL
 
-#ifndef _POSIX_C_SOURCE
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #ifndef _FILESEC_T
 struct _filesec;
 typedef struct _filesec        *filesec_t;
@@ -431,25 +577,43 @@ typedef enum {
 
 /* XXX backwards compatibility */
 #define FILESEC_GUID FILESEC_UUID
-#endif /* _POSIX_C_SOURCE */
+#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 
 __BEGIN_DECLS
-int    open(const char *, int, ...);
-int    creat(const char *, mode_t);
-int    fcntl(int, int, ...);
-#ifndef _POSIX_C_SOURCE
+int    open(const char *, int, ...) __DARWIN_ALIAS_C(open);
+int    creat(const char *, mode_t) __DARWIN_ALIAS_C(creat);
+int    fcntl(int, int, ...) __DARWIN_ALIAS_C(fcntl);
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+
+#ifdef PRIVATE
+/*
+ * These definitions are retained temporarily for compatibility.
+ * If you want to use fileports, please use
+ *     #include <sys/fileport.h>
+ * or
+ *     #include <System/sys/fileport.h>
+ */
+#ifndef _FILEPORT_T
+#define _FILEPORT_T
+typedef __darwin_mach_port_t fileport_t;
+#define FILEPORT_NULL ((fileport_t)0)
+#endif /* _FILEPORT_T */
+
+int     fileport_makeport(int, fileport_t*);
+int     fileport_makefd(fileport_t);
+#endif /* PRIVATE */
 int    openx_np(const char *, int, filesec_t);
 int    flock(int, int);
 filesec_t filesec_init(void);
 filesec_t filesec_dup(filesec_t);
 void   filesec_free(filesec_t);
 int    filesec_get_property(filesec_t, filesec_property_t, void *);
-int    filesec_set_property(filesec_t, filesec_property_t, const void *);
-int    filesec_unset_property(filesec_t, filesec_property_t);
 int    filesec_query_property(filesec_t, filesec_property_t, int *);
+int    filesec_set_property(filesec_t, filesec_property_t, const void *);
+int    filesec_unset_property(filesec_t, filesec_property_t) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
 #define _FILESEC_UNSET_PROPERTY        ((void *)0)
 #define _FILESEC_REMOVE_ACL    ((void *)1)
-#endif /* !_POSIX_C_SOURCE */
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 __END_DECLS
 #endif