Skip to contentSkip to conversation

mm/slub: fix help comment of SLUB_DEBUG[_ON]

PATCH Superseded Vernon Yang 3 participants 4 messages Feb 22, 2023 – Mar 14, 2023

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 mm/slub: fix help comment of SLUB_DEBUG[_ON]

Since commit 081248de0a02 ("kset: move /sys/slab to /sys/kernel/slab"), the SYSFS path of slab was modified, so fix up the help comment of SLUB_DEBUG to use the correct one.

And now the "slub_debug" parameter on boot that is support for more fine grained debug control, so fix up help comment of SLUB_DEBUG_ON for "no support" to "support".

---
 mm/Kconfig.debug | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
mm/Kconfig.debug +6 -6
index fca699ad1fb0..732043bf56c6 100644
@@ -61,8 +61,8 @@ config SLUB_DEBUG
 	help
 	  SLUB has extensive debug support features. Disabling these can
 	  result in significant savings in code size. This also disables
-	  SLUB sysfs support. /sys/slab will not exist and there will be
-	  no support for cache validation etc.
+	  SLUB sysfs support. /sys/kernel/slab will not exist and there
+	  will be no support for cache validation etc.
 
 config SLUB_DEBUG_ON
 	bool "SLUB debugging on by default"
@@ -73,10 +73,10 @@ config SLUB_DEBUG_ON
 	  Boot with debugging on by default. SLUB boots by default with
 	  the runtime debug capabilities switched off. Enabling this is
 	  equivalent to specifying the "slub_debug" parameter on boot.
-	  There is no support for more fine grained debug control like
-	  possible with slub_debug=xxx. SLUB debugging may be switched
-	  off in a kernel built with CONFIG_SLUB_DEBUG_ON by specifying
-	  "slub_debug=-".
+	  There is support for more fine grained debug control like
+	  possible with slub_debug=xxx, details in Documentation/mm/slub.rst.
+	  SLUB debugging may be switched off in a kernel built with
+	  CONFIG_SLUB_DEBUG_ON by specifying "slub_debug=-".
 
 config PAGE_OWNER
 	bool "Track page owner"
Signature · 1 line
2.34.1
#1 lore raw
Quoted 18 lines · Vernon Yang

Since commit 081248de0a02 ("kset: move /sys/slab to /sys/kernel/slab"), the SYSFS path of slab was modified, so fix up the help comment of SLUB_DEBUG to use the correct one.

And now the "slub_debug" parameter on boot that is support for more fine grained debug control, so fix up help comment of SLUB_DEBUG_ON for "no support" to "support".

---
 mm/Kconfig.debug | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
mm/Kconfig.debug +0 -0
index fca699ad1fb0..732043bf56c6 100644

mm/Kconfig.debug config SLUB_DEBUG · line 65

Quoted 7 lines
mm/Kconfig.debug +2 -2
@@ -61,8 +61,8 @@ config SLUB_DEBUG
 	help
 	  SLUB has extensive debug support features. Disabling these can
 	  result in significant savings in code size. This also disables
-	  SLUB sysfs support. /sys/slab will not exist and there will be
-	  no support for cache validation etc.
+	  SLUB sysfs support. /sys/kernel/slab will not exist and there
+	  will be no support for cache validation etc.

After commit ab4d5ed5eeda ("slub: Enable sysfs support for !CONFIG_SLUB_DEBUG"), "Disabling SLUB_DEBUG also disables SLUB sysfs support" is not true anymore.

Quoted 4 lines
mm/Kconfig.debug +0 -0
 config SLUB_DEBUG_ON
 	bool "SLUB debugging on by default"
@@ -73,10 +73,10 @@ config SLUB_DEBUG_ON
 	  Boot with debugging on by default. SLUB boots by default with

mm/Kconfig.debug config SLUB_DEBUG_ON · line 79

Quoted 10 lines
mm/Kconfig.debug +4 -4
 	  the runtime debug capabilities switched off. Enabling this is
 	  equivalent to specifying the "slub_debug" parameter on boot.
