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/Assembly/PrintModulePass.h"
  20 #include "llvm/Analysis/Verifier.h"
  21 #include "llvm/Target/TargetMachine.h"
  22 #include "llvm/Support/PassNameParser.h"
  23 #include "llvm/System/Signals.h"
  24 #include "llvm/Support/PluginLoader.h"
  25 #include "llvm/Support/SystemUtils.h"
  26 #include <fstream>
  27 #include <memory>
  28 #include <algorithm>
  29
  30 using namespace llvm;
  31
  32 // The OptimizationList is automatically populated with registered Passes by the
  33 // PassNameParser.
  34 //
  35 static cl::list<const PassInfo*, bool,
  36                 FilteredPassNameParser<PassInfo::Optimization> >
  37 OptimizationList(cl::desc("Optimizations available:"));
  38
  39
  40 // Other command line options...
  41 //
  42 static cl::opt<std::string>
  43 InputFilename(cl::Positional, cl::desc("<input bytecode>"), cl::init("-"));
  44
  45 static cl::opt<std::string>
  46 OutputFilename("o", cl::desc("Override output filename"),
  47                cl::value_desc("filename"), cl::init("-"));
  48
  49 static cl::opt<bool>
  50 Force("f", cl::desc("Overwrite output files"));
  51
  52 static cl::opt<bool>
  53 PrintEachXForm("p", cl::desc("Print module after each transformation"));
  54
  55 static cl::opt<bool>
  56 NoOutput("disable-output",
  57          cl::desc("Do not write result bytecode file"), cl::Hidden);
  58
  59 static cl::opt<bool>
  60 NoVerify("disable-verify", cl::desc("Do not verify result module"), cl::Hidden);
  61
  62 static cl::opt<bool>
  63 Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
  64
  65 static cl::alias
  66 QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
  67
  68
  69 //===----------------------------------------------------------------------===//
  70 // main for opt
  71 //
  72 int main(int argc, char **argv) {
  73   cl::ParseCommandLineOptions(argc, argv,
  74                               " llvm .bc -> .bc modular optimizer\n");
  75   sys::PrintStackTraceOnErrorSignal();
  76
  77   // Allocate a full target machine description only if necessary...
  78   // FIXME: The choice of target should be controllable on the command line.
  79   std::auto_ptr<TargetMachine> target;
  80
  81   TargetMachine* TM = NULL;
  82   std::string ErrorMessage;
  83
  84   // Load the input module...
  85   std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename, &ErrorMessage));
  86   if (M.get() == 0) {
  87     std::cerr << argv[0] << ": ";
  88     if (ErrorMessage.size())
  89       std::cerr << ErrorMessage << "\n";
  90     else
  91       std::cerr << "bytecode didn't read correctly.\n";
  92     return 1;
  93   }
  94
  95   // Figure out what stream we are supposed to write to...
  96   std::ostream *Out = &std::cout;  // Default to printing to stdout...
  97   if (OutputFilename != "-") {
  98     if (!Force && std::ifstream(OutputFilename.c_str())) {
  99       // If force is not specified, make sure not to overwrite a file!
 100       std::cerr << argv[0] << ": error opening '" << OutputFilename
 101                 << "': file exists!\n"
 102                 << "Use -f command line argument to force output\n";
 103       return 1;
 104     }
 105     Out = new std::ofstream(OutputFilename.c_str());
 106
 107     if (!Out->good()) {
 108       std::cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
 109       return 1;
 110     }
 111
 112     // Make sure that the Output file gets unlinked from the disk if we get a
 113     // SIGINT
 114     sys::RemoveFileOnSignal(OutputFilename);
 115   }
 116
 117   // If the output is set to be emitted to standard out, and standard out is a
 118   // console, print out a warning message and refuse to do it.  We don't impress
 119   // anyone by spewing tons of binary goo to a terminal.
 120   if (Out == &std::cout && isStandardOutAConsole() && !Force && !NoOutput
 121       && !Quiet) {
 122     std::cerr << "WARNING: It looks like you're attempting to print out a "
 123               << "bytecode file.  I'm\ngoing to pretend you didn't ask me to do"
 124               << " this (for your own good).  If you\nREALLY want to taste LLVM"
 125               << " bytecode first hand, you can force output with the\n'-f'"
 126               << " option.\n\n";
 127     NoOutput = true;
 128   }
 129
 130   // Create a PassManager to hold and optimize the collection of passes we are
 131   // about to build...
 132   //
 133   PassManager Passes;
 134
 135   // Add an appropriate TargetData instance for this module...
 136   Passes.add(new TargetData("opt", M.get()));
 137
 138   // Create a new optimization pass for each one specified on the command line
 139   for (unsigned i = 0; i < OptimizationList.size(); ++i) {
 140     const PassInfo *Opt = OptimizationList[i];
 141
 142     if (Opt->getNormalCtor())
 143       Passes.add(Opt->getNormalCtor()());
 144     else if (Opt->getTargetCtor()) {
 145 #if 0
 146       if (target.get() == NULL)
 147         target.reset(allocateSparcTargetMachine()); // FIXME: target option
 148 #endif
 149       assert(target.get() && "Could not allocate target machine!");
 150       Passes.add(Opt->getTargetCtor()(*target.get()));
 151     } else
 152       std::cerr << argv[0] << ": cannot create pass: " << Opt->getPassName()
 153                 << "\n";
 154
 155     if (PrintEachXForm)
 156       Passes.add(new PrintModulePass(&std::cerr));
 157   }
 158
 159   // Check that the module is well formed on completion of optimization
 160   if (!NoVerify)
 161     Passes.add(createVerifierPass());
 162
 163   // Write bytecode out to disk or cout as the last step...
 164   if (!NoOutput)
 165     Passes.add(new WriteBytecodePass(Out, Out != &std::cout));
 166
 167   // Now that we have all of the passes ready, run them.
 168   Passes.run(*M.get());
 169
 170   return 0;
 171 }