blob: 7f4818673c41f80d391faee5ea1667435d7bbf84 [file] [log] [blame]
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -08001#ifndef _LINUX_BUG_H
2#define _LINUX_BUG_H
3
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -08004#include <asm/bug.h>
Daniel Santosa3ccc492013-02-21 16:41:52 -08005#include <linux/compiler.h>
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -08006
7enum bug_trap_type {
8 BUG_TRAP_TYPE_NONE = 0,
9 BUG_TRAP_TYPE_WARN = 1,
10 BUG_TRAP_TYPE_BUG = 2,
11};
12
Heiko Carstens608e2612007-07-15 23:41:39 -070013struct pt_regs;
14
Paul Gortmaker35edd912011-11-16 23:51:05 -050015#ifdef __CHECKER__
Daniel Santosca623c92013-02-21 16:41:44 -080016#define BUILD_BUG_ON_NOT_POWER_OF_2(n) (0)
Paul Gortmaker35edd912011-11-16 23:51:05 -050017#define BUILD_BUG_ON_ZERO(e) (0)
18#define BUILD_BUG_ON_NULL(e) ((void*)0)
Tushar Beherac5782e92012-11-26 16:29:38 -080019#define BUILD_BUG_ON_INVALID(e) (0)
Daniel Santos9a8ab1c2013-02-21 16:41:55 -080020#define BUILD_BUG_ON_MSG(cond, msg) (0)
Daniel Santosca623c92013-02-21 16:41:44 -080021#define BUILD_BUG_ON(condition) (0)
Paul Gortmaker35edd912011-11-16 23:51:05 -050022#define BUILD_BUG() (0)
23#else /* __CHECKER__ */
24
25/* Force a compilation error if a constant expression is not a power of 2 */
26#define BUILD_BUG_ON_NOT_POWER_OF_2(n) \
27 BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
28
29/* Force a compilation error if condition is true, but also produce a
30 result (of value 0 and type size_t), so the expression can be used
31 e.g. in a structure initializer (or where-ever else comma expressions
32 aren't permitted). */
33#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
34#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
35
Konstantin Khlebnikovbaf05aa2012-05-29 15:06:27 -070036/*
37 * BUILD_BUG_ON_INVALID() permits the compiler to check the validity of the
38 * expression but avoids the generation of any code, even if that expression
39 * has side-effects.
40 */
41#define BUILD_BUG_ON_INVALID(e) ((void)(sizeof((__force long)(e))))
42
Paul Gortmaker35edd912011-11-16 23:51:05 -050043/**
Daniel Santos9a8ab1c2013-02-21 16:41:55 -080044 * BUILD_BUG_ON_MSG - break compile if a condition is true & emit supplied
45 * error message.
46 * @condition: the condition which the compiler should know is false.
47 *
48 * See BUILD_BUG_ON for description.
49 */
50#define BUILD_BUG_ON_MSG(cond, msg) compiletime_assert(!(cond), msg)
51
52/**
Paul Gortmaker35edd912011-11-16 23:51:05 -050053 * BUILD_BUG_ON - break compile if a condition is true.
54 * @condition: the condition which the compiler should know is false.
55 *
56 * If you have some code which relies on certain constants being equal, or
Daniel Santosa3ccc492013-02-21 16:41:52 -080057 * some other compile-time-evaluated condition, you should use BUILD_BUG_ON to
Paul Gortmaker35edd912011-11-16 23:51:05 -050058 * detect if someone changes it.
59 *
Daniel Santosa3ccc492013-02-21 16:41:52 -080060 * The implementation uses gcc's reluctance to create a negative array, but gcc
61 * (as of 4.4) only emits that error for obvious cases (e.g. not arguments to
62 * inline functions). Luckily, in 4.3 they added the "error" function
63 * attribute just for this type of case. Thus, we use a negative sized array
64 * (should always create an error on gcc versions older than 4.4) and then call
65 * an undefined function with the error attribute (should always create an
66 * error on gcc 4.3 and later). If for some reason, neither creates a
67 * compile-time error, we'll still have a link-time error, which is harder to
68 * track down.
Paul Gortmaker35edd912011-11-16 23:51:05 -050069 */
70#ifndef __OPTIMIZE__
71#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
72#else
Daniel Santos9a8ab1c2013-02-21 16:41:55 -080073#define BUILD_BUG_ON(condition) \
74 BUILD_BUG_ON_MSG(condition, "BUILD_BUG_ON failed: " #condition)
Paul Gortmaker35edd912011-11-16 23:51:05 -050075#endif
76
77/**
78 * BUILD_BUG - break compile if used.
79 *
80 * If you have some code that you expect the compiler to eliminate at
81 * build time, you should use BUILD_BUG to detect if it is
82 * unexpectedly used.
83 */
Daniel Santos9a8ab1c2013-02-21 16:41:55 -080084#define BUILD_BUG() BUILD_BUG_ON_MSG(1, "BUILD_BUG failed")
Paul Gortmaker35edd912011-11-16 23:51:05 -050085
86#endif /* __CHECKER__ */
87
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080088#ifdef CONFIG_GENERIC_BUG
89#include <asm-generic/bug.h>
90
91static inline int is_warning_bug(const struct bug_entry *bug)
92{
93 return bug->flags & BUGFLAG_WARNING;
94}
95
96const struct bug_entry *find_bug(unsigned long bugaddr);
97
Heiko Carstens608e2612007-07-15 23:41:39 -070098enum bug_trap_type report_bug(unsigned long bug_addr, struct pt_regs *regs);
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080099
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800100/* These are defined by the architecture */
101int is_valid_bugaddr(unsigned long addr);
102
103#else /* !CONFIG_GENERIC_BUG */
104
Heiko Carstens608e2612007-07-15 23:41:39 -0700105static inline enum bug_trap_type report_bug(unsigned long bug_addr,
106 struct pt_regs *regs)
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800107{
108 return BUG_TRAP_TYPE_BUG;
109}
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800110
111#endif /* CONFIG_GENERIC_BUG */
112#endif /* _LINUX_BUG_H */