1 //===- PassManagerBuilder.cpp - Build Standard Pass -----------------------===// 2 // 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 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // This file defines the PassManagerBuilder class, which is used to set up a 10 // "standard" optimization sequence suitable for languages like C and C++. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "llvm/Transforms/IPO/PassManagerBuilder.h" 15 #include "llvm-c/Transforms/PassManagerBuilder.h" 16 #include "llvm/ADT/STLExtras.h" 17 #include "llvm/ADT/SmallVector.h" 18 #include "llvm/Analysis/BasicAliasAnalysis.h" 19 #include "llvm/Analysis/CFLAndersAliasAnalysis.h" 20 #include "llvm/Analysis/CFLSteensAliasAnalysis.h" 21 #include "llvm/Analysis/GlobalsModRef.h" 22 #include "llvm/Analysis/InlineCost.h" 23 #include "llvm/Analysis/Passes.h" 24 #include "llvm/Analysis/ScopedNoAliasAA.h" 25 #include "llvm/Analysis/TargetLibraryInfo.h" 26 #include "llvm/Analysis/TypeBasedAliasAnalysis.h" 27 #include "llvm/IR/DataLayout.h" 28 #include "llvm/IR/LegacyPassManager.h" 29 #include "llvm/IR/Verifier.h" 30 #include "llvm/Support/CommandLine.h" 31 #include "llvm/Support/ManagedStatic.h" 32 #include "llvm/Transforms/AggressiveInstCombine/AggressiveInstCombine.h" 33 #include "llvm/Transforms/IPO.h" 34 #include "llvm/Transforms/IPO/Attributor.h" 35 #include "llvm/Transforms/IPO/ForceFunctionAttrs.h" 36 #include "llvm/Transforms/IPO/FunctionAttrs.h" 37 #include "llvm/Transforms/IPO/InferFunctionAttrs.h" 38 #include "llvm/Transforms/InstCombine/InstCombine.h" 39 #include "llvm/Transforms/Instrumentation.h" 40 #include "llvm/Transforms/Scalar.h" 41 #include "llvm/Transforms/Scalar/GVN.h" 42 #include "llvm/Transforms/Scalar/InstSimplifyPass.h" 43 #include "llvm/Transforms/Scalar/LICM.h" 44 #include "llvm/Transforms/Scalar/LoopUnrollPass.h" 45 #include "llvm/Transforms/Scalar/SimpleLoopUnswitch.h" 46 #include "llvm/Transforms/Utils.h" 47 #include "llvm/Transforms/Vectorize.h" 48 #include "llvm/Transforms/Vectorize/LoopVectorize.h" 49 #include "llvm/Transforms/Vectorize/SLPVectorizer.h" 50 #include "llvm/Transforms/Vectorize/VectorCombine.h" 51 52 using namespace llvm; 53 54 static cl::opt<bool> 55 RunPartialInlining("enable-partial-inlining", cl::init(false), cl::Hidden, 56 cl::ZeroOrMore, cl::desc("Run Partial inlinining pass")); 57 58 static cl::opt<bool> 59 UseGVNAfterVectorization("use-gvn-after-vectorization", 60 cl::init(false), cl::Hidden, 61 cl::desc("Run GVN instead of Early CSE after vectorization passes")); 62 63 static cl::opt<bool> ExtraVectorizerPasses( 64 "extra-vectorizer-passes", cl::init(false), cl::Hidden, 65 cl::desc("Run cleanup optimization passes after vectorization.")); 66 67 static cl::opt<bool> 68 RunLoopRerolling("reroll-loops", cl::Hidden, 69 cl::desc("Run the loop rerolling pass")); 70 71 static cl::opt<bool> RunNewGVN("enable-newgvn", cl::init(false), cl::Hidden, 72 cl::desc("Run the NewGVN pass")); 73 74 // Experimental option to use CFL-AA 75 enum class CFLAAType { None, Steensgaard, Andersen, Both }; 76 static cl::opt<CFLAAType> 77 UseCFLAA("use-cfl-aa", cl::init(CFLAAType::None), cl::Hidden, 78 cl::desc("Enable the new, experimental CFL alias analysis"), 79 cl::values(clEnumValN(CFLAAType::None, "none", "Disable CFL-AA"), 80 clEnumValN(CFLAAType::Steensgaard, "steens", 81 "Enable unification-based CFL-AA"), 82 clEnumValN(CFLAAType::Andersen, "anders", 83 "Enable inclusion-based CFL-AA"), 84 clEnumValN(CFLAAType::Both, "both", 85 "Enable both variants of CFL-AA"))); 86 87 static cl::opt<bool> EnableLoopInterchange( 88 "enable-loopinterchange", cl::init(false), cl::Hidden, 89 cl::desc("Enable the new, experimental LoopInterchange Pass")); 90 91 static cl::opt<bool> EnableUnrollAndJam("enable-unroll-and-jam", 92 cl::init(false), cl::Hidden, 93 cl::desc("Enable Unroll And Jam Pass")); 94 95 static cl::opt<bool> EnableLoopFlatten("enable-loop-flatten", cl::init(false), 96 cl::Hidden, 97 cl::desc("Enable the LoopFlatten Pass")); 98 99 static cl::opt<bool> 100 EnablePrepareForThinLTO("prepare-for-thinlto", cl::init(false), cl::Hidden, 101 cl::desc("Enable preparation for ThinLTO.")); 102 103 static cl::opt<bool> 104 EnablePerformThinLTO("perform-thinlto", cl::init(false), cl::Hidden, 105 cl::desc("Enable performing ThinLTO.")); 106 107 cl::opt<bool> EnableHotColdSplit("hot-cold-split", cl::init(false), 108 cl::ZeroOrMore, cl::desc("Enable hot-cold splitting pass")); 109 110 static cl::opt<bool> UseLoopVersioningLICM( 111 "enable-loop-versioning-licm", cl::init(false), cl::Hidden, 112 cl::desc("Enable the experimental Loop Versioning LICM pass")); 113 114 static cl::opt<bool> 115 DisablePreInliner("disable-preinline", cl::init(false), cl::Hidden, 116 cl::desc("Disable pre-instrumentation inliner")); 117 118 static cl::opt<int> PreInlineThreshold( 119 "preinline-threshold", cl::Hidden, cl::init(75), cl::ZeroOrMore, 120 cl::desc("Control the amount of inlining in pre-instrumentation inliner " 121 "(default = 75)")); 122 123 static cl::opt<bool> EnableGVNHoist( 124 "enable-gvn-hoist", cl::init(false), cl::ZeroOrMore, 125 cl::desc("Enable the GVN hoisting pass (default = off)")); 126 127 static cl::opt<bool> 128 DisableLibCallsShrinkWrap("disable-libcalls-shrinkwrap", cl::init(false), 129 cl::Hidden, 130 cl::desc("Disable shrink-wrap library calls")); 131 132 static cl::opt<bool> EnableSimpleLoopUnswitch( 133 "enable-simple-loop-unswitch", cl::init(false), cl::Hidden, 134 cl::desc("Enable the simple loop unswitch pass. Also enables independent " 135 "cleanup passes integrated into the loop pass manager pipeline.")); 136 137 static cl::opt<bool> EnableGVNSink( 138 "enable-gvn-sink", cl::init(false), cl::ZeroOrMore, 139 cl::desc("Enable the GVN sinking pass (default = off)")); 140 141 // This option is used in simplifying testing SampleFDO optimizations for 142 // profile loading. 143 static cl::opt<bool> 144 EnableCHR("enable-chr", cl::init(true), cl::Hidden, 145 cl::desc("Enable control height reduction optimization (CHR)")); 146 147 cl::opt<bool> FlattenedProfileUsed( 148 "flattened-profile-used", cl::init(false), cl::Hidden, 149 cl::desc("Indicate the sample profile being used is flattened, i.e., " 150 "no inline hierachy exists in the profile. ")); 151 152 cl::opt<bool> EnableOrderFileInstrumentation( 153 "enable-order-file-instrumentation", cl::init(false), cl::Hidden, 154 cl::desc("Enable order file instrumentation (default = off)")); 155 156 cl::opt<bool> EnableMatrix( 157 "enable-matrix", cl::init(false), cl::Hidden, 158 cl::desc("Enable lowering of the matrix intrinsics")); 159 160 cl::opt<bool> EnableConstraintElimination( 161 "enable-constraint-elimination", cl::init(false), cl::Hidden, 162 cl::desc( 163 "Enable pass to eliminate conditions based on linear constraints.")); 164 165 cl::opt<AttributorRunOption> AttributorRun( 166 "attributor-enable", cl::Hidden, cl::init(AttributorRunOption::NONE), 167 cl::desc("Enable the attributor inter-procedural deduction pass."), 168 cl::values(clEnumValN(AttributorRunOption::ALL, "all", 169 "enable all attributor runs"), 170 clEnumValN(AttributorRunOption::MODULE, "module", 171 "enable module-wide attributor runs"), 172 clEnumValN(AttributorRunOption::CGSCC, "cgscc", 173 "enable call graph SCC attributor runs"), 174 clEnumValN(AttributorRunOption::NONE, "none", 175 "disable attributor runs"))); 176 177 extern cl::opt<bool> EnableKnowledgeRetention; 178 179 PassManagerBuilder::PassManagerBuilder() { 180 OptLevel = 2; 181 SizeLevel = 0; 182 LibraryInfo = nullptr; 183 Inliner = nullptr; 184 DisableUnrollLoops = false; 185 SLPVectorize = false; 186 LoopVectorize = true; 187 LoopsInterleaved = true; 188 RerollLoops = RunLoopRerolling; 189 NewGVN = RunNewGVN; 190 LicmMssaOptCap = SetLicmMssaOptCap; 191 LicmMssaNoAccForPromotionCap = SetLicmMssaNoAccForPromotionCap; 192 DisableGVNLoadPRE = false; 193 ForgetAllSCEVInLoopUnroll = ForgetSCEVInLoopUnroll; 194 VerifyInput = false; 195 VerifyOutput = false; 196 MergeFunctions = false; 197 PrepareForLTO = false; 198 EnablePGOInstrGen = false; 199 EnablePGOCSInstrGen = false; 200 EnablePGOCSInstrUse = false; 201 PGOInstrGen = ""; 202 PGOInstrUse = ""; 203 PGOSampleUse = ""; 204 PrepareForThinLTO = EnablePrepareForThinLTO; 205 PerformThinLTO = EnablePerformThinLTO; 206 DivergentTarget = false; 207 CallGraphProfile = true; 208 } 209 210 PassManagerBuilder::~PassManagerBuilder() { 211 delete LibraryInfo; 212 delete Inliner; 213 } 214 215 /// Set of global extensions, automatically added as part of the standard set. 216 static ManagedStatic< 217 SmallVector<std::tuple<PassManagerBuilder::ExtensionPointTy, 218 PassManagerBuilder::ExtensionFn, 219 PassManagerBuilder::GlobalExtensionID>, 220 8>> 221 GlobalExtensions; 222 static PassManagerBuilder::GlobalExtensionID GlobalExtensionsCounter; 223 224 /// Check if GlobalExtensions is constructed and not empty. 225 /// Since GlobalExtensions is a managed static, calling 'empty()' will trigger 226 /// the construction of the object. 227 static bool GlobalExtensionsNotEmpty() { 228 return GlobalExtensions.isConstructed() && !GlobalExtensions->empty(); 229 } 230 231 PassManagerBuilder::GlobalExtensionID 232 PassManagerBuilder::addGlobalExtension(PassManagerBuilder::ExtensionPointTy Ty, 233 PassManagerBuilder::ExtensionFn Fn) { 234 auto ExtensionID = GlobalExtensionsCounter++; 235 GlobalExtensions->push_back(std::make_tuple(Ty, std::move(Fn), ExtensionID)); 236 return ExtensionID; 237 } 238 239 void PassManagerBuilder::removeGlobalExtension( 240 PassManagerBuilder::GlobalExtensionID ExtensionID) { 241 // RegisterStandardPasses may try to call this function after GlobalExtensions 242 // has already been destroyed; doing so should not generate an error. 243 if (!GlobalExtensions.isConstructed()) 244 return; 245 246 auto GlobalExtension = 247 llvm::find_if(*GlobalExtensions, [ExtensionID](const auto &elem) { 248 return std::get<2>(elem) == ExtensionID; 249 }); 250 assert(GlobalExtension != GlobalExtensions->end() && 251 "The extension ID to be removed should always be valid."); 252 253 GlobalExtensions->erase(GlobalExtension); 254 } 255 256 void PassManagerBuilder::addExtension(ExtensionPointTy Ty, ExtensionFn Fn) { 257 Extensions.push_back(std::make_pair(Ty, std::move(Fn))); 258 } 259 260 void PassManagerBuilder::addExtensionsToPM(ExtensionPointTy ETy, 261 legacy::PassManagerBase &PM) const { 262 if (GlobalExtensionsNotEmpty()) { 263 for (auto &Ext : *GlobalExtensions) { 264 if (std::get<0>(Ext) == ETy) 265 std::get<1>(Ext)(*this, PM); 266 } 267 } 268 for (unsigned i = 0, e = Extensions.size(); i != e; ++i) 269 if (Extensions[i].first == ETy) 270 Extensions[i].second(*this, PM); 271 } 272 273 void PassManagerBuilder::addInitialAliasAnalysisPasses( 274 legacy::PassManagerBase &PM) const { 275 switch (UseCFLAA) { 276 case CFLAAType::Steensgaard: 277 PM.add(createCFLSteensAAWrapperPass()); 278 break; 279 case CFLAAType::Andersen: 280 PM.add(createCFLAndersAAWrapperPass()); 281 break; 282 case CFLAAType::Both: 283 PM.add(createCFLSteensAAWrapperPass()); 284 PM.add(createCFLAndersAAWrapperPass()); 285 break; 286 default: 287 break; 288 } 289 290 // Add TypeBasedAliasAnalysis before BasicAliasAnalysis so that 291 // BasicAliasAnalysis wins if they disagree. This is intended to help 292 // support "obvious" type-punning idioms. 293 PM.add(createTypeBasedAAWrapperPass()); 294 PM.add(createScopedNoAliasAAWrapperPass()); 295 } 296 297 void PassManagerBuilder::populateFunctionPassManager( 298 legacy::FunctionPassManager &FPM) { 299 addExtensionsToPM(EP_EarlyAsPossible, FPM); 300 FPM.add(createEntryExitInstrumenterPass()); 301 302 // Add LibraryInfo if we have some. 303 if (LibraryInfo) 304 FPM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo)); 305 306 // The backends do not handle matrix intrinsics currently. 307 // Make sure they are also lowered in O0. 308 // FIXME: A lightweight version of the pass should run in the backend 309 // pipeline on demand. 310 if (EnableMatrix && OptLevel == 0) 311 FPM.add(createLowerMatrixIntrinsicsMinimalPass()); 312 313 if (OptLevel == 0) return; 314 315 addInitialAliasAnalysisPasses(FPM); 316 317 FPM.add(createCFGSimplificationPass()); 318 FPM.add(createSROAPass()); 319 FPM.add(createEarlyCSEPass()); 320 FPM.add(createLowerExpectIntrinsicPass()); 321 } 322 323 // Do PGO instrumentation generation or use pass as the option specified. 324 void PassManagerBuilder::addPGOInstrPasses(legacy::PassManagerBase &MPM, 325 bool IsCS = false) { 326 if (IsCS) { 327 if (!EnablePGOCSInstrGen && !EnablePGOCSInstrUse) 328 return; 329 } else if (!EnablePGOInstrGen && PGOInstrUse.empty() && PGOSampleUse.empty()) 330 return; 331 332 // Perform the preinline and cleanup passes for O1 and above. 333 // And avoid doing them if optimizing for size. 334 // We will not do this inline for context sensitive PGO (when IsCS is true). 335 if (OptLevel > 0 && SizeLevel == 0 && !DisablePreInliner && 336 PGOSampleUse.empty() && !IsCS) { 337 // Create preinline pass. We construct an InlineParams object and specify 338 // the threshold here to avoid the command line options of the regular 339 // inliner to influence pre-inlining. The only fields of InlineParams we 340 // care about are DefaultThreshold and HintThreshold. 341 InlineParams IP; 342 IP.DefaultThreshold = PreInlineThreshold; 343 // FIXME: The hint threshold has the same value used by the regular inliner. 344 // This should probably be lowered after performance testing. 345 IP.HintThreshold = 325; 346 347 MPM.add(createFunctionInliningPass(IP)); 348 MPM.add(createSROAPass()); 349 MPM.add(createEarlyCSEPass()); // Catch trivial redundancies 350 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs 351 MPM.add(createInstructionCombiningPass()); // Combine silly seq's 352 addExtensionsToPM(EP_Peephole, MPM); 353 } 354 if ((EnablePGOInstrGen && !IsCS) || (EnablePGOCSInstrGen && IsCS)) { 355 MPM.add(createPGOInstrumentationGenLegacyPass(IsCS)); 356 // Add the profile lowering pass. 357 InstrProfOptions Options; 358 if (!PGOInstrGen.empty()) 359 Options.InstrProfileOutput = PGOInstrGen; 360 Options.DoCounterPromotion = true; 361 Options.UseBFIInPromotion = IsCS; 362 MPM.add(createLoopRotatePass()); 363 MPM.add(createInstrProfilingLegacyPass(Options, IsCS)); 364 } 365 if (!PGOInstrUse.empty()) 366 MPM.add(createPGOInstrumentationUseLegacyPass(PGOInstrUse, IsCS)); 367 // Indirect call promotion that promotes intra-module targets only. 368 // For ThinLTO this is done earlier due to interactions with globalopt 369 // for imported functions. We don't run this at -O0. 370 if (OptLevel > 0 && !IsCS) 371 MPM.add( 372 createPGOIndirectCallPromotionLegacyPass(false, !PGOSampleUse.empty())); 373 } 374 void PassManagerBuilder::addFunctionSimplificationPasses( 375 legacy::PassManagerBase &MPM) { 376 // Start of function pass. 377 // Break up aggregate allocas, using SSAUpdater. 378 assert(OptLevel >= 1 && "Calling function optimizer with no optimization level!"); 379 MPM.add(createSROAPass()); 380 MPM.add(createEarlyCSEPass(true /* Enable mem-ssa. */)); // Catch trivial redundancies 381 if (EnableKnowledgeRetention) 382 MPM.add(createAssumeSimplifyPass()); 383 384 if (OptLevel > 1) { 385 if (EnableGVNHoist) 386 MPM.add(createGVNHoistPass()); 387 if (EnableGVNSink) { 388 MPM.add(createGVNSinkPass()); 389 MPM.add(createCFGSimplificationPass()); 390 } 391 } 392 393 if (EnableConstraintElimination) 394 MPM.add(createConstraintEliminationPass()); 395 396 if (OptLevel > 1) { 397 // Speculative execution if the target has divergent branches; otherwise nop. 398 MPM.add(createSpeculativeExecutionIfHasBranchDivergencePass()); 399 400 MPM.add(createJumpThreadingPass()); // Thread jumps. 401 MPM.add(createCorrelatedValuePropagationPass()); // Propagate conditionals 402 } 403 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs 404 // Combine silly seq's 405 if (OptLevel > 2) 406 MPM.add(createAggressiveInstCombinerPass()); 407 MPM.add(createInstructionCombiningPass()); 408 if (SizeLevel == 0 && !DisableLibCallsShrinkWrap) 409 MPM.add(createLibCallsShrinkWrapPass()); 410 addExtensionsToPM(EP_Peephole, MPM); 411 412 // Optimize memory intrinsic calls based on the profiled size information. 413 if (SizeLevel == 0) 414 MPM.add(createPGOMemOPSizeOptLegacyPass()); 415 416 // TODO: Investigate the cost/benefit of tail call elimination on debugging. 417 if (OptLevel > 1) 418 MPM.add(createTailCallEliminationPass()); // Eliminate tail calls 419 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs 420 MPM.add(createReassociatePass()); // Reassociate expressions 421 422 // Begin the loop pass pipeline. 423 if (EnableSimpleLoopUnswitch) { 424 // The simple loop unswitch pass relies on separate cleanup passes. Schedule 425 // them first so when we re-process a loop they run before other loop 426 // passes. 427 MPM.add(createLoopInstSimplifyPass()); 428 MPM.add(createLoopSimplifyCFGPass()); 429 } 430 // Rotate Loop - disable header duplication at -Oz 431 MPM.add(createLoopRotatePass(SizeLevel == 2 ? 0 : -1)); 432 // TODO: Investigate promotion cap for O1. 433 MPM.add(createLICMPass(LicmMssaOptCap, LicmMssaNoAccForPromotionCap)); 434 if (EnableSimpleLoopUnswitch) 435 MPM.add(createSimpleLoopUnswitchLegacyPass()); 436 else 437 MPM.add(createLoopUnswitchPass(SizeLevel || OptLevel < 3, DivergentTarget)); 438 // FIXME: We break the loop pass pipeline here in order to do full 439 // simplify-cfg. Eventually loop-simplifycfg should be enhanced to replace the 440 // need for this. 441 MPM.add(createCFGSimplificationPass()); 442 MPM.add(createInstructionCombiningPass()); 443 // We resume loop passes creating a second loop pipeline here. 444 MPM.add(createIndVarSimplifyPass()); // Canonicalize indvars 445 MPM.add(createLoopIdiomPass()); // Recognize idioms like memset. 446 addExtensionsToPM(EP_LateLoopOptimizations, MPM); 447 MPM.add(createLoopDeletionPass()); // Delete dead loops 448 449 if (EnableLoopInterchange) 450 MPM.add(createLoopInterchangePass()); // Interchange loops 451 if (EnableLoopFlatten) { 452 MPM.add(createLoopFlattenPass()); // Flatten loops 453 MPM.add(createLoopSimplifyCFGPass()); 454 } 455 456 // Unroll small loops 457 MPM.add(createSimpleLoopUnrollPass(OptLevel, DisableUnrollLoops, 458 ForgetAllSCEVInLoopUnroll)); 459 addExtensionsToPM(EP_LoopOptimizerEnd, MPM); 460 // This ends the loop pass pipelines. 461 462 if (OptLevel > 1) { 463 MPM.add(createMergedLoadStoreMotionPass()); // Merge ld/st in diamonds 464 MPM.add(NewGVN ? createNewGVNPass() 465 : createGVNPass(DisableGVNLoadPRE)); // Remove redundancies 466 } 467 MPM.add(createMemCpyOptPass()); // Remove memcpy / form memset 468 MPM.add(createSCCPPass()); // Constant prop with SCCP 469 470 // Delete dead bit computations (instcombine runs after to fold away the dead 471 // computations, and then ADCE will run later to exploit any new DCE 472 // opportunities that creates). 473 MPM.add(createBitTrackingDCEPass()); // Delete dead bit computations 474 475 // Run instcombine after redundancy elimination to exploit opportunities 476 // opened up by them. 477 MPM.add(createInstructionCombiningPass()); 478 addExtensionsToPM(EP_Peephole, MPM); 479 if (OptLevel > 1) { 480 MPM.add(createJumpThreadingPass()); // Thread jumps 481 MPM.add(createCorrelatedValuePropagationPass()); 482 MPM.add(createDeadStoreEliminationPass()); // Delete dead stores 483 MPM.add(createLICMPass(LicmMssaOptCap, LicmMssaNoAccForPromotionCap)); 484 } 485 486 addExtensionsToPM(EP_ScalarOptimizerLate, MPM); 487 488 if (RerollLoops) 489 MPM.add(createLoopRerollPass()); 490 491 // TODO: Investigate if this is too expensive at O1. 492 MPM.add(createAggressiveDCEPass()); // Delete dead instructions 493 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs 494 // Clean up after everything. 495 MPM.add(createInstructionCombiningPass()); 496 addExtensionsToPM(EP_Peephole, MPM); 497 498 if (EnableCHR && OptLevel >= 3 && 499 (!PGOInstrUse.empty() || !PGOSampleUse.empty() || EnablePGOCSInstrGen)) 500 MPM.add(createControlHeightReductionLegacyPass()); 501 } 502 503 void PassManagerBuilder::populateModulePassManager( 504 legacy::PassManagerBase &MPM) { 505 // Whether this is a default or *LTO pre-link pipeline. The FullLTO post-link 506 // is handled separately, so just check this is not the ThinLTO post-link. 507 bool DefaultOrPreLinkPipeline = !PerformThinLTO; 508 509 if (!PGOSampleUse.empty()) { 510 MPM.add(createPruneEHPass()); 511 // In ThinLTO mode, when flattened profile is used, all the available 512 // profile information will be annotated in PreLink phase so there is 513 // no need to load the profile again in PostLink. 514 if (!(FlattenedProfileUsed && PerformThinLTO)) 515 MPM.add(createSampleProfileLoaderPass(PGOSampleUse)); 516 } 517 518 // Allow forcing function attributes as a debugging and tuning aid. 519 MPM.add(createForceFunctionAttrsLegacyPass()); 520 521 // If all optimizations are disabled, just run the always-inline pass and, 522 // if enabled, the function merging pass. 523 if (OptLevel == 0) { 524 addPGOInstrPasses(MPM); 525 if (Inliner) { 526 MPM.add(Inliner); 527 Inliner = nullptr; 528 } 529 530 // FIXME: The BarrierNoopPass is a HACK! The inliner pass above implicitly 531 // creates a CGSCC pass manager, but we don't want to add extensions into 532 // that pass manager. To prevent this we insert a no-op module pass to reset 533 // the pass manager to get the same behavior as EP_OptimizerLast in non-O0 534 // builds. The function merging pass is 535 if (MergeFunctions) 536 MPM.add(createMergeFunctionsPass()); 537 else if (GlobalExtensionsNotEmpty() || !Extensions.empty()) 538 MPM.add(createBarrierNoopPass()); 539 540 if (PerformThinLTO) { 541 MPM.add(createLowerTypeTestsPass(nullptr, nullptr, true)); 542 // Drop available_externally and unreferenced globals. This is necessary 543 // with ThinLTO in order to avoid leaving undefined references to dead 544 // globals in the object file. 545 MPM.add(createEliminateAvailableExternallyPass()); 546 MPM.add(createGlobalDCEPass()); 547 } 548 549 addExtensionsToPM(EP_EnabledOnOptLevel0, MPM); 550 551 if (PrepareForLTO || PrepareForThinLTO) { 552 MPM.add(createCanonicalizeAliasesPass()); 553 // Rename anon globals to be able to export them in the summary. 554 // This has to be done after we add the extensions to the pass manager 555 // as there could be passes (e.g. Adddress sanitizer) which introduce 556 // new unnamed globals. 557 MPM.add(createNameAnonGlobalPass()); 558 } 559 return; 560 } 561 562 // Add LibraryInfo if we have some. 563 if (LibraryInfo) 564 MPM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo)); 565 566 addInitialAliasAnalysisPasses(MPM); 567 568 // For ThinLTO there are two passes of indirect call promotion. The 569 // first is during the compile phase when PerformThinLTO=false and 570 // intra-module indirect call targets are promoted. The second is during 571 // the ThinLTO backend when PerformThinLTO=true, when we promote imported 572 // inter-module indirect calls. For that we perform indirect call promotion 573 // earlier in the pass pipeline, here before globalopt. Otherwise imported 574 // available_externally functions look unreferenced and are removed. 575 if (PerformThinLTO) { 576 MPM.add(createPGOIndirectCallPromotionLegacyPass(/*InLTO = */ true, 577 !PGOSampleUse.empty())); 578 MPM.add(createLowerTypeTestsPass(nullptr, nullptr, true)); 579 } 580 581 // For SamplePGO in ThinLTO compile phase, we do not want to unroll loops 582 // as it will change the CFG too much to make the 2nd profile annotation 583 // in backend more difficult. 584 bool PrepareForThinLTOUsingPGOSampleProfile = 585 PrepareForThinLTO && !PGOSampleUse.empty(); 586 if (PrepareForThinLTOUsingPGOSampleProfile) 587 DisableUnrollLoops = true; 588 589 // Infer attributes about declarations if possible. 590 MPM.add(createInferFunctionAttrsLegacyPass()); 591 592 // Infer attributes on declarations, call sites, arguments, etc. 593 if (AttributorRun & AttributorRunOption::MODULE) 594 MPM.add(createAttributorLegacyPass()); 595 596 addExtensionsToPM(EP_ModuleOptimizerEarly, MPM); 597 598 if (OptLevel > 2) 599 MPM.add(createCallSiteSplittingPass()); 600 601 MPM.add(createIPSCCPPass()); // IP SCCP 602 MPM.add(createCalledValuePropagationPass()); 603 604 MPM.add(createGlobalOptimizerPass()); // Optimize out global vars 605 // Promote any localized global vars. 606 MPM.add(createPromoteMemoryToRegisterPass()); 607 608 MPM.add(createDeadArgEliminationPass()); // Dead argument elimination 609 610 MPM.add(createInstructionCombiningPass()); // Clean up after IPCP & DAE 611 addExtensionsToPM(EP_Peephole, MPM); 612 MPM.add(createCFGSimplificationPass()); // Clean up after IPCP & DAE 613 614 // For SamplePGO in ThinLTO compile phase, we do not want to do indirect 615 // call promotion as it will change the CFG too much to make the 2nd 616 // profile annotation in backend more difficult. 617 // PGO instrumentation is added during the compile phase for ThinLTO, do 618 // not run it a second time 619 if (DefaultOrPreLinkPipeline && !PrepareForThinLTOUsingPGOSampleProfile) 620 addPGOInstrPasses(MPM); 621 622 // Create profile COMDAT variables. Lld linker wants to see all variables 623 // before the LTO/ThinLTO link since it needs to resolve symbols/comdats. 624 if (!PerformThinLTO && EnablePGOCSInstrGen) 625 MPM.add(createPGOInstrumentationGenCreateVarLegacyPass(PGOInstrGen)); 626 627 // We add a module alias analysis pass here. In part due to bugs in the 628 // analysis infrastructure this "works" in that the analysis stays alive 629 // for the entire SCC pass run below. 630 MPM.add(createGlobalsAAWrapperPass()); 631 632 // Start of CallGraph SCC passes. 633 MPM.add(createPruneEHPass()); // Remove dead EH info 634 bool RunInliner = false; 635 if (Inliner) { 636 MPM.add(Inliner); 637 Inliner = nullptr; 638 RunInliner = true; 639 } 640 641 // Infer attributes on declarations, call sites, arguments, etc. for an SCC. 642 if (AttributorRun & AttributorRunOption::CGSCC) 643 MPM.add(createAttributorCGSCCLegacyPass()); 644 645 // Try to perform OpenMP specific optimizations. This is a (quick!) no-op if 646 // there are no OpenMP runtime calls present in the module. 647 if (OptLevel > 1) 648 MPM.add(createOpenMPOptLegacyPass()); 649 650 MPM.add(createPostOrderFunctionAttrsLegacyPass()); 651 if (OptLevel > 2) 652 MPM.add(createArgumentPromotionPass()); // Scalarize uninlined fn args 653 654 addExtensionsToPM(EP_CGSCCOptimizerLate, MPM); 655 addFunctionSimplificationPasses(MPM); 656 657 // FIXME: This is a HACK! The inliner pass above implicitly creates a CGSCC 658 // pass manager that we are specifically trying to avoid. To prevent this 659 // we must insert a no-op module pass to reset the pass manager. 660 MPM.add(createBarrierNoopPass()); 661 662 if (RunPartialInlining) 663 MPM.add(createPartialInliningPass()); 664 665 if (OptLevel > 1 && !PrepareForLTO && !PrepareForThinLTO) 666 // Remove avail extern fns and globals definitions if we aren't 667 // compiling an object file for later LTO. For LTO we want to preserve 668 // these so they are eligible for inlining at link-time. Note if they 669 // are unreferenced they will be removed by GlobalDCE later, so 670 // this only impacts referenced available externally globals. 671 // Eventually they will be suppressed during codegen, but eliminating 672 // here enables more opportunity for GlobalDCE as it may make 673 // globals referenced by available external functions dead 674 // and saves running remaining passes on the eliminated functions. 675 MPM.add(createEliminateAvailableExternallyPass()); 676 677 // CSFDO instrumentation and use pass. Don't invoke this for Prepare pass 678 // for LTO and ThinLTO -- The actual pass will be called after all inlines 679 // are performed. 680 // Need to do this after COMDAT variables have been eliminated, 681 // (i.e. after EliminateAvailableExternallyPass). 682 if (!(PrepareForLTO || PrepareForThinLTO)) 683 addPGOInstrPasses(MPM, /* IsCS */ true); 684 685 if (EnableOrderFileInstrumentation) 686 MPM.add(createInstrOrderFilePass()); 687 688 MPM.add(createReversePostOrderFunctionAttrsPass()); 689 690 // The inliner performs some kind of dead code elimination as it goes, 691 // but there are cases that are not really caught by it. We might 692 // at some point consider teaching the inliner about them, but it 693 // is OK for now to run GlobalOpt + GlobalDCE in tandem as their 694 // benefits generally outweight the cost, making the whole pipeline 695 // faster. 696 if (RunInliner) { 697 MPM.add(createGlobalOptimizerPass()); 698 MPM.add(createGlobalDCEPass()); 699 } 700 701 // If we are planning to perform ThinLTO later, let's not bloat the code with 702 // unrolling/vectorization/... now. We'll first run the inliner + CGSCC passes 703 // during ThinLTO and perform the rest of the optimizations afterward. 704 if (PrepareForThinLTO) { 705 // Ensure we perform any last passes, but do so before renaming anonymous 706 // globals in case the passes add any. 707 addExtensionsToPM(EP_OptimizerLast, MPM); 708 MPM.add(createCanonicalizeAliasesPass()); 709 // Rename anon globals to be able to export them in the summary. 710 MPM.add(createNameAnonGlobalPass()); 711 return; 712 } 713 714 if (PerformThinLTO) 715 // Optimize globals now when performing ThinLTO, this enables more 716 // optimizations later. 717 MPM.add(createGlobalOptimizerPass()); 718 719 // Scheduling LoopVersioningLICM when inlining is over, because after that 720 // we may see more accurate aliasing. Reason to run this late is that too 721 // early versioning may prevent further inlining due to increase of code 722 // size. By placing it just after inlining other optimizations which runs 723 // later might get benefit of no-alias assumption in clone loop. 724 if (UseLoopVersioningLICM) { 725 MPM.add(createLoopVersioningLICMPass()); // Do LoopVersioningLICM 726 MPM.add(createLICMPass(LicmMssaOptCap, LicmMssaNoAccForPromotionCap)); 727 } 728 729 // We add a fresh GlobalsModRef run at this point. This is particularly 730 // useful as the above will have inlined, DCE'ed, and function-attr 731 // propagated everything. We should at this point have a reasonably minimal 732 // and richly annotated call graph. By computing aliasing and mod/ref 733 // information for all local globals here, the late loop passes and notably 734 // the vectorizer will be able to use them to help recognize vectorizable 735 // memory operations. 736 // 737 // Note that this relies on a bug in the pass manager which preserves 738 // a module analysis into a function pass pipeline (and throughout it) so 739 // long as the first function pass doesn't invalidate the module analysis. 740 // Thus both Float2Int and LoopRotate have to preserve AliasAnalysis for 741 // this to work. Fortunately, it is trivial to preserve AliasAnalysis 742 // (doing nothing preserves it as it is required to be conservatively 743 // correct in the face of IR changes). 744 MPM.add(createGlobalsAAWrapperPass()); 745 746 MPM.add(createFloat2IntPass()); 747 MPM.add(createLowerConstantIntrinsicsPass()); 748 749 if (EnableMatrix) { 750 MPM.add(createLowerMatrixIntrinsicsPass()); 751 // CSE the pointer arithmetic of the column vectors. This allows alias 752 // analysis to establish no-aliasing between loads and stores of different 753 // columns of the same matrix. 754 MPM.add(createEarlyCSEPass(false)); 755 } 756 757 addExtensionsToPM(EP_VectorizerStart, MPM); 758 759 // Re-rotate loops in all our loop nests. These may have fallout out of 760 // rotated form due to GVN or other transformations, and the vectorizer relies 761 // on the rotated form. Disable header duplication at -Oz. 762 MPM.add(createLoopRotatePass(SizeLevel == 2 ? 0 : -1)); 763 764 // Distribute loops to allow partial vectorization. I.e. isolate dependences 765 // into separate loop that would otherwise inhibit vectorization. This is 766 // currently only performed for loops marked with the metadata 767 // llvm.loop.distribute=true or when -enable-loop-distribute is specified. 768 MPM.add(createLoopDistributePass()); 769 770 MPM.add(createLoopVectorizePass(!LoopsInterleaved, !LoopVectorize)); 771 772 // Eliminate loads by forwarding stores from the previous iteration to loads 773 // of the current iteration. 774 MPM.add(createLoopLoadEliminationPass()); 775 776 // FIXME: Because of #pragma vectorize enable, the passes below are always 777 // inserted in the pipeline, even when the vectorizer doesn't run (ex. when 778 // on -O1 and no #pragma is found). Would be good to have these two passes 779 // as function calls, so that we can only pass them when the vectorizer 780 // changed the code. 781 MPM.add(createInstructionCombiningPass()); 782 if (OptLevel > 1 && ExtraVectorizerPasses) { 783 // At higher optimization levels, try to clean up any runtime overlap and 784 // alignment checks inserted by the vectorizer. We want to track correllated 785 // runtime checks for two inner loops in the same outer loop, fold any 786 // common computations, hoist loop-invariant aspects out of any outer loop, 787 // and unswitch the runtime checks if possible. Once hoisted, we may have 788 // dead (or speculatable) control flows or more combining opportunities. 789 MPM.add(createEarlyCSEPass()); 790 MPM.add(createCorrelatedValuePropagationPass()); 791 MPM.add(createInstructionCombiningPass()); 792 MPM.add(createLICMPass(LicmMssaOptCap, LicmMssaNoAccForPromotionCap)); 793 MPM.add(createLoopUnswitchPass(SizeLevel || OptLevel < 3, DivergentTarget)); 794 MPM.add(createCFGSimplificationPass()); 795 MPM.add(createInstructionCombiningPass()); 796 } 797 798 // Cleanup after loop vectorization, etc. Simplification passes like CVP and 799 // GVN, loop transforms, and others have already run, so it's now better to 800 // convert to more optimized IR using more aggressive simplify CFG options. 801 // The extra sinking transform can create larger basic blocks, so do this 802 // before SLP vectorization. 803 // FIXME: study whether hoisting and/or sinking of common instructions should 804 // be delayed until after SLP vectorizer. 805 MPM.add(createCFGSimplificationPass(SimplifyCFGOptions() 806 .forwardSwitchCondToPhi(true) 807 .convertSwitchToLookupTable(true) 808 .needCanonicalLoops(false) 809 .hoistCommonInsts(true) 810 .sinkCommonInsts(true))); 811 812 if (SLPVectorize) { 813 MPM.add(createSLPVectorizerPass()); // Vectorize parallel scalar chains. 814 if (OptLevel > 1 && ExtraVectorizerPasses) { 815 MPM.add(createEarlyCSEPass()); 816 } 817 } 818 819 // Enhance/cleanup vector code. 820 MPM.add(createVectorCombinePass()); 821 822 addExtensionsToPM(EP_Peephole, MPM); 823 MPM.add(createInstructionCombiningPass()); 824 825 if (EnableUnrollAndJam && !DisableUnrollLoops) { 826 // Unroll and Jam. We do this before unroll but need to be in a separate 827 // loop pass manager in order for the outer loop to be processed by 828 // unroll and jam before the inner loop is unrolled. 829 MPM.add(createLoopUnrollAndJamPass(OptLevel)); 830 } 831 832 // Unroll small loops 833 MPM.add(createLoopUnrollPass(OptLevel, DisableUnrollLoops, 834 ForgetAllSCEVInLoopUnroll)); 835 836 if (!DisableUnrollLoops) { 837 // LoopUnroll may generate some redundency to cleanup. 838 MPM.add(createInstructionCombiningPass()); 839 840 // Runtime unrolling will introduce runtime check in loop prologue. If the 841 // unrolled loop is a inner loop, then the prologue will be inside the 842 // outer loop. LICM pass can help to promote the runtime check out if the 843 // checked value is loop invariant. 844 MPM.add(createLICMPass(LicmMssaOptCap, LicmMssaNoAccForPromotionCap)); 845 } 846 847 MPM.add(createWarnMissedTransformationsPass()); 848 849 // After vectorization and unrolling, assume intrinsics may tell us more 850 // about pointer alignments. 851 MPM.add(createAlignmentFromAssumptionsPass()); 852 853 // FIXME: We shouldn't bother with this anymore. 854 MPM.add(createStripDeadPrototypesPass()); // Get rid of dead prototypes 855 856 // GlobalOpt already deletes dead functions and globals, at -O2 try a 857 // late pass of GlobalDCE. It is capable of deleting dead cycles. 858 if (OptLevel > 1) { 859 MPM.add(createGlobalDCEPass()); // Remove dead fns and globals. 860 MPM.add(createConstantMergePass()); // Merge dup global constants 861 } 862 863 // See comment in the new PM for justification of scheduling splitting at 864 // this stage (\ref buildModuleSimplificationPipeline). 865 if (EnableHotColdSplit && !(PrepareForLTO || PrepareForThinLTO)) 866 MPM.add(createHotColdSplittingPass()); 867 868 if (MergeFunctions) 869 MPM.add(createMergeFunctionsPass()); 870 871 // Add Module flag "CG Profile" based on Branch Frequency Information. 872 if (CallGraphProfile) 873 MPM.add(createCGProfileLegacyPass()); 874 875 // LoopSink pass sinks instructions hoisted by LICM, which serves as a 876 // canonicalization pass that enables other optimizations. As a result, 877 // LoopSink pass needs to be a very late IR pass to avoid undoing LICM 878 // result too early. 879 MPM.add(createLoopSinkPass()); 880 // Get rid of LCSSA nodes. 881 MPM.add(createInstSimplifyLegacyPass()); 882 883 // This hoists/decomposes div/rem ops. It should run after other sink/hoist 884 // passes to avoid re-sinking, but before SimplifyCFG because it can allow 885 // flattening of blocks. 886 MPM.add(createDivRemPairsPass()); 887 888 // LoopSink (and other loop passes since the last simplifyCFG) might have 889 // resulted in single-entry-single-exit or empty blocks. Clean up the CFG. 890 MPM.add(createCFGSimplificationPass()); 891 892 addExtensionsToPM(EP_OptimizerLast, MPM); 893 894 if (PrepareForLTO) { 895 MPM.add(createCanonicalizeAliasesPass()); 896 // Rename anon globals to be able to handle them in the summary 897 MPM.add(createNameAnonGlobalPass()); 898 } 899 } 900 901 void PassManagerBuilder::addLTOOptimizationPasses(legacy::PassManagerBase &PM) { 902 // Load sample profile before running the LTO optimization pipeline. 903 if (!PGOSampleUse.empty()) { 904 PM.add(createPruneEHPass()); 905 PM.add(createSampleProfileLoaderPass(PGOSampleUse)); 906 } 907 908 // Remove unused virtual tables to improve the quality of code generated by 909 // whole-program devirtualization and bitset lowering. 910 PM.add(createGlobalDCEPass()); 911 912 // Provide AliasAnalysis services for optimizations. 913 addInitialAliasAnalysisPasses(PM); 914 915 // Allow forcing function attributes as a debugging and tuning aid. 916 PM.add(createForceFunctionAttrsLegacyPass()); 917 918 // Infer attributes about declarations if possible. 919 PM.add(createInferFunctionAttrsLegacyPass()); 920 921 if (OptLevel > 1) { 922 // Split call-site with more constrained arguments. 923 PM.add(createCallSiteSplittingPass()); 924 925 // Indirect call promotion. This should promote all the targets that are 926 // left by the earlier promotion pass that promotes intra-module targets. 927 // This two-step promotion is to save the compile time. For LTO, it should 928 // produce the same result as if we only do promotion here. 929 PM.add( 930 createPGOIndirectCallPromotionLegacyPass(true, !PGOSampleUse.empty())); 931 932 // Propagate constants at call sites into the functions they call. This 933 // opens opportunities for globalopt (and inlining) by substituting function 934 // pointers passed as arguments to direct uses of functions. 935 PM.add(createIPSCCPPass()); 936 937 // Attach metadata to indirect call sites indicating the set of functions 938 // they may target at run-time. This should follow IPSCCP. 939 PM.add(createCalledValuePropagationPass()); 940 941 // Infer attributes on declarations, call sites, arguments, etc. 942 if (AttributorRun & AttributorRunOption::MODULE) 943 PM.add(createAttributorLegacyPass()); 944 } 945 946 // Infer attributes about definitions. The readnone attribute in particular is 947 // required for virtual constant propagation. 948 PM.add(createPostOrderFunctionAttrsLegacyPass()); 949 PM.add(createReversePostOrderFunctionAttrsPass()); 950 951 // Split globals using inrange annotations on GEP indices. This can help 952 // improve the quality of generated code when virtual constant propagation or 953 // control flow integrity are enabled. 954 PM.add(createGlobalSplitPass()); 955 956 // Apply whole-program devirtualization and virtual constant propagation. 957 PM.add(createWholeProgramDevirtPass(ExportSummary, nullptr)); 958 959 // That's all we need at opt level 1. 960 if (OptLevel == 1) 961 return; 962 963 // Now that we internalized some globals, see if we can hack on them! 964 PM.add(createGlobalOptimizerPass()); 965 // Promote any localized global vars. 966 PM.add(createPromoteMemoryToRegisterPass()); 967 968 // Linking modules together can lead to duplicated global constants, only 969 // keep one copy of each constant. 970 PM.add(createConstantMergePass()); 971 972 // Remove unused arguments from functions. 973 PM.add(createDeadArgEliminationPass()); 974 975 // Reduce the code after globalopt and ipsccp. Both can open up significant 976 // simplification opportunities, and both can propagate functions through 977 // function pointers. When this happens, we often have to resolve varargs 978 // calls, etc, so let instcombine do this. 979 if (OptLevel > 2) 980 PM.add(createAggressiveInstCombinerPass()); 981 PM.add(createInstructionCombiningPass()); 982 addExtensionsToPM(EP_Peephole, PM); 983 984 // Inline small functions 985 bool RunInliner = Inliner; 986 if (RunInliner) { 987 PM.add(Inliner); 988 Inliner = nullptr; 989 } 990 991 PM.add(createPruneEHPass()); // Remove dead EH info. 992 993 // CSFDO instrumentation and use pass. 994 addPGOInstrPasses(PM, /* IsCS */ true); 995 996 // Infer attributes on declarations, call sites, arguments, etc. for an SCC. 997 if (AttributorRun & AttributorRunOption::CGSCC) 998 PM.add(createAttributorCGSCCLegacyPass()); 999 1000 // Try to perform OpenMP specific optimizations. This is a (quick!) no-op if 1001 // there are no OpenMP runtime calls present in the module. 1002 if (OptLevel > 1) 1003 PM.add(createOpenMPOptLegacyPass()); 1004 1005 // Optimize globals again if we ran the inliner. 1006 if (RunInliner) 1007 PM.add(createGlobalOptimizerPass()); 1008 PM.add(createGlobalDCEPass()); // Remove dead functions. 1009 1010 // If we didn't decide to inline a function, check to see if we can 1011 // transform it to pass arguments by value instead of by reference. 1012 PM.add(createArgumentPromotionPass()); 1013 1014 // The IPO passes may leave cruft around. Clean up after them. 1015 PM.add(createInstructionCombiningPass()); 1016 addExtensionsToPM(EP_Peephole, PM); 1017 PM.add(createJumpThreadingPass(/*FreezeSelectCond*/ true)); 1018 1019 // Break up allocas 1020 PM.add(createSROAPass()); 1021 1022 // LTO provides additional opportunities for tailcall elimination due to 1023 // link-time inlining, and visibility of nocapture attribute. 1024 if (OptLevel > 1) 1025 PM.add(createTailCallEliminationPass()); 1026 1027 // Infer attributes on declarations, call sites, arguments, etc. 1028 PM.add(createPostOrderFunctionAttrsLegacyPass()); // Add nocapture. 1029 // Run a few AA driven optimizations here and now, to cleanup the code. 1030 PM.add(createGlobalsAAWrapperPass()); // IP alias analysis. 1031 1032 PM.add(createLICMPass(LicmMssaOptCap, LicmMssaNoAccForPromotionCap)); 1033 PM.add(NewGVN ? createNewGVNPass() 1034 : createGVNPass(DisableGVNLoadPRE)); // Remove redundancies. 1035 PM.add(createMemCpyOptPass()); // Remove dead memcpys. 1036 1037 // Nuke dead stores. 1038 PM.add(createDeadStoreEliminationPass()); 1039 PM.add(createMergedLoadStoreMotionPass()); // Merge ld/st in diamonds. 1040 1041 // More loops are countable; try to optimize them. 1042 PM.add(createIndVarSimplifyPass()); 1043 PM.add(createLoopDeletionPass()); 1044 if (EnableLoopInterchange) 1045 PM.add(createLoopInterchangePass()); 1046 if (EnableLoopFlatten) 1047 PM.add(createLoopFlattenPass()); 1048 1049 // Unroll small loops 1050 PM.add(createSimpleLoopUnrollPass(OptLevel, DisableUnrollLoops, 1051 ForgetAllSCEVInLoopUnroll)); 1052 PM.add(createLoopVectorizePass(true, !LoopVectorize)); 1053 // The vectorizer may have significantly shortened a loop body; unroll again. 1054 PM.add(createLoopUnrollPass(OptLevel, DisableUnrollLoops, 1055 ForgetAllSCEVInLoopUnroll)); 1056 1057 PM.add(createWarnMissedTransformationsPass()); 1058 1059 // Now that we've optimized loops (in particular loop induction variables), 1060 // we may have exposed more scalar opportunities. Run parts of the scalar 1061 // optimizer again at this point. 1062 PM.add(createInstructionCombiningPass()); // Initial cleanup 1063 PM.add(createCFGSimplificationPass()); // if-convert 1064 PM.add(createSCCPPass()); // Propagate exposed constants 1065 PM.add(createInstructionCombiningPass()); // Clean up again 1066 PM.add(createBitTrackingDCEPass()); 1067 1068 // More scalar chains could be vectorized due to more alias information 1069 if (SLPVectorize) 1070 PM.add(createSLPVectorizerPass()); // Vectorize parallel scalar chains. 1071 1072 PM.add(createVectorCombinePass()); // Clean up partial vectorization. 1073 1074 // After vectorization, assume intrinsics may tell us more about pointer 1075 // alignments. 1076 PM.add(createAlignmentFromAssumptionsPass()); 1077 1078 // Cleanup and simplify the code after the scalar optimizations. 1079 PM.add(createInstructionCombiningPass()); 1080 addExtensionsToPM(EP_Peephole, PM); 1081 1082 PM.add(createJumpThreadingPass(/*FreezeSelectCond*/ true)); 1083 } 1084 1085 void PassManagerBuilder::addLateLTOOptimizationPasses( 1086 legacy::PassManagerBase &PM) { 1087 // See comment in the new PM for justification of scheduling splitting at 1088 // this stage (\ref buildLTODefaultPipeline). 1089 if (EnableHotColdSplit) 1090 PM.add(createHotColdSplittingPass()); 1091 1092 // Delete basic blocks, which optimization passes may have killed. 1093 PM.add(createCFGSimplificationPass()); 1094 1095 // Drop bodies of available externally objects to improve GlobalDCE. 1096 PM.add(createEliminateAvailableExternallyPass()); 1097 1098 // Now that we have optimized the program, discard unreachable functions. 1099 PM.add(createGlobalDCEPass()); 1100 1101 // FIXME: this is profitable (for compiler time) to do at -O0 too, but 1102 // currently it damages debug info. 1103 if (MergeFunctions) 1104 PM.add(createMergeFunctionsPass()); 1105 } 1106 1107 void PassManagerBuilder::populateThinLTOPassManager( 1108 legacy::PassManagerBase &PM) { 1109 PerformThinLTO = true; 1110 if (LibraryInfo) 1111 PM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo)); 1112 1113 if (VerifyInput) 1114 PM.add(createVerifierPass()); 1115 1116 if (ImportSummary) { 1117 // This pass imports type identifier resolutions for whole-program 1118 // devirtualization and CFI. It must run early because other passes may 1119 // disturb the specific instruction patterns that these passes look for, 1120 // creating dependencies on resolutions that may not appear in the summary. 1121 // 1122 // For example, GVN may transform the pattern assume(type.test) appearing in 1123 // two basic blocks into assume(phi(type.test, type.test)), which would 1124 // transform a dependency on a WPD resolution into a dependency on a type 1125 // identifier resolution for CFI. 1126 // 1127 // Also, WPD has access to more precise information than ICP and can 1128 // devirtualize more effectively, so it should operate on the IR first. 1129 PM.add(createWholeProgramDevirtPass(nullptr, ImportSummary)); 1130 PM.add(createLowerTypeTestsPass(nullptr, ImportSummary)); 1131 } 1132 1133 populateModulePassManager(PM); 1134 1135 if (VerifyOutput) 1136 PM.add(createVerifierPass()); 1137 PerformThinLTO = false; 1138 } 1139 1140 void PassManagerBuilder::populateLTOPassManager(legacy::PassManagerBase &PM) { 1141 if (LibraryInfo) 1142 PM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo)); 1143 1144 if (VerifyInput) 1145 PM.add(createVerifierPass()); 1146 1147 addExtensionsToPM(EP_FullLinkTimeOptimizationEarly, PM); 1148 1149 if (OptLevel != 0) 1150 addLTOOptimizationPasses(PM); 1151 else { 1152 // The whole-program-devirt pass needs to run at -O0 because only it knows 1153 // about the llvm.type.checked.load intrinsic: it needs to both lower the 1154 // intrinsic itself and handle it in the summary. 1155 PM.add(createWholeProgramDevirtPass(ExportSummary, nullptr)); 1156 } 1157 1158 // Create a function that performs CFI checks for cross-DSO calls with targets 1159 // in the current module. 1160 PM.add(createCrossDSOCFIPass()); 1161 1162 // Lower type metadata and the type.test intrinsic. This pass supports Clang's 1163 // control flow integrity mechanisms (-fsanitize=cfi*) and needs to run at 1164 // link time if CFI is enabled. The pass does nothing if CFI is disabled. 1165 PM.add(createLowerTypeTestsPass(ExportSummary, nullptr)); 1166 // Run a second time to clean up any type tests left behind by WPD for use 1167 // in ICP (which is performed earlier than this in the regular LTO pipeline). 1168 PM.add(createLowerTypeTestsPass(nullptr, nullptr, true)); 1169 1170 if (OptLevel != 0) 1171 addLateLTOOptimizationPasses(PM); 1172 1173 addExtensionsToPM(EP_FullLinkTimeOptimizationLast, PM); 1174 1175 if (VerifyOutput) 1176 PM.add(createVerifierPass()); 1177 } 1178 1179 LLVMPassManagerBuilderRef LLVMPassManagerBuilderCreate() { 1180 PassManagerBuilder *PMB = new PassManagerBuilder(); 1181 return wrap(PMB); 1182 } 1183 1184 void LLVMPassManagerBuilderDispose(LLVMPassManagerBuilderRef PMB) { 1185 PassManagerBuilder *Builder = unwrap(PMB); 1186 delete Builder; 1187 } 1188 1189 void 1190 LLVMPassManagerBuilderSetOptLevel(LLVMPassManagerBuilderRef PMB, 1191 unsigned OptLevel) { 1192 PassManagerBuilder *Builder = unwrap(PMB); 1193 Builder->OptLevel = OptLevel; 1194 } 1195 1196 void 1197 LLVMPassManagerBuilderSetSizeLevel(LLVMPassManagerBuilderRef PMB, 1198 unsigned SizeLevel) { 1199 PassManagerBuilder *Builder = unwrap(PMB); 1200 Builder->SizeLevel = SizeLevel; 1201 } 1202 1203 void 1204 LLVMPassManagerBuilderSetDisableUnitAtATime(LLVMPassManagerBuilderRef PMB, 1205 LLVMBool Value) { 1206 // NOTE: The DisableUnitAtATime switch has been removed. 1207 } 1208 1209 void 1210 LLVMPassManagerBuilderSetDisableUnrollLoops(LLVMPassManagerBuilderRef PMB, 1211 LLVMBool Value) { 1212 PassManagerBuilder *Builder = unwrap(PMB); 1213 Builder->DisableUnrollLoops = Value; 1214 } 1215 1216 void 1217 LLVMPassManagerBuilderSetDisableSimplifyLibCalls(LLVMPassManagerBuilderRef PMB, 1218 LLVMBool Value) { 1219 // NOTE: The simplify-libcalls pass has been removed. 1220 } 1221 1222 void 1223 LLVMPassManagerBuilderUseInlinerWithThreshold(LLVMPassManagerBuilderRef PMB, 1224 unsigned Threshold) { 1225 PassManagerBuilder *Builder = unwrap(PMB); 1226 Builder->Inliner = createFunctionInliningPass(Threshold); 1227 } 1228 1229 void 1230 LLVMPassManagerBuilderPopulateFunctionPassManager(LLVMPassManagerBuilderRef PMB, 1231 LLVMPassManagerRef PM) { 1232 PassManagerBuilder *Builder = unwrap(PMB); 1233 legacy::FunctionPassManager *FPM = unwrap<legacy::FunctionPassManager>(PM); 1234 Builder->populateFunctionPassManager(*FPM); 1235 } 1236 1237 void 1238 LLVMPassManagerBuilderPopulateModulePassManager(LLVMPassManagerBuilderRef PMB, 1239 LLVMPassManagerRef PM) { 1240 PassManagerBuilder *Builder = unwrap(PMB); 1241 legacy::PassManagerBase *MPM = unwrap(PM); 1242 Builder->populateModulePassManager(*MPM); 1243 } 1244 1245 void LLVMPassManagerBuilderPopulateLTOPassManager(LLVMPassManagerBuilderRef PMB, 1246 LLVMPassManagerRef PM, 1247 LLVMBool Internalize, 1248 LLVMBool RunInliner) { 1249 PassManagerBuilder *Builder = unwrap(PMB); 1250 legacy::PassManagerBase *LPM = unwrap(PM); 1251 1252 // A small backwards compatibility hack. populateLTOPassManager used to take 1253 // an RunInliner option. 1254 if (RunInliner && !Builder->Inliner) 1255 Builder->Inliner = createFunctionInliningPass(); 1256 1257 Builder->populateLTOPassManager(*LPM); 1258 } 1259