-	  There is no support for more fine grained debug control like
-	  possible with slub_debug=xxx. SLUB debugging may be switched
-	  off in a kernel built with CONFIG_SLUB_DEBUG_ON by specifying
-	  "slub_debug=-".
+	  There is support for more fine grained debug control like
+	  possible with slub_debug=xxx, details in Documentation/mm/slub.rst.
+	  SLUB debugging may be switched off in a kernel built with
+	  CONFIG_SLUB_DEBUG_ON by specifying "slub_debug=-".

I think this is a misunderstanding. SLUB_DEBUG_ON is equivalent to passing boot parameter slub_debug=FUPZ, and what the help text says is that

"You can enable slub debugging by default using this config option but
there is no support for fine-grained control like what slub_debug boot parameter provides."

IOW SLUB_DEBUG_ON cannot be used to have same effect as passing something like slub_debug=F.

Quoted 7 lines
mm/Kconfig.debug +0 -0
 config PAGE_OWNER
 	bool "Track page owner"
Signature · 1 line
2.34.1
#2 lore raw
Quoted 14 lines · Hyeonggon Yoo
Quoted 13 lines · Vernon Yang

Since commit 081248de0a02 ("kset: move /sys/slab to /sys/kernel/slab"), the SYSFS path of slab was modified, so fix up the help comment of SLUB_DEBUG to use the correct one.

And now the "slub_debug" parameter on boot that is support for more fine grained debug control, so fix up help comment of SLUB_DEBUG_ON for "no support" to "support".

---
 mm/Kconfig.debug | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
Quoted 15 lines

mm/Kconfig.debug config SLUB_DEBUG · line 65

Quoted 12 lines
mm/Kconfig.debug +2 -2
index fca699ad1fb0..732043bf56c6 100644
@@ -61,8 +61,8 @@ config SLUB_DEBUG
 	help
 	  SLUB has extensive debug support features. Disabling these can
 	  result in significant savings in code size. This also disables
-	  SLUB sysfs support. /sys/slab will not exist and there will be
-	  no support for cache validation etc.
+	  SLUB sysfs support. /sys/kernel/slab will not exist and there
+	  will be no support for cache validation etc.

After commit ab4d5ed5eeda ("slub: Enable sysfs support for !CONFIG_SLUB_DEBUG"), "Disabling SLUB_DEBUG also disables SLUB sysfs support" is not true anymore.

Yeah we could say that /sys/kernel/slab will exist but will not provide e.g. cache validation.

Quoted 18 lines
Quoted 4 lines
mm/Kconfig.debug +0 -0
 config SLUB_DEBUG_ON
 	bool "SLUB debugging on by default"
@@ -73,10 +73,10 @@ config SLUB_DEBUG_ON
 	  Boot with debugging on by default. SLUB boots by default with

mm/Kconfig.debug config SLUB_DEBUG_ON · line 79

Quoted 10 lines
mm/Kconfig.debug +4 -4
 	  the runtime debug capabilities switched off. Enabling this is
 	  equivalent to specifying the "slub_debug" parameter on boot.
-	  There is no support for more fine grained debug control like
-	  possible with slub_debug=xxx. SLUB debugging may be switched
-	  off in a kernel built with CONFIG_SLUB_DEBUG_ON by specifying
-	  "slub_debug=-".
+	  There is support for more fine grained debug control like
+	  possible with slub_debug=xxx, details in Documentation/mm/slub.rst.
+	  SLUB debugging may be switched off in a kernel built with
+	  CONFIG_SLUB_DEBUG_ON by specifying "slub_debug=-".

I think this is a misunderstanding. SLUB_DEBUG_ON is equivalent to passing boot parameter slub_debug=FUPZ, and what the help text says is that

Quoted 6 lines

"You can enable slub debugging by default using this config option but
there is no support for fine-grained control like what slub_debug boot parameter provides."

