Expose funcresolve pass through opt
[oota-llvm.git] / tools / opt / opt.cpp
index 7bae1d8190d8c58536e9fea360372795222e6625..c2c2620966b17d03b151de922e4ec10c0ea1b437 100644 (file)
-//===------------------------------------------------------------------------===
+//===----------------------------------------------------------------------===//
 // LLVM 'OPT' UTILITY 
 //
-// This utility may be invoked in the following manner:
-//  opt --help               - Output information about command line switches
-//  opt [options] -dce       - Run a dead code elimination pass on input 
-//                             bytecodes
-//  opt [options] -constprop - Run a constant propogation pass on input 
-//                             bytecodes
-//  opt [options] -inline    - Run a method inlining pass on input bytecodes
-//  opt [options] -strip     - Strip symbol tables out of methods
-//  opt [options] -mstrip    - Strip module & method symbol tables
-//
 // Optimizations may be specified an arbitrary number of times on the command
 // line, they are run in the order specified.
 //
-// TODO: Add a -all option to keep applying all optimizations until the program
-//       stops permuting.
-//
-//===------------------------------------------------------------------------===
+//===----------------------------------------------------------------------===//
 
-#include <iostream.h>
-#include <fstream.h>
 #include "llvm/Module.h"
+#include "llvm/PassManager.h"
 #include "llvm/Bytecode/Reader.h"
-#include "llvm/Bytecode/Writer.h"
-#include "llvm/Tools/CommandLine.h"
-#include "llvm/Opt/AllOpts.h"
+#include "llvm/Bytecode/WriteBytecodePass.h"
+#include "llvm/Assembly/PrintModulePass.h"
+#include "llvm/Analysis/Verifier.h"
+#include "llvm/Transforms/UnifyMethodExitNodes.h"
+#include "llvm/Transforms/ConstantMerge.h"
+#include "llvm/Transforms/CleanupGCCOutput.h"
+#include "llvm/Transforms/LevelChange.h"
+#include "llvm/Transforms/MethodInlining.h"
+#include "llvm/Transforms/SymbolStripping.h"
+#include "llvm/Transforms/ChangeAllocations.h"
+#include "llvm/Transforms/IPO/SimpleStructMutation.h"
+#include "llvm/Transforms/IPO/GlobalDCE.h"
+#include "llvm/Transforms/IPO/PoolAllocate.h"
+#include "llvm/Transforms/Scalar/DCE.h"
+#include "llvm/Transforms/Scalar/ConstantProp.h"
+#include "llvm/Transforms/Scalar/IndVarSimplify.h"
+#include "llvm/Transforms/Scalar/InstructionCombining.h"
+#include "llvm/Transforms/Scalar/PromoteMemoryToRegister.h"
+#include "llvm/Transforms/Scalar/DecomposeMultiDimRefs.h"
+#include "llvm/Transforms/Instrumentation/TraceValues.h"
+#include "llvm/Transforms/Instrumentation/ProfilePaths.h"
+#include "Support/CommandLine.h"
+#include <fstream>
+#include <memory>
+
+// Opts enum - All of the transformations we can do...
+enum Opts {
+  // Basic optimizations
+  dce, die, constprop, inlining, constmerge, strip, mstrip, mergereturn,
+
+  // Miscellaneous Transformations
+  raiseallocs, funcresolve, cleangcc, lowerrefs,
+
+  // Printing and verifying...
+  print, verify,
+
+  // More powerful optimizations
+  indvars, instcombine, sccp, adce, raise, mem2reg,
+
+  // Instrumentation
+  trace, tracem, paths,
+
+  // Interprocedural optimizations...
+  globaldce, swapstructs, sortstructs, poolalloc,
+};
+
+static Pass *createPrintMethodPass() {
+  return new PrintFunctionPass("Current Method: \n", &cerr);
+}
 
