lib/CodeGen/InstrSched/SchedGraph.cpp

   1 //===- SchedGraph.cpp - Scheduling Graph Implementation -------------------===//
   2 //
   3 // Scheduling graph based on SSA graph plus extra dependence edges capturing
   4 // dependences due to machine resources (machine registers, CC registers, and
   5 // any others).
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #include "SchedGraph.h"
  10 #include "llvm/CodeGen/InstrSelection.h"
  11 #include "llvm/CodeGen/MachineCodeForInstruction.h"
  12 #include "llvm/CodeGen/MachineFunction.h"
  13 #include "llvm/Target/TargetRegInfo.h"
  14 #include "llvm/Target/TargetMachine.h"
  15 #include "llvm/Target/TargetInstrInfo.h"
  16 #include "llvm/Function.h"
  17 #include "llvm/iOther.h"
  18 #include "Support/StringExtras.h"
  19 #include "Support/STLExtras.h"
  20
  21 //*********************** Internal Data Structures *************************/
  22
  23 // The following two types need to be classes, not typedefs, so we can use
  24 // opaque declarations in SchedGraph.h
  25 //
  26 struct RefVec: public std::vector<std::pair<SchedGraphNode*, int> > {
  27   typedef std::vector<std::pair<SchedGraphNode*,int> >::iterator iterator;
  28   typedef
  29   std::vector<std::pair<SchedGraphNode*,int> >::const_iterator const_iterator;
  30 };
  31
  32 struct RegToRefVecMap: public hash_map<int, RefVec> {
  33   typedef hash_map<int, RefVec>::      iterator       iterator;
  34   typedef hash_map<int, RefVec>::const_iterator const_iterator;
  35 };
  36
  37 struct ValueToDefVecMap: public hash_map<const Instruction*, RefVec> {
  38   typedef hash_map<const Instruction*, RefVec>::      iterator       iterator;
  39   typedef hash_map<const Instruction*, RefVec>::const_iterator const_iterator;
  40 };
  41
  42 //
  43 // class SchedGraphEdge
  44 //
  45
  46 /*ctor*/
  47 SchedGraphEdge::SchedGraphEdge(SchedGraphNode* _src,
  48                                SchedGraphNode* _sink,
  49                                SchedGraphEdgeDepType _depType,
  50                                unsigned int     _depOrderType,
  51                                int _minDelay)
  52   : src(_src),
  53     sink(_sink),
  54     depType(_depType),
  55     depOrderType(_depOrderType),
  56     minDelay((_minDelay >= 0)? _minDelay : _src->getLatency()),
  57     val(NULL)
  58 {
  59   assert(src != sink && "Self-loop in scheduling graph!");
  60   src->addOutEdge(this);
  61   sink->addInEdge(this);
  62 }
  63
  64
  65 /*ctor*/
  66 SchedGraphEdge::SchedGraphEdge(SchedGraphNode*  _src,
  67                                SchedGraphNode*  _sink,
  68                                const Value*     _val,
  69                                unsigned int     _depOrderType,
  70                                int              _minDelay)
  71   : src(_src),
  72     sink(_sink),
  73     depType(ValueDep),
  74     depOrderType(_depOrderType),
  75     minDelay((_minDelay >= 0)? _minDelay : _src->getLatency()),
  76     val(_val)
  77 {
  78   assert(src != sink && "Self-loop in scheduling graph!");
  79   src->addOutEdge(this);
  80   sink->addInEdge(this);
  81 }
  82
  83
  84 /*ctor*/
  85 SchedGraphEdge::SchedGraphEdge(SchedGraphNode*  _src,
  86                                SchedGraphNode*  _sink,
  87                                unsigned int     _regNum,
  88                                unsigned int     _depOrderType,
  89                                int             _minDelay)
  90   : src(_src),
  91     sink(_sink),
  92     depType(MachineRegister),
  93     depOrderType(_depOrderType),
  94     minDelay((_minDelay >= 0)? _minDelay : _src->getLatency()),
  95     machineRegNum(_regNum)
  96 {
  97   assert(src != sink && "Self-loop in scheduling graph!");
  98   src->addOutEdge(this);
  99   sink->addInEdge(this);
 100 }
 101
 102
 103 /*ctor*/
 104 SchedGraphEdge::SchedGraphEdge(SchedGraphNode* _src,
 105                                SchedGraphNode* _sink,
 106                                ResourceId      _resourceId,
 107                                int             _minDelay)
 108   : src(_src),
 109     sink(_sink),
 110     depType(MachineResource),
 111     depOrderType(NonDataDep),
 112     minDelay((_minDelay >= 0)? _minDelay : _src->getLatency()),
 113     resourceId(_resourceId)
 114 {
 115   assert(src != sink && "Self-loop in scheduling graph!");
 116   src->addOutEdge(this);
 117   sink->addInEdge(this);
 118 }
 119
 120 /*dtor*/
 121 SchedGraphEdge::~SchedGraphEdge()
 122 {
 123 }
 124
 125 void SchedGraphEdge::dump(int indent) const {
 126   std::cerr << std::string(indent*2, ' ') << *this;
 127 }
 128
 129
 130 //
 131 // class SchedGraphNode
 132 //
 133
 134 /*ctor*/
 135 SchedGraphNode::SchedGraphNode(unsigned NID,
 136                                MachineBasicBlock *mbb,
 137                                int   indexInBB,
 138                                const TargetMachine& Target)
 139   : nodeId(NID), MBB(mbb), minstr(mbb ? (*mbb)[indexInBB] : 0),
 140     origIndexInBB(indexInBB), latency(0) {
 141   if (minstr)
 142     {
 143       MachineOpCode mopCode = minstr->getOpCode();
 144       latency = Target.getInstrInfo().hasResultInterlock(mopCode)
 145         ? Target.getInstrInfo().minLatency(mopCode)
 146         : Target.getInstrInfo().maxLatency(mopCode);
 147     }
 148 }
 149
 150
 151 /*dtor*/
 152 SchedGraphNode::~SchedGraphNode()
 153 {
 154   // for each node, delete its out-edges
 155   std::for_each(beginOutEdges(), endOutEdges(),
 156                 deleter<SchedGraphEdge>);
 157 }
 158
 159 void SchedGraphNode::dump(int indent) const {
 160   std::cerr << std::string(indent*2, ' ') << *this;
 161 }
 162
 163
 164 inline void
 165 SchedGraphNode::addInEdge(SchedGraphEdge* edge)
 166 {
 167   inEdges.push_back(edge);
 168 }
 169
 170
 171 inline void
 172 SchedGraphNode::addOutEdge(SchedGraphEdge* edge)
 173 {
 174   outEdges.push_back(edge);
 175 }
 176
 177 inline void
 178 SchedGraphNode::removeInEdge(const SchedGraphEdge* edge)
 179 {
 180   assert(edge->getSink() == this);
 181
 182   for (iterator I = beginInEdges(); I != endInEdges(); ++I)
 183     if ((*I) == edge)
 184       {
 185         inEdges.erase(I);
 186         break;
 187       }
 188 }
 189
 190 inline void
 191 SchedGraphNode::removeOutEdge(const SchedGraphEdge* edge)
 192 {
 193   assert(edge->getSrc() == this);
 194
 195   for (iterator I = beginOutEdges(); I != endOutEdges(); ++I)
 196     if ((*I) == edge)
 197       {
 198         outEdges.erase(I);
 199         break;
 200       }
 201 }
 202
 203
 204 //
 205 // class SchedGraph
 206 //
 207
 208
 209 /*ctor*/
 210 SchedGraph::SchedGraph(MachineBasicBlock &mbb, const TargetMachine& target)
 211   : MBB(mbb) {
 212   buildGraph(target);
 213 }
 214
 215
 216 /*dtor*/
 217 SchedGraph::~SchedGraph()
 218 {
 219   for (const_iterator I = begin(); I != end(); ++I)
 220     delete I->second;
 221   delete graphRoot;
 222   delete graphLeaf;
 223 }
 224
 225
 226 void
 227 SchedGraph::dump() const
 228 {
 229   std::cerr << "  Sched Graph for Basic Block: ";
 230   std::cerr << MBB.getBasicBlock()->getName()
 231             << " (" << MBB.getBasicBlock() << ")";
 232
 233   std::cerr << "\n\n    Actual Root nodes : ";
 234   for (unsigned i=0, N=graphRoot->outEdges.size(); i < N; i++)
 235     std::cerr << graphRoot->outEdges[i]->getSink()->getNodeId()
 236               << ((i == N-1)? "" : ", ");
 237
 238   std::cerr << "\n    Graph Nodes:\n";
 239   for (const_iterator I=begin(); I != end(); ++I)
 240     std::cerr << "\n" << *I->second;
 241
 242   std::cerr << "\n";
 243 }
 244
 245
 246 void
 247 SchedGraph::eraseIncomingEdges(SchedGraphNode* node, bool addDummyEdges)
 248 {
 249   // Delete and disconnect all in-edges for the node
 250   for (SchedGraphNode::iterator I = node->beginInEdges();
 251        I != node->endInEdges(); ++I)
 252   {
 253     SchedGraphNode* srcNode = (*I)->getSrc();
 254     srcNode->removeOutEdge(*I);
 255     delete *I;
 256
 257     if (addDummyEdges &&
 258         srcNode != getRoot() &&
 259         srcNode->beginOutEdges() == srcNode->endOutEdges())
 260     {
 261       // srcNode has no more out edges, so add an edge to dummy EXIT node
 262       assert(node != getLeaf() && "Adding edge that was just removed?");
 263       (void) new SchedGraphEdge(srcNode, getLeaf(),
 264                         SchedGraphEdge::CtrlDep, SchedGraphEdge::NonDataDep, 0);
 265     }
 266   }
 267
 268   node->inEdges.clear();
 269 }
 270
 271 void
 272 SchedGraph::eraseOutgoingEdges(SchedGraphNode* node, bool addDummyEdges)
 273 {
 274   // Delete and disconnect all out-edges for the node
 275   for (SchedGraphNode::iterator I = node->beginOutEdges();
 276        I != node->endOutEdges(); ++I)
 277   {
 278     SchedGraphNode* sinkNode = (*I)->getSink();
 279     sinkNode->removeInEdge(*I);
 280     delete *I;
 281
 282     if (addDummyEdges &&
 283         sinkNode != getLeaf() &&
 284         sinkNode->beginInEdges() == sinkNode->endInEdges())
 285     { //sinkNode has no more in edges, so add an edge from dummy ENTRY node
 286       assert(node != getRoot() && "Adding edge that was just removed?");
 287       (void) new SchedGraphEdge(getRoot(), sinkNode,
 288                         SchedGraphEdge::CtrlDep, SchedGraphEdge::NonDataDep, 0);
 289     }
 290   }
 291
 292   node->outEdges.clear();
 293 }
 294
 295 void
 296 SchedGraph::eraseIncidentEdges(SchedGraphNode* node, bool addDummyEdges)
 297 {
 298   this->eraseIncomingEdges(node, addDummyEdges);
 299   this->eraseOutgoingEdges(node, addDummyEdges);
 300 }
 301
 302
 303 void
 304 SchedGraph::addDummyEdges()
 305 {
 306   assert(graphRoot->outEdges.size() == 0);
 307
 308   for (const_iterator I=begin(); I != end(); ++I)
 309   {
 310     SchedGraphNode* node = (*I).second;
 311     assert(node != graphRoot && node != graphLeaf);
 312     if (node->beginInEdges() == node->endInEdges())
 313       (void) new SchedGraphEdge(graphRoot, node, SchedGraphEdge::CtrlDep,
 314                                 SchedGraphEdge::NonDataDep, 0);
 315     if (node->beginOutEdges() == node->endOutEdges())
 316       (void) new SchedGraphEdge(node, graphLeaf, SchedGraphEdge::CtrlDep,
 317                                 SchedGraphEdge::NonDataDep, 0);
 318   }
 319 }
 320
 321
 322 void
 323 SchedGraph::addCDEdges(const TerminatorInst* term,
 324                        const TargetMachine& target)
 325 {
 326   const TargetInstrInfo& mii = target.getInstrInfo();
 327   MachineCodeForInstruction &termMvec = MachineCodeForInstruction::get(term);
 328
 329   // Find the first branch instr in the sequence of machine instrs for term
 330   //
 331   unsigned first = 0;
 332   while (! mii.isBranch(termMvec[first]->getOpCode()) &&
 333          ! mii.isReturn(termMvec[first]->getOpCode()))
 334     ++first;
 335   assert(first < termMvec.size() &&
 336          "No branch instructions for terminator?  Ok, but weird!");
 337   if (first == termMvec.size())
 338     return;
 339
 340   SchedGraphNode* firstBrNode = getGraphNodeForInstr(termMvec[first]);
 341
 342   // Add CD edges from each instruction in the sequence to the
 343   // *last preceding* branch instr. in the sequence
 344   // Use a latency of 0 because we only need to prevent out-of-order issue.
 345   //
 346   for (unsigned i = termMvec.size(); i > first+1; --i)
 347   {
 348     SchedGraphNode* toNode = getGraphNodeForInstr(termMvec[i-1]);
 349     assert(toNode && "No node for instr generated for branch/ret?");
 350
 351     for (unsigned j = i-1; j != 0; --j)
 352       if (mii.isBranch(termMvec[j-1]->getOpCode()) ||
 353           mii.isReturn(termMvec[j-1]->getOpCode()))
 354       {
 355         SchedGraphNode* brNode = getGraphNodeForInstr(termMvec[j-1]);
 356         assert(brNode && "No node for instr generated for branch/ret?");
 357         (void) new SchedGraphEdge(brNode, toNode, SchedGraphEdge::CtrlDep,
 358                                   SchedGraphEdge::NonDataDep, 0);
 359         break;                  // only one incoming edge is enough
 360       }
 361   }
 362
 363   // Add CD edges from each instruction preceding the first branch
 364   // to the first branch.  Use a latency of 0 as above.
 365   //
 366   for (unsigned i = first; i != 0; --i)
 367   {
 368     SchedGraphNode* fromNode = getGraphNodeForInstr(termMvec[i-1]);
 369     assert(fromNode && "No node for instr generated for branch?");
 370     (void) new SchedGraphEdge(fromNode, firstBrNode, SchedGraphEdge::CtrlDep,
 371                               SchedGraphEdge::NonDataDep, 0);
 372   }
 373
 374   // Now add CD edges to the first branch instruction in the sequence from
 375   // all preceding instructions in the basic block.  Use 0 latency again.
 376   //
 377   for (unsigned i=0, N=MBB.size(); i < N; i++)
 378   {
 379     if (MBB[i] == termMvec[first])   // reached the first branch
 380       break;
 381
 382     SchedGraphNode* fromNode = this->getGraphNodeForInstr(MBB[i]);
 383     if (fromNode == NULL)
 384       continue;                 // dummy instruction, e.g., PHI
 385
 386     (void) new SchedGraphEdge(fromNode, firstBrNode,
 387                               SchedGraphEdge::CtrlDep,
 388                               SchedGraphEdge::NonDataDep, 0);
 389
 390     // If we find any other machine instructions (other than due to
 391     // the terminator) that also have delay slots, add an outgoing edge
 392     // from the instruction to the instructions in the delay slots.
 393     //
 394     unsigned d = mii.getNumDelaySlots(MBB[i]->getOpCode());
 395     assert(i+d < N && "Insufficient delay slots for instruction?");
 396
 397     for (unsigned j=1; j <= d; j++)
 398     {
 399       SchedGraphNode* toNode = this->getGraphNodeForInstr(MBB[i+j]);
 400       assert(toNode && "No node for machine instr in delay slot?");
 401       (void) new SchedGraphEdge(fromNode, toNode,
 402                                 SchedGraphEdge::CtrlDep,
 403                                 SchedGraphEdge::NonDataDep, 0);
 404     }
 405   }
 406 }
 407
 408 static const int SG_LOAD_REF  = 0;
 409 static const int SG_STORE_REF = 1;
 410 static const int SG_CALL_REF  = 2;
 411
 412 static const unsigned int SG_DepOrderArray[][3] = {
 413   { SchedGraphEdge::NonDataDep,
 414             SchedGraphEdge::AntiDep,
 415                         SchedGraphEdge::AntiDep },
 416   { SchedGraphEdge::TrueDep,
 417             SchedGraphEdge::OutputDep,
 418                         SchedGraphEdge::TrueDep | SchedGraphEdge::OutputDep },
 419   { SchedGraphEdge::TrueDep,
 420             SchedGraphEdge::AntiDep | SchedGraphEdge::OutputDep,
 421                         SchedGraphEdge::TrueDep | SchedGraphEdge::AntiDep
 422                                                 | SchedGraphEdge::OutputDep }
 423 };
 424
 425
 426 // Add a dependence edge between every pair of machine load/store/call
 427 // instructions, where at least one is a store or a call.
 428 // Use latency 1 just to ensure that memory operations are ordered;
 429 // latency does not otherwise matter (true dependences enforce that).
 430 //
 431 void
 432 SchedGraph::addMemEdges(const std::vector<SchedGraphNode*>& memNodeVec,
 433                         const TargetMachine& target)
 434 {
 435   const TargetInstrInfo& mii = target.getInstrInfo();
 436
 437   // Instructions in memNodeVec are in execution order within the basic block,
 438   // so simply look at all pairs <memNodeVec[i], memNodeVec[j: j > i]>.
 439   //
 440   for (unsigned im=0, NM=memNodeVec.size(); im < NM; im++)
 441   {
 442     MachineOpCode fromOpCode = memNodeVec[im]->getOpCode();
 443     int fromType = mii.isCall(fromOpCode)? SG_CALL_REF
 444       : mii.isLoad(fromOpCode)? SG_LOAD_REF
 445       : SG_STORE_REF;
 446     for (unsigned jm=im+1; jm < NM; jm++)
 447     {
 448       MachineOpCode toOpCode = memNodeVec[jm]->getOpCode();
 449       int toType = mii.isCall(toOpCode)? SG_CALL_REF
 450         : mii.isLoad(toOpCode)? SG_LOAD_REF
 451         : SG_STORE_REF;
 452
 453       if (fromType != SG_LOAD_REF || toType != SG_LOAD_REF)
 454         (void) new SchedGraphEdge(memNodeVec[im], memNodeVec[jm],
 455                                   SchedGraphEdge::MemoryDep,
 456                                   SG_DepOrderArray[fromType][toType], 1);
 457     }
 458   }
 459 }
 460
 461 // Add edges from/to CC reg instrs to/from call instrs.
 462 // Essentially this prevents anything that sets or uses a CC reg from being
 463 // reordered w.r.t. a call.
 464 // Use a latency of 0 because we only need to prevent out-of-order issue,
 465 // like with control dependences.
 466 //
 467 void
 468 SchedGraph::addCallCCEdges(const std::vector<SchedGraphNode*>& memNodeVec,
 469                            MachineBasicBlock& bbMvec,
 470                            const TargetMachine& target)
 471 {
 472   const TargetInstrInfo& mii = target.getInstrInfo();
 473   std::vector<SchedGraphNode*> callNodeVec;
 474
 475   // Find the call instruction nodes and put them in a vector.
 476   for (unsigned im=0, NM=memNodeVec.size(); im < NM; im++)
 477     if (mii.isCall(memNodeVec[im]->getOpCode()))
 478       callNodeVec.push_back(memNodeVec[im]);
 479
 480   // Now walk the entire basic block, looking for CC instructions *and*
 481   // call instructions, and keep track of the order of the instructions.
 482   // Use the call node vec to quickly find earlier and later call nodes
 483   // relative to the current CC instruction.
 484   //
 485   int lastCallNodeIdx = -1;
 486   for (unsigned i=0, N=bbMvec.size(); i < N; i++)
 487     if (mii.isCall(bbMvec[i]->getOpCode()))
 488     {
 489       ++lastCallNodeIdx;
 490       for ( ; lastCallNodeIdx < (int)callNodeVec.size(); ++lastCallNodeIdx)
 491         if (callNodeVec[lastCallNodeIdx]->getMachineInstr() == bbMvec[i])
 492           break;
 493       assert(lastCallNodeIdx < (int)callNodeVec.size() && "Missed Call?");
 494     } else if (mii.isCCInstr(bbMvec[i]->getOpCode())) {
 495       // Add incoming/outgoing edges from/to preceding/later calls
 496       SchedGraphNode* ccNode = this->getGraphNodeForInstr(bbMvec[i]);
 497       int j=0;
 498       for ( ; j <= lastCallNodeIdx; j++)
 499         (void) new SchedGraphEdge(callNodeVec[j], ccNode,
 500                                   MachineCCRegsRID, 0);
 501       for ( ; j < (int) callNodeVec.size(); j++)
 502         (void) new SchedGraphEdge(ccNode, callNodeVec[j],
 503                                   MachineCCRegsRID, 0);
 504     }
 505 }
 506
 507
 508 void
 509 SchedGraph::addMachineRegEdges(RegToRefVecMap& regToRefVecMap,
 510                                const TargetMachine& target)
 511 {
 512   // This assumes that such hardwired registers are never allocated
 513   // to any LLVM value (since register allocation happens later), i.e.,
 514   // any uses or defs of this register have been made explicit!
 515   // Also assumes that two registers with different numbers are
 516   // not aliased!
 517   //
 518   for (RegToRefVecMap::iterator I = regToRefVecMap.begin();
 519        I != regToRefVecMap.end(); ++I)
 520   {
 521     int regNum        = (*I).first;
 522     RefVec& regRefVec = (*I).second;
 523
 524     // regRefVec is ordered by control flow order in the basic block
 525     for (unsigned i=0; i < regRefVec.size(); ++i) {
 526       SchedGraphNode* node = regRefVec[i].first;
 527       unsigned int opNum   = regRefVec[i].second;
 528       bool isDef = node->getMachineInstr()->getOperand(opNum).opIsDefOnly();
 529       bool isDefAndUse =
 530         node->getMachineInstr()->getOperand(opNum).opIsDefAndUse();
 531
 532       for (unsigned p=0; p < i; ++p) {
 533         SchedGraphNode* prevNode = regRefVec[p].first;
 534         if (prevNode != node) {
 535           unsigned int prevOpNum = regRefVec[p].second;
 536           bool prevIsDef =
 537             prevNode->getMachineInstr()->getOperand(prevOpNum).opIsDefOnly();
 538           bool prevIsDefAndUse =
 539             prevNode->getMachineInstr()->getOperand(prevOpNum).opIsDefAndUse();
 540           if (isDef) {
 541             if (prevIsDef)
 542               new SchedGraphEdge(prevNode, node, regNum,
 543                                  SchedGraphEdge::OutputDep);
 544             if (!prevIsDef || prevIsDefAndUse)
 545               new SchedGraphEdge(prevNode, node, regNum,
 546                                  SchedGraphEdge::AntiDep);
 547           }
 548
 549           if (prevIsDef)
 550             if (!isDef || isDefAndUse)
 551               new SchedGraphEdge(prevNode, node, regNum,
 552                                  SchedGraphEdge::TrueDep);
 553         }
 554       }
 555     }
 556   }
 557 }
 558
 559
 560 // Adds dependences to/from refNode from/to all other defs
 561 // in the basic block.  refNode may be a use, a def, or both.
 562 // We do not consider other uses because we are not building use-use deps.
 563 //
 564 void
 565 SchedGraph::addEdgesForValue(SchedGraphNode* refNode,
 566                              const RefVec& defVec,
 567                              const Value* defValue,
 568                              bool  refNodeIsDef,
 569                              bool  refNodeIsDefAndUse,
 570                              const TargetMachine& target)
 571 {
 572   bool refNodeIsUse = !refNodeIsDef || refNodeIsDefAndUse;
 573
 574   // Add true or output dep edges from all def nodes before refNode in BB.
 575   // Add anti or output dep edges to all def nodes after refNode.
 576   for (RefVec::const_iterator I=defVec.begin(), E=defVec.end(); I != E; ++I)
 577   {
 578     if ((*I).first == refNode)
 579       continue;                       // Dont add any self-loops
 580
 581     if ((*I).first->getOrigIndexInBB() < refNode->getOrigIndexInBB()) {
 582       // (*).first is before refNode
 583       if (refNodeIsDef)
 584         (void) new SchedGraphEdge((*I).first, refNode, defValue,
 585                                   SchedGraphEdge::OutputDep);
 586       if (refNodeIsUse)
 587         (void) new SchedGraphEdge((*I).first, refNode, defValue,
 588                                   SchedGraphEdge::TrueDep);
 589     } else {
 590       // (*).first is after refNode
 591       if (refNodeIsDef)
 592         (void) new SchedGraphEdge(refNode, (*I).first, defValue,
 593                                   SchedGraphEdge::OutputDep);
 594       if (refNodeIsUse)
 595         (void) new SchedGraphEdge(refNode, (*I).first, defValue,
 596                                   SchedGraphEdge::AntiDep);
 597     }
 598   }
 599 }
 600
 601
 602 void
 603 SchedGraph::addEdgesForInstruction(const MachineInstr& MI,
 604                                    const ValueToDefVecMap& valueToDefVecMap,
 605                                    const TargetMachine& target)
 606 {
 607   SchedGraphNode* node = getGraphNodeForInstr(&MI);
 608   if (node == NULL)
 609     return;
 610
 611   // Add edges for all operands of the machine instruction.
 612   //
 613   for (unsigned i = 0, numOps = MI.getNumOperands(); i != numOps; ++i)
 614   {
 615     switch (MI.getOperand(i).getType())
 616     {
 617     case MachineOperand::MO_VirtualRegister:
 618     case MachineOperand::MO_CCRegister:
 619       if (const Instruction* srcI =
 620           dyn_cast_or_null<Instruction>(MI.getOperand(i).getVRegValue()))
 621       {
 622         ValueToDefVecMap::const_iterator I = valueToDefVecMap.find(srcI);
 623         if (I != valueToDefVecMap.end())
 624           addEdgesForValue(node, I->second, srcI,
 625                            MI.getOperand(i).opIsDefOnly(),
 626                            MI.getOperand(i).opIsDefAndUse(), target);
 627       }
 628       break;
 629
 630     case MachineOperand::MO_MachineRegister:
 631       break;
 632
 633     case MachineOperand::MO_SignExtendedImmed:
 634     case MachineOperand::MO_UnextendedImmed:
 635     case MachineOperand::MO_PCRelativeDisp:
 636       break;    // nothing to do for immediate fields
 637
 638     default:
 639       assert(0 && "Unknown machine operand type in SchedGraph builder");
 640       break;
 641     }
 642   }
 643
 644   // Add edges for values implicitly used by the machine instruction.
 645   // Examples include function arguments to a Call instructions or the return
 646   // value of a Ret instruction.
 647   //
 648   for (unsigned i=0, N=MI.getNumImplicitRefs(); i < N; ++i)
 649     if (MI.getImplicitOp(i).opIsUse() || MI.getImplicitOp(i).opIsDefAndUse())
 650       if (const Instruction *srcI =
 651           dyn_cast_or_null<Instruction>(MI.getImplicitRef(i)))
 652       {
 653         ValueToDefVecMap::const_iterator I = valueToDefVecMap.find(srcI);
 654         if (I != valueToDefVecMap.end())
 655           addEdgesForValue(node, I->second, srcI,
 656                            MI.getImplicitOp(i).opIsDefOnly(),
 657                            MI.getImplicitOp(i).opIsDefAndUse(), target);
 658       }
 659 }
 660
 661
 662 void
 663 SchedGraph::findDefUseInfoAtInstr(const TargetMachine& target,
 664                                   SchedGraphNode* node,
 665                                   std::vector<SchedGraphNode*>& memNodeVec,
 666                                   RegToRefVecMap& regToRefVecMap,
 667                                   ValueToDefVecMap& valueToDefVecMap)
 668 {
 669   const TargetInstrInfo& mii = target.getInstrInfo();
 670
 671
 672   MachineOpCode opCode = node->getOpCode();
 673   if (mii.isLoad(opCode) || mii.isStore(opCode) || mii.isCall(opCode))
 674     memNodeVec.push_back(node);
 675
 676   // Collect the register references and value defs. for explicit operands
 677   //
 678   const MachineInstr& minstr = *node->getMachineInstr();
 679   for (int i=0, numOps = (int) minstr.getNumOperands(); i < numOps; i++)
 680   {
 681     const MachineOperand& mop = minstr.getOperand(i);
 682
 683     // if this references a register other than the hardwired
 684     // "zero" register, record the reference.
 685     if (mop.getType() == MachineOperand::MO_MachineRegister)
 686     {
 687       int regNum = mop.getMachineRegNum();
 688       if (regNum != target.getRegInfo().getZeroRegNum())
 689         regToRefVecMap[mop.getMachineRegNum()]
 690           .push_back(std::make_pair(node, i));
 691       continue;                     // nothing more to do
 692     }
 693
 694     // ignore all other non-def operands
 695     if (!minstr.getOperand(i).opIsDefOnly() &&
 696         !minstr.getOperand(i).opIsDefAndUse())
 697       continue;
 698
 699     // We must be defining a value.
 700     assert((mop.getType() == MachineOperand::MO_VirtualRegister ||
 701             mop.getType() == MachineOperand::MO_CCRegister)
 702            && "Do not expect any other kind of operand to be defined!");
 703
 704     const Instruction* defInstr = cast<Instruction>(mop.getVRegValue());
 705     valueToDefVecMap[defInstr].push_back(std::make_pair(node, i));
 706   }
 707
 708   //
 709   // Collect value defs. for implicit operands.  The interface to extract
 710   // them assumes they must be virtual registers!
 711   //
 712   for (unsigned i=0, N = minstr.getNumImplicitRefs(); i != N; ++i)
 713     if (minstr.getImplicitOp(i).opIsDefOnly() ||
 714         minstr.getImplicitOp(i).opIsDefAndUse())
 715       if (const Instruction* defInstr =
 716           dyn_cast_or_null<Instruction>(minstr.getImplicitRef(i)))
 717         valueToDefVecMap[defInstr].push_back(std::make_pair(node, -i));
 718 }
 719
 720
 721 void
 722 SchedGraph::buildNodesForBB(const TargetMachine& target,
 723                             MachineBasicBlock& MBB,
 724                             std::vector<SchedGraphNode*>& memNodeVec,
 725                             RegToRefVecMap& regToRefVecMap,
 726                             ValueToDefVecMap& valueToDefVecMap)
 727 {
 728   const TargetInstrInfo& mii = target.getInstrInfo();
 729
 730   // Build graph nodes for each VM instruction and gather def/use info.
 731   // Do both those together in a single pass over all machine instructions.
 732   for (unsigned i=0; i < MBB.size(); i++)
 733     if (!mii.isDummyPhiInstr(MBB[i]->getOpCode())) {
 734       SchedGraphNode* node = new SchedGraphNode(getNumNodes(), &MBB, i, target);
 735       noteGraphNodeForInstr(MBB[i], node);
 736
 737       // Remember all register references and value defs
 738       findDefUseInfoAtInstr(target, node, memNodeVec, regToRefVecMap,
 739                             valueToDefVecMap);
 740     }
 741 }
 742
 743
 744 void
 745 SchedGraph::buildGraph(const TargetMachine& target)
 746 {
 747   // Use this data structure to note all machine operands that compute
 748   // ordinary LLVM values.  These must be computed defs (i.e., instructions).
 749   // Note that there may be multiple machine instructions that define
 750   // each Value.
 751   ValueToDefVecMap valueToDefVecMap;
 752
 753   // Use this data structure to note all memory instructions.
 754   // We use this to add memory dependence edges without a second full walk.
 755   //
 756   // vector<const Instruction*> memVec;
 757   std::vector<SchedGraphNode*> memNodeVec;
 758
 759   // Use this data structure to note any uses or definitions of
 760   // machine registers so we can add edges for those later without
 761   // extra passes over the nodes.
 762   // The vector holds an ordered list of references to the machine reg,
 763   // ordered according to control-flow order.  This only works for a
 764   // single basic block, hence the assertion.  Each reference is identified
 765   // by the pair: <node, operand-number>.
 766   //
 767   RegToRefVecMap regToRefVecMap;
 768
 769   // Make a dummy root node.  We'll add edges to the real roots later.
 770   graphRoot = new SchedGraphNode(0, NULL, -1, target);
 771   graphLeaf = new SchedGraphNode(1, NULL, -1, target);
 772
 773   //----------------------------------------------------------------
 774   // First add nodes for all the machine instructions in the basic block
 775   // because this greatly simplifies identifying which edges to add.
 776   // Do this one VM instruction at a time since the SchedGraphNode needs that.
 777   // Also, remember the load/store instructions to add memory deps later.
 778   //----------------------------------------------------------------
 779
 780   buildNodesForBB(target, MBB, memNodeVec, regToRefVecMap, valueToDefVecMap);
 781
 782   //----------------------------------------------------------------
 783   // Now add edges for the following (all are incoming edges except (4)):
 784   // (1) operands of the machine instruction, including hidden operands
 785   // (2) machine register dependences
 786   // (3) memory load/store dependences
 787   // (3) other resource dependences for the machine instruction, if any
 788   // (4) output dependences when multiple machine instructions define the
 789   //     same value; all must have been generated from a single VM instrn
 790   // (5) control dependences to branch instructions generated for the
 791   //     terminator instruction of the BB. Because of delay slots and
 792   //     2-way conditional branches, multiple CD edges are needed
 793   //     (see addCDEdges for details).
 794   // Also, note any uses or defs of machine registers.
 795   //
 796   //----------------------------------------------------------------
 797
 798   // First, add edges to the terminator instruction of the basic block.
 799   this->addCDEdges(MBB.getBasicBlock()->getTerminator(), target);
 800
 801   // Then add memory dep edges: store->load, load->store, and store->store.
 802   // Call instructions are treated as both load and store.
 803   this->addMemEdges(memNodeVec, target);
 804
 805   // Then add edges between call instructions and CC set/use instructions
 806   this->addCallCCEdges(memNodeVec, MBB, target);
 807
 808   // Then add incoming def-use (SSA) edges for each machine instruction.
 809   for (unsigned i=0, N=MBB.size(); i < N; i++)
 810     addEdgesForInstruction(*MBB[i], valueToDefVecMap, target);
 811
 812 #ifdef NEED_SEPARATE_NONSSA_EDGES_CODE
 813   // Then add non-SSA edges for all VM instructions in the block.
 814   // We assume that all machine instructions that define a value are
 815   // generated from the VM instruction corresponding to that value.
 816   // TODO: This could probably be done much more efficiently.
 817   for (BasicBlock::const_iterator II = bb->begin(); II != bb->end(); ++II)
 818     this->addNonSSAEdgesForValue(*II, target);
 819 #endif //NEED_SEPARATE_NONSSA_EDGES_CODE
 820
 821   // Then add edges for dependences on machine registers
 822   this->addMachineRegEdges(regToRefVecMap, target);
 823
 824   // Finally, add edges from the dummy root and to dummy leaf
 825   this->addDummyEdges();
 826 }
 827
 828
 829 //
 830 // class SchedGraphSet
 831 //
 832
 833 /*ctor*/
 834 SchedGraphSet::SchedGraphSet(const Function* _function,
 835                              const TargetMachine& target) :
 836   method(_function)
 837 {
 838   buildGraphsForMethod(method, target);
 839 }
 840
 841
 842 /*dtor*/
 843 SchedGraphSet::~SchedGraphSet()
 844 {
 845   // delete all the graphs
 846   for(iterator I = begin(), E = end(); I != E; ++I)
 847     delete *I;  // destructor is a friend
 848 }
 849
 850
 851 void
 852 SchedGraphSet::dump() const
 853 {
 854   std::cerr << "======== Sched graphs for function `" << method->getName()
 855             << "' ========\n\n";
 856
 857   for (const_iterator I=begin(); I != end(); ++I)
 858     (*I)->dump();
 859
 860   std::cerr << "\n====== End graphs for function `" << method->getName()
 861             << "' ========\n\n";
 862 }
 863
 864
 865 void
 866 SchedGraphSet::buildGraphsForMethod(const Function *F,
 867                                     const TargetMachine& target)
 868 {
 869   MachineFunction &MF = MachineFunction::get(F);
 870   for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I)
 871     addGraph(new SchedGraph(*I, target));
 872 }
 873
 874
 875 std::ostream &operator<<(std::ostream &os, const SchedGraphEdge& edge)
 876 {
 877   os << "edge [" << edge.src->getNodeId() << "] -> ["
 878      << edge.sink->getNodeId() << "] : ";
 879
 880   switch(edge.depType) {
 881   case SchedGraphEdge::CtrlDep:         os<< "Control Dep"; break;
 882   case SchedGraphEdge::ValueDep:        os<< "Reg Value " << edge.val; break;
 883   case SchedGraphEdge::MemoryDep:       os<< "Memory Dep"; break;
 884   case SchedGraphEdge::MachineRegister: os<< "Reg " <<edge.machineRegNum;break;
 885   case SchedGraphEdge::MachineResource: os<<"Resource "<<edge.resourceId;break;
 886   default: assert(0); break;
 887   }
 888
 889   os << " : delay = " << edge.minDelay << "\n";
 890
 891   return os;
 892 }
 893
 894 std::ostream &operator<<(std::ostream &os, const SchedGraphNode& node)
 895 {
 896   os << std::string(8, ' ')
 897      << "Node " << node.nodeId << " : "
 898      << "latency = " << node.latency << "\n" << std::string(12, ' ');
 899
 900   if (node.getMachineInstr() == NULL)
 901     os << "(Dummy node)\n";
 902   else {
 903     os << *node.getMachineInstr() << "\n" << std::string(12, ' ');
 904     os << node.inEdges.size() << " Incoming Edges:\n";
 905     for (unsigned i=0, N=node.inEdges.size(); i < N; i++)
 906       os << std::string(16, ' ') << *node.inEdges[i];
 907
 908     os << std::string(12, ' ') << node.outEdges.size()
 909        << " Outgoing Edges:\n";
 910     for (unsigned i=0, N=node.outEdges.size(); i < N; i++)
 911       os << std::string(16, ' ') << *node.outEdges[i];
 912   }
 913
 914   return os;
 915 }