arch/x86/crypto/sha256_ssse3_glue.c

   1 /*
   2  * Cryptographic API.
   3  *
   4  * Glue code for the SHA256 Secure Hash Algorithm assembler
   5  * implementation using supplemental SSE3 / AVX / AVX2 instructions.
   6  *
   7  * This file is based on sha256_generic.c
   8  *
   9  * Copyright (C) 2013 Intel Corporation.
  10  *
  11  * Author:
  12  *     Tim Chen <tim.c.chen@linux.intel.com>
  13  *
  14  * This program is free software; you can redistribute it and/or modify it
  15  * under the terms of the GNU General Public License as published by the Free
  16  * Software Foundation; either version 2 of the License, or (at your option)
  17  * any later version.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  20  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  22  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  23  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  24  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  25  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29
  30 #define pr_fmt(fmt)     KBUILD_MODNAME ": " fmt
  31
  32 #include <crypto/internal/hash.h>
  33 #include <crypto/internal/simd.h>
  34 #include <linux/init.h>
  35 #include <linux/module.h>
  36 #include <linux/mm.h>
  37 #include <linux/cryptohash.h>
  38 #include <linux/types.h>
  39 #include <crypto/sha.h>
  40 #include <crypto/sha256_base.h>
  41 #include <linux/string.h>
  42 #include <asm/simd.h>
  43
  44 asmlinkage void sha256_transform_ssse3(struct sha256_state *state,
  45                                        const u8 *data, int blocks);
  46
  47 static int _sha256_update(struct shash_desc *desc, const u8 *data,
  48                           unsigned int len, sha256_block_fn *sha256_xform)
  49 {
  50         struct sha256_state *sctx = shash_desc_ctx(desc);
  51
  52         if (!crypto_simd_usable() ||
  53             (sctx->count % SHA256_BLOCK_SIZE) + len < SHA256_BLOCK_SIZE)
  54                 return crypto_sha256_update(desc, data, len);
  55
  56         /*
  57          * Make sure struct sha256_state begins directly with the SHA256
  58          * 256-bit internal state, as this is what the asm functions expect.
  59          */
  60         BUILD_BUG_ON(offsetof(struct sha256_state, state) != 0);
  61
  62         kernel_fpu_begin();
  63         sha256_base_do_update(desc, data, len, sha256_xform);
  64         kernel_fpu_end();
  65
  66         return 0;
  67 }
  68
  69 static int sha256_finup(struct shash_desc *desc, const u8 *data,
  70               unsigned int len, u8 *out, sha256_block_fn *sha256_xform)
  71 {
  72         if (!crypto_simd_usable())
  73                 return crypto_sha256_finup(desc, data, len, out);
  74
  75         kernel_fpu_begin();
  76         if (len)
  77                 sha256_base_do_update(desc, data, len, sha256_xform);
  78         sha256_base_do_finalize(desc, sha256_xform);
  79         kernel_fpu_end();
  80
  81         return sha256_base_finish(desc, out);
  82 }
  83
  84 static int sha256_ssse3_update(struct shash_desc *desc, const u8 *data,
  85                          unsigned int len)
  86 {
  87         return _sha256_update(desc, data, len, sha256_transform_ssse3);
  88 }
  89
  90 static int sha256_ssse3_finup(struct shash_desc *desc, const u8 *data,
  91               unsigned int len, u8 *out)
  92 {
  93         return sha256_finup(desc, data, len, out, sha256_transform_ssse3);
  94 }
  95
  96 /* Add padding and return the message digest. */
  97 static int sha256_ssse3_final(struct shash_desc *desc, u8 *out)
  98 {
  99         return sha256_ssse3_finup(desc, NULL, 0, out);
 100 }
 101
 102 static struct shash_alg sha256_ssse3_algs[] = { {
 103         .digestsize     =       SHA256_DIGEST_SIZE,
 104         .init           =       sha256_base_init,
 105         .update         =       sha256_ssse3_update,
 106         .final          =       sha256_ssse3_final,
 107         .finup          =       sha256_ssse3_finup,
 108         .descsize       =       sizeof(struct sha256_state),
 109         .base           =       {
 110                 .cra_name       =       "sha256",
 111                 .cra_driver_name =      "sha256-ssse3",
 112                 .cra_priority   =       150,
 113                 .cra_blocksize  =       SHA256_BLOCK_SIZE,
 114                 .cra_module     =       THIS_MODULE,
 115         }
 116 }, {
 117         .digestsize     =       SHA224_DIGEST_SIZE,
 118         .init           =       sha224_base_init,
 119         .update         =       sha256_ssse3_update,
 120         .final          =       sha256_ssse3_final,
 121         .finup          =       sha256_ssse3_finup,
 122         .descsize       =       sizeof(struct sha256_state),
 123         .base           =       {
 124                 .cra_name       =       "sha224",
 125                 .cra_driver_name =      "sha224-ssse3",
 126                 .cra_priority   =       150,
 127                 .cra_blocksize  =       SHA224_BLOCK_SIZE,
 128                 .cra_module     =       THIS_MODULE,
 129         }
 130 } };
 131
 132 static int register_sha256_ssse3(void)
 133 {
 134         if (boot_cpu_has(X86_FEATURE_SSSE3))
 135                 return crypto_register_shashes(sha256_ssse3_algs,
 136                                 ARRAY_SIZE(sha256_ssse3_algs));
 137         return 0;
 138 }
 139
 140 static void unregister_sha256_ssse3(void)
 141 {
 142         if (boot_cpu_has(X86_FEATURE_SSSE3))
 143                 crypto_unregister_shashes(sha256_ssse3_algs,
 144                                 ARRAY_SIZE(sha256_ssse3_algs));
 145 }
 146
 147 asmlinkage void sha256_transform_avx(struct sha256_state *state,
 148                                      const u8 *data, int blocks);
 149
 150 static int sha256_avx_update(struct shash_desc *desc, const u8 *data,
 151                          unsigned int len)
 152 {
 153         return _sha256_update(desc, data, len, sha256_transform_avx);
 154 }
 155
 156 static int sha256_avx_finup(struct shash_desc *desc, const u8 *data,
 157                       unsigned int len, u8 *out)
 158 {
 159         return sha256_finup(desc, data, len, out, sha256_transform_avx);
 160 }
 161
 162 static int sha256_avx_final(struct shash_desc *desc, u8 *out)
 163 {
 164         return sha256_avx_finup(desc, NULL, 0, out);
 165 }
 166
 167 static struct shash_alg sha256_avx_algs[] = { {
 168         .digestsize     =       SHA256_DIGEST_SIZE,
 169         .init           =       sha256_base_init,
 170         .update         =       sha256_avx_update,
 171         .final          =       sha256_avx_final,
 172         .finup          =       sha256_avx_finup,
 173         .descsize       =       sizeof(struct sha256_state),
 174         .base           =       {
 175                 .cra_name       =       "sha256",
 176                 .cra_driver_name =      "sha256-avx",
 177                 .cra_priority   =       160,
 178                 .cra_blocksize  =       SHA256_BLOCK_SIZE,
 179                 .cra_module     =       THIS_MODULE,
 180         }
 181 }, {
 182         .digestsize     =       SHA224_DIGEST_SIZE,
 183         .init           =       sha224_base_init,
 184         .update         =       sha256_avx_update,
 185         .final          =       sha256_avx_final,
 186         .finup          =       sha256_avx_finup,
 187         .descsize       =       sizeof(struct sha256_state),
 188         .base           =       {
 189                 .cra_name       =       "sha224",
 190                 .cra_driver_name =      "sha224-avx",
 191                 .cra_priority   =       160,
 192                 .cra_blocksize  =       SHA224_BLOCK_SIZE,
 193                 .cra_module     =       THIS_MODULE,
 194         }
 195 } };
 196
 197 static bool avx_usable(void)
 198 {
 199         if (!cpu_has_xfeatures(XFEATURE_MASK_SSE | XFEATURE_MASK_YMM, NULL)) {
 200                 if (boot_cpu_has(X86_FEATURE_AVX))
 201                         pr_info("AVX detected but unusable.\n");
 202                 return false;
 203         }
 204
 205         return true;
 206 }
 207
 208 static int register_sha256_avx(void)
 209 {
 210         if (avx_usable())
 211                 return crypto_register_shashes(sha256_avx_algs,
 212                                 ARRAY_SIZE(sha256_avx_algs));
 213         return 0;
 214 }
 215
 216 static void unregister_sha256_avx(void)
 217 {
 218         if (avx_usable())
 219                 crypto_unregister_shashes(sha256_avx_algs,
 220                                 ARRAY_SIZE(sha256_avx_algs));
 221 }
 222
 223 #if defined(CONFIG_AS_AVX2)
 224 asmlinkage void sha256_transform_rorx(struct sha256_state *state,
 225                                       const u8 *data, int blocks);
 226
 227 static int sha256_avx2_update(struct shash_desc *desc, const u8 *data,
 228                          unsigned int len)
 229 {
 230         return _sha256_update(desc, data, len, sha256_transform_rorx);
 231 }
 232
 233 static int sha256_avx2_finup(struct shash_desc *desc, const u8 *data,
 234                       unsigned int len, u8 *out)
 235 {
 236         return sha256_finup(desc, data, len, out, sha256_transform_rorx);
 237 }
 238
 239 static int sha256_avx2_final(struct shash_desc *desc, u8 *out)
 240 {
 241         return sha256_avx2_finup(desc, NULL, 0, out);
 242 }
 243
 244 static struct shash_alg sha256_avx2_algs[] = { {
 245         .digestsize     =       SHA256_DIGEST_SIZE,
 246         .init           =       sha256_base_init,
 247         .update         =       sha256_avx2_update,
 248         .final          =       sha256_avx2_final,
 249         .finup          =       sha256_avx2_finup,
 250         .descsize       =       sizeof(struct sha256_state),
 251         .base           =       {
 252                 .cra_name       =       "sha256",
 253                 .cra_driver_name =      "sha256-avx2",
 254                 .cra_priority   =       170,
 255                 .cra_blocksize  =       SHA256_BLOCK_SIZE,
 256                 .cra_module     =       THIS_MODULE,
 257         }
 258 }, {
 259         .digestsize     =       SHA224_DIGEST_SIZE,
 260         .init           =       sha224_base_init,
 261         .update         =       sha256_avx2_update,
 262         .final          =       sha256_avx2_final,
 263         .finup          =       sha256_avx2_finup,
 264         .descsize       =       sizeof(struct sha256_state),
 265         .base           =       {
 266                 .cra_name       =       "sha224",
 267                 .cra_driver_name =      "sha224-avx2",
 268                 .cra_priority   =       170,
 269                 .cra_blocksize  =       SHA224_BLOCK_SIZE,
 270                 .cra_module     =       THIS_MODULE,
 271         }
 272 } };
 273
 274 static bool avx2_usable(void)
 275 {
 276         if (avx_usable() && boot_cpu_has(X86_FEATURE_AVX2) &&
 277                     boot_cpu_has(X86_FEATURE_BMI2))
 278                 return true;
 279
 280         return false;
 281 }
 282
 283 static int register_sha256_avx2(void)
 284 {
 285         if (avx2_usable())
 286                 return crypto_register_shashes(sha256_avx2_algs,
 287                                 ARRAY_SIZE(sha256_avx2_algs));
 288         return 0;
 289 }
 290
 291 static void unregister_sha256_avx2(void)
 292 {
 293         if (avx2_usable())
 294                 crypto_unregister_shashes(sha256_avx2_algs,
 295                                 ARRAY_SIZE(sha256_avx2_algs));
 296 }
 297
 298 #else
 299 static inline int register_sha256_avx2(void) { return 0; }
 300 static inline void unregister_sha256_avx2(void) { }
 301 #endif
 302
 303 #ifdef CONFIG_AS_SHA256_NI
 304 asmlinkage void sha256_ni_transform(struct sha256_state *digest,
 305                                     const u8 *data, int rounds);
 306
 307 static int sha256_ni_update(struct shash_desc *desc, const u8 *data,
 308                          unsigned int len)
 309 {
 310         return _sha256_update(desc, data, len, sha256_ni_transform);
 311 }
 312
 313 static int sha256_ni_finup(struct shash_desc *desc, const u8 *data,
 314                       unsigned int len, u8 *out)
 315 {
 316         return sha256_finup(desc, data, len, out, sha256_ni_transform);
 317 }
 318
 319 static int sha256_ni_final(struct shash_desc *desc, u8 *out)
 320 {
 321         return sha256_ni_finup(desc, NULL, 0, out);
 322 }
 323
 324 static struct shash_alg sha256_ni_algs[] = { {
 325         .digestsize     =       SHA256_DIGEST_SIZE,
 326         .init           =       sha256_base_init,
 327         .update         =       sha256_ni_update,
 328         .final          =       sha256_ni_final,
 329         .finup          =       sha256_ni_finup,
 330         .descsize       =       sizeof(struct sha256_state),
 331         .base           =       {
 332                 .cra_name       =       "sha256",
 333                 .cra_driver_name =      "sha256-ni",
 334                 .cra_priority   =       250,
 335                 .cra_blocksize  =       SHA256_BLOCK_SIZE,
 336                 .cra_module     =       THIS_MODULE,
 337         }
 338 }, {
 339         .digestsize     =       SHA224_DIGEST_SIZE,
 340         .init           =       sha224_base_init,
 341         .update         =       sha256_ni_update,
 342         .final          =       sha256_ni_final,
 343         .finup          =       sha256_ni_finup,
 344         .descsize       =       sizeof(struct sha256_state),
 345         .base           =       {
 346                 .cra_name       =       "sha224",
 347                 .cra_driver_name =      "sha224-ni",
 348                 .cra_priority   =       250,
 349                 .cra_blocksize  =       SHA224_BLOCK_SIZE,
 350                 .cra_module     =       THIS_MODULE,
 351         }
 352 } };
 353
 354 static int register_sha256_ni(void)
 355 {
 356         if (boot_cpu_has(X86_FEATURE_SHA_NI))
 357                 return crypto_register_shashes(sha256_ni_algs,
 358                                 ARRAY_SIZE(sha256_ni_algs));
 359         return 0;
 360 }
 361
 362 static void unregister_sha256_ni(void)
 363 {
 364         if (boot_cpu_has(X86_FEATURE_SHA_NI))
 365                 crypto_unregister_shashes(sha256_ni_algs,
 366                                 ARRAY_SIZE(sha256_ni_algs));
 367 }
 368
 369 #else
 370 static inline int register_sha256_ni(void) { return 0; }
 371 static inline void unregister_sha256_ni(void) { }
 372 #endif
 373
 374 static int __init sha256_ssse3_mod_init(void)
 375 {
 376         if (register_sha256_ssse3())
 377                 goto fail;
 378
 379         if (register_sha256_avx()) {
 380                 unregister_sha256_ssse3();
 381                 goto fail;
 382         }
 383
 384         if (register_sha256_avx2()) {
 385                 unregister_sha256_avx();
 386                 unregister_sha256_ssse3();
 387                 goto fail;
 388         }
 389
 390         if (register_sha256_ni()) {
 391                 unregister_sha256_avx2();
 392                 unregister_sha256_avx();
 393                 unregister_sha256_ssse3();
 394                 goto fail;
 395         }
 396
 397         return 0;
 398 fail:
 399         return -ENODEV;
 400 }
 401
 402 static void __exit sha256_ssse3_mod_fini(void)
 403 {
 404         unregister_sha256_ni();
 405         unregister_sha256_avx2();
 406         unregister_sha256_avx();
 407         unregister_sha256_ssse3();
 408 }
 409
 410 module_init(sha256_ssse3_mod_init);
 411 module_exit(sha256_ssse3_mod_fini);
 412
 413 MODULE_LICENSE("GPL");
 414 MODULE_DESCRIPTION("SHA256 Secure Hash Algorithm, Supplemental SSE3 accelerated");
 415
 416 MODULE_ALIAS_CRYPTO("sha256");
 417 MODULE_ALIAS_CRYPTO("sha256-ssse3");
 418 MODULE_ALIAS_CRYPTO("sha256-avx");
 419 MODULE_ALIAS_CRYPTO("sha256-avx2");
 420 MODULE_ALIAS_CRYPTO("sha224");
 421 MODULE_ALIAS_CRYPTO("sha224-ssse3");
 422 MODULE_ALIAS_CRYPTO("sha224-avx");
 423 MODULE_ALIAS_CRYPTO("sha224-avx2");
 424 #ifdef CONFIG_AS_SHA256_NI
 425 MODULE_ALIAS_CRYPTO("sha256-ni");
 426 MODULE_ALIAS_CRYPTO("sha224-ni");
 427 #endif