]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sbin/fsck_ffs/fsck.h
MFC of 346185
[FreeBSD/FreeBSD.git] / sbin / fsck_ffs / fsck.h
1 /*
2  * Copyright (c) 2002 Networks Associates Technology, Inc.
3  * All rights reserved.
4  *
5  * This software was developed for the FreeBSD Project by Marshall
6  * Kirk McKusick and Network Associates Laboratories, the Security
7  * Research Division of Network Associates, Inc. under DARPA/SPAWAR
8  * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
9  * research program.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * Copyright (c) 1980, 1986, 1993
33  *      The Regents of the University of California.  All rights reserved.
34  *
35  * Redistribution and use in source and binary forms, with or without
36  * modification, are permitted provided that the following conditions
37  * are met:
38  * 1. Redistributions of source code must retain the above copyright
39  *    notice, this list of conditions and the following disclaimer.
40  * 2. Redistributions in binary form must reproduce the above copyright
41  *    notice, this list of conditions and the following disclaimer in the
42  *    documentation and/or other materials provided with the distribution.
43  * 4. Neither the name of the University nor the names of its contributors
44  *    may be used to endorse or promote products derived from this software
45  *    without specific prior written permission.
46  *
47  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
48  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
49  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
50  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
51  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
52  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
53  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
54  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
55  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
56  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
57  * SUCH DAMAGE.
58  *
59  *      @(#)fsck.h      8.4 (Berkeley) 5/9/95
60  * $FreeBSD$
61  */
62
63 #ifndef _FSCK_H_
64 #define _FSCK_H_
65
66 #include <unistd.h>
67 #include <stdlib.h>
68 #include <stdio.h>
69
70 #include <sys/queue.h>
71
72 #define MAXDUP          10      /* limit on dup blks (per inode) */
73 #define MAXBAD          10      /* limit on bad blks (per inode) */
74 #define MINBUFS         10      /* minimum number of buffers required */
75 #define MAXBUFS         40      /* maximum space to allocate to buffers */
76 #define INOBUFSIZE      64*1024 /* size of buffer to read inodes in pass1 */
77 #define ZEROBUFSIZE     (dev_bsize * 128) /* size of zero buffer used by -Z */
78
79 union dinode {
80         struct ufs1_dinode dp1;
81         struct ufs2_dinode dp2;
82 };
83 #define DIP(dp, field) \
84         ((sblock.fs_magic == FS_UFS1_MAGIC) ? \
85         (dp)->dp1.field : (dp)->dp2.field)
86
87 #define DIP_SET(dp, field, val) do { \
88         if (sblock.fs_magic == FS_UFS1_MAGIC) \
89                 (dp)->dp1.field = (val); \
90         else \
91                 (dp)->dp2.field = (val); \
92         } while (0)
93
94 /*
95  * Each inode on the file system is described by the following structure.
96  * The linkcnt is initially set to the value in the inode. Each time it
97  * is found during the descent in passes 2, 3, and 4 the count is
98  * decremented. Any inodes whose count is non-zero after pass 4 needs to
99  * have its link count adjusted by the value remaining in ino_linkcnt.
100  */
101 struct inostat {
102         char    ino_state;      /* state of inode, see below */
103         char    ino_type;       /* type of inode */
104         short   ino_linkcnt;    /* number of links not found */
105 };
106 /*
107  * Inode states.
108  */
109 #define USTATE  0x1             /* inode not allocated */
110 #define FSTATE  0x2             /* inode is file */
111 #define FZLINK  0x3             /* inode is file with a link count of zero */
112 #define DSTATE  0x4             /* inode is directory */
113 #define DZLINK  0x5             /* inode is directory with a zero link count  */
114 #define DFOUND  0x6             /* directory found during descent */
115 /*              0x7                UNUSED - see S_IS_DVALID() definition */
116 #define DCLEAR  0x8             /* directory is to be cleared */
117 #define FCLEAR  0x9             /* file is to be cleared */
118 /*      DUNFOUND === (state == DSTATE || state == DZLINK) */
119 #define S_IS_DUNFOUND(state)    (((state) & ~0x1) == DSTATE)
120 /*      DVALID   === (state == DSTATE || state == DZLINK || state == DFOUND) */
121 #define S_IS_DVALID(state)      (((state) & ~0x3) == DSTATE)
122 #define INO_IS_DUNFOUND(ino)    S_IS_DUNFOUND(inoinfo(ino)->ino_state)
123 #define INO_IS_DVALID(ino)      S_IS_DVALID(inoinfo(ino)->ino_state)
124 /*
125  * Inode state information is contained on per cylinder group lists
126  * which are described by the following structure.
127  */
128 struct inostatlist {
129         long    il_numalloced;  /* number of inodes allocated in this cg */
130         struct inostat *il_stat;/* inostat info for this cylinder group */
131 } *inostathead;
132
133 /*
134  * buffer cache structure.
135  */
136 struct bufarea {
137         TAILQ_ENTRY(bufarea) b_list;            /* buffer list */
138         ufs2_daddr_t b_bno;
139         int b_size;
140         int b_errs;
141         int b_flags;
142         int b_type;
143         union {
144                 char *b_buf;                    /* buffer space */
145                 ufs1_daddr_t *b_indir1;         /* UFS1 indirect block */
146                 ufs2_daddr_t *b_indir2;         /* UFS2 indirect block */
147                 struct fs *b_fs;                /* super block */
148                 struct cg *b_cg;                /* cylinder group */
149                 struct ufs1_dinode *b_dinode1;  /* UFS1 inode block */
150                 struct ufs2_dinode *b_dinode2;  /* UFS2 inode block */
151         } b_un;
152         char b_dirty;
153 };
154
155 #define IBLK(bp, i) \
156         ((sblock.fs_magic == FS_UFS1_MAGIC) ? \
157         (bp)->b_un.b_indir1[i] : (bp)->b_un.b_indir2[i])
158
159 #define IBLK_SET(bp, i, val) do { \
160         if (sblock.fs_magic == FS_UFS1_MAGIC) \
161                 (bp)->b_un.b_indir1[i] = (val); \
162         else \
163                 (bp)->b_un.b_indir2[i] = (val); \
164         } while (0)
165
166 /*
167  * Buffer flags
168  */
169 #define B_INUSE         0x00000001      /* Buffer is in use */
170 /*
171  * Type of data in buffer
172  */
173 #define BT_UNKNOWN       0      /* Buffer holds a superblock */
174 #define BT_SUPERBLK      1      /* Buffer holds a superblock */
175 #define BT_CYLGRP        2      /* Buffer holds a cylinder group map */
176 #define BT_LEVEL1        3      /* Buffer holds single level indirect */
177 #define BT_LEVEL2        4      /* Buffer holds double level indirect */
178 #define BT_LEVEL3        5      /* Buffer holds triple level indirect */
179 #define BT_EXTATTR       6      /* Buffer holds external attribute data */
180 #define BT_INODES        7      /* Buffer holds external attribute data */
181 #define BT_DIRDATA       8      /* Buffer holds directory data */
182 #define BT_DATA          9      /* Buffer holds user data */
183 #define BT_NUMBUFTYPES  10
184 #define BT_NAMES {                      \
185         "unknown",                      \
186         "Superblock",                   \
187         "Cylinder Group",               \
188         "Single Level Indirect",        \
189         "Double Level Indirect",        \
190         "Triple Level Indirect",        \
191         "External Attribute",           \
192         "Inode Block",                  \
193         "Directory Contents",           \
194         "User Data" }
195 extern long readcnt[BT_NUMBUFTYPES];
196 extern long totalreadcnt[BT_NUMBUFTYPES];
197 extern struct timespec readtime[BT_NUMBUFTYPES];
198 extern struct timespec totalreadtime[BT_NUMBUFTYPES];
199 extern struct timespec startprog;
200
201 extern struct bufarea sblk;             /* file system superblock */
202 extern struct bufarea *pdirbp;          /* current directory contents */
203 extern struct bufarea *pbp;             /* current inode block */
204
205 #define dirty(bp) do { \
206         if (fswritefd < 0) \
207                 pfatal("SETTING DIRTY FLAG IN READ_ONLY MODE\n"); \
208         else \
209                 (bp)->b_dirty = 1; \
210 } while (0)
211 #define initbarea(bp, type) do { \
212         (bp)->b_dirty = 0; \
213         (bp)->b_bno = (ufs2_daddr_t)-1; \
214         (bp)->b_flags = 0; \
215         (bp)->b_type = type; \
216 } while (0)
217
218 #define sbdirty()       dirty(&sblk)
219 #define sblock          (*sblk.b_un.b_fs)
220
221 enum fixstate {DONTKNOW, NOFIX, FIX, IGNORE};
222 extern ino_t cursnapshot;
223
224 struct inodesc {
225         enum fixstate id_fix;   /* policy on fixing errors */
226         int (*id_func)(struct inodesc *);
227                                 /* function to be applied to blocks of inode */
228         ino_t id_number;        /* inode number described */
229         ino_t id_parent;        /* for DATA nodes, their parent */
230         ufs_lbn_t id_lbn;       /* logical block number of current block */
231         ufs2_daddr_t id_blkno;  /* current block number being examined */
232         int id_level;           /* level of indirection of this block */
233         int id_numfrags;        /* number of frags contained in block */
234         ufs_lbn_t id_lballoc;   /* pass1: last LBN that is allocated */
235         off_t id_filesize;      /* for DATA nodes, the size of the directory */
236         ufs2_daddr_t id_entryno;/* for DATA nodes, current entry number */
237         int id_loc;             /* for DATA nodes, current location in dir */
238         struct direct *id_dirp; /* for DATA nodes, ptr to current entry */
239         char *id_name;          /* for DATA nodes, name to find or enter */
240         char id_type;           /* type of descriptor, DATA or ADDR */
241 };
242 /* file types */
243 #define DATA    1       /* a directory */
244 #define SNAP    2       /* a snapshot */
245 #define ADDR    3       /* anything but a directory or a snapshot */
246
247 /*
248  * Linked list of duplicate blocks.
249  *
250  * The list is composed of two parts. The first part of the
251  * list (from duplist through the node pointed to by muldup)
252  * contains a single copy of each duplicate block that has been
253  * found. The second part of the list (from muldup to the end)
254  * contains duplicate blocks that have been found more than once.
255  * To check if a block has been found as a duplicate it is only
256  * necessary to search from duplist through muldup. To find the
257  * total number of times that a block has been found as a duplicate
258  * the entire list must be searched for occurrences of the block
259  * in question. The following diagram shows a sample list where
260  * w (found twice), x (found once), y (found three times), and z
261  * (found once) are duplicate block numbers:
262  *
263  *    w -> y -> x -> z -> y -> w -> y
264  *    ^              ^
265  *    |              |
266  * duplist        muldup
267  */
268 struct dups {
269         struct dups *next;
270         ufs2_daddr_t dup;
271 };
272 struct dups *duplist;           /* head of dup list */
273 struct dups *muldup;            /* end of unique duplicate dup block numbers */
274
275 /*
276  * Inode cache data structures.
277  */
278 struct inoinfo {
279         struct  inoinfo *i_nexthash;    /* next entry in hash chain */
280         ino_t   i_number;               /* inode number of this entry */
281         ino_t   i_parent;               /* inode number of parent */
282         ino_t   i_dotdot;               /* inode number of `..' */
283         size_t  i_isize;                /* size of inode */
284         u_int   i_numblks;              /* size of block array in bytes */
285         ufs2_daddr_t i_blks[1];         /* actually longer */
286 } **inphead, **inpsort;
287 extern long dirhash, inplast;
288 extern unsigned long numdirs, listmax;
289 extern long countdirs;          /* number of directories we actually found */
290
291 #define MIBSIZE 3               /* size of fsck sysctl MIBs */
292 extern int      adjrefcnt[MIBSIZE];     /* MIB command to adjust inode reference cnt */
293 extern int      adjblkcnt[MIBSIZE];     /* MIB command to adjust inode block count */
294 extern int      setsize[MIBSIZE];       /* MIB command to set inode size */
295 extern int      adjndir[MIBSIZE];       /* MIB command to adjust number of directories */
296 extern int      adjnbfree[MIBSIZE];     /* MIB command to adjust number of free blocks */
297 extern int      adjnifree[MIBSIZE];     /* MIB command to adjust number of free inodes */
298 extern int      adjnffree[MIBSIZE];     /* MIB command to adjust number of free frags */
299 extern int      adjnumclusters[MIBSIZE];        /* MIB command to adjust number of free clusters */
300 extern int      freefiles[MIBSIZE];     /* MIB command to free a set of files */
301 extern int      freedirs[MIBSIZE];      /* MIB command to free a set of directories */
302 extern int      freeblks[MIBSIZE];      /* MIB command to free a set of data blocks */
303 extern struct   fsck_cmd cmd;           /* sysctl file system update commands */
304 extern char     snapname[BUFSIZ];       /* when doing snapshots, the name of the file */
305 extern char     *cdevname;              /* name of device being checked */
306 extern long     dev_bsize;              /* computed value of DEV_BSIZE */
307 extern long     secsize;                /* actual disk sector size */
308 extern u_int    real_dev_bsize;         /* actual disk sector size, not overridden */
309 extern char     nflag;                  /* assume a no response */
310 extern char     yflag;                  /* assume a yes response */
311 extern int      bkgrdflag;              /* use a snapshot to run on an active system */
312 extern ufs2_daddr_t bflag;              /* location of alternate super block */
313 extern int      debug;                  /* output debugging info */
314 extern int      Eflag;                  /* delete empty data blocks */
315 extern int      Zflag;                  /* zero empty data blocks */
316 extern int      inoopt;                 /* trim out unused inodes */
317 extern char     ckclean;                /* only do work if not cleanly unmounted */
318 extern int      cvtlevel;               /* convert to newer file system format */
319 extern int      bkgrdcheck;             /* determine if background check is possible */
320 extern int      bkgrdsumadj;            /* whether the kernel have ability to adjust superblock summary */
321 extern char     usedsoftdep;            /* just fix soft dependency inconsistencies */
322 extern char     preen;                  /* just fix normal inconsistencies */
323 extern char     rerun;                  /* rerun fsck. Only used in non-preen mode */
324 extern int      returntosingle;         /* 1 => return to single user mode on exit */
325 extern char     resolved;               /* cleared if unresolved changes => not clean */
326 extern char     havesb;                 /* superblock has been read */
327 extern char     skipclean;              /* skip clean file systems if preening */
328 extern int      fsmodified;             /* 1 => write done to file system */
329 extern int      fsreadfd;               /* file descriptor for reading file system */
330 extern int      fswritefd;              /* file descriptor for writing file system */
331 extern int      surrender;              /* Give up if reads fail */
332 extern int      wantrestart;            /* Restart fsck on early termination */
333
334 extern ufs2_daddr_t maxfsblock; /* number of blocks in the file system */
335 extern char     *blockmap;              /* ptr to primary blk allocation map */
336 extern ino_t    maxino;                 /* number of inodes in file system */
337
338 extern ino_t    lfdir;                  /* lost & found directory inode number */
339 extern const char *lfname;              /* lost & found directory name */
340 extern int      lfmode;                 /* lost & found directory creation mode */
341
342 extern ufs2_daddr_t n_blks;             /* number of blocks in use */
343 extern ino_t n_files;                   /* number of files in use */
344
345 extern volatile sig_atomic_t    got_siginfo;    /* received a SIGINFO */
346 extern volatile sig_atomic_t    got_sigalarm;   /* received a SIGALRM */
347
348 #define clearinode(dp) \
349         if (sblock.fs_magic == FS_UFS1_MAGIC) { \
350                 (dp)->dp1 = ufs1_zino; \
351         } else { \
352                 (dp)->dp2 = ufs2_zino; \
353         }
354 extern struct   ufs1_dinode ufs1_zino;
355 extern struct   ufs2_dinode ufs2_zino;
356
357 #define setbmap(blkno)  setbit(blockmap, blkno)
358 #define testbmap(blkno) isset(blockmap, blkno)
359 #define clrbmap(blkno)  clrbit(blockmap, blkno)
360
361 #define STOP    0x01
362 #define SKIP    0x02
363 #define KEEPON  0x04
364 #define ALTERED 0x08
365 #define FOUND   0x10
366
367 #define EEXIT   8               /* Standard error exit. */
368 #define ERERUN  16              /* fsck needs to be re-run. */
369 #define ERESTART -1
370
371 int flushentry(void);
372 /*
373  * Wrapper for malloc() that flushes the cylinder group cache to try 
374  * to get space.
375  */
376 static inline void*
377 Malloc(size_t size)
378 {
379         void *retval;
380
381         while ((retval = malloc(size)) == NULL)
382                 if (flushentry() == 0)
383                         break;
384         return (retval);
385 }
386
387 /*
388  * Wrapper for calloc() that flushes the cylinder group cache to try 
389  * to get space.
390  */
391 static inline void*
392 Calloc(size_t cnt, size_t size)
393 {
394         void *retval;
395
396         while ((retval = calloc(cnt, size)) == NULL)
397                 if (flushentry() == 0)
398                         break;
399         return (retval);
400 }
401
402 struct fstab;
403
404
405 void            adjust(struct inodesc *, int lcnt);
406 ufs2_daddr_t    allocblk(long frags);
407 ino_t           allocdir(ino_t parent, ino_t request, int mode);
408 ino_t           allocino(ino_t request, int type);
409 void            blkerror(ino_t ino, const char *type, ufs2_daddr_t blk);
410 char           *blockcheck(char *name);
411 int             blread(int fd, char *buf, ufs2_daddr_t blk, long size);
412 void            bufinit(void);
413 void            blwrite(int fd, char *buf, ufs2_daddr_t blk, ssize_t size);
414 void            blerase(int fd, ufs2_daddr_t blk, long size);
415 void            blzero(int fd, ufs2_daddr_t blk, long size);
416 void            cacheino(union dinode *dp, ino_t inumber);
417 void            catch(int);
418 void            catchquit(int);
419 int             changeino(ino_t dir, const char *name, ino_t newnum);
420 int             check_cgmagic(int cg, struct bufarea *cgbp);
421 int             chkrange(ufs2_daddr_t blk, int cnt);
422 void            ckfini(int markclean);
423 int             ckinode(union dinode *dp, struct inodesc *);
424 void            clri(struct inodesc *, const char *type, int flag);
425 int             clearentry(struct inodesc *);
426 void            direrror(ino_t ino, const char *errmesg);
427 int             dirscan(struct inodesc *);
428 int             dofix(struct inodesc *, const char *msg);
429 int             eascan(struct inodesc *, struct ufs2_dinode *dp);
430 void            fileerror(ino_t cwd, ino_t ino, const char *errmesg);
431 void            finalIOstats(void);
432 int             findino(struct inodesc *);
433 int             findname(struct inodesc *);
434 void            flush(int fd, struct bufarea *bp);
435 void            freeblk(ufs2_daddr_t blkno, long frags);
436 void            freeino(ino_t ino);
437 void            freeinodebuf(void);
438 void            fsutilinit(void);
439 int             ftypeok(union dinode *dp);
440 void            getblk(struct bufarea *bp, ufs2_daddr_t blk, long size);
441 struct bufarea *cgget(int cg);
442 struct bufarea *getdatablk(ufs2_daddr_t blkno, long size, int type);
443 struct inoinfo *getinoinfo(ino_t inumber);
444 union dinode   *getnextinode(ino_t inumber, int rebuildcg);
445 void            getpathname(char *namebuf, ino_t curdir, ino_t ino);
446 union dinode   *ginode(ino_t inumber);
447 void            infohandler(int sig);
448 void            alarmhandler(int sig);
449 void            inocleanup(void);
450 void            inodirty(union dinode *);
451 struct inostat *inoinfo(ino_t inum);
452 void            IOstats(char *what);
453 int             linkup(ino_t orphan, ino_t parentdir, char *name);
454 int             makeentry(ino_t parent, ino_t ino, const char *name);
455 void            panic(const char *fmt, ...) __printflike(1, 2);
456 void            pass1(void);
457 void            pass1b(void);
458 int             pass1check(struct inodesc *);
459 void            pass2(void);
460 void            pass3(void);
461 void            pass4(void);
462 int             pass4check(struct inodesc *);
463 void            pass5(void);
464 void            pfatal(const char *fmt, ...) __printflike(1, 2);
465 void            pinode(ino_t ino);
466 void            propagate(void);
467 void            pwarn(const char *fmt, ...) __printflike(1, 2);
468 int             readsb(int listerr);
469 int             reply(const char *question);
470 void            rwerror(const char *mesg, ufs2_daddr_t blk);
471 void            sblock_init(void);
472 void            setinodebuf(ino_t);
473 int             setup(char *dev);
474 void            gjournal_check(const char *filesys);
475 int             suj_check(const char *filesys);
476 void            update_maps(struct cg *, struct cg*, int);
477 void            fsckinit(void);
478
479 #endif  /* !_FSCK_H_ */