1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun * Copyright (c) 2000-2005 Silicon Graphics, Inc. 4*4882a593Smuzhiyun * Copyright (c) 2013 Red Hat, Inc. 5*4882a593Smuzhiyun * All Rights Reserved. 6*4882a593Smuzhiyun */ 7*4882a593Smuzhiyun #ifndef __XFS_SHARED_H__ 8*4882a593Smuzhiyun #define __XFS_SHARED_H__ 9*4882a593Smuzhiyun 10*4882a593Smuzhiyun /* 11*4882a593Smuzhiyun * Definitions shared between kernel and userspace that don't fit into any other 12*4882a593Smuzhiyun * header file that is shared with userspace. 13*4882a593Smuzhiyun */ 14*4882a593Smuzhiyun struct xfs_ifork; 15*4882a593Smuzhiyun struct xfs_buf; 16*4882a593Smuzhiyun struct xfs_buf_ops; 17*4882a593Smuzhiyun struct xfs_mount; 18*4882a593Smuzhiyun struct xfs_trans; 19*4882a593Smuzhiyun struct xfs_inode; 20*4882a593Smuzhiyun 21*4882a593Smuzhiyun /* 22*4882a593Smuzhiyun * Buffer verifier operations are widely used, including userspace tools 23*4882a593Smuzhiyun */ 24*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_agf_buf_ops; 25*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_agi_buf_ops; 26*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_agf_buf_ops; 27*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_agfl_buf_ops; 28*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_bnobt_buf_ops; 29*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_cntbt_buf_ops; 30*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_rmapbt_buf_ops; 31*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_refcountbt_buf_ops; 32*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_attr3_leaf_buf_ops; 33*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_attr3_rmt_buf_ops; 34*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_bmbt_buf_ops; 35*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_da3_node_buf_ops; 36*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_dquot_buf_ops; 37*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_symlink_buf_ops; 38*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_agi_buf_ops; 39*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_inobt_buf_ops; 40*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_finobt_buf_ops; 41*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_inode_buf_ops; 42*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_inode_buf_ra_ops; 43*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_dquot_buf_ops; 44*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_dquot_buf_ra_ops; 45*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_sb_buf_ops; 46*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_sb_quiet_buf_ops; 47*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_symlink_buf_ops; 48*4882a593Smuzhiyun extern const struct xfs_buf_ops xfs_rtbuf_ops; 49*4882a593Smuzhiyun 50*4882a593Smuzhiyun /* log size calculation functions */ 51*4882a593Smuzhiyun int xfs_log_calc_unit_res(struct xfs_mount *mp, int unit_bytes); 52*4882a593Smuzhiyun int xfs_log_calc_minimum_size(struct xfs_mount *); 53*4882a593Smuzhiyun 54*4882a593Smuzhiyun struct xfs_trans_res; 55*4882a593Smuzhiyun void xfs_log_get_max_trans_res(struct xfs_mount *mp, 56*4882a593Smuzhiyun struct xfs_trans_res *max_resp); 57*4882a593Smuzhiyun 58*4882a593Smuzhiyun /* 59*4882a593Smuzhiyun * Values for t_flags. 60*4882a593Smuzhiyun */ 61*4882a593Smuzhiyun #define XFS_TRANS_DIRTY 0x01 /* something needs to be logged */ 62*4882a593Smuzhiyun #define XFS_TRANS_SB_DIRTY 0x02 /* superblock is modified */ 63*4882a593Smuzhiyun #define XFS_TRANS_PERM_LOG_RES 0x04 /* xact took a permanent log res */ 64*4882a593Smuzhiyun #define XFS_TRANS_SYNC 0x08 /* make commit synchronous */ 65*4882a593Smuzhiyun #define XFS_TRANS_DQ_DIRTY 0x10 /* at least one dquot in trx dirty */ 66*4882a593Smuzhiyun #define XFS_TRANS_RESERVE 0x20 /* OK to use reserved data blocks */ 67*4882a593Smuzhiyun #define XFS_TRANS_NO_WRITECOUNT 0x40 /* do not elevate SB writecount */ 68*4882a593Smuzhiyun #define XFS_TRANS_RES_FDBLKS 0x80 /* reserve newly freed blocks */ 69*4882a593Smuzhiyun /* 70*4882a593Smuzhiyun * LOWMODE is used by the allocator to activate the lowspace algorithm - when 71*4882a593Smuzhiyun * free space is running low the extent allocator may choose to allocate an 72*4882a593Smuzhiyun * extent from an AG without leaving sufficient space for a btree split when 73*4882a593Smuzhiyun * inserting the new extent. In this case the allocator will enable the 74*4882a593Smuzhiyun * lowspace algorithm which is supposed to allow further allocations (such as 75*4882a593Smuzhiyun * btree splits and newroots) to allocate from sequential AGs. In order to 76*4882a593Smuzhiyun * avoid locking AGs out of order the lowspace algorithm will start searching 77*4882a593Smuzhiyun * for free space from AG 0. If the correct transaction reservations have been 78*4882a593Smuzhiyun * made then this algorithm will eventually find all the space it needs. 79*4882a593Smuzhiyun */ 80*4882a593Smuzhiyun #define XFS_TRANS_LOWMODE 0x100 /* allocate in low space mode */ 81*4882a593Smuzhiyun 82*4882a593Smuzhiyun /* 83*4882a593Smuzhiyun * Field values for xfs_trans_mod_sb. 84*4882a593Smuzhiyun */ 85*4882a593Smuzhiyun #define XFS_TRANS_SB_ICOUNT 0x00000001 86*4882a593Smuzhiyun #define XFS_TRANS_SB_IFREE 0x00000002 87*4882a593Smuzhiyun #define XFS_TRANS_SB_FDBLOCKS 0x00000004 88*4882a593Smuzhiyun #define XFS_TRANS_SB_RES_FDBLOCKS 0x00000008 89*4882a593Smuzhiyun #define XFS_TRANS_SB_FREXTENTS 0x00000010 90*4882a593Smuzhiyun #define XFS_TRANS_SB_RES_FREXTENTS 0x00000020 91*4882a593Smuzhiyun #define XFS_TRANS_SB_DBLOCKS 0x00000040 92*4882a593Smuzhiyun #define XFS_TRANS_SB_AGCOUNT 0x00000080 93*4882a593Smuzhiyun #define XFS_TRANS_SB_IMAXPCT 0x00000100 94*4882a593Smuzhiyun #define XFS_TRANS_SB_REXTSIZE 0x00000200 95*4882a593Smuzhiyun #define XFS_TRANS_SB_RBMBLOCKS 0x00000400 96*4882a593Smuzhiyun #define XFS_TRANS_SB_RBLOCKS 0x00000800 97*4882a593Smuzhiyun #define XFS_TRANS_SB_REXTENTS 0x00001000 98*4882a593Smuzhiyun #define XFS_TRANS_SB_REXTSLOG 0x00002000 99*4882a593Smuzhiyun 100*4882a593Smuzhiyun /* 101*4882a593Smuzhiyun * Here we centralize the specification of XFS meta-data buffer reference count 102*4882a593Smuzhiyun * values. This determines how hard the buffer cache tries to hold onto the 103*4882a593Smuzhiyun * buffer. 104*4882a593Smuzhiyun */ 105*4882a593Smuzhiyun #define XFS_AGF_REF 4 106*4882a593Smuzhiyun #define XFS_AGI_REF 4 107*4882a593Smuzhiyun #define XFS_AGFL_REF 3 108*4882a593Smuzhiyun #define XFS_INO_BTREE_REF 3 109*4882a593Smuzhiyun #define XFS_ALLOC_BTREE_REF 2 110*4882a593Smuzhiyun #define XFS_BMAP_BTREE_REF 2 111*4882a593Smuzhiyun #define XFS_RMAP_BTREE_REF 2 112*4882a593Smuzhiyun #define XFS_DIR_BTREE_REF 2 113*4882a593Smuzhiyun #define XFS_INO_REF 2 114*4882a593Smuzhiyun #define XFS_ATTR_BTREE_REF 1 115*4882a593Smuzhiyun #define XFS_DQUOT_REF 1 116*4882a593Smuzhiyun #define XFS_REFC_BTREE_REF 1 117*4882a593Smuzhiyun #define XFS_SSB_REF 0 118*4882a593Smuzhiyun 119*4882a593Smuzhiyun /* 120*4882a593Smuzhiyun * Flags for xfs_trans_ichgtime(). 121*4882a593Smuzhiyun */ 122*4882a593Smuzhiyun #define XFS_ICHGTIME_MOD 0x1 /* data fork modification timestamp */ 123*4882a593Smuzhiyun #define XFS_ICHGTIME_CHG 0x2 /* inode field change timestamp */ 124*4882a593Smuzhiyun #define XFS_ICHGTIME_CREATE 0x4 /* inode create timestamp */ 125*4882a593Smuzhiyun 126*4882a593Smuzhiyun 127*4882a593Smuzhiyun /* 128*4882a593Smuzhiyun * Symlink decoding/encoding functions 129*4882a593Smuzhiyun */ 130*4882a593Smuzhiyun int xfs_symlink_blocks(struct xfs_mount *mp, int pathlen); 131*4882a593Smuzhiyun int xfs_symlink_hdr_set(struct xfs_mount *mp, xfs_ino_t ino, uint32_t offset, 132*4882a593Smuzhiyun uint32_t size, struct xfs_buf *bp); 133*4882a593Smuzhiyun bool xfs_symlink_hdr_ok(xfs_ino_t ino, uint32_t offset, 134*4882a593Smuzhiyun uint32_t size, struct xfs_buf *bp); 135*4882a593Smuzhiyun void xfs_symlink_local_to_remote(struct xfs_trans *tp, struct xfs_buf *bp, 136*4882a593Smuzhiyun struct xfs_inode *ip, struct xfs_ifork *ifp); 137*4882a593Smuzhiyun xfs_failaddr_t xfs_symlink_shortform_verify(struct xfs_inode *ip); 138*4882a593Smuzhiyun 139*4882a593Smuzhiyun /* Computed inode geometry for the filesystem. */ 140*4882a593Smuzhiyun struct xfs_ino_geometry { 141*4882a593Smuzhiyun /* Maximum inode count in this filesystem. */ 142*4882a593Smuzhiyun uint64_t maxicount; 143*4882a593Smuzhiyun 144*4882a593Smuzhiyun /* Actual inode cluster buffer size, in bytes. */ 145*4882a593Smuzhiyun unsigned int inode_cluster_size; 146*4882a593Smuzhiyun 147*4882a593Smuzhiyun /* 148*4882a593Smuzhiyun * Desired inode cluster buffer size, in bytes. This value is not 149*4882a593Smuzhiyun * rounded up to at least one filesystem block, which is necessary for 150*4882a593Smuzhiyun * the sole purpose of validating sb_spino_align. Runtime code must 151*4882a593Smuzhiyun * only ever use inode_cluster_size. 152*4882a593Smuzhiyun */ 153*4882a593Smuzhiyun unsigned int inode_cluster_size_raw; 154*4882a593Smuzhiyun 155*4882a593Smuzhiyun /* Inode cluster sizes, adjusted to be at least 1 fsb. */ 156*4882a593Smuzhiyun unsigned int inodes_per_cluster; 157*4882a593Smuzhiyun unsigned int blocks_per_cluster; 158*4882a593Smuzhiyun 159*4882a593Smuzhiyun /* Inode cluster alignment. */ 160*4882a593Smuzhiyun unsigned int cluster_align; 161*4882a593Smuzhiyun unsigned int cluster_align_inodes; 162*4882a593Smuzhiyun unsigned int inoalign_mask; /* mask sb_inoalignmt if used */ 163*4882a593Smuzhiyun 164*4882a593Smuzhiyun unsigned int inobt_mxr[2]; /* max inobt btree records */ 165*4882a593Smuzhiyun unsigned int inobt_mnr[2]; /* min inobt btree records */ 166*4882a593Smuzhiyun unsigned int inobt_maxlevels; /* max inobt btree levels. */ 167*4882a593Smuzhiyun 168*4882a593Smuzhiyun /* Size of inode allocations under normal operation. */ 169*4882a593Smuzhiyun unsigned int ialloc_inos; 170*4882a593Smuzhiyun unsigned int ialloc_blks; 171*4882a593Smuzhiyun 172*4882a593Smuzhiyun /* Minimum inode blocks for a sparse allocation. */ 173*4882a593Smuzhiyun unsigned int ialloc_min_blks; 174*4882a593Smuzhiyun 175*4882a593Smuzhiyun /* stripe unit inode alignment */ 176*4882a593Smuzhiyun unsigned int ialloc_align; 177*4882a593Smuzhiyun 178*4882a593Smuzhiyun unsigned int agino_log; /* #bits for agino in inum */ 179*4882a593Smuzhiyun 180*4882a593Smuzhiyun /* precomputed value for di_flags2 */ 181*4882a593Smuzhiyun uint64_t new_diflags2; 182*4882a593Smuzhiyun }; 183*4882a593Smuzhiyun 184*4882a593Smuzhiyun #endif /* __XFS_SHARED_H__ */ 185