include/linux/compiler.h

   1 #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)))
   8 # define __kernel       /* default address space */
   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 __acquires(x)  __attribute__((context(x,0,1)))
  14 # define __releases(x)  __attribute__((context(x,1,0)))
  15 # define __acquire(x)   __context__(x,1)
  16 # define __release(x)   __context__(x,-1)
  17 # define __cond_lock(x,c)       ((c) ? ({ __acquire(x); 1; }) : 0)
  18 extern void __chk_user_ptr(const volatile void __user *);
  19 extern void __chk_io_ptr(const volatile void __iomem *);
  20 #else
  21 # define __user
  22 # define __kernel
  23 # define __safe
  24 # define __force
  25 # define __nocast
  26 # define __iomem
  27 # define __chk_user_ptr(x) (void)0
  28 # define __chk_io_ptr(x) (void)0
  29 # define __builtin_warning(x, y...) (1)
  30 # define __acquires(x)
  31 # define __releases(x)
  32 # define __acquire(x) (void)0
  33 # define __release(x) (void)0
  34 # define __cond_lock(x,c) (c)
  35 #endif
  36
  37 #ifdef __KERNEL__
  38
  39 #if __GNUC__ >= 4
  40 # include <linux/compiler-gcc4.h>
  41 #elif __GNUC__ == 3 && __GNUC_MINOR__ >= 2
  42 # include <linux/compiler-gcc3.h>
  43 #else
  44 # error Sorry, your compiler is too old/not recognized.
  45 #endif
  46
  47 #define notrace __attribute__((no_instrument_function))
  48
  49 /* Intel compiler defines __GNUC__. So we will overwrite implementations
  50  * coming from above header files here
  51  */
  52 #ifdef __INTEL_COMPILER
  53 # include <linux/compiler-intel.h>
  54 #endif
  55
  56 /*
  57  * Generic compiler-dependent macros required for kernel
  58  * build go below this comment. Actual compiler/compiler version
  59  * specific implementations come from the above header files
  60  */
  61
  62 struct ftrace_branch_data {
  63         const char *func;
  64         const char *file;
  65         unsigned line;
  66         unsigned long correct;
  67         unsigned long incorrect;
  68 };
  69
  70 /*
  71  * Note: DISABLE_BRANCH_PROFILING can be used by special lowlevel code
  72  * to disable branch tracing on a per file basis.
  73  */
  74 #if defined(CONFIG_TRACE_BRANCH_PROFILING) && !defined(DISABLE_BRANCH_PROFILING)
  75 void ftrace_likely_update(struct ftrace_branch_data *f, int val, int expect);
  76
  77 #define likely_notrace(x)       __builtin_expect(!!(x), 1)
  78 #define unlikely_notrace(x)     __builtin_expect(!!(x), 0)
  79
  80 #define likely_check(x) ({                                              \
  81                         int ______r;                                    \
  82                         static struct ftrace_branch_data                \
  83                                 __attribute__((__aligned__(4)))         \
  84                                 __attribute__((section("_ftrace_likely"))) \
  85                                 ______f = {                             \
  86                                 .func = __func__,                       \
  87                                 .file = __FILE__,                       \
  88                                 .line = __LINE__,                       \
  89                         };                                              \
  90                         ______f.line = __LINE__;                        \
  91                         ______r = likely_notrace(x);                    \
  92                         ftrace_likely_update(&______f, ______r, 1);     \
  93                         ______r;                                        \
  94                 })
  95 #define unlikely_check(x) ({                                            \
  96                         int ______r;                                    \
  97                         static struct ftrace_branch_data                \
  98                                 __attribute__((__aligned__(4)))         \
  99                                 __attribute__((section("_ftrace_unlikely"))) \
 100                                 ______f = {                             \
 101                                 .func = __func__,                       \
 102                                 .file = __FILE__,                       \
 103                                 .line = __LINE__,                       \
 104                         };                                              \
 105                         ______f.line = __LINE__;                        \
 106                         ______r = unlikely_notrace(x);                  \
 107                         ftrace_likely_update(&______f, ______r, 0);     \
 108                         ______r;                                        \
 109                 })
 110
 111 /*
 112  * Using __builtin_constant_p(x) to ignore cases where the return
 113  * value is always the same.  This idea is taken from a similar patch
 114  * written by Daniel Walker.
 115  */
 116 # ifndef likely
 117 #  define likely(x)     (__builtin_constant_p(x) ? !!(x) : likely_check(x))
 118 # endif
 119 # ifndef unlikely
 120 #  define unlikely(x)   (__builtin_constant_p(x) ? !!(x) : unlikely_check(x))
 121 # endif
 122 #else
 123 # define likely(x)      __builtin_expect(!!(x), 1)
 124 # define unlikely(x)    __builtin_expect(!!(x), 0)
 125 #endif
 126
 127 /* Optimization barrier */
 128 #ifndef barrier
 129 # define barrier() __memory_barrier()
 130 #endif
 131
 132 #ifndef RELOC_HIDE
 133 # define RELOC_HIDE(ptr, off)                                   \
 134   ({ unsigned long __ptr;                                       \
 135      __ptr = (unsigned long) (ptr);                             \
 136     (typeof(ptr)) (__ptr + (off)); })
 137 #endif
 138
 139 #endif /* __KERNEL__ */
 140
 141 #endif /* __ASSEMBLY__ */
 142
 143 #ifdef __KERNEL__
 144 /*
 145  * Allow us to mark functions as 'deprecated' and have gcc emit a nice
 146  * warning for each use, in hopes of speeding the functions removal.
 147  * Usage is:
 148  *              int __deprecated foo(void)
 149  */
 150 #ifndef __deprecated
 151 # define __deprecated           /* unimplemented */
 152 #endif
 153
 154 #ifdef MODULE
 155 #define __deprecated_for_modules __deprecated
 156 #else
 157 #define __deprecated_for_modules
 158 #endif
 159
 160 #ifndef __must_check
 161 #define __must_check
 162 #endif
 163
 164 #ifndef CONFIG_ENABLE_MUST_CHECK
 165 #undef __must_check
 166 #define __must_check
 167 #endif
 168 #ifndef CONFIG_ENABLE_WARN_DEPRECATED
 169 #undef __deprecated
 170 #undef __deprecated_for_modules
 171 #define __deprecated
 172 #define __deprecated_for_modules
 173 #endif
 174
 175 /*
 176  * Allow us to avoid 'defined but not used' warnings on functions and data,
 177  * as well as force them to be emitted to the assembly file.
 178  *
 179  * As of gcc 3.4, static functions that are not marked with attribute((used))
 180  * may be elided from the assembly file.  As of gcc 3.4, static data not so
 181  * marked will not be elided, but this may change in a future gcc version.
 182  *
 183  * NOTE: Because distributions shipped with a backported unit-at-a-time
 184  * compiler in gcc 3.3, we must define __used to be __attribute__((used))
 185  * for gcc >=3.3 instead of 3.4.
 186  *
 187  * In prior versions of gcc, such functions and data would be emitted, but
 188  * would be warned about except with attribute((unused)).
 189  *
 190  * Mark functions that are referenced only in inline assembly as __used so
 191  * the code is emitted even though it appears to be unreferenced.
 192  */
 193 #ifndef __used
 194 # define __used                 /* unimplemented */
 195 #endif
 196
 197 #ifndef __maybe_unused
 198 # define __maybe_unused         /* unimplemented */
 199 #endif
 200
 201 #ifndef noinline
 202 #define noinline
 203 #endif
 204
 205 /*
 206  * Rather then using noinline to prevent stack consumption, use
 207  * noinline_for_stack instead.  For documentaiton reasons.
 208  */
 209 #define noinline_for_stack noinline
 210
 211 #ifndef __always_inline
 212 #define __always_inline inline
 213 #endif
 214
 215 #endif /* __KERNEL__ */
 216
 217 /*
 218  * From the GCC manual:
 219  *
 220  * Many functions do not examine any values except their arguments,
 221  * and have no effects except the return value.  Basically this is
 222  * just slightly more strict class than the `pure' attribute above,
 223  * since function is not allowed to read global memory.
 224  *
 225  * Note that a function that has pointer arguments and examines the
 226  * data pointed to must _not_ be declared `const'.  Likewise, a
 227  * function that calls a non-`const' function usually must not be
 228  * `const'.  It does not make sense for a `const' function to return
 229  * `void'.
 230  */
 231 #ifndef __attribute_const__
 232 # define __attribute_const__    /* unimplemented */
 233 #endif
 234
 235 /*
 236  * Tell gcc if a function is cold. The compiler will assume any path
 237  * directly leading to the call is unlikely.
 238  */
 239
 240 #ifndef __cold
 241 #define __cold
 242 #endif
 243
 244 /* Simple shorthand for a section definition */
 245 #ifndef __section
 246 # define __section(S) __attribute__ ((__section__(#S)))
 247 #endif
 248
 249 /*
 250  * Prevent the compiler from merging or refetching accesses.  The compiler
 251  * is also forbidden from reordering successive instances of ACCESS_ONCE(),
 252  * but only when the compiler is aware of some particular ordering.  One way
 253  * to make the compiler aware of ordering is to put the two invocations of
 254  * ACCESS_ONCE() in different C statements.
 255  *
 256  * This macro does absolutely -nothing- to prevent the CPU from reordering,
 257  * merging, or refetching absolutely anything at any time.  Its main intended
 258  * use is to mediate communication between process-level code and irq/NMI
 259  * handlers, all running on the same CPU.
 260  */
 261 #define ACCESS_ONCE(x) (*(volatile typeof(x) *)&(x))
 262
 263 #endif /* __LINUX_COMPILER_H */