general: added assert

For wrpc-sw, this depends on a similar commit in wrpc-sw, because arch-wrpc relies on that implementation (to avoid building two of them). Signed-off-by: Alessandro Rubini <rubini@gnudd.com>

general: added assert
For wrpc-sw, this depends on a similar commit in wrpc-sw, because arch-wrpc relies on that implementation (to avoid building two of them). Signed-off-by: Alessandro Rubini <rubini@gnudd.com>
8bd086ca · Alessandro Rubini · Adam Wujek · c1858025 · 8bd086ca · 8bd086ca
Commit 8bd086ca authored Feb 21, 2017 by Alessandro Rubini Committed by Adam Wujek Feb 27, 2017
14 changed files
--- a/Kconfig
+++ b/Kconfig
@@ -100,6 +100,15 @@ menu "PTP Protocol Options"

 endmenu

+config ASSERT
+	bool "Build assertion checks in the code"
+	default y
+	  help
+	    Build assertions in the code, to catch unexpected situations.
+	    When an assertion fails the code loops over repeating the
+	    error message every second. OTOH, panic() is always built,
+	    with no Kconfig -- and it does the same, unconditionally.
+
 config EXT_WR
 	bool
 	default y if ARCH_WRS || ARCH_WRPC

--- a/arch-bare-i386/Makefile
+++ b/arch-bare-i386/Makefile
@@ -21,6 +21,7 @@ OBJ-y += $A/crt0.o \
 	lib/libc-functions.o \
 	lib/dump-funcs.o \
 	lib/cmdline.o \
+	lib/assert.o \
 	lib/div64.o

 # We only support "bare" time operations

--- a/arch-bare-i386/include/arch/arch.h
+++ b/arch-bare-i386/include/arch/arch.h
 #ifndef __ARCH_H__
 #define __ARCH_H__
+#include <ppsi/assert.h>
+
+static inline int sleep(unsigned int seconds)
+{
+	static volatile int i;
+	for (i = 0; i < 1000 * 1000 * seconds; i++)
+		;
+	return 0;
+}

 /* Architecture-specific defines, included by top-level stuff */


--- a/arch-bare-x86-64/Makefile
+++ b/arch-bare-x86-64/Makefile
@@ -22,6 +22,7 @@ OBJ-y += $A/crt0.o \
 	lib/libc-functions.o \
 	lib/dump-funcs.o \
 	lib/cmdline.o \
+	lib/assert.o \
 	lib/div64.o

 # We only support "bare" time operations

--- a/arch-bare-x86-64/include/arch/arch.h
+++ b/arch-bare-x86-64/include/arch/arch.h
 #ifndef __ARCH_H__
 #define __ARCH_H__
+#include <ppsi/assert.h>
+
+static inline int sleep(unsigned int seconds)
+{
+	static volatile int i;
+	for (i = 0; i < 1000 * 1000 * seconds; i++)
+		;
+	return 0;
+}

 /* Architecture-specific defines, included by top-level stuff */


--- a/arch-sim/Makefile
+++ b/arch-sim/Makefile
@@ -12,6 +12,7 @@ OBJ-y += $A/sim-startup.o \
 	lib/conf.o \
 	lib/dump-funcs.o \
 	lib/libc-functions.o \
+	lib/assert.o \
 	lib/div64.o

 # Support only "sim" time operations

--- a/arch-sim/include/arch/arch.h
+++ b/arch-sim/include/arch/arch.h
 #ifndef __ARCH_H__
 #define __ARCH_H__
+#include <ppsi/assert.h>

 /* Architecture-specific defines, included by top-level stuff */


--- a/arch-unix/Makefile
+++ b/arch-unix/Makefile
@@ -13,6 +13,7 @@ OBJ-y += $A/unix-startup.o \
 	lib/libc-functions.o \
 	lib/dump-funcs.o \
 	lib/drop.o \
