1 //===- opt.cpp - The LLVM Modular Optimizer -------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Optimizations may be specified an arbitrary number of times on the command
11 // line, They are run in the order specified.
13 //===----------------------------------------------------------------------===//
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"
44 // The OptimizationList is automatically populated with registered Passes by the
47 static cl::list<const PassInfo*, bool, PassNameParser>
48 PassList(cl::desc("Optimizations available:"));
50 // Other command line options...
52 static cl::opt<std::string>
53 InputFilename(cl::Positional, cl::desc("<input bitcode file>"),
54 cl::init("-"), cl::value_desc("filename"));
56 static cl::opt<std::string>
57 OutputFilename("o", cl::desc("Override output filename"),
58 cl::value_desc("filename"), cl::init("-"));
61 Force("f", cl::desc("Overwrite output files"));
64 PrintEachXForm("p", cl::desc("Print module after each transformation"));
67 NoOutput("disable-output",
68 cl::desc("Do not write result bitcode file"), cl::Hidden);
71 NoVerify("disable-verify", cl::desc("Do not verify result module"), cl::Hidden);
74 VerifyEach("verify-each", cl::desc("Verify after each transform"));
77 StripDebug("strip-debug",
78 cl::desc("Strip debugger symbol info from translation unit"));
81 DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
84 DisableOptimizations("disable-opt",
85 cl::desc("Do not run any optimization passes"));
88 StandardCompileOpts("std-compile-opts",
89 cl::desc("Include the standard compile time optimizations"));
93 cl::desc("Optimization level 1. Similar to llvm-gcc -O1"));
97 cl::desc("Optimization level 2. Similar to llvm-gcc -O2"));
101 cl::desc("Optimization level 3. Similar to llvm-gcc -O3"));
104 UnitAtATime("funit-at-a-time",
105 cl::desc("Enable IPO. This is same as llvm-gcc's -funit-at-a-time"));
108 DisableSimplifyLibCalls("disable-simplify-libcalls",
109 cl::desc("Disable simplify-libcalls"));
112 Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
115 QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
118 AnalyzeOnly("analyze", cl::desc("Only perform analysis, no optimization"));
120 // ---------- Define Printers for module and function passes ------------
123 struct CallGraphSCCPassPrinter : public CallGraphSCCPass {
125 const PassInfo *PassToPrint;
126 CallGraphSCCPassPrinter(const PassInfo *PI) :
127 CallGraphSCCPass(&ID), PassToPrint(PI) {}
129 virtual bool runOnSCC(const std::vector<CallGraphNode *>&SCC) {
131 cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
133 for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
134 Function *F = SCC[i]->getFunction();
136 getAnalysisID<Pass>(PassToPrint).print(cout, F->getParent());
139 // Get and print pass...
143 virtual const char *getPassName() const { return "'Pass' Printer"; }
145 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
146 AU.addRequiredID(PassToPrint);
147 AU.setPreservesAll();
151 char CallGraphSCCPassPrinter::ID = 0;
153 struct ModulePassPrinter : public ModulePass {
155 const PassInfo *PassToPrint;
156 ModulePassPrinter(const PassInfo *PI) : ModulePass(&ID),
159 virtual bool runOnModule(Module &M) {
161 cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
162 getAnalysisID<Pass>(PassToPrint).print(cout, &M);
165 // Get and print pass...
169 virtual const char *getPassName() const { return "'Pass' Printer"; }
171 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
172 AU.addRequiredID(PassToPrint);
173 AU.setPreservesAll();
177 char ModulePassPrinter::ID = 0;
178 struct FunctionPassPrinter : public FunctionPass {
179 const PassInfo *PassToPrint;
181 FunctionPassPrinter(const PassInfo *PI) : FunctionPass(&ID),
184 virtual bool runOnFunction(Function &F) {
186 cout << "Printing analysis '" << PassToPrint->getPassName()
187 << "' for function '" << F.getName() << "':\n";
189 // Get and print pass...
190 getAnalysisID<Pass>(PassToPrint).print(cout, F.getParent());
194 virtual const char *getPassName() const { return "FunctionPass Printer"; }
196 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
197 AU.addRequiredID(PassToPrint);
198 AU.setPreservesAll();
202 char FunctionPassPrinter::ID = 0;
204 struct LoopPassPrinter : public LoopPass {
206 const PassInfo *PassToPrint;
207 LoopPassPrinter(const PassInfo *PI) :
208 LoopPass(&ID), PassToPrint(PI) {}
210 virtual bool runOnLoop(Loop *L, LPPassManager &LPM) {
212 cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
213 getAnalysisID<Pass>(PassToPrint).print(cout,
214 L->getHeader()->getParent()->getParent());
216 // Get and print pass...
220 virtual const char *getPassName() const { return "'Pass' Printer"; }
222 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
223 AU.addRequiredID(PassToPrint);
224 AU.setPreservesAll();
228 char LoopPassPrinter::ID = 0;
230 struct BasicBlockPassPrinter : public BasicBlockPass {
231 const PassInfo *PassToPrint;
233 BasicBlockPassPrinter(const PassInfo *PI)
234 : BasicBlockPass(&ID), PassToPrint(PI) {}
236 virtual bool runOnBasicBlock(BasicBlock &BB) {
238 cout << "Printing Analysis info for BasicBlock '" << BB.getName()
239 << "': Pass " << PassToPrint->getPassName() << ":\n";
242 // Get and print pass...
243 getAnalysisID<Pass>(PassToPrint).print(cout, BB.getParent()->getParent());
247 virtual const char *getPassName() const { return "BasicBlockPass Printer"; }
249 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
250 AU.addRequiredID(PassToPrint);
251 AU.setPreservesAll();
255 char BasicBlockPassPrinter::ID = 0;
256 inline void addPass(PassManager &PM, Pass *P) {
257 // Add the pass to the pass manager...
260 // If we are verifying all of the intermediate steps, add the verifier...
261 if (VerifyEach) PM.add(createVerifierPass());
264 /// AddOptimizationPasses - This routine adds optimization passes
265 /// based on selected optimization level, OptLevel. This routine
266 /// duplicates llvm-gcc behaviour.
268 /// OptLevel - Optimization Level
269 void AddOptimizationPasses(PassManager &MPM, FunctionPassManager &FPM,
271 createStandardFunctionPasses(&FPM, OptLevel);
273 llvm::Pass *InliningPass = OptLevel > 1 ? createFunctionInliningPass() : 0;
274 createStandardModulePasses(&MPM, OptLevel,
275 /*OptimizeSize=*/ false,
277 /*UnrollLoops=*/ OptLevel > 1,
278 !DisableSimplifyLibCalls,
279 /*HaveExceptions=*/ true,
283 void AddStandardCompilePasses(PassManager &PM) {
284 PM.add(createVerifierPass()); // Verify that input is correct
286 addPass(PM, createLowerSetJmpPass()); // Lower llvm.setjmp/.longjmp
288 // If the -strip-debug command line option was specified, do it.
290 addPass(PM, createStripSymbolsPass(true));
292 if (DisableOptimizations) return;
294 llvm::Pass *InliningPass = !DisableInline ? createFunctionInliningPass() : 0;
296 // -std-compile-opts adds the same module passes as -O3.
297 createStandardModulePasses(&PM, 3,
298 /*OptimizeSize=*/ false,
299 /*UnitAtATime=*/ true,
300 /*UnrollLoops=*/ true,
301 /*SimplifyLibCalls=*/ true,
302 /*HaveExceptions=*/ true,
306 } // anonymous namespace
309 //===----------------------------------------------------------------------===//
312 int main(int argc, char **argv) {
313 llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
316 cl::ParseCommandLineOptions(argc, argv,
317 "llvm .bc -> .bc modular optimizer and analysis printer\n");
318 sys::PrintStackTraceOnErrorSignal();
320 // Allocate a full target machine description only if necessary.
321 // FIXME: The choice of target should be controllable on the command line.
322 std::auto_ptr<TargetMachine> target;
324 std::string ErrorMessage;
326 // Load the input module...
327 std::auto_ptr<Module> M;
328 if (MemoryBuffer *Buffer
329 = MemoryBuffer::getFileOrSTDIN(InputFilename, &ErrorMessage)) {
330 M.reset(ParseBitcodeFile(Buffer, Context, &ErrorMessage));
335 cerr << argv[0] << ": ";
336 if (ErrorMessage.size())
337 cerr << ErrorMessage << "\n";
339 cerr << "bitcode didn't read correctly.\n";
343 // Figure out what stream we are supposed to write to...
344 // FIXME: cout is not binary!
345 std::ostream *Out = &std::cout; // Default to printing to stdout...
346 if (OutputFilename != "-") {
347 if (!Force && std::ifstream(OutputFilename.c_str())) {
348 // If force is not specified, make sure not to overwrite a file!
349 cerr << argv[0] << ": error opening '" << OutputFilename
350 << "': file exists!\n"
351 << "Use -f command line argument to force output\n";
354 std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
356 Out = new std::ofstream(OutputFilename.c_str(), io_mode);
359 cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
363 // Make sure that the Output file gets unlinked from the disk if we get a
365 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
368 // If the output is set to be emitted to standard out, and standard out is a
369 // console, print out a warning message and refuse to do it. We don't
370 // impress anyone by spewing tons of binary goo to a terminal.
371 if (!Force && !NoOutput && CheckBitcodeOutputToConsole(Out,!Quiet)) {
375 // Create a PassManager to hold and optimize the collection of passes we are
380 // Add an appropriate TargetData instance for this module...
381 Passes.add(new TargetData(M.get()));
383 FunctionPassManager *FPasses = NULL;
384 if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
385 FPasses = new FunctionPassManager(new ExistingModuleProvider(M.get()));
386 FPasses->add(new TargetData(M.get()));
389 // If the -strip-debug command line option was specified, add it. If
390 // -std-compile-opts was also specified, it will handle StripDebug.
391 if (StripDebug && !StandardCompileOpts)
392 addPass(Passes, createStripSymbolsPass(true));
394 // Create a new optimization pass for each one specified on the command line
395 for (unsigned i = 0; i < PassList.size(); ++i) {
396 // Check to see if -std-compile-opts was specified before this option. If
398 if (StandardCompileOpts &&
399 StandardCompileOpts.getPosition() < PassList.getPosition(i)) {
400 AddStandardCompilePasses(Passes);
401 StandardCompileOpts = false;
404 if (OptLevelO1 && OptLevelO1.getPosition() < PassList.getPosition(i)) {
405 AddOptimizationPasses(Passes, *FPasses, 1);
409 if (OptLevelO2 && OptLevelO2.getPosition() < PassList.getPosition(i)) {
410 AddOptimizationPasses(Passes, *FPasses, 2);
414 if (OptLevelO3 && OptLevelO3.getPosition() < PassList.getPosition(i)) {
415 AddOptimizationPasses(Passes, *FPasses, 3);
419 const PassInfo *PassInf = PassList[i];
421 if (PassInf->getNormalCtor())
422 P = PassInf->getNormalCtor()();
424 cerr << argv[0] << ": cannot create pass: "
425 << PassInf->getPassName() << "\n";
427 bool isBBPass = dynamic_cast<BasicBlockPass*>(P) != 0;
428 bool isLPass = !isBBPass && dynamic_cast<LoopPass*>(P) != 0;
429 bool isFPass = !isLPass && dynamic_cast<FunctionPass*>(P) != 0;
430 bool isCGSCCPass = !isFPass && dynamic_cast<CallGraphSCCPass*>(P) != 0;
436 Passes.add(new BasicBlockPassPrinter(PassInf));
438 Passes.add(new LoopPassPrinter(PassInf));
440 Passes.add(new FunctionPassPrinter(PassInf));
441 else if (isCGSCCPass)
442 Passes.add(new CallGraphSCCPassPrinter(PassInf));
444 Passes.add(new ModulePassPrinter(PassInf));
449 Passes.add(createPrintModulePass(&errs()));
452 // If -std-compile-opts was specified at the end of the pass list, add them.
453 if (StandardCompileOpts) {
454 AddStandardCompilePasses(Passes);
455 StandardCompileOpts = false;
459 AddOptimizationPasses(Passes, *FPasses, 1);
463 AddOptimizationPasses(Passes, *FPasses, 2);
467 AddOptimizationPasses(Passes, *FPasses, 3);
470 if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
471 for (Module::iterator I = M.get()->begin(), E = M.get()->end();
476 // Check that the module is well formed on completion of optimization
477 if (!NoVerify && !VerifyEach)
478 Passes.add(createVerifierPass());
480 // Write bitcode out to disk or cout as the last step...
481 if (!NoOutput && !AnalyzeOnly)
482 Passes.add(CreateBitcodeWriterPass(*Out));
484 // Now that we have all of the passes ready, run them.
485 Passes.run(*M.get());
487 // Delete the ofstream.
488 if (Out != &std::cout)
492 } catch (const std::string& msg) {
493 cerr << argv[0] << ": " << msg << "\n";
495 cerr << argv[0] << ": Unexpected unknown exception occurred.\n";