tools/opt/opt.cpp

   1 //===- opt.cpp - The LLVM Modular Optimizer -------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Optimizations may be specified an arbitrary number of times on the command
  11 // line, They are run in the order specified.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Module.h"
  16 #include "llvm/PassManager.h"
  17 #include "llvm/Bytecode/Reader.h"
  18 #include "llvm/Bytecode/WriteBytecodePass.h"
  19 #include "llvm/Assembly/PrintModulePass.h"
  20 #include "llvm/Analysis/Verifier.h"
  21 #include "llvm/Analysis/LoopPass.h"
  22 #include "llvm/Target/TargetData.h"
  23 #include "llvm/Target/TargetMachine.h"
  24 #include "llvm/Support/PassNameParser.h"
  25 #include "llvm/System/Signals.h"
  26 #include "llvm/Support/ManagedStatic.h"
  27 #include "llvm/Support/PluginLoader.h"
  28 #include "llvm/Support/Streams.h"
  29 #include "llvm/Support/SystemUtils.h"
  30 #include "llvm/Support/Timer.h"
  31 #include "llvm/LinkAllPasses.h"
  32 #include "llvm/LinkAllVMCore.h"
  33 #include <iostream>
  34 #include <fstream>
  35 #include <memory>
  36 #include <algorithm>
  37 using namespace llvm;
  38
  39 // The OptimizationList is automatically populated with registered Passes by the
  40 // PassNameParser.
  41 //
  42 static cl::list<const PassInfo*, bool, PassNameParser>
  43 PassList(cl::desc("Optimizations available:"));
  44
  45 static cl::opt<bool> NoCompress("disable-compression", cl::init(true),
  46        cl::desc("Don't compress the generated bytecode"));
  47
  48 // Other command line options...
  49 //
  50 static cl::opt<std::string>
  51 InputFilename(cl::Positional, cl::desc("<input bytecode file>"),
  52     cl::init("-"), cl::value_desc("filename"));
  53
  54 static cl::opt<std::string>
  55 OutputFilename("o", cl::desc("Override output filename"),
  56                cl::value_desc("filename"), cl::init("-"));
  57
  58 static cl::opt<bool>
  59 Force("f", cl::desc("Overwrite output files"));
  60
  61 static cl::opt<bool>
  62 PrintEachXForm("p", cl::desc("Print module after each transformation"));
  63
  64 static cl::opt<bool>
  65 NoOutput("disable-output",
  66          cl::desc("Do not write result bytecode file"), cl::Hidden);
  67
  68 static cl::opt<bool>
  69 NoVerify("disable-verify", cl::desc("Do not verify result module"), cl::Hidden);
  70
  71 static cl::opt<bool>
  72 VerifyEach("verify-each", cl::desc("Verify after each transform"));
  73
  74 static cl::opt<bool>
  75 StripDebug("strip-debug",
  76            cl::desc("Strip debugger symbol info from translation unit"));
  77
  78 static cl::opt<bool>
  79 DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
  80
  81 static cl::opt<bool>
  82 DisableOptimizations("disable-opt",
  83                      cl::desc("Do not run any optimization passes"));
  84
  85 static cl::opt<bool>
  86 StandardCompileOpts("std-compile-opts",
  87                    cl::desc("Include the standard compile time optimizations"));
  88
  89 static cl::opt<bool>
  90 Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
  91
  92 static cl::alias
  93 QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
  94
  95 static cl::opt<bool>
  96 AnalyzeOnly("analyze", cl::desc("Only perform analysis, no optimization"));
  97
  98 static Timer BytecodeLoadTimer("Bytecode Loader");
  99
 100 // ---------- Define Printers for module and function passes ------------
 101 namespace {
 102
 103 struct ModulePassPrinter : public ModulePass {
 104   const PassInfo *PassToPrint;
 105   ModulePassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
 106
 107   virtual bool runOnModule(Module &M) {
 108     if (!Quiet) {
 109       cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
 110       getAnalysisID<Pass>(PassToPrint).print(cout, &M);
 111     }
 112
 113     // Get and print pass...
 114     return false;
 115   }
 116
 117   virtual const char *getPassName() const { return "'Pass' Printer"; }
 118
 119   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 120     AU.addRequiredID(PassToPrint);
 121     AU.setPreservesAll();
 122   }
 123 };
 124
 125 struct FunctionPassPrinter : public FunctionPass {
 126   const PassInfo *PassToPrint;
 127   FunctionPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
 128
 129   virtual bool runOnFunction(Function &F) {
 130     if (!Quiet) {
 131       cout << "Printing analysis '" << PassToPrint->getPassName()
 132            << "' for function '" << F.getName() << "':\n";
 133     }
 134     // Get and print pass...
 135     getAnalysisID<Pass>(PassToPrint).print(cout, F.getParent());
 136     return false;
 137   }
 138
 139   virtual const char *getPassName() const { return "FunctionPass Printer"; }
 140
 141   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 142     AU.addRequiredID(PassToPrint);
 143     AU.setPreservesAll();
 144   }
 145 };
 146
 147 struct BasicBlockPassPrinter : public BasicBlockPass {
 148   const PassInfo *PassToPrint;
 149   BasicBlockPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
 150
 151   virtual bool runOnBasicBlock(BasicBlock &BB) {
 152     if (!Quiet) {
 153       cout << "Printing Analysis info for BasicBlock '" << BB.getName()
 154            << "': Pass " << PassToPrint->getPassName() << ":\n";
 155     }
 156
 157     // Get and print pass...
 158     getAnalysisID<Pass>(PassToPrint).print(cout, BB.getParent()->getParent());
 159     return false;
 160   }
 161
 162   virtual const char *getPassName() const { return "BasicBlockPass Printer"; }
 163
 164   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 165     AU.addRequiredID(PassToPrint);
 166     AU.setPreservesAll();
 167   }
 168 };
 169
 170 inline void addPass(PassManager &PM, Pass *P) {
 171   // Add the pass to the pass manager...
 172   PM.add(P);
 173
 174   // If we are verifying all of the intermediate steps, add the verifier...
 175   if (VerifyEach) PM.add(createVerifierPass());
 176 }
 177
 178 void AddStandardCompilePasses(PassManager &PM) {
 179   PM.add(createVerifierPass());                  // Verify that input is correct
 180
 181   addPass(PM, createLowerSetJmpPass());          // Lower llvm.setjmp/.longjmp
 182
 183   // If the -strip-debug command line option was specified, do it.
 184   if (StripDebug)
 185     addPass(PM, createStripSymbolsPass(true));
 186
 187   if (DisableOptimizations) return;
 188
 189   addPass(PM, createRaiseAllocationsPass());     // call %malloc -> malloc inst
 190   addPass(PM, createCFGSimplificationPass());    // Clean up disgusting code
 191   addPass(PM, createPromoteMemoryToRegisterPass());// Kill useless allocas
 192   addPass(PM, createGlobalOptimizerPass());      // Optimize out global vars
 193   addPass(PM, createGlobalDCEPass());            // Remove unused fns and globs
 194   addPass(PM, createIPConstantPropagationPass());// IP Constant Propagation
 195   addPass(PM, createDeadArgEliminationPass());   // Dead argument elimination
 196   addPass(PM, createInstructionCombiningPass()); // Clean up after IPCP & DAE
 197   addPass(PM, createCFGSimplificationPass());    // Clean up after IPCP & DAE
 198
 199   addPass(PM, createPruneEHPass());              // Remove dead EH info
 200
 201   if (!DisableInline)
 202     addPass(PM, createFunctionInliningPass());   // Inline small functions
 203   addPass(PM, createArgumentPromotionPass());    // Scalarize uninlined fn args
 204
 205   addPass(PM, createTailDuplicationPass());      // Simplify cfg by copying code
 206   addPass(PM, createInstructionCombiningPass()); // Cleanup for scalarrepl.
 207   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 208   addPass(PM, createScalarReplAggregatesPass()); // Break up aggregate allocas
 209   addPass(PM, createInstructionCombiningPass()); // Combine silly seq's
 210   addPass(PM, createCondPropagationPass());      // Propagate conditionals
 211
 212   addPass(PM, createTailCallEliminationPass());  // Eliminate tail calls
 213   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 214   addPass(PM, createReassociatePass());          // Reassociate expressions
 215   addPass(PM, createLICMPass());                 // Hoist loop invariants
 216   addPass(PM, createLoopUnswitchPass());         // Unswitch loops.
 217   addPass(PM, createInstructionCombiningPass()); // Clean up after LICM/reassoc
 218   addPass(PM, createIndVarSimplifyPass());       // Canonicalize indvars
 219   addPass(PM, createLoopUnrollPass());           // Unroll small loops
 220   addPass(PM, createInstructionCombiningPass()); // Clean up after the unroller
 221   addPass(PM, createLoadValueNumberingPass());   // GVN for load instructions
 222   addPass(PM, createGCSEPass());                 // Remove common subexprs
 223   addPass(PM, createSCCPPass());                 // Constant prop with SCCP
 224
 225   // Run instcombine after redundancy elimination to exploit opportunities
 226   // opened up by them.
 227   addPass(PM, createInstructionCombiningPass());
 228   addPass(PM, createCondPropagationPass());      // Propagate conditionals
 229
 230   addPass(PM, createDeadStoreEliminationPass()); // Delete dead stores
 231   addPass(PM, createAggressiveDCEPass());        // SSA based 'Aggressive DCE'
 232   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 233   addPass(PM, createSimplifyLibCallsPass());     // Library Call Optimizations
 234   addPass(PM, createDeadTypeEliminationPass());  // Eliminate dead types
 235   addPass(PM, createConstantMergePass());        // Merge dup global constants
 236 }
 237
 238 } // anonymous namespace
 239
 240
 241 //===----------------------------------------------------------------------===//
 242 // main for opt
 243 //
 244 int main(int argc, char **argv) {
 245   llvm_shutdown_obj X;  // Call llvm_shutdown() on exit.
 246   try {
 247     cl::ParseCommandLineOptions(argc, argv,
 248       " llvm .bc -> .bc modular optimizer and analysis printer \n");
 249     sys::PrintStackTraceOnErrorSignal();
 250
 251     // Allocate a full target machine description only if necessary.
 252     // FIXME: The choice of target should be controllable on the command line.
 253     std::auto_ptr<TargetMachine> target;
 254
 255     std::string ErrorMessage;
 256
 257     // Load the input module...
 258     std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename,
 259                             Compressor::decompressToNewBuffer, &ErrorMessage));
 260     if (M.get() == 0) {
 261       cerr << argv[0] << ": ";
 262       if (ErrorMessage.size())
 263         cerr << ErrorMessage << "\n";
 264       else
 265         cerr << "bytecode didn't read correctly.\n";
 266       return 1;
 267     }
 268
 269     // Figure out what stream we are supposed to write to...
 270     // FIXME: cout is not binary!
 271     std::ostream *Out = &std::cout;  // Default to printing to stdout...
 272     if (OutputFilename != "-") {
 273       if (!Force && std::ifstream(OutputFilename.c_str())) {
 274         // If force is not specified, make sure not to overwrite a file!
 275         cerr << argv[0] << ": error opening '" << OutputFilename
 276              << "': file exists!\n"
 277              << "Use -f command line argument to force output\n";
 278         return 1;
 279       }
 280       std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
 281                                    std::ios::binary;
 282       Out = new std::ofstream(OutputFilename.c_str(), io_mode);
 283
 284       if (!Out->good()) {
 285         cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
 286         return 1;
 287       }
 288
 289       // Make sure that the Output file gets unlinked from the disk if we get a
 290       // SIGINT
 291       sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 292     }
 293
 294     // If the output is set to be emitted to standard out, and standard out is a
 295     // console, print out a warning message and refuse to do it.  We don't
 296     // impress anyone by spewing tons of binary goo to a terminal.
 297     if (!Force && !NoOutput && CheckBytecodeOutputToConsole(Out,!Quiet)) {
 298       NoOutput = true;
 299     }
 300
 301     // Create a PassManager to hold and optimize the collection of passes we are
 302     // about to build...
 303     //
 304     PassManager Passes;
 305
 306     // Add an appropriate TargetData instance for this module...
 307     Passes.add(new TargetData(M.get()));
 308
 309     // If -std-compile-opts is given, add in all the standard compilation
 310     // optimizations first. This will handle -strip-debug, -disable-inline,
 311     // and -disable-opt as well.
 312     if (StandardCompileOpts)
 313       AddStandardCompilePasses(Passes);
 314
 315     // otherwise if the -strip-debug command line option was specified, add it.
 316     else if (StripDebug)
 317       addPass(Passes, createStripSymbolsPass(true));
 318
 319     // Create a new optimization pass for each one specified on the command line
 320     for (unsigned i = 0; i < PassList.size(); ++i) {
 321       const PassInfo *PassInf = PassList[i];
 322       Pass *P = 0;
 323       if (PassInf->getNormalCtor())
 324         P = PassInf->getNormalCtor()();
 325       else
 326         cerr << argv[0] << ": cannot create pass: "
 327              << PassInf->getPassName() << "\n";
 328       if (P) {
 329         addPass(Passes, P);
 330
 331         if (AnalyzeOnly) {
 332           if (dynamic_cast<BasicBlockPass*>(P))
 333             Passes.add(new BasicBlockPassPrinter(PassInf));
 334           else if (dynamic_cast<FunctionPass*>(P))
 335             Passes.add(new FunctionPassPrinter(PassInf));
 336           else
 337             Passes.add(new ModulePassPrinter(PassInf));
 338         }
 339       }
 340
 341       if (PrintEachXForm)
 342         Passes.add(new PrintModulePass(&cerr));
 343     }
 344
 345     // Check that the module is well formed on completion of optimization
 346     if (!NoVerify && !VerifyEach)
 347       Passes.add(createVerifierPass());
 348
 349     // Write bytecode out to disk or cout as the last step...
 350     OStream L(*Out);
 351     if (!NoOutput && !AnalyzeOnly)
 352       Passes.add(new WriteBytecodePass(&L, false, !NoCompress));
 353
 354     // Now that we have all of the passes ready, run them.
 355     Passes.run(*M.get());
 356
 357     return 0;
 358
 359   } catch (const std::string& msg) {
 360     cerr << argv[0] << ": " << msg << "\n";
 361   } catch (...) {
 362     cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
 363   }
 364   llvm_shutdown();
 365   return 1;
 366 }