578 lines
16 KiB
Groff
578 lines
16 KiB
Groff
.\" Copyright (c) 1987, 1988, 1991, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to Berkeley by
|
|
.\" Symmetric Computer Systems.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgment:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)disklabel.8 8.2 (Berkeley) 4/19/94
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd July 30, 1999
|
|
.Dt DISKLABEL 8
|
|
.Os FreeBSD
|
|
.Sh NAME
|
|
.Nm disklabel
|
|
.Nd read and write disk pack label
|
|
.Sh SYNOPSIS
|
|
.Nm disklabel
|
|
.Op Fl r
|
|
.Ar disk
|
|
.Nm disklabel
|
|
.Fl w
|
|
.Op Fl r
|
|
.Ar disk Ar disktype
|
|
.Oo Ar packid Oc
|
|
.Nm disklabel
|
|
.Fl e
|
|
.Op Fl r
|
|
.Ar disk
|
|
.Nm disklabel
|
|
.Fl R
|
|
.Op Fl r
|
|
.Ar disk Ar protofile
|
|
.Nm disklabel
|
|
.Op Fl NW
|
|
.Ar disk
|
|
.sp
|
|
.Nm disklabel
|
|
.Fl B
|
|
.Oo
|
|
.Fl b Ar boot1
|
|
.Fl s Ar boot2
|
|
.Oc
|
|
.Ar disk
|
|
.Oo Ar disktype Oc
|
|
.Nm disklabel
|
|
.Fl w
|
|
.Fl B
|
|
.Oo
|
|
.Fl b Ar boot1
|
|
.Fl s Ar boot2
|
|
.Oc
|
|
.Ar disk Ar disktype
|
|
.Oo Ar packid Oc
|
|
.Nm disklabel
|
|
.Fl R
|
|
.Fl B
|
|
.Oo
|
|
.Fl b Ar boot1
|
|
.Fl s Ar boot2
|
|
.Oc
|
|
.Ar disk Ar protofile
|
|
.Oo Ar disktype Oc
|
|
.Sh DESCRIPTION
|
|
.Nm Disklabel
|
|
installs, examines or modifes the label on a disk drive or pack. When writing
|
|
the label, it can be used to change the drive identification, the disk
|
|
partitions on the drive, or to replace a damaged label. There are several forms
|
|
of the command that read (display), install or edit the label on a disk. In
|
|
addition,
|
|
.Nm
|
|
can install bootstrap code.
|
|
.Ss Raw or in-core label
|
|
.Pp
|
|
The disk label is resident close to or at the beginning of each disk partition.
|
|
For faster access, the kernel maintains a copy in core at all times. By
|
|
default, most
|
|
.Nm
|
|
access the in-core copy of the label. To access the raw (on-disk) copy, use the
|
|
.Fl r
|
|
option. This option allows a label to be installed on a disk without kernel
|
|
support for a label, such as when labels are first installed on a system; it
|
|
must be used when first installing a label on a disk. The specific effect of
|
|
.Fl r
|
|
is described under each command.
|
|
.Pp
|
|
.Ss Disk device name
|
|
.Pp
|
|
All
|
|
.Nm disklabel
|
|
forms require a disk device name, which should always be the raw
|
|
.if t ``complete'' (or ``c'')
|
|
.if n "complete" (or "c")
|
|
partition, for example
|
|
.Pa /dev/da0c .
|
|
.Nm
|
|
understands the abbreviation
|
|
.Pa da0 ,
|
|
which it converts internally to
|
|
.Pa /dev/da0c .
|
|
.Ss Reading the disk label
|
|
.Pp
|
|
To examine or save the label on a disk drive, use
|
|
.Nm
|
|
without options:
|
|
.Pp
|
|
.Nm disklabel
|
|
.Op Fl r
|
|
.Ar disk
|
|
.Pp
|
|
.Ar disk
|
|
represents the raw disk in question, and may be in the form
|
|
.Pa da0
|
|
or
|
|
.Pa /dev/da0c .
|
|
It will display all of the parameters associated with the drive and its
|
|
partition layout. Unless the
|
|
.Fl r
|
|
flag is given,
|
|
the kernel's in-core copy of the label is displayed;
|
|
if the disk has no label, or the partition types on the disk are incorrect,
|
|
the kernel may have constructed or modified the label.
|
|
If the
|
|
.Fl r
|
|
flag is given,
|
|
.Nm
|
|
reads the label from the raw disk and displays it.
|
|
.Ss Writing a standard label
|
|
.Pp
|
|
To write a standard label, use the form
|
|
.Pp
|
|
.Nm disklabel
|
|
.Fl w
|
|
.Op Fl r
|
|
.Ar disk Ar disktype
|
|
.Oo Ar packid Oc
|
|
.Pp
|
|
The required arguments to
|
|
.Nm
|
|
are the drive to be labeled and the drive type as described in the
|
|
.Pa disktab(5)
|
|
file. The drive parameters and partitions are taken from that file. If
|
|
different disks of the same physical type are to have different partitions, it
|
|
will be necessary to have separate disktab entries describing each, or to edit
|
|
the label after installation as described below. The optional argument is a
|
|
pack identification string, up to 16 characters long. The pack id must be
|
|
quoted if it contains blanks. If the
|
|
.Fl r
|
|
flag is given, the disk sectors containing the label and bootstrap
|
|
will be written directly.
|
|
A side-effect of this is that any existing bootstrap code will be overwritten
|
|
and the disk rendered unbootable. See the boot options below for a method of
|
|
writing the label and the bootstrap at the same time.
|
|
If
|
|
.Fl r
|
|
is not specified,
|
|
the existing label will be updated via the in-core copy and any bootstrap
|
|
code will be unaffected.
|
|
If the disk does not already have a label, the
|
|
.Fl r
|
|
flag must be used.
|
|
In either case, the kernel's in-core label is replaced.
|
|
.Pp
|
|
For a virgin disk that is not known to
|
|
.Xr disktab 5 ,
|
|
.Ar disktype
|
|
can be specified as
|
|
.Dq auto .
|
|
In this case, the driver is requested to produce a virgin label for the
|
|
disk. This might or might not be successful, depending on whether the
|
|
driver for the disk is able to get the required data without reading
|
|
anything from the disk at all. It will likely succeed for all SCSI
|
|
disks, most IDE disks, and vnode devices. Writing a label to the
|
|
disk is the only supported operation, and the
|
|
.Ar disk
|
|
itself must be provided as the canonical name, i.e. not as a full
|
|
path name.
|
|
.Ss Editing an existing disk label
|
|
.Pp
|
|
To edit an existing disk label, use the form
|
|
.Pp
|
|
.Nm disklabel
|
|
.Fl e
|
|
.Op Fl r
|
|
.Ar disk
|
|
.Pp
|
|
This command reads the label from the in-core kernel copy, or directly from the
|
|
disk if the
|
|
.Fl r
|
|
flag is also specified. The label is written to a file in ASCII and then
|
|
supplied to an editor for changes. If no editor is specified in an
|
|
.Ev EDITOR
|
|
environment variable,
|
|
.Xr vi 1
|
|
is used. When the editor terminates, the label file is used to rewrite the disk
|
|
label. Existing bootstrap code is unchanged regardless of whether
|
|
.Fl r
|
|
was specified.
|
|
.Ss Restoring a disk label from a file
|
|
.Pp
|
|
To restore a disk label from a file, use the form
|
|
.Pp
|
|
.Nm disklabel
|
|
.Fl R
|
|
.Op Fl r
|
|
.Ar disk Ar protofile
|
|
.Pp
|
|
.Nm
|
|
is capable of restoring a disk label that was previously saved in a file ASCII.
|
|
The prototype file used to create the label should be in the same format as that
|
|
produced when reading or editing a label. Comments are delimited by
|
|
.Ar \&#
|
|
and newline. As when writing a new label, any existing bootstrap code will be
|
|
clobbered if
|
|
.Fl r
|
|
is specified and will be unaffected otherwise. See the boot options below for a
|
|
method of restoring the label and writing the bootstrap at the same time.
|
|
.Ss Enabling and disabling writing to the disk label area
|
|
.Pp
|
|
By default, it is not possible to write to the disk label area at the beginning
|
|
of a disk. The disk driver silently ignores any attempt to do so. If you need
|
|
to write to this area (for example, to obliterate the label), use the form
|
|
.Pp
|
|
.Nm disklabel
|
|
.Op Fl W
|
|
.Ar disk
|
|
.Pp
|
|
To disallow writing to the label area after previously allowing it, use the
|
|
command
|
|
.Pp
|
|
.Nm disklabel
|
|
.Op Fl N
|
|
.Ar disk
|
|
.Ss Installing bootstraps
|
|
.Pp
|
|
The final three forms of
|
|
.Nm
|
|
are used to install bootstrap code:
|
|
.Pp
|
|
.Nm disklabel
|
|
.Fl B
|
|
.Oo
|
|
.Fl b Ar boot1
|
|
.Fl s Ar boot2
|
|
.Oc
|
|
.Ar disk
|
|
.Oo Ar disktype Oc
|
|
.Pp
|
|
This form installs the bootstrap only. It does not change the disk label.
|
|
.Pp
|
|
.Nm disklabel
|
|
.Fl w
|
|
.Fl B
|
|
.Oo
|
|
.Fl b Ar boot1
|
|
.Fl s Ar boot2
|
|
.Oc
|
|
.Ar disk Ar disktype
|
|
.Oo Ar packid Oc
|
|
.Pp
|
|
.if t This form corresponds to the ``write label'' command described above.
|
|
.if n This form corresponds to the "write label" command described above.
|
|
In addition to writing a new volume label, it also installs the bootstrap.
|
|
.Pp
|
|
.Nm disklabel
|
|
.Fl R
|
|
.Fl B
|
|
.Oo
|
|
.Fl b Ar boot1
|
|
.Fl s Ar boot2
|
|
.Oc
|
|
.Ar disk Ar protofile
|
|
.Oo Ar disktype Oc
|
|
.Pp
|
|
.if t This form corresponds to the ``restore label'' command described above.
|
|
.if n This form corresponds to the "restore label" command described above.
|
|
In addition to restoring the volume label, it also installs the bootstrap.
|
|
.Pp
|
|
The bootstrap commands always access the disk directly, so it is not necessary
|
|
to specify the
|
|
.Fl r
|
|
flag.
|
|
.Pp
|
|
The bootstrap code is comprised of two boot programs. Specify the name of the
|
|
boot programs to be installed in one of these ways:
|
|
.Bl -enum
|
|
.It
|
|
Specify the names explicitly with the
|
|
.Fl b
|
|
and
|
|
.Fl s
|
|
flags.
|
|
.Fl b
|
|
indicates the primary boot program and
|
|
.Fl s
|
|
the secondary boot program. The boot programs are located in
|
|
.Pa /boot .
|
|
.It
|
|
If the
|
|
.Fl b
|
|
and
|
|
.Fl s
|
|
flags are not specified, but
|
|
.Ar disktype
|
|
was specified, the names of the programs are taken from the
|
|
.if t ``b0'' and ``b1''
|
|
.if n "b0" and "b1"
|
|
parameters of the
|
|
.Xr disktab 5
|
|
entry for the disk if the disktab entry exists and includes those parameters.
|
|
.It
|
|
Otherwise, the default boot image names are used:
|
|
.Pa /boot/boot1
|
|
and
|
|
.Pa /boot/boot2
|
|
for the standard stage1 and stage2 boot images (details may vary
|
|
on architectures like the Alpha, where only a single-stage boot is used).
|
|
.El
|
|
.Sh FILES
|
|
.Bl -tag -width Pa -compact
|
|
.It Pa /etc/disktab
|
|
.It Pa /boot/
|
|
.It Pa /boot/boot<n>
|
|
.El
|
|
.Sh SAVED FILE FORMAT
|
|
.Nm
|
|
uses an ASCII version of the label when examining, editing or restoring a disk
|
|
label. The format is:
|
|
.Bd -literal -offset 4n
|
|
# /dev/da1c:
|
|
type: SCSI
|
|
disk: da0s1
|
|
label:
|
|
flags:
|
|
bytes/sector: 512
|
|
sectors/track: 51
|
|
tracks/cylinder: 19
|
|
sectors/cylinder: 969
|
|
cylinders: 1211
|
|
sectors/unit: 1173930
|
|
rpm: 3600
|
|
interleave: 1
|
|
trackskew: 0
|
|
cylinderskew: 0
|
|
headswitch: 0 # milliseconds
|
|
track-to-track seek: 0 # milliseconds
|
|
drivedata: 0
|
|
|
|
8 partitions:
|
|
# size offset fstype [fsize bsize bps/cpg]
|
|
a: 81920 0 4.2BSD 1024 8192 16 # (Cyl. 0 - 84*)
|
|
b: 160000 81920 swap # (Cyl. 84* - 218*)
|
|
c: 1173930 0 unused 0 0 # (Cyl. 0 - 1211*)
|
|
h: 962010 211920 vinum # (Cyl. 218*- 1211*)
|
|
.Ed
|
|
.Pp
|
|
Lines starting with a # mark are comments. Most of the other specifications are
|
|
no longer used. The ones which must still be set correctly are:
|
|
.Pp
|
|
.Bl -hang -width 20n
|
|
.It Nm label
|
|
is an optional label, set by the
|
|
.Ar packid
|
|
option when writing a label.
|
|
.It Nm flags
|
|
Flags may be
|
|
.Ar removable ,
|
|
.Ar ecc
|
|
or
|
|
.Ar badsect .
|
|
.Ar removable
|
|
is set for removable media drives, but no current FreeBSD driver evaluates this
|
|
flag.
|
|
.Ar ecc
|
|
is no longer supported;
|
|
.Ar badsect
|
|
specifies that the drive can perform bad sector remapping.
|
|
.It Nm sectors/unit
|
|
describes the total size of the disk. This value must be correct.
|
|
.It Nm the partition table
|
|
This is the UNIX partition table, not the Microsoft partition table described in
|
|
.Xr fdisk 8 .
|
|
.El
|
|
.Pp
|
|
The partition table can have up to 8 entries. It contains the following
|
|
information:
|
|
.Bl -hang -width 10n
|
|
.It identifier
|
|
The partition identifier is a single letter in the range
|
|
.Nm a
|
|
to
|
|
.Nm h .
|
|
By convention, partition
|
|
.Nm c
|
|
is reserved to describe the entire disk.
|
|
.It size
|
|
is the size of the partition in sectors.
|
|
.It offset
|
|
is the offset of the start of the partition from the beginning of the drive.
|
|
.It fstype
|
|
describes the purpose of the partition. The example shows most normal usages.
|
|
For UFS file systems, use type 4.2BSD. See
|
|
.Pa /usr/include/sys/disklabel.h
|
|
for a complete list.
|
|
.It fsize
|
|
For file systems only, the fragment size.
|
|
.It bsize
|
|
For file systems only, the block size.
|
|
.It bps/cpg
|
|
For UFS file systems, the number of cylinders in a cylinder group. For LFS file
|
|
systems, the segment shift value.
|
|
.El
|
|
The remainder of the line is a comment and shows the cylinder allocations based
|
|
on the obsolete (but possibly correct) geometry information about the drive.
|
|
The asterisk (*) indicates that the partition does not begin or end exactly on a
|
|
cylinder boundary.
|
|
.Sh EXAMPLES
|
|
.Dl disklabel da0
|
|
.Pp
|
|
Display the in-core label for
|
|
.Pa da0
|
|
as obtained via
|
|
.Pa /dev/da0c .
|
|
.Pp
|
|
.Dl disklabel da0 > savedlabel
|
|
.Pp
|
|
Save the in-core label for
|
|
.Pa da0
|
|
into the file
|
|
.Pa savedlabel .
|
|
This file can be used with the
|
|
.Fl R
|
|
flag to restore the label at a later date.
|
|
.Pp
|
|
.Dl disklabel -w -r /dev/da0c da2212 foo
|
|
.Pp
|
|
Create a label for
|
|
.Pa da0
|
|
based on information for
|
|
.if t ``da2212'' found in
|
|
.if n "da2212" found in
|
|
.Pa /etc/disktab .
|
|
Any existing bootstrap code will be clobbered.
|
|
.Pp
|
|
.Dl disklabel -e -r da0
|
|
.Pp
|
|
Read the on-disk label for
|
|
.Pa da0 ,
|
|
edit it and reinstall in-core as well as on-disk. Existing bootstrap code is
|
|
unaffected.
|
|
.Pp
|
|
.Dl disklabel -r -w da0 auto
|
|
.Pp
|
|
Try to auto-detect the required information from
|
|
.Pa da0 ,
|
|
and write a new label to the disk. Use another disklabel -e command to edit the
|
|
partitioning and file system information.
|
|
.Pp
|
|
.Dl disklabel -R da0 savedlabel
|
|
.Pp
|
|
Restore the on-disk and in-core label for
|
|
.Pa da0
|
|
from information in
|
|
.Pa savedlabel .
|
|
Existing bootstrap code is unaffected.
|
|
.Pp
|
|
.Dl disklabel -B da0
|
|
.Pp
|
|
Install a new bootstrap on
|
|
.Pa da0 .
|
|
The boot code comes from
|
|
.Pa /boot/boot1
|
|
and possibly
|
|
.Pa /boot/boot2 .
|
|
On-disk and in-core labels are unchanged.
|
|
.Pp
|
|
.Dl disklabel -w -B /dev/da0c -b newboot1 -s newboot da2212
|
|
.Pp
|
|
Install a new label and bootstrap.
|
|
.if t The label is derived from disktab information for ``da2212'' and
|
|
.if n The label is derived from disktab information for "da2212" and
|
|
installed both in-core and on-disk.
|
|
The bootstrap code comes from the files
|
|
.Pa /boot/newboot1
|
|
and
|
|
.Pa /boot/newboot2 .
|
|
.Sh SEE ALSO
|
|
.Xr disklabel 5 ,
|
|
.Xr disktab 5 ,
|
|
.Xr boot0cfg 8 ,
|
|
.Xr fdisk 8
|
|
.Sh DIAGNOSTICS
|
|
The kernel device drivers will not allow the size of a disk partition
|
|
to be decreased or the offset of a partition to be changed while it is open.
|
|
Some device drivers create a label containing only a single large partition
|
|
if a disk is unlabeled; thus, the label must be written to the
|
|
.if t ``a''
|
|
.if n "a"
|
|
partition of the disk while it is open. This sometimes requires the desired
|
|
label to be set in two steps, the first one creating at least one other
|
|
partition, and the second setting the label on the new partition while shrinking
|
|
the
|
|
.if t ``a''
|
|
.if n "a"
|
|
partition.
|
|
.Pp
|
|
On some machines the bootstrap code may not fit entirely in the area
|
|
allocated for it by some filesystems.
|
|
As a result, it may not be possible to have filesystems on some partitions
|
|
.if t of a ``bootable'' disk.
|
|
.if n of a "bootable" disk.
|
|
When installing bootstrap code,
|
|
.Nm
|
|
checks for these cases.
|
|
If the installed boot code would overlap a partition of type FS_UNUSED
|
|
it is marked as type FS_BOOT.
|
|
The
|
|
.Xr newfs 8
|
|
utility will disallow creation of filesystems on FS_BOOT partitions.
|
|
Conversely, if a partition has a type other than FS_UNUSED or FS_BOOT,
|
|
.Nm
|
|
will not install bootstrap code that overlaps it.
|
|
.Sh BUGS
|
|
When a disk name is given without a full pathname,
|
|
.if t the constructed device name uses the ``c'' partition.
|
|
.if n the constructed device name uses the "c" partition.
|
|
.Pp
|
|
For the i386 architecture, the primary bootstrap sector contains
|
|
an embedded
|
|
.Em fdisk
|
|
table.
|
|
.Nm Disklabel
|
|
takes care to not clobber it when installing a bootstrap only
|
|
.Pq Fl B ,
|
|
or when editing an existing label
|
|
.Pq Fl e ,
|
|
but it unconditionally writes the primary bootstrap program onto
|
|
the disk for
|
|
.Fl w
|
|
or
|
|
.Fl R ,
|
|
thus replacing the
|
|
.Em fdisk
|
|
table by the dummy one in the bootstrap program. This is only of
|
|
concern if the disk is fully dedicated, so that the BSD disklabel
|
|
starts at absolute block 0 on the disk.
|
|
.Pp
|
|
.Nm
|
|
does not perform adequate error checking. No warning is given if partitions
|
|
overlap, nor if space remains unused.
|