2 * SPDX-License-Identifier: BSD-3-Clause and BSD-2-Clause-FreeBSD
4 * Copyright (c) 2002 Networks Associates Technology, Inc.
7 * This software was developed for the FreeBSD Project by Marshall
8 * Kirk McKusick and Network Associates Laboratories, the Security
9 * Research Division of Network Associates, Inc. under DARPA/SPAWAR
10 * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * Copyright (c) 1980, 1986, 1993
35 * The Regents of the University of California. All rights reserved.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
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 * 3. Neither the name of the University nor the names of its contributors
46 * may be used to endorse or promote products derived from this software
47 * without specific prior written permission.
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
61 * @(#)fsck.h 8.4 (Berkeley) 5/9/95
72 #include <sys/queue.h>
74 #define MAXDUP 10 /* limit on dup blks (per inode) */
75 #define MAXBAD 10 /* limit on bad blks (per inode) */
76 #define MINBUFS 10 /* minimum number of buffers required */
77 #define MAXBUFS 40 /* maximum space to allocate to buffers */
78 #define INOBUFSIZE 64*1024 /* size of buffer to read inodes in pass1 */
79 #define ZEROBUFSIZE (dev_bsize * 128) /* size of zero buffer used by -Z */
82 struct ufs1_dinode dp1;
83 struct ufs2_dinode dp2;
85 #define DIP(dp, field) \
86 ((sblock.fs_magic == FS_UFS1_MAGIC) ? \
87 (dp)->dp1.field : (dp)->dp2.field)
89 #define DIP_SET(dp, field, val) do { \
90 if (sblock.fs_magic == FS_UFS1_MAGIC) \
91 (dp)->dp1.field = (val); \
93 (dp)->dp2.field = (val); \
97 * Each inode on the file system is described by the following structure.
98 * The linkcnt is initially set to the value in the inode. Each time it
99 * is found during the descent in passes 2, 3, and 4 the count is
100 * decremented. Any inodes whose count is non-zero after pass 4 needs to
101 * have its link count adjusted by the value remaining in ino_linkcnt.
104 char ino_state; /* state of inode, see below */
105 char ino_type; /* type of inode */
106 short ino_linkcnt; /* number of links not found */
111 #define USTATE 0x1 /* inode not allocated */
112 #define FSTATE 0x2 /* inode is file */
113 #define FZLINK 0x3 /* inode is file with a link count of zero */
114 #define DSTATE 0x4 /* inode is directory */
115 #define DZLINK 0x5 /* inode is directory with a zero link count */
116 #define DFOUND 0x6 /* directory found during descent */
117 /* 0x7 UNUSED - see S_IS_DVALID() definition */
118 #define DCLEAR 0x8 /* directory is to be cleared */
119 #define FCLEAR 0x9 /* file is to be cleared */
120 /* DUNFOUND === (state == DSTATE || state == DZLINK) */
121 #define S_IS_DUNFOUND(state) (((state) & ~0x1) == DSTATE)
122 /* DVALID === (state == DSTATE || state == DZLINK || state == DFOUND) */
123 #define S_IS_DVALID(state) (((state) & ~0x3) == DSTATE)
124 #define INO_IS_DUNFOUND(ino) S_IS_DUNFOUND(inoinfo(ino)->ino_state)
125 #define INO_IS_DVALID(ino) S_IS_DVALID(inoinfo(ino)->ino_state)
127 * Inode state information is contained on per cylinder group lists
128 * which are described by the following structure.
131 long il_numalloced; /* number of inodes allocated in this cg */
132 struct inostat *il_stat;/* inostat info for this cylinder group */
136 * buffer cache structure.
139 TAILQ_ENTRY(bufarea) b_list; /* buffer list */
146 char *b_buf; /* buffer space */
147 ufs1_daddr_t *b_indir1; /* UFS1 indirect block */
148 ufs2_daddr_t *b_indir2; /* UFS2 indirect block */
149 struct fs *b_fs; /* super block */
150 struct cg *b_cg; /* cylinder group */
151 struct ufs1_dinode *b_dinode1; /* UFS1 inode block */
152 struct ufs2_dinode *b_dinode2; /* UFS2 inode block */
157 #define IBLK(bp, i) \
158 ((sblock.fs_magic == FS_UFS1_MAGIC) ? \
159 (bp)->b_un.b_indir1[i] : (bp)->b_un.b_indir2[i])
161 #define IBLK_SET(bp, i, val) do { \
162 if (sblock.fs_magic == FS_UFS1_MAGIC) \
163 (bp)->b_un.b_indir1[i] = (val); \
165 (bp)->b_un.b_indir2[i] = (val); \
171 #define B_INUSE 0x00000001 /* Buffer is in use */
173 * Type of data in buffer
175 #define BT_UNKNOWN 0 /* Buffer holds a superblock */
176 #define BT_SUPERBLK 1 /* Buffer holds a superblock */
177 #define BT_CYLGRP 2 /* Buffer holds a cylinder group map */
178 #define BT_LEVEL1 3 /* Buffer holds single level indirect */
179 #define BT_LEVEL2 4 /* Buffer holds double level indirect */
180 #define BT_LEVEL3 5 /* Buffer holds triple level indirect */
181 #define BT_EXTATTR 6 /* Buffer holds external attribute data */
182 #define BT_INODES 7 /* Buffer holds external attribute data */
183 #define BT_DIRDATA 8 /* Buffer holds directory data */
184 #define BT_DATA 9 /* Buffer holds user data */
185 #define BT_NUMBUFTYPES 10
190 "Single Level Indirect", \
191 "Double Level Indirect", \
192 "Triple Level Indirect", \
193 "External Attribute", \
195 "Directory Contents", \
197 extern long readcnt[BT_NUMBUFTYPES];
198 extern long totalreadcnt[BT_NUMBUFTYPES];
199 extern struct timespec readtime[BT_NUMBUFTYPES];
200 extern struct timespec totalreadtime[BT_NUMBUFTYPES];
201 extern struct timespec startprog;
203 extern struct bufarea sblk; /* file system superblock */
204 extern struct bufarea *pdirbp; /* current directory contents */
205 extern struct bufarea *pbp; /* current inode block */
207 #define dirty(bp) do { \
209 pfatal("SETTING DIRTY FLAG IN READ_ONLY MODE\n"); \
213 #define initbarea(bp, type) do { \
215 (bp)->b_bno = (ufs2_daddr_t)-1; \
217 (bp)->b_type = type; \
220 #define sbdirty() dirty(&sblk)
221 #define sblock (*sblk.b_un.b_fs)
223 enum fixstate {DONTKNOW, NOFIX, FIX, IGNORE};
224 extern ino_t cursnapshot;
227 enum fixstate id_fix; /* policy on fixing errors */
228 int (*id_func)(struct inodesc *);
229 /* function to be applied to blocks of inode */
230 ino_t id_number; /* inode number described */
231 ino_t id_parent; /* for DATA nodes, their parent */
232 ufs_lbn_t id_lbn; /* logical block number of current block */
233 ufs2_daddr_t id_blkno; /* current block number being examined */
234 int id_numfrags; /* number of frags contained in block */
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 */
243 #define DATA 1 /* a directory */
244 #define SNAP 2 /* a snapshot */
245 #define ADDR 3 /* anything but a directory or a snapshot */
248 * Linked list of duplicate blocks.
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:
263 * w -> y -> x -> z -> y -> w -> y
272 struct dups *duplist; /* head of dup list */
273 struct dups *muldup; /* end of unique duplicate dup block numbers */
276 * Inode cache data structures.
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 */
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 adjndir[MIBSIZE]; /* MIB command to adjust number of directories */
295 extern int adjnbfree[MIBSIZE]; /* MIB command to adjust number of free blocks */
296 extern int adjnifree[MIBSIZE]; /* MIB command to adjust number of free inodes */
297 extern int adjnffree[MIBSIZE]; /* MIB command to adjust number of free frags */
298 extern int adjnumclusters[MIBSIZE]; /* MIB command to adjust number of free clusters */
299 extern int freefiles[MIBSIZE]; /* MIB command to free a set of files */
300 extern int freedirs[MIBSIZE]; /* MIB command to free a set of directories */
301 extern int freeblks[MIBSIZE]; /* MIB command to free a set of data blocks */
302 extern struct fsck_cmd cmd; /* sysctl file system update commands */
303 extern char snapname[BUFSIZ]; /* when doing snapshots, the name of the file */
304 extern char *cdevname; /* name of device being checked */
305 extern long dev_bsize; /* computed value of DEV_BSIZE */
306 extern long secsize; /* actual disk sector size */
307 extern u_int real_dev_bsize; /* actual disk sector size, not overridden */
308 extern char nflag; /* assume a no response */
309 extern char yflag; /* assume a yes response */
310 extern int bkgrdflag; /* use a snapshot to run on an active system */
311 extern off_t bflag; /* location of alternate super block */
312 extern int debug; /* output debugging info */
313 extern int Eflag; /* delete empty data blocks */
314 extern int Zflag; /* zero empty data blocks */
315 extern int inoopt; /* trim out unused inodes */
316 extern char ckclean; /* only do work if not cleanly unmounted */
317 extern int cvtlevel; /* convert to newer file system format */
318 extern int ckhashadd; /* check hashes to be added */
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 struct uufsd disk; /* libufs user-ufs disk structure */
332 extern int surrender; /* Give up if reads fail */
333 extern int wantrestart; /* Restart fsck on early termination */
335 extern ufs2_daddr_t maxfsblock; /* number of blocks in the file system */
336 extern char *blockmap; /* ptr to primary blk allocation map */
337 extern ino_t maxino; /* number of inodes in file system */
339 extern ino_t lfdir; /* lost & found directory inode number */
340 extern const char *lfname; /* lost & found directory name */
341 extern int lfmode; /* lost & found directory creation mode */
343 extern ufs2_daddr_t n_blks; /* number of blocks in use */
344 extern ino_t n_files; /* number of files in use */
346 extern volatile sig_atomic_t got_siginfo; /* received a SIGINFO */
347 extern volatile sig_atomic_t got_sigalarm; /* received a SIGALRM */
349 #define clearinode(dp) \
350 if (sblock.fs_magic == FS_UFS1_MAGIC) { \
351 (dp)->dp1 = ufs1_zino; \
353 (dp)->dp2 = ufs2_zino; \
355 extern struct ufs1_dinode ufs1_zino;
356 extern struct ufs2_dinode ufs2_zino;
358 #define setbmap(blkno) setbit(blockmap, blkno)
359 #define testbmap(blkno) isset(blockmap, blkno)
360 #define clrbmap(blkno) clrbit(blockmap, blkno)
368 #define EEXIT 8 /* Standard error exit. */
369 #define ERERUN 16 /* fsck needs to be re-run. */
372 int flushentry(void);
374 * Wrapper for malloc() that flushes the cylinder group cache to try
382 while ((retval = malloc(size)) == NULL)
383 if (flushentry() == 0)
389 * Wrapper for calloc() that flushes the cylinder group cache to try
393 Calloc(size_t cnt, size_t size)
397 while ((retval = calloc(cnt, size)) == NULL)
398 if (flushentry() == 0)
406 void adjust(struct inodesc *, int lcnt);
407 ufs2_daddr_t allocblk(long frags);
408 ino_t allocdir(ino_t parent, ino_t request, int mode);
409 ino_t allocino(ino_t request, int type);
410 void blkerror(ino_t ino, const char *type, ufs2_daddr_t blk);
411 char *blockcheck(char *name);
412 int blread(int fd, char *buf, ufs2_daddr_t blk, long size);
414 void blwrite(int fd, char *buf, ufs2_daddr_t blk, ssize_t size);
415 void blerase(int fd, ufs2_daddr_t blk, long size);
416 void blzero(int fd, ufs2_daddr_t blk, long size);
417 void cacheino(union dinode *dp, ino_t inumber);
420 int changeino(ino_t dir, const char *name, ino_t newnum);
421 int check_cgmagic(int cg, struct bufarea *cgbp);
422 int chkrange(ufs2_daddr_t blk, int cnt);
423 void ckfini(int markclean);
424 int ckinode(union dinode *dp, struct inodesc *);
425 void clri(struct inodesc *, const char *type, int flag);
426 int clearentry(struct inodesc *);
427 void direrror(ino_t ino, const char *errmesg);
428 int dirscan(struct inodesc *);
429 int dofix(struct inodesc *, const char *msg);
430 int eascan(struct inodesc *, struct ufs2_dinode *dp);
431 void fileerror(ino_t cwd, ino_t ino, const char *errmesg);
432 void finalIOstats(void);
433 int findino(struct inodesc *);
434 int findname(struct inodesc *);
435 void flush(int fd, struct bufarea *bp);
436 void freeblk(ufs2_daddr_t blkno, long frags);
437 void freeino(ino_t ino);
438 void freeinodebuf(void);
439 void fsutilinit(void);
440 int ftypeok(union dinode *dp);
441 void getblk(struct bufarea *bp, ufs2_daddr_t blk, long size);
442 struct bufarea *cglookup(int cg);
443 struct bufarea *getdatablk(ufs2_daddr_t blkno, long size, int type);
444 struct inoinfo *getinoinfo(ino_t inumber);
445 union dinode *getnextinode(ino_t inumber, int rebuildcg);
446 void getpathname(char *namebuf, ino_t curdir, ino_t ino);
447 union dinode *ginode(ino_t inumber);
448 void infohandler(int sig);
449 void alarmhandler(int sig);
450 void inocleanup(void);
452 struct inostat *inoinfo(ino_t inum);
453 void IOstats(char *what);
454 int linkup(ino_t orphan, ino_t parentdir, char *name);
455 int makeentry(ino_t parent, ino_t ino, const char *name);
456 void panic(const char *fmt, ...) __printflike(1, 2);
459 int pass1check(struct inodesc *);
463 int pass4check(struct inodesc *);
465 void pfatal(const char *fmt, ...) __printflike(1, 2);
466 void pinode(ino_t ino);
467 void propagate(void);
468 void pwarn(const char *fmt, ...) __printflike(1, 2);
469 int readsb(int listerr);
470 int reply(const char *question);
471 void rwerror(const char *mesg, ufs2_daddr_t blk);
472 void sblock_init(void);
473 void setinodebuf(ino_t);
474 int setup(char *dev);
475 void gjournal_check(const char *filesys);
476 int suj_check(const char *filesys);
477 void update_maps(struct cg *, struct cg*, int);
480 #endif /* !_FSCK_H_ */