blob: 573c5a18908fd53970fefea291805c500fd1d7f9 [file] [log] [blame]
Robert P. J. Day94f582f2007-10-16 23:26:11 -07001#ifndef __LINUX_COMPILER_H
2#error "Please don't include <linux/compiler-gcc.h> directly, include <linux/compiler.h> instead."
3#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07004
5/*
6 * Common definitions for all gcc versions go here.
7 */
Joe Perchesf6d133f82015-06-25 15:01:00 -07008#define GCC_VERSION (__GNUC__ * 10000 \
9 + __GNUC_MINOR__ * 100 \
10 + __GNUC_PATCHLEVEL__)
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
Linus Torvalds1da177e2005-04-16 15:20:36 -070012/* Optimization barrier */
Daniel Borkmann7829fb02015-04-30 04:13:52 +020013
Linus Torvalds1da177e2005-04-16 15:20:36 -070014/* The "volatile" is due to gcc bugs */
15#define barrier() __asm__ __volatile__("": : :"memory")
Daniel Borkmann7829fb02015-04-30 04:13:52 +020016/*
17 * This version is i.e. to prevent dead stores elimination on @ptr
18 * where gcc and llvm may behave differently when otherwise using
19 * normal barrier(): while gcc behavior gets along with a normal
20 * barrier(), llvm needs an explicit input variable to be assumed
21 * clobbered. The issue is as follows: while the inline asm might
22 * access any memory it wants, the compiler could have fit all of
23 * @ptr into memory registers instead, and since @ptr never escaped
24 * from that, it proofed that the inline asm wasn't touching any of
25 * it. This version works well with both compilers, i.e. we're telling
26 * the compiler that the inline asm absolutely may see the contents
27 * of @ptr. See also: https://llvm.org/bugs/show_bug.cgi?id=15495
28 */
29#define barrier_data(ptr) __asm__ __volatile__("": :"r"(ptr) :"memory")
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Anton Blanchardc8d52462006-01-10 18:21:20 +110031/*
Andi Kleen85c210e2009-01-09 16:40:53 -080032 * This macro obfuscates arithmetic on a variable address so that gcc
33 * shouldn't recognize the original var, and make assumptions about it.
34 *
35 * This is needed because the C standard makes it undefined to do
36 * pointer arithmetic on "objects" outside their boundaries and the
37 * gcc optimizers assume this is the case. In particular they
38 * assume such arithmetic does not wrap.
39 *
40 * A miscompilation has been observed because of this on PPC.
41 * To work around it we hide the relationship of the pointer and the object
42 * using this macro.
43 *
Anton Blanchardc8d52462006-01-10 18:21:20 +110044 * Versions of the ppc64 compiler before 4.1 had a bug where use of
45 * RELOC_HIDE could trash r30. The bug can be worked around by changing
46 * the inline assembly constraint from =g to =r, in this particular
47 * case either is valid.
48 */
Joe Perchesf6d133f82015-06-25 15:01:00 -070049#define RELOC_HIDE(ptr, off) \
50({ \
51 unsigned long __ptr; \
52 __asm__ ("" : "=r"(__ptr) : "0"(ptr)); \
53 (typeof(ptr)) (__ptr + (off)); \
54})
Andrew Mortona1365642006-01-08 01:04:09 -080055
Cesar Eduardo Barrosfe8c8a12013-11-25 22:00:41 -020056/* Make the optimizer believe the variable can be manipulated arbitrarily. */
Joe Perchesf6d133f82015-06-25 15:01:00 -070057#define OPTIMIZER_HIDE_VAR(var) \
58 __asm__ ("" : "=r" (var) : "0" (var))
Cesar Eduardo Barrosfe8c8a12013-11-25 22:00:41 -020059
KOSAKI Motohiro5bd7e6a2011-05-24 17:13:17 -070060#ifdef __CHECKER__
Joe Perchesf6d133f82015-06-25 15:01:00 -070061#define __must_be_array(a) 0
KOSAKI Motohiro5bd7e6a2011-05-24 17:13:17 -070062#else
Rusty Russellc5e631cf2007-05-06 14:51:05 -070063/* &a[0] degrades to a pointer: a different type from an array */
Joe Perchesf6d133f82015-06-25 15:01:00 -070064#define __must_be_array(a) BUILD_BUG_ON_ZERO(__same_type((a), &(a)[0]))
KOSAKI Motohiro5bd7e6a2011-05-24 17:13:17 -070065#endif
Andrew Mortona1365642006-01-08 01:04:09 -080066
Ingo Molnar60a3cdd2008-03-03 12:38:52 +010067/*
Ingo Molnarae3a0062008-04-30 00:15:31 +020068 * Force always-inline if the user requests it so via the .config,
69 * or if gcc is too old:
Ingo Molnar60a3cdd2008-03-03 12:38:52 +010070 */
Joe Perchesf6d133f82015-06-25 15:01:00 -070071#if !defined(CONFIG_ARCH_SUPPORTS_OPTIMIZED_INLINING) || \
Ingo Molnarae3a0062008-04-30 00:15:31 +020072 !defined(CONFIG_OPTIMIZE_INLINING) || (__GNUC__ < 4)
Joe Perchesf6d133f82015-06-25 15:01:00 -070073#define inline inline __attribute__((always_inline)) notrace
74#define __inline__ __inline__ __attribute__((always_inline)) notrace
75#define __inline __inline __attribute__((always_inline)) notrace
Steven Rostedt45959ee2011-12-12 15:22:41 -050076#else
77/* A lot of inline functions can cause havoc with function tracing */
Joe Perchesf6d133f82015-06-25 15:01:00 -070078#define inline inline notrace
79#define __inline__ __inline__ notrace
80#define __inline __inline notrace
Ingo Molnar60a3cdd2008-03-03 12:38:52 +010081#endif
82
Joe Perchesf6d133f82015-06-25 15:01:00 -070083#define __always_inline inline __attribute__((always_inline))
84#define noinline __attribute__((noinline))
85
86#define __deprecated __attribute__((deprecated))
87#define __packed __attribute__((packed))
88#define __weak __attribute__((weak))
89#define __alias(symbol) __attribute__((alias(#symbol)))
Uwe Kleine-König446c92b2009-03-12 18:03:16 +010090
91/*
Joe Perchesf6d133f82015-06-25 15:01:00 -070092 * it doesn't make sense on ARM (currently the only user of __naked)
93 * to trace naked functions because then mcount is called without
94 * stack and frame pointer being set up and there is no chance to
95 * restore the lr register to the value before mcount was called.
Mikael Pettersson9c695202010-06-29 15:05:25 -070096 *
Joe Perchesf6d133f82015-06-25 15:01:00 -070097 * The asm() bodies of naked functions often depend on standard calling
98 * conventions, therefore they must be noinline and noclone.
99 *
100 * GCC 4.[56] currently fail to enforce this, so we must do so ourselves.
101 * See GCC PR44290.
Uwe Kleine-König446c92b2009-03-12 18:03:16 +0100102 */
Joe Perchesf6d133f82015-06-25 15:01:00 -0700103#define __naked __attribute__((naked)) noinline __noclone notrace
Uwe Kleine-König446c92b2009-03-12 18:03:16 +0100104
Joe Perchesf6d133f82015-06-25 15:01:00 -0700105#define __noreturn __attribute__((noreturn))
Ralf Baechlee8c44312007-10-18 03:07:07 -0700106
107/*
108 * From the GCC manual:
109 *
110 * Many functions have no effects except the return value and their
111 * return value depends only on the parameters and/or global
112 * variables. Such a function can be subject to common subexpression
113 * elimination and loop optimization just as an arithmetic operator
114 * would be.
115 * [...]
116 */
Joe Perchesf6d133f82015-06-25 15:01:00 -0700117#define __pure __attribute__((pure))
118#define __aligned(x) __attribute__((aligned(x)))
119#define __printf(a, b) __attribute__((format(printf, a, b)))
120#define __scanf(a, b) __attribute__((format(scanf, a, b)))
121#define __attribute_const__ __attribute__((__const__))
122#define __maybe_unused __attribute__((unused))
123#define __always_unused __attribute__((unused))
Linus Torvaldsf153b822009-01-02 09:23:03 -0800124
Joe Perchescb984d12015-06-25 15:01:02 -0700125/* gcc version specific checks */
126
127#if GCC_VERSION < 30200
128# error Sorry, your compiler is too old - please upgrade it.
129#endif
130
131#if GCC_VERSION < 30300
132# define __used __attribute__((__unused__))
133#else
134# define __used __attribute__((__used__))
135#endif
136
137#ifdef CONFIG_GCOV_KERNEL
138# if GCC_VERSION < 30400
139# error "GCOV profiling support for gcc versions below 3.4 not included"
140# endif /* __GNUC_MINOR__ */
141#endif /* CONFIG_GCOV_KERNEL */
142
143#if GCC_VERSION >= 30400
144#define __must_check __attribute__((warn_unused_result))
Rasmus Villemoesd64e85d2016-05-19 17:10:52 -0700145#define __malloc __attribute__((__malloc__))
Joe Perchescb984d12015-06-25 15:01:02 -0700146#endif
147
148#if GCC_VERSION >= 40000
149
150/* GCC 4.1.[01] miscompiles __weak */
151#ifdef __KERNEL__
152# if GCC_VERSION >= 40100 && GCC_VERSION <= 40101
153# error Your version of gcc miscompiles the __weak directive
154# endif
155#endif
156
157#define __used __attribute__((__used__))
158#define __compiler_offsetof(a, b) \
159 __builtin_offsetof(a, b)
160
Josh Poimboeuf0d025d22016-08-30 08:04:16 -0500161#if GCC_VERSION >= 40100
Joe Perchescb984d12015-06-25 15:01:02 -0700162# define __compiletime_object_size(obj) __builtin_object_size(obj, 0)
163#endif
164
165#if GCC_VERSION >= 40300
166/* Mark functions as cold. gcc will assume any path leading to a call
167 * to them will be unlikely. This means a lot of manual unlikely()s
168 * are unnecessary now for any paths leading to the usual suspects
169 * like BUG(), printk(), panic() etc. [but let's keep them for now for
170 * older compilers]
171 *
172 * Early snapshots of gcc 4.3 don't support this and we can't detect this
173 * in the preprocessor, but we can live with this because they're unreleased.
174 * Maketime probing would be overkill here.
175 *
176 * gcc also has a __attribute__((__hot__)) to move hot functions into
177 * a special section, but I don't see any sense in this right now in
178 * the kernel context
179 */
180#define __cold __attribute__((__cold__))
181
182#define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __COUNTER__)
183
184#ifndef __CHECKER__
185# define __compiletime_warning(message) __attribute__((warning(message)))
186# define __compiletime_error(message) __attribute__((error(message)))
187#endif /* __CHECKER__ */
188#endif /* GCC_VERSION >= 40300 */
189
190#if GCC_VERSION >= 40500
191/*
192 * Mark a position in code as unreachable. This can be used to
193 * suppress control flow warnings after asm blocks that transfer
194 * control elsewhere.
195 *
196 * Early snapshots of gcc 4.5 don't support this and we can't detect
197 * this in the preprocessor, but we can live with this because they're
198 * unreleased. Really, we need to have autoconf for the kernel.
199 */
200#define unreachable() __builtin_unreachable()
201
202/* Mark a function definition as prohibited from being cloned. */
Paolo Bonzini95272c22016-03-31 09:38:51 +0200203#define __noclone __attribute__((__noclone__, __optimize__("no-tracer")))
Joe Perchescb984d12015-06-25 15:01:02 -0700204
205#endif /* GCC_VERSION >= 40500 */
206
207#if GCC_VERSION >= 40600
208/*
Andrew Morton9add8502015-11-06 16:30:09 -0800209 * When used with Link Time Optimization, gcc can optimize away C functions or
210 * variables which are referenced only from assembly code. __visible tells the
211 * optimizer that something else uses this function or variable, thus preventing
212 * this.
Joe Perchescb984d12015-06-25 15:01:02 -0700213 */
214#define __visible __attribute__((externally_visible))
215#endif
216
Rasmus Villemoesa744fd12015-11-05 18:45:02 -0800217
Rasmus Villemoes8748dd52015-11-05 18:45:05 -0800218#if GCC_VERSION >= 40900 && !defined(__CHECKER__)
Rasmus Villemoesa744fd12015-11-05 18:45:02 -0800219/*
220 * __assume_aligned(n, k): Tell the optimizer that the returned
221 * pointer can be assumed to be k modulo n. The second argument is
222 * optional (default 0), so we use a variadic macro to make the
223 * shorthand.
224 *
225 * Beware: Do not apply this to functions which may return
226 * ERR_PTRs. Also, it is probably unwise to apply it to functions
227 * returning extra information in the low bits (but in that case the
228 * compiler should see some alignment anyway, when the return value is
229 * massaged by 'flags = ptr & 3; ptr &= ~3;').
230 */
231#define __assume_aligned(a, ...) __attribute__((__assume_aligned__(a, ## __VA_ARGS__)))
232#endif
233
Joe Perchescb984d12015-06-25 15:01:02 -0700234/*
235 * GCC 'asm goto' miscompiles certain code sequences:
236 *
237 * http://gcc.gnu.org/bugzilla/show_bug.cgi?id=58670
238 *
239 * Work it around via a compiler barrier quirk suggested by Jakub Jelinek.
240 *
241 * (asm goto is automatically volatile - the naming reflects this.)
242 */
243#define asm_volatile_goto(x...) do { asm goto(x); asm (""); } while (0)
244
Johannes Berg101b29a2016-08-25 15:16:45 -0700245/*
246 * sparse (__CHECKER__) pretends to be gcc, but can't do constant
247 * folding in __builtin_bswap*() (yet), so don't set these for it.
248 */
249#if defined(CONFIG_ARCH_USE_BUILTIN_BSWAP) && !defined(__CHECKER__)
Joe Perchescb984d12015-06-25 15:01:02 -0700250#if GCC_VERSION >= 40400
251#define __HAVE_BUILTIN_BSWAP32__
252#define __HAVE_BUILTIN_BSWAP64__
253#endif
Josh Poimboeuf8634de62016-05-06 09:22:25 -0500254#if GCC_VERSION >= 40800
Joe Perchescb984d12015-06-25 15:01:02 -0700255#define __HAVE_BUILTIN_BSWAP16__
256#endif
Johannes Berg101b29a2016-08-25 15:16:45 -0700257#endif /* CONFIG_ARCH_USE_BUILTIN_BSWAP && !__CHECKER__ */
Joe Perchescb984d12015-06-25 15:01:02 -0700258
259#if GCC_VERSION >= 50000
260#define KASAN_ABI_VERSION 4
261#elif GCC_VERSION >= 40902
262#define KASAN_ABI_VERSION 3
263#endif
264
Andrey Ryabinind9764412015-10-19 11:37:17 +0300265#if GCC_VERSION >= 40902
266/*
267 * Tell the compiler that address safety instrumentation (KASAN)
268 * should not be applied to that function.
269 * Conflicts with inlining: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67368
270 */
271#define __no_sanitize_address __attribute__((no_sanitize_address))
272#endif
273
Joe Perchescb984d12015-06-25 15:01:02 -0700274#endif /* gcc version >= 40000 specific checks */
Mikael Pettersson9c695202010-06-29 15:05:25 -0700275
276#if !defined(__noclone)
277#define __noclone /* not needed */
278#endif
Borislav Petkovc837fb32011-03-22 16:33:55 -0700279
Andrey Ryabinind9764412015-10-19 11:37:17 +0300280#if !defined(__no_sanitize_address)
281#define __no_sanitize_address
282#endif
283
Borislav Petkovc837fb32011-03-22 16:33:55 -0700284/*
285 * A trick to suppress uninitialized variable warning without generating any
286 * code
287 */
288#define uninitialized_var(x) x = x