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