mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
253 lines
10 KiB
C++
253 lines
10 KiB
C++
//===--- ModuleDependencyScanner.cpp - Compute module dependencies --------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "swift/Serialization/SerializedModuleLoader.h"
|
|
#include "swift/AST/ASTContext.h"
|
|
#include "swift/AST/DiagnosticSuppression.h"
|
|
#include "swift/AST/ModuleDependencies.h"
|
|
#include "swift/AST/SourceFile.h"
|
|
#include "swift/Basic/FileTypes.h"
|
|
#include "swift/Subsystems.h"
|
|
using namespace swift;
|
|
using llvm::ErrorOr;
|
|
|
|
namespace {
|
|
|
|
/// A module "loader" that looks for .swiftinterface and .swiftmodule files
|
|
/// for the purpose of determining dependencies, but does not attempt to
|
|
/// load the module files.
|
|
class ModuleDependencyScanner : public SerializedModuleLoaderBase {
|
|
/// The module we're scanning dependencies of.
|
|
Identifier moduleName;
|
|
|
|
/// Scan the given interface file to determine dependencies.
|
|
ErrorOr<ModuleDependencies> scanInterfaceFile(
|
|
Twine moduleInterfacePath);
|
|
|
|
InterfaceSubContextDelegate &astDelegate;
|
|
public:
|
|
Optional<ModuleDependencies> dependencies;
|
|
|
|
/// Describes the kind of dependencies this scanner is able to identify
|
|
ModuleDependenciesKind dependencyKind;
|
|
|
|
ModuleDependencyScanner(
|
|
ASTContext &ctx, ModuleLoadingMode LoadMode, Identifier moduleName,
|
|
InterfaceSubContextDelegate &astDelegate,
|
|
ModuleDependenciesKind dependencyKind = ModuleDependenciesKind::Swift)
|
|
: SerializedModuleLoaderBase(ctx, nullptr, LoadMode,
|
|
/*IgnoreSwiftSourceInfoFile=*/true),
|
|
moduleName(moduleName), astDelegate(astDelegate),
|
|
dependencyKind(dependencyKind) {}
|
|
|
|
virtual std::error_code findModuleFilesInDirectory(
|
|
AccessPathElem ModuleID,
|
|
const SerializedModuleBaseName &BaseName,
|
|
SmallVectorImpl<char> *ModuleInterfacePath,
|
|
std::unique_ptr<llvm::MemoryBuffer> *ModuleBuffer,
|
|
std::unique_ptr<llvm::MemoryBuffer> *ModuleDocBuffer,
|
|
std::unique_ptr<llvm::MemoryBuffer> *ModuleSourceInfoBuffer) override {
|
|
using namespace llvm::sys;
|
|
|
|
auto &fs = *Ctx.SourceMgr.getFileSystem();
|
|
|
|
auto ModPath = BaseName.getName(file_types::TY_SwiftModuleFile);
|
|
auto InPath = BaseName.getName(file_types::TY_SwiftModuleInterfaceFile);
|
|
|
|
if (LoadMode == ModuleLoadingMode::OnlySerialized || !fs.exists(InPath)) {
|
|
if (fs.exists(ModPath)) {
|
|
// The module file will be loaded directly.
|
|
auto dependencies = scanModuleFile(ModPath);
|
|
if (dependencies) {
|
|
this->dependencies = std::move(dependencies.get());
|
|
return std::error_code();
|
|
}
|
|
return dependencies.getError();
|
|
} else {
|
|
return std::make_error_code(std::errc::no_such_file_or_directory);
|
|
}
|
|
}
|
|
assert(fs.exists(InPath));
|
|
auto dependencies = scanInterfaceFile(InPath);
|
|
if (dependencies) {
|
|
this->dependencies = std::move(dependencies.get());
|
|
return std::error_code();
|
|
}
|
|
|
|
return dependencies.getError();
|
|
}
|
|
|
|
virtual void collectVisibleTopLevelModuleNames(
|
|
SmallVectorImpl<Identifier> &names) const override {
|
|
llvm_unreachable("Not used");
|
|
}
|
|
};
|
|
|
|
/// A ModuleLoader that loads external dependency module stubs specified in
|
|
/// -external-dependency-module-map-file
|
|
/// This loader is used only in dependency scanning to inform the scanner that a
|
|
/// set of modules constitute external dependencies that are not visible to the
|
|
/// scanner but will nevertheless be provided by the scanner's clients.
|
|
/// This "loader" will not attempt to load any module files.
|
|
class ExternalSwiftModuleStubScanner : public ModuleDependencyScanner {
|
|
/// Scan the given external module map
|
|
void parseExternalModuleMap(StringRef fileName);
|
|
llvm::StringMap<ExplicitModuleInfo> ExternalDependencyModuleMap;
|
|
|
|
public:
|
|
ExternalSwiftModuleStubScanner(ASTContext &ctx, ModuleLoadingMode LoadMode,
|
|
Identifier moduleName,
|
|
StringRef ExternalDependencyModuleMap,
|
|
InterfaceSubContextDelegate &astDelegate)
|
|
: ModuleDependencyScanner(ctx, LoadMode, moduleName, astDelegate,
|
|
ModuleDependenciesKind::SwiftExternal) {
|
|
|
|
// FIXME: Find a better place for this map to live, to avoid
|
|
// doing the parsing on every module.
|
|
parseExternalModuleMap(ExternalDependencyModuleMap);
|
|
}
|
|
|
|
std::error_code findModuleFilesInDirectory(
|
|
AccessPathElem ModuleID, const SerializedModuleBaseName &BaseName,
|
|
SmallVectorImpl<char> *ModuleInterfacePath,
|
|
std::unique_ptr<llvm::MemoryBuffer> *ModuleBuffer,
|
|
std::unique_ptr<llvm::MemoryBuffer> *ModuleDocBuffer,
|
|
std::unique_ptr<llvm::MemoryBuffer> *ModuleSourceInfoBuffer) override {
|
|
StringRef moduleName = ModuleID.Item.str();
|
|
auto it = ExternalDependencyModuleMap.find(moduleName);
|
|
// If no external module stub path is given matches the name, return with an
|
|
// error code.
|
|
if (it == ExternalDependencyModuleMap.end()) {
|
|
return std::make_error_code(std::errc::not_supported);
|
|
}
|
|
auto &moduleInfo = it->getValue();
|
|
assert(!moduleInfo.moduleBuffer &&
|
|
"External dependency module stubs cannot have an associated buffer");
|
|
|
|
auto dependencies = ModuleDependencies::forExternalSwiftModuleStub(
|
|
moduleInfo.modulePath, moduleInfo.moduleDocPath,
|
|
moduleInfo.moduleSourceInfoPath);
|
|
this->dependencies = std::move(dependencies);
|
|
return std::error_code{};
|
|
}
|
|
|
|
public:
|
|
static std::unique_ptr<ExternalSwiftModuleStubScanner>
|
|
create(ASTContext &ctx, DependencyTracker *tracker,
|
|
ModuleLoadingMode loadMode, StringRef ExternalDependencyModuleMap,
|
|
bool IgnoreSwiftSourceInfoFile);
|
|
};
|
|
} // namespace
|
|
|
|
void ExternalSwiftModuleStubScanner::parseExternalModuleMap(StringRef fileName) {
|
|
ExplicitModuleMapParser parser(Ctx);
|
|
auto result =
|
|
parser.parseSwiftExplicitModuleMap(fileName, ExternalDependencyModuleMap);
|
|
if (result == std::errc::invalid_argument)
|
|
Ctx.Diags.diagnose(
|
|
SourceLoc(), diag::external_dependency_module_map_corrupted, fileName);
|
|
else if (result == std::errc::no_such_file_or_directory)
|
|
Ctx.Diags.diagnose(SourceLoc(),
|
|
diag::external_dependency_module_map_missing, fileName);
|
|
}
|
|
|
|
static std::vector<std::string> getCompiledCandidates(ASTContext &ctx,
|
|
StringRef moduleName,
|
|
StringRef interfacePath) {
|
|
return static_cast<SerializedModuleLoaderBase*>(ctx
|
|
.getModuleInterfaceLoader())->getCompiledModuleCandidatesForInterface(
|
|
moduleName.str(), interfacePath);
|
|
}
|
|
|
|
ErrorOr<ModuleDependencies> ModuleDependencyScanner::scanInterfaceFile(
|
|
Twine moduleInterfacePath) {
|
|
// Create a module filename.
|
|
// FIXME: Query the module interface loader to determine an appropriate
|
|
// name for the module, which includes an appropriate hash.
|
|
auto newExt = file_types::getExtension(file_types::TY_SwiftModuleFile);
|
|
llvm::SmallString<32> modulePath = moduleName.str();
|
|
llvm::sys::path::replace_extension(modulePath, newExt);
|
|
Optional<ModuleDependencies> Result;
|
|
std::error_code code;
|
|
auto hasError = astDelegate.runInSubContext(moduleName.str(),
|
|
moduleInterfacePath.str(),
|
|
StringRef(),
|
|
SourceLoc(),
|
|
[&](ASTContext &Ctx, ArrayRef<StringRef> Args,
|
|
ArrayRef<StringRef> PCMArgs, StringRef Hash) {
|
|
std::string InPath = moduleInterfacePath.str();
|
|
auto compiledCandidates = getCompiledCandidates(Ctx, moduleName.str(),
|
|
InPath);
|
|
Result = ModuleDependencies::forSwiftInterface(InPath,
|
|
compiledCandidates,
|
|
Args,
|
|
PCMArgs,
|
|
Hash);
|
|
// Open the interface file.
|
|
auto &fs = *Ctx.SourceMgr.getFileSystem();
|
|
auto interfaceBuf = fs.getBufferForFile(moduleInterfacePath);
|
|
if (!interfaceBuf) {
|
|
code = interfaceBuf.getError();
|
|
return true;
|
|
}
|
|
|
|
// Create a source file.
|
|
unsigned bufferID = Ctx.SourceMgr.addNewSourceBuffer(std::move(interfaceBuf.get()));
|
|
auto moduleDecl = ModuleDecl::create(moduleName, Ctx);
|
|
auto sourceFile = new (Ctx) SourceFile(
|
|
*moduleDecl, SourceFileKind::Interface, bufferID);
|
|
|
|
// Walk the source file to find the import declarations.
|
|
llvm::StringSet<> alreadyAddedModules;
|
|
Result->addModuleDependencies(*sourceFile, alreadyAddedModules);
|
|
return false;
|
|
});
|
|
|
|
if (hasError) {
|
|
return code;
|
|
}
|
|
return *Result;
|
|
}
|
|
|
|
Optional<ModuleDependencies> SerializedModuleLoaderBase::getModuleDependencies(
|
|
StringRef moduleName, ModuleDependenciesCache &cache,
|
|
InterfaceSubContextDelegate &delegate) {
|
|
// Check whether we've cached this result.
|
|
if (auto found = cache.findDependencies(
|
|
moduleName, ModuleDependenciesKind::Swift))
|
|
return found;
|
|
if (auto found =
|
|
cache.findDependencies(moduleName, ModuleDependenciesKind::SwiftExternal))
|
|
return found;
|
|
|
|
auto moduleId = Ctx.getIdentifier(moduleName);
|
|
// Instantiate dependency scanning "loaders".
|
|
SmallVector<std::unique_ptr<ModuleDependencyScanner>, 2> scanners;
|
|
scanners.push_back(std::make_unique<ModuleDependencyScanner>(
|
|
Ctx, LoadMode, moduleId, delegate));
|
|
scanners.push_back(std::make_unique<ExternalSwiftModuleStubScanner>(
|
|
Ctx, LoadMode, moduleId, Ctx.SearchPathOpts.ExternalDependencyModuleMap,
|
|
delegate));
|
|
|
|
// Check whether there is a module with this name that we can import.
|
|
for (auto &scanner : scanners) {
|
|
if (scanner->canImportModule({moduleId, SourceLoc()})) {
|
|
// Record the dependencies.
|
|
cache.recordDependencies(moduleName, *(scanner->dependencies),
|
|
scanner->dependencyKind);
|
|
return std::move(scanner->dependencies);
|
|
}
|
|
}
|
|
|
|
return None;
|
|
}
|