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