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