xref: /freebsd/sbin/fsck_ffs/setup.c (revision 7be9a3b45356747f9fcb6d69a722c1c95f8060bf)
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[] = "@(#)setup.c	8.10 (Berkeley) 5/9/95";
35 #endif /* not lint */
36 #endif
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
39 
40 #include <sys/param.h>
41 #include <sys/disk.h>
42 #include <sys/stat.h>
43 #define FSTYPENAMES
44 #include <sys/disklabel.h>
45 #include <sys/file.h>
46 #include <sys/sysctl.h>
47 
48 #include <ufs/ufs/dinode.h>
49 #include <ufs/ffs/fs.h>
50 
51 #include <ctype.h>
52 #include <err.h>
53 #include <errno.h>
54 #include <limits.h>
55 #include <stdint.h>
56 #include <string.h>
57 #include <libufs.h>
58 
59 #include "fsck.h"
60 
61 struct inoinfo **inphead, **inpsort;	/* info about all inodes */
62 
63 struct bufarea asblk;
64 #define altsblock (*asblk.b_un.b_fs)
65 #define POWEROF2(num)	(((num) & ((num) - 1)) == 0)
66 
67 static int calcsb(char *dev, int devfd, struct fs *fs);
68 static void saverecovery(int readfd, int writefd);
69 static int chkrecovery(int devfd);
70 
71 /*
72  * Read in a superblock finding an alternate if necessary.
73  * Return 1 if successful, 0 if unsuccessful, -1 if file system
74  * is already clean (ckclean and preen mode only).
75  */
76 int
77 setup(char *dev)
78 {
79 	long cg, bmapsize;
80 	struct fs proto;
81 
82 	/*
83 	 * We are expected to have an open file descriptor
84 	 */
85 	if (fsreadfd < 0)
86 		return (0);
87 	/*
88 	 * If we do not yet have a superblock, read it in looking
89 	 * for alternates if necessary.
90 	 */
91 	if (havesb == 0 && readsb(1) == 0) {
92 		skipclean = 0;
93 		if (bflag || preen || calcsb(dev, fsreadfd, &proto) == 0)
94 			return(0);
95 		if (reply("LOOK FOR ALTERNATE SUPERBLOCKS") == 0)
96 			return (0);
97 		for (cg = 0; cg < proto.fs_ncg; cg++) {
98 			bflag = fsbtodb(&proto, cgsblock(&proto, cg));
99 			if (readsb(0) != 0)
100 				break;
101 		}
102 		if (cg >= proto.fs_ncg) {
103 			printf("SEARCH FOR ALTERNATE SUPER-BLOCK FAILED. "
104 			    "YOU MUST USE THE\n-b OPTION TO FSCK TO SPECIFY "
105 			    "THE LOCATION OF AN ALTERNATE\nSUPER-BLOCK TO "
106 			    "SUPPLY NEEDED INFORMATION; SEE fsck_ffs(8).\n");
107 			bflag = 0;
108 			return(0);
109 		}
110 		pwarn("USING ALTERNATE SUPERBLOCK AT %jd\n", bflag);
111 		bflag = 0;
112 	}
113 	if (preen == 0)
114 		printf("** %s", dev);
115 	if (bkgrdflag == 0 &&
116 	    (nflag || (fswritefd = open(dev, O_WRONLY)) < 0)) {
117 		fswritefd = -1;
118 		if (preen)
119 			pfatal("NO WRITE ACCESS");
120 		printf(" (NO WRITE)");
121 	}
122 	if (preen == 0)
123 		printf("\n");
124 	if (sbhashfailed != 0) {
125 		pwarn("SUPERBLOCK CHECK HASH FAILED");
126 		if (fswritefd == -1)
127 			pwarn("OPENED READONLY SO CANNOT CORRECT CHECK HASH\n");
128 		else if (preen || reply("CORRECT CHECK HASH") != 0) {
129 			if (preen)
130 				printf(" (CORRECTED)\n");
131 			sblock.fs_clean = 0;
132 			sbdirty();
133 		}
134 	}
135 	if (skipclean && ckclean && sblock.fs_clean) {
136 		pwarn("FILE SYSTEM CLEAN; SKIPPING CHECKS\n");
137 		return (-1);
138 	}
139 	maxfsblock = sblock.fs_size;
140 	maxino = sblock.fs_ncg * sblock.fs_ipg;
141 	/*
142 	 * Check and potentially fix certain fields in the super block.
143 	 */
144 	if (sblock.fs_optim != FS_OPTTIME && sblock.fs_optim != FS_OPTSPACE) {
145 		pfatal("UNDEFINED OPTIMIZATION IN SUPERBLOCK");
146 		if (reply("SET TO DEFAULT") == 1) {
147 			sblock.fs_optim = FS_OPTTIME;
148 			sbdirty();
149 		}
150 	}
151 	if ((sblock.fs_minfree < 0 || sblock.fs_minfree > 99)) {
152 		pfatal("IMPOSSIBLE MINFREE=%d IN SUPERBLOCK",
153 			sblock.fs_minfree);
154 		if (reply("SET TO DEFAULT") == 1) {
155 			sblock.fs_minfree = 10;
156 			sbdirty();
157 		}
158 	}
159 	if (sblock.fs_magic == FS_UFS1_MAGIC &&
160 	    sblock.fs_old_inodefmt < FS_44INODEFMT) {
161 		pwarn("Format of file system is too old.\n");
162 		pwarn("Must update to modern format using a version of fsck\n");
163 		pfatal("from before 2002 with the command ``fsck -c 2''\n");
164 		exit(EEXIT);
165 	}
166 	if ((asblk.b_flags & B_DIRTY) != 0 && !bflag) {
167 		memmove(&altsblock, &sblock, (size_t)sblock.fs_sbsize);
168 		flush(fswritefd, &asblk);
169 	}
170 	if (preen == 0 && yflag == 0 && sblock.fs_magic == FS_UFS2_MAGIC &&
171 	    fswritefd != -1 && chkrecovery(fsreadfd) == 0 &&
172 	    reply("SAVE DATA TO FIND ALTERNATE SUPERBLOCKS") != 0)
173 		saverecovery(fsreadfd, fswritefd);
174 	/*
175 	 * allocate and initialize the necessary maps
176 	 */
177 	bmapsize = roundup(howmany(maxfsblock, CHAR_BIT), sizeof(short));
178 	blockmap = Calloc((unsigned)bmapsize, sizeof (char));
179 	if (blockmap == NULL) {
180 		printf("cannot alloc %u bytes for blockmap\n",
181 		    (unsigned)bmapsize);
182 		goto badsb;
183 	}
184 	inostathead = Calloc(sblock.fs_ncg, sizeof(struct inostatlist));
185 	if (inostathead == NULL) {
186 		printf("cannot alloc %u bytes for inostathead\n",
187 		    (unsigned)(sizeof(struct inostatlist) * (sblock.fs_ncg)));
188 		goto badsb;
189 	}
190 	numdirs = MAX(sblock.fs_cstotal.cs_ndir, 128);
191 	dirhash = numdirs;
192 	inplast = 0;
193 	listmax = numdirs + 10;
194 	inpsort = (struct inoinfo **)Calloc(listmax, sizeof(struct inoinfo *));
195 	inphead = (struct inoinfo **)Calloc(numdirs, sizeof(struct inoinfo *));
196 	if (inpsort == NULL || inphead == NULL) {
197 		printf("cannot alloc %ju bytes for inphead\n",
198 		    (uintmax_t)numdirs * sizeof(struct inoinfo *));
199 		goto badsb;
200 	}
201 	bufinit();
202 	if (sblock.fs_flags & FS_DOSOFTDEP)
203 		usedsoftdep = 1;
204 	else
205 		usedsoftdep = 0;
206 	return (1);
207 
208 badsb:
209 	ckfini(0);
210 	return (0);
211 }
212 
213 /*
214  * Read in the super block and its summary info.
215  */
216 int
217 readsb(int listerr)
218 {
219 	off_t super;
220 	int bad, ret;
221 	struct fs *fs;
222 
223 	super = bflag ? bflag * dev_bsize :
224 	    sbhashfailed ? STDSB_NOHASHFAIL_NOMSG : STDSB_NOMSG;
225 	readcnt[sblk.b_type]++;
226 	while ((ret = sbget(fsreadfd, &fs, super)) != 0) {
227 		switch (ret) {
228 		case EINTEGRITY:
229 			if (bflag || super == STDSB_NOHASHFAIL_NOMSG)
230 				return (0);
231 			super = STDSB_NOHASHFAIL_NOMSG;
232 			sbhashfailed = 1;
233 			continue;
234 		case ENOENT:
235 			if (bflag)
236 				printf("%jd is not a file system "
237 				    "superblock\n", super / dev_bsize);
238 			else
239 				printf("Cannot find file system "
240 				    "superblock\n");
241 			return (0);
242 		case EIO:
243 		default:
244 			printf("I/O error reading %jd\n",
245 			    super / dev_bsize);
246 			return (0);
247 		}
248 	}
249 	memcpy(&sblock, fs, fs->fs_sbsize);
250 	free(fs);
251 	/*
252 	 * Compute block size that the file system is based on,
253 	 * according to fsbtodb, and adjust superblock block number
254 	 * so we can tell if this is an alternate later.
255 	 */
256 	dev_bsize = sblock.fs_fsize / fsbtodb(&sblock, 1);
257 	sblk.b_bno = sblock.fs_sblockactualloc / dev_bsize;
258 	sblk.b_size = SBLOCKSIZE;
259 	/*
260 	 * Compare all fields that should not differ in alternate super block.
261 	 * When an alternate super-block is specified this check is skipped.
262 	 */
263 	if (bflag)
264 		goto out;
265 	getblk(&asblk, cgsblock(&sblock, sblock.fs_ncg - 1), sblock.fs_sbsize);
266 	if (asblk.b_errs)
267 		return (0);
268 	bad = 0;
269 #define CHK(x, y)				\
270 	if (altsblock.x != sblock.x) {		\
271 		bad++;				\
272 		if (listerr && debug)		\
273 			printf("SUPER BLOCK VS ALTERNATE MISMATCH %s: " y " vs " y "\n", \
274 			    #x, (intmax_t)sblock.x, (intmax_t)altsblock.x); \
275 	}
276 	CHK(fs_sblkno, "%jd");
277 	CHK(fs_cblkno, "%jd");
278 	CHK(fs_iblkno, "%jd");
279 	CHK(fs_dblkno, "%jd");
280 	CHK(fs_ncg, "%jd");
281 	CHK(fs_bsize, "%jd");
282 	CHK(fs_fsize, "%jd");
283 	CHK(fs_frag, "%jd");
284 	CHK(fs_bmask, "%#jx");
285 	CHK(fs_fmask, "%#jx");
286 	CHK(fs_bshift, "%jd");
287 	CHK(fs_fshift, "%jd");
288 	CHK(fs_fragshift, "%jd");
289 	CHK(fs_fsbtodb, "%jd");
290 	CHK(fs_sbsize, "%jd");
291 	CHK(fs_nindir, "%jd");
292 	CHK(fs_inopb, "%jd");
293 	CHK(fs_cssize, "%jd");
294 	CHK(fs_ipg, "%jd");
295 	CHK(fs_fpg, "%jd");
296 	CHK(fs_magic, "%#jx");
297 #undef CHK
298 	if (bad) {
299 		if (listerr == 0)
300 			return (0);
301 		if (preen)
302 			printf("%s: ", cdevname);
303 		printf(
304 		    "VALUES IN SUPER BLOCK LSB=%jd DISAGREE WITH THOSE IN\n"
305 		    "LAST ALTERNATE LSB=%jd\n",
306 		    sblk.b_bno, asblk.b_bno);
307 		if (reply("IGNORE ALTERNATE SUPER BLOCK") == 0)
308 			return (0);
309 	}
310 out:
311 	/*
312 	 * If not yet done, update UFS1 superblock with new wider fields.
313 	 */
314 	if (sblock.fs_magic == FS_UFS1_MAGIC &&
315 	    sblock.fs_maxbsize != sblock.fs_bsize) {
316 		sblock.fs_maxbsize = sblock.fs_bsize;
317 		sblock.fs_time = sblock.fs_old_time;
318 		sblock.fs_size = sblock.fs_old_size;
319 		sblock.fs_dsize = sblock.fs_old_dsize;
320 		sblock.fs_csaddr = sblock.fs_old_csaddr;
321 		sblock.fs_cstotal.cs_ndir = sblock.fs_old_cstotal.cs_ndir;
322 		sblock.fs_cstotal.cs_nbfree = sblock.fs_old_cstotal.cs_nbfree;
323 		sblock.fs_cstotal.cs_nifree = sblock.fs_old_cstotal.cs_nifree;
324 		sblock.fs_cstotal.cs_nffree = sblock.fs_old_cstotal.cs_nffree;
325 	}
326 	havesb = 1;
327 	return (1);
328 }
329 
330 void
331 sblock_init(void)
332 {
333 
334 	fswritefd = -1;
335 	fsmodified = 0;
336 	lfdir = 0;
337 	initbarea(&sblk, BT_SUPERBLK);
338 	initbarea(&asblk, BT_SUPERBLK);
339 	sblk.b_un.b_buf = Malloc(SBLOCKSIZE);
340 	asblk.b_un.b_buf = Malloc(SBLOCKSIZE);
341 	if (sblk.b_un.b_buf == NULL || asblk.b_un.b_buf == NULL)
342 		errx(EEXIT, "cannot allocate space for superblock");
343 	dev_bsize = secsize = DEV_BSIZE;
344 }
345 
346 /*
347  * Calculate a prototype superblock based on information in the boot area.
348  * When done the cgsblock macro can be calculated and the fs_ncg field
349  * can be used. Do NOT attempt to use other macros without verifying that
350  * their needed information is available!
351  */
352 static int
353 calcsb(char *dev, int devfd, struct fs *fs)
354 {
355 	struct fsrecovery *fsr;
356 	char *fsrbuf;
357 	u_int secsize;
358 
359 	/*
360 	 * We need fragments-per-group and the partition-size.
361 	 *
362 	 * Newfs stores these details at the end of the boot block area
363 	 * at the start of the filesystem partition. If they have been
364 	 * overwritten by a boot block, we fail. But usually they are
365 	 * there and we can use them.
366 	 */
367 	if (ioctl(devfd, DIOCGSECTORSIZE, &secsize) == -1)
368 		return (0);
369 	fsrbuf = Malloc(secsize);
370 	if (fsrbuf == NULL)
371 		errx(EEXIT, "calcsb: cannot allocate recovery buffer");
372 	if (blread(devfd, fsrbuf,
373 	    (SBLOCK_UFS2 - secsize) / dev_bsize, secsize) != 0) {
374 		free(fsrbuf);
375 		return (0);
376 	}
377 	fsr = (struct fsrecovery *)&fsrbuf[secsize - sizeof *fsr];
378 	if (fsr->fsr_magic != FS_UFS2_MAGIC) {
379 		free(fsrbuf);
380 		return (0);
381 	}
382 	memset(fs, 0, sizeof(struct fs));
383 	fs->fs_fpg = fsr->fsr_fpg;
384 	fs->fs_fsbtodb = fsr->fsr_fsbtodb;
385 	fs->fs_sblkno = fsr->fsr_sblkno;
386 	fs->fs_magic = fsr->fsr_magic;
387 	fs->fs_ncg = fsr->fsr_ncg;
388 	free(fsrbuf);
389 	return (1);
390 }
391 
392 /*
393  * Check to see if recovery information exists.
394  * Return 1 if it exists or cannot be created.
395  * Return 0 if it does not exist and can be created.
396  */
397 static int
398 chkrecovery(int devfd)
399 {
400 	struct fsrecovery *fsr;
401 	char *fsrbuf;
402 	u_int secsize;
403 
404 	/*
405 	 * Could not determine if backup material exists, so do not
406 	 * offer to create it.
407 	 */
408 	fsrbuf = NULL;
409 	if (ioctl(devfd, DIOCGSECTORSIZE, &secsize) == -1 ||
410 	    (fsrbuf = Malloc(secsize)) == NULL ||
411 	    blread(devfd, fsrbuf, (SBLOCK_UFS2 - secsize) / dev_bsize,
412 	      secsize) != 0) {
413 		free(fsrbuf);
414 		return (1);
415 	}
416 	/*
417 	 * Recovery material has already been created, so do not
418 	 * need to create it again.
419 	 */
420 	fsr = (struct fsrecovery *)&fsrbuf[secsize - sizeof *fsr];
421 	if (fsr->fsr_magic == FS_UFS2_MAGIC) {
422 		free(fsrbuf);
423 		return (1);
424 	}
425 	/*
426 	 * Recovery material has not been created and can be if desired.
427 	 */
428 	free(fsrbuf);
429 	return (0);
430 }
431 
432 /*
433  * Read the last sector of the boot block, replace the last
434  * 20 bytes with the recovery information, then write it back.
435  * The recovery information only works for UFS2 filesystems.
436  */
437 static void
438 saverecovery(int readfd, int writefd)
439 {
440 	struct fsrecovery *fsr;
441 	char *fsrbuf;
442 	u_int secsize;
443 
444 	fsrbuf = NULL;
445 	if (sblock.fs_magic != FS_UFS2_MAGIC ||
446 	    ioctl(readfd, DIOCGSECTORSIZE, &secsize) == -1 ||
447 	    (fsrbuf = Malloc(secsize)) == NULL ||
448 	    blread(readfd, fsrbuf, (SBLOCK_UFS2 - secsize) / dev_bsize,
449 	      secsize) != 0) {
450 		printf("RECOVERY DATA COULD NOT BE CREATED\n");
451 		free(fsrbuf);
452 		return;
453 	}
454 	fsr = (struct fsrecovery *)&fsrbuf[secsize - sizeof *fsr];
455 	fsr->fsr_magic = sblock.fs_magic;
456 	fsr->fsr_fpg = sblock.fs_fpg;
457 	fsr->fsr_fsbtodb = sblock.fs_fsbtodb;
458 	fsr->fsr_sblkno = sblock.fs_sblkno;
459 	fsr->fsr_ncg = sblock.fs_ncg;
460 	blwrite(writefd, fsrbuf, (SBLOCK_UFS2 - secsize) / secsize, secsize);
461 	free(fsrbuf);
462 }
463