xref: /freebsd/sys/compat/linuxkpi/common/include/linux/compiler.h (revision 6580f5c38dd5b01aeeaed16b370f1a12423437f0)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013-2016 Mellanox Technologies, Ltd.
6  * Copyright (c) 2015 François Tigeot
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice unmodified, this list of conditions, and the following
14  *    disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 #ifndef	_LINUXKPI_LINUX_COMPILER_H_
31 #define	_LINUXKPI_LINUX_COMPILER_H_
32 
33 #include <sys/cdefs.h>
34 
35 #define __user
36 #define __kernel
37 #define __safe
38 #define __force
39 #define __nocast
40 #define __iomem
41 #define __chk_user_ptr(x)		((void)0)
42 #define __chk_io_ptr(x)			((void)0)
43 #define __builtin_warning(x, y...)	(1)
44 #define __acquires(x)
45 #define __releases(x)
46 #define __acquire(x)			do { } while (0)
47 #define __release(x)			do { } while (0)
48 #define __cond_lock(x,c)		(c)
49 #define	__bitwise
50 #define __devinitdata
51 #define	__deprecated
52 #define __init
53 #define	__initconst
54 #define	__devinit
55 #define	__devexit
56 #define __exit
57 #define	__rcu
58 #define	__percpu
59 #define	__weak __weak_symbol
60 #define	__malloc
61 #define	__attribute_const__		__attribute__((__const__))
62 #undef __always_inline
63 #define	__always_inline			inline
64 #define	noinline			__noinline
65 #define	noinline_for_stack		__noinline
66 #define	____cacheline_aligned		__aligned(CACHE_LINE_SIZE)
67 #define	____cacheline_aligned_in_smp	__aligned(CACHE_LINE_SIZE)
68 #define	fallthrough			/* FALLTHROUGH */ do { } while(0)
69 
70 #if __has_attribute(__nonstring__)
71 #define	__nonstring			__attribute__((__nonstring__))
72 #else
73 #define	__nonstring
74 #endif
75 #if __has_attribute(__counted_by__)
76 #define	__counted_by(_x)		__attribute__((__counted_by__(_x)))
77 #else
78 #define	__counted_by(_x)
79 #endif
80 
81 #define	likely(x)			__builtin_expect(!!(x), 1)
82 #define	unlikely(x)			__builtin_expect(!!(x), 0)
83 #define typeof(x)			__typeof(x)
84 
85 #define	uninitialized_var(x)		x = x
86 #define	__maybe_unused			__unused
87 #define	__always_unused			__unused
88 #define	__must_check			__result_use_check
89 
90 #define	__printf(a,b)			__printflike(a,b)
91 
92 #define	barrier()			__asm__ __volatile__("": : :"memory")
93 
94 #define	lower_32_bits(n)		((u32)(n))
95 #define	upper_32_bits(n)		((u32)(((n) >> 16) >> 16))
96 
97 #define	___PASTE(a,b) a##b
98 #define	__PASTE(a,b) ___PASTE(a,b)
99 
100 #define	WRITE_ONCE(x,v) do {		\
101 	barrier();			\
102 	(*(volatile __typeof(x) *)(uintptr_t)&(x)) = (v); \
103 	barrier();			\
104 } while (0)
105 
106 #define	READ_ONCE(x) ({			\
107 	__typeof(x) __var = ({		\
108 		barrier();		\
109 		(*(const volatile __typeof(x) *)&(x)); \
110 	});				\
111 	barrier();			\
112 	__var;				\
113 })
114 
115 #define	lockless_dereference(p) READ_ONCE(p)
116 
117 #define	_AT(T,X)	((T)(X))
118 
119 #define	__same_type(a, b)	__builtin_types_compatible_p(typeof(a), typeof(b))
120 #define	__must_be_array(a)	__same_type(a, &(a)[0])
121 
122 #define	sizeof_field(_s, _m)	sizeof(((_s *)0)->_m)
123 
124 #define is_signed_type(t)	((t)-1 < (t)1)
125 #define is_unsigned_type(t)	((t)-1 > (t)1)
126 
127 #endif	/* _LINUXKPI_LINUX_COMPILER_H_ */
128