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