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/Verifier.h"
22 #include "llvm/Analysis/LoopPass.h"
23 #include "llvm/Analysis/CallGraph.h"
24 #include "llvm/Target/TargetData.h"
25 #include "llvm/Target/TargetMachine.h"
26 #include "llvm/Support/PassNameParser.h"
27 #include "llvm/System/Signals.h"
28 #include "llvm/Support/Debug.h"
29 #include "llvm/Support/IRReader.h"
30 #include "llvm/Support/ManagedStatic.h"
31 #include "llvm/Support/MemoryBuffer.h"
32 #include "llvm/Support/PluginLoader.h"
33 #include "llvm/Support/PrettyStackTrace.h"
34 #include "llvm/Support/StandardPasses.h"
35 #include "llvm/Support/SystemUtils.h"
36 #include "llvm/Support/raw_ostream.h"
37 #include "llvm/LinkAllPasses.h"
38 #include "llvm/LinkAllVMCore.h"
43 // The OptimizationList is automatically populated with registered Passes by the
46 static cl::list<const PassInfo*, bool, PassNameParser>
47 PassList(cl::desc("Optimizations available:"));
49 // Other command line options...
51 static cl::opt<std::string>
52 InputFilename(cl::Positional, cl::desc("<input bitcode file>"),
53 cl::init("-"), cl::value_desc("filename"));
55 static cl::opt<std::string>
56 OutputFilename("o", cl::desc("Override output filename"),
57 cl::value_desc("filename"), cl::init("-"));
60 Force("f", cl::desc("Enable binary output on terminals"));
63 PrintEachXForm("p", cl::desc("Print module after each transformation"));
66 NoOutput("disable-output",
67 cl::desc("Do not write result bitcode file"), cl::Hidden);
70 OutputAssembly("S", cl::desc("Write output as LLVM assembly"));
73 NoVerify("disable-verify", cl::desc("Do not verify result module"), cl::Hidden);
76 VerifyEach("verify-each", cl::desc("Verify after each transform"));
79 StripDebug("strip-debug",
80 cl::desc("Strip debugger symbol info from translation unit"));
83 DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
86 DisableOptimizations("disable-opt",
87 cl::desc("Do not run any optimization passes"));
90 DisableInternalize("disable-internalize",
91 cl::desc("Do not mark all symbols as internal"));
94 StandardCompileOpts("std-compile-opts",
95 cl::desc("Include the standard compile time optimizations"));
98 StandardLinkOpts("std-link-opts",
99 cl::desc("Include the standard link time optimizations"));
103 cl::desc("Optimization level 1. Similar to llvm-gcc -O1"));
107 cl::desc("Optimization level 2. Similar to llvm-gcc -O2"));
111 cl::desc("Optimization level 3. Similar to llvm-gcc -O3"));
114 UnitAtATime("funit-at-a-time",
115 cl::desc("Enable IPO. This is same as llvm-gcc's -funit-at-a-time"),
119 DisableSimplifyLibCalls("disable-simplify-libcalls",
120 cl::desc("Disable simplify-libcalls"));
123 Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
126 QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
129 AnalyzeOnly("analyze", cl::desc("Only perform analysis, no optimization"));
131 static cl::opt<std::string>
132 DefaultDataLayout("default-data-layout",
133 cl::desc("data layout string to use if not specified by module"),
134 cl::value_desc("layout-string"), cl::init(""));
136 // ---------- Define Printers for module and function passes ------------
139 struct CallGraphSCCPassPrinter : public CallGraphSCCPass {
141 const PassInfo *PassToPrint;
142 CallGraphSCCPassPrinter(const PassInfo *PI) :
143 CallGraphSCCPass(&ID), PassToPrint(PI) {}
145 virtual bool runOnSCC(std::vector<CallGraphNode *>&SCC) {
147 outs() << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
149 for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
150 Function *F = SCC[i]->getFunction();
152 getAnalysisID<Pass>(PassToPrint).print(outs(), F->getParent());
156 // Get and print pass...
160 virtual const char *getPassName() const { return "'Pass' Printer"; }
162 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
163 AU.addRequiredID(PassToPrint);
164 AU.setPreservesAll();
168 char CallGraphSCCPassPrinter::ID = 0;
170 struct ModulePassPrinter : public ModulePass {
172 const PassInfo *PassToPrint;
173 ModulePassPrinter(const PassInfo *PI) : ModulePass(&ID),
176 virtual bool runOnModule(Module &M) {
178 outs() << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
179 getAnalysisID<Pass>(PassToPrint).print(outs(), &M);
182 // Get and print pass...
186 virtual const char *getPassName() const { return "'Pass' Printer"; }
188 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
189 AU.addRequiredID(PassToPrint);
190 AU.setPreservesAll();
194 char ModulePassPrinter::ID = 0;
195 struct FunctionPassPrinter : public FunctionPass {
196 const PassInfo *PassToPrint;
198 FunctionPassPrinter(const PassInfo *PI) : FunctionPass(&ID),
201 virtual bool runOnFunction(Function &F) {
203 outs() << "Printing analysis '" << PassToPrint->getPassName()
204 << "' for function '" << F.getName() << "':\n";
206 // Get and print pass...
207 getAnalysisID<Pass>(PassToPrint).print(outs(), F.getParent());
211 virtual const char *getPassName() const { return "FunctionPass Printer"; }
213 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
214 AU.addRequiredID(PassToPrint);
215 AU.setPreservesAll();
219 char FunctionPassPrinter::ID = 0;
221 struct LoopPassPrinter : public LoopPass {
223 const PassInfo *PassToPrint;
224 LoopPassPrinter(const PassInfo *PI) :
225 LoopPass(&ID), PassToPrint(PI) {}
227 virtual bool runOnLoop(Loop *L, LPPassManager &LPM) {
229 outs() << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
230 getAnalysisID<Pass>(PassToPrint).print(outs(),
231 L->getHeader()->getParent()->getParent());
233 // Get and print pass...
237 virtual const char *getPassName() const { return "'Pass' Printer"; }
239 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
240 AU.addRequiredID(PassToPrint);
241 AU.setPreservesAll();
245 char LoopPassPrinter::ID = 0;
247 struct BasicBlockPassPrinter : public BasicBlockPass {
248 const PassInfo *PassToPrint;
250 BasicBlockPassPrinter(const PassInfo *PI)
251 : BasicBlockPass(&ID), PassToPrint(PI) {}
253 virtual bool runOnBasicBlock(BasicBlock &BB) {
255 outs() << "Printing Analysis info for BasicBlock '" << BB.getName()
256 << "': Pass " << PassToPrint->getPassName() << ":\n";
259 // Get and print pass...
260 getAnalysisID<Pass>(PassToPrint).print(outs(), BB.getParent()->getParent());
264 virtual const char *getPassName() const { return "BasicBlockPass Printer"; }
266 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
267 AU.addRequiredID(PassToPrint);
268 AU.setPreservesAll();
272 char BasicBlockPassPrinter::ID = 0;
273 inline void addPass(PassManager &PM, Pass *P) {
274 // Add the pass to the pass manager...
277 // If we are verifying all of the intermediate steps, add the verifier...
278 if (VerifyEach) PM.add(createVerifierPass());
281 /// AddOptimizationPasses - This routine adds optimization passes
282 /// based on selected optimization level, OptLevel. This routine
283 /// duplicates llvm-gcc behaviour.
285 /// OptLevel - Optimization Level
286 void AddOptimizationPasses(PassManager &MPM, FunctionPassManager &FPM,
288 createStandardFunctionPasses(&FPM, OptLevel);
290 llvm::Pass *InliningPass = 0;
293 } else if (OptLevel) {
294 unsigned Threshold = 200;
297 InliningPass = createFunctionInliningPass(Threshold);
299 InliningPass = createAlwaysInlinerPass();
301 createStandardModulePasses(&MPM, OptLevel,
302 /*OptimizeSize=*/ false,
304 /*UnrollLoops=*/ OptLevel > 1,
305 !DisableSimplifyLibCalls,
306 /*HaveExceptions=*/ true,
310 void AddStandardCompilePasses(PassManager &PM) {
311 PM.add(createVerifierPass()); // Verify that input is correct
313 addPass(PM, createLowerSetJmpPass()); // Lower llvm.setjmp/.longjmp
315 // If the -strip-debug command line option was specified, do it.
317 addPass(PM, createStripSymbolsPass(true));
319 if (DisableOptimizations) return;
321 llvm::Pass *InliningPass = !DisableInline ? createFunctionInliningPass() : 0;
323 // -std-compile-opts adds the same module passes as -O3.
324 createStandardModulePasses(&PM, 3,
325 /*OptimizeSize=*/ false,
326 /*UnitAtATime=*/ true,
327 /*UnrollLoops=*/ true,
328 /*SimplifyLibCalls=*/ true,
329 /*HaveExceptions=*/ true,
333 void AddStandardLinkPasses(PassManager &PM) {
334 PM.add(createVerifierPass()); // Verify that input is correct
336 // If the -strip-debug command line option was specified, do it.
338 addPass(PM, createStripSymbolsPass(true));
340 if (DisableOptimizations) return;
342 createStandardLTOPasses(&PM, /*Internalize=*/ !DisableInternalize,
343 /*RunInliner=*/ !DisableInline,
344 /*VerifyEach=*/ VerifyEach);
347 } // anonymous namespace
350 //===----------------------------------------------------------------------===//
353 int main(int argc, char **argv) {
354 sys::PrintStackTraceOnErrorSignal();
355 llvm::PrettyStackTraceProgram X(argc, argv);
357 // Enable debug stream buffering.
358 EnableDebugBuffering = true;
360 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
361 LLVMContext &Context = getGlobalContext();
363 cl::ParseCommandLineOptions(argc, argv,
364 "llvm .bc -> .bc modular optimizer and analysis printer\n");
366 // Allocate a full target machine description only if necessary.
367 // FIXME: The choice of target should be controllable on the command line.
368 std::auto_ptr<TargetMachine> target;
372 // Load the input module...
373 std::auto_ptr<Module> M;
374 M.reset(ParseIRFile(InputFilename, Err, Context));
377 Err.Print(argv[0], errs());
381 // Figure out what stream we are supposed to write to...
382 // FIXME: outs() is not binary!
383 raw_ostream *Out = &outs(); // Default to printing to stdout...
384 if (OutputFilename != "-") {
385 if (NoOutput || AnalyzeOnly) {
386 errs() << "WARNING: The -o (output filename) option is ignored when\n"
387 "the --disable-output or --analyze options are used.\n";
389 // Make sure that the Output file gets unlinked from the disk if we get a
391 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
393 std::string ErrorInfo;
394 Out = new raw_fd_ostream(OutputFilename.c_str(), ErrorInfo,
395 raw_fd_ostream::F_Binary);
396 if (!ErrorInfo.empty()) {
397 errs() << ErrorInfo << '\n';
404 // If the output is set to be emitted to standard out, and standard out is a
405 // console, print out a warning message and refuse to do it. We don't
406 // impress anyone by spewing tons of binary goo to a terminal.
407 if (!Force && !NoOutput && !AnalyzeOnly && !OutputAssembly)
408 if (CheckBitcodeOutputToConsole(*Out, !Quiet))
411 // Create a PassManager to hold and optimize the collection of passes we are
416 // Add an appropriate TargetData instance for this module...
418 const std::string &ModuleDataLayout = M.get()->getDataLayout();
419 if (!ModuleDataLayout.empty())
420 TD = new TargetData(ModuleDataLayout);
421 else if (!DefaultDataLayout.empty())
422 TD = new TargetData(DefaultDataLayout);
427 FunctionPassManager *FPasses = NULL;
428 if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
429 FPasses = new FunctionPassManager(M.get());
431 FPasses->add(new TargetData(*TD));
434 // If the -strip-debug command line option was specified, add it. If
435 // -std-compile-opts was also specified, it will handle StripDebug.
436 if (StripDebug && !StandardCompileOpts)
437 addPass(Passes, createStripSymbolsPass(true));
439 // Create a new optimization pass for each one specified on the command line
440 for (unsigned i = 0; i < PassList.size(); ++i) {
441 // Check to see if -std-compile-opts was specified before this option. If
443 if (StandardCompileOpts &&
444 StandardCompileOpts.getPosition() < PassList.getPosition(i)) {
445 AddStandardCompilePasses(Passes);
446 StandardCompileOpts = false;
449 if (StandardLinkOpts &&
450 StandardLinkOpts.getPosition() < PassList.getPosition(i)) {
451 AddStandardLinkPasses(Passes);
452 StandardLinkOpts = false;
455 if (OptLevelO1 && OptLevelO1.getPosition() < PassList.getPosition(i)) {
456 AddOptimizationPasses(Passes, *FPasses, 1);
460 if (OptLevelO2 && OptLevelO2.getPosition() < PassList.getPosition(i)) {
461 AddOptimizationPasses(Passes, *FPasses, 2);
465 if (OptLevelO3 && OptLevelO3.getPosition() < PassList.getPosition(i)) {
466 AddOptimizationPasses(Passes, *FPasses, 3);
470 const PassInfo *PassInf = PassList[i];
472 if (PassInf->getNormalCtor())
473 P = PassInf->getNormalCtor()();
475 errs() << argv[0] << ": cannot create pass: "
476 << PassInf->getPassName() << "\n";
481 switch (P->getPassKind()) {
483 Passes.add(new BasicBlockPassPrinter(PassInf));
486 Passes.add(new LoopPassPrinter(PassInf));
489 Passes.add(new FunctionPassPrinter(PassInf));
491 case PT_CallGraphSCC:
492 Passes.add(new CallGraphSCCPassPrinter(PassInf));
495 Passes.add(new ModulePassPrinter(PassInf));
502 Passes.add(createPrintModulePass(&errs()));
505 // If -std-compile-opts was specified at the end of the pass list, add them.
506 if (StandardCompileOpts) {
507 AddStandardCompilePasses(Passes);
508 StandardCompileOpts = false;
511 if (StandardLinkOpts) {
512 AddStandardLinkPasses(Passes);
513 StandardLinkOpts = false;
517 AddOptimizationPasses(Passes, *FPasses, 1);
520 AddOptimizationPasses(Passes, *FPasses, 2);
523 AddOptimizationPasses(Passes, *FPasses, 3);
525 if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
526 FPasses->doInitialization();
527 for (Module::iterator I = M.get()->begin(), E = M.get()->end();
532 // Check that the module is well formed on completion of optimization
533 if (!NoVerify && !VerifyEach)
534 Passes.add(createVerifierPass());
536 // Write bitcode or assembly out to disk or outs() as the last step...
537 if (!NoOutput && !AnalyzeOnly) {
539 Passes.add(createPrintModulePass(Out));
541 Passes.add(createBitcodeWriterPass(*Out));
544 // Now that we have all of the passes ready, run them.
545 Passes.run(*M.get());
547 // Delete the raw_fd_ostream.