4 * Glue code for the SHA512 Secure Hash Algorithm assembler
5 * implementation using supplemental SSE3 / AVX / AVX2 instructions.
7 * This file is based on sha512_generic.c
9 * Copyright (C) 2013 Intel Corporation
10 * Author: Tim Chen <tim.c.chen@linux.intel.com>
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 2 of the License, or (at your option)
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
21 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
22 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
30 #include <crypto/internal/hash.h>
31 #include <crypto/internal/simd.h>
32 #include <linux/init.h>
33 #include <linux/module.h>
35 #include <linux/cryptohash.h>
36 #include <linux/string.h>
37 #include <linux/types.h>
38 #include <crypto/sha.h>
39 #include <crypto/sha512_base.h>
42 asmlinkage void sha512_transform_ssse3(struct sha512_state *state,
43 const u8 *data, int blocks);
45 static int sha512_update(struct shash_desc *desc, const u8 *data,
46 unsigned int len, sha512_block_fn *sha512_xform)
48 struct sha512_state *sctx = shash_desc_ctx(desc);
50 if (!crypto_simd_usable() ||
51 (sctx->count[0] % SHA512_BLOCK_SIZE) + len < SHA512_BLOCK_SIZE)
52 return crypto_sha512_update(desc, data, len);
55 * Make sure struct sha512_state begins directly with the SHA512
56 * 512-bit internal state, as this is what the asm functions expect.
58 BUILD_BUG_ON(offsetof(struct sha512_state, state) != 0);
61 sha512_base_do_update(desc, data, len, sha512_xform);
67 static int sha512_finup(struct shash_desc *desc, const u8 *data,
68 unsigned int len, u8 *out, sha512_block_fn *sha512_xform)
70 if (!crypto_simd_usable())
71 return crypto_sha512_finup(desc, data, len, out);
75 sha512_base_do_update(desc, data, len, sha512_xform);
76 sha512_base_do_finalize(desc, sha512_xform);
79 return sha512_base_finish(desc, out);
82 static int sha512_ssse3_update(struct shash_desc *desc, const u8 *data,
85 return sha512_update(desc, data, len, sha512_transform_ssse3);
88 static int sha512_ssse3_finup(struct shash_desc *desc, const u8 *data,
89 unsigned int len, u8 *out)
91 return sha512_finup(desc, data, len, out, sha512_transform_ssse3);
94 /* Add padding and return the message digest. */
95 static int sha512_ssse3_final(struct shash_desc *desc, u8 *out)
97 return sha512_ssse3_finup(desc, NULL, 0, out);
100 static struct shash_alg sha512_ssse3_algs[] = { {
101 .digestsize = SHA512_DIGEST_SIZE,
102 .init = sha512_base_init,
103 .update = sha512_ssse3_update,
104 .final = sha512_ssse3_final,
105 .finup = sha512_ssse3_finup,
106 .descsize = sizeof(struct sha512_state),
108 .cra_name = "sha512",
109 .cra_driver_name = "sha512-ssse3",
111 .cra_blocksize = SHA512_BLOCK_SIZE,
112 .cra_module = THIS_MODULE,
115 .digestsize = SHA384_DIGEST_SIZE,
116 .init = sha384_base_init,
117 .update = sha512_ssse3_update,
118 .final = sha512_ssse3_final,
119 .finup = sha512_ssse3_finup,
120 .descsize = sizeof(struct sha512_state),
122 .cra_name = "sha384",
123 .cra_driver_name = "sha384-ssse3",
125 .cra_blocksize = SHA384_BLOCK_SIZE,
126 .cra_module = THIS_MODULE,
130 static int register_sha512_ssse3(void)
132 if (boot_cpu_has(X86_FEATURE_SSSE3))
133 return crypto_register_shashes(sha512_ssse3_algs,
134 ARRAY_SIZE(sha512_ssse3_algs));
138 static void unregister_sha512_ssse3(void)
140 if (boot_cpu_has(X86_FEATURE_SSSE3))
141 crypto_unregister_shashes(sha512_ssse3_algs,
142 ARRAY_SIZE(sha512_ssse3_algs));
146 asmlinkage void sha512_transform_avx(struct sha512_state *state,
147 const u8 *data, int blocks);
148 static bool avx_usable(void)
150 if (!cpu_has_xfeatures(XFEATURE_MASK_SSE | XFEATURE_MASK_YMM, NULL)) {
151 if (boot_cpu_has(X86_FEATURE_AVX))
152 pr_info("AVX detected but unusable.\n");
159 static int sha512_avx_update(struct shash_desc *desc, const u8 *data,
162 return sha512_update(desc, data, len, sha512_transform_avx);
165 static int sha512_avx_finup(struct shash_desc *desc, const u8 *data,
166 unsigned int len, u8 *out)
168 return sha512_finup(desc, data, len, out, sha512_transform_avx);
171 /* Add padding and return the message digest. */
172 static int sha512_avx_final(struct shash_desc *desc, u8 *out)
174 return sha512_avx_finup(desc, NULL, 0, out);
177 static struct shash_alg sha512_avx_algs[] = { {
178 .digestsize = SHA512_DIGEST_SIZE,
179 .init = sha512_base_init,
180 .update = sha512_avx_update,
181 .final = sha512_avx_final,
182 .finup = sha512_avx_finup,
183 .descsize = sizeof(struct sha512_state),
185 .cra_name = "sha512",
186 .cra_driver_name = "sha512-avx",
188 .cra_blocksize = SHA512_BLOCK_SIZE,
189 .cra_module = THIS_MODULE,
192 .digestsize = SHA384_DIGEST_SIZE,
193 .init = sha384_base_init,
194 .update = sha512_avx_update,
195 .final = sha512_avx_final,
196 .finup = sha512_avx_finup,
197 .descsize = sizeof(struct sha512_state),
199 .cra_name = "sha384",
200 .cra_driver_name = "sha384-avx",
202 .cra_blocksize = SHA384_BLOCK_SIZE,
203 .cra_module = THIS_MODULE,
207 static int register_sha512_avx(void)
210 return crypto_register_shashes(sha512_avx_algs,
211 ARRAY_SIZE(sha512_avx_algs));
215 static void unregister_sha512_avx(void)
218 crypto_unregister_shashes(sha512_avx_algs,
219 ARRAY_SIZE(sha512_avx_algs));
222 static inline int register_sha512_avx(void) { return 0; }
223 static inline void unregister_sha512_avx(void) { }
226 #if defined(CONFIG_AS_AVX2) && defined(CONFIG_AS_AVX)
227 asmlinkage void sha512_transform_rorx(struct sha512_state *state,
228 const u8 *data, int blocks);
230 static int sha512_avx2_update(struct shash_desc *desc, const u8 *data,
233 return sha512_update(desc, data, len, sha512_transform_rorx);
236 static int sha512_avx2_finup(struct shash_desc *desc, const u8 *data,
237 unsigned int len, u8 *out)
239 return sha512_finup(desc, data, len, out, sha512_transform_rorx);
242 /* Add padding and return the message digest. */
243 static int sha512_avx2_final(struct shash_desc *desc, u8 *out)
245 return sha512_avx2_finup(desc, NULL, 0, out);
248 static struct shash_alg sha512_avx2_algs[] = { {
249 .digestsize = SHA512_DIGEST_SIZE,
250 .init = sha512_base_init,
251 .update = sha512_avx2_update,
252 .final = sha512_avx2_final,
253 .finup = sha512_avx2_finup,
254 .descsize = sizeof(struct sha512_state),
256 .cra_name = "sha512",
257 .cra_driver_name = "sha512-avx2",
259 .cra_blocksize = SHA512_BLOCK_SIZE,
260 .cra_module = THIS_MODULE,
263 .digestsize = SHA384_DIGEST_SIZE,
264 .init = sha384_base_init,
265 .update = sha512_avx2_update,
266 .final = sha512_avx2_final,
267 .finup = sha512_avx2_finup,
268 .descsize = sizeof(struct sha512_state),
270 .cra_name = "sha384",
271 .cra_driver_name = "sha384-avx2",
273 .cra_blocksize = SHA384_BLOCK_SIZE,
274 .cra_module = THIS_MODULE,
278 static bool avx2_usable(void)
280 if (avx_usable() && boot_cpu_has(X86_FEATURE_AVX2) &&
281 boot_cpu_has(X86_FEATURE_BMI2))
287 static int register_sha512_avx2(void)
290 return crypto_register_shashes(sha512_avx2_algs,
291 ARRAY_SIZE(sha512_avx2_algs));
295 static void unregister_sha512_avx2(void)
298 crypto_unregister_shashes(sha512_avx2_algs,
299 ARRAY_SIZE(sha512_avx2_algs));
302 static inline int register_sha512_avx2(void) { return 0; }
303 static inline void unregister_sha512_avx2(void) { }
306 static int __init sha512_ssse3_mod_init(void)
309 if (register_sha512_ssse3())
312 if (register_sha512_avx()) {
313 unregister_sha512_ssse3();
317 if (register_sha512_avx2()) {
318 unregister_sha512_avx();
319 unregister_sha512_ssse3();
328 static void __exit sha512_ssse3_mod_fini(void)
330 unregister_sha512_avx2();
331 unregister_sha512_avx();
332 unregister_sha512_ssse3();
335 module_init(sha512_ssse3_mod_init);
336 module_exit(sha512_ssse3_mod_fini);
338 MODULE_LICENSE("GPL");
339 MODULE_DESCRIPTION("SHA512 Secure Hash Algorithm, Supplemental SSE3 accelerated");
341 MODULE_ALIAS_CRYPTO("sha512");
342 MODULE_ALIAS_CRYPTO("sha512-ssse3");
343 MODULE_ALIAS_CRYPTO("sha512-avx");
344 MODULE_ALIAS_CRYPTO("sha512-avx2");
345 MODULE_ALIAS_CRYPTO("sha384");
346 MODULE_ALIAS_CRYPTO("sha384-ssse3");
347 MODULE_ALIAS_CRYPTO("sha384-avx");
348 MODULE_ALIAS_CRYPTO("sha384-avx2");