sys/sys/disklabel32.h

   1 /*
   2  * Copyright (c) 1987, 1988, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)disklabel.h 8.2 (Berkeley) 7/10/94
  34  * $FreeBSD: src/sys/sys/disklabel.h,v 1.49.2.7 2001/05/27 05:58:26 jkh Exp $
  35  * $DragonFly: src/sys/sys/disklabel32.h,v 1.22 2007/05/17 23:49:56 dillon Exp $
  36  */
  37
  38 #ifndef _SYS_DISKLABEL_H_
  39 #define _SYS_DISKLABEL_H_
  40
  41 #ifndef _SYS_TYPES_H_
  42 #include <sys/types.h>
  43 #endif
  44 #if defined(_KERNEL) && !defined(_SYS_SYSTM_H_)
  45 #include <sys/systm.h>
  46 #endif
  47 #ifndef _SYS_IOCCOM_H_
  48 #include <sys/ioccom.h>
  49 #endif
  50 #if defined(_KERNEL) && !defined(_SYS_CONF_H_)
  51 #include <sys/conf.h>           /* for make_sub_dev() */
  52 #endif
  53
  54 /*
  55  * Each disk has a label which includes information about the hardware
  56  * disk geometry, filesystem partitions, and drive specific information.
  57  * The label is in block 0 or 1, possibly offset from the beginning
  58  * to leave room for a bootstrap, etc.
  59  */
  60
  61 /* XXX these should be defined per controller (or drive) elsewhere, not here! */
  62 #ifdef __i386__
  63 #define LABELSECTOR     1                       /* sector containing label */
  64 #define LABELOFFSET     0                       /* offset of label in sector */
  65 #endif
  66
  67 #ifndef LABELSECTOR
  68 #define LABELSECTOR     0                       /* sector containing label */
  69 #endif
  70
  71 #ifndef LABELOFFSET
  72 #define LABELOFFSET     64                      /* offset of label in sector */
  73 #endif
  74
  75 #define DISKMAGIC       ((u_int32_t)0x82564557) /* The disk magic number */
  76 #ifndef MAXPARTITIONS
  77 #define MAXPARTITIONS   16
  78 #endif
  79
  80 #define LABEL_PART      2               /* partition containing label */
  81 #define RAW_PART        2               /* partition containing whole disk */
  82 #define SWAP_PART       1               /* partition normally containing swap */
  83
  84 #ifndef LOCORE
  85 struct disklabel {
  86         u_int32_t d_magic;              /* the magic number */
  87         u_int16_t d_type;               /* drive type */
  88         u_int16_t d_subtype;            /* controller/d_type specific */
  89         char      d_typename[16];       /* type name, e.g. "eagle" */
  90
  91         /*
  92          * d_packname contains the pack identifier and is returned when
  93          * the disklabel is read off the disk or in-core copy.
  94          * d_boot0 and d_boot1 are the (optional) names of the
  95          * primary (block 0) and secondary (block 1-15) bootstraps
  96          * as found in /boot.  These are returned when using
  97          * getdiskbyname(3) to retrieve the values from /etc/disktab.
  98          */
  99         union {
 100                 char    un_d_packname[16];      /* pack identifier */
 101                 struct {
 102                         char *un_d_boot0;       /* primary bootstrap name */
 103                         char *un_d_boot1;       /* secondary bootstrap name */
 104                 } un_b;
 105         } d_un;
 106 #define d_packname      d_un.un_d_packname
 107 #define d_boot0         d_un.un_b.un_d_boot0
 108 #define d_boot1         d_un.un_b.un_d_boot1
 109
 110                         /* disk geometry: */
 111         u_int32_t d_secsize;            /* # of bytes per sector */
 112         u_int32_t d_nsectors;           /* # of data sectors per track */
 113         u_int32_t d_ntracks;            /* # of tracks per cylinder */
 114         u_int32_t d_ncylinders;         /* # of data cylinders per unit */
 115         u_int32_t d_secpercyl;          /* # of data sectors per cylinder */
 116         u_int32_t d_secperunit;         /* # of data sectors per unit */
 117
 118         /*
 119          * Spares (bad sector replacements) below are not counted in
 120          * d_nsectors or d_secpercyl.  Spare sectors are assumed to
 121          * be physical sectors which occupy space at the end of each
 122          * track and/or cylinder.
 123          */
 124         u_int16_t d_sparespertrack;     /* # of spare sectors per track */
 125         u_int16_t d_sparespercyl;       /* # of spare sectors per cylinder */
 126         /*
 127          * Alternate cylinders include maintenance, replacement, configuration
 128          * description areas, etc.
 129          */
 130         u_int32_t d_acylinders;         /* # of alt. cylinders per unit */
 131
 132                         /* hardware characteristics: */
 133         /*
 134          * d_interleave, d_trackskew and d_cylskew describe perturbations
 135          * in the media format used to compensate for a slow controller.
 136          * Interleave is physical sector interleave, set up by the
 137          * formatter or controller when formatting.  When interleaving is
 138          * in use, logically adjacent sectors are not physically
 139          * contiguous, but instead are separated by some number of
 140          * sectors.  It is specified as the ratio of physical sectors
 141          * traversed per logical sector.  Thus an interleave of 1:1
 142          * implies contiguous layout, while 2:1 implies that logical
 143          * sector 0 is separated by one sector from logical sector 1.
 144          * d_trackskew is the offset of sector 0 on track N relative to
 145          * sector 0 on track N-1 on the same cylinder.  Finally, d_cylskew
 146          * is the offset of sector 0 on cylinder N relative to sector 0
 147          * on cylinder N-1.
 148          */
 149         u_int16_t d_rpm;                /* rotational speed */
 150         u_int16_t d_interleave;         /* hardware sector interleave */
 151         u_int16_t d_trackskew;          /* sector 0 skew, per track */
 152         u_int16_t d_cylskew;            /* sector 0 skew, per cylinder */
 153         u_int32_t d_headswitch;         /* head switch time, usec */
 154         u_int32_t d_trkseek;            /* track-to-track seek, usec */
 155         u_int32_t d_flags;              /* generic flags (now unused) */
 156 #define NDDATA 5
 157         u_int32_t d_drivedata[NDDATA];  /* drive-type specific information */
 158 #define NSPARE 5
 159         u_int32_t d_spare[NSPARE];      /* reserved for future use */
 160         u_int32_t d_magic2;             /* the magic number (again) */
 161         u_int16_t d_checksum;           /* xor of data incl. partitions */
 162
 163                         /* filesystem and partition information: */
 164         u_int16_t d_npartitions;        /* number of partitions in following */
 165         u_int32_t d_bbsize;             /* size of boot area at sn0, bytes */
 166         u_int32_t d_sbsize;             /* max size of fs superblock, bytes */
 167         struct  partition {             /* the partition table */
 168                 u_int32_t p_size;       /* number of sectors in partition */
 169                 u_int32_t p_offset;     /* starting sector */
 170                 u_int32_t p_fsize;      /* filesystem basic fragment size */
 171                 u_int8_t p_fstype;      /* filesystem type, see below */
 172                 u_int8_t p_frag;        /* filesystem fragments per block */
 173                 union {
 174                         u_int16_t cpg;  /* UFS: FS cylinders per group */
 175                         u_int16_t sgs;  /* LFS: FS segment shift */
 176                 } __partition_u1;
 177 #define p_cpg   __partition_u1.cpg
 178 #define p_sgs   __partition_u1.sgs
 179         } d_partitions[MAXPARTITIONS];  /* actually may be more */
 180 };
 181
 182 static u_int16_t dkcksum(struct disklabel *lp);
 183
 184 static __inline u_int16_t
 185 dkcksum(struct disklabel *lp)
 186 {
 187         u_int16_t *start, *end;
 188         u_int16_t sum = 0;
 189
 190         start = (u_int16_t *)lp;
 191         end = (u_int16_t *)&lp->d_partitions[lp->d_npartitions];
 192         while (start < end)
 193                 sum ^= *start++;
 194         return (sum);
 195 }
 196
 197 #else /* LOCORE */
 198         /*
 199          * offsets for asm boot files.
 200          */
 201         .set    d_secsize,40
 202         .set    d_nsectors,44
 203         .set    d_ntracks,48
 204         .set    d_ncylinders,52
 205         .set    d_secpercyl,56
 206         .set    d_secperunit,60
 207         .set    d_end_,276              /* size of disk label */
 208 #endif /* LOCORE */
 209
 210 /* d_type values: */
 211 #define DTYPE_SMD               1               /* SMD, XSMD; VAX hp/up */
 212 #define DTYPE_MSCP              2               /* MSCP */
 213 #define DTYPE_DEC               3               /* other DEC (rk, rl) */
 214 #define DTYPE_SCSI              4               /* SCSI */
 215 #define DTYPE_ESDI              5               /* ESDI interface */
 216 #define DTYPE_ST506             6               /* ST506 etc. */
 217 #define DTYPE_HPIB              7               /* CS/80 on HP-IB */
 218 #define DTYPE_HPFL              8               /* HP Fiber-link */
 219 #define DTYPE_FLOPPY            10              /* floppy */
 220 #define DTYPE_CCD               11              /* concatenated disk */
 221 #define DTYPE_VINUM             12              /* vinum volume */
 222 #define DTYPE_DOC2K             13              /* Msys DiskOnChip */
 223
 224 #ifdef DKTYPENAMES
 225 static const char *dktypenames[] = {
 226         "unknown",
 227         "SMD",
 228         "MSCP",
 229         "old DEC",
 230         "SCSI",
 231         "ESDI",
 232         "ST506",
 233         "HP-IB",
 234         "HP-FL",
 235         "type 9",
 236         "floppy",
 237         "CCD",
 238         "Vinum",
 239         "DOC2K",
 240         NULL
 241 };
 242 #define DKMAXTYPES      (sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
 243 #endif
 244
 245 /*
 246  * Filesystem type and version.
 247  * Used to interpret other filesystem-specific
 248  * per-partition information.
 249  */
 250 #define FS_UNUSED       0               /* unused */
 251 #define FS_SWAP         1               /* swap */
 252 #define FS_V6           2               /* Sixth Edition */
 253 #define FS_V7           3               /* Seventh Edition */
 254 #define FS_SYSV         4               /* System V */
 255 #define FS_V71K         5               /* V7 with 1K blocks (4.1, 2.9) */
 256 #define FS_V8           6               /* Eighth Edition, 4K blocks */
 257 #define FS_BSDFFS       7               /* 4.2BSD fast file system */
 258 #define FS_MSDOS        8               /* MSDOS file system */
 259 #define FS_BSDLFS       9               /* 4.4BSD log-structured file system */
 260 #define FS_OTHER        10              /* in use, but unknown/unsupported */
 261 #define FS_HPFS         11              /* OS/2 high-performance file system */
 262 #define FS_ISO9660      12              /* ISO 9660, normally CD-ROM */
 263 #define FS_BOOT         13              /* partition contains bootstrap */
 264 #define FS_VINUM        14              /* Vinum drive partition */
 265 #define FS_RAID         15
 266 #define FS_RESERVED16   16
 267 #define FS_RESERVED17   17
 268 #define FS_RESERVED18   18
 269 #define FS_CCD          19              /* CCD drive partition */
 270 #define FS_RESERVED20   20
 271 #define FS_JFS2         21
 272
 273 #ifdef  DKTYPENAMES
 274 static const char *fstypenames[] = {
 275         "unused",
 276         "swap",
 277         "Version 6",
 278         "Version 7",
 279         "System V",
 280         "4.1BSD",
 281         "Eighth Edition",
 282         "4.2BSD",
 283         "MSDOS",
 284         "4.4LFS",
 285         "unknown",
 286         "HPFS",
 287         "ISO9660",
 288         "boot",
 289         "vinum",
 290         "raid",
 291         "?",
 292         "?",
 293         "?",
 294         "ccd",
 295         "?",    /* don't use in case freebsd reassigns jfs / bug in freebsd */
 296         "jfs",
 297         NULL
 298 };
 299 #define FSMAXTYPES      (sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
 300 #endif
 301
 302 #ifndef LOCORE
 303
 304 /*
 305  * Disk-specific ioctls.
 306  */
 307 #define DIOCGDINFO      _IOR('d', 101, struct disklabel)/* get */
 308 #define DIOCSDINFO      _IOW('d', 102, struct disklabel)/* set */
 309 #define DIOCWDINFO      _IOW('d', 103, struct disklabel)/* set, update disk */
 310 #define DIOCGDVIRGIN    _IOR('d', 105, struct disklabel) /* get virgin label */
 311
 312 #define DIOCWLABEL      _IOW('d', 109, int)     /* write en/disable label */
 313
 314 #ifdef _KERNEL
 315
 316 /*
 317  * XXX encoding of disk minor numbers, should be elsewhere.
 318  *
 319  * See <sys/reboot.h> for a possibly better encoding.
 320  *
 321  * "cpio -H newc" can be used to back up device files with large minor
 322  * numbers (but not ones >= 2^31).  Old cpio formats and all tar formats
 323  * don't have enough bits, and cpio and tar don't notice the lossage.
 324  * There are also some sign extension bugs.
 325  */
 326
 327 /*
 328        3                   2                   1                   0
 329      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
 330     _________________________________________________________________
 331     | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
 332     -----------------------------------------------------------------
 333     |    TYPE     |UNIT_2 |P| SLICE |  MAJOR?       |  UNIT   |PART |
 334     -----------------------------------------------------------------
 335 */
 336
 337 #define DKMAXUNIT 0x1ff         /* Highest disk unit number */
 338
 339 #define dkmakeminor(unit, slice, part) \
 340                                 (((slice) << 16) | (((unit) & 0x1e0) << 16) | \
 341                                 (((unit) & 0x1f) << 3) | (part & 7) | \
 342                                 ((part & 0x08) << 17))
 343
 344 static __inline u_int
 345 dkunitmask(void)
 346 {
 347         return (0x01e000f8);
 348 }
 349
 350 static __inline u_int
 351 dkmakeunit(int unit)
 352 {
 353         return(dkmakeminor(unit, 0, 0));
 354 }
 355
 356 static __inline cdev_t
 357 dkmodpart(cdev_t dev, int part)
 358 {
 359         int val;
 360
 361         if (part < 8)
 362                 val = (part & 7);
 363         else
 364                 val = (part & 7) | 0x100000;
 365         return (make_sub_dev(dev, (minor(dev) & ~0x100007) | val));
 366 }
 367
 368 static __inline cdev_t
 369 dkmodslice(cdev_t dev, int slice)
 370 {
 371         return (make_sub_dev(dev, (minor(dev) & ~0x0f0000) | (slice << 16)));
 372 }
 373
 374 static __inline int
 375 dkpart(cdev_t dev)
 376 {
 377         return (((minor(dev) >> 17) & 0x08) | (minor(dev) & 7));
 378 }
 379
 380 #define dkslice(dev)            ((minor(dev) >> 16) & 0x0f)
 381 #define dktype(dev)             ((minor(dev) >> 25) & 0x7f)
 382
 383 static __inline u_int
 384 dkunit(cdev_t dev)
 385 {
 386         return (((minor(dev) >> 16) & 0x1e0) | ((minor(dev) >> 3) & 0x1f));
 387 }
 388
 389 struct  buf;
 390 struct  bio;
 391 struct  bio_queue_head;
 392
 393 struct bio *bounds_check_with_label (cdev_t dev, struct bio *bio,
 394                                      struct disklabel *lp, int wlabel);
 395 void    diskerr (struct bio *bio, cdev_t dev, const char *what, int pri,
 396                      int donecnt);
 397 void    disksort (struct buf *ap, struct buf *bp);
 398 char    *readdisklabel (cdev_t dev, struct disklabel *lp);
 399 void    bioqdisksort (struct bio_queue_head *ap, struct bio *bio);
 400 int     setdisklabel (struct disklabel *olp, struct disklabel *nlp,
 401                           u_long openmask);
 402 int     writedisklabel (cdev_t dev, struct disklabel *lp);
 403
 404 #endif /* _KERNEL */
 405
 406 #endif /* LOCORE */
 407
 408 #endif /* !_SYS_DISKLABEL_H_ */