[XFS] add keys_inorder and recs_inorder btree methods
[safe/jmp/linux-2.6] / fs / xfs / xfs_btree.h
1 /*
2  * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
3  * All Rights Reserved.
4  *
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
7  * published by the Free Software Foundation.
8  *
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.
13  *
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
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
27 extern kmem_zone_t      *xfs_btree_cur_zone;
28
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  */
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 */
50 } xfs_btree_sblock_t;
51
52 /*
53  * Long form header: bmap btrees.
54  */
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 */
61 } xfs_btree_lblock_t;
62
63 /*
64  * Combined header and structure, used by common code.
65  */
66 typedef struct xfs_btree_block {
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 */
70         union {
71                 struct {
72                         __be32          bb_leftsib;
73                         __be32          bb_rightsib;
74                 } s;                    /* short form pointers */
75                 struct  {
76                         __be64          bb_leftsib;
77                         __be64          bb_rightsib;
78                 } l;                    /* long form pointers */
79         } bb_u;                         /* rest */
80 } xfs_btree_block_t;
81
82 /*
83  * Generic key, ptr and record wrapper structures.
84  *
85  * These are disk format structures, and are converted where necessary
86  * by the btree specific code that needs to interpret them.
87  */
88 union xfs_btree_ptr {
89         __be32                  s;      /* short form ptr */
90         __be64                  l;      /* long form ptr */
91 };
92
93 union xfs_btree_key {
94         xfs_bmbt_key_t          bmbt;
95         xfs_bmdr_key_t          bmbr;   /* bmbt root block */
96         xfs_alloc_key_t         alloc;
97         xfs_inobt_key_t         inobt;
98 };
99
100 union xfs_btree_rec {
101         xfs_bmbt_rec_t          bmbt;
102         xfs_bmdr_rec_t          bmbr;   /* bmbt root block */
103         xfs_alloc_rec_t         alloc;
104         xfs_inobt_rec_t         inobt;
105 };
106
107 /*
108  * For logging record fields.
109  */
110 #define XFS_BB_MAGIC            0x01
111 #define XFS_BB_LEVEL            0x02
112 #define XFS_BB_NUMRECS          0x04
113 #define XFS_BB_LEFTSIB          0x08
114 #define XFS_BB_RIGHTSIB         0x10
115 #define XFS_BB_NUM_BITS         5
116 #define XFS_BB_ALL_BITS         ((1 << XFS_BB_NUM_BITS) - 1)
117
118 /*
119  * Magic numbers for btree blocks.
120  */
121 extern const __uint32_t xfs_magics[];
122
123 /*
124  * Generic stats interface
125  */
126 #define __XFS_BTREE_STATS_INC(type, stat) \
127         XFS_STATS_INC(xs_ ## type ## _2_ ## stat)
128 #define XFS_BTREE_STATS_INC(cur, stat)  \
129 do {    \
130         switch (cur->bc_btnum) {  \
131         case XFS_BTNUM_BNO: __XFS_BTREE_STATS_INC(abtb, stat); break;   \
132         case XFS_BTNUM_CNT: __XFS_BTREE_STATS_INC(abtc, stat); break;   \
133         case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_INC(bmbt, stat); break;  \
134         case XFS_BTNUM_INO: __XFS_BTREE_STATS_INC(ibt, stat); break;    \
135         case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break;       \
136         }       \
137 } while (0)
138
139 #define __XFS_BTREE_STATS_ADD(type, stat, val) \
140         XFS_STATS_ADD(xs_ ## type ## _2_ ## stat, val)
141 #define XFS_BTREE_STATS_ADD(cur, stat, val)  \
142 do {    \
143         switch (cur->bc_btnum) {  \
144         case XFS_BTNUM_BNO: __XFS_BTREE_STATS_ADD(abtb, stat, val); break; \
145         case XFS_BTNUM_CNT: __XFS_BTREE_STATS_ADD(abtc, stat, val); break; \
146         case XFS_BTNUM_BMAP: __XFS_BTREE_STATS_ADD(bmbt, stat, val); break; \
147         case XFS_BTNUM_INO: __XFS_BTREE_STATS_ADD(ibt, stat, val); break; \
148         case XFS_BTNUM_MAX: ASSERT(0); /* fucking gcc */ ; break;       \
149         }       \
150 } while (0)
151 /*
152  * Maximum and minimum records in a btree block.
153  * Given block size, type prefix, and leaf flag (0 or 1).
154  * The divisor below is equivalent to lf ? (e1) : (e2) but that produces
155  * compiler warnings.
156  */
157 #define XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf)       \
158         ((int)(((bsz) - (uint)sizeof(t ## _block_t)) / \
159          (((lf) * (uint)sizeof(t ## _rec_t)) + \
160           ((1 - (lf)) * \
161            ((uint)sizeof(t ## _key_t) + (uint)sizeof(t ## _ptr_t))))))
162 #define XFS_BTREE_BLOCK_MINRECS(bsz,t,lf)       \
163         (XFS_BTREE_BLOCK_MAXRECS(bsz,t,lf) / 2)
164
165 /*
166  * Record, key, and pointer address calculation macros.
167  * Given block size, type prefix, block pointer, and index of requested entry
168  * (first entry numbered 1).
169  */
170 #define XFS_BTREE_REC_ADDR(t,bb,i)      \
171         ((t ## _rec_t *)((char *)(bb) + sizeof(t ## _block_t) + \
172          ((i) - 1) * sizeof(t ## _rec_t)))
173 #define XFS_BTREE_KEY_ADDR(t,bb,i)      \
174         ((t ## _key_t *)((char *)(bb) + sizeof(t ## _block_t) + \
175          ((i) - 1) * sizeof(t ## _key_t)))
176 #define XFS_BTREE_PTR_ADDR(t,bb,i,mxr)  \
177         ((t ## _ptr_t *)((char *)(bb) + sizeof(t ## _block_t) + \
178          (mxr) * sizeof(t ## _key_t) + ((i) - 1) * sizeof(t ## _ptr_t)))
179
180 #define XFS_BTREE_MAXLEVELS     8       /* max of all btrees */
181
182 struct xfs_btree_ops {
183         /* size of the key and record structures */
184         size_t  key_len;
185         size_t  rec_len;
186
187         /* cursor operations */
188         struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
189         void    (*update_cursor)(struct xfs_btree_cur *src,
190                                  struct xfs_btree_cur *dst);
191
192         /* update btree root pointer */
193         void    (*set_root)(struct xfs_btree_cur *cur,
194                                 union xfs_btree_ptr *nptr, int level_change);
195         int     (*kill_root)(struct xfs_btree_cur *cur, struct xfs_buf *bp,
196                                 int level, union xfs_btree_ptr *newroot);
197
198         /* block allocation / freeing */
199         int     (*alloc_block)(struct xfs_btree_cur *cur,
200                                union xfs_btree_ptr *start_bno,
201                                union xfs_btree_ptr *new_bno,
202                                int length, int *stat);
203         int     (*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp);
204
205         /* update last record information */
206         void    (*update_lastrec)(struct xfs_btree_cur *cur,
207                                   struct xfs_btree_block *block,
208                                   union xfs_btree_rec *rec,
209                                   int ptr, int reason);
210
211         /* records in block/level */
212         int     (*get_minrecs)(struct xfs_btree_cur *cur, int level);
213         int     (*get_maxrecs)(struct xfs_btree_cur *cur, int level);
214
215         /* records on disk.  Matter for the root in inode case. */
216         int     (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level);
217
218         /* init values of btree structures */
219         void    (*init_key_from_rec)(union xfs_btree_key *key,
220                                      union xfs_btree_rec *rec);
221         void    (*init_rec_from_key)(union xfs_btree_key *key,
222                                      union xfs_btree_rec *rec);
223         void    (*init_rec_from_cur)(struct xfs_btree_cur *cur,
224                                      union xfs_btree_rec *rec);
225         void    (*init_ptr_from_cur)(struct xfs_btree_cur *cur,
226                                      union xfs_btree_ptr *ptr);
227
228         /* difference between key value and cursor value */
229         __int64_t (*key_diff)(struct xfs_btree_cur *cur,
230                               union xfs_btree_key *key);
231
232 #ifdef DEBUG
233         /* check that k1 is lower than k2 */
234         int     (*keys_inorder)(struct xfs_btree_cur *cur,
235                                 union xfs_btree_key *k1,
236                                 union xfs_btree_key *k2);
237
238         /* check that r1 is lower than r2 */
239         int     (*recs_inorder)(struct xfs_btree_cur *cur,
240                                 union xfs_btree_rec *r1,
241                                 union xfs_btree_rec *r2);
242 #endif
243
244         /* btree tracing */
245 #ifdef XFS_BTREE_TRACE
246         void            (*trace_enter)(struct xfs_btree_cur *, const char *,
247                                        char *, int, int, __psunsigned_t,
248                                        __psunsigned_t, __psunsigned_t,
249                                        __psunsigned_t, __psunsigned_t,
250                                        __psunsigned_t, __psunsigned_t,
251                                        __psunsigned_t, __psunsigned_t,
252                                        __psunsigned_t, __psunsigned_t);
253         void            (*trace_cursor)(struct xfs_btree_cur *, __uint32_t *,
254                                         __uint64_t *, __uint64_t *);
255         void            (*trace_key)(struct xfs_btree_cur *,
256                                      union xfs_btree_key *, __uint64_t *,
257                                      __uint64_t *);
258         void            (*trace_record)(struct xfs_btree_cur *,
259                                         union xfs_btree_rec *, __uint64_t *,
260                                         __uint64_t *, __uint64_t *);
261 #endif
262 };
263
264 /*
265  * Reasons for the update_lastrec method to be called.
266  */
267 #define LASTREC_UPDATE  0
268 #define LASTREC_INSREC  1
269 #define LASTREC_DELREC  2
270
271
272 /*
273  * Btree cursor structure.
274  * This collects all information needed by the btree code in one place.
275  */
276 typedef struct xfs_btree_cur
277 {
278         struct xfs_trans        *bc_tp; /* transaction we're in, if any */
279         struct xfs_mount        *bc_mp; /* file system mount struct */
280         const struct xfs_btree_ops *bc_ops;
281         uint                    bc_flags; /* btree features - below */
282         union {
283                 xfs_alloc_rec_incore_t  a;
284                 xfs_bmbt_irec_t         b;
285                 xfs_inobt_rec_incore_t  i;
286         }               bc_rec;         /* current insert/search record value */
287         struct xfs_buf  *bc_bufs[XFS_BTREE_MAXLEVELS];  /* buf ptr per level */
288         int             bc_ptrs[XFS_BTREE_MAXLEVELS];   /* key/record # */
289         __uint8_t       bc_ra[XFS_BTREE_MAXLEVELS];     /* readahead bits */
290 #define XFS_BTCUR_LEFTRA        1       /* left sibling has been read-ahead */
291 #define XFS_BTCUR_RIGHTRA       2       /* right sibling has been read-ahead */
292         __uint8_t       bc_nlevels;     /* number of levels in the tree */
293         __uint8_t       bc_blocklog;    /* log2(blocksize) of btree blocks */
294         xfs_btnum_t     bc_btnum;       /* identifies which btree type */
295         union {
296                 struct {                        /* needed for BNO, CNT, INO */
297                         struct xfs_buf  *agbp;  /* agf/agi buffer pointer */
298                         xfs_agnumber_t  agno;   /* ag number */
299                 } a;
300                 struct {                        /* needed for BMAP */
301                         struct xfs_inode *ip;   /* pointer to our inode */
302                         struct xfs_bmap_free *flist;    /* list to free after */
303                         xfs_fsblock_t   firstblock;     /* 1st blk allocated */
304                         int             allocated;      /* count of alloced */
305                         short           forksize;       /* fork's inode space */
306                         char            whichfork;      /* data or attr fork */
307                         char            flags;          /* flags */
308 #define XFS_BTCUR_BPRV_WASDEL   1                       /* was delayed */
309                 } b;
310         }               bc_private;     /* per-btree type data */
311 } xfs_btree_cur_t;
312
313 /* cursor flags */
314 #define XFS_BTREE_LONG_PTRS             (1<<0)  /* pointers are 64bits long */
315 #define XFS_BTREE_ROOT_IN_INODE         (1<<1)  /* root may be variable size */
316 #define XFS_BTREE_LASTREC_UPDATE        (1<<2)  /* track last rec externally */
317
318
319 #define XFS_BTREE_NOERROR       0
320 #define XFS_BTREE_ERROR         1
321
322 /*
323  * Convert from buffer to btree block header.
324  */
325 #define XFS_BUF_TO_BLOCK(bp)    ((xfs_btree_block_t *)XFS_BUF_PTR(bp))
326 #define XFS_BUF_TO_LBLOCK(bp)   ((xfs_btree_lblock_t *)XFS_BUF_PTR(bp))
327 #define XFS_BUF_TO_SBLOCK(bp)   ((xfs_btree_sblock_t *)XFS_BUF_PTR(bp))
328
329
330 #ifdef __KERNEL__
331
332 /*
333  * Check that long form block header is ok.
334  */
335 int                                     /* error (0 or EFSCORRUPTED) */
336 xfs_btree_check_lblock(
337         struct xfs_btree_cur    *cur,   /* btree cursor */
338         struct xfs_btree_lblock *block, /* btree long form block pointer */
339         int                     level,  /* level of the btree block */
340         struct xfs_buf          *bp);   /* buffer containing block, if any */
341
342 /*
343  * Check that short form block header is ok.
344  */
345 int                                     /* error (0 or EFSCORRUPTED) */
346 xfs_btree_check_sblock(
347         struct xfs_btree_cur    *cur,   /* btree cursor */
348         struct xfs_btree_sblock *block, /* btree short form block pointer */
349         int                     level,  /* level of the btree block */
350         struct xfs_buf          *bp);   /* buffer containing block */
351
352 /*
353  * Check that block header is ok.
354  */
355 int
356 xfs_btree_check_block(
357         struct xfs_btree_cur    *cur,   /* btree cursor */
358         struct xfs_btree_block  *block, /* generic btree block pointer */
359         int                     level,  /* level of the btree block */
360         struct xfs_buf          *bp);   /* buffer containing block, if any */
361
362 /*
363  * Check that (long) pointer is ok.
364  */
365 int                                     /* error (0 or EFSCORRUPTED) */
366 xfs_btree_check_lptr(
367         struct xfs_btree_cur    *cur,   /* btree cursor */
368         xfs_dfsbno_t            ptr,    /* btree block disk address */
369         int                     level); /* btree block level */
370
371 #define xfs_btree_check_lptr_disk(cur, ptr, level) \
372         xfs_btree_check_lptr(cur, be64_to_cpu(ptr), level)
373
374
375 /*
376  * Check that (short) pointer is ok.
377  */
378 int                                     /* error (0 or EFSCORRUPTED) */
379 xfs_btree_check_sptr(
380         struct xfs_btree_cur    *cur,   /* btree cursor */
381         xfs_agblock_t           ptr,    /* btree block disk address */
382         int                     level); /* btree block level */
383
384 /*
385  * Check that (short) pointer is ok.
386  */
387 int                                     /* error (0 or EFSCORRUPTED) */
388 xfs_btree_check_ptr(
389         struct xfs_btree_cur    *cur,   /* btree cursor */
390         union xfs_btree_ptr     *ptr,   /* btree block disk address */
391         int                     index,  /* offset from ptr to check */
392         int                     level); /* btree block level */
393
394 /*
395  * Delete the btree cursor.
396  */
397 void
398 xfs_btree_del_cursor(
399         xfs_btree_cur_t         *cur,   /* btree cursor */
400         int                     error); /* del because of error */
401
402 /*
403  * Duplicate the btree cursor.
404  * Allocate a new one, copy the record, re-get the buffers.
405  */
406 int                                     /* error */
407 xfs_btree_dup_cursor(
408         xfs_btree_cur_t         *cur,   /* input cursor */
409         xfs_btree_cur_t         **ncur);/* output cursor */
410
411 /*
412  * Change the cursor to point to the first record in the current block
413  * at the given level.  Other levels are unaffected.
414  */
415 int                                     /* success=1, failure=0 */
416 xfs_btree_firstrec(
417         xfs_btree_cur_t         *cur,   /* btree cursor */
418         int                     level); /* level to change */
419
420 /*
421  * Get a buffer for the block, return it with no data read.
422  * Long-form addressing.
423  */
424 struct xfs_buf *                                /* buffer for fsbno */
425 xfs_btree_get_bufl(
426         struct xfs_mount        *mp,    /* file system mount point */
427         struct xfs_trans        *tp,    /* transaction pointer */
428         xfs_fsblock_t           fsbno,  /* file system block number */
429         uint                    lock);  /* lock flags for get_buf */
430
431 /*
432  * Get a buffer for the block, return it with no data read.
433  * Short-form addressing.
434  */
435 struct xfs_buf *                                /* buffer for agno/agbno */
436 xfs_btree_get_bufs(
437         struct xfs_mount        *mp,    /* file system mount point */
438         struct xfs_trans        *tp,    /* transaction pointer */
439         xfs_agnumber_t          agno,   /* allocation group number */
440         xfs_agblock_t           agbno,  /* allocation group block number */
441         uint                    lock);  /* lock flags for get_buf */
442
443 /*
444  * Check for the cursor referring to the last block at the given level.
445  */
446 int                                     /* 1=is last block, 0=not last block */
447 xfs_btree_islastblock(
448         xfs_btree_cur_t         *cur,   /* btree cursor */
449         int                     level); /* level to check */
450
451 /*
452  * Change the cursor to point to the last record in the current block
453  * at the given level.  Other levels are unaffected.
454  */
455 int                                     /* success=1, failure=0 */
456 xfs_btree_lastrec(
457         xfs_btree_cur_t         *cur,   /* btree cursor */
458         int                     level); /* level to change */
459
460 /*
461  * Compute first and last byte offsets for the fields given.
462  * Interprets the offsets table, which contains struct field offsets.
463  */
464 void
465 xfs_btree_offsets(
466         __int64_t               fields, /* bitmask of fields */
467         const short             *offsets,/* table of field offsets */
468         int                     nbits,  /* number of bits to inspect */
469         int                     *first, /* output: first byte offset */
470         int                     *last); /* output: last byte offset */
471
472 /*
473  * Get a buffer for the block, return it read in.
474  * Long-form addressing.
475  */
476 int                                     /* error */
477 xfs_btree_read_bufl(
478         struct xfs_mount        *mp,    /* file system mount point */
479         struct xfs_trans        *tp,    /* transaction pointer */
480         xfs_fsblock_t           fsbno,  /* file system block number */
481         uint                    lock,   /* lock flags for read_buf */
482         struct xfs_buf          **bpp,  /* buffer for fsbno */
483         int                     refval);/* ref count value for buffer */
484
485 /*
486  * Get a buffer for the block, return it read in.
487  * Short-form addressing.
488  */
489 int                                     /* error */
490 xfs_btree_read_bufs(
491         struct xfs_mount        *mp,    /* file system mount point */
492         struct xfs_trans        *tp,    /* transaction pointer */
493         xfs_agnumber_t          agno,   /* allocation group number */
494         xfs_agblock_t           agbno,  /* allocation group block number */
495         uint                    lock,   /* lock flags for read_buf */
496         struct xfs_buf          **bpp,  /* buffer for agno/agbno */
497         int                     refval);/* ref count value for buffer */
498
499 /*
500  * Read-ahead the block, don't wait for it, don't return a buffer.
501  * Long-form addressing.
502  */
503 void                                    /* error */
504 xfs_btree_reada_bufl(
505         struct xfs_mount        *mp,    /* file system mount point */
506         xfs_fsblock_t           fsbno,  /* file system block number */
507         xfs_extlen_t            count); /* count of filesystem blocks */
508
509 /*
510  * Read-ahead the block, don't wait for it, don't return a buffer.
511  * Short-form addressing.
512  */
513 void                                    /* error */
514 xfs_btree_reada_bufs(
515         struct xfs_mount        *mp,    /* file system mount point */
516         xfs_agnumber_t          agno,   /* allocation group number */
517         xfs_agblock_t           agbno,  /* allocation group block number */
518         xfs_extlen_t            count); /* count of filesystem blocks */
519
520 /*
521  * Read-ahead btree blocks, at the given level.
522  * Bits in lr are set from XFS_BTCUR_{LEFT,RIGHT}RA.
523  */
524 int                                     /* readahead block count */
525 xfs_btree_readahead(
526         xfs_btree_cur_t         *cur,   /* btree cursor */
527         int                     lev,    /* level in btree */
528         int                     lr);    /* left/right bits */
529
530 /*
531  * Set the buffer for level "lev" in the cursor to bp, releasing
532  * any previous buffer.
533  */
534 void
535 xfs_btree_setbuf(
536         xfs_btree_cur_t         *cur,   /* btree cursor */
537         int                     lev,    /* level in btree */
538         struct xfs_buf          *bp);   /* new buffer to set */
539
540
541 /*
542  * Common btree core entry points.
543  */
544 int xfs_btree_increment(struct xfs_btree_cur *, int, int *);
545 int xfs_btree_decrement(struct xfs_btree_cur *, int, int *);
546 int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *);
547 int xfs_btree_updkey(struct xfs_btree_cur *, union xfs_btree_key *, int);
548 int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *);
549 int xfs_btree_lshift(struct xfs_btree_cur *, int, int *);
550 int xfs_btree_rshift(struct xfs_btree_cur *, int, int *);
551 int xfs_btree_split(struct xfs_btree_cur *, int, union xfs_btree_ptr *,
552                 union xfs_btree_key *, struct xfs_btree_cur **, int *);
553 int xfs_btree_new_root(struct xfs_btree_cur *, int *);
554 int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *);
555 int xfs_btree_kill_iroot(struct xfs_btree_cur *);
556 int xfs_btree_insert(struct xfs_btree_cur *, int *);
557 int xfs_btree_delete(struct xfs_btree_cur *, int *);
558 int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *);
559
560 /*
561  * Internal btree helpers also used by xfs_bmap.c.
562  */
563 void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int);
564 void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int);
565
566 /*
567  * Helpers.
568  */
569 static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block)
570 {
571         return be16_to_cpu(block->bb_numrecs);
572 }
573
574 static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block,
575                 __uint16_t numrecs)
576 {
577         block->bb_numrecs = cpu_to_be16(numrecs);
578 }
579
580 static inline int xfs_btree_get_level(struct xfs_btree_block *block)
581 {
582         return be16_to_cpu(block->bb_level);
583 }
584
585 #endif  /* __KERNEL__ */
586
587
588 /*
589  * Min and max functions for extlen, agblock, fileoff, and filblks types.
590  */
591 #define XFS_EXTLEN_MIN(a,b)     min_t(xfs_extlen_t, (a), (b))
592 #define XFS_EXTLEN_MAX(a,b)     max_t(xfs_extlen_t, (a), (b))
593 #define XFS_AGBLOCK_MIN(a,b)    min_t(xfs_agblock_t, (a), (b))
594 #define XFS_AGBLOCK_MAX(a,b)    max_t(xfs_agblock_t, (a), (b))
595 #define XFS_FILEOFF_MIN(a,b)    min_t(xfs_fileoff_t, (a), (b))
596 #define XFS_FILEOFF_MAX(a,b)    max_t(xfs_fileoff_t, (a), (b))
597 #define XFS_FILBLKS_MIN(a,b)    min_t(xfs_filblks_t, (a), (b))
598 #define XFS_FILBLKS_MAX(a,b)    max_t(xfs_filblks_t, (a), (b))
599
600 #define XFS_FSB_SANITY_CHECK(mp,fsb)    \
601         (XFS_FSB_TO_AGNO(mp, fsb) < mp->m_sb.sb_agcount && \
602                 XFS_FSB_TO_AGBNO(mp, fsb) < mp->m_sb.sb_agblocks)
603
604 #endif  /* __XFS_BTREE_H__ */