include/asm-generic/bug.h

   1 #ifndef _ASM_GENERIC_BUG_H
   2 #define _ASM_GENERIC_BUG_H
   3
   4 #include <linux/compiler.h>
   5
   6 #ifdef CONFIG_BUG
   7
   8 #ifdef CONFIG_GENERIC_BUG
   9 #ifndef __ASSEMBLY__
  10 struct bug_entry {
  11 #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
  12         unsigned long   bug_addr;
  13 #else
  14         signed int      bug_addr_disp;
  15 #endif
  16 #ifdef CONFIG_DEBUG_BUGVERBOSE
  17 #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
  18         const char      *file;
  19 #else
  20         signed int      file_disp;
  21 #endif
  22         unsigned short  line;
  23 #endif
  24         unsigned short  flags;
  25 };
  26 #endif          /* __ASSEMBLY__ */
  27
  28 #define BUGFLAG_WARNING (1<<0)
  29 #endif  /* CONFIG_GENERIC_BUG */
  30
  31 /*
  32  * Don't use BUG() or BUG_ON() unless there's really no way out; one
  33  * example might be detecting data structure corruption in the middle
  34  * of an operation that can't be backed out of.  If the (sub)system
  35  * can somehow continue operating, perhaps with reduced functionality,
  36  * it's probably not BUG-worthy.
  37  *
  38  * If you're tempted to BUG(), think again:  is completely giving up
  39  * really the *only* solution?  There are usually better options, where
  40  * users don't need to reboot ASAP and can mostly shut down cleanly.
  41  */
  42 #ifndef HAVE_ARCH_BUG
  43 #define BUG() do { \
  44         printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \
  45         panic("BUG!"); \
  46 } while (0)
  47 #endif
  48
  49 #ifndef HAVE_ARCH_BUG_ON
  50 #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while(0)
  51 #endif
  52
  53 #define __WARN_RATELIMIT(condition, state, format...)           \
  54 ({                                                              \
  55         int rtn = 0;                                            \
  56         if (unlikely(__ratelimit(state)))                       \
  57                 rtn = WARN(condition, format);                  \
  58         rtn;                                                    \
  59 })
  60
  61 #define WARN_RATELIMIT(condition, format...)                    \
  62 ({                                                              \
  63         static DEFINE_RATELIMIT_STATE(_rs,                      \
  64                                       DEFAULT_RATELIMIT_INTERVAL,       \
  65                                       DEFAULT_RATELIMIT_BURST); \
  66         __WARN_RATELIMIT(condition, &_rs, format);              \
  67 })
  68
  69 /*
  70  * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report
  71  * significant issues that need prompt attention if they should ever
  72  * appear at runtime.  Use the versions with printk format strings
  73  * to provide better diagnostics.
  74  */
  75 #ifndef __WARN
  76 #ifndef __ASSEMBLY__
  77 extern void warn_slowpath_fmt(const char *file, const int line,
  78                 const char *fmt, ...) __attribute__((format(printf, 3, 4)));
  79 extern void warn_slowpath_null(const char *file, const int line);
  80 #define WANT_WARN_ON_SLOWPATH
  81 #endif
  82 #define __WARN()                warn_slowpath_null(__FILE__, __LINE__)
  83 #define __WARN_printf(arg...)   warn_slowpath_fmt(__FILE__, __LINE__, arg)
  84 #else
  85 #define __WARN_printf(arg...)   do { printk(arg); __WARN(); } while (0)
  86 #endif
  87
  88 #ifndef WARN_ON
  89 #define WARN_ON(condition) ({                                           \
  90         int __ret_warn_on = !!(condition);                              \
  91         if (unlikely(__ret_warn_on))                                    \
  92                 __WARN();                                               \
  93         unlikely(__ret_warn_on);                                        \
  94 })
  95 #endif
  96
  97 #ifndef WARN
  98 #define WARN(condition, format...) ({                                           \
  99         int __ret_warn_on = !!(condition);                              \
 100         if (unlikely(__ret_warn_on))                                    \
 101                 __WARN_printf(format);                                  \
 102         unlikely(__ret_warn_on);                                        \
 103 })
 104 #endif
 105
 106 #else /* !CONFIG_BUG */
 107 #ifndef HAVE_ARCH_BUG
 108 #define BUG() do {} while(0)
 109 #endif
 110
 111 #ifndef HAVE_ARCH_BUG_ON
 112 #define BUG_ON(condition) do { if (condition) ; } while(0)
 113 #endif
 114
 115 #ifndef HAVE_ARCH_WARN_ON
 116 #define WARN_ON(condition) ({                                           \
 117         int __ret_warn_on = !!(condition);                              \
 118         unlikely(__ret_warn_on);                                        \
 119 })
 120 #endif
 121
 122 #ifndef WARN
 123 #define WARN(condition, format...) ({                                   \
 124         int __ret_warn_on = !!(condition);                              \
 125         unlikely(__ret_warn_on);                                        \
 126 })
 127 #endif
 128
 129 #endif
 130
 131 #define WARN_ON_ONCE(condition) ({                              \
 132         static int __warned;                                    \
 133         int __ret_warn_once = !!(condition);                    \
 134                                                                 \
 135         if (unlikely(__ret_warn_once))                          \
 136                 if (WARN_ON(!__warned))                         \
 137                         __warned = 1;                           \
 138         unlikely(__ret_warn_once);                              \
 139 })
 140
 141 #define WARN_ONCE(condition, format...) ({                      \
 142         static int __warned;                                    \
 143         int __ret_warn_once = !!(condition);                    \
 144                                                                 \
 145         if (unlikely(__ret_warn_once))                          \
 146                 if (WARN(!__warned, format))                    \
 147                         __warned = 1;                           \
 148         unlikely(__ret_warn_once);                              \
 149 })
 150
 151 #define WARN_ON_RATELIMIT(condition, state)                     \
 152                 WARN_ON((condition) && __ratelimit(state))
 153
 154 #ifdef CONFIG_SMP
 155 # define WARN_ON_SMP(x)                 WARN_ON(x)
 156 #else
 157 # define WARN_ON_SMP(x)                 do { } while (0)
 158 #endif
 159
 160 #endif