1 //===- opt.cpp - The LLVM Modular Optimizer -------------------------------===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // Optimizations may be specified an arbitrary number of times on the command
10 // line, They are run in the order specified.
12 //===----------------------------------------------------------------------===//
14 #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/Analysis/TargetLibraryInfo.h"
24 #include "llvm/Analysis/TargetTransformInfo.h"
25 #include "llvm/Bitcode/BitcodeWriterPass.h"
26 #include "llvm/CodeGen/CommandFlags.inc"
27 #include "llvm/CodeGen/TargetPassConfig.h"
28 #include "llvm/Config/llvm-config.h"
29 #include "llvm/IR/DataLayout.h"
30 #include "llvm/IR/DebugInfo.h"
31 #include "llvm/IR/IRPrintingPasses.h"
32 #include "llvm/IR/LLVMContext.h"
33 #include "llvm/IR/LegacyPassManager.h"
34 #include "llvm/IR/LegacyPassNameParser.h"
35 #include "llvm/IR/Module.h"
36 #include "llvm/IR/RemarkStreamer.h"
37 #include "llvm/IR/Verifier.h"
38 #include "llvm/IRReader/IRReader.h"
39 #include "llvm/InitializePasses.h"
40 #include "llvm/LinkAllIR.h"
41 #include "llvm/LinkAllPasses.h"
42 #include "llvm/MC/SubtargetFeature.h"
43 #include "llvm/Support/Debug.h"
44 #include "llvm/Support/FileSystem.h"
45 #include "llvm/Support/Host.h"
46 #include "llvm/Support/InitLLVM.h"
47 #include "llvm/Support/PluginLoader.h"
48 #include "llvm/Support/SourceMgr.h"
49 #include "llvm/Support/SystemUtils.h"
50 #include "llvm/Support/TargetRegistry.h"
51 #include "llvm/Support/TargetSelect.h"
52 #include "llvm/Support/ToolOutputFile.h"
53 #include "llvm/Support/YAMLTraits.h"
54 #include "llvm/Target/TargetMachine.h"
55 #include "llvm/Transforms/Coroutines.h"
56 #include "llvm/Transforms/IPO/AlwaysInliner.h"
57 #include "llvm/Transforms/IPO/PassManagerBuilder.h"
58 #include "llvm/Transforms/Utils/Cloning.h"
62 using namespace opt_tool;
64 // The OptimizationList is automatically populated with registered Passes by the
67 static cl::list<const PassInfo*, bool, PassNameParser>
68 PassList(cl::desc("Optimizations available:"));
70 // This flag specifies a textual description of the optimization pass pipeline
71 // to run over the module. This flag switches opt to use the new pass manager
72 // infrastructure, completely disabling all of the flags specific to the old
74 static cl::opt<std::string> PassPipeline(
76 cl::desc("A textual description of the pass pipeline for optimizing"),
79 // Other command line options...
81 static cl::opt<std::string>
82 InputFilename(cl::Positional, cl::desc("<input bitcode file>"),
83 cl::init("-"), cl::value_desc("filename"));
85 static cl::opt<std::string>
86 OutputFilename("o", cl::desc("Override output filename"),
87 cl::value_desc("filename"));
90 Force("f", cl::desc("Enable binary output on terminals"));
93 PrintEachXForm("p", cl::desc("Print module after each transformation"));
96 NoOutput("disable-output",
97 cl::desc("Do not write result bitcode file"), cl::Hidden);
100 OutputAssembly("S", cl::desc("Write output as LLVM assembly"));
103 OutputThinLTOBC("thinlto-bc",
104 cl::desc("Write output as ThinLTO-ready bitcode"));
107 SplitLTOUnit("thinlto-split-lto-unit",
108 cl::desc("Enable splitting of a ThinLTO LTOUnit"));
110 static cl::opt<std::string> ThinLinkBitcodeFile(
111 "thin-link-bitcode-file", cl::value_desc("filename"),
113 "A file in which to write minimized bitcode for the thin link only"));
116 NoVerify("disable-verify", cl::desc("Do not run the verifier"), cl::Hidden);
119 VerifyEach("verify-each", cl::desc("Verify after each transform"));
122 DisableDITypeMap("disable-debug-info-type-map",
123 cl::desc("Don't use a uniquing type map for debug info"));
126 StripDebug("strip-debug",
127 cl::desc("Strip debugger symbol info from translation unit"));
130 StripNamedMetadata("strip-named-metadata",
131 cl::desc("Strip module-level named metadata"));
133 static cl::opt<bool> DisableInline("disable-inlining",
134 cl::desc("Do not run the inliner pass"));
137 DisableOptimizations("disable-opt",
138 cl::desc("Do not run any optimization passes"));
141 StandardLinkOpts("std-link-opts",
142 cl::desc("Include the standard link time optimizations"));
146 cl::desc("Optimization level 0. Similar to clang -O0"));
150 cl::desc("Optimization level 1. Similar to clang -O1"));
154 cl::desc("Optimization level 2. Similar to clang -O2"));
158 cl::desc("Like -O2 with extra optimizations for size. Similar to clang -Os"));
162 cl::desc("Like -Os but reduces code size further. Similar to clang -Oz"));
166 cl::desc("Optimization level 3. Similar to clang -O3"));
168 static cl::opt<unsigned>
169 CodeGenOptLevel("codegen-opt-level",
170 cl::desc("Override optimization level for codegen hooks"));
172 static cl::opt<std::string>
173 TargetTriple("mtriple", cl::desc("Override target triple for module"));
176 DisableLoopUnrolling("disable-loop-unrolling",
177 cl::desc("Disable loop unrolling in all relevant passes"),
181 DisableSLPVectorization("disable-slp-vectorization",
182 cl::desc("Disable the slp vectorization pass"),
185 static cl::opt<bool> EmitSummaryIndex("module-summary",
186 cl::desc("Emit module summary index"),
189 static cl::opt<bool> EmitModuleHash("module-hash", cl::desc("Emit module hash"),
193 DisableSimplifyLibCalls("disable-simplify-libcalls",
194 cl::desc("Disable simplify-libcalls"));
197 Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
200 QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
203 AnalyzeOnly("analyze", cl::desc("Only perform analysis, no optimization"));
205 static cl::opt<bool> EnableDebugify(
208 "Start the pipeline with debugify and end it with check-debugify"));
210 static cl::opt<bool> DebugifyEach(
213 "Start each pass with debugify and end it with check-debugify"));
215 static cl::opt<std::string>
216 DebugifyExport("debugify-export",
217 cl::desc("Export per-pass debugify statistics to this file"),
218 cl::value_desc("filename"), cl::init(""));
221 PrintBreakpoints("print-breakpoints-for-testing",
222 cl::desc("Print select breakpoints location for testing"));
224 static cl::opt<std::string> ClDataLayout("data-layout",
225 cl::desc("data layout string to use"),
226 cl::value_desc("layout-string"),
229 static cl::opt<bool> PreserveBitcodeUseListOrder(
230 "preserve-bc-uselistorder",
231 cl::desc("Preserve use-list order when writing LLVM bitcode."),
232 cl::init(true), cl::Hidden);
234 static cl::opt<bool> PreserveAssemblyUseListOrder(
235 "preserve-ll-uselistorder",
236 cl::desc("Preserve use-list order when writing LLVM assembly."),
237 cl::init(false), cl::Hidden);
240 RunTwice("run-twice",
241 cl::desc("Run all passes twice, re-using the same pass manager."),
242 cl::init(false), cl::Hidden);
244 static cl::opt<bool> DiscardValueNames(
245 "discard-value-names",
246 cl::desc("Discard names from Value (other than GlobalValue)."),
247 cl::init(false), cl::Hidden);
249 static cl::opt<bool> Coroutines(
251 cl::desc("Enable coroutine passes."),
252 cl::init(false), cl::Hidden);
254 static cl::opt<bool> RemarksWithHotness(
255 "pass-remarks-with-hotness",
256 cl::desc("With PGO, include profile count in optimization remarks"),
259 static cl::opt<unsigned>
260 RemarksHotnessThreshold("pass-remarks-hotness-threshold",
261 cl::desc("Minimum profile count required for "
262 "an optimization remark to be output"),
265 static cl::opt<std::string>
266 RemarksFilename("pass-remarks-output",
267 cl::desc("Output filename for pass remarks"),
268 cl::value_desc("filename"));
270 static cl::opt<std::string>
271 RemarksPasses("pass-remarks-filter",
272 cl::desc("Only record optimization remarks from passes whose "
273 "names match the given regular expression"),
274 cl::value_desc("regex"));
276 static cl::opt<std::string> RemarksFormat(
277 "pass-remarks-format",
278 cl::desc("The format used for serializing remarks (default: YAML)"),
279 cl::value_desc("format"), cl::init("yaml"));
282 PGOKindFlag("pgo-kind", cl::init(NoPGO), cl::Hidden,
283 cl::desc("The kind of profile guided optimization"),
284 cl::values(clEnumValN(NoPGO, "nopgo", "Do not use PGO."),
285 clEnumValN(InstrGen, "pgo-instr-gen-pipeline",
286 "Instrument the IR to generate profile."),
287 clEnumValN(InstrUse, "pgo-instr-use-pipeline",
288 "Use instrumented profile to guide PGO."),
289 clEnumValN(SampleUse, "pgo-sample-use-pipeline",
290 "Use sampled profile to guide PGO.")));
291 cl::opt<std::string> ProfileFile("profile-file",
292 cl::desc("Path to the profile."), cl::Hidden);
294 cl::opt<CSPGOKind> CSPGOKindFlag(
295 "cspgo-kind", cl::init(NoCSPGO), cl::Hidden,
296 cl::desc("The kind of context sensitive profile guided optimization"),
298 clEnumValN(NoCSPGO, "nocspgo", "Do not use CSPGO."),
300 CSInstrGen, "cspgo-instr-gen-pipeline",
301 "Instrument (context sensitive) the IR to generate profile."),
303 CSInstrUse, "cspgo-instr-use-pipeline",
304 "Use instrumented (context sensitive) profile to guide PGO.")));
305 cl::opt<std::string> CSProfileGenFile(
306 "cs-profilegen-file",
307 cl::desc("Path to the instrumented context sensitive profile."),
310 class OptCustomPassManager : public legacy::PassManager {
311 DebugifyStatsMap DIStatsMap;
314 using super = legacy::PassManager;
316 void add(Pass *P) override {
317 // Wrap each pass with (-check)-debugify passes if requested, making
318 // exceptions for passes which shouldn't see -debugify instrumentation.
319 bool WrapWithDebugify = DebugifyEach && !P->getAsImmutablePass() &&
320 !isIRPrintingPass(P) && !isBitcodeWriterPass(P);
321 if (!WrapWithDebugify) {
326 // Apply -debugify/-check-debugify before/after each pass and collect
327 // debug info loss statistics.
328 PassKind Kind = P->getPassKind();
329 StringRef Name = P->getPassName();
331 // TODO: Implement Debugify for BasicBlockPass, LoopPass.
334 super::add(createDebugifyFunctionPass());
336 super::add(createCheckDebugifyFunctionPass(true, Name, &DIStatsMap));
339 super::add(createDebugifyModulePass());
341 super::add(createCheckDebugifyModulePass(true, Name, &DIStatsMap));
349 const DebugifyStatsMap &getDebugifyStatsMap() const { return DIStatsMap; }
352 static inline void addPass(legacy::PassManagerBase &PM, Pass *P) {
353 // Add the pass to the pass manager...
356 // If we are verifying all of the intermediate steps, add the verifier...
358 PM.add(createVerifierPass());
361 /// This routine adds optimization passes based on selected optimization level,
364 /// OptLevel - Optimization Level
365 static void AddOptimizationPasses(legacy::PassManagerBase &MPM,
366 legacy::FunctionPassManager &FPM,
367 TargetMachine *TM, unsigned OptLevel,
368 unsigned SizeLevel) {
369 if (!NoVerify || VerifyEach)
370 FPM.add(createVerifierPass()); // Verify that input is correct
372 PassManagerBuilder Builder;
373 Builder.OptLevel = OptLevel;
374 Builder.SizeLevel = SizeLevel;
378 } else if (OptLevel > 1) {
379 Builder.Inliner = createFunctionInliningPass(OptLevel, SizeLevel, false);
381 Builder.Inliner = createAlwaysInlinerLegacyPass();
383 Builder.DisableUnrollLoops = (DisableLoopUnrolling.getNumOccurrences() > 0) ?
384 DisableLoopUnrolling : OptLevel == 0;
386 // Check if vectorization is explicitly disabled via -vectorize-loops=false.
387 // The flag enables vectorization in the LoopVectorize pass, it is on by
388 // default, and if it was disabled, leave it disabled here.
389 // Another flag that exists: -loop-vectorize, controls adding the pass to the
390 // pass manager. If set, the pass is added, and there is no additional check
392 if (Builder.LoopVectorize)
393 Builder.LoopVectorize = OptLevel > 1 && SizeLevel < 2;
395 // When #pragma vectorize is on for SLP, do the same as above
396 Builder.SLPVectorize =
397 DisableSLPVectorization ? false : OptLevel > 1 && SizeLevel < 2;
400 TM->adjustPassManager(Builder);
403 addCoroutinePassesToExtensionPoints(Builder);
405 switch (PGOKindFlag) {
407 Builder.EnablePGOInstrGen = true;
408 Builder.PGOInstrGen = ProfileFile;
411 Builder.PGOInstrUse = ProfileFile;
414 Builder.PGOSampleUse = ProfileFile;
420 switch (CSPGOKindFlag) {
422 Builder.EnablePGOCSInstrGen = true;
425 Builder.EnablePGOCSInstrUse = true;
431 Builder.populateFunctionPassManager(FPM);
432 Builder.populateModulePassManager(MPM);
435 static void AddStandardLinkPasses(legacy::PassManagerBase &PM) {
436 PassManagerBuilder Builder;
437 Builder.VerifyInput = true;
438 if (DisableOptimizations)
439 Builder.OptLevel = 0;
442 Builder.Inliner = createFunctionInliningPass();
443 Builder.populateLTOPassManager(PM);
446 //===----------------------------------------------------------------------===//
447 // CodeGen-related helper functions.
450 static CodeGenOpt::Level GetCodeGenOptLevel() {
451 if (CodeGenOptLevel.getNumOccurrences())
452 return static_cast<CodeGenOpt::Level>(unsigned(CodeGenOptLevel));
454 return CodeGenOpt::Less;
456 return CodeGenOpt::Default;
458 return CodeGenOpt::Aggressive;
459 return CodeGenOpt::None;
462 // Returns the TargetMachine instance or zero if no triple is provided.
463 static TargetMachine* GetTargetMachine(Triple TheTriple, StringRef CPUStr,
464 StringRef FeaturesStr,
465 const TargetOptions &Options) {
467 const Target *TheTarget = TargetRegistry::lookupTarget(MArch, TheTriple,
469 // Some modules don't specify a triple, and this is okay.
474 return TheTarget->createTargetMachine(TheTriple.getTriple(), CPUStr,
475 FeaturesStr, Options, getRelocModel(),
476 getCodeModel(), GetCodeGenOptLevel());
479 #ifdef LINK_POLLY_INTO_TOOLS
481 void initializePollyPasses(llvm::PassRegistry &Registry);
485 //===----------------------------------------------------------------------===//
488 int main(int argc, char **argv) {
489 InitLLVM X(argc, argv);
491 // Enable debug stream buffering.
492 EnableDebugBuffering = true;
496 InitializeAllTargets();
497 InitializeAllTargetMCs();
498 InitializeAllAsmPrinters();
499 InitializeAllAsmParsers();
502 PassRegistry &Registry = *PassRegistry::getPassRegistry();
503 initializeCore(Registry);
504 initializeCoroutines(Registry);
505 initializeScalarOpts(Registry);
506 initializeObjCARCOpts(Registry);
507 initializeVectorization(Registry);
508 initializeIPO(Registry);
509 initializeAnalysis(Registry);
510 initializeTransformUtils(Registry);
511 initializeInstCombine(Registry);
512 initializeAggressiveInstCombine(Registry);
513 initializeInstrumentation(Registry);
514 initializeTarget(Registry);
515 // For codegen passes, only passes that do IR to IR transformation are
517 initializeExpandMemCmpPassPass(Registry);
518 initializeScalarizeMaskedMemIntrinPass(Registry);
519 initializeCodeGenPreparePass(Registry);
520 initializeAtomicExpandPass(Registry);
521 initializeRewriteSymbolsLegacyPassPass(Registry);
522 initializeWinEHPreparePass(Registry);
523 initializeDwarfEHPreparePass(Registry);
524 initializeSafeStackLegacyPassPass(Registry);
525 initializeSjLjEHPreparePass(Registry);
526 initializeStackProtectorPass(Registry);
527 initializePreISelIntrinsicLoweringLegacyPassPass(Registry);
528 initializeGlobalMergePass(Registry);
529 initializeIndirectBrExpandPassPass(Registry);
530 initializeInterleavedLoadCombinePass(Registry);
531 initializeInterleavedAccessPass(Registry);
532 initializeEntryExitInstrumenterPass(Registry);
533 initializePostInlineEntryExitInstrumenterPass(Registry);
534 initializeUnreachableBlockElimLegacyPassPass(Registry);
535 initializeExpandReductionsPass(Registry);
536 initializeWasmEHPreparePass(Registry);
537 initializeWriteBitcodePassPass(Registry);
538 initializeHardwareLoopsPass(Registry);
540 #ifdef LINK_POLLY_INTO_TOOLS
541 polly::initializePollyPasses(Registry);
544 cl::ParseCommandLineOptions(argc, argv,
545 "llvm .bc -> .bc modular optimizer and analysis printer\n");
547 if (AnalyzeOnly && NoOutput) {
548 errs() << argv[0] << ": analyze mode conflicts with no-output mode.\n";
554 Context.setDiscardValueNames(DiscardValueNames);
555 if (!DisableDITypeMap)
556 Context.enableDebugTypeODRUniquing();
558 Expected<std::unique_ptr<ToolOutputFile>> RemarksFileOrErr =
559 setupOptimizationRemarks(Context, RemarksFilename, RemarksPasses,
560 RemarksFormat, RemarksWithHotness,
561 RemarksHotnessThreshold);
562 if (Error E = RemarksFileOrErr.takeError()) {
563 errs() << toString(std::move(E)) << '\n';
566 std::unique_ptr<ToolOutputFile> RemarksFile = std::move(*RemarksFileOrErr);
568 // Load the input module...
569 std::unique_ptr<Module> M =
570 parseIRFile(InputFilename, Err, Context, !NoVerify, ClDataLayout);
573 Err.print(argv[0], errs());
577 // Strip debug info before running the verifier.
581 // Erase module-level named metadata, if requested.
582 if (StripNamedMetadata) {
583 while (!M->named_metadata_empty()) {
584 NamedMDNode *NMD = &*M->named_metadata_begin();
585 M->eraseNamedMetadata(NMD);
589 // If we are supposed to override the target triple or data layout, do so now.
590 if (!TargetTriple.empty())
591 M->setTargetTriple(Triple::normalize(TargetTriple));
593 // Immediately run the verifier to catch any problems before starting up the
594 // pass pipelines. Otherwise we can crash on broken code during
595 // doInitialization().
596 if (!NoVerify && verifyModule(*M, &errs())) {
597 errs() << argv[0] << ": " << InputFilename
598 << ": error: input module is broken!\n";
602 // Figure out what stream we are supposed to write to...
603 std::unique_ptr<ToolOutputFile> Out;
604 std::unique_ptr<ToolOutputFile> ThinLinkOut;
606 if (!OutputFilename.empty())
607 errs() << "WARNING: The -o (output filename) option is ignored when\n"
608 "the --disable-output option is used.\n";
610 // Default to standard output.
611 if (OutputFilename.empty())
612 OutputFilename = "-";
615 Out.reset(new ToolOutputFile(OutputFilename, EC, sys::fs::F_None));
617 errs() << EC.message() << '\n';
621 if (!ThinLinkBitcodeFile.empty()) {
623 new ToolOutputFile(ThinLinkBitcodeFile, EC, sys::fs::F_None));
625 errs() << EC.message() << '\n';
631 Triple ModuleTriple(M->getTargetTriple());
632 std::string CPUStr, FeaturesStr;
633 TargetMachine *Machine = nullptr;
634 const TargetOptions Options = InitTargetOptionsFromCodeGenFlags();
636 if (ModuleTriple.getArch()) {
637 CPUStr = getCPUStr();
638 FeaturesStr = getFeaturesStr();
639 Machine = GetTargetMachine(ModuleTriple, CPUStr, FeaturesStr, Options);
640 } else if (ModuleTriple.getArchName() != "unknown" &&
641 ModuleTriple.getArchName() != "") {
642 errs() << argv[0] << ": unrecognized architecture '"
643 << ModuleTriple.getArchName() << "' provided.\n";
647 std::unique_ptr<TargetMachine> TM(Machine);
649 // Override function attributes based on CPUStr, FeaturesStr, and command line
651 setFunctionAttributes(CPUStr, FeaturesStr, *M);
653 // If the output is set to be emitted to standard out, and standard out is a
654 // console, print out a warning message and refuse to do it. We don't
655 // impress anyone by spewing tons of binary goo to a terminal.
656 if (!Force && !NoOutput && !AnalyzeOnly && !OutputAssembly)
657 if (CheckBitcodeOutputToConsole(Out->os(), !Quiet))
661 M->addModuleFlag(Module::Error, "EnableSplitLTOUnit", SplitLTOUnit);
663 if (PassPipeline.getNumOccurrences() > 0) {
664 OutputKind OK = OK_NoOutput;
668 : (OutputThinLTOBC ? OK_OutputThinLTOBitcode : OK_OutputBitcode);
670 VerifierKind VK = VK_VerifyInAndOut;
674 VK = VK_VerifyEachPass;
676 // The user has asked to use the new pass manager and provided a pipeline
677 // string. Hand off the rest of the functionality to the new code for that
679 return runPassPipeline(argv[0], *M, TM.get(), Out.get(), ThinLinkOut.get(),
680 RemarksFile.get(), PassPipeline, OK, VK,
681 PreserveAssemblyUseListOrder,
682 PreserveBitcodeUseListOrder, EmitSummaryIndex,
683 EmitModuleHash, EnableDebugify)
688 // Create a PassManager to hold and optimize the collection of passes we are
690 OptCustomPassManager Passes;
691 bool AddOneTimeDebugifyPasses = EnableDebugify && !DebugifyEach;
693 // Add an appropriate TargetLibraryInfo pass for the module's triple.
694 TargetLibraryInfoImpl TLII(ModuleTriple);
696 // The -disable-simplify-libcalls flag actually disables all builtin optzns.
697 if (DisableSimplifyLibCalls)
698 TLII.disableAllFunctions();
699 Passes.add(new TargetLibraryInfoWrapperPass(TLII));
701 // Add internal analysis passes from the target machine.
702 Passes.add(createTargetTransformInfoWrapperPass(TM ? TM->getTargetIRAnalysis()
703 : TargetIRAnalysis()));
705 if (AddOneTimeDebugifyPasses)
706 Passes.add(createDebugifyModulePass());
708 std::unique_ptr<legacy::FunctionPassManager> FPasses;
709 if (OptLevelO0 || OptLevelO1 || OptLevelO2 || OptLevelOs || OptLevelOz ||
711 FPasses.reset(new legacy::FunctionPassManager(M.get()));
712 FPasses->add(createTargetTransformInfoWrapperPass(
713 TM ? TM->getTargetIRAnalysis() : TargetIRAnalysis()));
716 if (PrintBreakpoints) {
717 // Default to standard output.
719 if (OutputFilename.empty())
720 OutputFilename = "-";
723 Out = llvm::make_unique<ToolOutputFile>(OutputFilename, EC,
726 errs() << EC.message() << '\n';
730 Passes.add(createBreakpointPrinter(Out->os()));
735 // FIXME: We should dyn_cast this when supported.
736 auto <M = static_cast<LLVMTargetMachine &>(*TM);
737 Pass *TPC = LTM.createPassConfig(Passes);
741 // Create a new optimization pass for each one specified on the command line
742 for (unsigned i = 0; i < PassList.size(); ++i) {
743 if (StandardLinkOpts &&
744 StandardLinkOpts.getPosition() < PassList.getPosition(i)) {
745 AddStandardLinkPasses(Passes);
746 StandardLinkOpts = false;
749 if (OptLevelO0 && OptLevelO0.getPosition() < PassList.getPosition(i)) {
750 AddOptimizationPasses(Passes, *FPasses, TM.get(), 0, 0);
754 if (OptLevelO1 && OptLevelO1.getPosition() < PassList.getPosition(i)) {
755 AddOptimizationPasses(Passes, *FPasses, TM.get(), 1, 0);
759 if (OptLevelO2 && OptLevelO2.getPosition() < PassList.getPosition(i)) {
760 AddOptimizationPasses(Passes, *FPasses, TM.get(), 2, 0);
764 if (OptLevelOs && OptLevelOs.getPosition() < PassList.getPosition(i)) {
765 AddOptimizationPasses(Passes, *FPasses, TM.get(), 2, 1);
769 if (OptLevelOz && OptLevelOz.getPosition() < PassList.getPosition(i)) {
770 AddOptimizationPasses(Passes, *FPasses, TM.get(), 2, 2);
774 if (OptLevelO3 && OptLevelO3.getPosition() < PassList.getPosition(i)) {
775 AddOptimizationPasses(Passes, *FPasses, TM.get(), 3, 0);
779 const PassInfo *PassInf = PassList[i];
781 if (PassInf->getNormalCtor())
782 P = PassInf->getNormalCtor()();
784 errs() << argv[0] << ": cannot create pass: "
785 << PassInf->getPassName() << "\n";
787 PassKind Kind = P->getPassKind();
793 Passes.add(createBasicBlockPassPrinter(PassInf, Out->os(), Quiet));
796 Passes.add(createRegionPassPrinter(PassInf, Out->os(), Quiet));
799 Passes.add(createLoopPassPrinter(PassInf, Out->os(), Quiet));
802 Passes.add(createFunctionPassPrinter(PassInf, Out->os(), Quiet));
804 case PT_CallGraphSCC:
805 Passes.add(createCallGraphPassPrinter(PassInf, Out->os(), Quiet));
808 Passes.add(createModulePassPrinter(PassInf, Out->os(), Quiet));
816 createPrintModulePass(errs(), "", PreserveAssemblyUseListOrder));
819 if (StandardLinkOpts) {
820 AddStandardLinkPasses(Passes);
821 StandardLinkOpts = false;
825 AddOptimizationPasses(Passes, *FPasses, TM.get(), 0, 0);
828 AddOptimizationPasses(Passes, *FPasses, TM.get(), 1, 0);
831 AddOptimizationPasses(Passes, *FPasses, TM.get(), 2, 0);
834 AddOptimizationPasses(Passes, *FPasses, TM.get(), 2, 1);
837 AddOptimizationPasses(Passes, *FPasses, TM.get(), 2, 2);
840 AddOptimizationPasses(Passes, *FPasses, TM.get(), 3, 0);
843 FPasses->doInitialization();
844 for (Function &F : *M)
846 FPasses->doFinalization();
849 // Check that the module is well formed on completion of optimization
850 if (!NoVerify && !VerifyEach)
851 Passes.add(createVerifierPass());
853 if (AddOneTimeDebugifyPasses)
854 Passes.add(createCheckDebugifyModulePass(false));
856 // In run twice mode, we want to make sure the output is bit-by-bit
857 // equivalent if we run the pass manager again, so setup two buffers and
858 // a stream to write to them. Note that llc does something similar and it
859 // may be worth to abstract this out in the future.
860 SmallVector<char, 0> Buffer;
861 SmallVector<char, 0> FirstRunBuffer;
862 std::unique_ptr<raw_svector_ostream> BOS;
863 raw_ostream *OS = nullptr;
865 // Write bitcode or assembly to the output as the last step...
866 if (!NoOutput && !AnalyzeOnly) {
870 BOS = make_unique<raw_svector_ostream>(Buffer);
873 if (OutputAssembly) {
874 if (EmitSummaryIndex)
875 report_fatal_error("Text output is incompatible with -module-summary");
877 report_fatal_error("Text output is incompatible with -module-hash");
878 Passes.add(createPrintModulePass(*OS, "", PreserveAssemblyUseListOrder));
879 } else if (OutputThinLTOBC)
880 Passes.add(createWriteThinLTOBitcodePass(
881 *OS, ThinLinkOut ? &ThinLinkOut->os() : nullptr));
883 Passes.add(createBitcodeWriterPass(*OS, PreserveBitcodeUseListOrder,
884 EmitSummaryIndex, EmitModuleHash));
887 // Before executing passes, print the final values of the LLVM options.
888 cl::PrintOptionValues();
891 // Now that we have all of the passes ready, run them.
894 // If requested, run all passes twice with the same pass manager to catch
895 // bugs caused by persistent state in the passes.
896 std::unique_ptr<Module> M2(CloneModule(*M));
897 // Run all passes on the original module first, so the second run processes
898 // the clone to catch CloneModule bugs.
900 FirstRunBuffer = Buffer;
905 // Compare the two outputs and make sure they're the same
907 if (Buffer.size() != FirstRunBuffer.size() ||
908 (memcmp(Buffer.data(), FirstRunBuffer.data(), Buffer.size()) != 0)) {
910 << "Running the pass manager twice changed the output.\n"
911 "Writing the result of the second run to the specified output.\n"
912 "To generate the one-run comparison binary, just run without\n"
913 "the compile-twice option\n";
914 Out->os() << BOS->str();
920 Out->os() << BOS->str();
923 if (DebugifyEach && !DebugifyExport.empty())
924 exportDebugifyStats(DebugifyExport, Passes.getDebugifyStatsMap());
927 if (!NoOutput || PrintBreakpoints)