1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright (c) 2000-2005 Silicon Graphics, Inc. 4 * All Rights Reserved. 5 */ 6 #ifndef __XFS_FORMAT_H__ 7 #define __XFS_FORMAT_H__ 8 9 /* 10 * XFS On Disk Format Definitions 11 * 12 * This header file defines all the on-disk format definitions for 13 * general XFS objects. Directory and attribute related objects are defined in 14 * xfs_da_format.h, which log and log item formats are defined in 15 * xfs_log_format.h. Everything else goes here. 16 */ 17 18 struct xfs_mount; 19 struct xfs_trans; 20 struct xfs_inode; 21 struct xfs_buf; 22 struct xfs_ifork; 23 24 /* 25 * Super block 26 * Fits into a sector-sized buffer at address 0 of each allocation group. 27 * Only the first of these is ever updated except during growfs. 28 */ 29 #define XFS_SB_MAGIC 0x58465342 /* 'XFSB' */ 30 #define XFS_SB_VERSION_1 1 /* 5.3, 6.0.1, 6.1 */ 31 #define XFS_SB_VERSION_2 2 /* 6.2 - attributes */ 32 #define XFS_SB_VERSION_3 3 /* 6.2 - new inode version */ 33 #define XFS_SB_VERSION_4 4 /* 6.2+ - bitmask version */ 34 #define XFS_SB_VERSION_5 5 /* CRC enabled filesystem */ 35 #define XFS_SB_VERSION_NUMBITS 0x000f 36 #define XFS_SB_VERSION_ALLFBITS 0xfff0 37 #define XFS_SB_VERSION_ATTRBIT 0x0010 38 #define XFS_SB_VERSION_NLINKBIT 0x0020 39 #define XFS_SB_VERSION_QUOTABIT 0x0040 40 #define XFS_SB_VERSION_ALIGNBIT 0x0080 41 #define XFS_SB_VERSION_DALIGNBIT 0x0100 42 #define XFS_SB_VERSION_SHAREDBIT 0x0200 43 #define XFS_SB_VERSION_LOGV2BIT 0x0400 44 #define XFS_SB_VERSION_SECTORBIT 0x0800 45 #define XFS_SB_VERSION_EXTFLGBIT 0x1000 46 #define XFS_SB_VERSION_DIRV2BIT 0x2000 47 #define XFS_SB_VERSION_BORGBIT 0x4000 /* ASCII only case-insens. */ 48 #define XFS_SB_VERSION_MOREBITSBIT 0x8000 49 50 /* 51 * The size of a single extended attribute on disk is limited by 52 * the size of index values within the attribute entries themselves. 53 * These are be16 fields, so we can only support attribute data 54 * sizes up to 2^16 bytes in length. 55 */ 56 #define XFS_XATTR_SIZE_MAX (1 << 16) 57 58 /* 59 * Supported feature bit list is just all bits in the versionnum field because 60 * we've used them all up and understand them all. Except, of course, for the 61 * shared superblock bit, which nobody knows what it does and so is unsupported. 62 */ 63 #define XFS_SB_VERSION_OKBITS \ 64 ((XFS_SB_VERSION_NUMBITS | XFS_SB_VERSION_ALLFBITS) & \ 65 ~XFS_SB_VERSION_SHAREDBIT) 66 67 /* 68 * There are two words to hold XFS "feature" bits: the original 69 * word, sb_versionnum, and sb_features2. Whenever a bit is set in 70 * sb_features2, the feature bit XFS_SB_VERSION_MOREBITSBIT must be set. 71 * 72 * These defines represent bits in sb_features2. 73 */ 74 #define XFS_SB_VERSION2_RESERVED1BIT 0x00000001 75 #define XFS_SB_VERSION2_LAZYSBCOUNTBIT 0x00000002 /* Superblk counters */ 76 #define XFS_SB_VERSION2_RESERVED4BIT 0x00000004 77 #define XFS_SB_VERSION2_ATTR2BIT 0x00000008 /* Inline attr rework */ 78 #define XFS_SB_VERSION2_PARENTBIT 0x00000010 /* parent pointers */ 79 #define XFS_SB_VERSION2_PROJID32BIT 0x00000080 /* 32 bit project id */ 80 #define XFS_SB_VERSION2_CRCBIT 0x00000100 /* metadata CRCs */ 81 #define XFS_SB_VERSION2_FTYPE 0x00000200 /* inode type in dir */ 82 83 #define XFS_SB_VERSION2_OKBITS \ 84 (XFS_SB_VERSION2_LAZYSBCOUNTBIT | \ 85 XFS_SB_VERSION2_ATTR2BIT | \ 86 XFS_SB_VERSION2_PROJID32BIT | \ 87 XFS_SB_VERSION2_FTYPE) 88 89 /* Maximum size of the xfs filesystem label, no terminating NULL */ 90 #define XFSLABEL_MAX 12 91 92 /* 93 * Superblock - in core version. Must match the ondisk version below. 94 * Must be padded to 64 bit alignment. 95 */ 96 typedef struct xfs_sb { 97 uint32_t sb_magicnum; /* magic number == XFS_SB_MAGIC */ 98 uint32_t sb_blocksize; /* logical block size, bytes */ 99 xfs_rfsblock_t sb_dblocks; /* number of data blocks */ 100 xfs_rfsblock_t sb_rblocks; /* number of realtime blocks */ 101 xfs_rtblock_t sb_rextents; /* number of realtime extents */ 102 uuid_t sb_uuid; /* user-visible file system unique id */ 103 xfs_fsblock_t sb_logstart; /* starting block of log if internal */ 104 xfs_ino_t sb_rootino; /* root inode number */ 105 xfs_ino_t sb_rbmino; /* bitmap inode for realtime extents */ 106 xfs_ino_t sb_rsumino; /* summary inode for rt bitmap */ 107 xfs_agblock_t sb_rextsize; /* realtime extent size, blocks */ 108 xfs_agblock_t sb_agblocks; /* size of an allocation group */ 109 xfs_agnumber_t sb_agcount; /* number of allocation groups */ 110 xfs_extlen_t sb_rbmblocks; /* number of rt bitmap blocks */ 111 xfs_extlen_t sb_logblocks; /* number of log blocks */ 112 uint16_t sb_versionnum; /* header version == XFS_SB_VERSION */ 113 uint16_t sb_sectsize; /* volume sector size, bytes */ 114 uint16_t sb_inodesize; /* inode size, bytes */ 115 uint16_t sb_inopblock; /* inodes per block */ 116 char sb_fname[XFSLABEL_MAX]; /* file system name */ 117 uint8_t sb_blocklog; /* log2 of sb_blocksize */ 118 uint8_t sb_sectlog; /* log2 of sb_sectsize */ 119 uint8_t sb_inodelog; /* log2 of sb_inodesize */ 120 uint8_t sb_inopblog; /* log2 of sb_inopblock */ 121 uint8_t sb_agblklog; /* log2 of sb_agblocks (rounded up) */ 122 uint8_t sb_rextslog; /* log2 of sb_rextents */ 123 uint8_t sb_inprogress; /* mkfs is in progress, don't mount */ 124 uint8_t sb_imax_pct; /* max % of fs for inode space */ 125 /* statistics */ 126 /* 127 * These fields must remain contiguous. If you really 128 * want to change their layout, make sure you fix the 129 * code in xfs_trans_apply_sb_deltas(). 130 */ 131 uint64_t sb_icount; /* allocated inodes */ 132 uint64_t sb_ifree; /* free inodes */ 133 uint64_t sb_fdblocks; /* free data blocks */ 134 uint64_t sb_frextents; /* free realtime extents */ 135 /* 136 * End contiguous fields. 137 */ 138 xfs_ino_t sb_uquotino; /* user quota inode */ 139 xfs_ino_t sb_gquotino; /* group quota inode */ 140 uint16_t sb_qflags; /* quota flags */ 141 uint8_t sb_flags; /* misc. flags */ 142 uint8_t sb_shared_vn; /* shared version number */ 143 xfs_extlen_t sb_inoalignmt; /* inode chunk alignment, fsblocks */ 144 uint32_t sb_unit; /* stripe or raid unit */ 145 uint32_t sb_width; /* stripe or raid width */ 146 uint8_t sb_dirblklog; /* log2 of dir block size (fsbs) */ 147 uint8_t sb_logsectlog; /* log2 of the log sector size */ 148 uint16_t sb_logsectsize; /* sector size for the log, bytes */ 149 uint32_t sb_logsunit; /* stripe unit size for the log */ 150 uint32_t sb_features2; /* additional feature bits */ 151 152 /* 153 * bad features2 field as a result of failing to pad the sb structure to 154 * 64 bits. Some machines will be using this field for features2 bits. 155 * Easiest just to mark it bad and not use it for anything else. 156 * 157 * This is not kept up to date in memory; it is always overwritten by 158 * the value in sb_features2 when formatting the incore superblock to 159 * the disk buffer. 160 */ 161 uint32_t sb_bad_features2; 162 163 /* version 5 superblock fields start here */ 164 165 /* feature masks */ 166 uint32_t sb_features_compat; 167 uint32_t sb_features_ro_compat; 168 uint32_t sb_features_incompat; 169 uint32_t sb_features_log_incompat; 170 171 uint32_t sb_crc; /* superblock crc */ 172 xfs_extlen_t sb_spino_align; /* sparse inode chunk alignment */ 173 174 xfs_ino_t sb_pquotino; /* project quota inode */ 175 xfs_lsn_t sb_lsn; /* last write sequence */ 176 uuid_t sb_meta_uuid; /* metadata file system unique id */ 177 178 /* must be padded to 64 bit alignment */ 179 } xfs_sb_t; 180 181 #define XFS_SB_CRC_OFF offsetof(struct xfs_sb, sb_crc) 182 183 /* 184 * Superblock - on disk version. Must match the in core version above. 185 * Must be padded to 64 bit alignment. 186 */ 187 typedef struct xfs_dsb { 188 __be32 sb_magicnum; /* magic number == XFS_SB_MAGIC */ 189 __be32 sb_blocksize; /* logical block size, bytes */ 190 __be64 sb_dblocks; /* number of data blocks */ 191 __be64 sb_rblocks; /* number of realtime blocks */ 192 __be64 sb_rextents; /* number of realtime extents */ 193 uuid_t sb_uuid; /* user-visible file system unique id */ 194 __be64 sb_logstart; /* starting block of log if internal */ 195 __be64 sb_rootino; /* root inode number */ 196 __be64 sb_rbmino; /* bitmap inode for realtime extents */ 197 __be64 sb_rsumino; /* summary inode for rt bitmap */ 198 __be32 sb_rextsize; /* realtime extent size, blocks */ 199 __be32 sb_agblocks; /* size of an allocation group */ 200 __be32 sb_agcount; /* number of allocation groups */ 201 __be32 sb_rbmblocks; /* number of rt bitmap blocks */ 202 __be32 sb_logblocks; /* number of log blocks */ 203 __be16 sb_versionnum; /* header version == XFS_SB_VERSION */ 204 __be16 sb_sectsize; /* volume sector size, bytes */ 205 __be16 sb_inodesize; /* inode size, bytes */ 206 __be16 sb_inopblock; /* inodes per block */ 207 char sb_fname[XFSLABEL_MAX]; /* file system name */ 208 __u8 sb_blocklog; /* log2 of sb_blocksize */ 209 __u8 sb_sectlog; /* log2 of sb_sectsize */ 210 __u8 sb_inodelog; /* log2 of sb_inodesize */ 211 __u8 sb_inopblog; /* log2 of sb_inopblock */ 212 __u8 sb_agblklog; /* log2 of sb_agblocks (rounded up) */ 213 __u8 sb_rextslog; /* log2 of sb_rextents */ 214 __u8 sb_inprogress; /* mkfs is in progress, don't mount */ 215 __u8 sb_imax_pct; /* max % of fs for inode space */ 216 /* statistics */ 217 /* 218 * These fields must remain contiguous. If you really 219 * want to change their layout, make sure you fix the 220 * code in xfs_trans_apply_sb_deltas(). 221 */ 222 __be64 sb_icount; /* allocated inodes */ 223 __be64 sb_ifree; /* free inodes */ 224 __be64 sb_fdblocks; /* free data blocks */ 225 __be64 sb_frextents; /* free realtime extents */ 226 /* 227 * End contiguous fields. 228 */ 229 __be64 sb_uquotino; /* user quota inode */ 230 __be64 sb_gquotino; /* group quota inode */ 231 __be16 sb_qflags; /* quota flags */ 232 __u8 sb_flags; /* misc. flags */ 233 __u8 sb_shared_vn; /* shared version number */ 234 __be32 sb_inoalignmt; /* inode chunk alignment, fsblocks */ 235 __be32 sb_unit; /* stripe or raid unit */ 236 __be32 sb_width; /* stripe or raid width */ 237 __u8 sb_dirblklog; /* log2 of dir block size (fsbs) */ 238 __u8 sb_logsectlog; /* log2 of the log sector size */ 239 __be16 sb_logsectsize; /* sector size for the log, bytes */ 240 __be32 sb_logsunit; /* stripe unit size for the log */ 241 __be32 sb_features2; /* additional feature bits */ 242 /* 243 * bad features2 field as a result of failing to pad the sb 244 * structure to 64 bits. Some machines will be using this field 245 * for features2 bits. Easiest just to mark it bad and not use 246 * it for anything else. 247 */ 248 __be32 sb_bad_features2; 249 250 /* version 5 superblock fields start here */ 251 252 /* feature masks */ 253 __be32 sb_features_compat; 254 __be32 sb_features_ro_compat; 255 __be32 sb_features_incompat; 256 __be32 sb_features_log_incompat; 257 258 __le32 sb_crc; /* superblock crc */ 259 __be32 sb_spino_align; /* sparse inode chunk alignment */ 260 261 __be64 sb_pquotino; /* project quota inode */ 262 __be64 sb_lsn; /* last write sequence */ 263 uuid_t sb_meta_uuid; /* metadata file system unique id */ 264 265 /* must be padded to 64 bit alignment */ 266 } xfs_dsb_t; 267 268 /* 269 * Misc. Flags - warning - these will be cleared by xfs_repair unless 270 * a feature bit is set when the flag is used. 271 */ 272 #define XFS_SBF_NOFLAGS 0x00 /* no flags set */ 273 #define XFS_SBF_READONLY 0x01 /* only read-only mounts allowed */ 274 275 /* 276 * define max. shared version we can interoperate with 277 */ 278 #define XFS_SB_MAX_SHARED_VN 0 279 280 #define XFS_SB_VERSION_NUM(sbp) ((sbp)->sb_versionnum & XFS_SB_VERSION_NUMBITS) 281 282 static inline bool xfs_sb_is_v5(struct xfs_sb *sbp) 283 { 284 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5; 285 } 286 287 /* 288 * Detect a mismatched features2 field. Older kernels read/wrote 289 * this into the wrong slot, so to be safe we keep them in sync. 290 */ 291 static inline bool xfs_sb_has_mismatched_features2(struct xfs_sb *sbp) 292 { 293 return sbp->sb_bad_features2 != sbp->sb_features2; 294 } 295 296 static inline bool xfs_sb_version_hasmorebits(struct xfs_sb *sbp) 297 { 298 return xfs_sb_is_v5(sbp) || 299 (sbp->sb_versionnum & XFS_SB_VERSION_MOREBITSBIT); 300 } 301 302 static inline void xfs_sb_version_addattr(struct xfs_sb *sbp) 303 { 304 sbp->sb_versionnum |= XFS_SB_VERSION_ATTRBIT; 305 } 306 307 static inline void xfs_sb_version_addquota(struct xfs_sb *sbp) 308 { 309 sbp->sb_versionnum |= XFS_SB_VERSION_QUOTABIT; 310 } 311 312 static inline void xfs_sb_version_addattr2(struct xfs_sb *sbp) 313 { 314 sbp->sb_versionnum |= XFS_SB_VERSION_MOREBITSBIT; 315 sbp->sb_features2 |= XFS_SB_VERSION2_ATTR2BIT; 316 } 317 318 static inline void xfs_sb_version_addprojid32(struct xfs_sb *sbp) 319 { 320 sbp->sb_versionnum |= XFS_SB_VERSION_MOREBITSBIT; 321 sbp->sb_features2 |= XFS_SB_VERSION2_PROJID32BIT; 322 } 323 324 /* 325 * Extended v5 superblock feature masks. These are to be used for new v5 326 * superblock features only. 327 * 328 * Compat features are new features that old kernels will not notice or affect 329 * and so can mount read-write without issues. 330 * 331 * RO-Compat (read only) are features that old kernels can read but will break 332 * if they write. Hence only read-only mounts of such filesystems are allowed on 333 * kernels that don't support the feature bit. 334 * 335 * InCompat features are features which old kernels will not understand and so 336 * must not mount. 337 * 338 * Log-InCompat features are for changes to log formats or new transactions that 339 * can't be replayed on older kernels. The fields are set when the filesystem is 340 * mounted, and a clean unmount clears the fields. 341 */ 342 #define XFS_SB_FEAT_COMPAT_ALL 0 343 #define XFS_SB_FEAT_COMPAT_UNKNOWN ~XFS_SB_FEAT_COMPAT_ALL 344 static inline bool 345 xfs_sb_has_compat_feature( 346 struct xfs_sb *sbp, 347 uint32_t feature) 348 { 349 return (sbp->sb_features_compat & feature) != 0; 350 } 351 352 #define XFS_SB_FEAT_RO_COMPAT_FINOBT (1 << 0) /* free inode btree */ 353 #define XFS_SB_FEAT_RO_COMPAT_RMAPBT (1 << 1) /* reverse map btree */ 354 #define XFS_SB_FEAT_RO_COMPAT_REFLINK (1 << 2) /* reflinked files */ 355 #define XFS_SB_FEAT_RO_COMPAT_INOBTCNT (1 << 3) /* inobt block counts */ 356 #define XFS_SB_FEAT_RO_COMPAT_ALL \ 357 (XFS_SB_FEAT_RO_COMPAT_FINOBT | \ 358 XFS_SB_FEAT_RO_COMPAT_RMAPBT | \ 359 XFS_SB_FEAT_RO_COMPAT_REFLINK| \ 360 XFS_SB_FEAT_RO_COMPAT_INOBTCNT) 361 #define XFS_SB_FEAT_RO_COMPAT_UNKNOWN ~XFS_SB_FEAT_RO_COMPAT_ALL 362 static inline bool 363 xfs_sb_has_ro_compat_feature( 364 struct xfs_sb *sbp, 365 uint32_t feature) 366 { 367 return (sbp->sb_features_ro_compat & feature) != 0; 368 } 369 370 #define XFS_SB_FEAT_INCOMPAT_FTYPE (1 << 0) /* filetype in dirent */ 371 #define XFS_SB_FEAT_INCOMPAT_SPINODES (1 << 1) /* sparse inode chunks */ 372 #define XFS_SB_FEAT_INCOMPAT_META_UUID (1 << 2) /* metadata UUID */ 373 #define XFS_SB_FEAT_INCOMPAT_BIGTIME (1 << 3) /* large timestamps */ 374 #define XFS_SB_FEAT_INCOMPAT_NEEDSREPAIR (1 << 4) /* needs xfs_repair */ 375 #define XFS_SB_FEAT_INCOMPAT_ALL \ 376 (XFS_SB_FEAT_INCOMPAT_FTYPE| \ 377 XFS_SB_FEAT_INCOMPAT_SPINODES| \ 378 XFS_SB_FEAT_INCOMPAT_META_UUID| \ 379 XFS_SB_FEAT_INCOMPAT_BIGTIME| \ 380 XFS_SB_FEAT_INCOMPAT_NEEDSREPAIR) 381 382 #define XFS_SB_FEAT_INCOMPAT_UNKNOWN ~XFS_SB_FEAT_INCOMPAT_ALL 383 static inline bool 384 xfs_sb_has_incompat_feature( 385 struct xfs_sb *sbp, 386 uint32_t feature) 387 { 388 return (sbp->sb_features_incompat & feature) != 0; 389 } 390 391 #define XFS_SB_FEAT_INCOMPAT_LOG_ALL 0 392 #define XFS_SB_FEAT_INCOMPAT_LOG_UNKNOWN ~XFS_SB_FEAT_INCOMPAT_LOG_ALL 393 static inline bool 394 xfs_sb_has_incompat_log_feature( 395 struct xfs_sb *sbp, 396 uint32_t feature) 397 { 398 return (sbp->sb_features_log_incompat & feature) != 0; 399 } 400 401 static inline void 402 xfs_sb_remove_incompat_log_features( 403 struct xfs_sb *sbp) 404 { 405 sbp->sb_features_log_incompat &= ~XFS_SB_FEAT_INCOMPAT_LOG_ALL; 406 } 407 408 static inline void 409 xfs_sb_add_incompat_log_features( 410 struct xfs_sb *sbp, 411 unsigned int features) 412 { 413 sbp->sb_features_log_incompat |= features; 414 } 415 416 417 /* 418 * v5 file systems support V3 inodes only, earlier file systems support 419 * v2 and v1 inodes. 420 */ 421 static inline bool xfs_dinode_good_version(struct xfs_sb *sbp, 422 uint8_t version) 423 { 424 if (xfs_sb_is_v5(sbp)) 425 return version == 3; 426 return version == 1 || version == 2; 427 } 428 429 static inline bool 430 xfs_is_quota_inode(struct xfs_sb *sbp, xfs_ino_t ino) 431 { 432 return (ino == sbp->sb_uquotino || 433 ino == sbp->sb_gquotino || 434 ino == sbp->sb_pquotino); 435 } 436 437 #define XFS_SB_DADDR ((xfs_daddr_t)0) /* daddr in filesystem/ag */ 438 #define XFS_SB_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_SB_DADDR) 439 440 #define XFS_HDR_BLOCK(mp,d) ((xfs_agblock_t)XFS_BB_TO_FSBT(mp,d)) 441 #define XFS_DADDR_TO_FSB(mp,d) XFS_AGB_TO_FSB(mp, \ 442 xfs_daddr_to_agno(mp,d), xfs_daddr_to_agbno(mp,d)) 443 #define XFS_FSB_TO_DADDR(mp,fsbno) XFS_AGB_TO_DADDR(mp, \ 444 XFS_FSB_TO_AGNO(mp,fsbno), XFS_FSB_TO_AGBNO(mp,fsbno)) 445 446 /* 447 * File system sector to basic block conversions. 448 */ 449 #define XFS_FSS_TO_BB(mp,sec) ((sec) << (mp)->m_sectbb_log) 450 451 /* 452 * File system block to basic block conversions. 453 */ 454 #define XFS_FSB_TO_BB(mp,fsbno) ((fsbno) << (mp)->m_blkbb_log) 455 #define XFS_BB_TO_FSB(mp,bb) \ 456 (((bb) + (XFS_FSB_TO_BB(mp,1) - 1)) >> (mp)->m_blkbb_log) 457 #define XFS_BB_TO_FSBT(mp,bb) ((bb) >> (mp)->m_blkbb_log) 458 459 /* 460 * File system block to byte conversions. 461 */ 462 #define XFS_FSB_TO_B(mp,fsbno) ((xfs_fsize_t)(fsbno) << (mp)->m_sb.sb_blocklog) 463 #define XFS_B_TO_FSB(mp,b) \ 464 ((((uint64_t)(b)) + (mp)->m_blockmask) >> (mp)->m_sb.sb_blocklog) 465 #define XFS_B_TO_FSBT(mp,b) (((uint64_t)(b)) >> (mp)->m_sb.sb_blocklog) 466 467 /* 468 * Allocation group header 469 * 470 * This is divided into three structures, placed in sequential 512-byte 471 * buffers after a copy of the superblock (also in a 512-byte buffer). 472 */ 473 #define XFS_AGF_MAGIC 0x58414746 /* 'XAGF' */ 474 #define XFS_AGI_MAGIC 0x58414749 /* 'XAGI' */ 475 #define XFS_AGFL_MAGIC 0x5841464c /* 'XAFL' */ 476 #define XFS_AGF_VERSION 1 477 #define XFS_AGI_VERSION 1 478 479 #define XFS_AGF_GOOD_VERSION(v) ((v) == XFS_AGF_VERSION) 480 #define XFS_AGI_GOOD_VERSION(v) ((v) == XFS_AGI_VERSION) 481 482 /* 483 * Btree number 0 is bno, 1 is cnt, 2 is rmap. This value gives the size of the 484 * arrays below. 485 */ 486 #define XFS_BTNUM_AGF ((int)XFS_BTNUM_RMAPi + 1) 487 488 /* 489 * The second word of agf_levels in the first a.g. overlaps the EFS 490 * superblock's magic number. Since the magic numbers valid for EFS 491 * are > 64k, our value cannot be confused for an EFS superblock's. 492 */ 493 494 typedef struct xfs_agf { 495 /* 496 * Common allocation group header information 497 */ 498 __be32 agf_magicnum; /* magic number == XFS_AGF_MAGIC */ 499 __be32 agf_versionnum; /* header version == XFS_AGF_VERSION */ 500 __be32 agf_seqno; /* sequence # starting from 0 */ 501 __be32 agf_length; /* size in blocks of a.g. */ 502 /* 503 * Freespace and rmap information 504 */ 505 __be32 agf_roots[XFS_BTNUM_AGF]; /* root blocks */ 506 __be32 agf_levels[XFS_BTNUM_AGF]; /* btree levels */ 507 508 __be32 agf_flfirst; /* first freelist block's index */ 509 __be32 agf_fllast; /* last freelist block's index */ 510 __be32 agf_flcount; /* count of blocks in freelist */ 511 __be32 agf_freeblks; /* total free blocks */ 512 513 __be32 agf_longest; /* longest free space */ 514 __be32 agf_btreeblks; /* # of blocks held in AGF btrees */ 515 uuid_t agf_uuid; /* uuid of filesystem */ 516 517 __be32 agf_rmap_blocks; /* rmapbt blocks used */ 518 __be32 agf_refcount_blocks; /* refcountbt blocks used */ 519 520 __be32 agf_refcount_root; /* refcount tree root block */ 521 __be32 agf_refcount_level; /* refcount btree levels */ 522 523 /* 524 * reserve some contiguous space for future logged fields before we add 525 * the unlogged fields. This makes the range logging via flags and 526 * structure offsets much simpler. 527 */ 528 __be64 agf_spare64[14]; 529 530 /* unlogged fields, written during buffer writeback. */ 531 __be64 agf_lsn; /* last write sequence */ 532 __be32 agf_crc; /* crc of agf sector */ 533 __be32 agf_spare2; 534 535 /* structure must be padded to 64 bit alignment */ 536 } xfs_agf_t; 537 538 #define XFS_AGF_CRC_OFF offsetof(struct xfs_agf, agf_crc) 539 540 #define XFS_AGF_MAGICNUM 0x00000001 541 #define XFS_AGF_VERSIONNUM 0x00000002 542 #define XFS_AGF_SEQNO 0x00000004 543 #define XFS_AGF_LENGTH 0x00000008 544 #define XFS_AGF_ROOTS 0x00000010 545 #define XFS_AGF_LEVELS 0x00000020 546 #define XFS_AGF_FLFIRST 0x00000040 547 #define XFS_AGF_FLLAST 0x00000080 548 #define XFS_AGF_FLCOUNT 0x00000100 549 #define XFS_AGF_FREEBLKS 0x00000200 550 #define XFS_AGF_LONGEST 0x00000400 551 #define XFS_AGF_BTREEBLKS 0x00000800 552 #define XFS_AGF_UUID 0x00001000 553 #define XFS_AGF_RMAP_BLOCKS 0x00002000 554 #define XFS_AGF_REFCOUNT_BLOCKS 0x00004000 555 #define XFS_AGF_REFCOUNT_ROOT 0x00008000 556 #define XFS_AGF_REFCOUNT_LEVEL 0x00010000 557 #define XFS_AGF_SPARE64 0x00020000 558 #define XFS_AGF_NUM_BITS 18 559 #define XFS_AGF_ALL_BITS ((1 << XFS_AGF_NUM_BITS) - 1) 560 561 #define XFS_AGF_FLAGS \ 562 { XFS_AGF_MAGICNUM, "MAGICNUM" }, \ 563 { XFS_AGF_VERSIONNUM, "VERSIONNUM" }, \ 564 { XFS_AGF_SEQNO, "SEQNO" }, \ 565 { XFS_AGF_LENGTH, "LENGTH" }, \ 566 { XFS_AGF_ROOTS, "ROOTS" }, \ 567 { XFS_AGF_LEVELS, "LEVELS" }, \ 568 { XFS_AGF_FLFIRST, "FLFIRST" }, \ 569 { XFS_AGF_FLLAST, "FLLAST" }, \ 570 { XFS_AGF_FLCOUNT, "FLCOUNT" }, \ 571 { XFS_AGF_FREEBLKS, "FREEBLKS" }, \ 572 { XFS_AGF_LONGEST, "LONGEST" }, \ 573 { XFS_AGF_BTREEBLKS, "BTREEBLKS" }, \ 574 { XFS_AGF_UUID, "UUID" }, \ 575 { XFS_AGF_RMAP_BLOCKS, "RMAP_BLOCKS" }, \ 576 { XFS_AGF_REFCOUNT_BLOCKS, "REFCOUNT_BLOCKS" }, \ 577 { XFS_AGF_REFCOUNT_ROOT, "REFCOUNT_ROOT" }, \ 578 { XFS_AGF_REFCOUNT_LEVEL, "REFCOUNT_LEVEL" }, \ 579 { XFS_AGF_SPARE64, "SPARE64" } 580 581 /* disk block (xfs_daddr_t) in the AG */ 582 #define XFS_AGF_DADDR(mp) ((xfs_daddr_t)(1 << (mp)->m_sectbb_log)) 583 #define XFS_AGF_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGF_DADDR(mp)) 584 585 /* 586 * Size of the unlinked inode hash table in the agi. 587 */ 588 #define XFS_AGI_UNLINKED_BUCKETS 64 589 590 typedef struct xfs_agi { 591 /* 592 * Common allocation group header information 593 */ 594 __be32 agi_magicnum; /* magic number == XFS_AGI_MAGIC */ 595 __be32 agi_versionnum; /* header version == XFS_AGI_VERSION */ 596 __be32 agi_seqno; /* sequence # starting from 0 */ 597 __be32 agi_length; /* size in blocks of a.g. */ 598 /* 599 * Inode information 600 * Inodes are mapped by interpreting the inode number, so no 601 * mapping data is needed here. 602 */ 603 __be32 agi_count; /* count of allocated inodes */ 604 __be32 agi_root; /* root of inode btree */ 605 __be32 agi_level; /* levels in inode btree */ 606 __be32 agi_freecount; /* number of free inodes */ 607 608 __be32 agi_newino; /* new inode just allocated */ 609 __be32 agi_dirino; /* last directory inode chunk */ 610 /* 611 * Hash table of inodes which have been unlinked but are 612 * still being referenced. 613 */ 614 __be32 agi_unlinked[XFS_AGI_UNLINKED_BUCKETS]; 615 /* 616 * This marks the end of logging region 1 and start of logging region 2. 617 */ 618 uuid_t agi_uuid; /* uuid of filesystem */ 619 __be32 agi_crc; /* crc of agi sector */ 620 __be32 agi_pad32; 621 __be64 agi_lsn; /* last write sequence */ 622 623 __be32 agi_free_root; /* root of the free inode btree */ 624 __be32 agi_free_level;/* levels in free inode btree */ 625 626 __be32 agi_iblocks; /* inobt blocks used */ 627 __be32 agi_fblocks; /* finobt blocks used */ 628 629 /* structure must be padded to 64 bit alignment */ 630 } xfs_agi_t; 631 632 #define XFS_AGI_CRC_OFF offsetof(struct xfs_agi, agi_crc) 633 634 #define XFS_AGI_MAGICNUM (1 << 0) 635 #define XFS_AGI_VERSIONNUM (1 << 1) 636 #define XFS_AGI_SEQNO (1 << 2) 637 #define XFS_AGI_LENGTH (1 << 3) 638 #define XFS_AGI_COUNT (1 << 4) 639 #define XFS_AGI_ROOT (1 << 5) 640 #define XFS_AGI_LEVEL (1 << 6) 641 #define XFS_AGI_FREECOUNT (1 << 7) 642 #define XFS_AGI_NEWINO (1 << 8) 643 #define XFS_AGI_DIRINO (1 << 9) 644 #define XFS_AGI_UNLINKED (1 << 10) 645 #define XFS_AGI_NUM_BITS_R1 11 /* end of the 1st agi logging region */ 646 #define XFS_AGI_ALL_BITS_R1 ((1 << XFS_AGI_NUM_BITS_R1) - 1) 647 #define XFS_AGI_FREE_ROOT (1 << 11) 648 #define XFS_AGI_FREE_LEVEL (1 << 12) 649 #define XFS_AGI_IBLOCKS (1 << 13) /* both inobt/finobt block counters */ 650 #define XFS_AGI_NUM_BITS_R2 14 651 652 /* disk block (xfs_daddr_t) in the AG */ 653 #define XFS_AGI_DADDR(mp) ((xfs_daddr_t)(2 << (mp)->m_sectbb_log)) 654 #define XFS_AGI_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGI_DADDR(mp)) 655 656 /* 657 * The third a.g. block contains the a.g. freelist, an array 658 * of block pointers to blocks owned by the allocation btree code. 659 */ 660 #define XFS_AGFL_DADDR(mp) ((xfs_daddr_t)(3 << (mp)->m_sectbb_log)) 661 #define XFS_AGFL_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGFL_DADDR(mp)) 662 #define XFS_BUF_TO_AGFL(bp) ((struct xfs_agfl *)((bp)->b_addr)) 663 664 struct xfs_agfl { 665 __be32 agfl_magicnum; 666 __be32 agfl_seqno; 667 uuid_t agfl_uuid; 668 __be64 agfl_lsn; 669 __be32 agfl_crc; 670 } __attribute__((packed)); 671 672 #define XFS_AGFL_CRC_OFF offsetof(struct xfs_agfl, agfl_crc) 673 674 #define XFS_AGB_TO_FSB(mp,agno,agbno) \ 675 (((xfs_fsblock_t)(agno) << (mp)->m_sb.sb_agblklog) | (agbno)) 676 #define XFS_FSB_TO_AGNO(mp,fsbno) \ 677 ((xfs_agnumber_t)((fsbno) >> (mp)->m_sb.sb_agblklog)) 678 #define XFS_FSB_TO_AGBNO(mp,fsbno) \ 679 ((xfs_agblock_t)((fsbno) & xfs_mask32lo((mp)->m_sb.sb_agblklog))) 680 #define XFS_AGB_TO_DADDR(mp,agno,agbno) \ 681 ((xfs_daddr_t)XFS_FSB_TO_BB(mp, \ 682 (xfs_fsblock_t)(agno) * (mp)->m_sb.sb_agblocks + (agbno))) 683 #define XFS_AG_DADDR(mp,agno,d) (XFS_AGB_TO_DADDR(mp, agno, 0) + (d)) 684 685 /* 686 * For checking for bad ranges of xfs_daddr_t's, covering multiple 687 * allocation groups or a single xfs_daddr_t that's a superblock copy. 688 */ 689 #define XFS_AG_CHECK_DADDR(mp,d,len) \ 690 ((len) == 1 ? \ 691 ASSERT((d) == XFS_SB_DADDR || \ 692 xfs_daddr_to_agbno(mp, d) != XFS_SB_DADDR) : \ 693 ASSERT(xfs_daddr_to_agno(mp, d) == \ 694 xfs_daddr_to_agno(mp, (d) + (len) - 1))) 695 696 /* 697 * XFS Timestamps 698 * ============== 699 * 700 * Traditional ondisk inode timestamps consist of signed 32-bit counters for 701 * seconds and nanoseconds; time zero is the Unix epoch, Jan 1 00:00:00 UTC 702 * 1970, which means that the timestamp epoch is the same as the Unix epoch. 703 * Therefore, the ondisk min and max defined here can be used directly to 704 * constrain the incore timestamps on a Unix system. Note that we actually 705 * encode a __be64 value on disk. 706 * 707 * When the bigtime feature is enabled, ondisk inode timestamps become an 708 * unsigned 64-bit nanoseconds counter. This means that the bigtime inode 709 * timestamp epoch is the start of the classic timestamp range, which is 710 * Dec 31 20:45:52 UTC 1901. Because the epochs are not the same, callers 711 * /must/ use the bigtime conversion functions when encoding and decoding raw 712 * timestamps. 713 */ 714 typedef __be64 xfs_timestamp_t; 715 716 /* Legacy timestamp encoding format. */ 717 struct xfs_legacy_timestamp { 718 __be32 t_sec; /* timestamp seconds */ 719 __be32 t_nsec; /* timestamp nanoseconds */ 720 }; 721 722 /* 723 * Smallest possible ondisk seconds value with traditional timestamps. This 724 * corresponds exactly with the incore timestamp Dec 13 20:45:52 UTC 1901. 725 */ 726 #define XFS_LEGACY_TIME_MIN ((int64_t)S32_MIN) 727 728 /* 729 * Largest possible ondisk seconds value with traditional timestamps. This 730 * corresponds exactly with the incore timestamp Jan 19 03:14:07 UTC 2038. 731 */ 732 #define XFS_LEGACY_TIME_MAX ((int64_t)S32_MAX) 733 734 /* 735 * Smallest possible ondisk seconds value with bigtime timestamps. This 736 * corresponds (after conversion to a Unix timestamp) with the traditional 737 * minimum timestamp of Dec 13 20:45:52 UTC 1901. 738 */ 739 #define XFS_BIGTIME_TIME_MIN ((int64_t)0) 740 741 /* 742 * Largest supported ondisk seconds value with bigtime timestamps. This 743 * corresponds (after conversion to a Unix timestamp) with an incore timestamp 744 * of Jul 2 20:20:24 UTC 2486. 745 * 746 * We round down the ondisk limit so that the bigtime quota and inode max 747 * timestamps will be the same. 748 */ 749 #define XFS_BIGTIME_TIME_MAX ((int64_t)((-1ULL / NSEC_PER_SEC) & ~0x3ULL)) 750 751 /* 752 * Bigtime epoch is set exactly to the minimum time value that a traditional 753 * 32-bit timestamp can represent when using the Unix epoch as a reference. 754 * Hence the Unix epoch is at a fixed offset into the supported bigtime 755 * timestamp range. 756 * 757 * The bigtime epoch also matches the minimum value an on-disk 32-bit XFS 758 * timestamp can represent so we will not lose any fidelity in converting 759 * to/from unix and bigtime timestamps. 760 * 761 * The following conversion factor converts a seconds counter from the Unix 762 * epoch to the bigtime epoch. 763 */ 764 #define XFS_BIGTIME_EPOCH_OFFSET (-(int64_t)S32_MIN) 765 766 /* Convert a timestamp from the Unix epoch to the bigtime epoch. */ 767 static inline uint64_t xfs_unix_to_bigtime(time64_t unix_seconds) 768 { 769 return (uint64_t)unix_seconds + XFS_BIGTIME_EPOCH_OFFSET; 770 } 771 772 /* Convert a timestamp from the bigtime epoch to the Unix epoch. */ 773 static inline time64_t xfs_bigtime_to_unix(uint64_t ondisk_seconds) 774 { 775 return (time64_t)ondisk_seconds - XFS_BIGTIME_EPOCH_OFFSET; 776 } 777 778 /* 779 * On-disk inode structure. 780 * 781 * This is just the header or "dinode core", the inode is expanded to fill a 782 * variable size the leftover area split into a data and an attribute fork. 783 * The format of the data and attribute fork depends on the format of the 784 * inode as indicated by di_format and di_aformat. To access the data and 785 * attribute use the XFS_DFORK_DPTR, XFS_DFORK_APTR, and XFS_DFORK_PTR macros 786 * below. 787 * 788 * There is a very similar struct xfs_log_dinode which matches the layout of 789 * this structure, but is kept in native format instead of big endian. 790 * 791 * Note: di_flushiter is only used by v1/2 inodes - it's effectively a zeroed 792 * padding field for v3 inodes. 793 */ 794 #define XFS_DINODE_MAGIC 0x494e /* 'IN' */ 795 typedef struct xfs_dinode { 796 __be16 di_magic; /* inode magic # = XFS_DINODE_MAGIC */ 797 __be16 di_mode; /* mode and type of file */ 798 __u8 di_version; /* inode version */ 799 __u8 di_format; /* format of di_c data */ 800 __be16 di_onlink; /* old number of links to file */ 801 __be32 di_uid; /* owner's user id */ 802 __be32 di_gid; /* owner's group id */ 803 __be32 di_nlink; /* number of links to file */ 804 __be16 di_projid_lo; /* lower part of owner's project id */ 805 __be16 di_projid_hi; /* higher part owner's project id */ 806 __u8 di_pad[6]; /* unused, zeroed space */ 807 __be16 di_flushiter; /* incremented on flush */ 808 xfs_timestamp_t di_atime; /* time last accessed */ 809 xfs_timestamp_t di_mtime; /* time last modified */ 810 xfs_timestamp_t di_ctime; /* time created/inode modified */ 811 __be64 di_size; /* number of bytes in file */ 812 __be64 di_nblocks; /* # of direct & btree blocks used */ 813 __be32 di_extsize; /* basic/minimum extent size for file */ 814 __be32 di_nextents; /* number of extents in data fork */ 815 __be16 di_anextents; /* number of extents in attribute fork*/ 816 __u8 di_forkoff; /* attr fork offs, <<3 for 64b align */ 817 __s8 di_aformat; /* format of attr fork's data */ 818 __be32 di_dmevmask; /* DMIG event mask */ 819 __be16 di_dmstate; /* DMIG state info */ 820 __be16 di_flags; /* random flags, XFS_DIFLAG_... */ 821 __be32 di_gen; /* generation number */ 822 823 /* di_next_unlinked is the only non-core field in the old dinode */ 824 __be32 di_next_unlinked;/* agi unlinked list ptr */ 825 826 /* start of the extended dinode, writable fields */ 827 __le32 di_crc; /* CRC of the inode */ 828 __be64 di_changecount; /* number of attribute changes */ 829 __be64 di_lsn; /* flush sequence */ 830 __be64 di_flags2; /* more random flags */ 831 __be32 di_cowextsize; /* basic cow extent size for file */ 832 __u8 di_pad2[12]; /* more padding for future expansion */ 833 834 /* fields only written to during inode creation */ 835 xfs_timestamp_t di_crtime; /* time created */ 836 __be64 di_ino; /* inode number */ 837 uuid_t di_uuid; /* UUID of the filesystem */ 838 839 /* structure must be padded to 64 bit alignment */ 840 } xfs_dinode_t; 841 842 #define XFS_DINODE_CRC_OFF offsetof(struct xfs_dinode, di_crc) 843 844 #define DI_MAX_FLUSH 0xffff 845 846 /* 847 * Size of the core inode on disk. Version 1 and 2 inodes have 848 * the same size, but version 3 has grown a few additional fields. 849 */ 850 static inline uint xfs_dinode_size(int version) 851 { 852 if (version == 3) 853 return sizeof(struct xfs_dinode); 854 return offsetof(struct xfs_dinode, di_crc); 855 } 856 857 /* 858 * The 32 bit link count in the inode theoretically maxes out at UINT_MAX. 859 * Since the pathconf interface is signed, we use 2^31 - 1 instead. 860 */ 861 #define XFS_MAXLINK ((1U << 31) - 1U) 862 863 /* 864 * Values for di_format 865 * 866 * This enum is used in string mapping in xfs_trace.h; please keep the 867 * TRACE_DEFINE_ENUMs for it up to date. 868 */ 869 enum xfs_dinode_fmt { 870 XFS_DINODE_FMT_DEV, /* xfs_dev_t */ 871 XFS_DINODE_FMT_LOCAL, /* bulk data */ 872 XFS_DINODE_FMT_EXTENTS, /* struct xfs_bmbt_rec */ 873 XFS_DINODE_FMT_BTREE, /* struct xfs_bmdr_block */ 874 XFS_DINODE_FMT_UUID /* added long ago, but never used */ 875 }; 876 877 #define XFS_INODE_FORMAT_STR \ 878 { XFS_DINODE_FMT_DEV, "dev" }, \ 879 { XFS_DINODE_FMT_LOCAL, "local" }, \ 880 { XFS_DINODE_FMT_EXTENTS, "extent" }, \ 881 { XFS_DINODE_FMT_BTREE, "btree" }, \ 882 { XFS_DINODE_FMT_UUID, "uuid" } 883 884 /* 885 * Inode minimum and maximum sizes. 886 */ 887 #define XFS_DINODE_MIN_LOG 8 888 #define XFS_DINODE_MAX_LOG 11 889 #define XFS_DINODE_MIN_SIZE (1 << XFS_DINODE_MIN_LOG) 890 #define XFS_DINODE_MAX_SIZE (1 << XFS_DINODE_MAX_LOG) 891 892 /* 893 * Inode size for given fs. 894 */ 895 #define XFS_DINODE_SIZE(sbp) \ 896 (xfs_sb_is_v5(sbp) ? \ 897 sizeof(struct xfs_dinode) : \ 898 offsetof(struct xfs_dinode, di_crc)) 899 #define XFS_LITINO(mp) \ 900 ((mp)->m_sb.sb_inodesize - XFS_DINODE_SIZE(&(mp)->m_sb)) 901 902 /* 903 * Inode data & attribute fork sizes, per inode. 904 */ 905 #define XFS_DFORK_BOFF(dip) ((int)((dip)->di_forkoff << 3)) 906 907 #define XFS_DFORK_DSIZE(dip,mp) \ 908 ((dip)->di_forkoff ? XFS_DFORK_BOFF(dip) : XFS_LITINO(mp)) 909 #define XFS_DFORK_ASIZE(dip,mp) \ 910 ((dip)->di_forkoff ? XFS_LITINO(mp) - XFS_DFORK_BOFF(dip) : 0) 911 #define XFS_DFORK_SIZE(dip,mp,w) \ 912 ((w) == XFS_DATA_FORK ? \ 913 XFS_DFORK_DSIZE(dip, mp) : \ 914 XFS_DFORK_ASIZE(dip, mp)) 915 916 #define XFS_DFORK_MAXEXT(dip, mp, w) \ 917 (XFS_DFORK_SIZE(dip, mp, w) / sizeof(struct xfs_bmbt_rec)) 918 919 /* 920 * Return pointers to the data or attribute forks. 921 */ 922 #define XFS_DFORK_DPTR(dip) \ 923 ((char *)dip + xfs_dinode_size(dip->di_version)) 924 #define XFS_DFORK_APTR(dip) \ 925 (XFS_DFORK_DPTR(dip) + XFS_DFORK_BOFF(dip)) 926 #define XFS_DFORK_PTR(dip,w) \ 927 ((w) == XFS_DATA_FORK ? XFS_DFORK_DPTR(dip) : XFS_DFORK_APTR(dip)) 928 929 #define XFS_DFORK_FORMAT(dip,w) \ 930 ((w) == XFS_DATA_FORK ? \ 931 (dip)->di_format : \ 932 (dip)->di_aformat) 933 #define XFS_DFORK_NEXTENTS(dip,w) \ 934 ((w) == XFS_DATA_FORK ? \ 935 be32_to_cpu((dip)->di_nextents) : \ 936 be16_to_cpu((dip)->di_anextents)) 937 938 /* 939 * For block and character special files the 32bit dev_t is stored at the 940 * beginning of the data fork. 941 */ 942 static inline xfs_dev_t xfs_dinode_get_rdev(struct xfs_dinode *dip) 943 { 944 return be32_to_cpu(*(__be32 *)XFS_DFORK_DPTR(dip)); 945 } 946 947 static inline void xfs_dinode_put_rdev(struct xfs_dinode *dip, xfs_dev_t rdev) 948 { 949 *(__be32 *)XFS_DFORK_DPTR(dip) = cpu_to_be32(rdev); 950 } 951 952 /* 953 * Values for di_flags 954 */ 955 #define XFS_DIFLAG_REALTIME_BIT 0 /* file's blocks come from rt area */ 956 #define XFS_DIFLAG_PREALLOC_BIT 1 /* file space has been preallocated */ 957 #define XFS_DIFLAG_NEWRTBM_BIT 2 /* for rtbitmap inode, new format */ 958 #define XFS_DIFLAG_IMMUTABLE_BIT 3 /* inode is immutable */ 959 #define XFS_DIFLAG_APPEND_BIT 4 /* inode is append-only */ 960 #define XFS_DIFLAG_SYNC_BIT 5 /* inode is written synchronously */ 961 #define XFS_DIFLAG_NOATIME_BIT 6 /* do not update atime */ 962 #define XFS_DIFLAG_NODUMP_BIT 7 /* do not dump */ 963 #define XFS_DIFLAG_RTINHERIT_BIT 8 /* create with realtime bit set */ 964 #define XFS_DIFLAG_PROJINHERIT_BIT 9 /* create with parents projid */ 965 #define XFS_DIFLAG_NOSYMLINKS_BIT 10 /* disallow symlink creation */ 966 #define XFS_DIFLAG_EXTSIZE_BIT 11 /* inode extent size allocator hint */ 967 #define XFS_DIFLAG_EXTSZINHERIT_BIT 12 /* inherit inode extent size */ 968 #define XFS_DIFLAG_NODEFRAG_BIT 13 /* do not reorganize/defragment */ 969 #define XFS_DIFLAG_FILESTREAM_BIT 14 /* use filestream allocator */ 970 /* Do not use bit 15, di_flags is legacy and unchanging now */ 971 972 #define XFS_DIFLAG_REALTIME (1 << XFS_DIFLAG_REALTIME_BIT) 973 #define XFS_DIFLAG_PREALLOC (1 << XFS_DIFLAG_PREALLOC_BIT) 974 #define XFS_DIFLAG_NEWRTBM (1 << XFS_DIFLAG_NEWRTBM_BIT) 975 #define XFS_DIFLAG_IMMUTABLE (1 << XFS_DIFLAG_IMMUTABLE_BIT) 976 #define XFS_DIFLAG_APPEND (1 << XFS_DIFLAG_APPEND_BIT) 977 #define XFS_DIFLAG_SYNC (1 << XFS_DIFLAG_SYNC_BIT) 978 #define XFS_DIFLAG_NOATIME (1 << XFS_DIFLAG_NOATIME_BIT) 979 #define XFS_DIFLAG_NODUMP (1 << XFS_DIFLAG_NODUMP_BIT) 980 #define XFS_DIFLAG_RTINHERIT (1 << XFS_DIFLAG_RTINHERIT_BIT) 981 #define XFS_DIFLAG_PROJINHERIT (1 << XFS_DIFLAG_PROJINHERIT_BIT) 982 #define XFS_DIFLAG_NOSYMLINKS (1 << XFS_DIFLAG_NOSYMLINKS_BIT) 983 #define XFS_DIFLAG_EXTSIZE (1 << XFS_DIFLAG_EXTSIZE_BIT) 984 #define XFS_DIFLAG_EXTSZINHERIT (1 << XFS_DIFLAG_EXTSZINHERIT_BIT) 985 #define XFS_DIFLAG_NODEFRAG (1 << XFS_DIFLAG_NODEFRAG_BIT) 986 #define XFS_DIFLAG_FILESTREAM (1 << XFS_DIFLAG_FILESTREAM_BIT) 987 988 #define XFS_DIFLAG_ANY \ 989 (XFS_DIFLAG_REALTIME | XFS_DIFLAG_PREALLOC | XFS_DIFLAG_NEWRTBM | \ 990 XFS_DIFLAG_IMMUTABLE | XFS_DIFLAG_APPEND | XFS_DIFLAG_SYNC | \ 991 XFS_DIFLAG_NOATIME | XFS_DIFLAG_NODUMP | XFS_DIFLAG_RTINHERIT | \ 992 XFS_DIFLAG_PROJINHERIT | XFS_DIFLAG_NOSYMLINKS | XFS_DIFLAG_EXTSIZE | \ 993 XFS_DIFLAG_EXTSZINHERIT | XFS_DIFLAG_NODEFRAG | XFS_DIFLAG_FILESTREAM) 994 995 /* 996 * Values for di_flags2 These start by being exposed to userspace in the upper 997 * 16 bits of the XFS_XFLAG_s range. 998 */ 999 #define XFS_DIFLAG2_DAX_BIT 0 /* use DAX for this inode */ 1000 #define XFS_DIFLAG2_REFLINK_BIT 1 /* file's blocks may be shared */ 1001 #define XFS_DIFLAG2_COWEXTSIZE_BIT 2 /* copy on write extent size hint */ 1002 #define XFS_DIFLAG2_BIGTIME_BIT 3 /* big timestamps */ 1003 1004 #define XFS_DIFLAG2_DAX (1 << XFS_DIFLAG2_DAX_BIT) 1005 #define XFS_DIFLAG2_REFLINK (1 << XFS_DIFLAG2_REFLINK_BIT) 1006 #define XFS_DIFLAG2_COWEXTSIZE (1 << XFS_DIFLAG2_COWEXTSIZE_BIT) 1007 #define XFS_DIFLAG2_BIGTIME (1 << XFS_DIFLAG2_BIGTIME_BIT) 1008 1009 #define XFS_DIFLAG2_ANY \ 1010 (XFS_DIFLAG2_DAX | XFS_DIFLAG2_REFLINK | XFS_DIFLAG2_COWEXTSIZE | \ 1011 XFS_DIFLAG2_BIGTIME) 1012 1013 static inline bool xfs_dinode_has_bigtime(const struct xfs_dinode *dip) 1014 { 1015 return dip->di_version >= 3 && 1016 (dip->di_flags2 & cpu_to_be64(XFS_DIFLAG2_BIGTIME)); 1017 } 1018 1019 /* 1020 * Inode number format: 1021 * low inopblog bits - offset in block 1022 * next agblklog bits - block number in ag 1023 * next agno_log bits - ag number 1024 * high agno_log-agblklog-inopblog bits - 0 1025 */ 1026 #define XFS_INO_MASK(k) (uint32_t)((1ULL << (k)) - 1) 1027 #define XFS_INO_OFFSET_BITS(mp) (mp)->m_sb.sb_inopblog 1028 #define XFS_INO_AGBNO_BITS(mp) (mp)->m_sb.sb_agblklog 1029 #define XFS_INO_AGINO_BITS(mp) ((mp)->m_ino_geo.agino_log) 1030 #define XFS_INO_AGNO_BITS(mp) (mp)->m_agno_log 1031 #define XFS_INO_BITS(mp) \ 1032 XFS_INO_AGNO_BITS(mp) + XFS_INO_AGINO_BITS(mp) 1033 #define XFS_INO_TO_AGNO(mp,i) \ 1034 ((xfs_agnumber_t)((i) >> XFS_INO_AGINO_BITS(mp))) 1035 #define XFS_INO_TO_AGINO(mp,i) \ 1036 ((xfs_agino_t)(i) & XFS_INO_MASK(XFS_INO_AGINO_BITS(mp))) 1037 #define XFS_INO_TO_AGBNO(mp,i) \ 1038 (((xfs_agblock_t)(i) >> XFS_INO_OFFSET_BITS(mp)) & \ 1039 XFS_INO_MASK(XFS_INO_AGBNO_BITS(mp))) 1040 #define XFS_INO_TO_OFFSET(mp,i) \ 1041 ((int)(i) & XFS_INO_MASK(XFS_INO_OFFSET_BITS(mp))) 1042 #define XFS_INO_TO_FSB(mp,i) \ 1043 XFS_AGB_TO_FSB(mp, XFS_INO_TO_AGNO(mp,i), XFS_INO_TO_AGBNO(mp,i)) 1044 #define XFS_AGINO_TO_INO(mp,a,i) \ 1045 (((xfs_ino_t)(a) << XFS_INO_AGINO_BITS(mp)) | (i)) 1046 #define XFS_AGINO_TO_AGBNO(mp,i) ((i) >> XFS_INO_OFFSET_BITS(mp)) 1047 #define XFS_AGINO_TO_OFFSET(mp,i) \ 1048 ((i) & XFS_INO_MASK(XFS_INO_OFFSET_BITS(mp))) 1049 #define XFS_OFFBNO_TO_AGINO(mp,b,o) \ 1050 ((xfs_agino_t)(((b) << XFS_INO_OFFSET_BITS(mp)) | (o))) 1051 #define XFS_FSB_TO_INO(mp, b) ((xfs_ino_t)((b) << XFS_INO_OFFSET_BITS(mp))) 1052 #define XFS_AGB_TO_AGINO(mp, b) ((xfs_agino_t)((b) << XFS_INO_OFFSET_BITS(mp))) 1053 1054 #define XFS_MAXINUMBER ((xfs_ino_t)((1ULL << 56) - 1ULL)) 1055 #define XFS_MAXINUMBER_32 ((xfs_ino_t)((1ULL << 32) - 1ULL)) 1056 1057 /* 1058 * RealTime Device format definitions 1059 */ 1060 1061 /* Min and max rt extent sizes, specified in bytes */ 1062 #define XFS_MAX_RTEXTSIZE (1024 * 1024 * 1024) /* 1GB */ 1063 #define XFS_DFL_RTEXTSIZE (64 * 1024) /* 64kB */ 1064 #define XFS_MIN_RTEXTSIZE (4 * 1024) /* 4kB */ 1065 1066 #define XFS_BLOCKSIZE(mp) ((mp)->m_sb.sb_blocksize) 1067 #define XFS_BLOCKMASK(mp) ((mp)->m_blockmask) 1068 #define XFS_BLOCKWSIZE(mp) ((mp)->m_blockwsize) 1069 #define XFS_BLOCKWMASK(mp) ((mp)->m_blockwmask) 1070 1071 /* 1072 * RT Summary and bit manipulation macros. 1073 */ 1074 #define XFS_SUMOFFS(mp,ls,bb) ((int)((ls) * (mp)->m_sb.sb_rbmblocks + (bb))) 1075 #define XFS_SUMOFFSTOBLOCK(mp,s) \ 1076 (((s) * (uint)sizeof(xfs_suminfo_t)) >> (mp)->m_sb.sb_blocklog) 1077 #define XFS_SUMPTR(mp,bp,so) \ 1078 ((xfs_suminfo_t *)((bp)->b_addr + \ 1079 (((so) * (uint)sizeof(xfs_suminfo_t)) & XFS_BLOCKMASK(mp)))) 1080 1081 #define XFS_BITTOBLOCK(mp,bi) ((bi) >> (mp)->m_blkbit_log) 1082 #define XFS_BLOCKTOBIT(mp,bb) ((bb) << (mp)->m_blkbit_log) 1083 #define XFS_BITTOWORD(mp,bi) \ 1084 ((int)(((bi) >> XFS_NBWORDLOG) & XFS_BLOCKWMASK(mp))) 1085 1086 #define XFS_RTMIN(a,b) ((a) < (b) ? (a) : (b)) 1087 #define XFS_RTMAX(a,b) ((a) > (b) ? (a) : (b)) 1088 1089 #define XFS_RTLOBIT(w) xfs_lowbit32(w) 1090 #define XFS_RTHIBIT(w) xfs_highbit32(w) 1091 1092 #define XFS_RTBLOCKLOG(b) xfs_highbit64(b) 1093 1094 /* 1095 * Dquot and dquot block format definitions 1096 */ 1097 #define XFS_DQUOT_MAGIC 0x4451 /* 'DQ' */ 1098 #define XFS_DQUOT_VERSION (uint8_t)0x01 /* latest version number */ 1099 1100 #define XFS_DQTYPE_USER 0x01 /* user dquot record */ 1101 #define XFS_DQTYPE_PROJ 0x02 /* project dquot record */ 1102 #define XFS_DQTYPE_GROUP 0x04 /* group dquot record */ 1103 #define XFS_DQTYPE_BIGTIME 0x80 /* large expiry timestamps */ 1104 1105 /* bitmask to determine if this is a user/group/project dquot */ 1106 #define XFS_DQTYPE_REC_MASK (XFS_DQTYPE_USER | \ 1107 XFS_DQTYPE_PROJ | \ 1108 XFS_DQTYPE_GROUP) 1109 1110 #define XFS_DQTYPE_ANY (XFS_DQTYPE_REC_MASK | \ 1111 XFS_DQTYPE_BIGTIME) 1112 1113 /* 1114 * XFS Quota Timers 1115 * ================ 1116 * 1117 * Traditional quota grace period expiration timers are an unsigned 32-bit 1118 * seconds counter; time zero is the Unix epoch, Jan 1 00:00:01 UTC 1970. 1119 * Note that an expiration value of zero means that the quota limit has not 1120 * been reached, and therefore no expiration has been set. Therefore, the 1121 * ondisk min and max defined here can be used directly to constrain the incore 1122 * quota expiration timestamps on a Unix system. 1123 * 1124 * When bigtime is enabled, we trade two bits of precision to expand the 1125 * expiration timeout range to match that of big inode timestamps. The min and 1126 * max recorded here are the on-disk limits, not a Unix timestamp. 1127 * 1128 * The grace period for each quota type is stored in the root dquot (id = 0) 1129 * and is applied to a non-root dquot when it exceeds the soft or hard limits. 1130 * The length of quota grace periods are unsigned 32-bit quantities measured in 1131 * units of seconds. A value of zero means to use the default period. 1132 */ 1133 1134 /* 1135 * Smallest possible ondisk quota expiration value with traditional timestamps. 1136 * This corresponds exactly with the incore expiration Jan 1 00:00:01 UTC 1970. 1137 */ 1138 #define XFS_DQ_LEGACY_EXPIRY_MIN ((int64_t)1) 1139 1140 /* 1141 * Largest possible ondisk quota expiration value with traditional timestamps. 1142 * This corresponds exactly with the incore expiration Feb 7 06:28:15 UTC 2106. 1143 */ 1144 #define XFS_DQ_LEGACY_EXPIRY_MAX ((int64_t)U32_MAX) 1145 1146 /* 1147 * Smallest possible ondisk quota expiration value with bigtime timestamps. 1148 * This corresponds (after conversion to a Unix timestamp) with the incore 1149 * expiration of Jan 1 00:00:04 UTC 1970. 1150 */ 1151 #define XFS_DQ_BIGTIME_EXPIRY_MIN (XFS_DQ_LEGACY_EXPIRY_MIN) 1152 1153 /* 1154 * Largest supported ondisk quota expiration value with bigtime timestamps. 1155 * This corresponds (after conversion to a Unix timestamp) with an incore 1156 * expiration of Jul 2 20:20:24 UTC 2486. 1157 * 1158 * The ondisk field supports values up to -1U, which corresponds to an incore 1159 * expiration in 2514. This is beyond the maximum the bigtime inode timestamp, 1160 * so we cap the maximum bigtime quota expiration to the max inode timestamp. 1161 */ 1162 #define XFS_DQ_BIGTIME_EXPIRY_MAX ((int64_t)4074815106U) 1163 1164 /* 1165 * The following conversion factors assist in converting a quota expiration 1166 * timestamp between the incore and ondisk formats. 1167 */ 1168 #define XFS_DQ_BIGTIME_SHIFT (2) 1169 #define XFS_DQ_BIGTIME_SLACK ((int64_t)(1ULL << XFS_DQ_BIGTIME_SHIFT) - 1) 1170 1171 /* Convert an incore quota expiration timestamp to an ondisk bigtime value. */ 1172 static inline uint32_t xfs_dq_unix_to_bigtime(time64_t unix_seconds) 1173 { 1174 /* 1175 * Round the expiration timestamp up to the nearest bigtime timestamp 1176 * that we can store, to give users the most time to fix problems. 1177 */ 1178 return ((uint64_t)unix_seconds + XFS_DQ_BIGTIME_SLACK) >> 1179 XFS_DQ_BIGTIME_SHIFT; 1180 } 1181 1182 /* Convert an ondisk bigtime quota expiration value to an incore timestamp. */ 1183 static inline time64_t xfs_dq_bigtime_to_unix(uint32_t ondisk_seconds) 1184 { 1185 return (time64_t)ondisk_seconds << XFS_DQ_BIGTIME_SHIFT; 1186 } 1187 1188 /* 1189 * Default quota grace periods, ranging from zero (use the compiled defaults) 1190 * to ~136 years. These are applied to a non-root dquot that has exceeded 1191 * either limit. 1192 */ 1193 #define XFS_DQ_GRACE_MIN ((int64_t)0) 1194 #define XFS_DQ_GRACE_MAX ((int64_t)U32_MAX) 1195 1196 /* 1197 * This is the main portion of the on-disk representation of quota information 1198 * for a user. We pad this with some more expansion room to construct the on 1199 * disk structure. 1200 */ 1201 struct xfs_disk_dquot { 1202 __be16 d_magic; /* dquot magic = XFS_DQUOT_MAGIC */ 1203 __u8 d_version; /* dquot version */ 1204 __u8 d_type; /* XFS_DQTYPE_USER/PROJ/GROUP */ 1205 __be32 d_id; /* user,project,group id */ 1206 __be64 d_blk_hardlimit;/* absolute limit on disk blks */ 1207 __be64 d_blk_softlimit;/* preferred limit on disk blks */ 1208 __be64 d_ino_hardlimit;/* maximum # allocated inodes */ 1209 __be64 d_ino_softlimit;/* preferred inode limit */ 1210 __be64 d_bcount; /* disk blocks owned by the user */ 1211 __be64 d_icount; /* inodes owned by the user */ 1212 __be32 d_itimer; /* zero if within inode limits if not, 1213 this is when we refuse service */ 1214 __be32 d_btimer; /* similar to above; for disk blocks */ 1215 __be16 d_iwarns; /* warnings issued wrt num inodes */ 1216 __be16 d_bwarns; /* warnings issued wrt disk blocks */ 1217 __be32 d_pad0; /* 64 bit align */ 1218 __be64 d_rtb_hardlimit;/* absolute limit on realtime blks */ 1219 __be64 d_rtb_softlimit;/* preferred limit on RT disk blks */ 1220 __be64 d_rtbcount; /* realtime blocks owned */ 1221 __be32 d_rtbtimer; /* similar to above; for RT disk blocks */ 1222 __be16 d_rtbwarns; /* warnings issued wrt RT disk blocks */ 1223 __be16 d_pad; 1224 }; 1225 1226 /* 1227 * This is what goes on disk. This is separated from the xfs_disk_dquot because 1228 * carrying the unnecessary padding would be a waste of memory. 1229 */ 1230 typedef struct xfs_dqblk { 1231 struct xfs_disk_dquot dd_diskdq; /* portion living incore as well */ 1232 char dd_fill[4];/* filling for posterity */ 1233 1234 /* 1235 * These two are only present on filesystems with the CRC bits set. 1236 */ 1237 __be32 dd_crc; /* checksum */ 1238 __be64 dd_lsn; /* last modification in log */ 1239 uuid_t dd_uuid; /* location information */ 1240 } xfs_dqblk_t; 1241 1242 #define XFS_DQUOT_CRC_OFF offsetof(struct xfs_dqblk, dd_crc) 1243 1244 /* 1245 * This defines the unit of allocation of dquots. 1246 * 1247 * Currently, it is just one file system block, and a 4K blk contains 30 1248 * (136 * 30 = 4080) dquots. It's probably not worth trying to make 1249 * this more dynamic. 1250 * 1251 * However, if this number is changed, we have to make sure that we don't 1252 * implicitly assume that we do allocations in chunks of a single filesystem 1253 * block in the dquot/xqm code. 1254 * 1255 * This is part of the ondisk format because the structure size is not a power 1256 * of two, which leaves slack at the end of the disk block. 1257 */ 1258 #define XFS_DQUOT_CLUSTER_SIZE_FSB (xfs_filblks_t)1 1259 1260 /* 1261 * Remote symlink format and access functions. 1262 */ 1263 #define XFS_SYMLINK_MAGIC 0x58534c4d /* XSLM */ 1264 1265 struct xfs_dsymlink_hdr { 1266 __be32 sl_magic; 1267 __be32 sl_offset; 1268 __be32 sl_bytes; 1269 __be32 sl_crc; 1270 uuid_t sl_uuid; 1271 __be64 sl_owner; 1272 __be64 sl_blkno; 1273 __be64 sl_lsn; 1274 }; 1275 1276 #define XFS_SYMLINK_CRC_OFF offsetof(struct xfs_dsymlink_hdr, sl_crc) 1277 1278 #define XFS_SYMLINK_MAXLEN 1024 1279 /* 1280 * The maximum pathlen is 1024 bytes. Since the minimum file system 1281 * blocksize is 512 bytes, we can get a max of 3 extents back from 1282 * bmapi when crc headers are taken into account. 1283 */ 1284 #define XFS_SYMLINK_MAPS 3 1285 1286 #define XFS_SYMLINK_BUF_SPACE(mp, bufsize) \ 1287 ((bufsize) - (xfs_has_crc((mp)) ? \ 1288 sizeof(struct xfs_dsymlink_hdr) : 0)) 1289 1290 1291 /* 1292 * Allocation Btree format definitions 1293 * 1294 * There are two on-disk btrees, one sorted by blockno and one sorted 1295 * by blockcount and blockno. All blocks look the same to make the code 1296 * simpler; if we have time later, we'll make the optimizations. 1297 */ 1298 #define XFS_ABTB_MAGIC 0x41425442 /* 'ABTB' for bno tree */ 1299 #define XFS_ABTB_CRC_MAGIC 0x41423342 /* 'AB3B' */ 1300 #define XFS_ABTC_MAGIC 0x41425443 /* 'ABTC' for cnt tree */ 1301 #define XFS_ABTC_CRC_MAGIC 0x41423343 /* 'AB3C' */ 1302 1303 /* 1304 * Data record/key structure 1305 */ 1306 typedef struct xfs_alloc_rec { 1307 __be32 ar_startblock; /* starting block number */ 1308 __be32 ar_blockcount; /* count of free blocks */ 1309 } xfs_alloc_rec_t, xfs_alloc_key_t; 1310 1311 typedef struct xfs_alloc_rec_incore { 1312 xfs_agblock_t ar_startblock; /* starting block number */ 1313 xfs_extlen_t ar_blockcount; /* count of free blocks */ 1314 } xfs_alloc_rec_incore_t; 1315 1316 /* btree pointer type */ 1317 typedef __be32 xfs_alloc_ptr_t; 1318 1319 /* 1320 * Block numbers in the AG: 1321 * SB is sector 0, AGF is sector 1, AGI is sector 2, AGFL is sector 3. 1322 */ 1323 #define XFS_BNO_BLOCK(mp) ((xfs_agblock_t)(XFS_AGFL_BLOCK(mp) + 1)) 1324 #define XFS_CNT_BLOCK(mp) ((xfs_agblock_t)(XFS_BNO_BLOCK(mp) + 1)) 1325 1326 1327 /* 1328 * Inode Allocation Btree format definitions 1329 * 1330 * There is a btree for the inode map per allocation group. 1331 */ 1332 #define XFS_IBT_MAGIC 0x49414254 /* 'IABT' */ 1333 #define XFS_IBT_CRC_MAGIC 0x49414233 /* 'IAB3' */ 1334 #define XFS_FIBT_MAGIC 0x46494254 /* 'FIBT' */ 1335 #define XFS_FIBT_CRC_MAGIC 0x46494233 /* 'FIB3' */ 1336 1337 typedef uint64_t xfs_inofree_t; 1338 #define XFS_INODES_PER_CHUNK (NBBY * sizeof(xfs_inofree_t)) 1339 #define XFS_INODES_PER_CHUNK_LOG (XFS_NBBYLOG + 3) 1340 #define XFS_INOBT_ALL_FREE ((xfs_inofree_t)-1) 1341 #define XFS_INOBT_MASK(i) ((xfs_inofree_t)1 << (i)) 1342 1343 #define XFS_INOBT_HOLEMASK_FULL 0 /* holemask for full chunk */ 1344 #define XFS_INOBT_HOLEMASK_BITS (NBBY * sizeof(uint16_t)) 1345 #define XFS_INODES_PER_HOLEMASK_BIT \ 1346 (XFS_INODES_PER_CHUNK / (NBBY * sizeof(uint16_t))) 1347 1348 static inline xfs_inofree_t xfs_inobt_maskn(int i, int n) 1349 { 1350 return ((n >= XFS_INODES_PER_CHUNK ? 0 : XFS_INOBT_MASK(n)) - 1) << i; 1351 } 1352 1353 /* 1354 * The on-disk inode record structure has two formats. The original "full" 1355 * format uses a 4-byte freecount. The "sparse" format uses a 1-byte freecount 1356 * and replaces the 3 high-order freecount bytes wth the holemask and inode 1357 * count. 1358 * 1359 * The holemask of the sparse record format allows an inode chunk to have holes 1360 * that refer to blocks not owned by the inode record. This facilitates inode 1361 * allocation in the event of severe free space fragmentation. 1362 */ 1363 typedef struct xfs_inobt_rec { 1364 __be32 ir_startino; /* starting inode number */ 1365 union { 1366 struct { 1367 __be32 ir_freecount; /* count of free inodes */ 1368 } f; 1369 struct { 1370 __be16 ir_holemask;/* hole mask for sparse chunks */ 1371 __u8 ir_count; /* total inode count */ 1372 __u8 ir_freecount; /* count of free inodes */ 1373 } sp; 1374 } ir_u; 1375 __be64 ir_free; /* free inode mask */ 1376 } xfs_inobt_rec_t; 1377 1378 typedef struct xfs_inobt_rec_incore { 1379 xfs_agino_t ir_startino; /* starting inode number */ 1380 uint16_t ir_holemask; /* hole mask for sparse chunks */ 1381 uint8_t ir_count; /* total inode count */ 1382 uint8_t ir_freecount; /* count of free inodes (set bits) */ 1383 xfs_inofree_t ir_free; /* free inode mask */ 1384 } xfs_inobt_rec_incore_t; 1385 1386 static inline bool xfs_inobt_issparse(uint16_t holemask) 1387 { 1388 /* non-zero holemask represents a sparse rec. */ 1389 return holemask; 1390 } 1391 1392 /* 1393 * Key structure 1394 */ 1395 typedef struct xfs_inobt_key { 1396 __be32 ir_startino; /* starting inode number */ 1397 } xfs_inobt_key_t; 1398 1399 /* btree pointer type */ 1400 typedef __be32 xfs_inobt_ptr_t; 1401 1402 /* 1403 * block numbers in the AG. 1404 */ 1405 #define XFS_IBT_BLOCK(mp) ((xfs_agblock_t)(XFS_CNT_BLOCK(mp) + 1)) 1406 #define XFS_FIBT_BLOCK(mp) ((xfs_agblock_t)(XFS_IBT_BLOCK(mp) + 1)) 1407 1408 /* 1409 * Reverse mapping btree format definitions 1410 * 1411 * There is a btree for the reverse map per allocation group 1412 */ 1413 #define XFS_RMAP_CRC_MAGIC 0x524d4233 /* 'RMB3' */ 1414 1415 /* 1416 * Ownership info for an extent. This is used to create reverse-mapping 1417 * entries. 1418 */ 1419 #define XFS_OWNER_INFO_ATTR_FORK (1 << 0) 1420 #define XFS_OWNER_INFO_BMBT_BLOCK (1 << 1) 1421 struct xfs_owner_info { 1422 uint64_t oi_owner; 1423 xfs_fileoff_t oi_offset; 1424 unsigned int oi_flags; 1425 }; 1426 1427 /* 1428 * Special owner types. 1429 * 1430 * Seeing as we only support up to 8EB, we have the upper bit of the owner field 1431 * to tell us we have a special owner value. We use these for static metadata 1432 * allocated at mkfs/growfs time, as well as for freespace management metadata. 1433 */ 1434 #define XFS_RMAP_OWN_NULL (-1ULL) /* No owner, for growfs */ 1435 #define XFS_RMAP_OWN_UNKNOWN (-2ULL) /* Unknown owner, for EFI recovery */ 1436 #define XFS_RMAP_OWN_FS (-3ULL) /* static fs metadata */ 1437 #define XFS_RMAP_OWN_LOG (-4ULL) /* static fs metadata */ 1438 #define XFS_RMAP_OWN_AG (-5ULL) /* AG freespace btree blocks */ 1439 #define XFS_RMAP_OWN_INOBT (-6ULL) /* Inode btree blocks */ 1440 #define XFS_RMAP_OWN_INODES (-7ULL) /* Inode chunk */ 1441 #define XFS_RMAP_OWN_REFC (-8ULL) /* refcount tree */ 1442 #define XFS_RMAP_OWN_COW (-9ULL) /* cow allocations */ 1443 #define XFS_RMAP_OWN_MIN (-10ULL) /* guard */ 1444 1445 #define XFS_RMAP_NON_INODE_OWNER(owner) (!!((owner) & (1ULL << 63))) 1446 1447 /* 1448 * Data record structure 1449 */ 1450 struct xfs_rmap_rec { 1451 __be32 rm_startblock; /* extent start block */ 1452 __be32 rm_blockcount; /* extent length */ 1453 __be64 rm_owner; /* extent owner */ 1454 __be64 rm_offset; /* offset within the owner */ 1455 }; 1456 1457 /* 1458 * rmap btree record 1459 * rm_offset:63 is the attribute fork flag 1460 * rm_offset:62 is the bmbt block flag 1461 * rm_offset:61 is the unwritten extent flag (same as l0:63 in bmbt) 1462 * rm_offset:54-60 aren't used and should be zero 1463 * rm_offset:0-53 is the block offset within the inode 1464 */ 1465 #define XFS_RMAP_OFF_ATTR_FORK ((uint64_t)1ULL << 63) 1466 #define XFS_RMAP_OFF_BMBT_BLOCK ((uint64_t)1ULL << 62) 1467 #define XFS_RMAP_OFF_UNWRITTEN ((uint64_t)1ULL << 61) 1468 1469 #define XFS_RMAP_LEN_MAX ((uint32_t)~0U) 1470 #define XFS_RMAP_OFF_FLAGS (XFS_RMAP_OFF_ATTR_FORK | \ 1471 XFS_RMAP_OFF_BMBT_BLOCK | \ 1472 XFS_RMAP_OFF_UNWRITTEN) 1473 #define XFS_RMAP_OFF_MASK ((uint64_t)0x3FFFFFFFFFFFFFULL) 1474 1475 #define XFS_RMAP_OFF(off) ((off) & XFS_RMAP_OFF_MASK) 1476 1477 #define XFS_RMAP_IS_BMBT_BLOCK(off) (!!((off) & XFS_RMAP_OFF_BMBT_BLOCK)) 1478 #define XFS_RMAP_IS_ATTR_FORK(off) (!!((off) & XFS_RMAP_OFF_ATTR_FORK)) 1479 #define XFS_RMAP_IS_UNWRITTEN(len) (!!((off) & XFS_RMAP_OFF_UNWRITTEN)) 1480 1481 #define RMAPBT_STARTBLOCK_BITLEN 32 1482 #define RMAPBT_BLOCKCOUNT_BITLEN 32 1483 #define RMAPBT_OWNER_BITLEN 64 1484 #define RMAPBT_ATTRFLAG_BITLEN 1 1485 #define RMAPBT_BMBTFLAG_BITLEN 1 1486 #define RMAPBT_EXNTFLAG_BITLEN 1 1487 #define RMAPBT_UNUSED_OFFSET_BITLEN 7 1488 #define RMAPBT_OFFSET_BITLEN 54 1489 1490 #define XFS_RMAP_ATTR_FORK (1 << 0) 1491 #define XFS_RMAP_BMBT_BLOCK (1 << 1) 1492 #define XFS_RMAP_UNWRITTEN (1 << 2) 1493 #define XFS_RMAP_KEY_FLAGS (XFS_RMAP_ATTR_FORK | \ 1494 XFS_RMAP_BMBT_BLOCK) 1495 #define XFS_RMAP_REC_FLAGS (XFS_RMAP_UNWRITTEN) 1496 struct xfs_rmap_irec { 1497 xfs_agblock_t rm_startblock; /* extent start block */ 1498 xfs_extlen_t rm_blockcount; /* extent length */ 1499 uint64_t rm_owner; /* extent owner */ 1500 uint64_t rm_offset; /* offset within the owner */ 1501 unsigned int rm_flags; /* state flags */ 1502 }; 1503 1504 /* 1505 * Key structure 1506 * 1507 * We don't use the length for lookups 1508 */ 1509 struct xfs_rmap_key { 1510 __be32 rm_startblock; /* extent start block */ 1511 __be64 rm_owner; /* extent owner */ 1512 __be64 rm_offset; /* offset within the owner */ 1513 } __attribute__((packed)); 1514 1515 /* btree pointer type */ 1516 typedef __be32 xfs_rmap_ptr_t; 1517 1518 #define XFS_RMAP_BLOCK(mp) \ 1519 (xfs_has_finobt(((mp))) ? \ 1520 XFS_FIBT_BLOCK(mp) + 1 : \ 1521 XFS_IBT_BLOCK(mp) + 1) 1522 1523 /* 1524 * Reference Count Btree format definitions 1525 * 1526 */ 1527 #define XFS_REFC_CRC_MAGIC 0x52334643 /* 'R3FC' */ 1528 1529 unsigned int xfs_refc_block(struct xfs_mount *mp); 1530 1531 /* 1532 * Data record/key structure 1533 * 1534 * Each record associates a range of physical blocks (starting at 1535 * rc_startblock and ending rc_blockcount blocks later) with a reference 1536 * count (rc_refcount). Extents that are being used to stage a copy on 1537 * write (CoW) operation are recorded in the refcount btree with a 1538 * refcount of 1. All other records must have a refcount > 1 and must 1539 * track an extent mapped only by file data forks. 1540 * 1541 * Extents with a single owner (attributes, metadata, non-shared file 1542 * data) are not tracked here. Free space is also not tracked here. 1543 * This is consistent with pre-reflink XFS. 1544 */ 1545 1546 /* 1547 * Extents that are being used to stage a copy on write are stored 1548 * in the refcount btree with a refcount of 1 and the upper bit set 1549 * on the startblock. This speeds up mount time deletion of stale 1550 * staging extents because they're all at the right side of the tree. 1551 */ 1552 #define XFS_REFC_COW_START ((xfs_agblock_t)(1U << 31)) 1553 #define REFCNTBT_COWFLAG_BITLEN 1 1554 #define REFCNTBT_AGBLOCK_BITLEN 31 1555 1556 struct xfs_refcount_rec { 1557 __be32 rc_startblock; /* starting block number */ 1558 __be32 rc_blockcount; /* count of blocks */ 1559 __be32 rc_refcount; /* number of inodes linked here */ 1560 }; 1561 1562 struct xfs_refcount_key { 1563 __be32 rc_startblock; /* starting block number */ 1564 }; 1565 1566 struct xfs_refcount_irec { 1567 xfs_agblock_t rc_startblock; /* starting block number */ 1568 xfs_extlen_t rc_blockcount; /* count of free blocks */ 1569 xfs_nlink_t rc_refcount; /* number of inodes linked here */ 1570 }; 1571 1572 #define MAXREFCOUNT ((xfs_nlink_t)~0U) 1573 #define MAXREFCEXTLEN ((xfs_extlen_t)~0U) 1574 1575 /* btree pointer type */ 1576 typedef __be32 xfs_refcount_ptr_t; 1577 1578 1579 /* 1580 * BMAP Btree format definitions 1581 * 1582 * This includes both the root block definition that sits inside an inode fork 1583 * and the record/pointer formats for the leaf/node in the blocks. 1584 */ 1585 #define XFS_BMAP_MAGIC 0x424d4150 /* 'BMAP' */ 1586 #define XFS_BMAP_CRC_MAGIC 0x424d4133 /* 'BMA3' */ 1587 1588 /* 1589 * Bmap root header, on-disk form only. 1590 */ 1591 typedef struct xfs_bmdr_block { 1592 __be16 bb_level; /* 0 is a leaf */ 1593 __be16 bb_numrecs; /* current # of data records */ 1594 } xfs_bmdr_block_t; 1595 1596 /* 1597 * Bmap btree record and extent descriptor. 1598 * l0:63 is an extent flag (value 1 indicates non-normal). 1599 * l0:9-62 are startoff. 1600 * l0:0-8 and l1:21-63 are startblock. 1601 * l1:0-20 are blockcount. 1602 */ 1603 #define BMBT_EXNTFLAG_BITLEN 1 1604 #define BMBT_STARTOFF_BITLEN 54 1605 #define BMBT_STARTBLOCK_BITLEN 52 1606 #define BMBT_BLOCKCOUNT_BITLEN 21 1607 1608 #define BMBT_STARTOFF_MASK ((1ULL << BMBT_STARTOFF_BITLEN) - 1) 1609 #define BMBT_BLOCKCOUNT_MASK ((1ULL << BMBT_BLOCKCOUNT_BITLEN) - 1) 1610 1611 /* 1612 * bmbt records have a file offset (block) field that is 54 bits wide, so this 1613 * is the largest xfs_fileoff_t that we ever expect to see. 1614 */ 1615 #define XFS_MAX_FILEOFF (BMBT_STARTOFF_MASK + BMBT_BLOCKCOUNT_MASK) 1616 1617 typedef struct xfs_bmbt_rec { 1618 __be64 l0, l1; 1619 } xfs_bmbt_rec_t; 1620 1621 typedef uint64_t xfs_bmbt_rec_base_t; /* use this for casts */ 1622 typedef xfs_bmbt_rec_t xfs_bmdr_rec_t; 1623 1624 /* 1625 * Values and macros for delayed-allocation startblock fields. 1626 */ 1627 #define STARTBLOCKVALBITS 17 1628 #define STARTBLOCKMASKBITS (15 + 20) 1629 #define STARTBLOCKMASK \ 1630 (((((xfs_fsblock_t)1) << STARTBLOCKMASKBITS) - 1) << STARTBLOCKVALBITS) 1631 1632 static inline int isnullstartblock(xfs_fsblock_t x) 1633 { 1634 return ((x) & STARTBLOCKMASK) == STARTBLOCKMASK; 1635 } 1636 1637 static inline xfs_fsblock_t nullstartblock(int k) 1638 { 1639 ASSERT(k < (1 << STARTBLOCKVALBITS)); 1640 return STARTBLOCKMASK | (k); 1641 } 1642 1643 static inline xfs_filblks_t startblockval(xfs_fsblock_t x) 1644 { 1645 return (xfs_filblks_t)((x) & ~STARTBLOCKMASK); 1646 } 1647 1648 /* 1649 * Key structure for non-leaf levels of the tree. 1650 */ 1651 typedef struct xfs_bmbt_key { 1652 __be64 br_startoff; /* starting file offset */ 1653 } xfs_bmbt_key_t, xfs_bmdr_key_t; 1654 1655 /* btree pointer type */ 1656 typedef __be64 xfs_bmbt_ptr_t, xfs_bmdr_ptr_t; 1657 1658 1659 /* 1660 * Generic Btree block format definitions 1661 * 1662 * This is a combination of the actual format used on disk for short and long 1663 * format btrees. The first three fields are shared by both format, but the 1664 * pointers are different and should be used with care. 1665 * 1666 * To get the size of the actual short or long form headers please use the size 1667 * macros below. Never use sizeof(xfs_btree_block). 1668 * 1669 * The blkno, crc, lsn, owner and uuid fields are only available in filesystems 1670 * with the crc feature bit, and all accesses to them must be conditional on 1671 * that flag. 1672 */ 1673 /* short form block header */ 1674 struct xfs_btree_block_shdr { 1675 __be32 bb_leftsib; 1676 __be32 bb_rightsib; 1677 1678 __be64 bb_blkno; 1679 __be64 bb_lsn; 1680 uuid_t bb_uuid; 1681 __be32 bb_owner; 1682 __le32 bb_crc; 1683 }; 1684 1685 /* long form block header */ 1686 struct xfs_btree_block_lhdr { 1687 __be64 bb_leftsib; 1688 __be64 bb_rightsib; 1689 1690 __be64 bb_blkno; 1691 __be64 bb_lsn; 1692 uuid_t bb_uuid; 1693 __be64 bb_owner; 1694 __le32 bb_crc; 1695 __be32 bb_pad; /* padding for alignment */ 1696 }; 1697 1698 struct xfs_btree_block { 1699 __be32 bb_magic; /* magic number for block type */ 1700 __be16 bb_level; /* 0 is a leaf */ 1701 __be16 bb_numrecs; /* current # of data records */ 1702 union { 1703 struct xfs_btree_block_shdr s; 1704 struct xfs_btree_block_lhdr l; 1705 } bb_u; /* rest */ 1706 }; 1707 1708 /* size of a short form block */ 1709 #define XFS_BTREE_SBLOCK_LEN \ 1710 (offsetof(struct xfs_btree_block, bb_u) + \ 1711 offsetof(struct xfs_btree_block_shdr, bb_blkno)) 1712 /* size of a long form block */ 1713 #define XFS_BTREE_LBLOCK_LEN \ 1714 (offsetof(struct xfs_btree_block, bb_u) + \ 1715 offsetof(struct xfs_btree_block_lhdr, bb_blkno)) 1716 1717 /* sizes of CRC enabled btree blocks */ 1718 #define XFS_BTREE_SBLOCK_CRC_LEN \ 1719 (offsetof(struct xfs_btree_block, bb_u) + \ 1720 sizeof(struct xfs_btree_block_shdr)) 1721 #define XFS_BTREE_LBLOCK_CRC_LEN \ 1722 (offsetof(struct xfs_btree_block, bb_u) + \ 1723 sizeof(struct xfs_btree_block_lhdr)) 1724 1725 #define XFS_BTREE_SBLOCK_CRC_OFF \ 1726 offsetof(struct xfs_btree_block, bb_u.s.bb_crc) 1727 #define XFS_BTREE_LBLOCK_CRC_OFF \ 1728 offsetof(struct xfs_btree_block, bb_u.l.bb_crc) 1729 1730 /* 1731 * On-disk XFS access control list structure. 1732 */ 1733 struct xfs_acl_entry { 1734 __be32 ae_tag; 1735 __be32 ae_id; 1736 __be16 ae_perm; 1737 __be16 ae_pad; /* fill the implicit hole in the structure */ 1738 }; 1739 1740 struct xfs_acl { 1741 __be32 acl_cnt; 1742 struct xfs_acl_entry acl_entry[]; 1743 }; 1744 1745 /* 1746 * The number of ACL entries allowed is defined by the on-disk format. 1747 * For v4 superblocks, that is limited to 25 entries. For v5 superblocks, it is 1748 * limited only by the maximum size of the xattr that stores the information. 1749 */ 1750 #define XFS_ACL_MAX_ENTRIES(mp) \ 1751 (xfs_has_crc(mp) \ 1752 ? (XFS_XATTR_SIZE_MAX - sizeof(struct xfs_acl)) / \ 1753 sizeof(struct xfs_acl_entry) \ 1754 : 25) 1755 1756 #define XFS_ACL_SIZE(cnt) \ 1757 (sizeof(struct xfs_acl) + \ 1758 sizeof(struct xfs_acl_entry) * cnt) 1759 1760 #define XFS_ACL_MAX_SIZE(mp) \ 1761 XFS_ACL_SIZE(XFS_ACL_MAX_ENTRIES((mp))) 1762 1763 1764 /* On-disk XFS extended attribute names */ 1765 #define SGI_ACL_FILE "SGI_ACL_FILE" 1766 #define SGI_ACL_DEFAULT "SGI_ACL_DEFAULT" 1767 #define SGI_ACL_FILE_SIZE (sizeof(SGI_ACL_FILE)-1) 1768 #define SGI_ACL_DEFAULT_SIZE (sizeof(SGI_ACL_DEFAULT)-1) 1769 1770 #endif /* __XFS_FORMAT_H__ */ 1771