crypto/pcrypt.c

   1 /*
   2  * pcrypt - Parallel crypto wrapper.
   3  *
   4  * Copyright (C) 2009 secunet Security Networks AG
   5  * Copyright (C) 2009 Steffen Klassert <steffen.klassert@secunet.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms and conditions of the GNU General Public License,
   9  * version 2, as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14  * more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with
  17  * this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 #include <crypto/algapi.h>
  22 #include <crypto/internal/aead.h>
  23 #include <linux/atomic.h>
  24 #include <linux/err.h>
  25 #include <linux/init.h>
  26 #include <linux/module.h>
  27 #include <linux/slab.h>
  28 #include <linux/notifier.h>
  29 #include <linux/kobject.h>
  30 #include <linux/cpu.h>
  31 #include <crypto/pcrypt.h>
  32
  33 struct padata_pcrypt {
  34         struct padata_instance *pinst;
  35         struct workqueue_struct *wq;
  36
  37         /*
  38          * Cpumask for callback CPUs. It should be
  39          * equal to serial cpumask of corresponding padata instance,
  40          * so it is updated when padata notifies us about serial
  41          * cpumask change.
  42          *
  43          * cb_cpumask is protected by RCU. This fact prevents us from
  44          * using cpumask_var_t directly because the actual type of
  45          * cpumsak_var_t depends on kernel configuration(particularly on
  46          * CONFIG_CPUMASK_OFFSTACK macro). Depending on the configuration
  47          * cpumask_var_t may be either a pointer to the struct cpumask
  48          * or a variable allocated on the stack. Thus we can not safely use
  49          * cpumask_var_t with RCU operations such as rcu_assign_pointer or
  50          * rcu_dereference. So cpumask_var_t is wrapped with struct
  51          * pcrypt_cpumask which makes possible to use it with RCU.
  52          */
  53         struct pcrypt_cpumask {
  54                 cpumask_var_t mask;
  55         } *cb_cpumask;
  56         struct notifier_block nblock;
  57 };
  58
  59 static struct padata_pcrypt pencrypt;
  60 static struct padata_pcrypt pdecrypt;
  61 static struct kset           *pcrypt_kset;
  62
  63 struct pcrypt_instance_ctx {
  64         struct crypto_aead_spawn spawn;
  65         atomic_t tfm_count;
  66 };
  67
  68 struct pcrypt_aead_ctx {
  69         struct crypto_aead *child;
  70         unsigned int cb_cpu;
  71 };
  72
  73 static int pcrypt_do_parallel(struct padata_priv *padata, unsigned int *cb_cpu,
  74                               struct padata_pcrypt *pcrypt)
  75 {
  76         unsigned int cpu_index, cpu, i;
  77         struct pcrypt_cpumask *cpumask;
  78
  79         cpu = *cb_cpu;
  80
  81         rcu_read_lock_bh();
  82         cpumask = rcu_dereference_bh(pcrypt->cb_cpumask);
  83         if (cpumask_test_cpu(cpu, cpumask->mask))
  84                         goto out;
  85
  86         if (!cpumask_weight(cpumask->mask))
  87                         goto out;
  88
  89         cpu_index = cpu % cpumask_weight(cpumask->mask);
  90
  91         cpu = cpumask_first(cpumask->mask);
  92         for (i = 0; i < cpu_index; i++)
  93                 cpu = cpumask_next(cpu, cpumask->mask);
  94
  95         *cb_cpu = cpu;
  96
  97 out:
  98         rcu_read_unlock_bh();
  99         return padata_do_parallel(pcrypt->pinst, padata, cpu);
 100 }
 101
 102 static int pcrypt_aead_setkey(struct crypto_aead *parent,
 103                               const u8 *key, unsigned int keylen)
 104 {
 105         struct pcrypt_aead_ctx *ctx = crypto_aead_ctx(parent);
 106
 107         return crypto_aead_setkey(ctx->child, key, keylen);
 108 }
 109
 110 static int pcrypt_aead_setauthsize(struct crypto_aead *parent,
 111                                    unsigned int authsize)
 112 {
 113         struct pcrypt_aead_ctx *ctx = crypto_aead_ctx(parent);
 114
 115         return crypto_aead_setauthsize(ctx->child, authsize);
 116 }
 117
 118 static void pcrypt_aead_serial(struct padata_priv *padata)
 119 {
 120         struct pcrypt_request *preq = pcrypt_padata_request(padata);
 121         struct aead_request *req = pcrypt_request_ctx(preq);
 122
 123         aead_request_complete(req->base.data, padata->info);
 124 }
 125
 126 static void pcrypt_aead_done(struct crypto_async_request *areq, int err)
 127 {
 128         struct aead_request *req = areq->data;
 129         struct pcrypt_request *preq = aead_request_ctx(req);
 130         struct padata_priv *padata = pcrypt_request_padata(preq);
 131
 132         padata->info = err;
 133
 134         padata_do_serial(padata);
 135 }
 136
 137 static void pcrypt_aead_enc(struct padata_priv *padata)
 138 {
 139         struct pcrypt_request *preq = pcrypt_padata_request(padata);
 140         struct aead_request *req = pcrypt_request_ctx(preq);
 141         int ret;
 142
 143         ret = crypto_aead_encrypt(req);
 144
 145         if (ret == -EINPROGRESS)
 146                 return;
 147
 148         padata->info = ret;
 149         padata_do_serial(padata);
 150 }
 151
 152 static int pcrypt_aead_encrypt(struct aead_request *req)
 153 {
 154         int err;
 155         struct pcrypt_request *preq = aead_request_ctx(req);
 156         struct aead_request *creq = pcrypt_request_ctx(preq);
 157         struct padata_priv *padata = pcrypt_request_padata(preq);
 158         struct crypto_aead *aead = crypto_aead_reqtfm(req);
 159         struct pcrypt_aead_ctx *ctx = crypto_aead_ctx(aead);
 160         u32 flags = aead_request_flags(req);
 161
 162         memset(padata, 0, sizeof(struct padata_priv));
 163
 164         padata->parallel = pcrypt_aead_enc;
 165         padata->serial = pcrypt_aead_serial;
 166
 167         aead_request_set_tfm(creq, ctx->child);
 168         aead_request_set_callback(creq, flags & ~CRYPTO_TFM_REQ_MAY_SLEEP,
 169                                   pcrypt_aead_done, req);
 170         aead_request_set_crypt(creq, req->src, req->dst,
 171                                req->cryptlen, req->iv);
 172         aead_request_set_ad(creq, req->assoclen);
 173
 174         err = pcrypt_do_parallel(padata, &ctx->cb_cpu, &pencrypt);
 175         if (!err)
 176                 return -EINPROGRESS;
 177         if (err == -EBUSY)
 178                 return -EAGAIN;
 179
 180         return err;
 181 }
 182
 183 static void pcrypt_aead_dec(struct padata_priv *padata)
 184 {
 185         struct pcrypt_request *preq = pcrypt_padata_request(padata);
 186         struct aead_request *req = pcrypt_request_ctx(preq);
 187         int ret;
 188
 189         ret = crypto_aead_decrypt(req);
 190
 191         if (ret == -EINPROGRESS)
 192                 return;
 193
 194         padata->info = ret;
 195         padata_do_serial(padata);
 196 }
 197
 198 static int pcrypt_aead_decrypt(struct aead_request *req)
 199 {
 200         int err;
 201         struct pcrypt_request *preq = aead_request_ctx(req);
 202         struct aead_request *creq = pcrypt_request_ctx(preq);
 203         struct padata_priv *padata = pcrypt_request_padata(preq);
 204         struct crypto_aead *aead = crypto_aead_reqtfm(req);
 205         struct pcrypt_aead_ctx *ctx = crypto_aead_ctx(aead);
 206         u32 flags = aead_request_flags(req);
 207
 208         memset(padata, 0, sizeof(struct padata_priv));
 209
 210         padata->parallel = pcrypt_aead_dec;
 211         padata->serial = pcrypt_aead_serial;
 212
 213         aead_request_set_tfm(creq, ctx->child);
 214         aead_request_set_callback(creq, flags & ~CRYPTO_TFM_REQ_MAY_SLEEP,
 215                                   pcrypt_aead_done, req);
 216         aead_request_set_crypt(creq, req->src, req->dst,
 217                                req->cryptlen, req->iv);
 218         aead_request_set_ad(creq, req->assoclen);
 219
 220         err = pcrypt_do_parallel(padata, &ctx->cb_cpu, &pdecrypt);
 221         if (!err)
 222                 return -EINPROGRESS;
 223         if (err == -EBUSY)
 224                 return -EAGAIN;
 225
 226         return err;
 227 }
 228
 229 static int pcrypt_aead_init_tfm(struct crypto_aead *tfm)
 230 {
 231         int cpu, cpu_index;
 232         struct aead_instance *inst = aead_alg_instance(tfm);
 233         struct pcrypt_instance_ctx *ictx = aead_instance_ctx(inst);
 234         struct pcrypt_aead_ctx *ctx = crypto_aead_ctx(tfm);
 235         struct crypto_aead *cipher;
 236
 237         cpu_index = (unsigned int)atomic_inc_return(&ictx->tfm_count) %
 238                     cpumask_weight(cpu_online_mask);
 239
 240         ctx->cb_cpu = cpumask_first(cpu_online_mask);
 241         for (cpu = 0; cpu < cpu_index; cpu++)
 242                 ctx->cb_cpu = cpumask_next(ctx->cb_cpu, cpu_online_mask);
 243
 244         cipher = crypto_spawn_aead(&ictx->spawn);
 245
 246         if (IS_ERR(cipher))
 247                 return PTR_ERR(cipher);
 248
 249         ctx->child = cipher;
 250         crypto_aead_set_reqsize(tfm, sizeof(struct pcrypt_request) +
 251                                      sizeof(struct aead_request) +
 252                                      crypto_aead_reqsize(cipher));
 253
 254         return 0;
 255 }
 256
 257 static void pcrypt_aead_exit_tfm(struct crypto_aead *tfm)
 258 {
 259         struct pcrypt_aead_ctx *ctx = crypto_aead_ctx(tfm);
 260
 261         crypto_free_aead(ctx->child);
 262 }
 263
 264 static void pcrypt_free(struct aead_instance *inst)
 265 {
 266         struct pcrypt_instance_ctx *ctx = aead_instance_ctx(inst);
 267
 268         crypto_drop_aead(&ctx->spawn);
 269         kfree(inst);
 270 }
 271
 272 static int pcrypt_init_instance(struct crypto_instance *inst,
 273                                 struct crypto_alg *alg)
 274 {
 275         if (snprintf(inst->alg.cra_driver_name, CRYPTO_MAX_ALG_NAME,
 276                      "pcrypt(%s)", alg->cra_driver_name) >= CRYPTO_MAX_ALG_NAME)
 277                 return -ENAMETOOLONG;
 278
 279         memcpy(inst->alg.cra_name, alg->cra_name, CRYPTO_MAX_ALG_NAME);
 280
 281         inst->alg.cra_priority = alg->cra_priority + 100;
 282         inst->alg.cra_blocksize = alg->cra_blocksize;
 283         inst->alg.cra_alignmask = alg->cra_alignmask;
 284
 285         return 0;
 286 }
 287
 288 static int pcrypt_create_aead(struct crypto_template *tmpl, struct rtattr **tb,
 289                               u32 type, u32 mask)
 290 {
 291         struct pcrypt_instance_ctx *ctx;
 292         struct crypto_attr_type *algt;
 293         struct aead_instance *inst;
 294         struct aead_alg *alg;
 295         const char *name;
 296         int err;
 297
 298         algt = crypto_get_attr_type(tb);
 299         if (IS_ERR(algt))
 300                 return PTR_ERR(algt);
 301
 302         name = crypto_attr_alg_name(tb[1]);
 303         if (IS_ERR(name))
 304                 return PTR_ERR(name);
 305
 306         inst = kzalloc(sizeof(*inst) + sizeof(*ctx), GFP_KERNEL);
 307         if (!inst)
 308                 return -ENOMEM;
 309
 310         ctx = aead_instance_ctx(inst);
 311         crypto_set_aead_spawn(&ctx->spawn, aead_crypto_instance(inst));
 312
 313         err = crypto_grab_aead(&ctx->spawn, name, 0, 0);
 314         if (err)
 315                 goto out_free_inst;
 316
 317         alg = crypto_spawn_aead_alg(&ctx->spawn);
 318         err = pcrypt_init_instance(aead_crypto_instance(inst), &alg->base);
 319         if (err)
 320                 goto out_drop_aead;
 321
 322         inst->alg.base.cra_flags = CRYPTO_ALG_ASYNC;
 323
 324         inst->alg.ivsize = crypto_aead_alg_ivsize(alg);
 325         inst->alg.maxauthsize = crypto_aead_alg_maxauthsize(alg);
 326
 327         inst->alg.base.cra_ctxsize = sizeof(struct pcrypt_aead_ctx);
 328
 329         inst->alg.init = pcrypt_aead_init_tfm;
 330         inst->alg.exit = pcrypt_aead_exit_tfm;
 331
 332         inst->alg.setkey = pcrypt_aead_setkey;
 333         inst->alg.setauthsize = pcrypt_aead_setauthsize;
 334         inst->alg.encrypt = pcrypt_aead_encrypt;
 335         inst->alg.decrypt = pcrypt_aead_decrypt;
 336
 337         inst->free = pcrypt_free;
 338
 339         err = aead_register_instance(tmpl, inst);
 340         if (err)
 341                 goto out_drop_aead;
 342
 343 out:
 344         return err;
 345
 346 out_drop_aead:
 347         crypto_drop_aead(&ctx->spawn);
 348 out_free_inst:
 349         kfree(inst);
 350         goto out;
 351 }
 352
 353 static int pcrypt_create(struct crypto_template *tmpl, struct rtattr **tb)
 354 {
 355         struct crypto_attr_type *algt;
 356
 357         algt = crypto_get_attr_type(tb);
 358         if (IS_ERR(algt))
 359                 return PTR_ERR(algt);
 360
 361         switch (algt->type & algt->mask & CRYPTO_ALG_TYPE_MASK) {
 362         case CRYPTO_ALG_TYPE_AEAD:
 363                 return pcrypt_create_aead(tmpl, tb, algt->type, algt->mask);
 364         }
 365
 366         return -EINVAL;
 367 }
 368
 369 static int pcrypt_cpumask_change_notify(struct notifier_block *self,
 370                                         unsigned long val, void *data)
 371 {
 372         struct padata_pcrypt *pcrypt;
 373         struct pcrypt_cpumask *new_mask, *old_mask;
 374         struct padata_cpumask *cpumask = (struct padata_cpumask *)data;
 375
 376         if (!(val & PADATA_CPU_SERIAL))
 377                 return 0;
 378
 379         pcrypt = container_of(self, struct padata_pcrypt, nblock);
 380         new_mask = kmalloc(sizeof(*new_mask), GFP_KERNEL);
 381         if (!new_mask)
 382                 return -ENOMEM;
 383         if (!alloc_cpumask_var(&new_mask->mask, GFP_KERNEL)) {
 384                 kfree(new_mask);
 385                 return -ENOMEM;
 386         }
 387
 388         old_mask = pcrypt->cb_cpumask;
 389
 390         cpumask_copy(new_mask->mask, cpumask->cbcpu);
 391         rcu_assign_pointer(pcrypt->cb_cpumask, new_mask);
 392         synchronize_rcu_bh();
 393
 394         free_cpumask_var(old_mask->mask);
 395         kfree(old_mask);
 396         return 0;
 397 }
 398
 399 static int pcrypt_sysfs_add(struct padata_instance *pinst, const char *name)
 400 {
 401         int ret;
 402
 403         pinst->kobj.kset = pcrypt_kset;
 404         ret = kobject_add(&pinst->kobj, NULL, "%s", name);
 405         if (!ret)
 406                 kobject_uevent(&pinst->kobj, KOBJ_ADD);
 407
 408         return ret;
 409 }
 410
 411 static int pcrypt_init_padata(struct padata_pcrypt *pcrypt,
 412                               const char *name)
 413 {
 414         int ret = -ENOMEM;
 415         struct pcrypt_cpumask *mask;
 416
 417         get_online_cpus();
 418
 419         pcrypt->wq = alloc_workqueue("%s", WQ_MEM_RECLAIM | WQ_CPU_INTENSIVE,
 420                                      1, name);
 421         if (!pcrypt->wq)
 422                 goto err;
 423
 424         pcrypt->pinst = padata_alloc_possible(pcrypt->wq);
 425         if (!pcrypt->pinst)
 426                 goto err_destroy_workqueue;
 427
 428         mask = kmalloc(sizeof(*mask), GFP_KERNEL);
 429         if (!mask)
 430                 goto err_free_padata;
 431         if (!alloc_cpumask_var(&mask->mask, GFP_KERNEL)) {
 432                 kfree(mask);
 433                 goto err_free_padata;
 434         }
 435
 436         cpumask_and(mask->mask, cpu_possible_mask, cpu_online_mask);
 437         rcu_assign_pointer(pcrypt->cb_cpumask, mask);
 438
 439         pcrypt->nblock.notifier_call = pcrypt_cpumask_change_notify;
 440         ret = padata_register_cpumask_notifier(pcrypt->pinst, &pcrypt->nblock);
 441         if (ret)
 442                 goto err_free_cpumask;
 443
 444         ret = pcrypt_sysfs_add(pcrypt->pinst, name);
 445         if (ret)
 446                 goto err_unregister_notifier;
 447
 448         put_online_cpus();
 449
 450         return ret;
 451
 452 err_unregister_notifier:
 453         padata_unregister_cpumask_notifier(pcrypt->pinst, &pcrypt->nblock);
 454 err_free_cpumask:
 455         free_cpumask_var(mask->mask);
 456         kfree(mask);
 457 err_free_padata:
 458         padata_free(pcrypt->pinst);
 459 err_destroy_workqueue:
 460         destroy_workqueue(pcrypt->wq);
 461 err:
 462         put_online_cpus();
 463
 464         return ret;
 465 }
 466
 467 static void pcrypt_fini_padata(struct padata_pcrypt *pcrypt)
 468 {
 469         free_cpumask_var(pcrypt->cb_cpumask->mask);
 470         kfree(pcrypt->cb_cpumask);
 471
 472         padata_stop(pcrypt->pinst);
 473         padata_unregister_cpumask_notifier(pcrypt->pinst, &pcrypt->nblock);
 474         destroy_workqueue(pcrypt->wq);
 475         padata_free(pcrypt->pinst);
 476 }
 477
 478 static struct crypto_template pcrypt_tmpl = {
 479         .name = "pcrypt",
 480         .create = pcrypt_create,
 481         .module = THIS_MODULE,
 482 };
 483
 484 static int __init pcrypt_init(void)
 485 {
 486         int err = -ENOMEM;
 487
 488         pcrypt_kset = kset_create_and_add("pcrypt", NULL, kernel_kobj);
 489         if (!pcrypt_kset)
 490                 goto err;
 491
 492         err = pcrypt_init_padata(&pencrypt, "pencrypt");
 493         if (err)
 494                 goto err_unreg_kset;
 495
 496         err = pcrypt_init_padata(&pdecrypt, "pdecrypt");
 497         if (err)
 498                 goto err_deinit_pencrypt;
 499
 500         padata_start(pencrypt.pinst);
 501         padata_start(pdecrypt.pinst);
 502
 503         return crypto_register_template(&pcrypt_tmpl);
 504
 505 err_deinit_pencrypt:
 506         pcrypt_fini_padata(&pencrypt);
 507 err_unreg_kset:
 508         kset_unregister(pcrypt_kset);
 509 err:
 510         return err;
 511 }
 512
 513 static void __exit pcrypt_exit(void)
 514 {
 515         crypto_unregister_template(&pcrypt_tmpl);
 516
 517         pcrypt_fini_padata(&pencrypt);
 518         pcrypt_fini_padata(&pdecrypt);
 519
 520         kset_unregister(pcrypt_kset);
 521 }
 522
 523 module_init(pcrypt_init);
 524 module_exit(pcrypt_exit);
 525
 526 MODULE_LICENSE("GPL");
 527 MODULE_AUTHOR("Steffen Klassert <steffen.klassert@secunet.com>");
 528 MODULE_DESCRIPTION("Parallel crypto wrapper");
 529 MODULE_ALIAS_CRYPTO("pcrypt");