tcp: Cache align ACK queue header.
[dragonfly.git] / sbin / disklabel32 / disklabel32.5
blobbef1c13355f19bc4c07a3822b1f960c9d13bdc73
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. Neither the name of the University nor the names of its contributors
16 .\"    may be used to endorse or promote products derived from this software
17 .\"    without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\"     @(#)disklabel.5.5       8.1 (Berkeley) 6/5/93
32 .\" $FreeBSD: src/sbin/disklabel/disklabel.5,v 1.7.2.4 2002/08/21 18:58:16 trhodes Exp $
33 .\" $DragonFly: src/sbin/disklabel/disklabel.5,v 1.6 2008/08/21 21:08:08 thomas Exp $
34 .\"
35 .Dd August 21, 2008
36 .Dt DISKLABEL32 5
37 .Os
38 .Sh NAME
39 .Nm disklabel32
40 .Nd 32 bit disk pack label
41 .Sh SYNOPSIS
42 .In sys/disklabel.h
43 .Sh DESCRIPTION
44 Each disk or disk pack on a system may contain a disk label
45 which provides detailed information
46 about the geometry of the disk and the partitions into which the disk
47 is divided.
48 It should be initialized when the disk is formatted,
49 and may be changed later with the
50 .Xr disklabel32 8
51 program.
52 This information is used by the system disk driver and by the bootstrap
53 program to determine how to program the drive
54 and where to find the file systems on the disk partitions.
55 Additional information is used by the file system in order
56 to use the disk most efficiently and to locate important file system information.
57 The description of each partition contains an identifier for the partition
58 type (standard file system, swap area, etc.).
59 The file system updates the in-core copy of the label if it contains
60 incomplete information about the file system.
61 .Pp
62 The label is located in sector number
63 .Dv LABELSECTOR
64 of the drive, usually sector 0 where it may be found
65 without any information about the disk geometry.
66 It is at an offset
67 .Dv LABELOFFSET
68 from the beginning of the sector, to allow room for the initial bootstrap.
69 The disk sector containing the label is normally made read-only
70 so that it is not accidentally overwritten by pack-to-pack copies
71 or swap operations;
72 the
73 .Dv DIOCWLABEL
74 .Xr ioctl 2 ,
75 which is done as needed by the
76 .Xr disklabel32 8
77 program.
78 .Pp
79 A copy of the in-core label for a disk can be obtained with the
80 .Dv DIOCGDINFO
81 .Xr ioctl 2 ;
82 this works with a file descriptor for a block or character (``raw'') device
83 for any partition of the disk.
84 The in-core copy of the label is set by the
85 .Dv DIOCSDINFO
86 .Xr ioctl 2 .
87 The offset of a partition cannot generally be changed while it is open,
88 nor can it be made smaller while it is open.
89 One exception is that any change is allowed if no label was found
90 on the disk, and the driver was able to construct only a skeletal label
91 without partition information.
92 Finally, the
93 .Dv DIOCWDINFO
94 .Xr ioctl 2
95 operation sets the in-core label and then updates the on-disk label;
96 there must be an existing label on the disk for this operation to succeed.
97 Thus, the initial label for a disk or disk pack must be installed
98 by writing to the raw disk.
99 All of these operations are normally done using
100 .Xr disklabel32 8 .
102 The format of the disk label is specified in
103 .In sys/disklabel32.h .
104 .Sh SEE ALSO
105 .Xr disklabel64 5 ,
106 .Xr disktab 5 ,
107 .Xr disklabel32 8