102deb73d2a1a4a72aa90c58b6d1128f21cd75df
[wimlib] / include / wimlib / compiler.h
1 /*
2  * compiler.h
3  *
4  * Compiler-specific definitions.  Currently, only GCC and clang are supported.
5  *
6  * The author dedicates this file to the public domain.
7  * You can do whatever you want with this file.
8  */
9
10 #ifndef _WIMLIB_COMPILER_H
11 #define _WIMLIB_COMPILER_H
12
13 /* Is the compiler GCC of the specified version or later?  This always returns
14  * false for clang, since clang is "frozen" at GNUC 4.2.  The __has_*
15  * feature-test macros should be used to detect clang functionality instead.  */
16 #define GCC_PREREQ(major, minor)                                        \
17         (!defined(__clang__) && !defined(__INTEL_COMPILER) &&           \
18          (__GNUC__ > major ||                                           \
19           (__GNUC__ == major && __GNUC_MINOR__ >= minor)))
20
21 /* Feature-test macros defined by recent versions of clang.  */
22 #ifndef __has_attribute
23 #  define __has_attribute(attribute)    0
24 #endif
25 #ifndef __has_feature
26 #  define __has_feature(feature)        0
27 #endif
28 #ifndef __has_builtin
29 #  define __has_builtin(builtin)        0
30 #endif
31
32 /* Declare that the annotated function should be exported from the shared
33  * library (or DLL).  */
34 #ifdef __WIN32__
35 #  define WIMLIBAPI __declspec(dllexport)
36 #else
37 #  define WIMLIBAPI __attribute__((visibility("default")))
38 #endif
39
40 /* Declare that the annotated function should be inlined.  Currently, we force
41  * the compiler to honor this because we use 'inline' in highly tuned code, e.g.
42  * compression codecs.  */
43 #define inline                  inline __attribute__((always_inline))
44
45 /* Declare that the annotated function should *not* be inlined.  */
46 #define noinline                __attribute__((noinline))
47
48 /* Functionally the same as 'noinline', but documents that the reason for not
49  * inlining is to prevent the annotated function from being inlined into a
50  * recursive function, thereby increasing its stack usage.  */
51 #define noinline_for_stack      noinline
52
53 /* Hint that the expression is usually true.  */
54 #define likely(expr)            __builtin_expect(!!(expr), 1)
55
56 /* Hint that the expression is usually false.  */
57 #define unlikely(expr)          __builtin_expect(!!(expr), 0)
58
59 /* Prefetch into L1 cache for read.  */
60 #define prefetchr(addr)         __builtin_prefetch((addr), 0)
61
62 /* Prefetch into L1 cache for write.  */
63 #define prefetchw(addr)         __builtin_prefetch((addr), 1)
64
65 /* Declare that the members of the annotated struct are tightly packed, and the
66  * struct itself may be misaligned.  */
67 #define _packed_attribute       __attribute__((packed))
68
69 /* Declare that the annotated variable, or variables of the annotated type, are
70  * to be aligned on n-byte boundaries.  */
71 #define _aligned_attribute(n)   __attribute__((aligned(n)))
72
73 /* Declare that pointers to the annotated type may alias other pointers.  */
74 #define _may_alias_attribute    __attribute__((may_alias))
75
76 /* Hint that the annotated function is rarely called.  */
77 #if GCC_PREREQ(4, 4) || __has_attribute(cold)
78 #  define _cold_attribute       __attribute__((cold))
79 #else
80 #  define _cold_attribute
81 #endif
82
83 /* Hint that the annotated function is malloc-like: any non-null pointer it
84  * returns will not alias any pointer previously in use by the program.  */
85 #define _malloc_attribute       __attribute__((malloc))
86
87 /* TODO: _format_attribute is currently ignored.  */
88 #define _format_attribute(type, format_str, format_start)
89
90 /* Hint that the annotated function is intentionally not used.  This might be
91  * the case if the function contains only static assertions.  */
92 #define _unused_attribute       __attribute__((unused))
93
94 /* Endianness definitions.  Either CPU_IS_BIG_ENDIAN or CPU_IS_LITTLE_ENDIAN is
95  * set to 1.  The other is set to 0.  Note that newer gcc supports
96  * __BYTE_ORDER__ for easily determining the endianness; older gcc doesn't.  In
97  * the latter case we fall back to a configure-time check.  */
98 #ifdef __BYTE_ORDER__
99 #  define CPU_IS_BIG_ENDIAN     (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
100 #elif defined(HAVE_CONFIG_H)
101 #  include "config.h"
102 #  ifdef WORDS_BIGENDIAN
103 #    define CPU_IS_BIG_ENDIAN 1
104 #  else
105 #    define CPU_IS_BIG_ENDIAN 0
106 #  endif
107 #endif
108 #define CPU_IS_LITTLE_ENDIAN (!CPU_IS_BIG_ENDIAN)
109
110 #if defined(__x86_64__) || defined(__i386__)
111 #  define UNALIGNED_ACCESS_SPEED 3
112 #elif defined(__ARM_FEATURE_UNALIGNED) && (__ARM_FEATURE_UNALIGNED == 1)
113 #  define UNALIGNED_ACCESS_SPEED 2
114 #else
115 #  define UNALIGNED_ACCESS_SPEED 0
116 #endif
117
118 /* Get the type of the specified expression.  */
119 #define typeof     __typeof__
120
121 /* Get the minimum of two variables, without multiple evaluation.  */
122 #ifndef min
123 #  define min(a, b)  ({ typeof(a) _a = (a); typeof(b) _b = (b); \
124                         (_a < _b) ? _a : _b; })
125 #endif
126
127 /* Get the maximum of two variables, without multiple evaluation.  */
128 #ifndef max
129 #  define max(a, b)  ({ typeof(a) _a = (a); typeof(b) _b = (b); \
130                         (_a > _b) ? _a : _b; })
131 #endif
132
133 /* Swap the values of two variables, without multiple evaluation.  */
134 #ifndef swap
135 #  define swap(a, b) ({ typeof(a) _a = (a); (a) = (b); (b) = _a; })
136 #endif
137
138 /* (Optional) Efficiently swap the bytes of a 16-bit integer.  */
139 #if GCC_PREREQ(4, 8) || __has_builtin(__builtin_bswap16)
140 #  define compiler_bswap16 __builtin_bswap16
141 #endif
142
143 /* (Optional) Efficiently swap the bytes of a 32-bit integer.  */
144 #if GCC_PREREQ(4, 3) || __has_builtin(__builtin_bswap32)
145 #  define compiler_bswap32 __builtin_bswap32
146 #endif
147
148 /* (Optional) Efficiently swap the bytes of a 64-bit integer.  */
149 #if GCC_PREREQ(4, 3) || __has_builtin(__builtin_bswap64)
150 #  define compiler_bswap64 __builtin_bswap64
151 #endif
152
153 /* (Optional) Find Last Set bit and Find First Set bit macros.  */
154 #define compiler_fls32(n)       (31 - __builtin_clz(n))
155 #define compiler_fls64(n)       (63 - __builtin_clzll(n))
156 #define compiler_ffs32(n)       __builtin_ctz(n)
157 #define compiler_ffs64(n)       __builtin_ctzll(n)
158
159 /* Optional definitions for checking with 'sparse'.  */
160 #ifdef __CHECKER__
161 #  define _bitwise_attr __attribute__((bitwise))
162 #  define _force_attr   __attribute__((force))
163 #else
164 #  define _bitwise_attr
165 #  define _force_attr
166 #endif
167
168 /* STATIC_ASSERT() - verify the truth of an expression at compilation time.  */
169 #if __STDC_VERSION__ >= 201112L
170 #  define STATIC_ASSERT(expr)   _Static_assert((expr), "")
171 #else
172 #  define STATIC_ASSERT(expr)   ((void)sizeof(char[1 - 2 * !(expr)]))
173 #endif
174
175 #define CONCAT_IMPL(s1, s2)     s1##s2
176
177 /* CONCAT() - concatenate two tokens at preprocessing time.  */
178 #define CONCAT(s1, s2)          CONCAT_IMPL(s1, s2)
179
180 #endif /* _WIMLIB_COMPILER_H */