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 #else
  62 # include "config/unknown.h"
  63 #endif /* Configuration file */
  64
  65 /* This is required to get the standard <inttypes.h> macros when compiling
  66    with a C++ compiler.  This must be defined *before* <inttypes.h> is
  67    included, directly or indirectly. */
  68 #define __STDC_CONSTANT_MACROS  1
  69 #define __STDC_LIMIT_MACROS     1
  70 #define __STDC_FORMAT_MACROS    1
  71
  72 #ifdef HAVE_INTTYPES_H
  73 # include <inttypes.h>
  74 #else
  75 # include "nasmint.h"
  76 #endif
  77
  78 #include <stddef.h>
  79 #include <stdarg.h>
  80 #include <stdio.h>
  81
  82 /* Some versions of MSVC have these only with underscores in front */
  83 #ifndef HAVE_SNPRINTF
  84 # ifdef HAVE__SNPRINTF
  85 #  define snprintf _snprintf
  86 # else
  87 int snprintf(char *, size_t, const char *, ...);
  88 # endif
  89 #endif
  90
  91 #ifndef HAVE_VSNPRINTF
  92 # ifdef HAVE__VSNPRINTF
  93 #  define vsnprintf _vsnprintf
  94 # else
  95 int vsnprintf(char *, size_t, const char *, va_list);
  96 # endif
  97 #endif
  98
  99 #if !defined(HAVE_STRLCPY) || !defined(HAVE_DECL_STRLCPY)
 100 size_t strlcpy(char *, const char *, size_t);
 101 #endif
 102
 103 #ifndef __cplusplus             /* C++ has false, true, bool as keywords */
 104 # ifdef HAVE_STDBOOL_H
 105 #  include <stdbool.h>
 106 # elif defined(HAVE__BOOL)
 107 #  typedef _Bool bool
 108 #  define false 0
 109 #  define true 1
 110 # else
 111 /* This is sort of dangerous, since casts will behave different than
 112    casting to the standard boolean type.  Always use !!, not (bool). */
 113 typedef enum bool { false, true } bool;
 114 # endif
 115 #endif
 116
 117 /* Provide a substitute for offsetof() if we don't have one.  This
 118    variant works on most (but not *all*) systems... */
 119 #ifndef offsetof
 120 # define offsetof(t,m) ((size_t)&(((t *)0)->m))
 121 #endif
 122
 123 /* The container_of construct: if p is a pointer to member m of
 124    container class c, then return a pointer to the container of which
 125    *p is a member. */
 126 #ifndef container_of
 127 # define container_of(p, c, m) ((c *)((char *)(p) - offsetof(c,m)))
 128 #endif
 129
 130 /* Some misguided platforms hide the defs for these */
 131 #if defined(HAVE_STRCASECMP) && !defined(HAVE_DECL_STRCASECMP)
 132 int strcasecmp(const char *, const char *);
 133 #endif
 134
 135 #if defined(HAVE_STRICMP) && !defined(HAVE_DECL_STRICMP)
 136 int stricmp(const char *, const char *);
 137 #endif
 138
 139 #if defined(HAVE_STRNCASECMP) && !defined(HAVE_DECL_STRNCASECMP)
 140 int strncasecmp(const char *, const char *, size_t);
 141 #endif
 142
 143 #if defined(HAVE_STRNICMP) && !defined(HAVE_DECL_STRNICMP)
 144 int strnicmp(const char *, const char *, size_t);
 145 #endif
 146
 147 #if defined(HAVE_STRSEP) && !defined(HAVE_DECL_STRSEP)
 148 char *strsep(char **, const char *);
 149 #endif
 150
 151 /*
 152  * Define this to 1 for faster performance if this is a littleendian
 153  * platform which can do unaligned memory references.  It is safe
 154  * to leave it defined to 0 even if that is true.
 155  */
 156 #if defined(__386__) || defined(__i386__) || defined(__x86_64__)
 157 # define X86_MEMORY 1
 158 # ifndef WORDS_LITTLEENDIAN
 159 #  define WORDS_LITTLEENDIAN 1
 160 # endif
 161 #else
 162 # define X86_MEMORY 0
 163 #endif
 164
 165 /*
 166  * Hints to the compiler that a particular branch of code is more or
 167  * less likely to be taken.
 168  */
 169 #if defined(__GNUC__) && __GNUC__ >= 3
 170 # define likely(x)      __builtin_expect(!!(x), 1)
 171 # define unlikely(x)    __builtin_expect(!!(x), 0)
 172 #else
 173 # define likely(x)      (!!(x))
 174 # define unlikely(x)    (!!(x))
 175 #endif
 176
 177 /*
 178  * Hints about malloc-like functions that never return NULL
 179  */
 180 #if defined(__GNUC__) && __GNUC__ >= 4 /* ? */
 181 # define never_null __attribute__((returns_nonnull))
 182 # define safe_alloc never_null __attribute__((malloc))
 183 # define safe_malloc(s) safe_alloc __attribute__((alloc_size(s)))
 184 # define safe_malloc2(s1,s2) safe_alloc __attribute__((alloc_size(s1,s2)))
 185 # define safe_realloc(s) never_null __attribute__((alloc_size(s)))
 186 #else
 187 # define never_null
 188 # define safe_alloc
 189 # define safe_malloc(s)
 190 # define safe_malloc2(s1,s2)
 191 # define safe_realloc(s)
 192 #endif
 193
 194 /*
 195  * How to tell the compiler that a function doesn't return
 196  */
 197 #ifdef __GNUC__
 198 # define no_return void __attribute__((noreturn))
 199 #else
 200 # define no_return void
 201 #endif
 202
 203 /*
 204  * How to tell the compiler that a function takes a printf-like string
 205  */
 206 #ifdef __GNUC__
 207 # define printf_func(fmt, list) __attribute__((format(printf, fmt, list)))
 208 #else
 209 # define printf_func(fmt, list)
 210 #endif
 211
 212 #endif  /* NASM_COMPILER_H */