1 //===-- Passes.cpp - Target independent code generation passes ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines interfaces to access the target independent code
11 // generation passes provided by the LLVM backend.
13 //===---------------------------------------------------------------------===//
15 #include "llvm/CodeGen/Passes.h"
16 #include "llvm/Analysis/Passes.h"
17 #include "llvm/Analysis/Verifier.h"
18 #include "llvm/Assembly/PrintModulePass.h"
19 #include "llvm/CodeGen/GCStrategy.h"
20 #include "llvm/CodeGen/MachineFunctionPass.h"
21 #include "llvm/CodeGen/RegAllocRegistry.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/TargetOptions.h"
29 #include "llvm/Target/TargetSubtargetInfo.h"
30 #include "llvm/Transforms/Scalar.h"
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",
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"));
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"));
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) {
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) {
119 report_fatal_error("Target cannot enable pass");
124 llvm_unreachable("Invalid command line option state");
127 /// Allow standard passes to be disabled by the command line, regardless of who
128 /// is adding the pass.
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.
134 /// TargetID is the pass that the target has configured to override StandardID.
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);
143 if (StandardID == &BranchFolderPassID)
144 return applyDisable(TargetID, DisableBranchFold);
146 if (StandardID == &TailDuplicateID)
147 return applyDisable(TargetID, DisableTailDuplicate);
149 if (StandardID == &TargetPassConfig::EarlyTailDuplicateID)
150 return applyDisable(TargetID, DisableEarlyTailDup);
152 if (StandardID == &MachineBlockPlacementID)
153 return applyDisable(TargetID, DisableCodePlace);
155 if (StandardID == &CodePlacementOptID)
156 return applyDisable(TargetID, DisableCodePlace);
158 if (StandardID == &StackSlotColoringID)
159 return applyDisable(TargetID, DisableSSC);
161 if (StandardID == &DeadMachineInstructionElimID)
162 return applyDisable(TargetID, DisableMachineDCE);
164 if (StandardID == &EarlyIfConverterID)
165 return applyDisable(TargetID, DisableEarlyIfConversion);
167 if (StandardID == &MachineLICMID)
168 return applyDisable(TargetID, DisableMachineLICM);
170 if (StandardID == &MachineCSEID)
171 return applyDisable(TargetID, DisableMachineCSE);
173 if (StandardID == &MachineSchedulerID)
174 return applyOverride(TargetID, EnableMachineSched, StandardID);
176 if (StandardID == &TargetPassConfig::PostRAMachineLICMID)
177 return applyDisable(TargetID, DisablePostRAMachineLICM);
179 if (StandardID == &MachineSinkingID)
180 return applyDisable(TargetID, DisableMachineSink);
182 if (StandardID == &MachineCopyPropagationID)
183 return applyDisable(TargetID, DisableCopyProp);
188 //===---------------------------------------------------------------------===//
190 //===---------------------------------------------------------------------===//
192 INITIALIZE_PASS(TargetPassConfig, "targetpassconfig",
193 "Target Pass Configuration", false, false)
194 char TargetPassConfig::ID = 0;
197 char TargetPassConfig::EarlyTailDuplicateID = 0;
198 char TargetPassConfig::PostRAMachineLICMID = 0;
201 class PassConfigImpl {
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;
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;
218 // Out of line virtual method.
219 TargetPassConfig::~TargetPassConfig() {
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) {
231 Impl = new PassConfigImpl();
233 // Register all target independent codegen passes to activate their PassIDs,
234 // including this pass itself.
235 initializeCodeGen(*PassRegistry::getPassRegistry());
237 // Substitute Pseudo Pass IDs for real ones.
238 substitutePass(&EarlyTailDuplicateID, &TailDuplicateID);
239 substitutePass(&PostRAMachineLICMID, &MachineLICMID);
241 // Disable early if-conversion. Targets that are ready can enable it.
242 disablePass(&EarlyIfConverterID);
244 // Temporarily disable experimental passes.
245 const TargetSubtargetInfo &ST = TM->getSubtarget<TargetSubtargetInfo>();
246 if (!ST.enableMachineScheduler())
247 disablePass(&MachineSchedulerID);
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);
258 /// createPassConfig - Create a pass configuration object to be used by
259 /// addPassToEmitX methods for generating a pipeline of CodeGen passes.
261 /// Targets may override this to extend TargetPassConfig.
262 TargetPassConfig *LLVMTargetMachine::createPassConfig(PassManagerBase &PM) {
263 return new TargetPassConfig(this, PM);
266 TargetPassConfig::TargetPassConfig()
267 : ImmutablePass(ID), PM(0) {
268 llvm_unreachable("TargetPassConfig should not be constructed on-the-fly");
271 // Helper to verify the analysis is really immutable.
272 void TargetPassConfig::setOpt(bool &Opt, bool Val) {
273 assert(!Initialized && "PassConfig is immutable");
277 void TargetPassConfig::substitutePass(AnalysisID StandardID,
278 AnalysisID TargetID) {
279 Impl->TargetPasses[StandardID] = TargetID;
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())
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");
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();
304 if (Started && !Stopped)
306 if (StopAfter == PassID)
308 if (StartAfter == PassID)
310 if (Stopped && !Started)
311 report_fatal_error("Cannot stop compilation after pass that is not run");
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);
322 Pass *P = Pass::createPass(FinalID);
324 llvm_unreachable("Pass ID not registered");
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();
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");
340 void TargetPassConfig::printAndVerify(const char *Banner) {
341 if (TM->shouldPrintMachineCode())
342 addPass(createMachineFunctionPrinterPass(dbgs(), Banner));
344 if (VerifyMachineCode)
345 addPass(createMachineVerifierPass(Banner));
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());
358 // Before running any passes, run the verifier to determine if the input
359 // coming from the front-end and/or optimizer is valid.
361 addPass(createVerifierPass());
363 // Run loop strength reduction before anything else.
364 if (getOptLevel() != CodeGenOpt::None && !DisableLSR) {
365 addPass(createLoopStrengthReducePass());
367 addPass(createPrintFunctionPass("\n\n*** Code after LSR ***\n", &dbgs()));
370 addPass(createGCLoweringPass());
372 // Make sure that no unreachable blocks are instruction selected.
373 addPass(createUnreachableBlockEliminationPass());
376 /// Turn exception handling constructs into something the code generators can
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()));
389 case ExceptionHandling::DwarfCFI:
390 case ExceptionHandling::ARM:
391 case ExceptionHandling::Win64:
392 addPass(createDwarfEHPass(TM));
394 case ExceptionHandling::None:
395 addPass(createLowerInvokePass(TM->getTargetLowering()));
397 // The lower invoke pass may create unreachable code. Remove it.
398 addPass(createUnreachableBlockEliminationPass());
403 /// Add pass to prepare the LLVM IR for code generation. This should be done
404 /// before exception handling preparation passes.
405 void TargetPassConfig::addCodeGenPrepare() {
406 if (getOptLevel() != CodeGenOpt::None && !DisableCGP)
407 addPass(createCodeGenPreparePass(getTargetLowering()));
410 /// Add common passes that perform LLVM IR to IR transforms in preparation for
411 /// instruction selection.
412 void TargetPassConfig::addISelPrepare() {
413 addPass(createStackProtectorPass(getTargetLowering()));
418 addPass(createPrintFunctionPass("\n\n"
419 "*** Final LLVM Code input to ISel ***\n",
422 // All passes which modify the LLVM IR are now complete; run the verifier
423 // to ensure that the IR is valid.
425 addPass(createVerifierPass());
428 /// Add the complete set of target-independent postISel code generator passes.
430 /// This can be read as the standard order of major LLVM CodeGen stages. Stages
431 /// with nontrivial configuration or multiple passes are broken out below in
432 /// add%Stage routines.
434 /// Any TargetPassConfig::addXX routine may be overriden by the Target. The
435 /// addPre/Post methods with empty header implementations allow injecting
436 /// target-specific fixups just before or after major stages. Additionally,
437 /// targets have the flexibility to change pass order within a stage by
438 /// overriding default implementation of add%Stage routines below. Each
439 /// technique has maintainability tradeoffs because alternate pass orders are
440 /// not well supported. addPre/Post works better if the target pass is easily
441 /// tied to a common pass. But if it has subtle dependencies on multiple passes,
442 /// the target should override the stage instead.
444 /// TODO: We could use a single addPre/Post(ID) hook to allow pass injection
445 /// before/after any target-independent pass. But it's currently overkill.
446 void TargetPassConfig::addMachinePasses() {
447 // Insert a machine instr printer pass after the specified pass.
448 // If -print-machineinstrs specified, print machineinstrs after all passes.
449 if (StringRef(PrintMachineInstrs.getValue()).equals(""))
450 TM->Options.PrintMachineCode = true;
451 else if (!StringRef(PrintMachineInstrs.getValue())
452 .equals("option-unspecified")) {
453 const PassRegistry *PR = PassRegistry::getPassRegistry();
454 const PassInfo *TPI = PR->getPassInfo(PrintMachineInstrs.getValue());
455 const PassInfo *IPI = PR->getPassInfo(StringRef("print-machineinstrs"));
456 assert (TPI && IPI && "Pass ID not registered!");
457 const char *TID = (const char *)(TPI->getTypeInfo());
458 const char *IID = (const char *)(IPI->getTypeInfo());
459 insertPass(TID, IID);
462 // Print the instruction selected machine code...
463 printAndVerify("After Instruction Selection");
465 // Expand pseudo-instructions emitted by ISel.
466 if (addPass(&ExpandISelPseudosID))
467 printAndVerify("After ExpandISelPseudos");
469 // Add passes that optimize machine instructions in SSA form.
470 if (getOptLevel() != CodeGenOpt::None) {
471 addMachineSSAOptimization();
473 // If the target requests it, assign local variables to stack slots relative
474 // to one another and simplify frame index references where possible.
475 addPass(&LocalStackSlotAllocationID);
478 // Run pre-ra passes.
479 if (addPreRegAlloc())
480 printAndVerify("After PreRegAlloc passes");
482 // Run register allocation and passes that are tightly coupled with it,
483 // including phi elimination and scheduling.
484 if (getOptimizeRegAlloc())
485 addOptimizedRegAlloc(createRegAllocPass(true));
487 addFastRegAlloc(createRegAllocPass(false));
489 // Run post-ra passes.
490 if (addPostRegAlloc())
491 printAndVerify("After PostRegAlloc passes");
493 // Insert prolog/epilog code. Eliminate abstract frame index references...
494 addPass(&PrologEpilogCodeInserterID);
495 printAndVerify("After PrologEpilogCodeInserter");
497 /// Add passes that optimize machine instructions after register allocation.
498 if (getOptLevel() != CodeGenOpt::None)
499 addMachineLateOptimization();
501 // Expand pseudo instructions before second scheduling pass.
502 addPass(&ExpandPostRAPseudosID);
503 printAndVerify("After ExpandPostRAPseudos");
505 // Run pre-sched2 passes.
507 printAndVerify("After PreSched2 passes");
509 // Second pass scheduler.
510 if (getOptLevel() != CodeGenOpt::None) {
511 addPass(&PostRASchedulerID);
512 printAndVerify("After PostRAScheduler");
518 addPass(createGCInfoPrinter(dbgs()));
521 // Basic block placement.
522 if (getOptLevel() != CodeGenOpt::None)
525 if (addPreEmitPass())
526 printAndVerify("After PreEmit passes");
529 /// Add passes that optimize machine instructions in SSA form.
530 void TargetPassConfig::addMachineSSAOptimization() {
531 // Pre-ra tail duplication.
532 if (addPass(&EarlyTailDuplicateID))
533 printAndVerify("After Pre-RegAlloc TailDuplicate");
535 // Optimize PHIs before DCE: removing dead PHI cycles may make more
536 // instructions dead.
537 addPass(&OptimizePHIsID);
539 // This pass merges large allocas. StackSlotColoring is a different pass
540 // which merges spill slots.
541 addPass(&StackColoringID);
543 // If the target requests it, assign local variables to stack slots relative
544 // to one another and simplify frame index references where possible.
545 addPass(&LocalStackSlotAllocationID);
547 // With optimization, dead code should already be eliminated. However
548 // there is one known exception: lowered code for arguments that are only
549 // used by tail calls, where the tail calls reuse the incoming stack
550 // arguments directly (see t11 in test/CodeGen/X86/sibcall.ll).
551 addPass(&DeadMachineInstructionElimID);
552 printAndVerify("After codegen DCE pass");
554 addPass(&EarlyIfConverterID);
555 addPass(&MachineLICMID);
556 addPass(&MachineCSEID);
557 addPass(&MachineSinkingID);
558 printAndVerify("After Machine LICM, CSE and Sinking passes");
560 addPass(&PeepholeOptimizerID);
561 printAndVerify("After codegen peephole optimization pass");
564 //===---------------------------------------------------------------------===//
565 /// Register Allocation Pass Configuration
566 //===---------------------------------------------------------------------===//
568 bool TargetPassConfig::getOptimizeRegAlloc() const {
569 switch (OptimizeRegAlloc) {
570 case cl::BOU_UNSET: return getOptLevel() != CodeGenOpt::None;
571 case cl::BOU_TRUE: return true;
572 case cl::BOU_FALSE: return false;
574 llvm_unreachable("Invalid optimize-regalloc state");
577 /// RegisterRegAlloc's global Registry tracks allocator registration.
578 MachinePassRegistry RegisterRegAlloc::Registry;
580 /// A dummy default pass factory indicates whether the register allocator is
581 /// overridden on the command line.
582 static FunctionPass *useDefaultRegisterAllocator() { return 0; }
583 static RegisterRegAlloc
584 defaultRegAlloc("default",
585 "pick register allocator based on -O option",
586 useDefaultRegisterAllocator);
588 /// -regalloc=... command line option.
589 static cl::opt<RegisterRegAlloc::FunctionPassCtor, false,
590 RegisterPassParser<RegisterRegAlloc> >
592 cl::init(&useDefaultRegisterAllocator),
593 cl::desc("Register allocator to use"));
596 /// Instantiate the default register allocator pass for this target for either
597 /// the optimized or unoptimized allocation path. This will be added to the pass
598 /// manager by addFastRegAlloc in the unoptimized case or addOptimizedRegAlloc
599 /// in the optimized case.
601 /// A target that uses the standard regalloc pass order for fast or optimized
602 /// allocation may still override this for per-target regalloc
603 /// selection. But -regalloc=... always takes precedence.
604 FunctionPass *TargetPassConfig::createTargetRegisterAllocator(bool Optimized) {
606 return createGreedyRegisterAllocator();
608 return createFastRegisterAllocator();
611 /// Find and instantiate the register allocation pass requested by this target
612 /// at the current optimization level. Different register allocators are
613 /// defined as separate passes because they may require different analysis.
615 /// This helper ensures that the regalloc= option is always available,
616 /// even for targets that override the default allocator.
618 /// FIXME: When MachinePassRegistry register pass IDs instead of function ptrs,
619 /// this can be folded into addPass.
620 FunctionPass *TargetPassConfig::createRegAllocPass(bool Optimized) {
621 RegisterRegAlloc::FunctionPassCtor Ctor = RegisterRegAlloc::getDefault();
623 // Initialize the global default.
626 RegisterRegAlloc::setDefault(RegAlloc);
628 if (Ctor != useDefaultRegisterAllocator)
631 // With no -regalloc= override, ask the target for a regalloc pass.
632 return createTargetRegisterAllocator(Optimized);
635 /// Add the minimum set of target-independent passes that are required for
636 /// register allocation. No coalescing or scheduling.
637 void TargetPassConfig::addFastRegAlloc(FunctionPass *RegAllocPass) {
638 addPass(&PHIEliminationID);
639 addPass(&TwoAddressInstructionPassID);
641 addPass(RegAllocPass);
642 printAndVerify("After Register Allocation");
645 /// Add standard target-independent passes that are tightly coupled with
646 /// optimized register allocation, including coalescing, machine instruction
647 /// scheduling, and register allocation itself.
648 void TargetPassConfig::addOptimizedRegAlloc(FunctionPass *RegAllocPass) {
649 addPass(&ProcessImplicitDefsID);
651 // LiveVariables currently requires pure SSA form.
653 // FIXME: Once TwoAddressInstruction pass no longer uses kill flags,
654 // LiveVariables can be removed completely, and LiveIntervals can be directly
655 // computed. (We still either need to regenerate kill flags after regalloc, or
656 // preferably fix the scavenger to not depend on them).
657 addPass(&LiveVariablesID);
659 // Add passes that move from transformed SSA into conventional SSA. This is a
660 // "copy coalescing" problem.
662 if (!EnableStrongPHIElim) {
663 // Edge splitting is smarter with machine loop info.
664 addPass(&MachineLoopInfoID);
665 addPass(&PHIEliminationID);
668 // Eventually, we want to run LiveIntervals before PHI elimination.
669 if (EarlyLiveIntervals)
670 addPass(&LiveIntervalsID);
672 addPass(&TwoAddressInstructionPassID);
674 if (EnableStrongPHIElim)
675 addPass(&StrongPHIEliminationID);
677 addPass(&RegisterCoalescerID);
679 // PreRA instruction scheduling.
680 if (addPass(&MachineSchedulerID))
681 printAndVerify("After Machine Scheduling");
683 // Add the selected register allocation pass.
684 addPass(RegAllocPass);
685 printAndVerify("After Register Allocation, before rewriter");
687 // Allow targets to change the register assignments before rewriting.
689 printAndVerify("After pre-rewrite passes");
691 // Finally rewrite virtual registers.
692 addPass(&VirtRegRewriterID);
693 printAndVerify("After Virtual Register Rewriter");
695 // FinalizeRegAlloc is convenient until MachineInstrBundles is more mature,
696 // but eventually, all users of it should probably be moved to addPostRA and
697 // it can go away. Currently, it's the intended place for targets to run
698 // FinalizeMachineBundles, because passes other than MachineScheduling an
699 // RegAlloc itself may not be aware of bundles.
700 if (addFinalizeRegAlloc())
701 printAndVerify("After RegAlloc finalization");
703 // Perform stack slot coloring and post-ra machine LICM.
705 // FIXME: Re-enable coloring with register when it's capable of adding
707 addPass(&StackSlotColoringID);
709 // Run post-ra machine LICM to hoist reloads / remats.
711 // FIXME: can this move into MachineLateOptimization?
712 addPass(&PostRAMachineLICMID);
714 printAndVerify("After StackSlotColoring and postra Machine LICM");
717 //===---------------------------------------------------------------------===//
718 /// Post RegAlloc Pass Configuration
719 //===---------------------------------------------------------------------===//
721 /// Add passes that optimize machine instructions after register allocation.
722 void TargetPassConfig::addMachineLateOptimization() {
723 // Branch folding must be run after regalloc and prolog/epilog insertion.
724 if (addPass(&BranchFolderPassID))
725 printAndVerify("After BranchFolding");
728 if (addPass(&TailDuplicateID))
729 printAndVerify("After TailDuplicate");
732 if (addPass(&MachineCopyPropagationID))
733 printAndVerify("After copy propagation pass");
736 /// Add standard GC passes.
737 bool TargetPassConfig::addGCPasses() {
738 addPass(&GCMachineCodeAnalysisID);
742 /// Add standard basic block placement passes.
743 void TargetPassConfig::addBlockPlacement() {
744 AnalysisID PassID = 0;
745 if (!DisableBlockPlacement) {
746 // MachineBlockPlacement is a new pass which subsumes the functionality of
747 // CodPlacementOpt. The old code placement pass can be restored by
748 // disabling block placement, but eventually it will be removed.
749 PassID = addPass(&MachineBlockPlacementID);
751 PassID = addPass(&CodePlacementOptID);
754 // Run a separate pass to collect block placement statistics.
755 if (EnableBlockPlacementStats)
756 addPass(&MachineBlockPlacementStatsID);
758 printAndVerify("After machine block placement.");