[PW_SID:967868] lib/crc: improve how arch-optimized code is integrated by linux-riscv-bot · Pull Request #460 · linux-riscv/linux

linux-riscv-bot · 2025-06-01T23:43:40Z

PR for series 967868 applied to workflow

Name: lib/crc: improve how arch-optimized code is integrated
URL: https://patchwork.kernel.org/project/linux-riscv/list/?series=967868
Version: 1

Stop unnecessarily registering a "crc32-generic" shash_alg when a "crc32-$(ARCH)" shash_alg is registered too. While every algorithm does need to have a generic implementation to ensure uniformity of support across platforms, that doesn't mean that we need to make the generic implementation available through crypto_shash when an optimized implementation is also available. Registering the generic shash_alg did allow users of the crypto_shash or crypto_ahash APIs to request the generic implementation specifically, instead of an optimized one. However, the only known use case for that was the differential fuzz tests in crypto/testmgr.c. Equivalent test coverage is now provided by crc_kunit. Besides simplifying crypto/crc32.c, this change eliminates the need for the library to provide crc32_le_base() as part of its interface. Later patches will make crc32_le_base() be internal to the library. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

Stop unnecessarily registering a "crc32c-generic" shash_alg when a "crc32c-$(ARCH)" shash_alg is registered too. While every algorithm does need to have a generic implementation to ensure uniformity of support across platforms, that doesn't mean that we need to make the generic implementation available through crypto_shash when an optimized implementation is also available. Registering the generic shash_alg did allow users of the crypto_shash or crypto_ahash APIs to request the generic implementation specifically, instead of an optimized one. However, the only known use case for that was the differential fuzz tests in crypto/testmgr.c. Equivalent test coverage is now provided by crc_kunit. Besides simplifying crypto/crc32c.c, this change eliminates the need for the library to provide crc32c_base() as part of its interface. Later patches will make crc32c_base() be internal to the library. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

Move all CRC files in lib/ into a subdirectory lib/crc/ to keep them from cluttering up the main lib/ directory. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

Rework how lib/crc/ supports arch-optimized code. First, instead of the arch-optimized code being in arch/$(SRCARCH)/lib/, it will now be in lib/crc/$(SRCARCH)/. Second, the API functions (e.g. crc32c()), arch-optimized functions (e.g. crc32c_arch()), and generic functions (e.g. crc32c_base()) will now be part of a single module for each CRC type, allowing better inlining and dead code elimination. The second change is made possible by the first. As an example, consider CONFIG_CRC32=m on x86. We'll now have just crc32.ko instead of both crc32-x86.ko and crc32.ko. The two modules were already coupled together and always both got loaded together via direct symbol dependency, so the separation provided no benefit. Note: later I'd like to apply the same design to lib/crypto/ too, where often the API functions are out-of-line so this will work even better. In those cases, for each algorithm we currently have 3 modules all coupled together, e.g. libsha256.ko, libsha256-generic.ko, and sha256-x86.ko. We should have just one, inline things properly, and rely on the compiler's dead code elimination to decide the inclusion of the generic code instead of manually setting it via kconfig. Having arch-specific code outside arch/ was somewhat controversial when Zinc proposed it back in 2018. But I don't think the concerns are warranted. It's better from a technical perspective, as it enables the improvements mentioned above. This model is already successfully used in other places in the kernel such as lib/raid6/. The community of each architecture still remains free to work on the code, even if it's not in arch/. At the time there was also a desire to put the library code in the same files as the old-school crypto API, but that was a mistake; now that the library is separate, that's no longer a constraint either. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

Move the arm-optimized CRC code from arch/arm/lib/crc* into its new location in lib/crc/arm/, and wire it up in the new way. For a detailed explanation of why this change is being made, see the commit that introduced the new way of integrating arch-specific code into lib/crc/. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

Move the arm64-optimized CRC code from arch/arm64/lib/crc* into its new location in lib/crc/arm64/, and wire it up in the new way. For a detailed explanation of why this change is being made, see the commit that introduced the new way of integrating arch-specific code into lib/crc/. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

Move the loongarch-optimized CRC code from arch/loongarch/lib/crc* into its new location in lib/crc/loongarch/, and wire it up in the new way. For a detailed explanation of why this change is being made, see the commit that introduced the new way of integrating arch-specific code into lib/crc/. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

