xref: /dragonfly/sys/sys/disklabel.h (revision 3f5e28f4)
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  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)disklabel.h	8.2 (Berkeley) 7/10/94
34  * $FreeBSD: src/sys/sys/disklabel.h,v 1.49.2.7 2001/05/27 05:58:26 jkh Exp $
35  * $DragonFly: src/sys/sys/disklabel.h,v 1.21 2007/05/17 03:20:11 dillon Exp $
36  */
37 
38 #ifndef _SYS_DISKLABEL_H_
39 #define	_SYS_DISKLABEL_H_
40 
41 #ifndef _SYS_TYPES_H_
42 #include <sys/types.h>
43 #endif
44 #if defined(_KERNEL) && !defined(_SYS_SYSTM_H_)
45 #include <sys/systm.h>
46 #endif
47 #ifndef _SYS_IOCCOM_H_
48 #include <sys/ioccom.h>
49 #endif
50 #if defined(_KERNEL) && !defined(_SYS_CONF_H_)
51 #include <sys/conf.h>		/* for make_sub_dev() */
52 #endif
53 
54 /*
55  * Disk description table, see disktab(5)
56  */
57 #define	_PATH_DISKTAB	"/etc/disktab"
58 #define	DISKTAB		"/etc/disktab"		/* deprecated */
59 
60 /*
61  * Each disk has a label which includes information about the hardware
62  * disk geometry, filesystem partitions, and drive specific information.
63  * The label is in block 0 or 1, possibly offset from the beginning
64  * to leave room for a bootstrap, etc.
65  */
66 
67 /* XXX these should be defined per controller (or drive) elsewhere, not here! */
68 #ifdef __i386__
69 #define LABELSECTOR	1			/* sector containing label */
70 #define LABELOFFSET	0			/* offset of label in sector */
71 #endif
72 
73 #ifndef	LABELSECTOR
74 #define LABELSECTOR	0			/* sector containing label */
75 #endif
76 
77 #ifndef	LABELOFFSET
78 #define LABELOFFSET	64			/* offset of label in sector */
79 #endif
80 
81 #define DISKMAGIC	((u_int32_t)0x82564557)	/* The disk magic number */
82 #ifndef MAXPARTITIONS
83 #define	MAXPARTITIONS	16
84 #endif
85 
86 #define	LABEL_PART	2		/* partition containing label */
87 #define	RAW_PART	2		/* partition containing whole disk */
88 #define	SWAP_PART	1		/* partition normally containing swap */
89 
90 #ifndef LOCORE
91 struct disklabel {
92 	u_int32_t d_magic;		/* the magic number */
93 	u_int16_t d_type;		/* drive type */
94 	u_int16_t d_subtype;		/* controller/d_type specific */
95 	char	  d_typename[16];	/* type name, e.g. "eagle" */
96 
97 	/*
98 	 * d_packname contains the pack identifier and is returned when
99 	 * the disklabel is read off the disk or in-core copy.
100 	 * d_boot0 and d_boot1 are the (optional) names of the
101 	 * primary (block 0) and secondary (block 1-15) bootstraps
102 	 * as found in /boot.  These are returned when using
103 	 * getdiskbyname(3) to retrieve the values from /etc/disktab.
104 	 */
105 	union {
106 		char	un_d_packname[16];	/* pack identifier */
107 		struct {
108 			char *un_d_boot0;	/* primary bootstrap name */
109 			char *un_d_boot1;	/* secondary bootstrap name */
110 		} un_b;
111 	} d_un;
112 #define d_packname	d_un.un_d_packname
113 #define d_boot0		d_un.un_b.un_d_boot0
114 #define d_boot1		d_un.un_b.un_d_boot1
115 
116 			/* disk geometry: */
117 	u_int32_t d_secsize;		/* # of bytes per sector */
118 	u_int32_t d_nsectors;		/* # of data sectors per track */
119 	u_int32_t d_ntracks;		/* # of tracks per cylinder */
120 	u_int32_t d_ncylinders;		/* # of data cylinders per unit */
121 	u_int32_t d_secpercyl;		/* # of data sectors per cylinder */
122 	u_int32_t d_secperunit;		/* # of data sectors per unit */
123 
124 	/*
125 	 * Spares (bad sector replacements) below are not counted in
126 	 * d_nsectors or d_secpercyl.  Spare sectors are assumed to
127 	 * be physical sectors which occupy space at the end of each
128 	 * track and/or cylinder.
129 	 */
130 	u_int16_t d_sparespertrack;	/* # of spare sectors per track */
131 	u_int16_t d_sparespercyl;	/* # of spare sectors per cylinder */
132 	/*
133 	 * Alternate cylinders include maintenance, replacement, configuration
134 	 * description areas, etc.
135 	 */
136 	u_int32_t d_acylinders;		/* # of alt. cylinders per unit */
137 
138 			/* hardware characteristics: */
139 	/*
140 	 * d_interleave, d_trackskew and d_cylskew describe perturbations
141 	 * in the media format used to compensate for a slow controller.
142 	 * Interleave is physical sector interleave, set up by the
143 	 * formatter or controller when formatting.  When interleaving is
144 	 * in use, logically adjacent sectors are not physically
145 	 * contiguous, but instead are separated by some number of
146 	 * sectors.  It is specified as the ratio of physical sectors
147 	 * traversed per logical sector.  Thus an interleave of 1:1
148 	 * implies contiguous layout, while 2:1 implies that logical
149 	 * sector 0 is separated by one sector from logical sector 1.
150 	 * d_trackskew is the offset of sector 0 on track N relative to
151 	 * sector 0 on track N-1 on the same cylinder.  Finally, d_cylskew
152 	 * is the offset of sector 0 on cylinder N relative to sector 0
153 	 * on cylinder N-1.
154 	 */
155 	u_int16_t d_rpm;		/* rotational speed */
156 	u_int16_t d_interleave;		/* hardware sector interleave */
157 	u_int16_t d_trackskew;		/* sector 0 skew, per track */
158 	u_int16_t d_cylskew;		/* sector 0 skew, per cylinder */
159 	u_int32_t d_headswitch;		/* head switch time, usec */
160 	u_int32_t d_trkseek;		/* track-to-track seek, usec */
161 	u_int32_t d_flags;		/* generic flags (now unused) */
162 #define NDDATA 5
163 	u_int32_t d_drivedata[NDDATA];	/* drive-type specific information */
164 #define NSPARE 5
165 	u_int32_t d_spare[NSPARE];	/* reserved for future use */
166 	u_int32_t d_magic2;		/* the magic number (again) */
167 	u_int16_t d_checksum;		/* xor of data incl. partitions */
168 
169 			/* filesystem and partition information: */
170 	u_int16_t d_npartitions;	/* number of partitions in following */
171 	u_int32_t d_bbsize;		/* size of boot area at sn0, bytes */
172 	u_int32_t d_sbsize;		/* max size of fs superblock, bytes */
173 	struct	partition {		/* the partition table */
174 		u_int32_t p_size;	/* number of sectors in partition */
175 		u_int32_t p_offset;	/* starting sector */
176 		u_int32_t p_fsize;	/* filesystem basic fragment size */
177 		u_int8_t p_fstype;	/* filesystem type, see below */
178 		u_int8_t p_frag;	/* filesystem fragments per block */
179 		union {
180 			u_int16_t cpg;	/* UFS: FS cylinders per group */
181 			u_int16_t sgs;	/* LFS: FS segment shift */
182 		} __partition_u1;
183 #define	p_cpg	__partition_u1.cpg
184 #define	p_sgs	__partition_u1.sgs
185 	} d_partitions[MAXPARTITIONS];	/* actually may be more */
186 };
187 
188 static u_int16_t dkcksum(struct disklabel *lp);
189 
190 static __inline u_int16_t
191 dkcksum(struct disklabel *lp)
192 {
193 	u_int16_t *start, *end;
194 	u_int16_t sum = 0;
195 
196 	start = (u_int16_t *)lp;
197 	end = (u_int16_t *)&lp->d_partitions[lp->d_npartitions];
198 	while (start < end)
199 		sum ^= *start++;
200 	return (sum);
201 }
202 
203 #else /* LOCORE */
204 	/*
205 	 * offsets for asm boot files.
206 	 */
207 	.set	d_secsize,40
208 	.set	d_nsectors,44
209 	.set	d_ntracks,48
210 	.set	d_ncylinders,52
211 	.set	d_secpercyl,56
212 	.set	d_secperunit,60
213 	.set	d_end_,276		/* size of disk label */
214 #endif /* LOCORE */
215 
216 /* d_type values: */
217 #define	DTYPE_SMD		1		/* SMD, XSMD; VAX hp/up */
218 #define	DTYPE_MSCP		2		/* MSCP */
219 #define	DTYPE_DEC		3		/* other DEC (rk, rl) */
220 #define	DTYPE_SCSI		4		/* SCSI */
221 #define	DTYPE_ESDI		5		/* ESDI interface */
222 #define	DTYPE_ST506		6		/* ST506 etc. */
223 #define	DTYPE_HPIB		7		/* CS/80 on HP-IB */
224 #define	DTYPE_HPFL		8		/* HP Fiber-link */
225 #define	DTYPE_FLOPPY		10		/* floppy */
226 #define	DTYPE_CCD		11		/* concatenated disk */
227 #define	DTYPE_VINUM		12		/* vinum volume */
228 #define	DTYPE_DOC2K		13		/* Msys DiskOnChip */
229 
230 #ifdef DKTYPENAMES
231 static const char *dktypenames[] = {
232 	"unknown",
233 	"SMD",
234 	"MSCP",
235 	"old DEC",
236 	"SCSI",
237 	"ESDI",
238 	"ST506",
239 	"HP-IB",
240 	"HP-FL",
241 	"type 9",
242 	"floppy",
243 	"CCD",
244 	"Vinum",
245 	"DOC2K",
246 	NULL
247 };
248 #define DKMAXTYPES	(sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
249 #endif
250 
251 /*
252  * Filesystem type and version.
253  * Used to interpret other filesystem-specific
254  * per-partition information.
255  */
256 #define	FS_UNUSED	0		/* unused */
257 #define	FS_SWAP		1		/* swap */
258 #define	FS_V6		2		/* Sixth Edition */
259 #define	FS_V7		3		/* Seventh Edition */
260 #define	FS_SYSV		4		/* System V */
261 #define	FS_V71K		5		/* V7 with 1K blocks (4.1, 2.9) */
262 #define	FS_V8		6		/* Eighth Edition, 4K blocks */
263 #define	FS_BSDFFS	7		/* 4.2BSD fast file system */
264 #define	FS_MSDOS	8		/* MSDOS file system */
265 #define	FS_BSDLFS	9		/* 4.4BSD log-structured file system */
266 #define	FS_OTHER	10		/* in use, but unknown/unsupported */
267 #define	FS_HPFS		11		/* OS/2 high-performance file system */
268 #define	FS_ISO9660	12		/* ISO 9660, normally CD-ROM */
269 #define	FS_BOOT		13		/* partition contains bootstrap */
270 #define	FS_VINUM	14		/* Vinum drive partition */
271 #define	FS_RAID		15
272 #define FS_RESERVED16	16
273 #define FS_RESERVED17	17
274 #define FS_RESERVED18	18
275 #define FS_CCD		19		/* CCD drive partition */
276 #define FS_RESERVED20	20
277 #define FS_JFS2		21
278 
279 #ifdef	DKTYPENAMES
280 static const char *fstypenames[] = {
281 	"unused",
282 	"swap",
283 	"Version 6",
284 	"Version 7",
285 	"System V",
286 	"4.1BSD",
287 	"Eighth Edition",
288 	"4.2BSD",
289 	"MSDOS",
290 	"4.4LFS",
291 	"unknown",
292 	"HPFS",
293 	"ISO9660",
294 	"boot",
295 	"vinum",
296 	"raid",
297 	"?",
298 	"?",
299 	"?",
300 	"ccd",
301 	"?",	/* don't use in case freebsd reassigns jfs / bug in freebsd */
302 	"jfs",
303 	NULL
304 };
305 #define FSMAXTYPES	(sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
306 #endif
307 
308 #ifndef LOCORE
309 
310 /*
311  * Disk-specific ioctls.
312  */
313 #define DIOCGDINFO	_IOR('d', 101, struct disklabel)/* get */
314 #define DIOCSDINFO	_IOW('d', 102, struct disklabel)/* set */
315 #define DIOCWDINFO	_IOW('d', 103, struct disklabel)/* set, update disk */
316 #define DIOCGDVIRGIN	_IOR('d', 105, struct disklabel) /* get virgin label */
317 
318 #define DIOCWLABEL	_IOW('d', 109, int)	/* write en/disable label */
319 
320 #ifdef _KERNEL
321 
322 /*
323  * XXX encoding of disk minor numbers, should be elsewhere.
324  *
325  * See <sys/reboot.h> for a possibly better encoding.
326  *
327  * "cpio -H newc" can be used to back up device files with large minor
328  * numbers (but not ones >= 2^31).  Old cpio formats and all tar formats
329  * don't have enough bits, and cpio and tar don't notice the lossage.
330  * There are also some sign extension bugs.
331  */
332 
333 /*
334        3                   2                   1                   0
335      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
336     _________________________________________________________________
337     | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
338     -----------------------------------------------------------------
339     |    TYPE     |UNIT_2 |P| SLICE |  MAJOR?       |  UNIT   |PART |
340     -----------------------------------------------------------------
341 */
342 
343 #define DKMAXUNIT 0x1ff		/* Highest disk unit number */
344 
345 #define	dkmakeminor(unit, slice, part) \
346 				(((slice) << 16) | (((unit) & 0x1e0) << 16) | \
347 				(((unit) & 0x1f) << 3) | (part & 7) | \
348 				((part & 0x08) << 17))
349 
350 static __inline u_int
351 dkunitmask(void)
352 {
353 	return (0x01e000f8);
354 }
355 
356 static __inline u_int
357 dkmakeunit(int unit)
358 {
359 	return(dkmakeminor(unit, 0, 0));
360 }
361 
362 static __inline cdev_t
363 dkmodpart(cdev_t dev, int part)
364 {
365 	int val;
366 
367 	if (part < 8)
368 		val = (part & 7);
369 	else
370 		val = (part & 7) | 0x100000;
371 	return (make_sub_dev(dev, (minor(dev) & ~0x100007) | val));
372 }
373 
374 static __inline cdev_t
375 dkmodslice(cdev_t dev, int slice)
376 {
377 	return (make_sub_dev(dev, (minor(dev) & ~0x0f0000) | (slice << 16)));
378 }
379 
380 static __inline int
381 dkpart(cdev_t dev)
382 {
383 	return (((minor(dev) >> 17) & 0x08) | (minor(dev) & 7));
384 }
385 
386 #define	dkslice(dev)		((minor(dev) >> 16) & 0x0f)
387 #define	dktype(dev)       	((minor(dev) >> 25) & 0x7f)
388 
389 static __inline u_int
390 dkunit(cdev_t dev)
391 {
392 	return (((minor(dev) >> 16) & 0x1e0) | ((minor(dev) >> 3) & 0x1f));
393 }
394 
395 struct	buf;
396 struct	bio;
397 struct	bio_queue_head;
398 
399 struct bio *bounds_check_with_label (cdev_t dev, struct bio *bio,
400 				     struct disklabel *lp, int wlabel);
401 void	diskerr (struct bio *bio, cdev_t dev, const char *what, int pri,
402 		     int donecnt);
403 void	disksort (struct buf *ap, struct buf *bp);
404 char	*readdisklabel (cdev_t dev, struct disklabel *lp);
405 void	bioqdisksort (struct bio_queue_head *ap, struct bio *bio);
406 int	setdisklabel (struct disklabel *olp, struct disklabel *nlp,
407 			  u_long openmask);
408 int	writedisklabel (cdev_t dev, struct disklabel *lp);
409 
410 #endif /* _KERNEL */
411 
412 #endif /* LOCORE */
413 
414 #ifndef _KERNEL
415 __BEGIN_DECLS
416 struct disklabel *getdiskbyname (const char *);
417 __END_DECLS
418 #endif
419 
420 #endif /* !_SYS_DISKLABEL_H_ */
421