MFC rev 1.89:
[dragonfly.git] / sbin / fsck / fsck.h
blobc6236ba8f9bc5886d37010275f076385416a97ef
1 /*
2 * Copyright (c) 1980, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. 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.
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.
33 * @(#)fsck.h 8.4 (Berkeley) 5/9/95
34 * $FreeBSD: src/sbin/fsck/fsck.h,v 1.12.2.1 2001/01/23 23:11:07 iedowse Exp $
35 * $DragonFly: src/sbin/fsck/fsck.h,v 1.9 2007/04/20 22:20:10 dillon Exp $
38 #include <unistd.h>
39 #include <stdlib.h>
40 #include <stdio.h>
42 #define MAXDUP 10 /* limit on dup blks (per inode) */
43 #define MAXBAD 10 /* limit on bad blks (per inode) */
44 #define MAXBUFSPACE 40*1024 /* maximum space to allocate to buffers */
45 #define INOBUFSIZE 56*1024 /* size of buffer to read inodes in pass1 */
48 * Each inode on the filesystem is described by the following structure.
49 * The linkcnt is initially set to the value in the inode. Each time it
50 * is found during the descent in passes 2, 3, and 4 the count is
51 * decremented. Any inodes whose count is non-zero after pass 4 needs to
52 * have its link count adjusted by the value remaining in ino_linkcnt.
54 struct inostat {
55 char ino_state; /* state of inode, see below */
56 char ino_type; /* type of inode */
57 short ino_linkcnt; /* number of links not found */
60 * Inode states.
62 #define USTATE 01 /* inode not allocated */
63 #define FSTATE 02 /* inode is file */
64 #define DSTATE 03 /* inode is directory */
65 #define DFOUND 04 /* directory found during descent */
66 #define DCLEAR 05 /* directory is to be cleared */
67 #define FCLEAR 06 /* file is to be cleared */
69 * Inode state information is contained on per cylinder group lists
70 * which are described by the following structure.
72 struct inostatlist {
73 long il_numalloced; /* number of inodes allocated in this cg */
74 struct inostat *il_stat;/* inostat info for this cylinder group */
75 } *inostathead;
78 * buffer cache structure.
80 struct bufarea {
81 struct bufarea *b_next; /* free list queue */
82 struct bufarea *b_prev; /* free list queue */
83 ufs_daddr_t b_bno;
84 int b_size;
85 int b_errs;
86 int b_flags;
87 union {
88 char *b_buf; /* buffer space */
89 ufs_daddr_t *b_indir; /* indirect block */
90 struct fs *b_fs; /* super block */
91 struct cg *b_cg; /* cylinder group */
92 struct ufs1_dinode *b_dinode; /* inode block */
93 } b_un;
94 char b_dirty;
97 #define B_INUSE 1
99 #define MINBUFS 5 /* minimum number of buffers required */
100 struct bufarea bufhead; /* head of list of other blks in filesys */
101 struct bufarea sblk; /* file system superblock */
102 struct bufarea cgblk; /* cylinder group blocks */
103 struct bufarea *pdirbp; /* current directory contents */
104 struct bufarea *pbp; /* current inode block */
106 #define dirty(bp) (bp)->b_dirty = 1
107 #define initbarea(bp) \
108 (bp)->b_dirty = 0; \
109 (bp)->b_bno = (ufs_daddr_t)-1; \
110 (bp)->b_flags = 0;
112 #define sbdirty() sblk.b_dirty = 1
113 #define cgdirty() cgblk.b_dirty = 1
114 #define sblock (*sblk.b_un.b_fs)
115 #define cgrp (*cgblk.b_un.b_cg)
117 enum fixstate {DONTKNOW, NOFIX, FIX, IGNORE};
119 struct inodesc {
120 enum fixstate id_fix; /* policy on fixing errors */
121 int (*id_func)(struct inodesc *); /* function to be applied to blocks of inode */
122 ufs1_ino_t id_number; /* inode number described */
123 ufs1_ino_t id_parent; /* for DATA nodes, their parent */
124 ufs_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 direct *id_dirp; /* for DATA nodes, ptr to current entry */
130 char *id_name; /* for DATA nodes, name to find or enter */
131 char id_type; /* type of descriptor, DATA or ADDR */
133 /* file types */
134 #define DATA 1
135 #define ADDR 2
138 * Linked list of duplicate blocks.
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 occurences 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:
153 * w -> y -> x -> z -> y -> w -> y
154 * ^ ^
155 * | |
156 * duplist muldup
158 struct dups {
159 struct dups *next;
160 ufs_daddr_t dup;
162 struct dups *duplist; /* head of dup list */
163 struct dups *muldup; /* end of unique duplicate dup block numbers */
166 * Linked list of inodes with zero link counts.
168 struct zlncnt {
169 struct zlncnt *next;
170 ufs1_ino_t zlncnt;
172 struct zlncnt *zlnhead; /* head of zero link count list */
175 * Inode cache data structures.
177 struct inoinfo {
178 struct inoinfo *i_nexthash; /* next entry in hash chain */
179 ufs1_ino_t i_number; /* inode number of this entry */
180 ufs1_ino_t i_parent; /* inode number of parent */
181 ufs1_ino_t i_dotdot; /* inode number of `..' */
182 size_t i_isize; /* size of inode */
183 u_int i_numblks; /* size of block array in bytes */
184 ufs_daddr_t i_blks[1]; /* actually longer */
185 } **inphead, **inpsort;
186 long numdirs, dirhash, listmax, inplast, dirhashmask;
187 long countdirs; /* number of directories we actually found */
190 * Be careful about cache locality of reference, large filesystems may
191 * have tens of millions of directories in them and if fsck has to swap
192 * we want it to swap efficiently. For this reason we try to group
193 * adjacent inodes together by a reasonable factor.
195 #define DIRHASH(ino) ((ino >> 3) & dirhashmask)
197 char *cdevname; /* name of device being checked */
198 long dev_bsize; /* computed value of DEV_BSIZE */
199 long secsize; /* actual disk sector size */
200 char fflag; /* force check, ignore clean flag */
201 char nflag; /* assume a no response */
202 char yflag; /* assume a yes response */
203 int bflag; /* location of alternate super block */
204 int debug; /* output debugging info */
205 int cvtlevel; /* convert to newer file system format */
206 int doinglevel1; /* converting to new cylinder group format */
207 int doinglevel2; /* converting to new inode format */
208 int newinofmt; /* filesystem has new inode format */
209 char usedsoftdep; /* just fix soft dependency inconsistencies */
210 char preen; /* just fix normal inconsistencies */
211 char rerun; /* rerun fsck. Only used in non-preen mode */
212 int returntosingle; /* 1 => return to single user mode on exit */
213 char resolved; /* cleared if unresolved changes => not clean */
214 char havesb; /* superblock has been read */
215 int fsmodified; /* 1 => write done to file system */
216 int fsreadfd; /* file descriptor for reading file system */
217 int fswritefd; /* file descriptor for writing file system */
218 int lastmntonly; /* Output the last mounted on only */
220 ufs_daddr_t maxfsblock; /* number of blocks in the file system */
221 char *blockmap; /* ptr to primary blk allocation map */
222 ufs1_ino_t maxino; /* number of inodes in file system */
224 ufs1_ino_t lfdir; /* lost & found directory inode number */
225 char *lfname; /* lost & found directory name */
226 int lfmode; /* lost & found directory creation mode */
228 ufs_daddr_t n_blks; /* number of blocks in use */
229 ufs_daddr_t n_files; /* number of files in use */
231 int got_siginfo; /* received a SIGINFO */
233 #define clearinode(dp) (*(dp) = zino)
234 struct ufs1_dinode zino;
236 #define setbmap(blkno) setbit(blockmap, blkno)
237 #define testbmap(blkno) isset(blockmap, blkno)
238 #define clrbmap(blkno) clrbit(blockmap, blkno)
240 #define STOP 0x01
241 #define SKIP 0x02
242 #define KEEPON 0x04
243 #define ALTERED 0x08
244 #define FOUND 0x10
246 #define EEXIT 8 /* Standard error exit. */
248 struct fstab;
251 void adjust(struct inodesc *, int);
252 ufs_daddr_t allocblk(long);
253 ufs1_ino_t allocdir(ufs1_ino_t, ufs1_ino_t, int);
254 ufs1_ino_t allocino(ufs1_ino_t, int);
255 void blkerror(ufs1_ino_t, char *, ufs_daddr_t);
256 char *blockcheck(char *);
257 int bread(int, char *, ufs_daddr_t, long);
258 void bufinit(void);
259 void bwrite(int, char *, ufs_daddr_t, long);
260 void cacheino(struct ufs1_dinode *, ufs1_ino_t);
261 void catch(int);
262 void catchquit(int);
263 int changeino(ufs1_ino_t, char *, ufs1_ino_t);
264 int checkfstab(int, int,
265 int (*)(struct fstab *),
266 int (*)(char *, char *, long, int));
267 int chkrange(ufs_daddr_t, int);
268 void ckfini(int);
269 int ckinode(struct ufs1_dinode *, struct inodesc *);
270 void clri(struct inodesc *, char *, int);
271 int clearentry(struct inodesc *);
272 void direrror(ufs1_ino_t, char *);
273 int dirscan(struct inodesc *);
274 int dofix(struct inodesc *, char *);
275 void ffs_clrblock(struct fs *, u_char *, ufs_daddr_t);
276 void ffs_fragacct(struct fs *, int, int32_t [], int);
277 int ffs_isblock(struct fs *, u_char *, ufs_daddr_t);
278 void ffs_setblock(struct fs *, u_char *, ufs_daddr_t);
279 void fileerror(ufs1_ino_t, ufs1_ino_t, char *);
280 int findino(struct inodesc *);
281 int findname(struct inodesc *);
282 void flush(int, struct bufarea *);
283 void freeblk(ufs_daddr_t, long);
284 void freeino(ufs1_ino_t);
285 void freeinodebuf(void);
286 int ftypeok(struct ufs1_dinode *);
287 void getblk(struct bufarea *, ufs_daddr_t, long);
288 struct bufarea *getdatablk(ufs_daddr_t, long);
289 struct inoinfo *getinoinfo(ufs1_ino_t);
290 struct ufs1_dinode *getnextinode(ufs1_ino_t);
291 void getpathname(char *, ufs1_ino_t, ufs1_ino_t);
292 struct ufs1_dinode *ginode(ufs1_ino_t);
293 void infohandler(int);
294 void inocleanup(void);
295 void inodirty(void);
296 struct inostat *inoinfo(ufs1_ino_t);
297 int linkup(ufs1_ino_t, ufs1_ino_t, char *);
298 int makeentry(ufs1_ino_t, ufs1_ino_t, char *);
299 void panic(const char *, ...);
300 void pass1(void);
301 void pass1b(void);
302 int pass1check(struct inodesc *);
303 void pass2(void);
304 void pass3(void);
305 void pass4(void);
306 int pass4check(struct inodesc *);
307 void pass5(void);
308 void pfatal(const char *, ...);
309 void pinode(ufs1_ino_t);
310 void propagate(void);
311 void pwarn(const char *, ...);
312 int reply(char *);
313 void setinodebuf(ufs1_ino_t);
314 int setup(char *);
315 void voidquit(int);