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 20ffb61c63SIngo Molnar #ifdef CONFIG_BUG 21ffb61c63SIngo Molnar 22f81f8ad5SNadav Amit #ifdef CONFIG_GENERIC_BUG 23ffb61c63SIngo Molnar 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; 38f81f8ad5SNadav Amit }; 39ffb61c63SIngo Molnar #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__); \ 55173a3efdSArnd Bergmann barrier_before_unreachable(); \ 561da177e4SLinus Torvalds panic("BUG!"); \ 571da177e4SLinus Torvalds } while (0) 581da177e4SLinus Torvalds #endif 591da177e4SLinus Torvalds 601da177e4SLinus Torvalds #ifndef HAVE_ARCH_BUG_ON 612a41de48SAlexey Dobriyan #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0) 621da177e4SLinus Torvalds #endif 631da177e4SLinus Torvalds 6419d43626SPeter Zijlstra #ifdef __WARN_FLAGS 6519d43626SPeter Zijlstra #define __WARN_TAINT(taint) __WARN_FLAGS(BUGFLAG_TAINT(taint)) 6619d43626SPeter Zijlstra #define __WARN_ONCE_TAINT(taint) __WARN_FLAGS(BUGFLAG_ONCE|BUGFLAG_TAINT(taint)) 6719d43626SPeter Zijlstra 6819d43626SPeter Zijlstra #define WARN_ON_ONCE(condition) ({ \ 6919d43626SPeter Zijlstra int __ret_warn_on = !!(condition); \ 7019d43626SPeter Zijlstra if (unlikely(__ret_warn_on)) \ 7119d43626SPeter Zijlstra __WARN_ONCE_TAINT(TAINT_WARN); \ 7219d43626SPeter Zijlstra unlikely(__ret_warn_on); \ 7319d43626SPeter Zijlstra }) 7419d43626SPeter Zijlstra #endif 7519d43626SPeter Zijlstra 76af9379c7SDavid Brownell /* 77af9379c7SDavid Brownell * WARN(), WARN_ON(), WARN_ON_ONCE, and so on can be used to report 7896c6a32cSDmitry Vyukov * significant kernel issues that need prompt attention if they should ever 7996c6a32cSDmitry Vyukov * appear at runtime. 8096c6a32cSDmitry Vyukov * 8196c6a32cSDmitry Vyukov * Do not use these macros when checking for invalid external inputs 8296c6a32cSDmitry Vyukov * (e.g. invalid system call arguments, or invalid data coming from 8396c6a32cSDmitry Vyukov * network/devices), and on transient conditions like ENOMEM or EAGAIN. 8496c6a32cSDmitry Vyukov * These macros should be used for recoverable kernel issues only. 8596c6a32cSDmitry Vyukov * For invalid external inputs, transient conditions, etc use 8696c6a32cSDmitry Vyukov * pr_err[_once/_ratelimited]() followed by dump_stack(), if necessary. 8796c6a32cSDmitry Vyukov * Do not include "BUG"/"WARNING" in format strings manually to make these 8896c6a32cSDmitry Vyukov * conditions distinguishable from kernel issues. 8996c6a32cSDmitry Vyukov * 9096c6a32cSDmitry Vyukov * Use the versions with printk format strings to provide better diagnostics. 91af9379c7SDavid Brownell */ 92b2be0527SBen Hutchings #ifndef __WARN_TAINT 93b9075fa9SJoe Perches extern __printf(3, 4) 94b9075fa9SJoe Perches void warn_slowpath_fmt(const char *file, const int line, 95b9075fa9SJoe Perches const char *fmt, ...); 96b9075fa9SJoe Perches extern __printf(4, 5) 97b9075fa9SJoe Perches void warn_slowpath_fmt_taint(const char *file, const int line, unsigned taint, 98b9075fa9SJoe Perches const char *fmt, ...); 9957adc4d2SAndi Kleen extern void warn_slowpath_null(const char *file, const int line); 10079b4cc5eSArjan van de Ven #define WANT_WARN_ON_SLOWPATH 10157adc4d2SAndi Kleen #define __WARN() warn_slowpath_null(__FILE__, __LINE__) 10257adc4d2SAndi Kleen #define __WARN_printf(arg...) warn_slowpath_fmt(__FILE__, __LINE__, arg) 103b2be0527SBen Hutchings #define __WARN_printf_taint(taint, arg...) \ 104b2be0527SBen Hutchings warn_slowpath_fmt_taint(__FILE__, __LINE__, taint, arg) 105a8f18b90SArjan van de Ven #else 106a7bed27aSKees Cook extern __printf(1, 2) void __warn_printk(const char *fmt, ...); 1076b15f678SDrew Davenport #define __WARN() do { \ 1086b15f678SDrew Davenport printk(KERN_WARNING CUT_HERE); __WARN_TAINT(TAINT_WARN); \ 1096b15f678SDrew Davenport } while (0) 1106b15f678SDrew Davenport #define __WARN_printf(arg...) __WARN_printf_taint(TAINT_WARN, arg) 111b2be0527SBen Hutchings #define __WARN_printf_taint(taint, arg...) \ 112a7bed27aSKees Cook do { __warn_printk(arg); __WARN_TAINT(taint); } while (0) 1133a6a62f9SOlof Johansson #endif 1143a6a62f9SOlof Johansson 1152553b67aSJosh Poimboeuf /* used internally by panic.c */ 1162553b67aSJosh Poimboeuf struct warn_args; 1170b396923SIan Abbott struct pt_regs; 1182553b67aSJosh Poimboeuf 1192553b67aSJosh Poimboeuf void __warn(const char *file, int line, void *caller, unsigned taint, 1202553b67aSJosh Poimboeuf struct pt_regs *regs, struct warn_args *args); 1212553b67aSJosh Poimboeuf 1223a6a62f9SOlof Johansson #ifndef WARN_ON 1233a6a62f9SOlof Johansson #define WARN_ON(condition) ({ \ 1243a6a62f9SOlof Johansson int __ret_warn_on = !!(condition); \ 1253a6a62f9SOlof Johansson if (unlikely(__ret_warn_on)) \ 1263a6a62f9SOlof Johansson __WARN(); \ 127684f9783SHerbert Xu unlikely(__ret_warn_on); \ 128684f9783SHerbert Xu }) 1291da177e4SLinus Torvalds #endif 1301da177e4SLinus Torvalds 131a8f18b90SArjan van de Ven #ifndef WARN 132a8f18b90SArjan van de Ven #define WARN(condition, format...) ({ \ 133a8f18b90SArjan van de Ven int __ret_warn_on = !!(condition); \ 134a8f18b90SArjan van de Ven if (unlikely(__ret_warn_on)) \ 135a8f18b90SArjan van de Ven __WARN_printf(format); \ 136a8f18b90SArjan van de Ven unlikely(__ret_warn_on); \ 137a8f18b90SArjan van de Ven }) 138a8f18b90SArjan van de Ven #endif 139a8f18b90SArjan van de Ven 140b2be0527SBen Hutchings #define WARN_TAINT(condition, taint, format...) ({ \ 141b2be0527SBen Hutchings int __ret_warn_on = !!(condition); \ 142b2be0527SBen Hutchings if (unlikely(__ret_warn_on)) \ 143b2be0527SBen Hutchings __WARN_printf_taint(taint, format); \ 144b2be0527SBen Hutchings unlikely(__ret_warn_on); \ 145b2be0527SBen Hutchings }) 146b2be0527SBen Hutchings 14719d43626SPeter Zijlstra #ifndef WARN_ON_ONCE 148684f9783SHerbert Xu #define WARN_ON_ONCE(condition) ({ \ 149b1fca27dSAndi Kleen static bool __section(.data.once) __warned; \ 1508d4fbcfbSLinus Torvalds int __ret_warn_once = !!(condition); \ 15174bb6a09SIngo Molnar \ 152dfbf2897SSteven Rostedt if (unlikely(__ret_warn_once && !__warned)) { \ 15342f247c8SCesar Eduardo Barros __warned = true; \ 154dfbf2897SSteven Rostedt WARN_ON(1); \ 155dfbf2897SSteven Rostedt } \ 156684f9783SHerbert Xu unlikely(__ret_warn_once); \ 15774bb6a09SIngo Molnar }) 15819d43626SPeter Zijlstra #endif 15974bb6a09SIngo Molnar 16045e9c0deSArjan van de Ven #define WARN_ONCE(condition, format...) ({ \ 161b1fca27dSAndi Kleen static bool __section(.data.once) __warned; \ 16245e9c0deSArjan van de Ven int __ret_warn_once = !!(condition); \ 16345e9c0deSArjan van de Ven \ 164dfbf2897SSteven Rostedt if (unlikely(__ret_warn_once && !__warned)) { \ 16542f247c8SCesar Eduardo Barros __warned = true; \ 166dfbf2897SSteven Rostedt WARN(1, format); \ 167dfbf2897SSteven Rostedt } \ 16845e9c0deSArjan van de Ven unlikely(__ret_warn_once); \ 16945e9c0deSArjan van de Ven }) 17045e9c0deSArjan van de Ven 171b2be0527SBen Hutchings #define WARN_TAINT_ONCE(condition, taint, format...) ({ \ 172b1fca27dSAndi Kleen static bool __section(.data.once) __warned; \ 173b2be0527SBen Hutchings int __ret_warn_once = !!(condition); \ 174b2be0527SBen Hutchings \ 175dfbf2897SSteven Rostedt if (unlikely(__ret_warn_once && !__warned)) { \ 176b2be0527SBen Hutchings __warned = true; \ 177dfbf2897SSteven Rostedt WARN_TAINT(1, taint, format); \ 178dfbf2897SSteven Rostedt } \ 179b2be0527SBen Hutchings unlikely(__ret_warn_once); \ 180b2be0527SBen Hutchings }) 181b2be0527SBen Hutchings 182b607e70eSJosh Triplett #else /* !CONFIG_BUG */ 183b607e70eSJosh Triplett #ifndef HAVE_ARCH_BUG 184a4b5d580SJosh Triplett #define BUG() do {} while (1) 185b607e70eSJosh Triplett #endif 186b607e70eSJosh Triplett 187b607e70eSJosh Triplett #ifndef HAVE_ARCH_BUG_ON 1889b87647cSDenis Efremov #define BUG_ON(condition) do { if (unlikely(condition)) BUG(); } while (0) 189b607e70eSJosh Triplett #endif 190b607e70eSJosh Triplett 191b607e70eSJosh Triplett #ifndef HAVE_ARCH_WARN_ON 192b607e70eSJosh Triplett #define WARN_ON(condition) ({ \ 193b607e70eSJosh Triplett int __ret_warn_on = !!(condition); \ 194b607e70eSJosh Triplett unlikely(__ret_warn_on); \ 195b607e70eSJosh Triplett }) 196b607e70eSJosh Triplett #endif 197b607e70eSJosh Triplett 198b607e70eSJosh Triplett #ifndef WARN 199b607e70eSJosh Triplett #define WARN(condition, format...) ({ \ 200b607e70eSJosh Triplett int __ret_warn_on = !!(condition); \ 2014e50ebdeSJosh Triplett no_printk(format); \ 202b607e70eSJosh Triplett unlikely(__ret_warn_on); \ 203b607e70eSJosh Triplett }) 204b607e70eSJosh Triplett #endif 205b607e70eSJosh Triplett 206b607e70eSJosh Triplett #define WARN_ON_ONCE(condition) WARN_ON(condition) 207b607e70eSJosh Triplett #define WARN_ONCE(condition, format...) WARN(condition, format) 208b607e70eSJosh Triplett #define WARN_TAINT(condition, taint, format...) WARN(condition, format) 209b607e70eSJosh Triplett #define WARN_TAINT_ONCE(condition, taint, format...) WARN(condition, format) 210b607e70eSJosh Triplett 211b607e70eSJosh Triplett #endif 212b607e70eSJosh Triplett 2132092e6beSSteven Rostedt /* 2142092e6beSSteven Rostedt * WARN_ON_SMP() is for cases that the warning is either 2152092e6beSSteven Rostedt * meaningless for !SMP or may even cause failures. 2162092e6beSSteven Rostedt * It can also be used with values that are only defined 2172092e6beSSteven Rostedt * on SMP: 2182092e6beSSteven Rostedt * 2192092e6beSSteven Rostedt * struct foo { 2202092e6beSSteven Rostedt * [...] 2212092e6beSSteven Rostedt * #ifdef CONFIG_SMP 2222092e6beSSteven Rostedt * int bar; 2232092e6beSSteven Rostedt * #endif 2242092e6beSSteven Rostedt * }; 2252092e6beSSteven Rostedt * 2262092e6beSSteven Rostedt * void func(struct foo *zoot) 2272092e6beSSteven Rostedt * { 2282092e6beSSteven Rostedt * WARN_ON_SMP(!zoot->bar); 2292092e6beSSteven Rostedt * 2302092e6beSSteven Rostedt * For CONFIG_SMP, WARN_ON_SMP() should act the same as WARN_ON(), 2312092e6beSSteven Rostedt * and should be a nop and return false for uniprocessor. 2322092e6beSSteven Rostedt * 2332092e6beSSteven Rostedt * if (WARN_ON_SMP(x)) returns true only when CONFIG_SMP is set 2342092e6beSSteven Rostedt * and x is true. 2352092e6beSSteven Rostedt */ 2368eb94f80SIngo Molnar #ifdef CONFIG_SMP 2378eb94f80SIngo Molnar # define WARN_ON_SMP(x) WARN_ON(x) 2388eb94f80SIngo Molnar #else 239ccd0d44fSSteven Rostedt /* 240ccd0d44fSSteven Rostedt * Use of ({0;}) because WARN_ON_SMP(x) may be used either as 241ccd0d44fSSteven Rostedt * a stand alone line statement or as a condition in an if () 242ccd0d44fSSteven Rostedt * statement. 243ccd0d44fSSteven Rostedt * A simple "0" would cause gcc to give a "statement has no effect" 244ccd0d44fSSteven Rostedt * warning. 245ccd0d44fSSteven Rostedt */ 2462092e6beSSteven Rostedt # define WARN_ON_SMP(x) ({0;}) 2478eb94f80SIngo Molnar #endif 2488eb94f80SIngo Molnar 2492603efa3SPaul Mundt #endif /* __ASSEMBLY__ */ 2502603efa3SPaul Mundt 2511da177e4SLinus Torvalds #endif 252