+// OptTable - Correlate enum Opts to Pass constructors...
+//
 struct {
-  const string ArgName, Name;
-  bool (*OptPtr)(Module *C);
+  enum Opts OptID;
+  Pass * (*PassCtor)();
 } OptTable[] = {
-  { "-dce"       , "Dead Code Elimination", DoDeadCodeElimination },
-  { "-constprop" , "Constant Propogation",  DoConstantPropogation }, 
-  { "-inline"    , "Method Inlining",       DoMethodInlining      },
-  { "-strip"     , "Strip Symbols",         DoSymbolStripping     },
-  { "-mstrip"    , "Strip Module Symbols",  DoFullSymbolStripping },
-  { "-indvars"   , "Simplify Induction Vars",DoInductionVariableCannonicalize },
-  { "-sccp"      , "Sparse Conditional Constant Prop", DoSCCP<Module> },
-  { "-cpm"       , "Constant Pool Merging", DoConstantPoolMerging },
+  { dce        , createDeadCodeEliminationPass },
+  { die        , createDeadInstEliminationPass },
+  { constprop  , createConstantPropogationPass }, 
+  { inlining   , createMethodInliningPass },
+  { constmerge , createConstantMergePass },
+  { strip      , createSymbolStrippingPass },
+  { mstrip     , createFullSymbolStrippingPass },
+  { mergereturn, createUnifyMethodExitNodesPass },
+
+  { indvars    , createIndVarSimplifyPass },
+  { instcombine, createInstructionCombiningPass },
+  { sccp       , createSCCPPass },
+  { adce       , createAgressiveDCEPass },
+  { raise      , createRaisePointerReferencesPass },
+  { mem2reg    , createPromoteMemoryToRegister },
+  { lowerrefs,   createDecomposeMultiDimRefsPass },
+
+  { trace      , createTraceValuesPassForBasicBlocks },
+  { tracem     , createTraceValuesPassForMethod },
+  { paths      , createProfilePathsPass },
+
+  { print      , createPrintMethodPass },
+  { verify     , createVerifierPass },
+
+  { raiseallocs, createRaiseAllocationsPass },
+  { cleangcc   , createCleanupGCCOutputPass },
+  { funcresolve, createFunctionResolvingPass },
+  { globaldce  , createGlobalDCEPass },
+  { swapstructs, createSwapElementsPass },
+  { sortstructs, createSortElementsPass },
+  { poolalloc  , createPoolAllocatePass },
 };
 
