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