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 // Break up allocas that may now be splittable after loop unrolling. 463 MPM.add(createSROAPass()); 464 465 if (OptLevel > 1) { 466 MPM.add(createMergedLoadStoreMotionPass()); // Merge ld/st in diamonds 467 MPM.add(NewGVN ? createNewGVNPass() 468 : createGVNPass(DisableGVNLoadPRE)); // Remove redundancies 469 } 470 MPM.add(createMemCpyOptPass()); // Remove memcpy / form memset 471 MPM.add(createSCCPPass()); // Constant prop with SCCP 472 473 // Delete dead bit computations (instcombine runs after to fold away the dead 474 // computations, and then ADCE will run later to exploit any new DCE 475 // opportunities that creates). 476 MPM.add(createBitTrackingDCEPass()); // Delete dead bit computations 477 478 // Run instcombine after redundancy elimination to exploit opportunities 479 // opened up by them. 480 MPM.add(createInstructionCombiningPass()); 481 addExtensionsToPM(EP_Peephole, MPM); 482 if (OptLevel > 1) { 483 MPM.add(createJumpThreadingPass()); // Thread jumps 484 MPM.add(createCorrelatedValuePropagationPass()); 485 } 486 MPM.add(createAggressiveDCEPass()); // Delete dead instructions 487 488 // TODO: Investigate if this is too expensive at O1. 489 if (OptLevel > 1) { 490 MPM.add(createDeadStoreEliminationPass()); // Delete dead stores 491 MPM.add(createLICMPass(LicmMssaOptCap, LicmMssaNoAccForPromotionCap)); 492 } 493 494 addExtensionsToPM(EP_ScalarOptimizerLate, MPM); 495 496 if (RerollLoops) 497 MPM.add(createLoopRerollPass()); 498 499 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs 500 // Clean up after everything. 501 MPM.add(createInstructionCombiningPass()); 502 addExtensionsToPM(EP_Peephole, MPM); 503 504 if (EnableCHR && OptLevel >= 3 && 505 (!PGOInstrUse.empty() || !PGOSampleUse.empty() || EnablePGOCSInstrGen)) 506 MPM.add(createControlHeightReductionLegacyPass()); 507 } 508 509 void PassManagerBuilder::populateModulePassManager( 510 legacy::PassManagerBase &MPM) { 511 // Whether this is a default or *LTO pre-link pipeline. The FullLTO post-link 512 // is handled separately, so just check this is not the ThinLTO post-link. 513 bool DefaultOrPreLinkPipeline = !PerformThinLTO; 514 515 if (!PGOSampleUse.empty()) { 516 MPM.add(createPruneEHPass()); 517 // In ThinLTO mode, when flattened profile is used, all the available 518 // profile information will be annotated in PreLink phase so there is 519 // no need to load the profile again in PostLink. 520 if (!(FlattenedProfileUsed && PerformThinLTO)) 521 MPM.add(createSampleProfileLoaderPass(PGOSampleUse)); 522 } 523 524 // Allow forcing function attributes as a debugging and tuning aid. 525 MPM.add(createForceFunctionAttrsLegacyPass()); 526 527 // If all optimizations are disabled, just run the always-inline pass and, 528 // if enabled, the function merging pass. 529 if (OptLevel == 0) { 530 addPGOInstrPasses(MPM); 531 if (Inliner) { 532 MPM.add(Inliner); 533 Inliner = nullptr; 534 } 535 536 // FIXME: The BarrierNoopPass is a HACK! The inliner pass above implicitly 537 // creates a CGSCC pass manager, but we don't want to add extensions into 538 // that pass manager. To prevent this we insert a no-op module pass to reset 539 // the pass manager to get the same behavior as EP_OptimizerLast in non-O0 540 // builds. The function merging pass is 541 if (MergeFunctions) 542 MPM.add(createMergeFunctionsPass()); 543 else if (GlobalExtensionsNotEmpty() || !Extensions.empty()) 544 MPM.add(createBarrierNoopPass()); 545 546 if (PerformThinLTO) { 547 MPM.add(createLowerTypeTestsPass(nullptr, nullptr, true)); 548 // Drop available_externally and unreferenced globals. This is necessary 549 // with ThinLTO in order to avoid leaving undefined references to dead 550 // globals in the object file. 551 MPM.add(createEliminateAvailableExternallyPass()); 552 MPM.add(createGlobalDCEPass()); 553 } 554 555 addExtensionsToPM(EP_EnabledOnOptLevel0, MPM); 556 557 if (PrepareForLTO || PrepareForThinLTO) { 558 MPM.add(createCanonicalizeAliasesPass()); 559 // Rename anon globals to be able to export them in the summary. 560 // This has to be done after we add the extensions to the pass manager 561 // as there could be passes (e.g. Adddress sanitizer) which introduce 562 // new unnamed globals. 563 MPM.add(createNameAnonGlobalPass()); 564 } 565 return; 566 } 567 568 // Add LibraryInfo if we have some. 569 if (LibraryInfo) 570 MPM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo)); 571 572 addInitialAliasAnalysisPasses(MPM); 573 574 // For ThinLTO there are two passes of indirect call promotion. The 575 // first is during the compile phase when PerformThinLTO=false and 576 // intra-module indirect call targets are promoted. The second is during 577 // the ThinLTO backend when PerformThinLTO=true, when we promote imported 578 // inter-module indirect calls. For that we perform indirect call promotion 579 // earlier in the pass pipeline, here before globalopt. Otherwise imported 580 // available_externally functions look unreferenced and are removed. 581 if (PerformThinLTO) { 582 MPM.add(createPGOIndirectCallPromotionLegacyPass(/*InLTO = */ true, 583 !PGOSampleUse.empty())); 584 MPM.add(createLowerTypeTestsPass(nullptr, nullptr, true)); 585 } 586 587 // For SamplePGO in ThinLTO compile phase, we do not want to unroll loops 588 // as it will change the CFG too much to make the 2nd profile annotation 589 // in backend more difficult. 590 bool PrepareForThinLTOUsingPGOSampleProfile = 591 PrepareForThinLTO && !PGOSampleUse.empty(); 592 if (PrepareForThinLTOUsingPGOSampleProfile) 593 DisableUnrollLoops = true; 594 595 // Infer attributes about declarations if possible. 596 MPM.add(createInferFunctionAttrsLegacyPass()); 597 598 // Infer attributes on declarations, call sites, arguments, etc. 599 if (AttributorRun & AttributorRunOption::MODULE) 600 MPM.add(createAttributorLegacyPass()); 601 602 addExtensionsToPM(EP_ModuleOptimizerEarly, MPM); 603 604 if (OptLevel > 2) 605 MPM.add(createCallSiteSplittingPass()); 606 607 MPM.add(createIPSCCPPass()); // IP SCCP 608 MPM.add(createCalledValuePropagationPass()); 609 610 MPM.add(createGlobalOptimizerPass()); // Optimize out global vars 611 // Promote any localized global vars. 612 MPM.add(createPromoteMemoryToRegisterPass()); 613 614 MPM.add(createDeadArgEliminationPass()); // Dead argument elimination 615 616 MPM.add(createInstructionCombiningPass()); // Clean up after IPCP & DAE 617 addExtensionsToPM(EP_Peephole, MPM); 618 MPM.add(createCFGSimplificationPass()); // Clean up after IPCP & DAE 619 620 // For SamplePGO in ThinLTO compile phase, we do not want to do indirect 621 // call promotion as it will change the CFG too much to make the 2nd 622 // profile annotation in backend more difficult. 623 // PGO instrumentation is added during the compile phase for ThinLTO, do 624 // not run it a second time 625 if (DefaultOrPreLinkPipeline && !PrepareForThinLTOUsingPGOSampleProfile) 626 addPGOInstrPasses(MPM); 627 628 // Create profile COMDAT variables. Lld linker wants to see all variables 629 // before the LTO/ThinLTO link since it needs to resolve symbols/comdats. 630 if (!PerformThinLTO && EnablePGOCSInstrGen) 631 MPM.add(createPGOInstrumentationGenCreateVarLegacyPass(PGOInstrGen)); 632 633 // We add a module alias analysis pass here. In part due to bugs in the 634 // analysis infrastructure this "works" in that the analysis stays alive 635 // for the entire SCC pass run below. 636 MPM.add(createGlobalsAAWrapperPass()); 637 638 // Start of CallGraph SCC passes. 639 MPM.add(createPruneEHPass()); // Remove dead EH info 640 bool RunInliner = false; 641 if (Inliner) { 642 MPM.add(Inliner); 643 Inliner = nullptr; 644 RunInliner = true; 645 } 646 647 // Infer attributes on declarations, call sites, arguments, etc. for an SCC. 648 if (AttributorRun & AttributorRunOption::CGSCC) 649 MPM.add(createAttributorCGSCCLegacyPass()); 650 651 // Try to perform OpenMP specific optimizations. This is a (quick!) no-op if 652 // there are no OpenMP runtime calls present in the module. 653 if (OptLevel > 1) 654 MPM.add(createOpenMPOptLegacyPass()); 655 656 MPM.add(createPostOrderFunctionAttrsLegacyPass()); 657 if (OptLevel > 2) 658 MPM.add(createArgumentPromotionPass()); // Scalarize uninlined fn args 659 660 addExtensionsToPM(EP_CGSCCOptimizerLate, MPM); 661 addFunctionSimplificationPasses(MPM); 662 663 // FIXME: This is a HACK! The inliner pass above implicitly creates a CGSCC 664 // pass manager that we are specifically trying to avoid. To prevent this 665 // we must insert a no-op module pass to reset the pass manager. 666 MPM.add(createBarrierNoopPass()); 667 668 if (RunPartialInlining) 669 MPM.add(createPartialInliningPass()); 670 671 if (OptLevel > 1 && !PrepareForLTO && !PrepareForThinLTO) 672 // Remove avail extern fns and globals definitions if we aren't 673 // compiling an object file for later LTO. For LTO we want to preserve 674 // these so they are eligible for inlining at link-time. Note if they 675 // are unreferenced they will be removed by GlobalDCE later, so 676 // this only impacts referenced available externally globals. 677 // Eventually they will be suppressed during codegen, but eliminating 678 // here enables more opportunity for GlobalDCE as it may make 679 // globals referenced by available external functions dead 680 // and saves running remaining passes on the eliminated functions. 681 MPM.add(createEliminateAvailableExternallyPass()); 682 683 // CSFDO instrumentation and use pass. Don't invoke this for Prepare pass 684 // for LTO and ThinLTO -- The actual pass will be called after all inlines 685 // are performed. 686 // Need to do this after COMDAT variables have been eliminated, 687 // (i.e. after EliminateAvailableExternallyPass). 688 if (!(PrepareForLTO || PrepareForThinLTO)) 689 addPGOInstrPasses(MPM, /* IsCS */ true); 690 691 if (EnableOrderFileInstrumentation) 692 MPM.add(createInstrOrderFilePass()); 693 694 MPM.add(createReversePostOrderFunctionAttrsPass()); 695 696 // The inliner performs some kind of dead code elimination as it goes, 697 // but there are cases that are not really caught by it. We might 698 // at some point consider teaching the inliner about them, but it 699 // is OK for now to run GlobalOpt + GlobalDCE in tandem as their 700 // benefits generally outweight the cost, making the whole pipeline 701 // faster. 702 if (RunInliner) { 703 MPM.add(createGlobalOptimizerPass()); 704 MPM.add(createGlobalDCEPass()); 705 } 706 707 // If we are planning to perform ThinLTO later, let's not bloat the code with 708 // unrolling/vectorization/... now. We'll first run the inliner + CGSCC passes 709 // during ThinLTO and perform the rest of the optimizations afterward. 710 if (PrepareForThinLTO) { 711 // Ensure we perform any last passes, but do so before renaming anonymous 712 // globals in case the passes add any. 713 addExtensionsToPM(EP_OptimizerLast, MPM); 714 MPM.add(createCanonicalizeAliasesPass()); 715 // Rename anon globals to be able to export them in the summary. 716 MPM.add(createNameAnonGlobalPass()); 717 return; 718 } 719 720 if (PerformThinLTO) 721 // Optimize globals now when performing ThinLTO, this enables more 722 // optimizations later. 723 MPM.add(createGlobalOptimizerPass()); 724 725 // Scheduling LoopVersioningLICM when inlining is over, because after that 726 // we may see more accurate aliasing. Reason to run this late is that too 727 // early versioning may prevent further inlining due to increase of code 728 // size. By placing it just after inlining other optimizations which runs 729 // later might get benefit of no-alias assumption in clone loop. 730 if (UseLoopVersioningLICM) { 731 MPM.add(createLoopVersioningLICMPass()); // Do LoopVersioningLICM 732 MPM.add(createLICMPass(LicmMssaOptCap, LicmMssaNoAccForPromotionCap)); 733 } 734 735 // We add a fresh GlobalsModRef run at this point. This is particularly 736 // useful as the above will have inlined, DCE'ed, and function-attr 737 // propagated everything. We should at this point have a reasonably minimal 738 // and richly annotated call graph. By computing aliasing and mod/ref 739 // information for all local globals here, the late loop passes and notably 740 // the vectorizer will be able to use them to help recognize vectorizable 741 // memory operations. 742 // 743 // Note that this relies on a bug in the pass manager which preserves 744 // a module analysis into a function pass pipeline (and throughout it) so 745 // long as the first function pass doesn't invalidate the module analysis. 746 // Thus both Float2Int and LoopRotate have to preserve AliasAnalysis for 747 // this to work. Fortunately, it is trivial to preserve AliasAnalysis 748 // (doing nothing preserves it as it is required to be conservatively 749 // correct in the face of IR changes). 750 MPM.add(createGlobalsAAWrapperPass()); 751 752 MPM.add(createFloat2IntPass()); 753 MPM.add(createLowerConstantIntrinsicsPass()); 754 755 if (EnableMatrix) { 756 MPM.add(createLowerMatrixIntrinsicsPass()); 757 // CSE the pointer arithmetic of the column vectors. This allows alias 758 // analysis to establish no-aliasing between loads and stores of different 759 // columns of the same matrix. 760 MPM.add(createEarlyCSEPass(false)); 761 } 762 763 addExtensionsToPM(EP_VectorizerStart, MPM); 764 765 // Re-rotate loops in all our loop nests. These may have fallout out of 766 // rotated form due to GVN or other transformations, and the vectorizer relies 767 // on the rotated form. Disable header duplication at -Oz. 768 MPM.add(createLoopRotatePass(SizeLevel == 2 ? 0 : -1)); 769 770 // Distribute loops to allow partial vectorization. I.e. isolate dependences 771 // into separate loop that would otherwise inhibit vectorization. This is 772 // currently only performed for loops marked with the metadata 773 // llvm.loop.distribute=true or when -enable-loop-distribute is specified. 774 MPM.add(createLoopDistributePass()); 775 776 MPM.add(createLoopVectorizePass(!LoopsInterleaved, !LoopVectorize)); 777 778 // Eliminate loads by forwarding stores from the previous iteration to loads 779 // of the current iteration. 780 MPM.add(createLoopLoadEliminationPass()); 781 782 // FIXME: Because of #pragma vectorize enable, the passes below are always 783 // inserted in the pipeline, even when the vectorizer doesn't run (ex. when 784 // on -O1 and no #pragma is found). Would be good to have these two passes 785 // as function calls, so that we can only pass them when the vectorizer 786 // changed the code. 787 MPM.add(createInstructionCombiningPass()); 788 if (OptLevel > 1 && ExtraVectorizerPasses) { 789 // At higher optimization levels, try to clean up any runtime overlap and 790 // alignment checks inserted by the vectorizer. We want to track correllated 791 // runtime checks for two inner loops in the same outer loop, fold any 792 // common computations, hoist loop-invariant aspects out of any outer loop, 793 // and unswitch the runtime checks if possible. Once hoisted, we may have 794 // dead (or speculatable) control flows or more combining opportunities. 795 MPM.add(createEarlyCSEPass()); 796 MPM.add(createCorrelatedValuePropagationPass()); 797 MPM.add(createInstructionCombiningPass()); 798 MPM.add(createLICMPass(LicmMssaOptCap, LicmMssaNoAccForPromotionCap)); 799 MPM.add(createLoopUnswitchPass(SizeLevel || OptLevel < 3, DivergentTarget)); 800 MPM.add(createCFGSimplificationPass()); 801 MPM.add(createInstructionCombiningPass()); 802 } 803 804 // Cleanup after loop vectorization, etc. Simplification passes like CVP and 805 // GVN, loop transforms, and others have already run, so it's now better to 806 // convert to more optimized IR using more aggressive simplify CFG options. 807 // The extra sinking transform can create larger basic blocks, so do this 808 // before SLP vectorization. 809 // FIXME: study whether hoisting and/or sinking of common instructions should 810 // be delayed until after SLP vectorizer. 811 MPM.add(createCFGSimplificationPass(SimplifyCFGOptions() 812 .forwardSwitchCondToPhi(true) 813 .convertSwitchToLookupTable(true) 814 .needCanonicalLoops(false) 815 .hoistCommonInsts(true) 816 .sinkCommonInsts(true))); 817 818 if (SLPVectorize) { 819 MPM.add(createSLPVectorizerPass()); // Vectorize parallel scalar chains. 820 if (OptLevel > 1 && ExtraVectorizerPasses) { 821 MPM.add(createEarlyCSEPass()); 822 } 823 } 824 825 // Enhance/cleanup vector code. 826 MPM.add(createVectorCombinePass()); 827 828 addExtensionsToPM(EP_Peephole, MPM); 829 MPM.add(createInstructionCombiningPass()); 830 831 if (EnableUnrollAndJam && !DisableUnrollLoops) { 832 // Unroll and Jam. We do this before unroll but need to be in a separate 833 // loop pass manager in order for the outer loop to be processed by 834 // unroll and jam before the inner loop is unrolled. 835 MPM.add(createLoopUnrollAndJamPass(OptLevel)); 836 } 837 838 // Unroll small loops 839 MPM.add(createLoopUnrollPass(OptLevel, DisableUnrollLoops, 840 ForgetAllSCEVInLoopUnroll)); 841 842 if (!DisableUnrollLoops) { 843 // LoopUnroll may generate some redundency to cleanup. 844 MPM.add(createInstructionCombiningPass()); 845 846 // Runtime unrolling will introduce runtime check in loop prologue. If the 847 // unrolled loop is a inner loop, then the prologue will be inside the 848 // outer loop. LICM pass can help to promote the runtime check out if the 849 // checked value is loop invariant. 850 MPM.add(createLICMPass(LicmMssaOptCap, LicmMssaNoAccForPromotionCap)); 851 } 852 853 MPM.add(createWarnMissedTransformationsPass()); 854 855 // After vectorization and unrolling, assume intrinsics may tell us more 856 // about pointer alignments. 857 MPM.add(createAlignmentFromAssumptionsPass()); 858 859 // FIXME: We shouldn't bother with this anymore. 860 MPM.add(createStripDeadPrototypesPass()); // Get rid of dead prototypes 861 862 // GlobalOpt already deletes dead functions and globals, at -O2 try a 863 // late pass of GlobalDCE. It is capable of deleting dead cycles. 864 if (OptLevel > 1) { 865 MPM.add(createGlobalDCEPass()); // Remove dead fns and globals. 866 MPM.add(createConstantMergePass()); // Merge dup global constants 867 } 868 869 // See comment in the new PM for justification of scheduling splitting at 870 // this stage (\ref buildModuleSimplificationPipeline). 871 if (EnableHotColdSplit && !(PrepareForLTO || PrepareForThinLTO)) 872 MPM.add(createHotColdSplittingPass()); 873 874 if (MergeFunctions) 875 MPM.add(createMergeFunctionsPass()); 876 877 // Add Module flag "CG Profile" based on Branch Frequency Information. 878 if (CallGraphProfile) 879 MPM.add(createCGProfileLegacyPass()); 880 881 // LoopSink pass sinks instructions hoisted by LICM, which serves as a 882 // canonicalization pass that enables other optimizations. As a result, 883 // LoopSink pass needs to be a very late IR pass to avoid undoing LICM 884 // result too early. 885 MPM.add(createLoopSinkPass()); 886 // Get rid of LCSSA nodes. 887 MPM.add(createInstSimplifyLegacyPass()); 888 889 // This hoists/decomposes div/rem ops. It should run after other sink/hoist 890 // passes to avoid re-sinking, but before SimplifyCFG because it can allow 891 // flattening of blocks. 892 MPM.add(createDivRemPairsPass()); 893 894 // LoopSink (and other loop passes since the last simplifyCFG) might have 895 // resulted in single-entry-single-exit or empty blocks. Clean up the CFG. 896 MPM.add(createCFGSimplificationPass()); 897 898 addExtensionsToPM(EP_OptimizerLast, MPM); 899 900 if (PrepareForLTO) { 901 MPM.add(createCanonicalizeAliasesPass()); 902 // Rename anon globals to be able to handle them in the summary 903 MPM.add(createNameAnonGlobalPass()); 904 } 905 } 906 907 void PassManagerBuilder::addLTOOptimizationPasses(legacy::PassManagerBase &PM) { 908 // Load sample profile before running the LTO optimization pipeline. 909 if (!PGOSampleUse.empty()) { 910 PM.add(createPruneEHPass()); 911 PM.add(createSampleProfileLoaderPass(PGOSampleUse)); 912 } 913 914 // Remove unused virtual tables to improve the quality of code generated by 915 // whole-program devirtualization and bitset lowering. 916 PM.add(createGlobalDCEPass()); 917 918 // Provide AliasAnalysis services for optimizations. 919 addInitialAliasAnalysisPasses(PM); 920 921 // Allow forcing function attributes as a debugging and tuning aid. 922 PM.add(createForceFunctionAttrsLegacyPass()); 923 924 // Infer attributes about declarations if possible. 925 PM.add(createInferFunctionAttrsLegacyPass()); 926 927 if (OptLevel > 1) { 928 // Split call-site with more constrained arguments. 929 PM.add(createCallSiteSplittingPass()); 930 931 // Indirect call promotion. This should promote all the targets that are 932 // left by the earlier promotion pass that promotes intra-module targets. 933 // This two-step promotion is to save the compile time. For LTO, it should 934 // produce the same result as if we only do promotion here. 935 PM.add( 936 createPGOIndirectCallPromotionLegacyPass(true, !PGOSampleUse.empty())); 937 938 // Propagate constants at call sites into the functions they call. This 939 // opens opportunities for globalopt (and inlining) by substituting function 940 // pointers passed as arguments to direct uses of functions. 941 PM.add(createIPSCCPPass()); 942 943 // Attach metadata to indirect call sites indicating the set of functions 944 // they may target at run-time. This should follow IPSCCP. 945 PM.add(createCalledValuePropagationPass()); 946 947 // Infer attributes on declarations, call sites, arguments, etc. 948 if (AttributorRun & AttributorRunOption::MODULE) 949 PM.add(createAttributorLegacyPass()); 950 } 951 952 // Infer attributes about definitions. The readnone attribute in particular is 953 // required for virtual constant propagation. 954 PM.add(createPostOrderFunctionAttrsLegacyPass()); 955 PM.add(createReversePostOrderFunctionAttrsPass()); 956 957 // Split globals using inrange annotations on GEP indices. This can help 958 // improve the quality of generated code when virtual constant propagation or 959 // control flow integrity are enabled. 960 PM.add(createGlobalSplitPass()); 961 962 // Apply whole-program devirtualization and virtual constant propagation. 963 PM.add(createWholeProgramDevirtPass(ExportSummary, nullptr)); 964 965 // That's all we need at opt level 1. 966 if (OptLevel == 1) 967 return; 968 969 // Now that we internalized some globals, see if we can hack on them! 970 PM.add(createGlobalOptimizerPass()); 971 // Promote any localized global vars. 972 PM.add(createPromoteMemoryToRegisterPass()); 973 974 // Linking modules together can lead to duplicated global constants, only 975 // keep one copy of each constant. 976 PM.add(createConstantMergePass()); 977 978 // Remove unused arguments from functions. 979 PM.add(createDeadArgEliminationPass()); 980 981 // Reduce the code after globalopt and ipsccp. Both can open up significant 982 // simplification opportunities, and both can propagate functions through 983 // function pointers. When this happens, we often have to resolve varargs 984 // calls, etc, so let instcombine do this. 985 if (OptLevel > 2) 986 PM.add(createAggressiveInstCombinerPass()); 987 PM.add(createInstructionCombiningPass()); 988 addExtensionsToPM(EP_Peephole, PM); 989 990 // Inline small functions 991 bool RunInliner = Inliner; 992 if (RunInliner) { 993 PM.add(Inliner); 994 Inliner = nullptr; 995 } 996 997 PM.add(createPruneEHPass()); // Remove dead EH info. 998 999 // CSFDO instrumentation and use pass. 1000 addPGOInstrPasses(PM, /* IsCS */ true); 1001 1002 // Infer attributes on declarations, call sites, arguments, etc. for an SCC. 1003 if (AttributorRun & AttributorRunOption::CGSCC) 1004 PM.add(createAttributorCGSCCLegacyPass()); 1005 1006 // Try to perform OpenMP specific optimizations. This is a (quick!) no-op if 1007 // there are no OpenMP runtime calls present in the module. 1008 if (OptLevel > 1) 1009 PM.add(createOpenMPOptLegacyPass()); 1010 1011 // Optimize globals again if we ran the inliner. 1012 if (RunInliner) 1013 PM.add(createGlobalOptimizerPass()); 1014 PM.add(createGlobalDCEPass()); // Remove dead functions. 1015 1016 // If we didn't decide to inline a function, check to see if we can 1017 // transform it to pass arguments by value instead of by reference. 1018 PM.add(createArgumentPromotionPass()); 1019 1020 // The IPO passes may leave cruft around. Clean up after them. 1021 PM.add(createInstructionCombiningPass()); 1022 addExtensionsToPM(EP_Peephole, PM); 1023 PM.add(createJumpThreadingPass(/*FreezeSelectCond*/ true)); 1024 1025 // Break up allocas 1026 PM.add(createSROAPass()); 1027 1028 // LTO provides additional opportunities for tailcall elimination due to 1029 // link-time inlining, and visibility of nocapture attribute. 1030 if (OptLevel > 1) 1031 PM.add(createTailCallEliminationPass()); 1032 1033 // Infer attributes on declarations, call sites, arguments, etc. 1034 PM.add(createPostOrderFunctionAttrsLegacyPass()); // Add nocapture. 1035 // Run a few AA driven optimizations here and now, to cleanup the code. 1036 PM.add(createGlobalsAAWrapperPass()); // IP alias analysis. 1037 1038 PM.add(createLICMPass(LicmMssaOptCap, LicmMssaNoAccForPromotionCap)); 1039 PM.add(NewGVN ? createNewGVNPass() 1040 : createGVNPass(DisableGVNLoadPRE)); // Remove redundancies. 1041 PM.add(createMemCpyOptPass()); // Remove dead memcpys. 1042 1043 // Nuke dead stores. 1044 PM.add(createDeadStoreEliminationPass()); 1045 PM.add(createMergedLoadStoreMotionPass()); // Merge ld/st in diamonds. 1046 1047 // More loops are countable; try to optimize them. 1048 PM.add(createIndVarSimplifyPass()); 1049 PM.add(createLoopDeletionPass()); 1050 if (EnableLoopInterchange) 1051 PM.add(createLoopInterchangePass()); 1052 if (EnableLoopFlatten) 1053 PM.add(createLoopFlattenPass()); 1054 1055 // Unroll small loops 1056 PM.add(createSimpleLoopUnrollPass(OptLevel, DisableUnrollLoops, 1057 ForgetAllSCEVInLoopUnroll)); 1058 PM.add(createLoopVectorizePass(true, !LoopVectorize)); 1059 // The vectorizer may have significantly shortened a loop body; unroll again. 1060 PM.add(createLoopUnrollPass(OptLevel, DisableUnrollLoops, 1061 ForgetAllSCEVInLoopUnroll)); 1062 1063 PM.add(createWarnMissedTransformationsPass()); 1064 1065 // Now that we've optimized loops (in particular loop induction variables), 1066 // we may have exposed more scalar opportunities. Run parts of the scalar 1067 // optimizer again at this point. 1068 PM.add(createInstructionCombiningPass()); // Initial cleanup 1069 PM.add(createCFGSimplificationPass()); // if-convert 1070 PM.add(createSCCPPass()); // Propagate exposed constants 1071 PM.add(createInstructionCombiningPass()); // Clean up again 1072 PM.add(createBitTrackingDCEPass()); 1073 1074 // More scalar chains could be vectorized due to more alias information 1075 if (SLPVectorize) 1076 PM.add(createSLPVectorizerPass()); // Vectorize parallel scalar chains. 1077 1078 PM.add(createVectorCombinePass()); // Clean up partial vectorization. 1079 1080 // After vectorization, assume intrinsics may tell us more about pointer 1081 // alignments. 1082 PM.add(createAlignmentFromAssumptionsPass()); 1083 1084 // Cleanup and simplify the code after the scalar optimizations. 1085 PM.add(createInstructionCombiningPass()); 1086 addExtensionsToPM(EP_Peephole, PM); 1087 1088 PM.add(createJumpThreadingPass(/*FreezeSelectCond*/ true)); 1089 } 1090 1091 void PassManagerBuilder::addLateLTOOptimizationPasses( 1092 legacy::PassManagerBase &PM) { 1093 // See comment in the new PM for justification of scheduling splitting at 1094 // this stage (\ref buildLTODefaultPipeline). 1095 if (EnableHotColdSplit) 1096 PM.add(createHotColdSplittingPass()); 1097 1098 // Delete basic blocks, which optimization passes may have killed. 1099 PM.add(createCFGSimplificationPass()); 1100 1101 // Drop bodies of available externally objects to improve GlobalDCE. 1102 PM.add(createEliminateAvailableExternallyPass()); 1103 1104 // Now that we have optimized the program, discard unreachable functions. 1105 PM.add(createGlobalDCEPass()); 1106 1107 // FIXME: this is profitable (for compiler time) to do at -O0 too, but 1108 // currently it damages debug info. 1109 if (MergeFunctions) 1110 PM.add(createMergeFunctionsPass()); 1111 } 1112 1113 void PassManagerBuilder::populateThinLTOPassManager( 1114 legacy::PassManagerBase &PM) { 1115 PerformThinLTO = true; 1116 if (LibraryInfo) 1117 PM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo)); 1118 1119 if (VerifyInput) 1120 PM.add(createVerifierPass()); 1121 1122 if (ImportSummary) { 1123 // This pass imports type identifier resolutions for whole-program 1124 // devirtualization and CFI. It must run early because other passes may 1125 // disturb the specific instruction patterns that these passes look for, 1126 // creating dependencies on resolutions that may not appear in the summary. 1127 // 1128 // For example, GVN may transform the pattern assume(type.test) appearing in 1129 // two basic blocks into assume(phi(type.test, type.test)), which would 1130 // transform a dependency on a WPD resolution into a dependency on a type 1131 // identifier resolution for CFI. 1132 // 1133 // Also, WPD has access to more precise information than ICP and can 1134 // devirtualize more effectively, so it should operate on the IR first. 1135 PM.add(createWholeProgramDevirtPass(nullptr, ImportSummary)); 1136 PM.add(createLowerTypeTestsPass(nullptr, ImportSummary)); 1137 } 1138 1139 populateModulePassManager(PM); 1140 1141 if (VerifyOutput) 1142 PM.add(createVerifierPass()); 1143 PerformThinLTO = false; 1144 } 1145 1146 void PassManagerBuilder::populateLTOPassManager(legacy::PassManagerBase &PM) { 1147 if (LibraryInfo) 1148 PM.add(new TargetLibraryInfoWrapperPass(*LibraryInfo)); 1149 1150 if (VerifyInput) 1151 PM.add(createVerifierPass()); 1152 1153 addExtensionsToPM(EP_FullLinkTimeOptimizationEarly, PM); 1154 1155 if (OptLevel != 0) 1156 addLTOOptimizationPasses(PM); 1157 else { 1158 // The whole-program-devirt pass needs to run at -O0 because only it knows 1159 // about the llvm.type.checked.load intrinsic: it needs to both lower the 1160 // intrinsic itself and handle it in the summary. 1161 PM.add(createWholeProgramDevirtPass(ExportSummary, nullptr)); 1162 } 1163 1164 // Create a function that performs CFI checks for cross-DSO calls with targets 1165 // in the current module. 1166 PM.add(createCrossDSOCFIPass()); 1167 1168 // Lower type metadata and the type.test intrinsic. This pass supports Clang's 1169 // control flow integrity mechanisms (-fsanitize=cfi*) and needs to run at 1170 // link time if CFI is enabled. The pass does nothing if CFI is disabled. 1171 PM.add(createLowerTypeTestsPass(ExportSummary, nullptr)); 1172 // Run a second time to clean up any type tests left behind by WPD for use 1173 // in ICP (which is performed earlier than this in the regular LTO pipeline). 1174 PM.add(createLowerTypeTestsPass(nullptr, nullptr, true)); 1175 1176 if (OptLevel != 0) 1177 addLateLTOOptimizationPasses(PM); 1178 1179 addExtensionsToPM(EP_FullLinkTimeOptimizationLast, PM); 1180 1181 if (VerifyOutput) 1182 PM.add(createVerifierPass()); 1183 } 1184 1185 LLVMPassManagerBuilderRef LLVMPassManagerBuilderCreate() { 1186 PassManagerBuilder *PMB = new PassManagerBuilder(); 1187 return wrap(PMB); 1188 } 1189 1190 void LLVMPassManagerBuilderDispose(LLVMPassManagerBuilderRef PMB) { 1191 PassManagerBuilder *Builder = unwrap(PMB); 1192 delete Builder; 1193 } 1194 1195 void 1196 LLVMPassManagerBuilderSetOptLevel(LLVMPassManagerBuilderRef PMB, 1197 unsigned OptLevel) { 1198 PassManagerBuilder *Builder = unwrap(PMB); 1199 Builder->OptLevel = OptLevel; 1200 } 1201 1202 void 1203 LLVMPassManagerBuilderSetSizeLevel(LLVMPassManagerBuilderRef PMB, 1204 unsigned SizeLevel) { 1205 PassManagerBuilder *Builder = unwrap(PMB); 1206 Builder->SizeLevel = SizeLevel; 1207 } 1208 1209 void 1210 LLVMPassManagerBuilderSetDisableUnitAtATime(LLVMPassManagerBuilderRef PMB, 1211 LLVMBool Value) { 1212 // NOTE: The DisableUnitAtATime switch has been removed. 1213 } 1214 1215 void 1216 LLVMPassManagerBuilderSetDisableUnrollLoops(LLVMPassManagerBuilderRef PMB, 1217 LLVMBool Value) { 1218 PassManagerBuilder *Builder = unwrap(PMB); 1219 Builder->DisableUnrollLoops = Value; 1220 } 1221 1222 void 1223 LLVMPassManagerBuilderSetDisableSimplifyLibCalls(LLVMPassManagerBuilderRef PMB, 1224 LLVMBool Value) { 1225 // NOTE: The simplify-libcalls pass has been removed. 1226 } 1227 1228 void 1229 LLVMPassManagerBuilderUseInlinerWithThreshold(LLVMPassManagerBuilderRef PMB, 1230 unsigned Threshold) { 1231 PassManagerBuilder *Builder = unwrap(PMB); 1232 Builder->Inliner = createFunctionInliningPass(Threshold); 1233 } 1234 1235 void 1236 LLVMPassManagerBuilderPopulateFunctionPassManager(LLVMPassManagerBuilderRef PMB, 1237 LLVMPassManagerRef PM) { 1238 PassManagerBuilder *Builder = unwrap(PMB); 1239 legacy::FunctionPassManager *FPM = unwrap<legacy::FunctionPassManager>(PM); 1240 Builder->populateFunctionPassManager(*FPM); 1241 } 1242 1243 void 1244 LLVMPassManagerBuilderPopulateModulePassManager(LLVMPassManagerBuilderRef PMB, 1245 LLVMPassManagerRef PM) { 1246 PassManagerBuilder *Builder = unwrap(PMB); 1247 legacy::PassManagerBase *MPM = unwrap(PM); 1248 Builder->populateModulePassManager(*MPM); 1249 } 1250 1251 void LLVMPassManagerBuilderPopulateLTOPassManager(LLVMPassManagerBuilderRef PMB, 1252 LLVMPassManagerRef PM, 1253 LLVMBool Internalize, 1254 LLVMBool RunInliner) { 1255 PassManagerBuilder *Builder = unwrap(PMB); 1256 legacy::PassManagerBase *LPM = unwrap(PM); 1257 1258 // A small backwards compatibility hack. populateLTOPassManager used to take 1259 // an RunInliner option. 1260 if (RunInliner && !Builder->Inliner) 1261 Builder->Inliner = createFunctionInliningPass(); 1262 1263 Builder->populateLTOPassManager(*LPM); 1264 } 1265