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