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