xref: /dragonfly/sys/sys/disklabel.h (revision 49781055)
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.12 2006/02/17 19:18:07 dillon Exp $
36  */
37 
38 #ifndef _SYS_DISKLABEL_H_
39 #define	_SYS_DISKLABEL_H_
40 
41 #ifndef _KERNEL
42 #include <sys/types.h>
43 #endif
44 #include <sys/ioccom.h>
45 #include <sys/conf.h>
46 
47 /*
48  * Disk description table, see disktab(5)
49  */
50 #define	_PATH_DISKTAB	"/etc/disktab"
51 #define	DISKTAB		"/etc/disktab"		/* deprecated */
52 
53 /*
54  * Each disk has a label which includes information about the hardware
55  * disk geometry, filesystem partitions, and drive specific information.
56  * The label is in block 0 or 1, possibly offset from the beginning
57  * to leave room for a bootstrap, etc.
58  */
59 
60 /* XXX these should be defined per controller (or drive) elsewhere, not here! */
61 #ifdef __i386__
62 #define LABELSECTOR	1			/* sector containing label */
63 #define LABELOFFSET	0			/* offset of label in sector */
64 #endif
65 
66 #ifndef	LABELSECTOR
67 #define LABELSECTOR	0			/* sector containing label */
68 #endif
69 
70 #ifndef	LABELOFFSET
71 #define LABELOFFSET	64			/* offset of label in sector */
72 #endif
73 
74 #define DISKMAGIC	((u_int32_t)0x82564557)	/* The disk magic number */
75 #ifndef MAXPARTITIONS
76 #define	MAXPARTITIONS	16
77 #endif
78 
79 #define	LABEL_PART	2		/* partition containing label */
80 #define	RAW_PART	2		/* partition containing whole disk */
81 #define	SWAP_PART	1		/* partition normally containing swap */
82 
83 #ifndef LOCORE
84 struct disklabel {
85 	u_int32_t d_magic;		/* the magic number */
86 	u_int16_t d_type;		/* drive type */
87 	u_int16_t d_subtype;		/* controller/d_type specific */
88 	char	  d_typename[16];	/* type name, e.g. "eagle" */
89 
90 	/*
91 	 * d_packname contains the pack identifier and is returned when
92 	 * the disklabel is read off the disk or in-core copy.
93 	 * d_boot0 and d_boot1 are the (optional) names of the
94 	 * primary (block 0) and secondary (block 1-15) bootstraps
95 	 * as found in /boot.  These are returned when using
96 	 * getdiskbyname(3) to retrieve the values from /etc/disktab.
97 	 */
98 	union {
99 		char	un_d_packname[16];	/* pack identifier */
100 		struct {
101 			char *un_d_boot0;	/* primary bootstrap name */
102 			char *un_d_boot1;	/* secondary bootstrap name */
103 		} un_b;
104 	} d_un;
105 #define d_packname	d_un.un_d_packname
106 #define d_boot0		d_un.un_b.un_d_boot0
107 #define d_boot1		d_un.un_b.un_d_boot1
108 
109 			/* disk geometry: */
110 	u_int32_t d_secsize;		/* # of bytes per sector */
111 	u_int32_t d_nsectors;		/* # of data sectors per track */
112 	u_int32_t d_ntracks;		/* # of tracks per cylinder */
113 	u_int32_t d_ncylinders;		/* # of data cylinders per unit */
114 	u_int32_t d_secpercyl;		/* # of data sectors per cylinder */
115 	u_int32_t d_secperunit;		/* # of data sectors per unit */
116 
117 	/*
118 	 * Spares (bad sector replacements) below are not counted in
119 	 * d_nsectors or d_secpercyl.  Spare sectors are assumed to
120 	 * be physical sectors which occupy space at the end of each
121 	 * track and/or cylinder.
122 	 */
123 	u_int16_t d_sparespertrack;	/* # of spare sectors per track */
124 	u_int16_t d_sparespercyl;	/* # of spare sectors per cylinder */
125 	/*
126 	 * Alternate cylinders include maintenance, replacement, configuration
127 	 * description areas, etc.
128 	 */
129 	u_int32_t d_acylinders;		/* # of alt. cylinders per unit */
130 
131 			/* hardware characteristics: */
132 	/*
133 	 * d_interleave, d_trackskew and d_cylskew describe perturbations
134 	 * in the media format used to compensate for a slow controller.
135 	 * Interleave is physical sector interleave, set up by the
136 	 * formatter or controller when formatting.  When interleaving is
137 	 * in use, logically adjacent sectors are not physically
138 	 * contiguous, but instead are separated by some number of
139 	 * sectors.  It is specified as the ratio of physical sectors
140 	 * traversed per logical sector.  Thus an interleave of 1:1
141 	 * implies contiguous layout, while 2:1 implies that logical
142 	 * sector 0 is separated by one sector from logical sector 1.
143 	 * d_trackskew is the offset of sector 0 on track N relative to
144 	 * sector 0 on track N-1 on the same cylinder.  Finally, d_cylskew
145 	 * is the offset of sector 0 on cylinder N relative to sector 0
146 	 * on cylinder N-1.
147 	 */
148 	u_int16_t d_rpm;		/* rotational speed */
149 	u_int16_t d_interleave;		/* hardware sector interleave */
150 	u_int16_t d_trackskew;		/* sector 0 skew, per track */
151 	u_int16_t d_cylskew;		/* sector 0 skew, per cylinder */
152 	u_int32_t d_headswitch;		/* head switch time, usec */
153 	u_int32_t d_trkseek;		/* track-to-track seek, usec */
154 	u_int32_t d_flags;		/* generic flags */
155 #define NDDATA 5
156 	u_int32_t d_drivedata[NDDATA];	/* drive-type specific information */
157 #define NSPARE 5
158 	u_int32_t d_spare[NSPARE];	/* reserved for future use */
159 	u_int32_t d_magic2;		/* the magic number (again) */
160 	u_int16_t d_checksum;		/* xor of data incl. partitions */
161 
162 			/* filesystem and partition information: */
163 	u_int16_t d_npartitions;	/* number of partitions in following */
164 	u_int32_t d_bbsize;		/* size of boot area at sn0, bytes */
165 	u_int32_t d_sbsize;		/* max size of fs superblock, bytes */
166 	struct	partition {		/* the partition table */
167 		u_int32_t p_size;	/* number of sectors in partition */
168 		u_int32_t p_offset;	/* starting sector */
169 		u_int32_t p_fsize;	/* filesystem basic fragment size */
170 		u_int8_t p_fstype;	/* filesystem type, see below */
171 		u_int8_t p_frag;	/* filesystem fragments per block */
172 		union {
173 			u_int16_t cpg;	/* UFS: FS cylinders per group */
174 			u_int16_t sgs;	/* LFS: FS segment shift */
175 		} __partition_u1;
176 #define	p_cpg	__partition_u1.cpg
177 #define	p_sgs	__partition_u1.sgs
178 	} d_partitions[MAXPARTITIONS];	/* actually may be more */
179 };
180 
181 static u_int16_t dkcksum(struct disklabel *lp);
182 
183 static __inline u_int16_t
184 dkcksum(struct disklabel *lp)
185 {
186 	u_int16_t *start, *end;
187 	u_int16_t sum = 0;
188 
189 	start = (u_int16_t *)lp;
190 	end = (u_int16_t *)&lp->d_partitions[lp->d_npartitions];
191 	while (start < end)
192 		sum ^= *start++;
193 	return (sum);
194 }
195 
196 #else /* LOCORE */
197 	/*
198 	 * offsets for asm boot files.
199 	 */
200 	.set	d_secsize,40
201 	.set	d_nsectors,44
202 	.set	d_ntracks,48
203 	.set	d_ncylinders,52
204 	.set	d_secpercyl,56
205 	.set	d_secperunit,60
206 	.set	d_end_,276		/* size of disk label */
207 #endif /* LOCORE */
208 
209 /* d_type values: */
210 #define	DTYPE_SMD		1		/* SMD, XSMD; VAX hp/up */
211 #define	DTYPE_MSCP		2		/* MSCP */
212 #define	DTYPE_DEC		3		/* other DEC (rk, rl) */
213 #define	DTYPE_SCSI		4		/* SCSI */
214 #define	DTYPE_ESDI		5		/* ESDI interface */
215 #define	DTYPE_ST506		6		/* ST506 etc. */
216 #define	DTYPE_HPIB		7		/* CS/80 on HP-IB */
217 #define	DTYPE_HPFL		8		/* HP Fiber-link */
218 #define	DTYPE_FLOPPY		10		/* floppy */
219 #define	DTYPE_CCD		11		/* concatenated disk */
220 #define	DTYPE_VINUM		12		/* vinum volume */
221 #define	DTYPE_DOC2K		13		/* Msys DiskOnChip */
222 
223 #ifdef DKTYPENAMES
224 static const char *dktypenames[] = {
225 	"unknown",
226 	"SMD",
227 	"MSCP",
228 	"old DEC",
229 	"SCSI",
230 	"ESDI",
231 	"ST506",
232 	"HP-IB",
233 	"HP-FL",
234 	"type 9",
235 	"floppy",
236 	"CCD",
237 	"Vinum",
238 	"DOC2K",
239 	NULL
240 };
241 #define DKMAXTYPES	(sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
242 #endif
243 
244 /*
245  * Filesystem type and version.
246  * Used to interpret other filesystem-specific
247  * per-partition information.
248  */
249 #define	FS_UNUSED	0		/* unused */
250 #define	FS_SWAP		1		/* swap */
251 #define	FS_V6		2		/* Sixth Edition */
252 #define	FS_V7		3		/* Seventh Edition */
253 #define	FS_SYSV		4		/* System V */
254 #define	FS_V71K		5		/* V7 with 1K blocks (4.1, 2.9) */
255 #define	FS_V8		6		/* Eighth Edition, 4K blocks */
256 #define	FS_BSDFFS	7		/* 4.2BSD fast file system */
257 #define	FS_MSDOS	8		/* MSDOS file system */
258 #define	FS_BSDLFS	9		/* 4.4BSD log-structured file system */
259 #define	FS_OTHER	10		/* in use, but unknown/unsupported */
260 #define	FS_HPFS		11		/* OS/2 high-performance file system */
261 #define	FS_ISO9660	12		/* ISO 9660, normally CD-ROM */
262 #define	FS_BOOT		13		/* partition contains bootstrap */
263 #define	FS_VINUM	14		/* Vinum drive */
264 
265 #ifdef	DKTYPENAMES
266 static const char *fstypenames[] = {
267 	"unused",
268 	"swap",
269 	"Version 6",
270 	"Version 7",
271 	"System V",
272 	"4.1BSD",
273 	"Eighth Edition",
274 	"4.2BSD",
275 	"MSDOS",
276 	"4.4LFS",
277 	"unknown",
278 	"HPFS",
279 	"ISO9660",
280 	"boot",
281 	"vinum",
282 	NULL
283 };
284 #define FSMAXTYPES	(sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
285 #endif
286 
287 /*
288  * flags shared by various drives:
289  */
290 #define		D_REMOVABLE	0x01		/* removable media */
291 #define		D_ECC		0x02		/* supports ECC */
292 #define		D_BADSECT	0x04		/* supports bad sector forw. */
293 #define		D_RAMDISK	0x08		/* disk emulator */
294 #define		D_CHAIN		0x10		/* can do back-back transfers */
295 
296 /*
297  * Drive data for SMD.
298  */
299 #define	d_smdflags	d_drivedata[0]
300 #define		D_SSE		0x1		/* supports skip sectoring */
301 #define	d_mindist	d_drivedata[1]
302 #define	d_maxdist	d_drivedata[2]
303 #define	d_sdist		d_drivedata[3]
304 
305 /*
306  * Drive data for ST506.
307  */
308 #define d_precompcyl	d_drivedata[0]
309 #define d_gap3		d_drivedata[1]		/* used only when formatting */
310 
311 /*
312  * Drive data for SCSI.
313  */
314 #define	d_blind		d_drivedata[0]
315 
316 #ifndef LOCORE
317 /*
318  * Structure used to perform a format or other raw operation, returning
319  * data and/or register values.  Register identification and format
320  * are device- and driver-dependent.
321  */
322 struct format_op {
323 	char	*df_buf;
324 	int	 df_count;		/* value-result */
325 	daddr_t	 df_startblk;
326 	int	 df_reg[8];		/* result */
327 };
328 
329 /*
330  * Structure used internally to retrieve information about a partition
331  * on a disk.
332  */
333 struct partinfo {
334 	struct disklabel *disklab;
335 	struct partition *part;
336 };
337 
338 /*
339  * Disk-specific ioctls.
340  */
341 		/* get and set disklabel; DIOCGPART used internally */
342 #define DIOCGDINFO	_IOR('d', 101, struct disklabel)/* get */
343 #define DIOCSDINFO	_IOW('d', 102, struct disklabel)/* set */
344 #define DIOCWDINFO	_IOW('d', 103, struct disklabel)/* set, update disk */
345 #define DIOCGPART	_IOW('d', 104, struct partinfo)	/* get partition */
346 #define DIOCGDVIRGIN	_IOR('d', 105, struct disklabel) /* get virgin label */
347 
348 #define DIOCWLABEL	_IOW('d', 109, int)	/* write en/disable label */
349 
350 #ifdef _KERNEL
351 
352 /*
353  * XXX encoding of disk minor numbers, should be elsewhere.
354  *
355  * See <sys/reboot.h> for a possibly better encoding.
356  *
357  * "cpio -H newc" can be used to back up device files with large minor
358  * numbers (but not ones >= 2^31).  Old cpio formats and all tar formats
359  * don't have enough bits, and cpio and tar don't notice the lossage.
360  * There are also some sign extension bugs.
361  */
362 
363 /*
364        3                   2                   1                   0
365      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
366     _________________________________________________________________
367     | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
368     -----------------------------------------------------------------
369     |    TYPE     |UNIT_2 |P| SLICE |  MAJOR?       |  UNIT   |PART |
370     -----------------------------------------------------------------
371 */
372 
373 #define DKMAXUNIT 0x1ff		/* Highest disk unit number */
374 
375 #define	dkmakeminor(unit, slice, part) \
376 				(((slice) << 16) | (((unit) & 0x1e0) << 16) | \
377 				(((unit) & 0x1f) << 3) | (part & 7) | \
378 				((part & 0x08) << 17))
379 
380 static __inline u_int
381 dkunitmask(void)
382 {
383 	return (0x01e000f8);
384 }
385 
386 static __inline u_int
387 dkmakeunit(int unit)
388 {
389 	return(dkmakeminor(unit, 0, 0));
390 }
391 
392 static __inline dev_t
393 dkmodpart(dev_t dev, int part)
394 {
395 	int val;
396 
397 	if (part < 8)
398 		val = (part & 7);
399 	else
400 		val = (part & 7) | 0x100000;
401 	return (make_sub_dev(dev, (minor(dev) & ~0x100007) | val));
402 }
403 
404 static __inline dev_t
405 dkmodslice(dev_t dev, int slice)
406 {
407 	return (make_sub_dev(dev, (minor(dev) & ~0x0f0000) | (slice << 16)));
408 }
409 
410 static __inline int
411 dkpart(dev_t dev)
412 {
413 	return (((minor(dev) >> 17) & 0x08) | (minor(dev) & 7));
414 }
415 
416 #define	dkslice(dev)		((minor(dev) >> 16) & 0x0f)
417 #define	dktype(dev)       	((minor(dev) >> 25) & 0x7f)
418 
419 static __inline u_int
420 dkunit(dev_t dev)
421 {
422 	return (((minor(dev) >> 16) & 0x1e0) | ((minor(dev) >> 3) & 0x1f));
423 }
424 
425 struct	buf;
426 struct	bio;
427 struct	bio_queue_head;
428 
429 struct bio *bounds_check_with_label (dev_t dev, struct bio *bio,
430 				     struct disklabel *lp, int wlabel);
431 void	diskerr (struct bio *bio, dev_t dev, const char *what, int pri,
432 		     int blkdone, struct disklabel *lp);
433 void	disksort (struct buf *ap, struct buf *bp);
434 char	*readdisklabel (dev_t dev, struct disklabel *lp);
435 void	bioqdisksort (struct bio_queue_head *ap, struct bio *bio);
436 int	setdisklabel (struct disklabel *olp, struct disklabel *nlp,
437 			  u_long openmask);
438 int	writedisklabel (dev_t dev, struct disklabel *lp);
439 
440 #endif /* _KERNEL */
441 
442 #endif /* LOCORE */
443 
444 #ifndef _KERNEL
445 __BEGIN_DECLS
446 struct disklabel *getdiskbyname (const char *);
447 __END_DECLS
448 #endif
449 
450 #endif /* !_SYS_DISKLABEL_H_ */
451