1/*	$NetBSD$	*/
2
3/*
4 * Copyright (c) 1980, 1986, 1993
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 *
8 * This software was developed for the FreeBSD Project by Marshall
9 * Kirk McKusick and Network Associates Laboratories, the Security
10 * Research Division of Network Associates, Inc. under DARPA/SPAWAR
11 * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
12 * research program
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
16 * are met:
17 * 1. Redistributions of source code must retain the above copyright
18 *    notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 *    notice, this list of conditions and the following disclaimer in the
21 *    documentation and/or other materials provided with the distribution.
22 * 3. Neither the name of the University nor the names of its contributors
23 *    may be used to endorse or promote products derived from this software
24 *    without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * SUCH DAMAGE.
37 *
38 *	@(#)fsck.h	8.4 (Berkeley) 5/9/95
39 */
40
41#include <stdio.h>
42#include <sys/queue.h>
43#include <machine/bswap.h>
44
45#ifdef PROGRESS
46#include "progress.h"
47#endif /* PROGRESS */
48
49#define	MAXDUP		10	/* limit on dup blks (per inode) */
50#define	MAXBAD		10	/* limit on bad blks (per inode) */
51#define	MAXBUFSPACE	40*1024	/* maximum space to allocate to buffers */
52#define	INOBUFSIZE	56*1024	/* size of buffer to read inodes in pass1 */
53
54union dinode {
55	struct ufs1_dinode dp1;
56	struct ufs2_dinode dp2;
57};
58#define       DIP(dp, field) \
59	(is_ufs2 ? (dp)->dp2.di_##field : (dp)->dp1.di_##field)
60
61#define       DIP_SET(dp, field, val) do {	\
62	if (is_ufs2)				\
63		(dp)->dp2.di_##field = (val);	\
64	else					\
65		(dp)->dp1.di_##field = (val);	\
66} while (0)
67
68#ifndef BUFSIZ
69#define BUFSIZ 1024
70#endif
71
72/*
73 * Each inode on the filesystem is described by the following structure.
74 * The linkcnt is initially set to the value in the inode. Each time it
75 * is found during the descent in passes 2, 3, and 4 the count is
76 * decremented. Any inodes whose count is non-zero after pass 4 needs to
77 * have its link count adjusted by the value remaining in ino_linkcnt.
78 */
79struct inostat {
80	char    ino_state;	/* state of inode, see below */
81	char    ino_type;	/* type of inode */
82	short   ino_linkcnt;	/* number of links not found */
83};
84/*
85 * Inode states.
86 */
87#define	USTATE	01		/* inode not allocated */
88#define	FSTATE	02		/* inode is file */
89#define	DSTATE	03		/* inode is directory */
90#define	DFOUND	04		/* directory found during descent */
91#define	DCLEAR	05		/* directory is to be cleared */
92#define	FCLEAR	06		/* file is to be cleared */
93#define	DMARK	07		/* used in propagate()'s traversal algorithm */
94
95/*
96 * Inode state information is contained on per cylinder group lists
97 * which are described by the following structure.
98 */
99struct inostatlist {
100	long    il_numalloced;  /* number of inodes allocated in this cg */
101	struct inostat *il_stat;/* inostat info for this cylinder group */
102} *inostathead;
103
104
105/*
106 * buffer cache structure.
107 */
108struct bufarea {
109	struct bufarea *b_next;		/* free list queue */
110	struct bufarea *b_prev;		/* free list queue */
111	daddr_t b_bno;
112	int b_size;
113	int b_errs;
114	int b_flags;
115	union {
116		char *b_buf;			/* buffer space */
117		int32_t *b_indir1;		/* indirect block */
118		int64_t *b_indir2;		/* indirect block */
119		struct fs *b_fs;		/* super block */
120		struct cg *b_cg;		/* cylinder group */
121		struct ufs1_dinode *b_dinode1;	/* UFS1 inode block */
122		struct ufs2_dinode *b_dinode2;	/* UFS2 inode block */
123		struct appleufslabel *b_appleufs;		/* Apple UFS volume label */
124	} b_un;
125	char b_dirty;
126};
127
128#define       IBLK(bp, i) \
129	(is_ufs2 ?  (bp)->b_un.b_indir2[i] : (bp)->b_un.b_indir1[i])
130
131#define       IBLK_SET(bp, i, val) do {		\
132	if (is_ufs2)				\
133		(bp)->b_un.b_indir2[i] = (val);	\
134	else					\
135		(bp)->b_un.b_indir1[i] = (val);	\
136} while (0)
137
138#define	B_INUSE 1
139
140#define	MINBUFS		5	/* minimum number of buffers required */
141struct bufarea bufhead;		/* head of list of other blks in filesys */
142struct bufarea sblk;		/* file system superblock */
143struct bufarea asblk;		/* file system superblock */
144struct bufarea cgblk;		/* cylinder group blocks */
145struct bufarea appleufsblk;		/* Apple UFS volume label */
146struct bufarea *pdirbp;		/* current directory contents */
147struct bufarea *pbp;		/* current inode block */
148
149#define	dirty(bp)	(bp)->b_dirty = 1
150#define	initbarea(bp) \
151	(bp)->b_dirty = 0; \
152	(bp)->b_bno = (daddr_t)-1; \
153	(bp)->b_flags = 0;
154
155struct fs *sblock;
156struct fs *altsblock;
157struct cg *cgrp;
158struct fs *sblocksave;
159#define	sbdirty() \
160	do { \
161		memmove(sblk.b_un.b_fs, sblock, SBLOCKSIZE); \
162		sb_oldfscompat_write(sblk.b_un.b_fs, sblocksave); \
163		if (needswap) \
164			ffs_sb_swap(sblk.b_un.b_fs, sblk.b_un.b_fs); \
165		sblk.b_dirty = 1; \
166	} while (0)
167#define	cgdirty()	do {copyback_cg(&cgblk); cgblk.b_dirty = 1;} while (0)
168
169#define appleufsdirty() \
170	do { \
171		appleufsblk.b_un.b_appleufs->ul_checksum = 0; \
172		appleufsblk.b_un.b_appleufs->ul_checksum =  \
173			ffs_appleufs_cksum(appleufsblk.b_un.b_appleufs); \
174		appleufsblk.b_dirty = 1; \
175	} while (0)
176
177enum fixstate {DONTKNOW, NOFIX, FIX, IGNORE};
178
179struct inodesc {
180	enum fixstate id_fix;	/* policy on fixing errors */
181	int (*id_func)		/* function to be applied to blocks of inode */
182	    (struct inodesc *);
183	ino_t id_number;	/* inode number described */
184	ino_t id_parent;	/* for DATA nodes, their parent */
185	daddr_t id_blkno;	/* current block number being examined */
186	int id_numfrags;	/* number of frags contained in block */
187	int64_t id_filesize;	/* for DATA nodes, the size of the directory */
188	int id_loc;		/* for DATA nodes, current location in dir */
189	int64_t id_entryno;	/* for DATA nodes, current entry number */
190	struct direct *id_dirp;	/* for DATA nodes, ptr to current entry */
191	const char *id_name;	/* for DATA nodes, name to find or enter */
192	char id_type;		/* type of descriptor, DATA or ADDR */
193	uid_t id_uid;		/* ownerchip of inode described */
194	gid_t id_gid;
195};
196/* file types */
197#define	DATA	1
198#define	SNAP	2
199#define	ADDR	3
200
201/*
202 * Linked list of duplicate blocks.
203 *
204 * The list is composed of two parts. The first part of the
205 * list (from duplist through the node pointed to by muldup)
206 * contains a single copy of each duplicate block that has been
207 * found. The second part of the list (from muldup to the end)
208 * contains duplicate blocks that have been found more than once.
209 * To check if a block has been found as a duplicate it is only
210 * necessary to search from duplist through muldup. To find the
211 * total number of times that a block has been found as a duplicate
212 * the entire list must be searched for occurrences of the block
213 * in question. The following diagram shows a sample list where
214 * w (found twice), x (found once), y (found three times), and z
215 * (found once) are duplicate block numbers:
216 *
217 *    w -> y -> x -> z -> y -> w -> y
218 *    ^		     ^
219 *    |		     |
220 * duplist	  muldup
221 */
222struct dups {
223	struct dups *next;
224	daddr_t dup;
225};
226struct dups *duplist;		/* head of dup list */
227struct dups *muldup;		/* end of unique duplicate dup block numbers */
228
229/*
230 * Linked list of inodes with zero link counts.
231 */
232struct zlncnt {
233	struct zlncnt *next;
234	ino_t zlncnt;
235};
236struct zlncnt *zlnhead;		/* head of zero link count list */
237
238/*
239 * Inode cache data structures.
240 */
241struct inoinfo {
242	struct	inoinfo *i_nexthash;	/* next entry in hash chain */
243	struct	inoinfo	*i_child, *i_sibling;
244	ino_t	i_number;		/* inode number of this entry */
245	ino_t	i_parent;		/* inode number of parent */
246	ino_t	i_dotdot;		/* inode number of `..' */
247	size_t	i_isize;		/* size of inode */
248	u_int	i_numblks;		/* size of block array in bytes */
249	int64_t i_blks[1];		/* actually longer */
250} **inphead, **inpsort;
251long numdirs, dirhash, listmax, inplast;
252
253/*
254 * quota usage structures
255 */
256struct uquot {
257	uint64_t  uq_b; /* block usage */
258	uint64_t  uq_i; /* inode usage */
259	SLIST_ENTRY(uquot) uq_entries;
260	uint32_t uq_uid; /* uid/gid of the owner */
261};
262SLIST_HEAD(uquot_hash, uquot);
263struct uquot_hash *uquot_user_hash;
264struct uquot_hash *uquot_group_hash;
265uint8_t q2h_hash_shift;
266uint16_t q2h_hash_mask;
267
268long	dev_bsize;		/* computed value of DEV_BSIZE */
269long	secsize;		/* actual disk sector size */
270char	nflag;			/* assume a no response */
271char	yflag;			/* assume a yes response */
272int	Uflag;			/* resolve user names */
273int	bflag;			/* location of alternate super block */
274int	debug;			/* output debugging info */
275int	cvtlevel;		/* convert to newer file system format */
276int	doinglevel1;		/* converting to new cylinder group format */
277int	doinglevel2;		/* converting to new inode format */
278int	newinofmt;		/* filesystem has new inode format */
279char	usedsoftdep;		/* just fix soft dependency inconsistencies */
280int	preen;			/* just fix normal inconsistencies */
281int	quiet;			/* Don't print anything if clean */
282int	forceimage;		/* file system is an image file */
283int	doswap;			/* convert byte order */
284int	needswap;		/* need to convert byte order in memory */
285int	is_ufs2;		/* we're dealing with an UFS2 filesystem */
286int	do_blkswap;		/* need to do block addr byteswap */
287int	do_dirswap;		/* need to do dir entry byteswap */
288int	endian;			/* endian coversion */
289int	markclean;		/* mark file system clean when done */
290char	havesb;			/* superblock has been read */
291char	skipclean;		/* skip clean file systems if preening */
292int	fsmodified;		/* 1 => write done to file system */
293int	fsreadfd;		/* file descriptor for reading file system */
294int	fswritefd;		/* file descriptor for writing file system */
295int	rerun;			/* rerun fsck.  Only used in non-preen mode */
296char	resolved;		/* cleared if unresolved changes => not clean */
297int	isappleufs;		/* filesystem is Apple UFS */
298
299daddr_t maxfsblock;		/* number of blocks in the file system */
300char	*blockmap;		/* ptr to primary blk allocation map */
301ino_t	maxino;			/* number of inodes in file system */
302
303int	dirblksiz;
304
305extern ino_t	lfdir;		/* lost & found directory inode number */
306extern const char *lfname;	/* lost & found directory name */
307extern int	lfmode;		/* lost & found directory creation mode */
308
309daddr_t n_blks;		/* number of blocks in use */
310ino_t n_files;		/* number of files in use */
311
312long countdirs;
313
314int	got_siginfo;		/* received a SIGINFO */
315
316#define	clearinode(dp) \
317do { \
318	if (is_ufs2) 			\
319		(dp)->dp2 = ufs2_zino;	\
320	else				\
321		(dp)->dp1 = ufs1_zino;	\
322} while (0)
323
324struct	ufs1_dinode ufs1_zino;
325struct	ufs2_dinode ufs2_zino;
326
327#define	setbmap(blkno)	setbit(blockmap, blkno)
328#define	testbmap(blkno)	isset(blockmap, blkno)
329#define	clrbmap(blkno)	clrbit(blockmap, blkno)
330
331#define	STOP	0x01
332#define	SKIP	0x02
333#define	KEEPON	0x04
334#define	ALTERED	0x08
335#define	FOUND	0x10
336
337/* some inline functs to help the byte-swapping mess */
338static inline u_int16_t iswap16 (u_int16_t);
339static inline u_int32_t iswap32 (u_int32_t);
340static inline u_int64_t iswap64 (u_int64_t);
341
342static inline u_int16_t
343iswap16(u_int16_t x)
344{
345	if (needswap)
346		return bswap16(x);
347	else return x;
348}
349
350static inline u_int32_t
351iswap32(u_int32_t x)
352{
353	if (needswap)
354		return bswap32(x);
355	else return x;
356}
357
358static inline u_int64_t
359iswap64(u_int64_t x)
360{
361	if (needswap)
362		return bswap64(x);
363	else return x;
364}
365