[analyzer] [NFC] Move the code for dumping the program point to ProgramPoint

[george.karpenkov]

Summary

So we can dump them outside of viewing the exploded graph.

[NoQ]

Yay.

clang/include/clang/Analysis/ProgramPoint.h

218–220 ↗

(On Diff #167221)

Maybe retrieve Context from the ProgramPoint's LocationContext.

Most structures define a print method that receives a stream and newline/separator strings, and dump as a method that calls print with default parameters. I guess it's easier for debuggers to support, because default arguments are meh.

Also do we need some sort of LLVM_DUMP_METHOD here?

[NoQ]

Yup, something like that.

include/clang/Analysis/ProgramPoint.h

public:
   void Profile(llvm::FoldingSetNodeID& ID) const {
     ID.AddInteger((unsigned) getKind());
     ID.AddPointer(getData1());
     ID.AddPointer(getData2());
     ID.AddPointer(getLocationContext());
     ID.AddPointer(getTag());
   }
 
+  void print(StringRef CR, llvm::raw_ostream &Out) const;
+
+  LLVM_DUMP_METHOD void dump() const {
+    return print(/*CR=*/"\n", llvm::errs());
+  }
+
   static ProgramPoint getProgramPoint(const Stmt *S, ProgramPoint::Kind K,
                                       const LocationContext *LC,
                                       const ProgramPointTag *tag);
 };
 
 class BlockEntrance : public ProgramPoint {
 public:
   BlockEntrance(const CFGBlock *B, const LocationContext *L,

lib/Analysis/ProgramPoint.cpp

case ProgramPoint::PostLValueKind:
       return PostLValue(S, LC, tag);
     case ProgramPoint::PostStmtPurgeDeadSymbolsKind:
       return PostStmtPurgeDeadSymbols(S, LC, tag);
     case ProgramPoint::PreStmtPurgeDeadSymbolsKind:
       return PreStmtPurgeDeadSymbols(S, LC, tag);
   }
 }
 
