Merge pull request #75704 from swiftlang/version-number-hack

DependencyScanner: report user module version in dependency scanning results for binary Swift modules

Author: nkcsgexi

include/swift-c/DependencyScan/DependencyScan.h

@@ -251,6 +251,9 @@ SWIFTSCAN_PUBLIC swiftscan_string_ref_t
 swiftscan_swift_binary_detail_get_module_cache_key(
     swiftscan_module_details_t details);
 
+SWIFTSCAN_PUBLIC swiftscan_string_ref_t
+swiftscan_swift_binary_detail_get_user_module_version(
+    swiftscan_module_details_t details);
 //=== Swift Placeholder Module Details query APIs -------------------------===//
 
 SWIFTSCAN_PUBLIC swiftscan_string_ref_t

include/swift/AST/ModuleDependencies.h

@@ -398,14 +398,15 @@ class SwiftBinaryModuleDependencyStorage
       ArrayRef<ScannerImportStatementInfo> optionalModuleImports,
       ArrayRef<LinkLibrary> linkLibraries, StringRef headerImport,
       StringRef definingModuleInterface, bool isFramework, bool isStatic,
-      StringRef moduleCacheKey)
+      StringRef moduleCacheKey, StringRef userModuleVersion)
       : ModuleDependencyInfoStorageBase(ModuleDependencyKind::SwiftBinary,
                                         moduleImports, optionalModuleImports,
                                         linkLibraries, moduleCacheKey),
         compiledModulePath(compiledModulePath), moduleDocPath(moduleDocPath),
         sourceInfoPath(sourceInfoPath), headerImport(headerImport),
         definingModuleInterfacePath(definingModuleInterface),
-        isFramework(isFramework), isStatic(isStatic) {}
+        isFramework(isFramework), isStatic(isStatic),
+        userModuleVersion(userModuleVersion) {}
 
   ModuleDependencyInfoStorageBase *clone() const override {
     return new SwiftBinaryModuleDependencyStorage(*this);
@@ -439,6 +440,9 @@ class SwiftBinaryModuleDependencyStorage
   /// A flag that indicates this dependency is associated with a static archive
   const bool isStatic;
 
+  /// The user module version of this binary module.
+  const std::string userModuleVersion;
+
   /// Return the path to the defining .swiftinterface of this module
   /// of one was determined. Otherwise, return the .swiftmodule path
   /// itself.
@@ -604,12 +608,13 @@ class ModuleDependencyInfo {
       ArrayRef<ScannerImportStatementInfo> optionalModuleImports,
       ArrayRef<LinkLibrary> linkLibraries, StringRef headerImport,
       StringRef definingModuleInterface, bool isFramework,
-      bool isStatic, StringRef moduleCacheKey) {
+      bool isStatic, StringRef moduleCacheKey, StringRef userModuleVer) {
     return ModuleDependencyInfo(
         std::make_unique<SwiftBinaryModuleDependencyStorage>(
             compiledModulePath, moduleDocPath, sourceInfoPath, moduleImports,
             optionalModuleImports, linkLibraries, headerImport,
-            definingModuleInterface,isFramework, isStatic, moduleCacheKey));
+            definingModuleInterface,isFramework, isStatic, moduleCacheKey,
+            userModuleVer));
   }
 
   /// Describe the main Swift module.

include/swift/DependencyScan/DependencyScanImpl.h

@@ -166,6 +166,9 @@ typedef struct {
 
   /// ModuleCacheKey
   swiftscan_string_ref_t module_cache_key;
+
+  /// User module version
+  swiftscan_string_ref_t user_module_version;
 } swiftscan_swift_binary_details_t;
 
 /// Swift placeholder modules carry additional details that specify their

include/swift/DependencyScan/SerializedModuleDependencyCacheFormat.h

@@ -178,7 +178,8 @@ using SwiftBinaryModuleDetailsLayout =
                    FileIDArrayIDField,               // headerSourceFiles
                    IsFrameworkField,                 // isFramework
                    IsStaticField,                    // isStatic
-                   IdentifierIDField                 // moduleCacheKey
+                   IdentifierIDField,                // moduleCacheKey
+                   IdentifierIDField                 // UserModuleVersion
                    >;
 
 using SwiftPlaceholderModuleDetailsLayout =

lib/DependencyScan/DependencyScanJSON.cpp

