tools/opt/opt.cpp

   1 //===- opt.cpp - The LLVM Modular Optimizer -------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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/LLVMContext.h"
  16 #include "llvm/Module.h"
  17 #include "llvm/ModuleProvider.h"
  18 #include "llvm/PassManager.h"
  19 #include "llvm/CallGraphSCCPass.h"
  20 #include "llvm/Bitcode/ReaderWriter.h"
  21 #include "llvm/Assembly/PrintModulePass.h"
  22 #include "llvm/Analysis/Verifier.h"
  23 #include "llvm/Analysis/LoopPass.h"
  24 #include "llvm/Analysis/CallGraph.h"
  25 #include "llvm/Target/TargetData.h"
  26 #include "llvm/Target/TargetMachine.h"
  27 #include "llvm/Support/PassNameParser.h"
  28 #include "llvm/System/Signals.h"
  29 #include "llvm/Support/ManagedStatic.h"
  30 #include "llvm/Support/MemoryBuffer.h"
  31 #include "llvm/Support/PluginLoader.h"
  32 #include "llvm/Support/StandardPasses.h"
  33 #include "llvm/Support/SystemUtils.h"
  34 #include "llvm/Support/raw_ostream.h"
  35 #include "llvm/LinkAllPasses.h"
  36 #include "llvm/LinkAllVMCore.h"
  37 #include <memory>
  38 #include <algorithm>
  39 using namespace llvm;
  40
  41 // The OptimizationList is automatically populated with registered Passes by the
  42 // PassNameParser.
  43 //
  44 static cl::list<const PassInfo*, bool, PassNameParser>
  45 PassList(cl::desc("Optimizations available:"));
  46
  47 // Other command line options...
  48 //
  49 static cl::opt<std::string>
  50 InputFilename(cl::Positional, cl::desc("<input bitcode file>"),
  51     cl::init("-"), cl::value_desc("filename"));
  52
  53 static cl::opt<std::string>
  54 OutputFilename("o", cl::desc("Override output filename"),
  55                cl::value_desc("filename"), cl::init("-"));
  56
  57 static cl::opt<bool>
  58 Force("f", cl::desc("Overwrite output files"));
  59
  60 static cl::opt<bool>
  61 PrintEachXForm("p", cl::desc("Print module after each transformation"));
  62
  63 static cl::opt<bool>
  64 NoOutput("disable-output",
  65          cl::desc("Do not write result bitcode file"), cl::Hidden);
  66
  67 static cl::opt<bool>
  68 NoVerify("disable-verify", cl::desc("Do not verify result module"), cl::Hidden);
  69
  70 static cl::opt<bool>
  71 VerifyEach("verify-each", cl::desc("Verify after each transform"));
  72
  73 static cl::opt<bool>
  74 StripDebug("strip-debug",
  75            cl::desc("Strip debugger symbol info from translation unit"));
  76
  77 static cl::opt<bool>
  78 DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
  79
  80 static cl::opt<bool>
  81 DisableOptimizations("disable-opt",
  82                      cl::desc("Do not run any optimization passes"));
  83
  84 static cl::opt<bool>
  85 DisableInternalize("disable-internalize",
  86                    cl::desc("Do not mark all symbols as internal"));
  87
  88 static cl::opt<bool>
  89 StandardCompileOpts("std-compile-opts",
  90                    cl::desc("Include the standard compile time optimizations"));
  91
  92 static cl::opt<bool>
  93 StandardLinkOpts("std-link-opts",
  94                  cl::desc("Include the standard link time optimizations"));
  95
  96 static cl::opt<bool>
  97 OptLevelO1("O1",
  98            cl::desc("Optimization level 1. Similar to llvm-gcc -O1"));
  99
 100 static cl::opt<bool>
 101 OptLevelO2("O2",
 102            cl::desc("Optimization level 2. Similar to llvm-gcc -O2"));
 103
 104 static cl::opt<bool>
 105 OptLevelO3("O3",
 106            cl::desc("Optimization level 3. Similar to llvm-gcc -O3"));
 107
 108 static cl::opt<bool>
 109 UnitAtATime("funit-at-a-time",
 110             cl::desc("Enable IPO. This is same as llvm-gcc's -funit-at-a-time"),
 111             cl::init(true));
 112
 113 static cl::opt<bool>
 114 DisableSimplifyLibCalls("disable-simplify-libcalls",
 115                         cl::desc("Disable simplify-libcalls"));
 116
 117 static cl::opt<bool>
 118 Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
 119
 120 static cl::alias
 121 QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
 122
 123 static cl::opt<bool>
 124 AnalyzeOnly("analyze", cl::desc("Only perform analysis, no optimization"));
 125
 126 // ---------- Define Printers for module and function passes ------------
 127 namespace {
 128
 129 struct CallGraphSCCPassPrinter : public CallGraphSCCPass {
 130   static char ID;
 131   const PassInfo *PassToPrint;
 132   CallGraphSCCPassPrinter(const PassInfo *PI) :
 133     CallGraphSCCPass(&ID), PassToPrint(PI) {}
 134
 135   virtual bool runOnSCC(const std::vector<CallGraphNode *>&SCC) {
 136     if (!Quiet) {
 137       outs() << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
 138
 139       for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
 140         Function *F = SCC[i]->getFunction();
 141         if (F) {
 142           outs().flush();
 143           getAnalysisID<Pass>(PassToPrint).print(outs(), F->getParent());
 144           cout << std::flush;
 145         }
 146       }
 147     }
 148     // Get and print pass...
 149     return false;
 150   }
 151
 152   virtual const char *getPassName() const { return "'Pass' Printer"; }
 153
 154   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 155     AU.addRequiredID(PassToPrint);
 156     AU.setPreservesAll();
 157   }
 158 };
 159
 160 char CallGraphSCCPassPrinter::ID = 0;
 161
 162 struct ModulePassPrinter : public ModulePass {
 163   static char ID;
 164   const PassInfo *PassToPrint;
 165   ModulePassPrinter(const PassInfo *PI) : ModulePass(&ID),
 166                                           PassToPrint(PI) {}
 167
 168   virtual bool runOnModule(Module &M) {
 169     if (!Quiet) {
 170       outs() << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
 171       outs().flush();
 172       getAnalysisID<Pass>(PassToPrint).print(outs(), &M);
 173       cout << std::flush;
 174     }
 175
 176     // Get and print pass...
 177     return false;
 178   }
 179
 180   virtual const char *getPassName() const { return "'Pass' Printer"; }
 181
 182   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 183     AU.addRequiredID(PassToPrint);
 184     AU.setPreservesAll();
 185   }
 186 };
 187
 188 char ModulePassPrinter::ID = 0;
 189 struct FunctionPassPrinter : public FunctionPass {
 190   const PassInfo *PassToPrint;
 191   static char ID;
 192   FunctionPassPrinter(const PassInfo *PI) : FunctionPass(&ID),
 193                                             PassToPrint(PI) {}
 194
 195   virtual bool runOnFunction(Function &F) {
 196     if (!Quiet) {
 197       outs() << "Printing analysis '" << PassToPrint->getPassName()
 198               << "' for function '" << F.getName() << "':\n";
 199     }
 200     // Get and print pass...
 201     outs().flush();
 202     getAnalysisID<Pass>(PassToPrint).print(outs(), F.getParent());
 203     cout << std::flush;
 204     return false;
 205   }
 206
 207   virtual const char *getPassName() const { return "FunctionPass Printer"; }
 208
 209   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 210     AU.addRequiredID(PassToPrint);
 211     AU.setPreservesAll();
 212   }
 213 };
 214
 215 char FunctionPassPrinter::ID = 0;
 216
 217 struct LoopPassPrinter : public LoopPass {
 218   static char ID;
 219   const PassInfo *PassToPrint;
 220   LoopPassPrinter(const PassInfo *PI) :
 221     LoopPass(&ID), PassToPrint(PI) {}
 222
 223   virtual bool runOnLoop(Loop *L, LPPassManager &LPM) {
 224     if (!Quiet) {
 225       outs() << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
 226       outs().flush();
 227       getAnalysisID<Pass>(PassToPrint).print(outs(),
 228                                   L->getHeader()->getParent()->getParent());
 229       cout << std::flush;
 230     }
 231     // Get and print pass...
 232     return false;
 233   }
 234
 235   virtual const char *getPassName() const { return "'Pass' Printer"; }
 236
 237   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 238     AU.addRequiredID(PassToPrint);
 239     AU.setPreservesAll();
 240   }
 241 };
 242
 243 char LoopPassPrinter::ID = 0;
 244
 245 struct BasicBlockPassPrinter : public BasicBlockPass {
 246   const PassInfo *PassToPrint;
 247   static char ID;
 248   BasicBlockPassPrinter(const PassInfo *PI)
 249     : BasicBlockPass(&ID), PassToPrint(PI) {}
 250
 251   virtual bool runOnBasicBlock(BasicBlock &BB) {
 252     if (!Quiet) {
 253       outs() << "Printing Analysis info for BasicBlock '" << BB.getName()
 254              << "': Pass " << PassToPrint->getPassName() << ":\n";
 255     }
 256
 257     // Get and print pass...
 258     outs().flush();
 259     getAnalysisID<Pass>(PassToPrint).print(outs(), BB.getParent()->getParent());
 260     cout << std::flush;
 261     return false;
 262   }
 263
 264   virtual const char *getPassName() const { return "BasicBlockPass Printer"; }
 265
 266   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 267     AU.addRequiredID(PassToPrint);
 268     AU.setPreservesAll();
 269   }
 270 };
 271
 272 char BasicBlockPassPrinter::ID = 0;
 273 inline void addPass(PassManager &PM, Pass *P) {
 274   // Add the pass to the pass manager...
 275   PM.add(P);
 276
 277   // If we are verifying all of the intermediate steps, add the verifier...
 278   if (VerifyEach) PM.add(createVerifierPass());
 279 }
 280
 281 /// AddOptimizationPasses - This routine adds optimization passes
 282 /// based on selected optimization level, OptLevel. This routine
 283 /// duplicates llvm-gcc behaviour.
 284 ///
 285 /// OptLevel - Optimization Level
 286 void AddOptimizationPasses(PassManager &MPM, FunctionPassManager &FPM,
 287                            unsigned OptLevel) {
 288   createStandardFunctionPasses(&FPM, OptLevel);
 289
 290   llvm::Pass *InliningPass = OptLevel > 1 ? createFunctionInliningPass() : 0;
 291   createStandardModulePasses(&MPM, OptLevel,
 292                              /*OptimizeSize=*/ false,
 293                              UnitAtATime,
 294                              /*UnrollLoops=*/ OptLevel > 1,
 295                              !DisableSimplifyLibCalls,
 296                              /*HaveExceptions=*/ true,
 297                              InliningPass);
 298 }
 299
 300 void AddStandardCompilePasses(PassManager &PM) {
 301   PM.add(createVerifierPass());                  // Verify that input is correct
 302
 303   addPass(PM, createLowerSetJmpPass());          // Lower llvm.setjmp/.longjmp
 304
 305   // If the -strip-debug command line option was specified, do it.
 306   if (StripDebug)
 307     addPass(PM, createStripSymbolsPass(true));
 308
 309   if (DisableOptimizations) return;
 310
 311   llvm::Pass *InliningPass = !DisableInline ? createFunctionInliningPass() : 0;
 312
 313   // -std-compile-opts adds the same module passes as -O3.
 314   createStandardModulePasses(&PM, 3,
 315                              /*OptimizeSize=*/ false,
 316                              /*UnitAtATime=*/ true,
 317                              /*UnrollLoops=*/ true,
 318                              /*SimplifyLibCalls=*/ true,
 319                              /*HaveExceptions=*/ true,
 320                              InliningPass);
 321 }
 322
 323 void AddStandardLinkPasses(PassManager &PM) {
 324   PM.add(createVerifierPass());                  // Verify that input is correct
 325
 326   // If the -strip-debug command line option was specified, do it.
 327   if (StripDebug)
 328     addPass(PM, createStripSymbolsPass(true));
 329
 330   if (DisableOptimizations) return;
 331
 332   createStandardLTOPasses(&PM, /*Internalize=*/ !DisableInternalize,
 333                           /*RunInliner=*/ !DisableInline,
 334                           /*VerifyEach=*/ VerifyEach);
 335 }
 336
 337 } // anonymous namespace
 338
 339
 340 //===----------------------------------------------------------------------===//
 341 // main for opt
 342 //
 343 int main(int argc, char **argv) {
 344   llvm_shutdown_obj X;  // Call llvm_shutdown() on exit.
 345   LLVMContext &Context = getGlobalContext();
 346   try {
 347     cl::ParseCommandLineOptions(argc, argv,
 348       "llvm .bc -> .bc modular optimizer and analysis printer\n");
 349     sys::PrintStackTraceOnErrorSignal();
 350
 351     // Allocate a full target machine description only if necessary.
 352     // FIXME: The choice of target should be controllable on the command line.
 353     std::auto_ptr<TargetMachine> target;
 354
 355     std::string ErrorMessage;
 356
 357     // Load the input module...
 358     std::auto_ptr<Module> M;
 359     if (MemoryBuffer *Buffer
 360           = MemoryBuffer::getFileOrSTDIN(InputFilename, &ErrorMessage)) {
 361       M.reset(ParseBitcodeFile(Buffer, Context, &ErrorMessage));
 362       delete Buffer;
 363     }
 364
 365     if (M.get() == 0) {
 366       errs() << argv[0] << ": ";
 367       if (ErrorMessage.size())
 368         errs() << ErrorMessage << "\n";
 369       else
 370         errs() << "bitcode didn't read correctly.\n";
 371       return 1;
 372     }
 373
 374     // Figure out what stream we are supposed to write to...
 375     // FIXME: outs() is not binary!
 376     raw_ostream *Out = &outs();  // Default to printing to stdout...
 377     if (OutputFilename != "-") {
 378       std::string ErrorInfo;
 379       Out = new raw_fd_ostream(OutputFilename.c_str(), ErrorInfo,
 380                                raw_fd_ostream::F_Binary |
 381                                (Force ? raw_fd_ostream::F_Force : 0));
 382       if (!ErrorInfo.empty()) {
 383         errs() << ErrorInfo << '\n';
 384         if (!Force)
 385           errs() << "Use -f command line argument to force output\n";
 386         delete Out;
 387         return 1;
 388       }
 389
 390       // Make sure that the Output file gets unlinked from the disk if we get a
 391       // SIGINT
 392       sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 393     }
 394
 395     // If the output is set to be emitted to standard out, and standard out is a
 396     // console, print out a warning message and refuse to do it.  We don't
 397     // impress anyone by spewing tons of binary goo to a terminal.
 398     if (!Force && !NoOutput && CheckBitcodeOutputToConsole(Out,!Quiet)) {
 399       NoOutput = true;
 400     }
 401
 402     // Create a PassManager to hold and optimize the collection of passes we are
 403     // about to build...
 404     //
 405     PassManager Passes;
 406
 407     // Add an appropriate TargetData instance for this module...
 408     Passes.add(new TargetData(M.get()));
 409
 410     FunctionPassManager *FPasses = NULL;
 411     if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
 412       FPasses = new FunctionPassManager(new ExistingModuleProvider(M.get()));
 413       FPasses->add(new TargetData(M.get()));
 414     }
 415
 416     // If the -strip-debug command line option was specified, add it.  If
 417     // -std-compile-opts was also specified, it will handle StripDebug.
 418     if (StripDebug && !StandardCompileOpts)
 419       addPass(Passes, createStripSymbolsPass(true));
 420
 421     // Create a new optimization pass for each one specified on the command line
 422     for (unsigned i = 0; i < PassList.size(); ++i) {
 423       // Check to see if -std-compile-opts was specified before this option.  If
 424       // so, handle it.
 425       if (StandardCompileOpts &&
 426           StandardCompileOpts.getPosition() < PassList.getPosition(i)) {
 427         AddStandardCompilePasses(Passes);
 428         StandardCompileOpts = false;
 429       }
 430
 431       if (StandardLinkOpts &&
 432           StandardLinkOpts.getPosition() < PassList.getPosition(i)) {
 433         AddStandardLinkPasses(Passes);
 434         StandardLinkOpts = false;
 435       }
 436
 437       if (OptLevelO1 && OptLevelO1.getPosition() < PassList.getPosition(i)) {
 438         AddOptimizationPasses(Passes, *FPasses, 1);
 439         OptLevelO1 = false;
 440       }
 441
 442       if (OptLevelO2 && OptLevelO2.getPosition() < PassList.getPosition(i)) {
 443         AddOptimizationPasses(Passes, *FPasses, 2);
 444         OptLevelO2 = false;
 445       }
 446
 447       if (OptLevelO3 && OptLevelO3.getPosition() < PassList.getPosition(i)) {
 448         AddOptimizationPasses(Passes, *FPasses, 3);
 449         OptLevelO3 = false;
 450       }
 451
 452       const PassInfo *PassInf = PassList[i];
 453       Pass *P = 0;
 454       if (PassInf->getNormalCtor())
 455         P = PassInf->getNormalCtor()();
 456       else
 457         errs() << argv[0] << ": cannot create pass: "
 458                << PassInf->getPassName() << "\n";
 459       if (P) {
 460         bool isBBPass = dynamic_cast<BasicBlockPass*>(P) != 0;
 461         bool isLPass = !isBBPass && dynamic_cast<LoopPass*>(P) != 0;
 462         bool isFPass = !isLPass && dynamic_cast<FunctionPass*>(P) != 0;
 463         bool isCGSCCPass = !isFPass && dynamic_cast<CallGraphSCCPass*>(P) != 0;
 464
 465         addPass(Passes, P);
 466
 467         if (AnalyzeOnly) {
 468           if (isBBPass)
 469             Passes.add(new BasicBlockPassPrinter(PassInf));
 470           else if (isLPass)
 471             Passes.add(new LoopPassPrinter(PassInf));
 472           else if (isFPass)
 473             Passes.add(new FunctionPassPrinter(PassInf));
 474           else if (isCGSCCPass)
 475             Passes.add(new CallGraphSCCPassPrinter(PassInf));
 476           else
 477             Passes.add(new ModulePassPrinter(PassInf));
 478         }
 479       }
 480
 481       if (PrintEachXForm)
 482         Passes.add(createPrintModulePass(&errs()));
 483     }
 484
 485     // If -std-compile-opts was specified at the end of the pass list, add them.
 486     if (StandardCompileOpts) {
 487       AddStandardCompilePasses(Passes);
 488       StandardCompileOpts = false;
 489     }
 490
 491     if (StandardLinkOpts) {
 492       AddStandardLinkPasses(Passes);
 493       StandardLinkOpts = false;
 494     }
 495
 496     if (OptLevelO1) {
 497       AddOptimizationPasses(Passes, *FPasses, 1);
 498     }
 499
 500     if (OptLevelO2) {
 501       AddOptimizationPasses(Passes, *FPasses, 2);
 502     }
 503
 504     if (OptLevelO3) {
 505       AddOptimizationPasses(Passes, *FPasses, 3);
 506     }
 507
 508     if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
 509       FPasses->doInitialization();
 510       for (Module::iterator I = M.get()->begin(), E = M.get()->end();
 511            I != E; ++I)
 512         FPasses->run(*I);
 513     }
 514
 515     // Check that the module is well formed on completion of optimization
 516     if (!NoVerify && !VerifyEach)
 517       Passes.add(createVerifierPass());
 518
 519     // Write bitcode out to disk or outs() as the last step...
 520     if (!NoOutput && !AnalyzeOnly)
 521       Passes.add(createBitcodeWriterPass(*Out));
 522
 523     // Now that we have all of the passes ready, run them.
 524     Passes.run(*M.get());
 525
 526     // Delete the raw_fd_ostream.
 527     if (Out != &outs())
 528       delete Out;
 529     return 0;
 530
 531   } catch (const std::string& msg) {
 532     errs() << argv[0] << ": " << msg << "\n";
 533   } catch (...) {
 534     errs() << argv[0] << ": Unexpected unknown exception occurred.\n";
 535   }
 536   llvm_shutdown();
 537   return 1;
 538 }