sys/sys/disklabel.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1987, 1988, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   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. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)disklabel.h 8.2 (Berkeley) 7/10/94
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _SYS_DISKLABEL_H_
  36 #define _SYS_DISKLABEL_H_
  37
  38 #ifndef _KERNEL
  39 #include <sys/types.h>
  40 #endif
  41 #include <sys/ioccom.h>
  42
  43 #include <sys/disk/bsd.h>
  44
  45 /* Disk description table, see disktab(5) */
  46 #define _PATH_DISKTAB   "/etc/disktab"
  47
  48 /*
  49  * The label is in block 0 or 1, possibly offset from the beginning
  50  * to leave room for a bootstrap, etc.
  51  * XXX these should be defined per controller (or drive) elsewhere, not here!
  52  * XXX in actuality it can't even be per controller or drive. It should be
  53  * constant/fixed across storage hardware and CPU architectures. Disks can
  54  * travel from one machine to another and a label created on one machine
  55  * should be detectable and understood by the other.
  56  */
  57 #define LABELSECTOR     1                       /* sector containing label */
  58 #define LABELOFFSET     0                       /* offset of label in sector */
  59
  60 #define DISKMAGIC       BSD_MAGIC               /* The disk magic number */
  61
  62 #ifndef MAXPARTITIONS
  63 #define MAXPARTITIONS   BSD_NPARTS_MIN
  64 #endif
  65
  66 /* Size of bootblock area in sector-size neutral bytes */
  67 #define BBSIZE          BSD_BOOTBLOCK_SIZE
  68
  69 #define LABEL_PART      BSD_PART_RAW
  70 #define RAW_PART        BSD_PART_RAW
  71 #define SWAP_PART       BSD_PART_SWAP
  72
  73 #define NDDATA          BSD_NDRIVEDATA
  74 #define NSPARE          BSD_NSPARE
  75
  76 static __inline u_int16_t dkcksum(struct disklabel *lp);
  77 static __inline u_int16_t
  78 dkcksum(struct disklabel *lp)
  79 {
  80         u_int16_t *start, *end;
  81         u_int16_t sum = 0;
  82
  83         start = (u_int16_t *)lp;
  84         end = (u_int16_t *)&lp->d_partitions[lp->d_npartitions];
  85         while (start < end)
  86                 sum ^= *start++;
  87         return (sum);
  88 }
  89
  90 #ifdef DKTYPENAMES
  91 static const char *dktypenames[] = {
  92         "unknown",
  93         "SMD",
  94         "MSCP",
  95         "old DEC",
  96         "SCSI",
  97         "ESDI",
  98         "ST506",
  99         "HP-IB",
 100         "HP-FL",
 101         "type 9",
 102         "floppy",
 103         "CCD",
 104         "Vinum",
 105         "DOC2K",
 106         "Raid",
 107         "?",
 108         "jfs",
 109         NULL
 110 };
 111 #define DKMAXTYPES      (sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
 112 #endif
 113
 114 #ifdef  FSTYPENAMES
 115 static const char *fstypenames[] = {
 116         "unused",
 117         "swap",
 118         "Version 6",
 119         "Version 7",
 120         "System V",
 121         "4.1BSD",
 122         "Eighth Edition",
 123         "4.2BSD",
 124         "MSDOS",
 125         "4.4LFS",
 126         "unknown",
 127         "HPFS",
 128         "ISO9660",
 129         "boot",
 130         "vinum",
 131         "raid",
 132         "Filecore",
 133         "EXT2FS",
 134         "NTFS",
 135         "?",
 136         "ccd",
 137         "jfs",
 138         "HAMMER",
 139         "HAMMER2",
 140         "UDF",
 141         "?",
 142         "EFS",
 143         "ZFS",
 144         "?",
 145         "?",
 146         "nandfs",
 147         NULL
 148 };
 149 #define FSMAXTYPES      (sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
 150 #endif
 151
 152 /*
 153  * NB: <sys/disk.h> defines ioctls from 'd'/128 and up.
 154  */
 155
 156 /*
 157  * Functions for proper encoding/decoding of struct disklabel into/from
 158  * bytestring.
 159  */
 160 void bsd_partition_le_dec(u_char *ptr, struct partition *d);
 161 int bsd_disklabel_le_dec(u_char *ptr, struct disklabel *d, int maxpart);
 162 void bsd_partition_le_enc(u_char *ptr, struct partition *d);
 163 void bsd_disklabel_le_enc(u_char *ptr, struct disklabel *d);
 164
 165 #ifndef _KERNEL
 166 __BEGIN_DECLS
 167 struct disklabel *getdiskbyname(const char *);
 168 __END_DECLS
 169 #endif
 170
 171 #endif /* !_SYS_DISKLABEL_H_ */