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"
42 // The OptimizationList is automatically populated with registered Passes by the
45 static cl::list<const PassInfo*, bool, PassNameParser>
46 PassList(cl::desc("Optimizations available:"));
48 // Other command line options...
50 static cl::opt<std::string>
51 InputFilename(cl::Positional, cl::desc("<input bitcode file>"),
52 cl::init("-"), cl::value_desc("filename"));
54 static cl::opt<std::string>
55 OutputFilename("o", cl::desc("Override output filename"),
56 cl::value_desc("filename"), cl::init("-"));
59 Force("f", cl::desc("Overwrite output files"));
62 PrintEachXForm("p", cl::desc("Print module after each transformation"));
65 NoOutput("disable-output",
66 cl::desc("Do not write result bitcode file"), cl::Hidden);
69 NoVerify("disable-verify", cl::desc("Do not verify result module"), cl::Hidden);
72 VerifyEach("verify-each", cl::desc("Verify after each transform"));
75 StripDebug("strip-debug",
76 cl::desc("Strip debugger symbol info from translation unit"));
79 DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
82 DisableOptimizations("disable-opt",
83 cl::desc("Do not run any optimization passes"));
86 StandardCompileOpts("std-compile-opts",
87 cl::desc("Include the standard compile time optimizations"));
91 cl::desc("Optimization level 1. Similar to llvm-gcc -O1"));
95 cl::desc("Optimization level 2. Similar to llvm-gcc -O2"));
99 cl::desc("Optimization level 3. Similar to llvm-gcc -O3"));
102 UnitAtATime("funit-at-a-time",
103 cl::desc("Enable IPO. This is same as llvm-gcc's -funit-at-a-time"));
106 DisableSimplifyLibCalls("disable-simplify-libcalls",
107 cl::desc("Disable simplify-libcalls"));
110 Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
113 QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
116 AnalyzeOnly("analyze", cl::desc("Only perform analysis, no optimization"));
118 // ---------- Define Printers for module and function passes ------------
121 struct CallGraphSCCPassPrinter : public CallGraphSCCPass {
123 const PassInfo *PassToPrint;
124 CallGraphSCCPassPrinter(const PassInfo *PI) :
125 CallGraphSCCPass(&ID), PassToPrint(PI) {}
127 virtual bool runOnSCC(const std::vector<CallGraphNode *>&SCC) {
129 cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
131 for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
132 Function *F = SCC[i]->getFunction();
134 getAnalysisID<Pass>(PassToPrint).print(cout, F->getParent());
137 // Get and print pass...
141 virtual const char *getPassName() const { return "'Pass' Printer"; }
143 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
144 AU.addRequiredID(PassToPrint);
145 AU.setPreservesAll();
149 char CallGraphSCCPassPrinter::ID = 0;
151 struct ModulePassPrinter : public ModulePass {
153 const PassInfo *PassToPrint;
154 ModulePassPrinter(const PassInfo *PI) : ModulePass(&ID),
157 virtual bool runOnModule(Module &M) {
159 cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
160 getAnalysisID<Pass>(PassToPrint).print(cout, &M);
163 // Get and print pass...
167 virtual const char *getPassName() const { return "'Pass' Printer"; }
169 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
170 AU.addRequiredID(PassToPrint);
171 AU.setPreservesAll();
175 char ModulePassPrinter::ID = 0;
176 struct FunctionPassPrinter : public FunctionPass {
177 const PassInfo *PassToPrint;
179 FunctionPassPrinter(const PassInfo *PI) : FunctionPass(&ID),
182 virtual bool runOnFunction(Function &F) {
184 cout << "Printing analysis '" << PassToPrint->getPassName()
185 << "' for function '" << F.getName() << "':\n";
187 // Get and print pass...
188 getAnalysisID<Pass>(PassToPrint).print(cout, F.getParent());
192 virtual const char *getPassName() const { return "FunctionPass Printer"; }
194 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
195 AU.addRequiredID(PassToPrint);
196 AU.setPreservesAll();
200 char FunctionPassPrinter::ID = 0;
202 struct LoopPassPrinter : public LoopPass {
204 const PassInfo *PassToPrint;
205 LoopPassPrinter(const PassInfo *PI) :
206 LoopPass(&ID), PassToPrint(PI) {}
208 virtual bool runOnLoop(Loop *L, LPPassManager &LPM) {
210 cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
211 getAnalysisID<Pass>(PassToPrint).print(cout,
212 L->getHeader()->getParent()->getParent());
214 // Get and print pass...
218 virtual const char *getPassName() const { return "'Pass' Printer"; }
220 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
221 AU.addRequiredID(PassToPrint);
222 AU.setPreservesAll();
226 char LoopPassPrinter::ID = 0;
228 struct BasicBlockPassPrinter : public BasicBlockPass {
229 const PassInfo *PassToPrint;
231 BasicBlockPassPrinter(const PassInfo *PI)
232 : BasicBlockPass(&ID), PassToPrint(PI) {}
234 virtual bool runOnBasicBlock(BasicBlock &BB) {
236 cout << "Printing Analysis info for BasicBlock '" << BB.getName()
237 << "': Pass " << PassToPrint->getPassName() << ":\n";
240 // Get and print pass...
241 getAnalysisID<Pass>(PassToPrint).print(cout, BB.getParent()->getParent());
245 virtual const char *getPassName() const { return "BasicBlockPass Printer"; }
247 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
248 AU.addRequiredID(PassToPrint);
249 AU.setPreservesAll();
253 char BasicBlockPassPrinter::ID = 0;
254 inline void addPass(PassManager &PM, Pass *P) {
255 // Add the pass to the pass manager...
258 // If we are verifying all of the intermediate steps, add the verifier...
259 if (VerifyEach) PM.add(createVerifierPass());
262 /// AddOptimizationPasses - This routine adds optimization passes
263 /// based on selected optimization level, OptLevel. This routine
264 /// duplicates llvm-gcc behaviour.
266 /// OptLevel - Optimization Level
267 void AddOptimizationPasses(PassManager &MPM, FunctionPassManager &FPM,
269 createStandardFunctionPasses(&FPM, OptLevel);
271 llvm::Pass *InliningPass = OptLevel > 1 ? createFunctionInliningPass() : 0;
272 createStandardModulePasses(&MPM, OptLevel,
273 /*OptimizeSize=*/ false,
275 /*UnrollLoops=*/ OptLevel > 1,
276 !DisableSimplifyLibCalls,
277 /*HaveExceptions=*/ true,
281 void AddStandardCompilePasses(PassManager &PM) {
282 PM.add(createVerifierPass()); // Verify that input is correct
284 addPass(PM, createLowerSetJmpPass()); // Lower llvm.setjmp/.longjmp
286 // If the -strip-debug command line option was specified, do it.
288 addPass(PM, createStripSymbolsPass(true));
290 if (DisableOptimizations) return;
292 llvm::Pass *InliningPass = !DisableInline ? createFunctionInliningPass() : 0;
294 // -std-compile-opts adds the same module passes as -O3.
295 createStandardModulePasses(&PM, 3,
296 /*OptimizeSize=*/ false,
297 /*UnitAtATime=*/ true,
298 /*UnrollLoops=*/ true,
299 /*SimplifyLibCalls=*/ true,
300 /*HaveExceptions=*/ true,
304 } // anonymous namespace
307 //===----------------------------------------------------------------------===//
310 int main(int argc, char **argv) {
311 llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
312 LLVMContext &Context = getGlobalContext();
314 cl::ParseCommandLineOptions(argc, argv,
315 "llvm .bc -> .bc modular optimizer and analysis printer\n");
316 sys::PrintStackTraceOnErrorSignal();
318 // Allocate a full target machine description only if necessary.
319 // FIXME: The choice of target should be controllable on the command line.
320 std::auto_ptr<TargetMachine> target;
322 std::string ErrorMessage;
324 // Load the input module...
325 std::auto_ptr<Module> M;
326 if (MemoryBuffer *Buffer
327 = MemoryBuffer::getFileOrSTDIN(InputFilename, &ErrorMessage)) {
328 M.reset(ParseBitcodeFile(Buffer, Context, &ErrorMessage));
333 cerr << argv[0] << ": ";
334 if (ErrorMessage.size())
335 cerr << ErrorMessage << "\n";
337 cerr << "bitcode didn't read correctly.\n";
341 // Figure out what stream we are supposed to write to...
342 // FIXME: cout is not binary!
343 raw_ostream *Out = &outs(); // Default to printing to stdout...
344 if (OutputFilename != "-") {
345 std::string ErrorInfo;
346 Out = new raw_fd_ostream(OutputFilename.c_str(), /*Binary=*/true,
348 if (!ErrorInfo.empty()) {
349 errs() << ErrorInfo << '\n';
351 errs() << "Use -f command line argument to force output\n";
356 // Make sure that the Output file gets unlinked from the disk if we get a
358 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
361 // If the output is set to be emitted to standard out, and standard out is a
362 // console, print out a warning message and refuse to do it. We don't
363 // impress anyone by spewing tons of binary goo to a terminal.
364 if (!Force && !NoOutput && CheckBitcodeOutputToConsole(Out,!Quiet)) {
368 // Create a PassManager to hold and optimize the collection of passes we are
373 // Add an appropriate TargetData instance for this module...
374 Passes.add(new TargetData(M.get()));
376 FunctionPassManager *FPasses = NULL;
377 if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
378 FPasses = new FunctionPassManager(new ExistingModuleProvider(M.get()));
379 FPasses->add(new TargetData(M.get()));
382 // If the -strip-debug command line option was specified, add it. If
383 // -std-compile-opts was also specified, it will handle StripDebug.
384 if (StripDebug && !StandardCompileOpts)
385 addPass(Passes, createStripSymbolsPass(true));
387 // Create a new optimization pass for each one specified on the command line
388 for (unsigned i = 0; i < PassList.size(); ++i) {
389 // Check to see if -std-compile-opts was specified before this option. If
391 if (StandardCompileOpts &&
392 StandardCompileOpts.getPosition() < PassList.getPosition(i)) {
393 AddStandardCompilePasses(Passes);
394 StandardCompileOpts = false;
397 if (OptLevelO1 && OptLevelO1.getPosition() < PassList.getPosition(i)) {
398 AddOptimizationPasses(Passes, *FPasses, 1);
402 if (OptLevelO2 && OptLevelO2.getPosition() < PassList.getPosition(i)) {
403 AddOptimizationPasses(Passes, *FPasses, 2);
407 if (OptLevelO3 && OptLevelO3.getPosition() < PassList.getPosition(i)) {
408 AddOptimizationPasses(Passes, *FPasses, 3);
412 const PassInfo *PassInf = PassList[i];
414 if (PassInf->getNormalCtor())
415 P = PassInf->getNormalCtor()();
417 cerr << argv[0] << ": cannot create pass: "
418 << PassInf->getPassName() << "\n";
420 bool isBBPass = dynamic_cast<BasicBlockPass*>(P) != 0;
421 bool isLPass = !isBBPass && dynamic_cast<LoopPass*>(P) != 0;
422 bool isFPass = !isLPass && dynamic_cast<FunctionPass*>(P) != 0;
423 bool isCGSCCPass = !isFPass && dynamic_cast<CallGraphSCCPass*>(P) != 0;
429 Passes.add(new BasicBlockPassPrinter(PassInf));
431 Passes.add(new LoopPassPrinter(PassInf));
433 Passes.add(new FunctionPassPrinter(PassInf));
434 else if (isCGSCCPass)
435 Passes.add(new CallGraphSCCPassPrinter(PassInf));
437 Passes.add(new ModulePassPrinter(PassInf));
442 Passes.add(createPrintModulePass(&errs()));
445 // If -std-compile-opts was specified at the end of the pass list, add them.
446 if (StandardCompileOpts) {
447 AddStandardCompilePasses(Passes);
448 StandardCompileOpts = false;
452 AddOptimizationPasses(Passes, *FPasses, 1);
456 AddOptimizationPasses(Passes, *FPasses, 2);
460 AddOptimizationPasses(Passes, *FPasses, 3);
463 if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
464 for (Module::iterator I = M.get()->begin(), E = M.get()->end();
469 // Check that the module is well formed on completion of optimization
470 if (!NoVerify && !VerifyEach)
471 Passes.add(createVerifierPass());
473 // Write bitcode out to disk or cout as the last step...
474 if (!NoOutput && !AnalyzeOnly)
475 Passes.add(createBitcodeWriterPass(*Out));
477 // Now that we have all of the passes ready, run them.
478 Passes.run(*M.get());
480 // Delete the ofstream.
485 } catch (const std::string& msg) {
486 cerr << argv[0] << ": " << msg << "\n";
488 cerr << argv[0] << ": Unexpected unknown exception occurred.\n";