blob: ce89fff90e6104a947c38f979b50bbb403cdc64c [file] [log] [blame]
//===- PrintSCC.cpp - Enumerate SCCs in some key graphs -------------------===//
//
// The LLVM Compiler Infrastructure
//
// This file was developed by the LLVM research group and is distributed under
// the University of Illinois Open Source License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file provides passes to print out SCCs in a CFG or a CallGraph.
// Normally, you would not use these passes; instead, you would use the
// scc_iterator directly to enumerate SCCs and process them in some way. These
// passes serve three purposes:
//
// (1) As a reference for how to use the scc_iterator.
// (2) To print out the SCCs for a CFG or a CallGraph:
// analyze -cfgscc to print the SCCs in each CFG of a module.
// analyze -cfgscc -stats to print the #SCCs and the maximum SCC size.
// analyze -cfgscc -debug > /dev/null to watch the algorithm in action.
//
// and similarly:
// analyze -callscc [-stats] [-debug] to print SCCs in the CallGraph
//
// (3) To test the scc_iterator.
//
//===----------------------------------------------------------------------===//
#include "llvm/Pass.h"
#include "llvm/Module.h"
#include "llvm/Analysis/CallGraph.h"
#include "llvm/Support/CFG.h"
#include "Support/SCCIterator.h"
namespace llvm {
namespace {
struct CFGSCC : public FunctionPass {
bool runOnFunction(Function& func);
void print(std::ostream &O) const { }
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
}
};
struct CallGraphSCC : public Pass {
// run - Print out SCCs in the call graph for the specified module.
bool run(Module &M);
void print(std::ostream &O) const { }
// getAnalysisUsage - This pass requires the CallGraph.
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
AU.addRequired<CallGraph>();
}
};
RegisterAnalysis<CFGSCC>
Y("cfgscc", "Print SCCs of each function CFG");
RegisterAnalysis<CallGraphSCC>
Z("callscc", "Print SCCs of the Call Graph");
}
bool CFGSCC::runOnFunction(Function &F) {
unsigned sccNum = 0;
std::cout << "SCCs for Function " << F.getName() << " in PostOrder:";
for (scc_iterator<Function*> SCCI = scc_begin(&F),
E = scc_end(&F); SCCI != E; ++SCCI) {
std::vector<BasicBlock*> &nextSCC = *SCCI;
std::cout << "\nSCC #" << ++sccNum << " : ";
for (std::vector<BasicBlock*>::const_iterator I = nextSCC.begin(),
E = nextSCC.end(); I != E; ++I)
std::cout << (*I)->getName() << ", ";
if (nextSCC.size() == 1 && SCCI.hasLoop())
std::cout << " (Has self-loop).";
}
std::cout << "\n";
return true;
}
// run - Print out SCCs in the call graph for the specified module.
bool CallGraphSCC::run(Module &M) {
CallGraphNode* rootNode = getAnalysis<CallGraph>().getRoot();
unsigned sccNum = 0;
std::cout << "SCCs for the program in PostOrder:";
for (scc_iterator<CallGraphNode*> SCCI = scc_begin(rootNode),
E = scc_end(rootNode); SCCI != E; ++SCCI) {
const std::vector<CallGraphNode*> &nextSCC = *SCCI;
std::cout << "\nSCC #" << ++sccNum << " : ";
for (std::vector<CallGraphNode*>::const_iterator I = nextSCC.begin(),
E = nextSCC.end(); I != E; ++I)
std::cout << ((*I)->getFunction() ? (*I)->getFunction()->getName()
: std::string("Indirect CallGraph node")) << ", ";
if (nextSCC.size() == 1 && SCCI.hasLoop())
std::cout << " (Has self-loop).";
}
std::cout << "\n";
return true;
}
} // End llvm namespace