1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1982, 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 * @(#)fs.h 8.13 (Berkeley) 3/21/95 32 * $FreeBSD$ 33 */ 34 35 #ifndef _UFS_FFS_FS_H_ 36 #define _UFS_FFS_FS_H_ 37 38 #include <sys/mount.h> 39 #include <ufs/ufs/dinode.h> 40 41 /* 42 * Each disk drive contains some number of filesystems. 43 * A filesystem consists of a number of cylinder groups. 44 * Each cylinder group has inodes and data. 45 * 46 * A filesystem is described by its super-block, which in turn 47 * describes the cylinder groups. The super-block is critical 48 * data and is replicated in each cylinder group to protect against 49 * catastrophic loss. This is done at `newfs' time and the critical 50 * super-block data does not change, so the copies need not be 51 * referenced further unless disaster strikes. 52 * 53 * For filesystem fs, the offsets of the various blocks of interest 54 * are given in the super block as: 55 * [fs->fs_sblkno] Super-block 56 * [fs->fs_cblkno] Cylinder group block 57 * [fs->fs_iblkno] Inode blocks 58 * [fs->fs_dblkno] Data blocks 59 * The beginning of cylinder group cg in fs, is given by 60 * the ``cgbase(fs, cg)'' macro. 61 * 62 * Depending on the architecture and the media, the superblock may 63 * reside in any one of four places. For tiny media where every block 64 * counts, it is placed at the very front of the partition. Historically, 65 * UFS1 placed it 8K from the front to leave room for the disk label and 66 * a small bootstrap. For UFS2 it got moved to 64K from the front to leave 67 * room for the disk label and a bigger bootstrap, and for really piggy 68 * systems we check at 256K from the front if the first three fail. In 69 * all cases the size of the superblock will be SBLOCKSIZE. All values are 70 * given in byte-offset form, so they do not imply a sector size. The 71 * SBLOCKSEARCH specifies the order in which the locations should be searched. 72 */ 73 #define SBLOCK_FLOPPY 0 74 #define SBLOCK_UFS1 8192 75 #define SBLOCK_UFS2 65536 76 #define SBLOCK_PIGGY 262144 77 #define SBLOCKSIZE 8192 78 #define SBLOCKSEARCH \ 79 { SBLOCK_UFS2, SBLOCK_UFS1, SBLOCK_FLOPPY, SBLOCK_PIGGY, -1 } 80 81 /* 82 * Max number of fragments per block. This value is NOT tweakable. 83 */ 84 #define MAXFRAG 8 85 86 /* 87 * Addresses stored in inodes are capable of addressing fragments 88 * of `blocks'. File system blocks of at most size MAXBSIZE can 89 * be optionally broken into 2, 4, or 8 pieces, each of which is 90 * addressable; these pieces may be DEV_BSIZE, or some multiple of 91 * a DEV_BSIZE unit. 92 * 93 * Large files consist of exclusively large data blocks. To avoid 94 * undue wasted disk space, the last data block of a small file may be 95 * allocated as only as many fragments of a large block as are 96 * necessary. The filesystem format retains only a single pointer 97 * to such a fragment, which is a piece of a single large block that 98 * has been divided. The size of such a fragment is determinable from 99 * information in the inode, using the ``blksize(fs, ip, lbn)'' macro. 100 * 101 * The filesystem records space availability at the fragment level; 102 * to determine block availability, aligned fragments are examined. 103 */ 104 105 /* 106 * MINBSIZE is the smallest allowable block size. 107 * In order to insure that it is possible to create files of size 108 * 2^32 with only two levels of indirection, MINBSIZE is set to 4096. 109 * MINBSIZE must be big enough to hold a cylinder group block, 110 * thus changes to (struct cg) must keep its size within MINBSIZE. 111 * Note that super blocks are always of size SBLOCKSIZE, 112 * and that both SBLOCKSIZE and MAXBSIZE must be >= MINBSIZE. 113 */ 114 #define MINBSIZE 4096 115 116 /* 117 * The path name on which the filesystem is mounted is maintained 118 * in fs_fsmnt. MAXMNTLEN defines the amount of space allocated in 119 * the super block for this name. 120 */ 121 #define MAXMNTLEN 468 122 123 /* 124 * The volume name for this filesystem is maintained in fs_volname. 125 * MAXVOLLEN defines the length of the buffer allocated. 126 */ 127 #define MAXVOLLEN 32 128 129 /* 130 * There is a 128-byte region in the superblock reserved for in-core 131 * pointers to summary information. Originally this included an array 132 * of pointers to blocks of struct csum; now there are just a few 133 * pointers and the remaining space is padded with fs_ocsp[]. 134 * 135 * NOCSPTRS determines the size of this padding. One pointer (fs_csp) 136 * is taken away to point to a contiguous array of struct csum for 137 * all cylinder groups; a second (fs_maxcluster) points to an array 138 * of cluster sizes that is computed as cylinder groups are inspected, 139 * and the third points to an array that tracks the creation of new 140 * directories. A fourth pointer, fs_active, is used when creating 141 * snapshots; it points to a bitmap of cylinder groups for which the 142 * free-block bitmap has changed since the snapshot operation began. 143 */ 144 #define NOCSPTRS ((128 / sizeof(void *)) - 4) 145 146 /* 147 * A summary of contiguous blocks of various sizes is maintained 148 * in each cylinder group. Normally this is set by the initial 149 * value of fs_maxcontig. To conserve space, a maximum summary size 150 * is set by FS_MAXCONTIG. 151 */ 152 #define FS_MAXCONTIG 16 153 154 /* 155 * MINFREE gives the minimum acceptable percentage of filesystem 156 * blocks which may be free. If the freelist drops below this level 157 * only the superuser may continue to allocate blocks. This may 158 * be set to 0 if no reserve of free blocks is deemed necessary, 159 * however throughput drops by fifty percent if the filesystem 160 * is run at between 95% and 100% full; thus the minimum default 161 * value of fs_minfree is 5%. However, to get good clustering 162 * performance, 10% is a better choice. hence we use 10% as our 163 * default value. With 10% free space, fragmentation is not a 164 * problem, so we choose to optimize for time. 165 */ 166 #define MINFREE 8 167 #define DEFAULTOPT FS_OPTTIME 168 169 /* 170 * Grigoriy Orlov <gluk@ptci.ru> has done some extensive work to fine 171 * tune the layout preferences for directories within a filesystem. 172 * His algorithm can be tuned by adjusting the following parameters 173 * which tell the system the average file size and the average number 174 * of files per directory. These defaults are well selected for typical 175 * filesystems, but may need to be tuned for odd cases like filesystems 176 * being used for squid caches or news spools. 177 */ 178 #define AVFILESIZ 16384 /* expected average file size */ 179 #define AFPDIR 64 /* expected number of files per directory */ 180 181 /* 182 * The maximum number of snapshot nodes that can be associated 183 * with each filesystem. This limit affects only the number of 184 * snapshot files that can be recorded within the superblock so 185 * that they can be found when the filesystem is mounted. However, 186 * maintaining too many will slow the filesystem performance, so 187 * having this limit is a good idea. 188 */ 189 #define FSMAXSNAP 20 190 191 /* 192 * Used to identify special blocks in snapshots: 193 * 194 * BLK_NOCOPY - A block that was unallocated at the time the snapshot 195 * was taken, hence does not need to be copied when written. 196 * BLK_SNAP - A block held by another snapshot that is not needed by this 197 * snapshot. When the other snapshot is freed, the BLK_SNAP entries 198 * are converted to BLK_NOCOPY. These are needed to allow fsck to 199 * identify blocks that are in use by other snapshots (which are 200 * expunged from this snapshot). 201 */ 202 #define BLK_NOCOPY ((ufs2_daddr_t)(1)) 203 #define BLK_SNAP ((ufs2_daddr_t)(2)) 204 205 /* 206 * Sysctl values for the fast filesystem. 207 */ 208 #define FFS_ADJ_REFCNT 1 /* adjust inode reference count */ 209 #define FFS_ADJ_BLKCNT 2 /* adjust inode used block count */ 210 #define FFS_BLK_FREE 3 /* free range of blocks in map */ 211 #define FFS_DIR_FREE 4 /* free specified dir inodes in map */ 212 #define FFS_FILE_FREE 5 /* free specified file inodes in map */ 213 #define FFS_SET_FLAGS 6 /* set filesystem flags */ 214 #define FFS_ADJ_NDIR 7 /* adjust number of directories */ 215 #define FFS_ADJ_NBFREE 8 /* adjust number of free blocks */ 216 #define FFS_ADJ_NIFREE 9 /* adjust number of free inodes */ 217 #define FFS_ADJ_NFFREE 10 /* adjust number of free frags */ 218 #define FFS_ADJ_NUMCLUSTERS 11 /* adjust number of free clusters */ 219 #define FFS_SET_CWD 12 /* set current directory */ 220 #define FFS_SET_DOTDOT 13 /* set inode number for ".." */ 221 #define FFS_UNLINK 14 /* remove a name in the filesystem */ 222 #define FFS_SET_INODE 15 /* update an on-disk inode */ 223 #define FFS_SET_BUFOUTPUT 16 /* set buffered writing on descriptor */ 224 #define FFS_MAXID 16 /* number of valid ffs ids */ 225 226 /* 227 * Command structure passed in to the filesystem to adjust filesystem values. 228 */ 229 #define FFS_CMD_VERSION 0x19790518 /* version ID */ 230 struct fsck_cmd { 231 int32_t version; /* version of command structure */ 232 int32_t handle; /* reference to filesystem to be changed */ 233 int64_t value; /* inode or block number to be affected */ 234 int64_t size; /* amount or range to be adjusted */ 235 int64_t spare; /* reserved for future use */ 236 }; 237 238 /* 239 * A recovery structure placed at the end of the boot block area by newfs 240 * that can be used by fsck to search for alternate superblocks. 241 */ 242 struct fsrecovery { 243 int32_t fsr_magic; /* magic number */ 244 int32_t fsr_fsbtodb; /* fsbtodb and dbtofsb shift constant */ 245 int32_t fsr_sblkno; /* offset of super-block in filesys */ 246 int32_t fsr_fpg; /* blocks per group * fs_frag */ 247 u_int32_t fsr_ncg; /* number of cylinder groups */ 248 }; 249 250 /* 251 * Per cylinder group information; summarized in blocks allocated 252 * from first cylinder group data blocks. These blocks have to be 253 * read in from fs_csaddr (size fs_cssize) in addition to the 254 * super block. 255 */ 256 struct csum { 257 int32_t cs_ndir; /* number of directories */ 258 int32_t cs_nbfree; /* number of free blocks */ 259 int32_t cs_nifree; /* number of free inodes */ 260 int32_t cs_nffree; /* number of free frags */ 261 }; 262 struct csum_total { 263 int64_t cs_ndir; /* number of directories */ 264 int64_t cs_nbfree; /* number of free blocks */ 265 int64_t cs_nifree; /* number of free inodes */ 266 int64_t cs_nffree; /* number of free frags */ 267 int64_t cs_numclusters; /* number of free clusters */ 268 int64_t cs_spare[3]; /* future expansion */ 269 }; 270 271 /* 272 * Super block for an FFS filesystem. 273 */ 274 struct fs { 275 int32_t fs_firstfield; /* historic filesystem linked list, */ 276 int32_t fs_unused_1; /* used for incore super blocks */ 277 int32_t fs_sblkno; /* offset of super-block in filesys */ 278 int32_t fs_cblkno; /* offset of cyl-block in filesys */ 279 int32_t fs_iblkno; /* offset of inode-blocks in filesys */ 280 int32_t fs_dblkno; /* offset of first data after cg */ 281 int32_t fs_old_cgoffset; /* cylinder group offset in cylinder */ 282 int32_t fs_old_cgmask; /* used to calc mod fs_ntrak */ 283 int32_t fs_old_time; /* last time written */ 284 int32_t fs_old_size; /* number of blocks in fs */ 285 int32_t fs_old_dsize; /* number of data blocks in fs */ 286 u_int32_t fs_ncg; /* number of cylinder groups */ 287 int32_t fs_bsize; /* size of basic blocks in fs */ 288 int32_t fs_fsize; /* size of frag blocks in fs */ 289 int32_t fs_frag; /* number of frags in a block in fs */ 290 /* these are configuration parameters */ 291 int32_t fs_minfree; /* minimum percentage of free blocks */ 292 int32_t fs_old_rotdelay; /* num of ms for optimal next block */ 293 int32_t fs_old_rps; /* disk revolutions per second */ 294 /* these fields can be computed from the others */ 295 int32_t fs_bmask; /* ``blkoff'' calc of blk offsets */ 296 int32_t fs_fmask; /* ``fragoff'' calc of frag offsets */ 297 int32_t fs_bshift; /* ``lblkno'' calc of logical blkno */ 298 int32_t fs_fshift; /* ``numfrags'' calc number of frags */ 299 /* these are configuration parameters */ 300 int32_t fs_maxcontig; /* max number of contiguous blks */ 301 int32_t fs_maxbpg; /* max number of blks per cyl group */ 302 /* these fields can be computed from the others */ 303 int32_t fs_fragshift; /* block to frag shift */ 304 int32_t fs_fsbtodb; /* fsbtodb and dbtofsb shift constant */ 305 int32_t fs_sbsize; /* actual size of super block */ 306 int32_t fs_spare1[2]; /* old fs_csmask */ 307 /* old fs_csshift */ 308 int32_t fs_nindir; /* value of NINDIR */ 309 u_int32_t fs_inopb; /* value of INOPB */ 310 int32_t fs_old_nspf; /* value of NSPF */ 311 /* yet another configuration parameter */ 312 int32_t fs_optim; /* optimization preference, see below */ 313 int32_t fs_old_npsect; /* # sectors/track including spares */ 314 int32_t fs_old_interleave; /* hardware sector interleave */ 315 int32_t fs_old_trackskew; /* sector 0 skew, per track */ 316 int32_t fs_id[2]; /* unique filesystem id */ 317 /* sizes determined by number of cylinder groups and their sizes */ 318 int32_t fs_old_csaddr; /* blk addr of cyl grp summary area */ 319 int32_t fs_cssize; /* size of cyl grp summary area */ 320 int32_t fs_cgsize; /* cylinder group size */ 321 int32_t fs_spare2; /* old fs_ntrak */ 322 int32_t fs_old_nsect; /* sectors per track */ 323 int32_t fs_old_spc; /* sectors per cylinder */ 324 int32_t fs_old_ncyl; /* cylinders in filesystem */ 325 int32_t fs_old_cpg; /* cylinders per group */ 326 u_int32_t fs_ipg; /* inodes per group */ 327 int32_t fs_fpg; /* blocks per group * fs_frag */ 328 /* this data must be re-computed after crashes */ 329 struct csum fs_old_cstotal; /* cylinder summary information */ 330 /* these fields are cleared at mount time */ 331 int8_t fs_fmod; /* super block modified flag */ 332 int8_t fs_clean; /* filesystem is clean flag */ 333 int8_t fs_ronly; /* mounted read-only flag */ 334 int8_t fs_old_flags; /* old FS_ flags */ 335 u_char fs_fsmnt[MAXMNTLEN]; /* name mounted on */ 336 u_char fs_volname[MAXVOLLEN]; /* volume name */ 337 u_int64_t fs_swuid; /* system-wide uid */ 338 int32_t fs_pad; /* due to alignment of fs_swuid */ 339 /* these fields retain the current block allocation info */ 340 int32_t fs_cgrotor; /* last cg searched */ 341 void *fs_ocsp[NOCSPTRS]; /* padding; was list of fs_cs buffers */ 342 u_int8_t *fs_contigdirs; /* (u) # of contig. allocated dirs */ 343 struct csum *fs_csp; /* (u) cg summary info buffer */ 344 int32_t *fs_maxcluster; /* (u) max cluster in each cyl group */ 345 u_int *fs_active; /* (u) used by snapshots to track fs */ 346 int32_t fs_old_cpc; /* cyl per cycle in postbl */ 347 int32_t fs_maxbsize; /* maximum blocking factor permitted */ 348 int64_t fs_unrefs; /* number of unreferenced inodes */ 349 int64_t fs_providersize; /* size of underlying GEOM provider */ 350 int64_t fs_metaspace; /* size of area reserved for metadata */ 351 int64_t fs_sparecon64[13]; /* old rotation block list head */ 352 int64_t fs_sblockactualloc; /* byte offset of this superblock */ 353 int64_t fs_sblockloc; /* byte offset of standard superblock */ 354 struct csum_total fs_cstotal; /* (u) cylinder summary information */ 355 ufs_time_t fs_time; /* last time written */ 356 int64_t fs_size; /* number of blocks in fs */ 357 int64_t fs_dsize; /* number of data blocks in fs */ 358 ufs2_daddr_t fs_csaddr; /* blk addr of cyl grp summary area */ 359 int64_t fs_pendingblocks; /* (u) blocks being freed */ 360 u_int32_t fs_pendinginodes; /* (u) inodes being freed */ 361 uint32_t fs_snapinum[FSMAXSNAP];/* list of snapshot inode numbers */ 362 u_int32_t fs_avgfilesize; /* expected average file size */ 363 u_int32_t fs_avgfpdir; /* expected # of files per directory */ 364 int32_t fs_save_cgsize; /* save real cg size to use fs_bsize */ 365 ufs_time_t fs_mtime; /* Last mount or fsck time. */ 366 int32_t fs_sujfree; /* SUJ free list */ 367 int32_t fs_sparecon32[22]; /* reserved for future constants */ 368 u_int32_t fs_metackhash; /* metadata check-hash, see CK_ below */ 369 int32_t fs_flags; /* see FS_ flags below */ 370 int32_t fs_contigsumsize; /* size of cluster summary array */ 371 int32_t fs_maxsymlinklen; /* max length of an internal symlink */ 372 int32_t fs_old_inodefmt; /* format of on-disk inodes */ 373 u_int64_t fs_maxfilesize; /* maximum representable file size */ 374 int64_t fs_qbmask; /* ~fs_bmask for use with 64-bit size */ 375 int64_t fs_qfmask; /* ~fs_fmask for use with 64-bit size */ 376 int32_t fs_state; /* validate fs_clean field */ 377 int32_t fs_old_postblformat; /* format of positional layout tables */ 378 int32_t fs_old_nrpos; /* number of rotational positions */ 379 int32_t fs_spare5[2]; /* old fs_postbloff */ 380 /* old fs_rotbloff */ 381 int32_t fs_magic; /* magic number */ 382 }; 383 384 /* Sanity checking. */ 385 #ifdef CTASSERT 386 CTASSERT(sizeof(struct fs) == 1376); 387 #endif 388 389 /* 390 * Filesystem identification 391 */ 392 #define FS_UFS1_MAGIC 0x011954 /* UFS1 fast filesystem magic number */ 393 #define FS_UFS2_MAGIC 0x19540119 /* UFS2 fast filesystem magic number */ 394 #define FS_BAD_MAGIC 0x19960408 /* UFS incomplete newfs magic number */ 395 #define FS_42INODEFMT -1 /* 4.2BSD inode format */ 396 #define FS_44INODEFMT 2 /* 4.4BSD inode format */ 397 398 /* 399 * Preference for optimization. 400 */ 401 #define FS_OPTTIME 0 /* minimize allocation time */ 402 #define FS_OPTSPACE 1 /* minimize disk fragmentation */ 403 404 /* 405 * Filesystem flags. 406 * 407 * The FS_UNCLEAN flag is set by the kernel when the filesystem was 408 * mounted with fs_clean set to zero. The FS_DOSOFTDEP flag indicates 409 * that the filesystem should be managed by the soft updates code. 410 * Note that the FS_NEEDSFSCK flag is set and cleared only by the 411 * fsck utility. It is set when background fsck finds an unexpected 412 * inconsistency which requires a traditional foreground fsck to be 413 * run. Such inconsistencies should only be found after an uncorrectable 414 * disk error. A foreground fsck will clear the FS_NEEDSFSCK flag when 415 * it has successfully cleaned up the filesystem. The kernel uses this 416 * flag to enforce that inconsistent filesystems be mounted read-only. 417 * The FS_INDEXDIRS flag when set indicates that the kernel maintains 418 * on-disk auxiliary indexes (such as B-trees) for speeding directory 419 * accesses. Kernels that do not support auxiliary indices clear the 420 * flag to indicate that the indices need to be rebuilt (by fsck) before 421 * they can be used. When a filesystem is mounted, any flags not 422 * included in FS_SUPPORTED are cleared. This lets newer features 423 * know that the filesystem has been run on an older version of the 424 * filesystem and thus that data structures associated with those 425 * features are out-of-date and need to be rebuilt. 426 * 427 * FS_ACLS indicates that POSIX.1e ACLs are administratively enabled 428 * for the file system, so they should be loaded from extended attributes, 429 * observed for access control purposes, and be administered by object 430 * owners. FS_NFS4ACLS indicates that NFSv4 ACLs are administratively 431 * enabled. This flag is mutually exclusive with FS_ACLS. FS_MULTILABEL 432 * indicates that the TrustedBSD MAC Framework should attempt to back MAC 433 * labels into extended attributes on the file system rather than maintain 434 * a single mount label for all objects. 435 */ 436 #define FS_UNCLEAN 0x0001 /* filesystem not clean at mount */ 437 #define FS_DOSOFTDEP 0x0002 /* filesystem using soft dependencies */ 438 #define FS_NEEDSFSCK 0x0004 /* filesystem needs sync fsck before mount */ 439 #define FS_SUJ 0x0008 /* Filesystem using softupdate journal */ 440 #define FS_ACLS 0x0010 /* file system has POSIX.1e ACLs enabled */ 441 #define FS_MULTILABEL 0x0020 /* file system is MAC multi-label */ 442 #define FS_GJOURNAL 0x0040 /* gjournaled file system */ 443 #define FS_FLAGS_UPDATED 0x0080 /* flags have been moved to new location */ 444 #define FS_NFS4ACLS 0x0100 /* file system has NFSv4 ACLs enabled */ 445 #define FS_INDEXDIRS 0x0200 /* kernel supports indexed directories */ 446 #define FS_TRIM 0x0400 /* issue BIO_DELETE for deleted blocks */ 447 #define FS_SUPPORTED 0xFFFF /* supported flags, others cleared at mount */ 448 449 /* 450 * The fs_metackhash field indicates the types of metadata check-hash 451 * that are maintained for a filesystem. Not all filesystems check-hash 452 * all metadata. 453 */ 454 #define CK_SUPERBLOCK 0x0001 /* the superblock */ 455 #define CK_CYLGRP 0x0002 /* the cylinder groups */ 456 #define CK_INODE 0x0004 /* inodes */ 457 #define CK_INDIR 0x0008 /* indirect blocks */ 458 #define CK_DIR 0x0010 /* directory contents */ 459 /* 460 * The BX_FSPRIV buffer b_xflags are used to track types of data in buffers. 461 */ 462 #define BX_SUPERBLOCK 0x00010000 /* superblock */ 463 #define BX_CYLGRP 0x00020000 /* cylinder groups */ 464 #define BX_INODE 0x00040000 /* inodes */ 465 #define BX_INDIR 0x00080000 /* indirect blocks */ 466 #define BX_DIR 0x00100000 /* directory contents */ 467 468 #define PRINT_UFS_BUF_XFLAGS "\20\25dir\24indir\23inode\22cylgrp\21superblock" 469 470 /* 471 * Macros to access bits in the fs_active array. 472 */ 473 #define ACTIVECGNUM(fs, cg) ((fs)->fs_active[(cg) / (NBBY * sizeof(int))]) 474 #define ACTIVECGOFF(cg) (1 << ((cg) % (NBBY * sizeof(int)))) 475 #define ACTIVESET(fs, cg) do { \ 476 if ((fs)->fs_active) \ 477 ACTIVECGNUM((fs), (cg)) |= ACTIVECGOFF((cg)); \ 478 } while (0) 479 #define ACTIVECLEAR(fs, cg) do { \ 480 if ((fs)->fs_active) \ 481 ACTIVECGNUM((fs), (cg)) &= ~ACTIVECGOFF((cg)); \ 482 } while (0) 483 484 /* 485 * The size of a cylinder group is calculated by CGSIZE. The maximum size 486 * is limited by the fact that cylinder groups are at most one block. 487 * Its size is derived from the size of the maps maintained in the 488 * cylinder group and the (struct cg) size. 489 */ 490 #define CGSIZE(fs) \ 491 /* base cg */ (sizeof(struct cg) + sizeof(int32_t) + \ 492 /* old btotoff */ (fs)->fs_old_cpg * sizeof(int32_t) + \ 493 /* old boff */ (fs)->fs_old_cpg * sizeof(u_int16_t) + \ 494 /* inode map */ howmany((fs)->fs_ipg, NBBY) + \ 495 /* block map */ howmany((fs)->fs_fpg, NBBY) +\ 496 /* if present */ ((fs)->fs_contigsumsize <= 0 ? 0 : \ 497 /* cluster sum */ (fs)->fs_contigsumsize * sizeof(int32_t) + \ 498 /* cluster map */ howmany(fragstoblks(fs, (fs)->fs_fpg), NBBY))) 499 500 /* 501 * The minimal number of cylinder groups that should be created. 502 */ 503 #define MINCYLGRPS 4 504 505 /* 506 * Convert cylinder group to base address of its global summary info. 507 */ 508 #define fs_cs(fs, indx) fs_csp[indx] 509 510 /* 511 * Cylinder group block for a filesystem. 512 */ 513 #define CG_MAGIC 0x090255 514 struct cg { 515 int32_t cg_firstfield; /* historic cyl groups linked list */ 516 int32_t cg_magic; /* magic number */ 517 int32_t cg_old_time; /* time last written */ 518 u_int32_t cg_cgx; /* we are the cgx'th cylinder group */ 519 int16_t cg_old_ncyl; /* number of cyl's this cg */ 520 int16_t cg_old_niblk; /* number of inode blocks this cg */ 521 u_int32_t cg_ndblk; /* number of data blocks this cg */ 522 struct csum cg_cs; /* cylinder summary information */ 523 u_int32_t cg_rotor; /* position of last used block */ 524 u_int32_t cg_frotor; /* position of last used frag */ 525 u_int32_t cg_irotor; /* position of last used inode */ 526 u_int32_t cg_frsum[MAXFRAG]; /* counts of available frags */ 527 int32_t cg_old_btotoff; /* (int32) block totals per cylinder */ 528 int32_t cg_old_boff; /* (u_int16) free block positions */ 529 u_int32_t cg_iusedoff; /* (u_int8) used inode map */ 530 u_int32_t cg_freeoff; /* (u_int8) free block map */ 531 u_int32_t cg_nextfreeoff; /* (u_int8) next available space */ 532 u_int32_t cg_clustersumoff; /* (u_int32) counts of avail clusters */ 533 u_int32_t cg_clusteroff; /* (u_int8) free cluster map */ 534 u_int32_t cg_nclusterblks; /* number of clusters this cg */ 535 u_int32_t cg_niblk; /* number of inode blocks this cg */ 536 u_int32_t cg_initediblk; /* last initialized inode */ 537 u_int32_t cg_unrefs; /* number of unreferenced inodes */ 538 int32_t cg_sparecon32[1]; /* reserved for future use */ 539 u_int32_t cg_ckhash; /* check-hash of this cg */ 540 ufs_time_t cg_time; /* time last written */ 541 int64_t cg_sparecon64[3]; /* reserved for future use */ 542 u_int8_t cg_space[1]; /* space for cylinder group maps */ 543 /* actually longer */ 544 }; 545 546 /* 547 * Macros for access to cylinder group array structures 548 */ 549 #define cg_chkmagic(cgp) ((cgp)->cg_magic == CG_MAGIC) 550 #define cg_inosused(cgp) \ 551 ((u_int8_t *)((u_int8_t *)(cgp) + (cgp)->cg_iusedoff)) 552 #define cg_blksfree(cgp) \ 553 ((u_int8_t *)((u_int8_t *)(cgp) + (cgp)->cg_freeoff)) 554 #define cg_clustersfree(cgp) \ 555 ((u_int8_t *)((u_int8_t *)(cgp) + (cgp)->cg_clusteroff)) 556 #define cg_clustersum(cgp) \ 557 ((int32_t *)((uintptr_t)(cgp) + (cgp)->cg_clustersumoff)) 558 559 /* 560 * Turn filesystem block numbers into disk block addresses. 561 * This maps filesystem blocks to device size blocks. 562 */ 563 #define fsbtodb(fs, b) ((daddr_t)(b) << (fs)->fs_fsbtodb) 564 #define dbtofsb(fs, b) ((b) >> (fs)->fs_fsbtodb) 565 566 /* 567 * Cylinder group macros to locate things in cylinder groups. 568 * They calc filesystem addresses of cylinder group data structures. 569 */ 570 #define cgbase(fs, c) (((ufs2_daddr_t)(fs)->fs_fpg) * (c)) 571 #define cgdata(fs, c) (cgdmin(fs, c) + (fs)->fs_metaspace) /* data zone */ 572 #define cgmeta(fs, c) (cgdmin(fs, c)) /* meta data */ 573 #define cgdmin(fs, c) (cgstart(fs, c) + (fs)->fs_dblkno) /* 1st data */ 574 #define cgimin(fs, c) (cgstart(fs, c) + (fs)->fs_iblkno) /* inode blk */ 575 #define cgsblock(fs, c) (cgstart(fs, c) + (fs)->fs_sblkno) /* super blk */ 576 #define cgtod(fs, c) (cgstart(fs, c) + (fs)->fs_cblkno) /* cg block */ 577 #define cgstart(fs, c) \ 578 ((fs)->fs_magic == FS_UFS2_MAGIC ? cgbase(fs, c) : \ 579 (cgbase(fs, c) + (fs)->fs_old_cgoffset * ((c) & ~((fs)->fs_old_cgmask)))) 580 581 /* 582 * Macros for handling inode numbers: 583 * inode number to filesystem block offset. 584 * inode number to cylinder group number. 585 * inode number to filesystem block address. 586 */ 587 #define ino_to_cg(fs, x) (((ino_t)(x)) / (fs)->fs_ipg) 588 #define ino_to_fsba(fs, x) \ 589 ((ufs2_daddr_t)(cgimin(fs, ino_to_cg(fs, (ino_t)(x))) + \ 590 (blkstofrags((fs), ((((ino_t)(x)) % (fs)->fs_ipg) / INOPB(fs)))))) 591 #define ino_to_fsbo(fs, x) (((ino_t)(x)) % INOPB(fs)) 592 593 /* 594 * Give cylinder group number for a filesystem block. 595 * Give cylinder group block number for a filesystem block. 596 */ 597 #define dtog(fs, d) ((d) / (fs)->fs_fpg) 598 #define dtogd(fs, d) ((d) % (fs)->fs_fpg) 599 600 /* 601 * Extract the bits for a block from a map. 602 * Compute the cylinder and rotational position of a cyl block addr. 603 */ 604 #define blkmap(fs, map, loc) \ 605 (((map)[(loc) / NBBY] >> ((loc) % NBBY)) & (0xff >> (NBBY - (fs)->fs_frag))) 606 607 /* 608 * The following macros optimize certain frequently calculated 609 * quantities by using shifts and masks in place of divisions 610 * modulos and multiplications. 611 */ 612 #define blkoff(fs, loc) /* calculates (loc % fs->fs_bsize) */ \ 613 ((loc) & (fs)->fs_qbmask) 614 #define fragoff(fs, loc) /* calculates (loc % fs->fs_fsize) */ \ 615 ((loc) & (fs)->fs_qfmask) 616 #define lfragtosize(fs, frag) /* calculates ((off_t)frag * fs->fs_fsize) */ \ 617 (((off_t)(frag)) << (fs)->fs_fshift) 618 #define lblktosize(fs, blk) /* calculates ((off_t)blk * fs->fs_bsize) */ \ 619 (((off_t)(blk)) << (fs)->fs_bshift) 620 /* Use this only when `blk' is known to be small, e.g., < UFS_NDADDR. */ 621 #define smalllblktosize(fs, blk) /* calculates (blk * fs->fs_bsize) */ \ 622 ((blk) << (fs)->fs_bshift) 623 #define lblkno(fs, loc) /* calculates (loc / fs->fs_bsize) */ \ 624 ((loc) >> (fs)->fs_bshift) 625 #define numfrags(fs, loc) /* calculates (loc / fs->fs_fsize) */ \ 626 ((loc) >> (fs)->fs_fshift) 627 #define blkroundup(fs, size) /* calculates roundup(size, fs->fs_bsize) */ \ 628 (((size) + (fs)->fs_qbmask) & (fs)->fs_bmask) 629 #define fragroundup(fs, size) /* calculates roundup(size, fs->fs_fsize) */ \ 630 (((size) + (fs)->fs_qfmask) & (fs)->fs_fmask) 631 #define fragstoblks(fs, frags) /* calculates (frags / fs->fs_frag) */ \ 632 ((frags) >> (fs)->fs_fragshift) 633 #define blkstofrags(fs, blks) /* calculates (blks * fs->fs_frag) */ \ 634 ((blks) << (fs)->fs_fragshift) 635 #define fragnum(fs, fsb) /* calculates (fsb % fs->fs_frag) */ \ 636 ((fsb) & ((fs)->fs_frag - 1)) 637 #define blknum(fs, fsb) /* calculates rounddown(fsb, fs->fs_frag) */ \ 638 ((fsb) &~ ((fs)->fs_frag - 1)) 639 640 /* 641 * Determine the number of available frags given a 642 * percentage to hold in reserve. 643 */ 644 #define freespace(fs, percentreserved) \ 645 (blkstofrags((fs), (fs)->fs_cstotal.cs_nbfree) + \ 646 (fs)->fs_cstotal.cs_nffree - \ 647 (((off_t)((fs)->fs_dsize)) * (percentreserved) / 100)) 648 649 /* 650 * Determining the size of a file block in the filesystem. 651 */ 652 #define blksize(fs, ip, lbn) \ 653 (((lbn) >= UFS_NDADDR || (ip)->i_size >= \ 654 (uint64_t)smalllblktosize(fs, (lbn) + 1)) \ 655 ? (fs)->fs_bsize \ 656 : (fragroundup(fs, blkoff(fs, (ip)->i_size)))) 657 #define sblksize(fs, size, lbn) \ 658 (((lbn) >= UFS_NDADDR || (size) >= ((lbn) + 1) << (fs)->fs_bshift) \ 659 ? (fs)->fs_bsize \ 660 : (fragroundup(fs, blkoff(fs, (size))))) 661 662 /* 663 * Number of indirects in a filesystem block. 664 */ 665 #define NINDIR(fs) ((fs)->fs_nindir) 666 667 /* 668 * Indirect lbns are aligned on UFS_NDADDR addresses where single indirects 669 * are the negated address of the lowest lbn reachable, double indirects 670 * are this lbn - 1 and triple indirects are this lbn - 2. This yields 671 * an unusual bit order to determine level. 672 */ 673 static inline int 674 lbn_level(ufs_lbn_t lbn) 675 { 676 if (lbn >= 0) 677 return 0; 678 switch (lbn & 0x3) { 679 case 0: 680 return (0); 681 case 1: 682 break; 683 case 2: 684 return (2); 685 case 3: 686 return (1); 687 default: 688 break; 689 } 690 return (-1); 691 } 692 693 static inline ufs_lbn_t 694 lbn_offset(struct fs *fs, int level) 695 { 696 ufs_lbn_t res; 697 698 for (res = 1; level > 0; level--) 699 res *= NINDIR(fs); 700 return (res); 701 } 702 703 /* 704 * Number of inodes in a secondary storage block/fragment. 705 */ 706 #define INOPB(fs) ((fs)->fs_inopb) 707 #define INOPF(fs) ((fs)->fs_inopb >> (fs)->fs_fragshift) 708 709 /* 710 * Softdep journal record format. 711 */ 712 713 #define JOP_ADDREF 1 /* Add a reference to an inode. */ 714 #define JOP_REMREF 2 /* Remove a reference from an inode. */ 715 #define JOP_NEWBLK 3 /* Allocate a block. */ 716 #define JOP_FREEBLK 4 /* Free a block or a tree of blocks. */ 717 #define JOP_MVREF 5 /* Move a reference from one off to another. */ 718 #define JOP_TRUNC 6 /* Partial truncation record. */ 719 #define JOP_SYNC 7 /* fsync() complete record. */ 720 721 #define JREC_SIZE 32 /* Record and segment header size. */ 722 723 #define SUJ_MIN (4 * 1024 * 1024) /* Minimum journal size */ 724 #define SUJ_MAX (32 * 1024 * 1024) /* Maximum journal size */ 725 #define SUJ_FILE ".sujournal" /* Journal file name */ 726 727 /* 728 * Size of the segment record header. There is at most one for each disk 729 * block in the journal. The segment header is followed by an array of 730 * records. fsck depends on the first element in each record being 'op' 731 * and the second being 'ino'. Segments may span multiple disk blocks but 732 * the header is present on each. 733 */ 734 struct jsegrec { 735 uint64_t jsr_seq; /* Our sequence number */ 736 uint64_t jsr_oldest; /* Oldest valid sequence number */ 737 uint16_t jsr_cnt; /* Count of valid records */ 738 uint16_t jsr_blocks; /* Count of device bsize blocks. */ 739 uint32_t jsr_crc; /* 32bit crc of the valid space */ 740 ufs_time_t jsr_time; /* timestamp for mount instance */ 741 }; 742 743 /* 744 * Reference record. Records a single link count modification. 745 */ 746 struct jrefrec { 747 uint32_t jr_op; 748 uint32_t jr_ino; 749 uint32_t jr_parent; 750 uint16_t jr_nlink; 751 uint16_t jr_mode; 752 int64_t jr_diroff; 753 uint64_t jr_unused; 754 }; 755 756 /* 757 * Move record. Records a reference moving within a directory block. The 758 * nlink is unchanged but we must search both locations. 759 */ 760 struct jmvrec { 761 uint32_t jm_op; 762 uint32_t jm_ino; 763 uint32_t jm_parent; 764 uint16_t jm_unused; 765 int64_t jm_oldoff; 766 int64_t jm_newoff; 767 }; 768 769 /* 770 * Block record. A set of frags or tree of blocks starting at an indirect are 771 * freed or a set of frags are allocated. 772 */ 773 struct jblkrec { 774 uint32_t jb_op; 775 uint32_t jb_ino; 776 ufs2_daddr_t jb_blkno; 777 ufs_lbn_t jb_lbn; 778 uint16_t jb_frags; 779 uint16_t jb_oldfrags; 780 uint32_t jb_unused; 781 }; 782 783 /* 784 * Truncation record. Records a partial truncation so that it may be 785 * completed at check time. Also used for sync records. 786 */ 787 struct jtrncrec { 788 uint32_t jt_op; 789 uint32_t jt_ino; 790 int64_t jt_size; 791 uint32_t jt_extsize; 792 uint32_t jt_pad[3]; 793 }; 794 795 union jrec { 796 struct jsegrec rec_jsegrec; 797 struct jrefrec rec_jrefrec; 798 struct jmvrec rec_jmvrec; 799 struct jblkrec rec_jblkrec; 800 struct jtrncrec rec_jtrncrec; 801 }; 802 803 #ifdef CTASSERT 804 CTASSERT(sizeof(struct jsegrec) == JREC_SIZE); 805 CTASSERT(sizeof(struct jrefrec) == JREC_SIZE); 806 CTASSERT(sizeof(struct jmvrec) == JREC_SIZE); 807 CTASSERT(sizeof(struct jblkrec) == JREC_SIZE); 808 CTASSERT(sizeof(struct jtrncrec) == JREC_SIZE); 809 CTASSERT(sizeof(union jrec) == JREC_SIZE); 810 #endif 811 812 extern int inside[], around[]; 813 extern u_char *fragtbl[]; 814 815 /* 816 * IOCTLs used for filesystem write suspension. 817 */ 818 #define UFSSUSPEND _IOW('U', 1, fsid_t) 819 #define UFSRESUME _IO('U', 2) 820 821 #endif 822