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;
271 Builder.Inliner = createFunctionInliningPass();
272 Builder.populateLTOPassManager(PM);
275 //===----------------------------------------------------------------------===//
276 // CodeGen-related helper functions.
279 CodeGenOpt::Level GetCodeGenOptLevel() {
281 return CodeGenOpt::Less;
283 return CodeGenOpt::Default;
285 return CodeGenOpt::Aggressive;
286 return CodeGenOpt::None;
289 // Returns the TargetMachine instance or zero if no triple is provided.
290 static TargetMachine* GetTargetMachine(Triple TheTriple) {
292 const Target *TheTarget = TargetRegistry::lookupTarget(MArch, TheTriple,
294 // Some modules don't specify a triple, and this is okay.
299 // Package up features to be passed to target/subtarget
300 std::string FeaturesStr;
302 SubtargetFeatures Features;
303 for (unsigned i = 0; i != MAttrs.size(); ++i)
304 Features.AddFeature(MAttrs[i]);
305 FeaturesStr = Features.getString();
308 return TheTarget->createTargetMachine(TheTriple.getTriple(),
310 InitTargetOptionsFromCodeGenFlags(),
312 GetCodeGenOptLevel());
315 #ifdef LINK_POLLY_INTO_TOOLS
317 void initializePollyPasses(llvm::PassRegistry &Registry);
321 //===----------------------------------------------------------------------===//
324 int main(int argc, char **argv) {
325 sys::PrintStackTraceOnErrorSignal();
326 llvm::PrettyStackTraceProgram X(argc, argv);
328 // Enable debug stream buffering.
329 EnableDebugBuffering = true;
331 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
332 LLVMContext &Context = getGlobalContext();
334 InitializeAllTargets();
335 InitializeAllTargetMCs();
336 InitializeAllAsmPrinters();
339 PassRegistry &Registry = *PassRegistry::getPassRegistry();
340 initializeCore(Registry);
341 initializeDebugIRPass(Registry);
342 initializeScalarOpts(Registry);
343 initializeObjCARCOpts(Registry);
344 initializeVectorization(Registry);
345 initializeIPO(Registry);
346 initializeAnalysis(Registry);
347 initializeIPA(Registry);
348 initializeTransformUtils(Registry);
349 initializeInstCombine(Registry);
350 initializeInstrumentation(Registry);
351 initializeTarget(Registry);
352 // For codegen passes, only passes that do IR to IR transformation are
354 initializeCodeGenPreparePass(Registry);
355 initializeAtomicExpandLoadLinkedPass(Registry);
357 #ifdef LINK_POLLY_INTO_TOOLS
358 polly::initializePollyPasses(Registry);
361 cl::ParseCommandLineOptions(argc, argv,
362 "llvm .bc -> .bc modular optimizer and analysis printer\n");
364 if (AnalyzeOnly && NoOutput) {
365 errs() << argv[0] << ": analyze mode conflicts with no-output mode.\n";
371 // Load the input module...
372 std::unique_ptr<Module> M;
373 M.reset(ParseIRFile(InputFilename, Err, Context));
376 Err.print(argv[0], errs());
380 // If we are supposed to override the target triple, do so now.
381 if (!TargetTriple.empty())
382 M->setTargetTriple(Triple::normalize(TargetTriple));
384 // Figure out what stream we are supposed to write to...
385 std::unique_ptr<tool_output_file> Out;
387 if (!OutputFilename.empty())
388 errs() << "WARNING: The -o (output filename) option is ignored when\n"
389 "the --disable-output option is used.\n";
391 // Default to standard output.
392 if (OutputFilename.empty())
393 OutputFilename = "-";
395 std::string ErrorInfo;
396 Out.reset(new tool_output_file(OutputFilename.c_str(), ErrorInfo,
398 if (!ErrorInfo.empty()) {
399 errs() << ErrorInfo << '\n';
404 // If the output is set to be emitted to standard out, and standard out is a
405 // console, print out a warning message and refuse to do it. We don't
406 // impress anyone by spewing tons of binary goo to a terminal.
407 if (!Force && !NoOutput && !AnalyzeOnly && !OutputAssembly)
408 if (CheckBitcodeOutputToConsole(Out->os(), !Quiet))
411 if (PassPipeline.getNumOccurrences() > 0) {
412 OutputKind OK = OK_NoOutput;
414 OK = OutputAssembly ? OK_OutputAssembly : OK_OutputBitcode;
416 VerifierKind VK = VK_VerifyInAndOut;
420 VK = VK_VerifyEachPass;
422 // The user has asked to use the new pass manager and provided a pipeline
423 // string. Hand off the rest of the functionality to the new code for that
425 return runPassPipeline(argv[0], Context, *M.get(), Out.get(), PassPipeline,
431 // Create a PassManager to hold and optimize the collection of passes we are
436 // Add an appropriate TargetLibraryInfo pass for the module's triple.
437 TargetLibraryInfo *TLI = new TargetLibraryInfo(Triple(M->getTargetTriple()));
439 // The -disable-simplify-libcalls flag actually disables all builtin optzns.
440 if (DisableSimplifyLibCalls)
441 TLI->disableAllFunctions();
444 // Add an appropriate DataLayout instance for this module.
445 const DataLayout *DL = M.get()->getDataLayout();
446 if (!DL && !DefaultDataLayout.empty()) {
447 M->setDataLayout(DefaultDataLayout);
448 DL = M.get()->getDataLayout();
452 Passes.add(new DataLayoutPass(M.get()));
454 Triple ModuleTriple(M->getTargetTriple());
455 TargetMachine *Machine = nullptr;
456 if (ModuleTriple.getArch())
457 Machine = GetTargetMachine(Triple(ModuleTriple));
458 std::unique_ptr<TargetMachine> TM(Machine);
460 // Add internal analysis passes from the target machine.
462 TM->addAnalysisPasses(Passes);
464 std::unique_ptr<FunctionPassManager> FPasses;
465 if (OptLevelO1 || OptLevelO2 || OptLevelOs || OptLevelOz || OptLevelO3) {
466 FPasses.reset(new FunctionPassManager(M.get()));
468 FPasses->add(new DataLayoutPass(M.get()));
470 TM->addAnalysisPasses(*FPasses);
474 if (PrintBreakpoints) {
475 // Default to standard output.
477 if (OutputFilename.empty())
478 OutputFilename = "-";
480 std::string ErrorInfo;
481 Out.reset(new tool_output_file(OutputFilename.c_str(), ErrorInfo,
483 if (!ErrorInfo.empty()) {
484 errs() << ErrorInfo << '\n';
488 Passes.add(createBreakpointPrinter(Out->os()));
492 // If the -strip-debug command line option was specified, add it. If
493 // -std-compile-opts was also specified, it will handle StripDebug.
494 if (StripDebug && !StandardCompileOpts)
495 addPass(Passes, createStripSymbolsPass(true));
497 // Create a new optimization pass for each one specified on the command line
498 for (unsigned i = 0; i < PassList.size(); ++i) {
499 // Check to see if -std-compile-opts was specified before this option. If
501 if (StandardCompileOpts &&
502 StandardCompileOpts.getPosition() < PassList.getPosition(i)) {
503 AddStandardCompilePasses(Passes);
504 StandardCompileOpts = false;
507 if (StandardLinkOpts &&
508 StandardLinkOpts.getPosition() < PassList.getPosition(i)) {
509 AddStandardLinkPasses(Passes);
510 StandardLinkOpts = false;
513 if (OptLevelO1 && OptLevelO1.getPosition() < PassList.getPosition(i)) {
514 AddOptimizationPasses(Passes, *FPasses, 1, 0);
518 if (OptLevelO2 && OptLevelO2.getPosition() < PassList.getPosition(i)) {
519 AddOptimizationPasses(Passes, *FPasses, 2, 0);
523 if (OptLevelOs && OptLevelOs.getPosition() < PassList.getPosition(i)) {
524 AddOptimizationPasses(Passes, *FPasses, 2, 1);
528 if (OptLevelOz && OptLevelOz.getPosition() < PassList.getPosition(i)) {
529 AddOptimizationPasses(Passes, *FPasses, 2, 2);
533 if (OptLevelO3 && OptLevelO3.getPosition() < PassList.getPosition(i)) {
534 AddOptimizationPasses(Passes, *FPasses, 3, 0);
538 const PassInfo *PassInf = PassList[i];
540 if (PassInf->getTargetMachineCtor())
541 P = PassInf->getTargetMachineCtor()(TM.get());
542 else if (PassInf->getNormalCtor())
543 P = PassInf->getNormalCtor()();
545 errs() << argv[0] << ": cannot create pass: "
546 << PassInf->getPassName() << "\n";
548 PassKind Kind = P->getPassKind();
554 Passes.add(createBasicBlockPassPrinter(PassInf, Out->os(), Quiet));
557 Passes.add(createRegionPassPrinter(PassInf, Out->os(), Quiet));
560 Passes.add(createLoopPassPrinter(PassInf, Out->os(), Quiet));
563 Passes.add(createFunctionPassPrinter(PassInf, Out->os(), Quiet));
565 case PT_CallGraphSCC:
566 Passes.add(createCallGraphPassPrinter(PassInf, Out->os(), Quiet));
569 Passes.add(createModulePassPrinter(PassInf, Out->os(), Quiet));
576 Passes.add(createPrintModulePass(errs()));
579 // If -std-compile-opts was specified at the end of the pass list, add them.
580 if (StandardCompileOpts) {
581 AddStandardCompilePasses(Passes);
582 StandardCompileOpts = false;
585 if (StandardLinkOpts) {
586 AddStandardLinkPasses(Passes);
587 StandardLinkOpts = false;
591 AddOptimizationPasses(Passes, *FPasses, 1, 0);
594 AddOptimizationPasses(Passes, *FPasses, 2, 0);
597 AddOptimizationPasses(Passes, *FPasses, 2, 1);
600 AddOptimizationPasses(Passes, *FPasses, 2, 2);
603 AddOptimizationPasses(Passes, *FPasses, 3, 0);
605 if (OptLevelO1 || OptLevelO2 || OptLevelOs || OptLevelOz || OptLevelO3) {
606 FPasses->doInitialization();
607 for (Module::iterator F = M->begin(), E = M->end(); F != E; ++F)
609 FPasses->doFinalization();
612 // Check that the module is well formed on completion of optimization
613 if (!NoVerify && !VerifyEach) {
614 Passes.add(createVerifierPass());
615 Passes.add(createDebugInfoVerifierPass());
618 // Write bitcode or assembly to the output as the last step...
619 if (!NoOutput && !AnalyzeOnly) {
621 Passes.add(createPrintModulePass(Out->os()));
623 Passes.add(createBitcodeWriterPass(Out->os()));
626 // Before executing passes, print the final values of the LLVM options.
627 cl::PrintOptionValues();
629 // Now that we have all of the passes ready, run them.
630 Passes.run(*M.get());
633 if (!NoOutput || PrintBreakpoints)