From cbde3571bdfecd5f0ba757e2b1c033148909a256 Mon Sep 17 00:00:00 2001
From: Chandler Carruth <chandlerc@gmail.com>
Date: Tue, 26 Nov 2013 03:43:52 +0000
Subject: [PATCH 1/1] [PM] Add a really simple trait to the DOTGraphTraitsPass
 class templates that lets the analysis and graph types be separate and the
 graph computed from the analysis through some arbitrary user-supplied code.

This will allow a call graph to an independent entity from the pass
which creates it which is necessary for the new pass manager.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@195717 91177308-0d34-0410-b5e6-96231b3b80d8
---
 include/llvm/Analysis/DOTGraphTraitsPass.h | 56 ++++++++++++++--------
 1 file changed, 36 insertions(+), 20 deletions(-)

diff --git a/include/llvm/Analysis/DOTGraphTraitsPass.h b/include/llvm/Analysis/DOTGraphTraitsPass.h
index 0dcbdec0329..ed26a06a581 100644
--- a/include/llvm/Analysis/DOTGraphTraitsPass.h
+++ b/include/llvm/Analysis/DOTGraphTraitsPass.h
@@ -19,50 +19,62 @@
 
 namespace llvm {
 
-template <class Analysis, bool Simple>
+/// \brief Default traits class for extracting a graph from an analysis pass.
+///
+/// This assumes that 'GraphT' is 'AnalysisT *' and so just passes it through.
+template <typename AnalysisT, typename GraphT = AnalysisT *>
+struct DefaultAnalysisGraphTraits {
+  static GraphT getGraph(AnalysisT *A) { return A; }
+};
+
+template <
+    typename AnalysisT, bool IsSimple, typename GraphT = AnalysisT *,
+    typename AnalysisGraphTraitsT = DefaultAnalysisGraphTraits<AnalysisT> >
 class DOTGraphTraitsViewer : public FunctionPass {
 public:
   DOTGraphTraitsViewer(StringRef GraphName, char &ID)
       : FunctionPass(ID), Name(GraphName) {}
 
   virtual bool runOnFunction(Function &F) {
-    Analysis *Graph = &getAnalysis<Analysis>();
-    std::string GraphName = DOTGraphTraits<Analysis *>::getGraphName(Graph);
+    GraphT Graph = AnalysisGraphTraitsT::getGraph(&getAnalysis<AnalysisT>());
+    std::string GraphName = DOTGraphTraits<GraphT>::getGraphName(Graph);
     std::string Title = GraphName + " for '" + F.getName().str() + "' function";
 
-    ViewGraph(Graph, Name, Simple, Title);
+    ViewGraph(Graph, Name, IsSimple, Title);
 
     return false;
   }
 
   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
     AU.setPreservesAll();
-    AU.addRequired<Analysis>();
+    AU.addRequired<AnalysisT>();
   }
 
 private:
   std::string Name;
 };
 
-template <class Analysis, bool Simple>
+template <
+    typename AnalysisT, bool IsSimple, typename GraphT = AnalysisT *,
+    typename AnalysisGraphTraitsT = DefaultAnalysisGraphTraits<AnalysisT> >
 class DOTGraphTraitsPrinter : public FunctionPass {
 public:
   DOTGraphTraitsPrinter(StringRef GraphName, char &ID)
       : FunctionPass(ID), Name(GraphName) {}
 
   virtual bool runOnFunction(Function &F) {
-    Analysis *Graph = &getAnalysis<Analysis>();
+    GraphT Graph = AnalysisGraphTraitsT::getGraph(&getAnalysis<AnalysisT>());
     std::string Filename = Name + "." + F.getName().str() + ".dot";
     std::string ErrorInfo;
 
     errs() << "Writing '" << Filename << "'...";
 
     raw_fd_ostream File(Filename.c_str(), ErrorInfo);
-    std::string GraphName = DOTGraphTraits<Analysis *>::getGraphName(Graph);
+    std::string GraphName = DOTGraphTraits<GraphT>::getGraphName(Graph);
     std::string Title = GraphName + " for '" + F.getName().str() + "' function";
 
     if (ErrorInfo.empty())
-      WriteGraph(File, Graph, Simple, Title);
+      WriteGraph(File, Graph, IsSimple, Title);
     else
       errs() << "  error opening file for writing!";
     errs() << "\n";
@@ -72,55 +84,59 @@ public:
 
   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
     AU.setPreservesAll();
-    AU.addRequired<Analysis>();
+    AU.addRequired<AnalysisT>();
   }
 
 private:
   std::string Name;
 };
 
-template <class Analysis, bool Simple>
+template <
+    typename AnalysisT, bool IsSimple, typename GraphT = AnalysisT *,
+    typename AnalysisGraphTraitsT = DefaultAnalysisGraphTraits<AnalysisT> >
 class DOTGraphTraitsModuleViewer : public ModulePass {
 public:
   DOTGraphTraitsModuleViewer(StringRef GraphName, char &ID)
       : ModulePass(ID), Name(GraphName) {}
 
   virtual bool runOnModule(Module &M) {
-    Analysis *Graph = &getAnalysis<Analysis>();
-    std::string Title = DOTGraphTraits<Analysis *>::getGraphName(Graph);
+    GraphT Graph = AnalysisGraphTraitsT::getGraph(&getAnalysis<AnalysisT>());
+    std::string Title = DOTGraphTraits<GraphT>::getGraphName(Graph);
 
-    ViewGraph(Graph, Name, Simple, Title);
+    ViewGraph(Graph, Name, IsSimple, Title);
 
     return false;
   }
 
   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
     AU.setPreservesAll();
-    AU.addRequired<Analysis>();
+    AU.addRequired<AnalysisT>();
   }
 
 private:
   std::string Name;
 };
 
-template <class Analysis, bool Simple>
+template <
+    typename AnalysisT, bool IsSimple, typename GraphT = AnalysisT *,
+    typename AnalysisGraphTraitsT = DefaultAnalysisGraphTraits<AnalysisT> >
 class DOTGraphTraitsModulePrinter : public ModulePass {
 public:
   DOTGraphTraitsModulePrinter(StringRef GraphName, char &ID)
       : ModulePass(ID), Name(GraphName) {}
 
   virtual bool runOnModule(Module &M) {
-    Analysis *Graph = &getAnalysis<Analysis>();
+    GraphT Graph = AnalysisGraphTraitsT::getGraph(&getAnalysis<AnalysisT>());
     std::string Filename = Name + ".dot";
     std::string ErrorInfo;
 
     errs() << "Writing '" << Filename << "'...";
 
     raw_fd_ostream File(Filename.c_str(), ErrorInfo);
-    std::string Title = DOTGraphTraits<Analysis *>::getGraphName(Graph);
+    std::string Title = DOTGraphTraits<GraphT>::getGraphName(Graph);
 
     if (ErrorInfo.empty())
-      WriteGraph(File, Graph, Simple, Title);
+      WriteGraph(File, Graph, IsSimple, Title);
     else
       errs() << "  error opening file for writing!";
     errs() << "\n";
@@ -130,7 +146,7 @@ public:
 
   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
     AU.setPreservesAll();
-    AU.addRequired<Analysis>();
+    AU.addRequired<AnalysisT>();
   }
 
 private:
-- 
2.34.1