Merge pull request #20609 from rjmccall/pretty-stack-trace-conformance

rjmccall · web-flow · commit dd1130501f75 · 2018-11-15T19:31:25.000-05:00
[NFC] Add PrettyStackTraceConformance and use it
diff --git a/include/swift/AST/PrettyStackTrace.h b/include/swift/AST/PrettyStackTrace.h
@@ -33,7 +33,7 @@ namespace swift {
   class TypeRepr;
 
 void printSourceLocDescription(llvm::raw_ostream &out, SourceLoc loc,
-                               ASTContext &Context);
+                               ASTContext &Context, bool addNewline = true);
 
 /// PrettyStackTraceLocation - Observe that we are doing some
 /// processing starting at a fixed location.
@@ -48,7 +48,7 @@ class PrettyStackTraceLocation : public llvm::PrettyStackTraceEntry {
 };
 
 void printDeclDescription(llvm::raw_ostream &out, const Decl *D,
-                          ASTContext &Context);
+                          ASTContext &Context, bool addNewline = true);
 
 /// PrettyStackTraceDecl - Observe that we are processing a specific
 /// declaration.
@@ -62,7 +62,7 @@ class PrettyStackTraceDecl : public llvm::PrettyStackTraceEntry {
 };
 
 void printExprDescription(llvm::raw_ostream &out, Expr *E,
-                          ASTContext &Context);
+                          ASTContext &Context, bool addNewline = true);
 
 /// PrettyStackTraceExpr - Observe that we are processing a specific
 /// expression.
@@ -77,7 +77,7 @@ class PrettyStackTraceExpr : public llvm::PrettyStackTraceEntry {
 };
 
 void printStmtDescription(llvm::raw_ostream &out, Stmt *S,
-                          ASTContext &Context);
+                          ASTContext &Context, bool addNewline = true);
 
 /// PrettyStackTraceStmt - Observe that we are processing a specific
 /// statement.
@@ -92,7 +92,7 @@ class PrettyStackTraceStmt : public llvm::PrettyStackTraceEntry {
 };
 
 void printPatternDescription(llvm::raw_ostream &out, Pattern *P,
-                             ASTContext &Context);
+                             ASTContext &Context, bool addNewline = true);
 
 /// PrettyStackTracePattern - Observe that we are processing a
 /// specific pattern.
