Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sbin / disklabel / disklabel.5
1 .\" Copyright (c) 1987, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Symmetric Computer Systems.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgment:
17 .\"     This product includes software developed by the University of
18 .\"     California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\"     @(#)disklabel.5.5       8.1 (Berkeley) 6/5/93
36 .\" $FreeBSD: src/sbin/disklabel/disklabel.5,v 1.7.2.4 2002/08/21 18:58:16 trhodes Exp $
37 .\"
38 .Dd June 5, 1993
39 .Dt DISKLABEL 5
40 .Os
41 .Sh NAME
42 .Nm disklabel
43 .Nd disk pack label
44 .Sh SYNOPSIS
45 .In sys/disklabel.h
46 .Sh DESCRIPTION
47 Each disk or disk pack on a system may contain a disk label
48 which provides detailed information
49 about the geometry of the disk and the partitions into which the disk
50 is divided.
51 It should be initialized when the disk is formatted,
52 and may be changed later with the
53 .Xr disklabel 8
54 program.
55 This information is used by the system disk driver and by the bootstrap
56 program to determine how to program the drive
57 and where to find the file systems on the disk partitions.
58 Additional information is used by the file system in order
59 to use the disk most efficiently and to locate important file system information.
60 The description of each partition contains an identifier for the partition
61 type (standard file system, swap area, etc.).
62 The file system updates the in-core copy of the label if it contains
63 incomplete information about the file system.
64 .Pp
65 The label is located in sector number
66 .Dv LABELSECTOR
67 of the drive, usually sector 0 where it may be found
68 without any information about the disk geometry.
69 It is at an offset
70 .Dv LABELOFFSET
71 from the beginning of the sector, to allow room for the initial bootstrap.
72 The disk sector containing the label is normally made read-only
73 so that it is not accidentally overwritten by pack-to-pack copies
74 or swap operations;
75 the
76 .Dv DIOCWLABEL
77 .Xr ioctl 2 ,
78 which is done as needed by the
79 .Xr disklabel 8
80 program.
81 .Pp
82 A copy of the in-core label for a disk can be obtained with the
83 .Dv DIOCGDINFO
84 .Xr ioctl 2 ;
85 this works with a file descriptor for a block or character (``raw'') device
86 for any partition of the disk.
87 The in-core copy of the label is set by the
88 .Dv DIOCSDINFO
89 .Xr ioctl 2 .
90 The offset of a partition cannot generally be changed while it is open,
91 nor can it be made smaller while it is open.
92 One exception is that any change is allowed if no label was found
93 on the disk, and the driver was able to construct only a skeletal label
94 without partition information.
95 Finally, the
96 .Dv DIOCWDINFO
97 .Xr ioctl 2
98 operation sets the in-core label and then updates the on-disk label;
99 there must be an existing label on the disk for this operation to succeed.
100 Thus, the initial label for a disk or disk pack must be installed
101 by writing to the raw disk.
102 All of these operations are normally done using
103 .Xr disklabel 8 .
104 .Pp
105 The format of the disk label, as specified in
106 .Pa <sys/disklabel.h> ,
107 is
108 .Bd -literal
109 #ifndef _SYS_DISKLABEL_H_
110 #define _SYS_DISKLABEL_H_
111
112 #ifndef _KERNEL
113 #include <sys/types.h>
114 #endif
115 #include <sys/ioccom.h>
116
117 /*
118  * Disk description table, see disktab(5)
119  */
120 #define _PATH_DISKTAB   "/etc/disktab"
121 #define DISKTAB         "/etc/disktab"          /* deprecated */
122
123 /*
124  * Each disk has a label which includes information about the hardware
125  * disk geometry, filesystem partitions, and drive specific information.
126  * The label is in block 0 or 1, possibly offset from the beginning
127  * to leave room for a bootstrap, etc.
128  */
129
130 /* XXX these should be defined per controller (or drive) elsewhere, not here! */
131 #ifdef __i386__
132 #define LABELSECTOR     1                       /* sector containing label */
133 #define LABELOFFSET     0                       /* offset of label in sector */
134 #endif
135
136 #ifdef __alpha__
137 #define LABELSECTOR     0
138 #define LABELOFFSET     64
139 #endif
140
141 #ifndef LABELSECTOR
142 #define LABELSECTOR     0                       /* sector containing label */
143 #endif
144
145 #ifndef LABELOFFSET
146 #define LABELOFFSET     64                      /* offset of label in sector */
147 #endif
148
149 #define DISKMAGIC       ((u_int32_t)0x82564557) /* The disk magic number */
150 #ifndef MAXPARTITIONS
151 #define MAXPARTITIONS   8
152 #endif
153
154 #define LABEL_PART      2               /* partition containing label */
155 #define RAW_PART        2               /* partition containing whole disk */
156 #define SWAP_PART       1               /* partition normally containing swap */
157
158 #ifndef LOCORE
159 struct disklabel {
160         u_int32_t d_magic;              /* the magic number */
161         u_int16_t d_type;               /* drive type */
162         u_int16_t d_subtype;            /* controller/d_type specific */
163         char      d_typename[16];       /* type name, e.g. "eagle" */
164
165         /*
166          * d_packname contains the pack identifier and is returned when
167          * the disklabel is read off the disk or in-core copy.
168          * d_boot0 and d_boot1 are the (optional) names of the
169          * primary (block 0) and secondary (block 1-15) bootstraps
170          * as found in /boot.  These are returned when using
171          * getdiskbyname(3) to retrieve the values from /etc/disktab.
172          */
173         union {
174                 char    un_d_packname[16];      /* pack identifier */
175                 struct {
176                         char *un_d_boot0;       /* primary bootstrap name */
177                         char *un_d_boot1;       /* secondary bootstrap name */
178                 } un_b;
179         } d_un;
180 #define d_packname      d_un.un_d_packname
181 #define d_boot0         d_un.un_b.un_d_boot0
182 #define d_boot1         d_un.un_b.un_d_boot1
183
184                         /* disk geometry: */
185         u_int32_t d_secsize;            /* # of bytes per sector */
186         u_int32_t d_nsectors;           /* # of data sectors per track */
187         u_int32_t d_ntracks;            /* # of tracks per cylinder */
188         u_int32_t d_ncylinders;         /* # of data cylinders per unit */
189         u_int32_t d_secpercyl;          /* # of data sectors per cylinder */
190         u_int32_t d_secperunit;         /* # of data sectors per unit */
191
192         /*
193          * Spares (bad sector replacements) below are not counted in
194          * d_nsectors or d_secpercyl.  Spare sectors are assumed to
195          * be physical sectors which occupy space at the end of each
196          * track and/or cylinder.
197          */
198         u_int16_t d_sparespertrack;     /* # of spare sectors per track */
199         u_int16_t d_sparespercyl;       /* # of spare sectors per cylinder */
200         /*
201          * Alternate cylinders include maintenance, replacement, configuration
202          * description areas, etc.
203          */
204         u_int32_t d_acylinders;         /* # of alt. cylinders per unit */
205
206                         /* hardware characteristics: */
207         /*
208          * d_interleave, d_trackskew and d_cylskew describe perturbations
209          * in the media format used to compensate for a slow controller.
210          * Interleave is physical sector interleave, set up by the
211          * formatter or controller when formatting.  When interleaving is
212          * in use, logically adjacent sectors are not physically
213          * contiguous, but instead are separated by some number of
214          * sectors.  It is specified as the ratio of physical sectors
215          * traversed per logical sector.  Thus an interleave of 1:1
216          * implies contiguous layout, while 2:1 implies that logical
217          * sector 0 is separated by one sector from logical sector 1.
218          * d_trackskew is the offset of sector 0 on track N relative to
219          * sector 0 on track N-1 on the same cylinder.  Finally, d_cylskew
220          * is the offset of sector 0 on cylinder N relative to sector 0
221          * on cylinder N-1.
222          */
223         u_int16_t d_rpm;                /* rotational speed */
224         u_int16_t d_interleave;         /* hardware sector interleave */
225         u_int16_t d_trackskew;          /* sector 0 skew, per track */
226         u_int16_t d_cylskew;            /* sector 0 skew, per cylinder */
227         u_int32_t d_headswitch;         /* head switch time, usec */
228         u_int32_t d_trkseek;            /* track-to-track seek, usec */
229         u_int32_t d_flags;              /* generic flags */
230 #define NDDATA 5
231         u_int32_t d_drivedata[NDDATA];  /* drive-type specific information */
232 #define NSPARE 5
233         u_int32_t d_spare[NSPARE];      /* reserved for future use */
234         u_int32_t d_magic2;             /* the magic number (again) */
235         u_int16_t d_checksum;           /* xor of data incl. partitions */
236
237                         /* filesystem and partition information: */
238         u_int16_t d_npartitions;        /* number of partitions in following */
239         u_int32_t d_bbsize;             /* size of boot area at sn0, bytes */
240         u_int32_t d_sbsize;             /* max size of fs superblock, bytes */
241         struct  partition {             /* the partition table */
242                 u_int32_t p_size;       /* number of sectors in partition */
243                 u_int32_t p_offset;     /* starting sector */
244                 u_int32_t p_fsize;      /* filesystem basic fragment size */
245                 u_int8_t p_fstype;      /* filesystem type, see below */
246                 u_int8_t p_frag;        /* filesystem fragments per block */
247                 union {
248                         u_int16_t cpg;  /* UFS: FS cylinders per group */
249                         u_int16_t sgs;  /* LFS: FS segment shift */
250                 } __partition_u1;
251 #define p_cpg   __partition_u1.cpg
252 #define p_sgs   __partition_u1.sgs
253         } d_partitions[MAXPARTITIONS];  /* actually may be more */
254 };
255 #else /* LOCORE */
256         /*
257          * offsets for asm boot files.
258          */
259         .set    d_secsize,40
260         .set    d_nsectors,44
261         .set    d_ntracks,48
262         .set    d_ncylinders,52
263         .set    d_secpercyl,56
264         .set    d_secperunit,60
265         .set    d_end_,276              /* size of disk label */
266 #endif /* LOCORE */
267
268 /* d_type values: */
269 #define DTYPE_SMD               1               /* SMD, XSMD; VAX hp/up */
270 #define DTYPE_MSCP              2               /* MSCP */
271 #define DTYPE_DEC               3               /* other DEC (rk, rl) */
272 #define DTYPE_SCSI              4               /* SCSI */
273 #define DTYPE_ESDI              5               /* ESDI interface */
274 #define DTYPE_ST506             6               /* ST506 etc. */
275 #define DTYPE_HPIB              7               /* CS/80 on HP-IB */
276 #define DTYPE_HPFL              8               /* HP Fiber-link */
277 #define DTYPE_FLOPPY            10              /* floppy */
278 #define DTYPE_CCD               11              /* concatenated disk */
279 #define DTYPE_VINUM             12              /* vinum volume */
280 #define DTYPE_DOC2K             13              /* Msys DiskOnChip */
281
282 #if defined(PC98) && !defined(PC98_ATCOMPAT)
283 #define DSTYPE_SEC256           0x80            /* physical sector size=256 */
284 #endif
285
286 #ifdef DKTYPENAMES
287 static char *dktypenames[] = {
288         "unknown",
289         "SMD",
290         "MSCP",
291         "old DEC",
292         "SCSI",
293         "ESDI",
294         "ST506",
295         "HP-IB",
296         "HP-FL",
297         "type 9",
298         "floppy",
299         "CCD",
300         "Vinum",
301         "DOC2K",
302         NULL
303 };
304 #define DKMAXTYPES      (sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
305 #endif
306
307 /*
308  * Filesystem type and version.
309  * Used to interpret other filesystem-specific
310  * per-partition information.
311  */
312 #define FS_UNUSED       0               /* unused */
313 #define FS_SWAP         1               /* swap */
314 #define FS_V6           2               /* Sixth Edition */
315 #define FS_V7           3               /* Seventh Edition */
316 #define FS_SYSV         4               /* System V */
317 #define FS_V71K         5               /* V7 with 1K blocks (4.1, 2.9) */
318 #define FS_V8           6               /* Eighth Edition, 4K blocks */
319 #define FS_BSDFFS       7               /* 4.2BSD fast file system */
320 #define FS_MSDOS        8               /* MSDOS file system */
321 #define FS_BSDLFS       9               /* 4.4BSD log-structured file system */
322 #define FS_OTHER        10              /* in use, but unknown/unsupported */
323 #define FS_HPFS         11              /* OS/2 high-performance file system */
324 #define FS_ISO9660      12              /* ISO 9660, normally CD-ROM */
325 #define FS_BOOT         13              /* partition contains bootstrap */
326 #define FS_VINUM        14              /* Vinum drive */
327
328 #ifdef  DKTYPENAMES
329 static char *fstypenames[] = {
330         "unused",
331         "swap",
332         "Version 6",
333         "Version 7",
334         "System V",
335         "4.1BSD",
336         "Eighth Edition",
337         "4.2BSD",
338         "MSDOS",
339         "4.4LFS",
340         "unknown",
341         "HPFS",
342         "ISO9660",
343         "boot",
344         "vinum",
345         NULL
346 };
347 #define FSMAXTYPES      (sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
348 #endif
349
350 /*
351  * flags shared by various drives:
352  */
353 #define         D_REMOVABLE     0x01            /* removable media */
354 #define         D_ECC           0x02            /* supports ECC */
355 #define         D_BADSECT       0x04            /* supports bad sector forw. */
356 #define         D_RAMDISK       0x08            /* disk emulator */
357 #define         D_CHAIN         0x10            /* can do back-back transfers */
358
359 /*
360  * Drive data for SMD.
361  */
362 #define d_smdflags      d_drivedata[0]
363 #define         D_SSE           0x1             /* supports skip sectoring */
364 #define d_mindist       d_drivedata[1]
365 #define d_maxdist       d_drivedata[2]
366 #define d_sdist         d_drivedata[3]
367
368 /*
369  * Drive data for ST506.
370  */
371 #define d_precompcyl    d_drivedata[0]
372 #define d_gap3          d_drivedata[1]          /* used only when formatting */
373
374 /*
375  * Drive data for SCSI.
376  */
377 #define d_blind         d_drivedata[0]
378
379 #ifndef LOCORE
380 /*
381  * Structure used to perform a format or other raw operation, returning
382  * data and/or register values.  Register identification and format
383  * are device- and driver-dependent.
384  */
385 struct format_op {
386         char    *df_buf;
387         int      df_count;              /* value-result */
388         daddr_t  df_startblk;
389         int      df_reg[8];             /* result */
390 };
391
392 /*
393  * Structure used internally to retrieve information about a partition
394  * on a disk.
395  */
396 struct partinfo {
397         struct disklabel *disklab;
398         struct partition *part;
399 };
400
401 /* DOS partition table -- located in boot block */
402
403 #if defined(PC98) && !defined(PC98_ATCOMPAT)
404 #define DOSBBSECTOR     0       /* DOS boot block relative sector number */
405 #define DOSLABELSECTOR  1       /* 0: 256b/s, 1: 512b/s */
406 #define DOSPARTOFF      0
407 #define NDOSPART        16
408 #define DOSPTYP_386BSD  0x94    /* 386BSD partition type */
409 #define MBR_PTYPE_FreeBSD 0x94  /* FreeBSD partition type */
410
411 struct dos_partition {
412         unsigned char   dp_mid;
413 #define DOSMID_386BSD           (0x14|0x80) /* 386bsd|bootable */
414         unsigned char   dp_sid;
415 #define DOSSID_386BSD           (0x44|0x80) /* 386bsd|active */
416         unsigned char   dp_dum1;
417         unsigned char   dp_dum2;
418         unsigned char   dp_ipl_sct;
419         unsigned char   dp_ipl_head;
420         unsigned short  dp_ipl_cyl;
421         unsigned char   dp_ssect;       /* starting sector */
422         unsigned char   dp_shd;         /* starting head */
423         unsigned short  dp_scyl;        /* starting cylinder */
424         unsigned char   dp_esect;       /* end sector */
425         unsigned char   dp_ehd;         /* end head */
426         unsigned short  dp_ecyl;        /* end cylinder */
427         unsigned char   dp_name[16];
428 };
429
430 #else /* IBMPC */
431 #define DOSBBSECTOR     0       /* DOS boot block relative sector number */
432 #define DOSPARTOFF      446
433 #define NDOSPART        4
434 #define DOSPTYP_386BSD  0xa5    /* 386BSD partition type */
435
436 struct dos_partition {
437         unsigned char   dp_flag;        /* bootstrap flags */
438         unsigned char   dp_shd;         /* starting head */
439         unsigned char   dp_ssect;       /* starting sector */
440         unsigned char   dp_scyl;        /* starting cylinder */
441         unsigned char   dp_typ;         /* partition type */
442         unsigned char   dp_ehd;         /* end head */
443         unsigned char   dp_esect;       /* end sector */
444         unsigned char   dp_ecyl;        /* end cylinder */
445         u_int32_t       dp_start;       /* absolute starting sector number */
446         u_int32_t       dp_size;        /* partition size in sectors */
447 };
448 #endif
449
450 #define DPSECT(s) ((s) & 0x3f)          /* isolate relevant bits of sector */
451 #define DPCYL(c, s) ((c) + (((s) & 0xc0)<<2)) /* and those that are cylinder */
452
453 /*
454  * Disk-specific ioctls.
455  */
456                 /* get and set disklabel; DIOCGPART used internally */
457 #define DIOCGDINFO      _IOR('d', 101, struct disklabel)/* get */
458 #define DIOCSDINFO      _IOW('d', 102, struct disklabel)/* set */
459 #define DIOCWDINFO      _IOW('d', 103, struct disklabel)/* set, update disk */
460 #define DIOCGPART       _IOW('d', 104, struct partinfo) /* get partition */
461
462 #define DIOCWLABEL      _IOW('d', 109, int)     /* write en/disable label */
463
464 #ifdef _KERNEL
465
466 /*
467  * XXX encoding of disk minor numbers, should be elsewhere.
468  *
469  * See <sys/reboot.h> for a possibly better encoding.
470  *
471  * "cpio -H newc" can be used to back up device files with large minor
472  * numbers (but not ones >= 2^31).  Old cpio formats and all tar formats
473  * don't have enough bits, and cpio and tar don't notice the lossage.
474  * There are also some sign extension bugs.
475  */
476
477 /*
478        3                   2                   1                   0
479      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
480     _________________________________________________________________
481     | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
482     -----------------------------------------------------------------
483     |    TYPE     |UNIT_2 | SLICE   |  MAJOR?       |  UNIT   |PART |
484     -----------------------------------------------------------------
485 */
486 #define dkmakeminor(unit, slice, part) \e
487         (((slice) << 16) | (((unit) & 0x1e0) << 16) | \e
488         (((unit) & 0x1f) << 3) | (part))
489 static __inline dev_t
490 dkmodpart(dev_t dev, int part)
491 {
492         return (makedev(major(dev), (minor(dev) & ~7) | part));
493 }
494
495 static __inline dev_t
496 dkmodslice(dev_t dev, int slice)
497 {
498         return (makedev(major(dev), (minor(dev) & ~0x1f0000) | (slice << 16)));
499 }
500
501 #define dkpart(dev)             (minor(dev) & 7)
502 #define dkslice(dev)            ((minor(dev) >> 16) & 0x1f)
503 #define dktype(dev)             ((minor(dev) >> 25) & 0x7f)
504
505 static __inline u_int
506 dkunit(dev_t dev)
507 {
508         return (((minor(dev) >> 16) & 0x1e0) | ((minor(dev) >> 3) & 0x1f));
509 }
510
511 struct  buf;
512 struct  buf_queue_head;
513
514 int     bounds_check_with_label __P((struct buf *bp, struct disklabel *lp,
515                                      int wlabel));
516 void    diskerr __P((struct buf *bp, char *what, int pri, int blkdone,
517                      struct disklabel *lp));
518 void    disksort __P((struct buf *ap, struct buf *bp));
519 u_int   dkcksum __P((struct disklabel *lp));
520 char    *readdisklabel __P((dev_t dev, struct disklabel *lp));
521 void    bufqdisksort __P((struct buf_queue_head *ap, struct buf *bp));
522 int     setdisklabel __P((struct disklabel *olp, struct disklabel *nlp,
523                           u_long openmask));
524 int     writedisklabel __P((dev_t dev, struct disklabel *lp));
525 #ifdef __alpha__
526 void    alpha_fix_srm_checksum __P((struct buf *bp));
527 #endif
528
529 #endif /* _KERNEL */
530
531 #endif /* LOCORE */
532
533 #ifndef _KERNEL
534 __BEGIN_DECLS
535 struct disklabel *getdiskbyname __P((const char *));
536 __END_DECLS
537 #endif
538
539 #endif /* !_SYS_DISKLABEL_H_ */
540 .Ed
541 .Sh SEE ALSO
542 .Xr disktab 5 ,
543 .Xr disklabel 8