lib/CodeGen/ScheduleDAGInstrs.cpp

   1 //===---- ScheduleDAGInstrs.cpp - MachineInstr Rescheduling ---------------===//
   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 implements the ScheduleDAGInstrs class, which implements re-scheduling
  11 // of MachineInstrs.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "sched-instrs"
  16 #include "ScheduleDAGInstrs.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/MC/MCInstrItineraries.h"
  26 #include "llvm/Target/TargetMachine.h"
  27 #include "llvm/Target/TargetInstrInfo.h"
  28 #include "llvm/Target/TargetRegisterInfo.h"
  29 #include "llvm/Target/TargetSubtargetInfo.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include "llvm/ADT/SmallSet.h"
  33 using namespace llvm;
  34
  35 ScheduleDAGInstrs::ScheduleDAGInstrs(MachineFunction &mf,
  36                                      const MachineLoopInfo &mli,
  37                                      const MachineDominatorTree &mdt,
  38                                      bool IsPostRAFlag,
  39                                      LiveIntervals *lis)
  40   : ScheduleDAG(mf), MLI(mli), MDT(mdt), MFI(mf.getFrameInfo()),
  41     InstrItins(mf.getTarget().getInstrItineraryData()), IsPostRA(IsPostRAFlag),
  42     LIS(lis), UnitLatencies(false),
  43     Defs(TRI->getNumRegs()), Uses(TRI->getNumRegs()),
  44     LoopRegs(MLI, MDT), FirstDbgValue(0) {
  45   assert((IsPostRA || LIS) && "PreRA scheduling requires LiveIntervals");
  46   DbgValues.clear();
  47   assert(!(IsPostRA && MRI.getNumVirtRegs()) &&
  48          "Virtual registers must be removed prior to PostRA scheduling");
  49 }
  50
  51 /// Run - perform scheduling.
  52 ///
  53 void ScheduleDAGInstrs::Run(MachineBasicBlock *bb,
  54                             MachineBasicBlock::iterator begin,
  55                             MachineBasicBlock::iterator end,
  56                             unsigned endcount) {
  57   BB = bb;
  58   Begin = begin;
  59   InsertPosIndex = endcount;
  60
  61   // Check to see if the scheduler cares about latencies.
  62   UnitLatencies = ForceUnitLatencies();
  63
  64   ScheduleDAG::Run(bb, end);
  65 }
  66
  67 /// getUnderlyingObjectFromInt - This is the function that does the work of
  68 /// looking through basic ptrtoint+arithmetic+inttoptr sequences.
  69 static const Value *getUnderlyingObjectFromInt(const Value *V) {
  70   do {
  71     if (const Operator *U = dyn_cast<Operator>(V)) {
  72       // If we find a ptrtoint, we can transfer control back to the
  73       // regular getUnderlyingObjectFromInt.
  74       if (U->getOpcode() == Instruction::PtrToInt)
  75         return U->getOperand(0);
  76       // If we find an add of a constant or a multiplied value, it's
  77       // likely that the other operand will lead us to the base
  78       // object. We don't have to worry about the case where the
  79       // object address is somehow being computed by the multiply,
  80       // because our callers only care when the result is an
  81       // identifibale object.
  82       if (U->getOpcode() != Instruction::Add ||
  83           (!isa<ConstantInt>(U->getOperand(1)) &&
  84            Operator::getOpcode(U->getOperand(1)) != Instruction::Mul))
  85         return V;
  86       V = U->getOperand(0);
  87     } else {
  88       return V;
  89     }
  90     assert(V->getType()->isIntegerTy() && "Unexpected operand type!");
  91   } while (1);
  92 }
  93
  94 /// getUnderlyingObject - This is a wrapper around GetUnderlyingObject
  95 /// and adds support for basic ptrtoint+arithmetic+inttoptr sequences.
  96 static const Value *getUnderlyingObject(const Value *V) {
  97   // First just call Value::getUnderlyingObject to let it do what it does.
  98   do {
  99     V = GetUnderlyingObject(V);
 100     // If it found an inttoptr, use special code to continue climing.
 101     if (Operator::getOpcode(V) != Instruction::IntToPtr)
 102       break;
 103     const Value *O = getUnderlyingObjectFromInt(cast<User>(V)->getOperand(0));
 104     // If that succeeded in finding a pointer, continue the search.
 105     if (!O->getType()->isPointerTy())
 106       break;
 107     V = O;
 108   } while (1);
 109   return V;
 110 }
 111
 112 /// getUnderlyingObjectForInstr - If this machine instr has memory reference
 113 /// information and it can be tracked to a normal reference to a known
 114 /// object, return the Value for that object. Otherwise return null.
 115 static const Value *getUnderlyingObjectForInstr(const MachineInstr *MI,
 116                                                 const MachineFrameInfo *MFI,
 117                                                 bool &MayAlias) {
 118   MayAlias = true;
 119   if (!MI->hasOneMemOperand() ||
 120       !(*MI->memoperands_begin())->getValue() ||
 121       (*MI->memoperands_begin())->isVolatile())
 122     return 0;
 123
 124   const Value *V = (*MI->memoperands_begin())->getValue();
 125   if (!V)
 126     return 0;
 127
 128   V = getUnderlyingObject(V);
 129   if (const PseudoSourceValue *PSV = dyn_cast<PseudoSourceValue>(V)) {
 130     // For now, ignore PseudoSourceValues which may alias LLVM IR values
 131     // because the code that uses this function has no way to cope with
 132     // such aliases.
 133     if (PSV->isAliased(MFI))
 134       return 0;
 135
 136     MayAlias = PSV->mayAlias(MFI);
 137     return V;
 138   }
 139
 140   if (isIdentifiedObject(V))
 141     return V;
 142
 143   return 0;
 144 }
 145
 146 void ScheduleDAGInstrs::StartBlock(MachineBasicBlock *BB) {
 147   LoopRegs.Deps.clear();
 148   if (MachineLoop *ML = MLI.getLoopFor(BB))
 149     if (BB == ML->getLoopLatch())
 150       LoopRegs.VisitLoop(ML);
 151 }
 152
 153 /// AddSchedBarrierDeps - Add dependencies from instructions in the current
 154 /// list of instructions being scheduled to scheduling barrier by adding
 155 /// the exit SU to the register defs and use list. This is because we want to
 156 /// make sure instructions which define registers that are either used by
 157 /// the terminator or are live-out are properly scheduled. This is
 158 /// especially important when the definition latency of the return value(s)
 159 /// are too high to be hidden by the branch or when the liveout registers
 160 /// used by instructions in the fallthrough block.
 161 void ScheduleDAGInstrs::AddSchedBarrierDeps() {
 162   MachineInstr *ExitMI = InsertPos != BB->end() ? &*InsertPos : 0;
 163   ExitSU.setInstr(ExitMI);
 164   bool AllDepKnown = ExitMI &&
 165     (ExitMI->isCall() || ExitMI->isBarrier());
 166   if (ExitMI && AllDepKnown) {
 167     // If it's a call or a barrier, add dependencies on the defs and uses of
 168     // instruction.
 169     for (unsigned i = 0, e = ExitMI->getNumOperands(); i != e; ++i) {
 170       const MachineOperand &MO = ExitMI->getOperand(i);
 171       if (!MO.isReg() || MO.isDef()) continue;
 172       unsigned Reg = MO.getReg();
 173       if (Reg == 0) continue;
 174
 175       if (TRI->isPhysicalRegister(Reg))
 176         Uses[Reg].push_back(&ExitSU);
 177       else
 178         assert(!IsPostRA && "Virtual register encountered after regalloc.");
 179     }
 180   } else {
 181     // For others, e.g. fallthrough, conditional branch, assume the exit
 182     // uses all the registers that are livein to the successor blocks.
 183     SmallSet<unsigned, 8> Seen;
 184     for (MachineBasicBlock::succ_iterator SI = BB->succ_begin(),
 185            SE = BB->succ_end(); SI != SE; ++SI)
 186       for (MachineBasicBlock::livein_iterator I = (*SI)->livein_begin(),
 187              E = (*SI)->livein_end(); I != E; ++I) {
 188         unsigned Reg = *I;
 189         if (Seen.insert(Reg))
 190           Uses[Reg].push_back(&ExitSU);
 191       }
 192   }
 193 }
 194
 195 /// addPhysRegDeps - Add register dependencies (data, anti, and output) from
 196 /// this SUnit to following instructions in the same scheduling region that
 197 /// depend the physical register referenced at OperIdx.
 198 void ScheduleDAGInstrs::addPhysRegDeps(SUnit *SU, unsigned OperIdx) {
 199   const MachineInstr *MI = SU->getInstr();
 200   const MachineOperand &MO = MI->getOperand(OperIdx);
 201   unsigned Reg = MO.getReg();
 202
 203   // Ask the target if address-backscheduling is desirable, and if so how much.
 204   const TargetSubtargetInfo &ST = TM.getSubtarget<TargetSubtargetInfo>();
 205   unsigned SpecialAddressLatency = ST.getSpecialAddressLatency();
 206
 207   // Optionally add output and anti dependencies. For anti
 208   // dependencies we use a latency of 0 because for a multi-issue
 209   // target we want to allow the defining instruction to issue
 210   // in the same cycle as the using instruction.
 211   // TODO: Using a latency of 1 here for output dependencies assumes
 212   //       there's no cost for reusing registers.
 213   SDep::Kind Kind = MO.isUse() ? SDep::Anti : SDep::Output;
 214   for (const unsigned *Alias = TRI->getOverlaps(Reg); *Alias; ++Alias) {
 215     std::vector<SUnit *> &DefList = Defs[*Alias];
 216     for (unsigned i = 0, e = DefList.size(); i != e; ++i) {
 217       SUnit *DefSU = DefList[i];
 218       if (DefSU == &ExitSU)
 219         continue;
 220       if (DefSU != SU &&
 221           (Kind != SDep::Output || !MO.isDead() ||
 222            !DefSU->getInstr()->registerDefIsDead(*Alias))) {
 223         if (Kind == SDep::Anti)
 224           DefSU->addPred(SDep(SU, Kind, 0, /*Reg=*/*Alias));
 225         else {
 226           unsigned AOLat = TII->getOutputLatency(InstrItins, MI, OperIdx,
 227                                                  DefSU->getInstr());
 228           DefSU->addPred(SDep(SU, Kind, AOLat, /*Reg=*/*Alias));
 229         }
 230       }
 231     }
 232   }
 233
 234   // Retrieve the UseList to add data dependencies and update uses.
 235   std::vector<SUnit *> &UseList = Uses[Reg];
 236   if (MO.isDef()) {
 237     // Update DefList. Defs are pushed in the order they are visited and
 238     // never reordered.
 239     std::vector<SUnit *> &DefList = Defs[Reg];
 240
 241     // Add any data dependencies.
 242     unsigned DataLatency = SU->Latency;
 243     for (unsigned i = 0, e = UseList.size(); i != e; ++i) {
 244       SUnit *UseSU = UseList[i];
 245       if (UseSU == SU)
 246         continue;
 247       unsigned LDataLatency = DataLatency;
 248       // Optionally add in a special extra latency for nodes that
 249       // feed addresses.
 250       // TODO: Do this for register aliases too.
 251       // TODO: Perhaps we should get rid of
 252       // SpecialAddressLatency and just move this into
 253       // adjustSchedDependency for the targets that care about it.
 254       if (SpecialAddressLatency != 0 && !UnitLatencies &&
 255           UseSU != &ExitSU) {
 256         MachineInstr *UseMI = UseSU->getInstr();
 257         const MCInstrDesc &UseMCID = UseMI->getDesc();
 258         int RegUseIndex = UseMI->findRegisterUseOperandIdx(Reg);
 259         assert(RegUseIndex >= 0 && "UseMI doesn's use register!");
 260         if (RegUseIndex >= 0 &&
 261             (UseMI->mayLoad() || UseMI->mayStore()) &&
 262             (unsigned)RegUseIndex < UseMCID.getNumOperands() &&
 263             UseMCID.OpInfo[RegUseIndex].isLookupPtrRegClass())
 264           LDataLatency += SpecialAddressLatency;
 265       }
 266       // Adjust the dependence latency using operand def/use
 267       // information (if any), and then allow the target to
 268       // perform its own adjustments.
 269       const SDep& dep = SDep(SU, SDep::Data, LDataLatency, Reg);
 270       if (!UnitLatencies) {
 271         ComputeOperandLatency(SU, UseSU, const_cast<SDep &>(dep));
 272         ST.adjustSchedDependency(SU, UseSU, const_cast<SDep &>(dep));
 273       }
 274       UseSU->addPred(dep);
 275     }
 276     for (const unsigned *Alias = TRI->getAliasSet(Reg); *Alias; ++Alias) {
 277       std::vector<SUnit *> &UseList = Uses[*Alias];
 278       for (unsigned i = 0, e = UseList.size(); i != e; ++i) {
 279         SUnit *UseSU = UseList[i];
 280         if (UseSU == SU)
 281           continue;
 282         const SDep& dep = SDep(SU, SDep::Data, DataLatency, *Alias);
 283         if (!UnitLatencies) {
 284           ComputeOperandLatency(SU, UseSU, const_cast<SDep &>(dep));
 285           ST.adjustSchedDependency(SU, UseSU, const_cast<SDep &>(dep));
 286         }
 287         UseSU->addPred(dep);
 288       }
 289     }
 290
 291     // If a def is going to wrap back around to the top of the loop,
 292     // backschedule it.
 293     if (!UnitLatencies && DefList.empty()) {
 294       LoopDependencies::LoopDeps::iterator I = LoopRegs.Deps.find(Reg);
 295       if (I != LoopRegs.Deps.end()) {
 296         const MachineOperand *UseMO = I->second.first;
 297         unsigned Count = I->second.second;
 298         const MachineInstr *UseMI = UseMO->getParent();
 299         unsigned UseMOIdx = UseMO - &UseMI->getOperand(0);
 300         const MCInstrDesc &UseMCID = UseMI->getDesc();
 301         // TODO: If we knew the total depth of the region here, we could
 302         // handle the case where the whole loop is inside the region but
 303         // is large enough that the isScheduleHigh trick isn't needed.
 304         if (UseMOIdx < UseMCID.getNumOperands()) {
 305           // Currently, we only support scheduling regions consisting of
 306           // single basic blocks. Check to see if the instruction is in
 307           // the same region by checking to see if it has the same parent.
 308           if (UseMI->getParent() != MI->getParent()) {
 309             unsigned Latency = SU->Latency;
 310             if (UseMCID.OpInfo[UseMOIdx].isLookupPtrRegClass())
 311               Latency += SpecialAddressLatency;
 312             // This is a wild guess as to the portion of the latency which
 313             // will be overlapped by work done outside the current
 314             // scheduling region.
 315             Latency -= std::min(Latency, Count);
 316             // Add the artificial edge.
 317             ExitSU.addPred(SDep(SU, SDep::Order, Latency,
 318                                 /*Reg=*/0, /*isNormalMemory=*/false,
 319                                 /*isMustAlias=*/false,
 320                                 /*isArtificial=*/true));
 321           } else if (SpecialAddressLatency > 0 &&
 322                      UseMCID.OpInfo[UseMOIdx].isLookupPtrRegClass()) {
 323             // The entire loop body is within the current scheduling region
 324             // and the latency of this operation is assumed to be greater
 325             // than the latency of the loop.
 326             // TODO: Recursively mark data-edge predecessors as
 327             //       isScheduleHigh too.
 328             SU->isScheduleHigh = true;
 329           }
 330         }
 331         LoopRegs.Deps.erase(I);
 332       }
 333     }
 334
 335     UseList.clear();
 336     if (!MO.isDead())
 337       DefList.clear();
 338
 339     // Calls will not be reordered because of chain dependencies (see
 340     // below). Since call operands are dead, calls may continue to be added
 341     // to the DefList making dependence checking quadratic in the size of
 342     // the block. Instead, we leave only one call at the back of the
 343     // DefList.
 344     if (SU->isCall) {
 345       while (!DefList.empty() && DefList.back()->isCall)
 346         DefList.pop_back();
 347     }
 348     DefList.push_back(SU);
 349   } else {
 350     UseList.push_back(SU);
 351   }
 352 }
 353
 354 /// addVRegDefDeps - Add register output and data dependencies from this SUnit
 355 /// to instructions that occur later in the same scheduling region if they read
 356 /// from or write to the virtual register defined at OperIdx.
 357 ///
 358 /// TODO: Hoist loop induction variable increments. This has to be
 359 /// reevaluated. Generally, IV scheduling should be done before coalescing.
 360 void ScheduleDAGInstrs::addVRegDefDeps(SUnit *SU, unsigned OperIdx) {
 361   const MachineInstr *MI = SU->getInstr();
 362   unsigned Reg = MI->getOperand(OperIdx).getReg();
 363
 364   // SSA defs do not have output/anti dependencies.
 365   // The current operand is a def, so we have at least one.
 366   if (llvm::next(MRI.def_begin(Reg)) == MRI.def_end())
 367     return;
 368
 369   // Add output dependence to the next nearest def of this vreg.
 370   //
 371   // Unless this definition is dead, the output dependence should be
 372   // transitively redundant with antidependencies from this definition's
 373   // uses. We're conservative for now until we have a way to guarantee the uses
 374   // are not eliminated sometime during scheduling. The output dependence edge
 375   // is also useful if output latency exceeds def-use latency.
 376   VReg2SUnitMap::iterator DefI = findVRegDef(Reg);
 377   if (DefI == VRegDefs.end())
 378     VRegDefs.insert(VReg2SUnit(Reg, SU));
 379   else {
 380     SUnit *DefSU = DefI->SU;
 381     if (DefSU != SU && DefSU != &ExitSU) {
 382       unsigned OutLatency = TII->getOutputLatency(InstrItins, MI, OperIdx,
 383                                                   DefSU->getInstr());
 384       DefSU->addPred(SDep(SU, SDep::Output, OutLatency, Reg));
 385     }
 386     DefI->SU = SU;
 387   }
 388 }
 389
 390 /// addVRegUseDeps - Add a register data dependency if the instruction that
 391 /// defines the virtual register used at OperIdx is mapped to an SUnit. Add a
 392 /// register antidependency from this SUnit to instructions that occur later in
 393 /// the same scheduling region if they write the virtual register.
 394 ///
 395 /// TODO: Handle ExitSU "uses" properly.
 396 void ScheduleDAGInstrs::addVRegUseDeps(SUnit *SU, unsigned OperIdx) {
 397   MachineInstr *MI = SU->getInstr();
 398   unsigned Reg = MI->getOperand(OperIdx).getReg();
 399
 400   // Lookup this operand's reaching definition.
 401   assert(LIS && "vreg dependencies requires LiveIntervals");
 402   SlotIndex UseIdx = LIS->getSlotIndexes()->getInstructionIndex(MI);
 403   LiveInterval *LI = &LIS->getInterval(Reg);
 404   VNInfo *VNI = LI->getVNInfoAt(UseIdx);
 405   MachineInstr *Def = LIS->getInstructionFromIndex(VNI->def);
 406   if (Def) {
 407     SUnit *DefSU = getSUnit(Def);
 408     if (DefSU) {
 409       // The reaching Def lives within this scheduling region.
 410       // Create a data dependence.
 411       //
 412       // TODO: Handle "special" address latencies cleanly.
 413       const SDep &dep = SDep(DefSU, SDep::Data, DefSU->Latency, Reg);
 414       if (!UnitLatencies) {
 415         // Adjust the dependence latency using operand def/use information, then
 416         // allow the target to perform its own adjustments.
 417         ComputeOperandLatency(DefSU, SU, const_cast<SDep &>(dep));
 418         const TargetSubtargetInfo &ST = TM.getSubtarget<TargetSubtargetInfo>();
 419         ST.adjustSchedDependency(DefSU, SU, const_cast<SDep &>(dep));
 420       }
 421       SU->addPred(dep);
 422     }
 423   }
 424
 425   // Add antidependence to the following def of the vreg it uses.
 426   VReg2SUnitMap::iterator DefI = findVRegDef(Reg);
 427   if (DefI != VRegDefs.end() && DefI->SU != SU)
 428     DefI->SU->addPred(SDep(SU, SDep::Anti, 0, Reg));
 429 }
 430
 431 /// Create an SUnit for each real instruction, numbered in top-down toplological
 432 /// order. The instruction order A < B, implies that no edge exists from B to A.
 433 ///
 434 /// Map each real instruction to its SUnit.
 435 ///
 436 /// After initSUnits, the SUnits vector is cannot be resized and the scheduler
 437 /// may hang onto SUnit pointers. We may relax this in the future by using SUnit
 438 /// IDs instead of pointers.
 439 void ScheduleDAGInstrs::initSUnits() {
 440   // We'll be allocating one SUnit for each real instruction in the region,
 441   // which is contained within a basic block.
 442   SUnits.reserve(BB->size());
 443
 444   for (MachineBasicBlock::iterator I = Begin; I != InsertPos; ++I) {
 445     MachineInstr *MI = I;
 446     if (MI->isDebugValue())
 447       continue;
 448
 449     SUnit *SU = NewSUnit(MI);
 450     MISUnitMap[MI] = SU;
 451
 452     SU->isCall = MI->isCall();
 453     SU->isCommutable = MI->isCommutable();
 454
 455     // Assign the Latency field of SU using target-provided information.
 456     if (UnitLatencies)
 457       SU->Latency = 1;
 458     else
 459       ComputeLatency(SU);
 460   }
 461 }
 462
 463 void ScheduleDAGInstrs::BuildSchedGraph(AliasAnalysis *AA) {
 464   // Create an SUnit for each real instruction.
 465   initSUnits();
 466
 467   // We build scheduling units by walking a block's instruction list from bottom
 468   // to top.
 469
 470   // Remember where a generic side-effecting instruction is as we procede.
 471   SUnit *BarrierChain = 0, *AliasChain = 0;
 472
 473   // Memory references to specific known memory locations are tracked
 474   // so that they can be given more precise dependencies. We track
 475   // separately the known memory locations that may alias and those
 476   // that are known not to alias
 477   std::map<const Value *, SUnit *> AliasMemDefs, NonAliasMemDefs;
 478   std::map<const Value *, std::vector<SUnit *> > AliasMemUses, NonAliasMemUses;
 479
 480   // Remove any stale debug info; sometimes BuildSchedGraph is called again
 481   // without emitting the info from the previous call.
 482   DbgValues.clear();
 483   FirstDbgValue = NULL;
 484
 485   // Model data dependencies between instructions being scheduled and the
 486   // ExitSU.
 487   AddSchedBarrierDeps();
 488
 489   for (int i = 0, e = TRI->getNumRegs(); i != e; ++i) {
 490     assert(Defs[i].empty() && "Only BuildGraph should push/pop Defs");
 491   }
 492
 493   assert(VRegDefs.empty() && "Only BuildSchedGraph may access VRegDefs");
 494   // FIXME: Allow SparseSet to reserve space for the creation of virtual
 495   // registers during scheduling. Don't artificially inflate the Universe
 496   // because we want to assert that vregs are not created during DAG building.
 497   VRegDefs.setUniverse(MRI.getNumVirtRegs());
 498
 499   // Walk the list of instructions, from bottom moving up.
 500   MachineInstr *PrevMI = NULL;
 501   for (MachineBasicBlock::iterator MII = InsertPos, MIE = Begin;
 502        MII != MIE; --MII) {
 503     MachineInstr *MI = prior(MII);
 504     if (MI && PrevMI) {
 505       DbgValues.push_back(std::make_pair(PrevMI, MI));
 506       PrevMI = NULL;
 507     }
 508
 509     if (MI->isDebugValue()) {
 510       PrevMI = MI;
 511       continue;
 512     }
 513
 514     assert(!MI->isTerminator() && !MI->isLabel() &&
 515            "Cannot schedule terminators or labels!");
 516
 517     SUnit *SU = MISUnitMap[MI];
 518     assert(SU && "No SUnit mapped to this MI");
 519
 520     // Add register-based dependencies (data, anti, and output).
 521     for (unsigned j = 0, n = MI->getNumOperands(); j != n; ++j) {
 522       const MachineOperand &MO = MI->getOperand(j);
 523       if (!MO.isReg()) continue;
 524       unsigned Reg = MO.getReg();
 525       if (Reg == 0) continue;
 526
 527       if (TRI->isPhysicalRegister(Reg))
 528         addPhysRegDeps(SU, j);
 529       else {
 530         assert(!IsPostRA && "Virtual register encountered!");
 531         if (MO.isDef())
 532           addVRegDefDeps(SU, j);
 533         else
 534           addVRegUseDeps(SU, j);
 535       }
 536     }
 537
 538     // Add chain dependencies.
 539     // Chain dependencies used to enforce memory order should have
 540     // latency of 0 (except for true dependency of Store followed by
 541     // aliased Load... we estimate that with a single cycle of latency
 542     // assuming the hardware will bypass)
 543     // Note that isStoreToStackSlot and isLoadFromStackSLot are not usable
 544     // after stack slots are lowered to actual addresses.
 545     // TODO: Use an AliasAnalysis and do real alias-analysis queries, and
 546     // produce more precise dependence information.
 547 #define STORE_LOAD_LATENCY 1
 548     unsigned TrueMemOrderLatency = 0;
 549     if (MI->isCall() || MI->hasUnmodeledSideEffects() ||
 550         (MI->hasVolatileMemoryRef() &&
 551          (!MI->mayLoad() || !MI->isInvariantLoad(AA)))) {
 552       // Be conservative with these and add dependencies on all memory
 553       // references, even those that are known to not alias.
 554       for (std::map<const Value *, SUnit *>::iterator I =
 555              NonAliasMemDefs.begin(), E = NonAliasMemDefs.end(); I != E; ++I) {
 556         I->second->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
 557       }
 558       for (std::map<const Value *, std::vector<SUnit *> >::iterator I =
 559              NonAliasMemUses.begin(), E = NonAliasMemUses.end(); I != E; ++I) {
 560         for (unsigned i = 0, e = I->second.size(); i != e; ++i)
 561           I->second[i]->addPred(SDep(SU, SDep::Order, TrueMemOrderLatency));
 562       }
 563       NonAliasMemDefs.clear();
 564       NonAliasMemUses.clear();
 565       // Add SU to the barrier chain.
 566       if (BarrierChain)
 567         BarrierChain->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
 568       BarrierChain = SU;
 569
 570       // fall-through
 571     new_alias_chain:
 572       // Chain all possibly aliasing memory references though SU.
 573       if (AliasChain)
 574         AliasChain->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
 575       AliasChain = SU;
 576       for (unsigned k = 0, m = PendingLoads.size(); k != m; ++k)
 577         PendingLoads[k]->addPred(SDep(SU, SDep::Order, TrueMemOrderLatency));
 578       for (std::map<const Value *, SUnit *>::iterator I = AliasMemDefs.begin(),
 579            E = AliasMemDefs.end(); I != E; ++I) {
 580         I->second->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
 581       }
 582       for (std::map<const Value *, std::vector<SUnit *> >::iterator I =
 583            AliasMemUses.begin(), E = AliasMemUses.end(); I != E; ++I) {
 584         for (unsigned i = 0, e = I->second.size(); i != e; ++i)
 585           I->second[i]->addPred(SDep(SU, SDep::Order, TrueMemOrderLatency));
 586       }
 587       PendingLoads.clear();
 588       AliasMemDefs.clear();
 589       AliasMemUses.clear();
 590     } else if (MI->mayStore()) {
 591       bool MayAlias = true;
 592       TrueMemOrderLatency = STORE_LOAD_LATENCY;
 593       if (const Value *V = getUnderlyingObjectForInstr(MI, MFI, MayAlias)) {
 594         // A store to a specific PseudoSourceValue. Add precise dependencies.
 595         // Record the def in MemDefs, first adding a dep if there is
 596         // an existing def.
 597         std::map<const Value *, SUnit *>::iterator I =
 598           ((MayAlias) ? AliasMemDefs.find(V) : NonAliasMemDefs.find(V));
 599         std::map<const Value *, SUnit *>::iterator IE =
 600           ((MayAlias) ? AliasMemDefs.end() : NonAliasMemDefs.end());
 601         if (I != IE) {
 602           I->second->addPred(SDep(SU, SDep::Order, /*Latency=*/0, /*Reg=*/0,
 603                                   /*isNormalMemory=*/true));
 604           I->second = SU;
 605         } else {
 606           if (MayAlias)
 607             AliasMemDefs[V] = SU;
 608           else
 609             NonAliasMemDefs[V] = SU;
 610         }
 611         // Handle the uses in MemUses, if there are any.
 612         std::map<const Value *, std::vector<SUnit *> >::iterator J =
 613           ((MayAlias) ? AliasMemUses.find(V) : NonAliasMemUses.find(V));
 614         std::map<const Value *, std::vector<SUnit *> >::iterator JE =
 615           ((MayAlias) ? AliasMemUses.end() : NonAliasMemUses.end());
 616         if (J != JE) {
 617           for (unsigned i = 0, e = J->second.size(); i != e; ++i)
 618             J->second[i]->addPred(SDep(SU, SDep::Order, TrueMemOrderLatency,
 619                                        /*Reg=*/0, /*isNormalMemory=*/true));
 620           J->second.clear();
 621         }
 622         if (MayAlias) {
 623           // Add dependencies from all the PendingLoads, i.e. loads
 624           // with no underlying object.
 625           for (unsigned k = 0, m = PendingLoads.size(); k != m; ++k)
 626             PendingLoads[k]->addPred(SDep(SU, SDep::Order, TrueMemOrderLatency));
 627           // Add dependence on alias chain, if needed.
 628           if (AliasChain)
 629             AliasChain->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
 630         }
 631         // Add dependence on barrier chain, if needed.
 632         if (BarrierChain)
 633           BarrierChain->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
 634       } else {
 635         // Treat all other stores conservatively.
 636         goto new_alias_chain;
 637       }
 638
 639       if (!ExitSU.isPred(SU))
 640         // Push store's up a bit to avoid them getting in between cmp
 641         // and branches.
 642         ExitSU.addPred(SDep(SU, SDep::Order, 0,
 643                             /*Reg=*/0, /*isNormalMemory=*/false,
 644                             /*isMustAlias=*/false,
 645                             /*isArtificial=*/true));
 646     } else if (MI->mayLoad()) {
 647       bool MayAlias = true;
 648       TrueMemOrderLatency = 0;
 649       if (MI->isInvariantLoad(AA)) {
 650         // Invariant load, no chain dependencies needed!
 651       } else {
 652         if (const Value *V =
 653             getUnderlyingObjectForInstr(MI, MFI, MayAlias)) {
 654           // A load from a specific PseudoSourceValue. Add precise dependencies.
 655           std::map<const Value *, SUnit *>::iterator I =
 656             ((MayAlias) ? AliasMemDefs.find(V) : NonAliasMemDefs.find(V));
 657           std::map<const Value *, SUnit *>::iterator IE =
 658             ((MayAlias) ? AliasMemDefs.end() : NonAliasMemDefs.end());
 659           if (I != IE)
 660             I->second->addPred(SDep(SU, SDep::Order, /*Latency=*/0, /*Reg=*/0,
 661                                     /*isNormalMemory=*/true));
 662           if (MayAlias)
 663             AliasMemUses[V].push_back(SU);
 664           else
 665             NonAliasMemUses[V].push_back(SU);
 666         } else {
 667           // A load with no underlying object. Depend on all
 668           // potentially aliasing stores.
 669           for (std::map<const Value *, SUnit *>::iterator I =
 670                  AliasMemDefs.begin(), E = AliasMemDefs.end(); I != E; ++I)
 671             I->second->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
 672
 673           PendingLoads.push_back(SU);
 674           MayAlias = true;
 675         }
 676
 677         // Add dependencies on alias and barrier chains, if needed.
 678         if (MayAlias && AliasChain)
 679           AliasChain->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
 680         if (BarrierChain)
 681           BarrierChain->addPred(SDep(SU, SDep::Order, /*Latency=*/0));
 682       }
 683     }
 684   }
 685   if (PrevMI)
 686     FirstDbgValue = PrevMI;
 687
 688   for (int i = 0, e = TRI->getNumRegs(); i != e; ++i) {
 689     Defs[i].clear();
 690     Uses[i].clear();
 691   }
 692   VRegDefs.clear();
 693   PendingLoads.clear();
 694   MISUnitMap.clear();
 695 }
 696
 697 void ScheduleDAGInstrs::FinishBlock() {
 698   // Nothing to do.
 699 }
 700
 701 void ScheduleDAGInstrs::ComputeLatency(SUnit *SU) {
 702   // Compute the latency for the node.
 703   if (!InstrItins || InstrItins->isEmpty()) {
 704     SU->Latency = 1;
 705
 706     // Simplistic target-independent heuristic: assume that loads take
 707     // extra time.
 708     if (SU->getInstr()->mayLoad())
 709       SU->Latency += 2;
 710   } else {
 711     SU->Latency = TII->getInstrLatency(InstrItins, SU->getInstr());
 712   }
 713 }
 714
 715 void ScheduleDAGInstrs::ComputeOperandLatency(SUnit *Def, SUnit *Use,
 716                                               SDep& dep) const {
 717   if (!InstrItins || InstrItins->isEmpty())
 718     return;
 719
 720   // For a data dependency with a known register...
 721   if ((dep.getKind() != SDep::Data) || (dep.getReg() == 0))
 722     return;
 723
 724   const unsigned Reg = dep.getReg();
 725
 726   // ... find the definition of the register in the defining
 727   // instruction
 728   MachineInstr *DefMI = Def->getInstr();
 729   int DefIdx = DefMI->findRegisterDefOperandIdx(Reg);
 730   if (DefIdx != -1) {
 731     const MachineOperand &MO = DefMI->getOperand(DefIdx);
 732     if (MO.isReg() && MO.isImplicit() &&
 733         DefIdx >= (int)DefMI->getDesc().getNumOperands()) {
 734       // This is an implicit def, getOperandLatency() won't return the correct
 735       // latency. e.g.
 736       //   %D6<def>, %D7<def> = VLD1q16 %R2<kill>, 0, ..., %Q3<imp-def>
 737       //   %Q1<def> = VMULv8i16 %Q1<kill>, %Q3<kill>, ...
 738       // What we want is to compute latency between def of %D6/%D7 and use of
 739       // %Q3 instead.
 740       unsigned Op2 = DefMI->findRegisterDefOperandIdx(Reg, false, true, TRI);
 741       if (DefMI->getOperand(Op2).isReg())
 742         DefIdx = Op2;
 743     }
 744     MachineInstr *UseMI = Use->getInstr();
 745     // For all uses of the register, calculate the maxmimum latency
 746     int Latency = -1;
 747     if (UseMI) {
 748       for (unsigned i = 0, e = UseMI->getNumOperands(); i != e; ++i) {
 749         const MachineOperand &MO = UseMI->getOperand(i);
 750         if (!MO.isReg() || !MO.isUse())
 751           continue;
 752         unsigned MOReg = MO.getReg();
 753         if (MOReg != Reg)
 754           continue;
 755
 756         int UseCycle = TII->getOperandLatency(InstrItins, DefMI, DefIdx,
 757                                               UseMI, i);
 758         Latency = std::max(Latency, UseCycle);
 759       }
 760     } else {
 761       // UseMI is null, then it must be a scheduling barrier.
 762       if (!InstrItins || InstrItins->isEmpty())
 763         return;
 764       unsigned DefClass = DefMI->getDesc().getSchedClass();
 765       Latency = InstrItins->getOperandCycle(DefClass, DefIdx);
 766     }
 767
 768     // If we found a latency, then replace the existing dependence latency.
 769     if (Latency >= 0)
 770       dep.setLatency(Latency);
 771   }
 772 }
 773
 774 void ScheduleDAGInstrs::dumpNode(const SUnit *SU) const {
 775   SU->getInstr()->dump();
 776 }
 777
 778 std::string ScheduleDAGInstrs::getGraphNodeLabel(const SUnit *SU) const {
 779   std::string s;
 780   raw_string_ostream oss(s);
 781   if (SU == &EntrySU)
 782     oss << "<entry>";
 783   else if (SU == &ExitSU)
 784     oss << "<exit>";
 785   else
 786     SU->getInstr()->print(oss);
 787   return oss.str();
 788 }
 789
 790 // EmitSchedule - Emit the machine code in scheduled order.
 791 MachineBasicBlock *ScheduleDAGInstrs::EmitSchedule() {
 792   Begin = InsertPos;
 793
 794   // If first instruction was a DBG_VALUE then put it back.
 795   if (FirstDbgValue)
 796     BB->splice(InsertPos, BB, FirstDbgValue);
 797
 798   // Then re-insert them according to the given schedule.
 799   for (unsigned i = 0, e = Sequence.size(); i != e; i++) {
 800     if (SUnit *SU = Sequence[i])
 801       BB->splice(InsertPos, BB, SU->getInstr());
 802     else
 803       // Null SUnit* is a noop.
 804       EmitNoop();
 805
 806     // Update the Begin iterator, as the first instruction in the block
 807     // may have been scheduled later.
 808     if (i == 0)
 809       Begin = prior(InsertPos);
 810   }
 811
 812   // Reinsert any remaining debug_values.
 813   for (std::vector<std::pair<MachineInstr *, MachineInstr *> >::iterator
 814          DI = DbgValues.end(), DE = DbgValues.begin(); DI != DE; --DI) {
 815     std::pair<MachineInstr *, MachineInstr *> P = *prior(DI);
 816     MachineInstr *DbgValue = P.first;
 817     MachineBasicBlock::iterator OrigPrivMI = P.second;
 818     BB->splice(++OrigPrivMI, BB, DbgValue);
 819   }
 820   DbgValues.clear();
 821   FirstDbgValue = NULL;
 822   return BB;
 823 }