sys/sys/disklabel.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$
  35  */
  36
  37 #ifndef _SYS_DISKLABEL_H_
  38 #define _SYS_DISKLABEL_H_
  39
  40 #ifndef _KERNEL
  41 #include <sys/types.h>
  42 #endif
  43 #include <sys/ioccom.h>
  44
  45 /*
  46  * Disk description table, see disktab(5)
  47  */
  48 #define _PATH_DISKTAB   "/etc/disktab"
  49
  50 /*
  51  * Each disk has a label which includes information about the hardware
  52  * disk geometry, filesystem partitions, and drive specific information.
  53  * The label is in block 0 or 1, possibly offset from the beginning
  54  * to leave room for a bootstrap, etc.
  55  */
  56
  57 /* XXX these should be defined per controller (or drive) elsewhere, not here! */
  58 #ifdef __i386__
  59 #define LABELSECTOR     1                       /* sector containing label */
  60 #define LABELOFFSET     0                       /* offset of label in sector */
  61 #endif
  62
  63 #ifdef __alpha__
  64 #define LABELSECTOR     0
  65 #define LABELOFFSET     64
  66 #endif
  67
  68 #ifdef __ia64__
  69 #define LABELSECTOR     1
  70 #define LABELOFFSET     0
  71 #endif
  72
  73 #ifdef __sparc64__
  74 #define LABELSECTOR     0
  75 #define LABELOFFSET     128
  76 #endif
  77
  78 #ifndef LABELSECTOR
  79 #define LABELSECTOR     0
  80 #endif
  81
  82 #ifndef LABELOFFSET
  83 #define LABELOFFSET     64
  84 #endif
  85
  86 #define DISKMAGIC       ((u_int32_t)0x82564557) /* The disk magic number */
  87 #ifndef MAXPARTITIONS
  88 #define MAXPARTITIONS   8
  89 #endif
  90
  91 /* Size of bootblock area in sector-size neutral bytes */
  92 #define BBSIZE          8192
  93
  94 #define LABEL_PART      2               /* partition containing label */
  95 #define RAW_PART        2               /* partition containing whole disk */
  96 #define SWAP_PART       1               /* partition normally containing swap */
  97
  98 struct disklabel {
  99         u_int32_t d_magic;              /* the magic number */
 100         u_int16_t d_type;               /* drive type */
 101         u_int16_t d_subtype;            /* controller/d_type specific */
 102         char      d_typename[16];       /* type name, e.g. "eagle" */
 103
 104         char      d_packname[16];       /* pack identifier */
 105
 106                         /* disk geometry: */
 107         u_int32_t d_secsize;            /* # of bytes per sector */
 108         u_int32_t d_nsectors;           /* # of data sectors per track */
 109         u_int32_t d_ntracks;            /* # of tracks per cylinder */
 110         u_int32_t d_ncylinders;         /* # of data cylinders per unit */
 111         u_int32_t d_secpercyl;          /* # of data sectors per cylinder */
 112         u_int32_t d_secperunit;         /* # of data sectors per unit */
 113
 114         /*
 115          * Spares (bad sector replacements) below are not counted in
 116          * d_nsectors or d_secpercyl.  Spare sectors are assumed to
 117          * be physical sectors which occupy space at the end of each
 118          * track and/or cylinder.
 119          */
 120         u_int16_t d_sparespertrack;     /* # of spare sectors per track */
 121         u_int16_t d_sparespercyl;       /* # of spare sectors per cylinder */
 122         /*
 123          * Alternate cylinders include maintenance, replacement, configuration
 124          * description areas, etc.
 125          */
 126         u_int32_t d_acylinders;         /* # of alt. cylinders per unit */
 127
 128                         /* hardware characteristics: */
 129         /*
 130          * d_interleave, d_trackskew and d_cylskew describe perturbations
 131          * in the media format used to compensate for a slow controller.
 132          * Interleave is physical sector interleave, set up by the
 133          * formatter or controller when formatting.  When interleaving is
 134          * in use, logically adjacent sectors are not physically
 135          * contiguous, but instead are separated by some number of
 136          * sectors.  It is specified as the ratio of physical sectors
 137          * traversed per logical sector.  Thus an interleave of 1:1
 138          * implies contiguous layout, while 2:1 implies that logical
 139          * sector 0 is separated by one sector from logical sector 1.
 140          * d_trackskew is the offset of sector 0 on track N relative to
 141          * sector 0 on track N-1 on the same cylinder.  Finally, d_cylskew
 142          * is the offset of sector 0 on cylinder N relative to sector 0
 143          * on cylinder N-1.
 144          */
 145         u_int16_t d_rpm;                /* rotational speed */
 146         u_int16_t d_interleave;         /* hardware sector interleave */
 147         u_int16_t d_trackskew;          /* sector 0 skew, per track */
 148         u_int16_t d_cylskew;            /* sector 0 skew, per cylinder */
 149         u_int32_t d_headswitch;         /* head switch time, usec */
 150         u_int32_t d_trkseek;            /* track-to-track seek, usec */
 151         u_int32_t d_flags;              /* generic flags */
 152 #define NDDATA 5
 153         u_int32_t d_drivedata[NDDATA];  /* drive-type specific information */
 154 #define NSPARE 5
 155         u_int32_t d_spare[NSPARE];      /* reserved for future use */
 156         u_int32_t d_magic2;             /* the magic number (again) */
 157         u_int16_t d_checksum;           /* xor of data incl. partitions */
 158
 159                         /* filesystem and partition information: */
 160         u_int16_t d_npartitions;        /* number of partitions in following */
 161         u_int32_t d_bbsize;             /* size of boot area at sn0, bytes */
 162         u_int32_t d_sbsize;             /* max size of fs superblock, bytes */
 163         struct partition {              /* the partition table */
 164                 u_int32_t p_size;       /* number of sectors in partition */
 165                 u_int32_t p_offset;     /* starting sector */
 166                 u_int32_t p_fsize;      /* filesystem basic fragment size */
 167                 u_int8_t p_fstype;      /* filesystem type, see below */
 168                 u_int8_t p_frag;        /* filesystem fragments per block */
 169                 u_int16_t p_cpg;        /* filesystem cylinders per group */
 170         } d_partitions[MAXPARTITIONS];  /* actually may be more */
 171 };
 172
 173 #ifdef CTASSERT
 174 CTASSERT(sizeof(struct disklabel) == 276);
 175 #endif
 176
 177 static __inline u_int16_t dkcksum(struct disklabel *lp);
 178 static __inline u_int16_t
 179 dkcksum(struct disklabel *lp)
 180 {
 181         u_int16_t *start, *end;
 182         u_int16_t sum = 0;
 183
 184         start = (u_int16_t *)lp;
 185         end = (u_int16_t *)&lp->d_partitions[lp->d_npartitions];
 186         while (start < end)
 187                 sum ^= *start++;
 188         return (sum);
 189 }
 190
 191
 192 /* d_type values: */
 193 #define DTYPE_SMD               1               /* SMD, XSMD; VAX hp/up */
 194 #define DTYPE_MSCP              2               /* MSCP */
 195 #define DTYPE_DEC               3               /* other DEC (rk, rl) */
 196 #define DTYPE_SCSI              4               /* SCSI */
 197 #define DTYPE_ESDI              5               /* ESDI interface */
 198 #define DTYPE_ST506             6               /* ST506 etc. */
 199 #define DTYPE_HPIB              7               /* CS/80 on HP-IB */
 200 #define DTYPE_HPFL              8               /* HP Fiber-link */
 201 #define DTYPE_FLOPPY            10              /* floppy */
 202 #define DTYPE_CCD               11              /* concatenated disk */
 203 #define DTYPE_VINUM             12              /* vinum volume */
 204 #define DTYPE_DOC2K             13              /* Msys DiskOnChip */
 205 #define DTYPE_JFS2              16              /* IBM JFS 2 */
 206
 207 #ifdef DKTYPENAMES
 208 static const char *dktypenames[] = {
 209         "unknown",
 210         "SMD",
 211         "MSCP",
 212         "old DEC",
 213         "SCSI",
 214         "ESDI",
 215         "ST506",
 216         "HP-IB",
 217         "HP-FL",
 218         "type 9",
 219         "floppy",
 220         "CCD",
 221         "Vinum",
 222         "DOC2K",
 223         "?",
 224         "?",
 225         "jfs",
 226         NULL
 227 };
 228 #define DKMAXTYPES      (sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
 229 #endif
 230
 231 /*
 232  * Filesystem type and version.
 233  * Used to interpret other filesystem-specific
 234  * per-partition information.
 235  */
 236 #define FS_UNUSED       0               /* unused */
 237 #define FS_SWAP         1               /* swap */
 238 #define FS_V6           2               /* Sixth Edition */
 239 #define FS_V7           3               /* Seventh Edition */
 240 #define FS_SYSV         4               /* System V */
 241 #define FS_V71K         5               /* V7 with 1K blocks (4.1, 2.9) */
 242 #define FS_V8           6               /* Eighth Edition, 4K blocks */
 243 #define FS_BSDFFS       7               /* 4.2BSD fast filesystem */
 244 #define FS_MSDOS        8               /* MSDOS filesystem */
 245 #define FS_BSDLFS       9               /* 4.4BSD log-structured filesystem */
 246 #define FS_OTHER        10              /* in use, but unknown/unsupported */
 247 #define FS_HPFS         11              /* OS/2 high-performance filesystem */
 248 #define FS_ISO9660      12              /* ISO 9660, normally CD-ROM */
 249 #define FS_BOOT         13              /* partition contains bootstrap */
 250 #define FS_VINUM        14              /* Vinum drive */
 251 #define FS_JFS2         21              /* IBM JFS2 */
 252
 253 #ifdef  FSTYPENAMES
 254 static const char *fstypenames[] = {
 255         "unused",
 256         "swap",
 257         "Version 6",
 258         "Version 7",
 259         "System V",
 260         "4.1BSD",
 261         "Eighth Edition",
 262         "4.2BSD",
 263         "MSDOS",
 264         "4.4LFS",
 265         "unknown",
 266         "HPFS",
 267         "ISO9660",
 268         "boot",
 269         "vinum",
 270         "?",
 271         "?",
 272         "?",
 273         "?",
 274         "?",
 275         "?",
 276         "?",
 277         "jfs",
 278         NULL
 279 };
 280 #define FSMAXTYPES      (sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
 281 #endif
 282
 283 /*
 284  * flags shared by various drives:
 285  */
 286 #define D_REMOVABLE     0x01            /* removable media */
 287 #define D_ECC           0x02            /* supports ECC */
 288 #define D_BADSECT       0x04            /* supports bad sector forw. */
 289 #define D_RAMDISK       0x08            /* disk emulator */
 290 #define D_CHAIN         0x10            /* can do back-back transfers */
 291
 292 /* DOS partition table -- located in boot block */
 293
 294 #if defined(PC98) && !defined(PC98_ATCOMPAT)
 295 #define DOSBBSECTOR     0       /* DOS boot block relative sector number */
 296 #define DOSPARTOFF      0
 297 #define NDOSPART        16
 298 #define DOSPTYP_386BSD  0x94    /* 386BSD partition type */
 299
 300 struct dos_partition {
 301         unsigned char   dp_mid;
 302 #define DOSMID_386BSD           (0x14|0x80) /* 386bsd|bootable */
 303         unsigned char   dp_sid;
 304 #define DOSSID_386BSD           (0x44|0x80) /* 386bsd|active */
 305         unsigned char   dp_dum1;
 306         unsigned char   dp_dum2;
 307         unsigned char   dp_ipl_sct;
 308         unsigned char   dp_ipl_head;
 309         unsigned short  dp_ipl_cyl;
 310         unsigned char   dp_ssect;       /* starting sector */
 311         unsigned char   dp_shd;         /* starting head */
 312         unsigned short  dp_scyl;        /* starting cylinder */
 313         unsigned char   dp_esect;       /* end sector */
 314         unsigned char   dp_ehd;         /* end head */
 315         unsigned short  dp_ecyl;        /* end cylinder */
 316         unsigned char   dp_name[16];
 317 };
 318
 319 #else /* IBMPC */
 320 #define DOSBBSECTOR     0       /* DOS boot block relative sector number */
 321 #define DOSPARTOFF      446
 322 #define NDOSPART        4
 323 #define DOSPTYP_386BSD  0xa5    /* 386BSD partition type */
 324 #define DOSPTYP_LINSWP  0x82    /* Linux swap partition */
 325 #define DOSPTYP_LINUX   0x83    /* Linux partition */
 326 #define DOSPTYP_EXT     5       /* DOS extended partition */
 327 #define DOSPTYP_EXTLBA  15      /* DOS extended partition */
 328
 329 struct dos_partition {
 330         unsigned char   dp_flag;        /* bootstrap flags */
 331         unsigned char   dp_shd;         /* starting head */
 332         unsigned char   dp_ssect;       /* starting sector */
 333         unsigned char   dp_scyl;        /* starting cylinder */
 334         unsigned char   dp_typ;         /* partition type */
 335         unsigned char   dp_ehd;         /* end head */
 336         unsigned char   dp_esect;       /* end sector */
 337         unsigned char   dp_ecyl;        /* end cylinder */
 338         u_int32_t       dp_start;       /* absolute starting sector number */
 339         u_int32_t       dp_size;        /* partition size in sectors */
 340 };
 341 #ifdef CTASSERT
 342 CTASSERT(sizeof (struct dos_partition) == 16);
 343 #endif
 344 #endif
 345
 346 #define DPSECT(s) ((s) & 0x3f)          /* isolate relevant bits of sector */
 347 #define DPCYL(c, s) ((c) + (((s) & 0xc0)<<2)) /* and those that are cylinder */
 348
 349 /*
 350  * Disklabel-specific ioctls.
 351  *
 352  * NB: <sys/disk.h> defines ioctls from 'd'/128 and up.
 353  */
 354                 /* get and set disklabel */
 355 #define DIOCGDINFO      _IOR('d', 101, struct disklabel)/* get */
 356 #define DIOCSDINFO      _IOW('d', 102, struct disklabel)/* set */
 357 #define DIOCWDINFO      _IOW('d', 103, struct disklabel)/* set, update disk */
 358 #define DIOCGDVIRGIN    _IOR('d', 105, struct disklabel)/* get virgin label */
 359
 360 #define DIOCWLABEL      _IOW('d', 109, int)     /* write en/disable label */
 361
 362 #ifdef _KERNEL
 363
 364 /*
 365  * XXX encoding of disk minor numbers, should be elsewhere.
 366  *
 367  * See <sys/reboot.h> for a possibly better encoding.
 368  *
 369  * "cpio -H newc" can be used to back up device files with large minor
 370  * numbers (but not ones >= 2^31).  Old cpio formats and all tar formats
 371  * don't have enough bits, and cpio and tar don't notice the lossage.
 372  * There are also some sign extension bugs.
 373  */
 374
 375 /*
 376        3                   2                   1                   0
 377      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
 378     _________________________________________________________________
 379     | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
 380     -----------------------------------------------------------------
 381     |    SPARE    |UNIT_2 | SLICE   |  MAJOR?       |  UNIT   |PART |
 382     -----------------------------------------------------------------
 383 */
 384
 385 #define DKMAXUNIT       0x1ff
 386
 387 #define dkmakeminor(unit, slice, part) \
 388                                 (((slice) << 16) | (((unit) & 0x1e0) << 16) | \
 389                                 (((unit) & 0x1f) << 3) | (part))
 390 #define dkpart(dev)             (minor(dev) & 7)
 391 #define dkslice(dev)            ((minor(dev) >> 16) & 0x1f)
 392 #define dksparebits(dev)        ((minor(dev) >> 25) & 0x7f)
 393
 394 struct  bio;
 395 struct  bio_queue_head;
 396
 397 int     bounds_check_with_label(struct bio *bp, struct disklabel *lp,
 398             int wlabel);
 399 void    diskerr(struct bio *bp, char *what, int blkdone, struct disklabel *lp);
 400 dev_t   dkmodpart(dev_t dev, int part);
 401 dev_t   dkmodslice(dev_t dev, int slice);
 402 u_int   dkunit(dev_t dev);
 403 char    *readdisklabel(dev_t dev, struct disklabel *lp);
 404 void    bioqdisksort(struct bio_queue_head *ap, struct bio *bp);
 405 int     setdisklabel(struct disklabel *olp, struct disklabel *nlp,
 406             u_long openmask);
 407 int     writedisklabel(dev_t dev, struct disklabel *lp);
 408 #ifdef __alpha__
 409 struct  buf;
 410 void    alpha_fix_srm_checksum(struct buf *bp);
 411 #endif
 412
 413 #endif /* _KERNEL */
 414
 415
 416 #ifndef _KERNEL
 417 __BEGIN_DECLS
 418 struct disklabel *getdiskbyname(const char *);
 419 __END_DECLS
 420 #endif
 421
 422 #endif /* !_SYS_DISKLABEL_H_ */