Skip to content

Commit 31337dd

Browse files
artemcmartemcm
authored
Merge pull request #69706 from artemcm/DepScanCPPInterop
[Explicit Module Builds] C++ Interoperability mode fixes
2 parents d87c991 + ec4e0e2 commit 31337dd

18 files changed

+160
-32
lines changed

‎include/swift/AST/ModuleDependencies.h

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,9 @@ class ClangModuleDependencyStorage : public ModuleDependencyInfoStorageBase {
403403
/// CASID for the Root of ClangIncludeTree. Empty if not used.
404404
std::string CASClangIncludeTreeRootID;
405405

406+
/// Whether this is a "system" module.
407+
bool IsSystem;
408+
406409
ClangModuleDependencyStorage(const std::string &pcmOutputPath,
407410
const std::string &mappedPCMPath,
408411
const std::string &moduleMapFile,
@@ -412,15 +415,16 @@ class ClangModuleDependencyStorage : public ModuleDependencyInfoStorageBase {
412415
const std::vector<std::string> &capturedPCMArgs,
413416
const std::string &CASFileSystemRootID,
414417
const std::string &clangIncludeTreeRoot,
415-
const std::string &moduleCacheKey)
418+
const std::string &moduleCacheKey,
419+
bool IsSystem)
416420
: ModuleDependencyInfoStorageBase(ModuleDependencyKind::Clang,
417421
moduleCacheKey),
418422
pcmOutputPath(pcmOutputPath), mappedPCMPath(mappedPCMPath),
419423
moduleMapFile(moduleMapFile), contextHash(contextHash),
420424
buildCommandLine(buildCommandLine), fileDependencies(fileDependencies),
421425
capturedPCMArgs(capturedPCMArgs),
422426
CASFileSystemRootID(CASFileSystemRootID),
423-
CASClangIncludeTreeRootID(clangIncludeTreeRoot) {}
427+
CASClangIncludeTreeRootID(clangIncludeTreeRoot), IsSystem(IsSystem) {}
424428

425429
ModuleDependencyInfoStorageBase *clone() const override {
426430
return new ClangModuleDependencyStorage(*this);
@@ -549,11 +553,12 @@ class ModuleDependencyInfo {
549553
const std::vector<std::string> &capturedPCMArgs,
550554
const std::string &CASFileSystemRootID,
551555
const std::string &clangIncludeTreeRoot,
552-
const std::string &moduleCacheKey) {
556+
const std::string &moduleCacheKey,
557+
bool IsSystem) {
553558
return ModuleDependencyInfo(std::make_unique<ClangModuleDependencyStorage>(
554559
pcmOutputPath, mappedPCMPath, moduleMapFile, contextHash,
555560
nonPathCommandLine, fileDependencies, capturedPCMArgs,
556-
CASFileSystemRootID, clangIncludeTreeRoot, moduleCacheKey));
561+
CASFileSystemRootID, clangIncludeTreeRoot, moduleCacheKey, IsSystem));
557562
}
558563

559564
/// Describe a placeholder dependency swift module.

‎include/swift/Basic/LangOptions.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,9 @@ namespace swift {
402402
bool DisableImplicitBacktracingModuleImport =
403403
!SWIFT_IMPLICIT_BACKTRACING_IMPORT;
404404

405+
/// Disable the implicit import of the Cxx module.
406+
bool DisableImplicitCxxModuleImport = false;
407+
405408
// Whether to use checked continuations when making an async call from
406409
// Swift into ObjC. If false, will use unchecked continuations instead.
407410
bool UseCheckedAsyncObjCBridging = false;

‎include/swift/ClangImporter/ClangImporter.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -665,6 +665,11 @@ bool requiresCPlusPlus(const clang::Module *module);
665665
/// (std_vector, std_iosfwd, etc).
666666
bool isCxxStdModule(const clang::Module *module);
667667

668+
/// Returns true if the given module is one of the C++ standard library modules.
669+
/// This could be the top-level std module, or any of the libc++ split modules
670+
/// (std_vector, std_iosfwd, etc).
671+
bool isCxxStdModule(StringRef moduleName, bool IsSystem);
672+
668673
/// Returns the pointee type if the given type is a C++ `const`
669674
/// reference type, `None` otherwise.
670675
std::optional<clang::QualType>

‎include/swift/DependencyScan/SerializedModuleDependencyCacheFormat.h

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ using llvm::BCVBR;
4040
/// Every .moddepcache file begins with these 4 bytes, for easy identification.
4141
const unsigned char MODULE_DEPENDENCY_CACHE_FORMAT_SIGNATURE[] = {'I', 'M', 'D','C'};
4242
const unsigned MODULE_DEPENDENCY_CACHE_FORMAT_VERSION_MAJOR =
43-
6; // mappedPCMPath
43+
7; // isSystem
4444
/// Increment this on every change.
4545
const unsigned MODULE_DEPENDENCY_CACHE_FORMAT_VERSION_MINOR = 1;
4646

@@ -53,6 +53,8 @@ using ContextHashIDField = IdentifierIDField;
5353

5454
/// A bit that indicates whether or not a module is a framework
5555
using IsFrameworkField = BCFixed<1>;
56+
/// A bit that indicates whether or not a module is a system module
57+
using IsSystemField = BCFixed<1>;
5658

5759
/// Arrays of various identifiers, distinguished for readability
5860
using IdentifierIDArryField = llvm::BCArray<IdentifierIDField>;
@@ -193,7 +195,8 @@ using ClangModuleDetailsLayout =
193195
FlagIDArrayIDField, // capturedPCMArgs
194196
IdentifierIDField, // CASFileSystemRootID
195197
IdentifierIDField, // clangIncludeTreeRoot
196-
IdentifierIDField // moduleCacheKey
198+
IdentifierIDField, // moduleCacheKey
199+
IsSystemField // isSystem
197200
>;
198201
} // namespace graph_block
199202

