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