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