/
portability.h
268 lines (225 loc) · 8.77 KB
/
portability.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
/*
+----------------------------------------------------------------------+
| HipHop for PHP |
+----------------------------------------------------------------------+
| Copyright (c) 2010-present Facebook, Inc. (http://www.facebook.com) |
+----------------------------------------------------------------------+
| This source file is subject to version 3.01 of the PHP license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| http://www.php.net/license/3_01.txt |
| If you did not receive a copy of the PHP license and are unable to |
| obtain it through the world-wide-web, please send a note to |
| license@php.net so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
*/
#ifndef incl_HPHP_PORTABILITY_H_
#define incl_HPHP_PORTABILITY_H_
#include <folly/Likely.h> // defining LIKELY/UNLIKELY is part of this header
#include <folly/Portability.h>
#include <folly/CPortability.h> // defining FOLLY_DISABLE_ADDRESS_SANITIZER
//////////////////////////////////////////////////////////////////////
/*
* Various macros to make certain things conditional on either
* compiler or architecture.
*
* Currently we don't *really* compile on anything other than gcc or
* sometimes clang, and there are some parts of the code using
* __attribute__ stuff directly, but some things go through these
* macros to make it maybe easier to change later.
*/
//////////////////////////////////////////////////////////////////////
// TODO: does clang define __GNUC__ ?
#ifndef __GNUC__
# define __attribute__(x)
#endif
//////////////////////////////////////////////////////////////////////
#ifdef ATTRIBUTE_UNUSED
# undef ATTRIBUTE_UNUSED
#endif
#ifdef ATTRIBUTE_PRINTF
# undef ATTRIBUTE_PRINTF
#endif
#ifdef ATTRIBUTE_PRINTF_STRING
# undef ATTRIBUTE_PRINTF_STRING
#endif
#define ATTRIBUTE_PRINTF_STRING FOLLY_PRINTF_FORMAT
#ifdef _MSC_VER
#define ATTRIBUTE_PRINTF(a1, a2)
#ifndef __thread
# define __thread __declspec(thread)
#endif
#define ATTRIBUTE_UNUSED
#define ATTRIBUTE_USED
#define ALWAYS_INLINE __forceinline
#define EXTERNALLY_VISIBLE
#define FLATTEN
#define NEVER_INLINE __declspec(noinline)
#define UNUSED
#else
#define ATTRIBUTE_PRINTF(a1, a2) \
__attribute__((__format__ (__printf__, a1, a2)))
#define ATTRIBUTE_UNUSED __attribute__((__unused__))
#define ATTRIBUTE_USED __attribute__((__used__))
#define ALWAYS_INLINE inline __attribute__((__always_inline__))
#define EXTERNALLY_VISIBLE __attribute__((__externally_visible__))
#define FLATTEN __attribute__((__flatten__))
#define INLINE_FLATTEN inline __attribute__((__always_inline__,__flatten__))
#define NEVER_INLINE __attribute__((__noinline__))
#define UNUSED __attribute__((__unused__))
#endif
#ifdef __clang__
#define NO_OPT [[clang::optnone]]
#else
#define NO_OPT __attribute__((__optimize__("O0")))
#endif
#if defined(__GNUC__)
# define HHVM_ATTRIBUTE_WEAK __attribute__((__weak__))
#elif defined(__clang__)
# define HHVM_ATTRIBUTE_WEAK __attribute__((__weak_import__))
#else
# define HHVM_ATTRIBUTE_WEAK
#endif
#ifdef DEBUG
# define DEBUG_ONLY /* nop */
#else
# define DEBUG_ONLY UNUSED
#endif
/*
* AARCH64 needs to create a walkable stack frame for
* getFrameRegs() when a FixupEntry isIndirect()
*/
#ifdef __aarch64__
#define AARCH64_WALKABLE_FRAME() asm("" ::: "memory");
#else
#define AARCH64_WALKABLE_FRAME()
#endif
/*
* We need to keep some unreferenced functions from being removed by
* the linker. There is no compile time mechanism for doing this, but
* by putting them in the same section as some other, referenced function
* in the same file, we can keep them around.
*
* So this macro should be used to mark at least one function that is
* referenced, and other functions that are not referenced in the same
* file.
*
* Note: this may not work properly with LTO. We'll revisit when/if we
* move to it.
*/
#ifndef __APPLE__
# define KEEP_SECTION \
__attribute__((__section__(".text.keep")))
#else
# define KEEP_SECTION \
__attribute__((__section__(".text,.text.keep")))
#endif
#if defined(__APPLE__)
// OS X has a macro "isset" defined in this header. Force the include so we can
// make sure the macro gets undef'd. (I think this also applies to BSD, but we
// can cross that road when we come to it.)
# include <sys/param.h>
# ifdef isset
# undef isset
# endif
#endif
//////////////////////////////////////////////////////////////////////
// DECLARE_FRAME_POINTER
#if defined(__x86_64__)
# define DECLARE_FRAME_POINTER(fp) \
auto const fp = (ActRec*) __builtin_frame_address(0)
# define FRAME_POINTER_IS_ACCURATE
#elif defined(_M_X64)
// TODO: FIXME! Without this implemented properly, the JIT
// will fail "pretty spectacularly".
# define DECLARE_FRAME_POINTER(fp) \
always_assert(false); \
register ActRec* fp = nullptr;
#elif defined(__AARCH64EL__)
# if defined(__clang__)
# error Clang implementation not done for ARM
# endif
# define DECLARE_FRAME_POINTER(fp) register ActRec* fp asm("x29")
#elif defined(__powerpc64__)
# if defined(__clang__)
# error Clang implementation not done for PPC64
# endif
# define DECLARE_FRAME_POINTER(fp) \
auto const fp = (ActRec*) __builtin_frame_address(0)
# define FRAME_POINTER_IS_ACCURATE
#else
# error What are the stack and frame pointers called on your architecture?
#endif
//////////////////////////////////////////////////////////////////////
// CALLEE_SAVED_BARRIER
#ifdef _MSC_VER
// Unfortunately, we have no way to tell MSVC to do this, so we'll
// probably have to use a pair of assembly stubs to manage this.
#define CALLEE_SAVED_BARRIER() always_assert(false);
#elif defined (__powerpc64__)
// After gcc 5.4.1 we can't clobber r30 on PPC64 anymore because it's used as
// PIC register.
#if __GNUC__ > 5 || (__GNUC__ == 5 && (__GNUC_MINOR__ >= 4) && \
(__GNUC_PATCHLEVEL__ >= 1))
#define CALLEE_SAVED_BARRIER()\
asm volatile("" : : : "r2", "r14", "r15", "r16", "r17", "r18", "r19",\
"r20", "r21", "r22", "r23", "r24", "r25", "r26", "r27", \
"r28", "r29", "cr2", "cr3", "cr4", "v20", "v21", "v22", \
"v23", "v24", "v25", "v26", "v27", "v28", "v29", "v30", \
"v31");
#else
// On gcc versions < 5.4.1 we need to include r30 on barrier as it's not
// saved by gcc.
#define CALLEE_SAVED_BARRIER()\
asm volatile("" : : : "r2", "r14", "r15", "r16", "r17", "r18", "r19",\
"r20", "r21", "r22", "r23", "r24", "r25", "r26", "r27", \
"r28", "r29", "r30", "cr2", "cr3", "cr4", "v20", "v21", \
"v22", "v23", "v24", "v25", "v26", "v27", "v28", "v29", \
"v30", "v31");
#endif
#elif defined (__AARCH64EL__)
#define CALLEE_SAVED_BARRIER()\
asm volatile("" : : : "x19", "x20", "x21", "x22", "x23", "x24", "x25",\
"x26", "x27", "x28")
#else
#define CALLEE_SAVED_BARRIER()\
asm volatile("" : : : "rbx", "r12", "r13", "r14", "r15");
#endif
//////////////////////////////////////////////////////////////////////
// We reserve the exit status 127 to signal a failure in the
// interpreter. 127 is a valid exit code on all reasonable
// architectures: POSIX requires at least 8 unsigned bits and
// Windows 32 signed bits.
#define HPHP_EXIT_FAILURE 127
//////////////////////////////////////////////////////////////////////
#if FACEBOOK
#define USE_FOLLY_SYMBOLIZER 1
// Linking in libbfd is a gigantic PITA, but if folly symbolizer doesn't
// work on your platform, you'll need to figure it out.
#define HAVE_LIBBFD 1
#endif
#ifndef PACKAGE
// The value doesn't matter, but it must be defined before you include
// bfd.h
#define PACKAGE "hhvm"
#endif
//////////////////////////////////////////////////////////////////////
#ifdef _MSC_VER
# include "hphp/util/portability/fnmatch.h"
# include "hphp/util/portability/glob.h"
# include "hphp/util/portability/rand_r.h"
# include "hphp/util/portability/strfmon.h"
#endif
#if defined(_MSC_VER) && _MSC_FULL_VER <= 190023506 // 2015 Update 1 or below
// MSVC2015 has an issue with getting function pointers to templated functions
// if the expected result type isn't auto. Unfortunately, when I made the
// initial bug report, I oversimplified the use-case, and, while the case I
// reported was indeed fixed in Update 1 RC, none of our actual uses of it were
// fixed.
// This is being tracked at MS as #163251.
# define MSVC_REQUIRE_AUTO_TEMPLATED_OVERLOAD 1
// 2015 RTM doesn't like it when you try to add via a double duration.
// Bug Report: https://connect.microsoft.com/VisualStudio/feedback/details/1839243
# define MSVC_NO_STD_CHRONO_DURATION_DOUBLE_ADD 1
#endif
#endif