fs.h revision 1.35
1 /* $NetBSD: fs.h,v 1.35 2003/09/29 20:34:23 dbj Exp $ */ 2 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 */ 33 34 #ifndef _UFS_FFS_FS_H_ 35 #define _UFS_FFS_FS_H_ 36 37 /* 38 * Each disk drive contains some number of file systems. 39 * A file system consists of a number of cylinder groups. 40 * Each cylinder group has inodes and data. 41 * 42 * A file system is described by its super-block, which in turn 43 * describes the cylinder groups. The super-block is critical 44 * data and is replicated in each cylinder group to protect against 45 * catastrophic loss. This is done at `newfs' time and the critical 46 * super-block data does not change, so the copies need not be 47 * referenced further unless disaster strikes. 48 * 49 * For file system fs, the offsets of the various blocks of interest 50 * are given in the super block as: 51 * [fs->fs_sblkno] Super-block 52 * [fs->fs_cblkno] Cylinder group block 53 * [fs->fs_iblkno] Inode blocks 54 * [fs->fs_dblkno] Data blocks 55 * The beginning of cylinder group cg in fs, is given by 56 * the ``cgbase(fs, cg)'' macro. 57 * 58 * Depending on the architecture and the media, the superblock may 59 * reside in any one of four places. For tiny media where every block 60 * counts, it is placed at the very front of the partition. Historically, 61 * UFS1 placed it 8K from the front to leave room for the disk label and 62 * a small bootstrap. For UFS2 it got moved to 64K from the front to leave 63 * room for the disk label and a bigger bootstrap, and for really piggy 64 * systems we check at 256K from the front if the first three fail. In 65 * all cases the size of the superblock will be SBLOCKSIZE. All values are 66 * given in byte-offset form, so they do not imply a sector size. The 67 * SBLOCKSEARCH specifies the order in which the locations should be searched. 68 * 69 */ 70 #define BBSIZE 8192 71 #define BBOFF ((off_t)(0)) 72 #define BBLOCK ((daddr_t)(0)) 73 74 #define SBLOCK_FLOPPY 0 75 #define SBLOCK_UFS1 8192 76 #define SBLOCK_UFS2 65536 77 #define SBLOCK_PIGGY 262144 78 #define SBLOCKSIZE 8192 79 #define SBLOCKSEARCH \ 80 { SBLOCK_UFS2, SBLOCK_UFS1, SBLOCK_FLOPPY, SBLOCK_PIGGY, -1 } 81 82 /* 83 * Max number of fragments per block. This value is NOT tweakable. 84 */ 85 #define MAXFRAG 8 86 87 88 89 /* 90 * Addresses stored in inodes are capable of addressing fragments 91 * of `blocks'. File system blocks of at most size MAXBSIZE can 92 * be optionally broken into 2, 4, or 8 pieces, each of which is 93 * addressable; these pieces may be DEV_BSIZE, or some multiple of 94 * a DEV_BSIZE unit. 95 * 96 * Large files consist of exclusively large data blocks. To avoid 97 * undue wasted disk space, the last data block of a small file may be 98 * allocated as only as many fragments of a large block as are 99 * necessary. The file system format retains only a single pointer 100 * to such a fragment, which is a piece of a single large block that 101 * has been divided. The size of such a fragment is determinable from 102 * information in the inode, using the ``blksize(fs, ip, lbn)'' macro. 103 * 104 * The file system records space availability at the fragment level; 105 * to determine block availability, aligned fragments are examined. 106 */ 107 108 /* 109 * MINBSIZE is the smallest allowable block size. 110 * In order to insure that it is possible to create files of size 111 * 2^32 with only two levels of indirection, MINBSIZE is set to 4096. 112 * MINBSIZE must be big enough to hold a cylinder group block, 113 * thus changes to (struct cg) must keep its size within MINBSIZE. 114 * Note that super blocks are always of size SBSIZE, 115 * and that both SBSIZE and MAXBSIZE must be >= MINBSIZE. 116 */ 117 #define MINBSIZE 4096 118 119 /* 120 * The path name on which the file system is mounted is maintained 121 * in fs_fsmnt. MAXMNTLEN defines the amount of space allocated in 122 * the super block for this name. 123 */ 124 #define MAXMNTLEN 468 125 126 /* 127 * The volume name for this filesystem is maintained in fs_volname. 128 * MAXVOLLEN defines the length of the buffer allocated. 129 */ 130 #define MAXVOLLEN 32 131 132 /* 133 * There is a 128-byte region in the superblock reserved for in-core 134 * pointers to summary information. Originally this included an array 135 * of pointers to blocks of struct csum; now there are just three 136 * pointers and the remaining space is padded with fs_ocsp[]. 137 * NOCSPTRS determines the size of this padding. One pointer (fs_csp) 138 * is taken away to point to a contiguous array of struct csum for 139 * all cylinder groups; a second (fs_maxcluster) points to an array 140 * of cluster sizes that is computed as cylinder groups are inspected; 141 * and the third points to an array that tracks the creation of new 142 * directories. 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 * Unused value currently, FreeBSD compat. 156 */ 157 #define FSMAXSNAP 20 158 159 /* 160 * MINFREE gives the minimum acceptable percentage of file system 161 * blocks which may be free. If the freelist drops below this level 162 * only the superuser may continue to allocate blocks. This may 163 * be set to 0 if no reserve of free blocks is deemed necessary, 164 * however throughput drops by fifty percent if the file system 165 * is run at between 95% and 100% full; thus the minimum default 166 * value of fs_minfree is 5%. However, to get good clustering 167 * performance, 10% is a better choice. hence we use 10% as our 168 * default value. With 10% free space, fragmentation is not a 169 * problem, so we choose to optimize for time. 170 */ 171 #define MINFREE 5 172 #define DEFAULTOPT FS_OPTTIME 173 174 /* 175 * Grigoriy Orlov <gluk (at) ptci.ru> has done some extensive work to fine 176 * tune the layout preferences for directories within a filesystem. 177 * His algorithm can be tuned by adjusting the following parameters 178 * which tell the system the average file size and the average number 179 * of files per directory. These defaults are well selected for typical 180 * filesystems, but may need to be tuned for odd cases like filesystems 181 * being used for squid caches or news spools. 182 */ 183 #define AVFILESIZ 16384 /* expected average file size */ 184 #define AFPDIR 64 /* expected number of files per directory */ 185 186 /* 187 * Per cylinder group information; summarized in blocks allocated 188 * from first cylinder group data blocks. These blocks have to be 189 * read in from fs_csaddr (size fs_cssize) in addition to the 190 * super block. 191 */ 192 struct csum { 193 int32_t cs_ndir; /* number of directories */ 194 int32_t cs_nbfree; /* number of free blocks */ 195 int32_t cs_nifree; /* number of free inodes */ 196 int32_t cs_nffree; /* number of free frags */ 197 }; 198 199 struct csum_total { 200 int64_t cs_ndir; /* number of directories */ 201 int64_t cs_nbfree; /* number of free blocks */ 202 int64_t cs_nifree; /* number of free inodes */ 203 int64_t cs_nffree; /* number of free frags */ 204 int64_t cs_numclusters; /* number of free clusters */ 205 int64_t cs_spare[3]; /* future expansion */ 206 }; 207 208 209 /* 210 * Super block for an FFS file system in memory. 211 */ 212 struct fs { 213 int32_t fs_firstfield; /* historic file system linked list, */ 214 int32_t fs_unused_1; /* used for incore super blocks */ 215 int32_t fs_sblkno; /* addr of super-block in filesys */ 216 int32_t fs_cblkno; /* offset of cyl-block in filesys */ 217 int32_t fs_iblkno; /* offset of inode-blocks in filesys */ 218 int32_t fs_dblkno; /* offset of first data after cg */ 219 int32_t fs_old_cgoffset; /* cylinder group offset in cylinder */ 220 int32_t fs_old_cgmask; /* used to calc mod fs_ntrak */ 221 int32_t fs_old_time; /* last time written */ 222 int32_t fs_old_size; /* number of blocks in fs */ 223 int32_t fs_old_dsize; /* number of data blocks in fs */ 224 int32_t fs_ncg; /* number of cylinder groups */ 225 int32_t fs_bsize; /* size of basic blocks in fs */ 226 int32_t fs_fsize; /* size of frag blocks in fs */ 227 int32_t fs_frag; /* number of frags in a block in fs */ 228 /* these are configuration parameters */ 229 int32_t fs_minfree; /* minimum percentage of free blocks */ 230 int32_t fs_old_rotdelay; /* num of ms for optimal next block */ 231 int32_t fs_old_rps; /* disk revolutions per second */ 232 /* these fields can be computed from the others */ 233 int32_t fs_bmask; /* ``blkoff'' calc of blk offsets */ 234 int32_t fs_fmask; /* ``fragoff'' calc of frag offsets */ 235 int32_t fs_bshift; /* ``lblkno'' calc of logical blkno */ 236 int32_t fs_fshift; /* ``numfrags'' calc number of frags */ 237 /* these are configuration parameters */ 238 int32_t fs_maxcontig; /* max number of contiguous blks */ 239 int32_t fs_maxbpg; /* max number of blks per cyl group */ 240 /* these fields can be computed from the others */ 241 int32_t fs_fragshift; /* block to frag shift */ 242 int32_t fs_fsbtodb; /* fsbtodb and dbtofsb shift constant */ 243 int32_t fs_sbsize; /* actual size of super block */ 244 int32_t fs_spare1[2]; /* old fs_csmask */ 245 /* old fs_csshift */ 246 int32_t fs_nindir; /* value of NINDIR */ 247 int32_t fs_inopb; /* value of INOPB */ 248 int32_t fs_old_nspf; /* value of NSPF */ 249 /* yet another configuration parameter */ 250 int32_t fs_optim; /* optimization preference, see below */ 251 /* these fields are derived from the hardware */ 252 int32_t fs_old_npsect; /* # sectors/track including spares */ 253 int32_t fs_old_interleave; /* hardware sector interleave */ 254 int32_t fs_old_trackskew; /* sector 0 skew, per track */ 255 /* fs_id takes the space of the unused fs_headswitch and fs_trkseek fields */ 256 int32_t fs_id[2]; /* unique file system id */ 257 /* sizes determined by number of cylinder groups and their sizes */ 258 int32_t fs_old_csaddr; /* blk addr of cyl grp summary area */ 259 int32_t fs_cssize; /* size of cyl grp summary area */ 260 int32_t fs_cgsize; /* cylinder group size */ 261 /* these fields are derived from the hardware */ 262 int32_t fs_spare2; /* old fs_ntrak */ 263 int32_t fs_old_nsect; /* sectors per track */ 264 int32_t fs_old_spc; /* sectors per cylinder */ 265 int32_t fs_old_ncyl; /* cylinders in file system */ 266 int32_t fs_old_cpg; /* cylinders per group */ 267 int32_t fs_ipg; /* inodes per group */ 268 int32_t fs_fpg; /* blocks per group * fs_frag */ 269 /* this data must be re-computed after crashes */ 270 struct csum fs_old_cstotal; /* cylinder summary information */ 271 /* these fields are cleared at mount time */ 272 int8_t fs_fmod; /* super block modified flag */ 273 int8_t fs_clean; /* file system is clean flag */ 274 int8_t fs_ronly; /* mounted read-only flag */ 275 uint8_t fs_old_flags; /* see FS_ flags below */ 276 u_char fs_fsmnt[MAXMNTLEN]; /* name mounted on */ 277 u_char fs_volname[MAXVOLLEN]; /* volume name */ 278 uint64_t fs_swuid; /* system-wide uid */ 279 int32_t fs_pad; 280 /* these fields retain the current block allocation info */ 281 int32_t fs_cgrotor; /* last cg searched (UNUSED) */ 282 void *fs_ocsp[NOCSPTRS]; /* padding; was list of fs_cs buffers */ 283 u_int8_t *fs_contigdirs; /* # of contiguously allocated dirs */ 284 struct csum *fs_csp; /* cg summary info buffer for fs_cs */ 285 int32_t *fs_maxcluster; /* max cluster in each cyl group */ 286 u_int *fs_active; /* used by snapshots to track fs */ 287 int32_t fs_old_cpc; /* cyl per cycle in postbl */ 288 int32_t fs_maxbsize; /* maximum blocking factor permitted */ 289 int64_t fs_sparecon64[17]; /* old rotation block list head */ 290 int64_t fs_sblockloc; /* byte offset of standard superblock */ 291 struct csum_total fs_cstotal; /* cylinder summary information */ 292 int64_t fs_time; /* last time written */ 293 int64_t fs_size; /* number of blocks in fs */ 294 int64_t fs_dsize; /* number of data blocks in fs */ 295 int64_t fs_csaddr; /* blk addr of cyl grp summary area */ 296 int64_t fs_pendingblocks; /* blocks in process of being freed */ 297 int32_t fs_pendinginodes; /* inodes in process of being freed */ 298 int32_t fs_snapinum[FSMAXSNAP];/* list of snapshot inode numbers */ 299 int32_t fs_avgfilesize; /* expected average file size */ 300 int32_t fs_avgfpdir; /* expected # of files per directory */ 301 int32_t fs_save_cgsize; /* save real cg size to use fs_bsize */ 302 int32_t fs_sparecon32[26]; /* reserved for future constants */ 303 uint32_t fs_flags; /* see FS_ flags below */ 304 int32_t fs_contigsumsize; /* size of cluster summary array */ 305 int32_t fs_maxsymlinklen; /* max length of an internal symlink */ 306 int32_t fs_old_inodefmt; /* format of on-disk inodes */ 307 u_int64_t fs_maxfilesize; /* maximum representable file size */ 308 int64_t fs_qbmask; /* ~fs_bmask for use with 64-bit size */ 309 int64_t fs_qfmask; /* ~fs_fmask for use with 64-bit size */ 310 int32_t fs_state; /* validate fs_clean field (UNUSED) */ 311 int32_t fs_old_postblformat; /* format of positional layout tables */ 312 int32_t fs_old_nrpos; /* number of rotational positions */ 313 int32_t fs_spare5[2]; /* old fs_postbloff */ 314 /* old fs_rotbloff */ 315 int32_t fs_magic; /* magic number */ 316 }; 317 318 #define fs_old_postbloff fs_spare5[0] 319 #define fs_old_rotbloff fs_spare5[1] 320 #define fs_old_postbl_start fs_maxbsize 321 322 #define FS_42POSTBLFMT -1 /* 4.2BSD rotational table format */ 323 #define FS_DYNAMICPOSTBLFMT 1 /* dynamic rotational table format */ 324 325 /* 326 * File system identification 327 */ 328 #define FS_UFS1_MAGIC 0x011954 /* UFS1 fast file system magic number */ 329 #define FS_UFS2_MAGIC 0x19540119 /* UFS2 fast file system magic number */ 330 #define FS_UFS1_MAGIC_SWAPPED 0x54190100 331 #define FS_UFS2_MAGIC_SWAPPED 0x19015419 332 #define FS_OKAY 0x7c269d38 /* superblock checksum */ 333 #define FS_42INODEFMT -1 /* 4.2BSD inode format */ 334 #define FS_44INODEFMT 2 /* 4.4BSD inode format */ 335 336 /* 337 * File system clean flags 338 */ 339 #define FS_ISCLEAN 0x01 340 #define FS_WASCLEAN 0x02 341 342 /* 343 * Preference for optimization. 344 */ 345 #define FS_OPTTIME 0 /* minimize allocation time */ 346 #define FS_OPTSPACE 1 /* minimize disk fragmentation */ 347 348 /* 349 * File system flags 350 */ 351 #define FS_UNCLEAN 0x01 /* file system not clean at mount (unused) */ 352 #define FS_DOSOFTDEP 0x02 /* file system using soft dependencies */ 353 #define FS_NEEDSFSCK 0x04 /* needs sync fsck (FreeBSD compat, unused) */ 354 #define FS_INDEXDIRS 0x08 /* kernel supports indexed directories */ 355 #define FS_ACLS 0x10 /* file system has ACLs enabled */ 356 #define FS_MULTILABEL 0x20 /* file system is MAC multi-label */ 357 #define FS_FLAGS_UPDATED 0x80 /* flags have been moved to new location */ 358 359 /* 360 * File system internal flags, also in fs_flags. 361 * (Pick highest number to avoid conflicts with others) 362 */ 363 #define FS_SWAPPED 0x80000000 /* file system is endian swapped */ 364 #define FS_INTERNAL 0x80000000 /* mask for internal flags */ 365 366 /* 367 * The size of a cylinder group is calculated by CGSIZE. The maximum size 368 * is limited by the fact that cylinder groups are at most one block. 369 * Its size is derived from the size of the maps maintained in the 370 * cylinder group and the (struct cg) size. 371 */ 372 #define CGSIZE_IF(fs, ipg, fpg) \ 373 /* base cg */ (sizeof(struct cg) + sizeof(int32_t) + \ 374 /* old btotoff */ (fs)->fs_old_cpg * sizeof(int32_t) + \ 375 /* old boff */ (fs)->fs_old_cpg * sizeof(u_int16_t) + \ 376 /* inode map */ howmany((ipg), NBBY) + \ 377 /* block map */ howmany((fpg), NBBY) +\ 378 /* if present */ ((fs)->fs_contigsumsize <= 0 ? 0 : \ 379 /* cluster sum */ (fs)->fs_contigsumsize * sizeof(int32_t) + \ 380 /* cluster map */ howmany(fragstoblks(fs, (fpg)), NBBY))) 381 382 #define CGSIZE(fs) CGSIZE_IF((fs), (fs)->fs_ipg, (fs)->fs_fpg) 383 384 /* 385 * The minimal number of cylinder groups that should be created. 386 */ 387 #define MINCYLGRPS 4 388 389 390 /* 391 * Convert cylinder group to base address of its global summary info. 392 */ 393 #define fs_cs(fs, indx) fs_csp[indx] 394 395 /* 396 * Cylinder group block for a file system. 397 */ 398 #define CG_MAGIC 0x090255 399 struct cg { 400 int32_t cg_firstfield; /* historic cyl groups linked list */ 401 int32_t cg_magic; /* magic number */ 402 int32_t cg_old_time; /* time last written */ 403 int32_t cg_cgx; /* we are the cgx'th cylinder group */ 404 int16_t cg_old_ncyl; /* number of cyl's this cg */ 405 int16_t cg_old_niblk; /* number of inode blocks this cg */ 406 int32_t cg_ndblk; /* number of data blocks this cg */ 407 struct csum cg_cs; /* cylinder summary information */ 408 int32_t cg_rotor; /* position of last used block */ 409 int32_t cg_frotor; /* position of last used frag */ 410 int32_t cg_irotor; /* position of last used inode */ 411 int32_t cg_frsum[MAXFRAG]; /* counts of available frags */ 412 int32_t cg_old_btotoff; /* (int32) block totals per cylinder */ 413 int32_t cg_old_boff; /* (u_int16) free block positions */ 414 int32_t cg_iusedoff; /* (u_int8) used inode map */ 415 int32_t cg_freeoff; /* (u_int8) free block map */ 416 int32_t cg_nextfreeoff; /* (u_int8) next available space */ 417 int32_t cg_clustersumoff; /* (u_int32) counts of avail clusters */ 418 int32_t cg_clusteroff; /* (u_int8) free cluster map */ 419 int32_t cg_nclusterblks; /* number of clusters this cg */ 420 int32_t cg_niblk; /* number of inode blocks this cg */ 421 int32_t cg_initediblk; /* last initialized inode */ 422 int32_t cg_sparecon32[3]; /* reserved for future use */ 423 int64_t cg_time; /* time last written */ 424 int64_t cg_sparecon64[3]; /* reserved for future use */ 425 u_int8_t cg_space[1]; /* space for cylinder group maps */ 426 /* actually longer */ 427 }; 428 429 /* 430 * The following structure is defined 431 * for compatibility with old file systems. 432 */ 433 struct ocg { 434 int32_t cg_firstfield; /* historic linked list of cyl groups */ 435 int32_t cg_unused_1; /* used for incore cyl groups */ 436 int32_t cg_time; /* time last written */ 437 int32_t cg_cgx; /* we are the cgx'th cylinder group */ 438 int16_t cg_ncyl; /* number of cyl's this cg */ 439 int16_t cg_niblk; /* number of inode blocks this cg */ 440 int32_t cg_ndblk; /* number of data blocks this cg */ 441 struct csum cg_cs; /* cylinder summary information */ 442 int32_t cg_rotor; /* position of last used block */ 443 int32_t cg_frotor; /* position of last used frag */ 444 int32_t cg_irotor; /* position of last used inode */ 445 int32_t cg_frsum[8]; /* counts of available frags */ 446 int32_t cg_btot[32]; /* block totals per cylinder */ 447 int16_t cg_b[32][8]; /* positions of free blocks */ 448 u_int8_t cg_iused[256]; /* used inode map */ 449 int32_t cg_magic; /* magic number */ 450 u_int8_t cg_free[1]; /* free block map */ 451 /* actually longer */ 452 }; 453 454 455 /* 456 * Macros for access to cylinder group array structures. 457 */ 458 #define cg_inosused_new(cgp, ns) \ 459 ((u_int8_t *)((u_int8_t *)(cgp) + \ 460 ufs_rw32((cgp)->cg_iusedoff, (ns)))) 461 #define cg_blksfree_new(cgp, ns) \ 462 ((u_int8_t *)((u_int8_t *)(cgp) + \ 463 ufs_rw32((cgp)->cg_freeoff, (ns)))) 464 #define cg_chkmagic_new(cgp, ns) \ 465 (ufs_rw32((cgp)->cg_magic, (ns)) == CG_MAGIC) 466 467 #define cg_inosused_old(cgp, ns) \ 468 (((struct ocg *)(cgp))->cg_iused) 469 #define cg_blksfree_old(cgp, ns) \ 470 (((struct ocg *)(cgp))->cg_free) 471 #define cg_chkmagic_old(cgp, ns) \ 472 (ufs_rw32(((struct ocg *)(cgp))->cg_magic, (ns)) == CG_MAGIC) 473 474 #define cg_inosused(cgp, ns) \ 475 ((ufs_rw32((cgp)->cg_magic, (ns)) != CG_MAGIC) ? \ 476 cg_inosused_old(cgp, ns) : cg_inosused_new(cgp, ns)) 477 #define cg_blksfree(cgp, ns) \ 478 ((ufs_rw32((cgp)->cg_magic, (ns)) != CG_MAGIC) ? \ 479 cg_blksfree_old(cgp, ns) : cg_blksfree_new(cgp, ns)) 480 #define cg_chkmagic(cgp, ns) \ 481 (cg_chkmagic_new(cgp, ns) || cg_chkmagic_old(cgp, ns)) 482 483 #define cg_clustersfree(cgp, ns) \ 484 ((u_int8_t *)((u_int8_t *)(cgp) + \ 485 ufs_rw32((cgp)->cg_clusteroff, (ns)))) 486 #define cg_clustersum(cgp, ns) \ 487 ((int32_t *)((u_int8_t *)(cgp) + \ 488 ufs_rw32((cgp)->cg_clustersumoff, (ns)))) 489 490 491 /* 492 * Turn file system block numbers into disk block addresses. 493 * This maps file system blocks to device size blocks. 494 */ 495 #define fsbtodb(fs, b) ((b) << (fs)->fs_fsbtodb) 496 #define dbtofsb(fs, b) ((b) >> (fs)->fs_fsbtodb) 497 498 /* 499 * Cylinder group macros to locate things in cylinder groups. 500 * They calc file system addresses of cylinder group data structures. 501 */ 502 #define cgbase(fs, c) (((daddr_t)(fs)->fs_fpg) * (c)) 503 #define cgstart_ufs1(fs, c) \ 504 (cgbase(fs, c) + (fs)->fs_old_cgoffset * ((c) & ~((fs)->fs_old_cgmask))) 505 #define cgstart_ufs2(fs, c) cgbase((fs), (c)) 506 #define cgstart(fs, c) ((fs)->fs_magic == FS_UFS2_MAGIC \ 507 ? cgstart_ufs2((fs), (c)) : cgstart_ufs1((fs), (c))) 508 #define cgdmin(fs, c) (cgstart(fs, c) + (fs)->fs_dblkno) /* 1st data */ 509 #define cgimin(fs, c) (cgstart(fs, c) + (fs)->fs_iblkno) /* inode blk */ 510 #define cgsblock(fs, c) (cgstart(fs, c) + (fs)->fs_sblkno) /* super blk */ 511 #define cgtod(fs, c) (cgstart(fs, c) + (fs)->fs_cblkno) /* cg block */ 512 513 /* 514 * Macros for handling inode numbers: 515 * inode number to file system block offset. 516 * inode number to cylinder group number. 517 * inode number to file system block address. 518 */ 519 #define ino_to_cg(fs, x) ((x) / (fs)->fs_ipg) 520 #define ino_to_fsba(fs, x) \ 521 ((daddr_t)(cgimin(fs, ino_to_cg(fs, x)) + \ 522 (blkstofrags((fs), (((x) % (fs)->fs_ipg) / INOPB(fs)))))) 523 #define ino_to_fsbo(fs, x) ((x) % INOPB(fs)) 524 525 /* 526 * Give cylinder group number for a file system block. 527 * Give cylinder group block number for a file system block. 528 */ 529 #define dtog(fs, d) ((d) / (fs)->fs_fpg) 530 #define dtogd(fs, d) ((d) % (fs)->fs_fpg) 531 532 /* 533 * Extract the bits for a block from a map. 534 * Compute the cylinder and rotational position of a cyl block addr. 535 */ 536 #define blkmap(fs, map, loc) \ 537 (((map)[(loc) / NBBY] >> ((loc) % NBBY)) & (0xff >> (NBBY - (fs)->fs_frag))) 538 539 /* 540 * The following macros optimize certain frequently calculated 541 * quantities by using shifts and masks in place of divisions 542 * modulos and multiplications. 543 */ 544 #define blkoff(fs, loc) /* calculates (loc % fs->fs_bsize) */ \ 545 ((loc) & (fs)->fs_qbmask) 546 #define fragoff(fs, loc) /* calculates (loc % fs->fs_fsize) */ \ 547 ((loc) & (fs)->fs_qfmask) 548 #define lfragtosize(fs, frag) /* calculates ((off_t)frag * fs->fs_fsize) */ \ 549 (((off_t)(frag)) << (fs)->fs_fshift) 550 #define lblktosize(fs, blk) /* calculates ((off_t)blk * fs->fs_bsize) */ \ 551 (((off_t)(blk)) << (fs)->fs_bshift) 552 #define lblkno(fs, loc) /* calculates (loc / fs->fs_bsize) */ \ 553 ((loc) >> (fs)->fs_bshift) 554 #define numfrags(fs, loc) /* calculates (loc / fs->fs_fsize) */ \ 555 ((loc) >> (fs)->fs_fshift) 556 #define blkroundup(fs, size) /* calculates roundup(size, fs->fs_bsize) */ \ 557 (((size) + (fs)->fs_qbmask) & (fs)->fs_bmask) 558 #define fragroundup(fs, size) /* calculates roundup(size, fs->fs_fsize) */ \ 559 (((size) + (fs)->fs_qfmask) & (fs)->fs_fmask) 560 #define fragstoblks(fs, frags) /* calculates (frags / fs->fs_frag) */ \ 561 ((frags) >> (fs)->fs_fragshift) 562 #define blkstofrags(fs, blks) /* calculates (blks * fs->fs_frag) */ \ 563 ((blks) << (fs)->fs_fragshift) 564 #define fragnum(fs, fsb) /* calculates (fsb % fs->fs_frag) */ \ 565 ((fsb) & ((fs)->fs_frag - 1)) 566 #define blknum(fs, fsb) /* calculates rounddown(fsb, fs->fs_frag) */ \ 567 ((fsb) &~ ((fs)->fs_frag - 1)) 568 569 /* 570 * Determine the number of available frags given a 571 * percentage to hold in reserve. 572 */ 573 #define freespace(fs, percentreserved) \ 574 (blkstofrags((fs), (fs)->fs_cstotal.cs_nbfree) + \ 575 (fs)->fs_cstotal.cs_nffree - \ 576 (((off_t)((fs)->fs_dsize)) * (percentreserved) / 100)) 577 578 /* 579 * Determining the size of a file block in the file system. 580 */ 581 #define blksize(fs, ip, lbn) \ 582 (((lbn) >= NDADDR || (ip)->i_size >= lblktosize(fs, (lbn) + 1)) \ 583 ? (fs)->fs_bsize \ 584 : (fragroundup(fs, blkoff(fs, (ip)->i_size)))) 585 586 #define sblksize(fs, size, lbn) \ 587 (((lbn) >= NDADDR || (size) >= ((lbn) + 1) << (fs)->fs_bshift) \ 588 ? (fs)->fs_bsize \ 589 : (fragroundup(fs, blkoff(fs, (size))))) 590 591 592 /* 593 * Number of inodes in a secondary storage block/fragment. 594 */ 595 #define INOPB(fs) ((fs)->fs_inopb) 596 #define INOPF(fs) ((fs)->fs_inopb >> (fs)->fs_fragshift) 597 598 /* 599 * Number of indirects in a file system block. 600 */ 601 #define NINDIR(fs) ((fs)->fs_nindir) 602 603 /* 604 * Apple UFS Label: 605 * We check for this to decide to use APPLEUFS_DIRBLKSIZ 606 */ 607 #define APPLEUFS_LABEL_MAGIC 0x4c41424c /* LABL */ 608 #define APPLEUFS_LABEL_SIZE 1024 609 #define APPLEUFS_LABEL_OFFSET (BBSIZE - APPLEUFS_LABEL_SIZE) /* located at 7k */ 610 #define APPLEUFS_LABEL_VERSION 1 611 #define APPLEUFS_MAX_LABEL_NAME 512 612 613 struct appleufslabel { 614 u_int32_t ul_magic; 615 u_int16_t ul_checksum; 616 u_int32_t ul_version; 617 u_int32_t ul_time; 618 u_int16_t ul_namelen; 619 u_char ul_name[APPLEUFS_MAX_LABEL_NAME]; 620 u_char ul_reserved[32]; 621 u_char ul_unused[460]; 622 }; 623 624 625 #endif /* !_UFS_FFS_FS_H_ */ 626
Indexes created Thu Oct 02 14:10:14 GMT 2025