diff mbox series

Kunit to check the longest symbol length

Message ID 20231105184010.49194-1-sergio.collado@gmail.com (mailing list archive)
State New
Headers show
Series Kunit to check the longest symbol length | expand

Commit Message

Sergio González Collado Nov. 5, 2023, 6:40 p.m. UTC
The longest length of a symbol (KSYM_NAME_LEN) was increased to 512
in the reference [1]. This patch adds a kunit test to check the longest
symbol length.

[1] https://lore.kernel.org/lkml/20220802015052.10452-6-ojeda@kernel.org/

Signed-off-by: Sergio González Collado <sergio.collado@gmail.com>
---
 lib/Kconfig.debug          |   9 +++
 lib/Makefile               |   1 +
 lib/longest_symbol_kunit.c | 120 +++++++++++++++++++++++++++++++++++++
 3 files changed, 130 insertions(+)
 create mode 100644 lib/longest_symbol_kunit.c

Comments

Martin Rodriguez Reboredo Nov. 5, 2023, 7:25 p.m. UTC | #1
On 11/5/23 15:40, Sergio González Collado wrote:
> The longest length of a symbol (KSYM_NAME_LEN) was increased to 512
> in the reference [1]. This patch adds a kunit test to check the longest
> symbol length.
> 
> [1] https://lore.kernel.org/lkml/20220802015052.10452-6-ojeda@kernel.org/
> 
> Signed-off-by: Sergio González Collado <sergio.collado@gmail.com>
> ---
> [...]
Alles gut!

Tested-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com>
Benno Lossin Nov. 5, 2023, 8:33 p.m. UTC | #2
On 05.11.23 19:40, Sergio González Collado wrote:
> The longest length of a symbol (KSYM_NAME_LEN) was increased to 512
> in the reference [1]. This patch adds a kunit test to check the longest
> symbol length.
> 
> [1] https://lore.kernel.org/lkml/20220802015052.10452-6-ojeda@kernel.org/
> 
> Signed-off-by: Sergio González Collado <sergio.collado@gmail.com>
> ---
>   lib/Kconfig.debug          |   9 +++
>   lib/Makefile               |   1 +
>   lib/longest_symbol_kunit.c | 120 +++++++++++++++++++++++++++++++++++++
>   3 files changed, 130 insertions(+)
>   create mode 100644 lib/longest_symbol_kunit.c

I am a bit confused why this is *only* sent to the rust-for-linux list.
Especially since there is no rust code and the changes do not change anything
that Rust code uses.

Shouldn't this go to linux-kernel list and the maintainers of lib/Makefile
instead?
Benno Lossin Nov. 5, 2023, 8:40 p.m. UTC | #3
On 05.11.23 21:33, Benno Lossin wrote:
> On 05.11.23 19:40, Sergio González Collado wrote:
>> The longest length of a symbol (KSYM_NAME_LEN) was increased to 512
>> in the reference [1]. This patch adds a kunit test to check the longest
>> symbol length.
>>
>> [1] https://lore.kernel.org/lkml/20220802015052.10452-6-ojeda@kernel.org/
>>
>> Signed-off-by: Sergio González Collado <sergio.collado@gmail.com>
>> ---
>>    lib/Kconfig.debug          |   9 +++
>>    lib/Makefile               |   1 +
>>    lib/longest_symbol_kunit.c | 120 +++++++++++++++++++++++++++++++++++++
>>    3 files changed, 130 insertions(+)
>>    create mode 100644 lib/longest_symbol_kunit.c
> 
> I am a bit confused why this is *only* sent to the rust-for-linux list.
> Especially since there is no rust code and the changes do not change anything
> that Rust code uses.
> 
> Shouldn't this go to linux-kernel list and the maintainers of lib/Makefile
> instead?

Seems I missed the "To: linux-kself" and others, sorry for the noise.
kernel test robot Nov. 7, 2023, 12:30 a.m. UTC | #4
Hi Sergio,

kernel test robot noticed the following build errors:

