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