Skip to contentSkip to conversation

xen: fix CONFIG_DEBUG_LOCKS

PATCH Superseded Juergen Gross 3 participants 10 messages Jan 9, 2020 – Jan 17, 2020

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

v2 cover xen: fix CONFIG_DEBUG_LOCKS

CONFIG_DEBUG_LOCKS is using ASSERT() for catching issues making it depend on CONFIG_DEBUG.

This series fixes that by using BUG_ON() instead. In order not to lose the rather nice debugging information which condition was hit add a config option to include a message similar to the one ASSERT() is printing in case of BUG_OM() triggering.

Juergen Gross (2):
xen: add config option to include failing condition in BUG_ON()
message
xen: make CONFIG_DEBUG_LOCKS usable without CONFIG_DEBUG

 xen/Kconfig.debug         | 6 ++++++
 xen/common/spinlock.c     | 2 +-
 xen/include/asm-x86/bug.h | 5 +++--
 xen/include/xen/lib.h     | 5 +++++
 4 files changed, 15 insertions(+), 3 deletions(-)
Signature · 7 lines
2.16.4


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#1 lore raw

PATCH v2 1/2 xen: add config option to include failing condition in BUG_ON() message

Today a triggering BUG_ON() will only print source file and line information. Add the possibility to print the triggering condition like ASSERT().

Do that by introducing BUG_ON_VERBOSE() and add a Kconfig option to make BUG_ON use BUG_ON_VERBOSE().

---
 xen/Kconfig.debug         | 6 ++++++
 xen/include/asm-x86/bug.h | 5 +++--
 xen/include/xen/lib.h     | 5 +++++
 3 files changed, 14 insertions(+), 2 deletions(-)
xen/Kconfig.debug +6 -0
index b3511e81a2..dfbcac575a 100644
@@ -81,6 +81,12 @@ config PERF_ARRAYS
 	---help---
 	  Enables software performance counter array histograms.
 
+config DEBUG_BUGVERBOSE
+	bool "Verbose BUG_ON messages"
+	default DEBUG
+	---help---
+	  In case a BUG_ON triggers additionally print the triggering
+	  condition on the console.
 
 config VERBOSE_DEBUG
 	bool "Verbose debug messages"
xen/include/asm-x86/bug.h +3 -2
index 9bb4a19420..46d282777f 100644
@@ -60,10 +60,11 @@ struct bug_frame {
 
 
 #define WARN() BUG_FRAME(BUGFRAME_warn, __LINE__, __FILE__, 0, NULL)
-#define BUG() do {                                              \
-    BUG_FRAME(BUGFRAME_bug,  __LINE__, __FILE__, 0, NULL);      \
+#define BUG_VERBOSE(msg) do {                                   \
+    BUG_FRAME(BUGFRAME_bug,  __LINE__, __FILE__, 0, msg);       \
     unreachable();                                              \
 } while (0)
+#define BUG() BUG_VERBOSE(NULL)
 
 #define run_in_exception_handler(fn) BUG_FRAME(BUGFRAME_run_fn, 0, fn, 0, NULL)
 
xen/include/xen/lib.h +5 -0
index 8fbe84032d..e7770b0d24 100644
@@ -8,7 +8,12 @@
 #include <xen/string.h>
 #include <asm/bug.h>
 
+#define BUG_ON_VERBOSE(p) do { if (unlikely(p)) BUG_VERBOSE(#p);  } while (0)
+#ifdef CONFIG_DEBUG_BUGVERBOSE
+#define BUG_ON(p)  BUG_ON_VERBOSE(p)
+#else
 #define BUG_ON(p)  do { if (unlikely(p)) BUG();  } while (0)
+#endif
 #define WARN_ON(p) do { if (unlikely(p)) WARN(); } while (0)
 
 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
Signature · 7 lines
2.16.4


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
#2 lore raw

Re: [Xen-devel] [PATCH v2 1/2] xen: add config option to include failing condition in BUG_ON() message

Quoted 4 lines · Juergen Gross
xen/Kconfig.debug +0 -0
@@ -81,6 +81,12 @@ config PERF_ARRAYS
 	---help---

xen/Kconfig.debug config PERF_ARRAYS · line 91

Quoted 10 lines
xen/Kconfig.debug +6 -0
 	  Enables software performance counter array histograms.
 
