Make topCallFrame reliable.
[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 "JSStack.h"
29 #include "MacroAssemblerCodeRef.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[JSStack::Callee].jsValue(); }
43         JSObject* callee() const { return this[JSStack::Callee].function(); }
44         CodeBlock* codeBlock() const { return this[JSStack::CodeBlock].Register::codeBlock(); }
45         JSScope* scope() const
46         {
47             ASSERT(this[JSStack::ScopeChain].Register::scope());
48             return this[JSStack::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         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         JSObject* globalThisValue() const;
61
62         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[JSStack::CallerFrame].callFrame(); }
106 #if ENABLE(JIT) || ENABLE(LLINT)
107         ReturnAddressPtr returnPC() const { return ReturnAddressPtr(this[JSStack::ReturnPC].vPC()); }
108         bool hasReturnPC() const { return !!this[JSStack::ReturnPC].vPC(); }
109         void clearReturnPC() { registers()[JSStack::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[JSStack::ArgumentCount].tag();
120         }
121         
122         void setBytecodeOffsetForNonDFGCode(unsigned offset)
123         {
124             ASSERT(codeBlock());
125             this[JSStack::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[JSStack::ReturnPC].asInlineCallFrame(); }
140         unsigned codeOriginIndexForDFG() const { return this[JSStack::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 USE(JSVALUE32_64)
152         Instruction* currentVPC() const
153         {
154             return bitwise_cast<Instruction*>(this[JSStack::ArgumentCount].tag());
155         }
156         void setCurrentVPC(Instruction* vpc)
157         {
158             this[JSStack::ArgumentCount].tag() = bitwise_cast<int32_t>(vpc);
159         }
160 #else
161         Instruction* currentVPC() const;
162         void setCurrentVPC(Instruction* vpc);
163 #endif
164
165         void setCallerFrame(CallFrame* callerFrame) { static_cast<Register*>(this)[JSStack::CallerFrame] = callerFrame; }
166         void setScope(JSScope* scope) { static_cast<Register*>(this)[JSStack::ScopeChain] = scope; }
167
168         ALWAYS_INLINE void init(CodeBlock* codeBlock, Instruction* vPC, JSScope* scope,
169             CallFrame* callerFrame, int argc, JSObject* callee)
170         {
171             ASSERT(callerFrame); // Use noCaller() rather than 0 for the outer host call frame caller.
172             ASSERT(callerFrame == noCaller() || callerFrame->removeHostCallFrameFlag()->stack()->end() >= this);
173
174             setCodeBlock(codeBlock);
175             setScope(scope);
176             setCallerFrame(callerFrame);
177             setReturnPC(vPC); // This is either an Instruction* or a pointer into JIT generated code stored as an Instruction*.
178             setArgumentCountIncludingThis(argc); // original argument count (for the sake of the "arguments" object)
179             setCallee(callee);
180         }
181
182         // Read a register from the codeframe (or constant from the CodeBlock).
183         Register& r(int);
184         // Read a register for a non-constant 
185         Register& uncheckedR(int);
186
187         // Access to arguments as passed. (After capture, arguments may move to a different location.)
188         size_t argumentCount() const { return argumentCountIncludingThis() - 1; }
189         size_t argumentCountIncludingThis() const { return this[JSStack::ArgumentCount].payload(); }
190         static int argumentOffset(int argument) { return s_firstArgumentOffset - argument; }
191         static int argumentOffsetIncludingThis(int argument) { return s_thisArgumentOffset - argument; }
192
193         // In the following (argument() and setArgument()), the 'argument'
194         // parameter is the index of the arguments of the target function of
195         // this frame. The index starts at 0 for the first arg, 1 for the
196         // second, etc.
197         //
198         // The arguments (in this case) do not include the 'this' value.
199         // arguments(0) will not fetch the 'this' value. To get/set 'this',
200         // use thisValue() and setThisValue() below.
201
202         JSValue argument(size_t argument)
203         {
204             if (argument >= argumentCount())
205                  return jsUndefined();
206             return this[argumentOffset(argument)].jsValue();
207         }
208         void setArgument(size_t argument, JSValue value)
209         {
210             this[argumentOffset(argument)] = value;
211         }
212
213         static int thisArgumentOffset() { return argumentOffsetIncludingThis(0); }
214         JSValue thisValue() { return this[thisArgumentOffset()].jsValue(); }
215         void setThisValue(JSValue value) { this[thisArgumentOffset()] = value; }
216
217         JSValue argumentAfterCapture(size_t argument);
218
219         static int offsetFor(size_t argumentCountIncludingThis) { return argumentCountIncludingThis + JSStack::CallFrameHeaderSize; }
220
221         // FIXME: Remove these.
222         int hostThisRegister() { return thisArgumentOffset(); }
223         JSValue hostThisValue() { return thisValue(); }
224
225         static CallFrame* noCaller() { return reinterpret_cast<CallFrame*>(HostCallFrameFlag); }
226
227         bool hasHostCallFrameFlag() const { return reinterpret_cast<intptr_t>(this) & HostCallFrameFlag; }
228         CallFrame* addHostCallFrameFlag() const { return reinterpret_cast<CallFrame*>(reinterpret_cast<intptr_t>(this) | HostCallFrameFlag); }
229         CallFrame* removeHostCallFrameFlag() { return reinterpret_cast<CallFrame*>(reinterpret_cast<intptr_t>(this) & ~HostCallFrameFlag); }
230
231         void setArgumentCountIncludingThis(int count) { static_cast<Register*>(this)[JSStack::ArgumentCount].payload() = count; }
232         void setCallee(JSObject* callee) { static_cast<Register*>(this)[JSStack::Callee] = Register::withCallee(callee); }
233         void setCodeBlock(CodeBlock* codeBlock) { static_cast<Register*>(this)[JSStack::CodeBlock] = codeBlock; }
234         void setReturnPC(void* value) { static_cast<Register*>(this)[JSStack::ReturnPC] = (Instruction*)value; }
235         
236 #if ENABLE(DFG_JIT)
237         bool isInlineCallFrame();
238         
239         void setInlineCallFrame(InlineCallFrame* inlineCallFrame) { static_cast<Register*>(this)[JSStack::ReturnPC] = inlineCallFrame; }
240         
241         // Call this to get the semantically correct JS CallFrame* for the
242         // currently executing function.
243         CallFrame* trueCallFrame(AbstractPC);
244         
245         // Call this to get the semantically correct JS CallFrame* corresponding
246         // to the caller. This resolves issues surrounding inlining and the
247         // HostCallFrameFlag stuff.
248         CallFrame* trueCallerFrame();
249         
250         CodeBlock* someCodeBlockForPossiblyInlinedCode();
251 #else
252         bool isInlineCallFrame() { return false; }
253         
254         CallFrame* trueCallFrame(AbstractPC) { return this; }
255         CallFrame* trueCallerFrame() { return callerFrame()->removeHostCallFrameFlag(); }
256         
257         CodeBlock* someCodeBlockForPossiblyInlinedCode() { return codeBlock(); }
258 #endif
259         CallFrame* callerFrameNoFlags() { return callerFrame()->removeHostCallFrameFlag(); }
260         
261         // Call this to get the true call frame (accounted for inlining and any
262         // other optimizations), when you have entered into VM code through one
263         // of the "blessed" entrypoints (JITStubs or DFGOperations). This means
264         // that if you're pretty much anywhere in the VM you can safely call this;
265         // though if you were to magically get an ExecState* by, say, interrupting
266         // a thread that is running JS code and brutishly scraped the call frame
267         // register, calling this method would probably lead to horrible things
268         // happening.
269         CallFrame* trueCallFrameFromVMCode() { return trueCallFrame(AbstractPC()); }
270
271     private:
272         static const intptr_t HostCallFrameFlag = 1;
273         static const int s_thisArgumentOffset = -1 - JSStack::CallFrameHeaderSize;
274         static const int s_firstArgumentOffset = s_thisArgumentOffset - 1;
275
276 #ifndef NDEBUG
277         JSStack* stack();
278 #endif
279 #if ENABLE(DFG_JIT)
280         bool isInlineCallFrameSlow();
281 #endif
282         ExecState();
283         ~ExecState();
284
285         // The following are for internal use in debugging and verification
286         // code only and not meant as an API for general usage:
287
288         size_t argIndexForRegister(Register* reg)
289         {
290             // The register at 'offset' number of slots from the frame pointer
291             // i.e.
292             //       reg = frame[offset];
293             //   ==> reg = frame + offset;
294             //   ==> offset = reg - frame;
295             int offset = reg - this->registers();
296
297             // The offset is defined (based on argumentOffset()) to be:
298             //       offset = s_firstArgumentOffset - argIndex;
299             // Hence:
300             //       argIndex = s_firstArgumentOffset - offset;
301             size_t argIndex = s_firstArgumentOffset - offset;
302             return argIndex;
303         }
304
305         JSValue getArgumentUnsafe(size_t argIndex)
306         {
307             // User beware! This method does not verify that there is a valid
308             // argument at the specified argIndex. This is used for debugging
309             // and verification code only. The caller is expected to know what
310             // he/she is doing when calling this method.
311             return this[argumentOffset(argIndex)].jsValue();
312         }
313
314         friend class JSStack;
315         friend class VMInspector;
316     };
317
318 } // namespace JSC
319
320 #endif // CallFrame_h