‎include/swift/Frontend/Frontend.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -405,6 +405,9 @@ class CompilerInvocation {
405405
/// imported.
406406
bool shouldImportSwiftBacktracing() const;
407407

408+
/// Whether the CXX module should be implicitly imported.
409+
bool shouldImportCxx() const;
410+
408411
/// Performs input setup common to these tools:
409412
/// sil-opt, sil-func-extractor, sil-llvm-gen, and sil-nm.
410413
/// Return value includes the buffer so caller can keep it alive.
@@ -660,6 +663,9 @@ class CompilerInstance {
660663
/// i.e. if it can be found.
661664
bool canImportSwiftBacktracing() const;
662665

666+
/// Whether the Cxx library can be imported
667+
bool canImportCxx() const;
668+
663669
/// Whether the CxxShim library can be imported
664670
/// i.e. if it can be found.
665671
bool canImportCxxShim() const;

‎include/swift/Option/FrontendOptions.td

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,10 @@ def disable_implicit_backtracing_module_import : Flag<["-"],
509509
"disable-implicit-backtracing-module-import">,
510510
HelpText<"Disable the implicit import of the _Backtracing module.">;
511511

512+
def disable_implicit_cxx_module_import : Flag<["-"],
513+
"disable-implicit-cxx-module-import">,
514+
HelpText<"Disable the implicit import of the C++ Standard Library module.">;
515+
512516
def disable_arc_opts : Flag<["-"], "disable-arc-opts">,
513517
HelpText<"Don't run SIL ARC optimization passes.">;
514518
def disable_ossa_opts : Flag<["-"], "disable-ossa-opts">,

‎include/swift/Serialization/SerializedModuleLoader.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,8 @@ class SerializedModuleLoaderBase : public ModuleLoader {
171171
std::string headerImport;
172172
};
173173

174-
static BinaryModuleImports
175-
getImportsOfModule(const ModuleFileSharedCore &loadedModule,
174+
llvm::ErrorOr<BinaryModuleImports>
175+
getImportsOfModule(const ModuleFileSharedCore &loadedModuleFile,
176176
ModuleLoadingBehavior transitiveBehavior,
177177
StringRef packageName, bool isTestableImport);
178178

‎include/swift/Strings.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ constexpr static const StringLiteral SWIFT_BACKTRACING_NAME = "_Backtracing";
3939
constexpr static const StringLiteral SWIFT_SHIMS_NAME = "SwiftShims";
4040
/// The name of the CxxShim module, which contains a cxx casting utility.
4141
constexpr static const StringLiteral CXX_SHIM_NAME = "CxxShim";
42+
/// The name of the Cxx module, which contains C++ interop helper protocols.
43+
constexpr static const StringLiteral CXX_MODULE_NAME = "Cxx";
4244
/// The name of the Builtin module, which contains Builtin functions.
4345
constexpr static const StringLiteral BUILTIN_NAME = "Builtin";
4446
/// The name of the clang imported header module.

‎lib/ClangImporter/ClangImporter.cpp

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7894,14 +7894,20 @@ bool importer::requiresCPlusPlus(const clang::Module *module) {
78947894
}
78957895

78967896
bool importer::isCxxStdModule(const clang::Module *module) {
7897-
if (module->getTopLevelModuleName() == "std")
7897+
return isCxxStdModule(module->getTopLevelModuleName(),
7898+
module->getTopLevelModule()->IsSystem);
7899+
}
7900+
7901+
bool importer::isCxxStdModule(StringRef moduleName, bool IsSystem) {
7902+
if (moduleName == "std")
78987903
return true;
78997904
// In recent libc++ versions the module is split into multiple top-level
79007905
// modules (std_vector, std_utility, etc).
7901-
if (module->getTopLevelModule()->IsSystem &&
7902-
module->getTopLevelModuleName().starts_with("std_"))
7906+
if (IsSystem && moduleName.starts_with("std_")) {
7907+
if (moduleName == "std_errno_h")
7908+
return false;
79037909
return true;
7904-
7910+
}
79057911
return false;
79067912
}
79077913

‎lib/ClangImporter/ClangModuleDependencyScanner.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ ModuleDependencyVector ClangImporter::bridgeClangModuleDependencies(
289289
auto dependencies = ModuleDependencyInfo::forClangModule(
290290
pcmPath, mappedPCMPath, clangModuleDep.ClangModuleMapFile,
291291
clangModuleDep.ID.ContextHash, swiftArgs, fileDeps, capturedPCMArgs,
292-
RootID, IncludeTree, /*module-cache-key*/ "");
292+
RootID, IncludeTree, /*module-cache-key*/ "", clangModuleDep.IsSystem);
293293
for (const auto &moduleName : clangModuleDep.ClangModuleDeps) {
294294
dependencies.addModuleImport(moduleName.ModuleName, &alreadyAddedModules);
295295
// It is safe to assume that all dependencies of a Clang module are Clang modules.

‎lib/DependencyScan/ModuleDependencyCacheSerialization.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -574,12 +574,12 @@ bool ModuleDependenciesCacheDeserializer::readGraph(SwiftDependencyScanningServi
574574
cache.configureForContextHash(getContextHash());
575575
unsigned pcmOutputPathID, mappedPCMPathID, moduleMapPathID, contextHashID,
576576
commandLineArrayID, fileDependenciesArrayID, capturedPCMArgsArrayID,
577-
CASFileSystemRootID, clangIncludeTreeRootID, moduleCacheKeyID;
577+
CASFileSystemRootID, clangIncludeTreeRootID, moduleCacheKeyID, isSystem;
578578
ClangModuleDetailsLayout::readRecord(
579579
Scratch, pcmOutputPathID, mappedPCMPathID, moduleMapPathID,
580580
contextHashID, commandLineArrayID, fileDependenciesArrayID,
581581
capturedPCMArgsArrayID, CASFileSystemRootID, clangIncludeTreeRootID,
582-
moduleCacheKeyID);
582+
moduleCacheKeyID, isSystem);
583583
auto pcmOutputPath = getIdentifier(pcmOutputPathID);
584584
if (!pcmOutputPath)
585585
llvm::report_fatal_error("Bad pcm output path");
@@ -615,7 +615,7 @@ bool ModuleDependenciesCacheDeserializer::readGraph(SwiftDependencyScanningServi
615615
auto moduleDep = ModuleDependencyInfo::forClangModule(
616616
*pcmOutputPath, *mappedPCMPath, *moduleMapPath, *contextHash,
617617
*commandLineArgs, *fileDependencies, *capturedPCMArgs,
618-
*rootFileSystemID, *clangIncludeTreeRoot, *moduleCacheKey);
618+
*rootFileSystemID, *clangIncludeTreeRoot, *moduleCacheKey, isSystem);
619619

620620
// Add dependencies of this module
621621
for (const auto &moduleName : *currentModuleImports)
@@ -1064,7 +1064,7 @@ void ModuleDependenciesCacheSerializer::writeModuleInfo(
10641064
getArrayID(moduleID, ModuleIdentifierArrayKind::CapturedPCMArgs),
10651065
getIdentifier(clangDeps->CASFileSystemRootID),
10661066
getIdentifier(clangDeps->CASClangIncludeTreeRootID),
1067-
getIdentifier(clangDeps->moduleCacheKey));
1067+
getIdentifier(clangDeps->moduleCacheKey), clangDeps->IsSystem);
10681068

10691069
break;
10701070
}

‎lib/DependencyScan/ModuleDependencyScanner.cpp

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
#include "swift/AST/TypeCheckRequests.h"
2222
#include "swift/Basic/FileTypes.h"
2323
#include "swift/Basic/PrettyStackTrace.h"
24+
#include "swift/ClangImporter/ClangImporter.h"
2425
#include "swift/DependencyScan/ModuleDependencyScanner.h"
2526
#include "swift/Frontend/ModuleInterfaceLoader.h"
2627
#include "swift/Serialization/SerializedModuleLoader.h"
@@ -774,24 +775,46 @@ void ModuleDependencyScanner::resolveSwiftOverlayDependencies(
774775
// FIXME: Once all clients know to fetch these dependencies from
775776
// `swiftOverlayDependencies`, the goal is to no longer have them in
776777
// `directDependencies` so the following will need to go away.
777-
directDependencies.insert({moduleName, cachedInfo->getKind()});
778+
directDependencies.insert({moduleName, cachedInfo->getKind()});
778779
} else {
779780
// Cache discovered module dependencies.
780781
cache.recordDependencies(lookupResult.value());
781782
if (!lookupResult.value().empty()) {
782-
swiftOverlayDependencies.insert(
783-
{moduleName, lookupResult.value()[0].first.Kind});
783+
swiftOverlayDependencies.insert({moduleName, lookupResult.value()[0].first.Kind});
784784
// FIXME: Once all clients know to fetch these dependencies from
785785
// `swiftOverlayDependencies`, the goal is to no longer have them in
786786
// `directDependencies` so the following will need to go away.
787-
directDependencies.insert(
788-
{moduleName, lookupResult.value()[0].first.Kind});
789-
}
787+
directDependencies.insert({moduleName, lookupResult.value()[0].first.Kind});
788+
}
790789
}
791790
}
792791
};
793792
for (const auto &clangDep : clangDependencies)
794793
recordResult(clangDep);
794+
795+
// C++ Interop requires additional handling
796+
if (ScanCompilerInvocation.getLangOptions().EnableCXXInterop) {
797+
for (const auto &clangDepName : clangDependencies) {
798+
// If this Clang module is a part of the C++ stdlib, and we haven't loaded
799+
// the overlay for it so far, it is a split libc++ module (e.g.
800+
// std_vector). Load the CxxStdlib overlay explicitly.
801+
const auto &clangDepInfo =
802+
cache.findDependency(clangDepName, ModuleDependencyKind::Clang)
803+
.value()
804+
->getAsClangModule();
805+
if (importer::isCxxStdModule(clangDepName, clangDepInfo->IsSystem) &&
806+
!swiftOverlayDependencies.contains(
807+
{clangDepName, ModuleDependencyKind::SwiftInterface}) &&
808+
!swiftOverlayDependencies.contains(
809+
{clangDepName, ModuleDependencyKind::SwiftBinary})) {
810+
ScanningThreadPool.async(
811+
scanForSwiftDependency,
812+
getModuleImportIdentifier(ScanASTContext.Id_CxxStdlib.str()));
813+
ScanningThreadPool.wait();
814+
recordResult(ScanASTContext.Id_CxxStdlib.str().str());
815+
}
816+
}
817+
}
795818
}
796819

