1 #ifndef __LINUX_COMPILER_H
2 #define __LINUX_COMPILER_H
7 # define __user __attribute__((noderef, address_space(1)))
8 # define __kernel __attribute__((address_space(0)))
9 # define __safe __attribute__((safe))
10 # define __force __attribute__((force))
11 # define __nocast __attribute__((nocast))
12 # define __iomem __attribute__((noderef, address_space(2)))
13 # define __must_hold(x) __attribute__((context(x,1,1)))
14 # 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)
18 # define __cond_lock(x,c) ((c) ? ({ __acquire(x); 1; }) : 0)
19 # define __percpu __attribute__((noderef, address_space(3)))
20 # define __rcu __attribute__((noderef, address_space(4)))
21 # define __private __attribute__((noderef))
22 extern void __chk_user_ptr(const volatile void __user
*);
23 extern void __chk_io_ptr(const volatile void __iomem
*);
24 # define ACCESS_PRIVATE(p, member) (*((typeof((p)->member) __force *) &(p)->member))
25 #else /* __CHECKER__ */
26 # ifdef STRUCTLEAK_PLUGIN
27 # define __user __attribute__((user))
36 # define __chk_user_ptr(x) (void)0
37 # define __chk_io_ptr(x) (void)0
38 # define __builtin_warning(x, y...) (1)
39 # define __must_hold(x)
40 # define __acquires(x)
41 # define __releases(x)
42 # define __acquire(x) (void)0
43 # define __release(x) (void)0
44 # define __cond_lock(x,c) (c)
48 # define ACCESS_PRIVATE(p, member) ((p)->member)
49 #endif /* __CHECKER__ */
51 /* Indirect macros required for expanded argument pasting, eg. __LINE__. */
52 #define ___PASTE(a,b) a##b
53 #define __PASTE(a,b) ___PASTE(a,b)
58 #include <linux/compiler-gcc.h>
61 #if defined(CC_USING_HOTPATCH) && !defined(__CHECKER__)
62 #define notrace __attribute__((hotpatch(0,0)))
64 #define notrace __attribute__((no_instrument_function))
67 /* Intel compiler defines __GNUC__. So we will overwrite implementations
68 * coming from above header files here
70 #ifdef __INTEL_COMPILER
71 # include <linux/compiler-intel.h>
74 /* Clang compiler defines __GNUC__. So we will overwrite implementations
75 * coming from above header files here
78 #include <linux/compiler-clang.h>
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
87 struct ftrace_branch_data
{
93 unsigned long correct
;
94 unsigned long incorrect
;
100 unsigned long miss_hit
[2];
104 struct ftrace_likely_data
{
105 struct ftrace_branch_data data
;
106 unsigned long constant
;
110 * Note: DISABLE_BRANCH_PROFILING can be used by special lowlevel code
111 * to disable branch tracing on a per file basis.
113 #if defined(CONFIG_TRACE_BRANCH_PROFILING) \
114 && !defined(DISABLE_BRANCH_PROFILING) && !defined(__CHECKER__)
115 void ftrace_likely_update(struct ftrace_likely_data
*f
, int val
,
116 int expect
, int is_constant
);
118 #define likely_notrace(x) __builtin_expect(!!(x), 1)
119 #define unlikely_notrace(x) __builtin_expect(!!(x), 0)
121 #define __branch_check__(x, expect, is_constant) ({ \
123 static struct ftrace_likely_data \
124 __attribute__((__aligned__(4))) \
125 __attribute__((section("_ftrace_annotated_branch"))) \
127 .data.func = __func__, \
128 .data.file = __FILE__, \
129 .data.line = __LINE__, \
131 ______r = __builtin_expect(!!(x), expect); \
132 ftrace_likely_update(&______f, ______r, \
133 expect, is_constant); \
138 * Using __builtin_constant_p(x) to ignore cases where the return
139 * value is always the same. This idea is taken from a similar patch
140 * written by Daniel Walker.
143 # define likely(x) (__branch_check__(x, 1, __builtin_constant_p(x)))
146 # define unlikely(x) (__branch_check__(x, 0, __builtin_constant_p(x)))
149 #ifdef CONFIG_PROFILE_ALL_BRANCHES
151 * "Define 'is'", Bill Clinton
152 * "Define 'if'", Steven Rostedt
154 #define if(cond, ...) __trace_if( (cond , ## __VA_ARGS__) )
155 #define __trace_if(cond) \
156 if (__builtin_constant_p(!!(cond)) ? !!(cond) : \
159 static struct ftrace_branch_data \
160 __attribute__((__aligned__(4))) \
161 __attribute__((section("_ftrace_branch"))) \
167 ______r = !!(cond); \
168 ______f.miss_hit[______r]++; \
171 #endif /* CONFIG_PROFILE_ALL_BRANCHES */
174 # define likely(x) __builtin_expect(!!(x), 1)
175 # define unlikely(x) __builtin_expect(!!(x), 0)
178 /* Optimization barrier */
180 # define barrier() __memory_barrier()
184 # define barrier_data(ptr) barrier()
187 /* Unreachable code */
188 #ifdef CONFIG_STACK_VALIDATION
189 #define annotate_reachable() ({ \
191 ".pushsection .discard.reachable\n\t" \
192 ".long %c0b - .\n\t" \
193 ".popsection\n\t" : : "i" (__LINE__)); \
195 #define annotate_unreachable() ({ \
197 ".pushsection .discard.unreachable\n\t" \
198 ".long %c0b - .\n\t" \
199 ".popsection\n\t" : : "i" (__LINE__)); \
201 #define ASM_UNREACHABLE \
203 ".pushsection .discard.unreachable\n\t" \
204 ".long 999b - .\n\t" \
207 #define annotate_reachable()
208 #define annotate_unreachable()
211 #ifndef ASM_UNREACHABLE
212 # define ASM_UNREACHABLE
215 # define unreachable() do { annotate_reachable(); do { } while (1); } while (0)
219 * KENTRY - kernel entry point
220 * This can be used to annotate symbols (functions or data) that are used
221 * without their linker symbol being referenced explicitly. For example,
222 * interrupt vector handlers, or functions in the kernel image that are found
225 * Not required for symbols exported with EXPORT_SYMBOL, or initcalls. Those
226 * are handled in their own way (with KEEP() in linker scripts).
228 * KENTRY can be avoided if the symbols in question are marked as KEEP() in the
229 * linker script. For example an architecture could KEEP() its entire
230 * boot/exception vector code rather than annotate each function and data.
233 # define KENTRY(sym) \
234 extern typeof(sym) sym; \
235 static const unsigned long __kentry_##sym \
237 __attribute__((section("___kentry" "+" #sym ), used)) \
238 = (unsigned long)&sym;
242 # define RELOC_HIDE(ptr, off) \
243 ({ unsigned long __ptr; \
244 __ptr = (unsigned long) (ptr); \
245 (typeof(ptr)) (__ptr + (off)); })
248 #ifndef OPTIMIZER_HIDE_VAR
249 #define OPTIMIZER_HIDE_VAR(var) barrier()
252 /* Not-quite-unique ID. */
254 # define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __LINE__)
257 #include <uapi/linux/types.h>
259 #define __READ_ONCE_SIZE \
262 case 1: *(__u8 *)res = *(volatile __u8 *)p; break; \
263 case 2: *(__u16 *)res = *(volatile __u16 *)p; break; \
264 case 4: *(__u32 *)res = *(volatile __u32 *)p; break; \
265 case 8: *(__u64 *)res = *(volatile __u64 *)p; break; \
268 __builtin_memcpy((void *)res, (const void *)p, size); \
273 static __always_inline
274 void __read_once_size(const volatile void *p
, void *res
, int size
)
281 * This function is not 'inline' because __no_sanitize_address confilcts
282 * with inlining. Attempt to inline it may cause a build failure.
283 * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67368
284 * '__maybe_unused' allows us to avoid defined-but-not-used warnings.
286 static __no_sanitize_address __maybe_unused
287 void __read_once_size_nocheck(const volatile void *p
, void *res
, int size
)
292 static __always_inline
293 void __read_once_size_nocheck(const volatile void *p
, void *res
, int size
)
299 static __always_inline
void __write_once_size(volatile void *p
, void *res
, int size
)
302 case 1: *(volatile __u8
*)p
= *(__u8
*)res
; break;
303 case 2: *(volatile __u16
*)p
= *(__u16
*)res
; break;
304 case 4: *(volatile __u32
*)p
= *(__u32
*)res
; break;
305 case 8: *(volatile __u64
*)p
= *(__u64
*)res
; break;
308 __builtin_memcpy((void *)p
, (const void *)res
, size
);
314 * Prevent the compiler from merging or refetching reads or writes. The
315 * compiler is also forbidden from reordering successive instances of
316 * READ_ONCE, WRITE_ONCE and ACCESS_ONCE (see below), but only when the
317 * compiler is aware of some particular ordering. One way to make the
318 * compiler aware of ordering is to put the two invocations of READ_ONCE,
319 * WRITE_ONCE or ACCESS_ONCE() in different C statements.
321 * In contrast to ACCESS_ONCE these two macros will also work on aggregate
322 * data types like structs or unions. If the size of the accessed data
323 * type exceeds the word size of the machine (e.g., 32 bits or 64 bits)
324 * READ_ONCE() and WRITE_ONCE() will fall back to memcpy(). There's at
325 * least two memcpy()s: one for the __builtin_memcpy() and then one for
326 * the macro doing the copy of variable - '__u' allocated on the stack.
328 * Their two major use cases are: (1) Mediating communication between
329 * process-level code and irq/NMI handlers, all running on the same CPU,
330 * and (2) Ensuring that the compiler does not fold, spindle, or otherwise
331 * mutilate accesses that either do not require ordering or that interact
332 * with an explicit memory barrier or atomic instruction that provides the
336 #define __READ_ONCE(x, check) \
338 union { typeof(x) __val; char __c[1]; } __u; \
340 __read_once_size(&(x), __u.__c, sizeof(x)); \
342 __read_once_size_nocheck(&(x), __u.__c, sizeof(x)); \
345 #define READ_ONCE(x) __READ_ONCE(x, 1)
348 * Use READ_ONCE_NOCHECK() instead of READ_ONCE() if you need
349 * to hide memory access from KASAN.
351 #define READ_ONCE_NOCHECK(x) __READ_ONCE(x, 0)
353 #define WRITE_ONCE(x, val) \
355 union { typeof(x) __val; char __c[1]; } __u = \
356 { .__val = (__force typeof(x)) (val) }; \
357 __write_once_size(&(x), __u.__c, sizeof(x)); \
361 #endif /* __KERNEL__ */
363 #endif /* __ASSEMBLY__ */
367 * Allow us to mark functions as 'deprecated' and have gcc emit a nice
368 * warning for each use, in hopes of speeding the functions removal.
370 * int __deprecated foo(void)
373 # define __deprecated /* unimplemented */
377 #define __deprecated_for_modules __deprecated
379 #define __deprecated_for_modules
386 #ifndef CONFIG_ENABLE_MUST_CHECK
390 #ifndef CONFIG_ENABLE_WARN_DEPRECATED
392 #undef __deprecated_for_modules
394 #define __deprecated_for_modules
402 * Allow us to avoid 'defined but not used' warnings on functions and data,
403 * as well as force them to be emitted to the assembly file.
405 * As of gcc 3.4, static functions that are not marked with attribute((used))
406 * may be elided from the assembly file. As of gcc 3.4, static data not so
407 * marked will not be elided, but this may change in a future gcc version.
409 * NOTE: Because distributions shipped with a backported unit-at-a-time
410 * compiler in gcc 3.3, we must define __used to be __attribute__((used))
411 * for gcc >=3.3 instead of 3.4.
413 * In prior versions of gcc, such functions and data would be emitted, but
414 * would be warned about except with attribute((unused)).
416 * Mark functions that are referenced only in inline assembly as __used so
417 * the code is emitted even though it appears to be unreferenced.
420 # define __used /* unimplemented */
423 #ifndef __maybe_unused
424 # define __maybe_unused /* unimplemented */
427 #ifndef __always_unused
428 # define __always_unused /* unimplemented */
436 * Rather then using noinline to prevent stack consumption, use
437 * noinline_for_stack instead. For documentation reasons.
439 #define noinline_for_stack noinline
441 #ifndef __always_inline
442 #define __always_inline inline
445 #endif /* __KERNEL__ */
448 * From the GCC manual:
450 * Many functions do not examine any values except their arguments,
451 * and have no effects except the return value. Basically this is
452 * just slightly more strict class than the `pure' attribute above,
453 * since function is not allowed to read global memory.
455 * Note that a function that has pointer arguments and examines the
456 * data pointed to must _not_ be declared `const'. Likewise, a
457 * function that calls a non-`const' function usually must not be
458 * `const'. It does not make sense for a `const' function to return
461 #ifndef __attribute_const__
462 # define __attribute_const__ /* unimplemented */
465 #ifndef __designated_init
466 # define __designated_init
469 #ifndef __latent_entropy
470 # define __latent_entropy
473 #ifndef __randomize_layout
474 # define __randomize_layout __designated_init
477 #ifndef __no_randomize_layout
478 # define __no_randomize_layout
481 #ifndef randomized_struct_fields_start
482 # define randomized_struct_fields_start
483 # define randomized_struct_fields_end
487 * Tell gcc if a function is cold. The compiler will assume any path
488 * directly leading to the call is unlikely.
495 /* Simple shorthand for a section definition */
497 # define __section(S) __attribute__ ((__section__(#S)))
504 #ifndef __nostackprotector
505 # define __nostackprotector
509 * Assume alignment of return value.
511 #ifndef __assume_aligned
512 #define __assume_aligned(a, ...)
516 /* Are two types/vars the same type (ignoring qualifiers)? */
518 # define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b))
521 /* Is this type a native word size -- useful for atomic operations */
522 #ifndef __native_word
523 # define __native_word(t) (sizeof(t) == sizeof(char) || sizeof(t) == sizeof(short) || sizeof(t) == sizeof(int) || sizeof(t) == sizeof(long))
526 /* Compile time object size, -1 for unknown */
527 #ifndef __compiletime_object_size
528 # define __compiletime_object_size(obj) -1
530 #ifndef __compiletime_warning
531 # define __compiletime_warning(message)
533 #ifndef __compiletime_error
534 # define __compiletime_error(message)
536 * Sparse complains of variable sized arrays due to the temporary variable in
537 * __compiletime_assert. Unfortunately we can't just expand it out to make
538 * sparse see a constant array size without breaking compiletime_assert on old
539 * versions of GCC (e.g. 4.2.4), so hide the array from sparse altogether.
542 # define __compiletime_error_fallback(condition) \
543 do { ((void)sizeof(char[1 - 2 * condition])); } while (0)
546 #ifndef __compiletime_error_fallback
547 # define __compiletime_error_fallback(condition) do { } while (0)
551 # define __compiletime_assert(condition, msg, prefix, suffix) \
553 bool __cond = !(condition); \
554 extern void prefix ## suffix(void) __compiletime_error(msg); \
556 prefix ## suffix(); \
557 __compiletime_error_fallback(__cond); \
560 # define __compiletime_assert(condition, msg, prefix, suffix) do { } while (0)
563 #define _compiletime_assert(condition, msg, prefix, suffix) \
564 __compiletime_assert(condition, msg, prefix, suffix)
567 * compiletime_assert - break build and emit msg if condition is false
568 * @condition: a compile-time constant condition to check
569 * @msg: a message to emit if condition is false
571 * In tradition of POSIX assert, this macro will break the build if the
572 * supplied condition is *false*, emitting the supplied error message if the
573 * compiler has support to do so.
575 #define compiletime_assert(condition, msg) \
576 _compiletime_assert(condition, msg, __compiletime_assert_, __LINE__)
578 #define compiletime_assert_atomic_type(t) \
579 compiletime_assert(__native_word(t), \
580 "Need native word sized stores/loads for atomicity.")
583 * Prevent the compiler from merging or refetching accesses. The compiler
584 * is also forbidden from reordering successive instances of ACCESS_ONCE(),
585 * but only when the compiler is aware of some particular ordering. One way
586 * to make the compiler aware of ordering is to put the two invocations of
587 * ACCESS_ONCE() in different C statements.
589 * ACCESS_ONCE will only work on scalar types. For union types, ACCESS_ONCE
590 * on a union member will work as long as the size of the member matches the
591 * size of the union and the size is smaller than word size.
593 * The major use cases of ACCESS_ONCE used to be (1) Mediating communication
594 * between process-level code and irq/NMI handlers, all running on the same CPU,
595 * and (2) Ensuring that the compiler does not fold, spindle, or otherwise
596 * mutilate accesses that either do not require ordering or that interact
597 * with an explicit memory barrier or atomic instruction that provides the
600 * If possible use READ_ONCE()/WRITE_ONCE() instead.
602 #define __ACCESS_ONCE(x) ({ \
603 __maybe_unused typeof(x) __var = (__force typeof(x)) 0; \
604 (volatile typeof(x) *)&(x); })
605 #define ACCESS_ONCE(x) (*__ACCESS_ONCE(x))
608 * lockless_dereference() - safely load a pointer for later dereference
609 * @p: The pointer to load
611 * Similar to rcu_dereference(), but for situations where the pointed-to
612 * object's lifetime is managed by something other than RCU. That
613 * "something other" might be reference counting or simple immortality.
615 * The seemingly unused variable ___typecheck_p validates that @p is
616 * indeed a pointer type by using a pointer to typeof(*p) as the type.
617 * Taking a pointer to typeof(*p) again is needed in case p is void *.
619 #define lockless_dereference(p) \
621 typeof(p) _________p1 = READ_ONCE(p); \
622 typeof(*(p)) *___typecheck_p __maybe_unused; \
623 smp_read_barrier_depends(); /* Dependency order vs. p above. */ \
627 #endif /* __LINUX_COMPILER_H */