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