2 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
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.
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.
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
18 #ifndef __XFS_FORMAT_H__
19 #define __XFS_FORMAT_H__
22 * XFS On Disk Format Definitions
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.
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.
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
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.
67 #define XFS_SB_VERSION_OKBITS \
68 ((XFS_SB_VERSION_NUMBITS | XFS_SB_VERSION_ALLFBITS) & \
69 ~XFS_SB_VERSION_SHAREDBIT)
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.
76 * These defines represent bits in sb_features2.
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 */
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)
94 * Superblock - in core version. Must match the ondisk version below.
95 * Must be padded to 64 bit alignment.
97 typedef 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 */
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().
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 */
137 * End contiguous fields.
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 */
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.
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
162 __uint32_t sb_bad_features2;
164 /* version 5 superblock fields start here */
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;
172 __uint32_t sb_crc; /* superblock crc */
173 xfs_extlen_t sb_spino_align; /* sparse inode chunk alignment */
175 xfs_ino_t sb_pquotino; /* project quota inode */
176 xfs_lsn_t sb_lsn; /* last write sequence */
178 /* must be padded to 64 bit alignment */
181 #define XFS_SB_CRC_OFF offsetof(struct xfs_sb, sb_crc)
184 * Superblock - on disk version. Must match the in core version above.
185 * Must be padded to 64 bit alignment.
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; /* 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 */
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().
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 */
227 * End contiguous fields.
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 */
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.
248 __be32 sb_bad_features2;
250 /* version 5 superblock fields start here */
253 __be32 sb_features_compat;
254 __be32 sb_features_ro_compat;
255 __be32 sb_features_incompat;
256 __be32 sb_features_log_incompat;
258 __le32 sb_crc; /* superblock crc */
259 __be32 sb_spino_align; /* sparse inode chunk alignment */
261 __be64 sb_pquotino; /* project quota inode */
262 __be64 sb_lsn; /* last write sequence */
264 /* must be padded to 64 bit alignment */
269 * Misc. Flags - warning - these will be cleared by xfs_repair unless
270 * a feature bit is set when the flag is used.
272 #define XFS_SBF_NOFLAGS 0x00 /* no flags set */
273 #define XFS_SBF_READONLY 0x01 /* only read-only mounts allowed */
276 * define max. shared version we can interoperate with
278 #define XFS_SB_MAX_SHARED_VN 0
280 #define XFS_SB_VERSION_NUM(sbp) ((sbp)->sb_versionnum & XFS_SB_VERSION_NUMBITS)
283 * The first XFS version we support is a v4 superblock with V2 directories.
285 static inline bool xfs_sb_good_v4_features(struct xfs_sb *sbp)
287 if (!(sbp->sb_versionnum & XFS_SB_VERSION_DIRV2BIT))
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)))
299 static inline bool xfs_sb_good_version(struct xfs_sb *sbp)
301 if (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5)
303 if (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4)
304 return xfs_sb_good_v4_features(sbp);
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.
312 static inline bool xfs_sb_has_mismatched_features2(struct xfs_sb *sbp)
314 return sbp->sb_bad_features2 != sbp->sb_features2;
317 static inline bool xfs_sb_version_hasattr(struct xfs_sb *sbp)
319 return (sbp->sb_versionnum & XFS_SB_VERSION_ATTRBIT);
322 static inline void xfs_sb_version_addattr(struct xfs_sb *sbp)
324 sbp->sb_versionnum |= XFS_SB_VERSION_ATTRBIT;
327 static inline bool xfs_sb_version_hasquota(struct xfs_sb *sbp)
329 return (sbp->sb_versionnum & XFS_SB_VERSION_QUOTABIT);
332 static inline void xfs_sb_version_addquota(struct xfs_sb *sbp)
334 sbp->sb_versionnum |= XFS_SB_VERSION_QUOTABIT;
337 static inline bool xfs_sb_version_hasalign(struct xfs_sb *sbp)
339 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 ||
340 (sbp->sb_versionnum & XFS_SB_VERSION_ALIGNBIT));
343 static inline bool xfs_sb_version_hasdalign(struct xfs_sb *sbp)
345 return (sbp->sb_versionnum & XFS_SB_VERSION_DALIGNBIT);
348 static inline bool xfs_sb_version_haslogv2(struct xfs_sb *sbp)
350 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 ||
351 (sbp->sb_versionnum & XFS_SB_VERSION_LOGV2BIT);
354 static inline bool xfs_sb_version_hasextflgbit(struct xfs_sb *sbp)
356 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 ||
357 (sbp->sb_versionnum & XFS_SB_VERSION_EXTFLGBIT);
360 static inline bool xfs_sb_version_hassector(struct xfs_sb *sbp)
362 return (sbp->sb_versionnum & XFS_SB_VERSION_SECTORBIT);
365 static inline bool xfs_sb_version_hasasciici(struct xfs_sb *sbp)
367 return (sbp->sb_versionnum & XFS_SB_VERSION_BORGBIT);
370 static inline bool xfs_sb_version_hasmorebits(struct xfs_sb *sbp)
372 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 ||
373 (sbp->sb_versionnum & XFS_SB_VERSION_MOREBITSBIT);
377 * sb_features2 bit version macros.
379 static inline bool xfs_sb_version_haslazysbcount(struct xfs_sb *sbp)
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));
386 static inline bool xfs_sb_version_hasattr2(struct xfs_sb *sbp)
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));
393 static inline void xfs_sb_version_addattr2(struct xfs_sb *sbp)
395 sbp->sb_versionnum |= XFS_SB_VERSION_MOREBITSBIT;
396 sbp->sb_features2 |= XFS_SB_VERSION2_ATTR2BIT;
399 static inline void xfs_sb_version_removeattr2(struct xfs_sb *sbp)
401 sbp->sb_features2 &= ~XFS_SB_VERSION2_ATTR2BIT;
402 if (!sbp->sb_features2)
403 sbp->sb_versionnum &= ~XFS_SB_VERSION_MOREBITSBIT;
406 static inline bool xfs_sb_version_hasprojid32bit(struct xfs_sb *sbp)
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));
413 static inline void xfs_sb_version_addprojid32bit(struct xfs_sb *sbp)
415 sbp->sb_versionnum |= XFS_SB_VERSION_MOREBITSBIT;
416 sbp->sb_features2 |= XFS_SB_VERSION2_PROJID32BIT;
420 * Extended v5 superblock feature masks. These are to be used for new v5
421 * superblock features only.
423 * Compat features are new features that old kernels will not notice or affect
424 * and so can mount read-write without issues.
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.
430 * InCompat features are features which old kernels will not understand and so
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.
437 #define XFS_SB_FEAT_COMPAT_ALL 0
438 #define XFS_SB_FEAT_COMPAT_UNKNOWN ~XFS_SB_FEAT_COMPAT_ALL
440 xfs_sb_has_compat_feature(
444 return (sbp->sb_features_compat & feature) != 0;
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
452 xfs_sb_has_ro_compat_feature(
456 return (sbp->sb_features_ro_compat & feature) != 0;
459 #define XFS_SB_FEAT_INCOMPAT_FTYPE (1 << 0) /* filetype in dirent */
460 #define XFS_SB_FEAT_INCOMPAT_SPINODES (1 << 1) /* sparse inode chunks */
461 #define XFS_SB_FEAT_INCOMPAT_ALL \
462 (XFS_SB_FEAT_INCOMPAT_FTYPE)
464 #define XFS_SB_FEAT_INCOMPAT_UNKNOWN ~XFS_SB_FEAT_INCOMPAT_ALL
466 xfs_sb_has_incompat_feature(
470 return (sbp->sb_features_incompat & feature) != 0;
473 #define XFS_SB_FEAT_INCOMPAT_LOG_ALL 0
474 #define XFS_SB_FEAT_INCOMPAT_LOG_UNKNOWN ~XFS_SB_FEAT_INCOMPAT_LOG_ALL
476 xfs_sb_has_incompat_log_feature(
480 return (sbp->sb_features_log_incompat & feature) != 0;
484 * V5 superblock specific feature checks
486 static inline int xfs_sb_version_hascrc(struct xfs_sb *sbp)
488 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5;
491 static inline int xfs_sb_version_has_pquotino(struct xfs_sb *sbp)
493 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5;
496 static inline int xfs_sb_version_hasftype(struct xfs_sb *sbp)
498 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 &&
499 xfs_sb_has_incompat_feature(sbp, XFS_SB_FEAT_INCOMPAT_FTYPE)) ||
500 (xfs_sb_version_hasmorebits(sbp) &&
501 (sbp->sb_features2 & XFS_SB_VERSION2_FTYPE));
504 static inline int xfs_sb_version_hasfinobt(xfs_sb_t *sbp)
506 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) &&
507 (sbp->sb_features_ro_compat & XFS_SB_FEAT_RO_COMPAT_FINOBT);
510 static inline bool xfs_sb_version_hassparseinodes(struct xfs_sb *sbp)
512 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 &&
513 xfs_sb_has_incompat_feature(sbp, XFS_SB_FEAT_INCOMPAT_SPINODES);
517 * end of superblock version macros
521 xfs_is_quota_inode(struct xfs_sb *sbp, xfs_ino_t ino)
523 return (ino == sbp->sb_uquotino ||
524 ino == sbp->sb_gquotino ||
525 ino == sbp->sb_pquotino);
528 #define XFS_SB_DADDR ((xfs_daddr_t)0) /* daddr in filesystem/ag */
529 #define XFS_SB_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_SB_DADDR)
530 #define XFS_BUF_TO_SBP(bp) ((xfs_dsb_t *)((bp)->b_addr))
532 #define XFS_HDR_BLOCK(mp,d) ((xfs_agblock_t)XFS_BB_TO_FSBT(mp,d))
533 #define XFS_DADDR_TO_FSB(mp,d) XFS_AGB_TO_FSB(mp, \
534 xfs_daddr_to_agno(mp,d), xfs_daddr_to_agbno(mp,d))
535 #define XFS_FSB_TO_DADDR(mp,fsbno) XFS_AGB_TO_DADDR(mp, \
536 XFS_FSB_TO_AGNO(mp,fsbno), XFS_FSB_TO_AGBNO(mp,fsbno))
539 * File system sector to basic block conversions.
541 #define XFS_FSS_TO_BB(mp,sec) ((sec) << (mp)->m_sectbb_log)
544 * File system block to basic block conversions.
546 #define XFS_FSB_TO_BB(mp,fsbno) ((fsbno) << (mp)->m_blkbb_log)
547 #define XFS_BB_TO_FSB(mp,bb) \
548 (((bb) + (XFS_FSB_TO_BB(mp,1) - 1)) >> (mp)->m_blkbb_log)
549 #define XFS_BB_TO_FSBT(mp,bb) ((bb) >> (mp)->m_blkbb_log)
552 * File system block to byte conversions.
554 #define XFS_FSB_TO_B(mp,fsbno) ((xfs_fsize_t)(fsbno) << (mp)->m_sb.sb_blocklog)
555 #define XFS_B_TO_FSB(mp,b) \
556 ((((__uint64_t)(b)) + (mp)->m_blockmask) >> (mp)->m_sb.sb_blocklog)
557 #define XFS_B_TO_FSBT(mp,b) (((__uint64_t)(b)) >> (mp)->m_sb.sb_blocklog)
558 #define XFS_B_FSB_OFFSET(mp,b) ((b) & (mp)->m_blockmask)
561 * Allocation group header
563 * This is divided into three structures, placed in sequential 512-byte
564 * buffers after a copy of the superblock (also in a 512-byte buffer).
566 #define XFS_AGF_MAGIC 0x58414746 /* 'XAGF' */
567 #define XFS_AGI_MAGIC 0x58414749 /* 'XAGI' */
568 #define XFS_AGFL_MAGIC 0x5841464c /* 'XAFL' */
569 #define XFS_AGF_VERSION 1
570 #define XFS_AGI_VERSION 1
572 #define XFS_AGF_GOOD_VERSION(v) ((v) == XFS_AGF_VERSION)
573 #define XFS_AGI_GOOD_VERSION(v) ((v) == XFS_AGI_VERSION)
576 * Btree number 0 is bno, 1 is cnt. This value gives the size of the
579 #define XFS_BTNUM_AGF ((int)XFS_BTNUM_CNTi + 1)
582 * The second word of agf_levels in the first a.g. overlaps the EFS
583 * superblock's magic number. Since the magic numbers valid for EFS
584 * are > 64k, our value cannot be confused for an EFS superblock's.
587 typedef struct xfs_agf {
589 * Common allocation group header information
591 __be32 agf_magicnum; /* magic number == XFS_AGF_MAGIC */
592 __be32 agf_versionnum; /* header version == XFS_AGF_VERSION */
593 __be32 agf_seqno; /* sequence # starting from 0 */
594 __be32 agf_length; /* size in blocks of a.g. */
596 * Freespace information
598 __be32 agf_roots[XFS_BTNUM_AGF]; /* root blocks */
599 __be32 agf_spare0; /* spare field */
600 __be32 agf_levels[XFS_BTNUM_AGF]; /* btree levels */
601 __be32 agf_spare1; /* spare field */
603 __be32 agf_flfirst; /* first freelist block's index */
604 __be32 agf_fllast; /* last freelist block's index */
605 __be32 agf_flcount; /* count of blocks in freelist */
606 __be32 agf_freeblks; /* total free blocks */
608 __be32 agf_longest; /* longest free space */
609 __be32 agf_btreeblks; /* # of blocks held in AGF btrees */
610 uuid_t agf_uuid; /* uuid of filesystem */
613 * reserve some contiguous space for future logged fields before we add
614 * the unlogged fields. This makes the range logging via flags and
615 * structure offsets much simpler.
617 __be64 agf_spare64[16];
619 /* unlogged fields, written during buffer writeback. */
620 __be64 agf_lsn; /* last write sequence */
621 __be32 agf_crc; /* crc of agf sector */
624 /* structure must be padded to 64 bit alignment */
627 #define XFS_AGF_CRC_OFF offsetof(struct xfs_agf, agf_crc)
629 #define XFS_AGF_MAGICNUM 0x00000001
630 #define XFS_AGF_VERSIONNUM 0x00000002
631 #define XFS_AGF_SEQNO 0x00000004
632 #define XFS_AGF_LENGTH 0x00000008
633 #define XFS_AGF_ROOTS 0x00000010
634 #define XFS_AGF_LEVELS 0x00000020
635 #define XFS_AGF_FLFIRST 0x00000040
636 #define XFS_AGF_FLLAST 0x00000080
637 #define XFS_AGF_FLCOUNT 0x00000100
638 #define XFS_AGF_FREEBLKS 0x00000200
639 #define XFS_AGF_LONGEST 0x00000400
640 #define XFS_AGF_BTREEBLKS 0x00000800
641 #define XFS_AGF_UUID 0x00001000
642 #define XFS_AGF_NUM_BITS 13
643 #define XFS_AGF_ALL_BITS ((1 << XFS_AGF_NUM_BITS) - 1)
645 #define XFS_AGF_FLAGS \
646 { XFS_AGF_MAGICNUM, "MAGICNUM" }, \
647 { XFS_AGF_VERSIONNUM, "VERSIONNUM" }, \
648 { XFS_AGF_SEQNO, "SEQNO" }, \
649 { XFS_AGF_LENGTH, "LENGTH" }, \
650 { XFS_AGF_ROOTS, "ROOTS" }, \
651 { XFS_AGF_LEVELS, "LEVELS" }, \
652 { XFS_AGF_FLFIRST, "FLFIRST" }, \
653 { XFS_AGF_FLLAST, "FLLAST" }, \
654 { XFS_AGF_FLCOUNT, "FLCOUNT" }, \
655 { XFS_AGF_FREEBLKS, "FREEBLKS" }, \
656 { XFS_AGF_LONGEST, "LONGEST" }, \
657 { XFS_AGF_BTREEBLKS, "BTREEBLKS" }, \
658 { XFS_AGF_UUID, "UUID" }
660 /* disk block (xfs_daddr_t) in the AG */
661 #define XFS_AGF_DADDR(mp) ((xfs_daddr_t)(1 << (mp)->m_sectbb_log))
662 #define XFS_AGF_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGF_DADDR(mp))
663 #define XFS_BUF_TO_AGF(bp) ((xfs_agf_t *)((bp)->b_addr))
666 * Size of the unlinked inode hash table in the agi.
668 #define XFS_AGI_UNLINKED_BUCKETS 64
670 typedef struct xfs_agi {
672 * Common allocation group header information
674 __be32 agi_magicnum; /* magic number == XFS_AGI_MAGIC */
675 __be32 agi_versionnum; /* header version == XFS_AGI_VERSION */
676 __be32 agi_seqno; /* sequence # starting from 0 */
677 __be32 agi_length; /* size in blocks of a.g. */
680 * Inodes are mapped by interpreting the inode number, so no
681 * mapping data is needed here.
683 __be32 agi_count; /* count of allocated inodes */
684 __be32 agi_root; /* root of inode btree */
685 __be32 agi_level; /* levels in inode btree */
686 __be32 agi_freecount; /* number of free inodes */
688 __be32 agi_newino; /* new inode just allocated */
689 __be32 agi_dirino; /* last directory inode chunk */
691 * Hash table of inodes which have been unlinked but are
692 * still being referenced.
694 __be32 agi_unlinked[XFS_AGI_UNLINKED_BUCKETS];
696 * This marks the end of logging region 1 and start of logging region 2.
698 uuid_t agi_uuid; /* uuid of filesystem */
699 __be32 agi_crc; /* crc of agi sector */
701 __be64 agi_lsn; /* last write sequence */
703 __be32 agi_free_root; /* root of the free inode btree */
704 __be32 agi_free_level;/* levels in free inode btree */
706 /* structure must be padded to 64 bit alignment */
709 #define XFS_AGI_CRC_OFF offsetof(struct xfs_agi, agi_crc)
711 #define XFS_AGI_MAGICNUM (1 << 0)
712 #define XFS_AGI_VERSIONNUM (1 << 1)
713 #define XFS_AGI_SEQNO (1 << 2)
714 #define XFS_AGI_LENGTH (1 << 3)
715 #define XFS_AGI_COUNT (1 << 4)
716 #define XFS_AGI_ROOT (1 << 5)
717 #define XFS_AGI_LEVEL (1 << 6)
718 #define XFS_AGI_FREECOUNT (1 << 7)
719 #define XFS_AGI_NEWINO (1 << 8)
720 #define XFS_AGI_DIRINO (1 << 9)
721 #define XFS_AGI_UNLINKED (1 << 10)
722 #define XFS_AGI_NUM_BITS_R1 11 /* end of the 1st agi logging region */
723 #define XFS_AGI_ALL_BITS_R1 ((1 << XFS_AGI_NUM_BITS_R1) - 1)
724 #define XFS_AGI_FREE_ROOT (1 << 11)
725 #define XFS_AGI_FREE_LEVEL (1 << 12)
726 #define XFS_AGI_NUM_BITS_R2 13
728 /* disk block (xfs_daddr_t) in the AG */
729 #define XFS_AGI_DADDR(mp) ((xfs_daddr_t)(2 << (mp)->m_sectbb_log))
730 #define XFS_AGI_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGI_DADDR(mp))
731 #define XFS_BUF_TO_AGI(bp) ((xfs_agi_t *)((bp)->b_addr))
734 * The third a.g. block contains the a.g. freelist, an array
735 * of block pointers to blocks owned by the allocation btree code.
737 #define XFS_AGFL_DADDR(mp) ((xfs_daddr_t)(3 << (mp)->m_sectbb_log))
738 #define XFS_AGFL_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGFL_DADDR(mp))
739 #define XFS_BUF_TO_AGFL(bp) ((xfs_agfl_t *)((bp)->b_addr))
741 #define XFS_BUF_TO_AGFL_BNO(mp, bp) \
742 (xfs_sb_version_hascrc(&((mp)->m_sb)) ? \
743 &(XFS_BUF_TO_AGFL(bp)->agfl_bno[0]) : \
744 (__be32 *)(bp)->b_addr)
747 * Size of the AGFL. For CRC-enabled filesystes we steal a couple of
748 * slots in the beginning of the block for a proper header with the
749 * location information and CRC.
751 #define XFS_AGFL_SIZE(mp) \
752 (((mp)->m_sb.sb_sectsize - \
753 (xfs_sb_version_hascrc(&((mp)->m_sb)) ? \
754 sizeof(struct xfs_agfl) : 0)) / \
755 sizeof(xfs_agblock_t))
757 typedef struct xfs_agfl {
758 __be32 agfl_magicnum;
763 __be32 agfl_bno[]; /* actually XFS_AGFL_SIZE(mp) */
766 #define XFS_AGFL_CRC_OFF offsetof(struct xfs_agfl, agfl_crc)
769 #define XFS_AG_MAXLEVELS(mp) ((mp)->m_ag_maxlevels)
770 #define XFS_MIN_FREELIST_RAW(bl,cl,mp) \
771 (MIN(bl + 1, XFS_AG_MAXLEVELS(mp)) + MIN(cl + 1, XFS_AG_MAXLEVELS(mp)))
772 #define XFS_MIN_FREELIST(a,mp) \
773 (XFS_MIN_FREELIST_RAW( \
774 be32_to_cpu((a)->agf_levels[XFS_BTNUM_BNOi]), \
775 be32_to_cpu((a)->agf_levels[XFS_BTNUM_CNTi]), mp))
776 #define XFS_MIN_FREELIST_PAG(pag,mp) \
777 (XFS_MIN_FREELIST_RAW( \
778 (unsigned int)(pag)->pagf_levels[XFS_BTNUM_BNOi], \
779 (unsigned int)(pag)->pagf_levels[XFS_BTNUM_CNTi], mp))
781 #define XFS_AGB_TO_FSB(mp,agno,agbno) \
782 (((xfs_fsblock_t)(agno) << (mp)->m_sb.sb_agblklog) | (agbno))
783 #define XFS_FSB_TO_AGNO(mp,fsbno) \
784 ((xfs_agnumber_t)((fsbno) >> (mp)->m_sb.sb_agblklog))
785 #define XFS_FSB_TO_AGBNO(mp,fsbno) \
786 ((xfs_agblock_t)((fsbno) & xfs_mask32lo((mp)->m_sb.sb_agblklog)))
787 #define XFS_AGB_TO_DADDR(mp,agno,agbno) \
788 ((xfs_daddr_t)XFS_FSB_TO_BB(mp, \
789 (xfs_fsblock_t)(agno) * (mp)->m_sb.sb_agblocks + (agbno)))
790 #define XFS_AG_DADDR(mp,agno,d) (XFS_AGB_TO_DADDR(mp, agno, 0) + (d))
793 * For checking for bad ranges of xfs_daddr_t's, covering multiple
794 * allocation groups or a single xfs_daddr_t that's a superblock copy.
796 #define XFS_AG_CHECK_DADDR(mp,d,len) \
798 ASSERT((d) == XFS_SB_DADDR || \
799 xfs_daddr_to_agbno(mp, d) != XFS_SB_DADDR) : \
800 ASSERT(xfs_daddr_to_agno(mp, d) == \
801 xfs_daddr_to_agno(mp, (d) + (len) - 1)))
803 typedef struct xfs_timestamp {
804 __be32 t_sec; /* timestamp seconds */
805 __be32 t_nsec; /* timestamp nanoseconds */
809 * On-disk inode structure.
811 * This is just the header or "dinode core", the inode is expanded to fill a
812 * variable size the leftover area split into a data and an attribute fork.
813 * The format of the data and attribute fork depends on the format of the
814 * inode as indicated by di_format and di_aformat. To access the data and
815 * attribute use the XFS_DFORK_DPTR, XFS_DFORK_APTR, and XFS_DFORK_PTR macros
818 * There is a very similar struct icdinode in xfs_inode which matches the
819 * layout of the first 96 bytes of this structure, but is kept in native
820 * format instead of big endian.
822 * Note: di_flushiter is only used by v1/2 inodes - it's effectively a zeroed
823 * padding field for v3 inodes.
825 #define XFS_DINODE_MAGIC 0x494e /* 'IN' */
826 #define XFS_DINODE_GOOD_VERSION(v) ((v) >= 1 && (v) <= 3)
827 typedef struct xfs_dinode {
828 __be16 di_magic; /* inode magic # = XFS_DINODE_MAGIC */
829 __be16 di_mode; /* mode and type of file */
830 __u8 di_version; /* inode version */
831 __u8 di_format; /* format of di_c data */
832 __be16 di_onlink; /* old number of links to file */
833 __be32 di_uid; /* owner's user id */
834 __be32 di_gid; /* owner's group id */
835 __be32 di_nlink; /* number of links to file */
836 __be16 di_projid_lo; /* lower part of owner's project id */
837 __be16 di_projid_hi; /* higher part owner's project id */
838 __u8 di_pad[6]; /* unused, zeroed space */
839 __be16 di_flushiter; /* incremented on flush */
840 xfs_timestamp_t di_atime; /* time last accessed */
841 xfs_timestamp_t di_mtime; /* time last modified */
842 xfs_timestamp_t di_ctime; /* time created/inode modified */
843 __be64 di_size; /* number of bytes in file */
844 __be64 di_nblocks; /* # of direct & btree blocks used */
845 __be32 di_extsize; /* basic/minimum extent size for file */
846 __be32 di_nextents; /* number of extents in data fork */
847 __be16 di_anextents; /* number of extents in attribute fork*/
848 __u8 di_forkoff; /* attr fork offs, <<3 for 64b align */
849 __s8 di_aformat; /* format of attr fork's data */
850 __be32 di_dmevmask; /* DMIG event mask */
851 __be16 di_dmstate; /* DMIG state info */
852 __be16 di_flags; /* random flags, XFS_DIFLAG_... */
853 __be32 di_gen; /* generation number */
855 /* di_next_unlinked is the only non-core field in the old dinode */
856 __be32 di_next_unlinked;/* agi unlinked list ptr */
858 /* start of the extended dinode, writable fields */
859 __le32 di_crc; /* CRC of the inode */
860 __be64 di_changecount; /* number of attribute changes */
861 __be64 di_lsn; /* flush sequence */
862 __be64 di_flags2; /* more random flags */
863 __u8 di_pad2[16]; /* more padding for future expansion */
865 /* fields only written to during inode creation */
866 xfs_timestamp_t di_crtime; /* time created */
867 __be64 di_ino; /* inode number */
868 uuid_t di_uuid; /* UUID of the filesystem */
870 /* structure must be padded to 64 bit alignment */
873 #define XFS_DINODE_CRC_OFF offsetof(struct xfs_dinode, di_crc)
875 #define DI_MAX_FLUSH 0xffff
878 * Size of the core inode on disk. Version 1 and 2 inodes have
879 * the same size, but version 3 has grown a few additional fields.
881 static inline uint xfs_dinode_size(int version)
884 return sizeof(struct xfs_dinode);
885 return offsetof(struct xfs_dinode, di_crc);
889 * The 32 bit link count in the inode theoretically maxes out at UINT_MAX.
890 * Since the pathconf interface is signed, we use 2^31 - 1 instead.
891 * The old inode format had a 16 bit link count, so its maximum is USHRT_MAX.
893 #define XFS_MAXLINK ((1U << 31) - 1U)
894 #define XFS_MAXLINK_1 65535U
897 * Values for di_format
899 typedef enum xfs_dinode_fmt {
900 XFS_DINODE_FMT_DEV, /* xfs_dev_t */
901 XFS_DINODE_FMT_LOCAL, /* bulk data */
902 XFS_DINODE_FMT_EXTENTS, /* struct xfs_bmbt_rec */
903 XFS_DINODE_FMT_BTREE, /* struct xfs_bmdr_block */
904 XFS_DINODE_FMT_UUID /* uuid_t */
908 * Inode minimum and maximum sizes.
910 #define XFS_DINODE_MIN_LOG 8
911 #define XFS_DINODE_MAX_LOG 11
912 #define XFS_DINODE_MIN_SIZE (1 << XFS_DINODE_MIN_LOG)
913 #define XFS_DINODE_MAX_SIZE (1 << XFS_DINODE_MAX_LOG)
916 * Inode size for given fs.
918 #define XFS_LITINO(mp, version) \
919 ((int)(((mp)->m_sb.sb_inodesize) - xfs_dinode_size(version)))
922 * Inode data & attribute fork sizes, per inode.
924 #define XFS_DFORK_Q(dip) ((dip)->di_forkoff != 0)
925 #define XFS_DFORK_BOFF(dip) ((int)((dip)->di_forkoff << 3))
927 #define XFS_DFORK_DSIZE(dip,mp) \
928 (XFS_DFORK_Q(dip) ? \
929 XFS_DFORK_BOFF(dip) : \
930 XFS_LITINO(mp, (dip)->di_version))
931 #define XFS_DFORK_ASIZE(dip,mp) \
932 (XFS_DFORK_Q(dip) ? \
933 XFS_LITINO(mp, (dip)->di_version) - XFS_DFORK_BOFF(dip) : \
935 #define XFS_DFORK_SIZE(dip,mp,w) \
936 ((w) == XFS_DATA_FORK ? \
937 XFS_DFORK_DSIZE(dip, mp) : \
938 XFS_DFORK_ASIZE(dip, mp))
941 * Return pointers to the data or attribute forks.
943 #define XFS_DFORK_DPTR(dip) \
944 ((char *)dip + xfs_dinode_size(dip->di_version))
945 #define XFS_DFORK_APTR(dip) \
946 (XFS_DFORK_DPTR(dip) + XFS_DFORK_BOFF(dip))
947 #define XFS_DFORK_PTR(dip,w) \
948 ((w) == XFS_DATA_FORK ? XFS_DFORK_DPTR(dip) : XFS_DFORK_APTR(dip))
950 #define XFS_DFORK_FORMAT(dip,w) \
951 ((w) == XFS_DATA_FORK ? \
954 #define XFS_DFORK_NEXTENTS(dip,w) \
955 ((w) == XFS_DATA_FORK ? \
956 be32_to_cpu((dip)->di_nextents) : \
957 be16_to_cpu((dip)->di_anextents))
960 * For block and character special files the 32bit dev_t is stored at the
961 * beginning of the data fork.
963 static inline xfs_dev_t xfs_dinode_get_rdev(struct xfs_dinode *dip)
965 return be32_to_cpu(*(__be32 *)XFS_DFORK_DPTR(dip));
968 static inline void xfs_dinode_put_rdev(struct xfs_dinode *dip, xfs_dev_t rdev)
970 *(__be32 *)XFS_DFORK_DPTR(dip) = cpu_to_be32(rdev);
974 * Values for di_flags
975 * There should be a one-to-one correspondence between these flags and the
978 #define XFS_DIFLAG_REALTIME_BIT 0 /* file's blocks come from rt area */
979 #define XFS_DIFLAG_PREALLOC_BIT 1 /* file space has been preallocated */
980 #define XFS_DIFLAG_NEWRTBM_BIT 2 /* for rtbitmap inode, new format */
981 #define XFS_DIFLAG_IMMUTABLE_BIT 3 /* inode is immutable */
982 #define XFS_DIFLAG_APPEND_BIT 4 /* inode is append-only */
983 #define XFS_DIFLAG_SYNC_BIT 5 /* inode is written synchronously */
984 #define XFS_DIFLAG_NOATIME_BIT 6 /* do not update atime */
985 #define XFS_DIFLAG_NODUMP_BIT 7 /* do not dump */
986 #define XFS_DIFLAG_RTINHERIT_BIT 8 /* create with realtime bit set */
987 #define XFS_DIFLAG_PROJINHERIT_BIT 9 /* create with parents projid */
988 #define XFS_DIFLAG_NOSYMLINKS_BIT 10 /* disallow symlink creation */
989 #define XFS_DIFLAG_EXTSIZE_BIT 11 /* inode extent size allocator hint */
990 #define XFS_DIFLAG_EXTSZINHERIT_BIT 12 /* inherit inode extent size */
991 #define XFS_DIFLAG_NODEFRAG_BIT 13 /* do not reorganize/defragment */
992 #define XFS_DIFLAG_FILESTREAM_BIT 14 /* use filestream allocator */
993 #define XFS_DIFLAG_REALTIME (1 << XFS_DIFLAG_REALTIME_BIT)
994 #define XFS_DIFLAG_PREALLOC (1 << XFS_DIFLAG_PREALLOC_BIT)
995 #define XFS_DIFLAG_NEWRTBM (1 << XFS_DIFLAG_NEWRTBM_BIT)
996 #define XFS_DIFLAG_IMMUTABLE (1 << XFS_DIFLAG_IMMUTABLE_BIT)
997 #define XFS_DIFLAG_APPEND (1 << XFS_DIFLAG_APPEND_BIT)
998 #define XFS_DIFLAG_SYNC (1 << XFS_DIFLAG_SYNC_BIT)
999 #define XFS_DIFLAG_NOATIME (1 << XFS_DIFLAG_NOATIME_BIT)
1000 #define XFS_DIFLAG_NODUMP (1 << XFS_DIFLAG_NODUMP_BIT)
1001 #define XFS_DIFLAG_RTINHERIT (1 << XFS_DIFLAG_RTINHERIT_BIT)
1002 #define XFS_DIFLAG_PROJINHERIT (1 << XFS_DIFLAG_PROJINHERIT_BIT)
1003 #define XFS_DIFLAG_NOSYMLINKS (1 << XFS_DIFLAG_NOSYMLINKS_BIT)
1004 #define XFS_DIFLAG_EXTSIZE (1 << XFS_DIFLAG_EXTSIZE_BIT)
1005 #define XFS_DIFLAG_EXTSZINHERIT (1 << XFS_DIFLAG_EXTSZINHERIT_BIT)
1006 #define XFS_DIFLAG_NODEFRAG (1 << XFS_DIFLAG_NODEFRAG_BIT)
1007 #define XFS_DIFLAG_FILESTREAM (1 << XFS_DIFLAG_FILESTREAM_BIT)
1009 #define XFS_DIFLAG_ANY \
1010 (XFS_DIFLAG_REALTIME | XFS_DIFLAG_PREALLOC | XFS_DIFLAG_NEWRTBM | \
1011 XFS_DIFLAG_IMMUTABLE | XFS_DIFLAG_APPEND | XFS_DIFLAG_SYNC | \
1012 XFS_DIFLAG_NOATIME | XFS_DIFLAG_NODUMP | XFS_DIFLAG_RTINHERIT | \
1013 XFS_DIFLAG_PROJINHERIT | XFS_DIFLAG_NOSYMLINKS | XFS_DIFLAG_EXTSIZE | \
1014 XFS_DIFLAG_EXTSZINHERIT | XFS_DIFLAG_NODEFRAG | XFS_DIFLAG_FILESTREAM)
1017 * Inode number format:
1018 * low inopblog bits - offset in block
1019 * next agblklog bits - block number in ag
1020 * next agno_log bits - ag number
1021 * high agno_log-agblklog-inopblog bits - 0
1023 #define XFS_INO_MASK(k) (__uint32_t)((1ULL << (k)) - 1)
1024 #define XFS_INO_OFFSET_BITS(mp) (mp)->m_sb.sb_inopblog
1025 #define XFS_INO_AGBNO_BITS(mp) (mp)->m_sb.sb_agblklog
1026 #define XFS_INO_AGINO_BITS(mp) (mp)->m_agino_log
1027 #define XFS_INO_AGNO_BITS(mp) (mp)->m_agno_log
1028 #define XFS_INO_BITS(mp) \
1029 XFS_INO_AGNO_BITS(mp) + XFS_INO_AGINO_BITS(mp)
1030 #define XFS_INO_TO_AGNO(mp,i) \
1031 ((xfs_agnumber_t)((i) >> XFS_INO_AGINO_BITS(mp)))
1032 #define XFS_INO_TO_AGINO(mp,i) \
1033 ((xfs_agino_t)(i) & XFS_INO_MASK(XFS_INO_AGINO_BITS(mp)))
1034 #define XFS_INO_TO_AGBNO(mp,i) \
1035 (((xfs_agblock_t)(i) >> XFS_INO_OFFSET_BITS(mp)) & \
1036 XFS_INO_MASK(XFS_INO_AGBNO_BITS(mp)))
1037 #define XFS_INO_TO_OFFSET(mp,i) \
1038 ((int)(i) & XFS_INO_MASK(XFS_INO_OFFSET_BITS(mp)))
1039 #define XFS_INO_TO_FSB(mp,i) \
1040 XFS_AGB_TO_FSB(mp, XFS_INO_TO_AGNO(mp,i), XFS_INO_TO_AGBNO(mp,i))
1041 #define XFS_AGINO_TO_INO(mp,a,i) \
1042 (((xfs_ino_t)(a) << XFS_INO_AGINO_BITS(mp)) | (i))
1043 #define XFS_AGINO_TO_AGBNO(mp,i) ((i) >> XFS_INO_OFFSET_BITS(mp))
1044 #define XFS_AGINO_TO_OFFSET(mp,i) \
1045 ((i) & XFS_INO_MASK(XFS_INO_OFFSET_BITS(mp)))
1046 #define XFS_OFFBNO_TO_AGINO(mp,b,o) \
1047 ((xfs_agino_t)(((b) << XFS_INO_OFFSET_BITS(mp)) | (o)))
1049 #define XFS_MAXINUMBER ((xfs_ino_t)((1ULL << 56) - 1ULL))
1050 #define XFS_MAXINUMBER_32 ((xfs_ino_t)((1ULL << 32) - 1ULL))
1053 * RealTime Device format definitions
1056 /* Min and max rt extent sizes, specified in bytes */
1057 #define XFS_MAX_RTEXTSIZE (1024 * 1024 * 1024) /* 1GB */
1058 #define XFS_DFL_RTEXTSIZE (64 * 1024) /* 64kB */
1059 #define XFS_MIN_RTEXTSIZE (4 * 1024) /* 4kB */
1061 #define XFS_BLOCKSIZE(mp) ((mp)->m_sb.sb_blocksize)
1062 #define XFS_BLOCKMASK(mp) ((mp)->m_blockmask)
1063 #define XFS_BLOCKWSIZE(mp) ((mp)->m_blockwsize)
1064 #define XFS_BLOCKWMASK(mp) ((mp)->m_blockwmask)
1067 * RT Summary and bit manipulation macros.
1069 #define XFS_SUMOFFS(mp,ls,bb) ((int)((ls) * (mp)->m_sb.sb_rbmblocks + (bb)))
1070 #define XFS_SUMOFFSTOBLOCK(mp,s) \
1071 (((s) * (uint)sizeof(xfs_suminfo_t)) >> (mp)->m_sb.sb_blocklog)
1072 #define XFS_SUMPTR(mp,bp,so) \
1073 ((xfs_suminfo_t *)((bp)->b_addr + \
1074 (((so) * (uint)sizeof(xfs_suminfo_t)) & XFS_BLOCKMASK(mp))))
1076 #define XFS_BITTOBLOCK(mp,bi) ((bi) >> (mp)->m_blkbit_log)
1077 #define XFS_BLOCKTOBIT(mp,bb) ((bb) << (mp)->m_blkbit_log)
1078 #define XFS_BITTOWORD(mp,bi) \
1079 ((int)(((bi) >> XFS_NBWORDLOG) & XFS_BLOCKWMASK(mp)))
1081 #define XFS_RTMIN(a,b) ((a) < (b) ? (a) : (b))
1082 #define XFS_RTMAX(a,b) ((a) > (b) ? (a) : (b))
1084 #define XFS_RTLOBIT(w) xfs_lowbit32(w)
1085 #define XFS_RTHIBIT(w) xfs_highbit32(w)
1087 #define XFS_RTBLOCKLOG(b) xfs_highbit64(b)
1090 * Dquot and dquot block format definitions
1092 #define XFS_DQUOT_MAGIC 0x4451 /* 'DQ' */
1093 #define XFS_DQUOT_VERSION (u_int8_t)0x01 /* latest version number */
1096 * This is the main portion of the on-disk representation of quota
1097 * information for a user. This is the q_core of the xfs_dquot_t that
1098 * is kept in kernel memory. We pad this with some more expansion room
1099 * to construct the on disk structure.
1101 typedef struct xfs_disk_dquot {
1102 __be16 d_magic; /* dquot magic = XFS_DQUOT_MAGIC */
1103 __u8 d_version; /* dquot version */
1104 __u8 d_flags; /* XFS_DQ_USER/PROJ/GROUP */
1105 __be32 d_id; /* user,project,group id */
1106 __be64 d_blk_hardlimit;/* absolute limit on disk blks */
1107 __be64 d_blk_softlimit;/* preferred limit on disk blks */
1108 __be64 d_ino_hardlimit;/* maximum # allocated inodes */
1109 __be64 d_ino_softlimit;/* preferred inode limit */
1110 __be64 d_bcount; /* disk blocks owned by the user */
1111 __be64 d_icount; /* inodes owned by the user */
1112 __be32 d_itimer; /* zero if within inode limits if not,
1113 this is when we refuse service */
1114 __be32 d_btimer; /* similar to above; for disk blocks */
1115 __be16 d_iwarns; /* warnings issued wrt num inodes */
1116 __be16 d_bwarns; /* warnings issued wrt disk blocks */
1117 __be32 d_pad0; /* 64 bit align */
1118 __be64 d_rtb_hardlimit;/* absolute limit on realtime blks */
1119 __be64 d_rtb_softlimit;/* preferred limit on RT disk blks */
1120 __be64 d_rtbcount; /* realtime blocks owned */
1121 __be32 d_rtbtimer; /* similar to above; for RT disk blocks */
1122 __be16 d_rtbwarns; /* warnings issued wrt RT disk blocks */
1127 * This is what goes on disk. This is separated from the xfs_disk_dquot because
1128 * carrying the unnecessary padding would be a waste of memory.
1130 typedef struct xfs_dqblk {
1131 xfs_disk_dquot_t dd_diskdq; /* portion that lives incore as well */
1132 char dd_fill[4]; /* filling for posterity */
1135 * These two are only present on filesystems with the CRC bits set.
1137 __be32 dd_crc; /* checksum */
1138 __be64 dd_lsn; /* last modification in log */
1139 uuid_t dd_uuid; /* location information */
1142 #define XFS_DQUOT_CRC_OFF offsetof(struct xfs_dqblk, dd_crc)
1145 * Remote symlink format and access functions.
1147 #define XFS_SYMLINK_MAGIC 0x58534c4d /* XSLM */
1149 struct xfs_dsymlink_hdr {
1160 #define XFS_SYMLINK_CRC_OFF offsetof(struct xfs_dsymlink_hdr, sl_crc)
1163 * The maximum pathlen is 1024 bytes. Since the minimum file system
1164 * blocksize is 512 bytes, we can get a max of 3 extents back from
1165 * bmapi when crc headers are taken into account.
1167 #define XFS_SYMLINK_MAPS 3
1169 #define XFS_SYMLINK_BUF_SPACE(mp, bufsize) \
1170 ((bufsize) - (xfs_sb_version_hascrc(&(mp)->m_sb) ? \
1171 sizeof(struct xfs_dsymlink_hdr) : 0))
1175 * Allocation Btree format definitions
1177 * There are two on-disk btrees, one sorted by blockno and one sorted
1178 * by blockcount and blockno. All blocks look the same to make the code
1179 * simpler; if we have time later, we'll make the optimizations.
1181 #define XFS_ABTB_MAGIC 0x41425442 /* 'ABTB' for bno tree */
1182 #define XFS_ABTB_CRC_MAGIC 0x41423342 /* 'AB3B' */
1183 #define XFS_ABTC_MAGIC 0x41425443 /* 'ABTC' for cnt tree */
1184 #define XFS_ABTC_CRC_MAGIC 0x41423343 /* 'AB3C' */
1187 * Data record/key structure
1189 typedef struct xfs_alloc_rec {
1190 __be32 ar_startblock; /* starting block number */
1191 __be32 ar_blockcount; /* count of free blocks */
1192 } xfs_alloc_rec_t, xfs_alloc_key_t;
1194 typedef struct xfs_alloc_rec_incore {
1195 xfs_agblock_t ar_startblock; /* starting block number */
1196 xfs_extlen_t ar_blockcount; /* count of free blocks */
1197 } xfs_alloc_rec_incore_t;
1199 /* btree pointer type */
1200 typedef __be32 xfs_alloc_ptr_t;
1203 * Block numbers in the AG:
1204 * SB is sector 0, AGF is sector 1, AGI is sector 2, AGFL is sector 3.
1206 #define XFS_BNO_BLOCK(mp) ((xfs_agblock_t)(XFS_AGFL_BLOCK(mp) + 1))
1207 #define XFS_CNT_BLOCK(mp) ((xfs_agblock_t)(XFS_BNO_BLOCK(mp) + 1))
1211 * Inode Allocation Btree format definitions
1213 * There is a btree for the inode map per allocation group.
1215 #define XFS_IBT_MAGIC 0x49414254 /* 'IABT' */
1216 #define XFS_IBT_CRC_MAGIC 0x49414233 /* 'IAB3' */
1217 #define XFS_FIBT_MAGIC 0x46494254 /* 'FIBT' */
1218 #define XFS_FIBT_CRC_MAGIC 0x46494233 /* 'FIB3' */
1220 typedef __uint64_t xfs_inofree_t;
1221 #define XFS_INODES_PER_CHUNK (NBBY * sizeof(xfs_inofree_t))
1222 #define XFS_INODES_PER_CHUNK_LOG (XFS_NBBYLOG + 3)
1223 #define XFS_INOBT_ALL_FREE ((xfs_inofree_t)-1)
1224 #define XFS_INOBT_MASK(i) ((xfs_inofree_t)1 << (i))
1226 static inline xfs_inofree_t xfs_inobt_maskn(int i, int n)
1228 return ((n >= XFS_INODES_PER_CHUNK ? 0 : XFS_INOBT_MASK(n)) - 1) << i;
1232 * Data record structure
1234 typedef struct xfs_inobt_rec {
1235 __be32 ir_startino; /* starting inode number */
1236 __be32 ir_freecount; /* count of free inodes (set bits) */
1237 __be64 ir_free; /* free inode mask */
1240 typedef struct xfs_inobt_rec_incore {
1241 xfs_agino_t ir_startino; /* starting inode number */
1242 __int32_t ir_freecount; /* count of free inodes (set bits) */
1243 xfs_inofree_t ir_free; /* free inode mask */
1244 } xfs_inobt_rec_incore_t;
1250 typedef struct xfs_inobt_key {
1251 __be32 ir_startino; /* starting inode number */
1254 /* btree pointer type */
1255 typedef __be32 xfs_inobt_ptr_t;
1258 * block numbers in the AG.
1260 #define XFS_IBT_BLOCK(mp) ((xfs_agblock_t)(XFS_CNT_BLOCK(mp) + 1))
1261 #define XFS_FIBT_BLOCK(mp) ((xfs_agblock_t)(XFS_IBT_BLOCK(mp) + 1))
1264 * The first data block of an AG depends on whether the filesystem was formatted
1265 * with the finobt feature. If so, account for the finobt reserved root btree
1268 #define XFS_PREALLOC_BLOCKS(mp) \
1269 (xfs_sb_version_hasfinobt(&((mp)->m_sb)) ? \
1270 XFS_FIBT_BLOCK(mp) + 1 : \
1271 XFS_IBT_BLOCK(mp) + 1)
1276 * BMAP Btree format definitions
1278 * This includes both the root block definition that sits inside an inode fork
1279 * and the record/pointer formats for the leaf/node in the blocks.
1281 #define XFS_BMAP_MAGIC 0x424d4150 /* 'BMAP' */
1282 #define XFS_BMAP_CRC_MAGIC 0x424d4133 /* 'BMA3' */
1285 * Bmap root header, on-disk form only.
1287 typedef struct xfs_bmdr_block {
1288 __be16 bb_level; /* 0 is a leaf */
1289 __be16 bb_numrecs; /* current # of data records */
1293 * Bmap btree record and extent descriptor.
1294 * l0:63 is an extent flag (value 1 indicates non-normal).
1295 * l0:9-62 are startoff.
1296 * l0:0-8 and l1:21-63 are startblock.
1297 * l1:0-20 are blockcount.
1299 #define BMBT_EXNTFLAG_BITLEN 1
1300 #define BMBT_STARTOFF_BITLEN 54
1301 #define BMBT_STARTBLOCK_BITLEN 52
1302 #define BMBT_BLOCKCOUNT_BITLEN 21
1304 typedef struct xfs_bmbt_rec {
1308 typedef __uint64_t xfs_bmbt_rec_base_t; /* use this for casts */
1309 typedef xfs_bmbt_rec_t xfs_bmdr_rec_t;
1311 typedef struct xfs_bmbt_rec_host {
1313 } xfs_bmbt_rec_host_t;
1316 * Values and macros for delayed-allocation startblock fields.
1318 #define STARTBLOCKVALBITS 17
1319 #define STARTBLOCKMASKBITS (15 + 20)
1320 #define STARTBLOCKMASK \
1321 (((((xfs_fsblock_t)1) << STARTBLOCKMASKBITS) - 1) << STARTBLOCKVALBITS)
1323 static inline int isnullstartblock(xfs_fsblock_t x)
1325 return ((x) & STARTBLOCKMASK) == STARTBLOCKMASK;
1328 static inline xfs_fsblock_t nullstartblock(int k)
1330 ASSERT(k < (1 << STARTBLOCKVALBITS));
1331 return STARTBLOCKMASK | (k);
1334 static inline xfs_filblks_t startblockval(xfs_fsblock_t x)
1336 return (xfs_filblks_t)((x) & ~STARTBLOCKMASK);
1340 * Possible extent formats.
1343 XFS_EXTFMT_NOSTATE = 0,
1348 * Possible extent states.
1351 XFS_EXT_NORM, XFS_EXT_UNWRITTEN,
1352 XFS_EXT_DMAPI_OFFLINE, XFS_EXT_INVALID
1356 * Incore version of above.
1358 typedef struct xfs_bmbt_irec
1360 xfs_fileoff_t br_startoff; /* starting file offset */
1361 xfs_fsblock_t br_startblock; /* starting block number */
1362 xfs_filblks_t br_blockcount; /* number of blocks */
1363 xfs_exntst_t br_state; /* extent state */
1367 * Key structure for non-leaf levels of the tree.
1369 typedef struct xfs_bmbt_key {
1370 __be64 br_startoff; /* starting file offset */
1371 } xfs_bmbt_key_t, xfs_bmdr_key_t;
1373 /* btree pointer type */
1374 typedef __be64 xfs_bmbt_ptr_t, xfs_bmdr_ptr_t;
1378 * Generic Btree block format definitions
1380 * This is a combination of the actual format used on disk for short and long
1381 * format btrees. The first three fields are shared by both format, but the
1382 * pointers are different and should be used with care.
1384 * To get the size of the actual short or long form headers please use the size
1385 * macros below. Never use sizeof(xfs_btree_block).
1387 * The blkno, crc, lsn, owner and uuid fields are only available in filesystems
1388 * with the crc feature bit, and all accesses to them must be conditional on
1391 struct xfs_btree_block {
1392 __be32 bb_magic; /* magic number for block type */
1393 __be16 bb_level; /* 0 is a leaf */
1394 __be16 bb_numrecs; /* current # of data records */
1405 } s; /* short form pointers */
1415 __be32 bb_pad; /* padding for alignment */
1416 } l; /* long form pointers */
1420 #define XFS_BTREE_SBLOCK_LEN 16 /* size of a short form block */
1421 #define XFS_BTREE_LBLOCK_LEN 24 /* size of a long form block */
1423 /* sizes of CRC enabled btree blocks */
1424 #define XFS_BTREE_SBLOCK_CRC_LEN (XFS_BTREE_SBLOCK_LEN + 40)
1425 #define XFS_BTREE_LBLOCK_CRC_LEN (XFS_BTREE_LBLOCK_LEN + 48)
1427 #define XFS_BTREE_SBLOCK_CRC_OFF \
1428 offsetof(struct xfs_btree_block, bb_u.s.bb_crc)
1429 #define XFS_BTREE_LBLOCK_CRC_OFF \
1430 offsetof(struct xfs_btree_block, bb_u.l.bb_crc)
1433 * On-disk XFS access control list structure.
1435 struct xfs_acl_entry {
1439 __be16 ae_pad; /* fill the implicit hole in the structure */
1444 struct xfs_acl_entry acl_entry[0];
1448 * The number of ACL entries allowed is defined by the on-disk format.
1449 * For v4 superblocks, that is limited to 25 entries. For v5 superblocks, it is
1450 * limited only by the maximum size of the xattr that stores the information.
1452 #define XFS_ACL_MAX_ENTRIES(mp) \
1453 (xfs_sb_version_hascrc(&mp->m_sb) \
1454 ? (XATTR_SIZE_MAX - sizeof(struct xfs_acl)) / \
1455 sizeof(struct xfs_acl_entry) \
1458 #define XFS_ACL_MAX_SIZE(mp) \
1459 (sizeof(struct xfs_acl) + \
1460 sizeof(struct xfs_acl_entry) * XFS_ACL_MAX_ENTRIES((mp)))
1462 /* On-disk XFS extended attribute names */
1463 #define SGI_ACL_FILE (unsigned char *)"SGI_ACL_FILE"
1464 #define SGI_ACL_DEFAULT (unsigned char *)"SGI_ACL_DEFAULT"
1465 #define SGI_ACL_FILE_SIZE (sizeof(SGI_ACL_FILE)-1)
1466 #define SGI_ACL_DEFAULT_SIZE (sizeof(SGI_ACL_DEFAULT)-1)
1468 #endif /* __XFS_FORMAT_H__ */