1 //===- Record.cpp - Record implementation ---------------------------------===//
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 // Implement the tablegen record classes.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/TableGen/Record.h"
15 #include "llvm/ADT/DenseMap.h"
16 #include "llvm/ADT/FoldingSet.h"
17 #include "llvm/ADT/Hashing.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/SmallVector.h"
20 #include "llvm/ADT/StringExtras.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/Support/DataTypes.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/Format.h"
25 #include "llvm/TableGen/Error.h"
29 //===----------------------------------------------------------------------===//
30 // std::string wrapper for DenseMap purposes
31 //===----------------------------------------------------------------------===//
35 /// TableGenStringKey - This is a wrapper for std::string suitable for
36 /// using as a key to a DenseMap. Because there isn't a particularly
37 /// good way to indicate tombstone or empty keys for strings, we want
38 /// to wrap std::string to indicate that this is a "special" string
39 /// not expected to take on certain values (those of the tombstone and
40 /// empty keys). This makes things a little safer as it clarifies
41 /// that DenseMap is really not appropriate for general strings.
43 class TableGenStringKey {
45 TableGenStringKey(const std::string &str) : data(str) {}
46 TableGenStringKey(const char *str) : data(str) {}
48 const std::string &str() const { return data; }
50 friend hash_code hash_value(const TableGenStringKey &Value) {
51 using llvm::hash_value;
52 return hash_value(Value.str());
58 /// Specialize DenseMapInfo for TableGenStringKey.
59 template<> struct DenseMapInfo<TableGenStringKey> {
60 static inline TableGenStringKey getEmptyKey() {
61 TableGenStringKey Empty("<<<EMPTY KEY>>>");
64 static inline TableGenStringKey getTombstoneKey() {
65 TableGenStringKey Tombstone("<<<TOMBSTONE KEY>>>");
68 static unsigned getHashValue(const TableGenStringKey& Val) {
69 using llvm::hash_value;
70 return hash_value(Val);
72 static bool isEqual(const TableGenStringKey& LHS,
73 const TableGenStringKey& RHS) {
74 return LHS.str() == RHS.str();
80 //===----------------------------------------------------------------------===//
81 // Type implementations
82 //===----------------------------------------------------------------------===//
84 BitRecTy BitRecTy::Shared;
85 IntRecTy IntRecTy::Shared;
86 StringRecTy StringRecTy::Shared;
87 DagRecTy DagRecTy::Shared;
89 void RecTy::anchor() { }
90 void RecTy::dump() const { print(errs()); }
92 ListRecTy *RecTy::getListTy() {
94 ListTy = new ListRecTy(this);
98 bool RecTy::baseClassOf(const RecTy *RHS) const{
99 assert (RHS && "NULL pointer");
100 return Kind == RHS->getRecTyKind();
103 Init *BitRecTy::convertValue(BitsInit *BI) {
104 if (BI->getNumBits() != 1) return nullptr; // Only accept if just one bit!
105 return BI->getBit(0);
108 Init *BitRecTy::convertValue(IntInit *II) {
109 int64_t Val = II->getValue();
110 if (Val != 0 && Val != 1) return nullptr; // Only accept 0 or 1 for a bit!
112 return BitInit::get(Val != 0);
115 Init *BitRecTy::convertValue(TypedInit *VI) {
116 RecTy *Ty = VI->getType();
117 if (isa<BitRecTy>(Ty))
118 return VI; // Accept variable if it is already of bit type!
119 if (auto *BitsTy = dyn_cast<BitsRecTy>(Ty))
120 // Accept only bits<1> expression.
121 return BitsTy->getNumBits() == 1 ? VI : nullptr;
122 // Ternary !if can be converted to bit, but only if both sides are
123 // convertible to a bit.
124 if (TernOpInit *TOI = dyn_cast<TernOpInit>(VI)) {
125 if (TOI->getOpcode() != TernOpInit::TernaryOp::IF)
127 if (!TOI->getMHS()->convertInitializerTo(BitRecTy::get()) ||
128 !TOI->getRHS()->convertInitializerTo(BitRecTy::get()))
135 bool BitRecTy::baseClassOf(const RecTy *RHS) const{
136 if(RecTy::baseClassOf(RHS) || getRecTyKind() == IntRecTyKind)
138 if(const BitsRecTy *BitsTy = dyn_cast<BitsRecTy>(RHS))
139 return BitsTy->getNumBits() == 1;
143 BitsRecTy *BitsRecTy::get(unsigned Sz) {
144 static std::vector<BitsRecTy*> Shared;
145 if (Sz >= Shared.size())
146 Shared.resize(Sz + 1);
147 BitsRecTy *&Ty = Shared[Sz];
149 Ty = new BitsRecTy(Sz);
153 std::string BitsRecTy::getAsString() const {
154 return "bits<" + utostr(Size) + ">";
157 Init *BitsRecTy::convertValue(UnsetInit *UI) {
158 SmallVector<Init *, 16> NewBits(Size);
160 for (unsigned i = 0; i != Size; ++i)
161 NewBits[i] = UnsetInit::get();
163 return BitsInit::get(NewBits);
166 Init *BitsRecTy::convertValue(BitInit *UI) {
167 if (Size != 1) return nullptr; // Can only convert single bit.
168 return BitsInit::get(UI);
171 /// canFitInBitfield - Return true if the number of bits is large enough to hold
172 /// the integer value.
173 static bool canFitInBitfield(int64_t Value, unsigned NumBits) {
174 // For example, with NumBits == 4, we permit Values from [-7 .. 15].
175 return (NumBits >= sizeof(Value) * 8) ||
176 (Value >> NumBits == 0) || (Value >> (NumBits-1) == -1);
179 /// convertValue from Int initializer to bits type: Split the integer up into the
180 /// appropriate bits.
182 Init *BitsRecTy::convertValue(IntInit *II) {
183 int64_t Value = II->getValue();
184 // Make sure this bitfield is large enough to hold the integer value.
185 if (!canFitInBitfield(Value, Size))
188 SmallVector<Init *, 16> NewBits(Size);
190 for (unsigned i = 0; i != Size; ++i)
191 NewBits[i] = BitInit::get(Value & (1LL << i));
193 return BitsInit::get(NewBits);
196 Init *BitsRecTy::convertValue(BitsInit *BI) {
197 // If the number of bits is right, return it. Otherwise we need to expand or
199 if (BI->getNumBits() == Size) return BI;
203 Init *BitsRecTy::convertValue(TypedInit *VI) {
204 if (Size == 1 && isa<BitRecTy>(VI->getType()))
205 return BitsInit::get(VI);
207 if (VI->getType()->typeIsConvertibleTo(this)) {
208 SmallVector<Init *, 16> NewBits(Size);
210 for (unsigned i = 0; i != Size; ++i)
211 NewBits[i] = VarBitInit::get(VI, i);
212 return BitsInit::get(NewBits);
218 bool BitsRecTy::baseClassOf(const RecTy *RHS) const{
219 if (RecTy::baseClassOf(RHS)) //argument and the receiver are the same type
220 return cast<BitsRecTy>(RHS)->Size == Size;
221 RecTyKind kind = RHS->getRecTyKind();
222 return (kind == BitRecTyKind && Size == 1) || (kind == IntRecTyKind);
225 Init *IntRecTy::convertValue(BitInit *BI) {
226 return IntInit::get(BI->getValue());
229 Init *IntRecTy::convertValue(BitsInit *BI) {
231 for (unsigned i = 0, e = BI->getNumBits(); i != e; ++i)
232 if (BitInit *Bit = dyn_cast<BitInit>(BI->getBit(i))) {
233 Result |= Bit->getValue() << i;
237 return IntInit::get(Result);
240 Init *IntRecTy::convertValue(TypedInit *TI) {
241 if (TI->getType()->typeIsConvertibleTo(this))
242 return TI; // Accept variable if already of the right type!
246 bool IntRecTy::baseClassOf(const RecTy *RHS) const{
247 RecTyKind kind = RHS->getRecTyKind();
248 return kind==BitRecTyKind || kind==BitsRecTyKind || kind==IntRecTyKind;
251 Init *StringRecTy::convertValue(UnOpInit *BO) {
252 if (BO->getOpcode() == UnOpInit::CAST) {
253 Init *L = BO->getOperand()->convertInitializerTo(this);
254 if (!L) return nullptr;
255 if (L != BO->getOperand())
256 return UnOpInit::get(UnOpInit::CAST, L, StringRecTy::get());
260 return convertValue((TypedInit*)BO);
263 Init *StringRecTy::convertValue(BinOpInit *BO) {
264 if (BO->getOpcode() == BinOpInit::STRCONCAT) {
265 Init *L = BO->getLHS()->convertInitializerTo(this);
266 Init *R = BO->getRHS()->convertInitializerTo(this);
267 if (!L || !R) return nullptr;
268 if (L != BO->getLHS() || R != BO->getRHS())
269 return BinOpInit::get(BinOpInit::STRCONCAT, L, R, StringRecTy::get());
273 return convertValue((TypedInit*)BO);
277 Init *StringRecTy::convertValue(TypedInit *TI) {
278 if (isa<StringRecTy>(TI->getType()))
279 return TI; // Accept variable if already of the right type!
283 std::string ListRecTy::getAsString() const {
284 return "list<" + Ty->getAsString() + ">";
287 Init *ListRecTy::convertValue(ListInit *LI) {
288 std::vector<Init*> Elements;
290 // Verify that all of the elements of the list are subclasses of the
291 // appropriate class!
292 for (unsigned i = 0, e = LI->getSize(); i != e; ++i)
293 if (Init *CI = LI->getElement(i)->convertInitializerTo(Ty))
294 Elements.push_back(CI);
298 if (!isa<ListRecTy>(LI->getType()))
301 return ListInit::get(Elements, this);
304 Init *ListRecTy::convertValue(TypedInit *TI) {
305 // Ensure that TI is compatible with our class.
306 if (ListRecTy *LRT = dyn_cast<ListRecTy>(TI->getType()))
307 if (LRT->getElementType()->typeIsConvertibleTo(getElementType()))
312 bool ListRecTy::baseClassOf(const RecTy *RHS) const{
313 if(const ListRecTy* ListTy = dyn_cast<ListRecTy>(RHS))
314 return ListTy->getElementType()->typeIsConvertibleTo(Ty);
318 Init *DagRecTy::convertValue(TypedInit *TI) {
319 if (TI->getType()->typeIsConvertibleTo(this))
324 Init *DagRecTy::convertValue(UnOpInit *BO) {
325 if (BO->getOpcode() == UnOpInit::CAST) {
326 Init *L = BO->getOperand()->convertInitializerTo(this);
327 if (!L) return nullptr;
328 if (L != BO->getOperand())
329 return UnOpInit::get(UnOpInit::CAST, L, new DagRecTy);
335 Init *DagRecTy::convertValue(BinOpInit *BO) {
336 if (BO->getOpcode() == BinOpInit::CONCAT) {
337 Init *L = BO->getLHS()->convertInitializerTo(this);
338 Init *R = BO->getRHS()->convertInitializerTo(this);
339 if (!L || !R) return nullptr;
340 if (L != BO->getLHS() || R != BO->getRHS())
341 return BinOpInit::get(BinOpInit::CONCAT, L, R, new DagRecTy);
347 RecordRecTy *RecordRecTy::get(Record *R) {
348 return dyn_cast<RecordRecTy>(R->getDefInit()->getType());
351 std::string RecordRecTy::getAsString() const {
352 return Rec->getName();
355 Init *RecordRecTy::convertValue(DefInit *DI) {
356 // Ensure that DI is a subclass of Rec.
357 if (!DI->getDef()->isSubClassOf(Rec))
362 Init *RecordRecTy::convertValue(TypedInit *TI) {
363 // Ensure that TI is compatible with Rec.
364 if (RecordRecTy *RRT = dyn_cast<RecordRecTy>(TI->getType()))
365 if (RRT->getRecord()->isSubClassOf(getRecord()) ||
366 RRT->getRecord() == getRecord())
371 bool RecordRecTy::baseClassOf(const RecTy *RHS) const{
372 const RecordRecTy *RTy = dyn_cast<RecordRecTy>(RHS);
376 if (Rec == RTy->getRecord() || RTy->getRecord()->isSubClassOf(Rec))
379 const std::vector<Record*> &SC = Rec->getSuperClasses();
380 for (unsigned i = 0, e = SC.size(); i != e; ++i)
381 if (RTy->getRecord()->isSubClassOf(SC[i]))
387 /// resolveTypes - Find a common type that T1 and T2 convert to.
388 /// Return null if no such type exists.
390 RecTy *llvm::resolveTypes(RecTy *T1, RecTy *T2) {
391 if (T1->typeIsConvertibleTo(T2))
393 if (T2->typeIsConvertibleTo(T1))
396 // If one is a Record type, check superclasses
397 if (RecordRecTy *RecTy1 = dyn_cast<RecordRecTy>(T1)) {
398 // See if T2 inherits from a type T1 also inherits from
399 const std::vector<Record *> &T1SuperClasses =
400 RecTy1->getRecord()->getSuperClasses();
401 for(std::vector<Record *>::const_iterator i = T1SuperClasses.begin(),
402 iend = T1SuperClasses.end();
405 RecordRecTy *SuperRecTy1 = RecordRecTy::get(*i);
406 RecTy *NewType1 = resolveTypes(SuperRecTy1, T2);
408 if (NewType1 != SuperRecTy1) {
415 if (RecordRecTy *RecTy2 = dyn_cast<RecordRecTy>(T2)) {
416 // See if T1 inherits from a type T2 also inherits from
417 const std::vector<Record *> &T2SuperClasses =
418 RecTy2->getRecord()->getSuperClasses();
419 for (std::vector<Record *>::const_iterator i = T2SuperClasses.begin(),
420 iend = T2SuperClasses.end();
423 RecordRecTy *SuperRecTy2 = RecordRecTy::get(*i);
424 RecTy *NewType2 = resolveTypes(T1, SuperRecTy2);
426 if (NewType2 != SuperRecTy2) {
437 //===----------------------------------------------------------------------===//
438 // Initializer implementations
439 //===----------------------------------------------------------------------===//
441 void Init::anchor() { }
442 void Init::dump() const { return print(errs()); }
444 void UnsetInit::anchor() { }
446 UnsetInit *UnsetInit::get() {
447 static UnsetInit TheInit;
451 void BitInit::anchor() { }
453 BitInit *BitInit::get(bool V) {
454 static BitInit True(true);
455 static BitInit False(false);
457 return V ? &True : &False;
461 ProfileBitsInit(FoldingSetNodeID &ID, ArrayRef<Init *> Range) {
462 ID.AddInteger(Range.size());
464 for (ArrayRef<Init *>::iterator i = Range.begin(),
471 BitsInit *BitsInit::get(ArrayRef<Init *> Range) {
472 typedef FoldingSet<BitsInit> Pool;
476 ProfileBitsInit(ID, Range);
479 if (BitsInit *I = ThePool.FindNodeOrInsertPos(ID, IP))
482 BitsInit *I = new BitsInit(Range);
483 ThePool.InsertNode(I, IP);
488 void BitsInit::Profile(FoldingSetNodeID &ID) const {
489 ProfileBitsInit(ID, Bits);
493 BitsInit::convertInitializerBitRange(const std::vector<unsigned> &Bits) const {
494 SmallVector<Init *, 16> NewBits(Bits.size());
496 for (unsigned i = 0, e = Bits.size(); i != e; ++i) {
497 if (Bits[i] >= getNumBits())
499 NewBits[i] = getBit(Bits[i]);
501 return BitsInit::get(NewBits);
504 std::string BitsInit::getAsString() const {
505 std::string Result = "{ ";
506 for (unsigned i = 0, e = getNumBits(); i != e; ++i) {
507 if (i) Result += ", ";
508 if (Init *Bit = getBit(e-i-1))
509 Result += Bit->getAsString();
513 return Result + " }";
516 // Fix bit initializer to preserve the behavior that bit reference from a unset
517 // bits initializer will resolve into VarBitInit to keep the field name and bit
518 // number used in targets with fixed insn length.
519 static Init *fixBitInit(const RecordVal *RV, Init *Before, Init *After) {
520 if (RV || !isa<UnsetInit>(After))
525 // resolveReferences - If there are any field references that refer to fields
526 // that have been filled in, we can propagate the values now.
528 Init *BitsInit::resolveReferences(Record &R, const RecordVal *RV) const {
529 bool Changed = false;
530 SmallVector<Init *, 16> NewBits(getNumBits());
532 Init *CachedInit = nullptr;
533 Init *CachedBitVar = nullptr;
534 bool CachedBitVarChanged = false;
536 for (unsigned i = 0, e = getNumBits(); i != e; ++i) {
537 Init *CurBit = Bits[i];
538 Init *CurBitVar = CurBit->getBitVar();
542 if (CurBitVar == CachedBitVar) {
543 if (CachedBitVarChanged) {
544 Init *Bit = CachedInit->getBit(CurBit->getBitNum());
545 NewBits[i] = fixBitInit(RV, CurBit, Bit);
549 CachedBitVar = CurBitVar;
550 CachedBitVarChanged = false;
555 CurBitVar = CurBitVar->resolveReferences(R, RV);
556 CachedBitVarChanged |= B != CurBitVar;
557 Changed |= B != CurBitVar;
558 } while (B != CurBitVar);
559 CachedInit = CurBitVar;
561 if (CachedBitVarChanged) {
562 Init *Bit = CurBitVar->getBit(CurBit->getBitNum());
563 NewBits[i] = fixBitInit(RV, CurBit, Bit);
568 return BitsInit::get(NewBits);
570 return const_cast<BitsInit *>(this);
573 IntInit *IntInit::get(int64_t V) {
574 static DenseMap<int64_t, std::unique_ptr<IntInit>> ThePool;
576 std::unique_ptr<IntInit> &I = ThePool[V];
577 if (!I) I.reset(new IntInit(V));
581 std::string IntInit::getAsString() const {
582 return itostr(Value);
586 IntInit::convertInitializerBitRange(const std::vector<unsigned> &Bits) const {
587 SmallVector<Init *, 16> NewBits(Bits.size());
589 for (unsigned i = 0, e = Bits.size(); i != e; ++i) {
593 NewBits[i] = BitInit::get(Value & (INT64_C(1) << Bits[i]));
595 return BitsInit::get(NewBits);
598 void StringInit::anchor() { }
600 StringInit *StringInit::get(StringRef V) {
601 static StringMap<std::unique_ptr<StringInit>> ThePool;
603 std::unique_ptr<StringInit> &I = ThePool[V];
604 if (!I) I.reset(new StringInit(V));
608 static void ProfileListInit(FoldingSetNodeID &ID,
609 ArrayRef<Init *> Range,
611 ID.AddInteger(Range.size());
612 ID.AddPointer(EltTy);
614 for (ArrayRef<Init *>::iterator i = Range.begin(),
621 ListInit *ListInit::get(ArrayRef<Init *> Range, RecTy *EltTy) {
622 typedef FoldingSet<ListInit> Pool;
624 static std::vector<std::unique_ptr<ListInit>> TheActualPool;
627 ProfileListInit(ID, Range, EltTy);
630 if (ListInit *I = ThePool.FindNodeOrInsertPos(ID, IP))
633 ListInit *I = new ListInit(Range, EltTy);
634 ThePool.InsertNode(I, IP);
635 TheActualPool.push_back(std::unique_ptr<ListInit>(I));
639 void ListInit::Profile(FoldingSetNodeID &ID) const {
640 ListRecTy *ListType = dyn_cast<ListRecTy>(getType());
641 assert(ListType && "Bad type for ListInit!");
642 RecTy *EltTy = ListType->getElementType();
644 ProfileListInit(ID, Values, EltTy);
648 ListInit::convertInitListSlice(const std::vector<unsigned> &Elements) const {
649 std::vector<Init*> Vals;
650 for (unsigned i = 0, e = Elements.size(); i != e; ++i) {
651 if (Elements[i] >= getSize())
653 Vals.push_back(getElement(Elements[i]));
655 return ListInit::get(Vals, getType());
658 Record *ListInit::getElementAsRecord(unsigned i) const {
659 assert(i < Values.size() && "List element index out of range!");
660 DefInit *DI = dyn_cast<DefInit>(Values[i]);
662 PrintFatalError("Expected record in list!");
666 Init *ListInit::resolveReferences(Record &R, const RecordVal *RV) const {
667 std::vector<Init*> Resolved;
668 Resolved.reserve(getSize());
669 bool Changed = false;
671 for (unsigned i = 0, e = getSize(); i != e; ++i) {
673 Init *CurElt = getElement(i);
677 CurElt = CurElt->resolveReferences(R, RV);
678 Changed |= E != CurElt;
679 } while (E != CurElt);
680 Resolved.push_back(E);
684 return ListInit::get(Resolved, getType());
685 return const_cast<ListInit *>(this);
688 Init *ListInit::resolveListElementReference(Record &R, const RecordVal *IRV,
689 unsigned Elt) const {
690 if (Elt >= getSize())
691 return nullptr; // Out of range reference.
692 Init *E = getElement(Elt);
693 // If the element is set to some value, or if we are resolving a reference
694 // to a specific variable and that variable is explicitly unset, then
695 // replace the VarListElementInit with it.
696 if (IRV || !isa<UnsetInit>(E))
701 std::string ListInit::getAsString() const {
702 std::string Result = "[";
703 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
704 if (i) Result += ", ";
705 Result += Values[i]->getAsString();
710 Init *OpInit::resolveListElementReference(Record &R, const RecordVal *IRV,
711 unsigned Elt) const {
712 Init *Resolved = resolveReferences(R, IRV);
713 OpInit *OResolved = dyn_cast<OpInit>(Resolved);
715 Resolved = OResolved->Fold(&R, nullptr);
718 if (Resolved != this) {
719 TypedInit *Typed = dyn_cast<TypedInit>(Resolved);
720 assert(Typed && "Expected typed init for list reference");
722 Init *New = Typed->resolveListElementReference(R, IRV, Elt);
725 return VarListElementInit::get(Typed, Elt);
732 Init *OpInit::getBit(unsigned Bit) const {
733 if (getType() == BitRecTy::get())
734 return const_cast<OpInit*>(this);
735 return VarBitInit::get(const_cast<OpInit*>(this), Bit);
738 UnOpInit *UnOpInit::get(UnaryOp opc, Init *lhs, RecTy *Type) {
739 typedef std::pair<std::pair<unsigned, Init *>, RecTy *> Key;
740 static DenseMap<Key, std::unique_ptr<UnOpInit>> ThePool;
742 Key TheKey(std::make_pair(std::make_pair(opc, lhs), Type));
744 std::unique_ptr<UnOpInit> &I = ThePool[TheKey];
745 if (!I) I.reset(new UnOpInit(opc, lhs, Type));
749 Init *UnOpInit::Fold(Record *CurRec, MultiClass *CurMultiClass) const {
750 switch (getOpcode()) {
752 if (getType()->getAsString() == "string") {
753 if (StringInit *LHSs = dyn_cast<StringInit>(LHS))
756 if (DefInit *LHSd = dyn_cast<DefInit>(LHS))
757 return StringInit::get(LHSd->getDef()->getName());
759 if (IntInit *LHSi = dyn_cast<IntInit>(LHS))
760 return StringInit::get(LHSi->getAsString());
762 if (StringInit *LHSs = dyn_cast<StringInit>(LHS)) {
763 std::string Name = LHSs->getValue();
765 // From TGParser::ParseIDValue
767 if (const RecordVal *RV = CurRec->getValue(Name)) {
768 if (RV->getType() != getType())
769 PrintFatalError("type mismatch in cast");
770 return VarInit::get(Name, RV->getType());
773 Init *TemplateArgName = QualifyName(*CurRec, CurMultiClass, Name,
776 if (CurRec->isTemplateArg(TemplateArgName)) {
777 const RecordVal *RV = CurRec->getValue(TemplateArgName);
778 assert(RV && "Template arg doesn't exist??");
780 if (RV->getType() != getType())
781 PrintFatalError("type mismatch in cast");
783 return VarInit::get(TemplateArgName, RV->getType());
788 Init *MCName = QualifyName(CurMultiClass->Rec, CurMultiClass, Name, "::");
790 if (CurMultiClass->Rec.isTemplateArg(MCName)) {
791 const RecordVal *RV = CurMultiClass->Rec.getValue(MCName);
792 assert(RV && "Template arg doesn't exist??");
794 if (RV->getType() != getType())
795 PrintFatalError("type mismatch in cast");
797 return VarInit::get(MCName, RV->getType());
800 assert(CurRec && "NULL pointer");
801 if (Record *D = (CurRec->getRecords()).getDef(Name))
802 return DefInit::get(D);
804 PrintFatalError(CurRec->getLoc(),
805 "Undefined reference:'" + Name + "'\n");
811 if (ListInit *LHSl = dyn_cast<ListInit>(LHS)) {
812 assert(LHSl->getSize() != 0 && "Empty list in car");
813 return LHSl->getElement(0);
818 if (ListInit *LHSl = dyn_cast<ListInit>(LHS)) {
819 assert(LHSl->getSize() != 0 && "Empty list in cdr");
820 // Note the +1. We can't just pass the result of getValues()
822 ArrayRef<Init *>::iterator begin = LHSl->getValues().begin()+1;
823 ArrayRef<Init *>::iterator end = LHSl->getValues().end();
825 ListInit::get(ArrayRef<Init *>(begin, end - begin),
832 if (ListInit *LHSl = dyn_cast<ListInit>(LHS)) {
833 if (LHSl->getSize() == 0) {
834 return IntInit::get(1);
836 return IntInit::get(0);
839 if (StringInit *LHSs = dyn_cast<StringInit>(LHS)) {
840 if (LHSs->getValue().empty()) {
841 return IntInit::get(1);
843 return IntInit::get(0);
850 return const_cast<UnOpInit *>(this);
853 Init *UnOpInit::resolveReferences(Record &R, const RecordVal *RV) const {
854 Init *lhs = LHS->resolveReferences(R, RV);
857 return (UnOpInit::get(getOpcode(), lhs, getType()))->Fold(&R, nullptr);
858 return Fold(&R, nullptr);
861 std::string UnOpInit::getAsString() const {
864 case CAST: Result = "!cast<" + getType()->getAsString() + ">"; break;
865 case HEAD: Result = "!head"; break;
866 case TAIL: Result = "!tail"; break;
867 case EMPTY: Result = "!empty"; break;
869 return Result + "(" + LHS->getAsString() + ")";
872 BinOpInit *BinOpInit::get(BinaryOp opc, Init *lhs,
873 Init *rhs, RecTy *Type) {
875 std::pair<std::pair<unsigned, Init *>, Init *>,
879 static DenseMap<Key, std::unique_ptr<BinOpInit>> ThePool;
881 Key TheKey(std::make_pair(std::make_pair(std::make_pair(opc, lhs), rhs),
884 std::unique_ptr<BinOpInit> &I = ThePool[TheKey];
885 if (!I) I.reset(new BinOpInit(opc, lhs, rhs, Type));
889 Init *BinOpInit::Fold(Record *CurRec, MultiClass *CurMultiClass) const {
890 switch (getOpcode()) {
892 DagInit *LHSs = dyn_cast<DagInit>(LHS);
893 DagInit *RHSs = dyn_cast<DagInit>(RHS);
895 DefInit *LOp = dyn_cast<DefInit>(LHSs->getOperator());
896 DefInit *ROp = dyn_cast<DefInit>(RHSs->getOperator());
897 if (!LOp || !ROp || LOp->getDef() != ROp->getDef())
898 PrintFatalError("Concated Dag operators do not match!");
899 std::vector<Init*> Args;
900 std::vector<std::string> ArgNames;
901 for (unsigned i = 0, e = LHSs->getNumArgs(); i != e; ++i) {
902 Args.push_back(LHSs->getArg(i));
903 ArgNames.push_back(LHSs->getArgName(i));
905 for (unsigned i = 0, e = RHSs->getNumArgs(); i != e; ++i) {
906 Args.push_back(RHSs->getArg(i));
907 ArgNames.push_back(RHSs->getArgName(i));
909 return DagInit::get(LHSs->getOperator(), "", Args, ArgNames);
914 ListInit *LHSs = dyn_cast<ListInit>(LHS);
915 ListInit *RHSs = dyn_cast<ListInit>(RHS);
917 std::vector<Init *> Args;
918 Args.insert(Args.end(), LHSs->begin(), LHSs->end());
919 Args.insert(Args.end(), RHSs->begin(), RHSs->end());
920 return ListInit::get(
921 Args, static_cast<ListRecTy *>(LHSs->getType())->getElementType());
926 StringInit *LHSs = dyn_cast<StringInit>(LHS);
927 StringInit *RHSs = dyn_cast<StringInit>(RHS);
929 return StringInit::get(LHSs->getValue() + RHSs->getValue());
933 // try to fold eq comparison for 'bit' and 'int', otherwise fallback
934 // to string objects.
936 dyn_cast_or_null<IntInit>(LHS->convertInitializerTo(IntRecTy::get()));
938 dyn_cast_or_null<IntInit>(RHS->convertInitializerTo(IntRecTy::get()));
941 return IntInit::get(L->getValue() == R->getValue());
943 StringInit *LHSs = dyn_cast<StringInit>(LHS);
944 StringInit *RHSs = dyn_cast<StringInit>(RHS);
946 // Make sure we've resolved
948 return IntInit::get(LHSs->getValue() == RHSs->getValue());
958 dyn_cast_or_null<IntInit>(LHS->convertInitializerTo(IntRecTy::get()));
960 dyn_cast_or_null<IntInit>(RHS->convertInitializerTo(IntRecTy::get()));
962 int64_t LHSv = LHSi->getValue(), RHSv = RHSi->getValue();
964 switch (getOpcode()) {
965 default: llvm_unreachable("Bad opcode!");
966 case ADD: Result = LHSv + RHSv; break;
967 case AND: Result = LHSv & RHSv; break;
968 case SHL: Result = LHSv << RHSv; break;
969 case SRA: Result = LHSv >> RHSv; break;
970 case SRL: Result = (uint64_t)LHSv >> (uint64_t)RHSv; break;
972 return IntInit::get(Result);
977 return const_cast<BinOpInit *>(this);
980 Init *BinOpInit::resolveReferences(Record &R, const RecordVal *RV) const {
981 Init *lhs = LHS->resolveReferences(R, RV);
982 Init *rhs = RHS->resolveReferences(R, RV);
984 if (LHS != lhs || RHS != rhs)
985 return (BinOpInit::get(getOpcode(), lhs, rhs, getType()))->Fold(&R,nullptr);
986 return Fold(&R, nullptr);
989 std::string BinOpInit::getAsString() const {
992 case CONCAT: Result = "!con"; break;
993 case ADD: Result = "!add"; break;
994 case AND: Result = "!and"; break;
995 case SHL: Result = "!shl"; break;
996 case SRA: Result = "!sra"; break;
997 case SRL: Result = "!srl"; break;
998 case EQ: Result = "!eq"; break;
999 case LISTCONCAT: Result = "!listconcat"; break;
1000 case STRCONCAT: Result = "!strconcat"; break;
1002 return Result + "(" + LHS->getAsString() + ", " + RHS->getAsString() + ")";
1005 TernOpInit *TernOpInit::get(TernaryOp opc, Init *lhs,
1006 Init *mhs, Init *rhs,
1010 std::pair<std::pair<unsigned, RecTy *>, Init *>,
1016 typedef DenseMap<Key, TernOpInit *> Pool;
1017 static Pool ThePool;
1019 Key TheKey(std::make_pair(std::make_pair(std::make_pair(std::make_pair(opc,
1025 TernOpInit *&I = ThePool[TheKey];
1026 if (!I) I = new TernOpInit(opc, lhs, mhs, rhs, Type);
1030 static Init *ForeachHelper(Init *LHS, Init *MHS, Init *RHS, RecTy *Type,
1031 Record *CurRec, MultiClass *CurMultiClass);
1033 static Init *EvaluateOperation(OpInit *RHSo, Init *LHS, Init *Arg,
1034 RecTy *Type, Record *CurRec,
1035 MultiClass *CurMultiClass) {
1036 std::vector<Init *> NewOperands;
1038 TypedInit *TArg = dyn_cast<TypedInit>(Arg);
1040 // If this is a dag, recurse
1041 if (TArg && TArg->getType()->getAsString() == "dag") {
1042 Init *Result = ForeachHelper(LHS, Arg, RHSo, Type,
1043 CurRec, CurMultiClass);
1047 for (int i = 0; i < RHSo->getNumOperands(); ++i) {
1048 OpInit *RHSoo = dyn_cast<OpInit>(RHSo->getOperand(i));
1051 Init *Result = EvaluateOperation(RHSoo, LHS, Arg,
1052 Type, CurRec, CurMultiClass);
1054 NewOperands.push_back(Result);
1056 NewOperands.push_back(Arg);
1058 } else if (LHS->getAsString() == RHSo->getOperand(i)->getAsString()) {
1059 NewOperands.push_back(Arg);
1061 NewOperands.push_back(RHSo->getOperand(i));
1065 // Now run the operator and use its result as the new leaf
1066 const OpInit *NewOp = RHSo->clone(NewOperands);
1067 Init *NewVal = NewOp->Fold(CurRec, CurMultiClass);
1068 return (NewVal != NewOp) ? NewVal : nullptr;
1071 static Init *ForeachHelper(Init *LHS, Init *MHS, Init *RHS, RecTy *Type,
1072 Record *CurRec, MultiClass *CurMultiClass) {
1073 DagInit *MHSd = dyn_cast<DagInit>(MHS);
1074 ListInit *MHSl = dyn_cast<ListInit>(MHS);
1076 OpInit *RHSo = dyn_cast<OpInit>(RHS);
1079 PrintFatalError(CurRec->getLoc(), "!foreach requires an operator\n");
1082 TypedInit *LHSt = dyn_cast<TypedInit>(LHS);
1085 PrintFatalError(CurRec->getLoc(), "!foreach requires typed variable\n");
1087 if ((MHSd && isa<DagRecTy>(Type)) || (MHSl && isa<ListRecTy>(Type))) {
1089 Init *Val = MHSd->getOperator();
1090 Init *Result = EvaluateOperation(RHSo, LHS, Val,
1091 Type, CurRec, CurMultiClass);
1096 std::vector<std::pair<Init *, std::string> > args;
1097 for (unsigned int i = 0; i < MHSd->getNumArgs(); ++i) {
1099 std::string ArgName;
1100 Arg = MHSd->getArg(i);
1101 ArgName = MHSd->getArgName(i);
1104 Init *Result = EvaluateOperation(RHSo, LHS, Arg, Type,
1105 CurRec, CurMultiClass);
1110 // TODO: Process arg names
1111 args.push_back(std::make_pair(Arg, ArgName));
1114 return DagInit::get(Val, "", args);
1117 std::vector<Init *> NewOperands;
1118 std::vector<Init *> NewList(MHSl->begin(), MHSl->end());
1120 for (std::vector<Init *>::iterator li = NewList.begin(),
1121 liend = NewList.end();
1125 NewOperands.clear();
1126 for(int i = 0; i < RHSo->getNumOperands(); ++i) {
1127 // First, replace the foreach variable with the list item
1128 if (LHS->getAsString() == RHSo->getOperand(i)->getAsString()) {
1129 NewOperands.push_back(Item);
1131 NewOperands.push_back(RHSo->getOperand(i));
1135 // Now run the operator and use its result as the new list item
1136 const OpInit *NewOp = RHSo->clone(NewOperands);
1137 Init *NewItem = NewOp->Fold(CurRec, CurMultiClass);
1138 if (NewItem != NewOp)
1141 return ListInit::get(NewList, MHSl->getType());
1147 Init *TernOpInit::Fold(Record *CurRec, MultiClass *CurMultiClass) const {
1148 switch (getOpcode()) {
1150 DefInit *LHSd = dyn_cast<DefInit>(LHS);
1151 VarInit *LHSv = dyn_cast<VarInit>(LHS);
1152 StringInit *LHSs = dyn_cast<StringInit>(LHS);
1154 DefInit *MHSd = dyn_cast<DefInit>(MHS);
1155 VarInit *MHSv = dyn_cast<VarInit>(MHS);
1156 StringInit *MHSs = dyn_cast<StringInit>(MHS);
1158 DefInit *RHSd = dyn_cast<DefInit>(RHS);
1159 VarInit *RHSv = dyn_cast<VarInit>(RHS);
1160 StringInit *RHSs = dyn_cast<StringInit>(RHS);
1162 if ((LHSd && MHSd && RHSd)
1163 || (LHSv && MHSv && RHSv)
1164 || (LHSs && MHSs && RHSs)) {
1166 Record *Val = RHSd->getDef();
1167 if (LHSd->getAsString() == RHSd->getAsString()) {
1168 Val = MHSd->getDef();
1170 return DefInit::get(Val);
1173 std::string Val = RHSv->getName();
1174 if (LHSv->getAsString() == RHSv->getAsString()) {
1175 Val = MHSv->getName();
1177 return VarInit::get(Val, getType());
1180 std::string Val = RHSs->getValue();
1182 std::string::size_type found;
1183 std::string::size_type idx = 0;
1185 found = Val.find(LHSs->getValue(), idx);
1186 if (found != std::string::npos) {
1187 Val.replace(found, LHSs->getValue().size(), MHSs->getValue());
1189 idx = found + MHSs->getValue().size();
1190 } while (found != std::string::npos);
1192 return StringInit::get(Val);
1199 Init *Result = ForeachHelper(LHS, MHS, RHS, getType(),
1200 CurRec, CurMultiClass);
1208 IntInit *LHSi = dyn_cast<IntInit>(LHS);
1209 if (Init *I = LHS->convertInitializerTo(IntRecTy::get()))
1210 LHSi = dyn_cast<IntInit>(I);
1212 if (LHSi->getValue()) {
1222 return const_cast<TernOpInit *>(this);
1225 Init *TernOpInit::resolveReferences(Record &R,
1226 const RecordVal *RV) const {
1227 Init *lhs = LHS->resolveReferences(R, RV);
1229 if (Opc == IF && lhs != LHS) {
1230 IntInit *Value = dyn_cast<IntInit>(lhs);
1231 if (Init *I = lhs->convertInitializerTo(IntRecTy::get()))
1232 Value = dyn_cast<IntInit>(I);
1235 if (Value->getValue()) {
1236 Init *mhs = MHS->resolveReferences(R, RV);
1237 return (TernOpInit::get(getOpcode(), lhs, mhs,
1238 RHS, getType()))->Fold(&R, nullptr);
1240 Init *rhs = RHS->resolveReferences(R, RV);
1241 return (TernOpInit::get(getOpcode(), lhs, MHS,
1242 rhs, getType()))->Fold(&R, nullptr);
1247 Init *mhs = MHS->resolveReferences(R, RV);
1248 Init *rhs = RHS->resolveReferences(R, RV);
1250 if (LHS != lhs || MHS != mhs || RHS != rhs)
1251 return (TernOpInit::get(getOpcode(), lhs, mhs, rhs,
1252 getType()))->Fold(&R, nullptr);
1253 return Fold(&R, nullptr);
1256 std::string TernOpInit::getAsString() const {
1259 case SUBST: Result = "!subst"; break;
1260 case FOREACH: Result = "!foreach"; break;
1261 case IF: Result = "!if"; break;
1263 return Result + "(" + LHS->getAsString() + ", " + MHS->getAsString() + ", "
1264 + RHS->getAsString() + ")";
1267 RecTy *TypedInit::getFieldType(const std::string &FieldName) const {
1268 if (RecordRecTy *RecordType = dyn_cast<RecordRecTy>(getType()))
1269 if (RecordVal *Field = RecordType->getRecord()->getValue(FieldName))
1270 return Field->getType();
1275 TypedInit::convertInitializerBitRange(const std::vector<unsigned> &Bits) const {
1276 BitsRecTy *T = dyn_cast<BitsRecTy>(getType());
1277 if (!T) return nullptr; // Cannot subscript a non-bits variable.
1278 unsigned NumBits = T->getNumBits();
1280 SmallVector<Init *, 16> NewBits(Bits.size());
1281 for (unsigned i = 0, e = Bits.size(); i != e; ++i) {
1282 if (Bits[i] >= NumBits)
1285 NewBits[i] = VarBitInit::get(const_cast<TypedInit *>(this), Bits[i]);
1287 return BitsInit::get(NewBits);
1291 TypedInit::convertInitListSlice(const std::vector<unsigned> &Elements) const {
1292 ListRecTy *T = dyn_cast<ListRecTy>(getType());
1293 if (!T) return nullptr; // Cannot subscript a non-list variable.
1295 if (Elements.size() == 1)
1296 return VarListElementInit::get(const_cast<TypedInit *>(this), Elements[0]);
1298 std::vector<Init*> ListInits;
1299 ListInits.reserve(Elements.size());
1300 for (unsigned i = 0, e = Elements.size(); i != e; ++i)
1301 ListInits.push_back(VarListElementInit::get(const_cast<TypedInit *>(this),
1303 return ListInit::get(ListInits, T);
1307 VarInit *VarInit::get(const std::string &VN, RecTy *T) {
1308 Init *Value = StringInit::get(VN);
1309 return VarInit::get(Value, T);
1312 VarInit *VarInit::get(Init *VN, RecTy *T) {
1313 typedef std::pair<RecTy *, Init *> Key;
1314 static DenseMap<Key, std::unique_ptr<VarInit>> ThePool;
1316 Key TheKey(std::make_pair(T, VN));
1318 std::unique_ptr<VarInit> &I = ThePool[TheKey];
1319 if (!I) I.reset(new VarInit(VN, T));
1323 const std::string &VarInit::getName() const {
1324 StringInit *NameString = dyn_cast<StringInit>(getNameInit());
1325 assert(NameString && "VarInit name is not a string!");
1326 return NameString->getValue();
1329 Init *VarInit::getBit(unsigned Bit) const {
1330 if (getType() == BitRecTy::get())
1331 return const_cast<VarInit*>(this);
1332 return VarBitInit::get(const_cast<VarInit*>(this), Bit);
1335 Init *VarInit::resolveListElementReference(Record &R,
1336 const RecordVal *IRV,
1337 unsigned Elt) const {
1338 if (R.isTemplateArg(getNameInit())) return nullptr;
1339 if (IRV && IRV->getNameInit() != getNameInit()) return nullptr;
1341 RecordVal *RV = R.getValue(getNameInit());
1342 assert(RV && "Reference to a non-existent variable?");
1343 ListInit *LI = dyn_cast<ListInit>(RV->getValue());
1345 TypedInit *VI = dyn_cast<TypedInit>(RV->getValue());
1346 assert(VI && "Invalid list element!");
1347 return VarListElementInit::get(VI, Elt);
1350 if (Elt >= LI->getSize())
1351 return nullptr; // Out of range reference.
1352 Init *E = LI->getElement(Elt);
1353 // If the element is set to some value, or if we are resolving a reference
1354 // to a specific variable and that variable is explicitly unset, then
1355 // replace the VarListElementInit with it.
1356 if (IRV || !isa<UnsetInit>(E))
1362 RecTy *VarInit::getFieldType(const std::string &FieldName) const {
1363 if (RecordRecTy *RTy = dyn_cast<RecordRecTy>(getType()))
1364 if (const RecordVal *RV = RTy->getRecord()->getValue(FieldName))
1365 return RV->getType();
1369 Init *VarInit::getFieldInit(Record &R, const RecordVal *RV,
1370 const std::string &FieldName) const {
1371 if (isa<RecordRecTy>(getType()))
1372 if (const RecordVal *Val = R.getValue(VarName)) {
1373 if (RV != Val && (RV || isa<UnsetInit>(Val->getValue())))
1375 Init *TheInit = Val->getValue();
1376 assert(TheInit != this && "Infinite loop detected!");
1377 if (Init *I = TheInit->getFieldInit(R, RV, FieldName))
1385 /// resolveReferences - This method is used by classes that refer to other
1386 /// variables which may not be defined at the time the expression is formed.
1387 /// If a value is set for the variable later, this method will be called on
1388 /// users of the value to allow the value to propagate out.
1390 Init *VarInit::resolveReferences(Record &R, const RecordVal *RV) const {
1391 if (RecordVal *Val = R.getValue(VarName))
1392 if (RV == Val || (!RV && !isa<UnsetInit>(Val->getValue())))
1393 return Val->getValue();
1394 return const_cast<VarInit *>(this);
1397 VarBitInit *VarBitInit::get(TypedInit *T, unsigned B) {
1398 typedef std::pair<TypedInit *, unsigned> Key;
1399 static DenseMap<Key, std::unique_ptr<VarBitInit>> ThePool;
1401 Key TheKey(std::make_pair(T, B));
1403 std::unique_ptr<VarBitInit> &I = ThePool[TheKey];
1404 if (!I) I.reset(new VarBitInit(T, B));
1408 std::string VarBitInit::getAsString() const {
1409 return TI->getAsString() + "{" + utostr(Bit) + "}";
1412 Init *VarBitInit::resolveReferences(Record &R, const RecordVal *RV) const {
1413 Init *I = TI->resolveReferences(R, RV);
1415 return I->getBit(getBitNum());
1417 return const_cast<VarBitInit*>(this);
1420 VarListElementInit *VarListElementInit::get(TypedInit *T,
1422 typedef std::pair<TypedInit *, unsigned> Key;
1423 typedef DenseMap<Key, VarListElementInit *> Pool;
1425 static Pool ThePool;
1427 Key TheKey(std::make_pair(T, E));
1429 VarListElementInit *&I = ThePool[TheKey];
1430 if (!I) I = new VarListElementInit(T, E);
1434 std::string VarListElementInit::getAsString() const {
1435 return TI->getAsString() + "[" + utostr(Element) + "]";
1439 VarListElementInit::resolveReferences(Record &R, const RecordVal *RV) const {
1440 if (Init *I = getVariable()->resolveListElementReference(R, RV,
1443 return const_cast<VarListElementInit *>(this);
1446 Init *VarListElementInit::getBit(unsigned Bit) const {
1447 if (getType() == BitRecTy::get())
1448 return const_cast<VarListElementInit*>(this);
1449 return VarBitInit::get(const_cast<VarListElementInit*>(this), Bit);
1452 Init *VarListElementInit:: resolveListElementReference(Record &R,
1453 const RecordVal *RV,
1454 unsigned Elt) const {
1455 Init *Result = TI->resolveListElementReference(R, RV, Element);
1458 if (TypedInit *TInit = dyn_cast<TypedInit>(Result)) {
1459 Init *Result2 = TInit->resolveListElementReference(R, RV, Elt);
1460 if (Result2) return Result2;
1461 return new VarListElementInit(TInit, Elt);
1469 DefInit *DefInit::get(Record *R) {
1470 return R->getDefInit();
1473 RecTy *DefInit::getFieldType(const std::string &FieldName) const {
1474 if (const RecordVal *RV = Def->getValue(FieldName))
1475 return RV->getType();
1479 Init *DefInit::getFieldInit(Record &R, const RecordVal *RV,
1480 const std::string &FieldName) const {
1481 return Def->getValue(FieldName)->getValue();
1485 std::string DefInit::getAsString() const {
1486 return Def->getName();
1489 FieldInit *FieldInit::get(Init *R, const std::string &FN) {
1490 typedef std::pair<Init *, TableGenStringKey> Key;
1491 typedef DenseMap<Key, FieldInit *> Pool;
1492 static Pool ThePool;
1494 Key TheKey(std::make_pair(R, FN));
1496 FieldInit *&I = ThePool[TheKey];
1497 if (!I) I = new FieldInit(R, FN);
1501 Init *FieldInit::getBit(unsigned Bit) const {
1502 if (getType() == BitRecTy::get())
1503 return const_cast<FieldInit*>(this);
1504 return VarBitInit::get(const_cast<FieldInit*>(this), Bit);
1507 Init *FieldInit::resolveListElementReference(Record &R, const RecordVal *RV,
1508 unsigned Elt) const {
1509 if (Init *ListVal = Rec->getFieldInit(R, RV, FieldName))
1510 if (ListInit *LI = dyn_cast<ListInit>(ListVal)) {
1511 if (Elt >= LI->getSize()) return nullptr;
1512 Init *E = LI->getElement(Elt);
1514 // If the element is set to some value, or if we are resolving a
1515 // reference to a specific variable and that variable is explicitly
1516 // unset, then replace the VarListElementInit with it.
1517 if (RV || !isa<UnsetInit>(E))
1523 Init *FieldInit::resolveReferences(Record &R, const RecordVal *RV) const {
1524 Init *NewRec = RV ? Rec->resolveReferences(R, RV) : Rec;
1526 Init *BitsVal = NewRec->getFieldInit(R, RV, FieldName);
1528 Init *BVR = BitsVal->resolveReferences(R, RV);
1529 return BVR->isComplete() ? BVR : const_cast<FieldInit *>(this);
1532 if (NewRec != Rec) {
1533 return FieldInit::get(NewRec, FieldName);
1535 return const_cast<FieldInit *>(this);
1538 static void ProfileDagInit(FoldingSetNodeID &ID, Init *V, const std::string &VN,
1539 ArrayRef<Init *> ArgRange,
1540 ArrayRef<std::string> NameRange) {
1544 ArrayRef<Init *>::iterator Arg = ArgRange.begin();
1545 ArrayRef<std::string>::iterator Name = NameRange.begin();
1546 while (Arg != ArgRange.end()) {
1547 assert(Name != NameRange.end() && "Arg name underflow!");
1548 ID.AddPointer(*Arg++);
1549 ID.AddString(*Name++);
1551 assert(Name == NameRange.end() && "Arg name overflow!");
1555 DagInit::get(Init *V, const std::string &VN,
1556 ArrayRef<Init *> ArgRange,
1557 ArrayRef<std::string> NameRange) {
1558 typedef FoldingSet<DagInit> Pool;
1559 static Pool ThePool;
1561 FoldingSetNodeID ID;
1562 ProfileDagInit(ID, V, VN, ArgRange, NameRange);
1565 if (DagInit *I = ThePool.FindNodeOrInsertPos(ID, IP))
1568 DagInit *I = new DagInit(V, VN, ArgRange, NameRange);
1569 ThePool.InsertNode(I, IP);
1575 DagInit::get(Init *V, const std::string &VN,
1576 const std::vector<std::pair<Init*, std::string> > &args) {
1577 typedef std::pair<Init*, std::string> PairType;
1579 std::vector<Init *> Args;
1580 std::vector<std::string> Names;
1582 for (std::vector<PairType>::const_iterator i = args.begin(),
1586 Args.push_back(i->first);
1587 Names.push_back(i->second);
1590 return DagInit::get(V, VN, Args, Names);
1593 void DagInit::Profile(FoldingSetNodeID &ID) const {
1594 ProfileDagInit(ID, Val, ValName, Args, ArgNames);
1597 Init *DagInit::resolveReferences(Record &R, const RecordVal *RV) const {
1598 std::vector<Init*> NewArgs;
1599 for (unsigned i = 0, e = Args.size(); i != e; ++i)
1600 NewArgs.push_back(Args[i]->resolveReferences(R, RV));
1602 Init *Op = Val->resolveReferences(R, RV);
1604 if (Args != NewArgs || Op != Val)
1605 return DagInit::get(Op, ValName, NewArgs, ArgNames);
1607 return const_cast<DagInit *>(this);
1611 std::string DagInit::getAsString() const {
1612 std::string Result = "(" + Val->getAsString();
1613 if (!ValName.empty())
1614 Result += ":" + ValName;
1615 if (!Args.empty()) {
1616 Result += " " + Args[0]->getAsString();
1617 if (!ArgNames[0].empty()) Result += ":$" + ArgNames[0];
1618 for (unsigned i = 1, e = Args.size(); i != e; ++i) {
1619 Result += ", " + Args[i]->getAsString();
1620 if (!ArgNames[i].empty()) Result += ":$" + ArgNames[i];
1623 return Result + ")";
1627 //===----------------------------------------------------------------------===//
1628 // Other implementations
1629 //===----------------------------------------------------------------------===//
1631 RecordVal::RecordVal(Init *N, RecTy *T, unsigned P)
1632 : Name(N), Ty(T), Prefix(P) {
1633 Value = Ty->convertValue(UnsetInit::get());
1634 assert(Value && "Cannot create unset value for current type!");
1637 RecordVal::RecordVal(const std::string &N, RecTy *T, unsigned P)
1638 : Name(StringInit::get(N)), Ty(T), Prefix(P) {
1639 Value = Ty->convertValue(UnsetInit::get());
1640 assert(Value && "Cannot create unset value for current type!");
1643 const std::string &RecordVal::getName() const {
1644 StringInit *NameString = dyn_cast<StringInit>(Name);
1645 assert(NameString && "RecordVal name is not a string!");
1646 return NameString->getValue();
1649 void RecordVal::dump() const { errs() << *this; }
1651 void RecordVal::print(raw_ostream &OS, bool PrintSem) const {
1652 if (getPrefix()) OS << "field ";
1653 OS << *getType() << " " << getNameInitAsString();
1656 OS << " = " << *getValue();
1658 if (PrintSem) OS << ";\n";
1661 unsigned Record::LastID = 0;
1663 void Record::init() {
1666 // Every record potentially has a def at the top. This value is
1667 // replaced with the top-level def name at instantiation time.
1668 RecordVal DN("NAME", StringRecTy::get(), 0);
1672 void Record::checkName() {
1673 // Ensure the record name has string type.
1674 const TypedInit *TypedName = dyn_cast<const TypedInit>(Name);
1675 assert(TypedName && "Record name is not typed!");
1676 RecTy *Type = TypedName->getType();
1677 if (!isa<StringRecTy>(Type))
1678 PrintFatalError(getLoc(), "Record name is not a string!");
1681 DefInit *Record::getDefInit() {
1683 TheInit = new DefInit(this, new RecordRecTy(this));
1687 const std::string &Record::getName() const {
1688 const StringInit *NameString = dyn_cast<StringInit>(Name);
1689 assert(NameString && "Record name is not a string!");
1690 return NameString->getValue();
1693 void Record::setName(Init *NewName) {
1696 // DO NOT resolve record values to the name at this point because
1697 // there might be default values for arguments of this def. Those
1698 // arguments might not have been resolved yet so we don't want to
1699 // prematurely assume values for those arguments were not passed to
1702 // Nonetheless, it may be that some of this Record's values
1703 // reference the record name. Indeed, the reason for having the
1704 // record name be an Init is to provide this flexibility. The extra
1705 // resolve steps after completely instantiating defs takes care of
1706 // this. See TGParser::ParseDef and TGParser::ParseDefm.
1709 void Record::setName(const std::string &Name) {
1710 setName(StringInit::get(Name));
1713 /// resolveReferencesTo - If anything in this record refers to RV, replace the
1714 /// reference to RV with the RHS of RV. If RV is null, we resolve all possible
1716 void Record::resolveReferencesTo(const RecordVal *RV) {
1717 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1718 if (RV == &Values[i]) // Skip resolve the same field as the given one
1720 if (Init *V = Values[i].getValue())
1721 if (Values[i].setValue(V->resolveReferences(*this, RV)))
1722 PrintFatalError(getLoc(), "Invalid value is found when setting '"
1723 + Values[i].getNameInitAsString()
1724 + "' after resolving references"
1725 + (RV ? " against '" + RV->getNameInitAsString()
1727 + RV->getValue()->getAsUnquotedString() + ")"
1731 Init *OldName = getNameInit();
1732 Init *NewName = Name->resolveReferences(*this, RV);
1733 if (NewName != OldName) {
1734 // Re-register with RecordKeeper.
1739 void Record::dump() const { errs() << *this; }
1741 raw_ostream &llvm::operator<<(raw_ostream &OS, const Record &R) {
1742 OS << R.getNameInitAsString();
1744 const std::vector<Init *> &TArgs = R.getTemplateArgs();
1745 if (!TArgs.empty()) {
1747 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1749 const RecordVal *RV = R.getValue(TArgs[i]);
1750 assert(RV && "Template argument record not found??");
1751 RV->print(OS, false);
1757 const std::vector<Record*> &SC = R.getSuperClasses();
1760 for (unsigned i = 0, e = SC.size(); i != e; ++i)
1761 OS << " " << SC[i]->getNameInitAsString();
1765 const std::vector<RecordVal> &Vals = R.getValues();
1766 for (unsigned i = 0, e = Vals.size(); i != e; ++i)
1767 if (Vals[i].getPrefix() && !R.isTemplateArg(Vals[i].getName()))
1769 for (unsigned i = 0, e = Vals.size(); i != e; ++i)
1770 if (!Vals[i].getPrefix() && !R.isTemplateArg(Vals[i].getName()))
1776 /// getValueInit - Return the initializer for a value with the specified name,
1777 /// or abort if the field does not exist.
1779 Init *Record::getValueInit(StringRef FieldName) const {
1780 const RecordVal *R = getValue(FieldName);
1781 if (!R || !R->getValue())
1782 PrintFatalError(getLoc(), "Record `" + getName() +
1783 "' does not have a field named `" + FieldName + "'!\n");
1784 return R->getValue();
1788 /// getValueAsString - This method looks up the specified field and returns its
1789 /// value as a string, aborts if the field does not exist or if
1790 /// the value is not a string.
1792 std::string Record::getValueAsString(StringRef FieldName) const {
1793 const RecordVal *R = getValue(FieldName);
1794 if (!R || !R->getValue())
1795 PrintFatalError(getLoc(), "Record `" + getName() +
1796 "' does not have a field named `" + FieldName + "'!\n");
1798 if (StringInit *SI = dyn_cast<StringInit>(R->getValue()))
1799 return SI->getValue();
1800 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1801 FieldName + "' does not have a string initializer!");
1804 /// getValueAsBitsInit - This method looks up the specified field and returns
1805 /// its value as a BitsInit, aborts if the field does not exist or if
1806 /// the value is not the right type.
1808 BitsInit *Record::getValueAsBitsInit(StringRef FieldName) const {
1809 const RecordVal *R = getValue(FieldName);
1810 if (!R || !R->getValue())
1811 PrintFatalError(getLoc(), "Record `" + getName() +
1812 "' does not have a field named `" + FieldName + "'!\n");
1814 if (BitsInit *BI = dyn_cast<BitsInit>(R->getValue()))
1816 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1817 FieldName + "' does not have a BitsInit initializer!");
1820 /// getValueAsListInit - This method looks up the specified field and returns
1821 /// its value as a ListInit, aborting if the field does not exist or if
1822 /// the value is not the right type.
1824 ListInit *Record::getValueAsListInit(StringRef FieldName) const {
1825 const RecordVal *R = getValue(FieldName);
1826 if (!R || !R->getValue())
1827 PrintFatalError(getLoc(), "Record `" + getName() +
1828 "' does not have a field named `" + FieldName + "'!\n");
1830 if (ListInit *LI = dyn_cast<ListInit>(R->getValue()))
1832 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1833 FieldName + "' does not have a list initializer!");
1836 /// getValueAsListOfDefs - This method looks up the specified field and returns
1837 /// its value as a vector of records, aborting if the field does not exist
1838 /// or if the value is not the right type.
1840 std::vector<Record*>
1841 Record::getValueAsListOfDefs(StringRef FieldName) const {
1842 ListInit *List = getValueAsListInit(FieldName);
1843 std::vector<Record*> Defs;
1844 for (unsigned i = 0; i < List->getSize(); i++) {
1845 if (DefInit *DI = dyn_cast<DefInit>(List->getElement(i))) {
1846 Defs.push_back(DI->getDef());
1848 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1849 FieldName + "' list is not entirely DefInit!");
1855 /// getValueAsInt - This method looks up the specified field and returns its
1856 /// value as an int64_t, aborting if the field does not exist or if the value
1857 /// is not the right type.
1859 int64_t Record::getValueAsInt(StringRef FieldName) const {
1860 const RecordVal *R = getValue(FieldName);
1861 if (!R || !R->getValue())
1862 PrintFatalError(getLoc(), "Record `" + getName() +
1863 "' does not have a field named `" + FieldName + "'!\n");
1865 if (IntInit *II = dyn_cast<IntInit>(R->getValue()))
1866 return II->getValue();
1867 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1868 FieldName + "' does not have an int initializer!");
1871 /// getValueAsListOfInts - This method looks up the specified field and returns
1872 /// its value as a vector of integers, aborting if the field does not exist or
1873 /// if the value is not the right type.
1875 std::vector<int64_t>
1876 Record::getValueAsListOfInts(StringRef FieldName) const {
1877 ListInit *List = getValueAsListInit(FieldName);
1878 std::vector<int64_t> Ints;
1879 for (unsigned i = 0; i < List->getSize(); i++) {
1880 if (IntInit *II = dyn_cast<IntInit>(List->getElement(i))) {
1881 Ints.push_back(II->getValue());
1883 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1884 FieldName + "' does not have a list of ints initializer!");
1890 /// getValueAsListOfStrings - This method looks up the specified field and
1891 /// returns its value as a vector of strings, aborting if the field does not
1892 /// exist or if the value is not the right type.
1894 std::vector<std::string>
1895 Record::getValueAsListOfStrings(StringRef FieldName) const {
1896 ListInit *List = getValueAsListInit(FieldName);
1897 std::vector<std::string> Strings;
1898 for (unsigned i = 0; i < List->getSize(); i++) {
1899 if (StringInit *II = dyn_cast<StringInit>(List->getElement(i))) {
1900 Strings.push_back(II->getValue());
1902 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1903 FieldName + "' does not have a list of strings initializer!");
1909 /// getValueAsDef - This method looks up the specified field and returns its
1910 /// value as a Record, aborting if the field does not exist or if the value
1911 /// is not the right type.
1913 Record *Record::getValueAsDef(StringRef FieldName) const {
1914 const RecordVal *R = getValue(FieldName);
1915 if (!R || !R->getValue())
1916 PrintFatalError(getLoc(), "Record `" + getName() +
1917 "' does not have a field named `" + FieldName + "'!\n");
1919 if (DefInit *DI = dyn_cast<DefInit>(R->getValue()))
1920 return DI->getDef();
1921 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1922 FieldName + "' does not have a def initializer!");
1925 /// getValueAsBit - This method looks up the specified field and returns its
1926 /// value as a bit, aborting if the field does not exist or if the value is
1927 /// not the right type.
1929 bool Record::getValueAsBit(StringRef FieldName) const {
1930 const RecordVal *R = getValue(FieldName);
1931 if (!R || !R->getValue())
1932 PrintFatalError(getLoc(), "Record `" + getName() +
1933 "' does not have a field named `" + FieldName + "'!\n");
1935 if (BitInit *BI = dyn_cast<BitInit>(R->getValue()))
1936 return BI->getValue();
1937 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1938 FieldName + "' does not have a bit initializer!");
1941 bool Record::getValueAsBitOrUnset(StringRef FieldName, bool &Unset) const {
1942 const RecordVal *R = getValue(FieldName);
1943 if (!R || !R->getValue())
1944 PrintFatalError(getLoc(), "Record `" + getName() +
1945 "' does not have a field named `" + FieldName.str() + "'!\n");
1947 if (isa<UnsetInit>(R->getValue())) {
1952 if (BitInit *BI = dyn_cast<BitInit>(R->getValue()))
1953 return BI->getValue();
1954 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1955 FieldName + "' does not have a bit initializer!");
1958 /// getValueAsDag - This method looks up the specified field and returns its
1959 /// value as an Dag, aborting if the field does not exist or if the value is
1960 /// not the right type.
1962 DagInit *Record::getValueAsDag(StringRef FieldName) const {
1963 const RecordVal *R = getValue(FieldName);
1964 if (!R || !R->getValue())
1965 PrintFatalError(getLoc(), "Record `" + getName() +
1966 "' does not have a field named `" + FieldName + "'!\n");
1968 if (DagInit *DI = dyn_cast<DagInit>(R->getValue()))
1970 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1971 FieldName + "' does not have a dag initializer!");
1975 void MultiClass::dump() const {
1976 errs() << "Record:\n";
1979 errs() << "Defs:\n";
1980 for (RecordVector::const_iterator r = DefPrototypes.begin(),
1981 rend = DefPrototypes.end();
1989 void RecordKeeper::dump() const { errs() << *this; }
1991 raw_ostream &llvm::operator<<(raw_ostream &OS, const RecordKeeper &RK) {
1992 OS << "------------- Classes -----------------\n";
1993 const auto &Classes = RK.getClasses();
1994 for (const auto &C : Classes)
1995 OS << "class " << *C.second;
1997 OS << "------------- Defs -----------------\n";
1998 const auto &Defs = RK.getDefs();
1999 for (const auto &D : Defs)
2000 OS << "def " << *D.second;
2005 /// getAllDerivedDefinitions - This method returns all concrete definitions
2006 /// that derive from the specified class name. If a class with the specified
2007 /// name does not exist, an error is printed and true is returned.
2008 std::vector<Record*>
2009 RecordKeeper::getAllDerivedDefinitions(const std::string &ClassName) const {
2010 Record *Class = getClass(ClassName);
2012 PrintFatalError("ERROR: Couldn't find the `" + ClassName + "' class!\n");
2014 std::vector<Record*> Defs;
2015 for (const auto &D : getDefs())
2016 if (D.second->isSubClassOf(Class))
2017 Defs.push_back(D.second.get());
2022 /// QualifyName - Return an Init with a qualifier prefix referring
2023 /// to CurRec's name.
2024 Init *llvm::QualifyName(Record &CurRec, MultiClass *CurMultiClass,
2025 Init *Name, const std::string &Scoper) {
2026 RecTy *Type = cast<TypedInit>(Name)->getType();
2028 BinOpInit *NewName =
2029 BinOpInit::get(BinOpInit::STRCONCAT,
2030 BinOpInit::get(BinOpInit::STRCONCAT,
2031 CurRec.getNameInit(),
2032 StringInit::get(Scoper),
2033 Type)->Fold(&CurRec, CurMultiClass),
2037 if (CurMultiClass && Scoper != "::") {
2039 BinOpInit::get(BinOpInit::STRCONCAT,
2040 BinOpInit::get(BinOpInit::STRCONCAT,
2041 CurMultiClass->Rec.getNameInit(),
2042 StringInit::get("::"),
2043 Type)->Fold(&CurRec, CurMultiClass),
2044 NewName->Fold(&CurRec, CurMultiClass),
2048 return NewName->Fold(&CurRec, CurMultiClass);
2051 /// QualifyName - Return an Init with a qualifier prefix referring
2052 /// to CurRec's name.
2053 Init *llvm::QualifyName(Record &CurRec, MultiClass *CurMultiClass,
2054 const std::string &Name,
2055 const std::string &Scoper) {
2056 return QualifyName(CurRec, CurMultiClass, StringInit::get(Name), Scoper);