797820
void ModuleDependencyScanner::discoverCrossImportOverlayDependencies(

‎lib/Frontend/CompilerInvocation.cpp

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -506,6 +506,9 @@ validateCxxInteropCompatibilityMode(StringRef mode) {
506506
// Swift 5 is the default language version.
507507
if (mode == "swift-5.9")
508508
return {CxxCompatMode::enabled, version::Version({5})};
509+
// Note: If this is updated, corresponding code in
510+
// InterfaceSubContextDelegateImpl::InterfaceSubContextDelegateImpl needs
511+
// to be updated also.
509512
return {CxxCompatMode::invalid, {}};
510513
}
511514

@@ -634,6 +637,9 @@ static bool ParseLangArgs(LangOptions &Opts, ArgList &Args,
634637
Opts.DisableImplicitStringProcessingModuleImport |=
635638
Args.hasArg(OPT_disable_implicit_string_processing_module_import);
636639

640+
Opts.DisableImplicitCxxModuleImport |=
641+
Args.hasArg(OPT_disable_implicit_cxx_module_import);
642+
637643
Opts.DisableImplicitBacktracingModuleImport =
638644
Args.hasFlag(OPT_disable_implicit_backtracing_module_import,
639645
OPT_enable_implicit_backtracing_module_import,

‎lib/Frontend/Frontend.cpp

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1094,6 +1094,26 @@ bool CompilerInvocation::shouldImportSwiftBacktracing() const {
10941094
FrontendOptions::ParseInputMode::SwiftModuleInterface;
10951095
}
10961096

1097+
bool CompilerInvocation::shouldImportCxx() const {
1098+
// C++ Interop is disabled
1099+
if (!getLangOptions().EnableCXXInterop)
1100+
return false;
1101+
// Avoid C++ stdlib when building Swift stdlib
1102+
if (getImplicitStdlibKind() == ImplicitStdlibKind::Builtin)
1103+
return false;
1104+
// Avoid importing Cxx when building Cxx itself
1105+
if (getFrontendOptions().ModuleName == CXX_MODULE_NAME)
1106+
return false;
1107+
// Cxx cannot be imported when Library evolution is enabled
1108+
if (getFrontendOptions().EnableLibraryEvolution)
1109+
return false;
1110+
// Implicit import of Cxx is disabled
1111+
if (getLangOptions().DisableImplicitCxxModuleImport)
1112+
return false;
1113+
1114+
return true;
1115+
}
1116+
10971117
/// Implicitly import the SwiftOnoneSupport module in non-optimized
10981118
/// builds. This allows for use of popular specialized functions
10991119
/// from the standard library, which makes the non-optimized builds
@@ -1175,6 +1195,13 @@ bool CompilerInstance::canImportSwiftBacktracing() const {
11751195
return getASTContext().testImportModule(modulePath);
11761196
}
11771197

1198+
bool CompilerInstance::canImportCxx() const {
1199+
ImportPath::Module::Builder builder(
1200+
getASTContext().getIdentifier(CXX_MODULE_NAME));
1201+
auto modulePath = builder.get();
1202+
return getASTContext().testImportModule(modulePath);
1203+
}
1204+
11781205
bool CompilerInstance::canImportCxxShim() const {
11791206
ImportPath::Module::Builder builder(
11801207
getASTContext().getIdentifier(CXX_SHIM_NAME));
@@ -1278,8 +1305,11 @@ ImplicitImportInfo CompilerInstance::getImplicitImportInfo() const {
12781305
}
12791306
}
12801307

1281-
if (Invocation.getLangOptions().EnableCXXInterop && canImportCxxShim()) {
1282-
pushImport(CXX_SHIM_NAME, {ImportFlags::ImplementationOnly});
1308+
if (Invocation.getLangOptions().EnableCXXInterop) {
1309+
if (Invocation.shouldImportCxx() && canImportCxx())
1310+
pushImport(CXX_MODULE_NAME);
1311+
if (canImportCxxShim())
1312+
pushImport(CXX_SHIM_NAME, {ImportFlags::ImplementationOnly});
12831313
}
12841314

12851315
imports.ShouldImportUnderlyingModule = frontendOpts.ImportUnderlyingModule;

‎lib/Frontend/ModuleInterfaceLoader.cpp

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1971,6 +1971,33 @@ InterfaceSubContextDelegateImpl::InterfaceSubContextDelegateImpl(
19711971
GenericArgs.push_back("-blocklist-file");
19721972
GenericArgs.push_back(blocklist);
19731973
}
1974+
1975+
// For now, we only inherit the C++ interoperability mode in
1976+
// Explicit Module Builds.
1977+
if (langOpts.EnableCXXInterop &&
1978+
(frontendOpts.DisableImplicitModules ||
1979+
LoaderOpts.requestedAction ==
1980+
FrontendOptions::ActionType::ScanDependencies)) {
1981+
// Modelled after a reverse of validateCxxInteropCompatibilityMode
1982+
genericSubInvocation.getLangOptions().EnableCXXInterop = true;
1983+
genericSubInvocation.getLangOptions().cxxInteropCompatVersion =
1984+
langOpts.cxxInteropCompatVersion;
1985+
std::string compatVersion;
1986+
if (langOpts.cxxInteropCompatVersion.empty())
1987+
compatVersion = "default";
1988+
else if (langOpts.cxxInteropCompatVersion[0] == 5)
1989+
compatVersion = "swift-5.9";
1990+
else if (langOpts.cxxInteropCompatVersion[0] == 6)
1991+
compatVersion = "swift-6";
1992+
else if (langOpts.cxxInteropCompatVersion[0] ==
1993+
version::getUpcomingCxxInteropCompatVersion())
1994+
compatVersion = "upcoming-swift";
1995+
else // TODO: This may need to be updated once more versions are added
1996+
compatVersion = "default";
1997+
1998+
GenericArgs.push_back(
1999+
ArgSaver.save("-cxx-interoperability-mode=" + compatVersion));
2000+
}
19742001
}
19752002

19762003
/// Calculate an output filename in \p genericSubInvocation's cache path that

0 commit comments

Comments
 (0)