+config DEBUG_BUGVERBOSE
+	bool "Verbose BUG_ON messages"
+	default DEBUG
+	---help---
+	  In case a BUG_ON triggers additionally print the triggering
+	  condition on the console.
 
 config VERBOSE_DEBUG

While I can see reasons to put this here, doing so means the option will be unavailable in non-EXPERT release builds. Is it intended to be that way?

xen/include/xen/lib.h line 13

Quoted 9 lines
xen/include/xen/lib.h +3 -0
@@ -8,7 +8,12 @@
 #include <xen/string.h>
 #include <asm/bug.h>
 
+#define BUG_ON_VERBOSE(p) do { if (unlikely(p)) BUG_VERBOSE(#p);  } while (0)
+#ifdef CONFIG_DEBUG_BUGVERBOSE
+#define BUG_ON(p)  BUG_ON_VERBOSE(p)

Looks like this will fail to build on Arm? Also - any particular reason for the introduction of the separate BUG_ON_VERBOSE(), when BUG_ON() could directly use BUG_VERBOSE()? I don't think we want to encourage use of BUG_ON_VERBOSE() elsewhere ...

Jan

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#3 lore raw

Re: [Xen-devel] [PATCH v2 1/2] xen: add config option to include failing condition in BUG_ON() message

Quoted 14 lines · Jan Beulich
Quoted 13 lines · Juergen Gross
xen/Kconfig.debug +6 -0
@@ -81,6 +81,12 @@ config PERF_ARRAYS
  	---help---
  	  Enables software performance counter array histograms.
 
+config DEBUG_BUGVERBOSE
+	bool "Verbose BUG_ON messages"
+	default DEBUG
+	---help---
+	  In case a BUG_ON triggers additionally print the triggering
+	  condition on the console.
 
Quoted 5 lines

xen/Kconfig.debug config PERF_ARRAYS · line 91

Quoted 1 line
xen/Kconfig.debug +0 -0
  config VERBOSE_DEBUG

While I can see reasons to put this here, doing so means the option will be unavailable in non-EXPERT release builds. Is it intended to be that way?

I can move it either to xen/Kconfig or in Kconfig.debug out of the "if expert" section if you want.

Quoted 7 lines
Quoted 7 lines
xen/include/xen/lib.h +0 -0
@@ -8,7 +8,12 @@
  #include <xen/string.h>
  #include <asm/bug.h>
 
Quoted 5 lines

xen/include/xen/lib.h line 13

Quoted 3 lines
xen/include/xen/lib.h +3 -0
+#define BUG_ON_VERBOSE(p) do { if (unlikely(p)) BUG_VERBOSE(#p);  } while (0)
+#ifdef CONFIG_DEBUG_BUGVERBOSE
+#define BUG_ON(p)  BUG_ON_VERBOSE(p)

Looks like this will fail to build on Arm? Also - any particular

Uh, shame on me!

Quoted 3 lines

reason for the introduction of the separate BUG_ON_VERBOSE(), when BUG_ON() could directly use BUG_VERBOSE()? I don't think we want to encourage use of BUG_ON_VERBOSE() elsewhere ...

I wanted to offer that option. If you want me to remove it I wouldn't mind.

Juergen

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#4 lore raw

Re: [Xen-devel] [PATCH v2 1/2] xen: add config option to include failing condition in BUG_ON() message

Quoted 15 lines · Jürgen Groß
Quoted 14 lines · Jan Beulich
Quoted 13 lines · Juergen Gross
xen/Kconfig.debug +6 -0
@@ -81,6 +81,12 @@ config PERF_ARRAYS
  	---help---
  	  Enables software performance counter array histograms.
 
+config DEBUG_BUGVERBOSE
+	bool "Verbose BUG_ON messages"
+	default DEBUG
+	---help---
+	  In case a BUG_ON triggers additionally print the triggering
+	  condition on the console.
 
Quoted 8 lines
Quoted 5 lines

xen/Kconfig.debug config PERF_ARRAYS · line 91

Quoted 1 line
xen/Kconfig.debug +0 -0
  config VERBOSE_DEBUG

While I can see reasons to put this here, doing so means the option will be unavailable in non-EXPERT release builds. Is it intended to be that way?

I can move it either to xen/Kconfig or in Kconfig.debug out of the "if expert" section if you want.

I think this would be better, but give others a chance to voice opinions.

Quoted 12 lines
Quoted 11 lines

xen/include/xen/lib.h line 13

