disklabel.h revision 37466
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 * $Id: disklabel.h,v 1.32 1998/06/07 17:12:58 dfr Exp $
35 */
36
37#ifndef	_SYS_DISKLABEL_H_
38#define	_SYS_DISKLABEL_H_
39
40#ifndef KERNEL
41#include <sys/types.h>
42#endif
43#include <sys/ioccom.h>
44
45/*
46 * Disk description table, see disktab(5)
47 */
48#define	_PATH_DISKTAB	"/etc/disktab"
49#define	DISKTAB		"/etc/disktab"		/* deprecated */
50
51/*
52 * Each disk has a label which includes information about the hardware
53 * disk geometry, filesystem partitions, and drive specific information.
54 * The label is in block 0 or 1, possibly offset from the beginning
55 * to leave room for a bootstrap, etc.
56 */
57
58/* XXX these should be defined per controller (or drive) elsewhere, not here! */
59#ifdef __i386__
60#define LABELSECTOR	1			/* sector containing label */
61#define LABELOFFSET	0			/* offset of label in sector */
62#endif
63
64#ifdef __alpha__
65#define LABELSECTOR	1
66#define LABELOFFSET	0
67#endif
68
69#ifndef	LABELSECTOR
70#define LABELSECTOR	0			/* sector containing label */
71#endif
72
73#ifndef	LABELOFFSET
74#define LABELOFFSET	64			/* offset of label in sector */
75#endif
76
77#define DISKMAGIC	((u_int32_t)0x82564557)	/* The disk magic number */
78#ifndef MAXPARTITIONS
79#define	MAXPARTITIONS	8
80#endif
81
82#define	LABEL_PART	2		/* partition containing label */
83#define	RAW_PART	2		/* partition containing whole disk */
84#define	SWAP_PART	1		/* partition normally containing swap */
85
86#ifndef LOCORE
87struct disklabel {
88	u_int32_t d_magic;		/* the magic number */
89	u_int16_t d_type;		/* drive type */
90	u_int16_t d_subtype;		/* controller/d_type specific */
91	char	  d_typename[16];	/* type name, e.g. "eagle" */
92
93	/*
94	 * d_packname contains the pack identifier and is returned when
95	 * the disklabel is read off the disk or in-core copy.
96	 * d_boot0 and d_boot1 are the (optional) names of the
97	 * primary (block 0) and secondary (block 1-15) bootstraps
98	 * as found in /usr/mdec.  These are returned when using
99	 * getdiskbyname(3) to retrieve the values from /etc/disktab.
100	 */
101#if defined(KERNEL) || defined(STANDALONE)
102	char	  d_packname[16];		/* pack identifier */
103#else
104	union {
105		char	un_d_packname[16];	/* pack identifier */
106		struct {
107			char *un_d_boot0;	/* primary bootstrap name */
108			char *un_d_boot1;	/* secondary bootstrap name */
109		} un_b;
110	} d_un;
111#define d_packname	d_un.un_d_packname
112#define d_boot0		d_un.un_b.un_d_boot0
113#define d_boot1		d_un.un_b.un_d_boot1
114#endif	/* ! KERNEL or STANDALONE */
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 */
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#else /* LOCORE */
188	/*
189	 * offsets for asm boot files.
190	 */
191	.set	d_secsize,40
192	.set	d_nsectors,44
193	.set	d_ntracks,48
194	.set	d_ncylinders,52
195	.set	d_secpercyl,56
196	.set	d_secperunit,60
197	.set	d_end_,276		/* size of disk label */
198#endif /* LOCORE */
199
200/* d_type values: */
201#define	DTYPE_SMD		1		/* SMD, XSMD; VAX hp/up */
202#define	DTYPE_MSCP		2		/* MSCP */
203#define	DTYPE_DEC		3		/* other DEC (rk, rl) */
204#define	DTYPE_SCSI		4		/* SCSI */
205#define	DTYPE_ESDI		5		/* ESDI interface */
206#define	DTYPE_ST506		6		/* ST506 etc. */
207#define	DTYPE_HPIB		7		/* CS/80 on HP-IB */
208#define	DTYPE_HPFL		8		/* HP Fiber-link */
209#define	DTYPE_FLOPPY		10		/* floppy */
210#define	DTYPE_CCD		11		/* concatenated disk */
211#define DTYPE_VINUM		12		/* vinum volume */
212
213#ifdef PC98
214#define DSTYPE_SEC256		0x80		/* physical sector size=256*/
215#endif
216
217#ifdef DKTYPENAMES
218static char *dktypenames[] = {
219	"unknown",
220	"SMD",
221	"MSCP",
222	"old DEC",
223	"SCSI",
224	"ESDI",
225	"ST506",
226	"HP-IB",
227	"HP-FL",
228	"type 9",
229	"floppy",
230	"CCD",
231	"Vinum",
232	NULL
233};
234#define DKMAXTYPES	(sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
235#endif
236
237/*
238 * Filesystem type and version.
239 * Used to interpret other filesystem-specific
240 * per-partition information.
241 */
242#define	FS_UNUSED	0		/* unused */
243#define	FS_SWAP		1		/* swap */
244#define	FS_V6		2		/* Sixth Edition */
245#define	FS_V7		3		/* Seventh Edition */
246#define	FS_SYSV		4		/* System V */
247#define	FS_V71K		5		/* V7 with 1K blocks (4.1, 2.9) */
248#define	FS_V8		6		/* Eighth Edition, 4K blocks */
249#define	FS_BSDFFS	7		/* 4.2BSD fast file system */
250#define	FS_MSDOS	8		/* MSDOS file system */
251#define	FS_BSDLFS	9		/* 4.4BSD log-structured file system */
252#define	FS_OTHER	10		/* in use, but unknown/unsupported */
253#define	FS_HPFS		11		/* OS/2 high-performance file system */
254#define	FS_ISO9660	12		/* ISO 9660, normally CD-ROM */
255#define	FS_BOOT		13		/* partition contains bootstrap */
256
257#ifdef	DKTYPENAMES
258static char *fstypenames[] = {
259	"unused",
260	"swap",
261	"Version 6",
262	"Version 7",
263	"System V",
264	"4.1BSD",
265	"Eighth Edition",
266	"4.2BSD",
267	"MSDOS",
268	"4.4LFS",
269	"unknown",
270	"HPFS",
271	"ISO9660",
272	"boot",
273	NULL
274};
275#define FSMAXTYPES	(sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
276#endif
277
278/*
279 * flags shared by various drives:
280 */
281#define		D_REMOVABLE	0x01		/* removable media */
282#define		D_ECC		0x02		/* supports ECC */
283#define		D_BADSECT	0x04		/* supports bad sector forw. */
284#define		D_RAMDISK	0x08		/* disk emulator */
285#define		D_CHAIN		0x10		/* can do back-back transfers */
286
287/*
288 * Drive data for SMD.
289 */
290#define	d_smdflags	d_drivedata[0]
291#define		D_SSE		0x1		/* supports skip sectoring */
292#define	d_mindist	d_drivedata[1]
293#define	d_maxdist	d_drivedata[2]
294#define	d_sdist		d_drivedata[3]
295
296/*
297 * Drive data for ST506.
298 */
299#define d_precompcyl	d_drivedata[0]
300#define d_gap3		d_drivedata[1]		/* used only when formatting */
301
302/*
303 * Drive data for SCSI.
304 */
305#define	d_blind		d_drivedata[0]
306
307#ifndef LOCORE
308/*
309 * Structure used to perform a format or other raw operation, returning
310 * data and/or register values.  Register identification and format
311 * are device- and driver-dependent.
312 */
313struct format_op {
314	char	*df_buf;
315	int	df_count;		/* value-result */
316	daddr_t	df_startblk;
317	int	df_reg[8];		/* result */
318};
319
320/*
321 * Structure used internally to retrieve information about a partition
322 * on a disk.
323 */
324struct partinfo {
325	struct disklabel *disklab;
326	struct partition *part;
327};
328
329/* DOS partition table -- located in boot block */
330
331#ifdef PC98
332#define	DOSBBSECTOR	0	/* DOS boot block relative sector number */
333#define DOSLABELSECTOR	1	/* 0: 256b/s, 1: 512b/s */
334#define	DOSPARTOFF	0
335#define NDOSPART	16
336#define	DOSPTYP_386BSD	0x94	/* 386BSD partition type */
337#define	MBR_PTYPE_FreeBSD 0x94	/* FreeBSD partition type */
338
339struct dos_partition {
340    	unsigned char	dp_mid;
341#define DOSMID_386BSD		(0x14|0x80) /* 386bsd|bootable */
342	unsigned char	dp_sid;
343#define DOSSID_386BSD		(0x44|0x80) /* 386bsd|active */
344	unsigned char	dp_dum1;
345	unsigned char	dp_dum2;
346	unsigned char	dp_ipl_sct;
347	unsigned char	dp_ipl_head;
348	unsigned short	dp_ipl_cyl;
349	unsigned char	dp_ssect;	/* starting sector */
350	unsigned char	dp_shd;		/* starting head */
351	unsigned short	dp_scyl;	/* starting cylinder */
352	unsigned char	dp_esect;	/* end sector */
353	unsigned char	dp_ehd;		/* end head */
354	unsigned short	dp_ecyl;	/* end cylinder */
355	unsigned char	dp_name[16];
356};
357
358#else /* IBMPC */
359#define DOSBBSECTOR	0	/* DOS boot block relative sector number */
360#define DOSPARTOFF	446
361#define NDOSPART	4
362#define	DOSPTYP_386BSD	0xa5	/* 386BSD partition type */
363
364struct dos_partition {
365	unsigned char	dp_flag;	/* bootstrap flags */
366	unsigned char	dp_shd;		/* starting head */
367	unsigned char	dp_ssect;	/* starting sector */
368	unsigned char	dp_scyl;	/* starting cylinder */
369	unsigned char	dp_typ;		/* partition type */
370	unsigned char	dp_ehd;		/* end head */
371	unsigned char	dp_esect;	/* end sector */
372	unsigned char	dp_ecyl;	/* end cylinder */
373	u_int32_t	dp_start;	/* absolute starting sector number */
374	u_int32_t	dp_size;	/* partition size in sectors */
375};
376#endif
377
378#define DPSECT(s) ((s) & 0x3f)		/* isolate relevant bits of sector */
379#define DPCYL(c, s) ((c) + (((s) & 0xc0)<<2)) /* and those that are cylinder */
380
381/*
382 * Disk-specific ioctls.
383 */
384		/* get and set disklabel; DIOCGPART used internally */
385#define DIOCGDINFO	_IOR('d', 101, struct disklabel)/* get */
386#define DIOCSDINFO	_IOW('d', 102, struct disklabel)/* set */
387#define DIOCWDINFO	_IOW('d', 103, struct disklabel)/* set, update disk */
388#define DIOCGPART	_IOW('d', 104, struct partinfo)	/* get partition */
389
390/* do format operation, read or write */
391#define DIOCRFORMAT	_IOWR('d', 105, struct format_op)
392#define DIOCWFORMAT	_IOWR('d', 106, struct format_op)
393
394#define DIOCSSTEP	_IOW('d', 107, int)	/* set step rate */
395#define DIOCSRETRIES	_IOW('d', 108, int)	/* set # of retries */
396#define DIOCWLABEL	_IOW('d', 109, int)	/* write en/disable label */
397
398#define DIOCSBAD	_IOW('d', 110, struct dkbad)	/* set kernel dkbad */
399#define DIOCSBADSCAN	_IOW('d', 111, int)	/* set badscan mode */
400
401/*
402 * XXX encoding of disk minor numbers, should be elsewhere.
403 *
404 * See <sys/reboot.h> for a possibly better encoding.
405 *
406 * "cpio -H newc" can be used to back up device files with large minor
407 * numbers (but not ones >= 2^31).  Old cpio formats and all tar formats
408 * don't have enough bits, and cpio and tar don't notice the lossage.
409 * There are also some sign extension bugs.
410 */
411
412/*
413       3                   2                   1                   0
414     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
415    _________________________________________________________________
416    | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
417    -----------------------------------------------------------------
418    |    TYPE     |UNIT_2 | SLICE   |  MAJOR?       |  UNIT   |PART |
419    -----------------------------------------------------------------
420*/
421#define	dkmakeminor(unit, slice, part) \
422				(((slice) << 16) | (((unit) & 0x1e0) << 16) | \
423				(((unit) & 0x1f) << 3) | (part))
424#define	dkmodpart(dev, part)	(((dev) & ~(dev_t)7) | (part))
425#define	dkmodslice(dev, slice)	(((dev) & ~(dev_t)0x1f0000) | ((slice) << 16))
426#define	dkpart(dev)		(minor(dev) & 7)
427#define	dkslice(dev)		((minor(dev) >> 16) & 0x1f)
428#define	dktype(dev)       	((minor(dev) >> 25) & 0x7f)
429#define	dkunit(dev)		((((dev) >> 16) & 0x1e0) | (((dev) >> 3) & 0x1f))
430
431#ifdef KERNEL
432
433struct	buf;
434struct	buf_queue_head;
435
436int	bounds_check_with_label __P((struct buf *bp, struct disklabel *lp,
437				     int wlabel));
438void	diskerr __P((struct buf *bp, char *dname, char *what, int pri,
439		     int blkdone, struct disklabel *lp));
440void	disksort __P((struct buf *ap, struct buf *bp));
441u_int	dkcksum __P((struct disklabel *lp));
442char	*readdisklabel __P((dev_t dev, void (*strat)(struct buf *bp),
443			    struct disklabel *lp));
444void	bufqdisksort __P((struct buf_queue_head *ap, struct buf *bp));
445int	setdisklabel __P((struct disklabel *olp, struct disklabel *nlp,
446			  u_long openmask));
447int	writedisklabel __P((dev_t dev, void (*strat)(struct buf *bp),
448			    struct disklabel *lp));
449
450#endif /* KERNEL */
451
452#endif /* LOCORE */
453
454#ifndef KERNEL
455__BEGIN_DECLS
456struct disklabel *getdiskbyname __P((const char *));
457__END_DECLS
458#endif
459
460#endif /* !_SYS_DISKLABEL_H_ */
461