blob: 70c43d9f72c1a8a45800374edb411a2a42e84c71 [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
Christoph Hellwigee1a47a2013-04-21 14:53:46 -050021#define XFS_BMAP_MAGIC 0x424d4150 /* 'BMAP' */
22#define XFS_BMAP_CRC_MAGIC 0x424d4133 /* 'BMA3' */
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24struct xfs_btree_cur;
Christoph Hellwig136341b2008-10-30 17:11:40 +110025struct xfs_btree_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -070026struct xfs_mount;
27struct xfs_inode;
Christoph Hellwig561f7d12008-10-30 16:53:59 +110028struct xfs_trans;
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30/*
31 * Bmap root header, on-disk form only.
32 */
Christoph Hellwig16259e72005-11-02 15:11:25 +110033typedef struct xfs_bmdr_block {
34 __be16 bb_level; /* 0 is a leaf */
35 __be16 bb_numrecs; /* current # of data records */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036} xfs_bmdr_block_t;
37
38/*
39 * Bmap btree record and extent descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 * l0:63 is an extent flag (value 1 indicates non-normal).
41 * l0:9-62 are startoff.
42 * l0:0-8 and l1:21-63 are startblock.
43 * l1:0-20 are blockcount.
44 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#define BMBT_EXNTFLAG_BITLEN 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#define BMBT_STARTOFF_BITLEN 54
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define BMBT_STARTBLOCK_BITLEN 52
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#define BMBT_BLOCKCOUNT_BITLEN 21
49
Christoph Hellwiga5f9be52009-12-04 10:19:07 +000050typedef struct xfs_bmbt_rec {
Christoph Hellwigcd8b0a92007-08-16 16:24:15 +100051 __be64 l0, l1;
Christoph Hellwiga5f9be52009-12-04 10:19:07 +000052} xfs_bmbt_rec_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54typedef __uint64_t xfs_bmbt_rec_base_t; /* use this for casts */
Christoph Hellwiga5f9be52009-12-04 10:19:07 +000055typedef xfs_bmbt_rec_t xfs_bmdr_rec_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Christoph Hellwiga6f64d42007-08-16 16:23:40 +100057typedef struct xfs_bmbt_rec_host {
58 __uint64_t l0, l1;
59} xfs_bmbt_rec_host_t;
60
Linus Torvalds1da177e2005-04-16 15:20:36 -070061/*
62 * Values and macros for delayed-allocation startblock fields.
63 */
64#define STARTBLOCKVALBITS 17
65#define STARTBLOCKMASKBITS (15 + XFS_BIG_BLKNOS * 20)
66#define DSTARTBLOCKMASKBITS (15 + 20)
67#define STARTBLOCKMASK \
68 (((((xfs_fsblock_t)1) << STARTBLOCKMASKBITS) - 1) << STARTBLOCKVALBITS)
69#define DSTARTBLOCKMASK \
70 (((((xfs_dfsbno_t)1) << DSTARTBLOCKMASKBITS) - 1) << STARTBLOCKVALBITS)
Nathan Scotta844f452005-11-02 14:38:42 +110071
Nathan Scotta844f452005-11-02 14:38:42 +110072static inline int isnullstartblock(xfs_fsblock_t x)
73{
74 return ((x) & STARTBLOCKMASK) == STARTBLOCKMASK;
75}
76
Nathan Scotta844f452005-11-02 14:38:42 +110077static inline int isnulldstartblock(xfs_dfsbno_t x)
78{
79 return ((x) & DSTARTBLOCKMASK) == DSTARTBLOCKMASK;
80}
81
Nathan Scotta844f452005-11-02 14:38:42 +110082static inline xfs_fsblock_t nullstartblock(int k)
83{
84 ASSERT(k < (1 << STARTBLOCKVALBITS));
85 return STARTBLOCKMASK | (k);
86}
87
Nathan Scotta844f452005-11-02 14:38:42 +110088static inline xfs_filblks_t startblockval(xfs_fsblock_t x)
89{
90 return (xfs_filblks_t)((x) & ~STARTBLOCKMASK);
91}
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93/*
94 * Possible extent formats.
95 */
96typedef enum {
97 XFS_EXTFMT_NOSTATE = 0,
98 XFS_EXTFMT_HASSTATE
99} xfs_exntfmt_t;
100
101/*
102 * Possible extent states.
103 */
104typedef enum {
105 XFS_EXT_NORM, XFS_EXT_UNWRITTEN,
106 XFS_EXT_DMAPI_OFFLINE, XFS_EXT_INVALID
107} xfs_exntst_t;
108
109/*
110 * Extent state and extent format macros.
111 */
Nathan Scotta844f452005-11-02 14:38:42 +1100112#define XFS_EXTFMT_INODE(x) \
Eric Sandeen62118702008-03-06 13:44:28 +1100113 (xfs_sb_version_hasextflgbit(&((x)->i_mount->m_sb)) ? \
Nathan Scotta844f452005-11-02 14:38:42 +1100114 XFS_EXTFMT_HASSTATE : XFS_EXTFMT_NOSTATE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115#define ISUNWRITTEN(x) ((x)->br_state == XFS_EXT_UNWRITTEN)
116
117/*
118 * Incore version of above.
119 */
120typedef struct xfs_bmbt_irec
121{
122 xfs_fileoff_t br_startoff; /* starting file offset */
123 xfs_fsblock_t br_startblock; /* starting block number */
124 xfs_filblks_t br_blockcount; /* number of blocks */
125 xfs_exntst_t br_state; /* extent state */
126} xfs_bmbt_irec_t;
127
128/*
129 * Key structure for non-leaf levels of the tree.
130 */
Christoph Hellwig8801bb92006-09-28 10:58:17 +1000131typedef struct xfs_bmbt_key {
132 __be64 br_startoff; /* starting file offset */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133} xfs_bmbt_key_t, xfs_bmdr_key_t;
134
Christoph Hellwig397b5202006-09-28 10:57:52 +1000135/* btree pointer type */
136typedef __be64 xfs_bmbt_ptr_t, xfs_bmdr_ptr_t;
137
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100138/*
139 * Btree block header size depends on a superblock flag.
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100140 */
Christoph Hellwigee1a47a2013-04-21 14:53:46 -0500141#define XFS_BMBT_BLOCK_LEN(mp) \
142 (xfs_sb_version_hascrc(&((mp)->m_sb)) ? \
143 XFS_BTREE_LBLOCK_CRC_LEN : XFS_BTREE_LBLOCK_LEN)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
Christoph Hellwig136341b2008-10-30 17:11:40 +1100145#define XFS_BMBT_REC_ADDR(mp, block, index) \
146 ((xfs_bmbt_rec_t *) \
147 ((char *)(block) + \
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100148 XFS_BMBT_BLOCK_LEN(mp) + \
Christoph Hellwig136341b2008-10-30 17:11:40 +1100149 ((index) - 1) * sizeof(xfs_bmbt_rec_t)))
Eric Sandeen2c36dde2007-02-10 18:37:33 +1100150
Christoph Hellwig136341b2008-10-30 17:11:40 +1100151#define XFS_BMBT_KEY_ADDR(mp, block, index) \
152 ((xfs_bmbt_key_t *) \
153 ((char *)(block) + \
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100154 XFS_BMBT_BLOCK_LEN(mp) + \
Christoph Hellwig136341b2008-10-30 17:11:40 +1100155 ((index) - 1) * sizeof(xfs_bmbt_key_t)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Christoph Hellwig136341b2008-10-30 17:11:40 +1100157#define XFS_BMBT_PTR_ADDR(mp, block, index, maxrecs) \
158 ((xfs_bmbt_ptr_t *) \
159 ((char *)(block) + \
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100160 XFS_BMBT_BLOCK_LEN(mp) + \
Christoph Hellwig136341b2008-10-30 17:11:40 +1100161 (maxrecs) * sizeof(xfs_bmbt_key_t) + \
162 ((index) - 1) * sizeof(xfs_bmbt_ptr_t)))
Eric Sandeen2c36dde2007-02-10 18:37:33 +1100163
Christoph Hellwig136341b2008-10-30 17:11:40 +1100164#define XFS_BMDR_REC_ADDR(block, index) \
165 ((xfs_bmdr_rec_t *) \
166 ((char *)(block) + \
167 sizeof(struct xfs_bmdr_block) + \
168 ((index) - 1) * sizeof(xfs_bmdr_rec_t)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Christoph Hellwig136341b2008-10-30 17:11:40 +1100170#define XFS_BMDR_KEY_ADDR(block, index) \
171 ((xfs_bmdr_key_t *) \
172 ((char *)(block) + \
173 sizeof(struct xfs_bmdr_block) + \
174 ((index) - 1) * sizeof(xfs_bmdr_key_t)))
175
176#define XFS_BMDR_PTR_ADDR(block, index, maxrecs) \
177 ((xfs_bmdr_ptr_t *) \
178 ((char *)(block) + \
179 sizeof(struct xfs_bmdr_block) + \
180 (maxrecs) * sizeof(xfs_bmdr_key_t) + \
181 ((index) - 1) * sizeof(xfs_bmdr_ptr_t)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183/*
184 * These are to be used when we know the size of the block and
185 * we don't have a cursor.
186 */
Christoph Hellwig136341b2008-10-30 17:11:40 +1100187#define XFS_BMAP_BROOT_PTR_ADDR(mp, bb, i, sz) \
188 XFS_BMBT_PTR_ADDR(mp, bb, i, xfs_bmbt_maxrecs(mp, sz, 0))
Nathan Scotta844f452005-11-02 14:38:42 +1100189
Christoph Hellwigee1a47a2013-04-21 14:53:46 -0500190#define XFS_BMAP_BROOT_SPACE_CALC(mp, nrecs) \
191 (int)(XFS_BMBT_BLOCK_LEN(mp) + \
Nathan Scotta844f452005-11-02 14:38:42 +1100192 ((nrecs) * (sizeof(xfs_bmbt_key_t) + sizeof(xfs_bmbt_ptr_t))))
193
Christoph Hellwigee1a47a2013-04-21 14:53:46 -0500194#define XFS_BMAP_BROOT_SPACE(mp, bb) \
195 (XFS_BMAP_BROOT_SPACE_CALC(mp, be16_to_cpu((bb)->bb_numrecs)))
Nathan Scotta844f452005-11-02 14:38:42 +1100196#define XFS_BMDR_SPACE_CALC(nrecs) \
197 (int)(sizeof(xfs_bmdr_block_t) + \
198 ((nrecs) * (sizeof(xfs_bmbt_key_t) + sizeof(xfs_bmbt_ptr_t))))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200/*
201 * Maximum number of bmap btree levels.
202 */
Nathan Scotta844f452005-11-02 14:38:42 +1100203#define XFS_BM_MAXLEVELS(mp,w) ((mp)->m_bm_maxlevels[(w)])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205/*
206 * Prototypes for xfs_bmap.c to call.
207 */
Christoph Hellwigee1a47a2013-04-21 14:53:46 -0500208extern void xfs_bmdr_to_bmbt(struct xfs_inode *, xfs_bmdr_block_t *, int,
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100209 struct xfs_btree_block *, int);
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000210extern void xfs_bmbt_get_all(xfs_bmbt_rec_host_t *r, xfs_bmbt_irec_t *s);
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000211extern xfs_filblks_t xfs_bmbt_get_blockcount(xfs_bmbt_rec_host_t *r);
212extern xfs_fsblock_t xfs_bmbt_get_startblock(xfs_bmbt_rec_host_t *r);
213extern xfs_fileoff_t xfs_bmbt_get_startoff(xfs_bmbt_rec_host_t *r);
214extern xfs_exntst_t xfs_bmbt_get_state(xfs_bmbt_rec_host_t *r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Nathan Scotta844f452005-11-02 14:38:42 +1100216extern xfs_filblks_t xfs_bmbt_disk_get_blockcount(xfs_bmbt_rec_t *r);
Nathan Scotta844f452005-11-02 14:38:42 +1100217extern xfs_fileoff_t xfs_bmbt_disk_get_startoff(xfs_bmbt_rec_t *r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000219extern void xfs_bmbt_set_all(xfs_bmbt_rec_host_t *r, xfs_bmbt_irec_t *s);
220extern void xfs_bmbt_set_allf(xfs_bmbt_rec_host_t *r, xfs_fileoff_t o,
Nathan Scotta844f452005-11-02 14:38:42 +1100221 xfs_fsblock_t b, xfs_filblks_t c, xfs_exntst_t v);
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000222extern void xfs_bmbt_set_blockcount(xfs_bmbt_rec_host_t *r, xfs_filblks_t v);
223extern void xfs_bmbt_set_startblock(xfs_bmbt_rec_host_t *r, xfs_fsblock_t v);
224extern void xfs_bmbt_set_startoff(xfs_bmbt_rec_host_t *r, xfs_fileoff_t v);
225extern void xfs_bmbt_set_state(xfs_bmbt_rec_host_t *r, xfs_exntst_t v);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
Nathan Scotta844f452005-11-02 14:38:42 +1100227extern void xfs_bmbt_disk_set_allf(xfs_bmbt_rec_t *r, xfs_fileoff_t o,
228 xfs_fsblock_t b, xfs_filblks_t c, xfs_exntst_t v);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Christoph Hellwig7cc95a82008-10-30 17:14:34 +1100230extern void xfs_bmbt_to_bmdr(struct xfs_mount *, struct xfs_btree_block *, int,
Christoph Hellwig60197e82008-10-30 17:11:19 +1100231 xfs_bmdr_block_t *, int);
232
233extern int xfs_bmbt_get_maxrecs(struct xfs_btree_cur *, int level);
234extern int xfs_bmdr_maxrecs(struct xfs_mount *, int blocklen, int leaf);
235extern int xfs_bmbt_maxrecs(struct xfs_mount *, int blocklen, int leaf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Christoph Hellwig561f7d12008-10-30 16:53:59 +1100237extern struct xfs_btree_cur *xfs_bmbt_init_cursor(struct xfs_mount *,
238 struct xfs_trans *, struct xfs_inode *, int);
239
Dave Chinner1813dd62012-11-14 17:54:40 +1100240extern const struct xfs_buf_ops xfs_bmbt_buf_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
242#endif /* __XFS_BMAP_BTREE_H__ */