Move the mips-optimized CRC code from arch/mips/lib/crc* into its new location in lib/crc/mips/, and wire it up in the new way. For a detailed explanation of why this change is being made, see the commit that introduced the new way of integrating arch-specific code into lib/crc/. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

Move the powerpc-optimized CRC code from arch/powerpc/lib/crc* into its new location in lib/crc/powerpc/, and wire it up in the new way. For a detailed explanation of why this change is being made, see the commit that introduced the new way of integrating arch-specific code into lib/crc/. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

Move the riscv-optimized CRC code from arch/riscv/lib/crc* into its new location in lib/crc/riscv/, and wire it up in the new way. For a detailed explanation of why this change is being made, see the commit that introduced the new way of integrating arch-specific code into lib/crc/. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

Move the s390-optimized CRC code from arch/s390/lib/crc* into its new location in lib/crc/s390/, and wire it up in the new way. For a detailed explanation of why this change is being made, see the commit that introduced the new way of integrating arch-specific code into lib/crc/. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

Move the sparc-optimized CRC code from arch/sparc/lib/crc* into its new location in lib/crc/sparc/, and wire it up in the new way. For a detailed explanation of why this change is being made, see the commit that introduced the new way of integrating arch-specific code into lib/crc/. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

Move the x86-optimized CRC code from arch/x86/lib/crc* into its new location in lib/crc/x86/, and wire it up in the new way. For a detailed explanation of why this change is being made, see the commit that introduced the new way of integrating arch-specific code into lib/crc/. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

linux-riscv-bot · 2025-06-01T23:49:05Z

Patch 1: "[01/13] crypto/crc32: register only one shash_alg"
build-rv32-defconfig
Desc: Builds riscv32 defconfig
Duration: 108.18 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:05:26Z

Patch 1: "[01/13] crypto/crc32: register only one shash_alg"
build-rv64-clang-allmodconfig
Desc: Builds riscv64 allmodconfig with Clang, and checks for errors and added warnings
Duration: 979.71 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:26:29Z

Patch 1: "[01/13] crypto/crc32: register only one shash_alg"
build-rv64-gcc-allmodconfig
Desc: Builds riscv64 allmodconfig with GCC, and checks for errors and added warnings
Duration: 1261.66 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:26:53Z

Patch 1: "[01/13] crypto/crc32: register only one shash_alg"
build-rv64-nommu-k210-defconfig
Desc: Builds riscv64 defconfig with NOMMU for K210
Duration: 22.34 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:27:18Z

Patch 1: "[01/13] crypto/crc32: register only one shash_alg"
build-rv64-nommu-k210-virt
Desc: Builds riscv64 defconfig with NOMMU for the virt platform
Duration: 23.69 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:27:20Z

Patch 1: "[01/13] crypto/crc32: register only one shash_alg"
checkpatch
Desc: Runs checkpatch.pl on the patch
Duration: 0.75 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:28:31Z

Patch 1: "[01/13] crypto/crc32: register only one shash_alg"
dtb-warn-rv64
Desc: Checks for Device Tree warnings/errors
Duration: 69.52 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:28:32Z

Patch 1: "[01/13] crypto/crc32: register only one shash_alg"
header-inline
Desc: Detects static functions without inline keyword in header files
Duration: 0.23 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:28:35Z

Patch 1: "[01/13] crypto/crc32: register only one shash_alg"
kdoc
Desc: Detects for kdoc errors
Duration: 0.82 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:28:36Z

Patch 1: "[01/13] crypto/crc32: register only one shash_alg"
module-param
Desc: Detect module_param changes
Duration: 0.24 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:28:38Z

Patch 1: "[01/13] crypto/crc32: register only one shash_alg"
verify-fixes
Desc: Verifies that the Fixes: tags exist
Duration: 0.22 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:28:40Z

Patch 1: "[01/13] crypto/crc32: register only one shash_alg"
verify-signedoff
Desc: Verifies that Signed-off-by: tags are correct
Duration: 0.29 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:30:41Z

Patch 2: "[02/13] crypto/crc32c: register only one shash_alg"
build-rv32-defconfig
Desc: Builds riscv32 defconfig
Duration: 105.83 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T00:46:59Z

Patch 2: "[02/13] crypto/crc32c: register only one shash_alg"
build-rv64-clang-allmodconfig
Desc: Builds riscv64 allmodconfig with Clang, and checks for errors and added warnings
Duration: 977.01 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T01:08:02Z

