fs/xfs/xfs_ondisk.h

0001 // SPDX-License-Identifier: GPL-2.0
0002 /*
0003  * Copyright (c) 2016 Oracle.
0004  * All Rights Reserved.
0005  */
0006 #ifndef __XFS_ONDISK_H
0007 #define __XFS_ONDISK_H
0008
0009 #define XFS_CHECK_STRUCT_SIZE(structname, size) \
0010     BUILD_BUG_ON_MSG(sizeof(structname) != (size), "XFS: sizeof(" \
0011         #structname ") is wrong, expected " #size)
0012
0013 #define XFS_CHECK_OFFSET(structname, member, off) \
0014     BUILD_BUG_ON_MSG(offsetof(structname, member) != (off), \
0015         "XFS: offsetof(" #structname ", " #member ") is wrong, " \
0016         "expected " #off)
0017
0018 #define XFS_CHECK_VALUE(value, expected) \
0019     BUILD_BUG_ON_MSG((value) != (expected), \
0020         "XFS: value of " #value " is wrong, expected " #expected)
0021
0022 static inline void __init
0023 xfs_check_ondisk_structs(void)
0024 {
0025     /* ag/file structures */
0026     XFS_CHECK_STRUCT_SIZE(struct xfs_acl,           4);
0027     XFS_CHECK_STRUCT_SIZE(struct xfs_acl_entry,     12);
0028     XFS_CHECK_STRUCT_SIZE(struct xfs_agf,           224);
0029     XFS_CHECK_STRUCT_SIZE(struct xfs_agfl,          36);
0030     XFS_CHECK_STRUCT_SIZE(struct xfs_agi,           344);
0031     XFS_CHECK_STRUCT_SIZE(struct xfs_bmbt_key,      8);
0032     XFS_CHECK_STRUCT_SIZE(struct xfs_bmbt_rec,      16);
0033     XFS_CHECK_STRUCT_SIZE(struct xfs_bmdr_block,        4);
0034     XFS_CHECK_STRUCT_SIZE(struct xfs_btree_block_shdr,  48);
0035     XFS_CHECK_STRUCT_SIZE(struct xfs_btree_block_lhdr,  64);
0036     XFS_CHECK_STRUCT_SIZE(struct xfs_btree_block,       72);
0037     XFS_CHECK_STRUCT_SIZE(struct xfs_dinode,        176);
0038     XFS_CHECK_STRUCT_SIZE(struct xfs_disk_dquot,        104);
0039     XFS_CHECK_STRUCT_SIZE(struct xfs_dqblk,         136);
0040     XFS_CHECK_STRUCT_SIZE(struct xfs_dsb,           264);
0041     XFS_CHECK_STRUCT_SIZE(struct xfs_dsymlink_hdr,      56);
0042     XFS_CHECK_STRUCT_SIZE(struct xfs_inobt_key,     4);
0043     XFS_CHECK_STRUCT_SIZE(struct xfs_inobt_rec,     16);
0044     XFS_CHECK_STRUCT_SIZE(struct xfs_refcount_key,      4);
0045     XFS_CHECK_STRUCT_SIZE(struct xfs_refcount_rec,      12);
0046     XFS_CHECK_STRUCT_SIZE(struct xfs_rmap_key,      20);
0047     XFS_CHECK_STRUCT_SIZE(struct xfs_rmap_rec,      24);
0048     XFS_CHECK_STRUCT_SIZE(xfs_timestamp_t,          8);
0049     XFS_CHECK_STRUCT_SIZE(struct xfs_legacy_timestamp,  8);
0050     XFS_CHECK_STRUCT_SIZE(xfs_alloc_key_t,          8);
0051     XFS_CHECK_STRUCT_SIZE(xfs_alloc_ptr_t,          4);
0052     XFS_CHECK_STRUCT_SIZE(xfs_alloc_rec_t,          8);
0053     XFS_CHECK_STRUCT_SIZE(xfs_inobt_ptr_t,          4);
0054     XFS_CHECK_STRUCT_SIZE(xfs_refcount_ptr_t,       4);
0055     XFS_CHECK_STRUCT_SIZE(xfs_rmap_ptr_t,           4);
0056
0057     /* dir/attr trees */
0058     XFS_CHECK_STRUCT_SIZE(struct xfs_attr3_leaf_hdr,    80);
0059     XFS_CHECK_STRUCT_SIZE(struct xfs_attr3_leafblock,   88);
0060     XFS_CHECK_STRUCT_SIZE(struct xfs_attr3_rmt_hdr,     56);
0061     XFS_CHECK_STRUCT_SIZE(struct xfs_da3_blkinfo,       56);
0062     XFS_CHECK_STRUCT_SIZE(struct xfs_da3_intnode,       64);
0063     XFS_CHECK_STRUCT_SIZE(struct xfs_da3_node_hdr,      64);
0064     XFS_CHECK_STRUCT_SIZE(struct xfs_dir3_blk_hdr,      48);
0065     XFS_CHECK_STRUCT_SIZE(struct xfs_dir3_data_hdr,     64);
0066     XFS_CHECK_STRUCT_SIZE(struct xfs_dir3_free,     64);
0067     XFS_CHECK_STRUCT_SIZE(struct xfs_dir3_free_hdr,     64);
0068     XFS_CHECK_STRUCT_SIZE(struct xfs_dir3_leaf,     64);
0069     XFS_CHECK_STRUCT_SIZE(struct xfs_dir3_leaf_hdr,     64);
0070     XFS_CHECK_STRUCT_SIZE(xfs_attr_leaf_entry_t,        8);
0071     XFS_CHECK_STRUCT_SIZE(xfs_attr_leaf_hdr_t,      32);
0072     XFS_CHECK_STRUCT_SIZE(xfs_attr_leaf_map_t,      4);
0073     XFS_CHECK_STRUCT_SIZE(xfs_attr_leaf_name_local_t,   4);
0074
0075     /*
0076      * m68k has problems with xfs_attr_leaf_name_remote_t, but we pad it to
0077      * 4 bytes anyway so it's not obviously a problem.  Hence for the moment
0078      * we don't check this structure. This can be re-instated when the attr
0079      * definitions are updated to use c99 VLA definitions.
0080      *
0081     XFS_CHECK_STRUCT_SIZE(xfs_attr_leaf_name_remote_t,  12);
0082      */
0083
0084     XFS_CHECK_OFFSET(xfs_attr_leaf_name_local_t, valuelen,  0);
0085     XFS_CHECK_OFFSET(xfs_attr_leaf_name_local_t, namelen,   2);
0086     XFS_CHECK_OFFSET(xfs_attr_leaf_name_local_t, nameval,   3);
0087     XFS_CHECK_OFFSET(xfs_attr_leaf_name_remote_t, valueblk, 0);
0088     XFS_CHECK_OFFSET(xfs_attr_leaf_name_remote_t, valuelen, 4);
0089     XFS_CHECK_OFFSET(xfs_attr_leaf_name_remote_t, namelen,  8);
0090     XFS_CHECK_OFFSET(xfs_attr_leaf_name_remote_t, name, 9);
0091     XFS_CHECK_STRUCT_SIZE(xfs_attr_leafblock_t,     40);
0092     XFS_CHECK_OFFSET(struct xfs_attr_shortform, hdr.totsize, 0);
0093     XFS_CHECK_OFFSET(struct xfs_attr_shortform, hdr.count,   2);
0094     XFS_CHECK_OFFSET(struct xfs_attr_shortform, list[0].namelen,    4);
0095     XFS_CHECK_OFFSET(struct xfs_attr_shortform, list[0].valuelen,   5);
0096     XFS_CHECK_OFFSET(struct xfs_attr_shortform, list[0].flags,  6);
0097     XFS_CHECK_OFFSET(struct xfs_attr_shortform, list[0].nameval,    7);
0098     XFS_CHECK_STRUCT_SIZE(xfs_da_blkinfo_t,         12);
0099     XFS_CHECK_STRUCT_SIZE(xfs_da_intnode_t,         16);
0100     XFS_CHECK_STRUCT_SIZE(xfs_da_node_entry_t,      8);
0101     XFS_CHECK_STRUCT_SIZE(xfs_da_node_hdr_t,        16);
0102     XFS_CHECK_STRUCT_SIZE(xfs_dir2_data_free_t,     4);
0103     XFS_CHECK_STRUCT_SIZE(xfs_dir2_data_hdr_t,      16);
0104     XFS_CHECK_OFFSET(xfs_dir2_data_unused_t, freetag,   0);
0105     XFS_CHECK_OFFSET(xfs_dir2_data_unused_t, length,    2);
0106     XFS_CHECK_STRUCT_SIZE(xfs_dir2_free_hdr_t,      16);
0107     XFS_CHECK_STRUCT_SIZE(xfs_dir2_free_t,          16);
0108     XFS_CHECK_STRUCT_SIZE(xfs_dir2_leaf_entry_t,        8);
0109     XFS_CHECK_STRUCT_SIZE(xfs_dir2_leaf_hdr_t,      16);
0110     XFS_CHECK_STRUCT_SIZE(xfs_dir2_leaf_t,          16);
0111     XFS_CHECK_STRUCT_SIZE(xfs_dir2_leaf_tail_t,     4);
0112     XFS_CHECK_STRUCT_SIZE(xfs_dir2_sf_entry_t,      3);
0113     XFS_CHECK_OFFSET(xfs_dir2_sf_entry_t, namelen,      0);
0114     XFS_CHECK_OFFSET(xfs_dir2_sf_entry_t, offset,       1);
0115     XFS_CHECK_OFFSET(xfs_dir2_sf_entry_t, name,     3);
0116     XFS_CHECK_STRUCT_SIZE(xfs_dir2_sf_hdr_t,        10);
0117
0118     /* log structures */
0119     XFS_CHECK_STRUCT_SIZE(struct xfs_buf_log_format,    88);
0120     XFS_CHECK_STRUCT_SIZE(struct xfs_dq_logformat,      24);
0121     XFS_CHECK_STRUCT_SIZE(struct xfs_efd_log_format_32, 28);
0122     XFS_CHECK_STRUCT_SIZE(struct xfs_efd_log_format_64, 32);
0123     XFS_CHECK_STRUCT_SIZE(struct xfs_efi_log_format_32, 28);
0124     XFS_CHECK_STRUCT_SIZE(struct xfs_efi_log_format_64, 32);
0125     XFS_CHECK_STRUCT_SIZE(struct xfs_extent_32,     12);
0126     XFS_CHECK_STRUCT_SIZE(struct xfs_extent_64,     16);
0127     XFS_CHECK_STRUCT_SIZE(struct xfs_log_dinode,        176);
0128     XFS_CHECK_STRUCT_SIZE(struct xfs_icreate_log,       28);
0129     XFS_CHECK_STRUCT_SIZE(xfs_log_timestamp_t,      8);
0130     XFS_CHECK_STRUCT_SIZE(struct xfs_log_legacy_timestamp,  8);
0131     XFS_CHECK_STRUCT_SIZE(struct xfs_inode_log_format_32,   52);
0132     XFS_CHECK_STRUCT_SIZE(struct xfs_inode_log_format,  56);
0133     XFS_CHECK_STRUCT_SIZE(struct xfs_qoff_logformat,    20);
0134     XFS_CHECK_STRUCT_SIZE(struct xfs_trans_header,      16);
0135     XFS_CHECK_STRUCT_SIZE(struct xfs_attri_log_format,  40);
0136     XFS_CHECK_STRUCT_SIZE(struct xfs_attrd_log_format,  16);
0137
0138     /*
0139      * The v5 superblock format extended several v4 header structures with
0140      * additional data. While new fields are only accessible on v5
0141      * superblocks, it's important that the v5 structures place original v4
0142      * fields/headers in the correct location on-disk. For example, we must
0143      * be able to find magic values at the same location in certain blocks
0144      * regardless of superblock version.
0145      *
0146      * The following checks ensure that various v5 data structures place the
0147      * subset of v4 metadata associated with the same type of block at the
0148      * start of the on-disk block. If there is no data structure definition
0149      * for certain types of v4 blocks, traverse down to the first field of
0150      * common metadata (e.g., magic value) and make sure it is at offset
0151      * zero.
0152      */
0153     XFS_CHECK_OFFSET(struct xfs_dir3_leaf, hdr.info.hdr,    0);
0154     XFS_CHECK_OFFSET(struct xfs_da3_intnode, hdr.info.hdr,  0);
0155     XFS_CHECK_OFFSET(struct xfs_dir3_data_hdr, hdr.magic,   0);
0156     XFS_CHECK_OFFSET(struct xfs_dir3_free, hdr.hdr.magic,   0);
0157     XFS_CHECK_OFFSET(struct xfs_attr3_leafblock, hdr.info.hdr, 0);
0158
0159     XFS_CHECK_STRUCT_SIZE(struct xfs_bulkstat,      192);
0160     XFS_CHECK_STRUCT_SIZE(struct xfs_inumbers,      24);
0161     XFS_CHECK_STRUCT_SIZE(struct xfs_bulkstat_req,      64);
0162     XFS_CHECK_STRUCT_SIZE(struct xfs_inumbers_req,      64);
0163
0164     /*
0165      * Make sure the incore inode timestamp range corresponds to hand
0166      * converted values based on the ondisk format specification.
0167      */
0168     XFS_CHECK_VALUE(XFS_BIGTIME_TIME_MIN - XFS_BIGTIME_EPOCH_OFFSET,
0169             XFS_LEGACY_TIME_MIN);
0170     XFS_CHECK_VALUE(XFS_BIGTIME_TIME_MAX - XFS_BIGTIME_EPOCH_OFFSET,
0171             16299260424LL);
0172
0173     /* Do the same with the incore quota expiration range. */
0174     XFS_CHECK_VALUE(XFS_DQ_BIGTIME_EXPIRY_MIN << XFS_DQ_BIGTIME_SHIFT, 4);
0175     XFS_CHECK_VALUE(XFS_DQ_BIGTIME_EXPIRY_MAX << XFS_DQ_BIGTIME_SHIFT,
0176             16299260424LL);
0177 }
0178
0179 #endif /* __XFS_ONDISK_H */