xref: /openbsd-src/sbin/fsck_ext2fs/fsck.h (revision 2b0358df1d88d06ef4139321dd05bd5e05d91eaf)
1 /*	$OpenBSD: fsck.h,v 1.9 2005/04/30 13:56:16 niallo 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. 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	80*1024	/* maximum space to allocate to buffers */
39 #define	INOBUFSIZE	128*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	ext2fs *b_fs;		/* super block */
66 		struct	ext2_gd *b_cgd;		/* cylinder group descriptor */
67 		struct	ext2fs_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 asblk;		/* first alternate superblock */
78 struct bufarea *pdirbp;		/* current directory contents */
79 struct bufarea *pbp;		/* current inode block */
80 struct bufarea *getdatablk(daddr_t, long);
81 struct m_ext2fs sblock;
82 
83 #define	dirty(bp)	(bp)->b_dirty = 1
84 #define	initbarea(bp) \
85 	(bp)->b_dirty = 0; \
86 	(bp)->b_bno = (daddr_t)-1; \
87 	(bp)->b_flags = 0;
88 
89 #define	sbdirty()	copyback_sb(&sblk); sblk.b_dirty = 1
90 
91 enum fixstate {DONTKNOW, NOFIX, FIX, IGNORE};
92 
93 struct inodesc {
94 	enum fixstate id_fix;	/* policy on fixing errors */
95 	int (*id_func)		/* function to be applied to blocks of inode */
96 (struct inodesc *);
97 	ino_t id_number;	/* inode number described */
98 	ino_t id_parent;	/* for DATA nodes, their parent */
99 	daddr_t id_blkno;	/* current block number being examined */
100 	int id_numfrags;	/* number of frags contained in block */
101 	quad_t id_filesize;	/* for DATA nodes, the size of the directory */
102 	int id_loc;		/* for DATA nodes, current location in dir */
103 	int id_entryno;		/* for DATA nodes, current entry number */
104 	struct ext2fs_direct *id_dirp;	/* for DATA nodes, ptr to current entry */
105 	char *id_name;		/* for DATA nodes, name to find or enter */
106 	char id_type;		/* type of descriptor, DATA or ADDR */
107 };
108 /* file types */
109 #define	DATA	1
110 #define	ADDR	2
111 
112 /*
113  * Linked list of duplicate blocks.
114  *
115  * The list is composed of two parts. The first part of the
116  * list (from duplist through the node pointed to by muldup)
117  * contains a single copy of each duplicate block that has been
118  * found. The second part of the list (from muldup to the end)
119  * contains duplicate blocks that have been found more than once.
120  * To check if a block has been found as a duplicate it is only
121  * necessary to search from duplist through muldup. To find the
122  * total number of times that a block has been found as a duplicate
123  * the entire list must be searched for occurrences of the block
124  * in question. The following diagram shows a sample list where
125  * w (found twice), x (found once), y (found three times), and z
126  * (found once) are duplicate block numbers:
127  *
128  *    w -> y -> x -> z -> y -> w -> y
129  *    ^		     ^
130  *    |		     |
131  * duplist	  muldup
132  */
133 struct dups {
134 	struct dups *next;
135 	daddr_t dup;
136 };
137 struct dups *duplist;		/* head of dup list */
138 struct dups *muldup;		/* end of unique duplicate dup block numbers */
139 
140 /*
141  * Linked list of inodes with zero link counts.
142  */
143 struct zlncnt {
144 	struct zlncnt *next;
145 	ino_t zlncnt;
146 };
147 struct zlncnt *zlnhead;		/* head of zero link count list */
148 
149 /*
150  * Inode cache data structures.
151  */
152 struct inoinfo {
153 	struct	inoinfo *i_nexthash;	/* next entry in hash chain */
154 	struct	inoinfo	*i_child, *i_sibling, *i_parentp;
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 	u_int64_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 long	dev_bsize;		/* computed value of DEV_BSIZE */
165 long	secsize;		/* actual disk sector size */
166 char	nflag;			/* assume a no response */
167 char	yflag;			/* assume a yes response */
168 int	bflag;			/* location of alternate super block */
169 int	debug;			/* output debugging info */
170 int	preen;			/* just fix normal inconsistencies */
171 char	havesb;			/* superblock has been read */
172 char	skipclean;		/* skip clean file systems if preening */
173 int	fsmodified;		/* 1 => write done to file system */
174 int	fsreadfd;		/* file descriptor for reading file system */
175 int	fswritefd;		/* file descriptor for writing file system */
176 int	rerun;			/* rerun fsck.  Only used in non-preen mode */
177 
178 daddr_t	maxfsblock;		/* number of blocks in the file system */
179 char	*blockmap;		/* ptr to primary blk allocation map */
180 ino_t	maxino;			/* number of inodes in file system */
181 ino_t	lastino;		/* last inode in use */
182 char	*statemap;		/* ptr to inode state table */
183 u_char	*typemap;		/* ptr to inode type table */
184 int16_t	*lncntp;		/* ptr to link count table */
185 
186 ino_t	lfdir;			/* lost & found directory inode number */
187 char	*lfname;		/* lost & found directory name */
188 int	lfmode;			/* lost & found directory creation mode */
189 
190 daddr_t	n_blks;			/* number of blocks in use */
191 daddr_t	n_files;		/* number of files in use */
192 
193 #define	clearinode(dp)	(*(dp) = zino)
194 struct	ext2fs_dinode zino;
195 
196 #define	setbmap(blkno)	setbit(blockmap, blkno)
197 #define	testbmap(blkno)	isset(blockmap, blkno)
198 #define	clrbmap(blkno)	clrbit(blockmap, blkno)
199 
200 #define	STOP	0x01
201 #define	SKIP	0x02
202 #define	KEEPON	0x04
203 #define	ALTERED	0x08
204 #define	FOUND	0x10
205 
206 struct ext2fs_dinode *ginode(ino_t);
207 struct inoinfo *getinoinfo(ino_t);
208 void getblk(struct bufarea *, daddr_t, long);
209 ino_t allocino(ino_t, int);
210 void copyback_sb(struct bufarea*);
211 daddr_t cgoverhead(int);	/* overhead per cg */
212