fb867681718eef7657e9b8977b6f4bcac1cf1a77
[linux-2.6.git] / include / linux / compiler.h
1 #ifndef __LINUX_COMPILER_H
2 #define __LINUX_COMPILER_H
3
4 #ifdef __CHECKER__
5 # define __user         __attribute__((noderef, address_space(1)))
6 # define __kernel       /* default address space */
7 # define __safe         __attribute__((safe))
8 # define __force        __attribute__((force))
9 #else
10 # define __user
11 # define __kernel
12 # define __safe
13 # define __force
14 #endif
15
16 #ifdef __KERNEL__
17
18 #ifndef __ASSEMBLY__
19 #if __GNUC__ > 3
20 # include <linux/compiler-gcc+.h>       /* catch-all for GCC 4, 5, etc. */
21 #elif __GNUC__ == 3
22 # include <linux/compiler-gcc3.h>
23 #elif __GNUC__ == 2
24 # include <linux/compiler-gcc2.h>
25 #else
26 # error Sorry, your compiler is too old/not recognized.
27 #endif
28 #endif
29
30 /* Intel compiler defines __GNUC__. So we will overwrite implementations
31  * coming from above header files here
32  */
33 #ifdef __INTEL_COMPILER
34 # include <linux/compiler-intel.h>
35 #endif
36
37 /*
38  * Generic compiler-dependent macros required for kernel
39  * build go below this comment. Actual compiler/compiler version
40  * specific implementations come from the above header files
41  */
42
43 #define likely(x)       __builtin_expect(!!(x), 1)
44 #define unlikely(x)     __builtin_expect(!!(x), 0)
45
46 #ifndef noinline
47 #define noinline
48 #endif
49
50 /* Optimization barrier */
51 #ifndef barrier
52 # define barrier() __memory_barrier()
53 #endif
54
55 #ifndef RELOC_HIDE
56 # define RELOC_HIDE(ptr, off)                                   \
57   ({ unsigned long __ptr;                                       \
58      __ptr = (unsigned long) (ptr);                             \
59     (typeof(ptr)) (__ptr + (off)); })
60 #endif
61
62 #endif /* __KERNEL__ */
63
64 /*
65  * Allow us to mark functions as 'deprecated' and have gcc emit a nice
66  * warning for each use, in hopes of speeding the functions removal.
67  * Usage is:
68  *              int __deprecated foo(void)
69  */
70 #ifndef __deprecated
71 # define __deprecated           /* unimplemented */
72 #endif
73
74 #ifndef __must_check
75 #define __must_check
76 #endif
77
78 /*
79  * Allow us to avoid 'defined but not used' warnings on functions and data,
80  * as well as force them to be emitted to the assembly file.
81  *
82  * As of gcc 3.3, static functions that are not marked with attribute((used))
83  * may be elided from the assembly file.  As of gcc 3.3, static data not so
84  * marked will not be elided, but this may change in a future gcc version.
85  *
86  * In prior versions of gcc, such functions and data would be emitted, but
87  * would be warned about except with attribute((unused)).
88  */
89 #ifndef __attribute_used__
90 # define __attribute_used__     /* unimplemented */
91 #endif
92
93 /*
94  * From the GCC manual:
95  *
96  * Many functions have no effects except the return value and their
97  * return value depends only on the parameters and/or global
98  * variables.  Such a function can be subject to common subexpression
99  * elimination and loop optimization just as an arithmetic operator
100  * would be.
101  * [...]
102  */
103 #ifndef __attribute_pure__
104 # define __attribute_pure__     /* unimplemented */
105 #endif
106
107 /*
108  * From the GCC manual:
109  *
110  * Many functions do not examine any values except their arguments,
111  * and have no effects except the return value.  Basically this is
112  * just slightly more strict class than the `pure' attribute above,
113  * since function is not allowed to read global memory.
114  *
115  * Note that a function that has pointer arguments and examines the
116  * data pointed to must _not_ be declared `const'.  Likewise, a
117  * function that calls a non-`const' function usually must not be
118  * `const'.  It does not make sense for a `const' function to return
119  * `void'.
120  */
121 #ifndef __attribute_const__
122 # define __attribute_const__    /* unimplemented */
123 #endif
124
125 #ifndef noinline
126 #define noinline
127 #endif
128
129 #endif /* __LINUX_COMPILER_H */