Right, globals aren't values yet..
[oota-llvm.git] / tools / opt / opt.cpp
index c61ecfa1a60c4c33a799aeccb3cfd2824249414d..43e807472557a109ced39dd7e647f70d602d0b37 100644 (file)
@@ -1,5 +1,11 @@
+//===- opt.cpp - The LLVM Modular Optimizer -------------------------------===//
+// 
+//                     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.
+// 
 //===----------------------------------------------------------------------===//
-// LLVM 'OPT' UTILITY 
 //
 // Optimizations may be specified an arbitrary number of times on the command
 // line, they are run in the order specified.
 #include "llvm/Bytecode/WriteBytecodePass.h"
 #include "llvm/Assembly/PrintModulePass.h"
 #include "llvm/Analysis/Verifier.h"
-#include "llvm/Transforms/ConstantMerge.h"
-#include "llvm/Transforms/CleanupGCCOutput.h"
-#include "llvm/Transforms/LevelChange.h"
-#include "llvm/Transforms/FunctionInlining.h"
-#include "llvm/Transforms/ChangeAllocations.h"
-#include "llvm/Transforms/IPO/SimpleStructMutation.h"
-#include "llvm/Transforms/IPO/Internalize.h"
-#include "llvm/Transforms/IPO/GlobalDCE.h"
-#include "llvm/Transforms/IPO/PoolAllocate.h"
-#include "llvm/Transforms/Scalar/ConstantProp.h"
-#include "llvm/Transforms/Scalar/DCE.h"
-#include "llvm/Transforms/Scalar/DecomposeMultiDimRefs.h"
-#include "llvm/Transforms/Scalar/GCSE.h"
-#include "llvm/Transforms/Scalar/IndVarSimplify.h"
-#include "llvm/Transforms/Scalar/InstructionCombining.h"
-#include "llvm/Transforms/Scalar/PromoteMemoryToRegister.h"
-#include "llvm/Transforms/Scalar/SymbolStripping.h"
-#include "llvm/Transforms/Utils/UnifyFunctionExitNodes.h"
-#include "llvm/Transforms/Instrumentation/TraceValues.h"
-#include "llvm/Transforms/Instrumentation/ProfilePaths.h"
-#include "Support/CommandLine.h"
-#include "Support/Signals.h"
+#include "llvm/Target/TargetMachine.h"
+#include "llvm/Target/TargetMachineImpls.h"
+#include "llvm/Support/PassNameParser.h"
+#include "llvm/System/Signals.h"
+#include "Support/SystemUtils.h"
 #include <fstream>
 #include <memory>
+#include <algorithm>
 
-// Opts enum - All of the transformations we can do...
-enum Opts {
-  // Basic optimizations
-  dce, die, constprop, gcse, inlining, constmerge, strip, mstrip, mergereturn,
+using namespace llvm;
 
-  // Miscellaneous Transformations
-  raiseallocs, funcresolve, cleangcc, lowerrefs,
+// The OptimizationList is automatically populated with registered Passes by the
+// PassNameParser.
+//
+static cl::list<const PassInfo*, bool,
+                FilteredPassNameParser<PassInfo::Optimization> >
+OptimizationList(cl::desc("Optimizations available:"));
 
-  // Printing and verifying...
-  print, printm, verify,
 
-  // More powerful optimizations
-  indvars, instcombine, sccp, adce, raise, mem2reg,
+// Other command line options...
+//
+static cl::opt<std::string>
+InputFilename(cl::Positional, cl::desc("<input bytecode>"), cl::init("-"));
 
-  // Instrumentation
-  trace, tracem, paths,
+static cl::opt<std::string>
+OutputFilename("o", cl::desc("Override output filename"),
+               cl::value_desc("filename"), cl::init("-"));
 
-  // Interprocedural optimizations...
-  internalize, globaldce, swapstructs, sortstructs, poolalloc,
-};
+static cl::opt<bool>
+Force("f", cl::desc("Overwrite output files"));
 
-static Pass *createPrintFunctionPass() {
-  return new PrintFunctionPass("Current Function: \n", &cerr);
-}
+static cl::opt<bool>
+PrintEachXForm("p", cl::desc("Print module after each transformation"));
 
-static Pass *createPrintModulePass() {
-  return new PrintModulePass(&cerr);
-}
+static cl::opt<bool>
+NoOutput("disable-output",
+         cl::desc("Do not write result bytecode file"), cl::Hidden);
 
