Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sbin / fsck / fsck.h
CommitLineData
984263bc
MD
1/*
2 * Copyright (c) 1980, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
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.
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.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 */
36
37#include <unistd.h>
38#include <stdlib.h>
39#include <stdio.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/*
47 * Each inode on the filesystem is described by the following structure.
48 * The linkcnt is initially set to the value in the inode. Each time it
49 * is found during the descent in passes 2, 3, and 4 the count is
50 * decremented. Any inodes whose count is non-zero after pass 4 needs to
51 * have its link count adjusted by the value remaining in ino_linkcnt.
52 */
53struct inostat {
54 char ino_state; /* state of inode, see below */
55 char ino_type; /* type of inode */
56 short ino_linkcnt; /* number of links not found */
57};
58/*
59 * Inode states.
60 */
61#define USTATE 01 /* inode not allocated */
62#define FSTATE 02 /* inode is file */
63#define DSTATE 03 /* inode is directory */
64#define DFOUND 04 /* directory found during descent */
65#define DCLEAR 05 /* directory is to be cleared */
66#define FCLEAR 06 /* file is to be cleared */
67/*
68 * Inode state information is contained on per cylinder group lists
69 * which are described by the following structure.
70 */
71struct inostatlist {
72 long il_numalloced; /* number of inodes allocated in this cg */
73 struct inostat *il_stat;/* inostat info for this cylinder group */
74} *inostathead;
75
76/*
77 * buffer cache structure.
78 */
79struct bufarea {
80 struct bufarea *b_next; /* free list queue */
81 struct bufarea *b_prev; /* free list queue */
82 ufs_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 ufs_daddr_t *b_indir; /* indirect block */
89 struct fs *b_fs; /* super block */
90 struct cg *b_cg; /* cylinder group */
91 struct dinode *b_dinode; /* inode block */
92 } b_un;
93 char b_dirty;
94};
95
96#define B_INUSE 1
97
98#define MINBUFS 5 /* minimum number of buffers required */
99struct bufarea bufhead; /* head of list of other blks in filesys */
100struct bufarea sblk; /* file system superblock */
101struct bufarea cgblk; /* cylinder group blocks */
102struct bufarea *pdirbp; /* current directory contents */
103struct bufarea *pbp; /* current inode block */
104
105#define dirty(bp) (bp)->b_dirty = 1
106#define initbarea(bp) \
107 (bp)->b_dirty = 0; \
108 (bp)->b_bno = (ufs_daddr_t)-1; \
109 (bp)->b_flags = 0;
110
111#define sbdirty() sblk.b_dirty = 1
112#define cgdirty() cgblk.b_dirty = 1
113#define sblock (*sblk.b_un.b_fs)
114#define cgrp (*cgblk.b_un.b_cg)
115
116enum fixstate {DONTKNOW, NOFIX, FIX, IGNORE};
117
118struct inodesc {
119 enum fixstate id_fix; /* policy on fixing errors */
120 int (*id_func)(); /* function to be applied to blocks of inode */
121 ino_t id_number; /* inode number described */
122 ino_t id_parent; /* for DATA nodes, their parent */
123 ufs_daddr_t id_blkno; /* current block number being examined */
124 int id_numfrags; /* number of frags contained in block */
125 quad_t id_filesize; /* for DATA nodes, the size of the directory */
126 int id_loc; /* for DATA nodes, current location in dir */
127 int id_entryno; /* for DATA nodes, current entry number */
128 struct direct *id_dirp; /* for DATA nodes, ptr to current entry */
129 char *id_name; /* for DATA nodes, name to find or enter */
130 char id_type; /* type of descriptor, DATA or ADDR */
131};
132/* file types */
133#define DATA 1
134#define ADDR 2
135
136/*
137 * Linked list of duplicate blocks.
138 *
139 * The list is composed of two parts. The first part of the
140 * list (from duplist through the node pointed to by muldup)
141 * contains a single copy of each duplicate block that has been
142 * found. The second part of the list (from muldup to the end)
143 * contains duplicate blocks that have been found more than once.
144 * To check if a block has been found as a duplicate it is only
145 * necessary to search from duplist through muldup. To find the
146 * total number of times that a block has been found as a duplicate
147 * the entire list must be searched for occurences of the block
148 * in question. The following diagram shows a sample list where
149 * w (found twice), x (found once), y (found three times), and z
150 * (found once) are duplicate block numbers:
151 *
152 * w -> y -> x -> z -> y -> w -> y
153 * ^ ^
154 * | |
155 * duplist muldup
156 */
157struct dups {
158 struct dups *next;
159 ufs_daddr_t dup;
160};
161struct dups *duplist; /* head of dup list */
162struct dups *muldup; /* end of unique duplicate dup block numbers */
163
164/*
165 * Linked list of inodes with zero link counts.
166 */
167struct zlncnt {
168 struct zlncnt *next;
169 ino_t zlncnt;
170};
171struct zlncnt *zlnhead; /* head of zero link count list */
172
173/*
174 * Inode cache data structures.
175 */
176struct inoinfo {
177 struct inoinfo *i_nexthash; /* next entry in hash chain */
178 ino_t i_number; /* inode number of this entry */
179 ino_t i_parent; /* inode number of parent */
180 ino_t i_dotdot; /* inode number of `..' */
181 size_t i_isize; /* size of inode */
182 u_int i_numblks; /* size of block array in bytes */
183 ufs_daddr_t i_blks[1]; /* actually longer */
184} **inphead, **inpsort;
185long numdirs, dirhash, listmax, inplast;
186long countdirs; /* number of directories we actually found */
187
188char *cdevname; /* name of device being checked */
189long dev_bsize; /* computed value of DEV_BSIZE */
190long secsize; /* actual disk sector size */
191char fflag; /* force check, ignore clean flag */
192char nflag; /* assume a no response */
193char yflag; /* assume a yes response */
194int bflag; /* location of alternate super block */
195int debug; /* output debugging info */
196int cvtlevel; /* convert to newer file system format */
197int doinglevel1; /* converting to new cylinder group format */
198int doinglevel2; /* converting to new inode format */
199int newinofmt; /* filesystem has new inode format */
200char usedsoftdep; /* just fix soft dependency inconsistencies */
201char preen; /* just fix normal inconsistencies */
202char rerun; /* rerun fsck. Only used in non-preen mode */
203int returntosingle; /* 1 => return to single user mode on exit */
204char resolved; /* cleared if unresolved changes => not clean */
205char havesb; /* superblock has been read */
206int fsmodified; /* 1 => write done to file system */
207int fsreadfd; /* file descriptor for reading file system */
208int fswritefd; /* file descriptor for writing file system */
209
210ufs_daddr_t maxfsblock; /* number of blocks in the file system */
211char *blockmap; /* ptr to primary blk allocation map */
212ino_t maxino; /* number of inodes in file system */
213
214ino_t lfdir; /* lost & found directory inode number */
215char *lfname; /* lost & found directory name */
216int lfmode; /* lost & found directory creation mode */
217
218ufs_daddr_t n_blks; /* number of blocks in use */
219ufs_daddr_t n_files; /* number of files in use */
220
221int got_siginfo; /* received a SIGINFO */
222
223#define clearinode(dp) (*(dp) = zino)
224struct dinode zino;
225
226#define setbmap(blkno) setbit(blockmap, blkno)
227#define testbmap(blkno) isset(blockmap, blkno)
228#define clrbmap(blkno) clrbit(blockmap, blkno)
229
230#define STOP 0x01
231#define SKIP 0x02
232#define KEEPON 0x04
233#define ALTERED 0x08
234#define FOUND 0x10
235
236#define EEXIT 8 /* Standard error exit. */
237
238struct fstab;
239
240
241void adjust __P((struct inodesc *, int lcnt));
242ufs_daddr_t allocblk __P((long frags));
243ino_t allocdir __P((ino_t parent, ino_t request, int mode));
244ino_t allocino __P((ino_t request, int type));
245void blkerror __P((ino_t ino, char *type, ufs_daddr_t blk));
246char *blockcheck __P((char *name));
247int bread __P((int fd, char *buf, ufs_daddr_t blk, long size));
248void bufinit __P((void));
249void bwrite __P((int fd, char *buf, ufs_daddr_t blk, long size));
250void cacheino __P((struct dinode *dp, ino_t inumber));
251void catch __P((int));
252void catchquit __P((int));
253int changeino __P((ino_t dir, char *name, ino_t newnum));
254int checkfstab __P((int preen, int maxrun,
255 int (*docheck)(struct fstab *),
256 int (*chkit)(char *, char *, long, int)));
257int chkrange __P((ufs_daddr_t blk, int cnt));
258void ckfini __P((int markclean));
259int ckinode __P((struct dinode *dp, struct inodesc *));
260void clri __P((struct inodesc *, char *type, int flag));
261int clearentry __P((struct inodesc *));
262void direrror __P((ino_t ino, char *errmesg));
263int dirscan __P((struct inodesc *));
264int dofix __P((struct inodesc *, char *msg));
265void ffs_clrblock __P((struct fs *, u_char *, ufs_daddr_t));
266void ffs_fragacct __P((struct fs *, int, int32_t [], int));
267int ffs_isblock __P((struct fs *, u_char *, ufs_daddr_t));
268void ffs_setblock __P((struct fs *, u_char *, ufs_daddr_t));
269void fileerror __P((ino_t cwd, ino_t ino, char *errmesg));
270int findino __P((struct inodesc *));
271int findname __P((struct inodesc *));
272void flush __P((int fd, struct bufarea *bp));
273void freeblk __P((ufs_daddr_t blkno, long frags));
274void freeino __P((ino_t ino));
275void freeinodebuf __P((void));
276int ftypeok __P((struct dinode *dp));
277void getblk __P((struct bufarea *bp, ufs_daddr_t blk, long size));
278struct bufarea *getdatablk __P((ufs_daddr_t blkno, long size));
279struct inoinfo *getinoinfo __P((ino_t inumber));
280struct dinode *getnextinode __P((ino_t inumber));
281void getpathname __P((char *namebuf, ino_t curdir, ino_t ino));
282struct dinode *ginode __P((ino_t inumber));
283void infohandler __P((int sig));
284void inocleanup __P((void));
285void inodirty __P((void));
286struct inostat *inoinfo __P((ino_t inum));
287int linkup __P((ino_t orphan, ino_t parentdir, char *name));
288int makeentry __P((ino_t parent, ino_t ino, char *name));
289void panic __P((const char *fmt, ...));
290void pass1 __P((void));
291void pass1b __P((void));
292int pass1check __P((struct inodesc *));
293void pass2 __P((void));
294void pass3 __P((void));
295void pass4 __P((void));
296int pass4check __P((struct inodesc *));
297void pass5 __P((void));
298void pfatal __P((const char *fmt, ...));
299void pinode __P((ino_t ino));
300void propagate __P((void));
301void pwarn __P((const char *fmt, ...));
302int reply __P((char *question));
303void setinodebuf __P((ino_t));
304int setup __P((char *dev));
305void voidquit __P((int));