]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/sys/fcntl.h
xnu-792.22.5.tar.gz
[apple/xnu.git] / bsd / sys / fcntl.h
index 6e274f663ab3f26c4e5cd99ef7163eddde4efca3..07499ad427ef8cbbc44c76f86fa62ae3f3401a94 100644 (file)
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000-2001 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2005 Apple Computer, 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 */
 /*-
  * described by POSIX for <fcntl.h>; it also includes
  * related kernel definitions.
  */
+#include <sys/_types.h>
+#include <sys/cdefs.h>
 
-#ifndef KERNEL
-#include <sys/types.h>
+/* We should not be exporting size_t here.  Temporary for gcc bootstrapping. */
+#ifndef _SIZE_T
+#define _SIZE_T
+typedef __darwin_size_t        size_t;
+#endif
+
+#ifndef        _MODE_T
+typedef        __darwin_mode_t mode_t;
+#define _MODE_T
+#endif
+
+#ifndef _OFF_T
+typedef __darwin_off_t off_t;
+#define _OFF_T
+#endif
+
+#ifndef _PID_T
+typedef __darwin_pid_t pid_t;
+#define _PID_T
 #endif
 
 /*
  * FREAD and FWRITE are excluded from the #ifdef KERNEL so that TIOCFLUSH,
  * which was documented to use FREAD/FWRITE, continues to work.
  */
-#ifndef _POSIX_SOURCE
+#ifndef _POSIX_C_SOURCE
 #define        FREAD           0x0001
 #define        FWRITE          0x0002
 #endif
 #define        O_NONBLOCK      0x0004          /* no delay */
 #define        O_APPEND        0x0008          /* set append mode */
-#ifndef _POSIX_SOURCE
+#define        O_SYNC          0x0080          /* synchronous writes */
+#ifndef _POSIX_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         0x0080          /* synchronous writes */
+#define        O_FSYNC         O_SYNC          /* source compatibility: do not use */
 #define O_NOFOLLOW  0x0100      /* don't follow symlinks */
-#endif
+#endif /* _POSIX_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 */
 #define        FDEFER          0x2000          /* defer for next gc pass */
 #define        FHASLOCK        0x4000          /* descriptor holds advisory lock */
 #endif
+#ifndef _POSIX_C_SOURCE
+#define        O_EVTONLY       0x8000          /* descriptor requested for event notifications only */
+#endif
+
+#ifdef KERNEL
+#define        FWASWRITTEN     0x10000         /* descriptor was written */
+#endif
+
+#ifndef _POSIX_C_SOURCE
+#define O_DIRECTORY    0x100000
+#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 */
 
 #ifdef KERNEL
 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
  * and by fcntl.  We retain the F* names for the kernel f_flags field
  * and for backward compatibility for fcntl.
  */
-#ifndef _POSIX_SOURCE
+#ifndef _POSIX_C_SOURCE
 #define        FAPPEND         O_APPEND        /* kernel/compat */
 #define        FASYNC          O_ASYNC         /* kernel/compat */
 #define        FFSYNC          O_FSYNC         /* kernel */
  * Flags used for copyfile(2)
  */
 
-#ifndef _POSIX_SOURCE
+#ifndef _POSIX_C_SOURCE
 #define CPF_OVERWRITE 1
 #define CPF_IGNORE_MODE 2
 #define CPF_MASK (CPF_OVERWRITE|CPF_IGNORE_MODE)
 #define        F_SETFD         2               /* set file descriptor flags */
 #define        F_GETFL         3               /* get file status flags */
 #define        F_SETFL         4               /* set file status flags */
-#ifndef _POSIX_SOURCE
 #define        F_GETOWN        5               /* get SIGIO/SIGURG proc/pgrp */
 #define F_SETOWN       6               /* set SIGIO/SIGURG proc/pgrp */
-#endif
 #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
+#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_WRITEBOOTSTRAP 47             /* Write bootstrap on disk */
 #define F_NOCACHE       48              /* turning data caching off/on */
 #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 */
+
+// FS-specific fcntl()'s numbers begin at 0x00010000 and go up
+#define FCNTL_FS_SPECIFIC_BASE  0x00010000
+#endif /* _POSIX_C_SOURCE */
 
 /* file descriptor flags (F_GETFD, F_SETFD) */
 #define        FD_CLOEXEC      1               /* close-on-exec flag */
 #define        F_POSIX         0x040           /* Use POSIX semantics for lock */
 #endif
 
