MPX: Add MPX instructions
[nasm/avx512.git] / compiler.h
blob5805f5a99f76de6ab798c9d9deebedb6fd71ecf6
1 /* ----------------------------------------------------------------------- *
2 *
3 * Copyright 2007-2009 The NASM Authors - All Rights Reserved
4 * See the file AUTHORS included with the NASM distribution for
5 * the specific copyright holders.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following
9 * conditions are met:
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.
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.
32 * ----------------------------------------------------------------------- */
35 * compiler.h
37 * Compiler-specific macros for NASM. Feel free to add support for
38 * other compilers in here.
40 * This header file should be included before any other header.
43 #ifndef NASM_COMPILER_H
44 #define NASM_COMPILER_H 1
46 #ifdef HAVE_CONFIG_H
47 # include "config.h"
48 /* autoconf doesn't define these if they are redundant, but we want to
49 be able to #ifdef them... */
50 #else
51 /* Default these to unsupported unless we have config.h */
52 # ifndef inline
53 # define inline
54 # endif
55 # ifndef restrict
56 # define restrict
57 # endif
58 #endif /* HAVE_CONFIG_H */
60 /* This is required to get the standard <inttypes.h> macros when compiling
61 with a C++ compiler. This must be defined *before* <inttypes.h> is
62 included, directly or indirectly. */
63 #define __STDC_CONSTANT_MACROS 1
64 #define __STDC_LIMIT_MACROS 1
65 #define __STDC_FORMAT_MACROS 1
67 #ifdef __GNUC__
68 # if __GNUC__ >= 4
69 # define HAVE_GNUC_4
70 # endif
71 # if __GNUC__ >= 3
72 # define HAVE_GNUC_3
73 # endif
74 #endif
76 #ifdef __GNUC__
77 # define _unused __attribute__((unused))
78 #else
79 # define _unused
80 #endif
82 /* Some versions of MSVC have these only with underscores in front */
83 #include <stddef.h>
84 #include <stdarg.h>
85 #include <stdio.h>
87 #ifndef HAVE_SNPRINTF
88 # ifdef HAVE__SNPRINTF
89 # define snprintf _snprintf
90 # else
91 int snprintf(char *, size_t, const char *, ...);
92 # endif
93 #endif
95 #ifndef HAVE_VSNPRINTF
96 # ifdef HAVE__VSNPRINT
97 # define vsnprintf _vsnprintf
98 # else
99 int vsnprintf(char *, size_t, const char *, va_list);
100 # endif
101 #endif
103 #if !defined(HAVE_STRLCPY) || !HAVE_DECL_STRLCPY
104 size_t strlcpy(char *, const char *, size_t);
105 #endif
107 #ifndef __cplusplus /* C++ has false, true, bool as keywords */
108 # if defined(HAVE_STDBOOL_H) && defined(HAVE_WORKING_BOOL)
109 # include <stdbool.h>
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
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
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
130 /* Some misguided platforms hide the defs for these */
131 #if defined(HAVE_STRCASECMP) && !HAVE_DECL_STRCASECMP
132 int strcasecmp(const char *, const char *);
133 #endif
135 #if defined(HAVE_STRICMP) && !HAVE_DECL_STRICMP
136 int stricmp(const char *, const char *);
137 #endif
139 #if defined(HAVE_STRNCASECMP) && !HAVE_DECL_STRNCASECMP
140 int strncasecmp(const char *, const char *, size_t);
141 #endif
143 #if defined(HAVE_STRNICMP) && !HAVE_DECL_STRNICMP
144 int strnicmp(const char *, const char *, size_t);
145 #endif
147 #if defined(HAVE_STRSEP) && !HAVE_DECL_STRSEP
148 char *strsep(char **, const char *);
149 #endif
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.
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
166 * Hints to the compiler that a particular branch of code is more or
167 * less likely to be taken.
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
178 * How to tell the compiler that a function doesn't return
180 #ifdef __GNUC__
181 # define no_return void __attribute__((noreturn))
182 #else
183 # define no_return void
184 #endif
186 #endif /* NASM_COMPILER_H */