blob: c068b72d7900f21f595234aec519d2d42bc9779a [file] [log] [blame]
H. Peter Anvinc1494ac2007-04-13 19:58:42 +00001/* ----------------------------------------------------------------------- *
H. Peter Anvin9e6747c2009-06-28 17:13:04 -07002 *
H. Peter Anvinbe01d492017-02-23 17:25:31 -08003 * Copyright 2007-2017 The NASM Authors - All Rights Reserved
H. Peter Anvin9e6747c2009-06-28 17:13:04 -07004 * See the file AUTHORS included with the NASM distribution for
5 * the specific copyright holders.
H. Peter Anvinc1494ac2007-04-13 19:58:42 +00006 *
H. Peter Anvin9e6747c2009-06-28 17:13:04 -07007 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following
9 * conditions are met:
H. Peter Anvinc1494ac2007-04-13 19:58:42 +000010 *
H. Peter Anvin9e6747c2009-06-28 17:13:04 -070011 * * 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.
17 *
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.
H. Peter Anvinc1494ac2007-04-13 19:58:42 +000031 *
32 * ----------------------------------------------------------------------- */
33
34/*
35 * compiler.h
36 *
37 * Compiler-specific macros for NASM. Feel free to add support for
38 * other compilers in here.
H. Peter Anvinfe501952007-10-02 21:53:51 -070039 *
40 * This header file should be included before any other header.
H. Peter Anvinc1494ac2007-04-13 19:58:42 +000041 */
42
H. Peter Anvinfe501952007-10-02 21:53:51 -070043#ifndef NASM_COMPILER_H
44#define NASM_COMPILER_H 1
H. Peter Anvinc40f89e2007-04-13 20:06:41 +000045
H. Peter Anvin2fc232b2016-07-14 13:51:01 -070046/*
47 * At least DJGPP and Cygwin have broken header files if __STRICT_ANSI__
48 * is defined.
49 */
50#ifdef __GNUC__
H. Peter Anvine8677d62016-01-27 14:29:40 -080051# undef __STRICT_ANSI__
52#endif
53
H. Peter Anvinb423c022016-02-18 11:57:53 -080054/* On Microsoft platforms we support multibyte character sets in filenames */
55#define _MBCS 1
56
H. Peter Anvinc40f89e2007-04-13 20:06:41 +000057#ifdef HAVE_CONFIG_H
H. Peter Anvin397c1692016-10-04 17:01:59 -070058# include "config/config.h"
H. Peter Anvin397c1692016-10-04 17:01:59 -070059#elif defined(_MSC_VER) && (_MSC_VER >= 1310)
60# include "config/msvc.h"
H. Peter Anvine29c7bb2017-02-28 23:05:17 -080061#elif defined(__WATCOMC__)
H. Peter Anvinf5287232016-10-19 13:23:04 -070062# include "config/watcom.h"
H. Peter Anvin253a4e72008-06-10 13:00:27 -070063#else
H. Peter Anvin276785a2016-10-04 17:13:50 -070064# include "config/unknown.h"
H. Peter Anvin397c1692016-10-04 17:01:59 -070065#endif /* Configuration file */
H. Peter Anvinc1494ac2007-04-13 19:58:42 +000066
H. Peter Anvin687b3632007-10-11 12:50:24 -070067/* 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
73
H. Peter Anvin3ef4f002016-03-08 12:14:55 -080074#ifdef HAVE_INTTYPES_H
75# include <inttypes.h>
76#else
77# include "nasmint.h"
78#endif
79
H. Peter Anvinabd28c92016-12-20 02:29:58 -080080#include <assert.h>
H. Peter Anvin304b6052007-09-28 10:50:20 -070081#include <stddef.h>
82#include <stdarg.h>
H. Peter Anvinfe501952007-10-02 21:53:51 -070083#include <stdio.h>
H. Peter Anvin9b4b92b2017-02-20 00:36:53 -080084#include <limits.h>
H. Peter Anvinb8af9aa2007-09-17 13:53:14 -070085
H. Peter Anvin4c9132e2016-10-19 13:13:38 -070086#ifdef HAVE_SYS_TYPES_H
87# include <sys/types.h>
88#endif
H. Peter Anvind3e22572017-04-24 12:58:30 -070089#ifdef HAVE_ENDIAN_H
90# include <endian.h>
91#endif
92
93/*
94 * If we have BYTE_ORDER defined, trust it over what autoconf came up
95 * with, especially since autoconf obviously can't figure things out
96 * for a universal compiler.
97 */
98#if defined(BYTE_ORDER) && defined(LITTLE_ENDIAN) && defined(BIG_ENDIAN)
99# undef WORDS_LITTLEENDIAN
100# undef WORDS_BIGENDIAN
101# if BYTE_ORDER == LITTLE_ENDIAN
102# define WORDS_LITTLEENDIAN 1
103# elif BYTE_ORDER == BIG_ENDIAN
104# define WORDS_BIGENDIAN 1
105# endif
106#endif
107
108/*
109 * Define this to 1 for faster performance if this is a littleendian
110 * platform which can do unaligned memory references. It is safe
111 * to leave it defined to 0 even if that is true.
112 */
113#if defined(__386__) || defined(__i386__) || defined(__x86_64__) \
114 || defined(_M_IX86) || defined(_M_X64)
115# define X86_MEMORY 1
116# ifndef WORDS_LITTLEENDIAN
117# define WORDS_LITTLEENDIAN 1
118# endif
119#else
120# define X86_MEMORY 0
121#endif
H. Peter Anvin4c9132e2016-10-19 13:13:38 -0700122
H. Peter Anvin3ef4f002016-03-08 12:14:55 -0800123/* Some versions of MSVC have these only with underscores in front */
H. Peter Anvin304b6052007-09-28 10:50:20 -0700124#ifndef HAVE_SNPRINTF
125# ifdef HAVE__SNPRINTF
126# define snprintf _snprintf
127# else
128int snprintf(char *, size_t, const char *, ...);
129# endif
H. Peter Anvinb8af9aa2007-09-17 13:53:14 -0700130#endif
131
H. Peter Anvin304b6052007-09-28 10:50:20 -0700132#ifndef HAVE_VSNPRINTF
Cyrill Gorcunovb2c34492014-11-26 10:44:19 +0300133# ifdef HAVE__VSNPRINTF
H. Peter Anvin304b6052007-09-28 10:50:20 -0700134# define vsnprintf _vsnprintf
135# else
136int vsnprintf(char *, size_t, const char *, va_list);
137# endif
H. Peter Anvinb8af9aa2007-09-17 13:53:14 -0700138#endif
139
H. Peter Anvin2958bcc2017-02-23 19:23:10 -0800140#if !defined(HAVE_STRLCPY) || !HAVE_DECL_STRLCPY
H. Peter Anvineaa68f12009-08-10 15:56:52 -0700141size_t strlcpy(char *, const char *, size_t);
142#endif
143
H. Peter Anvin6867acc2007-10-10 14:58:45 -0700144#ifndef __cplusplus /* C++ has false, true, bool as keywords */
H. Peter Anvind338b372016-02-18 00:54:30 -0800145# ifdef HAVE_STDBOOL_H
H. Peter Anvin6867acc2007-10-10 14:58:45 -0700146# include <stdbool.h>
H. Peter Anvind338b372016-02-18 00:54:30 -0800147# elif defined(HAVE__BOOL)
148# typedef _Bool bool
149# define false 0
150# define true 1
H. Peter Anvin6867acc2007-10-10 14:58:45 -0700151# else
H. Peter Anvin253a4e72008-06-10 13:00:27 -0700152/* This is sort of dangerous, since casts will behave different than
153 casting to the standard boolean type. Always use !!, not (bool). */
154typedef enum bool { false, true } bool;
H. Peter Anvin6867acc2007-10-10 14:58:45 -0700155# endif
156#endif
157
H. Peter Anvin9656a582008-10-30 10:52:08 -0700158/* Provide a substitute for offsetof() if we don't have one. This
159 variant works on most (but not *all*) systems... */
160#ifndef offsetof
161# define offsetof(t,m) ((size_t)&(((t *)0)->m))
162#endif
163
164/* The container_of construct: if p is a pointer to member m of
165 container class c, then return a pointer to the container of which
166 *p is a member. */
167#ifndef container_of
168# define container_of(p, c, m) ((c *)((char *)(p) - offsetof(c,m)))
169#endif
170
H. Peter Anvinc13d31a2007-10-26 18:49:29 -0700171/* Some misguided platforms hide the defs for these */
H. Peter Anvin2958bcc2017-02-23 19:23:10 -0800172#if defined(HAVE_STRCASECMP) && !HAVE_DECL_STRCASECMP
H. Peter Anvinc13d31a2007-10-26 18:49:29 -0700173int strcasecmp(const char *, const char *);
174#endif
175
H. Peter Anvin2958bcc2017-02-23 19:23:10 -0800176#if defined(HAVE_STRICMP) && !HAVE_DECL_STRICMP
H. Peter Anvinc13d31a2007-10-26 18:49:29 -0700177int stricmp(const char *, const char *);
178#endif
179
H. Peter Anvin2958bcc2017-02-23 19:23:10 -0800180#if defined(HAVE_STRNCASECMP) && !HAVE_DECL_STRNCASECMP
H. Peter Anvinc13d31a2007-10-26 18:49:29 -0700181int strncasecmp(const char *, const char *, size_t);
182#endif
183
H. Peter Anvin2958bcc2017-02-23 19:23:10 -0800184#if defined(HAVE_STRNICMP) && !HAVE_DECL_STRNICMP
H. Peter Anvinc13d31a2007-10-26 18:49:29 -0700185int strnicmp(const char *, const char *, size_t);
186#endif
187
H. Peter Anvin2958bcc2017-02-23 19:23:10 -0800188#if defined(HAVE_STRSEP) && !HAVE_DECL_STRSEP
H. Peter Anvinc13d31a2007-10-26 18:49:29 -0700189char *strsep(char **, const char *);
190#endif
191
H. Peter Anvin2958bcc2017-02-23 19:23:10 -0800192#if !HAVE_DECL_STRNLEN
193size_t strnlen(const char *s, size_t maxlen);
194#endif
195
H. Peter Anvind1fb15c2007-11-13 09:37:59 -0800196/*
H. Peter Anvin51997d32008-06-10 09:35:26 -0700197 * Hints to the compiler that a particular branch of code is more or
198 * less likely to be taken.
199 */
H. Peter Anvin7294d622016-11-15 15:53:38 -0800200#if HAVE___BUILTIN_EXPECT
H. Peter Anvin51997d32008-06-10 09:35:26 -0700201# define likely(x) __builtin_expect(!!(x), 1)
202# define unlikely(x) __builtin_expect(!!(x), 0)
203#else
204# define likely(x) (!!(x))
205# define unlikely(x) (!!(x))
206#endif
207
H. Peter Anvin396e6dc2009-07-01 22:01:07 -0700208/*
H. Peter Anvin4976cd22016-05-25 03:56:34 -0700209 * Hints about malloc-like functions that never return NULL
210 */
H. Peter Anvin8b190832016-11-15 14:01:37 -0800211#ifdef HAVE_FUNC_ATTRIBUTE_RETURNS_NONNULL
H. Peter Anvin4976cd22016-05-25 03:56:34 -0700212# define never_null __attribute__((returns_nonnull))
H. Peter Anvin8b190832016-11-15 14:01:37 -0800213#else
214# define never_null
215#endif
216
217#ifdef HAVE_FUNC_ATTRIBUTE_MALLOC
H. Peter Anvin4976cd22016-05-25 03:56:34 -0700218# define safe_alloc never_null __attribute__((malloc))
H. Peter Anvin8b190832016-11-15 14:01:37 -0800219#else
220# define safe_alloc
221#endif
222
223#ifdef HAVE_FUNC_ATTRIBUTE_ALLOC_SIZE
H. Peter Anvin9b733a52016-10-14 15:01:06 -0700224# define safe_malloc(s) safe_alloc __attribute__((alloc_size(s)))
225# define safe_malloc2(s1,s2) safe_alloc __attribute__((alloc_size(s1,s2)))
226# define safe_realloc(s) never_null __attribute__((alloc_size(s)))
H. Peter Anvin8b190832016-11-15 14:01:37 -0800227#else
H. Peter Anvin9b733a52016-10-14 15:01:06 -0700228# define safe_malloc(s) safe_alloc
H. Peter Anvin44e3a112016-10-14 15:05:28 -0700229# define safe_malloc2(s1,s2) safe_alloc
H. Peter Anvin9b733a52016-10-14 15:01:06 -0700230# define safe_realloc(s) never_null
H. Peter Anvin4976cd22016-05-25 03:56:34 -0700231#endif
232
233/*
H. Peter Anvin396e6dc2009-07-01 22:01:07 -0700234 * How to tell the compiler that a function doesn't return
235 */
H. Peter Anvinabd28c92016-12-20 02:29:58 -0800236#ifdef HAVE_STDNORETURN_H
237# include <stdnoreturn.h>
238# define no_return noreturn void
239#elif defined(HAVE_FUNC_ATTRIBUTE_NORETURN)
H. Peter Anvin84280bb2009-07-05 19:22:28 -0700240# define no_return void __attribute__((noreturn))
H. Peter Anvinc01af092017-04-06 13:48:54 -0700241#elif defined(_MSC_VER)
242# define no_return __declspec(noreturn) void
H. Peter Anvin396e6dc2009-07-01 22:01:07 -0700243#else
H. Peter Anvin84280bb2009-07-05 19:22:28 -0700244# define no_return void
H. Peter Anvin396e6dc2009-07-01 22:01:07 -0700245#endif
246
H. Peter Anvinf0d92fd2016-02-02 16:01:43 -0800247/*
248 * How to tell the compiler that a function takes a printf-like string
249 */
H. Peter Anvin8b190832016-11-15 14:01:37 -0800250#ifdef HAVE_FUNC_ATTRIBUTE_FORMAT
H. Peter Anvinf0d92fd2016-02-02 16:01:43 -0800251# define printf_func(fmt, list) __attribute__((format(printf, fmt, list)))
252#else
253# define printf_func(fmt, list)
254#endif
255
H. Peter Anvin8b190832016-11-15 14:01:37 -0800256/*
257 * How to tell the compiler that a function is pure arithmetic
258 */
259#ifdef HAVE_FUNC_ATTRIBUTE_CONST
260# define const_func __attribute__((const))
261#else
262# define const_func
263#endif
264
265/*
266 * This function has no side effects, but depends on its arguments,
267 * memory pointed to by its arguments, or global variables.
268 * NOTE: functions that return a value by modifying memory pointed to
269 * by a pointer argument are *NOT* considered pure.
270 */
271#ifdef HAVE_FUNC_ATTRIBUTE_PURE
272# define pure_func __attribute__((pure))
273#else
274# define pure_func
275#endif
276
H. Peter Anvin9b4b92b2017-02-20 00:36:53 -0800277/* Watcom doesn't handle switch statements with 64-bit types, hack around it */
H. Peter Anvine29c7bb2017-02-28 23:05:17 -0800278#ifdef __WATCOMC__
H. Peter Anvin9b4b92b2017-02-20 00:36:53 -0800279# define BOGUS_CASE 0x76543210
280
281static inline unsigned int watcom_switch_hack(uint64_t x)
282{
H. Peter Anvine90a89a2017-03-01 00:52:48 -0800283 if (x > (uint64_t)UINT_MAX)
H. Peter Anvin9b4b92b2017-02-20 00:36:53 -0800284 return BOGUS_CASE;
285 else
286 return (unsigned int)x;
287}
288
H. Peter Anvinbe01d492017-02-23 17:25:31 -0800289# define switch(x) switch(sizeof(x) > sizeof(unsigned int) \
290 ? watcom_switch_hack(x) : (unsigned int)(x))
291
292/* This is to make sure BOGUS_CASE doesn't conflict with anything real... */
H. Peter Anvin9b4b92b2017-02-20 00:36:53 -0800293# define default case BOGUS_CASE: default
294#endif
295
H. Peter Anvinfe501952007-10-02 21:53:51 -0700296#endif /* NASM_COMPILER_H */