Cleanup macros for distinguishing mandatory locks
[linux-3.10.git] / fs / xfs / xfs_ag.h
1 /*
2  * Copyright (c) 2000-2003,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_AG_H__
19 #define __XFS_AG_H__
20
21 /*
22  * Allocation group header
23  * This is divided into three structures, placed in sequential 512-byte
24  * buffers after a copy of the superblock (also in a 512-byte buffer).
25  */
26
27 struct xfs_buf;
28 struct xfs_mount;
29 struct xfs_trans;
30
31 #define XFS_AGF_MAGIC   0x58414746      /* 'XAGF' */
32 #define XFS_AGI_MAGIC   0x58414749      /* 'XAGI' */
33 #define XFS_AGF_VERSION 1
34 #define XFS_AGI_VERSION 1
35
36 #define XFS_AGF_GOOD_VERSION(v) ((v) == XFS_AGF_VERSION)
37 #define XFS_AGI_GOOD_VERSION(v) ((v) == XFS_AGI_VERSION)
38
39 /*
40  * Btree number 0 is bno, 1 is cnt.  This value gives the size of the
41  * arrays below.
42  */
43 #define XFS_BTNUM_AGF   ((int)XFS_BTNUM_CNTi + 1)
44
45 /*
46  * The second word of agf_levels in the first a.g. overlaps the EFS
47  * superblock's magic number.  Since the magic numbers valid for EFS
48  * are > 64k, our value cannot be confused for an EFS superblock's.
49  */
50
51 typedef struct xfs_agf {
52         /*
53          * Common allocation group header information
54          */
55         __be32          agf_magicnum;   /* magic number == XFS_AGF_MAGIC */
56         __be32          agf_versionnum; /* header version == XFS_AGF_VERSION */
57         __be32          agf_seqno;      /* sequence # starting from 0 */
58         __be32          agf_length;     /* size in blocks of a.g. */
59         /*
60          * Freespace information
61          */
62         __be32          agf_roots[XFS_BTNUM_AGF];       /* root blocks */
63         __be32          agf_spare0;     /* spare field */
64         __be32          agf_levels[XFS_BTNUM_AGF];      /* btree levels */
65         __be32          agf_spare1;     /* spare field */
66         __be32          agf_flfirst;    /* first freelist block's index */
67         __be32          agf_fllast;     /* last freelist block's index */
68         __be32          agf_flcount;    /* count of blocks in freelist */
69         __be32          agf_freeblks;   /* total free blocks */
70         __be32          agf_longest;    /* longest free space */
71         __be32          agf_btreeblks;  /* # of blocks held in AGF btrees */
72 } xfs_agf_t;
73
74 #define XFS_AGF_MAGICNUM        0x00000001
75 #define XFS_AGF_VERSIONNUM      0x00000002
76 #define XFS_AGF_SEQNO           0x00000004
77 #define XFS_AGF_LENGTH          0x00000008
78 #define XFS_AGF_ROOTS           0x00000010
79 #define XFS_AGF_LEVELS          0x00000020
80 #define XFS_AGF_FLFIRST         0x00000040
81 #define XFS_AGF_FLLAST          0x00000080
82 #define XFS_AGF_FLCOUNT         0x00000100
83 #define XFS_AGF_FREEBLKS        0x00000200
84 #define XFS_AGF_LONGEST         0x00000400
85 #define XFS_AGF_BTREEBLKS       0x00000800
86 #define XFS_AGF_NUM_BITS        12
87 #define XFS_AGF_ALL_BITS        ((1 << XFS_AGF_NUM_BITS) - 1)
88
89 /* disk block (xfs_daddr_t) in the AG */
90 #define XFS_AGF_DADDR(mp)       ((xfs_daddr_t)(1 << (mp)->m_sectbb_log))
91 #define XFS_AGF_BLOCK(mp)       XFS_HDR_BLOCK(mp, XFS_AGF_DADDR(mp))
92 #define XFS_BUF_TO_AGF(bp)      ((xfs_agf_t *)XFS_BUF_PTR(bp))
93
94
95 /*
96  * Size of the unlinked inode hash table in the agi.
97  */
98 #define XFS_AGI_UNLINKED_BUCKETS        64
99
100 typedef struct xfs_agi {
101         /*
102          * Common allocation group header information
103          */
104         __be32          agi_magicnum;   /* magic number == XFS_AGI_MAGIC */
105         __be32          agi_versionnum; /* header version == XFS_AGI_VERSION */
106         __be32          agi_seqno;      /* sequence # starting from 0 */
107         __be32          agi_length;     /* size in blocks of a.g. */
108         /*
109          * Inode information
110          * Inodes are mapped by interpreting the inode number, so no
111          * mapping data is needed here.
112          */
113         __be32          agi_count;      /* count of allocated inodes */
114         __be32          agi_root;       /* root of inode btree */
115         __be32          agi_level;      /* levels in inode btree */
116         __be32          agi_freecount;  /* number of free inodes */
117         __be32          agi_newino;     /* new inode just allocated */
118         __be32          agi_dirino;     /* last directory inode chunk */
119         /*
120          * Hash table of inodes which have been unlinked but are
121          * still being referenced.
122          */
123         __be32          agi_unlinked[XFS_AGI_UNLINKED_BUCKETS];
124 } xfs_agi_t;
125
126 #define XFS_AGI_MAGICNUM        0x00000001
127 #define XFS_AGI_VERSIONNUM      0x00000002
128 #define XFS_AGI_SEQNO           0x00000004
129 #define XFS_AGI_LENGTH          0x00000008
130 #define XFS_AGI_COUNT           0x00000010
131 #define XFS_AGI_ROOT            0x00000020
132 #define XFS_AGI_LEVEL           0x00000040
133 #define XFS_AGI_FREECOUNT       0x00000080
134 #define XFS_AGI_NEWINO          0x00000100
135 #define XFS_AGI_DIRINO          0x00000200
136 #define XFS_AGI_UNLINKED        0x00000400
137 #define XFS_AGI_NUM_BITS        11
138 #define XFS_AGI_ALL_BITS        ((1 << XFS_AGI_NUM_BITS) - 1)
139
140 /* disk block (xfs_daddr_t) in the AG */
141 #define XFS_AGI_DADDR(mp)       ((xfs_daddr_t)(2 << (mp)->m_sectbb_log))
142 #define XFS_AGI_BLOCK(mp)       XFS_HDR_BLOCK(mp, XFS_AGI_DADDR(mp))
143 #define XFS_BUF_TO_AGI(bp)      ((xfs_agi_t *)XFS_BUF_PTR(bp))
144
145 /*
146  * The third a.g. block contains the a.g. freelist, an array
147  * of block pointers to blocks owned by the allocation btree code.
148  */
149 #define XFS_AGFL_DADDR(mp)      ((xfs_daddr_t)(3 << (mp)->m_sectbb_log))
150 #define XFS_AGFL_BLOCK(mp)      XFS_HDR_BLOCK(mp, XFS_AGFL_DADDR(mp))
151 #define XFS_AGFL_SIZE(mp)       ((mp)->m_sb.sb_sectsize / sizeof(xfs_agblock_t))
152 #define XFS_BUF_TO_AGFL(bp)     ((xfs_agfl_t *)XFS_BUF_PTR(bp))
153
154 typedef struct xfs_agfl {
155         __be32          agfl_bno[1];    /* actually XFS_AGFL_SIZE(mp) */
156 } xfs_agfl_t;
157
158 /*
159  * Busy block/extent entry.  Used in perag to mark blocks that have been freed
160  * but whose transactions aren't committed to disk yet.
161  */
162 typedef struct xfs_perag_busy {
163         xfs_agblock_t   busy_start;
164         xfs_extlen_t    busy_length;
165         struct xfs_trans *busy_tp;      /* transaction that did the free */
166 } xfs_perag_busy_t;
167
168 /*
169  * Per-ag incore structure, copies of information in agf and agi,
170  * to improve the performance of allocation group selection.
171  *
172  * pick sizes which fit in allocation buckets well
173  */
174 #if (BITS_PER_LONG == 32)
175 #define XFS_PAGB_NUM_SLOTS      84
176 #elif (BITS_PER_LONG == 64)
177 #define XFS_PAGB_NUM_SLOTS      128
178 #endif
179
180 typedef struct xfs_perag
181 {
182         char            pagf_init;      /* this agf's entry is initialized */
183         char            pagi_init;      /* this agi's entry is initialized */
184         char            pagf_metadata;  /* the agf is preferred to be metadata */
185         char            pagi_inodeok;   /* The agi is ok for inodes */
186         __uint8_t       pagf_levels[XFS_BTNUM_AGF];
187                                         /* # of levels in bno & cnt btree */
188         __uint32_t      pagf_flcount;   /* count of blocks in freelist */
189         xfs_extlen_t    pagf_freeblks;  /* total free blocks */
190         xfs_extlen_t    pagf_longest;   /* longest free space */
191         __uint32_t      pagf_btreeblks; /* # of blocks held in AGF btrees */
192         xfs_agino_t     pagi_freecount; /* number of free inodes */
193         xfs_agino_t     pagi_count;     /* number of allocated inodes */
194         int             pagb_count;     /* pagb slots in use */
195 #ifdef __KERNEL__
196         lock_t          pagb_lock;      /* lock for pagb_list */
197 #endif
198         xfs_perag_busy_t *pagb_list;    /* unstable blocks */
199         atomic_t        pagf_fstrms;    /* # of filestreams active in this AG */
200 } xfs_perag_t;
201
202 #define XFS_AG_MAXLEVELS(mp)            ((mp)->m_ag_maxlevels)
203 #define XFS_MIN_FREELIST_RAW(bl,cl,mp)  \
204         (MIN(bl + 1, XFS_AG_MAXLEVELS(mp)) + MIN(cl + 1, XFS_AG_MAXLEVELS(mp)))
205 #define XFS_MIN_FREELIST(a,mp)          \
206         (XFS_MIN_FREELIST_RAW(          \
207                 be32_to_cpu((a)->agf_levels[XFS_BTNUM_BNOi]), \
208                 be32_to_cpu((a)->agf_levels[XFS_BTNUM_CNTi]), mp))
209 #define XFS_MIN_FREELIST_PAG(pag,mp)    \
210         (XFS_MIN_FREELIST_RAW(          \
211                 (uint_t)(pag)->pagf_levels[XFS_BTNUM_BNOi], \
212                 (uint_t)(pag)->pagf_levels[XFS_BTNUM_CNTi], mp))
213
214 #define XFS_AGB_TO_FSB(mp,agno,agbno)   \
215         (((xfs_fsblock_t)(agno) << (mp)->m_sb.sb_agblklog) | (agbno))
216 #define XFS_FSB_TO_AGNO(mp,fsbno)       \
217         ((xfs_agnumber_t)((fsbno) >> (mp)->m_sb.sb_agblklog))
218 #define XFS_FSB_TO_AGBNO(mp,fsbno)      \
219         ((xfs_agblock_t)((fsbno) & XFS_MASK32LO((mp)->m_sb.sb_agblklog)))
220 #define XFS_AGB_TO_DADDR(mp,agno,agbno) \
221         ((xfs_daddr_t)XFS_FSB_TO_BB(mp, \
222                 (xfs_fsblock_t)(agno) * (mp)->m_sb.sb_agblocks + (agbno)))
223 #define XFS_AG_DADDR(mp,agno,d)         (XFS_AGB_TO_DADDR(mp, agno, 0) + (d))
224
225 /*
226  * For checking for bad ranges of xfs_daddr_t's, covering multiple
227  * allocation groups or a single xfs_daddr_t that's a superblock copy.
228  */
229 #define XFS_AG_CHECK_DADDR(mp,d,len)    \
230         ((len) == 1 ? \
231             ASSERT((d) == XFS_SB_DADDR || \
232                    XFS_DADDR_TO_AGBNO(mp, d) != XFS_SB_DADDR) : \
233             ASSERT(XFS_DADDR_TO_AGNO(mp, d) == \
234                    XFS_DADDR_TO_AGNO(mp, (d) + (len) - 1)))
235
236 #endif  /* __XFS_AG_H__ */