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 __GNUC__
  76 # if __GNUC__ >= 4
  77 #  define HAVE_GNUC_4
  78 # endif
  79 # if __GNUC__ >= 3
  80 #  define HAVE_GNUC_3
  81 # endif
  82 #endif
  83
  84 #ifdef __GNUC__
  85 # define _unused        __attribute__((unused))
  86 #else
  87 # define _unused
  88 #endif
  89
  90 /* Some versions of MSVC have these only with underscores in front */
  91 #include <stddef.h>
  92 #include <stdarg.h>
  93 #include <stdio.h>
  94
  95 #ifndef HAVE_SNPRINTF
  96 # ifdef HAVE__SNPRINTF
  97 #  define snprintf _snprintf
  98 # else
  99 int snprintf(char *, size_t, const char *, ...);
 100 # endif
 101 #endif
 102
 103 #ifndef HAVE_VSNPRINTF
 104 # ifdef HAVE__VSNPRINTF
 105 #  define vsnprintf _vsnprintf
 106 # else
 107 int vsnprintf(char *, size_t, const char *, va_list);
 108 # endif
 109 #endif
 110
 111 #if !defined(HAVE_STRLCPY) || !HAVE_DECL_STRLCPY
 112 size_t strlcpy(char *, const char *, size_t);
 113 #endif
 114
 115 #ifndef __cplusplus             /* C++ has false, true, bool as keywords */
 116 # if defined(HAVE_STDBOOL_H) && defined(HAVE_WORKING_BOOL)
 117 #  include <stdbool.h>
 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 /*
 160  * Define this to 1 for faster performance if this is a littleendian
 161  * platform which can do unaligned memory references.  It is safe
 162  * to leave it defined to 0 even if that is true.
 163  */
 164 #if defined(__386__) || defined(__i386__) || defined(__x86_64__)
 165 # define X86_MEMORY 1
 166 # ifndef WORDS_LITTLEENDIAN
 167 #  define WORDS_LITTLEENDIAN 1
 168 # endif
 169 #else
 170 # define X86_MEMORY 0
 171 #endif
 172
 173 /*
 174  * Hints to the compiler that a particular branch of code is more or
 175  * less likely to be taken.
 176  */
 177 #if defined(__GNUC__) && __GNUC__ >= 3
 178 # define likely(x)      __builtin_expect(!!(x), 1)
 179 # define unlikely(x)    __builtin_expect(!!(x), 0)
 180 #else
 181 # define likely(x)      (!!(x))
 182 # define unlikely(x)    (!!(x))
 183 #endif
 184
 185 /*
 186  * How to tell the compiler that a function doesn't return
 187  */
 188 #ifdef __GNUC__
 189 # define no_return void __attribute__((noreturn))
 190 #else
 191 # define no_return void
 192 #endif
 193
 194 /*
 195  * How to tell the compiler that a function takes a printf-like string
 196  */
 197 #ifdef __GNUC__
 198 # define printf_func(fmt, list) __attribute__((format(printf, fmt, list)))
 199 #else
 200 # define printf_func(fmt, list)
 201 #endif
 202
 203 #endif  /* NASM_COMPILER_H */