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

   1 // SPDX-License-Identifier: GPL-2.0
   2
   3 #include "bcachefs.h"
   4 #include "bkey_methods.h"
   5 #include "btree_types.h"
   6 #include "alloc_background.h"
   7 #include "dirent.h"
   8 #include "ec.h"
   9 #include "error.h"
  10 #include "extents.h"
  11 #include "inode.h"
  12 #include "quota.h"
  13 #include "reflink.h"
  14 #include "xattr.h"
  15
  16 const char * const bch2_bkey_types[] = {
  17 #define x(name, nr) #name,
  18         BCH_BKEY_TYPES()
  19 #undef x
  20         NULL
  21 };
  22
  23 static const char *deleted_key_invalid(const struct bch_fs *c,
  24                                         struct bkey_s_c k)
  25 {
  26         return NULL;
  27 }
  28
  29 #define bch2_bkey_ops_deleted (struct bkey_ops) {       \
  30         .key_invalid = deleted_key_invalid,             \
  31 }
  32
  33 #define bch2_bkey_ops_discard (struct bkey_ops) {       \
  34         .key_invalid = deleted_key_invalid,             \
  35 }
  36
  37 static const char *empty_val_key_invalid(const struct bch_fs *c, struct bkey_s_c k)
  38 {
  39         if (bkey_val_bytes(k.k))
  40                 return "value size should be zero";
  41
  42         return NULL;
  43 }
  44
  45 #define bch2_bkey_ops_error (struct bkey_ops) {         \
  46         .key_invalid = empty_val_key_invalid,           \
  47 }
  48
  49 static const char *key_type_cookie_invalid(const struct bch_fs *c,
  50                                            struct bkey_s_c k)
  51 {
  52         if (bkey_val_bytes(k.k) != sizeof(struct bch_cookie))
  53                 return "incorrect value size";
  54
  55         return NULL;
  56 }
  57
  58 #define bch2_bkey_ops_cookie (struct bkey_ops) {        \
  59         .key_invalid = key_type_cookie_invalid,         \
  60 }
  61
  62 #define bch2_bkey_ops_whiteout (struct bkey_ops) {      \
  63         .key_invalid = empty_val_key_invalid,           \
  64 }
  65
  66 static const char *key_type_inline_data_invalid(const struct bch_fs *c,
  67                                            struct bkey_s_c k)
  68 {
  69         return NULL;
  70 }
  71
  72 static void key_type_inline_data_to_text(struct printbuf *out, struct bch_fs *c,
  73                                          struct bkey_s_c k)
  74 {
  75         pr_buf(out, "(%zu bytes)", bkey_val_bytes(k.k));
  76 }
  77
  78 #define bch2_bkey_ops_inline_data (struct bkey_ops) {   \
  79         .key_invalid    = key_type_inline_data_invalid, \
  80         .val_to_text    = key_type_inline_data_to_text, \
  81 }
  82
  83 static const struct bkey_ops bch2_bkey_ops[] = {
  84 #define x(name, nr) [KEY_TYPE_##name]   = bch2_bkey_ops_##name,
  85         BCH_BKEY_TYPES()
  86 #undef x
  87 };
  88
  89 const char *bch2_bkey_val_invalid(struct bch_fs *c, struct bkey_s_c k)
  90 {
  91         if (k.k->type >= KEY_TYPE_MAX)
  92                 return "invalid type";
  93
  94         return bch2_bkey_ops[k.k->type].key_invalid(c, k);
  95 }
  96
  97 const char *__bch2_bkey_invalid(struct bch_fs *c, struct bkey_s_c k,
  98                                 enum btree_node_type type)
  99 {
 100         if (k.k->u64s < BKEY_U64s)
 101                 return "u64s too small";
 102
 103         if (type == BKEY_TYPE_BTREE &&
 104             bkey_val_u64s(k.k) > BKEY_BTREE_PTR_VAL_U64s_MAX)
 105                 return "value too big";
 106
 107         if (btree_node_type_is_extents(type)) {
 108                 if ((k.k->size == 0) != bkey_deleted(k.k))
 109                         return "bad size field";
 110
 111                 if (k.k->size > k.k->p.offset)
 112                         return "size greater than offset";
 113         } else {
 114                 if (k.k->size)
 115                         return "nonzero size field";
 116         }
 117
 118         if (k.k->p.snapshot)
 119                 return "nonzero snapshot";
 120
 121         if (type != BKEY_TYPE_BTREE &&
 122             !bkey_cmp(k.k->p, POS_MAX))
 123                 return "POS_MAX key";
 124
 125         return NULL;
 126 }
 127
 128 const char *bch2_bkey_invalid(struct bch_fs *c, struct bkey_s_c k,
 129                               enum btree_node_type type)
 130 {
 131         return __bch2_bkey_invalid(c, k, type) ?:
 132                 bch2_bkey_val_invalid(c, k);
 133 }
 134
 135 const char *bch2_bkey_in_btree_node(struct btree *b, struct bkey_s_c k)
 136 {
 137         if (bkey_cmp(k.k->p, b->data->min_key) < 0)
 138                 return "key before start of btree node";
 139
 140         if (bkey_cmp(k.k->p, b->data->max_key) > 0)
 141                 return "key past end of btree node";
 142
 143         return NULL;
 144 }
 145
 146 void bch2_bkey_debugcheck(struct bch_fs *c, struct btree *b, struct bkey_s_c k)
 147 {
 148         const struct bkey_ops *ops = &bch2_bkey_ops[k.k->type];
 149         const char *invalid;
 150
 151         BUG_ON(!k.k->u64s);
 152
 153         invalid = bch2_bkey_invalid(c, k, btree_node_type(b)) ?:
 154                 bch2_bkey_in_btree_node(b, k);
 155         if (invalid) {
 156                 char buf[160];
 157
 158                 bch2_bkey_val_to_text(&PBUF(buf), c, k);
 159                 bch2_fs_inconsistent(c, "invalid bkey %s: %s", buf, invalid);
 160                 return;
 161         }
 162
 163         if (ops->key_debugcheck)
 164                 ops->key_debugcheck(c, k);
 165 }
 166
 167 void bch2_bpos_to_text(struct printbuf *out, struct bpos pos)
 168 {
 169         if (!bkey_cmp(pos, POS_MIN))
 170                 pr_buf(out, "POS_MIN");
 171         else if (!bkey_cmp(pos, POS_MAX))
 172                 pr_buf(out, "POS_MAX");
 173         else
 174                 pr_buf(out, "%llu:%llu", pos.inode, pos.offset);
 175 }
 176
 177 void bch2_bkey_to_text(struct printbuf *out, const struct bkey *k)
 178 {
 179         pr_buf(out, "u64s %u type %s ", k->u64s,
 180                bch2_bkey_types[k->type]);
 181
 182         bch2_bpos_to_text(out, k->p);
 183
 184         pr_buf(out, " snap %u len %u ver %llu",
 185                k->p.snapshot, k->size, k->version.lo);
 186 }
 187
 188 void bch2_val_to_text(struct printbuf *out, struct bch_fs *c,
 189                       struct bkey_s_c k)
 190 {
 191         const struct bkey_ops *ops = &bch2_bkey_ops[k.k->type];
 192
 193         if (likely(ops->val_to_text))
 194                 ops->val_to_text(out, c, k);
 195 }
 196
 197 void bch2_bkey_val_to_text(struct printbuf *out, struct bch_fs *c,
 198                            struct bkey_s_c k)
 199 {
 200         bch2_bkey_to_text(out, k.k);
 201         pr_buf(out, ": ");
 202         bch2_val_to_text(out, c, k);
 203 }
 204
 205 void bch2_bkey_swab_val(struct bkey_s k)
 206 {
 207         const struct bkey_ops *ops = &bch2_bkey_ops[k.k->type];
 208
 209         if (ops->swab)
 210                 ops->swab(k);
 211 }
 212
 213 bool bch2_bkey_normalize(struct bch_fs *c, struct bkey_s k)
 214 {
 215         const struct bkey_ops *ops = &bch2_bkey_ops[k.k->type];
 216
 217         return ops->key_normalize
 218                 ? ops->key_normalize(c, k)
 219                 : false;
 220 }
 221
 222 enum merge_result bch2_bkey_merge(struct bch_fs *c,
 223                                   struct bkey_s l, struct bkey_s r)
 224 {
 225         const struct bkey_ops *ops = &bch2_bkey_ops[l.k->type];
 226         enum merge_result ret;
 227
 228         if (key_merging_disabled(c) ||
 229             !ops->key_merge ||
 230             l.k->type != r.k->type ||
 231             bversion_cmp(l.k->version, r.k->version) ||
 232             bkey_cmp(l.k->p, bkey_start_pos(r.k)))
 233                 return BCH_MERGE_NOMERGE;
 234
 235         ret = ops->key_merge(c, l, r);
 236
 237         if (ret != BCH_MERGE_NOMERGE)
 238                 l.k->needs_whiteout |= r.k->needs_whiteout;
 239         return ret;
 240 }
 241
 242 static const struct old_bkey_type {
 243         u8              btree_node_type;
 244         u8              old;
 245         u8              new;
 246 } bkey_renumber_table[] = {
 247         {BKEY_TYPE_BTREE,       128, KEY_TYPE_btree_ptr         },
 248         {BKEY_TYPE_EXTENTS,     128, KEY_TYPE_extent            },
 249         {BKEY_TYPE_EXTENTS,     129, KEY_TYPE_extent            },
 250         {BKEY_TYPE_EXTENTS,     130, KEY_TYPE_reservation       },
 251         {BKEY_TYPE_INODES,      128, KEY_TYPE_inode             },
 252         {BKEY_TYPE_INODES,      130, KEY_TYPE_inode_generation  },
 253         {BKEY_TYPE_DIRENTS,     128, KEY_TYPE_dirent            },
 254         {BKEY_TYPE_DIRENTS,     129, KEY_TYPE_whiteout          },
 255         {BKEY_TYPE_XATTRS,      128, KEY_TYPE_xattr             },
 256         {BKEY_TYPE_XATTRS,      129, KEY_TYPE_whiteout          },
 257         {BKEY_TYPE_ALLOC,       128, KEY_TYPE_alloc             },
 258         {BKEY_TYPE_QUOTAS,      128, KEY_TYPE_quota             },
 259 };
 260
 261 void bch2_bkey_renumber(enum btree_node_type btree_node_type,
 262                         struct bkey_packed *k,
 263                         int write)
 264 {
 265         const struct old_bkey_type *i;
 266
 267         for (i = bkey_renumber_table;
 268              i < bkey_renumber_table + ARRAY_SIZE(bkey_renumber_table);
 269              i++)
 270                 if (btree_node_type == i->btree_node_type &&
 271                     k->type == (write ? i->new : i->old)) {
 272                         k->type = write ? i->old : i->new;
 273                         break;
 274                 }
 275 }
 276
 277 void __bch2_bkey_compat(unsigned level, enum btree_id btree_id,
 278                         unsigned version, unsigned big_endian,
 279                         int write,
 280                         struct bkey_format *f,
 281                         struct bkey_packed *k)
 282 {
 283         const struct bkey_ops *ops;
 284         struct bkey uk;
 285         struct bkey_s u;
 286
 287         if (big_endian != CPU_BIG_ENDIAN)
 288                 bch2_bkey_swab_key(f, k);
 289
 290         if (version < bcachefs_metadata_version_bkey_renumber)
 291                 bch2_bkey_renumber(__btree_node_type(level, btree_id), k, write);
 292
 293         if (version < bcachefs_metadata_version_inode_btree_change &&
 294             btree_id == BTREE_ID_INODES) {
 295                 if (!bkey_packed(k)) {
 296                         struct bkey_i *u = packed_to_bkey(k);
 297                         swap(u->k.p.inode, u->k.p.offset);
 298                 } else if (f->bits_per_field[BKEY_FIELD_INODE] &&
 299                            f->bits_per_field[BKEY_FIELD_OFFSET]) {
 300                         struct bkey_format tmp = *f, *in = f, *out = &tmp;
 301
 302                         swap(tmp.bits_per_field[BKEY_FIELD_INODE],
 303                              tmp.bits_per_field[BKEY_FIELD_OFFSET]);
 304                         swap(tmp.field_offset[BKEY_FIELD_INODE],
 305                              tmp.field_offset[BKEY_FIELD_OFFSET]);
 306
 307                         if (!write)
 308                                 swap(in, out);
 309
 310                         uk = __bch2_bkey_unpack_key(in, k);
 311                         swap(uk.p.inode, uk.p.offset);
 312                         BUG_ON(!bch2_bkey_pack_key(k, &uk, out));
 313                 }
 314         }
 315
 316         if (!bkey_packed(k)) {
 317                 u = bkey_i_to_s(packed_to_bkey(k));
 318         } else {
 319                 uk = __bch2_bkey_unpack_key(f, k);
 320                 u.k = &uk;
 321                 u.v = bkeyp_val(f, k);
 322         }
 323
 324         if (big_endian != CPU_BIG_ENDIAN)
 325                 bch2_bkey_swab_val(u);
 326
 327         ops = &bch2_bkey_ops[k->type];
 328
 329         if (ops->compat)
 330                 ops->compat(btree_id, version, big_endian, write, u);
 331 }