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/Module.h"
16 #include "llvm/PassManager.h"
17 #include "llvm/CallGraphSCCPass.h"
18 #include "llvm/Bitcode/ReaderWriter.h"
19 #include "llvm/Assembly/PrintModulePass.h"
20 #include "llvm/Analysis/Verifier.h"
21 #include "llvm/Analysis/LoopPass.h"
22 #include "llvm/Analysis/CallGraph.h"
23 #include "llvm/Target/TargetData.h"
24 #include "llvm/Target/TargetMachine.h"
25 #include "llvm/Support/PassNameParser.h"
26 #include "llvm/System/Signals.h"
27 #include "llvm/Support/ManagedStatic.h"
28 #include "llvm/Support/MemoryBuffer.h"
29 #include "llvm/Support/PluginLoader.h"
30 #include "llvm/Support/Streams.h"
31 #include "llvm/Support/SystemUtils.h"
32 #include "llvm/LinkAllPasses.h"
33 #include "llvm/LinkAllVMCore.h"
40 // The OptimizationList is automatically populated with registered Passes by the
43 static cl::list<const PassInfo*, bool, PassNameParser>
44 PassList(cl::desc("Optimizations available:"));
46 // Other command line options...
48 static cl::opt<std::string>
49 InputFilename(cl::Positional, cl::desc("<input bitcode file>"),
50 cl::init("-"), cl::value_desc("filename"));
52 static cl::opt<std::string>
53 OutputFilename("o", cl::desc("Override output filename"),
54 cl::value_desc("filename"), cl::init("-"));
57 Force("f", cl::desc("Overwrite output files"));
60 PrintEachXForm("p", cl::desc("Print module after each transformation"));
63 NoOutput("disable-output",
64 cl::desc("Do not write result bitcode file"), cl::Hidden);
67 NoVerify("disable-verify", cl::desc("Do not verify result module"), cl::Hidden);
70 VerifyEach("verify-each", cl::desc("Verify after each transform"));
73 StripDebug("strip-debug",
74 cl::desc("Strip debugger symbol info from translation unit"));
77 DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
80 DisableOptimizations("disable-opt",
81 cl::desc("Do not run any optimization passes"));
84 StandardCompileOpts("std-compile-opts",
85 cl::desc("Include the standard compile time optimizations"));
88 Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
91 QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
94 AnalyzeOnly("analyze", cl::desc("Only perform analysis, no optimization"));
96 // ---------- Define Printers for module and function passes ------------
99 struct CallGraphSCCPassPrinter : public CallGraphSCCPass {
101 const PassInfo *PassToPrint;
102 CallGraphSCCPassPrinter(const PassInfo *PI) :
103 CallGraphSCCPass((intptr_t)&ID), PassToPrint(PI) {}
105 virtual bool runOnSCC(const std::vector<CallGraphNode *>&SCC) {
107 cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
109 for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
110 Function *F = SCC[i]->getFunction();
112 getAnalysisID<Pass>(PassToPrint).print(cout, F->getParent());
115 // Get and print pass...
119 virtual const char *getPassName() const { return "'Pass' Printer"; }
121 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
122 AU.addRequiredID(PassToPrint);
123 AU.setPreservesAll();
127 char CallGraphSCCPassPrinter::ID = 0;
129 struct ModulePassPrinter : public ModulePass {
131 const PassInfo *PassToPrint;
132 ModulePassPrinter(const PassInfo *PI) : ModulePass((intptr_t)&ID),
135 virtual bool runOnModule(Module &M) {
137 cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
138 getAnalysisID<Pass>(PassToPrint).print(cout, &M);
141 // Get and print pass...
145 virtual const char *getPassName() const { return "'Pass' Printer"; }
147 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
148 AU.addRequiredID(PassToPrint);
149 AU.setPreservesAll();
153 char ModulePassPrinter::ID = 0;
154 struct FunctionPassPrinter : public FunctionPass {
155 const PassInfo *PassToPrint;
157 FunctionPassPrinter(const PassInfo *PI) : FunctionPass((intptr_t)&ID),
160 virtual bool runOnFunction(Function &F) {
162 cout << "Printing analysis '" << PassToPrint->getPassName()
163 << "' for function '" << F.getName() << "':\n";
165 // Get and print pass...
166 getAnalysisID<Pass>(PassToPrint).print(cout, F.getParent());
170 virtual const char *getPassName() const { return "FunctionPass Printer"; }
172 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
173 AU.addRequiredID(PassToPrint);
174 AU.setPreservesAll();
178 char FunctionPassPrinter::ID = 0;
180 struct LoopPassPrinter : public LoopPass {
182 const PassInfo *PassToPrint;
183 LoopPassPrinter(const PassInfo *PI) :
184 LoopPass((intptr_t)&ID), PassToPrint(PI) {}
186 virtual bool runOnLoop(Loop *L, LPPassManager &LPM) {
188 cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
189 getAnalysisID<Pass>(PassToPrint).print(cout,
190 L->getHeader()->getParent()->getParent());
192 // Get and print pass...
196 virtual const char *getPassName() const { return "'Pass' Printer"; }
198 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
199 AU.addRequiredID(PassToPrint);
200 AU.setPreservesAll();
204 char LoopPassPrinter::ID = 0;
206 struct BasicBlockPassPrinter : public BasicBlockPass {
207 const PassInfo *PassToPrint;
209 BasicBlockPassPrinter(const PassInfo *PI)
210 : BasicBlockPass((intptr_t)&ID), PassToPrint(PI) {}
212 virtual bool runOnBasicBlock(BasicBlock &BB) {
214 cout << "Printing Analysis info for BasicBlock '" << BB.getName()
215 << "': Pass " << PassToPrint->getPassName() << ":\n";
218 // Get and print pass...
219 getAnalysisID<Pass>(PassToPrint).print(cout, BB.getParent()->getParent());
223 virtual const char *getPassName() const { return "BasicBlockPass Printer"; }
225 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
226 AU.addRequiredID(PassToPrint);
227 AU.setPreservesAll();
231 char BasicBlockPassPrinter::ID = 0;
232 inline void addPass(PassManager &PM, Pass *P) {
233 // Add the pass to the pass manager...
236 // If we are verifying all of the intermediate steps, add the verifier...
237 if (VerifyEach) PM.add(createVerifierPass());
240 void AddStandardCompilePasses(PassManager &PM) {
241 PM.add(createVerifierPass()); // Verify that input is correct
243 addPass(PM, createLowerSetJmpPass()); // Lower llvm.setjmp/.longjmp
245 // If the -strip-debug command line option was specified, do it.
247 addPass(PM, createStripSymbolsPass(true));
249 if (DisableOptimizations) return;
251 addPass(PM, createRaiseAllocationsPass()); // call %malloc -> malloc inst
252 addPass(PM, createCFGSimplificationPass()); // Clean up disgusting code
253 addPass(PM, createPromoteMemoryToRegisterPass());// Kill useless allocas
254 addPass(PM, createGlobalOptimizerPass()); // Optimize out global vars
255 addPass(PM, createGlobalDCEPass()); // Remove unused fns and globs
256 addPass(PM, createIPConstantPropagationPass());// IP Constant Propagation
257 addPass(PM, createDeadArgEliminationPass()); // Dead argument elimination
258 addPass(PM, createInstructionCombiningPass()); // Clean up after IPCP & DAE
259 addPass(PM, createCFGSimplificationPass()); // Clean up after IPCP & DAE
261 addPass(PM, createPruneEHPass()); // Remove dead EH info
264 addPass(PM, createFunctionInliningPass()); // Inline small functions
265 addPass(PM, createArgumentPromotionPass()); // Scalarize uninlined fn args
267 addPass(PM, createSimplifyLibCallsPass()); // Library Call Optimizations
268 addPass(PM, createInstructionCombiningPass()); // Cleanup for scalarrepl.
269 addPass(PM, createJumpThreadingPass()); // Thread jumps.
270 addPass(PM, createCFGSimplificationPass()); // Merge & remove BBs
271 addPass(PM, createScalarReplAggregatesPass()); // Break up aggregate allocas
272 addPass(PM, createInstructionCombiningPass()); // Combine silly seq's
273 addPass(PM, createCondPropagationPass()); // Propagate conditionals
275 addPass(PM, createTailCallEliminationPass()); // Eliminate tail calls
276 addPass(PM, createCFGSimplificationPass()); // Merge & remove BBs
277 addPass(PM, createReassociatePass()); // Reassociate expressions
278 addPass(PM, createLoopRotatePass());
279 addPass(PM, createLICMPass()); // Hoist loop invariants
280 addPass(PM, createLoopUnswitchPass()); // Unswitch loops.
281 addPass(PM, createLoopIndexSplitPass()); // Index split loops.
282 // FIXME : Removing instcombine causes nestedloop regression.
283 addPass(PM, createInstructionCombiningPass());
284 addPass(PM, createIndVarSimplifyPass()); // Canonicalize indvars
285 addPass(PM, createLoopDeletionPass()); // Delete dead loops
286 addPass(PM, createLoopUnrollPass()); // Unroll small loops
287 addPass(PM, createInstructionCombiningPass()); // Clean up after the unroller
288 addPass(PM, createGVNPass()); // Remove redundancies
289 addPass(PM, createMemCpyOptPass()); // Remove memcpy / form memset
290 addPass(PM, createSCCPPass()); // Constant prop with SCCP
292 // Run instcombine after redundancy elimination to exploit opportunities
293 // opened up by them.
294 addPass(PM, createInstructionCombiningPass());
295 addPass(PM, createCondPropagationPass()); // Propagate conditionals
297 addPass(PM, createDeadStoreEliminationPass()); // Delete dead stores
298 addPass(PM, createAggressiveDCEPass()); // Delete dead instructions
299 addPass(PM, createCFGSimplificationPass()); // Merge & remove BBs
300 addPass(PM, createStripDeadPrototypesPass()); // Get rid of dead prototypes
301 addPass(PM, createDeadTypeEliminationPass()); // Eliminate dead types
302 addPass(PM, createConstantMergePass()); // Merge dup global constants
305 } // anonymous namespace
308 //===----------------------------------------------------------------------===//
311 int main(int argc, char **argv) {
312 llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
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, &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 std::ostream *Out = &std::cout; // Default to printing to stdout...
344 if (OutputFilename != "-") {
345 if (!Force && std::ifstream(OutputFilename.c_str())) {
346 // If force is not specified, make sure not to overwrite a file!
347 cerr << argv[0] << ": error opening '" << OutputFilename
348 << "': file exists!\n"
349 << "Use -f command line argument to force output\n";
352 std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
354 Out = new std::ofstream(OutputFilename.c_str(), io_mode);
357 cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
361 // Make sure that the Output file gets unlinked from the disk if we get a
363 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
366 // If the output is set to be emitted to standard out, and standard out is a
367 // console, print out a warning message and refuse to do it. We don't
368 // impress anyone by spewing tons of binary goo to a terminal.
369 if (!Force && !NoOutput && CheckBitcodeOutputToConsole(Out,!Quiet)) {
373 // Create a PassManager to hold and optimize the collection of passes we are
378 // Add an appropriate TargetData instance for this module...
379 Passes.add(new TargetData(M.get()));
381 // If the -strip-debug command line option was specified, add it. If
382 // -std-compile-opts was also specified, it will handle StripDebug.
383 if (StripDebug && !StandardCompileOpts)
384 addPass(Passes, createStripSymbolsPass(true));
386 // Create a new optimization pass for each one specified on the command line
387 for (unsigned i = 0; i < PassList.size(); ++i) {
388 // Check to see if -std-compile-opts was specified before this option. If
390 if (StandardCompileOpts &&
391 StandardCompileOpts.getPosition() < PassList.getPosition(i)) {
392 AddStandardCompilePasses(Passes);
393 StandardCompileOpts = false;
396 const PassInfo *PassInf = PassList[i];
398 if (PassInf->getNormalCtor())
399 P = PassInf->getNormalCtor()();
401 cerr << argv[0] << ": cannot create pass: "
402 << PassInf->getPassName() << "\n";
407 if (dynamic_cast<BasicBlockPass*>(P))
408 Passes.add(new BasicBlockPassPrinter(PassInf));
409 else if (dynamic_cast<LoopPass*>(P))
410 Passes.add(new LoopPassPrinter(PassInf));
411 else if (dynamic_cast<FunctionPass*>(P))
412 Passes.add(new FunctionPassPrinter(PassInf));
413 else if (dynamic_cast<CallGraphSCCPass*>(P))
414 Passes.add(new CallGraphSCCPassPrinter(PassInf));
416 Passes.add(new ModulePassPrinter(PassInf));
421 Passes.add(new PrintModulePass(&cerr));
424 // If -std-compile-opts was specified at the end of the pass list, add them.
425 if (StandardCompileOpts) {
426 AddStandardCompilePasses(Passes);
427 StandardCompileOpts = false;
430 // Check that the module is well formed on completion of optimization
431 if (!NoVerify && !VerifyEach)
432 Passes.add(createVerifierPass());
434 // Write bitcode out to disk or cout as the last step...
435 if (!NoOutput && !AnalyzeOnly)
436 Passes.add(CreateBitcodeWriterPass(*Out));
438 // Now that we have all of the passes ready, run them.
439 Passes.run(*M.get());
441 // Delete the ofstream.
442 if (Out != &std::cout)
446 } catch (const std::string& msg) {
447 cerr << argv[0] << ": " << msg << "\n";
449 cerr << argv[0] << ": Unexpected unknown exception occurred.\n";