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