utils/TableGen/InstrInfoEmitter.cpp

   1 //===- InstrInfoEmitter.cpp - Generate a Instruction Set Desc. ------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This tablegen backend is responsible for emitting a description of the target
  11 // instruction set for the code generator.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "InstrInfoEmitter.h"
  16 #include "CodeGenTarget.h"
  17 #include "Record.h"
  18 #include <algorithm>
  19 using namespace llvm;
  20
  21 // runEnums - Print out enum values for all of the instructions.
  22 void InstrInfoEmitter::runEnums(std::ostream &OS) {
  23   EmitSourceFileHeader("Target Instruction Enum Values", OS);
  24   OS << "namespace llvm {\n\n";
  25
  26   CodeGenTarget Target;
  27
  28   // We must emit the PHI opcode first...
  29   std::string Namespace;
  30   for (CodeGenTarget::inst_iterator II = Target.inst_begin(),
  31        E = Target.inst_end(); II != E; ++II) {
  32     if (II->second.Namespace != "TargetInstrInfo") {
  33       Namespace = II->second.Namespace;
  34       break;
  35     }
  36   }
  37
  38   if (Namespace.empty()) {
  39     std::cerr << "No instructions defined!\n";
  40     exit(1);
  41   }
  42
  43   std::vector<const CodeGenInstruction*> NumberedInstructions;
  44   Target.getInstructionsByEnumValue(NumberedInstructions);
  45
  46   OS << "namespace " << Namespace << " {\n";
  47   OS << "  enum {\n";
  48   for (unsigned i = 0, e = NumberedInstructions.size(); i != e; ++i) {
  49     OS << "    " << NumberedInstructions[i]->TheDef->getName()
  50        << "\t= " << i << ",\n";
  51   }
  52   OS << "    INSTRUCTION_LIST_END = " << NumberedInstructions.size() << "\n";
  53   OS << "  };\n}\n";
  54   OS << "} // End llvm namespace \n";
  55 }
  56
  57 void InstrInfoEmitter::printDefList(const std::vector<Record*> &Uses,
  58                                     unsigned Num, std::ostream &OS) const {
  59   OS << "static const unsigned ImplicitList" << Num << "[] = { ";
  60   for (unsigned i = 0, e = Uses.size(); i != e; ++i)
  61     OS << getQualifiedName(Uses[i]) << ", ";
  62   OS << "0 };\n";
  63 }
  64
  65 static std::vector<Record*> GetOperandInfo(const CodeGenInstruction &Inst) {
  66   std::vector<Record*> Result;
  67   for (unsigned i = 0, e = Inst.OperandList.size(); i != e; ++i) {
  68     if (Inst.OperandList[i].Rec->isSubClassOf("RegisterClass")) {
  69       Result.push_back(Inst.OperandList[i].Rec);
  70     } else {
  71       // This might be a multiple operand thing.
  72       // Targets like X86 have registers in their multi-operand operands.
  73       DagInit *MIOI = Inst.OperandList[i].MIOperandInfo;
  74       unsigned NumDefs = MIOI->getNumArgs();
  75       for (unsigned j = 0, e = Inst.OperandList[i].MINumOperands; j != e; ++j) {
  76         if (NumDefs <= j) {
  77           Result.push_back(0);
  78         } else {
  79           DefInit *Def = dynamic_cast<DefInit*>(MIOI->getArg(j));
  80           Result.push_back(Def ? Def->getDef() : 0);
  81         }
  82       }
  83     }
  84   }
  85   return Result;
  86 }
  87
  88
  89 // run - Emit the main instruction description records for the target...
  90 void InstrInfoEmitter::run(std::ostream &OS) {
  91   GatherItinClasses();
  92
  93   EmitSourceFileHeader("Target Instruction Descriptors", OS);
  94   OS << "namespace llvm {\n\n";
  95
  96   CodeGenTarget Target;
  97   const std::string &TargetName = Target.getName();
  98   Record *InstrInfo = Target.getInstructionSet();
  99
 100   // Keep track of all of the def lists we have emitted already.
 101   std::map<std::vector<Record*>, unsigned> EmittedLists;
 102   unsigned ListNumber = 0;
 103
 104   // Emit all of the instruction's implicit uses and defs.
 105   for (CodeGenTarget::inst_iterator II = Target.inst_begin(),
 106          E = Target.inst_end(); II != E; ++II) {
 107     Record *Inst = II->second.TheDef;
 108     std::vector<Record*> Uses = Inst->getValueAsListOfDefs("Uses");
 109     if (!Uses.empty()) {
 110       unsigned &IL = EmittedLists[Uses];
 111       if (!IL) printDefList(Uses, IL = ++ListNumber, OS);
 112     }
 113     std::vector<Record*> Defs = Inst->getValueAsListOfDefs("Defs");
 114     if (!Defs.empty()) {
 115       unsigned &IL = EmittedLists[Defs];
 116       if (!IL) printDefList(Defs, IL = ++ListNumber, OS);
 117     }
 118   }
 119
 120   std::map<std::vector<Record*>, unsigned> OperandInfosEmitted;
 121   unsigned OperandListNum = 0;
 122   OperandInfosEmitted[std::vector<Record*>()] = ++OperandListNum;
 123
 124   // Emit all of the operand info records.
 125   OS << "\n";
 126   for (CodeGenTarget::inst_iterator II = Target.inst_begin(),
 127        E = Target.inst_end(); II != E; ++II) {
 128     std::vector<Record*> OperandInfo = GetOperandInfo(II->second);
 129     unsigned &N = OperandInfosEmitted[OperandInfo];
 130     if (N == 0) {
 131       N = ++OperandListNum;
 132       OS << "static const TargetOperandInfo OperandInfo" << N << "[] = { ";
 133       for (unsigned i = 0, e = OperandInfo.size(); i != e; ++i) {
 134         Record *RC = OperandInfo[i];
 135         // FIXME: We only care about register operands for now.
 136         if (RC && RC->isSubClassOf("RegisterClass"))
 137           OS << "{ " << getQualifiedName(RC) << "RegClassID, 0 }, ";
 138         else if (RC && RC->getName() == "ptr_rc")
 139           // Ptr value whose register class is resolved via callback.
 140           OS << "{ 0, 1 }, ";
 141         else
 142           OS << "{ 0, 0 }, ";
 143       }
 144       OS << "};\n";
 145     }
 146   }
 147
 148   // Emit all of the TargetInstrDescriptor records in their ENUM ordering.
 149   //
 150   OS << "\nstatic const TargetInstrDescriptor " << TargetName
 151      << "Insts[] = {\n";
 152   std::vector<const CodeGenInstruction*> NumberedInstructions;
 153   Target.getInstructionsByEnumValue(NumberedInstructions);
 154
 155   for (unsigned i = 0, e = NumberedInstructions.size(); i != e; ++i)
 156     emitRecord(*NumberedInstructions[i], i, InstrInfo, EmittedLists,
 157                OperandInfosEmitted, OS);
 158   OS << "};\n";
 159   OS << "} // End llvm namespace \n";
 160 }
 161
 162 void InstrInfoEmitter::emitRecord(const CodeGenInstruction &Inst, unsigned Num,
 163                                   Record *InstrInfo,
 164                          std::map<std::vector<Record*>, unsigned> &EmittedLists,
 165                                std::map<std::vector<Record*>, unsigned> &OpInfo,
 166                                   std::ostream &OS) {
 167   int MinOperands;
 168   if (!Inst.OperandList.empty())
 169     // Each logical operand can be multiple MI operands.
 170     MinOperands = Inst.OperandList.back().MIOperandNo +
 171                   Inst.OperandList.back().MINumOperands;
 172   else
 173     MinOperands = 0;
 174
 175   OS << "  { \"";
 176   if (Inst.Name.empty())
 177     OS << Inst.TheDef->getName();
 178   else
 179     OS << Inst.Name;
 180
 181   unsigned ItinClass = !IsItineraries ? 0 :
 182             ItinClassNumber(Inst.TheDef->getValueAsDef("Itinerary")->getName());
 183
 184   OS << "\",\t" << MinOperands << ", " << ItinClass
 185      << ", 0";
 186
 187   // Try to determine (from the pattern), if the instruction is a store.
 188   bool isStore = false;
 189   if (dynamic_cast<ListInit*>(Inst.TheDef->getValueInit("Pattern"))) {
 190     ListInit *LI = Inst.TheDef->getValueAsListInit("Pattern");
 191     if (LI && LI->getSize() > 0) {
 192       DagInit *Dag = (DagInit *)LI->getElement(0);
 193       DefInit *OpDef = dynamic_cast<DefInit*>(Dag->getOperator());
 194       if (OpDef) {
 195         Record *Operator = OpDef->getDef();
 196         if (Operator->isSubClassOf("SDNode")) {
 197           const std::string Opcode = Operator->getValueAsString("Opcode");
 198           if (Opcode == "ISD::STORE" || Opcode == "ISD::TRUNCSTORE")
 199             isStore = true;
 200         }
 201       }
 202     }
 203   }
 204
 205   // Emit all of the target indepedent flags...
 206   if (Inst.isReturn)     OS << "|M_RET_FLAG";
 207   if (Inst.isBranch)     OS << "|M_BRANCH_FLAG";
 208   if (Inst.isBarrier)    OS << "|M_BARRIER_FLAG";
 209   if (Inst.hasDelaySlot) OS << "|M_DELAY_SLOT_FLAG";
 210   if (Inst.isCall)       OS << "|M_CALL_FLAG";
 211   if (Inst.isLoad)       OS << "|M_LOAD_FLAG";
 212   if (Inst.isStore || isStore) OS << "|M_STORE_FLAG";
 213   if (Inst.isTwoAddress) OS << "|M_2_ADDR_FLAG";
 214   if (Inst.isConvertibleToThreeAddress) OS << "|M_CONVERTIBLE_TO_3_ADDR";
 215   if (Inst.isCommutable) OS << "|M_COMMUTABLE";
 216   if (Inst.isTerminator) OS << "|M_TERMINATOR_FLAG";
 217   if (Inst.usesCustomDAGSchedInserter)
 218     OS << "|M_USES_CUSTOM_DAG_SCHED_INSERTION";
 219   if (Inst.hasVariableNumberOfOperands)
 220     OS << "|M_VARIABLE_OPS";
 221   OS << ", 0";
 222
 223   // Emit all of the target-specific flags...
 224   ListInit *LI    = InstrInfo->getValueAsListInit("TSFlagsFields");
 225   ListInit *Shift = InstrInfo->getValueAsListInit("TSFlagsShifts");
 226   if (LI->getSize() != Shift->getSize())
 227     throw "Lengths of " + InstrInfo->getName() +
 228           ":(TargetInfoFields, TargetInfoPositions) must be equal!";
 229
 230   for (unsigned i = 0, e = LI->getSize(); i != e; ++i)
 231     emitShiftedValue(Inst.TheDef, dynamic_cast<StringInit*>(LI->getElement(i)),
 232                      dynamic_cast<IntInit*>(Shift->getElement(i)), OS);
 233
 234   OS << ", ";
 235
 236   // Emit the implicit uses and defs lists...
 237   std::vector<Record*> UseList = Inst.TheDef->getValueAsListOfDefs("Uses");
 238   if (UseList.empty())
 239     OS << "NULL, ";
 240   else
 241     OS << "ImplicitList" << EmittedLists[UseList] << ", ";
 242
 243   std::vector<Record*> DefList = Inst.TheDef->getValueAsListOfDefs("Defs");
 244   if (DefList.empty())
 245     OS << "NULL, ";
 246   else
 247     OS << "ImplicitList" << EmittedLists[DefList] << ", ";
 248
 249   // Emit the operand info.
 250   std::vector<Record*> OperandInfo = GetOperandInfo(Inst);
 251   if (OperandInfo.empty())
 252     OS << "0";
 253   else
 254     OS << "OperandInfo" << OpInfo[OperandInfo];
 255
 256   OS << " },  // Inst #" << Num << " = " << Inst.TheDef->getName() << "\n";
 257 }
 258
 259 struct LessRecord {
 260   bool operator()(const Record *Rec1, const Record *Rec2) const {
 261     return Rec1->getName() < Rec2->getName();
 262   }
 263 };
 264 void InstrInfoEmitter::GatherItinClasses() {
 265   std::vector<Record*> DefList =
 266                           Records.getAllDerivedDefinitions("InstrItinClass");
 267   IsItineraries = !DefList.empty();
 268
 269   if (!IsItineraries) return;
 270
 271   std::sort(DefList.begin(), DefList.end(), LessRecord());
 272
 273   for (unsigned i = 0, N = DefList.size(); i < N; i++) {
 274     Record *Def = DefList[i];
 275     ItinClassMap[Def->getName()] = i;
 276   }
 277 }
 278
 279 unsigned InstrInfoEmitter::ItinClassNumber(std::string ItinName) {
 280   return ItinClassMap[ItinName];
 281 }
 282
 283 void InstrInfoEmitter::emitShiftedValue(Record *R, StringInit *Val,
 284                                         IntInit *ShiftInt, std::ostream &OS) {
 285   if (Val == 0 || ShiftInt == 0)
 286     throw std::string("Illegal value or shift amount in TargetInfo*!");
 287   RecordVal *RV = R->getValue(Val->getValue());
 288   int Shift = ShiftInt->getValue();
 289
 290   if (RV == 0 || RV->getValue() == 0) {
 291     // This isn't an error if this is a builtin instruction.
 292     if (R->getName() != "PHI" && R->getName() != "INLINEASM")
 293       throw R->getName() + " doesn't have a field named '" +
 294             Val->getValue() + "'!";
 295     return;
 296   }
 297
 298   Init *Value = RV->getValue();
 299   if (BitInit *BI = dynamic_cast<BitInit*>(Value)) {
 300     if (BI->getValue()) OS << "|(1<<" << Shift << ")";
 301     return;
 302   } else if (BitsInit *BI = dynamic_cast<BitsInit*>(Value)) {
 303     // Convert the Bits to an integer to print...
 304     Init *I = BI->convertInitializerTo(new IntRecTy());
 305     if (I)
 306       if (IntInit *II = dynamic_cast<IntInit*>(I)) {
 307         if (II->getValue()) {
 308           if (Shift)
 309             OS << "|(" << II->getValue() << "<<" << Shift << ")";
 310           else
 311             OS << "|" << II->getValue();
 312         }
 313         return;
 314       }
 315
 316   } else if (IntInit *II = dynamic_cast<IntInit*>(Value)) {
 317     if (II->getValue()) {
 318       if (Shift)
 319         OS << "|(" << II->getValue() << "<<" << Shift << ")";
 320       else
 321         OS << II->getValue();
 322     }
 323     return;
 324   }
 325
 326   std::cerr << "Unhandled initializer: " << *Val << "\n";
 327   throw "In record '" + R->getName() + "' for TSFlag emission.";
 328 }
 329