sys/sys/diskslice.h

   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.18 2007/06/13 20:58:38 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_IOCCOM_H_
  70 #include <sys/ioccom.h>
  71 #endif
  72 #if defined(_KERNEL)
  73 #ifndef _SYS_CONF_H_
  74 #include <sys/conf.h>           /* for make_sub_dev() */
  75 #endif
  76 #ifndef _SYS_SYSTM_H_
  77 #include <sys/systm.h>          /* for minor() */
  78 #endif
  79 #endif
  80
  81 #define BASE_SLICE              2       /* e.g. ad0s1 */
  82 #define COMPATIBILITY_SLICE     0       /* e.g. ad0a-j */
  83                                 /* 101 - compat disklabel DIOCGDINFO    */
  84                                 /* 102 - compat disklabel DIOCSDINFO    */
  85                                 /* 103 - compat disklabel DIOCWDINFO    */
  86                                 /* 104 - DIOCGPART (see below)          */
  87                                 /* 105 - compat disklabel DIOCGDVIRGIN  */
  88 #define DIOCWLABEL              _IOW('d', 109, int)
  89 #define DIOCGSLICEINFO          _IOR('d', 111, struct diskslices)
  90 #define DIOCSYNCSLICEINFO       _IOW('d', 112, int)
  91 #define MAX_SLICES              16
  92
  93 /*
  94  * Support limits
  95  */
  96 #define DKMAXUNITS      512     /* maximum supported disk units */
  97 #define DKMAXSLICES     128     /* maximum supported slices (0 & 1 special) */
  98 #define DKRESPARTITIONS 128     /* 128+ have special meanings */
  99 #define DKMAXPARTITIONS 256     /* maximum supported in-kernel partitions */
 100
 101 /*
 102  * The whole-disk-slice does not try to interpret the MBR.  The whole slice
 103  * partition does not try to interpret the disklabel within the slice.
 104  */
 105 #define WHOLE_DISK_SLICE        1
 106 #define WHOLE_SLICE_PART        (DKMAXPARTITIONS - 1)
 107
 108 #ifdef MAXPARTITIONS                    /* XXX don't depend on disklabel.h */
 109 #if MAXPARTITIONS !=    16              /* but check consistency if possible */
 110 #error "inconsistent MAXPARTITIONS"
 111 #endif
 112 #else
 113 #define MAXPARTITIONS   16
 114 #endif
 115
 116 /*
 117  * diskslice structure - slices up the disk and indicates where the
 118  * BSD labels are, if any.
 119  *
 120  * ds_skip_platform  -  sectors reserved by the platform abstraction,
 121  *                      typically to hold boot sectors and other junk.
 122  *                      The BSD label is placed after the reserved sectors.
 123  *
 124  *                      This field is typically non-zero for dos slices.
 125  *                      It will always be 0 for the whole-disk slice.
 126  *
 127  * ds_skip_bsdlabel  -  sectors reserved by the BSD label.  Always 0 when
 128  *                      the disk is accessed via the whole-disk slice.
 129  *
 130  *                      This field includes any sectors reserved by the
 131  *                      platform. e.g. in a dos slice the platform uses
 132  *                      1 sector (the boot code sector) and the disklabel
 133  *                      uses 15 sectors.  This field will be set to 16.
 134  *
 135  *                      This field would end up being set to one less for
 136  *                      a directly labeled disk, at least for a standard
 137  *                      bsd disklabel vs MBR + bsd disklabel.
 138  */
 139 struct diskslice {
 140         u_int64_t       ds_offset;      /* starting sector */
 141         u_int64_t       ds_size;        /* number of sectors */
 142         u_int32_t       ds_skip_platform;       /* in sectors */
 143         u_int32_t       ds_skip_bsdlabel;       /* in sectors */
 144         int             ds_type;        /* (foreign) slice type */
 145         struct disklabel *ds_label;     /* BSD label, if any */
 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)];
 149                                         /* devs open */
 150         u_char          ds_wlabel;      /* nonzero if label is writable */
 151         int             ds_ttlopens;    /* total opens, incl slice & raw */
 152 };
 153
 154 struct diskslices {
 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 */
 162         struct diskslice
 163                 dss_slices[MAX_SLICES]; /* actually usually less */
 164 };
 165
 166 /*
 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.
 169  *
 170  * NOTE: media_offset currently represents the byte offset on the raw device,
 171  * it is not a partition relative offset.
 172  *
 173  * skip_platform and skip_bsdlabel work as with the diskslice
 174  * structure.  For partitions within a disklabel these fields are usually
 175  * 0 except for partitions which overlap the label or slice reserved area
 176  * itself.  Those partitions will set these fields appropriately (relative
 177  * to the partition).  In particular, the 'a' and 'c' partitions are
 178  * protected.
 179  */
 180 struct partinfo {
 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) */
 185
 186         u_int32_t       skip_platform;  /* in sectors */
 187         u_int32_t       skip_bsdlabel;  /* in sectors */
 188         int             fstype;         /* filesystem type if numeric */
 189         char            fstypestr[16];  /* filesystem type as ascii */
 190
 191         /*
 192          * These fields are loaded from the diskinfo structure
 193          */
 194         u_int           d_nheads;
 195         u_int           d_ncylinders;
 196         u_int           d_secpertrack;
 197         u_int           d_secpercyl;
 198         u_int           d_reserved[16];
 199 };
 200
 201 #define DIOCGPART       _IOR('d', 104, struct partinfo) /* get partition */
 202
 203 /*
 204  * disk unit and slice helper functions
 205  *
 206  *     3                   2                   1                   0
 207  *   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
 208  *  _________________________________________________________________
 209  *  | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
 210  *  -----------------------------------------------------------------
 211  *  | SL2 | PART3 |UNIT_2 |P| SLICE |  MAJOR?       |  UNIT   |PART |
 212  *  -----------------------------------------------------------------
 213  */
 214
 215 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 216
 217 /*
 218  * Build a minor device number.
 219  */
 220 static __inline u_int32_t
 221 dkmakeminor(u_int32_t unit, u_int32_t slice, u_int32_t part)
 222 {
 223         u_int32_t val;
 224
 225         val = ((unit & 0x001f) << 3) | ((unit & 0x01e0) << 16) |
 226               ((slice & 0x000f) << 16) | ((slice & 0x0070) << 25) |
 227               (part & 0x0007) | ((part & 0x0008) << 17) |
 228               ((part & 0x00F0) << 21);
 229         return(val);
 230 }
 231
 232 /*
 233  * Generate the minor number representing the entire disk, with no
 234  * mbr or label interpretation.
 235  */
 236 static __inline u_int32_t
 237 dkmakewholedisk(u_int32_t unit)
 238 {
 239         return(dkmakeminor(unit, WHOLE_DISK_SLICE, WHOLE_SLICE_PART));
 240 }
 241
 242 /*
 243  * Generate the minor number representing an entire slice, with no
 244  * recursive mbr, boot sector, or label interpretation.
 245  */
 246 static __inline u_int32_t
 247 dkmakewholeslice(u_int32_t unit, u_int32_t slice)
 248 {
 249         return(dkmakeminor(unit, slice, WHOLE_SLICE_PART));
 250 }
 251
 252 /*
 253  * Return the unit mask, used in calls to make_dev()
 254  */
 255 static __inline u_int32_t
 256 dkunitmask(void)
 257 {
 258         return (0x01e000f8);
 259 }
 260
 261 /*
 262  * build minor number elements - encode unit number, slice, and partition
 263  * (OR the results together).
 264  */
 265 static __inline u_int32_t
 266 dkmakeunit(int unit)
 267 {
 268         return(dkmakeminor((u_int32_t)unit, 0, 0));
 269 }
 270
 271 static __inline u_int32_t
 272 dkmakeslice(int slice)
 273 {
 274         return(dkmakeminor(0, (u_int32_t)slice, 0));
 275 }
 276
 277 static __inline u_int32_t
 278 dkmakepart(int part)
 279 {
 280         return(dkmakeminor(0, 0, (u_int32_t)part));
 281 }
 282
 283 #endif
 284
 285 /*
 286  * dk*() support functions operating on cdev_t's
 287  */
 288 #ifdef _KERNEL
 289
 290 static __inline int
 291 dkunit(cdev_t dev)
 292 {
 293         u_int32_t val = minor(dev);
 294
 295         val = ((val >> 3) & 0x001f) | ((val >> 16) & 0x01e0);
 296         return((int)val);
 297 }
 298
 299 static __inline u_int32_t
 300 dkslice(cdev_t dev)
 301 {
 302         u_int32_t val = minor(dev);
 303
 304         val = ((val >> 16) & 0x000f) | ((val >> 25) & 0x0070);
 305         return(val);
 306 }
 307
 308 static __inline u_int32_t
 309 dkpart(cdev_t dev)
 310 {
 311         u_int32_t val = minor(dev);
 312
 313         val = (val & 0x0007) | ((val >> 17) & 0x0008) | ((val >> 21) & 0x00f0);
 314         return(val);
 315 }
 316
 317 /*
 318  * dkmodpart() - create sub-device
 319  */
 320 static __inline cdev_t
 321 dkmodpart(cdev_t dev, int part)
 322 {
 323         u_int32_t val;
 324
 325         val = (minor(dev) & ~dkmakepart(-1)) | dkmakepart(part);
 326         return (make_sub_dev(dev, val));
 327 }
 328
 329 static __inline cdev_t
 330 dkmodslice(cdev_t dev, int slice)
 331 {
 332         u_int32_t val;
 333
 334         val = (minor(dev) & ~dkmakeslice(-1)) | dkmakeslice(slice);
 335         return (make_sub_dev(dev, val));
 336 }
 337
 338 #endif
 339
 340 /*
 341  * Bitmask ops, keeping track of which partitions are open.
 342  */
 343 static __inline
 344 void
 345 dsclrmask(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 void
 353 dssetmask(struct diskslice *ds, int part)
 354 {
 355         part &= (DKMAXPARTITIONS - 1);
 356         ds->ds_openmask[part >> 5] |= (1 << (part & 31));
 357 }
 358
 359 static __inline
 360 int
 361 dschkmask(struct diskslice *ds, int part)
 362 {
 363         part &= (DKMAXPARTITIONS - 1);
 364         return (ds->ds_openmask[part >> 5] & (1 << (part & 31)));
 365 }
 366
 367 static __inline
 368 int
 369 dscountmask(struct diskslice *ds)
 370 {
 371         int count = 0;
 372         int i;
 373         int j;
 374
 375         for (i = 0; i < DKMAXPARTITIONS / 32; ++i) {
 376                 if (ds->ds_openmask[i]) {
 377                         for (j = 0; j < 32; ++j) {
 378                                 if (ds->ds_openmask[i] & (1 << j))
 379                                         ++count;
 380                         }
 381                 }
 382         }
 383         return(count);
 384 }
 385
 386 static __inline
 387 void
 388 dssetmaskfrommask(struct diskslice *ds, u_int32_t *tmask)
 389 {
 390         int i;
 391
 392         for (i = 0; i < DKMAXPARTITIONS / 32; ++i)
 393                 tmask[i] |= ds->ds_openmask[i];
 394 }
 395
 396 /*
 397  * disk management functions
 398  */
 399
 400 #ifdef _KERNEL
 401
 402 struct buf;
 403 struct bio;
 404 struct disklabel;
 405 struct disk_info;
 406 struct bio_queue_head;
 407
 408 int     mbrinit (cdev_t dev, struct disk_info *info,
 409                     struct diskslices **sspp);
 410 struct bio *
 411         dscheck (cdev_t dev, struct bio *bio, struct diskslices *ssp);
 412 void    dsclose (cdev_t dev, int mode, struct diskslices *ssp);
 413 void    dsgone (struct diskslices **sspp);
 414 int     dsioctl (cdev_t dev, u_long cmd, caddr_t data, int flags,
 415                     struct diskslices **sspp, struct disk_info *info);
 416 int     dsisopen (struct diskslices *ssp);
 417 struct diskslices *
 418         dsmakeslicestruct (int nslices, struct disk_info *info);
 419 char    *dsname (cdev_t dev, int unit, int slice, int part,
 420                     char *partname);
 421 int     dsopen (cdev_t dev, int mode, u_int flags,
 422                     struct diskslices **sspp, struct disk_info *info);
 423 int64_t dssize (cdev_t dev, struct diskslices **sspp);
 424
 425 /*
 426  * Ancillary functions
 427  */
 428
 429 void    diskerr (struct bio *bio, cdev_t dev, const char *what, int pri,
 430                     int donecnt);
 431 void    disksort (struct buf *ap, struct buf *bp);
 432 void    bioqdisksort (struct bio_queue_head *ap, struct bio *bio);
 433
 434 #endif /* _KERNEL */
 435
 436 #endif /* !_SYS_DISKSLICE_H_ */