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