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/PassManager.h"
18 #include "llvm/CallGraphSCCPass.h"
19 #include "llvm/Bitcode/ReaderWriter.h"
20 #include "llvm/Assembly/PrintModulePass.h"
21 #include "llvm/Analysis/DebugInfo.h"
22 #include "llvm/Analysis/Verifier.h"
23 #include "llvm/Analysis/LoopPass.h"
24 #include "llvm/Analysis/RegionPass.h"
25 #include "llvm/Analysis/CallGraph.h"
26 #include "llvm/Target/TargetData.h"
27 #include "llvm/Target/TargetMachine.h"
28 #include "llvm/Support/PassNameParser.h"
29 #include "llvm/Support/Signals.h"
30 #include "llvm/Support/Debug.h"
31 #include "llvm/Support/IRReader.h"
32 #include "llvm/Support/ManagedStatic.h"
33 #include "llvm/Support/PluginLoader.h"
34 #include "llvm/Support/PrettyStackTrace.h"
35 #include "llvm/Support/StandardPasses.h"
36 #include "llvm/Support/SystemUtils.h"
37 #include "llvm/Support/ToolOutputFile.h"
38 #include "llvm/LinkAllPasses.h"
39 #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"));
61 Force("f", cl::desc("Enable binary output on terminals"));
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 OutputAssembly("S", cl::desc("Write output as LLVM assembly"));
74 NoVerify("disable-verify", cl::desc("Do not verify result module"), cl::Hidden);
77 VerifyEach("verify-each", cl::desc("Verify after each transform"));
80 StripDebug("strip-debug",
81 cl::desc("Strip debugger symbol info from translation unit"));
84 DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
87 DisableOptimizations("disable-opt",
88 cl::desc("Do not run any optimization passes"));
91 DisableInternalize("disable-internalize",
92 cl::desc("Do not mark all symbols as internal"));
95 StandardCompileOpts("std-compile-opts",
96 cl::desc("Include the standard compile time optimizations"));
99 StandardLinkOpts("std-link-opts",
100 cl::desc("Include the standard link time optimizations"));
104 cl::desc("Optimization level 1. Similar to llvm-gcc -O1"));
108 cl::desc("Optimization level 2. Similar to llvm-gcc -O2"));
112 cl::desc("Optimization level 3. Similar to llvm-gcc -O3"));
115 UnitAtATime("funit-at-a-time",
116 cl::desc("Enable IPO. This is same as llvm-gcc's -funit-at-a-time"),
120 DisableSimplifyLibCalls("disable-simplify-libcalls",
121 cl::desc("Disable simplify-libcalls"));
124 Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
127 QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
130 AnalyzeOnly("analyze", cl::desc("Only perform analysis, no optimization"));
133 PrintBreakpoints("print-breakpoints-for-testing",
134 cl::desc("Print select breakpoints location for testing"));
136 static cl::opt<std::string>
137 DefaultDataLayout("default-data-layout",
138 cl::desc("data layout string to use if not specified by module"),
139 cl::value_desc("layout-string"), cl::init(""));
141 // ---------- Define Printers for module and function passes ------------
144 struct CallGraphSCCPassPrinter : public CallGraphSCCPass {
146 const PassInfo *PassToPrint;
148 std::string PassName;
150 CallGraphSCCPassPrinter(const PassInfo *PI, raw_ostream &out) :
151 CallGraphSCCPass(ID), PassToPrint(PI), Out(out) {
152 std::string PassToPrintName = PassToPrint->getPassName();
153 PassName = "CallGraphSCCPass Printer: " + PassToPrintName;
156 virtual bool runOnSCC(CallGraphSCC &SCC) {
158 Out << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
160 // Get and print pass...
161 for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I) {
162 Function *F = (*I)->getFunction();
164 getAnalysisID<Pass>(PassToPrint->getTypeInfo()).print(Out,
170 virtual const char *getPassName() const { return PassName.c_str(); }
172 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
173 AU.addRequiredID(PassToPrint->getTypeInfo());
174 AU.setPreservesAll();
178 char CallGraphSCCPassPrinter::ID = 0;
180 struct ModulePassPrinter : public ModulePass {
182 const PassInfo *PassToPrint;
184 std::string PassName;
186 ModulePassPrinter(const PassInfo *PI, raw_ostream &out)
187 : ModulePass(ID), PassToPrint(PI), Out(out) {
188 std::string PassToPrintName = PassToPrint->getPassName();
189 PassName = "ModulePass Printer: " + PassToPrintName;
192 virtual bool runOnModule(Module &M) {
194 Out << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
196 // Get and print pass...
197 getAnalysisID<Pass>(PassToPrint->getTypeInfo()).print(Out, &M);
201 virtual const char *getPassName() const { return PassName.c_str(); }
203 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
204 AU.addRequiredID(PassToPrint->getTypeInfo());
205 AU.setPreservesAll();
209 char ModulePassPrinter::ID = 0;
210 struct FunctionPassPrinter : public FunctionPass {
211 const PassInfo *PassToPrint;
214 std::string PassName;
216 FunctionPassPrinter(const PassInfo *PI, raw_ostream &out)
217 : FunctionPass(ID), PassToPrint(PI), Out(out) {
218 std::string PassToPrintName = PassToPrint->getPassName();
219 PassName = "FunctionPass Printer: " + PassToPrintName;
222 virtual bool runOnFunction(Function &F) {
224 Out << "Printing analysis '" << PassToPrint->getPassName()
225 << "' for function '" << F.getName() << "':\n";
227 // Get and print pass...
228 getAnalysisID<Pass>(PassToPrint->getTypeInfo()).print(Out,
233 virtual const char *getPassName() const { return PassName.c_str(); }
235 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
236 AU.addRequiredID(PassToPrint->getTypeInfo());
237 AU.setPreservesAll();
241 char FunctionPassPrinter::ID = 0;
243 struct LoopPassPrinter : public LoopPass {
245 const PassInfo *PassToPrint;
247 std::string PassName;
249 LoopPassPrinter(const PassInfo *PI, raw_ostream &out) :
250 LoopPass(ID), PassToPrint(PI), Out(out) {
251 std::string PassToPrintName = PassToPrint->getPassName();
252 PassName = "LoopPass Printer: " + PassToPrintName;
256 virtual bool runOnLoop(Loop *L, LPPassManager &LPM) {
258 Out << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
260 // Get and print pass...
261 getAnalysisID<Pass>(PassToPrint->getTypeInfo()).print(Out,
262 L->getHeader()->getParent()->getParent());
266 virtual const char *getPassName() const { return PassName.c_str(); }
268 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
269 AU.addRequiredID(PassToPrint->getTypeInfo());
270 AU.setPreservesAll();
274 char LoopPassPrinter::ID = 0;
276 struct RegionPassPrinter : public RegionPass {
278 const PassInfo *PassToPrint;
280 std::string PassName;
282 RegionPassPrinter(const PassInfo *PI, raw_ostream &out) : RegionPass(ID),
283 PassToPrint(PI), Out(out) {
284 std::string PassToPrintName = PassToPrint->getPassName();
285 PassName = "LoopPass Printer: " + PassToPrintName;
288 virtual bool runOnRegion(Region *R, RGPassManager &RGM) {
290 Out << "Printing analysis '" << PassToPrint->getPassName() << "' for "
291 << "region: '" << R->getNameStr() << "' in function '"
292 << R->getEntry()->getParent()->getNameStr() << "':\n";
294 // Get and print pass...
295 getAnalysisID<Pass>(PassToPrint->getTypeInfo()).print(Out,
296 R->getEntry()->getParent()->getParent());
300 virtual const char *getPassName() const { return "'Pass' Printer"; }
302 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
303 AU.addRequiredID(PassToPrint->getTypeInfo());
304 AU.setPreservesAll();
308 char RegionPassPrinter::ID = 0;
310 struct BasicBlockPassPrinter : public BasicBlockPass {
311 const PassInfo *PassToPrint;
314 std::string PassName;
316 BasicBlockPassPrinter(const PassInfo *PI, raw_ostream &out)
317 : BasicBlockPass(ID), PassToPrint(PI), Out(out) {
318 std::string PassToPrintName = PassToPrint->getPassName();
319 PassName = "BasicBlockPass Printer: " + PassToPrintName;
322 virtual bool runOnBasicBlock(BasicBlock &BB) {
324 Out << "Printing Analysis info for BasicBlock '" << BB.getName()
325 << "': Pass " << PassToPrint->getPassName() << ":\n";
327 // Get and print pass...
328 getAnalysisID<Pass>(PassToPrint->getTypeInfo()).print(Out,
329 BB.getParent()->getParent());
333 virtual const char *getPassName() const { return PassName.c_str(); }
335 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
336 AU.addRequiredID(PassToPrint->getTypeInfo());
337 AU.setPreservesAll();
341 char BasicBlockPassPrinter::ID = 0;
343 struct BreakpointPrinter : public FunctionPass {
347 BreakpointPrinter(raw_ostream &out)
348 : FunctionPass(ID), Out(out) {
351 virtual bool runOnFunction(Function &F) {
352 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
353 BasicBlock::const_iterator BI = I->end();
356 const Instruction *In = BI;
357 const DebugLoc DL = In->getDebugLoc();
358 if (!DL.isUnknown()) {
359 DIScope S(DL.getScope(getGlobalContext()));
360 Out << S.getFilename() << " " << DL.getLine() << "\n";
364 } while (BI != I->begin());
370 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
371 AU.setPreservesAll();
375 char BreakpointPrinter::ID = 0;
377 inline void addPass(PassManagerBase &PM, Pass *P) {
378 // Add the pass to the pass manager...
381 // If we are verifying all of the intermediate steps, add the verifier...
382 if (VerifyEach) PM.add(createVerifierPass());
385 /// AddOptimizationPasses - This routine adds optimization passes
386 /// based on selected optimization level, OptLevel. This routine
387 /// duplicates llvm-gcc behaviour.
389 /// OptLevel - Optimization Level
390 void AddOptimizationPasses(PassManagerBase &MPM, PassManagerBase &FPM,
392 createStandardFunctionPasses(&FPM, OptLevel);
394 llvm::Pass *InliningPass = 0;
397 } else if (OptLevel) {
398 unsigned Threshold = 225;
401 InliningPass = createFunctionInliningPass(Threshold);
403 InliningPass = createAlwaysInlinerPass();
405 createStandardModulePasses(&MPM, OptLevel,
406 /*OptimizeSize=*/ false,
408 /*UnrollLoops=*/ OptLevel > 1,
409 !DisableSimplifyLibCalls,
410 /*HaveExceptions=*/ true,
414 void AddStandardCompilePasses(PassManagerBase &PM) {
415 PM.add(createVerifierPass()); // Verify that input is correct
417 addPass(PM, createLowerSetJmpPass()); // Lower llvm.setjmp/.longjmp
419 // If the -strip-debug command line option was specified, do it.
421 addPass(PM, createStripSymbolsPass(true));
423 if (DisableOptimizations) return;
425 llvm::Pass *InliningPass = !DisableInline ? createFunctionInliningPass() : 0;
427 // -std-compile-opts adds the same module passes as -O3.
428 createStandardModulePasses(&PM, 3,
429 /*OptimizeSize=*/ false,
430 /*UnitAtATime=*/ true,
431 /*UnrollLoops=*/ true,
432 /*SimplifyLibCalls=*/ true,
433 /*HaveExceptions=*/ true,
437 void AddStandardLinkPasses(PassManagerBase &PM) {
438 PM.add(createVerifierPass()); // Verify that input is correct
440 // If the -strip-debug command line option was specified, do it.
442 addPass(PM, createStripSymbolsPass(true));
444 if (DisableOptimizations) return;
446 createStandardLTOPasses(&PM, /*Internalize=*/ !DisableInternalize,
447 /*RunInliner=*/ !DisableInline,
448 /*VerifyEach=*/ VerifyEach);
451 } // anonymous namespace
454 //===----------------------------------------------------------------------===//
457 int main(int argc, char **argv) {
458 sys::PrintStackTraceOnErrorSignal();
459 llvm::PrettyStackTraceProgram X(argc, argv);
461 // Enable debug stream buffering.
462 EnableDebugBuffering = true;
464 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
465 LLVMContext &Context = getGlobalContext();
468 PassRegistry &Registry = *PassRegistry::getPassRegistry();
469 initializeCore(Registry);
470 initializeScalarOpts(Registry);
471 initializeIPO(Registry);
472 initializeAnalysis(Registry);
473 initializeIPA(Registry);
474 initializeTransformUtils(Registry);
475 initializeInstCombine(Registry);
476 initializeInstrumentation(Registry);
477 initializeTarget(Registry);
479 cl::ParseCommandLineOptions(argc, argv,
480 "llvm .bc -> .bc modular optimizer and analysis printer\n");
482 if (AnalyzeOnly && NoOutput) {
483 errs() << argv[0] << ": analyze mode conflicts with no-output mode.\n";
487 // Allocate a full target machine description only if necessary.
488 // FIXME: The choice of target should be controllable on the command line.
489 std::auto_ptr<TargetMachine> target;
493 // Load the input module...
494 std::auto_ptr<Module> M;
495 M.reset(ParseIRFile(InputFilename, Err, Context));
498 Err.Print(argv[0], errs());
502 // Figure out what stream we are supposed to write to...
503 OwningPtr<tool_output_file> Out;
505 if (!OutputFilename.empty())
506 errs() << "WARNING: The -o (output filename) option is ignored when\n"
507 "the --disable-output option is used.\n";
509 // Default to standard output.
510 if (OutputFilename.empty())
511 OutputFilename = "-";
513 std::string ErrorInfo;
514 Out.reset(new tool_output_file(OutputFilename.c_str(), ErrorInfo,
515 raw_fd_ostream::F_Binary));
516 if (!ErrorInfo.empty()) {
517 errs() << ErrorInfo << '\n';
522 // If the output is set to be emitted to standard out, and standard out is a
523 // console, print out a warning message and refuse to do it. We don't
524 // impress anyone by spewing tons of binary goo to a terminal.
525 if (!Force && !NoOutput && !AnalyzeOnly && !OutputAssembly)
526 if (CheckBitcodeOutputToConsole(Out->os(), !Quiet))
529 // Create a PassManager to hold and optimize the collection of passes we are
534 // Add an appropriate TargetData instance for this module...
536 const std::string &ModuleDataLayout = M.get()->getDataLayout();
537 if (!ModuleDataLayout.empty())
538 TD = new TargetData(ModuleDataLayout);
539 else if (!DefaultDataLayout.empty())
540 TD = new TargetData(DefaultDataLayout);
545 OwningPtr<PassManager> FPasses;
546 if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
547 FPasses.reset(new PassManager());
549 FPasses->add(new TargetData(*TD));
552 if (PrintBreakpoints) {
553 // Default to standard output.
555 if (OutputFilename.empty())
556 OutputFilename = "-";
558 std::string ErrorInfo;
559 Out.reset(new tool_output_file(OutputFilename.c_str(), ErrorInfo,
560 raw_fd_ostream::F_Binary));
561 if (!ErrorInfo.empty()) {
562 errs() << ErrorInfo << '\n';
566 Passes.add(new BreakpointPrinter(Out->os()));
570 // If the -strip-debug command line option was specified, add it. If
571 // -std-compile-opts was also specified, it will handle StripDebug.
572 if (StripDebug && !StandardCompileOpts)
573 addPass(Passes, createStripSymbolsPass(true));
575 // Create a new optimization pass for each one specified on the command line
576 for (unsigned i = 0; i < PassList.size(); ++i) {
577 // Check to see if -std-compile-opts was specified before this option. If
579 if (StandardCompileOpts &&
580 StandardCompileOpts.getPosition() < PassList.getPosition(i)) {
581 AddStandardCompilePasses(Passes);
582 StandardCompileOpts = false;
585 if (StandardLinkOpts &&
586 StandardLinkOpts.getPosition() < PassList.getPosition(i)) {
587 AddStandardLinkPasses(Passes);
588 StandardLinkOpts = false;
591 if (OptLevelO1 && OptLevelO1.getPosition() < PassList.getPosition(i)) {
592 AddOptimizationPasses(Passes, *FPasses, 1);
596 if (OptLevelO2 && OptLevelO2.getPosition() < PassList.getPosition(i)) {
597 AddOptimizationPasses(Passes, *FPasses, 2);
601 if (OptLevelO3 && OptLevelO3.getPosition() < PassList.getPosition(i)) {
602 AddOptimizationPasses(Passes, *FPasses, 3);
606 const PassInfo *PassInf = PassList[i];
608 if (PassInf->getNormalCtor())
609 P = PassInf->getNormalCtor()();
611 errs() << argv[0] << ": cannot create pass: "
612 << PassInf->getPassName() << "\n";
614 PassKind Kind = P->getPassKind();
620 Passes.add(new BasicBlockPassPrinter(PassInf, Out->os()));
623 Passes.add(new RegionPassPrinter(PassInf, Out->os()));
626 Passes.add(new LoopPassPrinter(PassInf, Out->os()));
629 Passes.add(new FunctionPassPrinter(PassInf, Out->os()));
631 case PT_CallGraphSCC:
632 Passes.add(new CallGraphSCCPassPrinter(PassInf, Out->os()));
635 Passes.add(new ModulePassPrinter(PassInf, Out->os()));
642 Passes.add(createPrintModulePass(&errs()));
645 // If -std-compile-opts was specified at the end of the pass list, add them.
646 if (StandardCompileOpts) {
647 AddStandardCompilePasses(Passes);
648 StandardCompileOpts = false;
651 if (StandardLinkOpts) {
652 AddStandardLinkPasses(Passes);
653 StandardLinkOpts = false;
657 AddOptimizationPasses(Passes, *FPasses, 1);
660 AddOptimizationPasses(Passes, *FPasses, 2);
663 AddOptimizationPasses(Passes, *FPasses, 3);
665 if (OptLevelO1 || OptLevelO2 || OptLevelO3)
666 FPasses->run(*M.get());
668 // Check that the module is well formed on completion of optimization
669 if (!NoVerify && !VerifyEach)
670 Passes.add(createVerifierPass());
672 // Write bitcode or assembly to the output as the last step...
673 if (!NoOutput && !AnalyzeOnly) {
675 Passes.add(createPrintModulePass(&Out->os()));
677 Passes.add(createBitcodeWriterPass(Out->os()));
680 // Now that we have all of the passes ready, run them.
681 Passes.run(*M.get());
684 if (!NoOutput || PrintBreakpoints)