6fa599f24d0585ba074d48dd23cb4421f2f930f5
[akaros.git] / kern / include / linux / compiler.h
1 #ifndef __AKAROS_COMPILER_H
2 #error "Please don't include <linux/compiler.h> directly, include <compiler.h> instead."
3 #endif
4
5 #ifndef __LINUX_COMPILER_H
6 #define __LINUX_COMPILER_H
7
8 #ifndef __ASSEMBLY__
9
10 #ifdef __CHECKER__
11 # define __user         __attribute__((noderef, address_space(1)))
12 # define __kernel       __attribute__((address_space(0)))
13 # define __safe         __attribute__((safe))
14 # define __force        __attribute__((force))
15 # define __nocast       __attribute__((nocast))
16 # define __iomem        __attribute__((noderef, address_space(2)))
17 # define __must_hold(x) __attribute__((context(x,1,1)))
18 # define __acquires(x)  __attribute__((context(x,0,1)))
19 # define __releases(x)  __attribute__((context(x,1,0)))
20 # define __acquire(x)   __context__(x,1)
21 # define __release(x)   __context__(x,-1)
22 # define __cond_lock(x,c)       ((c) ? ({ __acquire(x); 1; }) : 0)
23 # define __percpu       __attribute__((noderef, address_space(3)))
24 # define __rcu          __attribute__((noderef, address_space(4)))
25 # define __private      __attribute__((noderef))
26 extern void __chk_user_ptr(const volatile void __user *);
27 extern void __chk_io_ptr(const volatile void __iomem *);
28 # define ACCESS_PRIVATE(p, member) (*((typeof((p)->member) __force *) &(p)->member))
29 #else /* __CHECKER__ */
30 # ifdef STRUCTLEAK_PLUGIN
31 #  define __user __attribute__((user))
32 # else
33 #  define __user
34 # endif
35 # define __kernel
36 # define __safe
37 # define __force
38 # define __nocast
39 # define __iomem
40 # define __chk_user_ptr(x) (void)0
41 # define __chk_io_ptr(x) (void)0
42 # define __builtin_warning(x, y...) (1)
43 # define __must_hold(x)
44 # define __acquires(x)
45 # define __releases(x)
46 # define __acquire(x) (void)0
47 # define __release(x) (void)0
48 # define __cond_lock(x,c) (c)
49 # define __percpu
50 # define __rcu
51 # define __private
52 # define ACCESS_PRIVATE(p, member) ((p)->member)
53 #endif /* __CHECKER__ */
54
55 /* Indirect macros required for expanded argument pasting, eg. __LINE__. */
56 #define ___PASTE(a,b) a##b
57 #define __PASTE(a,b) ___PASTE(a,b)
58
59 #ifdef __KERNEL__
60
61 #ifdef __GNUC__
62 #include <linux/compiler-gcc.h>
63 #endif
64
65 #if defined(CC_USING_HOTPATCH) && !defined(__CHECKER__)
66 #define notrace __attribute__((hotpatch(0,0)))
67 #else
68 #define notrace __attribute__((no_instrument_function))
69 #endif
70
71 /* Intel compiler defines __GNUC__. So we will overwrite implementations
72  * coming from above header files here
73  */
74 #ifdef __INTEL_COMPILER
75 # include <linux/compiler-intel.h>
76 #endif
77
78 /* Clang compiler defines __GNUC__. So we will overwrite implementations
79  * coming from above header files here
80  */
81 #ifdef __clang__
82 #include <linux/compiler-clang.h>
83 #endif
84
85 /*
86  * Generic compiler-dependent macros required for kernel
87  * build go below this comment. Actual compiler/compiler version
88  * specific implementations come from the above header files
89  */
90
91 struct ftrace_branch_data {
92         const char *func;
93         const char *file;
94         unsigned line;
95         union {
96                 struct {
97                         unsigned long correct;
98                         unsigned long incorrect;
99                 };
100                 struct {
101                         unsigned long miss;
102                         unsigned long hit;
103                 };
104                 unsigned long miss_hit[2];
105         };
106 };
107
108 struct ftrace_likely_data {
109         struct ftrace_branch_data       data;
110         unsigned long                   constant;
111 };
112
113 /*
114  * Note: DISABLE_BRANCH_PROFILING can be used by special lowlevel code
115  * to disable branch tracing on a per file basis.
116  */
117 #if defined(CONFIG_TRACE_BRANCH_PROFILING) \
118     && !defined(DISABLE_BRANCH_PROFILING) && !defined(__CHECKER__)
119 void ftrace_likely_update(struct ftrace_likely_data *f, int val,
120                           int expect, int is_constant);
121
122 #define likely_notrace(x)       __builtin_expect(!!(x), 1)
123 #define unlikely_notrace(x)     __builtin_expect(!!(x), 0)
124
125 #define __branch_check__(x, expect, is_constant) ({                     \
126                         int ______r;                                    \
127                         static struct ftrace_likely_data                \
128                                 __attribute__((__aligned__(4)))         \
129                                 __attribute__((section("_ftrace_annotated_branch"))) \
130                                 ______f = {                             \
131                                 .data.func = __func__,                  \
132                                 .data.file = __FILE__,                  \
133                                 .data.line = __LINE__,                  \
134                         };                                              \
135                         ______r = __builtin_expect(!!(x), expect);      \
136                         ftrace_likely_update(&______f, ______r,         \
137                                              expect, is_constant);      \
138                         ______r;                                        \
139                 })
140
141 /*
142  * Using __builtin_constant_p(x) to ignore cases where the return
143  * value is always the same.  This idea is taken from a similar patch
144  * written by Daniel Walker.
145  */
146 # ifndef likely
147 #  define likely(x)     (__branch_check__(x, 1, __builtin_constant_p(x)))
148 # endif
149 # ifndef unlikely
150 #  define unlikely(x)   (__branch_check__(x, 0, __builtin_constant_p(x)))
151 # endif
152
153 #ifdef CONFIG_PROFILE_ALL_BRANCHES
154 /*
155  * "Define 'is'", Bill Clinton
156  * "Define 'if'", Steven Rostedt
157  */
158 #define if(cond, ...) __trace_if( (cond , ## __VA_ARGS__) )
159 #define __trace_if(cond) \
160         if (__builtin_constant_p(!!(cond)) ? !!(cond) :                 \
161         ({                                                              \
162                 int ______r;                                            \
163                 static struct ftrace_branch_data                        \
164                         __attribute__((__aligned__(4)))                 \
165                         __attribute__((section("_ftrace_branch")))      \
166                         ______f = {                                     \
167                                 .func = __func__,                       \
168                                 .file = __FILE__,                       \
169                                 .line = __LINE__,                       \
170                         };                                              \
171                 ______r = !!(cond);                                     \
172                 ______f.miss_hit[______r]++;                                    \
173                 ______r;                                                \
174         }))
175 #endif /* CONFIG_PROFILE_ALL_BRANCHES */
176
177 #else
178 # define likely(x)      __builtin_expect(!!(x), 1)
179 # define unlikely(x)    __builtin_expect(!!(x), 0)
180 #endif
181
182 /* Optimization barrier */
183 #ifndef barrier
184 # define barrier() __memory_barrier()
185 #endif
186
187 #ifndef barrier_data
188 # define barrier_data(ptr) barrier()
189 #endif
190
191 /* Unreachable code */
192 #ifndef unreachable
193 # define unreachable() do { } while (1)
194 #endif
195
196 /*
197  * KENTRY - kernel entry point
198  * This can be used to annotate symbols (functions or data) that are used
199  * without their linker symbol being referenced explicitly. For example,
200  * interrupt vector handlers, or functions in the kernel image that are found
201  * programatically.
202  *
203  * Not required for symbols exported with EXPORT_SYMBOL, or initcalls. Those
204  * are handled in their own way (with KEEP() in linker scripts).
205  *
206  * KENTRY can be avoided if the symbols in question are marked as KEEP() in the
207  * linker script. For example an architecture could KEEP() its entire
208  * boot/exception vector code rather than annotate each function and data.
209  */
210 #ifndef KENTRY
211 # define KENTRY(sym)                                            \
212         extern typeof(sym) sym;                                 \
213         static const unsigned long __kentry_##sym               \
214         __used                                                  \
215         __attribute__((section("___kentry" "+" #sym ), used))   \
216         = (unsigned long)&sym;
217 #endif
218
219 #ifndef RELOC_HIDE
220 # define RELOC_HIDE(ptr, off)                                   \
221   ({ unsigned long __ptr;                                       \
222      __ptr = (unsigned long) (ptr);                             \
223     (typeof(ptr)) (__ptr + (off)); })
224 #endif
225
226 #ifndef OPTIMIZER_HIDE_VAR
227 #define OPTIMIZER_HIDE_VAR(var) barrier()
228 #endif
229
230 /* Not-quite-unique ID. */
231 #ifndef __UNIQUE_ID
232 # define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __LINE__)
233 #endif
234
235 #if 0 // AKAROS_PORT
236 #include <uapi/linux/types.h>
237 #else
238 #include <sys/types.h>
239 typedef uint8_t __u8;
240 typedef uint16_t __u16;
241 typedef uint32_t __u32;
242 typedef uint64_t __u64;
243 #endif
244
245 #define __READ_ONCE_SIZE                                                \
246 ({                                                                      \
247         switch (size) {                                                 \
248         case 1: *(__u8 *)res = *(volatile __u8 *)p; break;              \
249         case 2: *(__u16 *)res = *(volatile __u16 *)p; break;            \
250         case 4: *(__u32 *)res = *(volatile __u32 *)p; break;            \
251         case 8: *(__u64 *)res = *(volatile __u64 *)p; break;            \
252         default:                                                        \
253                 barrier();                                              \
254                 __builtin_memcpy((void *)res, (const void *)p, size);   \
255                 barrier();                                              \
256         }                                                               \
257 })
258
259 static __always_inline
260 void __read_once_size(const volatile void *p, void *res, int size)
261 {
262         __READ_ONCE_SIZE;
263 }
264
265 #ifdef CONFIG_KASAN
266 /*
267  * This function is not 'inline' because __no_sanitize_address confilcts
268  * with inlining. Attempt to inline it may cause a build failure.
269  *      https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67368
270  * '__maybe_unused' allows us to avoid defined-but-not-used warnings.
271  */
272 static __no_sanitize_address __maybe_unused
273 void __read_once_size_nocheck(const volatile void *p, void *res, int size)
274 {
275         __READ_ONCE_SIZE;
276 }
277 #else
278 static __always_inline
279 void __read_once_size_nocheck(const volatile void *p, void *res, int size)
280 {
281         __READ_ONCE_SIZE;
282 }
283 #endif
284
285 static __always_inline void __write_once_size(volatile void *p, void *res, int size)
286 {
287         switch (size) {
288         case 1: *(volatile __u8 *)p = *(__u8 *)res; break;
289         case 2: *(volatile __u16 *)p = *(__u16 *)res; break;
290         case 4: *(volatile __u32 *)p = *(__u32 *)res; break;
291         case 8: *(volatile __u64 *)p = *(__u64 *)res; break;
292         default:
293                 barrier();
294                 __builtin_memcpy((void *)p, (const void *)res, size);
295                 barrier();
296         }
297 }
298
299 /*
300  * Prevent the compiler from merging or refetching reads or writes. The
301  * compiler is also forbidden from reordering successive instances of
302  * READ_ONCE, WRITE_ONCE and ACCESS_ONCE (see below), but only when the
303  * compiler is aware of some particular ordering.  One way to make the
304  * compiler aware of ordering is to put the two invocations of READ_ONCE,
305  * WRITE_ONCE or ACCESS_ONCE() in different C statements.
306  *
307  * In contrast to ACCESS_ONCE these two macros will also work on aggregate
308  * data types like structs or unions. If the size of the accessed data
309  * type exceeds the word size of the machine (e.g., 32 bits or 64 bits)
310  * READ_ONCE() and WRITE_ONCE() will fall back to memcpy(). There's at
311  * least two memcpy()s: one for the __builtin_memcpy() and then one for
312  * the macro doing the copy of variable - '__u' allocated on the stack.
313  *
314  * Their two major use cases are: (1) Mediating communication between
315  * process-level code and irq/NMI handlers, all running on the same CPU,
316  * and (2) Ensuring that the compiler does not  fold, spindle, or otherwise
317  * mutilate accesses that either do not require ordering or that interact
318  * with an explicit memory barrier or atomic instruction that provides the
319  * required ordering.
320  */
321
322 #define __READ_ONCE(x, check)                                           \
323 ({                                                                      \
324         union { typeof(x) __val; char __c[1]; } __u;                    \
325         if (check)                                                      \
326                 __read_once_size(&(x), __u.__c, sizeof(x));             \
327         else                                                            \
328                 __read_once_size_nocheck(&(x), __u.__c, sizeof(x));     \
329         __u.__val;                                                      \
330 })
331 #define READ_ONCE(x) __READ_ONCE(x, 1)
332
333 /*
334  * Use READ_ONCE_NOCHECK() instead of READ_ONCE() if you need
335  * to hide memory access from KASAN.
336  */
337 #define READ_ONCE_NOCHECK(x) __READ_ONCE(x, 0)
338
339 #define WRITE_ONCE(x, val) \
340 ({                                                      \
341         union { typeof(x) __val; char __c[1]; } __u =   \
342                 { .__val = (__force typeof(x)) (val) }; \
343         __write_once_size(&(x), __u.__c, sizeof(x));    \
344         __u.__val;                                      \
345 })
346
347 #endif /* __KERNEL__ */
348
349 #endif /* __ASSEMBLY__ */
350
351 #ifdef __KERNEL__
352 /*
353  * Allow us to mark functions as 'deprecated' and have gcc emit a nice
354  * warning for each use, in hopes of speeding the functions removal.
355  * Usage is:
356  *              int __deprecated foo(void)
357  */
358 #ifndef __deprecated
359 # define __deprecated           /* unimplemented */
360 #endif
361
362 #ifdef MODULE
363 #define __deprecated_for_modules __deprecated
364 #else
365 #define __deprecated_for_modules
366 #endif
367
368 #ifndef __must_check
369 #define __must_check
370 #endif
371
372 #ifndef CONFIG_ENABLE_MUST_CHECK
373 #undef __must_check
374 #define __must_check
375 #endif
376 #ifndef CONFIG_ENABLE_WARN_DEPRECATED
377 #undef __deprecated
378 #undef __deprecated_for_modules
379 #define __deprecated
380 #define __deprecated_for_modules
381 #endif
382
383 #ifndef __malloc
384 #define __malloc
385 #endif
386
387 /*
388  * Allow us to avoid 'defined but not used' warnings on functions and data,
389  * as well as force them to be emitted to the assembly file.
390  *
391  * As of gcc 3.4, static functions that are not marked with attribute((used))
392  * may be elided from the assembly file.  As of gcc 3.4, static data not so
393  * marked will not be elided, but this may change in a future gcc version.
394  *
395  * NOTE: Because distributions shipped with a backported unit-at-a-time
396  * compiler in gcc 3.3, we must define __used to be __attribute__((used))
397  * for gcc >=3.3 instead of 3.4.
398  *
399  * In prior versions of gcc, such functions and data would be emitted, but
400  * would be warned about except with attribute((unused)).
401  *
402  * Mark functions that are referenced only in inline assembly as __used so
403  * the code is emitted even though it appears to be unreferenced.
404  */
405 #ifndef __used
406 # define __used                 /* unimplemented */
407 #endif
408
409 #ifndef __maybe_unused
410 # define __maybe_unused         /* unimplemented */
411 #endif
412
413 #ifndef __always_unused
414 # define __always_unused        /* unimplemented */
415 #endif
416
417 #ifndef noinline
418 #define noinline
419 #endif
420
421 /*
422  * Rather then using noinline to prevent stack consumption, use
423  * noinline_for_stack instead.  For documentation reasons.
424  */
425 #define noinline_for_stack noinline
426
427 #ifndef __always_inline
428 #define __always_inline inline
429 #endif
430
431 #endif /* __KERNEL__ */
432
433 /*
434  * From the GCC manual:
435  *
436  * Many functions do not examine any values except their arguments,
437  * and have no effects except the return value.  Basically this is
438  * just slightly more strict class than the `pure' attribute above,
439  * since function is not allowed to read global memory.
440  *
441  * Note that a function that has pointer arguments and examines the
442  * data pointed to must _not_ be declared `const'.  Likewise, a
443  * function that calls a non-`const' function usually must not be
444  * `const'.  It does not make sense for a `const' function to return
445  * `void'.
446  */
447 #ifndef __attribute_const__
448 # define __attribute_const__    /* unimplemented */
449 #endif
450
451 #ifndef __designated_init
452 # define __designated_init
453 #endif
454
455 #ifndef __latent_entropy
456 # define __latent_entropy
457 #endif
458
459 #ifndef __randomize_layout
460 # define __randomize_layout __designated_init
461 #endif
462
463 #ifndef __no_randomize_layout
464 # define __no_randomize_layout
465 #endif
466
467 #ifndef randomized_struct_fields_start
468 # define randomized_struct_fields_start
469 # define randomized_struct_fields_end
470 #endif
471
472 /*
473  * Tell gcc if a function is cold. The compiler will assume any path
474  * directly leading to the call is unlikely.
475  */
476
477 #ifndef __cold
478 #define __cold
479 #endif
480
481 /* Simple shorthand for a section definition */
482 #ifndef __section
483 # define __section(S) __attribute__ ((__section__(#S)))
484 #endif
485
486 #ifndef __visible
487 #define __visible
488 #endif
489
490 /*
491  * Assume alignment of return value.
492  */
493 #ifndef __assume_aligned
494 #define __assume_aligned(a, ...)
495 #endif
496
497
498 /* Are two types/vars the same type (ignoring qualifiers)? */
499 #ifndef __same_type
500 # define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b))
501 #endif
502
503 /* Is this type a native word size -- useful for atomic operations */
504 #ifndef __native_word
505 # define __native_word(t) (sizeof(t) == sizeof(char) || sizeof(t) == sizeof(short) || sizeof(t) == sizeof(int) || sizeof(t) == sizeof(long))
506 #endif
507
508 /* Compile time object size, -1 for unknown */
509 #ifndef __compiletime_object_size
510 # define __compiletime_object_size(obj) -1
511 #endif
512 #ifndef __compiletime_warning
513 # define __compiletime_warning(message)
514 #endif
515 #ifndef __compiletime_error
516 # define __compiletime_error(message)
517 /*
518  * Sparse complains of variable sized arrays due to the temporary variable in
519  * __compiletime_assert. Unfortunately we can't just expand it out to make
520  * sparse see a constant array size without breaking compiletime_assert on old
521  * versions of GCC (e.g. 4.2.4), so hide the array from sparse altogether.
522  */
523 # ifndef __CHECKER__
524 #  define __compiletime_error_fallback(condition) \
525         do { ((void)sizeof(char[1 - 2 * condition])); } while (0)
526 # endif
527 #endif
528 #ifndef __compiletime_error_fallback
529 # define __compiletime_error_fallback(condition) do { } while (0)
530 #endif
531
532 #ifdef __OPTIMIZE__
533 # define __compiletime_assert(condition, msg, prefix, suffix)           \
534         do {                                                            \
535                 bool __cond = !(condition);                             \
536                 extern void prefix ## suffix(void) __compiletime_error(msg); \
537                 if (__cond)                                             \
538                         prefix ## suffix();                             \
539                 __compiletime_error_fallback(__cond);                   \
540         } while (0)
541 #else
542 # define __compiletime_assert(condition, msg, prefix, suffix) do { } while (0)
543 #endif
544
545 #define _compiletime_assert(condition, msg, prefix, suffix) \
546         __compiletime_assert(condition, msg, prefix, suffix)
547
548 /**
549  * compiletime_assert - break build and emit msg if condition is false
550  * @condition: a compile-time constant condition to check
551  * @msg:       a message to emit if condition is false
552  *
553  * In tradition of POSIX assert, this macro will break the build if the
554  * supplied condition is *false*, emitting the supplied error message if the
555  * compiler has support to do so.
556  */
557 #define compiletime_assert(condition, msg) \
558         _compiletime_assert(condition, msg, __compiletime_assert_, __LINE__)
559
560 #define compiletime_assert_atomic_type(t)                               \
561         compiletime_assert(__native_word(t),                            \
562                 "Need native word sized stores/loads for atomicity.")
563
564 /*
565  * Prevent the compiler from merging or refetching accesses.  The compiler
566  * is also forbidden from reordering successive instances of ACCESS_ONCE(),
567  * but only when the compiler is aware of some particular ordering.  One way
568  * to make the compiler aware of ordering is to put the two invocations of
569  * ACCESS_ONCE() in different C statements.
570  *
571  * ACCESS_ONCE will only work on scalar types. For union types, ACCESS_ONCE
572  * on a union member will work as long as the size of the member matches the
573  * size of the union and the size is smaller than word size.
574  *
575  * The major use cases of ACCESS_ONCE used to be (1) Mediating communication
576  * between process-level code and irq/NMI handlers, all running on the same CPU,
577  * and (2) Ensuring that the compiler does not  fold, spindle, or otherwise
578  * mutilate accesses that either do not require ordering or that interact
579  * with an explicit memory barrier or atomic instruction that provides the
580  * required ordering.
581  *
582  * If possible use READ_ONCE()/WRITE_ONCE() instead.
583  */
584 #define __ACCESS_ONCE(x) ({ \
585          __maybe_unused typeof(x) __var = (__force typeof(x)) 0; \
586         (volatile typeof(x) *)&(x); })
587 #define ACCESS_ONCE(x) (*__ACCESS_ONCE(x))
588
589 /**
590  * lockless_dereference() - safely load a pointer for later dereference
591  * @p: The pointer to load
592  *
593  * Similar to rcu_dereference(), but for situations where the pointed-to
594  * object's lifetime is managed by something other than RCU.  That
595  * "something other" might be reference counting or simple immortality.
596  *
597  * The seemingly unused variable ___typecheck_p validates that @p is
598  * indeed a pointer type by using a pointer to typeof(*p) as the type.
599  * Taking a pointer to typeof(*p) again is needed in case p is void *.
600  */
601 #define lockless_dereference(p) \
602 ({ \
603         typeof(p) _________p1 = READ_ONCE(p); \
604         typeof(*(p)) *___typecheck_p __maybe_unused; \
605         smp_read_barrier_depends(); /* Dependency order vs. p above. */ \
606         (_________p1); \
607 })
608
609 #endif /* __LINUX_COMPILER_H */