[linux-2.6-block.git] / include / linux / compiler-gcc.h

#ifndef __LINUX_COMPILER_H
#error "Please don't include <linux/compiler-gcc.h> directly, include <linux/compiler.h> instead."
#endif

/*
 * Common definitions for all gcc versions go here.
 */


/* Optimization barrier */
/* The "volatile" is due to gcc bugs */
#define barrier() __asm__ __volatile__("": : :"memory")

/*
 * This macro obfuscates arithmetic on a variable address so that gcc
 * shouldn't recognize the original var, and make assumptions about it.
 *
 * This is needed because the C standard makes it undefined to do
 * pointer arithmetic on "objects" outside their boundaries and the
 * gcc optimizers assume this is the case. In particular they
 * assume such arithmetic does not wrap.
 *
 * A miscompilation has been observed because of this on PPC.
 * To work around it we hide the relationship of the pointer and the object
 * using this macro.
 *
 * Versions of the ppc64 compiler before 4.1 had a bug where use of
 * RELOC_HIDE could trash r30. The bug can be worked around by changing
 * the inline assembly constraint from =g to =r, in this particular
 * case either is valid.
 */
#define RELOC_HIDE(ptr, off)					\
  ({ unsigned long __ptr;					\
    __asm__ ("" : "=r"(__ptr) : "0"(ptr));		\
    (typeof(ptr)) (__ptr + (off)); })

#ifdef __CHECKER__
#define __must_be_array(arr) 0
#else
/* &a[0] degrades to a pointer: a different type from an array */
#define __must_be_array(a) BUILD_BUG_ON_ZERO(__same_type((a), &(a)[0]))
#endif

/*
 * Force always-inline if the user requests it so via the .config,
 * or if gcc is too old:
 */
#if !defined(CONFIG_ARCH_SUPPORTS_OPTIMIZED_INLINING) || \
    !defined(CONFIG_OPTIMIZE_INLINING) || (__GNUC__ < 4)
# define inline		inline		__attribute__((always_inline))
# define __inline__	__inline__	__attribute__((always_inline))
# define __inline	__inline	__attribute__((always_inline))
#endif

#define __deprecated			__attribute__((deprecated))
#define __packed			__attribute__((packed))
#define __weak				__attribute__((weak))

/*
 * it doesn't make sense on ARM (currently the only user of __naked) to trace
 * naked functions because then mcount is called without stack and frame pointer
 * being set up and there is no chance to restore the lr register to the value
 * before mcount was called.
 *
 * The asm() bodies of naked functions often depend on standard calling conventions,
 * therefore they must be noinline and noclone.  GCC 4.[56] currently fail to enforce
 * this, so we must do so ourselves.  See GCC PR44290.
 */
#define __naked				__attribute__((naked)) noinline __noclone notrace

#define __noreturn			__attribute__((noreturn))

/*
 * From the GCC manual:
 *
 * Many functions have no effects except the return value and their
 * return value depends only on the parameters and/or global
 * variables.  Such a function can be subject to common subexpression
 * elimination and loop optimization just as an arithmetic operator
 * would be.
 * [...]
 */
#define __pure				__attribute__((pure))
#define __aligned(x)			__attribute__((aligned(x)))
#define __printf(a,b)			__attribute__((format(printf,a,b)))
#define  noinline			__attribute__((noinline))
#define __attribute_const__		__attribute__((__const__))
#define __maybe_unused			__attribute__((unused))
#define __always_unused			__attribute__((unused))

#define __gcc_header(x) #x
#define _gcc_header(x) __gcc_header(linux/compiler-gcc##x.h)
#define gcc_header(x) _gcc_header(x)
#include gcc_header(__GNUC__)

#if !defined(__noclone)
#define __noclone	/* not needed */
#endif

/*
 * A trick to suppress uninitialized variable warning without generating any
 * code
 */
#define uninitialized_var(x) x = x

#define __always_inline		inline __attribute__((always_inline))
Commit	Line	Data
94f582f8 RD	1	#ifndef __LINUX_COMPILER_H
	2	#error "Please don't include <linux/compiler-gcc.h> directly, include <linux/compiler.h> instead."
	3	#endif