@@ -550,6 +550,10 @@ void writeJSON(llvm::raw_ostream &out,
                            swiftBinaryDeps->compiled_module_path,
                            /*indentLevel=*/5,
                            /*trailingComma=*/true);
+      writeJSONSingleField(out, "userModuleVersion",
+                           swiftBinaryDeps->user_module_version,
+                           /*indentLevel=*/5,
+                           /*trailingComma=*/true);
       // Module doc file
       if (swiftBinaryDeps->module_doc_path.data &&
           get_C_string(swiftBinaryDeps->module_doc_path)[0] != '\0')

lib/DependencyScan/ModuleDependencyCacheSerialization.cpp

@@ -490,13 +490,13 @@ bool ModuleDependenciesCacheDeserializer::readGraph(SwiftDependencyScanningServi
                overlayDependencyIDArrayID, headerImportID,
                headerModuleDependenciesArrayID,
                headerImportsSourceFilesArrayID, isFramework, isStatic,
-               moduleCacheKeyID;
+               moduleCacheKeyID, userModuleVersionID;
       SwiftBinaryModuleDetailsLayout::readRecord(
           Scratch, compiledModulePathID, moduleDocPathID,
           moduleSourceInfoPathID, overlayDependencyIDArrayID,
           headerImportID, headerModuleDependenciesArrayID,
           headerImportsSourceFilesArrayID, isFramework, isStatic,
-          moduleCacheKeyID);
+          moduleCacheKeyID, userModuleVersionID);
 
       auto compiledModulePath = getIdentifier(compiledModulePathID);
       if (!compiledModulePath)
@@ -510,6 +510,9 @@ bool ModuleDependenciesCacheDeserializer::readGraph(SwiftDependencyScanningServi
       auto moduleCacheKey = getIdentifier(moduleCacheKeyID);
       if (!moduleCacheKey)
         llvm::report_fatal_error("Bad moduleCacheKey");
+      auto userModuleVersion = getIdentifier(userModuleVersionID);
+      if (!userModuleVersion)
+        llvm::report_fatal_error("Bad userModuleVersion");
       auto headerImport = getIdentifier(headerImportID);
       if (!headerImport)
         llvm::report_fatal_error("Bad binary direct dependencies: no header import");
@@ -519,7 +522,7 @@ bool ModuleDependenciesCacheDeserializer::readGraph(SwiftDependencyScanningServi
       auto moduleDep = ModuleDependencyInfo::forSwiftBinaryModule(
            *compiledModulePath, *moduleDocPath, *moduleSourceInfoPath,
            currentModuleImports, currentOptionalModuleImports, {},
-           *headerImport, "", isFramework, isStatic, *moduleCacheKey);
+           *headerImport, "", isFramework, isStatic, *moduleCacheKey, *userModuleVersion);
 
       auto headerModuleDependencies = getStringArray(headerModuleDependenciesArrayID);
       if (!headerModuleDependencies)
@@ -1050,7 +1053,8 @@ void ModuleDependenciesCacheSerializer::writeModuleInfo(
         getArrayID(moduleID, ModuleIdentifierArrayKind::HeaderInputModuleDependencies),
         getArrayID(moduleID, ModuleIdentifierArrayKind::HeaderInputDependencySourceFiles),
         swiftBinDeps->isFramework, swiftBinDeps->isStatic,
-        getIdentifier(swiftBinDeps->moduleCacheKey));
+        getIdentifier(swiftBinDeps->moduleCacheKey),
+        getIdentifier(swiftBinDeps->userModuleVersion));
 
     break;
   }

lib/DependencyScan/ScanDependencies.cpp

