xref: /freebsd/sbin/fsck_ffs/setup.c (revision 8657387683946d0c03e09fe77029edfe309eeb20)
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. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #if 0
31 #ifndef lint
32 static const char sccsid[] = "@(#)setup.c	8.10 (Berkeley) 5/9/95";
33 #endif /* not lint */
34 #endif
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37 
38 #include <sys/param.h>
39 #include <sys/stat.h>
40 #define FSTYPENAMES
41 #include <sys/disklabel.h>
42 #include <sys/file.h>
43 #include <sys/sysctl.h>
44 
45 #include <ufs/ufs/dinode.h>
46 #include <ufs/ffs/fs.h>
47 
48 #include <ctype.h>
49 #include <err.h>
50 #include <errno.h>
51 #include <limits.h>
52 #include <stdint.h>
53 #include <string.h>
54 
55 #include "fsck.h"
56 
57 struct bufarea asblk;
58 #define altsblock (*asblk.b_un.b_fs)
59 #define POWEROF2(num)	(((num) & ((num) - 1)) == 0)
60 
61 static int calcsb(char *dev, int devfd, struct fs *fs);
62 static void saverecovery(int readfd, int writefd);
63 static int chkrecovery(int devfd);
64 
65 /*
66  * Read in a superblock finding an alternate if necessary.
67  * Return 1 if successful, 0 if unsuccessful, -1 if file system
68  * is already clean (ckclean and preen mode only).
69  */
70 int
71 setup(char *dev)
72 {
73 	long cg, asked, i, j;
74 	long bmapsize;
75 	struct stat statb;
76 	struct fs proto;
77 	size_t size;
78 
79 	havesb = 0;
80 	fswritefd = -1;
81 	cursnapshot = 0;
82 	if (stat(dev, &statb) < 0) {
83 		printf("Can't stat %s: %s\n", dev, strerror(errno));
84 		if (bkgrdflag) {
85 			unlink(snapname);
86 			bkgrdflag = 0;
87 		}
88 		return (0);
89 	}
90 	if ((statb.st_mode & S_IFMT) != S_IFCHR &&
91 	    (statb.st_mode & S_IFMT) != S_IFBLK) {
92 		if (bkgrdflag != 0 && (statb.st_flags & SF_SNAPSHOT) == 0) {
93 			unlink(snapname);
94 			printf("background fsck lacks a snapshot\n");
95 			exit(EEXIT);
96 		}
97 		if ((statb.st_flags & SF_SNAPSHOT) != 0 && cvtlevel == 0) {
98 			cursnapshot = statb.st_ino;
99 		} else {
100 			if (cvtlevel == 0 ||
101 			    (statb.st_flags & SF_SNAPSHOT) == 0) {
102 				if (preen && bkgrdflag) {
103 					unlink(snapname);
104 					bkgrdflag = 0;
105 				}
106 				pfatal("%s is not a disk device", dev);
107 				if (reply("CONTINUE") == 0) {
108 					if (bkgrdflag) {
109 						unlink(snapname);
110 						bkgrdflag = 0;
111 					}
112 					return (0);
113 				}
114 			} else {
115 				if (bkgrdflag) {
116 					unlink(snapname);
117 					bkgrdflag = 0;
118 				}
119 				pfatal("cannot convert a snapshot");
120 				exit(EEXIT);
121 			}
122 		}
123 	}
124 	if ((fsreadfd = open(dev, O_RDONLY)) < 0) {
125 		if (bkgrdflag) {
126 			unlink(snapname);
127 			bkgrdflag = 0;
128 		}
129 		printf("Can't open %s: %s\n", dev, strerror(errno));
130 		return (0);
131 	}
132 	if (bkgrdflag) {
133 		unlink(snapname);
134 		size = MIBSIZE;
135 		if (sysctlnametomib("vfs.ffs.adjrefcnt", adjrefcnt, &size) < 0||
136 		    sysctlnametomib("vfs.ffs.adjblkcnt", adjblkcnt, &size) < 0||
137 		    sysctlnametomib("vfs.ffs.freefiles", freefiles, &size) < 0||
138 		    sysctlnametomib("vfs.ffs.freedirs", freedirs, &size) < 0 ||
139 		    sysctlnametomib("vfs.ffs.freeblks", freeblks, &size) < 0) {
140 			pfatal("kernel lacks background fsck support\n");
141 			exit(EEXIT);
142 		}
143 		/*
144 		 * When kernel is lack of runtime bgfsck superblock summary
145 		 * adjustment functionality, it does not mean we can not
146 		 * continue, as old kernels will recompute the summary at
147 		 * mount time.  However, it will be an unexpected softupdates
148 		 * inconsistency if it turns out that the summary is still
149 		 * incorrect.  Set a flag so subsequent operation can know
150 		 * this.
151 		 */
152 		bkgrdsumadj = 1;
153 		if (sysctlnametomib("vfs.ffs.adjndir", adjndir, &size) < 0 ||
154 		    sysctlnametomib("vfs.ffs.adjnbfree", adjnbfree, &size) < 0 ||
155 		    sysctlnametomib("vfs.ffs.adjnifree", adjnifree, &size) < 0 ||
156 		    sysctlnametomib("vfs.ffs.adjnffree", adjnffree, &size) < 0 ||
157 		    sysctlnametomib("vfs.ffs.adjnumclusters", adjnumclusters, &size) < 0) {
158 			bkgrdsumadj = 0;
159 			pwarn("kernel lacks runtime superblock summary adjustment support");
160 		}
161 		cmd.version = FFS_CMD_VERSION;
162 		cmd.handle = fsreadfd;
163 		fswritefd = -1;
164 	}
165 	if (preen == 0)
166 		printf("** %s", dev);
167 	if (bkgrdflag == 0 &&
168 	    (nflag || (fswritefd = open(dev, O_WRONLY)) < 0)) {
169 		fswritefd = -1;
170 		if (preen)
171 			pfatal("NO WRITE ACCESS");
172 		printf(" (NO WRITE)");
173 	}
174 	if (preen == 0)
175 		printf("\n");
176 	/*
177 	 * Read in the superblock, looking for alternates if necessary
178 	 */
179 	if (readsb(1) == 0) {
180 		skipclean = 0;
181 		if (bflag || preen || calcsb(dev, fsreadfd, &proto) == 0)
182 			return(0);
183 		if (reply("LOOK FOR ALTERNATE SUPERBLOCKS") == 0)
184 			return (0);
185 		for (cg = 0; cg < proto.fs_ncg; cg++) {
186 			bflag = fsbtodb(&proto, cgsblock(&proto, cg));
187 			if (readsb(0) != 0)
188 				break;
189 		}
190 		if (cg >= proto.fs_ncg) {
191 			printf("%s %s\n%s %s\n%s %s\n",
192 				"SEARCH FOR ALTERNATE SUPER-BLOCK",
193 				"FAILED. YOU MUST USE THE",
194 				"-b OPTION TO FSCK TO SPECIFY THE",
195 				"LOCATION OF AN ALTERNATE",
196 				"SUPER-BLOCK TO SUPPLY NEEDED",
197 				"INFORMATION; SEE fsck_ffs(8).");
198 			bflag = 0;
199 			return(0);
200 		}
201 		pwarn("USING ALTERNATE SUPERBLOCK AT %jd\n", bflag);
202 		bflag = 0;
203 	}
204 	if (skipclean && ckclean && sblock.fs_clean) {
205 		pwarn("FILE SYSTEM CLEAN; SKIPPING CHECKS\n");
206 		return (-1);
207 	}
208 	maxfsblock = sblock.fs_size;
209 	maxino = sblock.fs_ncg * sblock.fs_ipg;
210 	/*
211 	 * Check and potentially fix certain fields in the super block.
212 	 */
213 	if (sblock.fs_optim != FS_OPTTIME && sblock.fs_optim != FS_OPTSPACE) {
214 		pfatal("UNDEFINED OPTIMIZATION IN SUPERBLOCK");
215 		if (reply("SET TO DEFAULT") == 1) {
216 			sblock.fs_optim = FS_OPTTIME;
217 			sbdirty();
218 		}
219 	}
220 	if ((sblock.fs_minfree < 0 || sblock.fs_minfree > 99)) {
221 		pfatal("IMPOSSIBLE MINFREE=%d IN SUPERBLOCK",
222 			sblock.fs_minfree);
223 		if (reply("SET TO DEFAULT") == 1) {
224 			sblock.fs_minfree = 10;
225 			sbdirty();
226 		}
227 	}
228 	if (sblock.fs_magic == FS_UFS1_MAGIC &&
229 	    sblock.fs_old_inodefmt < FS_44INODEFMT) {
230 		pwarn("Format of file system is too old.\n");
231 		pwarn("Must update to modern format using a version of fsck\n");
232 		pfatal("from before 2002 with the command ``fsck -c 2''\n");
233 		exit(EEXIT);
234 	}
235 	if (asblk.b_dirty && !bflag) {
236 		memmove(&altsblock, &sblock, (size_t)sblock.fs_sbsize);
237 		flush(fswritefd, &asblk);
238 	}
239 	if (preen == 0 && yflag == 0 && sblock.fs_magic == FS_UFS2_MAGIC &&
240 	    fswritefd != -1 && chkrecovery(fsreadfd) == 0 &&
241 	    reply("SAVE DATA TO FIND ALTERNATE SUPERBLOCKS") != 0)
242 		saverecovery(fsreadfd, fswritefd);
243 	/*
244 	 * read in the summary info.
245 	 */
246 	asked = 0;
247 	sblock.fs_csp = Calloc(1, sblock.fs_cssize);
248 	if (sblock.fs_csp == NULL) {
249 		printf("cannot alloc %u bytes for cg summary info\n",
250 		    (unsigned)sblock.fs_cssize);
251 		goto badsb;
252 	}
253 	for (i = 0, j = 0; i < sblock.fs_cssize; i += sblock.fs_bsize, j++) {
254 		size = MIN(sblock.fs_cssize - i, sblock.fs_bsize);
255 		readcnt[sblk.b_type]++;
256 		if (blread(fsreadfd, (char *)sblock.fs_csp + i,
257 		    fsbtodb(&sblock, sblock.fs_csaddr + j * sblock.fs_frag),
258 		    size) != 0 && !asked) {
259 			pfatal("BAD SUMMARY INFORMATION");
260 			if (reply("CONTINUE") == 0) {
261 				ckfini(0);
262 				exit(EEXIT);
263 			}
264 			asked++;
265 		}
266 	}
267 	/*
268 	 * allocate and initialize the necessary maps
269 	 */
270 	bmapsize = roundup(howmany(maxfsblock, CHAR_BIT), sizeof(short));
271 	blockmap = Calloc((unsigned)bmapsize, sizeof (char));
272 	if (blockmap == NULL) {
273 		printf("cannot alloc %u bytes for blockmap\n",
274 		    (unsigned)bmapsize);
275 		goto badsb;
276 	}
277 	inostathead = Calloc(sblock.fs_ncg, sizeof(struct inostatlist));
278 	if (inostathead == NULL) {
279 		printf("cannot alloc %u bytes for inostathead\n",
280 		    (unsigned)(sizeof(struct inostatlist) * (sblock.fs_ncg)));
281 		goto badsb;
282 	}
283 	numdirs = MAX(sblock.fs_cstotal.cs_ndir, 128);
284 	dirhash = numdirs;
285 	inplast = 0;
286 	listmax = numdirs + 10;
287 	inpsort = (struct inoinfo **)Calloc(listmax, sizeof(struct inoinfo *));
288 	inphead = (struct inoinfo **)Calloc(numdirs, sizeof(struct inoinfo *));
289 	if (inpsort == NULL || inphead == NULL) {
290 		printf("cannot alloc %ju bytes for inphead\n",
291 		    (uintmax_t)numdirs * sizeof(struct inoinfo *));
292 		goto badsb;
293 	}
294 	bufinit();
295 	if (sblock.fs_flags & FS_DOSOFTDEP)
296 		usedsoftdep = 1;
297 	else
298 		usedsoftdep = 0;
299 	return (1);
300 
301 badsb:
302 	ckfini(0);
303 	return (0);
304 }
305 
306 /*
307  * Possible superblock locations ordered from most to least likely.
308  */
309 static int sblock_try[] = SBLOCKSEARCH;
310 
311 #define BAD_MAGIC_MSG \
312 "The previous newfs operation on this volume did not complete.\n" \
313 "You must complete newfs before mounting this volume.\n"
314 
315 /*
316  * Read in the super block and its summary info.
317  */
318 int
319 readsb(int listerr)
320 {
321 	ufs2_daddr_t super;
322 	int i, bad;
323 
324 	if (bflag) {
325 		super = bflag;
326 		readcnt[sblk.b_type]++;
327 		if ((blread(fsreadfd, (char *)&sblock, super, (long)SBLOCKSIZE)))
328 			return (0);
329 		if (sblock.fs_magic == FS_BAD_MAGIC) {
330 			fprintf(stderr, BAD_MAGIC_MSG);
331 			exit(11);
332 		}
333 		if (sblock.fs_magic != FS_UFS1_MAGIC &&
334 		    sblock.fs_magic != FS_UFS2_MAGIC) {
335 			fprintf(stderr, "%jd is not a file system superblock\n",
336 			    bflag);
337 			return (0);
338 		}
339 	} else {
340 		for (i = 0; sblock_try[i] != -1; i++) {
341 			super = sblock_try[i] / dev_bsize;
342 			readcnt[sblk.b_type]++;
343 			if ((blread(fsreadfd, (char *)&sblock, super,
344 			    (long)SBLOCKSIZE)))
345 				return (0);
346 			if (sblock.fs_magic == FS_BAD_MAGIC) {
347 				fprintf(stderr, BAD_MAGIC_MSG);
348 				exit(11);
349 			}
350 			if ((sblock.fs_magic == FS_UFS1_MAGIC ||
351 			     (sblock.fs_magic == FS_UFS2_MAGIC &&
352 			      sblock.fs_sblockloc == sblock_try[i])) &&
353 			    sblock.fs_ncg >= 1 &&
354 			    sblock.fs_bsize >= MINBSIZE &&
355 			    sblock.fs_sbsize >= roundup(sizeof(struct fs), dev_bsize))
356 				break;
357 		}
358 		if (sblock_try[i] == -1) {
359 			fprintf(stderr, "Cannot find file system superblock\n");
360 			return (0);
361 		}
362 	}
363 	/*
364 	 * Compute block size that the file system is based on,
365 	 * according to fsbtodb, and adjust superblock block number
366 	 * so we can tell if this is an alternate later.
367 	 */
368 	super *= dev_bsize;
369 	dev_bsize = sblock.fs_fsize / fsbtodb(&sblock, 1);
370 	sblk.b_bno = super / dev_bsize;
371 	sblk.b_size = SBLOCKSIZE;
372 	/*
373 	 * Compare all fields that should not differ in alternate super block.
374 	 * When an alternate super-block is specified this check is skipped.
375 	 */
376 	if (bflag)
377 		goto out;
378 	getblk(&asblk, cgsblock(&sblock, sblock.fs_ncg - 1), sblock.fs_sbsize);
379 	if (asblk.b_errs)
380 		return (0);
381 	bad = 0;
382 #define CHK(x, y)				\
383 	if (altsblock.x != sblock.x) {		\
384 		bad++;				\
385 		if (listerr && debug)		\
386 			printf("SUPER BLOCK VS ALTERNATE MISMATCH %s: " y " vs " y "\n", \
387 			    #x, (intmax_t)sblock.x, (intmax_t)altsblock.x); \
388 	}
389 	CHK(fs_sblkno, "%jd");
390 	CHK(fs_cblkno, "%jd");
391 	CHK(fs_iblkno, "%jd");
392 	CHK(fs_dblkno, "%jd");
393 	CHK(fs_ncg, "%jd");
394 	CHK(fs_bsize, "%jd");
395 	CHK(fs_fsize, "%jd");
396 	CHK(fs_frag, "%jd");
397 	CHK(fs_bmask, "%#jx");
398 	CHK(fs_fmask, "%#jx");
399 	CHK(fs_bshift, "%jd");
400 	CHK(fs_fshift, "%jd");
401 	CHK(fs_fragshift, "%jd");
402 	CHK(fs_fsbtodb, "%jd");
403 	CHK(fs_sbsize, "%jd");
404 	CHK(fs_nindir, "%jd");
405 	CHK(fs_inopb, "%jd");
406 	CHK(fs_cssize, "%jd");
407 	CHK(fs_ipg, "%jd");
408 	CHK(fs_fpg, "%jd");
409 	CHK(fs_magic, "%#jx");
410 #undef CHK
411 	if (bad) {
412 		if (listerr == 0)
413 			return (0);
414 		if (preen)
415 			printf("%s: ", cdevname);
416 		printf(
417 		    "VALUES IN SUPER BLOCK LSB=%jd DISAGREE WITH THOSE IN\n"
418 		    "LAST ALTERNATE LSB=%jd\n",
419 		    sblk.b_bno, asblk.b_bno);
420 		if (reply("IGNORE ALTERNATE SUPER BLOCK") == 0)
421 			return (0);
422 	}
423 out:
424 	/*
425 	 * If not yet done, update UFS1 superblock with new wider fields.
426 	 */
427 	if (sblock.fs_magic == FS_UFS1_MAGIC &&
428 	    sblock.fs_maxbsize != sblock.fs_bsize) {
429 		sblock.fs_maxbsize = sblock.fs_bsize;
430 		sblock.fs_time = sblock.fs_old_time;
431 		sblock.fs_size = sblock.fs_old_size;
432 		sblock.fs_dsize = sblock.fs_old_dsize;
433 		sblock.fs_csaddr = sblock.fs_old_csaddr;
434 		sblock.fs_cstotal.cs_ndir = sblock.fs_old_cstotal.cs_ndir;
435 		sblock.fs_cstotal.cs_nbfree = sblock.fs_old_cstotal.cs_nbfree;
436 		sblock.fs_cstotal.cs_nifree = sblock.fs_old_cstotal.cs_nifree;
437 		sblock.fs_cstotal.cs_nffree = sblock.fs_old_cstotal.cs_nffree;
438 	}
439 	havesb = 1;
440 	return (1);
441 }
442 
443 void
444 sblock_init(void)
445 {
446 
447 	fswritefd = -1;
448 	fsmodified = 0;
449 	lfdir = 0;
450 	initbarea(&sblk, BT_SUPERBLK);
451 	initbarea(&asblk, BT_SUPERBLK);
452 	sblk.b_un.b_buf = Malloc(SBLOCKSIZE);
453 	asblk.b_un.b_buf = Malloc(SBLOCKSIZE);
454 	if (sblk.b_un.b_buf == NULL || asblk.b_un.b_buf == NULL)
455 		errx(EEXIT, "cannot allocate space for superblock");
456 	dev_bsize = secsize = DEV_BSIZE;
457 }
458 
459 /*
460  * Calculate a prototype superblock based on information in the boot area.
461  * When done the cgsblock macro can be calculated and the fs_ncg field
462  * can be used. Do NOT attempt to use other macros without verifying that
463  * their needed information is available!
464  */
465 static int
466 calcsb(char *dev, int devfd, struct fs *fs)
467 {
468 	struct fsrecovery fsr;
469 
470 	/*
471 	 * We need fragments-per-group and the partition-size.
472 	 *
473 	 * Newfs stores these details at the end of the boot block area
474 	 * at the start of the filesystem partition. If they have been
475 	 * overwritten by a boot block, we fail. But usually they are
476 	 * there and we can use them.
477 	 */
478 	if (blread(devfd, (char *)&fsr,
479 	    (SBLOCK_UFS2 - sizeof(fsr)) / dev_bsize, sizeof(fsr)) ||
480 	    fsr.fsr_magic != FS_UFS2_MAGIC)
481 		return (0);
482 	memset(fs, 0, sizeof(struct fs));
483 	fs->fs_fpg = fsr.fsr_fpg;
484 	fs->fs_fsbtodb = fsr.fsr_fsbtodb;
485 	fs->fs_sblkno = fsr.fsr_sblkno;
486 	fs->fs_magic = fsr.fsr_magic;
487 	fs->fs_ncg = fsr.fsr_ncg;
488 	return (1);
489 }
490 
491 /*
492  * Check to see if recovery information exists.
493  */
494 static int
495 chkrecovery(int devfd)
496 {
497 	struct fsrecovery fsr;
498 
499 	if (blread(devfd, (char *)&fsr,
500 	    (SBLOCK_UFS2 - sizeof(fsr)) / dev_bsize, sizeof(fsr)) ||
501 	    fsr.fsr_magic != FS_UFS2_MAGIC)
502 		return (0);
503 	return (1);
504 }
505 
506 /*
507  * Read the last sector of the boot block, replace the last
508  * 20 bytes with the recovery information, then write it back.
509  * The recovery information only works for UFS2 filesystems.
510  */
511 static void
512 saverecovery(int readfd, int writefd)
513 {
514 	struct fsrecovery fsr;
515 
516 	if (sblock.fs_magic != FS_UFS2_MAGIC ||
517 	    blread(readfd, (char *)&fsr,
518 	    (SBLOCK_UFS2 - sizeof(fsr)) / dev_bsize, sizeof(fsr)))
519 		return;
520 	fsr.fsr_magic = sblock.fs_magic;
521 	fsr.fsr_fpg = sblock.fs_fpg;
522 	fsr.fsr_fsbtodb = sblock.fs_fsbtodb;
523 	fsr.fsr_sblkno = sblock.fs_sblkno;
524 	fsr.fsr_ncg = sblock.fs_ncg;
525 	blwrite(writefd, (char *)&fsr, (SBLOCK_UFS2 - sizeof(fsr)) / dev_bsize,
526 	    sizeof(fsr));
527 }
528