xref: /freebsd/sbin/fsck_ffs/pass1.c (revision 47dd1d1b619cc035b82b49a91a25544309ff95ae)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
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 
32 #if 0
33 #ifndef lint
34 static const char sccsid[] = "@(#)pass1.c	8.6 (Berkeley) 4/28/95";
35 #endif /* not lint */
36 #endif
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
39 
40 #include <sys/param.h>
41 #include <sys/stat.h>
42 #include <sys/sysctl.h>
43 
44 #include <ufs/ufs/dinode.h>
45 #include <ufs/ufs/dir.h>
46 #include <ufs/ffs/fs.h>
47 
48 #include <err.h>
49 #include <limits.h>
50 #include <stdint.h>
51 #include <string.h>
52 
53 #include "fsck.h"
54 
55 static ufs2_daddr_t badblk;
56 static ufs2_daddr_t dupblk;
57 static ino_t lastino;		/* last inode in use */
58 
59 static int checkinode(ino_t inumber, struct inodesc *, int rebuildcg);
60 
61 void
62 pass1(void)
63 {
64 	struct inostat *info;
65 	struct inodesc idesc;
66 	struct bufarea *cgbp;
67 	struct cg *cgp;
68 	ino_t inumber, inosused, mininos;
69 	ufs2_daddr_t i, cgd;
70 	u_int8_t *cp;
71 	int c, rebuildcg;
72 
73 	badblk = dupblk = lastino = 0;
74 
75 	/*
76 	 * Set file system reserved blocks in used block map.
77 	 */
78 	for (c = 0; c < sblock.fs_ncg; c++) {
79 		cgd = cgdmin(&sblock, c);
80 		if (c == 0) {
81 			i = cgbase(&sblock, c);
82 		} else
83 			i = cgsblock(&sblock, c);
84 		for (; i < cgd; i++)
85 			setbmap(i);
86 	}
87 	i = sblock.fs_csaddr;
88 	cgd = i + howmany(sblock.fs_cssize, sblock.fs_fsize);
89 	for (; i < cgd; i++)
90 		setbmap(i);
91 
92 	/*
93 	 * Find all allocated blocks.
94 	 */
95 	memset(&idesc, 0, sizeof(struct inodesc));
96 	idesc.id_func = pass1check;
97 	n_files = n_blks = 0;
98 	for (c = 0; c < sblock.fs_ncg; c++) {
99 		inumber = c * sblock.fs_ipg;
100 		setinodebuf(inumber);
101 		cgbp = cglookup(c);
102 		cgp = cgbp->b_un.b_cg;
103 		rebuildcg = 0;
104 		if (!check_cgmagic(c, cgbp))
105 			rebuildcg = 1;
106 		if (!rebuildcg && sblock.fs_magic == FS_UFS2_MAGIC) {
107 			inosused = cgp->cg_initediblk;
108 			if (inosused > sblock.fs_ipg) {
109 				pfatal(
110 "Too many initialized inodes (%ju > %d) in cylinder group %d\nReset to %d\n",
111 				    (uintmax_t)inosused,
112 				    sblock.fs_ipg, c, sblock.fs_ipg);
113 				inosused = sblock.fs_ipg;
114 			}
115 		} else {
116 			inosused = sblock.fs_ipg;
117 		}
118 		if (got_siginfo) {
119 			printf("%s: phase 1: cyl group %d of %d (%d%%)\n",
120 			    cdevname, c, sblock.fs_ncg,
121 			    c * 100 / sblock.fs_ncg);
122 			got_siginfo = 0;
123 		}
124 		if (got_sigalarm) {
125 			setproctitle("%s p1 %d%%", cdevname,
126 			     c * 100 / sblock.fs_ncg);
127 			got_sigalarm = 0;
128 		}
129 		/*
130 		 * If we are using soft updates, then we can trust the
131 		 * cylinder group inode allocation maps to tell us which
132 		 * inodes are allocated. We will scan the used inode map
133 		 * to find the inodes that are really in use, and then
134 		 * read only those inodes in from disk.
135 		 */
136 		if ((preen || inoopt) && usedsoftdep && !rebuildcg) {
137 			cp = &cg_inosused(cgp)[(inosused - 1) / CHAR_BIT];
138 			for ( ; inosused != 0; cp--) {
139 				if (*cp == 0) {
140 					if (inosused > CHAR_BIT)
141 						inosused -= CHAR_BIT;
142 					else
143 						inosused = 0;
144 					continue;
145 				}
146 				for (i = 1 << (CHAR_BIT - 1); i > 0; i >>= 1) {
147 					if (*cp & i)
148 						break;
149 					inosused--;
150 				}
151 				break;
152 			}
153 		}
154 		/*
155 		 * Allocate inoinfo structures for the allocated inodes.
156 		 */
157 		inostathead[c].il_numalloced = inosused;
158 		if (inosused == 0) {
159 			inostathead[c].il_stat = NULL;
160 			continue;
161 		}
162 		info = Calloc((unsigned)inosused, sizeof(struct inostat));
163 		if (info == NULL)
164 			errx(EEXIT, "cannot alloc %u bytes for inoinfo",
165 			    (unsigned)(sizeof(struct inostat) * inosused));
166 		inostathead[c].il_stat = info;
167 		/*
168 		 * Scan the allocated inodes.
169 		 */
170 		for (i = 0; i < inosused; i++, inumber++) {
171 			if (inumber < UFS_ROOTINO) {
172 				(void)getnextinode(inumber, rebuildcg);
173 				continue;
174 			}
175 			/*
176 			 * NULL return indicates probable end of allocated
177 			 * inodes during cylinder group rebuild attempt.
178 			 * We always keep trying until we get to the minimum
179 			 * valid number for this cylinder group.
180 			 */
181 			if (checkinode(inumber, &idesc, rebuildcg) == 0 &&
182 			    i > cgp->cg_initediblk)
183 				break;
184 		}
185 		/*
186 		 * This optimization speeds up future runs of fsck
187 		 * by trimming down the number of inodes in cylinder
188 		 * groups that formerly had many inodes but now have
189 		 * fewer in use.
190 		 */
191 		mininos = roundup(inosused + INOPB(&sblock), INOPB(&sblock));
192 		if (inoopt && !preen && !rebuildcg &&
193 		    sblock.fs_magic == FS_UFS2_MAGIC &&
194 		    cgp->cg_initediblk > 2 * INOPB(&sblock) &&
195 		    mininos < cgp->cg_initediblk) {
196 			i = cgp->cg_initediblk;
197 			if (mininos < 2 * INOPB(&sblock))
198 				cgp->cg_initediblk = 2 * INOPB(&sblock);
199 			else
200 				cgp->cg_initediblk = mininos;
201 			pwarn("CYLINDER GROUP %d: RESET FROM %ju TO %d %s\n",
202 			    c, i, cgp->cg_initediblk, "VALID INODES");
203 			dirty(cgbp);
204 		}
205 		if (inosused < sblock.fs_ipg)
206 			continue;
207 		lastino += 1;
208 		if (lastino < (c * sblock.fs_ipg))
209 			inosused = 0;
210 		else
211 			inosused = lastino - (c * sblock.fs_ipg);
212 		if (rebuildcg && inosused > cgp->cg_initediblk &&
213 		    sblock.fs_magic == FS_UFS2_MAGIC) {
214 			cgp->cg_initediblk = roundup(inosused, INOPB(&sblock));
215 			pwarn("CYLINDER GROUP %d: FOUND %d VALID INODES\n", c,
216 			    cgp->cg_initediblk);
217 		}
218 		/*
219 		 * If we were not able to determine in advance which inodes
220 		 * were in use, then reduce the size of the inoinfo structure
221 		 * to the size necessary to describe the inodes that we
222 		 * really found.
223 		 */
224 		if (inumber == lastino)
225 			continue;
226 		inostathead[c].il_numalloced = inosused;
227 		if (inosused == 0) {
228 			free(inostathead[c].il_stat);
229 			inostathead[c].il_stat = NULL;
230 			continue;
231 		}
232 		info = Calloc((unsigned)inosused, sizeof(struct inostat));
233 		if (info == NULL)
234 			errx(EEXIT, "cannot alloc %u bytes for inoinfo",
235 			    (unsigned)(sizeof(struct inostat) * inosused));
236 		memmove(info, inostathead[c].il_stat, inosused * sizeof(*info));
237 		free(inostathead[c].il_stat);
238 		inostathead[c].il_stat = info;
239 	}
240 	freeinodebuf();
241 }
242 
243 static int
244 checkinode(ino_t inumber, struct inodesc *idesc, int rebuildcg)
245 {
246 	union dinode *dp;
247 	off_t kernmaxfilesize;
248 	ufs2_daddr_t ndb;
249 	mode_t mode;
250 	int j, ret, offset;
251 
252 	if ((dp = getnextinode(inumber, rebuildcg)) == NULL)
253 		return (0);
254 	mode = DIP(dp, di_mode) & IFMT;
255 	if (mode == 0) {
256 		if ((sblock.fs_magic == FS_UFS1_MAGIC &&
257 		     (memcmp(dp->dp1.di_db, ufs1_zino.di_db,
258 			UFS_NDADDR * sizeof(ufs1_daddr_t)) ||
259 		      memcmp(dp->dp1.di_ib, ufs1_zino.di_ib,
260 			UFS_NIADDR * sizeof(ufs1_daddr_t)) ||
261 		      dp->dp1.di_mode || dp->dp1.di_size)) ||
262 		    (sblock.fs_magic == FS_UFS2_MAGIC &&
263 		     (memcmp(dp->dp2.di_db, ufs2_zino.di_db,
264 			UFS_NDADDR * sizeof(ufs2_daddr_t)) ||
265 		      memcmp(dp->dp2.di_ib, ufs2_zino.di_ib,
266 			UFS_NIADDR * sizeof(ufs2_daddr_t)) ||
267 		      dp->dp2.di_mode || dp->dp2.di_size))) {
268 			pfatal("PARTIALLY ALLOCATED INODE I=%lu",
269 			    (u_long)inumber);
270 			if (reply("CLEAR") == 1) {
271 				dp = ginode(inumber);
272 				clearinode(dp);
273 				inodirty();
274 			}
275 		}
276 		inoinfo(inumber)->ino_state = USTATE;
277 		return (1);
278 	}
279 	lastino = inumber;
280 	/* This should match the file size limit in ffs_mountfs(). */
281 	if (sblock.fs_magic == FS_UFS1_MAGIC)
282 		kernmaxfilesize = (off_t)0x40000000 * sblock.fs_bsize - 1;
283 	else
284 		kernmaxfilesize = sblock.fs_maxfilesize;
285 	if (DIP(dp, di_size) > kernmaxfilesize ||
286 	    DIP(dp, di_size) > sblock.fs_maxfilesize ||
287 	    (mode == IFDIR && DIP(dp, di_size) > MAXDIRSIZE)) {
288 		if (debug)
289 			printf("bad size %ju:", (uintmax_t)DIP(dp, di_size));
290 		goto unknown;
291 	}
292 	if (!preen && mode == IFMT && reply("HOLD BAD BLOCK") == 1) {
293 		dp = ginode(inumber);
294 		DIP_SET(dp, di_size, sblock.fs_fsize);
295 		DIP_SET(dp, di_mode, IFREG|0600);
296 		inodirty();
297 	}
298 	if ((mode == IFBLK || mode == IFCHR || mode == IFIFO ||
299 	     mode == IFSOCK) && DIP(dp, di_size) != 0) {
300 		if (debug)
301 			printf("bad special-file size %ju:",
302 			    (uintmax_t)DIP(dp, di_size));
303 		goto unknown;
304 	}
305 	if ((mode == IFBLK || mode == IFCHR) &&
306 	    (dev_t)DIP(dp, di_rdev) == NODEV) {
307 		if (debug)
308 			printf("bad special-file rdev NODEV:");
309 		goto unknown;
310 	}
311 	ndb = howmany(DIP(dp, di_size), sblock.fs_bsize);
312 	if (ndb < 0) {
313 		if (debug)
314 			printf("bad size %ju ndb %ju:",
315 				(uintmax_t)DIP(dp, di_size), (uintmax_t)ndb);
316 		goto unknown;
317 	}
318 	if (mode == IFBLK || mode == IFCHR)
319 		ndb++;
320 	if (mode == IFLNK) {
321 		/*
322 		 * Fake ndb value so direct/indirect block checks below
323 		 * will detect any garbage after symlink string.
324 		 */
325 		if (DIP(dp, di_size) < (off_t)sblock.fs_maxsymlinklen) {
326 			if (sblock.fs_magic == FS_UFS1_MAGIC)
327 				ndb = howmany(DIP(dp, di_size),
328 				    sizeof(ufs1_daddr_t));
329 			else
330 				ndb = howmany(DIP(dp, di_size),
331 				    sizeof(ufs2_daddr_t));
332 			if (ndb > UFS_NDADDR) {
333 				j = ndb - UFS_NDADDR;
334 				for (ndb = 1; j > 1; j--)
335 					ndb *= NINDIR(&sblock);
336 				ndb += UFS_NDADDR;
337 			}
338 		}
339 	}
340 	for (j = ndb; ndb < UFS_NDADDR && j < UFS_NDADDR; j++)
341 		if (DIP(dp, di_db[j]) != 0) {
342 			if (debug)
343 				printf("bad direct addr[%d]: %ju\n", j,
344 				    (uintmax_t)DIP(dp, di_db[j]));
345 			goto unknown;
346 		}
347 	for (j = 0, ndb -= UFS_NDADDR; ndb > 0; j++)
348 		ndb /= NINDIR(&sblock);
349 	for (; j < UFS_NIADDR; j++)
350 		if (DIP(dp, di_ib[j]) != 0) {
351 			if (debug)
352 				printf("bad indirect addr: %ju\n",
353 				    (uintmax_t)DIP(dp, di_ib[j]));
354 			goto unknown;
355 		}
356 	if (ftypeok(dp) == 0)
357 		goto unknown;
358 	n_files++;
359 	inoinfo(inumber)->ino_linkcnt = DIP(dp, di_nlink);
360 	if (mode == IFDIR) {
361 		if (DIP(dp, di_size) == 0)
362 			inoinfo(inumber)->ino_state = DCLEAR;
363 		else if (DIP(dp, di_nlink) <= 0)
364 			inoinfo(inumber)->ino_state = DZLINK;
365 		else
366 			inoinfo(inumber)->ino_state = DSTATE;
367 		cacheino(dp, inumber);
368 		countdirs++;
369 	} else if (DIP(dp, di_nlink) <= 0)
370 		inoinfo(inumber)->ino_state = FZLINK;
371 	else
372 		inoinfo(inumber)->ino_state = FSTATE;
373 	inoinfo(inumber)->ino_type = IFTODT(mode);
374 	badblk = dupblk = 0;
375 	idesc->id_number = inumber;
376 	if (DIP(dp, di_flags) & SF_SNAPSHOT)
377 		idesc->id_type = SNAP;
378 	else
379 		idesc->id_type = ADDR;
380 	(void)ckinode(dp, idesc);
381 	if (sblock.fs_magic == FS_UFS2_MAGIC && dp->dp2.di_extsize > 0) {
382 		idesc->id_type = ADDR;
383 		ndb = howmany(dp->dp2.di_extsize, sblock.fs_bsize);
384 		for (j = 0; j < UFS_NXADDR; j++) {
385 			if (--ndb == 0 &&
386 			    (offset = blkoff(&sblock, dp->dp2.di_extsize)) != 0)
387 				idesc->id_numfrags = numfrags(&sblock,
388 				    fragroundup(&sblock, offset));
389 			else
390 				idesc->id_numfrags = sblock.fs_frag;
391 			if (dp->dp2.di_extb[j] == 0)
392 				continue;
393 			idesc->id_blkno = dp->dp2.di_extb[j];
394 			ret = (*idesc->id_func)(idesc);
395 			if (ret & STOP)
396 				break;
397 		}
398 	}
399 	if (sblock.fs_magic == FS_UFS2_MAGIC)
400 		eascan(idesc, &dp->dp2);
401 	idesc->id_entryno *= btodb(sblock.fs_fsize);
402 	if (DIP(dp, di_blocks) != idesc->id_entryno) {
403 		pwarn("INCORRECT BLOCK COUNT I=%lu (%ju should be %ju)",
404 		    (u_long)inumber, (uintmax_t)DIP(dp, di_blocks),
405 		    (uintmax_t)idesc->id_entryno);
406 		if (preen)
407 			printf(" (CORRECTED)\n");
408 		else if (reply("CORRECT") == 0)
409 			return (1);
410 		if (bkgrdflag == 0) {
411 			dp = ginode(inumber);
412 			DIP_SET(dp, di_blocks, idesc->id_entryno);
413 			inodirty();
414 		} else {
415 			cmd.value = idesc->id_number;
416 			cmd.size = idesc->id_entryno - DIP(dp, di_blocks);
417 			if (debug)
418 				printf("adjblkcnt ino %ju amount %lld\n",
419 				    (uintmax_t)cmd.value, (long long)cmd.size);
420 			if (sysctl(adjblkcnt, MIBSIZE, 0, 0,
421 			    &cmd, sizeof cmd) == -1)
422 				rwerror("ADJUST INODE BLOCK COUNT", cmd.value);
423 		}
424 	}
425 	return (1);
426 unknown:
427 	pfatal("UNKNOWN FILE TYPE I=%lu", (u_long)inumber);
428 	inoinfo(inumber)->ino_state = FCLEAR;
429 	if (reply("CLEAR") == 1) {
430 		inoinfo(inumber)->ino_state = USTATE;
431 		dp = ginode(inumber);
432 		clearinode(dp);
433 		inodirty();
434 	}
435 	return (1);
436 }
437 
438 int
439 pass1check(struct inodesc *idesc)
440 {
441 	int res = KEEPON;
442 	int anyout, nfrags;
443 	ufs2_daddr_t blkno = idesc->id_blkno;
444 	struct dups *dlp;
445 	struct dups *new;
446 
447 	if (idesc->id_type == SNAP) {
448 		if (blkno == BLK_NOCOPY)
449 			return (KEEPON);
450 		if (idesc->id_number == cursnapshot) {
451 			if (blkno == blkstofrags(&sblock, idesc->id_lbn))
452 				return (KEEPON);
453 			if (blkno == BLK_SNAP) {
454 				blkno = blkstofrags(&sblock, idesc->id_lbn);
455 				idesc->id_entryno -= idesc->id_numfrags;
456 			}
457 		} else {
458 			if (blkno == BLK_SNAP)
459 				return (KEEPON);
460 		}
461 	}
462 	if ((anyout = chkrange(blkno, idesc->id_numfrags)) != 0) {
463 		blkerror(idesc->id_number, "BAD", blkno);
464 		if (badblk++ >= MAXBAD) {
465 			pwarn("EXCESSIVE BAD BLKS I=%lu",
466 			    (u_long)idesc->id_number);
467 			if (preen)
468 				printf(" (SKIPPING)\n");
469 			else if (reply("CONTINUE") == 0) {
470 				ckfini(0);
471 				exit(EEXIT);
472 			}
473 			rerun = 1;
474 			return (STOP);
475 		}
476 	}
477 	for (nfrags = idesc->id_numfrags; nfrags > 0; blkno++, nfrags--) {
478 		if (anyout && chkrange(blkno, 1)) {
479 			res = SKIP;
480 		} else if (!testbmap(blkno)) {
481 			n_blks++;
482 			setbmap(blkno);
483 		} else {
484 			blkerror(idesc->id_number, "DUP", blkno);
485 			if (dupblk++ >= MAXDUP) {
486 				pwarn("EXCESSIVE DUP BLKS I=%lu",
487 					(u_long)idesc->id_number);
488 				if (preen)
489 					printf(" (SKIPPING)\n");
490 				else if (reply("CONTINUE") == 0) {
491 					ckfini(0);
492 					exit(EEXIT);
493 				}
494 				rerun = 1;
495 				return (STOP);
496 			}
497 			new = (struct dups *)Malloc(sizeof(struct dups));
498 			if (new == NULL) {
499 				pfatal("DUP TABLE OVERFLOW.");
500 				if (reply("CONTINUE") == 0) {
501 					ckfini(0);
502 					exit(EEXIT);
503 				}
504 				rerun = 1;
505 				return (STOP);
506 			}
507 			new->dup = blkno;
508 			if (muldup == NULL) {
509 				duplist = muldup = new;
510 				new->next = NULL;
511 			} else {
512 				new->next = muldup->next;
513 				muldup->next = new;
514 			}
515 			for (dlp = duplist; dlp != muldup; dlp = dlp->next)
516 				if (dlp->dup == blkno)
517 					break;
518 			if (dlp == muldup && dlp->dup != blkno)
519 				muldup = new;
520 		}
521 		/*
522 		 * count the number of blocks found in id_entryno
523 		 */
524 		idesc->id_entryno++;
525 	}
526 	return (res);
527 }
528