xref: /netbsd-src/sys/ufs/lfs/lfs.h (revision 95d875fb90b1458e4f1de6950286ddcd6644bc61)
1 /*	$NetBSD: lfs.h,v 1.19 1999/12/15 07:10:34 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@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	4
89 #define LFS_MAX_ACTIVE	10
90 #define LFS_MAXDIROP	(desiredvnodes>>2)
91 
92 #ifndef LFS_ATIME_IFILE
93 # define LFS_ITIMES(ip, acc, mod, cre) FFS_ITIMES((ip),(acc),(mod),(cre))
94 #else
95 # define LFS_ITIMES(ip, acc, mod, cre) {                                \
96 	struct buf *ibp;						\
97 	IFILE *ifp;							\
98 									\
99         if ((ip)->i_flag & IN_ACCESS) {                         	\
100 	LFS_IENTRY(ifp, ip->i_lfs, ip->i_number, ibp);			\
101        		ifp->if_atime = (mod);					\
102        		VOP_BWRITE(bp);						\
103 		(ip)->i_flag &= ~IN_ACCESS;				\
104         }                                                       	\
105         if ((ip)->i_flag & (IN_CHANGE | IN_UPDATE)) {       		\
106                 (ip)->i_flag |= IN_MODIFIED;                            \
107                 if ((ip)->i_flag & IN_UPDATE) {                         \
108                         (ip)->i_ffs_mtime = (mod)->tv_sec;		\
109                         (ip)->i_ffs_mtimensec = (mod)->tv_nsec;         \
110                         (ip)->i_modrev++;                               \
111                 }                                                       \
112                 if ((ip)->i_flag & IN_CHANGE) {                         \
113                         (ip)->i_ffs_ctime = (cre)->tv_sec;		\
114                         (ip)->i_ffs_ctimensec = (cre)->tv_nsec;         \
115                 }                                                       \
116                 (ip)->i_flag &= ~(IN_CHANGE | IN_UPDATE);   		\
117         }                                                               \
118 }
119 #endif
120 
121 #define WRITEINPROG(vp) (vp->v_dirtyblkhd.lh_first && !(VTOI(vp)->i_flag & (IN_MODIFIED|IN_CLEANING)))
122 
123 /* Here begins the berkeley code */
124 
125 #define	LFS_LABELPAD	8192		/* LFS label size */
126 #define	LFS_SBPAD	8192		/* LFS superblock size */
127 
128 /*
129  * XXX
130  * This is a kluge and NEEDS to go away.
131  *
132  * Right now, ufs code handles most of the calls for directory operations
133  * such as create, mkdir, link, etc.  As a result VOP_UPDATE is being
134  * called with waitfor set (since ffs does these things synchronously).
135  * Since LFS does not want to do these synchronously, we treat the last
136  * argument to lfs_update as a set of flags.  If LFS_SYNC is set, then
137  * the update should be synchronous, if not, do it asynchronously.
138  * Unfortunately, this means that LFS won't work with NFS yet because
139  * NFS goes through paths that will make normal calls to ufs which will
140  * call lfs with a last argument of 1.
141  */
142 #define	LFS_SYNC	0x02
143 
144 /* On-disk and in-memory checkpoint segment usage structure. */
145 typedef struct segusage SEGUSE;
146 struct segusage {
147 	u_int32_t su_nbytes;		/* number of live bytes */
148 	u_int32_t su_lastmod;		/* SEGUSE last modified timestamp */
149 	u_int16_t su_nsums;		/* number of summaries in segment */
150 	u_int16_t su_ninos;		/* number of inode blocks in seg */
151 
152 #define	SEGUSE_ACTIVE		0x01	/* segment is currently being written */
153 #define	SEGUSE_DIRTY		0x02	/* segment has data in it */
154 #define	SEGUSE_SUPERBLOCK	0x04	/* segment contains a superblock */
155 	u_int32_t su_flags;
156 };
157 
158 #define	SEGUPB(fs)	(1 << (fs)->lfs_sushift)
159 #define	SEGTABSIZE_SU(fs)						\
160 	(((fs)->lfs_nseg + SEGUPB(fs) - 1) >> (fs)->lfs_sushift)
161 
162 /* On-disk file information.  One per file with data blocks in the segment. */
163 typedef struct finfo FINFO;
164 struct finfo {
165 	u_int32_t fi_nblocks;		/* number of blocks */
166 	u_int32_t fi_version;		/* version number */
167 	u_int32_t fi_ino;		/* inode number */
168 	u_int32_t fi_lastlength;	/* length of last block in array */
169 	ufs_daddr_t	  fi_blocks[1];		/* array of logical block numbers */
170 };
171 
172 /* On-disk super block. */
173 struct dlfs {
174 #define	LFS_MAGIC	0x070162
175         u_int32_t dlfs_magic;     /* 0: magic number */
176 #define	LFS_VERSION	1
177         u_int32_t dlfs_version;   /* 4: version number */
178 
179         u_int32_t dlfs_size;      /* 8: number of blocks in fs */
180         u_int32_t dlfs_ssize;     /* 12: number of blocks per segment */
181         u_int32_t dlfs_dsize;     /* 16: number of disk blocks in fs */
182         u_int32_t dlfs_bsize;     /* 20: file system block size */
183         u_int32_t dlfs_fsize;     /* 24: size of frag blocks in fs */
184         u_int32_t dlfs_frag;      /* 28: number of frags in a block in fs */
185 
186 /* Checkpoint region. */
187         u_int32_t dlfs_free;      /* 32: start of the free list */
188         u_int32_t dlfs_bfree;     /* 36: number of free disk blocks */
189         u_int32_t dlfs_nfiles;    /* 40: number of allocated inodes */
190         int32_t   dlfs_avail;     /* 44: blocks available for writing */
191         u_int32_t dlfs_uinodes;   /* 48: inodes in cache not yet on disk */
192         ufs_daddr_t  dlfs_idaddr; /* 52: inode file disk address */
193         u_int32_t dlfs_ifile;     /* 56: inode file inode number */
194         ufs_daddr_t  dlfs_lastseg; /* 60: address of last segment written */
195         ufs_daddr_t  dlfs_nextseg; /* 64: address of next segment to write */
196         ufs_daddr_t  dlfs_curseg; /* 68: current segment being written */
197         ufs_daddr_t  dlfs_offset; /* 72: offset in curseg for next partial */
198         ufs_daddr_t  dlfs_lastpseg; /* 76: address of last partial written */
199         u_int32_t dlfs_tstamp;    /* 80: time stamp */
200 
201 /* These are configuration parameters. */
202         u_int32_t dlfs_minfree;   /* 84: minimum percentage of free blocks */
203 
204 /* These fields can be computed from the others. */
205         u_int64_t dlfs_maxfilesize; /* 88: maximum representable file size */
206         u_int32_t dlfs_dbpseg;    /* 96: disk blocks per segment */
207         u_int32_t dlfs_inopb;     /* 100: inodes per block */
208         u_int32_t dlfs_ifpb;      /* 104: IFILE entries per block */
209         u_int32_t dlfs_sepb;      /* 108: SEGUSE entries per block */
210         u_int32_t dlfs_nindir;    /* 112: indirect pointers per block */
211         u_int32_t dlfs_nseg;      /* 116: number of segments */
212         u_int32_t dlfs_nspf;      /* 120: number of sectors per fragment */
213         u_int32_t dlfs_cleansz;   /* 124: cleaner info size in blocks */
214         u_int32_t dlfs_segtabsz;  /* 128: segment table size in blocks */
215         u_int32_t dlfs_segmask;   /* 132: calculate offset within a segment */
216         u_int32_t dlfs_segshift;  /* 136: fast mult/div for segments */
217         u_int32_t dlfs_bshift;    /* 140: calc block number from file offset */
218         u_int32_t dlfs_ffshift;   /* 144: fast mult/div for frag from file */
219         u_int32_t dlfs_fbshift;   /* 148: fast mult/div for frag from block */
220         u_int64_t dlfs_bmask;     /* 152: calc block offset from file offset */
221         u_int64_t dlfs_ffmask;    /* 160: calc frag offset from file offset */
222         u_int64_t dlfs_fbmask;    /* 168: calc frag offset from block offset */
223         u_int32_t dlfs_fsbtodb;   /* 176: fsbtodb and dbtofsb shift constant */
224         u_int32_t dlfs_sushift;   /* 180: fast mult/div for segusage table */
225 
226         int32_t   dlfs_maxsymlinklen; /* 184: max length of an internal symlink */
227 
228 #define	LFS_MIN_SBINTERVAL	5  /* minimum superblock segment spacing */
229 #define LFS_MAXNUMSB            10 /* 188: superblock disk offsets */
230         ufs_daddr_t       dlfs_sboffs[LFS_MAXNUMSB];
231 
232 	u_int32_t dlfs_nclean;    /* 228: Number of clean segments */
233 	u_char	  dlfs_fsmnt[MNAMELEN];	 /* 232: name mounted on */
234 	/* XXX this is 2 bytes only to pad to a quad boundary */
235 	u_int16_t dlfs_clean;     /* 322: file system is clean flag */
236         int8_t    dlfs_pad[184];  /* 324: round to 512 bytes */
237 /* Checksum -- last valid disk field. */
238         u_int32_t dlfs_cksum;     /* 328: checksum for superblock checking */
239 };
240 
241 /* Maximum number of io's we can have pending at once */
242 #define LFS_THROTTLE  16 /* XXX should be better paramtrized - ? */
243 
244 /* In-memory super block. */
245 struct lfs {
246         struct dlfs lfs_dlfs;           /* on-disk parameters */
247 #define lfs_magic lfs_dlfs.dlfs_magic
248 #define lfs_version lfs_dlfs.dlfs_version
249 #define lfs_size lfs_dlfs.dlfs_size
250 #define lfs_ssize lfs_dlfs.dlfs_ssize
251 #define lfs_dsize lfs_dlfs.dlfs_dsize
252 #define lfs_bsize lfs_dlfs.dlfs_bsize
253 #define lfs_fsize lfs_dlfs.dlfs_fsize
254 #define lfs_frag lfs_dlfs.dlfs_frag
255 #define lfs_free lfs_dlfs.dlfs_free
256 #define lfs_bfree lfs_dlfs.dlfs_bfree
257 #define lfs_nfiles lfs_dlfs.dlfs_nfiles
258 #define lfs_avail lfs_dlfs.dlfs_avail
259 #define lfs_uinodes lfs_dlfs.dlfs_uinodes
260 #define lfs_idaddr lfs_dlfs.dlfs_idaddr
261 #define lfs_ifile lfs_dlfs.dlfs_ifile
262 #define lfs_lastseg lfs_dlfs.dlfs_lastseg
263 #define lfs_nextseg lfs_dlfs.dlfs_nextseg
264 #define lfs_curseg lfs_dlfs.dlfs_curseg
265 #define lfs_offset lfs_dlfs.dlfs_offset
266 #define lfs_lastpseg lfs_dlfs.dlfs_lastpseg
267 #define lfs_tstamp lfs_dlfs.dlfs_tstamp
268 #define lfs_minfree lfs_dlfs.dlfs_minfree
269 #define lfs_maxfilesize lfs_dlfs.dlfs_maxfilesize
270 #define lfs_dbpseg lfs_dlfs.dlfs_dbpseg
271 #define lfs_inopb lfs_dlfs.dlfs_inopb
272 #define lfs_ifpb lfs_dlfs.dlfs_ifpb
273 #define lfs_sepb lfs_dlfs.dlfs_sepb
274 #define lfs_nindir lfs_dlfs.dlfs_nindir
275 #define lfs_nseg lfs_dlfs.dlfs_nseg
276 #define lfs_nspf lfs_dlfs.dlfs_nspf
277 #define lfs_cleansz lfs_dlfs.dlfs_cleansz
278 #define lfs_segtabsz lfs_dlfs.dlfs_segtabsz
279 #define lfs_segmask lfs_dlfs.dlfs_segmask
280 #define lfs_segshift lfs_dlfs.dlfs_segshift
281 #define lfs_bmask lfs_dlfs.dlfs_bmask
282 #define lfs_bshift lfs_dlfs.dlfs_bshift
283 #define lfs_ffmask lfs_dlfs.dlfs_ffmask
284 #define lfs_ffshift lfs_dlfs.dlfs_ffshift
285 #define lfs_fbmask lfs_dlfs.dlfs_fbmask
286 #define lfs_fbshift lfs_dlfs.dlfs_fbshift
287 #define lfs_fsbtodb lfs_dlfs.dlfs_fsbtodb
288 #define lfs_sushift lfs_dlfs.dlfs_sushift
289 #define lfs_maxsymlinklen lfs_dlfs.dlfs_maxsymlinklen
290 #define lfs_sboffs lfs_dlfs.dlfs_sboffs
291 #define lfs_cksum lfs_dlfs.dlfs_cksum
292 #define lfs_clean lfs_dlfs.dlfs_clean
293 #define lfs_fsmnt lfs_dlfs.dlfs_fsmnt
294 #define lfs_nclean lfs_dlfs.dlfs_nclean
295 /* These fields are set at mount time and are meaningless on disk. */
296 	struct segment *lfs_sp;		/* current segment being written */
297 	struct vnode *lfs_ivnode;	/* vnode for the ifile */
298 	u_int32_t  lfs_seglock;		/* single-thread the segment writer */
299 	pid_t	  lfs_lockpid;		/* pid of lock holder */
300 	u_int32_t lfs_iocount;		/* number of ios pending */
301 	u_int32_t lfs_writer;		/* don't allow any dirops to start */
302 	u_int32_t lfs_dirops;		/* count of active directory ops */
303 	u_int32_t lfs_doifile;		/* Write ifile blocks on next write */
304 	u_int32_t lfs_nactive;		/* Number of segments since last ckp */
305 	int8_t	  lfs_fmod;		/* super block modified flag */
306 	int8_t	  lfs_ronly;		/* mounted read-only flag */
307 	int8_t	  lfs_flags;		/* currently unused flag */
308 	u_int16_t lfs_activesb;         /* toggle between superblocks */
309 #ifdef LFS_TRACK_IOS
310 	daddr_t   lfs_pending[LFS_THROTTLE]; /* daddrs of pending writes */
311 #endif /* LFS_TRACK_IOS */
312 #ifdef LFS_CANNOT_ROLLFW
313 	daddr_t   lfs_sbactive;         /* disk address of in-progress sb write */
314 #endif
315 	struct vnode *lfs_flushvp;      /* vnode being flushed */
316 	u_int32_t lfs_diropwait;	/* # procs waiting on dirop flush */
317 };
318 
319 /*
320  * Inode 0:	out-of-band inode number
321  * Inode 1:	IFILE inode number
322  * Inode 2:	root inode
323  * Inode 3:	lost+found inode number
324  */
325 #define	LFS_UNUSED_INUM	0		/* out of band inode number */
326 #define	LFS_IFILE_INUM	1		/* IFILE inode number */
327 #define	LOSTFOUNDINO	3		/* lost+found inode number */
328 #define	LFS_FIRST_INUM	4		/* first free inode number */
329 
330 /* Address calculations for metadata located in the inode */
331 #define	S_INDIR(fs)	-NDADDR
332 #define	D_INDIR(fs)	(S_INDIR(fs) - NINDIR(fs) - 1)
333 #define	T_INDIR(fs)	(D_INDIR(fs) - NINDIR(fs) * NINDIR(fs) - 1)
334 
335 /* Unassigned disk address. */
336 #define	UNASSIGNED	-1
337 
338 /* Unused logical block number */
339 #define LFS_UNUSED_LBN	-1
340 
341 typedef struct ifile IFILE;
342 struct ifile {
343 	u_int32_t if_version;		/* inode version number */
344 #define	LFS_UNUSED_DADDR	0	/* out-of-band daddr */
345 	ufs_daddr_t if_daddr;		/* inode disk address */
346 	ino_t	  if_nextfree;		/* next-unallocated inode */
347 #ifdef LFS_ATIME_IFILE
348 	struct timespec if_atime;	/* Last access time */
349 #endif
350 };
351 
352 /*
353  * Cleaner information structure.  This resides in the ifile and is used
354  * to pass information between the cleaner and the kernel.
355  */
356 typedef struct _cleanerinfo {
357 	u_int32_t clean;		/* K: number of clean segments */
358 	u_int32_t dirty;		/* K: number of dirty segments */
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 	u_int16_t seg_flags;		/* run-time flags for this segment */
501 };
502 
503 #define ISSPACE(F, BB, C)						\
504 	(((C)->cr_uid == 0 && (F)->lfs_bfree >= (BB)) ||		\
505 	((C)->cr_uid != 0 && IS_FREESPACE(F, BB)))
506 
507 #define IS_FREESPACE(F, BB)						\
508 	((F)->lfs_bfree > ((F)->lfs_dsize * (F)->lfs_minfree / 100 + (BB)))
509 
510 #define ISSPACE_XXX(F, BB)						\
511 	((F)->lfs_bfree >= (BB))
512 
513 /* Statistics Counters */
514 struct lfs_stats {
515 	u_int	segsused;
516 	u_int	psegwrites;
517 	u_int	psyncwrites;
518 	u_int	pcleanwrites;
519 	u_int	blocktot;
520 	u_int	cleanblocks;
521 	u_int	ncheckpoints;
522 	u_int	nwrites;
523 	u_int	nsync_writes;
524 	u_int	wait_exceeded;
525 	u_int	write_exceeded;
526 	u_int	flush_invoked;
527 	u_int	vflush_invoked;
528 };
529 extern struct lfs_stats lfs_stats;
530