]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph-client.git/commitdiff
crypto: crc32 - remove "generic" from file and module names
authorEric Biggers <ebiggers@google.com>
Mon, 28 Apr 2025 16:24:58 +0000 (09:24 -0700)
committerEric Biggers <ebiggers@google.com>
Mon, 28 Apr 2025 17:02:45 +0000 (10:02 -0700)
Since crc32_generic.c and crc32c_generic.c now expose both the generic
and architecture-optimized implementations via the crypto_shash API,
rather than just the generic implementations as they originally did,
remove the "generic" part of the filenames and module names:

    crypto/crc32-generic.c => crypto/crc32.c
    crypto/crc32c-generic.c => crypto/crc32c.c
    crc32-generic.ko => crc32-cryptoapi.ko
    crc32c-generic.ko => crc32c-cryptoapi.ko

The reason for adding the -cryptoapi suffixes to the module names is to
avoid a module name collision with crc32.ko which is the library API.

We could instead rename the library module to libcrc32.ko.  However,
while lib/crypto/ uses that convention, the rest of lib/ doesn't.  Since
the library API is the primary API for CRC-32, I'd like to keep the
unsuffixed name for it and make the Crypto API modules use a suffix.

Acked-by: Arnd Bergmann <arnd@arndb.de>
Link: https://lore.kernel.org/r/20250428162458.29732-1-ebiggers@kernel.org
Signed-off-by: Eric Biggers <ebiggers@google.com>
crypto/Makefile
crypto/crc32.c [new file with mode: 0644]
crypto/crc32_generic.c [deleted file]
crypto/crc32c.c [new file with mode: 0644]
crypto/crc32c_generic.c [deleted file]

index 0e6ab5ffd3f77ca5e5efb95abd8666ae47deb166..186f968baa39efae66c1c7834931029937733136 100644 (file)
@@ -152,10 +152,12 @@ obj-$(CONFIG_CRYPTO_CHACHA20) += chacha_generic.o
 obj-$(CONFIG_CRYPTO_POLY1305) += poly1305_generic.o
 obj-$(CONFIG_CRYPTO_DEFLATE) += deflate.o
 obj-$(CONFIG_CRYPTO_MICHAEL_MIC) += michael_mic.o
-obj-$(CONFIG_CRYPTO_CRC32C) += crc32c_generic.o
-obj-$(CONFIG_CRYPTO_CRC32) += crc32_generic.o
-CFLAGS_crc32c_generic.o += -DARCH=$(ARCH)
-CFLAGS_crc32_generic.o += -DARCH=$(ARCH)
+obj-$(CONFIG_CRYPTO_CRC32C) += crc32c-cryptoapi.o
+crc32c-cryptoapi-y := crc32c.o
+CFLAGS_crc32c.o += -DARCH=$(ARCH)
+obj-$(CONFIG_CRYPTO_CRC32) += crc32-cryptoapi.o
+crc32-cryptoapi-y := crc32.o
+CFLAGS_crc32.o += -DARCH=$(ARCH)
 obj-$(CONFIG_CRYPTO_AUTHENC) += authenc.o authencesn.o
 obj-$(CONFIG_CRYPTO_KRB5ENC) += krb5enc.o
 obj-$(CONFIG_CRYPTO_LZO) += lzo.o lzo-rle.o
