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 "BreakpointPrinter.h"
16 #include "NewPMDriver.h"
17 #include "PassPrinters.h"
18 #include "llvm/ADT/Triple.h"
19 #include "llvm/Analysis/CallGraph.h"
20 #include "llvm/Analysis/CallGraphSCCPass.h"
21 #include "llvm/Analysis/LoopPass.h"
22 #include "llvm/Analysis/RegionPass.h"
23 #include "llvm/Bitcode/BitcodeWriterPass.h"
24 #include "llvm/CodeGen/CommandFlags.h"
25 #include "llvm/IR/DataLayout.h"
26 #include "llvm/IR/IRPrintingPasses.h"
27 #include "llvm/IR/LLVMContext.h"
28 #include "llvm/IR/LegacyPassNameParser.h"
29 #include "llvm/IR/Module.h"
30 #include "llvm/IR/Verifier.h"
31 #include "llvm/IRReader/IRReader.h"
32 #include "llvm/InitializePasses.h"
33 #include "llvm/LinkAllIR.h"
34 #include "llvm/LinkAllPasses.h"
35 #include "llvm/MC/SubtargetFeature.h"
36 #include "llvm/PassManager.h"
37 #include "llvm/Support/Debug.h"
38 #include "llvm/Support/FileSystem.h"
39 #include "llvm/Support/ManagedStatic.h"
40 #include "llvm/Support/PluginLoader.h"
41 #include "llvm/Support/PrettyStackTrace.h"
42 #include "llvm/Support/Signals.h"
43 #include "llvm/Support/SourceMgr.h"
44 #include "llvm/Support/SystemUtils.h"
45 #include "llvm/Support/TargetRegistry.h"
46 #include "llvm/Support/TargetSelect.h"
47 #include "llvm/Support/ToolOutputFile.h"
48 #include "llvm/Target/TargetLibraryInfo.h"
49 #include "llvm/Target/TargetMachine.h"
50 #include "llvm/Transforms/IPO/PassManagerBuilder.h"
54 using namespace opt_tool;
56 // The OptimizationList is automatically populated with registered Passes by the
59 static cl::list<const PassInfo*, bool, PassNameParser>
60 PassList(cl::desc("Optimizations available:"));
62 // This flag specifies a textual description of the optimization pass pipeline
63 // to run over the module. This flag switches opt to use the new pass manager
64 // infrastructure, completely disabling all of the flags specific to the old
66 static cl::opt<std::string> PassPipeline(
68 cl::desc("A textual description of the pass pipeline for optimizing"),
71 // Other command line options...
73 static cl::opt<std::string>
74 InputFilename(cl::Positional, cl::desc("<input bitcode file>"),
75 cl::init("-"), cl::value_desc("filename"));
77 static cl::opt<std::string>
78 OutputFilename("o", cl::desc("Override output filename"),
79 cl::value_desc("filename"));
82 Force("f", cl::desc("Enable binary output on terminals"));
85 PrintEachXForm("p", cl::desc("Print module after each transformation"));
88 NoOutput("disable-output",
89 cl::desc("Do not write result bitcode file"), cl::Hidden);
92 OutputAssembly("S", cl::desc("Write output as LLVM assembly"));
95 NoVerify("disable-verify", cl::desc("Do not verify result module"), cl::Hidden);
98 VerifyEach("verify-each", cl::desc("Verify after each transform"));
101 StripDebug("strip-debug",
102 cl::desc("Strip debugger symbol info from translation unit"));
105 DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
108 DisableOptimizations("disable-opt",
109 cl::desc("Do not run any optimization passes"));
112 StandardCompileOpts("std-compile-opts",
113 cl::desc("Include the standard compile time optimizations"));
116 StandardLinkOpts("std-link-opts",
117 cl::desc("Include the standard link time optimizations"));
121 cl::desc("Optimization level 1. Similar to clang -O1"));
125 cl::desc("Optimization level 2. Similar to clang -O2"));
129 cl::desc("Like -O2 with extra optimizations for size. Similar to clang -Os"));
133 cl::desc("Like -Os but reduces code size further. Similar to clang -Oz"));
137 cl::desc("Optimization level 3. Similar to clang -O3"));
139 static cl::opt<std::string>
140 TargetTriple("mtriple", cl::desc("Override target triple for module"));
143 UnitAtATime("funit-at-a-time",
144 cl::desc("Enable IPO. This is same as llvm-gcc's -funit-at-a-time"),
148 DisableLoopUnrolling("disable-loop-unrolling",
149 cl::desc("Disable loop unrolling in all relevant passes"),
152 DisableLoopVectorization("disable-loop-vectorization",
153 cl::desc("Disable the loop vectorization pass"),
157 DisableSLPVectorization("disable-slp-vectorization",
158 cl::desc("Disable the slp vectorization pass"),
163 DisableSimplifyLibCalls("disable-simplify-libcalls",
164 cl::desc("Disable simplify-libcalls"));
167 Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
170 QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
173 AnalyzeOnly("analyze", cl::desc("Only perform analysis, no optimization"));
176 PrintBreakpoints("print-breakpoints-for-testing",
177 cl::desc("Print select breakpoints location for testing"));
179 static cl::opt<std::string>
180 DefaultDataLayout("default-data-layout",
181 cl::desc("data layout string to use if not specified by module"),
182 cl::value_desc("layout-string"), cl::init(""));
186 static inline void addPass(PassManagerBase &PM, Pass *P) {
187 // Add the pass to the pass manager...
190 // If we are verifying all of the intermediate steps, add the verifier...
192 PM.add(createVerifierPass());
193 PM.add(createDebugInfoVerifierPass());
197 /// AddOptimizationPasses - This routine adds optimization passes
198 /// based on selected optimization level, OptLevel. This routine
199 /// duplicates llvm-gcc behaviour.
201 /// OptLevel - Optimization Level
202 static void AddOptimizationPasses(PassManagerBase &MPM,FunctionPassManager &FPM,
203 unsigned OptLevel, unsigned SizeLevel) {
204 FPM.add(createVerifierPass()); // Verify that input is correct
205 MPM.add(createDebugInfoVerifierPass()); // Verify that debug info is correct
207 PassManagerBuilder Builder;
208 Builder.OptLevel = OptLevel;
209 Builder.SizeLevel = SizeLevel;
213 } else if (OptLevel > 1) {
214 Builder.Inliner = createFunctionInliningPass(OptLevel, SizeLevel);
216 Builder.Inliner = createAlwaysInlinerPass();
218 Builder.DisableUnitAtATime = !UnitAtATime;
219 Builder.DisableUnrollLoops = (DisableLoopUnrolling.getNumOccurrences() > 0) ?
220 DisableLoopUnrolling : OptLevel == 0;
222 // This is final, unless there is a #pragma vectorize enable
223 if (DisableLoopVectorization)
224 Builder.LoopVectorize = false;
225 // If option wasn't forced via cmd line (-vectorize-loops, -loop-vectorize)
226 else if (!Builder.LoopVectorize)
227 Builder.LoopVectorize = OptLevel > 1 && SizeLevel < 2;
229 // When #pragma vectorize is on for SLP, do the same as above
230 Builder.SLPVectorize =
231 DisableSLPVectorization ? false : OptLevel > 1 && SizeLevel < 2;
233 Builder.populateFunctionPassManager(FPM);
234 Builder.populateModulePassManager(MPM);
237 static void AddStandardCompilePasses(PassManagerBase &PM) {
238 PM.add(createVerifierPass()); // Verify that input is correct
240 // If the -strip-debug command line option was specified, do it.
242 addPass(PM, createStripSymbolsPass(true));
244 // Verify debug info only after it's (possibly) stripped.
245 PM.add(createDebugInfoVerifierPass());
247 if (DisableOptimizations) return;
249 // -std-compile-opts adds the same module passes as -O3.
250 PassManagerBuilder Builder;
252 Builder.Inliner = createFunctionInliningPass();
253 Builder.OptLevel = 3;
254 Builder.populateModulePassManager(PM);
257 static void AddStandardLinkPasses(PassManagerBase &PM) {
258 PM.add(createVerifierPass()); // Verify that input is correct
260 // If the -strip-debug command line option was specified, do it.
262 addPass(PM, createStripSymbolsPass(true));
264 // Verify debug info only after it's (possibly) stripped.
265 PM.add(createDebugInfoVerifierPass());
267 if (DisableOptimizations) return;
269 PassManagerBuilder Builder;
270 Builder.populateLTOPassManager(PM, /*RunInliner=*/!DisableInline);
273 //===----------------------------------------------------------------------===//
274 // CodeGen-related helper functions.
277 CodeGenOpt::Level GetCodeGenOptLevel() {
279 return CodeGenOpt::Less;
281 return CodeGenOpt::Default;
283 return CodeGenOpt::Aggressive;
284 return CodeGenOpt::None;
287 // Returns the TargetMachine instance or zero if no triple is provided.
288 static TargetMachine* GetTargetMachine(Triple TheTriple) {
290 const Target *TheTarget = TargetRegistry::lookupTarget(MArch, TheTriple,
292 // Some modules don't specify a triple, and this is okay.
297 // Package up features to be passed to target/subtarget
298 std::string FeaturesStr;
300 SubtargetFeatures Features;
301 for (unsigned i = 0; i != MAttrs.size(); ++i)
302 Features.AddFeature(MAttrs[i]);
303 FeaturesStr = Features.getString();
306 return TheTarget->createTargetMachine(TheTriple.getTriple(),
308 InitTargetOptionsFromCodeGenFlags(),
310 GetCodeGenOptLevel());
313 #ifdef LINK_POLLY_INTO_TOOLS
315 void initializePollyPasses(llvm::PassRegistry &Registry);
319 //===----------------------------------------------------------------------===//
322 int main(int argc, char **argv) {
323 sys::PrintStackTraceOnErrorSignal();
324 llvm::PrettyStackTraceProgram X(argc, argv);
326 // Enable debug stream buffering.
327 EnableDebugBuffering = true;
329 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
330 LLVMContext &Context = getGlobalContext();
332 InitializeAllTargets();
333 InitializeAllTargetMCs();
334 InitializeAllAsmPrinters();
337 PassRegistry &Registry = *PassRegistry::getPassRegistry();
338 initializeCore(Registry);
339 initializeDebugIRPass(Registry);
340 initializeScalarOpts(Registry);
341 initializeObjCARCOpts(Registry);
342 initializeVectorization(Registry);
343 initializeIPO(Registry);
344 initializeAnalysis(Registry);
345 initializeIPA(Registry);
346 initializeTransformUtils(Registry);
347 initializeInstCombine(Registry);
348 initializeInstrumentation(Registry);
349 initializeTarget(Registry);
350 // For codegen passes, only passes that do IR to IR transformation are
352 initializeCodeGenPreparePass(Registry);
353 initializeAtomicExpandLoadLinkedPass(Registry);
355 #ifdef LINK_POLLY_INTO_TOOLS
356 polly::initializePollyPasses(Registry);
359 cl::ParseCommandLineOptions(argc, argv,
360 "llvm .bc -> .bc modular optimizer and analysis printer\n");
362 if (AnalyzeOnly && NoOutput) {
363 errs() << argv[0] << ": analyze mode conflicts with no-output mode.\n";
369 // Load the input module...
370 std::unique_ptr<Module> M;
371 M.reset(ParseIRFile(InputFilename, Err, Context));
374 Err.print(argv[0], errs());
378 // If we are supposed to override the target triple, do so now.
379 if (!TargetTriple.empty())
380 M->setTargetTriple(Triple::normalize(TargetTriple));
382 // Figure out what stream we are supposed to write to...
383 std::unique_ptr<tool_output_file> Out;
385 if (!OutputFilename.empty())
386 errs() << "WARNING: The -o (output filename) option is ignored when\n"
387 "the --disable-output option is used.\n";
389 // Default to standard output.
390 if (OutputFilename.empty())
391 OutputFilename = "-";
393 std::string ErrorInfo;
394 Out.reset(new tool_output_file(OutputFilename.c_str(), ErrorInfo,
396 if (!ErrorInfo.empty()) {
397 errs() << ErrorInfo << '\n';
402 // If the output is set to be emitted to standard out, and standard out is a
403 // console, print out a warning message and refuse to do it. We don't
404 // impress anyone by spewing tons of binary goo to a terminal.
405 if (!Force && !NoOutput && !AnalyzeOnly && !OutputAssembly)
406 if (CheckBitcodeOutputToConsole(Out->os(), !Quiet))
409 if (PassPipeline.getNumOccurrences() > 0) {
410 OutputKind OK = OK_NoOutput;
412 OK = OutputAssembly ? OK_OutputAssembly : OK_OutputBitcode;
414 VerifierKind VK = VK_VerifyInAndOut;
418 VK = VK_VerifyEachPass;
420 // The user has asked to use the new pass manager and provided a pipeline
421 // string. Hand off the rest of the functionality to the new code for that
423 return runPassPipeline(argv[0], Context, *M.get(), Out.get(), PassPipeline,
429 // Create a PassManager to hold and optimize the collection of passes we are
434 // Add an appropriate TargetLibraryInfo pass for the module's triple.
435 TargetLibraryInfo *TLI = new TargetLibraryInfo(Triple(M->getTargetTriple()));
437 // The -disable-simplify-libcalls flag actually disables all builtin optzns.
438 if (DisableSimplifyLibCalls)
439 TLI->disableAllFunctions();
442 // Add an appropriate DataLayout instance for this module.
443 const DataLayout *DL = M.get()->getDataLayout();
444 if (!DL && !DefaultDataLayout.empty()) {
445 M->setDataLayout(DefaultDataLayout);
446 DL = M.get()->getDataLayout();
450 Passes.add(new DataLayoutPass(M.get()));
452 Triple ModuleTriple(M->getTargetTriple());
453 TargetMachine *Machine = nullptr;
454 if (ModuleTriple.getArch())
455 Machine = GetTargetMachine(Triple(ModuleTriple));
456 std::unique_ptr<TargetMachine> TM(Machine);
458 // Add internal analysis passes from the target machine.
460 TM->addAnalysisPasses(Passes);
462 std::unique_ptr<FunctionPassManager> FPasses;
463 if (OptLevelO1 || OptLevelO2 || OptLevelOs || OptLevelOz || OptLevelO3) {
464 FPasses.reset(new FunctionPassManager(M.get()));
466 FPasses->add(new DataLayoutPass(M.get()));
468 TM->addAnalysisPasses(*FPasses);
472 if (PrintBreakpoints) {
473 // Default to standard output.
475 if (OutputFilename.empty())
476 OutputFilename = "-";
478 std::string ErrorInfo;
479 Out.reset(new tool_output_file(OutputFilename.c_str(), ErrorInfo,
481 if (!ErrorInfo.empty()) {
482 errs() << ErrorInfo << '\n';
486 Passes.add(createBreakpointPrinter(Out->os()));
490 // If the -strip-debug command line option was specified, add it. If
491 // -std-compile-opts was also specified, it will handle StripDebug.
492 if (StripDebug && !StandardCompileOpts)
493 addPass(Passes, createStripSymbolsPass(true));
495 // Create a new optimization pass for each one specified on the command line
496 for (unsigned i = 0; i < PassList.size(); ++i) {
497 // Check to see if -std-compile-opts was specified before this option. If
499 if (StandardCompileOpts &&
500 StandardCompileOpts.getPosition() < PassList.getPosition(i)) {
501 AddStandardCompilePasses(Passes);
502 StandardCompileOpts = false;
505 if (StandardLinkOpts &&
506 StandardLinkOpts.getPosition() < PassList.getPosition(i)) {
507 AddStandardLinkPasses(Passes);
508 StandardLinkOpts = false;
511 if (OptLevelO1 && OptLevelO1.getPosition() < PassList.getPosition(i)) {
512 AddOptimizationPasses(Passes, *FPasses, 1, 0);
516 if (OptLevelO2 && OptLevelO2.getPosition() < PassList.getPosition(i)) {
517 AddOptimizationPasses(Passes, *FPasses, 2, 0);
521 if (OptLevelOs && OptLevelOs.getPosition() < PassList.getPosition(i)) {
522 AddOptimizationPasses(Passes, *FPasses, 2, 1);
526 if (OptLevelOz && OptLevelOz.getPosition() < PassList.getPosition(i)) {
527 AddOptimizationPasses(Passes, *FPasses, 2, 2);
531 if (OptLevelO3 && OptLevelO3.getPosition() < PassList.getPosition(i)) {
532 AddOptimizationPasses(Passes, *FPasses, 3, 0);
536 const PassInfo *PassInf = PassList[i];
538 if (PassInf->getTargetMachineCtor())
539 P = PassInf->getTargetMachineCtor()(TM.get());
540 else if (PassInf->getNormalCtor())
541 P = PassInf->getNormalCtor()();
543 errs() << argv[0] << ": cannot create pass: "
544 << PassInf->getPassName() << "\n";
546 PassKind Kind = P->getPassKind();
552 Passes.add(createBasicBlockPassPrinter(PassInf, Out->os(), Quiet));
555 Passes.add(createRegionPassPrinter(PassInf, Out->os(), Quiet));
558 Passes.add(createLoopPassPrinter(PassInf, Out->os(), Quiet));
561 Passes.add(createFunctionPassPrinter(PassInf, Out->os(), Quiet));
563 case PT_CallGraphSCC:
564 Passes.add(createCallGraphPassPrinter(PassInf, Out->os(), Quiet));
567 Passes.add(createModulePassPrinter(PassInf, Out->os(), Quiet));
574 Passes.add(createPrintModulePass(errs()));
577 // If -std-compile-opts was specified at the end of the pass list, add them.
578 if (StandardCompileOpts) {
579 AddStandardCompilePasses(Passes);
580 StandardCompileOpts = false;
583 if (StandardLinkOpts) {
584 AddStandardLinkPasses(Passes);
585 StandardLinkOpts = false;
589 AddOptimizationPasses(Passes, *FPasses, 1, 0);
592 AddOptimizationPasses(Passes, *FPasses, 2, 0);
595 AddOptimizationPasses(Passes, *FPasses, 2, 1);
598 AddOptimizationPasses(Passes, *FPasses, 2, 2);
601 AddOptimizationPasses(Passes, *FPasses, 3, 0);
603 if (OptLevelO1 || OptLevelO2 || OptLevelOs || OptLevelOz || OptLevelO3) {
604 FPasses->doInitialization();
605 for (Module::iterator F = M->begin(), E = M->end(); F != E; ++F)
607 FPasses->doFinalization();
610 // Check that the module is well formed on completion of optimization
611 if (!NoVerify && !VerifyEach) {
612 Passes.add(createVerifierPass());
613 Passes.add(createDebugInfoVerifierPass());
616 // Write bitcode or assembly to the output as the last step...
617 if (!NoOutput && !AnalyzeOnly) {
619 Passes.add(createPrintModulePass(Out->os()));
621 Passes.add(createBitcodeWriterPass(Out->os()));
624 // Before executing passes, print the final values of the LLVM options.
625 cl::PrintOptionValues();
627 // Now that we have all of the passes ready, run them.
628 Passes.run(*M.get());
631 if (!NoOutput || PrintBreakpoints)