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/SystemUtils.h"
34 #include "llvm/Support/raw_ostream.h"
35 #include "llvm/LinkAllPasses.h"
36 #include "llvm/LinkAllVMCore.h"
41 // The OptimizationList is automatically populated with registered Passes by the
44 static cl::list<const PassInfo*, bool, PassNameParser>
45 PassList(cl::desc("Optimizations available:"));
47 // Other command line options...
49 static cl::opt<std::string>
50 InputFilename(cl::Positional, cl::desc("<input bitcode file>"),
51 cl::init("-"), cl::value_desc("filename"));
53 static cl::opt<std::string>
54 OutputFilename("o", cl::desc("Override output filename"),
55 cl::value_desc("filename"), cl::init("-"));
58 Force("f", cl::desc("Overwrite output files"));
61 PrintEachXForm("p", cl::desc("Print module after each transformation"));
64 NoOutput("disable-output",
65 cl::desc("Do not write result bitcode file"), cl::Hidden);
68 NoVerify("disable-verify", cl::desc("Do not verify result module"), cl::Hidden);
71 VerifyEach("verify-each", cl::desc("Verify after each transform"));
74 StripDebug("strip-debug",
75 cl::desc("Strip debugger symbol info from translation unit"));
78 DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
81 DisableOptimizations("disable-opt",
82 cl::desc("Do not run any optimization passes"));
85 DisableInternalize("disable-internalize",
86 cl::desc("Do not mark all symbols as internal"));
89 StandardCompileOpts("std-compile-opts",
90 cl::desc("Include the standard compile time optimizations"));
93 StandardLinkOpts("std-link-opts",
94 cl::desc("Include the standard link time optimizations"));
98 cl::desc("Optimization level 1. Similar to llvm-gcc -O1"));
102 cl::desc("Optimization level 2. Similar to llvm-gcc -O2"));
106 cl::desc("Optimization level 3. Similar to llvm-gcc -O3"));
109 UnitAtATime("funit-at-a-time",
110 cl::desc("Enable IPO. This is same as llvm-gcc's -funit-at-a-time"),
114 DisableSimplifyLibCalls("disable-simplify-libcalls",
115 cl::desc("Disable simplify-libcalls"));
118 Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
121 QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
124 AnalyzeOnly("analyze", cl::desc("Only perform analysis, no optimization"));
126 // ---------- Define Printers for module and function passes ------------
129 struct CallGraphSCCPassPrinter : public CallGraphSCCPass {
131 const PassInfo *PassToPrint;
132 CallGraphSCCPassPrinter(const PassInfo *PI) :
133 CallGraphSCCPass(&ID), PassToPrint(PI) {}
135 virtual bool runOnSCC(const std::vector<CallGraphNode *>&SCC) {
137 outs() << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
139 for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
140 Function *F = SCC[i]->getFunction();
143 getAnalysisID<Pass>(PassToPrint).print(outs(), F->getParent());
148 // Get and print pass...
152 virtual const char *getPassName() const { return "'Pass' Printer"; }
154 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
155 AU.addRequiredID(PassToPrint);
156 AU.setPreservesAll();
160 char CallGraphSCCPassPrinter::ID = 0;
162 struct ModulePassPrinter : public ModulePass {
164 const PassInfo *PassToPrint;
165 ModulePassPrinter(const PassInfo *PI) : ModulePass(&ID),
168 virtual bool runOnModule(Module &M) {
170 outs() << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
172 getAnalysisID<Pass>(PassToPrint).print(outs(), &M);
176 // Get and print pass...
180 virtual const char *getPassName() const { return "'Pass' Printer"; }
182 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
183 AU.addRequiredID(PassToPrint);
184 AU.setPreservesAll();
188 char ModulePassPrinter::ID = 0;
189 struct FunctionPassPrinter : public FunctionPass {
190 const PassInfo *PassToPrint;
192 FunctionPassPrinter(const PassInfo *PI) : FunctionPass(&ID),
195 virtual bool runOnFunction(Function &F) {
197 outs() << "Printing analysis '" << PassToPrint->getPassName()
198 << "' for function '" << F.getName() << "':\n";
200 // Get and print pass...
202 getAnalysisID<Pass>(PassToPrint).print(outs(), F.getParent());
207 virtual const char *getPassName() const { return "FunctionPass Printer"; }
209 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
210 AU.addRequiredID(PassToPrint);
211 AU.setPreservesAll();
215 char FunctionPassPrinter::ID = 0;
217 struct LoopPassPrinter : public LoopPass {
219 const PassInfo *PassToPrint;
220 LoopPassPrinter(const PassInfo *PI) :
221 LoopPass(&ID), PassToPrint(PI) {}
223 virtual bool runOnLoop(Loop *L, LPPassManager &LPM) {
225 outs() << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
227 getAnalysisID<Pass>(PassToPrint).print(outs(),
228 L->getHeader()->getParent()->getParent());
231 // Get and print pass...
235 virtual const char *getPassName() const { return "'Pass' Printer"; }
237 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
238 AU.addRequiredID(PassToPrint);
239 AU.setPreservesAll();
243 char LoopPassPrinter::ID = 0;
245 struct BasicBlockPassPrinter : public BasicBlockPass {
246 const PassInfo *PassToPrint;
248 BasicBlockPassPrinter(const PassInfo *PI)
249 : BasicBlockPass(&ID), PassToPrint(PI) {}
251 virtual bool runOnBasicBlock(BasicBlock &BB) {
253 outs() << "Printing Analysis info for BasicBlock '" << BB.getName()
254 << "': Pass " << PassToPrint->getPassName() << ":\n";
257 // Get and print pass...
259 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 = OptLevel > 1 ? createFunctionInliningPass() : 0;
291 createStandardModulePasses(&MPM, OptLevel,
292 /*OptimizeSize=*/ false,
294 /*UnrollLoops=*/ OptLevel > 1,
295 !DisableSimplifyLibCalls,
296 /*HaveExceptions=*/ true,
300 void AddStandardCompilePasses(PassManager &PM) {
301 PM.add(createVerifierPass()); // Verify that input is correct
303 addPass(PM, createLowerSetJmpPass()); // Lower llvm.setjmp/.longjmp
305 // If the -strip-debug command line option was specified, do it.
307 addPass(PM, createStripSymbolsPass(true));
309 if (DisableOptimizations) return;
311 llvm::Pass *InliningPass = !DisableInline ? createFunctionInliningPass() : 0;
313 // -std-compile-opts adds the same module passes as -O3.
314 createStandardModulePasses(&PM, 3,
315 /*OptimizeSize=*/ false,
316 /*UnitAtATime=*/ true,
317 /*UnrollLoops=*/ true,
318 /*SimplifyLibCalls=*/ true,
319 /*HaveExceptions=*/ true,
323 void AddStandardLinkPasses(PassManager &PM) {
324 PM.add(createVerifierPass()); // Verify that input is correct
326 // If the -strip-debug command line option was specified, do it.
328 addPass(PM, createStripSymbolsPass(true));
330 if (DisableOptimizations) return;
332 createStandardLTOPasses(&PM, /*Internalize=*/ !DisableInternalize,
333 /*RunInliner=*/ !DisableInline,
334 /*VerifyEach=*/ VerifyEach);
337 } // anonymous namespace
340 //===----------------------------------------------------------------------===//
343 int main(int argc, char **argv) {
344 llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
345 LLVMContext &Context = getGlobalContext();
347 cl::ParseCommandLineOptions(argc, argv,
348 "llvm .bc -> .bc modular optimizer and analysis printer\n");
349 sys::PrintStackTraceOnErrorSignal();
351 // Allocate a full target machine description only if necessary.
352 // FIXME: The choice of target should be controllable on the command line.
353 std::auto_ptr<TargetMachine> target;
355 std::string ErrorMessage;
357 // Load the input module...
358 std::auto_ptr<Module> M;
359 if (MemoryBuffer *Buffer
360 = MemoryBuffer::getFileOrSTDIN(InputFilename, &ErrorMessage)) {
361 M.reset(ParseBitcodeFile(Buffer, Context, &ErrorMessage));
366 errs() << argv[0] << ": ";
367 if (ErrorMessage.size())
368 errs() << ErrorMessage << "\n";
370 errs() << "bitcode didn't read correctly.\n";
374 // Figure out what stream we are supposed to write to...
375 // FIXME: outs() is not binary!
376 raw_ostream *Out = &outs(); // Default to printing to stdout...
377 if (OutputFilename != "-") {
378 std::string ErrorInfo;
379 Out = new raw_fd_ostream(OutputFilename.c_str(), ErrorInfo,
380 raw_fd_ostream::F_Binary |
381 (Force ? raw_fd_ostream::F_Force : 0));
382 if (!ErrorInfo.empty()) {
383 errs() << ErrorInfo << '\n';
385 errs() << "Use -f command line argument to force output\n";
390 // Make sure that the Output file gets unlinked from the disk if we get a
392 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
395 // If the output is set to be emitted to standard out, and standard out is a
396 // console, print out a warning message and refuse to do it. We don't
397 // impress anyone by spewing tons of binary goo to a terminal.
398 if (!Force && !NoOutput && CheckBitcodeOutputToConsole(Out,!Quiet)) {
402 // Create a PassManager to hold and optimize the collection of passes we are
407 // Add an appropriate TargetData instance for this module...
408 Passes.add(new TargetData(M.get()));
410 FunctionPassManager *FPasses = NULL;
411 if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
412 FPasses = new FunctionPassManager(new ExistingModuleProvider(M.get()));
413 FPasses->add(new TargetData(M.get()));
416 // If the -strip-debug command line option was specified, add it. If
417 // -std-compile-opts was also specified, it will handle StripDebug.
418 if (StripDebug && !StandardCompileOpts)
419 addPass(Passes, createStripSymbolsPass(true));
421 // Create a new optimization pass for each one specified on the command line
422 for (unsigned i = 0; i < PassList.size(); ++i) {
423 // Check to see if -std-compile-opts was specified before this option. If
425 if (StandardCompileOpts &&
426 StandardCompileOpts.getPosition() < PassList.getPosition(i)) {
427 AddStandardCompilePasses(Passes);
428 StandardCompileOpts = false;
431 if (StandardLinkOpts &&
432 StandardLinkOpts.getPosition() < PassList.getPosition(i)) {
433 AddStandardLinkPasses(Passes);
434 StandardLinkOpts = false;
437 if (OptLevelO1 && OptLevelO1.getPosition() < PassList.getPosition(i)) {
438 AddOptimizationPasses(Passes, *FPasses, 1);
442 if (OptLevelO2 && OptLevelO2.getPosition() < PassList.getPosition(i)) {
443 AddOptimizationPasses(Passes, *FPasses, 2);
447 if (OptLevelO3 && OptLevelO3.getPosition() < PassList.getPosition(i)) {
448 AddOptimizationPasses(Passes, *FPasses, 3);
452 const PassInfo *PassInf = PassList[i];
454 if (PassInf->getNormalCtor())
455 P = PassInf->getNormalCtor()();
457 errs() << argv[0] << ": cannot create pass: "
458 << PassInf->getPassName() << "\n";
460 bool isBBPass = dynamic_cast<BasicBlockPass*>(P) != 0;
461 bool isLPass = !isBBPass && dynamic_cast<LoopPass*>(P) != 0;
462 bool isFPass = !isLPass && dynamic_cast<FunctionPass*>(P) != 0;
463 bool isCGSCCPass = !isFPass && dynamic_cast<CallGraphSCCPass*>(P) != 0;
469 Passes.add(new BasicBlockPassPrinter(PassInf));
471 Passes.add(new LoopPassPrinter(PassInf));
473 Passes.add(new FunctionPassPrinter(PassInf));
474 else if (isCGSCCPass)
475 Passes.add(new CallGraphSCCPassPrinter(PassInf));
477 Passes.add(new ModulePassPrinter(PassInf));
482 Passes.add(createPrintModulePass(&errs()));
485 // If -std-compile-opts was specified at the end of the pass list, add them.
486 if (StandardCompileOpts) {
487 AddStandardCompilePasses(Passes);
488 StandardCompileOpts = false;
491 if (StandardLinkOpts) {
492 AddStandardLinkPasses(Passes);
493 StandardLinkOpts = false;
497 AddOptimizationPasses(Passes, *FPasses, 1);
501 AddOptimizationPasses(Passes, *FPasses, 2);
505 AddOptimizationPasses(Passes, *FPasses, 3);
508 if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
509 FPasses->doInitialization();
510 for (Module::iterator I = M.get()->begin(), E = M.get()->end();
515 // Check that the module is well formed on completion of optimization
516 if (!NoVerify && !VerifyEach)
517 Passes.add(createVerifierPass());
519 // Write bitcode out to disk or outs() as the last step...
520 if (!NoOutput && !AnalyzeOnly)
521 Passes.add(createBitcodeWriterPass(*Out));
523 // Now that we have all of the passes ready, run them.
524 Passes.run(*M.get());
526 // Delete the raw_fd_ostream.
531 } catch (const std::string& msg) {
532 errs() << argv[0] << ": " << msg << "\n";
534 errs() << argv[0] << ": Unexpected unknown exception occurred.\n";