[Indexing] Use module real name in case module aliasing is used

elsh · elsh · commit 0ff713d44c06 · 2021-12-07T02:22:36.000-08:00
Resolves rdar://82896373
diff --git a/include/swift/AST/Module.h b/include/swift/AST/Module.h
@@ -869,8 +869,19 @@ class ModuleEntity {
   ModuleEntity(const ModuleDecl *Mod) : Mod(Mod) {}
   ModuleEntity(const clang::Module *Mod) : Mod(static_cast<const void *>(Mod)){}
 
-  StringRef getName() const;
-  std::string getFullName() const;
+  // @param useRealNameIfAliased Whether to use the module's real name in case
+  //                             module aliasing is used. For example, if a file
+  //                             has `import Foo` and `-module-alias Foo=Bar` is
+  //                             passed, treat Foo as an alias and Bar as the real
+  //                             module name as its dependency. This only applies
+  //                             to Swift modules.
+  // @return The module name; for Swift modules, the real module name could be
+  //         different from the name if module aliasing is used.
+  StringRef getName(bool useRealNameIfAliased = false) const;
+
+  // For Swift modules, it returns the same result as \c ModuleEntity::getName(bool).
+  // For Clang modules, it returns the result of \c clang::Module::getFullModuleName.
+  std::string getFullName(bool useRealNameIfAliased = false) const;
 
   bool isSystemModule() const;
   bool isBuiltinModule() const;
diff --git a/include/swift/AST/USRGeneration.h b/include/swift/AST/USRGeneration.h
@@ -47,8 +47,14 @@ bool printDeclTypeUSR(const ValueDecl *D, raw_ostream &OS);
 bool printValueDeclUSR(const ValueDecl *D, raw_ostream &OS);
 
 /// Prints out the USR for the given ModuleEntity.
+/// \param useRealNameIfAliased Whether to use the module's real name in case
+///                             module aliasing is used. For example, if a file
+///                             has `import Foo` and `-module-alias Foo=Bar` is
+///                             passed, treat Foo as an alias and Bar as the real
+///                             module name as its dependency. This only applies
+///                             to Swift modules.
 /// \returns true if it failed, false on success.
-bool printModuleUSR(ModuleEntity Mod, raw_ostream &OS);
+bool printModuleUSR(ModuleEntity Mod, raw_ostream &OS, bool useRealNameIfAliased = false);
 
 /// Prints out the accessor USR for the given storage Decl.
 /// \returns true if it failed, false on success.
diff --git a/lib/AST/Module.cpp b/lib/AST/Module.cpp
@@ -3073,17 +3073,17 @@ getClangModule(llvm::PointerUnion<const ModuleDecl *, const void *> Union) {
   return static_cast<const clang::Module *>(Union.get<const void *>());
 }
 
-StringRef ModuleEntity::getName() const {
+StringRef ModuleEntity::getName(bool useRealNameIfAliased) const {
   assert(!Mod.isNull());
   if (auto SwiftMod = Mod.dyn_cast<const ModuleDecl*>())
-    return SwiftMod->getName().str();
+    return useRealNameIfAliased ? SwiftMod->getRealName().str() : SwiftMod->getName().str();
   return getClangModule(Mod)->Name;
 }
 
-std::string ModuleEntity::getFullName() const {
+std::string ModuleEntity::getFullName(bool useRealNameIfAliased) const {
   assert(!Mod.isNull());
   if (auto SwiftMod = Mod.dyn_cast<const ModuleDecl*>())
-    return std::string(SwiftMod->getName());
+    return std::string(useRealNameIfAliased ? SwiftMod->getRealName() : SwiftMod->getName());
   return getClangModule(Mod)->getFullModuleName();
 }
 
diff --git a/lib/AST/USRGeneration.cpp b/lib/AST/USRGeneration.cpp
@@ -278,9 +278,9 @@ swift::MangleLocalTypeDeclRequest::evaluate(Evaluator &evaluator,
   return NewMangler.mangleLocalTypeDecl(D);
 }
 
-bool ide::printModuleUSR(ModuleEntity Mod, raw_ostream &OS) {
+bool ide::printModuleUSR(ModuleEntity Mod, raw_ostream &OS, bool useRealNameIfAliased) {
   if (auto *D = Mod.getAsSwiftModule()) {
-    StringRef moduleName = D->getName().str();
+    StringRef moduleName = useRealNameIfAliased ? D->getRealName().str() : D->getNameStr();
     return clang::index::generateFullUSRForTopLevelModuleName(moduleName, OS);
   } else if (auto ClangM = Mod.getAsClangModule()) {
     return clang::index::generateFullUSRForModule(ClangM, OS);
diff --git a/lib/Index/Index.cpp b/lib/Index/Index.cpp
@@ -482,14 +482,14 @@ class IndexSwiftASTWalker : public SourceEntityWalker {
       SmallString<128> storage;
       {
         llvm::raw_svector_ostream OS(storage);
-        if (ide::printModuleUSR(Mod, OS))
+        if (ide::printModuleUSR(Mod, OS, /*useRealNameIfAliased=*/true))
           return true;
         result.USR = stringStorage.copyString(OS.str());
       }
       storage.clear();
       {
         llvm::raw_svector_ostream OS(storage);
-        OS << Mod.getFullName();
+        OS << Mod.getFullName(/*useRealNameIfAliased=*/true);
         result.name = stringStorage.copyString(OS.str());
       }
     }
@@ -1119,8 +1119,11 @@ bool IndexSwiftASTWalker::visitImports(
     if (!IsClangModuleOpt.hasValue())
       continue;
     bool IsClangModule = *IsClangModuleOpt;
-
-    StringRef ModuleName = Mod->getNameStr();
+    // Use module real name in case module aliasing is used.
+    // For example, if a file being indexed has `import Foo`
+    // and `-module-alias Foo=Bar` is passed, treat Foo as an
+    // alias and Bar as the real module name as its dependency.
+    StringRef ModuleName = Mod->getRealName().str();
 
     // If this module is an underscored cross-import overlay, use the name
     // of the underlying module that declared it instead.
diff --git a/lib/Index/IndexRecord.cpp b/lib/Index/IndexRecord.cpp
@@ -413,7 +413,11 @@ static void addModuleDependencies(ArrayRef<ImportedModule> imports,
       case FileUnitKind::ClangModule: {
         auto *LFU = cast<LoadedFile>(FU);
         if (auto F = fileMgr.getFile(LFU->getFilename())) {
-          StringRef moduleName = mod->getNameStr();
+          // Use module real name for unit writer in case module aliasing
+          // is used. For example, if a file being indexed has `import Foo`
+          // and `-module-alias Foo=Bar` is passed, treat Foo as an alias
+          // and Bar as the real module name as its dependency.
+          StringRef moduleName = mod->getRealName().str();
           bool withoutUnitName = true;
           if (FU->getKind() == FileUnitKind::ClangModule) {
             auto clangModUnit = cast<ClangModuleUnit>(LFU);
@@ -611,7 +615,6 @@ recordSourceFileUnit(SourceFile *primarySourceFile, StringRef indexUnitToken,
   // FIXME: Get real values for the following.
   StringRef swiftVersion;
   StringRef sysrootPath = clangCI.getHeaderSearchOpts().Sysroot;
-
   IndexUnitWriter unitWriter(
       fileMgr, indexStorePath, "swift", swiftVersion, indexUnitToken,
       module->getNameStr(), mainFile ? *mainFile : nullptr, isSystem,
diff --git a/test/Index/module-alias-indexing.swift b/test/Index/module-alias-indexing.swift
@@ -0,0 +1,84 @@
+// RUN: %empty-directory(%t)
+// RUN: %{python} %utils/split_file.py -o %t %s
+
+// RUN: %target-swift-frontend %t/FileLogging.swift -module-name AppleLogging -module-alias XLogging=AppleLogging -emit-module -o %t/AppleLogging.swiftmodule -index-store-path %t/indexResult
+// RUN: %target-swift-frontend -typecheck %t/FileLib.swift -module-alias XLogging=AppleLogging -I %t -index-store-path %t/indexResult
+
+// RUN: c-index-test core -print-unit %t/indexResult > %t/indexUnitDump.txt
+// RUN: %FileCheck %s -input-file %t/indexUnitDump.txt -check-prefix CHECK-UNIT
+
+// RUN: c-index-test core -print-record %t/indexResult > %t/indexRecordDump.txt
+// RUN: %FileCheck %s -input-file %t/indexRecordDump.txt -check-prefix CHECK-RECORD
+
+// BEGIN FileLogging.swift
+public struct Logger {
+  public init() {}
+}
+
+public func setup() -> XLogging.Logger? {
+  return Logger()
+}
+
+// BEGIN FileLib.swift
+import XLogging
+
+public func start() {
+  _ = XLogging.setup()
+}
+
+
+// CHECK-UNIT: [[MODA:--[A-Z0-9]*]]
+// CHECK-UNIT: --------
+// CHECK-UNIT: module-name: FileLib
+// CHECK-UNIT: has-main: 1
+// CHECK-UNIT: main-path: {{.*}}{{/|\\}}FileLib.swift
+// CHECK-UNIT: out-file: -
+// CHECK-UNIT: DEPEND START
+// CHECK-UNIT: Unit | system | Swift | {{.*}}{{/|\\}}Swift.swiftmodule
+// CHECK-UNIT: Unit | user | AppleLogging | {{.*}}{{/|\\}}AppleLogging.swiftmodule
+// CHECK-UNIT: Record | user | {{.*}}{{/|\\}}FileLib.swift | [[MODA:FileLib.swift-[A-Z0-9]*]]
+// CHECK-UNIT: DEPEND END
+
+// CHECK-UNIT: [[MODA:AppleLogging.swiftmodule-[A-Z0-9]*]]
+// CHECK-UNIT: --------
+// CHECK-UNIT: module-name: AppleLogging
+// CHECK-UNIT: has-main: 1
+// CHECK-UNIT: main-path: {{.*}}{{/|\\}}FileLogging.swift
+// CHECK-UNIT: out-file: {{.*}}{{/|\\}}AppleLogging.swiftmodule
+// CHECK-UNIT: DEPEND START
+// CHECK-UNIT: Unit | system | Swift | {{.*}}{{/|\\}}Swift.swiftmodule
+// CHECK-UNIT: Record | user | {{.*}}{{/|\\}}FileLogging.swift | [[MODA:FileLogging.swift-[A-Z0-9]*]]
+// CHECK-UNIT: DEPEND END
+
+// CHECK-RECORD: FileLib.swift
+// CHECK-RECORD: ------------
+// CHECK-RECORD: module/Swift | AppleLogging | c:@M@AppleLogging | <no-cgname> | Ref,RelCont -
+// CHECK-RECORD: function/Swift | start() | s:7FileLib5startyyF | <no-cgname> | Def - RelCall,RelCont
+// CHECK-RECORD: function/Swift | setup() | s:12AppleLogging5setupAA6LoggerVSgyF | <no-cgname> | Ref,Call,RelCall,RelCont -
+// CHECK-RECORD: ------------
+// CHECK-RECORD: 1:8 | module/Swift | c:@M@AppleLogging | Ref | rel: 0
+// CHECK-RECORD: 3:13 | function/Swift | s:7FileLib5startyyF | Def | rel: 0
+// CHECK-RECORD: 4:7 | module/Swift | c:@M@AppleLogging | Ref,RelCont | rel: 1
+// CHECK-RECORD:   RelCont | s:7FileLib5startyyF
+// CHECK-RECORD: 4:16 | function/Swift | s:12AppleLogging5setupAA6LoggerVSgyF | Ref,Call,RelCall,RelCont | rel: 1
+// CHECK-RECORD:   RelCall,RelCont | s:7FileLib5startyyF
+
+// CHECK-RECORD: FileLogging.swift
+// CHECK-RECORD: ------------
+// CHECK-RECORD: struct/Swift | Logger | s:12AppleLogging6LoggerV | <no-cgname> | Def,Ref,RelCont - RelChild
+// CHECK-RECORD: constructor/Swift | init() | s:12AppleLogging6LoggerVACycfc | <no-cgname> | Def,Ref,Call,RelChild,RelCall,RelCont -
+// CHECK-RECORD: function/Swift | setup() | s:12AppleLogging5setupAA6LoggerVSgyF | <no-cgname> | Def - RelCall,RelCont
+// CHECK-RECORD: ------------
+// CHECK-RECORD: 1:15 | struct/Swift | s:12AppleLogging6LoggerV | Def | rel: 0
+// CHECK-RECORD: 2:10 | constructor/Swift | s:12AppleLogging6LoggerVACycfc | Def,RelChild | rel: 1
+// CHECK-RECORD:   RelChild | s:12AppleLogging6LoggerV
+// CHECK-RECORD: 5:13 | function/Swift | s:12AppleLogging5setupAA6LoggerVSgyF | Def | rel: 0
+// CHECK-RECORD: 5:24 | module/Swift | c:@M@AppleLogging | Ref,RelCont | rel: 1
+// CHECK-RECORD:   RelCont | s:12AppleLogging5setupAA6LoggerVSgyF
+// CHECK-RECORD: 5:33 | struct/Swift | s:12AppleLogging6LoggerV | Ref,RelCont | rel: 1
+// CHECK-RECORD:   RelCont | s:12AppleLogging5setupAA6LoggerVSgyF
+// CHECK-RECORD: 6:10 | struct/Swift | s:12AppleLogging6LoggerV | Ref,RelCont | rel: 1
+// CHECK-RECORD:   RelCont | s:12AppleLogging5setupAA6LoggerVSgyF
+// CHECK-RECORD: 6:10 | constructor/Swift | s:12AppleLogging6LoggerVACycfc | Ref,Call,RelCall,RelCont | rel: 1
+// CHECK-RECORD:   RelCall,RelCont | s:12AppleLogging5setupAA6LoggerVSgyF
+

Original file line number	Diff line number	Diff line change
`@@ -3073,17 +3073,17 @@ getClangModule(llvm::PointerUnion<const ModuleDecl , const void > Union) {`
`3073`	`3073`	`return static_cast<const clang::Module >(Union.get<const void >());`
`3074`	`3074`	`}`
`3075`	`3075`
`3076`		`-StringRef ModuleEntity::getName() const {`
	`3076`	`+StringRef ModuleEntity::getName(bool useRealNameIfAliased) const {`
`3077`	`3077`	`assert(!Mod.isNull());`
`3078`	`3078`	`if (auto SwiftMod = Mod.dyn_cast<const ModuleDecl*>())`
`3079`		`- return SwiftMod->getName().str();`
	`3079`	`+ return useRealNameIfAliased ? SwiftMod->getRealName().str() : SwiftMod->getName().str();`
`3080`	`3080`	`return getClangModule(Mod)->Name;`
`3081`	`3081`	`}`
`3082`	`3082`
`3083`		`-std::string ModuleEntity::getFullName() const {`
	`3083`	`+std::string ModuleEntity::getFullName(bool useRealNameIfAliased) const {`
`3084`	`3084`	`assert(!Mod.isNull());`
`3085`	`3085`	`if (auto SwiftMod = Mod.dyn_cast<const ModuleDecl*>())`
`3086`		`- return std::string(SwiftMod->getName());`
	`3086`	`+ return std::string(useRealNameIfAliased ? SwiftMod->getRealName() : SwiftMod->getName());`
`3087`	`3087`	`return getClangModule(Mod)->getFullModuleName();`
`3088`	`3088`	`}`
`3089`	`3089`
Original file line number	Diff line number	Diff line change
`@@ -482,14 +482,14 @@ class IndexSwiftASTWalker : public SourceEntityWalker {`
`482`	`482`	`SmallString<128> storage;`
`483`	`483`	`{`
`484`	`484`	`llvm::raw_svector_ostream OS(storage);`
`485`		`- if (ide::printModuleUSR(Mod, OS))`
	`485`	`+ if (ide::printModuleUSR(Mod, OS, /useRealNameIfAliased=/true))`
`486`	`486`	`return true;`
`487`	`487`	`result.USR = stringStorage.copyString(OS.str());`
`488`	`488`	`}`
`489`	`489`	`storage.clear();`
`490`	`490`	`{`
`491`	`491`	`llvm::raw_svector_ostream OS(storage);`
`492`		`- OS << Mod.getFullName();`
	`492`	`+ OS << Mod.getFullName(/useRealNameIfAliased=/true);`
`493`	`493`	`result.name = stringStorage.copyString(OS.str());`
`494`	`494`	`}`
`495`	`495`	`}`
`@@ -1119,8 +1119,11 @@ bool IndexSwiftASTWalker::visitImports(`
`1119`	`1119`	`if (!IsClangModuleOpt.hasValue())`
`1120`	`1120`	`continue;`
`1121`	`1121`	`bool IsClangModule = *IsClangModuleOpt;`
`1122`		`-`
`1123`		`- StringRef ModuleName = Mod->getNameStr();`
	`1122`	`+ // Use module real name in case module aliasing is used.`
	`1123`	+ // For example, if a file being indexed has `import Foo`
	`1124`	+ // and `-module-alias Foo=Bar` is passed, treat Foo as an
	`1125`	`+ // alias and Bar as the real module name as its dependency.`
	`1126`	`+ StringRef ModuleName = Mod->getRealName().str();`
`1124`	`1127`
`1125`	`1128`	`// If this module is an underscored cross-import overlay, use the name`
`1126`	`1129`	`// of the underlying module that declared it instead.`