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