Skip to content

Commit d8d4c04

Browse files
allevatoallevato
committed
Allow module aliases to be expressed in the explicit Swift module map JSON file.
For build systems that already generate these files, it makes sense to include the aliases so that the map file serves as a comprehensive index of how the module inputs are referenced.
1 parent 6b72ff0 commit d8d4c04

File tree

6 files changed

+116
-18
lines changed

6 files changed

+116
-18
lines changed

‎include/swift/AST/ASTContext.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -615,6 +615,10 @@ class ASTContext final {
615615
/// are the real (physical) module names on disk.
616616
void setModuleAliases(const llvm::StringMap<StringRef> &aliasMap);
617617

618+
/// Adds a given alias to the map of Identifiers between module aliases and
619+
/// their actual names.
620+
void addModuleAlias(StringRef moduleAlias, StringRef realName);
621+
618622
/// Look up option used in \c getRealModuleName when module aliasing is applied.
619623
enum class ModuleAliasLookupOption {
620624
alwaysRealName,

‎include/swift/Frontend/ModuleInterfaceLoader.h

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -318,10 +318,11 @@ class ExplicitModuleMapParser {
318318
public:
319319
ExplicitModuleMapParser(llvm::BumpPtrAllocator &Allocator) : Saver(Allocator) {}
320320

321-
std::error_code
322-
parseSwiftExplicitModuleMap(llvm::MemoryBufferRef BufferRef,
323-
llvm::StringMap<ExplicitSwiftModuleInputInfo> &swiftModuleMap,
324-
llvm::StringMap<ExplicitClangModuleInputInfo> &clangModuleMap) {
321+
std::error_code parseSwiftExplicitModuleMap(
322+
llvm::MemoryBufferRef BufferRef,
323+
llvm::StringMap<ExplicitSwiftModuleInputInfo> &swiftModuleMap,
324+
llvm::StringMap<ExplicitClangModuleInputInfo> &clangModuleMap,
325+
llvm::StringMap<std::string> &moduleAliases) {
325326
using namespace llvm::yaml;
326327
// Use a new source manager instead of the one from ASTContext because we
327328
// don't want the JSON file to be persistent.
@@ -331,7 +332,8 @@ class ExplicitModuleMapParser {
331332
assert(DI != Stream.end() && "Failed to read a document");
332333
if (auto *MN = dyn_cast_or_null<SequenceNode>(DI->getRoot())) {
333334
for (auto &entry : *MN) {
334-
if (parseSingleModuleEntry(entry, swiftModuleMap, clangModuleMap)) {
335+
if (parseSingleModuleEntry(entry, swiftModuleMap, clangModuleMap,
336+
moduleAliases)) {
335337
return std::make_error_code(std::errc::invalid_argument);
336338
}
337339
}
@@ -359,16 +361,19 @@ class ExplicitModuleMapParser {
359361
llvm_unreachable("Unexpected JSON value for isFramework");
360362
}
361363

362-
bool parseSingleModuleEntry(llvm::yaml::Node &node,
363-
llvm::StringMap<ExplicitSwiftModuleInputInfo> &swiftModuleMap,
364-
llvm::StringMap<ExplicitClangModuleInputInfo> &clangModuleMap) {
364+
bool parseSingleModuleEntry(
365+
llvm::yaml::Node &node,
366+
llvm::StringMap<ExplicitSwiftModuleInputInfo> &swiftModuleMap,
367+
llvm::StringMap<ExplicitClangModuleInputInfo> &clangModuleMap,
368+
llvm::StringMap<std::string> &moduleAliases) {
365369
using namespace llvm::yaml;
366370
auto *mapNode = dyn_cast<MappingNode>(&node);
367371
if (!mapNode)
368372
return true;
369373
StringRef moduleName;
370374
std::optional<std::string> swiftModulePath, swiftModuleDocPath,
371-
swiftModuleSourceInfoPath, swiftModuleCacheKey, clangModuleCacheKey;
375+
swiftModuleSourceInfoPath, swiftModuleCacheKey, clangModuleCacheKey,
376+
moduleAlias;
372377
std::optional<std::vector<std::string>> headerDependencyPaths;
373378
std::string clangModuleMapPath = "", clangModulePath = "";
374379
bool isFramework = false, isSystem = false,
@@ -405,6 +410,8 @@ class ExplicitModuleMapParser {
405410
clangModuleCacheKey = val.str();
406411
} else if (key == "isBridgingHeaderDependency") {
407412
isBridgingHeaderDependency = parseBoolValue(val);
413+
} else if (key == "moduleAlias") {
414+
moduleAlias = val.str();
408415
} else {
409416
// Being forgiving for future fields.
410417
continue;
@@ -439,6 +446,9 @@ class ExplicitModuleMapParser {
439446
clangModuleCacheKey);
440447
didInsert = clangModuleMap.try_emplace(moduleName, std::move(entry)).second;
441448
}
449+
if (didInsert && moduleAlias.has_value()) {
450+
moduleAliases[*moduleAlias] = moduleName;
451+
}
442452
// Prevent duplicate module names.
443453
return !didInsert;
444454
}

‎lib/AST/ASTContext.cpp

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2136,16 +2136,20 @@ void ASTContext::setModuleAliases(const llvm::StringMap<StringRef> &aliasMap) {
21362136
for (auto k: aliasMap.keys()) {
21372137
auto v = aliasMap.lookup(k);
21382138
if (!v.empty()) {
2139-
auto key = getIdentifier(k);
2140-
auto val = getIdentifier(v);
2141-
// key is a module alias, val is its corresponding real name
2142-
ModuleAliasMap[key] = std::make_pair(val, true);
2143-
// add an entry with an alias as key for an easier lookup later
2144-
ModuleAliasMap[val] = std::make_pair(key, false);
2139+
addModuleAlias(k, v);
21452140
}
21462141
}
21472142
}
21482143

2144+
void ASTContext::addModuleAlias(StringRef moduleAlias, StringRef realName) {
2145+
auto key = getIdentifier(moduleAlias);
2146+
auto val = getIdentifier(realName);
2147+
// key is a module alias, val is its corresponding real name
2148+
ModuleAliasMap[key] = std::make_pair(val, true);
2149+
// add an entry with an alias as key for an easier lookup later
2150+
ModuleAliasMap[val] = std::make_pair(key, false);
2151+
}
2152+
21492153
Identifier ASTContext::getRealModuleName(Identifier key, ModuleAliasLookupOption option) const {
21502154
auto found = ModuleAliasMap.find(key);
21512155
if (found == ModuleAliasMap.end())

‎lib/Frontend/ModuleInterfaceLoader.cpp

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2183,6 +2183,14 @@ InterfaceSubContextDelegateImpl::runInSubCompilerInstance(StringRef moduleName,
21832183
return action(info);
21842184
}
21852185

2186+
static void addModuleAliasesFromExplicitSwiftModuleMap(
2187+
ASTContext &Ctx, llvm::StringMap<std::string> ModuleAliases) {
2188+
for (auto &entry : ModuleAliases) {
2189+
Ctx.addModuleAlias(/*moduleAlias=*/entry.getKey(),
2190+
/*realModule=*/entry.getValue());
2191+
}
2192+
}
2193+
21862194
struct ExplicitSwiftModuleLoader::Implementation {
21872195
ASTContext &Ctx;
21882196
llvm::BumpPtrAllocator Allocator;
@@ -2192,6 +2200,7 @@ struct ExplicitSwiftModuleLoader::Implementation {
21922200
void parseSwiftExplicitModuleMap(StringRef fileName) {
21932201
ExplicitModuleMapParser parser(Allocator);
21942202
llvm::StringMap<ExplicitClangModuleInputInfo> ExplicitClangModuleMap;
2203+
llvm::StringMap<std::string> ModuleAliases;
21952204
// Load the input file.
21962205
llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> fileBufOrErr =
21972206
llvm::MemoryBuffer::getFile(fileName);
@@ -2203,7 +2212,7 @@ struct ExplicitSwiftModuleLoader::Implementation {
22032212

22042213
auto hasError = parser.parseSwiftExplicitModuleMap(
22052214
(*fileBufOrErr)->getMemBufferRef(), ExplicitModuleMap,
2206-
ExplicitClangModuleMap);
2215+
ExplicitClangModuleMap, ModuleAliases);
22072216

22082217
if (hasError)
22092218
Ctx.Diags.diagnose(SourceLoc(), diag::explicit_swift_module_map_corrupted,
@@ -2230,6 +2239,7 @@ struct ExplicitSwiftModuleLoader::Implementation {
22302239
.str());
22312240
}
22322241
}
2242+
addModuleAliasesFromExplicitSwiftModuleMap(Ctx, ModuleAliases);
22332243
}
22342244

22352245
void addCommandLineExplicitInputs(
@@ -2462,6 +2472,7 @@ struct ExplicitCASModuleLoader::Implementation {
24622472
void parseSwiftExplicitModuleMap(StringRef ID) {
24632473
ExplicitModuleMapParser parser(Allocator);
24642474
llvm::StringMap<ExplicitClangModuleInputInfo> ExplicitClangModuleMap;
2475+
llvm::StringMap<std::string> ModuleAliases;
24652476
auto buf = loadBuffer(ID);
24662477
if (!buf) {
24672478
Ctx.Diags.diagnose(SourceLoc(), diag::error_cas,
@@ -2477,7 +2488,8 @@ struct ExplicitCASModuleLoader::Implementation {
24772488
llvm::MemoryBuffer::getFile(ID);
24782489

24792490
auto hasError = parser.parseSwiftExplicitModuleMap(
2480-
(*buf)->getMemBufferRef(), ExplicitModuleMap, ExplicitClangModuleMap);
2491+
(*buf)->getMemBufferRef(), ExplicitModuleMap, ExplicitClangModuleMap,
2492+
ModuleAliases);
24812493

24822494
if (hasError)
24832495
Ctx.Diags.diagnose(SourceLoc(), diag::explicit_swift_module_map_corrupted,
@@ -2516,6 +2528,7 @@ struct ExplicitCASModuleLoader::Implementation {
25162528
extraClangArgs.push_back(*cachePath);
25172529
}
25182530
}
2531+
addModuleAliasesFromExplicitSwiftModuleMap(Ctx, ModuleAliases);
25192532
}
25202533

25212534
void addCommandLineExplicitInputs(

‎lib/Serialization/ScanningLoaders.cpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ void PlaceholderSwiftModuleScanner::parsePlaceholderModuleMap(
112112
StringRef fileName) {
113113
ExplicitModuleMapParser parser(Allocator);
114114
llvm::StringMap<ExplicitClangModuleInputInfo> ClangDependencyModuleMap;
115+
llvm::StringMap<std::string> ModuleAliases;
115116
llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> fileBufOrErr =
116117
llvm::MemoryBuffer::getFile(fileName);
117118
if (!fileBufOrErr) {
@@ -121,7 +122,7 @@ void PlaceholderSwiftModuleScanner::parsePlaceholderModuleMap(
121122
}
122123
auto result = parser.parseSwiftExplicitModuleMap(
123124
(*fileBufOrErr)->getMemBufferRef(), PlaceholderDependencyModuleMap,
124-
ClangDependencyModuleMap);
125+
ClangDependencyModuleMap, ModuleAliases);
125126
if (result == std::errc::invalid_argument) {
126127
Ctx.Diags.diagnose(SourceLoc(),
127128
diag::placeholder_dependency_module_map_corrupted,

‎test/Frontend/module-alias-explicit-build-alias-in-json.swift

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
/// Test setting a module alias in the explicit module loader's JSON directly.
2+
// UNSUPPORTED: OS=windows-msvc
3+
// RUN: %empty-directory(%t)
4+
// RUN: mkdir -p %t/inputs
5+
// RUN: mkdir -p %t/outputs
6+
7+
/// Create a module Bar
8+
// RUN: echo 'public func bar() {}' > %t/inputs/FileBar.swift
9+
// RUN: %target-swift-frontend -module-name Bar %t/inputs/FileBar.swift -emit-module -emit-module-path %t/inputs/Bar.swiftmodule
10+
// RUN: %target-swift-emit-pcm -module-name SwiftShims %swift-lib-dir/swift/shims/module.modulemap -o %t/inputs/SwiftShims.pcm
11+
// RUN: %target-swift-emit-pcm -module-name _SwiftConcurrencyShims %swift-lib-dir/swift/shims/module.modulemap -o %t/inputs/_SwiftConcurrencyShims.pcm
12+
13+
/// Check Bar.swiftmodule is created
14+
// RUN: test -f %t/inputs/Bar.swiftmodule
15+
16+
/// Next create an explicit module dependency map to build module Foo
17+
// RUN: echo 'import Cat' > %t/inputs/FileFoo.swift
18+
19+
// RUN: echo "[{" > %/t/inputs/map.json
20+
// RUN: echo "\"moduleName\": \"Bar\"," >> %/t/inputs/map.json
21+
// RUN: echo "\"modulePath\": \"%/t/inputs/Bar.swiftmodule\"," >> %/t/inputs/map.json
22+
// RUN: echo "\"moduleAlias\": \"Cat\"," >> %/t/inputs/map.json
23+
// RUN: echo "\"isFramework\": false" >> %/t/inputs/map.json
24+
// RUN: echo "}," >> %/t/inputs/map.json
25+
// RUN: echo "{" >> %/t/inputs/map.json
26+
// RUN: echo "\"moduleName\": \"Swift\"," >> %/t/inputs/map.json
27+
// RUN: echo "\"modulePath\": \"%/stdlib_module\"," >> %/t/inputs/map.json
28+
// RUN: echo "\"isFramework\": false" >> %/t/inputs/map.json
29+
// RUN: echo "}," >> %/t/inputs/map.json
30+
// RUN: echo "{" >> %/t/inputs/map.json
31+
// RUN: echo "\"moduleName\": \"SwiftOnoneSupport\"," >> %/t/inputs/map.json
32+
// RUN: echo "\"modulePath\": \"%/ononesupport_module\"," >> %/t/inputs/map.json
33+
// RUN: echo "\"isFramework\": false" >> %/t/inputs/map.json
34+
// RUN: echo "}," >> %/t/inputs/map.json
35+
// RUN: echo "{" >> %/t/inputs/map.json
36+
// RUN: echo "\"moduleName\": \"_Concurrency\"," >> %/t/inputs/map.json
37+
// RUN: echo "\"modulePath\": \"%/concurrency_module\"," >> %/t/inputs/map.json
38+
// RUN: echo "\"isFramework\": false" >> %/t/inputs/map.json
39+
// RUN: echo "}," >> %/t/inputs/map.json
40+
// RUN: echo "{" >> %/t/inputs/map.json
41+
// RUN: echo "\"moduleName\": \"SwiftShims\"," >> %/t/inputs/map.json
42+
// RUN: echo "\"isFramework\": false," >> %/t/inputs/map.json
43+
// RUN: echo "\"clangModuleMapPath\": \"%swift-lib-dir/swift/shims/module.modulemap\"," >> %/t/inputs/map.json
44+
// RUN: echo "\"clangModulePath\": \"%t/inputs/SwiftShims.pcm\"" >> %/t/inputs/map.json
45+
// RUN: echo "}," >> %/t/inputs/map.json
46+
// RUN: echo "{" >> %/t/inputs/map.json
47+
// RUN: echo "\"moduleName\": \"_SwiftConcurrencyShims\"," >> %/t/inputs/map.json
48+
// RUN: echo "\"isFramework\": false," >> %/t/inputs/map.json
49+
// RUN: echo "\"clangModuleMapPath\": \"%swift-lib-dir/swift/shims/module.modulemap\"," >> %/t/inputs/map.json
50+
// RUN: echo "\"clangModulePath\": \"%t/inputs/_SwiftConcurrencyShims.pcm\"" >> %/t/inputs/map.json
51+
// RUN: echo "}," >> %/t/inputs/map.json
52+
// RUN: echo "{" >> %/t/inputs/map.json
53+
// RUN: echo "\"moduleName\": \"_StringProcessing\"," >> %/t/inputs/map.json
54+
// RUN: echo "\"modulePath\": \"%/string_processing_module\"," >> %/t/inputs/map.json
55+
// RUN: echo "\"isFramework\": false" >> %/t/inputs/map.json
56+
// RUN: echo "}]" >> %/t/inputs/map.json
57+
58+
/// Create a module Foo that imports Cat aliased to Bar in the JSON above
59+
// RUN: %target-swift-frontend -module-name Foo %t/inputs/FileFoo.swift -I %t/inputs -emit-module -emit-module-path %t/outputs/Foo.swiftmodule -disable-implicit-swift-modules -explicit-swift-module-map-file %t/inputs/map.json -Rmodule-loading 2> %t/outputs/load-result.output
60+
61+
// RUN: test -f %t/outputs/Foo.swiftmodule
62+
// RUN: test -f %t/inputs/Bar.swiftmodule
63+
// RUN: not test -f %t/inputs/Cat.swiftmodule
64+
65+
// RUN: %FileCheck %s -input-file %t/outputs/load-result.output -check-prefix CHECK
66+
// CHECK: remark: loaded module {{.*}}Bar.swiftmodule

0 commit comments

Comments
 (0)