xnu-6153.81.5.tar.gz

[apple/xnu.git] / bsd / sys / fsctl.h

diff --git a/bsd/sys/fsctl.h b/bsd/sys/fsctl.h
index c99d47ba716c2e0b97d46617495081e9d22b5399..3c2c3783cf9b58e0449c72547a38ef4b837c7edd 100644 (file)
--- a/bsd/sys/fsctl.h
+++ b/bsd/sys/fsctl.h
@@ -2,7 +2,7 @@
  * Copyright (c) 2000-2014 Apple Computer, Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * Copyright (c) 2000-2014 Apple Computer, Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_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
  * 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


@@ -11,10 +11,10 @@
  * 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.
  * 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.
  * 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,
  * 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,


@@ -22,7 +22,7 @@
  * 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.
  * 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_OSREFERENCE_LICENSE_HEADER_END@
  */
 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */


@@ -66,8 +66,8 @@
  *     @(#)fsctl.h     8.6 (Berkeley) 3/28/94
  */
 
  *     @(#)fsctl.h     8.6 (Berkeley) 3/28/94
  */
 

-#ifndef        _SYS_FSCTL_H_
-#define        _SYS_FSCTL_H_
+#ifndef _SYS_FSCTL_H_
+#define _SYS_FSCTL_H_

 
 #include <sys/ioccom.h>
 #include <sys/mount.h>
 
 #include <sys/ioccom.h>
 #include <sys/mount.h>


@@ -158,10 +158,7 @@ typedef struct namespace_handler_data {
 } namespace_handler_data;
 
 
 } namespace_handler_data;
 
 

-#define NSPACE_REARM_NO_ARG ((void *)1)
-extern int resolve_nspace_item(struct vnode *vp, uint64_t op);

 extern int resolve_nspace_item_ext(struct vnode *vp, uint64_t op, void *arg);
 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
 
 
 #else
 


@@ -191,6 +188,14 @@ typedef struct namespace_handler_data {
 
 #endif /* XNU_KERNEL_PRIVATE */
 
 
 #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_READ_OP             0x0001
 #define NAMESPACE_HANDLER_WRITE_OP            0x0002
 #define NAMESPACE_HANDLER_DELETE_OP           0x0004


@@ -210,8 +215,6 @@ typedef struct namespace_handler_data {
 
 #define NAMESPACE_HANDLER_EVENT_TYPE_MASK (NAMESPACE_HANDLER_NSPACE_EVENT | NAMESPACE_HANDLER_SNAPSHOT_EVENT | NAMESPACE_HANDLER_TRACK_EVENT)
 
 
 #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];
 
 typedef int32_t nspace_handler_info[2];
 typedef char fstypename_t[MFSTYPENAMELEN];


@@ -219,93 +222,139 @@ typedef char fstypename_t[MFSTYPENAMELEN];
 #ifdef KERNEL
 
 typedef struct user64_package_ext_info {
 #ifdef KERNEL
 
 typedef struct user64_package_ext_info {

-    user64_addr_t strings;
-    uint32_t      num_entries;
-    uint32_t      max_width;
+       user64_addr_t strings;
+       uint32_t      num_entries;
+       uint32_t      max_width;

 } user64_package_ext_info;
 
 typedef struct user32_package_ext_info {
 } user64_package_ext_info;
 
 typedef struct user32_package_ext_info {

-    user32_addr_t strings;
-    uint32_t      num_entries;
-    uint32_t      max_width;
+       user32_addr_t strings;
+       uint32_t      num_entries;
+       uint32_t      max_width;

 } user32_package_ext_info;
 
 #endif  // KERNEL
 
 typedef struct package_ext_info {
 } user32_package_ext_info;
 
 #endif  // KERNEL
 
 typedef struct package_ext_info {

-    const char *strings;
-    uint32_t    num_entries;
-    uint32_t    max_width;
+       const char *strings;
+       uint32_t    num_entries;
+       uint32_t    max_width;

 } package_ext_info;
 
 } 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 */
+/* Disk conditioner configuration */
+typedef struct disk_conditioner_info {
+       int enabled;
+       uint64_t access_time_usec; // maximum latency until transfer begins
+       uint64_t read_throughput_mbps; // maximum throughput for reads
+       uint64_t write_throughput_mbps; // maximum throughput for writes
+       int is_ssd; // behave like an SSD
+
+       /* revision 2 */
+       uint32_t ioqueue_depth;
+       uint32_t maxreadcnt;
+       uint32_t maxwritecnt;
+       uint32_t segreadcnt;
+       uint32_t segwritecnt;
+} disk_conditioner_info;

 
 

+/*
+ * BSD flags manipulation arguments.
+ *
+ * This provides a safe way to update the BSD flags field of an inode,
+ * which has some user components as well as some system components.
+ * What it provides is a compare-and-swap operation, whereby the caller
+ * fetches what the expected flags are, computes the new set, and then
+ * provides the old along with the new.  If the old that's provided matches
+ * what's actually in the inode, the new value is set.  The actual inode
+ * value is returned to the caller, and expected == actual is how the
+ * caller can determine that the operation succeeded.
+ *
+ * Some BSD flags (e.g. UF_COMPRESSED) can only be manipulated via this
+ * safe mechanism.
+ */
+struct fsioc_cas_bsdflags {
+       uint32_t expected_flags;        /* [IN] expected flags */
+       uint32_t new_flags;             /* [IN] new value to set */
+       uint32_t actual_flags;          /* [OUT] the actual flags in inode */
+};

 
 

-#define FSIOC_SYNC_VOLUME                        _IOW('A', 1, uint32_t)
-#define        FSCTL_SYNC_VOLUME                         IOCBASECMD(FSIOC_SYNC_VOLUME)
+#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_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_SYNC_VOLUME                         _IOW('A', 1, uint32_t)
+#define FSCTL_SYNC_VOLUME                         IOCBASECMD(FSIOC_SYNC_VOLUME)

 
 

-#define FSIOC_NAMESPACE_HANDLER_GET              _IOW('A', 4, struct namespace_handler_info)
-#define        FSCTL_NAMESPACE_HANDLER_GET               IOCBASECMD(FSIOC_NAMESPACE_HANDLER_GET)
+#define FSIOC_SET_PACKAGE_EXTS                    _IOW('A', 2, struct package_ext_info)
+#define FSCTL_SET_PACKAGE_EXTS                    IOCBASECMD(FSIOC_SET_PACKAGE_EXTS)

 
 

-#define FSIOC_NAMESPACE_HANDLER_UPDATE           _IOW('A', 5, nspace_handler_info)
-#define        FSCTL_NAMESPACE_HANDLER_UPDATE            IOCBASECMD(FSIOC_NAMESPACE_HANDLER_UPDATE)
+/* Unsupported - previously FSIOC_WAIT_FOR_SYNC */
+#define FSIOC_UNSUPPORTED                         _IOR('A', 3, int32_t)

 
 

-#define FSIOC_NAMESPACE_HANDLER_UNBLOCK                  _IOW('A', 6, nspace_handler_info)
-#define        FSCTL_NAMESPACE_HANDLER_UNBLOCK           IOCBASECMD(FSIOC_NAMESPACE_HANDLER_UNBLOCK)
+/* 4 - 9 was used for NAMESPACE handler operation to support dataless file faults
+ * no and no longer user */

 
 

-#define FSIOC_NAMESPACE_HANDLER_CANCEL           _IOW('A', 7, nspace_handler_info)
-#define        FSCTL_NAMESPACE_HANDLER_CANCEL            IOCBASECMD(FSIOC_NAMESPACE_HANDLER_CANCEL)
+#define FSIOC_SET_FSTYPENAME_OVERRIDE             _IOW('A', 10, fstypename_t)
+#define FSCTL_SET_FSTYPENAME_OVERRIDE             IOCBASECMD(FSIOC_SET_FSTYPENAME_OVERRIDE)

 
 

-#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)
+/* 12 was used for TRACKED_HANDLER_GET which has now been removed
+ *  as it is no longer used. */

 
 

-#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)
+/* 13 was used for FSIOC_SNAPSHOT_HANDLER_GET_EXT and now been removed */

 
 

-#define FSIOC_SET_FSTYPENAME_OVERRIDE            _IOW('A', 10, fstypename_t)
-#define        FSCTL_SET_FSTYPENAME_OVERRIDE             IOCBASECMD(FSIOC_SET_FSTYPENAME_OVERRIDE)
+/* 14 was used for NAMESPACE_HANDLER_GETDATA which has now been
+ *  removed as it is no longer used. */

 
 

-#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)
+#define FSIOC_ROUTEFS_SETROUTEID                          _IO('A', 15)
+#define FSCTL_ROUTEFS_SETROUTEID                          IOCBASECMD(FSIOC_ROUTEFS_SETROUTEID)

 
 

-/* 12 was used for TRACKED_HANDLER_GET which has now been removed
-   as it is no longer used. */
+/* ioctls to support SEEK_HOLE SEEK_DATA */
+#define FSIOC_FIOSEEKHOLE                                         _IOWR('A', 16, off_t)
+#define FSCTL_FIOSEEKHOLE                                         IOCBASECMD(FSIOC_FIOSEEKHOLE)
+#define FSIOC_FIOSEEKDATA                                         _IOWR('A', 17, off_t)
+#define FSCTL_FIOSEEKDATA                                         IOCBASECMD(FSIOC_FIOSEEKDATA)

 
 

-#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)
+/* Disk conditioner */
+#define DISK_CONDITIONER_IOC_GET                  _IOR('A', 18, disk_conditioner_info)
+#define DISK_CONDITIONER_FSCTL_GET                IOCBASECMD(DISK_CONDITIONER_IOC_GET)
+#define DISK_CONDITIONER_IOC_SET                  _IOW('A', 19, disk_conditioner_info)
+#define DISK_CONDITIONER_FSCTL_SET                IOCBASECMD(DISK_CONDITIONER_IOC_SET)

 
 

-/* 14 was used for NAMESPACE_HANDLER_GETDATA which has now been
-   removed as it is no longer used. */
+/* Set the value of a file's BSD flags in a safe way. */
+#define FSIOC_CAS_BSDFLAGS      _IOWR('A', 20, struct fsioc_cas_bsdflags)

 
 

-//
-// IO commands 15, 16, and 17 are currently unused
-//
+/* Check if a file is only open once (pass zero for the extra arg) */
+#define FSIOC_FD_ONLY_OPEN_ONCE _IOWR('A', 21, uint32_t)

 
 //
 
 //

-// 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.
+// 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 APFS support these calls.

 //
 // NOTE: the values for these defines should _not_ be changed
 //       or else it will break binary compatibility with mds
 //       and fseventsd.
 //
 //
 // 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)
+#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)
+
+/* Mark file's extents as "frozen" because someone has references to physical address */
+#define FSIOC_FREEZE_EXTENTS                            _IO('h', 20)
+#define FSCTL_FREEZE_EXTENTS                            IOCBASECMD(FSIOC_FREEZE_EXTENTS)
+
+/* Clear the "frozen" status of file's extents */
+#define FSIOC_THAW_EXTENTS                              _IO('h', 21)
+#define FSCTL_THAW_EXTENTS                              IOCBASECMD(FSIOC_THAW_EXTENTS)
+
+/* this FSCTL selector is duplicated in XNU with the intent of making the VFS/generic one the only one eventually */
+#define FIRMLINK_STRUCT_LEN 1032
+typedef struct generic_firmlink {
+       uint8_t array[FIRMLINK_STRUCT_LEN];
+} generic_firmlink_t;

 
 

+#define FSIOC_FIRMLINK_CTL _IOWR ('J', 60, generic_firmlink_t)

 
 #ifndef KERNEL
 
 
 #ifndef KERNEL
 


@@ -313,8 +362,8 @@ typedef struct package_ext_info {
 
 __BEGIN_DECLS
 
 
 __BEGIN_DECLS
 

-int    fsctl(const char *,unsigned long,void*,unsigned int);
-int    ffsctl(int,unsigned long,void*,unsigned int);
+int     fsctl(const char *, unsigned long, void*, unsigned int);
+int     ffsctl(int, unsigned long, void*, unsigned int);

 
 __END_DECLS
 
 
 __END_DECLS