@@ -107,7 +107,7 @@ class PrettyStackTracePattern : public llvm::PrettyStackTraceEntry {
 };
 
 void printTypeDescription(llvm::raw_ostream &out, Type T,
-                          ASTContext &Context);
+                          ASTContext &Context, bool addNewline = true);
 
 /// PrettyStackTraceType - Observe that we are processing a specific type.
 class PrettyStackTraceType : public llvm::PrettyStackTraceEntry {
@@ -131,6 +131,23 @@ class PrettyStackTraceTypeRepr : public llvm::PrettyStackTraceEntry {
   virtual void print(llvm::raw_ostream &OS) const;
 };
 
+/// PrettyStackTraceConformance - Observe that we are processing a
+/// specific protocol conformance.
+class PrettyStackTraceConformance : public llvm::PrettyStackTraceEntry {
+  ASTContext &Context;
+  const ProtocolConformance *Conformance;
+  const char *Action;
+public:
+  PrettyStackTraceConformance(ASTContext &C, const char *action,
+                              const ProtocolConformance *conformance)
+    : Context(C), Conformance(conformance), Action(action) {}
+  virtual void print(llvm::raw_ostream &OS) const;
+};
+
+void printConformanceDescription(llvm::raw_ostream &out,
+                                 const ProtocolConformance *conformance,
+                                 ASTContext &Context, bool addNewline = true);
+
 class PrettyStackTraceGenericSignature : public llvm::PrettyStackTraceEntry {
   const char *Action;
   GenericSignature *GenericSig;
diff --git a/lib/AST/PrettyStackTrace.cpp b/lib/AST/PrettyStackTrace.cpp
@@ -21,6 +21,7 @@
 #include "swift/AST/GenericSignature.h"
 #include "swift/AST/Module.h"
 #include "swift/AST/Pattern.h"
+#include "swift/AST/ProtocolConformance.h"
 #include "swift/AST/Stmt.h"
 #include "swift/AST/PrettyStackTrace.h"
 #include "swift/AST/TypeVisitor.h"
@@ -40,7 +41,7 @@ void PrettyStackTraceDecl::print(llvm::raw_ostream &out) const {
 }
 
 void swift::printDeclDescription(llvm::raw_ostream &out, const Decl *D,
-                                 ASTContext &Context) {
+                                 ASTContext &Context, bool addNewline) {
   SourceLoc loc = D->getStartLoc();
   bool hasPrintedName = false;
   if (auto *named = dyn_cast<ValueDecl>(D)) {
@@ -94,12 +95,13 @@ void swift::printDeclDescription(llvm::raw_ostream &out, const Decl *D,
     out << "declaration " << (const void *)D;
 
   if (loc.isValid()) {
-    out << " at ";
+    out << " (at ";
     loc.print(out, Context.SourceMgr);
+    out << ')';
   } else {
-    out << " in module '" << D->getModuleContext()->getName() << '\'';
+    out << " (in module '" << D->getModuleContext()->getName() << "')";
   }
-  out << '\n';
+  if (addNewline) out << '\n';
 }
 
 void PrettyStackTraceExpr::print(llvm::raw_ostream &out) const {
@@ -112,10 +114,10 @@ void PrettyStackTraceExpr::print(llvm::raw_ostream &out) const {
 }
 
 void swift::printExprDescription(llvm::raw_ostream &out, Expr *E,
-                                 ASTContext &Context) {
+                                 ASTContext &Context, bool addNewline) {
   out << "expression at ";
   E->getSourceRange().print(out, Context.SourceMgr);
-  out << '\n';
+  if (addNewline) out << '\n';
 }
 
 void PrettyStackTraceStmt::print(llvm::raw_ostream &out) const {
@@ -128,10 +130,10 @@ void PrettyStackTraceStmt::print(llvm::raw_ostream &out) const {
 }
 
 void swift::printStmtDescription(llvm::raw_ostream &out, Stmt *S,
-                                 ASTContext &Context) {
+                                 ASTContext &Context, bool addNewline) {
   out << "statement at ";
   S->getSourceRange().print(out, Context.SourceMgr);
-  out << '\n';
+  if (addNewline) out << '\n';
 }
 
 void PrettyStackTracePattern::print(llvm::raw_ostream &out) const {
@@ -144,10 +146,10 @@ void PrettyStackTracePattern::print(llvm::raw_ostream &out) const {
 }
 
 void swift::printPatternDescription(llvm::raw_ostream &out, Pattern *P,
-                                    ASTContext &Context) {
+                                    ASTContext &Context, bool addNewline) {
   out << "pattern at ";
   P->getSourceRange().print(out, Context.SourceMgr);
-  out << '\n';
+  if (addNewline) out << '\n';
 }
 
 namespace {
@@ -183,7 +185,7 @@ void PrettyStackTraceType::print(llvm::raw_ostream &out) const {
 }
 
 void swift::printTypeDescription(llvm::raw_ostream &out, Type type,
-                                 ASTContext &Context) {
+                                 ASTContext &Context, bool addNewline) {
   out << "type '" << type << '\'';
   if (Decl *decl = InterestingDeclForType().visit(type)) {
     if (decl->getSourceRange().isValid()) {
@@ -192,7 +194,7 @@ void swift::printTypeDescription(llvm::raw_ostream &out, Type type,
       out << ')';
     }
   }
-  out << '\n';
+  if (addNewline) out << '\n';
 }
 
 void PrettyStackTraceTypeRepr::print(llvm::raw_ostream &out) const {
@@ -205,10 +207,31 @@ void PrettyStackTraceTypeRepr::print(llvm::raw_ostream &out) const {
   out << '\n';
 }
 
+void PrettyStackTraceConformance::print(llvm::raw_ostream &out) const {
+  out << "While " << Action << ' ';
+  printConformanceDescription(out, Conformance, Context);
+}
+
+void swift::printConformanceDescription(llvm::raw_ostream &out,
+                                        const ProtocolConformance *conformance,
+                                        ASTContext &ctxt, bool addNewline) {
+  if (!conformance) {
+    out << "NULL protocol conformance!";
+    if (addNewline) out << '\n';
+    return;
+  }
+
+  out << "protocol conformance to ";
+  printDeclDescription(out, conformance->getProtocol(), ctxt, /*newline*/false);
+  out << " for ";
+  printTypeDescription(out, conformance->getType(), ctxt, addNewline);
+}
+
 void swift::printSourceLocDescription(llvm::raw_ostream &out,
-                                      SourceLoc loc, ASTContext &ctx) {
+                                      SourceLoc loc, ASTContext &ctx,
+                                      bool addNewline) {
   loc.print(out, ctx.SourceMgr);
-  out << '\n';
+  if (addNewline) out << '\n';
 }
 
 void PrettyStackTraceLocation::print(llvm::raw_ostream &out) const {
diff --git a/lib/ClangImporter/ImportDecl.cpp b/lib/ClangImporter/ImportDecl.cpp
@@ -7788,9 +7788,8 @@ void ClangImporter::Implementation::finishNormalConformance(
   (void)unused;
 
   auto *proto = conformance->getProtocol();
-  PrettyStackTraceType trace(SwiftContext, "completing conformance for",
-                             conformance->getType());
-  PrettyStackTraceDecl traceTo("... to", proto);
+  PrettyStackTraceConformance trace(SwiftContext, "completing import of",
+                                    conformance);
 
   if (!proto->isRequirementSignatureComputed())
     proto->computeRequirementSignature();
diff --git a/lib/IRGen/GenProto.cpp b/lib/IRGen/GenProto.cpp
@@ -2203,9 +2203,7 @@ void IRGenModule::emitSILWitnessTable(SILWitnessTable *wt) {
     return;
 
   auto conf = wt->getConformance();
-  PrettyStackTraceType stackTraceRAII(Context, "emitting witness table for",
-                                      conf->getType());
-  PrettyStackTraceDecl stackTraceRAII2("...conforming to", conf->getProtocol());
+  PrettyStackTraceConformance _st(Context, "emitting witness table for", conf);
 
   // Build the witness table.
   ConstantInitBuilder builder(*this);
diff --git a/lib/Sema/TypeCheckProtocol.cpp b/lib/Sema/TypeCheckProtocol.cpp
@@ -4321,9 +4321,7 @@ void TypeChecker::useBridgedNSErrorConformances(DeclContext *dc, Type type) {
 }
 
 void TypeChecker::checkConformance(NormalProtocolConformance *conformance) {
-  PrettyStackTraceType trace1(Context, "checking conformance of",
-                              conformance->getType());
-  PrettyStackTraceDecl trace2("...to", conformance->getProtocol());
+  PrettyStackTraceConformance trace(Context, "type-checking", conformance);
 
   MultiConformanceChecker checker(*this);
   checker.addConformance(conformance);
@@ -4336,9 +4334,8 @@ void TypeChecker::checkConformanceRequirements(
   if (conformance->isInvalid())
     return;
 
-  PrettyStackTraceType trace1(Context, "checking conformance requirements of",
-                              conformance->getType());
-  PrettyStackTraceDecl trace2("...to", conformance->getProtocol());
+  PrettyStackTraceConformance trace(Context, "checking requirements of",
+                                    conformance);
 
   conformance->setSignatureConformances({ });
 
diff --git a/lib/Serialization/Deserialization.cpp b/lib/Serialization/Deserialization.cpp
@@ -5183,10 +5183,9 @@ void ModuleFile::finishNormalConformance(NormalProtocolConformance *conformance,
   using namespace decls_block;
 
   PrettyStackTraceModuleFile traceModule("While reading from", *this);
-  PrettyStackTraceType trace(getAssociatedModule()->getASTContext(),
-                             "finishing conformance for",
-                             conformance->getType());
-  PrettyStackTraceDecl traceTo("... to", conformance->getProtocol());
+  PrettyStackTraceConformance trace(getAssociatedModule()->getASTContext(),
+                                    "finishing conformance for",
+                                    conformance);
   ++NumNormalProtocolConformancesCompleted;
 
   assert(conformance->isComplete());
diff --git a/lib/Serialization/DeserializeSIL.cpp b/lib/Serialization/DeserializeSIL.cpp
@@ -2947,10 +2947,9 @@ SILWitnessTable *SILDeserializer::readWitnessTable(DeclID WId,
   auto theConformance = cast<RootProtocolConformance>(
                           MF->readConformance(SILCursor).getConcrete());
 
-  PrettyStackTraceType trace(SILMod.getASTContext(),
-                             "deserializing SIL witness table for",
-                             theConformance->getType());
-  PrettyStackTraceDecl trace2("... to", theConformance->getProtocol());
+  PrettyStackTraceConformance trace(SILMod.getASTContext(),
+                                    "deserializing SIL witness table for",
+                                    theConformance);
 
   if (!existingWt)
     existingWt = SILMod.lookUpWitnessTable(theConformance, false);
diff --git a/test/Serialization/Recovery/crash-recovery.swift b/test/Serialization/Recovery/crash-recovery.swift
@@ -17,4 +17,4 @@ public class Sub: Base {
 // 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
-// CHECK-CRASH: While loading members for 'Sub' in module 'Lib'
+// CHECK-CRASH: While loading members for 'Sub' (in module 'Lib')
