Merge pull request #62185 from xymus/improve-rmodule-loading

Improve `-Rmodule-loading` to show both the path to the source and to the cached file actually loaded

Author: xymus

include/swift/AST/DiagnosticsSema.def

@@ -989,8 +989,10 @@ REMARK(cross_import_added,none,
        (Identifier, Identifier, Identifier))
 
 REMARK(module_loaded,none,
-       "loaded module at %0",
-       (StringRef))
+       "loaded module %0"
+       "%select{| (overlay for a clang dependency)}1"
+       "; source: '%2', loaded: '%3'",
+       (Identifier, unsigned, StringRef, StringRef))
 
 REMARK(explicit_interface_build_skipped,none,
        "Skipped rebuilding module at %0 - up-to-date",

include/swift/AST/FileUnit.h

@@ -404,6 +404,11 @@ class LoadedFile : public FileUnit {
   /// This is usually a filesystem path.
   virtual StringRef getFilename() const;
 
+  /// Get the path to the file loaded by the compiler. Usually the binary
+  /// swiftmodule file or a pcm in the cache. Returns an empty string if not
+  /// applicable.
+  virtual StringRef getLoadedFilename() const { return StringRef(); }
+
   virtual StringRef getFilenameForPrivateDecl(const ValueDecl *decl) const {
     return StringRef();
   }

include/swift/AST/Module.h

@@ -836,6 +836,17 @@ class ModuleDecl
   /// string if this is not applicable.
   StringRef getModuleFilename() const;
 
+  /// Get the path to the file defining this module, what we consider the
+  /// source of truth about the module. Usually a swiftinterface file for a
+  /// resilient module, a swiftmodule for a non-resilient module, or the
+  /// modulemap for a clang module. Returns an empty string if not applicable.
+  StringRef getModuleSourceFilename() const;
+
+  /// Get the path to the file loaded by the compiler. Usually the binary
+  /// swiftmodule file or a pcm in the cache. Returns an empty string if not
+  /// applicable.
+  StringRef getModuleLoadedFilename() const;
+
   /// \returns true if this module is the "swift" standard library module.
   bool isStdlibModule() const;
 

include/swift/ClangImporter/ClangModule.h

@@ -110,6 +110,8 @@ class ClangModuleUnit final : public LoadedFile {
 
   virtual StringRef getFilename() const override;
 
+  virtual StringRef getLoadedFilename() const override;
+
   virtual const clang::Module *getUnderlyingClangModule() const override {
     return getClangModule();
   }

include/swift/Serialization/SerializedModuleLoader.h

@@ -451,6 +451,8 @@ class SerializedASTFile final : public LoadedFile {
 
   virtual StringRef getFilename() const override;
 
+  virtual StringRef getLoadedFilename() const override;
+
   virtual StringRef getModuleDefiningPath() const override;
 
   ValueDecl *getMainDecl() const override;

lib/AST/ASTContext.cpp

@@ -2479,7 +2479,10 @@ ASTContext::getModule(ImportPath::Module ModulePath, bool AllowMemoryCached) {
       if (LangOpts.EnableModuleLoadingRemarks) {
         Diags.diagnose(ModulePath.getSourceRange().Start,
                        diag::module_loaded,
-                       M->getModuleFilename());
+                       M->getName(),
+                       /*overlay=*/false,
+                       M->getModuleSourceFilename(),
+                       M->getModuleLoadedFilename());
       }
       return M;
     }
@@ -2507,8 +2510,17 @@ ModuleDecl *ASTContext::getOverlayModule(const FileUnit *FU) {
   for (auto &importer : getImpl().ModuleLoaders) {
     if (importer.get() == getClangModuleLoader())
       continue;
-    if (ModuleDecl *M = importer->loadModule(SourceLoc(), ModPath))
+    if (ModuleDecl *M = importer->loadModule(SourceLoc(), ModPath)) {
+      if (LangOpts.EnableModuleLoadingRemarks) {
+        Diags.diagnose(SourceLoc(),
+                       diag::module_loaded,
+                       M->getName(),
+                       /*overlay=*/true,
+                       M->getModuleSourceFilename(),
+                       M->getModuleLoadedFilename());
+      }
       return M;
+    }
   }
 
   return nullptr;

lib/AST/Module.cpp

@@ -1965,6 +1965,25 @@ StringRef ModuleDecl::getModuleFilename() const {
   return Result;
 }
 
+StringRef ModuleDecl::getModuleSourceFilename() const {
+  for (auto F : getFiles()) {
+    if (auto *SFU = dyn_cast<SynthesizedFileUnit>(F))
+      continue;
+    return F->getModuleDefiningPath();
+  }
+
+  return StringRef();
+}
+
+StringRef ModuleDecl::getModuleLoadedFilename() const {
+  for (auto F : getFiles()) {
+    if (auto LF = dyn_cast<LoadedFile>(F)) {
+      return LF->getLoadedFilename();
+    }
+  }
+  return StringRef();
+}
+
 bool ModuleDecl::isStdlibModule() const {
   return !getParent() && getName() == getASTContext().StdlibModuleName;
 }

lib/ClangImporter/ClangImporter.cpp

@@ -3631,6 +3631,12 @@ StringRef ClangModuleUnit::getFilename() const {
   return StringRef();
 }
 
+StringRef ClangModuleUnit::getLoadedFilename() const {
+  if (const clang::FileEntry *F = clangModule->getASTFile())
+    return F->getName();
+  return StringRef();
+}
+
 clang::TargetInfo &ClangImporter::getTargetInfo() const {
   return Impl.Instance->getTarget();
 }

lib/Serialization/ModuleFile.h

@@ -712,6 +712,10 @@ class ModuleFile
     return Core->ModuleInputBuffer->getBufferIdentifier();
   }
 
+  StringRef getModuleLoadedFilename() const {
+    return Core->ModuleInputBuffer->getBufferIdentifier();
+  }
+
   StringRef getTargetTriple() const {
     return Core->TargetTriple;
   }

lib/Serialization/SerializedModuleLoader.cpp

@@ -1582,6 +1582,10 @@ StringRef SerializedASTFile::getFilename() const {
   return File.getModuleFilename();
 }
 
+StringRef SerializedASTFile::getLoadedFilename() const {
+  return File.getModuleLoadedFilename();
+}
+
 StringRef SerializedASTFile::getTargetTriple() const {
   return File.getTargetTriple();
 }