Skip to contentSkip to conversation

config RCU_EQS_DEBUG

DISCUSSION Jean Delvare 2 participants 4 messages Jul 3, 2015 – Jul 5, 2015 Library code

lore
Share & tools
lore
#0 lore raw

Hi Paul,

You just introduced a Linux kernel configuration option named RCU_EQS_DEBUG. Its short description is "Use this when adding any sort of NO_HZ support to your arch".

I'm afraid this is a bad way to briefly explain what the option actually does (which is what the short description is for.) A sentence like "use this when adding any sort of NO_HZ support to your arch" should go in the help text, not the short description. The short description should be something like along the lines of "Enable consistency checks for RCU", for example.

Additionally I see some inconsistency in the fact that this option defaults to n but the help text says "Say Y if you are unsure". BTW, option RCU_CPU_STALL_INFO is equally inconsistent with a default y and "say N if you are unsure" in the help text.

Signature · 2 lines
Jean Delvare
SUSE L3 Support
#1 lore raw
Quoted 13 lines · Jean Delvare

Hi Paul,

You just introduced a Linux kernel configuration option named RCU_EQS_DEBUG. Its short description is "Use this when adding any sort of NO_HZ support to your arch".

I'm afraid this is a bad way to briefly explain what the option actually does (which is what the short description is for.) A sentence like "use this when adding any sort of NO_HZ support to your arch" should go in the help text, not the short description. The short description should be something like along the lines of "Enable consistency checks for RCU", for example.

Quoted 4 lines

Additionally I see some inconsistency in the fact that this option defaults to n but the help text says "Say Y if you are unsure". BTW, option RCU_CPU_STALL_INFO is equally inconsistent with a default y and "say N if you are unsure" in the help text.

Hello, Jean,

I have the following queued, which should address your first point.

Would adding "default y" address your other point?

On RCU_CPU_STALL_INFO, I have a patch queued for v4.3 that eliminates this Kconfig option completely.

Thanx, Paul

------------------------------------------------------------------------

rcu: Clarify CONFIG_RCU_EQS_DEBUG help text

lib/Kconfig.debug +1 -1
index 6be521990d61..80efaade5e59 100644
@@ -1360,7 +1360,7 @@ config RCU_TRACE
 	  Say N if you are unsure.
 
 config RCU_EQS_DEBUG
-	bool "Use this when adding any sort of NO_HZ support to your arch"
+	bool "Provide debugging asserts for adding NO_HZ support to an arch"
 	depends on DEBUG_KERNEL
 	help
 	  This option provides consistency checks in RCU's handling of
#2 lore raw

Hi Paul,

Quoted 12 lines · Paul E. McKenney
Quoted 11 lines · Jean Delvare

You just introduced a Linux kernel configuration option named RCU_EQS_DEBUG. Its short description is "Use this when adding any sort of NO_HZ support to your arch".

I'm afraid this is a bad way to briefly explain what the option actually does (which is what the short description is for.) A sentence like "use this when adding any sort of NO_HZ support to your arch" should go in the help text, not the short description. The short description should be something like along the lines of "Enable consistency checks for RCU", for example.

Quoted 6 lines
Quoted 4 lines

Additionally I see some inconsistency in the fact that this option defaults to n but the help text says "Say Y if you are unsure". BTW, option RCU_CPU_STALL_INFO is equally inconsistent with a default y and "say N if you are unsure" in the help text.

I have the following queued, which should address your first point.

Yes it does, thank you. If I were to nitpick I'd say that the option is adding (or including) the asserts rather than providing them.

Quoted 1 line

Would adding "default y" address your other point?

It would make things consistent, but I have a serious doubt that this is the right direction. An option which is described as being useful "when adding any sort of NO_HZ support to a new architecture" really does not seem to be one that should be enabled by default. You may argue that it still depends on DEBUG_KERNEL but well, that option is enabled in pretty much every distribution kernel these days. So I believe that default n (no default actually) was correct, and what needs to be removed is the statement "Say Y if you are unsure". If the user is unsure, then certainly he/she is not working on NO_HZ support for a new architecture and thus doesn't need to enable RCU_EQS_DEBUG.

