1
2
3
4
5
6#ifndef __XFS_BTREE_H__
7#define __XFS_BTREE_H__
8
9struct xfs_buf;
10struct xfs_inode;
11struct xfs_mount;
12struct xfs_trans;
13struct xfs_ifork;
14struct xfs_perag;
15
16extern kmem_zone_t *xfs_btree_cur_zone;
17
18
19
20
21
22
23
24union xfs_btree_ptr {
25 __be32 s;
26 __be64 l;
27};
28
29
30
31
32
33
34union xfs_btree_key {
35 struct xfs_bmbt_key bmbt;
36 xfs_bmdr_key_t bmbr;
37 xfs_alloc_key_t alloc;
38 struct xfs_inobt_key inobt;
39 struct xfs_rmap_key rmap;
40 struct xfs_rmap_key __rmap_bigkey[2];
41 struct xfs_refcount_key refc;
42};
43
44union xfs_btree_rec {
45 struct xfs_bmbt_rec bmbt;
46 xfs_bmdr_rec_t bmbr;
47 struct xfs_alloc_rec alloc;
48 struct xfs_inobt_rec inobt;
49 struct xfs_rmap_rec rmap;
50 struct xfs_refcount_rec refc;
51};
52
53
54
55
56#define XFS_LOOKUP_EQ ((xfs_lookup_t)XFS_LOOKUP_EQi)
57#define XFS_LOOKUP_LE ((xfs_lookup_t)XFS_LOOKUP_LEi)
58#define XFS_LOOKUP_GE ((xfs_lookup_t)XFS_LOOKUP_GEi)
59
60#define XFS_BTNUM_BNO ((xfs_btnum_t)XFS_BTNUM_BNOi)
61#define XFS_BTNUM_CNT ((xfs_btnum_t)XFS_BTNUM_CNTi)
62#define XFS_BTNUM_BMAP ((xfs_btnum_t)XFS_BTNUM_BMAPi)
63#define XFS_BTNUM_INO ((xfs_btnum_t)XFS_BTNUM_INOi)
64#define XFS_BTNUM_FINO ((xfs_btnum_t)XFS_BTNUM_FINOi)
65#define XFS_BTNUM_RMAP ((xfs_btnum_t)XFS_BTNUM_RMAPi)
66#define XFS_BTNUM_REFC ((xfs_btnum_t)XFS_BTNUM_REFCi)
67
68uint32_t xfs_btree_magic(int crc, xfs_btnum_t btnum);
69
70
71
72
73#define XFS_BB_MAGIC (1 << 0)
74#define XFS_BB_LEVEL (1 << 1)
75#define XFS_BB_NUMRECS (1 << 2)
76#define XFS_BB_LEFTSIB (1 << 3)
77#define XFS_BB_RIGHTSIB (1 << 4)
78#define XFS_BB_BLKNO (1 << 5)
79#define XFS_BB_LSN (1 << 6)
80#define XFS_BB_UUID (1 << 7)
81#define XFS_BB_OWNER (1 << 8)
82#define XFS_BB_NUM_BITS 5
83#define XFS_BB_ALL_BITS ((1 << XFS_BB_NUM_BITS) - 1)
84#define XFS_BB_NUM_BITS_CRC 9
85#define XFS_BB_ALL_BITS_CRC ((1 << XFS_BB_NUM_BITS_CRC) - 1)
86
87
88
89
90#define XFS_BTREE_STATS_INC(cur, stat) \
91 XFS_STATS_INC_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat)
92#define XFS_BTREE_STATS_ADD(cur, stat, val) \
93 XFS_STATS_ADD_OFF((cur)->bc_mp, (cur)->bc_statoff + __XBTS_ ## stat, val)
94
95#define XFS_BTREE_MAXLEVELS 9
96
97struct xfs_btree_ops {
98
99 size_t key_len;
100 size_t rec_len;
101
102
103 struct xfs_btree_cur *(*dup_cursor)(struct xfs_btree_cur *);
104 void (*update_cursor)(struct xfs_btree_cur *src,
105 struct xfs_btree_cur *dst);
106
107
108 void (*set_root)(struct xfs_btree_cur *cur,
109 const union xfs_btree_ptr *nptr, int level_change);
110
111
112 int (*alloc_block)(struct xfs_btree_cur *cur,
113 const union xfs_btree_ptr *start_bno,
114 union xfs_btree_ptr *new_bno,
115 int *stat);
116 int (*free_block)(struct xfs_btree_cur *cur, struct xfs_buf *bp);
117
118
119 void (*update_lastrec)(struct xfs_btree_cur *cur,
120 const struct xfs_btree_block *block,
121 const union xfs_btree_rec *rec,
122 int ptr, int reason);
123
124
125 int (*get_minrecs)(struct xfs_btree_cur *cur, int level);
126 int (*get_maxrecs)(struct xfs_btree_cur *cur, int level);
127
128
129 int (*get_dmaxrecs)(struct xfs_btree_cur *cur, int level);
130
131
132 void (*init_key_from_rec)(union xfs_btree_key *key,
133 const union xfs_btree_rec *rec);
134 void (*init_rec_from_cur)(struct xfs_btree_cur *cur,
135 union xfs_btree_rec *rec);
136 void (*init_ptr_from_cur)(struct xfs_btree_cur *cur,
137 union xfs_btree_ptr *ptr);
138 void (*init_high_key_from_rec)(union xfs_btree_key *key,
139 const union xfs_btree_rec *rec);
140
141
142 int64_t (*key_diff)(struct xfs_btree_cur *cur,
143 const union xfs_btree_key *key);
144
145
146
147
148
149 int64_t (*diff_two_keys)(struct xfs_btree_cur *cur,
150 const union xfs_btree_key *key1,
151 const union xfs_btree_key *key2);
152
153 const struct xfs_buf_ops *buf_ops;
154
155
156 int (*keys_inorder)(struct xfs_btree_cur *cur,
157 const union xfs_btree_key *k1,
158 const union xfs_btree_key *k2);
159
160
161 int (*recs_inorder)(struct xfs_btree_cur *cur,
162 const union xfs_btree_rec *r1,
163 const union xfs_btree_rec *r2);
164};
165
166
167
168
169#define LASTREC_UPDATE 0
170#define LASTREC_INSREC 1
171#define LASTREC_DELREC 2
172
173
174union xfs_btree_irec {
175 struct xfs_alloc_rec_incore a;
176 struct xfs_bmbt_irec b;
177 struct xfs_inobt_rec_incore i;
178 struct xfs_rmap_irec r;
179 struct xfs_refcount_irec rc;
180};
181
182
183struct xfs_btree_cur_ag {
184 struct xfs_perag *pag;
185 union {
186 struct xfs_buf *agbp;
187 struct xbtree_afakeroot *afake;
188 };
189 union {
190 struct {
191 unsigned long nr_ops;
192 int shape_changes;
193 } refc;
194 struct {
195 bool active;
196 } abt;
197 };
198};
199
200
201struct xfs_btree_cur_ino {
202 struct xfs_inode *ip;
203 struct xbtree_ifakeroot *ifake;
204 int allocated;
205 short forksize;
206 char whichfork;
207 char flags;
208
209#define XFS_BTCUR_BMBT_WASDEL (1 << 0)
210
211
212#define XFS_BTCUR_BMBT_INVALID_OWNER (1 << 1)
213};
214
215
216
217
218
219typedef struct xfs_btree_cur
220{
221 struct xfs_trans *bc_tp;
222 struct xfs_mount *bc_mp;
223 const struct xfs_btree_ops *bc_ops;
224 uint bc_flags;
225 union xfs_btree_irec bc_rec;
226 struct xfs_buf *bc_bufs[XFS_BTREE_MAXLEVELS];
227 int bc_ptrs[XFS_BTREE_MAXLEVELS];
228 uint8_t bc_ra[XFS_BTREE_MAXLEVELS];
229#define XFS_BTCUR_LEFTRA 1
230#define XFS_BTCUR_RIGHTRA 2
231 uint8_t bc_nlevels;
232 uint8_t bc_blocklog;
233 xfs_btnum_t bc_btnum;
234 int bc_statoff;
235
236
237
238
239
240
241
242 union {
243 struct xfs_btree_cur_ag bc_ag;
244 struct xfs_btree_cur_ino bc_ino;
245 };
246} xfs_btree_cur_t;
247
248
249#define XFS_BTREE_LONG_PTRS (1<<0)
250#define XFS_BTREE_ROOT_IN_INODE (1<<1)
251#define XFS_BTREE_LASTREC_UPDATE (1<<2)
252#define XFS_BTREE_CRC_BLOCKS (1<<3)
253#define XFS_BTREE_OVERLAPPING (1<<4)
254
255
256
257
258
259#define XFS_BTREE_STAGING (1<<5)
260
261
262#define XFS_BTREE_NOERROR 0
263#define XFS_BTREE_ERROR 1
264
265
266
267
268#define XFS_BUF_TO_BLOCK(bp) ((struct xfs_btree_block *)((bp)->b_addr))
269
270
271
272
273
274xfs_failaddr_t __xfs_btree_check_lblock(struct xfs_btree_cur *cur,
275 struct xfs_btree_block *block, int level, struct xfs_buf *bp);
276xfs_failaddr_t __xfs_btree_check_sblock(struct xfs_btree_cur *cur,
277 struct xfs_btree_block *block, int level, struct xfs_buf *bp);
278
279
280
281
282int
283xfs_btree_check_block(
284 struct xfs_btree_cur *cur,
285 struct xfs_btree_block *block,
286 int level,
287 struct xfs_buf *bp);
288
289
290
291
292bool
293xfs_btree_check_lptr(
294 struct xfs_btree_cur *cur,
295 xfs_fsblock_t fsbno,
296 int level);
297
298
299
300
301bool
302xfs_btree_check_sptr(
303 struct xfs_btree_cur *cur,
304 xfs_agblock_t agbno,
305 int level);
306
307
308
309
310void
311xfs_btree_del_cursor(
312 xfs_btree_cur_t *cur,
313 int error);
314
315
316
317
318
319int
320xfs_btree_dup_cursor(
321 xfs_btree_cur_t *cur,
322 xfs_btree_cur_t **ncur);
323
324
325
326
327
328void
329xfs_btree_offsets(
330 int64_t fields,
331 const short *offsets,
332 int nbits,
333 int *first,
334 int *last);
335
336
337
338
339
340int
341xfs_btree_read_bufl(
342 struct xfs_mount *mp,
343 struct xfs_trans *tp,
344 xfs_fsblock_t fsbno,
345 struct xfs_buf **bpp,
346 int refval,
347 const struct xfs_buf_ops *ops);
348
349
350
351
352
353void
354xfs_btree_reada_bufl(
355 struct xfs_mount *mp,
356 xfs_fsblock_t fsbno,
357 xfs_extlen_t count,
358 const struct xfs_buf_ops *ops);
359
360
361
362
363
364void
365xfs_btree_reada_bufs(
366 struct xfs_mount *mp,
367 xfs_agnumber_t agno,
368 xfs_agblock_t agbno,
369 xfs_extlen_t count,
370 const struct xfs_buf_ops *ops);
371
372
373
374
375void
376xfs_btree_init_block(
377 struct xfs_mount *mp,
378 struct xfs_buf *bp,
379 xfs_btnum_t btnum,
380 __u16 level,
381 __u16 numrecs,
382 __u64 owner);
383
384void
385xfs_btree_init_block_int(
386 struct xfs_mount *mp,
387 struct xfs_btree_block *buf,
388 xfs_daddr_t blkno,
389 xfs_btnum_t btnum,
390 __u16 level,
391 __u16 numrecs,
392 __u64 owner,
393 unsigned int flags);
394
395
396
397
398int xfs_btree_increment(struct xfs_btree_cur *, int, int *);
399int xfs_btree_decrement(struct xfs_btree_cur *, int, int *);
400int xfs_btree_lookup(struct xfs_btree_cur *, xfs_lookup_t, int *);
401int xfs_btree_update(struct xfs_btree_cur *, union xfs_btree_rec *);
402int xfs_btree_new_iroot(struct xfs_btree_cur *, int *, int *);
403int xfs_btree_insert(struct xfs_btree_cur *, int *);
404int xfs_btree_delete(struct xfs_btree_cur *, int *);
405int xfs_btree_get_rec(struct xfs_btree_cur *, union xfs_btree_rec **, int *);
406int xfs_btree_change_owner(struct xfs_btree_cur *cur, uint64_t new_owner,
407 struct list_head *buffer_list);
408
409
410
411
412void xfs_btree_lblock_calc_crc(struct xfs_buf *);
413bool xfs_btree_lblock_verify_crc(struct xfs_buf *);
414void xfs_btree_sblock_calc_crc(struct xfs_buf *);
415bool xfs_btree_sblock_verify_crc(struct xfs_buf *);
416
417
418
419
420void xfs_btree_log_block(struct xfs_btree_cur *, struct xfs_buf *, int);
421void xfs_btree_log_recs(struct xfs_btree_cur *, struct xfs_buf *, int, int);
422
423
424
425
426static inline int xfs_btree_get_numrecs(const struct xfs_btree_block *block)
427{
428 return be16_to_cpu(block->bb_numrecs);
429}
430
431static inline void xfs_btree_set_numrecs(struct xfs_btree_block *block,
432 uint16_t numrecs)
433{
434 block->bb_numrecs = cpu_to_be16(numrecs);
435}
436
437static inline int xfs_btree_get_level(const struct xfs_btree_block *block)
438{
439 return be16_to_cpu(block->bb_level);
440}
441
442
443
444
445
446#define XFS_EXTLEN_MIN(a,b) min_t(xfs_extlen_t, (a), (b))
447#define XFS_EXTLEN_MAX(a,b) max_t(xfs_extlen_t, (a), (b))
448#define XFS_AGBLOCK_MIN(a,b) min_t(xfs_agblock_t, (a), (b))
449#define XFS_AGBLOCK_MAX(a,b) max_t(xfs_agblock_t, (a), (b))
450#define XFS_FILEOFF_MIN(a,b) min_t(xfs_fileoff_t, (a), (b))
451#define XFS_FILEOFF_MAX(a,b) max_t(xfs_fileoff_t, (a), (b))
452#define XFS_FILBLKS_MIN(a,b) min_t(xfs_filblks_t, (a), (b))
453#define XFS_FILBLKS_MAX(a,b) max_t(xfs_filblks_t, (a), (b))
454
455xfs_failaddr_t xfs_btree_sblock_v5hdr_verify(struct xfs_buf *bp);
456xfs_failaddr_t xfs_btree_sblock_verify(struct xfs_buf *bp,
457 unsigned int max_recs);
458xfs_failaddr_t xfs_btree_lblock_v5hdr_verify(struct xfs_buf *bp,
459 uint64_t owner);
460xfs_failaddr_t xfs_btree_lblock_verify(struct xfs_buf *bp,
461 unsigned int max_recs);
462
463uint xfs_btree_compute_maxlevels(uint *limits, unsigned long len);
464unsigned long long xfs_btree_calc_size(uint *limits, unsigned long long len);
465
466
467
468
469
470
471
472
473typedef int (*xfs_btree_query_range_fn)(struct xfs_btree_cur *cur,
474 const union xfs_btree_rec *rec, void *priv);
475
476int xfs_btree_query_range(struct xfs_btree_cur *cur,
477 const union xfs_btree_irec *low_rec,
478 const union xfs_btree_irec *high_rec,
479 xfs_btree_query_range_fn fn, void *priv);
480int xfs_btree_query_all(struct xfs_btree_cur *cur, xfs_btree_query_range_fn fn,
481 void *priv);
482
483typedef int (*xfs_btree_visit_blocks_fn)(struct xfs_btree_cur *cur, int level,
484 void *data);
485
486#define XFS_BTREE_VISIT_RECORDS (1 << 0)
487
488#define XFS_BTREE_VISIT_LEAVES (1 << 1)
489
490#define XFS_BTREE_VISIT_ALL (XFS_BTREE_VISIT_RECORDS | \
491 XFS_BTREE_VISIT_LEAVES)
492int xfs_btree_visit_blocks(struct xfs_btree_cur *cur,
493 xfs_btree_visit_blocks_fn fn, unsigned int flags, void *data);
494
495int xfs_btree_count_blocks(struct xfs_btree_cur *cur, xfs_extlen_t *blocks);
496
497union xfs_btree_rec *xfs_btree_rec_addr(struct xfs_btree_cur *cur, int n,
498 struct xfs_btree_block *block);
499union xfs_btree_key *xfs_btree_key_addr(struct xfs_btree_cur *cur, int n,
500 struct xfs_btree_block *block);
501union xfs_btree_key *xfs_btree_high_key_addr(struct xfs_btree_cur *cur, int n,
502 struct xfs_btree_block *block);
503union xfs_btree_ptr *xfs_btree_ptr_addr(struct xfs_btree_cur *cur, int n,
504 struct xfs_btree_block *block);
505int xfs_btree_lookup_get_block(struct xfs_btree_cur *cur, int level,
506 const union xfs_btree_ptr *pp, struct xfs_btree_block **blkp);
507struct xfs_btree_block *xfs_btree_get_block(struct xfs_btree_cur *cur,
508 int level, struct xfs_buf **bpp);
509bool xfs_btree_ptr_is_null(struct xfs_btree_cur *cur,
510 const union xfs_btree_ptr *ptr);
511int64_t xfs_btree_diff_two_ptrs(struct xfs_btree_cur *cur,
512 const union xfs_btree_ptr *a,
513 const union xfs_btree_ptr *b);
514void xfs_btree_get_sibling(struct xfs_btree_cur *cur,
515 struct xfs_btree_block *block,
516 union xfs_btree_ptr *ptr, int lr);
517void xfs_btree_get_keys(struct xfs_btree_cur *cur,
518 struct xfs_btree_block *block, union xfs_btree_key *key);
519union xfs_btree_key *xfs_btree_high_key_from_key(struct xfs_btree_cur *cur,
520 union xfs_btree_key *key);
521int xfs_btree_has_record(struct xfs_btree_cur *cur,
522 const union xfs_btree_irec *low,
523 const union xfs_btree_irec *high, bool *exists);
524bool xfs_btree_has_more_records(struct xfs_btree_cur *cur);
525struct xfs_ifork *xfs_btree_ifork_ptr(struct xfs_btree_cur *cur);
526
527
528static inline bool
529xfs_btree_islastblock(
530 xfs_btree_cur_t *cur,
531 int level)
532{
533 struct xfs_btree_block *block;
534 struct xfs_buf *bp;
535
536 block = xfs_btree_get_block(cur, level, &bp);
537 ASSERT(block && xfs_btree_check_block(cur, block, level, bp) == 0);
538
539 if (cur->bc_flags & XFS_BTREE_LONG_PTRS)
540 return block->bb_u.l.bb_rightsib == cpu_to_be64(NULLFSBLOCK);
541 return block->bb_u.s.bb_rightsib == cpu_to_be32(NULLAGBLOCK);
542}
543
544void xfs_btree_set_ptr_null(struct xfs_btree_cur *cur,
545 union xfs_btree_ptr *ptr);
546int xfs_btree_get_buf_block(struct xfs_btree_cur *cur,
547 const union xfs_btree_ptr *ptr, struct xfs_btree_block **block,
548 struct xfs_buf **bpp);
549void xfs_btree_set_sibling(struct xfs_btree_cur *cur,
550 struct xfs_btree_block *block, const union xfs_btree_ptr *ptr,
551 int lr);
552void xfs_btree_init_block_cur(struct xfs_btree_cur *cur,
553 struct xfs_buf *bp, int level, int numrecs);
554void xfs_btree_copy_ptrs(struct xfs_btree_cur *cur,
555 union xfs_btree_ptr *dst_ptr,
556 const union xfs_btree_ptr *src_ptr, int numptrs);
557void xfs_btree_copy_keys(struct xfs_btree_cur *cur,
558 union xfs_btree_key *dst_key,
559 const union xfs_btree_key *src_key, int numkeys);
560
561#endif
562