1 //===- opt.cpp - The LLVM Modular Optimizer -------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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/Bytecode/Reader.h"
18 #include "llvm/Bytecode/WriteBytecodePass.h"
19 #include "llvm/Assembly/PrintModulePass.h"
20 #include "llvm/Analysis/Verifier.h"
21 #include "llvm/Target/TargetData.h"
22 #include "llvm/Target/TargetMachine.h"
23 #include "llvm/Support/PassNameParser.h"
24 #include "llvm/System/Signals.h"
25 #include "llvm/Support/ManagedStatic.h"
26 #include "llvm/Support/PluginLoader.h"
27 #include "llvm/Support/Streams.h"
28 #include "llvm/Support/SystemUtils.h"
29 #include "llvm/Support/Timer.h"
30 #include "llvm/LinkAllPasses.h"
31 #include "llvm/LinkAllVMCore.h"
38 // The OptimizationList is automatically populated with registered Passes by the
41 static cl::list<const PassInfo*, bool, PassNameParser>
42 PassList(cl::desc("Optimizations available:"));
44 static cl::opt<bool> NoCompress("disable-compression", cl::init(true),
45 cl::desc("Don't compress the generated bytecode"));
47 // Other command line options...
49 static cl::opt<std::string>
50 InputFilename(cl::Positional, cl::desc("<input bytecode 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 bytecode 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 StandardCompileOpts("std-compile-opts",
86 cl::desc("Include the standard compile time optimizations"));
89 Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
92 QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
95 AnalyzeOnly("analyze", cl::desc("Only perform analysis, no optimization"));
97 static Timer BytecodeLoadTimer("Bytecode Loader");
99 // ---------- Define Printers for module and function passes ------------
102 struct ModulePassPrinter : public ModulePass {
103 const PassInfo *PassToPrint;
104 ModulePassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
106 virtual bool runOnModule(Module &M) {
108 cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
109 getAnalysisID<Pass>(PassToPrint).print(cout, &M);
112 // Get and print pass...
116 virtual const char *getPassName() const { return "'Pass' Printer"; }
118 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
119 AU.addRequiredID(PassToPrint);
120 AU.setPreservesAll();
124 struct FunctionPassPrinter : public FunctionPass {
125 const PassInfo *PassToPrint;
126 FunctionPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
128 virtual bool runOnFunction(Function &F) {
130 cout << "Printing analysis '" << PassToPrint->getPassName()
131 << "' for function '" << F.getName() << "':\n";
133 // Get and print pass...
134 getAnalysisID<Pass>(PassToPrint).print(cout, F.getParent());
138 virtual const char *getPassName() const { return "FunctionPass Printer"; }
140 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
141 AU.addRequiredID(PassToPrint);
142 AU.setPreservesAll();
146 struct BasicBlockPassPrinter : public BasicBlockPass {
147 const PassInfo *PassToPrint;
148 BasicBlockPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
150 virtual bool runOnBasicBlock(BasicBlock &BB) {
152 cout << "Printing Analysis info for BasicBlock '" << BB.getName()
153 << "': Pass " << PassToPrint->getPassName() << ":\n";
156 // Get and print pass...
157 getAnalysisID<Pass>(PassToPrint).print(cout, BB.getParent()->getParent());
161 virtual const char *getPassName() const { return "BasicBlockPass Printer"; }
163 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
164 AU.addRequiredID(PassToPrint);
165 AU.setPreservesAll();
169 inline void addPass(PassManager &PM, Pass *P) {
170 // Add the pass to the pass manager...
173 // If we are verifying all of the intermediate steps, add the verifier...
174 if (VerifyEach) PM.add(createVerifierPass());
177 void AddStandardCompilePasses(PassManager &PM) {
178 PM.add(createVerifierPass()); // Verify that input is correct
180 addPass(PM, createLowerSetJmpPass()); // Lower llvm.setjmp/.longjmp
181 addPass(PM, createFunctionResolvingPass()); // Resolve (...) functions
183 // If the -strip-debug command line option was specified, do it.
185 addPass(PM, createStripSymbolsPass(true));
187 if (DisableOptimizations) return;
189 addPass(PM, createRaiseAllocationsPass()); // call %malloc -> malloc inst
190 addPass(PM, createCFGSimplificationPass()); // Clean up disgusting code
191 addPass(PM, createPromoteMemoryToRegisterPass());// Kill useless allocas
192 addPass(PM, createGlobalOptimizerPass()); // Optimize out global vars
193 addPass(PM, createGlobalDCEPass()); // Remove unused fns and globs
194 addPass(PM, createIPConstantPropagationPass());// IP Constant Propagation
195 addPass(PM, createDeadArgEliminationPass()); // Dead argument elimination
196 addPass(PM, createInstructionCombiningPass()); // Clean up after IPCP & DAE
197 addPass(PM, createCFGSimplificationPass()); // Clean up after IPCP & DAE
199 addPass(PM, createPruneEHPass()); // Remove dead EH info
202 addPass(PM, createFunctionInliningPass()); // Inline small functions
203 addPass(PM, createArgumentPromotionPass()); // Scalarize uninlined fn args
205 addPass(PM, createRaisePointerReferencesPass());// Recover type information
206 addPass(PM, createTailDuplicationPass()); // Simplify cfg by copying code
207 addPass(PM, createInstructionCombiningPass()); // Cleanup for scalarrepl.
208 addPass(PM, createCFGSimplificationPass()); // Merge & remove BBs
209 addPass(PM, createScalarReplAggregatesPass()); // Break up aggregate allocas
210 addPass(PM, createInstructionCombiningPass()); // Combine silly seq's
211 addPass(PM, createCondPropagationPass()); // Propagate conditionals
213 addPass(PM, createTailCallEliminationPass()); // Eliminate tail calls
214 addPass(PM, createCFGSimplificationPass()); // Merge & remove BBs
215 addPass(PM, createReassociatePass()); // Reassociate expressions
216 addPass(PM, createLICMPass()); // Hoist loop invariants
217 addPass(PM, createLoopUnswitchPass()); // Unswitch loops.
218 addPass(PM, createInstructionCombiningPass()); // Clean up after LICM/reassoc
219 addPass(PM, createIndVarSimplifyPass()); // Canonicalize indvars
220 addPass(PM, createLoopUnrollPass()); // Unroll small loops
221 addPass(PM, createInstructionCombiningPass()); // Clean up after the unroller
222 addPass(PM, createLoadValueNumberingPass()); // GVN for load instructions
223 addPass(PM, createGCSEPass()); // Remove common subexprs
224 addPass(PM, createSCCPPass()); // Constant prop with SCCP
226 // Run instcombine after redundancy elimination to exploit opportunities
227 // opened up by them.
228 addPass(PM, createInstructionCombiningPass());
229 addPass(PM, createCondPropagationPass()); // Propagate conditionals
231 addPass(PM, createDeadStoreEliminationPass()); // Delete dead stores
232 addPass(PM, createAggressiveDCEPass()); // SSA based 'Aggressive DCE'
233 addPass(PM, createCFGSimplificationPass()); // Merge & remove BBs
234 addPass(PM, createSimplifyLibCallsPass()); // Library Call Optimizations
235 addPass(PM, createDeadTypeEliminationPass()); // Eliminate dead types
236 addPass(PM, createConstantMergePass()); // Merge dup global constants
239 } // anonymous namespace
242 //===----------------------------------------------------------------------===//
245 int main(int argc, char **argv) {
246 llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
248 cl::ParseCommandLineOptions(argc, argv,
249 " llvm .bc -> .bc modular optimizer and analysis printer \n");
250 sys::PrintStackTraceOnErrorSignal();
252 // Allocate a full target machine description only if necessary.
253 // FIXME: The choice of target should be controllable on the command line.
254 std::auto_ptr<TargetMachine> target;
256 std::string ErrorMessage;
258 // Load the input module...
259 std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename, &ErrorMessage));
261 cerr << argv[0] << ": ";
262 if (ErrorMessage.size())
263 cerr << ErrorMessage << "\n";
265 cerr << "bytecode didn't read correctly.\n";
269 // Figure out what stream we are supposed to write to...
270 // FIXME: cout is not binary!
271 std::ostream *Out = &std::cout; // Default to printing to stdout...
272 if (OutputFilename != "-") {
273 if (!Force && std::ifstream(OutputFilename.c_str())) {
274 // If force is not specified, make sure not to overwrite a file!
275 cerr << argv[0] << ": error opening '" << OutputFilename
276 << "': file exists!\n"
277 << "Use -f command line argument to force output\n";
280 std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
282 Out = new std::ofstream(OutputFilename.c_str(), io_mode);
285 cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
289 // Make sure that the Output file gets unlinked from the disk if we get a
291 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
294 // If the output is set to be emitted to standard out, and standard out is a
295 // console, print out a warning message and refuse to do it. We don't
296 // impress anyone by spewing tons of binary goo to a terminal.
297 if (!Force && !NoOutput && CheckBytecodeOutputToConsole(Out,!Quiet)) {
301 // Create a PassManager to hold and optimize the collection of passes we are
306 // Add an appropriate TargetData instance for this module...
307 Passes.add(new TargetData(M.get()));
309 // If -std-compile-opts is given, add in all the standard compilation
310 // optimizations first. This will handle -strip-debug, -disable-inline,
311 // and -disable-opt as well.
312 if (StandardCompileOpts)
313 AddStandardCompilePasses(Passes);
315 // otherwise if the -strip-debug command line option was specified, add it.
317 addPass(Passes, createStripSymbolsPass(true));
319 // Create a new optimization pass for each one specified on the command line
320 for (unsigned i = 0; i < PassList.size(); ++i) {
321 const PassInfo *PassInf = PassList[i];
323 if (PassInf->getNormalCtor())
324 P = PassInf->getNormalCtor()();
326 cerr << argv[0] << ": cannot create pass: "
327 << PassInf->getPassName() << "\n";
332 if (dynamic_cast<BasicBlockPass*>(P))
333 Passes.add(new BasicBlockPassPrinter(PassInf));
334 else if (dynamic_cast<FunctionPass*>(P))
335 Passes.add(new FunctionPassPrinter(PassInf));
337 Passes.add(new ModulePassPrinter(PassInf));
342 Passes.add(new PrintModulePass(&cerr));
345 // Check that the module is well formed on completion of optimization
346 if (!NoVerify && !VerifyEach)
347 Passes.add(createVerifierPass());
349 // Write bytecode out to disk or cout as the last step...
351 if (!NoOutput && !AnalyzeOnly)
352 Passes.add(new WriteBytecodePass(&L, false, !NoCompress));
354 // Now that we have all of the passes ready, run them.
355 Passes.run(*M.get());
359 } catch (const std::string& msg) {
360 cerr << argv[0] << ": " << msg << "\n";
362 cerr << argv[0] << ": Unexpected unknown exception occurred.\n";