xnu-3248.40.184.tar.gz

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

diff --git a/bsd/sys/disk.h b/bsd/sys/disk.h
index 3482531079655b9d455928ce0c75ed6b4aee3bd5..6a47180167792148f8a4da970c34918a2c281d23 100644 (file)
--- a/bsd/sys/disk.h
+++ b/bsd/sys/disk.h
@@ -1,5 +1,5 @@
 /*
 /*

- * Copyright (c) 1998-2006 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2014 Apple Computer, Inc. All rights reserved.

  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 


@@ -32,13 +32,17 @@
 #include <stdint.h>
 #include <sys/ioctl.h>
 
 #include <stdint.h>
 #include <sys/ioctl.h>
 

+#ifdef XNU_KERNEL_PRIVATE
+#include <mach/boolean.h>
+#endif /* XNU_KERNEL_PRIVATE */
+

 /*
  * Definitions
  *
  * ioctl                                 description
  * ------------------------------------- ---------------------------------------
  * DKIOCEJECT                            eject media
 /*
  * Definitions
  *
  * ioctl                                 description
  * ------------------------------------- ---------------------------------------
  * DKIOCEJECT                            eject media

- * DKIOCSYNCHRONIZECACHE                 flush media
+ * DKIOCSYNCHRONIZE                      flush media

  *
  * DKIOCFORMAT                           format media
  * DKIOCGETFORMATCAPACITIES              get media's formattable capacities
  *
  * DKIOCFORMAT                           format media
  * DKIOCGETFORMATCAPACITIES              get media's formattable capacities


@@ -51,7 +55,7 @@
  * DKIOCISWRITABLE                       is media writable?
  *
  * DKIOCREQUESTIDLE                      idle media
  * DKIOCISWRITABLE                       is media writable?
  *
  * DKIOCREQUESTIDLE                      idle media

- * DKIOCDISCARD                          delete unused data
+ * DKIOCUNMAP                            delete unused data

  *
  * DKIOCGETMAXBLOCKCOUNTREAD             get maximum block count for reads
  * DKIOCGETMAXBLOCKCOUNTWRITE            get maximum block count for writes
  *
  * DKIOCGETMAXBLOCKCOUNTREAD             get maximum block count for reads
  * DKIOCGETMAXBLOCKCOUNTWRITE            get maximum block count for writes


@@ -66,16 +70,22 @@
  * DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  get minimum segment alignment in bytes
  * DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT get maximum segment width in bits
  *
  * DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  get minimum segment alignment in bytes
  * DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT get maximum segment width in bits
  *

+ * DKIOCGETFEATURES                      get device's feature set

  * DKIOCGETPHYSICALBLOCKSIZE             get device's block size
  * DKIOCGETPHYSICALBLOCKSIZE             get device's block size

+ * DKIOCGETCOMMANDPOOLSIZE               get device's queue depth

  */
 
  */
 

+#define DK_FEATURE_BARRIER                    0x00000002
+#define DK_FEATURE_PRIORITY                   0x00000004
+#define DK_FEATURE_UNMAP                      0x00000010
+
+#define DK_SYNCHRONIZE_OPTION_BARRIER         0x00000002
+

 typedef struct
 {
     uint64_t               offset;
     uint64_t               length;
 typedef struct
 {
     uint64_t               offset;
     uint64_t               length;

-
-    uint8_t                reserved0128[16];       /* reserved, clear to zero */
-} dk_discard_t;
+} dk_extent_t;

 
 typedef struct
 {
 
 typedef struct
 {


@@ -102,8 +112,55 @@ typedef struct
 #endif /* !__LP64__ */
 } dk_format_capacities_t;
 
 #endif /* !__LP64__ */
 } dk_format_capacities_t;
 

+typedef struct
+{
+    uint64_t               offset;
+    uint64_t               length;
+
+    uint32_t               options;
+
+    uint8_t                reserved0160[4];        /* reserved, clear to zero */
+} dk_synchronize_t;
+
+typedef struct
+{
+    dk_extent_t *          extents;
+    uint32_t               extentsCount;
+
+    uint32_t               options;
+
+#ifndef __LP64__
+    uint8_t                reserved0096[4];        /* reserved, clear to zero */
+#endif /* !__LP64__ */
+} dk_unmap_t;
+
+
+typedef struct
+{
+       uint64_t           flags;
+       uint64_t           hotfile_size;           /* in bytes */
+       uint64_t           hibernate_minsize;
+       uint64_t           swapfile_pinning;
+
+       uint64_t           padding[4];
+} dk_corestorage_info_t;
+
+#define DK_CORESTORAGE_PIN_YOUR_METADATA        0x00000001
+#define DK_CORESTORAGE_ENABLE_HOTFILES          0x00000002
+#define DK_CORESTORAGE_PIN_YOUR_SWAPFILE        0x00000004
+
+
+#ifdef KERNEL
+#ifdef PRIVATE
+
+/* Definitions of option bits for dk_unmap_t */
+#define _DK_UNMAP_INITIALIZE                   0x00000100
+
+#endif /* PRIVATE */
+#endif /* KERNEL */
+

 #define DKIOCEJECT                            _IO('d', 21)
 #define DKIOCEJECT                            _IO('d', 21)

