2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1989, 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
31 * @(#)ffs_subr.c 8.5 (Berkeley) 3/21/95
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
44 #include <sys/errno.h>
45 #include <ufs/ufs/dinode.h>
46 #include <ufs/ffs/fs.h>
48 uint32_t calculate_crc32c(uint32_t, const void *, size_t);
49 uint32_t ffs_calc_sbhash(struct fs *);
51 #define UFS_MALLOC(size, type, flags) malloc(size)
52 #define UFS_FREE(ptr, type) free(ptr)
53 #define UFS_TIME time(NULL)
55 * Request standard superblock location in ffs_sbget
57 #define STDSB -1 /* Fail if check-hash is bad */
58 #define STDSB_NOHASHFAIL -2 /* Ignore check-hash failure */
61 #include <sys/systm.h>
63 #include <sys/malloc.h>
64 #include <sys/mount.h>
65 #include <sys/vnode.h>
68 #include <sys/ucred.h>
70 #include <ufs/ufs/quota.h>
71 #include <ufs/ufs/inode.h>
72 #include <ufs/ufs/extattr.h>
73 #include <ufs/ufs/ufsmount.h>
74 #include <ufs/ufs/ufs_extern.h>
75 #include <ufs/ffs/ffs_extern.h>
76 #include <ufs/ffs/fs.h>
78 #define UFS_MALLOC(size, type, flags) malloc(size, type, flags)
79 #define UFS_FREE(ptr, type) free(ptr, type)
80 #define UFS_TIME time_second
83 * Return buffer with the contents of block "offset" from the beginning of
84 * directory "ip". If "res" is non-zero, fill it in with a pointer to the
85 * remaining space in the directory.
88 ffs_blkatoff(struct vnode *vp, off_t offset, char **res, struct buf **bpp)
98 lbn = lblkno(fs, offset);
99 bsize = blksize(fs, ip, lbn);
102 error = bread(vp, lbn, bsize, NOCRED, &bp);
108 *res = (char *)bp->b_data + blkoff(fs, offset);
114 * Load up the contents of an inode and copy the appropriate pieces
115 * to the incore copy.
118 ffs_load_inode(struct buf *bp, struct inode *ip, struct fs *fs, ino_t ino)
120 struct ufs1_dinode *dip1;
121 struct ufs2_dinode *dip2;
127 *((struct ufs1_dinode *)bp->b_data + ino_to_fsbo(fs, ino));
128 ip->i_mode = dip1->di_mode;
129 ip->i_nlink = dip1->di_nlink;
130 ip->i_effnlink = dip1->di_nlink;
131 ip->i_size = dip1->di_size;
132 ip->i_flags = dip1->di_flags;
133 ip->i_gen = dip1->di_gen;
134 ip->i_uid = dip1->di_uid;
135 ip->i_gid = dip1->di_gid;
138 dip2 = ((struct ufs2_dinode *)bp->b_data + ino_to_fsbo(fs, ino));
139 if ((error = ffs_verify_dinode_ckhash(fs, dip2)) != 0) {
140 printf("%s: inode %jd: check-hash failed\n", fs->fs_fsmnt,
146 ip->i_mode = dip2->di_mode;
147 ip->i_nlink = dip2->di_nlink;
148 ip->i_effnlink = dip2->di_nlink;
149 ip->i_size = dip2->di_size;
150 ip->i_flags = dip2->di_flags;
151 ip->i_gen = dip2->di_gen;
152 ip->i_uid = dip2->di_uid;
153 ip->i_gid = dip2->di_gid;
159 * Verify an inode check-hash.
162 ffs_verify_dinode_ckhash(struct fs *fs, struct ufs2_dinode *dip)
164 uint32_t save_ckhash;
167 * Return success if unallocated or we are not doing inode check-hash.
169 if (dip->di_mode == 0 || (fs->fs_metackhash & CK_INODE) == 0)
172 * Exclude di_ckhash from the crc32 calculation, e.g., always use
173 * a check-hash value of zero when calculating the check-hash.
175 save_ckhash = dip->di_ckhash;
177 if (save_ckhash != calculate_crc32c(~0L, (void *)dip, sizeof(*dip)))
179 dip->di_ckhash = save_ckhash;
184 * Update an inode check-hash.
187 ffs_update_dinode_ckhash(struct fs *fs, struct ufs2_dinode *dip)
190 if (dip->di_mode == 0 || (fs->fs_metackhash & CK_INODE) == 0)
193 * Exclude old di_ckhash from the crc32 calculation, e.g., always use
194 * a check-hash value of zero when calculating the new check-hash.
197 dip->di_ckhash = calculate_crc32c(~0L, (void *)dip, sizeof(*dip));
201 * These are the low-level functions that actually read and write
202 * the superblock and its associated data.
204 static off_t sblock_try[] = SBLOCKSEARCH;
205 static int readsuper(void *, struct fs **, off_t, int, int,
206 int (*)(void *, off_t, void **, int));
209 * Read a superblock from the devfd device.
211 * If an alternate superblock is specified, it is read. Otherwise the
212 * set of locations given in the SBLOCKSEARCH list is searched for a
213 * superblock. Memory is allocated for the superblock by the readfunc and
214 * is returned. If filltype is non-NULL, additional memory is allocated
215 * of type filltype and filled in with the superblock summary information.
216 * All memory is freed when any error is returned.
218 * If a superblock is found, zero is returned. Otherwise one of the
219 * following error values is returned:
220 * EIO: non-existent or truncated superblock.
221 * EIO: error reading summary information.
222 * ENOENT: no usable known superblock found.
223 * ENOSPC: failed to allocate space for the superblock.
224 * EINVAL: The previous newfs operation on this volume did not complete.
225 * The administrator must complete newfs before using this volume.
228 ffs_sbget(void *devfd, struct fs **fsp, off_t altsblock,
229 struct malloc_type *filltype,
230 int (*readfunc)(void *devfd, off_t loc, void **bufp, int size))
233 int i, error, size, blks;
242 if (altsblock >= 0) {
243 if ((error = readsuper(devfd, &fs, altsblock, 1, chkhash,
246 UFS_FREE(fs, filltype);
250 if (altsblock == STDSB_NOHASHFAIL)
252 for (i = 0; sblock_try[i] != -1; i++) {
253 if ((error = readsuper(devfd, &fs, sblock_try[i], 0,
254 chkhash, readfunc)) == 0)
257 UFS_FREE(fs, filltype);
264 if (sblock_try[i] == -1)
268 * Read in the superblock summary information.
270 size = fs->fs_cssize;
271 blks = howmany(size, fs->fs_fsize);
272 if (fs->fs_contigsumsize > 0)
273 size += fs->fs_ncg * sizeof(int32_t);
274 size += fs->fs_ncg * sizeof(u_int8_t);
275 /* When running in libufs or libsa, UFS_MALLOC may fail */
276 if ((space = UFS_MALLOC(size, filltype, M_WAITOK)) == NULL) {
277 UFS_FREE(fs, filltype);
280 fs->fs_csp = (struct csum *)space;
281 for (i = 0; i < blks; i += fs->fs_frag) {
283 if (i + fs->fs_frag > blks)
284 size = (blks - i) * fs->fs_fsize;
286 error = (*readfunc)(devfd,
287 dbtob(fsbtodb(fs, fs->fs_csaddr + i)), (void **)&buf, size);
290 UFS_FREE(buf, filltype);
291 UFS_FREE(fs->fs_csp, filltype);
292 UFS_FREE(fs, filltype);
295 memcpy(space, buf, size);
296 UFS_FREE(buf, filltype);
299 if (fs->fs_contigsumsize > 0) {
300 fs->fs_maxcluster = lp = (int32_t *)space;
301 for (i = 0; i < fs->fs_ncg; i++)
302 *lp++ = fs->fs_contigsumsize;
303 space = (uint8_t *)lp;
305 size = fs->fs_ncg * sizeof(u_int8_t);
306 fs->fs_contigdirs = (u_int8_t *)space;
307 bzero(fs->fs_contigdirs, size);
313 * Try to read a superblock from the location specified by sblockloc.
314 * Return zero on success or an errno on failure.
317 readsuper(void *devfd, struct fs **fsp, off_t sblockloc, int isaltsblk,
318 int chkhash, int (*readfunc)(void *devfd, off_t loc, void **bufp, int size))
324 error = (*readfunc)(devfd, sblockloc, (void **)fsp, SBLOCKSIZE);
328 if (fs->fs_magic == FS_BAD_MAGIC)
330 if (((fs->fs_magic == FS_UFS1_MAGIC && (isaltsblk ||
331 sblockloc <= SBLOCK_UFS1)) ||
332 (fs->fs_magic == FS_UFS2_MAGIC && (isaltsblk ||
333 sblockloc == fs->fs_sblockloc))) &&
335 fs->fs_bsize >= MINBSIZE &&
336 fs->fs_bsize <= MAXBSIZE &&
337 fs->fs_bsize >= roundup(sizeof(struct fs), DEV_BSIZE) &&
338 fs->fs_sbsize <= SBLOCKSIZE) {
340 * If the filesystem has been run on a kernel without
341 * metadata check hashes, disable them.
343 if ((fs->fs_flags & FS_METACKHASH) == 0)
344 fs->fs_metackhash = 0;
345 if (fs->fs_ckhash != (ckhash = ffs_calc_sbhash(fs))) {
347 res = uprintf("Superblock check-hash failed: recorded "
348 "check-hash 0x%x != computed check-hash 0x%x%s\n",
349 fs->fs_ckhash, ckhash,
350 chkhash == 0 ? " (Ignored)" : "");
355 * Print check-hash failure if no controlling terminal
356 * in kernel or always if in user-mode (libufs).
359 printf("Superblock check-hash failed: recorded "
360 "check-hash 0x%x != computed check-hash "
361 "0x%x%s\n", fs->fs_ckhash, ckhash,
362 chkhash == 0 ? " (Ignored)" : "");
364 fs->fs_flags |= FS_NEEDSFSCK;
371 /* Have to set for old filesystems that predate this field */
372 fs->fs_sblockactualloc = sblockloc;
373 /* Not yet any summary information */
381 * Write a superblock to the devfd device from the memory pointed to by fs.
382 * Write out the superblock summary information if it is present.
384 * If the write is successful, zero is returned. Otherwise one of the
385 * following error values is returned:
386 * EIO: failed to write superblock.
387 * EIO: failed to write superblock summary information.
390 ffs_sbput(void *devfd, struct fs *fs, off_t loc,
391 int (*writefunc)(void *devfd, off_t loc, void *buf, int size))
393 int i, error, blks, size;
397 * If there is summary information, write it first, so if there
398 * is an error, the superblock will not be marked as clean.
400 if (fs->fs_csp != NULL) {
401 blks = howmany(fs->fs_cssize, fs->fs_fsize);
402 space = (uint8_t *)fs->fs_csp;
403 for (i = 0; i < blks; i += fs->fs_frag) {
405 if (i + fs->fs_frag > blks)
406 size = (blks - i) * fs->fs_fsize;
407 if ((error = (*writefunc)(devfd,
408 dbtob(fsbtodb(fs, fs->fs_csaddr + i)),
415 fs->fs_time = UFS_TIME;
416 fs->fs_ckhash = ffs_calc_sbhash(fs);
417 if ((error = (*writefunc)(devfd, loc, fs, fs->fs_sbsize)) != 0)
423 * Calculate the check-hash for a superblock.
426 ffs_calc_sbhash(struct fs *fs)
428 uint32_t ckhash, save_ckhash;
431 * A filesystem that was using a superblock ckhash may be moved
432 * to an older kernel that does not support ckhashes. The
433 * older kernel will clear the FS_METACKHASH flag indicating
434 * that it does not update hashes. When the disk is moved back
435 * to a kernel capable of ckhashes it disables them on mount:
437 * if ((fs->fs_flags & FS_METACKHASH) == 0)
438 * fs->fs_metackhash = 0;
440 * This leaves (fs->fs_metackhash & CK_SUPERBLOCK) == 0) with an
441 * old stale value in the fs->fs_ckhash field. Thus the need to
442 * just accept what is there.
444 if ((fs->fs_metackhash & CK_SUPERBLOCK) == 0)
445 return (fs->fs_ckhash);
447 save_ckhash = fs->fs_ckhash;
450 * If newly read from disk, the caller is responsible for
451 * verifying that fs->fs_sbsize <= SBLOCKSIZE.
453 ckhash = calculate_crc32c(~0L, (void *)fs, fs->fs_sbsize);
454 fs->fs_ckhash = save_ckhash;
459 * Update the frsum fields to reflect addition or deletion
463 ffs_fragacct(struct fs *fs, int fragmap, int32_t fraglist[], int cnt)
469 inblk = (int)(fragtbl[fs->fs_frag][fragmap]) << 1;
471 for (siz = 1; siz < fs->fs_frag; siz++) {
472 if ((inblk & (1 << (siz + (fs->fs_frag % NBBY)))) == 0)
475 subfield = inside[siz];
476 for (pos = siz; pos <= fs->fs_frag; pos++) {
477 if ((fragmap & field) == subfield) {
478 fraglist[siz] += cnt;
492 * check if a block is available
495 ffs_isblock(struct fs *fs, unsigned char *cp, ufs1_daddr_t h)
499 switch ((int)fs->fs_frag) {
501 return (cp[h] == 0xff);
503 mask = 0x0f << ((h & 0x1) << 2);
504 return ((cp[h >> 1] & mask) == mask);
506 mask = 0x03 << ((h & 0x3) << 1);
507 return ((cp[h >> 2] & mask) == mask);
509 mask = 0x01 << (h & 0x7);
510 return ((cp[h >> 3] & mask) == mask);
513 panic("ffs_isblock");
521 * check if a block is free
524 ffs_isfreeblock(struct fs *fs, u_char *cp, ufs1_daddr_t h)
527 switch ((int)fs->fs_frag) {
531 return ((cp[h >> 1] & (0x0f << ((h & 0x1) << 2))) == 0);
533 return ((cp[h >> 2] & (0x03 << ((h & 0x3) << 1))) == 0);
535 return ((cp[h >> 3] & (0x01 << (h & 0x7))) == 0);
538 panic("ffs_isfreeblock");
546 * take a block out of the map
549 ffs_clrblock(struct fs *fs, u_char *cp, ufs1_daddr_t h)
552 switch ((int)fs->fs_frag) {
557 cp[h >> 1] &= ~(0x0f << ((h & 0x1) << 2));
560 cp[h >> 2] &= ~(0x03 << ((h & 0x3) << 1));
563 cp[h >> 3] &= ~(0x01 << (h & 0x7));
567 panic("ffs_clrblock");
574 * put a block into the map
577 ffs_setblock(struct fs *fs, unsigned char *cp, ufs1_daddr_t h)
580 switch ((int)fs->fs_frag) {
586 cp[h >> 1] |= (0x0f << ((h & 0x1) << 2));
589 cp[h >> 2] |= (0x03 << ((h & 0x3) << 1));
592 cp[h >> 3] |= (0x01 << (h & 0x7));
596 panic("ffs_setblock");
603 * Update the cluster map because of an allocation or free.
605 * Cnt == 1 means free; cnt == -1 means allocating.
608 ffs_clusteracct(struct fs *fs, struct cg *cgp, ufs1_daddr_t blkno, int cnt)
612 u_char *freemapp, *mapp;
613 int i, start, end, forw, back, map;
616 if (fs->fs_contigsumsize <= 0)
618 freemapp = cg_clustersfree(cgp);
619 sump = cg_clustersum(cgp);
621 * Allocate or clear the actual block.
624 setbit(freemapp, blkno);
626 clrbit(freemapp, blkno);
628 * Find the size of the cluster going forward.
631 end = start + fs->fs_contigsumsize;
632 if (end >= cgp->cg_nclusterblks)
633 end = cgp->cg_nclusterblks;
634 mapp = &freemapp[start / NBBY];
636 bit = 1U << (start % NBBY);
637 for (i = start; i < end; i++) {
638 if ((map & bit) == 0)
640 if ((i & (NBBY - 1)) != (NBBY - 1)) {
649 * Find the size of the cluster going backward.
652 end = start - fs->fs_contigsumsize;
655 mapp = &freemapp[start / NBBY];
657 bit = 1U << (start % NBBY);
658 for (i = start; i > end; i--) {
659 if ((map & bit) == 0)
661 if ((i & (NBBY - 1)) != 0) {
665 bit = 1U << (NBBY - 1);
670 * Account for old cluster and the possibly new forward and
674 if (i > fs->fs_contigsumsize)
675 i = fs->fs_contigsumsize;
682 * Update cluster summary information.
684 lp = &sump[fs->fs_contigsumsize];
685 for (i = fs->fs_contigsumsize; i > 0; i--)
688 fs->fs_maxcluster[cgp->cg_cgx] = i;