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