utils/TableGen/CodeGenTarget.cpp

   1 //===- CodeGenTarget.cpp - CodeGen Target Class Wrapper -------------------===//
   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 wraps target description classes used by the various code
  11 // generation TableGen backends.  This makes it easier to access the data and
  12 // provides a single place that needs to check it for validity.  All of these
  13 // classes throw exceptions on error conditions.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "CodeGenTarget.h"
  18 #include "CodeGenIntrinsics.h"
  19 #include "Record.h"
  20 #include "llvm/ADT/StringExtras.h"
  21 #include "llvm/Support/CommandLine.h"
  22 #include "llvm/Support/Streams.h"
  23 #include <algorithm>
  24 using namespace llvm;
  25
  26 static cl::opt<unsigned>
  27 AsmWriterNum("asmwriternum", cl::init(0),
  28              cl::desc("Make -gen-asm-writer emit assembly writer #N"));
  29
  30 /// getValueType - Return the MVT::SimpleValueType that the specified TableGen
  31 /// record corresponds to.
  32 MVT::SimpleValueType llvm::getValueType(Record *Rec) {
  33   return (MVT::SimpleValueType)Rec->getValueAsInt("Value");
  34 }
  35
  36 std::string llvm::getName(MVT::SimpleValueType T) {
  37   switch (T) {
  38   case MVT::Other: return "UNKNOWN";
  39   case MVT::i1:    return "MVT::i1";
  40   case MVT::i8:    return "MVT::i8";
  41   case MVT::i16:   return "MVT::i16";
  42   case MVT::i32:   return "MVT::i32";
  43   case MVT::i64:   return "MVT::i64";
  44   case MVT::i128:  return "MVT::i128";
  45   case MVT::iAny:  return "MVT::iAny";
  46   case MVT::fAny:  return "MVT::fAny";
  47   case MVT::f32:   return "MVT::f32";
  48   case MVT::f64:   return "MVT::f64";
  49   case MVT::f80:   return "MVT::f80";
  50   case MVT::f128:  return "MVT::f128";
  51   case MVT::ppcf128:  return "MVT::ppcf128";
  52   case MVT::Flag:  return "MVT::Flag";
  53   case MVT::isVoid:return "MVT::void";
  54   case MVT::v8i8:  return "MVT::v8i8";
  55   case MVT::v4i16: return "MVT::v4i16";
  56   case MVT::v2i32: return "MVT::v2i32";
  57   case MVT::v1i64: return "MVT::v1i64";
  58   case MVT::v16i8: return "MVT::v16i8";
  59   case MVT::v8i16: return "MVT::v8i16";
  60   case MVT::v4i32: return "MVT::v4i32";
  61   case MVT::v2i64: return "MVT::v2i64";
  62   case MVT::v2f32: return "MVT::v2f32";
  63   case MVT::v4f32: return "MVT::v4f32";
  64   case MVT::v2f64: return "MVT::v2f64";
  65   case MVT::v3i32: return "MVT::v3i32";
  66   case MVT::v3f32: return "MVT::v3f32";
  67   case MVT::iPTR:  return "TLI.getPointerTy()";
  68   default: assert(0 && "ILLEGAL VALUE TYPE!"); return "";
  69   }
  70 }
  71
  72 std::string llvm::getEnumName(MVT::SimpleValueType T) {
  73   switch (T) {
  74   case MVT::Other: return "MVT::Other";
  75   case MVT::i1:    return "MVT::i1";
  76   case MVT::i8:    return "MVT::i8";
  77   case MVT::i16:   return "MVT::i16";
  78   case MVT::i32:   return "MVT::i32";
  79   case MVT::i64:   return "MVT::i64";
  80   case MVT::i128:  return "MVT::i128";
  81   case MVT::iAny:  return "MVT::iAny";
  82   case MVT::fAny:  return "MVT::fAny";
  83   case MVT::f32:   return "MVT::f32";
  84   case MVT::f64:   return "MVT::f64";
  85   case MVT::f80:   return "MVT::f80";
  86   case MVT::f128:  return "MVT::f128";
  87   case MVT::ppcf128:  return "MVT::ppcf128";
  88   case MVT::Flag:  return "MVT::Flag";
  89   case MVT::isVoid:return "MVT::isVoid";
  90   case MVT::v8i8:  return "MVT::v8i8";
  91   case MVT::v4i16: return "MVT::v4i16";
  92   case MVT::v2i32: return "MVT::v2i32";
  93   case MVT::v1i64: return "MVT::v1i64";
  94   case MVT::v16i8: return "MVT::v16i8";
  95   case MVT::v8i16: return "MVT::v8i16";
  96   case MVT::v4i32: return "MVT::v4i32";
  97   case MVT::v2i64: return "MVT::v2i64";
  98   case MVT::v2f32: return "MVT::v2f32";
  99   case MVT::v4f32: return "MVT::v4f32";
 100   case MVT::v2f64: return "MVT::v2f64";
 101   case MVT::v3i32: return "MVT::v3i32";
 102   case MVT::v3f32: return "MVT::v3f32";
 103   case MVT::iPTR:  return "MVT::iPTR";
 104   default: assert(0 && "ILLEGAL VALUE TYPE!"); return "";
 105   }
 106 }
 107
 108 /// getQualifiedName - Return the name of the specified record, with a
 109 /// namespace qualifier if the record contains one.
 110 ///
 111 std::string llvm::getQualifiedName(const Record *R) {
 112   std::string Namespace = R->getValueAsString("Namespace");
 113   if (Namespace.empty()) return R->getName();
 114   return Namespace + "::" + R->getName();
 115 }
 116
 117
 118
 119
 120 /// getTarget - Return the current instance of the Target class.
 121 ///
 122 CodeGenTarget::CodeGenTarget() {
 123   std::vector<Record*> Targets = Records.getAllDerivedDefinitions("Target");
 124   if (Targets.size() == 0)
 125     throw std::string("ERROR: No 'Target' subclasses defined!");
 126   if (Targets.size() != 1)
 127     throw std::string("ERROR: Multiple subclasses of Target defined!");
 128   TargetRec = Targets[0];
 129 }
 130
 131
 132 const std::string &CodeGenTarget::getName() const {
 133   return TargetRec->getName();
 134 }
 135
 136 Record *CodeGenTarget::getInstructionSet() const {
 137   return TargetRec->getValueAsDef("InstructionSet");
 138 }
 139
 140 /// getAsmWriter - Return the AssemblyWriter definition for this target.
 141 ///
 142 Record *CodeGenTarget::getAsmWriter() const {
 143   std::vector<Record*> LI = TargetRec->getValueAsListOfDefs("AssemblyWriters");
 144   if (AsmWriterNum >= LI.size())
 145     throw "Target does not have an AsmWriter #" + utostr(AsmWriterNum) + "!";
 146   return LI[AsmWriterNum];
 147 }
 148
 149 void CodeGenTarget::ReadRegisters() const {
 150   std::vector<Record*> Regs = Records.getAllDerivedDefinitions("Register");
 151   if (Regs.empty())
 152     throw std::string("No 'Register' subclasses defined!");
 153
 154   Registers.reserve(Regs.size());
 155   Registers.assign(Regs.begin(), Regs.end());
 156 }
 157
 158 CodeGenRegister::CodeGenRegister(Record *R) : TheDef(R) {
 159   DeclaredSpillSize = R->getValueAsInt("SpillSize");
 160   DeclaredSpillAlignment = R->getValueAsInt("SpillAlignment");
 161 }
 162
 163 const std::string &CodeGenRegister::getName() const {
 164   return TheDef->getName();
 165 }
 166
 167 void CodeGenTarget::ReadRegisterClasses() const {
 168   std::vector<Record*> RegClasses =
 169     Records.getAllDerivedDefinitions("RegisterClass");
 170   if (RegClasses.empty())
 171     throw std::string("No 'RegisterClass' subclasses defined!");
 172
 173   RegisterClasses.reserve(RegClasses.size());
 174   RegisterClasses.assign(RegClasses.begin(), RegClasses.end());
 175 }
 176
 177 std::vector<unsigned char> CodeGenTarget::getRegisterVTs(Record *R) const {
 178   std::vector<unsigned char> Result;
 179   const std::vector<CodeGenRegisterClass> &RCs = getRegisterClasses();
 180   for (unsigned i = 0, e = RCs.size(); i != e; ++i) {
 181     const CodeGenRegisterClass &RC = RegisterClasses[i];
 182     for (unsigned ei = 0, ee = RC.Elements.size(); ei != ee; ++ei) {
 183       if (R == RC.Elements[ei]) {
 184         const std::vector<MVT::SimpleValueType> &InVTs = RC.getValueTypes();
 185         for (unsigned i = 0, e = InVTs.size(); i != e; ++i)
 186           Result.push_back(InVTs[i]);
 187       }
 188     }
 189   }
 190   return Result;
 191 }
 192
 193
 194 CodeGenRegisterClass::CodeGenRegisterClass(Record *R) : TheDef(R) {
 195   // Rename anonymous register classes.
 196   if (R->getName().size() > 9 && R->getName()[9] == '.') {
 197     static unsigned AnonCounter = 0;
 198     R->setName("AnonRegClass_"+utostr(AnonCounter++));
 199   }
 200
 201   std::vector<Record*> TypeList = R->getValueAsListOfDefs("RegTypes");
 202   for (unsigned i = 0, e = TypeList.size(); i != e; ++i) {
 203     Record *Type = TypeList[i];
 204     if (!Type->isSubClassOf("ValueType"))
 205       throw "RegTypes list member '" + Type->getName() +
 206         "' does not derive from the ValueType class!";
 207     VTs.push_back(getValueType(Type));
 208   }
 209   assert(!VTs.empty() && "RegisterClass must contain at least one ValueType!");
 210
 211   std::vector<Record*> RegList = R->getValueAsListOfDefs("MemberList");
 212   for (unsigned i = 0, e = RegList.size(); i != e; ++i) {
 213     Record *Reg = RegList[i];
 214     if (!Reg->isSubClassOf("Register"))
 215       throw "Register Class member '" + Reg->getName() +
 216             "' does not derive from the Register class!";
 217     Elements.push_back(Reg);
 218   }
 219
 220   std::vector<Record*> SubRegClassList =
 221                         R->getValueAsListOfDefs("SubRegClassList");
 222   for (unsigned i = 0, e = SubRegClassList.size(); i != e; ++i) {
 223     Record *SubRegClass = SubRegClassList[i];
 224     if (!SubRegClass->isSubClassOf("RegisterClass"))
 225       throw "Register Class member '" + SubRegClass->getName() +
 226             "' does not derive from the RegisterClass class!";
 227     SubRegClasses.push_back(SubRegClass);
 228   }
 229
 230   // Allow targets to override the size in bits of the RegisterClass.
 231   unsigned Size = R->getValueAsInt("Size");
 232
 233   Namespace = R->getValueAsString("Namespace");
 234   SpillSize = Size ? Size : MVT(VTs[0]).getSizeInBits();
 235   SpillAlignment = R->getValueAsInt("Alignment");
 236   CopyCost = R->getValueAsInt("CopyCost");
 237   MethodBodies = R->getValueAsCode("MethodBodies");
 238   MethodProtos = R->getValueAsCode("MethodProtos");
 239 }
 240
 241 const std::string &CodeGenRegisterClass::getName() const {
 242   return TheDef->getName();
 243 }
 244
 245 void CodeGenTarget::ReadLegalValueTypes() const {
 246   const std::vector<CodeGenRegisterClass> &RCs = getRegisterClasses();
 247   for (unsigned i = 0, e = RCs.size(); i != e; ++i)
 248     for (unsigned ri = 0, re = RCs[i].VTs.size(); ri != re; ++ri)
 249       LegalValueTypes.push_back(RCs[i].VTs[ri]);
 250
 251   // Remove duplicates.
 252   std::sort(LegalValueTypes.begin(), LegalValueTypes.end());
 253   LegalValueTypes.erase(std::unique(LegalValueTypes.begin(),
 254                                     LegalValueTypes.end()),
 255                         LegalValueTypes.end());
 256 }
 257
 258
 259 void CodeGenTarget::ReadInstructions() const {
 260   std::vector<Record*> Insts = Records.getAllDerivedDefinitions("Instruction");
 261   if (Insts.size() <= 2)
 262     throw std::string("No 'Instruction' subclasses defined!");
 263
 264   // Parse the instructions defined in the .td file.
 265   std::string InstFormatName =
 266     getAsmWriter()->getValueAsString("InstFormatName");
 267
 268   for (unsigned i = 0, e = Insts.size(); i != e; ++i) {
 269     std::string AsmStr = Insts[i]->getValueAsString(InstFormatName);
 270     Instructions.insert(std::make_pair(Insts[i]->getName(),
 271                                        CodeGenInstruction(Insts[i], AsmStr)));
 272   }
 273 }
 274
 275 /// getInstructionsByEnumValue - Return all of the instructions defined by the
 276 /// target, ordered by their enum value.
 277 void CodeGenTarget::
 278 getInstructionsByEnumValue(std::vector<const CodeGenInstruction*>
 279                                                  &NumberedInstructions) {
 280   std::map<std::string, CodeGenInstruction>::const_iterator I;
 281   I = getInstructions().find("PHI");
 282   if (I == Instructions.end()) throw "Could not find 'PHI' instruction!";
 283   const CodeGenInstruction *PHI = &I->second;
 284
 285   I = getInstructions().find("INLINEASM");
 286   if (I == Instructions.end()) throw "Could not find 'INLINEASM' instruction!";
 287   const CodeGenInstruction *INLINEASM = &I->second;
 288
 289   I = getInstructions().find("LABEL");
 290   if (I == Instructions.end()) throw "Could not find 'LABEL' instruction!";
 291   const CodeGenInstruction *LABEL = &I->second;
 292
 293   I = getInstructions().find("DECLARE");
 294   if (I == Instructions.end()) throw "Could not find 'DECLARE' instruction!";
 295   const CodeGenInstruction *DECLARE = &I->second;
 296
 297   I = getInstructions().find("EXTRACT_SUBREG");
 298   if (I == Instructions.end())
 299     throw "Could not find 'EXTRACT_SUBREG' instruction!";
 300   const CodeGenInstruction *EXTRACT_SUBREG = &I->second;
 301
 302   I = getInstructions().find("INSERT_SUBREG");
 303   if (I == Instructions.end())
 304     throw "Could not find 'INSERT_SUBREG' instruction!";
 305   const CodeGenInstruction *INSERT_SUBREG = &I->second;
 306
 307   I = getInstructions().find("IMPLICIT_DEF");
 308   if (I == Instructions.end())
 309     throw "Could not find 'IMPLICIT_DEF' instruction!";
 310   const CodeGenInstruction *IMPLICIT_DEF = &I->second;
 311
 312   I = getInstructions().find("SUBREG_TO_REG");
 313   if (I == Instructions.end())
 314     throw "Could not find 'SUBREG_TO_REG' instruction!";
 315   const CodeGenInstruction *SUBREG_TO_REG = &I->second;
 316
 317   // Print out the rest of the instructions now.
 318   NumberedInstructions.push_back(PHI);
 319   NumberedInstructions.push_back(INLINEASM);
 320   NumberedInstructions.push_back(LABEL);
 321   NumberedInstructions.push_back(DECLARE);
 322   NumberedInstructions.push_back(EXTRACT_SUBREG);
 323   NumberedInstructions.push_back(INSERT_SUBREG);
 324   NumberedInstructions.push_back(IMPLICIT_DEF);
 325   NumberedInstructions.push_back(SUBREG_TO_REG);
 326   for (inst_iterator II = inst_begin(), E = inst_end(); II != E; ++II)
 327     if (&II->second != PHI &&
 328         &II->second != INLINEASM &&
 329         &II->second != LABEL &&
 330         &II->second != DECLARE &&
 331         &II->second != EXTRACT_SUBREG &&
 332         &II->second != INSERT_SUBREG &&
 333         &II->second != IMPLICIT_DEF &&
 334         &II->second != SUBREG_TO_REG)
 335       NumberedInstructions.push_back(&II->second);
 336 }
 337
 338
 339 /// isLittleEndianEncoding - Return whether this target encodes its instruction
 340 /// in little-endian format, i.e. bits laid out in the order [0..n]
 341 ///
 342 bool CodeGenTarget::isLittleEndianEncoding() const {
 343   return getInstructionSet()->getValueAsBit("isLittleEndianEncoding");
 344 }
 345
 346 //===----------------------------------------------------------------------===//
 347 // ComplexPattern implementation
 348 //
 349 ComplexPattern::ComplexPattern(Record *R) {
 350   Ty          = ::getValueType(R->getValueAsDef("Ty"));
 351   NumOperands = R->getValueAsInt("NumOperands");
 352   SelectFunc  = R->getValueAsString("SelectFunc");
 353   RootNodes   = R->getValueAsListOfDefs("RootNodes");
 354
 355   // Parse the properties.
 356   Properties = 0;
 357   std::vector<Record*> PropList = R->getValueAsListOfDefs("Properties");
 358   for (unsigned i = 0, e = PropList.size(); i != e; ++i)
 359     if (PropList[i]->getName() == "SDNPHasChain") {
 360       Properties |= 1 << SDNPHasChain;
 361     } else if (PropList[i]->getName() == "SDNPOptInFlag") {
 362       Properties |= 1 << SDNPOptInFlag;
 363     } else if (PropList[i]->getName() == "SDNPMayStore") {
 364       Properties |= 1 << SDNPMayStore;
 365     } else if (PropList[i]->getName() == "SDNPMayLoad") {
 366       Properties |= 1 << SDNPMayLoad;
 367     } else if (PropList[i]->getName() == "SDNPSideEffect") {
 368       Properties |= 1 << SDNPSideEffect;
 369     } else if (PropList[i]->getName() == "SDNPMemOperand") {
 370       Properties |= 1 << SDNPMemOperand;
 371     } else {
 372       cerr << "Unsupported SD Node property '" << PropList[i]->getName()
 373            << "' on ComplexPattern '" << R->getName() << "'!\n";
 374       exit(1);
 375     }
 376
 377   // Parse the attributes.
 378   Attributes = 0;
 379   PropList = R->getValueAsListOfDefs("Attributes");
 380   for (unsigned i = 0, e = PropList.size(); i != e; ++i)
 381     if (PropList[i]->getName() == "CPAttrParentAsRoot") {
 382       Attributes |= 1 << CPAttrParentAsRoot;
 383     } else {
 384       cerr << "Unsupported pattern attribute '" << PropList[i]->getName()
 385            << "' on ComplexPattern '" << R->getName() << "'!\n";
 386       exit(1);
 387     }
 388 }
 389
 390 //===----------------------------------------------------------------------===//
 391 // CodeGenIntrinsic Implementation
 392 //===----------------------------------------------------------------------===//
 393
 394 std::vector<CodeGenIntrinsic> llvm::LoadIntrinsics(const RecordKeeper &RC) {
 395   std::vector<Record*> I = RC.getAllDerivedDefinitions("Intrinsic");
 396
 397   std::vector<CodeGenIntrinsic> Result;
 398
 399   for (unsigned i = 0, e = I.size(); i != e; ++i)
 400     Result.push_back(CodeGenIntrinsic(I[i]));
 401   return Result;
 402 }
 403
 404 CodeGenIntrinsic::CodeGenIntrinsic(Record *R) {
 405   TheDef = R;
 406   std::string DefName = R->getName();
 407   ModRef = WriteMem;
 408   isOverloaded = false;
 409   isCommutative = false;
 410
 411   if (DefName.size() <= 4 ||
 412       std::string(DefName.begin(), DefName.begin()+4) != "int_")
 413     throw "Intrinsic '" + DefName + "' does not start with 'int_'!";
 414   EnumName = std::string(DefName.begin()+4, DefName.end());
 415   if (R->getValue("GCCBuiltinName"))  // Ignore a missing GCCBuiltinName field.
 416     GCCBuiltinName = R->getValueAsString("GCCBuiltinName");
 417   TargetPrefix   = R->getValueAsString("TargetPrefix");
 418   Name = R->getValueAsString("LLVMName");
 419   if (Name == "") {
 420     // If an explicit name isn't specified, derive one from the DefName.
 421     Name = "llvm.";
 422     for (unsigned i = 0, e = EnumName.size(); i != e; ++i)
 423       if (EnumName[i] == '_')
 424         Name += '.';
 425       else
 426         Name += EnumName[i];
 427   } else {
 428     // Verify it starts with "llvm.".
 429     if (Name.size() <= 5 ||
 430         std::string(Name.begin(), Name.begin()+5) != "llvm.")
 431       throw "Intrinsic '" + DefName + "'s name does not start with 'llvm.'!";
 432   }
 433
 434   // If TargetPrefix is specified, make sure that Name starts with
 435   // "llvm.<targetprefix>.".
 436   if (!TargetPrefix.empty()) {
 437     if (Name.size() < 6+TargetPrefix.size() ||
 438         std::string(Name.begin()+5, Name.begin()+6+TargetPrefix.size())
 439         != (TargetPrefix+"."))
 440       throw "Intrinsic '" + DefName + "' does not start with 'llvm." +
 441         TargetPrefix + ".'!";
 442   }
 443
 444   // Parse the list of argument types.
 445   ListInit *TypeList = R->getValueAsListInit("Types");
 446   for (unsigned i = 0, e = TypeList->getSize(); i != e; ++i) {
 447     Record *TyEl = TypeList->getElementAsRecord(i);
 448     assert(TyEl->isSubClassOf("LLVMType") && "Expected a type!");
 449     MVT::SimpleValueType VT = getValueType(TyEl->getValueAsDef("VT"));
 450     isOverloaded |= VT == MVT::iAny || VT == MVT::fAny;
 451     ArgVTs.push_back(VT);
 452     ArgTypeDefs.push_back(TyEl);
 453   }
 454   if (ArgVTs.size() == 0)
 455     throw "Intrinsic '"+DefName+"' needs at least a type for the ret value!";
 456
 457
 458   // Parse the intrinsic properties.
 459   ListInit *PropList = R->getValueAsListInit("Properties");
 460   for (unsigned i = 0, e = PropList->getSize(); i != e; ++i) {
 461     Record *Property = PropList->getElementAsRecord(i);
 462     assert(Property->isSubClassOf("IntrinsicProperty") &&
 463            "Expected a property!");
 464
 465     if (Property->getName() == "IntrNoMem")
 466       ModRef = NoMem;
 467     else if (Property->getName() == "IntrReadArgMem")
 468       ModRef = ReadArgMem;
 469     else if (Property->getName() == "IntrReadMem")
 470       ModRef = ReadMem;
 471     else if (Property->getName() == "IntrWriteArgMem")
 472       ModRef = WriteArgMem;
 473     else if (Property->getName() == "IntrWriteMem")
 474       ModRef = WriteMem;
 475     else if (Property->getName() == "Commutative")
 476       isCommutative = true;
 477     else
 478       assert(0 && "Unknown property!");
 479   }
 480 }