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 DIOCGKERNELDUMP _IOW('d', 133, u_int) /* Set/Clear kernel dumps */ 98 #define MAX_SLICES 16 99 100 /* 101 * Support limits 102 */ 103 #define DKMAXUNITS 512 /* maximum supported disk units */ 104 #define DKMAXSLICES 128 /* maximum supported slices (0 & 1 special) */ 105 #define DKRESPARTITIONS 128 /* 128+ have special meanings */ 106 #define DKMAXPARTITIONS 256 /* maximum supported in-kernel partitions */ 107 108 /* 109 * The whole-disk-slice does not try to interpret the MBR. The whole slice 110 * partition does not try to interpret the disklabel within the slice. 111 */ 112 #define WHOLE_DISK_SLICE 1 113 #define WHOLE_SLICE_PART (DKMAXPARTITIONS - 1) 114 115 #ifdef MAXPARTITIONS /* XXX don't depend on disklabel.h */ 116 #if MAXPARTITIONS != 16 /* but check consistency if possible */ 117 #error "inconsistent MAXPARTITIONS" 118 #endif 119 #else 120 #define MAXPARTITIONS 16 121 #endif 122 123 /* 124 * diskslice structure - slices up the disk and indicates where the 125 * BSD labels are, if any. 126 * 127 * ds_reserved - indicates read-only sectors due to an overlap with 128 * a parent partition or an in-band label. BSD labels 129 * are in-band labels. This field is also set if 130 * label snooping has been requested, even if there is 131 * no label present. 132 */ 133 struct diskslice { 134 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 135 cdev_t ds_dev; 136 #else 137 void *ds_dev; 138 #endif 139 u_int64_t ds_offset; /* starting sector */ 140 u_int64_t ds_size; /* number of sectors */ 141 u_int32_t ds_reserved; /* sectors reserved parent overlap */ 142 struct uuid ds_type_uuid; /* slice type uuid */ 143 struct uuid ds_stor_uuid; /* slice storage unique uuid */ 144 int ds_type; /* (foreign) slice type */ 145 int ds_flags; /* DSF_ flags */ 146 disklabel_t ds_label; /* label, if any */ 147 struct disklabel_ops *ds_ops; /* label ops (probe default) */ 148 //void *ds_dev; /* devfs token for raw whole slice */ 149 void *ds_devs[MAXPARTITIONS]; /* XXX s.b. in label */ 150 u_int32_t ds_openmask[DKMAXPARTITIONS/(sizeof(u_int32_t)*8)]; 151 /* devs open */ 152 u_char ds_wlabel; /* nonzero if label is writable */ 153 int ds_ttlopens; /* total opens, incl slice & raw */ 154 }; 155 156 #define DSF_REPROBE 0x0001 /* sniffer wants us to reprobe */ 157 158 struct diskslices { 159 struct cdevsw *dss_cdevsw; /* for containing device */ 160 int dss_first_bsd_slice; /* COMPATIBILITY_SLICE is mapped here */ 161 u_int dss_nslices; /* actual dimension of dss_slices[] */ 162 u_int dss_oflags; /* copy of flags for "first" open */ 163 int dss_secmult; /* block to sector multiplier */ 164 int dss_secshift; /* block to sector shift (or -1) */ 165 int dss_secsize; /* sector size */ 166 struct diskslice 167 dss_slices[MAX_SLICES]; /* actually usually less */ 168 }; 169 170 /* 171 * DIOCGPART ioctl - returns information about a disk, slice, or partition. 172 * This ioctl is primarily used to get the block size and media size. 173 * 174 * NOTE: media_offset currently represents the byte offset on the raw device, 175 * it is not a partition relative offset. disklabel(32) uses this field 176 * to figure out the slice offset so it fixup raw labels. 177 * 178 * NOTE: reserved_blocks indicates how many blocks at the beginning of the 179 * partition are read-only due to in-band sharing with the parent. For 180 * example, if partition 'a' starts at block 0, it actually overlaps the 181 * disklabel itself so numerous sectors at the beginning of 'a' will be 182 * reserved. 183 */ 184 struct partinfo { 185 u_int64_t media_offset; /* byte offset in parent layer */ 186 u_int64_t media_size; /* media size in bytes */ 187 u_int64_t media_blocks; /* media size in blocks */ 188 int media_blksize; /* block size in bytes (sector size) */ 189 190 u_int64_t reserved_blocks;/* read-only, in sectors */ 191 int fstype; /* legacy filesystem type or FS_OTHER */ 192 char fsreserved[16]; /* reserved for future use */ 193 194 /* 195 * These fields are loaded from the diskinfo structure 196 */ 197 u_int d_nheads; 198 u_int d_ncylinders; 199 u_int d_secpertrack; 200 u_int d_secpercyl; 201 u_int d_reserved[8]; /* reserved for future use */ 202 203 /* 204 * UUIDs can be extracted from GPT slices and disklabel64 205 * partitions. If not known, they will be set to a nil uuid. 206 * 207 * fstype_uuid represents the slice or partition type, e.g. 208 * like GPT_ENT_TYPE_DRAGONFLY_DISKLABEL32. If not nil, 209 * storage_uuid uniquely identifies the physical storage. 210 */ 211 struct uuid fstype_uuid; 212 struct uuid storage_uuid; 213 }; 214 215 #define DIOCGPART _IOR('d', 104, struct partinfo) /* get partition */ 216 217 /* 218 * disk unit and slice helper functions 219 * 220 * 3 2 1 0 221 * 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 222 * _________________________________________________________________ 223 * | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 224 * ----------------------------------------------------------------- 225 * | SL2 | PART3 |UNIT_2 |P| SLICE | MAJOR? | UNIT |PART | 226 * ----------------------------------------------------------------- 227 */ 228 229 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 230 231 /* 232 * Build a minor device number. 233 */ 234 static __inline u_int32_t 235 dkmakeminor(u_int32_t unit, u_int32_t slice, u_int32_t part) 236 { 237 u_int32_t val; 238 239 val = ((unit & 0x001f) << 3) | ((unit & 0x01e0) << 16) | 240 ((slice & 0x000f) << 16) | ((slice & 0x0070) << 25) | 241 (part & 0x0007) | ((part & 0x0008) << 17) | 242 ((part & 0x00F0) << 21); 243 return(val); 244 } 245 246 /* 247 * Generate the minor number representing the entire disk, with no 248 * mbr or label interpretation. 249 */ 250 static __inline u_int32_t 251 dkmakewholedisk(u_int32_t unit) 252 { 253 return(dkmakeminor(unit, WHOLE_DISK_SLICE, WHOLE_SLICE_PART)); 254 } 255 256 /* 257 * Generate the minor number representing an entire slice, with no 258 * recursive mbr, boot sector, or label interpretation. 259 */ 260 static __inline u_int32_t 261 dkmakewholeslice(u_int32_t unit, u_int32_t slice) 262 { 263 return(dkmakeminor(unit, slice, WHOLE_SLICE_PART)); 264 } 265 266 /* 267 * Return the unit mask, used in calls to make_dev() 268 */ 269 static __inline u_int32_t 270 dkunitmask(void) 271 { 272 return (0x01e000f8); 273 } 274 275 /* 276 * build minor number elements - encode unit number, slice, and partition 277 * (OR the results together). 278 */ 279 static __inline u_int32_t 280 dkmakeunit(int unit) 281 { 282 return(dkmakeminor((u_int32_t)unit, 0, 0)); 283 } 284 285 static __inline u_int32_t 286 dkmakeslice(int slice) 287 { 288 return(dkmakeminor(0, (u_int32_t)slice, 0)); 289 } 290 291 static __inline u_int32_t 292 dkmakepart(int part) 293 { 294 return(dkmakeminor(0, 0, (u_int32_t)part)); 295 } 296 297 #endif 298 299 /* 300 * dk*() support functions operating on cdev_t's 301 */ 302 #ifdef _KERNEL 303 304 static __inline int 305 dkunit(cdev_t dev) 306 { 307 u_int32_t val = minor(dev); 308 309 val = ((val >> 3) & 0x001f) | ((val >> 16) & 0x01e0); 310 return((int)val); 311 } 312 313 static __inline u_int32_t 314 dkslice(cdev_t dev) 315 { 316 u_int32_t val = minor(dev); 317 318 val = ((val >> 16) & 0x000f) | ((val >> 25) & 0x0070); 319 return(val); 320 } 321 322 static __inline u_int32_t 323 dkpart(cdev_t dev) 324 { 325 u_int32_t val = minor(dev); 326 327 val = (val & 0x0007) | ((val >> 17) & 0x0008) | ((val >> 21) & 0x00f0); 328 return(val); 329 } 330 331 #endif 332 333 /* 334 * Bitmask ops, keeping track of which partitions are open. 335 */ 336 static __inline 337 void 338 dsclrmask(struct diskslice *ds, int part) 339 { 340 part &= (DKMAXPARTITIONS - 1); 341 ds->ds_openmask[part >> 5] &= ~(1 << (part & 31)); 342 } 343 344 static __inline 345 void 346 dssetmask(struct diskslice *ds, int part) 347 { 348 part &= (DKMAXPARTITIONS - 1); 349 ds->ds_openmask[part >> 5] |= (1 << (part & 31)); 350 } 351 352 static __inline 353 int 354 dschkmask(struct diskslice *ds, int part) 355 { 356 part &= (DKMAXPARTITIONS - 1); 357 return (ds->ds_openmask[part >> 5] & (1 << (part & 31))); 358 } 359 360 static __inline 361 int 362 dscountmask(struct diskslice *ds) 363 { 364 int count = 0; 365 int i; 366 int j; 367 368 for (i = 0; i < DKMAXPARTITIONS / 32; ++i) { 369 if (ds->ds_openmask[i]) { 370 for (j = 0; j < 32; ++j) { 371 if (ds->ds_openmask[i] & (1 << j)) 372 ++count; 373 } 374 } 375 } 376 return(count); 377 } 378 379 static __inline 380 void 381 dssetmaskfrommask(struct diskslice *ds, u_int32_t *tmask) 382 { 383 int i; 384 385 for (i = 0; i < DKMAXPARTITIONS / 32; ++i) 386 tmask[i] |= ds->ds_openmask[i]; 387 } 388 389 /* 390 * disk management functions 391 */ 392 393 #ifdef _KERNEL 394 395 struct buf; 396 struct bio; 397 struct disk_info; 398 struct bio_queue_head; 399 400 int mbrinit (cdev_t dev, struct disk_info *info, 401 struct diskslices **sspp); 402 int gptinit (cdev_t dev, struct disk_info *info, 403 struct diskslices **sspp); 404 struct bio * 405 dscheck (cdev_t dev, struct bio *bio, struct diskslices *ssp); 406 void dsclose (cdev_t dev, int mode, struct diskslices *ssp); 407 void dsgone (struct diskslices **sspp); 408 int dsioctl (cdev_t dev, u_long cmd, caddr_t data, int flags, 409 struct diskslices **sspp, struct disk_info *info); 410 int dsisopen (struct diskslices *ssp); 411 struct diskslices * 412 dsmakeslicestruct (int nslices, struct disk_info *info); 413 char *dsname (cdev_t dev, int unit, int slice, int part, 414 char *partname); 415 int dsopen (cdev_t dev, int mode, u_int flags, 416 struct diskslices **sspp, struct disk_info *info); 417 int64_t dssize (cdev_t dev, struct diskslices **sspp); 418 419 /* 420 * Ancillary functions 421 */ 422 423 void diskerr (struct bio *bio, cdev_t dev, const char *what, int pri, 424 int donecnt); 425 void bioqdisksort (struct bio_queue_head *ap, struct bio *bio); 426 427 #endif /* _KERNEL */ 428 429 #endif /* !_SYS_DISKSLICE_H_ */ 430