[auto build test ERROR on linus/master]
[also build test ERROR on v6.6 next-20231106]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Sergio-Gonz-lez-Collado/Kunit-to-check-the-longest-symbol-length/20231106-024653
base:   linus/master
patch link:    https://lore.kernel.org/r/20231105184010.49194-1-sergio.collado%40gmail.com
patch subject: [PATCH] Kunit to check the longest symbol length
config: i386-randconfig-014-20231106 (https://download.01.org/0day-ci/archive/20231107/202311070705.7aFWz7q4-lkp@intel.com/config)
compiler: gcc-12 (Debian 12.2.0-14) 12.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231107/202311070705.7aFWz7q4-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202311070705.7aFWz7q4-lkp@intel.com/

All errors (new ones prefixed by >>):

>> arch/x86/tools/insn_decoder_test: error: malformed line 1810458:
   7nnnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m
kernel test robot Nov. 7, 2023, 7:34 p.m. UTC | #5
Hi Sergio,

kernel test robot noticed the following build warnings:

[auto build test WARNING on linus/master]
[also build test WARNING on v6.6 next-20231107]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Sergio-Gonz-lez-Collado/Kunit-to-check-the-longest-symbol-length/20231106-024653
base:   linus/master
patch link:    https://lore.kernel.org/r/20231105184010.49194-1-sergio.collado%40gmail.com
patch subject: [PATCH] Kunit to check the longest symbol length
config: sparc-allyesconfig (https://download.01.org/0day-ci/archive/20231108/202311080319.fCEp5dTC-lkp@intel.com/config)
compiler: sparc64-linux-gcc (GCC) 13.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231108/202311080319.fCEp5dTC-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202311080319.fCEp5dTC-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> lib/longest_symbol_kunit.c:16:18: warning: no previous prototype for 'snnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7n' [-Wmissing-prototypes]
      16 | #define DI(name) s##name##name
         |                  ^
   lib/longest_symbol_kunit.c:17:19: note: in expansion of macro 'DI'
      17 | #define DDI(name) DI(n##name##name)
         |                   ^~
   lib/longest_symbol_kunit.c:18:20: note: in expansion of macro 'DDI'
      18 | #define DDDI(name) DDI(n##name##name)
         |                    ^~~
   lib/longest_symbol_kunit.c:19:21: note: in expansion of macro 'DDDI'
      19 | #define DDDDI(name) DDDI(n##name##name)
         |                     ^~~~
   lib/longest_symbol_kunit.c:20:22: note: in expansion of macro 'DDDDI'
      20 | #define DDDDDI(name) DDDDI(n##name##name)
         |                      ^~~~~
   lib/longest_symbol_kunit.c:25:27: note: in expansion of macro 'DDDDDI'
      25 | #define LONGEST_SYM_NAME  DDDDDI(g1h2i3j4k5l6m7n)
         |                           ^~~~~~
   lib/longest_symbol_kunit.c:33:14: note: in expansion of macro 'LONGEST_SYM_NAME'
      33 | noinline int LONGEST_SYM_NAME(void)
         |              ^~~~~~~~~~~~~~~~
   In file included from <command-line>:
   lib/longest_symbol_kunit.c:16:18: warning: no previous prototype for 'snnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7ne' [-Wmissing-prototypes]
      16 | #define DI(name) s##name##name
         |                  ^
   include/linux/compiler_types.h:83:23: note: in definition of macro '___PASTE'
      83 | #define ___PASTE(a,b) a##b
         |                       ^
   lib/longest_symbol_kunit.c:22:21: note: in expansion of macro '__PASTE'
      22 | #define PLUS1(name) __PASTE(name, e)
         |                     ^~~~~~~
   lib/longest_symbol_kunit.c:28:32: note: in expansion of macro 'PLUS1'
      28 | #define LONGEST_SYM_NAME_PLUS1 PLUS1(LONGEST_SYM_NAME)
         |                                ^~~~~
   lib/longest_symbol_kunit.c:17:19: note: in expansion of macro 'DI'
      17 | #define DDI(name) DI(n##name##name)
         |                   ^~
   lib/longest_symbol_kunit.c:18:20: note: in expansion of macro 'DDI'
      18 | #define DDDI(name) DDI(n##name##name)
         |                    ^~~
   lib/longest_symbol_kunit.c:19:21: note: in expansion of macro 'DDDI'
      19 | #define DDDDI(name) DDDI(n##name##name)
         |                     ^~~~
   lib/longest_symbol_kunit.c:20:22: note: in expansion of macro 'DDDDI'
      20 | #define DDDDDI(name) DDDDI(n##name##name)
         |                      ^~~~~
   lib/longest_symbol_kunit.c:25:27: note: in expansion of macro 'DDDDDI'
      25 | #define LONGEST_SYM_NAME  DDDDDI(g1h2i3j4k5l6m7n)
         |                           ^~~~~~
   lib/longest_symbol_kunit.c:28:38: note: in expansion of macro 'LONGEST_SYM_NAME'
      28 | #define LONGEST_SYM_NAME_PLUS1 PLUS1(LONGEST_SYM_NAME)
         |                                      ^~~~~~~~~~~~~~~~
   lib/longest_symbol_kunit.c:38:14: note: in expansion of macro 'LONGEST_SYM_NAME_PLUS1'
      38 | noinline int LONGEST_SYM_NAME_PLUS1(void)
         |              ^~~~~~~~~~~~~~~~~~~~~~


vim +/snnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nnng1h2i3j4k5l6m7ng1h2i3j4k5l6m7nng1h2i3j4k5l6m7ng1h2i3j4k5l6m7n +16 lib/longest_symbol_kunit.c

    15	
  > 16	#define DI(name) s##name##name
    17	#define DDI(name) DI(n##name##name)
    18	#define DDDI(name) DDI(n##name##name)
    19	#define DDDDI(name) DDDI(n##name##name)
    20	#define DDDDDI(name) DDDDI(n##name##name)
    21
Martin Rodriguez Reboredo Nov. 10, 2023, 3:55 p.m. UTC | #6
On 11/5/23 15:40, Sergio González Collado wrote:
> [...]
> diff --git a/lib/Makefile b/lib/Makefile
> index 740109b6e2c8..82ac084b6bc6 100644
> --- a/lib/Makefile
> +++ b/lib/Makefile
> @@ -402,6 +402,7 @@ obj-$(CONFIG_FORTIFY_KUNIT_TEST) += fortify_kunit.o
>   obj-$(CONFIG_STRCAT_KUNIT_TEST) += strcat_kunit.o
>   obj-$(CONFIG_STRSCPY_KUNIT_TEST) += strscpy_kunit.o
>   obj-$(CONFIG_SIPHASH_KUNIT_TEST) += siphash_kunit.o
> +obj-$(CONFIG_LONGEST_SYM_KUNIT_TEST) += longest_symbol_kunit.o
>   
>   obj-$(CONFIG_GENERIC_LIB_DEVMEM_IS_ALLOWED) += devmem_is_allowed.o
>   

This test is triggering `-Wmissing-prototypes`, so you might have to
either add the prototypes or change the hunk to this.

diff --git a/lib/Makefile b/lib/Makefile
index 740109b6e2c8..b9d2577fbbe1 100644
--- a/lib/Makefile
+++ b/lib/Makefile
@@ -402,6 +402,8 @@ obj-$(CONFIG_FORTIFY_KUNIT_TEST) += fortify_kunit.o
  obj-$(CONFIG_STRCAT_KUNIT_TEST) += strcat_kunit.o
  obj-$(CONFIG_STRSCPY_KUNIT_TEST) += strscpy_kunit.o
  obj-$(CONFIG_SIPHASH_KUNIT_TEST) += siphash_kunit.o
+obj-$(CONFIG_LONGEST_SYM_KUNIT_TEST) += longest_symbol_kunit.o
+CFLAGS_longest_symbol_kunit.o += $(call cc-disable-warning, missing-prototypes)
  
  obj-$(CONFIG_GENERIC_LIB_DEVMEM_IS_ALLOWED) += devmem_is_allowed.o
  

> diff --git a/lib/longest_symbol_kunit.c b/lib/longest_symbol_kunit.c
> new file mode 100644
> index 000000000000..6282fbb7e991
> --- /dev/null
> +++ b/lib/longest_symbol_kunit.c
> [...]
> +
> +noinline int LONGEST_SYM_NAME(void)
> +{
> +	return RETURN_LONGEST_SYM;
> +}
> +
> +noinline int LONGEST_SYM_NAME_PLUS1(void)
> +{
> +	return RETURN_LONGEST_SYM_PLUS1;
> +}

arch/x86/tools/insn_decoder_test.c has a buffer size of 256 that might be
too short for these symbols, you might have to increase it for it to work.

> [...]
diff mbox series

Patch

diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug
index fa307f93fa2e..7c0ae4373aa6 100644
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -2760,6 +2760,15 @@  config FORTIFY_KUNIT_TEST
 	  by the str*() and mem*() family of functions. For testing runtime
 	  traps of FORTIFY_SOURCE, see LKDTM's "FORTIFY_*" tests.
 
+config LONGEST_SYM_KUNIT_TEST
+	tristate "Test the longest symbol possible" if !KUNIT_ALL_TESTS
+	depends on KUNIT && KPROBES
+	default KUNIT_ALL_TESTS
+	help
+	  Tests the longest symbol possible
+
+	  If unsure, say N.
+
 config HW_BREAKPOINT_KUNIT_TEST
 	bool "Test hw_breakpoint constraints accounting" if !KUNIT_ALL_TESTS
 	depends on HAVE_HW_BREAKPOINT
diff --git a/lib/Makefile b/lib/Makefile
index 740109b6e2c8..82ac084b6bc6 100644
--- a/lib/Makefile
+++ b/lib/Makefile
@@ -402,6 +402,7 @@  obj-$(CONFIG_FORTIFY_KUNIT_TEST) += fortify_kunit.o
 obj-$(CONFIG_STRCAT_KUNIT_TEST) += strcat_kunit.o
 obj-$(CONFIG_STRSCPY_KUNIT_TEST) += strscpy_kunit.o
 obj-$(CONFIG_SIPHASH_KUNIT_TEST) += siphash_kunit.o
+obj-$(CONFIG_LONGEST_SYM_KUNIT_TEST) += longest_symbol_kunit.o
 
 obj-$(CONFIG_GENERIC_LIB_DEVMEM_IS_ALLOWED) += devmem_is_allowed.o
 
diff --git a/lib/longest_symbol_kunit.c b/lib/longest_symbol_kunit.c
new file mode 100644
index 000000000000..6282fbb7e991
--- /dev/null
+++ b/lib/longest_symbol_kunit.c
@@ -0,0 +1,120 @@ 
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Test the longest symbol length. Execute with:
+ *  ./tools/testing/kunit/kunit.py run longest-symbol
+ *  --arch=x86_64 --kconfig_add CONFIG_KPROBES=y --kconfig_add CONFIG_MODULES=y
+ *  --kconfig_add CONFIG_RETPOLINE=n
+ */
+
+#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
+
+#include <kunit/test.h>
+#include <linux/stringify.h>
+#include <linux/kprobes.h>
+#include <linux/kallsyms.h>
+
+#define DI(name) s##name##name
+#define DDI(name) DI(n##name##name)
+#define DDDI(name) DDI(n##name##name)
+#define DDDDI(name) DDDI(n##name##name)
+#define DDDDDI(name) DDDDI(n##name##name)
+
+#define PLUS1(name) __PASTE(name, e)
+
+/*Generate a symbol whose name length is 511 */
+#define LONGEST_SYM_NAME  DDDDDI(g1h2i3j4k5l6m7n)
+
+/*Generate a symbol whose name length is 512 */
+#define LONGEST_SYM_NAME_PLUS1 PLUS1(LONGEST_SYM_NAME)
+
+#define RETURN_LONGEST_SYM 0xAAAAA
+#define RETURN_LONGEST_SYM_PLUS1 0x55555
+
+noinline int LONGEST_SYM_NAME(void)
+{
+	return RETURN_LONGEST_SYM;
+}
+
+noinline int LONGEST_SYM_NAME_PLUS1(void)
+{
+	return RETURN_LONGEST_SYM_PLUS1;
+}
+
+_Static_assert(sizeof(__stringify(LONGEST_SYM_NAME)) == KSYM_NAME_LEN,
+"Incorrect symbol length found. Expected KSYM_NAME_LEN: "
+__stringify(KSYM_NAME) ", but found: "
+__stringify(sizeof(LONGEST_SYM_NAME)));
+
+static void test_longest_symbol(struct kunit *test)
+{
+	KUNIT_EXPECT_EQ(test, RETURN_LONGEST_SYM, LONGEST_SYM_NAME());
+};
+
+static void test_longest_symbol_kallsyms(struct kunit *test)
+{
+	unsigned long (*kallsyms_lookup_name)(const char *name);
+	static int (*longest_sym)(void);
+
+	struct kprobe kp = {
+		.symbol_name = "kallsyms_lookup_name",
+	};
+
+	if (register_kprobe(&kp) < 0) {
+		pr_info("%s: kprobe not registered\n", __func__);
+		KUNIT_FAIL(test, "test_longest_symbol kallsysms: kprobe not registered\n");
+		return;
+	}
+
+	kunit_warn(test, "test_longest_symbol kallsyms: kprobe registered\n");
+	kallsyms_lookup_name = (unsigned long (*)(const char *name))kp.addr;
+	unregister_kprobe(&kp);
+
+	longest_sym =
+	    (void *) kallsyms_lookup_name(__stringify(LONGEST_SYM_NAME));
+	KUNIT_EXPECT_EQ(test, RETURN_LONGEST_SYM, longest_sym());
+};
+
+static void test_longest_symbol_plus1(struct kunit *test)
+{
+	KUNIT_EXPECT_EQ(test, RETURN_LONGEST_SYM_PLUS1, LONGEST_SYM_NAME_PLUS1());
+};
+
+static void test_longest_symbol_plus1_kallsyms(struct kunit *test)
+{
+	unsigned long (*kallsyms_lookup_name)(const char *name);
+	static int (*longest_sym_plus1)(void);
+
+	struct kprobe kp = {
+		.symbol_name = "kallsyms_lookup_name",
+	};
+
+	if (register_kprobe(&kp) < 0) {
+		pr_info("%s: kprobe not registered\n", __func__);
+		KUNIT_FAIL(test, "test_longest_symbol kallsysms: kprobe not registered\n");
+		return;
+	}
+
+	kunit_warn(test, "test_longest_symbol_plus1 kallsyms: kprobe registered\n");
+	kallsyms_lookup_name = (unsigned long (*)(const char *name))kp.addr;
+	unregister_kprobe(&kp);
+
+	longest_sym_plus1 =
+	    (void *) kallsyms_lookup_name(__stringify(LONGEST_SYM_NAME_PLUS1));
+	KUNIT_EXPECT_NULL(test, longest_sym_plus1);
+};
+
+static struct kunit_case longest_symbol_test_cases[] = {
+	KUNIT_CASE(test_longest_symbol),
+	KUNIT_CASE(test_longest_symbol_kallsyms),
+	KUNIT_CASE(test_longest_symbol_plus1),
+	KUNIT_CASE(test_longest_symbol_plus1_kallsyms),
+	{}
+};
+
+static struct kunit_suite longest_symbol_test_suite = {
+	.name = "longest-symbol",
+	.test_cases = longest_symbol_test_cases,
+};
+kunit_test_suite(longest_symbol_test_suite);
+
+MODULE_LICENSE("GPL");