Skip to contentSkip to conversation

smb: improve search speed of SMB2 maperror

PATCH In review [email protected] 2 participants 7 messages Jan 18 – Feb 10

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

v9 cover smb: improve search speed of SMB2 maperror

From: ChenXiaoSong <[email protected]>

v8: https://lore.kernel.org/linux-cifs/[email protected]/
v8->v9:
- Fix build error when CONFIG_CIFS=y

The following patches from v8 have already been merged into cifs-2.6.git for-next:
- 9303cdba632a smb/client: use bsearch() to find target in smb2_error_map_table
- 430ae68414c2 smb/client: check whether smb2_error_map_table is sorted in ascending order
- 9d40867a8685 cifs: Autogenerate SMB2 error mapping table
- ce609a4b3a27 cifs: Label SMB2 statuses with errors

v4: https://lore.kernel.org/linux-cifs/[email protected]/
The following patches from v4 have already been merged into the mainline:
- 01ab0d1640e3 smb/server: rename include guard in smb_common.h
- d8f52650b24d smb/client: update some SMB2 status strings
- d159702c9492 smb/client: add two elements to smb2_error_map_table array
- 523ecd976632 smb: rename to STATUS_SMB_NO_PREAUTH_INTEGRITY_HASH_OVERLAP
- bf80d1517dc8 smb/client: remove unused elements from smb2_error_map_table array
- 6c1eb31ecb97 smb/client: reduce loop count in map_smb2_to_linux_error() by half

When searching for the last element and printing error message, the comparison count are shown in the table below:

+----------+--------+--------+
|          | Before | After  |
|          |Patchset|Patchset|
+----------+--------+--------+
|Comparison|  3486  |   10   |
|  Count   |        |        |
+----------+--------+--------+

ChenXiaoSong (1):
smb/client: introduce KUnit test to check search result of
smb2_error_map_table

 fs/smb/Kconfig                    | 17 ++++++++++++
 fs/smb/client/smb2maperror.c      |  8 ++++++
 fs/smb/client/smb2maperror_test.c | 45 +++++++++++++++++++++++++++++++
 3 files changed, 70 insertions(+)
 create mode 100644 fs/smb/client/smb2maperror_test.c
Signature · 1 line
2.43.0
#1 lore raw

PATCH v9 1/1 smb/client: introduce KUnit test to check search result of smb2_error_map_table

From: ChenXiaoSong <[email protected]>

The KUnit test are executed when cifs.ko is loaded.

Just like fs/ext4/mballoc.c includes fs/ext4/mballoc-test.c. smb2maperror.c also includes smb2maperror_test.c, allowing KUnit tests to access any functions and variables in smb2maperror.c.

The maperror_test_check_search() checks whether all elements can be correctly found in the array.

---
 fs/smb/Kconfig                    | 17 ++++++++++++
 fs/smb/client/smb2maperror.c      |  8 ++++++
 fs/smb/client/smb2maperror_test.c | 45 +++++++++++++++++++++++++++++++
 3 files changed, 70 insertions(+)
 create mode 100644 fs/smb/client/smb2maperror_test.c
fs/smb/Kconfig +17 -0
index ef425789fa6a..85f7ad5fbc5e 100644
@@ -9,3 +9,20 @@ config SMBFS
 	tristate
 	default y if CIFS=y || SMB_SERVER=y
 	default m if CIFS=m || SMB_SERVER=m
+
+config SMB_KUNIT_TESTS
+	tristate "KUnit tests for SMB" if !KUNIT_ALL_TESTS
+	depends on SMBFS && KUNIT
+	default KUNIT_ALL_TESTS
+	help
+	  This builds the SMB KUnit tests.
+
+	  KUnit tests run during boot and output the results to the debug log
+	  in TAP format (https://testanything.org/). Only useful for kernel devs
+	  running KUnit test harness and are not for inclusion into a production
+	  build.
+
+	  For more information on KUnit and unit tests in general please refer
+	  to the KUnit documentation in Documentation/dev-tools/kunit/.
+
+	  If unsure, say N.
fs/smb/client/smb2maperror.c +8 -0
index 090bbd10623d..cd036365201f 100644
@@ -114,3 +114,11 @@ int __init smb2_init_maperror(void)
 
 	return 0;
 }
