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