Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
7b718769 NS |
2 | * Copyright (c) 2000-2001,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_BTREE_H__ | |
19 | #define __XFS_BTREE_H__ | |
20 | ||
21 | struct xfs_buf; | |
22 | struct xfs_bmap_free; | |
23 | struct xfs_inode; | |
24 | struct xfs_mount; | |
25 | struct xfs_trans; | |
26 | ||
a8272ce0 DC |
27 | extern kmem_zone_t *xfs_btree_cur_zone; |
28 | ||
1da177e4 LT |
29 | /* |
30 | * This nonsense is to make -wlint happy. | |
31 | */ | |
32 | #define XFS_LOOKUP_EQ ((xfs_lookup_t)XFS_LOOKUP_EQi) | |
33 | #define XFS_LOOKUP_LE ((xfs_lookup_t)XFS_LOOKUP_LEi) | |
34 | #define XFS_LOOKUP_GE ((xfs_lookup_t)XFS_LOOKUP_GEi) | |
35 | ||
36 | #define XFS_BTNUM_BNO ((xfs_btnum_t)XFS_BTNUM_BNOi) | |
37 | #define XFS_BTNUM_CNT ((xfs_btnum_t)XFS_BTNUM_CNTi) | |
38 | #define XFS_BTNUM_BMAP ((xfs_btnum_t)XFS_BTNUM_BMAPi) | |
39 | #define XFS_BTNUM_INO ((xfs_btnum_t)XFS_BTNUM_INOi) | |
40 | ||
41 | /* | |
42 | * Short form header: space allocation btrees. | |
43 | */ | |
16259e7d CH |
44 | typedef struct xfs_btree_sblock { |
45 | __be32 bb_magic; /* magic number for block type */ | |
46 | __be16 bb_level; /* 0 is a leaf */ | |
47 | __be16 bb_numrecs; /* current # of data records */ | |
48 | __be32 bb_leftsib; /* left sibling block or NULLAGBLOCK */ | |
49 | __be32 bb_rightsib; /* right sibling block or NULLAGBLOCK */ | |
1da177e4 LT |
50 | } xfs_btree_sblock_t; |
51 | ||
52 | /* | |
53 | * Long form header: bmap btrees. | |
54 | */ | |
16259e7d CH |
55 | typedef struct xfs_btree_lblock { |
56 | __be32 bb_magic; /* magic number for block type */ | |
57 | __be16 bb_level; /* 0 is a leaf */ | |
58 | __be16 bb_numrecs; /* current # of data records */ | |
59 | __be64 bb_leftsib; /* left sibling block or NULLDFSBNO */ | |
60 | __be64 bb_rightsib; /* right sibling block or NULLDFSBNO */ | |
1da177e4 LT |
61 | } xfs_btree_lblock_t; |
62 | ||
63 | /* | |
64 | * Combined header and structure, used by common code. | |
65 | */ | |
f2277f06 | 66 | typedef struct xfs_btree_block { |
16259e7d CH |
67 | __be32 bb_magic; /* magic number for block type */ |
68 | __be16 bb_level; /* 0 is a leaf */ | |
69 | __be16 bb_numrecs; /* current # of data records */ | |
16259e7d CH |
70 | union { |
71 | struct { | |
72 | __be32 bb_leftsib; | |
73 | __be32 bb_rightsib; | |
74 | } s; /* short form pointers */ | |
1da177e4 | 75 | struct { |
16259e7d CH |
76 | __be64 bb_leftsib; |
77 | __be64 bb_rightsib; | |
78 | } l; /* long form pointers */ | |
79 | } bb_u; /* rest */ | |
1da177e4 LT |
80 | } xfs_btree_block_t; |
81 | ||
82 | /* | |
83 | * For logging record fields. | |
84 | */ | |
85 | #define XFS_BB_MAGIC 0x01 | |
86 | #define XFS_BB_LEVEL 0x02 | |
87 | #define XFS_BB_NUMRECS 0x04 | |
88 | #define XFS_BB_LEFTSIB 0x08 | |
89 | #define XFS_BB_RIGHTSIB 0x10 | |
90 | #define XFS_BB_NUM_BITS 5 | |
91 | #define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1) | |
92 | ||
93 | /* | |
94 | * Boolean to select which form of xfs_btree_block_t.bb_u to use. | |
95 | */ | |
1da177e4 | 96 | #define XFS_BTREE_LONG_PTRS(btnum) ((btnum) == XFS_BTNUM_BMAP) |
1da177e4 LT |
97 | |
98 | /* | |
99 | * Magic numbers for btree blocks. | |
100 | */ | |
101 | extern const __uint32_t xfs_magics[]; | |
102 | ||
103 | /* | |
104 | * Maximum and minimum records in a btree block. | |
105 | * Given block size, type prefix, and leaf flag (0 or 1). | |
106 | * The divisor below is equivalent to lf ? (e1) : (e2) but that produces | |
107 | * compiler warnings. | |
108 | */ | |
109 | #define XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) \ | |
110 | ((int)(((bsz) - (uint)sizeof(t ## _block_t)) / \ | |
111 | (((lf) * (uint)sizeof(t ## _rec_t)) + \ | |
112 | ((1 - (lf)) * \ | |
113 | ((uint)sizeof(t ## _key_t) + (uint)sizeof(t ## _ptr_t)))))) | |
114 | #define XFS_BTREE_BLOCK_MINRECS(bsz,t,lf) \ | |
115 | (XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) / 2) | |
116 | ||
117 | /* | |
118 | * Record, key, and pointer address calculation macros. | |
119 | * Given block size, type prefix, block pointer, and index of requested entry | |
120 | * (first entry numbered 1). | |
121 | */ | |
2c36dded | 122 | #define XFS_BTREE_REC_ADDR(t,bb,i) \ |
1da177e4 LT |
123 | ((t ## _rec_t *)((char *)(bb) + sizeof(t ## _block_t) + \ |
124 | ((i) - 1) * sizeof(t ## _rec_t))) | |
2c36dded | 125 | #define XFS_BTREE_KEY_ADDR(t,bb,i) \ |
1da177e4 LT |
126 | ((t ## _key_t *)((char *)(bb) + sizeof(t ## _block_t) + \ |
127 | ((i) - 1) * sizeof(t ## _key_t))) | |
2c36dded | 128 | #define XFS_BTREE_PTR_ADDR(t,bb,i,mxr) \ |
1da177e4 LT |
129 | ((t ## _ptr_t *)((char *)(bb) + sizeof(t ## _block_t) + \ |
130 | (mxr) * sizeof(t ## _key_t) + ((i) - 1) * sizeof(t ## _ptr_t))) | |
131 | ||
132 | #define XFS_BTREE_MAXLEVELS 8 /* max of all btrees */ | |
133 | ||
134 | /* | |
135 | * Btree cursor structure. | |
136 | * This collects all information needed by the btree code in one place. | |
137 | */ | |
138 | typedef struct xfs_btree_cur | |
139 | { | |
140 | struct xfs_trans *bc_tp; /* transaction we're in, if any */ | |
141 | struct xfs_mount *bc_mp; /* file system mount struct */ | |
142 | union { | |
16259e7d | 143 | xfs_alloc_rec_incore_t a; |
1da177e4 | 144 | xfs_bmbt_irec_t b; |
61a25848 | 145 | xfs_inobt_rec_incore_t i; |
1da177e4 LT |
146 | } bc_rec; /* current insert/search record value */ |
147 | struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS]; /* buf ptr per level */ | |
148 | int bc_ptrs[XFS_BTREE_MAXLEVELS]; /* key/record # */ | |
149 | __uint8_t bc_ra[XFS_BTREE_MAXLEVELS]; /* readahead bits */ | |
150 | #define XFS_BTCUR_LEFTRA 1 /* left sibling has been read-ahead */ | |
151 | #define XFS_BTCUR_RIGHTRA 2 /* right sibling has been read-ahead */ | |
152 | __uint8_t bc_nlevels; /* number of levels in the tree */ | |
153 | __uint8_t bc_blocklog; /* log2(blocksize) of btree blocks */ | |
154 | xfs_btnum_t bc_btnum; /* identifies which btree type */ | |
155 | union { | |
169d6227 CH |
156 | struct { /* needed for BNO, CNT, INO */ |
157 | struct xfs_buf *agbp; /* agf/agi buffer pointer */ | |
1da177e4 LT |
158 | xfs_agnumber_t agno; /* ag number */ |
159 | } a; | |
160 | struct { /* needed for BMAP */ | |
161 | struct xfs_inode *ip; /* pointer to our inode */ | |
162 | struct xfs_bmap_free *flist; /* list to free after */ | |
163 | xfs_fsblock_t firstblock; /* 1st blk allocated */ | |
164 | int allocated; /* count of alloced */ | |
165 | short forksize; /* fork's inode space */ | |
166 | char whichfork; /* data or attr fork */ | |
167 | char flags; /* flags */ | |
168 | #define XFS_BTCUR_BPRV_WASDEL 1 /* was delayed */ | |
169 | } b; | |
1da177e4 LT |
170 | } bc_private; /* per-btree type data */ |
171 | } xfs_btree_cur_t; | |
172 | ||
173 | #define XFS_BTREE_NOERROR 0 | |
174 | #define XFS_BTREE_ERROR 1 | |
175 | ||
176 | /* | |
177 | * Convert from buffer to btree block header. | |
178 | */ | |
a844f451 NS |
179 | #define XFS_BUF_TO_BLOCK(bp) ((xfs_btree_block_t *)XFS_BUF_PTR(bp)) |
180 | #define XFS_BUF_TO_LBLOCK(bp) ((xfs_btree_lblock_t *)XFS_BUF_PTR(bp)) | |
181 | #define XFS_BUF_TO_SBLOCK(bp) ((xfs_btree_sblock_t *)XFS_BUF_PTR(bp)) | |
182 | ||
1da177e4 LT |
183 | |
184 | #ifdef __KERNEL__ | |
185 | ||
186 | #ifdef DEBUG | |
187 | /* | |
188 | * Debug routine: check that block header is ok. | |
189 | */ | |
190 | void | |
191 | xfs_btree_check_block( | |
192 | xfs_btree_cur_t *cur, /* btree cursor */ | |
193 | xfs_btree_block_t *block, /* generic btree block pointer */ | |
194 | int level, /* level of the btree block */ | |
195 | struct xfs_buf *bp); /* buffer containing block, if any */ | |
196 | ||
197 | /* | |
198 | * Debug routine: check that keys are in the right order. | |
199 | */ | |
200 | void | |
201 | xfs_btree_check_key( | |
202 | xfs_btnum_t btnum, /* btree identifier */ | |
203 | void *ak1, /* pointer to left (lower) key */ | |
204 | void *ak2); /* pointer to right (higher) key */ | |
205 | ||
206 | /* | |
207 | * Debug routine: check that records are in the right order. | |
208 | */ | |
209 | void | |
210 | xfs_btree_check_rec( | |
211 | xfs_btnum_t btnum, /* btree identifier */ | |
212 | void *ar1, /* pointer to left (lower) record */ | |
213 | void *ar2); /* pointer to right (higher) record */ | |
214 | #else | |
215 | #define xfs_btree_check_block(a,b,c,d) | |
216 | #define xfs_btree_check_key(a,b,c) | |
217 | #define xfs_btree_check_rec(a,b,c) | |
218 | #endif /* DEBUG */ | |
219 | ||
220 | /* | |
221 | * Checking routine: check that long form block header is ok. | |
222 | */ | |
223 | int /* error (0 or EFSCORRUPTED) */ | |
224 | xfs_btree_check_lblock( | |
225 | xfs_btree_cur_t *cur, /* btree cursor */ | |
226 | xfs_btree_lblock_t *block, /* btree long form block pointer */ | |
227 | int level, /* level of the btree block */ | |
228 | struct xfs_buf *bp); /* buffer containing block, if any */ | |
229 | ||
230 | /* | |
231 | * Checking routine: check that (long) pointer is ok. | |
232 | */ | |
233 | int /* error (0 or EFSCORRUPTED) */ | |
234 | xfs_btree_check_lptr( | |
235 | xfs_btree_cur_t *cur, /* btree cursor */ | |
236 | xfs_dfsbno_t ptr, /* btree block disk address */ | |
237 | int level); /* btree block level */ | |
238 | ||
b113bcb8 | 239 | #define xfs_btree_check_lptr_disk(cur, ptr, level) \ |
576039cf | 240 | xfs_btree_check_lptr(cur, be64_to_cpu(ptr), level) |
b113bcb8 | 241 | |
1da177e4 LT |
242 | /* |
243 | * Checking routine: check that short form block header is ok. | |
244 | */ | |
245 | int /* error (0 or EFSCORRUPTED) */ | |
246 | xfs_btree_check_sblock( | |
247 | xfs_btree_cur_t *cur, /* btree cursor */ | |
248 | xfs_btree_sblock_t *block, /* btree short form block pointer */ | |
249 | int level, /* level of the btree block */ | |
250 | struct xfs_buf *bp); /* buffer containing block */ | |
251 | ||
252 | /* | |
253 | * Checking routine: check that (short) pointer is ok. | |
254 | */ | |
255 | int /* error (0 or EFSCORRUPTED) */ | |
256 | xfs_btree_check_sptr( | |
257 | xfs_btree_cur_t *cur, /* btree cursor */ | |
258 | xfs_agblock_t ptr, /* btree block disk address */ | |
259 | int level); /* btree block level */ | |
260 | ||
261 | /* | |
262 | * Delete the btree cursor. | |
263 | */ | |
264 | void | |
265 | xfs_btree_del_cursor( | |
266 | xfs_btree_cur_t *cur, /* btree cursor */ | |
267 | int error); /* del because of error */ | |
268 | ||
269 | /* | |
270 | * Duplicate the btree cursor. | |
271 | * Allocate a new one, copy the record, re-get the buffers. | |
272 | */ | |
273 | int /* error */ | |
274 | xfs_btree_dup_cursor( | |
275 | xfs_btree_cur_t *cur, /* input cursor */ | |
276 | xfs_btree_cur_t **ncur);/* output cursor */ | |
277 | ||
278 | /* | |
279 | * Change the cursor to point to the first record in the current block | |
280 | * at the given level. Other levels are unaffected. | |
281 | */ | |
282 | int /* success=1, failure=0 */ | |
283 | xfs_btree_firstrec( | |
284 | xfs_btree_cur_t *cur, /* btree cursor */ | |
285 | int level); /* level to change */ | |
286 | ||
1da177e4 LT |
287 | /* |
288 | * Get a buffer for the block, return it with no data read. | |
289 | * Long-form addressing. | |
290 | */ | |
291 | struct xfs_buf * /* buffer for fsbno */ | |
292 | xfs_btree_get_bufl( | |
293 | struct xfs_mount *mp, /* file system mount point */ | |
294 | struct xfs_trans *tp, /* transaction pointer */ | |
295 | xfs_fsblock_t fsbno, /* file system block number */ | |
296 | uint lock); /* lock flags for get_buf */ | |
297 | ||
298 | /* | |
299 | * Get a buffer for the block, return it with no data read. | |
300 | * Short-form addressing. | |
301 | */ | |
302 | struct xfs_buf * /* buffer for agno/agbno */ | |
303 | xfs_btree_get_bufs( | |
304 | struct xfs_mount *mp, /* file system mount point */ | |
305 | struct xfs_trans *tp, /* transaction pointer */ | |
306 | xfs_agnumber_t agno, /* allocation group number */ | |
307 | xfs_agblock_t agbno, /* allocation group block number */ | |
308 | uint lock); /* lock flags for get_buf */ | |
309 | ||
310 | /* | |
311 | * Allocate a new btree cursor. | |
312 | * The cursor is either for allocation (A) or bmap (B). | |
313 | */ | |
314 | xfs_btree_cur_t * /* new btree cursor */ | |
315 | xfs_btree_init_cursor( | |
316 | struct xfs_mount *mp, /* file system mount point */ | |
317 | struct xfs_trans *tp, /* transaction pointer */ | |
318 | struct xfs_buf *agbp, /* (A only) buffer for agf structure */ | |
319 | xfs_agnumber_t agno, /* (A only) allocation group number */ | |
320 | xfs_btnum_t btnum, /* btree identifier */ | |
321 | struct xfs_inode *ip, /* (B only) inode owning the btree */ | |
322 | int whichfork); /* (B only) data/attr fork */ | |
323 | ||
324 | /* | |
325 | * Check for the cursor referring to the last block at the given level. | |
326 | */ | |
327 | int /* 1=is last block, 0=not last block */ | |
328 | xfs_btree_islastblock( | |
329 | xfs_btree_cur_t *cur, /* btree cursor */ | |
330 | int level); /* level to check */ | |
331 | ||
332 | /* | |
333 | * Change the cursor to point to the last record in the current block | |
334 | * at the given level. Other levels are unaffected. | |
335 | */ | |
336 | int /* success=1, failure=0 */ | |
337 | xfs_btree_lastrec( | |
338 | xfs_btree_cur_t *cur, /* btree cursor */ | |
339 | int level); /* level to change */ | |
340 | ||
341 | /* | |
342 | * Compute first and last byte offsets for the fields given. | |
343 | * Interprets the offsets table, which contains struct field offsets. | |
344 | */ | |
345 | void | |
346 | xfs_btree_offsets( | |
347 | __int64_t fields, /* bitmask of fields */ | |
348 | const short *offsets,/* table of field offsets */ | |
349 | int nbits, /* number of bits to inspect */ | |
350 | int *first, /* output: first byte offset */ | |
351 | int *last); /* output: last byte offset */ | |
352 | ||
353 | /* | |
354 | * Get a buffer for the block, return it read in. | |
355 | * Long-form addressing. | |
356 | */ | |
357 | int /* error */ | |
358 | xfs_btree_read_bufl( | |
359 | struct xfs_mount *mp, /* file system mount point */ | |
360 | struct xfs_trans *tp, /* transaction pointer */ | |
361 | xfs_fsblock_t fsbno, /* file system block number */ | |
362 | uint lock, /* lock flags for read_buf */ | |
363 | struct xfs_buf **bpp, /* buffer for fsbno */ | |
364 | int refval);/* ref count value for buffer */ | |
365 | ||
366 | /* | |
367 | * Get a buffer for the block, return it read in. | |
368 | * Short-form addressing. | |
369 | */ | |
370 | int /* error */ | |
371 | xfs_btree_read_bufs( | |
372 | struct xfs_mount *mp, /* file system mount point */ | |
373 | struct xfs_trans *tp, /* transaction pointer */ | |
374 | xfs_agnumber_t agno, /* allocation group number */ | |
375 | xfs_agblock_t agbno, /* allocation group block number */ | |
376 | uint lock, /* lock flags for read_buf */ | |
377 | struct xfs_buf **bpp, /* buffer for agno/agbno */ | |
378 | int refval);/* ref count value for buffer */ | |
379 | ||
380 | /* | |
381 | * Read-ahead the block, don't wait for it, don't return a buffer. | |
382 | * Long-form addressing. | |
383 | */ | |
384 | void /* error */ | |
385 | xfs_btree_reada_bufl( | |
386 | struct xfs_mount *mp, /* file system mount point */ | |
387 | xfs_fsblock_t fsbno, /* file system block number */ | |
388 | xfs_extlen_t count); /* count of filesystem blocks */ | |
389 | ||
390 | /* | |
391 | * Read-ahead the block, don't wait for it, don't return a buffer. | |
392 | * Short-form addressing. | |
393 | */ | |
394 | void /* error */ | |
395 | xfs_btree_reada_bufs( | |
396 | struct xfs_mount *mp, /* file system mount point */ | |
397 | xfs_agnumber_t agno, /* allocation group number */ | |
398 | xfs_agblock_t agbno, /* allocation group block number */ | |
399 | xfs_extlen_t count); /* count of filesystem blocks */ | |
400 | ||
401 | /* | |
402 | * Read-ahead btree blocks, at the given level. | |
403 | * Bits in lr are set from XFS_BTCUR_{LEFT,RIGHT}RA. | |
404 | */ | |
405 | int /* readahead block count */ | |
406 | xfs_btree_readahead_core( | |
407 | xfs_btree_cur_t *cur, /* btree cursor */ | |
408 | int lev, /* level in btree */ | |
409 | int lr); /* left/right bits */ | |
410 | ||
411 | static inline int /* readahead block count */ | |
412 | xfs_btree_readahead( | |
413 | xfs_btree_cur_t *cur, /* btree cursor */ | |
414 | int lev, /* level in btree */ | |
415 | int lr) /* left/right bits */ | |
416 | { | |
417 | if ((cur->bc_ra[lev] | lr) == cur->bc_ra[lev]) | |
418 | return 0; | |
419 | ||
420 | return xfs_btree_readahead_core(cur, lev, lr); | |
421 | } | |
422 | ||
423 | ||
424 | /* | |
425 | * Set the buffer for level "lev" in the cursor to bp, releasing | |
426 | * any previous buffer. | |
427 | */ | |
428 | void | |
429 | xfs_btree_setbuf( | |
430 | xfs_btree_cur_t *cur, /* btree cursor */ | |
431 | int lev, /* level in btree */ | |
432 | struct xfs_buf *bp); /* new buffer to set */ | |
433 | ||
434 | #endif /* __KERNEL__ */ | |
435 | ||
436 | ||
437 | /* | |
438 | * Min and max functions for extlen, agblock, fileoff, and filblks types. | |
439 | */ | |
54aa8e26 DC |
440 | #define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b)) |
441 | #define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b)) | |
442 | #define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b)) | |
443 | #define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b)) | |
444 | #define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b)) | |
445 | #define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b)) | |
446 | #define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b)) | |
447 | #define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b)) | |
a844f451 | 448 | |
1da177e4 LT |
449 | #define XFS_FSB_SANITY_CHECK(mp,fsb) \ |
450 | (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \ | |
a844f451 | 451 | XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks) |
1da177e4 LT |
452 | |
453 | #endif /* __XFS_BTREE_H__ */ |