git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/bkey_methods.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _BCACHEFS_BKEY_METHODS_H
   3 #define _BCACHEFS_BKEY_METHODS_H
   4
   5 #include "bkey.h"
   6
   7 struct bch_fs;
   8 struct btree;
   9 struct btree_trans;
  10 struct bkey;
  11 enum btree_node_type;
  12
  13 extern const char * const bch2_bkey_types[];
  14
  15 /*
  16  * key_invalid: checks validity of @k, returns 0 if good or -EINVAL if bad. If
  17  * invalid, entire key will be deleted.
  18  *
  19  * When invalid, error string is returned via @err. @rw indicates whether key is
  20  * being read or written; more aggressive checks can be enabled when rw == WRITE.
  21  */
  22 struct bkey_ops {
  23         int             (*key_invalid)(const struct bch_fs *c, struct bkey_s_c k,
  24                                        int rw, struct printbuf *err);
  25         void            (*val_to_text)(struct printbuf *, struct bch_fs *,
  26                                        struct bkey_s_c);
  27         void            (*swab)(struct bkey_s);
  28         bool            (*key_normalize)(struct bch_fs *, struct bkey_s);
  29         bool            (*key_merge)(struct bch_fs *, struct bkey_s, struct bkey_s_c);
  30         int             (*trans_trigger)(struct btree_trans *, enum btree_id, unsigned,
  31                                          struct bkey_s_c, struct bkey_i *, unsigned);
  32         int             (*atomic_trigger)(struct btree_trans *, struct bkey_s_c,
  33                                           struct bkey_s_c, unsigned);
  34         void            (*compat)(enum btree_id id, unsigned version,
  35                                   unsigned big_endian, int write,
  36                                   struct bkey_s);
  37 };
  38
  39 extern const struct bkey_ops bch2_bkey_ops[];
  40
  41 int bch2_bkey_val_invalid(struct bch_fs *, struct bkey_s_c, int, struct printbuf *);
  42 int __bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c,
  43                         enum btree_node_type, int, struct printbuf *);
  44 int bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c,
  45                       enum btree_node_type, int, struct printbuf *);
  46 int bch2_bkey_in_btree_node(struct btree *, struct bkey_s_c, struct printbuf *);
  47
  48 void bch2_bpos_to_text(struct printbuf *, struct bpos);
  49 void bch2_bkey_to_text(struct printbuf *, const struct bkey *);
  50 void bch2_val_to_text(struct printbuf *, struct bch_fs *,
  51                       struct bkey_s_c);
  52 void bch2_bkey_val_to_text(struct printbuf *, struct bch_fs *,
  53                            struct bkey_s_c);
  54
  55 void bch2_bkey_swab_val(struct bkey_s);
  56
  57 bool bch2_bkey_normalize(struct bch_fs *, struct bkey_s);
  58
  59 static inline bool bch2_bkey_maybe_mergable(const struct bkey *l, const struct bkey *r)
  60 {
  61         return l->type == r->type &&
  62                 !bversion_cmp(l->version, r->version) &&
  63                 !bpos_cmp(l->p, bkey_start_pos(r)) &&
  64                 (u64) l->size + r->size <= KEY_SIZE_MAX &&
  65                 bch2_bkey_ops[l->type].key_merge &&
  66                 !bch2_key_merging_disabled;
  67 }
  68
  69 bool bch2_bkey_merge(struct bch_fs *, struct bkey_s, struct bkey_s_c);
  70
  71 static inline int bch2_mark_key(struct btree_trans *trans,
  72                   struct bkey_s_c old,
  73                   struct bkey_s_c new,
  74                   unsigned flags)
  75 {
  76         const struct bkey_ops *ops = &bch2_bkey_ops[old.k->type ?: new.k->type];
  77
  78         return ops->atomic_trigger
  79                 ? ops->atomic_trigger(trans, old, new, flags)
  80                 : 0;
  81 }
  82
  83 enum btree_update_flags {
  84         __BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE,
  85         __BTREE_UPDATE_KEY_CACHE_RECLAIM,
  86
  87         __BTREE_TRIGGER_NORUN,          /* Don't run triggers at all */
  88
  89         __BTREE_TRIGGER_INSERT,
  90         __BTREE_TRIGGER_OVERWRITE,
  91
  92         __BTREE_TRIGGER_GC,
  93         __BTREE_TRIGGER_BUCKET_INVALIDATE,
  94         __BTREE_TRIGGER_NOATOMIC,
  95 };
  96
  97 #define BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE (1U << __BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE)
  98 #define BTREE_UPDATE_KEY_CACHE_RECLAIM  (1U << __BTREE_UPDATE_KEY_CACHE_RECLAIM)
  99
 100 #define BTREE_TRIGGER_NORUN             (1U << __BTREE_TRIGGER_NORUN)
 101
 102 #define BTREE_TRIGGER_INSERT            (1U << __BTREE_TRIGGER_INSERT)
 103 #define BTREE_TRIGGER_OVERWRITE         (1U << __BTREE_TRIGGER_OVERWRITE)
 104
 105 #define BTREE_TRIGGER_GC                (1U << __BTREE_TRIGGER_GC)
 106 #define BTREE_TRIGGER_BUCKET_INVALIDATE (1U << __BTREE_TRIGGER_BUCKET_INVALIDATE)
 107 #define BTREE_TRIGGER_NOATOMIC          (1U << __BTREE_TRIGGER_NOATOMIC)
 108
 109 #define BTREE_TRIGGER_WANTS_OLD_AND_NEW         \
 110         ((1U << KEY_TYPE_alloc)|                \
 111          (1U << KEY_TYPE_alloc_v2)|             \
 112          (1U << KEY_TYPE_alloc_v3)|             \
 113          (1U << KEY_TYPE_alloc_v4)|             \
 114          (1U << KEY_TYPE_stripe)|               \
 115          (1U << KEY_TYPE_inode)|                \
 116          (1U << KEY_TYPE_inode_v2)|             \
 117          (1U << KEY_TYPE_snapshot))
 118
 119 static inline int bch2_trans_mark_key(struct btree_trans *trans,
 120                                       enum btree_id btree_id, unsigned level,
 121                                       struct bkey_s_c old, struct bkey_i *new,
 122                                       unsigned flags)
 123 {
 124         const struct bkey_ops *ops = &bch2_bkey_ops[old.k->type ?: new->k.type];
 125
 126         return ops->trans_trigger
 127                 ? ops->trans_trigger(trans, btree_id, level, old, new, flags)
 128                 : 0;
 129 }
 130
 131 static inline int bch2_trans_mark_old(struct btree_trans *trans,
 132                                       enum btree_id btree_id, unsigned level,
 133                                       struct bkey_s_c old, unsigned flags)
 134 {
 135         struct bkey_i deleted;
 136
 137         bkey_init(&deleted.k);
 138         deleted.k.p = old.k->p;
 139
 140         return bch2_trans_mark_key(trans, btree_id, level, old, &deleted,
 141                                    BTREE_TRIGGER_OVERWRITE|flags);
 142 }
 143
 144 static inline int bch2_trans_mark_new(struct btree_trans *trans,
 145                                       enum btree_id btree_id, unsigned level,
 146                                       struct bkey_i *new, unsigned flags)
 147 {
 148         struct bkey_i deleted;
 149
 150         bkey_init(&deleted.k);
 151         deleted.k.p = new->k.p;
 152
 153         return bch2_trans_mark_key(trans, btree_id, level, bkey_i_to_s_c(&deleted), new,
 154                                    BTREE_TRIGGER_INSERT|flags);
 155 }
 156
 157 void bch2_bkey_renumber(enum btree_node_type, struct bkey_packed *, int);
 158
 159 void __bch2_bkey_compat(unsigned, enum btree_id, unsigned, unsigned,
 160                         int, struct bkey_format *, struct bkey_packed *);
 161
 162 static inline void bch2_bkey_compat(unsigned level, enum btree_id btree_id,
 163                                unsigned version, unsigned big_endian,
 164                                int write,
 165                                struct bkey_format *f,
 166                                struct bkey_packed *k)
 167 {
 168         if (version < bcachefs_metadata_version_current ||
 169             big_endian != CPU_BIG_ENDIAN)
 170                 __bch2_bkey_compat(level, btree_id, version,
 171                                    big_endian, write, f, k);
 172
 173 }
 174
 175 #endif /* _BCACHEFS_BKEY_METHODS_H */