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