716115baf2ea4273c22aac3f19b7ccad1a8f86e1
[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 #include "Register.h"
31
32 namespace JSC  {
33
34     class Arguments;
35     class JSActivation;
36     class Interpreter;
37     class JSScope;
38
39     // Represents the current state of script execution.
40     // Passed as the first argument to most functions.
41     class ExecState : private Register {
42     public:
43         JSValue calleeAsValue() const { return this[JSStack::Callee].jsValue(); }
44         JSObject* callee() const { return this[JSStack::Callee].function(); }
45         CodeBlock* codeBlock() const { return this[JSStack::CodeBlock].Register::codeBlock(); }
46         JSScope* scope() const
47         {
48             ASSERT(this[JSStack::ScopeChain].Register::scope());
49             return this[JSStack::ScopeChain].Register::scope();
50         }
51
52         // Global object in which execution began.
53         JSGlobalObject* dynamicGlobalObject();
54
55         // Global object in which the currently executing code was defined.
56         // Differs from dynamicGlobalObject() during function calls across web browser frames.
57         JSGlobalObject* lexicalGlobalObject() const;
58
59         // Differs from lexicalGlobalObject because this will have DOM window shell rather than
60         // the actual DOM window, which can't be "this" for security reasons.
61         JSObject* globalThisValue() const;
62
63         JSGlobalData& globalData() const;
64
65         // Convenience functions for access to global data.
66         // It takes a few memory references to get from a call frame to the global data
67         // pointer, so these are inefficient, and should be used sparingly in new code.
68         // But they're used in many places in legacy code, so they're not going away any time soon.
69
70         void clearException() { globalData().exception = JSValue(); }
71         JSValue exception() const { return globalData().exception; }
72         bool hadException() const { return globalData().exception; }
73
74         const CommonIdentifiers& propertyNames() const { return *globalData().propertyNames; }
75         const MarkedArgumentBuffer& emptyList() const { return *globalData().emptyList; }
76         Interpreter* interpreter() { return globalData().interpreter; }
77         Heap* heap() { return &globalData().heap; }
78 #ifndef NDEBUG
79         void dumpCaller();
80 #endif
81         static const HashTable* arrayConstructorTable(CallFrame* callFrame) { return callFrame->globalData().arrayConstructorTable; }
82         static const HashTable* arrayPrototypeTable(CallFrame* callFrame) { return callFrame->globalData().arrayPrototypeTable; }
83         static const HashTable* booleanPrototypeTable(CallFrame* callFrame) { return callFrame->globalData().booleanPrototypeTable; }
84         static const HashTable* dateTable(CallFrame* callFrame) { return callFrame->globalData().dateTable; }
85         static const HashTable* dateConstructorTable(CallFrame* callFrame) { return callFrame->globalData().dateConstructorTable; }
86         static const HashTable* errorPrototypeTable(CallFrame* callFrame) { return callFrame->globalData().errorPrototypeTable; }
87         static const HashTable* globalObjectTable(CallFrame* callFrame) { return callFrame->globalData().globalObjectTable; }
88         static const HashTable* jsonTable(CallFrame* callFrame) { return callFrame->globalData().jsonTable; }
89         static const HashTable* mathTable(CallFrame* callFrame) { return callFrame->globalData().mathTable; }
90         static const HashTable* numberConstructorTable(CallFrame* callFrame) { return callFrame->globalData().numberConstructorTable; }
91         static const HashTable* numberPrototypeTable(CallFrame* callFrame) { return callFrame->globalData().numberPrototypeTable; }
92         static const HashTable* objectConstructorTable(CallFrame* callFrame) { return callFrame->globalData().objectConstructorTable; }
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* stringConstructorTable(CallFrame* callFrame) { return callFrame->globalData().stringConstructorTable; }
98
99         static CallFrame* create(Register* callFrameBase) { return static_cast<CallFrame*>(callFrameBase); }
100         Register* registers() { return this; }
101
102         CallFrame& operator=(const Register& r) { *static_cast<Register*>(this) = r; return *this; }
103
104         CallFrame* callerFrame() const { return this[JSStack::CallerFrame].callFrame(); }
105 #if ENABLE(JIT) || ENABLE(LLINT)
106         ReturnAddressPtr returnPC() const { return ReturnAddressPtr(this[JSStack::ReturnPC].vPC()); }
107         bool hasReturnPC() const { return !!this[JSStack::ReturnPC].vPC(); }
108         void clearReturnPC() { registers()[JSStack::ReturnPC] = static_cast<Instruction*>(0); }
109 #endif
110         AbstractPC abstractReturnPC(JSGlobalData& globalData) { return AbstractPC(globalData, this); }
111 #if USE(JSVALUE32_64)
112         unsigned bytecodeOffsetForNonDFGCode() const;
113         void setBytecodeOffsetForNonDFGCode(unsigned offset);
114 #else
115         unsigned bytecodeOffsetForNonDFGCode() const
116         {
117             ASSERT(codeBlock());
118             return this[JSStack::ArgumentCount].tag();
119         }
120         
121         void setBytecodeOffsetForNonDFGCode(unsigned offset)
122         {
123             ASSERT(codeBlock());
124             this[JSStack::ArgumentCount].tag() = static_cast<int32_t>(offset);
125         }
126 #endif
127
128         Register* frameExtent()
129         {
130             if (!codeBlock())
131                 return registers();
132             return frameExtentInternal();
133         }
134     
135         Register* frameExtentInternal();
136     
137 #if ENABLE(DFG_JIT)
138         InlineCallFrame* inlineCallFrame() const { return this[JSStack::ReturnPC].asInlineCallFrame(); }
139         unsigned codeOriginIndexForDFG() const { return this[JSStack::ArgumentCount].tag(); }
140 #else
141         // This will never be called if !ENABLE(DFG_JIT) since all calls should be guarded by
142         // isInlineCallFrame(). But to make it easier to write code without having a bunch of
143         // #if's, we make a dummy implementation available anyway.
144         InlineCallFrame* inlineCallFrame() const
145         {
146             RELEASE_ASSERT_NOT_REACHED();
147             return 0;
148         }
149 #endif
150 #if USE(JSVALUE32_64)
151         Instruction* currentVPC() const
152         {
153             return bitwise_cast<Instruction*>(this[JSStack::ArgumentCount].tag());
154         }
155         void setCurrentVPC(Instruction* vpc)
156         {
157             this[JSStack::ArgumentCount].tag() = bitwise_cast<int32_t>(vpc);
158         }
159 #else
160         Instruction* currentVPC() const;
161         void setCurrentVPC(Instruction* vpc);
162 #endif
163
164         void setCallerFrame(CallFrame* callerFrame) { static_cast<Register*>(this)[JSStack::CallerFrame] = callerFrame; }
165         void setScope(JSScope* scope) { static_cast<Register*>(this)[JSStack::ScopeChain] = scope; }
166
167         ALWAYS_INLINE void init(CodeBlock* codeBlock, Instruction* vPC, JSScope* scope,
168             CallFrame* callerFrame, int argc, JSObject* callee)
169         {
170             ASSERT(callerFrame); // Use noCaller() rather than 0 for the outer host call frame caller.
171             ASSERT(callerFrame == noCaller() || callerFrame->removeHostCallFrameFlag()->stack()->end() >= this);
172
173             setCodeBlock(codeBlock);
174             setScope(scope);
175             setCallerFrame(callerFrame);
176             setReturnPC(vPC); // This is either an Instruction* or a pointer into JIT generated code stored as an Instruction*.
177             setArgumentCountIncludingThis(argc); // original argument count (for the sake of the "arguments" object)
178             setCallee(callee);
179         }
180
181         // Read a register from the codeframe (or constant from the CodeBlock).
182         Register& r(int);
183         // Read a register for a non-constant 
184         Register& uncheckedR(int);
185
186         // Access to arguments as passed. (After capture, arguments may move to a different location.)
187         size_t argumentCount() const { return argumentCountIncludingThis() - 1; }
188         size_t argumentCountIncludingThis() const { return this[JSStack::ArgumentCount].payload(); }
189         static int argumentOffset(int argument) { return s_firstArgumentOffset - argument; }
190         static int argumentOffsetIncludingThis(int argument) { return s_thisArgumentOffset - argument; }
191
192         // In the following (argument() and setArgument()), the 'argument'
193         // parameter is the index of the arguments of the target function of
194         // this frame. The index starts at 0 for the first arg, 1 for the
195         // second, etc.
196         //
197         // The arguments (in this case) do not include the 'this' value.
198         // arguments(0) will not fetch the 'this' value. To get/set 'this',
199         // use thisValue() and setThisValue() below.
200
201         JSValue argument(size_t argument)
202         {
203             if (argument >= argumentCount())
204                  return jsUndefined();
205             return this[argumentOffset(argument)].jsValue();
206         }
207         void setArgument(size_t argument, JSValue value)
208         {
209             this[argumentOffset(argument)] = value;
210         }
211
212         static int thisArgumentOffset() { return argumentOffsetIncludingThis(0); }
213         JSValue thisValue() { return this[thisArgumentOffset()].jsValue(); }
214         void setThisValue(JSValue value) { this[thisArgumentOffset()] = value; }
215
216         JSValue argumentAfterCapture(size_t argument);
217
218         static int offsetFor(size_t argumentCountIncludingThis) { return argumentCountIncludingThis + JSStack::CallFrameHeaderSize; }
219
220         // FIXME: Remove these.
221         int hostThisRegister() { return thisArgumentOffset(); }
222         JSValue hostThisValue() { return thisValue(); }
223
224         static CallFrame* noCaller() { return reinterpret_cast<CallFrame*>(HostCallFrameFlag); }
225
226         bool hasHostCallFrameFlag() const { return reinterpret_cast<intptr_t>(this) & HostCallFrameFlag; }
227         CallFrame* addHostCallFrameFlag() const { return reinterpret_cast<CallFrame*>(reinterpret_cast<intptr_t>(this) | HostCallFrameFlag); }
228         CallFrame* removeHostCallFrameFlag() { return reinterpret_cast<CallFrame*>(reinterpret_cast<intptr_t>(this) & ~HostCallFrameFlag); }
229
230         void setArgumentCountIncludingThis(int count) { static_cast<Register*>(this)[JSStack::ArgumentCount].payload() = count; }
231         void setCallee(JSObject* callee) { static_cast<Register*>(this)[JSStack::Callee] = Register::withCallee(callee); }
232         void setCodeBlock(CodeBlock* codeBlock) { static_cast<Register*>(this)[JSStack::CodeBlock] = codeBlock; }
233         void setReturnPC(void* value) { static_cast<Register*>(this)[JSStack::ReturnPC] = (Instruction*)value; }
234         
235 #if ENABLE(DFG_JIT)
236         bool isInlineCallFrame();
237         
238         void setInlineCallFrame(InlineCallFrame* inlineCallFrame) { static_cast<Register*>(this)[JSStack::ReturnPC] = inlineCallFrame; }
239         
240         // Call this to get the semantically correct JS CallFrame* for the
241         // currently executing function.
242         CallFrame* trueCallFrame(AbstractPC);
243         
244         // Call this to get the semantically correct JS CallFrame* corresponding
245         // to the caller. This resolves issues surrounding inlining and the
246         // HostCallFrameFlag stuff.
247         CallFrame* trueCallerFrame();
248         
249         CodeBlock* someCodeBlockForPossiblyInlinedCode();
250 #else
251         bool isInlineCallFrame() { return false; }
252         
253         CallFrame* trueCallFrame(AbstractPC) { return this; }
254         CallFrame* trueCallerFrame() { return callerFrame()->removeHostCallFrameFlag(); }
255         
256         CodeBlock* someCodeBlockForPossiblyInlinedCode() { return codeBlock(); }
257 #endif
258         CallFrame* callerFrameNoFlags() { return callerFrame()->removeHostCallFrameFlag(); }
259         
260         // Call this to get the true call frame (accounted for inlining and any
261         // other optimizations), when you have entered into VM code through one
262         // of the "blessed" entrypoints (JITStubs or DFGOperations). This means
263         // that if you're pretty much anywhere in the VM you can safely call this;
264         // though if you were to magically get an ExecState* by, say, interrupting
265         // a thread that is running JS code and brutishly scraped the call frame
266         // register, calling this method would probably lead to horrible things
267         // happening.
268         CallFrame* trueCallFrameFromVMCode() { return trueCallFrame(AbstractPC()); }
269
270     private:
271         static const intptr_t HostCallFrameFlag = 1;
272         static const int s_thisArgumentOffset = -1 - JSStack::CallFrameHeaderSize;
273         static const int s_firstArgumentOffset = s_thisArgumentOffset - 1;
274
275 #ifndef NDEBUG
276         JSStack* stack();
277 #endif
278 #if ENABLE(DFG_JIT)
279         bool isInlineCallFrameSlow();
280 #endif
281         ExecState();
282         ~ExecState();
283
284         // The following are for internal use in debugging and verification
285         // code only and not meant as an API for general usage:
286
287         size_t argIndexForRegister(Register* reg)
288         {
289             // The register at 'offset' number of slots from the frame pointer
290             // i.e.
291             //       reg = frame[offset];
292             //   ==> reg = frame + offset;
293             //   ==> offset = reg - frame;
294             int offset = reg - this->registers();
295
296             // The offset is defined (based on argumentOffset()) to be:
297             //       offset = s_firstArgumentOffset - argIndex;
298             // Hence:
299             //       argIndex = s_firstArgumentOffset - offset;
300             size_t argIndex = s_firstArgumentOffset - offset;
301             return argIndex;
302         }
303
304         JSValue getArgumentUnsafe(size_t argIndex)
305         {
306             // User beware! This method does not verify that there is a valid
307             // argument at the specified argIndex. This is used for debugging
308             // and verification code only. The caller is expected to know what
309             // he/she is doing when calling this method.
310             return this[argumentOffset(argIndex)].jsValue();
311         }
312
313         friend class JSStack;
314         friend class VMInspector;
315     };
316
317 } // namespace JSC
318
319 #endif // CallFrame_h