2008-12-11 Gavin Barraclough <barraclough@apple.com>
[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 #define CTI_ARGS void* args, ...
58 #define ARGS (reinterpret_cast<void**>(vl_args) - 1)
59 #define SFX_CALL
60
61     typedef uint64_t VoidPtrPair;
62
63     typedef union
64     {
65         struct { void* first; void* second; } s;
66         VoidPtrPair i;
67     } VoidPtrPairValue;
68 #endif
69
70     enum DebugHookID {
71         WillExecuteProgram,
72         DidExecuteProgram,
73         DidEnterCallFrame,
74         DidReachBreakpoint,
75         WillLeaveCallFrame,
76         WillExecuteStatement
77     };
78
79     enum { MaxReentryDepth = 128 };
80
81     class Interpreter {
82         friend class JIT;
83     public:
84         Interpreter();
85         ~Interpreter();
86
87         void initialize(JSGlobalData*);
88         
89         RegisterFile& registerFile() { return m_registerFile; }
90         
91         Opcode getOpcode(OpcodeID id)
92         {
93             #if HAVE(COMPUTED_GOTO)
94                 return m_opcodeTable[id];
95             #else
96                 return id;
97             #endif
98         }
99
100         OpcodeID getOpcodeID(Opcode opcode)
101         {
102             #if HAVE(COMPUTED_GOTO)
103                 ASSERT(isOpcode(opcode));
104                 return m_opcodeIDTable.get(opcode);
105             #else
106                 return opcode;
107             #endif
108         }
109
110         bool isOpcode(Opcode);
111         
112         JSValue* execute(ProgramNode*, CallFrame*, ScopeChainNode*, JSObject* thisObj, JSValue** exception);
113         JSValue* execute(FunctionBodyNode*, CallFrame*, JSFunction*, JSObject* thisObj, const ArgList& args, ScopeChainNode*, JSValue** exception);
114         JSValue* execute(EvalNode* evalNode, CallFrame* exec, JSObject* thisObj, ScopeChainNode* scopeChain, JSValue** exception);
115
116         JSValue* retrieveArguments(CallFrame*, JSFunction*) const;
117         JSValue* retrieveCaller(CallFrame*, InternalFunction*) const;
118         void retrieveLastCaller(CallFrame*, int& lineNumber, intptr_t& sourceID, UString& sourceURL, JSValue*& function) const;
119         
120         void getArgumentsData(CallFrame*, JSFunction*&, ptrdiff_t& firstParameterIndex, Register*& argv, int& argc);
121         void setTimeoutTime(unsigned timeoutTime) { m_timeoutTime = timeoutTime; }
122         
123         void startTimeoutCheck()
124         {
125             if (!m_timeoutCheckCount)
126                 resetTimeoutCheck();
127             
128             ++m_timeoutCheckCount;
129         }
130         
131         void stopTimeoutCheck()
132         {
133             ASSERT(m_timeoutCheckCount);
134             --m_timeoutCheckCount;
135         }
136
137         inline void initTimeout()
138         {
139             ASSERT(!m_timeoutCheckCount);
140             resetTimeoutCheck();
141             m_timeoutTime = 0;
142             m_timeoutCheckCount = 0;
143         }
144
145         void setSampler(SamplingTool* sampler) { m_sampler = sampler; }
146         SamplingTool* sampler() { return m_sampler; }
147
148 #if ENABLE(JIT)
149
150         static int SFX_CALL cti_timeout_check(CTI_ARGS);
151         static void SFX_CALL cti_register_file_check(CTI_ARGS);
152
153         static JSObject* SFX_CALL cti_op_convert_this(CTI_ARGS);
154         static void SFX_CALL cti_op_end(CTI_ARGS);
155         static JSValue* SFX_CALL cti_op_add(CTI_ARGS);
156         static JSValue* SFX_CALL cti_op_pre_inc(CTI_ARGS);
157         static int SFX_CALL cti_op_loop_if_less(CTI_ARGS);
158         static int SFX_CALL cti_op_loop_if_lesseq(CTI_ARGS);
159         static JSObject* SFX_CALL cti_op_new_object(CTI_ARGS);
160         static void SFX_CALL cti_op_put_by_id(CTI_ARGS);
161         static void SFX_CALL cti_op_put_by_id_second(CTI_ARGS);
162         static void SFX_CALL cti_op_put_by_id_generic(CTI_ARGS);
163         static void SFX_CALL cti_op_put_by_id_fail(CTI_ARGS);
164         static JSValue* SFX_CALL cti_op_get_by_id(CTI_ARGS);
165         static JSValue* SFX_CALL cti_op_get_by_id_second(CTI_ARGS);
166         static JSValue* SFX_CALL cti_op_get_by_id_generic(CTI_ARGS);
167         static JSValue* SFX_CALL cti_op_get_by_id_self_fail(CTI_ARGS);
168         static JSValue* SFX_CALL cti_op_get_by_id_proto_list(CTI_ARGS);
169         static JSValue* SFX_CALL cti_op_get_by_id_proto_list_full(CTI_ARGS);
170         static JSValue* SFX_CALL cti_op_get_by_id_proto_fail(CTI_ARGS);
171         static JSValue* SFX_CALL cti_op_get_by_id_array_fail(CTI_ARGS);
172         static JSValue* SFX_CALL cti_op_get_by_id_string_fail(CTI_ARGS);
173         static JSValue* SFX_CALL cti_op_del_by_id(CTI_ARGS);
174         static JSValue* SFX_CALL cti_op_instanceof(CTI_ARGS);
175         static JSValue* SFX_CALL cti_op_mul(CTI_ARGS);
176         static JSObject* SFX_CALL cti_op_new_func(CTI_ARGS);
177         static void* SFX_CALL cti_op_call_JSFunction(CTI_ARGS);
178         static VoidPtrPair SFX_CALL cti_op_call_arityCheck(CTI_ARGS);
179         static JSValue* SFX_CALL cti_op_call_NotJSFunction(CTI_ARGS);
180         static void SFX_CALL cti_op_create_arguments(CTI_ARGS);
181         static void SFX_CALL cti_op_create_arguments_no_params(CTI_ARGS);
182         static void SFX_CALL cti_op_tear_off_activation(CTI_ARGS);
183         static void SFX_CALL cti_op_tear_off_arguments(CTI_ARGS);
184         static void SFX_CALL cti_op_profile_will_call(CTI_ARGS);
185         static void SFX_CALL cti_op_profile_did_call(CTI_ARGS);
186         static void SFX_CALL cti_op_ret_scopeChain(CTI_ARGS);
187         static JSObject* SFX_CALL cti_op_new_array(CTI_ARGS);
188         static JSValue* SFX_CALL cti_op_resolve(CTI_ARGS);
189         static JSValue* SFX_CALL cti_op_resolve_global(CTI_ARGS);
190         static JSObject* SFX_CALL cti_op_construct_JSConstruct(CTI_ARGS);
191         static JSValue* SFX_CALL cti_op_construct_NotJSConstruct(CTI_ARGS);
192         static JSValue* SFX_CALL cti_op_get_by_val(CTI_ARGS);
193         static VoidPtrPair SFX_CALL cti_op_resolve_func(CTI_ARGS);
194         static JSValue* SFX_CALL cti_op_sub(CTI_ARGS);
195         static void SFX_CALL cti_op_put_by_val(CTI_ARGS);
196         static void SFX_CALL cti_op_put_by_val_array(CTI_ARGS);
197         static JSValue* SFX_CALL cti_op_lesseq(CTI_ARGS);
198         static int SFX_CALL cti_op_loop_if_true(CTI_ARGS);
199         static JSValue* SFX_CALL cti_op_resolve_base(CTI_ARGS);
200         static JSValue* SFX_CALL cti_op_negate(CTI_ARGS);
201         static JSValue* SFX_CALL cti_op_resolve_skip(CTI_ARGS);
202         static JSValue* SFX_CALL cti_op_div(CTI_ARGS);
203         static JSValue* SFX_CALL cti_op_pre_dec(CTI_ARGS);
204         static int SFX_CALL cti_op_jless(CTI_ARGS);
205         static JSValue* SFX_CALL cti_op_not(CTI_ARGS);
206         static int SFX_CALL cti_op_jtrue(CTI_ARGS);
207         static VoidPtrPair SFX_CALL cti_op_post_inc(CTI_ARGS);
208         static JSValue* SFX_CALL cti_op_eq(CTI_ARGS);
209         static JSValue* SFX_CALL cti_op_lshift(CTI_ARGS);
210         static JSValue* SFX_CALL cti_op_bitand(CTI_ARGS);
211         static JSValue* SFX_CALL cti_op_rshift(CTI_ARGS);
212         static JSValue* SFX_CALL cti_op_bitnot(CTI_ARGS);
213         static VoidPtrPair SFX_CALL cti_op_resolve_with_base(CTI_ARGS);
214         static JSObject* SFX_CALL cti_op_new_func_exp(CTI_ARGS);
215         static JSValue* SFX_CALL cti_op_mod(CTI_ARGS);
216         static JSValue* SFX_CALL cti_op_less(CTI_ARGS);
217         static JSValue* SFX_CALL cti_op_neq(CTI_ARGS);
218         static VoidPtrPair SFX_CALL cti_op_post_dec(CTI_ARGS);
219         static JSValue* SFX_CALL cti_op_urshift(CTI_ARGS);
220         static JSValue* SFX_CALL cti_op_bitxor(CTI_ARGS);
221         static JSObject* SFX_CALL cti_op_new_regexp(CTI_ARGS);
222         static JSValue* SFX_CALL cti_op_bitor(CTI_ARGS);
223         static JSValue* SFX_CALL cti_op_call_eval(CTI_ARGS);
224         static JSValue* SFX_CALL cti_op_throw(CTI_ARGS);
225         static JSPropertyNameIterator* SFX_CALL cti_op_get_pnames(CTI_ARGS);
226         static JSValue* SFX_CALL cti_op_next_pname(CTI_ARGS);
227         static void SFX_CALL cti_op_push_scope(CTI_ARGS);
228         static void SFX_CALL cti_op_pop_scope(CTI_ARGS);
229         static JSValue* SFX_CALL cti_op_typeof(CTI_ARGS);
230         static JSValue* SFX_CALL cti_op_is_undefined(CTI_ARGS);
231         static JSValue* SFX_CALL cti_op_is_boolean(CTI_ARGS);
232         static JSValue* SFX_CALL cti_op_is_number(CTI_ARGS);
233         static JSValue* SFX_CALL cti_op_is_string(CTI_ARGS);
234         static JSValue* SFX_CALL cti_op_is_object(CTI_ARGS);
235         static JSValue* SFX_CALL cti_op_is_function(CTI_ARGS);
236         static JSValue* SFX_CALL cti_op_stricteq(CTI_ARGS);
237         static JSValue* SFX_CALL cti_op_nstricteq(CTI_ARGS);
238         static JSValue* SFX_CALL cti_op_to_jsnumber(CTI_ARGS);
239         static JSValue* SFX_CALL cti_op_in(CTI_ARGS);
240         static JSObject* SFX_CALL cti_op_push_new_scope(CTI_ARGS);
241         static void SFX_CALL cti_op_jmp_scopes(CTI_ARGS);
242         static void SFX_CALL cti_op_put_by_index(CTI_ARGS);
243         static void* SFX_CALL cti_op_switch_imm(CTI_ARGS);
244         static void* SFX_CALL cti_op_switch_char(CTI_ARGS);
245         static void* SFX_CALL cti_op_switch_string(CTI_ARGS);
246         static JSValue* SFX_CALL cti_op_del_by_val(CTI_ARGS);
247         static void SFX_CALL cti_op_put_getter(CTI_ARGS);
248         static void SFX_CALL cti_op_put_setter(CTI_ARGS);
249         static JSObject* SFX_CALL cti_op_new_error(CTI_ARGS);
250         static void SFX_CALL cti_op_debug(CTI_ARGS);
251
252         static JSValue* SFX_CALL cti_vm_throw(CTI_ARGS);
253         static void* SFX_CALL cti_vm_dontLazyLinkCall(CTI_ARGS);
254         static void* SFX_CALL cti_vm_lazyLinkCall(CTI_ARGS);
255         static JSObject* SFX_CALL cti_op_push_activation(CTI_ARGS);
256         
257 #endif // ENABLE(JIT)
258
259         // Default number of ticks before a timeout check should be done.
260         static const int initialTickCountThreshold = 1024;
261
262         bool isJSArray(JSValue* v) { return !JSImmediate::isImmediate(v) && v->asCell()->vptr() == m_jsArrayVptr; }
263         bool isJSString(JSValue* v) { return !JSImmediate::isImmediate(v) && v->asCell()->vptr() == m_jsStringVptr; }
264
265     private:
266         enum ExecutionFlag { Normal, InitializeAndReturn };
267
268         NEVER_INLINE JSValue* callEval(CallFrame*, RegisterFile*, Register* argv, int argc, int registerOffset, JSValue*& exceptionValue);
269         JSValue* execute(EvalNode*, CallFrame*, JSObject* thisObject, int globalRegisterOffset, ScopeChainNode*, JSValue** exception);
270
271         NEVER_INLINE void debug(CallFrame*, DebugHookID, int firstLine, int lastLine);
272
273         NEVER_INLINE bool resolve(CallFrame*, Instruction*, JSValue*& exceptionValue);
274         NEVER_INLINE bool resolveSkip(CallFrame*, Instruction*, JSValue*& exceptionValue);
275         NEVER_INLINE bool resolveGlobal(CallFrame*, Instruction*, JSValue*& exceptionValue);
276         NEVER_INLINE void resolveBase(CallFrame*, Instruction* vPC);
277         NEVER_INLINE bool resolveBaseAndProperty(CallFrame*, Instruction*, JSValue*& exceptionValue);
278         NEVER_INLINE ScopeChainNode* createExceptionScope(CallFrame*, const Instruction* vPC);
279
280         NEVER_INLINE bool unwindCallFrame(CallFrame*&, JSValue*, const Instruction*&, CodeBlock*&);
281         NEVER_INLINE HandlerInfo* throwException(CallFrame*&, JSValue*&, const Instruction*, bool);
282         NEVER_INLINE bool resolveBaseAndFunc(CallFrame*, Instruction*, JSValue*& exceptionValue);
283
284         static ALWAYS_INLINE CallFrame* slideRegisterWindowForCall(CodeBlock*, RegisterFile*, CallFrame*, size_t registerOffset, int argc);
285
286         static CallFrame* findFunctionCallFrame(CallFrame*, InternalFunction*);
287
288         JSValue* privateExecute(ExecutionFlag, RegisterFile*, CallFrame*, JSValue** exception);
289
290         void dumpCallFrame(CallFrame*);
291         void dumpRegisters(CallFrame*);
292
293         JSValue* checkTimeout(JSGlobalObject*);
294         void resetTimeoutCheck();
295
296         void tryCacheGetByID(CallFrame*, CodeBlock*, Instruction*, JSValue* baseValue, const Identifier& propertyName, const PropertySlot&);
297         void uncacheGetByID(CodeBlock*, Instruction* vPC);
298         void tryCachePutByID(CallFrame*, CodeBlock*, Instruction*, JSValue* baseValue, const PutPropertySlot&);
299         void uncachePutByID(CodeBlock*, Instruction* vPC);
300         
301         bool isCallBytecode(Opcode opcode) { return opcode == getOpcode(op_call) || opcode == getOpcode(op_construct) || opcode == getOpcode(op_call_eval); }
302
303 #if ENABLE(JIT)
304         static void throwStackOverflowPreviousFrame(CallFrame**, JSGlobalData*, void*& returnAddress);
305
306         void tryCTICacheGetByID(CallFrame*, CodeBlock*, void* returnAddress, JSValue* baseValue, const Identifier& propertyName, const PropertySlot&);
307         void tryCTICachePutByID(CallFrame*, CodeBlock*, void* returnAddress, JSValue* baseValue, const PutPropertySlot&);
308 #endif
309
310         SamplingTool* m_sampler;
311
312 #if ENABLE(JIT)
313         RefPtr<ExecutablePool> m_executablePool;
314         void* m_ctiArrayLengthTrampoline;
315         void* m_ctiStringLengthTrampoline;
316         void* m_ctiVirtualCallPreLink;
317         void* m_ctiVirtualCallLink;
318         void* m_ctiVirtualCall;
319 #endif
320
321         int m_reentryDepth;
322         unsigned m_timeoutTime;
323         unsigned m_timeAtLastCheckTimeout;
324         unsigned m_timeExecuting;
325         unsigned m_timeoutCheckCount;
326         unsigned m_ticksUntilNextTimeoutCheck;
327
328         RegisterFile m_registerFile;
329         
330         void* m_jsArrayVptr;
331         void* m_jsStringVptr;
332         void* m_jsFunctionVptr;
333
334 #if HAVE(COMPUTED_GOTO)
335         Opcode m_opcodeTable[numOpcodeIDs]; // Maps OpcodeID => Opcode for compiling
336         HashMap<Opcode, OpcodeID> m_opcodeIDTable; // Maps Opcode => OpcodeID for decompiling
337 #endif
338     };
339
340 } // namespace JSC
341
342 #endif // Interpreter_h