11da177e4SLinus Torvalds #ifndef _ASM_GENERIC_BUG_H 21da177e4SLinus Torvalds #define _ASM_GENERIC_BUG_H 31da177e4SLinus Torvalds 41da177e4SLinus Torvalds #include <linux/compiler.h> 51da177e4SLinus Torvalds 6c8538a7aSMatt Mackall #ifdef CONFIG_BUG 77664c5a1SJeremy Fitzhardinge 87664c5a1SJeremy Fitzhardinge #ifdef CONFIG_GENERIC_BUG 97664c5a1SJeremy Fitzhardinge #ifndef __ASSEMBLY__ 107664c5a1SJeremy Fitzhardinge struct bug_entry { 11b93a531eSJan Beulich #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS 127664c5a1SJeremy Fitzhardinge unsigned long bug_addr; 13b93a531eSJan Beulich #else 14b93a531eSJan Beulich signed int bug_addr_disp; 15b93a531eSJan Beulich #endif 167664c5a1SJeremy Fitzhardinge #ifdef CONFIG_DEBUG_BUGVERBOSE 17b93a531eSJan Beulich #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS 187664c5a1SJeremy Fitzhardinge const char *file; 19b93a531eSJan Beulich #else 20b93a531eSJan Beulich signed int file_disp; 21b93a531eSJan Beulich #endif 227664c5a1SJeremy Fitzhardinge unsigned short line; 237664c5a1SJeremy Fitzhardinge #endif 247664c5a1SJeremy Fitzhardinge unsigned short flags; 257664c5a1SJeremy Fitzhardinge }; 267664c5a1SJeremy Fitzhardinge #endif /* __ASSEMBLY__ */ 277664c5a1SJeremy Fitzhardinge 287664c5a1SJeremy Fitzhardinge #define BUGFLAG_WARNING (1 << 0) 29b2be0527SBen Hutchings #define BUGFLAG_TAINT(taint) (BUGFLAG_WARNING | ((taint) << 8)) 30b2be0527SBen Hutchings #define BUG_GET_TAINT(bug) ((bug)->flags >> 8) 31b2be0527SBen Hutchings 327664c5a1SJeremy Fitzhardinge #endif /* CONFIG_GENERIC_BUG */ 337664c5a1SJeremy Fitzhardinge 34af9379c7SDavid Brownell /* 35af9379c7SDavid Brownell * Don't use BUG() or BUG_ON() unless there's really no way out; one 36af9379c7SDavid Brownell * example might be detecting data structure corruption in the middle 37af9379c7SDavid Brownell * of an operation that can't be backed out of. If the (sub)system 38af9379c7SDavid Brownell * can somehow continue operating, perhaps with reduced functionality, 39af9379c7SDavid Brownell * it's probably not BUG-worthy. 40af9379c7SDavid Brownell * 41af9379c7SDavid Brownell * If you're tempted to BUG(), think again: is completely giving up 42af9379c7SDavid Brownell * really the *only* solution? There are usually better options, where 43af9379c7SDavid Brownell * users don't need to reboot ASAP and can mostly shut down cleanly. 44af9379c7SDavid Brownell */ 451da177e4SLinus Torvalds #ifndef HAVE_ARCH_BUG 461da177e4SLinus Torvalds #define BUG() do { \ 47d5c003b4SHarvey Harrison printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \ 481da177e4SLinus Torvalds panic("BUG!"); \ 491da177e4SLinus Torvalds } while (0) 501da177e4SLinus Torvalds #endif 511da177e4SLinus Torvalds 521da177e4SLinus Torvalds #ifndef HAVE_ARCH_BUG_ON 532a41de48SAlexey Dobriyan #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while(0) 541da177e4SLinus Torvalds #endif 551da177e4SLinus Torvalds 56af9379c7SDavid Brownell /* 57af9379c7SDavid Brownell * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report 58af9379c7SDavid Brownell * significant issues that need prompt attention if they should ever 59af9379c7SDavid Brownell * appear at runtime. Use the versions with printk format strings 60af9379c7SDavid Brownell * to provide better diagnostics. 61af9379c7SDavid Brownell */ 62b2be0527SBen Hutchings #ifndef __WARN_TAINT 6379b4cc5eSArjan van de Ven #ifndef __ASSEMBLY__ 64b9075fa9SJoe Perches extern __printf(3, 4) 65b9075fa9SJoe Perches void warn_slowpath_fmt(const char *file, const int line, 66b9075fa9SJoe Perches const char *fmt, ...); 67b9075fa9SJoe Perches extern __printf(4, 5) 68b9075fa9SJoe Perches void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint, 69b9075fa9SJoe Perches const char *fmt, ...); 7057adc4d2SAndi Kleen extern void warn_slowpath_null(const char *file, const int line); 7179b4cc5eSArjan van de Ven #define WANT_WARN_ON_SLOWPATH 7279b4cc5eSArjan van de Ven #endif 7357adc4d2SAndi Kleen #define __WARN() warn_slowpath_null(__FILE__, __LINE__) 7457adc4d2SAndi Kleen #define __WARN_printf(arg...) warn_slowpath_fmt(__FILE__, __LINE__, arg) 75b2be0527SBen Hutchings #define __WARN_printf_taint(taint, arg...) \ 76b2be0527SBen Hutchings warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg) 77a8f18b90SArjan van de Ven #else 78b2be0527SBen Hutchings #define __WARN() __WARN_TAINT(TAINT_WARN) 79f6f286f3SArjan van de Ven #define __WARN_printf(arg...) do { printk(arg); __WARN(); } while (0) 80b2be0527SBen Hutchings #define __WARN_printf_taint(taint, arg...) \ 81b2be0527SBen Hutchings do { printk(arg); __WARN_TAINT(taint); } while (0) 823a6a62f9SOlof Johansson #endif 833a6a62f9SOlof Johansson 843a6a62f9SOlof Johansson #ifndef WARN_ON 853a6a62f9SOlof Johansson #define WARN_ON(condition) ({ \ 863a6a62f9SOlof Johansson int __ret_warn_on = !!(condition); \ 873a6a62f9SOlof Johansson if (unlikely(__ret_warn_on)) \ 883a6a62f9SOlof Johansson __WARN(); \ 89684f9783SHerbert Xu unlikely(__ret_warn_on); \ 90684f9783SHerbert Xu }) 911da177e4SLinus Torvalds #endif 921da177e4SLinus Torvalds 93a8f18b90SArjan van de Ven #ifndef WARN 94a8f18b90SArjan van de Ven #define WARN(condition, format...) ({ \ 95a8f18b90SArjan van de Ven int __ret_warn_on = !!(condition); \ 96a8f18b90SArjan van de Ven if (unlikely(__ret_warn_on)) \ 97a8f18b90SArjan van de Ven __WARN_printf(format); \ 98a8f18b90SArjan van de Ven unlikely(__ret_warn_on); \ 99a8f18b90SArjan van de Ven }) 100a8f18b90SArjan van de Ven #endif 101a8f18b90SArjan van de Ven 102b2be0527SBen Hutchings #define WARN_TAINT(condition, taint, format...) ({ \ 103b2be0527SBen Hutchings int __ret_warn_on = !!(condition); \ 104b2be0527SBen Hutchings if (unlikely(__ret_warn_on)) \ 105b2be0527SBen Hutchings __WARN_printf_taint(taint, format); \ 106b2be0527SBen Hutchings unlikely(__ret_warn_on); \ 107b2be0527SBen Hutchings }) 108b2be0527SBen Hutchings 109c8538a7aSMatt Mackall #else /* !CONFIG_BUG */ 110c8538a7aSMatt Mackall #ifndef HAVE_ARCH_BUG 111da60682cSDavid Howells #define BUG() do {} while(0) 112c8538a7aSMatt Mackall #endif 113c8538a7aSMatt Mackall 114c8538a7aSMatt Mackall #ifndef HAVE_ARCH_BUG_ON 115c8538a7aSMatt Mackall #define BUG_ON(condition) do { if (condition) ; } while(0) 116c8538a7aSMatt Mackall #endif 117c8538a7aSMatt Mackall 118c8538a7aSMatt Mackall #ifndef HAVE_ARCH_WARN_ON 1198c7c7c9bSRalf Baechle #define WARN_ON(condition) ({ \ 1208d4fbcfbSLinus Torvalds int __ret_warn_on = !!(condition); \ 1218c7c7c9bSRalf Baechle unlikely(__ret_warn_on); \ 1228c7c7c9bSRalf Baechle }) 123c8538a7aSMatt Mackall #endif 124a8f18b90SArjan van de Ven 125a8f18b90SArjan van de Ven #ifndef WARN 126a8f18b90SArjan van de Ven #define WARN(condition, format...) ({ \ 127a8f18b90SArjan van de Ven int __ret_warn_on = !!(condition); \ 128a8f18b90SArjan van de Ven unlikely(__ret_warn_on); \ 129a8f18b90SArjan van de Ven }) 130a8f18b90SArjan van de Ven #endif 131a8f18b90SArjan van de Ven 132b2be0527SBen Hutchings #define WARN_TAINT(condition, taint, format...) WARN_ON(condition) 133b2be0527SBen Hutchings 134c8538a7aSMatt Mackall #endif 135c8538a7aSMatt Mackall 136684f9783SHerbert Xu #define WARN_ON_ONCE(condition) ({ \ 13742f247c8SCesar Eduardo Barros static bool __warned; \ 1388d4fbcfbSLinus Torvalds int __ret_warn_once = !!(condition); \ 13974bb6a09SIngo Molnar \ 140d69a8922SAndrew Morton if (unlikely(__ret_warn_once)) \ 141d69a8922SAndrew Morton if (WARN_ON(!__warned)) \ 14242f247c8SCesar Eduardo Barros __warned = true; \ 143684f9783SHerbert Xu unlikely(__ret_warn_once); \ 14474bb6a09SIngo Molnar }) 14574bb6a09SIngo Molnar 14645e9c0deSArjan van de Ven #define WARN_ONCE(condition, format...) ({ \ 14742f247c8SCesar Eduardo Barros static bool __warned; \ 14845e9c0deSArjan van de Ven int __ret_warn_once = !!(condition); \ 14945e9c0deSArjan van de Ven \ 15045e9c0deSArjan van de Ven if (unlikely(__ret_warn_once)) \ 15145e9c0deSArjan van de Ven if (WARN(!__warned, format)) \ 15242f247c8SCesar Eduardo Barros __warned = true; \ 15345e9c0deSArjan van de Ven unlikely(__ret_warn_once); \ 15445e9c0deSArjan van de Ven }) 15545e9c0deSArjan van de Ven 156b2be0527SBen Hutchings #define WARN_TAINT_ONCE(condition, taint, format...) ({ \ 157b2be0527SBen Hutchings static bool __warned; \ 158b2be0527SBen Hutchings int __ret_warn_once = !!(condition); \ 159b2be0527SBen Hutchings \ 160b2be0527SBen Hutchings if (unlikely(__ret_warn_once)) \ 161b2be0527SBen Hutchings if (WARN_TAINT(!__warned, taint, format)) \ 162b2be0527SBen Hutchings __warned = true; \ 163b2be0527SBen Hutchings unlikely(__ret_warn_once); \ 164b2be0527SBen Hutchings }) 165b2be0527SBen Hutchings 1662092e6beSSteven Rostedt /* 1672092e6beSSteven Rostedt * WARN_ON_SMP() is for cases that the warning is either 1682092e6beSSteven Rostedt * meaningless for !SMP or may even cause failures. 1692092e6beSSteven Rostedt * This is usually used for cases that we have 1702092e6beSSteven Rostedt * WARN_ON(!spin_is_locked(&lock)) checks, as spin_is_locked() 1712092e6beSSteven Rostedt * returns 0 for uniprocessor settings. 1722092e6beSSteven Rostedt * It can also be used with values that are only defined 1732092e6beSSteven Rostedt * on SMP: 1742092e6beSSteven Rostedt * 1752092e6beSSteven Rostedt * struct foo { 1762092e6beSSteven Rostedt * [...] 1772092e6beSSteven Rostedt * #ifdef CONFIG_SMP 1782092e6beSSteven Rostedt * int bar; 1792092e6beSSteven Rostedt * #endif 1802092e6beSSteven Rostedt * }; 1812092e6beSSteven Rostedt * 1822092e6beSSteven Rostedt * void func(struct foo *zoot) 1832092e6beSSteven Rostedt * { 1842092e6beSSteven Rostedt * WARN_ON_SMP(!zoot->bar); 1852092e6beSSteven Rostedt * 1862092e6beSSteven Rostedt * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(), 1872092e6beSSteven Rostedt * and should be a nop and return false for uniprocessor. 1882092e6beSSteven Rostedt * 1892092e6beSSteven Rostedt * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set 1902092e6beSSteven Rostedt * and x is true. 1912092e6beSSteven Rostedt */ 1928eb94f80SIngo Molnar #ifdef CONFIG_SMP 1938eb94f80SIngo Molnar # define WARN_ON_SMP(x) WARN_ON(x) 1948eb94f80SIngo Molnar #else 195ccd0d44fSSteven Rostedt /* 196ccd0d44fSSteven Rostedt * Use of ({0;}) because WARN_ON_SMP(x) may be used either as 197ccd0d44fSSteven Rostedt * a stand alone line statement or as a condition in an if () 198ccd0d44fSSteven Rostedt * statement. 199ccd0d44fSSteven Rostedt * A simple "0" would cause gcc to give a "statement has no effect" 200ccd0d44fSSteven Rostedt * warning. 201ccd0d44fSSteven Rostedt */ 2022092e6beSSteven Rostedt # define WARN_ON_SMP(x) ({0;}) 2038eb94f80SIngo Molnar #endif 2048eb94f80SIngo Molnar 2051da177e4SLinus Torvalds #endif 206