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 #include "llvm/MC/MCInstrDesc.h"
  19 #include "llvm/MC/MCInstrItineraries.h"
  20 #include "llvm/TableGen/Record.h"
  21 #include "CodeGenTarget.h"
  22 #include "DFAPacketizerEmitter.h"
  23 #include <list>
  24
  25 using namespace llvm;
  26
  27 //
  28 //
  29 // State represents the usage of machine resources if the packet contains
  30 // a set of instruction classes.
  31 //
  32 // Specifically, currentState is a set of bit-masks.
  33 // The nth bit in a bit-mask indicates whether the nth resource is being used
  34 // by this state. The set of bit-masks in a state represent the different
  35 // possible outcomes of transitioning to this state.
  36 // For example: consider a two resource architecture: resource L and resource M
  37 // with three instruction classes: L, M, and L_or_M.
  38 // From the initial state (currentState = 0x00), if we add instruction class
  39 // L_or_M we will transition to a state with currentState = [0x01, 0x10]. This
  40 // represents the possible resource states that can result from adding a L_or_M
  41 // instruction
  42 //
  43 // Another way of thinking about this transition is we are mapping a NDFA with
  44 // two states [0x01] and [0x10] into a DFA with a single state [0x01, 0x10].
  45 //
  46 //
  47 namespace {
  48 class State {
  49  public:
  50   static int currentStateNum;
  51   int stateNum;
  52   bool isInitial;
  53   std::set<unsigned> stateInfo;
  54
  55   State();
  56   State(const State &S);
  57
  58   //
  59   // canAddInsnClass - Returns true if an instruction of type InsnClass is a
  60   // valid transition from this state, i.e., can an instruction of type InsnClass
  61   // be added to the packet represented by this state.
  62   //
  63   // PossibleStates is the set of valid resource states that ensue from valid
  64   // transitions.
  65   //
  66   bool canAddInsnClass(unsigned InsnClass, std::set<unsigned> &PossibleStates);
  67 };
  68 } // End anonymous namespace.
  69
  70
  71 namespace {
  72 struct Transition {
  73  public:
  74   static int currentTransitionNum;
  75   int transitionNum;
  76   State *from;
  77   unsigned input;
  78   State *to;
  79
  80   Transition(State *from_, unsigned input_, State *to_);
  81 };
  82 } // End anonymous namespace.
  83
  84
  85 //
  86 // Comparators to keep set of states sorted.
  87 //
  88 namespace {
  89 struct ltState {
  90   bool operator()(const State *s1, const State *s2) const;
  91 };
  92 } // End anonymous namespace.
  93
  94
  95 //
  96 // class DFA: deterministic finite automaton for processor resource tracking.
  97 //
  98 namespace {
  99 class DFA {
 100 public:
 101   DFA();
 102
 103   // Set of states. Need to keep this sorted to emit the transition table.
 104   std::set<State*, ltState> states;
 105
 106   // Map from a state to the list of transitions with that state as source.
 107   std::map<State*, SmallVector<Transition*, 16>, ltState> stateTransitions;
 108   State *currentState;
 109
 110   // Highest valued Input seen.
 111   unsigned LargestInput;
 112
 113   //
 114   // Modify the DFA.
 115   //
 116   void initialize();
 117   void addState(State *);
 118   void addTransition(Transition *);
 119
 120   //
 121   // getTransition -  Return the state when a transition is made from
 122   // State From with Input I. If a transition is not found, return NULL.
 123   //
 124   State *getTransition(State *, unsigned);
 125
 126   //
 127   // isValidTransition: Predicate that checks if there is a valid transition
 128   // from state From on input InsnClass.
 129   //
 130   bool isValidTransition(State *From, unsigned InsnClass);
 131
 132   //
 133   // writeTable: Print out a table representing the DFA.
 134   //
 135   void writeTableAndAPI(raw_ostream &OS, const std::string &ClassName);
 136 };
 137 } // End anonymous namespace.
 138
 139
 140 //
 141 // Constructors for State, Transition, and DFA
 142 //
 143 State::State() :
 144   stateNum(currentStateNum++), isInitial(false) {}
 145
 146
 147 State::State(const State &S) :
 148   stateNum(currentStateNum++), isInitial(S.isInitial),
 149   stateInfo(S.stateInfo) {}
 150
 151
 152 Transition::Transition(State *from_, unsigned input_, State *to_) :
 153   transitionNum(currentTransitionNum++), from(from_), input(input_),
 154   to(to_) {}
 155
 156
 157 DFA::DFA() :
 158   LargestInput(0) {}
 159
 160
 161 bool ltState::operator()(const State *s1, const State *s2) const {
 162     return (s1->stateNum < s2->stateNum);
 163 }
 164
 165
 166 //
 167 // canAddInsnClass - Returns true if an instruction of type InsnClass is a
 168 // valid transition from this state i.e., can an instruction of type InsnClass
 169 // be added to the packet represented by this state.
 170 //
 171 // PossibleStates is the set of valid resource states that ensue from valid
 172 // transitions.
 173 //
 174 bool State::canAddInsnClass(unsigned InsnClass,
 175                             std::set<unsigned> &PossibleStates) {
 176   //
 177   // Iterate over all resource states in currentState.
 178   //
 179   bool AddedState = false;
 180
 181   for (std::set<unsigned>::iterator SI = stateInfo.begin();
 182        SI != stateInfo.end(); ++SI) {
 183     unsigned thisState = *SI;
 184
 185     //
 186     // Iterate over all possible resources used in InsnClass.
 187     // For ex: for InsnClass = 0x11, all resources = {0x01, 0x10}.
 188     //
 189
 190     DenseSet<unsigned> VisitedResourceStates;
 191     for (unsigned int j = 0; j < sizeof(InsnClass) * 8; ++j) {
 192       if ((0x1 << j) & InsnClass) {
 193         //
 194         // For each possible resource used in InsnClass, generate the
 195         // resource state if that resource was used.
 196         //
 197         unsigned ResultingResourceState = thisState | (0x1 << j);
 198         //
 199         // Check if the resulting resource state can be accommodated in this
 200         // packet.
 201         // We compute ResultingResourceState OR thisState.
 202         // If the result of the OR is different than thisState, it implies
 203         // that there is at least one resource that can be used to schedule
 204         // InsnClass in the current packet.
 205         // Insert ResultingResourceState into PossibleStates only if we haven't
 206         // processed ResultingResourceState before.
 207         //
 208         if ((ResultingResourceState != thisState) &&
 209             (VisitedResourceStates.count(ResultingResourceState) == 0)) {
 210           VisitedResourceStates.insert(ResultingResourceState);
 211           PossibleStates.insert(ResultingResourceState);
 212           AddedState = true;
 213         }
 214       }
 215     }
 216   }
 217
 218   return AddedState;
 219 }
 220
 221
 222 void DFA::initialize() {
 223   currentState->isInitial = true;
 224 }
 225
 226
 227 void DFA::addState(State *S) {
 228   assert(!states.count(S) && "State already exists");
 229   states.insert(S);
 230 }
 231
 232
 233 void DFA::addTransition(Transition *T) {
 234   // Update LargestInput.
 235   if (T->input > LargestInput)
 236     LargestInput = T->input;
 237
 238   // Add the new transition.
 239   stateTransitions[T->from].push_back(T);
 240 }
 241
 242
 243 //
 244 // getTransition - Return the state when a transition is made from
 245 // State From with Input I. If a transition is not found, return NULL.
 246 //
 247 State *DFA::getTransition(State *From, unsigned I) {
 248   // Do we have a transition from state From?
 249   if (!stateTransitions.count(From))
 250     return NULL;
 251
 252   // Do we have a transition from state From with Input I?
 253   for (SmallVector<Transition*, 16>::iterator VI =
 254          stateTransitions[From].begin();
 255          VI != stateTransitions[From].end(); ++VI)
 256     if ((*VI)->input == I)
 257       return (*VI)->to;
 258
 259   return NULL;
 260 }
 261
 262
 263 bool DFA::isValidTransition(State *From, unsigned InsnClass) {
 264   return (getTransition(From, InsnClass) != NULL);
 265 }
 266
 267
 268 int State::currentStateNum = 0;
 269 int Transition::currentTransitionNum = 0;
 270
 271 DFAGen::DFAGen(RecordKeeper &R):
 272   TargetName(CodeGenTarget(R).getName()),
 273   allInsnClasses(), Records(R) {}
 274
 275
 276 //
 277 // writeTableAndAPI - Print out a table representing the DFA and the
 278 // associated API to create a DFA packetizer.
 279 //
 280 // Format:
 281 // DFAStateInputTable[][2] = pairs of <Input, Transition> for all valid
 282 //                           transitions.
 283 // DFAStateEntryTable[i] = Index of the first entry in DFAStateInputTable for
 284 //                         the ith state.
 285 //
 286 //
 287 void DFA::writeTableAndAPI(raw_ostream &OS, const std::string &TargetName) {
 288   std::set<State*, ltState>::iterator SI = states.begin();
 289   // This table provides a map to the beginning of the transitions for State s
 290   // in DFAStateInputTable.
 291   std::vector<int> StateEntry(states.size());
 292
 293   OS << "namespace llvm {\n\n";
 294   OS << "const int " << TargetName << "DFAStateInputTable[][2] = {\n";
 295
 296   // Tracks the total valid transitions encountered so far. It is used
 297   // to construct the StateEntry table.
 298   int ValidTransitions = 0;
 299   for (unsigned i = 0; i < states.size(); ++i, ++SI) {
 300     StateEntry[i] = ValidTransitions;
 301     for (unsigned j = 0; j <= LargestInput; ++j) {
 302       assert (((*SI)->stateNum == (int) i) && "Mismatch in state numbers");
 303       if (!isValidTransition(*SI, j))
 304         continue;
 305
 306       OS << "{" << j << ", "
 307          << getTransition(*SI, j)->stateNum
 308          << "},    ";
 309       ++ValidTransitions;
 310     }
 311
 312     // If there are no valid transitions from this stage, we need a sentinel
 313     // transition.
 314     if (ValidTransitions == StateEntry[i]) {
 315       OS << "{-1, -1},";
 316       ++ValidTransitions;
 317     }
 318
 319     OS << "\n";
 320   }
 321   OS << "};\n\n";
 322   OS << "const unsigned int " << TargetName << "DFAStateEntryTable[] = {\n";
 323
 324   // Multiply i by 2 since each entry in DFAStateInputTable is a set of
 325   // two numbers.
 326   for (unsigned i = 0; i < states.size(); ++i)
 327     OS << StateEntry[i] << ", ";
 328
 329   OS << "\n};\n";
 330   OS << "} // namespace\n";
 331
 332
 333   //
 334   // Emit DFA Packetizer tables if the target is a VLIW machine.
 335   //
 336   std::string SubTargetClassName = TargetName + "GenSubtargetInfo";
 337   OS << "\n" << "#include \"llvm/CodeGen/DFAPacketizer.h\"\n";
 338   OS << "namespace llvm {\n";
 339   OS << "DFAPacketizer *" << SubTargetClassName << "::"
 340      << "createDFAPacketizer(const InstrItineraryData *IID) const {\n"
 341      << "   return new DFAPacketizer(IID, " << TargetName
 342      << "DFAStateInputTable, " << TargetName << "DFAStateEntryTable);\n}\n\n";
 343   OS << "} // End llvm namespace \n";
 344 }
 345
 346
 347 //
 348 // collectAllInsnClasses - Populate allInsnClasses which is a set of units
 349 // used in each stage.
 350 //
 351 void DFAGen::collectAllInsnClasses(const std::string &Name,
 352                                   Record *ItinData,
 353                                   unsigned &NStages,
 354                                   raw_ostream &OS) {
 355   // Collect processor itineraries.
 356   std::vector<Record*> ProcItinList =
 357     Records.getAllDerivedDefinitions("ProcessorItineraries");
 358
 359   // If just no itinerary then don't bother.
 360   if (ProcItinList.size() < 2)
 361     return;
 362   std::map<std::string, unsigned> NameToBitsMap;
 363
 364   // Parse functional units for all the itineraries.
 365   for (unsigned i = 0, N = ProcItinList.size(); i < N; ++i) {
 366     Record *Proc = ProcItinList[i];
 367     std::vector<Record*> FUs = Proc->getValueAsListOfDefs("FU");
 368
 369     // Convert macros to bits for each stage.
 370     for (unsigned i = 0, N = FUs.size(); i < N; ++i)
 371       NameToBitsMap[FUs[i]->getName()] = (unsigned) (1U << i);
 372   }
 373
 374   const std::vector<Record*> &StageList =
 375     ItinData->getValueAsListOfDefs("Stages");
 376
 377   // The number of stages.
 378   NStages = StageList.size();
 379
 380   // For each unit.
 381   unsigned UnitBitValue = 0;
 382
 383   // Compute the bitwise or of each unit used in this stage.
 384   for (unsigned i = 0; i < NStages; ++i) {
 385     const Record *Stage = StageList[i];
 386
 387     // Get unit list.
 388     const std::vector<Record*> &UnitList =
 389       Stage->getValueAsListOfDefs("Units");
 390
 391     for (unsigned j = 0, M = UnitList.size(); j < M; ++j) {
 392       // Conduct bitwise or.
 393       std::string UnitName = UnitList[j]->getName();
 394       assert(NameToBitsMap.count(UnitName));
 395       UnitBitValue |= NameToBitsMap[UnitName];
 396     }
 397
 398     if (UnitBitValue != 0)
 399       allInsnClasses.insert(UnitBitValue);
 400   }
 401 }
 402
 403
 404 //
 405 // Run the worklist algorithm to generate the DFA.
 406 //
 407 void DFAGen::run(raw_ostream &OS) {
 408   EmitSourceFileHeader("Target DFA Packetizer Tables", OS);
 409
 410   // Collect processor iteraries.
 411   std::vector<Record*> ProcItinList =
 412     Records.getAllDerivedDefinitions("ProcessorItineraries");
 413
 414   //
 415   // Collect the instruction classes.
 416   //
 417   for (unsigned i = 0, N = ProcItinList.size(); i < N; i++) {
 418     Record *Proc = ProcItinList[i];
 419
 420     // Get processor itinerary name.
 421     const std::string &Name = Proc->getName();
 422
 423     // Skip default.
 424     if (Name == "NoItineraries")
 425       continue;
 426
 427     // Sanity check for at least one instruction itinerary class.
 428     unsigned NItinClasses =
 429       Records.getAllDerivedDefinitions("InstrItinClass").size();
 430     if (NItinClasses == 0)
 431       return;
 432
 433     // Get itinerary data list.
 434     std::vector<Record*> ItinDataList = Proc->getValueAsListOfDefs("IID");
 435
 436     // Collect instruction classes for all itinerary data.
 437     for (unsigned j = 0, M = ItinDataList.size(); j < M; j++) {
 438       Record *ItinData = ItinDataList[j];
 439       unsigned NStages;
 440       collectAllInsnClasses(Name, ItinData, NStages, OS);
 441     }
 442   }
 443
 444
 445   //
 446   // Run a worklist algorithm to generate the DFA.
 447   //
 448   DFA D;
 449   State *Initial = new State;
 450   Initial->isInitial = true;
 451   Initial->stateInfo.insert(0x0);
 452   D.addState(Initial);
 453   SmallVector<State*, 32> WorkList;
 454   std::map<std::set<unsigned>, State*> Visited;
 455
 456   WorkList.push_back(Initial);
 457
 458   //
 459   // Worklist algorithm to create a DFA for processor resource tracking.
 460   // C = {set of InsnClasses}
 461   // Begin with initial node in worklist. Initial node does not have
 462   // any consumed resources,
 463   //     ResourceState = 0x0
 464   // Visited = {}
 465   // While worklist != empty
 466   //    S = first element of worklist
 467   //    For every instruction class C
 468   //      if we can accommodate C in S:
 469   //          S' = state with resource states = {S Union C}
 470   //          Add a new transition: S x C -> S'
 471   //          If S' is not in Visited:
 472   //             Add S' to worklist
 473   //             Add S' to Visited
 474   //
 475   while (!WorkList.empty()) {
 476     State *current = WorkList.pop_back_val();
 477     for (DenseSet<unsigned>::iterator CI = allInsnClasses.begin(),
 478            CE = allInsnClasses.end(); CI != CE; ++CI) {
 479       unsigned InsnClass = *CI;
 480
 481       std::set<unsigned> NewStateResources;
 482       //
 483       // If we haven't already created a transition for this input
 484       // and the state can accommodate this InsnClass, create a transition.
 485       //
 486       if (!D.getTransition(current, InsnClass) &&
 487           current->canAddInsnClass(InsnClass, NewStateResources)) {
 488         State *NewState = NULL;
 489
 490         //
 491         // If we have seen this state before, then do not create a new state.
 492         //
 493         //
 494         std::map<std::set<unsigned>, State*>::iterator VI;
 495         if ((VI = Visited.find(NewStateResources)) != Visited.end())
 496           NewState = VI->second;
 497         else {
 498           NewState = new State;
 499           NewState->stateInfo = NewStateResources;
 500           D.addState(NewState);
 501           Visited[NewStateResources] = NewState;
 502           WorkList.push_back(NewState);
 503         }
 504
 505         Transition *NewTransition = new Transition(current, InsnClass,
 506                                                    NewState);
 507         D.addTransition(NewTransition);
 508       }
 509     }
 510   }
 511
 512   // Print out the table.
 513   D.writeTableAndAPI(OS, TargetName);
 514 }