c8c96126d76c603155508a9e03a3cc9bf9ce2397
[WebKit-https.git] / JavaScriptCore / interpreter / Interpreter.h
1 /*
2  * Copyright (C) 2008 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef Interpreter_h
30 #define Interpreter_h
31
32 #include "ArgList.h"
33 #include "JSCell.h"
34 #include "JSValue.h"
35 #include "Opcode.h"
36 #include "RegisterFile.h"
37 #include <wtf/HashMap.h>
38
39 namespace JSC {
40
41     class CodeBlock;
42     class EvalNode;
43     class FunctionBodyNode;
44     class Instruction;
45     class InternalFunction;
46     class AssemblerBuffer;
47     class JSFunction;
48     class JSGlobalObject;
49     class ProgramNode;
50     class Register;
51     class ScopeChainNode;
52     class SamplingTool;
53     struct HandlerInfo;
54
55 #if ENABLE(JIT)
56
57 #if USE(CTI_ARGUMENT)
58 #define CTI_ARGS void** args
59 #define ARGS (args)
60 #else
61 #define CTI_ARGS void* args, ...
62 #define ARGS (reinterpret_cast<void**>(vl_args) - 1)
63 #endif
64
65 #if USE(FAST_CALL_CTI_ARGUMENT)
66
67 #if COMPILER(MSVC)
68 #define SFX_CALL __fastcall
69 #elif COMPILER(GCC)
70 #define SFX_CALL  __attribute__ ((fastcall))
71 #else
72 #error Need to support fastcall calling convention in this compiler
73 #endif
74
75 #else
76
77 #if COMPILER(MSVC)
78 #define SFX_CALL __cdecl
79 #else
80 #define SFX_CALL
81 #endif
82
83 #endif
84
85     typedef uint64_t VoidPtrPair;
86
87     typedef union
88     {
89         struct { void* first; void* second; } s;
90         VoidPtrPair i;
91     } VoidPtrPairValue;
92 #endif
93
94     enum DebugHookID {
95         WillExecuteProgram,
96         DidExecuteProgram,
97         DidEnterCallFrame,
98         DidReachBreakpoint,
99         WillLeaveCallFrame,
100         WillExecuteStatement
101     };
102
103     enum { MaxReentryDepth = 128 };
104
105     class Interpreter {
106         friend class JIT;
107     public:
108         Interpreter();
109         ~Interpreter();
110
111         void initialize(JSGlobalData*);
112         
113         RegisterFile& registerFile() { return m_registerFile; }
114         
115         Opcode getOpcode(OpcodeID id)
116         {
117             #if HAVE(COMPUTED_GOTO)
118                 return m_opcodeTable[id];
119             #else
120                 return id;
121             #endif
122         }
123
124         OpcodeID getOpcodeID(Opcode opcode)
125         {
126             #if HAVE(COMPUTED_GOTO)
127                 ASSERT(isOpcode(opcode));
128                 return m_opcodeIDTable.get(opcode);
129             #else
130                 return opcode;
131             #endif
132         }
133
134         bool isOpcode(Opcode);
135         
136         JSValue* execute(ProgramNode*, CallFrame*, ScopeChainNode*, JSObject* thisObj, JSValue** exception);
137         JSValue* execute(FunctionBodyNode*, CallFrame*, JSFunction*, JSObject* thisObj, const ArgList& args, ScopeChainNode*, JSValue** exception);
138         JSValue* execute(EvalNode* evalNode, CallFrame* exec, JSObject* thisObj, ScopeChainNode* scopeChain, JSValue** exception);
139
140         JSValue* retrieveArguments(CallFrame*, JSFunction*) const;
141         JSValue* retrieveCaller(CallFrame*, InternalFunction*) const;
142         void retrieveLastCaller(CallFrame*, int& lineNumber, intptr_t& sourceID, UString& sourceURL, JSValue*& function) const;
143         
144         void getArgumentsData(CallFrame*, JSFunction*&, ptrdiff_t& firstParameterIndex, Register*& argv, int& argc);
145         void setTimeoutTime(unsigned timeoutTime) { m_timeoutTime = timeoutTime; }
146         
147         void startTimeoutCheck()
148         {
149             if (!m_timeoutCheckCount)
150                 resetTimeoutCheck();
151             
152             ++m_timeoutCheckCount;
153         }
154         
155         void stopTimeoutCheck()
156         {
157             ASSERT(m_timeoutCheckCount);
158             --m_timeoutCheckCount;
159         }
160
161         inline void initTimeout()
162         {
163             ASSERT(!m_timeoutCheckCount);
164             resetTimeoutCheck();
165             m_timeoutTime = 0;
166             m_timeoutCheckCount = 0;
167         }
168
169         void setSampler(SamplingTool* sampler) { m_sampler = sampler; }
170         SamplingTool* sampler() { return m_sampler; }
171
172 #if ENABLE(JIT)
173
174         static int SFX_CALL cti_timeout_check(CTI_ARGS);
175         static void SFX_CALL cti_register_file_check(CTI_ARGS);
176
177         static JSObject* SFX_CALL cti_op_convert_this(CTI_ARGS);
178         static void SFX_CALL cti_op_end(CTI_ARGS);
179         static JSValue* SFX_CALL cti_op_add(CTI_ARGS);
180         static JSValue* SFX_CALL cti_op_pre_inc(CTI_ARGS);
181         static int SFX_CALL cti_op_loop_if_less(CTI_ARGS);
182         static int SFX_CALL cti_op_loop_if_lesseq(CTI_ARGS);
183         static JSObject* SFX_CALL cti_op_new_object(CTI_ARGS);
184         static void SFX_CALL cti_op_put_by_id(CTI_ARGS);
185         static void SFX_CALL cti_op_put_by_id_second(CTI_ARGS);
186         static void SFX_CALL cti_op_put_by_id_generic(CTI_ARGS);
187         static void SFX_CALL cti_op_put_by_id_fail(CTI_ARGS);
188         static JSValue* SFX_CALL cti_op_get_by_id(CTI_ARGS);
189         static JSValue* SFX_CALL cti_op_get_by_id_second(CTI_ARGS);
190         static JSValue* SFX_CALL cti_op_get_by_id_generic(CTI_ARGS);
191         static JSValue* SFX_CALL cti_op_get_by_id_self_fail(CTI_ARGS);
192         static JSValue* SFX_CALL cti_op_get_by_id_proto_list(CTI_ARGS);
193         static JSValue* SFX_CALL cti_op_get_by_id_proto_list_full(CTI_ARGS);
194         static JSValue* SFX_CALL cti_op_get_by_id_proto_fail(CTI_ARGS);
195         static JSValue* SFX_CALL cti_op_get_by_id_array_fail(CTI_ARGS);
196         static JSValue* SFX_CALL cti_op_get_by_id_string_fail(CTI_ARGS);
197         static JSValue* SFX_CALL cti_op_del_by_id(CTI_ARGS);
198         static JSValue* SFX_CALL cti_op_instanceof(CTI_ARGS);
199         static JSValue* SFX_CALL cti_op_mul(CTI_ARGS);
200         static JSObject* SFX_CALL cti_op_new_func(CTI_ARGS);
201         static void* SFX_CALL cti_op_call_JSFunction(CTI_ARGS);
202         static VoidPtrPair SFX_CALL cti_op_call_arityCheck(CTI_ARGS);
203         static JSValue* SFX_CALL cti_op_call_NotJSFunction(CTI_ARGS);
204         static void SFX_CALL cti_op_create_arguments(CTI_ARGS);
205         static void SFX_CALL cti_op_create_arguments_no_params(CTI_ARGS);
206         static void SFX_CALL cti_op_tear_off_activation(CTI_ARGS);
207         static void SFX_CALL cti_op_tear_off_arguments(CTI_ARGS);
208         static void SFX_CALL cti_op_profile_will_call(CTI_ARGS);
209         static void SFX_CALL cti_op_profile_did_call(CTI_ARGS);
210         static void SFX_CALL cti_op_ret_scopeChain(CTI_ARGS);
211         static JSObject* SFX_CALL cti_op_new_array(CTI_ARGS);
212         static JSValue* SFX_CALL cti_op_resolve(CTI_ARGS);
213         static JSValue* SFX_CALL cti_op_resolve_global(CTI_ARGS);
214         static JSObject* SFX_CALL cti_op_construct_JSConstruct(CTI_ARGS);
215         static JSValue* SFX_CALL cti_op_construct_NotJSConstruct(CTI_ARGS);
216         static JSValue* SFX_CALL cti_op_get_by_val(CTI_ARGS);
217         static VoidPtrPair SFX_CALL cti_op_resolve_func(CTI_ARGS);
218         static JSValue* SFX_CALL cti_op_sub(CTI_ARGS);
219         static void SFX_CALL cti_op_put_by_val(CTI_ARGS);
220         static void SFX_CALL cti_op_put_by_val_array(CTI_ARGS);
221         static JSValue* SFX_CALL cti_op_lesseq(CTI_ARGS);
222         static int SFX_CALL cti_op_loop_if_true(CTI_ARGS);
223         static JSValue* SFX_CALL cti_op_resolve_base(CTI_ARGS);
224         static JSValue* SFX_CALL cti_op_negate(CTI_ARGS);
225         static JSValue* SFX_CALL cti_op_resolve_skip(CTI_ARGS);
226         static JSValue* SFX_CALL cti_op_div(CTI_ARGS);
227         static JSValue* SFX_CALL cti_op_pre_dec(CTI_ARGS);
228         static int SFX_CALL cti_op_jless(CTI_ARGS);
229         static JSValue* SFX_CALL cti_op_not(CTI_ARGS);
230         static int SFX_CALL cti_op_jtrue(CTI_ARGS);
231         static VoidPtrPair SFX_CALL cti_op_post_inc(CTI_ARGS);
232         static JSValue* SFX_CALL cti_op_eq(CTI_ARGS);
233         static JSValue* SFX_CALL cti_op_lshift(CTI_ARGS);
234         static JSValue* SFX_CALL cti_op_bitand(CTI_ARGS);
235         static JSValue* SFX_CALL cti_op_rshift(CTI_ARGS);
236         static JSValue* SFX_CALL cti_op_bitnot(CTI_ARGS);
237         static VoidPtrPair SFX_CALL cti_op_resolve_with_base(CTI_ARGS);
238         static JSObject* SFX_CALL cti_op_new_func_exp(CTI_ARGS);
239         static JSValue* SFX_CALL cti_op_mod(CTI_ARGS);
240         static JSValue* SFX_CALL cti_op_less(CTI_ARGS);
241         static JSValue* SFX_CALL cti_op_neq(CTI_ARGS);
242         static VoidPtrPair SFX_CALL cti_op_post_dec(CTI_ARGS);
243         static JSValue* SFX_CALL cti_op_urshift(CTI_ARGS);
244         static JSValue* SFX_CALL cti_op_bitxor(CTI_ARGS);
245         static JSObject* SFX_CALL cti_op_new_regexp(CTI_ARGS);
246         static JSValue* SFX_CALL cti_op_bitor(CTI_ARGS);
247         static JSValue* SFX_CALL cti_op_call_eval(CTI_ARGS);
248         static JSValue* SFX_CALL cti_op_throw(CTI_ARGS);
249         static JSPropertyNameIterator* SFX_CALL cti_op_get_pnames(CTI_ARGS);
250         static JSValue* SFX_CALL cti_op_next_pname(CTI_ARGS);
251         static void SFX_CALL cti_op_push_scope(CTI_ARGS);
252         static void SFX_CALL cti_op_pop_scope(CTI_ARGS);
253         static JSValue* SFX_CALL cti_op_typeof(CTI_ARGS);
254         static JSValue* SFX_CALL cti_op_is_undefined(CTI_ARGS);
255         static JSValue* SFX_CALL cti_op_is_boolean(CTI_ARGS);
256         static JSValue* SFX_CALL cti_op_is_number(CTI_ARGS);
257         static JSValue* SFX_CALL cti_op_is_string(CTI_ARGS);
258         static JSValue* SFX_CALL cti_op_is_object(CTI_ARGS);
259         static JSValue* SFX_CALL cti_op_is_function(CTI_ARGS);
260         static JSValue* SFX_CALL cti_op_stricteq(CTI_ARGS);
261         static JSValue* SFX_CALL cti_op_nstricteq(CTI_ARGS);
262         static JSValue* SFX_CALL cti_op_to_jsnumber(CTI_ARGS);
263         static JSValue* SFX_CALL cti_op_in(CTI_ARGS);
264         static JSObject* SFX_CALL cti_op_push_new_scope(CTI_ARGS);
265         static void SFX_CALL cti_op_jmp_scopes(CTI_ARGS);
266         static void SFX_CALL cti_op_put_by_index(CTI_ARGS);
267         static void* SFX_CALL cti_op_switch_imm(CTI_ARGS);
268         static void* SFX_CALL cti_op_switch_char(CTI_ARGS);
269         static void* SFX_CALL cti_op_switch_string(CTI_ARGS);
270         static JSValue* SFX_CALL cti_op_del_by_val(CTI_ARGS);
271         static void SFX_CALL cti_op_put_getter(CTI_ARGS);
272         static void SFX_CALL cti_op_put_setter(CTI_ARGS);
273         static JSObject* SFX_CALL cti_op_new_error(CTI_ARGS);
274         static void SFX_CALL cti_op_debug(CTI_ARGS);
275
276         static JSValue* SFX_CALL cti_vm_throw(CTI_ARGS);
277         static void* SFX_CALL cti_vm_dontLazyLinkCall(CTI_ARGS);
278         static void* SFX_CALL cti_vm_lazyLinkCall(CTI_ARGS);
279         static JSObject* SFX_CALL cti_op_push_activation(CTI_ARGS);
280         
281 #endif // ENABLE(JIT)
282
283         // Default number of ticks before a timeout check should be done.
284         static const int initialTickCountThreshold = 1024;
285
286         bool isJSArray(JSValue* v) { return !JSImmediate::isImmediate(v) && v->asCell()->vptr() == m_jsArrayVptr; }
287         bool isJSString(JSValue* v) { return !JSImmediate::isImmediate(v) && v->asCell()->vptr() == m_jsStringVptr; }
288
289     private:
290         enum ExecutionFlag { Normal, InitializeAndReturn };
291
292         NEVER_INLINE JSValue* callEval(CallFrame*, RegisterFile*, Register* argv, int argc, int registerOffset, JSValue*& exceptionValue);
293         JSValue* execute(EvalNode*, CallFrame*, JSObject* thisObject, int globalRegisterOffset, ScopeChainNode*, JSValue** exception);
294
295         NEVER_INLINE void debug(CallFrame*, DebugHookID, int firstLine, int lastLine);
296
297         NEVER_INLINE bool resolve(CallFrame*, Instruction*, JSValue*& exceptionValue);
298         NEVER_INLINE bool resolveSkip(CallFrame*, Instruction*, JSValue*& exceptionValue);
299         NEVER_INLINE bool resolveGlobal(CallFrame*, Instruction*, JSValue*& exceptionValue);
300         NEVER_INLINE void resolveBase(CallFrame*, Instruction* vPC);
301         NEVER_INLINE bool resolveBaseAndProperty(CallFrame*, Instruction*, JSValue*& exceptionValue);
302         NEVER_INLINE ScopeChainNode* createExceptionScope(CallFrame*, const Instruction* vPC);
303
304         NEVER_INLINE bool unwindCallFrame(CallFrame*&, JSValue*, const Instruction*&, CodeBlock*&);
305         NEVER_INLINE HandlerInfo* throwException(CallFrame*&, JSValue*&, const Instruction*, bool);
306         NEVER_INLINE bool resolveBaseAndFunc(CallFrame*, Instruction*, JSValue*& exceptionValue);
307
308         static ALWAYS_INLINE CallFrame* slideRegisterWindowForCall(CodeBlock*, RegisterFile*, CallFrame*, size_t registerOffset, int argc);
309
310         static CallFrame* findFunctionCallFrame(CallFrame*, InternalFunction*);
311
312         JSValue* privateExecute(ExecutionFlag, RegisterFile*, CallFrame*, JSValue** exception);
313
314         void dumpCallFrame(CallFrame*);
315         void dumpRegisters(CallFrame*);
316
317         JSValue* checkTimeout(JSGlobalObject*);
318         void resetTimeoutCheck();
319
320         void tryCacheGetByID(CallFrame*, CodeBlock*, Instruction*, JSValue* baseValue, const Identifier& propertyName, const PropertySlot&);
321         void uncacheGetByID(CodeBlock*, Instruction* vPC);
322         void tryCachePutByID(CallFrame*, CodeBlock*, Instruction*, JSValue* baseValue, const PutPropertySlot&);
323         void uncachePutByID(CodeBlock*, Instruction* vPC);
324         
325         bool isCallBytecode(Opcode opcode) { return opcode == getOpcode(op_call) || opcode == getOpcode(op_construct) || opcode == getOpcode(op_call_eval); }
326
327 #if ENABLE(JIT)
328         static void throwStackOverflowPreviousFrame(CallFrame**, JSGlobalData*, void*& returnAddress);
329
330         void tryCTICacheGetByID(CallFrame*, CodeBlock*, void* returnAddress, JSValue* baseValue, const Identifier& propertyName, const PropertySlot&);
331         void tryCTICachePutByID(CallFrame*, CodeBlock*, void* returnAddress, JSValue* baseValue, const PutPropertySlot&);
332 #endif
333
334         SamplingTool* m_sampler;
335
336 #if ENABLE(JIT)
337         RefPtr<ExecutablePool> m_executablePool;
338         void* m_ctiArrayLengthTrampoline;
339         void* m_ctiStringLengthTrampoline;
340         void* m_ctiVirtualCallPreLink;
341         void* m_ctiVirtualCallLink;
342         void* m_ctiVirtualCall;
343 #endif
344
345         int m_reentryDepth;
346         unsigned m_timeoutTime;
347         unsigned m_timeAtLastCheckTimeout;
348         unsigned m_timeExecuting;
349         unsigned m_timeoutCheckCount;
350         unsigned m_ticksUntilNextTimeoutCheck;
351
352         RegisterFile m_registerFile;
353         
354         void* m_jsArrayVptr;
355         void* m_jsStringVptr;
356         void* m_jsFunctionVptr;
357
358 #if HAVE(COMPUTED_GOTO)
359         Opcode m_opcodeTable[numOpcodeIDs]; // Maps OpcodeID => Opcode for compiling
360         HashMap<Opcode, OpcodeID> m_opcodeIDTable; // Maps Opcode => OpcodeID for decompiling
361 #endif
362     };
363
364 } // namespace JSC
365
366 #endif // Interpreter_h