+/*
+ * [XSI] The values used for l_whence shall be defined as described
+ * in <unistd.h>
+ */
+#ifndef SEEK_SET
+#define        SEEK_SET        0       /* set file offset to offset */
+#define        SEEK_CUR        1       /* set file offset to current plus offset */
+#define        SEEK_END        2       /* set file offset to EOF plus offset */
+#endif /* !SEEK_SET */
+
+/*
+ * [XSI] The symbolic names for file modes for use as values of mode_t
+ * shall be defined as described in <sys/stat.h>
+ */
+#ifndef S_IFMT
+/* File type */
+#define        S_IFMT          0170000         /* [XSI] type of file mask */
+#define        S_IFIFO         0010000         /* [XSI] named pipe (fifo) */
+#define        S_IFCHR         0020000         /* [XSI] character special */
+#define        S_IFDIR         0040000         /* [XSI] directory */
+#define        S_IFBLK         0060000         /* [XSI] block special */
+#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 */
+#endif
+
+/* File mode */
+/* Read, write, execute/search by owner */
+#define        S_IRWXU         0000700         /* [XSI] RWX mask for owner */
+#define        S_IRUSR         0000400         /* [XSI] R for owner */
+#define        S_IWUSR         0000200         /* [XSI] W for owner */
+#define        S_IXUSR         0000100         /* [XSI] X for owner */
+/* Read, write, execute/search by group */
+#define        S_IRWXG         0000070         /* [XSI] RWX mask for group */
+#define        S_IRGRP         0000040         /* [XSI] R for group */
+#define        S_IWGRP         0000020         /* [XSI] W for group */
+#define        S_IXGRP         0000010         /* [XSI] X for group */
+/* Read, write, execute/search by others */
+#define        S_IRWXO         0000007         /* [XSI] RWX mask for other */
+#define        S_IROTH         0000004         /* [XSI] R for other */
+#define        S_IWOTH         0000002         /* [XSI] W for other */
+#define        S_IXOTH         0000001         /* [XSI] X for other */
+
+#define        S_ISUID         0004000         /* [XSI] set user id on execution */
+#define        S_ISGID         0002000         /* [XSI] set group id on execution */
+#define        S_ISVTX         0001000         /* [XSI] directory restrcted delete */
+
+#ifndef _POSIX_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 */
+#define        S_IEXEC         S_IXUSR         /* backward compatability */
+#endif
+#endif /* !S_IFMT */
+
+#ifndef _POSIX_C_SOURCE
 /* allocate flags (F_PREALLOCATE) */
 
 #define F_ALLOCATECONTIG  0x00000002    /* allocate contigious space */
 #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 */
 
 /*
  * Advisory file segment locking data type -
@@ -218,6 +326,7 @@ struct flock {
 };
 
 
+#ifndef _POSIX_C_SOURCE
 /*
  * advisory file read data type -
  * information passed by user to system
@@ -228,18 +337,16 @@ struct radvisory {
 };
 
 
-#ifndef _POSIX_SOURCE
 /* lock operations for flock(2) */
 #define        LOCK_SH         0x01            /* shared file lock */
 #define        LOCK_EX         0x02            /* exclusive file lock */
 #define        LOCK_NB         0x04            /* don't block when locking */
 #define        LOCK_UN         0x08            /* unlock file */
-#endif
 
 /*  fstore_t type used by F_DEALLOCATE and F_PREALLOCATE commands */
 
 typedef struct fstore {
-       u_int32_t fst_flags;    /* IN: flags word */
+       unsigned int fst_flags; /* IN: flags word */
        int     fst_posmode;    /* IN: indicates use of offset field */
        off_t   fst_offset;     /* IN: start of the region */
        off_t   fst_length;     /* IN: size of the region */
@@ -250,10 +357,26 @@ typedef struct fstore {
 
 typedef struct fbootstraptransfer {
   off_t fbt_offset;             /* IN: offset to start read/write */
-  size_t fbt_length;            /* IN: number of bytes to transfer */
+  size_t fbt_length;          /* IN: number of bytes to transfer */
   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
+ */
+
+typedef struct user_fbootstraptransfer {
+  off_t fbt_offset;             /* IN: offset to start read/write */
+  user_size_t fbt_length;              /* IN: number of bytes to transfer */
+  user_addr_t fbt_buffer;              /* IN: buffer to be read/written */
+} user_fbootstraptransfer_t;
+
+#endif // KERNEL
+
 /*
  * For F_LOG2PHYS this information is passed back to user
  * Currently only devoffset is returned - that is the VOP_BMAP
@@ -270,27 +393,62 @@ typedef struct fbootstraptransfer {
  * and a per filesystem type flag will be needed to interpret the
  * contiguous bytes count result from CMAP.
  */
+#pragma pack(4)
+
 struct log2phys {
-       u_int32_t       l2p_flags;              /* unused so far */
+       unsigned int    l2p_flags;              /* unused so far */
        off_t           l2p_contigbytes;        /* unused so far */
        off_t           l2p_devoffset;  /* bytes into device */
 };
 
-#ifndef _POSIX_SOURCE
+#pragma pack()
+
 #define        O_POPUP    0x80000000   /* force window to popup on open */
 #define        O_ALERT    0x20000000   /* small, clean popup window */
-#endif
+#endif /* _POSIX_C_SOURCE */
 
 #ifndef KERNEL
-#include <sys/cdefs.h>
+
+#ifndef _POSIX_C_SOURCE
+#ifndef _FILESEC_T
+struct _filesec;
+typedef struct _filesec        *filesec_t;
+#define _FILESEC_T
+#endif
+typedef enum {
+       FILESEC_OWNER = 1,
+       FILESEC_GROUP = 2,
+       FILESEC_UUID = 3,
+       FILESEC_MODE = 4,
+       FILESEC_ACL = 5,
+       FILESEC_GRPUUID = 6,
+
+/* XXX these are private to the implementation */
+       FILESEC_ACL_RAW = 100,
+       FILESEC_ACL_ALLOCSIZE = 101
+} filesec_property_t;
+
+/* XXX backwards compatibility */
+#define FILESEC_GUID FILESEC_UUID
+#endif /* _POSIX_C_SOURCE */
 
 __BEGIN_DECLS
-int    open __P((const char *, int, ...));
-int    creat __P((const char *, mode_t));
-int    fcntl __P((int, int, ...));
-#ifndef _POSIX_SOURCE
-int    flock __P((int, int));
-#endif /* !_POSIX_SOURCE */
+int    open(const char *, int, ...);
+int    creat(const char *, mode_t);
+int    fcntl(int, int, ...);
+#ifndef _POSIX_C_SOURCE
+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 *);
+#define _FILESEC_UNSET_PROPERTY        ((void *)0)
+#define _FILESEC_REMOVE_ACL    ((void *)1)
+#endif /* !_POSIX_C_SOURCE */
 __END_DECLS
 #endif