contrib/llvm/lib/CodeGen/TargetPassConfig.cpp

   1 //===-- TargetPassConfig.cpp - Target independent code generation passes --===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines interfaces to access the target independent code
  11 // generation passes provided by the LLVM backend.
  12 //
  13 //===---------------------------------------------------------------------===//
  14
  15 #include "llvm/CodeGen/TargetPassConfig.h"
  16
  17 #include "llvm/Analysis/BasicAliasAnalysis.h"
  18 #include "llvm/Analysis/CFLAndersAliasAnalysis.h"
  19 #include "llvm/Analysis/CFLSteensAliasAnalysis.h"
  20 #include "llvm/Analysis/CallGraphSCCPass.h"
  21 #include "llvm/Analysis/Passes.h"
  22 #include "llvm/Analysis/ScopedNoAliasAA.h"
  23 #include "llvm/Analysis/TypeBasedAliasAnalysis.h"
  24 #include "llvm/CodeGen/MachineFunctionPass.h"
  25 #include "llvm/CodeGen/RegAllocRegistry.h"
  26 #include "llvm/CodeGen/RegisterUsageInfo.h"
  27 #include "llvm/IR/IRPrintingPasses.h"
  28 #include "llvm/IR/LegacyPassManager.h"
  29 #include "llvm/IR/Verifier.h"
  30 #include "llvm/MC/MCAsmInfo.h"
  31 #include "llvm/Support/Debug.h"
  32 #include "llvm/Support/ErrorHandling.h"
  33 #include "llvm/Support/raw_ostream.h"
  34 #include "llvm/Target/TargetMachine.h"
  35 #include "llvm/Transforms/Instrumentation.h"
  36 #include "llvm/Transforms/Scalar.h"
  37 #include "llvm/Transforms/Utils/SymbolRewriter.h"
  38
  39 using namespace llvm;
  40
  41 static cl::opt<bool> DisablePostRASched("disable-post-ra", cl::Hidden,
  42     cl::desc("Disable Post Regalloc Scheduler"));
  43 static cl::opt<bool> DisableBranchFold("disable-branch-fold", cl::Hidden,
  44     cl::desc("Disable branch folding"));
  45 static cl::opt<bool> DisableTailDuplicate("disable-tail-duplicate", cl::Hidden,
  46     cl::desc("Disable tail duplication"));
  47 static cl::opt<bool> DisableEarlyTailDup("disable-early-taildup", cl::Hidden,
  48     cl::desc("Disable pre-register allocation tail duplication"));
  49 static cl::opt<bool> DisableBlockPlacement("disable-block-placement",
  50     cl::Hidden, cl::desc("Disable probability-driven block placement"));
  51 static cl::opt<bool> EnableBlockPlacementStats("enable-block-placement-stats",
  52     cl::Hidden, cl::desc("Collect probability-driven block placement stats"));
  53 static cl::opt<bool> DisableSSC("disable-ssc", cl::Hidden,
  54     cl::desc("Disable Stack Slot Coloring"));
  55 static cl::opt<bool> DisableMachineDCE("disable-machine-dce", cl::Hidden,
  56     cl::desc("Disable Machine Dead Code Elimination"));
  57 static cl::opt<bool> DisableEarlyIfConversion("disable-early-ifcvt", cl::Hidden,
  58     cl::desc("Disable Early If-conversion"));
  59 static cl::opt<bool> DisableMachineLICM("disable-machine-licm", cl::Hidden,
  60     cl::desc("Disable Machine LICM"));
  61 static cl::opt<bool> DisableMachineCSE("disable-machine-cse", cl::Hidden,
  62     cl::desc("Disable Machine Common Subexpression Elimination"));
  63 static cl::opt<cl::boolOrDefault> OptimizeRegAlloc(
  64     "optimize-regalloc", cl::Hidden,
  65     cl::desc("Enable optimized register allocation compilation path."));
  66 static cl::opt<bool> DisablePostRAMachineLICM("disable-postra-machine-licm",
  67     cl::Hidden,
  68     cl::desc("Disable Machine LICM"));
  69 static cl::opt<bool> DisableMachineSink("disable-machine-sink", cl::Hidden,
  70     cl::desc("Disable Machine Sinking"));
  71 static cl::opt<bool> DisableLSR("disable-lsr", cl::Hidden,
  72     cl::desc("Disable Loop Strength Reduction Pass"));
  73 static cl::opt<bool> DisableConstantHoisting("disable-constant-hoisting",
  74     cl::Hidden, cl::desc("Disable ConstantHoisting"));
  75 static cl::opt<bool> DisableCGP("disable-cgp", cl::Hidden,
  76     cl::desc("Disable Codegen Prepare"));
  77 static cl::opt<bool> DisableCopyProp("disable-copyprop", cl::Hidden,
  78     cl::desc("Disable Copy Propagation pass"));
  79 static cl::opt<bool> DisablePartialLibcallInlining("disable-partial-libcall-inlining",
  80     cl::Hidden, cl::desc("Disable Partial Libcall Inlining"));
  81 static cl::opt<bool> EnableImplicitNullChecks(
  82     "enable-implicit-null-checks",
  83     cl::desc("Fold null checks into faulting memory operations"),
  84     cl::init(false));
  85 static cl::opt<bool> PrintLSR("print-lsr-output", cl::Hidden,
  86     cl::desc("Print LLVM IR produced by the loop-reduce pass"));
  87 static cl::opt<bool> PrintISelInput("print-isel-input", cl::Hidden,
  88     cl::desc("Print LLVM IR input to isel pass"));
  89 static cl::opt<bool> PrintGCInfo("print-gc", cl::Hidden,
  90     cl::desc("Dump garbage collector data"));
  91 static cl::opt<bool> VerifyMachineCode("verify-machineinstrs", cl::Hidden,
  92     cl::desc("Verify generated machine code"),
  93     cl::init(false),
  94     cl::ZeroOrMore);
  95 static cl::opt<bool> EnableMachineOutliner("enable-machine-outliner",
  96     cl::Hidden,
  97     cl::desc("Enable machine outliner"));
  98
  99 static cl::opt<std::string>
 100 PrintMachineInstrs("print-machineinstrs", cl::ValueOptional,
 101                    cl::desc("Print machine instrs"),
 102                    cl::value_desc("pass-name"), cl::init("option-unspecified"));
 103
 104 static cl::opt<int> EnableGlobalISelAbort(
 105     "global-isel-abort", cl::Hidden,
 106     cl::desc("Enable abort calls when \"global\" instruction selection "
 107              "fails to lower/select an instruction: 0 disable the abort, "
 108              "1 enable the abort, and "
 109              "2 disable the abort but emit a diagnostic on failure"),
 110     cl::init(1));
 111
 112 // Temporary option to allow experimenting with MachineScheduler as a post-RA
 113 // scheduler. Targets can "properly" enable this with
 114 // substitutePass(&PostRASchedulerID, &PostMachineSchedulerID).
 115 // Targets can return true in targetSchedulesPostRAScheduling() and
 116 // insert a PostRA scheduling pass wherever it wants.
 117 cl::opt<bool> MISchedPostRA("misched-postra", cl::Hidden,
 118   cl::desc("Run MachineScheduler post regalloc (independent of preRA sched)"));
 119
 120 // Experimental option to run live interval analysis early.
 121 static cl::opt<bool> EarlyLiveIntervals("early-live-intervals", cl::Hidden,
 122     cl::desc("Run live interval analysis earlier in the pipeline"));
 123
 124 // Experimental option to use CFL-AA in codegen
 125 enum class CFLAAType { None, Steensgaard, Andersen, Both };
 126 static cl::opt<CFLAAType> UseCFLAA(
 127     "use-cfl-aa-in-codegen", cl::init(CFLAAType::None), cl::Hidden,
 128     cl::desc("Enable the new, experimental CFL alias analysis in CodeGen"),
 129     cl::values(clEnumValN(CFLAAType::None, "none", "Disable CFL-AA"),
 130                clEnumValN(CFLAAType::Steensgaard, "steens",
 131                           "Enable unification-based CFL-AA"),
 132                clEnumValN(CFLAAType::Andersen, "anders",
 133                           "Enable inclusion-based CFL-AA"),
 134                clEnumValN(CFLAAType::Both, "both",
 135                           "Enable both variants of CFL-AA")));
 136
 137 /// Allow standard passes to be disabled by command line options. This supports
 138 /// simple binary flags that either suppress the pass or do nothing.
 139 /// i.e. -disable-mypass=false has no effect.
 140 /// These should be converted to boolOrDefault in order to use applyOverride.
 141 static IdentifyingPassPtr applyDisable(IdentifyingPassPtr PassID,
 142                                        bool Override) {
 143   if (Override)
 144     return IdentifyingPassPtr();
 145   return PassID;
 146 }
 147
 148 /// Allow standard passes to be disabled by the command line, regardless of who
 149 /// is adding the pass.
 150 ///
 151 /// StandardID is the pass identified in the standard pass pipeline and provided
 152 /// to addPass(). It may be a target-specific ID in the case that the target
 153 /// directly adds its own pass, but in that case we harmlessly fall through.
 154 ///
 155 /// TargetID is the pass that the target has configured to override StandardID.
 156 ///
 157 /// StandardID may be a pseudo ID. In that case TargetID is the name of the real
 158 /// pass to run. This allows multiple options to control a single pass depending
 159 /// on where in the pipeline that pass is added.
 160 static IdentifyingPassPtr overridePass(AnalysisID StandardID,
 161                                        IdentifyingPassPtr TargetID) {
 162   if (StandardID == &PostRASchedulerID)
 163     return applyDisable(TargetID, DisablePostRASched);
 164
 165   if (StandardID == &BranchFolderPassID)
 166     return applyDisable(TargetID, DisableBranchFold);
 167
 168   if (StandardID == &TailDuplicateID)
 169     return applyDisable(TargetID, DisableTailDuplicate);
 170
 171   if (StandardID == &TargetPassConfig::EarlyTailDuplicateID)
 172     return applyDisable(TargetID, DisableEarlyTailDup);
 173
 174   if (StandardID == &MachineBlockPlacementID)
 175     return applyDisable(TargetID, DisableBlockPlacement);
 176
 177   if (StandardID == &StackSlotColoringID)
 178     return applyDisable(TargetID, DisableSSC);
 179
 180   if (StandardID == &DeadMachineInstructionElimID)
 181     return applyDisable(TargetID, DisableMachineDCE);
 182
 183   if (StandardID == &EarlyIfConverterID)
 184     return applyDisable(TargetID, DisableEarlyIfConversion);
 185
 186   if (StandardID == &MachineLICMID)
 187     return applyDisable(TargetID, DisableMachineLICM);
 188
 189   if (StandardID == &MachineCSEID)
 190     return applyDisable(TargetID, DisableMachineCSE);
 191
 192   if (StandardID == &TargetPassConfig::PostRAMachineLICMID)
 193     return applyDisable(TargetID, DisablePostRAMachineLICM);
 194
 195   if (StandardID == &MachineSinkingID)
 196     return applyDisable(TargetID, DisableMachineSink);
 197
 198   if (StandardID == &MachineCopyPropagationID)
 199     return applyDisable(TargetID, DisableCopyProp);
 200
 201   return TargetID;
 202 }
 203
 204 //===---------------------------------------------------------------------===//
 205 /// TargetPassConfig
 206 //===---------------------------------------------------------------------===//
 207
 208 INITIALIZE_PASS(TargetPassConfig, "targetpassconfig",
 209                 "Target Pass Configuration", false, false)
 210 char TargetPassConfig::ID = 0;
 211
 212 // Pseudo Pass IDs.
 213 char TargetPassConfig::EarlyTailDuplicateID = 0;
 214 char TargetPassConfig::PostRAMachineLICMID = 0;
 215
 216 namespace {
 217 struct InsertedPass {
 218   AnalysisID TargetPassID;
 219   IdentifyingPassPtr InsertedPassID;
 220   bool VerifyAfter;
 221   bool PrintAfter;
 222
 223   InsertedPass(AnalysisID TargetPassID, IdentifyingPassPtr InsertedPassID,
 224                bool VerifyAfter, bool PrintAfter)
 225       : TargetPassID(TargetPassID), InsertedPassID(InsertedPassID),
 226         VerifyAfter(VerifyAfter), PrintAfter(PrintAfter) {}
 227
 228   Pass *getInsertedPass() const {
 229     assert(InsertedPassID.isValid() && "Illegal Pass ID!");
 230     if (InsertedPassID.isInstance())
 231       return InsertedPassID.getInstance();
 232     Pass *NP = Pass::createPass(InsertedPassID.getID());
 233     assert(NP && "Pass ID not registered");
 234     return NP;
 235   }
 236 };
 237 }
 238
 239 namespace llvm {
 240 class PassConfigImpl {
 241 public:
 242   // List of passes explicitly substituted by this target. Normally this is
 243   // empty, but it is a convenient way to suppress or replace specific passes
 244   // that are part of a standard pass pipeline without overridding the entire
 245   // pipeline. This mechanism allows target options to inherit a standard pass's
 246   // user interface. For example, a target may disable a standard pass by
 247   // default by substituting a pass ID of zero, and the user may still enable
 248   // that standard pass with an explicit command line option.
 249   DenseMap<AnalysisID,IdentifyingPassPtr> TargetPasses;
 250
 251   /// Store the pairs of <AnalysisID, AnalysisID> of which the second pass
 252   /// is inserted after each instance of the first one.
 253   SmallVector<InsertedPass, 4> InsertedPasses;
 254 };
 255 } // namespace llvm
 256
 257 // Out of line virtual method.
 258 TargetPassConfig::~TargetPassConfig() {
 259   delete Impl;
 260 }
 261
 262 // Out of line constructor provides default values for pass options and
 263 // registers all common codegen passes.
 264 TargetPassConfig::TargetPassConfig(LLVMTargetMachine &TM, PassManagerBase &pm)
 265     : ImmutablePass(ID), PM(&pm), Started(true), Stopped(false),
 266       AddingMachinePasses(false), TM(&TM), Impl(nullptr), Initialized(false),
 267       DisableVerify(false), EnableTailMerge(true),
 268       RequireCodeGenSCCOrder(false) {
 269
 270   Impl = new PassConfigImpl();
 271
 272   // Register all target independent codegen passes to activate their PassIDs,
 273   // including this pass itself.
 274   initializeCodeGen(*PassRegistry::getPassRegistry());
 275
 276   // Also register alias analysis passes required by codegen passes.
 277   initializeBasicAAWrapperPassPass(*PassRegistry::getPassRegistry());
 278   initializeAAResultsWrapperPassPass(*PassRegistry::getPassRegistry());
 279
 280   // Substitute Pseudo Pass IDs for real ones.
 281   substitutePass(&EarlyTailDuplicateID, &TailDuplicateID);
 282   substitutePass(&PostRAMachineLICMID, &MachineLICMID);
 283
 284   if (StringRef(PrintMachineInstrs.getValue()).equals(""))
 285     TM.Options.PrintMachineCode = true;
 286
 287   if (TM.Options.EnableIPRA)
 288     setRequiresCodeGenSCCOrder();
 289 }
 290
 291 CodeGenOpt::Level TargetPassConfig::getOptLevel() const {
 292   return TM->getOptLevel();
 293 }
 294
 295 /// Insert InsertedPassID pass after TargetPassID.
 296 void TargetPassConfig::insertPass(AnalysisID TargetPassID,
 297                                   IdentifyingPassPtr InsertedPassID,
 298                                   bool VerifyAfter, bool PrintAfter) {
 299   assert(((!InsertedPassID.isInstance() &&
 300            TargetPassID != InsertedPassID.getID()) ||
 301           (InsertedPassID.isInstance() &&
 302            TargetPassID != InsertedPassID.getInstance()->getPassID())) &&
 303          "Insert a pass after itself!");
 304   Impl->InsertedPasses.emplace_back(TargetPassID, InsertedPassID, VerifyAfter,
 305                                     PrintAfter);
 306 }
 307
 308 /// createPassConfig - Create a pass configuration object to be used by
 309 /// addPassToEmitX methods for generating a pipeline of CodeGen passes.
 310 ///
 311 /// Targets may override this to extend TargetPassConfig.
 312 TargetPassConfig *LLVMTargetMachine::createPassConfig(PassManagerBase &PM) {
 313   return new TargetPassConfig(*this, PM);
 314 }
 315
 316 TargetPassConfig::TargetPassConfig()
 317   : ImmutablePass(ID), PM(nullptr) {
 318   report_fatal_error("Trying to construct TargetPassConfig without a target "
 319                      "machine. Scheduling a CodeGen pass without a target "
 320                      "triple set?");
 321 }
 322
 323 // Helper to verify the analysis is really immutable.
 324 void TargetPassConfig::setOpt(bool &Opt, bool Val) {
 325   assert(!Initialized && "PassConfig is immutable");
 326   Opt = Val;
 327 }
 328
 329 void TargetPassConfig::substitutePass(AnalysisID StandardID,
 330                                       IdentifyingPassPtr TargetID) {
 331   Impl->TargetPasses[StandardID] = TargetID;
 332 }
 333
 334 IdentifyingPassPtr TargetPassConfig::getPassSubstitution(AnalysisID ID) const {
 335   DenseMap<AnalysisID, IdentifyingPassPtr>::const_iterator
 336     I = Impl->TargetPasses.find(ID);
 337   if (I == Impl->TargetPasses.end())
 338     return ID;
 339   return I->second;
 340 }
 341
 342 bool TargetPassConfig::isPassSubstitutedOrOverridden(AnalysisID ID) const {
 343   IdentifyingPassPtr TargetID = getPassSubstitution(ID);
 344   IdentifyingPassPtr FinalPtr = overridePass(ID, TargetID);
 345   return !FinalPtr.isValid() || FinalPtr.isInstance() ||
 346       FinalPtr.getID() != ID;
 347 }
 348
 349 /// Add a pass to the PassManager if that pass is supposed to be run.  If the
 350 /// Started/Stopped flags indicate either that the compilation should start at
 351 /// a later pass or that it should stop after an earlier pass, then do not add
 352 /// the pass.  Finally, compare the current pass against the StartAfter
 353 /// and StopAfter options and change the Started/Stopped flags accordingly.
 354 void TargetPassConfig::addPass(Pass *P, bool verifyAfter, bool printAfter) {
 355   assert(!Initialized && "PassConfig is immutable");
 356
 357   // Cache the Pass ID here in case the pass manager finds this pass is
 358   // redundant with ones already scheduled / available, and deletes it.
 359   // Fundamentally, once we add the pass to the manager, we no longer own it
 360   // and shouldn't reference it.
 361   AnalysisID PassID = P->getPassID();
 362
 363   if (StartBefore == PassID)
 364     Started = true;
 365   if (StopBefore == PassID)
 366     Stopped = true;
 367   if (Started && !Stopped) {
 368     std::string Banner;
 369     // Construct banner message before PM->add() as that may delete the pass.
 370     if (AddingMachinePasses && (printAfter || verifyAfter))
 371       Banner = std::string("After ") + std::string(P->getPassName());
 372     PM->add(P);
 373     if (AddingMachinePasses) {
 374       if (printAfter)
 375         addPrintPass(Banner);
 376       if (verifyAfter)
 377         addVerifyPass(Banner);
 378     }
 379
 380     // Add the passes after the pass P if there is any.
 381     for (auto IP : Impl->InsertedPasses) {
 382       if (IP.TargetPassID == PassID)
 383         addPass(IP.getInsertedPass(), IP.VerifyAfter, IP.PrintAfter);
 384     }
 385   } else {
 386     delete P;
 387   }
 388   if (StopAfter == PassID)
 389     Stopped = true;
 390   if (StartAfter == PassID)
 391     Started = true;
 392   if (Stopped && !Started)
 393     report_fatal_error("Cannot stop compilation after pass that is not run");
 394 }
 395
 396 /// Add a CodeGen pass at this point in the pipeline after checking for target
 397 /// and command line overrides.
 398 ///
 399 /// addPass cannot return a pointer to the pass instance because is internal the
 400 /// PassManager and the instance we create here may already be freed.
 401 AnalysisID TargetPassConfig::addPass(AnalysisID PassID, bool verifyAfter,
 402                                      bool printAfter) {
 403   IdentifyingPassPtr TargetID = getPassSubstitution(PassID);
 404   IdentifyingPassPtr FinalPtr = overridePass(PassID, TargetID);
 405   if (!FinalPtr.isValid())
 406     return nullptr;
 407
 408   Pass *P;
 409   if (FinalPtr.isInstance())
 410     P = FinalPtr.getInstance();
 411   else {
 412     P = Pass::createPass(FinalPtr.getID());
 413     if (!P)
 414       llvm_unreachable("Pass ID not registered");
 415   }
 416   AnalysisID FinalID = P->getPassID();
 417   addPass(P, verifyAfter, printAfter); // Ends the lifetime of P.
 418
 419   return FinalID;
 420 }
 421
 422 void TargetPassConfig::printAndVerify(const std::string &Banner) {
 423   addPrintPass(Banner);
 424   addVerifyPass(Banner);
 425 }
 426
 427 void TargetPassConfig::addPrintPass(const std::string &Banner) {
 428   if (TM->shouldPrintMachineCode())
 429     PM->add(createMachineFunctionPrinterPass(dbgs(), Banner));
 430 }
 431
 432 void TargetPassConfig::addVerifyPass(const std::string &Banner) {
 433   bool Verify = VerifyMachineCode;
 434 #ifdef EXPENSIVE_CHECKS
 435   if (VerifyMachineCode == cl::BOU_UNSET)
 436     Verify = TM->isMachineVerifierClean();
 437 #endif
 438   if (Verify)
 439     PM->add(createMachineVerifierPass(Banner));
 440 }
 441
 442 /// Add common target configurable passes that perform LLVM IR to IR transforms
 443 /// following machine independent optimization.
 444 void TargetPassConfig::addIRPasses() {
 445   switch (UseCFLAA) {
 446   case CFLAAType::Steensgaard:
 447     addPass(createCFLSteensAAWrapperPass());
 448     break;
 449   case CFLAAType::Andersen:
 450     addPass(createCFLAndersAAWrapperPass());
 451     break;
 452   case CFLAAType::Both:
 453     addPass(createCFLAndersAAWrapperPass());
 454     addPass(createCFLSteensAAWrapperPass());
 455     break;
 456   default:
 457     break;
 458   }
 459
 460   // Basic AliasAnalysis support.
 461   // Add TypeBasedAliasAnalysis before BasicAliasAnalysis so that
 462   // BasicAliasAnalysis wins if they disagree. This is intended to help
 463   // support "obvious" type-punning idioms.
 464   addPass(createTypeBasedAAWrapperPass());
 465   addPass(createScopedNoAliasAAWrapperPass());
 466   addPass(createBasicAAWrapperPass());
 467
 468   // Before running any passes, run the verifier to determine if the input
 469   // coming from the front-end and/or optimizer is valid.
 470   if (!DisableVerify)
 471     addPass(createVerifierPass());
 472
 473   // Run loop strength reduction before anything else.
 474   if (getOptLevel() != CodeGenOpt::None && !DisableLSR) {
 475     addPass(createLoopStrengthReducePass());
 476     if (PrintLSR)
 477       addPass(createPrintFunctionPass(dbgs(), "\n\n*** Code after LSR ***\n"));
 478   }
 479
 480   // Run GC lowering passes for builtin collectors
 481   // TODO: add a pass insertion point here
 482   addPass(createGCLoweringPass());
 483   addPass(createShadowStackGCLoweringPass());
 484
 485   // Make sure that no unreachable blocks are instruction selected.
 486   addPass(createUnreachableBlockEliminationPass());
 487
 488   // Prepare expensive constants for SelectionDAG.
 489   if (getOptLevel() != CodeGenOpt::None && !DisableConstantHoisting)
 490     addPass(createConstantHoistingPass());
 491
 492   if (getOptLevel() != CodeGenOpt::None && !DisablePartialLibcallInlining)
 493     addPass(createPartiallyInlineLibCallsPass());
 494
 495   // Insert calls to mcount-like functions.
 496   addPass(createCountingFunctionInserterPass());
 497
 498   // Add scalarization of target's unsupported masked memory intrinsics pass.
 499   // the unsupported intrinsic will be replaced with a chain of basic blocks,
 500   // that stores/loads element one-by-one if the appropriate mask bit is set.
 501   addPass(createScalarizeMaskedMemIntrinPass());
 502
 503   // Expand reduction intrinsics into shuffle sequences if the target wants to.
 504   addPass(createExpandReductionsPass());
 505 }
 506
 507 /// Turn exception handling constructs into something the code generators can
 508 /// handle.
 509 void TargetPassConfig::addPassesToHandleExceptions() {
 510   const MCAsmInfo *MCAI = TM->getMCAsmInfo();
 511   assert(MCAI && "No MCAsmInfo");
 512   switch (MCAI->getExceptionHandlingType()) {
 513   case ExceptionHandling::SjLj:
 514     // SjLj piggy-backs on dwarf for this bit. The cleanups done apply to both
 515     // Dwarf EH prepare needs to be run after SjLj prepare. Otherwise,
 516     // catch info can get misplaced when a selector ends up more than one block
 517     // removed from the parent invoke(s). This could happen when a landing
 518     // pad is shared by multiple invokes and is also a target of a normal
 519     // edge from elsewhere.
 520     addPass(createSjLjEHPreparePass());
 521     LLVM_FALLTHROUGH;
 522   case ExceptionHandling::DwarfCFI:
 523   case ExceptionHandling::ARM:
 524     addPass(createDwarfEHPass());
 525     break;
 526   case ExceptionHandling::WinEH:
 527     // We support using both GCC-style and MSVC-style exceptions on Windows, so
 528     // add both preparation passes. Each pass will only actually run if it
 529     // recognizes the personality function.
 530     addPass(createWinEHPass());
 531     addPass(createDwarfEHPass());
 532     break;
 533   case ExceptionHandling::None:
 534     addPass(createLowerInvokePass());
 535
 536     // The lower invoke pass may create unreachable code. Remove it.
 537     addPass(createUnreachableBlockEliminationPass());
 538     break;
 539   }
 540 }
 541
 542 /// Add pass to prepare the LLVM IR for code generation. This should be done
 543 /// before exception handling preparation passes.
 544 void TargetPassConfig::addCodeGenPrepare() {
 545   if (getOptLevel() != CodeGenOpt::None && !DisableCGP)
 546     addPass(createCodeGenPreparePass());
 547   addPass(createRewriteSymbolsPass());
 548 }
 549
 550 /// Add common passes that perform LLVM IR to IR transforms in preparation for
 551 /// instruction selection.
 552 void TargetPassConfig::addISelPrepare() {
 553   addPreISel();
 554
 555   // Force codegen to run according to the callgraph.
 556   if (requiresCodeGenSCCOrder())
 557     addPass(new DummyCGSCCPass);
 558
 559   // Add both the safe stack and the stack protection passes: each of them will
 560   // only protect functions that have corresponding attributes.
 561   addPass(createSafeStackPass());
 562   addPass(createStackProtectorPass());
 563
 564   if (PrintISelInput)
 565     addPass(createPrintFunctionPass(
 566         dbgs(), "\n\n*** Final LLVM Code input to ISel ***\n"));
 567
 568   // All passes which modify the LLVM IR are now complete; run the verifier
 569   // to ensure that the IR is valid.
 570   if (!DisableVerify)
 571     addPass(createVerifierPass());
 572 }
 573
 574 /// -regalloc=... command line option.
 575 static FunctionPass *useDefaultRegisterAllocator() { return nullptr; }
 576 static cl::opt<RegisterRegAlloc::FunctionPassCtor, false,
 577                RegisterPassParser<RegisterRegAlloc> >
 578 RegAlloc("regalloc",
 579          cl::init(&useDefaultRegisterAllocator),
 580          cl::desc("Register allocator to use"));
 581
 582 /// Add the complete set of target-independent postISel code generator passes.
 583 ///
 584 /// This can be read as the standard order of major LLVM CodeGen stages. Stages
 585 /// with nontrivial configuration or multiple passes are broken out below in
 586 /// add%Stage routines.
 587 ///
 588 /// Any TargetPassConfig::addXX routine may be overriden by the Target. The
 589 /// addPre/Post methods with empty header implementations allow injecting
 590 /// target-specific fixups just before or after major stages. Additionally,
 591 /// targets have the flexibility to change pass order within a stage by
 592 /// overriding default implementation of add%Stage routines below. Each
 593 /// technique has maintainability tradeoffs because alternate pass orders are
 594 /// not well supported. addPre/Post works better if the target pass is easily
 595 /// tied to a common pass. But if it has subtle dependencies on multiple passes,
 596 /// the target should override the stage instead.
 597 ///
 598 /// TODO: We could use a single addPre/Post(ID) hook to allow pass injection
 599 /// before/after any target-independent pass. But it's currently overkill.
 600 void TargetPassConfig::addMachinePasses() {
 601   AddingMachinePasses = true;
 602
 603   // Insert a machine instr printer pass after the specified pass.
 604   if (!StringRef(PrintMachineInstrs.getValue()).equals("") &&
 605       !StringRef(PrintMachineInstrs.getValue()).equals("option-unspecified")) {
 606     const PassRegistry *PR = PassRegistry::getPassRegistry();
 607     const PassInfo *TPI = PR->getPassInfo(PrintMachineInstrs.getValue());
 608     const PassInfo *IPI = PR->getPassInfo(StringRef("machineinstr-printer"));
 609     assert (TPI && IPI && "Pass ID not registered!");
 610     const char *TID = (const char *)(TPI->getTypeInfo());
 611     const char *IID = (const char *)(IPI->getTypeInfo());
 612     insertPass(TID, IID);
 613   }
 614
 615   // Print the instruction selected machine code...
 616   printAndVerify("After Instruction Selection");
 617
 618   if (TM->Options.EnableIPRA)
 619     addPass(createRegUsageInfoPropPass());
 620
 621   // Expand pseudo-instructions emitted by ISel.
 622   addPass(&ExpandISelPseudosID);
 623
 624   // Add passes that optimize machine instructions in SSA form.
 625   if (getOptLevel() != CodeGenOpt::None) {
 626     addMachineSSAOptimization();
 627   } else {
 628     // If the target requests it, assign local variables to stack slots relative
 629     // to one another and simplify frame index references where possible.
 630     addPass(&LocalStackSlotAllocationID, false);
 631   }
 632
 633   // Run pre-ra passes.
 634   addPreRegAlloc();
 635
 636   // Run register allocation and passes that are tightly coupled with it,
 637   // including phi elimination and scheduling.
 638   if (getOptimizeRegAlloc())
 639     addOptimizedRegAlloc(createRegAllocPass(true));
 640   else {
 641     if (RegAlloc != &useDefaultRegisterAllocator &&
 642         RegAlloc != &createFastRegisterAllocator)
 643       report_fatal_error("Must use fast (default) register allocator for unoptimized regalloc.");
 644     addFastRegAlloc(createRegAllocPass(false));
 645   }
 646
 647   // Run post-ra passes.
 648   addPostRegAlloc();
 649
 650   // Insert prolog/epilog code.  Eliminate abstract frame index references...
 651   if (getOptLevel() != CodeGenOpt::None)
 652     addPass(&ShrinkWrapID);
 653
 654   // Prolog/Epilog inserter needs a TargetMachine to instantiate. But only
 655   // do so if it hasn't been disabled, substituted, or overridden.
 656   if (!isPassSubstitutedOrOverridden(&PrologEpilogCodeInserterID))
 657       addPass(createPrologEpilogInserterPass());
 658
 659   /// Add passes that optimize machine instructions after register allocation.
 660   if (getOptLevel() != CodeGenOpt::None)
 661     addMachineLateOptimization();
 662
 663   // Expand pseudo instructions before second scheduling pass.
 664   addPass(&ExpandPostRAPseudosID);
 665
 666   // Run pre-sched2 passes.
 667   addPreSched2();
 668
 669   if (EnableImplicitNullChecks)
 670     addPass(&ImplicitNullChecksID);
 671
 672   // Second pass scheduler.
 673   // Let Target optionally insert this pass by itself at some other
 674   // point.
 675   if (getOptLevel() != CodeGenOpt::None &&
 676       !TM->targetSchedulesPostRAScheduling()) {
 677     if (MISchedPostRA)
 678       addPass(&PostMachineSchedulerID);
 679     else
 680       addPass(&PostRASchedulerID);
 681   }
 682
 683   // GC
 684   if (addGCPasses()) {
 685     if (PrintGCInfo)
 686       addPass(createGCInfoPrinter(dbgs()), false, false);
 687   }
 688
 689   // Basic block placement.
 690   if (getOptLevel() != CodeGenOpt::None)
 691     addBlockPlacement();
 692
 693   addPreEmitPass();
 694
 695   if (TM->Options.EnableIPRA)
 696     // Collect register usage information and produce a register mask of
 697     // clobbered registers, to be used to optimize call sites.
 698     addPass(createRegUsageInfoCollector());
 699
 700   addPass(&FuncletLayoutID, false);
 701
 702   addPass(&StackMapLivenessID, false);
 703   addPass(&LiveDebugValuesID, false);
 704
 705   // Insert before XRay Instrumentation.
 706   addPass(&FEntryInserterID, false);
 707
 708   addPass(&XRayInstrumentationID, false);
 709   addPass(&PatchableFunctionID, false);
 710
 711   if (EnableMachineOutliner)
 712     PM->add(createMachineOutlinerPass());
 713
 714   AddingMachinePasses = false;
 715 }
 716
 717 /// Add passes that optimize machine instructions in SSA form.
 718 void TargetPassConfig::addMachineSSAOptimization() {
 719   // Pre-ra tail duplication.
 720   addPass(&EarlyTailDuplicateID);
 721
 722   // Optimize PHIs before DCE: removing dead PHI cycles may make more
 723   // instructions dead.
 724   addPass(&OptimizePHIsID, false);
 725
 726   // This pass merges large allocas. StackSlotColoring is a different pass
 727   // which merges spill slots.
 728   addPass(&StackColoringID, false);
 729
 730   // If the target requests it, assign local variables to stack slots relative
 731   // to one another and simplify frame index references where possible.
 732   addPass(&LocalStackSlotAllocationID, false);
 733
 734   // With optimization, dead code should already be eliminated. However
 735   // there is one known exception: lowered code for arguments that are only
 736   // used by tail calls, where the tail calls reuse the incoming stack
 737   // arguments directly (see t11 in test/CodeGen/X86/sibcall.ll).
 738   addPass(&DeadMachineInstructionElimID);
 739
 740   // Allow targets to insert passes that improve instruction level parallelism,
 741   // like if-conversion. Such passes will typically need dominator trees and
 742   // loop info, just like LICM and CSE below.
 743   addILPOpts();
 744
 745   addPass(&MachineLICMID, false);
 746   addPass(&MachineCSEID, false);
 747
 748   // Coalesce basic blocks with the same branch condition
 749   addPass(&BranchCoalescingID);
 750
 751   addPass(&MachineSinkingID);
 752
 753   addPass(&PeepholeOptimizerID);
 754   // Clean-up the dead code that may have been generated by peephole
 755   // rewriting.
 756   addPass(&DeadMachineInstructionElimID);
 757 }
 758
 759 //===---------------------------------------------------------------------===//
 760 /// Register Allocation Pass Configuration
 761 //===---------------------------------------------------------------------===//
 762
 763 bool TargetPassConfig::getOptimizeRegAlloc() const {
 764   switch (OptimizeRegAlloc) {
 765   case cl::BOU_UNSET: return getOptLevel() != CodeGenOpt::None;
 766   case cl::BOU_TRUE:  return true;
 767   case cl::BOU_FALSE: return false;
 768   }
 769   llvm_unreachable("Invalid optimize-regalloc state");
 770 }
 771
 772 /// RegisterRegAlloc's global Registry tracks allocator registration.
 773 MachinePassRegistry RegisterRegAlloc::Registry;
 774
 775 /// A dummy default pass factory indicates whether the register allocator is
 776 /// overridden on the command line.
 777 static llvm::once_flag InitializeDefaultRegisterAllocatorFlag;
 778
 779 static RegisterRegAlloc
 780 defaultRegAlloc("default",
 781                 "pick register allocator based on -O option",
 782                 useDefaultRegisterAllocator);
 783
 784 static void initializeDefaultRegisterAllocatorOnce() {
 785   RegisterRegAlloc::FunctionPassCtor Ctor = RegisterRegAlloc::getDefault();
 786
 787   if (!Ctor) {
 788     Ctor = RegAlloc;
 789     RegisterRegAlloc::setDefault(RegAlloc);
 790   }
 791 }
 792
 793 /// Instantiate the default register allocator pass for this target for either
 794 /// the optimized or unoptimized allocation path. This will be added to the pass
 795 /// manager by addFastRegAlloc in the unoptimized case or addOptimizedRegAlloc
 796 /// in the optimized case.
 797 ///
 798 /// A target that uses the standard regalloc pass order for fast or optimized
 799 /// allocation may still override this for per-target regalloc
 800 /// selection. But -regalloc=... always takes precedence.
 801 FunctionPass *TargetPassConfig::createTargetRegisterAllocator(bool Optimized) {
 802   if (Optimized)
 803     return createGreedyRegisterAllocator();
 804   else
 805     return createFastRegisterAllocator();
 806 }
 807
 808 /// Find and instantiate the register allocation pass requested by this target
 809 /// at the current optimization level.  Different register allocators are
 810 /// defined as separate passes because they may require different analysis.
 811 ///
 812 /// This helper ensures that the regalloc= option is always available,
 813 /// even for targets that override the default allocator.
 814 ///
 815 /// FIXME: When MachinePassRegistry register pass IDs instead of function ptrs,
 816 /// this can be folded into addPass.
 817 FunctionPass *TargetPassConfig::createRegAllocPass(bool Optimized) {
 818   // Initialize the global default.
 819   llvm::call_once(InitializeDefaultRegisterAllocatorFlag,
 820                   initializeDefaultRegisterAllocatorOnce);
 821
 822   RegisterRegAlloc::FunctionPassCtor Ctor = RegisterRegAlloc::getDefault();
 823   if (Ctor != useDefaultRegisterAllocator)
 824     return Ctor();
 825
 826   // With no -regalloc= override, ask the target for a regalloc pass.
 827   return createTargetRegisterAllocator(Optimized);
 828 }
 829
 830 /// Return true if the default global register allocator is in use and
 831 /// has not be overriden on the command line with '-regalloc=...'
 832 bool TargetPassConfig::usingDefaultRegAlloc() const {
 833   return RegAlloc.getNumOccurrences() == 0;
 834 }
 835
 836 /// Add the minimum set of target-independent passes that are required for
 837 /// register allocation. No coalescing or scheduling.
 838 void TargetPassConfig::addFastRegAlloc(FunctionPass *RegAllocPass) {
 839   addPass(&PHIEliminationID, false);
 840   addPass(&TwoAddressInstructionPassID, false);
 841
 842   if (RegAllocPass)
 843     addPass(RegAllocPass);
 844 }
 845
 846 /// Add standard target-independent passes that are tightly coupled with
 847 /// optimized register allocation, including coalescing, machine instruction
 848 /// scheduling, and register allocation itself.
 849 void TargetPassConfig::addOptimizedRegAlloc(FunctionPass *RegAllocPass) {
 850   addPass(&DetectDeadLanesID, false);
 851
 852   addPass(&ProcessImplicitDefsID, false);
 853
 854   // LiveVariables currently requires pure SSA form.
 855   //
 856   // FIXME: Once TwoAddressInstruction pass no longer uses kill flags,
 857   // LiveVariables can be removed completely, and LiveIntervals can be directly
 858   // computed. (We still either need to regenerate kill flags after regalloc, or
 859   // preferably fix the scavenger to not depend on them).
 860   addPass(&LiveVariablesID, false);
 861
 862   // Edge splitting is smarter with machine loop info.
 863   addPass(&MachineLoopInfoID, false);
 864   addPass(&PHIEliminationID, false);
 865
 866   // Eventually, we want to run LiveIntervals before PHI elimination.
 867   if (EarlyLiveIntervals)
 868     addPass(&LiveIntervalsID, false);
 869
 870   addPass(&TwoAddressInstructionPassID, false);
 871   addPass(&RegisterCoalescerID);
 872
 873   // The machine scheduler may accidentally create disconnected components
 874   // when moving subregister definitions around, avoid this by splitting them to
 875   // separate vregs before. Splitting can also improve reg. allocation quality.
 876   addPass(&RenameIndependentSubregsID);
 877
 878   // PreRA instruction scheduling.
 879   addPass(&MachineSchedulerID);
 880
 881   if (RegAllocPass) {
 882     // Add the selected register allocation pass.
 883     addPass(RegAllocPass);
 884
 885     // Allow targets to change the register assignments before rewriting.
 886     addPreRewrite();
 887
 888     // Finally rewrite virtual registers.
 889     addPass(&VirtRegRewriterID);
 890
 891     // Perform stack slot coloring and post-ra machine LICM.
 892     //
 893     // FIXME: Re-enable coloring with register when it's capable of adding
 894     // kill markers.
 895     addPass(&StackSlotColoringID);
 896
 897     // Run post-ra machine LICM to hoist reloads / remats.
 898     //
 899     // FIXME: can this move into MachineLateOptimization?
 900     addPass(&PostRAMachineLICMID);
 901   }
 902 }
 903
 904 //===---------------------------------------------------------------------===//
 905 /// Post RegAlloc Pass Configuration
 906 //===---------------------------------------------------------------------===//
 907
 908 /// Add passes that optimize machine instructions after register allocation.
 909 void TargetPassConfig::addMachineLateOptimization() {
 910   // Branch folding must be run after regalloc and prolog/epilog insertion.
 911   addPass(&BranchFolderPassID);
 912
 913   // Tail duplication.
 914   // Note that duplicating tail just increases code size and degrades
 915   // performance for targets that require Structured Control Flow.
 916   // In addition it can also make CFG irreducible. Thus we disable it.
 917   if (!TM->requiresStructuredCFG())
 918     addPass(&TailDuplicateID);
 919
 920   // Copy propagation.
 921   addPass(&MachineCopyPropagationID);
 922 }
 923
 924 /// Add standard GC passes.
 925 bool TargetPassConfig::addGCPasses() {
 926   addPass(&GCMachineCodeAnalysisID, false);
 927   return true;
 928 }
 929
 930 /// Add standard basic block placement passes.
 931 void TargetPassConfig::addBlockPlacement() {
 932   if (addPass(&MachineBlockPlacementID)) {
 933     // Run a separate pass to collect block placement statistics.
 934     if (EnableBlockPlacementStats)
 935       addPass(&MachineBlockPlacementStatsID);
 936   }
 937 }
 938
 939 //===---------------------------------------------------------------------===//
 940 /// GlobalISel Configuration
 941 //===---------------------------------------------------------------------===//
 942
 943 bool TargetPassConfig::isGlobalISelEnabled() const {
 944   return false;
 945 }
 946
 947 bool TargetPassConfig::isGlobalISelAbortEnabled() const {
 948   return EnableGlobalISelAbort == 1;
 949 }
 950
 951 bool TargetPassConfig::reportDiagnosticWhenGlobalISelFallback() const {
 952   return EnableGlobalISelAbort == 2;
 953 }