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 bkey;
  10 enum btree_node_type;
  11
  12 extern const char * const bch2_bkey_types[];
  13
  14 enum merge_result {
  15         BCH_MERGE_NOMERGE,
  16
  17         /*
  18          * The keys were mergeable, but would have overflowed size - so instead
  19          * l was changed to the maximum size, and both keys were modified:
  20          */
  21         BCH_MERGE_PARTIAL,
  22         BCH_MERGE_MERGE,
  23 };
  24
  25 struct bkey_ops {
  26         /* Returns reason for being invalid if invalid, else NULL: */
  27         const char *    (*key_invalid)(const struct bch_fs *,
  28                                        struct bkey_s_c);
  29         void            (*val_to_text)(struct printbuf *, struct bch_fs *,
  30                                        struct bkey_s_c);
  31         void            (*swab)(struct bkey_s);
  32         bool            (*key_normalize)(struct bch_fs *, struct bkey_s);
  33         enum merge_result (*key_merge)(struct bch_fs *,
  34                                        struct bkey_s, struct bkey_s);
  35         void            (*compat)(enum btree_id id, unsigned version,
  36                                   unsigned big_endian, int write,
  37                                   struct bkey_s);
  38 };
  39
  40 const char *bch2_bkey_val_invalid(struct bch_fs *, struct bkey_s_c);
  41 const char *__bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c,
  42                                 enum btree_node_type);
  43 const char *bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c,
  44                               enum btree_node_type);
  45 const char *bch2_bkey_in_btree_node(struct btree *, struct bkey_s_c);
  46
  47 void bch2_bkey_debugcheck(struct bch_fs *, struct btree *, struct bkey_s_c);
  48
  49 void bch2_bpos_to_text(struct printbuf *, struct bpos);
  50 void bch2_bkey_to_text(struct printbuf *, const struct bkey *);
  51 void bch2_val_to_text(struct printbuf *, struct bch_fs *,
  52                       struct bkey_s_c);
  53 void bch2_bkey_val_to_text(struct printbuf *, struct bch_fs *,
  54                            struct bkey_s_c);
  55
  56 void bch2_bkey_swab_val(struct bkey_s);
  57
  58 bool bch2_bkey_normalize(struct bch_fs *, struct bkey_s);
  59
  60 enum merge_result bch2_bkey_merge(struct bch_fs *,
  61                                   struct bkey_s, struct bkey_s);
  62
  63 void bch2_bkey_renumber(enum btree_node_type, struct bkey_packed *, int);
  64
  65 void __bch2_bkey_compat(unsigned, enum btree_id, unsigned, unsigned,
  66                         int, struct bkey_format *, struct bkey_packed *);
  67
  68 static inline void bch2_bkey_compat(unsigned level, enum btree_id btree_id,
  69                                unsigned version, unsigned big_endian,
  70                                int write,
  71                                struct bkey_format *f,
  72                                struct bkey_packed *k)
  73 {
  74         if (version < bcachefs_metadata_version_current ||
  75             big_endian != CPU_BIG_ENDIAN)
  76                 __bch2_bkey_compat(level, btree_id, version,
  77                                    big_endian, write, f, k);
  78
  79 }
  80
  81 #endif /* _BCACHEFS_BKEY_METHODS_H */