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