5637b4f642a37d7b5cc350a7949c6c968ba1fa2d
[WebKit-https.git] / Source / JavaScriptCore / inspector / ScriptCallStackFactory.cpp
1 /*
2  * Copyright (C) 2014 Apple Inc. All rights reserved.
3  * Copyright (c) 2010 Google Inc. All rights reserved.
4  * Copyright (C) 2012 Research In Motion Limited. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above
13  * copyright notice, this list of conditions and the following disclaimer
14  * in the documentation and/or other materials provided with the
15  * distribution.
16  *     * Neither the name of Google Inc. nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #include "config.h"
34 #include "ScriptCallStackFactory.h"
35
36 #include "CallFrame.h"
37 #include "JSCJSValue.h"
38 #include "JSCInlines.h"
39 #include "ScriptArguments.h"
40 #include "ScriptCallFrame.h"
41 #include "ScriptCallStack.h"
42 #include "ScriptValue.h"
43 #include "StackVisitor.h"
44 #include <wtf/RefCountedArray.h>
45 #include <wtf/text/WTFString.h>
46
47 using namespace JSC;
48
49 namespace Inspector {
50
51 class CreateScriptCallStackFunctor {
52 public:
53     CreateScriptCallStackFunctor(bool needToSkipAFrame, Vector<ScriptCallFrame>& frames, size_t remainingCapacity)
54         : m_needToSkipAFrame(needToSkipAFrame)
55         , m_frames(frames)
56         , m_remainingCapacityForFrameCapture(remainingCapacity)
57     {
58     }
59
60     StackVisitor::Status operator()(StackVisitor& visitor)
61     {
62         if (m_needToSkipAFrame) {
63             m_needToSkipAFrame = false;
64             return StackVisitor::Continue;
65         }
66
67         if (m_remainingCapacityForFrameCapture) {
68             unsigned line;
69             unsigned column;
70             visitor->computeLineAndColumn(line, column);
71             m_frames.append(ScriptCallFrame(visitor->functionName(), visitor->sourceURL(), line, column));
72
73             m_remainingCapacityForFrameCapture--;
74             return StackVisitor::Continue;
75         }
76
77         return StackVisitor::Done;
78     }
79
80 private:
81     bool m_needToSkipAFrame;
82     Vector<ScriptCallFrame>& m_frames;
83     size_t m_remainingCapacityForFrameCapture;
84 };
85
86 PassRefPtr<ScriptCallStack> createScriptCallStack(JSC::ExecState* exec, size_t maxStackSize, bool emptyIsAllowed)
87 {
88     Vector<ScriptCallFrame> frames;
89
90     if (exec) {
91         CallFrame* frame = exec->vm().topCallFrame;
92         CreateScriptCallStackFunctor functor(false, frames, maxStackSize);
93         frame->iterate(functor);
94     }
95
96     if (frames.isEmpty() && !emptyIsAllowed) {
97         // No frames found. It may happen in the case where
98         // a bound function is called from native code for example.
99         // Fallback to setting lineNumber to 0, and source and function name to "undefined".
100         frames.append(ScriptCallFrame(ASCIILiteral("undefined"), ASCIILiteral("undefined"), 0, 0));
101     }
102
103     return ScriptCallStack::create(frames);
104 }
105
106 PassRefPtr<ScriptCallStack> createScriptCallStack(JSC::ExecState* exec, size_t maxStackSize)
107 {
108     Vector<ScriptCallFrame> frames;
109
110     CallFrame* frame = exec->vm().topCallFrame;
111     CreateScriptCallStackFunctor functor(true, frames, maxStackSize);
112     frame->iterate(functor);
113
114     if (frames.isEmpty()) {
115         CreateScriptCallStackFunctor functor(false, frames, maxStackSize);
116         frame->iterate(functor);
117     }
118
119     return ScriptCallStack::create(frames);
120 }
121
122 PassRefPtr<ScriptCallStack> createScriptCallStackForConsole(JSC::ExecState* exec)
123 {
124     // FIXME: Caller should use createScriptCallStack alternative with the exec and appropriate max.
125     return createScriptCallStack(exec, ScriptCallStack::maxCallStackSizeToCapture);
126 }
127
128 PassRefPtr<ScriptCallStack> createScriptCallStackFromException(JSC::ExecState* exec, JSC::JSValue& exception, size_t maxStackSize)
129 {
130     Vector<ScriptCallFrame> frames;
131     RefCountedArray<StackFrame> stackTrace = exec->vm().exceptionStack();
132     for (size_t i = 0; i < stackTrace.size() && i < maxStackSize; i++) {
133         if (!stackTrace[i].callee && frames.size())
134             break;
135
136         unsigned line;
137         unsigned column;
138         stackTrace[i].computeLineAndColumn(line, column);
139         String functionName = stackTrace[i].friendlyFunctionName(exec);
140         frames.append(ScriptCallFrame(functionName, stackTrace[i].sourceURL, line, column));
141     }
142
143     // FIXME: <http://webkit.org/b/115087> Web Inspector: WebCore::reportException should not evaluate JavaScript handling exceptions
144     // Fallback to getting at least the line and sourceURL from the exception if it has values and the exceptionStack doesn't.
145     if (frames.size() > 0) {
146         const ScriptCallFrame& firstCallFrame = frames.first();
147         JSObject* exceptionObject = exception.toObject(exec);
148         if (exception.isObject() && firstCallFrame.sourceURL().isEmpty()) {
149             JSValue lineValue = exceptionObject->getDirect(exec->vm(), Identifier(exec, "line"));
150             int lineNumber = lineValue && lineValue.isNumber() ? int(lineValue.toNumber(exec)) : 0;
151             JSValue columnValue = exceptionObject->getDirect(exec->vm(), Identifier(exec, "column"));
152             int columnNumber = columnValue && columnValue.isNumber() ? int(columnValue.toNumber(exec)) : 0;
153             JSValue sourceURLValue = exceptionObject->getDirect(exec->vm(), Identifier(exec, "sourceURL"));
154             String exceptionSourceURL = sourceURLValue && sourceURLValue.isString() ? sourceURLValue.toString(exec)->value(exec) : ASCIILiteral("undefined");
155             frames[0] = ScriptCallFrame(firstCallFrame.functionName(), exceptionSourceURL, lineNumber, columnNumber);
156         }
157     }
158
159     return ScriptCallStack::create(frames);
160 }
161
162 PassRefPtr<ScriptArguments> createScriptArguments(JSC::ExecState* exec, unsigned skipArgumentCount)
163 {
164     Vector<Deprecated::ScriptValue> arguments;
165     size_t argumentCount = exec->argumentCount();
166     for (size_t i = skipArgumentCount; i < argumentCount; ++i)
167         arguments.append(Deprecated::ScriptValue(exec->vm(), exec->uncheckedArgument(i)));
168     return ScriptArguments::create(exec, arguments);
169 }
170
171 } // namespace Inspector