# disklabel.h

    00001 /*
    00002  * Copyright (c) 1987, 1988, 1993
    00003  *      The Regents of the University of California.  All rights reserved.
    00004  *
    00005  * Redistribution and use in source and binary forms, with or without
    00006  * modification, are permitted provided that the following conditions
    00007  * are met:
    00008  * 1. Redistributions of source code must retain the above copyright
    00009  *    notice, this list of conditions and the following disclaimer.
    00010  * 2. Redistributions in binary form must reproduce the above copyright
    00011  *    notice, this list of conditions and the following disclaimer in the
    00012  *    documentation and/or other materials provided with the distribution.
    00013  * 3. All advertising materials mentioning features or use of this software
    00014  *    must display the following acknowledgement:
    00015  *      This product includes software developed by the University of
    00016  *      California, Berkeley and its contributors.
    00017  * 4. Neither the name of the University nor the names of its contributors
    00018  *    may be used to endorse or promote products derived from this software
    00019  *    without specific prior written permission.
    00020  *
    00021  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
    00022  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    00023  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    00024  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    00025  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    00026  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    00027  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    00028  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    00029  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    00030  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    00031  * SUCH DAMAGE.
    00032  *
    00033  *      @(#)disklabel.h 8.2 (Berkeley) 7/10/94
    00034  * $FreeBSD: src/sys/sys/disklabel.h,v 1.49.2.7 2001/05/27 05:58:26 jkh Exp $
    00035  */
    00036
    00037 #ifndef _SYS_DISKLABEL_H_
    00038 #define _SYS_DISKLABEL_H_
    00039
    00040 #ifndef _KERNEL
    00041 #include <sys/types.h>
    00042 #endif
    00043 #include <sys/ioccom.h>
    00044
    00045 /*
    00046  * Disk description table, see disktab(5)
    00047  */
    00048 #define _PATH_DISKTAB   "/etc/disktab"
    00049 #define DISKTAB         "/etc/disktab"          /* deprecated */
    00050
    00051 /*
    00052  * Each disk has a label which includes information about the hardware
    00053  * disk geometry, filesystem partitions, and drive specific information.
    00054  * The label is in block 0 or 1, possibly offset from the beginning
    00055  * to leave room for a bootstrap, etc.
    00056  */
    00057
    00058 /* XXX these should be defined per controller (or drive) elsewhere, not here! */
    00059 #ifdef __i386__
    00060 #define LABELSECTOR     1                       /* sector containing label */
    00061 #define LABELOFFSET     0                       /* offset of label in sector */
    00062 #endif
    00063
    00064 #ifdef __alpha__
    00065 #define LABELSECTOR     0
    00066 #define LABELOFFSET     64
    00067 #endif
    00068
    00069 #ifndef LABELSECTOR
    00070 #define LABELSECTOR     0                       /* sector containing label */
    00071 #endif
    00072
    00073 #ifndef LABELOFFSET
    00074 #define LABELOFFSET     64                      /* offset of label in sector */
    00075 #endif
    00076
    00077 #define DISKMAGIC       ((u_int32_t)0x82564557) /* The disk magic number */
    00078 #ifndef MAXPARTITIONS
    00079 #define MAXPARTITIONS   8
    00080 #endif
    00081
    00082 #define LABEL_PART      2               /* partition containing label */
    00083 #define RAW_PART        2               /* partition containing whole disk */
    00084 #define SWAP_PART       1               /* partition normally containing swap */
    00085
    00086 #ifndef LOCORE
    00087 struct disklabel {
    00088         u_int32_t d_magic;              /* the magic number */
    00089         u_int16_t d_type;               /* drive type */
    00090         u_int16_t d_subtype;            /* controller/d_type specific */
    00091         char      d_typename[16];       /* type name, e.g. "eagle" */
    00092
    00093         /*
    00094          * d_packname contains the pack identifier and is returned when
    00095          * the disklabel is read off the disk or in-core copy.
    00096          * d_boot0 and d_boot1 are the (optional) names of the
    00097          * primary (block 0) and secondary (block 1-15) bootstraps
    00098          * as found in /boot.  These are returned when using
    00099          * getdiskbyname(3) to retrieve the values from /etc/disktab.
    00100          */
    00101         union {
    00102                 char    un_d_packname[16];      /* pack identifier */
    00103                 struct {
    00104                         char *un_d_boot0;       /* primary bootstrap name */
    00105                         char *un_d_boot1;       /* secondary bootstrap name */
    00106                 } un_b;
    00107         } d_un;
    00108 #define d_packname      d_un.un_d_packname
    00109 #define d_boot0         d_un.un_b.un_d_boot0
    00110 #define d_boot1         d_un.un_b.un_d_boot1
    00111
    00112                         /* disk geometry: */
    00113         u_int32_t d_secsize;            /* # of bytes per sector */
    00114         u_int32_t d_nsectors;           /* # of data sectors per track */
    00115         u_int32_t d_ntracks;            /* # of tracks per cylinder */
    00116         u_int32_t d_ncylinders;         /* # of data cylinders per unit */
    00117         u_int32_t d_secpercyl;          /* # of data sectors per cylinder */
    00118         u_int32_t d_secperunit;         /* # of data sectors per unit */
    00119
    00120         /*
    00121          * Spares (bad sector replacements) below are not counted in
    00122          * d_nsectors or d_secpercyl.  Spare sectors are assumed to
    00123          * be physical sectors which occupy space at the end of each
    00124          * track and/or cylinder.
    00125          */
    00126         u_int16_t d_sparespertrack;     /* # of spare sectors per track */
    00127         u_int16_t d_sparespercyl;       /* # of spare sectors per cylinder */
    00128         /*
    00129          * Alternate cylinders include maintenance, replacement, configuration
    00130          * description areas, etc.
    00131          */
    00132         u_int32_t d_acylinders;         /* # of alt. cylinders per unit */
    00133
    00134                         /* hardware characteristics: */
    00135         /*
    00136          * d_interleave, d_trackskew and d_cylskew describe perturbations
    00137          * in the media format used to compensate for a slow controller.
    00138          * Interleave is physical sector interleave, set up by the
    00139          * formatter or controller when formatting.  When interleaving is
    00140          * in use, logically adjacent sectors are not physically
    00141          * contiguous, but instead are separated by some number of
    00142          * sectors.  It is specified as the ratio of physical sectors
    00143          * traversed per logical sector.  Thus an interleave of 1:1
    00144          * implies contiguous layout, while 2:1 implies that logical
    00145          * sector 0 is separated by one sector from logical sector 1.
    00146          * d_trackskew is the offset of sector 0 on track N relative to
    00147          * sector 0 on track N-1 on the same cylinder.  Finally, d_cylskew
    00148          * is the offset of sector 0 on cylinder N relative to sector 0
    00149          * on cylinder N-1.
    00150          */
    00151         u_int16_t d_rpm;                /* rotational speed */
    00152         u_int16_t d_interleave;         /* hardware sector interleave */
    00153         u_int16_t d_trackskew;          /* sector 0 skew, per track */
    00154         u_int16_t d_cylskew;            /* sector 0 skew, per cylinder */
    00155         u_int32_t d_headswitch;         /* head switch time, usec */
    00156         u_int32_t d_trkseek;            /* track-to-track seek, usec */
    00157         u_int32_t d_flags;              /* generic flags */
    00158 #define NDDATA 5
    00159         u_int32_t d_drivedata[NDDATA];  /* drive-type specific information */
    00160 #define NSPARE 5
    00161         u_int32_t d_spare[NSPARE];      /* reserved for future use */
    00162         u_int32_t d_magic2;             /* the magic number (again) */
    00163         u_int16_t d_checksum;           /* xor of data incl. partitions */
    00164
    00165                         /* filesystem and partition information: */
    00166         u_int16_t d_npartitions;        /* number of partitions in following */
    00167         u_int32_t d_bbsize;             /* size of boot area at sn0, bytes */
    00168         u_int32_t d_sbsize;             /* max size of fs superblock, bytes */
    00169         struct  partition {             /* the partition table */
    00170                 u_int32_t p_size;       /* number of sectors in partition */
    00171                 u_int32_t p_offset;     /* starting sector */
    00172                 u_int32_t p_fsize;      /* filesystem basic fragment size */
    00173                 u_int8_t p_fstype;      /* filesystem type, see below */
    00174                 u_int8_t p_frag;        /* filesystem fragments per block */
    00175                 union {
    00176                         u_int16_t cpg;  /* UFS: FS cylinders per group */
    00177                         u_int16_t sgs;  /* LFS: FS segment shift */
    00178                 } __partition_u1;
    00179 #define p_cpg   __partition_u1.cpg
    00180 #define p_sgs   __partition_u1.sgs
    00181         } d_partitions[MAXPARTITIONS];  /* actually may be more */
    00182 };
    00183
    00184 static u_int16_t dkcksum(struct disklabel *lp);
    00185
    00186 static __inline u_int16_t
    00187 dkcksum(struct disklabel *lp)
    00188 {
    00189         u_int16_t *start, *end;
    00190         u_int16_t sum = 0;
    00191
    00192         start = (u_int16_t *)lp;
    00193         end = (u_int16_t *)&lp->d_partitions[lp->d_npartitions];
    00194         while (start < end)
    00195                 sum ^= *start++;
    00196         return (sum);
    00197 }
    00198
    00199 #else /* LOCORE */
    00200         /*
    00201          * offsets for asm boot files.
    00202          */
    00203         .set    d_secsize,40
    00204         .set    d_nsectors,44
    00205         .set    d_ntracks,48
    00206         .set    d_ncylinders,52
    00207         .set    d_secpercyl,56
    00208         .set    d_secperunit,60
    00209         .set    d_end_,276              /* size of disk label */
    00210 #endif /* LOCORE */
    00211
    00212 /* d_type values: */
    00213 #define DTYPE_SMD               1               /* SMD, XSMD; VAX hp/up */
    00214 #define DTYPE_MSCP              2               /* MSCP */
    00215 #define DTYPE_DEC               3               /* other DEC (rk, rl) */
    00216 #define DTYPE_SCSI              4               /* SCSI */
    00217 #define DTYPE_ESDI              5               /* ESDI interface */
    00218 #define DTYPE_ST506             6               /* ST506 etc. */
    00219 #define DTYPE_HPIB              7               /* CS/80 on HP-IB */
    00220 #define DTYPE_HPFL              8               /* HP Fiber-link */
    00221 #define DTYPE_FLOPPY            10              /* floppy */
    00222 #define DTYPE_CCD               11              /* concatenated disk */
    00223 #define DTYPE_VINUM             12              /* vinum volume */
    00224 #define DTYPE_DOC2K             13              /* Msys DiskOnChip */
    00225
    00226 #if defined(PC98) && !defined(PC98_ATCOMPAT)
    00227 #define DSTYPE_SEC256           0x80            /* physical sector size=256 */
    00228 #endif
    00229
    00230 #ifdef DKTYPENAMES
    00231 static char *dktypenames[] = {
    00232         "unknown",
    00233         "SMD",
    00234         "MSCP",
    00235         "old DEC",
    00236         "SCSI",
    00237         "ESDI",
    00238         "ST506",
    00239         "HP-IB",
    00240         "HP-FL",
    00241         "type 9",
    00242         "floppy",
    00243         "CCD",
    00244         "Vinum",
    00245         "DOC2K",
    00246         NULL
    00247 };
    00248 #define DKMAXTYPES      (sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
    00249 #endif
    00250
    00251 /*
    00252  * Filesystem type and version.
    00253  * Used to interpret other filesystem-specific
    00254  * per-partition information.
    00255  */
    00256 #define FS_UNUSED       0               /* unused */
    00257 #define FS_SWAP         1               /* swap */
    00258 #define FS_V6           2               /* Sixth Edition */
    00259 #define FS_V7           3               /* Seventh Edition */
    00260 #define FS_SYSV         4               /* System V */
    00261 #define FS_V71K         5               /* V7 with 1K blocks (4.1, 2.9) */
    00262 #define FS_V8           6               /* Eighth Edition, 4K blocks */
    00263 #define FS_BSDFFS       7               /* 4.2BSD fast file system */
    00264 #define FS_MSDOS        8               /* MSDOS file system */
    00265 #define FS_BSDLFS       9               /* 4.4BSD log-structured file system */
    00266 #define FS_OTHER        10              /* in use, but unknown/unsupported */
    00267 #define FS_HPFS         11              /* OS/2 high-performance file system */
    00268 #define FS_ISO9660      12              /* ISO 9660, normally CD-ROM */
    00269 #define FS_BOOT         13              /* partition contains bootstrap */
    00270 #define FS_VINUM        14              /* Vinum drive */
    00271
    00272 #ifdef  DKTYPENAMES
    00273 static char *fstypenames[] = {
    00274         "unused",
    00275         "swap",
    00276         "Version 6",
    00277         "Version 7",
    00278         "System V",
    00279         "4.1BSD",
    00280         "Eighth Edition",
    00281         "4.2BSD",
    00282         "MSDOS",
    00283         "4.4LFS",
    00284         "unknown",
    00285         "HPFS",
    00286         "ISO9660",
    00287         "boot",
    00288         "vinum",
    00289         NULL
    00290 };
    00291 #define FSMAXTYPES      (sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
    00292 #endif
    00293
    00294 /*
    00295  * flags shared by various drives:
    00296  */
    00297 #define         D_REMOVABLE     0x01            /* removable media */
    00298 #define         D_ECC           0x02            /* supports ECC */
    00299 #define         D_BADSECT       0x04            /* supports bad sector forw. */
    00300 #define         D_RAMDISK       0x08            /* disk emulator */
    00301 #define         D_CHAIN         0x10            /* can do back-back transfers */
    00302
    00303 /*
    00304  * Drive data for SMD.
    00305  */
    00306 #define d_smdflags      d_drivedata[0]
    00307 #define         D_SSE           0x1             /* supports skip sectoring */
    00308 #define d_mindist       d_drivedata[1]
    00309 #define d_maxdist       d_drivedata[2]
    00310 #define d_sdist         d_drivedata[3]
    00311
    00312 /*
    00313  * Drive data for ST506.
    00314  */
    00315 #define d_precompcyl    d_drivedata[0]
    00316 #define d_gap3          d_drivedata[1]          /* used only when formatting */
    00317
    00318 /*
    00319  * Drive data for SCSI.
    00320  */
    00321 #define d_blind         d_drivedata[0]
    00322
    00323 #ifndef LOCORE
    00324 /*
    00325  * Structure used to perform a format or other raw operation, returning
    00326  * data and/or register values.  Register identification and format
    00327  * are device- and driver-dependent.
    00328  */
    00329 struct format_op {
    00330         char    *df_buf;
    00331         int      df_count;              /* value-result */
    00332         daddr_t  df_startblk;
    00333         int      df_reg[8];             /* result */
    00334 };
    00335
    00336 /*
    00337  * Structure used internally to retrieve information about a partition
    00338  * on a disk.
    00339  */
    00340 struct partinfo {
    00341         struct disklabel *disklab;
    00342         struct partition *part;
    00343 };
    00344
    00345 /* DOS partition table -- located in boot block */
    00346
    00347 #if defined(PC98) && !defined(PC98_ATCOMPAT)
    00348 #define DOSBBSECTOR     0       /* DOS boot block relative sector number */
    00349 #define DOSLABELSECTOR  1       /* 0: 256b/s, 1: 512b/s */
    00350 #define DOSPARTOFF      0
    00351 #define NDOSPART        16
    00352 #define DOSPTYP_386BSD  0x94    /* 386BSD partition type */
    00353 #define MBR_PTYPE_FreeBSD 0x94  /* FreeBSD partition type */
    00354
    00355 struct dos_partition {
    00356         unsigned char   dp_mid;
    00357 #define DOSMID_386BSD           (0x14|0x80) /* 386bsd|bootable */
    00358         unsigned char   dp_sid;
    00359 #define DOSSID_386BSD           (0x44|0x80) /* 386bsd|active */
    00360         unsigned char   dp_dum1;
    00361         unsigned char   dp_dum2;
    00362         unsigned char   dp_ipl_sct;
    00363         unsigned char   dp_ipl_head;
    00364         unsigned short  dp_ipl_cyl;
    00365         unsigned char   dp_ssect;       /* starting sector */
    00366         unsigned char   dp_shd;         /* starting head */
    00367         unsigned short  dp_scyl;        /* starting cylinder */
    00368         unsigned char   dp_esect;       /* end sector */
    00369         unsigned char   dp_ehd;         /* end head */
    00370         unsigned short  dp_ecyl;        /* end cylinder */
    00371         unsigned char   dp_name[16];
    00372 };
    00373
    00374 #else /* IBMPC */
    00375 #define DOSBBSECTOR     0       /* DOS boot block relative sector number */
    00376 #define DOSPARTOFF      446
    00377 #define NDOSPART        4
    00378 #define DOSPTYP_386BSD  0xa5    /* 386BSD partition type */
    00379 #define DOSPTYP_LINSWP  0x82    /* Linux swap partition */
    00380 #define DOSPTYP_LINUX   0x83    /* Linux partition */
    00381 #define DOSPTYP_EXT     5       /* DOS extended partition */
    00382
    00383 struct dos_partition {
    00384         unsigned char   dp_flag;        /* bootstrap flags */
    00385         unsigned char   dp_shd;         /* starting head */
    00386         unsigned char   dp_ssect;       /* starting sector */
    00387         unsigned char   dp_scyl;        /* starting cylinder */
    00388         unsigned char   dp_typ;         /* partition type */
    00389         unsigned char   dp_ehd;         /* end head */
    00390         unsigned char   dp_esect;       /* end sector */
    00391         unsigned char   dp_ecyl;        /* end cylinder */
    00392         u_int32_t       dp_start;       /* absolute starting sector number */
    00393         u_int32_t       dp_size;        /* partition size in sectors */
    00394 };
    00395 #endif
    00396
    00397 #define DPSECT(s) ((s) & 0x3f)          /* isolate relevant bits of sector */
    00398 #define DPCYL(c, s) ((c) + (((s) & 0xc0)<<2)) /* and those that are cylinder */
    00399
    00400 /*
    00401  * Disk-specific ioctls.
    00402  */
    00403                 /* get and set disklabel; DIOCGPART used internally */
    00404 #define DIOCGDINFO      _IOR('d', 101, struct disklabel)/* get */
    00405 #define DIOCSDINFO      _IOW('d', 102, struct disklabel)/* set */
    00406 #define DIOCWDINFO      _IOW('d', 103, struct disklabel)/* set, update disk */
    00407 #define DIOCGPART       _IOW('d', 104, struct partinfo) /* get partition */
    00408 #define DIOCGDVIRGIN    _IOR('d', 105, struct disklabel) /* get virgin label */
    00409
    00410 #define DIOCWLABEL      _IOW('d', 109, int)     /* write en/disable label */
    00411
    00412 #ifdef _KERNEL
    00413
    00414 /*
    00415  * XXX encoding of disk minor numbers, should be elsewhere.
    00416  *
    00417  * See <sys/reboot.h> for a possibly better encoding.
    00418  *
    00419  * "cpio -H newc" can be used to back up device files with large minor
    00420  * numbers (but not ones >= 2^31).  Old cpio formats and all tar formats
    00421  * don't have enough bits, and cpio and tar don't notice the lossage.
    00422  * There are also some sign extension bugs.
    00423  */
    00424
    00425 /*
    00426        3                   2                   1                   0
    00427      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
    00428     _________________________________________________________________
    00429     | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
    00430     -----------------------------------------------------------------
    00431     |    TYPE     |UNIT_2 | SLICE   |  MAJOR?       |  UNIT   |PART |
    00432     -----------------------------------------------------------------
    00433 */
    00434
    00435 #define DKMAXUNIT 0x1ff         /* Highest disk unit number */
    00436
    00437 #define dkmakeminor(unit, slice, part) \
    00438                                 (((slice) << 16) | (((unit) & 0x1e0) << 16) | \
    00439                                 (((unit) & 0x1f) << 3) | (part))
    00440 static __inline dev_t
    00441 dkmodpart(dev_t dev, int part)
    00442 {
    00443         return (makedev(major(dev), (minor(dev) & ~7) | part));
    00444 }
    00445
    00446 static __inline dev_t
    00447 dkmodslice(dev_t dev, int slice)
    00448 {
    00449         return (makedev(major(dev), (minor(dev) & ~0x1f0000) | (slice << 16)));
    00450 }
    00451
    00452 #define dkpart(dev)             (minor(dev) & 7)
    00453 #define dkslice(dev)            ((minor(dev) >> 16) & 0x1f)
    00454 #define dktype(dev)             ((minor(dev) >> 25) & 0x7f)
    00455
    00456 static __inline u_int
    00457 dkunit(dev_t dev)
    00458 {
    00459         return (((minor(dev) >> 16) & 0x1e0) | ((minor(dev) >> 3) & 0x1f));
    00460 }
    00461
    00462 struct  buf;
    00463 struct  buf_queue_head;
    00464
    00465 int     bounds_check_with_label __P((struct buf *bp, struct disklabel *lp,
    00466                                      int wlabel));
    00467 void    diskerr __P((struct buf *bp, char *what, int pri, int blkdone,
    00468                      struct disklabel *lp));
    00469 void    disksort __P((struct buf *ap, struct buf *bp));
    00470 char    *readdisklabel __P((dev_t dev, struct disklabel *lp));
    00471 void    bufqdisksort __P((struct buf_queue_head *ap, struct buf *bp));
    00472 int     setdisklabel __P((struct disklabel *olp, struct disklabel *nlp,
    00473                           u_long openmask));
    00474 int     writedisklabel __P((dev_t dev, struct disklabel *lp));
    00475 #ifdef __alpha__
    00476 void    alpha_fix_srm_checksum __P((struct buf *bp));
    00477 #endif
    00478
    00479 #endif /* _KERNEL */
    00480
    00481 #endif /* LOCORE */
    00482
    00483 #ifndef _KERNEL
    00484 __BEGIN_DECLS
    00485 struct disklabel *getdiskbyname __P((const char *));
    00486 __END_DECLS
    00487 #endif
    00488
    00489 #endif /* !_SYS_DISKLABEL_H_ */