AbstractModuleRecord.cpp [plain text]
#include "config.h"
#include "AbstractModuleRecord.h"
#include "Error.h"
#include "Interpreter.h"
#include "JSCInlines.h"
#include "JSMap.h"
#include "JSModuleEnvironment.h"
#include "JSModuleNamespaceObject.h"
#include "JSModuleRecord.h"
#include "UnlinkedModuleProgramCodeBlock.h"
#include "WebAssemblyModuleRecord.h"
namespace JSC {
namespace AbstractModuleRecordInternal {
static const bool verbose = false;
}
const ClassInfo AbstractModuleRecord::s_info = { "AbstractModuleRecord", &Base::s_info, nullptr, nullptr, CREATE_METHOD_TABLE(AbstractModuleRecord) };
AbstractModuleRecord::AbstractModuleRecord(VM& vm, Structure* structure, const Identifier& moduleKey)
: Base(vm, structure)
, m_moduleKey(moduleKey)
{
}
void AbstractModuleRecord::destroy(JSCell* cell)
{
AbstractModuleRecord* thisObject = static_cast<AbstractModuleRecord*>(cell);
thisObject->AbstractModuleRecord::~AbstractModuleRecord();
}
void AbstractModuleRecord::finishCreation(ExecState* exec, VM& vm)
{
Base::finishCreation(vm);
ASSERT(inherits(vm, info()));
auto scope = DECLARE_THROW_SCOPE(vm);
JSMap* map = JSMap::create(exec, vm, globalObject(vm)->mapStructure());
scope.releaseAssertNoException();
m_dependenciesMap.set(vm, this, map);
putDirect(vm, Identifier::fromString(&vm, "dependenciesMap"_s), m_dependenciesMap.get());
}
void AbstractModuleRecord::visitChildren(JSCell* cell, SlotVisitor& visitor)
{
AbstractModuleRecord* thisObject = jsCast<AbstractModuleRecord*>(cell);
Base::visitChildren(thisObject, visitor);
visitor.append(thisObject->m_moduleEnvironment);
visitor.append(thisObject->m_moduleNamespaceObject);
visitor.append(thisObject->m_dependenciesMap);
}
void AbstractModuleRecord::appendRequestedModule(const Identifier& moduleName)
{
m_requestedModules.add(moduleName.impl());
}
void AbstractModuleRecord::addStarExportEntry(const Identifier& moduleName)
{
m_starExportEntries.add(moduleName.impl());
}
void AbstractModuleRecord::addImportEntry(const ImportEntry& entry)
{
bool isNewEntry = m_importEntries.add(entry.localName.impl(), entry).isNewEntry;
ASSERT_UNUSED(isNewEntry, isNewEntry); }
void AbstractModuleRecord::addExportEntry(const ExportEntry& entry)
{
bool isNewEntry = m_exportEntries.add(entry.exportName.impl(), entry).isNewEntry;
ASSERT_UNUSED(isNewEntry, isNewEntry); }
auto AbstractModuleRecord::tryGetImportEntry(UniquedStringImpl* localName) -> Optional<ImportEntry>
{
const auto iterator = m_importEntries.find(localName);
if (iterator == m_importEntries.end())
return WTF::nullopt;
return Optional<ImportEntry>(iterator->value);
}
auto AbstractModuleRecord::tryGetExportEntry(UniquedStringImpl* exportName) -> Optional<ExportEntry>
{
const auto iterator = m_exportEntries.find(exportName);
if (iterator == m_exportEntries.end())
return WTF::nullopt;
return Optional<ExportEntry>(iterator->value);
}
auto AbstractModuleRecord::ExportEntry::createLocal(const Identifier& exportName, const Identifier& localName) -> ExportEntry
{
return ExportEntry { Type::Local, exportName, Identifier(), Identifier(), localName };
}
auto AbstractModuleRecord::ExportEntry::createIndirect(const Identifier& exportName, const Identifier& importName, const Identifier& moduleName) -> ExportEntry
{
return ExportEntry { Type::Indirect, exportName, moduleName, importName, Identifier() };
}
auto AbstractModuleRecord::Resolution::notFound() -> Resolution
{
return Resolution { Type::NotFound, nullptr, Identifier() };
}
auto AbstractModuleRecord::Resolution::error() -> Resolution
{
return Resolution { Type::Error, nullptr, Identifier() };
}
auto AbstractModuleRecord::Resolution::ambiguous() -> Resolution
{
return Resolution { Type::Ambiguous, nullptr, Identifier() };
}
AbstractModuleRecord* AbstractModuleRecord::hostResolveImportedModule(ExecState* exec, const Identifier& moduleName)
{
VM& vm = exec->vm();
auto scope = DECLARE_THROW_SCOPE(vm);
JSValue moduleNameValue = identifierToJSValue(vm, moduleName);
JSValue entry = m_dependenciesMap->JSMap::get(exec, moduleNameValue);
RETURN_IF_EXCEPTION(scope, nullptr);
RELEASE_AND_RETURN(scope, jsCast<AbstractModuleRecord*>(entry.get(exec, Identifier::fromString(exec, "module"))));
}
auto AbstractModuleRecord::resolveImport(ExecState* exec, const Identifier& localName) -> Resolution
{
VM& vm = exec->vm();
auto scope = DECLARE_THROW_SCOPE(vm);
Optional<ImportEntry> optionalImportEntry = tryGetImportEntry(localName.impl());
if (!optionalImportEntry)
return Resolution::notFound();
const ImportEntry& importEntry = *optionalImportEntry;
if (importEntry.type == AbstractModuleRecord::ImportEntryType::Namespace)
return Resolution::notFound();
AbstractModuleRecord* importedModule = hostResolveImportedModule(exec, importEntry.moduleRequest);
RETURN_IF_EXCEPTION(scope, Resolution::error());
return importedModule->resolveExport(exec, importEntry.importName);
}
struct AbstractModuleRecord::ResolveQuery {
struct Hash {
static unsigned hash(const ResolveQuery&);
static bool equal(const ResolveQuery&, const ResolveQuery&);
static const bool safeToCompareToEmptyOrDeleted = true;
};
using HashTraits = WTF::CustomHashTraits<ResolveQuery>;
ResolveQuery(AbstractModuleRecord* moduleRecord, UniquedStringImpl* exportName)
: moduleRecord(moduleRecord)
, exportName(exportName)
{
}
ResolveQuery(AbstractModuleRecord* moduleRecord, const Identifier& exportName)
: ResolveQuery(moduleRecord, exportName.impl())
{
}
enum EmptyValueTag { EmptyValue };
ResolveQuery(EmptyValueTag)
{
}
enum DeletedValueTag { DeletedValue };
ResolveQuery(DeletedValueTag)
: moduleRecord(nullptr)
, exportName(WTF::HashTableDeletedValue)
{
}
bool isEmptyValue() const
{
return !exportName;
}
bool isDeletedValue() const
{
return exportName.isHashTableDeletedValue();
}
void dump(PrintStream& out) const
{
if (!moduleRecord) {
out.print("<empty>");
return;
}
out.print(moduleRecord->moduleKey(), " \"", exportName.get(), "\"");
}
AbstractModuleRecord* moduleRecord;
RefPtr<UniquedStringImpl> exportName;
};
inline unsigned AbstractModuleRecord::ResolveQuery::Hash::hash(const ResolveQuery& query)
{
return WTF::PtrHash<AbstractModuleRecord*>::hash(query.moduleRecord) + IdentifierRepHash::hash(query.exportName);
}
inline bool AbstractModuleRecord::ResolveQuery::Hash::equal(const ResolveQuery& lhs, const ResolveQuery& rhs)
{
return lhs.moduleRecord == rhs.moduleRecord && lhs.exportName == rhs.exportName;
}
auto AbstractModuleRecord::tryGetCachedResolution(UniquedStringImpl* exportName) -> Optional<Resolution>
{
const auto iterator = m_resolutionCache.find(exportName);
if (iterator == m_resolutionCache.end())
return WTF::nullopt;
return Optional<Resolution>(iterator->value);
}
void AbstractModuleRecord::cacheResolution(UniquedStringImpl* exportName, const Resolution& resolution)
{
m_resolutionCache.add(exportName, resolution);
}
auto AbstractModuleRecord::resolveExportImpl(ExecState* exec, const ResolveQuery& root) -> Resolution
{
VM& vm = exec->vm();
auto scope = DECLARE_THROW_SCOPE(vm);
if (AbstractModuleRecordInternal::verbose)
dataLog("Resolving ", root, "\n");
using ResolveSet = WTF::HashSet<ResolveQuery, ResolveQuery::Hash, ResolveQuery::HashTraits>;
enum class Type { Query, IndirectFallback, GatherStars };
struct Task {
ResolveQuery query;
Type type;
};
auto typeString = [] (Type type) -> const char* {
switch (type) {
case Type::Query:
return "Query";
case Type::IndirectFallback:
return "IndirectFallback";
case Type::GatherStars:
return "GatherStars";
}
RELEASE_ASSERT_NOT_REACHED();
return nullptr;
};
Vector<Task, 8> pendingTasks;
ResolveSet resolveSet;
Vector<Resolution, 8> frames;
bool foundStarLinks = false;
frames.append(Resolution::notFound());
auto resolveNonLocal = [&](const ResolveQuery& query) -> bool {
VM& vm = exec->vm();
auto scope = DECLARE_THROW_SCOPE(vm);
if (query.exportName == vm.propertyNames->defaultKeyword.impl())
return false;
pendingTasks.append(Task { query, Type::GatherStars });
foundStarLinks = true;
frames.append(Resolution::notFound());
for (auto iterator = query.moduleRecord->starExportEntries().rbegin(), end = query.moduleRecord->starExportEntries().rend(); iterator != end; ++iterator) {
const RefPtr<UniquedStringImpl>& starModuleName = *iterator;
AbstractModuleRecord* importedModuleRecord = query.moduleRecord->hostResolveImportedModule(exec, Identifier::fromUid(exec, starModuleName.get()));
RETURN_IF_EXCEPTION(scope, false);
pendingTasks.append(Task { ResolveQuery(importedModuleRecord, query.exportName.get()), Type::Query });
}
return true;
};
auto currentTop = [&] () -> Resolution& {
ASSERT(!frames.isEmpty());
return frames.last();
};
auto mergeToCurrentTop = [&] (const Resolution& resolution) -> bool {
if (resolution.type == Resolution::Type::NotFound)
return true;
if (currentTop().type == Resolution::Type::NotFound) {
currentTop() = resolution;
return true;
}
if (currentTop().moduleRecord != resolution.moduleRecord || currentTop().localName != resolution.localName)
return false;
return true;
};
auto cacheResolutionForQuery = [] (const ResolveQuery& query, const Resolution& resolution) {
ASSERT(resolution.type == Resolution::Type::Resolved);
query.moduleRecord->cacheResolution(query.exportName.get(), resolution);
};
pendingTasks.append(Task { root, Type::Query });
while (!pendingTasks.isEmpty()) {
const Task task = pendingTasks.takeLast();
const ResolveQuery& query = task.query;
if (AbstractModuleRecordInternal::verbose)
dataLog(" ", typeString(task.type), " ", task.query, "\n");
switch (task.type) {
case Type::Query: {
AbstractModuleRecord* moduleRecord = query.moduleRecord;
if (!resolveSet.add(task.query).isNewEntry)
continue;
if (!moduleRecord->starExportEntries().isEmpty())
foundStarLinks = true;
if (!foundStarLinks) {
if (Optional<Resolution> cachedResolution = moduleRecord->tryGetCachedResolution(query.exportName.get())) {
if (!mergeToCurrentTop(*cachedResolution))
return Resolution::ambiguous();
continue;
}
}
const Optional<ExportEntry> optionalExportEntry = moduleRecord->tryGetExportEntry(query.exportName.get());
if (!optionalExportEntry) {
bool success = resolveNonLocal(task.query);
EXCEPTION_ASSERT(!scope.exception() || !success);
if (!success)
return Resolution::error();
continue;
}
const ExportEntry& exportEntry = *optionalExportEntry;
switch (exportEntry.type) {
case ExportEntry::Type::Local: {
ASSERT(!exportEntry.localName.isNull());
Resolution resolution { Resolution::Type::Resolved, moduleRecord, exportEntry.localName };
cacheResolutionForQuery(query, resolution);
if (!mergeToCurrentTop(resolution))
return Resolution::ambiguous();
continue;
}
case ExportEntry::Type::Indirect: {
AbstractModuleRecord* importedModuleRecord = moduleRecord->hostResolveImportedModule(exec, exportEntry.moduleName);
RETURN_IF_EXCEPTION(scope, Resolution::error());
pendingTasks.append(Task { query, Type::IndirectFallback });
frames.append(Resolution::notFound());
pendingTasks.append(Task { ResolveQuery(importedModuleRecord, exportEntry.importName), Type::Query });
continue;
}
}
break;
}
case Type::IndirectFallback: {
Resolution resolution = frames.takeLast();
if (resolution.type == Resolution::Type::NotFound) {
bool success = resolveNonLocal(task.query);
EXCEPTION_ASSERT(!scope.exception() || !success);
if (!success)
return Resolution::error();
continue;
}
ASSERT_WITH_MESSAGE(resolution.type == Resolution::Type::Resolved, "When we see Error and Ambiguous, we immediately return from this loop. So here, only Resolved comes.");
if (!foundStarLinks)
cacheResolutionForQuery(query, resolution);
if (!mergeToCurrentTop(resolution))
return Resolution::ambiguous();
break;
}
case Type::GatherStars: {
Resolution resolution = frames.takeLast();
ASSERT_WITH_MESSAGE(resolution.type == Resolution::Type::Resolved || resolution.type == Resolution::Type::NotFound, "When we see Error and Ambiguous, we immediately return from this loop. So here, only Resolved and NotFound comes.");
if (!mergeToCurrentTop(resolution))
return Resolution::ambiguous();
break;
}
}
}
ASSERT(frames.size() == 1);
if (frames[0].type == Resolution::Type::Resolved)
cacheResolutionForQuery(root, frames[0]);
return frames[0];
}
auto AbstractModuleRecord::resolveExport(ExecState* exec, const Identifier& exportName) -> Resolution
{
if (Optional<Resolution> cachedResolution = tryGetCachedResolution(exportName.impl()))
return *cachedResolution;
return resolveExportImpl(exec, ResolveQuery(this, exportName.impl()));
}
static void getExportedNames(ExecState* exec, AbstractModuleRecord* root, IdentifierSet& exportedNames)
{
VM& vm = exec->vm();
auto scope = DECLARE_THROW_SCOPE(vm);
HashSet<AbstractModuleRecord*> exportStarSet;
Vector<AbstractModuleRecord*, 8> pendingModules;
pendingModules.append(root);
while (!pendingModules.isEmpty()) {
AbstractModuleRecord* moduleRecord = pendingModules.takeLast();
if (exportStarSet.contains(moduleRecord))
continue;
exportStarSet.add(moduleRecord);
for (const auto& pair : moduleRecord->exportEntries()) {
const AbstractModuleRecord::ExportEntry& exportEntry = pair.value;
if (moduleRecord == root || vm.propertyNames->defaultKeyword != exportEntry.exportName)
exportedNames.add(exportEntry.exportName.impl());
}
for (const auto& starModuleName : moduleRecord->starExportEntries()) {
AbstractModuleRecord* requestedModuleRecord = moduleRecord->hostResolveImportedModule(exec, Identifier::fromUid(exec, starModuleName.get()));
RETURN_IF_EXCEPTION(scope, void());
pendingModules.append(requestedModuleRecord);
}
}
}
JSModuleNamespaceObject* AbstractModuleRecord::getModuleNamespace(ExecState* exec)
{
VM& vm = exec->vm();
auto scope = DECLARE_THROW_SCOPE(vm);
if (m_moduleNamespaceObject)
return m_moduleNamespaceObject.get();
JSGlobalObject* globalObject = exec->lexicalGlobalObject();
IdentifierSet exportedNames;
getExportedNames(exec, this, exportedNames);
RETURN_IF_EXCEPTION(scope, nullptr);
Vector<std::pair<Identifier, Resolution>> resolutions;
for (auto& name : exportedNames) {
Identifier ident = Identifier::fromUid(exec, name.get());
const Resolution resolution = resolveExport(exec, ident);
RETURN_IF_EXCEPTION(scope, nullptr);
switch (resolution.type) {
case Resolution::Type::NotFound:
throwSyntaxError(exec, scope, makeString("Exported binding name '", String(name.get()), "' is not found."));
return nullptr;
case Resolution::Type::Error:
throwSyntaxError(exec, scope, makeString("Exported binding name 'default' cannot be resolved by star export entries."));
return nullptr;
case Resolution::Type::Ambiguous:
break;
case Resolution::Type::Resolved:
resolutions.append({ WTFMove(ident), resolution });
break;
}
}
auto* moduleNamespaceObject = JSModuleNamespaceObject::create(exec, globalObject, globalObject->moduleNamespaceObjectStructure(), this, WTFMove(resolutions));
RETURN_IF_EXCEPTION(scope, nullptr);
m_moduleNamespaceObject.set(vm, this, moduleNamespaceObject);
return moduleNamespaceObject;
}
void AbstractModuleRecord::link(ExecState* exec, JSValue scriptFetcher)
{
VM& vm = exec->vm();
if (auto* jsModuleRecord = jsDynamicCast<JSModuleRecord*>(vm, this))
return jsModuleRecord->link(exec, scriptFetcher);
#if ENABLE(WEBASSEMBLY)
if (auto* wasmModuleRecord = jsDynamicCast<WebAssemblyModuleRecord*>(vm, this))
return wasmModuleRecord->link(exec, scriptFetcher, nullptr, Wasm::CreationMode::FromModuleLoader);
#endif
RELEASE_ASSERT_NOT_REACHED();
}
JS_EXPORT_PRIVATE JSValue AbstractModuleRecord::evaluate(ExecState* exec)
{
VM& vm = exec->vm();
if (auto* jsModuleRecord = jsDynamicCast<JSModuleRecord*>(vm, this))
return jsModuleRecord->evaluate(exec);
#if ENABLE(WEBASSEMBLY)
if (auto* wasmModuleRecord = jsDynamicCast<WebAssemblyModuleRecord*>(vm, this))
return wasmModuleRecord->evaluate(exec);
#endif
RELEASE_ASSERT_NOT_REACHED();
return jsUndefined();
}
static String printableName(const RefPtr<UniquedStringImpl>& uid)
{
if (uid->isSymbol())
return uid.get();
return WTF::makeString("'", String(uid.get()), "'");
}
static String printableName(const Identifier& ident)
{
return printableName(ident.impl());
}
void AbstractModuleRecord::dump()
{
dataLog("\nAnalyzing ModuleRecord key(", printableName(m_moduleKey), ")\n");
dataLog(" Dependencies: ", m_requestedModules.size(), " modules\n");
for (const auto& moduleName : m_requestedModules)
dataLog(" module(", printableName(moduleName), ")\n");
dataLog(" Import: ", m_importEntries.size(), " entries\n");
for (const auto& pair : m_importEntries) {
const ImportEntry& importEntry = pair.value;
dataLog(" import(", printableName(importEntry.importName), "), local(", printableName(importEntry.localName), "), module(", printableName(importEntry.moduleRequest), ")\n");
}
dataLog(" Export: ", m_exportEntries.size(), " entries\n");
for (const auto& pair : m_exportEntries) {
const ExportEntry& exportEntry = pair.value;
switch (exportEntry.type) {
case ExportEntry::Type::Local:
dataLog(" [Local] ", "export(", printableName(exportEntry.exportName), "), local(", printableName(exportEntry.localName), ")\n");
break;
case ExportEntry::Type::Indirect:
dataLog(" [Indirect] ", "export(", printableName(exportEntry.exportName), "), import(", printableName(exportEntry.importName), "), module(", printableName(exportEntry.moduleName), ")\n");
break;
}
}
for (const auto& moduleName : m_starExportEntries)
dataLog(" [Star] module(", printableName(moduleName.get()), ")\n");
}
}