1 //===- CodeGenTarget.cpp - CodeGen Target Class Wrapper -------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
15 //===----------------------------------------------------------------------===//
17 #include "CodeGenTarget.h"
18 #include "CodeGenIntrinsics.h"
20 #include "llvm/ADT/StringExtras.h"
21 #include "llvm/ADT/STLExtras.h"
22 #include "llvm/Support/CommandLine.h"
26 static cl::opt<unsigned>
27 AsmParserNum("asmparsernum", cl::init(0),
28 cl::desc("Make -gen-asm-parser emit assembly parser #N"));
30 static cl::opt<unsigned>
31 AsmWriterNum("asmwriternum", cl::init(0),
32 cl::desc("Make -gen-asm-writer emit assembly writer #N"));
34 /// getValueType - Return the MVT::SimpleValueType that the specified TableGen
35 /// record corresponds to.
36 MVT::SimpleValueType llvm::getValueType(Record *Rec) {
37 return (MVT::SimpleValueType)Rec->getValueAsInt("Value");
40 std::string llvm::getName(MVT::SimpleValueType T) {
42 case MVT::Other: return "UNKNOWN";
43 case MVT::iPTR: return "TLI.getPointerTy()";
44 case MVT::iPTRAny: return "TLI.getPointerTy()";
45 default: return getEnumName(T);
49 std::string llvm::getEnumName(MVT::SimpleValueType T) {
51 case MVT::Other: return "MVT::Other";
52 case MVT::i1: return "MVT::i1";
53 case MVT::i8: return "MVT::i8";
54 case MVT::i16: return "MVT::i16";
55 case MVT::i32: return "MVT::i32";
56 case MVT::i64: return "MVT::i64";
57 case MVT::i128: return "MVT::i128";
58 case MVT::iAny: return "MVT::iAny";
59 case MVT::fAny: return "MVT::fAny";
60 case MVT::vAny: return "MVT::vAny";
61 case MVT::f32: return "MVT::f32";
62 case MVT::f64: return "MVT::f64";
63 case MVT::f80: return "MVT::f80";
64 case MVT::f128: return "MVT::f128";
65 case MVT::ppcf128: return "MVT::ppcf128";
66 case MVT::x86mmx: return "MVT::x86mmx";
67 case MVT::Flag: return "MVT::Flag";
68 case MVT::isVoid: return "MVT::isVoid";
69 case MVT::v2i8: return "MVT::v2i8";
70 case MVT::v4i8: return "MVT::v4i8";
71 case MVT::v8i8: return "MVT::v8i8";
72 case MVT::v16i8: return "MVT::v16i8";
73 case MVT::v32i8: return "MVT::v32i8";
74 case MVT::v2i16: return "MVT::v2i16";
75 case MVT::v4i16: return "MVT::v4i16";
76 case MVT::v8i16: return "MVT::v8i16";
77 case MVT::v16i16: return "MVT::v16i16";
78 case MVT::v2i32: return "MVT::v2i32";
79 case MVT::v4i32: return "MVT::v4i32";
80 case MVT::v8i32: return "MVT::v8i32";
81 case MVT::v1i64: return "MVT::v1i64";
82 case MVT::v2i64: return "MVT::v2i64";
83 case MVT::v4i64: return "MVT::v4i64";
84 case MVT::v8i64: return "MVT::v8i64";
85 case MVT::v2f32: return "MVT::v2f32";
86 case MVT::v4f32: return "MVT::v4f32";
87 case MVT::v8f32: return "MVT::v8f32";
88 case MVT::v2f64: return "MVT::v2f64";
89 case MVT::v4f64: return "MVT::v4f64";
90 case MVT::Metadata: return "MVT::Metadata";
91 case MVT::iPTR: return "MVT::iPTR";
92 case MVT::iPTRAny: return "MVT::iPTRAny";
93 default: assert(0 && "ILLEGAL VALUE TYPE!"); return "";
97 /// getQualifiedName - Return the name of the specified record, with a
98 /// namespace qualifier if the record contains one.
100 std::string llvm::getQualifiedName(const Record *R) {
101 std::string Namespace = R->getValueAsString("Namespace");
102 if (Namespace.empty()) return R->getName();
103 return Namespace + "::" + R->getName();
109 /// getTarget - Return the current instance of the Target class.
111 CodeGenTarget::CodeGenTarget() {
112 std::vector<Record*> Targets = Records.getAllDerivedDefinitions("Target");
113 if (Targets.size() == 0)
114 throw std::string("ERROR: No 'Target' subclasses defined!");
115 if (Targets.size() != 1)
116 throw std::string("ERROR: Multiple subclasses of Target defined!");
117 TargetRec = Targets[0];
121 const std::string &CodeGenTarget::getName() const {
122 return TargetRec->getName();
125 std::string CodeGenTarget::getInstNamespace() const {
126 for (inst_iterator i = inst_begin(), e = inst_end(); i != e; ++i) {
127 // Make sure not to pick up "TargetOpcode" by accidentally getting
128 // the namespace off the PHI instruction or something.
129 if ((*i)->Namespace != "TargetOpcode")
130 return (*i)->Namespace;
136 Record *CodeGenTarget::getInstructionSet() const {
137 return TargetRec->getValueAsDef("InstructionSet");
141 /// getAsmParser - Return the AssemblyParser definition for this target.
143 Record *CodeGenTarget::getAsmParser() const {
144 std::vector<Record*> LI = TargetRec->getValueAsListOfDefs("AssemblyParsers");
145 if (AsmParserNum >= LI.size())
146 throw "Target does not have an AsmParser #" + utostr(AsmParserNum) + "!";
147 return LI[AsmParserNum];
150 /// getAsmWriter - Return the AssemblyWriter definition for this target.
152 Record *CodeGenTarget::getAsmWriter() const {
153 std::vector<Record*> LI = TargetRec->getValueAsListOfDefs("AssemblyWriters");
154 if (AsmWriterNum >= LI.size())
155 throw "Target does not have an AsmWriter #" + utostr(AsmWriterNum) + "!";
156 return LI[AsmWriterNum];
159 void CodeGenTarget::ReadRegisters() const {
160 std::vector<Record*> Regs = Records.getAllDerivedDefinitions("Register");
162 throw std::string("No 'Register' subclasses defined!");
163 std::sort(Regs.begin(), Regs.end(), LessRecord());
165 Registers.reserve(Regs.size());
166 Registers.assign(Regs.begin(), Regs.end());
169 CodeGenRegister::CodeGenRegister(Record *R) : TheDef(R) {
170 DeclaredSpillSize = R->getValueAsInt("SpillSize");
171 DeclaredSpillAlignment = R->getValueAsInt("SpillAlignment");
174 const std::string &CodeGenRegister::getName() const {
175 return TheDef->getName();
178 void CodeGenTarget::ReadSubRegIndices() const {
179 SubRegIndices = Records.getAllDerivedDefinitions("SubRegIndex");
180 std::sort(SubRegIndices.begin(), SubRegIndices.end(), LessRecord());
183 void CodeGenTarget::ReadRegisterClasses() const {
184 std::vector<Record*> RegClasses =
185 Records.getAllDerivedDefinitions("RegisterClass");
186 if (RegClasses.empty())
187 throw std::string("No 'RegisterClass' subclasses defined!");
189 RegisterClasses.reserve(RegClasses.size());
190 RegisterClasses.assign(RegClasses.begin(), RegClasses.end());
193 std::vector<MVT::SimpleValueType> CodeGenTarget::
194 getRegisterVTs(Record *R) const {
195 std::vector<MVT::SimpleValueType> Result;
196 const std::vector<CodeGenRegisterClass> &RCs = getRegisterClasses();
197 for (unsigned i = 0, e = RCs.size(); i != e; ++i) {
198 const CodeGenRegisterClass &RC = RegisterClasses[i];
199 for (unsigned ei = 0, ee = RC.Elements.size(); ei != ee; ++ei) {
200 if (R == RC.Elements[ei]) {
201 const std::vector<MVT::SimpleValueType> &InVTs = RC.getValueTypes();
202 Result.insert(Result.end(), InVTs.begin(), InVTs.end());
207 // Remove duplicates.
208 array_pod_sort(Result.begin(), Result.end());
209 Result.erase(std::unique(Result.begin(), Result.end()), Result.end());
214 CodeGenRegisterClass::CodeGenRegisterClass(Record *R) : TheDef(R) {
215 // Rename anonymous register classes.
216 if (R->getName().size() > 9 && R->getName()[9] == '.') {
217 static unsigned AnonCounter = 0;
218 R->setName("AnonRegClass_"+utostr(AnonCounter++));
221 std::vector<Record*> TypeList = R->getValueAsListOfDefs("RegTypes");
222 for (unsigned i = 0, e = TypeList.size(); i != e; ++i) {
223 Record *Type = TypeList[i];
224 if (!Type->isSubClassOf("ValueType"))
225 throw "RegTypes list member '" + Type->getName() +
226 "' does not derive from the ValueType class!";
227 VTs.push_back(getValueType(Type));
229 assert(!VTs.empty() && "RegisterClass must contain at least one ValueType!");
231 std::vector<Record*> RegList = R->getValueAsListOfDefs("MemberList");
232 for (unsigned i = 0, e = RegList.size(); i != e; ++i) {
233 Record *Reg = RegList[i];
234 if (!Reg->isSubClassOf("Register"))
235 throw "Register Class member '" + Reg->getName() +
236 "' does not derive from the Register class!";
237 Elements.push_back(Reg);
240 // SubRegClasses is a list<dag> containing (RC, subregindex, ...) dags.
241 ListInit *SRC = R->getValueAsListInit("SubRegClasses");
242 for (ListInit::const_iterator i = SRC->begin(), e = SRC->end(); i != e; ++i) {
243 DagInit *DAG = dynamic_cast<DagInit*>(*i);
244 if (!DAG) throw "SubRegClasses must contain DAGs";
245 DefInit *DAGOp = dynamic_cast<DefInit*>(DAG->getOperator());
247 if (!DAGOp || !(RCRec = DAGOp->getDef())->isSubClassOf("RegisterClass"))
248 throw "Operator '" + DAG->getOperator()->getAsString() +
249 "' in SubRegClasses is not a RegisterClass";
250 // Iterate over args, all SubRegIndex instances.
251 for (DagInit::const_arg_iterator ai = DAG->arg_begin(), ae = DAG->arg_end();
253 DefInit *Idx = dynamic_cast<DefInit*>(*ai);
255 if (!Idx || !(IdxRec = Idx->getDef())->isSubClassOf("SubRegIndex"))
256 throw "Argument '" + (*ai)->getAsString() +
257 "' in SubRegClasses is not a SubRegIndex";
258 if (!SubRegClasses.insert(std::make_pair(IdxRec, RCRec)).second)
259 throw "SubRegIndex '" + IdxRec->getName() + "' mentioned twice";
263 // Allow targets to override the size in bits of the RegisterClass.
264 unsigned Size = R->getValueAsInt("Size");
266 Namespace = R->getValueAsString("Namespace");
267 SpillSize = Size ? Size : EVT(VTs[0]).getSizeInBits();
268 SpillAlignment = R->getValueAsInt("Alignment");
269 CopyCost = R->getValueAsInt("CopyCost");
270 MethodBodies = R->getValueAsCode("MethodBodies");
271 MethodProtos = R->getValueAsCode("MethodProtos");
274 const std::string &CodeGenRegisterClass::getName() const {
275 return TheDef->getName();
278 void CodeGenTarget::ReadLegalValueTypes() const {
279 const std::vector<CodeGenRegisterClass> &RCs = getRegisterClasses();
280 for (unsigned i = 0, e = RCs.size(); i != e; ++i)
281 for (unsigned ri = 0, re = RCs[i].VTs.size(); ri != re; ++ri)
282 LegalValueTypes.push_back(RCs[i].VTs[ri]);
284 // Remove duplicates.
285 std::sort(LegalValueTypes.begin(), LegalValueTypes.end());
286 LegalValueTypes.erase(std::unique(LegalValueTypes.begin(),
287 LegalValueTypes.end()),
288 LegalValueTypes.end());
292 void CodeGenTarget::ReadInstructions() const {
293 std::vector<Record*> Insts = Records.getAllDerivedDefinitions("Instruction");
294 if (Insts.size() <= 2)
295 throw std::string("No 'Instruction' subclasses defined!");
297 // Parse the instructions defined in the .td file.
298 for (unsigned i = 0, e = Insts.size(); i != e; ++i)
299 Instructions[Insts[i]] = new CodeGenInstruction(Insts[i]);
302 static const CodeGenInstruction *
303 GetInstByName(const char *Name,
304 const DenseMap<const Record*, CodeGenInstruction*> &Insts) {
305 const Record *Rec = Records.getDef(Name);
307 DenseMap<const Record*, CodeGenInstruction*>::const_iterator
309 if (Rec == 0 || I == Insts.end())
310 throw std::string("Could not find '") + Name + "' instruction!";
315 /// SortInstByName - Sorting predicate to sort instructions by name.
317 struct SortInstByName {
318 bool operator()(const CodeGenInstruction *Rec1,
319 const CodeGenInstruction *Rec2) const {
320 return Rec1->TheDef->getName() < Rec2->TheDef->getName();
325 /// getInstructionsByEnumValue - Return all of the instructions defined by the
326 /// target, ordered by their enum value.
327 void CodeGenTarget::ComputeInstrsByEnum() const {
328 // The ordering here must match the ordering in TargetOpcodes.h.
329 const char *const FixedInstrs[] = {
346 const DenseMap<const Record*, CodeGenInstruction*> &Insts = getInstructions();
347 for (const char *const *p = FixedInstrs; *p; ++p) {
348 const CodeGenInstruction *Instr = GetInstByName(*p, Insts);
349 assert(Instr && "Missing target independent instruction");
350 assert(Instr->Namespace == "TargetOpcode" && "Bad namespace");
351 InstrsByEnum.push_back(Instr);
353 unsigned EndOfPredefines = InstrsByEnum.size();
355 for (DenseMap<const Record*, CodeGenInstruction*>::const_iterator
356 I = Insts.begin(), E = Insts.end(); I != E; ++I) {
357 const CodeGenInstruction *CGI = I->second;
358 if (CGI->Namespace != "TargetOpcode")
359 InstrsByEnum.push_back(CGI);
362 assert(InstrsByEnum.size() == Insts.size() && "Missing predefined instr");
364 // All of the instructions are now in random order based on the map iteration.
365 // Sort them by name.
366 std::sort(InstrsByEnum.begin()+EndOfPredefines, InstrsByEnum.end(),
371 /// isLittleEndianEncoding - Return whether this target encodes its instruction
372 /// in little-endian format, i.e. bits laid out in the order [0..n]
374 bool CodeGenTarget::isLittleEndianEncoding() const {
375 return getInstructionSet()->getValueAsBit("isLittleEndianEncoding");
378 //===----------------------------------------------------------------------===//
379 // ComplexPattern implementation
381 ComplexPattern::ComplexPattern(Record *R) {
382 Ty = ::getValueType(R->getValueAsDef("Ty"));
383 NumOperands = R->getValueAsInt("NumOperands");
384 SelectFunc = R->getValueAsString("SelectFunc");
385 RootNodes = R->getValueAsListOfDefs("RootNodes");
387 // Parse the properties.
389 std::vector<Record*> PropList = R->getValueAsListOfDefs("Properties");
390 for (unsigned i = 0, e = PropList.size(); i != e; ++i)
391 if (PropList[i]->getName() == "SDNPHasChain") {
392 Properties |= 1 << SDNPHasChain;
393 } else if (PropList[i]->getName() == "SDNPOptInFlag") {
394 Properties |= 1 << SDNPOptInFlag;
395 } else if (PropList[i]->getName() == "SDNPMayStore") {
396 Properties |= 1 << SDNPMayStore;
397 } else if (PropList[i]->getName() == "SDNPMayLoad") {
398 Properties |= 1 << SDNPMayLoad;
399 } else if (PropList[i]->getName() == "SDNPSideEffect") {
400 Properties |= 1 << SDNPSideEffect;
401 } else if (PropList[i]->getName() == "SDNPMemOperand") {
402 Properties |= 1 << SDNPMemOperand;
403 } else if (PropList[i]->getName() == "SDNPVariadic") {
404 Properties |= 1 << SDNPVariadic;
405 } else if (PropList[i]->getName() == "SDNPWantRoot") {
406 Properties |= 1 << SDNPWantRoot;
407 } else if (PropList[i]->getName() == "SDNPWantParent") {
408 Properties |= 1 << SDNPWantParent;
410 errs() << "Unsupported SD Node property '" << PropList[i]->getName()
411 << "' on ComplexPattern '" << R->getName() << "'!\n";
416 //===----------------------------------------------------------------------===//
417 // CodeGenIntrinsic Implementation
418 //===----------------------------------------------------------------------===//
420 std::vector<CodeGenIntrinsic> llvm::LoadIntrinsics(const RecordKeeper &RC,
422 std::vector<Record*> I = RC.getAllDerivedDefinitions("Intrinsic");
424 std::vector<CodeGenIntrinsic> Result;
426 for (unsigned i = 0, e = I.size(); i != e; ++i) {
427 bool isTarget = I[i]->getValueAsBit("isTarget");
428 if (isTarget == TargetOnly)
429 Result.push_back(CodeGenIntrinsic(I[i]));
434 CodeGenIntrinsic::CodeGenIntrinsic(Record *R) {
436 std::string DefName = R->getName();
437 ModRef = ReadWriteMem;
438 isOverloaded = false;
439 isCommutative = false;
441 if (DefName.size() <= 4 ||
442 std::string(DefName.begin(), DefName.begin() + 4) != "int_")
443 throw "Intrinsic '" + DefName + "' does not start with 'int_'!";
445 EnumName = std::string(DefName.begin()+4, DefName.end());
447 if (R->getValue("GCCBuiltinName")) // Ignore a missing GCCBuiltinName field.
448 GCCBuiltinName = R->getValueAsString("GCCBuiltinName");
450 TargetPrefix = R->getValueAsString("TargetPrefix");
451 Name = R->getValueAsString("LLVMName");
454 // If an explicit name isn't specified, derive one from the DefName.
457 for (unsigned i = 0, e = EnumName.size(); i != e; ++i)
458 Name += (EnumName[i] == '_') ? '.' : EnumName[i];
460 // Verify it starts with "llvm.".
461 if (Name.size() <= 5 ||
462 std::string(Name.begin(), Name.begin() + 5) != "llvm.")
463 throw "Intrinsic '" + DefName + "'s name does not start with 'llvm.'!";
466 // If TargetPrefix is specified, make sure that Name starts with
467 // "llvm.<targetprefix>.".
468 if (!TargetPrefix.empty()) {
469 if (Name.size() < 6+TargetPrefix.size() ||
470 std::string(Name.begin() + 5, Name.begin() + 6 + TargetPrefix.size())
471 != (TargetPrefix + "."))
472 throw "Intrinsic '" + DefName + "' does not start with 'llvm." +
473 TargetPrefix + ".'!";
476 // Parse the list of return types.
477 std::vector<MVT::SimpleValueType> OverloadedVTs;
478 ListInit *TypeList = R->getValueAsListInit("RetTypes");
479 for (unsigned i = 0, e = TypeList->getSize(); i != e; ++i) {
480 Record *TyEl = TypeList->getElementAsRecord(i);
481 assert(TyEl->isSubClassOf("LLVMType") && "Expected a type!");
482 MVT::SimpleValueType VT;
483 if (TyEl->isSubClassOf("LLVMMatchType")) {
484 unsigned MatchTy = TyEl->getValueAsInt("Number");
485 assert(MatchTy < OverloadedVTs.size() &&
486 "Invalid matching number!");
487 VT = OverloadedVTs[MatchTy];
488 // It only makes sense to use the extended and truncated vector element
489 // variants with iAny types; otherwise, if the intrinsic is not
490 // overloaded, all the types can be specified directly.
491 assert(((!TyEl->isSubClassOf("LLVMExtendedElementVectorType") &&
492 !TyEl->isSubClassOf("LLVMTruncatedElementVectorType")) ||
493 VT == MVT::iAny || VT == MVT::vAny) &&
494 "Expected iAny or vAny type");
496 VT = getValueType(TyEl->getValueAsDef("VT"));
498 if (EVT(VT).isOverloaded()) {
499 OverloadedVTs.push_back(VT);
503 // Reject invalid types.
504 if (VT == MVT::isVoid)
505 throw "Intrinsic '" + DefName + " has void in result type list!";
507 IS.RetVTs.push_back(VT);
508 IS.RetTypeDefs.push_back(TyEl);
511 // Parse the list of parameter types.
512 TypeList = R->getValueAsListInit("ParamTypes");
513 for (unsigned i = 0, e = TypeList->getSize(); i != e; ++i) {
514 Record *TyEl = TypeList->getElementAsRecord(i);
515 assert(TyEl->isSubClassOf("LLVMType") && "Expected a type!");
516 MVT::SimpleValueType VT;
517 if (TyEl->isSubClassOf("LLVMMatchType")) {
518 unsigned MatchTy = TyEl->getValueAsInt("Number");
519 assert(MatchTy < OverloadedVTs.size() &&
520 "Invalid matching number!");
521 VT = OverloadedVTs[MatchTy];
522 // It only makes sense to use the extended and truncated vector element
523 // variants with iAny types; otherwise, if the intrinsic is not
524 // overloaded, all the types can be specified directly.
525 assert(((!TyEl->isSubClassOf("LLVMExtendedElementVectorType") &&
526 !TyEl->isSubClassOf("LLVMTruncatedElementVectorType")) ||
527 VT == MVT::iAny || VT == MVT::vAny) &&
528 "Expected iAny or vAny type");
530 VT = getValueType(TyEl->getValueAsDef("VT"));
532 if (EVT(VT).isOverloaded()) {
533 OverloadedVTs.push_back(VT);
537 // Reject invalid types.
538 if (VT == MVT::isVoid && i != e-1 /*void at end means varargs*/)
539 throw "Intrinsic '" + DefName + " has void in result type list!";
541 IS.ParamVTs.push_back(VT);
542 IS.ParamTypeDefs.push_back(TyEl);
545 // Parse the intrinsic properties.
546 ListInit *PropList = R->getValueAsListInit("Properties");
547 for (unsigned i = 0, e = PropList->getSize(); i != e; ++i) {
548 Record *Property = PropList->getElementAsRecord(i);
549 assert(Property->isSubClassOf("IntrinsicProperty") &&
550 "Expected a property!");
552 if (Property->getName() == "IntrNoMem")
554 else if (Property->getName() == "IntrReadArgMem")
556 else if (Property->getName() == "IntrReadMem")
558 else if (Property->getName() == "IntrReadWriteArgMem")
559 ModRef = ReadWriteArgMem;
560 else if (Property->getName() == "Commutative")
561 isCommutative = true;
562 else if (Property->isSubClassOf("NoCapture")) {
563 unsigned ArgNo = Property->getValueAsInt("ArgNo");
564 ArgumentAttributes.push_back(std::make_pair(ArgNo, NoCapture));
566 assert(0 && "Unknown property!");