HAMMER VFS - REDO/fsync precursor work
[dragonfly.git] / sbin / fsck / SMM.doc / 0.t
blob528dd96a7d8d48341c18df47a7e6a5f27d207b89
1 .\" Copyright (c) 1986, 1993
2 .\"  The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)0.t 8.1 (Berkeley) 6/8/93
33 .\"
34 .if n .ND
35 .TL
36 Fsck \- The UNIX\(dg File System Check Program
37 .EH 'SMM:3-%''The \s-2UNIX\s+2 File System Check Program'
38 .OH 'The \s-2UNIX\s+2 File System Check Program''SMM:3-%'
39 .AU
40 Marshall Kirk McKusick
41 .AI
42 Computer Systems Research Group
43 Computer Science Division
44 Department of Electrical Engineering and Computer Science
45 University of California, Berkeley
46 Berkeley, CA  94720
47 .AU
48 T. J. Kowalski
49 .AI
50 Bell Laboratories
51 Murray Hill, New Jersey 07974
52 .AB
53 .FS
54 \(dgUNIX is a trademark of Bell Laboratories.
55 .FE
56 .FS
57 This work was done under grants from
58 the National Science Foundation under grant MCS80-05144,
59 and the Defense Advance Research Projects Agency (DoD) under
60 Arpa Order No. 4031 monitored by Naval Electronic System Command under
61 Contract No. N00039-82-C-0235.
62 .FE
63 This document reflects the use of
64 .I fsck
65 with the 4.2BSD and 4.3BSD file system organization.  This
66 is a revision of the
67 original paper written by
68 T. J. Kowalski.
69 .PP
70 File System Check Program (\fIfsck\fR)
71 is an interactive file system check and repair program.
72 .I Fsck
73 uses the redundant structural information in the
74 UNIX file system to perform several consistency checks.
75 If an inconsistency is detected, it is reported
76 to the operator, who may elect to fix or ignore
77 each inconsistency.
78 These inconsistencies result from the permanent interruption
79 of the file system updates, which are performed every
80 time a file is modified.
81 Unless there has been a hardware failure,
82 .I fsck
83 is able to repair corrupted file systems
84 using procedures based upon the order in which UNIX honors
85 these file system update requests.
86 .PP
87 The purpose of this document is to describe the normal updating
88 of the file system,
89 to discuss the possible causes of file system corruption,
90 and to present the corrective actions implemented
92 .I fsck.
93 Both the program and the interaction between the
94 program and the operator are described.
95 .sp 2
96 .LP
97 Revised October 7, 1996
98 .AE
99 .LP
102 .B "TABLE OF CONTENTS"
104 .sp 1
106 .B "1.  Introduction"
108 .sp .5v
110 .B "2.  Overview of the file system
111 2.1.    Superblock
112 2.2.    Summary Information
113 2.3.    Cylinder groups
114 2.4.    Fragments
115 2.5.    Updates to the file system
117 .sp .5v
119 .B "3.  Fixing corrupted file systems
120 3.1.    Detecting and correcting corruption
121 3.2.    Super block checking
122 3.3.    Free block checking
123 3.4.    Checking the inode state
124 3.5.    Inode links
125 3.6.    Inode data size
126 3.7.    Checking the data associated with an inode
127 3.8.    File system connectivity
129 .sp .5v
131 .B Acknowledgements
133 .sp .5v
135 .B References
137 .sp .5v
139 .B "4.  Appendix A
140 4.1.     Conventions
141 4.2.     Initialization
142 4.3.     Phase 1 - Check Blocks and Sizes
143 4.4.     Phase 1b - Rescan for more Dups
144 4.5.     Phase 2 - Check Pathnames
145 4.6.     Phase 3 - Check Connectivity
146 4.7.     Phase 4 - Check Reference Counts
147 4.8.     Phase 5 - Check Cyl groups
148 4.9.     Cleanup
149 .ds RH Introduction