2 * Copyright (c) 2000,2002-2005 Silicon Graphics, Inc.
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.
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.
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
18 #ifndef __XFS_BMAP_BTREE_H__
19 #define __XFS_BMAP_BTREE_H__
21 #define XFS_BMAP_MAGIC 0x424d4150 /* 'BMAP' */
24 struct xfs_btree_lblock;
30 * Bmap root header, on-disk form only.
32 typedef struct xfs_bmdr_block {
33 __be16 bb_level; /* 0 is a leaf */
34 __be16 bb_numrecs; /* current # of data records */
38 * Bmap btree record and extent descriptor.
39 * l0:63 is an extent flag (value 1 indicates non-normal).
40 * l0:9-62 are startoff.
41 * l0:0-8 and l1:21-63 are startblock.
42 * l1:0-20 are blockcount.
44 #define BMBT_EXNTFLAG_BITLEN 1
45 #define BMBT_STARTOFF_BITLEN 54
46 #define BMBT_STARTBLOCK_BITLEN 52
47 #define BMBT_BLOCKCOUNT_BITLEN 21
52 typedef struct xfs_bmbt_rec_32
54 __uint32_t l0, l1, l2, l3;
56 typedef struct xfs_bmbt_rec_64
61 typedef __uint64_t xfs_bmbt_rec_base_t; /* use this for casts */
62 typedef xfs_bmbt_rec_64_t xfs_bmbt_rec_t, xfs_bmdr_rec_t;
64 typedef struct xfs_bmbt_rec_host {
66 } xfs_bmbt_rec_host_t;
69 * Values and macros for delayed-allocation startblock fields.
71 #define STARTBLOCKVALBITS 17
72 #define STARTBLOCKMASKBITS (15 + XFS_BIG_BLKNOS * 20)
73 #define DSTARTBLOCKMASKBITS (15 + 20)
74 #define STARTBLOCKMASK \
75 (((((xfs_fsblock_t)1) << STARTBLOCKMASKBITS) - 1) << STARTBLOCKVALBITS)
76 #define DSTARTBLOCKMASK \
77 (((((xfs_dfsbno_t)1) << DSTARTBLOCKMASKBITS) - 1) << STARTBLOCKVALBITS)
79 #define ISNULLSTARTBLOCK(x) isnullstartblock(x)
80 static inline int isnullstartblock(xfs_fsblock_t x)
82 return ((x) & STARTBLOCKMASK) == STARTBLOCKMASK;
85 #define ISNULLDSTARTBLOCK(x) isnulldstartblock(x)
86 static inline int isnulldstartblock(xfs_dfsbno_t x)
88 return ((x) & DSTARTBLOCKMASK) == DSTARTBLOCKMASK;
91 #define NULLSTARTBLOCK(k) nullstartblock(k)
92 static inline xfs_fsblock_t nullstartblock(int k)
94 ASSERT(k < (1 << STARTBLOCKVALBITS));
95 return STARTBLOCKMASK | (k);
98 #define STARTBLOCKVAL(x) startblockval(x)
99 static inline xfs_filblks_t startblockval(xfs_fsblock_t x)
101 return (xfs_filblks_t)((x) & ~STARTBLOCKMASK);
105 * Possible extent formats.
108 XFS_EXTFMT_NOSTATE = 0,
113 * Possible extent states.
116 XFS_EXT_NORM, XFS_EXT_UNWRITTEN,
117 XFS_EXT_DMAPI_OFFLINE, XFS_EXT_INVALID
121 * Extent state and extent format macros.
123 #define XFS_EXTFMT_INODE(x) \
124 (xfs_sb_version_hasextflgbit(&((x)->i_mount->m_sb)) ? \
125 XFS_EXTFMT_HASSTATE : XFS_EXTFMT_NOSTATE)
126 #define ISUNWRITTEN(x) ((x)->br_state == XFS_EXT_UNWRITTEN)
129 * Incore version of above.
131 typedef struct xfs_bmbt_irec
133 xfs_fileoff_t br_startoff; /* starting file offset */
134 xfs_fsblock_t br_startblock; /* starting block number */
135 xfs_filblks_t br_blockcount; /* number of blocks */
136 xfs_exntst_t br_state; /* extent state */
140 * Key structure for non-leaf levels of the tree.
142 typedef struct xfs_bmbt_key {
143 __be64 br_startoff; /* starting file offset */
144 } xfs_bmbt_key_t, xfs_bmdr_key_t;
146 /* btree pointer type */
147 typedef __be64 xfs_bmbt_ptr_t, xfs_bmdr_ptr_t;
149 /* btree block header type */
150 typedef struct xfs_btree_lblock xfs_bmbt_block_t;
152 #define XFS_BUF_TO_BMBT_BLOCK(bp) ((xfs_bmbt_block_t *)XFS_BUF_PTR(bp))
154 #define XFS_BMAP_RBLOCK_DSIZE(lev,cur) ((cur)->bc_private.b.forksize)
155 #define XFS_BMAP_RBLOCK_ISIZE(lev,cur) \
156 ((int)XFS_IFORK_PTR((cur)->bc_private.b.ip, \
157 (cur)->bc_private.b.whichfork)->if_broot_bytes)
159 #define XFS_BMAP_BLOCK_DMAXRECS(lev,cur) \
160 (((lev) == (cur)->bc_nlevels - 1 ? \
161 XFS_BTREE_BLOCK_MAXRECS(XFS_BMAP_RBLOCK_DSIZE(lev,cur), \
162 xfs_bmdr, (lev) == 0) : \
163 ((cur)->bc_mp->m_bmap_dmxr[(lev) != 0])))
164 #define XFS_BMAP_BLOCK_IMAXRECS(lev,cur) \
165 (((lev) == (cur)->bc_nlevels - 1 ? \
166 XFS_BTREE_BLOCK_MAXRECS(XFS_BMAP_RBLOCK_ISIZE(lev,cur),\
167 xfs_bmbt, (lev) == 0) : \
168 ((cur)->bc_mp->m_bmap_dmxr[(lev) != 0])))
170 #define XFS_BMAP_BLOCK_DMINRECS(lev,cur) \
171 (((lev) == (cur)->bc_nlevels - 1 ? \
172 XFS_BTREE_BLOCK_MINRECS(XFS_BMAP_RBLOCK_DSIZE(lev,cur),\
173 xfs_bmdr, (lev) == 0) : \
174 ((cur)->bc_mp->m_bmap_dmnr[(lev) != 0])))
175 #define XFS_BMAP_BLOCK_IMINRECS(lev,cur) \
176 (((lev) == (cur)->bc_nlevels - 1 ? \
177 XFS_BTREE_BLOCK_MINRECS(XFS_BMAP_RBLOCK_ISIZE(lev,cur),\
178 xfs_bmbt, (lev) == 0) : \
179 ((cur)->bc_mp->m_bmap_dmnr[(lev) != 0])))
181 #define XFS_BMAP_REC_DADDR(bb,i,cur) (XFS_BTREE_REC_ADDR(xfs_bmbt, bb, i))
183 #define XFS_BMAP_REC_IADDR(bb,i,cur) (XFS_BTREE_REC_ADDR(xfs_bmbt, bb, i))
185 #define XFS_BMAP_KEY_DADDR(bb,i,cur) \
186 (XFS_BTREE_KEY_ADDR(xfs_bmbt, bb, i))
188 #define XFS_BMAP_KEY_IADDR(bb,i,cur) \
189 (XFS_BTREE_KEY_ADDR(xfs_bmbt, bb, i))
191 #define XFS_BMAP_PTR_DADDR(bb,i,cur) \
192 (XFS_BTREE_PTR_ADDR(xfs_bmbt, bb, i, XFS_BMAP_BLOCK_DMAXRECS( \
193 be16_to_cpu((bb)->bb_level), cur)))
194 #define XFS_BMAP_PTR_IADDR(bb,i,cur) \
195 (XFS_BTREE_PTR_ADDR(xfs_bmbt, bb, i, XFS_BMAP_BLOCK_IMAXRECS( \
196 be16_to_cpu((bb)->bb_level), cur)))
199 * These are to be used when we know the size of the block and
200 * we don't have a cursor.
202 #define XFS_BMAP_BROOT_REC_ADDR(bb,i,sz) \
203 (XFS_BTREE_REC_ADDR(xfs_bmbt,bb,i))
204 #define XFS_BMAP_BROOT_KEY_ADDR(bb,i,sz) \
205 (XFS_BTREE_KEY_ADDR(xfs_bmbt,bb,i))
206 #define XFS_BMAP_BROOT_PTR_ADDR(bb,i,sz) \
207 (XFS_BTREE_PTR_ADDR(xfs_bmbt,bb,i,XFS_BMAP_BROOT_MAXRECS(sz)))
209 #define XFS_BMAP_BROOT_NUMRECS(bb) be16_to_cpu((bb)->bb_numrecs)
210 #define XFS_BMAP_BROOT_MAXRECS(sz) XFS_BTREE_BLOCK_MAXRECS(sz,xfs_bmbt,0)
212 #define XFS_BMAP_BROOT_SPACE_CALC(nrecs) \
213 (int)(sizeof(xfs_bmbt_block_t) + \
214 ((nrecs) * (sizeof(xfs_bmbt_key_t) + sizeof(xfs_bmbt_ptr_t))))
216 #define XFS_BMAP_BROOT_SPACE(bb) \
217 (XFS_BMAP_BROOT_SPACE_CALC(be16_to_cpu((bb)->bb_numrecs)))
218 #define XFS_BMDR_SPACE_CALC(nrecs) \
219 (int)(sizeof(xfs_bmdr_block_t) + \
220 ((nrecs) * (sizeof(xfs_bmbt_key_t) + sizeof(xfs_bmbt_ptr_t))))
223 * Maximum number of bmap btree levels.
225 #define XFS_BM_MAXLEVELS(mp,w) ((mp)->m_bm_maxlevels[(w)])
227 #define XFS_BMAP_SANITY_CHECK(mp,bb,level) \
228 (be32_to_cpu((bb)->bb_magic) == XFS_BMAP_MAGIC && \
229 be16_to_cpu((bb)->bb_level) == level && \
230 be16_to_cpu((bb)->bb_numrecs) > 0 && \
231 be16_to_cpu((bb)->bb_numrecs) <= (mp)->m_bmap_dmxr[(level) != 0])
237 * Prototypes for xfs_bmap.c to call.
239 extern void xfs_bmdr_to_bmbt(xfs_bmdr_block_t *, int, xfs_bmbt_block_t *, int);
240 extern int xfs_bmbt_decrement(struct xfs_btree_cur *, int, int *);
241 extern int xfs_bmbt_delete(struct xfs_btree_cur *, int *);
242 extern void xfs_bmbt_get_all(xfs_bmbt_rec_host_t *r, xfs_bmbt_irec_t *s);
243 extern xfs_bmbt_block_t *xfs_bmbt_get_block(struct xfs_btree_cur *cur,
244 int, struct xfs_buf **bpp);
245 extern xfs_filblks_t xfs_bmbt_get_blockcount(xfs_bmbt_rec_host_t *r);
246 extern xfs_fsblock_t xfs_bmbt_get_startblock(xfs_bmbt_rec_host_t *r);
247 extern xfs_fileoff_t xfs_bmbt_get_startoff(xfs_bmbt_rec_host_t *r);
248 extern xfs_exntst_t xfs_bmbt_get_state(xfs_bmbt_rec_host_t *r);
250 extern void xfs_bmbt_disk_get_all(xfs_bmbt_rec_t *r, xfs_bmbt_irec_t *s);
251 extern xfs_filblks_t xfs_bmbt_disk_get_blockcount(xfs_bmbt_rec_t *r);
252 extern xfs_fileoff_t xfs_bmbt_disk_get_startoff(xfs_bmbt_rec_t *r);
254 extern int xfs_bmbt_increment(struct xfs_btree_cur *, int, int *);
255 extern int xfs_bmbt_insert(struct xfs_btree_cur *, int *);
256 extern void xfs_bmbt_log_block(struct xfs_btree_cur *, struct xfs_buf *, int);
257 extern void xfs_bmbt_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int,
259 extern int xfs_bmbt_lookup_eq(struct xfs_btree_cur *, xfs_fileoff_t,
260 xfs_fsblock_t, xfs_filblks_t, int *);
261 extern int xfs_bmbt_lookup_ge(struct xfs_btree_cur *, xfs_fileoff_t,
262 xfs_fsblock_t, xfs_filblks_t, int *);
265 * Give the bmap btree a new root block. Copy the old broot contents
266 * down into a real block and make the broot point to it.
268 extern int xfs_bmbt_newroot(struct xfs_btree_cur *cur, int *lflags, int *stat);
270 extern void xfs_bmbt_set_all(xfs_bmbt_rec_host_t *r, xfs_bmbt_irec_t *s);
271 extern void xfs_bmbt_set_allf(xfs_bmbt_rec_host_t *r, xfs_fileoff_t o,
272 xfs_fsblock_t b, xfs_filblks_t c, xfs_exntst_t v);
273 extern void xfs_bmbt_set_blockcount(xfs_bmbt_rec_host_t *r, xfs_filblks_t v);
274 extern void xfs_bmbt_set_startblock(xfs_bmbt_rec_host_t *r, xfs_fsblock_t v);
275 extern void xfs_bmbt_set_startoff(xfs_bmbt_rec_host_t *r, xfs_fileoff_t v);
276 extern void xfs_bmbt_set_state(xfs_bmbt_rec_host_t *r, xfs_exntst_t v);
278 extern void xfs_bmbt_disk_set_all(xfs_bmbt_rec_t *r, xfs_bmbt_irec_t *s);
279 extern void xfs_bmbt_disk_set_allf(xfs_bmbt_rec_t *r, xfs_fileoff_t o,
280 xfs_fsblock_t b, xfs_filblks_t c, xfs_exntst_t v);
282 extern void xfs_bmbt_to_bmdr(xfs_bmbt_block_t *, int, xfs_bmdr_block_t *, int);
283 extern int xfs_bmbt_update(struct xfs_btree_cur *, xfs_fileoff_t,
284 xfs_fsblock_t, xfs_filblks_t, xfs_exntst_t);
286 extern struct xfs_btree_cur *xfs_bmbt_init_cursor(struct xfs_mount *,
287 struct xfs_trans *, struct xfs_inode *, int);
289 #endif /* __KERNEL__ */
291 #endif /* __XFS_BMAP_BTREE_H__ */