2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1980, 1986, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
34 static const char sccsid[] = "@(#)setup.c 8.10 (Berkeley) 5/9/95";
37 #include <sys/cdefs.h>
38 #include <sys/param.h>
42 #include <sys/disklabel.h>
44 #include <sys/sysctl.h>
46 #include <ufs/ufs/dinode.h>
47 #include <ufs/ffs/fs.h>
58 struct inohash *inphash; /* hash list of directory inode info */
59 struct inoinfo **inpsort; /* disk order list of directory inodes */
60 struct inode snaplist[FSMAXSNAP + 1]; /* list of active snapshots */
61 int snapcnt; /* number of active snapshots */
62 char *copybuf; /* buffer to copy snapshot blocks */
64 static int sbhashfailed;
65 #define POWEROF2(num) (((num) & ((num) - 1)) == 0)
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 static int getlbnblkno(struct inodesc *);
71 static int checksnapinfo(struct inode *);
74 * Read in a superblock finding an alternate if necessary.
75 * Return 1 if successful, 0 if unsuccessful, -1 if file system
76 * is already clean (ckclean and preen mode only).
85 * We are expected to have an open file descriptor and a superblock.
87 if (fsreadfd < 0 || havesb == 0) {
90 printf("setup: missing fsreadfd\n");
92 printf("setup: missing superblock\n");
99 (nflag || (fswritefd = open(dev, O_WRONLY)) < 0)) {
102 pfatal("NO WRITE ACCESS");
103 printf(" (NO WRITE)");
107 if (sbhashfailed != 0) {
108 pwarn("SUPERBLOCK CHECK HASH FAILED");
110 pwarn("OPENED READONLY SO CANNOT CORRECT CHECK HASH\n");
111 else if (preen || reply("CORRECT CHECK HASH") != 0) {
113 printf(" (CORRECTED)\n");
118 if (skipclean && ckclean && sblock.fs_clean) {
119 pwarn("FILE SYSTEM CLEAN; SKIPPING CHECKS\n");
122 maxfsblock = sblock.fs_size;
123 maxino = sblock.fs_ncg * sblock.fs_ipg;
125 * Check and potentially fix certain fields in the super block.
127 if (sblock.fs_optim != FS_OPTTIME && sblock.fs_optim != FS_OPTSPACE) {
128 pfatal("UNDEFINED OPTIMIZATION IN SUPERBLOCK");
129 if (reply("SET TO DEFAULT") == 1) {
130 sblock.fs_optim = FS_OPTTIME;
134 if ((sblock.fs_minfree < 0 || sblock.fs_minfree > 99)) {
135 pfatal("IMPOSSIBLE MINFREE=%d IN SUPERBLOCK",
137 if (reply("SET TO DEFAULT") == 1) {
138 sblock.fs_minfree = 10;
142 if (sblock.fs_magic == FS_UFS1_MAGIC &&
143 sblock.fs_old_inodefmt < FS_44INODEFMT) {
144 pwarn("Format of file system is too old.\n");
145 pwarn("Must update to modern format using a version of fsck\n");
146 pfatal("from before 2002 with the command ``fsck -c 2''\n");
149 if (preen == 0 && yflag == 0 && sblock.fs_magic == FS_UFS2_MAGIC &&
150 fswritefd != -1 && chkrecovery(fsreadfd) == 0 &&
151 reply("SAVE DATA TO FIND ALTERNATE SUPERBLOCKS") != 0)
152 saverecovery(fsreadfd, fswritefd);
154 * allocate and initialize the necessary maps
157 bmapsize = roundup(howmany(maxfsblock, CHAR_BIT), sizeof(short));
158 blockmap = Calloc((unsigned)bmapsize, sizeof (char));
159 if (blockmap == NULL) {
160 printf("cannot alloc %u bytes for blockmap\n",
164 inostathead = Calloc(sblock.fs_ncg, sizeof(struct inostatlist));
165 if (inostathead == NULL) {
166 printf("cannot alloc %u bytes for inostathead\n",
167 (unsigned)(sizeof(struct inostatlist) * (sblock.fs_ncg)));
170 numdirs = sblock.fs_cstotal.cs_ndir;
171 dirhash = MAX(numdirs / 2, 1);
173 listmax = numdirs + 10;
174 inpsort = (struct inoinfo **)Calloc(listmax, sizeof(struct inoinfo *));
175 inphash = (struct inohash *)Calloc(dirhash, sizeof(struct inohash));
176 if (inpsort == NULL || inphash == NULL) {
177 printf("cannot alloc %ju bytes for inphash\n",
178 (uintmax_t)numdirs * sizeof(struct inoinfo *));
181 if (sblock.fs_flags & FS_DOSOFTDEP)
186 * Collect any snapshot inodes so that we can allow them to
187 * claim any blocks that we free. The code for doing this is
188 * imported here and into inode.c from sys/ufs/ffs/ffs_snapshot.c.
190 for (snapcnt = 0; snapcnt < FSMAXSNAP; snapcnt++) {
191 if (sblock.fs_snapinum[snapcnt] == 0)
193 ginode(sblock.fs_snapinum[snapcnt], &ip);
194 if ((DIP(ip.i_dp, di_mode) & IFMT) == IFREG &&
195 (DIP(ip.i_dp, di_flags) & SF_SNAPSHOT) != 0 &&
196 checksnapinfo(&ip)) {
198 printf("Load snapshot %jd\n",
199 (intmax_t)sblock.fs_snapinum[snapcnt]);
200 snaplist[snapcnt] = ip;
203 printf("Removing non-snapshot inode %ju from snapshot list\n",
204 (uintmax_t)sblock.fs_snapinum[snapcnt]);
206 for (i = snapcnt + 1; i < FSMAXSNAP; i++) {
207 if (sblock.fs_snapinum[i] == 0)
209 sblock.fs_snapinum[i - 1] = sblock.fs_snapinum[i];
211 sblock.fs_snapinum[i - 1] = 0;
215 if (snapcnt > 0 && copybuf == NULL) {
216 copybuf = Balloc(sblock.fs_bsize);
218 errx(EEXIT, "cannot allocate space for snapshot "
229 * Check for valid snapshot information.
231 * Each snapshot has a list of blocks that have been copied. This list
232 * is consulted before checking the snapshot inode. Its purpose is to
233 * speed checking of commonly checked blocks and to avoid recursive
234 * checks of the snapshot inode. In particular, the list must contain
235 * the superblock, the superblock summary information, and all the
236 * cylinder group blocks. The list may contain other commonly checked
237 * pointers such as those of the blocks that contain the snapshot inodes.
238 * The list is sorted into block order to allow binary search lookup.
240 * The twelve direct direct block pointers of the snapshot are always
241 * copied, so we test for them first before checking the list itself
242 * (i.e., they are not in the list).
244 * The checksnapinfo() routine needs to ensure that the list contains at
245 * least the super block, its summary information, and the cylinder groups.
246 * Here we check the list first for the superblock, zero or more cylinder
247 * groups up to the location of the superblock summary information, the
248 * summary group information, and any remaining cylinder group maps that
249 * follow it. We skip over any other entries in the list.
251 #define CHKBLKINLIST(chkblk) \
252 /* All UFS_NDADDR blocks are copied */ \
253 if ((chkblk) >= UFS_NDADDR) { \
254 /* Skip over blocks that are not of interest */ \
255 while (*blkp < (chkblk) && blkp < lastblkp) \
257 /* Fail if end of list and not all blocks found */ \
258 if (blkp >= lastblkp) { \
259 pwarn("UFS%d snapshot inode %jd failed: " \
260 "improper block list length (%jd)\n", \
261 sblock.fs_magic == FS_UFS1_MAGIC ? 1 : 2, \
262 (intmax_t)snapip->i_number, \
263 (intmax_t)(lastblkp - &snapblklist[0])); \
266 /* Fail if block we seek is missing */ \
267 else if (*blkp++ != (chkblk)) { \
268 pwarn("UFS%d snapshot inode %jd failed: " \
269 "block list (%jd) != %s (%jd)\n", \
270 sblock.fs_magic == FS_UFS1_MAGIC ? 1 : 2, \
271 (intmax_t)snapip->i_number, \
272 (intmax_t)blkp[-1], #chkblk, \
279 checksnapinfo(struct inode *snapip)
283 struct inodesc idesc;
284 daddr_t *snapblklist, *blkp, *lastblkp, csblkno;
285 int cg, loc, len, status;
290 memset(&idesc, 0, sizeof(struct inodesc));
291 idesc.id_type = ADDR;
292 idesc.id_func = getlbnblkno;
293 idesc.id_number = snapip->i_number;
294 lbn = howmany(fs->fs_size, fs->fs_frag);
295 idesc.id_parent = lbn; /* sought after blkno */
296 if ((ckinode(snapip->i_dp, &idesc) & FOUND) == 0)
298 size = fragroundup(fs,
299 DIP(snapip->i_dp, di_size) - lblktosize(fs, lbn));
300 bp = getdatablk(idesc.id_parent, size, BT_DATA);
303 snapblklist = (daddr_t *)bp->b_un.b_buf;
305 * snapblklist[0] is the size of the list
306 * snapblklist[1] is the first element of the list
308 * We need to be careful to bound the size of the list and verify
309 * that we have not run off the end of it if it or its size has
312 blkp = &snapblklist[1];
313 lastblkp = &snapblklist[MAX(0,
314 MIN(snapblklist[0] + 1, size / sizeof(daddr_t)))];
316 /* Check that the superblock is listed. */
317 CHKBLKINLIST(lblkno(fs, fs->fs_sblockloc));
321 * Calculate where the summary information is located.
322 * Usually it is in the first cylinder group, but growfs
323 * may move it to the first cylinder group that it adds.
325 * Check all cylinder groups up to the summary information.
327 csblkno = fragstoblks(fs, fs->fs_csaddr);
328 for (cg = 0; cg < fs->fs_ncg; cg++) {
329 if (fragstoblks(fs, cgtod(fs, cg)) > csblkno)
331 CHKBLKINLIST(fragstoblks(fs, cgtod(fs, cg)));
335 /* Check the summary information block(s). */
336 len = howmany(fs->fs_cssize, fs->fs_bsize);
337 for (loc = 0; loc < len; loc++) {
338 CHKBLKINLIST(csblkno + loc);
342 /* Check the remaining cylinder groups. */
343 for (; cg < fs->fs_ncg; cg++) {
344 CHKBLKINLIST(fragstoblks(fs, cgtod(fs, cg)));
354 * Return the block number associated with a specified inode lbn.
355 * Requested lbn is in id_parent. If found, block is returned in
359 getlbnblkno(struct inodesc *idesc)
362 if (idesc->id_lbn < idesc->id_parent)
364 idesc->id_parent = idesc->id_blkno;
365 return (STOP | FOUND);
369 * Open a device or file to be checked by fsck.
372 openfilesys(char *dev)
377 if (stat(dev, &statb) < 0)
379 if ((statb.st_mode & S_IFMT) != S_IFCHR &&
380 (statb.st_mode & S_IFMT) != S_IFBLK) {
381 if (bkgrdflag != 0 && (statb.st_flags & SF_SNAPSHOT) == 0) {
382 pwarn("BACKGROUND FSCK LACKS A SNAPSHOT\n");
385 if (bkgrdflag != 0) {
386 cursnapshot = statb.st_ino;
388 pwarn("%s IS NOT A DISK DEVICE\n", dev);
389 if (preen || reply("CONTINUE") == 0)
393 saved_fsreadfd = fsreadfd;
394 if ((fsreadfd = open(dev, O_RDONLY)) < 0) {
395 fsreadfd = saved_fsreadfd;
398 if (saved_fsreadfd != -1)
399 close(saved_fsreadfd);
404 * Read in the super block and its summary info.
412 readcnt[sblk.b_type]++;
414 * If bflag is given, then check just that superblock.
417 switch (sbget(fsreadfd, &fs, bflag * dev_bsize, 0)) {
421 printf("Check hash failed for superblock at %jd\n",
425 printf("%jd is not a file system superblock\n", bflag);
429 printf("I/O error reading %jd\n", bflag);
434 * Check for the standard superblock and use it if good.
436 if (sbget(fsreadfd, &fs, UFS_STDSB, UFS_NOMSG) == 0)
439 * Check if the only problem is a check-hash failure.
442 if (sbget(fsreadfd, &fs, UFS_STDSB, UFS_NOMSG | UFS_NOHASHFAIL) == 0) {
447 * Do an exhaustive search for a usable superblock.
449 switch (sbsearch(fsreadfd, &fs, 0)) {
453 printf("SEARCH FOR ALTERNATE SUPER-BLOCK FAILED. "
454 "YOU MUST USE THE\n-b OPTION TO FSCK TO SPECIFY "
455 "THE LOCATION OF AN ALTERNATE\nSUPER-BLOCK TO "
456 "SUPPLY NEEDED INFORMATION; SEE fsck_ffs(8).\n");
460 printf("I/O error reading a usable superblock\n");
465 memcpy(&sblock, fs, fs->fs_sbsize);
468 * Compute block size that the file system is based on,
469 * according to fsbtodb, and adjust superblock block number
470 * so we can tell if this is an alternate later.
472 dev_bsize = sblock.fs_fsize / fsbtodb(&sblock, 1);
473 sblk.b_bno = sblock.fs_sblockactualloc / dev_bsize;
474 sblk.b_size = SBLOCKSIZE;
476 * If not yet done, update UFS1 superblock with new wider fields.
478 if (sblock.fs_magic == FS_UFS1_MAGIC &&
479 sblock.fs_maxbsize != sblock.fs_bsize) {
480 sblock.fs_maxbsize = sblock.fs_bsize;
481 sblock.fs_time = sblock.fs_old_time;
482 sblock.fs_size = sblock.fs_old_size;
483 sblock.fs_dsize = sblock.fs_old_dsize;
484 sblock.fs_csaddr = sblock.fs_old_csaddr;
485 sblock.fs_cstotal.cs_ndir = sblock.fs_old_cstotal.cs_ndir;
486 sblock.fs_cstotal.cs_nbfree = sblock.fs_old_cstotal.cs_nbfree;
487 sblock.fs_cstotal.cs_nifree = sblock.fs_old_cstotal.cs_nifree;
488 sblock.fs_cstotal.cs_nffree = sblock.fs_old_cstotal.cs_nffree;
502 initbarea(&sblk, BT_SUPERBLK);
503 sblk.b_un.b_buf = Balloc(SBLOCKSIZE);
504 if (sblk.b_un.b_buf == NULL)
505 errx(EEXIT, "cannot allocate space for superblock");
506 dev_bsize = secsize = DEV_BSIZE;
510 * Calculate a prototype superblock based on information in the boot area.
511 * When done the cgsblock macro can be calculated and the fs_ncg field
512 * can be used. Do NOT attempt to use other macros without verifying that
513 * their needed information is available!
516 calcsb(char *dev, int devfd, struct fs *fs)
518 struct fsrecovery *fsr;
523 * We need fragments-per-group and the partition-size.
525 * Newfs stores these details at the end of the boot block area
526 * at the start of the filesystem partition. If they have been
527 * overwritten by a boot block, we fail. But usually they are
528 * there and we can use them.
530 if (ioctl(devfd, DIOCGSECTORSIZE, &secsize) == -1)
532 fsrbuf = Balloc(secsize);
534 errx(EEXIT, "calcsb: cannot allocate recovery buffer");
535 if (blread(devfd, fsrbuf,
536 (SBLOCK_UFS2 - secsize) / dev_bsize, secsize) != 0) {
540 fsr = (struct fsrecovery *)&fsrbuf[secsize - sizeof *fsr];
541 if (fsr->fsr_magic != FS_UFS2_MAGIC) {
545 memset(fs, 0, sizeof(struct fs));
546 fs->fs_fpg = fsr->fsr_fpg;
547 fs->fs_fsbtodb = fsr->fsr_fsbtodb;
548 fs->fs_sblkno = fsr->fsr_sblkno;
549 fs->fs_magic = fsr->fsr_magic;
550 fs->fs_ncg = fsr->fsr_ncg;
556 * Check to see if recovery information exists.
557 * Return 1 if it exists or cannot be created.
558 * Return 0 if it does not exist and can be created.
561 chkrecovery(int devfd)
563 struct fsrecovery *fsr;
565 u_int secsize, rdsize;
568 * Could not determine if backup material exists, so do not
569 * offer to create it.
572 rdsize = sblock.fs_fsize;
573 if (ioctl(devfd, DIOCGSECTORSIZE, &secsize) == -1 ||
574 rdsize % secsize != 0 ||
575 (fsrbuf = Balloc(rdsize)) == NULL ||
576 blread(devfd, fsrbuf, (SBLOCK_UFS2 - rdsize) / dev_bsize,
582 * Recovery material has already been created, so do not
583 * need to create it again.
585 fsr = (struct fsrecovery *)&fsrbuf[rdsize - sizeof *fsr];
586 if (fsr->fsr_magic == FS_UFS2_MAGIC) {
591 * Recovery material has not been created and can be if desired.
598 * Read the last filesystem-size piece of the boot block, replace the
599 * last 20 bytes with the recovery information, then write it back.
600 * The recovery information only works for UFS2 filesystems.
603 saverecovery(int readfd, int writefd)
605 struct fsrecovery *fsr;
607 u_int secsize, rdsize;
610 rdsize = sblock.fs_fsize;
611 if (sblock.fs_magic != FS_UFS2_MAGIC ||
612 ioctl(readfd, DIOCGSECTORSIZE, &secsize) == -1 ||
613 rdsize % secsize != 0 ||
614 (fsrbuf = Balloc(rdsize)) == NULL ||
615 blread(readfd, fsrbuf, (SBLOCK_UFS2 - rdsize) / dev_bsize,
617 printf("RECOVERY DATA COULD NOT BE CREATED\n");
621 fsr = (struct fsrecovery *)&fsrbuf[rdsize - sizeof *fsr];
622 fsr->fsr_magic = sblock.fs_magic;
623 fsr->fsr_fpg = sblock.fs_fpg;
624 fsr->fsr_fsbtodb = sblock.fs_fsbtodb;
625 fsr->fsr_sblkno = sblock.fs_sblkno;
626 fsr->fsr_ncg = sblock.fs_ncg;
627 blwrite(writefd, fsrbuf, (SBLOCK_UFS2 - rdsize) / dev_bsize, rdsize);