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