xref: /freebsd/sbin/fsck_ffs/fsck.h (revision 4cf49a43559ed9fdad601bdcccd2c55963008675)
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.4 (Berkeley) 5/9/95
34  */
35 
36 #include <unistd.h>
37 #include <stdlib.h>
38 #include <stdio.h>
39 
40 #define	MAXDUP		10	/* limit on dup blks (per inode) */
41 #define	MAXBAD		10	/* limit on bad blks (per inode) */
42 #define	MAXBUFSPACE	40*1024	/* maximum space to allocate to buffers */
43 #define	INOBUFSIZE	56*1024	/* size of buffer to read inodes in pass1 */
44 
45 /*
46  * Each inode on the filesystem is described by the following structure.
47  * The linkcnt is initially set to the value in the inode. Each time it
48  * is found during the descent in passes 2, 3, and 4 the count is
49  * decremented. Any inodes whose count is non-zero after pass 4 needs to
50  * have its link count adjusted by the value remaining in ino_linkcnt.
51  */
52 struct inostat {
53 	char	ino_state;	/* state of inode, see below */
54 	char	ino_type;	/* type of inode */
55 	short	ino_linkcnt;	/* number of links not found */
56 };
57 /*
58  * Inode states.
59  */
60 #define	USTATE	01		/* inode not allocated */
61 #define	FSTATE	02		/* inode is file */
62 #define	DSTATE	03		/* inode is directory */
63 #define	DFOUND	04		/* directory found during descent */
64 #define	DCLEAR	05		/* directory is to be cleared */
65 #define	FCLEAR	06		/* file is to be cleared */
66 /*
67  * Inode state information is contained on per cylinder group lists
68  * which are described by the following structure.
69  */
70 struct inostatlist {
71 	long	il_numalloced;	/* number of inodes allocated in this cg */
72 	struct inostat *il_stat;/* inostat info for this cylinder group */
73 } *inostathead;
74 
75 /*
76  * buffer cache structure.
77  */
78 struct bufarea {
79 	struct bufarea *b_next;		/* free list queue */
80 	struct bufarea *b_prev;		/* free list queue */
81 	ufs_daddr_t b_bno;
82 	int b_size;
83 	int b_errs;
84 	int b_flags;
85 	union {
86 		char *b_buf;			/* buffer space */
87 		ufs_daddr_t *b_indir;		/* indirect block */
88 		struct fs *b_fs;		/* super block */
89 		struct cg *b_cg;		/* cylinder group */
90 		struct dinode *b_dinode;	/* inode block */
91 	} b_un;
92 	char b_dirty;
93 };
94 
95 #define	B_INUSE 1
96 
97 #define	MINBUFS		5	/* minimum number of buffers required */
98 struct bufarea bufhead;		/* head of list of other blks in filesys */
99 struct bufarea sblk;		/* file system superblock */
100 struct bufarea cgblk;		/* cylinder group blocks */
101 struct bufarea *pdirbp;		/* current directory contents */
102 struct bufarea *pbp;		/* current inode block */
103 
104 #define	dirty(bp)	(bp)->b_dirty = 1
105 #define	initbarea(bp) \
106 	(bp)->b_dirty = 0; \
107 	(bp)->b_bno = (ufs_daddr_t)-1; \
108 	(bp)->b_flags = 0;
109 
110 #define	sbdirty()	sblk.b_dirty = 1
111 #define	cgdirty()	cgblk.b_dirty = 1
112 #define	sblock		(*sblk.b_un.b_fs)
113 #define	cgrp		(*cgblk.b_un.b_cg)
114 
115 enum fixstate {DONTKNOW, NOFIX, FIX, IGNORE};
116 
117 struct inodesc {
118 	enum fixstate id_fix;	/* policy on fixing errors */
119 	int (*id_func)();	/* function to be applied to blocks of inode */
120 	ino_t id_number;	/* inode number described */
121 	ino_t id_parent;	/* for DATA nodes, their parent */
122 	ufs_daddr_t id_blkno;	/* current block number being examined */
123 	int id_numfrags;	/* number of frags contained in block */
124 	quad_t id_filesize;	/* for DATA nodes, the size of the directory */
125 	int id_loc;		/* for DATA nodes, current location in dir */
126 	int id_entryno;		/* for DATA nodes, current entry number */
127 	struct direct *id_dirp;	/* for DATA nodes, ptr to current entry */
128 	char *id_name;		/* for DATA nodes, name to find or enter */
129 	char id_type;		/* type of descriptor, DATA or ADDR */
130 };
131 /* file types */
132 #define	DATA	1
133 #define	ADDR	2
134 
135 /*
136  * Linked list of duplicate blocks.
137  *
138  * The list is composed of two parts. The first part of the
139  * list (from duplist through the node pointed to by muldup)
140  * contains a single copy of each duplicate block that has been
141  * found. The second part of the list (from muldup to the end)
142  * contains duplicate blocks that have been found more than once.
143  * To check if a block has been found as a duplicate it is only
144  * necessary to search from duplist through muldup. To find the
145  * total number of times that a block has been found as a duplicate
146  * the entire list must be searched for occurences of the block
147  * in question. The following diagram shows a sample list where
148  * w (found twice), x (found once), y (found three times), and z
149  * (found once) are duplicate block numbers:
150  *
151  *    w -> y -> x -> z -> y -> w -> y
152  *    ^		     ^
153  *    |		     |
154  * duplist	  muldup
155  */
156 struct dups {
157 	struct dups *next;
158 	ufs_daddr_t dup;
159 };
160 struct dups *duplist;		/* head of dup list */
161 struct dups *muldup;		/* end of unique duplicate dup block numbers */
162 
163 /*
164  * Linked list of inodes with zero link counts.
165  */
166 struct zlncnt {
167 	struct zlncnt *next;
168 	ino_t zlncnt;
169 };
170 struct zlncnt *zlnhead;		/* head of zero link count list */
171 
172 /*
173  * Inode cache data structures.
174  */
175 struct inoinfo {
176 	struct	inoinfo *i_nexthash;	/* next entry in hash chain */
177 	ino_t	i_number;		/* inode number of this entry */
178 	ino_t	i_parent;		/* inode number of parent */
179 	ino_t	i_dotdot;		/* inode number of `..' */
180 	size_t	i_isize;		/* size of inode */
181 	u_int	i_numblks;		/* size of block array in bytes */
182 	ufs_daddr_t i_blks[1];		/* actually longer */
183 } **inphead, **inpsort;
184 long numdirs, listmax, inplast;
185 long countdirs;			/* number of directories we actually found */
186 
187 char	*cdevname;		/* name of device being checked */
188 long	dev_bsize;		/* computed value of DEV_BSIZE */
189 long	secsize;		/* actual disk sector size */
190 char	fflag;			/* force check, ignore clean flag */
191 char	nflag;			/* assume a no response */
192 char	yflag;			/* assume a yes response */
193 int	bflag;			/* location of alternate super block */
194 int	debug;			/* output debugging info */
195 int	cvtlevel;		/* convert to newer file system format */
196 int	doinglevel1;		/* converting to new cylinder group format */
197 int	doinglevel2;		/* converting to new inode format */
198 int	newinofmt;		/* filesystem has new inode format */
199 char	usedsoftdep;		/* just fix soft dependency inconsistencies */
200 char	preen;			/* just fix normal inconsistencies */
201 char	rerun;			/* rerun fsck. Only used in non-preen mode */
202 int	returntosingle;		/* 1 => return to single user mode on exit */
203 char	resolved;		/* cleared if unresolved changes => not clean */
204 char	hotroot;		/* checking root device */
205 char	havesb;			/* superblock has been read */
206 int	fsmodified;		/* 1 => write done to file system */
207 int	fsreadfd;		/* file descriptor for reading file system */
208 int	fswritefd;		/* file descriptor for writing file system */
209 
210 ufs_daddr_t maxfsblock;		/* number of blocks in the file system */
211 char	*blockmap;		/* ptr to primary blk allocation map */
212 ino_t	maxino;			/* number of inodes in file system */
213 
214 ino_t	lfdir;			/* lost & found directory inode number */
215 char	*lfname;		/* lost & found directory name */
216 int	lfmode;			/* lost & found directory creation mode */
217 
218 ufs_daddr_t n_blks;		/* number of blocks in use */
219 ufs_daddr_t n_files;		/* number of files in use */
220 
221 #define	clearinode(dp)	(*(dp) = zino)
222 struct	dinode zino;
223 
224 #define	setbmap(blkno)	setbit(blockmap, blkno)
225 #define	testbmap(blkno)	isset(blockmap, blkno)
226 #define	clrbmap(blkno)	clrbit(blockmap, blkno)
227 
228 #define	STOP	0x01
229 #define	SKIP	0x02
230 #define	KEEPON	0x04
231 #define	ALTERED	0x08
232 #define	FOUND	0x10
233 
234 #define	EEXIT	8		/* Standard error exit. */
235 
236 struct fstab;
237 
238 
239 void		adjust __P((struct inodesc *, int lcnt));
240 ufs_daddr_t	allocblk __P((long frags));
241 ino_t		allocdir __P((ino_t parent, ino_t request, int mode));
242 ino_t		allocino __P((ino_t request, int type));
243 void		blkerror __P((ino_t ino, char *type, ufs_daddr_t blk));
244 char	       *blockcheck __P((char *name));
245 int		bread __P((int fd, char *buf, ufs_daddr_t blk, long size));
246 void		bufinit __P((void));
247 void		bwrite __P((int fd, char *buf, ufs_daddr_t blk, long size));
248 void		cacheino __P((struct dinode *dp, ino_t inumber));
249 void		catch __P((int));
250 void		catchquit __P((int));
251 int		changeino __P((ino_t dir, char *name, ino_t newnum));
252 int		checkfstab __P((int preen, int maxrun,
253 			int (*docheck)(struct fstab *),
254 			int (*chkit)(char *, char *, long, int)));
255 int		chkrange __P((ufs_daddr_t blk, int cnt));
256 void		ckfini __P((int markclean));
257 int		ckinode __P((struct dinode *dp, struct inodesc *));
258 void		clri __P((struct inodesc *, char *type, int flag));
259 int		clearentry __P((struct inodesc *));
260 void		direrror __P((ino_t ino, char *errmesg));
261 int		dirscan __P((struct inodesc *));
262 int		dofix __P((struct inodesc *, char *msg));
263 void		ffs_clrblock __P((struct fs *, u_char *, ufs_daddr_t));
264 void		ffs_fragacct __P((struct fs *, int, int32_t [], int));
265 int		ffs_isblock __P((struct fs *, u_char *, ufs_daddr_t));
266 void		ffs_setblock __P((struct fs *, u_char *, ufs_daddr_t));
267 void		fileerror __P((ino_t cwd, ino_t ino, char *errmesg));
268 int		findino __P((struct inodesc *));
269 int		findname __P((struct inodesc *));
270 void		flush __P((int fd, struct bufarea *bp));
271 void		freeblk __P((ufs_daddr_t blkno, long frags));
272 void		freeino __P((ino_t ino));
273 void		freeinodebuf __P((void));
274 int		ftypeok __P((struct dinode *dp));
275 void		getblk __P((struct bufarea *bp, ufs_daddr_t blk, long size));
276 struct bufarea *getdatablk __P((ufs_daddr_t blkno, long size));
277 struct inoinfo *getinoinfo __P((ino_t inumber));
278 struct dinode  *getnextinode __P((ino_t inumber));
279 void		getpathname __P((char *namebuf, ino_t curdir, ino_t ino));
280 struct dinode  *ginode __P((ino_t inumber));
281 void		inocleanup __P((void));
282 void		inodirty __P((void));
283 struct inostat *inoinfo __P((ino_t inum));
284 int		linkup __P((ino_t orphan, ino_t parentdir, char *name));
285 int		makeentry __P((ino_t parent, ino_t ino, char *name));
286 void		panic __P((const char *fmt, ...));
287 void		pass1 __P((void));
288 void		pass1b __P((void));
289 int		pass1check __P((struct inodesc *));
290 void		pass2 __P((void));
291 void		pass3 __P((void));
292 void		pass4 __P((void));
293 int		pass4check __P((struct inodesc *));
294 void		pass5 __P((void));
295 void		pfatal __P((const char *fmt, ...));
296 void		pinode __P((ino_t ino));
297 void		propagate __P((void));
298 void		pwarn __P((const char *fmt, ...));
299 int		reply __P((char *question));
300 void		setinodebuf __P((ino_t));
301 int		setup __P((char *dev));
302 void		voidquit __P((int));
303