f29c020de0f95250e305c775d0a37e35ba018c1c
[WebKit-https.git] / Source / JavaScriptCore / interpreter / Interpreter.h
1 /*
2  * Copyright (C) 2008-2017 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 #if !ENABLE(JIT)
101         CLoopStack& cloopStack() { return m_cloopStack; }
102 #endif
103         
104         static inline Opcode getOpcode(OpcodeID);
105
106         static inline OpcodeID getOpcodeID(Opcode);
107         static inline OpcodeID getOpcodeID(const Instruction&);
108         static inline OpcodeID getOpcodeID(const UnlinkedInstruction&);
109
110 #if !ASSERT_DISABLED
111         static bool isOpcode(Opcode);
112 #endif
113
114         JSValue executeProgram(const SourceCode&, CallFrame*, JSObject* thisObj);
115         JSValue executeModuleProgram(ModuleProgramExecutable*, CallFrame*, JSModuleEnvironment*);
116         JSValue executeCall(CallFrame*, JSObject* function, CallType, const CallData&, JSValue thisValue, const ArgList&);
117         JSObject* executeConstruct(CallFrame*, JSObject* function, ConstructType, const ConstructData&, const ArgList&, JSValue newTarget);
118         JSValue execute(EvalExecutable*, CallFrame*, JSValue thisValue, JSScope*);
119
120         void getArgumentsData(CallFrame*, JSFunction*&, ptrdiff_t& firstParameterIndex, Register*& argv, int& argc);
121         
122         NEVER_INLINE HandlerInfo* unwind(VM&, CallFrame*&, Exception*, UnwindStart);
123         void notifyDebuggerOfExceptionToBeThrown(VM&, CallFrame*, Exception*);
124         NEVER_INLINE void debug(CallFrame*, DebugHookType);
125         static JSString* stackTraceAsString(VM&, const Vector<StackFrame>&);
126
127         static EncodedJSValue JSC_HOST_CALL constructWithErrorConstructor(ExecState*);
128         static EncodedJSValue JSC_HOST_CALL callErrorConstructor(ExecState*);
129         static EncodedJSValue JSC_HOST_CALL constructWithNativeErrorConstructor(ExecState*);
130         static EncodedJSValue JSC_HOST_CALL callNativeErrorConstructor(ExecState*);
131
132         JS_EXPORT_PRIVATE void dumpCallFrame(CallFrame*);
133
134         void getStackTrace(Vector<StackFrame>& results, size_t framesToSkip = 0, size_t maxStackSize = std::numeric_limits<size_t>::max());
135
136     private:
137         enum ExecutionFlag { Normal, InitializeAndReturn };
138
139         CallFrameClosure prepareForRepeatCall(FunctionExecutable*, CallFrame*, ProtoCallFrame*, JSFunction*, int argumentCountIncludingThis, JSScope*, const ArgList&);
140
141         JSValue execute(CallFrameClosure&);
142
143
144
145         void dumpRegisters(CallFrame*);
146         
147         VM& m_vm;
148 #if !ENABLE(JIT)
149         CLoopStack m_cloopStack;
150 #endif
151         
152 #if ENABLE(COMPUTED_GOTO_OPCODES)
153 #if !USE(LLINT_EMBEDDED_OPCODE_ID) || !ASSERT_DISABLED
154         static HashMap<Opcode, OpcodeID>& opcodeIDTable(); // Maps Opcode => OpcodeID.
155 #endif // !USE(LLINT_EMBEDDED_OPCODE_ID) || !ASSERT_DISABLED
156 #endif // ENABLE(COMPUTED_GOTO_OPCODES)
157     };
158
159     JSValue eval(CallFrame*);
160
161     inline CallFrame* calleeFrameForVarargs(CallFrame* callFrame, unsigned numUsedStackSlots, unsigned argumentCountIncludingThis)
162     {
163         // We want the new frame to be allocated on a stack aligned offset with a stack
164         // aligned size. Align the size here.
165         argumentCountIncludingThis = WTF::roundUpToMultipleOf(
166             stackAlignmentRegisters(),
167             argumentCountIncludingThis + CallFrame::headerSizeInRegisters) - CallFrame::headerSizeInRegisters;
168
169         // Align the frame offset here.
170         unsigned paddedCalleeFrameOffset = WTF::roundUpToMultipleOf(
171             stackAlignmentRegisters(),
172             numUsedStackSlots + argumentCountIncludingThis + CallFrame::headerSizeInRegisters);
173         return CallFrame::create(callFrame->registers() - paddedCalleeFrameOffset);
174     }
175
176     unsigned sizeOfVarargs(CallFrame* exec, JSValue arguments, uint32_t firstVarArgOffset);
177     static const unsigned maxArguments = 0x10000;
178     unsigned sizeFrameForVarargs(CallFrame* exec, VM&, JSValue arguments, unsigned numUsedStackSlots, uint32_t firstVarArgOffset);
179     unsigned sizeFrameForForwardArguments(CallFrame* exec, VM&, unsigned numUsedStackSlots);
180     void loadVarargs(CallFrame* execCaller, VirtualRegister firstElementDest, JSValue source, uint32_t offset, uint32_t length);
181     void setupVarargsFrame(CallFrame* execCaller, CallFrame* execCallee, JSValue arguments, uint32_t firstVarArgOffset, uint32_t length);
182     void setupVarargsFrameAndSetThis(CallFrame* execCaller, CallFrame* execCallee, JSValue thisValue, JSValue arguments, uint32_t firstVarArgOffset, uint32_t length);
183     void setupForwardArgumentsFrame(CallFrame* execCaller, CallFrame* execCallee, uint32_t length);
184     void setupForwardArgumentsFrameAndSetThis(CallFrame* execCaller, CallFrame* execCallee, JSValue thisValue, uint32_t length);
185     
186 } // namespace JSC