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