[XFS] split ondisk vs incore versions of xfs_bmbt_rec_t
[linux-2.6-block.git] / fs / xfs / xfs_bmap_btree.h
CommitLineData
1da177e4 1/*
7b718769
NS
2 * Copyright (c) 2000,2002-2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
1da177e4 4 *
7b718769
NS
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
1da177e4
LT
7 * published by the Free Software Foundation.
8 *
7b718769
NS
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.
1da177e4 13 *
7b718769
NS
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
1da177e4
LT
17 */
18#ifndef __XFS_BMAP_BTREE_H__
19#define __XFS_BMAP_BTREE_H__
20
21#define XFS_BMAP_MAGIC 0x424d4150 /* 'BMAP' */
22
23struct xfs_btree_cur;
24struct xfs_btree_lblock;
25struct xfs_mount;
26struct xfs_inode;
27
28/*
29 * Bmap root header, on-disk form only.
30 */
16259e7d
CH
31typedef struct xfs_bmdr_block {
32 __be16 bb_level; /* 0 is a leaf */
33 __be16 bb_numrecs; /* current # of data records */
1da177e4
LT
34} xfs_bmdr_block_t;
35
36/*
37 * Bmap btree record and extent descriptor.
38 * For 32-bit kernels,
39 * l0:31 is an extent flag (value 1 indicates non-normal).
40 * l0:0-30 and l1:9-31 are startoff.
41 * l1:0-8, l2:0-31, and l3:21-31 are startblock.
42 * l3:0-20 are blockcount.
43 * For 64-bit kernels,
44 * l0:63 is an extent flag (value 1 indicates non-normal).
45 * l0:9-62 are startoff.
46 * l0:0-8 and l1:21-63 are startblock.
47 * l1:0-20 are blockcount.
48 */
49
f016bad6 50#ifndef XFS_NATIVE_HOST
1da177e4
LT
51
52#define BMBT_TOTAL_BITLEN 128 /* 128 bits, 16 bytes */
53#define BMBT_EXNTFLAG_BITOFF 0
54#define BMBT_EXNTFLAG_BITLEN 1
55#define BMBT_STARTOFF_BITOFF (BMBT_EXNTFLAG_BITOFF + BMBT_EXNTFLAG_BITLEN)
56#define BMBT_STARTOFF_BITLEN 54
57#define BMBT_STARTBLOCK_BITOFF (BMBT_STARTOFF_BITOFF + BMBT_STARTOFF_BITLEN)
58#define BMBT_STARTBLOCK_BITLEN 52
59#define BMBT_BLOCKCOUNT_BITOFF \
60 (BMBT_STARTBLOCK_BITOFF + BMBT_STARTBLOCK_BITLEN)
61#define BMBT_BLOCKCOUNT_BITLEN (BMBT_TOTAL_BITLEN - BMBT_BLOCKCOUNT_BITOFF)
62
63#else
64
65#define BMBT_TOTAL_BITLEN 128 /* 128 bits, 16 bytes */
66#define BMBT_EXNTFLAG_BITOFF 63
67#define BMBT_EXNTFLAG_BITLEN 1
68#define BMBT_STARTOFF_BITOFF (BMBT_EXNTFLAG_BITOFF - BMBT_STARTOFF_BITLEN)
69#define BMBT_STARTOFF_BITLEN 54
70#define BMBT_STARTBLOCK_BITOFF 85 /* 128 - 43 (other 9 is in first word) */
71#define BMBT_STARTBLOCK_BITLEN 52
72#define BMBT_BLOCKCOUNT_BITOFF 64 /* Start of second 64 bit container */
73#define BMBT_BLOCKCOUNT_BITLEN 21
74
f016bad6 75#endif /* XFS_NATIVE_HOST */
1da177e4
LT
76
77
78#define BMBT_USE_64 1
79
80typedef struct xfs_bmbt_rec_32
81{
82 __uint32_t l0, l1, l2, l3;
83} xfs_bmbt_rec_32_t;
84typedef struct xfs_bmbt_rec_64
85{
86 __uint64_t l0, l1;
87} xfs_bmbt_rec_64_t;
88
89typedef __uint64_t xfs_bmbt_rec_base_t; /* use this for casts */
90typedef xfs_bmbt_rec_64_t xfs_bmbt_rec_t, xfs_bmdr_rec_t;
91
a6f64d4a
CH
92typedef struct xfs_bmbt_rec_host {
93 __uint64_t l0, l1;
94} xfs_bmbt_rec_host_t;
95
1da177e4
LT
96/*
97 * Values and macros for delayed-allocation startblock fields.
98 */
99#define STARTBLOCKVALBITS 17
100#define STARTBLOCKMASKBITS (15 + XFS_BIG_BLKNOS * 20)
101#define DSTARTBLOCKMASKBITS (15 + 20)
102#define STARTBLOCKMASK \
103 (((((xfs_fsblock_t)1) << STARTBLOCKMASKBITS) - 1) << STARTBLOCKVALBITS)
104#define DSTARTBLOCKMASK \
105 (((((xfs_dfsbno_t)1) << DSTARTBLOCKMASKBITS) - 1) << STARTBLOCKVALBITS)
a844f451 106
1da177e4 107#define ISNULLSTARTBLOCK(x) isnullstartblock(x)
a844f451
NS
108static inline int isnullstartblock(xfs_fsblock_t x)
109{
110 return ((x) & STARTBLOCKMASK) == STARTBLOCKMASK;
111}
112
1da177e4 113#define ISNULLDSTARTBLOCK(x) isnulldstartblock(x)
a844f451
NS
114static inline int isnulldstartblock(xfs_dfsbno_t x)
115{
116 return ((x) & DSTARTBLOCKMASK) == DSTARTBLOCKMASK;
117}
118
1da177e4 119#define NULLSTARTBLOCK(k) nullstartblock(k)
a844f451
NS
120static inline xfs_fsblock_t nullstartblock(int k)
121{
122 ASSERT(k < (1 << STARTBLOCKVALBITS));
123 return STARTBLOCKMASK | (k);
124}
125
1da177e4 126#define STARTBLOCKVAL(x) startblockval(x)
a844f451
NS
127static inline xfs_filblks_t startblockval(xfs_fsblock_t x)
128{
129 return (xfs_filblks_t)((x) & ~STARTBLOCKMASK);
130}
1da177e4
LT
131
132/*
133 * Possible extent formats.
134 */
135typedef enum {
136 XFS_EXTFMT_NOSTATE = 0,
137 XFS_EXTFMT_HASSTATE
138} xfs_exntfmt_t;
139
140/*
141 * Possible extent states.
142 */
143typedef enum {
144 XFS_EXT_NORM, XFS_EXT_UNWRITTEN,
145 XFS_EXT_DMAPI_OFFLINE, XFS_EXT_INVALID
146} xfs_exntst_t;
147
148/*
149 * Extent state and extent format macros.
150 */
a844f451
NS
151#define XFS_EXTFMT_INODE(x) \
152 (XFS_SB_VERSION_HASEXTFLGBIT(&((x)->i_mount->m_sb)) ? \
153 XFS_EXTFMT_HASSTATE : XFS_EXTFMT_NOSTATE)
1da177e4
LT
154#define ISUNWRITTEN(x) ((x)->br_state == XFS_EXT_UNWRITTEN)
155
156/*
157 * Incore version of above.
158 */
159typedef struct xfs_bmbt_irec
160{
161 xfs_fileoff_t br_startoff; /* starting file offset */
162 xfs_fsblock_t br_startblock; /* starting block number */
163 xfs_filblks_t br_blockcount; /* number of blocks */
164 xfs_exntst_t br_state; /* extent state */
165} xfs_bmbt_irec_t;
166
167/*
168 * Key structure for non-leaf levels of the tree.
169 */
8801bb99
CH
170typedef struct xfs_bmbt_key {
171 __be64 br_startoff; /* starting file offset */
1da177e4
LT
172} xfs_bmbt_key_t, xfs_bmdr_key_t;
173
397b5208
CH
174/* btree pointer type */
175typedef __be64 xfs_bmbt_ptr_t, xfs_bmdr_ptr_t;
176
177/* btree block header type */
1da177e4
LT
178typedef struct xfs_btree_lblock xfs_bmbt_block_t;
179
a844f451 180#define XFS_BUF_TO_BMBT_BLOCK(bp) ((xfs_bmbt_block_t *)XFS_BUF_PTR(bp))
1da177e4 181
a844f451
NS
182#define XFS_BMAP_RBLOCK_DSIZE(lev,cur) ((cur)->bc_private.b.forksize)
183#define XFS_BMAP_RBLOCK_ISIZE(lev,cur) \
1da177e4 184 ((int)XFS_IFORK_PTR((cur)->bc_private.b.ip, \
a844f451 185 (cur)->bc_private.b.whichfork)->if_broot_bytes)
1da177e4 186
1da177e4 187#define XFS_BMAP_BLOCK_DMAXRECS(lev,cur) \
a844f451 188 (((lev) == (cur)->bc_nlevels - 1 ? \
1da177e4
LT
189 XFS_BTREE_BLOCK_MAXRECS(XFS_BMAP_RBLOCK_DSIZE(lev,cur), \
190 xfs_bmdr, (lev) == 0) : \
a844f451 191 ((cur)->bc_mp->m_bmap_dmxr[(lev) != 0])))
1da177e4 192#define XFS_BMAP_BLOCK_IMAXRECS(lev,cur) \
a844f451
NS
193 (((lev) == (cur)->bc_nlevels - 1 ? \
194 XFS_BTREE_BLOCK_MAXRECS(XFS_BMAP_RBLOCK_ISIZE(lev,cur),\
195 xfs_bmbt, (lev) == 0) : \
196 ((cur)->bc_mp->m_bmap_dmxr[(lev) != 0])))
1da177e4 197
1da177e4 198#define XFS_BMAP_BLOCK_DMINRECS(lev,cur) \
a844f451
NS
199 (((lev) == (cur)->bc_nlevels - 1 ? \
200 XFS_BTREE_BLOCK_MINRECS(XFS_BMAP_RBLOCK_DSIZE(lev,cur),\
201 xfs_bmdr, (lev) == 0) : \
202 ((cur)->bc_mp->m_bmap_dmnr[(lev) != 0])))
1da177e4 203#define XFS_BMAP_BLOCK_IMINRECS(lev,cur) \
a844f451
NS
204 (((lev) == (cur)->bc_nlevels - 1 ? \
205 XFS_BTREE_BLOCK_MINRECS(XFS_BMAP_RBLOCK_ISIZE(lev,cur),\
206 xfs_bmbt, (lev) == 0) : \
207 ((cur)->bc_mp->m_bmap_dmnr[(lev) != 0])))
208
2c36dded
ES
209#define XFS_BMAP_REC_DADDR(bb,i,cur) (XFS_BTREE_REC_ADDR(xfs_bmbt, bb, i))
210
211#define XFS_BMAP_REC_IADDR(bb,i,cur) (XFS_BTREE_REC_ADDR(xfs_bmbt, bb, i))
a844f451
NS
212
213#define XFS_BMAP_KEY_DADDR(bb,i,cur) \
2c36dded
ES
214 (XFS_BTREE_KEY_ADDR(xfs_bmbt, bb, i))
215
a844f451 216#define XFS_BMAP_KEY_IADDR(bb,i,cur) \
2c36dded 217 (XFS_BTREE_KEY_ADDR(xfs_bmbt, bb, i))
a844f451
NS
218
219#define XFS_BMAP_PTR_DADDR(bb,i,cur) \
2c36dded 220 (XFS_BTREE_PTR_ADDR(xfs_bmbt, bb, i, XFS_BMAP_BLOCK_DMAXRECS( \
16259e7d 221 be16_to_cpu((bb)->bb_level), cur)))
a844f451 222#define XFS_BMAP_PTR_IADDR(bb,i,cur) \
2c36dded 223 (XFS_BTREE_PTR_ADDR(xfs_bmbt, bb, i, XFS_BMAP_BLOCK_IMAXRECS( \
16259e7d 224 be16_to_cpu((bb)->bb_level), cur)))
1da177e4
LT
225
226/*
227 * These are to be used when we know the size of the block and
228 * we don't have a cursor.
229 */
1da177e4 230#define XFS_BMAP_BROOT_REC_ADDR(bb,i,sz) \
2c36dded 231 (XFS_BTREE_REC_ADDR(xfs_bmbt,bb,i))
1da177e4 232#define XFS_BMAP_BROOT_KEY_ADDR(bb,i,sz) \
2c36dded 233 (XFS_BTREE_KEY_ADDR(xfs_bmbt,bb,i))
1da177e4 234#define XFS_BMAP_BROOT_PTR_ADDR(bb,i,sz) \
2c36dded 235 (XFS_BTREE_PTR_ADDR(xfs_bmbt,bb,i,XFS_BMAP_BROOT_MAXRECS(sz)))
a844f451 236
16259e7d 237#define XFS_BMAP_BROOT_NUMRECS(bb) be16_to_cpu((bb)->bb_numrecs)
a844f451 238#define XFS_BMAP_BROOT_MAXRECS(sz) XFS_BTREE_BLOCK_MAXRECS(sz,xfs_bmbt,0)
1da177e4 239
1da177e4 240#define XFS_BMAP_BROOT_SPACE_CALC(nrecs) \
a844f451
NS
241 (int)(sizeof(xfs_bmbt_block_t) + \
242 ((nrecs) * (sizeof(xfs_bmbt_key_t) + sizeof(xfs_bmbt_ptr_t))))
243
1da177e4 244#define XFS_BMAP_BROOT_SPACE(bb) \
16259e7d 245 (XFS_BMAP_BROOT_SPACE_CALC(be16_to_cpu((bb)->bb_numrecs)))
a844f451
NS
246#define XFS_BMDR_SPACE_CALC(nrecs) \
247 (int)(sizeof(xfs_bmdr_block_t) + \
248 ((nrecs) * (sizeof(xfs_bmbt_key_t) + sizeof(xfs_bmbt_ptr_t))))
1da177e4
LT
249
250/*
251 * Maximum number of bmap btree levels.
252 */
a844f451 253#define XFS_BM_MAXLEVELS(mp,w) ((mp)->m_bm_maxlevels[(w)])
1da177e4 254
a844f451 255#define XFS_BMAP_SANITY_CHECK(mp,bb,level) \
16259e7d
CH
256 (be32_to_cpu((bb)->bb_magic) == XFS_BMAP_MAGIC && \
257 be16_to_cpu((bb)->bb_level) == level && \
258 be16_to_cpu((bb)->bb_numrecs) > 0 && \
259 be16_to_cpu((bb)->bb_numrecs) <= (mp)->m_bmap_dmxr[(level) != 0])
1da177e4
LT
260
261
262#ifdef __KERNEL__
263
264#if defined(XFS_BMBT_TRACE)
265/*
266 * Trace buffer entry types.
267 */
268#define XFS_BMBT_KTRACE_ARGBI 1
269#define XFS_BMBT_KTRACE_ARGBII 2
270#define XFS_BMBT_KTRACE_ARGFFFI 3
271#define XFS_BMBT_KTRACE_ARGI 4
272#define XFS_BMBT_KTRACE_ARGIFK 5
273#define XFS_BMBT_KTRACE_ARGIFR 6
274#define XFS_BMBT_KTRACE_ARGIK 7
275#define XFS_BMBT_KTRACE_CUR 8
276
277#define XFS_BMBT_TRACE_SIZE 4096 /* size of global trace buffer */
278#define XFS_BMBT_KTRACE_SIZE 32 /* size of per-inode trace buffer */
279extern ktrace_t *xfs_bmbt_trace_buf;
280#endif
281
282/*
283 * Prototypes for xfs_bmap.c to call.
284 */
a844f451
NS
285extern void xfs_bmdr_to_bmbt(xfs_bmdr_block_t *, int, xfs_bmbt_block_t *, int);
286extern int xfs_bmbt_decrement(struct xfs_btree_cur *, int, int *);
287extern int xfs_bmbt_delete(struct xfs_btree_cur *, int *);
a6f64d4a 288extern void xfs_bmbt_get_all(xfs_bmbt_rec_host_t *r, xfs_bmbt_irec_t *s);
a844f451
NS
289extern xfs_bmbt_block_t *xfs_bmbt_get_block(struct xfs_btree_cur *cur,
290 int, struct xfs_buf **bpp);
a6f64d4a
CH
291extern xfs_filblks_t xfs_bmbt_get_blockcount(xfs_bmbt_rec_host_t *r);
292extern xfs_fsblock_t xfs_bmbt_get_startblock(xfs_bmbt_rec_host_t *r);
293extern xfs_fileoff_t xfs_bmbt_get_startoff(xfs_bmbt_rec_host_t *r);
294extern xfs_exntst_t xfs_bmbt_get_state(xfs_bmbt_rec_host_t *r);
1da177e4 295
f016bad6 296#ifndef XFS_NATIVE_HOST
a844f451 297extern void xfs_bmbt_disk_get_all(xfs_bmbt_rec_t *r, xfs_bmbt_irec_t *s);
a844f451 298extern xfs_filblks_t xfs_bmbt_disk_get_blockcount(xfs_bmbt_rec_t *r);
a844f451
NS
299extern xfs_fileoff_t xfs_bmbt_disk_get_startoff(xfs_bmbt_rec_t *r);
300#else
301#define xfs_bmbt_disk_get_all(r, s) xfs_bmbt_get_all(r, s)
a844f451 302#define xfs_bmbt_disk_get_blockcount(r) xfs_bmbt_get_blockcount(r)
a844f451 303#define xfs_bmbt_disk_get_startoff(r) xfs_bmbt_get_startoff(r)
f016bad6 304#endif /* XFS_NATIVE_HOST */
1da177e4 305
a844f451
NS
306extern int xfs_bmbt_increment(struct xfs_btree_cur *, int, int *);
307extern int xfs_bmbt_insert(struct xfs_btree_cur *, int *);
308extern void xfs_bmbt_log_block(struct xfs_btree_cur *, struct xfs_buf *, int);
309extern void xfs_bmbt_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int,
310 int);
311extern int xfs_bmbt_lookup_eq(struct xfs_btree_cur *, xfs_fileoff_t,
312 xfs_fsblock_t, xfs_filblks_t, int *);
313extern int xfs_bmbt_lookup_ge(struct xfs_btree_cur *, xfs_fileoff_t,
314 xfs_fsblock_t, xfs_filblks_t, int *);
1da177e4 315
1da177e4
LT
316/*
317 * Give the bmap btree a new root block. Copy the old broot contents
318 * down into a real block and make the broot point to it.
319 */
a844f451
NS
320extern int xfs_bmbt_newroot(struct xfs_btree_cur *cur, int *lflags, int *stat);
321
a6f64d4a
CH
322extern void xfs_bmbt_set_all(xfs_bmbt_rec_host_t *r, xfs_bmbt_irec_t *s);
323extern void xfs_bmbt_set_allf(xfs_bmbt_rec_host_t *r, xfs_fileoff_t o,
a844f451 324 xfs_fsblock_t b, xfs_filblks_t c, xfs_exntst_t v);
a6f64d4a
CH
325extern void xfs_bmbt_set_blockcount(xfs_bmbt_rec_host_t *r, xfs_filblks_t v);
326extern void xfs_bmbt_set_startblock(xfs_bmbt_rec_host_t *r, xfs_fsblock_t v);
327extern void xfs_bmbt_set_startoff(xfs_bmbt_rec_host_t *r, xfs_fileoff_t v);
328extern void xfs_bmbt_set_state(xfs_bmbt_rec_host_t *r, xfs_exntst_t v);
1da177e4 329
f016bad6 330#ifndef XFS_NATIVE_HOST
a844f451
NS
331extern void xfs_bmbt_disk_set_all(xfs_bmbt_rec_t *r, xfs_bmbt_irec_t *s);
332extern void xfs_bmbt_disk_set_allf(xfs_bmbt_rec_t *r, xfs_fileoff_t o,
333 xfs_fsblock_t b, xfs_filblks_t c, xfs_exntst_t v);
1da177e4 334#else
a844f451
NS
335#define xfs_bmbt_disk_set_all(r, s) xfs_bmbt_set_all(r, s)
336#define xfs_bmbt_disk_set_allf(r, o, b, c, v) xfs_bmbt_set_allf(r, o, b, c, v)
f016bad6 337#endif /* XFS_NATIVE_HOST */
1da177e4 338
a844f451
NS
339extern void xfs_bmbt_to_bmdr(xfs_bmbt_block_t *, int, xfs_bmdr_block_t *, int);
340extern int xfs_bmbt_update(struct xfs_btree_cur *, xfs_fileoff_t,
341 xfs_fsblock_t, xfs_filblks_t, xfs_exntst_t);
1da177e4 342
1da177e4
LT
343#endif /* __KERNEL__ */
344
345#endif /* __XFS_BMAP_BTREE_H__ */