+static void printLocation(raw_ostream &Out, SourceLocation SLoc,
+                          const SourceManager &SM,
+                          StringRef CR,
+                          StringRef Postfix) {
+  if (SLoc.isFileID()) {
+    Out << CR << "line=" << SM.getExpansionLineNumber(SLoc)
+        << " col=" << SM.getExpansionColumnNumber(SLoc) << Postfix;
+  }
+}
+
+void ProgramPoint::print(StringRef CR, llvm::raw_ostream &Out) const {
+  const ASTContext &Context =
+      getLocationContext()->getAnalysisDeclContext()->getASTContext();
+  const SourceManager &SM = Context.getSourceManager();
+  switch (getKind()) {
+  case ProgramPoint::BlockEntranceKind:
+    Out << "Block Entrance: B"
+        << castAs<BlockEntrance>().getBlock()->getBlockID();
+    break;
+
+  case ProgramPoint::FunctionExitKind: {
+    auto FEP = getAs<FunctionExitPoint>();
+    Out << "Function Exit: B" << FEP->getBlock()->getBlockID();
+    if (const ReturnStmt *RS = FEP->getStmt()) {
+      Out << CR << " Return: S" << RS->getID(Context) << CR;
+      RS->printPretty(Out, /*helper=*/nullptr, Context.getPrintingPolicy(),
+                      /*Indentation=*/2, /*NewlineSymbol=*/CR);
+    }
+    break;
+  }
+  case ProgramPoint::BlockExitKind:
+    assert(false);
+    break;
+
+  case ProgramPoint::CallEnterKind:
+    Out << "CallEnter";
+    break;
+
+  case ProgramPoint::CallExitBeginKind:
+    Out << "CallExitBegin";
+    break;
+
+  case ProgramPoint::CallExitEndKind:
+    Out << "CallExitEnd";
+    break;
+
+  case ProgramPoint::PostStmtPurgeDeadSymbolsKind:
+    Out << "PostStmtPurgeDeadSymbols";
+    break;
+
+  case ProgramPoint::PreStmtPurgeDeadSymbolsKind:
+    Out << "PreStmtPurgeDeadSymbols";
+    break;
+
+  case ProgramPoint::EpsilonKind:
+    Out << "Epsilon Point";
+    break;
+
+  case ProgramPoint::LoopExitKind: {
+    LoopExit LE = castAs<LoopExit>();
+    Out << "LoopExit: " << LE.getLoopStmt()->getStmtClassName();
+    break;
+  }
+
+  case ProgramPoint::PreImplicitCallKind: {
+    ImplicitCallPoint PC = castAs<ImplicitCallPoint>();
+    Out << "PreCall: ";
+    PC.getDecl()->print(Out, Context.getLangOpts());
+    printLocation(Out, PC.getLocation(), SM, CR, /*Postfix=*/CR);
+    break;
+  }
+
+  case ProgramPoint::PostImplicitCallKind: {
+    ImplicitCallPoint PC = castAs<ImplicitCallPoint>();
+    Out << "PostCall: ";
+    PC.getDecl()->print(Out, Context.getLangOpts());
+    printLocation(Out, PC.getLocation(), SM, CR, /*Postfix=*/CR);
+    break;
+  }
+
+  case ProgramPoint::PostInitializerKind: {
+    Out << "PostInitializer: ";
+    const CXXCtorInitializer *Init = castAs<PostInitializer>().getInitializer();
+    if (const FieldDecl *FD = Init->getAnyMember())
+      Out << *FD;
+    else {
+      QualType Ty = Init->getTypeSourceInfo()->getType();
+      Ty = Ty.getLocalUnqualifiedType();
+      Ty.print(Out, Context.getLangOpts());
+    }
+    break;
+  }
+
+  case ProgramPoint::BlockEdgeKind: {
+    const BlockEdge &E = castAs<BlockEdge>();
+    Out << "Edge: (B" << E.getSrc()->getBlockID() << ", B"
+        << E.getDst()->getBlockID() << ')';
+
+    if (const Stmt *T = E.getSrc()->getTerminator()) {
+      SourceLocation SLoc = T->getBeginLoc();
+
+      Out << "\\|Terminator: ";
+      E.getSrc()->printTerminator(Out, Context.getLangOpts());
+      printLocation(Out, SLoc, SM, CR, /*Postfix=*/"");
+
+      if (isa<SwitchStmt>(T)) {
+        const Stmt *Label = E.getDst()->getLabel();
+
+        if (Label) {
+          if (const auto *C = dyn_cast<CaseStmt>(Label)) {
+            Out << CR << "case ";
+            if (C->getLHS())
+              C->getLHS()->printPretty(
+                  Out, nullptr, Context.getPrintingPolicy(),
+                  /*Indentation=*/0, /*NewlineSymbol=*/CR);
+
+            if (const Stmt *RHS = C->getRHS()) {
+              Out << " .. ";
+              RHS->printPretty(Out, nullptr, Context.getPrintingPolicy(),
+                               /*Indetation=*/0, /*NewlineSymbol=*/CR);
+            }
+
+            Out << ":";
+          } else {
+            assert(isa<DefaultStmt>(Label));
+            Out << CR << "default:";
+          }
+        } else
+          Out << CR << "(implicit) default:";
+      } else if (isa<IndirectGotoStmt>(T)) {
+        // FIXME
+      } else {
+        Out << CR << "Condition: ";
+        if (*E.getSrc()->succ_begin() == E.getDst())
+          Out << "true";
+        else
+          Out << "false";
+      }
+
+      Out << CR;
+    }
+
+    break;
+  }
+
+  default: {
+    const Stmt *S = castAs<StmtPoint>().getStmt();
+    assert(S != nullptr && "Expecting non-null Stmt");
+
+    Out << S->getStmtClassName() << " S" << S->getID(Context) << " <"
+        << (const void *)S << "> ";
+    S->printPretty(Out, /*helper=*/nullptr, Context.getPrintingPolicy(),
+                   /*Indentation=*/2, /*NewlineSymbol=*/CR);
+    printLocation(Out, S->getBeginLoc(), SM, CR, /*Postfix=*/"");
+
+    if (getAs<PreStmt>())
+      Out << CR << "PreStmt" << CR;
+    else if (getAs<PostLoad>())
+      Out << CR << "PostLoad" << CR;
+    else if (getAs<PostStore>())
+      Out << CR << "PostStore" << CR;
+    else if (getAs<PostLValue>())
+      Out << CR << "PostLValue" << CR;
+    else if (getAs<PostAllocatorCall>())
+      Out << CR << "PostAllocatorCall" << CR;
+
+    break;
+  }
+  }
+}
+
 SimpleProgramPointTag::SimpleProgramPointTag(StringRef MsgProvider,
                                              StringRef Msg)
   : Desc((MsgProvider + " : " + Msg).str()) {}
 
 StringRef SimpleProgramPointTag::getTagDescription() const {
   return Desc;
 }

