Added copyright header to all C++ source files.
[oota-llvm.git] / tools / analyze / analyze.cpp
index d9423e4c65ebfd98c66ebddbfce83c72444db8e6..17f7e4866d851098a812409ca45753ec4e262222 100644 (file)
@@ -1,4 +1,12 @@
 //===----------------------------------------------------------------------===//
+// 
+//                     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.
+// 
+//===----------------------------------------------------------------------===//
+// 
 // The LLVM analyze utility
 //
 // This utility is designed to print out the results of running various analysis
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Module.h"
-#include "llvm/iPHINode.h"
-#include "llvm/Type.h"
 #include "llvm/PassManager.h"
 #include "llvm/Bytecode/Reader.h"
 #include "llvm/Assembly/Parser.h"
-#include "llvm/Assembly/PrintModulePass.h"
-#include "llvm/Assembly/Writer.h"
-#include "llvm/Analysis/InstForest.h"
-#include "llvm/Analysis/Expressions.h"
-#include "llvm/Analysis/InductionVariable.h"
-#include "llvm/Support/InstIterator.h"
+#include "llvm/Analysis/Verifier.h"
+#include "llvm/Target/TargetData.h"
 #include "llvm/Support/PassNameParser.h"
+#include "Support/Timer.h"
 #include <algorithm>
 
-using std::ostream;
-
-#if 0
-
-template <class PassType, class PassName>
-class PassPrinter;  // Do not implement
 
-template <class PassName>
-class PassPrinter<Pass, PassName> : public Pass {
-  const AnalysisID ID;
-public:
-  PassPrinter(AnalysisID id) : ID(id) {}
+struct ModulePassPrinter : public Pass {
+  const PassInfo *PassToPrint;
+  ModulePassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
 
-  const char *getPassName() const { return "IP Pass Printer"; }
-  
   virtual bool run(Module &M) {
-    printPass(getAnalysis<PassName>(ID), std::cout, M);
+    std::cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
+    getAnalysisID<Pass>(PassToPrint).print(std::cout, &M);
+    
+    // Get and print pass...
     return false;
   }
-
-  virtual void getAnalysisUsage(AnalysisUsage &AU) const {
-    AU.addRequired(ID);
-  }
-};
-
-template <class PassName>
-class PassPrinter<FunctionPass, PassName> : public FunctionPass {
-  const AnalysisID ID;
-public:
-  PassPrinter(AnalysisID id) : ID(id) {}
-
-    const char *getPassName() const { return "Function Pass Printer"; }
   
-  virtual bool runOnFunction(Function &F) {
-    std::cout << "Running on function '" << F.getName() << "'\n";
-    printPass(getAnalysis<PassName>(ID), std::cout, F);
-    return false;
-  }
+  virtual const char *getPassName() const { return "'Pass' Printer"; }
 
   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
-    AU.addRequired(ID);
+    AU.addRequiredID(PassToPrint);
     AU.setPreservesAll();
   }
 };
 
-
-struct InstForestHelper : public FunctionPass {
-  const char *getPassName() const { return "InstForest Printer"; }
-
-  void doit(Function &F) {
-    std::cout << InstForest<char>(&F);
-  }
-
-  virtual void getAnalysisUsage(AnalysisUsage &AU) const {
-    AU.setPreservesAll();
-  }
-};
-
-struct IndVars : public FunctionPass {
-  const char *getPassName() const { return "IndVars Printer"; }
-
-  void doit(Function &F) {
-    LoopInfo &LI = getAnalysis<LoopInfo>();
-    for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
-      if (PHINode *PN = dyn_cast<PHINode>(*I)) {
-        InductionVariable IV(PN, &LI);
-        if (IV.InductionType != InductionVariable::Unknown)
-          IV.print(std::cout);
-      }
-  }
-
-  void getAnalysisUsage(AnalysisUsage &AU) const {
-    AU.addRequired(LoopInfo::ID);
-    AU.setPreservesAll();
-  }
-};
-
-struct Exprs : public FunctionPass {
-  const char *getPassName() const { return "Expression Printer"; }
-
-  static void doit(Function &F) {
-    std::cout << "Classified expressions for: " << F.getName() << "\n";
-    for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I) {
-      std::cout << *I;
-      
-      if ((*I)->getType() == Type::VoidTy) continue;
-      analysis::ExprType R = analysis::ClassifyExpression(*I);
-      if (R.Var == *I) continue;  // Doesn't tell us anything
-      
-      std::cout << "\t\tExpr =";
-      switch (R.ExprTy) {
-      case analysis::ExprType::ScaledLinear:
-        WriteAsOperand(std::cout << "(", (Value*)R.Scale) << " ) *";
-        // fall through
-      case analysis::ExprType::Linear:
-        WriteAsOperand(std::cout << "(", R.Var) << " )";
-        if (R.Offset == 0) break;
-        else std::cout << " +";
-        // fall through
-      case analysis::ExprType::Constant:
-        if (R.Offset) WriteAsOperand(std::cout, (Value*)R.Offset);
-        else std::cout << " 0";
-        break;
-      }
-      std::cout << "\n\n";
-    }
-  }
-  virtual void getAnalysisUsage(AnalysisUsage &AU) const {
-    AU.setPreservesAll();
-  }
-};
-#endif
-
-struct ModulePassPrinter : public Pass {
-  Pass *PassToPrint;
-  ModulePassPrinter(Pass *PI) : PassToPrint(PI) {}
-
-  virtual bool run(Module &M) {
-    std::cout << "Printing Analysis info for Pass "
-              << PassToPrint->getPassName() << ":\n";
-    PassToPrint->print(std::cout, &M);
-    
-    // Get and print pass...
-    return false;
-  }
-};
-
 struct FunctionPassPrinter : public FunctionPass {
   const PassInfo *PassToPrint;
   FunctionPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
 
   virtual bool runOnFunction(Function &F) {
-    std::cout << "Printing Analysis info for function '" << F.getName()
-              << "': Pass " << PassToPrint->getPassName() << ":\n";
-    getAnalysis<Pass>(PassToPrint).print(std::cout, F.getParent());
+    std::cout << "Printing analysis '" << PassToPrint->getPassName()
+              << "' for function '" << F.getName() << "':\n";
+    getAnalysisID<Pass>(PassToPrint).print(std::cout, F.getParent());
 
     // Get and print pass...
     return false;
   }
 
+  virtual const char *getPassName() const { return "FunctionPass Printer"; }
+
   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
-    AU.addRequired(PassToPrint);
+    AU.addRequiredID(PassToPrint);
     AU.setPreservesAll();
   }
 };
