3a823db04c9ef1f6c36ea3a6220e60bb60cebfd1
[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 #if BCPU(ARM64)
36 // FIXME: This can probably be a lot bigger on iOS. I just haven't tried to make it bigger yet.
37 // https://bugs.webkit.org/show_bug.cgi?id=177605
38 #define PRIMITIVE_GIGACAGE_SIZE 0x40000000llu
39 #define JSVALUE_GIGACAGE_SIZE 0x40000000llu
40 #define STRING_GIGACAGE_SIZE 0x40000000llu
41 #define GIGACAGE_ALLOCATION_CAN_FAIL 1
42 #else
43 #define PRIMITIVE_GIGACAGE_SIZE 0x800000000llu
44 #define JSVALUE_GIGACAGE_SIZE 0x400000000llu
45 #define STRING_GIGACAGE_SIZE 0x400000000llu
46 #define GIGACAGE_ALLOCATION_CAN_FAIL 0
47 #endif
48
49 #define GIGACAGE_SIZE_TO_MASK(size) ((size) - 1)
50
51 #define PRIMITIVE_GIGACAGE_MASK GIGACAGE_SIZE_TO_MASK(PRIMITIVE_GIGACAGE_SIZE)
52 #define JSVALUE_GIGACAGE_MASK GIGACAGE_SIZE_TO_MASK(JSVALUE_GIGACAGE_SIZE)
53 #define STRING_GIGACAGE_MASK GIGACAGE_SIZE_TO_MASK(STRING_GIGACAGE_SIZE)
54
55 #if (BOS(DARWIN) && (BCPU(ARM64) || BCPU(X86_64))) || (BOS(LINUX) && BCPU(X86_64))
56 #define GIGACAGE_ENABLED 1
57 #else
58 #define GIGACAGE_ENABLED 0
59 #endif
60
61 #if BCPU(ARM64)
62 #define GIGACAGE_BASE_PTRS_SIZE 16384
63 #else
64 #define GIGACAGE_BASE_PTRS_SIZE 4096
65 #endif
66
67 extern "C" BEXPORT char g_gigacageBasePtrs[GIGACAGE_BASE_PTRS_SIZE] __attribute__((aligned(GIGACAGE_BASE_PTRS_SIZE)));
68
69 namespace Gigacage {
70
71 extern BEXPORT bool g_wasEnabled;
72 BINLINE bool wasEnabled() { return g_wasEnabled; }
73
74 struct BasePtrs {
75     void* primitive;
76     void* jsValue;
77     void* string;
78 };
79
80 enum Kind {
81     Primitive,
82     JSValue,
83     String
84 };
85
86 BEXPORT void ensureGigacage();
87
88 BEXPORT void disablePrimitiveGigacage();
89
90 // This will call the disable callback immediately if the Primitive Gigacage is currently disabled.
91 BEXPORT void addPrimitiveDisableCallback(void (*)(void*), void*);
92 BEXPORT void removePrimitiveDisableCallback(void (*)(void*), void*);
93
94 BEXPORT void disableDisablingPrimitiveGigacageIfShouldBeEnabled();
95
96 BEXPORT bool isDisablingPrimitiveGigacageDisabled();
97 inline bool isPrimitiveGigacagePermanentlyEnabled() { return isDisablingPrimitiveGigacageDisabled(); }
98 inline bool canPrimitiveGigacageBeDisabled() { return !isDisablingPrimitiveGigacageDisabled(); }
99
100 BINLINE const char* name(Kind kind)
101 {
102     switch (kind) {
103     case Primitive:
104         return "Primitive";
105     case JSValue:
106         return "JSValue";
107     case String:
108         return "String";
109     }
110     BCRASH();
111     return nullptr;
112 }
113
114 BINLINE void*& basePtr(BasePtrs& basePtrs, Kind kind)
115 {
116     switch (kind) {
117     case Primitive:
118         return basePtrs.primitive;
119     case JSValue:
120         return basePtrs.jsValue;
121     case String:
122         return basePtrs.string;
123     }
124     BCRASH();
125     return basePtrs.primitive;
126 }
127
128 BINLINE BasePtrs& basePtrs()
129 {
130     return *reinterpret_cast<BasePtrs*>(g_gigacageBasePtrs);
131 }
132
133 BINLINE void*& basePtr(Kind kind)
134 {
135     return basePtr(basePtrs(), kind);
136 }
137
138 BINLINE bool isEnabled(Kind kind)
139 {
140     return !!basePtr(kind);
141 }
142
143 BINLINE size_t size(Kind kind)
144 {
145     switch (kind) {
146     case Primitive:
147         return static_cast<size_t>(PRIMITIVE_GIGACAGE_SIZE);
148     case JSValue:
149         return static_cast<size_t>(JSVALUE_GIGACAGE_SIZE);
150     case String:
151         return static_cast<size_t>(STRING_GIGACAGE_SIZE);
152     }
153     BCRASH();
154     return 0;
155 }
156
157 BINLINE size_t alignment(Kind kind)
158 {
159     return size(kind);
160 }
161
162 BINLINE size_t mask(Kind kind)
163 {
164     return GIGACAGE_SIZE_TO_MASK(size(kind));
165 }
166
167 size_t runway(Kind kind);
168 size_t totalSize(Kind kind);
169
170 template<typename Func>
171 void forEachKind(const Func& func)
172 {
173     func(Primitive);
174     func(JSValue);
175     func(String);
176 }
177
178 template<typename T>
179 BINLINE T* caged(Kind kind, T* ptr)
180 {
181     BASSERT(ptr);
182     void* gigacageBasePtr = basePtr(kind);
183     if (!gigacageBasePtr)
184         return ptr;
185     return reinterpret_cast<T*>(
186         reinterpret_cast<uintptr_t>(gigacageBasePtr) + (
187             reinterpret_cast<uintptr_t>(ptr) & mask(kind)));
188 }
189
190 BINLINE bool isCaged(Kind kind, const void* ptr)
191 {
192     return caged(kind, ptr) == ptr;
193 }
194
195 BEXPORT bool shouldBeEnabled();
196
197 } // namespace Gigacage
198
199