Whamcloud - gitweb
LU-8602 gss: get rid of cfs_crypto_hash_desc
[fs/lustre-release.git] / libcfs / libcfs / linux / linux-crypto.c
index b5f376d..dce1734 100644 (file)
 /*
  * Copyright 2012 Xyratex Technology Limited
  *
- * Copyright (c) 2012, Intel Corporation.
+ * Copyright (c) 2012, 2014, Intel Corporation.
  */
 
-#include <linux/crypto.h>
+#include <crypto/hash.h>
 #include <linux/scatterlist.h>
+#include <linux/pagemap.h>
 #include <libcfs/libcfs.h>
 #include <libcfs/libcfs_crypto.h>
 #include <libcfs/linux/linux-crypto.h>
+
+#ifndef HAVE_CRYPTO_HASH_HELPERS
+static inline const char *crypto_ahash_alg_name(struct crypto_ahash *tfm)
+{
+       return crypto_tfm_alg_name(crypto_ahash_tfm(tfm));
+}
+
+static inline const char *crypto_ahash_driver_name(struct crypto_ahash *tfm)
+{
+       return crypto_tfm_alg_driver_name(crypto_ahash_tfm(tfm));
+}
+#endif
+
 /**
  *  Array of hash algorithm speed in MByte per second
  */
@@ -47,7 +61,7 @@ static int cfs_crypto_hash_speeds[CFS_HASH_ALG_MAX];
  *
  * \param[in]  hash_alg        hash algorithm id (CFS_HASH_ALG_*)
  * \param[out] type    pointer to the hash description in hash_types[] array
- * \param[in,out] hdesc        hash state descriptor to be initialized
+ * \param[in,out] req  ahash request to be initialized
  * \param[in]  key     initial hash value/state, NULL to use default value
  * \param[in]  key_len length of \a key
  *
