Merge pull request swiftlang#31055 from xymus/note-misc-version

[Serialization] Note the misc version field of modules on deserialization failures

Author: xymus

include/swift/AST/DiagnosticsSema.def

@@ -751,6 +751,9 @@ ERROR(serialization_fatal,Fatal,
       "fatal error encountered while reading from module '%0'; "
       "please file a bug report with your project and the crash log",
       (StringRef))
+NOTE(serialization_misc_version,none,
+     "module '%0' full misc version is '%1'",
+     (StringRef, StringRef))
 NOTE(serialization_compatibility_version_mismatch,none,
      "compiling as Swift %0, with '%1' built as Swift %2 "
      "(this is supported but may expose additional compiler issues)",

include/swift/Serialization/Validation.h

@@ -77,6 +77,7 @@ struct ValidationInfo {
   StringRef name = {};
   StringRef targetTriple = {};
   StringRef shortVersion = {};
+  StringRef miscVersion = {};
   version::Version compatibilityVersion = {};
   size_t bytes = 0;
   Status status = Status::Malformed;

lib/Serialization/Deserialization.cpp

@@ -167,6 +167,8 @@ static void skipRecord(llvm::BitstreamCursor &cursor, unsigned recordKind) {
 void ModuleFile::fatal(llvm::Error error) {
   if (FileContext) {
     getContext().Diags.diagnose(SourceLoc(), diag::serialization_fatal, Name);
+    getContext().Diags.diagnose(SourceLoc(), diag::serialization_misc_version,
+      Name, MiscVersion);
 
     if (!CompatibilityVersion.empty()) {
       if (getContext().LangOpts.EffectiveLanguageVersion

lib/Serialization/ModuleFile.cpp

@@ -274,6 +274,7 @@ validateControlBlock(llvm::BitstreamCursor &cursor,
         break;
       }
 
+      result.miscVersion = blobData;
       versionSeen = true;
       break;
     }
@@ -1673,6 +1674,7 @@ ModuleFile::ModuleFile(
       TargetTriple = info.targetTriple;
       CompatibilityVersion = info.compatibilityVersion;
       IsSIB = extInfo->isSIB();
+      MiscVersion = info.miscVersion;
 
       hasValidControlBlock = true;
       break;

lib/Serialization/ModuleFile.h

@@ -100,6 +100,10 @@ class ModuleFile
   /// modules, which are assumed to contain canonical SIL for an entire module.
   bool IsSIB = false;
 
+  // Full blob from the misc. version field of the metadata block. This should
+  // include the version string of the compiler that built the module.
+  StringRef MiscVersion;
+
 public:
   /// Represents another module that has been imported as a dependency.
   class Dependency {

test/Serialization/Recovery/crash-recovery.swift

@@ -13,7 +13,8 @@ public class Sub: Base {
 }
 
 // CHECK-CRASH: error: fatal error encountered while reading from module 'Lib'; please file a bug report with your project and the crash log
-// CHECK-CRASH-4-NOT: note
+// CHECK-CRASH: note: module 'Lib' full misc version is
+// CHECK-CRASH-4-NOT: note: compiling as
 // CHECK-CRASH-4_2: note: compiling as Swift 4.2, with 'Lib' built as Swift 4.1.50
 // CHECK-CRASH-LABEL: *** DESERIALIZATION FAILURE (please include this section in any bug report) ***
 // CHECK-CRASH: could not find 'disappearingMethod()' in parent class