Home | History | Annotate | Line # | Download | only in fsck_ext2fs
      1 /*	$NetBSD: fsck.h,v 1.17 2020/04/05 15:25:39 joerg 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. Neither the name of the University nor the names of its contributors
     16  *    may be used to endorse or promote products derived from this software
     17  *    without specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     29  * SUCH DAMAGE.
     30  *
     31  *	@(#)fsck.h	8.1 (Berkeley) 6/5/93
     32  */
     33 
     34 /*
     35  * Copyright (c) 1997 Manuel Bouyer.
     36  *
     37  * Redistribution and use in source and binary forms, with or without
     38  * modification, are permitted provided that the following conditions
     39  * are met:
     40  * 1. Redistributions of source code must retain the above copyright
     41  *    notice, this list of conditions and the following disclaimer.
     42  * 2. Redistributions in binary form must reproduce the above copyright
     43  *    notice, this list of conditions and the following disclaimer in the
     44  *    documentation and/or other materials provided with the distribution.
     45  *
     46  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     47  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     48  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     49  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     50  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     51  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     52  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     53  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     54  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     55  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     56  *
     57  *	@(#)fsck.h	8.1 (Berkeley) 6/5/93
     58  */
     59 
     60 #define	MAXDUP		10	/* limit on dup blks (per inode) */
     61 #define	MAXBAD		10	/* limit on bad blks (per inode) */
     62 #define	MAXBUFSPACE	80*1024	/* maximum space to allocate to buffers */
     63 #define	INOBUFSIZE	128*1024	/* size of buffer to read inodes in pass1 */
     64 
     65 #ifndef BUFSIZ
     66 #define BUFSIZ 1024
     67 #endif
     68 
     69 #define	USTATE	01		/* inode not allocated */
     70 #define	FSTATE	02		/* inode is file */
     71 #define	DSTATE	03		/* inode is directory */
     72 #define	DFOUND	04		/* directory found during descent */
     73 #define	DCLEAR	05		/* directory is to be cleared */
     74 #define	FCLEAR	06		/* file is to be cleared */
     75 
     76 /*
     77  * buffer cache structure.
     78  */
     79 struct bufarea {
     80 	struct bufarea	*b_next;		/* free list queue */
     81 	struct bufarea	*b_prev;		/* free list queue */
     82 	daddr_t	b_bno;
     83 	int	b_size;
     84 	int	b_errs;
     85 	int	b_flags;
     86 	union {
     87 		char	*b_buf;			/* buffer space */
     88 		/* XXX ondisk32 */
     89 		int32_t	*b_indir;		/* indirect block */
     90 		struct	ext2fs *b_fs;		/* super block */
     91 		struct	ext2_gd *b_cgd;		/* cylinder group descriptor */
     92 		struct	ext2fs_dinode *b_dinode;	/* inode block */
     93 	} b_un;
     94 	char	b_dirty;
     95 };
     96 
     97 #define	B_INUSE 1
     98 
     99 #define	MINBUFS		5	/* minimum number of buffers required */
    100 extern struct bufarea bufhead;		/* head of list of other blks in filesys */
    101 extern struct bufarea sblk;		/* file system superblock */
    102 extern struct bufarea asblk;		/* first alternate superblock */
    103 extern struct bufarea *pdirbp;		/* current directory contents */
    104 extern struct bufarea *pbp;		/* current inode block */
    105 extern struct bufarea *getdatablk(daddr_t, long);
    106 extern struct m_ext2fs sblock;
    107 
    108 #define	dirty(bp)	(bp)->b_dirty = 1
    109 #define	initbarea(bp) \
    110 	(bp)->b_dirty = 0; \
    111 	(bp)->b_bno = (daddr_t)-1; \
    112 	(bp)->b_flags = 0;
    113 
    114 #define	sbdirty()	copyback_sb(&sblk); sblk.b_dirty = 1
    115 
    116 enum fixstate {DONTKNOW, NOFIX, FIX, IGNORE};
    117 
    118 struct inodesc {
    119 	enum fixstate id_fix;	/* policy on fixing errors */
    120 	int (*id_func)		/* function to be applied to blocks of inode */
    121 	    (struct inodesc *);
    122 	ino_t id_number;	/* inode number described */
    123 	ino_t id_parent;	/* for DATA nodes, their parent */
    124 	daddr_t id_blkno;	/* current block number being examined */
    125 	int id_numfrags;	/* number of frags contained in block */
    126 	quad_t id_filesize;	/* for DATA nodes, the size of the directory */
    127 	int id_loc;		/* for DATA nodes, current location in dir */
    128 	int id_entryno;		/* for DATA nodes, current entry number */
    129 	struct ext2fs_direct *id_dirp;	/* for DATA nodes, ptr to current entry */
    130 	const char *id_name;	/* for DATA nodes, name to find or enter */
    131 	char id_type;		/* type of descriptor, DATA or ADDR */
    132 };
    133 /* file types */
    134 #define	DATA	1
    135 #define	ADDR	2
    136 
    137 /*
    138  * Linked list of duplicate blocks.
    139  *
    140  * The list is composed of two parts. The first part of the
    141  * list (from duplist through the node pointed to by muldup)
    142  * contains a single copy of each duplicate block that has been
    143  * found. The second part of the list (from muldup to the end)
    144  * contains duplicate blocks that have been found more than once.
    145  * To check if a block has been found as a duplicate it is only
    146  * necessary to search from duplist through muldup. To find the
    147  * total number of times that a block has been found as a duplicate
    148  * the entire list must be searched for occurrences of the block
    149  * in question. The following diagram shows a sample list where
    150  * w (found twice), x (found once), y (found three times), and z
    151  * (found once) are duplicate block numbers:
    152  *
    153  *    w -> y -> x -> z -> y -> w -> y
    154  *    ^		     ^
    155  *    |		     |
    156  * duplist	  muldup
    157  */
    158 struct dups {
    159 	struct dups *next;
    160 	daddr_t dup;
    161 };
    162 extern struct dups *duplist;	/* head of dup list */
    163 extern struct dups *muldup;	/* end of unique duplicate dup block numbers */
    164 
    165 /*
    166  * Linked list of inodes with zero link counts.
    167  */
    168 struct zlncnt {
    169 	struct zlncnt *next;
    170 	ino_t zlncnt;
    171 };
    172 extern struct zlncnt *zlnhead;	/* head of zero link count list */
    173 
    174 /*
    175  * Inode cache data structures.
    176  */
    177 extern struct inoinfo {
    178 	struct	inoinfo *i_nexthash;	/* next entry in hash chain */
    179 	struct	inoinfo	*i_child, *i_sibling, *i_parentp;
    180 	ino_t	i_number;		/* inode number of this entry */
    181 	ino_t	i_parent;		/* inode number of parent */
    182 	ino_t	i_dotdot;		/* inode number of `..' */
    183 	u_int64_t i_isize;		/* size of inode */
    184 	u_int	i_numblks;		/* size of block array in bytes */
    185 	/* XXX ondisk32 */
    186 	int32_t	i_blks[1];		/* actually longer */
    187 } **inphead, **inpsort;
    188 extern long numdirs, listmax, inplast;
    189 
    190 extern long	dev_bsize;	/* computed value of DEV_BSIZE */
    191 extern long	secsize;	/* actual disk sector size */
    192 extern char	nflag;		/* assume a no response */
    193 extern char	yflag;		/* assume a yes response */
    194 extern int	bflag;		/* location of alternate super block */
    195 extern int	Uflag;		/* resolve user names */
    196 extern int	debug;		/* output debugging info */
    197 extern int	preen;		/* just fix normal inconsistencies */
    198 extern char	havesb;		/* superblock has been read */
    199 extern char	skipclean;	/* skip clean file systems if preening */
    200 extern int	fsmodified;	/* 1 => write done to file system */
    201 extern int	fsreadfd;	/* file descriptor for reading file system */
    202 extern int	fswritefd;	/* file descriptor for writing file system */
    203 extern int	rerun;		/* rerun fsck.  Only used in non-preen mode */
    204 
    205 extern daddr_t	maxfsblock;	/* number of blocks in the file system */
    206 extern char	*blockmap;	/* ptr to primary blk allocation map */
    207 extern ino_t	maxino;		/* number of inodes in file system */
    208 extern ino_t	lastino;	/* last inode in use */
    209 extern char	*statemap;	/* ptr to inode state table */
    210 extern u_char	*typemap;	/* ptr to inode type table */
    211 extern int16_t	*lncntp;	/* ptr to link count table */
    212 
    213 extern ino_t	lfdir;		/* lost & found directory inode number */
    214 extern const char *lfname;	/* lost & found directory name */
    215 extern int	lfmode;		/* lost & found directory creation mode */
    216 
    217 extern daddr_t	n_blks;		/* number of blocks in use */
    218 extern daddr_t	n_files;	/* number of files in use */
    219 
    220 #define	clearinode(dp)	(*(dp) = zino)
    221 extern struct	ext2fs_dinode zino;
    222 
    223 #define	setbmap(blkno)	setbit(blockmap, blkno)
    224 #define	testbmap(blkno)	isset(blockmap, blkno)
    225 #define	clrbmap(blkno)	clrbit(blockmap, blkno)
    226 
    227 #define	STOP	0x01
    228 #define	SKIP	0x02
    229 #define	KEEPON	0x04
    230 #define	ALTERED	0x08
    231 #define	FOUND	0x10
    232 
    233 /*
    234  * Kernel support for features doesn't imply fsck support
    235  */
    236 #define EXT2F_COMPAT_SUPP_FSCK		0x00
    237 #define EXT2F_ROCOMPAT_SUPP_FSCK	(EXT2F_ROCOMPAT_SPARSESUPER \
    238                                          | EXT2F_ROCOMPAT_LARGEFILE \
    239                                          | EXT2F_ROCOMPAT_HUGE_FILE \
    240 					)
    241 #define EXT2F_INCOMPAT_SUPP_FSCK	(EXT2F_INCOMPAT_FTYPE \
    242 					)
    243 
    244 struct ext2fs_dinode *ginode(ino_t);
    245 struct inoinfo *getinoinfo(ino_t);
    246 void getblk(struct bufarea *, daddr_t, long);
    247 ino_t allocino(ino_t, int);
    248 void copyback_sb(struct bufarea*);
    249 daddr_t cgoverhead(int);	/* overhead per cg */
    250