GNU Linux-libre 4.14.259-gnu1
[releases.git] / fs / xfs / 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  * Null values for the types.
52  */
53 #define NULLFSBLOCK     ((xfs_fsblock_t)-1)
54 #define NULLRFSBLOCK    ((xfs_rfsblock_t)-1)
55 #define NULLRTBLOCK     ((xfs_rtblock_t)-1)
56 #define NULLFILEOFF     ((xfs_fileoff_t)-1)
57
58 #define NULLAGBLOCK     ((xfs_agblock_t)-1)
59 #define NULLAGNUMBER    ((xfs_agnumber_t)-1)
60
61 #define NULLCOMMITLSN   ((xfs_lsn_t)-1)
62
63 #define NULLFSINO       ((xfs_ino_t)-1)
64 #define NULLAGINO       ((xfs_agino_t)-1)
65
66 /*
67  * Max values for extlen, extnum, aextnum.
68  */
69 #define MAXEXTLEN       ((xfs_extlen_t)0x001fffff)      /* 21 bits */
70 #define MAXEXTNUM       ((xfs_extnum_t)0x7fffffff)      /* signed int */
71 #define MAXAEXTNUM      ((xfs_aextnum_t)0x7fff)         /* signed short */
72
73 /*
74  * Minimum and maximum blocksize and sectorsize.
75  * The blocksize upper limit is pretty much arbitrary.
76  * The sectorsize upper limit is due to sizeof(sb_sectsize).
77  * CRC enable filesystems use 512 byte inodes, meaning 512 byte block sizes
78  * cannot be used.
79  */
80 #define XFS_MIN_BLOCKSIZE_LOG   9       /* i.e. 512 bytes */
81 #define XFS_MAX_BLOCKSIZE_LOG   16      /* i.e. 65536 bytes */
82 #define XFS_MIN_BLOCKSIZE       (1 << XFS_MIN_BLOCKSIZE_LOG)
83 #define XFS_MAX_BLOCKSIZE       (1 << XFS_MAX_BLOCKSIZE_LOG)
84 #define XFS_MIN_CRC_BLOCKSIZE   (1 << (XFS_MIN_BLOCKSIZE_LOG + 1))
85 #define XFS_MIN_SECTORSIZE_LOG  9       /* i.e. 512 bytes */
86 #define XFS_MAX_SECTORSIZE_LOG  15      /* i.e. 32768 bytes */
87 #define XFS_MIN_SECTORSIZE      (1 << XFS_MIN_SECTORSIZE_LOG)
88 #define XFS_MAX_SECTORSIZE      (1 << XFS_MAX_SECTORSIZE_LOG)
89
90 /*
91  * Inode fork identifiers.
92  */
93 #define XFS_DATA_FORK   0
94 #define XFS_ATTR_FORK   1
95 #define XFS_COW_FORK    2
96
97 /*
98  * Min numbers of data/attr fork btree root pointers.
99  */
100 #define MINDBTPTRS      3
101 #define MINABTPTRS      2
102
103 /*
104  * MAXNAMELEN is the length (including the terminating null) of
105  * the longest permissible file (component) name.
106  */
107 #define MAXNAMELEN      256
108
109 typedef enum {
110         XFS_LOOKUP_EQi, XFS_LOOKUP_LEi, XFS_LOOKUP_GEi
111 } xfs_lookup_t;
112
113 typedef enum {
114         XFS_BTNUM_BNOi, XFS_BTNUM_CNTi, XFS_BTNUM_RMAPi, XFS_BTNUM_BMAPi,
115         XFS_BTNUM_INOi, XFS_BTNUM_FINOi, XFS_BTNUM_REFCi, XFS_BTNUM_MAX
116 } xfs_btnum_t;
117
118 struct xfs_name {
119         const unsigned char     *name;
120         int                     len;
121         int                     type;
122 };
123
124 /*
125  * uid_t and gid_t are hard-coded to 32 bits in the inode.
126  * Hence, an 'id' in a dquot is 32 bits..
127  */
128 typedef uint32_t        xfs_dqid_t;
129
130 /*
131  * Constants for bit manipulations.
132  */
133 #define XFS_NBBYLOG     3               /* log2(NBBY) */
134 #define XFS_WORDLOG     2               /* log2(sizeof(xfs_rtword_t)) */
135 #define XFS_NBWORDLOG   (XFS_NBBYLOG + XFS_WORDLOG)
136 #define XFS_NBWORD      (1 << XFS_NBWORDLOG)
137 #define XFS_WORDMASK    ((1 << XFS_WORDLOG) - 1)
138
139
140 #endif  /* __XFS_TYPES_H__ */