1/*
2 * Copyright (C) 2017-2018 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 "WasmFormat.h"
31#include "WasmLimits.h"
32#include "WriteBarrier.h"
33#include <wtf/MallocPtr.h>
34#include <wtf/Optional.h>
35#include <wtf/Ref.h>
36#include <wtf/ThreadSafeRefCounted.h>
37
38namespace JSC { namespace Wasm {
39
40class Instance;
41class FuncRefTable;
42
43class Table : public ThreadSafeRefCounted<Table> {
44 WTF_MAKE_NONCOPYABLE(Table);
45 WTF_MAKE_FAST_ALLOCATED(Table);
46public:
47 static RefPtr<Table> tryCreate(uint32_t initial, Optional<uint32_t> maximum, TableElementType);
48
49 JS_EXPORT_PRIVATE ~Table() = default;
50
51 Optional<uint32_t> maximum() const { return m_maximum; }
52 uint32_t length() const { return m_length; }
53
54 static ptrdiff_t offsetOfLength() { return OBJECT_OFFSETOF(Table, m_length); }
55 static ptrdiff_t offsetOfMask() { return OBJECT_OFFSETOF(Table, m_mask); }
56
57 static uint32_t allocatedLength(uint32_t length);
58 uint32_t mask() const { return m_mask; }
59
60 template<typename T> T* owner() const { return reinterpret_cast<T*>(m_owner); }
61 void setOwner(JSObject* owner)
62 {
63 ASSERT(!m_owner);
64 ASSERT(owner);
65 m_owner = owner;
66 }
67
68 TableElementType type() const { return m_type; }
69 bool isAnyrefTable() const { return m_type == TableElementType::Anyref; }
70 FuncRefTable* asFuncrefTable();
71
72 static bool isValidLength(uint32_t length) { return length < maxTableEntries; }
73
74 void clear(uint32_t);
75 void set(uint32_t, JSValue);
76 JSValue get(uint32_t) const;
77
78 Optional<uint32_t> grow(uint32_t delta);
79
80 void visitAggregate(SlotVisitor&);
81
82protected:
83 Table(uint32_t initial, Optional<uint32_t> maximum, TableElementType = TableElementType::Anyref);
84
85 void setLength(uint32_t);
86
87 uint32_t m_length;
88 uint32_t m_mask;
89 const TableElementType m_type;
90 const Optional<uint32_t> m_maximum;
91
92 MallocPtr<WriteBarrier<Unknown>> m_jsValues;
93 JSObject* m_owner;
94};
95
96class FuncRefTable : public Table {
97public:
98 JS_EXPORT_PRIVATE ~FuncRefTable() = default;
99
100 void setFunction(uint32_t, JSObject*, WasmToWasmImportableFunction, Instance*);
101 const WasmToWasmImportableFunction& function(uint32_t) const;
102 Instance* instance(uint32_t) const;
103
104 static ptrdiff_t offsetOfFunctions() { return OBJECT_OFFSETOF(FuncRefTable, m_importableFunctions); }
105 static ptrdiff_t offsetOfInstances() { return OBJECT_OFFSETOF(FuncRefTable, m_instances); }
106
107private:
108 FuncRefTable(uint32_t initial, Optional<uint32_t> maximum);
109
110 MallocPtr<WasmToWasmImportableFunction> m_importableFunctions;
111 // call_indirect needs to do an Instance check to potentially context switch when calling a function to another instance. We can hold raw pointers to Instance here because the embedder ensures that Table keeps all the instances alive. We couldn't hold a Ref here because it would cause cycles.
112 MallocPtr<Instance*> m_instances;
113
114 friend class Table;
115};
116
117} } // namespace JSC::Wasm
118
119#endif // ENABLE(WEBASSEMBLY)
120