utils/TableGen/DFAPacketizerEmitter.cpp

   1 //===- DFAPacketizerEmitter.cpp - Packetization DFA for a VLIW machine-----===//
   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 class parses the Schedule.td file and produces an API that can be used
  11 // to reason about whether an instruction can be added to a packet on a VLIW
  12 // architecture. The class internally generates a deterministic finite
  13 // automaton (DFA) that models all possible mappings of machine instructions
  14 // to functional units as instructions are added to a packet.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #define DEBUG_TYPE "dfa-emitter"
  19
  20 #include "CodeGenTarget.h"
  21 #include "llvm/ADT/DenseSet.h"
  22 #include "llvm/ADT/STLExtras.h"
  23 #include "llvm/ADT/StringExtras.h"
  24 #include "llvm/CodeGen/DFAPacketizer.h"
  25 #include "llvm/TableGen/Record.h"
  26 #include "llvm/TableGen/TableGenBackend.h"
  27 #include "llvm/Support/Debug.h"
  28 #include <list>
  29 #include <map>
  30 #include <string>
  31 #include <queue>
  32 using namespace llvm;
  33
  34 // To enable debugging, run llvm-tblgen with: "-debug-only dfa-emitter".
  35 //
  36 // dbgsInsnClass - When debugging, print instruction class stages.
  37 //
  38 void dbgsInsnClass(const std::vector<unsigned> &InsnClass);
  39 //
  40 // dbgsStateInfo - When debugging, print the set of state info.
  41 //
  42 void dbgsStateInfo(const std::set<unsigned> &stateInfo);
  43 //
  44 // dbgsIndent - When debugging, indent by the specified amount.
  45 //
  46 void dbgsIndent(unsigned indent);
  47
  48 //
  49 // class DFAPacketizerEmitter: class that generates and prints out the DFA
  50 // for resource tracking.
  51 //
  52 namespace {
  53 class DFAPacketizerEmitter {
  54 private:
  55   std::string TargetName;
  56   //
  57   // allInsnClasses is the set of all possible resources consumed by an
  58   // InstrStage.
  59   //
  60   std::vector<std::vector<unsigned>> allInsnClasses;
  61   RecordKeeper &Records;
  62
  63 public:
  64   DFAPacketizerEmitter(RecordKeeper &R);
  65
  66   //
  67   // collectAllFuncUnits - Construct a map of function unit names to bits.
  68   //
  69   int collectAllFuncUnits(std::vector<Record*> &ProcItinList,
  70                            std::map<std::string, unsigned> &FUNameToBitsMap,
  71                            int &maxResources,
  72                            raw_ostream &OS);
  73
  74   //
  75   // collectAllComboFuncs - Construct a map from a combo function unit bit to
  76   //                        the bits of all included functional units.
  77   //
  78   int collectAllComboFuncs(std::vector<Record*> &ComboFuncList,
  79                            std::map<std::string, unsigned> &FUNameToBitsMap,
  80                            std::map<unsigned, unsigned> &ComboBitToBitsMap,
  81                            raw_ostream &OS);
  82
  83   //
  84   // collectOneInsnClass - Populate allInsnClasses with one instruction class.
  85   //
  86   int collectOneInsnClass(const std::string &ProcName,
  87                            std::vector<Record*> &ProcItinList,
  88                            std::map<std::string, unsigned> &FUNameToBitsMap,
  89                            Record *ItinData,
  90                            raw_ostream &OS);
  91
  92   //
  93   // collectAllInsnClasses - Populate allInsnClasses which is a set of units
  94   // used in each stage.
  95   //
  96   int collectAllInsnClasses(const std::string &ProcName,
  97                            std::vector<Record*> &ProcItinList,
  98                            std::map<std::string, unsigned> &FUNameToBitsMap,
  99                            std::vector<Record*> &ItinDataList,
 100                            int &maxStages,
 101                            raw_ostream &OS);
 102
 103   void run(raw_ostream &OS);
 104 };
 105 } // End anonymous namespace.
 106
 107 //
 108 //
 109 // State represents the usage of machine resources if the packet contains
 110 // a set of instruction classes.
 111 //
 112 // Specifically, currentState is a set of bit-masks.
 113 // The nth bit in a bit-mask indicates whether the nth resource is being used
 114 // by this state. The set of bit-masks in a state represent the different
 115 // possible outcomes of transitioning to this state.
 116 // For example: consider a two resource architecture: resource L and resource M
 117 // with three instruction classes: L, M, and L_or_M.
 118 // From the initial state (currentState = 0x00), if we add instruction class
 119 // L_or_M we will transition to a state with currentState = [0x01, 0x10]. This
 120 // represents the possible resource states that can result from adding a L_or_M
 121 // instruction
 122 //
 123 // Another way of thinking about this transition is we are mapping a NDFA with
 124 // two states [0x01] and [0x10] into a DFA with a single state [0x01, 0x10].
 125 //
 126 // A State instance also contains a collection of transitions from that state:
 127 // a map from inputs to new states.
 128 //
 129 namespace {
 130 class State {
 131  public:
 132   static int currentStateNum;
 133   // stateNum is the only member used for equality/ordering, all other members
 134   // can be mutated even in const State objects.
 135   const int stateNum;
 136   mutable bool isInitial;
 137   mutable std::set<unsigned> stateInfo;
 138   typedef std::map<std::vector<unsigned>, const State *> TransitionMap;
 139   mutable TransitionMap Transitions;
 140
 141   State();
 142
 143   bool operator<(const State &s) const {
 144     return stateNum < s.stateNum;
 145   }
 146
 147   //
 148   // canMaybeAddInsnClass - Quickly verifies if an instruction of type InsnClass
 149   // may be a valid transition from this state i.e., can an instruction of type
 150   // InsnClass be added to the packet represented by this state.
 151   //
 152   // Note that for multiple stages, this quick check does not take into account
 153   // any possible resource competition between the stages themselves.  That is
 154   // enforced in AddInsnClassStages which checks the cross product of all
 155   // stages for resource availability (which is a more involved check).
 156   //
 157   bool canMaybeAddInsnClass(std::vector<unsigned> &InsnClass,
 158                         std::map<unsigned, unsigned> &ComboBitToBitsMap) const;
 159   //
 160   // AddInsnClass - Return all combinations of resource reservation
 161   // which are possible from this state (PossibleStates).
 162   //
 163   // PossibleStates is the set of valid resource states that ensue from valid
 164   // transitions.
 165   //
 166   void AddInsnClass(std::vector<unsigned> &InsnClass,
 167                         std::map<unsigned, unsigned> &ComboBitToBitsMap,
 168                         std::set<unsigned> &PossibleStates) const;
 169   //
 170   // AddInsnClassStages - Return all combinations of resource reservation
 171   // resulting from the cross product of all stages for this InsnClass
 172   // which are possible from this state (PossibleStates).
 173   //
 174   void AddInsnClassStages(std::vector<unsigned> &InsnClass,
 175                         std::map<unsigned, unsigned> &ComboBitToBitsMap,
 176                         unsigned chkstage, unsigned numstages,
 177                         unsigned prevState, unsigned origState,
 178                         DenseSet<unsigned> &VisitedResourceStates,
 179                         std::set<unsigned> &PossibleStates) const;
 180   //
 181   // addTransition - Add a transition from this state given the input InsnClass
 182   //
 183   void addTransition(std::vector<unsigned> InsnClass, const State *To) const;
 184   //
 185   // hasTransition - Returns true if there is a transition from this state
 186   // given the input InsnClass
 187   //
 188   bool hasTransition(std::vector<unsigned> InsnClass) const;
 189 };
 190 } // End anonymous namespace.
 191
 192 //
 193 // class DFA: deterministic finite automaton for processor resource tracking.
 194 //
 195 namespace {
 196 class DFA {
 197 public:
 198   DFA();
 199
 200   // Set of states. Need to keep this sorted to emit the transition table.
 201   typedef std::set<State> StateSet;
 202   StateSet states;
 203
 204   State *currentState;
 205
 206   //
 207   // Modify the DFA.
 208   //
 209   const State &newState();
 210
 211   //
 212   // writeTable: Print out a table representing the DFA.
 213   //
 214   void writeTableAndAPI(raw_ostream &OS, const std::string &ClassName,
 215                  int numInsnClasses = 0,
 216                  int maxResources = 0, int numCombos = 0, int maxStages = 0);
 217 };
 218 } // End anonymous namespace.
 219
 220 // To enable debugging, run llvm-tblgen with: "-debug-only dfa-emitter".
 221 //
 222 // dbgsInsnClass - When debugging, print instruction class stages.
 223 //
 224 void dbgsInsnClass(const std::vector<unsigned> &InsnClass) {
 225   DEBUG(dbgs() << "InsnClass: ");
 226   for (unsigned i = 0; i < InsnClass.size(); ++i) {
 227     if (i > 0) {
 228       DEBUG(dbgs() << ", ");
 229     }
 230     DEBUG(dbgs() << "0x" << utohexstr(InsnClass[i]));
 231   }
 232   DFAInput InsnInput = DFAPacketizer::getInsnInput(InsnClass);
 233   DEBUG(dbgs() << " (input: 0x" << utohexstr(InsnInput) << ")");
 234 }
 235
 236 //
 237 // dbgsStateInfo - When debugging, print the set of state info.
 238 //
 239 void dbgsStateInfo(const std::set<unsigned> &stateInfo) {
 240   DEBUG(dbgs() << "StateInfo: ");
 241   unsigned i = 0;
 242   for (std::set<unsigned>::iterator SI = stateInfo.begin();
 243        SI != stateInfo.end(); ++SI, ++i) {
 244     unsigned thisState = *SI;
 245     if (i > 0) {
 246       DEBUG(dbgs() << ", ");
 247     }
 248     DEBUG(dbgs() << "0x" << utohexstr(thisState));
 249   }
 250 }
 251
 252 //
 253 // dbgsIndent - When debugging, indent by the specified amount.
 254 //
 255 void dbgsIndent(unsigned indent) {
 256   for (unsigned i = 0; i < indent; ++i) {
 257     DEBUG(dbgs() << " ");
 258   }
 259 }
 260
 261 //
 262 // Constructors and destructors for State and DFA
 263 //
 264 State::State() :
 265   stateNum(currentStateNum++), isInitial(false) {}
 266
 267 DFA::DFA(): currentState(nullptr) {}
 268
 269 //
 270 // addTransition - Add a transition from this state given the input InsnClass
 271 //
 272 void State::addTransition(std::vector<unsigned> InsnClass, const State *To)
 273       const {
 274   assert(!Transitions.count(InsnClass) &&
 275       "Cannot have multiple transitions for the same input");
 276   Transitions[InsnClass] = To;
 277 }
 278
 279 //
 280 // hasTransition - Returns true if there is a transition from this state
 281 // given the input InsnClass
 282 //
 283 bool State::hasTransition(std::vector<unsigned> InsnClass) const {
 284   return Transitions.count(InsnClass) > 0;
 285 }
 286
 287 //
 288 // AddInsnClass - Return all combinations of resource reservation
 289 // which are possible from this state (PossibleStates).
 290 //
 291 // PossibleStates is the set of valid resource states that ensue from valid
 292 // transitions.
 293 //
 294 void State::AddInsnClass(std::vector<unsigned> &InsnClass,
 295                         std::map<unsigned, unsigned> &ComboBitToBitsMap,
 296                         std::set<unsigned> &PossibleStates) const {
 297   //
 298   // Iterate over all resource states in currentState.
 299   //
 300   unsigned numstages = InsnClass.size();
 301   assert((numstages > 0) && "InsnClass has no stages");
 302
 303   for (std::set<unsigned>::iterator SI = stateInfo.begin();
 304        SI != stateInfo.end(); ++SI) {
 305     unsigned thisState = *SI;
 306
 307     DenseSet<unsigned> VisitedResourceStates;
 308
 309     DEBUG(dbgs() << "  thisState: 0x" << utohexstr(thisState) << "\n");
 310     AddInsnClassStages(InsnClass, ComboBitToBitsMap,
 311                                 numstages - 1, numstages,
 312                                 thisState, thisState,
 313                                 VisitedResourceStates, PossibleStates);
 314   }
 315 }
 316
 317 void State::AddInsnClassStages(std::vector<unsigned> &InsnClass,
 318                         std::map<unsigned, unsigned> &ComboBitToBitsMap,
 319                         unsigned chkstage, unsigned numstages,
 320                         unsigned prevState, unsigned origState,
 321                         DenseSet<unsigned> &VisitedResourceStates,
 322                         std::set<unsigned> &PossibleStates) const {
 323
 324   assert((chkstage < numstages) && "AddInsnClassStages: stage out of range");
 325   unsigned thisStage = InsnClass[chkstage];
 326
 327   dbgsIndent((1 + numstages - chkstage) << 1);
 328   DEBUG(dbgs() << "AddInsnClassStages " << chkstage
 329                << " (0x" << utohexstr(thisStage) << ") from ");
 330   dbgsInsnClass(InsnClass);
 331   DEBUG(dbgs() << "\n");
 332
 333   //
 334   // Iterate over all possible resources used in thisStage.
 335   // For ex: for thisStage = 0x11, all resources = {0x01, 0x10}.
 336   //
 337   for (unsigned int j = 0; j < DFA_MAX_RESOURCES; ++j) {
 338     unsigned resourceMask = (0x1 << j);
 339     if (resourceMask & thisStage) {
 340       unsigned combo = ComboBitToBitsMap[resourceMask];
 341       if (combo && ((~prevState & combo) != combo)) {
 342         DEBUG(dbgs() << "\tSkipped Add 0x" << utohexstr(prevState)
 343                      << " - combo op 0x" << utohexstr(resourceMask)
 344                      << " (0x" << utohexstr(combo) <<") cannot be scheduled\n");
 345         continue;
 346       }
 347       //
 348       // For each possible resource used in thisStage, generate the
 349       // resource state if that resource was used.
 350       //
 351       unsigned ResultingResourceState = prevState | resourceMask | combo;
 352       dbgsIndent((2 + numstages - chkstage) << 1);
 353       DEBUG(dbgs() << "0x" << utohexstr(prevState)
 354                    << " | 0x" << utohexstr(resourceMask));
 355       if (combo) {
 356         DEBUG(dbgs() << " | 0x" << utohexstr(combo));
 357       }
 358       DEBUG(dbgs() << " = 0x" << utohexstr(ResultingResourceState) << " ");
 359
 360       //
 361       // If this is the final stage for this class
 362       //
 363       if (chkstage == 0) {
 364         //
 365         // Check if the resulting resource state can be accommodated in this
 366         // packet.
 367         // We compute resource OR prevState (originally started as origState).
 368         // If the result of the OR is different than origState, it implies
 369         // that there is at least one resource that can be used to schedule
 370         // thisStage in the current packet.
 371         // Insert ResultingResourceState into PossibleStates only if we haven't
 372         // processed ResultingResourceState before.
 373         //
 374         if (ResultingResourceState != prevState) {
 375           if (VisitedResourceStates.count(ResultingResourceState) == 0) {
 376             VisitedResourceStates.insert(ResultingResourceState);
 377             PossibleStates.insert(ResultingResourceState);
 378             DEBUG(dbgs() << "\tResultingResourceState: 0x"
 379                          << utohexstr(ResultingResourceState) << "\n");
 380           } else {
 381             DEBUG(dbgs() << "\tSkipped Add - state already seen\n");
 382           }
 383         } else {
 384           DEBUG(dbgs() << "\tSkipped Add - no final resources available\n");
 385         }
 386       } else {
 387         //
 388         // If the current resource can be accommodated, check the next
 389         // stage in InsnClass for available resources.
 390         //
 391         if (ResultingResourceState != prevState) {
 392           DEBUG(dbgs() << "\n");
 393           AddInsnClassStages(InsnClass, ComboBitToBitsMap,
 394                                 chkstage - 1, numstages,
 395                                 ResultingResourceState, origState,
 396                                 VisitedResourceStates, PossibleStates);
 397         } else {
 398           DEBUG(dbgs() << "\tSkipped Add - no resources available\n");
 399         }
 400       }
 401     }
 402   }
 403 }
 404
 405
 406 //
 407 // canMaybeAddInsnClass - Quickly verifies if an instruction of type InsnClass
 408 // may be a valid transition from this state i.e., can an instruction of type
 409 // InsnClass be added to the packet represented by this state.
 410 //
 411 // Note that this routine is performing conservative checks that can be
 412 // quickly executed acting as a filter before calling AddInsnClassStages.
 413 // Any cases allowed through here will be caught later in AddInsnClassStages
 414 // which performs the more expensive exact check.
 415 //
 416 bool State::canMaybeAddInsnClass(std::vector<unsigned> &InsnClass,
 417                     std::map<unsigned, unsigned> &ComboBitToBitsMap) const {
 418   for (std::set<unsigned>::const_iterator SI = stateInfo.begin();
 419        SI != stateInfo.end(); ++SI) {
 420
 421     // Check to see if all required resources are available.
 422     bool available = true;
 423
 424     // Inspect each stage independently.
 425     // note: This is a conservative check as we aren't checking for
 426     //       possible resource competition between the stages themselves
 427     //       The full cross product is examined later in AddInsnClass.
 428     for (unsigned i = 0; i < InsnClass.size(); ++i) {
 429       unsigned resources = *SI;
 430       if ((~resources & InsnClass[i]) == 0) {
 431         available = false;
 432         break;
 433       }
 434       // Make sure _all_ resources for a combo function are available.
 435       // note: This is a quick conservative check as it won't catch an
 436       //       unscheduleable combo if this stage is an OR expression
 437       //       containing a combo.
 438       //       These cases are caught later in AddInsnClass.
 439       unsigned combo = ComboBitToBitsMap[InsnClass[i]];
 440       if (combo && ((~resources & combo) != combo)) {
 441         DEBUG(dbgs() << "\tSkipped canMaybeAdd 0x" << utohexstr(resources)
 442                      << " - combo op 0x" << utohexstr(InsnClass[i])
 443                      << " (0x" << utohexstr(combo) <<") cannot be scheduled\n");
 444         available = false;
 445         break;
 446       }
 447     }
 448
 449     if (available) {
 450       return true;
 451     }
 452   }
 453   return false;
 454 }
 455
 456
 457 const State &DFA::newState() {
 458   auto IterPair = states.insert(State());
 459   assert(IterPair.second && "State already exists");
 460   return *IterPair.first;
 461 }
 462
 463 int State::currentStateNum = 0;
 464
 465 DFAPacketizerEmitter::DFAPacketizerEmitter(RecordKeeper &R):
 466   TargetName(CodeGenTarget(R).getName()),
 467   allInsnClasses(), Records(R) {}
 468
 469
 470 //
 471 // writeTableAndAPI - Print out a table representing the DFA and the
 472 // associated API to create a DFA packetizer.
 473 //
 474 // Format:
 475 // DFAStateInputTable[][2] = pairs of <Input, Transition> for all valid
 476 //                           transitions.
 477 // DFAStateEntryTable[i] = Index of the first entry in DFAStateInputTable for
 478 //                         the ith state.
 479 //
 480 //
 481 void DFA::writeTableAndAPI(raw_ostream &OS, const std::string &TargetName,
 482                            int numInsnClasses,
 483                            int maxResources, int numCombos, int maxStages) {
 484
 485   unsigned numStates = states.size();
 486
 487   DEBUG(dbgs() << "-----------------------------------------------------------------------------\n");
 488   DEBUG(dbgs() << "writeTableAndAPI\n");
 489   DEBUG(dbgs() << "Total states: " << numStates << "\n");
 490
 491   OS << "namespace llvm {\n";
 492
 493   OS << "\n// Input format:\n";
 494   OS << "#define DFA_MAX_RESTERMS        " << DFA_MAX_RESTERMS
 495      << "\t// maximum AND'ed resource terms\n";
 496   OS << "#define DFA_MAX_RESOURCES       " << DFA_MAX_RESOURCES
 497      << "\t// maximum resource bits in one term\n";
 498
 499   OS << "\n// " << TargetName << "DFAStateInputTable[][2] = "
 500      << "pairs of <Input, NextState> for all valid\n";
 501   OS << "//                           transitions.\n";
 502   OS << "// " << numStates << "\tstates\n";
 503   OS << "// " << numInsnClasses << "\tinstruction classes\n";
 504   OS << "// " << maxResources << "\tresources max\n";
 505   OS << "// " << numCombos << "\tcombo resources\n";
 506   OS << "// " << maxStages << "\tstages max\n";
 507   OS << "const " << DFA_TBLTYPE << " "
 508      << TargetName << "DFAStateInputTable[][2] = {\n";
 509
 510   // This table provides a map to the beginning of the transitions for State s
 511   // in DFAStateInputTable.
 512   std::vector<int> StateEntry(numStates+1);
 513   static const std::string SentinelEntry = "{-1, -1}";
 514
 515   // Tracks the total valid transitions encountered so far. It is used
 516   // to construct the StateEntry table.
 517   int ValidTransitions = 0;
 518   DFA::StateSet::iterator SI = states.begin();
 519   for (unsigned i = 0; i < numStates; ++i, ++SI) {
 520     assert ((SI->stateNum == (int) i) && "Mismatch in state numbers");
 521     StateEntry[i] = ValidTransitions;
 522     for (State::TransitionMap::iterator
 523         II = SI->Transitions.begin(), IE = SI->Transitions.end();
 524         II != IE; ++II) {
 525       OS << "{0x" << utohexstr(DFAPacketizer::getInsnInput(II->first)) << ", "
 526          << II->second->stateNum
 527          << "},\t";
 528     }
 529     ValidTransitions += SI->Transitions.size();
 530
 531     // If there are no valid transitions from this stage, we need a sentinel
 532     // transition.
 533     if (ValidTransitions == StateEntry[i]) {
 534       OS << SentinelEntry << ",\t";
 535       ++ValidTransitions;
 536     }
 537
 538     OS << " // state " << i << ": " << StateEntry[i];
 539     if (StateEntry[i] != (ValidTransitions-1)) {   // More than one transition.
 540        OS << "-" << (ValidTransitions-1);
 541     }
 542     OS << "\n";
 543   }
 544
 545   // Print out a sentinel entry at the end of the StateInputTable. This is
 546   // needed to iterate over StateInputTable in DFAPacketizer::ReadTable()
 547   OS << SentinelEntry << "\t";
 548   OS << " // state " << numStates << ": " << ValidTransitions;
 549   OS << "\n";
 550
 551   OS << "};\n\n";
 552   OS << "// " << TargetName << "DFAStateEntryTable[i] = "
 553      << "Index of the first entry in DFAStateInputTable for\n";
 554   OS << "//                         "
 555      << "the ith state.\n";
 556   OS << "// " << numStates << " states\n";
 557   OS << "const unsigned int " << TargetName << "DFAStateEntryTable[] = {\n";
 558
 559   // Multiply i by 2 since each entry in DFAStateInputTable is a set of
 560   // two numbers.
 561   unsigned lastState = 0;
 562   for (unsigned i = 0; i < numStates; ++i) {
 563     if (i && ((i % 10) == 0)) {
 564         lastState = i-1;
 565         OS << "   // states " << (i-10) << ":" << lastState << "\n";
 566     }
 567     OS << StateEntry[i] << ", ";
 568   }
 569
 570   // Print out the index to the sentinel entry in StateInputTable
 571   OS << ValidTransitions << ", ";
 572   OS << "   // states " << (lastState+1) << ":" << numStates << "\n";
 573
 574   OS << "};\n";
 575   OS << "} // namespace\n";
 576
 577
 578   //
 579   // Emit DFA Packetizer tables if the target is a VLIW machine.
 580   //
 581   std::string SubTargetClassName = TargetName + "GenSubtargetInfo";
 582   OS << "\n" << "#include \"llvm/CodeGen/DFAPacketizer.h\"\n";
 583   OS << "namespace llvm {\n";
 584   OS << "DFAPacketizer *" << SubTargetClassName << "::"
 585      << "createDFAPacketizer(const InstrItineraryData *IID) const {\n"
 586      << "   return new DFAPacketizer(IID, " << TargetName
 587      << "DFAStateInputTable, " << TargetName << "DFAStateEntryTable);\n}\n\n";
 588   OS << "} // End llvm namespace \n";
 589 }
 590
 591
 592 //
 593 // collectAllFuncUnits - Construct a map of function unit names to bits.
 594 //
 595 int DFAPacketizerEmitter::collectAllFuncUnits(
 596                             std::vector<Record*> &ProcItinList,
 597                             std::map<std::string, unsigned> &FUNameToBitsMap,
 598                             int &maxFUs,
 599                             raw_ostream &OS) {
 600   DEBUG(dbgs() << "-----------------------------------------------------------------------------\n");
 601   DEBUG(dbgs() << "collectAllFuncUnits");
 602   DEBUG(dbgs() << " (" << ProcItinList.size() << " itineraries)\n");
 603
 604   int totalFUs = 0;
 605   // Parse functional units for all the itineraries.
 606   for (unsigned i = 0, N = ProcItinList.size(); i < N; ++i) {
 607     Record *Proc = ProcItinList[i];
 608     const std::string &ProcName = Proc->getName();
 609     std::vector<Record*> FUs = Proc->getValueAsListOfDefs("FU");
 610
 611     DEBUG(dbgs() << "    FU:" << i
 612                  << " (" << FUs.size() << " FUs) "
 613                  << ProcName);
 614
 615
 616     // Convert macros to bits for each stage.
 617     unsigned numFUs = FUs.size();
 618     for (unsigned j = 0; j < numFUs; ++j) {
 619       assert ((j < DFA_MAX_RESOURCES) &&
 620                       "Exceeded maximum number of representable resources");
 621       unsigned FuncResources = (unsigned) (1U << j);
 622       FUNameToBitsMap[FUs[j]->getName()] = FuncResources;
 623       DEBUG(dbgs() << " " << FUs[j]->getName()
 624                    << ":0x" << utohexstr(FuncResources));
 625     }
 626     if (((int) numFUs) > maxFUs) {
 627       maxFUs = numFUs;
 628     }
 629     totalFUs += numFUs;
 630     DEBUG(dbgs() << "\n");
 631   }
 632   return totalFUs;
 633 }
 634
 635 //
 636 // collectAllComboFuncs - Construct a map from a combo function unit bit to
 637 //                        the bits of all included functional units.
 638 //
 639 int DFAPacketizerEmitter::collectAllComboFuncs(
 640                             std::vector<Record*> &ComboFuncList,
 641                             std::map<std::string, unsigned> &FUNameToBitsMap,
 642                             std::map<unsigned, unsigned> &ComboBitToBitsMap,
 643                             raw_ostream &OS) {
 644   DEBUG(dbgs() << "-----------------------------------------------------------------------------\n");
 645   DEBUG(dbgs() << "collectAllComboFuncs");
 646   DEBUG(dbgs() << " (" << ComboFuncList.size() << " sets)\n");
 647
 648   int numCombos = 0;
 649   for (unsigned i = 0, N = ComboFuncList.size(); i < N; ++i) {
 650     Record *Func = ComboFuncList[i];
 651     const std::string &ProcName = Func->getName();
 652     std::vector<Record*> FUs = Func->getValueAsListOfDefs("CFD");
 653
 654     DEBUG(dbgs() << "    CFD:" << i
 655                  << " (" << FUs.size() << " combo FUs) "
 656                  << ProcName << "\n");
 657
 658     // Convert macros to bits for each stage.
 659     for (unsigned j = 0, N = FUs.size(); j < N; ++j) {
 660       assert ((j < DFA_MAX_RESOURCES) &&
 661                       "Exceeded maximum number of DFA resources");
 662       Record *FuncData = FUs[j];
 663       Record *ComboFunc = FuncData->getValueAsDef("TheComboFunc");
 664       const std::vector<Record*> &FuncList =
 665                                    FuncData->getValueAsListOfDefs("FuncList");
 666       std::string ComboFuncName = ComboFunc->getName();
 667       unsigned ComboBit = FUNameToBitsMap[ComboFuncName];
 668       unsigned ComboResources = ComboBit;
 669       DEBUG(dbgs() << "      combo: " << ComboFuncName
 670                    << ":0x" << utohexstr(ComboResources) << "\n");
 671       for (unsigned k = 0, M = FuncList.size(); k < M; ++k) {
 672         std::string FuncName = FuncList[k]->getName();
 673         unsigned FuncResources = FUNameToBitsMap[FuncName];
 674         DEBUG(dbgs() << "        " << FuncName
 675                      << ":0x" << utohexstr(FuncResources) << "\n");
 676         ComboResources |= FuncResources;
 677       }
 678       ComboBitToBitsMap[ComboBit] = ComboResources;
 679       numCombos++;
 680       DEBUG(dbgs() << "          => combo bits: " << ComboFuncName << ":0x"
 681                    << utohexstr(ComboBit) << " = 0x"
 682                    << utohexstr(ComboResources) << "\n");
 683     }
 684   }
 685   return numCombos;
 686 }
 687
 688
 689 //
 690 // collectOneInsnClass - Populate allInsnClasses with one instruction class
 691 //
 692 int DFAPacketizerEmitter::collectOneInsnClass(const std::string &ProcName,
 693                         std::vector<Record*> &ProcItinList,
 694                         std::map<std::string, unsigned> &FUNameToBitsMap,
 695                         Record *ItinData,
 696                         raw_ostream &OS) {
 697   // Collect instruction classes.
 698   Record *ItinDef = ItinData->getValueAsDef("TheClass");
 699
 700   const std::vector<Record*> &StageList =
 701     ItinData->getValueAsListOfDefs("Stages");
 702
 703   // The number of stages.
 704   unsigned NStages = StageList.size();
 705
 706   DEBUG(dbgs() << "    " << ItinDef->getName()
 707                << "\n");
 708
 709   std::vector<unsigned> UnitBits;
 710
 711   // Compute the bitwise or of each unit used in this stage.
 712   for (unsigned i = 0; i < NStages; ++i) {
 713     const Record *Stage = StageList[i];
 714
 715     // Get unit list.
 716     const std::vector<Record*> &UnitList =
 717       Stage->getValueAsListOfDefs("Units");
 718
 719     DEBUG(dbgs() << "        stage:" << i
 720                  << " [" << UnitList.size() << " units]:");
 721     unsigned dbglen = 26;  // cursor after stage dbgs
 722
 723     // Compute the bitwise or of each unit used in this stage.
 724     unsigned UnitBitValue = 0;
 725     for (unsigned j = 0, M = UnitList.size(); j < M; ++j) {
 726       // Conduct bitwise or.
 727       std::string UnitName = UnitList[j]->getName();
 728       DEBUG(dbgs() << " " << j << ":" << UnitName);
 729       dbglen += 3 + UnitName.length();
 730       assert(FUNameToBitsMap.count(UnitName));
 731       UnitBitValue |= FUNameToBitsMap[UnitName];
 732     }
 733
 734     if (UnitBitValue != 0)
 735       UnitBits.push_back(UnitBitValue);
 736
 737     while (dbglen <= 64) {   // line up bits dbgs
 738         dbglen += 8;
 739         DEBUG(dbgs() << "\t");
 740     }
 741     DEBUG(dbgs() << " (bits: 0x" << utohexstr(UnitBitValue) << ")\n");
 742   }
 743
 744   if (UnitBits.size() > 0)
 745     allInsnClasses.push_back(UnitBits);
 746
 747   DEBUG(dbgs() << "        ");
 748   dbgsInsnClass(UnitBits);
 749   DEBUG(dbgs() << "\n");
 750
 751   return NStages;
 752 }
 753
 754 //
 755 // collectAllInsnClasses - Populate allInsnClasses which is a set of units
 756 // used in each stage.
 757 //
 758 int DFAPacketizerEmitter::collectAllInsnClasses(const std::string &ProcName,
 759                             std::vector<Record*> &ProcItinList,
 760                             std::map<std::string, unsigned> &FUNameToBitsMap,
 761                             std::vector<Record*> &ItinDataList,
 762                             int &maxStages,
 763                             raw_ostream &OS) {
 764   // Collect all instruction classes.
 765   unsigned M = ItinDataList.size();
 766
 767   int numInsnClasses = 0;
 768   DEBUG(dbgs() << "-----------------------------------------------------------------------------\n"
 769                << "collectAllInsnClasses "
 770                << ProcName
 771                << " (" << M << " classes)\n");
 772
 773   // Collect stages for each instruction class for all itinerary data
 774   for (unsigned j = 0; j < M; j++) {
 775     Record *ItinData = ItinDataList[j];
 776     int NStages = collectOneInsnClass(ProcName, ProcItinList,
 777                                       FUNameToBitsMap, ItinData, OS);
 778     if (NStages > maxStages) {
 779       maxStages = NStages;
 780     }
 781     numInsnClasses++;
 782   }
 783   return numInsnClasses;
 784 }
 785
 786 //
 787 // Run the worklist algorithm to generate the DFA.
 788 //
 789 void DFAPacketizerEmitter::run(raw_ostream &OS) {
 790
 791   // Collect processor iteraries.
 792   std::vector<Record*> ProcItinList =
 793     Records.getAllDerivedDefinitions("ProcessorItineraries");
 794
 795   //
 796   // Collect the Functional units.
 797   //
 798   std::map<std::string, unsigned> FUNameToBitsMap;
 799   int maxResources = 0;
 800   collectAllFuncUnits(ProcItinList,
 801                               FUNameToBitsMap, maxResources, OS);
 802
 803   //
 804   // Collect the Combo Functional units.
 805   //
 806   std::map<unsigned, unsigned> ComboBitToBitsMap;
 807   std::vector<Record*> ComboFuncList =
 808     Records.getAllDerivedDefinitions("ComboFuncUnits");
 809   int numCombos = collectAllComboFuncs(ComboFuncList,
 810                               FUNameToBitsMap, ComboBitToBitsMap, OS);
 811
 812   //
 813   // Collect the itineraries.
 814   //
 815   int maxStages = 0;
 816   int numInsnClasses = 0;
 817   for (unsigned i = 0, N = ProcItinList.size(); i < N; i++) {
 818     Record *Proc = ProcItinList[i];
 819
 820     // Get processor itinerary name.
 821     const std::string &ProcName = Proc->getName();
 822
 823     // Skip default.
 824     if (ProcName == "NoItineraries")
 825       continue;
 826
 827     // Sanity check for at least one instruction itinerary class.
 828     unsigned NItinClasses =
 829       Records.getAllDerivedDefinitions("InstrItinClass").size();
 830     if (NItinClasses == 0)
 831       return;
 832
 833     // Get itinerary data list.
 834     std::vector<Record*> ItinDataList = Proc->getValueAsListOfDefs("IID");
 835
 836     // Collect all instruction classes
 837     numInsnClasses += collectAllInsnClasses(ProcName, ProcItinList,
 838                           FUNameToBitsMap, ItinDataList, maxStages, OS);
 839   }
 840
 841   //
 842   // Run a worklist algorithm to generate the DFA.
 843   //
 844   DFA D;
 845   const State *Initial = &D.newState();
 846   Initial->isInitial = true;
 847   Initial->stateInfo.insert(0x0);
 848   SmallVector<const State*, 32> WorkList;
 849 //  std::queue<State*> WorkList;
 850   std::map<std::set<unsigned>, const State*> Visited;
 851
 852   WorkList.push_back(Initial);
 853
 854   //
 855   // Worklist algorithm to create a DFA for processor resource tracking.
 856   // C = {set of InsnClasses}
 857   // Begin with initial node in worklist. Initial node does not have
 858   // any consumed resources,
 859   //     ResourceState = 0x0
 860   // Visited = {}
 861   // While worklist != empty
 862   //    S = first element of worklist
 863   //    For every instruction class C
 864   //      if we can accommodate C in S:
 865   //          S' = state with resource states = {S Union C}
 866   //          Add a new transition: S x C -> S'
 867   //          If S' is not in Visited:
 868   //             Add S' to worklist
 869   //             Add S' to Visited
 870   //
 871   while (!WorkList.empty()) {
 872     const State *current = WorkList.pop_back_val();
 873     DEBUG(dbgs() << "---------------------\n");
 874     DEBUG(dbgs() << "Processing state: " << current->stateNum << " - ");
 875     dbgsStateInfo(current->stateInfo);
 876     DEBUG(dbgs() << "\n");
 877     for (unsigned i = 0; i < allInsnClasses.size(); i++) {
 878       std::vector<unsigned> InsnClass = allInsnClasses[i];
 879       DEBUG(dbgs() << i << " ");
 880       dbgsInsnClass(InsnClass);
 881       DEBUG(dbgs() << "\n");
 882
 883       std::set<unsigned> NewStateResources;
 884       //
 885       // If we haven't already created a transition for this input
 886       // and the state can accommodate this InsnClass, create a transition.
 887       //
 888       if (!current->hasTransition(InsnClass) &&
 889           current->canMaybeAddInsnClass(InsnClass, ComboBitToBitsMap)) {
 890         const State *NewState = NULL;
 891         current->AddInsnClass(InsnClass, ComboBitToBitsMap, NewStateResources);
 892         if (NewStateResources.size() == 0) {
 893           DEBUG(dbgs() << "  Skipped - no new states generated\n");
 894           continue;
 895         }
 896
 897         DEBUG(dbgs() << "\t");
 898         dbgsStateInfo(NewStateResources);
 899         DEBUG(dbgs() << "\n");
 900
 901         //
 902         // If we have seen this state before, then do not create a new state.
 903         //
 904         auto VI = Visited.find(NewStateResources);
 905         if (VI != Visited.end()) {
 906           NewState = VI->second;
 907           DEBUG(dbgs() << "\tFound existing state: "
 908                        << NewState->stateNum << " - ");
 909           dbgsStateInfo(NewState->stateInfo);
 910           DEBUG(dbgs() << "\n");
 911         } else {
 912           NewState = &D.newState();
 913           NewState->stateInfo = NewStateResources;
 914           Visited[NewStateResources] = NewState;
 915           WorkList.push_back(NewState);
 916           DEBUG(dbgs() << "\tAccepted new state: "
 917                        << NewState->stateNum << " - ");
 918           dbgsStateInfo(NewState->stateInfo);
 919           DEBUG(dbgs() << "\n");
 920         }
 921
 922         current->addTransition(InsnClass, NewState);
 923       }
 924     }
 925   }
 926
 927   // Print out the table.
 928   D.writeTableAndAPI(OS, TargetName,
 929                numInsnClasses, maxResources, numCombos, maxStages);
 930 }
 931
 932 namespace llvm {
 933
 934 void EmitDFAPacketizer(RecordKeeper &RK, raw_ostream &OS) {
 935   emitSourceFileHeader("Target DFA Packetizer Tables", OS);
 936   DFAPacketizerEmitter(RK).run(OS);
 937 }
 938
 939 } // End llvm namespace