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