xref: /kernel/linux/linux-5.10/fs/xfs/xfs_ondisk.h (revision 8c2ecf20)
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (c) 2016 Oracle.
4 * All Rights Reserved.
5 */
6#ifndef __XFS_ONDISK_H
7#define __XFS_ONDISK_H
8
9#define XFS_CHECK_STRUCT_SIZE(structname, size) \
10	BUILD_BUG_ON_MSG(sizeof(structname) != (size), "XFS: sizeof(" \
11		#structname ") is wrong, expected " #size)
12
13#define XFS_CHECK_OFFSET(structname, member, off) \
14	BUILD_BUG_ON_MSG(offsetof(structname, member) != (off), \
15		"XFS: offsetof(" #structname ", " #member ") is wrong, " \
16		"expected " #off)
17
18#define XFS_CHECK_VALUE(value, expected) \
19	BUILD_BUG_ON_MSG((value) != (expected), \
20		"XFS: value of " #value " is wrong, expected " #expected)
21
22static inline void __init
23xfs_check_ondisk_structs(void)
24{
25	/* ag/file structures */
26	XFS_CHECK_STRUCT_SIZE(struct xfs_acl,			4);
27	XFS_CHECK_STRUCT_SIZE(struct xfs_acl_entry,		12);
28	XFS_CHECK_STRUCT_SIZE(struct xfs_agf,			224);
29	XFS_CHECK_STRUCT_SIZE(struct xfs_agfl,			36);
30	XFS_CHECK_STRUCT_SIZE(struct xfs_agi,			344);
31	XFS_CHECK_STRUCT_SIZE(struct xfs_bmbt_key,		8);
32	XFS_CHECK_STRUCT_SIZE(struct xfs_bmbt_rec,		16);
33	XFS_CHECK_STRUCT_SIZE(struct xfs_bmdr_block,		4);
34	XFS_CHECK_STRUCT_SIZE(struct xfs_btree_block_shdr,	48);
35	XFS_CHECK_STRUCT_SIZE(struct xfs_btree_block_lhdr,	64);
36	XFS_CHECK_STRUCT_SIZE(struct xfs_btree_block,		72);
37	XFS_CHECK_STRUCT_SIZE(struct xfs_dinode,		176);
38	XFS_CHECK_STRUCT_SIZE(struct xfs_disk_dquot,		104);
39	XFS_CHECK_STRUCT_SIZE(struct xfs_dqblk,			136);
40	XFS_CHECK_STRUCT_SIZE(struct xfs_dsb,			264);
41	XFS_CHECK_STRUCT_SIZE(struct xfs_dsymlink_hdr,		56);
42	XFS_CHECK_STRUCT_SIZE(struct xfs_inobt_key,		4);
43	XFS_CHECK_STRUCT_SIZE(struct xfs_inobt_rec,		16);
44	XFS_CHECK_STRUCT_SIZE(struct xfs_refcount_key,		4);
45	XFS_CHECK_STRUCT_SIZE(struct xfs_refcount_rec,		12);
46	XFS_CHECK_STRUCT_SIZE(struct xfs_rmap_key,		20);
47	XFS_CHECK_STRUCT_SIZE(struct xfs_rmap_rec,		24);
48	XFS_CHECK_STRUCT_SIZE(xfs_timestamp_t,			8);
49	XFS_CHECK_STRUCT_SIZE(struct xfs_legacy_timestamp,	8);
50	XFS_CHECK_STRUCT_SIZE(xfs_alloc_key_t,			8);
51	XFS_CHECK_STRUCT_SIZE(xfs_alloc_ptr_t,			4);
52	XFS_CHECK_STRUCT_SIZE(xfs_alloc_rec_t,			8);
53	XFS_CHECK_STRUCT_SIZE(xfs_inobt_ptr_t,			4);
54	XFS_CHECK_STRUCT_SIZE(xfs_refcount_ptr_t,		4);
55	XFS_CHECK_STRUCT_SIZE(xfs_rmap_ptr_t,			4);
56
57	/* dir/attr trees */
58	XFS_CHECK_STRUCT_SIZE(struct xfs_attr3_leaf_hdr,	80);
59	XFS_CHECK_STRUCT_SIZE(struct xfs_attr3_leafblock,	88);
60	XFS_CHECK_STRUCT_SIZE(struct xfs_attr3_rmt_hdr,		56);
61	XFS_CHECK_STRUCT_SIZE(struct xfs_da3_blkinfo,		56);
62	XFS_CHECK_STRUCT_SIZE(struct xfs_da3_intnode,		64);
63	XFS_CHECK_STRUCT_SIZE(struct xfs_da3_node_hdr,		64);
64	XFS_CHECK_STRUCT_SIZE(struct xfs_dir3_blk_hdr,		48);
65	XFS_CHECK_STRUCT_SIZE(struct xfs_dir3_data_hdr,		64);
66	XFS_CHECK_STRUCT_SIZE(struct xfs_dir3_free,		64);
67	XFS_CHECK_STRUCT_SIZE(struct xfs_dir3_free_hdr,		64);
68	XFS_CHECK_STRUCT_SIZE(struct xfs_dir3_leaf,		64);
69	XFS_CHECK_STRUCT_SIZE(struct xfs_dir3_leaf_hdr,		64);
70	XFS_CHECK_STRUCT_SIZE(xfs_attr_leaf_entry_t,		8);
71	XFS_CHECK_STRUCT_SIZE(xfs_attr_leaf_hdr_t,		32);
72	XFS_CHECK_STRUCT_SIZE(xfs_attr_leaf_map_t,		4);
73	XFS_CHECK_STRUCT_SIZE(xfs_attr_leaf_name_local_t,	4);
74
75	/*
76	 * m68k has problems with xfs_attr_leaf_name_remote_t, but we pad it to
77	 * 4 bytes anyway so it's not obviously a problem.  Hence for the moment
78	 * we don't check this structure. This can be re-instated when the attr
79	 * definitions are updated to use c99 VLA definitions.
80	 *
81	XFS_CHECK_STRUCT_SIZE(xfs_attr_leaf_name_remote_t,	12);
82	 */
83
84	XFS_CHECK_OFFSET(xfs_attr_leaf_name_local_t, valuelen,	0);
85	XFS_CHECK_OFFSET(xfs_attr_leaf_name_local_t, namelen,	2);
86	XFS_CHECK_OFFSET(xfs_attr_leaf_name_local_t, nameval,	3);
87	XFS_CHECK_OFFSET(xfs_attr_leaf_name_remote_t, valueblk,	0);
88	XFS_CHECK_OFFSET(xfs_attr_leaf_name_remote_t, valuelen,	4);
89	XFS_CHECK_OFFSET(xfs_attr_leaf_name_remote_t, namelen,	8);
90	XFS_CHECK_OFFSET(xfs_attr_leaf_name_remote_t, name,	9);
91	XFS_CHECK_STRUCT_SIZE(xfs_attr_leafblock_t,		40);
92	XFS_CHECK_OFFSET(struct xfs_attr_shortform, hdr.totsize, 0);
93	XFS_CHECK_OFFSET(struct xfs_attr_shortform, hdr.count,	 2);
94	XFS_CHECK_OFFSET(struct xfs_attr_shortform, list[0].namelen,	4);
95	XFS_CHECK_OFFSET(struct xfs_attr_shortform, list[0].valuelen,	5);
96	XFS_CHECK_OFFSET(struct xfs_attr_shortform, list[0].flags,	6);
97	XFS_CHECK_OFFSET(struct xfs_attr_shortform, list[0].nameval,	7);
98	XFS_CHECK_STRUCT_SIZE(xfs_da_blkinfo_t,			12);
99	XFS_CHECK_STRUCT_SIZE(xfs_da_intnode_t,			16);
100	XFS_CHECK_STRUCT_SIZE(xfs_da_node_entry_t,		8);
101	XFS_CHECK_STRUCT_SIZE(xfs_da_node_hdr_t,		16);
102	XFS_CHECK_STRUCT_SIZE(xfs_dir2_data_free_t,		4);
103	XFS_CHECK_STRUCT_SIZE(xfs_dir2_data_hdr_t,		16);
104	XFS_CHECK_OFFSET(xfs_dir2_data_unused_t, freetag,	0);
105	XFS_CHECK_OFFSET(xfs_dir2_data_unused_t, length,	2);
106	XFS_CHECK_STRUCT_SIZE(xfs_dir2_free_hdr_t,		16);
107	XFS_CHECK_STRUCT_SIZE(xfs_dir2_free_t,			16);
108	XFS_CHECK_STRUCT_SIZE(xfs_dir2_leaf_entry_t,		8);
109	XFS_CHECK_STRUCT_SIZE(xfs_dir2_leaf_hdr_t,		16);
110	XFS_CHECK_STRUCT_SIZE(xfs_dir2_leaf_t,			16);
111	XFS_CHECK_STRUCT_SIZE(xfs_dir2_leaf_tail_t,		4);
112	XFS_CHECK_STRUCT_SIZE(xfs_dir2_sf_entry_t,		3);
113	XFS_CHECK_OFFSET(xfs_dir2_sf_entry_t, namelen,		0);
114	XFS_CHECK_OFFSET(xfs_dir2_sf_entry_t, offset,		1);
115	XFS_CHECK_OFFSET(xfs_dir2_sf_entry_t, name,		3);
116	XFS_CHECK_STRUCT_SIZE(xfs_dir2_sf_hdr_t,		10);
117
118	/* log structures */
119	XFS_CHECK_STRUCT_SIZE(struct xfs_buf_log_format,	88);
120	XFS_CHECK_STRUCT_SIZE(struct xfs_dq_logformat,		24);
121	XFS_CHECK_STRUCT_SIZE(struct xfs_efd_log_format_32,	28);
122	XFS_CHECK_STRUCT_SIZE(struct xfs_efd_log_format_64,	32);
123	XFS_CHECK_STRUCT_SIZE(struct xfs_efi_log_format_32,	28);
124	XFS_CHECK_STRUCT_SIZE(struct xfs_efi_log_format_64,	32);
125	XFS_CHECK_STRUCT_SIZE(struct xfs_extent_32,		12);
126	XFS_CHECK_STRUCT_SIZE(struct xfs_extent_64,		16);
127	XFS_CHECK_STRUCT_SIZE(struct xfs_log_dinode,		176);
128	XFS_CHECK_STRUCT_SIZE(struct xfs_icreate_log,		28);
129	XFS_CHECK_STRUCT_SIZE(xfs_ictimestamp_t,		8);
130	XFS_CHECK_STRUCT_SIZE(struct xfs_legacy_ictimestamp,	8);
131	XFS_CHECK_STRUCT_SIZE(struct xfs_inode_log_format_32,	52);
132	XFS_CHECK_STRUCT_SIZE(struct xfs_inode_log_format,	56);
133	XFS_CHECK_STRUCT_SIZE(struct xfs_qoff_logformat,	20);
134	XFS_CHECK_STRUCT_SIZE(struct xfs_trans_header,		16);
135
136	/*
137	 * The v5 superblock format extended several v4 header structures with
138	 * additional data. While new fields are only accessible on v5
139	 * superblocks, it's important that the v5 structures place original v4
140	 * fields/headers in the correct location on-disk. For example, we must
141	 * be able to find magic values at the same location in certain blocks
142	 * regardless of superblock version.
143	 *
144	 * The following checks ensure that various v5 data structures place the
145	 * subset of v4 metadata associated with the same type of block at the
146	 * start of the on-disk block. If there is no data structure definition
147	 * for certain types of v4 blocks, traverse down to the first field of
148	 * common metadata (e.g., magic value) and make sure it is at offset
149	 * zero.
150	 */
151	XFS_CHECK_OFFSET(struct xfs_dir3_leaf, hdr.info.hdr,	0);
152	XFS_CHECK_OFFSET(struct xfs_da3_intnode, hdr.info.hdr,	0);
153	XFS_CHECK_OFFSET(struct xfs_dir3_data_hdr, hdr.magic,	0);
154	XFS_CHECK_OFFSET(struct xfs_dir3_free, hdr.hdr.magic,	0);
155	XFS_CHECK_OFFSET(struct xfs_attr3_leafblock, hdr.info.hdr, 0);
156
157	XFS_CHECK_STRUCT_SIZE(struct xfs_bulkstat,		192);
158	XFS_CHECK_STRUCT_SIZE(struct xfs_inumbers,		24);
159	XFS_CHECK_STRUCT_SIZE(struct xfs_bulkstat_req,		64);
160	XFS_CHECK_STRUCT_SIZE(struct xfs_inumbers_req,		64);
161
162	/*
163	 * Make sure the incore inode timestamp range corresponds to hand
164	 * converted values based on the ondisk format specification.
165	 */
166	XFS_CHECK_VALUE(XFS_BIGTIME_TIME_MIN - XFS_BIGTIME_EPOCH_OFFSET,
167			XFS_LEGACY_TIME_MIN);
168	XFS_CHECK_VALUE(XFS_BIGTIME_TIME_MAX - XFS_BIGTIME_EPOCH_OFFSET,
169			16299260424LL);
170
171	/* Do the same with the incore quota expiration range. */
172	XFS_CHECK_VALUE(XFS_DQ_BIGTIME_EXPIRY_MIN << XFS_DQ_BIGTIME_SHIFT, 4);
173	XFS_CHECK_VALUE(XFS_DQ_BIGTIME_EXPIRY_MAX << XFS_DQ_BIGTIME_SHIFT,
174			16299260424LL);
175}
176
177#endif /* __XFS_ONDISK_H */
178