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/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 bitcode 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 bitcode 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
 180 struct LoopPassPrinter : public LoopPass {
 181   static char ID;
 182   const PassInfo *PassToPrint;
 183   LoopPassPrinter(const PassInfo *PI) :
 184     LoopPass((intptr_t)&ID), PassToPrint(PI) {}
 185
 186   virtual bool runOnLoop(Loop *L, LPPassManager &LPM) {
 187     if (!Quiet) {
 188       cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
 189       getAnalysisID<Pass>(PassToPrint).print(cout,
 190                                   L->getHeader()->getParent()->getParent());
 191     }
 192     // Get and print pass...
 193     return false;
 194   }
 195
 196   virtual const char *getPassName() const { return "'Pass' Printer"; }
 197
 198   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 199     AU.addRequiredID(PassToPrint);
 200     AU.setPreservesAll();
 201   }
 202 };
 203
 204 char LoopPassPrinter::ID = 0;
 205
 206 struct BasicBlockPassPrinter : public BasicBlockPass {
 207   const PassInfo *PassToPrint;
 208   static char ID;
 209   BasicBlockPassPrinter(const PassInfo *PI)
 210     : BasicBlockPass((intptr_t)&ID), PassToPrint(PI) {}
 211
 212   virtual bool runOnBasicBlock(BasicBlock &BB) {
 213     if (!Quiet) {
 214       cout << "Printing Analysis info for BasicBlock '" << BB.getName()
 215            << "': Pass " << PassToPrint->getPassName() << ":\n";
 216     }
 217
 218     // Get and print pass...
 219     getAnalysisID<Pass>(PassToPrint).print(cout, BB.getParent()->getParent());
 220     return false;
 221   }
 222
 223   virtual const char *getPassName() const { return "BasicBlockPass Printer"; }
 224
 225   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 226     AU.addRequiredID(PassToPrint);
 227     AU.setPreservesAll();
 228   }
 229 };
 230
 231 char BasicBlockPassPrinter::ID = 0;
 232 inline void addPass(PassManager &PM, Pass *P) {
 233   // Add the pass to the pass manager...
 234   PM.add(P);
 235
 236   // If we are verifying all of the intermediate steps, add the verifier...
 237   if (VerifyEach) PM.add(createVerifierPass());
 238 }
 239
 240 void AddStandardCompilePasses(PassManager &PM) {
 241   PM.add(createVerifierPass());                  // Verify that input is correct
 242
 243   addPass(PM, createLowerSetJmpPass());          // Lower llvm.setjmp/.longjmp
 244
 245   // If the -strip-debug command line option was specified, do it.
 246   if (StripDebug)
 247     addPass(PM, createStripSymbolsPass(true));
 248
 249   if (DisableOptimizations) return;
 250
 251   addPass(PM, createRaiseAllocationsPass());     // call %malloc -> malloc inst
 252   addPass(PM, createCFGSimplificationPass());    // Clean up disgusting code
 253   addPass(PM, createPromoteMemoryToRegisterPass());// Kill useless allocas
 254   addPass(PM, createGlobalOptimizerPass());      // Optimize out global vars
 255   addPass(PM, createGlobalDCEPass());            // Remove unused fns and globs
 256   addPass(PM, createIPConstantPropagationPass());// IP Constant Propagation
 257   addPass(PM, createDeadArgEliminationPass());   // Dead argument elimination
 258   addPass(PM, createInstructionCombiningPass()); // Clean up after IPCP & DAE
 259   addPass(PM, createCFGSimplificationPass());    // Clean up after IPCP & DAE
 260
 261   addPass(PM, createPruneEHPass());              // Remove dead EH info
 262
 263   if (!DisableInline)
 264     addPass(PM, createFunctionInliningPass());   // Inline small functions
 265   addPass(PM, createSimplifyLibCallsPass());     // Library Call Optimizations
 266   addPass(PM, createArgumentPromotionPass());    // Scalarize uninlined fn args
 267
 268   addPass(PM, createTailDuplicationPass());      // Simplify cfg by copying code
 269   addPass(PM, createInstructionCombiningPass()); // Cleanup for scalarrepl.
 270   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 271   addPass(PM, createScalarReplAggregatesPass()); // Break up aggregate allocas
 272   addPass(PM, createInstructionCombiningPass()); // Combine silly seq's
 273   addPass(PM, createCondPropagationPass());      // Propagate conditionals
 274
 275   addPass(PM, createTailCallEliminationPass());  // Eliminate tail calls
 276   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 277   addPass(PM, createReassociatePass());          // Reassociate expressions
 278   addPass(PM, createLoopRotatePass());
 279   addPass(PM, createLICMPass());                 // Hoist loop invariants
 280   addPass(PM, createLoopUnswitchPass());         // Unswitch loops.
 281   addPass(PM, createLoopIndexSplitPass());       // Index split loops.
 282   addPass(PM, createInstructionCombiningPass()); // Clean up after LICM/reassoc
 283   addPass(PM, createIndVarSimplifyPass());       // Canonicalize indvars
 284   addPass(PM, createLoopUnrollPass());           // Unroll small loops
 285   addPass(PM, createInstructionCombiningPass()); // Clean up after the unroller
 286   addPass(PM, createGVNPass());                  // Remove redundancies
 287   addPass(PM, createMemCpyOptPass());            // Remove memcpy / form memset
 288   addPass(PM, createSCCPPass());                 // Constant prop with SCCP
 289
 290   // Run instcombine after redundancy elimination to exploit opportunities
 291   // opened up by them.
 292   addPass(PM, createInstructionCombiningPass());
 293   addPass(PM, createCondPropagationPass());      // Propagate conditionals
 294
 295   addPass(PM, createDeadStoreEliminationPass()); // Delete dead stores
 296   addPass(PM, createAggressiveDCEPass());        // SSA based 'Aggressive DCE'
 297   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 298   addPass(PM, createStripDeadPrototypesPass());  // Get rid of dead prototypes
 299   addPass(PM, createDeadTypeEliminationPass());  // Eliminate dead types
 300   addPass(PM, createConstantMergePass());        // Merge dup global constants
 301 }
 302
 303 } // anonymous namespace
 304
 305
 306 //===----------------------------------------------------------------------===//
 307 // main for opt
 308 //
 309 int main(int argc, char **argv) {
 310   llvm_shutdown_obj X;  // Call llvm_shutdown() on exit.
 311   try {
 312     cl::ParseCommandLineOptions(argc, argv,
 313       "llvm .bc -> .bc modular optimizer and analysis printer\n");
 314     sys::PrintStackTraceOnErrorSignal();
 315
 316     // Allocate a full target machine description only if necessary.
 317     // FIXME: The choice of target should be controllable on the command line.
 318     std::auto_ptr<TargetMachine> target;
 319
 320     std::string ErrorMessage;
 321
 322     // Load the input module...
 323     std::auto_ptr<Module> M;
 324     if (MemoryBuffer *Buffer
 325           = MemoryBuffer::getFileOrSTDIN(InputFilename, &ErrorMessage)) {
 326       M.reset(ParseBitcodeFile(Buffer, &ErrorMessage));
 327       delete Buffer;
 328     }
 329
 330     if (M.get() == 0) {
 331       cerr << argv[0] << ": ";
 332       if (ErrorMessage.size())
 333         cerr << ErrorMessage << "\n";
 334       else
 335         cerr << "bitcode didn't read correctly.\n";
 336       return 1;
 337     }
 338
 339     // Figure out what stream we are supposed to write to...
 340     // FIXME: cout is not binary!
 341     std::ostream *Out = &std::cout;  // Default to printing to stdout...
 342     if (OutputFilename != "-") {
 343       if (!Force && std::ifstream(OutputFilename.c_str())) {
 344         // If force is not specified, make sure not to overwrite a file!
 345         cerr << argv[0] << ": error opening '" << OutputFilename
 346              << "': file exists!\n"
 347              << "Use -f command line argument to force output\n";
 348         return 1;
 349       }
 350       std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
 351                                    std::ios::binary;
 352       Out = new std::ofstream(OutputFilename.c_str(), io_mode);
 353
 354       if (!Out->good()) {
 355         cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
 356         return 1;
 357       }
 358
 359       // Make sure that the Output file gets unlinked from the disk if we get a
 360       // SIGINT
 361       sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 362     }
 363
 364     // If the output is set to be emitted to standard out, and standard out is a
 365     // console, print out a warning message and refuse to do it.  We don't
 366     // impress anyone by spewing tons of binary goo to a terminal.
 367     if (!Force && !NoOutput && CheckBitcodeOutputToConsole(Out,!Quiet)) {
 368       NoOutput = true;
 369     }
 370
 371     // Create a PassManager to hold and optimize the collection of passes we are
 372     // about to build...
 373     //
 374     PassManager Passes;
 375
 376     // Add an appropriate TargetData instance for this module...
 377     Passes.add(new TargetData(M.get()));
 378
 379     // If -std-compile-opts is given, add in all the standard compilation
 380     // optimizations first. This will handle -strip-debug, -disable-inline,
 381     // and -disable-opt as well.
 382     if (StandardCompileOpts)
 383       AddStandardCompilePasses(Passes);
 384
 385     // otherwise if the -strip-debug command line option was specified, add it.
 386     else if (StripDebug)
 387       addPass(Passes, createStripSymbolsPass(true));
 388
 389     // Create a new optimization pass for each one specified on the command line
 390     for (unsigned i = 0; i < PassList.size(); ++i) {
 391       const PassInfo *PassInf = PassList[i];
 392       Pass *P = 0;
 393       if (PassInf->getNormalCtor())
 394         P = PassInf->getNormalCtor()();
 395       else
 396         cerr << argv[0] << ": cannot create pass: "
 397              << PassInf->getPassName() << "\n";
 398       if (P) {
 399         addPass(Passes, P);
 400
 401         if (AnalyzeOnly) {
 402           if (dynamic_cast<BasicBlockPass*>(P))
 403             Passes.add(new BasicBlockPassPrinter(PassInf));
 404           else if (dynamic_cast<LoopPass*>(P))
 405             Passes.add(new  LoopPassPrinter(PassInf));
 406           else if (dynamic_cast<FunctionPass*>(P))
 407             Passes.add(new FunctionPassPrinter(PassInf));
 408           else if (dynamic_cast<CallGraphSCCPass*>(P))
 409             Passes.add(new CallGraphSCCPassPrinter(PassInf));
 410           else
 411             Passes.add(new ModulePassPrinter(PassInf));
 412         }
 413       }
 414
 415       if (PrintEachXForm)
 416         Passes.add(new PrintModulePass(&cerr));
 417     }
 418
 419     // Check that the module is well formed on completion of optimization
 420     if (!NoVerify && !VerifyEach)
 421       Passes.add(createVerifierPass());
 422
 423     // Write bitcode out to disk or cout as the last step...
 424     if (!NoOutput && !AnalyzeOnly)
 425       Passes.add(CreateBitcodeWriterPass(*Out));
 426
 427     // Now that we have all of the passes ready, run them.
 428     Passes.run(*M.get());
 429
 430     // Delete the ofstream.
 431     if (Out != &std::cout)
 432       delete Out;
 433     return 0;
 434
 435   } catch (const std::string& msg) {
 436     cerr << argv[0] << ": " << msg << "\n";
 437   } catch (...) {
 438     cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
 439   }
 440   llvm_shutdown();
 441   return 1;
 442 }