mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-09 20:45:46 +00:00
7db51e4eaa
Replaces various stringify type macros with _STRINGIFY(x). Change-Id: Ic029d1e6ae344e960464310067eb1a648869919a Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
136 lines
5.0 KiB
C
136 lines
5.0 KiB
C
/* __assert.h - debug aid */
|
|
|
|
/*
|
|
* Copyright (c) 2011-2014 Wind River Systems, Inc.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1) Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
*
|
|
* 2) Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* 3) Neither the name of Wind River Systems nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software without
|
|
* specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
/*
|
|
DESCRIPTION
|
|
|
|
The __ASSERT() macro can be used inside kernel code.
|
|
|
|
Assertions are enabled by setting the __ASSERT_ON symbol to a non-zero value.
|
|
There are two ways to do this:
|
|
a) Use the ASSERT and ASSERT_LEVEL kconfig options.
|
|
b) Add "CFLAGS += -D__ASSERT_ON=<level>" at the end of a project's Makefile.
|
|
The Makefile method takes precedence over the kconfig option if both are used.
|
|
|
|
Specifying an assertion level of 1 causes the compiler to issue warnings that
|
|
the kernel contains debug-type __ASSERT() statements; this reminder is issued
|
|
since assertion code is not normally present in a final product. Specifying
|
|
assertion level 2 suppresses these warnings.
|
|
|
|
The __ASSERT_EVAL() macro can also be used inside kernel code.
|
|
|
|
It makes use of the __ASSERT() macro, but has some extra flexibility. It
|
|
allows the developer to specify different actions depending whether the
|
|
__ASSERT() macro is enabled or not. This can be particularly useful to
|
|
prevent the compiler from generating comments (errors, warnings or remarks)
|
|
about variables that are only used with __ASSERT() being assigned a value, but
|
|
otherwise unused when the __ASSERT() macro is disabled.
|
|
|
|
Consider the following example:
|
|
|
|
int x;
|
|
|
|
x = foo ();
|
|
__ASSERT (x != 0, "foo() returned zero!");
|
|
|
|
If __ASSERT() is disabled, then <x> is assigned a value, but never used.
|
|
This type of situation can be resolved using the __ASSERT_EVAL() macro.
|
|
|
|
__ASSERT_EVAL ((void) foo(),
|
|
int x = foo(),
|
|
x != 0,
|
|
"foo() returned zero!");
|
|
|
|
The first parameter tells __ASSERT_EVAL() what to do if __ASSERT() is disabled.
|
|
The second parameter tells __ASSERT_EVAL() what to do if __ASSERT() is enabled.
|
|
The third and fourth parameters are the parameters it passes to __ASSERT().
|
|
|
|
The __ASSERT_NO_MSG() macro can be used to perform an assertion that reports
|
|
the failed test and its location, but lacks additional debugging information
|
|
provided to assist the user in diagnosing the problem; its use is discouraged.
|
|
*/
|
|
|
|
#ifndef ___ASSERT__H_
|
|
#define ___ASSERT__H_
|
|
|
|
#ifdef CONFIG_ASSERT
|
|
#ifndef __ASSERT_ON
|
|
#define __ASSERT_ON CONFIG_ASSERT_LEVEL
|
|
#endif
|
|
#endif
|
|
|
|
#ifdef __ASSERT_ON
|
|
#if (__ASSERT_ON < 0) || (__ASSERT_ON > 2)
|
|
#error "Invalid __ASSERT() level: must be between 0 and 2"
|
|
#endif
|
|
|
|
#if __ASSERT_ON
|
|
#include <misc/printk.h>
|
|
#define __ASSERT(test, fmt...) \
|
|
do { \
|
|
if (!(test)) { \
|
|
printk("ASSERTION FAIL [%s] @ %s:%d:\n\t", \
|
|
_STRINGIFY(test), \
|
|
__FILE__, \
|
|
__LINE__); \
|
|
printk(fmt); \
|
|
for (;;) \
|
|
; /* spin thread */ \
|
|
} \
|
|
} while ((0))
|
|
|
|
#define __ASSERT_EVAL(expr1, expr2, test, fmt...) \
|
|
do { \
|
|
expr2; \
|
|
__ASSERT(test, fmt); \
|
|
} while (0)
|
|
|
|
#if (__ASSERT_ON == 1)
|
|
#warning "__ASSERT() statements are ENABLED"
|
|
#endif
|
|
#else
|
|
#define __ASSERT(test, fmt...) \
|
|
do {/* nothing */ \
|
|
} while ((0))
|
|
#define __ASSERT_EVAL(expr1, expr2, test, fmt...) expr1
|
|
#endif
|
|
#else
|
|
#define __ASSERT(test, fmt...) \
|
|
do {/* nothing */ \
|
|
} while ((0))
|
|
#define __ASSERT_EVAL(expr1, expr2, test, fmt...) expr1
|
|
#endif
|
|
|
|
#define __ASSERT_NO_MSG(test) __ASSERT(test, "")
|
|
|
|
#endif /* ___ASSERT__H_ */
|