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