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