initial import
[vuplus_webkit] / Source / 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 "JSObject.h"
36 #include "Opcode.h"
37 #include "RegisterFile.h"
38
39 #include <wtf/HashMap.h>
40
41 namespace JSC {
42
43     class CodeBlock;
44     class EvalExecutable;
45     class FunctionExecutable;
46     class JSFunction;
47     class JSGlobalObject;
48     class ProgramExecutable;
49     class Register;
50     class ScopeChainNode;
51     class SamplingTool;
52     struct CallFrameClosure;
53     struct HandlerInfo;
54     struct Instruction;
55     
56     enum DebugHookID {
57         WillExecuteProgram,
58         DidExecuteProgram,
59         DidEnterCallFrame,
60         DidReachBreakpoint,
61         WillLeaveCallFrame,
62         WillExecuteStatement
63     };
64
65     class TopCallFrameSetter {
66     public:
67         TopCallFrameSetter(JSGlobalData& global, CallFrame* callFrame)
68             : globalData(global)
69             , oldCallFrame(global.topCallFrame) 
70         {
71             global.topCallFrame = callFrame;
72         }
73         
74         ~TopCallFrameSetter() 
75         {
76             globalData.topCallFrame = oldCallFrame;
77         }
78     private:
79         JSGlobalData& globalData;
80         CallFrame* oldCallFrame;
81     };
82
83     enum { MaxLargeThreadReentryDepth = 256, MaxSmallThreadReentryDepth = 32 };
84
85     class Interpreter {
86         WTF_MAKE_FAST_ALLOCATED;
87         friend class JIT;
88         friend class CachedCall;
89     public:
90         Interpreter();
91
92         RegisterFile& registerFile() { return m_registerFile; }
93         
94         Opcode getOpcode(OpcodeID id)
95         {
96             #if ENABLE(COMPUTED_GOTO_INTERPRETER)
97                 return m_opcodeTable[id];
98             #else
99                 return id;
100             #endif
101         }
102
103         OpcodeID getOpcodeID(Opcode opcode)
104         {
105             #if ENABLE(COMPUTED_GOTO_INTERPRETER)
106                 ASSERT(isOpcode(opcode));
107                 return m_opcodeIDTable.get(opcode);
108             #else
109                 return opcode;
110             #endif
111         }
112
113         bool isOpcode(Opcode);
114
115         JSValue execute(ProgramExecutable*, CallFrame*, ScopeChainNode*, JSObject* thisObj);
116         JSValue executeCall(CallFrame*, JSObject* function, CallType, const CallData&, JSValue thisValue, const ArgList&);
117         JSObject* executeConstruct(CallFrame*, JSObject* function, ConstructType, const ConstructData&, const ArgList&);
118         JSValue execute(EvalExecutable* evalNode, CallFrame*, JSValue thisValue, ScopeChainNode*);
119
120         JSValue retrieveArguments(CallFrame*, JSFunction*) const;
121         JS_EXPORT_PRIVATE JSValue retrieveCaller(CallFrame*, JSFunction*) const;
122         JS_EXPORT_PRIVATE void retrieveLastCaller(CallFrame*, int& lineNumber, intptr_t& sourceID, UString& sourceURL, JSValue& function) const;
123         
124         void getArgumentsData(CallFrame*, JSFunction*&, ptrdiff_t& firstParameterIndex, Register*& argv, int& argc);
125         
126         SamplingTool* sampler() { return m_sampler.get(); }
127
128         NEVER_INLINE JSValue callEval(CallFrame*, RegisterFile*, Register* argv, int argc, int registerOffset);
129         NEVER_INLINE HandlerInfo* throwException(CallFrame*&, JSValue&, unsigned bytecodeOffset);
130         NEVER_INLINE void debug(CallFrame*, DebugHookID, int firstLine, int lastLine);
131
132         void dumpSampleData(ExecState* exec);
133         void startSampling();
134         void stopSampling();
135     private:
136         enum ExecutionFlag { Normal, InitializeAndReturn };
137
138         CallFrameClosure prepareForRepeatCall(FunctionExecutable*, CallFrame*, JSFunction*, int argCount, ScopeChainNode*);
139         void endRepeatCall(CallFrameClosure&);
140         JSValue execute(CallFrameClosure&);
141
142         JSValue execute(EvalExecutable*, CallFrame*, JSValue thisValue, int globalRegisterOffset, ScopeChainNode*);
143
144 #if ENABLE(INTERPRETER)
145         NEVER_INLINE bool resolve(CallFrame*, Instruction*, JSValue& exceptionValue);
146         NEVER_INLINE bool resolveSkip(CallFrame*, Instruction*, JSValue& exceptionValue);
147         NEVER_INLINE bool resolveGlobal(CallFrame*, Instruction*, JSValue& exceptionValue);
148         NEVER_INLINE bool resolveGlobalDynamic(CallFrame*, Instruction*, JSValue& exceptionValue);
149         NEVER_INLINE void resolveBase(CallFrame*, Instruction* vPC);
150         NEVER_INLINE bool resolveBaseAndProperty(CallFrame*, Instruction*, JSValue& exceptionValue);
151         NEVER_INLINE bool resolveThisAndProperty(CallFrame*, Instruction*, JSValue& exceptionValue);
152         NEVER_INLINE ScopeChainNode* createExceptionScope(CallFrame*, const Instruction* vPC);
153
154         void tryCacheGetByID(CallFrame*, CodeBlock*, Instruction*, JSValue baseValue, const Identifier& propertyName, const PropertySlot&);
155         void uncacheGetByID(CodeBlock*, Instruction* vPC);
156         void tryCachePutByID(CallFrame*, CodeBlock*, Instruction*, JSValue baseValue, const PutPropertySlot&);
157         void uncachePutByID(CodeBlock*, Instruction* vPC);        
158 #endif // ENABLE(INTERPRETER)
159
160         NEVER_INLINE bool unwindCallFrame(CallFrame*&, JSValue, unsigned& bytecodeOffset, CodeBlock*&);
161
162         static ALWAYS_INLINE CallFrame* slideRegisterWindowForCall(CodeBlock*, RegisterFile*, CallFrame*, size_t registerOffset, int argc);
163
164         static CallFrame* findFunctionCallFrame(CallFrame*, JSFunction*);
165
166         JSValue privateExecute(ExecutionFlag, RegisterFile*, CallFrame*);
167
168         void dumpCallFrame(CallFrame*);
169         void dumpRegisters(CallFrame*);
170         
171         bool isCallBytecode(Opcode opcode) { return opcode == getOpcode(op_call) || opcode == getOpcode(op_construct) || opcode == getOpcode(op_call_eval); }
172
173         void enableSampler();
174         int m_sampleEntryDepth;
175         OwnPtr<SamplingTool> m_sampler;
176
177         int m_reentryDepth;
178
179         RegisterFile m_registerFile;
180         
181 #if ENABLE(COMPUTED_GOTO_INTERPRETER)
182         Opcode m_opcodeTable[numOpcodeIDs]; // Maps OpcodeID => Opcode for compiling
183         HashMap<Opcode, OpcodeID> m_opcodeIDTable; // Maps Opcode => OpcodeID for decompiling
184 #endif
185     };
186
187     // This value must not be an object that would require this conversion (WebCore's global object).
188     inline bool isValidThisObject(JSValue thisValue, ExecState* exec)
189     {
190         return !thisValue.isObject() || thisValue.toThisObject(exec) == thisValue;
191     }
192
193 } // namespace JSC
194
195 #endif // Interpreter_h