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 int 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 int __bch2_encrypt_bio(struct bch_fs *, unsigned,
  65                        struct nonce, struct bio *);
  66
  67 static inline int bch2_encrypt_bio(struct bch_fs *c, unsigned type,
  68                                    struct nonce nonce, struct bio *bio)
  69 {
  70         return bch2_csum_type_is_encryption(type)
  71                 ? __bch2_encrypt_bio(c, type, nonce, bio)
  72                 : 0;
  73 }
  74
  75 int bch2_decrypt_sb_key(struct bch_fs *, struct bch_sb_field_crypt *,
  76                         struct bch_key *);
  77
  78 int bch2_disable_encryption(struct bch_fs *);
  79 int bch2_enable_encryption(struct bch_fs *, bool);
  80
  81 void bch2_fs_encryption_exit(struct bch_fs *);
  82 int bch2_fs_encryption_init(struct bch_fs *);
  83
  84 static inline enum bch_csum_type bch2_csum_opt_to_type(enum bch_csum_opts type,
  85                                                        bool data)
  86 {
  87         switch (type) {
  88         case BCH_CSUM_OPT_none:
  89                 return BCH_CSUM_none;
  90         case BCH_CSUM_OPT_crc32c:
  91                 return data ? BCH_CSUM_crc32c : BCH_CSUM_crc32c_nonzero;
  92         case BCH_CSUM_OPT_crc64:
  93                 return data ? BCH_CSUM_crc64 : BCH_CSUM_crc64_nonzero;
  94         case BCH_CSUM_OPT_xxhash:
  95                 return BCH_CSUM_xxhash;
  96         default:
  97                 BUG();
  98         }
  99 }
 100
 101 static inline enum bch_csum_type bch2_data_checksum_type(struct bch_fs *c,
 102                                                          struct bch_io_opts opts)
 103 {
 104         if (opts.nocow)
 105                 return 0;
 106
 107         if (c->sb.encryption_type)
 108                 return c->opts.wide_macs
 109                         ? BCH_CSUM_chacha20_poly1305_128
 110                         : BCH_CSUM_chacha20_poly1305_80;
 111
 112         return bch2_csum_opt_to_type(opts.data_checksum, true);
 113 }
 114
 115 static inline enum bch_csum_type bch2_meta_checksum_type(struct bch_fs *c)
 116 {
 117         if (c->sb.encryption_type)
 118                 return BCH_CSUM_chacha20_poly1305_128;
 119
 120         return bch2_csum_opt_to_type(c->opts.metadata_checksum, false);
 121 }
 122
 123 static const unsigned bch2_compression_opt_to_type[] = {
 124 #define x(t, n) [BCH_COMPRESSION_OPT_##t] = BCH_COMPRESSION_TYPE_##t,
 125         BCH_COMPRESSION_OPTS()
 126 #undef x
 127 };
 128
 129 static inline bool bch2_checksum_type_valid(const struct bch_fs *c,
 130                                            unsigned type)
 131 {
 132         if (type >= BCH_CSUM_NR)
 133                 return false;
 134
 135         if (bch2_csum_type_is_encryption(type) && !c->chacha20)
 136                 return false;
 137
 138         return true;
 139 }
 140
 141 /* returns true if not equal */
 142 static inline bool bch2_crc_cmp(struct bch_csum l, struct bch_csum r)
 143 {
 144         /*
 145          * XXX: need some way of preventing the compiler from optimizing this
 146          * into a form that isn't constant time..
 147          */
 148         return ((l.lo ^ r.lo) | (l.hi ^ r.hi)) != 0;
 149 }
 150
 151 /* for skipping ahead and encrypting/decrypting at an offset: */
 152 static inline struct nonce nonce_add(struct nonce nonce, unsigned offset)
 153 {
 154         EBUG_ON(offset & (CHACHA_BLOCK_SIZE - 1));
 155
 156         le32_add_cpu(&nonce.d[0], offset / CHACHA_BLOCK_SIZE);
 157         return nonce;
 158 }
 159
 160 static inline struct nonce null_nonce(void)
 161 {
 162         struct nonce ret;
 163
 164         memset(&ret, 0, sizeof(ret));
 165         return ret;
 166 }
 167
 168 static inline struct nonce extent_nonce(struct bversion version,
 169                                         struct bch_extent_crc_unpacked crc)
 170 {
 171         unsigned compression_type = crc_is_compressed(crc)
 172                 ? crc.compression_type
 173                 : 0;
 174         unsigned size = compression_type ? crc.uncompressed_size : 0;
 175         struct nonce nonce = (struct nonce) {{
 176                 [0] = cpu_to_le32(size << 22),
 177                 [1] = cpu_to_le32(version.lo),
 178                 [2] = cpu_to_le32(version.lo >> 32),
 179                 [3] = cpu_to_le32(version.hi|
 180                                   (compression_type << 24))^BCH_NONCE_EXTENT,
 181         }};
 182
 183         return nonce_add(nonce, crc.nonce << 9);
 184 }
 185
 186 static inline bool bch2_key_is_encrypted(struct bch_encrypted_key *key)
 187 {
 188         return le64_to_cpu(key->magic) != BCH_KEY_MAGIC;
 189 }
 190
 191 static inline struct nonce __bch2_sb_key_nonce(struct bch_sb *sb)
 192 {
 193         __le64 magic = __bch2_sb_magic(sb);
 194
 195         return (struct nonce) {{
 196                 [0] = 0,
 197                 [1] = 0,
 198                 [2] = ((__le32 *) &magic)[0],
 199                 [3] = ((__le32 *) &magic)[1],
 200         }};
 201 }
 202
 203 static inline struct nonce bch2_sb_key_nonce(struct bch_fs *c)
 204 {
 205         __le64 magic = bch2_sb_magic(c);
 206
 207         return (struct nonce) {{
 208                 [0] = 0,
 209                 [1] = 0,
 210                 [2] = ((__le32 *) &magic)[0],
 211                 [3] = ((__le32 *) &magic)[1],
 212         }};
 213 }
 214
 215 #endif /* _BCACHEFS_CHECKSUM_H */