0e62aa40e8725bfcdb0f655ca87a5a4427a8dcf8
[WebKit-https.git] / Source / JavaScriptCore / inspector / JSGlobalObjectInspectorController.cpp
1 /*
2  * Copyright (C) 2014, 2015 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "JSGlobalObjectInspectorController.h"
28
29 #include "CatchScope.h"
30 #include "Completion.h"
31 #include "ConsoleMessage.h"
32 #include "ErrorHandlingScope.h"
33 #include "Exception.h"
34 #include "InjectedScriptHost.h"
35 #include "InjectedScriptManager.h"
36 #include "InspectorAgent.h"
37 #include "InspectorBackendDispatcher.h"
38 #include "InspectorConsoleAgent.h"
39 #include "InspectorFrontendChannel.h"
40 #include "InspectorFrontendRouter.h"
41 #include "InspectorHeapAgent.h"
42 #include "InspectorScriptProfilerAgent.h"
43 #include "JSCInlines.h"
44 #include "JSGlobalObject.h"
45 #include "JSGlobalObjectAuditAgent.h"
46 #include "JSGlobalObjectConsoleClient.h"
47 #include "JSGlobalObjectDebuggerAgent.h"
48 #include "JSGlobalObjectRuntimeAgent.h"
49 #include "ScriptArguments.h"
50 #include "ScriptCallStack.h"
51 #include "ScriptCallStackFactory.h"
52 #include <wtf/StackTrace.h>
53 #include <wtf/Stopwatch.h>
54
55 #if ENABLE(REMOTE_INSPECTOR)
56 #include "JSGlobalObjectDebuggable.h"
57 #include "RemoteInspector.h"
58 #endif
59
60 using namespace JSC;
61
62 namespace Inspector {
63
64 JSGlobalObjectInspectorController::JSGlobalObjectInspectorController(JSGlobalObject& globalObject)
65     : m_globalObject(globalObject)
66     , m_injectedScriptManager(std::make_unique<InjectedScriptManager>(*this, InjectedScriptHost::create()))
67     , m_executionStopwatch(Stopwatch::create())
68     , m_scriptDebugServer(globalObject)
69     , m_frontendRouter(FrontendRouter::create())
70     , m_backendDispatcher(BackendDispatcher::create(m_frontendRouter.copyRef()))
71 {
72     auto context = jsAgentContext();
73
74     auto inspectorAgent = std::make_unique<InspectorAgent>(context);
75     auto runtimeAgent = std::make_unique<JSGlobalObjectRuntimeAgent>(context);
76     auto heapAgent = std::make_unique<InspectorHeapAgent>(context);
77     auto consoleAgent = std::make_unique<InspectorConsoleAgent>(context, heapAgent.get());
78     auto debuggerAgent = std::make_unique<JSGlobalObjectDebuggerAgent>(context, consoleAgent.get());
79     auto scriptProfilerAgent = std::make_unique<InspectorScriptProfilerAgent>(context);
80
81     m_inspectorAgent = inspectorAgent.get();
82     m_debuggerAgent = debuggerAgent.get();
83     m_consoleAgent = consoleAgent.get();
84     m_consoleClient = std::make_unique<JSGlobalObjectConsoleClient>(m_consoleAgent, m_debuggerAgent, scriptProfilerAgent.get());
85
86     m_agents.append(WTFMove(inspectorAgent));
87     m_agents.append(WTFMove(runtimeAgent));
88     m_agents.append(WTFMove(consoleAgent));
89     m_agents.append(WTFMove(debuggerAgent));
90     m_agents.append(WTFMove(heapAgent));
91     m_agents.append(WTFMove(scriptProfilerAgent));
92
93     m_executionStopwatch->start();
94 }
95
96 JSGlobalObjectInspectorController::~JSGlobalObjectInspectorController()
97 {
98 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
99     if (m_augmentingClient)
100         m_augmentingClient->inspectorControllerDestroyed();
101 #endif
102 }
103
104 void JSGlobalObjectInspectorController::globalObjectDestroyed()
105 {
106     ASSERT(!m_frontendRouter->hasFrontends());
107
108     m_injectedScriptManager->disconnect();
109
110     m_agents.discardValues();
111 }
112
113 void JSGlobalObjectInspectorController::connectFrontend(FrontendChannel& frontendChannel, bool isAutomaticInspection, bool immediatelyPause)
114 {
115     m_isAutomaticInspection = isAutomaticInspection;
116     m_pauseAfterInitialization = immediatelyPause;
117
118     createLazyAgents();
119
120     bool connectedFirstFrontend = !m_frontendRouter->hasFrontends();
121     m_frontendRouter->connectFrontend(frontendChannel);
122
123     if (!connectedFirstFrontend)
124         return;
125
126     // Keep the JSGlobalObject and VM alive while we are debugging it.
127     m_strongVM = &m_globalObject.vm();
128     m_strongGlobalObject.set(m_globalObject.vm(), &m_globalObject);
129
130     // FIXME: change this to notify agents which frontend has connected (by id).
131     m_agents.didCreateFrontendAndBackend(nullptr, nullptr);
132
133 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
134     m_inspectorAgent->activateExtraDomains(m_agents.extraDomains());
135
136     if (m_augmentingClient)
137         m_augmentingClient->inspectorConnected();
138 #endif
139 }
140
141 void JSGlobalObjectInspectorController::disconnectFrontend(FrontendChannel& frontendChannel)
142 {
143     // FIXME: change this to notify agents which frontend has disconnected (by id).
144     m_agents.willDestroyFrontendAndBackend(DisconnectReason::InspectorDestroyed);
145
146     m_frontendRouter->disconnectFrontend(frontendChannel);
147
148     m_isAutomaticInspection = false;
149     m_pauseAfterInitialization = false;
150
151     bool disconnectedLastFrontend = !m_frontendRouter->hasFrontends();
152     if (!disconnectedLastFrontend)
153         return;
154
155 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
156     if (m_augmentingClient)
157         m_augmentingClient->inspectorDisconnected();
158 #endif
159
160     // Remove our JSGlobalObject and VM references, we are done debugging it.
161     m_strongGlobalObject.clear();
162     m_strongVM = nullptr;
163 }
164
165 void JSGlobalObjectInspectorController::dispatchMessageFromFrontend(const String& message)
166 {
167     m_backendDispatcher->dispatch(message);
168 }
169
170 void JSGlobalObjectInspectorController::appendAPIBacktrace(ScriptCallStack& callStack)
171 {
172     static const int framesToShow = 31;
173     static const int framesToSkip = 3; // WTFGetBacktrace, appendAPIBacktrace, reportAPIException.
174
175     void* samples[framesToShow + framesToSkip];
176     int frames = framesToShow + framesToSkip;
177     WTFGetBacktrace(samples, &frames);
178
179     void** stack = samples + framesToSkip;
180     int size = frames - framesToSkip;
181     for (int i = 0; i < size; ++i) {
182         auto demangled = StackTrace::demangle(stack[i]);
183         if (demangled)
184             callStack.append(ScriptCallFrame(demangled->demangledName() ? demangled->demangledName() : demangled->mangledName(), "[native code]"_s, noSourceID, 0, 0));
185         else
186             callStack.append(ScriptCallFrame("?"_s, "[native code]"_s, noSourceID, 0, 0));
187     }
188 }
189
190 void JSGlobalObjectInspectorController::reportAPIException(ExecState* exec, Exception* exception)
191 {
192     VM& vm = exec->vm();
193     if (isTerminatedExecutionException(vm, exception))
194         return;
195
196     auto scope = DECLARE_CATCH_SCOPE(vm);
197     ErrorHandlingScope errorScope(vm);
198
199     Ref<ScriptCallStack> callStack = createScriptCallStackFromException(exec, exception);
200     if (includesNativeCallStackWhenReportingExceptions())
201         appendAPIBacktrace(callStack.get());
202
203     // FIXME: <http://webkit.org/b/115087> Web Inspector: Should not evaluate JavaScript handling exceptions
204     // If this is a custom exception object, call toString on it to try and get a nice string representation for the exception.
205     String errorMessage = exception->value().toWTFString(exec);
206     scope.clearException();
207
208     if (JSGlobalObjectConsoleClient::logToSystemConsole()) {
209         if (callStack->size()) {
210             const ScriptCallFrame& callFrame = callStack->at(0);
211             ConsoleClient::printConsoleMessage(MessageSource::JS, MessageType::Log, MessageLevel::Error, errorMessage, callFrame.sourceURL(), callFrame.lineNumber(), callFrame.columnNumber());
212         } else
213             ConsoleClient::printConsoleMessage(MessageSource::JS, MessageType::Log, MessageLevel::Error, errorMessage, String(), 0, 0);
214     }
215
216     m_consoleAgent->addMessageToConsole(std::make_unique<ConsoleMessage>(MessageSource::JS, MessageType::Log, MessageLevel::Error, errorMessage, WTFMove(callStack)));
217 }
218
219 ConsoleClient* JSGlobalObjectInspectorController::consoleClient() const
220 {
221     return m_consoleClient.get();
222 }
223
224 bool JSGlobalObjectInspectorController::developerExtrasEnabled() const
225 {
226 #if ENABLE(REMOTE_INSPECTOR)
227     if (!RemoteInspector::singleton().enabled())
228         return false;
229
230     if (!m_globalObject.inspectorDebuggable().remoteDebuggingAllowed())
231         return false;
232 #endif
233
234     return true;
235 }
236
237 InspectorFunctionCallHandler JSGlobalObjectInspectorController::functionCallHandler() const
238 {
239     return JSC::call;
240 }
241
242 InspectorEvaluateHandler JSGlobalObjectInspectorController::evaluateHandler() const
243 {
244     return JSC::evaluate;
245 }
246
247 void JSGlobalObjectInspectorController::frontendInitialized()
248 {
249     if (m_pauseAfterInitialization) {
250         m_pauseAfterInitialization = false;
251         ErrorString ignored;
252         m_debuggerAgent->enable(ignored);
253         m_debuggerAgent->pause(ignored);
254     }
255
256 #if ENABLE(REMOTE_INSPECTOR)
257     if (m_isAutomaticInspection)
258         m_globalObject.inspectorDebuggable().unpauseForInitializedInspector();
259 #endif
260 }
261
262 Ref<Stopwatch> JSGlobalObjectInspectorController::executionStopwatch()
263 {
264     return m_executionStopwatch.copyRef();
265 }
266
267 JSGlobalObjectScriptDebugServer& JSGlobalObjectInspectorController::scriptDebugServer()
268 {
269     return m_scriptDebugServer;
270 }
271
272 VM& JSGlobalObjectInspectorController::vm()
273 {
274     return m_globalObject.vm();
275 }
276
277 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
278 void JSGlobalObjectInspectorController::appendExtraAgent(std::unique_ptr<InspectorAgentBase> agent)
279 {
280     String domainName = agent->domainName();
281
282     // FIXME: change this to notify agents which frontend has connected (by id).
283     agent->didCreateFrontendAndBackend(nullptr, nullptr);
284
285     m_agents.appendExtraAgent(WTFMove(agent));
286
287     m_inspectorAgent->activateExtraDomain(domainName);
288 }
289 #endif
290
291 JSAgentContext JSGlobalObjectInspectorController::jsAgentContext()
292 {
293     AgentContext baseContext = {
294         *this,
295         *m_injectedScriptManager,
296         m_frontendRouter.get(),
297         m_backendDispatcher.get()
298     };
299
300     JSAgentContext context = {
301         baseContext,
302         m_globalObject
303     };
304
305     return context;
306 }
307
308 void JSGlobalObjectInspectorController::createLazyAgents()
309 {
310     if (m_didCreateLazyAgents)
311         return;
312
313     m_didCreateLazyAgents = true;
314
315     auto context = jsAgentContext();
316
317     m_agents.append(std::make_unique<JSGlobalObjectAuditAgent>(context));
318 }
319
320 } // namespace Inspector