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