fs/xfs/libxfs/xfs_types.h

   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_rtxlen_t;   /* file extent length in rtextents */
  15 typedef uint32_t        xfs_agnumber_t; /* allocation group number */
  16 typedef uint64_t        xfs_extnum_t;   /* # of extents in a file */
  17 typedef uint32_t        xfs_aextnum_t;  /* # extents in an attribute fork */
  18 typedef int64_t         xfs_fsize_t;    /* bytes in a file */
  19 typedef uint64_t        xfs_ufsize_t;   /* unsigned bytes in a file */
  20
  21 typedef int32_t         xfs_suminfo_t;  /* type of bitmap summary info */
  22 typedef uint32_t        xfs_rtword_t;   /* word type for bitmap manipulations */
  23
  24 typedef int64_t         xfs_lsn_t;      /* log sequence number */
  25 typedef int64_t         xfs_csn_t;      /* CIL sequence number */
  26
  27 typedef uint32_t        xfs_dablk_t;    /* dir/attr block number (in file) */
  28 typedef uint32_t        xfs_dahash_t;   /* dir/attr hash value */
  29
  30 typedef uint64_t        xfs_fsblock_t;  /* blockno in filesystem (agno|agbno) */
  31 typedef uint64_t        xfs_rfsblock_t; /* blockno in filesystem (raw) */
  32 typedef uint64_t        xfs_rtblock_t;  /* extent (block) in realtime area */
  33 typedef uint64_t        xfs_fileoff_t;  /* block number in a file */
  34 typedef uint64_t        xfs_filblks_t;  /* number of blocks in a file */
  35 typedef uint64_t        xfs_rtbxlen_t;  /* rtbitmap extent length in rtextents */
  36
  37 typedef int64_t         xfs_srtblock_t; /* signed version of xfs_rtblock_t */
  38
  39 /*
  40  * New verifiers will return the instruction address of the failing check.
  41  * NULL means everything is ok.
  42  */
  43 typedef void *          xfs_failaddr_t;
  44
  45 /*
  46  * Null values for the types.
  47  */
  48 #define NULLFSBLOCK     ((xfs_fsblock_t)-1)
  49 #define NULLRFSBLOCK    ((xfs_rfsblock_t)-1)
  50 #define NULLRTBLOCK     ((xfs_rtblock_t)-1)
  51 #define NULLFILEOFF     ((xfs_fileoff_t)-1)
  52
  53 #define NULLAGBLOCK     ((xfs_agblock_t)-1)
  54 #define NULLAGNUMBER    ((xfs_agnumber_t)-1)
  55
  56 #define NULLCOMMITLSN   ((xfs_lsn_t)-1)
  57
  58 #define NULLFSINO       ((xfs_ino_t)-1)
  59 #define NULLAGINO       ((xfs_agino_t)-1)
  60
  61 /*
  62  * Minimum and maximum blocksize and sectorsize.
  63  * The blocksize upper limit is pretty much arbitrary.
  64  * The sectorsize upper limit is due to sizeof(sb_sectsize).
  65  * CRC enable filesystems use 512 byte inodes, meaning 512 byte block sizes
  66  * cannot be used.
  67  */
  68 #define XFS_MIN_BLOCKSIZE_LOG   9       /* i.e. 512 bytes */
  69 #define XFS_MAX_BLOCKSIZE_LOG   16      /* i.e. 65536 bytes */
  70 #define XFS_MIN_BLOCKSIZE       (1 << XFS_MIN_BLOCKSIZE_LOG)
  71 #define XFS_MAX_BLOCKSIZE       (1 << XFS_MAX_BLOCKSIZE_LOG)
  72 #define XFS_MIN_CRC_BLOCKSIZE   (1 << (XFS_MIN_BLOCKSIZE_LOG + 1))
  73 #define XFS_MIN_SECTORSIZE_LOG  9       /* i.e. 512 bytes */
  74 #define XFS_MAX_SECTORSIZE_LOG  15      /* i.e. 32768 bytes */
  75 #define XFS_MIN_SECTORSIZE      (1 << XFS_MIN_SECTORSIZE_LOG)
  76 #define XFS_MAX_SECTORSIZE      (1 << XFS_MAX_SECTORSIZE_LOG)
  77
  78 /*
  79  * Inode fork identifiers.
  80  */
  81 #define XFS_DATA_FORK   0
  82 #define XFS_ATTR_FORK   1
  83 #define XFS_COW_FORK    2
  84
  85 #define XFS_WHICHFORK_STRINGS \
  86         { XFS_DATA_FORK,        "data" }, \
  87         { XFS_ATTR_FORK,        "attr" }, \
  88         { XFS_COW_FORK,         "cow" }
  89
  90 /*
  91  * Min numbers of data/attr fork btree root pointers.
  92  */
  93 #define MINDBTPTRS      3
  94 #define MINABTPTRS      2
  95
  96 /*
  97  * MAXNAMELEN is the length (including the terminating null) of
  98  * the longest permissible file (component) name.
  99  */
 100 #define MAXNAMELEN      256
 101
 102 /*
 103  * This enum is used in string mapping in xfs_trace.h; please keep the
 104  * TRACE_DEFINE_ENUMs for it up to date.
 105  */
 106 typedef enum {
 107         XFS_LOOKUP_EQi, XFS_LOOKUP_LEi, XFS_LOOKUP_GEi
 108 } xfs_lookup_t;
 109
 110 #define XFS_AG_BTREE_CMP_FORMAT_STR \
 111         { XFS_LOOKUP_EQi,       "eq" }, \
 112         { XFS_LOOKUP_LEi,       "le" }, \
 113         { XFS_LOOKUP_GEi,       "ge" }
 114
 115 /*
 116  * This enum is used in string mapping in xfs_trace.h and scrub/trace.h;
 117  * please keep the TRACE_DEFINE_ENUMs for it up to date.
 118  */
 119 typedef enum {
 120         XFS_BTNUM_BNOi, XFS_BTNUM_CNTi, XFS_BTNUM_RMAPi, XFS_BTNUM_BMAPi,
 121         XFS_BTNUM_INOi, XFS_BTNUM_FINOi, XFS_BTNUM_REFCi, XFS_BTNUM_MAX
 122 } xfs_btnum_t;
 123
 124 #define XFS_BTNUM_STRINGS \
 125         { XFS_BTNUM_BNOi,       "bnobt" }, \
 126         { XFS_BTNUM_CNTi,       "cntbt" }, \
 127         { XFS_BTNUM_RMAPi,      "rmapbt" }, \
 128         { XFS_BTNUM_BMAPi,      "bmbt" }, \
 129         { XFS_BTNUM_INOi,       "inobt" }, \
 130         { XFS_BTNUM_FINOi,      "finobt" }, \
 131         { XFS_BTNUM_REFCi,      "refcbt" }
 132
 133 struct xfs_name {
 134         const unsigned char     *name;
 135         int                     len;
 136         int                     type;
 137 };
 138
 139 /*
 140  * uid_t and gid_t are hard-coded to 32 bits in the inode.
 141  * Hence, an 'id' in a dquot is 32 bits..
 142  */
 143 typedef uint32_t        xfs_dqid_t;
 144
 145 /*
 146  * Constants for bit manipulations.
 147  */
 148 #define XFS_NBBYLOG     3               /* log2(NBBY) */
 149 #define XFS_WORDLOG     2               /* log2(sizeof(xfs_rtword_t)) */
 150 #define XFS_NBWORDLOG   (XFS_NBBYLOG + XFS_WORDLOG)
 151 #define XFS_NBWORD      (1 << XFS_NBWORDLOG)
 152 #define XFS_WORDMASK    ((1 << XFS_WORDLOG) - 1)
 153
 154 struct xfs_iext_cursor {
 155         struct xfs_iext_leaf    *leaf;
 156         int                     pos;
 157 };
 158
 159 typedef enum {
 160         XFS_EXT_NORM, XFS_EXT_UNWRITTEN,
 161 } xfs_exntst_t;
 162
 163 typedef struct xfs_bmbt_irec
 164 {
 165         xfs_fileoff_t   br_startoff;    /* starting file offset */
 166         xfs_fsblock_t   br_startblock;  /* starting block number */
 167         xfs_filblks_t   br_blockcount;  /* number of blocks */
 168         xfs_exntst_t    br_state;       /* extent state */
 169 } xfs_bmbt_irec_t;
 170
 171 enum xfs_refc_domain {
 172         XFS_REFC_DOMAIN_SHARED = 0,
 173         XFS_REFC_DOMAIN_COW,
 174 };
 175
 176 #define XFS_REFC_DOMAIN_STRINGS \
 177         { XFS_REFC_DOMAIN_SHARED,       "shared" }, \
 178         { XFS_REFC_DOMAIN_COW,          "cow" }
 179
 180 struct xfs_refcount_irec {
 181         xfs_agblock_t   rc_startblock;  /* starting block number */
 182         xfs_extlen_t    rc_blockcount;  /* count of free blocks */
 183         xfs_nlink_t     rc_refcount;    /* number of inodes linked here */
 184         enum xfs_refc_domain    rc_domain; /* shared or cow staging extent? */
 185 };
 186
 187 #define XFS_RMAP_ATTR_FORK              (1 << 0)
 188 #define XFS_RMAP_BMBT_BLOCK             (1 << 1)
 189 #define XFS_RMAP_UNWRITTEN              (1 << 2)
 190 #define XFS_RMAP_KEY_FLAGS              (XFS_RMAP_ATTR_FORK | \
 191                                          XFS_RMAP_BMBT_BLOCK)
 192 #define XFS_RMAP_REC_FLAGS              (XFS_RMAP_UNWRITTEN)
 193 struct xfs_rmap_irec {
 194         xfs_agblock_t   rm_startblock;  /* extent start block */
 195         xfs_extlen_t    rm_blockcount;  /* extent length */
 196         uint64_t        rm_owner;       /* extent owner */
 197         uint64_t        rm_offset;      /* offset within the owner */
 198         unsigned int    rm_flags;       /* state flags */
 199 };
 200
 201 /* per-AG block reservation types */
 202 enum xfs_ag_resv_type {
 203         XFS_AG_RESV_NONE = 0,
 204         XFS_AG_RESV_AGFL,
 205         XFS_AG_RESV_METADATA,
 206         XFS_AG_RESV_RMAPBT,
 207 };
 208
 209 /* Results of scanning a btree keyspace to check occupancy. */
 210 enum xbtree_recpacking {
 211         /* None of the keyspace maps to records. */
 212         XBTREE_RECPACKING_EMPTY = 0,
 213
 214         /* Some, but not all, of the keyspace maps to records. */
 215         XBTREE_RECPACKING_SPARSE,
 216
 217         /* The entire keyspace maps to records. */
 218         XBTREE_RECPACKING_FULL,
 219 };
 220
 221 /*
 222  * Type verifier functions
 223  */
 224 struct xfs_mount;
 225
 226 bool xfs_verify_fsbno(struct xfs_mount *mp, xfs_fsblock_t fsbno);
 227 bool xfs_verify_fsbext(struct xfs_mount *mp, xfs_fsblock_t fsbno,
 228                 xfs_fsblock_t len);
 229
 230 bool xfs_verify_ino(struct xfs_mount *mp, xfs_ino_t ino);
 231 bool xfs_internal_inum(struct xfs_mount *mp, xfs_ino_t ino);
 232 bool xfs_verify_dir_ino(struct xfs_mount *mp, xfs_ino_t ino);
 233 bool xfs_verify_rtbno(struct xfs_mount *mp, xfs_rtblock_t rtbno);
 234 bool xfs_verify_rtbext(struct xfs_mount *mp, xfs_rtblock_t rtbno,
 235                 xfs_filblks_t len);
 236 bool xfs_verify_icount(struct xfs_mount *mp, unsigned long long icount);
 237 bool xfs_verify_dablk(struct xfs_mount *mp, xfs_fileoff_t off);
 238 void xfs_icount_range(struct xfs_mount *mp, unsigned long long *min,
 239                 unsigned long long *max);
 240 bool xfs_verify_fileoff(struct xfs_mount *mp, xfs_fileoff_t off);
 241 bool xfs_verify_fileext(struct xfs_mount *mp, xfs_fileoff_t off,
 242                 xfs_fileoff_t len);
 243
 244 #endif  /* __XFS_TYPES_H__ */