-#define DKIOCSYNCHRONIZECACHE                 _IO('d', 22)
+#define DKIOCSYNCHRONIZE                      _IOW('d', 22, dk_synchronize_t)

 
 #define DKIOCFORMAT                           _IOW('d', 26, dk_format_capacity_t)
 #define DKIOCGETFORMATCAPACITIES              _IOWR('d', 26, dk_format_capacities_t)
 
 #define DKIOCFORMAT                           _IOW('d', 26, dk_format_capacity_t)
 #define DKIOCGETFORMATCAPACITIES              _IOWR('d', 26, dk_format_capacities_t)


@@ -116,7 +173,8 @@ typedef struct
 #define DKIOCISWRITABLE                       _IOR('d', 29, uint32_t)
 
 #define DKIOCREQUESTIDLE                      _IO('d', 30)
 #define DKIOCISWRITABLE                       _IOR('d', 29, uint32_t)
 
 #define DKIOCREQUESTIDLE                      _IO('d', 30)

-#define DKIOCDISCARD                          _IOW('d', 31, dk_discard_t)
+#define DKIOCUNMAP                            _IOW('d', 31, dk_unmap_t)
+#define DKIOCCORESTORAGE                      _IOR('d', 32, dk_corestorage_info_t)

 
 #define DKIOCGETMAXBLOCKCOUNTREAD             _IOR('d', 64, uint64_t)
 #define DKIOCGETMAXBLOCKCOUNTWRITE            _IOR('d', 65, uint64_t)
 
 #define DKIOCGETMAXBLOCKCOUNTREAD             _IOR('d', 64, uint64_t)
 #define DKIOCGETMAXBLOCKCOUNTWRITE            _IOR('d', 65, uint64_t)


@@ -131,17 +189,112 @@ typedef struct
 #define DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  _IOR('d', 74, uint64_t)
 #define DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT _IOR('d', 75, uint64_t)
 
 #define DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  _IOR('d', 74, uint64_t)
 #define DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT _IOR('d', 75, uint64_t)
 

+#define DKIOCGETFEATURES                      _IOR('d', 76, uint32_t)

 #define DKIOCGETPHYSICALBLOCKSIZE             _IOR('d', 77, uint32_t)
 #define DKIOCGETPHYSICALBLOCKSIZE             _IOR('d', 77, uint32_t)

+#define DKIOCGETCOMMANDPOOLSIZE               _IOR('d', 78, uint32_t)
+
+#define DKIOCSYNCHRONIZECACHE                 _IO('d', 22)

 
 #ifdef KERNEL
 
 #ifdef KERNEL

-#define DK_FEATURE_DISCARD                    0x00000010

 #define DK_FEATURE_FORCE_UNIT_ACCESS          0x00000001
 #define DK_FEATURE_FORCE_UNIT_ACCESS          0x00000001

-#define DKIOCGETBLOCKCOUNT32                  _IOR('d', 25, uint32_t)
+
+#define DK_ENCRYPTION_TYPE_AES_CBC            1
+#define DK_ENCRYPTION_TYPE_AES_XEX            2
+#define DK_ENCRYPTION_TYPE_AES_XTS            3
+
+#define DK_TIER_MASK                          0xC0
+#define DK_TIER_SHIFT                         6
+
+#define DK_TIER_TO_PRIORITY(tier)             (((tier) << DK_TIER_SHIFT) | ~DK_TIER_MASK)
+#define DK_PRIORITY_TO_TIER(priority)         ((priority) >> DK_TIER_SHIFT)
+
+typedef struct
+{
+    uint64_t               offset;
+    uint64_t               length;
+
+    uint8_t                reserved0128[12];       /* reserved, clear to zero */
+
+    dev_t                  dev;
+} dk_physical_extent_t;
+
+typedef struct
+{
+    dk_extent_t *          extents;
+    uint32_t               extentsCount;
+
+    uint8_t                tier;
+
+#ifdef __LP64__
+    uint8_t                reserved0104[3];        /* reserved, clear to zero */
+#else /* !__LP64__ */
+    uint8_t                reserved0072[7];        /* reserved, clear to zero */
+#endif /* !__LP64__ */
+} dk_set_tier_t;
+

 #define DKIOCSETBLOCKSIZE                     _IOW('d', 24, uint32_t)
 #define DKIOCGETBSDUNIT                       _IOR('d', 27, uint32_t)
 #define DKIOCSETBLOCKSIZE                     _IOW('d', 24, uint32_t)
 #define DKIOCGETBSDUNIT                       _IOR('d', 27, uint32_t)

