xref: /netbsd/sbin/fsck_ffs/fsck.h (revision bf9ec67e)
1 /*	$NetBSD: fsck.h,v 1.28 2002/05/06 03:17:43 lukem Exp $	*/
2 
3 /*
4  * Copyright (c) 1980, 1986, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the University of
18  *	California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *	@(#)fsck.h	8.4 (Berkeley) 5/9/95
36  */
37 
38 #include <stdio.h>
39 #include <machine/bswap.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 #ifndef BUFSIZ
47 #define BUFSIZ 1024
48 #endif
49 
50 #define	USTATE	01		/* inode not allocated */
51 #define	FSTATE	02		/* inode is file */
52 #define	DSTATE	03		/* inode is directory */
53 #define	DFOUND	04		/* directory found during descent */
54 #define	DCLEAR	05		/* directory is to be cleared */
55 #define	FCLEAR	06		/* file is to be cleared */
56 #define	DMARK	07		/* used in propagate()'s traversal algorithm */
57 
58 /*
59  * buffer cache structure.
60  */
61 struct bufarea {
62 	struct bufarea *b_next;		/* free list queue */
63 	struct bufarea *b_prev;		/* free list queue */
64 	ufs_daddr_t b_bno;
65 	int b_size;
66 	int b_errs;
67 	int b_flags;
68 	union {
69 		char *b_buf;			/* buffer space */
70 		ufs_daddr_t *b_indir;		/* indirect block */
71 		struct fs *b_fs;		/* super block */
72 		struct cg *b_cg;		/* cylinder group */
73 	} b_un;
74 	char b_dirty;
75 };
76 
77 #define	B_INUSE 1
78 
79 #define	MINBUFS		5	/* minimum number of buffers required */
80 struct bufarea bufhead;		/* head of list of other blks in filesys */
81 struct bufarea sblk;		/* file system superblock */
82 struct bufarea asblk;		/* file system superblock */
83 struct bufarea cgblk;		/* cylinder group blocks */
84 struct bufarea *pdirbp;		/* current directory contents */
85 struct bufarea *pbp;		/* current inode block */
86 
87 #define	dirty(bp)	(bp)->b_dirty = 1
88 #define	initbarea(bp) \
89 	(bp)->b_dirty = 0; \
90 	(bp)->b_bno = (ufs_daddr_t)-1; \
91 	(bp)->b_flags = 0;
92 
93 struct fs *sblock;
94 struct fs *altsblock;
95 struct cg *cgrp;
96 #define	sbdirty() \
97 	do { \
98 		memmove(sblk.b_un.b_fs, sblock, SBSIZE); \
99 		if (needswap) \
100 			ffs_sb_swap(sblock, sblk.b_un.b_fs); \
101 		sblk.b_dirty = 1; \
102 	} while (0)
103 #define	cgdirty()	do {copyback_cg(&cgblk); cgblk.b_dirty = 1;} while (0)
104 
105 enum fixstate {DONTKNOW, NOFIX, FIX, IGNORE};
106 
107 struct inodesc {
108 	enum fixstate id_fix;	/* policy on fixing errors */
109 	int (*id_func)		/* function to be applied to blocks of inode */
110 	    __P((struct inodesc *));
111 	ino_t id_number;	/* inode number described */
112 	ino_t id_parent;	/* for DATA nodes, their parent */
113 	ufs_daddr_t id_blkno;	/* current block number being examined */
114 	int id_numfrags;	/* number of frags contained in block */
115 	int64_t id_filesize;	/* for DATA nodes, the size of the directory */
116 	int id_loc;		/* for DATA nodes, current location in dir */
117 	int id_entryno;		/* for DATA nodes, current entry number */
118 	struct direct *id_dirp;	/* for DATA nodes, ptr to current entry */
119 	char *id_name;		/* for DATA nodes, name to find or enter */
120 	char id_type;		/* type of descriptor, DATA or ADDR */
121 };
122 /* file types */
123 #define	DATA	1
124 #define	ADDR	2
125 
126 /*
127  * Linked list of duplicate blocks.
128  *
129  * The list is composed of two parts. The first part of the
130  * list (from duplist through the node pointed to by muldup)
131  * contains a single copy of each duplicate block that has been
132  * found. The second part of the list (from muldup to the end)
133  * contains duplicate blocks that have been found more than once.
134  * To check if a block has been found as a duplicate it is only
135  * necessary to search from duplist through muldup. To find the
136  * total number of times that a block has been found as a duplicate
137  * the entire list must be searched for occurences of the block
138  * in question. The following diagram shows a sample list where
139  * w (found twice), x (found once), y (found three times), and z
140  * (found once) are duplicate block numbers:
141  *
142  *    w -> y -> x -> z -> y -> w -> y
143  *    ^		     ^
144  *    |		     |
145  * duplist	  muldup
146  */
147 struct dups {
148 	struct dups *next;
149 	ufs_daddr_t dup;
150 };
151 struct dups *duplist;		/* head of dup list */
152 struct dups *muldup;		/* end of unique duplicate dup block numbers */
153 
154 /*
155  * Linked list of inodes with zero link counts.
156  */
157 struct zlncnt {
158 	struct zlncnt *next;
159 	ino_t zlncnt;
160 };
161 struct zlncnt *zlnhead;		/* head of zero link count list */
162 
163 /*
164  * Inode cache data structures.
165  */
166 struct inoinfo {
167 	struct	inoinfo *i_nexthash;	/* next entry in hash chain */
168 	struct	inoinfo	*i_child, *i_sibling, *i_parentp;
169 	ino_t	i_number;		/* inode number of this entry */
170 	ino_t	i_parent;		/* inode number of parent */
171 	ino_t	i_dotdot;		/* inode number of `..' */
172 	size_t	i_isize;		/* size of inode */
173 	u_int	i_numblks;		/* size of block array in bytes */
174 	ufs_daddr_t i_blks[1];		/* actually longer */
175 } **inphead, **inpsort;
176 long numdirs, listmax, inplast;
177 
178 long	dev_bsize;		/* computed value of DEV_BSIZE */
179 long	secsize;		/* actual disk sector size */
180 char	nflag;			/* assume a no response */
181 char	yflag;			/* assume a yes response */
182 int	bflag;			/* location of alternate super block */
183 int	debug;			/* output debugging info */
184 int	cvtlevel;		/* convert to newer file system format */
185 int	doinglevel1;		/* converting to new cylinder group format */
186 int	doinglevel2;		/* converting to new inode format */
187 int	newinofmt;		/* filesystem has new inode format */
188 char	usedsoftdep;		/* just fix soft dependency inconsistencies */
189 int	preen;			/* just fix normal inconsistencies */
190 int	forceimage;		/* file system is an image file */
191 int	doswap;			/* convert byte order */
192 int	needswap;		/* need to convert byte order in memory */
193 int	do_blkswap;		/* need to do block addr byteswap */
194 int	do_dirswap;		/* need to do dir entry byteswap */
195 int	endian;			/* endian coversion */
196 int	markclean;		/* mark file system clean when done */
197 char	havesb;			/* superblock has been read */
198 char	skipclean;		/* skip clean file systems if preening */
199 int	fsmodified;		/* 1 => write done to file system */
200 int	fsreadfd;		/* file descriptor for reading file system */
201 int	fswritefd;		/* file descriptor for writing file system */
202 int	rerun;			/* rerun fsck.  Only used in non-preen mode */
203 char	resolved;		/* cleared if unresolved changes => not clean */
204 
205 ufs_daddr_t maxfsblock;		/* number of blocks in the file system */
206 char	*blockmap;		/* ptr to primary blk allocation map */
207 ino_t	maxino;			/* number of inodes in file system */
208 ino_t	lastino;		/* last inode in use */
209 char	*statemap;		/* ptr to inode state table */
210 u_char	*typemap;		/* ptr to inode type table */
211 int16_t	*lncntp;		/* ptr to link count table */
212 
213 extern ino_t	lfdir;		/* lost & found directory inode number */
214 extern char	*lfname;	/* lost & found directory name */
215 extern int	lfmode;		/* lost & found directory creation mode */
216 
217 ufs_daddr_t n_blks;		/* number of blocks in use */
218 ufs_daddr_t n_files;		/* number of files in use */
219 
220 int	got_siginfo;		/* received a SIGINFO */
221 
222 #define	clearinode(dp)	(*(dp) = zino)
223 struct	dinode zino;
224 
225 #define	setbmap(blkno)	setbit(blockmap, blkno)
226 #define	testbmap(blkno)	isset(blockmap, blkno)
227 #define	clrbmap(blkno)	clrbit(blockmap, blkno)
228 
229 #define	STOP	0x01
230 #define	SKIP	0x02
231 #define	KEEPON	0x04
232 #define	ALTERED	0x08
233 #define	FOUND	0x10
234 
235 #define	EEXIT	8		/* Standard error exit. */
236 
237 /* some inline functs to help the byte-swapping mess */
238 static __inline u_int16_t iswap16 __P((u_int16_t));
239 static __inline u_int32_t iswap32 __P((u_int32_t));
240 static __inline u_int64_t iswap64 __P((u_int64_t));
241 
242 static __inline u_int16_t iswap16(x)
243 	u_int16_t x;
244 {
245 	if (needswap)
246 		return bswap16(x);
247 	else return x;
248 }
249 
250 static __inline u_int32_t iswap32(x)
251 	u_int32_t x;
252 {
253 	if (needswap)
254 		return bswap32(x);
255 	else return x;
256 }
257 
258 static __inline u_int64_t iswap64(x)
259 	u_int64_t x;
260 {
261 	if (needswap)
262 		return bswap64(x);
263 	else return x;
264 }
265