blob: bce81c7a4fdc4212a6db024c8900add19e6938b8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000,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_ALLOC_BTREE_H__
19#define __XFS_ALLOC_BTREE_H__
20
21/*
22 * Freespace on-disk structures
23 */
24
25struct xfs_buf;
26struct xfs_btree_cur;
27struct xfs_btree_sblock;
28struct xfs_mount;
29
30/*
31 * There are two on-disk btrees, one sorted by blockno and one sorted
32 * by blockcount and blockno. All blocks look the same to make the code
33 * simpler; if we have time later, we'll make the optimizations.
34 */
35#define XFS_ABTB_MAGIC 0x41425442 /* 'ABTB' for bno tree */
36#define XFS_ABTC_MAGIC 0x41425443 /* 'ABTC' for cnt tree */
37
38/*
39 * Data record/key structure
40 */
Christoph Hellwig16259e72005-11-02 15:11:25 +110041typedef struct xfs_alloc_rec {
42 __be32 ar_startblock; /* starting block number */
43 __be32 ar_blockcount; /* count of free blocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -070044} xfs_alloc_rec_t, xfs_alloc_key_t;
45
Christoph Hellwig16259e72005-11-02 15:11:25 +110046typedef struct xfs_alloc_rec_incore {
47 xfs_agblock_t ar_startblock; /* starting block number */
48 xfs_extlen_t ar_blockcount; /* count of free blocks */
49} xfs_alloc_rec_incore_t;
50
51/* btree pointer type */
52typedef __be32 xfs_alloc_ptr_t;
53/* btree block header type */
Linus Torvalds1da177e2005-04-16 15:20:36 -070054typedef struct xfs_btree_sblock xfs_alloc_block_t;
55
Nathan Scotta844f452005-11-02 14:38:42 +110056#define XFS_BUF_TO_ALLOC_BLOCK(bp) ((xfs_alloc_block_t *)XFS_BUF_PTR(bp))
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
58/*
59 * Real block structures have a size equal to the disk block size.
60 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070061#define XFS_ALLOC_BLOCK_SIZE(lev,cur) (1 << (cur)->bc_blocklog)
Nathan Scotta844f452005-11-02 14:38:42 +110062#define XFS_ALLOC_BLOCK_MAXRECS(lev,cur) ((cur)->bc_mp->m_alloc_mxr[lev != 0])
63#define XFS_ALLOC_BLOCK_MINRECS(lev,cur) ((cur)->bc_mp->m_alloc_mnr[lev != 0])
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65/*
66 * Minimum and maximum blocksize and sectorsize.
67 * The blocksize upper limit is pretty much arbitrary.
68 * The sectorsize upper limit is due to sizeof(sb_sectsize).
69 */
70#define XFS_MIN_BLOCKSIZE_LOG 9 /* i.e. 512 bytes */
71#define XFS_MAX_BLOCKSIZE_LOG 16 /* i.e. 65536 bytes */
72#define XFS_MIN_BLOCKSIZE (1 << XFS_MIN_BLOCKSIZE_LOG)
73#define XFS_MAX_BLOCKSIZE (1 << XFS_MAX_BLOCKSIZE_LOG)
74#define XFS_MIN_SECTORSIZE_LOG 9 /* i.e. 512 bytes */
75#define XFS_MAX_SECTORSIZE_LOG 15 /* i.e. 32768 bytes */
76#define XFS_MIN_SECTORSIZE (1 << XFS_MIN_SECTORSIZE_LOG)
77#define XFS_MAX_SECTORSIZE (1 << XFS_MAX_SECTORSIZE_LOG)
78
79/*
80 * Block numbers in the AG:
81 * SB is sector 0, AGF is sector 1, AGI is sector 2, AGFL is sector 3.
82 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070083#define XFS_BNO_BLOCK(mp) ((xfs_agblock_t)(XFS_AGFL_BLOCK(mp) + 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -070084#define XFS_CNT_BLOCK(mp) ((xfs_agblock_t)(XFS_BNO_BLOCK(mp) + 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86/*
87 * Record, key, and pointer address macros for btree blocks.
88 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089#define XFS_ALLOC_REC_ADDR(bb,i,cur) \
Nathan Scotta844f452005-11-02 14:38:42 +110090 XFS_BTREE_REC_ADDR(XFS_ALLOC_BLOCK_SIZE(0,cur), xfs_alloc, \
91 bb, i, XFS_ALLOC_BLOCK_MAXRECS(0, cur))
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Linus Torvalds1da177e2005-04-16 15:20:36 -070093#define XFS_ALLOC_KEY_ADDR(bb,i,cur) \
Nathan Scotta844f452005-11-02 14:38:42 +110094 XFS_BTREE_KEY_ADDR(XFS_ALLOC_BLOCK_SIZE(1,cur), xfs_alloc, \
95 bb, i, XFS_ALLOC_BLOCK_MAXRECS(1, cur))
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#define XFS_ALLOC_PTR_ADDR(bb,i,cur) \
Nathan Scotta844f452005-11-02 14:38:42 +110098 XFS_BTREE_PTR_ADDR(XFS_ALLOC_BLOCK_SIZE(1,cur), xfs_alloc, \
99 bb, i, XFS_ALLOC_BLOCK_MAXRECS(1, cur))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
101/*
102 * Decrement cursor by one record at the level.
103 * For nonzero levels the leaf-ward information is untouched.
104 */
Nathan Scotta844f452005-11-02 14:38:42 +1100105extern int xfs_alloc_decrement(struct xfs_btree_cur *cur, int level, int *stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
107/*
108 * Delete the record pointed to by cur.
109 * The cursor refers to the place where the record was (could be inserted)
110 * when the operation returns.
111 */
Nathan Scotta844f452005-11-02 14:38:42 +1100112extern int xfs_alloc_delete(struct xfs_btree_cur *cur, int *stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114/*
115 * Get the data from the pointed-to record.
116 */
Nathan Scotta844f452005-11-02 14:38:42 +1100117extern int xfs_alloc_get_rec(struct xfs_btree_cur *cur, xfs_agblock_t *bno,
118 xfs_extlen_t *len, int *stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120/*
121 * Increment cursor by one record at the level.
122 * For nonzero levels the leaf-ward information is untouched.
123 */
Nathan Scotta844f452005-11-02 14:38:42 +1100124extern int xfs_alloc_increment(struct xfs_btree_cur *cur, int level, int *stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126/*
127 * Insert the current record at the point referenced by cur.
128 * The cursor may be inconsistent on return if splits have been done.
129 */
Nathan Scotta844f452005-11-02 14:38:42 +1100130extern int xfs_alloc_insert(struct xfs_btree_cur *cur, int *stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132/*
133 * Lookup the record equal to [bno, len] in the btree given by cur.
134 */
Nathan Scotta844f452005-11-02 14:38:42 +1100135extern int xfs_alloc_lookup_eq(struct xfs_btree_cur *cur, xfs_agblock_t bno,
136 xfs_extlen_t len, int *stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138/*
139 * Lookup the first record greater than or equal to [bno, len]
140 * in the btree given by cur.
141 */
Nathan Scotta844f452005-11-02 14:38:42 +1100142extern int xfs_alloc_lookup_ge(struct xfs_btree_cur *cur, xfs_agblock_t bno,
143 xfs_extlen_t len, int *stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145/*
146 * Lookup the first record less than or equal to [bno, len]
147 * in the btree given by cur.
148 */
Nathan Scotta844f452005-11-02 14:38:42 +1100149extern int xfs_alloc_lookup_le(struct xfs_btree_cur *cur, xfs_agblock_t bno,
150 xfs_extlen_t len, int *stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152/*
153 * Update the record referred to by cur, to the value given by [bno, len].
154 * This either works (return 0) or gets an EFSCORRUPTED error.
155 */
Nathan Scotta844f452005-11-02 14:38:42 +1100156extern int xfs_alloc_update(struct xfs_btree_cur *cur, xfs_agblock_t bno,
157 xfs_extlen_t len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
159#endif /* __XFS_ALLOC_BTREE_H__ */