Implement linear memory instructions in WebAssembly
[WebKit-https.git] / Source / JavaScriptCore / wasm / WASMFunctionParser.h
1 /*
2  * Copyright (C) 2015 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 #ifndef WASMFunctionParser_h
27 #define WASMFunctionParser_h
28
29 #if ENABLE(WEBASSEMBLY)
30
31 #include "SourceCode.h"
32 #include "WASMReader.h"
33
34 #define ContextExpression typename Context::Expression
35 #define ContextStatement typename Context::Statement
36 #define ContextExpressionList typename Context::ExpressionList
37 #define ContextMemoryAddress typename Context::MemoryAddress
38 #define ContextJumpTarget typename Context::JumpTarget
39
40 namespace JSC {
41
42 class CodeBlock;
43 class JSWASMModule;
44 class VM;
45
46 class WASMFunctionParser {
47 public:
48     static bool checkSyntax(JSWASMModule*, const SourceCode&, size_t functionIndex, unsigned startOffsetInSource, unsigned& endOffsetInSource, unsigned& stackHeight, String& errorMessage);
49     static void compile(VM&, CodeBlock*, JSWASMModule*, const SourceCode&, size_t functionIndex);
50
51 private:
52     WASMFunctionParser(JSWASMModule* module, const SourceCode& source, size_t functionIndex)
53         : m_module(module)
54         , m_reader(static_cast<WebAssemblySourceProvider*>(source.provider())->data())
55         , m_functionIndex(functionIndex)
56         , m_breakScopeDepth(0)
57         , m_continueScopeDepth(0)
58         , m_labelDepth(0)
59     {
60     }
61
62     template <class Context> bool parseFunction(Context&);
63     bool parseLocalVariables();
64
65     template <class Context> ContextStatement parseStatement(Context&);
66     template <class Context> ContextStatement parseSetLocalStatement(Context&, uint32_t localIndex);
67     template <class Context> ContextStatement parseSetLocalStatement(Context&);
68     template <class Context> ContextStatement parseSetGlobalStatement(Context&, uint32_t globalIndex);
69     template <class Context> ContextStatement parseSetGlobalStatement(Context&);
70     template <class Context> ContextStatement parseReturnStatement(Context&);
71     template <class Context> ContextStatement parseBlockStatement(Context&);
72     template <class Context> ContextStatement parseIfStatement(Context&);
73     template <class Context> ContextStatement parseIfElseStatement(Context&);
74     template <class Context> ContextStatement parseWhileStatement(Context&);
75     template <class Context> ContextStatement parseDoStatement(Context&);
76     template <class Context> ContextStatement parseLabelStatement(Context&);
77     template <class Context> ContextStatement parseBreakStatement(Context&);
78     template <class Context> ContextStatement parseBreakLabelStatement(Context&);
79     template <class Context> ContextStatement parseContinueStatement(Context&);
80     template <class Context> ContextStatement parseContinueLabelStatement(Context&);
81     template <class Context> ContextStatement parseSwitchStatement(Context&);
82
83     template <class Context> ContextExpression parseExpression(Context&, WASMExpressionType);
84
85     template <class Context> ContextExpression parseExpressionI32(Context&);
86     template <class Context> ContextExpression parseConstantPoolIndexExpressionI32(Context&, uint32_t constantPoolIndex);
87     template <class Context> ContextExpression parseConstantPoolIndexExpressionI32(Context&);
88     template <class Context> ContextExpression parseImmediateExpressionI32(Context&, uint32_t immediate);
89     template <class Context> ContextExpression parseImmediateExpressionI32(Context&);
90     template <class Context> ContextExpression parseGetLocalExpressionI32(Context&, uint32_t localIndex);
91     template <class Context> ContextExpression parseGetLocalExpressionI32(Context&);
92     template <class Context> ContextExpression parseGetGlobalExpressionI32(Context&);
93     template <class Context> ContextExpression parseUnaryExpressionI32(Context&, WASMOpExpressionI32);
94     template <class Context> ContextExpression parseBinaryExpressionI32(Context&, WASMOpExpressionI32);
95     template <class Context> ContextExpression parseRelationalI32ExpressionI32(Context&, WASMOpExpressionI32);
96     template <class Context> ContextExpression parseRelationalF32ExpressionI32(Context&, WASMOpExpressionI32);
97     template <class Context> ContextExpression parseRelationalF64ExpressionI32(Context&, WASMOpExpressionI32);
98
99     template <class Context> ContextExpression parseExpressionF32(Context&);
100     template <class Context> ContextExpression parseConstantPoolIndexExpressionF32(Context&, uint32_t constantIndex);
101     template <class Context> ContextExpression parseConstantPoolIndexExpressionF32(Context&);
102     template <class Context> ContextExpression parseImmediateExpressionF32(Context&);
103     template <class Context> ContextExpression parseGetLocalExpressionF32(Context&, uint32_t localIndex);
104     template <class Context> ContextExpression parseGetLocalExpressionF32(Context&);
105     template <class Context> ContextExpression parseGetGlobalExpressionF32(Context&);
106     template <class Context> ContextExpression parseUnaryExpressionF32(Context&, WASMOpExpressionF32);
107     template <class Context> ContextExpression parseBinaryExpressionF32(Context&, WASMOpExpressionF32);
108
109     template <class Context> ContextExpression parseExpressionF64(Context&);
110     template <class Context> ContextExpression parseConstantPoolIndexExpressionF64(Context&, uint32_t constantIndex);
111     template <class Context> ContextExpression parseConstantPoolIndexExpressionF64(Context&);
112     template <class Context> ContextExpression parseImmediateExpressionF64(Context&);
113     template <class Context> ContextExpression parseGetLocalExpressionF64(Context&, uint32_t localIndex);
114     template <class Context> ContextExpression parseGetLocalExpressionF64(Context&);
115     template <class Context> ContextExpression parseGetGlobalExpressionF64(Context&);
116
117     template <class Context> ContextMemoryAddress parseMemoryAddress(Context&, MemoryAccessOffsetMode);
118     template <class Context> ContextExpression parseLoad(Context&, WASMExpressionType, WASMMemoryType, MemoryAccessOffsetMode, MemoryAccessConversion = MemoryAccessConversion::NoConversion);
119     template <class Context> ContextExpression parseStore(Context&, WASMExpressionType, WASMMemoryType, MemoryAccessOffsetMode);
120
121     template <class Context> ContextExpressionList parseCallArguments(Context&, const Vector<WASMType>& arguments);
122     template <class Context> ContextExpression parseCallInternal(Context&, WASMExpressionType returnType);
123     template <class Context> ContextExpression parseCallIndirect(Context&, WASMExpressionType returnType);
124     template <class Context> ContextExpression parseCallImport(Context&, WASMExpressionType returnType);
125     template <class Context> ContextExpression parseConvertType(Context&, WASMExpressionType fromType, WASMExpressionType toType, WASMTypeConversion);
126
127     JSWASMModule* m_module;
128     WASMReader m_reader;
129     size_t m_functionIndex;
130     String m_errorMessage;
131
132     WASMExpressionType m_returnType;
133     Vector<WASMType> m_localTypes;
134     uint32_t m_numberOfI32LocalVariables;
135     uint32_t m_numberOfF32LocalVariables;
136     uint32_t m_numberOfF64LocalVariables;
137
138     unsigned m_breakScopeDepth;
139     unsigned m_continueScopeDepth;
140     unsigned m_labelDepth;
141 };
142
143 } // namespace JSC
144
145 #endif // ENABLE(WEBASSEMBLY)
146
147 #endif // WASMFunctionParser_h