drivers/md/dm-crypt.c

   1 /*
   2  * Copyright (C) 2003 Christophe Saout <christophe@saout.de>
   3  * Copyright (C) 2004 Clemens Fruhwirth <clemens@endorphin.org>
   4  * Copyright (C) 2006-2008 Red Hat, Inc. All rights reserved.
   5  *
   6  * This file is released under the GPL.
   7  */
   8
   9 #include <linux/completion.h>
  10 #include <linux/err.h>
  11 #include <linux/module.h>
  12 #include <linux/init.h>
  13 #include <linux/kernel.h>
  14 #include <linux/bio.h>
  15 #include <linux/blkdev.h>
  16 #include <linux/mempool.h>
  17 #include <linux/slab.h>
  18 #include <linux/crypto.h>
  19 #include <linux/workqueue.h>
  20 #include <linux/backing-dev.h>
  21 #include <asm/atomic.h>
  22 #include <linux/scatterlist.h>
  23 #include <asm/page.h>
  24 #include <asm/unaligned.h>
  25
  26 #include "dm.h"
  27
  28 #define DM_MSG_PREFIX "crypt"
  29 #define MESG_STR(x) x, sizeof(x)
  30
  31 /*
  32  * context holding the current state of a multi-part conversion
  33  */
  34 struct convert_context {
  35         struct completion restart;
  36         struct bio *bio_in;
  37         struct bio *bio_out;
  38         unsigned int offset_in;
  39         unsigned int offset_out;
  40         unsigned int idx_in;
  41         unsigned int idx_out;
  42         sector_t sector;
  43         atomic_t pending;
  44 };
  45
  46 /*
  47  * per bio private data
  48  */
  49 struct dm_crypt_io {
  50         struct dm_target *target;
  51         struct bio *base_bio;
  52         struct work_struct work;
  53
  54         struct convert_context ctx;
  55
  56         atomic_t pending;
  57         int error;
  58         sector_t sector;
  59 };
  60
  61 struct dm_crypt_request {
  62         struct scatterlist sg_in;
  63         struct scatterlist sg_out;
  64 };
  65
  66 struct crypt_config;
  67
  68 struct crypt_iv_operations {
  69         int (*ctr)(struct crypt_config *cc, struct dm_target *ti,
  70                    const char *opts);
  71         void (*dtr)(struct crypt_config *cc);
  72         const char *(*status)(struct crypt_config *cc);
  73         int (*generator)(struct crypt_config *cc, u8 *iv, sector_t sector);
  74 };
  75
  76 /*
  77  * Crypt: maps a linear range of a block device
  78  * and encrypts / decrypts at the same time.
  79  */
  80 enum flags { DM_CRYPT_SUSPENDED, DM_CRYPT_KEY_VALID };
  81 struct crypt_config {
  82         struct dm_dev *dev;
  83         sector_t start;
  84
  85         /*
  86          * pool for per bio private data, crypto requests and
  87          * encryption requeusts/buffer pages
  88          */
  89         mempool_t *io_pool;
  90         mempool_t *req_pool;
  91         mempool_t *page_pool;
  92         struct bio_set *bs;
  93
  94         struct workqueue_struct *io_queue;
  95         struct workqueue_struct *crypt_queue;
  96         wait_queue_head_t writeq;
  97
  98         /*
  99          * crypto related data
 100          */
 101         struct crypt_iv_operations *iv_gen_ops;
 102         char *iv_mode;
 103         union {
 104                 struct crypto_cipher *essiv_tfm;
 105                 int benbi_shift;
 106         } iv_gen_private;
 107         sector_t iv_offset;
 108         unsigned int iv_size;
 109
 110         /*
 111          * Layout of each crypto request:
 112          *
 113          *   struct ablkcipher_request
 114          *      context
 115          *      padding
 116          *   struct dm_crypt_request
 117          *      padding
 118          *   IV
 119          *
 120          * The padding is added so that dm_crypt_request and the IV are
 121          * correctly aligned.
 122          */
 123         unsigned int dmreq_start;
 124         struct ablkcipher_request *req;
 125
 126         char cipher[CRYPTO_MAX_ALG_NAME];
 127         char chainmode[CRYPTO_MAX_ALG_NAME];
 128         struct crypto_ablkcipher *tfm;
 129         unsigned long flags;
 130         unsigned int key_size;
 131         u8 key[0];
 132 };
 133
 134 #define MIN_IOS        16
 135 #define MIN_POOL_PAGES 32
 136 #define MIN_BIO_PAGES  8
 137
 138 static struct kmem_cache *_crypt_io_pool;
 139
 140 static void clone_init(struct dm_crypt_io *, struct bio *);
 141 static void kcryptd_queue_crypt(struct dm_crypt_io *io);
 142
 143 /*
 144  * Different IV generation algorithms:
 145  *
 146  * plain: the initial vector is the 32-bit little-endian version of the sector
 147  *        number, padded with zeros if necessary.
 148  *
 149  * essiv: "encrypted sector|salt initial vector", the sector number is
 150  *        encrypted with the bulk cipher using a salt as key. The salt
 151  *        should be derived from the bulk cipher's key via hashing.
 152  *
 153  * benbi: the 64-bit "big-endian 'narrow block'-count", starting at 1
 154  *        (needed for LRW-32-AES and possible other narrow block modes)
 155  *
 156  * null: the initial vector is always zero.  Provides compatibility with
 157  *       obsolete loop_fish2 devices.  Do not use for new devices.
 158  *
 159  * plumb: unimplemented, see:
 160  * http://article.gmane.org/gmane.linux.kernel.device-mapper.dm-crypt/454
 161  */
 162
 163 static int crypt_iv_plain_gen(struct crypt_config *cc, u8 *iv, sector_t sector)
 164 {
 165         memset(iv, 0, cc->iv_size);
 166         *(u32 *)iv = cpu_to_le32(sector & 0xffffffff);
 167
 168         return 0;
 169 }
 170
 171 static int crypt_iv_essiv_ctr(struct crypt_config *cc, struct dm_target *ti,
 172                               const char *opts)
 173 {
 174         struct crypto_cipher *essiv_tfm;
 175         struct crypto_hash *hash_tfm;
 176         struct hash_desc desc;
 177         struct scatterlist sg;
 178         unsigned int saltsize;
 179         u8 *salt;
 180         int err;
 181
 182         if (opts == NULL) {
 183                 ti->error = "Digest algorithm missing for ESSIV mode";
 184                 return -EINVAL;
 185         }
 186
 187         /* Hash the cipher key with the given hash algorithm */
 188         hash_tfm = crypto_alloc_hash(opts, 0, CRYPTO_ALG_ASYNC);
 189         if (IS_ERR(hash_tfm)) {
 190                 ti->error = "Error initializing ESSIV hash";
 191                 return PTR_ERR(hash_tfm);
 192         }
 193
 194         saltsize = crypto_hash_digestsize(hash_tfm);
 195         salt = kmalloc(saltsize, GFP_KERNEL);
 196         if (salt == NULL) {
 197                 ti->error = "Error kmallocing salt storage in ESSIV";
 198                 crypto_free_hash(hash_tfm);
 199                 return -ENOMEM;
 200         }
 201
 202         sg_init_one(&sg, cc->key, cc->key_size);
 203         desc.tfm = hash_tfm;
 204         desc.flags = CRYPTO_TFM_REQ_MAY_SLEEP;
 205         err = crypto_hash_digest(&desc, &sg, cc->key_size, salt);
 206         crypto_free_hash(hash_tfm);
 207
 208         if (err) {
 209                 ti->error = "Error calculating hash in ESSIV";
 210                 kfree(salt);
 211                 return err;
 212         }
 213
 214         /* Setup the essiv_tfm with the given salt */
 215         essiv_tfm = crypto_alloc_cipher(cc->cipher, 0, CRYPTO_ALG_ASYNC);
 216         if (IS_ERR(essiv_tfm)) {
 217                 ti->error = "Error allocating crypto tfm for ESSIV";
 218                 kfree(salt);
 219                 return PTR_ERR(essiv_tfm);
 220         }
 221         if (crypto_cipher_blocksize(essiv_tfm) !=
 222             crypto_ablkcipher_ivsize(cc->tfm)) {
 223                 ti->error = "Block size of ESSIV cipher does "
 224                             "not match IV size of block cipher";
 225                 crypto_free_cipher(essiv_tfm);
 226                 kfree(salt);
 227                 return -EINVAL;
 228         }
 229         err = crypto_cipher_setkey(essiv_tfm, salt, saltsize);
 230         if (err) {
 231                 ti->error = "Failed to set key for ESSIV cipher";
 232                 crypto_free_cipher(essiv_tfm);
 233                 kfree(salt);
 234                 return err;
 235         }
 236         kfree(salt);
 237
 238         cc->iv_gen_private.essiv_tfm = essiv_tfm;
 239         return 0;
 240 }
 241
 242 static void crypt_iv_essiv_dtr(struct crypt_config *cc)
 243 {
 244         crypto_free_cipher(cc->iv_gen_private.essiv_tfm);
 245         cc->iv_gen_private.essiv_tfm = NULL;
 246 }
 247
 248 static int crypt_iv_essiv_gen(struct crypt_config *cc, u8 *iv, sector_t sector)
 249 {
 250         memset(iv, 0, cc->iv_size);
 251         *(u64 *)iv = cpu_to_le64(sector);
 252         crypto_cipher_encrypt_one(cc->iv_gen_private.essiv_tfm, iv, iv);
 253         return 0;
 254 }
 255
 256 static int crypt_iv_benbi_ctr(struct crypt_config *cc, struct dm_target *ti,
 257                               const char *opts)
 258 {
 259         unsigned bs = crypto_ablkcipher_blocksize(cc->tfm);
 260         int log = ilog2(bs);
 261
 262         /* we need to calculate how far we must shift the sector count
 263          * to get the cipher block count, we use this shift in _gen */
 264
 265         if (1 << log != bs) {
 266                 ti->error = "cypher blocksize is not a power of 2";
 267                 return -EINVAL;
 268         }
 269
 270         if (log > 9) {
 271                 ti->error = "cypher blocksize is > 512";
 272                 return -EINVAL;
 273         }
 274
 275         cc->iv_gen_private.benbi_shift = 9 - log;
 276
 277         return 0;
 278 }
 279
 280 static void crypt_iv_benbi_dtr(struct crypt_config *cc)
 281 {
 282 }
 283
 284 static int crypt_iv_benbi_gen(struct crypt_config *cc, u8 *iv, sector_t sector)
 285 {
 286         __be64 val;
 287
 288         memset(iv, 0, cc->iv_size - sizeof(u64)); /* rest is cleared below */
 289
 290         val = cpu_to_be64(((u64)sector << cc->iv_gen_private.benbi_shift) + 1);
 291         put_unaligned(val, (__be64 *)(iv + cc->iv_size - sizeof(u64)));
 292
 293         return 0;
 294 }
 295
 296 static int crypt_iv_null_gen(struct crypt_config *cc, u8 *iv, sector_t sector)
 297 {
 298         memset(iv, 0, cc->iv_size);
 299
 300         return 0;
 301 }
 302
 303 static struct crypt_iv_operations crypt_iv_plain_ops = {
 304         .generator = crypt_iv_plain_gen
 305 };
 306
 307 static struct crypt_iv_operations crypt_iv_essiv_ops = {
 308         .ctr       = crypt_iv_essiv_ctr,
 309         .dtr       = crypt_iv_essiv_dtr,
 310         .generator = crypt_iv_essiv_gen
 311 };
 312
 313 static struct crypt_iv_operations crypt_iv_benbi_ops = {
 314         .ctr       = crypt_iv_benbi_ctr,
 315         .dtr       = crypt_iv_benbi_dtr,
 316         .generator = crypt_iv_benbi_gen
 317 };
 318
 319 static struct crypt_iv_operations crypt_iv_null_ops = {
 320         .generator = crypt_iv_null_gen
 321 };
 322
 323 static void crypt_convert_init(struct crypt_config *cc,
 324                                struct convert_context *ctx,
 325                                struct bio *bio_out, struct bio *bio_in,
 326                                sector_t sector)
 327 {
 328         ctx->bio_in = bio_in;
 329         ctx->bio_out = bio_out;
 330         ctx->offset_in = 0;
 331         ctx->offset_out = 0;
 332         ctx->idx_in = bio_in ? bio_in->bi_idx : 0;
 333         ctx->idx_out = bio_out ? bio_out->bi_idx : 0;
 334         ctx->sector = sector + cc->iv_offset;
 335         init_completion(&ctx->restart);
 336         atomic_set(&ctx->pending, 1);
 337 }
 338
 339 static int crypt_convert_block(struct crypt_config *cc,
 340                                struct convert_context *ctx,
 341                                struct ablkcipher_request *req)
 342 {
 343         struct bio_vec *bv_in = bio_iovec_idx(ctx->bio_in, ctx->idx_in);
 344         struct bio_vec *bv_out = bio_iovec_idx(ctx->bio_out, ctx->idx_out);
 345         struct dm_crypt_request *dmreq;
 346         u8 *iv;
 347         int r = 0;
 348
 349         dmreq = (struct dm_crypt_request *)((char *)req + cc->dmreq_start);
 350         iv = (u8 *)ALIGN((unsigned long)(dmreq + 1),
 351                          crypto_ablkcipher_alignmask(cc->tfm) + 1);
 352
 353         sg_init_table(&dmreq->sg_in, 1);
 354         sg_set_page(&dmreq->sg_in, bv_in->bv_page, 1 << SECTOR_SHIFT,
 355                     bv_in->bv_offset + ctx->offset_in);
 356
 357         sg_init_table(&dmreq->sg_out, 1);
 358         sg_set_page(&dmreq->sg_out, bv_out->bv_page, 1 << SECTOR_SHIFT,
 359                     bv_out->bv_offset + ctx->offset_out);
 360
 361         ctx->offset_in += 1 << SECTOR_SHIFT;
 362         if (ctx->offset_in >= bv_in->bv_len) {
 363                 ctx->offset_in = 0;
 364                 ctx->idx_in++;
 365         }
 366
 367         ctx->offset_out += 1 << SECTOR_SHIFT;
 368         if (ctx->offset_out >= bv_out->bv_len) {
 369                 ctx->offset_out = 0;
 370                 ctx->idx_out++;
 371         }
 372
 373         if (cc->iv_gen_ops) {
 374                 r = cc->iv_gen_ops->generator(cc, iv, ctx->sector);
 375                 if (r < 0)
 376                         return r;
 377         }
 378
 379         ablkcipher_request_set_crypt(req, &dmreq->sg_in, &dmreq->sg_out,
 380                                      1 << SECTOR_SHIFT, iv);
 381
 382         if (bio_data_dir(ctx->bio_in) == WRITE)
 383                 r = crypto_ablkcipher_encrypt(req);
 384         else
 385                 r = crypto_ablkcipher_decrypt(req);
 386
 387         return r;
 388 }
 389
 390 static void kcryptd_async_done(struct crypto_async_request *async_req,
 391                                int error);
 392 static void crypt_alloc_req(struct crypt_config *cc,
 393                             struct convert_context *ctx)
 394 {
 395         if (!cc->req)
 396                 cc->req = mempool_alloc(cc->req_pool, GFP_NOIO);
 397         ablkcipher_request_set_tfm(cc->req, cc->tfm);
 398         ablkcipher_request_set_callback(cc->req, CRYPTO_TFM_REQ_MAY_BACKLOG |
 399                                              CRYPTO_TFM_REQ_MAY_SLEEP,
 400                                              kcryptd_async_done, ctx);
 401 }
 402
 403 /*
 404  * Encrypt / decrypt data from one bio to another one (can be the same one)
 405  */
 406 static int crypt_convert(struct crypt_config *cc,
 407                          struct convert_context *ctx)
 408 {
 409         int r;
 410
 411         while(ctx->idx_in < ctx->bio_in->bi_vcnt &&
 412               ctx->idx_out < ctx->bio_out->bi_vcnt) {
 413
 414                 crypt_alloc_req(cc, ctx);
 415
 416                 atomic_inc(&ctx->pending);
 417
 418                 r = crypt_convert_block(cc, ctx, cc->req);
 419
 420                 switch (r) {
 421                 /* async */
 422                 case -EBUSY:
 423                         wait_for_completion(&ctx->restart);
 424                         INIT_COMPLETION(ctx->restart);
 425                         /* fall through*/
 426                 case -EINPROGRESS:
 427                         cc->req = NULL;
 428                         ctx->sector++;
 429                         continue;
 430
 431                 /* sync */
 432                 case 0:
 433                         atomic_dec(&ctx->pending);
 434                         ctx->sector++;
 435                         cond_resched();
 436                         continue;
 437
 438                 /* error */
 439                 default:
 440                         atomic_dec(&ctx->pending);
 441                         return r;
 442                 }
 443         }
 444
 445         return 0;
 446 }
 447
 448 static void dm_crypt_bio_destructor(struct bio *bio)
 449 {
 450         struct dm_crypt_io *io = bio->bi_private;
 451         struct crypt_config *cc = io->target->private;
 452
 453         bio_free(bio, cc->bs);
 454 }
 455
 456 /*
 457  * Generate a new unfragmented bio with the given size
 458  * This should never violate the device limitations
 459  * May return a smaller bio when running out of pages
 460  */
 461 static struct bio *crypt_alloc_buffer(struct dm_crypt_io *io, unsigned size)
 462 {
 463         struct crypt_config *cc = io->target->private;
 464         struct bio *clone;
 465         unsigned int nr_iovecs = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
 466         gfp_t gfp_mask = GFP_NOIO | __GFP_HIGHMEM;
 467         unsigned i, len;
 468         struct page *page;
 469
 470         clone = bio_alloc_bioset(GFP_NOIO, nr_iovecs, cc->bs);
 471         if (!clone)
 472                 return NULL;
 473
 474         clone_init(io, clone);
 475
 476         for (i = 0; i < nr_iovecs; i++) {
 477                 page = mempool_alloc(cc->page_pool, gfp_mask);
 478                 if (!page)
 479                         break;
 480
 481                 /*
 482                  * if additional pages cannot be allocated without waiting,
 483                  * return a partially allocated bio, the caller will then try
 484                  * to allocate additional bios while submitting this partial bio
 485                  */
 486                 if (i == (MIN_BIO_PAGES - 1))
 487                         gfp_mask = (gfp_mask | __GFP_NOWARN) & ~__GFP_WAIT;
 488
 489                 len = (size > PAGE_SIZE) ? PAGE_SIZE : size;
 490
 491                 if (!bio_add_page(clone, page, len, 0)) {
 492                         mempool_free(page, cc->page_pool);
 493                         break;
 494                 }
 495
 496                 size -= len;
 497         }
 498
 499         if (!clone->bi_size) {
 500                 bio_put(clone);
 501                 return NULL;
 502         }
 503
 504         return clone;
 505 }
 506
 507 static void crypt_free_buffer_pages(struct crypt_config *cc, struct bio *clone)
 508 {
 509         unsigned int i;
 510         struct bio_vec *bv;
 511
 512         for (i = 0; i < clone->bi_vcnt; i++) {
 513                 bv = bio_iovec_idx(clone, i);
 514                 BUG_ON(!bv->bv_page);
 515                 mempool_free(bv->bv_page, cc->page_pool);
 516                 bv->bv_page = NULL;
 517         }
 518 }
 519
 520 static struct dm_crypt_io *crypt_io_alloc(struct dm_target *ti,
 521                                           struct bio *bio, sector_t sector)
 522 {
 523         struct crypt_config *cc = ti->private;
 524         struct dm_crypt_io *io;
 525
 526         io = mempool_alloc(cc->io_pool, GFP_NOIO);
 527         io->target = ti;
 528         io->base_bio = bio;
 529         io->sector = sector;
 530         io->error = 0;
 531         atomic_set(&io->pending, 0);
 532
 533         return io;
 534 }
 535
 536 static void crypt_inc_pending(struct dm_crypt_io *io)
 537 {
 538         atomic_inc(&io->pending);
 539 }
 540
 541 /*
 542  * One of the bios was finished. Check for completion of
 543  * the whole request and correctly clean up the buffer.
 544  */
 545 static void crypt_dec_pending(struct dm_crypt_io *io)
 546 {
 547         struct crypt_config *cc = io->target->private;
 548
 549         if (!atomic_dec_and_test(&io->pending))
 550                 return;
 551
 552         bio_endio(io->base_bio, io->error);
 553         mempool_free(io, cc->io_pool);
 554 }
 555
 556 /*
 557  * kcryptd/kcryptd_io:
 558  *
 559  * Needed because it would be very unwise to do decryption in an
 560  * interrupt context.
 561  *
 562  * kcryptd performs the actual encryption or decryption.
 563  *
 564  * kcryptd_io performs the IO submission.
 565  *
 566  * They must be separated as otherwise the final stages could be
 567  * starved by new requests which can block in the first stages due
 568  * to memory allocation.
 569  */
 570 static void crypt_endio(struct bio *clone, int error)
 571 {
 572         struct dm_crypt_io *io = clone->bi_private;
 573         struct crypt_config *cc = io->target->private;
 574         unsigned rw = bio_data_dir(clone);
 575
 576         if (unlikely(!bio_flagged(clone, BIO_UPTODATE) && !error))
 577                 error = -EIO;
 578
 579         /*
 580          * free the processed pages
 581          */
 582         if (rw == WRITE)
 583                 crypt_free_buffer_pages(cc, clone);
 584
 585         bio_put(clone);
 586
 587         if (rw == READ && !error) {
 588                 kcryptd_queue_crypt(io);
 589                 return;
 590         }
 591
 592         if (unlikely(error))
 593                 io->error = error;
 594
 595         crypt_dec_pending(io);
 596 }
 597
 598 static void clone_init(struct dm_crypt_io *io, struct bio *clone)
 599 {
 600         struct crypt_config *cc = io->target->private;
 601
 602         clone->bi_private = io;
 603         clone->bi_end_io  = crypt_endio;
 604         clone->bi_bdev    = cc->dev->bdev;
 605         clone->bi_rw      = io->base_bio->bi_rw;
 606         clone->bi_destructor = dm_crypt_bio_destructor;
 607 }
 608
 609 static void kcryptd_io_read(struct dm_crypt_io *io)
 610 {
 611         struct crypt_config *cc = io->target->private;
 612         struct bio *base_bio = io->base_bio;
 613         struct bio *clone;
 614
 615         crypt_inc_pending(io);
 616
 617         /*
 618          * The block layer might modify the bvec array, so always
 619          * copy the required bvecs because we need the original
 620          * one in order to decrypt the whole bio data *afterwards*.
 621          */
 622         clone = bio_alloc_bioset(GFP_NOIO, bio_segments(base_bio), cc->bs);
 623         if (unlikely(!clone)) {
 624                 io->error = -ENOMEM;
 625                 crypt_dec_pending(io);
 626                 return;
 627         }
 628
 629         clone_init(io, clone);
 630         clone->bi_idx = 0;
 631         clone->bi_vcnt = bio_segments(base_bio);
 632         clone->bi_size = base_bio->bi_size;
 633         clone->bi_sector = cc->start + io->sector;
 634         memcpy(clone->bi_io_vec, bio_iovec(base_bio),
 635                sizeof(struct bio_vec) * clone->bi_vcnt);
 636
 637         generic_make_request(clone);
 638 }
 639
 640 static void kcryptd_io_write(struct dm_crypt_io *io)
 641 {
 642         struct bio *clone = io->ctx.bio_out;
 643         struct crypt_config *cc = io->target->private;
 644
 645         generic_make_request(clone);
 646         wake_up(&cc->writeq);
 647 }
 648
 649 static void kcryptd_io(struct work_struct *work)
 650 {
 651         struct dm_crypt_io *io = container_of(work, struct dm_crypt_io, work);
 652
 653         if (bio_data_dir(io->base_bio) == READ)
 654                 kcryptd_io_read(io);
 655         else
 656                 kcryptd_io_write(io);
 657 }
 658
 659 static void kcryptd_queue_io(struct dm_crypt_io *io)
 660 {
 661         struct crypt_config *cc = io->target->private;
 662
 663         INIT_WORK(&io->work, kcryptd_io);
 664         queue_work(cc->io_queue, &io->work);
 665 }
 666
 667 static void kcryptd_crypt_write_io_submit(struct dm_crypt_io *io,
 668                                           int error, int async)
 669 {
 670         struct bio *clone = io->ctx.bio_out;
 671         struct crypt_config *cc = io->target->private;
 672
 673         if (unlikely(error < 0)) {
 674                 crypt_free_buffer_pages(cc, clone);
 675                 bio_put(clone);
 676                 io->error = -EIO;
 677                 crypt_dec_pending(io);
 678                 return;
 679         }
 680
 681         /* crypt_convert should have filled the clone bio */
 682         BUG_ON(io->ctx.idx_out < clone->bi_vcnt);
 683
 684         clone->bi_sector = cc->start + io->sector;
 685         io->sector += bio_sectors(clone);
 686
 687         if (async)
 688                 kcryptd_queue_io(io);
 689         else
 690                 generic_make_request(clone);
 691 }
 692
 693 static void kcryptd_crypt_write_convert(struct dm_crypt_io *io)
 694 {
 695         struct crypt_config *cc = io->target->private;
 696         struct bio *clone;
 697         unsigned remaining = io->base_bio->bi_size;
 698         int r;
 699
 700         /*
 701          * Prevent io from disappearing until this function completes.
 702          */
 703         crypt_inc_pending(io);
 704         crypt_convert_init(cc, &io->ctx, NULL, io->base_bio, io->sector);
 705
 706         /*
 707          * The allocated buffers can be smaller than the whole bio,
 708          * so repeat the whole process until all the data can be handled.
 709          */
 710         while (remaining) {
 711                 clone = crypt_alloc_buffer(io, remaining);
 712                 if (unlikely(!clone)) {
 713                         io->error = -ENOMEM;
 714                         break;
 715                 }
 716
 717                 io->ctx.bio_out = clone;
 718                 io->ctx.idx_out = 0;
 719
 720                 remaining -= clone->bi_size;
 721
 722                 crypt_inc_pending(io);
 723                 r = crypt_convert(cc, &io->ctx);
 724
 725                 if (atomic_dec_and_test(&io->ctx.pending)) {
 726                         /* processed, no running async crypto  */
 727                         kcryptd_crypt_write_io_submit(io, r, 0);
 728                         if (unlikely(r < 0))
 729                                 break;
 730                 }
 731
 732                 /* out of memory -> run queues */
 733                 if (unlikely(remaining)) {
 734                         /* wait for async crypto then reinitialize pending */
 735                         wait_event(cc->writeq, !atomic_read(&io->ctx.pending));
 736                         atomic_set(&io->ctx.pending, 1);
 737                         congestion_wait(WRITE, HZ/100);
 738                 }
 739         }
 740
 741         crypt_dec_pending(io);
 742 }
 743
 744 static void kcryptd_crypt_read_done(struct dm_crypt_io *io, int error)
 745 {
 746         if (unlikely(error < 0))
 747                 io->error = -EIO;
 748
 749         crypt_dec_pending(io);
 750 }
 751
 752 static void kcryptd_crypt_read_convert(struct dm_crypt_io *io)
 753 {
 754         struct crypt_config *cc = io->target->private;
 755         int r = 0;
 756
 757         crypt_inc_pending(io);
 758
 759         crypt_convert_init(cc, &io->ctx, io->base_bio, io->base_bio,
 760                            io->sector);
 761
 762         r = crypt_convert(cc, &io->ctx);
 763
 764         if (atomic_dec_and_test(&io->ctx.pending))
 765                 kcryptd_crypt_read_done(io, r);
 766
 767         crypt_dec_pending(io);
 768 }
 769
 770 static void kcryptd_async_done(struct crypto_async_request *async_req,
 771                                int error)
 772 {
 773         struct convert_context *ctx = async_req->data;
 774         struct dm_crypt_io *io = container_of(ctx, struct dm_crypt_io, ctx);
 775         struct crypt_config *cc = io->target->private;
 776
 777         if (error == -EINPROGRESS) {
 778                 complete(&ctx->restart);
 779                 return;
 780         }
 781
 782         mempool_free(ablkcipher_request_cast(async_req), cc->req_pool);
 783
 784         if (!atomic_dec_and_test(&ctx->pending))
 785                 return;
 786
 787         if (bio_data_dir(io->base_bio) == READ)
 788                 kcryptd_crypt_read_done(io, error);
 789         else
 790                 kcryptd_crypt_write_io_submit(io, error, 1);
 791 }
 792
 793 static void kcryptd_crypt(struct work_struct *work)
 794 {
 795         struct dm_crypt_io *io = container_of(work, struct dm_crypt_io, work);
 796
 797         if (bio_data_dir(io->base_bio) == READ)
 798                 kcryptd_crypt_read_convert(io);
 799         else
 800                 kcryptd_crypt_write_convert(io);
 801 }
 802
 803 static void kcryptd_queue_crypt(struct dm_crypt_io *io)
 804 {
 805         struct crypt_config *cc = io->target->private;
 806
 807         INIT_WORK(&io->work, kcryptd_crypt);
 808         queue_work(cc->crypt_queue, &io->work);
 809 }
 810
 811 /*
 812  * Decode key from its hex representation
 813  */
 814 static int crypt_decode_key(u8 *key, char *hex, unsigned int size)
 815 {
 816         char buffer[3];
 817         char *endp;
 818         unsigned int i;
 819
 820         buffer[2] = '\0';
 821
 822         for (i = 0; i < size; i++) {
 823                 buffer[0] = *hex++;
 824                 buffer[1] = *hex++;
 825
 826                 key[i] = (u8)simple_strtoul(buffer, &endp, 16);
 827
 828                 if (endp != &buffer[2])
 829                         return -EINVAL;
 830         }
 831
 832         if (*hex != '\0')
 833                 return -EINVAL;
 834
 835         return 0;
 836 }
 837
 838 /*
 839  * Encode key into its hex representation
 840  */
 841 static void crypt_encode_key(char *hex, u8 *key, unsigned int size)
 842 {
 843         unsigned int i;
 844
 845         for (i = 0; i < size; i++) {
 846                 sprintf(hex, "%02x", *key);
 847                 hex += 2;
 848                 key++;
 849         }
 850 }
 851
 852 static int crypt_set_key(struct crypt_config *cc, char *key)
 853 {
 854         unsigned key_size = strlen(key) >> 1;
 855
 856         if (cc->key_size && cc->key_size != key_size)
 857                 return -EINVAL;
 858
 859         cc->key_size = key_size; /* initial settings */
 860
 861         if ((!key_size && strcmp(key, "-")) ||
 862            (key_size && crypt_decode_key(cc->key, key, key_size) < 0))
 863                 return -EINVAL;
 864
 865         set_bit(DM_CRYPT_KEY_VALID, &cc->flags);
 866
 867         return 0;
 868 }
 869
 870 static int crypt_wipe_key(struct crypt_config *cc)
 871 {
 872         clear_bit(DM_CRYPT_KEY_VALID, &cc->flags);
 873         memset(&cc->key, 0, cc->key_size * sizeof(u8));
 874         return 0;
 875 }
 876
 877 /*
 878  * Construct an encryption mapping:
 879  * <cipher> <key> <iv_offset> <dev_path> <start>
 880  */
 881 static int crypt_ctr(struct dm_target *ti, unsigned int argc, char **argv)
 882 {
 883         struct crypt_config *cc;
 884         struct crypto_ablkcipher *tfm;
 885         char *tmp;
 886         char *cipher;
 887         char *chainmode;
 888         char *ivmode;
 889         char *ivopts;
 890         unsigned int key_size;
 891         unsigned long long tmpll;
 892
 893         if (argc != 5) {
 894                 ti->error = "Not enough arguments";
 895                 return -EINVAL;
 896         }
 897
 898         tmp = argv[0];
 899         cipher = strsep(&tmp, "-");
 900         chainmode = strsep(&tmp, "-");
 901         ivopts = strsep(&tmp, "-");
 902         ivmode = strsep(&ivopts, ":");
 903
 904         if (tmp)
 905                 DMWARN("Unexpected additional cipher options");
 906
 907         key_size = strlen(argv[1]) >> 1;
 908
 909         cc = kzalloc(sizeof(*cc) + key_size * sizeof(u8), GFP_KERNEL);
 910         if (cc == NULL) {
 911                 ti->error =
 912                         "Cannot allocate transparent encryption context";
 913                 return -ENOMEM;
 914         }
 915
 916         if (crypt_set_key(cc, argv[1])) {
 917                 ti->error = "Error decoding key";
 918                 goto bad_cipher;
 919         }
 920
 921         /* Compatiblity mode for old dm-crypt cipher strings */
 922         if (!chainmode || (strcmp(chainmode, "plain") == 0 && !ivmode)) {
 923                 chainmode = "cbc";
 924                 ivmode = "plain";
 925         }
 926
 927         if (strcmp(chainmode, "ecb") && !ivmode) {
 928                 ti->error = "This chaining mode requires an IV mechanism";
 929                 goto bad_cipher;
 930         }
 931
 932         if (snprintf(cc->cipher, CRYPTO_MAX_ALG_NAME, "%s(%s)",
 933                      chainmode, cipher) >= CRYPTO_MAX_ALG_NAME) {
 934                 ti->error = "Chain mode + cipher name is too long";
 935                 goto bad_cipher;
 936         }
 937
 938         tfm = crypto_alloc_ablkcipher(cc->cipher, 0, 0);
 939         if (IS_ERR(tfm)) {
 940                 ti->error = "Error allocating crypto tfm";
 941                 goto bad_cipher;
 942         }
 943
 944         strcpy(cc->cipher, cipher);
 945         strcpy(cc->chainmode, chainmode);
 946         cc->tfm = tfm;
 947
 948         /*
 949          * Choose ivmode. Valid modes: "plain", "essiv:<esshash>", "benbi".
 950          * See comments at iv code
 951          */
 952
 953         if (ivmode == NULL)
 954                 cc->iv_gen_ops = NULL;
 955         else if (strcmp(ivmode, "plain") == 0)
 956                 cc->iv_gen_ops = &crypt_iv_plain_ops;
 957         else if (strcmp(ivmode, "essiv") == 0)
 958                 cc->iv_gen_ops = &crypt_iv_essiv_ops;
 959         else if (strcmp(ivmode, "benbi") == 0)
 960                 cc->iv_gen_ops = &crypt_iv_benbi_ops;
 961         else if (strcmp(ivmode, "null") == 0)
 962                 cc->iv_gen_ops = &crypt_iv_null_ops;
 963         else {
 964                 ti->error = "Invalid IV mode";
 965                 goto bad_ivmode;
 966         }
 967
 968         if (cc->iv_gen_ops && cc->iv_gen_ops->ctr &&
 969             cc->iv_gen_ops->ctr(cc, ti, ivopts) < 0)
 970                 goto bad_ivmode;
 971
 972         cc->iv_size = crypto_ablkcipher_ivsize(tfm);
 973         if (cc->iv_size)
 974                 /* at least a 64 bit sector number should fit in our buffer */
 975                 cc->iv_size = max(cc->iv_size,
 976                                   (unsigned int)(sizeof(u64) / sizeof(u8)));
 977         else {
 978                 if (cc->iv_gen_ops) {
 979                         DMWARN("Selected cipher does not support IVs");
 980                         if (cc->iv_gen_ops->dtr)
 981                                 cc->iv_gen_ops->dtr(cc);
 982                         cc->iv_gen_ops = NULL;
 983                 }
 984         }
 985
 986         cc->io_pool = mempool_create_slab_pool(MIN_IOS, _crypt_io_pool);
 987         if (!cc->io_pool) {
 988                 ti->error = "Cannot allocate crypt io mempool";
 989                 goto bad_slab_pool;
 990         }
 991
 992         cc->dmreq_start = sizeof(struct ablkcipher_request);
 993         cc->dmreq_start += crypto_ablkcipher_reqsize(tfm);
 994         cc->dmreq_start = ALIGN(cc->dmreq_start, crypto_tfm_ctx_alignment());
 995         cc->dmreq_start += crypto_ablkcipher_alignmask(tfm) &
 996                            ~(crypto_tfm_ctx_alignment() - 1);
 997
 998         cc->req_pool = mempool_create_kmalloc_pool(MIN_IOS, cc->dmreq_start +
 999                         sizeof(struct dm_crypt_request) + cc->iv_size);
1000         if (!cc->req_pool) {
1001                 ti->error = "Cannot allocate crypt request mempool";
1002                 goto bad_req_pool;
1003         }
1004         cc->req = NULL;
1005
1006         cc->page_pool = mempool_create_page_pool(MIN_POOL_PAGES, 0);
1007         if (!cc->page_pool) {
1008                 ti->error = "Cannot allocate page mempool";
1009                 goto bad_page_pool;
1010         }
1011
1012         cc->bs = bioset_create(MIN_IOS, MIN_IOS);
1013         if (!cc->bs) {
1014                 ti->error = "Cannot allocate crypt bioset";
1015                 goto bad_bs;
1016         }
1017
1018         if (crypto_ablkcipher_setkey(tfm, cc->key, key_size) < 0) {
1019                 ti->error = "Error setting key";
1020                 goto bad_device;
1021         }
1022
1023         if (sscanf(argv[2], "%llu", &tmpll) != 1) {
1024                 ti->error = "Invalid iv_offset sector";
1025                 goto bad_device;
1026         }
1027         cc->iv_offset = tmpll;
1028
1029         if (sscanf(argv[4], "%llu", &tmpll) != 1) {
1030                 ti->error = "Invalid device sector";
1031                 goto bad_device;
1032         }
1033         cc->start = tmpll;
1034
1035         if (dm_get_device(ti, argv[3], cc->start, ti->len,
1036                           dm_table_get_mode(ti->table), &cc->dev)) {
1037                 ti->error = "Device lookup failed";
1038                 goto bad_device;
1039         }
1040
1041         if (ivmode && cc->iv_gen_ops) {
1042                 if (ivopts)
1043                         *(ivopts - 1) = ':';
1044                 cc->iv_mode = kmalloc(strlen(ivmode) + 1, GFP_KERNEL);
1045                 if (!cc->iv_mode) {
1046                         ti->error = "Error kmallocing iv_mode string";
1047                         goto bad_ivmode_string;
1048                 }
1049                 strcpy(cc->iv_mode, ivmode);
1050         } else
1051                 cc->iv_mode = NULL;
1052
1053         cc->io_queue = create_singlethread_workqueue("kcryptd_io");
1054         if (!cc->io_queue) {
1055                 ti->error = "Couldn't create kcryptd io queue";
1056                 goto bad_io_queue;
1057         }
1058
1059         cc->crypt_queue = create_singlethread_workqueue("kcryptd");
1060         if (!cc->crypt_queue) {
1061                 ti->error = "Couldn't create kcryptd queue";
1062                 goto bad_crypt_queue;
1063         }
1064
1065         init_waitqueue_head(&cc->writeq);
1066         ti->private = cc;
1067         return 0;
1068
1069 bad_crypt_queue:
1070         destroy_workqueue(cc->io_queue);
1071 bad_io_queue:
1072         kfree(cc->iv_mode);
1073 bad_ivmode_string:
1074         dm_put_device(ti, cc->dev);
1075 bad_device:
1076         bioset_free(cc->bs);
1077 bad_bs:
1078         mempool_destroy(cc->page_pool);
1079 bad_page_pool:
1080         mempool_destroy(cc->req_pool);
1081 bad_req_pool:
1082         mempool_destroy(cc->io_pool);
1083 bad_slab_pool:
1084         if (cc->iv_gen_ops && cc->iv_gen_ops->dtr)
1085                 cc->iv_gen_ops->dtr(cc);
1086 bad_ivmode:
1087         crypto_free_ablkcipher(tfm);
1088 bad_cipher:
1089         /* Must zero key material before freeing */
1090         memset(cc, 0, sizeof(*cc) + cc->key_size * sizeof(u8));
1091         kfree(cc);
1092         return -EINVAL;
1093 }
1094
1095 static void crypt_dtr(struct dm_target *ti)
1096 {
1097         struct crypt_config *cc = (struct crypt_config *) ti->private;
1098
1099         destroy_workqueue(cc->io_queue);
1100         destroy_workqueue(cc->crypt_queue);
1101
1102         if (cc->req)
1103                 mempool_free(cc->req, cc->req_pool);
1104
1105         bioset_free(cc->bs);
1106         mempool_destroy(cc->page_pool);
1107         mempool_destroy(cc->req_pool);
1108         mempool_destroy(cc->io_pool);
1109
1110         kfree(cc->iv_mode);
1111         if (cc->iv_gen_ops && cc->iv_gen_ops->dtr)
1112                 cc->iv_gen_ops->dtr(cc);
1113         crypto_free_ablkcipher(cc->tfm);
1114         dm_put_device(ti, cc->dev);
1115
1116         /* Must zero key material before freeing */
1117         memset(cc, 0, sizeof(*cc) + cc->key_size * sizeof(u8));
1118         kfree(cc);
1119 }
1120
1121 static int crypt_map(struct dm_target *ti, struct bio *bio,
1122                      union map_info *map_context)
1123 {
1124         struct dm_crypt_io *io;
1125
1126         io = crypt_io_alloc(ti, bio, bio->bi_sector - ti->begin);
1127
1128         if (bio_data_dir(io->base_bio) == READ)
1129                 kcryptd_queue_io(io);
1130         else
1131                 kcryptd_queue_crypt(io);
1132
1133         return DM_MAPIO_SUBMITTED;
1134 }
1135
1136 static int crypt_status(struct dm_target *ti, status_type_t type,
1137                         char *result, unsigned int maxlen)
1138 {
1139         struct crypt_config *cc = (struct crypt_config *) ti->private;
1140         unsigned int sz = 0;
1141
1142         switch (type) {
1143         case STATUSTYPE_INFO:
1144                 result[0] = '\0';
1145                 break;
1146
1147         case STATUSTYPE_TABLE:
1148                 if (cc->iv_mode)
1149                         DMEMIT("%s-%s-%s ", cc->cipher, cc->chainmode,
1150                                cc->iv_mode);
1151                 else
1152                         DMEMIT("%s-%s ", cc->cipher, cc->chainmode);
1153
1154                 if (cc->key_size > 0) {
1155                         if ((maxlen - sz) < ((cc->key_size << 1) + 1))
1156                                 return -ENOMEM;
1157
1158                         crypt_encode_key(result + sz, cc->key, cc->key_size);
1159                         sz += cc->key_size << 1;
1160                 } else {
1161                         if (sz >= maxlen)
1162                                 return -ENOMEM;
1163                         result[sz++] = '-';
1164                 }
1165
1166                 DMEMIT(" %llu %s %llu", (unsigned long long)cc->iv_offset,
1167                                 cc->dev->name, (unsigned long long)cc->start);
1168                 break;
1169         }
1170         return 0;
1171 }
1172
1173 static void crypt_postsuspend(struct dm_target *ti)
1174 {
1175         struct crypt_config *cc = ti->private;
1176
1177         set_bit(DM_CRYPT_SUSPENDED, &cc->flags);
1178 }
1179
1180 static int crypt_preresume(struct dm_target *ti)
1181 {
1182         struct crypt_config *cc = ti->private;
1183
1184         if (!test_bit(DM_CRYPT_KEY_VALID, &cc->flags)) {
1185                 DMERR("aborting resume - crypt key is not set.");
1186                 return -EAGAIN;
1187         }
1188
1189         return 0;
1190 }
1191
1192 static void crypt_resume(struct dm_target *ti)
1193 {
1194         struct crypt_config *cc = ti->private;
1195
1196         clear_bit(DM_CRYPT_SUSPENDED, &cc->flags);
1197 }
1198
1199 /* Message interface
1200  *      key set <key>
1201  *      key wipe
1202  */
1203 static int crypt_message(struct dm_target *ti, unsigned argc, char **argv)
1204 {
1205         struct crypt_config *cc = ti->private;
1206
1207         if (argc < 2)
1208                 goto error;
1209
1210         if (!strnicmp(argv[0], MESG_STR("key"))) {
1211                 if (!test_bit(DM_CRYPT_SUSPENDED, &cc->flags)) {
1212                         DMWARN("not suspended during key manipulation.");
1213                         return -EINVAL;
1214                 }
1215                 if (argc == 3 && !strnicmp(argv[1], MESG_STR("set")))
1216                         return crypt_set_key(cc, argv[2]);
1217                 if (argc == 2 && !strnicmp(argv[1], MESG_STR("wipe")))
1218                         return crypt_wipe_key(cc);
1219         }
1220
1221 error:
1222         DMWARN("unrecognised message received.");
1223         return -EINVAL;
1224 }
1225
1226 static int crypt_merge(struct dm_target *ti, struct bvec_merge_data *bvm,
1227                        struct bio_vec *biovec, int max_size)
1228 {
1229         struct crypt_config *cc = ti->private;
1230         struct request_queue *q = bdev_get_queue(cc->dev->bdev);
1231
1232         if (!q->merge_bvec_fn)
1233                 return max_size;
1234
1235         bvm->bi_bdev = cc->dev->bdev;
1236         bvm->bi_sector = cc->start + bvm->bi_sector - ti->begin;
1237
1238         return min(max_size, q->merge_bvec_fn(q, bvm, biovec));
1239 }
1240
1241 static struct target_type crypt_target = {
1242         .name   = "crypt",
1243         .version= {1, 6, 0},
1244         .module = THIS_MODULE,
1245         .ctr    = crypt_ctr,
1246         .dtr    = crypt_dtr,
1247         .map    = crypt_map,
1248         .status = crypt_status,
1249         .postsuspend = crypt_postsuspend,
1250         .preresume = crypt_preresume,
1251         .resume = crypt_resume,
1252         .message = crypt_message,
1253         .merge  = crypt_merge,
1254 };
1255
1256 static int __init dm_crypt_init(void)
1257 {
1258         int r;
1259
1260         _crypt_io_pool = KMEM_CACHE(dm_crypt_io, 0);
1261         if (!_crypt_io_pool)
1262                 return -ENOMEM;
1263
1264         r = dm_register_target(&crypt_target);
1265         if (r < 0) {
1266                 DMERR("register failed %d", r);
1267                 kmem_cache_destroy(_crypt_io_pool);
1268         }
1269
1270         return r;
1271 }
1272
1273 static void __exit dm_crypt_exit(void)
1274 {
1275         int r = dm_unregister_target(&crypt_target);
1276
1277         if (r < 0)
1278                 DMERR("unregister failed %d", r);
1279
1280         kmem_cache_destroy(_crypt_io_pool);
1281 }
1282
1283 module_init(dm_crypt_init);
1284 module_exit(dm_crypt_exit);
1285
1286 MODULE_AUTHOR("Christophe Saout <christophe@saout.de>");
1287 MODULE_DESCRIPTION(DM_NAME " target for transparent encryption / decryption");
1288 MODULE_LICENSE("GPL");