tools/opt/opt.cpp

   1 //===----------------------------------------------------------------------===//
   2 // LLVM 'OPT' UTILITY
   3 //
   4 // Optimizations may be specified an arbitrary number of times on the command
   5 // line, they are run in the order specified.
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #include "llvm/Module.h"
  10 #include "llvm/PassManager.h"
  11 #include "llvm/Bytecode/Reader.h"
  12 #include "llvm/Bytecode/WriteBytecodePass.h"
  13 #include "llvm/Assembly/PrintModulePass.h"
  14 #include "llvm/Analysis/Verifier.h"
  15 #include "llvm/Transforms/UnifyMethodExitNodes.h"
  16 #include "llvm/Transforms/ConstantMerge.h"
  17 #include "llvm/Transforms/CleanupGCCOutput.h"
  18 #include "llvm/Transforms/LevelChange.h"
  19 #include "llvm/Transforms/MethodInlining.h"
  20 #include "llvm/Transforms/SymbolStripping.h"
  21 #include "llvm/Transforms/ChangeAllocations.h"
  22 #include "llvm/Transforms/IPO/SimpleStructMutation.h"
  23 #include "llvm/Transforms/IPO/GlobalDCE.h"
  24 #include "llvm/Transforms/Scalar/DCE.h"
  25 #include "llvm/Transforms/Scalar/ConstantProp.h"
  26 #include "llvm/Transforms/Scalar/IndVarSimplify.h"
  27 #include "llvm/Transforms/Scalar/InstructionCombining.h"
  28 #include "llvm/Transforms/Scalar/PromoteMemoryToRegister.h"
  29 #include "llvm/Transforms/Scalar/DecomposeMultiDimRefs.h"
  30 #include "llvm/Transforms/Instrumentation/TraceValues.h"
  31 #include "llvm/Transforms/Instrumentation/ProfilePaths.h"
  32 #include "Support/CommandLine.h"
  33 #include <fstream>
  34 #include <memory>
  35
  36 // Opts enum - All of the transformations we can do...
  37 enum Opts {
  38   // Basic optimizations
  39   dce, die, constprop, inlining, constmerge, strip, mstrip, mergereturn,
  40
  41   // Miscellaneous Transformations
  42   raiseallocs, cleangcc, lowerrefs,
  43
  44   // Printing and verifying...
  45   print, verify,
  46
  47   // More powerful optimizations
  48   indvars, instcombine, sccp, adce, raise, mem2reg,
  49
  50   // Instrumentation
  51   trace, tracem, paths,
  52
  53   // Interprocedural optimizations...
  54   globaldce, swapstructs, sortstructs,
  55 };
  56
  57 static Pass *createPrintMethodPass() {
  58   return new PrintMethodPass("Current Method: \n", &cerr);
  59 }
  60
  61 // OptTable - Correlate enum Opts to Pass constructors...
  62 //
  63 struct {
  64   enum Opts OptID;
  65   Pass * (*PassCtor)();
  66 } OptTable[] = {
  67   { dce        , createDeadCodeEliminationPass },
  68   { die        , createDeadInstEliminationPass },
  69   { constprop  , createConstantPropogationPass },
  70   { inlining   , createMethodInliningPass },
  71   { constmerge , createConstantMergePass },
  72   { strip      , createSymbolStrippingPass },
  73   { mstrip     , createFullSymbolStrippingPass },
  74   { mergereturn, createUnifyMethodExitNodesPass },
  75
  76   { indvars    , createIndVarSimplifyPass },
  77   { instcombine, createInstructionCombiningPass },
  78   { sccp       , createSCCPPass },
  79   { adce       , createAgressiveDCEPass },
  80   { raise      , createRaisePointerReferencesPass },
  81   { mem2reg    , createPromoteMemoryToRegister },
  82
  83   { trace      , createTraceValuesPassForBasicBlocks },
  84   { tracem     , createTraceValuesPassForMethod },
  85   { paths      , createProfilePathsPass },
  86
  87   { print      , createPrintMethodPass },
  88   { verify     , createVerifierPass },
  89
  90   { raiseallocs, createRaiseAllocationsPass },
  91   { cleangcc   , createCleanupGCCOutputPass },
  92   { globaldce  , createGlobalDCEPass },
  93   { swapstructs, createSwapElementsPass },
  94   { sortstructs, createSortElementsPass },
  95   { lowerrefs,   createDecomposeMultiDimRefsPass }
  96 };
  97
  98 // Command line option handling code...
  99 //
 100 cl::String InputFilename ("", "Load <arg> file to optimize", cl::NoFlags, "-");
 101 cl::String OutputFilename("o", "Override output filename", cl::NoFlags, "");
 102 cl::Flag   Force         ("f", "Overwrite output files", cl::NoFlags, false);
 103 cl::Flag   PrintEachXForm("p", "Print module after each transformation");
 104 cl::Flag   Quiet         ("q", "Don't print modifying pass names", 0, false);
 105 cl::Alias  QuietA        ("quiet", "Alias for -q", cl::NoFlags, Quiet);
 106 cl::EnumList<enum Opts> OptimizationList(cl::NoFlags,
 107   clEnumVal(dce        , "Dead Code Elimination"),
 108   clEnumVal(die        , "Dead Instruction Elimination"),
 109   clEnumVal(constprop  , "Simple constant propogation"),
 110  clEnumValN(inlining   , "inline", "Method integration"),
 111   clEnumVal(constmerge , "Merge identical global constants"),
 112   clEnumVal(strip      , "Strip symbols"),
 113   clEnumVal(mstrip     , "Strip module symbols"),
 114   clEnumVal(mergereturn, "Unify method exit nodes"),
 115
 116   clEnumVal(indvars    , "Simplify Induction Variables"),
 117   clEnumVal(instcombine, "Combine redundant instructions"),
 118   clEnumVal(sccp       , "Sparse Conditional Constant Propogation"),
 119   clEnumVal(adce       , "Agressive DCE"),
 120   clEnumVal(mem2reg    , "Promote alloca locations to registers"),
 121
 122   clEnumVal(globaldce  , "Remove unreachable globals"),
 123   clEnumVal(swapstructs, "Swap structure types around"),
 124   clEnumVal(sortstructs, "Sort structure elements"),
 125
 126   clEnumVal(raiseallocs, "Raise allocations from calls to instructions"),
 127   clEnumVal(cleangcc   , "Cleanup GCC Output"),
 128   clEnumVal(raise      , "Raise to Higher Level"),
 129   clEnumVal(trace      , "Insert BB & Method trace code"),
 130   clEnumVal(tracem     , "Insert Method trace code only"),
 131   clEnumVal(paths      , "Insert path profiling instrumentation"),
 132   clEnumVal(print      , "Print working method to stderr"),
 133   clEnumVal(verify     , "Verify module is well formed"),
 134   clEnumVal(lowerrefs  , "Decompose multi-dimensional structure/array refs to use one index per instruction"),
 135 0);
 136
 137
 138
 139 int main(int argc, char **argv) {
 140   cl::ParseCommandLineOptions(argc, argv,
 141                               " llvm .bc -> .bc modular optimizer\n");
 142
 143   // Load the input module...
 144   std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
 145   if (M.get() == 0) {
 146     cerr << "bytecode didn't read correctly.\n";
 147     return 1;
 148   }
 149
 150   // Figure out what stream we are supposed to write to...
 151   std::ostream *Out = &std::cout;  // Default to printing to stdout...
 152   if (OutputFilename != "") {
 153     if (!Force && std::ifstream(OutputFilename.c_str())) {
 154       // If force is not specified, make sure not to overwrite a file!
 155       cerr << "Error opening '" << OutputFilename << "': File exists!\n"
 156            << "Use -f command line argument to force output\n";
 157       return 1;
 158     }
 159     Out = new std::ofstream(OutputFilename.c_str());
 160
 161     if (!Out->good()) {
 162       cerr << "Error opening " << OutputFilename << "!\n";
 163       return 1;
 164     }
 165   }
 166
 167   // Create a PassManager to hold and optimize the collection of passes we are
 168   // about to build...
 169   //
 170   PassManager Passes;
 171
 172   // Create a new optimization pass for each one specified on the command line
 173   for (unsigned i = 0; i < OptimizationList.size(); ++i) {
 174     enum Opts Opt = OptimizationList[i];
 175     for (unsigned j = 0; j < sizeof(OptTable)/sizeof(OptTable[0]); ++j)
 176       if (Opt == OptTable[j].OptID) {
 177         Passes.add(OptTable[j].PassCtor());
 178         break;
 179       }
 180
 181     if (PrintEachXForm)
 182       Passes.add(new PrintModulePass(&std::cerr));
 183   }
 184
 185   // Check that the module is well formed on completion of optimization
 186   Passes.add(createVerifierPass());
 187
 188   // Write bytecode out to disk or cout as the last step...
 189   Passes.add(new WriteBytecodePass(Out, Out != &std::cout));
 190
 191   // Now that we have all of the passes ready, run them.
 192   if (Passes.run(M.get()) && !Quiet)
 193     cerr << "Program modified.\n";
 194
 195   return 0;
 196 }