c3844eeb2ed64cd7d6c64a886f72e75ef8e9846c
[WebKit-https.git] / Source / JavaScriptCore / interpreter / Interpreter.h
1 /*
2  * Copyright (C) 2008, 2013, 2015-2016 Apple Inc. All rights reserved.
3  * Copyright (C) 2012 Research In Motion Limited. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #pragma once
31
32 #include "ArgList.h"
33 #include "CatchScope.h"
34 #include "FrameTracers.h"
35 #include "JSCJSValue.h"
36 #include "JSCell.h"
37 #include "JSObject.h"
38 #include "Opcode.h"
39 #include "StackAlignment.h"
40 #include <wtf/HashMap.h>
41
42 #if !ENABLE(JIT)
43 #include "CLoopStack.h"
44 #endif
45
46
47 namespace JSC {
48
49     class CodeBlock;
50     class EvalExecutable;
51     class FunctionExecutable;
52     class VM;
53     class JSFunction;
54     class JSGlobalObject;
55     class JSModuleEnvironment;
56     class JSModuleRecord;
57     class LLIntOffsetsExtractor;
58     class ProgramExecutable;
59     class ModuleProgramExecutable;
60     class Register;
61     class JSScope;
62     class StackFrame;
63     struct CallFrameClosure;
64     struct HandlerInfo;
65     struct Instruction;
66     struct ProtoCallFrame;
67     struct UnlinkedInstruction;
68
69     enum UnwindStart : uint8_t { UnwindFromCurrentFrame, UnwindFromCallerFrame };
70
71     enum DebugHookType {
72         WillExecuteProgram,
73         DidExecuteProgram,
74         DidEnterCallFrame,
75         DidReachBreakpoint,
76         WillLeaveCallFrame,
77         WillExecuteStatement,
78         WillExecuteExpression,
79     };
80
81     enum StackFrameCodeType {
82         StackFrameGlobalCode,
83         StackFrameEvalCode,
84         StackFrameModuleCode,
85         StackFrameFunctionCode,
86         StackFrameNativeCode
87     };
88
89     class Interpreter {
90         WTF_MAKE_FAST_ALLOCATED;
91         friend class CachedCall;
92         friend class LLIntOffsetsExtractor;
93         friend class JIT;
94         friend class VM;
95
96     public:
97         Interpreter(VM &);
98         ~Interpreter();
99         
100         void initialize();
101
102 #if !ENABLE(JIT)
103         CLoopStack& cloopStack() { return m_cloopStack; }
104 #endif
105         
106         Opcode getOpcode(OpcodeID id)
107         {
108             ASSERT(m_initialized);
109 #if ENABLE(COMPUTED_GOTO_OPCODES)
110             return m_opcodeTable[id];
111 #else
112             return id;
113 #endif
114         }
115
116         OpcodeID getOpcodeID(Opcode opcode)
117         {
118             ASSERT(m_initialized);
119 #if ENABLE(COMPUTED_GOTO_OPCODES)
120             ASSERT(isOpcode(opcode));
121             return m_opcodeIDTable.get(opcode);
122 #else
123             return opcode;
124 #endif
125         }
126
127         OpcodeID getOpcodeID(const Instruction&);
128         OpcodeID getOpcodeID(const UnlinkedInstruction&);
129
130         bool isOpcode(Opcode);
131
132         JSValue executeProgram(const SourceCode&, CallFrame*, JSObject* thisObj);
133         JSValue executeCall(CallFrame*, JSObject* function, CallType, const CallData&, JSValue thisValue, const ArgList&);
134         JSObject* executeConstruct(CallFrame*, JSObject* function, ConstructType, const ConstructData&, const ArgList&, JSValue newTarget);
135         JSValue execute(EvalExecutable*, CallFrame*, JSValue thisValue, JSScope*);
136         JSValue execute(ModuleProgramExecutable*, CallFrame*, JSModuleEnvironment*);
137
138         void getArgumentsData(CallFrame*, JSFunction*&, ptrdiff_t& firstParameterIndex, Register*& argv, int& argc);
139         
140         NEVER_INLINE HandlerInfo* unwind(VM&, CallFrame*&, Exception*, UnwindStart);
141         void notifyDebuggerOfExceptionToBeThrown(CallFrame*, Exception*);
142         NEVER_INLINE void debug(CallFrame*, DebugHookType);
143         static JSString* stackTraceAsString(VM&, const Vector<StackFrame>&);
144
145         static EncodedJSValue JSC_HOST_CALL constructWithErrorConstructor(ExecState*);
146         static EncodedJSValue JSC_HOST_CALL callErrorConstructor(ExecState*);
147         static EncodedJSValue JSC_HOST_CALL constructWithNativeErrorConstructor(ExecState*);
148         static EncodedJSValue JSC_HOST_CALL callNativeErrorConstructor(ExecState*);
149
150         JS_EXPORT_PRIVATE void dumpCallFrame(CallFrame*);
151
152         void getStackTrace(Vector<StackFrame>& results, size_t framesToSkip = 0, size_t maxStackSize = std::numeric_limits<size_t>::max());
153
154     private:
155         enum ExecutionFlag { Normal, InitializeAndReturn };
156
157         CallFrameClosure prepareForRepeatCall(FunctionExecutable*, CallFrame*, ProtoCallFrame*, JSFunction*, int argumentCountIncludingThis, JSScope*, JSValue*);
158
159         JSValue execute(CallFrameClosure&);
160
161
162
163         void dumpRegisters(CallFrame*);
164         
165         bool isCallBytecode(Opcode opcode) { return opcode == getOpcode(op_call) || opcode == getOpcode(op_construct) || opcode == getOpcode(op_call_eval) || opcode == getOpcode(op_tail_call); }
166
167         VM& m_vm;
168 #if !ENABLE(JIT)
169         CLoopStack m_cloopStack;
170 #endif
171         
172 #if ENABLE(COMPUTED_GOTO_OPCODES)
173         Opcode* m_opcodeTable; // Maps OpcodeID => Opcode for compiling
174         HashMap<Opcode, OpcodeID> m_opcodeIDTable; // Maps Opcode => OpcodeID for decompiling
175 #endif
176
177 #if !ASSERT_DISABLED
178         bool m_initialized;
179 #endif
180     };
181
182     JSValue eval(CallFrame*);
183
184     inline CallFrame* calleeFrameForVarargs(CallFrame* callFrame, unsigned numUsedStackSlots, unsigned argumentCountIncludingThis)
185     {
186         // We want the new frame to be allocated on a stack aligned offset with a stack
187         // aligned size. Align the size here.
188         argumentCountIncludingThis = WTF::roundUpToMultipleOf(
189             stackAlignmentRegisters(),
190             argumentCountIncludingThis + CallFrame::headerSizeInRegisters) - CallFrame::headerSizeInRegisters;
191
192         // Align the frame offset here.
193         unsigned paddedCalleeFrameOffset = WTF::roundUpToMultipleOf(
194             stackAlignmentRegisters(),
195             numUsedStackSlots + argumentCountIncludingThis + CallFrame::headerSizeInRegisters);
196         return CallFrame::create(callFrame->registers() - paddedCalleeFrameOffset);
197     }
198
199     unsigned sizeOfVarargs(CallFrame* exec, JSValue arguments, uint32_t firstVarArgOffset);
200     static const unsigned maxArguments = 0x10000;
201     unsigned sizeFrameForVarargs(CallFrame* exec, VM&, JSValue arguments, unsigned numUsedStackSlots, uint32_t firstVarArgOffset);
202     unsigned sizeFrameForForwardArguments(CallFrame* exec, VM&, unsigned numUsedStackSlots);
203     void loadVarargs(CallFrame* execCaller, VirtualRegister firstElementDest, JSValue source, uint32_t offset, uint32_t length);
204     void setupVarargsFrame(CallFrame* execCaller, CallFrame* execCallee, JSValue arguments, uint32_t firstVarArgOffset, uint32_t length);
205     void setupVarargsFrameAndSetThis(CallFrame* execCaller, CallFrame* execCallee, JSValue thisValue, JSValue arguments, uint32_t firstVarArgOffset, uint32_t length);
206     void setupForwardArgumentsFrame(CallFrame* execCaller, CallFrame* execCallee, uint32_t length);
207     void setupForwardArgumentsFrameAndSetThis(CallFrame* execCaller, CallFrame* execCallee, JSValue thisValue, uint32_t length);
208     
209 } // namespace JSC