1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Copyright (c) 2000-2005 Silicon Graphics, Inc. 4 * All Rights Reserved. 5 */ 6 #ifndef __XFS_TYPES_H__ 7 #define __XFS_TYPES_H__ 8 9 typedef uint32_t prid_t; /* project ID */ 10 11 typedef uint32_t xfs_agblock_t; /* blockno in alloc. group */ 12 typedef uint32_t xfs_agino_t; /* inode # within allocation grp */ 13 typedef uint32_t xfs_extlen_t; /* extent length in blocks */ 14 typedef uint32_t xfs_agnumber_t; /* allocation group number */ 15 typedef int32_t xfs_extnum_t; /* # of extents in a file */ 16 typedef int16_t xfs_aextnum_t; /* # extents in an attribute fork */ 17 typedef int64_t xfs_fsize_t; /* bytes in a file */ 18 typedef uint64_t xfs_ufsize_t; /* unsigned bytes in a file */ 19 20 typedef int32_t xfs_suminfo_t; /* type of bitmap summary info */ 21 typedef uint32_t xfs_rtword_t; /* word type for bitmap manipulations */ 22 23 typedef int64_t xfs_lsn_t; /* log sequence number */ 24 25 typedef uint32_t xfs_dablk_t; /* dir/attr block number (in file) */ 26 typedef uint32_t xfs_dahash_t; /* dir/attr hash value */ 27 28 typedef uint64_t xfs_fsblock_t; /* blockno in filesystem (agno|agbno) */ 29 typedef uint64_t xfs_rfsblock_t; /* blockno in filesystem (raw) */ 30 typedef uint64_t xfs_rtblock_t; /* extent (block) in realtime area */ 31 typedef uint64_t xfs_fileoff_t; /* block number in a file */ 32 typedef uint64_t xfs_filblks_t; /* number of blocks in a file */ 33 34 typedef int64_t xfs_srtblock_t; /* signed version of xfs_rtblock_t */ 35 36 /* 37 * New verifiers will return the instruction address of the failing check. 38 * NULL means everything is ok. 39 */ 40 typedef void * xfs_failaddr_t; 41 42 /* 43 * Null values for the types. 44 */ 45 #define NULLFSBLOCK ((xfs_fsblock_t)-1) 46 #define NULLRFSBLOCK ((xfs_rfsblock_t)-1) 47 #define NULLRTBLOCK ((xfs_rtblock_t)-1) 48 #define NULLFILEOFF ((xfs_fileoff_t)-1) 49 50 #define NULLAGBLOCK ((xfs_agblock_t)-1) 51 #define NULLAGNUMBER ((xfs_agnumber_t)-1) 52 53 #define NULLCOMMITLSN ((xfs_lsn_t)-1) 54 55 #define NULLFSINO ((xfs_ino_t)-1) 56 #define NULLAGINO ((xfs_agino_t)-1) 57 58 /* 59 * Max values for extlen, extnum, aextnum. 60 */ 61 #define MAXEXTLEN ((xfs_extlen_t)0x001fffff) /* 21 bits */ 62 #define MAXEXTNUM ((xfs_extnum_t)0x7fffffff) /* signed int */ 63 #define MAXAEXTNUM ((xfs_aextnum_t)0x7fff) /* signed short */ 64 65 /* 66 * Minimum and maximum blocksize and sectorsize. 67 * The blocksize upper limit is pretty much arbitrary. 68 * The sectorsize upper limit is due to sizeof(sb_sectsize). 69 * CRC enable filesystems use 512 byte inodes, meaning 512 byte block sizes 70 * cannot be used. 71 */ 72 #define XFS_MIN_BLOCKSIZE_LOG 9 /* i.e. 512 bytes */ 73 #define XFS_MAX_BLOCKSIZE_LOG 16 /* i.e. 65536 bytes */ 74 #define XFS_MIN_BLOCKSIZE (1 << XFS_MIN_BLOCKSIZE_LOG) 75 #define XFS_MAX_BLOCKSIZE (1 << XFS_MAX_BLOCKSIZE_LOG) 76 #define XFS_MIN_CRC_BLOCKSIZE (1 << (XFS_MIN_BLOCKSIZE_LOG + 1)) 77 #define XFS_MIN_SECTORSIZE_LOG 9 /* i.e. 512 bytes */ 78 #define XFS_MAX_SECTORSIZE_LOG 15 /* i.e. 32768 bytes */ 79 #define XFS_MIN_SECTORSIZE (1 << XFS_MIN_SECTORSIZE_LOG) 80 #define XFS_MAX_SECTORSIZE (1 << XFS_MAX_SECTORSIZE_LOG) 81 82 /* 83 * Inode fork identifiers. 84 */ 85 #define XFS_DATA_FORK 0 86 #define XFS_ATTR_FORK 1 87 #define XFS_COW_FORK 2 88 89 /* 90 * Min numbers of data/attr fork btree root pointers. 91 */ 92 #define MINDBTPTRS 3 93 #define MINABTPTRS 2 94 95 /* 96 * MAXNAMELEN is the length (including the terminating null) of 97 * the longest permissible file (component) name. 98 */ 99 #define MAXNAMELEN 256 100 101 /* 102 * This enum is used in string mapping in xfs_trace.h; please keep the 103 * TRACE_DEFINE_ENUMs for it up to date. 104 */ 105 typedef enum { 106 XFS_LOOKUP_EQi, XFS_LOOKUP_LEi, XFS_LOOKUP_GEi 107 } xfs_lookup_t; 108 109 #define XFS_AG_BTREE_CMP_FORMAT_STR \ 110 { XFS_LOOKUP_EQi, "eq" }, \ 111 { XFS_LOOKUP_LEi, "le" }, \ 112 { XFS_LOOKUP_GEi, "ge" } 113 114 /* 115 * This enum is used in string mapping in xfs_trace.h and scrub/trace.h; 116 * please keep the TRACE_DEFINE_ENUMs for it up to date. 117 */ 118 typedef enum { 119 XFS_BTNUM_BNOi, XFS_BTNUM_CNTi, XFS_BTNUM_RMAPi, XFS_BTNUM_BMAPi, 120 XFS_BTNUM_INOi, XFS_BTNUM_FINOi, XFS_BTNUM_REFCi, XFS_BTNUM_MAX 121 } xfs_btnum_t; 122 123 #define XFS_BTNUM_STRINGS \ 124 { XFS_BTNUM_BNOi, "bnobt" }, \ 125 { XFS_BTNUM_CNTi, "cntbt" }, \ 126 { XFS_BTNUM_RMAPi, "rmapbt" }, \ 127 { XFS_BTNUM_BMAPi, "bmbt" }, \ 128 { XFS_BTNUM_INOi, "inobt" }, \ 129 { XFS_BTNUM_FINOi, "finobt" }, \ 130 { XFS_BTNUM_REFCi, "refcbt" } 131 132 struct xfs_name { 133 const unsigned char *name; 134 int len; 135 int type; 136 }; 137 138 /* 139 * uid_t and gid_t are hard-coded to 32 bits in the inode. 140 * Hence, an 'id' in a dquot is 32 bits.. 141 */ 142 typedef uint32_t xfs_dqid_t; 143 144 /* 145 * Constants for bit manipulations. 146 */ 147 #define XFS_NBBYLOG 3 /* log2(NBBY) */ 148 #define XFS_WORDLOG 2 /* log2(sizeof(xfs_rtword_t)) */ 149 #define XFS_NBWORDLOG (XFS_NBBYLOG + XFS_WORDLOG) 150 #define XFS_NBWORD (1 << XFS_NBWORDLOG) 151 #define XFS_WORDMASK ((1 << XFS_WORDLOG) - 1) 152 153 struct xfs_iext_cursor { 154 struct xfs_iext_leaf *leaf; 155 int pos; 156 }; 157 158 typedef enum { 159 XFS_EXT_NORM, XFS_EXT_UNWRITTEN, 160 } xfs_exntst_t; 161 162 typedef struct xfs_bmbt_irec 163 { 164 xfs_fileoff_t br_startoff; /* starting file offset */ 165 xfs_fsblock_t br_startblock; /* starting block number */ 166 xfs_filblks_t br_blockcount; /* number of blocks */ 167 xfs_exntst_t br_state; /* extent state */ 168 } xfs_bmbt_irec_t; 169 170 /* per-AG block reservation types */ 171 enum xfs_ag_resv_type { 172 XFS_AG_RESV_NONE = 0, 173 XFS_AG_RESV_AGFL, 174 XFS_AG_RESV_METADATA, 175 XFS_AG_RESV_RMAPBT, 176 }; 177 178 /* 179 * Type verifier functions 180 */ 181 struct xfs_mount; 182 183 xfs_agblock_t xfs_ag_block_count(struct xfs_mount *mp, xfs_agnumber_t agno); 184 bool xfs_verify_agbno(struct xfs_mount *mp, xfs_agnumber_t agno, 185 xfs_agblock_t agbno); 186 bool xfs_verify_fsbno(struct xfs_mount *mp, xfs_fsblock_t fsbno); 187 bool xfs_verify_fsbext(struct xfs_mount *mp, xfs_fsblock_t fsbno, 188 xfs_fsblock_t len); 189 190 void xfs_agino_range(struct xfs_mount *mp, xfs_agnumber_t agno, 191 xfs_agino_t *first, xfs_agino_t *last); 192 bool xfs_verify_agino(struct xfs_mount *mp, xfs_agnumber_t agno, 193 xfs_agino_t agino); 194 bool xfs_verify_agino_or_null(struct xfs_mount *mp, xfs_agnumber_t agno, 195 xfs_agino_t agino); 196 bool xfs_verify_ino(struct xfs_mount *mp, xfs_ino_t ino); 197 bool xfs_internal_inum(struct xfs_mount *mp, xfs_ino_t ino); 198 bool xfs_verify_dir_ino(struct xfs_mount *mp, xfs_ino_t ino); 199 bool xfs_verify_rtbno(struct xfs_mount *mp, xfs_rtblock_t rtbno); 200 bool xfs_verify_rtext(struct xfs_mount *mp, xfs_rtblock_t rtbno, 201 xfs_rtblock_t len); 202 bool xfs_verify_icount(struct xfs_mount *mp, unsigned long long icount); 203 bool xfs_verify_dablk(struct xfs_mount *mp, xfs_fileoff_t off); 204 void xfs_icount_range(struct xfs_mount *mp, unsigned long long *min, 205 unsigned long long *max); 206 bool xfs_verify_fileoff(struct xfs_mount *mp, xfs_fileoff_t off); 207 bool xfs_verify_fileext(struct xfs_mount *mp, xfs_fileoff_t off, 208 xfs_fileoff_t len); 209 210 #endif /* __XFS_TYPES_H__ */ 211