include/compiler.h

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