Unreviewed, rolling out r223015 and r223025.
[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 "BAssert.h"
29 #include "BExport.h"
30 #include "BInline.h"
31 #include "BPlatform.h"
32 #include <cstddef>
33 #include <inttypes.h>
34
35 #define PRIMITIVE_GIGACAGE_SIZE 0x800000000llu
36 #define JSVALUE_GIGACAGE_SIZE 0x400000000llu
37 #define STRING_GIGACAGE_SIZE 0x400000000llu
38
39 #define GIGACAGE_SIZE_TO_MASK(size) ((size) - 1)
40
41 #define PRIMITIVE_GIGACAGE_MASK GIGACAGE_SIZE_TO_MASK(PRIMITIVE_GIGACAGE_SIZE)
42 #define JSVALUE_GIGACAGE_MASK GIGACAGE_SIZE_TO_MASK(JSVALUE_GIGACAGE_SIZE)
43 #define STRING_GIGACAGE_MASK GIGACAGE_SIZE_TO_MASK(STRING_GIGACAGE_SIZE)
44
45 // FIXME: Consider making this 32GB, in case unsigned 32-bit indices find their way into indexed accesses.
46 // https://bugs.webkit.org/show_bug.cgi?id=175062
47 #define PRIMITIVE_GIGACAGE_RUNWAY (16llu * 1024 * 1024 * 1024)
48
49 // FIXME: Reconsider this.
50 // https://bugs.webkit.org/show_bug.cgi?id=175921
51 #define JSVALUE_GIGACAGE_RUNWAY 0
52 #define STRING_GIGACAGE_RUNWAY 0
53
54 #if (BOS(DARWIN) || BOS(LINUX)) && BCPU(X86_64)
55 #define GIGACAGE_ENABLED 1
56 #else
57 #define GIGACAGE_ENABLED 0
58 #endif
59
60 #define GIGACAGE_BASE_PTRS_SIZE 8192
61
62 extern "C" BEXPORT char g_gigacageBasePtrs[GIGACAGE_BASE_PTRS_SIZE] __attribute__((aligned(GIGACAGE_BASE_PTRS_SIZE)));
63
64 namespace Gigacage {
65
66 struct BasePtrs {
67     void* primitive;
68     void* jsValue;
69     void* string;
70 };
71
72 enum Kind {
73     Primitive,
74     JSValue,
75     String
76 };
77
78 BEXPORT void ensureGigacage();
79
80 BEXPORT void disablePrimitiveGigacage();
81
82 // This will call the disable callback immediately if the Primitive Gigacage is currently disabled.
83 BEXPORT void addPrimitiveDisableCallback(void (*)(void*), void*);
84 BEXPORT void removePrimitiveDisableCallback(void (*)(void*), void*);
85
86 BEXPORT void disableDisablingPrimitiveGigacageIfShouldBeEnabled();
87
88 BEXPORT bool isDisablingPrimitiveGigacageDisabled();
89 inline bool isPrimitiveGigacagePermanentlyEnabled() { return isDisablingPrimitiveGigacageDisabled(); }
90 inline bool canPrimitiveGigacageBeDisabled() { return !isDisablingPrimitiveGigacageDisabled(); }
91
92 BINLINE const char* name(Kind kind)
93 {
94     switch (kind) {
95     case Primitive:
96         return "Primitive";
97     case JSValue:
98         return "JSValue";
99     case String:
100         return "String";
101     }
102     BCRASH();
103     return nullptr;
104 }
105
106 BINLINE void*& basePtr(BasePtrs& basePtrs, Kind kind)
107 {
108     switch (kind) {
109     case Primitive:
110         return basePtrs.primitive;
111     case JSValue:
112         return basePtrs.jsValue;
113     case String:
114         return basePtrs.string;
115     }
116     BCRASH();
117     return basePtrs.primitive;
118 }
119
120 BINLINE BasePtrs& basePtrs()
121 {
122     return *reinterpret_cast<BasePtrs*>(g_gigacageBasePtrs);
123 }
124
125 BINLINE void*& basePtr(Kind kind)
126 {
127     return basePtr(basePtrs(), kind);
128 }
129
130 BINLINE size_t size(Kind kind)
131 {
132     switch (kind) {
133     case Primitive:
134         return static_cast<size_t>(PRIMITIVE_GIGACAGE_SIZE);
135     case JSValue:
136         return static_cast<size_t>(JSVALUE_GIGACAGE_SIZE);
137     case String:
138         return static_cast<size_t>(STRING_GIGACAGE_SIZE);
139     }
140     BCRASH();
141     return 0;
142 }
143
144 BINLINE size_t alignment(Kind kind)
145 {
146     return size(kind);
147 }
148
149 BINLINE size_t mask(Kind kind)
150 {
151     return GIGACAGE_SIZE_TO_MASK(size(kind));
152 }
153
154 BINLINE size_t runway(Kind kind)
155 {
156     switch (kind) {
157     case Primitive:
158         return static_cast<size_t>(PRIMITIVE_GIGACAGE_RUNWAY);
159     case JSValue:
160         return static_cast<size_t>(JSVALUE_GIGACAGE_RUNWAY);
161     case String:
162         return static_cast<size_t>(STRING_GIGACAGE_RUNWAY);
163     }
164     BCRASH();
165     return 0;
166 }
167
168 BINLINE size_t totalSize(Kind kind)
169 {
170     return size(kind) + runway(kind);
171 }
172
173 template<typename Func>
174 void forEachKind(const Func& func)
175 {
176     func(Primitive);
177     func(JSValue);
178     func(String);
179 }
180
181 template<typename T>
182 BINLINE T* caged(Kind kind, T* ptr)
183 {
184     BASSERT(ptr);
185     void* gigacageBasePtr = basePtr(kind);
186     if (!gigacageBasePtr)
187         return ptr;
188     return reinterpret_cast<T*>(
189         reinterpret_cast<uintptr_t>(gigacageBasePtr) + (
190             reinterpret_cast<uintptr_t>(ptr) & mask(kind)));
191 }
192
193 BINLINE bool isCaged(Kind kind, const void* ptr)
194 {
195     return caged(kind, ptr) == ptr;
196 }
197
198 BEXPORT bool shouldBeEnabled();
199
200 } // namespace Gigacage
201
202