public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
* [U-Boot] [PATCH v3] Add assert() for debug assertions
@ 2011-06-29 19:49 Simon Glass
  2011-06-29 20:43 ` Mike Frysinger
                   ` (4 more replies)
  0 siblings, 5 replies; 16+ messages in thread
From: Simon Glass @ 2011-06-29 19:49 UTC (permalink / raw)
  To: u-boot

assert() is like BUG_ON() but compiles to nothing unless DEBUG is defined.
This is useful when a condition is an error but a board reset is unlikely
to fix it, so it is better to soldier on in hope. Assertion failures should
be caught during development/test.

It turns out that assert() is defined separately in a few places in U-Boot
with various meanings. This patch cleans up some of these.

Build errors exposed by this change (and defining DEBUG) are also fixed in
this patch.

Signed-off-by: Simon Glass <sjg@chromium.org>
---
Changes in v2:
- Changed macros so that all code is compiled even if DEBUG is disabled

Changes in v3:
- Use panic() instead of printf()
- Use separate __assert_fail() function to reduce memory footprint
- Changed output format to match assert(3)

 common/dlmalloc.c |    7 -------
 include/common.h  |   21 +++++++++++++++++++++
 include/malloc.h  |    8 --------
 lib/qsort.c       |    5 -----
 lib/vsprintf.c    |    8 ++++++++
 5 files changed, 29 insertions(+), 20 deletions(-)

diff --git a/common/dlmalloc.c b/common/dlmalloc.c
index e9bab09..f2080c6 100644
--- a/common/dlmalloc.c
+++ b/common/dlmalloc.c
@@ -286,13 +286,6 @@ extern "C" {
 
 */
 
-#ifdef DEBUG
-#include <assert.h>
-#else
-#define assert(x) ((void)0)
-#endif
-
-
 /*
   INTERNAL_SIZE_T is the word-size used for internal bookkeeping
   of chunk sizes. On a 64-bit machine, you can reduce malloc
diff --git a/include/common.h b/include/common.h
index 1e21b7a..0956b93 100644
--- a/include/common.h
+++ b/include/common.h
@@ -124,6 +124,27 @@ typedef volatile unsigned char	vu_char;
 #define debugX(level,fmt,args...)
 #endif	/* DEBUG */
 
+#ifdef DEBUG
+# define _DEBUG 1
+#else
+# define _DEBUG 0
+#endif
+
+/*
+ * An assertion is run-time check done in debug mode only. If DEBUG is not
+ * defined then it is skipped. If DEBUG is defined and the assertion fails,
+ * then it calls panic*( which may or may not reset/halt U-Boot (see
+ * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
+ * before release, and after release it is hoped that they don't matter. But
+ * in any case these failing assertions cannot be fixed with a reset (which
+ * may just do the same assertion again).
+ */
+void __assert_fail(const char *assertion, const char *file, unsigned line,
+		   const char *function);
+#define assert(x) \
+	({ if (!(x) && _DEBUG) \
+		__assert_fail(#x, __FILE__, __LINE__, __func__); })
+
 #define error(fmt, args...) do {					\
 		printf("ERROR: " fmt "\nat %s:%d/%s()\n",		\
 			##args, __FILE__, __LINE__, __func__);		\
diff --git a/include/malloc.h b/include/malloc.h
index 3e145ad..ecf3c67 100644
--- a/include/malloc.h
+++ b/include/malloc.h
@@ -285,14 +285,6 @@ extern "C" {
 
 */
 
-#ifdef DEBUG
-/* #include <assert.h> */
-#define assert(x) ((void)0)
-#else
-#define assert(x) ((void)0)
-#endif
-
-
 /*
   INTERNAL_SIZE_T is the word-size used for internal bookkeeping
   of chunk sizes. On a 64-bit machine, you can reduce malloc
diff --git a/lib/qsort.c b/lib/qsort.c
index 1cc0d31..86c392c 100644
--- a/lib/qsort.c
+++ b/lib/qsort.c
@@ -17,11 +17,6 @@
 
 #include <linux/types.h>
 #include <exports.h>
-#if 0
-#include <assert.h>
-#else
-#define assert(arg)
-#endif
 
 void qsort(void  *base,
 	   size_t nel,
diff --git a/lib/vsprintf.c b/lib/vsprintf.c
index 3b924ec..1f01b70 100644
--- a/lib/vsprintf.c
+++ b/lib/vsprintf.c
@@ -728,3 +728,11 @@ void panic(const char *fmt, ...)
 	do_reset (NULL, 0, 0, NULL);
 #endif
 }
+
+void __assert_fail(const char *assertion, const char *file, unsigned line,
+		   const char *function)
+{
+	/* This will not return */
+	panic("%s:%u: %s: Assertion `%s' failed.", file, line, function,
+	      assertion);
+}
-- 
1.7.3.1

^ permalink raw reply related	[flat|nested] 16+ messages in thread
end of thread, other threads:[~2011-09-12  4:39 UTC | newest]

Thread overview: 16+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2011-06-29 19:49 [U-Boot] [PATCH v3] Add assert() for debug assertions Simon Glass
2011-06-29 20:43 ` Mike Frysinger
2011-06-29 21:01   ` Wolfgang Denk
2011-06-29 21:54     ` Mike Frysinger
2011-09-07 22:29       ` Simon Glass
2011-09-09  0:34         ` Mike Frysinger
2011-09-09 13:55           ` Simon Glass
2011-09-09 22:04 ` Wolfgang Denk
2011-09-09 22:38 ` [U-Boot] [PATCH] Fix warning: "assert" redefined Wolfgang Denk
2011-09-09 22:46   ` Simon Glass
2011-09-10 20:37   ` Wolfgang Denk
2011-09-10 14:07 ` [U-Boot] [PATCH] utx8245: fix build breakage due to assert() Wolfgang Denk
2011-09-10 20:42   ` Wolfgang Denk
2011-09-10 14:19 ` [U-Boot] [PATCH] tegra2: fix warning: "assert" redefined Wolfgang Denk
2011-09-10 20:44   ` Wolfgang Denk
2011-09-12  4:39     ` Simon Glass

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox