]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/btree_update.h
bab135fae0b0bbd9225c308eb5b9fda8868a70c4
[bcachefs-tools-debian] / libbcachefs / btree_update.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_BTREE_UPDATE_H
3 #define _BCACHEFS_BTREE_UPDATE_H
4
5 #include "btree_iter.h"
6 #include "journal.h"
7
8 struct bch_fs;
9 struct btree;
10
11 void bch2_btree_node_lock_for_insert(struct btree_trans *, struct btree_iter *,
12                                      struct btree *);
13 bool bch2_btree_bset_insert_key(struct btree_iter *, struct btree *,
14                                 struct btree_node_iter *, struct bkey_i *);
15 void bch2_btree_add_journal_pin(struct bch_fs *, struct btree *, u64);
16
17 enum btree_insert_flags {
18         __BTREE_INSERT_NOUNLOCK,
19         __BTREE_INSERT_NOFAIL,
20         __BTREE_INSERT_NOCHECK_RW,
21         __BTREE_INSERT_LAZY_RW,
22         __BTREE_INSERT_USE_RESERVE,
23         __BTREE_INSERT_JOURNAL_REPLAY,
24         __BTREE_INSERT_JOURNAL_RESERVED,
25         __BTREE_INSERT_JOURNAL_RECLAIM,
26         __BTREE_INSERT_NOWAIT,
27         __BTREE_INSERT_GC_LOCK_HELD,
28         __BCH_HASH_SET_MUST_CREATE,
29         __BCH_HASH_SET_MUST_REPLACE,
30 };
31
32 /*
33  * Don't drop locks _after_ successfully updating btree:
34  */
35 #define BTREE_INSERT_NOUNLOCK           (1 << __BTREE_INSERT_NOUNLOCK)
36
37 /* Don't check for -ENOSPC: */
38 #define BTREE_INSERT_NOFAIL             (1 << __BTREE_INSERT_NOFAIL)
39
40 #define BTREE_INSERT_NOCHECK_RW         (1 << __BTREE_INSERT_NOCHECK_RW)
41 #define BTREE_INSERT_LAZY_RW            (1 << __BTREE_INSERT_LAZY_RW)
42
43 /* for copygc, or when merging btree nodes */
44 #define BTREE_INSERT_USE_RESERVE        (1 << __BTREE_INSERT_USE_RESERVE)
45
46 /* Insert is for journal replay - don't get journal reservations: */
47 #define BTREE_INSERT_JOURNAL_REPLAY     (1 << __BTREE_INSERT_JOURNAL_REPLAY)
48
49 /* Indicates that we have pre-reserved space in the journal: */
50 #define BTREE_INSERT_JOURNAL_RESERVED   (1 << __BTREE_INSERT_JOURNAL_RESERVED)
51
52 /* Insert is being called from journal reclaim path: */
53 #define BTREE_INSERT_JOURNAL_RECLAIM (1 << __BTREE_INSERT_JOURNAL_RECLAIM)
54
55 /* Don't block on allocation failure (for new btree nodes: */
56 #define BTREE_INSERT_NOWAIT             (1 << __BTREE_INSERT_NOWAIT)
57 #define BTREE_INSERT_GC_LOCK_HELD       (1 << __BTREE_INSERT_GC_LOCK_HELD)
58
59 #define BCH_HASH_SET_MUST_CREATE        (1 << __BCH_HASH_SET_MUST_CREATE)
60 #define BCH_HASH_SET_MUST_REPLACE       (1 << __BCH_HASH_SET_MUST_REPLACE)
61
62 int bch2_btree_delete_at(struct btree_trans *, struct btree_iter *, unsigned);
63
64 int __bch2_btree_insert(struct btree_trans *, enum btree_id, struct bkey_i *);
65 int bch2_btree_insert(struct bch_fs *, enum btree_id, struct bkey_i *,
66                      struct disk_reservation *, u64 *, int flags);
67
68 int bch2_btree_delete_range_trans(struct btree_trans *, enum btree_id,
69                                   struct bpos, struct bpos, u64 *);
70 int bch2_btree_delete_range(struct bch_fs *, enum btree_id,
71                             struct bpos, struct bpos, u64 *);
72
73 int bch2_btree_node_rewrite(struct btree_trans *, struct btree_iter *,
74                             __le64, unsigned);
75 void bch2_btree_node_rewrite_async(struct bch_fs *, struct btree *);
76 int bch2_btree_node_update_key(struct btree_trans *, struct btree_iter *,
77                                struct btree *, struct bkey_i *, bool);
78 int bch2_btree_node_update_key_get_iter(struct btree_trans *,
79                                 struct btree *, struct bkey_i *, bool);
80
81 int bch2_trans_update(struct btree_trans *, struct btree_iter *,
82                       struct bkey_i *, enum btree_update_flags);
83 void bch2_trans_commit_hook(struct btree_trans *,
84                             struct btree_trans_commit_hook *);
85 int __bch2_trans_commit(struct btree_trans *);
86
87 /**
88  * bch2_trans_commit - insert keys at given iterator positions
89  *
90  * This is main entry point for btree updates.
91  *
92  * Return values:
93  * -EINTR: locking changed, this function should be called again.
94  * -EROFS: filesystem read only
95  * -EIO: journal or btree node IO error
96  */
97 static inline int bch2_trans_commit(struct btree_trans *trans,
98                                     struct disk_reservation *disk_res,
99                                     u64 *journal_seq,
100                                     unsigned flags)
101 {
102         trans->disk_res         = disk_res;
103         trans->journal_seq      = journal_seq;
104         trans->flags            = flags;
105
106         return __bch2_trans_commit(trans);
107 }
108
109 #define lockrestart_do(_trans, _do)                                     \
110 ({                                                                      \
111         int _ret;                                                       \
112                                                                         \
113         while (1) {                                                     \
114                 _ret = (_do);                                           \
115                 if (_ret != -EINTR)                                     \
116                         break;                                          \
117                 bch2_trans_reset(_trans, 0);                            \
118         }                                                               \
119                                                                         \
120         _ret;                                                           \
121 })
122
123 #define __bch2_trans_do(_trans, _disk_res, _journal_seq, _flags, _do)   \
124         lockrestart_do(_trans, _do ?: bch2_trans_commit(_trans, (_disk_res),\
125                                         (_journal_seq), (_flags)))
126
127 #define bch2_trans_do(_c, _disk_res, _journal_seq, _flags, _do)         \
128 ({                                                                      \
129         struct btree_trans trans;                                       \
130         int _ret, _ret2;                                                \
131                                                                         \
132         bch2_trans_init(&trans, (_c), 0, 0);                            \
133         _ret = __bch2_trans_do(&trans, _disk_res, _journal_seq, _flags, \
134                                _do);                                    \
135         _ret2 = bch2_trans_exit(&trans);                                \
136                                                                         \
137         _ret ?: _ret2;                                                  \
138 })
139
140 #define trans_for_each_update(_trans, _i)                               \
141         for ((_i) = (_trans)->updates;                                  \
142              (_i) < (_trans)->updates + (_trans)->nr_updates;           \
143              (_i)++)
144
145 #endif /* _BCACHEFS_BTREE_UPDATE_H */