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 uufsd disk;
62 struct bufarea asblk;
63 #define altsblock (*asblk.b_un.b_fs)
64 #define POWEROF2(num) (((num) & ((num) - 1)) == 0)
65
66 static int calcsb(char *dev, int devfd, struct fs *fs);
67 static void saverecovery(int readfd, int writefd);
68 static int chkrecovery(int devfd);
69
70 /*
71 * Read in a superblock finding an alternate if necessary.
72 * Return 1 if successful, 0 if unsuccessful, -1 if file system
73 * is already clean (ckclean and preen mode only).
74 */
75 int
setup(char * dev)76 setup(char *dev)
77 {
78 long cg, asked, i, j;
79 long bmapsize;
80 struct stat statb;
81 struct fs proto;
82 size_t size;
83
84 havesb = 0;
85 fswritefd = -1;
86 cursnapshot = 0;
87 if (stat(dev, &statb) < 0) {
88 printf("Can't stat %s: %s\n", dev, strerror(errno));
89 if (bkgrdflag) {
90 unlink(snapname);
91 bkgrdflag = 0;
92 }
93 return (0);
94 }
95 if ((statb.st_mode & S_IFMT) != S_IFCHR &&
96 (statb.st_mode & S_IFMT) != S_IFBLK) {
97 if (bkgrdflag != 0 && (statb.st_flags & SF_SNAPSHOT) == 0) {
98 unlink(snapname);
99 printf("background fsck lacks a snapshot\n");
100 exit(EEXIT);
101 }
102 if ((statb.st_flags & SF_SNAPSHOT) != 0 && cvtlevel == 0) {
103 cursnapshot = statb.st_ino;
104 } else {
105 if (cvtlevel == 0 ||
106 (statb.st_flags & SF_SNAPSHOT) == 0) {
107 if (preen && bkgrdflag) {
108 unlink(snapname);
109 bkgrdflag = 0;
110 }
111 pfatal("%s is not a disk device", dev);
112 if (reply("CONTINUE") == 0) {
113 if (bkgrdflag) {
114 unlink(snapname);
115 bkgrdflag = 0;
116 }
117 return (0);
118 }
119 } else {
120 if (bkgrdflag) {
121 unlink(snapname);
122 bkgrdflag = 0;
123 }
124 pfatal("cannot convert a snapshot");
125 exit(EEXIT);
126 }
127 }
128 }
129 if ((fsreadfd = open(dev, O_RDONLY)) < 0 ||
130 ufs_disk_fillout(&disk, dev) < 0) {
131 if (bkgrdflag) {
132 unlink(snapname);
133 bkgrdflag = 0;
134 }
135 printf("Can't open %s: %s\n", dev, strerror(errno));
136 return (0);
137 }
138 if (bkgrdflag) {
139 unlink(snapname);
140 size = MIBSIZE;
141 if (sysctlnametomib("vfs.ffs.adjrefcnt", adjrefcnt, &size) < 0||
142 sysctlnametomib("vfs.ffs.adjblkcnt", adjblkcnt, &size) < 0||
143 sysctlnametomib("vfs.ffs.setsize", setsize, &size) < 0 ||
144 sysctlnametomib("vfs.ffs.freefiles", freefiles, &size) < 0||
145 sysctlnametomib("vfs.ffs.freedirs", freedirs, &size) < 0 ||
146 sysctlnametomib("vfs.ffs.freeblks", freeblks, &size) < 0) {
147 pfatal("kernel lacks background fsck support\n");
148 exit(EEXIT);
149 }
150 /*
151 * When kernel is lack of runtime bgfsck superblock summary
152 * adjustment functionality, it does not mean we can not
153 * continue, as old kernels will recompute the summary at
154 * mount time. However, it will be an unexpected softupdates
155 * inconsistency if it turns out that the summary is still
156 * incorrect. Set a flag so subsequent operation can know
157 * this.
158 */
159 bkgrdsumadj = 1;
160 if (sysctlnametomib("vfs.ffs.adjndir", adjndir, &size) < 0 ||
161 sysctlnametomib("vfs.ffs.adjnbfree", adjnbfree, &size) < 0 ||
162 sysctlnametomib("vfs.ffs.adjnifree", adjnifree, &size) < 0 ||
163 sysctlnametomib("vfs.ffs.adjnffree", adjnffree, &size) < 0 ||
164 sysctlnametomib("vfs.ffs.adjnumclusters", adjnumclusters, &size) < 0) {
165 bkgrdsumadj = 0;
166 pwarn("kernel lacks runtime superblock summary adjustment support");
167 }
168 cmd.version = FFS_CMD_VERSION;
169 cmd.handle = fsreadfd;
170 fswritefd = -1;
171 }
172 if (preen == 0)
173 printf("** %s", dev);
174 if (bkgrdflag == 0 &&
175 (nflag || ufs_disk_write(&disk) < 0 ||
176 (fswritefd = dup(disk.d_fd)) < 0)) {
177 fswritefd = -1;
178 if (preen)
179 pfatal("NO WRITE ACCESS");
180 printf(" (NO WRITE)");
181 }
182 if (preen == 0)
183 printf("\n");
184 /*
185 * Read in the superblock, looking for alternates if necessary
186 */
187 if (readsb(1) == 0) {
188 skipclean = 0;
189 if (bflag || preen || calcsb(dev, fsreadfd, &proto) == 0)
190 return(0);
191 if (reply("LOOK FOR ALTERNATE SUPERBLOCKS") == 0)
192 return (0);
193 for (cg = 0; cg < proto.fs_ncg; cg++) {
194 bflag = fsbtodb(&proto, cgsblock(&proto, cg));
195 if (readsb(0) != 0)
196 break;
197 }
198 if (cg >= proto.fs_ncg) {
199 printf("%s %s\n%s %s\n%s %s\n",
200 "SEARCH FOR ALTERNATE SUPER-BLOCK",
201 "FAILED. YOU MUST USE THE",
202 "-b OPTION TO FSCK TO SPECIFY THE",
203 "LOCATION OF AN ALTERNATE",
204 "SUPER-BLOCK TO SUPPLY NEEDED",
205 "INFORMATION; SEE fsck_ffs(8).");
206 bflag = 0;
207 return(0);
208 }
209 pwarn("USING ALTERNATE SUPERBLOCK AT %jd\n", bflag);
210 bflag = 0;
211 }
212 if (skipclean && ckclean && sblock.fs_clean) {
213 pwarn("FILE SYSTEM CLEAN; SKIPPING CHECKS\n");
214 return (-1);
215 }
216 maxfsblock = sblock.fs_size;
217 maxino = sblock.fs_ncg * sblock.fs_ipg;
218 /*
219 * Check and potentially fix certain fields in the super block.
220 */
221 if (sblock.fs_optim != FS_OPTTIME && sblock.fs_optim != FS_OPTSPACE) {
222 pfatal("UNDEFINED OPTIMIZATION IN SUPERBLOCK");
223 if (reply("SET TO DEFAULT") == 1) {
224 sblock.fs_optim = FS_OPTTIME;
225 sbdirty();
226 }
227 }
228 if ((sblock.fs_minfree < 0 || sblock.fs_minfree > 99)) {
229 pfatal("IMPOSSIBLE MINFREE=%d IN SUPERBLOCK",
230 sblock.fs_minfree);
231 if (reply("SET TO DEFAULT") == 1) {
232 sblock.fs_minfree = 10;
233 sbdirty();
234 }
235 }
236 if (sblock.fs_magic == FS_UFS1_MAGIC &&
237 sblock.fs_old_inodefmt < FS_44INODEFMT) {
238 pwarn("Format of file system is too old.\n");
239 pwarn("Must update to modern format using a version of fsck\n");
240 pfatal("from before 2002 with the command ``fsck -c 2''\n");
241 exit(EEXIT);
242 }
243 if (asblk.b_dirty && !bflag) {
244 memmove(&altsblock, &sblock, (size_t)sblock.fs_sbsize);
245 flush(fswritefd, &asblk);
246 }
247 if (preen == 0 && yflag == 0 && sblock.fs_magic == FS_UFS2_MAGIC &&
248 fswritefd != -1 && chkrecovery(fsreadfd) == 0 &&
249 reply("SAVE DATA TO FIND ALTERNATE SUPERBLOCKS") != 0)
250 saverecovery(fsreadfd, fswritefd);
251 /*
252 * read in the summary info.
253 */
254 asked = 0;
255 sblock.fs_csp = Calloc(1, sblock.fs_cssize);
256 if (sblock.fs_csp == NULL) {
257 printf("cannot alloc %u bytes for cg summary info\n",
258 (unsigned)sblock.fs_cssize);
259 goto badsb;
260 }
261 for (i = 0, j = 0; i < sblock.fs_cssize; i += sblock.fs_bsize, j++) {
262 size = MIN(sblock.fs_cssize - i, sblock.fs_bsize);
263 readcnt[sblk.b_type]++;
264 if (blread(fsreadfd, (char *)sblock.fs_csp + i,
265 fsbtodb(&sblock, sblock.fs_csaddr + j * sblock.fs_frag),
266 size) != 0 && !asked) {
267 pfatal("BAD SUMMARY INFORMATION");
268 if (reply("CONTINUE") == 0) {
269 ckfini(0);
270 exit(EEXIT);
271 }
272 asked++;
273 }
274 }
275 /*
276 * allocate and initialize the necessary maps
277 */
278 bmapsize = roundup(howmany(maxfsblock, CHAR_BIT), sizeof(short));
279 blockmap = Calloc((unsigned)bmapsize, sizeof (char));
280 if (blockmap == NULL) {
281 printf("cannot alloc %u bytes for blockmap\n",
282 (unsigned)bmapsize);
283 goto badsb;
284 }
285 inostathead = Calloc(sblock.fs_ncg, sizeof(struct inostatlist));
286 if (inostathead == NULL) {
287 printf("cannot alloc %u bytes for inostathead\n",
288 (unsigned)(sizeof(struct inostatlist) * (sblock.fs_ncg)));
289 goto badsb;
290 }
291 numdirs = MAX(sblock.fs_cstotal.cs_ndir, 128);
292 dirhash = numdirs;
293 inplast = 0;
294 listmax = numdirs + 10;
295 inpsort = (struct inoinfo **)Calloc(listmax, sizeof(struct inoinfo *));
296 inphead = (struct inoinfo **)Calloc(numdirs, sizeof(struct inoinfo *));
297 if (inpsort == NULL || inphead == NULL) {
298 printf("cannot alloc %ju bytes for inphead\n",
299 (uintmax_t)numdirs * sizeof(struct inoinfo *));
300 goto badsb;
301 }
302 bufinit();
303 if (sblock.fs_flags & FS_DOSOFTDEP)
304 usedsoftdep = 1;
305 else
306 usedsoftdep = 0;
307 return (1);
308
309 badsb:
310 ckfini(0);
311 return (0);
312 }
313
314 /*
315 * Read in the super block and its summary info.
316 */
317 int
readsb(int listerr)318 readsb(int listerr)
319 {
320 off_t super;
321 int bad, ret;
322 struct fs *fs;
323
324 super = bflag ? bflag * dev_bsize : -1;
325 readcnt[sblk.b_type]++;
326 if ((ret = sbget(fsreadfd, &fs, super)) != 0) {
327 switch (ret) {
328 case EINVAL:
329 fprintf(stderr, "The previous newfs operation "
330 "on this volume did not complete.\nYou must "
331 "complete newfs before using this volume.\n");
332 exit(11);
333 case ENOENT:
334 if (bflag)
335 fprintf(stderr, "%jd is not a file system "
336 "superblock\n", super / dev_bsize);
337 else
338 fprintf(stderr, "Cannot find file system "
339 "superblock\n");
340 return (0);
341 case EIO:
342 default:
343 fprintf(stderr, "I/O error reading %jd\n",
344 super / dev_bsize);
345 return (0);
346 }
347 }
348 memcpy(&sblock, fs, fs->fs_sbsize);
349 free(fs);
350 /*
351 * Compute block size that the file system is based on,
352 * according to fsbtodb, and adjust superblock block number
353 * so we can tell if this is an alternate later.
354 */
355 dev_bsize = sblock.fs_fsize / fsbtodb(&sblock, 1);
356 sblk.b_bno = sblock.fs_sblockactualloc / dev_bsize;
357 sblk.b_size = SBLOCKSIZE;
358 /*
359 * Compare all fields that should not differ in alternate super block.
360 * When an alternate super-block is specified this check is skipped.
361 */
362 if (bflag)
363 goto out;
364 getblk(&asblk, cgsblock(&sblock, sblock.fs_ncg - 1), sblock.fs_sbsize);
365 if (asblk.b_errs)
366 return (0);
367 bad = 0;
368 #define CHK(x, y) \
369 if (altsblock.x != sblock.x) { \
370 bad++; \
371 if (listerr && debug) \
372 printf("SUPER BLOCK VS ALTERNATE MISMATCH %s: " y " vs " y "\n", \
373 #x, (intmax_t)sblock.x, (intmax_t)altsblock.x); \
374 }
375 CHK(fs_sblkno, "%jd");
376 CHK(fs_cblkno, "%jd");
377 CHK(fs_iblkno, "%jd");
378 CHK(fs_dblkno, "%jd");
379 CHK(fs_ncg, "%jd");
380 CHK(fs_bsize, "%jd");
381 CHK(fs_fsize, "%jd");
382 CHK(fs_frag, "%jd");
383 CHK(fs_bmask, "%#jx");
384 CHK(fs_fmask, "%#jx");
385 CHK(fs_bshift, "%jd");
386 CHK(fs_fshift, "%jd");
387 CHK(fs_fragshift, "%jd");
388 CHK(fs_fsbtodb, "%jd");
389 CHK(fs_sbsize, "%jd");
390 CHK(fs_nindir, "%jd");
391 CHK(fs_inopb, "%jd");
392 CHK(fs_cssize, "%jd");
393 CHK(fs_ipg, "%jd");
394 CHK(fs_fpg, "%jd");
395 CHK(fs_magic, "%#jx");
396 #undef CHK
397 if (bad) {
398 if (listerr == 0)
399 return (0);
400 if (preen)
401 printf("%s: ", cdevname);
402 printf(
403 "VALUES IN SUPER BLOCK LSB=%jd DISAGREE WITH THOSE IN\n"
404 "LAST ALTERNATE LSB=%jd\n",
405 sblk.b_bno, asblk.b_bno);
406 if (reply("IGNORE ALTERNATE SUPER BLOCK") == 0)
407 return (0);
408 }
409 out:
410 /*
411 * If not yet done, update UFS1 superblock with new wider fields.
412 */
413 if (sblock.fs_magic == FS_UFS1_MAGIC &&
414 sblock.fs_maxbsize != sblock.fs_bsize) {
415 sblock.fs_maxbsize = sblock.fs_bsize;
416 sblock.fs_time = sblock.fs_old_time;
417 sblock.fs_size = sblock.fs_old_size;
418 sblock.fs_dsize = sblock.fs_old_dsize;
419 sblock.fs_csaddr = sblock.fs_old_csaddr;
420 sblock.fs_cstotal.cs_ndir = sblock.fs_old_cstotal.cs_ndir;
421 sblock.fs_cstotal.cs_nbfree = sblock.fs_old_cstotal.cs_nbfree;
422 sblock.fs_cstotal.cs_nifree = sblock.fs_old_cstotal.cs_nifree;
423 sblock.fs_cstotal.cs_nffree = sblock.fs_old_cstotal.cs_nffree;
424 }
425 havesb = 1;
426 return (1);
427 }
428
429 void
sblock_init(void)430 sblock_init(void)
431 {
432
433 fswritefd = -1;
434 fsmodified = 0;
435 lfdir = 0;
436 initbarea(&sblk, BT_SUPERBLK);
437 initbarea(&asblk, BT_SUPERBLK);
438 sblk.b_un.b_buf = Malloc(SBLOCKSIZE);
439 asblk.b_un.b_buf = Malloc(SBLOCKSIZE);
440 if (sblk.b_un.b_buf == NULL || asblk.b_un.b_buf == NULL)
441 errx(EEXIT, "cannot allocate space for superblock");
442 dev_bsize = secsize = DEV_BSIZE;
443 }
444
445 /*
446 * Calculate a prototype superblock based on information in the boot area.
447 * When done the cgsblock macro can be calculated and the fs_ncg field
448 * can be used. Do NOT attempt to use other macros without verifying that
449 * their needed information is available!
450 */
451 static int
calcsb(char * dev,int devfd,struct fs * fs)452 calcsb(char *dev, int devfd, struct fs *fs)
453 {
454 struct fsrecovery *fsr;
455 char *fsrbuf;
456 u_int secsize;
457
458 /*
459 * We need fragments-per-group and the partition-size.
460 *
461 * Newfs stores these details at the end of the boot block area
462 * at the start of the filesystem partition. If they have been
463 * overwritten by a boot block, we fail. But usually they are
464 * there and we can use them.
465 */
466 if (ioctl(devfd, DIOCGSECTORSIZE, &secsize) == -1)
467 return (0);
468 fsrbuf = Malloc(secsize);
469 if (fsrbuf == NULL)
470 errx(EEXIT, "calcsb: cannot allocate recovery buffer");
471 if (blread(devfd, fsrbuf,
472 (SBLOCK_UFS2 - secsize) / dev_bsize, secsize) != 0)
473 return (0);
474 fsr = (struct fsrecovery *)&fsrbuf[secsize - sizeof *fsr];
475 if (fsr->fsr_magic != FS_UFS2_MAGIC)
476 return (0);
477 memset(fs, 0, sizeof(struct fs));
478 fs->fs_fpg = fsr->fsr_fpg;
479 fs->fs_fsbtodb = fsr->fsr_fsbtodb;
480 fs->fs_sblkno = fsr->fsr_sblkno;
481 fs->fs_magic = fsr->fsr_magic;
482 fs->fs_ncg = fsr->fsr_ncg;
483 free(fsrbuf);
484 return (1);
485 }
486
487 /*
488 * Check to see if recovery information exists.
489 * Return 1 if it exists or cannot be created.
490 * Return 0 if it does not exist and can be created.
491 */
492 static int
chkrecovery(int devfd)493 chkrecovery(int devfd)
494 {
495 struct fsrecovery *fsr;
496 char *fsrbuf;
497 u_int secsize;
498
499 /*
500 * Could not determine if backup material exists, so do not
501 * offer to create it.
502 */
503 if (ioctl(devfd, DIOCGSECTORSIZE, &secsize) == -1 ||
504 (fsrbuf = Malloc(secsize)) == NULL ||
505 blread(devfd, fsrbuf, (SBLOCK_UFS2 - secsize) / dev_bsize,
506 secsize) != 0)
507 return (1);
508 /*
509 * Recovery material has already been created, so do not
510 * need to create it again.
511 */
512 fsr = (struct fsrecovery *)&fsrbuf[secsize - sizeof *fsr];
513 if (fsr->fsr_magic == FS_UFS2_MAGIC) {
514 free(fsrbuf);
515 return (1);
516 }
517 /*
518 * Recovery material has not been created and can be if desired.
519 */
520 free(fsrbuf);
521 return (0);
522 }
523
524 /*
525 * Read the last sector of the boot block, replace the last
526 * 20 bytes with the recovery information, then write it back.
527 * The recovery information only works for UFS2 filesystems.
528 */
529 static void
saverecovery(int readfd,int writefd)530 saverecovery(int readfd, int writefd)
531 {
532 struct fsrecovery *fsr;
533 char *fsrbuf;
534 u_int secsize;
535
536 if (sblock.fs_magic != FS_UFS2_MAGIC ||
537 ioctl(readfd, DIOCGSECTORSIZE, &secsize) == -1 ||
538 (fsrbuf = Malloc(secsize)) == NULL ||
539 blread(readfd, fsrbuf, (SBLOCK_UFS2 - secsize) / dev_bsize,
540 secsize) != 0) {
541 printf("RECOVERY DATA COULD NOT BE CREATED\n");
542 return;
543 }
544 fsr = (struct fsrecovery *)&fsrbuf[secsize - sizeof *fsr];
545 fsr->fsr_magic = sblock.fs_magic;
546 fsr->fsr_fpg = sblock.fs_fpg;
547 fsr->fsr_fsbtodb = sblock.fs_fsbtodb;
548 fsr->fsr_sblkno = sblock.fs_sblkno;
549 fsr->fsr_ncg = sblock.fs_ncg;
550 blwrite(writefd, fsrbuf, (SBLOCK_UFS2 - secsize) / secsize, secsize);
551 free(fsrbuf);
552 }
553