diff --git a/crypto/crc32.c b/crypto/crc32.c
new file mode 100644 (file)
index 0000000..783a30b
--- /dev/null
@@ -0,0 +1,182 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Copyright 2012 Xyratex Technology Limited
+ */
+
+/*
+ * This is crypto api shash wrappers to crc32_le.
+ */
+
+#include <linux/unaligned.h>
+#include <linux/crc32.h>
+#include <crypto/internal/hash.h>
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/string.h>
+#include <linux/kernel.h>
+
+#define CHKSUM_BLOCK_SIZE      1
+#define CHKSUM_DIGEST_SIZE     4
+
+/** No default init with ~0 */
+static int crc32_cra_init(struct crypto_tfm *tfm)
+{
+       u32 *key = crypto_tfm_ctx(tfm);
+
+       *key = 0;
+
+       return 0;
+}
+
+/*
+ * Setting the seed allows arbitrary accumulators and flexible XOR policy
+ * If your algorithm starts with ~0, then XOR with ~0 before you set
+ * the seed.
+ */
+static int crc32_setkey(struct crypto_shash *hash, const u8 *key,
+                       unsigned int keylen)
+{
+       u32 *mctx = crypto_shash_ctx(hash);
+
+       if (keylen != sizeof(u32))
+               return -EINVAL;
+       *mctx = get_unaligned_le32(key);
+       return 0;
+}
+
+static int crc32_init(struct shash_desc *desc)
+{
+       u32 *mctx = crypto_shash_ctx(desc->tfm);
+       u32 *crcp = shash_desc_ctx(desc);
+
+       *crcp = *mctx;
+
+       return 0;
+}
+
+static int crc32_update(struct shash_desc *desc, const u8 *data,
+                       unsigned int len)
+{
+       u32 *crcp = shash_desc_ctx(desc);
+
+       *crcp = crc32_le_base(*crcp, data, len);
+       return 0;
+}
+
+static int crc32_update_arch(struct shash_desc *desc, const u8 *data,
+                            unsigned int len)
+{
+       u32 *crcp = shash_desc_ctx(desc);
+
+       *crcp = crc32_le(*crcp, data, len);
+       return 0;
+}
+
+/* No final XOR 0xFFFFFFFF, like crc32_le */
+static int __crc32_finup(u32 *crcp, const u8 *data, unsigned int len,
+                        u8 *out)
+{
+       put_unaligned_le32(crc32_le_base(*crcp, data, len), out);
+       return 0;
+}
+
+static int __crc32_finup_arch(u32 *crcp, const u8 *data, unsigned int len,
+                             u8 *out)
+{
+       put_unaligned_le32(crc32_le(*crcp, data, len), out);
+       return 0;
+}
+
+static int crc32_finup(struct shash_desc *desc, const u8 *data,
+                      unsigned int len, u8 *out)
+{
+       return __crc32_finup(shash_desc_ctx(desc), data, len, out);
+}
+
+static int crc32_finup_arch(struct shash_desc *desc, const u8 *data,
+                      unsigned int len, u8 *out)
+{
+       return __crc32_finup_arch(shash_desc_ctx(desc), data, len, out);
+}
+
+static int crc32_final(struct shash_desc *desc, u8 *out)
+{
+       u32 *crcp = shash_desc_ctx(desc);
+
+       put_unaligned_le32(*crcp, out);
+       return 0;
+}
+
+static int crc32_digest(struct shash_desc *desc, const u8 *data,
+                       unsigned int len, u8 *out)
+{
+       return __crc32_finup(crypto_shash_ctx(desc->tfm), data, len, out);
+}
+
+static int crc32_digest_arch(struct shash_desc *desc, const u8 *data,
+                            unsigned int len, u8 *out)
+{
+       return __crc32_finup_arch(crypto_shash_ctx(desc->tfm), data, len, out);
+}
+
+static struct shash_alg algs[] = {{
+       .setkey                 = crc32_setkey,
+       .init                   = crc32_init,
+       .update                 = crc32_update,
+       .final                  = crc32_final,
+       .finup                  = crc32_finup,
+       .digest                 = crc32_digest,
+       .descsize               = sizeof(u32),
+       .digestsize             = CHKSUM_DIGEST_SIZE,
+
+       .base.cra_name          = "crc32",
+       .base.cra_driver_name   = "crc32-generic",
+       .base.cra_priority      = 100,
+       .base.cra_flags         = CRYPTO_ALG_OPTIONAL_KEY,
+       .base.cra_blocksize     = CHKSUM_BLOCK_SIZE,
+       .base.cra_ctxsize       = sizeof(u32),
+       .base.cra_module        = THIS_MODULE,
+       .base.cra_init          = crc32_cra_init,
+}, {
+       .setkey                 = crc32_setkey,
+       .init                   = crc32_init,
+       .update                 = crc32_update_arch,
+       .final                  = crc32_final,
+       .finup                  = crc32_finup_arch,
+       .digest                 = crc32_digest_arch,
+       .descsize               = sizeof(u32),
+       .digestsize             = CHKSUM_DIGEST_SIZE,
+
+       .base.cra_name          = "crc32",
+       .base.cra_driver_name   = "crc32-" __stringify(ARCH),
+       .base.cra_priority      = 150,
+       .base.cra_flags         = CRYPTO_ALG_OPTIONAL_KEY,
+       .base.cra_blocksize     = CHKSUM_BLOCK_SIZE,
+       .base.cra_ctxsize       = sizeof(u32),
+       .base.cra_module        = THIS_MODULE,
+       .base.cra_init          = crc32_cra_init,
+}};
+
+static int num_algs;
+
+static int __init crc32_mod_init(void)
+{
+       /* register the arch flavor only if it differs from the generic one */
+       num_algs = 1 + ((crc32_optimizations() & CRC32_LE_OPTIMIZATION) != 0);
+
+       return crypto_register_shashes(algs, num_algs);
+}
+
+static void __exit crc32_mod_fini(void)
+{
+       crypto_unregister_shashes(algs, num_algs);
+}
+
+subsys_initcall(crc32_mod_init);
+module_exit(crc32_mod_fini);
+
+MODULE_AUTHOR("Alexander Boyko <alexander_boyko@xyratex.com>");
+MODULE_DESCRIPTION("CRC32 calculations wrapper for lib/crc32");
+MODULE_LICENSE("GPL");
+MODULE_ALIAS_CRYPTO("crc32");
+MODULE_ALIAS_CRYPTO("crc32-generic");
diff --git a/crypto/crc32_generic.c b/crypto/crc32_generic.c
deleted file mode 100644 (file)
index 783a30b..0000000
+++ /dev/null
@@ -1,182 +0,0 @@
-// SPDX-License-Identifier: GPL-2.0-only
-/*
- * Copyright 2012 Xyratex Technology Limited
- */
-
-/*
- * This is crypto api shash wrappers to crc32_le.
- */
-
-#include <linux/unaligned.h>
-#include <linux/crc32.h>
-#include <crypto/internal/hash.h>
-#include <linux/init.h>
-#include <linux/module.h>
-#include <linux/string.h>
-#include <linux/kernel.h>
-
-#define CHKSUM_BLOCK_SIZE      1
-#define CHKSUM_DIGEST_SIZE     4
-
-/** No default init with ~0 */
-static int crc32_cra_init(struct crypto_tfm *tfm)
-{
-       u32 *key = crypto_tfm_ctx(tfm);
-
-       *key = 0;
-
-       return 0;
-}
-
-/*
- * Setting the seed allows arbitrary accumulators and flexible XOR policy
- * If your algorithm starts with ~0, then XOR with ~0 before you set
- * the seed.
- */
-static int crc32_setkey(struct crypto_shash *hash, const u8 *key,
-                       unsigned int keylen)
-{
-       u32 *mctx = crypto_shash_ctx(hash);
-
-       if (keylen != sizeof(u32))
-               return -EINVAL;
-       *mctx = get_unaligned_le32(key);
-       return 0;
-}
-
-static int crc32_init(struct shash_desc *desc)
-{
-       u32 *mctx = crypto_shash_ctx(desc->tfm);
-       u32 *crcp = shash_desc_ctx(desc);
-
-       *crcp = *mctx;
-
-       return 0;
-}
-
-static int crc32_update(struct shash_desc *desc, const u8 *data,
-                       unsigned int len)
-{
-       u32 *crcp = shash_desc_ctx(desc);
-
-       *crcp = crc32_le_base(*crcp, data, len);
-       return 0;
-}
-
-static int crc32_update_arch(struct shash_desc *desc, const u8 *data,
-                            unsigned int len)
-{
-       u32 *crcp = shash_desc_ctx(desc);
-
-       *crcp = crc32_le(*crcp, data, len);
-       return 0;
-}
-
-/* No final XOR 0xFFFFFFFF, like crc32_le */
-static int __crc32_finup(u32 *crcp, const u8 *data, unsigned int len,
-                        u8 *out)
-{
-       put_unaligned_le32(crc32_le_base(*crcp, data, len), out);
-       return 0;
-}
-
-static int __crc32_finup_arch(u32 *crcp, const u8 *data, unsigned int len,
-                             u8 *out)
-{
-       put_unaligned_le32(crc32_le(*crcp, data, len), out);
-       return 0;
-}
-
-static int crc32_finup(struct shash_desc *desc, const u8 *data,
-                      unsigned int len, u8 *out)
-{
-       return __crc32_finup(shash_desc_ctx(desc), data, len, out);
-}
-
-static int crc32_finup_arch(struct shash_desc *desc, const u8 *data,
-                      unsigned int len, u8 *out)
-{
-       return __crc32_finup_arch(shash_desc_ctx(desc), data, len, out);
-}
-
-static int crc32_final(struct shash_desc *desc, u8 *out)
-{
-       u32 *crcp = shash_desc_ctx(desc);
-
-       put_unaligned_le32(*crcp, out);
-       return 0;
-}
-
-static int crc32_digest(struct shash_desc *desc, const u8 *data,
-                       unsigned int len, u8 *out)
-{
-       return __crc32_finup(crypto_shash_ctx(desc->tfm), data, len, out);
-}
-
-static int crc32_digest_arch(struct shash_desc *desc, const u8 *data,
-                            unsigned int len, u8 *out)
-{
-       return __crc32_finup_arch(crypto_shash_ctx(desc->tfm), data, len, out);
-}
-
-static struct shash_alg algs[] = {{
-       .setkey                 = crc32_setkey,
-       .init                   = crc32_init,
-       .update                 = crc32_update,
-       .final                  = crc32_final,
-       .finup                  = crc32_finup,
-       .digest                 = crc32_digest,
-       .descsize               = sizeof(u32),
-       .digestsize             = CHKSUM_DIGEST_SIZE,
-
-       .base.cra_name          = "crc32",
-       .base.cra_driver_name   = "crc32-generic",
-       .base.cra_priority      = 100,
-       .base.cra_flags         = CRYPTO_ALG_OPTIONAL_KEY,
-       .base.cra_blocksize     = CHKSUM_BLOCK_SIZE,
-       .base.cra_ctxsize       = sizeof(u32),
-       .base.cra_module        = THIS_MODULE,
-       .base.cra_init          = crc32_cra_init,
-}, {
-       .setkey                 = crc32_setkey,
-       .init                   = crc32_init,
-       .update                 = crc32_update_arch,
-       .final                  = crc32_final,
-       .finup                  = crc32_finup_arch,
-       .digest                 = crc32_digest_arch,
-       .descsize               = sizeof(u32),
-       .digestsize             = CHKSUM_DIGEST_SIZE,
-
-       .base.cra_name          = "crc32",
-       .base.cra_driver_name   = "crc32-" __stringify(ARCH),
-       .base.cra_priority      = 150,
-       .base.cra_flags         = CRYPTO_ALG_OPTIONAL_KEY,
-       .base.cra_blocksize     = CHKSUM_BLOCK_SIZE,
-       .base.cra_ctxsize       = sizeof(u32),
-       .base.cra_module        = THIS_MODULE,
-       .base.cra_init          = crc32_cra_init,
-}};
-
-static int num_algs;
-
-static int __init crc32_mod_init(void)
-{
-       /* register the arch flavor only if it differs from the generic one */
-       num_algs = 1 + ((crc32_optimizations() & CRC32_LE_OPTIMIZATION) != 0);
-
-       return crypto_register_shashes(algs, num_algs);
-}
-
-static void __exit crc32_mod_fini(void)
-{
-       crypto_unregister_shashes(algs, num_algs);
-}
-
-subsys_initcall(crc32_mod_init);
-module_exit(crc32_mod_fini);
-
-MODULE_AUTHOR("Alexander Boyko <alexander_boyko@xyratex.com>");
-MODULE_DESCRIPTION("CRC32 calculations wrapper for lib/crc32");
-MODULE_LICENSE("GPL");
-MODULE_ALIAS_CRYPTO("crc32");
-MODULE_ALIAS_CRYPTO("crc32-generic");
diff --git a/crypto/crc32c.c b/crypto/crc32c.c
new file mode 100644 (file)
index 0000000..b1a36d3
--- /dev/null
@@ -0,0 +1,222 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Cryptographic API.
+ *
+ * CRC32C chksum
+ *
+ *@Article{castagnoli-crc,
+ * author =       { Guy Castagnoli and Stefan Braeuer and Martin Herrman},
+ * title =        {{Optimization of Cyclic Redundancy-Check Codes with 24
+ *                 and 32 Parity Bits}},
+ * journal =      IEEE Transactions on Communication,
+ * year =         {1993},
+ * volume =       {41},
+ * number =       {6},
+ * pages =        {},
+ * month =        {June},
+ *}
+ * Used by the iSCSI driver, possibly others, and derived from
+ * the iscsi-crc.c module of the linux-iscsi driver at
+ * http://linux-iscsi.sourceforge.net.
+ *
+ * Following the example of lib/crc32, this function is intended to be
+ * flexible and useful for all users.  Modules that currently have their
+ * own crc32c, but hopefully may be able to use this one are:
+ *  net/sctp (please add all your doco to here if you change to
+ *            use this one!)
+ *  <endoflist>
+ *
+ * Copyright (c) 2004 Cisco Systems, Inc.
+ * Copyright (c) 2008 Herbert Xu <herbert@gondor.apana.org.au>
+ */
+
+#include <linux/unaligned.h>
+#include <crypto/internal/hash.h>
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/string.h>
+#include <linux/kernel.h>
+#include <linux/crc32.h>
+
+#define CHKSUM_BLOCK_SIZE      1
+#define CHKSUM_DIGEST_SIZE     4
+
+struct chksum_ctx {
+       u32 key;
+};
+
+struct chksum_desc_ctx {
+       u32 crc;
+};
+
+/*
+ * Steps through buffer one byte at a time, calculates reflected
+ * crc using table.
+ */
+
+static int chksum_init(struct shash_desc *desc)
+{
+       struct chksum_ctx *mctx = crypto_shash_ctx(desc->tfm);
+       struct chksum_desc_ctx *ctx = shash_desc_ctx(desc);
+
+       ctx->crc = mctx->key;
+
+       return 0;
+}
+
+/*
+ * Setting the seed allows arbitrary accumulators and flexible XOR policy
+ * If your algorithm starts with ~0, then XOR with ~0 before you set
+ * the seed.
+ */
+static int chksum_setkey(struct crypto_shash *tfm, const u8 *key,
+                        unsigned int keylen)
+{
+       struct chksum_ctx *mctx = crypto_shash_ctx(tfm);
+
+       if (keylen != sizeof(mctx->key))
+               return -EINVAL;
+       mctx->key = get_unaligned_le32(key);
+       return 0;
+}
+
+static int chksum_update(struct shash_desc *desc, const u8 *data,
+                        unsigned int length)
+{
+       struct chksum_desc_ctx *ctx = shash_desc_ctx(desc);
+
+       ctx->crc = crc32c_base(ctx->crc, data, length);
+       return 0;
+}
+
+static int chksum_update_arch(struct shash_desc *desc, const u8 *data,
+                             unsigned int length)
+{
+       struct chksum_desc_ctx *ctx = shash_desc_ctx(desc);
+
+       ctx->crc = crc32c(ctx->crc, data, length);
+       return 0;
+}
+
+static int chksum_final(struct shash_desc *desc, u8 *out)
+{
+       struct chksum_desc_ctx *ctx = shash_desc_ctx(desc);
+
+       put_unaligned_le32(~ctx->crc, out);
+       return 0;
+}
+
+static int __chksum_finup(u32 *crcp, const u8 *data, unsigned int len, u8 *out)
+{
+       put_unaligned_le32(~crc32c_base(*crcp, data, len), out);
+       return 0;
+}
+
+static int __chksum_finup_arch(u32 *crcp, const u8 *data, unsigned int len,
+                              u8 *out)
+{
+       put_unaligned_le32(~crc32c(*crcp, data, len), out);
+       return 0;
+}
+
+static int chksum_finup(struct shash_desc *desc, const u8 *data,
+                       unsigned int len, u8 *out)
+{
+       struct chksum_desc_ctx *ctx = shash_desc_ctx(desc);
+
+       return __chksum_finup(&ctx->crc, data, len, out);
+}
+
+static int chksum_finup_arch(struct shash_desc *desc, const u8 *data,
+                            unsigned int len, u8 *out)
+{
+       struct chksum_desc_ctx *ctx = shash_desc_ctx(desc);
+
+       return __chksum_finup_arch(&ctx->crc, data, len, out);
+}
+
+static int chksum_digest(struct shash_desc *desc, const u8 *data,
+                        unsigned int length, u8 *out)
+{
+       struct chksum_ctx *mctx = crypto_shash_ctx(desc->tfm);
+
+       return __chksum_finup(&mctx->key, data, length, out);
+}
+
+static int chksum_digest_arch(struct shash_desc *desc, const u8 *data,
+                             unsigned int length, u8 *out)
+{
+       struct chksum_ctx *mctx = crypto_shash_ctx(desc->tfm);
+
+       return __chksum_finup_arch(&mctx->key, data, length, out);
+}
+
+static int crc32c_cra_init(struct crypto_tfm *tfm)
+{
+       struct chksum_ctx *mctx = crypto_tfm_ctx(tfm);
+
+       mctx->key = ~0;
+       return 0;
+}
+
+static struct shash_alg algs[] = {{
+       .digestsize             = CHKSUM_DIGEST_SIZE,
+       .setkey                 = chksum_setkey,
+       .init                   = chksum_init,
+       .update                 = chksum_update,
+       .final                  = chksum_final,
+       .finup                  = chksum_finup,
+       .digest                 = chksum_digest,
+       .descsize               = sizeof(struct chksum_desc_ctx),
+
+       .base.cra_name          = "crc32c",
+       .base.cra_driver_name   = "crc32c-generic",
+       .base.cra_priority      = 100,
+       .base.cra_flags         = CRYPTO_ALG_OPTIONAL_KEY,
+       .base.cra_blocksize     = CHKSUM_BLOCK_SIZE,
+       .base.cra_ctxsize       = sizeof(struct chksum_ctx),
+       .base.cra_module        = THIS_MODULE,
+       .base.cra_init          = crc32c_cra_init,
+}, {
+       .digestsize             = CHKSUM_DIGEST_SIZE,
+       .setkey                 = chksum_setkey,
+       .init                   = chksum_init,
+       .update                 = chksum_update_arch,
+       .final                  = chksum_final,
+       .finup                  = chksum_finup_arch,
+       .digest                 = chksum_digest_arch,
+       .descsize               = sizeof(struct chksum_desc_ctx),
+
+       .base.cra_name          = "crc32c",
+       .base.cra_driver_name   = "crc32c-" __stringify(ARCH),
+       .base.cra_priority      = 150,
+       .base.cra_flags         = CRYPTO_ALG_OPTIONAL_KEY,
+       .base.cra_blocksize     = CHKSUM_BLOCK_SIZE,
+       .base.cra_ctxsize       = sizeof(struct chksum_ctx),
+       .base.cra_module        = THIS_MODULE,
+       .base.cra_init          = crc32c_cra_init,
+}};
+
+static int num_algs;
+
+static int __init crc32c_mod_init(void)
+{
+       /* register the arch flavor only if it differs from the generic one */
+       num_algs = 1 + ((crc32_optimizations() & CRC32C_OPTIMIZATION) != 0);
+
+       return crypto_register_shashes(algs, num_algs);
+}
+
+static void __exit crc32c_mod_fini(void)
+{
+       crypto_unregister_shashes(algs, num_algs);
+}
+
+subsys_initcall(crc32c_mod_init);
+module_exit(crc32c_mod_fini);
+
+MODULE_AUTHOR("Clay Haapala <chaapala@cisco.com>");
+MODULE_DESCRIPTION("CRC32c (Castagnoli) calculations wrapper for lib/crc32c");
+MODULE_LICENSE("GPL");
+MODULE_ALIAS_CRYPTO("crc32c");
+MODULE_ALIAS_CRYPTO("crc32c-generic");
diff --git a/crypto/crc32c_generic.c b/crypto/crc32c_generic.c
deleted file mode 100644 (file)
index b1a36d3..0000000
+++ /dev/null
@@ -1,222 +0,0 @@
-// SPDX-License-Identifier: GPL-2.0-or-later
-/*
- * Cryptographic API.
- *
- * CRC32C chksum
- *
- *@Article{castagnoli-crc,
- * author =       { Guy Castagnoli and Stefan Braeuer and Martin Herrman},
- * title =        {{Optimization of Cyclic Redundancy-Check Codes with 24
- *                 and 32 Parity Bits}},
- * journal =      IEEE Transactions on Communication,
- * year =         {1993},
- * volume =       {41},
- * number =       {6},
- * pages =        {},
- * month =        {June},
- *}
- * Used by the iSCSI driver, possibly others, and derived from
- * the iscsi-crc.c module of the linux-iscsi driver at
- * http://linux-iscsi.sourceforge.net.
- *
- * Following the example of lib/crc32, this function is intended to be
- * flexible and useful for all users.  Modules that currently have their
- * own crc32c, but hopefully may be able to use this one are:
- *  net/sctp (please add all your doco to here if you change to
- *            use this one!)
- *  <endoflist>
- *
- * Copyright (c) 2004 Cisco Systems, Inc.
- * Copyright (c) 2008 Herbert Xu <herbert@gondor.apana.org.au>
- */
-
-#include <linux/unaligned.h>
-#include <crypto/internal/hash.h>
-#include <linux/init.h>
-#include <linux/module.h>
-#include <linux/string.h>
-#include <linux/kernel.h>
-#include <linux/crc32.h>
-
-#define CHKSUM_BLOCK_SIZE      1
-#define CHKSUM_DIGEST_SIZE     4
-
-struct chksum_ctx {
-       u32 key;
-};
-
-struct chksum_desc_ctx {
-       u32 crc;
-};
-
-/*
- * Steps through buffer one byte at a time, calculates reflected
- * crc using table.
- */
-
-static int chksum_init(struct shash_desc *desc)
-{
-       struct chksum_ctx *mctx = crypto_shash_ctx(desc->tfm);
-       struct chksum_desc_ctx *ctx = shash_desc_ctx(desc);
-
-       ctx->crc = mctx->key;
-
-       return 0;
-}
-
-/*
- * Setting the seed allows arbitrary accumulators and flexible XOR policy
- * If your algorithm starts with ~0, then XOR with ~0 before you set
- * the seed.
- */
-static int chksum_setkey(struct crypto_shash *tfm, const u8 *key,
-                        unsigned int keylen)
-{
-       struct chksum_ctx *mctx = crypto_shash_ctx(tfm);
-
-       if (keylen != sizeof(mctx->key))
-               return -EINVAL;
-       mctx->key = get_unaligned_le32(key);
-       return 0;
-}
-
-static int chksum_update(struct shash_desc *desc, const u8 *data,
-                        unsigned int length)
-{
-       struct chksum_desc_ctx *ctx = shash_desc_ctx(desc);
-
-       ctx->crc = crc32c_base(ctx->crc, data, length);
-       return 0;
-}
-
-static int chksum_update_arch(struct shash_desc *desc, const u8 *data,
-                             unsigned int length)
-{
-       struct chksum_desc_ctx *ctx = shash_desc_ctx(desc);
-
-       ctx->crc = crc32c(ctx->crc, data, length);
-       return 0;
-}
-
-static int chksum_final(struct shash_desc *desc, u8 *out)
-{
-       struct chksum_desc_ctx *ctx = shash_desc_ctx(desc);
-
-       put_unaligned_le32(~ctx->crc, out);
-       return 0;
-}
-
-static int __chksum_finup(u32 *crcp, const u8 *data, unsigned int len, u8 *out)
-{
-       put_unaligned_le32(~crc32c_base(*crcp, data, len), out);
-       return 0;
-}
-
-static int __chksum_finup_arch(u32 *crcp, const u8 *data, unsigned int len,
-                              u8 *out)
-{
-       put_unaligned_le32(~crc32c(*crcp, data, len), out);
-       return 0;
-}
-
-static int chksum_finup(struct shash_desc *desc, const u8 *data,
-                       unsigned int len, u8 *out)
-{
-       struct chksum_desc_ctx *ctx = shash_desc_ctx(desc);
-
-       return __chksum_finup(&ctx->crc, data, len, out);
-}
-
-static int chksum_finup_arch(struct shash_desc *desc, const u8 *data,
-                            unsigned int len, u8 *out)
-{
-       struct chksum_desc_ctx *ctx = shash_desc_ctx(desc);
-
-       return __chksum_finup_arch(&ctx->crc, data, len, out);
-}
-
-static int chksum_digest(struct shash_desc *desc, const u8 *data,
-                        unsigned int length, u8 *out)
-{
-       struct chksum_ctx *mctx = crypto_shash_ctx(desc->tfm);
-
-       return __chksum_finup(&mctx->key, data, length, out);
-}
-
-static int chksum_digest_arch(struct shash_desc *desc, const u8 *data,
-                             unsigned int length, u8 *out)
-{
-       struct chksum_ctx *mctx = crypto_shash_ctx(desc->tfm);
-
-       return __chksum_finup_arch(&mctx->key, data, length, out);
-}
-
-static int crc32c_cra_init(struct crypto_tfm *tfm)
-{
-       struct chksum_ctx *mctx = crypto_tfm_ctx(tfm);
-
-       mctx->key = ~0;
-       return 0;
-}
-
-static struct shash_alg algs[] = {{
-       .digestsize             = CHKSUM_DIGEST_SIZE,
-       .setkey                 = chksum_setkey,
-       .init                   = chksum_init,
-       .update                 = chksum_update,
-       .final                  = chksum_final,
-       .finup                  = chksum_finup,
-       .digest                 = chksum_digest,
-       .descsize               = sizeof(struct chksum_desc_ctx),
-
-       .base.cra_name          = "crc32c",
-       .base.cra_driver_name   = "crc32c-generic",
-       .base.cra_priority      = 100,
-       .base.cra_flags         = CRYPTO_ALG_OPTIONAL_KEY,
-       .base.cra_blocksize     = CHKSUM_BLOCK_SIZE,
-       .base.cra_ctxsize       = sizeof(struct chksum_ctx),
-       .base.cra_module        = THIS_MODULE,
-       .base.cra_init          = crc32c_cra_init,
-}, {
-       .digestsize             = CHKSUM_DIGEST_SIZE,
-       .setkey                 = chksum_setkey,
-       .init                   = chksum_init,
-       .update                 = chksum_update_arch,
-       .final                  = chksum_final,
-       .finup                  = chksum_finup_arch,
-       .digest                 = chksum_digest_arch,
-       .descsize               = sizeof(struct chksum_desc_ctx),
-
-       .base.cra_name          = "crc32c",
-       .base.cra_driver_name   = "crc32c-" __stringify(ARCH),
-       .base.cra_priority      = 150,
-       .base.cra_flags         = CRYPTO_ALG_OPTIONAL_KEY,
-       .base.cra_blocksize     = CHKSUM_BLOCK_SIZE,
-       .base.cra_ctxsize       = sizeof(struct chksum_ctx),
-       .base.cra_module        = THIS_MODULE,
-       .base.cra_init          = crc32c_cra_init,
-}};
-
-static int num_algs;
-
-static int __init crc32c_mod_init(void)
-{
-       /* register the arch flavor only if it differs from the generic one */
-       num_algs = 1 + ((crc32_optimizations() & CRC32C_OPTIMIZATION) != 0);
-
-       return crypto_register_shashes(algs, num_algs);
-}
-
-static void __exit crc32c_mod_fini(void)
-{
-       crypto_unregister_shashes(algs, num_algs);
-}
-
-subsys_initcall(crc32c_mod_init);
-module_exit(crc32c_mod_fini);
-
-MODULE_AUTHOR("Clay Haapala <chaapala@cisco.com>");
-MODULE_DESCRIPTION("CRC32c (Castagnoli) calculations wrapper for lib/crc32c");
-MODULE_LICENSE("GPL");
-MODULE_ALIAS_CRYPTO("crc32c");
-MODULE_ALIAS_CRYPTO("crc32c-generic");