sbin/disklabel/disklabel.5

   1 .\" Copyright (c) 1987, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Symmetric Computer Systems.
   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 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgment:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)disklabel.5.5       8.1 (Berkeley) 6/5/93
  36 .\" $FreeBSD$
  37 .\"
  38 .Dd June 5, 1993
  39 .Dt DISKLABEL 5
  40 .Os
  41 .Sh NAME
  42 .Nm disklabel
  43 .Nd disk pack label
  44 .Sh SYNOPSIS
  45 .In sys/disklabel.h
  46 .Sh DESCRIPTION
  47 Each disk or disk pack on a system may contain a disk label
  48 which provides detailed information
  49 about the geometry of the disk and the partitions into which the disk
  50 is divided.
  51 It should be initialized when the disk is formatted,
  52 and may be changed later with the
  53 .Xr disklabel 8
  54 program.
  55 This information is used by the system disk driver and by the bootstrap
  56 program to determine how to program the drive
  57 and where to find the filesystems on the disk partitions.
  58 Additional information is used by the filesystem in order
  59 to use the disk most efficiently and to locate important filesystem information.
  60 The description of each partition contains an identifier for the partition
  61 type (standard filesystem, swap area, etc.).
  62 The filesystem updates the in-core copy of the label if it contains
  63 incomplete information about the filesystem.
  64 .Pp
  65 The label is located in sector number
  66 .Dv LABELSECTOR
  67 of the drive, usually sector 0 where it may be found
  68 without any information about the disk geometry.
  69 It is at an offset
  70 .Dv LABELOFFSET
  71 from the beginning of the sector, to allow room for the initial bootstrap.
  72 The disk sector containing the label is normally made read-only
  73 so that it is not accidentally overwritten by pack-to-pack copies
  74 or swap operations;
  75 the
  76 .Dv DIOCWLABEL
  77 .Xr ioctl 2 ,
  78 which is done as needed by the
  79 .Xr disklabel 8
  80 program.
  81 .Pp
  82 A copy of the in-core label for a disk can be obtained with the
  83 .Dv DIOCGDINFO
  84 .Xr ioctl 2 ;
  85 this works with a file descriptor for a block or character (``raw'') device
  86 for any partition of the disk.
  87 The in-core copy of the label is set by the
  88 .Dv DIOCSDINFO
  89 .Xr ioctl 2 .
  90 The offset of a partition cannot generally be changed while it is open,
  91 nor can it be made smaller while it is open.
  92 One exception is that any change is allowed if no label was found
  93 on the disk, and the driver was able to construct only a skeletal label
  94 without partition information.
  95 Finally, the
  96 .Dv DIOCWDINFO
  97 .Xr ioctl 2
  98 operation sets the in-core label and then updates the on-disk label;
  99 there must be an existing label on the disk for this operation to succeed.
 100 Thus, the initial label for a disk or disk pack must be installed
 101 by writing to the raw disk.
 102 All of these operations are normally done using
 103 .Xr disklabel 8 .
 104 .Pp
 105 The format of the disk label, as specified in
 106 .Pa <sys/disklabel.h> ,
 107 is
 108 .Bd -literal
 109 #ifndef _SYS_DISKLABEL_H_
 110 #define _SYS_DISKLABEL_H_
 111
 112 #ifndef _KERNEL
 113 #include <sys/types.h>
 114 #endif
 115 #include <sys/ioccom.h>
 116
 117 /*
 118  * Disk description table, see disktab(5)
 119  */
 120 #define _PATH_DISKTAB   "/etc/disktab"
 121 #define DISKTAB         "/etc/disktab"          /* deprecated */
 122
 123 /*
 124  * Each disk has a label which includes information about the hardware
 125  * disk geometry, filesystem partitions, and drive specific information.
 126  * The label is in block 0 or 1, possibly offset from the beginning
 127  * to leave room for a bootstrap, etc.
 128  */
 129
 130 /* XXX these should be defined per controller (or drive) elsewhere, not here! */
 131 #ifdef __i386__
 132 #define LABELSECTOR     1                       /* sector containing label */
 133 #define LABELOFFSET     0                       /* offset of label in sector */
 134 #endif
 135
 136 #ifdef __alpha__
 137 #define LABELSECTOR     0
 138 #define LABELOFFSET     64
 139 #endif
 140
 141 #ifndef LABELSECTOR
 142 #define LABELSECTOR     0                       /* sector containing label */
 143 #endif
 144
 145 #ifndef LABELOFFSET
 146 #define LABELOFFSET     64                      /* offset of label in sector */
 147 #endif
 148
 149 #define DISKMAGIC       ((u_int32_t)0x82564557) /* The disk magic number */
 150 #ifndef MAXPARTITIONS
 151 #define MAXPARTITIONS   8
 152 #endif
 153
 154 #define LABEL_PART      2               /* partition containing label */
 155 #define RAW_PART        2               /* partition containing whole disk */
 156 #define SWAP_PART       1               /* partition normally containing swap */
 157
 158 #ifndef LOCORE
 159 struct disklabel {
 160         u_int32_t d_magic;              /* the magic number */
 161         u_int16_t d_type;               /* drive type */
 162         u_int16_t d_subtype;            /* controller/d_type specific */
 163         char      d_typename[16];       /* type name, e.g. "eagle" */
 164         char      d_packname[16];       /* pack identifier */
 165
 166                         /* disk geometry: */
 167         u_int32_t d_secsize;            /* # of bytes per sector */
 168         u_int32_t d_nsectors;           /* # of data sectors per track */
 169         u_int32_t d_ntracks;            /* # of tracks per cylinder */
 170         u_int32_t d_ncylinders;         /* # of data cylinders per unit */
 171         u_int32_t d_secpercyl;          /* # of data sectors per cylinder */
 172         u_int32_t d_secperunit;         /* # of data sectors per unit */
 173
 174         /*
 175          * Spares (bad sector replacements) below are not counted in
 176          * d_nsectors or d_secpercyl.  Spare sectors are assumed to
 177          * be physical sectors which occupy space at the end of each
 178          * track and/or cylinder.
 179          */
 180         u_int16_t d_sparespertrack;     /* # of spare sectors per track */
 181         u_int16_t d_sparespercyl;       /* # of spare sectors per cylinder */
 182         /*
 183          * Alternate cylinders include maintenance, replacement, configuration
 184          * description areas, etc.
 185          */
 186         u_int32_t d_acylinders;         /* # of alt. cylinders per unit */
 187
 188                         /* hardware characteristics: */
 189         /*
 190          * d_interleave, d_trackskew and d_cylskew describe perturbations
 191          * in the media format used to compensate for a slow controller.
 192          * Interleave is physical sector interleave, set up by the
 193          * formatter or controller when formatting.  When interleaving is
 194          * in use, logically adjacent sectors are not physically
 195          * contiguous, but instead are separated by some number of
 196          * sectors.  It is specified as the ratio of physical sectors
 197          * traversed per logical sector.  Thus an interleave of 1:1
 198          * implies contiguous layout, while 2:1 implies that logical
 199          * sector 0 is separated by one sector from logical sector 1.
 200          * d_trackskew is the offset of sector 0 on track N relative to
 201          * sector 0 on track N-1 on the same cylinder.  Finally, d_cylskew
 202          * is the offset of sector 0 on cylinder N relative to sector 0
 203          * on cylinder N-1.
 204          */
 205         u_int16_t d_rpm;                /* rotational speed */
 206         u_int16_t d_interleave;         /* hardware sector interleave */
 207         u_int16_t d_trackskew;          /* sector 0 skew, per track */
 208         u_int16_t d_cylskew;            /* sector 0 skew, per cylinder */
 209         u_int32_t d_headswitch;         /* head switch time, usec */
 210         u_int32_t d_trkseek;            /* track-to-track seek, usec */
 211         u_int32_t d_flags;              /* generic flags */
 212 #define NDDATA 5
 213         u_int32_t d_drivedata[NDDATA];  /* drive-type specific information */
 214 #define NSPARE 5
 215         u_int32_t d_spare[NSPARE];      /* reserved for future use */
 216         u_int32_t d_magic2;             /* the magic number (again) */
 217         u_int16_t d_checksum;           /* xor of data incl. partitions */
 218
 219                         /* filesystem and partition information: */
 220         u_int16_t d_npartitions;        /* number of partitions in following */
 221         u_int32_t d_bbsize;             /* size of boot area at sn0, bytes */
 222         u_int32_t d_sbsize;             /* max size of fs superblock, bytes */
 223         struct  partition {             /* the partition table */
 224                 u_int32_t p_size;       /* number of sectors in partition */
 225                 u_int32_t p_offset;     /* starting sector */
 226                 u_int32_t p_fsize;      /* filesystem basic fragment size */
 227                 u_int8_t p_fstype;      /* filesystem type, see below */
 228                 u_int8_t p_frag;        /* filesystem fragments per block */
 229                 union {
 230                         u_int16_t cpg;  /* UFS: FS cylinders per group */
 231                         u_int16_t sgs;  /* LFS: FS segment shift */
 232                 } __partition_u1;
 233 #define p_cpg   __partition_u1.cpg
 234 #define p_sgs   __partition_u1.sgs
 235         } d_partitions[MAXPARTITIONS];  /* actually may be more */
 236 };
 237 #else /* LOCORE */
 238         /*
 239          * offsets for asm boot files.
 240          */
 241         .set    d_secsize,40
 242         .set    d_nsectors,44
 243         .set    d_ntracks,48
 244         .set    d_ncylinders,52
 245         .set    d_secpercyl,56
 246         .set    d_secperunit,60
 247         .set    d_end_,276              /* size of disk label */
 248 #endif /* LOCORE */
 249
 250 /* d_type values: */
 251 #define DTYPE_SMD               1               /* SMD, XSMD; VAX hp/up */
 252 #define DTYPE_MSCP              2               /* MSCP */
 253 #define DTYPE_DEC               3               /* other DEC (rk, rl) */
 254 #define DTYPE_SCSI              4               /* SCSI */
 255 #define DTYPE_ESDI              5               /* ESDI interface */
 256 #define DTYPE_ST506             6               /* ST506 etc. */
 257 #define DTYPE_HPIB              7               /* CS/80 on HP-IB */
 258 #define DTYPE_HPFL              8               /* HP Fiber-link */
 259 #define DTYPE_FLOPPY            10              /* floppy */
 260 #define DTYPE_CCD               11              /* concatenated disk */
 261 #define DTYPE_VINUM             12              /* vinum volume */
 262 #define DTYPE_DOC2K             13              /* Msys DiskOnChip */
 263
 264 #if defined(PC98) && !defined(PC98_ATCOMPAT)
 265 #define DSTYPE_SEC256           0x80            /* physical sector size=256 */
 266 #endif
 267
 268 #ifdef DKTYPENAMES
 269 static char *dktypenames[] = {
 270         "unknown",
 271         "SMD",
 272         "MSCP",
 273         "old DEC",
 274         "SCSI",
 275         "ESDI",
 276         "ST506",
 277         "HP-IB",
 278         "HP-FL",
 279         "type 9",
 280         "floppy",
 281         "CCD",
 282         "Vinum",
 283         "DOC2K",
 284         NULL
 285 };
 286 #define DKMAXTYPES      (sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
 287 #endif
 288
 289 /*
 290  * Filesystem type and version.
 291  * Used to interpret other filesystem-specific
 292  * per-partition information.
 293  */
 294 #define FS_UNUSED       0               /* unused */
 295 #define FS_SWAP         1               /* swap */
 296 #define FS_V6           2               /* Sixth Edition */
 297 #define FS_V7           3               /* Seventh Edition */
 298 #define FS_SYSV         4               /* System V */
 299 #define FS_V71K         5               /* V7 with 1K blocks (4.1, 2.9) */
 300 #define FS_V8           6               /* Eighth Edition, 4K blocks */
 301 #define FS_BSDFFS       7               /* 4.2BSD fast file system */
 302 #define FS_MSDOS        8               /* MSDOS file system */
 303 #define FS_BSDLFS       9               /* 4.4BSD log-structured file system */
 304 #define FS_OTHER        10              /* in use, but unknown/unsupported */
 305 #define FS_HPFS         11              /* OS/2 high-performance file system */
 306 #define FS_ISO9660      12              /* ISO 9660, normally CD-ROM */
 307 #define FS_BOOT         13              /* partition contains bootstrap */
 308 #define FS_VINUM        14              /* Vinum drive */
 309
 310 #ifdef  DKTYPENAMES
 311 static char *fstypenames[] = {
 312         "unused",
 313         "swap",
 314         "Version 6",
 315         "Version 7",
 316         "System V",
 317         "4.1BSD",
 318         "Eighth Edition",
 319         "4.2BSD",
 320         "MSDOS",
 321         "4.4LFS",
 322         "unknown",
 323         "HPFS",
 324         "ISO9660",
 325         "boot",
 326         "vinum",
 327         NULL
 328 };
 329 #define FSMAXTYPES      (sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
 330 #endif
 331
 332 /*
 333  * flags shared by various drives:
 334  */
 335 #define         D_REMOVABLE     0x01            /* removable media */
 336 #define         D_ECC           0x02            /* supports ECC */
 337 #define         D_BADSECT       0x04            /* supports bad sector forw. */
 338 #define         D_RAMDISK       0x08            /* disk emulator */
 339 #define         D_CHAIN         0x10            /* can do back-back transfers */
 340
 341 /*
 342  * Drive data for SMD.
 343  */
 344 #define d_smdflags      d_drivedata[0]
 345 #define         D_SSE           0x1             /* supports skip sectoring */
 346 #define d_mindist       d_drivedata[1]
 347 #define d_maxdist       d_drivedata[2]
 348 #define d_sdist         d_drivedata[3]
 349
 350 /*
 351  * Drive data for ST506.
 352  */
 353 #define d_precompcyl    d_drivedata[0]
 354 #define d_gap3          d_drivedata[1]          /* used only when formatting */
 355
 356 /*
 357  * Drive data for SCSI.
 358  */
 359 #define d_blind         d_drivedata[0]
 360
 361 #ifndef LOCORE
 362 /*
 363  * Structure used to perform a format or other raw operation, returning
 364  * data and/or register values.  Register identification and format
 365  * are device- and driver-dependent.
 366  */
 367 struct format_op {
 368         char    *df_buf;
 369         int      df_count;              /* value-result */
 370         daddr_t  df_startblk;
 371         int      df_reg[8];             /* result */
 372 };
 373
 374 /*
 375  * Structure used internally to retrieve information about a partition
 376  * on a disk.
 377  */
 378 struct partinfo {
 379         struct disklabel *disklab;
 380         struct partition *part;
 381 };
 382
 383 /* DOS partition table -- located in boot block */
 384
 385 #if defined(PC98) && !defined(PC98_ATCOMPAT)
 386 #define DOSBBSECTOR     0       /* DOS boot block relative sector number */
 387 #define DOSLABELSECTOR  1       /* 0: 256b/s, 1: 512b/s */
 388 #define DOSPARTOFF      0
 389 #define NDOSPART        16
 390 #define DOSPTYP_386BSD  0x94    /* 386BSD partition type */
 391 #define MBR_PTYPE_FreeBSD 0x94  /* FreeBSD partition type */
 392
 393 struct dos_partition {
 394         unsigned char   dp_mid;
 395 #define DOSMID_386BSD           (0x14|0x80) /* 386bsd|bootable */
 396         unsigned char   dp_sid;
 397 #define DOSSID_386BSD           (0x44|0x80) /* 386bsd|active */
 398         unsigned char   dp_dum1;
 399         unsigned char   dp_dum2;
 400         unsigned char   dp_ipl_sct;
 401         unsigned char   dp_ipl_head;
 402         unsigned short  dp_ipl_cyl;
 403         unsigned char   dp_ssect;       /* starting sector */
 404         unsigned char   dp_shd;         /* starting head */
 405         unsigned short  dp_scyl;        /* starting cylinder */
 406         unsigned char   dp_esect;       /* end sector */
 407         unsigned char   dp_ehd;         /* end head */
 408         unsigned short  dp_ecyl;        /* end cylinder */
 409         unsigned char   dp_name[16];
 410 };
 411
 412 #else /* IBMPC */
 413 #define DOSBBSECTOR     0       /* DOS boot block relative sector number */
 414 #define DOSPARTOFF      446
 415 #define NDOSPART        4
 416 #define DOSPTYP_386BSD  0xa5    /* 386BSD partition type */
 417
 418 struct dos_partition {
 419         unsigned char   dp_flag;        /* bootstrap flags */
 420         unsigned char   dp_shd;         /* starting head */
 421         unsigned char   dp_ssect;       /* starting sector */
 422         unsigned char   dp_scyl;        /* starting cylinder */
 423         unsigned char   dp_typ;         /* partition type */
 424         unsigned char   dp_ehd;         /* end head */
 425         unsigned char   dp_esect;       /* end sector */
 426         unsigned char   dp_ecyl;        /* end cylinder */
 427         u_int32_t       dp_start;       /* absolute starting sector number */
 428         u_int32_t       dp_size;        /* partition size in sectors */
 429 };
 430 #endif
 431
 432 #define DPSECT(s) ((s) & 0x3f)          /* isolate relevant bits of sector */
 433 #define DPCYL(c, s) ((c) + (((s) & 0xc0)<<2)) /* and those that are cylinder */
 434
 435 /*
 436  * Disk-specific ioctls.
 437  */
 438                 /* get and set disklabel; DIOCGPART used internally */
 439 #define DIOCGDINFO      _IOR('d', 101, struct disklabel)/* get */
 440 #define DIOCSDINFO      _IOW('d', 102, struct disklabel)/* set */
 441 #define DIOCWDINFO      _IOW('d', 103, struct disklabel)/* set, update disk */
 442 #define DIOCGPART       _IOW('d', 104, struct partinfo) /* get partition */
 443
 444 #define DIOCWLABEL      _IOW('d', 109, int)     /* write en/disable label */
 445
 446 #ifdef _KERNEL
 447
 448 /*
 449  * XXX encoding of disk minor numbers, should be elsewhere.
 450  *
 451  * See <sys/reboot.h> for a possibly better encoding.
 452  *
 453  * "cpio -H newc" can be used to back up device files with large minor
 454  * numbers (but not ones >= 2^31).  Old cpio formats and all tar formats
 455  * don't have enough bits, and cpio and tar don't notice the lossage.
 456  * There are also some sign extension bugs.
 457  */
 458
 459 /*
 460        3                   2                   1                   0
 461      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
 462     _________________________________________________________________
 463     | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
 464     -----------------------------------------------------------------
 465     |    TYPE     |UNIT_2 | SLICE   |  MAJOR?       |  UNIT   |PART |
 466     -----------------------------------------------------------------
 467 */
 468 #define dkmakeminor(unit, slice, part) \e
 469         (((slice) << 16) | (((unit) & 0x1e0) << 16) | \e
 470         (((unit) & 0x1f) << 3) | (part))
 471 static __inline dev_t
 472 dkmodpart(dev_t dev, int part)
 473 {
 474         return (makedev(major(dev), (minor(dev) & ~7) | part));
 475 }
 476
 477 static __inline dev_t
 478 dkmodslice(dev_t dev, int slice)
 479 {
 480         return (makedev(major(dev), (minor(dev) & ~0x1f0000) | (slice << 16)));
 481 }
 482
 483 #define dkpart(dev)             (minor(dev) & 7)
 484 #define dkslice(dev)            ((minor(dev) >> 16) & 0x1f)
 485 #define dktype(dev)             ((minor(dev) >> 25) & 0x7f)
 486
 487 static __inline u_int
 488 dkunit(dev_t dev)
 489 {
 490         return (((minor(dev) >> 16) & 0x1e0) | ((minor(dev) >> 3) & 0x1f));
 491 }
 492
 493 struct  buf;
 494 struct  buf_queue_head;
 495
 496 int     bounds_check_with_label(struct buf *bp, struct disklabel *lp,
 497                                 int wlabel);
 498 void    diskerr(struct buf *bp, char *what, int pri, int blkdone,
 499                 struct disklabel *lp);
 500 void    disksort(struct buf *ap, struct buf *bp);
 501 u_int   dkcksum struct disklabel *lp);
 502 char    *readdisklabel(dev_t dev, struct disklabel *lp);
 503 void    bufqdisksort(struct buf_queue_head *ap, struct buf *bp);
 504 int     setdisklabel(struct disklabel *olp, struct disklabel *nlp,
 505                      u_long openmask);
 506 int     writedisklabel(dev_t dev, struct disklabel *lp);
 507 #ifdef __alpha__
 508 void    alpha_fix_srm_checksum(struct buf *bp);
 509 #endif
 510
 511 #endif /* _KERNEL */
 512
 513 #endif /* LOCORE */
 514
 515 #ifndef _KERNEL
 516 __BEGIN_DECLS
 517 struct disklabel *getdiskbyname(const char *);
 518 __END_DECLS
 519 #endif
 520
 521 #endif /* !_SYS_DISKLABEL_H_ */
 522 .Ed
 523 .Sh SEE ALSO
 524 .Xr disktab 5 ,
 525 .Xr disklabel 8