Merge pull request #62116 from artemcm/DepScanSwiftOutputPath

[Dependency Scanning] Produce canonical output path for Swift binary modules.

Author: artemcm

include/swift/AST/ModuleDependencies.h

@@ -125,6 +125,9 @@ struct CommonSwiftTextualModuleDependencyDetails {
 class SwiftInterfaceModuleDependenciesStorage :
   public ModuleDependenciesStorageBase {
 public:
+  /// Destination output path
+  const std::string moduleOutputPath;
+
   /// The Swift interface file to be used to generate the module file.
   const std::string swiftInterfaceFile;
 
@@ -145,13 +148,15 @@ class SwiftInterfaceModuleDependenciesStorage :
   CommonSwiftTextualModuleDependencyDetails textualModuleDetails;
 
   SwiftInterfaceModuleDependenciesStorage(
+      const std::string moduleOutputPath,
       const std::string swiftInterfaceFile,
       ArrayRef<std::string> compiledModuleCandidates,
       ArrayRef<StringRef> buildCommandLine,
       ArrayRef<StringRef> extraPCMArgs,
       StringRef contextHash,
       bool isFramework
   ) : ModuleDependenciesStorageBase(ModuleDependenciesKind::SwiftInterface),
+      moduleOutputPath(moduleOutputPath),
       swiftInterfaceFile(swiftInterfaceFile),
       compiledModuleCandidates(compiledModuleCandidates.begin(),
                                compiledModuleCandidates.end()),
@@ -340,15 +345,16 @@ class ModuleDependencies {
   /// Describe the module dependencies for a Swift module that can be
   /// built from a Swift interface file (\c .swiftinterface).
   static ModuleDependencies forSwiftInterfaceModule(
-      std::string swiftInterfaceFile,
+      const std::string &moduleOutputPath,
+      const std::string &swiftInterfaceFile,
       ArrayRef<std::string> compiledCandidates,
       ArrayRef<StringRef> buildCommands,
       ArrayRef<StringRef> extraPCMArgs,
       StringRef contextHash,
       bool isFramework) {
     return ModuleDependencies(
         std::make_unique<SwiftInterfaceModuleDependenciesStorage>(
-          swiftInterfaceFile, compiledCandidates, buildCommands,
+          moduleOutputPath, swiftInterfaceFile, compiledCandidates, buildCommands,
           extraPCMArgs, contextHash, isFramework));
   }
 

include/swift/DependencyScan/SerializedModuleDependencyCacheFormat.h

@@ -124,7 +124,8 @@ using ModuleInfoLayout =
 
 using SwiftInterfaceModuleDetailsLayout =
     BCRecordLayout<SWIFT_INTERFACE_MODULE_DETAILS_NODE, // ID
-                   FileIDField,                       // swiftInterfaceFile
+                   FileIDField,        // outputFilePath
+                   FileIDField,        // swiftInterfaceFile
                    FileIDArrayIDField, // compiledModuleCandidates
                    FlagIDArrayIDField, // buildCommandLine
                    FlagIDArrayIDField, // extraPCMArgs

include/swift/Serialization/ModuleDependencyScanner.h

@@ -37,16 +37,21 @@ namespace swift {
           Twine moduleInterfacePath, bool isFramework);
 
       InterfaceSubContextDelegate &astDelegate;
+
+      /// Location where pre-built moduels are to be built into.
+      std::string moduleCachePath;
     public:
       Optional<ModuleDependencies> dependencies;
 
-      ModuleDependencyScanner(
-          ASTContext &ctx, ModuleLoadingMode LoadMode, Identifier moduleName,
-          InterfaceSubContextDelegate &astDelegate,
-          ScannerKind kind = MDS_plain)
+      ModuleDependencyScanner(ASTContext &ctx, ModuleLoadingMode LoadMode,
+                              Identifier moduleName,
+                              InterfaceSubContextDelegate &astDelegate,
+                              ScannerKind kind = MDS_plain)
           : SerializedModuleLoaderBase(ctx, nullptr, LoadMode,
                                        /*IgnoreSwiftSourceInfoFile=*/true),
-            kind(kind), moduleName(moduleName), astDelegate(astDelegate) {}
+            kind(kind), moduleName(moduleName), astDelegate(astDelegate),
+            moduleCachePath(getModuleCachePathFromClang(
+                ctx.getClangModuleLoader()->getClangInstance())) {}
 
       std::error_code findModuleFilesInDirectory(
           ImportPath::Element ModuleID,

lib/DependencyScan/ModuleDependencyCacheSerialization.cpp

@@ -227,16 +227,19 @@ bool Deserializer::readGraph(GlobalModuleDependenciesCache &cache) {
         llvm::report_fatal_error(
             "Unexpected SWIFT_TEXTUAL_MODULE_DETAILS_NODE record");
       cache.configureForTriple(getTriple());
-      unsigned interfaceFileID, compiledModuleCandidatesArrayID,
+      unsigned outputPathFileID, interfaceFileID, compiledModuleCandidatesArrayID,
           buildCommandLineArrayID, extraPCMArgsArrayID, contextHashID,
           isFramework, bridgingHeaderFileID, sourceFilesArrayID,
           bridgingSourceFilesArrayID, bridgingModuleDependenciesArrayID;
       SwiftInterfaceModuleDetailsLayout::readRecord(
-          Scratch, interfaceFileID, compiledModuleCandidatesArrayID,
+          Scratch, outputPathFileID, interfaceFileID, compiledModuleCandidatesArrayID,
           buildCommandLineArrayID, extraPCMArgsArrayID, contextHashID,
           isFramework, bridgingHeaderFileID, sourceFilesArrayID,
           bridgingSourceFilesArrayID, bridgingModuleDependenciesArrayID);
 
+      auto outputModulePath = getIdentifier(outputPathFileID);
+      if (!outputModulePath)
+         llvm::report_fatal_error("Bad .swiftmodule output path");
       Optional<std::string> optionalSwiftInterfaceFile;
       if (interfaceFileID != 0) {
         auto swiftInterfaceFile = getIdentifier(interfaceFileID);
@@ -267,6 +270,7 @@ bool Deserializer::readGraph(GlobalModuleDependenciesCache &cache) {
 
       // Form the dependencies storage object
       auto moduleDep = ModuleDependencies::forSwiftInterfaceModule(
+          outputModulePath.getValue(),
           optionalSwiftInterfaceFile.getValue(), *compiledModuleCandidates,
           buildCommandRefs, extraPCMRefs, *contextHash, isFramework);
 
@@ -782,6 +786,8 @@ void Serializer::writeModuleInfo(ModuleDependencyID moduleID,
     assert(triple.hasValue() && "Expected triple for serializing MODULE_NODE");
     auto swiftTextDeps = dependencyInfo.getAsSwiftInterfaceModule();
     assert(swiftTextDeps);
+    unsigned outputModulePathFileId =
+        getIdentifier(swiftTextDeps->moduleOutputPath);
     unsigned swiftInterfaceFileId =
         getIdentifier(swiftTextDeps->swiftInterfaceFile);
     unsigned bridgingHeaderFileId =
@@ -791,6 +797,7 @@ void Serializer::writeModuleInfo(ModuleDependencyID moduleID,
             : 0;
     SwiftInterfaceModuleDetailsLayout::emitRecord(
         Out, ScratchRecord, AbbrCodes[SwiftInterfaceModuleDetailsLayout::Code],
+        outputModulePathFileId,
         swiftInterfaceFileId,
         getArray(moduleID, ModuleIdentifierArrayKind::CompiledModuleCandidates),
         getArray(moduleID, ModuleIdentifierArrayKind::BuildCommandLine),
@@ -981,6 +988,7 @@ void Serializer::collectStringsAndArrays(
         case swift::ModuleDependenciesKind::SwiftInterface: {
           auto swiftTextDeps = dependencyInfo.getAsSwiftInterfaceModule();
           assert(swiftTextDeps);
+          addIdentifier(swiftTextDeps->moduleOutputPath);
           addIdentifier(swiftTextDeps->swiftInterfaceFile);
           addArray(moduleID,
                    ModuleIdentifierArrayKind::CompiledModuleCandidates,

lib/DependencyScan/ScanDependencies.cpp

@@ -590,7 +590,7 @@ static void writeJSON(llvm::raw_ostream &out,
       modulePath = get_C_string(swiftPlaceholderDeps->compiled_module_path);
     else if (swiftBinaryDeps)
       modulePath = get_C_string(swiftBinaryDeps->compiled_module_path);
-    else if (clangDeps)
+    else if (clangDeps || swiftTextualDeps)
       modulePath = get_C_string(moduleInfo.module_path);
     else
       modulePath = moduleName + modulePathSuffix;
@@ -829,7 +829,9 @@ generateFullDependencyGraph(CompilerInstance &instance,
     const char *modulePathSuffix =
         moduleDeps.isSwiftModule() ? ".swiftmodule" : ".pcm";
     std::string modulePath;
-    if (swiftPlaceholderDeps)
+    if (swiftTextualDeps)
+      modulePath = swiftTextualDeps->moduleOutputPath;
+    else if (swiftPlaceholderDeps)
       modulePath = swiftPlaceholderDeps->compiledModulePath;
     else if (swiftBinaryDeps)
       modulePath = swiftBinaryDeps->compiledModulePath;
@@ -1261,6 +1263,9 @@ bool swift::dependencies::scanDependencies(CompilerInstance &instance) {
   if (opts.ReuseDependencyScannerCache)
     deserializeDependencyCache(instance, globalCache);
 
+  auto ModuleCachePath = getModuleCachePathFromClang(
+               Context.getClangModuleLoader()->getClangInstance());
+
   ModuleDependenciesCache cache(globalCache,
                                 instance.getMainModule()->getNameStr());
 

lib/Serialization/ModuleDependencyScanner.cpp

@@ -118,12 +118,15 @@ ErrorOr<ModuleDependencies> ModuleDependencyScanner::scanInterfaceFile(
     std::string InPath = moduleInterfacePath.str();
     auto compiledCandidates = getCompiledCandidates(Ctx, realModuleName.str(),
                                                     InPath);
-    Result = ModuleDependencies::forSwiftInterfaceModule(InPath,
-                                                   compiledCandidates,
-                                                   Args,
-                                                   PCMArgs,
-                                                   Hash,
-                                                   isFramework);
+
+    SmallString<128> outputPathBase(moduleCachePath);
+    llvm::sys::path::append(
+        outputPathBase,
+        moduleName.str() + "-" + Hash + "." +
+            file_types::getExtension(file_types::TY_SwiftModuleFile));
+    Result = ModuleDependencies::forSwiftInterfaceModule(
+        outputPathBase.str().str(), InPath, compiledCandidates, Args, PCMArgs,
+        Hash, isFramework);
     // Open the interface file.
     auto &fs = *Ctx.SourceMgr.getFileSystem();
     auto interfaceBuf = fs.getBufferForFile(moduleInterfacePath);

test/ModuleInterface/clang-args-transitive-availability.swift

@@ -25,7 +25,7 @@ import ImportsMacroSpecificClangModule
 //CHECK:      "swift": "ImportsMacroSpecificClangModule"
 //CHECK-NEXT:    },
 //CHECK-NEXT:    {
-//CHECK-NEXT:      "modulePath": "ImportsMacroSpecificClangModule.swiftmodule",
+//CHECK-NEXT:      "modulePath": "{{.*}}{{/|\\}}ImportsMacroSpecificClangModule-{{.*}}.swiftmodule",
 //CHECK-NEXT:      "sourceFiles": [
 //CHECK-NEXT:      ],
 //CHECK-NEXT:      "directDependencies": [

test/ModuleInterface/extension-transitive-availability.swift

@@ -27,7 +27,7 @@ func foo() {
 // CHECK:      "swift": "ExtensionAvailable"
 // CHECK-NEXT:    },
 // CHECK-NEXT:    {
-// CHECK-NEXT:      "modulePath": "ExtensionAvailable.swiftmodule",
+// CHECK-NEXT:      "modulePath": "{{.*}}{{/|\\}}ExtensionAvailable-{{.*}}.swiftmodule",
 // CHECK-NEXT:      "sourceFiles": [
 // CHECK-NEXT:      ],
 // CHECK-NEXT:      "directDependencies": [

test/ScanDependencies/batch_module_scan.swift

@@ -27,7 +27,7 @@
 // CHECK-PCM-NEXT:      "clang": "F"
 // CHECK-PCM-NEXT:    },
 // CHECK-PCM-NEXT:    {
-// CHECK-PCM-NEXT:      "modulePath": "{{.*}}F-{{.*}}.pcm",
+// CHECK-PCM-NEXT:      "modulePath": "{{.*}}{{/|\\}}F-{{.*}}.pcm",
 // CHECK-PCM: "-I
 
 // CHECK-SWIFT: {
@@ -37,4 +37,4 @@
 // CHECK-SWIFT-NEXT:      "swift": "F"
 // CHECK-SWIFT-NEXT:    },
 // CHECK-SWIFT-NEXT:    {
-// CHECK-SWIFT-NEXT:      "modulePath": "F.swiftmodule",
+// CHECK-SWIFT-NEXT:      "modulePath": "{{.*}}{{/|\\}}F-{{.*}}.swiftmodule",

test/ScanDependencies/module_deps.swift

@@ -96,7 +96,7 @@ import SubE
 // CHECK-NEXT: ]
 
 /// --------Swift module A
-// CHECK-LABEL: "modulePath": "A.swiftmodule",
+// CHECK-LABEL: "modulePath": "{{.*}}{{/|\\}}A-{{.*}}.swiftmodule",
 
 // CHECK: directDependencies
 // CHECK-NEXT: {
@@ -145,7 +145,7 @@ import SubE
 
 /// --------Swift module E
 // CHECK: "swift": "E"
-// CHECK-LABEL: modulePath": "E.swiftmodule"
+// CHECK-LABEL: modulePath": "{{.*}}{{/|\\}}E-{{.*}}.swiftmodule"
 // CHECK: "directDependencies"
 // CHECK-NEXT: {
 // CHECK-NEXT: "swift": "Swift"
@@ -154,7 +154,7 @@ import SubE
 // CHECK-SAME: E.swiftinterface
 
 /// --------Swift module F
-// CHECK:      "modulePath": "F.swiftmodule",
+// CHECK:      "modulePath": "{{.*}}{{/|\\}}F-{{.*}}.swiftmodule",
 // CHECK-NEXT: "sourceFiles": [
 // CHECK-NEXT: ],
 // CHECK-NEXT: "directDependencies": [
@@ -170,7 +170,7 @@ import SubE
 // CHECK-NEXT: ],
 
 /// --------Swift module G
-// CHECK-LABEL: "modulePath": "G.swiftmodule"
+// CHECK-LABEL: "modulePath": "{{.*}}{{/|\\}}G-{{.*}}.swiftmodule"
 // CHECK: "directDependencies"
 // CHECK-NEXT: {
 // CHECK-NEXT:   "clang": "G"
@@ -202,7 +202,7 @@ import SubE
 // CHECK_CLANG_TARGET-NEXT:   ]
 
 /// --------Swift module Swift
-// CHECK-LABEL: "modulePath": "Swift.swiftmodule",
+// CHECK-LABEL: "modulePath": "{{.*}}{{/|\\}}Swift-{{.*}}.swiftmodule",
 
 // CHECK: directDependencies
 // CHECK-NEXT: {