7b20a04c06d61aa0f8c727e4cd1bfa43bc94d5df
[WebKit-https.git] / Source / JavaScriptCore / wasm / WasmMemory.h
1 /*
2  * Copyright (C) 2016 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 #if ENABLE(WEBASSEMBLY)
29
30 #include "WasmCallingConvention.h"
31
32 #include <wtf/Vector.h>
33
34 namespace JSC { namespace Wasm {
35
36 struct PinnedSizeRegisterInfo {
37     GPRReg sizeRegister;
38     unsigned sizeOffset;
39 };
40
41 // FIXME: We should support more than one memory size register. Right now we take a vector with only one
42 // entry. Specifically an entry where the sizeOffset == 0. If we have more than one size register,
43 // we can have one for each load size class. see: https://bugs.webkit.org/show_bug.cgi?id=162952
44 struct PinnedRegisterInfo {
45     Vector<PinnedSizeRegisterInfo> sizeRegisters;
46     GPRReg baseMemoryPointer;
47 };
48
49 constexpr uint32_t pageSize = 64 * KB;
50 constexpr uint32_t maxPageCount = static_cast<uint32_t>((1ull << 32) / pageSize);
51
52 class Memory {
53     WTF_MAKE_NONCOPYABLE(Memory);
54     WTF_MAKE_FAST_ALLOCATED;
55 public:
56
57     // FIXME: We should support other modes. see: https://bugs.webkit.org/show_bug.cgi?id=162693
58     enum class Mode {
59         BoundsChecking
60     };
61
62     Memory() = default;
63     Memory(uint32_t startingSize, uint32_t capacity, const Vector<unsigned>& pinnedSizeRegisters);
64
65     ~Memory()
66     {
67         if (m_memory)
68             munmap(m_memory, m_mappedCapacity);
69     }
70
71     void* memory() const { return m_memory; }
72     uint32_t size() const { return m_size; }
73     const PinnedRegisterInfo& pinnedRegisters() const { return m_pinnedRegisters; }
74
75     Mode mode() const { return m_mode; }
76
77     bool grow(uint32_t newSize)
78     {
79         ASSERT(m_memory);
80         if (newSize > m_capacity)
81             return false;
82
83         return !mprotect(m_memory, newSize, PROT_READ | PROT_WRITE);
84     }
85
86     static ptrdiff_t offsetOfSize() { return OBJECT_OFFSETOF(Memory, m_size); }
87     
88 private:
89     void* m_memory { nullptr };
90     PinnedRegisterInfo m_pinnedRegisters;
91     Mode m_mode;
92     uint32_t m_size { 0 };
93     uint32_t m_capacity { 0 };
94     uint64_t m_mappedCapacity { 0 };
95 };
96
97 } } // namespace JSC::Wasm
98
99 #endif // ENABLE(WEBASSEMLY)