summaryrefslogtreecommitdiff
path: root/Source/JavaScriptCore/wasm/WasmMemory.cpp
blob: aad91c13e3a3016838fb0384dab5a42b47743d28 (plain)
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
/*
 * Copyright (C) 2016 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 <wtf/HexNumber.h>
#include <wtf/PrintStream.h>
#include <wtf/text/WTFString.h>

namespace JSC { namespace Wasm {

namespace {
const bool verbose = false;
}

void Memory::dump(PrintStream& out) const
{
    String memoryHex;
    WTF::appendUnsigned64AsHex((uint64_t)(uintptr_t)m_memory, memoryHex);
    out.print("Memory at 0x", memoryHex, ", size ", m_size, "B capacity ", m_mappedCapacity, "B, initial ", m_initial, " maximum ", m_maximum, " mode ", makeString(m_mode));
}

const char* Memory::makeString(Mode mode) const
{
    switch (mode) {
    case Mode::BoundsChecking: return "BoundsChecking";
    }
    RELEASE_ASSERT_NOT_REACHED();
    return "";
}

static_assert(sizeof(uint64_t) == sizeof(size_t), "We rely on allowing the maximum size of Memory we map to be 2^32 which is larger than fits in a 32-bit integer that we'd pass to mprotect if this didn't hold.");

Memory::Memory(PageCount initial, PageCount maximum, bool& failed)
    : m_size(initial.bytes())
    , m_initial(initial)
    , m_maximum(maximum)
    , m_mode(Mode::BoundsChecking)
    // FIXME: If we add signal based bounds checking then we need extra space for overflow on load.
    // see: https://bugs.webkit.org/show_bug.cgi?id=162693
{
    RELEASE_ASSERT(!maximum || maximum >= initial); // This should be guaranteed by our caller.

    m_mappedCapacity = maximum ? maximum.bytes() : PageCount::max().bytes();
    if (!m_mappedCapacity) {
        // This means we specified a zero as maximum (which means we also have zero as initial size).
        RELEASE_ASSERT(m_size == 0);
        m_memory = nullptr;
        m_mappedCapacity = 0;
        failed = false;
        if (verbose)
            dataLogLn("Memory::Memory allocating nothing ", *this);
        return;
    }

    // FIXME: It would be nice if we had a VM tag for wasm memory. https://bugs.webkit.org/show_bug.cgi?id=163600
    void* result = Options::simulateWebAssemblyLowMemory() ? MAP_FAILED : mmap(nullptr, m_mappedCapacity, PROT_NONE, MAP_PRIVATE | MAP_ANON, -1, 0);
    if (result == MAP_FAILED) {
        // Try again with a different number.
        if (verbose)
            dataLogLn("Memory::Memory mmap failed once for capacity, trying again", *this);
        m_mappedCapacity = m_size;
        if (!m_mappedCapacity) {
            m_memory = nullptr;
            failed = false;
            if (verbose)
                dataLogLn("Memory::Memory mmap not trying again because size is zero ", *this);
            return;
        }

        result = mmap(nullptr, m_mappedCapacity, PROT_NONE, MAP_PRIVATE | MAP_ANON, -1, 0);
        if (result == MAP_FAILED) {
            if (verbose)
                dataLogLn("Memory::Memory mmap failed twice ", *this);
            failed = true;
            return;
        }
    }

    ASSERT(m_size <= m_mappedCapacity);
    {
        bool success = !mprotect(result, static_cast<size_t>(m_size), PROT_READ | PROT_WRITE);
        RELEASE_ASSERT(success);
    }

    m_memory = result;
    failed = false;
    if (verbose)
        dataLogLn("Memory::Memory mmap succeeded ", *this);
}

Memory::~Memory()
{
    if (verbose)
        dataLogLn("Memory::~Memory ", *this);
    if (m_memory) {
        if (munmap(m_memory, m_mappedCapacity))
            CRASH();
    }
}

bool Memory::grow(PageCount newSize)
{
    RELEASE_ASSERT(newSize > PageCount::fromBytes(m_size));

    if (verbose)
        dataLogLn("Memory::grow to ", newSize, " from ", *this);

    if (maximum() && newSize > maximum())
        return false;

    uint64_t desiredSize = newSize.bytes();

    if (m_memory && desiredSize <= m_mappedCapacity) {
        bool success = !mprotect(static_cast<uint8_t*>(m_memory) + m_size, static_cast<size_t>(desiredSize - m_size), PROT_READ | PROT_WRITE);
        RELEASE_ASSERT(success);
        m_size = desiredSize;
        if (verbose)
            dataLogLn("Memory::grow in-place ", *this);
        return true;
    }

    // Otherwise, let's try to make some new memory.
    void* newMemory = mmap(nullptr, desiredSize, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANON, -1, 0);
    if (newMemory == MAP_FAILED)
        return false;

    if (m_memory) {
        memcpy(newMemory, m_memory, m_size);
        bool success = !munmap(m_memory, m_mappedCapacity);
        RELEASE_ASSERT(success);
    }
    m_memory = newMemory;
    m_mappedCapacity = desiredSize;
    m_size = desiredSize;

    if (verbose)
        dataLogLn("Memory::grow ", *this);
    return true;
}

} // namespace JSC

} // namespace Wasm

#endif // ENABLE(WEBASSEMBLY)