git.sesse.net Git - bcachefs-tools-debian/blob - 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_prep_for_write(struct btree_trans *,
  12                                     struct btree_path *, struct btree *);
  13 bool bch2_btree_bset_insert_key(struct btree_trans *, struct btree_path *,
  14                                 struct btree *, struct btree_node_iter *,
  15                                 struct bkey_i *);
  16
  17 int bch2_btree_node_flush0(struct journal *, struct journal_entry_pin *, u64);
  18 int bch2_btree_node_flush1(struct journal *, struct journal_entry_pin *, u64);
  19 void bch2_btree_add_journal_pin(struct bch_fs *, struct btree *, u64);
  20
  21 void bch2_btree_insert_key_leaf(struct btree_trans *, struct btree_path *,
  22                                 struct bkey_i *, u64);
  23
  24 enum btree_insert_flags {
  25         /* First two bits for journal watermark: */
  26         __BTREE_INSERT_NOFAIL = 2,
  27         __BTREE_INSERT_NOCHECK_RW,
  28         __BTREE_INSERT_LAZY_RW,
  29         __BTREE_INSERT_USE_RESERVE,
  30         __BTREE_INSERT_JOURNAL_REPLAY,
  31         __BTREE_INSERT_JOURNAL_RECLAIM,
  32         __BTREE_INSERT_NOWAIT,
  33         __BTREE_INSERT_GC_LOCK_HELD,
  34         __BCH_HASH_SET_MUST_CREATE,
  35         __BCH_HASH_SET_MUST_REPLACE,
  36 };
  37
  38 /* Don't check for -ENOSPC: */
  39 #define BTREE_INSERT_NOFAIL             (1 << __BTREE_INSERT_NOFAIL)
  40
  41 #define BTREE_INSERT_NOCHECK_RW         (1 << __BTREE_INSERT_NOCHECK_RW)
  42 #define BTREE_INSERT_LAZY_RW            (1 << __BTREE_INSERT_LAZY_RW)
  43
  44 /* for copygc, or when merging btree nodes */
  45 #define BTREE_INSERT_USE_RESERVE        (1 << __BTREE_INSERT_USE_RESERVE)
  46
  47 /* Insert is for journal replay - don't get journal reservations: */
  48 #define BTREE_INSERT_JOURNAL_REPLAY     (1 << __BTREE_INSERT_JOURNAL_REPLAY)
  49
  50 /* Insert is being called from journal reclaim path: */
  51 #define BTREE_INSERT_JOURNAL_RECLAIM (1 << __BTREE_INSERT_JOURNAL_RECLAIM)
  52
  53 /* Don't block on allocation failure (for new btree nodes: */
  54 #define BTREE_INSERT_NOWAIT             (1 << __BTREE_INSERT_NOWAIT)
  55 #define BTREE_INSERT_GC_LOCK_HELD       (1 << __BTREE_INSERT_GC_LOCK_HELD)
  56
  57 #define BCH_HASH_SET_MUST_CREATE        (1 << __BCH_HASH_SET_MUST_CREATE)
  58 #define BCH_HASH_SET_MUST_REPLACE       (1 << __BCH_HASH_SET_MUST_REPLACE)
  59
  60 int bch2_btree_delete_extent_at(struct btree_trans *, struct btree_iter *,
  61                                 unsigned, unsigned);
  62 int bch2_btree_delete_at(struct btree_trans *, struct btree_iter *, unsigned);
  63 int bch2_btree_delete_at_buffered(struct btree_trans *, enum btree_id, struct bpos);
  64
  65 int bch2_btree_insert_nonextent(struct btree_trans *, enum btree_id,
  66                                 struct bkey_i *, enum btree_update_flags);
  67
  68 int __bch2_btree_insert(struct btree_trans *, enum btree_id, struct bkey_i *,
  69                         enum btree_update_flags);
  70 int bch2_btree_insert(struct bch_fs *, enum btree_id, struct bkey_i *,
  71                      struct disk_reservation *, u64 *, int flags);
  72
  73 int bch2_btree_delete_range_trans(struct btree_trans *, enum btree_id,
  74                                   struct bpos, struct bpos, unsigned, u64 *);
  75 int bch2_btree_delete_range(struct bch_fs *, enum btree_id,
  76                             struct bpos, struct bpos, unsigned, u64 *);
  77
  78 int bch2_btree_node_rewrite(struct btree_trans *, struct btree_iter *,
  79                             struct btree *, unsigned);
  80 void bch2_btree_node_rewrite_async(struct bch_fs *, struct btree *);
  81 int bch2_btree_node_update_key(struct btree_trans *, struct btree_iter *,
  82                                struct btree *, struct bkey_i *, bool);
  83 int bch2_btree_node_update_key_get_iter(struct btree_trans *,
  84                                 struct btree *, struct bkey_i *, bool);
  85
  86 int bch2_trans_update_extent(struct btree_trans *, struct btree_iter *,
  87                              struct bkey_i *, enum btree_update_flags);
  88
  89 int bch2_bkey_get_empty_slot(struct btree_trans *, struct btree_iter *,
  90                              enum btree_id, struct bpos);
  91
  92 int __must_check bch2_trans_update(struct btree_trans *, struct btree_iter *,
  93                                    struct bkey_i *, enum btree_update_flags);
  94 int __must_check bch2_trans_update_buffered(struct btree_trans *,
  95                                             enum btree_id, struct bkey_i *);
  96
  97 void bch2_trans_commit_hook(struct btree_trans *,
  98                             struct btree_trans_commit_hook *);
  99 int __bch2_trans_commit(struct btree_trans *, unsigned);
 100
 101 int bch2_fs_log_msg(struct bch_fs *, const char *, ...);
 102 int bch2_journal_log_msg(struct bch_fs *, const char *, ...);
 103
 104 /**
 105  * bch2_trans_commit - insert keys at given iterator positions
 106  *
 107  * This is main entry point for btree updates.
 108  *
 109  * Return values:
 110  * -EROFS: filesystem read only
 111  * -EIO: journal or btree node IO error
 112  */
 113 static inline int bch2_trans_commit(struct btree_trans *trans,
 114                                     struct disk_reservation *disk_res,
 115                                     u64 *journal_seq,
 116                                     unsigned flags)
 117 {
 118         trans->disk_res         = disk_res;
 119         trans->journal_seq      = journal_seq;
 120
 121         return __bch2_trans_commit(trans, flags);
 122 }
 123
 124 #define commit_do(_trans, _disk_res, _journal_seq, _flags, _do) \
 125         lockrestart_do(_trans, _do ?: bch2_trans_commit(_trans, (_disk_res),\
 126                                         (_journal_seq), (_flags)))
 127
 128 #define nested_commit_do(_trans, _disk_res, _journal_seq, _flags, _do)  \
 129         nested_lockrestart_do(_trans, _do ?: bch2_trans_commit(_trans, (_disk_res),\
 130                                         (_journal_seq), (_flags)))
 131
 132 #define bch2_trans_do(_c, _disk_res, _journal_seq, _flags, _do)         \
 133 ({                                                                      \
 134         struct btree_trans trans;                                       \
 135         int _ret;                                                       \
 136                                                                         \
 137         bch2_trans_init(&trans, (_c), 0, 0);                            \
 138         _ret = commit_do(&trans, _disk_res, _journal_seq, _flags, _do); \
 139         bch2_trans_exit(&trans);                                        \
 140                                                                         \
 141         _ret;                                                           \
 142 })
 143
 144 #define bch2_trans_run(_c, _do)                                         \
 145 ({                                                                      \
 146         struct btree_trans trans;                                       \
 147         int _ret;                                                       \
 148                                                                         \
 149         bch2_trans_init(&trans, (_c), 0, 0);                            \
 150         _ret = (_do);                                                   \
 151         bch2_trans_exit(&trans);                                        \
 152                                                                         \
 153         _ret;                                                           \
 154 })
 155
 156 #define trans_for_each_update(_trans, _i)                               \
 157         for ((_i) = (_trans)->updates;                                  \
 158              (_i) < (_trans)->updates + (_trans)->nr_updates;           \
 159              (_i)++)
 160
 161 #define trans_for_each_wb_update(_trans, _i)                            \
 162         for ((_i) = (_trans)->wb_updates;                               \
 163              (_i) < (_trans)->wb_updates + (_trans)->nr_wb_updates;     \
 164              (_i)++)
 165
 166 static inline void bch2_trans_reset_updates(struct btree_trans *trans)
 167 {
 168         struct btree_insert_entry *i;
 169
 170         trans_for_each_update(trans, i)
 171                 bch2_path_put(trans, i->path, true);
 172
 173         trans->extra_journal_res        = 0;
 174         trans->nr_updates               = 0;
 175         trans->nr_wb_updates            = 0;
 176         trans->wb_updates               = NULL;
 177         trans->hooks                    = NULL;
 178         trans->extra_journal_entries.nr = 0;
 179
 180         if (trans->fs_usage_deltas) {
 181                 trans->fs_usage_deltas->used = 0;
 182                 memset((void *) trans->fs_usage_deltas +
 183                        offsetof(struct replicas_delta_list, memset_start), 0,
 184                        (void *) &trans->fs_usage_deltas->memset_end -
 185                        (void *) &trans->fs_usage_deltas->memset_start);
 186         }
 187 }
 188
 189 static inline struct bkey_i *__bch2_bkey_make_mut_noupdate(struct btree_trans *trans, struct bkey_s_c k,
 190                                                   unsigned type, unsigned min_bytes)
 191 {
 192         unsigned bytes = max_t(unsigned, min_bytes, bkey_bytes(k.k));
 193         struct bkey_i *mut;
 194
 195         if (type && k.k->type != type)
 196                 return ERR_PTR(-ENOENT);
 197
 198         mut = bch2_trans_kmalloc_nomemzero(trans, bytes);
 199         if (!IS_ERR(mut)) {
 200                 bkey_reassemble(mut, k);
 201
 202                 if (unlikely(bytes > bkey_bytes(k.k))) {
 203                         memset((void *) mut + bkey_bytes(k.k), 0,
 204                                bytes - bkey_bytes(k.k));
 205                         mut->k.u64s = DIV_ROUND_UP(bytes, sizeof(u64));
 206                 }
 207         }
 208         return mut;
 209 }
 210
 211 static inline struct bkey_i *bch2_bkey_make_mut_noupdate(struct btree_trans *trans, struct bkey_s_c k)
 212 {
 213         return __bch2_bkey_make_mut_noupdate(trans, k, 0, 0);
 214 }
 215
 216 #define bch2_bkey_make_mut_noupdate_typed(_trans, _k, _type)            \
 217         bkey_i_to_##_type(__bch2_bkey_make_mut_noupdate(_trans, _k,     \
 218                                 KEY_TYPE_##_type, sizeof(struct bkey_i_##_type)))
 219
 220 static inline struct bkey_i *__bch2_bkey_make_mut(struct btree_trans *trans, struct btree_iter *iter,
 221                                         struct bkey_s_c k, unsigned flags,
 222                                         unsigned type, unsigned min_bytes)
 223 {
 224         struct bkey_i *mut = __bch2_bkey_make_mut_noupdate(trans, k, type, min_bytes);
 225         int ret;
 226
 227         if (IS_ERR(mut))
 228                 return mut;
 229
 230         ret = bch2_trans_update(trans, iter, mut, flags);
 231         if (ret)
 232                 return ERR_PTR(ret);
 233         return mut;
 234 }
 235
 236 static inline struct bkey_i *bch2_bkey_make_mut(struct btree_trans *trans, struct btree_iter *iter,
 237                                                 struct bkey_s_c k, unsigned flags)
 238 {
 239         return __bch2_bkey_make_mut(trans, iter, k, flags, 0, 0);
 240 }
 241
 242 #define bch2_bkey_make_mut_typed(_trans, _iter, _k, _flags, _type)      \
 243         bkey_i_to_##_type(__bch2_bkey_make_mut(_trans, _iter, _k, _flags,\
 244                                 KEY_TYPE_##_type, sizeof(struct bkey_i_##_type)))
 245
 246 static inline struct bkey_i *__bch2_bkey_get_mut_noupdate(struct btree_trans *trans,
 247                                          struct btree_iter *iter,
 248                                          unsigned btree_id, struct bpos pos,
 249                                          unsigned flags, unsigned type, unsigned min_bytes)
 250 {
 251         struct bkey_s_c k = __bch2_bkey_get_iter(trans, iter,
 252                                 btree_id, pos, flags|BTREE_ITER_INTENT, type);
 253         struct bkey_i *ret = unlikely(IS_ERR(k.k))
 254                 ? ERR_CAST(k.k)
 255                 : __bch2_bkey_make_mut_noupdate(trans, k, 0, min_bytes);
 256         if (unlikely(IS_ERR(ret)))
 257                 bch2_trans_iter_exit(trans, iter);
 258         return ret;
 259 }
 260
 261 static inline struct bkey_i *bch2_bkey_get_mut_noupdate(struct btree_trans *trans,
 262                                                struct btree_iter *iter,
 263                                                unsigned btree_id, struct bpos pos,
 264                                                unsigned flags)
 265 {
 266         return __bch2_bkey_get_mut_noupdate(trans, iter, btree_id, pos, flags, 0, 0);
 267 }
 268
 269 static inline struct bkey_i *__bch2_bkey_get_mut(struct btree_trans *trans,
 270                                          struct btree_iter *iter,
 271                                          unsigned btree_id, struct bpos pos,
 272                                          unsigned flags, unsigned type, unsigned min_bytes)
 273 {
 274         struct bkey_i *mut = __bch2_bkey_get_mut_noupdate(trans, iter,
 275                                 btree_id, pos, flags|BTREE_ITER_INTENT, type, min_bytes);
 276         int ret;
 277
 278         if (IS_ERR(mut))
 279                 return mut;
 280
 281         ret = bch2_trans_update(trans, iter, mut, flags);
 282         if (ret) {
 283                 bch2_trans_iter_exit(trans, iter);
 284                 return ERR_PTR(ret);
 285         }
 286
 287         return mut;
 288 }
 289
 290 static inline struct bkey_i *bch2_bkey_get_mut_minsize(struct btree_trans *trans,
 291                                                        struct btree_iter *iter,
 292                                                        unsigned btree_id, struct bpos pos,
 293                                                        unsigned flags, unsigned min_bytes)
 294 {
 295         return __bch2_bkey_get_mut(trans, iter, btree_id, pos, flags, 0, min_bytes);
 296 }
 297
 298 static inline struct bkey_i *bch2_bkey_get_mut(struct btree_trans *trans,
 299                                                struct btree_iter *iter,
 300                                                unsigned btree_id, struct bpos pos,
 301                                                unsigned flags)
 302 {
 303         return __bch2_bkey_get_mut(trans, iter, btree_id, pos, flags, 0, 0);
 304 }
 305
 306 #define bch2_bkey_get_mut_typed(_trans, _iter, _btree_id, _pos, _flags, _type)\
 307         bkey_i_to_##_type(__bch2_bkey_get_mut(_trans, _iter,            \
 308                         _btree_id, _pos, _flags,                        \
 309                         KEY_TYPE_##_type, sizeof(struct bkey_i_##_type)))
 310
 311 static inline struct bkey_i *__bch2_bkey_alloc(struct btree_trans *trans, struct btree_iter *iter,
 312                                                unsigned flags, unsigned type, unsigned val_size)
 313 {
 314         struct bkey_i *k = bch2_trans_kmalloc(trans, sizeof(*k) + val_size);
 315         int ret;
 316
 317         if (IS_ERR(k))
 318                 return k;
 319
 320         bkey_init(&k->k);
 321         k->k.p = iter->pos;
 322         k->k.type = type;
 323         set_bkey_val_bytes(&k->k, val_size);
 324
 325         ret = bch2_trans_update(trans, iter, k, flags);
 326         if (unlikely(ret))
 327                 return ERR_PTR(ret);
 328         return k;
 329 }
 330
 331 #define bch2_bkey_alloc(_trans, _iter, _flags, _type)                   \
 332         bkey_i_to_##_type(__bch2_bkey_alloc(_trans, _iter, _flags,      \
 333                                 KEY_TYPE_##_type, sizeof(struct bch_##_type)))
 334
 335 #endif /* _BCACHEFS_BTREE_UPDATE_H */