Fix spelling and grammar in a comment.
[oota-llvm.git] / tools / llvm-ld / Optimize.cpp
index 41111f93fc8471d73f8ddddaf0602a7babc7aefa..cbdf2f74990a6c9873a434b976857fd6b638ccb9 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by Reid Spencer and is distributed under the
-// University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 #include "llvm/PassManager.h"
 #include "llvm/Analysis/LoadValueNumbering.h"
 #include "llvm/Analysis/Passes.h"
+#include "llvm/Analysis/LoopPass.h"
 #include "llvm/Analysis/Verifier.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/System/DynamicLibrary.h"
 #include "llvm/Target/TargetData.h"
+#include "llvm/Target/TargetMachine.h"
 #include "llvm/Transforms/IPO.h"
 #include "llvm/Transforms/Scalar.h"
+#include "llvm/Support/PassNameParser.h"
+#include "llvm/Support/PluginLoader.h"
+#include <iostream>
 using namespace llvm;
 
-// Optimization Options
+// Pass Name Options as generated by the PassNameParser
+static cl::list<const PassInfo*, bool, PassNameParser>
+  OptimizationList(cl::desc("Optimizations available:"));
+
+//Don't verify at the end
+static cl::opt<bool> DontVerify("disable-verify", cl::ReallyHidden);
 
