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  * DKIOCGETPROVISIONSTATUS               get device's block provision status
  78  * DKIOCGETIOMINSATURATIONBYTECOUNT      get minimum byte count to saturate storage bandwidth
  79  */
  80
  81 #define DK_FEATURE_BARRIER                    0x00000002
  82 #define DK_FEATURE_PRIORITY                   0x00000004
  83 #define DK_FEATURE_UNMAP                      0x00000010
  84
  85 #define DK_SYNCHRONIZE_OPTION_BARRIER         0x00000002
  86
  87 typedef struct
  88 {
  89     uint64_t               offset;
  90     uint64_t               length;
  91 } dk_extent_t;
  92
  93 typedef struct
  94 {
  95     char                   path[128];
  96 } dk_firmware_path_t;
  97
  98 typedef struct
  99 {
 100     uint64_t               blockCount;
 101     uint32_t               blockSize;
 102
 103     uint8_t                reserved0096[4];        /* reserved, clear to zero */
 104 } dk_format_capacity_t;
 105
 106 typedef struct
 107 {
 108     dk_format_capacity_t * capacities;
 109     uint32_t               capacitiesCount;        /* use zero to probe count */
 110
 111 #ifdef __LP64__
 112     uint8_t                reserved0096[4];        /* reserved, clear to zero */
 113 #else /* !__LP64__ */
 114     uint8_t                reserved0064[8];        /* reserved, clear to zero */
 115 #endif /* !__LP64__ */
 116 } dk_format_capacities_t;
 117
 118 typedef struct
 119 {
 120     uint64_t               offset;
 121     uint64_t               length;
 122
 123     uint32_t               options;
 124
 125     uint8_t                reserved0160[4];        /* reserved, clear to zero */
 126 } dk_synchronize_t;
 127
 128 typedef struct
 129 {
 130     dk_extent_t *          extents;
 131     uint32_t               extentsCount;
 132
 133     uint32_t               options;
 134
 135 #ifndef __LP64__
 136     uint8_t                reserved0096[4];        /* reserved, clear to zero */
 137 #endif /* !__LP64__ */
 138 } dk_unmap_t;
 139
 140
 141 typedef struct
 142 {
 143         uint64_t           flags;
 144         uint64_t           hotfile_size;           /* in bytes */
 145         uint64_t           hibernate_minsize;
 146         uint64_t           swapfile_pinning;
 147
 148         uint64_t           padding[4];
 149 } dk_corestorage_info_t;
 150
 151 #define DK_CORESTORAGE_PIN_YOUR_METADATA        0x00000001
 152 #define DK_CORESTORAGE_ENABLE_HOTFILES          0x00000002
 153 #define DK_CORESTORAGE_PIN_YOUR_SWAPFILE        0x00000004
 154
 155 #define DK_PROVISION_TYPE_MAPPED                0x00
 156 #define DK_PROVISION_TYPE_DEALLOCATED           0x01
 157 #define DK_PROVISION_TYPE_ANCHORED              0x02
 158
 159 typedef struct
 160 {
 161         uint64_t           offset;
 162         uint64_t           length;
 163         uint8_t            provisionType;
 164         uint8_t            reserved[7];
 165 } dk_provision_extent_t;
 166
 167 typedef struct
 168 {
 169         uint64_t                offset;         /* input:        logical byte offset */
 170         uint64_t                length;         /* input:        byte length, 0 for whole length */
 171         uint64_t                options;        /*               reserved, clear to zero */
 172         uint32_t                reserved;       /*               not used */
 173         uint32_t                extentsCount;   /* input/output: count for extents */
 174         dk_provision_extent_t * extents;        /* output:       provision extents */
 175 } dk_provision_status_t;
 176
 177 #ifdef KERNEL
 178 #ifdef PRIVATE
 179
 180 /* Definitions of option bits for dk_unmap_t */
 181 #define _DK_UNMAP_INITIALIZE                   0x00000100
 182
 183 #endif /* PRIVATE */
 184 #endif /* KERNEL */
 185
 186 #define DKIOCEJECT                            _IO('d', 21)
 187 #define DKIOCSYNCHRONIZE                      _IOW('d', 22, dk_synchronize_t)
 188
 189 #define DKIOCFORMAT                           _IOW('d', 26, dk_format_capacity_t)
 190 #define DKIOCGETFORMATCAPACITIES              _IOWR('d', 26, dk_format_capacities_t)
 191
 192 #define DKIOCGETBLOCKSIZE                     _IOR('d', 24, uint32_t)
 193 #define DKIOCGETBLOCKCOUNT                    _IOR('d', 25, uint64_t)
 194 #define DKIOCGETFIRMWAREPATH                  _IOR('d', 28, dk_firmware_path_t)
 195
 196 #define DKIOCISFORMATTED                      _IOR('d', 23, uint32_t)
 197 #define DKIOCISWRITABLE                       _IOR('d', 29, uint32_t)
 198
 199 #define DKIOCREQUESTIDLE                      _IO('d', 30)
 200 #define DKIOCUNMAP                            _IOW('d', 31, dk_unmap_t)
 201 #define DKIOCCORESTORAGE                      _IOR('d', 32, dk_corestorage_info_t)
 202
 203 #define DKIOCGETMAXBLOCKCOUNTREAD             _IOR('d', 64, uint64_t)
 204 #define DKIOCGETMAXBLOCKCOUNTWRITE            _IOR('d', 65, uint64_t)
 205 #define DKIOCGETMAXBYTECOUNTREAD              _IOR('d', 70, uint64_t)
 206 #define DKIOCGETMAXBYTECOUNTWRITE             _IOR('d', 71, uint64_t)
 207
 208 #define DKIOCGETMAXSEGMENTCOUNTREAD           _IOR('d', 66, uint64_t)
 209 #define DKIOCGETMAXSEGMENTCOUNTWRITE          _IOR('d', 67, uint64_t)
 210 #define DKIOCGETMAXSEGMENTBYTECOUNTREAD       _IOR('d', 68, uint64_t)
 211 #define DKIOCGETMAXSEGMENTBYTECOUNTWRITE      _IOR('d', 69, uint64_t)
 212
 213 #define DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT  _IOR('d', 74, uint64_t)
 214 #define DKIOCGETMAXSEGMENTADDRESSABLEBITCOUNT _IOR('d', 75, uint64_t)
 215
 216 #define DKIOCGETFEATURES                      _IOR('d', 76, uint32_t)
 217 #define DKIOCGETPHYSICALBLOCKSIZE             _IOR('d', 77, uint32_t)
 218 #define DKIOCGETCOMMANDPOOLSIZE               _IOR('d', 78, uint32_t)
 219
 220 #define DKIOCGETPROVISIONSTATUS               _IOWR('d', 79, dk_provision_status_t)
 221
 222 #define DKIOCSYNCHRONIZECACHE                 _IO('d', 22)
 223
 224 #ifdef KERNEL
 225 #define DK_FEATURE_FORCE_UNIT_ACCESS          0x00000001
 226
 227 #define DK_ENCRYPTION_TYPE_AES_CBC            1
 228 #define DK_ENCRYPTION_TYPE_AES_XEX            2
 229 #define DK_ENCRYPTION_TYPE_AES_XTS            3
 230
 231 #define DK_TIER_MASK                          0xC0
 232 #define DK_TIER_SHIFT                         6
 233
 234 #define DK_TIER_TO_PRIORITY(tier)             (((tier) << DK_TIER_SHIFT) | ~DK_TIER_MASK)
 235 #define DK_PRIORITY_TO_TIER(priority)         ((priority) >> DK_TIER_SHIFT)
 236
 237 typedef struct
 238 {
 239     uint64_t               offset;
 240     uint64_t               length;
 241
 242     uint8_t                reserved0128[12];       /* reserved, clear to zero */
 243
 244     dev_t                  dev;
 245 } dk_physical_extent_t;
 246
 247 typedef struct
 248 {
 249     dk_extent_t *          extents;
 250     uint32_t               extentsCount;
 251
 252     uint8_t                tier;
 253
 254 #ifdef __LP64__
 255     uint8_t                reserved0104[3];        /* reserved, clear to zero */
 256 #else /* !__LP64__ */
 257     uint8_t                reserved0072[7];        /* reserved, clear to zero */
 258 #endif /* !__LP64__ */
 259 } dk_set_tier_t;
 260
 261 #define DKIOCSETBLOCKSIZE                     _IOW('d', 24, uint32_t)
 262 #define DKIOCGETBSDUNIT                       _IOR('d', 27, uint32_t)
 263 #define DKIOCISSOLIDSTATE                     _IOR('d', 79, uint32_t)
 264 #define DKIOCISVIRTUAL                        _IOR('d', 72, uint32_t)
 265 #define DKIOCGETBASE                          _IOR('d', 73, uint64_t)
 266 #define DKIOCGETTHROTTLEMASK                  _IOR('d', 80, uint64_t)
 267 #define DKIOCLOCKPHYSICALEXTENTS              _IO('d', 81)
 268 #define DKIOCGETPHYSICALEXTENT                _IOWR('d', 82, dk_physical_extent_t)
 269 #define DKIOCUNLOCKPHYSICALEXTENTS            _IO('d', 83)
 270 #define DKIOCSETTIER                          _IOW('d', 85, dk_set_tier_t)
 271 #define DKIOCGETENCRYPTIONTYPE                _IOR('d', 86, uint32_t)
 272 #define DKIOCISLOWPOWERMODE                   _IOR('d', 87, uint32_t)
 273 #define DKIOCGETIOMINSATURATIONBYTECOUNT      _IOR('d', 88, uint32_t)
 274
 275 #ifdef XNU_KERNEL_PRIVATE
 276 typedef struct
 277 {
 278     boolean_t mi_mdev; /* Is this a memdev device? */
 279     boolean_t mi_phys; /* Physical memory? */
 280     uint32_t mi_base;  /* Base page number of the device? */
 281     uint64_t mi_size;  /* Size of the device (in ) */
 282 } dk_memdev_info_t;
 283
 284 typedef dk_memdev_info_t memdev_info_t;
 285
 286 #define DKIOCGETMEMDEVINFO                    _IOR('d', 90, dk_memdev_info_t)
 287 #endif /* XNU_KERNEL_PRIVATE */
 288 #ifdef PRIVATE
 289 typedef struct _dk_cs_pin {
 290         dk_extent_t     cp_extent;
 291         int64_t         cp_flags;
 292 } _dk_cs_pin_t;
 293 /* The following are modifiers to _DKIOCCSPINEXTENT/cp_flags operation */
 294 #define _DKIOCCSPINTOFASTMEDIA          (0)                     /* Pin extent to the fast (SSD) media             */
 295 #define _DKIOCCSPINFORHIBERNATION       (1 << 0)        /* Pin of hibernation file, content not preserved */
 296 #define _DKIOCCSPINDISCARDBLACKLIST     (1 << 1)        /* Hibernation complete/error, stop blacklisting  */
 297 #define _DKIOCCSPINTOSLOWMEDIA          (1 << 2)        /* Pin extent to the slow (HDD) media             */
 298 #define _DKIOCCSTEMPORARYPIN            (1 << 3)        /* Relocate, but do not pin, to indicated media   */
 299 #define _DKIOCCSHIBERNATEIMGSIZE        (1 << 4)        /* Anticipate/Max size of the upcoming hibernate  */
 300 #define _DKIOCCSPINFORSWAPFILE          (1 << 5)        /* Pin of swap file, content not preserved        */
 301
 302 #define _DKIOCCSSETLVNAME                     _IOW('d', 198, char[256])
 303 #define _DKIOCCSPINEXTENT                     _IOW('d', 199, _dk_cs_pin_t)
 304 #define _DKIOCCSUNPINEXTENT                   _IOW('d', 200, _dk_cs_pin_t)
 305 #define _DKIOCGETMIGRATIONUNITBYTESIZE        _IOR('d', 201, uint32_t)
 306
 307 typedef struct _dk_cs_map {
 308         dk_extent_t     cm_extent;
 309         uint64_t        cm_bytes_mapped;
 310 } _dk_cs_map_t;
 311
 312 typedef struct _dk_cs_unmap {
 313         dk_extent_t                  *extents;
 314         uint32_t                     extentsCount;
 315         uint32_t                     options;
 316 } _dk_cs_unmap_t;
 317
 318 #define _DKIOCCSMAP                           _IOWR('d', 202, _dk_cs_map_t)
 319 // No longer used: _DKIOCCSSETFSVNODE (203) & _DKIOCCSGETFREEBYTES (204)
 320 #define _DKIOCCSUNMAP                         _IOWR('d', 205, _dk_cs_unmap_t)
 321 #endif /* PRIVATE */
 322 #endif /* KERNEL */
 323
 324 #ifdef PRIVATE
 325 #endif /* PRIVATE */
 326
 327 #endif  /* _SYS_DISK_H_ */