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