@@ -761,7 +761,8 @@ generateFullDependencyGraph(const CompilerInstance &instance,
             create_set(swiftBinaryDeps->headerSourceFiles),
             swiftBinaryDeps->isFramework,
             swiftBinaryDeps->isStatic,
-            create_clone(swiftBinaryDeps->moduleCacheKey.c_str())};
+            create_clone(swiftBinaryDeps->moduleCacheKey.c_str()),
+            create_clone(swiftBinaryDeps->userModuleVersion.c_str())};
       } else {
         // Clang module details
         details->kind = SWIFTSCAN_DEPENDENCY_INFO_CLANG;

lib/Serialization/ModuleFileSharedCore.h

@@ -623,6 +623,10 @@ class ModuleFileSharedCore {
     return Bits.IsStaticLibrary;
   }
 
+  llvm::VersionTuple getUserModuleVersion() const {
+    return UserModuleVersion;
+  }
+
   /// If the module-defining `.swiftinterface` file is an SDK-relative path,
   /// resolve it to be absolute to the specified SDK.
   std::string resolveModuleDefiningFilePath(const StringRef SDKPath) const;

lib/Serialization/SerializedModuleLoader.cpp

@@ -515,12 +515,13 @@ SerializedModuleLoaderBase::scanModuleFile(Twine modulePath, bool isFramework,
   std::string definingModulePath =
        loadedModuleFile->resolveModuleDefiningFilePath(Ctx.SearchPathOpts.getSDKPath());
 
+  std::string userModuleVer = loadedModuleFile->getUserModuleVersion().getAsString();
   // Map the set of dependencies over to the "module dependencies".
   auto dependencies = ModuleDependencyInfo::forSwiftBinaryModule(
       modulePath.str(), moduleDocPath, sourceInfoPath, moduleImports,
       optionalModuleImports, linkLibraries, importedHeader,
       definingModulePath, isFramework, loadedModuleFile->isStaticLibrary(),
-      /*module-cache-key*/ "");
+      /*module-cache-key*/ "", userModuleVer);
 
   return std::move(dependencies);
 }

test/ScanDependencies/binary_framework_dependency.swift

@@ -23,6 +23,7 @@ import Foo
 // CHECK-NEXT:      "directDependencies": [
 // CHECK:      "details": {
 // CHECK-NEXT:        "swiftPrebuiltExternal": {
-// CHECK-NEXT:          "compiledModulePath": 
+// CHECK-NEXT:          "compiledModulePath":
+// CHECK-NEXT:          "userModuleVersion":
 // CHECK-NEXT:          "isFramework": true
 // CHECK-NEXT:        }

test/ScanDependencies/scan_return_module_version_textual_interface.swift

@@ -0,0 +1,23 @@
+// REQUIRES: objc_interop
+// RUN: %empty-directory(%t)
+// RUN: %empty-directory(%t/clang-module-cache)
+// RUN: %empty-directory(%t/DependencyModules)
+
+// Emit a textual module dependency
+// RUN: %target-swift-frontend -emit-module -emit-module-path %t/DependencyModules/Foo.swiftmodule -module-cache-path %t/clang-module-cache -module-name Foo %s -D FOO -user-module-version 42.3.3
+
+// RUN: %target-swift-frontend -scan-dependencies -module-cache-path %t/clang-module-cache %s -o %t/deps.json -I %t/DependencyModules/ -module-name main
+
+// Check the contents of the JSON output
+// RUN: %FileCheck -check-prefix CHECK %s < %t/deps.json
+
+#if FOO
+
+public func foo() {}
+
+#else
+import Foo
+
+#endif
+
+// CHECK:  "userModuleVersion": "42.3.3.0"

tools/libSwiftScan/libSwiftScan.cpp

@@ -88,6 +88,8 @@ void swiftscan_dependency_info_details_dispose(
         details_impl->swift_binary_details.header_dependency);
     swiftscan_string_dispose(
         details_impl->swift_binary_details.module_cache_key);
+    swiftscan_string_dispose(
+        details_impl->swift_binary_details.user_module_version);
     break;
   case SWIFTSCAN_DEPENDENCY_INFO_SWIFT_PLACEHOLDER:
     swiftscan_string_dispose(
@@ -437,6 +439,11 @@ swiftscan_string_ref_t swiftscan_swift_binary_detail_get_module_cache_key(
   return details->swift_binary_details.module_cache_key;
 }
 
+SWIFTSCAN_PUBLIC swiftscan_string_ref_t
+swiftscan_swift_binary_detail_get_user_module_version(
+    swiftscan_module_details_t details) {
+  return details->swift_binary_details.user_module_version;
+}
 
 //=== Swift Placeholder Module Details query APIs -------------------------===//
 

tools/libSwiftScan/libSwiftScan.exports

@@ -32,6 +32,7 @@ swiftscan_swift_binary_detail_get_header_dependency
 swiftscan_swift_binary_detail_get_header_dependency_module_dependencies
 swiftscan_swift_binary_detail_get_is_framework
 swiftscan_swift_binary_detail_get_module_cache_key
+swiftscan_swift_binary_detail_get_user_module_version
 swiftscan_swift_placeholder_detail_get_compiled_module_path
 swiftscan_swift_placeholder_detail_get_module_doc_path
 swiftscan_swift_placeholder_detail_get_module_source_info_path