@@ -178,49 +77,58 @@ struct BasicBlockPassPrinter : public BasicBlockPass {
   virtual bool runOnBasicBlock(BasicBlock &BB) {
     std::cout << "Printing Analysis info for BasicBlock '" << BB.getName()
               << "': Pass " << PassToPrint->getPassName() << ":\n";
-    getAnalysis<Pass>(PassToPrint).print(std::cout, BB.getParent()->getParent());
+    getAnalysisID<Pass>(PassToPrint).print(std::cout, BB.getParent()->getParent());
 
     // Get and print pass...
     return false;
   }
 
+  virtual const char *getPassName() const { return "BasicBlockPass Printer"; }
+
   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
-    AU.addRequired(PassToPrint);
+    AU.addRequiredID(PassToPrint);
     AU.setPreservesAll();
   }
 };
 
 
 
+namespace {
+  cl::opt<std::string>
+  InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"),
+                cl::value_desc("filename"));
 
-static cl::opt<std::string>
-InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"),
-              cl::value_desc("filename"));
+  cl::opt<bool> Quiet("q", cl::desc("Don't print analysis pass names"));
+  cl::alias    QuietA("quiet", cl::desc("Alias for -q"),
+                      cl::aliasopt(Quiet));
 
-static cl::opt<bool> Quiet("q", cl::desc("Don't print analysis pass names"));
-static cl::alias    QuietA("quiet", cl::desc("Alias for -q"),
-                           cl::aliasopt(Quiet));
+  cl::opt<bool> NoVerify("disable-verify", cl::Hidden,
+                         cl::desc("Do not verify input module"));
 
-// The AnalysesList is automatically populated with registered Passes by the
-// PassNameParser.
-//
-static cl::list<const PassInfo*, bool,
-                FilteredPassNameParser<PassInfo::Analysis> >
-AnalysesList(cl::desc("Analyses available:"));
+  // The AnalysesList is automatically populated with registered Passes by the
+  // PassNameParser.
+  //
+  cl::list<const PassInfo*, bool, FilteredPassNameParser<PassInfo::Analysis> >
+  AnalysesList(cl::desc("Analyses available:"));
 
+  Timer BytecodeLoadTimer("Bytecode Loader");
+}
 
 int main(int argc, char **argv) {
   cl::ParseCommandLineOptions(argc, argv, " llvm analysis printer tool\n");
 
   Module *CurMod = 0;
   try {
+#if 0
+    TimeRegion RegionTimer(BytecodeLoadTimer);
+#endif
     CurMod = ParseBytecodeFile(InputFilename);
     if (!CurMod && !(CurMod = ParseAssemblyFile(InputFilename))){
-      std::cerr << "Input file didn't read correctly.\n";
+      std::cerr << argv[0] << ": input file didn't read correctly.\n";
       return 1;
     }
   } catch (const ParseException &E) {
-    std::cerr << E.getMessage() << "\n";
+    std::cerr << argv[0] << ": " << E.getMessage() << "\n";
     return 1;
   }
 
@@ -229,6 +137,13 @@ int main(int argc, char **argv) {
   //
   PassManager Passes;
 
+  // Add an appropriate TargetData instance for this module...
+  Passes.add(new TargetData("analyze", CurMod));
+
+  // Make sure the input LLVM is well formed.
+  if (!NoVerify)
+    Passes.add(createVerifierPass());
+
   // Create a new optimization pass for each one specified on the command line
   for (unsigned i = 0; i < AnalysesList.size(); ++i) {
     const PassInfo *Analysis = AnalysesList[i];
@@ -242,10 +157,11 @@ int main(int argc, char **argv) {
       else if (FunctionPass *FP = dynamic_cast<FunctionPass*>(P))
         Passes.add(new FunctionPassPrinter(Analysis));
       else
-        Passes.add(new ModulePassPrinter(P));
+        Passes.add(new ModulePassPrinter(Analysis));
 
     } else
-      cerr << "Cannot create pass: " << Analysis->getPassName() << "\n";
+      std::cerr << argv[0] << ": cannot create pass: "
+                << Analysis->getPassName() << "\n";
   }
 
   Passes.run(*CurMod);