1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */ 21da177e4SLinus Torvalds #ifndef _ASM_GENERIC_BUG_H 31da177e4SLinus Torvalds #define _ASM_GENERIC_BUG_H 41da177e4SLinus Torvalds 51da177e4SLinus Torvalds #include <linux/compiler.h> 61da177e4SLinus Torvalds 72a8358d8SKees Cook #define CUT_HERE "------------[ cut here ]------------\n" 82a8358d8SKees Cook 909682c1dSPaul Mundt #ifdef CONFIG_GENERIC_BUG 1009682c1dSPaul Mundt #define BUGFLAG_WARNING (1 << 0) 1119d43626SPeter Zijlstra #define BUGFLAG_ONCE (1 << 1) 1219d43626SPeter Zijlstra #define BUGFLAG_DONE (1 << 2) 13f26dee15SPeter Zijlstra #define BUGFLAG_TAINT(taint) ((taint) << 8) 1409682c1dSPaul Mundt #define BUG_GET_TAINT(bug) ((bug)->flags >> 8) 1509682c1dSPaul Mundt #endif 1609682c1dSPaul Mundt 1709682c1dSPaul Mundt #ifndef __ASSEMBLY__ 1809682c1dSPaul Mundt #include <linux/kernel.h> 1909682c1dSPaul Mundt 20c8538a7aSMatt Mackall #ifdef CONFIG_BUG 217664c5a1SJeremy Fitzhardinge 227664c5a1SJeremy Fitzhardinge #ifdef CONFIG_GENERIC_BUG 237664c5a1SJeremy Fitzhardinge struct bug_entry { 24b93a531eSJan Beulich #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS 257664c5a1SJeremy Fitzhardinge unsigned long bug_addr; 26b93a531eSJan Beulich #else 27b93a531eSJan Beulich signed int bug_addr_disp; 28b93a531eSJan Beulich #endif 297664c5a1SJeremy Fitzhardinge #ifdef CONFIG_DEBUG_BUGVERBOSE 30b93a531eSJan Beulich #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS 317664c5a1SJeremy Fitzhardinge const char *file; 32b93a531eSJan Beulich #else 33b93a531eSJan Beulich signed int file_disp; 34b93a531eSJan Beulich #endif 357664c5a1SJeremy Fitzhardinge unsigned short line; 367664c5a1SJeremy Fitzhardinge #endif 377664c5a1SJeremy Fitzhardinge unsigned short flags; 387664c5a1SJeremy Fitzhardinge }; 397664c5a1SJeremy Fitzhardinge #endif /* CONFIG_GENERIC_BUG */ 407664c5a1SJeremy Fitzhardinge 41af9379c7SDavid Brownell /* 42af9379c7SDavid Brownell * Don't use BUG() or BUG_ON() unless there's really no way out; one 43af9379c7SDavid Brownell * example might be detecting data structure corruption in the middle 44af9379c7SDavid Brownell * of an operation that can't be backed out of. If the (sub)system 45af9379c7SDavid Brownell * can somehow continue operating, perhaps with reduced functionality, 46af9379c7SDavid Brownell * it's probably not BUG-worthy. 47af9379c7SDavid Brownell * 48af9379c7SDavid Brownell * If you're tempted to BUG(), think again: is completely giving up 49af9379c7SDavid Brownell * really the *only* solution? There are usually better options, where 50af9379c7SDavid Brownell * users don't need to reboot ASAP and can mostly shut down cleanly. 51af9379c7SDavid Brownell */ 521da177e4SLinus Torvalds #ifndef HAVE_ARCH_BUG 531da177e4SLinus Torvalds #define BUG() do { \ 54d5c003b4SHarvey Harrison printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \ 551da177e4SLinus Torvalds panic("BUG!"); \ 561da177e4SLinus Torvalds } while (0) 571da177e4SLinus Torvalds #endif 581da177e4SLinus Torvalds 591da177e4SLinus Torvalds #ifndef HAVE_ARCH_BUG_ON 602a41de48SAlexey Dobriyan #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0) 611da177e4SLinus Torvalds #endif 621da177e4SLinus Torvalds 6319d43626SPeter Zijlstra #ifdef __WARN_FLAGS 6419d43626SPeter Zijlstra #define __WARN_TAINT(taint) __WARN_FLAGS(BUGFLAG_TAINT(taint)) 6519d43626SPeter Zijlstra #define __WARN_ONCE_TAINT(taint) __WARN_FLAGS(BUGFLAG_ONCE|BUGFLAG_TAINT(taint)) 6619d43626SPeter Zijlstra 6719d43626SPeter Zijlstra #define WARN_ON_ONCE(condition) ({ \ 6819d43626SPeter Zijlstra int __ret_warn_on = !!(condition); \ 6919d43626SPeter Zijlstra if (unlikely(__ret_warn_on)) \ 7019d43626SPeter Zijlstra __WARN_ONCE_TAINT(TAINT_WARN); \ 7119d43626SPeter Zijlstra unlikely(__ret_warn_on); \ 7219d43626SPeter Zijlstra }) 7319d43626SPeter Zijlstra #endif 7419d43626SPeter Zijlstra 75af9379c7SDavid Brownell /* 76af9379c7SDavid Brownell * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report 77af9379c7SDavid Brownell * significant issues that need prompt attention if they should ever 78af9379c7SDavid Brownell * appear at runtime. Use the versions with printk format strings 79af9379c7SDavid Brownell * to provide better diagnostics. 80af9379c7SDavid Brownell */ 81b2be0527SBen Hutchings #ifndef __WARN_TAINT 82b9075fa9SJoe Perches extern __printf(3, 4) 83b9075fa9SJoe Perches void warn_slowpath_fmt(const char *file, const int line, 84b9075fa9SJoe Perches const char *fmt, ...); 85b9075fa9SJoe Perches extern __printf(4, 5) 86b9075fa9SJoe Perches void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint, 87b9075fa9SJoe Perches const char *fmt, ...); 8857adc4d2SAndi Kleen extern void warn_slowpath_null(const char *file, const int line); 8979b4cc5eSArjan van de Ven #define WANT_WARN_ON_SLOWPATH 9057adc4d2SAndi Kleen #define __WARN() warn_slowpath_null(__FILE__, __LINE__) 9157adc4d2SAndi Kleen #define __WARN_printf(arg...) warn_slowpath_fmt(__FILE__, __LINE__, arg) 92b2be0527SBen Hutchings #define __WARN_printf_taint(taint, arg...) \ 93b2be0527SBen Hutchings warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg) 94a8f18b90SArjan van de Ven #else 95b2be0527SBen Hutchings #define __WARN() __WARN_TAINT(TAINT_WARN) 96f6f286f3SArjan van de Ven #define __WARN_printf(arg...) do { printk(arg); __WARN(); } while (0) 97b2be0527SBen Hutchings #define __WARN_printf_taint(taint, arg...) \ 98b2be0527SBen Hutchings do { printk(arg); __WARN_TAINT(taint); } while (0) 993a6a62f9SOlof Johansson #endif 1003a6a62f9SOlof Johansson 1012553b67aSJosh Poimboeuf /* used internally by panic.c */ 1022553b67aSJosh Poimboeuf struct warn_args; 1030b396923SIan Abbott struct pt_regs; 1042553b67aSJosh Poimboeuf 1052553b67aSJosh Poimboeuf void __warn(const char *file, int line, void *caller, unsigned taint, 1062553b67aSJosh Poimboeuf struct pt_regs *regs, struct warn_args *args); 1072553b67aSJosh Poimboeuf 1083a6a62f9SOlof Johansson #ifndef WARN_ON 1093a6a62f9SOlof Johansson #define WARN_ON(condition) ({ \ 1103a6a62f9SOlof Johansson int __ret_warn_on = !!(condition); \ 1113a6a62f9SOlof Johansson if (unlikely(__ret_warn_on)) \ 1123a6a62f9SOlof Johansson __WARN(); \ 113684f9783SHerbert Xu unlikely(__ret_warn_on); \ 114684f9783SHerbert Xu }) 1151da177e4SLinus Torvalds #endif 1161da177e4SLinus Torvalds 117a8f18b90SArjan van de Ven #ifndef WARN 118a8f18b90SArjan van de Ven #define WARN(condition, format...) ({ \ 119a8f18b90SArjan van de Ven int __ret_warn_on = !!(condition); \ 120a8f18b90SArjan van de Ven if (unlikely(__ret_warn_on)) \ 121a8f18b90SArjan van de Ven __WARN_printf(format); \ 122a8f18b90SArjan van de Ven unlikely(__ret_warn_on); \ 123a8f18b90SArjan van de Ven }) 124a8f18b90SArjan van de Ven #endif 125a8f18b90SArjan van de Ven 126b2be0527SBen Hutchings #define WARN_TAINT(condition, taint, format...) ({ \ 127b2be0527SBen Hutchings int __ret_warn_on = !!(condition); \ 128b2be0527SBen Hutchings if (unlikely(__ret_warn_on)) \ 129b2be0527SBen Hutchings __WARN_printf_taint(taint, format); \ 130b2be0527SBen Hutchings unlikely(__ret_warn_on); \ 131b2be0527SBen Hutchings }) 132b2be0527SBen Hutchings 13319d43626SPeter Zijlstra #ifndef WARN_ON_ONCE 134684f9783SHerbert Xu #define WARN_ON_ONCE(condition) ({ \ 135b1fca27dSAndi Kleen static bool __section(.data.once) __warned; \ 1368d4fbcfbSLinus Torvalds int __ret_warn_once = !!(condition); \ 13774bb6a09SIngo Molnar \ 138dfbf2897SSteven Rostedt if (unlikely(__ret_warn_once && !__warned)) { \ 13942f247c8SCesar Eduardo Barros __warned = true; \ 140dfbf2897SSteven Rostedt WARN_ON(1); \ 141dfbf2897SSteven Rostedt } \ 142684f9783SHerbert Xu unlikely(__ret_warn_once); \ 14374bb6a09SIngo Molnar }) 14419d43626SPeter Zijlstra #endif 14574bb6a09SIngo Molnar 14645e9c0deSArjan van de Ven #define WARN_ONCE(condition, format...) ({ \ 147b1fca27dSAndi Kleen static bool __section(.data.once) __warned; \ 14845e9c0deSArjan van de Ven int __ret_warn_once = !!(condition); \ 14945e9c0deSArjan van de Ven \ 150dfbf2897SSteven Rostedt if (unlikely(__ret_warn_once && !__warned)) { \ 15142f247c8SCesar Eduardo Barros __warned = true; \ 152dfbf2897SSteven Rostedt WARN(1, format); \ 153dfbf2897SSteven Rostedt } \ 15445e9c0deSArjan van de Ven unlikely(__ret_warn_once); \ 15545e9c0deSArjan van de Ven }) 15645e9c0deSArjan van de Ven 157b2be0527SBen Hutchings #define WARN_TAINT_ONCE(condition, taint, format...) ({ \ 158b1fca27dSAndi Kleen static bool __section(.data.once) __warned; \ 159b2be0527SBen Hutchings int __ret_warn_once = !!(condition); \ 160b2be0527SBen Hutchings \ 161dfbf2897SSteven Rostedt if (unlikely(__ret_warn_once && !__warned)) { \ 162b2be0527SBen Hutchings __warned = true; \ 163dfbf2897SSteven Rostedt WARN_TAINT(1, taint, format); \ 164dfbf2897SSteven Rostedt } \ 165b2be0527SBen Hutchings unlikely(__ret_warn_once); \ 166b2be0527SBen Hutchings }) 167b2be0527SBen Hutchings 168b607e70eSJosh Triplett #else /* !CONFIG_BUG */ 169b607e70eSJosh Triplett #ifndef HAVE_ARCH_BUG 170a4b5d580SJosh Triplett #define BUG() do {} while (1) 171b607e70eSJosh Triplett #endif 172b607e70eSJosh Triplett 173b607e70eSJosh Triplett #ifndef HAVE_ARCH_BUG_ON 1743c047057SArnd Bergmann #define BUG_ON(condition) do { if (condition) BUG(); } while (0) 175b607e70eSJosh Triplett #endif 176b607e70eSJosh Triplett 177b607e70eSJosh Triplett #ifndef HAVE_ARCH_WARN_ON 178b607e70eSJosh Triplett #define WARN_ON(condition) ({ \ 179b607e70eSJosh Triplett int __ret_warn_on = !!(condition); \ 180b607e70eSJosh Triplett unlikely(__ret_warn_on); \ 181b607e70eSJosh Triplett }) 182b607e70eSJosh Triplett #endif 183b607e70eSJosh Triplett 184b607e70eSJosh Triplett #ifndef WARN 185b607e70eSJosh Triplett #define WARN(condition, format...) ({ \ 186b607e70eSJosh Triplett int __ret_warn_on = !!(condition); \ 1874e50ebdeSJosh Triplett no_printk(format); \ 188b607e70eSJosh Triplett unlikely(__ret_warn_on); \ 189b607e70eSJosh Triplett }) 190b607e70eSJosh Triplett #endif 191b607e70eSJosh Triplett 192b607e70eSJosh Triplett #define WARN_ON_ONCE(condition) WARN_ON(condition) 193b607e70eSJosh Triplett #define WARN_ONCE(condition, format...) WARN(condition, format) 194b607e70eSJosh Triplett #define WARN_TAINT(condition, taint, format...) WARN(condition, format) 195b607e70eSJosh Triplett #define WARN_TAINT_ONCE(condition, taint, format...) WARN(condition, format) 196b607e70eSJosh Triplett 197b607e70eSJosh Triplett #endif 198b607e70eSJosh Triplett 1992092e6beSSteven Rostedt /* 2002092e6beSSteven Rostedt * WARN_ON_SMP() is for cases that the warning is either 2012092e6beSSteven Rostedt * meaningless for !SMP or may even cause failures. 2022092e6beSSteven Rostedt * This is usually used for cases that we have 2032092e6beSSteven Rostedt * WARN_ON(!spin_is_locked(&lock)) checks, as spin_is_locked() 2042092e6beSSteven Rostedt * returns 0 for uniprocessor settings. 2052092e6beSSteven Rostedt * It can also be used with values that are only defined 2062092e6beSSteven Rostedt * on SMP: 2072092e6beSSteven Rostedt * 2082092e6beSSteven Rostedt * struct foo { 2092092e6beSSteven Rostedt * [...] 2102092e6beSSteven Rostedt * #ifdef CONFIG_SMP 2112092e6beSSteven Rostedt * int bar; 2122092e6beSSteven Rostedt * #endif 2132092e6beSSteven Rostedt * }; 2142092e6beSSteven Rostedt * 2152092e6beSSteven Rostedt * void func(struct foo *zoot) 2162092e6beSSteven Rostedt * { 2172092e6beSSteven Rostedt * WARN_ON_SMP(!zoot->bar); 2182092e6beSSteven Rostedt * 2192092e6beSSteven Rostedt * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(), 2202092e6beSSteven Rostedt * and should be a nop and return false for uniprocessor. 2212092e6beSSteven Rostedt * 2222092e6beSSteven Rostedt * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set 2232092e6beSSteven Rostedt * and x is true. 2242092e6beSSteven Rostedt */ 2258eb94f80SIngo Molnar #ifdef CONFIG_SMP 2268eb94f80SIngo Molnar # define WARN_ON_SMP(x) WARN_ON(x) 2278eb94f80SIngo Molnar #else 228ccd0d44fSSteven Rostedt /* 229ccd0d44fSSteven Rostedt * Use of ({0;}) because WARN_ON_SMP(x) may be used either as 230ccd0d44fSSteven Rostedt * a stand alone line statement or as a condition in an if () 231ccd0d44fSSteven Rostedt * statement. 232ccd0d44fSSteven Rostedt * A simple "0" would cause gcc to give a "statement has no effect" 233ccd0d44fSSteven Rostedt * warning. 234ccd0d44fSSteven Rostedt */ 2352092e6beSSteven Rostedt # define WARN_ON_SMP(x) ({0;}) 2368eb94f80SIngo Molnar #endif 2378eb94f80SIngo Molnar 2382603efa3SPaul Mundt #endif /* __ASSEMBLY__ */ 2392603efa3SPaul Mundt 2401da177e4SLinus Torvalds #endif 241