assert.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013 The University of Manchester
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __ASSERT_H__
#define __ASSERT_H__
 
#include "spin-print.h"
 
#define abort(n)    do { exit(n); } while (0)
 
#define LOG_ERROR 10
 
#define LOG_WARNING 20
 
#define LOG_INFO 30
 
#define LOG_DEBUG 40
 
// Define the log level if not already defined
#ifndef LOG_LEVEL
#if defined(PRODUCTION_CODE) || defined(NDEBUG)
#define LOG_LEVEL LOG_INFO
#else // PRODUCTION_CODE
#define LOG_LEVEL LOG_DEBUG
#endif // PRODUCTION_CODE
#endif // LOG_LEVEL
 
#if !(defined(PRODUCTION_CODE) || defined(NDEBUG))
 
#define check(condition, message, ...) \
    do {                                \
        if (!(condition)) {                     \
            io_printf(IO_BUF, "[CHECK]    ", message, ##__VA_ARGS__);   \
        }                               \
    } while (0)
 
#define sentinel(message, ...) \
    do {                                \
        io_printf(IO_BUF, "[SENTINEL] ", message, ##__VA_ARGS__);   \
        abort(0);                           \
    } while (0)
 
#define assert(assertion) \
    do {                                \
        if (!(assertion)) {                     \
            io_printf(IO_BUF, "[ASSERT]   ", "assertion check fails!"); \
            abort(0);                           \
        }                               \
    } while (0)
 
#define assert_info(assertion, message, ...) \
    do {                                                                \
        if (!(assertion)) {                                             \
            io_printf(IO_BUF, "[ASSERT]   ", message, ##__VA_ARGS__);    \
            abort(0);                                                   \
        }                                                               \
    } while (0)
 
#else  /* PRODUCTION_CODE */
#define check(a, s, ...)    skip()
#define sentinel(s, ...)    skip()
#define assert(a)       skip()
#define assert_info(a, m, ...)  skip()
#endif /* PRODUCTION_CODE */
 
static inline unsigned int __addr__(void *ptr)
{
    return (unsigned int) ptr;
}
 
#define check_memory(a)     check((a), "Out of memory")
 
#ifndef DEBUG_ON_HOST
#define check_itcm(a) \
    check((ITCM_BASE   <= __addr__(a) && __addr__(a) < ITCM_TOP),       \
          "%x is not in ITCM", (a))
 
#define check_dtcm(a) \
    check((DTCM_BASE   <= __addr__(a) && __addr__(a) < DTCM_TOP),       \
          "%x is not in DTCM", (a))
 
#define check_sysram(a) \
    check((SYSRAM_BASE <= __addr__(a) && __addr__(a) < SYSRAM_TOP),     \
          "%x is not in sysRAM", (a))
 
#define check_sdram(a) \
    check((SDRAM_BASE  <= __addr__(a) && __addr__(a) < SDRAM_TOP),      \
          "%x is not in sdram", (a))
 
#else  /* DEBUG_ON_HOST */
#define check_itcm(a)       skip()
#define check_dtcm(a)       skip()
#define check_sysram(a)     skip()
#define check_sdram(a)      skip()
#endif /* DEBUG_ON_HOST */
 
#endif /* __ASSERT_H__ */