+#define DKIOCISSOLIDSTATE                     _IOR('d', 79, uint32_t)

 #define DKIOCISVIRTUAL                        _IOR('d', 72, uint32_t)
 #define DKIOCGETBASE                          _IOR('d', 73, uint64_t)
 #define DKIOCISVIRTUAL                        _IOR('d', 72, uint32_t)
 #define DKIOCGETBASE                          _IOR('d', 73, uint64_t)

-#define DKIOCGETFEATURES                      _IOR('d', 76, uint32_t)
+#define DKIOCGETTHROTTLEMASK                  _IOR('d', 80, uint64_t)
+#define DKIOCLOCKPHYSICALEXTENTS              _IO('d', 81)
+#define DKIOCGETPHYSICALEXTENT                _IOWR('d', 82, dk_physical_extent_t)
+#define DKIOCUNLOCKPHYSICALEXTENTS            _IO('d', 83)
+#define DKIOCSETTIER                          _IOW('d', 85, dk_set_tier_t)
+#define DKIOCGETENCRYPTIONTYPE                _IOR('d', 86, uint32_t)
+#define DKIOCISLOWPOWERMODE                   _IOR('d', 87, uint32_t)
+
+#ifdef XNU_KERNEL_PRIVATE
+typedef struct
+{
+    boolean_t mi_mdev; /* Is this a memdev device? */
+    boolean_t mi_phys; /* Physical memory? */
+    uint32_t mi_base;  /* Base page number of the device? */
+    uint64_t mi_size;  /* Size of the device (in ) */
+} dk_memdev_info_t;
+
+typedef dk_memdev_info_t memdev_info_t;
+
+#define DKIOCGETMEMDEVINFO                    _IOR('d', 90, dk_memdev_info_t)
+#endif /* XNU_KERNEL_PRIVATE */
+#ifdef PRIVATE
+typedef struct _dk_cs_pin {
+       dk_extent_t     cp_extent;
+       int64_t         cp_flags;
+} _dk_cs_pin_t;
+/* The following are modifiers to _DKIOCCSPINEXTENT/cp_flags operation */
+#define _DKIOCCSPINTOFASTMEDIA          (0)                    /* Pin extent to the fast (SSD) media             */
+#define _DKIOCCSPINFORHIBERNATION       (1 << 0)       /* Pin of hibernation file, content not preserved */
+#define _DKIOCCSPINDISCARDBLACKLIST     (1 << 1)       /* Hibernation complete/error, stop blacklisting  */
+#define _DKIOCCSPINTOSLOWMEDIA          (1 << 2)       /* Pin extent to the slow (HDD) media             */
+#define _DKIOCCSTEMPORARYPIN            (1 << 3)       /* Relocate, but do not pin, to indicated media   */
+#define _DKIOCCSHIBERNATEIMGSIZE        (1 << 4)       /* Anticipate/Max size of the upcoming hibernate  */
+#define _DKIOCCSPINFORSWAPFILE          (1 << 5)       /* Pin of swap file, content not preserved        */
+
+#define _DKIOCCSSETLVNAME                     _IOW('d', 198, char[256])
+#define _DKIOCCSPINEXTENT                     _IOW('d', 199, _dk_cs_pin_t)
+#define _DKIOCCSUNPINEXTENT                   _IOW('d', 200, _dk_cs_pin_t)
+#define _DKIOCGETMIGRATIONUNITBYTESIZE        _IOR('d', 201, uint32_t)
+
+typedef struct _dk_cs_map {
+       dk_extent_t     cm_extent;
+       uint64_t        cm_bytes_mapped;
+} _dk_cs_map_t;
+
+typedef struct _dk_cs_unmap {
+       dk_extent_t                  *extents;
+       uint32_t                     extentsCount;
+       uint32_t                     options;
+} _dk_cs_unmap_t;
+
+#define _DKIOCCSMAP                           _IOWR('d', 202, _dk_cs_map_t)
+// No longer used: _DKIOCCSSETFSVNODE (203) & _DKIOCCSGETFREEBYTES (204)
+#define        _DKIOCCSUNMAP                         _IOWR('d', 205, _dk_cs_unmap_t)
+#endif /* PRIVATE */

 #endif /* KERNEL */
 
 #endif /* KERNEL */
 

+#ifdef PRIVATE
+#endif /* PRIVATE */
+

 #endif /* _SYS_DISK_H_ */
 #endif /* _SYS_DISK_H_ */