blob: cf0fa5d86059b6672773025b625027f6301074c1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __LINUX_COMPILER_H
2#define __LINUX_COMPILER_H
3
4#ifndef __ASSEMBLY__
5
6#ifdef __CHECKER__
7# define __user __attribute__((noderef, address_space(1)))
Rusty Russelle0fdb0e2009-10-29 22:34:15 +09008# define __kernel __attribute__((address_space(0)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07009# define __safe __attribute__((safe))
10# define __force __attribute__((force))
11# define __nocast __attribute__((nocast))
12# define __iomem __attribute__((noderef, address_space(2)))
Josh Triplett85290912012-12-17 16:03:24 -080013# define __must_hold(x) __attribute__((context(x,1,1)))
Josh Triplettc902e0a2006-09-30 23:28:21 -070014# define __acquires(x) __attribute__((context(x,0,1)))
15# define __releases(x) __attribute__((context(x,1,0)))
16# define __acquire(x) __context__(x,1)
17# define __release(x) __context__(x,-1)
Josh Triplettdcc8e552006-09-29 02:01:03 -070018# define __cond_lock(x,c) ((c) ? ({ __acquire(x); 1; }) : 0)
Rusty Russelle0fdb0e2009-10-29 22:34:15 +090019# define __percpu __attribute__((noderef, address_space(3)))
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -070020#ifdef CONFIG_SPARSE_RCU_POINTER
21# define __rcu __attribute__((noderef, address_space(4)))
Boqun Fengad315452015-12-29 12:18:46 +080022#else /* CONFIG_SPARSE_RCU_POINTER */
Paul E. McKenney71d1d5c2010-05-11 16:13:14 -070023# define __rcu
Boqun Fengad315452015-12-29 12:18:46 +080024#endif /* CONFIG_SPARSE_RCU_POINTER */
25# define __private __attribute__((noderef))
Al Viroc47ffe32007-07-26 17:35:29 +010026extern void __chk_user_ptr(const volatile void __user *);
27extern void __chk_io_ptr(const volatile void __iomem *);
Boqun Fengad315452015-12-29 12:18:46 +080028# define ACCESS_PRIVATE(p, member) (*((typeof((p)->member) __force *) &(p)->member))
29#else /* __CHECKER__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -070030# define __user
31# define __kernel
32# define __safe
33# define __force
34# define __nocast
35# define __iomem
36# define __chk_user_ptr(x) (void)0
37# define __chk_io_ptr(x) (void)0
38# define __builtin_warning(x, y...) (1)
Josh Triplett85290912012-12-17 16:03:24 -080039# define __must_hold(x)
Linus Torvalds1da177e2005-04-16 15:20:36 -070040# define __acquires(x)
41# define __releases(x)
42# define __acquire(x) (void)0
43# define __release(x) (void)0
Josh Triplettdcc8e552006-09-29 02:01:03 -070044# define __cond_lock(x,c) (c)
Rusty Russelle0fdb0e2009-10-29 22:34:15 +090045# define __percpu
Paul E. McKenney71d1d5c2010-05-11 16:13:14 -070046# define __rcu
Boqun Fengad315452015-12-29 12:18:46 +080047# define __private
48# define ACCESS_PRIVATE(p, member) ((p)->member)
49#endif /* __CHECKER__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Rusty Russell6f33d582012-11-22 12:30:25 +103051/* Indirect macros required for expanded argument pasting, eg. __LINE__. */
52#define ___PASTE(a,b) a##b
53#define __PASTE(a,b) ___PASTE(a,b)
54
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#ifdef __KERNEL__
56
Linus Torvaldsf153b822009-01-02 09:23:03 -080057#ifdef __GNUC__
58#include <linux/compiler-gcc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070059#endif
60
Christian Borntraeger0c5a69f2015-10-07 10:54:36 +020061#if defined(CC_USING_HOTPATCH) && !defined(__CHECKER__)
Heiko Carstens61f55212015-01-18 16:45:42 +010062#define notrace __attribute__((hotpatch(0,0)))
63#else
Steven Rostedt28614882008-08-14 22:47:18 -040064#define notrace __attribute__((no_instrument_function))
Heiko Carstens61f55212015-01-18 16:45:42 +010065#endif
Steven Rostedt28614882008-08-14 22:47:18 -040066
Linus Torvalds1da177e2005-04-16 15:20:36 -070067/* Intel compiler defines __GNUC__. So we will overwrite implementations
68 * coming from above header files here
69 */
70#ifdef __INTEL_COMPILER
71# include <linux/compiler-intel.h>
72#endif
73
Mark Charlebois565cbdc2012-11-20 22:13:10 +010074/* Clang compiler defines __GNUC__. So we will overwrite implementations
75 * coming from above header files here
76 */
77#ifdef __clang__
78#include <linux/compiler-clang.h>
79#endif
80
Linus Torvalds1da177e2005-04-16 15:20:36 -070081/*
82 * Generic compiler-dependent macros required for kernel
83 * build go below this comment. Actual compiler/compiler version
84 * specific implementations come from the above header files
85 */
86
Steven Rostedt2ed84ee2008-11-12 15:24:24 -050087struct ftrace_branch_data {
Steven Rostedt1f0d69a2008-11-12 00:14:39 -050088 const char *func;
89 const char *file;
90 unsigned line;
Steven Rostedt2bcd5212008-11-21 01:30:54 -050091 union {
92 struct {
93 unsigned long correct;
94 unsigned long incorrect;
95 };
96 struct {
97 unsigned long miss;
98 unsigned long hit;
99 };
Witold Baryluk97e7e4f2009-03-17 21:15:44 +0100100 unsigned long miss_hit[2];
Steven Rostedt2bcd5212008-11-21 01:30:54 -0500101 };
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500102};
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500103
104/*
105 * Note: DISABLE_BRANCH_PROFILING can be used by special lowlevel code
106 * to disable branch tracing on a per file basis.
107 */
Bart Van Assched9ad8bc2009-04-05 16:20:02 +0200108#if defined(CONFIG_TRACE_BRANCH_PROFILING) \
109 && !defined(DISABLE_BRANCH_PROFILING) && !defined(__CHECKER__)
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500110void ftrace_likely_update(struct ftrace_branch_data *f, int val, int expect);
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500111
112#define likely_notrace(x) __builtin_expect(!!(x), 1)
113#define unlikely_notrace(x) __builtin_expect(!!(x), 0)
114
Steven Rostedt45b79742008-11-21 00:40:40 -0500115#define __branch_check__(x, expect) ({ \
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500116 int ______r; \
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500117 static struct ftrace_branch_data \
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500118 __attribute__((__aligned__(4))) \
Steven Rostedt45b79742008-11-21 00:40:40 -0500119 __attribute__((section("_ftrace_annotated_branch"))) \
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500120 ______f = { \
121 .func = __func__, \
122 .file = __FILE__, \
123 .line = __LINE__, \
124 }; \
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500125 ______r = likely_notrace(x); \
Steven Rostedt45b79742008-11-21 00:40:40 -0500126 ftrace_likely_update(&______f, ______r, expect); \
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500127 ______r; \
128 })
129
130/*
131 * Using __builtin_constant_p(x) to ignore cases where the return
132 * value is always the same. This idea is taken from a similar patch
133 * written by Daniel Walker.
134 */
135# ifndef likely
Steven Rostedt45b79742008-11-21 00:40:40 -0500136# define likely(x) (__builtin_constant_p(x) ? !!(x) : __branch_check__(x, 1))
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500137# endif
138# ifndef unlikely
Steven Rostedt45b79742008-11-21 00:40:40 -0500139# define unlikely(x) (__builtin_constant_p(x) ? !!(x) : __branch_check__(x, 0))
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500140# endif
Steven Rostedt2bcd5212008-11-21 01:30:54 -0500141
142#ifdef CONFIG_PROFILE_ALL_BRANCHES
143/*
144 * "Define 'is'", Bill Clinton
145 * "Define 'if'", Steven Rostedt
146 */
Linus Torvaldsab3c9c62009-04-07 07:59:41 -0700147#define if(cond, ...) __trace_if( (cond , ## __VA_ARGS__) )
148#define __trace_if(cond) \
Arnd Bergmannb33c8ff2016-02-12 22:26:42 +0100149 if (__builtin_constant_p(!!(cond)) ? !!(cond) : \
Steven Rostedt2bcd5212008-11-21 01:30:54 -0500150 ({ \
151 int ______r; \
152 static struct ftrace_branch_data \
153 __attribute__((__aligned__(4))) \
154 __attribute__((section("_ftrace_branch"))) \
155 ______f = { \
156 .func = __func__, \
157 .file = __FILE__, \
158 .line = __LINE__, \
159 }; \
160 ______r = !!(cond); \
Witold Baryluk97e7e4f2009-03-17 21:15:44 +0100161 ______f.miss_hit[______r]++; \
Steven Rostedt2bcd5212008-11-21 01:30:54 -0500162 ______r; \
163 }))
164#endif /* CONFIG_PROFILE_ALL_BRANCHES */
165
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500166#else
167# define likely(x) __builtin_expect(!!(x), 1)
168# define unlikely(x) __builtin_expect(!!(x), 0)
169#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171/* Optimization barrier */
172#ifndef barrier
173# define barrier() __memory_barrier()
174#endif
175
Daniel Borkmann7829fb02015-04-30 04:13:52 +0200176#ifndef barrier_data
177# define barrier_data(ptr) barrier()
178#endif
179
David Daney38938c82009-12-04 17:44:50 -0800180/* Unreachable code */
181#ifndef unreachable
182# define unreachable() do { } while (1)
183#endif
184
Nicholas Pigginb67067f2016-08-24 22:29:20 +1000185/*
186 * KENTRY - kernel entry point
187 * This can be used to annotate symbols (functions or data) that are used
188 * without their linker symbol being referenced explicitly. For example,
189 * interrupt vector handlers, or functions in the kernel image that are found
190 * programatically.
191 *
192 * Not required for symbols exported with EXPORT_SYMBOL, or initcalls. Those
193 * are handled in their own way (with KEEP() in linker scripts).
194 *
195 * KENTRY can be avoided if the symbols in question are marked as KEEP() in the
196 * linker script. For example an architecture could KEEP() its entire
197 * boot/exception vector code rather than annotate each function and data.
198 */
199#ifndef KENTRY
200# define KENTRY(sym) \
201 extern typeof(sym) sym; \
202 static const unsigned long __kentry_##sym \
203 __used \
204 __attribute__((section("___kentry" "+" #sym ), used)) \
205 = (unsigned long)&sym;
206#endif
207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208#ifndef RELOC_HIDE
209# define RELOC_HIDE(ptr, off) \
210 ({ unsigned long __ptr; \
211 __ptr = (unsigned long) (ptr); \
212 (typeof(ptr)) (__ptr + (off)); })
213#endif
214
Cesar Eduardo Barrosfe8c8a12013-11-25 22:00:41 -0200215#ifndef OPTIMIZER_HIDE_VAR
216#define OPTIMIZER_HIDE_VAR(var) barrier()
217#endif
218
Rusty Russell6f33d582012-11-22 12:30:25 +1030219/* Not-quite-unique ID. */
220#ifndef __UNIQUE_ID
221# define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __LINE__)
222#endif
223
Christian Borntraeger230fa252014-11-25 10:01:16 +0100224#include <uapi/linux/types.h>
225
Andrey Ryabinind9764412015-10-19 11:37:17 +0300226#define __READ_ONCE_SIZE \
227({ \
228 switch (size) { \
229 case 1: *(__u8 *)res = *(volatile __u8 *)p; break; \
230 case 2: *(__u16 *)res = *(volatile __u16 *)p; break; \
231 case 4: *(__u32 *)res = *(volatile __u32 *)p; break; \
232 case 8: *(__u64 *)res = *(volatile __u64 *)p; break; \
233 default: \
234 barrier(); \
235 __builtin_memcpy((void *)res, (const void *)p, size); \
236 barrier(); \
237 } \
238})
239
240static __always_inline
241void __read_once_size(const volatile void *p, void *res, int size)
Christian Borntraeger230fa252014-11-25 10:01:16 +0100242{
Andrey Ryabinind9764412015-10-19 11:37:17 +0300243 __READ_ONCE_SIZE;
Christian Borntraeger230fa252014-11-25 10:01:16 +0100244}
245
Andrey Ryabinind9764412015-10-19 11:37:17 +0300246#ifdef CONFIG_KASAN
247/*
248 * This function is not 'inline' because __no_sanitize_address confilcts
249 * with inlining. Attempt to inline it may cause a build failure.
250 * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67368
251 * '__maybe_unused' allows us to avoid defined-but-not-used warnings.
252 */
253static __no_sanitize_address __maybe_unused
254void __read_once_size_nocheck(const volatile void *p, void *res, int size)
255{
256 __READ_ONCE_SIZE;
257}
258#else
259static __always_inline
260void __read_once_size_nocheck(const volatile void *p, void *res, int size)
261{
262 __READ_ONCE_SIZE;
263}
264#endif
265
Christian Borntraeger43239cb2015-01-13 10:46:42 +0100266static __always_inline void __write_once_size(volatile void *p, void *res, int size)
Christian Borntraeger230fa252014-11-25 10:01:16 +0100267{
268 switch (size) {
269 case 1: *(volatile __u8 *)p = *(__u8 *)res; break;
270 case 2: *(volatile __u16 *)p = *(__u16 *)res; break;
271 case 4: *(volatile __u32 *)p = *(__u32 *)res; break;
Christian Borntraeger230fa252014-11-25 10:01:16 +0100272 case 8: *(volatile __u64 *)p = *(__u64 *)res; break;
Christian Borntraeger230fa252014-11-25 10:01:16 +0100273 default:
274 barrier();
275 __builtin_memcpy((void *)p, (const void *)res, size);
Christian Borntraeger230fa252014-11-25 10:01:16 +0100276 barrier();
277 }
278}
279
280/*
281 * Prevent the compiler from merging or refetching reads or writes. The
282 * compiler is also forbidden from reordering successive instances of
Christian Borntraeger43239cb2015-01-13 10:46:42 +0100283 * READ_ONCE, WRITE_ONCE and ACCESS_ONCE (see below), but only when the
Christian Borntraeger230fa252014-11-25 10:01:16 +0100284 * compiler is aware of some particular ordering. One way to make the
285 * compiler aware of ordering is to put the two invocations of READ_ONCE,
Christian Borntraeger43239cb2015-01-13 10:46:42 +0100286 * WRITE_ONCE or ACCESS_ONCE() in different C statements.
Christian Borntraeger230fa252014-11-25 10:01:16 +0100287 *
288 * In contrast to ACCESS_ONCE these two macros will also work on aggregate
289 * data types like structs or unions. If the size of the accessed data
290 * type exceeds the word size of the machine (e.g., 32 bits or 64 bits)
Konrad Rzeszutek Wilkfed07642016-01-25 16:33:20 -0500291 * READ_ONCE() and WRITE_ONCE() will fall back to memcpy(). There's at
292 * least two memcpy()s: one for the __builtin_memcpy() and then one for
293 * the macro doing the copy of variable - '__u' allocated on the stack.
Christian Borntraeger230fa252014-11-25 10:01:16 +0100294 *
295 * Their two major use cases are: (1) Mediating communication between
296 * process-level code and irq/NMI handlers, all running on the same CPU,
297 * and (2) Ensuring that the compiler does not fold, spindle, or otherwise
298 * mutilate accesses that either do not require ordering or that interact
299 * with an explicit memory barrier or atomic instruction that provides the
300 * required ordering.
301 */
302
Andrey Ryabinind9764412015-10-19 11:37:17 +0300303#define __READ_ONCE(x, check) \
304({ \
305 union { typeof(x) __val; char __c[1]; } __u; \
306 if (check) \
307 __read_once_size(&(x), __u.__c, sizeof(x)); \
308 else \
309 __read_once_size_nocheck(&(x), __u.__c, sizeof(x)); \
310 __u.__val; \
311})
312#define READ_ONCE(x) __READ_ONCE(x, 1)
313
314/*
315 * Use READ_ONCE_NOCHECK() instead of READ_ONCE() if you need
316 * to hide memory access from KASAN.
317 */
318#define READ_ONCE_NOCHECK(x) __READ_ONCE(x, 0)
Christian Borntraeger230fa252014-11-25 10:01:16 +0100319
Christian Borntraeger43239cb2015-01-13 10:46:42 +0100320#define WRITE_ONCE(x, val) \
Christian Borntraegerba330342015-08-04 09:55:48 +0200321({ \
322 union { typeof(x) __val; char __c[1]; } __u = \
323 { .__val = (__force typeof(x)) (val) }; \
324 __write_once_size(&(x), __u.__c, sizeof(x)); \
325 __u.__val; \
326})
Christian Borntraeger230fa252014-11-25 10:01:16 +0100327
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328#endif /* __KERNEL__ */
329
330#endif /* __ASSEMBLY__ */
331
David Woodhouse4f79c3f2006-05-02 10:41:25 +0100332#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333/*
334 * Allow us to mark functions as 'deprecated' and have gcc emit a nice
335 * warning for each use, in hopes of speeding the functions removal.
336 * Usage is:
337 * int __deprecated foo(void)
338 */
339#ifndef __deprecated
340# define __deprecated /* unimplemented */
341#endif
342
Paul E. McKenney512345b2005-05-01 08:59:03 -0700343#ifdef MODULE
344#define __deprecated_for_modules __deprecated
345#else
346#define __deprecated_for_modules
347#endif
348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349#ifndef __must_check
350#define __must_check
351#endif
352
Andrew Mortoncebc04b2006-08-14 22:43:18 -0700353#ifndef CONFIG_ENABLE_MUST_CHECK
354#undef __must_check
355#define __must_check
356#endif
Jeff Garzikde488442007-10-25 04:06:13 -0400357#ifndef CONFIG_ENABLE_WARN_DEPRECATED
358#undef __deprecated
359#undef __deprecated_for_modules
360#define __deprecated
361#define __deprecated_for_modules
362#endif
Andrew Mortoncebc04b2006-08-14 22:43:18 -0700363
Rasmus Villemoesd64e85d2016-05-19 17:10:52 -0700364#ifndef __malloc
365#define __malloc
366#endif
367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368/*
369 * Allow us to avoid 'defined but not used' warnings on functions and data,
370 * as well as force them to be emitted to the assembly file.
371 *
David Rientjes0d7ebbb2007-05-09 02:35:27 -0700372 * As of gcc 3.4, static functions that are not marked with attribute((used))
373 * may be elided from the assembly file. As of gcc 3.4, static data not so
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 * marked will not be elided, but this may change in a future gcc version.
375 *
David Rientjes0d7ebbb2007-05-09 02:35:27 -0700376 * NOTE: Because distributions shipped with a backported unit-at-a-time
377 * compiler in gcc 3.3, we must define __used to be __attribute__((used))
378 * for gcc >=3.3 instead of 3.4.
379 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 * In prior versions of gcc, such functions and data would be emitted, but
381 * would be warned about except with attribute((unused)).
David Rientjes0d7ebbb2007-05-09 02:35:27 -0700382 *
383 * Mark functions that are referenced only in inline assembly as __used so
384 * the code is emitted even though it appears to be unreferenced.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 */
David Rientjes0d7ebbb2007-05-09 02:35:27 -0700386#ifndef __used
387# define __used /* unimplemented */
388#endif
389
390#ifndef __maybe_unused
391# define __maybe_unused /* unimplemented */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392#endif
393
Li Zefan7b2a3512009-11-02 08:50:52 +0800394#ifndef __always_unused
395# define __always_unused /* unimplemented */
396#endif
397
David Woodhouse423bc7b2006-05-04 00:41:02 +0100398#ifndef noinline
399#define noinline
400#endif
401
Andrew Morton735c4fb2008-03-04 14:28:40 -0800402/*
403 * Rather then using noinline to prevent stack consumption, use
Alexander Steine6be0c92012-02-23 13:42:30 +0100404 * noinline_for_stack instead. For documentation reasons.
Andrew Morton735c4fb2008-03-04 14:28:40 -0800405 */
406#define noinline_for_stack noinline
407
David Woodhouse423bc7b2006-05-04 00:41:02 +0100408#ifndef __always_inline
409#define __always_inline inline
410#endif
411
412#endif /* __KERNEL__ */
413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414/*
415 * From the GCC manual:
416 *
417 * Many functions do not examine any values except their arguments,
418 * and have no effects except the return value. Basically this is
419 * just slightly more strict class than the `pure' attribute above,
420 * since function is not allowed to read global memory.
421 *
422 * Note that a function that has pointer arguments and examines the
423 * data pointed to must _not_ be declared `const'. Likewise, a
424 * function that calls a non-`const' function usually must not be
425 * `const'. It does not make sense for a `const' function to return
426 * `void'.
427 */
428#ifndef __attribute_const__
429# define __attribute_const__ /* unimplemented */
430#endif
431
Emese Revfy0766f782016-06-20 20:42:34 +0200432#ifndef __latent_entropy
433# define __latent_entropy
434#endif
435
Andi Kleena586df02007-07-21 17:10:00 +0200436/*
437 * Tell gcc if a function is cold. The compiler will assume any path
438 * directly leading to the call is unlikely.
439 */
440
441#ifndef __cold
442#define __cold
443#endif
444
Sam Ravnborgf3fe8662008-01-20 18:54:48 +0100445/* Simple shorthand for a section definition */
446#ifndef __section
447# define __section(S) __attribute__ ((__section__(#S)))
448#endif
449
Andi Kleen9a858dc2012-09-17 14:09:15 -0700450#ifndef __visible
451#define __visible
452#endif
453
Rasmus Villemoesa744fd12015-11-05 18:45:02 -0800454/*
455 * Assume alignment of return value.
456 */
457#ifndef __assume_aligned
458#define __assume_aligned(a, ...)
459#endif
460
461
Rusty Russelld2c123c2009-06-12 21:46:56 -0600462/* Are two types/vars the same type (ignoring qualifiers)? */
463#ifndef __same_type
464# define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b))
465#endif
466
Peter Zijlstra47933ad2013-11-06 14:57:36 +0100467/* Is this type a native word size -- useful for atomic operations */
468#ifndef __native_word
Paul E. McKenney536fa402014-09-05 11:14:48 -0700469# define __native_word(t) (sizeof(t) == sizeof(char) || sizeof(t) == sizeof(short) || sizeof(t) == sizeof(int) || sizeof(t) == sizeof(long))
Peter Zijlstra47933ad2013-11-06 14:57:36 +0100470#endif
471
Arjan van de Ven9f0cf4a2009-09-26 14:33:01 +0200472/* Compile time object size, -1 for unknown */
473#ifndef __compiletime_object_size
474# define __compiletime_object_size(obj) -1
475#endif
Arjan van de Ven4a312762009-09-30 13:05:23 +0200476#ifndef __compiletime_warning
477# define __compiletime_warning(message)
478#endif
Arjan van de Ven63312b62009-10-02 07:50:50 -0700479#ifndef __compiletime_error
480# define __compiletime_error(message)
James Hogan2c0d2592014-06-04 16:11:16 -0700481/*
482 * Sparse complains of variable sized arrays due to the temporary variable in
483 * __compiletime_assert. Unfortunately we can't just expand it out to make
484 * sparse see a constant array size without breaking compiletime_assert on old
485 * versions of GCC (e.g. 4.2.4), so hide the array from sparse altogether.
486 */
487# ifndef __CHECKER__
488# define __compiletime_error_fallback(condition) \
Daniel Santos9a8ab1c2013-02-21 16:41:55 -0800489 do { ((void)sizeof(char[1 - 2 * condition])); } while (0)
James Hogan2c0d2592014-06-04 16:11:16 -0700490# endif
491#endif
492#ifndef __compiletime_error_fallback
Daniel Santosc361d3e2013-02-21 16:41:54 -0800493# define __compiletime_error_fallback(condition) do { } while (0)
Arjan van de Ven63312b62009-10-02 07:50:50 -0700494#endif
Daniel Santosc361d3e2013-02-21 16:41:54 -0800495
Daniel Santos9a8ab1c2013-02-21 16:41:55 -0800496#define __compiletime_assert(condition, msg, prefix, suffix) \
497 do { \
498 bool __cond = !(condition); \
499 extern void prefix ## suffix(void) __compiletime_error(msg); \
500 if (__cond) \
501 prefix ## suffix(); \
502 __compiletime_error_fallback(__cond); \
503 } while (0)
504
505#define _compiletime_assert(condition, msg, prefix, suffix) \
506 __compiletime_assert(condition, msg, prefix, suffix)
507
508/**
509 * compiletime_assert - break build and emit msg if condition is false
510 * @condition: a compile-time constant condition to check
511 * @msg: a message to emit if condition is false
512 *
513 * In tradition of POSIX assert, this macro will break the build if the
514 * supplied condition is *false*, emitting the supplied error message if the
515 * compiler has support to do so.
516 */
517#define compiletime_assert(condition, msg) \
518 _compiletime_assert(condition, msg, __compiletime_assert_, __LINE__)
519
Peter Zijlstra47933ad2013-11-06 14:57:36 +0100520#define compiletime_assert_atomic_type(t) \
521 compiletime_assert(__native_word(t), \
522 "Need native word sized stores/loads for atomicity.")
523
Linus Torvalds9c3cdc12008-05-10 19:51:16 -0700524/*
525 * Prevent the compiler from merging or refetching accesses. The compiler
526 * is also forbidden from reordering successive instances of ACCESS_ONCE(),
527 * but only when the compiler is aware of some particular ordering. One way
528 * to make the compiler aware of ordering is to put the two invocations of
529 * ACCESS_ONCE() in different C statements.
530 *
Christian Borntraeger927609d2014-11-25 10:16:39 +0100531 * ACCESS_ONCE will only work on scalar types. For union types, ACCESS_ONCE
532 * on a union member will work as long as the size of the member matches the
533 * size of the union and the size is smaller than word size.
534 *
535 * The major use cases of ACCESS_ONCE used to be (1) Mediating communication
536 * between process-level code and irq/NMI handlers, all running on the same CPU,
537 * and (2) Ensuring that the compiler does not fold, spindle, or otherwise
538 * mutilate accesses that either do not require ordering or that interact
539 * with an explicit memory barrier or atomic instruction that provides the
540 * required ordering.
541 *
Preeti U Murthy663fdcb2015-04-30 17:27:21 +0530542 * If possible use READ_ONCE()/WRITE_ONCE() instead.
Linus Torvalds9c3cdc12008-05-10 19:51:16 -0700543 */
Christian Borntraeger927609d2014-11-25 10:16:39 +0100544#define __ACCESS_ONCE(x) ({ \
Christian Borntraegerc5b19942015-01-12 12:13:39 +0100545 __maybe_unused typeof(x) __var = (__force typeof(x)) 0; \
Christian Borntraeger927609d2014-11-25 10:16:39 +0100546 (volatile typeof(x) *)&(x); })
547#define ACCESS_ONCE(x) (*__ACCESS_ONCE(x))
Linus Torvalds9c3cdc12008-05-10 19:51:16 -0700548
Peter Zijlstra0a04b012015-05-27 11:09:36 +0930549/**
550 * lockless_dereference() - safely load a pointer for later dereference
551 * @p: The pointer to load
552 *
553 * Similar to rcu_dereference(), but for situations where the pointed-to
554 * object's lifetime is managed by something other than RCU. That
555 * "something other" might be reference counting or simple immortality.
Peter Zijlstra331b6d82016-05-22 12:48:27 +0200556 *
Johannes Bergd7127b52016-08-26 08:16:00 +0200557 * The seemingly unused variable ___typecheck_p validates that @p is
558 * indeed a pointer type by using a pointer to typeof(*p) as the type.
559 * Taking a pointer to typeof(*p) again is needed in case p is void *.
Peter Zijlstra0a04b012015-05-27 11:09:36 +0930560 */
561#define lockless_dereference(p) \
562({ \
Stephen Rothwell38183b92015-05-28 17:20:58 +1000563 typeof(p) _________p1 = READ_ONCE(p); \
Johannes Bergd7127b52016-08-26 08:16:00 +0200564 typeof(*(p)) *___typecheck_p __maybe_unused; \
Peter Zijlstra0a04b012015-05-27 11:09:36 +0930565 smp_read_barrier_depends(); /* Dependency order vs. p above. */ \
566 (_________p1); \
567})
568
Masami Hiramatsu324670b2013-04-04 19:40:50 +0900569/* Ignore/forbid kprobes attach on very low level functions marked by this attribute: */
570#ifdef CONFIG_KPROBES
571# define __kprobes __attribute__((__section__(".kprobes.text")))
Masami Hiramatsu376e2422014-04-17 17:17:05 +0900572# define nokprobe_inline __always_inline
Masami Hiramatsu324670b2013-04-04 19:40:50 +0900573#else
574# define __kprobes
Masami Hiramatsu376e2422014-04-17 17:17:05 +0900575# define nokprobe_inline inline
Masami Hiramatsu324670b2013-04-04 19:40:50 +0900576#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577#endif /* __LINUX_COMPILER_H */