lib/StaticAnalyzer/Core/ExprEngine.cpp

struct DOTGraphTraits<ExplodedGraph*> : public DefaultDOTGraphTraits {
   // work.
   static std::string getNodeAttributes(const ExplodedNode *N,
                                        ExplodedGraph *G) {
     if (N->isSink())
       return "color=red";
     return {};
   }
 
-  // De-duplicate some source location pretty-printing.
-  static void printLocation(raw_ostream &Out,
-                            SourceLocation SLoc,
-                            const SourceManager &SM,
-                            StringRef Postfix="\\l") {
-    if (SLoc.isFileID()) {
-      Out << "\\lline="
-        << SM.getExpansionLineNumber(SLoc)
-        << " col="
-        << SM.getExpansionColumnNumber(SLoc)
-        << Postfix;
-    }
-  }
-
-  static void dumpProgramPoint(ProgramPoint Loc,
-                               const ASTContext &Context,
-                               llvm::raw_string_ostream &Out) {
-    const SourceManager &SM = Context.getSourceManager();
-    switch (Loc.getKind()) {
-    case ProgramPoint::BlockEntranceKind:
-      Out << "Block Entrance: B"
-          << Loc.castAs<BlockEntrance>().getBlock()->getBlockID();
-      break;
-
-    case ProgramPoint::FunctionExitKind: {
-      auto FEP = Loc.getAs<FunctionExitPoint>();
-      Out << "Function Exit: B"
-          << FEP->getBlock()->getBlockID();
-      if (const ReturnStmt *RS = FEP->getStmt()) {
-        Out << "\\l Return: S" << RS->getID(Context) << "\\l";
-        RS->printPretty(Out, /*helper=*/nullptr, Context.getPrintingPolicy(),
-                       /*Indentation=*/2, /*NewlineSymbol=*/"\\l");
-      }
-      break;
-    }
-    case ProgramPoint::BlockExitKind:
-      assert(false);
-      break;
-
-    case ProgramPoint::CallEnterKind:
-      Out << "CallEnter";
-      break;
-
-    case ProgramPoint::CallExitBeginKind:
-      Out << "CallExitBegin";
-      break;
-
-    case ProgramPoint::CallExitEndKind:
-      Out << "CallExitEnd";
-      break;
-
-    case ProgramPoint::PostStmtPurgeDeadSymbolsKind:
-      Out << "PostStmtPurgeDeadSymbols";
-      break;
-
-    case ProgramPoint::PreStmtPurgeDeadSymbolsKind:
-      Out << "PreStmtPurgeDeadSymbols";
-      break;
-
-    case ProgramPoint::EpsilonKind:
-      Out << "Epsilon Point";
-      break;
-
-    case ProgramPoint::LoopExitKind: {
-      LoopExit LE = Loc.castAs<LoopExit>();
-      Out << "LoopExit: " << LE.getLoopStmt()->getStmtClassName();
-      break;
-    }
-
-    case ProgramPoint::PreImplicitCallKind: {
-      ImplicitCallPoint PC = Loc.castAs<ImplicitCallPoint>();
-      Out << "PreCall: ";
-      PC.getDecl()->print(Out, Context.getLangOpts());
-      printLocation(Out, PC.getLocation(), SM);
-      break;
-    }
-
-    case ProgramPoint::PostImplicitCallKind: {
-      ImplicitCallPoint PC = Loc.castAs<ImplicitCallPoint>();
-      Out << "PostCall: ";
-      PC.getDecl()->print(Out, Context.getLangOpts());
-      printLocation(Out, PC.getLocation(), SM);
-      break;
-    }
-
-    case ProgramPoint::PostInitializerKind: {
-      Out << "PostInitializer: ";
-      const CXXCtorInitializer *Init =
-          Loc.castAs<PostInitializer>().getInitializer();
-      if (const FieldDecl *FD = Init->getAnyMember())
-        Out << *FD;
-      else {
-        QualType Ty = Init->getTypeSourceInfo()->getType();
-        Ty = Ty.getLocalUnqualifiedType();
-        Ty.print(Out, Context.getLangOpts());
-      }
-      break;
-    }
-
-    case ProgramPoint::BlockEdgeKind: {
-      const BlockEdge &E = Loc.castAs<BlockEdge>();
-      Out << "Edge: (B" << E.getSrc()->getBlockID() << ", B"
-          << E.getDst()->getBlockID() << ')';
-
-      if (const Stmt *T = E.getSrc()->getTerminator()) {
-        SourceLocation SLoc = T->getBeginLoc();
-
-        Out << "\\|Terminator: ";
-        E.getSrc()->printTerminator(Out, Context.getLangOpts());
-        printLocation(Out, SLoc, SM, /*Postfix=*/"");
-
-        if (isa<SwitchStmt>(T)) {
-          const Stmt *Label = E.getDst()->getLabel();
-
-          if (Label) {
-            if (const auto *C = dyn_cast<CaseStmt>(Label)) {
-              Out << "\\lcase ";
-              if (C->getLHS())
-                C->getLHS()->printPretty(
-                    Out, nullptr, Context.getPrintingPolicy(),
-                    /*Indentation=*/0, /*NewlineSymbol=*/"\\l");
-
-              if (const Stmt *RHS = C->getRHS()) {
-                Out << " .. ";
-                RHS->printPretty(Out, nullptr, Context.getPrintingPolicy(),
-                                 /*Indetation=*/0, /*NewlineSymbol=*/"\\l");
-              }
-
-              Out << ":";
-            } else {
-              assert(isa<DefaultStmt>(Label));
-              Out << "\\ldefault:";
-            }
-          } else
-            Out << "\\l(implicit) default:";
-        } else if (isa<IndirectGotoStmt>(T)) {
-          // FIXME
-        } else {
-          Out << "\\lCondition: ";
-          if (*E.getSrc()->succ_begin() == E.getDst())
-            Out << "true";
-          else
-            Out << "false";
-        }
-
-        Out << "\\l";
-      }
-
-      break;
-    }
-
-    default: {
-      const Stmt *S = Loc.castAs<StmtPoint>().getStmt();
-      assert(S != nullptr && "Expecting non-null Stmt");
-
-      Out << S->getStmtClassName() << " S"
-          << S->getID(Context) << " <" << (const void *)S << "> ";
-      S->printPretty(Out, /*helper=*/nullptr, Context.getPrintingPolicy(),
-                     /*Indentation=*/2, /*NewlineSymbol=*/"\\l");
-      printLocation(Out, S->getBeginLoc(), SM, /*Postfix=*/"");
-
-      if (Loc.getAs<PreStmt>())
-        Out << "\\lPreStmt\\l";
-      else if (Loc.getAs<PostLoad>())
-        Out << "\\lPostLoad\\l";
-      else if (Loc.getAs<PostStore>())
-        Out << "\\lPostStore\\l";
-      else if (Loc.getAs<PostLValue>())
-        Out << "\\lPostLValue\\l";
-      else if (Loc.getAs<PostAllocatorCall>())
-        Out << "\\lPostAllocatorCall\\l";
-
-      break;
-    }
-    }
-  }
-
   static bool isNodeHidden(const ExplodedNode *N) {
     return N->isTrivial();
   }
 
   static std::string getNodeLabel(const ExplodedNode *N, ExplodedGraph *G){
     std::string sbuf;
     llvm::raw_string_ostream Out(sbuf);
 
     // Find the first node which program point and tag has to be included in
     // the output.
     const ExplodedNode *FirstHiddenNode = N;
     while (FirstHiddenNode->pred_size() == 1 &&
            isNodeHidden(*FirstHiddenNode->pred_begin())) {
       FirstHiddenNode = *FirstHiddenNode->pred_begin();
     }
 
     ProgramStateRef State = N->getState();
-    const ASTContext &Context = State->getStateManager().getContext();
 
     // Dump program point for all the previously skipped nodes.
     const ExplodedNode *OtherNode = FirstHiddenNode;
     while (true) {
-      dumpProgramPoint(OtherNode->getLocation(), Context, Out);
+      OtherNode->getLocation().print(/*CR=*/"\\l", Out);
 
       if (const ProgramPointTag *Tag = OtherNode->getLocation().getTag())
         Out << "\\lTag:" << Tag->getTagDescription();
 
       if (OtherNode == N)
         break;
 
       OtherNode = *OtherNode->succ_begin();