Merge pull request #73828 from xymus/serial-fix-control-block

Serialization: Stop reading control block early on version mismatch and fix current control block ordering

Author: xymus

lib/Serialization/ModuleFileSharedCore.cpp

@@ -334,6 +334,12 @@ static ValidationInfo validateControlBlock(
         LLVM_FALLTHROUGH;
       case 3:
         result.shortVersion = blobData.slice(0, scratch[2]);
+
+        // If the format version doesn't match, give up after also getting the
+        // compiler version. This provides better diagnostics.
+        if (result.status != Status::Valid)
+          return result;
+
         LLVM_FALLTHROUGH;
       case 2:
       case 1:

lib/Serialization/ModuleFormat.h

@@ -58,8 +58,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 =
-    875; // Add package field to SerializedKind_t
+const uint16_t SWIFTMODULE_VERSION_MINOR = 876; // Reorder control block enum
 
 /// A standard hash seed used for all string hashes in a serialized module.
 ///
@@ -862,11 +861,11 @@ namespace control_block {
     MODULE_NAME,
     TARGET,
     SDK_NAME,
-    SDK_VERSION,
     REVISION,
-    CHANNEL,
     IS_OSSA,
     ALLOWABLE_CLIENT_NAME,
+    CHANNEL,
+    SDK_VERSION,
   };
 
   using MetadataLayout = BCRecordLayout<
@@ -897,21 +896,11 @@ namespace control_block {
     BCBlob
   >;
 
-  using SDKVersionLayout = BCRecordLayout<
-    SDK_VERSION,
-    BCBlob
-  >;
-
   using RevisionLayout = BCRecordLayout<
     REVISION,
     BCBlob
   >;
 
-  using ChannelLayout = BCRecordLayout<
-    CHANNEL,
-    BCBlob
-  >;
-
   using IsOSSALayout = BCRecordLayout<
     IS_OSSA,
     BCFixed<1>
@@ -921,6 +910,16 @@ namespace control_block {
     ALLOWABLE_CLIENT_NAME,
     BCBlob
   >;
+
+  using ChannelLayout = BCRecordLayout<
+    CHANNEL,
+    BCBlob
+  >;
+
+  using SDKVersionLayout = BCRecordLayout<
+    SDK_VERSION,
+    BCBlob
+  >;
 }
 
 /// The record types within the options block (a sub-block of the control

lib/Serialization/Serialization.cpp

@@ -834,11 +834,11 @@ void Serializer::writeBlockInfoBlock() {
   BLOCK_RECORD(control_block, MODULE_NAME);
   BLOCK_RECORD(control_block, TARGET);
   BLOCK_RECORD(control_block, SDK_NAME);
-  BLOCK_RECORD(control_block, SDK_VERSION);
   BLOCK_RECORD(control_block, REVISION);
-  BLOCK_RECORD(control_block, CHANNEL);
   BLOCK_RECORD(control_block, IS_OSSA);
   BLOCK_RECORD(control_block, ALLOWABLE_CLIENT_NAME);
+  BLOCK_RECORD(control_block, CHANNEL);
+  BLOCK_RECORD(control_block, SDK_VERSION);
 
   BLOCK(OPTIONS_BLOCK);
   BLOCK_RECORD(options_block, SDK_PATH);