1/* 2 * Copyright (c) 2000-2005 Silicon Graphics, Inc. 3 * All Rights Reserved. 4 * 5 * This program is free software; you can redistribute it and/or 6 * modify it under the terms of the GNU General Public License as 7 * published by the Free Software Foundation. 8 * 9 * This program is distributed in the hope that it would be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * GNU General Public License for more details. 13 * 14 * You should have received a copy of the GNU General Public License 15 * along with this program; if not, write the Free Software Foundation, 16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 17 */ 18#ifndef __XFS_FORMAT_H__ 19#define __XFS_FORMAT_H__ 20 21/* 22 * XFS On Disk Format Definitions 23 * 24 * This header file defines all the on-disk format definitions for 25 * general XFS objects. Directory and attribute related objects are defined in 26 * xfs_da_format.h, which log and log item formats are defined in 27 * xfs_log_format.h. Everything else goes here. 28 */ 29 30struct xfs_mount; 31struct xfs_trans; 32struct xfs_inode; 33struct xfs_buf; 34struct xfs_ifork; 35 36/* 37 * Super block 38 * Fits into a sector-sized buffer at address 0 of each allocation group. 39 * Only the first of these is ever updated except during growfs. 40 */ 41#define XFS_SB_MAGIC 0x58465342 /* 'XFSB' */ 42#define XFS_SB_VERSION_1 1 /* 5.3, 6.0.1, 6.1 */ 43#define XFS_SB_VERSION_2 2 /* 6.2 - attributes */ 44#define XFS_SB_VERSION_3 3 /* 6.2 - new inode version */ 45#define XFS_SB_VERSION_4 4 /* 6.2+ - bitmask version */ 46#define XFS_SB_VERSION_5 5 /* CRC enabled filesystem */ 47#define XFS_SB_VERSION_NUMBITS 0x000f 48#define XFS_SB_VERSION_ALLFBITS 0xfff0 49#define XFS_SB_VERSION_ATTRBIT 0x0010 50#define XFS_SB_VERSION_NLINKBIT 0x0020 51#define XFS_SB_VERSION_QUOTABIT 0x0040 52#define XFS_SB_VERSION_ALIGNBIT 0x0080 53#define XFS_SB_VERSION_DALIGNBIT 0x0100 54#define XFS_SB_VERSION_SHAREDBIT 0x0200 55#define XFS_SB_VERSION_LOGV2BIT 0x0400 56#define XFS_SB_VERSION_SECTORBIT 0x0800 57#define XFS_SB_VERSION_EXTFLGBIT 0x1000 58#define XFS_SB_VERSION_DIRV2BIT 0x2000 59#define XFS_SB_VERSION_BORGBIT 0x4000 /* ASCII only case-insens. */ 60#define XFS_SB_VERSION_MOREBITSBIT 0x8000 61 62/* 63 * Supported feature bit list is just all bits in the versionnum field because 64 * we've used them all up and understand them all. Except, of course, for the 65 * shared superblock bit, which nobody knows what it does and so is unsupported. 66 */ 67#define XFS_SB_VERSION_OKBITS \ 68 ((XFS_SB_VERSION_NUMBITS | XFS_SB_VERSION_ALLFBITS) & \ 69 ~XFS_SB_VERSION_SHAREDBIT) 70 71/* 72 * There are two words to hold XFS "feature" bits: the original 73 * word, sb_versionnum, and sb_features2. Whenever a bit is set in 74 * sb_features2, the feature bit XFS_SB_VERSION_MOREBITSBIT must be set. 75 * 76 * These defines represent bits in sb_features2. 77 */ 78#define XFS_SB_VERSION2_RESERVED1BIT 0x00000001 79#define XFS_SB_VERSION2_LAZYSBCOUNTBIT 0x00000002 /* Superblk counters */ 80#define XFS_SB_VERSION2_RESERVED4BIT 0x00000004 81#define XFS_SB_VERSION2_ATTR2BIT 0x00000008 /* Inline attr rework */ 82#define XFS_SB_VERSION2_PARENTBIT 0x00000010 /* parent pointers */ 83#define XFS_SB_VERSION2_PROJID32BIT 0x00000080 /* 32 bit project id */ 84#define XFS_SB_VERSION2_CRCBIT 0x00000100 /* metadata CRCs */ 85#define XFS_SB_VERSION2_FTYPE 0x00000200 /* inode type in dir */ 86 87#define XFS_SB_VERSION2_OKBITS \ 88 (XFS_SB_VERSION2_LAZYSBCOUNTBIT | \ 89 XFS_SB_VERSION2_ATTR2BIT | \ 90 XFS_SB_VERSION2_PROJID32BIT | \ 91 XFS_SB_VERSION2_FTYPE) 92 93/* 94 * Superblock - in core version. Must match the ondisk version below. 95 * Must be padded to 64 bit alignment. 96 */ 97typedef struct xfs_sb { 98 __uint32_t sb_magicnum; /* magic number == XFS_SB_MAGIC */ 99 __uint32_t sb_blocksize; /* logical block size, bytes */ 100 xfs_rfsblock_t sb_dblocks; /* number of data blocks */ 101 xfs_rfsblock_t sb_rblocks; /* number of realtime blocks */ 102 xfs_rtblock_t sb_rextents; /* number of realtime extents */ 103 uuid_t sb_uuid; /* file system unique id */ 104 xfs_fsblock_t sb_logstart; /* starting block of log if internal */ 105 xfs_ino_t sb_rootino; /* root inode number */ 106 xfs_ino_t sb_rbmino; /* bitmap inode for realtime extents */ 107 xfs_ino_t sb_rsumino; /* summary inode for rt bitmap */ 108 xfs_agblock_t sb_rextsize; /* realtime extent size, blocks */ 109 xfs_agblock_t sb_agblocks; /* size of an allocation group */ 110 xfs_agnumber_t sb_agcount; /* number of allocation groups */ 111 xfs_extlen_t sb_rbmblocks; /* number of rt bitmap blocks */ 112 xfs_extlen_t sb_logblocks; /* number of log blocks */ 113 __uint16_t sb_versionnum; /* header version == XFS_SB_VERSION */ 114 __uint16_t sb_sectsize; /* volume sector size, bytes */ 115 __uint16_t sb_inodesize; /* inode size, bytes */ 116 __uint16_t sb_inopblock; /* inodes per block */ 117 char sb_fname[12]; /* file system name */ 118 __uint8_t sb_blocklog; /* log2 of sb_blocksize */ 119 __uint8_t sb_sectlog; /* log2 of sb_sectsize */ 120 __uint8_t sb_inodelog; /* log2 of sb_inodesize */ 121 __uint8_t sb_inopblog; /* log2 of sb_inopblock */ 122 __uint8_t sb_agblklog; /* log2 of sb_agblocks (rounded up) */ 123 __uint8_t sb_rextslog; /* log2 of sb_rextents */ 124 __uint8_t sb_inprogress; /* mkfs is in progress, don't mount */ 125 __uint8_t sb_imax_pct; /* max % of fs for inode space */ 126 /* statistics */ 127 /* 128 * These fields must remain contiguous. If you really 129 * want to change their layout, make sure you fix the 130 * code in xfs_trans_apply_sb_deltas(). 131 */ 132 __uint64_t sb_icount; /* allocated inodes */ 133 __uint64_t sb_ifree; /* free inodes */ 134 __uint64_t sb_fdblocks; /* free data blocks */ 135 __uint64_t sb_frextents; /* free realtime extents */ 136 /* 137 * End contiguous fields. 138 */ 139 xfs_ino_t sb_uquotino; /* user quota inode */ 140 xfs_ino_t sb_gquotino; /* group quota inode */ 141 __uint16_t sb_qflags; /* quota flags */ 142 __uint8_t sb_flags; /* misc. flags */ 143 __uint8_t sb_shared_vn; /* shared version number */ 144 xfs_extlen_t sb_inoalignmt; /* inode chunk alignment, fsblocks */ 145 __uint32_t sb_unit; /* stripe or raid unit */ 146 __uint32_t sb_width; /* stripe or raid width */ 147 __uint8_t sb_dirblklog; /* log2 of dir block size (fsbs) */ 148 __uint8_t sb_logsectlog; /* log2 of the log sector size */ 149 __uint16_t sb_logsectsize; /* sector size for the log, bytes */ 150 __uint32_t sb_logsunit; /* stripe unit size for the log */ 151 __uint32_t sb_features2; /* additional feature bits */ 152 153 /* 154 * bad features2 field as a result of failing to pad the sb structure to 155 * 64 bits. Some machines will be using this field for features2 bits. 156 * Easiest just to mark it bad and not use it for anything else. 157 * 158 * This is not kept up to date in memory; it is always overwritten by 159 * the value in sb_features2 when formatting the incore superblock to 160 * the disk buffer. 161 */ 162 __uint32_t sb_bad_features2; 163 164 /* version 5 superblock fields start here */ 165 166 /* feature masks */ 167 __uint32_t sb_features_compat; 168 __uint32_t sb_features_ro_compat; 169 __uint32_t sb_features_incompat; 170 __uint32_t sb_features_log_incompat; 171 172 __uint32_t sb_crc; /* superblock crc */ 173 __uint32_t sb_pad; 174 175 xfs_ino_t sb_pquotino; /* project quota inode */ 176 xfs_lsn_t sb_lsn; /* last write sequence */ 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 */ 187typedef 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; /* 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[12]; /* 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_pad; 260 261 __be64 sb_pquotino; /* project quota inode */ 262 __be64 sb_lsn; /* last write sequence */ 263 264 /* must be padded to 64 bit alignment */ 265} xfs_dsb_t; 266 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/* 283 * The first XFS version we support is a v4 superblock with V2 directories. 284 */ 285static inline bool xfs_sb_good_v4_features(struct xfs_sb *sbp) 286{ 287 if (!(sbp->sb_versionnum & XFS_SB_VERSION_DIRV2BIT)) 288 return false; 289 290 /* check for unknown features in the fs */ 291 if ((sbp->sb_versionnum & ~XFS_SB_VERSION_OKBITS) || 292 ((sbp->sb_versionnum & XFS_SB_VERSION_MOREBITSBIT) && 293 (sbp->sb_features2 & ~XFS_SB_VERSION2_OKBITS))) 294 return false; 295 296 return true; 297} 298 299static inline bool xfs_sb_good_version(struct xfs_sb *sbp) 300{ 301 if (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) 302 return true; 303 if (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4) 304 return xfs_sb_good_v4_features(sbp); 305 return false; 306} 307 308/* 309 * Detect a mismatched features2 field. Older kernels read/wrote 310 * this into the wrong slot, so to be safe we keep them in sync. 311 */ 312static inline bool xfs_sb_has_mismatched_features2(struct xfs_sb *sbp) 313{ 314 return sbp->sb_bad_features2 != sbp->sb_features2; 315} 316 317static inline bool xfs_sb_version_hasattr(struct xfs_sb *sbp) 318{ 319 return (sbp->sb_versionnum & XFS_SB_VERSION_ATTRBIT); 320} 321 322static inline void xfs_sb_version_addattr(struct xfs_sb *sbp) 323{ 324 sbp->sb_versionnum |= XFS_SB_VERSION_ATTRBIT; 325} 326 327static inline bool xfs_sb_version_hasquota(struct xfs_sb *sbp) 328{ 329 return (sbp->sb_versionnum & XFS_SB_VERSION_QUOTABIT); 330} 331 332static inline void xfs_sb_version_addquota(struct xfs_sb *sbp) 333{ 334 sbp->sb_versionnum |= XFS_SB_VERSION_QUOTABIT; 335} 336 337static inline bool xfs_sb_version_hasalign(struct xfs_sb *sbp) 338{ 339 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 || 340 (sbp->sb_versionnum & XFS_SB_VERSION_ALIGNBIT)); 341} 342 343static inline bool xfs_sb_version_hasdalign(struct xfs_sb *sbp) 344{ 345 return (sbp->sb_versionnum & XFS_SB_VERSION_DALIGNBIT); 346} 347 348static inline bool xfs_sb_version_haslogv2(struct xfs_sb *sbp) 349{ 350 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 || 351 (sbp->sb_versionnum & XFS_SB_VERSION_LOGV2BIT); 352} 353 354static inline bool xfs_sb_version_hasextflgbit(struct xfs_sb *sbp) 355{ 356 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 || 357 (sbp->sb_versionnum & XFS_SB_VERSION_EXTFLGBIT); 358} 359 360static inline bool xfs_sb_version_hassector(struct xfs_sb *sbp) 361{ 362 return (sbp->sb_versionnum & XFS_SB_VERSION_SECTORBIT); 363} 364 365static inline bool xfs_sb_version_hasasciici(struct xfs_sb *sbp) 366{ 367 return (sbp->sb_versionnum & XFS_SB_VERSION_BORGBIT); 368} 369 370static inline bool xfs_sb_version_hasmorebits(struct xfs_sb *sbp) 371{ 372 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 || 373 (sbp->sb_versionnum & XFS_SB_VERSION_MOREBITSBIT); 374} 375 376/* 377 * sb_features2 bit version macros. 378 */ 379static inline bool xfs_sb_version_haslazysbcount(struct xfs_sb *sbp) 380{ 381 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) || 382 (xfs_sb_version_hasmorebits(sbp) && 383 (sbp->sb_features2 & XFS_SB_VERSION2_LAZYSBCOUNTBIT)); 384} 385 386static inline bool xfs_sb_version_hasattr2(struct xfs_sb *sbp) 387{ 388 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) || 389 (xfs_sb_version_hasmorebits(sbp) && 390 (sbp->sb_features2 & XFS_SB_VERSION2_ATTR2BIT)); 391} 392 393static inline void xfs_sb_version_addattr2(struct xfs_sb *sbp) 394{ 395 sbp->sb_versionnum |= XFS_SB_VERSION_MOREBITSBIT; 396 sbp->sb_features2 |= XFS_SB_VERSION2_ATTR2BIT; 397} 398 399static inline void xfs_sb_version_removeattr2(struct xfs_sb *sbp) 400{ 401 sbp->sb_features2 &= ~XFS_SB_VERSION2_ATTR2BIT; 402 if (!sbp->sb_features2) 403 sbp->sb_versionnum &= ~XFS_SB_VERSION_MOREBITSBIT; 404} 405 406static inline bool xfs_sb_version_hasprojid32bit(struct xfs_sb *sbp) 407{ 408 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) || 409 (xfs_sb_version_hasmorebits(sbp) && 410 (sbp->sb_features2 & XFS_SB_VERSION2_PROJID32BIT)); 411} 412 413static inline void xfs_sb_version_addprojid32bit(struct xfs_sb *sbp) 414{ 415 sbp->sb_versionnum |= XFS_SB_VERSION_MOREBITSBIT; 416 sbp->sb_features2 |= XFS_SB_VERSION2_PROJID32BIT; 417} 418 419/* 420 * Extended v5 superblock feature masks. These are to be used for new v5 421 * superblock features only. 422 * 423 * Compat features are new features that old kernels will not notice or affect 424 * and so can mount read-write without issues. 425 * 426 * RO-Compat (read only) are features that old kernels can read but will break 427 * if they write. Hence only read-only mounts of such filesystems are allowed on 428 * kernels that don't support the feature bit. 429 * 430 * InCompat features are features which old kernels will not understand and so 431 * must not mount. 432 * 433 * Log-InCompat features are for changes to log formats or new transactions that 434 * can't be replayed on older kernels. The fields are set when the filesystem is 435 * mounted, and a clean unmount clears the fields. 436 */ 437#define XFS_SB_FEAT_COMPAT_ALL 0 438#define XFS_SB_FEAT_COMPAT_UNKNOWN ~XFS_SB_FEAT_COMPAT_ALL 439static inline bool 440xfs_sb_has_compat_feature( 441 struct xfs_sb *sbp, 442 __uint32_t feature) 443{ 444 return (sbp->sb_features_compat & feature) != 0; 445} 446 447#define XFS_SB_FEAT_RO_COMPAT_FINOBT (1 << 0) /* free inode btree */ 448#define XFS_SB_FEAT_RO_COMPAT_ALL \ 449 (XFS_SB_FEAT_RO_COMPAT_FINOBT) 450#define XFS_SB_FEAT_RO_COMPAT_UNKNOWN ~XFS_SB_FEAT_RO_COMPAT_ALL 451static inline bool 452xfs_sb_has_ro_compat_feature( 453 struct xfs_sb *sbp, 454 __uint32_t feature) 455{ 456 return (sbp->sb_features_ro_compat & feature) != 0; 457} 458 459#define XFS_SB_FEAT_INCOMPAT_FTYPE (1 << 0) /* filetype in dirent */ 460#define XFS_SB_FEAT_INCOMPAT_ALL \ 461 (XFS_SB_FEAT_INCOMPAT_FTYPE) 462 463#define XFS_SB_FEAT_INCOMPAT_UNKNOWN ~XFS_SB_FEAT_INCOMPAT_ALL 464static inline bool 465xfs_sb_has_incompat_feature( 466 struct xfs_sb *sbp, 467 __uint32_t feature) 468{ 469 return (sbp->sb_features_incompat & feature) != 0; 470} 471 472#define XFS_SB_FEAT_INCOMPAT_LOG_ALL 0 473#define XFS_SB_FEAT_INCOMPAT_LOG_UNKNOWN ~XFS_SB_FEAT_INCOMPAT_LOG_ALL 474static inline bool 475xfs_sb_has_incompat_log_feature( 476 struct xfs_sb *sbp, 477 __uint32_t feature) 478{ 479 return (sbp->sb_features_log_incompat & feature) != 0; 480} 481 482/* 483 * V5 superblock specific feature checks 484 */ 485static inline int xfs_sb_version_hascrc(struct xfs_sb *sbp) 486{ 487 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5; 488} 489 490static inline int xfs_sb_version_has_pquotino(struct xfs_sb *sbp) 491{ 492 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5; 493} 494 495static inline int xfs_sb_version_hasftype(struct xfs_sb *sbp) 496{ 497 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 && 498 xfs_sb_has_incompat_feature(sbp, XFS_SB_FEAT_INCOMPAT_FTYPE)) || 499 (xfs_sb_version_hasmorebits(sbp) && 500 (sbp->sb_features2 & XFS_SB_VERSION2_FTYPE)); 501} 502 503static inline int xfs_sb_version_hasfinobt(xfs_sb_t *sbp) 504{ 505 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) && 506 (sbp->sb_features_ro_compat & XFS_SB_FEAT_RO_COMPAT_FINOBT); 507} 508 509/* 510 * end of superblock version macros 511 */ 512 513static inline bool 514xfs_is_quota_inode(struct xfs_sb *sbp, xfs_ino_t ino) 515{ 516 return (ino == sbp->sb_uquotino || 517 ino == sbp->sb_gquotino || 518 ino == sbp->sb_pquotino); 519} 520 521#define XFS_SB_DADDR ((xfs_daddr_t)0) /* daddr in filesystem/ag */ 522#define XFS_SB_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_SB_DADDR) 523#define XFS_BUF_TO_SBP(bp) ((xfs_dsb_t *)((bp)->b_addr)) 524 525#define XFS_HDR_BLOCK(mp,d) ((xfs_agblock_t)XFS_BB_TO_FSBT(mp,d)) 526#define XFS_DADDR_TO_FSB(mp,d) XFS_AGB_TO_FSB(mp, \ 527 xfs_daddr_to_agno(mp,d), xfs_daddr_to_agbno(mp,d)) 528#define XFS_FSB_TO_DADDR(mp,fsbno) XFS_AGB_TO_DADDR(mp, \ 529 XFS_FSB_TO_AGNO(mp,fsbno), XFS_FSB_TO_AGBNO(mp,fsbno)) 530 531/* 532 * File system sector to basic block conversions. 533 */ 534#define XFS_FSS_TO_BB(mp,sec) ((sec) << (mp)->m_sectbb_log) 535 536/* 537 * File system block to basic block conversions. 538 */ 539#define XFS_FSB_TO_BB(mp,fsbno) ((fsbno) << (mp)->m_blkbb_log) 540#define XFS_BB_TO_FSB(mp,bb) \ 541 (((bb) + (XFS_FSB_TO_BB(mp,1) - 1)) >> (mp)->m_blkbb_log) 542#define XFS_BB_TO_FSBT(mp,bb) ((bb) >> (mp)->m_blkbb_log) 543 544/* 545 * File system block to byte conversions. 546 */ 547#define XFS_FSB_TO_B(mp,fsbno) ((xfs_fsize_t)(fsbno) << (mp)->m_sb.sb_blocklog) 548#define XFS_B_TO_FSB(mp,b) \ 549 ((((__uint64_t)(b)) + (mp)->m_blockmask) >> (mp)->m_sb.sb_blocklog) 550#define XFS_B_TO_FSBT(mp,b) (((__uint64_t)(b)) >> (mp)->m_sb.sb_blocklog) 551#define XFS_B_FSB_OFFSET(mp,b) ((b) & (mp)->m_blockmask) 552 553/* 554 * Allocation group header 555 * 556 * This is divided into three structures, placed in sequential 512-byte 557 * buffers after a copy of the superblock (also in a 512-byte buffer). 558 */ 559#define XFS_AGF_MAGIC 0x58414746 /* 'XAGF' */ 560#define XFS_AGI_MAGIC 0x58414749 /* 'XAGI' */ 561#define XFS_AGFL_MAGIC 0x5841464c /* 'XAFL' */ 562#define XFS_AGF_VERSION 1 563#define XFS_AGI_VERSION 1 564 565#define XFS_AGF_GOOD_VERSION(v) ((v) == XFS_AGF_VERSION) 566#define XFS_AGI_GOOD_VERSION(v) ((v) == XFS_AGI_VERSION) 567 568/* 569 * Btree number 0 is bno, 1 is cnt. This value gives the size of the 570 * arrays below. 571 */ 572#define XFS_BTNUM_AGF ((int)XFS_BTNUM_CNTi + 1) 573 574/* 575 * The second word of agf_levels in the first a.g. overlaps the EFS 576 * superblock's magic number. Since the magic numbers valid for EFS 577 * are > 64k, our value cannot be confused for an EFS superblock's. 578 */ 579 580typedef struct xfs_agf { 581 /* 582 * Common allocation group header information 583 */ 584 __be32 agf_magicnum; /* magic number == XFS_AGF_MAGIC */ 585 __be32 agf_versionnum; /* header version == XFS_AGF_VERSION */ 586 __be32 agf_seqno; /* sequence # starting from 0 */ 587 __be32 agf_length; /* size in blocks of a.g. */ 588 /* 589 * Freespace information 590 */ 591 __be32 agf_roots[XFS_BTNUM_AGF]; /* root blocks */ 592 __be32 agf_spare0; /* spare field */ 593 __be32 agf_levels[XFS_BTNUM_AGF]; /* btree levels */ 594 __be32 agf_spare1; /* spare field */ 595 596 __be32 agf_flfirst; /* first freelist block's index */ 597 __be32 agf_fllast; /* last freelist block's index */ 598 __be32 agf_flcount; /* count of blocks in freelist */ 599 __be32 agf_freeblks; /* total free blocks */ 600 601 __be32 agf_longest; /* longest free space */ 602 __be32 agf_btreeblks; /* # of blocks held in AGF btrees */ 603 uuid_t agf_uuid; /* uuid of filesystem */ 604 605 /* 606 * reserve some contiguous space for future logged fields before we add 607 * the unlogged fields. This makes the range logging via flags and 608 * structure offsets much simpler. 609 */ 610 __be64 agf_spare64[16]; 611 612 /* unlogged fields, written during buffer writeback. */ 613 __be64 agf_lsn; /* last write sequence */ 614 __be32 agf_crc; /* crc of agf sector */ 615 __be32 agf_spare2; 616 617 /* structure must be padded to 64 bit alignment */ 618} xfs_agf_t; 619 620#define XFS_AGF_CRC_OFF offsetof(struct xfs_agf, agf_crc) 621 622#define XFS_AGF_MAGICNUM 0x00000001 623#define XFS_AGF_VERSIONNUM 0x00000002 624#define XFS_AGF_SEQNO 0x00000004 625#define XFS_AGF_LENGTH 0x00000008 626#define XFS_AGF_ROOTS 0x00000010 627#define XFS_AGF_LEVELS 0x00000020 628#define XFS_AGF_FLFIRST 0x00000040 629#define XFS_AGF_FLLAST 0x00000080 630#define XFS_AGF_FLCOUNT 0x00000100 631#define XFS_AGF_FREEBLKS 0x00000200 632#define XFS_AGF_LONGEST 0x00000400 633#define XFS_AGF_BTREEBLKS 0x00000800 634#define XFS_AGF_UUID 0x00001000 635#define XFS_AGF_NUM_BITS 13 636#define XFS_AGF_ALL_BITS ((1 << XFS_AGF_NUM_BITS) - 1) 637 638#define XFS_AGF_FLAGS \ 639 { XFS_AGF_MAGICNUM, "MAGICNUM" }, \ 640 { XFS_AGF_VERSIONNUM, "VERSIONNUM" }, \ 641 { XFS_AGF_SEQNO, "SEQNO" }, \ 642 { XFS_AGF_LENGTH, "LENGTH" }, \ 643 { XFS_AGF_ROOTS, "ROOTS" }, \ 644 { XFS_AGF_LEVELS, "LEVELS" }, \ 645 { XFS_AGF_FLFIRST, "FLFIRST" }, \ 646 { XFS_AGF_FLLAST, "FLLAST" }, \ 647 { XFS_AGF_FLCOUNT, "FLCOUNT" }, \ 648 { XFS_AGF_FREEBLKS, "FREEBLKS" }, \ 649 { XFS_AGF_LONGEST, "LONGEST" }, \ 650 { XFS_AGF_BTREEBLKS, "BTREEBLKS" }, \ 651 { XFS_AGF_UUID, "UUID" } 652 653/* disk block (xfs_daddr_t) in the AG */ 654#define XFS_AGF_DADDR(mp) ((xfs_daddr_t)(1 << (mp)->m_sectbb_log)) 655#define XFS_AGF_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGF_DADDR(mp)) 656#define XFS_BUF_TO_AGF(bp) ((xfs_agf_t *)((bp)->b_addr)) 657 658/* 659 * Size of the unlinked inode hash table in the agi. 660 */ 661#define XFS_AGI_UNLINKED_BUCKETS 64 662 663typedef struct xfs_agi { 664 /* 665 * Common allocation group header information 666 */ 667 __be32 agi_magicnum; /* magic number == XFS_AGI_MAGIC */ 668 __be32 agi_versionnum; /* header version == XFS_AGI_VERSION */ 669 __be32 agi_seqno; /* sequence # starting from 0 */ 670 __be32 agi_length; /* size in blocks of a.g. */ 671 /* 672 * Inode information 673 * Inodes are mapped by interpreting the inode number, so no 674 * mapping data is needed here. 675 */ 676 __be32 agi_count; /* count of allocated inodes */ 677 __be32 agi_root; /* root of inode btree */ 678 __be32 agi_level; /* levels in inode btree */ 679 __be32 agi_freecount; /* number of free inodes */ 680 681 __be32 agi_newino; /* new inode just allocated */ 682 __be32 agi_dirino; /* last directory inode chunk */ 683 /* 684 * Hash table of inodes which have been unlinked but are 685 * still being referenced. 686 */ 687 __be32 agi_unlinked[XFS_AGI_UNLINKED_BUCKETS]; 688 /* 689 * This marks the end of logging region 1 and start of logging region 2. 690 */ 691 uuid_t agi_uuid; /* uuid of filesystem */ 692 __be32 agi_crc; /* crc of agi sector */ 693 __be32 agi_pad32; 694 __be64 agi_lsn; /* last write sequence */ 695 696 __be32 agi_free_root; /* root of the free inode btree */ 697 __be32 agi_free_level;/* levels in free inode btree */ 698 699 /* structure must be padded to 64 bit alignment */ 700} xfs_agi_t; 701 702#define XFS_AGI_CRC_OFF offsetof(struct xfs_agi, agi_crc) 703 704#define XFS_AGI_MAGICNUM (1 << 0) 705#define XFS_AGI_VERSIONNUM (1 << 1) 706#define XFS_AGI_SEQNO (1 << 2) 707#define XFS_AGI_LENGTH (1 << 3) 708#define XFS_AGI_COUNT (1 << 4) 709#define XFS_AGI_ROOT (1 << 5) 710#define XFS_AGI_LEVEL (1 << 6) 711#define XFS_AGI_FREECOUNT (1 << 7) 712#define XFS_AGI_NEWINO (1 << 8) 713#define XFS_AGI_DIRINO (1 << 9) 714#define XFS_AGI_UNLINKED (1 << 10) 715#define XFS_AGI_NUM_BITS_R1 11 /* end of the 1st agi logging region */ 716#define XFS_AGI_ALL_BITS_R1 ((1 << XFS_AGI_NUM_BITS_R1) - 1) 717#define XFS_AGI_FREE_ROOT (1 << 11) 718#define XFS_AGI_FREE_LEVEL (1 << 12) 719#define XFS_AGI_NUM_BITS_R2 13 720 721/* disk block (xfs_daddr_t) in the AG */ 722#define XFS_AGI_DADDR(mp) ((xfs_daddr_t)(2 << (mp)->m_sectbb_log)) 723#define XFS_AGI_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGI_DADDR(mp)) 724#define XFS_BUF_TO_AGI(bp) ((xfs_agi_t *)((bp)->b_addr)) 725 726/* 727 * The third a.g. block contains the a.g. freelist, an array 728 * of block pointers to blocks owned by the allocation btree code. 729 */ 730#define XFS_AGFL_DADDR(mp) ((xfs_daddr_t)(3 << (mp)->m_sectbb_log)) 731#define XFS_AGFL_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGFL_DADDR(mp)) 732#define XFS_BUF_TO_AGFL(bp) ((xfs_agfl_t *)((bp)->b_addr)) 733 734#define XFS_BUF_TO_AGFL_BNO(mp, bp) \ 735 (xfs_sb_version_hascrc(&((mp)->m_sb)) ? \ 736 &(XFS_BUF_TO_AGFL(bp)->agfl_bno[0]) : \ 737 (__be32 *)(bp)->b_addr) 738 739/* 740 * Size of the AGFL. For CRC-enabled filesystes we steal a couple of 741 * slots in the beginning of the block for a proper header with the 742 * location information and CRC. 743 */ 744#define XFS_AGFL_SIZE(mp) \ 745 (((mp)->m_sb.sb_sectsize - \ 746 (xfs_sb_version_hascrc(&((mp)->m_sb)) ? \ 747 sizeof(struct xfs_agfl) : 0)) / \ 748 sizeof(xfs_agblock_t)) 749 750typedef struct xfs_agfl { 751 __be32 agfl_magicnum; 752 __be32 agfl_seqno; 753 uuid_t agfl_uuid; 754 __be64 agfl_lsn; 755 __be32 agfl_crc; 756 __be32 agfl_bno[]; /* actually XFS_AGFL_SIZE(mp) */ 757} __attribute__((packed)) xfs_agfl_t; 758 759#define XFS_AGFL_CRC_OFF offsetof(struct xfs_agfl, agfl_crc) 760 761 762#define XFS_AG_MAXLEVELS(mp) ((mp)->m_ag_maxlevels) 763#define XFS_MIN_FREELIST_RAW(bl,cl,mp) \ 764 (MIN(bl + 1, XFS_AG_MAXLEVELS(mp)) + MIN(cl + 1, XFS_AG_MAXLEVELS(mp))) 765#define XFS_MIN_FREELIST(a,mp) \ 766 (XFS_MIN_FREELIST_RAW( \ 767 be32_to_cpu((a)->agf_levels[XFS_BTNUM_BNOi]), \ 768 be32_to_cpu((a)->agf_levels[XFS_BTNUM_CNTi]), mp)) 769#define XFS_MIN_FREELIST_PAG(pag,mp) \ 770 (XFS_MIN_FREELIST_RAW( \ 771 (unsigned int)(pag)->pagf_levels[XFS_BTNUM_BNOi], \ 772 (unsigned int)(pag)->pagf_levels[XFS_BTNUM_CNTi], mp)) 773 774#define XFS_AGB_TO_FSB(mp,agno,agbno) \ 775 (((xfs_fsblock_t)(agno) << (mp)->m_sb.sb_agblklog) | (agbno)) 776#define XFS_FSB_TO_AGNO(mp,fsbno) \ 777 ((xfs_agnumber_t)((fsbno) >> (mp)->m_sb.sb_agblklog)) 778#define XFS_FSB_TO_AGBNO(mp,fsbno) \ 779 ((xfs_agblock_t)((fsbno) & xfs_mask32lo((mp)->m_sb.sb_agblklog))) 780#define XFS_AGB_TO_DADDR(mp,agno,agbno) \ 781 ((xfs_daddr_t)XFS_FSB_TO_BB(mp, \ 782 (xfs_fsblock_t)(agno) * (mp)->m_sb.sb_agblocks + (agbno))) 783#define XFS_AG_DADDR(mp,agno,d) (XFS_AGB_TO_DADDR(mp, agno, 0) + (d)) 784 785/* 786 * For checking for bad ranges of xfs_daddr_t's, covering multiple 787 * allocation groups or a single xfs_daddr_t that's a superblock copy. 788 */ 789#define XFS_AG_CHECK_DADDR(mp,d,len) \ 790 ((len) == 1 ? \ 791 ASSERT((d) == XFS_SB_DADDR || \ 792 xfs_daddr_to_agbno(mp, d) != XFS_SB_DADDR) : \ 793 ASSERT(xfs_daddr_to_agno(mp, d) == \ 794 xfs_daddr_to_agno(mp, (d) + (len) - 1))) 795 796typedef struct xfs_timestamp { 797 __be32 t_sec; /* timestamp seconds */ 798 __be32 t_nsec; /* timestamp nanoseconds */ 799} xfs_timestamp_t; 800 801/* 802 * On-disk inode structure. 803 * 804 * This is just the header or "dinode core", the inode is expanded to fill a 805 * variable size the leftover area split into a data and an attribute fork. 806 * The format of the data and attribute fork depends on the format of the 807 * inode as indicated by di_format and di_aformat. To access the data and 808 * attribute use the XFS_DFORK_DPTR, XFS_DFORK_APTR, and XFS_DFORK_PTR macros 809 * below. 810 * 811 * There is a very similar struct icdinode in xfs_inode which matches the 812 * layout of the first 96 bytes of this structure, but is kept in native 813 * format instead of big endian. 814 * 815 * Note: di_flushiter is only used by v1/2 inodes - it's effectively a zeroed 816 * padding field for v3 inodes. 817 */ 818#define XFS_DINODE_MAGIC 0x494e /* 'IN' */ 819#define XFS_DINODE_GOOD_VERSION(v) ((v) >= 1 && (v) <= 3) 820typedef struct xfs_dinode { 821 __be16 di_magic; /* inode magic # = XFS_DINODE_MAGIC */ 822 __be16 di_mode; /* mode and type of file */ 823 __u8 di_version; /* inode version */ 824 __u8 di_format; /* format of di_c data */ 825 __be16 di_onlink; /* old number of links to file */ 826 __be32 di_uid; /* owner's user id */ 827 __be32 di_gid; /* owner's group id */ 828 __be32 di_nlink; /* number of links to file */ 829 __be16 di_projid_lo; /* lower part of owner's project id */ 830 __be16 di_projid_hi; /* higher part owner's project id */ 831 __u8 di_pad[6]; /* unused, zeroed space */ 832 __be16 di_flushiter; /* incremented on flush */ 833 xfs_timestamp_t di_atime; /* time last accessed */ 834 xfs_timestamp_t di_mtime; /* time last modified */ 835 xfs_timestamp_t di_ctime; /* time created/inode modified */ 836 __be64 di_size; /* number of bytes in file */ 837 __be64 di_nblocks; /* # of direct & btree blocks used */ 838 __be32 di_extsize; /* basic/minimum extent size for file */ 839 __be32 di_nextents; /* number of extents in data fork */ 840 __be16 di_anextents; /* number of extents in attribute fork*/ 841 __u8 di_forkoff; /* attr fork offs, <<3 for 64b align */ 842 __s8 di_aformat; /* format of attr fork's data */ 843 __be32 di_dmevmask; /* DMIG event mask */ 844 __be16 di_dmstate; /* DMIG state info */ 845 __be16 di_flags; /* random flags, XFS_DIFLAG_... */ 846 __be32 di_gen; /* generation number */ 847 848 /* di_next_unlinked is the only non-core field in the old dinode */ 849 __be32 di_next_unlinked;/* agi unlinked list ptr */ 850 851 /* start of the extended dinode, writable fields */ 852 __le32 di_crc; /* CRC of the inode */ 853 __be64 di_changecount; /* number of attribute changes */ 854 __be64 di_lsn; /* flush sequence */ 855 __be64 di_flags2; /* more random flags */ 856 __u8 di_pad2[16]; /* more padding for future expansion */ 857 858 /* fields only written to during inode creation */ 859 xfs_timestamp_t di_crtime; /* time created */ 860 __be64 di_ino; /* inode number */ 861 uuid_t di_uuid; /* UUID of the filesystem */ 862 863 /* structure must be padded to 64 bit alignment */ 864} xfs_dinode_t; 865 866#define XFS_DINODE_CRC_OFF offsetof(struct xfs_dinode, di_crc) 867 868#define DI_MAX_FLUSH 0xffff 869 870/* 871 * Size of the core inode on disk. Version 1 and 2 inodes have 872 * the same size, but version 3 has grown a few additional fields. 873 */ 874static inline uint xfs_dinode_size(int version) 875{ 876 if (version == 3) 877 return sizeof(struct xfs_dinode); 878 return offsetof(struct xfs_dinode, di_crc); 879} 880 881/* 882 * The 32 bit link count in the inode theoretically maxes out at UINT_MAX. 883 * Since the pathconf interface is signed, we use 2^31 - 1 instead. 884 * The old inode format had a 16 bit link count, so its maximum is USHRT_MAX. 885 */ 886#define XFS_MAXLINK ((1U << 31) - 1U) 887#define XFS_MAXLINK_1 65535U 888 889/* 890 * Values for di_format 891 */ 892typedef enum xfs_dinode_fmt { 893 XFS_DINODE_FMT_DEV, /* xfs_dev_t */ 894 XFS_DINODE_FMT_LOCAL, /* bulk data */ 895 XFS_DINODE_FMT_EXTENTS, /* struct xfs_bmbt_rec */ 896 XFS_DINODE_FMT_BTREE, /* struct xfs_bmdr_block */ 897 XFS_DINODE_FMT_UUID /* uuid_t */ 898} xfs_dinode_fmt_t; 899 900/* 901 * Inode minimum and maximum sizes. 902 */ 903#define XFS_DINODE_MIN_LOG 8 904#define XFS_DINODE_MAX_LOG 11 905#define XFS_DINODE_MIN_SIZE (1 << XFS_DINODE_MIN_LOG) 906#define XFS_DINODE_MAX_SIZE (1 << XFS_DINODE_MAX_LOG) 907 908/* 909 * Inode size for given fs. 910 */ 911#define XFS_LITINO(mp, version) \ 912 ((int)(((mp)->m_sb.sb_inodesize) - xfs_dinode_size(version))) 913 914/* 915 * Inode data & attribute fork sizes, per inode. 916 */ 917#define XFS_DFORK_Q(dip) ((dip)->di_forkoff != 0) 918#define XFS_DFORK_BOFF(dip) ((int)((dip)->di_forkoff << 3)) 919 920#define XFS_DFORK_DSIZE(dip,mp) \ 921 (XFS_DFORK_Q(dip) ? \ 922 XFS_DFORK_BOFF(dip) : \ 923 XFS_LITINO(mp, (dip)->di_version)) 924#define XFS_DFORK_ASIZE(dip,mp) \ 925 (XFS_DFORK_Q(dip) ? \ 926 XFS_LITINO(mp, (dip)->di_version) - XFS_DFORK_BOFF(dip) : \ 927 0) 928#define XFS_DFORK_SIZE(dip,mp,w) \ 929 ((w) == XFS_DATA_FORK ? \ 930 XFS_DFORK_DSIZE(dip, mp) : \ 931 XFS_DFORK_ASIZE(dip, mp)) 932 933/* 934 * Return pointers to the data or attribute forks. 935 */ 936#define XFS_DFORK_DPTR(dip) \ 937 ((char *)dip + xfs_dinode_size(dip->di_version)) 938#define XFS_DFORK_APTR(dip) \ 939 (XFS_DFORK_DPTR(dip) + XFS_DFORK_BOFF(dip)) 940#define XFS_DFORK_PTR(dip,w) \ 941 ((w) == XFS_DATA_FORK ? XFS_DFORK_DPTR(dip) : XFS_DFORK_APTR(dip)) 942 943#define XFS_DFORK_FORMAT(dip,w) \ 944 ((w) == XFS_DATA_FORK ? \ 945 (dip)->di_format : \ 946 (dip)->di_aformat) 947#define XFS_DFORK_NEXTENTS(dip,w) \ 948 ((w) == XFS_DATA_FORK ? \ 949 be32_to_cpu((dip)->di_nextents) : \ 950 be16_to_cpu((dip)->di_anextents)) 951 952/* 953 * For block and character special files the 32bit dev_t is stored at the 954 * beginning of the data fork. 955 */ 956static inline xfs_dev_t xfs_dinode_get_rdev(struct xfs_dinode *dip) 957{ 958 return be32_to_cpu(*(__be32 *)XFS_DFORK_DPTR(dip)); 959} 960 961static inline void xfs_dinode_put_rdev(struct xfs_dinode *dip, xfs_dev_t rdev) 962{ 963 *(__be32 *)XFS_DFORK_DPTR(dip) = cpu_to_be32(rdev); 964} 965 966/* 967 * Values for di_flags 968 * There should be a one-to-one correspondence between these flags and the 969 * XFS_XFLAG_s. 970 */ 971#define XFS_DIFLAG_REALTIME_BIT 0 /* file's blocks come from rt area */ 972#define XFS_DIFLAG_PREALLOC_BIT 1 /* file space has been preallocated */ 973#define XFS_DIFLAG_NEWRTBM_BIT 2 /* for rtbitmap inode, new format */ 974#define XFS_DIFLAG_IMMUTABLE_BIT 3 /* inode is immutable */ 975#define XFS_DIFLAG_APPEND_BIT 4 /* inode is append-only */ 976#define XFS_DIFLAG_SYNC_BIT 5 /* inode is written synchronously */ 977#define XFS_DIFLAG_NOATIME_BIT 6 /* do not update atime */ 978#define XFS_DIFLAG_NODUMP_BIT 7 /* do not dump */ 979#define XFS_DIFLAG_RTINHERIT_BIT 8 /* create with realtime bit set */ 980#define XFS_DIFLAG_PROJINHERIT_BIT 9 /* create with parents projid */ 981#define XFS_DIFLAG_NOSYMLINKS_BIT 10 /* disallow symlink creation */ 982#define XFS_DIFLAG_EXTSIZE_BIT 11 /* inode extent size allocator hint */ 983#define XFS_DIFLAG_EXTSZINHERIT_BIT 12 /* inherit inode extent size */ 984#define XFS_DIFLAG_NODEFRAG_BIT 13 /* do not reorganize/defragment */ 985#define XFS_DIFLAG_FILESTREAM_BIT 14 /* use filestream allocator */ 986#define XFS_DIFLAG_REALTIME (1 << XFS_DIFLAG_REALTIME_BIT) 987#define XFS_DIFLAG_PREALLOC (1 << XFS_DIFLAG_PREALLOC_BIT) 988#define XFS_DIFLAG_NEWRTBM (1 << XFS_DIFLAG_NEWRTBM_BIT) 989#define XFS_DIFLAG_IMMUTABLE (1 << XFS_DIFLAG_IMMUTABLE_BIT) 990#define XFS_DIFLAG_APPEND (1 << XFS_DIFLAG_APPEND_BIT) 991#define XFS_DIFLAG_SYNC (1 << XFS_DIFLAG_SYNC_BIT) 992#define XFS_DIFLAG_NOATIME (1 << XFS_DIFLAG_NOATIME_BIT) 993#define XFS_DIFLAG_NODUMP (1 << XFS_DIFLAG_NODUMP_BIT) 994#define XFS_DIFLAG_RTINHERIT (1 << XFS_DIFLAG_RTINHERIT_BIT) 995#define XFS_DIFLAG_PROJINHERIT (1 << XFS_DIFLAG_PROJINHERIT_BIT) 996#define XFS_DIFLAG_NOSYMLINKS (1 << XFS_DIFLAG_NOSYMLINKS_BIT) 997#define XFS_DIFLAG_EXTSIZE (1 << XFS_DIFLAG_EXTSIZE_BIT) 998#define XFS_DIFLAG_EXTSZINHERIT (1 << XFS_DIFLAG_EXTSZINHERIT_BIT) 999#define XFS_DIFLAG_NODEFRAG (1 << XFS_DIFLAG_NODEFRAG_BIT) 1000#define XFS_DIFLAG_FILESTREAM (1 << XFS_DIFLAG_FILESTREAM_BIT) 1001 1002#define XFS_DIFLAG_ANY \ 1003 (XFS_DIFLAG_REALTIME | XFS_DIFLAG_PREALLOC | XFS_DIFLAG_NEWRTBM | \ 1004 XFS_DIFLAG_IMMUTABLE | XFS_DIFLAG_APPEND | XFS_DIFLAG_SYNC | \ 1005 XFS_DIFLAG_NOATIME | XFS_DIFLAG_NODUMP | XFS_DIFLAG_RTINHERIT | \ 1006 XFS_DIFLAG_PROJINHERIT | XFS_DIFLAG_NOSYMLINKS | XFS_DIFLAG_EXTSIZE | \ 1007 XFS_DIFLAG_EXTSZINHERIT | XFS_DIFLAG_NODEFRAG | XFS_DIFLAG_FILESTREAM) 1008 1009/* 1010 * Inode number format: 1011 * low inopblog bits - offset in block 1012 * next agblklog bits - block number in ag 1013 * next agno_log bits - ag number 1014 * high agno_log-agblklog-inopblog bits - 0 1015 */ 1016#define XFS_INO_MASK(k) (__uint32_t)((1ULL << (k)) - 1) 1017#define XFS_INO_OFFSET_BITS(mp) (mp)->m_sb.sb_inopblog 1018#define XFS_INO_AGBNO_BITS(mp) (mp)->m_sb.sb_agblklog 1019#define XFS_INO_AGINO_BITS(mp) (mp)->m_agino_log 1020#define XFS_INO_AGNO_BITS(mp) (mp)->m_agno_log 1021#define XFS_INO_BITS(mp) \ 1022 XFS_INO_AGNO_BITS(mp) + XFS_INO_AGINO_BITS(mp) 1023#define XFS_INO_TO_AGNO(mp,i) \ 1024 ((xfs_agnumber_t)((i) >> XFS_INO_AGINO_BITS(mp))) 1025#define XFS_INO_TO_AGINO(mp,i) \ 1026 ((xfs_agino_t)(i) & XFS_INO_MASK(XFS_INO_AGINO_BITS(mp))) 1027#define XFS_INO_TO_AGBNO(mp,i) \ 1028 (((xfs_agblock_t)(i) >> XFS_INO_OFFSET_BITS(mp)) & \ 1029 XFS_INO_MASK(XFS_INO_AGBNO_BITS(mp))) 1030#define XFS_INO_TO_OFFSET(mp,i) \ 1031 ((int)(i) & XFS_INO_MASK(XFS_INO_OFFSET_BITS(mp))) 1032#define XFS_INO_TO_FSB(mp,i) \ 1033 XFS_AGB_TO_FSB(mp, XFS_INO_TO_AGNO(mp,i), XFS_INO_TO_AGBNO(mp,i)) 1034#define XFS_AGINO_TO_INO(mp,a,i) \ 1035 (((xfs_ino_t)(a) << XFS_INO_AGINO_BITS(mp)) | (i)) 1036#define XFS_AGINO_TO_AGBNO(mp,i) ((i) >> XFS_INO_OFFSET_BITS(mp)) 1037#define XFS_AGINO_TO_OFFSET(mp,i) \ 1038 ((i) & XFS_INO_MASK(XFS_INO_OFFSET_BITS(mp))) 1039#define XFS_OFFBNO_TO_AGINO(mp,b,o) \ 1040 ((xfs_agino_t)(((b) << XFS_INO_OFFSET_BITS(mp)) | (o))) 1041 1042#define XFS_MAXINUMBER ((xfs_ino_t)((1ULL << 56) - 1ULL)) 1043#define XFS_MAXINUMBER_32 ((xfs_ino_t)((1ULL << 32) - 1ULL)) 1044 1045/* 1046 * RealTime Device format definitions 1047 */ 1048 1049/* Min and max rt extent sizes, specified in bytes */ 1050#define XFS_MAX_RTEXTSIZE (1024 * 1024 * 1024) /* 1GB */ 1051#define XFS_DFL_RTEXTSIZE (64 * 1024) /* 64kB */ 1052#define XFS_MIN_RTEXTSIZE (4 * 1024) /* 4kB */ 1053 1054#define XFS_BLOCKSIZE(mp) ((mp)->m_sb.sb_blocksize) 1055#define XFS_BLOCKMASK(mp) ((mp)->m_blockmask) 1056#define XFS_BLOCKWSIZE(mp) ((mp)->m_blockwsize) 1057#define XFS_BLOCKWMASK(mp) ((mp)->m_blockwmask) 1058 1059/* 1060 * RT Summary and bit manipulation macros. 1061 */ 1062#define XFS_SUMOFFS(mp,ls,bb) ((int)((ls) * (mp)->m_sb.sb_rbmblocks + (bb))) 1063#define XFS_SUMOFFSTOBLOCK(mp,s) \ 1064 (((s) * (uint)sizeof(xfs_suminfo_t)) >> (mp)->m_sb.sb_blocklog) 1065#define XFS_SUMPTR(mp,bp,so) \ 1066 ((xfs_suminfo_t *)((bp)->b_addr + \ 1067 (((so) * (uint)sizeof(xfs_suminfo_t)) & XFS_BLOCKMASK(mp)))) 1068 1069#define XFS_BITTOBLOCK(mp,bi) ((bi) >> (mp)->m_blkbit_log) 1070#define XFS_BLOCKTOBIT(mp,bb) ((bb) << (mp)->m_blkbit_log) 1071#define XFS_BITTOWORD(mp,bi) \ 1072 ((int)(((bi) >> XFS_NBWORDLOG) & XFS_BLOCKWMASK(mp))) 1073 1074#define XFS_RTMIN(a,b) ((a) < (b) ? (a) : (b)) 1075#define XFS_RTMAX(a,b) ((a) > (b) ? (a) : (b)) 1076 1077#define XFS_RTLOBIT(w) xfs_lowbit32(w) 1078#define XFS_RTHIBIT(w) xfs_highbit32(w) 1079 1080#define XFS_RTBLOCKLOG(b) xfs_highbit64(b) 1081 1082/* 1083 * Dquot and dquot block format definitions 1084 */ 1085#define XFS_DQUOT_MAGIC 0x4451 /* 'DQ' */ 1086#define XFS_DQUOT_VERSION (u_int8_t)0x01 /* latest version number */ 1087 1088/* 1089 * This is the main portion of the on-disk representation of quota 1090 * information for a user. This is the q_core of the xfs_dquot_t that 1091 * is kept in kernel memory. We pad this with some more expansion room 1092 * to construct the on disk structure. 1093 */ 1094typedef struct xfs_disk_dquot { 1095 __be16 d_magic; /* dquot magic = XFS_DQUOT_MAGIC */ 1096 __u8 d_version; /* dquot version */ 1097 __u8 d_flags; /* XFS_DQ_USER/PROJ/GROUP */ 1098 __be32 d_id; /* user,project,group id */ 1099 __be64 d_blk_hardlimit;/* absolute limit on disk blks */ 1100 __be64 d_blk_softlimit;/* preferred limit on disk blks */ 1101 __be64 d_ino_hardlimit;/* maximum # allocated inodes */ 1102 __be64 d_ino_softlimit;/* preferred inode limit */ 1103 __be64 d_bcount; /* disk blocks owned by the user */ 1104 __be64 d_icount; /* inodes owned by the user */ 1105 __be32 d_itimer; /* zero if within inode limits if not, 1106 this is when we refuse service */ 1107 __be32 d_btimer; /* similar to above; for disk blocks */ 1108 __be16 d_iwarns; /* warnings issued wrt num inodes */ 1109 __be16 d_bwarns; /* warnings issued wrt disk blocks */ 1110 __be32 d_pad0; /* 64 bit align */ 1111 __be64 d_rtb_hardlimit;/* absolute limit on realtime blks */ 1112 __be64 d_rtb_softlimit;/* preferred limit on RT disk blks */ 1113 __be64 d_rtbcount; /* realtime blocks owned */ 1114 __be32 d_rtbtimer; /* similar to above; for RT disk blocks */ 1115 __be16 d_rtbwarns; /* warnings issued wrt RT disk blocks */ 1116 __be16 d_pad; 1117} xfs_disk_dquot_t; 1118 1119/* 1120 * This is what goes on disk. This is separated from the xfs_disk_dquot because 1121 * carrying the unnecessary padding would be a waste of memory. 1122 */ 1123typedef struct xfs_dqblk { 1124 xfs_disk_dquot_t dd_diskdq; /* portion that lives incore as well */ 1125 char dd_fill[4]; /* filling for posterity */ 1126 1127 /* 1128 * These two are only present on filesystems with the CRC bits set. 1129 */ 1130 __be32 dd_crc; /* checksum */ 1131 __be64 dd_lsn; /* last modification in log */ 1132 uuid_t dd_uuid; /* location information */ 1133} xfs_dqblk_t; 1134 1135#define XFS_DQUOT_CRC_OFF offsetof(struct xfs_dqblk, dd_crc) 1136 1137/* 1138 * Remote symlink format and access functions. 1139 */ 1140#define XFS_SYMLINK_MAGIC 0x58534c4d /* XSLM */ 1141 1142struct xfs_dsymlink_hdr { 1143 __be32 sl_magic; 1144 __be32 sl_offset; 1145 __be32 sl_bytes; 1146 __be32 sl_crc; 1147 uuid_t sl_uuid; 1148 __be64 sl_owner; 1149 __be64 sl_blkno; 1150 __be64 sl_lsn; 1151}; 1152 1153#define XFS_SYMLINK_CRC_OFF offsetof(struct xfs_dsymlink_hdr, sl_crc) 1154 1155/* 1156 * The maximum pathlen is 1024 bytes. Since the minimum file system 1157 * blocksize is 512 bytes, we can get a max of 3 extents back from 1158 * bmapi when crc headers are taken into account. 1159 */ 1160#define XFS_SYMLINK_MAPS 3 1161 1162#define XFS_SYMLINK_BUF_SPACE(mp, bufsize) \ 1163 ((bufsize) - (xfs_sb_version_hascrc(&(mp)->m_sb) ? \ 1164 sizeof(struct xfs_dsymlink_hdr) : 0)) 1165 1166 1167/* 1168 * Allocation Btree format definitions 1169 * 1170 * There are two on-disk btrees, one sorted by blockno and one sorted 1171 * by blockcount and blockno. All blocks look the same to make the code 1172 * simpler; if we have time later, we'll make the optimizations. 1173 */ 1174#define XFS_ABTB_MAGIC 0x41425442 /* 'ABTB' for bno tree */ 1175#define XFS_ABTB_CRC_MAGIC 0x41423342 /* 'AB3B' */ 1176#define XFS_ABTC_MAGIC 0x41425443 /* 'ABTC' for cnt tree */ 1177#define XFS_ABTC_CRC_MAGIC 0x41423343 /* 'AB3C' */ 1178 1179/* 1180 * Data record/key structure 1181 */ 1182typedef struct xfs_alloc_rec { 1183 __be32 ar_startblock; /* starting block number */ 1184 __be32 ar_blockcount; /* count of free blocks */ 1185} xfs_alloc_rec_t, xfs_alloc_key_t; 1186 1187typedef struct xfs_alloc_rec_incore { 1188 xfs_agblock_t ar_startblock; /* starting block number */ 1189 xfs_extlen_t ar_blockcount; /* count of free blocks */ 1190} xfs_alloc_rec_incore_t; 1191 1192/* btree pointer type */ 1193typedef __be32 xfs_alloc_ptr_t; 1194 1195/* 1196 * Block numbers in the AG: 1197 * SB is sector 0, AGF is sector 1, AGI is sector 2, AGFL is sector 3. 1198 */ 1199#define XFS_BNO_BLOCK(mp) ((xfs_agblock_t)(XFS_AGFL_BLOCK(mp) + 1)) 1200#define XFS_CNT_BLOCK(mp) ((xfs_agblock_t)(XFS_BNO_BLOCK(mp) + 1)) 1201 1202 1203/* 1204 * Inode Allocation Btree format definitions 1205 * 1206 * There is a btree for the inode map per allocation group. 1207 */ 1208#define XFS_IBT_MAGIC 0x49414254 /* 'IABT' */ 1209#define XFS_IBT_CRC_MAGIC 0x49414233 /* 'IAB3' */ 1210#define XFS_FIBT_MAGIC 0x46494254 /* 'FIBT' */ 1211#define XFS_FIBT_CRC_MAGIC 0x46494233 /* 'FIB3' */ 1212 1213typedef __uint64_t xfs_inofree_t; 1214#define XFS_INODES_PER_CHUNK (NBBY * sizeof(xfs_inofree_t)) 1215#define XFS_INODES_PER_CHUNK_LOG (XFS_NBBYLOG + 3) 1216#define XFS_INOBT_ALL_FREE ((xfs_inofree_t)-1) 1217#define XFS_INOBT_MASK(i) ((xfs_inofree_t)1 << (i)) 1218 1219static inline xfs_inofree_t xfs_inobt_maskn(int i, int n) 1220{ 1221 return ((n >= XFS_INODES_PER_CHUNK ? 0 : XFS_INOBT_MASK(n)) - 1) << i; 1222} 1223 1224/* 1225 * Data record structure 1226 */ 1227typedef struct xfs_inobt_rec { 1228 __be32 ir_startino; /* starting inode number */ 1229 __be32 ir_freecount; /* count of free inodes (set bits) */ 1230 __be64 ir_free; /* free inode mask */ 1231} xfs_inobt_rec_t; 1232 1233typedef struct xfs_inobt_rec_incore { 1234 xfs_agino_t ir_startino; /* starting inode number */ 1235 __int32_t ir_freecount; /* count of free inodes (set bits) */ 1236 xfs_inofree_t ir_free; /* free inode mask */ 1237} xfs_inobt_rec_incore_t; 1238 1239 1240/* 1241 * Key structure 1242 */ 1243typedef struct xfs_inobt_key { 1244 __be32 ir_startino; /* starting inode number */ 1245} xfs_inobt_key_t; 1246 1247/* btree pointer type */ 1248typedef __be32 xfs_inobt_ptr_t; 1249 1250/* 1251 * block numbers in the AG. 1252 */ 1253#define XFS_IBT_BLOCK(mp) ((xfs_agblock_t)(XFS_CNT_BLOCK(mp) + 1)) 1254#define XFS_FIBT_BLOCK(mp) ((xfs_agblock_t)(XFS_IBT_BLOCK(mp) + 1)) 1255 1256/* 1257 * The first data block of an AG depends on whether the filesystem was formatted 1258 * with the finobt feature. If so, account for the finobt reserved root btree 1259 * block. 1260 */ 1261#define XFS_PREALLOC_BLOCKS(mp) \ 1262 (xfs_sb_version_hasfinobt(&((mp)->m_sb)) ? \ 1263 XFS_FIBT_BLOCK(mp) + 1 : \ 1264 XFS_IBT_BLOCK(mp) + 1) 1265 1266 1267 1268/* 1269 * BMAP Btree format definitions 1270 * 1271 * This includes both the root block definition that sits inside an inode fork 1272 * and the record/pointer formats for the leaf/node in the blocks. 1273 */ 1274#define XFS_BMAP_MAGIC 0x424d4150 /* 'BMAP' */ 1275#define XFS_BMAP_CRC_MAGIC 0x424d4133 /* 'BMA3' */ 1276 1277/* 1278 * Bmap root header, on-disk form only. 1279 */ 1280typedef struct xfs_bmdr_block { 1281 __be16 bb_level; /* 0 is a leaf */ 1282 __be16 bb_numrecs; /* current # of data records */ 1283} xfs_bmdr_block_t; 1284 1285/* 1286 * Bmap btree record and extent descriptor. 1287 * l0:63 is an extent flag (value 1 indicates non-normal). 1288 * l0:9-62 are startoff. 1289 * l0:0-8 and l1:21-63 are startblock. 1290 * l1:0-20 are blockcount. 1291 */ 1292#define BMBT_EXNTFLAG_BITLEN 1 1293#define BMBT_STARTOFF_BITLEN 54 1294#define BMBT_STARTBLOCK_BITLEN 52 1295#define BMBT_BLOCKCOUNT_BITLEN 21 1296 1297typedef struct xfs_bmbt_rec { 1298 __be64 l0, l1; 1299} xfs_bmbt_rec_t; 1300 1301typedef __uint64_t xfs_bmbt_rec_base_t; /* use this for casts */ 1302typedef xfs_bmbt_rec_t xfs_bmdr_rec_t; 1303 1304typedef struct xfs_bmbt_rec_host { 1305 __uint64_t l0, l1; 1306} xfs_bmbt_rec_host_t; 1307 1308/* 1309 * Values and macros for delayed-allocation startblock fields. 1310 */ 1311#define STARTBLOCKVALBITS 17 1312#define STARTBLOCKMASKBITS (15 + 20) 1313#define STARTBLOCKMASK \ 1314 (((((xfs_fsblock_t)1) << STARTBLOCKMASKBITS) - 1) << STARTBLOCKVALBITS) 1315 1316static inline int isnullstartblock(xfs_fsblock_t x) 1317{ 1318 return ((x) & STARTBLOCKMASK) == STARTBLOCKMASK; 1319} 1320 1321static inline xfs_fsblock_t nullstartblock(int k) 1322{ 1323 ASSERT(k < (1 << STARTBLOCKVALBITS)); 1324 return STARTBLOCKMASK | (k); 1325} 1326 1327static inline xfs_filblks_t startblockval(xfs_fsblock_t x) 1328{ 1329 return (xfs_filblks_t)((x) & ~STARTBLOCKMASK); 1330} 1331 1332/* 1333 * Possible extent formats. 1334 */ 1335typedef enum { 1336 XFS_EXTFMT_NOSTATE = 0, 1337 XFS_EXTFMT_HASSTATE 1338} xfs_exntfmt_t; 1339 1340/* 1341 * Possible extent states. 1342 */ 1343typedef enum { 1344 XFS_EXT_NORM, XFS_EXT_UNWRITTEN, 1345 XFS_EXT_DMAPI_OFFLINE, XFS_EXT_INVALID 1346} xfs_exntst_t; 1347 1348/* 1349 * Incore version of above. 1350 */ 1351typedef struct xfs_bmbt_irec 1352{ 1353 xfs_fileoff_t br_startoff; /* starting file offset */ 1354 xfs_fsblock_t br_startblock; /* starting block number */ 1355 xfs_filblks_t br_blockcount; /* number of blocks */ 1356 xfs_exntst_t br_state; /* extent state */ 1357} xfs_bmbt_irec_t; 1358 1359/* 1360 * Key structure for non-leaf levels of the tree. 1361 */ 1362typedef struct xfs_bmbt_key { 1363 __be64 br_startoff; /* starting file offset */ 1364} xfs_bmbt_key_t, xfs_bmdr_key_t; 1365 1366/* btree pointer type */ 1367typedef __be64 xfs_bmbt_ptr_t, xfs_bmdr_ptr_t; 1368 1369 1370/* 1371 * Generic Btree block format definitions 1372 * 1373 * This is a combination of the actual format used on disk for short and long 1374 * format btrees. The first three fields are shared by both format, but the 1375 * pointers are different and should be used with care. 1376 * 1377 * To get the size of the actual short or long form headers please use the size 1378 * macros below. Never use sizeof(xfs_btree_block). 1379 * 1380 * The blkno, crc, lsn, owner and uuid fields are only available in filesystems 1381 * with the crc feature bit, and all accesses to them must be conditional on 1382 * that flag. 1383 */ 1384struct xfs_btree_block { 1385 __be32 bb_magic; /* magic number for block type */ 1386 __be16 bb_level; /* 0 is a leaf */ 1387 __be16 bb_numrecs; /* current # of data records */ 1388 union { 1389 struct { 1390 __be32 bb_leftsib; 1391 __be32 bb_rightsib; 1392 1393 __be64 bb_blkno; 1394 __be64 bb_lsn; 1395 uuid_t bb_uuid; 1396 __be32 bb_owner; 1397 __le32 bb_crc; 1398 } s; /* short form pointers */ 1399 struct { 1400 __be64 bb_leftsib; 1401 __be64 bb_rightsib; 1402 1403 __be64 bb_blkno; 1404 __be64 bb_lsn; 1405 uuid_t bb_uuid; 1406 __be64 bb_owner; 1407 __le32 bb_crc; 1408 __be32 bb_pad; /* padding for alignment */ 1409 } l; /* long form pointers */ 1410 } bb_u; /* rest */ 1411}; 1412 1413#define XFS_BTREE_SBLOCK_LEN 16 /* size of a short form block */ 1414#define XFS_BTREE_LBLOCK_LEN 24 /* size of a long form block */ 1415 1416/* sizes of CRC enabled btree blocks */ 1417#define XFS_BTREE_SBLOCK_CRC_LEN (XFS_BTREE_SBLOCK_LEN + 40) 1418#define XFS_BTREE_LBLOCK_CRC_LEN (XFS_BTREE_LBLOCK_LEN + 48) 1419 1420#define XFS_BTREE_SBLOCK_CRC_OFF \ 1421 offsetof(struct xfs_btree_block, bb_u.s.bb_crc) 1422#define XFS_BTREE_LBLOCK_CRC_OFF \ 1423 offsetof(struct xfs_btree_block, bb_u.l.bb_crc) 1424 1425/* 1426 * On-disk XFS access control list structure. 1427 */ 1428struct xfs_acl_entry { 1429 __be32 ae_tag; 1430 __be32 ae_id; 1431 __be16 ae_perm; 1432 __be16 ae_pad; /* fill the implicit hole in the structure */ 1433}; 1434 1435struct xfs_acl { 1436 __be32 acl_cnt; 1437 struct xfs_acl_entry acl_entry[0]; 1438}; 1439 1440/* 1441 * The number of ACL entries allowed is defined by the on-disk format. 1442 * For v4 superblocks, that is limited to 25 entries. For v5 superblocks, it is 1443 * limited only by the maximum size of the xattr that stores the information. 1444 */ 1445#define XFS_ACL_MAX_ENTRIES(mp) \ 1446 (xfs_sb_version_hascrc(&mp->m_sb) \ 1447 ? (XATTR_SIZE_MAX - sizeof(struct xfs_acl)) / \ 1448 sizeof(struct xfs_acl_entry) \ 1449 : 25) 1450 1451#define XFS_ACL_MAX_SIZE(mp) \ 1452 (sizeof(struct xfs_acl) + \ 1453 sizeof(struct xfs_acl_entry) * XFS_ACL_MAX_ENTRIES((mp))) 1454 1455/* On-disk XFS extended attribute names */ 1456#define SGI_ACL_FILE (unsigned char *)"SGI_ACL_FILE" 1457#define SGI_ACL_DEFAULT (unsigned char *)"SGI_ACL_DEFAULT" 1458#define SGI_ACL_FILE_SIZE (sizeof(SGI_ACL_FILE)-1) 1459#define SGI_ACL_DEFAULT_SIZE (sizeof(SGI_ACL_DEFAULT)-1) 1460 1461#endif /* __XFS_FORMAT_H__ */ 1462