Merge pull request #37455 from nkcsgexi/user-module-subminor

Serialization: embed subminor and build version in the user module version entry

Author: nkcsgexi

lib/Serialization/ModuleFileSharedCore.cpp

@@ -255,9 +255,21 @@ validateControlBlock(llvm::BitstreamCursor &cursor,
       switch (scratch.size()) {
       default:
       // Add new cases here, in descending order.
+      case 8:
+      case 7:
       case 6:
       case 5: {
-        result.userModuleVersion = llvm::VersionTuple(scratch[4], scratch[5]);
+        auto subMinor = 0;
+        auto build = 0;
+        // case 7 and 8 were added after case 5 and 6, so we need to have this
+        // special handling to make sure we can still load the module without
+        // case 7 and case 8 successfully.
+        if (scratch.size() >= 8) {
+          subMinor = scratch[6];
+          build = scratch[7];
+        }
+        result.userModuleVersion = llvm::VersionTuple(scratch[4], scratch[5],
+                                                      subMinor, build);
         LLVM_FALLTHROUGH;
       }
       case 4:

lib/Serialization/ModuleFormat.h

@@ -56,7 +56,7 @@ const uint16_t SWIFTMODULE_VERSION_MAJOR = 0;
 /// describe what change you made. The content of this comment isn't important;
 /// it just ensures a conflict if two people change the module format.
 /// Don't worry about adhering to the 80-column limit for this line.
-const uint16_t SWIFTMODULE_VERSION_MINOR = 613; // isStaticLibrary option
+const uint16_t SWIFTMODULE_VERSION_MINOR = 614; // add subminor and build in user module version
 
 /// A standard hash seed used for all string hashes in a serialized module.
 ///
@@ -765,6 +765,8 @@ namespace control_block {
     BCVBR<8>, // length of "short compatibility version string" in the blob
     BCVBR<17>, // User module format major version
     BCVBR<17>, // User module format minor version
+    BCVBR<17>, // User module format sub-minor version
+    BCVBR<17>, // User module format build version
     BCBlob // misc. version information
   >;
 

lib/Serialization/Serialization.cpp

@@ -966,11 +966,20 @@ void Serializer::writeHeader(const SerializationOptions &options) {
     if (auto minor = options.UserModuleVersion.getMinor()) {
       userModuleMinor = *minor;
     }
+    auto userModuleSubminor = 0;
+    if (auto subMinor = options.UserModuleVersion.getSubminor()) {
+      userModuleSubminor = *subMinor;
+    }
+    auto userModuleBuild = 0;
+    if (auto build = options.UserModuleVersion.getBuild()) {
+      userModuleBuild = *build;
+    }
     Metadata.emit(ScratchRecord,
                   SWIFTMODULE_VERSION_MAJOR, SWIFTMODULE_VERSION_MINOR,
                   shortVersionStringLength,
                   compatibilityVersionStringLength,
                   userModuleMajor, userModuleMinor,
+                  userModuleSubminor, userModuleBuild,
                   versionString.str());
 
     Target.emit(ScratchRecord, M->getASTContext().LangOpts.Target.str());

lib/Serialization/SerializeDoc.cpp

@@ -493,7 +493,10 @@ void DocSerializer::writeDocHeader() {
     Metadata.emit(ScratchRecord, SWIFTDOC_VERSION_MAJOR, SWIFTDOC_VERSION_MINOR,
                   /*short version string length*/0, /*compatibility length*/0,
                   /*user module version major*/0,
-                  /*user module version minor*/0, verText);
+                  /*user module version minor*/0,
+                  /*user module version subminor*/0,
+                  /*user module version build*/0,
+                  verText);
 
     ModuleName.emit(ScratchRecord, M->getName().str());
     Target.emit(ScratchRecord, LangOpts.Target.str());
@@ -878,7 +881,10 @@ class SourceInfoSerializer : public SerializerBase {
                     SWIFTSOURCEINFO_VERSION_MINOR,
                     /*short version string length*/0, /*compatibility length*/0,
                     /*user module version major*/0,
-                    /*user module version minor*/0, verText);
+                    /*user module version minor*/0,
+                    /*user module version sub-minor*/0,
+                    /*user module version build*/0,
+                    verText);
 
       ModuleName.emit(ScratchRecord, M->getName().str());
       Target.emit(ScratchRecord, LangOpts.Target.str());

test/ModuleInterface/user-module-version.swift

@@ -3,7 +3,7 @@
 // RUN: %empty-directory(%t/binary)
 // RUN: %empty-directory(%t/module-cache)
 
-// RUN: %target-swift-frontend -emit-module %s -module-name Foo -swift-version 5 -disable-implicit-concurrency-module-import -user-module-version 113.33 -emit-module-interface-path %t/textual/Foo.swiftinterface -enable-library-evolution -emit-module-path %t/binary/Foo.swiftmodule
+// RUN: %target-swift-frontend -emit-module %s -module-name Foo -swift-version 5 -disable-implicit-concurrency-module-import -user-module-version 113.33.44.55 -emit-module-interface-path %t/textual/Foo.swiftinterface -enable-library-evolution -emit-module-path %t/binary/Foo.swiftmodule
 
 // RUN: %FileCheck %s --check-prefix=INTERFACE-FLAG < %t/textual/Foo.swiftinterface
 
@@ -15,6 +15,6 @@
 // RUN: %target-swift-frontend -compile-module-from-interface %t/textual/Foo.swiftinterface -o %t/binary/Foo.swiftmodule
 // RUN: %target-swift-ide-test -print-module-metadata -module-to-print Foo -I %t/binary -source-filename %s | %FileCheck %s --check-prefix=USER-MODULE-PRINT
 
-// INTERFACE-FLAG: -user-module-version 113.33
+// INTERFACE-FLAG: -user-module-version 113.33.44.55
 
-// USER-MODULE-PRINT: user module version: 113.33
+// USER-MODULE-PRINT: user module version: 113.33.44.55