+
+// Command line option handling code...
+//
+cl::String InputFilename ("", "Load <arg> file to optimize", cl::NoFlags, "-");
+cl::String OutputFilename("o", "Override output filename", cl::NoFlags, "");
+cl::Flag   Force         ("f", "Overwrite output files", cl::NoFlags, false);
+cl::Flag   PrintEachXForm("p", "Print module after each transformation");
+cl::Flag   Quiet         ("q", "Don't print modifying pass names", 0, false);
+cl::Alias  QuietA        ("quiet", "Alias for -q", cl::NoFlags, Quiet);
+cl::EnumList<enum Opts> OptimizationList(cl::NoFlags,
+  clEnumVal(dce        , "Dead Code Elimination"),
+  clEnumVal(die        , "Dead Instruction Elimination"),
+  clEnumVal(constprop  , "Simple constant propogation"),
+ clEnumValN(inlining   , "inline", "Method integration"),
+  clEnumVal(constmerge , "Merge identical global constants"),
+  clEnumVal(strip      , "Strip symbols"),
+  clEnumVal(mstrip     , "Strip module symbols"),
+  clEnumVal(mergereturn, "Unify method exit nodes"),
+
+  clEnumVal(indvars    , "Simplify Induction Variables"),
+  clEnumVal(instcombine, "Combine redundant instructions"),
+  clEnumVal(sccp       , "Sparse Conditional Constant Propogation"),
+  clEnumVal(adce       , "Agressive DCE"),
+  clEnumVal(mem2reg    , "Promote alloca locations to registers"),
+
+  clEnumVal(globaldce  , "Remove unreachable globals"),
+  clEnumVal(swapstructs, "Swap structure types around"),
+  clEnumVal(sortstructs, "Sort structure elements"),
+  clEnumVal(poolalloc  , "Pool allocate disjoint datastructures"),
+
+  clEnumVal(raiseallocs, "Raise allocations from calls to instructions"),
+  clEnumVal(cleangcc   , "Cleanup GCC Output"),
+  clEnumVal(funcresolve, "Resolve calls to foo(...) to foo(<concrete types>)"),
+  clEnumVal(raise      , "Raise to Higher Level"),
+  clEnumVal(trace      , "Insert BB & Method trace code"),
+  clEnumVal(tracem     , "Insert Method trace code only"),
+  clEnumVal(paths      , "Insert path profiling instrumentation"),
+  clEnumVal(print      , "Print working method to stderr"),
+  clEnumVal(verify     , "Verify module is well formed"),
+  clEnumVal(lowerrefs  , "Decompose multi-dimensional structure/array refs to use one index per instruction"),
+0);
+
+
+
 int main(int argc, char **argv) {
-  ToolCommandLine Opts(argc, argv, false);
-  bool Quiet = false;
-
-  for (int i = 1; i < argc; i++) {
-    if (string(argv[i]) == string("--help")) {
-      cerr << argv[0] << " usage:\n"
-           << "  " << argv[0] << " --help  - Print this usage information\n";
-      for (unsigned j = 0; j < sizeof(OptTable)/sizeof(OptTable[0]); ++j) {
-       cerr << "\t" << OptTable[j].ArgName << "\t - Enable " 
-            << OptTable[j].Name << endl;
-      }
-      return 1;
-    } else if (string(argv[i]) == string("-q")) {
-      Quiet = true; argv[i] = 0;
-    }
-  }
-  
-  ostream *Out = &cout;  // Default to printing to stdout...
+  cl::ParseCommandLineOptions(argc, argv,
+                             " llvm .bc -> .bc modular optimizer\n");
 
-  Module *C = ParseBytecodeFile(Opts.getInputFilename());
-  if (C == 0) {
+  // Load the input module...
+  std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
+  if (M.get() == 0) {
     cerr << "bytecode didn't read correctly.\n";
     return 1;
   }
 
-
-  for (int i = 1; i < argc; i++) {
-    if (argv[i] == 0) continue;
-    unsigned j;
-    for (j = 0; j < sizeof(OptTable)/sizeof(OptTable[0]); j++) {
-      if (string(argv[i]) == OptTable[j].ArgName) {
-        if (OptTable[j].OptPtr(C) && !Quiet)
-          cerr << OptTable[j].Name << " pass made modifications!\n";
-        break;
-      }
+  // Figure out what stream we are supposed to write to...
+  std::ostream *Out = &std::cout;  // Default to printing to stdout...
+  if (OutputFilename != "") {
+    if (!Force && std::ifstream(OutputFilename.c_str())) {
+      // If force is not specified, make sure not to overwrite a file!
+      cerr << "Error opening '" << OutputFilename << "': File exists!\n"
+           << "Use -f command line argument to force output\n";
+      return 1;
     }
+    Out = new std::ofstream(OutputFilename.c_str());
 
-    if (j == sizeof(OptTable)/sizeof(OptTable[0])) 
-      cerr << "'" << argv[i] << "' argument unrecognized: ignored\n";
-  }
-
-  if (Opts.getOutputFilename() != "-") {
-    Out = new ofstream(Opts.getOutputFilename().c_str(), 
-                       (Opts.getForce() ? 0 : ios::noreplace)|ios::out);
     if (!Out->good()) {
-      cerr << "Error opening " << Opts.getOutputFilename() 
-           << "!\n";
-      delete C;
+      cerr << "Error opening " << OutputFilename << "!\n";
       return 1;
     }
   }
 
-  // Okay, we're done now... write out result...
-  WriteBytecodeToFile(C, *Out);
-  delete C;
+  // Create a PassManager to hold and optimize the collection of passes we are
+  // about to build...
+  //
+  PassManager Passes;
+
+  // Create a new optimization pass for each one specified on the command line
+  for (unsigned i = 0; i < OptimizationList.size(); ++i) {
+    enum Opts Opt = OptimizationList[i];
+    for (unsigned j = 0; j < sizeof(OptTable)/sizeof(OptTable[0]); ++j)
+      if (Opt == OptTable[j].OptID) {
+        Passes.add(OptTable[j].PassCtor());
+        break;
+      }
+
+    if (PrintEachXForm)
+      Passes.add(new PrintModulePass(&std::cerr));
+  }
+
+  // Check that the module is well formed on completion of optimization
+  Passes.add(createVerifierPass());
+
+  // Write bytecode out to disk or cout as the last step...
+  Passes.add(new WriteBytecodePass(Out, Out != &std::cout));
+
+  // Now that we have all of the passes ready, run them.
+  if (Passes.run(M.get()) && !Quiet)
+    cerr << "Program modified.\n";
 
-  if (Out != &cout) delete Out;
   return 0;
 }