xref: /freebsd/sbin/fsck_ffs/setup.c (revision 77a0943ded95b9e6438f7db70c4a28e4d93946d4)
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. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 #ifndef lint
35 #if 0
36 static const char sccsid[] = "@(#)setup.c	8.10 (Berkeley) 5/9/95";
37 #endif
38 static const char rcsid[] =
39   "$FreeBSD$";
40 #endif /* not lint */
41 
42 #define DKTYPENAMES
43 #include <sys/param.h>
44 #include <sys/stat.h>
45 #include <sys/disklabel.h>
46 #include <sys/file.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 <string.h>
55 
56 #include "fsck.h"
57 
58 struct bufarea asblk;
59 #define altsblock (*asblk.b_un.b_fs)
60 #define POWEROF2(num)	(((num) & ((num) - 1)) == 0)
61 
62 static void badsb __P((int listerr, char *s));
63 static int calcsb __P((char *dev, int devfd, struct fs *fs));
64 static struct disklabel *getdisklabel __P((char *s, int fd));
65 static int readsb __P((int listerr));
66 
67 /*
68  * Read in a superblock finding an alternate if necessary.
69  * Return 1 if successful, 0 if unsuccessful, -1 if filesystem
70  * is already clean (preen mode only).
71  */
72 int
73 setup(dev)
74 	char *dev;
75 {
76 	long cg, size, asked, i, j;
77 	long skipclean, bmapsize;
78 	struct disklabel *lp;
79 	off_t sizepb;
80 	struct stat statb;
81 	struct fs proto;
82 
83 	havesb = 0;
84 	fswritefd = -1;
85 	cursnapshot = 0;
86 	skipclean = fflag ? 0 : preen;
87 	if (stat(dev, &statb) < 0) {
88 		printf("Can't stat %s: %s\n", dev, strerror(errno));
89 		return (0);
90 	}
91 	if ((statb.st_mode & S_IFMT) != S_IFCHR &&
92 	    (statb.st_mode & S_IFMT) != S_IFBLK) {
93 		if ((statb.st_flags & SF_SNAPSHOT) != 0) {
94 			cursnapshot = statb.st_ino;
95 		} else {
96 			pfatal("%s is not a disk device", dev);
97 			if (reply("CONTINUE") == 0)
98 				return (0);
99 		}
100 	}
101 	if ((fsreadfd = open(dev, O_RDONLY)) < 0) {
102 		printf("Can't open %s: %s\n", dev, strerror(errno));
103 		return (0);
104 	}
105 	if (preen == 0)
106 		printf("** %s", dev);
107 	if (nflag || (fswritefd = open(dev, O_WRONLY)) < 0) {
108 		fswritefd = -1;
109 		if (preen)
110 			pfatal("NO WRITE ACCESS");
111 		printf(" (NO WRITE)");
112 	}
113 	if (preen == 0)
114 		printf("\n");
115 	fsmodified = 0;
116 	lfdir = 0;
117 	initbarea(&sblk);
118 	initbarea(&asblk);
119 	sblk.b_un.b_buf = malloc(SBSIZE);
120 	asblk.b_un.b_buf = malloc(SBSIZE);
121 	if (sblk.b_un.b_buf == NULL || asblk.b_un.b_buf == NULL)
122 		errx(EEXIT, "cannot allocate space for superblock");
123 	if ((lp = getdisklabel(NULL, fsreadfd)))
124 		dev_bsize = secsize = lp->d_secsize;
125 	else
126 		dev_bsize = secsize = DEV_BSIZE;
127 	/*
128 	 * Read in the superblock, looking for alternates if necessary
129 	 */
130 	if (readsb(1) == 0) {
131 		skipclean = 0;
132 		if (bflag || preen || calcsb(dev, fsreadfd, &proto) == 0)
133 			return(0);
134 		if (reply("LOOK FOR ALTERNATE SUPERBLOCKS") == 0)
135 			return (0);
136 		for (cg = 0; cg < proto.fs_ncg; cg++) {
137 			bflag = fsbtodb(&proto, cgsblock(&proto, cg));
138 			if (readsb(0) != 0)
139 				break;
140 		}
141 		if (cg >= proto.fs_ncg) {
142 			printf("%s %s\n%s %s\n%s %s\n",
143 				"SEARCH FOR ALTERNATE SUPER-BLOCK",
144 				"FAILED. YOU MUST USE THE",
145 				"-b OPTION TO FSCK TO SPECIFY THE",
146 				"LOCATION OF AN ALTERNATE",
147 				"SUPER-BLOCK TO SUPPLY NEEDED",
148 				"INFORMATION; SEE fsck(8).");
149 			bflag = 0;
150 			return(0);
151 		}
152 		pwarn("USING ALTERNATE SUPERBLOCK AT %d\n", bflag);
153 		bflag = 0;
154 	}
155 	if (skipclean && sblock.fs_clean) {
156 		pwarn("FILESYSTEM CLEAN; SKIPPING CHECKS\n");
157 		return (-1);
158 	}
159 	maxfsblock = sblock.fs_size;
160 	maxino = sblock.fs_ncg * sblock.fs_ipg;
161 	/*
162 	 * Check and potentially fix certain fields in the super block.
163 	 */
164 	if (sblock.fs_optim != FS_OPTTIME && sblock.fs_optim != FS_OPTSPACE) {
165 		pfatal("UNDEFINED OPTIMIZATION IN SUPERBLOCK");
166 		if (reply("SET TO DEFAULT") == 1) {
167 			sblock.fs_optim = FS_OPTTIME;
168 			sbdirty();
169 		}
170 	}
171 	if ((sblock.fs_minfree < 0 || sblock.fs_minfree > 99)) {
172 		pfatal("IMPOSSIBLE MINFREE=%d IN SUPERBLOCK",
173 			sblock.fs_minfree);
174 		if (reply("SET TO DEFAULT") == 1) {
175 			sblock.fs_minfree = 10;
176 			sbdirty();
177 		}
178 	}
179 	if (sblock.fs_interleave < 1 ||
180 	    sblock.fs_interleave > sblock.fs_nsect) {
181 		pwarn("IMPOSSIBLE INTERLEAVE=%d IN SUPERBLOCK",
182 			sblock.fs_interleave);
183 		sblock.fs_interleave = 1;
184 		if (preen)
185 			printf(" (FIXED)\n");
186 		if (preen || reply("SET TO DEFAULT") == 1) {
187 			sbdirty();
188 			dirty(&asblk);
189 		}
190 	}
191 	if (sblock.fs_npsect < sblock.fs_nsect ||
192 	    sblock.fs_npsect > sblock.fs_nsect*2) {
193 		pwarn("IMPOSSIBLE NPSECT=%d IN SUPERBLOCK",
194 			sblock.fs_npsect);
195 		sblock.fs_npsect = sblock.fs_nsect;
196 		if (preen)
197 			printf(" (FIXED)\n");
198 		if (preen || reply("SET TO DEFAULT") == 1) {
199 			sbdirty();
200 			dirty(&asblk);
201 		}
202 	}
203 	if (sblock.fs_inodefmt >= FS_44INODEFMT) {
204 		newinofmt = 1;
205 	} else {
206 		sblock.fs_qbmask = ~sblock.fs_bmask;
207 		sblock.fs_qfmask = ~sblock.fs_fmask;
208 		newinofmt = 0;
209 	}
210 	/*
211 	 * Convert to new inode format.
212 	 */
213 	if (cvtlevel >= 2 && sblock.fs_inodefmt < FS_44INODEFMT) {
214 		if (preen)
215 			pwarn("CONVERTING TO NEW INODE FORMAT\n");
216 		else if (!reply("CONVERT TO NEW INODE FORMAT"))
217 			return(0);
218 		doinglevel2++;
219 		sblock.fs_inodefmt = FS_44INODEFMT;
220 		sizepb = sblock.fs_bsize;
221 		sblock.fs_maxfilesize = sblock.fs_bsize * NDADDR - 1;
222 		for (i = 0; i < NIADDR; i++) {
223 			sizepb *= NINDIR(&sblock);
224 			sblock.fs_maxfilesize += sizepb;
225 		}
226 		sblock.fs_maxsymlinklen = MAXSYMLINKLEN;
227 		sblock.fs_qbmask = ~sblock.fs_bmask;
228 		sblock.fs_qfmask = ~sblock.fs_fmask;
229 		sbdirty();
230 		dirty(&asblk);
231 	}
232 	/*
233 	 * Convert to new cylinder group format.
234 	 */
235 	if (cvtlevel >= 1 && sblock.fs_postblformat == FS_42POSTBLFMT) {
236 		if (preen)
237 			pwarn("CONVERTING TO NEW CYLINDER GROUP FORMAT\n");
238 		else if (!reply("CONVERT TO NEW CYLINDER GROUP FORMAT"))
239 			return(0);
240 		doinglevel1++;
241 		sblock.fs_postblformat = FS_DYNAMICPOSTBLFMT;
242 		sblock.fs_nrpos = 8;
243 		sblock.fs_postbloff =
244 		    (char *)(&sblock.fs_opostbl[0][0]) -
245 		    (char *)(&sblock.fs_firstfield);
246 		sblock.fs_rotbloff = &sblock.fs_space[0] -
247 		    (u_char *)(&sblock.fs_firstfield);
248 		sblock.fs_cgsize =
249 			fragroundup(&sblock, CGSIZE(&sblock));
250 		sbdirty();
251 		dirty(&asblk);
252 	}
253 	if (asblk.b_dirty && !bflag) {
254 		memmove(&altsblock, &sblock, (size_t)sblock.fs_sbsize);
255 		flush(fswritefd, &asblk);
256 	}
257 	/*
258 	 * read in the summary info.
259 	 */
260 	asked = 0;
261 	for (i = 0, j = 0; i < sblock.fs_cssize; i += sblock.fs_bsize, j++) {
262 		size = sblock.fs_cssize - i < sblock.fs_bsize ?
263 		    sblock.fs_cssize - i : sblock.fs_bsize;
264 		sblock.fs_csp[j] = (struct csum *)calloc(1, (unsigned)size);
265 		if (bread(fsreadfd, (char *)sblock.fs_csp[j],
266 		    fsbtodb(&sblock, sblock.fs_csaddr + j * sblock.fs_frag),
267 		    size) != 0 && !asked) {
268 			pfatal("BAD SUMMARY INFORMATION");
269 			if (reply("CONTINUE") == 0) {
270 				ckfini(0);
271 				exit(EEXIT);
272 			}
273 			asked++;
274 		}
275 	}
276 	/*
277 	 * allocate and initialize the necessary maps
278 	 */
279 	bmapsize = roundup(howmany(maxfsblock, NBBY), sizeof(short));
280 	blockmap = calloc((unsigned)bmapsize, sizeof (char));
281 	if (blockmap == NULL) {
282 		printf("cannot alloc %u bytes for blockmap\n",
283 		    (unsigned)bmapsize);
284 		goto badsb;
285 	}
286 	inostathead = calloc((unsigned)(sblock.fs_ncg),
287 	    sizeof(struct inostatlist));
288 	if (inostathead == NULL) {
289 		printf("cannot alloc %u bytes for inostathead\n",
290 		    (unsigned)(sizeof(struct inostatlist) * (sblock.fs_ncg)));
291 		goto badsb;
292 	}
293 	numdirs = sblock.fs_cstotal.cs_ndir;
294 	dirhash = numdirs;
295 	if (numdirs == 0) {
296 		printf("numdirs is zero, try using an alternate superblock\n");
297 		goto badsb;
298 	}
299 	inplast = 0;
300 	listmax = numdirs + 10;
301 	inpsort = (struct inoinfo **)calloc((unsigned)listmax,
302 	    sizeof(struct inoinfo *));
303 	inphead = (struct inoinfo **)calloc((unsigned)numdirs,
304 	    sizeof(struct inoinfo *));
305 	if (inpsort == NULL || inphead == NULL) {
306 		printf("cannot alloc %u bytes for inphead\n",
307 		    (unsigned)numdirs * sizeof(struct inoinfo *));
308 		goto badsb;
309 	}
310 	bufinit();
311 	if (sblock.fs_flags & FS_DOSOFTDEP)
312 		usedsoftdep = 1;
313 	else
314 		usedsoftdep = 0;
315 	return (1);
316 
317 badsb:
318 	ckfini(0);
319 	return (0);
320 }
321 
322 /*
323  * Read in the super block and its summary info.
324  */
325 static int
326 readsb(listerr)
327 	int listerr;
328 {
329 	ufs_daddr_t super = bflag ? bflag : SBOFF / dev_bsize;
330 
331 	if (bread(fsreadfd, (char *)&sblock, super, (long)SBSIZE) != 0)
332 		return (0);
333 	sblk.b_bno = super;
334 	sblk.b_size = SBSIZE;
335 	/*
336 	 * run a few consistency checks of the super block
337 	 */
338 	if (sblock.fs_magic != FS_MAGIC)
339 		{ badsb(listerr, "MAGIC NUMBER WRONG"); return (0); }
340 	if (sblock.fs_ncg < 1)
341 		{ badsb(listerr, "NCG OUT OF RANGE"); return (0); }
342 	if (sblock.fs_cpg < 1)
343 		{ badsb(listerr, "CPG OUT OF RANGE"); return (0); }
344 	if (sblock.fs_ncg * sblock.fs_cpg < sblock.fs_ncyl ||
345 	    (sblock.fs_ncg - 1) * sblock.fs_cpg >= sblock.fs_ncyl)
346 		{ badsb(listerr, "NCYL LESS THAN NCG*CPG"); return (0); }
347 	if (sblock.fs_sbsize > SBSIZE)
348 		{ badsb(listerr, "SIZE PREPOSTEROUSLY LARGE"); return (0); }
349 	/*
350 	 * Compute block size that the filesystem is based on,
351 	 * according to fsbtodb, and adjust superblock block number
352 	 * so we can tell if this is an alternate later.
353 	 */
354 	super *= dev_bsize;
355 	dev_bsize = sblock.fs_fsize / fsbtodb(&sblock, 1);
356 	sblk.b_bno = super / dev_bsize;
357 	if (bflag) {
358 		havesb = 1;
359 		return (1);
360 	}
361 	/*
362 	 * Set all possible fields that could differ, then do check
363 	 * of whole super block against an alternate super block.
364 	 * When an alternate super-block is specified this check is skipped.
365 	 */
366 	getblk(&asblk, cgsblock(&sblock, sblock.fs_ncg - 1), sblock.fs_sbsize);
367 	if (asblk.b_errs)
368 		return (0);
369 	altsblock.fs_firstfield = sblock.fs_firstfield;
370 	altsblock.fs_unused_1 = sblock.fs_unused_1;
371 	altsblock.fs_time = sblock.fs_time;
372 	altsblock.fs_cstotal = sblock.fs_cstotal;
373 	altsblock.fs_cgrotor = sblock.fs_cgrotor;
374 	altsblock.fs_fmod = sblock.fs_fmod;
375 	altsblock.fs_clean = sblock.fs_clean;
376 	altsblock.fs_ronly = sblock.fs_ronly;
377 	altsblock.fs_flags = sblock.fs_flags;
378 	altsblock.fs_maxcontig = sblock.fs_maxcontig;
379 	altsblock.fs_minfree = sblock.fs_minfree;
380 	altsblock.fs_optim = sblock.fs_optim;
381 	altsblock.fs_rotdelay = sblock.fs_rotdelay;
382 	altsblock.fs_maxbpg = sblock.fs_maxbpg;
383 	memmove(altsblock.fs_csp, sblock.fs_csp, sizeof sblock.fs_csp);
384 	altsblock.fs_maxcluster = sblock.fs_maxcluster;
385 	memmove(altsblock.fs_fsmnt, sblock.fs_fsmnt, sizeof sblock.fs_fsmnt);
386 	memmove(altsblock.fs_snapinum, sblock.fs_snapinum,
387 		sizeof sblock.fs_snapinum);
388 	memmove(altsblock.fs_sparecon,
389 		sblock.fs_sparecon, sizeof sblock.fs_sparecon);
390 	/*
391 	 * The following should not have to be copied.
392 	 */
393 	altsblock.fs_fsbtodb = sblock.fs_fsbtodb;
394 	altsblock.fs_interleave = sblock.fs_interleave;
395 	altsblock.fs_npsect = sblock.fs_npsect;
396 	altsblock.fs_nrpos = sblock.fs_nrpos;
397 	altsblock.fs_state = sblock.fs_state;
398 	altsblock.fs_qbmask = sblock.fs_qbmask;
399 	altsblock.fs_qfmask = sblock.fs_qfmask;
400 	altsblock.fs_state = sblock.fs_state;
401 	altsblock.fs_maxfilesize = sblock.fs_maxfilesize;
402 	if (memcmp(&sblock, &altsblock, (int)sblock.fs_sbsize)) {
403 		if (debug) {
404 			long *nlp, *olp, *endlp;
405 
406 			printf("superblock mismatches\n");
407 			nlp = (long *)&altsblock;
408 			olp = (long *)&sblock;
409 			endlp = olp + (sblock.fs_sbsize / sizeof *olp);
410 			for ( ; olp < endlp; olp++, nlp++) {
411 				if (*olp == *nlp)
412 					continue;
413 				printf(
414 				    "offset %d, original %ld, alternate %ld\n",
415 				    olp - (long *)&sblock, *olp, *nlp);
416 			}
417 		}
418 		badsb(listerr,
419 		"VALUES IN SUPER BLOCK DISAGREE WITH THOSE IN FIRST ALTERNATE");
420 		return (0);
421 	}
422 	havesb = 1;
423 	return (1);
424 }
425 
426 static void
427 badsb(listerr, s)
428 	int listerr;
429 	char *s;
430 {
431 
432 	if (!listerr)
433 		return;
434 	if (preen)
435 		printf("%s: ", cdevname);
436 	pfatal("BAD SUPER BLOCK: %s\n", s);
437 }
438 
439 /*
440  * Calculate a prototype superblock based on information in the disk label.
441  * When done the cgsblock macro can be calculated and the fs_ncg field
442  * can be used. Do NOT attempt to use other macros without verifying that
443  * their needed information is available!
444  */
445 static int
446 calcsb(dev, devfd, fs)
447 	char *dev;
448 	int devfd;
449 	register struct fs *fs;
450 {
451 	register struct disklabel *lp;
452 	register struct partition *pp;
453 	register char *cp;
454 	int i;
455 
456 	cp = strchr(dev, '\0') - 1;
457 	if (cp == (char *)-1 || ((*cp < 'a' || *cp > 'h') && !isdigit(*cp))) {
458 		pfatal("%s: CANNOT FIGURE OUT FILE SYSTEM PARTITION\n", dev);
459 		return (0);
460 	}
461 	lp = getdisklabel(dev, devfd);
462 	if (isdigit(*cp))
463 		pp = &lp->d_partitions[0];
464 	else
465 		pp = &lp->d_partitions[*cp - 'a'];
466 	if (pp->p_fstype != FS_BSDFFS) {
467 		pfatal("%s: NOT LABELED AS A BSD FILE SYSTEM (%s)\n",
468 			dev, pp->p_fstype < FSMAXTYPES ?
469 			fstypenames[pp->p_fstype] : "unknown");
470 		return (0);
471 	}
472 	if (pp->p_fsize == 0 || pp->p_frag == 0 ||
473 	    pp->p_cpg == 0 || pp->p_size == 0) {
474 		pfatal("%s: %s: type %s fsize %d, frag %d, cpg %d, size %d\n",
475 		    dev, "INCOMPLETE LABEL", fstypenames[pp->p_fstype],
476 		    pp->p_fsize, pp->p_frag, pp->p_cpg, pp->p_size);
477 		return (0);
478 	}
479 	memset(fs, 0, sizeof(struct fs));
480 	fs->fs_fsize = pp->p_fsize;
481 	fs->fs_frag = pp->p_frag;
482 	fs->fs_cpg = pp->p_cpg;
483 	fs->fs_size = pp->p_size;
484 	fs->fs_ntrak = lp->d_ntracks;
485 	fs->fs_nsect = lp->d_nsectors;
486 	fs->fs_spc = lp->d_secpercyl;
487 	fs->fs_nspf = fs->fs_fsize / lp->d_secsize;
488 	fs->fs_sblkno = roundup(
489 		howmany(lp->d_bbsize + lp->d_sbsize, fs->fs_fsize),
490 		fs->fs_frag);
491 	fs->fs_cgmask = 0xffffffff;
492 	for (i = fs->fs_ntrak; i > 1; i >>= 1)
493 		fs->fs_cgmask <<= 1;
494 	if (!POWEROF2(fs->fs_ntrak))
495 		fs->fs_cgmask <<= 1;
496 	fs->fs_cgoffset = roundup(
497 		howmany(fs->fs_nsect, NSPF(fs)), fs->fs_frag);
498 	fs->fs_fpg = (fs->fs_cpg * fs->fs_spc) / NSPF(fs);
499 	fs->fs_ncg = howmany(fs->fs_size / fs->fs_spc, fs->fs_cpg);
500 	for (fs->fs_fsbtodb = 0, i = NSPF(fs); i > 1; i >>= 1)
501 		fs->fs_fsbtodb++;
502 	dev_bsize = lp->d_secsize;
503 	return (1);
504 }
505 
506 static struct disklabel *
507 getdisklabel(s, fd)
508 	char *s;
509 	int	fd;
510 {
511 	static struct disklabel lab;
512 
513 	if (ioctl(fd, DIOCGDINFO, (char *)&lab) < 0) {
514 		if (s == NULL)
515 			return ((struct disklabel *)NULL);
516 		pwarn("ioctl (GCINFO): %s\n", strerror(errno));
517 		errx(EEXIT, "%s: can't read disk label", s);
518 	}
519 	return (&lab);
520 }
521