1da177e4 LT	4
	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
c8d52465	14	/*
85c210ed AK	15	* 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	*
c8d52465 AB	27	* 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	*/
1da177e4 LT	32	#define RELOC_HIDE(ptr, off) \
1da177e4 LT	33	({ unsigned long __ptr; \
c8d52465	34	__asm__ ("" : "=r"(__ptr) : "0"(ptr)); \
1da177e4	35	(typeof(ptr)) (__ptr + (off)); })
a1365647	36
5bd7e6a3 KM	37	#ifdef __CHECKER__
	38	#define __must_be_array(arr) 0
	39	#else
c5e631cf	40	/* &a[0] degrades to a pointer: a different type from an array */
ea6b101d	41	#define __must_be_array(a) BUILD_BUG_ON_ZERO(__same_type((a), &(a)[0]))
5bd7e6a3	42	#endif
a1365647	43
60a3cdd0	44	/*
ae3a0064 IM	45	* Force always-inline if the user requests it so via the .config,
ae3a0064 IM	46	* or if gcc is too old:
60a3cdd0	47	*/
765c68bd	48	#if !defined(CONFIG_ARCH_SUPPORTS_OPTIMIZED_INLINING) \|\| \
ae3a0064	49	!defined(CONFIG_OPTIMIZE_INLINING) \|\| (__GNUC__ < 4)
60a3cdd0 IM	50	# define inline inline __attribute__((always_inline))
	51	# define __inline__ __inline__ __attribute__((always_inline))
	52	# define __inline __inline __attribute__((always_inline))
	53	#endif
	54
a1365647	55	#define __deprecated __attribute__((deprecated))
82ddcb04 RD	56	#define __packed __attribute__((packed))
82ddcb04 RD	57	#define __weak __attribute__((weak))
446c92b2 UKK	58
	59	/*
	60	* it doesn't make sense on ARM (currently the only user of __naked) to trace
	61	* naked functions because then mcount is called without stack and frame pointer
	62	* being set up and there is no chance to restore the lr register to the value
	63	* before mcount was called.
9c695203 MP	64	*
	65	* The asm() bodies of naked functions often depend on standard calling conventions,
	66	* therefore they must be noinline and noclone. GCC 4.[56] currently fail to enforce
	67	* this, so we must do so ourselves. See GCC PR44290.
446c92b2	68	*/
9c695203	69	#define __naked __attribute__((naked)) noinline __noclone notrace
446c92b2	70
82ddcb04	71	#define __noreturn __attribute__((noreturn))
e8c44319 RB	72
	73	/*
	74	* From the GCC manual:
	75	*
	76	* Many functions have no effects except the return value and their
	77	* return value depends only on the parameters and/or global
	78	* variables. Such a function can be subject to common subexpression
	79	* elimination and loop optimization just as an arithmetic operator
	80	* would be.
	81	* [...]
	82	*/
82ddcb04 RD	83	#define __pure __attribute__((pure))
	84	#define __aligned(x) __attribute__((aligned(x)))
	85	#define __printf(a,b) __attribute__((format(printf,a,b)))
a1365647	86	#define noinline __attribute__((noinline))
a1365647	87	#define __attribute_const__ __attribute__((__const__))
0d7ebbbc	88	#define __maybe_unused __attribute__((unused))
7b2a3513	89	#define __always_unused __attribute__((unused))
f153b821 LT	90
	91	#define __gcc_header(x) #x
	92	#define _gcc_header(x) __gcc_header(linux/compiler-gcc##x.h)
	93	#define gcc_header(x) _gcc_header(x)
	94	#include gcc_header(__GNUC__)
9c695203 MP	95
	96	#if !defined(__noclone)
	97	#define __noclone /* not needed */
	98	#endif
c837fb37 BP	99
	100	/*
	101	* A trick to suppress uninitialized variable warning without generating any
	102	* code
	103	*/
	104	#define uninitialized_var(x) x = x
	105
	106	#define __always_inline inline __attribute__((always_inline))