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