+// Optimization Enumeration
 enum OptimizationLevels {
   OPT_FAST_COMPILE         = 1,
   OPT_SIMPLE               = 2,
@@ -33,6 +44,7 @@ enum OptimizationLevels {
   OPT_AGGRESSIVE_LINK_TIME = 5
 };
 
+// Optimization Options
 static cl::opt<OptimizationLevels> OptLevel(
   cl::desc("Choose level of optimization to apply:"),
   cl::init(OPT_FAST_COMPILE), cl::values(
@@ -62,19 +74,24 @@ DisableOptimizations("disable-opt",
 static cl::opt<bool> DisableInternalize("disable-internalize",
   cl::desc("Do not mark all symbols as internal"));
 
-static cl::opt<bool> Verify("verify",
-  cl::desc("Verify intermediate results of all passes"));
-
-static cl::opt<bool> Strip("s",
-  cl::desc("Strip symbol info from executable"));
+static cl::opt<bool> VerifyEach("verify-each",
+ cl::desc("Verify intermediate results of all passes"));
 
 static cl::alias ExportDynamic("export-dynamic",
   cl::aliasopt(DisableInternalize),
   cl::desc("Alias for -disable-internalize"));
 
-static cl::list<std::string> LoadableModules("load",
-  cl::value_desc("path to loadable optimization module"),
-  cl::desc("Load an optimization module and run it"));
+static cl::opt<bool> Strip("strip-all", 
+  cl::desc("Strip all symbol info from executable"));
+
+static cl::alias A0("s", cl::desc("Alias for --strip-all"), 
+  cl::aliasopt(Strip));
+
+static cl::opt<bool> StripDebug("strip-debug",
+  cl::desc("Strip debugger symbol info from executable"));
+
+static cl::alias A1("S", cl::desc("Alias for --strip-debug"),
+  cl::aliasopt(StripDebug));
 
 // A utility function that adds a pass to the pass manager but will also add
 // a verifier pass after if we're supposed to verify.
@@ -83,7 +100,7 @@ static inline void addPass(PassManager &PM, Pass *P) {
   PM.add(P);
 
   // If we are verifying all of the intermediate steps, add the verifier...
-  if (Verify)
+  if (VerifyEach)
     PM.add(createVerifierPass());
 }
 
@@ -98,23 +115,23 @@ void Optimize(Module* M) {
   PassManager Passes;
 
   // If we're verifying, start off with a verification pass.
-  if (Verify)
+  if (VerifyEach)
     Passes.add(createVerifierPass());
 
   // Add an appropriate TargetData instance for this module...
-  addPass(Passes, new TargetData("gccld", M));
-
-  // Often if the programmer does not specify proper prototypes for the
-  // functions they are calling, they end up calling a vararg version of the
-  // function that does not get a body filled in (the real function has typed
-  // arguments).  This pass merges the two functions.
-  addPass(Passes, createFunctionResolvingPass());
+  addPass(Passes, new TargetData(M));
 
   if (!DisableOptimizations) {
     // Now that composite has been compiled, scan through the module, looking
     // for a main function.  If main is defined, mark all other functions
     // internal.
-    addPass(Passes, createInternalizePass(!DisableInternalize));
+    if (!DisableInternalize)
+      addPass(Passes, createInternalizePass(true));
+
+    // Propagate constants at call sites into the functions they call.  This
+    // opens opportunities for globalopt (and inlining) by substituting function
+    // pointers passed as arguments to direct uses of functions.  
+    addPass(Passes, createIPSCCPPass());
 
     // Now that we internalized some globals, see if we can hack on them!
     addPass(Passes, createGlobalOptimizerPass());
@@ -123,22 +140,20 @@ void Optimize(Module* M) {
     // keep one copy of each constant...
     addPass(Passes, createConstantMergePass());
 
-    // If the -s command line option was specified, strip the symbols out of the
-    // resulting program to make it smaller.  -s is a GLD option that we are
-    // supporting.
-    if (Strip)
-      addPass(Passes, createStripSymbolsPass());
-
-    // Propagate constants at call sites into the functions they call.
-    addPass(Passes, createIPConstantPropagationPass());
-
     // Remove unused arguments from functions...
     addPass(Passes, createDeadArgEliminationPass());
 
+    // Reduce the code after globalopt and ipsccp.  Both can open up significant
+    // simplification opportunities, and both can propagate functions through
+    // function pointers.  When this happens, we often have to resolve varargs
+    // calls, etc, so let instcombine do this.
+    addPass(Passes, createInstructionCombiningPass());
+
     if (!DisableInline)
       addPass(Passes, createFunctionInliningPass()); // Inline small functions
 
     addPass(Passes, createPruneEHPass());            // Remove dead EH info
+    addPass(Passes, createGlobalOptimizerPass());    // Optimize globals again.
     addPass(Passes, createGlobalDCEPass());          // Remove dead functions
 
     // If we didn't decide to inline a function, check to see if we can
@@ -147,20 +162,22 @@ void Optimize(Module* M) {
 
     // The IPO passes may leave cruft around.  Clean up after them.
     addPass(Passes, createInstructionCombiningPass());
-
+    addPass(Passes, createJumpThreadingPass());        // Thread jumps.
     addPass(Passes, createScalarReplAggregatesPass()); // Break up allocas
 
     // Run a few AA driven optimizations here and now, to cleanup the code.
     addPass(Passes, createGlobalsModRefPass());      // IP alias analysis
 
     addPass(Passes, createLICMPass());               // Hoist loop invariants
-    addPass(Passes, createLoadValueNumberingPass()); // GVN for load instrs
-    addPass(Passes, createGCSEPass());               // Remove common subexprs
+    addPass(Passes, createGVNPass());                  // Remove redundancies
+    addPass(Passes, createMemCpyOptPass());          // Remove dead memcpy's
     addPass(Passes, createDeadStoreEliminationPass()); // Nuke dead stores
 
     // Cleanup and simplify the code after the scalar optimizations.
     addPass(Passes, createInstructionCombiningPass());
 
+    addPass(Passes, createJumpThreadingPass());        // Thread jumps.
+
     // Delete basic blocks, which optimization passes may have killed...
     addPass(Passes, createCFGSimplificationPass());
 
@@ -168,22 +185,35 @@ void Optimize(Module* M) {
     addPass(Passes, createGlobalDCEPass());
   }
 
-  std::vector<std::string> plugins = LoadableModules;
-  for (std::vector<std::string>::iterator I = plugins.begin(),
-      E = plugins.end(); I != E; ++I) {
-    sys::DynamicLibrary dll(I->c_str());
-    typedef void (*OptimizeFunc)(PassManager&,int);
-    OptimizeFunc OF = OptimizeFunc(
-        (intptr_t)dll.GetAddressOfSymbol("RunOptimizations"));
-    if (OF == 0) {
-      throw std::string("Optimization Module '") + *I +
-        "' is missing the RunOptimizations symbol";
-    }
-    (*OF)(Passes,OptLevel);
+  // If the -s or -S command line options were specified, strip the symbols out
+  // of the resulting program to make it smaller.  -s and -S are GNU ld options
+  // that we are supporting; they alias -strip-all and -strip-debug.
+  if (Strip || StripDebug)
+    addPass(Passes, createStripSymbolsPass(StripDebug && !Strip));
+
+  // Create a new optimization pass for each one specified on the command line
+  std::auto_ptr<TargetMachine> target;
+  for (unsigned i = 0; i < OptimizationList.size(); ++i) {
+    const PassInfo *Opt = OptimizationList[i];
+    if (Opt->getNormalCtor())
+      addPass(Passes, Opt->getNormalCtor()());
+    else
+      std::cerr << "llvm-ld: cannot create pass: " << Opt->getPassName() 
+                << "\n";
+  }
+
+  // The user's passes may leave cruft around. Clean up after them them but
+  // only if we haven't got DisableOptimizations set
+  if (!DisableOptimizations) {
+    addPass(Passes, createInstructionCombiningPass());
+    addPass(Passes, createCFGSimplificationPass());
+    addPass(Passes, createDeadCodeEliminationPass());
+    addPass(Passes, createGlobalDCEPass());
   }
 
   // Make sure everything is still good.
-  Passes.add(createVerifierPass());
+  if (!DontVerify)
+    Passes.add(createVerifierPass());
 
   // Run our queue of passes all at once now, efficiently.
   Passes.run(*M);