]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/sys/fsctl.h
xnu-3789.31.2.tar.gz
[apple/xnu.git] / bsd / sys / fsctl.h
index 9c7dbf7cb922cfa3cb872cf24b0961d67d477946..8f15b24ae2c6434919ac6ace1b972b0e5a10caf4 100644 (file)
@@ -1,31 +1,29 @@
 /*
- * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
+ * Copyright (c) 2000-2014 Apple Computer, Inc. All rights reserved.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
+ * 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 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.
- *
- * 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, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
- * Please see the License for the specific language governing rights and 
+ * 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, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
  * limitations under the License.
- *
- * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
+ * 
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
 /*-
 #define        _SYS_FSCTL_H_
 
 #include <sys/ioccom.h>
+#include <sys/mount.h>
+
+#ifdef XNU_KERNEL_PRIVATE
+
+/* Userland structs for namespace handler */
+typedef struct user64_namespace_handler_info {
+       user64_addr_t  token;
+       user64_addr_t  flags;
+       user64_addr_t  fdptr;
+} user64_namespace_handler_info;
+
+typedef struct user32_namespace_handler_info {
+       user32_addr_t  token;
+       user32_addr_t  flags;
+       user32_addr_t  fdptr;
+} user32_namespace_handler_info;
+
+
+/* Kernel-internal of namespace handler info */
+typedef struct namespace_handler_info {
+       user_addr_t  token;
+       user_addr_t  flags;
+       user_addr_t  fdptr;
+} namespace_handler_info;
+
+
+/* Userland structs for extended namespace handler */
+typedef struct user64_namespace_handler_info_ext {
+       user64_addr_t  token;
+       user64_addr_t  flags;
+       user64_addr_t  fdptr;
+       user64_addr_t  infoptr;
+} user64_namespace_handler_info_ext;
+
+typedef struct user32_namespace_handler_info_ext {
+       user32_addr_t  token;
+       user32_addr_t  flags;
+       user32_addr_t  fdptr;
+       user32_addr_t  infoptr;
+} user32_namespace_handler_info_ext;
+
+
+/* Kernel-internal of extended namespace handler */
+typedef struct namespace_handler_info_ext {
+       user_addr_t  token;
+       user_addr_t  flags;
+       user_addr_t  fdptr;
+       user_addr_t  infoptr;
+} namespace_handler_info_ext;
+
+/* Size-Augmented namespace_handler_info */
+/* 64 bit userland*/
+typedef struct user64_namespace_handler_data {
+       user64_addr_t token;
+       user64_addr_t flags;
+       user64_addr_t fdptr;
+       user64_addr_t infoptr;
+       user64_addr_t objid;
+       user64_addr_t reserved1;
+       user64_addr_t reserved2;
+       user64_addr_t reserved3;
+} user64_namespace_handler_data;
+
+/*32 bit userland*/
+typedef struct user32_namespace_handler_data {
+       user32_addr_t token;
+       user32_addr_t flags;
+       user32_addr_t fdptr;
+       user32_addr_t infoptr;
+       user32_addr_t objid;
+       user32_addr_t reserved1;
+       user32_addr_t reserved2;
+       user32_addr_t reserved3;
+} user32_namespace_handler_data;
+
+/* kernel-internal */
+typedef struct namespace_handler_data {
+       user_addr_t token;
+       user_addr_t flags;
+       user_addr_t fdptr;
+       user_addr_t infoptr;
+       user_addr_t objid;
+       user_addr_t reserved1;
+       user_addr_t reserved2;
+       user_addr_t reserved3;
+} namespace_handler_data;
+
+
+extern int resolve_nspace_item_ext(struct vnode *vp, uint64_t op, void *arg);
+extern int get_nspace_item_status(struct vnode *vp, int32_t *status);
+
+#else
+
+typedef struct namespace_handler_info {
+       int32_t    *token;
+       int64_t    *flags;
+       int32_t    *fdptr;
+} namespace_handler_info;
+
+typedef struct namespace_handler_info_ext {
+       int32_t    *token;
+       int64_t    *flags;
+       int32_t    *fdptr;
+       int64_t    *infoptr;     // for snapshot write events, the kernel puts an offset/length pair here
+} namespace_handler_info_ext;
+
+typedef struct namespace_handler_data {
+       int32_t *token;
+       int64_t *flags;
+       int32_t *fdptr;
+       int64_t *infoptr;     // for snapshot write events, the kernel puts an offset/length pair here
+       int64_t *objid;
+       uint32_t *reserved1;
+       uint32_t *reserved2;
+       uint32_t *reserved3;
+} namespace_handler_data;
+
+#endif /* XNU_KERNEL_PRIVATE */
+
+#ifdef KERNEL_PRIVATE
+
+#define NSPACE_REARM_NO_ARG ((void *)1)
+int resolve_nspace_item(struct vnode *vp, uint64_t op);
+int nspace_snapshot_event(vnode_t vp, time_t ctime, uint64_t op_type, void *arg);
+
+#endif // defined(KERNEL_PRIVATE)
+
+#define NAMESPACE_HANDLER_READ_OP             0x0001
+#define NAMESPACE_HANDLER_WRITE_OP            0x0002
+#define NAMESPACE_HANDLER_DELETE_OP           0x0004
+#define NAMESPACE_HANDLER_TRUNCATE_OP         0x0008
+#define NAMESPACE_HANDLER_RENAME_OP           0x0010
+#define NAMESPACE_HANDLER_METADATA_WRITE_OP   0x0020
+#define NAMESPACE_HANDLER_METADATA_DELETE_OP  0x0040
+#define NAMESPACE_HANDLER_METADATA_MOD        0x0080
+// #define NAMESPACE_HANDLER_OP_DO_NOT_USE    0x0100   // SNAPSHOT_EVENT uses this value
+#define NAMESPACE_HANDLER_LINK_CREATE         0x0200
+#define NAMESPACE_HANDLER_RENAME_SUCCESS_OP   0x0400
+#define NAMESPACE_HANDLER_RENAME_FAILED_OP    0x0800
+
+#define NAMESPACE_HANDLER_NSPACE_EVENT        0x1000
+#define NAMESPACE_HANDLER_SNAPSHOT_EVENT      0x0100
+#define NAMESPACE_HANDLER_TRACK_EVENT         0x2000
+
+#define NAMESPACE_HANDLER_EVENT_TYPE_MASK (NAMESPACE_HANDLER_NSPACE_EVENT | NAMESPACE_HANDLER_SNAPSHOT_EVENT | NAMESPACE_HANDLER_TRACK_EVENT)
+
+#define DATALESS_CMPFS_TYPE     0x80000001
+
+
+typedef int32_t nspace_handler_info[2];
+typedef char fstypename_t[MFSTYPENAMELEN];
+
+#ifdef KERNEL
+
+typedef struct user64_package_ext_info {
+    user64_addr_t strings;
+    uint32_t      num_entries;
+    uint32_t      max_width;
+} user64_package_ext_info;
+
+typedef struct user32_package_ext_info {
+    user32_addr_t strings;
+    uint32_t      num_entries;
+    uint32_t      max_width;
+} user32_package_ext_info;
+
+#endif  // KERNEL
+
+typedef struct package_ext_info {
+    const char *strings;
+    uint32_t    num_entries;
+    uint32_t    max_width;
+} package_ext_info;
+
+#define        FSCTL_SYNC_FULLSYNC     (1<<0)  /* Flush the data fully to disk, if supported by the filesystem */
+#define        FSCTL_SYNC_WAIT         (1<<1)  /* Wait for the sync to complete */
+
+
+#define FSIOC_SYNC_VOLUME                        _IOW('A', 1, uint32_t)
+#define        FSCTL_SYNC_VOLUME                         IOCBASECMD(FSIOC_SYNC_VOLUME)
+
+#define FSIOC_SET_PACKAGE_EXTS                   _IOW('A', 2, struct package_ext_info)
+#define        FSCTL_SET_PACKAGE_EXTS                    IOCBASECMD(FSIOC_SET_PACKAGE_EXTS)
+
+/* Unsupported - previously FSIOC_WAIT_FOR_SYNC */
+#define FSIOC_UNSUPPORTED                        _IOR('A', 3, int32_t)
+
+#define FSIOC_NAMESPACE_HANDLER_GET              _IOW('A', 4, struct namespace_handler_info)
+#define        FSCTL_NAMESPACE_HANDLER_GET               IOCBASECMD(FSIOC_NAMESPACE_HANDLER_GET)
+
+#define FSIOC_NAMESPACE_HANDLER_UPDATE           _IOW('A', 5, nspace_handler_info)
+#define        FSCTL_NAMESPACE_HANDLER_UPDATE            IOCBASECMD(FSIOC_NAMESPACE_HANDLER_UPDATE)
+
+#define FSIOC_NAMESPACE_HANDLER_UNBLOCK                  _IOW('A', 6, nspace_handler_info)
+#define        FSCTL_NAMESPACE_HANDLER_UNBLOCK           IOCBASECMD(FSIOC_NAMESPACE_HANDLER_UNBLOCK)
+
+#define FSIOC_NAMESPACE_HANDLER_CANCEL           _IOW('A', 7, nspace_handler_info)
+#define        FSCTL_NAMESPACE_HANDLER_CANCEL            IOCBASECMD(FSIOC_NAMESPACE_HANDLER_CANCEL)
+
+#define FSIOC_NAMESPACE_HANDLER_SET_SNAPSHOT_TIME _IOW('A', 8, int32_t)
+#define        FSCTL_NAMESPACE_HANDLER_SET_SNAPSHOT_TIME IOCBASECMD(FSIOC_NAMESPACE_HANDLER_SET_SNAPSHOT_TIME)
+
+#define FSIOC_OLD_SNAPSHOT_HANDLER_GET           _IOW('A', 9, struct namespace_handler_info)
+#define FSCTL_OLD_SNAPSHOT_HANDLER_GET           IOCBASECMD(FSIOC_OLD_SNAPSHOT_HANDLER_GET)
+
+#define FSIOC_SET_FSTYPENAME_OVERRIDE            _IOW('A', 10, fstypename_t)
+#define        FSCTL_SET_FSTYPENAME_OVERRIDE             IOCBASECMD(FSIOC_SET_FSTYPENAME_OVERRIDE)
+
+#define FSIOC_NAMESPACE_ALLOW_DMG_SNAPSHOT_EVENTS _IOW('A', 11, int32_t)
+#define        FSCTL_NAMESPACE_ALLOW_DMG_SNAPSHOT_EVENTS IOCBASECMD(FSIOC_NAMESPACE_ALLOW_DMG_SNAPSHOT_EVENTS)
+
+/* 12 was used for TRACKED_HANDLER_GET which has now been removed
+   as it is no longer used. */
+
+#define FSIOC_SNAPSHOT_HANDLER_GET_EXT           _IOW('A', 13, struct namespace_handler_info_ext)
+#define FSCTL_SNAPSHOT_HANDLER_GET_EXT           IOCBASECMD(FSIOC_SNAPSHOT_HANDLER_GET_EXT)
+
+/* 14 was used for NAMESPACE_HANDLER_GETDATA which has now been
+   removed as it is no longer used. */
+
+#define FSIOC_ROUTEFS_SETROUTEID                         _IO('A', 15)
+#define        FSCTL_ROUTEFS_SETROUTEID                          IOCBASECMD(FSIOC_ROUTEFS_SETROUTEID)
+
+//
+// IO commands 16 and 17 are currently unused
+//
+
+//
+// Spotlight and fseventsd use these fsctl()'s to find out 
+// the mount time of a volume and the last time it was 
+// unmounted.  Both HFS and ZFS support these calls.
+//
+// User space code should pass the "_IOC_" macros while the 
+// kernel should test for the "_FSCTL_" variant of the macro 
+// in its vnop_ioctl function.
+//
+// NOTE: the values for these defines should _not_ be changed
+//       or else it will break binary compatibility with mds
+//       and fseventsd.
+//
+#define SPOTLIGHT_IOC_GET_MOUNT_TIME             _IOR('h', 18, u_int32_t)
+#define SPOTLIGHT_FSCTL_GET_MOUNT_TIME           IOCBASECMD(SPOTLIGHT_IOC_GET_MOUNT_TIME)
+#define SPOTLIGHT_IOC_GET_LAST_MTIME             _IOR('h', 19, u_int32_t)
+#define SPOTLIGHT_FSCTL_GET_LAST_MTIME           IOCBASECMD(SPOTLIGHT_IOC_GET_LAST_MTIME)
+
 
 #ifndef KERNEL
 
 #include <sys/cdefs.h>
 
 __BEGIN_DECLS
-int    fsctl(const char *, unsigned long, void *, unsigned long);
+
+int    fsctl(const char *,unsigned long,void*,unsigned int);
+int    ffsctl(int,unsigned long,void*,unsigned int);
+
 __END_DECLS
 
 #endif /* !KERNEL */