fs: Convert namespace IDAs to new API
[linux-2.6-microblaze.git] / fs / xfs / libxfs / xfs_btree.h
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
4  * All Rights Reserved.
5  */
6 #ifndef __XFS_BTREE_H__
7 #define __XFS_BTREE_H__
8
9 struct xfs_buf;
10 struct xfs_defer_ops;
11 struct xfs_inode;
12 struct xfs_mount;
13 struct xfs_trans;
14
15 extern kmem_zone_t      *xfs_btree_cur_zone;
16
17 /*
18  * Generic key, ptr and record wrapper structures.
19  *
20  * These are disk format structures, and are converted where necessary
21  * by the btree specific code that needs to interpret them.
22  */
23 union xfs_btree_ptr {
24         __be32                  s;      /* short form ptr */
25         __be64                  l;      /* long form ptr */
26 };
27
28 /*
29  * The in-core btree key.  Overlapping btrees actually store two keys
30  * per pointer, so we reserve enough memory to hold both.  The __*bigkey
31  * items should never be accessed directly.
32  */
33 union xfs_btree_key {
34         struct xfs_bmbt_key             bmbt;
35         xfs_bmdr_key_t                  bmbr;   /* bmbt root block */
36         xfs_alloc_key_t                 alloc;
37         struct xfs_inobt_key            inobt;
38         struct xfs_rmap_key             rmap;
39         struct xfs_rmap_key             __rmap_bigkey[2];
40         struct xfs_refcount_key         refc;
41 };
42
43 union xfs_btree_rec {
44         struct xfs_bmbt_rec             bmbt;
45         xfs_bmdr_rec_t                  bmbr;   /* bmbt root block */
46         struct xfs_alloc_rec            alloc;
47         struct xfs_inobt_rec            inobt;
48         struct xfs_rmap_rec             rmap;
49         struct xfs_refcount_rec         refc;
50 };
51
52 /*
53  * This nonsense is to make -wlint happy.
54  */
55 #define XFS_LOOKUP_EQ   ((xfs_lookup_t)XFS_LOOKUP_EQi)
56 #define XFS_LOOKUP_LE   ((xfs_lookup_t)XFS_LOOKUP_LEi)
57 #define XFS_LOOKUP_GE   ((xfs_lookup_t)XFS_LOOKUP_GEi)
58
59 #define XFS_BTNUM_BNO   ((xfs_btnum_t)XFS_BTNUM_BNOi)
60 #define XFS_BTNUM_CNT   ((xfs_btnum_t)XFS_BTNUM_CNTi)
61 #define XFS_BTNUM_BMAP  ((xfs_btnum_t)XFS_BTNUM_BMAPi)
62 #define XFS_BTNUM_INO   ((xfs_btnum_t)XFS_BTNUM_INOi)
63 #define XFS_BTNUM_FINO  ((xfs_btnum_t)XFS_BTNUM_FINOi)
64 #define XFS_BTNUM_RMAP  ((xfs_btnum_t)XFS_BTNUM_RMAPi)
65 #define XFS_BTNUM_REFC  ((xfs_btnum_t)XFS_BTNUM_REFCi)
66
67 uint32_t xfs_btree_magic(int crc, xfs_btnum_t btnum);
68
69 /*
70  * For logging record fields.
71  */
72 #define XFS_BB_MAGIC            (1 << 0)
73 #define XFS_BB_LEVEL            (1 << 1)
74 #define XFS_BB_NUMRECS          (1 << 2)
75 #define XFS_BB_LEFTSIB          (1 << 3)
76 #define XFS_BB_RIGHTSIB         (1 << 4)
77 #define XFS_BB_BLKNO            (1 << 5)
78 #define XFS_BB_LSN              (1 << 6)
79 #define XFS_BB_UUID             (1 << 7)
80 #define XFS_BB_OWNER            (1 << 8)
81 #define XFS_BB_NUM_BITS         5
82 #define XFS_BB_ALL_BITS         ((1 << XFS_BB_NUM_BITS) - 1)
83 #define XFS_BB_NUM_BITS_CRC     9
84 #define XFS_BB_ALL_BITS_CRC     ((1 << XFS_BB_NUM_BITS_CRC) - 1)
85
86 /*
87  * Generic stats interface
88  */
89 #define XFS_BTREE_STATS_INC(cur, stat)  \
90         XFS_STATS_INC_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat)
91 #define XFS_BTREE_STATS_ADD(cur, stat, val)     \
92         XFS_STATS_ADD_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat, val)
93
94 #define XFS_BTREE_MAXLEVELS     9       /* max of all btrees */
95
96 struct xfs_btree_ops {
97         /* size of the key and record structures */
98         size_t  key_len;
99         size_t  rec_len;
100
101         /* cursor operations */
102         struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
103         void    (*update_cursor)(struct xfs_btree_cur *src,
104                                  struct xfs_btree_cur *dst);
105
106         /* update btree root pointer */
107         void    (*set_root)(struct xfs_btree_cur *cur,
108                             union xfs_btree_ptr *nptr, int level_change);
109
110         /* block allocation / freeing */
111         int     (*alloc_block)(struct xfs_btree_cur *cur,
112                                union xfs_btree_ptr *start_bno,
113                                union xfs_btree_ptr *new_bno,
114                                int *stat);
115         int     (*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp);
116
117         /* update last record information */
118         void    (*update_lastrec)(struct xfs_btree_cur *cur,
119                                   struct xfs_btree_block *block,
120                                   union xfs_btree_rec *rec,
121                                   int ptr, int reason);
122
123         /* records in block/level */
124         int     (*get_minrecs)(struct xfs_btree_cur *cur, int level);
125         int     (*get_maxrecs)(struct xfs_btree_cur *cur, int level);
126
127         /* records on disk.  Matter for the root in inode case. */
128         int     (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level);
129
130         /* init values of btree structures */
131         void    (*init_key_from_rec)(union xfs_btree_key *key,
132                                      union xfs_btree_rec *rec);
133         void    (*init_rec_from_cur)(struct xfs_btree_cur *cur,
134                                      union xfs_btree_rec *rec);
135         void    (*init_ptr_from_cur)(struct xfs_btree_cur *cur,
136                                      union xfs_btree_ptr *ptr);
137         void    (*init_high_key_from_rec)(union xfs_btree_key *key,
138                                           union xfs_btree_rec *rec);
139
140         /* difference between key value and cursor value */
141         int64_t (*key_diff)(struct xfs_btree_cur *cur,
142                               union xfs_btree_key *key);
143
144         /*
145          * Difference between key2 and key1 -- positive if key1 > key2,
146          * negative if key1 < key2, and zero if equal.
147          */
148         int64_t (*diff_two_keys)(struct xfs_btree_cur *cur,
149                                    union xfs_btree_key *key1,
150                                    union xfs_btree_key *key2);
151
152         const struct xfs_buf_ops        *buf_ops;
153
154         /* check that k1 is lower than k2 */
155         int     (*keys_inorder)(struct xfs_btree_cur *cur,
156                                 union xfs_btree_key *k1,
157                                 union xfs_btree_key *k2);
158
159         /* check that r1 is lower than r2 */
160         int     (*recs_inorder)(struct xfs_btree_cur *cur,
161                                 union xfs_btree_rec *r1,
162                                 union xfs_btree_rec *r2);
163 };
164
165 /*
166  * Reasons for the update_lastrec method to be called.
167  */
168 #define LASTREC_UPDATE  0
169 #define LASTREC_INSREC  1
170 #define LASTREC_DELREC  2
171
172
173 union xfs_btree_irec {
174         struct xfs_alloc_rec_incore     a;
175         struct xfs_bmbt_irec            b;
176         struct xfs_inobt_rec_incore     i;
177         struct xfs_rmap_irec            r;
178         struct xfs_refcount_irec        rc;
179 };
180
181 /* Per-AG btree private information. */
182 union xfs_btree_cur_private {
183         struct {
184                 unsigned long   nr_ops;         /* # record updates */
185                 int             shape_changes;  /* # of extent splits */
186         } refc;
187 };
188
189 /*
190  * Btree cursor structure.
191  * This collects all information needed by the btree code in one place.
192  */
193 typedef struct xfs_btree_cur
194 {
195         struct xfs_trans        *bc_tp; /* transaction we're in, if any */
196         struct xfs_mount        *bc_mp; /* file system mount struct */
197         const struct xfs_btree_ops *bc_ops;
198         uint                    bc_flags; /* btree features - below */
199         union xfs_btree_irec    bc_rec; /* current insert/search record value */
200         struct xfs_buf  *bc_bufs[XFS_BTREE_MAXLEVELS];  /* buf ptr per level */
201         int             bc_ptrs[XFS_BTREE_MAXLEVELS];   /* key/record # */
202         uint8_t         bc_ra[XFS_BTREE_MAXLEVELS];     /* readahead bits */
203 #define XFS_BTCUR_LEFTRA        1       /* left sibling has been read-ahead */
204 #define XFS_BTCUR_RIGHTRA       2       /* right sibling has been read-ahead */
205         uint8_t         bc_nlevels;     /* number of levels in the tree */
206         uint8_t         bc_blocklog;    /* log2(blocksize) of btree blocks */
207         xfs_btnum_t     bc_btnum;       /* identifies which btree type */
208         int             bc_statoff;     /* offset of btre stats array */
209         union {
210                 struct {                        /* needed for BNO, CNT, INO */
211                         struct xfs_buf  *agbp;  /* agf/agi buffer pointer */
212                         struct xfs_defer_ops *dfops;    /* deferred updates */
213                         xfs_agnumber_t  agno;   /* ag number */
214                         union xfs_btree_cur_private     priv;
215                 } a;
216                 struct {                        /* needed for BMAP */
217                         struct xfs_inode *ip;   /* pointer to our inode */
218                         struct xfs_defer_ops *dfops;    /* deferred updates */
219                         xfs_fsblock_t   firstblock;     /* 1st blk allocated */
220                         int             allocated;      /* count of alloced */
221                         short           forksize;       /* fork's inode space */
222                         char            whichfork;      /* data or attr fork */
223                         char            flags;          /* flags */
224 #define XFS_BTCUR_BPRV_WASDEL           (1<<0)          /* was delayed */
225 #define XFS_BTCUR_BPRV_INVALID_OWNER    (1<<1)          /* for ext swap */
226                 } b;
227         }               bc_private;     /* per-btree type data */
228 } xfs_btree_cur_t;
229
230 /* cursor flags */
231 #define XFS_BTREE_LONG_PTRS             (1<<0)  /* pointers are 64bits long */
232 #define XFS_BTREE_ROOT_IN_INODE         (1<<1)  /* root may be variable size */
233 #define XFS_BTREE_LASTREC_UPDATE        (1<<2)  /* track last rec externally */
234 #define XFS_BTREE_CRC_BLOCKS            (1<<3)  /* uses extended btree blocks */
235 #define XFS_BTREE_OVERLAPPING           (1<<4)  /* overlapping intervals */
236
237
238 #define XFS_BTREE_NOERROR       0
239 #define XFS_BTREE_ERROR         1
240
241 /*
242  * Convert from buffer to btree block header.
243  */
244 #define XFS_BUF_TO_BLOCK(bp)    ((struct xfs_btree_block *)((bp)->b_addr))
245
246 /*
247  * Internal long and short btree block checks.  They return NULL if the
248  * block is ok or the address of the failed check otherwise.
249  */
250 xfs_failaddr_t __xfs_btree_check_lblock(struct xfs_btree_cur *cur,
251                 struct xfs_btree_block *block, int level, struct xfs_buf *bp);
252 xfs_failaddr_t __xfs_btree_check_sblock(struct xfs_btree_cur *cur,
253                 struct xfs_btree_block *block, int level, struct xfs_buf *bp);
254
255 /*
256  * Check that block header is ok.
257  */
258 int
259 xfs_btree_check_block(
260         struct xfs_btree_cur    *cur,   /* btree cursor */
261         struct xfs_btree_block  *block, /* generic btree block pointer */
262         int                     level,  /* level of the btree block */
263         struct xfs_buf          *bp);   /* buffer containing block, if any */
264
265 /*
266  * Check that (long) pointer is ok.
267  */
268 bool                                    /* error (0 or EFSCORRUPTED) */
269 xfs_btree_check_lptr(
270         struct xfs_btree_cur    *cur,   /* btree cursor */
271         xfs_fsblock_t           fsbno,  /* btree block disk address */
272         int                     level); /* btree block level */
273
274 /*
275  * Check that (short) pointer is ok.
276  */
277 bool                                    /* error (0 or EFSCORRUPTED) */
278 xfs_btree_check_sptr(
279         struct xfs_btree_cur    *cur,   /* btree cursor */
280         xfs_agblock_t           agbno,  /* btree block disk address */
281         int                     level); /* btree block level */
282
283 /*
284  * Delete the btree cursor.
285  */
286 void
287 xfs_btree_del_cursor(
288         xfs_btree_cur_t         *cur,   /* btree cursor */
289         int                     error); /* del because of error */
290
291 /*
292  * Duplicate the btree cursor.
293  * Allocate a new one, copy the record, re-get the buffers.
294  */
295 int                                     /* error */
296 xfs_btree_dup_cursor(
297         xfs_btree_cur_t         *cur,   /* input cursor */
298         xfs_btree_cur_t         **ncur);/* output cursor */
299
300 /*
301  * Get a buffer for the block, return it with no data read.
302  * Long-form addressing.
303  */
304 struct xfs_buf *                                /* buffer for fsbno */
305 xfs_btree_get_bufl(
306         struct xfs_mount        *mp,    /* file system mount point */
307         struct xfs_trans        *tp,    /* transaction pointer */
308         xfs_fsblock_t           fsbno,  /* file system block number */
309         uint                    lock);  /* lock flags for get_buf */
310
311 /*
312  * Get a buffer for the block, return it with no data read.
313  * Short-form addressing.
314  */
315 struct xfs_buf *                                /* buffer for agno/agbno */
316 xfs_btree_get_bufs(
317         struct xfs_mount        *mp,    /* file system mount point */
318         struct xfs_trans        *tp,    /* transaction pointer */
319         xfs_agnumber_t          agno,   /* allocation group number */
320         xfs_agblock_t           agbno,  /* allocation group block number */
321         uint                    lock);  /* lock flags for get_buf */
322
323 /*
324  * Check for the cursor referring to the last block at the given level.
325  */
326 int                                     /* 1=is last block, 0=not last block */
327 xfs_btree_islastblock(
328         xfs_btree_cur_t         *cur,   /* btree cursor */
329         int                     level); /* level to check */
330
331 /*
332  * Compute first and last byte offsets for the fields given.
333  * Interprets the offsets table, which contains struct field offsets.
334  */
335 void
336 xfs_btree_offsets(
337         int64_t                 fields, /* bitmask of fields */
338         const short             *offsets,/* table of field offsets */
339         int                     nbits,  /* number of bits to inspect */
340         int                     *first, /* output: first byte offset */
341         int                     *last); /* output: last byte offset */
342
343 /*
344  * Get a buffer for the block, return it read in.
345  * Long-form addressing.
346  */
347 int                                     /* error */
348 xfs_btree_read_bufl(
349         struct xfs_mount        *mp,    /* file system mount point */
350         struct xfs_trans        *tp,    /* transaction pointer */
351         xfs_fsblock_t           fsbno,  /* file system block number */
352         uint                    lock,   /* lock flags for read_buf */
353         struct xfs_buf          **bpp,  /* buffer for fsbno */
354         int                     refval, /* ref count value for buffer */
355         const struct xfs_buf_ops *ops);
356
357 /*
358  * Read-ahead the block, don't wait for it, don't return a buffer.
359  * Long-form addressing.
360  */
361 void                                    /* error */
362 xfs_btree_reada_bufl(
363         struct xfs_mount        *mp,    /* file system mount point */
364         xfs_fsblock_t           fsbno,  /* file system block number */
365         xfs_extlen_t            count,  /* count of filesystem blocks */
366         const struct xfs_buf_ops *ops);
367
368 /*
369  * Read-ahead the block, don't wait for it, don't return a buffer.
370  * Short-form addressing.
371  */
372 void                                    /* error */
373 xfs_btree_reada_bufs(
374         struct xfs_mount        *mp,    /* file system mount point */
375         xfs_agnumber_t          agno,   /* allocation group number */
376         xfs_agblock_t           agbno,  /* allocation group block number */
377         xfs_extlen_t            count,  /* count of filesystem blocks */
378         const struct xfs_buf_ops *ops);
379
380 /*
381  * Initialise a new btree block header
382  */
383 void
384 xfs_btree_init_block(
385         struct xfs_mount *mp,
386         struct xfs_buf  *bp,
387         xfs_btnum_t     btnum,
388         __u16           level,
389         __u16           numrecs,
390         __u64           owner,
391         unsigned int    flags);
392
393 void
394 xfs_btree_init_block_int(
395         struct xfs_mount        *mp,
396         struct xfs_btree_block  *buf,
397         xfs_daddr_t             blkno,
398         xfs_btnum_t             btnum,
399         __u16                   level,
400         __u16                   numrecs,
401         __u64                   owner,
402         unsigned int            flags);
403
404 /*
405  * Common btree core entry points.
406  */
407 int xfs_btree_increment(struct xfs_btree_cur *, int, int *);
408 int xfs_btree_decrement(struct xfs_btree_cur *, int, int *);
409 int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *);
410 int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *);
411 int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *);
412 int xfs_btree_insert(struct xfs_btree_cur *, int *);
413 int xfs_btree_delete(struct xfs_btree_cur *, int *);
414 int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *);
415 int xfs_btree_change_owner(struct xfs_btree_cur *cur, uint64_t new_owner,
416                            struct list_head *buffer_list);
417
418 /*
419  * btree block CRC helpers
420  */
421 void xfs_btree_lblock_calc_crc(struct xfs_buf *);
422 bool xfs_btree_lblock_verify_crc(struct xfs_buf *);
423 void xfs_btree_sblock_calc_crc(struct xfs_buf *);
424 bool xfs_btree_sblock_verify_crc(struct xfs_buf *);
425
426 /*
427  * Internal btree helpers also used by xfs_bmap.c.
428  */
429 void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int);
430 void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int);
431
432 /*
433  * Helpers.
434  */
435 static inline int xfs_btree_get_numrecs(struct xfs_btree_block *block)
436 {
437         return be16_to_cpu(block->bb_numrecs);
438 }
439
440 static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block,
441                 uint16_t numrecs)
442 {
443         block->bb_numrecs = cpu_to_be16(numrecs);
444 }
445
446 static inline int xfs_btree_get_level(struct xfs_btree_block *block)
447 {
448         return be16_to_cpu(block->bb_level);
449 }
450
451
452 /*
453  * Min and max functions for extlen, agblock, fileoff, and filblks types.
454  */
455 #define XFS_EXTLEN_MIN(a,b)     min_t(xfs_extlen_t, (a), (b))
456 #define XFS_EXTLEN_MAX(a,b)     max_t(xfs_extlen_t, (a), (b))
457 #define XFS_AGBLOCK_MIN(a,b)    min_t(xfs_agblock_t, (a), (b))
458 #define XFS_AGBLOCK_MAX(a,b)    max_t(xfs_agblock_t, (a), (b))
459 #define XFS_FILEOFF_MIN(a,b)    min_t(xfs_fileoff_t, (a), (b))
460 #define XFS_FILEOFF_MAX(a,b)    max_t(xfs_fileoff_t, (a), (b))
461 #define XFS_FILBLKS_MIN(a,b)    min_t(xfs_filblks_t, (a), (b))
462 #define XFS_FILBLKS_MAX(a,b)    max_t(xfs_filblks_t, (a), (b))
463
464 xfs_failaddr_t xfs_btree_sblock_v5hdr_verify(struct xfs_buf *bp);
465 xfs_failaddr_t xfs_btree_sblock_verify(struct xfs_buf *bp,
466                 unsigned int max_recs);
467 xfs_failaddr_t xfs_btree_lblock_v5hdr_verify(struct xfs_buf *bp,
468                 uint64_t owner);
469 xfs_failaddr_t xfs_btree_lblock_verify(struct xfs_buf *bp,
470                 unsigned int max_recs);
471
472 uint xfs_btree_compute_maxlevels(uint *limits, unsigned long len);
473 unsigned long long xfs_btree_calc_size(uint *limits, unsigned long long len);
474
475 /* return codes */
476 #define XFS_BTREE_QUERY_RANGE_CONTINUE  0       /* keep iterating */
477 #define XFS_BTREE_QUERY_RANGE_ABORT     1       /* stop iterating */
478 typedef int (*xfs_btree_query_range_fn)(struct xfs_btree_cur *cur,
479                 union xfs_btree_rec *rec, void *priv);
480
481 int xfs_btree_query_range(struct xfs_btree_cur *cur,
482                 union xfs_btree_irec *low_rec, union xfs_btree_irec *high_rec,
483                 xfs_btree_query_range_fn fn, void *priv);
484 int xfs_btree_query_all(struct xfs_btree_cur *cur, xfs_btree_query_range_fn fn,
485                 void *priv);
486
487 typedef int (*xfs_btree_visit_blocks_fn)(struct xfs_btree_cur *cur, int level,
488                 void *data);
489 int xfs_btree_visit_blocks(struct xfs_btree_cur *cur,
490                 xfs_btree_visit_blocks_fn fn, void *data);
491
492 int xfs_btree_count_blocks(struct xfs_btree_cur *cur, xfs_extlen_t *blocks);
493
494 union xfs_btree_rec *xfs_btree_rec_addr(struct xfs_btree_cur *cur, int n,
495                 struct xfs_btree_block *block);
496 union xfs_btree_key *xfs_btree_key_addr(struct xfs_btree_cur *cur, int n,
497                 struct xfs_btree_block *block);
498 union xfs_btree_key *xfs_btree_high_key_addr(struct xfs_btree_cur *cur, int n,
499                 struct xfs_btree_block *block);
500 union xfs_btree_ptr *xfs_btree_ptr_addr(struct xfs_btree_cur *cur, int n,
501                 struct xfs_btree_block *block);
502 int xfs_btree_lookup_get_block(struct xfs_btree_cur *cur, int level,
503                 union xfs_btree_ptr *pp, struct xfs_btree_block **blkp);
504 struct xfs_btree_block *xfs_btree_get_block(struct xfs_btree_cur *cur,
505                 int level, struct xfs_buf **bpp);
506 bool xfs_btree_ptr_is_null(struct xfs_btree_cur *cur, union xfs_btree_ptr *ptr);
507 int64_t xfs_btree_diff_two_ptrs(struct xfs_btree_cur *cur,
508                                 const union xfs_btree_ptr *a,
509                                 const union xfs_btree_ptr *b);
510 void xfs_btree_get_sibling(struct xfs_btree_cur *cur,
511                            struct xfs_btree_block *block,
512                            union xfs_btree_ptr *ptr, int lr);
513 void xfs_btree_get_keys(struct xfs_btree_cur *cur,
514                 struct xfs_btree_block *block, union xfs_btree_key *key);
515 union xfs_btree_key *xfs_btree_high_key_from_key(struct xfs_btree_cur *cur,
516                 union xfs_btree_key *key);
517 int xfs_btree_has_record(struct xfs_btree_cur *cur, union xfs_btree_irec *low,
518                 union xfs_btree_irec *high, bool *exists);
519 bool xfs_btree_has_more_records(struct xfs_btree_cur *cur);
520
521 #endif  /* __XFS_BTREE_H__ */