Quoted 2 lines

On RCU_CPU_STALL_INFO, I have a patch queued for v4.3 that eliminates this Kconfig option completely.

That solves the problem nicely :-)

Quoted 19 lines

rcu: Clarify CONFIG_RCU_EQS_DEBUG help text

lib/Kconfig.debug +1 -1
index 6be521990d61..80efaade5e59 100644
@@ -1360,7 +1360,7 @@ config RCU_TRACE
 	  Say N if you are unsure.
 
 config RCU_EQS_DEBUG
-	bool "Use this when adding any sort of NO_HZ support to your arch"
+	bool "Provide debugging asserts for adding NO_HZ support to an arch"
 	depends on DEBUG_KERNEL
 	help
 	  This option provides consistency checks in RCU's handling of
Signature · 2 lines
Jean Delvare
SUSE L3 Support
#3 lore raw
Quoted 27 lines · Jean Delvare

Hi Paul,

Quoted 12 lines · Paul E. McKenney
Quoted 11 lines · Jean Delvare

You just introduced a Linux kernel configuration option named RCU_EQS_DEBUG. Its short description is "Use this when adding any sort of NO_HZ support to your arch".

I'm afraid this is a bad way to briefly explain what the option actually does (which is what the short description is for.) A sentence like "use this when adding any sort of NO_HZ support to your arch" should go in the help text, not the short description. The short description should be something like along the lines of "Enable consistency checks for RCU", for example.

Quoted 6 lines
Quoted 4 lines

Additionally I see some inconsistency in the fact that this option defaults to n but the help text says "Say Y if you are unsure". BTW, option RCU_CPU_STALL_INFO is equally inconsistent with a default y and "say N if you are unsure" in the help text.

I have the following queued, which should address your first point.

Yes it does, thank you. If I were to nitpick I'd say that the option is adding (or including) the asserts rather than providing them.

Quoted 1 line

Would adding "default y" address your other point?

Quoted 10 lines

It would make things consistent, but I have a serious doubt that this is the right direction. An option which is described as being useful "when adding any sort of NO_HZ support to a new architecture" really does not seem to be one that should be enabled by default. You may argue that it still depends on DEBUG_KERNEL but well, that option is enabled in pretty much every distribution kernel these days. So I believe that default n (no default actually) was correct, and what needs to be removed is the statement "Say Y if you are unsure". If the user is unsure, then certainly he/she is not working on NO_HZ support for a new architecture and thus doesn't need to enable RCU_EQS_DEBUG.

What would be ideal is if everyone enabled it except for those building systems requiring the fastest possible user-to-kernel switch times. Because it is not that hard to break this even if you don't believe that your are working on NO_HZ support.

Quoted 4 lines
Quoted 2 lines

On RCU_CPU_STALL_INFO, I have a patch queued for v4.3 that eliminates this Kconfig option completely.

That solves the problem nicely :-)

Glad it works for you! ;-)

Thanx, Paul

Quoted 24 lines
Quoted 19 lines

rcu: Clarify CONFIG_RCU_EQS_DEBUG help text

lib/Kconfig.debug +1 -1
index 6be521990d61..80efaade5e59 100644
@@ -1360,7 +1360,7 @@ config RCU_TRACE
 	  Say N if you are unsure.
 
 config RCU_EQS_DEBUG
-	bool "Use this when adding any sort of NO_HZ support to your arch"
+	bool "Provide debugging asserts for adding NO_HZ support to an arch"
 	depends on DEBUG_KERNEL
 	help
 	  This option provides consistency checks in RCU's handling of
Signature · 2 lines
Jean Delvare
SUSE L3 Support