Home | History | Annotate | Line # | Download | only in lfs
lfs.h revision 1.28
      1 /*	$NetBSD: lfs.h,v 1.28 2000/07/04 22:30:37 perseant Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1999 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Konrad E. Schroder <perseant (at) hhhh.org>.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *      This product includes software developed by the NetBSD
     21  *      Foundation, Inc. and its contributors.
     22  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  *    contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  * POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 /*-
     39  * Copyright (c) 1991, 1993
     40  *	The Regents of the University of California.  All rights reserved.
     41  *
     42  * Redistribution and use in source and binary forms, with or without
     43  * modification, are permitted provided that the following conditions
     44  * are met:
     45  * 1. Redistributions of source code must retain the above copyright
     46  *    notice, this list of conditions and the following disclaimer.
     47  * 2. Redistributions in binary form must reproduce the above copyright
     48  *    notice, this list of conditions and the following disclaimer in the
     49  *    documentation and/or other materials provided with the distribution.
     50  * 3. All advertising materials mentioning features or use of this software
     51  *    must display the following acknowledgement:
     52  *	This product includes software developed by the University of
     53  *	California, Berkeley and its contributors.
     54  * 4. Neither the name of the University nor the names of its contributors
     55  *    may be used to endorse or promote products derived from this software
     56  *    without specific prior written permission.
     57  *
     58  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     59  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     60  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     61  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     62  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     63  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     64  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     65  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     66  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     67  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     68  * SUCH DAMAGE.
     69  *
     70  *	@(#)lfs.h	8.9 (Berkeley) 5/8/95
     71  */
     72 
     73 /*
     74  * Compile-time options for LFS.
     75  */
     76 #define LFS_EAGAIN_FAIL          /* markv fail with EAGAIN if ino is locked */
     77 #define LFS_TRACK_IOS            /* attempt to avoid cleaning segments not yet fully written to disk */
     78 #define LFS_CANNOT_ROLLFW       /* No roll-forward agent exists */
     79 
     80 /* #define DEBUG_LFS */              /* Intensive debugging of LFS subsystem */
     81 
     82 /* #define LFS_ATIME_IFILE */         /* Store atime in Ifile, don't push */
     83 
     84 /*
     85  * Parameters and generic definitions
     86  */
     87 #define BW_CLEAN	1
     88 #define MIN_FREE_SEGS	2
     89 #define LFS_MAX_ACTIVE	10
     90 #define LFS_MAXDIROP	(desiredvnodes>>2)
     91 
     92 /* For convenience */
     93 #define IN_ALLMOD (IN_MODIFIED|IN_ACCESS|IN_CHANGE|IN_UPDATE|IN_ACCESSED|IN_CLEANING)
     94 
     95 #ifndef LFS_ATIME_IFILE
     96 # define LFS_ITIMES(ip, acc, mod, cre) FFS_ITIMES((ip),(acc),(mod),(cre))
     97 #else
     98 # define LFS_ITIMES(ip, acc, mod, cre) {                                \
     99 	struct buf *ibp;						\
    100 	IFILE *ifp;							\
    101 									\
    102         if ((ip)->i_flag & IN_ACCESS) {                         	\
    103 	LFS_IENTRY(ifp, ip->i_lfs, ip->i_number, ibp);			\
    104        		ifp->if_atime = (mod);					\
    105        		VOP_BWRITE(bp);						\
    106 		(ip)->i_flag &= ~IN_ACCESS;				\
    107         }                                                       	\
    108         if ((ip)->i_flag & (IN_CHANGE | IN_UPDATE)) {       		\
    109                 (ip)->i_flag |= IN_MODIFIED;                            \
    110                 if ((ip)->i_flag & IN_UPDATE) {                         \
    111                         (ip)->i_ffs_mtime = (mod)->tv_sec;		\
    112                         (ip)->i_ffs_mtimensec = (mod)->tv_nsec;         \
    113                         (ip)->i_modrev++;                               \
    114                 }                                                       \
    115                 if ((ip)->i_flag & IN_CHANGE) {                         \
    116                         (ip)->i_ffs_ctime = (cre)->tv_sec;		\
    117                         (ip)->i_ffs_ctimensec = (cre)->tv_nsec;         \
    118                 }                                                       \
    119                 (ip)->i_flag &= ~(IN_CHANGE | IN_UPDATE);   		\
    120         }                                                               \
    121 }
    122 #endif
    123 
    124 #define WRITEINPROG(vp) (vp->v_dirtyblkhd.lh_first && !(VTOI(vp)->i_flag & (IN_MODIFIED|IN_ACCESSED|IN_CLEANING)))
    125 
    126 /* Here begins the berkeley code */
    127 
    128 #define	LFS_LABELPAD	8192		/* LFS label size */
    129 #define	LFS_SBPAD	8192		/* LFS superblock size */
    130 
    131 /* On-disk and in-memory checkpoint segment usage structure. */
    132 typedef struct segusage SEGUSE;
    133 struct segusage {
    134 	u_int32_t su_nbytes;		/* number of live bytes */
    135 	u_int32_t su_lastmod;		/* SEGUSE last modified timestamp */
    136 	u_int16_t su_nsums;		/* number of summaries in segment */
    137 	u_int16_t su_ninos;		/* number of inode blocks in seg */
    138 
    139 #define	SEGUSE_ACTIVE		0x01	/* segment is currently being written */
    140 #define	SEGUSE_DIRTY		0x02	/* segment has data in it */
    141 #define	SEGUSE_SUPERBLOCK	0x04	/* segment contains a superblock */
    142 	u_int32_t su_flags;
    143 };
    144 
    145 #define	SEGUPB(fs)	(1 << (fs)->lfs_sushift)
    146 #define	SEGTABSIZE_SU(fs)						\
    147 	(((fs)->lfs_nseg + SEGUPB(fs) - 1) >> (fs)->lfs_sushift)
    148 
    149 /* On-disk file information.  One per file with data blocks in the segment. */
    150 typedef struct finfo FINFO;
    151 struct finfo {
    152 	u_int32_t fi_nblocks;		/* number of blocks */
    153 	u_int32_t fi_version;		/* version number */
    154 	u_int32_t fi_ino;		/* inode number */
    155 	u_int32_t fi_lastlength;	/* length of last block in array */
    156 	ufs_daddr_t	  fi_blocks[1];		/* array of logical block numbers */
    157 };
    158 
    159 /* On-disk super block. */
    160 struct dlfs {
    161 #define	LFS_MAGIC	0x070162
    162         u_int32_t dlfs_magic;     /* 0: magic number */
    163 #define	LFS_VERSION	1
    164         u_int32_t dlfs_version;   /* 4: version number */
    165 
    166         u_int32_t dlfs_size;      /* 8: number of blocks in fs */
    167         u_int32_t dlfs_ssize;     /* 12: number of blocks per segment */
    168         u_int32_t dlfs_dsize;     /* 16: number of disk blocks in fs */
    169         u_int32_t dlfs_bsize;     /* 20: file system block size */
    170         u_int32_t dlfs_fsize;     /* 24: size of frag blocks in fs */
    171         u_int32_t dlfs_frag;      /* 28: number of frags in a block in fs */
    172 
    173 /* Checkpoint region. */
    174         u_int32_t dlfs_free;      /* 32: start of the free list */
    175         u_int32_t dlfs_bfree;     /* 36: number of free disk blocks */
    176         u_int32_t dlfs_nfiles;    /* 40: number of allocated inodes */
    177         int32_t   dlfs_avail;     /* 44: blocks available for writing */
    178         u_int32_t dlfs_uinodes;   /* 48: inodes in cache not yet on disk */
    179         ufs_daddr_t  dlfs_idaddr; /* 52: inode file disk address */
    180         u_int32_t dlfs_ifile;     /* 56: inode file inode number */
    181         ufs_daddr_t  dlfs_lastseg; /* 60: address of last segment written */
    182         ufs_daddr_t  dlfs_nextseg; /* 64: address of next segment to write */
    183         ufs_daddr_t  dlfs_curseg; /* 68: current segment being written */
    184         ufs_daddr_t  dlfs_offset; /* 72: offset in curseg for next partial */
    185         ufs_daddr_t  dlfs_lastpseg; /* 76: address of last partial written */
    186         u_int32_t dlfs_tstamp;    /* 80: time stamp */
    187 
    188 /* These are configuration parameters. */
    189         u_int32_t dlfs_minfree;   /* 84: minimum percentage of free blocks */
    190 
    191 /* These fields can be computed from the others. */
    192         u_int64_t dlfs_maxfilesize; /* 88: maximum representable file size */
    193         u_int32_t dlfs_dbpseg;    /* 96: disk blocks per segment */
    194         u_int32_t dlfs_inopb;     /* 100: inodes per block */
    195         u_int32_t dlfs_ifpb;      /* 104: IFILE entries per block */
    196         u_int32_t dlfs_sepb;      /* 108: SEGUSE entries per block */
    197         u_int32_t dlfs_nindir;    /* 112: indirect pointers per block */
    198         u_int32_t dlfs_nseg;      /* 116: number of segments */
    199         u_int32_t dlfs_nspf;      /* 120: number of sectors per fragment */
    200         u_int32_t dlfs_cleansz;   /* 124: cleaner info size in blocks */
    201         u_int32_t dlfs_segtabsz;  /* 128: segment table size in blocks */
    202         u_int32_t dlfs_segmask;   /* 132: calculate offset within a segment */
    203         u_int32_t dlfs_segshift;  /* 136: fast mult/div for segments */
    204         u_int32_t dlfs_bshift;    /* 140: calc block number from file offset */
    205         u_int32_t dlfs_ffshift;   /* 144: fast mult/div for frag from file */
    206         u_int32_t dlfs_fbshift;   /* 148: fast mult/div for frag from block */
    207         u_int64_t dlfs_bmask;     /* 152: calc block offset from file offset */
    208         u_int64_t dlfs_ffmask;    /* 160: calc frag offset from file offset */
    209         u_int64_t dlfs_fbmask;    /* 168: calc frag offset from block offset */
    210         u_int32_t dlfs_fsbtodb;   /* 176: fsbtodb and dbtofsb shift constant */
    211         u_int32_t dlfs_sushift;   /* 180: fast mult/div for segusage table */
    212 
    213         int32_t   dlfs_maxsymlinklen; /* 184: max length of an internal symlink */
    214 
    215 #define	LFS_MIN_SBINTERVAL	5  /* minimum superblock segment spacing */
    216 #define LFS_MAXNUMSB            10 /* 188: superblock disk offsets */
    217         ufs_daddr_t       dlfs_sboffs[LFS_MAXNUMSB];
    218 
    219 	u_int32_t dlfs_nclean;    /* 228: Number of clean segments */
    220 	u_char	  dlfs_fsmnt[MNAMELEN];	 /* 232: name mounted on */
    221 	/* XXX this is 2 bytes only to pad to a quad boundary */
    222 	u_int16_t dlfs_clean;     /* 322: file system is clean flag */
    223 	u_int32_t dlfs_dmeta;     /* 324: total number of dirty summaries */
    224 	u_int32_t dlfs_minfreeseg; /* 328: segs reserved for cleaner */
    225         int8_t    dlfs_pad[176];  /* 332: round to 512 bytes */
    226 /* Checksum -- last valid disk field. */
    227         u_int32_t dlfs_cksum;     /* 508: checksum for superblock checking */
    228 };
    229 
    230 /* Maximum number of io's we can have pending at once */
    231 #define LFS_THROTTLE  16 /* XXX should be better paramtrized - ? */
    232 
    233 /* In-memory super block. */
    234 struct lfs {
    235         struct dlfs lfs_dlfs;           /* on-disk parameters */
    236 #define lfs_magic lfs_dlfs.dlfs_magic
    237 #define lfs_version lfs_dlfs.dlfs_version
    238 #define lfs_size lfs_dlfs.dlfs_size
    239 #define lfs_ssize lfs_dlfs.dlfs_ssize
    240 #define lfs_dsize lfs_dlfs.dlfs_dsize
    241 #define lfs_bsize lfs_dlfs.dlfs_bsize
    242 #define lfs_fsize lfs_dlfs.dlfs_fsize
    243 #define lfs_frag lfs_dlfs.dlfs_frag
    244 #define lfs_free lfs_dlfs.dlfs_free
    245 #define lfs_bfree lfs_dlfs.dlfs_bfree
    246 #define lfs_nfiles lfs_dlfs.dlfs_nfiles
    247 #define lfs_avail lfs_dlfs.dlfs_avail
    248 #define lfs_uinodes lfs_dlfs.dlfs_uinodes
    249 #define lfs_idaddr lfs_dlfs.dlfs_idaddr
    250 #define lfs_ifile lfs_dlfs.dlfs_ifile
    251 #define lfs_lastseg lfs_dlfs.dlfs_lastseg
    252 #define lfs_nextseg lfs_dlfs.dlfs_nextseg
    253 #define lfs_curseg lfs_dlfs.dlfs_curseg
    254 #define lfs_offset lfs_dlfs.dlfs_offset
    255 #define lfs_lastpseg lfs_dlfs.dlfs_lastpseg
    256 #define lfs_tstamp lfs_dlfs.dlfs_tstamp
    257 #define lfs_minfree lfs_dlfs.dlfs_minfree
    258 #define lfs_maxfilesize lfs_dlfs.dlfs_maxfilesize
    259 #define lfs_dbpseg lfs_dlfs.dlfs_dbpseg
    260 #define lfs_inopb lfs_dlfs.dlfs_inopb
    261 #define lfs_ifpb lfs_dlfs.dlfs_ifpb
    262 #define lfs_sepb lfs_dlfs.dlfs_sepb
    263 #define lfs_nindir lfs_dlfs.dlfs_nindir
    264 #define lfs_nseg lfs_dlfs.dlfs_nseg
    265 #define lfs_nspf lfs_dlfs.dlfs_nspf
    266 #define lfs_cleansz lfs_dlfs.dlfs_cleansz
    267 #define lfs_segtabsz lfs_dlfs.dlfs_segtabsz
    268 #define lfs_segmask lfs_dlfs.dlfs_segmask
    269 #define lfs_segshift lfs_dlfs.dlfs_segshift
    270 #define lfs_bmask lfs_dlfs.dlfs_bmask
    271 #define lfs_bshift lfs_dlfs.dlfs_bshift
    272 #define lfs_ffmask lfs_dlfs.dlfs_ffmask
    273 #define lfs_ffshift lfs_dlfs.dlfs_ffshift
    274 #define lfs_fbmask lfs_dlfs.dlfs_fbmask
    275 #define lfs_fbshift lfs_dlfs.dlfs_fbshift
    276 #define lfs_fsbtodb lfs_dlfs.dlfs_fsbtodb
    277 #define lfs_sushift lfs_dlfs.dlfs_sushift
    278 #define lfs_maxsymlinklen lfs_dlfs.dlfs_maxsymlinklen
    279 #define lfs_sboffs lfs_dlfs.dlfs_sboffs
    280 #define lfs_cksum lfs_dlfs.dlfs_cksum
    281 #define lfs_clean lfs_dlfs.dlfs_clean
    282 #define lfs_fsmnt lfs_dlfs.dlfs_fsmnt
    283 #define lfs_nclean lfs_dlfs.dlfs_nclean
    284 #define lfs_dmeta lfs_dlfs.dlfs_dmeta
    285 #define lfs_minfreeseg lfs_dlfs.dlfs_minfreeseg
    286 
    287 /* These fields are set at mount time and are meaningless on disk. */
    288 	struct segment *lfs_sp;		/* current segment being written */
    289 	struct vnode *lfs_ivnode;	/* vnode for the ifile */
    290 	u_int32_t  lfs_seglock;		/* single-thread the segment writer */
    291 	pid_t	  lfs_lockpid;		/* pid of lock holder */
    292 	u_int32_t lfs_iocount;		/* number of ios pending */
    293 	u_int32_t lfs_writer;		/* don't allow any dirops to start */
    294 	u_int32_t lfs_dirops;		/* count of active directory ops */
    295 	u_int32_t lfs_doifile;		/* Write ifile blocks on next write */
    296 	u_int32_t lfs_nactive;		/* Number of segments since last ckp */
    297 	int8_t	  lfs_fmod;		/* super block modified flag */
    298 	int8_t	  lfs_ronly;		/* mounted read-only flag */
    299 #define LFS_NOTYET 0x01
    300 	int8_t	  lfs_flags;		/* currently unused flag */
    301 	u_int16_t lfs_activesb;         /* toggle between superblocks */
    302 #ifdef LFS_TRACK_IOS
    303 	daddr_t   lfs_pending[LFS_THROTTLE]; /* daddrs of pending writes */
    304 #endif /* LFS_TRACK_IOS */
    305 #ifdef LFS_CANNOT_ROLLFW
    306 	daddr_t   lfs_sbactive;         /* disk address of in-progress sb write */
    307 #endif
    308 	struct vnode *lfs_flushvp;      /* vnode being flushed */
    309 	struct vnode *lfs_unlockvp;     /* being inactivated in lfs_segunlock */
    310 	u_int32_t lfs_diropwait;	/* # procs waiting on dirop flush */
    311 	struct lock lfs_freelock;
    312 	pid_t lfs_rfpid;		/* Process ID of roll-forward agent */
    313 	int       lfs_nadirop;		/* number of active dirop nodes */
    314 };
    315 
    316 /*
    317  * Inode 0:	out-of-band inode number
    318  * Inode 1:	IFILE inode number
    319  * Inode 2:	root inode
    320  * Inode 3:	lost+found inode number
    321  */
    322 #define	LFS_UNUSED_INUM	0		/* out of band inode number */
    323 #define	LFS_IFILE_INUM	1		/* IFILE inode number */
    324 #define	LOSTFOUNDINO	3		/* lost+found inode number */
    325 #define	LFS_FIRST_INUM	4		/* first free inode number */
    326 
    327 /* Address calculations for metadata located in the inode */
    328 #define	S_INDIR(fs)	-NDADDR
    329 #define	D_INDIR(fs)	(S_INDIR(fs) - NINDIR(fs) - 1)
    330 #define	T_INDIR(fs)	(D_INDIR(fs) - NINDIR(fs) * NINDIR(fs) - 1)
    331 
    332 /* Unassigned disk addresses. */
    333 #define	UNASSIGNED	-1
    334 #define UNWRITTEN       -2
    335 
    336 /* Unused logical block number */
    337 #define LFS_UNUSED_LBN	-1
    338 
    339 typedef struct ifile IFILE;
    340 struct ifile {
    341 	u_int32_t if_version;		/* inode version number */
    342 #define	LFS_UNUSED_DADDR	0	/* out-of-band daddr */
    343 	ufs_daddr_t if_daddr;		/* inode disk address */
    344 	ino_t	  if_nextfree;		/* next-unallocated inode */
    345 #ifdef LFS_ATIME_IFILE
    346 	struct timespec if_atime;	/* Last access time */
    347 #endif
    348 };
    349 
    350 /*
    351  * Cleaner information structure.  This resides in the ifile and is used
    352  * to pass information between the cleaner and the kernel.
    353  */
    354 typedef struct _cleanerinfo {
    355 	u_int32_t clean;		/* number of clean segments */
    356 	u_int32_t dirty;		/* number of dirty segments */
    357 	u_int32_t bfree;		/* disk blocks free */
    358 	u_int32_t avail;		/* disk blocks available */
    359 } CLEANERINFO;
    360 
    361 #define	CLEANSIZE_SU(fs)						\
    362 	((sizeof(CLEANERINFO) + (fs)->lfs_bsize - 1) >> (fs)->lfs_bshift)
    363 
    364 /*
    365  * All summary blocks are the same size, so we can always read a summary
    366  * block easily from a segment.
    367  */
    368 #define	LFS_SUMMARY_SIZE	512
    369 
    370 /* On-disk segment summary information */
    371 typedef struct segsum SEGSUM;
    372 struct segsum {
    373 	u_int32_t ss_sumsum;		/* check sum of summary block */
    374 	u_int32_t ss_datasum;		/* check sum of data */
    375 	u_int32_t ss_magic;		/* segment summary magic number */
    376 #define SS_MAGIC	0x061561
    377 	ufs_daddr_t ss_next;		/* next segment */
    378 	u_int32_t ss_create;		/* creation time stamp */
    379 	u_int16_t ss_nfinfo;		/* number of file info structures */
    380 	u_int16_t ss_ninos;		/* number of inodes in summary */
    381 
    382 #define	SS_DIROP	0x01		/* segment begins a dirop */
    383 #define	SS_CONT		0x02		/* more partials to finish this write*/
    384 	u_int16_t ss_flags;		/* used for directory operations */
    385 	u_int16_t ss_pad;		/* extra space */
    386 	/* FINFO's and inode daddr's... */
    387 };
    388 
    389 /* NINDIR is the number of indirects in a file system block. */
    390 #define	NINDIR(fs)	((fs)->lfs_nindir)
    391 
    392 /* INOPB is the number of inodes in a secondary storage block. */
    393 #define	INOPB(fs)	((fs)->lfs_inopb)
    394 
    395 #define	blksize(fs, ip, lbn) \
    396 	(((lbn) >= NDADDR || (ip)->i_ffs_size >= ((lbn) + 1) << (fs)->lfs_bshift) \
    397 	    ? (fs)->lfs_bsize \
    398 	    : (fragroundup(fs, blkoff(fs, (ip)->i_ffs_size))))
    399 #define	blkoff(fs, loc)		((int)(loc) & (fs)->lfs_bmask)
    400 #define fragoff(fs, loc)    /* calculates (loc % fs->lfs_fsize) */ \
    401     ((int)((loc) & (fs)->lfs_ffmask))
    402 #define	fsbtodb(fs, b)		((b) << (fs)->lfs_fsbtodb)
    403 #define	dbtofsb(fs, b)		((b) >> (fs)->lfs_fsbtodb)
    404 #define fragstodb(fs, b)	((b) << ((fs)->lfs_fsbtodb - (fs)->lfs_fbshift))
    405 #define dbtofrags(fs, b)	((b) >> ((fs)->lfs_fsbtodb - (fs)->lfs_fbshift))
    406 #define	lblkno(fs, loc)		((loc) >> (fs)->lfs_bshift)
    407 #define	lblktosize(fs, blk)	((blk) << (fs)->lfs_bshift)
    408 #define numfrags(fs, loc)	/* calculates (loc / fs->lfs_fsize) */	\
    409 	((loc) >> (fs)->lfs_ffshift)
    410 #define blkroundup(fs, size)	/* calculates roundup(size, fs->lfs_bsize) */ \
    411 	((int)(((size) + (fs)->lfs_bmask) & (~(fs)->lfs_bmask)))
    412 #define fragroundup(fs, size)	/* calculates roundup(size, fs->lfs_fsize) */ \
    413 	((int)(((size) + (fs)->lfs_ffmask) & (~(fs)->lfs_ffmask)))
    414 #define fragstoblks(fs, frags)	/* calculates (frags / fs->lfs_frag) */ \
    415 	((frags) >> (fs)->lfs_fbshift)
    416 #define blkstofrags(fs, blks)	/* calculates (blks * fs->lfs_frag) */ \
    417 	((blks) << (fs)->lfs_fbshift)
    418 #define fragnum(fs, fsb)	/* calculates (fsb % fs->lfs_frag) */ \
    419 	((fsb) & ((fs)->lfs_frag - 1))
    420 #define blknum(fs, fsb)		/* calculates rounddown(fsb, fs->lfs_frag) */ \
    421 	((fsb) &~ ((fs)->lfs_frag - 1))
    422 #define dblksize(fs, dip, lbn) \
    423 	(((lbn) >= NDADDR || (dip)->di_size >= ((lbn) + 1) << (fs)->lfs_bshift)\
    424 	    ? (fs)->lfs_bsize \
    425 	    : (fragroundup(fs, blkoff(fs, (dip)->di_size))))
    426 #define	datosn(fs, daddr)	/* disk address to segment number */	\
    427 	(((daddr) - (fs)->lfs_sboffs[0]) / fsbtodb((fs), (fs)->lfs_ssize))
    428 #define sntoda(fs, sn) 		/* segment number to disk address */	\
    429 	((ufs_daddr_t)((sn) * ((fs)->lfs_ssize << (fs)->lfs_fsbtodb) +	\
    430 	    (fs)->lfs_sboffs[0]))
    431 
    432 /* Read in the block with the cleaner info from the ifile. */
    433 #define LFS_CLEANERINFO(CP, F, BP) {					\
    434 	VTOI((F)->lfs_ivnode)->i_flag |= IN_ACCESS;			\
    435 	if (bread((F)->lfs_ivnode,					\
    436 	    (ufs_daddr_t)0, (F)->lfs_bsize, NOCRED, &(BP)))		\
    437 		panic("lfs: ifile read");				\
    438 	(CP) = (CLEANERINFO *)(BP)->b_data;				\
    439 }
    440 
    441 /* Read in the block with a specific inode from the ifile. */
    442 #define	LFS_IENTRY(IP, F, IN, BP) {					\
    443 	int _e;								\
    444 	VTOI((F)->lfs_ivnode)->i_flag |= IN_ACCESS;			\
    445 	if ((_e = bread((F)->lfs_ivnode,				\
    446 	    (IN) / (F)->lfs_ifpb + (F)->lfs_cleansz + (F)->lfs_segtabsz,\
    447 	    (F)->lfs_bsize, NOCRED, &(BP))) != 0)			\
    448 		panic("lfs: ifile read %d", _e);			\
    449 	(IP) = (IFILE *)(BP)->b_data + (IN) % (F)->lfs_ifpb;		\
    450 }
    451 
    452 /* Read in the block with a specific segment usage entry from the ifile. */
    453 #define	LFS_SEGENTRY(SP, F, IN, BP) {					\
    454 	int _e;								\
    455 	VTOI((F)->lfs_ivnode)->i_flag |= IN_ACCESS;			\
    456 	if ((_e = bread((F)->lfs_ivnode,				\
    457 	    ((IN) >> (F)->lfs_sushift) + (F)->lfs_cleansz,		\
    458 	    (F)->lfs_bsize, NOCRED, &(BP))) != 0)			\
    459 		panic("lfs: ifile read: %d", _e);			\
    460 	(SP) = (SEGUSE *)(BP)->b_data + ((IN) & ((F)->lfs_sepb - 1));	\
    461 }
    462 
    463 /* Determine if a buffer belongs to the ifile */
    464 #define IS_IFILE(bp)	(VTOI(bp->b_vp)->i_number == LFS_IFILE_INUM)
    465 
    466 /*
    467  * Structures used by lfs_bmapv and lfs_markv to communicate information
    468  * about inodes and data blocks.
    469  */
    470 typedef struct block_info {
    471 	ino_t	bi_inode;		/* inode # */
    472 	ufs_daddr_t bi_lbn;		/* logical block w/in file */
    473 	ufs_daddr_t bi_daddr;		/* disk address of block */
    474 	time_t	bi_segcreate;		/* origin segment create time */
    475 	int	bi_version;		/* file version number */
    476 	void	*bi_bp;			/* data buffer */
    477 	int     bi_size;		/* size of the block (if fragment) */
    478 } BLOCK_INFO;
    479 
    480 /* In-memory description of a segment about to be written. */
    481 struct segment {
    482 	struct lfs	 *fs;		/* file system pointer */
    483 	struct buf	**bpp;		/* pointer to buffer array */
    484 	struct buf	**cbpp;		/* pointer to next available bp */
    485 	struct buf	**start_bpp;	/* pointer to first bp in this set */
    486 	struct buf	 *ibp;		/* buffer pointer to inode page */
    487 	struct dinode    *idp;          /* pointer to ifile dinode */
    488 	struct finfo	 *fip;		/* current fileinfo pointer */
    489 	struct vnode	 *vp;		/* vnode being gathered */
    490 	void	 *segsum;		/* segment summary info */
    491 	u_int32_t ninodes;		/* number of inodes in this segment */
    492 	u_int32_t seg_bytes_left;	/* bytes left in segment */
    493 	u_int32_t sum_bytes_left;	/* bytes left in summary block */
    494 	u_int32_t seg_number;		/* number of this segment */
    495 	ufs_daddr_t *start_lbp;		/* beginning lbn for this set */
    496 
    497 #define	SEGM_CKP	0x01		/* doing a checkpoint */
    498 #define	SEGM_CLEAN	0x02		/* cleaner call; don't sort */
    499 #define	SEGM_SYNC	0x04		/* wait for segment */
    500 #define	SEGM_PROT	0x08		/* don't inactivate at segunlock */
    501 	u_int16_t seg_flags;		/* run-time flags for this segment */
    502 };
    503 
    504 /*
    505  * Macros for determining free space on the disk, with the variable metadata
    506  * of segment summaries and inode blocks taken into account.
    507  */
    508 /* Estimate number of clean blocks not available for writing */
    509 #define LFS_EST_CMETA(F) ((((F)->lfs_dmeta * (u_int64_t)(F)->lfs_nclean) /  \
    510 				      ((F)->lfs_nseg - (F)->lfs_nclean)))
    511 
    512 /* Estimate total size of the disk not including metadata */
    513 #define LFS_EST_NONMETA(F) ((F)->lfs_dsize - (F)->lfs_dmeta - LFS_EST_CMETA(F))
    514 
    515 /* Estimate number of blocks actually available for writing */
    516 #define LFS_EST_BFREE(F) ((F)->lfs_bfree - LFS_EST_CMETA(F) - (F)->lfs_dmeta)
    517 
    518 /* Amount of non-meta space not available to mortal man */
    519 #define LFS_EST_RSVD(F) ((LFS_EST_NONMETA(F) * (u_int64_t)(F)->lfs_minfree) / \
    520 			  100)
    521 
    522 /* Can credential C write BB blocks */
    523 #define ISSPACE(F, BB, C)						\
    524 	((((C) == NOCRED || (C)->cr_uid == 0) &&			\
    525           LFS_EST_BFREE(F) >= (BB)) ||					\
    526 	 ((C)->cr_uid != 0 && IS_FREESPACE(F, BB)))
    527 
    528 /* Can an ordinary user write BB blocks */
    529 #define IS_FREESPACE(F, BB)						\
    530           (LFS_EST_BFREE(F) >= (BB) + LFS_EST_RSVD(F))
    531 
    532 /* Statistics Counters */
    533 struct lfs_stats {
    534 	u_int	segsused;
    535 	u_int	psegwrites;
    536 	u_int	psyncwrites;
    537 	u_int	pcleanwrites;
    538 	u_int	blocktot;
    539 	u_int	cleanblocks;
    540 	u_int	ncheckpoints;
    541 	u_int	nwrites;
    542 	u_int	nsync_writes;
    543 	u_int	wait_exceeded;
    544 	u_int	write_exceeded;
    545 	u_int	flush_invoked;
    546 	u_int	vflush_invoked;
    547 };
    548 extern struct lfs_stats lfs_stats;
    549