Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Expand file tree
/
Copy pathWasmMemory.cpp
More file actions
458 lines (380 loc) · 17.8 KB
/
WasmMemory.cpp
File metadata and controls
458 lines (380 loc) · 17.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
/*
* Copyright (C) 2016-2024 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "WasmMemory.h"
#if ENABLE(WEBASSEMBLY)
#include "JSCInlines.h"
#include "JSWebAssemblyInstance.h"
#include "Options.h"
#include "WasmFaultSignalHandler.h"
#include "WeakGCSetInlines.h"
#include <wtf/CheckedArithmetic.h>
#include <wtf/DataLog.h>
#include <wtf/FastMalloc.h>
#include <wtf/Lock.h>
#include <wtf/Platform.h>
#include <wtf/PrintStream.h>
#include <wtf/RAMSize.h>
#include <wtf/SafeStrerror.h>
#include <wtf/StdSet.h>
#include <wtf/TZoneMallocInlines.h>
#include <wtf/Vector.h>
#include <cstring>
#include <limits>
#include <mutex>
WTF_ALLOW_UNSAFE_BUFFER_USAGE_BEGIN
namespace JSC {
namespace Wasm {
WTF_MAKE_TZONE_ALLOCATED_IMPL(Memory);
// FIXME: We could be smarter about memset / mmap / madvise. https://bugs.webkit.org/show_bug.cgi?id=170343
// FIXME: Give up some of the cached fast memories if the GC determines it's easy to get them back, and they haven't been used in a while. https://bugs.webkit.org/show_bug.cgi?id=170773
// FIXME: Limit slow memory size. https://bugs.webkit.org/show_bug.cgi?id=170825
namespace {
constexpr bool verbose = false;
NEVER_INLINE NO_RETURN_DUE_TO_CRASH void webAssemblyCouldntGetFastMemory() { CRASH(); }
template<typename Func>
static bool tryAllocate(VM& vm, const Func& allocate)
{
unsigned numTries = 2;
bool done = false;
for (unsigned i = 0; i < numTries && !done; ++i) {
switch (allocate()) {
case BufferMemoryResult::Kind::Success:
done = true;
break;
case BufferMemoryResult::Kind::SuccessAndNotifyMemoryPressure:
vm.heap.collectAsync(CollectionScope::Full);
done = true;
break;
case BufferMemoryResult::Kind::SyncTryToReclaimMemory:
if (i + 1 == numTries)
break;
vm.heap.collectSync(CollectionScope::Full);
break;
}
}
return done;
}
} // anonymous namespace
Memory::Memory()
: m_handle(adoptRef(*new BufferMemoryHandle(BufferMemoryHandle::nullBasePointer(), 0, 0, PageCount(0), PageCount(0), MemorySharingMode::Default, MemoryMode::BoundsChecking)))
{
}
Memory::Memory(PageCount initial, PageCount maximum, MemorySharingMode sharingMode, AddressType addressType, WTF::Function<void(GrowSuccess, PageCount, PageCount)>&& growSuccessCallback)
: m_handle(adoptRef(*new BufferMemoryHandle(BufferMemoryHandle::nullBasePointer(), 0, 0, initial, maximum, sharingMode, MemoryMode::BoundsChecking)))
, m_growSuccessCallback(WTF::move(growSuccessCallback))
, m_addressType(addressType)
{
ASSERT(!initial.bytes());
ASSERT(mode() == MemoryMode::BoundsChecking);
dataLogLnIf(verbose, "Memory::Memory allocating ", *this);
ASSERT(basePointer());
}
Memory::Memory(Ref<BufferMemoryHandle>&& handle, AddressType addressType, WTF::Function<void(GrowSuccess, PageCount, PageCount)>&& growSuccessCallback)
: m_handle(WTF::move(handle))
, m_growSuccessCallback(WTF::move(growSuccessCallback))
, m_addressType(addressType)
{
dataLogLnIf(verbose, "Memory::Memory allocating ", *this);
}
Memory::Memory(Ref<BufferMemoryHandle>&& handle, Ref<SharedArrayBufferContents>&& shared, AddressType addressType, WTF::Function<void(GrowSuccess, PageCount, PageCount)>&& growSuccessCallback)
: m_handle(WTF::move(handle))
, m_shared(WTF::move(shared))
, m_growSuccessCallback(WTF::move(growSuccessCallback))
, m_addressType(addressType)
{
dataLogLnIf(verbose, "Memory::Memory allocating ", *this);
}
Ref<Memory> Memory::create()
{
return adoptRef(*new Memory());
}
Ref<Memory> Memory::create(Ref<BufferMemoryHandle>&& handle, AddressType addressType, WTF::Function<void(GrowSuccess, PageCount, PageCount)>&& growSuccessCallback)
{
return adoptRef(*new Memory(WTF::move(handle), addressType, WTF::move(growSuccessCallback)));
}
Ref<Memory> Memory::create(Ref<SharedArrayBufferContents>&& shared, AddressType addressType, WTF::Function<void(GrowSuccess, PageCount, PageCount)>&& growSuccessCallback)
{
RefPtr<BufferMemoryHandle> handle = shared->memoryHandle();
ASSERT(handle);
return adoptRef(*new Memory(handle.releaseNonNull(), WTF::move(shared), addressType, WTF::move(growSuccessCallback)));
}
Ref<Memory> Memory::createZeroSized(MemorySharingMode sharingMode, AddressType addressType, WTF::Function<void(GrowSuccess, PageCount, PageCount)>&& growSuccessCallback)
{
return adoptRef(*new Memory(PageCount(0), PageCount(0), sharingMode, addressType, WTF::move(growSuccessCallback)));
}
RefPtr<Memory> Memory::tryCreate(VM& vm, PageCount initial, PageCount maximum, MemorySharingMode sharingMode, AddressType addressType, std::optional<MemoryMode> desiredMemoryMode, WTF::Function<void(GrowSuccess, PageCount, PageCount)>&& growSuccessCallback)
{
ASSERT(initial);
RELEASE_ASSERT(!maximum || maximum >= initial); // This should be guaranteed by our caller.
const uint64_t initialBytes = initial.bytes();
const uint64_t maximumBytes = maximum ? maximum.bytes() : 0;
if (initialBytes > MAX_ARRAY_BUFFER_SIZE)
return nullptr; // Client will throw OOMError.
if (maximum && !maximumBytes) {
// User specified a zero maximum, initial size must also be zero.
RELEASE_ASSERT(!initialBytes);
return createZeroSized(sharingMode, addressType, WTF::move(growSuccessCallback));
}
bool done = tryAllocate(vm,
[&] () -> BufferMemoryResult::Kind {
return BufferMemoryManager::singleton().tryAllocatePhysicalBytes(initialBytes);
});
if (!done)
return nullptr;
char* fastMemory = nullptr;
if (Options::useWasmFastMemory() && desiredMemoryMode.value_or(MemoryMode::Signaling) == MemoryMode::Signaling && !addressType.is64Bit()) {
#if CPU(ADDRESS32)
RELEASE_ASSERT_NOT_REACHED_WITH_MESSAGE("32-bit platforms don't support fast memory.");
#endif
tryAllocate(vm,
[&] () -> BufferMemoryResult::Kind {
auto result = BufferMemoryManager::singleton().tryAllocateFastMemory();
fastMemory = std::bit_cast<char*>(result.basePtr);
return result.kind;
});
}
if (fastMemory) {
constexpr bool readable = false;
constexpr bool writable = false;
OSAllocator::protect(fastMemory + initialBytes, BufferMemoryHandle::fastMappedBytes() - initialBytes, readable, writable);
switch (sharingMode) {
case MemorySharingMode::Default: {
return Memory::create(adoptRef(*new BufferMemoryHandle(fastMemory, initialBytes, BufferMemoryHandle::fastMappedBytes(), initial, maximum, MemorySharingMode::Default, MemoryMode::Signaling)), addressType, WTF::move(growSuccessCallback));
}
case MemorySharingMode::Shared: {
auto handle = adoptRef(*new BufferMemoryHandle(fastMemory, initialBytes, BufferMemoryHandle::fastMappedBytes(), initial, maximum, MemorySharingMode::Shared, MemoryMode::Signaling));
auto span = handle->mutableSpan();
auto content = SharedArrayBufferContents::create(span, maximumBytes, WTF::move(handle), nullptr, SharedArrayBufferContents::Mode::WebAssembly);
return Memory::create(WTF::move(content), addressType, WTF::move(growSuccessCallback));
}
}
RELEASE_ASSERT_NOT_REACHED();
return nullptr;
}
if (desiredMemoryMode == MemoryMode::Signaling)
return nullptr;
if (Options::crashIfWasmCantFastMemory()) [[unlikely]]
webAssemblyCouldntGetFastMemory();
switch (sharingMode) {
case MemorySharingMode::Default: {
if (!initialBytes)
return adoptRef(new Memory(initial, maximum, MemorySharingMode::Default, addressType, WTF::move(growSuccessCallback)));
void* slowMemory = Gigacage::tryAllocateZeroedVirtualPages(Gigacage::Primitive, initialBytes);
if (!slowMemory) {
BufferMemoryManager::singleton().freePhysicalBytes(initialBytes);
return nullptr;
}
return Memory::create(adoptRef(*new BufferMemoryHandle(slowMemory, initialBytes, initialBytes, initial, maximum, MemorySharingMode::Default, MemoryMode::BoundsChecking)), addressType, WTF::move(growSuccessCallback));
}
case MemorySharingMode::Shared: {
char* slowMemory = nullptr;
tryAllocate(vm,
[&] () -> BufferMemoryResult::Kind {
auto result = BufferMemoryManager::singleton().tryAllocateGrowableBoundsCheckingMemory(maximumBytes);
slowMemory = std::bit_cast<char*>(result.basePtr);
return result.kind;
});
if (!slowMemory) {
BufferMemoryManager::singleton().freePhysicalBytes(initialBytes);
return nullptr;
}
constexpr bool readable = false;
constexpr bool writable = false;
OSAllocator::protect(slowMemory + initialBytes, maximumBytes - initialBytes, readable, writable);
auto handle = adoptRef(*new BufferMemoryHandle(slowMemory, initialBytes, maximumBytes, initial, maximum, MemorySharingMode::Shared, MemoryMode::BoundsChecking));
auto span = handle->mutableSpan();
auto content = SharedArrayBufferContents::create(span, maximumBytes, WTF::move(handle), nullptr, SharedArrayBufferContents::Mode::WebAssembly);
return Memory::create(WTF::move(content), addressType, WTF::move(growSuccessCallback));
}
}
RELEASE_ASSERT_NOT_REACHED();
return nullptr;
}
Memory::~Memory() = default;
bool Memory::addressIsInGrowableOrFastMemory(void* address)
{
return BufferMemoryManager::singleton().isInGrowableOrFastMemory(address);
}
Expected<PageCount, GrowFailReason> Memory::growShared(VM& vm, PageCount delta)
{
PageCount oldPageCount;
PageCount newPageCount;
Expected<int64_t, GrowFailReason> result;
{
std::optional<Locker<Lock>> locker;
// m_shared may not be exist, if this is zero byte memory with zero byte maximum size.
if (m_shared)
locker.emplace(m_shared->memoryHandle()->lock());
oldPageCount = PageCount::fromBytes(size());
newPageCount = oldPageCount + delta;
if (!newPageCount || !newPageCount.isValid())
return makeUnexpected(GrowFailReason::InvalidGrowSize);
if (newPageCount.bytes() > MAX_ARRAY_BUFFER_SIZE)
return makeUnexpected(GrowFailReason::OutOfMemory);
if (!delta.pageCount())
return oldPageCount;
dataLogLnIf(verbose, "Memory::grow(", delta, ") to ", newPageCount, " from ", *this);
RELEASE_ASSERT(newPageCount > PageCount::fromBytes(size()));
if (maximum() && newPageCount > maximum())
return makeUnexpected(GrowFailReason::WouldExceedMaximum);
size_t desiredSize = newPageCount.bytes();
RELEASE_ASSERT(m_shared);
RELEASE_ASSERT(desiredSize <= MAX_ARRAY_BUFFER_SIZE);
RELEASE_ASSERT(desiredSize > size());
constexpr bool sizeMustBePageMultiple = true;
result = m_shared->grow(locker.value(), vm, desiredSize, sizeMustBePageMultiple);
}
if (!result)
return makeUnexpected(result.error());
m_growSuccessCallback(GrowSuccessTag, oldPageCount, newPageCount);
return oldPageCount;
}
Expected<PageCount, GrowFailReason> Memory::grow(VM& vm, PageCount delta)
{
if (!delta.isValid())
return makeUnexpected(GrowFailReason::InvalidDelta);
if (sharingMode() == MemorySharingMode::Shared)
return growShared(vm, delta);
ASSERT(!m_shared);
const PageCount oldPageCount = PageCount::fromBytes(size());
const PageCount newPageCount = oldPageCount + delta;
if (!newPageCount || !newPageCount.isValid())
return makeUnexpected(GrowFailReason::InvalidGrowSize);
if (newPageCount.bytes() > MAX_ARRAY_BUFFER_SIZE)
return makeUnexpected(GrowFailReason::OutOfMemory);
auto success = [&] () {
// Update cache for instance
{
Locker locker { m_handle->lock() };
for (Ref anchor : m_handle->anchors(locker)) {
Locker locker { anchor->m_lock };
if (JSWebAssemblyInstance* instance = anchor->instance())
instance->updateCachedMemories();
}
}
m_growSuccessCallback(GrowSuccessTag, oldPageCount, newPageCount);
return oldPageCount;
};
if (delta.pageCount() == 0)
return success();
dataLogLnIf(verbose, "Memory::grow(", delta, ") to ", newPageCount, " from ", *this);
RELEASE_ASSERT(newPageCount > PageCount::fromBytes(size()));
if (maximum() && newPageCount > maximum())
return makeUnexpected(GrowFailReason::WouldExceedMaximum);
size_t desiredSize = newPageCount.bytes();
RELEASE_ASSERT(desiredSize <= MAX_ARRAY_BUFFER_SIZE);
RELEASE_ASSERT(desiredSize > size());
switch (mode()) {
case MemoryMode::BoundsChecking: {
bool allocationSuccess = tryAllocate(vm,
[&] () -> BufferMemoryResult::Kind {
return BufferMemoryManager::singleton().tryAllocatePhysicalBytes(desiredSize);
});
if (!allocationSuccess)
return makeUnexpected(GrowFailReason::OutOfMemory);
RELEASE_ASSERT(maximum().bytes() != 0);
void* newMemory = Gigacage::tryAllocateZeroedVirtualPages(Gigacage::Primitive, desiredSize);
if (!newMemory)
return makeUnexpected(GrowFailReason::OutOfMemory);
memcpy(newMemory, basePointer(), size());
auto newHandle = adoptRef(*new BufferMemoryHandle(newMemory, desiredSize, desiredSize, initial(), maximum(), sharingMode(), MemoryMode::BoundsChecking));
m_handle->transferAnchors(newHandle.get());
m_handle = WTF::move(newHandle);
ASSERT(basePointer() == newMemory);
return success();
}
case MemoryMode::Signaling: {
size_t extraBytes = desiredSize - size();
RELEASE_ASSERT(extraBytes);
bool allocationSuccess = tryAllocate(vm,
[&] () -> BufferMemoryResult::Kind {
return BufferMemoryManager::singleton().tryAllocatePhysicalBytes(extraBytes);
});
if (!allocationSuccess)
return makeUnexpected(GrowFailReason::OutOfMemory);
void* memory = this->basePointer();
RELEASE_ASSERT(memory);
// Signaling memory must have been pre-allocated virtually.
uint8_t* startAddress = static_cast<uint8_t*>(memory) + size();
dataLogLnIf(verbose, "Marking WebAssembly memory's ", RawPointer(memory), " as read+write in range [", RawPointer(startAddress), ", ", RawPointer(startAddress + extraBytes), ")");
constexpr bool readable = true;
constexpr bool writable = true;
OSAllocator::protect(startAddress, extraBytes, readable, writable);
m_handle->updateSize(desiredSize);
return success();
}
}
RELEASE_ASSERT_NOT_REACHED();
return oldPageCount;
}
bool Memory::fill(uint32_t offset, uint8_t targetValue, uint32_t count)
{
if (sumOverflows<uint32_t>(offset, count))
return false;
if (offset + count > m_handle->size())
return false;
memset(static_cast<uint8_t*>(basePointer()) + offset, targetValue, count);
return true;
}
bool Memory::copy(uint32_t dstAddress, uint32_t srcAddress, uint32_t count)
{
if (sumOverflows<uint32_t>(dstAddress, count) || sumOverflows<uint32_t>(srcAddress, count))
return false;
const uint32_t lastDstAddress = dstAddress + count;
const uint32_t lastSrcAddress = srcAddress + count;
if (lastDstAddress > size() || lastSrcAddress > size())
return false;
if (!count)
return true;
uint8_t* base = static_cast<uint8_t*>(basePointer());
// Source and destination areas might overlap, so using memmove.
memmove(base + dstAddress, base + srcAddress, count);
return true;
}
bool Memory::init(uint64_t offset, const uint8_t* data, uint32_t length)
{
if (sumOverflows<uint32_t>(offset, length))
return false;
if (offset + length > m_handle->size())
return false;
if (!length)
return true;
memcpy(static_cast<uint8_t*>(basePointer()) + offset, data, length);
return true;
}
void Memory::registerInstance(JSWebAssemblyInstance& instance)
{
m_handle->registerInstance(instance);
}
void Memory::dump(PrintStream& out) const
{
auto handle = m_handle.copyRef();
out.print("Memory at ", RawPointer(handle->memory()), ", size ", handle->size(), "B capacity ", handle->mappedCapacity(), "B, initial ", handle->initial(), " maximum ", handle->maximum(), " mode ", handle->mode(), " sharingMode ", handle->sharingMode());
}
} // namespace Wasm
} // namespace JSC
WTF_ALLOW_UNSAFE_BUFFER_USAGE_END
#endif // ENABLE(WEBASSEMBLY)
You can’t perform that action at this time.