1 /*- 2 * Copyright (c) 1991, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * %sccs.include.redist.c% 6 * 7 * @(#)lfs.h 8.4 (Berkeley) 06/15/94 8 */ 9 10 #define LFS_LABELPAD 8192 /* LFS label size */ 11 #define LFS_SBPAD 8192 /* LFS superblock size */ 12 13 /* 14 * XXX 15 * This is a kluge and NEEDS to go away. 16 * 17 * Right now, ufs code handles most of the calls for directory operations 18 * such as create, mkdir, link, etc. As a result VOP_UPDATE is being 19 * called with waitfor set (since ffs does these things synchronously). 20 * Since LFS does not want to do these synchronously, we treat the last 21 * argument to lfs_update as a set of flags. If LFS_SYNC is set, then 22 * the update should be synchronous, if not, do it asynchronously. 23 * Unfortunately, this means that LFS won't work with NFS yet because 24 * NFS goes through paths that will make normal calls to ufs which will 25 * call lfs with a last argument of 1. 26 */ 27 #define LFS_SYNC 0x02 28 29 /* On-disk and in-memory checkpoint segment usage structure. */ 30 typedef struct segusage SEGUSE; 31 struct segusage { 32 u_long su_nbytes; /* number of live bytes */ 33 u_long su_lastmod; /* SEGUSE last modified timestamp */ 34 u_short su_nsums; /* number of summaries in segment */ 35 u_short su_ninos; /* number of inode blocks in seg */ 36 #define SEGUSE_ACTIVE 0x1 /* segment is currently being written */ 37 #define SEGUSE_DIRTY 0x2 /* segment has data in it */ 38 #define SEGUSE_SUPERBLOCK 0x4 /* segment contains a superblock */ 39 u_long su_flags; 40 }; 41 42 #define SEGUPB(fs) (1 << (fs)->lfs_sushift) 43 #define SEGTABSIZE_SU(fs) \ 44 (((fs)->lfs_nseg + SEGUPB(fs) - 1) >> (fs)->lfs_sushift) 45 46 /* On-disk file information. One per file with data blocks in the segment. */ 47 typedef struct finfo FINFO; 48 struct finfo { 49 u_long fi_nblocks; /* number of blocks */ 50 u_long fi_version; /* version number */ 51 u_long fi_ino; /* inode number */ 52 long fi_blocks[1]; /* array of logical block numbers */ 53 }; 54 55 /* On-disk and in-memory super block. */ 56 struct lfs { 57 #define LFS_MAGIC 0x070162 58 u_long lfs_magic; /* magic number */ 59 #define LFS_VERSION 1 60 u_long lfs_version; /* version number */ 61 62 u_long lfs_size; /* number of blocks in fs */ 63 u_long lfs_ssize; /* number of blocks per segment */ 64 u_long lfs_dsize; /* number of disk blocks in fs */ 65 u_long lfs_bsize; /* file system block size */ 66 u_long lfs_fsize; /* size of frag blocks in fs */ 67 u_long lfs_frag; /* number of frags in a block in fs */ 68 69 /* Checkpoint region. */ 70 ino_t lfs_free; /* start of the free list */ 71 u_long lfs_bfree; /* number of free disk blocks */ 72 u_long lfs_nfiles; /* number of allocated inodes */ 73 long lfs_avail; /* blocks available for writing */ 74 u_long lfs_uinodes; /* inodes in cache not yet on disk */ 75 daddr_t lfs_idaddr; /* inode file disk address */ 76 ino_t lfs_ifile; /* inode file inode number */ 77 daddr_t lfs_lastseg; /* address of last segment written */ 78 daddr_t lfs_nextseg; /* address of next segment to write */ 79 daddr_t lfs_curseg; /* current segment being written */ 80 daddr_t lfs_offset; /* offset in curseg for next partial */ 81 daddr_t lfs_lastpseg; /* address of last partial written */ 82 u_long lfs_tstamp; /* time stamp */ 83 84 /* These are configuration parameters. */ 85 u_long lfs_minfree; /* minimum percentage of free blocks */ 86 87 /* These fields can be computed from the others. */ 88 u_quad_t lfs_maxfilesize; /* maximum representable file size */ 89 u_long lfs_dbpseg; /* disk blocks per segment */ 90 u_long lfs_inopb; /* inodes per block */ 91 u_long lfs_ifpb; /* IFILE entries per block */ 92 u_long lfs_sepb; /* SEGUSE entries per block */ 93 u_long lfs_nindir; /* indirect pointers per block */ 94 u_long lfs_nseg; /* number of segments */ 95 u_long lfs_nspf; /* number of sectors per fragment */ 96 u_long lfs_cleansz; /* cleaner info size in blocks */ 97 u_long lfs_segtabsz; /* segment table size in blocks */ 98 99 u_long lfs_segmask; /* calculate offset within a segment */ 100 u_long lfs_segshift; /* fast mult/div for segments */ 101 u_long lfs_bmask; /* calc block offset from file offset */ 102 u_long lfs_bshift; /* calc block number from file offset */ 103 u_long lfs_ffmask; /* calc frag offset from file offset */ 104 u_long lfs_ffshift; /* fast mult/div for frag from file */ 105 u_long lfs_fbmask; /* calc frag offset from block offset */ 106 u_long lfs_fbshift; /* fast mult/div for frag from block */ 107 u_long lfs_fsbtodb; /* fsbtodb and dbtofsb shift constant */ 108 u_long lfs_sushift; /* fast mult/div for segusage table */ 109 110 #define LFS_MIN_SBINTERVAL 5 /* minimum superblock segment spacing */ 111 #define LFS_MAXNUMSB 10 /* superblock disk offsets */ 112 daddr_t lfs_sboffs[LFS_MAXNUMSB]; 113 114 /* These fields are set at mount time and are meaningless on disk. */ 115 struct segment *lfs_sp; /* current segment being written */ 116 struct vnode *lfs_ivnode; /* vnode for the ifile */ 117 u_long lfs_seglock; /* single-thread the segment writer */ 118 pid_t lfs_lockpid; /* pid of lock holder */ 119 u_long lfs_iocount; /* number of ios pending */ 120 u_long lfs_writer; /* don't allow any dirops to start */ 121 u_long lfs_dirops; /* count of active directory ops */ 122 u_long lfs_doifile; /* Write ifile blocks on next write */ 123 u_long lfs_nactive; /* Number of segments since last ckp */ 124 u_char lfs_fmod; /* super block modified flag */ 125 u_char lfs_clean; /* file system is clean flag */ 126 u_char lfs_ronly; /* mounted read-only flag */ 127 u_char lfs_flags; /* currently unused flag */ 128 u_char lfs_fsmnt[MNAMELEN]; /* name mounted on */ 129 u_char pad[3]; /* long-align */ 130 131 /* Checksum; valid on disk. */ 132 u_long lfs_cksum; /* checksum for superblock checking */ 133 long lfs_maxsymlinklen; /* max length of an internal symlink */ 134 }; 135 136 /* 137 * Inode 0 is the out-of-band inode number, inode 1 is the inode number for 138 * the IFILE, the root inode is 2 and the lost+found inode is 3. 139 */ 140 141 /* Fixed inode numbers. */ 142 #define LFS_UNUSED_INUM 0 /* out of band inode number */ 143 #define LFS_IFILE_INUM 1 /* IFILE inode number */ 144 #define LOSTFOUNDINO 3 /* lost+found inode number */ 145 #define LFS_FIRST_INUM 4 /* first free inode number */ 146 147 /* Address calculations for metadata located in the inode */ 148 #define S_INDIR(fs) -NDADDR 149 #define D_INDIR(fs) (S_INDIR(fs) - NINDIR(fs) - 1) 150 #define T_INDIR(fs) (D_INDIR(fs) - NINDIR(fs) * NINDIR(fs) - 1) 151 152 /* Unassigned disk address. */ 153 #define UNASSIGNED -1 154 155 /* Unused logical block number */ 156 #define LFS_UNUSED_LBN -1 157 158 typedef struct ifile IFILE; 159 struct ifile { 160 u_long if_version; /* inode version number */ 161 #define LFS_UNUSED_DADDR 0 /* out-of-band daddr */ 162 daddr_t if_daddr; /* inode disk address */ 163 ino_t if_nextfree; /* next-unallocated inode */ 164 }; 165 166 /* 167 * Cleaner information structure. This resides in the ifile and is used 168 * to pass information between the cleaner and the kernel. 169 */ 170 typedef struct _cleanerinfo { 171 u_long clean; /* K: number of clean segments */ 172 u_long dirty; /* K: number of dirty segments */ 173 } CLEANERINFO; 174 175 #define CLEANSIZE_SU(fs) \ 176 ((sizeof(CLEANERINFO) + (fs)->lfs_bsize - 1) >> (fs)->lfs_bshift) 177 178 /* 179 * All summary blocks are the same size, so we can always read a summary 180 * block easily from a segment. 181 */ 182 #define LFS_SUMMARY_SIZE 512 183 184 /* On-disk segment summary information */ 185 typedef struct segsum SEGSUM; 186 struct segsum { 187 u_long ss_sumsum; /* check sum of summary block */ 188 u_long ss_datasum; /* check sum of data */ 189 daddr_t ss_next; /* next segment */ 190 u_long ss_create; /* creation time stamp */ 191 u_short ss_nfinfo; /* number of file info structures */ 192 u_short ss_ninos; /* number of inodes in summary */ 193 #define SS_DIROP 0x01 /* segment begins a dirop */ 194 #define SS_CONT 0x02 /* more partials to finish this write*/ 195 u_short ss_flags; /* used for directory operations */ 196 u_short ss_pad; /* extra space */ 197 /* FINFO's and inode daddr's... */ 198 }; 199 200 /* NINDIR is the number of indirects in a file system block. */ 201 #define NINDIR(fs) ((fs)->lfs_nindir) 202 203 /* INOPB is the number of inodes in a secondary storage block. */ 204 #define INOPB(fs) ((fs)->lfs_inopb) 205 206 #define blksize(fs) ((fs)->lfs_bsize) 207 #define blkoff(fs, loc) ((loc) & (fs)->lfs_bmask) 208 #define fsbtodb(fs, b) ((b) << (fs)->lfs_fsbtodb) 209 #define dbtofsb(fs, b) ((b) >> (fs)->lfs_fsbtodb) 210 #define lblkno(fs, loc) ((loc) >> (fs)->lfs_bshift) 211 #define lblktosize(fs, blk) ((blk) << (fs)->lfs_bshift) 212 #define numfrags(fs, loc) /* calculates (loc / fs->fs_fsize) */ \ 213 ((loc) >> (fs)->lfs_bshift) 214 215 #define datosn(fs, daddr) /* disk address to segment number */ \ 216 (((daddr) - (fs)->lfs_sboffs[0]) / fsbtodb((fs), (fs)->lfs_ssize)) 217 #define sntoda(fs, sn) /* segment number to disk address */ \ 218 ((daddr_t)((sn) * ((fs)->lfs_ssize << (fs)->lfs_fsbtodb) + \ 219 (fs)->lfs_sboffs[0])) 220 221 /* Read in the block with the cleaner info from the ifile. */ 222 #define LFS_CLEANERINFO(CP, F, BP) { \ 223 VTOI((F)->lfs_ivnode)->i_flag |= IN_ACCESS; \ 224 if (bread((F)->lfs_ivnode, \ 225 (daddr_t)0, (F)->lfs_bsize, NOCRED, &(BP))) \ 226 panic("lfs: ifile read"); \ 227 (CP) = (CLEANERINFO *)(BP)->b_data; \ 228 } 229 230 /* Read in the block with a specific inode from the ifile. */ 231 #define LFS_IENTRY(IP, F, IN, BP) { \ 232 int _e; \ 233 VTOI((F)->lfs_ivnode)->i_flag |= IN_ACCESS; \ 234 if (_e = bread((F)->lfs_ivnode, \ 235 (IN) / (F)->lfs_ifpb + (F)->lfs_cleansz + (F)->lfs_segtabsz,\ 236 (F)->lfs_bsize, NOCRED, &(BP))) \ 237 panic("lfs: ifile read %d", _e); \ 238 (IP) = (IFILE *)(BP)->b_data + (IN) % (F)->lfs_ifpb; \ 239 } 240 241 /* Read in the block with a specific segment usage entry from the ifile. */ 242 #define LFS_SEGENTRY(SP, F, IN, BP) { \ 243 int _e; \ 244 VTOI((F)->lfs_ivnode)->i_flag |= IN_ACCESS; \ 245 if (_e = bread((F)->lfs_ivnode, \ 246 ((IN) >> (F)->lfs_sushift) + (F)->lfs_cleansz, \ 247 (F)->lfs_bsize, NOCRED, &(BP))) \ 248 panic("lfs: ifile read: %d", _e); \ 249 (SP) = (SEGUSE *)(BP)->b_data + ((IN) & (F)->lfs_sepb - 1); \ 250 } 251 252 /* 253 * Determine if there is enough room currently available to write db 254 * disk blocks. We need enough blocks for the new blocks, the current, 255 * inode blocks, a summary block, plus potentially the ifile inode and 256 * the segment usage table, plus an ifile page. 257 */ 258 #define LFS_FITS(fs, db) \ 259 ((long)((db + ((fs)->lfs_uinodes + INOPB((fs))) / INOPB((fs)) + \ 260 fsbtodb(fs, 1) + LFS_SUMMARY_SIZE / DEV_BSIZE + \ 261 (fs)->lfs_segtabsz)) < (fs)->lfs_avail) 262 263 /* Determine if a buffer belongs to the ifile */ 264 #define IS_IFILE(bp) (VTOI(bp->b_vp)->i_number == LFS_IFILE_INUM) 265 266 /* 267 * Structures used by lfs_bmapv and lfs_markv to communicate information 268 * about inodes and data blocks. 269 */ 270 typedef struct block_info { 271 ino_t bi_inode; /* inode # */ 272 daddr_t bi_lbn; /* logical block w/in file */ 273 daddr_t bi_daddr; /* disk address of block */ 274 time_t bi_segcreate; /* origin segment create time */ 275 int bi_version; /* file version number */ 276 void *bi_bp; /* data buffer */ 277 } BLOCK_INFO; 278 279 /* In-memory description of a segment about to be written. */ 280 struct segment { 281 struct lfs *fs; /* file system pointer */ 282 struct buf **bpp; /* pointer to buffer array */ 283 struct buf **cbpp; /* pointer to next available bp */ 284 struct buf **start_bpp; /* pointer to first bp in this set */ 285 struct buf *ibp; /* buffer pointer to inode page */ 286 struct finfo *fip; /* current fileinfo pointer */ 287 struct vnode *vp; /* vnode being gathered */ 288 void *segsum; /* segment summary info */ 289 u_long ninodes; /* number of inodes in this segment */ 290 u_long seg_bytes_left; /* bytes left in segment */ 291 u_long sum_bytes_left; /* bytes left in summary block */ 292 u_long seg_number; /* number of this segment */ 293 daddr_t *start_lbp; /* beginning lbn for this set */ 294 #define SEGM_CKP 0x01 /* doing a checkpoint */ 295 #define SEGM_CLEAN 0x02 /* cleaner call; don't sort */ 296 #define SEGM_SYNC 0x04 /* wait for segment */ 297 u_long seg_flags; /* run-time flags for this segment */ 298 }; 299 300 #define ISSPACE(F, BB, C) \ 301 (((C)->cr_uid == 0 && (F)->lfs_bfree >= (BB)) || \ 302 ((C)->cr_uid != 0 && IS_FREESPACE(F, BB))) 303 304 #define IS_FREESPACE(F, BB) \ 305 ((F)->lfs_bfree > ((F)->lfs_dsize * (F)->lfs_minfree / 100 + (BB))) 306 307 #define ISSPACE_XXX(F, BB) \ 308 ((F)->lfs_bfree >= (BB)) 309 310 #define DOSTATS 311 #ifdef DOSTATS 312 /* Statistics Counters */ 313 struct lfs_stats { 314 int segsused; 315 int psegwrites; 316 int psyncwrites; 317 int pcleanwrites; 318 int blocktot; 319 int cleanblocks; 320 int ncheckpoints; 321 int nwrites; 322 int nsync_writes; 323 int wait_exceeded; 324 int write_exceeded; 325 int flush_invoked; 326 }; 327 extern struct lfs_stats lfs_stats; 328 #endif 329