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 709682c1dSPaul Mundt #ifdef CONFIG_GENERIC_BUG 809682c1dSPaul Mundt #define BUGFLAG_WARNING (1 << 0) 919d43626SPeter Zijlstra #define BUGFLAG_ONCE (1 << 1) 1019d43626SPeter Zijlstra #define BUGFLAG_DONE (1 << 2) 11f26dee15SPeter Zijlstra #define BUGFLAG_TAINT(taint) ((taint) << 8) 1209682c1dSPaul Mundt #define BUG_GET_TAINT(bug) ((bug)->flags >> 8) 1309682c1dSPaul Mundt #endif 1409682c1dSPaul Mundt 1509682c1dSPaul Mundt #ifndef __ASSEMBLY__ 1609682c1dSPaul Mundt #include <linux/kernel.h> 1709682c1dSPaul Mundt 18c8538a7aSMatt Mackall #ifdef CONFIG_BUG 197664c5a1SJeremy Fitzhardinge 207664c5a1SJeremy Fitzhardinge #ifdef CONFIG_GENERIC_BUG 217664c5a1SJeremy Fitzhardinge struct bug_entry { 22b93a531eSJan Beulich #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS 237664c5a1SJeremy Fitzhardinge unsigned long bug_addr; 24b93a531eSJan Beulich #else 25b93a531eSJan Beulich signed int bug_addr_disp; 26b93a531eSJan Beulich #endif 277664c5a1SJeremy Fitzhardinge #ifdef CONFIG_DEBUG_BUGVERBOSE 28b93a531eSJan Beulich #ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS 297664c5a1SJeremy Fitzhardinge const char *file; 30b93a531eSJan Beulich #else 31b93a531eSJan Beulich signed int file_disp; 32b93a531eSJan Beulich #endif 337664c5a1SJeremy Fitzhardinge unsigned short line; 347664c5a1SJeremy Fitzhardinge #endif 357664c5a1SJeremy Fitzhardinge unsigned short flags; 367664c5a1SJeremy Fitzhardinge }; 377664c5a1SJeremy Fitzhardinge #endif /* CONFIG_GENERIC_BUG */ 387664c5a1SJeremy Fitzhardinge 39af9379c7SDavid Brownell /* 40af9379c7SDavid Brownell * Don't use BUG() or BUG_ON() unless there's really no way out; one 41af9379c7SDavid Brownell * example might be detecting data structure corruption in the middle 42af9379c7SDavid Brownell * of an operation that can't be backed out of. If the (sub)system 43af9379c7SDavid Brownell * can somehow continue operating, perhaps with reduced functionality, 44af9379c7SDavid Brownell * it's probably not BUG-worthy. 45af9379c7SDavid Brownell * 46af9379c7SDavid Brownell * If you're tempted to BUG(), think again: is completely giving up 47af9379c7SDavid Brownell * really the *only* solution? There are usually better options, where 48af9379c7SDavid Brownell * users don't need to reboot ASAP and can mostly shut down cleanly. 49af9379c7SDavid Brownell */ 501da177e4SLinus Torvalds #ifndef HAVE_ARCH_BUG 511da177e4SLinus Torvalds #define BUG() do { \ 52d5c003b4SHarvey Harrison printk("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __func__); \ 531da177e4SLinus Torvalds panic("BUG!"); \ 541da177e4SLinus Torvalds } while (0) 551da177e4SLinus Torvalds #endif 561da177e4SLinus Torvalds 571da177e4SLinus Torvalds #ifndef HAVE_ARCH_BUG_ON 582a41de48SAlexey Dobriyan #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0) 591da177e4SLinus Torvalds #endif 601da177e4SLinus Torvalds 6119d43626SPeter Zijlstra #ifdef __WARN_FLAGS 6219d43626SPeter Zijlstra #define __WARN_TAINT(taint) __WARN_FLAGS(BUGFLAG_TAINT(taint)) 6319d43626SPeter Zijlstra #define __WARN_ONCE_TAINT(taint) __WARN_FLAGS(BUGFLAG_ONCE|BUGFLAG_TAINT(taint)) 6419d43626SPeter Zijlstra 6519d43626SPeter Zijlstra #define WARN_ON_ONCE(condition) ({ \ 6619d43626SPeter Zijlstra int __ret_warn_on = !!(condition); \ 6719d43626SPeter Zijlstra if (unlikely(__ret_warn_on)) \ 6819d43626SPeter Zijlstra __WARN_ONCE_TAINT(TAINT_WARN); \ 6919d43626SPeter Zijlstra unlikely(__ret_warn_on); \ 7019d43626SPeter Zijlstra }) 7119d43626SPeter Zijlstra #endif 7219d43626SPeter Zijlstra 73af9379c7SDavid Brownell /* 74af9379c7SDavid Brownell * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report 75af9379c7SDavid Brownell * significant issues that need prompt attention if they should ever 76af9379c7SDavid Brownell * appear at runtime. Use the versions with printk format strings 77af9379c7SDavid Brownell * to provide better diagnostics. 78af9379c7SDavid Brownell */ 79b2be0527SBen Hutchings #ifndef __WARN_TAINT 80b9075fa9SJoe Perches extern __printf(3, 4) 81b9075fa9SJoe Perches void warn_slowpath_fmt(const char *file, const int line, 82b9075fa9SJoe Perches const char *fmt, ...); 83b9075fa9SJoe Perches extern __printf(4, 5) 84b9075fa9SJoe Perches void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint, 85b9075fa9SJoe Perches const char *fmt, ...); 8657adc4d2SAndi Kleen extern void warn_slowpath_null(const char *file, const int line); 8779b4cc5eSArjan van de Ven #define WANT_WARN_ON_SLOWPATH 8857adc4d2SAndi Kleen #define __WARN() warn_slowpath_null(__FILE__, __LINE__) 8957adc4d2SAndi Kleen #define __WARN_printf(arg...) warn_slowpath_fmt(__FILE__, __LINE__, arg) 90b2be0527SBen Hutchings #define __WARN_printf_taint(taint, arg...) \ 91b2be0527SBen Hutchings warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg) 92a8f18b90SArjan van de Ven #else 93b2be0527SBen Hutchings #define __WARN() __WARN_TAINT(TAINT_WARN) 94f6f286f3SArjan van de Ven #define __WARN_printf(arg...) do { printk(arg); __WARN(); } while (0) 95b2be0527SBen Hutchings #define __WARN_printf_taint(taint, arg...) \ 96b2be0527SBen Hutchings do { printk(arg); __WARN_TAINT(taint); } while (0) 973a6a62f9SOlof Johansson #endif 983a6a62f9SOlof Johansson 992553b67aSJosh Poimboeuf /* used internally by panic.c */ 1002553b67aSJosh Poimboeuf struct warn_args; 1010b396923SIan Abbott struct pt_regs; 1022553b67aSJosh Poimboeuf 1032553b67aSJosh Poimboeuf void __warn(const char *file, int line, void *caller, unsigned taint, 1042553b67aSJosh Poimboeuf struct pt_regs *regs, struct warn_args *args); 1052553b67aSJosh Poimboeuf 1063a6a62f9SOlof Johansson #ifndef WARN_ON 1073a6a62f9SOlof Johansson #define WARN_ON(condition) ({ \ 1083a6a62f9SOlof Johansson int __ret_warn_on = !!(condition); \ 1093a6a62f9SOlof Johansson if (unlikely(__ret_warn_on)) \ 1103a6a62f9SOlof Johansson __WARN(); \ 111684f9783SHerbert Xu unlikely(__ret_warn_on); \ 112684f9783SHerbert Xu }) 1131da177e4SLinus Torvalds #endif 1141da177e4SLinus Torvalds 115a8f18b90SArjan van de Ven #ifndef WARN 116a8f18b90SArjan van de Ven #define WARN(condition, format...) ({ \ 117a8f18b90SArjan van de Ven int __ret_warn_on = !!(condition); \ 118a8f18b90SArjan van de Ven if (unlikely(__ret_warn_on)) \ 119a8f18b90SArjan van de Ven __WARN_printf(format); \ 120a8f18b90SArjan van de Ven unlikely(__ret_warn_on); \ 121a8f18b90SArjan van de Ven }) 122a8f18b90SArjan van de Ven #endif 123a8f18b90SArjan van de Ven 124b2be0527SBen Hutchings #define WARN_TAINT(condition, taint, format...) ({ \ 125b2be0527SBen Hutchings int __ret_warn_on = !!(condition); \ 126b2be0527SBen Hutchings if (unlikely(__ret_warn_on)) \ 127b2be0527SBen Hutchings __WARN_printf_taint(taint, format); \ 128b2be0527SBen Hutchings unlikely(__ret_warn_on); \ 129b2be0527SBen Hutchings }) 130b2be0527SBen Hutchings 13119d43626SPeter Zijlstra #ifndef WARN_ON_ONCE 132684f9783SHerbert Xu #define WARN_ON_ONCE(condition) ({ \ 1337ccaba53SJan Beulich static bool __section(.data.unlikely) __warned; \ 1348d4fbcfbSLinus Torvalds int __ret_warn_once = !!(condition); \ 13574bb6a09SIngo Molnar \ 136dfbf2897SSteven Rostedt if (unlikely(__ret_warn_once && !__warned)) { \ 13742f247c8SCesar Eduardo Barros __warned = true; \ 138dfbf2897SSteven Rostedt WARN_ON(1); \ 139dfbf2897SSteven Rostedt } \ 140684f9783SHerbert Xu unlikely(__ret_warn_once); \ 14174bb6a09SIngo Molnar }) 14219d43626SPeter Zijlstra #endif 14374bb6a09SIngo Molnar 14445e9c0deSArjan van de Ven #define WARN_ONCE(condition, format...) ({ \ 1457ccaba53SJan Beulich static bool __section(.data.unlikely) __warned; \ 14645e9c0deSArjan van de Ven int __ret_warn_once = !!(condition); \ 14745e9c0deSArjan van de Ven \ 148dfbf2897SSteven Rostedt if (unlikely(__ret_warn_once && !__warned)) { \ 14942f247c8SCesar Eduardo Barros __warned = true; \ 150dfbf2897SSteven Rostedt WARN(1, format); \ 151dfbf2897SSteven Rostedt } \ 15245e9c0deSArjan van de Ven unlikely(__ret_warn_once); \ 15345e9c0deSArjan van de Ven }) 15445e9c0deSArjan van de Ven 155b2be0527SBen Hutchings #define WARN_TAINT_ONCE(condition, taint, format...) ({ \ 1567ccaba53SJan Beulich static bool __section(.data.unlikely) __warned; \ 157b2be0527SBen Hutchings int __ret_warn_once = !!(condition); \ 158b2be0527SBen Hutchings \ 159dfbf2897SSteven Rostedt if (unlikely(__ret_warn_once && !__warned)) { \ 160b2be0527SBen Hutchings __warned = true; \ 161dfbf2897SSteven Rostedt WARN_TAINT(1, taint, format); \ 162dfbf2897SSteven Rostedt } \ 163b2be0527SBen Hutchings unlikely(__ret_warn_once); \ 164b2be0527SBen Hutchings }) 165b2be0527SBen Hutchings 166b607e70eSJosh Triplett #else /* !CONFIG_BUG */ 167b607e70eSJosh Triplett #ifndef HAVE_ARCH_BUG 168a4b5d580SJosh Triplett #define BUG() do {} while (1) 169b607e70eSJosh Triplett #endif 170b607e70eSJosh Triplett 171b607e70eSJosh Triplett #ifndef HAVE_ARCH_BUG_ON 1723c047057SArnd Bergmann #define BUG_ON(condition) do { if (condition) BUG(); } while (0) 173b607e70eSJosh Triplett #endif 174b607e70eSJosh Triplett 175b607e70eSJosh Triplett #ifndef HAVE_ARCH_WARN_ON 176b607e70eSJosh Triplett #define WARN_ON(condition) ({ \ 177b607e70eSJosh Triplett int __ret_warn_on = !!(condition); \ 178b607e70eSJosh Triplett unlikely(__ret_warn_on); \ 179b607e70eSJosh Triplett }) 180b607e70eSJosh Triplett #endif 181b607e70eSJosh Triplett 182b607e70eSJosh Triplett #ifndef WARN 183b607e70eSJosh Triplett #define WARN(condition, format...) ({ \ 184b607e70eSJosh Triplett int __ret_warn_on = !!(condition); \ 1854e50ebdeSJosh Triplett no_printk(format); \ 186b607e70eSJosh Triplett unlikely(__ret_warn_on); \ 187b607e70eSJosh Triplett }) 188b607e70eSJosh Triplett #endif 189b607e70eSJosh Triplett 190b607e70eSJosh Triplett #define WARN_ON_ONCE(condition) WARN_ON(condition) 191b607e70eSJosh Triplett #define WARN_ONCE(condition, format...) WARN(condition, format) 192b607e70eSJosh Triplett #define WARN_TAINT(condition, taint, format...) WARN(condition, format) 193b607e70eSJosh Triplett #define WARN_TAINT_ONCE(condition, taint, format...) WARN(condition, format) 194b607e70eSJosh Triplett 195b607e70eSJosh Triplett #endif 196b607e70eSJosh Triplett 1972092e6beSSteven Rostedt /* 1982092e6beSSteven Rostedt * WARN_ON_SMP() is for cases that the warning is either 1992092e6beSSteven Rostedt * meaningless for !SMP or may even cause failures. 2002092e6beSSteven Rostedt * This is usually used for cases that we have 2012092e6beSSteven Rostedt * WARN_ON(!spin_is_locked(&lock)) checks, as spin_is_locked() 2022092e6beSSteven Rostedt * returns 0 for uniprocessor settings. 2032092e6beSSteven Rostedt * It can also be used with values that are only defined 2042092e6beSSteven Rostedt * on SMP: 2052092e6beSSteven Rostedt * 2062092e6beSSteven Rostedt * struct foo { 2072092e6beSSteven Rostedt * [...] 2082092e6beSSteven Rostedt * #ifdef CONFIG_SMP 2092092e6beSSteven Rostedt * int bar; 2102092e6beSSteven Rostedt * #endif 2112092e6beSSteven Rostedt * }; 2122092e6beSSteven Rostedt * 2132092e6beSSteven Rostedt * void func(struct foo *zoot) 2142092e6beSSteven Rostedt * { 2152092e6beSSteven Rostedt * WARN_ON_SMP(!zoot->bar); 2162092e6beSSteven Rostedt * 2172092e6beSSteven Rostedt * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(), 2182092e6beSSteven Rostedt * and should be a nop and return false for uniprocessor. 2192092e6beSSteven Rostedt * 2202092e6beSSteven Rostedt * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set 2212092e6beSSteven Rostedt * and x is true. 2222092e6beSSteven Rostedt */ 2238eb94f80SIngo Molnar #ifdef CONFIG_SMP 2248eb94f80SIngo Molnar # define WARN_ON_SMP(x) WARN_ON(x) 2258eb94f80SIngo Molnar #else 226ccd0d44fSSteven Rostedt /* 227ccd0d44fSSteven Rostedt * Use of ({0;}) because WARN_ON_SMP(x) may be used either as 228ccd0d44fSSteven Rostedt * a stand alone line statement or as a condition in an if () 229ccd0d44fSSteven Rostedt * statement. 230ccd0d44fSSteven Rostedt * A simple "0" would cause gcc to give a "statement has no effect" 231ccd0d44fSSteven Rostedt * warning. 232ccd0d44fSSteven Rostedt */ 2332092e6beSSteven Rostedt # define WARN_ON_SMP(x) ({0;}) 2348eb94f80SIngo Molnar #endif 2358eb94f80SIngo Molnar 2362603efa3SPaul Mundt #endif /* __ASSEMBLY__ */ 2372603efa3SPaul Mundt 2381da177e4SLinus Torvalds #endif 239