lib/CodeGen/Passes.cpp

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