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 struct bkey_ops {
  16         /* Returns reason for being invalid if invalid, else NULL: */
  17         const char *    (*key_invalid)(const struct bch_fs *,
  18                                        struct bkey_s_c);
  19         void            (*val_to_text)(struct printbuf *, struct bch_fs *,
  20                                        struct bkey_s_c);
  21         void            (*swab)(struct bkey_s);
  22         bool            (*key_normalize)(struct bch_fs *, struct bkey_s);
  23         bool            (*key_merge)(struct bch_fs *, struct bkey_s, struct bkey_s_c);
  24         int             (*trans_trigger)(struct btree_trans *, struct bkey_s_c,
  25                                          struct bkey_i *, unsigned);
  26         int             (*atomic_trigger)(struct btree_trans *, struct bkey_s_c,
  27                                           struct bkey_s_c, unsigned);
  28         void            (*compat)(enum btree_id id, unsigned version,
  29                                   unsigned big_endian, int write,
  30                                   struct bkey_s);
  31 };
  32
  33 extern const struct bkey_ops bch2_bkey_ops[];
  34
  35 const char *bch2_bkey_val_invalid(struct bch_fs *, struct bkey_s_c);
  36 const char *__bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c,
  37                                 enum btree_node_type);
  38 const char *bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c,
  39                               enum btree_node_type);
  40 const char *bch2_bkey_in_btree_node(struct btree *, struct bkey_s_c);
  41
  42 void bch2_bpos_to_text(struct printbuf *, struct bpos);
  43 void bch2_bkey_to_text(struct printbuf *, const struct bkey *);
  44 void bch2_val_to_text(struct printbuf *, struct bch_fs *,
  45                       struct bkey_s_c);
  46 void bch2_bkey_val_to_text(struct printbuf *, struct bch_fs *,
  47                            struct bkey_s_c);
  48
  49 void bch2_bkey_swab_val(struct bkey_s);
  50
  51 bool bch2_bkey_normalize(struct bch_fs *, struct bkey_s);
  52
  53 static inline bool bch2_bkey_maybe_mergable(const struct bkey *l, const struct bkey *r)
  54 {
  55         return l->type == r->type &&
  56                 !bversion_cmp(l->version, r->version) &&
  57                 !bpos_cmp(l->p, bkey_start_pos(r)) &&
  58                 (u64) l->size + r->size <= KEY_SIZE_MAX &&
  59                 bch2_bkey_ops[l->type].key_merge &&
  60                 !bch2_key_merging_disabled;
  61 }
  62
  63 bool bch2_bkey_merge(struct bch_fs *, struct bkey_s, struct bkey_s_c);
  64
  65 static inline int bch2_mark_key(struct btree_trans *trans,
  66                   struct bkey_s_c old,
  67                   struct bkey_s_c new,
  68                   unsigned flags)
  69 {
  70         const struct bkey_ops *ops = &bch2_bkey_ops[old.k->type ?: new.k->type];
  71
  72         return ops->atomic_trigger
  73                 ? ops->atomic_trigger(trans, old, new, flags)
  74                 : 0;
  75 }
  76
  77 static inline int bch2_trans_mark_key(struct btree_trans *trans, struct bkey_s_c old,
  78                         struct bkey_i *new, unsigned flags)
  79 {
  80         const struct bkey_ops *ops = &bch2_bkey_ops[old.k->type ?: new->k.type];
  81
  82         return ops->trans_trigger
  83                 ? ops->trans_trigger(trans, old, new, flags)
  84                 : 0;
  85 }
  86
  87 void bch2_bkey_renumber(enum btree_node_type, struct bkey_packed *, int);
  88
  89 void __bch2_bkey_compat(unsigned, enum btree_id, unsigned, unsigned,
  90                         int, struct bkey_format *, struct bkey_packed *);
  91
  92 static inline void bch2_bkey_compat(unsigned level, enum btree_id btree_id,
  93                                unsigned version, unsigned big_endian,
  94                                int write,
  95                                struct bkey_format *f,
  96                                struct bkey_packed *k)
  97 {
  98         if (version < bcachefs_metadata_version_current ||
  99             big_endian != CPU_BIG_ENDIAN)
 100                 __bch2_bkey_compat(level, btree_id, version,
 101                                    big_endian, write, f, k);
 102
 103 }
 104
 105 #endif /* _BCACHEFS_BKEY_METHODS_H */