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