libxfs/xfs_types.h

   1 /*
   2  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
   3  * All Rights Reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it would be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write the Free Software Foundation,
  16  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  */
  18 #ifndef __XFS_TYPES_H__
  19 #define __XFS_TYPES_H__
  20
  21 typedef uint32_t        prid_t;         /* project ID */
  22
  23 typedef uint32_t        xfs_agblock_t;  /* blockno in alloc. group */
  24 typedef uint32_t        xfs_agino_t;    /* inode # within allocation grp */
  25 typedef uint32_t        xfs_extlen_t;   /* extent length in blocks */
  26 typedef uint32_t        xfs_agnumber_t; /* allocation group number */
  27 typedef int32_t         xfs_extnum_t;   /* # of extents in a file */
  28 typedef int16_t         xfs_aextnum_t;  /* # extents in an attribute fork */
  29 typedef int64_t         xfs_fsize_t;    /* bytes in a file */
  30 typedef uint64_t        xfs_ufsize_t;   /* unsigned bytes in a file */
  31
  32 typedef int32_t         xfs_suminfo_t;  /* type of bitmap summary info */
  33 typedef int32_t         xfs_rtword_t;   /* word type for bitmap manipulations */
  34
  35 typedef int64_t         xfs_lsn_t;      /* log sequence number */
  36 typedef int32_t         xfs_tid_t;      /* transaction identifier */
  37
  38 typedef uint32_t        xfs_dablk_t;    /* dir/attr block number (in file) */
  39 typedef uint32_t        xfs_dahash_t;   /* dir/attr hash value */
  40
  41 typedef uint64_t        xfs_fsblock_t;  /* blockno in filesystem (agno|agbno) */
  42 typedef uint64_t        xfs_rfsblock_t; /* blockno in filesystem (raw) */
  43 typedef uint64_t        xfs_rtblock_t;  /* extent (block) in realtime area */
  44 typedef uint64_t        xfs_fileoff_t;  /* block number in a file */
  45 typedef uint64_t        xfs_filblks_t;  /* number of blocks in a file */
  46
  47 typedef int64_t         xfs_srtblock_t; /* signed version of xfs_rtblock_t */
  48 typedef int64_t         xfs_sfiloff_t;  /* signed block number in a file */
  49
  50 /*
  51  * New verifiers will return the instruction address of the failing check.
  52  * NULL means everything is ok.
  53  */
  54 typedef void *          xfs_failaddr_t;
  55
  56 /*
  57  * Null values for the types.
  58  */
  59 #define NULLFSBLOCK     ((xfs_fsblock_t)-1)
  60 #define NULLRFSBLOCK    ((xfs_rfsblock_t)-1)
  61 #define NULLRTBLOCK     ((xfs_rtblock_t)-1)
  62 #define NULLFILEOFF     ((xfs_fileoff_t)-1)
  63
  64 #define NULLAGBLOCK     ((xfs_agblock_t)-1)
  65 #define NULLAGNUMBER    ((xfs_agnumber_t)-1)
  66
  67 #define NULLCOMMITLSN   ((xfs_lsn_t)-1)
  68
  69 #define NULLFSINO       ((xfs_ino_t)-1)
  70 #define NULLAGINO       ((xfs_agino_t)-1)
  71
  72 /*
  73  * Max values for extlen, extnum, aextnum.
  74  */
  75 #define MAXEXTLEN       ((xfs_extlen_t)0x001fffff)      /* 21 bits */
  76 #define MAXEXTNUM       ((xfs_extnum_t)0x7fffffff)      /* signed int */
  77 #define MAXAEXTNUM      ((xfs_aextnum_t)0x7fff)         /* signed short */
  78
  79 /*
  80  * Minimum and maximum blocksize and sectorsize.
  81  * The blocksize upper limit is pretty much arbitrary.
  82  * The sectorsize upper limit is due to sizeof(sb_sectsize).
  83  * CRC enable filesystems use 512 byte inodes, meaning 512 byte block sizes
  84  * cannot be used.
  85  */
  86 #define XFS_MIN_BLOCKSIZE_LOG   9       /* i.e. 512 bytes */
  87 #define XFS_MAX_BLOCKSIZE_LOG   16      /* i.e. 65536 bytes */
  88 #define XFS_MIN_BLOCKSIZE       (1 << XFS_MIN_BLOCKSIZE_LOG)
  89 #define XFS_MAX_BLOCKSIZE       (1 << XFS_MAX_BLOCKSIZE_LOG)
  90 #define XFS_MIN_CRC_BLOCKSIZE   (1 << (XFS_MIN_BLOCKSIZE_LOG + 1))
  91 #define XFS_MIN_SECTORSIZE_LOG  9       /* i.e. 512 bytes */
  92 #define XFS_MAX_SECTORSIZE_LOG  15      /* i.e. 32768 bytes */
  93 #define XFS_MIN_SECTORSIZE      (1 << XFS_MIN_SECTORSIZE_LOG)
  94 #define XFS_MAX_SECTORSIZE      (1 << XFS_MAX_SECTORSIZE_LOG)
  95
  96 /*
  97  * Inode fork identifiers.
  98  */
  99 #define XFS_DATA_FORK   0
 100 #define XFS_ATTR_FORK   1
 101 #define XFS_COW_FORK    2
 102
 103 /*
 104  * Min numbers of data/attr fork btree root pointers.
 105  */
 106 #define MINDBTPTRS      3
 107 #define MINABTPTRS      2
 108
 109 /*
 110  * MAXNAMELEN is the length (including the terminating null) of
 111  * the longest permissible file (component) name.
 112  */
 113 #define MAXNAMELEN      256
 114
 115 typedef enum {
 116         XFS_LOOKUP_EQi, XFS_LOOKUP_LEi, XFS_LOOKUP_GEi
 117 } xfs_lookup_t;
 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 struct xfs_name {
 125         const unsigned char     *name;
 126         int                     len;
 127         int                     type;
 128 };
 129
 130 /*
 131  * uid_t and gid_t are hard-coded to 32 bits in the inode.
 132  * Hence, an 'id' in a dquot is 32 bits..
 133  */
 134 typedef uint32_t        xfs_dqid_t;
 135
 136 /*
 137  * Constants for bit manipulations.
 138  */
 139 #define XFS_NBBYLOG     3               /* log2(NBBY) */
 140 #define XFS_WORDLOG     2               /* log2(sizeof(xfs_rtword_t)) */
 141 #define XFS_NBWORDLOG   (XFS_NBBYLOG + XFS_WORDLOG)
 142 #define XFS_NBWORD      (1 << XFS_NBWORDLOG)
 143 #define XFS_WORDMASK    ((1 << XFS_WORDLOG) - 1)
 144
 145 struct xfs_iext_cursor {
 146         struct xfs_iext_leaf    *leaf;
 147         int                     pos;
 148 };
 149
 150 typedef enum {
 151         XFS_EXT_NORM, XFS_EXT_UNWRITTEN,
 152 } xfs_exntst_t;
 153
 154 typedef struct xfs_bmbt_irec
 155 {
 156         xfs_fileoff_t   br_startoff;    /* starting file offset */
 157         xfs_fsblock_t   br_startblock;  /* starting block number */
 158         xfs_filblks_t   br_blockcount;  /* number of blocks */
 159         xfs_exntst_t    br_state;       /* extent state */
 160 } xfs_bmbt_irec_t;
 161
 162 #endif  /* __XFS_TYPES_H__ */