Use one object instead of two for closures, eliminating ScopeChainNode
[WebKit-https.git] / Source / JavaScriptCore / interpreter / CallFrame.h
1 /*
2  *  Copyright (C) 1999-2001 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2003, 2007, 2008, 2011 Apple Inc. All rights reserved.
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Library General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2 of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Library General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Library General Public License
17  *  along with this library; see the file COPYING.LIB.  If not, write to
18  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  *  Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef CallFrame_h
24 #define CallFrame_h
25
26 #include "AbstractPC.h"
27 #include "JSGlobalData.h"
28 #include "MacroAssemblerCodeRef.h"
29 #include "RegisterFile.h"
30
31 namespace JSC  {
32
33     class Arguments;
34     class JSActivation;
35     class Interpreter;
36     class JSScope;
37
38     // Represents the current state of script execution.
39     // Passed as the first argument to most functions.
40     class ExecState : private Register {
41     public:
42         JSValue calleeAsValue() const { return this[RegisterFile::Callee].jsValue(); }
43         JSObject* callee() const { return this[RegisterFile::Callee].function(); }
44         CodeBlock* codeBlock() const { return this[RegisterFile::CodeBlock].Register::codeBlock(); }
45         JSScope* scope() const
46         {
47             ASSERT(this[RegisterFile::ScopeChain].Register::scope());
48             return this[RegisterFile::ScopeChain].Register::scope();
49         }
50
51         // Global object in which execution began.
52         JSGlobalObject* dynamicGlobalObject();
53
54         // Global object in which the currently executing code was defined.
55         // Differs from dynamicGlobalObject() during function calls across web browser frames.
56         inline JSGlobalObject* lexicalGlobalObject() const;
57
58         // Differs from lexicalGlobalObject because this will have DOM window shell rather than
59         // the actual DOM window, which can't be "this" for security reasons.
60         inline JSObject* globalThisValue() const;
61
62         inline JSGlobalData& globalData() const;
63
64         // Convenience functions for access to global data.
65         // It takes a few memory references to get from a call frame to the global data
66         // pointer, so these are inefficient, and should be used sparingly in new code.
67         // But they're used in many places in legacy code, so they're not going away any time soon.
68
69         void clearException() { globalData().exception = JSValue(); }
70         JSValue exception() const { return globalData().exception; }
71         bool hadException() const { return globalData().exception; }
72
73         const CommonIdentifiers& propertyNames() const { return *globalData().propertyNames; }
74         const MarkedArgumentBuffer& emptyList() const { return *globalData().emptyList; }
75         Interpreter* interpreter() { return globalData().interpreter; }
76         Heap* heap() { return &globalData().heap; }
77 #ifndef NDEBUG
78         void dumpCaller();
79 #endif
80         static const HashTable* arrayConstructorTable(CallFrame* callFrame) { return callFrame->globalData().arrayConstructorTable; }
81         static const HashTable* arrayPrototypeTable(CallFrame* callFrame) { return callFrame->globalData().arrayPrototypeTable; }
82         static const HashTable* booleanPrototypeTable(CallFrame* callFrame) { return callFrame->globalData().booleanPrototypeTable; }
83         static const HashTable* dateTable(CallFrame* callFrame) { return callFrame->globalData().dateTable; }
84         static const HashTable* dateConstructorTable(CallFrame* callFrame) { return callFrame->globalData().dateConstructorTable; }
85         static const HashTable* errorPrototypeTable(CallFrame* callFrame) { return callFrame->globalData().errorPrototypeTable; }
86         static const HashTable* globalObjectTable(CallFrame* callFrame) { return callFrame->globalData().globalObjectTable; }
87         static const HashTable* jsonTable(CallFrame* callFrame) { return callFrame->globalData().jsonTable; }
88         static const HashTable* mathTable(CallFrame* callFrame) { return callFrame->globalData().mathTable; }
89         static const HashTable* numberConstructorTable(CallFrame* callFrame) { return callFrame->globalData().numberConstructorTable; }
90         static const HashTable* numberPrototypeTable(CallFrame* callFrame) { return callFrame->globalData().numberPrototypeTable; }
91         static const HashTable* objectConstructorTable(CallFrame* callFrame) { return callFrame->globalData().objectConstructorTable; }
92         static const HashTable* objectPrototypeTable(CallFrame* callFrame) { return callFrame->globalData().objectPrototypeTable; }
93         static const HashTable* privateNamePrototypeTable(CallFrame* callFrame) { return callFrame->globalData().privateNamePrototypeTable; }
94         static const HashTable* regExpTable(CallFrame* callFrame) { return callFrame->globalData().regExpTable; }
95         static const HashTable* regExpConstructorTable(CallFrame* callFrame) { return callFrame->globalData().regExpConstructorTable; }
96         static const HashTable* regExpPrototypeTable(CallFrame* callFrame) { return callFrame->globalData().regExpPrototypeTable; }
97         static const HashTable* stringTable(CallFrame* callFrame) { return callFrame->globalData().stringTable; }
98         static const HashTable* stringConstructorTable(CallFrame* callFrame) { return callFrame->globalData().stringConstructorTable; }
99
100         static CallFrame* create(Register* callFrameBase) { return static_cast<CallFrame*>(callFrameBase); }
101         Register* registers() { return this; }
102
103         CallFrame& operator=(const Register& r) { *static_cast<Register*>(this) = r; return *this; }
104
105         CallFrame* callerFrame() const { return this[RegisterFile::CallerFrame].callFrame(); }
106 #if ENABLE(JIT) || ENABLE(LLINT)
107         ReturnAddressPtr returnPC() const { return ReturnAddressPtr(this[RegisterFile::ReturnPC].vPC()); }
108         bool hasReturnPC() const { return !!this[RegisterFile::ReturnPC].vPC(); }
109         void clearReturnPC() { registers()[RegisterFile::ReturnPC] = static_cast<Instruction*>(0); }
110 #endif
111         AbstractPC abstractReturnPC(JSGlobalData& globalData) { return AbstractPC(globalData, this); }
112 #if USE(JSVALUE32_64)
113         unsigned bytecodeOffsetForNonDFGCode() const;
114         void setBytecodeOffsetForNonDFGCode(unsigned offset);
115 #else
116         unsigned bytecodeOffsetForNonDFGCode() const
117         {
118             ASSERT(codeBlock());
119             return this[RegisterFile::ArgumentCount].tag();
120         }
121         
122         void setBytecodeOffsetForNonDFGCode(unsigned offset)
123         {
124             ASSERT(codeBlock());
125             this[RegisterFile::ArgumentCount].tag() = static_cast<int32_t>(offset);
126         }
127 #endif
128
129         Register* frameExtent()
130         {
131             if (!codeBlock())
132                 return registers();
133             return frameExtentInternal();
134         }
135     
136         Register* frameExtentInternal();
137     
138 #if ENABLE(DFG_JIT)
139         InlineCallFrame* inlineCallFrame() const { return this[RegisterFile::ReturnPC].asInlineCallFrame(); }
140         unsigned codeOriginIndexForDFG() const { return this[RegisterFile::ArgumentCount].tag(); }
141 #else
142         // This will never be called if !ENABLE(DFG_JIT) since all calls should be guarded by
143         // isInlineCallFrame(). But to make it easier to write code without having a bunch of
144         // #if's, we make a dummy implementation available anyway.
145         InlineCallFrame* inlineCallFrame() const
146         {
147             ASSERT_NOT_REACHED();
148             return 0;
149         }
150 #endif
151 #if ENABLE(CLASSIC_INTERPRETER)
152         Instruction* returnVPC() const { return this[RegisterFile::ReturnPC].vPC(); }
153 #endif
154 #if USE(JSVALUE32_64)
155         Instruction* currentVPC() const
156         {
157             return bitwise_cast<Instruction*>(this[RegisterFile::ArgumentCount].tag());
158         }
159         void setCurrentVPC(Instruction* vpc)
160         {
161             this[RegisterFile::ArgumentCount].tag() = bitwise_cast<int32_t>(vpc);
162         }
163 #else
164         Instruction* currentVPC() const;
165         void setCurrentVPC(Instruction* vpc);
166 #endif
167
168         void setCallerFrame(CallFrame* callerFrame) { static_cast<Register*>(this)[RegisterFile::CallerFrame] = callerFrame; }
169         void setScope(JSScope* scope) { static_cast<Register*>(this)[RegisterFile::ScopeChain] = scope; }
170
171         ALWAYS_INLINE void init(CodeBlock* codeBlock, Instruction* vPC, JSScope* scope,
172             CallFrame* callerFrame, int argc, JSObject* callee)
173         {
174             ASSERT(callerFrame); // Use noCaller() rather than 0 for the outer host call frame caller.
175             ASSERT(callerFrame == noCaller() || callerFrame->removeHostCallFrameFlag()->registerFile()->end() >= this);
176
177             setCodeBlock(codeBlock);
178             setScope(scope);
179             setCallerFrame(callerFrame);
180             setReturnPC(vPC); // This is either an Instruction* or a pointer into JIT generated code stored as an Instruction*.
181             setArgumentCountIncludingThis(argc); // original argument count (for the sake of the "arguments" object)
182             setCallee(callee);
183         }
184
185         // Read a register from the codeframe (or constant from the CodeBlock).
186         inline Register& r(int);
187         // Read a register for a non-constant 
188         inline Register& uncheckedR(int);
189
190         // Access to arguments.
191         size_t argumentCount() const { return argumentCountIncludingThis() - 1; }
192         size_t argumentCountIncludingThis() const { return this[RegisterFile::ArgumentCount].payload(); }
193         static int argumentOffset(size_t argument) { return s_firstArgumentOffset - argument; }
194         static int argumentOffsetIncludingThis(size_t argument) { return s_thisArgumentOffset - argument; }
195
196         JSValue argument(size_t argument)
197         {
198             if (argument >= argumentCount())
199                  return jsUndefined();
200             return this[argumentOffset(argument)].jsValue();
201         }
202         void setArgument(size_t argument, JSValue value)
203         {
204             this[argumentOffset(argument)] = value;
205         }
206
207         static int thisArgumentOffset() { return argumentOffsetIncludingThis(0); }
208         JSValue thisValue() { return this[thisArgumentOffset()].jsValue(); }
209         void setThisValue(JSValue value) { this[thisArgumentOffset()] = value; }
210
211         static int offsetFor(size_t argumentCountIncludingThis) { return argumentCountIncludingThis + RegisterFile::CallFrameHeaderSize; }
212
213         // FIXME: Remove these.
214         int hostThisRegister() { return thisArgumentOffset(); }
215         JSValue hostThisValue() { return thisValue(); }
216
217         static CallFrame* noCaller() { return reinterpret_cast<CallFrame*>(HostCallFrameFlag); }
218
219         bool hasHostCallFrameFlag() const { return reinterpret_cast<intptr_t>(this) & HostCallFrameFlag; }
220         CallFrame* addHostCallFrameFlag() const { return reinterpret_cast<CallFrame*>(reinterpret_cast<intptr_t>(this) | HostCallFrameFlag); }
221         CallFrame* removeHostCallFrameFlag() { return reinterpret_cast<CallFrame*>(reinterpret_cast<intptr_t>(this) & ~HostCallFrameFlag); }
222
223         void setArgumentCountIncludingThis(int count) { static_cast<Register*>(this)[RegisterFile::ArgumentCount].payload() = count; }
224         void setCallee(JSObject* callee) { static_cast<Register*>(this)[RegisterFile::Callee] = Register::withCallee(callee); }
225         void setCodeBlock(CodeBlock* codeBlock) { static_cast<Register*>(this)[RegisterFile::CodeBlock] = codeBlock; }
226         void setReturnPC(void* value) { static_cast<Register*>(this)[RegisterFile::ReturnPC] = (Instruction*)value; }
227         
228 #if ENABLE(DFG_JIT)
229         bool isInlineCallFrame();
230         
231         void setInlineCallFrame(InlineCallFrame* inlineCallFrame) { static_cast<Register*>(this)[RegisterFile::ReturnPC] = inlineCallFrame; }
232         
233         // Call this to get the semantically correct JS CallFrame* for the
234         // currently executing function.
235         CallFrame* trueCallFrame(AbstractPC);
236         
237         // Call this to get the semantically correct JS CallFrame* corresponding
238         // to the caller. This resolves issues surrounding inlining and the
239         // HostCallFrameFlag stuff.
240         CallFrame* trueCallerFrame();
241         
242         CodeBlock* someCodeBlockForPossiblyInlinedCode();
243 #else
244         bool isInlineCallFrame() { return false; }
245         
246         CallFrame* trueCallFrame(AbstractPC) { return this; }
247         CallFrame* trueCallerFrame() { return callerFrame()->removeHostCallFrameFlag(); }
248         
249         CodeBlock* someCodeBlockForPossiblyInlinedCode() { return codeBlock(); }
250 #endif
251         
252         // Call this to get the true call frame (accounted for inlining and any
253         // other optimizations), when you have entered into VM code through one
254         // of the "blessed" entrypoints (JITStubs or DFGOperations). This means
255         // that if you're pretty much anywhere in the VM you can safely call this;
256         // though if you were to magically get an ExecState* by, say, interrupting
257         // a thread that is running JS code and brutishly scraped the call frame
258         // register, calling this method would probably lead to horrible things
259         // happening.
260         CallFrame* trueCallFrameFromVMCode() { return trueCallFrame(AbstractPC()); }
261
262     private:
263         static const intptr_t HostCallFrameFlag = 1;
264         static const int s_thisArgumentOffset = -1 - RegisterFile::CallFrameHeaderSize;
265         static const int s_firstArgumentOffset = s_thisArgumentOffset - 1;
266
267 #ifndef NDEBUG
268         RegisterFile* registerFile();
269 #endif
270 #if ENABLE(DFG_JIT)
271         bool isInlineCallFrameSlow();
272 #endif
273         ExecState();
274         ~ExecState();
275
276         friend class VMInspector;
277     };
278
279 } // namespace JSC
280
281 #endif // CallFrame_h