DebuggerCallFrame::invalidate() should invalidate all DebuggerScope chains.
[WebKit-https.git] / Source / JavaScriptCore / debugger / DebuggerCallFrame.cpp
1 /*
2  * Copyright (C) 2008, 2013, 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "DebuggerCallFrame.h"
31
32 #include "CodeBlock.h"
33 #include "DebuggerEvalEnabler.h"
34 #include "DebuggerScope.h"
35 #include "Interpreter.h"
36 #include "JSFunction.h"
37 #include "JSLexicalEnvironment.h"
38 #include "JSCInlines.h"
39 #include "Parser.h"
40 #include "StackVisitor.h"
41 #include "StrongInlines.h"
42
43 namespace JSC {
44
45 class LineAndColumnFunctor {
46 public:
47     StackVisitor::Status operator()(StackVisitor& visitor)
48     {
49         visitor->computeLineAndColumn(m_line, m_column);
50         return StackVisitor::Done;
51     }
52
53     unsigned line() const { return m_line; }
54     unsigned column() const { return m_column; }
55
56 private:
57     unsigned m_line;
58     unsigned m_column;
59 };
60
61 class FindCallerMidStackFunctor {
62 public:
63     FindCallerMidStackFunctor(CallFrame* callFrame)
64         : m_callFrame(callFrame)
65         , m_callerFrame(nullptr)
66     { }
67
68     StackVisitor::Status operator()(StackVisitor& visitor)
69     {
70         if (visitor->callFrame() == m_callFrame) {
71             m_callerFrame = visitor->callerFrame();
72             return StackVisitor::Done;
73         }
74         return StackVisitor::Continue;
75     }
76
77     CallFrame* getCallerFrame() const { return m_callerFrame; }
78
79 private:
80     CallFrame* m_callFrame;
81     CallFrame* m_callerFrame;
82 };
83
84 DebuggerCallFrame::DebuggerCallFrame(CallFrame* callFrame)
85     : m_callFrame(callFrame)
86 {
87     m_position = positionForCallFrame(m_callFrame);
88 }
89
90 PassRefPtr<DebuggerCallFrame> DebuggerCallFrame::callerFrame()
91 {
92     ASSERT(isValid());
93     if (!isValid())
94         return 0;
95
96     if (m_caller)
97         return m_caller;
98
99     FindCallerMidStackFunctor functor(m_callFrame);
100     m_callFrame->vm().topCallFrame->iterate(functor);
101
102     CallFrame* callerFrame = functor.getCallerFrame();
103     if (!callerFrame)
104         return 0;
105
106     m_caller = DebuggerCallFrame::create(callerFrame);
107     return m_caller;
108 }
109
110 JSC::JSGlobalObject* DebuggerCallFrame::vmEntryGlobalObject() const
111 {
112     ASSERT(isValid());
113     if (!isValid())
114         return 0;
115     return m_callFrame->vmEntryGlobalObject();
116 }
117
118 SourceID DebuggerCallFrame::sourceID() const
119 {
120     ASSERT(isValid());
121     if (!isValid())
122         return noSourceID;
123     return sourceIDForCallFrame(m_callFrame);
124 }
125
126 String DebuggerCallFrame::functionName() const
127 {
128     ASSERT(isValid());
129     if (!isValid())
130         return String();
131     JSFunction* function = jsDynamicCast<JSFunction*>(m_callFrame->callee());
132     if (!function)
133         return String();
134
135     return getCalculatedDisplayName(m_callFrame, function);
136 }
137
138 DebuggerScope* DebuggerCallFrame::scope()
139 {
140     ASSERT(isValid());
141     if (!isValid())
142         return 0;
143
144     if (!m_scope) {
145         VM& vm = m_callFrame->vm();
146         CodeBlock* codeBlock = m_callFrame->codeBlock();
147         if (codeBlock && codeBlock->needsActivation() && !m_callFrame->hasActivation()) {
148             ASSERT(!m_callFrame->scope()->isWithScope());
149             JSLexicalEnvironment* lexicalEnvironment = JSLexicalEnvironment::create(vm, m_callFrame, codeBlock);
150             m_callFrame->setActivation(lexicalEnvironment);
151             m_callFrame->setScope(lexicalEnvironment);
152         }
153
154         m_scope.set(vm, DebuggerScope::create(vm, m_callFrame->scope()));
155     }
156     return m_scope.get();
157 }
158
159 DebuggerCallFrame::Type DebuggerCallFrame::type() const
160 {
161     ASSERT(isValid());
162     if (!isValid())
163         return ProgramType;
164
165     if (jsDynamicCast<JSFunction*>(m_callFrame->callee()))
166         return FunctionType;
167
168     return ProgramType;
169 }
170
171 JSValue DebuggerCallFrame::thisValue() const
172 {
173     ASSERT(isValid());
174     return thisValueForCallFrame(m_callFrame);
175 }
176
177 // Evaluate some JavaScript code in the scope of this frame.
178 JSValue DebuggerCallFrame::evaluate(const String& script, JSValue& exception)
179 {
180     ASSERT(isValid());
181     CallFrame* callFrame = m_callFrame;
182     if (!callFrame)
183         return jsNull();
184
185     JSLockHolder lock(callFrame);
186
187     if (!callFrame->codeBlock())
188         return JSValue();
189     
190     DebuggerEvalEnabler evalEnabler(callFrame);
191     VM& vm = callFrame->vm();
192     EvalExecutable* eval = EvalExecutable::create(callFrame, makeSource(script), callFrame->codeBlock()->isStrictMode());
193     if (vm.exception()) {
194         exception = vm.exception();
195         vm.clearException();
196         return jsUndefined();
197     }
198
199     JSValue thisValue = thisValueForCallFrame(callFrame);
200     JSValue result = vm.interpreter->execute(eval, callFrame, thisValue, scope()->jsScope());
201     if (vm.exception()) {
202         exception = vm.exception();
203         vm.clearException();
204     }
205     ASSERT(result);
206     return result;
207 }
208
209 void DebuggerCallFrame::invalidate()
210 {
211     RefPtr<DebuggerCallFrame> frame = this;
212     while (frame) {
213         frame->m_callFrame = nullptr;
214         if (frame->m_scope) {
215             frame->m_scope->invalidateChain();
216             frame->m_scope.clear();
217         }
218         frame = frame->m_caller.release();
219     }
220 }
221
222 TextPosition DebuggerCallFrame::positionForCallFrame(CallFrame* callFrame)
223 {
224     if (!callFrame)
225         return TextPosition();
226
227     LineAndColumnFunctor functor;
228     callFrame->iterate(functor);
229     return TextPosition(OrdinalNumber::fromOneBasedInt(functor.line()), OrdinalNumber::fromOneBasedInt(functor.column()));
230 }
231
232 SourceID DebuggerCallFrame::sourceIDForCallFrame(CallFrame* callFrame)
233 {
234     ASSERT(callFrame);
235     CodeBlock* codeBlock = callFrame->codeBlock();
236     if (!codeBlock)
237         return noSourceID;
238     return codeBlock->ownerExecutable()->sourceID();
239 }
240
241 JSValue DebuggerCallFrame::thisValueForCallFrame(CallFrame* callFrame)
242 {
243     if (!callFrame)
244         return jsNull();
245
246     ECMAMode ecmaMode = NotStrictMode;
247     CodeBlock* codeBlock = callFrame->codeBlock();
248     if (codeBlock && codeBlock->isStrictMode())
249         ecmaMode = StrictMode;
250     JSValue thisValue = callFrame->thisValue().toThis(callFrame, ecmaMode);
251     return thisValue;
252 }
253
254 } // namespace JSC