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(__powerpc__) || defined(__mips__)
56 #define LABELSECTOR 1 /* sector containing label */
57 #define LABELOFFSET 0 /* offset of label in sector */
58 #endif
59
60 #define DISKMAGIC ((u_int32_t)0x82564557) /* The disk magic number */
61 #ifndef MAXPARTITIONS
62 #define MAXPARTITIONS 8
63 #endif
64
65 /* Size of bootblock area in sector-size neutral bytes */
66 #define BBSIZE 8192
67
68 #define LABEL_PART 2 /* partition containing label */
69 #define RAW_PART 2 /* partition containing whole disk */
70 #define SWAP_PART 1 /* partition normally containing swap */
71
72 struct disklabel {
73 u_int32_t d_magic; /* the magic number */
74 u_int16_t d_type; /* drive type */
75 u_int16_t d_subtype; /* controller/d_type specific */
76 char d_typename[16]; /* type name, e.g. "eagle" */
77
78 char d_packname[16]; /* pack identifier */
79
80 /* disk geometry: */
81 u_int32_t d_secsize; /* # of bytes per sector */
82 u_int32_t d_nsectors; /* # of data sectors per track */
83 u_int32_t d_ntracks; /* # of tracks per cylinder */
84 u_int32_t d_ncylinders; /* # of data cylinders per unit */
85 u_int32_t d_secpercyl; /* # of data sectors per cylinder */
86 u_int32_t d_secperunit; /* # of data sectors per unit */
87
88 /*
89 * Spares (bad sector replacements) below are not counted in
90 * d_nsectors or d_secpercyl. Spare sectors are assumed to
91 * be physical sectors which occupy space at the end of each
92 * track and/or cylinder.
93 */
94 u_int16_t d_sparespertrack; /* # of spare sectors per track */
95 u_int16_t d_sparespercyl; /* # of spare sectors per cylinder */
96 /*
97 * Alternate cylinders include maintenance, replacement, configuration
98 * description areas, etc.
99 */
100 u_int32_t d_acylinders; /* # of alt. cylinders per unit */
101
102 /* hardware characteristics: */
103 /*
104 * d_interleave, d_trackskew and d_cylskew describe perturbations
105 * in the media format used to compensate for a slow controller.
106 * Interleave is physical sector interleave, set up by the
107 * formatter or controller when formatting. When interleaving is
108 * in use, logically adjacent sectors are not physically
109 * contiguous, but instead are separated by some number of
110 * sectors. It is specified as the ratio of physical sectors
111 * traversed per logical sector. Thus an interleave of 1:1
112 * implies contiguous layout, while 2:1 implies that logical
113 * sector 0 is separated by one sector from logical sector 1.
114 * d_trackskew is the offset of sector 0 on track N relative to
115 * sector 0 on track N-1 on the same cylinder. Finally, d_cylskew
116 * is the offset of sector 0 on cylinder N relative to sector 0
117 * on cylinder N-1.
118 */
119 u_int16_t d_rpm; /* rotational speed */
120 u_int16_t d_interleave; /* hardware sector interleave */
121 u_int16_t d_trackskew; /* sector 0 skew, per track */
122 u_int16_t d_cylskew; /* sector 0 skew, per cylinder */
123 u_int32_t d_headswitch; /* head switch time, usec */
124 u_int32_t d_trkseek; /* track-to-track seek, usec */
125 u_int32_t d_flags; /* generic flags */
126 #define NDDATA 5
127 u_int32_t d_drivedata[NDDATA]; /* drive-type specific information */
128 #define NSPARE 5
129 u_int32_t d_spare[NSPARE]; /* reserved for future use */
130 u_int32_t d_magic2; /* the magic number (again) */
131 u_int16_t d_checksum; /* xor of data incl. partitions */
132
133 /* filesystem and partition information: */
134 u_int16_t d_npartitions; /* number of partitions in following */
135 u_int32_t d_bbsize; /* size of boot area at sn0, bytes */
136 u_int32_t d_sbsize; /* max size of fs superblock, bytes */
137 struct partition { /* the partition table */
138 u_int32_t p_size; /* number of sectors in partition */
139 u_int32_t p_offset; /* starting sector */
140 u_int32_t p_fsize; /* filesystem basic fragment size */
141 u_int8_t p_fstype; /* filesystem type, see below */
142 u_int8_t p_frag; /* filesystem fragments per block */
143 u_int16_t p_cpg; /* filesystem cylinders per group */
144 } d_partitions[MAXPARTITIONS]; /* actually may be more */
145 };
146
147 #ifdef CTASSERT
148 CTASSERT(sizeof(struct disklabel) == 148 + MAXPARTITIONS * 16);
149 #endif
150
151 static __inline u_int16_t dkcksum(struct disklabel *lp);
152 static __inline u_int16_t
dkcksum(struct disklabel * lp)153 dkcksum(struct disklabel *lp)
154 {
155 u_int16_t *start, *end;
156 u_int16_t sum = 0;
157
158 start = (u_int16_t *)lp;
159 end = (u_int16_t *)&lp->d_partitions[lp->d_npartitions];
160 while (start < end)
161 sum ^= *start++;
162 return (sum);
163 }
164
165
166 /* d_type values: */
167 #define DTYPE_SMD 1 /* SMD, XSMD; VAX hp/up */
168 #define DTYPE_MSCP 2 /* MSCP */
169 #define DTYPE_DEC 3 /* other DEC (rk, rl) */
170 #define DTYPE_SCSI 4 /* SCSI */
171 #define DTYPE_ESDI 5 /* ESDI interface */
172 #define DTYPE_ST506 6 /* ST506 etc. */
173 #define DTYPE_HPIB 7 /* CS/80 on HP-IB */
174 #define DTYPE_HPFL 8 /* HP Fiber-link */
175 #define DTYPE_FLOPPY 10 /* floppy */
176 #define DTYPE_CCD 11 /* concatenated disk */
177 #define DTYPE_VINUM 12 /* vinum volume */
178 #define DTYPE_DOC2K 13 /* Msys DiskOnChip */
179 #define DTYPE_RAID 14 /* CMU RAIDFrame */
180 #define DTYPE_JFS2 16 /* IBM JFS 2 */
181
182 #ifdef DKTYPENAMES
183 static const char *dktypenames[] = {
184 "unknown",
185 "SMD",
186 "MSCP",
187 "old DEC",
188 "SCSI",
189 "ESDI",
190 "ST506",
191 "HP-IB",
192 "HP-FL",
193 "type 9",
194 "floppy",
195 "CCD",
196 "Vinum",
197 "DOC2K",
198 "Raid",
199 "?",
200 "jfs",
201 NULL
202 };
203 #define DKMAXTYPES (sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
204 #endif
205
206 /*
207 * Filesystem type and version.
208 * Used to interpret other filesystem-specific
209 * per-partition information.
210 */
211 #define FS_UNUSED 0 /* unused */
212 #define FS_SWAP 1 /* swap */
213 #define FS_V6 2 /* Sixth Edition */
214 #define FS_V7 3 /* Seventh Edition */
215 #define FS_SYSV 4 /* System V */
216 #define FS_V71K 5 /* V7 with 1K blocks (4.1, 2.9) */
217 #define FS_V8 6 /* Eighth Edition, 4K blocks */
218 #define FS_BSDFFS 7 /* 4.2BSD fast filesystem */
219 #define FS_MSDOS 8 /* MSDOS filesystem */
220 #define FS_BSDLFS 9 /* 4.4BSD log-structured filesystem */
221 #define FS_OTHER 10 /* in use, but unknown/unsupported */
222 #define FS_HPFS 11 /* OS/2 high-performance filesystem */
223 #define FS_ISO9660 12 /* ISO 9660, normally CD-ROM */
224 #define FS_BOOT 13 /* partition contains bootstrap */
225 #define FS_VINUM 14 /* Vinum drive */
226 #define FS_RAID 15 /* RAIDFrame drive */
227 #define FS_FILECORE 16 /* Acorn Filecore Filing System */
228 #define FS_EXT2FS 17 /* ext2fs */
229 #define FS_NTFS 18 /* Windows/NT file system */
230 #define FS_CCD 20 /* concatenated disk component */
231 #define FS_JFS2 21 /* IBM JFS2 */
232 #define FS_HAMMER 22 /* DragonFlyBSD Hammer FS */
233 #define FS_HAMMER2 23 /* DragonFlyBSD Hammer2 FS */
234 #define FS_UDF 24 /* UDF */
235 #define FS_EFS 26 /* SGI's Extent File system */
236 #define FS_ZFS 27 /* Sun's ZFS */
237
238 #ifdef FSTYPENAMES
239 static const char *fstypenames[] = {
240 "unused",
241 "swap",
242 "Version 6",
243 "Version 7",
244 "System V",
245 "4.1BSD",
246 "Eighth Edition",
247 "4.2BSD",
248 "MSDOS",
249 "4.4LFS",
250 "unknown",
251 "HPFS",
252 "ISO9660",
253 "boot",
254 "vinum",
255 "raid",
256 "Filecore",
257 "EXT2FS",
258 "NTFS",
259 "?",
260 "ccd",
261 "jfs",
262 "HAMMER",
263 "HAMMER2",
264 "UDF",
265 "?",
266 "EFS",
267 "ZFS",
268 "?",
269 "?",
270 NULL
271 };
272 #define FSMAXTYPES (sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
273 #endif
274
275 /*
276 * flags shared by various drives:
277 */
278 #define D_REMOVABLE 0x01 /* removable media */
279 #define D_ECC 0x02 /* supports ECC */
280 #define D_BADSECT 0x04 /* supports bad sector forw. */
281 #define D_RAMDISK 0x08 /* disk emulator */
282 #define D_CHAIN 0x10 /* can do back-back transfers */
283
284 /*
285 * NB: <sys/disk.h> defines ioctls from 'd'/128 and up.
286 */
287
288 /*
289 * Functions for proper encoding/decoding of struct disklabel into/from
290 * bytestring.
291 */
292 void bsd_partition_le_dec(u_char *ptr, struct partition *d);
293 int bsd_disklabel_le_dec(u_char *ptr, struct disklabel *d, int maxpart);
294 void bsd_partition_le_enc(u_char *ptr, struct partition *d);
295 void bsd_disklabel_le_enc(u_char *ptr, struct disklabel *d);
296
297 #ifndef _KERNEL
298 __BEGIN_DECLS
299 struct disklabel *getdiskbyname(const char *);
300 __END_DECLS
301 #endif
302
303 #endif /* !_SYS_DISKLABEL_H_ */
304