1 /* 2 * Copyright (c) 2007 The DragonFly Project. All rights reserved. 3 * 4 * This code is derived from software contributed to The DragonFly Project 5 * by Matthew Dillon <dillon@backplane.com> 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * 3. Neither the name of The DragonFly Project nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific, prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, 27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 */ 34 /*- 35 * Copyright (c) 1994 Bruce D. Evans. 36 * All rights reserved. 37 * 38 * Redistribution and use in source and binary forms, with or without 39 * modification, are permitted provided that the following conditions 40 * are met: 41 * 1. Redistributions of source code must retain the above copyright 42 * notice, this list of conditions and the following disclaimer. 43 * 2. Redistributions in binary form must reproduce the above copyright 44 * notice, this list of conditions and the following disclaimer in the 45 * documentation and/or other materials provided with the distribution. 46 * 47 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 48 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 49 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 50 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 51 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 52 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 53 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 54 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 55 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 56 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 57 * SUCH DAMAGE. 58 * 59 * $FreeBSD: src/sys/sys/diskslice.h,v 1.36.2.1 2001/01/29 01:50:50 ken Exp $ 60 * $DragonFly: src/sys/sys/diskslice.h,v 1.22 2007/06/19 06:07:51 dillon Exp $ 61 */ 62 63 #ifndef _SYS_DISKSLICE_H_ 64 #define _SYS_DISKSLICE_H_ 65 66 #ifndef _SYS_TYPES_H_ 67 #include <sys/types.h> 68 #endif 69 #ifndef _SYS_DISKLABEL_H_ 70 #include <sys/disklabel.h> 71 #endif 72 #ifndef _SYS_UUID_H_ 73 #include <sys/uuid.h> 74 #endif 75 #ifndef _SYS_IOCCOM_H_ 76 #include <sys/ioccom.h> 77 #endif 78 #if defined(_KERNEL) 79 #ifndef _SYS_CONF_H_ 80 #include <sys/conf.h> /* for make_sub_dev() */ 81 #endif 82 #ifndef _SYS_SYSTM_H_ 83 #include <sys/systm.h> /* for minor() */ 84 #endif 85 #endif 86 87 #define BASE_SLICE 2 /* e.g. ad0s1 */ 88 #define COMPATIBILITY_SLICE 0 /* e.g. ad0a-j */ 89 /* 101 - compat disklabel DIOCGDINFO */ 90 /* 102 - compat disklabel DIOCSDINFO */ 91 /* 103 - compat disklabel DIOCWDINFO */ 92 /* 104 - DIOCGPART (see below) */ 93 /* 105 - compat disklabel DIOCGDVIRGIN */ 94 #define DIOCWLABEL _IOW('d', 109, int) 95 #define DIOCGSLICEINFO _IOR('d', 111, struct diskslices) 96 #define DIOCSYNCSLICEINFO _IOW('d', 112, int) 97 #define MAX_SLICES 16 98 99 /* 100 * Support limits 101 */ 102 #define DKMAXUNITS 512 /* maximum supported disk units */ 103 #define DKMAXSLICES 128 /* maximum supported slices (0 & 1 special) */ 104 #define DKRESPARTITIONS 128 /* 128+ have special meanings */ 105 #define DKMAXPARTITIONS 256 /* maximum supported in-kernel partitions */ 106 107 /* 108 * The whole-disk-slice does not try to interpret the MBR. The whole slice 109 * partition does not try to interpret the disklabel within the slice. 110 */ 111 #define WHOLE_DISK_SLICE 1 112 #define WHOLE_SLICE_PART (DKMAXPARTITIONS - 1) 113 114 #ifdef MAXPARTITIONS /* XXX don't depend on disklabel.h */ 115 #if MAXPARTITIONS != 16 /* but check consistency if possible */ 116 #error "inconsistent MAXPARTITIONS" 117 #endif 118 #else 119 #define MAXPARTITIONS 16 120 #endif 121 122 /* 123 * diskslice structure - slices up the disk and indicates where the 124 * BSD labels are, if any. 125 * 126 * ds_reserved - indicates read-only sectors due to an overlap with 127 * a parent partition or an in-band label. BSD labels 128 * are in-band labels. This field is also set if 129 * label snooping has been requested, even if there is 130 * no label present. 131 */ 132 struct diskslice { 133 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 134 cdev_t ds_dev; 135 #else 136 void *ds_dev; 137 #endif 138 u_int64_t ds_offset; /* starting sector */ 139 u_int64_t ds_size; /* number of sectors */ 140 u_int32_t ds_reserved; /* sectors reserved parent overlap */ 141 struct uuid ds_type_uuid; /* slice type uuid */ 142 struct uuid ds_stor_uuid; /* slice storage unique uuid */ 143 int ds_type; /* (foreign) slice type */ 144 int ds_flags; /* DSF_ flags */ 145 disklabel_t ds_label; /* label, if any */ 146 struct disklabel_ops *ds_ops; /* label ops (probe default) */ 147 //void *ds_dev; /* devfs token for raw whole slice */ 148 void *ds_devs[MAXPARTITIONS]; /* XXX s.b. in label */ 149 u_int32_t ds_openmask[DKMAXPARTITIONS/(sizeof(u_int32_t)*8)]; 150 /* devs open */ 151 u_char ds_wlabel; /* nonzero if label is writable */ 152 int ds_ttlopens; /* total opens, incl slice & raw */ 153 }; 154 155 #define DSF_REPROBE 0x0001 /* sniffer wants us to reprobe */ 156 157 struct diskslices { 158 struct cdevsw *dss_cdevsw; /* for containing device */ 159 int dss_first_bsd_slice; /* COMPATIBILITY_SLICE is mapped here */ 160 u_int dss_nslices; /* actual dimension of dss_slices[] */ 161 u_int dss_oflags; /* copy of flags for "first" open */ 162 int dss_secmult; /* block to sector multiplier */ 163 int dss_secshift; /* block to sector shift (or -1) */ 164 int dss_secsize; /* sector size */ 165 struct diskslice 166 dss_slices[MAX_SLICES]; /* actually usually less */ 167 }; 168 169 /* 170 * DIOCGPART ioctl - returns information about a disk, slice, or partition. 171 * This ioctl is primarily used to get the block size and media size. 172 * 173 * NOTE: media_offset currently represents the byte offset on the raw device, 174 * it is not a partition relative offset. disklabel(32) uses this field 175 * to figure out the slice offset so it fixup raw labels. 176 * 177 * NOTE: reserved_blocks indicates how many blocks at the beginning of the 178 * partition are read-only due to in-band sharing with the parent. For 179 * example, if partition 'a' starts at block 0, it actually overlaps the 180 * disklabel itself so numerous sectors at the beginning of 'a' will be 181 * reserved. 182 */ 183 struct partinfo { 184 u_int64_t media_offset; /* byte offset in parent layer */ 185 u_int64_t media_size; /* media size in bytes */ 186 u_int64_t media_blocks; /* media size in blocks */ 187 int media_blksize; /* block size in bytes (sector size) */ 188 189 u_int64_t reserved_blocks;/* read-only, in sectors */ 190 int fstype; /* legacy filesystem type or FS_OTHER */ 191 char fsreserved[16]; /* reserved for future use */ 192 193 /* 194 * These fields are loaded from the diskinfo structure 195 */ 196 u_int d_nheads; 197 u_int d_ncylinders; 198 u_int d_secpertrack; 199 u_int d_secpercyl; 200 u_int d_reserved[8]; /* reserved for future use */ 201 202 /* 203 * UUIDs can be extracted from GPT slices and disklabel64 204 * partitions. If not known, they will be set to a nil uuid. 205 * 206 * fstype_uuid represents the slice or partition type, e.g. 207 * like GPT_ENT_TYPE_DRAGONFLY_DISKLABEL32. If not nil, 208 * storage_uuid uniquely identifies the physical storage. 209 */ 210 struct uuid fstype_uuid; 211 struct uuid storage_uuid; 212 }; 213 214 #define DIOCGPART _IOR('d', 104, struct partinfo) /* get partition */ 215 216 /* 217 * disk unit and slice helper functions 218 * 219 * 3 2 1 0 220 * 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 221 * _________________________________________________________________ 222 * | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 223 * ----------------------------------------------------------------- 224 * | SL2 | PART3 |UNIT_2 |P| SLICE | MAJOR? | UNIT |PART | 225 * ----------------------------------------------------------------- 226 */ 227 228 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 229 230 /* 231 * Build a minor device number. 232 */ 233 static __inline u_int32_t 234 dkmakeminor(u_int32_t unit, u_int32_t slice, u_int32_t part) 235 { 236 u_int32_t val; 237 238 val = ((unit & 0x001f) << 3) | ((unit & 0x01e0) << 16) | 239 ((slice & 0x000f) << 16) | ((slice & 0x0070) << 25) | 240 (part & 0x0007) | ((part & 0x0008) << 17) | 241 ((part & 0x00F0) << 21); 242 return(val); 243 } 244 245 /* 246 * Generate the minor number representing the entire disk, with no 247 * mbr or label interpretation. 248 */ 249 static __inline u_int32_t 250 dkmakewholedisk(u_int32_t unit) 251 { 252 return(dkmakeminor(unit, WHOLE_DISK_SLICE, WHOLE_SLICE_PART)); 253 } 254 255 /* 256 * Generate the minor number representing an entire slice, with no 257 * recursive mbr, boot sector, or label interpretation. 258 */ 259 static __inline u_int32_t 260 dkmakewholeslice(u_int32_t unit, u_int32_t slice) 261 { 262 return(dkmakeminor(unit, slice, WHOLE_SLICE_PART)); 263 } 264 265 /* 266 * Return the unit mask, used in calls to make_dev() 267 */ 268 static __inline u_int32_t 269 dkunitmask(void) 270 { 271 return (0x01e000f8); 272 } 273 274 /* 275 * build minor number elements - encode unit number, slice, and partition 276 * (OR the results together). 277 */ 278 static __inline u_int32_t 279 dkmakeunit(int unit) 280 { 281 return(dkmakeminor((u_int32_t)unit, 0, 0)); 282 } 283 284 static __inline u_int32_t 285 dkmakeslice(int slice) 286 { 287 return(dkmakeminor(0, (u_int32_t)slice, 0)); 288 } 289 290 static __inline u_int32_t 291 dkmakepart(int part) 292 { 293 return(dkmakeminor(0, 0, (u_int32_t)part)); 294 } 295 296 #endif 297 298 /* 299 * dk*() support functions operating on cdev_t's 300 */ 301 #ifdef _KERNEL 302 303 static __inline int 304 dkunit(cdev_t dev) 305 { 306 u_int32_t val = minor(dev); 307 308 val = ((val >> 3) & 0x001f) | ((val >> 16) & 0x01e0); 309 return((int)val); 310 } 311 312 static __inline u_int32_t 313 dkslice(cdev_t dev) 314 { 315 u_int32_t val = minor(dev); 316 317 val = ((val >> 16) & 0x000f) | ((val >> 25) & 0x0070); 318 return(val); 319 } 320 321 static __inline u_int32_t 322 dkpart(cdev_t dev) 323 { 324 u_int32_t val = minor(dev); 325 326 val = (val & 0x0007) | ((val >> 17) & 0x0008) | ((val >> 21) & 0x00f0); 327 return(val); 328 } 329 330 #endif 331 332 /* 333 * Bitmask ops, keeping track of which partitions are open. 334 */ 335 static __inline 336 void 337 dsclrmask(struct diskslice *ds, int part) 338 { 339 part &= (DKMAXPARTITIONS - 1); 340 ds->ds_openmask[part >> 5] &= ~(1 << (part & 31)); 341 } 342 343 static __inline 344 void 345 dssetmask(struct diskslice *ds, int part) 346 { 347 part &= (DKMAXPARTITIONS - 1); 348 ds->ds_openmask[part >> 5] |= (1 << (part & 31)); 349 } 350 351 static __inline 352 int 353 dschkmask(struct diskslice *ds, int part) 354 { 355 part &= (DKMAXPARTITIONS - 1); 356 return (ds->ds_openmask[part >> 5] & (1 << (part & 31))); 357 } 358 359 static __inline 360 int 361 dscountmask(struct diskslice *ds) 362 { 363 int count = 0; 364 int i; 365 int j; 366 367 for (i = 0; i < DKMAXPARTITIONS / 32; ++i) { 368 if (ds->ds_openmask[i]) { 369 for (j = 0; j < 32; ++j) { 370 if (ds->ds_openmask[i] & (1 << j)) 371 ++count; 372 } 373 } 374 } 375 return(count); 376 } 377 378 static __inline 379 void 380 dssetmaskfrommask(struct diskslice *ds, u_int32_t *tmask) 381 { 382 int i; 383 384 for (i = 0; i < DKMAXPARTITIONS / 32; ++i) 385 tmask[i] |= ds->ds_openmask[i]; 386 } 387 388 /* 389 * disk management functions 390 */ 391 392 #ifdef _KERNEL 393 394 struct buf; 395 struct bio; 396 struct disk_info; 397 struct bio_queue_head; 398 399 int mbrinit (cdev_t dev, struct disk_info *info, 400 struct diskslices **sspp); 401 int gptinit (cdev_t dev, struct disk_info *info, 402 struct diskslices **sspp); 403 struct bio * 404 dscheck (cdev_t dev, struct bio *bio, struct diskslices *ssp); 405 void dsclose (cdev_t dev, int mode, struct diskslices *ssp); 406 void dsgone (struct diskslices **sspp); 407 int dsioctl (cdev_t dev, u_long cmd, caddr_t data, int flags, 408 struct diskslices **sspp, struct disk_info *info); 409 int dsisopen (struct diskslices *ssp); 410 struct diskslices * 411 dsmakeslicestruct (int nslices, struct disk_info *info); 412 char *dsname (cdev_t dev, int unit, int slice, int part, 413 char *partname); 414 int dsopen (cdev_t dev, int mode, u_int flags, 415 struct diskslices **sspp, struct disk_info *info); 416 int64_t dssize (cdev_t dev, struct diskslices **sspp); 417 418 /* 419 * Ancillary functions 420 */ 421 422 void diskerr (struct bio *bio, cdev_t dev, const char *what, int pri, 423 int donecnt); 424 void disksort (struct buf *ap, struct buf *bp); 425 void bioqdisksort (struct bio_queue_head *ap, struct bio *bio); 426 427 #endif /* _KERNEL */ 428 429 #endif /* !_SYS_DISKSLICE_H_ */ 430