+
+#define SMB_CLIENT_KUNIT_AVAILABLE \
+	((IS_MODULE(CONFIG_CIFS) && IS_ENABLED(CONFIG_KUNIT)) || \
+	 (IS_BUILTIN(CONFIG_CIFS) && IS_BUILTIN(CONFIG_KUNIT)))
+
+#if SMB_CLIENT_KUNIT_AVAILABLE && IS_ENABLED(CONFIG_SMB_KUNIT_TESTS)
+#include "smb2maperror_test.c"
+#endif /* CONFIG_SMB_KUNIT_TESTS */
fs/smb/client/smb2maperror_test.c new file +45 -0

45 lines not on this page · raw message

Signature · 1 line
2.43.0
#2 lore raw

Re: [PATCH v9 1/1] smb/client: introduce KUnit test to check search result of smb2_error_map_table

When CONFIG_EXT4_FS=m, the mballoc-test.c KUnit tests in the ext4 module cannot be executed. I have reported the ext4 issue to my friend Ye Bin <[email protected]>, and he will modify ext4 to handle this case in a similar way to how we did for SMB.

Thanks,
ChenXiaoSong <[email protected]>

Quoted 14 lines · On 1/18/26 17:13, [email protected] wrote:
fs/smb/client/smb2maperror.c +8 -0
@@ -114,3 +114,11 @@ int __init smb2_init_maperror(void)
 
  	return 0;
  }
+
+#define SMB_CLIENT_KUNIT_AVAILABLE \
+	((IS_MODULE(CONFIG_CIFS) && IS_ENABLED(CONFIG_KUNIT)) || \
+	 (IS_BUILTIN(CONFIG_CIFS) && IS_BUILTIN(CONFIG_KUNIT)))
+
+#if SMB_CLIENT_KUNIT_AVAILABLE && IS_ENABLED(CONFIG_SMB_KUNIT_TESTS)
+#include "smb2maperror_test.c"
+#endif /* CONFIG_SMB_KUNIT_TESTS */
#3 lore raw

Re: [PATCH v9 1/1] smb/client: introduce KUnit test to check search result of smb2_error_map_table

In reply to [email protected]

Hi ChenXiaoSong,

Thanks for your patch, which is now commit 480afcb19b61385d ("smb/client: introduce KUnit test to check search result of smb2_error_map_table") in linus/master

Quoted 1 line

The KUnit test are executed when cifs.ko is loaded.

This means the tests are _always_ executed when cifs.ko is loaded, which is different from how most other test modules work. Please make it a separate test module, so it can be loaded independently of the main cifs module. That way people can enable all tests in production kernels, without affecting the system unless a test module is actually loaded.

Quoted 98 lines

Just like fs/ext4/mballoc.c includes fs/ext4/mballoc-test.c. smb2maperror.c also includes smb2maperror_test.c, allowing KUnit tests to access any functions and variables in smb2maperror.c.

The maperror_test_check_search() checks whether all elements can be correctly found in the array.

---
 fs/smb/Kconfig                    | 17 ++++++++++++
 fs/smb/client/smb2maperror.c      |  8 ++++++
 fs/smb/client/smb2maperror_test.c | 45 +++++++++++++++++++++++++++++++
 3 files changed, 70 insertions(+)
 create mode 100644 fs/smb/client/smb2maperror_test.c
fs/smb/Kconfig +17 -0
index ef425789fa6a..85f7ad5fbc5e 100644
@@ -9,3 +9,20 @@ config SMBFS
 	tristate
 	default y if CIFS=y || SMB_SERVER=y
 	default m if CIFS=m || SMB_SERVER=m
