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 #define BCH_TRANS_COMMIT_FLAGS()                                                        \
  25         x(no_enospc,    "don't check for enospc")                                       \
  26         x(no_check_rw,  "don't attempt to take a ref on c->writes")                     \
  27         x(lazy_rw,      "go read-write if we haven't yet - only for use in recovery")   \
  28         x(no_journal_res, "don't take a journal reservation, instead "                  \
  29                         "pin journal entry referred to by trans->journal_res.seq")      \
  30         x(journal_reclaim, "operation required for journal reclaim; may return error"   \
  31                         "instead of deadlocking if BCH_WATERMARK_reclaim not specified")\
  32
  33 enum __bch_trans_commit_flags {
  34         /* First bits for bch_watermark: */
  35         __BCH_TRANS_COMMIT_FLAGS_START = BCH_WATERMARK_BITS,
  36 #define x(n, ...)       __BCH_TRANS_COMMIT_##n,
  37         BCH_TRANS_COMMIT_FLAGS()
  38 #undef x
  39 };
  40
  41 enum bch_trans_commit_flags {
  42 #define x(n, ...)       BCH_TRANS_COMMIT_##n = BIT(__BCH_TRANS_COMMIT_##n),
  43         BCH_TRANS_COMMIT_FLAGS()
  44 #undef x
  45 };
  46
  47 int bch2_btree_delete_extent_at(struct btree_trans *, struct btree_iter *,
  48                                 unsigned, unsigned);
  49 int bch2_btree_delete_at(struct btree_trans *, struct btree_iter *, unsigned);
  50 int bch2_btree_delete(struct btree_trans *, enum btree_id, struct bpos, unsigned);
  51
  52 int bch2_btree_insert_nonextent(struct btree_trans *, enum btree_id,
  53                                 struct bkey_i *, enum btree_update_flags);
  54
  55 int bch2_btree_insert_trans(struct btree_trans *, enum btree_id, struct bkey_i *,
  56                         enum btree_update_flags);
  57 int bch2_btree_insert(struct bch_fs *, enum btree_id, struct bkey_i *,
  58                      struct disk_reservation *, int flags);
  59
  60 int bch2_btree_delete_range_trans(struct btree_trans *, enum btree_id,
  61                                   struct bpos, struct bpos, unsigned, u64 *);
  62 int bch2_btree_delete_range(struct bch_fs *, enum btree_id,
  63                             struct bpos, struct bpos, unsigned, u64 *);
  64
  65 int bch2_btree_bit_mod(struct btree_trans *, enum btree_id, struct bpos, bool);
  66
  67 static inline int bch2_btree_delete_at_buffered(struct btree_trans *trans,
  68                                                 enum btree_id btree, struct bpos pos)
  69 {
  70         return bch2_btree_bit_mod(trans, btree, pos, false);
  71 }
  72
  73 int __bch2_insert_snapshot_whiteouts(struct btree_trans *, enum btree_id,
  74                                      struct bpos, struct bpos);
  75
  76 /*
  77  * For use when splitting extents in existing snapshots:
  78  *
  79  * If @old_pos is an interior snapshot node, iterate over descendent snapshot
  80  * nodes: for every descendent snapshot in whiche @old_pos is overwritten and
  81  * not visible, emit a whiteout at @new_pos.
  82  */
  83 static inline int bch2_insert_snapshot_whiteouts(struct btree_trans *trans,
  84                                                  enum btree_id btree,
  85                                                  struct bpos old_pos,
  86                                                  struct bpos new_pos)
  87 {
  88         if (!btree_type_has_snapshots(btree) ||
  89             bkey_eq(old_pos, new_pos))
  90                 return 0;
  91
  92         return __bch2_insert_snapshot_whiteouts(trans, btree, old_pos, new_pos);
  93 }
  94
  95 int bch2_trans_update_extent_overwrite(struct btree_trans *, struct btree_iter *,
  96                                        enum btree_update_flags,
  97                                        struct bkey_s_c, struct bkey_s_c);
  98
  99 int bch2_bkey_get_empty_slot(struct btree_trans *, struct btree_iter *,
 100                              enum btree_id, struct bpos);
 101
 102 int __must_check bch2_trans_update(struct btree_trans *, struct btree_iter *,
 103                                    struct bkey_i *, enum btree_update_flags);
 104 int __must_check bch2_trans_update_seq(struct btree_trans *, u64, struct btree_iter *,
 105                                        struct bkey_i *, enum btree_update_flags);
 106 int __must_check bch2_trans_update_buffered(struct btree_trans *,
 107                                             enum btree_id, struct bkey_i *);
 108
 109 void bch2_trans_commit_hook(struct btree_trans *,
 110                             struct btree_trans_commit_hook *);
 111 int __bch2_trans_commit(struct btree_trans *, unsigned);
 112
 113 __printf(2, 3) int bch2_fs_log_msg(struct bch_fs *, const char *, ...);
 114 __printf(2, 3) int bch2_journal_log_msg(struct bch_fs *, const char *, ...);
 115
 116 /**
 117  * bch2_trans_commit - insert keys at given iterator positions
 118  *
 119  * This is main entry point for btree updates.
 120  *
 121  * Return values:
 122  * -EROFS: filesystem read only
 123  * -EIO: journal or btree node IO error
 124  */
 125 static inline int bch2_trans_commit(struct btree_trans *trans,
 126                                     struct disk_reservation *disk_res,
 127                                     u64 *journal_seq,
 128                                     unsigned flags)
 129 {
 130         trans->disk_res         = disk_res;
 131         trans->journal_seq      = journal_seq;
 132
 133         return __bch2_trans_commit(trans, flags);
 134 }
 135
 136 #define commit_do(_trans, _disk_res, _journal_seq, _flags, _do) \
 137         lockrestart_do(_trans, _do ?: bch2_trans_commit(_trans, (_disk_res),\
 138                                         (_journal_seq), (_flags)))
 139
 140 #define nested_commit_do(_trans, _disk_res, _journal_seq, _flags, _do)  \
 141         nested_lockrestart_do(_trans, _do ?: bch2_trans_commit(_trans, (_disk_res),\
 142                                         (_journal_seq), (_flags)))
 143
 144 #define bch2_trans_run(_c, _do)                                         \
 145 ({                                                                      \
 146         struct btree_trans *trans = bch2_trans_get(_c);                 \
 147         int _ret = (_do);                                               \
 148         bch2_trans_put(trans);                                          \
 149         _ret;                                                           \
 150 })
 151
 152 #define bch2_trans_do(_c, _disk_res, _journal_seq, _flags, _do)         \
 153         bch2_trans_run(_c, commit_do(trans, _disk_res, _journal_seq, _flags, _do))
 154
 155 #define trans_for_each_update(_trans, _i)                               \
 156         for ((_i) = (_trans)->updates;                                  \
 157              (_i) < (_trans)->updates + (_trans)->nr_updates;           \
 158              (_i)++)
 159
 160 #define trans_for_each_wb_update(_trans, _i)                            \
 161         for ((_i) = (_trans)->wb_updates;                               \
 162              (_i) < (_trans)->wb_updates + (_trans)->nr_wb_updates;     \
 163              (_i)++)
 164
 165 static inline void bch2_trans_reset_updates(struct btree_trans *trans)
 166 {
 167         struct btree_insert_entry *i;
 168
 169         trans_for_each_update(trans, i)
 170                 bch2_path_put(trans, i->path, true);
 171
 172         trans->extra_journal_res        = 0;
 173         trans->nr_updates               = 0;
 174         trans->nr_wb_updates            = 0;
 175         trans->wb_updates               = NULL;
 176         trans->hooks                    = NULL;
 177         trans->extra_journal_entries.nr = 0;
 178
 179         if (trans->fs_usage_deltas) {
 180                 trans->fs_usage_deltas->used = 0;
 181                 memset((void *) trans->fs_usage_deltas +
 182                        offsetof(struct replicas_delta_list, memset_start), 0,
 183                        (void *) &trans->fs_usage_deltas->memset_end -
 184                        (void *) &trans->fs_usage_deltas->memset_start);
 185         }
 186 }
 187
 188 static inline struct bkey_i *__bch2_bkey_make_mut_noupdate(struct btree_trans *trans, struct bkey_s_c k,
 189                                                   unsigned type, unsigned min_bytes)
 190 {
 191         unsigned bytes = max_t(unsigned, min_bytes, bkey_bytes(k.k));
 192         struct bkey_i *mut;
 193
 194         if (type && k.k->type != type)
 195                 return ERR_PTR(-ENOENT);
 196
 197         mut = bch2_trans_kmalloc_nomemzero(trans, bytes);
 198         if (!IS_ERR(mut)) {
 199                 bkey_reassemble(mut, k);
 200
 201                 if (unlikely(bytes > bkey_bytes(k.k))) {
 202                         memset((void *) mut + bkey_bytes(k.k), 0,
 203                                bytes - bkey_bytes(k.k));
 204                         mut->k.u64s = DIV_ROUND_UP(bytes, sizeof(u64));
 205                 }
 206         }
 207         return mut;
 208 }
 209
 210 static inline struct bkey_i *bch2_bkey_make_mut_noupdate(struct btree_trans *trans, struct bkey_s_c k)
 211 {
 212         return __bch2_bkey_make_mut_noupdate(trans, k, 0, 0);
 213 }
 214
 215 #define bch2_bkey_make_mut_noupdate_typed(_trans, _k, _type)            \
 216         bkey_i_to_##_type(__bch2_bkey_make_mut_noupdate(_trans, _k,     \
 217                                 KEY_TYPE_##_type, sizeof(struct bkey_i_##_type)))
 218
 219 static inline struct bkey_i *__bch2_bkey_make_mut(struct btree_trans *trans, struct btree_iter *iter,
 220                                         struct bkey_s_c *k, unsigned flags,
 221                                         unsigned type, unsigned min_bytes)
 222 {
 223         struct bkey_i *mut = __bch2_bkey_make_mut_noupdate(trans, *k, type, min_bytes);
 224         int ret;
 225
 226         if (IS_ERR(mut))
 227                 return mut;
 228
 229         ret = bch2_trans_update(trans, iter, mut, flags);
 230         if (ret)
 231                 return ERR_PTR(ret);
 232
 233         *k = bkey_i_to_s_c(mut);
 234         return mut;
 235 }
 236
 237 static inline struct bkey_i *bch2_bkey_make_mut(struct btree_trans *trans, struct btree_iter *iter,
 238                                                 struct bkey_s_c *k, unsigned flags)
 239 {
 240         return __bch2_bkey_make_mut(trans, iter, k, flags, 0, 0);
 241 }
 242
 243 #define bch2_bkey_make_mut_typed(_trans, _iter, _k, _flags, _type)      \
 244         bkey_i_to_##_type(__bch2_bkey_make_mut(_trans, _iter, _k, _flags,\
 245                                 KEY_TYPE_##_type, sizeof(struct bkey_i_##_type)))
 246
 247 static inline struct bkey_i *__bch2_bkey_get_mut_noupdate(struct btree_trans *trans,
 248                                          struct btree_iter *iter,
 249                                          unsigned btree_id, struct bpos pos,
 250                                          unsigned flags, unsigned type, unsigned min_bytes)
 251 {
 252         struct bkey_s_c k = __bch2_bkey_get_iter(trans, iter,
 253                                 btree_id, pos, flags|BTREE_ITER_INTENT, type);
 254         struct bkey_i *ret = IS_ERR(k.k)
 255                 ? ERR_CAST(k.k)
 256                 : __bch2_bkey_make_mut_noupdate(trans, k, 0, min_bytes);
 257         if (IS_ERR(ret))
 258                 bch2_trans_iter_exit(trans, iter);
 259         return ret;
 260 }
 261
 262 static inline struct bkey_i *bch2_bkey_get_mut_noupdate(struct btree_trans *trans,
 263                                                struct btree_iter *iter,
 264                                                unsigned btree_id, struct bpos pos,
 265                                                unsigned flags)
 266 {
 267         return __bch2_bkey_get_mut_noupdate(trans, iter, btree_id, pos, flags, 0, 0);
 268 }
 269
 270 static inline struct bkey_i *__bch2_bkey_get_mut(struct btree_trans *trans,
 271                                          struct btree_iter *iter,
 272                                          unsigned btree_id, struct bpos pos,
 273                                          unsigned flags, unsigned type, unsigned min_bytes)
 274 {
 275         struct bkey_i *mut = __bch2_bkey_get_mut_noupdate(trans, iter,
 276                                 btree_id, pos, flags|BTREE_ITER_INTENT, type, min_bytes);
 277         int ret;
 278
 279         if (IS_ERR(mut))
 280                 return mut;
 281
 282         ret = bch2_trans_update(trans, iter, mut, flags);
 283         if (ret) {
 284                 bch2_trans_iter_exit(trans, iter);
 285                 return ERR_PTR(ret);
 286         }
 287
 288         return mut;
 289 }
 290
 291 static inline struct bkey_i *bch2_bkey_get_mut_minsize(struct btree_trans *trans,
 292                                                        struct btree_iter *iter,
 293                                                        unsigned btree_id, struct bpos pos,
 294                                                        unsigned flags, unsigned min_bytes)
 295 {
 296         return __bch2_bkey_get_mut(trans, iter, btree_id, pos, flags, 0, min_bytes);
 297 }
 298
 299 static inline struct bkey_i *bch2_bkey_get_mut(struct btree_trans *trans,
 300                                                struct btree_iter *iter,
 301                                                unsigned btree_id, struct bpos pos,
 302                                                unsigned flags)
 303 {
 304         return __bch2_bkey_get_mut(trans, iter, btree_id, pos, flags, 0, 0);
 305 }
 306
 307 #define bch2_bkey_get_mut_typed(_trans, _iter, _btree_id, _pos, _flags, _type)\
 308         bkey_i_to_##_type(__bch2_bkey_get_mut(_trans, _iter,            \
 309                         _btree_id, _pos, _flags,                        \
 310                         KEY_TYPE_##_type, sizeof(struct bkey_i_##_type)))
 311
 312 static inline struct bkey_i *__bch2_bkey_alloc(struct btree_trans *trans, struct btree_iter *iter,
 313                                                unsigned flags, unsigned type, unsigned val_size)
 314 {
 315         struct bkey_i *k = bch2_trans_kmalloc(trans, sizeof(*k) + val_size);
 316         int ret;
 317
 318         if (IS_ERR(k))
 319                 return k;
 320
 321         bkey_init(&k->k);
 322         k->k.p = iter->pos;
 323         k->k.type = type;
 324         set_bkey_val_bytes(&k->k, val_size);
 325
 326         ret = bch2_trans_update(trans, iter, k, flags);
 327         if (unlikely(ret))
 328                 return ERR_PTR(ret);
 329         return k;
 330 }
 331
 332 #define bch2_bkey_alloc(_trans, _iter, _flags, _type)                   \
 333         bkey_i_to_##_type(__bch2_bkey_alloc(_trans, _iter, _flags,      \
 334                                 KEY_TYPE_##_type, sizeof(struct bch_##_type)))
 335
 336 #endif /* _BCACHEFS_BTREE_UPDATE_H */