bsd/sys/disk.h

   1 /*
   2  * Copyright (c) 1998-2014 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #ifndef _SYS_DISK_H_
  30 #define _SYS_DISK_H_
  31
  32 #include <stdint.h>
  33 #include <sys/ioctl.h>
  34
  35 #ifdef XNU_KERNEL_PRIVATE
  36 #include <mach/boolean.h>
  37 #endif /* XNU_KERNEL_PRIVATE */
  38
  39 /*
  40  * Definitions
  41  *
  42  * ioctl                                 description
  43  * ------------------------------------- ---------------------------------------
  44  * DKIOCEJECT                            eject media
  45  * DKIOCSYNCHRONIZE                      flush media
  46  *
  47  * DKIOCFORMAT                           format media
  48  * DKIOCGETFORMATCAPACITIES              get media's formattable capacities
  49  *
  50  * DKIOCGETBLOCKSIZE                     get media's block size
  51  * DKIOCGETBLOCKCOUNT                    get media's block count
  52  * DKIOCGETFIRMWAREPATH                  get media's firmware path
  53  *
  54  * DKIOCISFORMATTED                      is media formatted?
  55  * DKIOCISWRITABLE                       is media writable?
  56  *
  57  * DKIOCREQUESTIDLE                      idle media
  58  * DKIOCUNMAP                            delete unused data
  59  *
  60  * DKIOCGETMAXBLOCKCOUNTREAD             get maximum block count for reads
  61  * DKIOCGETMAXBLOCKCOUNTWRITE            get maximum block count for writes
  62  * DKIOCGETMAXBYTECOUNTREAD              get maximum byte count for reads
  63  * DKIOCGETMAXBYTECOUNTWRITE             get maximum byte count for writes
  64  *
  65  * DKIOCGETMAXSEGMENTCOUNTREAD           get maximum segment count for reads
  66  * DKIOCGETMAXSEGMENTCOUNTWRITE          get maximum segment count for writes
  67  * DKIOCGETMAXSEGMENTBYTECOUNTREAD       get maximum segment byte count for reads
  68  * DKIOCGETMAXSEGMENTBYTECOUNTWRITE      get maximum segment byte count for writes
  69  *
  70  * DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  get minimum segment alignment in bytes
  71  * DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT get maximum segment width in bits
  72  *
  73  * DKIOCGETFEATURES                      get device's feature set
  74  * DKIOCGETPHYSICALBLOCKSIZE             get device's block size
  75  * DKIOCGETCOMMANDPOOLSIZE               get device's queue depth
  76  */
  77
  78 #define DK_FEATURE_BARRIER                    0x00000002
  79 #define DK_FEATURE_PRIORITY                   0x00000004
  80 #define DK_FEATURE_UNMAP                      0x00000010
  81
  82 #define DK_SYNCHRONIZE_OPTION_BARRIER         0x00000002
  83
  84 typedef struct
  85 {
  86     uint64_t               offset;
  87     uint64_t               length;
  88 } dk_extent_t;
  89
  90 typedef struct
  91 {
  92     char                   path[128];
  93 } dk_firmware_path_t;
  94
  95 typedef struct
  96 {
  97     uint64_t               blockCount;
  98     uint32_t               blockSize;
  99
 100     uint8_t                reserved0096[4];        /* reserved, clear to zero */
 101 } dk_format_capacity_t;
 102
 103 typedef struct
 104 {
 105     dk_format_capacity_t * capacities;
 106     uint32_t               capacitiesCount;        /* use zero to probe count */
 107
 108 #ifdef __LP64__
 109     uint8_t                reserved0096[4];        /* reserved, clear to zero */
 110 #else /* !__LP64__ */
 111     uint8_t                reserved0064[8];        /* reserved, clear to zero */
 112 #endif /* !__LP64__ */
 113 } dk_format_capacities_t;
 114
 115 typedef struct
 116 {
 117     uint64_t               offset;
 118     uint64_t               length;
 119
 120     uint32_t               options;
 121
 122     uint8_t                reserved0160[4];        /* reserved, clear to zero */
 123 } dk_synchronize_t;
 124
 125 typedef struct
 126 {
 127     dk_extent_t *          extents;
 128     uint32_t               extentsCount;
 129
 130     uint32_t               options;
 131
 132 #ifndef __LP64__
 133     uint8_t                reserved0096[4];        /* reserved, clear to zero */
 134 #endif /* !__LP64__ */
 135 } dk_unmap_t;
 136
 137
 138 typedef struct
 139 {
 140         uint64_t           flags;
 141         uint64_t           hotfile_size;           /* in bytes */
 142         uint64_t           hibernate_minsize;
 143         uint64_t           swapfile_pinning;
 144
 145         uint64_t           padding[4];
 146 } dk_corestorage_info_t;
 147
 148 #define DK_CORESTORAGE_PIN_YOUR_METADATA        0x00000001
 149 #define DK_CORESTORAGE_ENABLE_HOTFILES          0x00000002
 150 #define DK_CORESTORAGE_PIN_YOUR_SWAPFILE        0x00000004
 151
 152
 153 #ifdef KERNEL
 154 #ifdef PRIVATE
 155
 156 /* Definitions of option bits for dk_unmap_t */
 157 #define _DK_UNMAP_INITIALIZE                   0x00000100
 158
 159 #endif /* PRIVATE */
 160 #endif /* KERNEL */
 161
 162 #define DKIOCEJECT                            _IO('d', 21)
 163 #define DKIOCSYNCHRONIZE                      _IOW('d', 22, dk_synchronize_t)
 164
 165 #define DKIOCFORMAT                           _IOW('d', 26, dk_format_capacity_t)
 166 #define DKIOCGETFORMATCAPACITIES              _IOWR('d', 26, dk_format_capacities_t)
 167
 168 #define DKIOCGETBLOCKSIZE                     _IOR('d', 24, uint32_t)
 169 #define DKIOCGETBLOCKCOUNT                    _IOR('d', 25, uint64_t)
 170 #define DKIOCGETFIRMWAREPATH                  _IOR('d', 28, dk_firmware_path_t)
 171
 172 #define DKIOCISFORMATTED                      _IOR('d', 23, uint32_t)
 173 #define DKIOCISWRITABLE                       _IOR('d', 29, uint32_t)
 174
 175 #define DKIOCREQUESTIDLE                      _IO('d', 30)
 176 #define DKIOCUNMAP                            _IOW('d', 31, dk_unmap_t)
 177 #define DKIOCCORESTORAGE                      _IOR('d', 32, dk_corestorage_info_t)
 178
 179 #define DKIOCGETMAXBLOCKCOUNTREAD             _IOR('d', 64, uint64_t)
 180 #define DKIOCGETMAXBLOCKCOUNTWRITE            _IOR('d', 65, uint64_t)
 181 #define DKIOCGETMAXBYTECOUNTREAD              _IOR('d', 70, uint64_t)
 182 #define DKIOCGETMAXBYTECOUNTWRITE             _IOR('d', 71, uint64_t)
 183
 184 #define DKIOCGETMAXSEGMENTCOUNTREAD           _IOR('d', 66, uint64_t)
 185 #define DKIOCGETMAXSEGMENTCOUNTWRITE          _IOR('d', 67, uint64_t)
 186 #define DKIOCGETMAXSEGMENTBYTECOUNTREAD       _IOR('d', 68, uint64_t)
 187 #define DKIOCGETMAXSEGMENTBYTECOUNTWRITE      _IOR('d', 69, uint64_t)
 188
 189 #define DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  _IOR('d', 74, uint64_t)
 190 #define DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT _IOR('d', 75, uint64_t)
 191
 192 #define DKIOCGETFEATURES                      _IOR('d', 76, uint32_t)
 193 #define DKIOCGETPHYSICALBLOCKSIZE             _IOR('d', 77, uint32_t)
 194 #define DKIOCGETCOMMANDPOOLSIZE               _IOR('d', 78, uint32_t)
 195
 196 #define DKIOCSYNCHRONIZECACHE                 _IO('d', 22)
 197
 198 #ifdef KERNEL
 199 #define DK_FEATURE_FORCE_UNIT_ACCESS          0x00000001
 200
 201 #define DK_ENCRYPTION_TYPE_AES_CBC            1
 202 #define DK_ENCRYPTION_TYPE_AES_XEX            2
 203 #define DK_ENCRYPTION_TYPE_AES_XTS            3
 204
 205 #define DK_TIER_MASK                          0xC0
 206 #define DK_TIER_SHIFT                         6
 207
 208 #define DK_TIER_TO_PRIORITY(tier)             (((tier) << DK_TIER_SHIFT) | ~DK_TIER_MASK)
 209 #define DK_PRIORITY_TO_TIER(priority)         ((priority) >> DK_TIER_SHIFT)
 210
 211 typedef struct
 212 {
 213     uint64_t               offset;
 214     uint64_t               length;
 215
 216     uint8_t                reserved0128[12];       /* reserved, clear to zero */
 217
 218     dev_t                  dev;
 219 } dk_physical_extent_t;
 220
 221 typedef struct
 222 {
 223     dk_extent_t *          extents;
 224     uint32_t               extentsCount;
 225
 226     uint8_t                tier;
 227
 228 #ifdef __LP64__
 229     uint8_t                reserved0104[3];        /* reserved, clear to zero */
 230 #else /* !__LP64__ */
 231     uint8_t                reserved0072[7];        /* reserved, clear to zero */
 232 #endif /* !__LP64__ */
 233 } dk_set_tier_t;
 234
 235 #define DKIOCSETBLOCKSIZE                     _IOW('d', 24, uint32_t)
 236 #define DKIOCGETBSDUNIT                       _IOR('d', 27, uint32_t)
 237 #define DKIOCISSOLIDSTATE                     _IOR('d', 79, uint32_t)
 238 #define DKIOCISVIRTUAL                        _IOR('d', 72, uint32_t)
 239 #define DKIOCGETBASE                          _IOR('d', 73, uint64_t)
 240 #define DKIOCGETTHROTTLEMASK                  _IOR('d', 80, uint64_t)
 241 #define DKIOCLOCKPHYSICALEXTENTS              _IO('d', 81)
 242 #define DKIOCGETPHYSICALEXTENT                _IOWR('d', 82, dk_physical_extent_t)
 243 #define DKIOCUNLOCKPHYSICALEXTENTS            _IO('d', 83)
 244 #define DKIOCSETTIER                          _IOW('d', 85, dk_set_tier_t)
 245 #define DKIOCGETENCRYPTIONTYPE                _IOR('d', 86, uint32_t)
 246 #define DKIOCISLOWPOWERMODE                   _IOR('d', 87, uint32_t)
 247
 248 #ifdef XNU_KERNEL_PRIVATE
 249 typedef struct
 250 {
 251     boolean_t mi_mdev; /* Is this a memdev device? */
 252     boolean_t mi_phys; /* Physical memory? */
 253     uint32_t mi_base;  /* Base page number of the device? */
 254     uint64_t mi_size;  /* Size of the device (in ) */
 255 } dk_memdev_info_t;
 256
 257 typedef dk_memdev_info_t memdev_info_t;
 258
 259 #define DKIOCGETMEMDEVINFO                    _IOR('d', 90, dk_memdev_info_t)
 260 #endif /* XNU_KERNEL_PRIVATE */
 261 #ifdef PRIVATE
 262 typedef struct _dk_cs_pin {
 263         dk_extent_t     cp_extent;
 264         int64_t         cp_flags;
 265 } _dk_cs_pin_t;
 266 /* The following are modifiers to _DKIOCCSPINEXTENT/cp_flags operation */
 267 #define _DKIOCCSPINTOFASTMEDIA          (0)                     /* Pin extent to the fast (SSD) media             */
 268 #define _DKIOCCSPINFORHIBERNATION       (1 << 0)        /* Pin of hibernation file, content not preserved */
 269 #define _DKIOCCSPINDISCARDBLACKLIST     (1 << 1)        /* Hibernation complete/error, stop blacklisting  */
 270 #define _DKIOCCSPINTOSLOWMEDIA          (1 << 2)        /* Pin extent to the slow (HDD) media             */
 271 #define _DKIOCCSTEMPORARYPIN            (1 << 3)        /* Relocate, but do not pin, to indicated media   */
 272 #define _DKIOCCSHIBERNATEIMGSIZE        (1 << 4)        /* Anticipate/Max size of the upcoming hibernate  */
 273 #define _DKIOCCSPINFORSWAPFILE          (1 << 5)        /* Pin of swap file, content not preserved        */
 274
 275 #define _DKIOCCSSETLVNAME                     _IOW('d', 198, char[256])
 276 #define _DKIOCCSPINEXTENT                     _IOW('d', 199, _dk_cs_pin_t)
 277 #define _DKIOCCSUNPINEXTENT                   _IOW('d', 200, _dk_cs_pin_t)
 278 #define _DKIOCGETMIGRATIONUNITBYTESIZE        _IOR('d', 201, uint32_t)
 279
 280 typedef struct _dk_cs_map {
 281         dk_extent_t     cm_extent;
 282         uint64_t        cm_bytes_mapped;
 283 } _dk_cs_map_t;
 284
 285 typedef struct _dk_cs_unmap {
 286         dk_extent_t                  *extents;
 287         uint32_t                     extentsCount;
 288         uint32_t                     options;
 289 } _dk_cs_unmap_t;
 290
 291 #define _DKIOCCSMAP                           _IOWR('d', 202, _dk_cs_map_t)
 292 // No longer used: _DKIOCCSSETFSVNODE (203) & _DKIOCCSGETFREEBYTES (204)
 293 #define _DKIOCCSUNMAP                         _IOWR('d', 205, _dk_cs_unmap_t)
 294 #endif /* PRIVATE */
 295 #endif /* KERNEL */
 296
 297 #ifdef PRIVATE
 298 #endif /* PRIVATE */
 299
 300 #endif  /* _SYS_DISK_H_ */