+
+config SMB_KUNIT_TESTS
+	tristate "KUnit tests for SMB" if !KUNIT_ALL_TESTS
+	depends on SMBFS && KUNIT
+	default KUNIT_ALL_TESTS
+	help
+	  This builds the SMB KUnit tests.
+
+	  KUnit tests run during boot and output the results to the debug log
+	  in TAP format (https://testanything.org/). Only useful for kernel devs
+	  running KUnit test harness and are not for inclusion into a production
+	  build.
+
+	  For more information on KUnit and unit tests in general please refer
+	  to the KUnit documentation in Documentation/dev-tools/kunit/.
+
+	  If unsure, say N.
fs/smb/client/smb2maperror.c +8 -0
index 090bbd10623d..cd036365201f 100644
@@ -114,3 +114,11 @@ int __init smb2_init_maperror(void)
 
 	return 0;
 }
+
+#define SMB_CLIENT_KUNIT_AVAILABLE \
+	((IS_MODULE(CONFIG_CIFS) && IS_ENABLED(CONFIG_KUNIT)) || \
+	 (IS_BUILTIN(CONFIG_CIFS) && IS_BUILTIN(CONFIG_KUNIT)))
+
+#if SMB_CLIENT_KUNIT_AVAILABLE && IS_ENABLED(CONFIG_SMB_KUNIT_TESTS)
+#include "smb2maperror_test.c"
+#endif /* CONFIG_SMB_KUNIT_TESTS */
fs/smb/client/smb2maperror_test.c new file +35 -0
new file mode 100644
index 000000000000..38ea6b846a99
@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: LGPL-2.1
+/*
+ *
+ *   KUnit tests of SMB2 maperror
+ *
+ *   Copyright (C) 2025 KylinSoft Co., Ltd. All rights reserved.
+ *   Author(s): ChenXiaoSong <[email protected]>
+ *
+ */
+
+#include <kunit/test.h>
+
+static void
+test_cmp_map(struct kunit *test, const struct status_to_posix_error *expect)
+{
+	const struct status_to_posix_error *result;
+
+	result = smb2_get_err_map(expect->smb2_status);
+	KUNIT_EXPECT_PTR_NE(test, NULL, result);
+	KUNIT_EXPECT_EQ(test, expect->smb2_status, result->smb2_status);
+	KUNIT_EXPECT_EQ(test, expect->posix_error, result->posix_error);
+	KUNIT_EXPECT_STREQ(test, expect->status_string, result->status_string);
+}
+
+static void maperror_test_check_search(struct kunit *test)
+{
+	unsigned int i;
+
+	for (i = 0; i < ARRAY_SIZE(smb2_error_map_table); i++)
+		test_cmp_map(test, &smb2_error_map_table[i]);
+}
+
+static struct kunit_case maperror_test_cases[] = {
+	KUNIT_CASE(maperror_test_check_search),
+	{}

fs/smb/client/smb2maperror_test.c line 45

Quoted 10 lines
fs/smb/client/smb2maperror_test.c new file +10 -0
+};
+
+static struct kunit_suite maperror_suite = {
+	.name = "smb2_maperror",
+	.test_cases = maperror_test_cases,
+};
+
+kunit_test_suite(maperror_suite);
+
+MODULE_LICENSE("GPL");

Gr{oetje,eeting}s,

Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that.
-- Linus Torvalds

#4 lore raw

Re: [PATCH v9 1/1] smb/client: introduce KUnit test to check search result of smb2_error_map_table

Hi Geert,

Thank you for reviewing this patch.

The KUnit test cases are only executed when the CONFIG_SMB_KUNIT_TESTS is enabled.

Making it a separate test module would require exporting local variables and functions so that the test code can access them. However, exporting local variables and functions would likely make the code much uglier, as it would require adding "#if" conditionals into the production code to isolate the test code.

Geert, please let me know if you have a better idea.

I am also discussing this with the ext4 community, and we all hope to find a way to make the tests a separate module.

Thanks,
ChenXiaoSong <[email protected]>

Quoted 13 lines · Geert Uytterhoeven

Hi ChenXiaoSong,

Thanks for your patch, which is now commit 480afcb19b61385d ("smb/client: introduce KUnit test to check search result of smb2_error_map_table") in linus/master

Quoted 1 line

The KUnit test are executed when cifs.ko is loaded.

