Skip to contentSkip to conversation

Documentation/process: Add testing section to tip handbook

RFC PATCH In review Dave Hansen 3 participants 3 messages Mar 14, 2022 – Mar 31, 2022

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

RFC PATCH 1/1 Documentation/process: Add testing section to tip handbook

From: Dave Hansen <[email protected]>

The kernel has a wide variety of debugging options to help catch and squash bugs. However, new debugging is added all the time and the existing options can be hard to find.

Add a list of debugging options which tip maintainers expect to be used to test contributions.

This should make it easier for contributors to test their code and find issues before submission.

Cc Jonathan Corbet <[email protected]>
Cc Borislav Petkov <[email protected]>
Cc Thomas Gleixner <[email protected]>
---
 Documentation/process/maintainer-tip.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
Documentation/process/maintainer-tip.rst +24 -0
index c74f4a81588b..75f86b0f1cf0 100644
@@ -437,6 +437,30 @@ in a private repository which allows interested people to easily pull the
 series for testing. The usual way to offer this is a git URL in the cover
 letter of the patch series.
 
+Testing
+^^^^^^^
+
+Code should be tested before submitting to the tip maintainers.  Anything
+other than minor changes should be built, booted and tested with the
+following set of comprehensive (and heavyweight) set of kernel debugging
+options enabled.
+
+	CONFIG_X86_DEBUG_FPU=y
+	CONFIG_LOCK_STAT=y
+	CONFIG_DEBUG_VM=y
+	CONFIG_DEBUG_VM_VMACACHE=y
+	CONFIG_DEBUG_VM_RB=y
+	CONFIG_DEBUG_SLAB=y
+	CONFIG_DEBUG_KMEMLEAK=y
+	CONFIG_DEBUG_PAGEALLOC=y
+	CONFIG_SLUB_DEBUG_ON=y
+	CONFIG_KMEMCHECK=y
+	CONFIG_DEBUG_OBJECTS_ENABLE_DEFAULT=y
+	CONFIG_GCOV_KERNEL=y
+	CONFIG_LOCKDEP=y
+	CONFIG_PROVE_LOCKING=y
+	CONFIG_SCHEDSTATS=y
+	CONFIG_VMLINUX_VALIDATION=y
 
 Coding style notes
 ------------------
Signature · 1 line
2.34.0
#1 lore raw
Quoted 44 lines · Dave Hansen

From: Dave Hansen <[email protected]>

The kernel has a wide variety of debugging options to help catch and squash bugs. However, new debugging is added all the time and the existing options can be hard to find.

Add a list of debugging options which tip maintainers expect to be used to test contributions.

This should make it easier for contributors to test their code and find issues before submission.

Cc Jonathan Corbet <[email protected]>
Cc Borislav Petkov <[email protected]>
Cc Thomas Gleixner <[email protected]>
---
 Documentation/process/maintainer-tip.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
Documentation/process/maintainer-tip.rst +14 -0
index c74f4a81588b..75f86b0f1cf0 100644
@@ -437,6 +437,30 @@ in a private repository which allows interested people to easily pull the
 series for testing. The usual way to offer this is a git URL in the cover
 letter of the patch series.
 
+Testing
+^^^^^^^
+
+Code should be tested before submitting to the tip maintainers.  Anything
+other than minor changes should be built, booted and tested with the
+following set of comprehensive (and heavyweight) set of kernel debugging
+options enabled.
+
+	CONFIG_X86_DEBUG_FPU=y
+	CONFIG_LOCK_STAT=y
+	CONFIG_DEBUG_VM=y
+	CONFIG_DEBUG_VM_VMACACHE=y
+	CONFIG_DEBUG_VM_RB=y
+	CONFIG_DEBUG_SLAB=y

Documentation/process/maintainer-tip.rst in a private repository which allows interested people to easily pull the · line 463

Quoted 10 lines
Documentation/process/maintainer-tip.rst +10 -0
+	CONFIG_DEBUG_KMEMLEAK=y
+	CONFIG_DEBUG_PAGEALLOC=y
+	CONFIG_SLUB_DEBUG_ON=y
+	CONFIG_KMEMCHECK=y
+	CONFIG_DEBUG_OBJECTS_ENABLE_DEFAULT=y
+	CONFIG_GCOV_KERNEL=y
+	CONFIG_LOCKDEP=y
+	CONFIG_PROVE_LOCKING=y
+	CONFIG_SCHEDSTATS=y
+	CONFIG_VMLINUX_VALIDATION=y

It would be cool if there were a command I can run so that I can enable all those. Example:

$ grep CONFIG_VMLINUX_VALIDATION .config
$ ./scripts/config --enable CONFIG_VMLINUX_VALIDATION
$ grep CONFIG_VMLINUX_VALIDATION .config
CONFIG_VMLINUX_VALIDATION=y
$ make oldconfig
#
# configuration written to .config
#
$ grep CONFIG_VMLINUX_VALIDATION .config
$

Needs other options.

Maybe you could create a .config snippet which we can merge with scripts/kconfig/merge_config.sh... or maybe start from arch/x86/configs/x86_64_defconfig, add all those and call it

arch/x86/configs/x86_64_testconfig

or so.

Signature · 4 lines
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette
#2 lore raw
Quoted 7 lines · Borislav Petkov
Quoted 7 lines
Documentation/process/maintainer-tip.rst +7 -0
+Code should be tested before submitting to the tip maintainers.  Anything
+other than minor changes should be built, booted and tested with the
+following set of comprehensive (and heavyweight) set of kernel debugging
+options enabled.
+
+	CONFIG_X86_DEBUG_FPU=y
+	CONFIG_LOCK_STAT=y

...

Quoted 14 lines

It would be cool if there were a command I can run so that I can enable all those. Example:

$ grep CONFIG_VMLINUX_VALIDATION .config
$ ./scripts/config --enable CONFIG_VMLINUX_VALIDATION
$ grep CONFIG_VMLINUX_VALIDATION .config
CONFIG_VMLINUX_VALIDATION=y
$ make oldconfig
#
# configuration written to .config
#
$ grep CONFIG_VMLINUX_VALIDATION .config
$
Quoted 7 lines

Needs other options.

Maybe you could create a .config snippet which we can merge with scripts/kconfig/merge_config.sh... or maybe start from arch/x86/configs/x86_64_defconfig, add all those and call it

arch/x86/configs/x86_64_testconfig

Well, after some digging around it turns out that we're not the first ones with this problem. Just throwing those options into:

kernel/configs/x86_debug.config

and doing:

make x86_debug.config

will magically do:

	Using .config as base
	Merging /home/davehans/linux.git/kernel/configs/x86_debug.config
	#
	# merged configuration written to .config (needs make)
	...

Who knew? I'll move the options and send another patch.