dm-verity-fec.c 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * Copyright (C) 2015 Google, Inc.
  4. *
  5. * Author: Sami Tolvanen <samitolvanen@google.com>
  6. */
  7. #include "dm-verity-fec.h"
  8. #include <linux/math64.h>
  9. #define DM_MSG_PREFIX "verity-fec"
  10. /*
  11. * If error correction has been configured, returns true.
  12. */
  13. bool verity_fec_is_enabled(struct dm_verity *v)
  14. {
  15. return v->fec && v->fec->dev;
  16. }
  17. /*
  18. * Return a pointer to dm_verity_fec_io after dm_verity_io and its variable
  19. * length fields.
  20. */
  21. static inline struct dm_verity_fec_io *fec_io(struct dm_verity_io *io)
  22. {
  23. return (struct dm_verity_fec_io *)
  24. ((char *)io + io->v->ti->per_io_data_size - sizeof(struct dm_verity_fec_io));
  25. }
  26. /*
  27. * Return an interleaved offset for a byte in RS block.
  28. */
  29. static inline u64 fec_interleave(struct dm_verity *v, u64 offset)
  30. {
  31. u32 mod;
  32. mod = do_div(offset, v->fec->rsn);
  33. return offset + mod * (v->fec->rounds << v->data_dev_block_bits);
  34. }
  35. /*
  36. * Decode an RS block using Reed-Solomon.
  37. */
  38. static int fec_decode_rs8(struct dm_verity *v, struct dm_verity_fec_io *fio,
  39. u8 *data, u8 *fec, int neras)
  40. {
  41. int i;
  42. uint16_t par[DM_VERITY_FEC_RSM - DM_VERITY_FEC_MIN_RSN];
  43. for (i = 0; i < v->fec->roots; i++)
  44. par[i] = fec[i];
  45. return decode_rs8(fio->rs, data, par, v->fec->rsn, NULL, neras,
  46. fio->erasures, 0, NULL);
  47. }
  48. /*
  49. * Read error-correcting codes for the requested RS block. Returns a pointer
  50. * to the data block. Caller is responsible for releasing buf.
  51. */
  52. static u8 *fec_read_parity(struct dm_verity *v, u64 rsb, int index,
  53. unsigned int *offset, unsigned int par_buf_offset,
  54. struct dm_buffer **buf, unsigned short ioprio)
  55. {
  56. u64 position, block, rem;
  57. u8 *res;
  58. /* We have already part of parity bytes read, skip to the next block */
  59. if (par_buf_offset)
  60. index++;
  61. position = (index + rsb) * v->fec->roots;
  62. block = div64_u64_rem(position, v->fec->io_size, &rem);
  63. *offset = par_buf_offset ? 0 : (unsigned int)rem;
  64. res = dm_bufio_read_with_ioprio(v->fec->bufio, block, buf, ioprio);
  65. if (IS_ERR(res)) {
  66. DMERR("%s: FEC %llu: parity read failed (block %llu): %ld",
  67. v->data_dev->name, (unsigned long long)rsb,
  68. (unsigned long long)block, PTR_ERR(res));
  69. *buf = NULL;
  70. }
  71. return res;
  72. }
  73. /* Loop over each preallocated buffer slot. */
  74. #define fec_for_each_prealloc_buffer(__i) \
  75. for (__i = 0; __i < DM_VERITY_FEC_BUF_PREALLOC; __i++)
  76. /* Loop over each extra buffer slot. */
  77. #define fec_for_each_extra_buffer(io, __i) \
  78. for (__i = DM_VERITY_FEC_BUF_PREALLOC; __i < DM_VERITY_FEC_BUF_MAX; __i++)
  79. /* Loop over each allocated buffer. */
  80. #define fec_for_each_buffer(io, __i) \
  81. for (__i = 0; __i < (io)->nbufs; __i++)
  82. /* Loop over each RS block in each allocated buffer. */
  83. #define fec_for_each_buffer_rs_block(io, __i, __j) \
  84. fec_for_each_buffer(io, __i) \
  85. for (__j = 0; __j < 1 << DM_VERITY_FEC_BUF_RS_BITS; __j++)
  86. /*
  87. * Return a pointer to the current RS block when called inside
  88. * fec_for_each_buffer_rs_block.
  89. */
  90. static inline u8 *fec_buffer_rs_block(struct dm_verity *v,
  91. struct dm_verity_fec_io *fio,
  92. unsigned int i, unsigned int j)
  93. {
  94. return &fio->bufs[i][j * v->fec->rsn];
  95. }
  96. /*
  97. * Return an index to the current RS block when called inside
  98. * fec_for_each_buffer_rs_block.
  99. */
  100. static inline unsigned int fec_buffer_rs_index(unsigned int i, unsigned int j)
  101. {
  102. return (i << DM_VERITY_FEC_BUF_RS_BITS) + j;
  103. }
  104. /*
  105. * Decode all RS blocks from buffers and copy corrected bytes into fio->output
  106. * starting from block_offset.
  107. */
  108. static int fec_decode_bufs(struct dm_verity *v, struct dm_verity_io *io,
  109. struct dm_verity_fec_io *fio, u64 rsb, int byte_index,
  110. unsigned int block_offset, int neras)
  111. {
  112. int r, corrected = 0, res;
  113. struct dm_buffer *buf;
  114. unsigned int n, i, offset, par_buf_offset = 0;
  115. u8 *par, *block, par_buf[DM_VERITY_FEC_RSM - DM_VERITY_FEC_MIN_RSN];
  116. struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
  117. par = fec_read_parity(v, rsb, block_offset, &offset,
  118. par_buf_offset, &buf, bio_prio(bio));
  119. if (IS_ERR(par))
  120. return PTR_ERR(par);
  121. /*
  122. * Decode the RS blocks we have in bufs. Each RS block results in
  123. * one corrected target byte and consumes fec->roots parity bytes.
  124. */
  125. fec_for_each_buffer_rs_block(fio, n, i) {
  126. block = fec_buffer_rs_block(v, fio, n, i);
  127. memcpy(&par_buf[par_buf_offset], &par[offset], v->fec->roots - par_buf_offset);
  128. res = fec_decode_rs8(v, fio, block, par_buf, neras);
  129. if (res < 0) {
  130. r = res;
  131. goto error;
  132. }
  133. corrected += res;
  134. fio->output[block_offset] = block[byte_index];
  135. block_offset++;
  136. if (block_offset >= 1 << v->data_dev_block_bits)
  137. goto done;
  138. /* Read the next block when we run out of parity bytes */
  139. offset += (v->fec->roots - par_buf_offset);
  140. /* Check if parity bytes are split between blocks */
  141. if (offset < v->fec->io_size && (offset + v->fec->roots) > v->fec->io_size) {
  142. par_buf_offset = v->fec->io_size - offset;
  143. memcpy(par_buf, &par[offset], par_buf_offset);
  144. offset += par_buf_offset;
  145. } else
  146. par_buf_offset = 0;
  147. if (offset >= v->fec->io_size) {
  148. dm_bufio_release(buf);
  149. par = fec_read_parity(v, rsb, block_offset, &offset,
  150. par_buf_offset, &buf, bio_prio(bio));
  151. if (IS_ERR(par))
  152. return PTR_ERR(par);
  153. }
  154. }
  155. done:
  156. r = corrected;
  157. error:
  158. dm_bufio_release(buf);
  159. if (r < 0 && neras)
  160. DMERR_LIMIT("%s: FEC %llu: failed to correct: %d",
  161. v->data_dev->name, (unsigned long long)rsb, r);
  162. else if (r > 0)
  163. DMWARN_LIMIT("%s: FEC %llu: corrected %d errors",
  164. v->data_dev->name, (unsigned long long)rsb, r);
  165. return r;
  166. }
  167. /*
  168. * Locate data block erasures using verity hashes.
  169. */
  170. static int fec_is_erasure(struct dm_verity *v, struct dm_verity_io *io,
  171. u8 *want_digest, u8 *data)
  172. {
  173. if (unlikely(verity_hash(v, io, data, 1 << v->data_dev_block_bits,
  174. verity_io_real_digest(v, io), true)))
  175. return 0;
  176. return memcmp(verity_io_real_digest(v, io), want_digest,
  177. v->digest_size) != 0;
  178. }
  179. /*
  180. * Read data blocks that are part of the RS block and deinterleave as much as
  181. * fits into buffers. Check for erasure locations if @neras is non-NULL.
  182. */
  183. static int fec_read_bufs(struct dm_verity *v, struct dm_verity_io *io,
  184. u64 rsb, u64 target, unsigned int block_offset,
  185. int *neras)
  186. {
  187. bool is_zero;
  188. int i, j, target_index = -1;
  189. struct dm_buffer *buf;
  190. struct dm_bufio_client *bufio;
  191. struct dm_verity_fec_io *fio = fec_io(io);
  192. u64 block, ileaved;
  193. u8 *bbuf, *rs_block;
  194. u8 want_digest[HASH_MAX_DIGESTSIZE];
  195. unsigned int n, k;
  196. struct bio *bio = dm_bio_from_per_bio_data(io, v->ti->per_io_data_size);
  197. if (neras)
  198. *neras = 0;
  199. if (WARN_ON(v->digest_size > sizeof(want_digest)))
  200. return -EINVAL;
  201. /*
  202. * read each of the rsn data blocks that are part of the RS block, and
  203. * interleave contents to available bufs
  204. */
  205. for (i = 0; i < v->fec->rsn; i++) {
  206. ileaved = fec_interleave(v, rsb * v->fec->rsn + i);
  207. /*
  208. * target is the data block we want to correct, target_index is
  209. * the index of this block within the rsn RS blocks
  210. */
  211. if (ileaved == target)
  212. target_index = i;
  213. block = ileaved >> v->data_dev_block_bits;
  214. bufio = v->fec->data_bufio;
  215. if (block >= v->data_blocks) {
  216. block -= v->data_blocks;
  217. /*
  218. * blocks outside the area were assumed to contain
  219. * zeros when encoding data was generated
  220. */
  221. if (unlikely(block >= v->fec->hash_blocks))
  222. continue;
  223. block += v->hash_start;
  224. bufio = v->bufio;
  225. }
  226. bbuf = dm_bufio_read_with_ioprio(bufio, block, &buf, bio_prio(bio));
  227. if (IS_ERR(bbuf)) {
  228. DMWARN_LIMIT("%s: FEC %llu: read failed (%llu): %ld",
  229. v->data_dev->name,
  230. (unsigned long long)rsb,
  231. (unsigned long long)block, PTR_ERR(bbuf));
  232. /* assume the block is corrupted */
  233. if (neras && *neras <= v->fec->roots)
  234. fio->erasures[(*neras)++] = i;
  235. continue;
  236. }
  237. /* locate erasures if the block is on the data device */
  238. if (bufio == v->fec->data_bufio &&
  239. verity_hash_for_block(v, io, block, want_digest,
  240. &is_zero) == 0) {
  241. /* skip known zero blocks entirely */
  242. if (is_zero)
  243. goto done;
  244. /*
  245. * skip if we have already found the theoretical
  246. * maximum number (i.e. fec->roots) of erasures
  247. */
  248. if (neras && *neras <= v->fec->roots &&
  249. fec_is_erasure(v, io, want_digest, bbuf))
  250. fio->erasures[(*neras)++] = i;
  251. }
  252. /*
  253. * deinterleave and copy the bytes that fit into bufs,
  254. * starting from block_offset
  255. */
  256. fec_for_each_buffer_rs_block(fio, n, j) {
  257. k = fec_buffer_rs_index(n, j) + block_offset;
  258. if (k >= 1 << v->data_dev_block_bits)
  259. goto done;
  260. rs_block = fec_buffer_rs_block(v, fio, n, j);
  261. rs_block[i] = bbuf[k];
  262. }
  263. done:
  264. dm_bufio_release(buf);
  265. }
  266. return target_index;
  267. }
  268. /*
  269. * Allocate RS control structure and FEC buffers from preallocated mempools,
  270. * and attempt to allocate as many extra buffers as available.
  271. */
  272. static int fec_alloc_bufs(struct dm_verity *v, struct dm_verity_fec_io *fio)
  273. {
  274. unsigned int n;
  275. if (!fio->rs)
  276. fio->rs = mempool_alloc(&v->fec->rs_pool, GFP_NOIO);
  277. fec_for_each_prealloc_buffer(n) {
  278. if (fio->bufs[n])
  279. continue;
  280. fio->bufs[n] = mempool_alloc(&v->fec->prealloc_pool, GFP_NOWAIT);
  281. if (unlikely(!fio->bufs[n])) {
  282. DMERR("failed to allocate FEC buffer");
  283. return -ENOMEM;
  284. }
  285. }
  286. /* try to allocate the maximum number of buffers */
  287. fec_for_each_extra_buffer(fio, n) {
  288. if (fio->bufs[n])
  289. continue;
  290. fio->bufs[n] = mempool_alloc(&v->fec->extra_pool, GFP_NOWAIT);
  291. /* we can manage with even one buffer if necessary */
  292. if (unlikely(!fio->bufs[n]))
  293. break;
  294. }
  295. fio->nbufs = n;
  296. if (!fio->output)
  297. fio->output = mempool_alloc(&v->fec->output_pool, GFP_NOIO);
  298. return 0;
  299. }
  300. /*
  301. * Initialize buffers and clear erasures. fec_read_bufs() assumes buffers are
  302. * zeroed before deinterleaving.
  303. */
  304. static void fec_init_bufs(struct dm_verity *v, struct dm_verity_fec_io *fio)
  305. {
  306. unsigned int n;
  307. fec_for_each_buffer(fio, n)
  308. memset(fio->bufs[n], 0, v->fec->rsn << DM_VERITY_FEC_BUF_RS_BITS);
  309. memset(fio->erasures, 0, sizeof(fio->erasures));
  310. }
  311. /*
  312. * Decode all RS blocks in a single data block and return the target block
  313. * (indicated by @offset) in fio->output. If @use_erasures is non-zero, uses
  314. * hashes to locate erasures.
  315. */
  316. static int fec_decode_rsb(struct dm_verity *v, struct dm_verity_io *io,
  317. struct dm_verity_fec_io *fio, u64 rsb, u64 offset,
  318. bool use_erasures)
  319. {
  320. int r, neras = 0;
  321. unsigned int pos;
  322. r = fec_alloc_bufs(v, fio);
  323. if (unlikely(r < 0))
  324. return r;
  325. for (pos = 0; pos < 1 << v->data_dev_block_bits; ) {
  326. fec_init_bufs(v, fio);
  327. r = fec_read_bufs(v, io, rsb, offset, pos,
  328. use_erasures ? &neras : NULL);
  329. if (unlikely(r < 0))
  330. return r;
  331. r = fec_decode_bufs(v, io, fio, rsb, r, pos, neras);
  332. if (r < 0)
  333. return r;
  334. pos += fio->nbufs << DM_VERITY_FEC_BUF_RS_BITS;
  335. }
  336. /* Always re-validate the corrected block against the expected hash */
  337. r = verity_hash(v, io, fio->output, 1 << v->data_dev_block_bits,
  338. verity_io_real_digest(v, io), true);
  339. if (unlikely(r < 0))
  340. return r;
  341. if (memcmp(verity_io_real_digest(v, io), verity_io_want_digest(v, io),
  342. v->digest_size)) {
  343. DMERR_LIMIT("%s: FEC %llu: failed to correct (%d erasures)",
  344. v->data_dev->name, (unsigned long long)rsb, neras);
  345. return -EILSEQ;
  346. }
  347. return 0;
  348. }
  349. /* Correct errors in a block. Copies corrected block to dest. */
  350. int verity_fec_decode(struct dm_verity *v, struct dm_verity_io *io,
  351. enum verity_block_type type, sector_t block, u8 *dest)
  352. {
  353. int r;
  354. struct dm_verity_fec_io *fio = fec_io(io);
  355. u64 offset, res, rsb;
  356. if (!verity_fec_is_enabled(v))
  357. return -EOPNOTSUPP;
  358. if (fio->level >= DM_VERITY_FEC_MAX_RECURSION) {
  359. DMWARN_LIMIT("%s: FEC: recursion too deep", v->data_dev->name);
  360. return -EIO;
  361. }
  362. fio->level++;
  363. if (type == DM_VERITY_BLOCK_TYPE_METADATA)
  364. block = block - v->hash_start + v->data_blocks;
  365. /*
  366. * For RS(M, N), the continuous FEC data is divided into blocks of N
  367. * bytes. Since block size may not be divisible by N, the last block
  368. * is zero padded when decoding.
  369. *
  370. * Each byte of the block is covered by a different RS(M, N) code,
  371. * and each code is interleaved over N blocks to make it less likely
  372. * that bursty corruption will leave us in unrecoverable state.
  373. */
  374. offset = block << v->data_dev_block_bits;
  375. res = div64_u64(offset, v->fec->rounds << v->data_dev_block_bits);
  376. /*
  377. * The base RS block we can feed to the interleaver to find out all
  378. * blocks required for decoding.
  379. */
  380. rsb = offset - res * (v->fec->rounds << v->data_dev_block_bits);
  381. /*
  382. * Locating erasures is slow, so attempt to recover the block without
  383. * them first. Do a second attempt with erasures if the corruption is
  384. * bad enough.
  385. */
  386. r = fec_decode_rsb(v, io, fio, rsb, offset, false);
  387. if (r < 0) {
  388. r = fec_decode_rsb(v, io, fio, rsb, offset, true);
  389. if (r < 0)
  390. goto done;
  391. }
  392. memcpy(dest, fio->output, 1 << v->data_dev_block_bits);
  393. done:
  394. fio->level--;
  395. return r;
  396. }
  397. /*
  398. * Clean up per-bio data.
  399. */
  400. void verity_fec_finish_io(struct dm_verity_io *io)
  401. {
  402. unsigned int n;
  403. struct dm_verity_fec *f = io->v->fec;
  404. struct dm_verity_fec_io *fio = fec_io(io);
  405. if (!verity_fec_is_enabled(io->v))
  406. return;
  407. mempool_free(fio->rs, &f->rs_pool);
  408. fec_for_each_prealloc_buffer(n)
  409. mempool_free(fio->bufs[n], &f->prealloc_pool);
  410. fec_for_each_extra_buffer(fio, n)
  411. mempool_free(fio->bufs[n], &f->extra_pool);
  412. mempool_free(fio->output, &f->output_pool);
  413. }
  414. /*
  415. * Initialize per-bio data.
  416. */
  417. void verity_fec_init_io(struct dm_verity_io *io)
  418. {
  419. struct dm_verity_fec_io *fio = fec_io(io);
  420. if (!verity_fec_is_enabled(io->v))
  421. return;
  422. fio->rs = NULL;
  423. memset(fio->bufs, 0, sizeof(fio->bufs));
  424. fio->nbufs = 0;
  425. fio->output = NULL;
  426. fio->level = 0;
  427. }
  428. /*
  429. * Append feature arguments and values to the status table.
  430. */
  431. unsigned int verity_fec_status_table(struct dm_verity *v, unsigned int sz,
  432. char *result, unsigned int maxlen)
  433. {
  434. if (!verity_fec_is_enabled(v))
  435. return sz;
  436. DMEMIT(" " DM_VERITY_OPT_FEC_DEV " %s "
  437. DM_VERITY_OPT_FEC_BLOCKS " %llu "
  438. DM_VERITY_OPT_FEC_START " %llu "
  439. DM_VERITY_OPT_FEC_ROOTS " %d",
  440. v->fec->dev->name,
  441. (unsigned long long)v->fec->blocks,
  442. (unsigned long long)v->fec->start,
  443. v->fec->roots);
  444. return sz;
  445. }
  446. void verity_fec_dtr(struct dm_verity *v)
  447. {
  448. struct dm_verity_fec *f = v->fec;
  449. if (!verity_fec_is_enabled(v))
  450. goto out;
  451. mempool_exit(&f->rs_pool);
  452. mempool_exit(&f->prealloc_pool);
  453. mempool_exit(&f->extra_pool);
  454. mempool_exit(&f->output_pool);
  455. kmem_cache_destroy(f->cache);
  456. if (f->data_bufio)
  457. dm_bufio_client_destroy(f->data_bufio);
  458. if (f->bufio)
  459. dm_bufio_client_destroy(f->bufio);
  460. if (f->dev)
  461. dm_put_device(v->ti, f->dev);
  462. out:
  463. kfree(f);
  464. v->fec = NULL;
  465. }
  466. static void *fec_rs_alloc(gfp_t gfp_mask, void *pool_data)
  467. {
  468. struct dm_verity *v = pool_data;
  469. return init_rs_gfp(8, 0x11d, 0, 1, v->fec->roots, gfp_mask);
  470. }
  471. static void fec_rs_free(void *element, void *pool_data)
  472. {
  473. struct rs_control *rs = element;
  474. if (rs)
  475. free_rs(rs);
  476. }
  477. bool verity_is_fec_opt_arg(const char *arg_name)
  478. {
  479. return (!strcasecmp(arg_name, DM_VERITY_OPT_FEC_DEV) ||
  480. !strcasecmp(arg_name, DM_VERITY_OPT_FEC_BLOCKS) ||
  481. !strcasecmp(arg_name, DM_VERITY_OPT_FEC_START) ||
  482. !strcasecmp(arg_name, DM_VERITY_OPT_FEC_ROOTS));
  483. }
  484. int verity_fec_parse_opt_args(struct dm_arg_set *as, struct dm_verity *v,
  485. unsigned int *argc, const char *arg_name)
  486. {
  487. int r;
  488. struct dm_target *ti = v->ti;
  489. const char *arg_value;
  490. unsigned long long num_ll;
  491. unsigned char num_c;
  492. char dummy;
  493. if (!*argc) {
  494. ti->error = "FEC feature arguments require a value";
  495. return -EINVAL;
  496. }
  497. arg_value = dm_shift_arg(as);
  498. (*argc)--;
  499. if (!strcasecmp(arg_name, DM_VERITY_OPT_FEC_DEV)) {
  500. if (v->fec->dev) {
  501. ti->error = "FEC device already specified";
  502. return -EINVAL;
  503. }
  504. r = dm_get_device(ti, arg_value, BLK_OPEN_READ, &v->fec->dev);
  505. if (r) {
  506. ti->error = "FEC device lookup failed";
  507. return r;
  508. }
  509. } else if (!strcasecmp(arg_name, DM_VERITY_OPT_FEC_BLOCKS)) {
  510. if (sscanf(arg_value, "%llu%c", &num_ll, &dummy) != 1 ||
  511. ((sector_t)(num_ll << (v->data_dev_block_bits - SECTOR_SHIFT))
  512. >> (v->data_dev_block_bits - SECTOR_SHIFT) != num_ll)) {
  513. ti->error = "Invalid " DM_VERITY_OPT_FEC_BLOCKS;
  514. return -EINVAL;
  515. }
  516. v->fec->blocks = num_ll;
  517. } else if (!strcasecmp(arg_name, DM_VERITY_OPT_FEC_START)) {
  518. if (sscanf(arg_value, "%llu%c", &num_ll, &dummy) != 1 ||
  519. ((sector_t)(num_ll << (v->data_dev_block_bits - SECTOR_SHIFT)) >>
  520. (v->data_dev_block_bits - SECTOR_SHIFT) != num_ll)) {
  521. ti->error = "Invalid " DM_VERITY_OPT_FEC_START;
  522. return -EINVAL;
  523. }
  524. v->fec->start = num_ll;
  525. } else if (!strcasecmp(arg_name, DM_VERITY_OPT_FEC_ROOTS)) {
  526. if (sscanf(arg_value, "%hhu%c", &num_c, &dummy) != 1 || !num_c ||
  527. num_c < (DM_VERITY_FEC_RSM - DM_VERITY_FEC_MAX_RSN) ||
  528. num_c > (DM_VERITY_FEC_RSM - DM_VERITY_FEC_MIN_RSN)) {
  529. ti->error = "Invalid " DM_VERITY_OPT_FEC_ROOTS;
  530. return -EINVAL;
  531. }
  532. v->fec->roots = num_c;
  533. } else {
  534. ti->error = "Unrecognized verity FEC feature request";
  535. return -EINVAL;
  536. }
  537. return 0;
  538. }
  539. /*
  540. * Allocate dm_verity_fec for v->fec. Must be called before verity_fec_ctr.
  541. */
  542. int verity_fec_ctr_alloc(struct dm_verity *v)
  543. {
  544. struct dm_verity_fec *f;
  545. f = kzalloc(sizeof(struct dm_verity_fec), GFP_KERNEL);
  546. if (!f) {
  547. v->ti->error = "Cannot allocate FEC structure";
  548. return -ENOMEM;
  549. }
  550. v->fec = f;
  551. return 0;
  552. }
  553. /*
  554. * Validate arguments and preallocate memory. Must be called after arguments
  555. * have been parsed using verity_fec_parse_opt_args.
  556. */
  557. int verity_fec_ctr(struct dm_verity *v)
  558. {
  559. struct dm_verity_fec *f = v->fec;
  560. struct dm_target *ti = v->ti;
  561. u64 hash_blocks, fec_blocks;
  562. int ret;
  563. if (!verity_fec_is_enabled(v)) {
  564. verity_fec_dtr(v);
  565. return 0;
  566. }
  567. /*
  568. * FEC is computed over data blocks, possible metadata, and
  569. * hash blocks. In other words, FEC covers total of fec_blocks
  570. * blocks consisting of the following:
  571. *
  572. * data blocks | hash blocks | metadata (optional)
  573. *
  574. * We allow metadata after hash blocks to support a use case
  575. * where all data is stored on the same device and FEC covers
  576. * the entire area.
  577. *
  578. * If metadata is included, we require it to be available on the
  579. * hash device after the hash blocks.
  580. */
  581. hash_blocks = v->hash_blocks - v->hash_start;
  582. /*
  583. * Require matching block sizes for data and hash devices for
  584. * simplicity.
  585. */
  586. if (v->data_dev_block_bits != v->hash_dev_block_bits) {
  587. ti->error = "Block sizes must match to use FEC";
  588. return -EINVAL;
  589. }
  590. if (!f->roots) {
  591. ti->error = "Missing " DM_VERITY_OPT_FEC_ROOTS;
  592. return -EINVAL;
  593. }
  594. f->rsn = DM_VERITY_FEC_RSM - f->roots;
  595. if (!f->blocks) {
  596. ti->error = "Missing " DM_VERITY_OPT_FEC_BLOCKS;
  597. return -EINVAL;
  598. }
  599. f->rounds = f->blocks;
  600. if (sector_div(f->rounds, f->rsn))
  601. f->rounds++;
  602. /*
  603. * Due to optional metadata, f->blocks can be larger than
  604. * data_blocks and hash_blocks combined.
  605. */
  606. if (f->blocks < v->data_blocks + hash_blocks || !f->rounds) {
  607. ti->error = "Invalid " DM_VERITY_OPT_FEC_BLOCKS;
  608. return -EINVAL;
  609. }
  610. /*
  611. * Metadata is accessed through the hash device, so we require
  612. * it to be large enough.
  613. */
  614. f->hash_blocks = f->blocks - v->data_blocks;
  615. if (dm_bufio_get_device_size(v->bufio) < f->hash_blocks) {
  616. ti->error = "Hash device is too small for "
  617. DM_VERITY_OPT_FEC_BLOCKS;
  618. return -E2BIG;
  619. }
  620. f->io_size = 1 << v->data_dev_block_bits;
  621. f->bufio = dm_bufio_client_create(f->dev->bdev,
  622. f->io_size,
  623. 1, 0, NULL, NULL, 0);
  624. if (IS_ERR(f->bufio)) {
  625. ti->error = "Cannot initialize FEC bufio client";
  626. return PTR_ERR(f->bufio);
  627. }
  628. dm_bufio_set_sector_offset(f->bufio, f->start << (v->data_dev_block_bits - SECTOR_SHIFT));
  629. fec_blocks = div64_u64(f->rounds * f->roots, v->fec->roots << SECTOR_SHIFT);
  630. if (dm_bufio_get_device_size(f->bufio) < fec_blocks) {
  631. ti->error = "FEC device is too small";
  632. return -E2BIG;
  633. }
  634. f->data_bufio = dm_bufio_client_create(v->data_dev->bdev,
  635. 1 << v->data_dev_block_bits,
  636. 1, 0, NULL, NULL, 0);
  637. if (IS_ERR(f->data_bufio)) {
  638. ti->error = "Cannot initialize FEC data bufio client";
  639. return PTR_ERR(f->data_bufio);
  640. }
  641. if (dm_bufio_get_device_size(f->data_bufio) < v->data_blocks) {
  642. ti->error = "Data device is too small";
  643. return -E2BIG;
  644. }
  645. /* Preallocate an rs_control structure for each worker thread */
  646. ret = mempool_init(&f->rs_pool, num_online_cpus(), fec_rs_alloc,
  647. fec_rs_free, (void *) v);
  648. if (ret) {
  649. ti->error = "Cannot allocate RS pool";
  650. return ret;
  651. }
  652. f->cache = kmem_cache_create("dm_verity_fec_buffers",
  653. f->rsn << DM_VERITY_FEC_BUF_RS_BITS,
  654. 0, 0, NULL);
  655. if (!f->cache) {
  656. ti->error = "Cannot create FEC buffer cache";
  657. return -ENOMEM;
  658. }
  659. /* Preallocate DM_VERITY_FEC_BUF_PREALLOC buffers for each thread */
  660. ret = mempool_init_slab_pool(&f->prealloc_pool, num_online_cpus() *
  661. DM_VERITY_FEC_BUF_PREALLOC,
  662. f->cache);
  663. if (ret) {
  664. ti->error = "Cannot allocate FEC buffer prealloc pool";
  665. return ret;
  666. }
  667. ret = mempool_init_slab_pool(&f->extra_pool, 0, f->cache);
  668. if (ret) {
  669. ti->error = "Cannot allocate FEC buffer extra pool";
  670. return ret;
  671. }
  672. /* Preallocate an output buffer for each thread */
  673. ret = mempool_init_kmalloc_pool(&f->output_pool, num_online_cpus(),
  674. 1 << v->data_dev_block_bits);
  675. if (ret) {
  676. ti->error = "Cannot allocate FEC output pool";
  677. return ret;
  678. }
  679. /* Reserve space for our per-bio data */
  680. ti->per_io_data_size += sizeof(struct dm_verity_fec_io);
  681. return 0;
  682. }