This means the tests are_always_ executed when cifs.ko is loaded, which is different from how most other test modules work. Please make it a separate test module, so it can be loaded independently of the main cifs module. That way people can enable all tests in production kernels, without affecting the system unless a test module is actually loaded.

#5 lore raw

Re: [PATCH v9 1/1] smb/client: introduce KUnit test to check search result of smb2_error_map_table

Hi ChenXiaoSong,

Quoted 2 lines · ChenXiaoSong

The KUnit test cases are only executed when the CONFIG_SMB_KUNIT_TESTS is enabled.

... which defaults to KUNIT_ALL_TESTS, so if KUNIT_ALL_TESTS is enabled, the test is enabled by default, too.

Quoted 10 lines

Making it a separate test module would require exporting local variables and functions so that the test code can access them. However, exporting local variables and functions would likely make the code much uglier, as it would require adding "#if" conditionals into the production code to isolate the test code.

Geert, please let me know if you have a better idea.

I am also discussing this with the ext4 community, and we all hope to find a way to make the tests a separate module.

There are ways to restrict exported symbols to test modules only, see EXPORT_SYMBOL_FOR_TESTS_ONLY(), EXPORT_SYMBOL_FOR_MODULES(), and EXPORT_SYMBOL_NS().

If it is really hard to convert the tests into a separate module, you can add a new kernel/module parameter, which needs to be specified explicitly to run the test. That would avoid running the tests when just (auto)loading cifs.ko.

Quoted 5 lines · Geert Uytterhoeven
Quoted 4 lines

Thanks for your patch, which is now commit 480afcb19b61385d ("smb/client: introduce KUnit test to check search result of smb2_error_map_table") in linus/master

Quoted 7 lines
Quoted 7 lines
Quoted 1 line

The KUnit test are executed when cifs.ko is loaded.

This means the tests are_always_ executed when cifs.ko is loaded, which is different from how most other test modules work. Please make it a separate test module, so it can be loaded independently of the main cifs module. That way people can enable all tests in production kernels, without affecting the system unless a test module is actually loaded.

Gr{oetje,eeting}s,

Geert

Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds
#6 lore raw

Re: [PATCH v9 1/1] smb/client: introduce KUnit test to check search result of smb2_error_map_table

Thanks for your suggestions, these are really helpful. I will make the changes as soon as possible.

Thanks,
ChenXiaoSong <[email protected]>

Quoted 47 lines · Geert Uytterhoeven

Hi ChenXiaoSong,

Quoted 2 lines · ChenXiaoSong

The KUnit test cases are only executed when the CONFIG_SMB_KUNIT_TESTS is enabled.

... which defaults to KUNIT_ALL_TESTS, so if KUNIT_ALL_TESTS is enabled, the test is enabled by default, too.

Quoted 10 lines

Making it a separate test module would require exporting local variables and functions so that the test code can access them. However, exporting local variables and functions would likely make the code much uglier, as it would require adding "#if" conditionals into the production code to isolate the test code.

Geert, please let me know if you have a better idea.

I am also discussing this with the ext4 community, and we all hope to find a way to make the tests a separate module.

There are ways to restrict exported symbols to test modules only, see EXPORT_SYMBOL_FOR_TESTS_ONLY(), EXPORT_SYMBOL_FOR_MODULES(), and EXPORT_SYMBOL_NS().

If it is really hard to convert the tests into a separate module, you can add a new kernel/module parameter, which needs to be specified explicitly to run the test. That would avoid running the tests when just (auto)loading cifs.ko.

Quoted 5 lines · Geert Uytterhoeven
Quoted 4 lines

Thanks for your patch, which is now commit 480afcb19b61385d ("smb/client: introduce KUnit test to check search result of smb2_error_map_table") in linus/master

Quoted 7 lines
Quoted 7 lines
Quoted 1 line

The KUnit test are executed when cifs.ko is loaded.

This means the tests are_always_ executed when cifs.ko is loaded, which is different from how most other test modules work. Please make it a separate test module, so it can be loaded independently of the main cifs module. That way people can enable all tests in production kernels, without affecting the system unless a test module is actually loaded.

Gr{oetje,eeting}s,

Geert