kernel/generic/include/debug.h

   1 /*
   2  * Copyright (c) 2005 Martin Decky
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup genericdebug
  30  * @{
  31  */
  32 /** @file
  33  */
  34
  35 #ifndef KERN_DEBUG_H_
  36 #define KERN_DEBUG_H_
  37
  38 #include <panic.h>
  39 #include <log.h>
  40 #include <symtab_lookup.h>
  41
  42 #define CALLER  ((uintptr_t) __builtin_return_address(0))
  43
  44 #ifdef CONFIG_DEBUG
  45
  46 /** Debugging ASSERT macro
  47  *
  48  * If CONFIG_DEBUG is set, the ASSERT() macro
  49  * evaluates expr and if it is false raises
  50  * kernel panic.
  51  *
  52  * @param expr Expression which is expected to be true.
  53  *
  54  */
  55 #define ASSERT(expr) \
  56         do { \
  57                 if (!(expr)) \
  58                         panic_assert("%s() at %s:%u:\n%s", \
  59                             __func__, __FILE__, __LINE__, #expr); \
  60         } while (0)
  61
  62 /** Debugging verbose ASSERT macro
  63  *
  64  * If CONFIG_DEBUG is set, the ASSERT() macro
  65  * evaluates expr and if it is false raises
  66  * kernel panic. The panic message contains also
  67  * the supplied message.
  68  *
  69  * @param expr Expression which is expected to be true.
  70  * @param msg  Additional message to show (string).
  71  *
  72  */
  73 #define ASSERT_VERBOSE(expr, msg) \
  74         do { \
  75                 if (!(expr)) \
  76                         panic_assert("%s() at %s:%u:\n%s, %s", \
  77                             __func__, __FILE__, __LINE__, #expr, msg); \
  78         } while (0)
  79
  80 /** Static assert macro
  81  *
  82  */
  83 #define STATIC_ASSERT(expr) \
  84         _Static_assert(expr, "")
  85
  86 #define STATIC_ASSERT_VERBOSE(expr, msg) \
  87         _Static_assert(expr, msg)
  88
  89
  90 #else /* CONFIG_DEBUG */
  91
  92 #define ASSERT(expr)
  93 #define ASSERT_VERBOSE(expr, msg)
  94 #define STATIC_ASSERT(expr)
  95 #define STATIC_ASSERT_VERBOSE(expr, msg)
  96
  97 #endif /* CONFIG_DEBUG */
  98
  99 #ifdef CONFIG_LOG
 100
 101 /** Extensive logging output macro
 102  *
 103  * If CONFIG_LOG is set, the LOG() macro
 104  * will print whatever message is indicated plus
 105  * an information about the location.
 106  *
 107  */
 108 #define LOG(format, ...) \
 109         do { \
 110                 log(LF_OTHER, LVL_DEBUG, \
 111                     "%s() from %s at %s:%u: " format,__func__, \
 112                     symtab_fmt_name_lookup(CALLER), __FILE__, __LINE__, \
 113                     ##__VA_ARGS__); \
 114         } while (0)
 115
 116 #else /* CONFIG_LOG */
 117
 118 #define LOG(format, ...)
 119
 120 #endif /* CONFIG_LOG */
 121
 122 #ifdef CONFIG_TRACE
 123
 124 extern void __cyg_profile_func_enter(void *, void *);
 125 extern void __cyg_profile_func_exit(void *, void *);
 126
 127 #endif /* CONFIG_TRACE */
 128
 129 #endif
 130
 131 /** @}
 132  */