3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License version 2 for more details (a copy is included
13 * in the LICENSE file that accompanied this code).
15 * You should have received a copy of the GNU General Public License
16 * version 2 along with this program; If not, see http://www.gnu.org/licenses
18 * Please visit http://www.xyratex.com/contact if you need additional
19 * information or have any questions.
25 * Copyright 2012 Xyratex Technology Limited
27 * Copyright (c) 2012, Intel Corporation.
30 #include <crypto/hash.h>
31 #include <linux/scatterlist.h>
32 #include "../../../include/linux/libcfs/libcfs.h"
33 #include "../../../include/linux/libcfs/libcfs_crypto.h"
34 #include "linux-crypto.h"
37 * Array of hash algorithm speed in MByte per second
39 static int cfs_crypto_hash_speeds
[CFS_HASH_ALG_MAX
];
42 * Initialize the state descriptor for the specified hash algorithm.
44 * An internal routine to allocate the hash-specific state in \a hdesc for
45 * use with cfs_crypto_hash_digest() to compute the hash of a single message,
46 * though possibly in multiple chunks. The descriptor internal state should
47 * be freed with cfs_crypto_hash_final().
49 * \param[in] hash_alg hash algorithm id (CFS_HASH_ALG_*)
50 * \param[out] type pointer to the hash description in hash_types[]
52 * \param[in,out] hdesc hash state descriptor to be initialized
53 * \param[in] key initial hash value/state, NULL to use default
55 * \param[in] key_len length of \a key
57 * \retval 0 on success
58 * \retval negative errno on failure
60 static int cfs_crypto_hash_alloc(enum cfs_crypto_hash_alg hash_alg
,
61 const struct cfs_crypto_hash_type
**type
,
62 struct ahash_request
**req
,
66 struct crypto_ahash
*tfm
;
69 *type
= cfs_crypto_hash_type(hash_alg
);
72 CWARN("Unsupported hash algorithm id = %d, max id is %d\n",
73 hash_alg
, CFS_HASH_ALG_MAX
);
76 tfm
= crypto_alloc_ahash((*type
)->cht_name
, 0, CRYPTO_ALG_ASYNC
);
79 CDEBUG(D_INFO
, "Failed to alloc crypto hash %s\n",
84 *req
= ahash_request_alloc(tfm
, GFP_KERNEL
);
86 CDEBUG(D_INFO
, "Failed to alloc ahash_request for %s\n",
88 crypto_free_ahash(tfm
);
92 ahash_request_set_callback(*req
, 0, NULL
, NULL
);
95 err
= crypto_ahash_setkey(tfm
, key
, key_len
);
96 else if ((*type
)->cht_key
!= 0)
97 err
= crypto_ahash_setkey(tfm
,
98 (unsigned char *)&((*type
)->cht_key
),
102 ahash_request_free(*req
);
103 crypto_free_ahash(tfm
);
107 CDEBUG(D_INFO
, "Using crypto hash: %s (%s) speed %d MB/s\n",
108 crypto_ahash_alg_name(tfm
), crypto_ahash_driver_name(tfm
),
109 cfs_crypto_hash_speeds
[hash_alg
]);
111 err
= crypto_ahash_init(*req
);
113 ahash_request_free(*req
);
114 crypto_free_ahash(tfm
);
120 * Calculate hash digest for the passed buffer.
122 * This should be used when computing the hash on a single contiguous buffer.
123 * It combines the hash initialization, computation, and cleanup.
125 * \param[in] hash_alg id of hash algorithm (CFS_HASH_ALG_*)
126 * \param[in] buf data buffer on which to compute hash
127 * \param[in] buf_len length of \a buf in bytes
128 * \param[in] key initial value/state for algorithm,
129 * if \a key = NULL use default initial value
130 * \param[in] key_len length of \a key in bytes
131 * \param[out] hash pointer to computed hash value,
132 * if \a hash = NULL then \a hash_len is to digest
133 * size in bytes, retval -ENOSPC
134 * \param[in,out] hash_len size of \a hash buffer
136 * \retval -EINVAL \a buf, \a buf_len, \a hash_len,
137 * \a hash_alg invalid
138 * \retval -ENOENT \a hash_alg is unsupported
139 * \retval -ENOSPC \a hash is NULL, or \a hash_len less than
141 * \retval 0 for success
142 * \retval negative errno for other errors from lower
145 int cfs_crypto_hash_digest(enum cfs_crypto_hash_alg hash_alg
,
146 const void *buf
, unsigned int buf_len
,
147 unsigned char *key
, unsigned int key_len
,
148 unsigned char *hash
, unsigned int *hash_len
)
150 struct scatterlist sl
;
151 struct ahash_request
*req
;
153 const struct cfs_crypto_hash_type
*type
;
155 if (!buf
|| buf_len
== 0 || !hash_len
)
158 err
= cfs_crypto_hash_alloc(hash_alg
, &type
, &req
, key
, key_len
);
162 if (!hash
|| *hash_len
< type
->cht_size
) {
163 *hash_len
= type
->cht_size
;
164 crypto_free_ahash(crypto_ahash_reqtfm(req
));
165 ahash_request_free(req
);
168 sg_init_one(&sl
, buf
, buf_len
);
170 ahash_request_set_crypt(req
, &sl
, hash
, sl
.length
);
171 err
= crypto_ahash_digest(req
);
172 crypto_free_ahash(crypto_ahash_reqtfm(req
));
173 ahash_request_free(req
);
177 EXPORT_SYMBOL(cfs_crypto_hash_digest
);
180 * Allocate and initialize desriptor for hash algorithm.
182 * This should be used to initialize a hash descriptor for multiple calls
183 * to a single hash function when computing the hash across multiple
184 * separate buffers or pages using cfs_crypto_hash_update{,_page}().
186 * The hash descriptor should be freed with cfs_crypto_hash_final().
188 * \param[in] hash_alg algorithm id (CFS_HASH_ALG_*)
189 * \param[in] key initial value/state for algorithm, if \a key = NULL
190 * use default initial value
191 * \param[in] key_len length of \a key in bytes
193 * \retval pointer to descriptor of hash instance
194 * \retval ERR_PTR(errno) in case of error
196 struct cfs_crypto_hash_desc
*
197 cfs_crypto_hash_init(enum cfs_crypto_hash_alg hash_alg
,
198 unsigned char *key
, unsigned int key_len
)
200 struct ahash_request
*req
;
202 const struct cfs_crypto_hash_type
*type
;
204 err
= cfs_crypto_hash_alloc(hash_alg
, &type
, &req
, key
, key_len
);
208 return (struct cfs_crypto_hash_desc
*)req
;
210 EXPORT_SYMBOL(cfs_crypto_hash_init
);
213 * Update hash digest computed on data within the given \a page
215 * \param[in] hdesc hash state descriptor
216 * \param[in] page data page on which to compute the hash
217 * \param[in] offset offset within \a page at which to start hash
218 * \param[in] len length of data on which to compute hash
220 * \retval 0 for success
221 * \retval negative errno on failure
223 int cfs_crypto_hash_update_page(struct cfs_crypto_hash_desc
*hdesc
,
224 struct page
*page
, unsigned int offset
,
227 struct ahash_request
*req
= (void *)hdesc
;
228 struct scatterlist sl
;
230 sg_init_table(&sl
, 1);
231 sg_set_page(&sl
, page
, len
, offset
& ~PAGE_MASK
);
233 ahash_request_set_crypt(req
, &sl
, NULL
, sl
.length
);
234 return crypto_ahash_update(req
);
236 EXPORT_SYMBOL(cfs_crypto_hash_update_page
);
239 * Update hash digest computed on the specified data
241 * \param[in] hdesc hash state descriptor
242 * \param[in] buf data buffer on which to compute the hash
243 * \param[in] buf_len length of \buf on which to compute hash
245 * \retval 0 for success
246 * \retval negative errno on failure
248 int cfs_crypto_hash_update(struct cfs_crypto_hash_desc
*hdesc
,
249 const void *buf
, unsigned int buf_len
)
251 struct ahash_request
*req
= (void *)hdesc
;
252 struct scatterlist sl
;
254 sg_init_one(&sl
, buf
, buf_len
);
256 ahash_request_set_crypt(req
, &sl
, NULL
, sl
.length
);
257 return crypto_ahash_update(req
);
259 EXPORT_SYMBOL(cfs_crypto_hash_update
);
262 * Finish hash calculation, copy hash digest to buffer, clean up hash descriptor
264 * \param[in] hdesc hash descriptor
265 * \param[out] hash pointer to hash buffer to store hash digest
266 * \param[in,out] hash_len pointer to hash buffer size, if \a hdesc = NULL
267 * only free \a hdesc instead of computing the hash
269 * \retval 0 for success
270 * \retval -EOVERFLOW if hash_len is too small for the hash digest
271 * \retval negative errno for other errors from lower layers
273 int cfs_crypto_hash_final(struct cfs_crypto_hash_desc
*hdesc
,
274 unsigned char *hash
, unsigned int *hash_len
)
277 struct ahash_request
*req
= (void *)hdesc
;
278 int size
= crypto_ahash_digestsize(crypto_ahash_reqtfm(req
));
280 if (!hash
|| !hash_len
) {
284 if (*hash_len
< size
) {
289 ahash_request_set_crypt(req
, NULL
, hash
, 0);
290 err
= crypto_ahash_final(req
);
294 crypto_free_ahash(crypto_ahash_reqtfm(req
));
295 ahash_request_free(req
);
298 EXPORT_SYMBOL(cfs_crypto_hash_final
);
301 * Compute the speed of specified hash function
303 * Run a speed test on the given hash algorithm on buffer of the given size.
304 * The speed is stored internally in the cfs_crypto_hash_speeds[] array, and
305 * is available through the cfs_crypto_hash_speed() function.
307 * \param[in] hash_alg hash algorithm id (CFS_HASH_ALG_*)
308 * \param[in] buf data buffer on which to compute the hash
309 * \param[in] buf_len length of \buf on which to compute hash
311 static void cfs_crypto_performance_test(enum cfs_crypto_hash_alg hash_alg
)
313 int buf_len
= max(PAGE_SIZE
, 1048576UL);
315 unsigned long start
, end
;
318 unsigned char hash
[CFS_CRYPTO_HASH_DIGESTSIZE_MAX
];
319 unsigned int hash_len
= sizeof(hash
);
321 page
= alloc_page(GFP_KERNEL
);
328 memset(buf
, 0xAD, PAGE_SIZE
);
331 for (start
= jiffies
, end
= start
+ msecs_to_jiffies(MSEC_PER_SEC
),
332 bcount
= 0; time_before(jiffies
, end
); bcount
++) {
333 struct cfs_crypto_hash_desc
*hdesc
;
336 hdesc
= cfs_crypto_hash_init(hash_alg
, NULL
, 0);
338 err
= PTR_ERR(hdesc
);
342 for (i
= 0; i
< buf_len
/ PAGE_SIZE
; i
++) {
343 err
= cfs_crypto_hash_update_page(hdesc
, page
, 0,
349 err
= cfs_crypto_hash_final(hdesc
, hash
, &hash_len
);
357 cfs_crypto_hash_speeds
[hash_alg
] = err
;
358 CDEBUG(D_INFO
, "Crypto hash algorithm %s test error: rc = %d\n",
359 cfs_crypto_hash_name(hash_alg
), err
);
363 tmp
= ((bcount
* buf_len
/ jiffies_to_msecs(end
- start
)) *
364 1000) / (1024 * 1024);
365 cfs_crypto_hash_speeds
[hash_alg
] = (int)tmp
;
366 CDEBUG(D_CONFIG
, "Crypto hash algorithm %s speed = %d MB/s\n",
367 cfs_crypto_hash_name(hash_alg
),
368 cfs_crypto_hash_speeds
[hash_alg
]);
373 * hash speed in Mbytes per second for valid hash algorithm
375 * Return the performance of the specified \a hash_alg that was previously
376 * computed using cfs_crypto_performance_test().
378 * \param[in] hash_alg hash algorithm id (CFS_HASH_ALG_*)
380 * \retval positive speed of the hash function in MB/s
381 * \retval -ENOENT if \a hash_alg is unsupported
382 * \retval negative errno if \a hash_alg speed is unavailable
384 int cfs_crypto_hash_speed(enum cfs_crypto_hash_alg hash_alg
)
386 if (hash_alg
< CFS_HASH_ALG_MAX
)
387 return cfs_crypto_hash_speeds
[hash_alg
];
390 EXPORT_SYMBOL(cfs_crypto_hash_speed
);
393 * Run the performance test for all hash algorithms.
395 * Run the cfs_crypto_performance_test() benchmark for all of the available
396 * hash functions using a 1MB buffer size. This is a reasonable buffer size
397 * for Lustre RPCs, even if the actual RPC size is larger or smaller.
399 * Since the setup cost and computation speed of various hash algorithms is
400 * a function of the buffer size (and possibly internal contention of offload
401 * engines), this speed only represents an estimate of the actual speed under
402 * actual usage, but is reasonable for comparing available algorithms.
404 * The actual speeds are available via cfs_crypto_hash_speed() for later
407 * \retval 0 on success
408 * \retval -ENOMEM if no memory is available for test buffer
410 static int cfs_crypto_test_hashes(void)
412 enum cfs_crypto_hash_alg hash_alg
;
414 for (hash_alg
= 0; hash_alg
< CFS_HASH_ALG_MAX
; hash_alg
++)
415 cfs_crypto_performance_test(hash_alg
);
423 * Register available hash functions
427 int cfs_crypto_register(void)
429 request_module("crc32c");
431 adler32
= cfs_crypto_adler32_register();
433 /* check all algorithms and do performance test */
434 cfs_crypto_test_hashes();
439 * Unregister previously registered hash functions
441 void cfs_crypto_unregister(void)
444 cfs_crypto_adler32_unregister();