compiler.h

   1 /* ----------------------------------------------------------------------- *
   2  *
   3  *   Copyright 2007-2008 The NASM Authors - All Rights Reserved
   4  *
   5  *   This program is free software; you can redistribute it and/or modify
   6  *   it under the terms of the license given in the file "LICENSE"
   7  *   distributed in the NASM archive.
   8  *
   9  * ----------------------------------------------------------------------- */
  10
  11 /*
  12  * compiler.h
  13  *
  14  * Compiler-specific macros for NASM.  Feel free to add support for
  15  * other compilers in here.
  16  *
  17  * This header file should be included before any other header.
  18  */
  19
  20 #ifndef NASM_COMPILER_H
  21 #define NASM_COMPILER_H 1
  22
  23 #ifdef HAVE_CONFIG_H
  24 # include "config.h"
  25 /* autoconf doesn't define these if they are redundant, but we want to
  26    be able to #ifdef them... */
  27 #else
  28 /* Default these to unsupported unless we have config.h */
  29 # ifndef inline
  30 #  define inline
  31 # endif
  32 # ifndef restrict
  33 #  define restrict
  34 # endif
  35 #endif /* HAVE_CONFIG_H */
  36
  37 /* This is required to get the standard <inttypes.h> macros when compiling
  38    with a C++ compiler.  This must be defined *before* <inttypes.h> is
  39    included, directly or indirectly. */
  40 #define __STDC_CONSTANT_MACROS  1
  41 #define __STDC_LIMIT_MACROS     1
  42 #define __STDC_FORMAT_MACROS    1
  43
  44 #ifdef __GNUC__
  45 # if __GNUC__ >= 4
  46 #  define HAVE_GNUC_4
  47 # endif
  48 # if __GNUC__ >= 3
  49 #  define HAVE_GNUC_3
  50 # endif
  51 #endif
  52
  53 #ifdef __GNUC__
  54 # define _unused        __attribute__((unused))
  55 #else
  56 # define _unused
  57 #endif
  58
  59 /* Some versions of MSVC have these only with underscores in front */
  60 #include <stddef.h>
  61 #include <stdarg.h>
  62 #include <stdio.h>
  63
  64 #ifndef HAVE_SNPRINTF
  65 # ifdef HAVE__SNPRINTF
  66 #  define snprintf _snprintf
  67 # else
  68 int snprintf(char *, size_t, const char *, ...);
  69 # endif
  70 #endif
  71
  72 #ifndef HAVE_VSNPRINTF
  73 # ifdef HAVE__VSNPRINT
  74 #  define vsnprintf _vsnprintf
  75 # else
  76 int vsnprintf(char *, size_t, const char *, va_list);
  77 # endif
  78 #endif
  79
  80 #ifndef __cplusplus             /* C++ has false, true, bool as keywords */
  81 # if defined(HAVE_STDBOOL_H) && defined(HAVE_WORKING_BOOL)
  82 #  include <stdbool.h>
  83 # else
  84 /* This is sort of dangerous, since casts will behave different than
  85    casting to the standard boolean type.  Always use !!, not (bool). */
  86 typedef enum bool { false, true } bool;
  87 # endif
  88 #endif
  89
  90 /* Provide a substitute for offsetof() if we don't have one.  This
  91    variant works on most (but not *all*) systems... */
  92 #ifndef offsetof
  93 # define offsetof(t,m) ((size_t)&(((t *)0)->m))
  94 #endif
  95
  96 /* The container_of construct: if p is a pointer to member m of
  97    container class c, then return a pointer to the container of which
  98    *p is a member. */
  99 #ifndef container_of
 100 # define container_of(p, c, m) ((c *)((char *)(p) - offsetof(c,m)))
 101 #endif
 102
 103 /* Some misguided platforms hide the defs for these */
 104 #if defined(HAVE_STRCASECMP) && !HAVE_DECL_STRCASECMP
 105 int strcasecmp(const char *, const char *);
 106 #endif
 107
 108 #if defined(HAVE_STRICMP) && !HAVE_DECL_STRICMP
 109 int stricmp(const char *, const char *);
 110 #endif
 111
 112 #if defined(HAVE_STRNCASECMP) && !HAVE_DECL_STRNCASECMP
 113 int strncasecmp(const char *, const char *, size_t);
 114 #endif
 115
 116 #if defined(HAVE_STRNICMP) && !HAVE_DECL_STRNICMP
 117 int strnicmp(const char *, const char *, size_t);
 118 #endif
 119
 120 #if defined(HAVE_STRSEP) && !HAVE_DECL_STRSEP
 121 char *strsep(char **, const char *);
 122 #endif
 123
 124 /*
 125  * Define this to 1 for faster performance if this is a littleendian
 126  * platform which can do unaligned memory references.  It is safe
 127  * to leave it defined to 0 even if that is true.
 128  */
 129 #if defined(__386__) || defined(__i386__) || defined(__x86_64__)
 130 # define X86_MEMORY 1
 131 # ifndef WORDS_LITTLEENDIAN
 132 #  define WORDS_LITTLEENDIAN 1
 133 # endif
 134 #else
 135 # define X86_MEMORY 0
 136 #endif
 137
 138 /*
 139  * Hints to the compiler that a particular branch of code is more or
 140  * less likely to be taken.
 141  */
 142 #if defined(__GNUC__) && __GNUC__ >= 3
 143 # define likely(x)      __builtin_expect(!!(x), 1)
 144 # define unlikely(x)    __builtin_expect(!!(x), 0)
 145 #else
 146 # define likely(x)      (!!(x))
 147 # define unlikely(x)    (!!(x))
 148 #endif
 149
 150 #endif  /* NASM_COMPILER_H */