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