Quoted 9 lines
xen/include/xen/lib.h +3 -0
@@ -8,7 +8,12 @@
  #include <xen/string.h>
  #include <asm/bug.h>
 
+#define BUG_ON_VERBOSE(p) do { if (unlikely(p)) BUG_VERBOSE(#p);  } while (0)
+#ifdef CONFIG_DEBUG_BUGVERBOSE
+#define BUG_ON(p)  BUG_ON_VERBOSE(p)

Looks like this will fail to build on Arm? Also - any particular

Quoted 8 lines

Uh, shame on me!

Quoted 3 lines

reason for the introduction of the separate BUG_ON_VERBOSE(), when BUG_ON() could directly use BUG_VERBOSE()? I don't think we want to encourage use of BUG_ON_VERBOSE() elsewhere ...

I wanted to offer that option. If you want me to remove it I wouldn't mind.

As above - unless there are good reasons (making others to agree with you to have it), I'd prefer to not see it being independently usable, at least for the time being.

Jan

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#5 lore raw

Re: [Xen-devel] [PATCH v2 1/2] xen: add config option to include failing condition in BUG_ON() message

Quoted 16 lines · Jan Beulich
Quoted 15 lines · Jürgen Groß
Quoted 14 lines · Jan Beulich
Quoted 13 lines · Juergen Gross
xen/Kconfig.debug +6 -0
@@ -81,6 +81,12 @@ config PERF_ARRAYS
  	---help---
  	  Enables software performance counter array histograms.
 
+config DEBUG_BUGVERBOSE
+	bool "Verbose BUG_ON messages"
+	default DEBUG
+	---help---
+	  In case a BUG_ON triggers additionally print the triggering
+	  condition on the console.
 
Quoted 8 lines
Quoted 6 lines
Quoted 4 lines

xen/Kconfig.debug config PERF_ARRAYS · line 91

Quoted 1 line
xen/Kconfig.debug +0 -0
  config VERBOSE_DEBUG

While I can see reasons to put this here, doing so means the option will be unavailable in non-EXPERT release builds. Is it intended to be that way?

I can move it either to xen/Kconfig or in Kconfig.debug out of the "if expert" section if you want.

I think this would be better, but give others a chance to voice opinions.

TBH, I don't think anyone will be interested in not having the strings. The change is what? a couple of hundred bytes?  That is a fraction of the size of some functions we have.

Personally, I wouldn't even bother having the option.

Quoted 13 lines
Quoted 13 lines
Quoted 11 lines

xen/include/xen/lib.h line 13

Quoted 10 lines
xen/include/xen/lib.h +3 -0
@@ -8,7 +8,12 @@
  #include <xen/string.h>
  #include <asm/bug.h>
 
+#define BUG_ON_VERBOSE(p) do { if (unlikely(p)) BUG_VERBOSE(#p);  } while (0)
+#ifdef CONFIG_DEBUG_BUGVERBOSE
+#define BUG_ON(p)  BUG_ON_VERBOSE(p)

Looks like this will fail to build on Arm? Also - any particular

Uh, shame on me!

Quoted 8 lines
Quoted 5 lines
Quoted 3 lines

reason for the introduction of the separate BUG_ON_VERBOSE(), when BUG_ON() could directly use BUG_VERBOSE()? I don't think we want to encourage use of BUG_ON_VERBOSE() elsewhere ...

I wanted to offer that option. If you want me to remove it I wouldn't mind.

As above - unless there are good reasons (making others to agree with you to have it), I'd prefer to not see it being independently usable, at least for the time being.

I'd agree with the wish to not have a new flavour of BUG_ON().

People writing code aren't going to want the complexity of thinking about it, and people who care about the presence/absence of messages will care about it globally, not on a per-use bases.

~Andrew

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#6 lore raw

Re: [Xen-devel] [PATCH v2 1/2] xen: add config option to include failing condition in BUG_ON() message

Quoted 21 lines · Andrew Cooper
Quoted 20 lines · Jan Beulich
Quoted 19 lines · Jürgen Groß
Quoted 18 lines · Jan Beulich
Quoted 4 lines · Juergen Gross
xen/Kconfig.debug +0 -0
@@ -81,6 +81,12 @@ config PERF_ARRAYS
  	---help---

xen/Kconfig.debug config PERF_ARRAYS · line 91

Quoted 10 lines
xen/Kconfig.debug +6 -0
  	  Enables software performance counter array histograms.
 