IOW SLUB_DEBUG_ON cannot be used to have same effect as passing something like slub_debug=F.

Agree with both comments. Vernon, will you send an updated patch?

Quoted 7 lines
Quoted 7 lines
mm/Kconfig.debug +0 -0
 config PAGE_OWNER
 	bool "Track page owner"
Signature · 1 line
2.34.1
#3 lore raw
Quoted 15 lines · Vlastimil Babka
Quoted 14 lines · Hyeonggon Yoo
Quoted 13 lines · Vernon Yang

Since commit 081248de0a02 ("kset: move /sys/slab to /sys/kernel/slab"), the SYSFS path of slab was modified, so fix up the help comment of SLUB_DEBUG to use the correct one.

And now the "slub_debug" parameter on boot that is support for more fine grained debug control, so fix up help comment of SLUB_DEBUG_ON for "no support" to "support".

---
 mm/Kconfig.debug | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
Quoted 15 lines
Quoted 7 lines
Quoted 7 lines
mm/Kconfig.debug +0 -0
index fca699ad1fb0..732043bf56c6 100644
@@ -61,8 +61,8 @@ config SLUB_DEBUG
 	help
 	  SLUB has extensive debug support features. Disabling these can
Quoted 8 lines

mm/Kconfig.debug config SLUB_DEBUG · line 65

Quoted 5 lines
mm/Kconfig.debug +2 -2
 	  result in significant savings in code size. This also disables
-	  SLUB sysfs support. /sys/slab will not exist and there will be
-	  no support for cache validation etc.
+	  SLUB sysfs support. /sys/kernel/slab will not exist and there
+	  will be no support for cache validation etc.

After commit ab4d5ed5eeda ("slub: Enable sysfs support for !CONFIG_SLUB_DEBUG"), "Disabling SLUB_DEBUG also disables SLUB sysfs support" is not true anymore.

Yes, You are right. Thanks.

Quoted 3 lines

Yeah we could say that /sys/kernel/slab will exist but will not provide e.g. cache validation.

OK.

Quoted 17 lines
Quoted 17 lines
Quoted 5 lines
mm/Kconfig.debug +0 -0
 config SLUB_DEBUG_ON
 	bool "SLUB debugging on by default"
@@ -73,10 +73,10 @@ config SLUB_DEBUG_ON
 	  Boot with debugging on by default. SLUB boots by default with

mm/Kconfig.debug config SLUB_DEBUG_ON · line 79

Quoted 10 lines
mm/Kconfig.debug +4 -4
 	  the runtime debug capabilities switched off. Enabling this is
 	  equivalent to specifying the "slub_debug" parameter on boot.
-	  There is no support for more fine grained debug control like
-	  possible with slub_debug=xxx. SLUB debugging may be switched
-	  off in a kernel built with CONFIG_SLUB_DEBUG_ON by specifying
-	  "slub_debug=-".
+	  There is support for more fine grained debug control like
+	  possible with slub_debug=xxx, details in Documentation/mm/slub.rst.
+	  SLUB debugging may be switched off in a kernel built with
+	  CONFIG_SLUB_DEBUG_ON by specifying "slub_debug=-".

I think this is a misunderstanding. SLUB_DEBUG_ON is equivalent to

Yeah, This is a misunderstanding. I remove this.

Quoted 10 lines
Quoted 8 lines

passing boot parameter slub_debug=FUPZ, and what the help text says is that

"You can enable slub debugging by default using this config option but
there is no support for fine-grained control like what slub_debug boot parameter provides."

IOW SLUB_DEBUG_ON cannot be used to have same effect as passing something like slub_debug=F.

Agree with both comments. Vernon, will you send an updated patch?

Ok, I'll be sending a new patch shortly.

Quoted 9 lines
Quoted 8 lines
Quoted 8 lines
mm/Kconfig.debug +0 -1
 config PAGE_OWNER
 	bool "Track page owner"
--

2.34.1