2 * Copyright (c) 2007 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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
35 * Copyright (c) 1994 Bruce D. Evans.
36 * All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
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.
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
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 $
63 #ifndef _SYS_DISKSLICE_H_
64 #define _SYS_DISKSLICE_H_
67 #include <sys/types.h>
69 #ifndef _SYS_DISKLABEL_H_
70 #include <sys/disklabel.h>
75 #ifndef _SYS_IOCCOM_H_
76 #include <sys/ioccom.h>
80 #include <sys/conf.h> /* for make_sub_dev() */
83 #include <sys/systm.h> /* for minor() */
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)
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 */
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.
111 #define WHOLE_DISK_SLICE 1
112 #define WHOLE_SLICE_PART (DKMAXPARTITIONS - 1)
114 #ifdef MAXPARTITIONS /* XXX don't depend on disklabel.h */
115 #if MAXPARTITIONS != 16 /* but check consistency if possible */
116 #error "inconsistent MAXPARTITIONS"
119 #define MAXPARTITIONS 16
123 * diskslice structure - slices up the disk and indicates where the
124 * BSD labels are, if any.
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
133 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
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 disklabel_t ds_label; /* label, if any */
145 struct disklabel_ops *ds_ops; /* label ops (probe default) */
146 //void *ds_dev; /* devfs token for raw whole slice */
147 void *ds_devs[MAXPARTITIONS]; /* XXX s.b. in label */
148 u_int32_t ds_openmask[DKMAXPARTITIONS/(sizeof(u_int32_t)*8)];
150 u_char ds_wlabel; /* nonzero if label is writable */
151 int ds_ttlopens; /* total opens, incl slice & raw */
155 struct cdevsw *dss_cdevsw; /* for containing device */
156 int dss_first_bsd_slice; /* COMPATIBILITY_SLICE is mapped here */
157 u_int dss_nslices; /* actual dimension of dss_slices[] */
158 u_int dss_oflags; /* copy of flags for "first" open */
159 int dss_secmult; /* block to sector multiplier */
160 int dss_secshift; /* block to sector shift (or -1) */
161 int dss_secsize; /* sector size */
163 dss_slices[MAX_SLICES]; /* actually usually less */
167 * DIOCGPART ioctl - returns information about a disk, slice, or partition.
168 * This ioctl is primarily used to get the block size and media size.
170 * NOTE: media_offset currently represents the byte offset on the raw device,
171 * it is not a partition relative offset. disklabel(32) uses this field
172 * to figure out the slice offset so it fixup raw labels.
174 * NOTE: reserved_blocks indicates how many blocks at the beginning of the
175 * partition are read-only due to in-band sharing with the parent. For
176 * example, if partition 'a' starts at block 0, it actually overlaps the
177 * disklabel itself so numerous sectors at the beginning of 'a' will be
181 u_int64_t media_offset; /* byte offset in parent layer */
182 u_int64_t media_size; /* media size in bytes */
183 u_int64_t media_blocks; /* media size in blocks */
184 int media_blksize; /* block size in bytes (sector size) */
186 u_int64_t reserved_blocks;/* read-only, in sectors */
187 int fstype; /* legacy filesystem type or FS_OTHER */
188 char fsreserved[16]; /* reserved for future use */
191 * These fields are loaded from the diskinfo structure
197 u_int d_reserved[8]; /* reserved for future use */
200 * UUIDs can be extracted from GPT slices and disklabel64
201 * partitions. If not known, they will be set to a nil uuid.
203 * fstype_uuid represents the slice or partition type, e.g.
204 * like GPT_ENT_TYPE_DRAGONFLY_DISKLABEL32. If not nil,
205 * storage_uuid uniquely identifies the physical storage.
207 struct uuid fstype_uuid;
208 struct uuid storage_uuid;
211 #define DIOCGPART _IOR('d', 104, struct partinfo) /* get partition */
214 * disk unit and slice helper functions
217 * 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
218 * _________________________________________________________________
219 * | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
220 * -----------------------------------------------------------------
221 * | SL2 | PART3 |UNIT_2 |P| SLICE | MAJOR? | UNIT |PART |
222 * -----------------------------------------------------------------
225 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
228 * Build a minor device number.
230 static __inline u_int32_t
231 dkmakeminor(u_int32_t unit, u_int32_t slice, u_int32_t part)
235 val = ((unit & 0x001f) << 3) | ((unit & 0x01e0) << 16) |
236 ((slice & 0x000f) << 16) | ((slice & 0x0070) << 25) |
237 (part & 0x0007) | ((part & 0x0008) << 17) |
238 ((part & 0x00F0) << 21);
243 * Generate the minor number representing the entire disk, with no
244 * mbr or label interpretation.
246 static __inline u_int32_t
247 dkmakewholedisk(u_int32_t unit)
249 return(dkmakeminor(unit, WHOLE_DISK_SLICE, WHOLE_SLICE_PART));
253 * Generate the minor number representing an entire slice, with no
254 * recursive mbr, boot sector, or label interpretation.
256 static __inline u_int32_t
257 dkmakewholeslice(u_int32_t unit, u_int32_t slice)
259 return(dkmakeminor(unit, slice, WHOLE_SLICE_PART));
263 * Return the unit mask, used in calls to make_dev()
265 static __inline u_int32_t
272 * build minor number elements - encode unit number, slice, and partition
273 * (OR the results together).
275 static __inline u_int32_t
278 return(dkmakeminor((u_int32_t)unit, 0, 0));
281 static __inline u_int32_t
282 dkmakeslice(int slice)
284 return(dkmakeminor(0, (u_int32_t)slice, 0));
287 static __inline u_int32_t
290 return(dkmakeminor(0, 0, (u_int32_t)part));
296 * dk*() support functions operating on cdev_t's
303 u_int32_t val = minor(dev);
305 val = ((val >> 3) & 0x001f) | ((val >> 16) & 0x01e0);
309 static __inline u_int32_t
312 u_int32_t val = minor(dev);
314 val = ((val >> 16) & 0x000f) | ((val >> 25) & 0x0070);
318 static __inline u_int32_t
321 u_int32_t val = minor(dev);
323 val = (val & 0x0007) | ((val >> 17) & 0x0008) | ((val >> 21) & 0x00f0);
328 * dkmodpart() - create sub-device
330 static __inline cdev_t
331 dkmodpart(cdev_t dev, int part)
335 val = (minor(dev) & ~dkmakepart(-1)) | dkmakepart(part);
336 return (make_sub_dev(dev, val));
339 static __inline cdev_t
340 dkmodslice(cdev_t dev, int slice)
344 val = (minor(dev) & ~dkmakeslice(-1)) | dkmakeslice(slice);
345 return (make_sub_dev(dev, val));
351 * Bitmask ops, keeping track of which partitions are open.
355 dsclrmask(struct diskslice *ds, int part)
357 part &= (DKMAXPARTITIONS - 1);
358 ds->ds_openmask[part >> 5] &= ~(1 << (part & 31));
363 dssetmask(struct diskslice *ds, int part)
365 part &= (DKMAXPARTITIONS - 1);
366 ds->ds_openmask[part >> 5] |= (1 << (part & 31));
371 dschkmask(struct diskslice *ds, int part)
373 part &= (DKMAXPARTITIONS - 1);
374 return (ds->ds_openmask[part >> 5] & (1 << (part & 31)));
379 dscountmask(struct diskslice *ds)
385 for (i = 0; i < DKMAXPARTITIONS / 32; ++i) {
386 if (ds->ds_openmask[i]) {
387 for (j = 0; j < 32; ++j) {
388 if (ds->ds_openmask[i] & (1 << j))
398 dssetmaskfrommask(struct diskslice *ds, u_int32_t *tmask)
402 for (i = 0; i < DKMAXPARTITIONS / 32; ++i)
403 tmask[i] |= ds->ds_openmask[i];
407 * disk management functions
415 struct bio_queue_head;
417 int mbrinit (cdev_t dev, struct disk_info *info,
418 struct diskslices **sspp);
419 int gptinit (cdev_t dev, struct disk_info *info,
420 struct diskslices **sspp);
422 dscheck (cdev_t dev, struct bio *bio, struct diskslices *ssp);
423 void dsclose (cdev_t dev, int mode, struct diskslices *ssp);
424 void dsgone (struct diskslices **sspp);
425 int dsioctl (cdev_t dev, u_long cmd, caddr_t data, int flags,
426 struct diskslices **sspp, struct disk_info *info);
427 int dsisopen (struct diskslices *ssp);
429 dsmakeslicestruct (int nslices, struct disk_info *info);
430 char *dsname (cdev_t dev, int unit, int slice, int part,
432 int dsopen (cdev_t dev, int mode, u_int flags,
433 struct diskslices **sspp, struct disk_info *info);
434 int64_t dssize (cdev_t dev, struct diskslices **sspp);
437 * Ancillary functions
440 void diskerr (struct bio *bio, cdev_t dev, const char *what, int pri,
442 void disksort (struct buf *ap, struct buf *bp);
443 void bioqdisksort (struct bio_queue_head *ap, struct bio *bio);
447 #endif /* !_SYS_DISKSLICE_H_ */