lib/verity/verity_fec.c

   1 /*
   2  * dm-verity Forward Error Correction (FEC) support
   3  *
   4  * Copyright (C) 2015 Google, Inc. All rights reserved.
   5  * Copyright (C) 2017-2020 Red Hat, Inc. All rights reserved.
   6  *
   7  * This file is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This file is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this file; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #include <stdlib.h>
  23 #include <errno.h>
  24
  25 #include "verity.h"
  26 #include "internal.h"
  27 #include "rs.h"
  28
  29 /* ecc parameters */
  30 #define FEC_RSM 255
  31 #define FEC_MIN_RSN 231
  32 #define FEC_MAX_RSN 253
  33
  34 #define FEC_INPUT_DEVICES 2
  35
  36 /* parameters to init_rs_char */
  37 #define FEC_PARAMS(roots) \
  38     8,          /* symbol size in bits */ \
  39     0x11d,      /* field generator polynomial coefficients */ \
  40     0,          /* first root of the generator */ \
  41     1,          /* primitive element to generate polynomial roots */ \
  42     (roots),    /* polynomial degree (number of roots) */ \
  43     0           /* padding bytes at the front of shortened block */
  44
  45 struct fec_input_device {
  46         struct device *device;
  47         int fd;
  48         uint64_t start;
  49         uint64_t count;
  50 };
  51
  52 struct fec_context {
  53         uint32_t rsn;
  54         uint32_t roots;
  55         uint64_t size;
  56         uint64_t blocks;
  57         uint64_t rounds;
  58         uint32_t block_size;
  59         struct fec_input_device *inputs;
  60         size_t ninputs;
  61 };
  62
  63 /* computes ceil(x / y) */
  64 static inline uint64_t FEC_div_round_up(uint64_t x, uint64_t y)
  65 {
  66         return (x / y) + (x % y > 0 ? 1 : 0);
  67 }
  68
  69 /* returns a physical offset for the given RS offset */
  70 static inline uint64_t FEC_interleave(struct fec_context *ctx, uint64_t offset)
  71 {
  72         return (offset / ctx->rsn) +
  73                         (offset % ctx->rsn) * ctx->rounds * ctx->block_size;
  74 }
  75
  76 /* returns data for a byte at the specified RS offset */
  77 static int FEC_read_interleaved(struct fec_context *ctx, uint64_t i,
  78                                 void *output, size_t count)
  79 {
  80         size_t n;
  81         uint64_t offset = FEC_interleave(ctx, i);
  82
  83         /* offsets outside input area are assumed to contain zeros */
  84         if (offset >= ctx->size) {
  85                 memset(output, 0, count);
  86                 return 0;
  87         }
  88
  89         /* find the correct input device and read from it */
  90         for (n = 0; n < ctx->ninputs; ++n) {
  91                 if (offset >= ctx->inputs[n].count) {
  92                         offset -= ctx->inputs[n].count;
  93                         continue;
  94                 }
  95
  96                 /* FIXME: read_lseek_blockwise candidate */
  97                 if (lseek(ctx->inputs[n].fd, ctx->inputs[n].start + offset, SEEK_SET) < 0)
  98                         return -1;
  99                 return (read_buffer(ctx->inputs[n].fd, output, count) == (ssize_t)count) ? 0 : -1;
 100         }
 101
 102         /* should never be reached */
 103         return -1;
 104 }
 105
 106 /* encodes/decode inputs to/from fd */
 107 static int FEC_process_inputs(struct crypt_device *cd,
 108                               struct crypt_params_verity *params,
 109                               struct fec_input_device *inputs,
 110                               size_t ninputs, int fd,
 111                               int decode, unsigned int *errors)
 112 {
 113         int r = 0;
 114         unsigned int i;
 115         struct fec_context ctx;
 116         uint32_t b;
 117         uint64_t n;
 118         uint8_t rs_block[FEC_RSM];
 119         uint8_t *buf = NULL;
 120         void *rs;
 121
 122         /* initialize parameters */
 123         ctx.roots = params->fec_roots;
 124         ctx.rsn = FEC_RSM - ctx.roots;
 125         ctx.block_size = params->data_block_size;
 126         ctx.inputs = inputs;
 127         ctx.ninputs = ninputs;
 128
 129         rs = init_rs_char(FEC_PARAMS(ctx.roots));
 130         if (!rs) {
 131                 log_err(cd, _("Failed to allocate RS context."));
 132                 return -ENOMEM;
 133         }
 134
 135         /* calculate the total area covered by error correction codes */
 136         ctx.size = 0;
 137         for (n = 0; n < ctx.ninputs; ++n)
 138                 ctx.size += ctx.inputs[n].count;
 139
 140         /* each byte in a data block is covered by a different code */
 141         ctx.blocks = FEC_div_round_up(ctx.size, ctx.block_size);
 142         ctx.rounds = FEC_div_round_up(ctx.blocks, ctx.rsn);
 143
 144         buf = malloc((size_t)ctx.block_size * ctx.rsn);
 145         if (!buf) {
 146                 log_err(cd, _("Failed to allocate buffer."));
 147                 r = -ENOMEM;
 148                 goto out;
 149         }
 150
 151         /* encode/decode input */
 152         for (n = 0; n < ctx.rounds; ++n) {
 153                 for (i = 0; i < ctx.rsn; ++i) {
 154                         if (FEC_read_interleaved(&ctx, n * ctx.rsn * ctx.block_size + i,
 155                                                  &buf[i * ctx.block_size], ctx.block_size)) {
 156                                 log_err(cd, _("Failed to read RS block %" PRIu64 " byte %d."), n, i);
 157                                 r = -EIO;
 158                                 goto out;
 159                         }
 160                 }
 161
 162                 for (b = 0; b < ctx.block_size; ++b) {
 163                         for (i = 0; i < ctx.rsn; ++i)
 164                                 rs_block[i] = buf[i * ctx.block_size + b];
 165
 166                         /* decoding from parity device */
 167                         if (decode) {
 168                                 if (read_buffer(fd, &rs_block[ctx.rsn], ctx.roots) < 0) {
 169                                         log_err(cd, _("Failed to read parity for RS block %" PRIu64 "."), n);
 170                                         r = -EIO;
 171                                         goto out;
 172                                 }
 173
 174                                 /* coverity[tainted_data] */
 175                                 r = decode_rs_char(rs, rs_block);
 176                                 if (r < 0) {
 177                                         log_err(cd, _("Failed to repair parity for block %" PRIu64 "."), n);
 178                                         goto out;
 179                                 }
 180                                 /* return number of detected errors */
 181                                 if (errors)
 182                                         *errors += r;
 183                                 r = 0;
 184                         } else {
 185                                 /* encoding and writing parity data to fec device */
 186                                 encode_rs_char(rs, rs_block, &rs_block[ctx.rsn]);
 187                                 if (write_buffer(fd, &rs_block[ctx.rsn], ctx.roots) < 0) {
 188                                         log_err(cd, _("Failed to write parity for RS block %" PRIu64 "."), n);
 189                                         r = -EIO;
 190                                         goto out;
 191                                 }
 192                         }
 193                 }
 194         }
 195 out:
 196         free_rs_char(rs);
 197         free(buf);
 198         return r;
 199 }
 200
 201 int VERITY_FEC_process(struct crypt_device *cd,
 202                       struct crypt_params_verity *params,
 203                       struct device *fec_device, int check_fec,
 204                       unsigned int *errors)
 205 {
 206         int r;
 207         int fd = -1;
 208         struct fec_input_device inputs[FEC_INPUT_DEVICES] = {
 209                 {
 210                         .device = crypt_data_device(cd),
 211                         .fd = -1,
 212                         .start = 0,
 213                         .count =  params->data_size * params->data_block_size
 214                 },{
 215                         .device = crypt_metadata_device(cd),
 216                         .fd = -1,
 217                         .start = VERITY_hash_offset_block(params) * params->data_block_size
 218                 }
 219         };
 220
 221         /* validate parameters */
 222         if (params->data_block_size != params->hash_block_size) {
 223                 log_err(cd, _("Block sizes must match for FEC."));
 224                 return -EINVAL;
 225         }
 226
 227         if (params->fec_roots > FEC_RSM - FEC_MIN_RSN ||
 228                 params->fec_roots < FEC_RSM - FEC_MAX_RSN) {
 229                 log_err(cd, _("Invalid number of parity bytes."));
 230                 return -EINVAL;
 231         }
 232
 233         r = -EIO;
 234
 235         if (check_fec)
 236                 fd = open(device_path(fec_device), O_RDONLY);
 237         else
 238                 fd = open(device_path(fec_device), O_RDWR);
 239
 240         if (fd == -1) {
 241                 log_err(cd, _("Cannot open device %s."), device_path(fec_device));
 242                 goto out;
 243         }
 244
 245         if (lseek(fd, params->fec_area_offset, SEEK_SET) < 0) {
 246                 log_dbg(cd, "Cannot seek to requested position in FEC device.");
 247                 goto out;
 248         }
 249
 250         /* input devices */
 251         inputs[0].fd = open(device_path(inputs[0].device), O_RDONLY);
 252         if (inputs[0].fd == -1) {
 253                 log_err(cd, _("Cannot open device %s."), device_path(inputs[0].device));
 254                 goto out;
 255         }
 256         inputs[1].fd = open(device_path(inputs[1].device), O_RDONLY);
 257         if (inputs[1].fd == -1) {
 258                 log_err(cd, _("Cannot open device %s."), device_path(inputs[1].device));
 259                 goto out;
 260         }
 261
 262         /* cover the entire hash device starting from hash_offset */
 263         r = device_size(inputs[1].device, &inputs[1].count);
 264         if (r) {
 265                 log_err(cd, _("Failed to determine size for device %s."),
 266                                 device_path(inputs[1].device));
 267                 goto out;
 268         }
 269         inputs[1].count -= inputs[1].start;
 270
 271         r = FEC_process_inputs(cd, params, inputs, FEC_INPUT_DEVICES, fd, check_fec, errors);
 272 out:
 273         if (inputs[0].fd != -1)
 274                 close(inputs[0].fd);
 275         if (inputs[1].fd != -1)
 276                 close(inputs[1].fd);
 277         if (fd != -1)
 278                 close(fd);
 279
 280         return r;
 281 }