fourthTier: Recursive deadlock in DFG::ByteCodeParser
[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, 2013 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 "VM.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         VM& vm() 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() { vm().exception = JSValue(); }
71         void clearSupplementaryExceptionInfo()
72         {
73             vm().clearExceptionStack();
74         }
75
76         JSValue exception() const { return vm().exception; }
77         bool hadException() const { return vm().exception; }
78
79         const CommonIdentifiers& propertyNames() const { return *vm().propertyNames; }
80         const MarkedArgumentBuffer& emptyList() const { return *vm().emptyList; }
81         Interpreter* interpreter() { return vm().interpreter; }
82         Heap* heap() { return &vm().heap; }
83 #ifndef NDEBUG
84         void dumpCaller();
85 #endif
86         static const HashTable* arrayConstructorTable(CallFrame* callFrame) { return callFrame->vm().arrayConstructorTable; }
87         static const HashTable* arrayPrototypeTable(CallFrame* callFrame) { return callFrame->vm().arrayPrototypeTable; }
88         static const HashTable* booleanPrototypeTable(CallFrame* callFrame) { return callFrame->vm().booleanPrototypeTable; }
89         static const HashTable* dateTable(CallFrame* callFrame) { return callFrame->vm().dateTable; }
90         static const HashTable* dateConstructorTable(CallFrame* callFrame) { return callFrame->vm().dateConstructorTable; }
91         static const HashTable* errorPrototypeTable(CallFrame* callFrame) { return callFrame->vm().errorPrototypeTable; }
92         static const HashTable* globalObjectTable(CallFrame* callFrame) { return callFrame->vm().globalObjectTable; }
93         static const HashTable* jsonTable(CallFrame* callFrame) { return callFrame->vm().jsonTable; }
94         static const HashTable* mathTable(CallFrame* callFrame) { return callFrame->vm().mathTable; }
95         static const HashTable* numberConstructorTable(CallFrame* callFrame) { return callFrame->vm().numberConstructorTable; }
96         static const HashTable* numberPrototypeTable(CallFrame* callFrame) { return callFrame->vm().numberPrototypeTable; }
97         static const HashTable* objectConstructorTable(CallFrame* callFrame) { return callFrame->vm().objectConstructorTable; }
98         static const HashTable* privateNamePrototypeTable(CallFrame* callFrame) { return callFrame->vm().privateNamePrototypeTable; }
99         static const HashTable* regExpTable(CallFrame* callFrame) { return callFrame->vm().regExpTable; }
100         static const HashTable* regExpConstructorTable(CallFrame* callFrame) { return callFrame->vm().regExpConstructorTable; }
101         static const HashTable* regExpPrototypeTable(CallFrame* callFrame) { return callFrame->vm().regExpPrototypeTable; }
102         static const HashTable* stringConstructorTable(CallFrame* callFrame) { return callFrame->vm().stringConstructorTable; }
103
104         static CallFrame* create(Register* callFrameBase) { return static_cast<CallFrame*>(callFrameBase); }
105         Register* registers() { return this; }
106
107         CallFrame& operator=(const Register& r) { *static_cast<Register*>(this) = r; return *this; }
108
109         CallFrame* callerFrame() const { return this[JSStack::CallerFrame].callFrame(); }
110 #if ENABLE(JIT) || ENABLE(LLINT)
111         ReturnAddressPtr returnPC() const { return ReturnAddressPtr(this[JSStack::ReturnPC].vPC()); }
112         bool hasReturnPC() const { return !!this[JSStack::ReturnPC].vPC(); }
113         void clearReturnPC() { registers()[JSStack::ReturnPC] = static_cast<Instruction*>(0); }
114 #endif
115         AbstractPC abstractReturnPC(VM& vm) { return AbstractPC(vm, this); }
116
117         class Location {
118         public:
119             static inline uint32_t decode(uint32_t bits);
120
121             static inline bool isBytecodeLocation(uint32_t bits);
122 #if USE(JSVALUE64)
123             static inline uint32_t encodeAsBytecodeOffset(uint32_t bits);
124 #else
125             static inline uint32_t encodeAsBytecodeInstruction(Instruction*);
126 #endif
127
128             static inline bool isCodeOriginIndex(uint32_t bits);
129             static inline uint32_t encodeAsCodeOriginIndex(uint32_t bits);
130
131             static inline bool isInlinedCode(uint32_t bits);
132             static inline uint32_t encodeAsInlinedCode(uint32_t bits);
133
134         private:
135             enum TypeTag {
136                 BytecodeLocationTag = 0,
137                 CodeOriginIndexTag = 1,
138                 IsInlinedCodeTag = 2,
139             };
140
141             static inline uint32_t encode(TypeTag, uint32_t bits);
142
143             static const uint32_t s_mask = 0x3;
144 #if USE(JSVALUE64)
145             static const uint32_t s_shift = 30;
146             static const uint32_t s_shiftedMask = s_mask << s_shift;
147 #else
148             static const uint32_t s_shift = 2;
149 #endif
150         };
151
152         bool isInlinedFrame() const;
153         void setIsInlinedFrame();
154
155         bool hasLocationAsBytecodeOffset() const;
156         bool hasLocationAsCodeOriginIndex() const;
157
158         unsigned locationAsRawBits() const;
159         unsigned locationAsBytecodeOffset() const;
160         unsigned locationAsCodeOriginIndex() const;
161
162         void setLocationAsRawBits(unsigned);
163         void setLocationAsBytecodeOffset(unsigned);
164
165 #if ENABLE(DFG_JIT)
166         unsigned bytecodeOffsetFromCodeOriginIndex();
167 #endif
168
169         Register* frameExtent()
170         {
171             if (!codeBlock())
172                 return registers();
173             return frameExtentInternal();
174         }
175     
176         Register* frameExtentInternal();
177     
178 #if ENABLE(DFG_JIT)
179         InlineCallFrame* inlineCallFrame() const { return this[JSStack::ReturnPC].asInlineCallFrame(); }
180 #else
181         // This will never be called if !ENABLE(DFG_JIT) since all calls should be guarded by
182         // isInlinedFrame(). But to make it easier to write code without having a bunch of
183         // #if's, we make a dummy implementation available anyway.
184         InlineCallFrame* inlineCallFrame() const
185         {
186             RELEASE_ASSERT_NOT_REACHED();
187             return 0;
188         }
189 #endif
190 #if USE(JSVALUE32_64)
191         Instruction* currentVPC() const
192         {
193             return bitwise_cast<Instruction*>(this[JSStack::ArgumentCount].tag());
194         }
195         void setCurrentVPC(Instruction* vpc)
196         {
197             this[JSStack::ArgumentCount].tag() = bitwise_cast<int32_t>(vpc);
198         }
199 #else
200         Instruction* currentVPC() const;
201         void setCurrentVPC(Instruction* vpc);
202 #endif
203
204         void setCallerFrame(CallFrame* callerFrame) { static_cast<Register*>(this)[JSStack::CallerFrame] = callerFrame; }
205         void setScope(JSScope* scope) { static_cast<Register*>(this)[JSStack::ScopeChain] = scope; }
206
207         ALWAYS_INLINE void init(CodeBlock* codeBlock, Instruction* vPC, JSScope* scope,
208             CallFrame* callerFrame, int argc, JSObject* callee)
209         {
210             ASSERT(callerFrame); // Use noCaller() rather than 0 for the outer host call frame caller.
211             ASSERT(callerFrame == noCaller() || callerFrame->removeHostCallFrameFlag()->stack()->end() >= this);
212
213             setCodeBlock(codeBlock);
214             setScope(scope);
215             setCallerFrame(callerFrame);
216             setReturnPC(vPC); // This is either an Instruction* or a pointer into JIT generated code stored as an Instruction*.
217             setArgumentCountIncludingThis(argc); // original argument count (for the sake of the "arguments" object)
218             setCallee(callee);
219         }
220
221         // Read a register from the codeframe (or constant from the CodeBlock).
222         Register& r(int);
223         // Read a register for a non-constant 
224         Register& uncheckedR(int);
225
226         // Access to arguments as passed. (After capture, arguments may move to a different location.)
227         size_t argumentCount() const { return argumentCountIncludingThis() - 1; }
228         size_t argumentCountIncludingThis() const { return this[JSStack::ArgumentCount].payload(); }
229         static int argumentOffset(int argument) { return s_firstArgumentOffset - argument; }
230         static int argumentOffsetIncludingThis(int argument) { return s_thisArgumentOffset - argument; }
231
232         // In the following (argument() and setArgument()), the 'argument'
233         // parameter is the index of the arguments of the target function of
234         // this frame. The index starts at 0 for the first arg, 1 for the
235         // second, etc.
236         //
237         // The arguments (in this case) do not include the 'this' value.
238         // arguments(0) will not fetch the 'this' value. To get/set 'this',
239         // use thisValue() and setThisValue() below.
240
241         JSValue argument(size_t argument)
242         {
243             if (argument >= argumentCount())
244                  return jsUndefined();
245             return this[argumentOffset(argument)].jsValue();
246         }
247         void setArgument(size_t argument, JSValue value)
248         {
249             this[argumentOffset(argument)] = value;
250         }
251
252         static int thisArgumentOffset() { return argumentOffsetIncludingThis(0); }
253         JSValue thisValue() { return this[thisArgumentOffset()].jsValue(); }
254         void setThisValue(JSValue value) { this[thisArgumentOffset()] = value; }
255
256         JSValue argumentAfterCapture(size_t argument);
257
258         static int offsetFor(size_t argumentCountIncludingThis) { return argumentCountIncludingThis + JSStack::CallFrameHeaderSize; }
259
260         // FIXME: Remove these.
261         int hostThisRegister() { return thisArgumentOffset(); }
262         JSValue hostThisValue() { return thisValue(); }
263
264         static CallFrame* noCaller() { return reinterpret_cast<CallFrame*>(HostCallFrameFlag); }
265
266         bool hasHostCallFrameFlag() const { return reinterpret_cast<intptr_t>(this) & HostCallFrameFlag; }
267         CallFrame* addHostCallFrameFlag() const { return reinterpret_cast<CallFrame*>(reinterpret_cast<intptr_t>(this) | HostCallFrameFlag); }
268         CallFrame* removeHostCallFrameFlag() { return reinterpret_cast<CallFrame*>(reinterpret_cast<intptr_t>(this) & ~HostCallFrameFlag); }
269
270         void setArgumentCountIncludingThis(int count) { static_cast<Register*>(this)[JSStack::ArgumentCount].payload() = count; }
271         void setCallee(JSObject* callee) { static_cast<Register*>(this)[JSStack::Callee] = Register::withCallee(callee); }
272         void setCodeBlock(CodeBlock* codeBlock) { static_cast<Register*>(this)[JSStack::CodeBlock] = codeBlock; }
273         void setReturnPC(void* value) { static_cast<Register*>(this)[JSStack::ReturnPC] = (Instruction*)value; }
274         
275 #if ENABLE(DFG_JIT)
276         void setInlineCallFrame(InlineCallFrame* inlineCallFrame) { static_cast<Register*>(this)[JSStack::ReturnPC] = inlineCallFrame; }
277
278         // Call this to get the semantically correct JS CallFrame* for the
279         // currently executing function.
280         CallFrame* trueCallFrame();
281
282         // Call this to get the semantically correct JS CallFrame* corresponding
283         // to the caller. This resolves issues surrounding inlining and the
284         // HostCallFrameFlag stuff.
285         CallFrame* trueCallerFrame();
286 #else
287         CallFrame* trueCallFrame() { return this; }
288         CallFrame* trueCallerFrame() { return callerFrame()->removeHostCallFrameFlag(); }
289 #endif
290         CallFrame* callerFrameNoFlags() { return callerFrame()->removeHostCallFrameFlag(); }
291
292     private:
293         static const intptr_t HostCallFrameFlag = 1;
294         static const int s_thisArgumentOffset = -1 - JSStack::CallFrameHeaderSize;
295         static const int s_firstArgumentOffset = s_thisArgumentOffset - 1;
296
297 #ifndef NDEBUG
298         JSStack* stack();
299 #endif
300         ExecState();
301         ~ExecState();
302
303         // The following are for internal use in debugging and verification
304         // code only and not meant as an API for general usage:
305
306         size_t argIndexForRegister(Register* reg)
307         {
308             // The register at 'offset' number of slots from the frame pointer
309             // i.e.
310             //       reg = frame[offset];
311             //   ==> reg = frame + offset;
312             //   ==> offset = reg - frame;
313             int offset = reg - this->registers();
314
315             // The offset is defined (based on argumentOffset()) to be:
316             //       offset = s_firstArgumentOffset - argIndex;
317             // Hence:
318             //       argIndex = s_firstArgumentOffset - offset;
319             size_t argIndex = s_firstArgumentOffset - offset;
320             return argIndex;
321         }
322
323         JSValue getArgumentUnsafe(size_t argIndex)
324         {
325             // User beware! This method does not verify that there is a valid
326             // argument at the specified argIndex. This is used for debugging
327             // and verification code only. The caller is expected to know what
328             // he/she is doing when calling this method.
329             return this[argumentOffset(argIndex)].jsValue();
330         }
331
332         friend class JSStack;
333         friend class VMInspector;
334     };
335
336 } // namespace JSC
337
338 #endif // CallFrame_h