mm: fix exec activate_mm vs TLB shootdown and lazy tlb switching race
[linux/fpc-iii.git] / fs / xfs / libxfs / xfs_format.h
blobed4481b2f1131f5c2259420367ca5a85757e6bbd
1 /*
2 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
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.
30 struct xfs_mount;
31 struct xfs_trans;
32 struct xfs_inode;
33 struct xfs_buf;
34 struct xfs_ifork;
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.
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 * The size of a single extended attribute on disk is limited by
64 * the size of index values within the attribute entries themselves.
65 * These are be16 fields, so we can only support attribute data
66 * sizes up to 2^16 bytes in length.
68 #define XFS_XATTR_SIZE_MAX (1 << 16)
71 * Supported feature bit list is just all bits in the versionnum field because
72 * we've used them all up and understand them all. Except, of course, for the
73 * shared superblock bit, which nobody knows what it does and so is unsupported.
75 #define XFS_SB_VERSION_OKBITS \
76 ((XFS_SB_VERSION_NUMBITS | XFS_SB_VERSION_ALLFBITS) & \
77 ~XFS_SB_VERSION_SHAREDBIT)
80 * There are two words to hold XFS "feature" bits: the original
81 * word, sb_versionnum, and sb_features2. Whenever a bit is set in
82 * sb_features2, the feature bit XFS_SB_VERSION_MOREBITSBIT must be set.
84 * These defines represent bits in sb_features2.
86 #define XFS_SB_VERSION2_RESERVED1BIT 0x00000001
87 #define XFS_SB_VERSION2_LAZYSBCOUNTBIT 0x00000002 /* Superblk counters */
88 #define XFS_SB_VERSION2_RESERVED4BIT 0x00000004
89 #define XFS_SB_VERSION2_ATTR2BIT 0x00000008 /* Inline attr rework */
90 #define XFS_SB_VERSION2_PARENTBIT 0x00000010 /* parent pointers */
91 #define XFS_SB_VERSION2_PROJID32BIT 0x00000080 /* 32 bit project id */
92 #define XFS_SB_VERSION2_CRCBIT 0x00000100 /* metadata CRCs */
93 #define XFS_SB_VERSION2_FTYPE 0x00000200 /* inode type in dir */
95 #define XFS_SB_VERSION2_OKBITS \
96 (XFS_SB_VERSION2_LAZYSBCOUNTBIT | \
97 XFS_SB_VERSION2_ATTR2BIT | \
98 XFS_SB_VERSION2_PROJID32BIT | \
99 XFS_SB_VERSION2_FTYPE)
102 * Superblock - in core version. Must match the ondisk version below.
103 * Must be padded to 64 bit alignment.
105 typedef struct xfs_sb {
106 uint32_t sb_magicnum; /* magic number == XFS_SB_MAGIC */
107 uint32_t sb_blocksize; /* logical block size, bytes */
108 xfs_rfsblock_t sb_dblocks; /* number of data blocks */
109 xfs_rfsblock_t sb_rblocks; /* number of realtime blocks */
110 xfs_rtblock_t sb_rextents; /* number of realtime extents */
111 uuid_t sb_uuid; /* user-visible file system unique id */
112 xfs_fsblock_t sb_logstart; /* starting block of log if internal */
113 xfs_ino_t sb_rootino; /* root inode number */
114 xfs_ino_t sb_rbmino; /* bitmap inode for realtime extents */
115 xfs_ino_t sb_rsumino; /* summary inode for rt bitmap */
116 xfs_agblock_t sb_rextsize; /* realtime extent size, blocks */
117 xfs_agblock_t sb_agblocks; /* size of an allocation group */
118 xfs_agnumber_t sb_agcount; /* number of allocation groups */
119 xfs_extlen_t sb_rbmblocks; /* number of rt bitmap blocks */
120 xfs_extlen_t sb_logblocks; /* number of log blocks */
121 uint16_t sb_versionnum; /* header version == XFS_SB_VERSION */
122 uint16_t sb_sectsize; /* volume sector size, bytes */
123 uint16_t sb_inodesize; /* inode size, bytes */
124 uint16_t sb_inopblock; /* inodes per block */
125 char sb_fname[12]; /* file system name */
126 uint8_t sb_blocklog; /* log2 of sb_blocksize */
127 uint8_t sb_sectlog; /* log2 of sb_sectsize */
128 uint8_t sb_inodelog; /* log2 of sb_inodesize */
129 uint8_t sb_inopblog; /* log2 of sb_inopblock */
130 uint8_t sb_agblklog; /* log2 of sb_agblocks (rounded up) */
131 uint8_t sb_rextslog; /* log2 of sb_rextents */
132 uint8_t sb_inprogress; /* mkfs is in progress, don't mount */
133 uint8_t sb_imax_pct; /* max % of fs for inode space */
134 /* statistics */
136 * These fields must remain contiguous. If you really
137 * want to change their layout, make sure you fix the
138 * code in xfs_trans_apply_sb_deltas().
140 uint64_t sb_icount; /* allocated inodes */
141 uint64_t sb_ifree; /* free inodes */
142 uint64_t sb_fdblocks; /* free data blocks */
143 uint64_t sb_frextents; /* free realtime extents */
145 * End contiguous fields.
147 xfs_ino_t sb_uquotino; /* user quota inode */
148 xfs_ino_t sb_gquotino; /* group quota inode */
149 uint16_t sb_qflags; /* quota flags */
150 uint8_t sb_flags; /* misc. flags */
151 uint8_t sb_shared_vn; /* shared version number */
152 xfs_extlen_t sb_inoalignmt; /* inode chunk alignment, fsblocks */
153 uint32_t sb_unit; /* stripe or raid unit */
154 uint32_t sb_width; /* stripe or raid width */
155 uint8_t sb_dirblklog; /* log2 of dir block size (fsbs) */
156 uint8_t sb_logsectlog; /* log2 of the log sector size */
157 uint16_t sb_logsectsize; /* sector size for the log, bytes */
158 uint32_t sb_logsunit; /* stripe unit size for the log */
159 uint32_t sb_features2; /* additional feature bits */
162 * bad features2 field as a result of failing to pad the sb structure to
163 * 64 bits. Some machines will be using this field for features2 bits.
164 * Easiest just to mark it bad and not use it for anything else.
166 * This is not kept up to date in memory; it is always overwritten by
167 * the value in sb_features2 when formatting the incore superblock to
168 * the disk buffer.
170 uint32_t sb_bad_features2;
172 /* version 5 superblock fields start here */
174 /* feature masks */
175 uint32_t sb_features_compat;
176 uint32_t sb_features_ro_compat;
177 uint32_t sb_features_incompat;
178 uint32_t sb_features_log_incompat;
180 uint32_t sb_crc; /* superblock crc */
181 xfs_extlen_t sb_spino_align; /* sparse inode chunk alignment */
183 xfs_ino_t sb_pquotino; /* project quota inode */
184 xfs_lsn_t sb_lsn; /* last write sequence */
185 uuid_t sb_meta_uuid; /* metadata file system unique id */
187 /* must be padded to 64 bit alignment */
188 } xfs_sb_t;
190 #define XFS_SB_CRC_OFF offsetof(struct xfs_sb, sb_crc)
193 * Superblock - on disk version. Must match the in core version above.
194 * Must be padded to 64 bit alignment.
196 typedef struct xfs_dsb {
197 __be32 sb_magicnum; /* magic number == XFS_SB_MAGIC */
198 __be32 sb_blocksize; /* logical block size, bytes */
199 __be64 sb_dblocks; /* number of data blocks */
200 __be64 sb_rblocks; /* number of realtime blocks */
201 __be64 sb_rextents; /* number of realtime extents */
202 uuid_t sb_uuid; /* user-visible file system unique id */
203 __be64 sb_logstart; /* starting block of log if internal */
204 __be64 sb_rootino; /* root inode number */
205 __be64 sb_rbmino; /* bitmap inode for realtime extents */
206 __be64 sb_rsumino; /* summary inode for rt bitmap */
207 __be32 sb_rextsize; /* realtime extent size, blocks */
208 __be32 sb_agblocks; /* size of an allocation group */
209 __be32 sb_agcount; /* number of allocation groups */
210 __be32 sb_rbmblocks; /* number of rt bitmap blocks */
211 __be32 sb_logblocks; /* number of log blocks */
212 __be16 sb_versionnum; /* header version == XFS_SB_VERSION */
213 __be16 sb_sectsize; /* volume sector size, bytes */
214 __be16 sb_inodesize; /* inode size, bytes */
215 __be16 sb_inopblock; /* inodes per block */
216 char sb_fname[12]; /* file system name */
217 __u8 sb_blocklog; /* log2 of sb_blocksize */
218 __u8 sb_sectlog; /* log2 of sb_sectsize */
219 __u8 sb_inodelog; /* log2 of sb_inodesize */
220 __u8 sb_inopblog; /* log2 of sb_inopblock */
221 __u8 sb_agblklog; /* log2 of sb_agblocks (rounded up) */
222 __u8 sb_rextslog; /* log2 of sb_rextents */
223 __u8 sb_inprogress; /* mkfs is in progress, don't mount */
224 __u8 sb_imax_pct; /* max % of fs for inode space */
225 /* statistics */
227 * These fields must remain contiguous. If you really
228 * want to change their layout, make sure you fix the
229 * code in xfs_trans_apply_sb_deltas().
231 __be64 sb_icount; /* allocated inodes */
232 __be64 sb_ifree; /* free inodes */
233 __be64 sb_fdblocks; /* free data blocks */
234 __be64 sb_frextents; /* free realtime extents */
236 * End contiguous fields.
238 __be64 sb_uquotino; /* user quota inode */
239 __be64 sb_gquotino; /* group quota inode */
240 __be16 sb_qflags; /* quota flags */
241 __u8 sb_flags; /* misc. flags */
242 __u8 sb_shared_vn; /* shared version number */
243 __be32 sb_inoalignmt; /* inode chunk alignment, fsblocks */
244 __be32 sb_unit; /* stripe or raid unit */
245 __be32 sb_width; /* stripe or raid width */
246 __u8 sb_dirblklog; /* log2 of dir block size (fsbs) */
247 __u8 sb_logsectlog; /* log2 of the log sector size */
248 __be16 sb_logsectsize; /* sector size for the log, bytes */
249 __be32 sb_logsunit; /* stripe unit size for the log */
250 __be32 sb_features2; /* additional feature bits */
252 * bad features2 field as a result of failing to pad the sb
253 * structure to 64 bits. Some machines will be using this field
254 * for features2 bits. Easiest just to mark it bad and not use
255 * it for anything else.
257 __be32 sb_bad_features2;
259 /* version 5 superblock fields start here */
261 /* feature masks */
262 __be32 sb_features_compat;
263 __be32 sb_features_ro_compat;
264 __be32 sb_features_incompat;
265 __be32 sb_features_log_incompat;
267 __le32 sb_crc; /* superblock crc */
268 __be32 sb_spino_align; /* sparse inode chunk alignment */
270 __be64 sb_pquotino; /* project quota inode */
271 __be64 sb_lsn; /* last write sequence */
272 uuid_t sb_meta_uuid; /* metadata file system unique id */
274 /* must be padded to 64 bit alignment */
275 } xfs_dsb_t;
279 * Misc. Flags - warning - these will be cleared by xfs_repair unless
280 * a feature bit is set when the flag is used.
282 #define XFS_SBF_NOFLAGS 0x00 /* no flags set */
283 #define XFS_SBF_READONLY 0x01 /* only read-only mounts allowed */
286 * define max. shared version we can interoperate with
288 #define XFS_SB_MAX_SHARED_VN 0
290 #define XFS_SB_VERSION_NUM(sbp) ((sbp)->sb_versionnum & XFS_SB_VERSION_NUMBITS)
293 * The first XFS version we support is a v4 superblock with V2 directories.
295 static inline bool xfs_sb_good_v4_features(struct xfs_sb *sbp)
297 if (!(sbp->sb_versionnum & XFS_SB_VERSION_DIRV2BIT))
298 return false;
300 /* check for unknown features in the fs */
301 if ((sbp->sb_versionnum & ~XFS_SB_VERSION_OKBITS) ||
302 ((sbp->sb_versionnum & XFS_SB_VERSION_MOREBITSBIT) &&
303 (sbp->sb_features2 & ~XFS_SB_VERSION2_OKBITS)))
304 return false;
306 return true;
309 static inline bool xfs_sb_good_version(struct xfs_sb *sbp)
311 if (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5)
312 return true;
313 if (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4)
314 return xfs_sb_good_v4_features(sbp);
315 return false;
319 * Detect a mismatched features2 field. Older kernels read/wrote
320 * this into the wrong slot, so to be safe we keep them in sync.
322 static inline bool xfs_sb_has_mismatched_features2(struct xfs_sb *sbp)
324 return sbp->sb_bad_features2 != sbp->sb_features2;
327 static inline bool xfs_sb_version_hasattr(struct xfs_sb *sbp)
329 return (sbp->sb_versionnum & XFS_SB_VERSION_ATTRBIT);
332 static inline void xfs_sb_version_addattr(struct xfs_sb *sbp)
334 sbp->sb_versionnum |= XFS_SB_VERSION_ATTRBIT;
337 static inline bool xfs_sb_version_hasquota(struct xfs_sb *sbp)
339 return (sbp->sb_versionnum & XFS_SB_VERSION_QUOTABIT);
342 static inline void xfs_sb_version_addquota(struct xfs_sb *sbp)
344 sbp->sb_versionnum |= XFS_SB_VERSION_QUOTABIT;
347 static inline bool xfs_sb_version_hasalign(struct xfs_sb *sbp)
349 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 ||
350 (sbp->sb_versionnum & XFS_SB_VERSION_ALIGNBIT));
353 static inline bool xfs_sb_version_hasdalign(struct xfs_sb *sbp)
355 return (sbp->sb_versionnum & XFS_SB_VERSION_DALIGNBIT);
358 static inline bool xfs_sb_version_haslogv2(struct xfs_sb *sbp)
360 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 ||
361 (sbp->sb_versionnum & XFS_SB_VERSION_LOGV2BIT);
364 static inline bool xfs_sb_version_hasextflgbit(struct xfs_sb *sbp)
366 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 ||
367 (sbp->sb_versionnum & XFS_SB_VERSION_EXTFLGBIT);
370 static inline bool xfs_sb_version_hassector(struct xfs_sb *sbp)
372 return (sbp->sb_versionnum & XFS_SB_VERSION_SECTORBIT);
375 static inline bool xfs_sb_version_hasasciici(struct xfs_sb *sbp)
377 return (sbp->sb_versionnum & XFS_SB_VERSION_BORGBIT);
380 static inline bool xfs_sb_version_hasmorebits(struct xfs_sb *sbp)
382 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 ||
383 (sbp->sb_versionnum & XFS_SB_VERSION_MOREBITSBIT);
387 * sb_features2 bit version macros.
389 static inline bool xfs_sb_version_haslazysbcount(struct xfs_sb *sbp)
391 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) ||
392 (xfs_sb_version_hasmorebits(sbp) &&
393 (sbp->sb_features2 & XFS_SB_VERSION2_LAZYSBCOUNTBIT));
396 static inline bool xfs_sb_version_hasattr2(struct xfs_sb *sbp)
398 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) ||
399 (xfs_sb_version_hasmorebits(sbp) &&
400 (sbp->sb_features2 & XFS_SB_VERSION2_ATTR2BIT));
403 static inline void xfs_sb_version_addattr2(struct xfs_sb *sbp)
405 sbp->sb_versionnum |= XFS_SB_VERSION_MOREBITSBIT;
406 sbp->sb_features2 |= XFS_SB_VERSION2_ATTR2BIT;
409 static inline void xfs_sb_version_removeattr2(struct xfs_sb *sbp)
411 sbp->sb_features2 &= ~XFS_SB_VERSION2_ATTR2BIT;
412 if (!sbp->sb_features2)
413 sbp->sb_versionnum &= ~XFS_SB_VERSION_MOREBITSBIT;
416 static inline bool xfs_sb_version_hasprojid32bit(struct xfs_sb *sbp)
418 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) ||
419 (xfs_sb_version_hasmorebits(sbp) &&
420 (sbp->sb_features2 & XFS_SB_VERSION2_PROJID32BIT));
423 static inline void xfs_sb_version_addprojid32bit(struct xfs_sb *sbp)
425 sbp->sb_versionnum |= XFS_SB_VERSION_MOREBITSBIT;
426 sbp->sb_features2 |= XFS_SB_VERSION2_PROJID32BIT;
430 * Extended v5 superblock feature masks. These are to be used for new v5
431 * superblock features only.
433 * Compat features are new features that old kernels will not notice or affect
434 * and so can mount read-write without issues.
436 * RO-Compat (read only) are features that old kernels can read but will break
437 * if they write. Hence only read-only mounts of such filesystems are allowed on
438 * kernels that don't support the feature bit.
440 * InCompat features are features which old kernels will not understand and so
441 * must not mount.
443 * Log-InCompat features are for changes to log formats or new transactions that
444 * can't be replayed on older kernels. The fields are set when the filesystem is
445 * mounted, and a clean unmount clears the fields.
447 #define XFS_SB_FEAT_COMPAT_ALL 0
448 #define XFS_SB_FEAT_COMPAT_UNKNOWN ~XFS_SB_FEAT_COMPAT_ALL
449 static inline bool
450 xfs_sb_has_compat_feature(
451 struct xfs_sb *sbp,
452 uint32_t feature)
454 return (sbp->sb_features_compat & feature) != 0;
457 #define XFS_SB_FEAT_RO_COMPAT_FINOBT (1 << 0) /* free inode btree */
458 #define XFS_SB_FEAT_RO_COMPAT_RMAPBT (1 << 1) /* reverse map btree */
459 #define XFS_SB_FEAT_RO_COMPAT_REFLINK (1 << 2) /* reflinked files */
460 #define XFS_SB_FEAT_RO_COMPAT_ALL \
461 (XFS_SB_FEAT_RO_COMPAT_FINOBT | \
462 XFS_SB_FEAT_RO_COMPAT_RMAPBT | \
463 XFS_SB_FEAT_RO_COMPAT_REFLINK)
464 #define XFS_SB_FEAT_RO_COMPAT_UNKNOWN ~XFS_SB_FEAT_RO_COMPAT_ALL
465 static inline bool
466 xfs_sb_has_ro_compat_feature(
467 struct xfs_sb *sbp,
468 uint32_t feature)
470 return (sbp->sb_features_ro_compat & feature) != 0;
473 #define XFS_SB_FEAT_INCOMPAT_FTYPE (1 << 0) /* filetype in dirent */
474 #define XFS_SB_FEAT_INCOMPAT_SPINODES (1 << 1) /* sparse inode chunks */
475 #define XFS_SB_FEAT_INCOMPAT_META_UUID (1 << 2) /* metadata UUID */
476 #define XFS_SB_FEAT_INCOMPAT_ALL \
477 (XFS_SB_FEAT_INCOMPAT_FTYPE| \
478 XFS_SB_FEAT_INCOMPAT_SPINODES| \
479 XFS_SB_FEAT_INCOMPAT_META_UUID)
481 #define XFS_SB_FEAT_INCOMPAT_UNKNOWN ~XFS_SB_FEAT_INCOMPAT_ALL
482 static inline bool
483 xfs_sb_has_incompat_feature(
484 struct xfs_sb *sbp,
485 uint32_t feature)
487 return (sbp->sb_features_incompat & feature) != 0;
490 #define XFS_SB_FEAT_INCOMPAT_LOG_ALL 0
491 #define XFS_SB_FEAT_INCOMPAT_LOG_UNKNOWN ~XFS_SB_FEAT_INCOMPAT_LOG_ALL
492 static inline bool
493 xfs_sb_has_incompat_log_feature(
494 struct xfs_sb *sbp,
495 uint32_t feature)
497 return (sbp->sb_features_log_incompat & feature) != 0;
501 * V5 superblock specific feature checks
503 static inline int xfs_sb_version_hascrc(struct xfs_sb *sbp)
505 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5;
508 static inline int xfs_sb_version_has_pquotino(struct xfs_sb *sbp)
510 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5;
513 static inline int xfs_sb_version_hasftype(struct xfs_sb *sbp)
515 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 &&
516 xfs_sb_has_incompat_feature(sbp, XFS_SB_FEAT_INCOMPAT_FTYPE)) ||
517 (xfs_sb_version_hasmorebits(sbp) &&
518 (sbp->sb_features2 & XFS_SB_VERSION2_FTYPE));
521 static inline int xfs_sb_version_hasfinobt(xfs_sb_t *sbp)
523 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) &&
524 (sbp->sb_features_ro_compat & XFS_SB_FEAT_RO_COMPAT_FINOBT);
527 static inline bool xfs_sb_version_hassparseinodes(struct xfs_sb *sbp)
529 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 &&
530 xfs_sb_has_incompat_feature(sbp, XFS_SB_FEAT_INCOMPAT_SPINODES);
534 * XFS_SB_FEAT_INCOMPAT_META_UUID indicates that the metadata UUID
535 * is stored separately from the user-visible UUID; this allows the
536 * user-visible UUID to be changed on V5 filesystems which have a
537 * filesystem UUID stamped into every piece of metadata.
539 static inline bool xfs_sb_version_hasmetauuid(struct xfs_sb *sbp)
541 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) &&
542 (sbp->sb_features_incompat & XFS_SB_FEAT_INCOMPAT_META_UUID);
545 static inline bool xfs_sb_version_hasrmapbt(struct xfs_sb *sbp)
547 return (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5) &&
548 (sbp->sb_features_ro_compat & XFS_SB_FEAT_RO_COMPAT_RMAPBT);
551 static inline bool xfs_sb_version_hasreflink(struct xfs_sb *sbp)
553 return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_5 &&
554 (sbp->sb_features_ro_compat & XFS_SB_FEAT_RO_COMPAT_REFLINK);
558 * end of superblock version macros
561 static inline bool
562 xfs_is_quota_inode(struct xfs_sb *sbp, xfs_ino_t ino)
564 return (ino == sbp->sb_uquotino ||
565 ino == sbp->sb_gquotino ||
566 ino == sbp->sb_pquotino);
569 #define XFS_SB_DADDR ((xfs_daddr_t)0) /* daddr in filesystem/ag */
570 #define XFS_SB_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_SB_DADDR)
571 #define XFS_BUF_TO_SBP(bp) ((xfs_dsb_t *)((bp)->b_addr))
573 #define XFS_HDR_BLOCK(mp,d) ((xfs_agblock_t)XFS_BB_TO_FSBT(mp,d))
574 #define XFS_DADDR_TO_FSB(mp,d) XFS_AGB_TO_FSB(mp, \
575 xfs_daddr_to_agno(mp,d), xfs_daddr_to_agbno(mp,d))
576 #define XFS_FSB_TO_DADDR(mp,fsbno) XFS_AGB_TO_DADDR(mp, \
577 XFS_FSB_TO_AGNO(mp,fsbno), XFS_FSB_TO_AGBNO(mp,fsbno))
580 * File system sector to basic block conversions.
582 #define XFS_FSS_TO_BB(mp,sec) ((sec) << (mp)->m_sectbb_log)
585 * File system block to basic block conversions.
587 #define XFS_FSB_TO_BB(mp,fsbno) ((fsbno) << (mp)->m_blkbb_log)
588 #define XFS_BB_TO_FSB(mp,bb) \
589 (((bb) + (XFS_FSB_TO_BB(mp,1) - 1)) >> (mp)->m_blkbb_log)
590 #define XFS_BB_TO_FSBT(mp,bb) ((bb) >> (mp)->m_blkbb_log)
593 * File system block to byte conversions.
595 #define XFS_FSB_TO_B(mp,fsbno) ((xfs_fsize_t)(fsbno) << (mp)->m_sb.sb_blocklog)
596 #define XFS_B_TO_FSB(mp,b) \
597 ((((uint64_t)(b)) + (mp)->m_blockmask) >> (mp)->m_sb.sb_blocklog)
598 #define XFS_B_TO_FSBT(mp,b) (((uint64_t)(b)) >> (mp)->m_sb.sb_blocklog)
599 #define XFS_B_FSB_OFFSET(mp,b) ((b) & (mp)->m_blockmask)
602 * Allocation group header
604 * This is divided into three structures, placed in sequential 512-byte
605 * buffers after a copy of the superblock (also in a 512-byte buffer).
607 #define XFS_AGF_MAGIC 0x58414746 /* 'XAGF' */
608 #define XFS_AGI_MAGIC 0x58414749 /* 'XAGI' */
609 #define XFS_AGFL_MAGIC 0x5841464c /* 'XAFL' */
610 #define XFS_AGF_VERSION 1
611 #define XFS_AGI_VERSION 1
613 #define XFS_AGF_GOOD_VERSION(v) ((v) == XFS_AGF_VERSION)
614 #define XFS_AGI_GOOD_VERSION(v) ((v) == XFS_AGI_VERSION)
617 * Btree number 0 is bno, 1 is cnt, 2 is rmap. This value gives the size of the
618 * arrays below.
620 #define XFS_BTNUM_AGF ((int)XFS_BTNUM_RMAPi + 1)
623 * The second word of agf_levels in the first a.g. overlaps the EFS
624 * superblock's magic number. Since the magic numbers valid for EFS
625 * are > 64k, our value cannot be confused for an EFS superblock's.
628 typedef struct xfs_agf {
630 * Common allocation group header information
632 __be32 agf_magicnum; /* magic number == XFS_AGF_MAGIC */
633 __be32 agf_versionnum; /* header version == XFS_AGF_VERSION */
634 __be32 agf_seqno; /* sequence # starting from 0 */
635 __be32 agf_length; /* size in blocks of a.g. */
637 * Freespace and rmap information
639 __be32 agf_roots[XFS_BTNUM_AGF]; /* root blocks */
640 __be32 agf_levels[XFS_BTNUM_AGF]; /* btree levels */
642 __be32 agf_flfirst; /* first freelist block's index */
643 __be32 agf_fllast; /* last freelist block's index */
644 __be32 agf_flcount; /* count of blocks in freelist */
645 __be32 agf_freeblks; /* total free blocks */
647 __be32 agf_longest; /* longest free space */
648 __be32 agf_btreeblks; /* # of blocks held in AGF btrees */
649 uuid_t agf_uuid; /* uuid of filesystem */
651 __be32 agf_rmap_blocks; /* rmapbt blocks used */
652 __be32 agf_refcount_blocks; /* refcountbt blocks used */
654 __be32 agf_refcount_root; /* refcount tree root block */
655 __be32 agf_refcount_level; /* refcount btree levels */
658 * reserve some contiguous space for future logged fields before we add
659 * the unlogged fields. This makes the range logging via flags and
660 * structure offsets much simpler.
662 __be64 agf_spare64[14];
664 /* unlogged fields, written during buffer writeback. */
665 __be64 agf_lsn; /* last write sequence */
666 __be32 agf_crc; /* crc of agf sector */
667 __be32 agf_spare2;
669 /* structure must be padded to 64 bit alignment */
670 } xfs_agf_t;
672 #define XFS_AGF_CRC_OFF offsetof(struct xfs_agf, agf_crc)
674 #define XFS_AGF_MAGICNUM 0x00000001
675 #define XFS_AGF_VERSIONNUM 0x00000002
676 #define XFS_AGF_SEQNO 0x00000004
677 #define XFS_AGF_LENGTH 0x00000008
678 #define XFS_AGF_ROOTS 0x00000010
679 #define XFS_AGF_LEVELS 0x00000020
680 #define XFS_AGF_FLFIRST 0x00000040
681 #define XFS_AGF_FLLAST 0x00000080
682 #define XFS_AGF_FLCOUNT 0x00000100
683 #define XFS_AGF_FREEBLKS 0x00000200
684 #define XFS_AGF_LONGEST 0x00000400
685 #define XFS_AGF_BTREEBLKS 0x00000800
686 #define XFS_AGF_UUID 0x00001000
687 #define XFS_AGF_RMAP_BLOCKS 0x00002000
688 #define XFS_AGF_REFCOUNT_BLOCKS 0x00004000
689 #define XFS_AGF_REFCOUNT_ROOT 0x00008000
690 #define XFS_AGF_REFCOUNT_LEVEL 0x00010000
691 #define XFS_AGF_SPARE64 0x00020000
692 #define XFS_AGF_NUM_BITS 18
693 #define XFS_AGF_ALL_BITS ((1 << XFS_AGF_NUM_BITS) - 1)
695 #define XFS_AGF_FLAGS \
696 { XFS_AGF_MAGICNUM, "MAGICNUM" }, \
697 { XFS_AGF_VERSIONNUM, "VERSIONNUM" }, \
698 { XFS_AGF_SEQNO, "SEQNO" }, \
699 { XFS_AGF_LENGTH, "LENGTH" }, \
700 { XFS_AGF_ROOTS, "ROOTS" }, \
701 { XFS_AGF_LEVELS, "LEVELS" }, \
702 { XFS_AGF_FLFIRST, "FLFIRST" }, \
703 { XFS_AGF_FLLAST, "FLLAST" }, \
704 { XFS_AGF_FLCOUNT, "FLCOUNT" }, \
705 { XFS_AGF_FREEBLKS, "FREEBLKS" }, \
706 { XFS_AGF_LONGEST, "LONGEST" }, \
707 { XFS_AGF_BTREEBLKS, "BTREEBLKS" }, \
708 { XFS_AGF_UUID, "UUID" }, \
709 { XFS_AGF_RMAP_BLOCKS, "RMAP_BLOCKS" }, \
710 { XFS_AGF_REFCOUNT_BLOCKS, "REFCOUNT_BLOCKS" }, \
711 { XFS_AGF_REFCOUNT_ROOT, "REFCOUNT_ROOT" }, \
712 { XFS_AGF_REFCOUNT_LEVEL, "REFCOUNT_LEVEL" }, \
713 { XFS_AGF_SPARE64, "SPARE64" }
715 /* disk block (xfs_daddr_t) in the AG */
716 #define XFS_AGF_DADDR(mp) ((xfs_daddr_t)(1 << (mp)->m_sectbb_log))
717 #define XFS_AGF_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGF_DADDR(mp))
718 #define XFS_BUF_TO_AGF(bp) ((xfs_agf_t *)((bp)->b_addr))
721 * Size of the unlinked inode hash table in the agi.
723 #define XFS_AGI_UNLINKED_BUCKETS 64
725 typedef struct xfs_agi {
727 * Common allocation group header information
729 __be32 agi_magicnum; /* magic number == XFS_AGI_MAGIC */
730 __be32 agi_versionnum; /* header version == XFS_AGI_VERSION */
731 __be32 agi_seqno; /* sequence # starting from 0 */
732 __be32 agi_length; /* size in blocks of a.g. */
734 * Inode information
735 * Inodes are mapped by interpreting the inode number, so no
736 * mapping data is needed here.
738 __be32 agi_count; /* count of allocated inodes */
739 __be32 agi_root; /* root of inode btree */
740 __be32 agi_level; /* levels in inode btree */
741 __be32 agi_freecount; /* number of free inodes */
743 __be32 agi_newino; /* new inode just allocated */
744 __be32 agi_dirino; /* last directory inode chunk */
746 * Hash table of inodes which have been unlinked but are
747 * still being referenced.
749 __be32 agi_unlinked[XFS_AGI_UNLINKED_BUCKETS];
751 * This marks the end of logging region 1 and start of logging region 2.
753 uuid_t agi_uuid; /* uuid of filesystem */
754 __be32 agi_crc; /* crc of agi sector */
755 __be32 agi_pad32;
756 __be64 agi_lsn; /* last write sequence */
758 __be32 agi_free_root; /* root of the free inode btree */
759 __be32 agi_free_level;/* levels in free inode btree */
761 /* structure must be padded to 64 bit alignment */
762 } xfs_agi_t;
764 #define XFS_AGI_CRC_OFF offsetof(struct xfs_agi, agi_crc)
766 #define XFS_AGI_MAGICNUM (1 << 0)
767 #define XFS_AGI_VERSIONNUM (1 << 1)
768 #define XFS_AGI_SEQNO (1 << 2)
769 #define XFS_AGI_LENGTH (1 << 3)
770 #define XFS_AGI_COUNT (1 << 4)
771 #define XFS_AGI_ROOT (1 << 5)
772 #define XFS_AGI_LEVEL (1 << 6)
773 #define XFS_AGI_FREECOUNT (1 << 7)
774 #define XFS_AGI_NEWINO (1 << 8)
775 #define XFS_AGI_DIRINO (1 << 9)
776 #define XFS_AGI_UNLINKED (1 << 10)
777 #define XFS_AGI_NUM_BITS_R1 11 /* end of the 1st agi logging region */
778 #define XFS_AGI_ALL_BITS_R1 ((1 << XFS_AGI_NUM_BITS_R1) - 1)
779 #define XFS_AGI_FREE_ROOT (1 << 11)
780 #define XFS_AGI_FREE_LEVEL (1 << 12)
781 #define XFS_AGI_NUM_BITS_R2 13
783 /* disk block (xfs_daddr_t) in the AG */
784 #define XFS_AGI_DADDR(mp) ((xfs_daddr_t)(2 << (mp)->m_sectbb_log))
785 #define XFS_AGI_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGI_DADDR(mp))
786 #define XFS_BUF_TO_AGI(bp) ((xfs_agi_t *)((bp)->b_addr))
789 * The third a.g. block contains the a.g. freelist, an array
790 * of block pointers to blocks owned by the allocation btree code.
792 #define XFS_AGFL_DADDR(mp) ((xfs_daddr_t)(3 << (mp)->m_sectbb_log))
793 #define XFS_AGFL_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGFL_DADDR(mp))
794 #define XFS_BUF_TO_AGFL(bp) ((xfs_agfl_t *)((bp)->b_addr))
796 #define XFS_BUF_TO_AGFL_BNO(mp, bp) \
797 (xfs_sb_version_hascrc(&((mp)->m_sb)) ? \
798 &(XFS_BUF_TO_AGFL(bp)->agfl_bno[0]) : \
799 (__be32 *)(bp)->b_addr)
801 typedef struct xfs_agfl {
802 __be32 agfl_magicnum;
803 __be32 agfl_seqno;
804 uuid_t agfl_uuid;
805 __be64 agfl_lsn;
806 __be32 agfl_crc;
807 __be32 agfl_bno[]; /* actually xfs_agfl_size(mp) */
808 } __attribute__((packed)) xfs_agfl_t;
810 #define XFS_AGFL_CRC_OFF offsetof(struct xfs_agfl, agfl_crc)
812 #define XFS_AGB_TO_FSB(mp,agno,agbno) \
813 (((xfs_fsblock_t)(agno) << (mp)->m_sb.sb_agblklog) | (agbno))
814 #define XFS_FSB_TO_AGNO(mp,fsbno) \
815 ((xfs_agnumber_t)((fsbno) >> (mp)->m_sb.sb_agblklog))
816 #define XFS_FSB_TO_AGBNO(mp,fsbno) \
817 ((xfs_agblock_t)((fsbno) & xfs_mask32lo((mp)->m_sb.sb_agblklog)))
818 #define XFS_AGB_TO_DADDR(mp,agno,agbno) \
819 ((xfs_daddr_t)XFS_FSB_TO_BB(mp, \
820 (xfs_fsblock_t)(agno) * (mp)->m_sb.sb_agblocks + (agbno)))
821 #define XFS_AG_DADDR(mp,agno,d) (XFS_AGB_TO_DADDR(mp, agno, 0) + (d))
824 * For checking for bad ranges of xfs_daddr_t's, covering multiple
825 * allocation groups or a single xfs_daddr_t that's a superblock copy.
827 #define XFS_AG_CHECK_DADDR(mp,d,len) \
828 ((len) == 1 ? \
829 ASSERT((d) == XFS_SB_DADDR || \
830 xfs_daddr_to_agbno(mp, d) != XFS_SB_DADDR) : \
831 ASSERT(xfs_daddr_to_agno(mp, d) == \
832 xfs_daddr_to_agno(mp, (d) + (len) - 1)))
834 typedef struct xfs_timestamp {
835 __be32 t_sec; /* timestamp seconds */
836 __be32 t_nsec; /* timestamp nanoseconds */
837 } xfs_timestamp_t;
840 * On-disk inode structure.
842 * This is just the header or "dinode core", the inode is expanded to fill a
843 * variable size the leftover area split into a data and an attribute fork.
844 * The format of the data and attribute fork depends on the format of the
845 * inode as indicated by di_format and di_aformat. To access the data and
846 * attribute use the XFS_DFORK_DPTR, XFS_DFORK_APTR, and XFS_DFORK_PTR macros
847 * below.
849 * There is a very similar struct icdinode in xfs_inode which matches the
850 * layout of the first 96 bytes of this structure, but is kept in native
851 * format instead of big endian.
853 * Note: di_flushiter is only used by v1/2 inodes - it's effectively a zeroed
854 * padding field for v3 inodes.
856 #define XFS_DINODE_MAGIC 0x494e /* 'IN' */
857 typedef struct xfs_dinode {
858 __be16 di_magic; /* inode magic # = XFS_DINODE_MAGIC */
859 __be16 di_mode; /* mode and type of file */
860 __u8 di_version; /* inode version */
861 __u8 di_format; /* format of di_c data */
862 __be16 di_onlink; /* old number of links to file */
863 __be32 di_uid; /* owner's user id */
864 __be32 di_gid; /* owner's group id */
865 __be32 di_nlink; /* number of links to file */
866 __be16 di_projid_lo; /* lower part of owner's project id */
867 __be16 di_projid_hi; /* higher part owner's project id */
868 __u8 di_pad[6]; /* unused, zeroed space */
869 __be16 di_flushiter; /* incremented on flush */
870 xfs_timestamp_t di_atime; /* time last accessed */
871 xfs_timestamp_t di_mtime; /* time last modified */
872 xfs_timestamp_t di_ctime; /* time created/inode modified */
873 __be64 di_size; /* number of bytes in file */
874 __be64 di_nblocks; /* # of direct & btree blocks used */
875 __be32 di_extsize; /* basic/minimum extent size for file */
876 __be32 di_nextents; /* number of extents in data fork */
877 __be16 di_anextents; /* number of extents in attribute fork*/
878 __u8 di_forkoff; /* attr fork offs, <<3 for 64b align */
879 __s8 di_aformat; /* format of attr fork's data */
880 __be32 di_dmevmask; /* DMIG event mask */
881 __be16 di_dmstate; /* DMIG state info */
882 __be16 di_flags; /* random flags, XFS_DIFLAG_... */
883 __be32 di_gen; /* generation number */
885 /* di_next_unlinked is the only non-core field in the old dinode */
886 __be32 di_next_unlinked;/* agi unlinked list ptr */
888 /* start of the extended dinode, writable fields */
889 __le32 di_crc; /* CRC of the inode */
890 __be64 di_changecount; /* number of attribute changes */
891 __be64 di_lsn; /* flush sequence */
892 __be64 di_flags2; /* more random flags */
893 __be32 di_cowextsize; /* basic cow extent size for file */
894 __u8 di_pad2[12]; /* more padding for future expansion */
896 /* fields only written to during inode creation */
897 xfs_timestamp_t di_crtime; /* time created */
898 __be64 di_ino; /* inode number */
899 uuid_t di_uuid; /* UUID of the filesystem */
901 /* structure must be padded to 64 bit alignment */
902 } xfs_dinode_t;
904 #define XFS_DINODE_CRC_OFF offsetof(struct xfs_dinode, di_crc)
906 #define DI_MAX_FLUSH 0xffff
909 * Size of the core inode on disk. Version 1 and 2 inodes have
910 * the same size, but version 3 has grown a few additional fields.
912 static inline uint xfs_dinode_size(int version)
914 if (version == 3)
915 return sizeof(struct xfs_dinode);
916 return offsetof(struct xfs_dinode, di_crc);
920 * The 32 bit link count in the inode theoretically maxes out at UINT_MAX.
921 * Since the pathconf interface is signed, we use 2^31 - 1 instead.
923 #define XFS_MAXLINK ((1U << 31) - 1U)
926 * Values for di_format
928 typedef enum xfs_dinode_fmt {
929 XFS_DINODE_FMT_DEV, /* xfs_dev_t */
930 XFS_DINODE_FMT_LOCAL, /* bulk data */
931 XFS_DINODE_FMT_EXTENTS, /* struct xfs_bmbt_rec */
932 XFS_DINODE_FMT_BTREE, /* struct xfs_bmdr_block */
933 XFS_DINODE_FMT_UUID /* uuid_t */
934 } xfs_dinode_fmt_t;
937 * Inode minimum and maximum sizes.
939 #define XFS_DINODE_MIN_LOG 8
940 #define XFS_DINODE_MAX_LOG 11
941 #define XFS_DINODE_MIN_SIZE (1 << XFS_DINODE_MIN_LOG)
942 #define XFS_DINODE_MAX_SIZE (1 << XFS_DINODE_MAX_LOG)
945 * Inode size for given fs.
947 #define XFS_LITINO(mp, version) \
948 ((int)(((mp)->m_sb.sb_inodesize) - xfs_dinode_size(version)))
951 * Inode data & attribute fork sizes, per inode.
953 #define XFS_DFORK_Q(dip) ((dip)->di_forkoff != 0)
954 #define XFS_DFORK_BOFF(dip) ((int)((dip)->di_forkoff << 3))
956 #define XFS_DFORK_DSIZE(dip,mp) \
957 (XFS_DFORK_Q(dip) ? \
958 XFS_DFORK_BOFF(dip) : \
959 XFS_LITINO(mp, (dip)->di_version))
960 #define XFS_DFORK_ASIZE(dip,mp) \
961 (XFS_DFORK_Q(dip) ? \
962 XFS_LITINO(mp, (dip)->di_version) - XFS_DFORK_BOFF(dip) : \
964 #define XFS_DFORK_SIZE(dip,mp,w) \
965 ((w) == XFS_DATA_FORK ? \
966 XFS_DFORK_DSIZE(dip, mp) : \
967 XFS_DFORK_ASIZE(dip, mp))
970 * Return pointers to the data or attribute forks.
972 #define XFS_DFORK_DPTR(dip) \
973 ((char *)dip + xfs_dinode_size(dip->di_version))
974 #define XFS_DFORK_APTR(dip) \
975 (XFS_DFORK_DPTR(dip) + XFS_DFORK_BOFF(dip))
976 #define XFS_DFORK_PTR(dip,w) \
977 ((w) == XFS_DATA_FORK ? XFS_DFORK_DPTR(dip) : XFS_DFORK_APTR(dip))
979 #define XFS_DFORK_FORMAT(dip,w) \
980 ((w) == XFS_DATA_FORK ? \
981 (dip)->di_format : \
982 (dip)->di_aformat)
983 #define XFS_DFORK_NEXTENTS(dip,w) \
984 ((w) == XFS_DATA_FORK ? \
985 be32_to_cpu((dip)->di_nextents) : \
986 be16_to_cpu((dip)->di_anextents))
989 * For block and character special files the 32bit dev_t is stored at the
990 * beginning of the data fork.
992 static inline xfs_dev_t xfs_dinode_get_rdev(struct xfs_dinode *dip)
994 return be32_to_cpu(*(__be32 *)XFS_DFORK_DPTR(dip));
997 static inline void xfs_dinode_put_rdev(struct xfs_dinode *dip, xfs_dev_t rdev)
999 *(__be32 *)XFS_DFORK_DPTR(dip) = cpu_to_be32(rdev);
1003 * Values for di_flags
1005 #define XFS_DIFLAG_REALTIME_BIT 0 /* file's blocks come from rt area */
1006 #define XFS_DIFLAG_PREALLOC_BIT 1 /* file space has been preallocated */
1007 #define XFS_DIFLAG_NEWRTBM_BIT 2 /* for rtbitmap inode, new format */
1008 #define XFS_DIFLAG_IMMUTABLE_BIT 3 /* inode is immutable */
1009 #define XFS_DIFLAG_APPEND_BIT 4 /* inode is append-only */
1010 #define XFS_DIFLAG_SYNC_BIT 5 /* inode is written synchronously */
1011 #define XFS_DIFLAG_NOATIME_BIT 6 /* do not update atime */
1012 #define XFS_DIFLAG_NODUMP_BIT 7 /* do not dump */
1013 #define XFS_DIFLAG_RTINHERIT_BIT 8 /* create with realtime bit set */
1014 #define XFS_DIFLAG_PROJINHERIT_BIT 9 /* create with parents projid */
1015 #define XFS_DIFLAG_NOSYMLINKS_BIT 10 /* disallow symlink creation */
1016 #define XFS_DIFLAG_EXTSIZE_BIT 11 /* inode extent size allocator hint */
1017 #define XFS_DIFLAG_EXTSZINHERIT_BIT 12 /* inherit inode extent size */
1018 #define XFS_DIFLAG_NODEFRAG_BIT 13 /* do not reorganize/defragment */
1019 #define XFS_DIFLAG_FILESTREAM_BIT 14 /* use filestream allocator */
1020 #define XFS_DIFLAG_REALTIME (1 << XFS_DIFLAG_REALTIME_BIT)
1021 #define XFS_DIFLAG_PREALLOC (1 << XFS_DIFLAG_PREALLOC_BIT)
1022 #define XFS_DIFLAG_NEWRTBM (1 << XFS_DIFLAG_NEWRTBM_BIT)
1023 #define XFS_DIFLAG_IMMUTABLE (1 << XFS_DIFLAG_IMMUTABLE_BIT)
1024 #define XFS_DIFLAG_APPEND (1 << XFS_DIFLAG_APPEND_BIT)
1025 #define XFS_DIFLAG_SYNC (1 << XFS_DIFLAG_SYNC_BIT)
1026 #define XFS_DIFLAG_NOATIME (1 << XFS_DIFLAG_NOATIME_BIT)
1027 #define XFS_DIFLAG_NODUMP (1 << XFS_DIFLAG_NODUMP_BIT)
1028 #define XFS_DIFLAG_RTINHERIT (1 << XFS_DIFLAG_RTINHERIT_BIT)
1029 #define XFS_DIFLAG_PROJINHERIT (1 << XFS_DIFLAG_PROJINHERIT_BIT)
1030 #define XFS_DIFLAG_NOSYMLINKS (1 << XFS_DIFLAG_NOSYMLINKS_BIT)
1031 #define XFS_DIFLAG_EXTSIZE (1 << XFS_DIFLAG_EXTSIZE_BIT)
1032 #define XFS_DIFLAG_EXTSZINHERIT (1 << XFS_DIFLAG_EXTSZINHERIT_BIT)
1033 #define XFS_DIFLAG_NODEFRAG (1 << XFS_DIFLAG_NODEFRAG_BIT)
1034 #define XFS_DIFLAG_FILESTREAM (1 << XFS_DIFLAG_FILESTREAM_BIT)
1036 #define XFS_DIFLAG_ANY \
1037 (XFS_DIFLAG_REALTIME | XFS_DIFLAG_PREALLOC | XFS_DIFLAG_NEWRTBM | \
1038 XFS_DIFLAG_IMMUTABLE | XFS_DIFLAG_APPEND | XFS_DIFLAG_SYNC | \
1039 XFS_DIFLAG_NOATIME | XFS_DIFLAG_NODUMP | XFS_DIFLAG_RTINHERIT | \
1040 XFS_DIFLAG_PROJINHERIT | XFS_DIFLAG_NOSYMLINKS | XFS_DIFLAG_EXTSIZE | \
1041 XFS_DIFLAG_EXTSZINHERIT | XFS_DIFLAG_NODEFRAG | XFS_DIFLAG_FILESTREAM)
1044 * Values for di_flags2 These start by being exposed to userspace in the upper
1045 * 16 bits of the XFS_XFLAG_s range.
1047 #define XFS_DIFLAG2_DAX_BIT 0 /* use DAX for this inode */
1048 #define XFS_DIFLAG2_REFLINK_BIT 1 /* file's blocks may be shared */
1049 #define XFS_DIFLAG2_COWEXTSIZE_BIT 2 /* copy on write extent size hint */
1050 #define XFS_DIFLAG2_DAX (1 << XFS_DIFLAG2_DAX_BIT)
1051 #define XFS_DIFLAG2_REFLINK (1 << XFS_DIFLAG2_REFLINK_BIT)
1052 #define XFS_DIFLAG2_COWEXTSIZE (1 << XFS_DIFLAG2_COWEXTSIZE_BIT)
1054 #define XFS_DIFLAG2_ANY \
1055 (XFS_DIFLAG2_DAX | XFS_DIFLAG2_REFLINK | XFS_DIFLAG2_COWEXTSIZE)
1058 * Inode number format:
1059 * low inopblog bits - offset in block
1060 * next agblklog bits - block number in ag
1061 * next agno_log bits - ag number
1062 * high agno_log-agblklog-inopblog bits - 0
1064 #define XFS_INO_MASK(k) (uint32_t)((1ULL << (k)) - 1)
1065 #define XFS_INO_OFFSET_BITS(mp) (mp)->m_sb.sb_inopblog
1066 #define XFS_INO_AGBNO_BITS(mp) (mp)->m_sb.sb_agblklog
1067 #define XFS_INO_AGINO_BITS(mp) (mp)->m_agino_log
1068 #define XFS_INO_AGNO_BITS(mp) (mp)->m_agno_log
1069 #define XFS_INO_BITS(mp) \
1070 XFS_INO_AGNO_BITS(mp) + XFS_INO_AGINO_BITS(mp)
1071 #define XFS_INO_TO_AGNO(mp,i) \
1072 ((xfs_agnumber_t)((i) >> XFS_INO_AGINO_BITS(mp)))
1073 #define XFS_INO_TO_AGINO(mp,i) \
1074 ((xfs_agino_t)(i) & XFS_INO_MASK(XFS_INO_AGINO_BITS(mp)))
1075 #define XFS_INO_TO_AGBNO(mp,i) \
1076 (((xfs_agblock_t)(i) >> XFS_INO_OFFSET_BITS(mp)) & \
1077 XFS_INO_MASK(XFS_INO_AGBNO_BITS(mp)))
1078 #define XFS_INO_TO_OFFSET(mp,i) \
1079 ((int)(i) & XFS_INO_MASK(XFS_INO_OFFSET_BITS(mp)))
1080 #define XFS_INO_TO_FSB(mp,i) \
1081 XFS_AGB_TO_FSB(mp, XFS_INO_TO_AGNO(mp,i), XFS_INO_TO_AGBNO(mp,i))
1082 #define XFS_AGINO_TO_INO(mp,a,i) \
1083 (((xfs_ino_t)(a) << XFS_INO_AGINO_BITS(mp)) | (i))
1084 #define XFS_AGINO_TO_AGBNO(mp,i) ((i) >> XFS_INO_OFFSET_BITS(mp))
1085 #define XFS_AGINO_TO_OFFSET(mp,i) \
1086 ((i) & XFS_INO_MASK(XFS_INO_OFFSET_BITS(mp)))
1087 #define XFS_OFFBNO_TO_AGINO(mp,b,o) \
1088 ((xfs_agino_t)(((b) << XFS_INO_OFFSET_BITS(mp)) | (o)))
1090 #define XFS_MAXINUMBER ((xfs_ino_t)((1ULL << 56) - 1ULL))
1091 #define XFS_MAXINUMBER_32 ((xfs_ino_t)((1ULL << 32) - 1ULL))
1094 * RealTime Device format definitions
1097 /* Min and max rt extent sizes, specified in bytes */
1098 #define XFS_MAX_RTEXTSIZE (1024 * 1024 * 1024) /* 1GB */
1099 #define XFS_DFL_RTEXTSIZE (64 * 1024) /* 64kB */
1100 #define XFS_MIN_RTEXTSIZE (4 * 1024) /* 4kB */
1102 #define XFS_BLOCKSIZE(mp) ((mp)->m_sb.sb_blocksize)
1103 #define XFS_BLOCKMASK(mp) ((mp)->m_blockmask)
1104 #define XFS_BLOCKWSIZE(mp) ((mp)->m_blockwsize)
1105 #define XFS_BLOCKWMASK(mp) ((mp)->m_blockwmask)
1108 * RT Summary and bit manipulation macros.
1110 #define XFS_SUMOFFS(mp,ls,bb) ((int)((ls) * (mp)->m_sb.sb_rbmblocks + (bb)))
1111 #define XFS_SUMOFFSTOBLOCK(mp,s) \
1112 (((s) * (uint)sizeof(xfs_suminfo_t)) >> (mp)->m_sb.sb_blocklog)
1113 #define XFS_SUMPTR(mp,bp,so) \
1114 ((xfs_suminfo_t *)((bp)->b_addr + \
1115 (((so) * (uint)sizeof(xfs_suminfo_t)) & XFS_BLOCKMASK(mp))))
1117 #define XFS_BITTOBLOCK(mp,bi) ((bi) >> (mp)->m_blkbit_log)
1118 #define XFS_BLOCKTOBIT(mp,bb) ((bb) << (mp)->m_blkbit_log)
1119 #define XFS_BITTOWORD(mp,bi) \
1120 ((int)(((bi) >> XFS_NBWORDLOG) & XFS_BLOCKWMASK(mp)))
1122 #define XFS_RTMIN(a,b) ((a) < (b) ? (a) : (b))
1123 #define XFS_RTMAX(a,b) ((a) > (b) ? (a) : (b))
1125 #define XFS_RTLOBIT(w) xfs_lowbit32(w)
1126 #define XFS_RTHIBIT(w) xfs_highbit32(w)
1128 #define XFS_RTBLOCKLOG(b) xfs_highbit64(b)
1131 * Dquot and dquot block format definitions
1133 #define XFS_DQUOT_MAGIC 0x4451 /* 'DQ' */
1134 #define XFS_DQUOT_VERSION (u_int8_t)0x01 /* latest version number */
1137 * This is the main portion of the on-disk representation of quota
1138 * information for a user. This is the q_core of the xfs_dquot_t that
1139 * is kept in kernel memory. We pad this with some more expansion room
1140 * to construct the on disk structure.
1142 typedef struct xfs_disk_dquot {
1143 __be16 d_magic; /* dquot magic = XFS_DQUOT_MAGIC */
1144 __u8 d_version; /* dquot version */
1145 __u8 d_flags; /* XFS_DQ_USER/PROJ/GROUP */
1146 __be32 d_id; /* user,project,group id */
1147 __be64 d_blk_hardlimit;/* absolute limit on disk blks */
1148 __be64 d_blk_softlimit;/* preferred limit on disk blks */
1149 __be64 d_ino_hardlimit;/* maximum # allocated inodes */
1150 __be64 d_ino_softlimit;/* preferred inode limit */
1151 __be64 d_bcount; /* disk blocks owned by the user */
1152 __be64 d_icount; /* inodes owned by the user */
1153 __be32 d_itimer; /* zero if within inode limits if not,
1154 this is when we refuse service */
1155 __be32 d_btimer; /* similar to above; for disk blocks */
1156 __be16 d_iwarns; /* warnings issued wrt num inodes */
1157 __be16 d_bwarns; /* warnings issued wrt disk blocks */
1158 __be32 d_pad0; /* 64 bit align */
1159 __be64 d_rtb_hardlimit;/* absolute limit on realtime blks */
1160 __be64 d_rtb_softlimit;/* preferred limit on RT disk blks */
1161 __be64 d_rtbcount; /* realtime blocks owned */
1162 __be32 d_rtbtimer; /* similar to above; for RT disk blocks */
1163 __be16 d_rtbwarns; /* warnings issued wrt RT disk blocks */
1164 __be16 d_pad;
1165 } xfs_disk_dquot_t;
1168 * This is what goes on disk. This is separated from the xfs_disk_dquot because
1169 * carrying the unnecessary padding would be a waste of memory.
1171 typedef struct xfs_dqblk {
1172 xfs_disk_dquot_t dd_diskdq; /* portion that lives incore as well */
1173 char dd_fill[4]; /* filling for posterity */
1176 * These two are only present on filesystems with the CRC bits set.
1178 __be32 dd_crc; /* checksum */
1179 __be64 dd_lsn; /* last modification in log */
1180 uuid_t dd_uuid; /* location information */
1181 } xfs_dqblk_t;
1183 #define XFS_DQUOT_CRC_OFF offsetof(struct xfs_dqblk, dd_crc)
1186 * Remote symlink format and access functions.
1188 #define XFS_SYMLINK_MAGIC 0x58534c4d /* XSLM */
1190 struct xfs_dsymlink_hdr {
1191 __be32 sl_magic;
1192 __be32 sl_offset;
1193 __be32 sl_bytes;
1194 __be32 sl_crc;
1195 uuid_t sl_uuid;
1196 __be64 sl_owner;
1197 __be64 sl_blkno;
1198 __be64 sl_lsn;
1201 #define XFS_SYMLINK_CRC_OFF offsetof(struct xfs_dsymlink_hdr, sl_crc)
1203 #define XFS_SYMLINK_MAXLEN 1024
1205 * The maximum pathlen is 1024 bytes. Since the minimum file system
1206 * blocksize is 512 bytes, we can get a max of 3 extents back from
1207 * bmapi when crc headers are taken into account.
1209 #define XFS_SYMLINK_MAPS 3
1211 #define XFS_SYMLINK_BUF_SPACE(mp, bufsize) \
1212 ((bufsize) - (xfs_sb_version_hascrc(&(mp)->m_sb) ? \
1213 sizeof(struct xfs_dsymlink_hdr) : 0))
1217 * Allocation Btree format definitions
1219 * There are two on-disk btrees, one sorted by blockno and one sorted
1220 * by blockcount and blockno. All blocks look the same to make the code
1221 * simpler; if we have time later, we'll make the optimizations.
1223 #define XFS_ABTB_MAGIC 0x41425442 /* 'ABTB' for bno tree */
1224 #define XFS_ABTB_CRC_MAGIC 0x41423342 /* 'AB3B' */
1225 #define XFS_ABTC_MAGIC 0x41425443 /* 'ABTC' for cnt tree */
1226 #define XFS_ABTC_CRC_MAGIC 0x41423343 /* 'AB3C' */
1229 * Data record/key structure
1231 typedef struct xfs_alloc_rec {
1232 __be32 ar_startblock; /* starting block number */
1233 __be32 ar_blockcount; /* count of free blocks */
1234 } xfs_alloc_rec_t, xfs_alloc_key_t;
1236 typedef struct xfs_alloc_rec_incore {
1237 xfs_agblock_t ar_startblock; /* starting block number */
1238 xfs_extlen_t ar_blockcount; /* count of free blocks */
1239 } xfs_alloc_rec_incore_t;
1241 /* btree pointer type */
1242 typedef __be32 xfs_alloc_ptr_t;
1245 * Block numbers in the AG:
1246 * SB is sector 0, AGF is sector 1, AGI is sector 2, AGFL is sector 3.
1248 #define XFS_BNO_BLOCK(mp) ((xfs_agblock_t)(XFS_AGFL_BLOCK(mp) + 1))
1249 #define XFS_CNT_BLOCK(mp) ((xfs_agblock_t)(XFS_BNO_BLOCK(mp) + 1))
1253 * Inode Allocation Btree format definitions
1255 * There is a btree for the inode map per allocation group.
1257 #define XFS_IBT_MAGIC 0x49414254 /* 'IABT' */
1258 #define XFS_IBT_CRC_MAGIC 0x49414233 /* 'IAB3' */
1259 #define XFS_FIBT_MAGIC 0x46494254 /* 'FIBT' */
1260 #define XFS_FIBT_CRC_MAGIC 0x46494233 /* 'FIB3' */
1262 typedef uint64_t xfs_inofree_t;
1263 #define XFS_INODES_PER_CHUNK (NBBY * sizeof(xfs_inofree_t))
1264 #define XFS_INODES_PER_CHUNK_LOG (XFS_NBBYLOG + 3)
1265 #define XFS_INOBT_ALL_FREE ((xfs_inofree_t)-1)
1266 #define XFS_INOBT_MASK(i) ((xfs_inofree_t)1 << (i))
1268 #define XFS_INOBT_HOLEMASK_FULL 0 /* holemask for full chunk */
1269 #define XFS_INOBT_HOLEMASK_BITS (NBBY * sizeof(uint16_t))
1270 #define XFS_INODES_PER_HOLEMASK_BIT \
1271 (XFS_INODES_PER_CHUNK / (NBBY * sizeof(uint16_t)))
1273 static inline xfs_inofree_t xfs_inobt_maskn(int i, int n)
1275 return ((n >= XFS_INODES_PER_CHUNK ? 0 : XFS_INOBT_MASK(n)) - 1) << i;
1279 * The on-disk inode record structure has two formats. The original "full"
1280 * format uses a 4-byte freecount. The "sparse" format uses a 1-byte freecount
1281 * and replaces the 3 high-order freecount bytes wth the holemask and inode
1282 * count.
1284 * The holemask of the sparse record format allows an inode chunk to have holes
1285 * that refer to blocks not owned by the inode record. This facilitates inode
1286 * allocation in the event of severe free space fragmentation.
1288 typedef struct xfs_inobt_rec {
1289 __be32 ir_startino; /* starting inode number */
1290 union {
1291 struct {
1292 __be32 ir_freecount; /* count of free inodes */
1293 } f;
1294 struct {
1295 __be16 ir_holemask;/* hole mask for sparse chunks */
1296 __u8 ir_count; /* total inode count */
1297 __u8 ir_freecount; /* count of free inodes */
1298 } sp;
1299 } ir_u;
1300 __be64 ir_free; /* free inode mask */
1301 } xfs_inobt_rec_t;
1303 typedef struct xfs_inobt_rec_incore {
1304 xfs_agino_t ir_startino; /* starting inode number */
1305 uint16_t ir_holemask; /* hole mask for sparse chunks */
1306 uint8_t ir_count; /* total inode count */
1307 uint8_t ir_freecount; /* count of free inodes (set bits) */
1308 xfs_inofree_t ir_free; /* free inode mask */
1309 } xfs_inobt_rec_incore_t;
1311 static inline bool xfs_inobt_issparse(uint16_t holemask)
1313 /* non-zero holemask represents a sparse rec. */
1314 return holemask;
1318 * Key structure
1320 typedef struct xfs_inobt_key {
1321 __be32 ir_startino; /* starting inode number */
1322 } xfs_inobt_key_t;
1324 /* btree pointer type */
1325 typedef __be32 xfs_inobt_ptr_t;
1328 * block numbers in the AG.
1330 #define XFS_IBT_BLOCK(mp) ((xfs_agblock_t)(XFS_CNT_BLOCK(mp) + 1))
1331 #define XFS_FIBT_BLOCK(mp) ((xfs_agblock_t)(XFS_IBT_BLOCK(mp) + 1))
1334 * Reverse mapping btree format definitions
1336 * There is a btree for the reverse map per allocation group
1338 #define XFS_RMAP_CRC_MAGIC 0x524d4233 /* 'RMB3' */
1341 * Ownership info for an extent. This is used to create reverse-mapping
1342 * entries.
1344 #define XFS_OWNER_INFO_ATTR_FORK (1 << 0)
1345 #define XFS_OWNER_INFO_BMBT_BLOCK (1 << 1)
1346 struct xfs_owner_info {
1347 uint64_t oi_owner;
1348 xfs_fileoff_t oi_offset;
1349 unsigned int oi_flags;
1353 * Special owner types.
1355 * Seeing as we only support up to 8EB, we have the upper bit of the owner field
1356 * to tell us we have a special owner value. We use these for static metadata
1357 * allocated at mkfs/growfs time, as well as for freespace management metadata.
1359 #define XFS_RMAP_OWN_NULL (-1ULL) /* No owner, for growfs */
1360 #define XFS_RMAP_OWN_UNKNOWN (-2ULL) /* Unknown owner, for EFI recovery */
1361 #define XFS_RMAP_OWN_FS (-3ULL) /* static fs metadata */
1362 #define XFS_RMAP_OWN_LOG (-4ULL) /* static fs metadata */
1363 #define XFS_RMAP_OWN_AG (-5ULL) /* AG freespace btree blocks */
1364 #define XFS_RMAP_OWN_INOBT (-6ULL) /* Inode btree blocks */
1365 #define XFS_RMAP_OWN_INODES (-7ULL) /* Inode chunk */
1366 #define XFS_RMAP_OWN_REFC (-8ULL) /* refcount tree */
1367 #define XFS_RMAP_OWN_COW (-9ULL) /* cow allocations */
1368 #define XFS_RMAP_OWN_MIN (-10ULL) /* guard */
1370 #define XFS_RMAP_NON_INODE_OWNER(owner) (!!((owner) & (1ULL << 63)))
1373 * Data record structure
1375 struct xfs_rmap_rec {
1376 __be32 rm_startblock; /* extent start block */
1377 __be32 rm_blockcount; /* extent length */
1378 __be64 rm_owner; /* extent owner */
1379 __be64 rm_offset; /* offset within the owner */
1383 * rmap btree record
1384 * rm_offset:63 is the attribute fork flag
1385 * rm_offset:62 is the bmbt block flag
1386 * rm_offset:61 is the unwritten extent flag (same as l0:63 in bmbt)
1387 * rm_offset:54-60 aren't used and should be zero
1388 * rm_offset:0-53 is the block offset within the inode
1390 #define XFS_RMAP_OFF_ATTR_FORK ((uint64_t)1ULL << 63)
1391 #define XFS_RMAP_OFF_BMBT_BLOCK ((uint64_t)1ULL << 62)
1392 #define XFS_RMAP_OFF_UNWRITTEN ((uint64_t)1ULL << 61)
1394 #define XFS_RMAP_LEN_MAX ((uint32_t)~0U)
1395 #define XFS_RMAP_OFF_FLAGS (XFS_RMAP_OFF_ATTR_FORK | \
1396 XFS_RMAP_OFF_BMBT_BLOCK | \
1397 XFS_RMAP_OFF_UNWRITTEN)
1398 #define XFS_RMAP_OFF_MASK ((uint64_t)0x3FFFFFFFFFFFFFULL)
1400 #define XFS_RMAP_OFF(off) ((off) & XFS_RMAP_OFF_MASK)
1402 #define XFS_RMAP_IS_BMBT_BLOCK(off) (!!((off) & XFS_RMAP_OFF_BMBT_BLOCK))
1403 #define XFS_RMAP_IS_ATTR_FORK(off) (!!((off) & XFS_RMAP_OFF_ATTR_FORK))
1404 #define XFS_RMAP_IS_UNWRITTEN(len) (!!((off) & XFS_RMAP_OFF_UNWRITTEN))
1406 #define RMAPBT_STARTBLOCK_BITLEN 32
1407 #define RMAPBT_BLOCKCOUNT_BITLEN 32
1408 #define RMAPBT_OWNER_BITLEN 64
1409 #define RMAPBT_ATTRFLAG_BITLEN 1
1410 #define RMAPBT_BMBTFLAG_BITLEN 1
1411 #define RMAPBT_EXNTFLAG_BITLEN 1
1412 #define RMAPBT_UNUSED_OFFSET_BITLEN 7
1413 #define RMAPBT_OFFSET_BITLEN 54
1415 #define XFS_RMAP_ATTR_FORK (1 << 0)
1416 #define XFS_RMAP_BMBT_BLOCK (1 << 1)
1417 #define XFS_RMAP_UNWRITTEN (1 << 2)
1418 #define XFS_RMAP_KEY_FLAGS (XFS_RMAP_ATTR_FORK | \
1419 XFS_RMAP_BMBT_BLOCK)
1420 #define XFS_RMAP_REC_FLAGS (XFS_RMAP_UNWRITTEN)
1421 struct xfs_rmap_irec {
1422 xfs_agblock_t rm_startblock; /* extent start block */
1423 xfs_extlen_t rm_blockcount; /* extent length */
1424 uint64_t rm_owner; /* extent owner */
1425 uint64_t rm_offset; /* offset within the owner */
1426 unsigned int rm_flags; /* state flags */
1430 * Key structure
1432 * We don't use the length for lookups
1434 struct xfs_rmap_key {
1435 __be32 rm_startblock; /* extent start block */
1436 __be64 rm_owner; /* extent owner */
1437 __be64 rm_offset; /* offset within the owner */
1438 } __attribute__((packed));
1440 /* btree pointer type */
1441 typedef __be32 xfs_rmap_ptr_t;
1443 #define XFS_RMAP_BLOCK(mp) \
1444 (xfs_sb_version_hasfinobt(&((mp)->m_sb)) ? \
1445 XFS_FIBT_BLOCK(mp) + 1 : \
1446 XFS_IBT_BLOCK(mp) + 1)
1449 * Reference Count Btree format definitions
1452 #define XFS_REFC_CRC_MAGIC 0x52334643 /* 'R3FC' */
1454 unsigned int xfs_refc_block(struct xfs_mount *mp);
1457 * Data record/key structure
1459 * Each record associates a range of physical blocks (starting at
1460 * rc_startblock and ending rc_blockcount blocks later) with a reference
1461 * count (rc_refcount). Extents that are being used to stage a copy on
1462 * write (CoW) operation are recorded in the refcount btree with a
1463 * refcount of 1. All other records must have a refcount > 1 and must
1464 * track an extent mapped only by file data forks.
1466 * Extents with a single owner (attributes, metadata, non-shared file
1467 * data) are not tracked here. Free space is also not tracked here.
1468 * This is consistent with pre-reflink XFS.
1472 * Extents that are being used to stage a copy on write are stored
1473 * in the refcount btree with a refcount of 1 and the upper bit set
1474 * on the startblock. This speeds up mount time deletion of stale
1475 * staging extents because they're all at the right side of the tree.
1477 #define XFS_REFC_COW_START ((xfs_agblock_t)(1U << 31))
1478 #define REFCNTBT_COWFLAG_BITLEN 1
1479 #define REFCNTBT_AGBLOCK_BITLEN 31
1481 struct xfs_refcount_rec {
1482 __be32 rc_startblock; /* starting block number */
1483 __be32 rc_blockcount; /* count of blocks */
1484 __be32 rc_refcount; /* number of inodes linked here */
1487 struct xfs_refcount_key {
1488 __be32 rc_startblock; /* starting block number */
1491 struct xfs_refcount_irec {
1492 xfs_agblock_t rc_startblock; /* starting block number */
1493 xfs_extlen_t rc_blockcount; /* count of free blocks */
1494 xfs_nlink_t rc_refcount; /* number of inodes linked here */
1497 #define MAXREFCOUNT ((xfs_nlink_t)~0U)
1498 #define MAXREFCEXTLEN ((xfs_extlen_t)~0U)
1500 /* btree pointer type */
1501 typedef __be32 xfs_refcount_ptr_t;
1505 * BMAP Btree format definitions
1507 * This includes both the root block definition that sits inside an inode fork
1508 * and the record/pointer formats for the leaf/node in the blocks.
1510 #define XFS_BMAP_MAGIC 0x424d4150 /* 'BMAP' */
1511 #define XFS_BMAP_CRC_MAGIC 0x424d4133 /* 'BMA3' */
1514 * Bmap root header, on-disk form only.
1516 typedef struct xfs_bmdr_block {
1517 __be16 bb_level; /* 0 is a leaf */
1518 __be16 bb_numrecs; /* current # of data records */
1519 } xfs_bmdr_block_t;
1522 * Bmap btree record and extent descriptor.
1523 * l0:63 is an extent flag (value 1 indicates non-normal).
1524 * l0:9-62 are startoff.
1525 * l0:0-8 and l1:21-63 are startblock.
1526 * l1:0-20 are blockcount.
1528 #define BMBT_EXNTFLAG_BITLEN 1
1529 #define BMBT_STARTOFF_BITLEN 54
1530 #define BMBT_STARTBLOCK_BITLEN 52
1531 #define BMBT_BLOCKCOUNT_BITLEN 21
1533 typedef struct xfs_bmbt_rec {
1534 __be64 l0, l1;
1535 } xfs_bmbt_rec_t;
1537 typedef uint64_t xfs_bmbt_rec_base_t; /* use this for casts */
1538 typedef xfs_bmbt_rec_t xfs_bmdr_rec_t;
1540 typedef struct xfs_bmbt_rec_host {
1541 uint64_t l0, l1;
1542 } xfs_bmbt_rec_host_t;
1545 * Values and macros for delayed-allocation startblock fields.
1547 #define STARTBLOCKVALBITS 17
1548 #define STARTBLOCKMASKBITS (15 + 20)
1549 #define STARTBLOCKMASK \
1550 (((((xfs_fsblock_t)1) << STARTBLOCKMASKBITS) - 1) << STARTBLOCKVALBITS)
1552 static inline int isnullstartblock(xfs_fsblock_t x)
1554 return ((x) & STARTBLOCKMASK) == STARTBLOCKMASK;
1557 static inline xfs_fsblock_t nullstartblock(int k)
1559 ASSERT(k < (1 << STARTBLOCKVALBITS));
1560 return STARTBLOCKMASK | (k);
1563 static inline xfs_filblks_t startblockval(xfs_fsblock_t x)
1565 return (xfs_filblks_t)((x) & ~STARTBLOCKMASK);
1569 * Possible extent states.
1571 typedef enum {
1572 XFS_EXT_NORM, XFS_EXT_UNWRITTEN,
1573 } xfs_exntst_t;
1576 * Incore version of above.
1578 typedef struct xfs_bmbt_irec
1580 xfs_fileoff_t br_startoff; /* starting file offset */
1581 xfs_fsblock_t br_startblock; /* starting block number */
1582 xfs_filblks_t br_blockcount; /* number of blocks */
1583 xfs_exntst_t br_state; /* extent state */
1584 } xfs_bmbt_irec_t;
1587 * Key structure for non-leaf levels of the tree.
1589 typedef struct xfs_bmbt_key {
1590 __be64 br_startoff; /* starting file offset */
1591 } xfs_bmbt_key_t, xfs_bmdr_key_t;
1593 /* btree pointer type */
1594 typedef __be64 xfs_bmbt_ptr_t, xfs_bmdr_ptr_t;
1598 * Generic Btree block format definitions
1600 * This is a combination of the actual format used on disk for short and long
1601 * format btrees. The first three fields are shared by both format, but the
1602 * pointers are different and should be used with care.
1604 * To get the size of the actual short or long form headers please use the size
1605 * macros below. Never use sizeof(xfs_btree_block).
1607 * The blkno, crc, lsn, owner and uuid fields are only available in filesystems
1608 * with the crc feature bit, and all accesses to them must be conditional on
1609 * that flag.
1611 /* short form block header */
1612 struct xfs_btree_block_shdr {
1613 __be32 bb_leftsib;
1614 __be32 bb_rightsib;
1616 __be64 bb_blkno;
1617 __be64 bb_lsn;
1618 uuid_t bb_uuid;
1619 __be32 bb_owner;
1620 __le32 bb_crc;
1623 /* long form block header */
1624 struct xfs_btree_block_lhdr {
1625 __be64 bb_leftsib;
1626 __be64 bb_rightsib;
1628 __be64 bb_blkno;
1629 __be64 bb_lsn;
1630 uuid_t bb_uuid;
1631 __be64 bb_owner;
1632 __le32 bb_crc;
1633 __be32 bb_pad; /* padding for alignment */
1636 struct xfs_btree_block {
1637 __be32 bb_magic; /* magic number for block type */
1638 __be16 bb_level; /* 0 is a leaf */
1639 __be16 bb_numrecs; /* current # of data records */
1640 union {
1641 struct xfs_btree_block_shdr s;
1642 struct xfs_btree_block_lhdr l;
1643 } bb_u; /* rest */
1646 /* size of a short form block */
1647 #define XFS_BTREE_SBLOCK_LEN \
1648 (offsetof(struct xfs_btree_block, bb_u) + \
1649 offsetof(struct xfs_btree_block_shdr, bb_blkno))
1650 /* size of a long form block */
1651 #define XFS_BTREE_LBLOCK_LEN \
1652 (offsetof(struct xfs_btree_block, bb_u) + \
1653 offsetof(struct xfs_btree_block_lhdr, bb_blkno))
1655 /* sizes of CRC enabled btree blocks */
1656 #define XFS_BTREE_SBLOCK_CRC_LEN \
1657 (offsetof(struct xfs_btree_block, bb_u) + \
1658 sizeof(struct xfs_btree_block_shdr))
1659 #define XFS_BTREE_LBLOCK_CRC_LEN \
1660 (offsetof(struct xfs_btree_block, bb_u) + \
1661 sizeof(struct xfs_btree_block_lhdr))
1663 #define XFS_BTREE_SBLOCK_CRC_OFF \
1664 offsetof(struct xfs_btree_block, bb_u.s.bb_crc)
1665 #define XFS_BTREE_LBLOCK_CRC_OFF \
1666 offsetof(struct xfs_btree_block, bb_u.l.bb_crc)
1669 * On-disk XFS access control list structure.
1671 struct xfs_acl_entry {
1672 __be32 ae_tag;
1673 __be32 ae_id;
1674 __be16 ae_perm;
1675 __be16 ae_pad; /* fill the implicit hole in the structure */
1678 struct xfs_acl {
1679 __be32 acl_cnt;
1680 struct xfs_acl_entry acl_entry[0];
1684 * The number of ACL entries allowed is defined by the on-disk format.
1685 * For v4 superblocks, that is limited to 25 entries. For v5 superblocks, it is
1686 * limited only by the maximum size of the xattr that stores the information.
1688 #define XFS_ACL_MAX_ENTRIES(mp) \
1689 (xfs_sb_version_hascrc(&mp->m_sb) \
1690 ? (XFS_XATTR_SIZE_MAX - sizeof(struct xfs_acl)) / \
1691 sizeof(struct xfs_acl_entry) \
1692 : 25)
1694 #define XFS_ACL_SIZE(cnt) \
1695 (sizeof(struct xfs_acl) + \
1696 sizeof(struct xfs_acl_entry) * cnt)
1698 #define XFS_ACL_MAX_SIZE(mp) \
1699 XFS_ACL_SIZE(XFS_ACL_MAX_ENTRIES((mp)))
1702 /* On-disk XFS extended attribute names */
1703 #define SGI_ACL_FILE "SGI_ACL_FILE"
1704 #define SGI_ACL_DEFAULT "SGI_ACL_DEFAULT"
1705 #define SGI_ACL_FILE_SIZE (sizeof(SGI_ACL_FILE)-1)
1706 #define SGI_ACL_DEFAULT_SIZE (sizeof(SGI_ACL_DEFAULT)-1)
1708 #endif /* __XFS_FORMAT_H__ */