xref: /netbsd/sbin/fsck_lfs/fsck.h (revision bf9ec67e)
1 /* $NetBSD: fsck.h,v 1.6 2002/05/23 04:05:11 perseant Exp $	 */
2 
3 /*
4  * Copyright (c) 1997
5  *      Konrad Schroder.  All rights reserved.
6  * Copyright (c) 1980, 1986, 1993
7  *	The Regents of the University of California.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *	This product includes software developed by the University of
20  *	California, Berkeley and its contributors.
21  * 4. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	@(#)fsck.h	8.1 (Berkeley) 6/5/93
38  */
39 
40 #ifdef KS_DEBUG
41 #include <err.h>
42 #define debug_printf warn
43 #else
44 #define debug_printf
45 #endif
46 
47 #define	MAXDUP		10	/* limit on dup blks (per inode) */
48 #define	MAXBAD		10	/* limit on bad blks (per inode) */
49 #define	MAXBUFSPACE	40*1024	/* maximum space to allocate to buffers */
50 #define	INOBUFSIZE	56*1024	/* size of buffer to read inodes in pass1 */
51 
52 #ifndef BUFSIZ
53 #define BUFSIZ 1024
54 #endif
55 
56 #define	USTATE	01		/* inode not allocated */
57 #define	FSTATE	02		/* inode is file */
58 #define	DSTATE	03		/* inode is directory */
59 #define	DFOUND	04		/* directory found during descent */
60 #define	DCLEAR	05		/* directory is to be cleared */
61 #define	FCLEAR	06		/* file is to be cleared */
62 
63 /*
64  * buffer cache structure.
65  */
66 struct bufarea {
67 	struct bufarea *b_next;	/* free list queue */
68 	struct bufarea *b_prev;	/* free list queue */
69 	daddr_t         b_bno;
70 	int             b_size;
71 	int             b_errs;
72 	int             b_flags;
73 	union {
74 		char           *b_buf;	/* buffer space */
75 		daddr_t        *b_indir;	/* indirect block */
76 		struct lfs     *b_fs;	/* super block */
77 		struct cg      *b_cg;	/* cylinder group */
78 		struct dinode  *b_dinode;	/* inode block */
79 	}               b_un;
80 	char            b_dirty;
81 };
82 
83 #define	B_INUSE 1
84 
85 #define	MINBUFS		5	/* minimum number of buffers required */
86 
87 #define	dirty(bp)	(bp)->b_dirty = 1
88 #define	initbarea(bp) \
89 	(bp)->b_dirty = 0; \
90 	(bp)->b_bno = (daddr_t)-1; \
91 	(bp)->b_flags = 0;
92 
93 #define	sblock		(*sblk.b_un.b_fs)
94 #define ifblock         (*iblk.b_un.b_dinode)
95 #define	sbdirty() do {							\
96 	sblk.b_dirty = 1;						\
97 	sblock.lfs_dlfs.dlfs_cksum = lfs_sb_cksum(&(sblock.lfs_dlfs));	\
98 } while(0)
99 
100 enum fixstate {
101 	DONTKNOW, NOFIX, FIX, IGNORE
102 };
103 
104 struct inodesc {
105 	enum fixstate   id_fix;		/* policy on fixing errors */
106 	int             (*id_func)(struct inodesc *);  /* function to be
107 					 * applied to blocks of inode */
108 	ino_t           id_number;	/* inode number described */
109 	ino_t           id_parent;	/* for DATA nodes, their parent */
110 	daddr_t         id_blkno;	/* current block number being
111 					 * examined */
112 	daddr_t         id_lblkno;	/* current logical block number */
113 	int             id_numfrags;	/* number of frags contained in block */
114 	quad_t          id_filesize;	/* for DATA nodes, the size of the
115 					 * directory */
116 	int             id_loc;		/* for DATA nodes, current location
117 					 * in dir */
118 	int             id_entryno;	/* for DATA nodes, current entry
119 					 * number */
120 	struct direct  *id_dirp;	/* for DATA nodes, ptr to current
121 					 * entry */
122 	char           *id_name;	/* for DATA nodes, name to find or
123 					 * enter */
124 	char            id_type;	/* type of descriptor, DATA or ADDR */
125 };
126 /* file types */
127 #define	DATA	1
128 #define	ADDR	2
129 
130 /*
131  * Linked list of duplicate blocks.
132  *
133  * The list is composed of two parts. The first part of the
134  * list (from duplist through the node pointed to by muldup)
135  * contains a single copy of each duplicate block that has been
136  * found. The second part of the list (from muldup to the end)
137  * contains duplicate blocks that have been found more than once.
138  * To check if a block has been found as a duplicate it is only
139  * necessary to search from duplist through muldup. To find the
140  * total number of times that a block has been found as a duplicate
141  * the entire list must be searched for occurences of the block
142  * in question. The following diagram shows a sample list where
143  * w (found twice), x (found once), y (found three times), and z
144  * (found once) are duplicate block numbers:
145  *
146  *    w -> y -> x -> z -> y -> w -> y
147  *    ^		     ^
148  *    |		     |
149  * duplist	  muldup
150  */
151 struct dups {
152 	struct dups    *next;
153 	daddr_t         dup;
154 };
155 
156 /*
157  * Linked list of inodes with zero link counts.
158  */
159 struct zlncnt {
160 	struct zlncnt  *next;
161 	ino_t           zlncnt;
162 };
163 
164 /*
165  * Inode cache data structures.
166  */
167 struct inoinfo {
168 	struct inoinfo *i_nexthash;	/* next entry in hash chain */
169 	struct inoinfo *i_child, *i_sibling, *i_parentp;
170 	ino_t           i_number;	/* inode number of this entry */
171 	ino_t           i_parent;	/* inode number of parent */
172 	ino_t           i_dotdot;	/* inode number of `..' */
173 	size_t          i_isize;	/* size of inode */
174 	u_int           i_numblks;	/* size of block array in bytes */
175 	daddr_t         i_blks[1];	/* actually longer */
176 } **inphead, **inpsort;
177 
178 #define	clearinode(dp)	(*(dp) = zino)
179 
180 #ifndef VERBOSE_BLOCKMAP
181 #define	setbmap(blkno)	setbit(blockmap, blkno)
182 #define	testbmap(blkno)	isset(blockmap, blkno)
183 #define	clrbmap(blkno)	clrbit(blockmap, blkno)
184 #else
185 #define	setbmap(blkno,ino)	if(blkno > maxfsblock)raise(1); else blockmap[blkno] = ino
186 #define	testbmap(blkno)		blockmap[blkno]
187 #define	clrbmap(blkno)		blockmap[blkno] = 0
188 #endif
189 
190 #define	STOP	0x01
191 #define	SKIP	0x02
192 #define	KEEPON	0x04
193 #define	ALTERED	0x08
194 #define	FOUND	0x10
195 
196 ino_t           allocino(ino_t, int);
197 int             ino_to_fsba(struct lfs *, ino_t);
198 struct bufarea *getfileblk(struct lfs *, struct dinode *, ino_t);
199 struct dinode  *ginode(ino_t);
200 struct dinode  *lfs_ginode(ino_t);
201 struct dinode  *lfs_difind(struct lfs *, ino_t, struct dinode *);
202 struct ifile   *lfs_ientry(ino_t, struct bufarea **);
203 struct inoinfo *getinoinfo(ino_t);
204 void            getblk(struct bufarea *, daddr_t, long);
205 void            getdblk(struct bufarea *, daddr_t, long);
206 int             check_summary(struct lfs *, SEGSUM *, daddr_t);
207 SEGUSE         *lfs_gseguse(int, struct bufarea **);
208 daddr_t         lfs_ino_daddr(ino_t);
209 
210 #include "fsck_vars.h"
211