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_node_rewrite(struct btree_trans *, struct btree_iter *,
  76                             struct btree *, unsigned);
  77 void bch2_btree_node_rewrite_async(struct bch_fs *, struct btree *);
  78 int bch2_btree_node_update_key(struct btree_trans *, struct btree_iter *,
  79                                struct btree *, struct bkey_i *,
  80                                unsigned, bool);
  81 int bch2_btree_node_update_key_get_iter(struct btree_trans *, struct btree *,
  82                                         struct bkey_i *, unsigned, bool);
  83
  84 int __bch2_insert_snapshot_whiteouts(struct btree_trans *, enum btree_id,
  85                                      struct bpos, struct bpos);
  86
  87 /*
  88  * For use when splitting extents in existing snapshots:
  89  *
  90  * If @old_pos is an interior snapshot node, iterate over descendent snapshot
  91  * nodes: for every descendent snapshot in whiche @old_pos is overwritten and
  92  * not visible, emit a whiteout at @new_pos.
  93  */
  94 static inline int bch2_insert_snapshot_whiteouts(struct btree_trans *trans,
  95                                                  enum btree_id btree,
  96                                                  struct bpos old_pos,
  97                                                  struct bpos new_pos)
  98 {
  99         if (!btree_type_has_snapshots(btree) ||
 100             bkey_eq(old_pos, new_pos))
 101                 return 0;
 102
 103         return __bch2_insert_snapshot_whiteouts(trans, btree, old_pos, new_pos);
 104 }
 105
 106 int bch2_trans_update_extent(struct btree_trans *, struct btree_iter *,
 107                              struct bkey_i *, enum btree_update_flags);
 108
 109 int bch2_bkey_get_empty_slot(struct btree_trans *, struct btree_iter *,
 110                              enum btree_id, struct bpos);
 111
 112 int __must_check bch2_trans_update(struct btree_trans *, struct btree_iter *,
 113                                    struct bkey_i *, enum btree_update_flags);
 114 int __must_check bch2_trans_update_buffered(struct btree_trans *,
 115                                             enum btree_id, struct bkey_i *);
 116
 117 void bch2_trans_commit_hook(struct btree_trans *,
 118                             struct btree_trans_commit_hook *);
 119 int __bch2_trans_commit(struct btree_trans *, unsigned);
 120
 121 int bch2_fs_log_msg(struct bch_fs *, const char *, ...);
 122 int bch2_journal_log_msg(struct bch_fs *, const char *, ...);
 123
 124 /**
 125  * bch2_trans_commit - insert keys at given iterator positions
 126  *
 127  * This is main entry point for btree updates.
 128  *
 129  * Return values:
 130  * -EROFS: filesystem read only
 131  * -EIO: journal or btree node IO error
 132  */
 133 static inline int bch2_trans_commit(struct btree_trans *trans,
 134                                     struct disk_reservation *disk_res,
 135                                     u64 *journal_seq,
 136                                     unsigned flags)
 137 {
 138         trans->disk_res         = disk_res;
 139         trans->journal_seq      = journal_seq;
 140
 141         return __bch2_trans_commit(trans, flags);
 142 }
 143
 144 #define commit_do(_trans, _disk_res, _journal_seq, _flags, _do) \
 145         lockrestart_do(_trans, _do ?: bch2_trans_commit(_trans, (_disk_res),\
 146                                         (_journal_seq), (_flags)))
 147
 148 #define nested_commit_do(_trans, _disk_res, _journal_seq, _flags, _do)  \
 149         nested_lockrestart_do(_trans, _do ?: bch2_trans_commit(_trans, (_disk_res),\
 150                                         (_journal_seq), (_flags)))
 151
 152 #define bch2_trans_do(_c, _disk_res, _journal_seq, _flags, _do)         \
 153 ({                                                                      \
 154         struct btree_trans trans;                                       \
 155         int _ret;                                                       \
 156                                                                         \
 157         bch2_trans_init(&trans, (_c), 0, 0);                            \
 158         _ret = commit_do(&trans, _disk_res, _journal_seq, _flags, _do); \
 159         bch2_trans_exit(&trans);                                        \
 160                                                                         \
 161         _ret;                                                           \
 162 })
 163
 164 #define bch2_trans_run(_c, _do)                                         \
 165 ({                                                                      \
 166         struct btree_trans trans;                                       \
 167         int _ret;                                                       \
 168                                                                         \
 169         bch2_trans_init(&trans, (_c), 0, 0);                            \
 170         _ret = (_do);                                                   \
 171         bch2_trans_exit(&trans);                                        \
 172                                                                         \
 173         _ret;                                                           \
 174 })
 175
 176 #define trans_for_each_update(_trans, _i)                               \
 177         for ((_i) = (_trans)->updates;                                  \
 178              (_i) < (_trans)->updates + (_trans)->nr_updates;           \
 179              (_i)++)
 180
 181 #define trans_for_each_wb_update(_trans, _i)                            \
 182         for ((_i) = (_trans)->wb_updates;                               \
 183              (_i) < (_trans)->wb_updates + (_trans)->nr_wb_updates;     \
 184              (_i)++)
 185
 186 static inline void bch2_trans_reset_updates(struct btree_trans *trans)
 187 {
 188         struct btree_insert_entry *i;
 189
 190         trans_for_each_update(trans, i)
 191                 bch2_path_put(trans, i->path, true);
 192
 193         trans->extra_journal_res        = 0;
 194         trans->nr_updates               = 0;
 195         trans->nr_wb_updates            = 0;
 196         trans->wb_updates               = NULL;
 197         trans->hooks                    = NULL;
 198         trans->extra_journal_entries.nr = 0;
 199
 200         if (trans->fs_usage_deltas) {
 201                 trans->fs_usage_deltas->used = 0;
 202                 memset((void *) trans->fs_usage_deltas +
 203                        offsetof(struct replicas_delta_list, memset_start), 0,
 204                        (void *) &trans->fs_usage_deltas->memset_end -
 205                        (void *) &trans->fs_usage_deltas->memset_start);
 206         }
 207 }
 208
 209 static inline struct bkey_i *__bch2_bkey_make_mut_noupdate(struct btree_trans *trans, struct bkey_s_c k,
 210                                                   unsigned type, unsigned min_bytes)
 211 {
 212         unsigned bytes = max_t(unsigned, min_bytes, bkey_bytes(k.k));
 213         struct bkey_i *mut;
 214
 215         if (type && k.k->type != type)
 216                 return ERR_PTR(-ENOENT);
 217
 218         mut = bch2_trans_kmalloc_nomemzero(trans, bytes);
 219         if (!IS_ERR(mut)) {
 220                 bkey_reassemble(mut, k);
 221
 222                 if (unlikely(bytes > bkey_bytes(k.k))) {
 223                         memset((void *) mut + bkey_bytes(k.k), 0,
 224                                bytes - bkey_bytes(k.k));
 225                         mut->k.u64s = DIV_ROUND_UP(bytes, sizeof(u64));
 226                 }
 227         }
 228         return mut;
 229 }
 230
 231 static inline struct bkey_i *bch2_bkey_make_mut_noupdate(struct btree_trans *trans, struct bkey_s_c k)
 232 {
 233         return __bch2_bkey_make_mut_noupdate(trans, k, 0, 0);
 234 }
 235
 236 #define bch2_bkey_make_mut_noupdate_typed(_trans, _k, _type)            \
 237         bkey_i_to_##_type(__bch2_bkey_make_mut_noupdate(_trans, _k,     \
 238                                 KEY_TYPE_##_type, sizeof(struct bkey_i_##_type)))
 239
 240 static inline struct bkey_i *__bch2_bkey_make_mut(struct btree_trans *trans, struct btree_iter *iter,
 241                                         struct bkey_s_c *k, unsigned flags,
 242                                         unsigned type, unsigned min_bytes)
 243 {
 244         struct bkey_i *mut = __bch2_bkey_make_mut_noupdate(trans, *k, type, min_bytes);
 245         int ret;
 246
 247         if (IS_ERR(mut))
 248                 return mut;
 249
 250         ret = bch2_trans_update(trans, iter, mut, flags);
 251         if (ret)
 252                 return ERR_PTR(ret);
 253
 254         *k = bkey_i_to_s_c(mut);
 255         return mut;
 256 }
 257
 258 static inline struct bkey_i *bch2_bkey_make_mut(struct btree_trans *trans, struct btree_iter *iter,
 259                                                 struct bkey_s_c *k, unsigned flags)
 260 {
 261         return __bch2_bkey_make_mut(trans, iter, k, flags, 0, 0);
 262 }
 263
 264 #define bch2_bkey_make_mut_typed(_trans, _iter, _k, _flags, _type)      \
 265         bkey_i_to_##_type(__bch2_bkey_make_mut(_trans, _iter, _k, _flags,\
 266                                 KEY_TYPE_##_type, sizeof(struct bkey_i_##_type)))
 267
 268 static inline struct bkey_i *__bch2_bkey_get_mut_noupdate(struct btree_trans *trans,
 269                                          struct btree_iter *iter,
 270                                          unsigned btree_id, struct bpos pos,
 271                                          unsigned flags, unsigned type, unsigned min_bytes)
 272 {
 273         struct bkey_s_c k = __bch2_bkey_get_iter(trans, iter,
 274                                 btree_id, pos, flags|BTREE_ITER_INTENT, type);
 275         struct bkey_i *ret = unlikely(IS_ERR(k.k))
 276                 ? ERR_CAST(k.k)
 277                 : __bch2_bkey_make_mut_noupdate(trans, k, 0, min_bytes);
 278         if (unlikely(IS_ERR(ret)))
 279                 bch2_trans_iter_exit(trans, iter);
 280         return ret;
 281 }
 282
 283 static inline struct bkey_i *bch2_bkey_get_mut_noupdate(struct btree_trans *trans,
 284                                                struct btree_iter *iter,
 285                                                unsigned btree_id, struct bpos pos,
 286                                                unsigned flags)
 287 {
 288         return __bch2_bkey_get_mut_noupdate(trans, iter, btree_id, pos, flags, 0, 0);
 289 }
 290
 291 static inline struct bkey_i *__bch2_bkey_get_mut(struct btree_trans *trans,
 292                                          struct btree_iter *iter,
 293                                          unsigned btree_id, struct bpos pos,
 294                                          unsigned flags, unsigned type, unsigned min_bytes)
 295 {
 296         struct bkey_i *mut = __bch2_bkey_get_mut_noupdate(trans, iter,
 297                                 btree_id, pos, flags|BTREE_ITER_INTENT, type, min_bytes);
 298         int ret;
 299
 300         if (IS_ERR(mut))
 301                 return mut;
 302
 303         ret = bch2_trans_update(trans, iter, mut, flags);
 304         if (ret) {
 305                 bch2_trans_iter_exit(trans, iter);
 306                 return ERR_PTR(ret);
 307         }
 308
 309         return mut;
 310 }
 311
 312 static inline struct bkey_i *bch2_bkey_get_mut_minsize(struct btree_trans *trans,
 313                                                        struct btree_iter *iter,
 314                                                        unsigned btree_id, struct bpos pos,
 315                                                        unsigned flags, unsigned min_bytes)
 316 {
 317         return __bch2_bkey_get_mut(trans, iter, btree_id, pos, flags, 0, min_bytes);
 318 }
 319
 320 static inline struct bkey_i *bch2_bkey_get_mut(struct btree_trans *trans,
 321                                                struct btree_iter *iter,
 322                                                unsigned btree_id, struct bpos pos,
 323                                                unsigned flags)
 324 {
 325         return __bch2_bkey_get_mut(trans, iter, btree_id, pos, flags, 0, 0);
 326 }
 327
 328 #define bch2_bkey_get_mut_typed(_trans, _iter, _btree_id, _pos, _flags, _type)\
 329         bkey_i_to_##_type(__bch2_bkey_get_mut(_trans, _iter,            \
 330                         _btree_id, _pos, _flags,                        \
 331                         KEY_TYPE_##_type, sizeof(struct bkey_i_##_type)))
 332
 333 static inline struct bkey_i *__bch2_bkey_alloc(struct btree_trans *trans, struct btree_iter *iter,
 334                                                unsigned flags, unsigned type, unsigned val_size)
 335 {
 336         struct bkey_i *k = bch2_trans_kmalloc(trans, sizeof(*k) + val_size);
 337         int ret;
 338
 339         if (IS_ERR(k))
 340                 return k;
 341
 342         bkey_init(&k->k);
 343         k->k.p = iter->pos;
 344         k->k.type = type;
 345         set_bkey_val_bytes(&k->k, val_size);
 346
 347         ret = bch2_trans_update(trans, iter, k, flags);
 348         if (unlikely(ret))
 349                 return ERR_PTR(ret);
 350         return k;
 351 }
 352
 353 #define bch2_bkey_alloc(_trans, _iter, _flags, _type)                   \
 354         bkey_i_to_##_type(__bch2_bkey_alloc(_trans, _iter, _flags,      \
 355                                 KEY_TYPE_##_type, sizeof(struct bch_##_type)))
 356
 357 #endif /* _BCACHEFS_BTREE_UPDATE_H */