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
  90 /* Some versions of MSVC have these only with underscores in front */
  91 #ifndef HAVE_SNPRINTF
  92 # ifdef HAVE__SNPRINTF
  93 #  define snprintf _snprintf
  94 # else
  95 int snprintf(char *, size_t, const char *, ...);
  96 # endif
  97 #endif
  98
  99 #ifndef HAVE_VSNPRINTF
 100 # ifdef HAVE__VSNPRINTF
 101 #  define vsnprintf _vsnprintf
 102 # else
 103 int vsnprintf(char *, size_t, const char *, va_list);
 104 # endif
 105 #endif
 106
 107 #if !defined(HAVE_STRLCPY) || !HAVE_DECL_STRLCPY
 108 size_t strlcpy(char *, const char *, size_t);
 109 #endif
 110
 111 #ifndef __cplusplus             /* C++ has false, true, bool as keywords */
 112 # ifdef HAVE_STDBOOL_H
 113 #  include <stdbool.h>
 114 # elif defined(HAVE__BOOL)
 115 #  typedef _Bool bool
 116 #  define false 0
 117 #  define true 1
 118 # else
 119 /* This is sort of dangerous, since casts will behave different than
 120    casting to the standard boolean type.  Always use !!, not (bool). */
 121 typedef enum bool { false, true } bool;
 122 # endif
 123 #endif
 124
 125 /* Provide a substitute for offsetof() if we don't have one.  This
 126    variant works on most (but not *all*) systems... */
 127 #ifndef offsetof
 128 # define offsetof(t,m) ((size_t)&(((t *)0)->m))
 129 #endif
 130
 131 /* The container_of construct: if p is a pointer to member m of
 132    container class c, then return a pointer to the container of which
 133    *p is a member. */
 134 #ifndef container_of
 135 # define container_of(p, c, m) ((c *)((char *)(p) - offsetof(c,m)))
 136 #endif
 137
 138 /* Some misguided platforms hide the defs for these */
 139 #if defined(HAVE_STRCASECMP) && !HAVE_DECL_STRCASECMP
 140 int strcasecmp(const char *, const char *);
 141 #endif
 142
 143 #if defined(HAVE_STRICMP) && !HAVE_DECL_STRICMP
 144 int stricmp(const char *, const char *);
 145 #endif
 146
 147 #if defined(HAVE_STRNCASECMP) && !HAVE_DECL_STRNCASECMP
 148 int strncasecmp(const char *, const char *, size_t);
 149 #endif
 150
 151 #if defined(HAVE_STRNICMP) && !HAVE_DECL_STRNICMP
 152 int strnicmp(const char *, const char *, size_t);
 153 #endif
 154
 155 #if defined(HAVE_STRSEP) && !HAVE_DECL_STRSEP
 156 char *strsep(char **, const char *);
 157 #endif
 158
 159 #if !HAVE_DECL_STRNLEN
 160 size_t strnlen(const char *s, size_t maxlen);
 161 #endif
 162
 163 /*
 164  * Define this to 1 for faster performance if this is a littleendian
 165  * platform which can do unaligned memory references.  It is safe
 166  * to leave it defined to 0 even if that is true.
 167  */
 168 #if defined(__386__) || defined(__i386__) || defined(__x86_64__)
 169 # define X86_MEMORY 1
 170 # ifndef WORDS_LITTLEENDIAN
 171 #  define WORDS_LITTLEENDIAN 1
 172 # endif
 173 #else
 174 # define X86_MEMORY 0
 175 #endif
 176
 177 /*
 178  * Hints to the compiler that a particular branch of code is more or
 179  * less likely to be taken.
 180  */
 181 #if HAVE___BUILTIN_EXPECT
 182 # define likely(x)      __builtin_expect(!!(x), 1)
 183 # define unlikely(x)    __builtin_expect(!!(x), 0)
 184 #else
 185 # define likely(x)      (!!(x))
 186 # define unlikely(x)    (!!(x))
 187 #endif
 188
 189 /*
 190  * Hints about malloc-like functions that never return NULL
 191  */
 192 #ifdef HAVE_FUNC_ATTRIBUTE_RETURNS_NONNULL
 193 # define never_null __attribute__((returns_nonnull))
 194 #else
 195 # define never_null
 196 #endif
 197
 198 #ifdef HAVE_FUNC_ATTRIBUTE_MALLOC
 199 # define safe_alloc never_null __attribute__((malloc))
 200 #else
 201 # define safe_alloc
 202 #endif
 203
 204 #ifdef HAVE_FUNC_ATTRIBUTE_ALLOC_SIZE
 205 #   define safe_malloc(s) safe_alloc __attribute__((alloc_size(s)))
 206 #   define safe_malloc2(s1,s2) safe_alloc __attribute__((alloc_size(s1,s2)))
 207 #   define safe_realloc(s) never_null __attribute__((alloc_size(s)))
 208 #else
 209 # define safe_malloc(s) safe_alloc
 210 # define safe_malloc2(s1,s2) safe_alloc
 211 # define safe_realloc(s) never_null
 212 #endif
 213
 214 /*
 215  * How to tell the compiler that a function doesn't return
 216  */
 217 #ifdef HAVE_STDNORETURN_H
 218 # include <stdnoreturn.h>
 219 # define no_return noreturn void
 220 #elif defined(HAVE_FUNC_ATTRIBUTE_NORETURN)
 221 # define no_return void __attribute__((noreturn))
 222 #elif defined(_MSC_VER)
 223 # define no_return __declspec(noreturn) void
 224 #else
 225 # define no_return void
 226 #endif
 227
 228 /*
 229  * How to tell the compiler that a function takes a printf-like string
 230  */
 231 #ifdef HAVE_FUNC_ATTRIBUTE_FORMAT
 232 # define printf_func(fmt, list) __attribute__((format(printf, fmt, list)))
 233 #else
 234 # define printf_func(fmt, list)
 235 #endif
 236
 237 /*
 238  * How to tell the compiler that a function is pure arithmetic
 239  */
 240 #ifdef HAVE_FUNC_ATTRIBUTE_CONST
 241 # define const_func __attribute__((const))
 242 #else
 243 # define const_func
 244 #endif
 245
 246 /*
 247  * This function has no side effects, but depends on its arguments,
 248  * memory pointed to by its arguments, or global variables.
 249  * NOTE: functions that return a value by modifying memory pointed to
 250  * by a pointer argument are *NOT* considered pure.
 251  */
 252 #ifdef HAVE_FUNC_ATTRIBUTE_PURE
 253 # define pure_func __attribute__((pure))
 254 #else
 255 # define pure_func
 256 #endif
 257
 258 /* Watcom doesn't handle switch statements with 64-bit types, hack around it */
 259 #ifdef __WATCOMC__
 260 # define BOGUS_CASE 0x76543210
 261
 262 static inline unsigned int watcom_switch_hack(uint64_t x)
 263 {
 264     if (x > (uint64_t)UINT_MAX)
 265         return BOGUS_CASE;
 266     else
 267         return (unsigned int)x;
 268 }
 269
 270 # define switch(x) switch(sizeof(x) > sizeof(unsigned int) \
 271                           ? watcom_switch_hack(x) : (unsigned int)(x))
 272
 273 /* This is to make sure BOGUS_CASE doesn't conflict with anything real... */
 274 # define default case BOGUS_CASE: default
 275 #endif
 276
 277 #endif  /* NASM_COMPILER_H */