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