disklabel.h revision 12478
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.1 (Berkeley) 6/2/93
34 * $Id: disklabel.h,v 1.18 1995/11/24 14:50:39 bde Exp $
35 */
36
37#ifndef _SYS_DISKLABEL_H_
38#define	_SYS_DISKLABEL_H_
39
40/*
41 * Disk description table, see disktab(5)
42 */
43#define	_PATH_DISKTAB	"/etc/disktab"
44#define	DISKTAB		"/etc/disktab"		/* deprecated */
45
46/*
47 * Each disk has a label which includes information about the hardware
48 * disk geometry, filesystem partitions, and drive specific information.
49 * The label is in block 0 or 1, possibly offset from the beginning
50 * to leave room for a bootstrap, etc.
51 */
52
53/* XXX these should be defined per controller (or drive) elsewhere, not here! */
54#ifdef __i386__
55#define LABELSECTOR	1			/* sector containing label */
56#define LABELOFFSET	0			/* offset of label in sector */
57#endif
58
59#ifndef	LABELSECTOR
60#define LABELSECTOR	0			/* sector containing label */
61#endif
62
63#ifndef	LABELOFFSET
64#define LABELOFFSET	64			/* offset of label in sector */
65#endif
66
67#define DISKMAGIC	((u_long) 0x82564557)	/* The disk magic number */
68#ifndef MAXPARTITIONS
69#define	MAXPARTITIONS	8
70#endif
71
72#define	LABEL_PART	2		/* partition containing label */
73#define	RAW_PART	2		/* partition containing whole disk */
74#define	SWAP_PART	1		/* partition normally containing swap */
75
76#ifndef LOCORE
77struct disklabel {
78	u_long	d_magic;		/* the magic number */
79	short	d_type;			/* drive type */
80	short	d_subtype;		/* controller/d_type specific */
81	char	d_typename[16];		/* type name, e.g. "eagle" */
82	/*
83	 * d_packname contains the pack identifier and is returned when
84	 * the disklabel is read off the disk or in-core copy.
85	 * d_boot0 and d_boot1 are the (optional) names of the
86	 * primary (block 0) and secondary (block 1-15) bootstraps
87	 * as found in /usr/mdec.  These are returned when using
88	 * getdiskbyname(3) to retrieve the values from /etc/disktab.
89	 */
90#if defined(KERNEL) || defined(STANDALONE)
91	char	d_packname[16];			/* pack identifier */
92#else
93	union {
94		char	un_d_packname[16];	/* pack identifier */
95		struct {
96			char *un_d_boot0;	/* primary bootstrap name */
97			char *un_d_boot1;	/* secondary bootstrap name */
98		} un_b;
99	} d_un;
100#define d_packname	d_un.un_d_packname
101#define d_boot0		d_un.un_b.un_d_boot0
102#define d_boot1		d_un.un_b.un_d_boot1
103#endif	/* ! KERNEL or STANDALONE */
104			/* disk geometry: */
105	u_long	d_secsize;		/* # of bytes per sector */
106	u_long	d_nsectors;		/* # of data sectors per track */
107	u_long	d_ntracks;		/* # of tracks per cylinder */
108	u_long	d_ncylinders;		/* # of data cylinders per unit */
109	u_long	d_secpercyl;		/* # of data sectors per cylinder */
110	u_long	d_secperunit;		/* # of data sectors per unit */
111	/*
112	 * Spares (bad sector replacements) below
113	 * are not counted in d_nsectors or d_secpercyl.
114	 * Spare sectors are assumed to be physical sectors
115	 * which occupy space at the end of each track and/or cylinder.
116	 */
117	u_short	d_sparespertrack;	/* # of spare sectors per track */
118	u_short	d_sparespercyl;		/* # of spare sectors per cylinder */
119	/*
120	 * Alternate cylinders include maintenance, replacement,
121	 * configuration description areas, etc.
122	 */
123	u_long	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 formatter
130	 * or controller when formatting.  When interleaving is in use,
131	 * logically adjacent sectors are not physically contiguous,
132	 * but instead are separated by some number of sectors.
133	 * It is specified as the ratio of physical sectors traversed
134	 * per logical sector.  Thus an interleave of 1:1 implies contiguous
135	 * layout, while 2:1 implies that logical sector 0 is separated
136	 * by one sector from logical sector 1.
137	 * d_trackskew is the offset of sector 0 on track N
138	 * relative to sector 0 on track N-1 on the same cylinder.
139	 * Finally, d_cylskew is the offset of sector 0 on cylinder N
140	 * relative to sector 0 on cylinder N-1.
141	 */
142	u_short	d_rpm;			/* rotational speed */
143	u_short	d_interleave;		/* hardware sector interleave */
144	u_short	d_trackskew;		/* sector 0 skew, per track */
145	u_short	d_cylskew;		/* sector 0 skew, per cylinder */
146	u_long	d_headswitch;		/* head switch time, usec */
147	u_long	d_trkseek;		/* track-to-track seek, usec */
148	u_long	d_flags;		/* generic flags */
149#define NDDATA 5
150	u_long	d_drivedata[NDDATA];	/* drive-type specific information */
151#define NSPARE 5
152	u_long	d_spare[NSPARE];	/* reserved for future use */
153	u_long	d_magic2;		/* the magic number (again) */
154	u_short	d_checksum;		/* xor of data incl. partitions */
155
156			/* filesystem and partition information: */
157	u_short	d_npartitions;		/* number of partitions in following */
158	u_long	d_bbsize;		/* size of boot area at sn0, bytes */
159	u_long	d_sbsize;		/* max size of fs superblock, bytes */
160	struct	partition {		/* the partition table */
161		u_long	p_size;		/* number of sectors in partition */
162		u_long	p_offset;	/* starting sector */
163		u_long	p_fsize;	/* filesystem basic fragment size */
164		u_char	p_fstype;	/* filesystem type, see below */
165		u_char	p_frag;		/* filesystem fragments per block */
166		union {
167			u_short	cpg;	/* UFS: FS cylinders per group */
168			u_short	sgs;	/* LFS: FS segment shift */
169		} __partition_u1;
170#define	p_cpg	__partition_u1.cpg
171#define	p_sgs	__partition_u1.sgs
172	} d_partitions[MAXPARTITIONS];	/* actually may be more */
173};
174#else /* LOCORE */
175	/*
176	 * offsets for asm boot files.
177	 */
178	.set	d_secsize,40
179	.set	d_nsectors,44
180	.set	d_ntracks,48
181	.set	d_ncylinders,52
182	.set	d_secpercyl,56
183	.set	d_secperunit,60
184	.set	d_end_,276		/* size of disk label */
185#endif /* LOCORE */
186
187/* d_type values: */
188#define	DTYPE_SMD		1		/* SMD, XSMD; VAX hp/up */
189#define	DTYPE_MSCP		2		/* MSCP */
190#define	DTYPE_DEC		3		/* other DEC (rk, rl) */
191#define	DTYPE_SCSI		4		/* SCSI */
192#define	DTYPE_ESDI		5		/* ESDI interface */
193#define	DTYPE_ST506		6		/* ST506 etc. */
194#define	DTYPE_HPIB		7		/* CS/80 on HP-IB */
195#define	DTYPE_HPFL		8		/* HP Fiber-link */
196#define	DTYPE_FLOPPY		10		/* floppy */
197
198#ifdef DKTYPENAMES
199static char *dktypenames[] = {
200	"unknown",
201	"SMD",
202	"MSCP",
203	"old DEC",
204	"SCSI",
205	"ESDI",
206	"ST506",
207	"HP-IB",
208	"HP-FL",
209	"type 9",
210	"floppy",
211	0
212};
213#define DKMAXTYPES	(sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
214#endif
215
216/*
217 * Filesystem type and version.
218 * Used to interpret other filesystem-specific
219 * per-partition information.
220 */
221#define	FS_UNUSED	0		/* unused */
222#define	FS_SWAP		1		/* swap */
223#define	FS_V6		2		/* Sixth Edition */
224#define	FS_V7		3		/* Seventh Edition */
225#define	FS_SYSV		4		/* System V */
226#define	FS_V71K		5		/* V7 with 1K blocks (4.1, 2.9) */
227#define	FS_V8		6		/* Eighth Edition, 4K blocks */
228#define	FS_BSDFFS	7		/* 4.2BSD fast file system */
229#define	FS_MSDOS	8		/* MSDOS file system */
230#define	FS_BSDLFS	9		/* 4.4BSD log-structured file system */
231#define	FS_OTHER	10		/* in use, but unknown/unsupported */
232#define	FS_HPFS		11		/* OS/2 high-performance file system */
233#define	FS_ISO9660	12		/* ISO 9660, normally CD-ROM */
234#define	FS_BOOT		13		/* partition contains bootstrap */
235
236#ifdef	DKTYPENAMES
237static char *fstypenames[] = {
238	"unused",
239	"swap",
240	"Version 6",
241	"Version 7",
242	"System V",
243	"4.1BSD",
244	"Eighth Edition",
245	"4.2BSD",
246	"MSDOS",
247	"4.4LFS",
248	"unknown",
249	"HPFS",
250	"ISO9660",
251	"boot",
252	0
253};
254#define FSMAXTYPES	(sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
255#endif
256
257/*
258 * flags shared by various drives:
259 */
260#define		D_REMOVABLE	0x01		/* removable media */
261#define		D_ECC		0x02		/* supports ECC */
262#define		D_BADSECT	0x04		/* supports bad sector forw. */
263#define		D_RAMDISK	0x08		/* disk emulator */
264#define		D_CHAIN		0x10		/* can do back-back transfers */
265
266/*
267 * Drive data for SMD.
268 */
269#define	d_smdflags	d_drivedata[0]
270#define		D_SSE		0x1		/* supports skip sectoring */
271#define	d_mindist	d_drivedata[1]
272#define	d_maxdist	d_drivedata[2]
273#define	d_sdist		d_drivedata[3]
274
275/*
276 * Drive data for ST506.
277 */
278#define d_precompcyl	d_drivedata[0]
279#define d_gap3		d_drivedata[1]		/* used only when formatting */
280
281/*
282 * Drive data for SCSI.
283 */
284#define	d_blind		d_drivedata[0]
285
286#ifndef LOCORE
287/*
288 * Structure used to perform a format
289 * or other raw operation, returning data
290 * and/or register values.
291 * Register identification and format
292 * are device- and driver-dependent.
293 */
294struct format_op {
295	char	*df_buf;
296	int	df_count;		/* value-result */
297	daddr_t	df_startblk;
298	int	df_reg[8];		/* result */
299};
300
301/*
302 * Structure used internally to retrieve
303 * information about a partition on a disk.
304 */
305struct partinfo {
306	struct disklabel *disklab;
307	struct partition *part;
308};
309
310/* DOS partition table -- located in boot block */
311
312#define DOSBBSECTOR	0	/* DOS boot block relative sector number */
313#define DOSPARTOFF	446
314#define NDOSPART	4
315#define	DOSPTYP_386BSD	0xa5	/* 386BSD partition type */
316
317struct dos_partition {
318	unsigned char	dp_flag;	/* bootstrap flags */
319	unsigned char	dp_shd;		/* starting head */
320	unsigned char	dp_ssect;	/* starting sector */
321	unsigned char	dp_scyl;	/* starting cylinder */
322	unsigned char	dp_typ;		/* partition type */
323	unsigned char	dp_ehd;		/* end head */
324	unsigned char	dp_esect;	/* end sector */
325	unsigned char	dp_ecyl;	/* end cylinder */
326	unsigned long	dp_start;	/* absolute starting sector number */
327	unsigned long	dp_size;	/* partition size in sectors */
328};
329
330#define DPSECT(s) ((s) & 0x3f)		/* isolate relevant bits of sector */
331#define DPCYL(c, s) ((c) + (((s) & 0xc0)<<2)) /* and those that are cylinder */
332
333/*
334 * Disk-specific ioctls.
335 */
336		/* get and set disklabel; DIOCGPART used internally */
337#define DIOCGDINFO	_IOR('d', 101, struct disklabel)/* get */
338#define DIOCSDINFO	_IOW('d', 102, struct disklabel)/* set */
339#define DIOCWDINFO	_IOW('d', 103, struct disklabel)/* set, update disk */
340#define DIOCGPART	_IOW('d', 104, struct partinfo)	/* get partition */
341
342/* do format operation, read or write */
343#define DIOCRFORMAT	_IOWR('d', 105, struct format_op)
344#define DIOCWFORMAT	_IOWR('d', 106, struct format_op)
345
346#define DIOCSSTEP	_IOW('d', 107, int)	/* set step rate */
347#define DIOCSRETRIES	_IOW('d', 108, int)	/* set # of retries */
348#define DIOCWLABEL	_IOW('d', 109, int)	/* write en/disable label */
349
350#define DIOCSBAD	_IOW('d', 110, struct dkbad)	/* set kernel dkbad */
351#define DIOCSBADSCAN	_IOW('d', 111, int)	/* set badscan mode */
352
353/*
354 * XXX encoding of disk minor numbers, should be elsewhere.
355 *
356 * See <sys/reboot.h> for a possibly better encoding.
357 *
358 * "cpio -H newc" can be used to back up device files with large minor
359 * numbers (but not ones >= 2^31).  Old cpio formats and all tar formats
360 * don't have enough bits, and cpio and tar don't notice the lossage.
361 * There are also some sign extension bugs.
362 */
363
364/*
365       3                   2                   1                   0
366     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
367    _________________________________________________________________
368    | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
369    -----------------------------------------------------------------
370    |      TYPE           | SLICE   |  MAJOR?       |  UNIT   |PART |
371    -----------------------------------------------------------------
372    |      TYPE     |PART2| SLICE   |  MAJOR?       |  UNIT   |PART | <-soon
373    -----------------------------------------------------------------
374
375	I want 3 more part bits (taken from 'TYPE' (useless as it is) (JRE)
376*/
377#define	dkmakeminor(unit, slice, part) \
378				(((slice) << 16) | ((unit) << 3) | (part))
379#define	dkmodpart(dev, part)	(((dev) & ~(dev_t)7) | (part))
380#define	dkmodslice(dev, slice)	(((dev) & ~(dev_t)0x1f0000) | ((slice) << 16))
381#define	dkpart(dev)		(minor(dev) & 7)
382#define	dkslice(dev)		((minor(dev) >> 16) & 0x1f)
383#define	dktype(dev)       	((minor(dev) >> 21) & 0x7ff)
384#define	dkunit(dev)		((minor(dev) >> 3) & 0x1f)
385
386#ifdef KERNEL
387/*
388 * We're not ready to use <sys/disk.h>.
389 */
390#include <sys/conf.h>
391
392struct	buf_queue_head;
393
394int	bounds_check_with_label __P((struct buf *bp, struct disklabel *lp,
395				     int wlabel));
396void	diskerr __P((struct buf *bp, char *dname, char *what, int pri,
397		     int blkdone, struct disklabel *lp));
398void	disksort __P((struct buf *ap, struct buf *bp));
399u_int	dkcksum __P((struct disklabel *lp));
400char	*readdisklabel __P((dev_t dev, d_strategy_t *strat,
401			    struct disklabel *lp));
402void	tqdisksort __P((struct buf_queue_head *ap, struct buf *bp));
403int	setdisklabel __P((struct disklabel *olp, struct disklabel *nlp,
404			  u_long openmask));
405int	writedisklabel __P((dev_t dev, d_strategy_t *strat,
406			    struct disklabel *lp));
407
408#endif /* KERNEL */
409
410#endif /* LOCORE */
411
412#if !defined(KERNEL) && !defined(LOCORE)
413
414#include <sys/cdefs.h>
415
416__BEGIN_DECLS
417struct disklabel *getdiskbyname __P((const char *));
418__END_DECLS
419
420#endif
421
422#endif /* !_SYS_DISKLABEL_H_ */
423