__assert.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2014 Wind River Systems, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SYS___ASSERT_H_
#define ZEPHYR_INCLUDE_SYS___ASSERT_H_
 
#include <stdbool.h>
#include <zephyr/toolchain.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Wrapper around printk to avoid including printk.h in assert.h */
void __printf_like(1, 2) assert_print(const char *fmt, ...);
 
#ifdef __cplusplus
}
#endif
 
#if defined(CONFIG_ASSERT_VERBOSE)
#define __ASSERT_PRINT(fmt, ...) assert_print(fmt, ##__VA_ARGS__)
#else /* CONFIG_ASSERT_VERBOSE */
#define __ASSERT_PRINT(fmt, ...)
#endif /* CONFIG_ASSERT_VERBOSE */
 
#ifdef CONFIG_ASSERT_NO_MSG_INFO
#define __ASSERT_MSG_INFO(fmt, ...)
#else  /* CONFIG_ASSERT_NO_MSG_INFO */
#define __ASSERT_MSG_INFO(fmt, ...) __ASSERT_PRINT("\t" fmt "\n", ##__VA_ARGS__)
#endif /* CONFIG_ASSERT_NO_MSG_INFO */
 
#if !defined(CONFIG_ASSERT_NO_COND_INFO) && !defined(CONFIG_ASSERT_NO_FILE_INFO)
#define __ASSERT_LOC(test)                              \
        __ASSERT_PRINT("ASSERTION FAIL [%s] @ %s:%d\n", \
                Z_STRINGIFY(test),                      \
                __FILE__, __LINE__)
#endif
 
#if defined(CONFIG_ASSERT_NO_COND_INFO) && !defined(CONFIG_ASSERT_NO_FILE_INFO)
#define __ASSERT_LOC(test)                         \
        __ASSERT_PRINT("ASSERTION FAIL @ %s:%d\n", \
                __FILE__, __LINE__)
#endif
 
#if !defined(CONFIG_ASSERT_NO_COND_INFO) && defined(CONFIG_ASSERT_NO_FILE_INFO)
#define __ASSERT_LOC(test)                      \
        __ASSERT_PRINT("ASSERTION FAIL [%s]\n", \
                Z_STRINGIFY(test))
#endif
 
#if defined(CONFIG_ASSERT_NO_COND_INFO) && defined(CONFIG_ASSERT_NO_FILE_INFO)
#define __ASSERT_LOC(test)                 \
        __ASSERT_PRINT("ASSERTION FAIL\n")
#endif
 
#if defined(CONFIG_ASSERT) && !defined(CONFIG_FORCE_NO_ASSERT) && \
        defined(CONFIG_ASSERT_LEVEL) && (CONFIG_ASSERT_LEVEL > 0)
 
BUILD_ASSERT(CONFIG_ASSERT_LEVEL >= 0 && CONFIG_ASSERT_LEVEL <= 2,
             "Invalid CONFIG_ASSERT_LEVEL: must be between 0 and 2");
 
#if CONFIG_ASSERT_LEVEL == 1
#warning "__ASSERT() statements are ENABLED"
#endif /* CONFIG_ASSERT_LEVEL == 1 */
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef CONFIG_ASSERT_NO_FILE_INFO
void assert_post_action(void);
#define __ASSERT_POST_ACTION() assert_post_action()
#else  /* CONFIG_ASSERT_NO_FILE_INFO */
void assert_post_action(const char *file, unsigned int line);
#define __ASSERT_POST_ACTION() assert_post_action(__FILE__, __LINE__)
#endif /* CONFIG_ASSERT_NO_FILE_INFO */
 
/*
 * When the assert test mode is enabled, the default kernel fatal error handler
 * and the custom assert hook function may return in order to allow the test to
 * proceed.
 * NOTE: this macro is INTERNAL and should not be used outside of this header!
 */
#ifdef CONFIG_ASSERT_TEST
#define __ASSERT_AFTER_TRIGGER_UNREACHABILITY_MARKER
#else
#define __ASSERT_AFTER_TRIGGER_UNREACHABILITY_MARKER CODE_UNREACHABLE
#endif
 
#ifdef __cplusplus
}
#endif
 
#define __ASSERT_NO_MSG(test)                                             \
        do {                                                              \
                if (unlikely(!(test))) {                                  \
                        __ASSERT_LOC(test);                               \
                        __ASSERT_POST_ACTION();                           \
                        __ASSERT_AFTER_TRIGGER_UNREACHABILITY_MARKER;     \
                }                                                         \
        } while (false)
 
#define __ASSERT(test, fmt, ...)                                          \
        do {                                                              \
                if (unlikely(!(test))) {                                  \
                        __ASSERT_LOC(test);                               \
                        __ASSERT_MSG_INFO(fmt, ##__VA_ARGS__);            \
                        __ASSERT_POST_ACTION();                           \
                        __ASSERT_AFTER_TRIGGER_UNREACHABILITY_MARKER;     \
                }                                                         \
        } while (false)
 
#define __ASSERT_EVAL(expr1, expr2, test, fmt, ...)                \
        do {                                                       \
                expr2;                                             \
                __ASSERT(test, fmt, ##__VA_ARGS__);                \
        } while (false)
 
 
#else
 
#define __ASSERT(test, fmt, ...) { }
#define __ASSERT_EVAL(expr1, expr2, test, fmt, ...) expr1
#define __ASSERT_NO_MSG(test) { }
#define __ASSERT_POST_ACTION() { }
 
#endif
 
#ifdef CONFIG_ASSERT_CUSTOM_HEADER
/* This include must always be at the end of __assert.h */
#include <zephyr_custom_assert.h>
#endif
 
#endif /* ZEPHYR_INCLUDE_SYS___ASSERT_H_ */