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       __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 #ifdef CONFIG_SPARSE_RCU_POINTER
  21 # define __rcu          __attribute__((noderef, address_space(4)))
  22 #else
  23 # define __rcu
  24 #endif
  25 extern void __chk_user_ptr(const volatile void __user *);
  26 extern void __chk_io_ptr(const volatile void __iomem *);
  27 #else
  28 # define __user
  29 # define __kernel
  30 # define __safe
  31 # define __force
  32 # define __nocast
  33 # define __iomem
  34 # define __chk_user_ptr(x) (void)0
  35 # define __chk_io_ptr(x) (void)0
  36 # define __builtin_warning(x, y...) (1)
  37 # define __must_hold(x)
  38 # define __acquires(x)
  39 # define __releases(x)
  40 # define __acquire(x) (void)0
  41 # define __release(x) (void)0
  42 # define __cond_lock(x,c) (c)
  43 # define __percpu
  44 # define __rcu
  45 #endif
  46
  47 /* Indirect macros required for expanded argument pasting, eg. __LINE__. */
  48 #define ___PASTE(a,b) a##b
  49 #define __PASTE(a,b) ___PASTE(a,b)
  50
  51 #ifdef __KERNEL__
  52
  53 #ifdef __GNUC__
  54 #include <linux/compiler-gcc.h>
  55 #endif
  56
  57 #ifdef CC_USING_HOTPATCH
  58 #define notrace __attribute__((hotpatch(0,0)))
  59 #else
  60 #define notrace __attribute__((no_instrument_function))
  61 #endif
  62
  63 /* Intel compiler defines __GNUC__. So we will overwrite implementations
  64  * coming from above header files here
  65  */
  66 #ifdef __INTEL_COMPILER
  67 # include <linux/compiler-intel.h>
  68 #endif
  69
  70 /* Clang compiler defines __GNUC__. So we will overwrite implementations
  71  * coming from above header files here
  72  */
  73 #ifdef __clang__
  74 #include <linux/compiler-clang.h>
  75 #endif
  76
  77 /*
  78  * Generic compiler-dependent macros required for kernel
  79  * build go below this comment. Actual compiler/compiler version
  80  * specific implementations come from the above header files
  81  */
  82
  83 struct ftrace_branch_data {
  84         const char *func;
  85         const char *file;
  86         unsigned line;
  87         union {
  88                 struct {
  89                         unsigned long correct;
  90                         unsigned long incorrect;
  91                 };
  92                 struct {
  93                         unsigned long miss;
  94                         unsigned long hit;
  95                 };
  96                 unsigned long miss_hit[2];
  97         };
  98 };
  99
 100 /*
 101  * Note: DISABLE_BRANCH_PROFILING can be used by special lowlevel code
 102  * to disable branch tracing on a per file basis.
 103  */
 104 #if defined(CONFIG_TRACE_BRANCH_PROFILING) \
 105     && !defined(DISABLE_BRANCH_PROFILING) && !defined(__CHECKER__)
 106 void ftrace_likely_update(struct ftrace_branch_data *f, int val, int expect);
 107
 108 #define likely_notrace(x)       __builtin_expect(!!(x), 1)
 109 #define unlikely_notrace(x)     __builtin_expect(!!(x), 0)
 110
 111 #define __branch_check__(x, expect) ({                                  \
 112                         int ______r;                                    \
 113                         static struct ftrace_branch_data                \
 114                                 __attribute__((__aligned__(4)))         \
 115                                 __attribute__((section("_ftrace_annotated_branch"))) \
 116                                 ______f = {                             \
 117                                 .func = __func__,                       \
 118                                 .file = __FILE__,                       \
 119                                 .line = __LINE__,                       \
 120                         };                                              \
 121                         ______r = likely_notrace(x);                    \
 122                         ftrace_likely_update(&______f, ______r, expect); \
 123                         ______r;                                        \
 124                 })
 125
 126 /*
 127  * Using __builtin_constant_p(x) to ignore cases where the return
 128  * value is always the same.  This idea is taken from a similar patch
 129  * written by Daniel Walker.
 130  */
 131 # ifndef likely
 132 #  define likely(x)     (__builtin_constant_p(x) ? !!(x) : __branch_check__(x, 1))
 133 # endif
 134 # ifndef unlikely
 135 #  define unlikely(x)   (__builtin_constant_p(x) ? !!(x) : __branch_check__(x, 0))
 136 # endif
 137
 138 #ifdef CONFIG_PROFILE_ALL_BRANCHES
 139 /*
 140  * "Define 'is'", Bill Clinton
 141  * "Define 'if'", Steven Rostedt
 142  */
 143 #define if(cond, ...) __trace_if( (cond , ## __VA_ARGS__) )
 144 #define __trace_if(cond) \
 145         if (__builtin_constant_p((cond)) ? !!(cond) :                   \
 146         ({                                                              \
 147                 int ______r;                                            \
 148                 static struct ftrace_branch_data                        \
 149                         __attribute__((__aligned__(4)))                 \
 150                         __attribute__((section("_ftrace_branch")))      \
 151                         ______f = {                                     \
 152                                 .func = __func__,                       \
 153                                 .file = __FILE__,                       \
 154                                 .line = __LINE__,                       \
 155                         };                                              \
 156                 ______r = !!(cond);                                     \
 157                 ______f.miss_hit[______r]++;                                    \
 158                 ______r;                                                \
 159         }))
 160 #endif /* CONFIG_PROFILE_ALL_BRANCHES */
 161
 162 #else
 163 # define likely(x)      __builtin_expect(!!(x), 1)
 164 # define unlikely(x)    __builtin_expect(!!(x), 0)
 165 #endif
 166
 167 /* Optimization barrier */
 168 #ifndef barrier
 169 # define barrier() __memory_barrier()
 170 #endif
 171
 172 /* Unreachable code */
 173 #ifndef unreachable
 174 # define unreachable() do { } while (1)
 175 #endif
 176
 177 #ifndef RELOC_HIDE
 178 # define RELOC_HIDE(ptr, off)                                   \
 179   ({ unsigned long __ptr;                                       \
 180      __ptr = (unsigned long) (ptr);                             \
 181     (typeof(ptr)) (__ptr + (off)); })
 182 #endif
 183
 184 #ifndef OPTIMIZER_HIDE_VAR
 185 #define OPTIMIZER_HIDE_VAR(var) barrier()
 186 #endif
 187
 188 /* Not-quite-unique ID. */
 189 #ifndef __UNIQUE_ID
 190 # define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __LINE__)
 191 #endif
 192
 193 #endif /* __KERNEL__ */
 194
 195 #endif /* __ASSEMBLY__ */
 196
 197 #ifdef __KERNEL__
 198 /*
 199  * Allow us to mark functions as 'deprecated' and have gcc emit a nice
 200  * warning for each use, in hopes of speeding the functions removal.
 201  * Usage is:
 202  *              int __deprecated foo(void)
 203  */
 204 #ifndef __deprecated
 205 # define __deprecated           /* unimplemented */
 206 #endif
 207
 208 #ifdef MODULE
 209 #define __deprecated_for_modules __deprecated
 210 #else
 211 #define __deprecated_for_modules
 212 #endif
 213
 214 #ifndef __must_check
 215 #define __must_check
 216 #endif
 217
 218 #ifndef CONFIG_ENABLE_MUST_CHECK
 219 #undef __must_check
 220 #define __must_check
 221 #endif
 222 #ifndef CONFIG_ENABLE_WARN_DEPRECATED
 223 #undef __deprecated
 224 #undef __deprecated_for_modules
 225 #define __deprecated
 226 #define __deprecated_for_modules
 227 #endif
 228
 229 /*
 230  * Allow us to avoid 'defined but not used' warnings on functions and data,
 231  * as well as force them to be emitted to the assembly file.
 232  *
 233  * As of gcc 3.4, static functions that are not marked with attribute((used))
 234  * may be elided from the assembly file.  As of gcc 3.4, static data not so
 235  * marked will not be elided, but this may change in a future gcc version.
 236  *
 237  * NOTE: Because distributions shipped with a backported unit-at-a-time
 238  * compiler in gcc 3.3, we must define __used to be __attribute__((used))
 239  * for gcc >=3.3 instead of 3.4.
 240  *
 241  * In prior versions of gcc, such functions and data would be emitted, but
 242  * would be warned about except with attribute((unused)).
 243  *
 244  * Mark functions that are referenced only in inline assembly as __used so
 245  * the code is emitted even though it appears to be unreferenced.
 246  */
 247 #ifndef __used
 248 # define __used                 /* unimplemented */
 249 #endif
 250
 251 #ifndef __maybe_unused
 252 # define __maybe_unused         /* unimplemented */
 253 #endif
 254
 255 #ifndef __always_unused
 256 # define __always_unused        /* unimplemented */
 257 #endif
 258
 259 #ifndef noinline
 260 #define noinline
 261 #endif
 262
 263 /*
 264  * Rather then using noinline to prevent stack consumption, use
 265  * noinline_for_stack instead.  For documentation reasons.
 266  */
 267 #define noinline_for_stack noinline
 268
 269 #ifndef __always_inline
 270 #define __always_inline inline
 271 #endif
 272
 273 #endif /* __KERNEL__ */
 274
 275 /*
 276  * From the GCC manual:
 277  *
 278  * Many functions do not examine any values except their arguments,
 279  * and have no effects except the return value.  Basically this is
 280  * just slightly more strict class than the `pure' attribute above,
 281  * since function is not allowed to read global memory.
 282  *
 283  * Note that a function that has pointer arguments and examines the
 284  * data pointed to must _not_ be declared `const'.  Likewise, a
 285  * function that calls a non-`const' function usually must not be
 286  * `const'.  It does not make sense for a `const' function to return
 287  * `void'.
 288  */
 289 #ifndef __attribute_const__
 290 # define __attribute_const__    /* unimplemented */
 291 #endif
 292
 293 /*
 294  * Tell gcc if a function is cold. The compiler will assume any path
 295  * directly leading to the call is unlikely.
 296  */
 297
 298 #ifndef __cold
 299 #define __cold
 300 #endif
 301
 302 /* Simple shorthand for a section definition */
 303 #ifndef __section
 304 # define __section(S) __attribute__ ((__section__(#S)))
 305 #endif
 306
 307 #ifndef __visible
 308 #define __visible
 309 #endif
 310
 311 /* Are two types/vars the same type (ignoring qualifiers)? */
 312 #ifndef __same_type
 313 # define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b))
 314 #endif
 315
 316 /* Is this type a native word size -- useful for atomic operations */
 317 #ifndef __native_word
 318 # define __native_word(t) (sizeof(t) == sizeof(int) || sizeof(t) == sizeof(long))
 319 #endif
 320
 321 /* Compile time object size, -1 for unknown */
 322 #ifndef __compiletime_object_size
 323 # define __compiletime_object_size(obj) -1
 324 #endif
 325 #ifndef __compiletime_warning
 326 # define __compiletime_warning(message)
 327 #endif
 328 #ifndef __compiletime_error
 329 # define __compiletime_error(message)
 330 /*
 331  * Sparse complains of variable sized arrays due to the temporary variable in
 332  * __compiletime_assert. Unfortunately we can't just expand it out to make
 333  * sparse see a constant array size without breaking compiletime_assert on old
 334  * versions of GCC (e.g. 4.2.4), so hide the array from sparse altogether.
 335  */
 336 # ifndef __CHECKER__
 337 #  define __compiletime_error_fallback(condition) \
 338         do { ((void)sizeof(char[1 - 2 * condition])); } while (0)
 339 # endif
 340 #endif
 341 #ifndef __compiletime_error_fallback
 342 # define __compiletime_error_fallback(condition) do { } while (0)
 343 #endif
 344
 345 #define __compiletime_assert(condition, msg, prefix, suffix)            \
 346         do {                                                            \
 347                 bool __cond = !(condition);                             \
 348                 extern void prefix ## suffix(void) __compiletime_error(msg); \
 349                 if (__cond)                                             \
 350                         prefix ## suffix();                             \
 351                 __compiletime_error_fallback(__cond);                   \
 352         } while (0)
 353
 354 #define _compiletime_assert(condition, msg, prefix, suffix) \
 355         __compiletime_assert(condition, msg, prefix, suffix)
 356
 357 /**
 358  * compiletime_assert - break build and emit msg if condition is false
 359  * @condition: a compile-time constant condition to check
 360  * @msg:       a message to emit if condition is false
 361  *
 362  * In tradition of POSIX assert, this macro will break the build if the
 363  * supplied condition is *false*, emitting the supplied error message if the
 364  * compiler has support to do so.
 365  */
 366 #define compiletime_assert(condition, msg) \
 367         _compiletime_assert(condition, msg, __compiletime_assert_, __LINE__)
 368
 369 #define compiletime_assert_atomic_type(t)                               \
 370         compiletime_assert(__native_word(t),                            \
 371                 "Need native word sized stores/loads for atomicity.")
 372
 373 /*
 374  * Prevent the compiler from merging or refetching accesses.  The compiler
 375  * is also forbidden from reordering successive instances of ACCESS_ONCE(),
 376  * but only when the compiler is aware of some particular ordering.  One way
 377  * to make the compiler aware of ordering is to put the two invocations of
 378  * ACCESS_ONCE() in different C statements.
 379  *
 380  * This macro does absolutely -nothing- to prevent the CPU from reordering,
 381  * merging, or refetching absolutely anything at any time.  Its main intended
 382  * use is to mediate communication between process-level code and irq/NMI
 383  * handlers, all running on the same CPU.
 384  */
 385 #define ACCESS_ONCE(x) (*(volatile typeof(x) *)&(x))
 386
 387 /* Ignore/forbid kprobes attach on very low level functions marked by this attribute: */
 388 #ifdef CONFIG_KPROBES
 389 # define __kprobes      __attribute__((__section__(".kprobes.text")))
 390 # define nokprobe_inline        __always_inline
 391 #else
 392 # define __kprobes
 393 # define nokprobe_inline        inline
 394 #endif
 395 #endif /* __LINUX_COMPILER_H */