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