@@ -56,49 +70,71 @@ static int cfs_crypto_hash_speeds[CFS_HASH_ALG_MAX];
  */
 static int cfs_crypto_hash_alloc(enum cfs_crypto_hash_alg hash_alg,
                                 const struct cfs_crypto_hash_type **type,
-                                struct hash_desc *hdesc, unsigned char *key,
+                                struct ahash_request **req,
+                                unsigned char *key,
                                 unsigned int key_len)
 {
+       struct crypto_ahash *tfm;
        int err = 0;
 
        *type = cfs_crypto_hash_type(hash_alg);
-
-       if (*type == NULL) {
+       if (!*type) {
                CWARN("Unsupported hash algorithm id = %d, max id is %d\n",
                      hash_alg, CFS_HASH_ALG_MAX);
                return -EINVAL;
        }
-       hdesc->tfm = crypto_alloc_hash((*type)->cht_name, 0, 0);
 
-       if (hdesc->tfm == NULL)
-               return -EINVAL;
+       /* Keys are only supported for the hmac version */
+       if (key && key_len > 0) {
+               char *algo_name;
+
+               algo_name = kasprintf(GFP_KERNEL, "hmac(%s)",
+                                     (*type)->cht_name);
+               if (!algo_name)
+                       return -ENOMEM;
 
-       if (IS_ERR(hdesc->tfm)) {
+               tfm = crypto_alloc_ahash(algo_name, 0, CRYPTO_ALG_ASYNC);
+               kfree(algo_name);
+       } else {
+               tfm = crypto_alloc_ahash((*type)->cht_name, 0,
+                                        CRYPTO_ALG_ASYNC);
+       }
+       if (IS_ERR(tfm)) {
                CDEBUG(D_INFO, "Failed to alloc crypto hash %s\n",
                       (*type)->cht_name);
-               return PTR_ERR(hdesc->tfm);
+               return PTR_ERR(tfm);
+       }
+
+       *req = ahash_request_alloc(tfm, GFP_KERNEL);
+       if (!*req) {
+               CDEBUG(D_INFO, "Failed to alloc ahash_request for %s\n",
+                      (*type)->cht_name);
+               GOTO(out_free_tfm, err = -ENOMEM);
        }
 
-       hdesc->flags = 0;
+       ahash_request_set_callback(*req, 0, NULL, NULL);
 
-       if (key != NULL)
-               err = crypto_hash_setkey(hdesc->tfm, key, key_len);
+       if (key)
+               err = crypto_ahash_setkey(tfm, key, key_len);
        else if ((*type)->cht_key != 0)
-               err = crypto_hash_setkey(hdesc->tfm,
+               err = crypto_ahash_setkey(tfm,
                                         (unsigned char *)&((*type)->cht_key),
                                         (*type)->cht_size);
-
-       if (err != 0) {
-               crypto_free_hash(hdesc->tfm);
-               return err;
-       }
+       if (err)
+               GOTO(out_free_req, err);
 
        CDEBUG(D_INFO, "Using crypto hash: %s (%s) speed %d MB/s\n",
-              (crypto_hash_tfm(hdesc->tfm))->__crt_alg->cra_name,
-              (crypto_hash_tfm(hdesc->tfm))->__crt_alg->cra_driver_name,
+              crypto_ahash_alg_name(tfm), crypto_ahash_driver_name(tfm),
               cfs_crypto_hash_speeds[hash_alg]);
 
-       return crypto_hash_init(hdesc);
+       err = crypto_ahash_init(*req);
+       if (err) {
+out_free_req:
+               ahash_request_free(*req);
+out_free_tfm:
+               crypto_free_ahash(tfm);
+       }
+       return err;
 }
 
 /**
@@ -117,7 +153,7 @@ static int cfs_crypto_hash_alloc(enum cfs_crypto_hash_alg hash_alg,
  *                     \a hash_len is to digest size in bytes, retval -ENOSPC
  * \param[in,out] hash_len size of \a hash buffer
  *
- * \retval -EINVAL       \a buf, \a buf_len, \a hash_len, \a alg_id invalid
+ * \retval -EINVAL       \a buf, \a buf_len, \a hash_len, \a hash_alg invalid
  * \retval -ENOENT       \a hash_alg is unsupported
  * \retval -ENOSPC       \a hash is NULL, or \a hash_len less than digest size
  * \retval             0 for success
@@ -129,27 +165,29 @@ int cfs_crypto_hash_digest(enum cfs_crypto_hash_alg hash_alg,
                           unsigned char *hash, unsigned int *hash_len)
 {
        struct scatterlist      sl;
-       struct hash_desc        hdesc;
+       struct ahash_request *req;
        int                     err;
        const struct cfs_crypto_hash_type       *type;
 
-       if (buf == NULL || buf_len == 0 || hash_len == NULL)
+       if (!buf || buf_len == 0 || !hash_len)
                return -EINVAL;
 
-       err = cfs_crypto_hash_alloc(hash_alg, &type, &hdesc, key, key_len);
+       err = cfs_crypto_hash_alloc(hash_alg, &type, &req, key, key_len);
        if (err != 0)
                return err;
 
-       if (hash == NULL || *hash_len < type->cht_size) {
+       if (!hash || *hash_len < type->cht_size) {
                *hash_len = type->cht_size;
-               crypto_free_hash(hdesc.tfm);
+               crypto_free_ahash(crypto_ahash_reqtfm(req));
+               ahash_request_free(req);
                return -ENOSPC;
        }
        sg_init_one(&sl, (void *)buf, buf_len);
 
-       hdesc.flags = 0;
-       err = crypto_hash_digest(&hdesc, &sl, sl.length, hash);
-       crypto_free_hash(hdesc.tfm);
+       ahash_request_set_crypt(req, &sl, hash, sl.length);
+       err = crypto_ahash_digest(req);
+       crypto_free_ahash(crypto_ahash_reqtfm(req));
+       ahash_request_free(req);
 
        return err;
 }
@@ -169,36 +207,28 @@ EXPORT_SYMBOL(cfs_crypto_hash_digest);
  *                     use default initial value
  * \param[in] key_len  length of \a key in bytes
  *
- * \retval             pointer to descriptor of hash instance
+ * \retval             pointer to ahash request
  * \retval             ERR_PTR(errno) in case of error
  */
-struct cfs_crypto_hash_desc *
+struct ahash_request *
        cfs_crypto_hash_init(enum cfs_crypto_hash_alg hash_alg,
                             unsigned char *key, unsigned int key_len)
 {
-
-       struct  hash_desc                       *hdesc;
+       struct ahash_request *req;
        int                                     err;
        const struct cfs_crypto_hash_type       *type;
 
-       hdesc = kmalloc(sizeof(*hdesc), 0);
-       if (hdesc == NULL)
-               return ERR_PTR(-ENOMEM);
-
-       err = cfs_crypto_hash_alloc(hash_alg, &type, hdesc, key, key_len);
-
-       if (err) {
-               kfree(hdesc);
-               hdesc = ERR_PTR(err);
-       }
-       return (struct cfs_crypto_hash_desc *)hdesc;
+       err = cfs_crypto_hash_alloc(hash_alg, &type, &req, key, key_len);
+       if (err)
+               return ERR_PTR(err);
+       return req;
 }
 EXPORT_SYMBOL(cfs_crypto_hash_init);
 
 /**
  * Update hash digest computed on data within the given \a page
  *
- * \param[in] hdesc    hash state descriptor
+ * \param[in] req      ahash request
  * \param[in] page     data page on which to compute the hash
  * \param[in] offset   offset within \a page at which to start hash
  * \param[in] len      length of data on which to compute hash
@@ -206,70 +236,77 @@ EXPORT_SYMBOL(cfs_crypto_hash_init);
  * \retval             0 for success
  * \retval             negative errno on failure
  */
-int cfs_crypto_hash_update_page(struct cfs_crypto_hash_desc *hdesc,
+int cfs_crypto_hash_update_page(struct ahash_request *req,
                                struct page *page, unsigned int offset,
                                unsigned int len)
 {
        struct scatterlist sl;
 
        sg_init_table(&sl, 1);
-       sg_set_page(&sl, page, len, offset & ~CFS_PAGE_MASK);
+       sg_set_page(&sl, page, len, offset & ~PAGE_MASK);
 
-       return crypto_hash_update((struct hash_desc *)hdesc, &sl, sl.length);
+       ahash_request_set_crypt(req, &sl, NULL, sl.length);
+       return crypto_ahash_update(req);
 }
 EXPORT_SYMBOL(cfs_crypto_hash_update_page);
 
 /**
  * Update hash digest computed on the specified data
  *
- * \param[in] hdesc    hash state descriptor
+ * \param[in] req      ahash request
  * \param[in] buf      data buffer on which to compute the hash
  * \param[in] buf_len  length of \buf on which to compute hash
  *
  * \retval             0 for success
  * \retval             negative errno on failure
  */
-int cfs_crypto_hash_update(struct cfs_crypto_hash_desc *hdesc,
+int cfs_crypto_hash_update(struct ahash_request *req,
                           const void *buf, unsigned int buf_len)
 {
        struct scatterlist sl;
 
        sg_init_one(&sl, (void *)buf, buf_len);
 
-       return crypto_hash_update((struct hash_desc *)hdesc, &sl, sl.length);
+       ahash_request_set_crypt(req, &sl, NULL, sl.length);
+       return crypto_ahash_update(req);
 }
 EXPORT_SYMBOL(cfs_crypto_hash_update);
 
 /**
  * Finish hash calculation, copy hash digest to buffer, clean up hash descriptor
  *
- * \param[in] hdesc    hash descriptor
- * \param[out] hash    pointer to hash buffer to store hash digest
- * \param[in,out] hash_len pointer to hash buffer size, if \a hdesc = NULL
- *                     only free \a hdesc instead of computing the hash
+ * \param[in]  req             ahash request
+ * \param[out] hash            pointer to hash buffer to store hash digest
+ * \param[in,out] hash_len     pointer to hash buffer size, if \a hash == NULL
+ *                             or hash_len == NULL only free \a hdesc instead
+ *                             of computing the hash
  *
- * \retval             -ENOSPC if \a hash = NULL, or \a hash_len < digest size
  * \retval             0 for success
+ * \retval             -EOVERFLOW if hash_len is too small for the hash digest
  * \retval             negative errno for other errors from lower layers
  */
-int cfs_crypto_hash_final(struct cfs_crypto_hash_desc *hdesc,
+int cfs_crypto_hash_final(struct ahash_request *req,
                          unsigned char *hash, unsigned int *hash_len)
 {
-       int     size = crypto_hash_digestsize(((struct hash_desc *)hdesc)->tfm);
-       int     err;
+       int size = crypto_ahash_digestsize(crypto_ahash_reqtfm(req));
+       int err;
 
-       if (hash_len == NULL) {
+       if (!hash || !hash_len) {
                err = 0;
                goto free;
        }
-       if (hash == NULL || *hash_len < size) {
-               err = -ENOSPC;
+       if (*hash_len < size) {
+               err = -EOVERFLOW;
                goto free;
        }
-       err = crypto_hash_final((struct hash_desc *)hdesc, hash);
+
+       ahash_request_set_crypt(req, NULL, hash, 0);
+       err = crypto_ahash_final(req);
+       if (err == 0)
+               *hash_len = size;
 free:
-       crypto_free_hash(((struct hash_desc *)hdesc)->tfm);
-       kfree(hdesc);
+       crypto_free_ahash(crypto_ahash_reqtfm(req));
+       ahash_request_free(req);
 
        return err;
 }
@@ -278,34 +315,66 @@ EXPORT_SYMBOL(cfs_crypto_hash_final);
 /**
  * Compute the speed of specified hash function
  *
- * Run a speed test on the given hash algorithm on buffer of the given size.
+ * Run a speed test on the given hash algorithm on buffer using a 1MB buffer
+ * size.  This is a reasonable buffer size for Lustre RPCs, even if the actual
+ * RPC size is larger or smaller.
+ *
  * The speed is stored internally in the cfs_crypto_hash_speeds[] array, and
  * is available through the cfs_crypto_hash_speed() function.
  *
+ * This function needs to stay the same as obd_t10_performance_test() so that
+ * the speeds are comparable.
+ *
  * \param[in] hash_alg hash algorithm id (CFS_HASH_ALG_*)
  * \param[in] buf      data buffer on which to compute the hash
  * \param[in] buf_len  length of \buf on which to compute hash
  */
-static void cfs_crypto_performance_test(enum cfs_crypto_hash_alg hash_alg,
-                                       const unsigned char *buf,
-                                       unsigned int buf_len)
+static void cfs_crypto_performance_test(enum cfs_crypto_hash_alg hash_alg)
 {
+       int                     buf_len = max(PAGE_SIZE, 1048576UL);
+       void                    *buf;
        unsigned long           start, end;
-       int                     bcount, err = 0;
-       int                     sec = 1; /* do test only 1 sec */
-       unsigned char           hash[64];
+       int                     err = 0;
+       unsigned long           bcount;
+       struct page             *page;
+       unsigned char           hash[CFS_CRYPTO_HASH_DIGESTSIZE_MAX];
        unsigned int            hash_len = sizeof(hash);
 
-       for (start = jiffies, end = start + sec * HZ, bcount = 0;
-            time_before(jiffies, end); bcount++) {
-               err = cfs_crypto_hash_digest(hash_alg, buf, buf_len, NULL, 0,
-                                            hash, &hash_len);
-               if (err != 0)
+       page = alloc_page(GFP_KERNEL);
+       if (page == NULL) {
+               err = -ENOMEM;
+               goto out_err;
+       }
+
+       buf = kmap(page);
+       memset(buf, 0xAD, PAGE_SIZE);
+       kunmap(page);
+
+       for (start = jiffies, end = start + msecs_to_jiffies(MSEC_PER_SEC / 4),
+            bcount = 0; time_before(jiffies, end) && err == 0; bcount++) {
+               struct ahash_request *req;
+               int i;
+
+               req = cfs_crypto_hash_init(hash_alg, NULL, 0);
+               if (IS_ERR(req)) {
+                       err = PTR_ERR(req);
                        break;
+               }
 
+               for (i = 0; i < buf_len / PAGE_SIZE; i++) {
+                       err = cfs_crypto_hash_update_page(req, page, 0,
+                                                         PAGE_SIZE);
+                       if (err != 0)
+                               break;
+               }
+
+               err = cfs_crypto_hash_final(req, hash, &hash_len);
+               if (err != 0)
+                       break;
        }
        end = jiffies;
-
+       __free_page(page);
+out_err:
        if (err != 0) {
                cfs_crypto_hash_speeds[hash_alg] = err;
                CDEBUG(D_INFO, "Crypto hash algorithm %s test error: rc = %d\n",
@@ -325,8 +394,12 @@ static void cfs_crypto_performance_test(enum cfs_crypto_hash_alg hash_alg,
 /**
  * hash speed in Mbytes per second for valid hash algorithm
  *
- * Return the performance of the specified \a hash_alg that was previously
- * computed using cfs_crypto_performance_test().
+ * Return the performance of the specified \a hash_alg that was
+ * computed using cfs_crypto_performance_test().  If the performance
+ * has not yet been computed, do that when it is first requested.
+ * That avoids computing the speed when it is not actually needed.
+ * To avoid competing threads computing the checksum speed at the
+ * same time, only compute a single checksum speed at one time.
  *
  * \param[in] hash_alg hash algorithm id (CFS_HASH_ALG_*)
  *
@@ -336,8 +409,17 @@ static void cfs_crypto_performance_test(enum cfs_crypto_hash_alg hash_alg,
  */
 int cfs_crypto_hash_speed(enum cfs_crypto_hash_alg hash_alg)
 {
-       if (hash_alg < CFS_HASH_ALG_MAX)
+       if (hash_alg < CFS_HASH_ALG_MAX) {
+               if (unlikely(cfs_crypto_hash_speeds[hash_alg] == 0)) {
+                       static DEFINE_MUTEX(crypto_hash_speed_mutex);
+
+                       mutex_lock(&crypto_hash_speed_mutex);
+                       if (cfs_crypto_hash_speeds[hash_alg] == 0)
+                               cfs_crypto_performance_test(hash_alg);
+                       mutex_unlock(&crypto_hash_speed_mutex);
+               }
                return cfs_crypto_hash_speeds[hash_alg];
+       }
 
        return -ENOENT;
 }
@@ -346,9 +428,10 @@ EXPORT_SYMBOL(cfs_crypto_hash_speed);
 /**
  * Run the performance test for all hash algorithms.
  *
- * Run the cfs_crypto_performance_test() benchmark for all of the available
- * hash functions using a 1MB buffer size.  This is a reasonable buffer size
- * for Lustre RPCs, even if the actual RPC size is larger or smaller.
+ * Run the cfs_crypto_performance_test() benchmark for some of the available
+ * hash functions at module load time.  This can't be reliably done at runtime
+ * since the CPUs may be under load from thousands of connecting clients when
+ * the first client connects and the checksum speeds are needed.
  *
  * Since the setup cost and computation speed of various hash algorithms is
  * a function of the buffer size (and possibly internal contention of offload
@@ -364,22 +447,10 @@ EXPORT_SYMBOL(cfs_crypto_hash_speed);
 static int cfs_crypto_test_hashes(void)
 {
        enum cfs_crypto_hash_alg hash_alg;
-       unsigned char           *data;
-       /* Data block size for testing hash. Use bulk RPC size. */
-       unsigned int             data_len = 1024 * 1024;
-
-       data = vmalloc(data_len);
-       if (data == NULL) {
-               CERROR("Failed to allocate buffer for hash speed test\n");
-               return -ENOMEM;
-       }
-
-       memset(data, 0xAD, data_len);
 
-       for (hash_alg = 0; hash_alg < CFS_HASH_ALG_MAX; hash_alg++)
-               cfs_crypto_performance_test(hash_alg, data, data_len);
+       for (hash_alg = 1; hash_alg < CFS_HASH_ALG_SPEED_MAX; hash_alg++)
+               cfs_crypto_performance_test(hash_alg);
 
-       vfree(data);
        return 0;
 }