New pass which is useful for writing regression tests
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@6979 91177308-0d34-0410-b5e6-96231b3b80d8
diff --git a/lib/Analysis/DataStructure/GraphChecker.cpp b/lib/Analysis/DataStructure/GraphChecker.cpp
new file mode 100644
index 0000000..7bfbf7d
--- /dev/null
+++ b/lib/Analysis/DataStructure/GraphChecker.cpp
@@ -0,0 +1,150 @@
+//===- GraphChecker.cpp - Assert that various graph properties hold -------===//
+//
+// This pass is used to test DSA with regression tests. It can be used to check
+// that certain graph properties hold, such as two nodes being disjoint, whether
+// or not a node is collapsed, etc. These are the command line arguments that
+// it supports:
+//
+// --dsgc-dsapass={local,bu,td} - Specify what flavor of graph to check
+// --dsgc-abort-if-any-collapsed - Abort if any collapsed nodes are found
+// --dsgc-abort-if-collapsed=<list> - Abort if a node pointed to by an SSA
+// value with name in <list> is collapsed
+// --dsgc-abort-if-merged=<list> - Abort if any of the named SSA values
+// point to the same node.
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/Analysis/DataStructure.h"
+#include "llvm/Analysis/DSGraph.h"
+#include "Support/CommandLine.h"
+#include "llvm/Value.h"
+#include <set>
+
+namespace {
+ enum DSPass { local, bu, td };
+ cl::opt<DSPass>
+ DSPass("dsgc-dspass", cl::Hidden,
+ cl::desc("Specify which DSA pass the -datastructure-gc pass should use"),
+ cl::values(clEnumVal(local, "Local pass"),
+ clEnumVal(bu, "Bottom-up pass"),
+ clEnumVal(td, "Top-down pass"), 0), cl::init(local));
+
+ cl::opt<bool>
+ AbortIfAnyCollapsed("dsgc-abort-if-any-collapsed", cl::Hidden,
+ cl::desc("Abort if any collapsed nodes are found"));
+ cl::list<std::string>
+ AbortIfCollapsed("dsgc-abort-if-collapsed", cl::Hidden, cl::CommaSeparated,
+ cl::desc("Abort if any of the named symbols is collapsed"));
+ cl::list<std::string>
+ AbortIfMerged("dsgc-abort-if-merged", cl::Hidden, cl::CommaSeparated,
+ cl::desc("Abort if any of the named symbols are merged together"));
+
+ struct DSGC : public FunctionPass {
+ DSGC();
+ bool doFinalization(Module &M);
+ bool runOnFunction(Function &F);
+
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ switch (DSPass) {
+ case local: AU.addRequired<LocalDataStructures>(); break;
+ case bu: AU.addRequired<BUDataStructures>(); break;
+ case td: AU.addRequired<TDDataStructures>(); break;
+ }
+ AU.setPreservesAll();
+ }
+
+ private:
+ void verify(const DSGraph &G);
+ };
+
+ RegisterAnalysis<DSGC> X("datastructure-gc", "DSA Graph Checking Pass");
+}
+
+DSGC::DSGC() {
+ if (!AbortIfAnyCollapsed && AbortIfCollapsed.empty() &&
+ AbortIfMerged.empty()) {
+ std::cerr << "The -datastructure-gc is useless if you don't specify any"
+ " -dsgc-* options. See the -help-hidden output for a list.\n";
+ abort();
+ }
+}
+
+
+/// doFinalization - Verify that the globals graph is in good shape...
+///
+bool DSGC::doFinalization(Module &M) {
+ switch (DSPass) {
+ case local:verify(getAnalysis<LocalDataStructures>().getGlobalsGraph());break;
+ case bu: verify(getAnalysis<BUDataStructures>().getGlobalsGraph()); break;
+ case td: verify(getAnalysis<TDDataStructures>().getGlobalsGraph()); break;
+ }
+ return false;
+}
+
+/// runOnFunction - Get the DSGraph for this function and verify that it is ok.
+///
+bool DSGC::runOnFunction(Function &F) {
+ switch (DSPass) {
+ case local: verify(getAnalysis<LocalDataStructures>().getDSGraph(F)); break;
+ case bu: verify(getAnalysis<BUDataStructures>().getDSGraph(F)); break;
+ case td: verify(getAnalysis<TDDataStructures>().getDSGraph(F)); break;
+ }
+
+ return false;
+}
+
+/// verify - This is the function which checks to make sure that all of the
+/// invariants established on the command line are true.
+///
+void DSGC::verify(const DSGraph &G) {
+ // Loop over all of the nodes, checking to see if any are collapsed...
+ if (AbortIfAnyCollapsed) {
+ const std::vector<DSNode*> &Nodes = G.getNodes();
+ for (unsigned i = 0, e = Nodes.size(); i != e; ++i)
+ if (Nodes[i]->isNodeCompletelyFolded()) {
+ std::cerr << "Node is collapsed: ";
+ Nodes[i]->print(std::cerr, &G);
+ abort();
+ }
+ }
+
+ if (!AbortIfCollapsed.empty() || !AbortIfMerged.empty()) {
+ // Convert from a list to a set, because we don't have cl::set's yet. FIXME
+ std::set<std::string> AbortIfCollapsedS(AbortIfCollapsed.begin(),
+ AbortIfCollapsed.end());
+ std::set<std::string> AbortIfMerged(AbortIfMerged.begin(),
+ AbortIfMerged.end());
+
+
+ // Now we loop over all of the scalars, checking to see if any are collapsed
+ // that are not supposed to be, or if any are merged together.
+ const DSGraph::ScalarMapTy &SM = G.getScalarMap();
+ std::map<DSNode*, std::string> AbortIfMergedNodes;
+
+ for (DSGraph::ScalarMapTy::const_iterator I = SM.begin(), E = SM.end();
+ I != E; ++I)
+ if (I->first->hasName() && I->second.getNode()) {
+ DSNode *N = I->second.getNode();
+
+ // Verify it is not collapsed if it is not supposed to be...
+ if (N->isNodeCompletelyFolded() &&
+ AbortIfCollapsedS.count(I->first->getName())) {
+ std::cerr << "Node for value '%" << I->first->getName()
+ << "' is collapsed: ";
+ N->print(std::cerr, &G);
+ abort();
+ }
+
+ // Verify that it is not merged if it is not supposed to be...
+ if (AbortIfMerged.count(I->first->getName())) {
+ if (AbortIfMergedNodes.count(N)) {
+ std::cerr << "Nodes for values '%" << I->first->getName()
+ << "' and '%" << AbortIfMergedNodes[N] << "' is merged: ";
+ N->print(std::cerr, &G);
+ abort();
+ }
+ AbortIfMergedNodes[N] = I->first->getName();
+ }
+ }
+ }
+}