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