include/compiler.h

   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.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following
   9  *   conditions are met:
  10  *
  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.
  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.
  31  *
  32  * ----------------------------------------------------------------------- */
  33
  34 /*
  35  * compiler.h
  36  *
  37  * Compiler-specific macros for NASM.  Feel free to add support for
  38  * other compilers in here.
  39  *
  40  * This header file should be included before any other header.
  41  */
  42
  43 #ifndef NASM_COMPILER_H
  44 #define NASM_COMPILER_H 1
  45
  46 /*
  47  * At least DJGPP and Cygwin have broken header files if __STRICT_ANSI__
  48  * is defined.
  49  */
  50 #ifdef __GNUC__
  51 # undef __STRICT_ANSI__
  52 #endif
  53
  54 /* On Microsoft platforms we support multibyte character sets in filenames */
  55 #define _MBCS 1
  56
  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 */
  66
  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
  73
  74 #ifdef HAVE_INTTYPES_H
  75 # include <inttypes.h>
  76 #else
  77 # include "nasmint.h"
  78 #endif
  79
  80 #include <assert.h>
  81 #include <stddef.h>
  82 #include <stdarg.h>
  83 #include <stdio.h>
  84 #include <limits.h>
  85
  86 #ifdef HAVE_SYS_TYPES_H
  87 # include <sys/types.h>
  88 #endif
  89 #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
 122
 123 /* Some versions of MSVC have these only with underscores in front */
 124 #ifndef HAVE_SNPRINTF
 125 # ifdef HAVE__SNPRINTF
 126 #  define snprintf _snprintf
 127 # else
 128 int snprintf(char *, size_t, const char *, ...);
 129 # endif
 130 #endif
 131
 132 #ifndef HAVE_VSNPRINTF
 133 # ifdef HAVE__VSNPRINTF
 134 #  define vsnprintf _vsnprintf
 135 # else
 136 int vsnprintf(char *, size_t, const char *, va_list);
 137 # endif
 138 #endif
 139
 140 #if !defined(HAVE_STRLCPY) || !HAVE_DECL_STRLCPY
 141 size_t strlcpy(char *, const char *, size_t);
 142 #endif
 143
 144 #ifndef __cplusplus             /* C++ has false, true, bool as keywords */
 145 # ifdef HAVE_STDBOOL_H
 146 #  include <stdbool.h>
 147 # elif defined(HAVE__BOOL)
 148 #  typedef _Bool bool
 149 #  define false 0
 150 #  define true 1
 151 # else
 152 /* This is sort of dangerous, since casts will behave different than
 153    casting to the standard boolean type.  Always use !!, not (bool). */
 154 typedef enum bool { false, true } bool;
 155 # endif
 156 #endif
 157
 158 /* 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
 171 /* Some misguided platforms hide the defs for these */
 172 #if defined(HAVE_STRCASECMP) && !HAVE_DECL_STRCASECMP
 173 int strcasecmp(const char *, const char *);
 174 #endif
 175
 176 #if defined(HAVE_STRICMP) && !HAVE_DECL_STRICMP
 177 int stricmp(const char *, const char *);
 178 #endif
 179
 180 #if defined(HAVE_STRNCASECMP) && !HAVE_DECL_STRNCASECMP
 181 int strncasecmp(const char *, const char *, size_t);
 182 #endif
 183
 184 #if defined(HAVE_STRNICMP) && !HAVE_DECL_STRNICMP
 185 int strnicmp(const char *, const char *, size_t);
 186 #endif
 187
 188 #if defined(HAVE_STRSEP) && !HAVE_DECL_STRSEP
 189 char *strsep(char **, const char *);
 190 #endif
 191
 192 #if !HAVE_DECL_STRNLEN
 193 size_t strnlen(const char *s, size_t maxlen);
 194 #endif
 195
 196 /*
 197  * Hints to the compiler that a particular branch of code is more or
 198  * less likely to be taken.
 199  */
 200 #if HAVE___BUILTIN_EXPECT
 201 # 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
 208 /*
 209  * Hints about malloc-like functions that never return NULL
 210  */
 211 #ifdef HAVE_FUNC_ATTRIBUTE_RETURNS_NONNULL
 212 # define never_null __attribute__((returns_nonnull))
 213 #else
 214 # define never_null
 215 #endif
 216
 217 #ifdef HAVE_FUNC_ATTRIBUTE_MALLOC
 218 # define safe_alloc never_null __attribute__((malloc))
 219 #else
 220 # define safe_alloc
 221 #endif
 222
 223 #ifdef HAVE_FUNC_ATTRIBUTE_ALLOC_SIZE
 224 #   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)))
 227 #else
 228 # define safe_malloc(s) safe_alloc
 229 # define safe_malloc2(s1,s2) safe_alloc
 230 # define safe_realloc(s) never_null
 231 #endif
 232
 233 /*
 234  * How to tell the compiler that a function doesn't return
 235  */
 236 #ifdef HAVE_STDNORETURN_H
 237 # include <stdnoreturn.h>
 238 # define no_return noreturn void
 239 #elif defined(HAVE_FUNC_ATTRIBUTE_NORETURN)
 240 # define no_return void __attribute__((noreturn))
 241 #elif defined(_MSC_VER)
 242 # define no_return __declspec(noreturn) void
 243 #else
 244 # define no_return void
 245 #endif
 246
 247 /*
 248  * How to tell the compiler that a function takes a printf-like string
 249  */
 250 #ifdef HAVE_FUNC_ATTRIBUTE_FORMAT
 251 # define printf_func(fmt, list) __attribute__((format(printf, fmt, list)))
 252 #else
 253 # define printf_func(fmt, list)
 254 #endif
 255
 256 /*
 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
 277 /* Watcom doesn't handle switch statements with 64-bit types, hack around it */
 278 #ifdef __WATCOMC__
 279 # define BOGUS_CASE 0x76543210
 280
 281 static inline unsigned int watcom_switch_hack(uint64_t x)
 282 {
 283     if (x > (uint64_t)UINT_MAX)
 284         return BOGUS_CASE;
 285     else
 286         return (unsigned int)x;
 287 }
 288
 289 # 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... */
 293 # define default case BOGUS_CASE: default
 294 #endif
 295
 296 #endif  /* NASM_COMPILER_H */