xref: /openbsd-src/sbin/fsck_ext2fs/fsck.h (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1 /*	$OpenBSD: fsck.h,v 1.4 2000/04/26 23:26:05 jasoni Exp $	*/
2 /*	$NetBSD: fsck.h,v 1.1 1997/06/11 11:21:47 bouyer Exp $	*/
3 
4 /*
5  * Copyright (c) 1997 Manuel Bouyer.
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 #define	MAXDUP		10	/* limit on dup blks (per inode) */
41 #define	MAXBAD		10	/* limit on bad blks (per inode) */
42 #define	MAXBUFSPACE	80*1024	/* maximum space to allocate to buffers */
43 #define	INOBUFSIZE	128*1024	/* size of buffer to read inodes in pass1 */
44 
45 #ifndef BUFSIZ
46 #define BUFSIZ 1024
47 #endif
48 
49 #define	USTATE	01		/* inode not allocated */
50 #define	FSTATE	02		/* inode is file */
51 #define	DSTATE	03		/* inode is directory */
52 #define	DFOUND	04		/* directory found during descent */
53 #define	DCLEAR	05		/* directory is to be cleared */
54 #define	FCLEAR	06		/* file is to be cleared */
55 
56 /*
57  * buffer cache structure.
58  */
59 struct bufarea {
60 	struct bufarea	*b_next;		/* free list queue */
61 	struct bufarea	*b_prev;		/* free list queue */
62 	daddr_t	b_bno;
63 	int	b_size;
64 	int	b_errs;
65 	int	b_flags;
66 	union {
67 		char	*b_buf;			/* buffer space */
68 		daddr_t	*b_indir;		/* indirect block */
69 		struct	ext2fs *b_fs;		/* super block */
70 		struct	ext2_gd *b_cgd;		/* cylinder group descriptor */
71 		struct	ext2fs_dinode *b_dinode;	/* inode block */
72 	} b_un;
73 	char	b_dirty;
74 };
75 
76 #define	B_INUSE 1
77 
78 #define	MINBUFS		5	/* minimum number of buffers required */
79 struct bufarea bufhead;		/* head of list of other blks in filesys */
80 struct bufarea sblk;		/* file system superblock */
81 struct bufarea asblk;		/* first alternate superblock */
82 struct bufarea *pdirbp;		/* current directory contents */
83 struct bufarea *pbp;		/* current inode block */
84 struct bufarea *getdatablk __P((daddr_t, long));
85 struct m_ext2fs sblock;
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	sbdirty()	copyback_sb(&sblk); sblk.b_dirty = 1
94 
95 enum fixstate {DONTKNOW, NOFIX, FIX, IGNORE};
96 
97 struct inodesc {
98 	enum fixstate id_fix;	/* policy on fixing errors */
99 	int (*id_func)		/* function to be applied to blocks of inode */
100 	    __P((struct inodesc *));
101 	ino_t id_number;	/* inode number described */
102 	ino_t id_parent;	/* for DATA nodes, their parent */
103 	daddr_t id_blkno;	/* current block number being examined */
104 	int id_numfrags;	/* number of frags contained in block */
105 	quad_t id_filesize;	/* for DATA nodes, the size of the directory */
106 	int id_loc;		/* for DATA nodes, current location in dir */
107 	int id_entryno;		/* for DATA nodes, current entry number */
108 	struct ext2fs_direct *id_dirp;	/* for DATA nodes, ptr to current entry */
109 	char *id_name;		/* for DATA nodes, name to find or enter */
110 	char id_type;		/* type of descriptor, DATA or ADDR */
111 };
112 /* file types */
113 #define	DATA	1
114 #define	ADDR	2
115 
116 /*
117  * Linked list of duplicate blocks.
118  *
119  * The list is composed of two parts. The first part of the
120  * list (from duplist through the node pointed to by muldup)
121  * contains a single copy of each duplicate block that has been
122  * found. The second part of the list (from muldup to the end)
123  * contains duplicate blocks that have been found more than once.
124  * To check if a block has been found as a duplicate it is only
125  * necessary to search from duplist through muldup. To find the
126  * total number of times that a block has been found as a duplicate
127  * the entire list must be searched for occurences of the block
128  * in question. The following diagram shows a sample list where
129  * w (found twice), x (found once), y (found three times), and z
130  * (found once) are duplicate block numbers:
131  *
132  *    w -> y -> x -> z -> y -> w -> y
133  *    ^		     ^
134  *    |		     |
135  * duplist	  muldup
136  */
137 struct dups {
138 	struct dups *next;
139 	daddr_t dup;
140 };
141 struct dups *duplist;		/* head of dup list */
142 struct dups *muldup;		/* end of unique duplicate dup block numbers */
143 
144 /*
145  * Linked list of inodes with zero link counts.
146  */
147 struct zlncnt {
148 	struct zlncnt *next;
149 	ino_t zlncnt;
150 };
151 struct zlncnt *zlnhead;		/* head of zero link count list */
152 
153 /*
154  * Inode cache data structures.
155  */
156 struct inoinfo {
157 	struct	inoinfo *i_nexthash;	/* next entry in hash chain */
158 	struct	inoinfo	*i_child, *i_sibling, *i_parentp;
159 	ino_t	i_number;		/* inode number of this entry */
160 	ino_t	i_parent;		/* inode number of parent */
161 	ino_t	i_dotdot;		/* inode number of `..' */
162 	size_t	i_isize;		/* size of inode */
163 	u_int	i_numblks;		/* size of block array in bytes */
164 	daddr_t	i_blks[1];		/* actually longer */
165 } **inphead, **inpsort;
166 long numdirs, listmax, inplast;
167 
168 long	dev_bsize;		/* computed value of DEV_BSIZE */
169 long	secsize;		/* actual disk sector size */
170 char	nflag;			/* assume a no response */
171 char	yflag;			/* assume a yes response */
172 int	bflag;			/* location of alternate super block */
173 int	debug;			/* output debugging info */
174 int	preen;			/* just fix normal inconsistencies */
175 char	havesb;			/* superblock has been read */
176 char	skipclean;		/* skip clean file systems if preening */
177 int	fsmodified;		/* 1 => write done to file system */
178 int	fsreadfd;		/* file descriptor for reading file system */
179 int	fswritefd;		/* file descriptor for writing file system */
180 int	rerun;			/* rerun fsck.  Only used in non-preen mode */
181 
182 daddr_t	maxfsblock;		/* number of blocks in the file system */
183 char	*blockmap;		/* ptr to primary blk allocation map */
184 ino_t	maxino;			/* number of inodes in file system */
185 ino_t	lastino;		/* last inode in use */
186 char	*statemap;		/* ptr to inode state table */
187 u_char	*typemap;		/* ptr to inode type table */
188 int16_t	*lncntp;		/* ptr to link count table */
189 
190 ino_t	lfdir;			/* lost & found directory inode number */
191 char	*lfname;		/* lost & found directory name */
192 int	lfmode;			/* lost & found directory creation mode */
193 
194 daddr_t	n_blks;			/* number of blocks in use */
195 daddr_t	n_files;		/* number of files in use */
196 
197 #define	clearinode(dp)	(*(dp) = zino)
198 struct	ext2fs_dinode zino;
199 
200 #define	setbmap(blkno)	setbit(blockmap, blkno)
201 #define	testbmap(blkno)	isset(blockmap, blkno)
202 #define	clrbmap(blkno)	clrbit(blockmap, blkno)
203 
204 #define	STOP	0x01
205 #define	SKIP	0x02
206 #define	KEEPON	0x04
207 #define	ALTERED	0x08
208 #define	FOUND	0x10
209 
210 struct ext2fs_dinode *ginode __P((ino_t));
211 struct inoinfo *getinoinfo __P((ino_t));
212 void getblk __P((struct bufarea *, daddr_t, long));
213 ino_t allocino __P((ino_t, int));
214 void copyback_sb __P((struct bufarea*));
215 daddr_t cgoverhead __P((int));	/* overhead per cg */
216