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