blob: 5549d495947f4d3e9949c2c15fbc2982282ebe35 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000,2002-2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Nathan Scott7b718762005-11-02 14:58:39 +11005 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * published by the Free Software Foundation.
8 *
Nathan Scott7b718762005-11-02 14:58:39 +11009 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
Nathan Scott7b718762005-11-02 14:58:39 +110014 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
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;
Christoph Hellwig136341b2008-10-30 17:11:40 +110024struct xfs_btree_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -070025struct xfs_mount;
26struct xfs_inode;
Christoph Hellwig561f7d12008-10-30 16:53:59 +110027struct xfs_trans;
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29/*
30 * Bmap root header, on-disk form only.
31 */
Christoph Hellwig16259e72005-11-02 15:11:25 +110032typedef struct xfs_bmdr_block {
33 __be16 bb_level; /* 0 is a leaf */
34 __be16 bb_numrecs; /* current # of data records */
Linus Torvalds1da177e2005-04-16 15:20:36 -070035} xfs_bmdr_block_t;
36
37/*
38 * Bmap btree record and extent descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 * 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.
43 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#define BMBT_EXNTFLAG_BITLEN 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#define BMBT_STARTOFF_BITLEN 54
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#define BMBT_STARTBLOCK_BITLEN 52
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define BMBT_BLOCKCOUNT_BITLEN 21
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50#define BMBT_USE_64 1
51
52typedef struct xfs_bmbt_rec_32
53{
54 __uint32_t l0, l1, l2, l3;
55} xfs_bmbt_rec_32_t;
56typedef struct xfs_bmbt_rec_64
57{
Christoph Hellwigcd8b0a92007-08-16 16:24:15 +100058 __be64 l0, l1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059} xfs_bmbt_rec_64_t;
60
61typedef __uint64_t xfs_bmbt_rec_base_t; /* use this for casts */
62typedef xfs_bmbt_rec_64_t xfs_bmbt_rec_t, xfs_bmdr_rec_t;
63
Christoph Hellwiga6f64d42007-08-16 16:23:40 +100064typedef struct xfs_bmbt_rec_host {
65 __uint64_t l0, l1;
66} xfs_bmbt_rec_host_t;
67
Linus Torvalds1da177e2005-04-16 15:20:36 -070068/*
69 * Values and macros for delayed-allocation startblock fields.
70 */
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)
Nathan Scotta844f452005-11-02 14:38:42 +110078
Nathan Scotta844f452005-11-02 14:38:42 +110079static inline int isnullstartblock(xfs_fsblock_t x)
80{
81 return ((x) & STARTBLOCKMASK) == STARTBLOCKMASK;
82}
83
Nathan Scotta844f452005-11-02 14:38:42 +110084static inline int isnulldstartblock(xfs_dfsbno_t x)
85{
86 return ((x) & DSTARTBLOCKMASK) == DSTARTBLOCKMASK;
87}
88
Nathan Scotta844f452005-11-02 14:38:42 +110089static inline xfs_fsblock_t nullstartblock(int k)
90{
91 ASSERT(k < (1 << STARTBLOCKVALBITS));
92 return STARTBLOCKMASK | (k);
93}
94
Nathan Scotta844f452005-11-02 14:38:42 +110095static inline xfs_filblks_t startblockval(xfs_fsblock_t x)
96{
97 return (xfs_filblks_t)((x) & ~STARTBLOCKMASK);
98}
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
100/*
101 * Possible extent formats.
102 */
103typedef enum {
104 XFS_EXTFMT_NOSTATE = 0,
105 XFS_EXTFMT_HASSTATE
106} xfs_exntfmt_t;
107
108/*
109 * Possible extent states.
110 */
111typedef enum {
112 XFS_EXT_NORM, XFS_EXT_UNWRITTEN,
113 XFS_EXT_DMAPI_OFFLINE, XFS_EXT_INVALID
114} xfs_exntst_t;
115
116/*
117 * Extent state and extent format macros.
118 */
Nathan Scotta844f452005-11-02 14:38:42 +1100119#define XFS_EXTFMT_INODE(x) \
Eric Sandeen62118702008-03-06 13:44:28 +1100120 (xfs_sb_version_hasextflgbit(&((x)->i_mount->m_sb)) ? \
Nathan Scotta844f452005-11-02 14:38:42 +1100121 XFS_EXTFMT_HASSTATE : XFS_EXTFMT_NOSTATE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122#define ISUNWRITTEN(x) ((x)->br_state == XFS_EXT_UNWRITTEN)
123
124/*
125 * Incore version of above.
126 */
127typedef struct xfs_bmbt_irec
128{
129 xfs_fileoff_t br_startoff; /* starting file offset */
130 xfs_fsblock_t br_startblock; /* starting block number */
131 xfs_filblks_t br_blockcount; /* number of blocks */
132 xfs_exntst_t br_state; /* extent state */
133} xfs_bmbt_irec_t;
134
135/*
136 * Key structure for non-leaf levels of the tree.
137 */
Christoph Hellwig8801bb92006-09-28 10:58:17 +1000138typedef struct xfs_bmbt_key {
139 __be64 br_startoff; /* starting file offset */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140} xfs_bmbt_key_t, xfs_bmdr_key_t;
141
Christoph Hellwig397b5202006-09-28 10:57:52 +1000142/* btree pointer type */
143typedef __be64 xfs_bmbt_ptr_t, xfs_bmdr_ptr_t;
144
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100145/*
146 * Btree block header size depends on a superblock flag.
147 *
148 * (not quite yet, but soon)
149 */
150#define XFS_BMBT_BLOCK_LEN(mp) XFS_BTREE_LBLOCK_LEN
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
Christoph Hellwig136341b2008-10-30 17:11:40 +1100152#define XFS_BMBT_REC_ADDR(mp, block, index) \
153 ((xfs_bmbt_rec_t *) \
154 ((char *)(block) + \
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100155 XFS_BMBT_BLOCK_LEN(mp) + \
Christoph Hellwig136341b2008-10-30 17:11:40 +1100156 ((index) - 1) * sizeof(xfs_bmbt_rec_t)))
Eric Sandeen2c36dde2007-02-10 18:37:33 +1100157
Christoph Hellwig136341b2008-10-30 17:11:40 +1100158#define XFS_BMBT_KEY_ADDR(mp, block, index) \
159 ((xfs_bmbt_key_t *) \
160 ((char *)(block) + \
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100161 XFS_BMBT_BLOCK_LEN(mp) + \
Christoph Hellwig136341b2008-10-30 17:11:40 +1100162 ((index) - 1) * sizeof(xfs_bmbt_key_t)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Christoph Hellwig136341b2008-10-30 17:11:40 +1100164#define XFS_BMBT_PTR_ADDR(mp, block, index, maxrecs) \
165 ((xfs_bmbt_ptr_t *) \
166 ((char *)(block) + \
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100167 XFS_BMBT_BLOCK_LEN(mp) + \
Christoph Hellwig136341b2008-10-30 17:11:40 +1100168 (maxrecs) * sizeof(xfs_bmbt_key_t) + \
169 ((index) - 1) * sizeof(xfs_bmbt_ptr_t)))
Eric Sandeen2c36dde2007-02-10 18:37:33 +1100170
Christoph Hellwig136341b2008-10-30 17:11:40 +1100171#define XFS_BMDR_REC_ADDR(block, index) \
172 ((xfs_bmdr_rec_t *) \
173 ((char *)(block) + \
174 sizeof(struct xfs_bmdr_block) + \
175 ((index) - 1) * sizeof(xfs_bmdr_rec_t)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Christoph Hellwig136341b2008-10-30 17:11:40 +1100177#define XFS_BMDR_KEY_ADDR(block, index) \
178 ((xfs_bmdr_key_t *) \
179 ((char *)(block) + \
180 sizeof(struct xfs_bmdr_block) + \
181 ((index) - 1) * sizeof(xfs_bmdr_key_t)))
182
183#define XFS_BMDR_PTR_ADDR(block, index, maxrecs) \
184 ((xfs_bmdr_ptr_t *) \
185 ((char *)(block) + \
186 sizeof(struct xfs_bmdr_block) + \
187 (maxrecs) * sizeof(xfs_bmdr_key_t) + \
188 ((index) - 1) * sizeof(xfs_bmdr_ptr_t)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
190/*
191 * These are to be used when we know the size of the block and
192 * we don't have a cursor.
193 */
Christoph Hellwig136341b2008-10-30 17:11:40 +1100194#define XFS_BMAP_BROOT_PTR_ADDR(mp, bb, i, sz) \
195 XFS_BMBT_PTR_ADDR(mp, bb, i, xfs_bmbt_maxrecs(mp, sz, 0))
Nathan Scotta844f452005-11-02 14:38:42 +1100196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197#define XFS_BMAP_BROOT_SPACE_CALC(nrecs) \
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100198 (int)(XFS_BTREE_LBLOCK_LEN + \
Nathan Scotta844f452005-11-02 14:38:42 +1100199 ((nrecs) * (sizeof(xfs_bmbt_key_t) + sizeof(xfs_bmbt_ptr_t))))
200
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201#define XFS_BMAP_BROOT_SPACE(bb) \
Christoph Hellwig16259e72005-11-02 15:11:25 +1100202 (XFS_BMAP_BROOT_SPACE_CALC(be16_to_cpu((bb)->bb_numrecs)))
Nathan Scotta844f452005-11-02 14:38:42 +1100203#define XFS_BMDR_SPACE_CALC(nrecs) \
204 (int)(sizeof(xfs_bmdr_block_t) + \
205 ((nrecs) * (sizeof(xfs_bmbt_key_t) + sizeof(xfs_bmbt_ptr_t))))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207/*
208 * Maximum number of bmap btree levels.
209 */
Nathan Scotta844f452005-11-02 14:38:42 +1100210#define XFS_BM_MAXLEVELS(mp,w) ((mp)->m_bm_maxlevels[(w)])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212/*
213 * Prototypes for xfs_bmap.c to call.
214 */
Christoph Hellwig60197e82008-10-30 17:11:19 +1100215extern void xfs_bmdr_to_bmbt(struct xfs_mount *, xfs_bmdr_block_t *, int,
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100216 struct xfs_btree_block *, int);
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000217extern void xfs_bmbt_get_all(xfs_bmbt_rec_host_t *r, xfs_bmbt_irec_t *s);
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000218extern xfs_filblks_t xfs_bmbt_get_blockcount(xfs_bmbt_rec_host_t *r);
219extern xfs_fsblock_t xfs_bmbt_get_startblock(xfs_bmbt_rec_host_t *r);
220extern xfs_fileoff_t xfs_bmbt_get_startoff(xfs_bmbt_rec_host_t *r);
221extern xfs_exntst_t xfs_bmbt_get_state(xfs_bmbt_rec_host_t *r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Nathan Scotta844f452005-11-02 14:38:42 +1100223extern xfs_filblks_t xfs_bmbt_disk_get_blockcount(xfs_bmbt_rec_t *r);
Nathan Scotta844f452005-11-02 14:38:42 +1100224extern xfs_fileoff_t xfs_bmbt_disk_get_startoff(xfs_bmbt_rec_t *r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000226extern void xfs_bmbt_set_all(xfs_bmbt_rec_host_t *r, xfs_bmbt_irec_t *s);
227extern void xfs_bmbt_set_allf(xfs_bmbt_rec_host_t *r, xfs_fileoff_t o,
Nathan Scotta844f452005-11-02 14:38:42 +1100228 xfs_fsblock_t b, xfs_filblks_t c, xfs_exntst_t v);
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000229extern void xfs_bmbt_set_blockcount(xfs_bmbt_rec_host_t *r, xfs_filblks_t v);
230extern void xfs_bmbt_set_startblock(xfs_bmbt_rec_host_t *r, xfs_fsblock_t v);
231extern void xfs_bmbt_set_startoff(xfs_bmbt_rec_host_t *r, xfs_fileoff_t v);
232extern void xfs_bmbt_set_state(xfs_bmbt_rec_host_t *r, xfs_exntst_t v);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Nathan Scotta844f452005-11-02 14:38:42 +1100234extern void xfs_bmbt_disk_set_all(xfs_bmbt_rec_t *r, xfs_bmbt_irec_t *s);
235extern void xfs_bmbt_disk_set_allf(xfs_bmbt_rec_t *r, xfs_fileoff_t o,
236 xfs_fsblock_t b, xfs_filblks_t c, xfs_exntst_t v);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100238extern void xfs_bmbt_to_bmdr(struct xfs_mount *, struct xfs_btree_block *, int,
Christoph Hellwig60197e82008-10-30 17:11:19 +1100239 xfs_bmdr_block_t *, int);
240
241extern int xfs_bmbt_get_maxrecs(struct xfs_btree_cur *, int level);
242extern int xfs_bmdr_maxrecs(struct xfs_mount *, int blocklen, int leaf);
243extern int xfs_bmbt_maxrecs(struct xfs_mount *, int blocklen, int leaf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Christoph Hellwig561f7d12008-10-30 16:53:59 +1100245extern struct xfs_btree_cur *xfs_bmbt_init_cursor(struct xfs_mount *,
246 struct xfs_trans *, struct xfs_inode *, int);
247
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249#endif /* __XFS_BMAP_BTREE_H__ */