Try ripping out inferred types because it might be a performance improvement
[WebKit-https.git] / Source / JavaScriptCore / inspector / ScriptCallStackFactory.cpp
1 /*
2  * Copyright (C) 2014, 2016 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 "CatchScope.h"
38 #include "CodeBlock.h"
39 #include "Exception.h"
40 #include "JSCJSValue.h"
41 #include "JSCInlines.h"
42 #include "ScriptArguments.h"
43 #include "ScriptCallFrame.h"
44 #include "StackVisitor.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) const
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(), static_cast<SourceID>(visitor->sourceID()), line, column));
72
73             m_remainingCapacityForFrameCapture--;
74             return StackVisitor::Continue;
75         }
76
77         return StackVisitor::Done;
78     }
79
80 private:
81     mutable bool m_needToSkipAFrame;
82     Vector<ScriptCallFrame>& m_frames;
83     mutable size_t m_remainingCapacityForFrameCapture;
84 };
85
86 Ref<ScriptCallStack> createScriptCallStack(JSC::ExecState* exec, size_t maxStackSize)
87 {
88     if (!exec)
89         return ScriptCallStack::create();
90
91     JSLockHolder locker(exec);
92     Vector<ScriptCallFrame> frames;
93
94     CallFrame* frame = exec->vm().topCallFrame;
95     if (!frame)
96         return ScriptCallStack::create();
97     CreateScriptCallStackFunctor functor(false, frames, maxStackSize);
98     frame->iterate(functor);
99
100     return ScriptCallStack::create(frames);
101 }
102
103 Ref<ScriptCallStack> createScriptCallStackForConsole(JSC::ExecState* exec, size_t maxStackSize)
104 {
105     if (!exec)
106         return ScriptCallStack::create();
107
108     JSLockHolder locker(exec);
109     Vector<ScriptCallFrame> frames;
110
111     CallFrame* frame = exec->vm().topCallFrame;
112     if (!frame)
113         return ScriptCallStack::create();
114     CreateScriptCallStackFunctor functor(true, frames, maxStackSize);
115     frame->iterate(functor);
116
117     if (frames.isEmpty()) {
118         CreateScriptCallStackFunctor functor(false, frames, maxStackSize);
119         frame->iterate(functor);
120     }
121
122     return ScriptCallStack::create(frames);
123 }
124
125 static bool extractSourceInformationFromException(JSC::ExecState* exec, JSObject* exceptionObject, int* lineNumber, int* columnNumber, String* sourceURL)
126 {
127     VM& vm = exec->vm();
128     auto scope = DECLARE_CATCH_SCOPE(vm);
129
130     // FIXME: <http://webkit.org/b/115087> Web Inspector: Should not need to evaluate JavaScript handling exceptions
131     JSValue lineValue = exceptionObject->getDirect(vm, Identifier::fromString(exec, "line"));
132     JSValue columnValue = exceptionObject->getDirect(vm, Identifier::fromString(exec, "column"));
133     JSValue sourceURLValue = exceptionObject->getDirect(vm, Identifier::fromString(exec, "sourceURL"));
134     
135     bool result = false;
136     if (lineValue && lineValue.isNumber()
137         && sourceURLValue && sourceURLValue.isString()) {
138         *lineNumber = int(lineValue.toNumber(exec));
139         *columnNumber = columnValue && columnValue.isNumber() ? int(columnValue.toNumber(exec)) : 0;
140         *sourceURL = sourceURLValue.toWTFString(exec);
141         result = true;
142     } else if (ErrorInstance* error = jsDynamicCast<ErrorInstance*>(vm, exceptionObject)) {
143         unsigned unsignedLine;
144         unsigned unsignedColumn;
145         result = getLineColumnAndSource(error->stackTrace(), unsignedLine, unsignedColumn, *sourceURL);
146         *lineNumber = static_cast<int>(unsignedLine);
147         *columnNumber = static_cast<int>(unsignedColumn);
148     }
149     
150     if (sourceURL->isEmpty())
151         *sourceURL = "undefined"_s;
152     
153     scope.clearException();
154     return result;
155 }
156
157 Ref<ScriptCallStack> createScriptCallStackFromException(JSC::ExecState* exec, JSC::Exception* exception, size_t maxStackSize)
158 {
159     Vector<ScriptCallFrame> frames;
160     auto& stackTrace = exception->stack();
161     VM& vm = exec->vm();
162     for (size_t i = 0; i < stackTrace.size() && i < maxStackSize; i++) {
163         unsigned line;
164         unsigned column;
165         stackTrace[i].computeLineAndColumn(line, column);
166         String functionName = stackTrace[i].functionName(vm);
167         frames.append(ScriptCallFrame(functionName, stackTrace[i].sourceURL(), static_cast<SourceID>(stackTrace[i].sourceID()), line, column));
168     }
169
170     // Fallback to getting at least the line and sourceURL from the exception object if it has values and the exceptionStack doesn't.
171     if (exception->value().isObject()) {
172         JSObject* exceptionObject = exception->value().toObject(exec);
173         ASSERT(exceptionObject);
174         int lineNumber;
175         int columnNumber;
176         String exceptionSourceURL;
177         if (!frames.size()) {
178             if (extractSourceInformationFromException(exec, exceptionObject, &lineNumber, &columnNumber, &exceptionSourceURL))
179                 frames.append(ScriptCallFrame(String(), exceptionSourceURL, noSourceID, lineNumber, columnNumber));
180         } else {
181             // FIXME: The typical stack trace will have a native frame at the top, and consumers of
182             // this code already know this (see JSDOMExceptionHandling.cpp's reportException, for
183             // example - it uses firstNonNativeCallFrame). This looks like it splats something else
184             // over it. That something else is probably already at stackTrace[1].
185             // https://bugs.webkit.org/show_bug.cgi?id=176663
186             if (!stackTrace[0].hasLineAndColumnInfo() || stackTrace[0].sourceURL().isEmpty()) {
187                 const ScriptCallFrame& firstCallFrame = frames.first();
188                 if (extractSourceInformationFromException(exec, exceptionObject, &lineNumber, &columnNumber, &exceptionSourceURL))
189                     frames[0] = ScriptCallFrame(firstCallFrame.functionName(), exceptionSourceURL, stackTrace[0].sourceID(), lineNumber, columnNumber);
190             }
191         }
192     }
193
194     return ScriptCallStack::create(frames);
195 }
196
197 Ref<ScriptArguments> createScriptArguments(JSC::ExecState* state, unsigned skipArgumentCount)
198 {
199     VM& vm = state->vm();
200     Vector<JSC::Strong<JSC::Unknown>> arguments;
201     size_t argumentCount = state->argumentCount();
202     for (size_t i = skipArgumentCount; i < argumentCount; ++i)
203         arguments.append({ vm, state->uncheckedArgument(i) });
204     return ScriptArguments::create(*state, WTFMove(arguments));
205 }
206
207 } // namespace Inspector