xref: /freebsd/sbin/fsck_ffs/fsck.h (revision e627b39baccd1ec9129690167cf5e6d860509655)
1 /*
2  * Copyright (c) 1980, 1986, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)fsck.h	8.1 (Berkeley) 6/5/93
34  */
35 
36 #define	MAXDUP		10	/* limit on dup blks (per inode) */
37 #define	MAXBAD		10	/* limit on bad blks (per inode) */
38 #define	MAXBUFSPACE	40*1024	/* maximum space to allocate to buffers */
39 #define	INOBUFSIZE	56*1024	/* size of buffer to read inodes in pass1 */
40 
41 #ifndef BUFSIZ
42 #define BUFSIZ 1024
43 #endif
44 
45 #define	USTATE	01		/* inode not allocated */
46 #define	FSTATE	02		/* inode is file */
47 #define	DSTATE	03		/* inode is directory */
48 #define	DFOUND	04		/* directory found during descent */
49 #define	DCLEAR	05		/* directory is to be cleared */
50 #define	FCLEAR	06		/* file is to be cleared */
51 
52 /*
53  * buffer cache structure.
54  */
55 struct bufarea {
56 	struct bufarea	*b_next;		/* free list queue */
57 	struct bufarea	*b_prev;		/* free list queue */
58 	daddr_t	b_bno;
59 	int	b_size;
60 	int	b_errs;
61 	int	b_flags;
62 	union {
63 		char	*b_buf;			/* buffer space */
64 		daddr_t	*b_indir;		/* indirect block */
65 		struct	fs *b_fs;		/* super block */
66 		struct	cg *b_cg;		/* cylinder group */
67 		struct	dinode *b_dinode;	/* inode block */
68 	} b_un;
69 	char	b_dirty;
70 };
71 
72 #define	B_INUSE 1
73 
74 #define	MINBUFS		5	/* minimum number of buffers required */
75 struct bufarea bufhead;		/* head of list of other blks in filesys */
76 struct bufarea sblk;		/* file system superblock */
77 struct bufarea cgblk;		/* cylinder group blocks */
78 struct bufarea *pdirbp;		/* current directory contents */
79 struct bufarea *pbp;		/* current inode block */
80 struct bufarea *getdatablk();
81 
82 #define	dirty(bp)	(bp)->b_dirty = 1
83 #define	initbarea(bp) \
84 	(bp)->b_dirty = 0; \
85 	(bp)->b_bno = (daddr_t)-1; \
86 	(bp)->b_flags = 0;
87 
88 #define	sbdirty()	sblk.b_dirty = 1
89 #define	cgdirty()	cgblk.b_dirty = 1
90 #define	sblock		(*sblk.b_un.b_fs)
91 #define	cgrp		(*cgblk.b_un.b_cg)
92 
93 enum fixstate {DONTKNOW, NOFIX, FIX, IGNORE};
94 
95 struct inodesc {
96 	enum fixstate id_fix;	/* policy on fixing errors */
97 	int (*id_func)();	/* function to be applied to blocks of inode */
98 	ino_t id_number;	/* inode number described */
99 	ino_t id_parent;	/* for DATA nodes, their parent */
100 	daddr_t id_blkno;	/* current block number being examined */
101 	int id_numfrags;	/* number of frags contained in block */
102 	quad_t id_filesize;	/* for DATA nodes, the size of the directory */
103 	int id_loc;		/* for DATA nodes, current location in dir */
104 	int id_entryno;		/* for DATA nodes, current entry number */
105 	struct direct *id_dirp;	/* for DATA nodes, ptr to current entry */
106 	char *id_name;		/* for DATA nodes, name to find or enter */
107 	char id_type;		/* type of descriptor, DATA or ADDR */
108 };
109 /* file types */
110 #define	DATA	1
111 #define	ADDR	2
112 
113 /*
114  * Linked list of duplicate blocks.
115  *
116  * The list is composed of two parts. The first part of the
117  * list (from duplist through the node pointed to by muldup)
118  * contains a single copy of each duplicate block that has been
119  * found. The second part of the list (from muldup to the end)
120  * contains duplicate blocks that have been found more than once.
121  * To check if a block has been found as a duplicate it is only
122  * necessary to search from duplist through muldup. To find the
123  * total number of times that a block has been found as a duplicate
124  * the entire list must be searched for occurences of the block
125  * in question. The following diagram shows a sample list where
126  * w (found twice), x (found once), y (found three times), and z
127  * (found once) are duplicate block numbers:
128  *
129  *    w -> y -> x -> z -> y -> w -> y
130  *    ^		     ^
131  *    |		     |
132  * duplist	  muldup
133  */
134 struct dups {
135 	struct dups *next;
136 	daddr_t dup;
137 };
138 struct dups *duplist;		/* head of dup list */
139 struct dups *muldup;		/* end of unique duplicate dup block numbers */
140 
141 /*
142  * Linked list of inodes with zero link counts.
143  */
144 struct zlncnt {
145 	struct zlncnt *next;
146 	ino_t zlncnt;
147 };
148 struct zlncnt *zlnhead;		/* head of zero link count list */
149 
150 /*
151  * Inode cache data structures.
152  */
153 struct inoinfo {
154 	struct	inoinfo *i_nexthash;	/* next entry in hash chain */
155 	ino_t	i_number;		/* inode number of this entry */
156 	ino_t	i_parent;		/* inode number of parent */
157 	ino_t	i_dotdot;		/* inode number of `..' */
158 	size_t	i_isize;		/* size of inode */
159 	u_int	i_numblks;		/* size of block array in bytes */
160 	daddr_t	i_blks[1];		/* actually longer */
161 } **inphead, **inpsort;
162 long numdirs, listmax, inplast;
163 
164 char	*cdevname;		/* name of device being checked */
165 long	dev_bsize;		/* computed value of DEV_BSIZE */
166 long	secsize;		/* actual disk sector size */
167 char	fflag;			/* force fs check (ignore clean flag) */
168 char	nflag;			/* assume a no response */
169 char	yflag;			/* assume a yes response */
170 int	bflag;			/* location of alternate super block */
171 int	debug;			/* output debugging info */
172 int	cvtlevel;		/* convert to newer file system format */
173 int	doinglevel1;		/* converting to new cylinder group format */
174 int	doinglevel2;		/* converting to new inode format */
175 int	newinofmt;		/* filesystem has new inode format */
176 char	preen;			/* just fix normal inconsistencies */
177 char	hotroot;		/* checking root device */
178 char	havesb;			/* superblock has been read */
179 int	fsmodified;		/* 1 => write done to file system */
180 int	fsreadfd;		/* file descriptor for reading file system */
181 int	fswritefd;		/* file descriptor for writing file system */
182 int	returntosingle;		/* return to single user mode */
183 
184 daddr_t	maxfsblock;		/* number of blocks in the file system */
185 char	*blockmap;		/* ptr to primary blk allocation map */
186 ino_t	maxino;			/* number of inodes in file system */
187 ino_t	lastino;		/* last inode in use */
188 char	*statemap;		/* ptr to inode state table */
189 unsigned char	*typemap;	/* ptr to inode type table */
190 short	*lncntp;		/* ptr to link count table */
191 
192 ino_t	lfdir;			/* lost & found directory inode number */
193 char	*lfname;		/* lost & found directory name */
194 int	lfmode;			/* lost & found directory creation mode */
195 
196 daddr_t	n_blks;			/* number of blocks in use */
197 daddr_t	n_files;		/* number of files in use */
198 
199 #define	clearinode(dp)	(*(dp) = zino)
200 struct	dinode zino;
201 
202 #define	setbmap(blkno)	setbit(blockmap, blkno)
203 #define	testbmap(blkno)	isset(blockmap, blkno)
204 #define	clrbmap(blkno)	clrbit(blockmap, blkno)
205 
206 #define	STOP	0x01
207 #define	SKIP	0x02
208 #define	KEEPON	0x04
209 #define	ALTERED	0x08
210 #define	FOUND	0x10
211 
212 /* dir.c */
213 void	adjust __P((struct inodesc *idesc, short lcnt));
214 ino_t	allocdir __P((ino_t parent, ino_t request, int mode));
215 int	changeino __P((ino_t dir, char *name, ino_t newnum));
216 void	direrror __P((ino_t ino, char *errmesg));
217 int	dirscan __P((struct inodesc *idesc));
218 void	fileerror __P((ino_t cwd, ino_t ino, char *errmesg));
219 int	linkup __P((ino_t orphan, ino_t parentdir));
220 int	makeentry __P((ino_t parent, ino_t ino, char *name));
221 void	propagate __P((void));
222 
223 /* ffs_subr.c */
224 void	ffs_fragacct __P((struct fs *fs, int fragmap, long *fraglist, int cnt));
225 
226 /* inode.c */
227 ino_t	allocino __P((ino_t request, int type));
228 void	blkerror __P((ino_t ino, char *type, daddr_t blk));
229 void	cacheino __P((struct dinode *dp, ino_t inumber));
230 int	chkrange __P((daddr_t blk, int cnt));
231 int	ckinode __P((struct dinode *dp, struct inodesc *idesc));
232 void	clri __P((struct inodesc *idesc, char *type, int flag));
233 int	findino __P((struct inodesc *idesc));
234 void	freeino __P((ino_t ino));
235 void	freeinodebuf __P((void));
236 struct dinode * ginode __P((ino_t inumber));
237 struct inoinfo * getinoinfo __P((ino_t inumber));
238 struct dinode * getnextinode __P((ino_t inumber));
239 void	inodirty __P((void));
240 void	inocleanup __P((void));
241 void	pinode __P((ino_t ino));
242 void	resetinodebuf __P((void));
243 int	findname __P((struct inodesc *idesc));
244 
245 /* pass1.c */
246 void	pass1 __P((void));
247 int	pass1check __P((struct inodesc *idesc));
248 
249 /* pass1b.c */
250 void	pass1b __P((void));
251 
252 /* pass2.c */
253 void	pass2 __P((void));
254 
255 /* pass3.c */
256 void	pass3 __P((void));
257 
258 /* pass4.c */
259 void	pass4 __P((void));
260 int	pass4check __P((struct inodesc *idesc));
261 
262 /* pass5.c */
263 void	pass5 __P((void));
264 
265 /* preen.c */
266 char	*blockcheck __P((char *name));
267 int	checkfstab __P((int preen, int maxrun,int (*docheck)(), int (*chkit)()));
268 
269 /* setup.c */
270 int	setup __P((char *dev));
271 
272 /* utilities.c */
273 int	allocblk __P((long frags));
274 int	bread __P((int fd, char *buf, daddr_t blk, long size));
275 void	bufinit __P((void));
276 void	bwrite __P((int fd, char *buf, daddr_t blk, long size));
277 void	catch __P((int));
278 void	catchquit __P((int));
279 void	ckfini __P((void));
280 int	dofix __P((struct inodesc *idesc, char *msg));
281 void	errexit __P((const char *s1, ...)) __dead2;
282 void	flush __P((int fd, struct bufarea *bp));
283 void	freeblk __P((daddr_t blkno, long frags));
284 int	ftypeok __P((struct dinode *dp));
285 void	getblk __P((struct bufarea *bp, daddr_t blk, long size));
286 struct bufarea * getdatablk __P((daddr_t blkno, long size));
287 void	getpathname __P((char *namebuf, ino_t curdir, ino_t ino));
288 void	panic __P((const char *, ...)) __dead2;
289 void	pfatal __P((const char *s1, ...));
290 void	pwarn __P((const char *s1, ...));
291 int	reply __P((char *question));
292 void	voidquit __P((int));
293