ca67313c7072032ed46d64c04464518f7b027faa
[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
38 #define GIGACAGE_SIZE_TO_MASK(size) ((size) - 1)
39
40 #define PRIMITIVE_GIGACAGE_MASK GIGACAGE_SIZE_TO_MASK(PRIMITIVE_GIGACAGE_SIZE)
41 #define JSVALUE_GIGACAGE_MASK GIGACAGE_SIZE_TO_MASK(JSVALUE_GIGACAGE_SIZE)
42
43 // FIXME: Consider making this 32GB, in case unsigned 32-bit indices find their way into indexed accesses.
44 // https://bugs.webkit.org/show_bug.cgi?id=175062
45 #define PRIMITIVE_GIGACAGE_RUNWAY (16llu * 1024 * 1024 * 1024)
46
47 // FIXME: Reconsider this.
48 // https://bugs.webkit.org/show_bug.cgi?id=175921
49 #define JSVALUE_GIGACAGE_RUNWAY 0
50
51 #if BOS(DARWIN) && BCPU(X86_64)
52 #define GIGACAGE_ENABLED 1
53 #else
54 #define GIGACAGE_ENABLED 0
55 #endif
56
57 extern "C" BEXPORT void* g_primitiveGigacageBasePtr;
58 extern "C" BEXPORT void* g_jsValueGigacageBasePtr;
59
60 namespace Gigacage {
61
62 enum Kind {
63     Primitive,
64     JSValue
65 };
66
67 BEXPORT void ensureGigacage();
68
69 BEXPORT void disablePrimitiveGigacage();
70
71 // This will call the disable callback immediately if the Primitive Gigacage is currently disabled.
72 BEXPORT void addPrimitiveDisableCallback(void (*)(void*), void*);
73 BEXPORT void removePrimitiveDisableCallback(void (*)(void*), void*);
74
75 BEXPORT void disableDisablingPrimitiveGigacageIfShouldBeEnabled();
76
77 BEXPORT bool isDisablingPrimitiveGigacageDisabled();
78 inline bool isPrimitiveGigacagePermanentlyEnabled() { return isDisablingPrimitiveGigacageDisabled(); }
79 inline bool canPrimitiveGigacageBeDisabled() { return !isDisablingPrimitiveGigacageDisabled(); }
80
81 BINLINE const char* name(Kind kind)
82 {
83     switch (kind) {
84     case Primitive:
85         return "Primitive";
86     case JSValue:
87         return "JSValue";
88     }
89     BCRASH();
90     return nullptr;
91 }
92
93 BINLINE void*& basePtr(Kind kind)
94 {
95     switch (kind) {
96     case Primitive:
97         return g_primitiveGigacageBasePtr;
98     case JSValue:
99         return g_jsValueGigacageBasePtr;
100     }
101     BCRASH();
102     return g_primitiveGigacageBasePtr;
103 }
104
105 BINLINE size_t size(Kind kind)
106 {
107     switch (kind) {
108     case Primitive:
109         return static_cast<size_t>(PRIMITIVE_GIGACAGE_SIZE);
110     case JSValue:
111         return static_cast<size_t>(JSVALUE_GIGACAGE_SIZE);
112     }
113     BCRASH();
114     return 0;
115 }
116
117 BINLINE size_t alignment(Kind kind)
118 {
119     return size(kind);
120 }
121
122 BINLINE size_t mask(Kind kind)
123 {
124     return GIGACAGE_SIZE_TO_MASK(size(kind));
125 }
126
127 BINLINE size_t runway(Kind kind)
128 {
129     switch (kind) {
130     case Primitive:
131         return static_cast<size_t>(PRIMITIVE_GIGACAGE_RUNWAY);
132     case JSValue:
133         return static_cast<size_t>(JSVALUE_GIGACAGE_RUNWAY);
134     }
135     BCRASH();
136     return 0;
137 }
138
139 BINLINE size_t totalSize(Kind kind)
140 {
141     return size(kind) + runway(kind);
142 }
143
144 template<typename Func>
145 void forEachKind(const Func& func)
146 {
147     func(Primitive);
148     func(JSValue);
149 }
150
151 template<typename T>
152 BINLINE T* caged(Kind kind, T* ptr)
153 {
154     BASSERT(ptr);
155     void* gigacageBasePtr = basePtr(kind);
156     if (!gigacageBasePtr)
157         return ptr;
158     return reinterpret_cast<T*>(
159         reinterpret_cast<uintptr_t>(gigacageBasePtr) + (
160             reinterpret_cast<uintptr_t>(ptr) & mask(kind)));
161 }
162
163 BINLINE bool isCaged(Kind kind, const void* ptr)
164 {
165     return caged(kind, ptr) == ptr;
166 }
167
168 BEXPORT bool shouldBeEnabled();
169
170 } // namespace Gigacage
171
172