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>
49 #define UFS_MALLOC(size, type, flags) malloc(size)
50 #define UFS_FREE(ptr, type) free(ptr)
51 #define UFS_TIME time(NULL)
54 #include <sys/systm.h>
56 #include <sys/malloc.h>
57 #include <sys/mount.h>
58 #include <sys/vnode.h>
61 #include <sys/ucred.h>
63 #include <ufs/ufs/quota.h>
64 #include <ufs/ufs/inode.h>
65 #include <ufs/ufs/extattr.h>
66 #include <ufs/ufs/ufsmount.h>
67 #include <ufs/ufs/ufs_extern.h>
68 #include <ufs/ffs/ffs_extern.h>
69 #include <ufs/ffs/fs.h>
71 #define UFS_MALLOC(size, type, flags) malloc(size, type, flags)
72 #define UFS_FREE(ptr, type) free(ptr, type)
73 #define UFS_TIME time_second
76 * Return buffer with the contents of block "offset" from the beginning of
77 * directory "ip". If "res" is non-zero, fill it in with a pointer to the
78 * remaining space in the directory.
81 ffs_blkatoff(struct vnode *vp, off_t offset, char **res, struct buf **bpp)
91 lbn = lblkno(fs, offset);
92 bsize = blksize(fs, ip, lbn);
95 error = bread(vp, lbn, bsize, NOCRED, &bp);
101 *res = (char *)bp->b_data + blkoff(fs, offset);
107 * Load up the contents of an inode and copy the appropriate pieces
108 * to the incore copy.
111 ffs_load_inode(struct buf *bp, struct inode *ip, struct fs *fs, ino_t ino)
116 *((struct ufs1_dinode *)bp->b_data + ino_to_fsbo(fs, ino));
117 ip->i_mode = ip->i_din1->di_mode;
118 ip->i_nlink = ip->i_din1->di_nlink;
119 ip->i_size = ip->i_din1->di_size;
120 ip->i_flags = ip->i_din1->di_flags;
121 ip->i_gen = ip->i_din1->di_gen;
122 ip->i_uid = ip->i_din1->di_uid;
123 ip->i_gid = ip->i_din1->di_gid;
126 *((struct ufs2_dinode *)bp->b_data + ino_to_fsbo(fs, ino));
127 ip->i_mode = ip->i_din2->di_mode;
128 ip->i_nlink = ip->i_din2->di_nlink;
129 ip->i_size = ip->i_din2->di_size;
130 ip->i_flags = ip->i_din2->di_flags;
131 ip->i_gen = ip->i_din2->di_gen;
132 ip->i_uid = ip->i_din2->di_uid;
133 ip->i_gid = ip->i_din2->di_gid;
139 * These are the low-level functions that actually read and write
140 * the superblock and its associated data.
142 static off_t sblock_try[] = SBLOCKSEARCH;
143 static int readsuper(void *, struct fs **, off_t, int,
144 int (*)(void *, off_t, void **, int));
147 * Read a superblock from the devfd device.
149 * If an alternate superblock is specified, it is read. Otherwise the
150 * set of locations given in the SBLOCKSEARCH list is searched for a
151 * superblock. Memory is allocated for the superblock by the readfunc and
152 * is returned. If filltype is non-NULL, additional memory is allocated
153 * of type filltype and filled in with the superblock summary information.
154 * All memory is freed when any error is returned.
156 * If a superblock is found, zero is returned. Otherwise one of the
157 * following error values is returned:
158 * EIO: non-existent or truncated superblock.
159 * EIO: error reading summary information.
160 * ENOENT: no usable known superblock found.
161 * ENOSPC: failed to allocate space for the superblock.
162 * EINVAL: The previous newfs operation on this volume did not complete.
163 * The administrator must complete newfs before using this volume.
166 ffs_sbget(void *devfd, struct fs **fsp, off_t altsblock,
167 struct malloc_type *filltype,
168 int (*readfunc)(void *devfd, off_t loc, void **bufp, int size))
171 int i, error, size, blks;
178 if (altsblock != -1) {
179 if ((error = readsuper(devfd, &fs, altsblock, 1,
182 UFS_FREE(fs, filltype);
186 for (i = 0; sblock_try[i] != -1; i++) {
187 if ((error = readsuper(devfd, &fs, sblock_try[i], 0,
191 UFS_FREE(fs, filltype);
198 if (sblock_try[i] == -1)
202 * Read in the superblock summary information.
204 size = fs->fs_cssize;
205 blks = howmany(size, fs->fs_fsize);
206 if (fs->fs_contigsumsize > 0)
207 size += fs->fs_ncg * sizeof(int32_t);
208 size += fs->fs_ncg * sizeof(u_int8_t);
209 /* When running in libufs or libsa, UFS_MALLOC may fail */
210 if ((space = UFS_MALLOC(size, filltype, M_WAITOK)) == NULL) {
211 UFS_FREE(fs, filltype);
214 fs->fs_csp = (struct csum *)space;
215 for (i = 0; i < blks; i += fs->fs_frag) {
217 if (i + fs->fs_frag > blks)
218 size = (blks - i) * fs->fs_fsize;
220 error = (*readfunc)(devfd,
221 dbtob(fsbtodb(fs, fs->fs_csaddr + i)), (void **)&buf, size);
224 UFS_FREE(buf, filltype);
225 UFS_FREE(fs->fs_csp, filltype);
226 UFS_FREE(fs, filltype);
229 memcpy(space, buf, size);
230 UFS_FREE(buf, filltype);
233 if (fs->fs_contigsumsize > 0) {
234 fs->fs_maxcluster = lp = (int32_t *)space;
235 for (i = 0; i < fs->fs_ncg; i++)
236 *lp++ = fs->fs_contigsumsize;
237 space = (uint8_t *)lp;
239 size = fs->fs_ncg * sizeof(u_int8_t);
240 fs->fs_contigdirs = (u_int8_t *)space;
241 bzero(fs->fs_contigdirs, size);
247 * Try to read a superblock from the location specified by sblockloc.
248 * Return zero on success or an errno on failure.
251 readsuper(void *devfd, struct fs **fsp, off_t sblockloc, int isaltsblk,
252 int (*readfunc)(void *devfd, off_t loc, void **bufp, int size))
257 error = (*readfunc)(devfd, sblockloc, (void **)fsp, SBLOCKSIZE);
261 if (fs->fs_magic == FS_BAD_MAGIC)
263 if (((fs->fs_magic == FS_UFS1_MAGIC && (isaltsblk ||
264 sblockloc <= SBLOCK_UFS1)) ||
265 (fs->fs_magic == FS_UFS2_MAGIC && (isaltsblk ||
266 sblockloc == fs->fs_sblockloc))) &&
268 fs->fs_bsize >= MINBSIZE &&
269 fs->fs_bsize <= MAXBSIZE &&
270 fs->fs_bsize >= roundup(sizeof(struct fs), DEV_BSIZE)) {
271 /* Have to set for old filesystems that predate this field */
272 fs->fs_sblockactualloc = sblockloc;
273 /* Not yet any summary information */
281 * Write a superblock to the devfd device from the memory pointed to by fs.
282 * Write out the superblock summary information if it is present.
284 * If the write is successful, zero is returned. Otherwise one of the
285 * following error values is returned:
286 * EIO: failed to write superblock.
287 * EIO: failed to write superblock summary information.
290 ffs_sbput(void *devfd, struct fs *fs, off_t loc,
291 int (*writefunc)(void *devfd, off_t loc, void *buf, int size))
293 int i, error, blks, size;
297 * If there is summary information, write it first, so if there
298 * is an error, the superblock will not be marked as clean.
300 if (fs->fs_csp != NULL) {
301 blks = howmany(fs->fs_cssize, fs->fs_fsize);
302 space = (uint8_t *)fs->fs_csp;
303 for (i = 0; i < blks; i += fs->fs_frag) {
305 if (i + fs->fs_frag > blks)
306 size = (blks - i) * fs->fs_fsize;
307 if ((error = (*writefunc)(devfd,
308 dbtob(fsbtodb(fs, fs->fs_csaddr + i)),
315 fs->fs_time = UFS_TIME;
316 if ((error = (*writefunc)(devfd, loc, fs, fs->fs_sbsize)) != 0)
322 * Update the frsum fields to reflect addition or deletion
326 ffs_fragacct(struct fs *fs, int fragmap, int32_t fraglist[], int cnt)
332 inblk = (int)(fragtbl[fs->fs_frag][fragmap]) << 1;
334 for (siz = 1; siz < fs->fs_frag; siz++) {
335 if ((inblk & (1 << (siz + (fs->fs_frag % NBBY)))) == 0)
338 subfield = inside[siz];
339 for (pos = siz; pos <= fs->fs_frag; pos++) {
340 if ((fragmap & field) == subfield) {
341 fraglist[siz] += cnt;
355 * check if a block is available
358 ffs_isblock(struct fs *fs, unsigned char *cp, ufs1_daddr_t h)
362 switch ((int)fs->fs_frag) {
364 return (cp[h] == 0xff);
366 mask = 0x0f << ((h & 0x1) << 2);
367 return ((cp[h >> 1] & mask) == mask);
369 mask = 0x03 << ((h & 0x3) << 1);
370 return ((cp[h >> 2] & mask) == mask);
372 mask = 0x01 << (h & 0x7);
373 return ((cp[h >> 3] & mask) == mask);
376 panic("ffs_isblock");
384 * check if a block is free
387 ffs_isfreeblock(struct fs *fs, u_char *cp, ufs1_daddr_t h)
390 switch ((int)fs->fs_frag) {
394 return ((cp[h >> 1] & (0x0f << ((h & 0x1) << 2))) == 0);
396 return ((cp[h >> 2] & (0x03 << ((h & 0x3) << 1))) == 0);
398 return ((cp[h >> 3] & (0x01 << (h & 0x7))) == 0);
401 panic("ffs_isfreeblock");
409 * take a block out of the map
412 ffs_clrblock(struct fs *fs, u_char *cp, ufs1_daddr_t h)
415 switch ((int)fs->fs_frag) {
420 cp[h >> 1] &= ~(0x0f << ((h & 0x1) << 2));
423 cp[h >> 2] &= ~(0x03 << ((h & 0x3) << 1));
426 cp[h >> 3] &= ~(0x01 << (h & 0x7));
430 panic("ffs_clrblock");
437 * put a block into the map
440 ffs_setblock(struct fs *fs, unsigned char *cp, ufs1_daddr_t h)
443 switch ((int)fs->fs_frag) {
449 cp[h >> 1] |= (0x0f << ((h & 0x1) << 2));
452 cp[h >> 2] |= (0x03 << ((h & 0x3) << 1));
455 cp[h >> 3] |= (0x01 << (h & 0x7));
459 panic("ffs_setblock");
466 * Update the cluster map because of an allocation or free.
468 * Cnt == 1 means free; cnt == -1 means allocating.
471 ffs_clusteracct(struct fs *fs, struct cg *cgp, ufs1_daddr_t blkno, int cnt)
475 u_char *freemapp, *mapp;
476 int i, start, end, forw, back, map;
479 if (fs->fs_contigsumsize <= 0)
481 freemapp = cg_clustersfree(cgp);
482 sump = cg_clustersum(cgp);
484 * Allocate or clear the actual block.
487 setbit(freemapp, blkno);
489 clrbit(freemapp, blkno);
491 * Find the size of the cluster going forward.
494 end = start + fs->fs_contigsumsize;
495 if (end >= cgp->cg_nclusterblks)
496 end = cgp->cg_nclusterblks;
497 mapp = &freemapp[start / NBBY];
499 bit = 1U << (start % NBBY);
500 for (i = start; i < end; i++) {
501 if ((map & bit) == 0)
503 if ((i & (NBBY - 1)) != (NBBY - 1)) {
512 * Find the size of the cluster going backward.
515 end = start - fs->fs_contigsumsize;
518 mapp = &freemapp[start / NBBY];
520 bit = 1U << (start % NBBY);
521 for (i = start; i > end; i--) {
522 if ((map & bit) == 0)
524 if ((i & (NBBY - 1)) != 0) {
528 bit = 1U << (NBBY - 1);
533 * Account for old cluster and the possibly new forward and
537 if (i > fs->fs_contigsumsize)
538 i = fs->fs_contigsumsize;
545 * Update cluster summary information.
547 lp = &sump[fs->fs_contigsumsize];
548 for (i = fs->fs_contigsumsize; i > 0; i--)
551 fs->fs_maxcluster[cgp->cg_cgx] = i;