Strings need to be in some kind of gigacage
[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) && BCPU(X86_64)
55 #define GIGACAGE_ENABLED 1
56 #else
57 #define GIGACAGE_ENABLED 0
58 #endif
59
60 extern "C" BEXPORT void* g_primitiveGigacageBasePtr;
61 extern "C" BEXPORT void* g_jsValueGigacageBasePtr;
62 extern "C" BEXPORT void* g_stringGigacageBasePtr;
63
64 namespace Gigacage {
65
66 enum Kind {
67     Primitive,
68     JSValue,
69     String
70 };
71
72 BEXPORT void ensureGigacage();
73
74 BEXPORT void disablePrimitiveGigacage();
75
76 // This will call the disable callback immediately if the Primitive Gigacage is currently disabled.
77 BEXPORT void addPrimitiveDisableCallback(void (*)(void*), void*);
78 BEXPORT void removePrimitiveDisableCallback(void (*)(void*), void*);
79
80 BEXPORT void disableDisablingPrimitiveGigacageIfShouldBeEnabled();
81
82 BEXPORT bool isDisablingPrimitiveGigacageDisabled();
83 inline bool isPrimitiveGigacagePermanentlyEnabled() { return isDisablingPrimitiveGigacageDisabled(); }
84 inline bool canPrimitiveGigacageBeDisabled() { return !isDisablingPrimitiveGigacageDisabled(); }
85
86 BINLINE const char* name(Kind kind)
87 {
88     switch (kind) {
89     case Primitive:
90         return "Primitive";
91     case JSValue:
92         return "JSValue";
93     case String:
94         return "String";
95     }
96     BCRASH();
97     return nullptr;
98 }
99
100 BINLINE void*& basePtr(Kind kind)
101 {
102     switch (kind) {
103     case Primitive:
104         return g_primitiveGigacageBasePtr;
105     case JSValue:
106         return g_jsValueGigacageBasePtr;
107     case String:
108         return g_stringGigacageBasePtr;
109     }
110     BCRASH();
111     return g_primitiveGigacageBasePtr;
112 }
113
114 BINLINE size_t size(Kind kind)
115 {
116     switch (kind) {
117     case Primitive:
118         return static_cast<size_t>(PRIMITIVE_GIGACAGE_SIZE);
119     case JSValue:
120         return static_cast<size_t>(JSVALUE_GIGACAGE_SIZE);
121     case String:
122         return static_cast<size_t>(STRING_GIGACAGE_SIZE);
123     }
124     BCRASH();
125     return 0;
126 }
127
128 BINLINE size_t alignment(Kind kind)
129 {
130     return size(kind);
131 }
132
133 BINLINE size_t mask(Kind kind)
134 {
135     return GIGACAGE_SIZE_TO_MASK(size(kind));
136 }
137
138 BINLINE size_t runway(Kind kind)
139 {
140     switch (kind) {
141     case Primitive:
142         return static_cast<size_t>(PRIMITIVE_GIGACAGE_RUNWAY);
143     case JSValue:
144         return static_cast<size_t>(JSVALUE_GIGACAGE_RUNWAY);
145     case String:
146         return static_cast<size_t>(STRING_GIGACAGE_RUNWAY);
147     }
148     BCRASH();
149     return 0;
150 }
151
152 BINLINE size_t totalSize(Kind kind)
153 {
154     return size(kind) + runway(kind);
155 }
156
157 template<typename Func>
158 void forEachKind(const Func& func)
159 {
160     func(Primitive);
161     func(JSValue);
162     func(String);
163 }
164
165 template<typename T>
166 BINLINE T* caged(Kind kind, T* ptr)
167 {
168     BASSERT(ptr);
169     void* gigacageBasePtr = basePtr(kind);
170     if (!gigacageBasePtr)
171         return ptr;
172     return reinterpret_cast<T*>(
173         reinterpret_cast<uintptr_t>(gigacageBasePtr) + (
174             reinterpret_cast<uintptr_t>(ptr) & mask(kind)));
175 }
176
177 BINLINE bool isCaged(Kind kind, const void* ptr)
178 {
179     return caged(kind, ptr) == ptr;
180 }
181
182 BEXPORT bool shouldBeEnabled();
183
184 } // namespace Gigacage
185
186