WebAssembly JS API: implement importing and defining Memory
[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 #include "WasmPageCount.h"
32
33 #include <wtf/Vector.h>
34
35 namespace JSC { namespace Wasm {
36
37 class Memory {
38     WTF_MAKE_NONCOPYABLE(Memory);
39     WTF_MAKE_FAST_ALLOCATED;
40 public:
41
42     // FIXME: We should support other modes. see: https://bugs.webkit.org/show_bug.cgi?id=162693
43     enum class Mode {
44         BoundsChecking
45     };
46
47     JS_EXPORT_PRIVATE Memory(PageCount initial, PageCount maximum);
48
49     ~Memory()
50     {
51         if (m_memory)
52             munmap(m_memory, m_mappedCapacity);
53     }
54
55     void* memory() const { return m_memory; }
56     uint32_t size() const { return m_size; }
57
58     Mode mode() const { return m_mode; }
59
60     PageCount initial() const { return m_initial; }
61     PageCount maximum() const { return m_maximum; }
62
63     bool grow(uint32_t newSize)
64     {
65         ASSERT(m_memory);
66         if (newSize > m_capacity)
67             return false;
68
69         return !mprotect(m_memory, newSize, PROT_READ | PROT_WRITE);
70     }
71
72     static ptrdiff_t offsetOfSize() { return OBJECT_OFFSETOF(Memory, m_size); }
73
74     
75 private:
76     void* m_memory { nullptr };
77     Mode m_mode;
78     uint32_t m_size { 0 };
79     uint32_t m_capacity { 0 };
80     PageCount m_initial;
81     PageCount m_maximum;
82     uint64_t m_mappedCapacity { 0 };
83 };
84
85 } } // namespace JSC::Wasm
86
87 #endif // ENABLE(WEBASSEMLY)