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

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _BCACHEFS_CHECKSUM_H
   3 #define _BCACHEFS_CHECKSUM_H
   4
   5 #include "bcachefs.h"
   6 #include "extents_types.h"
   7 #include "super-io.h"
   8
   9 #include <linux/crc64.h>
  10 #include <crypto/chacha.h>
  11
  12 static inline bool bch2_checksum_mergeable(unsigned type)
  13 {
  14
  15         switch (type) {
  16         case BCH_CSUM_NONE:
  17         case BCH_CSUM_CRC32C:
  18         case BCH_CSUM_CRC64:
  19                 return true;
  20         default:
  21                 return false;
  22         }
  23 }
  24
  25 struct bch_csum bch2_checksum_merge(unsigned, struct bch_csum,
  26                                     struct bch_csum, size_t);
  27
  28 #define BCH_NONCE_EXTENT        cpu_to_le32(1 << 28)
  29 #define BCH_NONCE_BTREE         cpu_to_le32(2 << 28)
  30 #define BCH_NONCE_JOURNAL       cpu_to_le32(3 << 28)
  31 #define BCH_NONCE_PRIO          cpu_to_le32(4 << 28)
  32 #define BCH_NONCE_POLY          cpu_to_le32(1 << 31)
  33
  34 struct bch_csum bch2_checksum(struct bch_fs *, unsigned, struct nonce,
  35                              const void *, size_t);
  36
  37 /*
  38  * This is used for various on disk data structures - bch_sb, prio_set, bset,
  39  * jset: The checksum is _always_ the first field of these structs
  40  */
  41 #define csum_vstruct(_c, _type, _nonce, _i)                             \
  42 ({                                                                      \
  43         const void *start = ((const void *) (_i)) + sizeof((_i)->csum); \
  44         const void *end = vstruct_end(_i);                              \
  45                                                                         \
  46         bch2_checksum(_c, _type, _nonce, start, end - start);           \
  47 })
  48
  49 int bch2_chacha_encrypt_key(struct bch_key *, struct nonce, void *, size_t);
  50 int bch2_request_key(struct bch_sb *, struct bch_key *);
  51
  52 void bch2_encrypt(struct bch_fs *, unsigned, struct nonce,
  53                  void *data, size_t);
  54
  55 struct bch_csum bch2_checksum_bio(struct bch_fs *, unsigned,
  56                                   struct nonce, struct bio *);
  57
  58 int bch2_rechecksum_bio(struct bch_fs *, struct bio *, struct bversion,
  59                         struct bch_extent_crc_unpacked,
  60                         struct bch_extent_crc_unpacked *,
  61                         struct bch_extent_crc_unpacked *,
  62                         unsigned, unsigned, unsigned);
  63
  64 void bch2_encrypt_bio(struct bch_fs *, unsigned,
  65                     struct nonce, struct bio *);
  66
  67 int bch2_decrypt_sb_key(struct bch_fs *, struct bch_sb_field_crypt *,
  68                         struct bch_key *);
  69
  70 int bch2_disable_encryption(struct bch_fs *);
  71 int bch2_enable_encryption(struct bch_fs *, bool);
  72
  73 void bch2_fs_encryption_exit(struct bch_fs *);
  74 int bch2_fs_encryption_init(struct bch_fs *);
  75
  76 static inline enum bch_csum_type bch2_csum_opt_to_type(enum bch_csum_opts type,
  77                                                        bool data)
  78 {
  79         switch (type) {
  80         case BCH_CSUM_OPT_NONE:
  81              return BCH_CSUM_NONE;
  82         case BCH_CSUM_OPT_CRC32C:
  83              return data ? BCH_CSUM_CRC32C : BCH_CSUM_CRC32C_NONZERO;
  84         case BCH_CSUM_OPT_CRC64:
  85              return data ? BCH_CSUM_CRC64 : BCH_CSUM_CRC64_NONZERO;
  86         default:
  87              BUG();
  88         }
  89 }
  90
  91 static inline enum bch_csum_type bch2_data_checksum_type(struct bch_fs *c,
  92                                                          unsigned opt)
  93 {
  94         if (c->sb.encryption_type)
  95                 return c->opts.wide_macs
  96                         ? BCH_CSUM_CHACHA20_POLY1305_128
  97                         : BCH_CSUM_CHACHA20_POLY1305_80;
  98
  99         return bch2_csum_opt_to_type(opt, true);
 100 }
 101
 102 static inline enum bch_csum_type bch2_meta_checksum_type(struct bch_fs *c)
 103 {
 104         if (c->sb.encryption_type)
 105                 return BCH_CSUM_CHACHA20_POLY1305_128;
 106
 107         return bch2_csum_opt_to_type(c->opts.metadata_checksum, false);
 108 }
 109
 110 static const unsigned bch2_compression_opt_to_type[] = {
 111 #define x(t, n) [BCH_COMPRESSION_OPT_##t] = BCH_COMPRESSION_TYPE_##t,
 112         BCH_COMPRESSION_OPTS()
 113 #undef x
 114 };
 115
 116 static inline bool bch2_checksum_type_valid(const struct bch_fs *c,
 117                                            unsigned type)
 118 {
 119         if (type >= BCH_CSUM_NR)
 120                 return false;
 121
 122         if (bch2_csum_type_is_encryption(type) && !c->chacha20)
 123                 return false;
 124
 125         return true;
 126 }
 127
 128 /* returns true if not equal */
 129 static inline bool bch2_crc_cmp(struct bch_csum l, struct bch_csum r)
 130 {
 131         /*
 132          * XXX: need some way of preventing the compiler from optimizing this
 133          * into a form that isn't constant time..
 134          */
 135         return ((l.lo ^ r.lo) | (l.hi ^ r.hi)) != 0;
 136 }
 137
 138 /* for skipping ahead and encrypting/decrypting at an offset: */
 139 static inline struct nonce nonce_add(struct nonce nonce, unsigned offset)
 140 {
 141         EBUG_ON(offset & (CHACHA_BLOCK_SIZE - 1));
 142
 143         le32_add_cpu(&nonce.d[0], offset / CHACHA_BLOCK_SIZE);
 144         return nonce;
 145 }
 146
 147 static inline struct nonce null_nonce(void)
 148 {
 149         struct nonce ret;
 150
 151         memset(&ret, 0, sizeof(ret));
 152         return ret;
 153 }
 154
 155 static inline struct nonce extent_nonce(struct bversion version,
 156                                         struct bch_extent_crc_unpacked crc)
 157 {
 158         unsigned compression_type = crc_is_compressed(crc)
 159                 ? crc.compression_type
 160                 : 0;
 161         unsigned size = compression_type ? crc.uncompressed_size : 0;
 162         struct nonce nonce = (struct nonce) {{
 163                 [0] = cpu_to_le32(size << 22),
 164                 [1] = cpu_to_le32(version.lo),
 165                 [2] = cpu_to_le32(version.lo >> 32),
 166                 [3] = cpu_to_le32(version.hi|
 167                                   (compression_type << 24))^BCH_NONCE_EXTENT,
 168         }};
 169
 170         return nonce_add(nonce, crc.nonce << 9);
 171 }
 172
 173 static inline bool bch2_key_is_encrypted(struct bch_encrypted_key *key)
 174 {
 175         return le64_to_cpu(key->magic) != BCH_KEY_MAGIC;
 176 }
 177
 178 static inline struct nonce __bch2_sb_key_nonce(struct bch_sb *sb)
 179 {
 180         __le64 magic = __bch2_sb_magic(sb);
 181
 182         return (struct nonce) {{
 183                 [0] = 0,
 184                 [1] = 0,
 185                 [2] = ((__le32 *) &magic)[0],
 186                 [3] = ((__le32 *) &magic)[1],
 187         }};
 188 }
 189
 190 static inline struct nonce bch2_sb_key_nonce(struct bch_fs *c)
 191 {
 192         __le64 magic = bch2_sb_magic(c);
 193
 194         return (struct nonce) {{
 195                 [0] = 0,
 196                 [1] = 0,
 197                 [2] = ((__le32 *) &magic)[0],
 198                 [3] = ((__le32 *) &magic)[1],
 199         }};
 200 }
 201
 202 #endif /* _BCACHEFS_CHECKSUM_H */