blob: 0da5b187f1245e8c33fd659420f5e4dca82b9ead [file] [log] [blame]
Robert P. J. Day94f582f2007-10-16 23:26:11 -07001#ifndef __LINUX_COMPILER_H
2#error "Please don't include <linux/compiler-gcc.h> directly, include <linux/compiler.h> instead."
3#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07004
5/*
6 * Common definitions for all gcc versions go here.
7 */
8
9
10/* Optimization barrier */
11/* The "volatile" is due to gcc bugs */
12#define barrier() __asm__ __volatile__("": : :"memory")
13
Anton Blanchardc8d52462006-01-10 18:21:20 +110014/*
Andi Kleen85c210e2009-01-09 16:40:53 -080015 * This macro obfuscates arithmetic on a variable address so that gcc
16 * shouldn't recognize the original var, and make assumptions about it.
17 *
18 * This is needed because the C standard makes it undefined to do
19 * pointer arithmetic on "objects" outside their boundaries and the
20 * gcc optimizers assume this is the case. In particular they
21 * assume such arithmetic does not wrap.
22 *
23 * A miscompilation has been observed because of this on PPC.
24 * To work around it we hide the relationship of the pointer and the object
25 * using this macro.
26 *
Anton Blanchardc8d52462006-01-10 18:21:20 +110027 * Versions of the ppc64 compiler before 4.1 had a bug where use of
28 * RELOC_HIDE could trash r30. The bug can be worked around by changing
29 * the inline assembly constraint from =g to =r, in this particular
30 * case either is valid.
31 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#define RELOC_HIDE(ptr, off) \
33 ({ unsigned long __ptr; \
Anton Blanchardc8d52462006-01-10 18:21:20 +110034 __asm__ ("" : "=r"(__ptr) : "0"(ptr)); \
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 (typeof(ptr)) (__ptr + (off)); })
Andrew Mortona1365642006-01-08 01:04:09 -080036
Rusty Russellc5e631cf2007-05-06 14:51:05 -070037/* &a[0] degrades to a pointer: a different type from an array */
38#define __must_be_array(a) \
39 BUILD_BUG_ON_ZERO(__builtin_types_compatible_p(typeof(a), typeof(&a[0])))
Andrew Mortona1365642006-01-08 01:04:09 -080040
Ingo Molnar60a3cdd2008-03-03 12:38:52 +010041/*
Ingo Molnarae3a0062008-04-30 00:15:31 +020042 * Force always-inline if the user requests it so via the .config,
43 * or if gcc is too old:
Ingo Molnar60a3cdd2008-03-03 12:38:52 +010044 */
Ingo Molnar765c68b2008-04-09 11:03:37 +020045#if !defined(CONFIG_ARCH_SUPPORTS_OPTIMIZED_INLINING) || \
Ingo Molnarae3a0062008-04-30 00:15:31 +020046 !defined(CONFIG_OPTIMIZE_INLINING) || (__GNUC__ < 4)
Ingo Molnar60a3cdd2008-03-03 12:38:52 +010047# define inline inline __attribute__((always_inline))
48# define __inline__ __inline__ __attribute__((always_inline))
49# define __inline __inline __attribute__((always_inline))
50#endif
51
Andrew Mortona1365642006-01-08 01:04:09 -080052#define __deprecated __attribute__((deprecated))
Robert P. J. Day82ddcb02007-02-10 01:46:20 -080053#define __packed __attribute__((packed))
54#define __weak __attribute__((weak))
Uwe Kleine-König446c92b2009-03-12 18:03:16 +010055
56/*
57 * it doesn't make sense on ARM (currently the only user of __naked) to trace
58 * naked functions because then mcount is called without stack and frame pointer
59 * being set up and there is no chance to restore the lr register to the value
60 * before mcount was called.
Mikael Pettersson9c695202010-06-29 15:05:25 -070061 *
62 * The asm() bodies of naked functions often depend on standard calling conventions,
63 * therefore they must be noinline and noclone. GCC 4.[56] currently fail to enforce
64 * this, so we must do so ourselves. See GCC PR44290.
Uwe Kleine-König446c92b2009-03-12 18:03:16 +010065 */
Mikael Pettersson9c695202010-06-29 15:05:25 -070066#define __naked __attribute__((naked)) noinline __noclone notrace
Uwe Kleine-König446c92b2009-03-12 18:03:16 +010067
Robert P. J. Day82ddcb02007-02-10 01:46:20 -080068#define __noreturn __attribute__((noreturn))
Ralf Baechlee8c44312007-10-18 03:07:07 -070069
70/*
71 * From the GCC manual:
72 *
73 * Many functions have no effects except the return value and their
74 * return value depends only on the parameters and/or global
75 * variables. Such a function can be subject to common subexpression
76 * elimination and loop optimization just as an arithmetic operator
77 * would be.
78 * [...]
79 */
Robert P. J. Day82ddcb02007-02-10 01:46:20 -080080#define __pure __attribute__((pure))
81#define __aligned(x) __attribute__((aligned(x)))
82#define __printf(a,b) __attribute__((format(printf,a,b)))
Andrew Mortona1365642006-01-08 01:04:09 -080083#define noinline __attribute__((noinline))
Andrew Mortona1365642006-01-08 01:04:09 -080084#define __attribute_const__ __attribute__((__const__))
David Rientjes0d7ebbb2007-05-09 02:35:27 -070085#define __maybe_unused __attribute__((unused))
Li Zefan7b2a3512009-11-02 08:50:52 +080086#define __always_unused __attribute__((unused))
Linus Torvaldsf153b822009-01-02 09:23:03 -080087
88#define __gcc_header(x) #x
89#define _gcc_header(x) __gcc_header(linux/compiler-gcc##x.h)
90#define gcc_header(x) _gcc_header(x)
91#include gcc_header(__GNUC__)
Mikael Pettersson9c695202010-06-29 15:05:25 -070092
93#if !defined(__noclone)
94#define __noclone /* not needed */
95#endif