1 //===---- ScheduleDAGInstrs.cpp - MachineInstr Rescheduling ---------------===//
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 implements the ScheduleDAGInstrs class, which implements re-scheduling
13 //===----------------------------------------------------------------------===//
15 #define DEBUG_TYPE "sched-instrs"
16 #include "RegisterPressure.h"
17 #include "llvm/Operator.h"
18 #include "llvm/Analysis/AliasAnalysis.h"
19 #include "llvm/Analysis/ValueTracking.h"
20 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
21 #include "llvm/CodeGen/MachineFunctionPass.h"
22 #include "llvm/CodeGen/MachineMemOperand.h"
23 #include "llvm/CodeGen/MachineRegisterInfo.h"
24 #include "llvm/CodeGen/PseudoSourceValue.h"
25 #include "llvm/CodeGen/ScheduleDAGInstrs.h"
26 #include "llvm/MC/MCInstrItineraries.h"
27 #include "llvm/Target/TargetMachine.h"
28 #include "llvm/Target/TargetInstrInfo.h"
29 #include "llvm/Target/TargetRegisterInfo.h"
30 #include "llvm/Target/TargetSubtargetInfo.h"
31 #include "llvm/Support/CommandLine.h"
32 #include "llvm/Support/Debug.h"
33 #include "llvm/Support/raw_ostream.h"
34 #include "llvm/ADT/SmallSet.h"
35 #include "llvm/ADT/SmallPtrSet.h"
38 static cl::opt<bool> EnableAASchedMI("enable-aa-sched-mi", cl::Hidden,
39 cl::ZeroOrMore, cl::init(false),
40 cl::desc("Enable use of AA during MI GAD construction"));
42 ScheduleDAGInstrs::ScheduleDAGInstrs(MachineFunction &mf,
43 const MachineLoopInfo &mli,
44 const MachineDominatorTree &mdt,
47 : ScheduleDAG(mf), MLI(mli), MDT(mdt), MFI(mf.getFrameInfo()),
48 InstrItins(mf.getTarget().getInstrItineraryData()), LIS(lis),
49 IsPostRA(IsPostRAFlag), UnitLatencies(false), CanHandleTerminators(false),
50 LoopRegs(MLI, MDT), FirstDbgValue(0) {
51 assert((IsPostRA || LIS) && "PreRA scheduling requires LiveIntervals");
53 assert(!(IsPostRA && MRI.getNumVirtRegs()) &&
54 "Virtual registers must be removed prior to PostRA scheduling");
57 /// getUnderlyingObjectFromInt - This is the function that does the work of
58 /// looking through basic ptrtoint+arithmetic+inttoptr sequences.
59 static const Value *getUnderlyingObjectFromInt(const Value *V) {
61 if (const Operator *U = dyn_cast<Operator>(V)) {
62 // If we find a ptrtoint, we can transfer control back to the
63 // regular getUnderlyingObjectFromInt.
64 if (U->getOpcode() == Instruction::PtrToInt)
65 return U->getOperand(0);
66 // If we find an add of a constant or a multiplied value, it's
67 // likely that the other operand will lead us to the base
68 // object. We don't have to worry about the case where the
69 // object address is somehow being computed by the multiply,
70 // because our callers only care when the result is an
71 // identifibale object.
72 if (U->getOpcode() != Instruction::Add ||
73 (!isa<ConstantInt>(U->getOperand(1)) &&
74 Operator::getOpcode(U->getOperand(1)) != Instruction::Mul))
80 assert(V->getType()->isIntegerTy() && "Unexpected operand type!");
84 /// getUnderlyingObject - This is a wrapper around GetUnderlyingObject
85 /// and adds support for basic ptrtoint+arithmetic+inttoptr sequences.
86 static const Value *getUnderlyingObject(const Value *V) {
87 // First just call Value::getUnderlyingObject to let it do what it does.
89 V = GetUnderlyingObject(V);
90 // If it found an inttoptr, use special code to continue climing.
91 if (Operator::getOpcode(V) != Instruction::IntToPtr)
93 const Value *O = getUnderlyingObjectFromInt(cast<User>(V)->getOperand(0));
94 // If that succeeded in finding a pointer, continue the search.
95 if (!O->getType()->isPointerTy())
102 /// getUnderlyingObjectForInstr - If this machine instr has memory reference
103 /// information and it can be tracked to a normal reference to a known
104 /// object, return the Value for that object. Otherwise return null.
105 static const Value *getUnderlyingObjectForInstr(const MachineInstr *MI,
106 const MachineFrameInfo *MFI,
109 if (!MI->hasOneMemOperand() ||
110 !(*MI->memoperands_begin())->getValue() ||
111 (*MI->memoperands_begin())->isVolatile())
114 const Value *V = (*MI->memoperands_begin())->getValue();
118 V = getUnderlyingObject(V);
119 if (const PseudoSourceValue *PSV = dyn_cast<PseudoSourceValue>(V)) {
120 // For now, ignore PseudoSourceValues which may alias LLVM IR values
121 // because the code that uses this function has no way to cope with
123 if (PSV->isAliased(MFI))
126 MayAlias = PSV->mayAlias(MFI);
130 if (isIdentifiedObject(V))
136 void ScheduleDAGInstrs::startBlock(MachineBasicBlock *bb) {
138 LoopRegs.Deps.clear();
139 if (MachineLoop *ML = MLI.getLoopFor(BB))
140 if (BB == ML->getLoopLatch())
141 LoopRegs.VisitLoop(ML);
144 void ScheduleDAGInstrs::finishBlock() {
145 // Subclasses should no longer refer to the old block.
149 /// Initialize the map with the number of registers.
150 void Reg2SUnitsMap::setRegLimit(unsigned Limit) {
151 PhysRegSet.setUniverse(Limit);
152 SUnits.resize(Limit);
155 /// Clear the map without deallocating storage.
156 void Reg2SUnitsMap::clear() {
157 for (const_iterator I = reg_begin(), E = reg_end(); I != E; ++I) {
163 /// Initialize the DAG and common scheduler state for the current scheduling
164 /// region. This does not actually create the DAG, only clears it. The
165 /// scheduling driver may call BuildSchedGraph multiple times per scheduling
167 void ScheduleDAGInstrs::enterRegion(MachineBasicBlock *bb,
168 MachineBasicBlock::iterator begin,
169 MachineBasicBlock::iterator end,
171 assert(bb == BB && "startBlock should set BB");
177 // Check to see if the scheduler cares about latencies.
178 UnitLatencies = forceUnitLatencies();
180 ScheduleDAG::clearDAG();
183 /// Close the current scheduling region. Don't clear any state in case the
184 /// driver wants to refer to the previous scheduling region.
185 void ScheduleDAGInstrs::exitRegion() {
189 /// addSchedBarrierDeps - Add dependencies from instructions in the current
190 /// list of instructions being scheduled to scheduling barrier by adding
191 /// the exit SU to the register defs and use list. This is because we want to
192 /// make sure instructions which define registers that are either used by
193 /// the terminator or are live-out are properly scheduled. This is
194 /// especially important when the definition latency of the return value(s)
195 /// are too high to be hidden by the branch or when the liveout registers
196 /// used by instructions in the fallthrough block.
197 void ScheduleDAGInstrs::addSchedBarrierDeps() {
198 MachineInstr *ExitMI = RegionEnd != BB->end() ? &*RegionEnd : 0;
199 ExitSU.setInstr(ExitMI);
200 bool AllDepKnown = ExitMI &&
201 (ExitMI->isCall() || ExitMI->isBarrier());
202 if (ExitMI && AllDepKnown) {
203 // If it's a call or a barrier, add dependencies on the defs and uses of
205 for (unsigned i = 0, e = ExitMI->getNumOperands(); i != e; ++i) {
206 const MachineOperand &MO = ExitMI->getOperand(i);
207 if (!MO.isReg() || MO.isDef()) continue;
208 unsigned Reg = MO.getReg();
209 if (Reg == 0) continue;
211 if (TRI->isPhysicalRegister(Reg))
212 Uses[Reg].push_back(&ExitSU);
214 assert(!IsPostRA && "Virtual register encountered after regalloc.");
215 addVRegUseDeps(&ExitSU, i);
219 // For others, e.g. fallthrough, conditional branch, assume the exit
220 // uses all the registers that are livein to the successor blocks.
221 assert(Uses.empty() && "Uses in set before adding deps?");
222 for (MachineBasicBlock::succ_iterator SI = BB->succ_begin(),
223 SE = BB->succ_end(); SI != SE; ++SI)
224 for (MachineBasicBlock::livein_iterator I = (*SI)->livein_begin(),
225 E = (*SI)->livein_end(); I != E; ++I) {
227 if (!Uses.contains(Reg))
228 Uses[Reg].push_back(&ExitSU);
233 /// MO is an operand of SU's instruction that defines a physical register. Add
234 /// data dependencies from SU to any uses of the physical register.
235 void ScheduleDAGInstrs::addPhysRegDataDeps(SUnit *SU,
236 const MachineOperand &MO) {
237 assert(MO.isDef() && "expect physreg def");
239 // Ask the target if address-backscheduling is desirable, and if so how much.
240 const TargetSubtargetInfo &ST = TM.getSubtarget<TargetSubtargetInfo>();
241 unsigned SpecialAddressLatency = ST.getSpecialAddressLatency();
242 unsigned DataLatency = SU->Latency;
244 for (const uint16_t *Alias = TRI->getOverlaps(MO.getReg()); *Alias; ++Alias) {
245 if (!Uses.contains(*Alias))
247 std::vector<SUnit*> &UseList = Uses[*Alias];
248 for (unsigned i = 0, e = UseList.size(); i != e; ++i) {
249 SUnit *UseSU = UseList[i];
252 unsigned LDataLatency = DataLatency;
253 // Optionally add in a special extra latency for nodes that
255 // TODO: Perhaps we should get rid of
256 // SpecialAddressLatency and just move this into
257 // adjustSchedDependency for the targets that care about it.
258 if (SpecialAddressLatency != 0 && !UnitLatencies &&
260 MachineInstr *UseMI = UseSU->getInstr();
261 const MCInstrDesc &UseMCID = UseMI->getDesc();
262 int RegUseIndex = UseMI->findRegisterUseOperandIdx(*Alias);
263 assert(RegUseIndex >= 0 && "UseMI doesn't use register!");
264 if (RegUseIndex >= 0 &&
265 (UseMI->mayLoad() || UseMI->mayStore()) &&
266 (unsigned)RegUseIndex < UseMCID.getNumOperands() &&
267 UseMCID.OpInfo[RegUseIndex].isLookupPtrRegClass())
268 LDataLatency += SpecialAddressLatency;
270 // Adjust the dependence latency using operand def/use
271 // information (if any), and then allow the target to
272 // perform its own adjustments.
273 const SDep& dep = SDep(SU, SDep::Data, LDataLatency, *Alias);
274 if (!UnitLatencies) {
275 computeOperandLatency(SU, UseSU, const_cast<SDep &>(dep));
276 ST.adjustSchedDependency(SU, UseSU, const_cast<SDep &>(dep));
283 /// addPhysRegDeps - Add register dependencies (data, anti, and output) from
284 /// this SUnit to following instructions in the same scheduling region that
285 /// depend the physical register referenced at OperIdx.
286 void ScheduleDAGInstrs::addPhysRegDeps(SUnit *SU, unsigned OperIdx) {
287 const MachineInstr *MI = SU->getInstr();
288 const MachineOperand &MO = MI->getOperand(OperIdx);
290 // Optionally add output and anti dependencies. For anti
291 // dependencies we use a latency of 0 because for a multi-issue
292 // target we want to allow the defining instruction to issue
293 // in the same cycle as the using instruction.
294 // TODO: Using a latency of 1 here for output dependencies assumes
295 // there's no cost for reusing registers.
296 SDep::Kind Kind = MO.isUse() ? SDep::Anti : SDep::Output;
297 for (const uint16_t *Alias = TRI->getOverlaps(MO.getReg()); *Alias; ++Alias) {
298 if (!Defs.contains(*Alias))
300 std::vector<SUnit *> &DefList = Defs[*Alias];
301 for (unsigned i = 0, e = DefList.size(); i != e; ++i) {
302 SUnit *DefSU = DefList[i];
303 if (DefSU == &ExitSU)
306 (Kind != SDep::Output || !MO.isDead() ||
307 !DefSU->getInstr()->registerDefIsDead(*Alias))) {
308 if (Kind == SDep::Anti)
309 DefSU->addPred(SDep(SU, Kind, 0, /*Reg=*/*Alias));
311 unsigned AOLat = TII->getOutputLatency(InstrItins, MI, OperIdx,
313 DefSU->addPred(SDep(SU, Kind, AOLat, /*Reg=*/*Alias));
320 // Either insert a new Reg2SUnits entry with an empty SUnits list, or
321 // retrieve the existing SUnits list for this register's uses.
322 // Push this SUnit on the use list.
323 Uses[MO.getReg()].push_back(SU);
326 addPhysRegDataDeps(SU, MO);
328 // Either insert a new Reg2SUnits entry with an empty SUnits list, or
329 // retrieve the existing SUnits list for this register's defs.
330 std::vector<SUnit *> &DefList = Defs[MO.getReg()];
332 // If a def is going to wrap back around to the top of the loop,
334 if (!UnitLatencies && DefList.empty()) {
335 LoopDependencies::LoopDeps::iterator I = LoopRegs.Deps.find(MO.getReg());
336 if (I != LoopRegs.Deps.end()) {
337 const MachineOperand *UseMO = I->second.first;
338 unsigned Count = I->second.second;
339 const MachineInstr *UseMI = UseMO->getParent();
340 unsigned UseMOIdx = UseMO - &UseMI->getOperand(0);
341 const MCInstrDesc &UseMCID = UseMI->getDesc();
342 const TargetSubtargetInfo &ST =
343 TM.getSubtarget<TargetSubtargetInfo>();
344 unsigned SpecialAddressLatency = ST.getSpecialAddressLatency();
345 // TODO: If we knew the total depth of the region here, we could
346 // handle the case where the whole loop is inside the region but
347 // is large enough that the isScheduleHigh trick isn't needed.
348 if (UseMOIdx < UseMCID.getNumOperands()) {
349 // Currently, we only support scheduling regions consisting of
350 // single basic blocks. Check to see if the instruction is in
351 // the same region by checking to see if it has the same parent.
352 if (UseMI->getParent() != MI->getParent()) {
353 unsigned Latency = SU->Latency;
354 if (UseMCID.OpInfo[UseMOIdx].isLookupPtrRegClass())
355 Latency += SpecialAddressLatency;
356 // This is a wild guess as to the portion of the latency which
357 // will be overlapped by work done outside the current
358 // scheduling region.
359 Latency -= std::min(Latency, Count);
360 // Add the artificial edge.
361 ExitSU.addPred(SDep(SU, SDep::Order, Latency,
362 /*Reg=*/0, /*isNormalMemory=*/false,
363 /*isMustAlias=*/false,
364 /*isArtificial=*/true));
365 } else if (SpecialAddressLatency > 0 &&
366 UseMCID.OpInfo[UseMOIdx].isLookupPtrRegClass()) {
367 // The entire loop body is within the current scheduling region
368 // and the latency of this operation is assumed to be greater
369 // than the latency of the loop.
370 // TODO: Recursively mark data-edge predecessors as
371 // isScheduleHigh too.
372 SU->isScheduleHigh = true;
375 LoopRegs.Deps.erase(I);
379 // clear this register's use list
380 if (Uses.contains(MO.getReg()))
381 Uses[MO.getReg()].clear();
386 // Calls will not be reordered because of chain dependencies (see
387 // below). Since call operands are dead, calls may continue to be added
388 // to the DefList making dependence checking quadratic in the size of
389 // the block. Instead, we leave only one call at the back of the
392 while (!DefList.empty() && DefList.back()->isCall)
395 // Defs are pushed in the order they are visited and never reordered.
396 DefList.push_back(SU);
400 /// addVRegDefDeps - Add register output and data dependencies from this SUnit
401 /// to instructions that occur later in the same scheduling region if they read
402 /// from or write to the virtual register defined at OperIdx.
404 /// TODO: Hoist loop induction variable increments. This has to be
405 /// reevaluated. Generally, IV scheduling should be done before coalescing.
406 void ScheduleDAGInstrs::addVRegDefDeps(SUnit *SU, unsigned OperIdx) {
407 const MachineInstr *MI = SU->getInstr();
408 unsigned Reg = MI->getOperand(OperIdx).getReg();
410 // SSA defs do not have output/anti dependencies.
411 // The current operand is a def, so we have at least one.
412 if (llvm::next(MRI.def_begin(Reg)) == MRI.def_end())
415 // Add output dependence to the next nearest def of this vreg.
417 // Unless this definition is dead, the output dependence should be
418 // transitively redundant with antidependencies from this definition's
419 // uses. We're conservative for now until we have a way to guarantee the uses
420 // are not eliminated sometime during scheduling. The output dependence edge
421 // is also useful if output latency exceeds def-use latency.
422 VReg2SUnitMap::iterator DefI = VRegDefs.find(Reg);
423 if (DefI == VRegDefs.end())
424 VRegDefs.insert(VReg2SUnit(Reg, SU));
426 SUnit *DefSU = DefI->SU;
427 if (DefSU != SU && DefSU != &ExitSU) {
428 unsigned OutLatency = TII->getOutputLatency(InstrItins, MI, OperIdx,
430 DefSU->addPred(SDep(SU, SDep::Output, OutLatency, Reg));
436 /// addVRegUseDeps - Add a register data dependency if the instruction that
437 /// defines the virtual register used at OperIdx is mapped to an SUnit. Add a
438 /// register antidependency from this SUnit to instructions that occur later in
439 /// the same scheduling region if they write the virtual register.
441 /// TODO: Handle ExitSU "uses" properly.
442 void ScheduleDAGInstrs::addVRegUseDeps(SUnit *SU, unsigned OperIdx) {
443 MachineInstr *MI = SU->getInstr();
444 unsigned Reg = MI->getOperand(OperIdx).getReg();
446 // Lookup this operand's reaching definition.
447 assert(LIS && "vreg dependencies requires LiveIntervals");
448 LiveRangeQuery LRQ(LIS->getInterval(Reg), LIS->getInstructionIndex(MI));
449 VNInfo *VNI = LRQ.valueIn();
451 // VNI will be valid because MachineOperand::readsReg() is checked by caller.
452 assert(VNI && "No value to read by operand");
453 MachineInstr *Def = LIS->getInstructionFromIndex(VNI->def);
454 // Phis and other noninstructions (after coalescing) have a NULL Def.
456 SUnit *DefSU = getSUnit(Def);
458 // The reaching Def lives within this scheduling region.
459 // Create a data dependence.
461 // TODO: Handle "special" address latencies cleanly.
462 const SDep &dep = SDep(DefSU, SDep::Data, DefSU->Latency, Reg);
463 if (!UnitLatencies) {
464 // Adjust the dependence latency using operand def/use information, then
465 // allow the target to perform its own adjustments.
466 computeOperandLatency(DefSU, SU, const_cast<SDep &>(dep));
467 const TargetSubtargetInfo &ST = TM.getSubtarget<TargetSubtargetInfo>();
468 ST.adjustSchedDependency(DefSU, SU, const_cast<SDep &>(dep));
474 // Add antidependence to the following def of the vreg it uses.
475 VReg2SUnitMap::iterator DefI = VRegDefs.find(Reg);
476 if (DefI != VRegDefs.end() && DefI->SU != SU)
477 DefI->SU->addPred(SDep(SU, SDep::Anti, 0, Reg));
480 /// Return true if MI is an instruction we are unable to reason about
481 /// (like a call or something with unmodeled side effects).
482 static inline bool isGlobalMemoryObject(AliasAnalysis *AA, MachineInstr *MI) {
483 if (MI->isCall() || MI->hasUnmodeledSideEffects() ||
484 (MI->hasVolatileMemoryRef() &&
485 (!MI->mayLoad() || !MI->isInvariantLoad(AA))))
490 // This MI might have either incomplete info, or known to be unsafe
491 // to deal with (i.e. volatile object).
492 static inline bool isUnsafeMemoryObject(MachineInstr *MI,
493 const MachineFrameInfo *MFI) {
494 if (!MI || MI->memoperands_empty())
496 // We purposefully do no check for hasOneMemOperand() here
497 // in hope to trigger an assert downstream in order to
498 // finish implementation.
499 if ((*MI->memoperands_begin())->isVolatile() ||
500 MI->hasUnmodeledSideEffects())
503 const Value *V = (*MI->memoperands_begin())->getValue();
507 V = getUnderlyingObject(V);
508 if (const PseudoSourceValue *PSV = dyn_cast<PseudoSourceValue>(V)) {
509 // Similarly to getUnderlyingObjectForInstr:
510 // For now, ignore PseudoSourceValues which may alias LLVM IR values
511 // because the code that uses this function has no way to cope with
513 if (PSV->isAliased(MFI))
516 // Does this pointer refer to a distinct and identifiable object?
517 if (!isIdentifiedObject(V))
523 /// This returns true if the two MIs need a chain edge betwee them.
524 /// If these are not even memory operations, we still may need
525 /// chain deps between them. The question really is - could
526 /// these two MIs be reordered during scheduling from memory dependency
528 static bool MIsNeedChainEdge(AliasAnalysis *AA, const MachineFrameInfo *MFI,
531 // Cover a trivial case - no edge is need to itself.
535 if (isUnsafeMemoryObject(MIa, MFI) || isUnsafeMemoryObject(MIb, MFI))
538 // If we are dealing with two "normal" loads, we do not need an edge
539 // between them - they could be reordered.
540 if (!MIa->mayStore() && !MIb->mayStore())
543 // To this point analysis is generic. From here on we do need AA.
547 MachineMemOperand *MMOa = *MIa->memoperands_begin();
548 MachineMemOperand *MMOb = *MIb->memoperands_begin();
550 // FIXME: Need to handle multiple memory operands to support all targets.
551 if (!MIa->hasOneMemOperand() || !MIb->hasOneMemOperand())
552 llvm_unreachable("Multiple memory operands.");
554 // The following interface to AA is fashioned after DAGCombiner::isAlias
555 // and operates with MachineMemOperand offset with some important
557 // - LLVM fundamentally assumes flat address spaces.
558 // - MachineOperand offset can *only* result from legalization and
559 // cannot affect queries other than the trivial case of overlap
561 // - These offsets never wrap and never step outside
562 // of allocated objects.
563 // - There should never be any negative offsets here.
565 // FIXME: Modify API to hide this math from "user"
566 // FIXME: Even before we go to AA we can reason locally about some
567 // memory objects. It can save compile time, and possibly catch some
568 // corner cases not currently covered.
570 assert ((MMOa->getOffset() >= 0) && "Negative MachineMemOperand offset");
571 assert ((MMOb->getOffset() >= 0) && "Negative MachineMemOperand offset");
573 int64_t MinOffset = std::min(MMOa->getOffset(), MMOb->getOffset());
574 int64_t Overlapa = MMOa->getSize() + MMOa->getOffset() - MinOffset;
575 int64_t Overlapb = MMOb->getSize() + MMOb->getOffset() - MinOffset;
577 AliasAnalysis::AliasResult AAResult = AA->alias(
578 AliasAnalysis::Location(MMOa->getValue(), Overlapa,
579 MMOa->getTBAAInfo()),
580 AliasAnalysis::Location(MMOb->getValue(), Overlapb,
581 MMOb->getTBAAInfo()));
583 return (AAResult != AliasAnalysis::NoAlias);
586 /// This recursive function iterates over chain deps of SUb looking for
587 /// "latest" node that needs a chain edge to SUa.
589 iterateChainSucc(AliasAnalysis *AA, const MachineFrameInfo *MFI,
590 SUnit *SUa, SUnit *SUb, SUnit *ExitSU, unsigned *Depth,
591 SmallPtrSet<const SUnit*, 16> &Visited) {
592 if (!SUa || !SUb || SUb == ExitSU)
595 // Remember visited nodes.
596 if (!Visited.insert(SUb))
598 // If there is _some_ dependency already in place, do not
599 // descend any further.
600 // TODO: Need to make sure that if that dependency got eliminated or ignored
601 // for any reason in the future, we would not violate DAG topology.
602 // Currently it does not happen, but makes an implicit assumption about
603 // future implementation.
605 // Independently, if we encounter node that is some sort of global
606 // object (like a call) we already have full set of dependencies to it
607 // and we can stop descending.
608 if (SUa->isSucc(SUb) ||
609 isGlobalMemoryObject(AA, SUb->getInstr()))
612 // If we do need an edge, or we have exceeded depth budget,
613 // add that edge to the predecessors chain of SUb,
614 // and stop descending.
616 MIsNeedChainEdge(AA, MFI, SUa->getInstr(), SUb->getInstr())) {
617 SUb->addPred(SDep(SUa, SDep::Order, /*Latency=*/0, /*Reg=*/0,
618 /*isNormalMemory=*/true));
621 // Track current depth.
623 // Iterate over chain dependencies only.
624 for (SUnit::const_succ_iterator I = SUb->Succs.begin(), E = SUb->Succs.end();
627 iterateChainSucc (AA, MFI, SUa, I->getSUnit(), ExitSU, Depth, Visited);
631 /// This function assumes that "downward" from SU there exist
632 /// tail/leaf of already constructed DAG. It iterates downward and
633 /// checks whether SU can be aliasing any node dominated
635 static void adjustChainDeps(AliasAnalysis *AA, const MachineFrameInfo *MFI,
636 SUnit *SU, SUnit *ExitSU, std::set<SUnit *> &CheckList) {
640 SmallPtrSet<const SUnit*, 16> Visited;
643 for (std::set<SUnit *>::iterator I = CheckList.begin(), IE = CheckList.end();
647 if (MIsNeedChainEdge(AA, MFI, SU->getInstr(), (*I)->getInstr()))
648 (*I)->addPred(SDep(SU, SDep::Order, /*Latency=*/0, /*Reg=*/0,
649 /*isNormalMemory=*/true));
650 // Now go through all the chain successors and iterate from them.
651 // Keep track of visited nodes.
652 for (SUnit::const_succ_iterator J = (*I)->Succs.begin(),
653 JE = (*I)->Succs.end(); J != JE; ++J)
655 iterateChainSucc (AA, MFI, SU, J->getSUnit(),
656 ExitSU, &Depth, Visited);
660 /// Check whether two objects need a chain edge, if so, add it
661 /// otherwise remember the rejected SU.
663 void addChainDependency (AliasAnalysis *AA, const MachineFrameInfo *MFI,
664 SUnit *SUa, SUnit *SUb,
665 std::set<SUnit *> &RejectList,
666 unsigned TrueMemOrderLatency = 0,
667 bool isNormalMemory = false) {
668 // If this is a false dependency,
669 // do not add the edge, but rememeber the rejected node.
670 if (!EnableAASchedMI ||
671 MIsNeedChainEdge(AA, MFI, SUa->getInstr(), SUb->getInstr()))
672 SUb->addPred(SDep(SUa, SDep::Order, TrueMemOrderLatency, /*Reg=*/0,
675 // Duplicate entries should be ignored.
676 RejectList.insert(SUb);
677 DEBUG(dbgs() << "\tReject chain dep between SU("
678 << SUa->NodeNum << ") and SU("
679 << SUb->NodeNum << ")\n");
683 /// Create an SUnit for each real instruction, numbered in top-down toplological
684 /// order. The instruction order A < B, implies that no edge exists from B to A.
686 /// Map each real instruction to its SUnit.
688 /// After initSUnits, the SUnits vector cannot be resized and the scheduler may
689 /// hang onto SUnit pointers. We may relax this in the future by using SUnit IDs
690 /// instead of pointers.
692 /// MachineScheduler relies on initSUnits numbering the nodes by their order in
693 /// the original instruction list.
694 void ScheduleDAGInstrs::initSUnits() {
695 // We'll be allocating one SUnit for each real instruction in the region,
696 // which is contained within a basic block.
697 SUnits.reserve(BB->size());
699 for (MachineBasicBlock::iterator I = RegionBegin; I != RegionEnd; ++I) {
700 MachineInstr *MI = I;
701 if (MI->isDebugValue())
704 SUnit *SU = newSUnit(MI);
707 SU->isCall = MI->isCall();
708 SU->isCommutable = MI->isCommutable();
710 // Assign the Latency field of SU using target-provided information.
718 /// If RegPressure is non null, compute register pressure as a side effect. The
719 /// DAG builder is an efficient place to do it because it already visits
721 void ScheduleDAGInstrs::buildSchedGraph(AliasAnalysis *AA,
722 RegPressureTracker *RPTracker) {
723 // Create an SUnit for each real instruction.
726 // We build scheduling units by walking a block's instruction list from bottom
729 // Remember where a generic side-effecting instruction is as we procede.
730 SUnit *BarrierChain = 0, *AliasChain = 0;
732 // Memory references to specific known memory locations are tracked
733 // so that they can be given more precise dependencies. We track
734 // separately the known memory locations that may alias and those
735 // that are known not to alias
736 std::map<const Value *, SUnit *> AliasMemDefs, NonAliasMemDefs;
737 std::map<const Value *, std::vector<SUnit *> > AliasMemUses, NonAliasMemUses;
738 std::set<SUnit*> RejectMemNodes;
740 // Remove any stale debug info; sometimes BuildSchedGraph is called again
741 // without emitting the info from the previous call.
743 FirstDbgValue = NULL;
745 assert(Defs.empty() && Uses.empty() &&
746 "Only BuildGraph should update Defs/Uses");
747 Defs.setRegLimit(TRI->getNumRegs());
748 Uses.setRegLimit(TRI->getNumRegs());
750 assert(VRegDefs.empty() && "Only BuildSchedGraph may access VRegDefs");
751 // FIXME: Allow SparseSet to reserve space for the creation of virtual
752 // registers during scheduling. Don't artificially inflate the Universe
753 // because we want to assert that vregs are not created during DAG building.
754 VRegDefs.setUniverse(MRI.getNumVirtRegs());
756 // Model data dependencies between instructions being scheduled and the
758 addSchedBarrierDeps();
760 // Walk the list of instructions, from bottom moving up.
761 MachineInstr *PrevMI = NULL;
762 for (MachineBasicBlock::iterator MII = RegionEnd, MIE = RegionBegin;
764 MachineInstr *MI = prior(MII);
766 DbgValues.push_back(std::make_pair(PrevMI, MI));
770 if (MI->isDebugValue()) {
776 assert(RPTracker->getPos() == prior(MII) && "RPTracker can't find MI");
779 assert((!MI->isTerminator() || CanHandleTerminators) && !MI->isLabel() &&
780 "Cannot schedule terminators or labels!");
782 SUnit *SU = MISUnitMap[MI];
783 assert(SU && "No SUnit mapped to this MI");
785 // Add register-based dependencies (data, anti, and output).
786 for (unsigned j = 0, n = MI->getNumOperands(); j != n; ++j) {
787 const MachineOperand &MO = MI->getOperand(j);
788 if (!MO.isReg()) continue;
789 unsigned Reg = MO.getReg();
790 if (Reg == 0) continue;
792 if (TRI->isPhysicalRegister(Reg))
793 addPhysRegDeps(SU, j);
795 assert(!IsPostRA && "Virtual register encountered!");
797 addVRegDefDeps(SU, j);
798 else if (MO.readsReg()) // ignore undef operands
799 addVRegUseDeps(SU, j);
803 // Add chain dependencies.
804 // Chain dependencies used to enforce memory order should have
805 // latency of 0 (except for true dependency of Store followed by
806 // aliased Load... we estimate that with a single cycle of latency
807 // assuming the hardware will bypass)
808 // Note that isStoreToStackSlot and isLoadFromStackSLot are not usable
809 // after stack slots are lowered to actual addresses.
810 // TODO: Use an AliasAnalysis and do real alias-analysis queries, and
811 // produce more precise dependence information.
812 #define STORE_LOAD_LATENCY 1
813 unsigned TrueMemOrderLatency = 0;
814 if (isGlobalMemoryObject(AA, MI)) {
815 // Be conservative with these and add dependencies on all memory
816 // references, even those that are known to not alias.
817 for (std::map<const Value *, SUnit *>::iterator I =
818 NonAliasMemDefs.begin(), E = NonAliasMemDefs.end(); I != E; ++I) {
819 I->second->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
821 for (std::map<const Value *, std::vector<SUnit *> >::iterator I =
822 NonAliasMemUses.begin(), E = NonAliasMemUses.end(); I != E; ++I) {
823 for (unsigned i = 0, e = I->second.size(); i != e; ++i)
824 I->second[i]->addPred(SDep(SU, SDep::Order, TrueMemOrderLatency));
826 // Add SU to the barrier chain.
828 BarrierChain->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
830 // This is a barrier event that acts as a pivotal node in the DAG,
831 // so it is safe to clear list of exposed nodes.
832 adjustChainDeps(AA, MFI, SU, &ExitSU, RejectMemNodes);
833 RejectMemNodes.clear();
834 NonAliasMemDefs.clear();
835 NonAliasMemUses.clear();
839 // Chain all possibly aliasing memory references though SU.
841 addChainDependency(AA, MFI, SU, AliasChain, RejectMemNodes);
843 for (unsigned k = 0, m = PendingLoads.size(); k != m; ++k)
844 addChainDependency(AA, MFI, SU, PendingLoads[k], RejectMemNodes,
845 TrueMemOrderLatency);
846 for (std::map<const Value *, SUnit *>::iterator I = AliasMemDefs.begin(),
847 E = AliasMemDefs.end(); I != E; ++I)
848 addChainDependency(AA, MFI, SU, I->second, RejectMemNodes);
849 for (std::map<const Value *, std::vector<SUnit *> >::iterator I =
850 AliasMemUses.begin(), E = AliasMemUses.end(); I != E; ++I) {
851 for (unsigned i = 0, e = I->second.size(); i != e; ++i)
852 addChainDependency(AA, MFI, SU, I->second[i], RejectMemNodes,
853 TrueMemOrderLatency);
855 adjustChainDeps(AA, MFI, SU, &ExitSU, RejectMemNodes);
856 PendingLoads.clear();
857 AliasMemDefs.clear();
858 AliasMemUses.clear();
859 } else if (MI->mayStore()) {
860 bool MayAlias = true;
861 TrueMemOrderLatency = STORE_LOAD_LATENCY;
862 if (const Value *V = getUnderlyingObjectForInstr(MI, MFI, MayAlias)) {
863 // A store to a specific PseudoSourceValue. Add precise dependencies.
864 // Record the def in MemDefs, first adding a dep if there is
866 std::map<const Value *, SUnit *>::iterator I =
867 ((MayAlias) ? AliasMemDefs.find(V) : NonAliasMemDefs.find(V));
868 std::map<const Value *, SUnit *>::iterator IE =
869 ((MayAlias) ? AliasMemDefs.end() : NonAliasMemDefs.end());
871 addChainDependency(AA, MFI, SU, I->second, RejectMemNodes,
876 AliasMemDefs[V] = SU;
878 NonAliasMemDefs[V] = SU;
880 // Handle the uses in MemUses, if there are any.
881 std::map<const Value *, std::vector<SUnit *> >::iterator J =
882 ((MayAlias) ? AliasMemUses.find(V) : NonAliasMemUses.find(V));
883 std::map<const Value *, std::vector<SUnit *> >::iterator JE =
884 ((MayAlias) ? AliasMemUses.end() : NonAliasMemUses.end());
886 for (unsigned i = 0, e = J->second.size(); i != e; ++i)
887 addChainDependency(AA, MFI, SU, J->second[i], RejectMemNodes,
888 TrueMemOrderLatency, true);
892 // Add dependencies from all the PendingLoads, i.e. loads
893 // with no underlying object.
894 for (unsigned k = 0, m = PendingLoads.size(); k != m; ++k)
895 addChainDependency(AA, MFI, SU, PendingLoads[k], RejectMemNodes,
896 TrueMemOrderLatency);
897 // Add dependence on alias chain, if needed.
899 addChainDependency(AA, MFI, SU, AliasChain, RejectMemNodes);
900 // But we also should check dependent instructions for the
902 adjustChainDeps(AA, MFI, SU, &ExitSU, RejectMemNodes);
904 // Add dependence on barrier chain, if needed.
905 // There is no point to check aliasing on barrier event. Even if
906 // SU and barrier _could_ be reordered, they should not. In addition,
907 // we have lost all RejectMemNodes below barrier.
909 BarrierChain->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
911 // Treat all other stores conservatively.
912 goto new_alias_chain;
915 if (!ExitSU.isPred(SU))
916 // Push store's up a bit to avoid them getting in between cmp
918 ExitSU.addPred(SDep(SU, SDep::Order, 0,
919 /*Reg=*/0, /*isNormalMemory=*/false,
920 /*isMustAlias=*/false,
921 /*isArtificial=*/true));
922 } else if (MI->mayLoad()) {
923 bool MayAlias = true;
924 TrueMemOrderLatency = 0;
925 if (MI->isInvariantLoad(AA)) {
926 // Invariant load, no chain dependencies needed!
929 getUnderlyingObjectForInstr(MI, MFI, MayAlias)) {
930 // A load from a specific PseudoSourceValue. Add precise dependencies.
931 std::map<const Value *, SUnit *>::iterator I =
932 ((MayAlias) ? AliasMemDefs.find(V) : NonAliasMemDefs.find(V));
933 std::map<const Value *, SUnit *>::iterator IE =
934 ((MayAlias) ? AliasMemDefs.end() : NonAliasMemDefs.end());
936 addChainDependency(AA, MFI, SU, I->second, RejectMemNodes, 0, true);
938 AliasMemUses[V].push_back(SU);
940 NonAliasMemUses[V].push_back(SU);
942 // A load with no underlying object. Depend on all
943 // potentially aliasing stores.
944 for (std::map<const Value *, SUnit *>::iterator I =
945 AliasMemDefs.begin(), E = AliasMemDefs.end(); I != E; ++I)
946 addChainDependency(AA, MFI, SU, I->second, RejectMemNodes);
948 PendingLoads.push_back(SU);
952 adjustChainDeps(AA, MFI, SU, &ExitSU, RejectMemNodes);
953 // Add dependencies on alias and barrier chains, if needed.
954 if (MayAlias && AliasChain)
955 addChainDependency(AA, MFI, SU, AliasChain, RejectMemNodes);
957 BarrierChain->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
962 FirstDbgValue = PrevMI;
967 PendingLoads.clear();
970 void ScheduleDAGInstrs::computeLatency(SUnit *SU) {
971 // Compute the latency for the node.
972 if (!InstrItins || InstrItins->isEmpty()) {
975 // Simplistic target-independent heuristic: assume that loads take
977 if (SU->getInstr()->mayLoad())
980 SU->Latency = TII->getInstrLatency(InstrItins, SU->getInstr());
984 void ScheduleDAGInstrs::computeOperandLatency(SUnit *Def, SUnit *Use,
986 if (!InstrItins || InstrItins->isEmpty())
989 // For a data dependency with a known register...
990 if ((dep.getKind() != SDep::Data) || (dep.getReg() == 0))
993 const unsigned Reg = dep.getReg();
995 // ... find the definition of the register in the defining
997 MachineInstr *DefMI = Def->getInstr();
998 int DefIdx = DefMI->findRegisterDefOperandIdx(Reg);
1000 const MachineOperand &MO = DefMI->getOperand(DefIdx);
1001 if (MO.isReg() && MO.isImplicit() &&
1002 DefIdx >= (int)DefMI->getDesc().getNumOperands()) {
1003 // This is an implicit def, getOperandLatency() won't return the correct
1005 // %D6<def>, %D7<def> = VLD1q16 %R2<kill>, 0, ..., %Q3<imp-def>
1006 // %Q1<def> = VMULv8i16 %Q1<kill>, %Q3<kill>, ...
1007 // What we want is to compute latency between def of %D6/%D7 and use of
1009 unsigned Op2 = DefMI->findRegisterDefOperandIdx(Reg, false, true, TRI);
1010 if (DefMI->getOperand(Op2).isReg())
1013 MachineInstr *UseMI = Use->getInstr();
1014 // For all uses of the register, calculate the maxmimum latency
1017 for (unsigned i = 0, e = UseMI->getNumOperands(); i != e; ++i) {
1018 const MachineOperand &MO = UseMI->getOperand(i);
1019 if (!MO.isReg() || !MO.isUse())
1021 unsigned MOReg = MO.getReg();
1025 int UseCycle = TII->getOperandLatency(InstrItins, DefMI, DefIdx,
1027 Latency = std::max(Latency, UseCycle);
1030 // UseMI is null, then it must be a scheduling barrier.
1031 if (!InstrItins || InstrItins->isEmpty())
1033 unsigned DefClass = DefMI->getDesc().getSchedClass();
1034 Latency = InstrItins->getOperandCycle(DefClass, DefIdx);
1037 // If we found a latency, then replace the existing dependence latency.
1039 dep.setLatency(Latency);
1043 void ScheduleDAGInstrs::dumpNode(const SUnit *SU) const {
1044 SU->getInstr()->dump();
1047 std::string ScheduleDAGInstrs::getGraphNodeLabel(const SUnit *SU) const {
1049 raw_string_ostream oss(s);
1052 else if (SU == &ExitSU)
1055 SU->getInstr()->print(oss);
1059 /// Return the basic block label. It is not necessarilly unique because a block
1060 /// contains multiple scheduling regions. But it is fine for visualization.
1061 std::string ScheduleDAGInstrs::getDAGName() const {
1062 return "dag." + BB->getFullName();