1 /* $NetBSD: lfs.h,v 1.219 2026/01/05 05:02:47 perseant Exp $ */ 2 3 /* from NetBSD: dinode.h,v 1.25 2016/01/22 23:06:10 dholland Exp */ 4 /* from NetBSD: dir.h,v 1.25 2015/09/01 06:16:03 dholland Exp */ 5 6 /*- 7 * Copyright (c) 1999, 2000, 2001, 2002, 2003 The NetBSD Foundation, Inc. 8 * All rights reserved. 9 * 10 * This code is derived from software contributed to The NetBSD Foundation 11 * by Konrad E. Schroder <perseant (at) hhhh.org>. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32 * POSSIBILITY OF SUCH DAMAGE. 33 */ 34 /*- 35 * Copyright (c) 1991, 1993 36 * The Regents of the University of California. All rights reserved. 37 * 38 * Redistribution and use in source and binary forms, with or without 39 * modification, are permitted provided that the following conditions 40 * are met: 41 * 1. Redistributions of source code must retain the above copyright 42 * notice, this list of conditions and the following disclaimer. 43 * 2. Redistributions in binary form must reproduce the above copyright 44 * notice, this list of conditions and the following disclaimer in the 45 * documentation and/or other materials provided with the distribution. 46 * 3. Neither the name of the University nor the names of its contributors 47 * may be used to endorse or promote products derived from this software 48 * without specific prior written permission. 49 * 50 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 53 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 54 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 60 * SUCH DAMAGE. 61 * 62 * @(#)lfs.h 8.9 (Berkeley) 5/8/95 63 */ 64 /* 65 * Copyright (c) 2002 Networks Associates Technology, Inc. 66 * All rights reserved. 67 * 68 * This software was developed for the FreeBSD Project by Marshall 69 * Kirk McKusick and Network Associates Laboratories, the Security 70 * Research Division of Network Associates, Inc. under DARPA/SPAWAR 71 * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS 72 * research program 73 * 74 * Copyright (c) 1982, 1989, 1993 75 * The Regents of the University of California. All rights reserved. 76 * (c) UNIX System Laboratories, Inc. 77 * All or some portions of this file are derived from material licensed 78 * to the University of California by American Telephone and Telegraph 79 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 80 * the permission of UNIX System Laboratories, Inc. 81 * 82 * Redistribution and use in source and binary forms, with or without 83 * modification, are permitted provided that the following conditions 84 * are met: 85 * 1. Redistributions of source code must retain the above copyright 86 * notice, this list of conditions and the following disclaimer. 87 * 2. Redistributions in binary form must reproduce the above copyright 88 * notice, this list of conditions and the following disclaimer in the 89 * documentation and/or other materials provided with the distribution. 90 * 3. Neither the name of the University nor the names of its contributors 91 * may be used to endorse or promote products derived from this software 92 * without specific prior written permission. 93 * 94 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 95 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 96 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 97 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 98 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 99 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 100 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 101 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 102 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 103 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 104 * SUCH DAMAGE. 105 * 106 * @(#)dinode.h 8.9 (Berkeley) 3/29/95 107 */ 108 /* 109 * Copyright (c) 1982, 1986, 1989, 1993 110 * The Regents of the University of California. All rights reserved. 111 * (c) UNIX System Laboratories, Inc. 112 * All or some portions of this file are derived from material licensed 113 * to the University of California by American Telephone and Telegraph 114 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 115 * the permission of UNIX System Laboratories, Inc. 116 * 117 * Redistribution and use in source and binary forms, with or without 118 * modification, are permitted provided that the following conditions 119 * are met: 120 * 1. Redistributions of source code must retain the above copyright 121 * notice, this list of conditions and the following disclaimer. 122 * 2. Redistributions in binary form must reproduce the above copyright 123 * notice, this list of conditions and the following disclaimer in the 124 * documentation and/or other materials provided with the distribution. 125 * 3. Neither the name of the University nor the names of its contributors 126 * may be used to endorse or promote products derived from this software 127 * without specific prior written permission. 128 * 129 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 130 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 131 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 132 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 133 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 134 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 135 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 136 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 137 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 138 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 139 * SUCH DAMAGE. 140 * 141 * @(#)dir.h 8.5 (Berkeley) 4/27/95 142 */ 143 144 /* 145 * NOTE: COORDINATE ON-DISK FORMAT CHANGES WITH THE FREEBSD PROJECT. 146 */ 147 148 #ifndef _UFS_LFS_LFS_H_ 149 #define _UFS_LFS_LFS_H_ 150 151 #if !defined(_KERNEL) && !defined(_STANDALONE) 152 #include <stddef.h> /* for offsetof */ 153 #endif 154 155 #include <sys/rwlock.h> 156 #include <sys/mutex.h> 157 #include <sys/queue.h> 158 #include <sys/condvar.h> 159 #include <sys/mount.h> 160 #include <sys/pool.h> 161 #include <sys/rbtree.h> 162 163 /* 164 * Compile-time options for LFS. 165 */ 166 #define LFS_IFIND_RETRIES 16 167 #define LFS_LOGLENGTH 1024 /* size of debugging log */ 168 #define LFS_MAX_ACTIVE 10 /* Dirty segments before ckp forced */ 169 170 /* 171 * Fixed filesystem layout parameters 172 */ 173 #define LFS_LABELPAD 8192 /* LFS label size */ 174 #define LFS_SBPAD 8192 /* LFS superblock size */ 175 176 #define LFS_UNUSED_INUM 0 /* 0: out of band inode number */ 177 #define LFS_IFILE_INUM 1 /* 1: IFILE inode number */ 178 /* 2: Root inode number */ 179 #define LFS_LOSTFOUNDINO 3 /* 3: lost+found inode number */ 180 #define LFS_FIRST_INUM 4 /* 4: first free inode number */ 181 182 /* 183 * The root inode is the root of the file system. Inode 0 can't be used for 184 * normal purposes and historically bad blocks were linked to inode 1, thus 185 * the root inode is 2. (Inode 1 is no longer used for this purpose, however 186 * numerous dump tapes make this assumption, so we are stuck with it). 187 */ 188 #define ULFS_ROOTINO ((ino_t)2) 189 190 /* 191 * The Whiteout inode# is a dummy non-zero inode number which will 192 * never be allocated to a real file. It is used as a place holder 193 * in the directory entry which has been tagged as a LFS_DT_WHT entry. 194 * See the comments about ULFS_ROOTINO above. 195 */ 196 #define ULFS_WINO ((ino_t)1) 197 198 199 #define LFS_V1_SUMMARY_SIZE 512 /* V1 fixed summary size */ 200 #define LFS_DFL_SUMMARY_SIZE 512 /* Default summary size */ 201 202 #define LFS_MAXNAMLEN 255 /* maximum name length in a dir */ 203 204 #define ULFS_NXADDR 2 205 #define ULFS_NDADDR 12 /* Direct addresses in inode. */ 206 #define ULFS_NIADDR 3 /* Indirect addresses in inode. */ 207 208 /* 209 * Adjustable filesystem parameters 210 */ 211 #ifndef LFS_ATIME_IFILE 212 # define LFS_ATIME_IFILE 0 /* Store atime info in ifile (optional in LFSv1) */ 213 #endif 214 215 /* 216 * Directories 217 */ 218 219 /* 220 * Directories in LFS are files; they use the same inode and block 221 * mapping structures that regular files do. The directory per se is 222 * manifested in the file contents: an unordered, unstructured 223 * sequence of variable-size directory entries. 224 * 225 * This format and structure is taken (via what was originally shared 226 * ufs-level code) from FFS. Each directory entry is a fixed header 227 * followed by a string, the total length padded to a 4-byte boundary. 228 * All strings include a null terminator; the maximum string length 229 * is LFS_MAXNAMLEN, which is 255. 230 * 231 * The directory entry header structure (struct lfs_dirheader) is just 232 * the header information. A complete entry is this plus a null- 233 * terminated name following it, plus some amount of padding. The 234 * length of the name (not including the null terminator) is given by 235 * the namlen field of the header; the complete record length, 236 * including the null terminator and padding, is given by the reclen 237 * field of the header. The record length is always 4-byte aligned. 238 * (Even on 64-bit volumes, the record length is only 4-byte aligned, 239 * not 8-byte.) 240 * 241 * Historically, FFS directories were/are organized into blocks of 242 * size DIRBLKSIZE that can be written atomically to disk at the 243 * hardware level. Directory entries are not allowed to cross the 244 * boundaries of these blocks. The resulting atomicity is important 245 * for the integrity of FFS volumes; however, for LFS it's irrelevant. 246 * All we have to care about is not writing out directories that 247 * confuse earlier ufs-based versions of the LFS code. 248 * 249 * This means [to be determined]. (XXX) 250 * 251 * As DIRBLKSIZE in its FFS sense is hardware-dependent, and file 252 * system images do from time to time move to different hardware, code 253 * that reads directories should be prepared to handle directories 254 * written in a context where DIRBLKSIZE was different (smaller or 255 * larger) than its current value. Note however that it is not 256 * sensible for DIRBLKSIZE to be larger than the volume fragment size, 257 * and not practically possible for it to be larger than the volume 258 * block size. 259 * 260 * Some further notes: 261 * - the LFS_DIRSIZ macro provides the minimum space needed to hold 262 * a directory entry. 263 * - any particular entry may be arbitrarily larger (which is why the 264 * header stores both the entry size and the name size) to pad out 265 * unused space. 266 * - historically the padding in an entry is not necessarily zeroed 267 * but may contain trash. 268 * - dp->d_reclen is the size of the entry. This is always 4-byte 269 * aligned. 270 * - dp->d_namlen is the length of the string, and should always be 271 * the same as strlen(dp->d_name). 272 * - in particular, space available in an entry is given by 273 * dp->d_reclen - LFS_DIRSIZ(dp), and all space available within a 274 * directory block is tucked away within an existing entry. 275 * - all space within a directory block is part of some entry. 276 * - therefore, inserting a new entry requires finding and 277 * splitting a suitable existing entry, and when entries are 278 * removed their space is merged into the entry ahead of them. 279 * - an empty/unused entry has d_ino set to 0. This normally only 280 * appears in the first entry in a block, as elsewhere the unused 281 * entry should have been merged into the one before it. However, 282 * fsck leaves such entries behind so they must be tolerated 283 * elsewhere. 284 * - a completely empty directory block has one entry whose 285 * d_reclen is DIRBLKSIZ and whose d_ino is 0. 286 * 287 * The "old directory format" referenced by the fs->lfs_isolddirfmt 288 * flag (and some other things) refers to when the type field was 289 * added to directory entries. This change was made to FFS in the 80s, 290 * well before LFS was first written; there should be no LFS volumes 291 * (and certainly no LFS v2-format volumes or LFS64 volumes) where the 292 * old format pertains. All of the related logic should probably be 293 * removed; however, it hasn't been yet, and we get to carry it around 294 * until we can be conclusively sure it isn't needed. 295 * 296 * In the "old directory format" there is no type field and the namlen 297 * field is correspondingly 16 bits wide. On big-endian volumes this 298 * has no effect: namlen cannot exceed 255, so the upper byte is 299 * always 0 and this reads back from the type field as LFS_DT_UNKNOWN. 300 * On little-endian volumes, the namlen field will always be 0 and 301 * the namlen value needs to be read out of the type field. (The type 302 * is always LFS_DT_UNKNOWN.) The directory accessor functions take 303 * care of this so nothing else needs to be aware of it. 304 * 305 * LFS_OLDDIRFMT and LFS_NEWDIRFMT are code numbers for the old and 306 * new directory format respectively. These codes do not appear on 307 * disk; they're generated from a runtime macro called FSFMT() that's 308 * cued by other things. This is why (confusingly) LFS_OLDDIRFMT is 1 309 * and LFS_NEWDIRFMT is 0. 310 * 311 * FSFMT(), LFS_OLDDIRFMT, and LFS_NEWDIRFMT should be removed. (XXX) 312 */ 313 314 /* 315 * Directory block size. 316 */ 317 #undef LFS_DIRBLKSIZ 318 #define LFS_DIRBLKSIZ DEV_BSIZE 319 320 /* 321 * Convert between stat structure type codes and directory entry type codes. 322 */ 323 #define LFS_IFTODT(mode) (((mode) & 0170000) >> 12) 324 #define LFS_DTTOIF(dirtype) ((dirtype) << 12) 325 326 /* 327 * Theoretically, directories can be more than 2Gb in length; however, in 328 * practice this seems unlikely. So, we define the type doff_t as a 32-bit 329 * quantity to keep down the cost of doing lookup on a 32-bit machine. 330 */ 331 #define doff_t int32_t 332 #define lfs_doff_t int32_t 333 #define LFS_MAXDIRSIZE (0x7fffffff) 334 335 /* 336 * File types for d_type 337 */ 338 #define LFS_DT_UNKNOWN 0 339 #define LFS_DT_FIFO 1 340 #define LFS_DT_CHR 2 341 #define LFS_DT_DIR 4 342 #define LFS_DT_BLK 6 343 #define LFS_DT_REG 8 344 #define LFS_DT_LNK 10 345 #define LFS_DT_SOCK 12 346 #define LFS_DT_WHT 14 347 348 /* 349 * (See notes above) 350 */ 351 352 struct lfs_dirheader32 { 353 uint32_t dh_ino; /* inode number of entry */ 354 uint16_t dh_reclen; /* length of this record */ 355 uint8_t dh_type; /* file type, see below */ 356 uint8_t dh_namlen; /* length of string in d_name */ 357 }; 358 __CTASSERT(sizeof(struct lfs_dirheader32) == 8); 359 360 struct lfs_dirheader64 { 361 uint64_t dh_ino; /* inode number of entry */ 362 uint16_t dh_reclen; /* length of this record */ 363 uint8_t dh_type; /* file type, see below */ 364 uint8_t dh_namlen; /* length of string in d_name */ 365 } __aligned(4) __packed; 366 __CTASSERT(sizeof(struct lfs_dirheader64) == 12); 367 368 union lfs_dirheader { 369 struct lfs_dirheader64 u_64; 370 struct lfs_dirheader32 u_32; 371 }; 372 __CTASSERT(__alignof(union lfs_dirheader) == __alignof(struct lfs_dirheader64)); 373 #ifndef __lint__ 374 __CTASSERT(__alignof(union lfs_dirheader) == __alignof(struct lfs_dirheader32)); 375 #endif 376 377 typedef union lfs_dirheader LFS_DIRHEADER; 378 379 /* 380 * Template for manipulating directories. 381 */ 382 383 struct lfs_dirtemplate32 { 384 struct lfs_dirheader32 dot_header; 385 char dot_name[4]; /* must be multiple of 4 */ 386 struct lfs_dirheader32 dotdot_header; 387 char dotdot_name[4]; /* ditto */ 388 }; 389 __CTASSERT(sizeof(struct lfs_dirtemplate32) == 2*(8 + 4)); 390 391 struct lfs_dirtemplate64 { 392 struct lfs_dirheader64 dot_header; 393 char dot_name[4]; /* must be multiple of 4 */ 394 struct lfs_dirheader64 dotdot_header; 395 char dotdot_name[4]; /* ditto */ 396 }; 397 __CTASSERT(sizeof(struct lfs_dirtemplate64) == 2*(12 + 4)); 398 399 union lfs_dirtemplate { 400 struct lfs_dirtemplate64 u_64; 401 struct lfs_dirtemplate32 u_32; 402 }; 403 404 #if 0 405 /* 406 * This is the old format of directories, sans type element. 407 */ 408 struct lfs_odirtemplate { 409 uint32_t dot_ino; 410 int16_t dot_reclen; 411 uint16_t dot_namlen; 412 char dot_name[4]; /* must be multiple of 4 */ 413 uint32_t dotdot_ino; 414 int16_t dotdot_reclen; 415 uint16_t dotdot_namlen; 416 char dotdot_name[4]; /* ditto */ 417 }; 418 __CTASSERT(sizeof(struct lfs_odirtemplate) == 2*(8 + 4)); 419 #endif 420 421 /* 422 * Inodes 423 */ 424 425 /* 426 * A dinode contains all the meta-data associated with a LFS file. 427 * This structure defines the on-disk format of a dinode. Since 428 * this structure describes an on-disk structure, all its fields 429 * are defined by types with precise widths. 430 */ 431 432 struct lfs32_dinode { 433 uint16_t di_mode; /* 0: IFMT, permissions; see below. */ 434 int16_t di_nlink; /* 2: File link count. */ 435 uint32_t di_inumber; /* 4: Inode number. */ 436 uint64_t di_size; /* 8: File byte count. */ 437 int32_t di_atime; /* 16: Last access time. */ 438 int32_t di_atimensec; /* 20: Last access time. */ 439 int32_t di_mtime; /* 24: Last modified time. */ 440 int32_t di_mtimensec; /* 28: Last modified time. */ 441 int32_t di_ctime; /* 32: Last inode change time. */ 442 int32_t di_ctimensec; /* 36: Last inode change time. */ 443 int32_t di_db[ULFS_NDADDR]; /* 40: Direct disk blocks. */ 444 int32_t di_ib[ULFS_NIADDR]; /* 88: Indirect disk blocks. */ 445 uint32_t di_flags; /* 100: Status flags (chflags). */ 446 uint32_t di_blocks; /* 104: Blocks actually held. */ 447 int32_t di_gen; /* 108: Generation number. */ 448 uint32_t di_uid; /* 112: File owner. */ 449 uint32_t di_gid; /* 116: File group. */ 450 uint64_t di_modrev; /* 120: i_modrev for NFSv4 */ 451 }; 452 __CTASSERT(sizeof(struct lfs32_dinode) == 128); 453 454 struct lfs64_dinode { 455 uint16_t di_mode; /* 0: IFMT, permissions; see below. */ 456 int16_t di_nlink; /* 2: File link count. */ 457 uint32_t di_uid; /* 4: File owner. */ 458 uint32_t di_gid; /* 8: File group. */ 459 uint32_t di_blksize; /* 12: Inode blocksize. */ 460 uint64_t di_size; /* 16: File byte count. */ 461 uint64_t di_blocks; /* 24: Bytes actually held. */ 462 int64_t di_atime; /* 32: Last access time. */ 463 int64_t di_mtime; /* 40: Last modified time. */ 464 int64_t di_ctime; /* 48: Last inode change time. */ 465 int64_t di_birthtime; /* 56: Inode creation time. */ 466 int32_t di_mtimensec; /* 64: Last modified time. */ 467 int32_t di_atimensec; /* 68: Last access time. */ 468 int32_t di_ctimensec; /* 72: Last inode change time. */ 469 int32_t di_birthnsec; /* 76: Inode creation time. */ 470 int32_t di_gen; /* 80: Generation number. */ 471 uint32_t di_kernflags; /* 84: Kernel flags. */ 472 uint32_t di_flags; /* 88: Status flags (chflags). */ 473 int32_t di_extsize; /* 92: External attributes block. */ 474 int64_t di_extb[ULFS_NXADDR];/* 96: External attributes block. */ 475 int64_t di_db[ULFS_NDADDR]; /* 112: Direct disk blocks. */ 476 int64_t di_ib[ULFS_NIADDR]; /* 208: Indirect disk blocks. */ 477 uint64_t di_modrev; /* 232: i_modrev for NFSv4 */ 478 uint64_t di_inumber; /* 240: Inode number */ 479 uint64_t di_spare[1]; /* 248: Reserved; currently unused */ 480 }; 481 __CTASSERT(sizeof(struct lfs64_dinode) == 256); 482 483 union lfs_dinode { 484 struct lfs64_dinode u_64; 485 struct lfs32_dinode u_32; 486 }; 487 __CTASSERT(__alignof(union lfs_dinode) == __alignof(struct lfs64_dinode)); 488 __CTASSERT(__alignof(union lfs_dinode) == __alignof(struct lfs32_dinode)); 489 490 /* 491 * The di_db fields may be overlaid with other information for 492 * file types that do not have associated disk storage. Block 493 * and character devices overlay the first data block with their 494 * dev_t value. Short symbolic links place their path in the 495 * di_db area. 496 */ 497 #define di_rdev di_db[0] 498 499 /* Size of the on-disk inode. */ 500 //#define LFS_DINODE1_SIZE (sizeof(struct ulfs1_dinode)) /* 128 */ 501 //#define LFS_DINODE2_SIZE (sizeof(struct ulfs2_dinode)) 502 503 /* File types, found in the upper bits of di_mode. */ 504 #define LFS_IFMT 0170000 /* Mask of file type. */ 505 #define LFS_IFIFO 0010000 /* Named pipe (fifo). */ 506 #define LFS_IFCHR 0020000 /* Character device. */ 507 #define LFS_IFDIR 0040000 /* Directory file. */ 508 #define LFS_IFBLK 0060000 /* Block device. */ 509 #define LFS_IFREG 0100000 /* Regular file. */ 510 #define LFS_IFLNK 0120000 /* Symbolic link. */ 511 #define LFS_IFSOCK 0140000 /* UNIX domain socket. */ 512 #define LFS_IFWHT 0160000 /* Whiteout. */ 513 514 /* 515 * "struct buf" associated definitions 516 */ 517 518 /* Unassigned disk addresses. */ 519 #define UNASSIGNED -1 520 #define UNWRITTEN -2 521 522 /* Unused logical block number */ 523 #define LFS_UNUSED_LBN -1 524 525 /* 526 * On-disk and in-memory checkpoint segment usage structure. 527 */ 528 typedef struct segusage SEGUSE; 529 struct segusage { 530 uint32_t su_nbytes; /* 0: number of live bytes */ 531 uint32_t su_olastmod; /* 4: SEGUSE last modified timestamp */ 532 uint16_t su_nsums; /* 8: number of summaries in segment */ 533 uint16_t su_ninos; /* 10: number of inode blocks in seg */ 534 535 #define SEGUSE_ACTIVE 0x01 /* segment currently being written */ 536 #define SEGUSE_DIRTY 0x02 /* segment has data in it */ 537 #define SEGUSE_SUPERBLOCK 0x04 /* segment contains a superblock */ 538 #define SEGUSE_ERROR 0x08 /* cleaner: do not clean segment */ 539 #define SEGUSE_EMPTY 0x10 /* segment is empty */ 540 #define SEGUSE_INVAL 0x20 /* segment is invalid */ 541 #define SEGUSE_READY 0x40 /* segment is ready for reclaim */ 542 uint32_t su_flags; /* 12: segment flags */ 543 uint64_t su_lastmod; /* 16: last modified timestamp */ 544 }; 545 __CTASSERT(sizeof(struct segusage) == 24); 546 547 typedef struct segusage_v1 SEGUSE_V1; 548 struct segusage_v1 { 549 uint32_t su_nbytes; /* 0: number of live bytes */ 550 uint32_t su_lastmod; /* 4: SEGUSE last modified timestamp */ 551 uint16_t su_nsums; /* 8: number of summaries in segment */ 552 uint16_t su_ninos; /* 10: number of inode blocks in seg */ 553 uint32_t su_flags; /* 12: segment flags */ 554 }; 555 __CTASSERT(sizeof(struct segusage_v1) == 16); 556 557 /* 558 * On-disk file information. One per file with data blocks in the segment. 559 * 560 * The FINFO structure is a header; it is followed by fi_nblocks block 561 * pointers, which are logical block numbers of the file. (These are the 562 * blocks of the file present in this segment.) 563 */ 564 565 typedef struct finfo64 FINFO64; 566 struct finfo64 { 567 uint32_t fi_nblocks; /* number of blocks */ 568 uint32_t fi_version; /* version number */ 569 uint64_t fi_ino; /* inode number */ 570 uint32_t fi_lastlength; /* length of last block in array */ 571 uint32_t fi_pad; /* unused */ 572 } __aligned(4) __packed; 573 __CTASSERT(sizeof(struct finfo64) == 24); 574 575 typedef struct finfo32 FINFO32; 576 struct finfo32 { 577 uint32_t fi_nblocks; /* number of blocks */ 578 uint32_t fi_version; /* version number */ 579 uint32_t fi_ino; /* inode number */ 580 uint32_t fi_lastlength; /* length of last block in array */ 581 }; 582 __CTASSERT(sizeof(struct finfo32) == 16); 583 584 typedef union finfo { 585 struct finfo64 u_64; 586 struct finfo32 u_32; 587 } FINFO; 588 __CTASSERT(__alignof(union finfo) == __alignof(struct finfo64)); 589 #ifndef __lint__ 590 __CTASSERT(__alignof(union finfo) == __alignof(struct finfo32)); 591 #endif 592 593 /* 594 * inode info (part of the segment summary) 595 * 596 * Each one of these is just a block number; wrapping the structure 597 * around it gives more contextual information in the code about 598 * what's going on. 599 */ 600 601 typedef struct iinfo64 { 602 uint64_t ii_block; /* block number */ 603 } __aligned(4) __packed IINFO64; 604 __CTASSERT(sizeof(struct iinfo64) == 8); 605 606 typedef struct iinfo32 { 607 uint32_t ii_block; /* block number */ 608 } IINFO32; 609 __CTASSERT(sizeof(struct iinfo32) == 4); 610 611 typedef union iinfo { 612 struct iinfo64 u_64; 613 struct iinfo32 u_32; 614 } IINFO; 615 __CTASSERT(__alignof(union iinfo) == __alignof(struct iinfo64)); 616 #ifndef __lint__ 617 __CTASSERT(__alignof(union iinfo) == __alignof(struct iinfo32)); 618 #endif 619 620 /* 621 * Index file inode entries. 622 */ 623 624 /* magic values for daddrs */ 625 #define LFS_UNUSED_DADDR 0 /* out-of-band daddr */ 626 #ifdef DEBUG 627 # define LFS_ILLEGAL_DADDR -1 /* out-of-band daddr */ 628 # define DADDR_IS_BAD(daddr) \ 629 ((daddr) == LFS_UNUSED_DADDR || (daddr) == LFS_ILLEGAL_DADDR) 630 #else /* ! DEBUG */ 631 # define LFS_ILLEGAL_DADDR LFS_UNUSED_DADDR 632 # define DADDR_IS_BAD(daddr) ((daddr) == LFS_UNUSED_DADDR) 633 #endif /* ! DEBUG */ 634 635 /* magic value for if_nextfree -- indicate orphaned file */ 636 #define LFS_ORPHAN_NEXTFREE(fs) \ 637 ((fs)->lfs_is64 ? ~(uint64_t)0 : ~(uint32_t)0) 638 639 #define INUM_IS_BAD(fs, ino) \ 640 (ino == LFS_UNUSED_INUM || ino == LFS_ORPHAN_NEXTFREE(fs)) 641 642 typedef struct ifile64 IFILE64; 643 struct ifile64 { 644 uint32_t if_version; /* inode version number */ 645 uint32_t if_atime_nsec; /* and nanoseconds */ 646 uint64_t if_atime_sec; /* Last access time, seconds */ 647 int64_t if_daddr; /* inode disk address */ 648 uint64_t if_nextfree; /* next-unallocated inode */ 649 } __aligned(4) __packed; 650 __CTASSERT(sizeof(struct ifile64) == 32); 651 652 typedef struct ifile32 IFILE32; 653 struct ifile32 { 654 uint32_t if_version; /* inode version number */ 655 int32_t if_daddr; /* inode disk address */ 656 uint32_t if_nextfree; /* next-unallocated inode */ 657 uint32_t if_atime_sec; /* Last access time, seconds */ 658 uint32_t if_atime_nsec; /* and nanoseconds */ 659 }; 660 __CTASSERT(sizeof(struct ifile32) == 20); 661 662 typedef struct ifile_v1 IFILE_V1; 663 struct ifile_v1 { 664 uint32_t if_version; /* inode version number */ 665 int32_t if_daddr; /* inode disk address */ 666 uint32_t if_nextfree; /* next-unallocated inode */ 667 #if LFS_ATIME_IFILE 668 #error "this cannot work" 669 struct timespec if_atime; /* Last access time */ 670 #endif 671 }; 672 __CTASSERT(sizeof(struct ifile_v1) == 12); 673 674 /* 675 * Note: struct ifile_v1 is often handled by accessing the first three 676 * fields of struct ifile32. (XXX: Blah. This should be cleaned up as 677 * it may in some cases violate the strict-aliasing rules.) 678 */ 679 typedef union ifile { 680 struct ifile64 u_64; 681 struct ifile32 u_32; 682 struct ifile_v1 u_v1; 683 } IFILE; 684 __CTASSERT(__alignof(union ifile) == __alignof(struct ifile64)); 685 #ifndef __lint__ 686 __CTASSERT(__alignof(union ifile) == __alignof(struct ifile32)); 687 __CTASSERT(__alignof(union ifile) == __alignof(struct ifile_v1)); 688 #endif 689 690 /* 691 * Cleaner information structure. This resides in the ifile and is used 692 * to pass information from the kernel to the cleaner. 693 */ 694 695 /* flags for ->flags */ 696 #define LFS_CLEANER_MUST_CLEAN 0x01 697 698 typedef struct _cleanerinfo32 { 699 uint32_t clean; /* 0: number of clean segments */ 700 uint32_t dirty; /* 4: number of dirty segments */ 701 int32_t bfree; /* 8: disk blocks free */ 702 int32_t avail; /* 12: disk blocks available */ 703 uint32_t free_head; /* 16: head of the inode free list */ 704 uint32_t free_tail; /* 20: tail of the inode free list */ 705 uint32_t flags; /* 24: status word from the kernel */ 706 } CLEANERINFO32; 707 __CTASSERT(sizeof(struct _cleanerinfo32) == 28); 708 709 typedef struct _cleanerinfo64 { 710 uint32_t clean; /* 0: number of clean segments */ 711 uint32_t dirty; /* 4: number of dirty segments */ 712 int64_t bfree; /* 8: disk blocks free */ 713 int64_t avail; /* 16: disk blocks available */ 714 uint64_t free_head; /* 24: head of the inode free list */ 715 uint64_t free_tail; /* 32: tail of the inode free list */ 716 uint32_t flags; /* 40: status word from the kernel */ 717 uint32_t pad; /* 44: must be 64-bit aligned */ 718 } __aligned(4) __packed CLEANERINFO64; 719 __CTASSERT(sizeof(struct _cleanerinfo64) == 48); 720 721 /* this must not go to disk directly of course */ 722 typedef union _cleanerinfo { 723 CLEANERINFO32 u_32; 724 CLEANERINFO64 u_64; 725 } CLEANERINFO; 726 #ifndef __lint__ 727 __CTASSERT(__alignof(union _cleanerinfo) == __alignof(struct _cleanerinfo32)); 728 __CTASSERT(__alignof(union _cleanerinfo) == __alignof(struct _cleanerinfo64)); 729 #endif 730 731 /* 732 * On-disk segment summary information 733 */ 734 735 /* magic value for ss_magic */ 736 #define SS_MAGIC 0x061561 737 738 /* flags for ss_flags */ 739 #define SS_DIROP 0x01 /* segment begins a dirop */ 740 #define SS_CONT 0x02 /* more partials to finish this write*/ 741 #define SS_CLEAN 0x04 /* written by the cleaner */ 742 #define SS_RFW 0x08 /* written by the roll-forward agent */ 743 #define SS_RECLAIM 0x10 /* written by the roll-forward agent */ 744 745 /* type used for reading checksum signatures from metadata structures */ 746 typedef uint32_t lfs_checkword; 747 748 typedef struct segsum_v1 SEGSUM_V1; 749 struct segsum_v1 { 750 uint32_t ss_sumsum; /* 0: check sum of summary block */ 751 uint32_t ss_datasum; /* 4: check sum of data */ 752 uint32_t ss_magic; /* 8: segment summary magic number */ 753 int32_t ss_next; /* 12: next segment */ 754 uint32_t ss_create; /* 16: creation time stamp */ 755 uint16_t ss_nfinfo; /* 20: number of file info structures */ 756 uint16_t ss_ninos; /* 22: number of inodes in summary */ 757 uint16_t ss_flags; /* 24: used for directory operations */ 758 uint16_t ss_pad; /* 26: extra space */ 759 /* FINFO's and inode daddr's... */ 760 }; 761 __CTASSERT(sizeof(struct segsum_v1) == 28); 762 763 typedef struct segsum32 SEGSUM32; 764 struct segsum32 { 765 uint32_t ss_sumsum; /* 0: check sum of summary block */ 766 uint32_t ss_datasum; /* 4: check sum of data */ 767 uint32_t ss_magic; /* 8: segment summary magic number */ 768 int32_t ss_next; /* 12: next segment (disk address) */ 769 uint32_t ss_ident; /* 16: roll-forward fsid */ 770 uint16_t ss_nfinfo; /* 20: number of file info structures */ 771 uint16_t ss_ninos; /* 22: number of inodes in summary */ 772 uint16_t ss_flags; /* 24: used for directory operations */ 773 uint8_t ss_pad[2]; /* 26: extra space */ 774 uint32_t ss_reclino; /* 28: inode being reclaimed */ 775 uint64_t ss_serial; /* 32: serial number */ 776 uint64_t ss_create; /* 40: time stamp */ 777 /* FINFO's and inode daddr's... */ 778 } __aligned(4) __packed; 779 __CTASSERT(sizeof(struct segsum32) == 48); 780 781 typedef struct segsum64 SEGSUM64; 782 struct segsum64 { 783 uint32_t ss_sumsum; /* 0: check sum of summary block */ 784 uint32_t ss_datasum; /* 4: check sum of data */ 785 uint32_t ss_magic; /* 8: segment summary magic number */ 786 uint32_t ss_ident; /* 12: roll-forward fsid */ 787 int64_t ss_next; /* 16: next segment (disk address) */ 788 uint16_t ss_nfinfo; /* 24: number of file info structures */ 789 uint16_t ss_ninos; /* 26: number of inodes in summary */ 790 uint16_t ss_flags; /* 28: used for directory operations */ 791 uint8_t ss_pad[2]; /* 30: extra space */ 792 uint64_t ss_reclino; /* 32: inode being reclaimed */ 793 uint64_t ss_serial; /* 40: serial number */ 794 uint64_t ss_create; /* 48: time stamp */ 795 /* FINFO's and inode daddr's... */ 796 } __aligned(4) __packed; 797 __CTASSERT(sizeof(struct segsum64) == 56); 798 799 typedef union segsum SEGSUM; 800 union segsum { 801 struct segsum64 u_64; 802 struct segsum32 u_32; 803 struct segsum_v1 u_v1; 804 }; 805 __CTASSERT(__alignof(union segsum) == __alignof(struct segsum64)); 806 __CTASSERT(__alignof(union segsum) == __alignof(struct segsum32)); 807 #ifndef __lint__ 808 __CTASSERT(__alignof(union segsum) == __alignof(struct segsum_v1)); 809 #endif 810 811 /* 812 * On-disk super block. 813 * 814 * We have separate superblock structures for the 32-bit and 64-bit 815 * LFS, and accessor functions to hide the differences. 816 * 817 * For lfs64, the format version is always 2; version 1 lfs is old. 818 * For both, the inode format version is 0; for lfs32 this selects the 819 * same 32-bit inode as always, and for lfs64 this selects the larger 820 * 64-bit inode structure we got from ffsv2. 821 * 822 * In lfs64: 823 * - inode numbers are 64 bit now 824 * - segments may not be larger than 4G (counted in bytes) 825 * - there may not be more than 2^32 (or perhaps 2^31) segments 826 * - the total volume size is limited to 2^63 frags and/or 2^63 827 * disk blocks, and probably in practice 2^63 bytes. 828 */ 829 830 #define LFS_MAGIC 0x070162 831 #define LFS_MAGIC_SWAPPED 0x62010700 832 833 #define LFS64_MAGIC (0x19620701 ^ 0xffffffff) 834 #define LFS64_MAGIC_SWAPPED (0x01076219 ^ 0xffffffff) 835 836 #define LFS_VERSION 2 837 838 #define LFS_MIN_SBINTERVAL 5 /* min superblock segment spacing */ 839 #define LFS_MAXNUMSB 10 /* max number of superblocks */ 840 841 /* flags for dlfs_pflags */ 842 #define LFS_PF_CLEAN 0x1 843 844 /* Inode format versions */ 845 #define LFS_44INODEFMT 0 846 #define LFS_MAXINODEFMT 0 847 848 struct dlfs { 849 uint32_t dlfs_magic; /* 0: magic number */ 850 uint32_t dlfs_version; /* 4: version number */ 851 852 uint32_t dlfs_size; /* 8: number of blocks in fs (v1) */ 853 /* number of frags in fs (v2) */ 854 uint32_t dlfs_ssize; /* 12: number of blocks per segment (v1) */ 855 /* number of bytes per segment (v2) */ 856 uint32_t dlfs_dsize; /* 16: number of disk blocks in fs */ 857 uint32_t dlfs_bsize; /* 20: file system block size */ 858 uint32_t dlfs_fsize; /* 24: size of frag blocks in fs */ 859 uint32_t dlfs_frag; /* 28: number of frags in a block in fs */ 860 861 /* Checkpoint region. */ 862 uint32_t dlfs_freehd; /* 32: start of the free inode list */ 863 int32_t dlfs_bfree; /* 36: number of free frags */ 864 uint32_t dlfs_nfiles; /* 40: number of allocated inodes */ 865 int32_t dlfs_avail; /* 44: blocks available for writing */ 866 int32_t dlfs_uinodes; /* 48: inodes in cache not yet on disk */ 867 int32_t dlfs_idaddr; /* 52: inode file disk address */ 868 uint32_t dlfs_ifile; /* 56: inode file inode number */ 869 int32_t dlfs_lastseg; /* 60: address of last segment written */ 870 int32_t dlfs_nextseg; /* 64: address of next segment to write */ 871 int32_t dlfs_curseg; /* 68: current segment being written */ 872 int32_t dlfs_offset; /* 72: offset in curseg for next partial */ 873 int32_t dlfs_lastpseg; /* 76: address of last partial written */ 874 uint32_t dlfs_inopf; /* 80: v1: time stamp; v2: inodes per frag */ 875 876 /* These are configuration parameters. */ 877 uint32_t dlfs_minfree; /* 84: minimum percentage of free blocks */ 878 879 /* These fields can be computed from the others. */ 880 uint64_t dlfs_maxfilesize; /* 88: maximum representable file size */ 881 uint32_t dlfs_fsbpseg; /* 96: frags (fsb) per segment */ 882 uint32_t dlfs_inopb; /* 100: inodes per block */ 883 uint32_t dlfs_ifpb; /* 104: IFILE entries per block */ 884 uint32_t dlfs_sepb; /* 108: SEGUSE entries per block */ 885 uint32_t dlfs_nindir; /* 112: indirect pointers per block */ 886 uint32_t dlfs_nseg; /* 116: number of segments */ 887 uint32_t dlfs_nspf; /* 120: number of sectors per fragment */ 888 uint32_t dlfs_cleansz; /* 124: cleaner info size in blocks */ 889 uint32_t dlfs_segtabsz; /* 128: segment table size in blocks */ 890 uint32_t dlfs_segmask; /* 132: calculate offset within a segment */ 891 uint32_t dlfs_segshift; /* 136: fast mult/div for segments */ 892 uint32_t dlfs_bshift; /* 140: calc block number from file offset */ 893 uint32_t dlfs_ffshift; /* 144: fast mult/div for frag from file */ 894 uint32_t dlfs_fbshift; /* 148: fast mult/div for frag from block */ 895 uint64_t dlfs_bmask; /* 152: calc block offset from file offset */ 896 uint64_t dlfs_ffmask; /* 160: calc frag offset from file offset */ 897 uint64_t dlfs_fbmask; /* 168: calc frag offset from block offset */ 898 uint32_t dlfs_blktodb; /* 176: blktodb and dbtoblk shift constant */ 899 uint32_t dlfs_sushift; /* 180: fast mult/div for segusage table */ 900 901 int32_t dlfs_maxsymlinklen; /* 184: max length of an internal symlink */ 902 /* 188: superblock disk offsets */ 903 int32_t dlfs_sboffs[LFS_MAXNUMSB]; 904 905 uint32_t dlfs_nclean; /* 228: Number of clean segments */ 906 u_char dlfs_fsmnt[MNAMELEN]; /* 232: name mounted on */ 907 uint16_t dlfs_pflags; /* 322: file system persistent flags */ 908 int32_t dlfs_dmeta; /* 324: total number of dirty summaries */ 909 uint32_t dlfs_minfreeseg; /* 328: segments not counted in bfree */ 910 uint32_t dlfs_sumsize; /* 332: size of summary blocks */ 911 uint64_t dlfs_serial; /* 336: serial number */ 912 uint32_t dlfs_ibsize; /* 344: size of inode blocks */ 913 int32_t dlfs_s0addr; /* 348: start of segment 0 */ 914 uint64_t dlfs_tstamp; /* 352: time stamp */ 915 uint32_t dlfs_inodefmt; /* 360: inode format version */ 916 uint32_t dlfs_interleave; /* 364: segment interleave */ 917 uint32_t dlfs_ident; /* 368: per-fs identifier */ 918 uint32_t dlfs_fsbtodb; /* 372: fsbtodb and dbtodsb shift constant */ 919 uint32_t dlfs_resvseg; /* 376: segments reserved for the cleaner */ 920 int8_t dlfs_pad[128]; /* 380: round to 512 bytes */ 921 /* Checksum -- last valid disk field. */ 922 uint32_t dlfs_cksum; /* 508: checksum for superblock checking */ 923 }; 924 925 struct dlfs64 { 926 uint32_t dlfs_magic; /* 0: magic number */ 927 uint32_t dlfs_version; /* 4: version number (2) */ 928 929 uint64_t dlfs_size; /* 8: number of frags in fs (v2) */ 930 uint64_t dlfs_dsize; /* 16: number of disk blocks in fs */ 931 uint32_t dlfs_ssize; /* 24: number of bytes per segment (v2) */ 932 uint32_t dlfs_bsize; /* 28: file system block size */ 933 uint32_t dlfs_fsize; /* 32: size of frag blocks in fs */ 934 uint32_t dlfs_frag; /* 36: number of frags in a block in fs */ 935 936 /* Checkpoint region. */ 937 uint64_t dlfs_freehd; /* 40: start of the free inode list */ 938 uint64_t dlfs_nfiles; /* 48: number of allocated inodes */ 939 int64_t dlfs_bfree; /* 56: number of free frags */ 940 int64_t dlfs_avail; /* 64: blocks available for writing */ 941 int64_t dlfs_idaddr; /* 72: inode file disk address */ 942 int32_t dlfs_uinodes; /* 80: inodes in cache not yet on disk */ 943 uint32_t dlfs_unused_0; /* 84: not used */ 944 int64_t dlfs_lastseg; /* 88: address of last segment written */ 945 int64_t dlfs_nextseg; /* 96: address of next segment to write */ 946 int64_t dlfs_curseg; /* 104: current segment being written */ 947 int64_t dlfs_offset; /* 112: offset in curseg for next partial */ 948 int64_t dlfs_lastpseg; /* 120: address of last partial written */ 949 uint32_t dlfs_inopf; /* 128: inodes per frag */ 950 951 /* These are configuration parameters. */ 952 uint32_t dlfs_minfree; /* 132: minimum percentage of free blocks */ 953 954 /* These fields can be computed from the others. */ 955 uint64_t dlfs_maxfilesize; /* 136: maximum representable file size */ 956 uint32_t dlfs_fsbpseg; /* 144: frags (fsb) per segment */ 957 uint32_t dlfs_inopb; /* 148: inodes per block */ 958 uint32_t dlfs_ifpb; /* 152: IFILE entries per block */ 959 uint32_t dlfs_sepb; /* 156: SEGUSE entries per block */ 960 uint32_t dlfs_nindir; /* 160: indirect pointers per block */ 961 uint32_t dlfs_nseg; /* 164: number of segments */ 962 uint32_t dlfs_nspf; /* 168: number of sectors per fragment */ 963 uint32_t dlfs_cleansz; /* 172: cleaner info size in blocks */ 964 uint32_t dlfs_segtabsz; /* 176: segment table size in blocks */ 965 uint32_t dlfs_bshift; /* 180: calc block number from file offset */ 966 uint32_t dlfs_ffshift; /* 184: fast mult/div for frag from file */ 967 uint32_t dlfs_fbshift; /* 188: fast mult/div for frag from block */ 968 uint64_t dlfs_bmask; /* 192: calc block offset from file offset */ 969 uint64_t dlfs_ffmask; /* 200: calc frag offset from file offset */ 970 uint64_t dlfs_fbmask; /* 208: calc frag offset from block offset */ 971 uint32_t dlfs_blktodb; /* 216: blktodb and dbtoblk shift constant */ 972 uint32_t dlfs_sushift; /* 220: fast mult/div for segusage table */ 973 974 /* 224: superblock disk offsets */ 975 int64_t dlfs_sboffs[LFS_MAXNUMSB]; 976 977 int32_t dlfs_maxsymlinklen; /* 304: max len of an internal symlink */ 978 uint32_t dlfs_nclean; /* 308: Number of clean segments */ 979 u_char dlfs_fsmnt[MNAMELEN]; /* 312: name mounted on */ 980 uint16_t dlfs_pflags; /* 402: file system persistent flags */ 981 int32_t dlfs_dmeta; /* 404: total number of dirty summaries */ 982 uint32_t dlfs_minfreeseg; /* 408: segments not counted in bfree */ 983 uint32_t dlfs_sumsize; /* 412: size of summary blocks */ 984 uint32_t dlfs_ibsize; /* 416: size of inode blocks */ 985 uint32_t dlfs_inodefmt; /* 420: inode format version */ 986 uint64_t dlfs_serial; /* 424: serial number */ 987 int64_t dlfs_s0addr; /* 432: start of segment 0 */ 988 uint64_t dlfs_tstamp; /* 440: time stamp */ 989 uint32_t dlfs_interleave; /* 448: segment interleave */ 990 uint32_t dlfs_ident; /* 452: per-fs identifier */ 991 uint32_t dlfs_fsbtodb; /* 456: fsbtodb and dbtodsb shift constant */ 992 uint32_t dlfs_resvseg; /* 460: segments reserved for the cleaner */ 993 int8_t dlfs_pad[44]; /* 464: round to 512 bytes */ 994 /* Checksum -- last valid disk field. */ 995 uint32_t dlfs_cksum; /* 508: checksum for superblock checking */ 996 }; 997 998 __CTASSERT(__alignof(struct dlfs) == __alignof(struct dlfs64)); 999 1000 /* Type used for the inode bitmap */ 1001 typedef uint32_t lfs_bm_t; 1002 1003 /* 1004 * Linked list of segments whose byte count needs updating following a 1005 * file truncation. 1006 */ 1007 struct segdelta { 1008 long segnum; 1009 size_t num; 1010 rb_node_t rb_entry; 1011 }; 1012 1013 /* 1014 * Parameters used by the in-kernel cleaner. 1015 */ 1016 struct lfs_autoclean_params { 1017 size_t size; /* Size of this structure */ 1018 #define LFS_CLEANMODE_NONE 0x00 /* Auto-cleaner off */ 1019 #define LFS_CLEANMODE_GREEDY 0x01 /* Greedy selector */ 1020 #define LFS_CLEANMODE_CB 0x02 /* Cost-benefit selector */ 1021 int mode; /* Which of the autoclean modes to use */ 1022 int thresh; /* Low cleaning threshold to use */ 1023 int target; /* How many blocks to rewrite before checkpointing */ 1024 } __packed; 1025 1026 /* 1027 * In-memory super block. 1028 */ 1029 struct lfs { 1030 union { /* on-disk parameters */ 1031 struct dlfs u_32; 1032 struct dlfs64 u_64; 1033 } lfs_dlfs_u; 1034 1035 /* These fields are set at mount time and are meaningless on disk. */ 1036 unsigned lfs_is64 : 1, /* are we lfs64 or lfs32? */ 1037 lfs_dobyteswap : 1, /* are we opposite-endian? */ 1038 lfs_hasolddirfmt : 1; /* dir entries have no d_type */ 1039 1040 struct segment *lfs_sp; /* current segment being written */ 1041 struct vnode *lfs_ivnode; /* vnode for the ifile */ 1042 1043 /* Preventative lock */ 1044 uint32_t lfs_prelock; /* preventative lock counter */ 1045 struct lwp *lfs_prelocklwp; /* LWP of lock holder */ 1046 kcondvar_t lfs_prelockcv; /* condvar for cleaner */ 1047 bool lfs_prelock_unfrag; /* whether we took fraglock */ 1048 1049 /* Segment lock */ 1050 uint32_t lfs_seglock; /* segment lock counter */ 1051 1052 uint32_t lfs_iocount; /* number of ios pending */ 1053 uint32_t lfs_writer; /* don't allow any dirops to start */ 1054 uint32_t lfs_dirops; /* count of active directory ops */ 1055 kcondvar_t lfs_diropscv; /* condvar of active directory ops */ 1056 uint32_t lfs_dirvcount; /* count of VDIROP nodes in this fs */ 1057 uint32_t lfs_doifile; /* Write ifile blocks on next write */ 1058 uint32_t lfs_nactive; /* Number of segments since last ckp */ 1059 int8_t lfs_fmod; /* super block modified flag */ 1060 int8_t lfs_ronly; /* mounted read-only flag */ 1061 #define LFS_NOTYET 0x01 1062 #define LFS_IFDIRTY 0x02 1063 #define LFS_WARNED 0x04 1064 #define LFS_UNDIROP 0x08 1065 #define LFS_MUSTCLEAN 0x10 1066 int8_t lfs_flags; /* non-persistent flags */ 1067 uint16_t lfs_activesb; /* toggle between superblocks */ 1068 daddr_t lfs_sbactive; /* disk address of current sb write */ 1069 struct vnode *lfs_flushvp; /* vnode being flushed */ 1070 int lfs_flushvp_fakevref; /* fake vref count for flushvp */ 1071 struct vnode *lfs_unlockvp; /* being inactivated in lfs_segunlock */ 1072 uint32_t lfs_diropwait; /* # procs waiting on dirop flush */ 1073 size_t lfs_devbsize; /* Device block size */ 1074 size_t lfs_devbshift; /* Device block shift */ 1075 krwlock_t lfs_fraglock; 1076 krwlock_t lfs_iflock; /* Ifile lock */ 1077 kcondvar_t lfs_stopcv; /* Wrap lock */ 1078 struct lwp *lfs_stoplwp; 1079 pid_t lfs_rfpid; /* Process ID of roll-forward agent */ 1080 int lfs_nadirop; /* number of active dirop nodes */ 1081 long lfs_ravail; /* blocks pre-reserved for writing */ 1082 long lfs_favail; /* blocks pre-reserved for writing */ 1083 struct lfs_res_blk *lfs_resblk; /* Reserved memory for pageout */ 1084 TAILQ_HEAD(, inode) lfs_dchainhd; /* dirop vnodes */ 1085 TAILQ_HEAD(, inode) lfs_pchainhd; /* paging vnodes */ 1086 TAILQ_HEAD(, inode) lfs_cleanhd; /* vnodes being cleaned */ 1087 #define LFS_RESHASH_WIDTH 17 1088 LIST_HEAD(, lfs_res_blk) lfs_reshash[LFS_RESHASH_WIDTH]; 1089 int lfs_pdflush; /* pagedaemon wants us to flush */ 1090 #ifdef _KERNEL 1091 struct pool lfs_clpool; /* Pool for struct lfs_cluster */ 1092 struct pool lfs_bpppool; /* Pool for bpp */ 1093 struct pool lfs_segpool; /* Pool for struct segment */ 1094 #endif /* _KERNEL */ 1095 #define LFS_MAX_CLEANIND 64 1096 daddr_t lfs_cleanint[LFS_MAX_CLEANIND]; /* Active cleaning intervals */ 1097 int lfs_cleanind; /* Index into intervals */ 1098 int lfs_sleepers; /* # procs sleeping this fs */ 1099 kcondvar_t lfs_sleeperscv; 1100 int lfs_pages; /* dirty pages blaming this fs */ 1101 lfs_bm_t *lfs_ino_bitmap; /* Inuse inodes bitmap */ 1102 int lfs_nowrap; /* Suspend log wrap */ 1103 int lfs_wrappass; /* Allow first log wrap requester to pass */ 1104 int lfs_wrapstatus; /* Wrap status */ 1105 int lfs_reclino; /* Inode being reclaimed */ 1106 daddr_t lfs_startseg; /* Segment we started writing at */ 1107 rb_tree_t lfs_segdhd; /* List of pending trunc accounting events */ 1108 1109 #ifdef _KERNEL 1110 /* The block device we're mounted on. */ 1111 dev_t lfs_dev; 1112 struct vnode *lfs_devvp; 1113 1114 /* ULFS-level information */ 1115 uint32_t um_flags; /* ULFS flags (below) */ 1116 u_long um_nindir; /* indirect ptrs per block */ 1117 u_long um_lognindir; /* log2 of um_nindir */ 1118 u_long um_bptrtodb; /* indir ptr to disk block */ 1119 u_long um_seqinc; /* inc between seq blocks */ 1120 int um_maxsymlinklen; 1121 int um_dirblksiz; 1122 uint64_t um_maxfilesize; 1123 1124 /* Stuff used by quota2 code, not currently operable */ 1125 unsigned lfs_use_quota2 : 1; 1126 uint32_t lfs_quota_magic; 1127 uint8_t lfs_quota_flags; 1128 uint64_t lfs_quotaino[2]; 1129 1130 /* Sleep address replacing &lfs_avail inside the on-disk superblock */ 1131 /* XXX: should be replaced with a condvar */ 1132 int lfs_availsleep; 1133 /* This one replaces &lfs_nextseg... all ditto */ 1134 kcondvar_t lfs_nextsegsleep; 1135 1136 /* Cleaner lwp, set on first bmapv syscall. */ 1137 struct lwp *lfs_cleaner_thread; 1138 1139 /* Hint from cleaner, only valid if curlwp == um_cleaner_thread. */ 1140 /* XXX change this to BLOCK_INFO after resorting this file */ 1141 struct block_info *lfs_cleaner_hint; 1142 1143 /* Cleaner lock */ 1144 struct lwp *lfs_cleanlock; /* LWP of lock holder */ 1145 kcondvar_t lfs_cleanercv; /* condvar for cleaner */ 1146 1147 /* Cleaner selection function and params */ 1148 struct lfs_autoclean_params lfs_autoclean; 1149 long (*lfs_clean_selector)(struct lfs *, int, SEGUSE *); 1150 uint64_t lfs_clean_accum; 1151 # define LFS_AUTOCLEAN_STATUS_OFF 0 1152 # define LFS_AUTOCLEAN_STATUS_ON 1 1153 int lfs_autoclean_status; 1154 kcondvar_t lfs_cleanquitcv; /* condvar for cleaner quit */ 1155 1156 /* Last cleaned segment */ 1157 uint32_t lfs_lastcleaned; 1158 #endif 1159 }; 1160 1161 /* 1162 * Structures used to pass information between the partial-segment 1163 * parser and its callback functions. 1164 */ 1165 struct lfs_inofuncarg { 1166 struct lfs *fs; /* The filesystem */ 1167 daddr_t offset; /* Address of the inode block */ 1168 kauth_cred_t cred; /* Credential */ 1169 struct lwp *l; /* lwp */ 1170 char *buf; /* Pre-allocated buffer space */ 1171 void *arg; /* Opaque argument to function */ 1172 }; 1173 1174 struct lfs_finfofuncarg { 1175 struct lfs *fs; /* The file system */ 1176 FINFO *finfop; /* The FINFO structure to parse */ 1177 daddr_t *offsetp; /* Address of the first block */ 1178 kauth_cred_t cred; /* Credential */ 1179 struct lwp *l; /* lwp */ 1180 void *arg; /* Opaque argument to function */ 1181 }; 1182 1183 /* 1184 * Structures used by lfs_bmapv and lfs_markv to communicate information 1185 * about inodes and data blocks. 1186 */ 1187 typedef struct block_info { 1188 uint64_t bi_inode; /* inode # */ 1189 int64_t bi_lbn; /* logical block w/in file */ 1190 int64_t bi_daddr; /* disk address of block */ 1191 uint64_t bi_segcreate; /* origin segment create time */ 1192 int bi_version; /* file version number */ 1193 int bi_size; /* size of the block (if fragment) */ 1194 void *bi_bp; /* data buffer */ 1195 } BLOCK_INFO; 1196 1197 /* Compatibility for 7.0 binaries */ 1198 typedef struct block_info_70 { 1199 uint32_t bi_inode; /* inode # */ 1200 int32_t bi_lbn; /* logical block w/in file */ 1201 int32_t bi_daddr; /* disk address of block */ 1202 uint64_t bi_segcreate; /* origin segment create time */ 1203 int bi_version; /* file version number */ 1204 void *bi_bp; /* data buffer */ 1205 int bi_size; /* size of the block (if fragment) */ 1206 } BLOCK_INFO_70; 1207 1208 /* Compatibility for 1.5 binaries */ 1209 typedef struct block_info_15 { 1210 uint32_t bi_inode; /* inode # */ 1211 int32_t bi_lbn; /* logical block w/in file */ 1212 int32_t bi_daddr; /* disk address of block */ 1213 uint32_t bi_segcreate; /* origin segment create time */ 1214 int bi_version; /* file version number */ 1215 void *bi_bp; /* data buffer */ 1216 int bi_size; /* size of the block (if fragment) */ 1217 } BLOCK_INFO_15; 1218 1219 /* 1220 * 32/64-bit-clean pointer to block pointers. This points into 1221 * already-existing storage; it is mostly used to access the block 1222 * pointers following a FINFO. 1223 */ 1224 union lfs_blocks { 1225 int64_t *b64; 1226 int32_t *b32; 1227 }; 1228 1229 /* In-memory description of a segment about to be written. */ 1230 struct segment { 1231 struct lfs *fs; /* file system pointer */ 1232 struct buf **bpp; /* pointer to buffer array */ 1233 struct buf **cbpp; /* pointer to next available bp */ 1234 struct buf **start_bpp; /* pointer to first bp in this set */ 1235 struct buf *ibp; /* buffer pointer to inode page */ 1236 union lfs_dinode *idp; /* pointer to ifile dinode */ 1237 FINFO *fip; /* current fileinfo pointer */ 1238 struct vnode *vp; /* vnode being gathered */ 1239 void *segsum; /* segment summary info */ 1240 uint32_t ninodes; /* number of inodes in this segment */ 1241 int32_t seg_bytes_left; /* bytes left in segment */ 1242 int32_t sum_bytes_left; /* bytes left in summary block */ 1243 uint32_t seg_number; /* number of this segment */ 1244 union lfs_blocks start_lbp; /* beginning lbn for this set */ 1245 1246 #define SEGM_CKP 0x0001 /* doing a checkpoint */ 1247 #define SEGM_CLEAN 0x0002 /* cleaner call; don't sort */ 1248 #define SEGM_SYNC 0x0004 /* wait for segment */ 1249 #define SEGM_PAGEDAEMON 0x0010 /* pagedaemon called us */ 1250 #define SEGM_WRITERD 0x0020 /* LFS writed called us */ 1251 #define SEGM_FORCE_CKP 0x0040 /* Force checkpoint right away */ 1252 #define SEGM_RECLAIM 0x0080 /* Writing to reclaim vnode */ 1253 #define SEGM_SINGLE 0x0100 /* Opportunistic writevnodes */ 1254 uint16_t seg_flags; /* run-time flags for this segment */ 1255 uint32_t seg_iocount; /* number of ios pending */ 1256 uint64_t bytes_written; /* bytes written */ 1257 int gatherblock_loopcount; /* lfs_gatherblock loop count */ 1258 }; 1259 1260 /* Statistics Counters */ 1261 struct lfs_stats { /* Must match sysctl list in lfs_vfsops.h ! */ 1262 u_int segsused; 1263 u_int psegwrites; 1264 u_int psyncwrites; 1265 u_int pcleanwrites; 1266 u_int blocktot; 1267 u_int cleanblocks; 1268 u_int ncheckpoints; 1269 u_int nwrites; 1270 u_int nsync_writes; 1271 u_int wait_exceeded; 1272 u_int write_exceeded; 1273 u_int flush_invoked; 1274 u_int vflush_invoked; 1275 u_int clean_inlocked; 1276 u_int clean_vnlocked; 1277 u_int segs_reclaimed; 1278 }; 1279 1280 1281 /* 1282 * fcntl-related definitions. 1283 */ 1284 1285 /* 1286 * Struct lfs_write_stats is returned by many of the LFS fcntl calls. 1287 * It contains the amount of data written directly by the call, as 1288 * well as the total amount ths current write offset advanced, both 1289 * measured in "fsb" (fragments). 1290 */ 1291 struct lfs_write_stats { 1292 int direct; /* Direct data written, in frags */ 1293 int offset; /* Offset difference, in frags */ 1294 }; 1295 1296 /* 1297 * Update the current segment offset somewhere before the given 1298 * segment number. Primarily used for the old, manual file system 1299 * resize method. 1300 */ 1301 #define LFCNREWIND _FCNR_FSPRIV('L', 6, int) 1302 1303 /* 1304 * Mark the given segment as temporarily invalid, that is, it should 1305 * not be written to unless no other clean segments are available. 1306 * Primarily used for the old, manual file system resize method. 1307 */ 1308 #define LFCNINVAL _FCNR_FSPRIV('L', 7, int) 1309 1310 /* 1311 * Resize the file system to the given number of segments. If the 1312 * file system is being shrunk, enough clean segments must already 1313 * exist to accommodate the size change. 1314 */ 1315 #define LFCNRESIZE _FCNR_FSPRIV('L', 8, int) 1316 1317 /* 1318 * Wrap control. 1319 * 1320 * LFCNWRAPSTOP stops the writer from "wrapping" to the beginning of 1321 * the disk when there are no clean segments higher than the current 1322 * write offset. This is primarily used for diagnostic and analysis 1323 * purposes. If an argument of 1 is given, this call waits until the 1324 * writer stops. 1325 * 1326 * LFCNWRAPSTATUS retrieves the status of the wrapping restriction 1327 * (going or stopping). 1328 * 1329 * LFCNWRAPPASS allows the segment selector to pass to the beginning 1330 * of the disk, once, while wrapping is suspended. 1331 * 1332 * LFCNWRAPGO releases the restriction. 1333 */ 1334 #define LFCNWRAPSTOP _FCNR_FSPRIV('L', 9, int) 1335 #define LFCNWRAPGO _FCNR_FSPRIV('L', 10, int) 1336 #define LFCNWRAPPASS _FCNR_FSPRIV('L', 12, int) 1337 # define LFS_WRAP_GOING 0x0 1338 # define LFS_WRAP_WAITING 0x1 1339 #define LFCNWRAPSTATUS _FCNW_FSPRIV('L', 13, int) 1340 1341 /* 1342 * Retrieve the file handle of the index file. It is preferable for the 1343 * cleaner to hold the file handle of the index file rather than the file 1344 * system root because the latter would prevent a clean unmount. 1345 */ 1346 struct lfs_fhandle { 1347 char space[28]; /* FHANDLE_SIZE_COMPAT (but used from userland too) */ 1348 }; 1349 #define LFCNIFILEFH _FCNW_FSPRIV('L', 11, struct lfs_fhandle) 1350 1351 /* 1352 * Fcntls to take the place of the historical lfs syscalls. 1353 * 1354 * LFCNSEGWAIT waits for this file system to advance to a new segment. 1355 * 1356 * LFCNSEGWAITALL waits for *any* LFS to advance to a new segment. 1357 * 1358 * LFCNCLEANERINFO retrieves the most current cleaner information 1359 * from the kernel. 1360 * 1361 * LFCNSEGUSE retrieves the current SEGUSE structure for segments 1362 * beginning at _start_ and ending at _start_ + _len_ - 1. 1363 * 1364 * LFCNBMAPV takes a list of blocks, parsed out of the partial-segment 1365 * headers, and returns those that have not been relocated. 1366 * 1367 * LFCNMARKV relocated the specified blocks, writing them at the head 1368 * of the log. 1369 * 1370 * LFCNRECLAIM forces a checkpoint with the intention of reclaiming 1371 * empty segments. The write statistics show the amount of data 1372 * written to disk to accomplish this. 1373 */ 1374 #define LFS_SEGUSE_MAXCNT 65536 /* Max entry count for LFCNSEGUSE */ 1375 struct lfs_seguse_array { 1376 int start; /* Start segment */ 1377 size_t len; /* Length of the array */ 1378 SEGUSE *seguse; /* Out: array of seguse */ 1379 }; 1380 #define LFS_MARKV_MAXBLKCNT 65536 /* Max block count for lfs_markv() */ 1381 struct lfs_fcntl_markv { 1382 BLOCK_INFO *blkiov; /* blocks to relocate */ 1383 int blkcnt; /* number of blocks (limited to 65536) */ 1384 }; 1385 #define LFCNSEGWAITALL _FCNR_FSPRIV ('L', 14, struct timeval) 1386 #define LFCNSEGWAIT _FCNR_FSPRIV ('L', 15, struct timeval) 1387 #define LFCNCLEANERINFO _FCNW_FSPRIV ('L', 22, CLEANERINFO64) 1388 #define LFCNSEGUSE _FCNRW_FSPRIV('L', 23, struct lfs_seguse_array) 1389 #define LFCNBMAPV _FCNRW_FSPRIV('L', 16, struct lfs_fcntl_markv) 1390 #define LFCNMARKV _FCNRW_FSPRIV('L', 17, struct lfs_fcntl_markv) 1391 #define LFCNRECLAIM _FCNW_FSPRIV ('L', 4, struct lfs_write_stats) 1392 1393 /* 1394 * File defragmentation. 1395 * 1396 * LFCNFILESTATS returns fragmentation information about the direct blocks 1397 * held by the inodes numbered between _ino_ and _ino_ + _len_ - 1. 1398 * Two metrics are returned: the total number of discontinuities; and the 1399 * sum of the length of the discontinuities, reported in frags. 1400 * 1401 * LFCNREWRITEFILE rewrites the specified files sequentially, 1402 * restoring them to a state with as few discontinuities as possible. 1403 * 1404 * LFCNSCRAMBLE rewrites every other block of the specified files, 1405 * creating as many gaps as possible. This is primarily used for 1406 * testing. 1407 */ 1408 #define LFS_FILESTATS_MAXCNT 65536 /* Max entry count for LFCNFILESTATS */ 1409 struct lfs_filestats { 1410 ino_t ino; /* Inode number */ 1411 off_t nblk; /* Block count */ 1412 int dc_count; /* Count of discontinuities (gaps) */ 1413 daddr_t dc_sum; /* Sum of absolute values of gap lengths */ 1414 }; 1415 struct lfs_filestat_req { 1416 ino_t ino; /* Starting inode number */ 1417 int len; /* Number of inodes to report */ 1418 struct lfs_filestats *fss; /* Out: file statistics */ 1419 }; 1420 #define LFCNFILESTATS _FCNRW_FSPRIV('L', 18, struct lfs_filestat_req) 1421 1422 #define LFS_REWRITE_MAXCNT 65536 /* Max entry count for LFCNREWRITE* */ 1423 struct lfs_inode_array { 1424 size_t len; /* Length of array */ 1425 ino_t *inodes; /* Array of inode numbers */ 1426 struct lfs_write_stats stats; /* Out: frags written */ 1427 }; 1428 #define LFCNREWRITEFILE _FCNRW_FSPRIV('L', 19, struct lfs_inode_array) 1429 #define LFCNSCRAMBLE _FCNRW_FSPRIV('L', 20, struct lfs_inode_array) 1430 1431 /* 1432 * Segment rewriting. 1433 * 1434 * LFCNREWRITESEGS rewrites the live data still contained within the 1435 * specified segments. It is intended to replace the 1436 * read/lfs_bmapv/lfs_bmapv combination historically used by the cleaner. 1437 */ 1438 struct lfs_segnum_array { 1439 size_t len; /* Length of array */ 1440 int *segments; /* Array of segment numbers */ 1441 struct lfs_write_stats stats; /* Out: frags written */ 1442 }; 1443 #define LFCNREWRITESEGS _FCNRW_FSPRIV('L', 21, struct lfs_segnum_array) 1444 1445 /* 1446 * In-kernel cleaner. 1447 * 1448 * LFCNAUTOCLEAN directs the in-kernel cleaner process. Three 1449 * parameters are available: cleaning mode, priority threshold, and 1450 * cleaning target. 1451 * 1452 * struct lfs_autoclean_params { 1453 * size_t size; // Size of this structure 1454 * #define LFS_CLEANMODE_NONE 0x00 // Auto-cleaner off 1455 * #define LFS_CLEANMODE_GREEDY 0x01 // Greedy selector 1456 * #define LFS_CLEANMODE_CB 0x02 // Cost-benefit selector 1457 * int mode; // Which of the autoclean modes to use 1458 * int thresh; // Low cleaning threshold to use 1459 * int target; // How many blocks to rewrite before checkpointing 1460 * }; 1461 * 1462 * The cleaning mode, or strategy, can be given as any of greedy; 1463 * cost/benefit using clock time for the time metric; or NONE, 1464 * indicating that the in-kernel cleaner should not be used for this 1465 * file system. The default is NONE. 1466 * 1467 * The priority threshold determines when to stop cleaning. A 1468 * threshold of zero indicates that the cleaner should never pause 1469 * from cleaning until there are no segments with dead blocks; a 1470 * negative value means the kernel will choose the threshold. 1471 * 1472 * The "target" parameter describes how many blocks should be written 1473 * before a checkpoint. Too low a value will result in the creation 1474 * of many short-lived index file blocks, which might make the cleaner 1475 * lose ground; but too high a value might result in the file system 1476 * becoming short on clean segments, so that other processes must wait 1477 * for a synchronous checkpoint. A negative value means that the 1478 * kernel will choose the target. 1479 */ 1480 #define LFCNAUTOCLEAN _FCNR_FSPRIV('L', 24, struct lfs_autoclean_params) 1481 1482 1483 /* Debug segment lock */ 1484 #ifdef notyet 1485 # define ASSERT_SEGLOCK(fs) KASSERT(LFS_SEGLOCK_HELD(fs)) 1486 # define ASSERT_NO_SEGLOCK(fs) KASSERT(!LFS_SEGLOCK_HELD(fs)) 1487 # define ASSERT_DUNNO_SEGLOCK(fs) 1488 # define ASSERT_MAYBE_SEGLOCK(fs) 1489 #else /* !notyet */ 1490 # define ASSERT_DUNNO_SEGLOCK(fs) \ 1491 DLOG((DLOG_SEG, "lfs func %s seglock wrong (%d)\n", __func__, \ 1492 LFS_SEGLOCK_HELD(fs))) 1493 # define ASSERT_SEGLOCK(fs) do { \ 1494 if (!LFS_SEGLOCK_HELD(fs)) { \ 1495 DLOG((DLOG_SEG, "lfs func %s seglock wrong (0)\n", __func__)); \ 1496 } \ 1497 } while(0) 1498 # define ASSERT_NO_SEGLOCK(fs) do { \ 1499 if (LFS_SEGLOCK_HELD(fs)) { \ 1500 DLOG((DLOG_SEG, "lfs func %s seglock wrong (1)\n", __func__)); \ 1501 } \ 1502 } while(0) 1503 # define ASSERT_MAYBE_SEGLOCK(x) 1504 #endif /* !notyet */ 1505 1506 /* 1507 * Arguments to mount LFS filesystems 1508 */ 1509 struct ulfs_args { 1510 char *fspec; /* block special device to mount */ 1511 }; 1512 1513 __BEGIN_DECLS 1514 void lfs_itimes(struct inode *, const struct timespec *, 1515 const struct timespec *, const struct timespec *); 1516 __END_DECLS 1517 1518 #endif /* !_UFS_LFS_LFS_H_ */ 1519