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         if (k) {
 180                 pr_buf(out, "u64s %u type %s ", k->u64s,
 181                        bch2_bkey_types[k->type]);
 182
 183                 bch2_bpos_to_text(out, k->p);
 184
 185                 pr_buf(out, " snap %u len %u ver %llu",
 186                        k->p.snapshot, k->size, k->version.lo);
 187         } else {
 188                 pr_buf(out, "(null)");
 189         }
 190 }
 191
 192 void bch2_val_to_text(struct printbuf *out, struct bch_fs *c,
 193                       struct bkey_s_c k)
 194 {
 195         const struct bkey_ops *ops = &bch2_bkey_ops[k.k->type];
 196
 197         if (likely(ops->val_to_text))
 198                 ops->val_to_text(out, c, k);
 199 }
 200
 201 void bch2_bkey_val_to_text(struct printbuf *out, struct bch_fs *c,
 202                            struct bkey_s_c k)
 203 {
 204         bch2_bkey_to_text(out, k.k);
 205
 206         if (k.k) {
 207                 pr_buf(out, ": ");
 208                 bch2_val_to_text(out, c, k);
 209         }
 210 }
 211
 212 void bch2_bkey_swab_val(struct bkey_s k)
 213 {
 214         const struct bkey_ops *ops = &bch2_bkey_ops[k.k->type];
 215
 216         if (ops->swab)
 217                 ops->swab(k);
 218 }
 219
 220 bool bch2_bkey_normalize(struct bch_fs *c, struct bkey_s k)
 221 {
 222         const struct bkey_ops *ops = &bch2_bkey_ops[k.k->type];
 223
 224         return ops->key_normalize
 225                 ? ops->key_normalize(c, k)
 226                 : false;
 227 }
 228
 229 enum merge_result bch2_bkey_merge(struct bch_fs *c,
 230                                   struct bkey_s l, struct bkey_s r)
 231 {
 232         const struct bkey_ops *ops = &bch2_bkey_ops[l.k->type];
 233         enum merge_result ret;
 234
 235         if (key_merging_disabled(c) ||
 236             !ops->key_merge ||
 237             l.k->type != r.k->type ||
 238             bversion_cmp(l.k->version, r.k->version) ||
 239             bkey_cmp(l.k->p, bkey_start_pos(r.k)))
 240                 return BCH_MERGE_NOMERGE;
 241
 242         ret = ops->key_merge(c, l, r);
 243
 244         if (ret != BCH_MERGE_NOMERGE)
 245                 l.k->needs_whiteout |= r.k->needs_whiteout;
 246         return ret;
 247 }
 248
 249 static const struct old_bkey_type {
 250         u8              btree_node_type;
 251         u8              old;
 252         u8              new;
 253 } bkey_renumber_table[] = {
 254         {BKEY_TYPE_BTREE,       128, KEY_TYPE_btree_ptr         },
 255         {BKEY_TYPE_EXTENTS,     128, KEY_TYPE_extent            },
 256         {BKEY_TYPE_EXTENTS,     129, KEY_TYPE_extent            },
 257         {BKEY_TYPE_EXTENTS,     130, KEY_TYPE_reservation       },
 258         {BKEY_TYPE_INODES,      128, KEY_TYPE_inode             },
 259         {BKEY_TYPE_INODES,      130, KEY_TYPE_inode_generation  },
 260         {BKEY_TYPE_DIRENTS,     128, KEY_TYPE_dirent            },
 261         {BKEY_TYPE_DIRENTS,     129, KEY_TYPE_whiteout          },
 262         {BKEY_TYPE_XATTRS,      128, KEY_TYPE_xattr             },
 263         {BKEY_TYPE_XATTRS,      129, KEY_TYPE_whiteout          },
 264         {BKEY_TYPE_ALLOC,       128, KEY_TYPE_alloc             },
 265         {BKEY_TYPE_QUOTAS,      128, KEY_TYPE_quota             },
 266 };
 267
 268 void bch2_bkey_renumber(enum btree_node_type btree_node_type,
 269                         struct bkey_packed *k,
 270                         int write)
 271 {
 272         const struct old_bkey_type *i;
 273
 274         for (i = bkey_renumber_table;
 275              i < bkey_renumber_table + ARRAY_SIZE(bkey_renumber_table);
 276              i++)
 277                 if (btree_node_type == i->btree_node_type &&
 278                     k->type == (write ? i->new : i->old)) {
 279                         k->type = write ? i->old : i->new;
 280                         break;
 281                 }
 282 }
 283
 284 void __bch2_bkey_compat(unsigned level, enum btree_id btree_id,
 285                         unsigned version, unsigned big_endian,
 286                         int write,
 287                         struct bkey_format *f,
 288                         struct bkey_packed *k)
 289 {
 290         const struct bkey_ops *ops;
 291         struct bkey uk;
 292         struct bkey_s u;
 293         int i;
 294
 295         /*
 296          * Do these operations in reverse order in the write path:
 297          */
 298
 299         for (i = 0; i < 4; i++)
 300         switch (!write ? i : 3 - i) {
 301         case 0:
 302                 if (big_endian != CPU_BIG_ENDIAN)
 303                         bch2_bkey_swab_key(f, k);
 304                 break;
 305         case 1:
 306                 if (version < bcachefs_metadata_version_bkey_renumber)
 307                         bch2_bkey_renumber(__btree_node_type(level, btree_id), k, write);
 308                 break;
 309         case 2:
 310                 if (version < bcachefs_metadata_version_inode_btree_change &&
 311                     btree_id == BTREE_ID_INODES) {
 312                         if (!bkey_packed(k)) {
 313                                 struct bkey_i *u = packed_to_bkey(k);
 314                                 swap(u->k.p.inode, u->k.p.offset);
 315                         } else if (f->bits_per_field[BKEY_FIELD_INODE] &&
 316                                    f->bits_per_field[BKEY_FIELD_OFFSET]) {
 317                                 struct bkey_format tmp = *f, *in = f, *out = &tmp;
 318
 319                                 swap(tmp.bits_per_field[BKEY_FIELD_INODE],
 320                                      tmp.bits_per_field[BKEY_FIELD_OFFSET]);
 321                                 swap(tmp.field_offset[BKEY_FIELD_INODE],
 322                                      tmp.field_offset[BKEY_FIELD_OFFSET]);
 323
 324                                 if (!write)
 325                                         swap(in, out);
 326
 327                                 uk = __bch2_bkey_unpack_key(in, k);
 328                                 swap(uk.p.inode, uk.p.offset);
 329                                 BUG_ON(!bch2_bkey_pack_key(k, &uk, out));
 330                         }
 331                 }
 332                 break;
 333         case 3:
 334                 if (!bkey_packed(k)) {
 335                         u = bkey_i_to_s(packed_to_bkey(k));
 336                 } else {
 337                         uk = __bch2_bkey_unpack_key(f, k);
 338                         u.k = &uk;
 339                         u.v = bkeyp_val(f, k);
 340                 }
 341
 342                 if (big_endian != CPU_BIG_ENDIAN)
 343                         bch2_bkey_swab_val(u);
 344
 345                 ops = &bch2_bkey_ops[k->type];
 346
 347                 if (ops->compat)
 348                         ops->compat(btree_id, version, big_endian, write, u);
 349                 break;
 350         default:
 351                 BUG();
 352         }
 353 }