Define GIGACAGE_ALLOCATION_CAN_FAIL on Linux
[WebKit-https.git] / Source / bmalloc / bmalloc / Gigacage.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "Algorithm.h"
29 #include "BAssert.h"
30 #include "BExport.h"
31 #include "BInline.h"
32 #include "BPlatform.h"
33 #include <cstddef>
34 #include <inttypes.h>
35
36 #if BCPU(ARM64)
37 #define PRIMITIVE_GIGACAGE_SIZE 0x80000000llu
38 #define JSVALUE_GIGACAGE_SIZE 0x40000000llu
39 #define GIGACAGE_ALLOCATION_CAN_FAIL 1
40 #else
41 #define PRIMITIVE_GIGACAGE_SIZE 0x800000000llu
42 #define JSVALUE_GIGACAGE_SIZE 0x400000000llu
43 #define GIGACAGE_ALLOCATION_CAN_FAIL 0
44 #endif
45
46 // In Linux, if `vm.overcommit_memory = 2` is specified, mmap with large size can fail if it exceeds the size of RAM.
47 // So we specify GIGACAGE_ALLOCATION_CAN_FAIL = 1.
48 #if BOS(LINUX)
49 #undef GIGACAGE_ALLOCATION_CAN_FAIL
50 #define GIGACAGE_ALLOCATION_CAN_FAIL 1
51 #endif
52
53 static_assert(bmalloc::isPowerOfTwo(PRIMITIVE_GIGACAGE_SIZE), "");
54 static_assert(bmalloc::isPowerOfTwo(JSVALUE_GIGACAGE_SIZE), "");
55
56 #define GIGACAGE_SIZE_TO_MASK(size) ((size) - 1)
57
58 #define PRIMITIVE_GIGACAGE_MASK GIGACAGE_SIZE_TO_MASK(PRIMITIVE_GIGACAGE_SIZE)
59 #define JSVALUE_GIGACAGE_MASK GIGACAGE_SIZE_TO_MASK(JSVALUE_GIGACAGE_SIZE)
60
61 #if ((BOS(DARWIN) || BOS(LINUX)) && \
62     (BCPU(X86_64) || (BCPU(ARM64) && !defined(__ILP32__) && (!BPLATFORM(IOS) || __IPHONE_OS_VERSION_MIN_REQUIRED >= 110300))))
63 #define GIGACAGE_ENABLED 1
64 #else
65 #define GIGACAGE_ENABLED 0
66 #endif
67
68 #if BCPU(ARM64)
69 #define GIGACAGE_BASE_PTRS_SIZE 16384
70 #else
71 #define GIGACAGE_BASE_PTRS_SIZE 4096
72 #endif
73
74 extern "C" alignas(GIGACAGE_BASE_PTRS_SIZE) BEXPORT char g_gigacageBasePtrs[GIGACAGE_BASE_PTRS_SIZE];
75
76 namespace Gigacage {
77
78 extern BEXPORT bool g_wasEnabled;
79 BINLINE bool wasEnabled() { return g_wasEnabled; }
80
81 struct BasePtrs {
82     void* primitive;
83     void* jsValue;
84 };
85
86 enum Kind {
87     Primitive,
88     JSValue,
89 };
90
91 static constexpr unsigned numKinds = 2;
92
93 BEXPORT void ensureGigacage();
94
95 BEXPORT void disablePrimitiveGigacage();
96
97 // This will call the disable callback immediately if the Primitive Gigacage is currently disabled.
98 BEXPORT void addPrimitiveDisableCallback(void (*)(void*), void*);
99 BEXPORT void removePrimitiveDisableCallback(void (*)(void*), void*);
100
101 BEXPORT void disableDisablingPrimitiveGigacageIfShouldBeEnabled();
102
103 BEXPORT bool isDisablingPrimitiveGigacageDisabled();
104 inline bool isPrimitiveGigacagePermanentlyEnabled() { return isDisablingPrimitiveGigacageDisabled(); }
105 inline bool canPrimitiveGigacageBeDisabled() { return !isDisablingPrimitiveGigacageDisabled(); }
106
107 BINLINE const char* name(Kind kind)
108 {
109     switch (kind) {
110     case Primitive:
111         return "Primitive";
112     case JSValue:
113         return "JSValue";
114     }
115     BCRASH();
116     return nullptr;
117 }
118
119 BINLINE void*& basePtr(BasePtrs& basePtrs, Kind kind)
120 {
121     switch (kind) {
122     case Primitive:
123         return basePtrs.primitive;
124     case JSValue:
125         return basePtrs.jsValue;
126     }
127     BCRASH();
128     return basePtrs.primitive;
129 }
130
131 BINLINE BasePtrs& basePtrs()
132 {
133     return *reinterpret_cast<BasePtrs*>(reinterpret_cast<void*>(g_gigacageBasePtrs));
134 }
135
136 BINLINE void*& basePtr(Kind kind)
137 {
138     return basePtr(basePtrs(), kind);
139 }
140
141 BINLINE bool isEnabled(Kind kind)
142 {
143     return !!basePtr(kind);
144 }
145
146 BINLINE size_t size(Kind kind)
147 {
148     switch (kind) {
149     case Primitive:
150         return static_cast<size_t>(PRIMITIVE_GIGACAGE_SIZE);
151     case JSValue:
152         return static_cast<size_t>(JSVALUE_GIGACAGE_SIZE);
153     }
154     BCRASH();
155     return 0;
156 }
157
158 BINLINE size_t alignment(Kind kind)
159 {
160     return size(kind);
161 }
162
163 BINLINE size_t mask(Kind kind)
164 {
165     return GIGACAGE_SIZE_TO_MASK(size(kind));
166 }
167
168 template<typename Func>
169 void forEachKind(const Func& func)
170 {
171     func(Primitive);
172     func(JSValue);
173 }
174
175 template<typename T>
176 BINLINE T* caged(Kind kind, T* ptr)
177 {
178     BASSERT(ptr);
179     void* gigacageBasePtr = basePtr(kind);
180     if (!gigacageBasePtr)
181         return ptr;
182     return reinterpret_cast<T*>(
183         reinterpret_cast<uintptr_t>(gigacageBasePtr) + (
184             reinterpret_cast<uintptr_t>(ptr) & mask(kind)));
185 }
186
187 BINLINE bool isCaged(Kind kind, const void* ptr)
188 {
189     return caged(kind, ptr) == ptr;
190 }
191
192 BEXPORT bool shouldBeEnabled();
193
194 } // namespace Gigacage
195
196