[Module aliasing] Serialize binary with module real name

elsh · elsh · commit 96fb3d61126a · 2021-10-12T13:59:34.000-07:00
Resolves rdar://83632529
diff --git a/include/swift/AST/FileUnit.h b/include/swift/AST/FileUnit.h
@@ -293,7 +293,7 @@ class FileUnit : public DeclContext, public ASTAllocated<FileUnit> {
   /// Usually this is the module name itself, but certain Clang features allow
   /// substituting another name instead.
   virtual StringRef getExportedModuleName() const {
-    return getParentModule()->getName().str();
+    return getParentModule()->getRealName().str();
   }
 
   /// Traverse the decls within this file.
diff --git a/lib/AST/Module.cpp b/lib/AST/Module.cpp
@@ -1501,7 +1501,7 @@ StringRef ModuleDecl::ReverseFullNameIterator::operator*() const {
   assert(current && "all name components exhausted");
 
   if (auto *swiftModule = current.dyn_cast<const ModuleDecl *>())
-    return swiftModule->getName().str();
+    return swiftModule->getRealName().str();
 
   auto *clangModule =
       static_cast<const clang::Module *>(current.get<const void *>());
diff --git a/lib/ClangImporter/ClangImporter.cpp b/lib/ClangImporter/ClangImporter.cpp
@@ -3582,7 +3582,7 @@ StringRef ClangModuleUnit::getExportedModuleName() const {
   if (clangModule && !clangModule->ExportAsModule.empty())
     return clangModule->ExportAsModule;
 
-  return getParentModule()->getName().str();
+  return getParentModule()->getRealName().str();
 }
 
 ModuleDecl *ClangModuleUnit::getOverlayModule() const {
diff --git a/lib/Serialization/Serialization.cpp b/lib/Serialization/Serialization.cpp
@@ -752,7 +752,7 @@ IdentifierID Serializer::addModuleRef(const ModuleDecl *module) {
   if (module == this->M->getASTContext().TheBuiltinModule)
     return BUILTIN_MODULE_ID;
   auto moduleName =
-      module->getASTContext().getIdentifier(module->getName().str());
+      module->getASTContext().getIdentifier(module->getRealName().str());
   return addDeclBaseNameRef(moduleName);
 }
 
@@ -961,7 +961,7 @@ void Serializer::writeHeader(const SerializationOptions &options) {
     control_block::RevisionLayout Revision(Out);
     control_block::IsOSSALayout IsOSSA(Out);
 
-    ModuleName.emit(ScratchRecord, M->getName().str());
+    ModuleName.emit(ScratchRecord, M->getRealName().str());
 
     SmallString<32> versionStringBuf;
     llvm::raw_svector_ostream versionString(versionStringBuf);
diff --git a/test/Frontend/Inputs/module_aliasing/Client.swift b/test/Frontend/Inputs/module_aliasing/Client.swift
@@ -0,0 +1,5 @@
+import Lib
+
+public func run() {
+  Lib.start()
+}
diff --git a/test/Frontend/Inputs/module_aliasing/Client_imports_Lib_and_AppleLogging.swift b/test/Frontend/Inputs/module_aliasing/Client_imports_Lib_and_AppleLogging.swift
@@ -0,0 +1,7 @@
+import AppleLogging
+import Lib
+
+public func run() {
+  Lib.start()
+}
+
diff --git a/test/Frontend/Inputs/module_aliasing/Client_imports_Lib_and_Logging.swift b/test/Frontend/Inputs/module_aliasing/Client_imports_Lib_and_Logging.swift
@@ -0,0 +1,6 @@
+import Logging
+import Lib
+
+public func run() {
+  Lib.start()
+}
diff --git a/test/Frontend/Inputs/module_aliasing/Lib.swift b/test/Frontend/Inputs/module_aliasing/Lib.swift
@@ -0,0 +1,5 @@
+import Logging
+
+public func start() {
+  Logging.setup()
+}
diff --git a/test/Frontend/Inputs/module_aliasing/Logging.swift b/test/Frontend/Inputs/module_aliasing/Logging.swift
@@ -0,0 +1,6 @@
+public struct Logger {
+  public init() {}
+}
+
+public func setup() -> Logging.Logger? { return Logger()
+}
diff --git a/test/Frontend/load-module-with-alias-chained-simple.swift b/test/Frontend/load-module-with-alias-chained-simple.swift
diff --git a/test/Frontend/load-module-with-alias-chained1.swift b/test/Frontend/load-module-with-alias-chained1.swift
diff --git a/test/Frontend/load-module-with-alias-chained2.swift b/test/Frontend/load-module-with-alias-chained2.swift
diff --git a/test/Frontend/module-alias-for-client.swift b/test/Frontend/module-alias-for-client.swift
@@ -0,0 +1,61 @@
+/// Test the -module-alias flag with the following scenario:
+/// Module 'Lib' imports module 'LoggingApple', and module 'ClientN' imports both 'Lib' and 'Logging'.
+/// 'Logging' can be aliased 'LoggingApple' via -module-alias.
+
+// RUN: %empty-directory(%t)
+
+/// Create Logging.swiftmodule
+// RUN: echo 'public struct Logger { }' > %t/FileLog.swift
+// RUN: echo 'public func setup() -> Logging.Logger? { return nil }' >> %t/FileLog.swift
+// RUN: %target-swift-frontend -module-name Logging %t/FileLog.swift -emit-module -emit-module-path %t/Logging.swiftmodule
+
+/// Check Logging.swiftmodule is created
+// RUN: test -f %t/Logging.swiftmodule
+
+/// Create LoggingApple.swiftmodule
+// RUN: echo 'public struct Logger { }' > %t/FileAppleLog.swift
+// RUN: echo 'public func setup() -> LoggingApple.Logger? { return nil }' >> %t/FileAppleLog.swift
+// RUN: echo 'public func pie() -> LoggingApple.Logger? { return nil }' >> %t/FileAppleLog.swift
+// RUN: %target-swift-frontend -module-name LoggingApple %t/FileAppleLog.swift -emit-module -emit-module-path %t/LoggingApple.swiftmodule
+
+/// Check LoggingApple.swiftmodule is created
+// RUN: test -f %t/LoggingApple.swiftmodule
+
+/// Create a module Lib that imports LoggingApple
+// RUN: echo 'import LoggingApple' > %t/FileLib.swift
+// RUN: echo 'public func start() { _ = LoggingApple.setup() }' >> %t/FileLib.swift
+// RUN: %target-swift-frontend -module-name Lib %t/FileLib.swift -I %t -emit-module -emit-module-path %t/Lib.swiftmodule -Rmodule-loading 2> %t/result-Lib.output
+
+/// Check Lib.swiftmodule is created and LoggingApple.swiftmodule is loaded
+// RUN: test -f %t/Lib.swiftmodule
+// RUN: %FileCheck %s -input-file %t/result-Lib.output -check-prefix CHECK-Lib
+// CHECK-Lib: remark: loaded module at {{.*}}LoggingApple.swiftmodule
+
+/// Create a module Client1 that imports both Lib and Logging, without module aliasing for Logging
+// RUN: echo 'import Logging' > %t/File.swift
+// RUN: echo 'import Lib' >> %t/File.swift
+// RUN: echo 'public func runLib() { Lib.start() }' >> %t/File.swift
+// RUN: echo 'public func runLog() { _ = Logging.setup() }' >> %t/File.swift
+// RUN: %target-swift-frontend -module-name Client1 %t/File.swift -I %t -emit-module -emit-module-path %t/Client1.swiftmodule -Rmodule-loading 2> %t/result-Client1.output
+
+/// Check Client1.swiftmodule is created and Lib.swiftmodule and Logging.swiftmodule are loaded
+// RUN: test -f %t/Client1.swiftmodule
+// RUN: %FileCheck %s -input-file %t/result-Client1.output -check-prefix CHECK-1
+// CHECK-1: remark: loaded module at {{.*}}Logging.swiftmodule
+// CHECK-1: remark: loaded module at {{.*}}Lib.swiftmodule
+
+/// Create a module Client2 that imports both Lib and Logging, with module aliasing for Logging
+// RUN: echo 'import Logging' > %t/File.swift
+// RUN: echo 'import Lib' >> %t/File.swift
+// RUN: echo 'public func runLib() { Lib.start() }' >> %t/File.swift
+// RUN: echo 'public func runLog() { _ = Logging.setup() }' >> %t/File.swift
+// RUN: %target-swift-frontend -module-name Client2 -module-alias Logging=LoggingApple %t/File.swift -I %t -emit-module -emit-module-path %t/Client2.swiftmodule -Rmodule-loading 2> %t/result-Client2.output
+
+/// Check Client2.swiftmodule is created and Lib.swiftmodule and LoggingApple.swiftmodule are loaded but
+/// Logging.swiftmodule is not loaded.
+// RUN: test -f %t/Client2.swiftmodule
+// RUN: %FileCheck %s -input-file %t/result-Client2.output -check-prefix CHECK-2A
+// CHECK-2A: remark: loaded module at {{.*}}LoggingApple.swiftmodule
+// CHECK-2A: remark: loaded module at {{.*}}Lib.swiftmodule
+// RUN: not %FileCheck %s -input-file %t/result-Client2.output -check-prefix CHECK-2B
+// CHECK-2B: remark: loaded module at {{.*}}Logging.swiftmodule
diff --git a/test/Frontend/module-alias-for-lib-and-client.swift b/test/Frontend/module-alias-for-lib-and-client.swift
@@ -0,0 +1,55 @@
+/// Test the -module-alias flag on the following scenario:
+/// Module 'Lib' imports module 'Logging', and module 'ClientN' imports both 'Lib' and 'Logging'.
+/// 'Logging' needs to be aliased due to a name collision, so is renamed 'AppleLogging'.
+
+// RUN: %empty-directory(%t)
+
+/// Input file with a reference to its enclosing module called Logging
+/// Create AppleLogging.swiftmodule by aliasing Logging via -module-alias Logging=AppleLogging
+// RUN: %target-swift-frontend -module-name AppleLogging -module-alias Logging=AppleLogging %S/Inputs/module_aliasing/Logging.swift -emit-module -emit-module-path %t/AppleLogging.swiftmodule
+
+/// Check AppleLogging.swiftmodule is created
+// RUN: test -f %t/AppleLogging.swiftmodule
+// RUN: not test -f %t/Logging.swiftmodule
+
+/// Create a module Lib that imports Logging with -module-alias Logging=AppleLogging
+// RUN: echo 'import Logging' > %t/FileLib.swift
+// RUN: echo 'public func start() { Logging.setup() }' >> %t/FileLib.swift
+// RUN: %target-swift-frontend -module-name Lib %S/Inputs/module_aliasing/Lib.swift -module-alias Logging=AppleLogging -I %t -emit-module -emit-module-path %t/Lib.swiftmodule -Rmodule-loading 2> %t/result-Lib.output
+
+/// Check Lib.swiftmodule is created and AppleLogging.swiftmodule is loaded
+// RUN: test -f %t/Lib.swiftmodule
+// RUN: test -f %t/AppleLogging.swiftmodule
+// RUN: not test -f %t/Logging.swiftmodule
+
+// RUN: %FileCheck %s -input-file %t/result-Lib.output -check-prefix CHECK-Lib
+// CHECK-Lib: remark: loaded module at {{.*}}AppleLogging.swiftmodule
+
+/// Create module Client1 that imports both Lib and Logging, with module aliasing for Logging
+// RUN: %target-swift-frontend -module-name Client1 %S/Inputs/module_aliasing/Client_imports_Lib_and_Logging.swift -module-alias Logging=AppleLogging -I %t -emit-module -emit-module-path %t/Client1.swiftmodule -Rmodule-loading 2>&1 | %FileCheck %s -check-prefix CHECK-1
+
+/// Check Client1.swiftmodule is created and Lib.swiftmodule and AppleLogging.swiftmodule are loaded
+// RUN: test -f %t/Client1.swiftmodule
+// RUN: test -f %t/Lib.swiftmodule
+// RUN: test -f %t/AppleLogging.swiftmodule
+// RUN: not test -f %t/Logging.swiftmodule
+// CHECK-1: remark: loaded module at {{.*}}AppleLogging.swiftmodule
+// CHECK-1: remark: loaded module at {{.*}}Lib.swiftmodule
+
+/// Try creating module Client2 that imports both Lib and Logging, without module aliasing
+// RUN: not %target-swift-frontend -module-name Client2 %S/Inputs/module_aliasing/Client_imports_Lib_and_Logging.swift -I %t -emit-module -emit-module-path %t/Client2.swiftmodule 2> %t/result-Client2.output
+
+/// Check that it fails
+// RUN: %FileCheck %s -input-file %t/result-Client2.output -check-prefix CHECK-2
+// CHECK-2: {{.*}}error: no such module 'Logging'
+
+/// Create module Client3 that imports both Lib and AppleLogging, without module aliasing
+// RUN: %target-swift-frontend -module-name Client3 %S/Inputs/module_aliasing/Client_imports_Lib_and_AppleLogging.swift -I %t -emit-module -emit-module-path %t/Client3.swiftmodule -Rmodule-loading 2>&1 | %FileCheck %s -check-prefix CHECK-3
+
+/// Check Client3.swiftmodule is created and correct modules are loaded
+// RUN: test -f %t/Client3.swiftmodule
+// RUN: test -f %t/Lib.swiftmodule
+// RUN: test -f %t/AppleLogging.swiftmodule
+// RUN: not test -f %t/Logging.swiftmodule
+// CHECK-3: remark: loaded module at {{.*}}AppleLogging.swiftmodule
+// CHECK-3: remark: loaded module at {{.*}}Lib.swiftmodule
diff --git a/test/Frontend/module-alias-interface.swift b/test/Frontend/module-alias-interface.swift
@@ -20,7 +20,7 @@
 
 // RUN: %FileCheck %s -input-file %t/FooInterface.swiftinterface -check-prefix CHECK-IMPORT
 // CHECK-IMPORT: -module-alias Cat=Baz
-// CHECK-IMPORT: import Cat
+// CHECK-IMPORT: import Baz
 
 // RUN: %FileCheck %s -input-file %t/load-result.output -check-prefix CHECK-LOAD
 // CHECK-LOAD: remark: loaded module at {{.*}}Baz.swiftmodule
diff --git a/test/Frontend/module-alias-load.swift b/test/Frontend/module-alias-load.swift
diff --git a/test/Frontend/module-alias-serialize.swift b/test/Frontend/module-alias-serialize.swift

Original file line number	Diff line number	Diff line change
`@@ -293,7 +293,7 @@ class FileUnit : public DeclContext, public ASTAllocated<FileUnit> {`
`293`	`293`	`/// Usually this is the module name itself, but certain Clang features allow`
`294`	`294`	`/// substituting another name instead.`
`295`	`295`	`virtual StringRef getExportedModuleName() const {`
`296`		`- return getParentModule()->getName().str();`
	`296`	`+ return getParentModule()->getRealName().str();`
`297`	`297`	`}`
`298`	`298`
`299`	`299`	`/// Traverse the decls within this file.`
Original file line number	Diff line number	Diff line change
`@@ -3582,7 +3582,7 @@ StringRef ClangModuleUnit::getExportedModuleName() const {`
`3582`	`3582`	`if (clangModule && !clangModule->ExportAsModule.empty())`
`3583`	`3583`	`return clangModule->ExportAsModule;`
`3584`	`3584`
`3585`		`- return getParentModule()->getName().str();`
	`3585`	`+ return getParentModule()->getRealName().str();`
`3586`	`3586`	`}`
`3587`	`3587`
`3588`	`3588`	`ModuleDecl *ClangModuleUnit::getOverlayModule() const {`