-// OptTable - Correlate enum Opts to Pass constructors...
-//
-struct {
-  enum Opts OptID;
-  Pass * (*PassCtor)();
-} OptTable[] = {
-  { dce        , createDeadCodeEliminationPass  },
-  { die        , createDeadInstEliminationPass  },
-  { constprop  , createConstantPropogationPass  }, 
-  { gcse       , createGCSEPass                 },
-  { inlining   , createFunctionInliningPass     },
-  { constmerge , createConstantMergePass        },
-  { strip      , createSymbolStrippingPass      },
-  { mstrip     , createFullSymbolStrippingPass  },
-  { mergereturn, createUnifyFunctionExitNodesPass },
-
-  { indvars    , createIndVarSimplifyPass         },
-  { instcombine, createInstructionCombiningPass   },
-  { sccp       , createSCCPPass                   },
-  { adce       , createAgressiveDCEPass           },
-  { raise      , createRaisePointerReferencesPass },
-  { mem2reg    , createPromoteMemoryToRegister    },
-  { lowerrefs,   createDecomposeMultiDimRefsPass  },
-
-  { trace      , createTraceValuesPassForBasicBlocks },
-  { tracem     , createTraceValuesPassForFunction    },
-  { paths      , createProfilePathsPass  },
-
-  { print      , createPrintFunctionPass },
-  { printm     , createPrintModulePass   },
-  { verify     , createVerifierPass      },
-
-  { raiseallocs, createRaiseAllocationsPass  },
-  { cleangcc   , createCleanupGCCOutputPass  },
-  { funcresolve, createFunctionResolvingPass },
-
-  { internalize, createInternalizePass  },
-  { 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"),
-  clEnumVal(gcse       , "Global Common Subexpression Elimination"),
- clEnumValN(inlining   , "inline", "Function integration"),
-  clEnumVal(constmerge , "Merge identical global constants"),
-  clEnumVal(strip      , "Strip symbols"),
-  clEnumVal(mstrip     , "Strip module symbols"),
-  clEnumVal(mergereturn, "Unify function 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(internalize, "Mark all fn's internal except for main"),
-  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 and Function trace code"),
-  clEnumVal(tracem     , "Insert Function trace code only"),
-  clEnumVal(paths      , "Insert path profiling instrumentation"),
-  clEnumVal(print      , "Print working function to stderr"),
-  clEnumVal(printm     , "Print working module to stderr"),
-  clEnumVal(verify     , "Verify module is well formed"),
-  clEnumVal(lowerrefs  , "Decompose multi-dimensional structure/array refs to use one index per instruction"),
-0);
+static cl::opt<bool>
+NoVerify("disable-verify", cl::desc("Do not verify result module"), cl::Hidden);
+
+static cl::opt<bool>
+Quiet("q", cl::desc("Don't print 'program modified' message"));
 
+static cl::alias
+QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
 
 
+//===----------------------------------------------------------------------===//
+// main for opt
+//
 int main(int argc, char **argv) {
   cl::ParseCommandLineOptions(argc, argv,
                              " llvm .bc -> .bc modular optimizer\n");
+  PrintStackTraceOnErrorSignal();
+
+  // Allocate a full target machine description only if necessary...
+  // FIXME: The choice of target should be controllable on the command line.
+  std::auto_ptr<TargetMachine> target;
+
+  TargetMachine* TM = NULL;
+  std::string ErrorMessage;
 
   // Load the input module...
-  std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
+  std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename, &ErrorMessage));
   if (M.get() == 0) {
-    cerr << "bytecode didn't read correctly.\n";
+    std::cerr << argv[0] << ": ";
+    if (ErrorMessage.size())
+      std::cerr << ErrorMessage << "\n";
+    else
+      std::cerr << "bytecode didn't read correctly.\n";
     return 1;
   }
 
   // Figure out what stream we are supposed to write to...
   std::ostream *Out = &std::cout;  // Default to printing to stdout...
-  if (OutputFilename != "") {
+  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";
+      std::cerr << argv[0] << ": 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 (!Out->good()) {
-      cerr << "Error opening " << OutputFilename << "!\n";
+      std::cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
       return 1;
     }
 
-    // Make sure that the Output file gets unlink'd from the disk if we get a
+    // Make sure that the Output file gets unlinked from the disk if we get a
     // SIGINT
     RemoveFileOnSignal(OutputFilename);
   }
 
+  // If the output is set to be emitted to standard out, and standard out is a
+  // console, print out a warning message and refuse to do it.  We don't impress
+  // anyone by spewing tons of binary goo to a terminal.
+  if (Out == &std::cout && isStandardOutAConsole() && !Force && !NoOutput) {
+    std::cerr << "WARNING: It looks like you're attempting to print out a "
+              << "bytecode file.  I'm\ngoing to pretend you didn't ask me to do"
+              << " this (for your own good).  If you\nREALLY want to taste LLVM"
+              << " bytecode first hand, you can force output with the\n'-f'"
+              << " option.\n\n";
+    NoOutput = true;
+  }
+
   // Create a PassManager to hold and optimize the collection of passes we are
   // about to build...
   //
   PassManager Passes;
 
+  // Add an appropriate TargetData instance for this module...
+  Passes.add(new TargetData("opt", M.get()));
+
   // 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;
-      }
+    const PassInfo *Opt = OptimizationList[i];
+    
+    if (Opt->getNormalCtor())
+      Passes.add(Opt->getNormalCtor()());
+    else if (Opt->getTargetCtor()) {
+#if 0
+      if (target.get() == NULL)
+        target.reset(allocateSparcTargetMachine()); // FIXME: target option
+#endif
+      assert(target.get() && "Could not allocate target machine!");
+      Passes.add(Opt->getTargetCtor()(*target.get()));
+    } else
+      std::cerr << argv[0] << ": cannot create pass: " << Opt->getPassName()
+                << "\n";
 
     if (PrintEachXForm)
       Passes.add(new PrintModulePass(&std::cerr));
   }
 
   // Check that the module is well formed on completion of optimization
-  Passes.add(createVerifierPass());
+  if (!NoVerify)
+    Passes.add(createVerifierPass());
 
   // Write bytecode out to disk or cout as the last step...
-  Passes.add(new WriteBytecodePass(Out, Out != &std::cout));
+  if (!NoOutput)
+    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 (Passes.run(*M.get()) && !Quiet)
+    std::cerr << "Program modified.\n";
 
   return 0;
 }