msvc.mak: (hopefully) make external dependencies work with NMAKE
[nasm.git] / include / compiler.h
blobb074b478f754161007b98d1cb0e0c609f8d8c1c5
1 /* ----------------------------------------------------------------------- *
2 *
3 * Copyright 2007-2017 The NASM Authors - All Rights Reserved
4 * See the file AUTHORS included with the NASM distribution for
5 * the specific copyright holders.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following
9 * conditions are met:
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 * ----------------------------------------------------------------------- */
35 * compiler.h
37 * Compiler-specific macros for NASM. Feel free to add support for
38 * other compilers in here.
40 * This header file should be included before any other header.
43 #ifndef NASM_COMPILER_H
44 #define NASM_COMPILER_H 1
47 * At least DJGPP and Cygwin have broken header files if __STRICT_ANSI__
48 * is defined.
50 #ifdef __GNUC__
51 # undef __STRICT_ANSI__
52 #endif
54 /* On Microsoft platforms we support multibyte character sets in filenames */
55 #define _MBCS 1
57 #ifdef HAVE_CONFIG_H
58 # include "config/config.h"
59 #elif defined(_MSC_VER) && (_MSC_VER >= 1310)
60 # include "config/msvc.h"
61 #elif defined(__WATCOMC__)
62 # include "config/watcom.h"
63 #else
64 # include "config/unknown.h"
65 #endif /* Configuration file */
67 /* This is required to get the standard <inttypes.h> macros when compiling
68 with a C++ compiler. This must be defined *before* <inttypes.h> is
69 included, directly or indirectly. */
70 #define __STDC_CONSTANT_MACROS 1
71 #define __STDC_LIMIT_MACROS 1
72 #define __STDC_FORMAT_MACROS 1
74 #ifdef HAVE_INTTYPES_H
75 # include <inttypes.h>
76 #else
77 # include "nasmint.h"
78 #endif
80 #include <assert.h>
81 #include <stddef.h>
82 #include <stdarg.h>
83 #include <stdio.h>
84 #include <limits.h>
86 #ifdef HAVE_SYS_TYPES_H
87 # include <sys/types.h>
88 #endif
90 #ifdef HAVE_ENDIAN_H
91 # include <endian.h>
92 #elif defined(HAVE_SYS_ENDIAN_H)
93 # include <sys/endian.h>
94 #elif defined(HAVE_MACHINE_ENDIAN_H)
95 # include <machine/endian.h>
96 #endif
99 * If we have BYTE_ORDER defined, or the compiler provides
100 * __BIG_ENDIAN__ or __LITTLE_ENDIAN__, trust it over what autoconf
101 * came up with, especially since autoconf obviously can't figure
102 * things out for a universal compiler.
104 #if defined(__BIG_ENDIAN__) && !defined(__LITTLE_ENDIAN__)
105 # undef WORDS_LITTLEENDIAN
106 # undef WORDS_BIGENDIAN
107 # define WORDS_BIGENDIAN 1
108 #elif defined(__LITTLE_ENDIAN__) && !defined(__BIG_ENDIAN__)
109 # undef WORDS_LITTLEENDIAN
110 # undef WORDS_BIGENDIAN
111 # define WORDS_LITTLEENDIAN 1
112 #elif defined(BYTE_ORDER) && defined(LITTLE_ENDIAN) && defined(BIG_ENDIAN)
113 # undef WORDS_LITTLEENDIAN
114 # undef WORDS_BIGENDIAN
115 # if BYTE_ORDER == LITTLE_ENDIAN
116 # define WORDS_LITTLEENDIAN 1
117 # elif BYTE_ORDER == BIG_ENDIAN
118 # define WORDS_BIGENDIAN 1
119 # endif
120 #endif
123 * Define this to 1 for faster performance if this is a littleendian
124 * platform *and* it can do arbitrary unaligned memory references. It
125 * is safe to leave it defined to 0 even if that is true.
127 #if defined(__386__) || defined(__i386__) || defined(__x86_64__) \
128 || defined(_M_IX86) || defined(_M_X64)
129 # define X86_MEMORY 1
130 # undef WORDS_BIGENDIAN
131 # undef WORDS_LITTLEENDIAN
132 # define WORDS_LITTLEENDIAN 1
133 #else
134 # define X86_MEMORY 0
135 #endif
137 /* Some versions of MSVC have these only with underscores in front */
138 #ifndef HAVE_SNPRINTF
139 # ifdef HAVE__SNPRINTF
140 # define snprintf _snprintf
141 # else
142 int snprintf(char *, size_t, const char *, ...);
143 # endif
144 #endif
146 #ifndef HAVE_VSNPRINTF
147 # ifdef HAVE__VSNPRINTF
148 # define vsnprintf _vsnprintf
149 # else
150 int vsnprintf(char *, size_t, const char *, va_list);
151 # endif
152 #endif
154 #if !defined(HAVE_STRLCPY) || !HAVE_DECL_STRLCPY
155 size_t strlcpy(char *, const char *, size_t);
156 #endif
158 #ifndef __cplusplus /* C++ has false, true, bool as keywords */
159 # ifdef HAVE_STDBOOL_H
160 # include <stdbool.h>
161 # elif defined(HAVE__BOOL)
162 # typedef _Bool bool
163 # define false 0
164 # define true 1
165 # else
166 /* This is sort of dangerous, since casts will behave different than
167 casting to the standard boolean type. Always use !!, not (bool). */
168 typedef enum bool { false, true } bool;
169 # endif
170 #endif
172 /* Provide a substitute for offsetof() if we don't have one. This
173 variant works on most (but not *all*) systems... */
174 #ifndef offsetof
175 # define offsetof(t,m) ((size_t)&(((t *)0)->m))
176 #endif
178 /* The container_of construct: if p is a pointer to member m of
179 container class c, then return a pointer to the container of which
180 *p is a member. */
181 #ifndef container_of
182 # define container_of(p, c, m) ((c *)((char *)(p) - offsetof(c,m)))
183 #endif
185 /* Some misguided platforms hide the defs for these */
186 #if defined(HAVE_STRCASECMP) && !HAVE_DECL_STRCASECMP
187 int strcasecmp(const char *, const char *);
188 #endif
190 #if defined(HAVE_STRICMP) && !HAVE_DECL_STRICMP
191 int stricmp(const char *, const char *);
192 #endif
194 #if defined(HAVE_STRNCASECMP) && !HAVE_DECL_STRNCASECMP
195 int strncasecmp(const char *, const char *, size_t);
196 #endif
198 #if defined(HAVE_STRNICMP) && !HAVE_DECL_STRNICMP
199 int strnicmp(const char *, const char *, size_t);
200 #endif
202 #if defined(HAVE_STRSEP) && !HAVE_DECL_STRSEP
203 char *strsep(char **, const char *);
204 #endif
206 #if !HAVE_DECL_STRNLEN
207 size_t strnlen(const char *s, size_t maxlen);
208 #endif
211 * Hack to support external-linkage inline functions
213 #ifdef __GNUC__
214 # ifdef __GNUC_STDC_INLINE__
215 # define HAVE_STDC_INLINE
216 # else
217 # define HAVE_GNU_INLINE
218 # endif
219 #elif defined(__STDC_VERSION__)
220 # if __STDC_VERSION__ >= 199901L
221 # define HAVE_STDC_INLINE
222 # endif
223 #endif
225 #ifdef HAVE_STDC_INLINE
226 # define extern_inline inline
227 #elif defined(HAVE_GNU_INLINE)
228 # define extern_inline extern inline
229 #else
230 # define inline_prototypes
231 #endif
234 * Hints to the compiler that a particular branch of code is more or
235 * less likely to be taken.
237 #if HAVE___BUILTIN_EXPECT
238 # define likely(x) __builtin_expect(!!(x), 1)
239 # define unlikely(x) __builtin_expect(!!(x), 0)
240 #else
241 # define likely(x) (!!(x))
242 # define unlikely(x) (!!(x))
243 #endif
246 * Hints about malloc-like functions that never return NULL
248 #ifdef HAVE_FUNC_ATTRIBUTE_RETURNS_NONNULL
249 # define never_null __attribute__((returns_nonnull))
250 #else
251 # define never_null
252 #endif
254 #ifdef HAVE_FUNC_ATTRIBUTE_MALLOC
255 # define safe_alloc never_null __attribute__((malloc))
256 #else
257 # define safe_alloc
258 #endif
260 #ifdef HAVE_FUNC_ATTRIBUTE_ALLOC_SIZE
261 # define safe_malloc(s) safe_alloc __attribute__((alloc_size(s)))
262 # define safe_malloc2(s1,s2) safe_alloc __attribute__((alloc_size(s1,s2)))
263 # define safe_realloc(s) never_null __attribute__((alloc_size(s)))
264 #else
265 # define safe_malloc(s) safe_alloc
266 # define safe_malloc2(s1,s2) safe_alloc
267 # define safe_realloc(s) never_null
268 #endif
271 * How to tell the compiler that a function doesn't return
273 #ifdef HAVE_STDNORETURN_H
274 # include <stdnoreturn.h>
275 # define no_return noreturn void
276 #elif defined(HAVE_FUNC_ATTRIBUTE_NORETURN)
277 # define no_return void __attribute__((noreturn))
278 #elif defined(_MSC_VER)
279 # define no_return __declspec(noreturn) void
280 #else
281 # define no_return void
282 #endif
285 * How to tell the compiler that a function takes a printf-like string
287 #ifdef HAVE_FUNC_ATTRIBUTE_FORMAT
288 # define printf_func(fmt, list) __attribute__((format(printf, fmt, list)))
289 #else
290 # define printf_func(fmt, list)
291 #endif
294 * How to tell the compiler that a function is pure arithmetic
296 #ifdef HAVE_FUNC_ATTRIBUTE_CONST
297 # define const_func __attribute__((const))
298 #else
299 # define const_func
300 #endif
303 * This function has no side effects, but depends on its arguments,
304 * memory pointed to by its arguments, or global variables.
305 * NOTE: functions that return a value by modifying memory pointed to
306 * by a pointer argument are *NOT* considered pure.
308 #ifdef HAVE_FUNC_ATTRIBUTE_PURE
309 # define pure_func __attribute__((pure))
310 #else
311 # define pure_func
312 #endif
314 /* Watcom doesn't handle switch statements with 64-bit types, hack around it */
315 #ifdef __WATCOMC__
316 # define BOGUS_CASE 0x76543210
318 static inline unsigned int watcom_switch_hack(uint64_t x)
320 if (x > (uint64_t)UINT_MAX)
321 return BOGUS_CASE;
322 else
323 return (unsigned int)x;
326 # define switch(x) switch(sizeof(x) > sizeof(unsigned int) \
327 ? watcom_switch_hack(x) : (unsigned int)(x))
329 /* This is to make sure BOGUS_CASE doesn't conflict with anything real... */
330 # define default case BOGUS_CASE: default
331 #endif
333 #endif /* NASM_COMPILER_H */