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