Patch 2: "[02/13] crypto/crc32c: register only one shash_alg"
build-rv64-gcc-allmodconfig
Desc: Builds riscv64 allmodconfig with GCC, and checks for errors and added warnings
Duration: 1261.35 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T01:08:25Z

Patch 2: "[02/13] crypto/crc32c: register only one shash_alg"
build-rv64-nommu-k210-defconfig
Desc: Builds riscv64 defconfig with NOMMU for K210
Duration: 21.54 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T08:42:45Z

Patch 13: "[13/13] lib/crc/x86: migrate x86-optimized CRC code into lib/crc/"
checkpatch
Desc: Runs checkpatch.pl on the patch
Duration: 4.15 seconds
Result: WARNING
Output:

WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#23: 
 {arch/x86/lib => lib/crc/x86}/crc32-pclmul.S  |  0

total: 0 errors, 1 warnings, 0 checks, 207 lines checked

NOTE: For some of the reported defects, checkpatch may be able to
      mechanically convert to the typical style using --fix or --fix-inplace.

Commit d35b04e73f1c ("lib/crc/x86: migrate x86-optimized CRC code into lib/crc/") has style problems, please review.

NOTE: Ignored message types: ALLOC_SIZEOF_STRUCT CAMELCASE COMMIT_LOG_LONG_LINE GIT_COMMIT_ID MACRO_ARG_REUSE NO_AUTHOR_SIGN_OFF

NOTE: If any of the errors are false positives, please report
      them to the maintainer, see CHECKPATCH in MAINTAINERS.
total: 0 errors, 1 warnings, 0 checks, 207 lines checked
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?

linux-riscv-bot · 2025-06-02T08:43:56Z

Patch 13: "[13/13] lib/crc/x86: migrate x86-optimized CRC code into lib/crc/"
dtb-warn-rv64
Desc: Checks for Device Tree warnings/errors
Duration: 70.08 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T08:43:59Z

Patch 13: "[13/13] lib/crc/x86: migrate x86-optimized CRC code into lib/crc/"
header-inline
Desc: Detects static functions without inline keyword in header files
Duration: 0.99 seconds
Result: ERROR
Output:

Detected static functions without inline keyword in header files:
+
+static __ro_after_init DEFINE_STATIC_KEY_FALSE(have_pclmulqdq);
+
--
+
+static __ro_after_init DEFINE_STATIC_KEY_FALSE(have_crc32);
+static __ro_after_init DEFINE_STATIC_KEY_FALSE(have_pclmulqdq);
+
--
+
+static __ro_after_init DEFINE_STATIC_KEY_FALSE(have_pclmulqdq);
+
Detected static functions without inline keyword in header files: 1

linux-riscv-bot · 2025-06-02T08:44:01Z

Patch 13: "[13/13] lib/crc/x86: migrate x86-optimized CRC code into lib/crc/"
kdoc
Desc: Detects for kdoc errors
Duration: 0.87 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T08:44:03Z

Patch 13: "[13/13] lib/crc/x86: migrate x86-optimized CRC code into lib/crc/"
module-param
Desc: Detect module_param changes
Duration: 0.28 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T08:44:05Z

Patch 13: "[13/13] lib/crc/x86: migrate x86-optimized CRC code into lib/crc/"
verify-fixes
Desc: Verifies that the Fixes: tags exist
Duration: 0.22 seconds
Result: PASS

linux-riscv-bot · 2025-06-02T08:44:06Z

Patch 13: "[13/13] lib/crc/x86: migrate x86-optimized CRC code into lib/crc/"
verify-signedoff
Desc: Verifies that Signed-off-by: tags are correct
Duration: 0.31 seconds
Result: PASS

Linux RISC-V bot and others added 14 commits June 1, 2025 19:40

Adding CI files

f8cfeb8

lib/crc: move files into lib/crc/

dd5ffe3

Move all CRC files in lib/ into a subdirectory lib/crc/ to keep them from cluttering up the main lib/ directory. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Linux RISC-V bot <linux.riscv.bot@gmail.com>

linux-riscv-bot force-pushed the workflow branch 21 times, most recently from 83b702b to b94890f Compare June 7, 2025 19:16

linux-riscv-bot closed this Jun 7, 2025

linux-riscv-bot deleted the pw967868 branch June 7, 2025 21:18

Conversation

linux-riscv-bot commented Jun 1, 2025

Uh oh!

linux-riscv-bot commented Jun 1, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

linux-riscv-bot commented Jun 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants