[WebAssembly] Parse wasm modules in a streaming fashion
[WebKit-https.git] / Source / JavaScriptCore / wasm / WasmModuleInformation.h
1 /*
2  * Copyright (C) 2017 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
32 #include <wtf/Optional.h>
33
34 namespace JSC { namespace Wasm {
35
36 struct ModuleInformation : public ThreadSafeRefCounted<ModuleInformation> {
37     ModuleInformation();
38     ModuleInformation(const ModuleInformation&) = delete;
39     ModuleInformation(ModuleInformation&&) = delete;
40
41     static Ref<ModuleInformation> create()
42     {
43         return adoptRef(*new ModuleInformation);
44     }
45
46     JS_EXPORT_PRIVATE ~ModuleInformation();
47     
48     size_t functionIndexSpaceSize() const { return importFunctionSignatureIndices.size() + internalFunctionSignatureIndices.size(); }
49     bool isImportedFunctionFromFunctionIndexSpace(size_t functionIndex) const
50     {
51         ASSERT(functionIndex < functionIndexSpaceSize());
52         return functionIndex < importFunctionSignatureIndices.size();
53     }
54     SignatureIndex signatureIndexFromFunctionIndexSpace(size_t functionIndex) const
55     {
56         return isImportedFunctionFromFunctionIndexSpace(functionIndex)
57             ? importFunctionSignatureIndices[functionIndex]
58             : internalFunctionSignatureIndices[functionIndex - importFunctionSignatureIndices.size()];
59     }
60
61     uint32_t importFunctionCount() const { return importFunctionSignatureIndices.size(); }
62     uint32_t internalFunctionCount() const { return internalFunctionSignatureIndices.size(); }
63
64     // Currently, our wasm implementation allows only one memory and table.
65     // If we need to remove this limitation, we would have MemoryInformation and TableInformation in the Vectors.
66     uint32_t memoryCount() const { return memory ? 1 : 0; }
67     uint32_t tableCount() const { return tableInformation ? 1 : 0; }
68
69     Vector<Import> imports;
70     Vector<SignatureIndex> importFunctionSignatureIndices;
71     Vector<SignatureIndex> internalFunctionSignatureIndices;
72     Vector<Ref<Signature>> usedSignatures;
73
74     MemoryInformation memory;
75
76     Vector<FunctionData> functions;
77
78     Vector<Export> exports;
79     std::optional<uint32_t> startFunctionIndexSpace;
80     Vector<Segment::Ptr> data;
81     Vector<Element> elements;
82     TableInformation tableInformation;
83     Vector<Global> globals;
84     unsigned firstInternalGlobal { 0 };
85     Vector<CustomSection> customSections;
86     Ref<NameSection> nameSection;
87 };
88
89     
90 } } // namespace JSC::Wasm
91
92 #endif // ENABLE(WEBASSEMBLY)