+	lib/assert.o \
 	lib/div64.o

 # The user can set TIME=, but we pick unix time by default

--- a/arch-unix/include/arch/arch.h
+++ b/arch-unix/include/arch/arch.h
@@ -5,5 +5,6 @@

 #include <arpa/inet.h> /* ntohs etc */
 #include <stdlib.h>    /* abs */
+#include <ppsi/assert.h>

 #endif /* __ARCH_H__ */
--- a/arch-wrpc/include/arch/arch.h
+++ b/arch-wrpc/include/arch/arch.h
 #ifndef __ARCH_H__
 #define __ARCH_H__
+#include <assert.h> /* wrpc-sw includes assert already */

 /* This arch exports wr functions, so include this for consistency checking */
 #include "../proto-ext-whiterabbit/wr-api.h"

--- a/arch-wrs/Makefile
+++ b/arch-wrs/Makefile
@@ -18,6 +18,7 @@ OBJ-y += $A/wrs-startup.o \
 	lib/libc-functions.o \
 	lib/dump-funcs.o \
 	lib/drop.o \
+	lib/assert.o \
 	lib/div64.o

 # We only support "wrs" time operations

--- a/arch-wrs/include/arch/arch.h
+++ b/arch-wrs/include/arch/arch.h
 #ifndef __ARCH_H__
 #define __ARCH_H__
+#include <ppsi/assert.h>

 /* This arch exports wr functions, so include this for consistency checking */
 #include "../proto-ext-whiterabbit/wr-api.h"

--- a/include/ppsi/assert.h
+++ b/include/ppsi/assert.h
+#ifndef __ASSERT_H__
+#define __ASSERT_H__
+
+/*
+ * Both panic and assert loop over the console, re-printing the
+ * message, so you can connnect to a paniced node and see the message
+ * that caused the panic.  assert_warn(condition) is once only, like
+ * warn_on(!condition) in the kernel.
+ */
+
+extern void panic(const char *fmt, ...)
+        __attribute__((format(printf,1,2)));
+
+#define assert(cond, fmt, ...) \
+	if (CONFIG_HAS_ASSERT && !(cond)) \
+		__assert(__func__, __LINE__, 1 /* forever */, fmt  __VA_ARGS__)
+
+#define assert_warn(cond, fmt, ...) \
+	if (CONFIG_HAS_ASSERT && !(cond)) \
+		__assert(__func__, __LINE__, 0 /* once */, fmt  __VA_ARGS__)
+
+
+extern void __assert(const char *func, int line, int forever,
+		     const char *fmt, ...)
+	__attribute__((format(printf, 4, 5)));
+
+#ifdef CONFIG_ASSERT
+#  define CONFIG_HAS_ASSERT 1
+#else
+#  define CONFIG_HAS_ASSERT 0
+#endif
+
+#endif /* __ASSERT_H__ */
--- a/lib/assert.c
+++ b/lib/assert.c
+#include <stdarg.h>
+#include <ppsi/ppsi.h>
+#include <ppsi/assert.h>
+#if __STDC_HOSTED__
+#include <unistd.h> /* bare archs have no sleep, but a sw loop */
+#endif
+
+
+void panic(const char *fmt, ...)
+{
+	va_list args;
+
+	while (1) {
+		pp_printf("Panic: ");
+		va_start(args, fmt);
+		pp_vprintf(fmt, args);
+		va_end(args);
+		sleep(1);
+	}
+}
+
+void __assert(const char *func, int line, int forever,
+		     const char *fmt, ...)
+{
+	va_list args;
+
+	while (1) {
+		pp_printf("Assertion failed (%s:%i)", func, line);
+		if (fmt && fmt[0]) {
+			pp_printf(": ");
+			va_start(args, fmt);
+			pp_vprintf(fmt, args);
+			va_end(args);
+		} else {
+			pp_printf(".\n");
+		}
+		if (!forever)
+			break;
+		sleep(1);
+	}
+}