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