+config DEBUG_BUGVERBOSE
+	bool "Verbose BUG_ON messages"
+	default DEBUG
+	---help---
+	  In case a BUG_ON triggers additionally print the triggering
+	  condition on the console.
 
  config VERBOSE_DEBUG

While I can see reasons to put this here, doing so means the option will be unavailable in non-EXPERT release builds. Is it intended to be that way?

Quoted 8 lines
Quoted 4 lines
Quoted 2 lines

I can move it either to xen/Kconfig or in Kconfig.debug out of the "if expert" section if you want.

I think this would be better, but give others a chance to voice opinions.

TBH, I don't think anyone will be interested in not having the strings. The change is what? a couple of hundred bytes?  That is a fraction of the size of some functions we have.

Well, it's a couple thousand (about 7k according to my simplistic estimation, but this is taking Arm and x86 together). It's not the end of the world, but in particular embedded users may want to get rid of this. There's a reason after all (I assume) that Linux has the option.

Jan

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#7 lore raw

Re: [Xen-devel] [PATCH v2 1/2] xen: add config option to include failing condition in BUG_ON() message

Quoted 31 lines · Jan Beulich
Quoted 21 lines · Andrew Cooper
Quoted 20 lines · Jan Beulich
Quoted 19 lines · Jürgen Groß
Quoted 18 lines · Jan Beulich
Quoted 4 lines · Juergen Gross
xen/Kconfig.debug +0 -0
@@ -81,6 +81,12 @@ config PERF_ARRAYS
   	---help---

xen/Kconfig.debug config PERF_ARRAYS · line 91

Quoted 10 lines
xen/Kconfig.debug +6 -0
   	  Enables software performance counter array histograms.
 
+config DEBUG_BUGVERBOSE
+	bool "Verbose BUG_ON messages"
+	default DEBUG
+	---help---
+	  In case a BUG_ON triggers additionally print the triggering
+	  condition on the console.
 
   config VERBOSE_DEBUG

While I can see reasons to put this here, doing so means the option will be unavailable in non-EXPERT release builds. Is it intended to be that way?

Quoted 8 lines
Quoted 4 lines
Quoted 2 lines

I can move it either to xen/Kconfig or in Kconfig.debug out of the "if expert" section if you want.

I think this would be better, but give others a chance to voice opinions.

TBH, I don't think anyone will be interested in not having the strings. The change is what? a couple of hundred bytes?  That is a fraction of the size of some functions we have.

Quoted 5 lines

Well, it's a couple thousand (about 7k according to my simplistic estimation, but this is taking Arm and x86 together). It's not the end of the world, but in particular embedded users may want to get rid of this. There's a reason after all (I assume) that Linux has the option.

The needed code churn is rather limited, so I think we should keep the config option.

Juergen

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel

#8 lore raw

PATCH v2 2/2 xen: make CONFIG_DEBUG_LOCKS usable without CONFIG_DEBUG

In reply to Juergen Gross

In expert mode it is possible to enable CONFIG_DEBUG_LOCKS without having enabled CONFIG_DEBUG. The coding is depending on CONFIG_DEBUG as it is using ASSERT(), however.

Fix that by using BUG_ON() instead of ASSERT() in rel_lock().

---
 xen/common/spinlock.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
xen/common/spinlock.c +1 -1
index 286f916bca..344981c54a 100644
@@ -86,7 +86,7 @@ static void got_lock(union lock_debug *debug)
 static void rel_lock(union lock_debug *debug)
 {
     if ( atomic_read(&spin_debug) > 0 )
-        ASSERT(debug->cpu == smp_processor_id());
+        BUG_ON(debug->cpu != smp_processor_id());
     debug->cpu = SPINLOCK_NO_CPU;
 }
 
Signature · 7 lines
2.16.4


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel
Reviewed-by on v2 2/2
#9 lore raw

Re: [Xen-devel] [PATCH v2 2/2] xen: make CONFIG_DEBUG_LOCKS usable without CONFIG_DEBUG

Quoted 7 lines · Juergen Gross

In expert mode it is possible to enable CONFIG_DEBUG_LOCKS without having enabled CONFIG_DEBUG. The coding is depending on CONFIG_DEBUG as it is using ASSERT(), however.

Fix that by using BUG_ON() instead of ASSERT() in rel_lock().

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xenproject.org/mailman/listinfo/xen-devel