InspectorRuntimeAgent.cpp [plain text]
#include "config.h"
#include "InspectorRuntimeAgent.h"
#include "Completion.h"
#include "DFGWorklist.h"
#include "HeapIterationScope.h"
#include "InjectedScript.h"
#include "InjectedScriptManager.h"
#include "InspectorFrontendRouter.h"
#include "JSLock.h"
#include "ParserError.h"
#include "ScriptDebugServer.h"
#include "SourceCode.h"
#include "TypeProfiler.h"
#include "TypeProfilerLog.h"
#include <wtf/CurrentTime.h>
#include <wtf/JSONValues.h>
using namespace JSC;
namespace Inspector {
static bool asBool(const bool* const b)
{
return b ? *b : false;
}
InspectorRuntimeAgent::InspectorRuntimeAgent(AgentContext& context)
: InspectorAgentBase(ASCIILiteral("Runtime"))
, m_injectedScriptManager(context.injectedScriptManager)
, m_scriptDebugServer(context.environment.scriptDebugServer())
, m_vm(context.environment.vm())
{
}
InspectorRuntimeAgent::~InspectorRuntimeAgent()
{
}
static ScriptDebugServer::PauseOnExceptionsState setPauseOnExceptionsState(ScriptDebugServer& scriptDebugServer, ScriptDebugServer::PauseOnExceptionsState newState)
{
ScriptDebugServer::PauseOnExceptionsState presentState = scriptDebugServer.pauseOnExceptionsState();
if (presentState != newState)
scriptDebugServer.setPauseOnExceptionsState(newState);
return presentState;
}
static Ref<Inspector::Protocol::Runtime::ErrorRange> buildErrorRangeObject(const JSTokenLocation& tokenLocation)
{
return Inspector::Protocol::Runtime::ErrorRange::create()
.setStartOffset(tokenLocation.startOffset)
.setEndOffset(tokenLocation.endOffset)
.release();
}
void InspectorRuntimeAgent::parse(ErrorString&, const String& expression, Inspector::Protocol::Runtime::SyntaxErrorType* result, Inspector::Protocol::OptOutput<String>* message, RefPtr<Inspector::Protocol::Runtime::ErrorRange>& range)
{
JSLockHolder lock(m_vm);
ParserError error;
checkSyntax(m_vm, JSC::makeSource(expression, { }), error);
switch (error.syntaxErrorType()) {
case ParserError::SyntaxErrorNone:
*result = Inspector::Protocol::Runtime::SyntaxErrorType::None;
break;
case ParserError::SyntaxErrorIrrecoverable:
*result = Inspector::Protocol::Runtime::SyntaxErrorType::Irrecoverable;
break;
case ParserError::SyntaxErrorUnterminatedLiteral:
*result = Inspector::Protocol::Runtime::SyntaxErrorType::UnterminatedLiteral;
break;
case ParserError::SyntaxErrorRecoverable:
*result = Inspector::Protocol::Runtime::SyntaxErrorType::Recoverable;
break;
}
if (error.syntaxErrorType() != ParserError::SyntaxErrorNone) {
*message = error.message();
range = buildErrorRangeObject(error.token().m_location);
}
}
void InspectorRuntimeAgent::evaluate(ErrorString& errorString, const String& expression, const String* const objectGroup, const bool* const includeCommandLineAPI, const bool* const doNotPauseOnExceptionsAndMuteConsole, const int* executionContextId, const bool* const returnByValue, const bool* generatePreview, const bool* saveResult, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result, Inspector::Protocol::OptOutput<bool>* out_wasThrown, Inspector::Protocol::OptOutput<int>* out_savedResultIndex)
{
InjectedScript injectedScript = injectedScriptForEval(errorString, executionContextId);
if (injectedScript.hasNoValue())
return;
ScriptDebugServer::PauseOnExceptionsState previousPauseOnExceptionsState = ScriptDebugServer::DontPauseOnExceptions;
if (asBool(doNotPauseOnExceptionsAndMuteConsole))
previousPauseOnExceptionsState = setPauseOnExceptionsState(m_scriptDebugServer, ScriptDebugServer::DontPauseOnExceptions);
if (asBool(doNotPauseOnExceptionsAndMuteConsole))
muteConsole();
bool wasThrown;
std::optional<int> savedResultIndex;
injectedScript.evaluate(errorString, expression, objectGroup ? *objectGroup : String(), asBool(includeCommandLineAPI), asBool(returnByValue), asBool(generatePreview), asBool(saveResult), result, wasThrown, savedResultIndex);
*out_wasThrown = wasThrown;
if (savedResultIndex.has_value())
*out_savedResultIndex = savedResultIndex.value();
if (asBool(doNotPauseOnExceptionsAndMuteConsole)) {
unmuteConsole();
setPauseOnExceptionsState(m_scriptDebugServer, previousPauseOnExceptionsState);
}
}
void InspectorRuntimeAgent::callFunctionOn(ErrorString& errorString, const String& objectId, const String& expression, const JSON::Array* optionalArguments, const bool* const doNotPauseOnExceptionsAndMuteConsole, const bool* const returnByValue, const bool* generatePreview, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result, Inspector::Protocol::OptOutput<bool>* out_wasThrown)
{
InjectedScript injectedScript = m_injectedScriptManager.injectedScriptForObjectId(objectId);
if (injectedScript.hasNoValue()) {
errorString = ASCIILiteral("Could not find InjectedScript for objectId");
return;
}
String arguments;
if (optionalArguments)
arguments = optionalArguments->toJSONString();
ScriptDebugServer::PauseOnExceptionsState previousPauseOnExceptionsState = ScriptDebugServer::DontPauseOnExceptions;
if (asBool(doNotPauseOnExceptionsAndMuteConsole))
previousPauseOnExceptionsState = setPauseOnExceptionsState(m_scriptDebugServer, ScriptDebugServer::DontPauseOnExceptions);
if (asBool(doNotPauseOnExceptionsAndMuteConsole))
muteConsole();
bool wasThrown;
injectedScript.callFunctionOn(errorString, objectId, expression, arguments, asBool(returnByValue), asBool(generatePreview), result, wasThrown);
*out_wasThrown = wasThrown;
if (asBool(doNotPauseOnExceptionsAndMuteConsole)) {
unmuteConsole();
setPauseOnExceptionsState(m_scriptDebugServer, previousPauseOnExceptionsState);
}
}
void InspectorRuntimeAgent::getPreview(ErrorString& errorString, const String& objectId, RefPtr<Inspector::Protocol::Runtime::ObjectPreview>& preview)
{
InjectedScript injectedScript = m_injectedScriptManager.injectedScriptForObjectId(objectId);
if (injectedScript.hasNoValue()) {
errorString = ASCIILiteral("Could not find InjectedScript for objectId");
return;
}
ScriptDebugServer::PauseOnExceptionsState previousPauseOnExceptionsState = setPauseOnExceptionsState(m_scriptDebugServer, ScriptDebugServer::DontPauseOnExceptions);
muteConsole();
injectedScript.getPreview(errorString, objectId, preview);
unmuteConsole();
setPauseOnExceptionsState(m_scriptDebugServer, previousPauseOnExceptionsState);
}
void InspectorRuntimeAgent::getProperties(ErrorString& errorString, const String& objectId, const bool* const ownProperties, const bool* const generatePreview, RefPtr<JSON::ArrayOf<Inspector::Protocol::Runtime::PropertyDescriptor>>& result, RefPtr<JSON::ArrayOf<Inspector::Protocol::Runtime::InternalPropertyDescriptor>>& internalProperties)
{
InjectedScript injectedScript = m_injectedScriptManager.injectedScriptForObjectId(objectId);
if (injectedScript.hasNoValue()) {
errorString = ASCIILiteral("Could not find InjectedScript for objectId");
return;
}
ScriptDebugServer::PauseOnExceptionsState previousPauseOnExceptionsState = setPauseOnExceptionsState(m_scriptDebugServer, ScriptDebugServer::DontPauseOnExceptions);
muteConsole();
injectedScript.getProperties(errorString, objectId, asBool(ownProperties), asBool(generatePreview), result);
injectedScript.getInternalProperties(errorString, objectId, asBool(generatePreview), internalProperties);
unmuteConsole();
setPauseOnExceptionsState(m_scriptDebugServer, previousPauseOnExceptionsState);
}
void InspectorRuntimeAgent::getDisplayableProperties(ErrorString& errorString, const String& objectId, const bool* const generatePreview, RefPtr<JSON::ArrayOf<Inspector::Protocol::Runtime::PropertyDescriptor>>& result, RefPtr<JSON::ArrayOf<Inspector::Protocol::Runtime::InternalPropertyDescriptor>>& internalProperties)
{
InjectedScript injectedScript = m_injectedScriptManager.injectedScriptForObjectId(objectId);
if (injectedScript.hasNoValue()) {
errorString = ASCIILiteral("Could not find InjectedScript for objectId");
return;
}
ScriptDebugServer::PauseOnExceptionsState previousPauseOnExceptionsState = setPauseOnExceptionsState(m_scriptDebugServer, ScriptDebugServer::DontPauseOnExceptions);
muteConsole();
injectedScript.getDisplayableProperties(errorString, objectId, asBool(generatePreview), result);
injectedScript.getInternalProperties(errorString, objectId, asBool(generatePreview), internalProperties);
unmuteConsole();
setPauseOnExceptionsState(m_scriptDebugServer, previousPauseOnExceptionsState);
}
void InspectorRuntimeAgent::getCollectionEntries(ErrorString& errorString, const String& objectId, const String* objectGroup, const int* startIndex, const int* numberToFetch, RefPtr<JSON::ArrayOf<Inspector::Protocol::Runtime::CollectionEntry>>& entries)
{
InjectedScript injectedScript = m_injectedScriptManager.injectedScriptForObjectId(objectId);
if (injectedScript.hasNoValue()) {
errorString = ASCIILiteral("Could not find InjectedScript for objectId");
return;
}
int start = startIndex && *startIndex >= 0 ? *startIndex : 0;
int fetch = numberToFetch && *numberToFetch >= 0 ? *numberToFetch : 0;
injectedScript.getCollectionEntries(errorString, objectId, objectGroup ? *objectGroup : String(), start, fetch, entries);
}
void InspectorRuntimeAgent::saveResult(ErrorString& errorString, const JSON::Object& callArgument, const int* executionContextId, Inspector::Protocol::OptOutput<int>* out_savedResultIndex)
{
InjectedScript injectedScript;
String objectId;
if (callArgument.getString(ASCIILiteral("objectId"), objectId)) {
injectedScript = m_injectedScriptManager.injectedScriptForObjectId(objectId);
if (injectedScript.hasNoValue()) {
errorString = ASCIILiteral("Could not find InjectedScript for objectId");
return;
}
} else {
injectedScript = injectedScriptForEval(errorString, executionContextId);
if (injectedScript.hasNoValue())
return;
}
std::optional<int> savedResultIndex;
injectedScript.saveResult(errorString, callArgument.toJSONString(), savedResultIndex);
if (savedResultIndex.has_value())
*out_savedResultIndex = savedResultIndex.value();
}
void InspectorRuntimeAgent::releaseObject(ErrorString&, const String& objectId)
{
InjectedScript injectedScript = m_injectedScriptManager.injectedScriptForObjectId(objectId);
if (!injectedScript.hasNoValue())
injectedScript.releaseObject(objectId);
}
void InspectorRuntimeAgent::releaseObjectGroup(ErrorString&, const String& objectGroup)
{
m_injectedScriptManager.releaseObjectGroup(objectGroup);
}
void InspectorRuntimeAgent::getRuntimeTypesForVariablesAtOffsets(ErrorString& errorString, const JSON::Array& locations, RefPtr<JSON::ArrayOf<Inspector::Protocol::Runtime::TypeDescription>>& typeDescriptions)
{
static const bool verbose = false;
typeDescriptions = JSON::ArrayOf<Inspector::Protocol::Runtime::TypeDescription>::create();
if (!m_vm.typeProfiler()) {
errorString = ASCIILiteral("The VM does not currently have Type Information.");
return;
}
double start = currentTimeMS();
m_vm.typeProfilerLog()->processLogEntries(ASCIILiteral("User Query"));
for (size_t i = 0; i < locations.length(); i++) {
RefPtr<JSON::Value> value = locations.get(i);
RefPtr<JSON::Object> location;
if (!value->asObject(location)) {
errorString = ASCIILiteral("Array of TypeLocation objects has an object that does not have type of TypeLocation.");
return;
}
int descriptor;
String sourceIDAsString;
int divot;
location->getInteger(ASCIILiteral("typeInformationDescriptor"), descriptor);
location->getString(ASCIILiteral("sourceID"), sourceIDAsString);
location->getInteger(ASCIILiteral("divot"), divot);
bool okay;
TypeLocation* typeLocation = m_vm.typeProfiler()->findLocation(divot, sourceIDAsString.toIntPtrStrict(&okay), static_cast<TypeProfilerSearchDescriptor>(descriptor), m_vm);
ASSERT(okay);
RefPtr<TypeSet> typeSet;
if (typeLocation) {
if (typeLocation->m_globalTypeSet && typeLocation->m_globalVariableID != TypeProfilerNoGlobalIDExists)
typeSet = typeLocation->m_globalTypeSet;
else
typeSet = typeLocation->m_instructionTypeSet;
}
bool isValid = typeLocation && typeSet && !typeSet->isEmpty();
auto description = Inspector::Protocol::Runtime::TypeDescription::create()
.setIsValid(isValid)
.release();
if (isValid) {
description->setLeastCommonAncestor(typeSet->leastCommonAncestor());
description->setStructures(typeSet->allStructureRepresentations());
description->setTypeSet(typeSet->inspectorTypeSet());
description->setIsTruncated(typeSet->isOverflown());
}
typeDescriptions->addItem(WTFMove(description));
}
double end = currentTimeMS();
if (verbose)
dataLogF("Inspector::getRuntimeTypesForVariablesAtOffsets took %lfms\n", end - start);
}
void InspectorRuntimeAgent::willDestroyFrontendAndBackend(DisconnectReason reason)
{
if (reason != DisconnectReason::InspectedTargetDestroyed && m_isTypeProfilingEnabled)
setTypeProfilerEnabledState(false);
}
void InspectorRuntimeAgent::enableTypeProfiler(ErrorString&)
{
setTypeProfilerEnabledState(true);
}
void InspectorRuntimeAgent::disableTypeProfiler(ErrorString&)
{
setTypeProfilerEnabledState(false);
}
void InspectorRuntimeAgent::enableControlFlowProfiler(ErrorString&)
{
setControlFlowProfilerEnabledState(true);
}
void InspectorRuntimeAgent::disableControlFlowProfiler(ErrorString&)
{
setControlFlowProfilerEnabledState(false);
}
void InspectorRuntimeAgent::setTypeProfilerEnabledState(bool isTypeProfilingEnabled)
{
if (m_isTypeProfilingEnabled == isTypeProfilingEnabled)
return;
m_isTypeProfilingEnabled = isTypeProfilingEnabled;
VM& vm = m_vm;
vm.whenIdle([&vm, isTypeProfilingEnabled] () {
bool shouldRecompileFromTypeProfiler = (isTypeProfilingEnabled ? vm.enableTypeProfiler() : vm.disableTypeProfiler());
if (shouldRecompileFromTypeProfiler)
vm.deleteAllCode(PreventCollectionAndDeleteAllCode);
});
}
void InspectorRuntimeAgent::setControlFlowProfilerEnabledState(bool isControlFlowProfilingEnabled)
{
if (m_isControlFlowProfilingEnabled == isControlFlowProfilingEnabled)
return;
m_isControlFlowProfilingEnabled = isControlFlowProfilingEnabled;
VM& vm = m_vm;
vm.whenIdle([&vm, isControlFlowProfilingEnabled] () {
bool shouldRecompileFromControlFlowProfiler = (isControlFlowProfilingEnabled ? vm.enableControlFlowProfiler() : vm.disableControlFlowProfiler());
if (shouldRecompileFromControlFlowProfiler)
vm.deleteAllCode(PreventCollectionAndDeleteAllCode);
});
}
void InspectorRuntimeAgent::getBasicBlocks(ErrorString& errorString, const String& sourceIDAsString, RefPtr<JSON::ArrayOf<Inspector::Protocol::Runtime::BasicBlock>>& basicBlocks)
{
if (!m_vm.controlFlowProfiler()) {
errorString = ASCIILiteral("The VM does not currently have a Control Flow Profiler.");
return;
}
bool okay;
intptr_t sourceID = sourceIDAsString.toIntPtrStrict(&okay);
ASSERT(okay);
const Vector<BasicBlockRange>& basicBlockRanges = m_vm.controlFlowProfiler()->getBasicBlocksForSourceID(sourceID, m_vm);
basicBlocks = JSON::ArrayOf<Inspector::Protocol::Runtime::BasicBlock>::create();
for (const BasicBlockRange& block : basicBlockRanges) {
Ref<Inspector::Protocol::Runtime::BasicBlock> location = Inspector::Protocol::Runtime::BasicBlock::create()
.setStartOffset(block.m_startOffset)
.setEndOffset(block.m_endOffset)
.setHasExecuted(block.m_hasExecuted)
.setExecutionCount(block.m_executionCount)
.release();
basicBlocks->addItem(WTFMove(location));
}
}
}