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  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)disklabel.h 8.2 (Berkeley) 7/10/94
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _SYS_DISKLABEL_H_
  34 #define _SYS_DISKLABEL_H_
  35
  36 #ifndef _KERNEL
  37 #include <sys/types.h>
  38 #endif
  39 #include <sys/ioccom.h>
  40
  41 /*
  42  * Disk description table, see disktab(5)
  43  */
  44 #define _PATH_DISKTAB   "/etc/disktab"
  45
  46 /*
  47  * Each disk has a label which includes information about the hardware
  48  * disk geometry, filesystem partitions, and drive specific information.
  49  * The label is in block 0 or 1, possibly offset from the beginning
  50  * to leave room for a bootstrap, etc.
  51  */
  52
  53 /* XXX these should be defined per controller (or drive) elsewhere, not here! */
  54 #if defined(__i386__) || defined(__amd64__) || defined(__arm__) || \
  55     defined(__ia64__)
  56 #define LABELSECTOR     1                       /* sector containing label */
  57 #define LABELOFFSET     0                       /* offset of label in sector */
  58 #endif
  59
  60 #ifdef __alpha__
  61 #define LABELSECTOR     0
  62 #define LABELOFFSET     64
  63 #endif
  64
  65 #define DISKMAGIC       ((u_int32_t)0x82564557) /* The disk magic number */
  66 #ifndef MAXPARTITIONS
  67 #define MAXPARTITIONS   8
  68 #endif
  69
  70 /* Size of bootblock area in sector-size neutral bytes */
  71 #define BBSIZE          8192
  72
  73 #define LABEL_PART      2               /* partition containing label */
  74 #define RAW_PART        2               /* partition containing whole disk */
  75 #define SWAP_PART       1               /* partition normally containing swap */
  76
  77 struct disklabel {
  78         u_int32_t d_magic;              /* the magic number */
  79         u_int16_t d_type;               /* drive type */
  80         u_int16_t d_subtype;            /* controller/d_type specific */
  81         char      d_typename[16];       /* type name, e.g. "eagle" */
  82
  83         char      d_packname[16];       /* pack identifier */
  84
  85                         /* disk geometry: */
  86         u_int32_t d_secsize;            /* # of bytes per sector */
  87         u_int32_t d_nsectors;           /* # of data sectors per track */
  88         u_int32_t d_ntracks;            /* # of tracks per cylinder */
  89         u_int32_t d_ncylinders;         /* # of data cylinders per unit */
  90         u_int32_t d_secpercyl;          /* # of data sectors per cylinder */
  91         u_int32_t d_secperunit;         /* # of data sectors per unit */
  92
  93         /*
  94          * Spares (bad sector replacements) below are not counted in
  95          * d_nsectors or d_secpercyl.  Spare sectors are assumed to
  96          * be physical sectors which occupy space at the end of each
  97          * track and/or cylinder.
  98          */
  99         u_int16_t d_sparespertrack;     /* # of spare sectors per track */
 100         u_int16_t d_sparespercyl;       /* # of spare sectors per cylinder */
 101         /*
 102          * Alternate cylinders include maintenance, replacement, configuration
 103          * description areas, etc.
 104          */
 105         u_int32_t d_acylinders;         /* # of alt. cylinders per unit */
 106
 107                         /* hardware characteristics: */
 108         /*
 109          * d_interleave, d_trackskew and d_cylskew describe perturbations
 110          * in the media format used to compensate for a slow controller.
 111          * Interleave is physical sector interleave, set up by the
 112          * formatter or controller when formatting.  When interleaving is
 113          * in use, logically adjacent sectors are not physically
 114          * contiguous, but instead are separated by some number of
 115          * sectors.  It is specified as the ratio of physical sectors
 116          * traversed per logical sector.  Thus an interleave of 1:1
 117          * implies contiguous layout, while 2:1 implies that logical
 118          * sector 0 is separated by one sector from logical sector 1.
 119          * d_trackskew is the offset of sector 0 on track N relative to
 120          * sector 0 on track N-1 on the same cylinder.  Finally, d_cylskew
 121          * is the offset of sector 0 on cylinder N relative to sector 0
 122          * on cylinder N-1.
 123          */
 124         u_int16_t d_rpm;                /* rotational speed */
 125         u_int16_t d_interleave;         /* hardware sector interleave */
 126         u_int16_t d_trackskew;          /* sector 0 skew, per track */
 127         u_int16_t d_cylskew;            /* sector 0 skew, per cylinder */
 128         u_int32_t d_headswitch;         /* head switch time, usec */
 129         u_int32_t d_trkseek;            /* track-to-track seek, usec */
 130         u_int32_t d_flags;              /* generic flags */
 131 #define NDDATA 5
 132         u_int32_t d_drivedata[NDDATA];  /* drive-type specific information */
 133 #define NSPARE 5
 134         u_int32_t d_spare[NSPARE];      /* reserved for future use */
 135         u_int32_t d_magic2;             /* the magic number (again) */
 136         u_int16_t d_checksum;           /* xor of data incl. partitions */
 137
 138                         /* filesystem and partition information: */
 139         u_int16_t d_npartitions;        /* number of partitions in following */
 140         u_int32_t d_bbsize;             /* size of boot area at sn0, bytes */
 141         u_int32_t d_sbsize;             /* max size of fs superblock, bytes */
 142         struct partition {              /* the partition table */
 143                 u_int32_t p_size;       /* number of sectors in partition */
 144                 u_int32_t p_offset;     /* starting sector */
 145                 u_int32_t p_fsize;      /* filesystem basic fragment size */
 146                 u_int8_t p_fstype;      /* filesystem type, see below */
 147                 u_int8_t p_frag;        /* filesystem fragments per block */
 148                 u_int16_t p_cpg;        /* filesystem cylinders per group */
 149         } d_partitions[MAXPARTITIONS];  /* actually may be more */
 150 };
 151
 152 #ifdef CTASSERT
 153 CTASSERT(sizeof(struct disklabel) == 148 + MAXPARTITIONS * 16);
 154 #endif
 155
 156 static __inline u_int16_t dkcksum(struct disklabel *lp);
 157 static __inline u_int16_t
 158 dkcksum(struct disklabel *lp)
 159 {
 160         u_int16_t *start, *end;
 161         u_int16_t sum = 0;
 162
 163         start = (u_int16_t *)lp;
 164         end = (u_int16_t *)&lp->d_partitions[lp->d_npartitions];
 165         while (start < end)
 166                 sum ^= *start++;
 167         return (sum);
 168 }
 169
 170
 171 /* d_type values: */
 172 #define DTYPE_SMD               1               /* SMD, XSMD; VAX hp/up */
 173 #define DTYPE_MSCP              2               /* MSCP */
 174 #define DTYPE_DEC               3               /* other DEC (rk, rl) */
 175 #define DTYPE_SCSI              4               /* SCSI */
 176 #define DTYPE_ESDI              5               /* ESDI interface */
 177 #define DTYPE_ST506             6               /* ST506 etc. */
 178 #define DTYPE_HPIB              7               /* CS/80 on HP-IB */
 179 #define DTYPE_HPFL              8               /* HP Fiber-link */
 180 #define DTYPE_FLOPPY            10              /* floppy */
 181 #define DTYPE_CCD               11              /* concatenated disk */
 182 #define DTYPE_VINUM             12              /* vinum volume */
 183 #define DTYPE_DOC2K             13              /* Msys DiskOnChip */
 184 #define DTYPE_RAID              14              /* CMU RAIDFrame */
 185 #define DTYPE_JFS2              16              /* IBM JFS 2 */
 186
 187 #ifdef DKTYPENAMES
 188 static const char *dktypenames[] = {
 189         "unknown",
 190         "SMD",
 191         "MSCP",
 192         "old DEC",
 193         "SCSI",
 194         "ESDI",
 195         "ST506",
 196         "HP-IB",
 197         "HP-FL",
 198         "type 9",
 199         "floppy",
 200         "CCD",
 201         "Vinum",
 202         "DOC2K",
 203         "Raid",
 204         "?",
 205         "jfs",
 206         NULL
 207 };
 208 #define DKMAXTYPES      (sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
 209 #endif
 210
 211 /*
 212  * Filesystem type and version.
 213  * Used to interpret other filesystem-specific
 214  * per-partition information.
 215  */
 216 #define FS_UNUSED       0               /* unused */
 217 #define FS_SWAP         1               /* swap */
 218 #define FS_V6           2               /* Sixth Edition */
 219 #define FS_V7           3               /* Seventh Edition */
 220 #define FS_SYSV         4               /* System V */
 221 #define FS_V71K         5               /* V7 with 1K blocks (4.1, 2.9) */
 222 #define FS_V8           6               /* Eighth Edition, 4K blocks */
 223 #define FS_BSDFFS       7               /* 4.2BSD fast filesystem */
 224 #define FS_MSDOS        8               /* MSDOS filesystem */
 225 #define FS_BSDLFS       9               /* 4.4BSD log-structured filesystem */
 226 #define FS_OTHER        10              /* in use, but unknown/unsupported */
 227 #define FS_HPFS         11              /* OS/2 high-performance filesystem */
 228 #define FS_ISO9660      12              /* ISO 9660, normally CD-ROM */
 229 #define FS_BOOT         13              /* partition contains bootstrap */
 230 #define FS_VINUM        14              /* Vinum drive */
 231 #define FS_RAID         15              /* RAIDFrame drive */
 232 #define FS_JFS2         21              /* IBM JFS2 */
 233
 234 #ifdef  FSTYPENAMES
 235 static const char *fstypenames[] = {
 236         "unused",
 237         "swap",
 238         "Version 6",
 239         "Version 7",
 240         "System V",
 241         "4.1BSD",
 242         "Eighth Edition",
 243         "4.2BSD",
 244         "MSDOS",
 245         "4.4LFS",
 246         "unknown",
 247         "HPFS",
 248         "ISO9660",
 249         "boot",
 250         "vinum",
 251         "raid",
 252         "?",
 253         "?",
 254         "?",
 255         "?",
 256         "jfs",
 257         NULL
 258 };
 259 #define FSMAXTYPES      (sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
 260 #endif
 261
 262 /*
 263  * flags shared by various drives:
 264  */
 265 #define D_REMOVABLE     0x01            /* removable media */
 266 #define D_ECC           0x02            /* supports ECC */
 267 #define D_BADSECT       0x04            /* supports bad sector forw. */
 268 #define D_RAMDISK       0x08            /* disk emulator */
 269 #define D_CHAIN         0x10            /* can do back-back transfers */
 270
 271 /*
 272  * Disklabel-specific ioctls.
 273  *
 274  * NB: <sys/disk.h> defines ioctls from 'd'/128 and up.
 275  */
 276                 /* get and set disklabel */
 277 #define DIOCGDINFO      _IOR('d', 101, struct disklabel)/* get */
 278 #define DIOCSDINFO      _IOW('d', 102, struct disklabel)/* set */
 279 #define DIOCWDINFO      _IOW('d', 103, struct disklabel)/* set, update disk */
 280 #define DIOCBSDBB       _IOW('d', 110, void *)  /* write bootblocks */
 281
 282 /*
 283  * Functions for proper encoding/decoding of struct disklabel into/from
 284  * bytestring.
 285  */
 286 void bsd_partition_le_dec(u_char *ptr, struct partition *d);
 287 int bsd_disklabel_le_dec(u_char *ptr, struct disklabel *d, int maxpart);
 288 void bsd_partition_le_enc(u_char *ptr, struct partition *d);
 289 void bsd_disklabel_le_enc(u_char *ptr, struct disklabel *d);
 290
 291 #ifndef _KERNEL
 292 __BEGIN_DECLS
 293 struct disklabel *getdiskbyname(const char *);
 294 __END_DECLS
 295 #endif
 296
 297 #endif /* !_SYS_DISKLABEL_H_ */