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) || isa<BitsRecTy>(Ty) || isa<IntRecTy>(Ty))
118 return VI; // Accept variable if it is already of bit type!
122 bool BitRecTy::baseClassOf(const RecTy *RHS) const{
123 if(RecTy::baseClassOf(RHS) || getRecTyKind() == IntRecTyKind)
125 if(const BitsRecTy *BitsTy = dyn_cast<BitsRecTy>(RHS))
126 return BitsTy->getNumBits() == 1;
130 BitsRecTy *BitsRecTy::get(unsigned Sz) {
131 static std::vector<BitsRecTy*> Shared;
132 if (Sz >= Shared.size())
133 Shared.resize(Sz + 1);
134 BitsRecTy *&Ty = Shared[Sz];
136 Ty = new BitsRecTy(Sz);
140 std::string BitsRecTy::getAsString() const {
141 return "bits<" + utostr(Size) + ">";
144 Init *BitsRecTy::convertValue(UnsetInit *UI) {
145 SmallVector<Init *, 16> NewBits(Size);
147 for (unsigned i = 0; i != Size; ++i)
148 NewBits[i] = UnsetInit::get();
150 return BitsInit::get(NewBits);
153 Init *BitsRecTy::convertValue(BitInit *UI) {
154 if (Size != 1) return nullptr; // Can only convert single bit.
155 return BitsInit::get(UI);
158 /// canFitInBitfield - Return true if the number of bits is large enough to hold
159 /// the integer value.
160 static bool canFitInBitfield(int64_t Value, unsigned NumBits) {
161 // For example, with NumBits == 4, we permit Values from [-7 .. 15].
162 return (NumBits >= sizeof(Value) * 8) ||
163 (Value >> NumBits == 0) || (Value >> (NumBits-1) == -1);
166 /// convertValue from Int initializer to bits type: Split the integer up into the
167 /// appropriate bits.
169 Init *BitsRecTy::convertValue(IntInit *II) {
170 int64_t Value = II->getValue();
171 // Make sure this bitfield is large enough to hold the integer value.
172 if (!canFitInBitfield(Value, Size))
175 SmallVector<Init *, 16> NewBits(Size);
177 for (unsigned i = 0; i != Size; ++i)
178 NewBits[i] = BitInit::get(Value & (1LL << i));
180 return BitsInit::get(NewBits);
183 Init *BitsRecTy::convertValue(BitsInit *BI) {
184 // If the number of bits is right, return it. Otherwise we need to expand or
186 if (BI->getNumBits() == Size) return BI;
190 Init *BitsRecTy::convertValue(TypedInit *VI) {
191 if (Size == 1 && isa<BitRecTy>(VI->getType()))
192 return BitsInit::get(VI);
194 if (VI->getType()->typeIsConvertibleTo(this)) {
195 SmallVector<Init *, 16> NewBits(Size);
197 for (unsigned i = 0; i != Size; ++i)
198 NewBits[i] = VarBitInit::get(VI, i);
199 return BitsInit::get(NewBits);
205 bool BitsRecTy::baseClassOf(const RecTy *RHS) const{
206 if (RecTy::baseClassOf(RHS)) //argument and the receiver are the same type
207 return cast<BitsRecTy>(RHS)->Size == Size;
208 RecTyKind kind = RHS->getRecTyKind();
209 return (kind == BitRecTyKind && Size == 1) || (kind == IntRecTyKind);
212 Init *IntRecTy::convertValue(BitInit *BI) {
213 return IntInit::get(BI->getValue());
216 Init *IntRecTy::convertValue(BitsInit *BI) {
218 for (unsigned i = 0, e = BI->getNumBits(); i != e; ++i)
219 if (BitInit *Bit = dyn_cast<BitInit>(BI->getBit(i))) {
220 Result |= Bit->getValue() << i;
224 return IntInit::get(Result);
227 Init *IntRecTy::convertValue(TypedInit *TI) {
228 if (TI->getType()->typeIsConvertibleTo(this))
229 return TI; // Accept variable if already of the right type!
233 bool IntRecTy::baseClassOf(const RecTy *RHS) const{
234 RecTyKind kind = RHS->getRecTyKind();
235 return kind==BitRecTyKind || kind==BitsRecTyKind || kind==IntRecTyKind;
238 Init *StringRecTy::convertValue(UnOpInit *BO) {
239 if (BO->getOpcode() == UnOpInit::CAST) {
240 Init *L = BO->getOperand()->convertInitializerTo(this);
241 if (!L) return nullptr;
242 if (L != BO->getOperand())
243 return UnOpInit::get(UnOpInit::CAST, L, new StringRecTy);
247 return convertValue((TypedInit*)BO);
250 Init *StringRecTy::convertValue(BinOpInit *BO) {
251 if (BO->getOpcode() == BinOpInit::STRCONCAT) {
252 Init *L = BO->getLHS()->convertInitializerTo(this);
253 Init *R = BO->getRHS()->convertInitializerTo(this);
254 if (!L || !R) return nullptr;
255 if (L != BO->getLHS() || R != BO->getRHS())
256 return BinOpInit::get(BinOpInit::STRCONCAT, L, R, new StringRecTy);
260 return convertValue((TypedInit*)BO);
264 Init *StringRecTy::convertValue(TypedInit *TI) {
265 if (isa<StringRecTy>(TI->getType()))
266 return TI; // Accept variable if already of the right type!
270 std::string ListRecTy::getAsString() const {
271 return "list<" + Ty->getAsString() + ">";
274 Init *ListRecTy::convertValue(ListInit *LI) {
275 std::vector<Init*> Elements;
277 // Verify that all of the elements of the list are subclasses of the
278 // appropriate class!
279 for (unsigned i = 0, e = LI->getSize(); i != e; ++i)
280 if (Init *CI = LI->getElement(i)->convertInitializerTo(Ty))
281 Elements.push_back(CI);
285 if (!isa<ListRecTy>(LI->getType()))
288 return ListInit::get(Elements, this);
291 Init *ListRecTy::convertValue(TypedInit *TI) {
292 // Ensure that TI is compatible with our class.
293 if (ListRecTy *LRT = dyn_cast<ListRecTy>(TI->getType()))
294 if (LRT->getElementType()->typeIsConvertibleTo(getElementType()))
299 bool ListRecTy::baseClassOf(const RecTy *RHS) const{
300 if(const ListRecTy* ListTy = dyn_cast<ListRecTy>(RHS))
301 return ListTy->getElementType()->typeIsConvertibleTo(Ty);
305 Init *DagRecTy::convertValue(TypedInit *TI) {
306 if (TI->getType()->typeIsConvertibleTo(this))
311 Init *DagRecTy::convertValue(UnOpInit *BO) {
312 if (BO->getOpcode() == UnOpInit::CAST) {
313 Init *L = BO->getOperand()->convertInitializerTo(this);
314 if (!L) return nullptr;
315 if (L != BO->getOperand())
316 return UnOpInit::get(UnOpInit::CAST, L, new DagRecTy);
322 Init *DagRecTy::convertValue(BinOpInit *BO) {
323 if (BO->getOpcode() == BinOpInit::CONCAT) {
324 Init *L = BO->getLHS()->convertInitializerTo(this);
325 Init *R = BO->getRHS()->convertInitializerTo(this);
326 if (!L || !R) return nullptr;
327 if (L != BO->getLHS() || R != BO->getRHS())
328 return BinOpInit::get(BinOpInit::CONCAT, L, R, new DagRecTy);
334 RecordRecTy *RecordRecTy::get(Record *R) {
335 return dyn_cast<RecordRecTy>(R->getDefInit()->getType());
338 std::string RecordRecTy::getAsString() const {
339 return Rec->getName();
342 Init *RecordRecTy::convertValue(DefInit *DI) {
343 // Ensure that DI is a subclass of Rec.
344 if (!DI->getDef()->isSubClassOf(Rec))
349 Init *RecordRecTy::convertValue(TypedInit *TI) {
350 // Ensure that TI is compatible with Rec.
351 if (RecordRecTy *RRT = dyn_cast<RecordRecTy>(TI->getType()))
352 if (RRT->getRecord()->isSubClassOf(getRecord()) ||
353 RRT->getRecord() == getRecord())
358 bool RecordRecTy::baseClassOf(const RecTy *RHS) const{
359 const RecordRecTy *RTy = dyn_cast<RecordRecTy>(RHS);
363 if (Rec == RTy->getRecord() || RTy->getRecord()->isSubClassOf(Rec))
366 const std::vector<Record*> &SC = Rec->getSuperClasses();
367 for (unsigned i = 0, e = SC.size(); i != e; ++i)
368 if (RTy->getRecord()->isSubClassOf(SC[i]))
374 /// resolveTypes - Find a common type that T1 and T2 convert to.
375 /// Return 0 if no such type exists.
377 RecTy *llvm::resolveTypes(RecTy *T1, RecTy *T2) {
378 if (T1->typeIsConvertibleTo(T2))
380 if (T2->typeIsConvertibleTo(T1))
383 // If one is a Record type, check superclasses
384 if (RecordRecTy *RecTy1 = dyn_cast<RecordRecTy>(T1)) {
385 // See if T2 inherits from a type T1 also inherits from
386 const std::vector<Record *> &T1SuperClasses =
387 RecTy1->getRecord()->getSuperClasses();
388 for(std::vector<Record *>::const_iterator i = T1SuperClasses.begin(),
389 iend = T1SuperClasses.end();
392 RecordRecTy *SuperRecTy1 = RecordRecTy::get(*i);
393 RecTy *NewType1 = resolveTypes(SuperRecTy1, T2);
395 if (NewType1 != SuperRecTy1) {
402 if (RecordRecTy *RecTy2 = dyn_cast<RecordRecTy>(T2)) {
403 // See if T1 inherits from a type T2 also inherits from
404 const std::vector<Record *> &T2SuperClasses =
405 RecTy2->getRecord()->getSuperClasses();
406 for (std::vector<Record *>::const_iterator i = T2SuperClasses.begin(),
407 iend = T2SuperClasses.end();
410 RecordRecTy *SuperRecTy2 = RecordRecTy::get(*i);
411 RecTy *NewType2 = resolveTypes(T1, SuperRecTy2);
413 if (NewType2 != SuperRecTy2) {
424 //===----------------------------------------------------------------------===//
425 // Initializer implementations
426 //===----------------------------------------------------------------------===//
428 void Init::anchor() { }
429 void Init::dump() const { return print(errs()); }
431 void UnsetInit::anchor() { }
433 UnsetInit *UnsetInit::get() {
434 static UnsetInit TheInit;
438 void BitInit::anchor() { }
440 BitInit *BitInit::get(bool V) {
441 static BitInit True(true);
442 static BitInit False(false);
444 return V ? &True : &False;
448 ProfileBitsInit(FoldingSetNodeID &ID, ArrayRef<Init *> Range) {
449 ID.AddInteger(Range.size());
451 for (ArrayRef<Init *>::iterator i = Range.begin(),
458 BitsInit *BitsInit::get(ArrayRef<Init *> Range) {
459 typedef FoldingSet<BitsInit> Pool;
463 ProfileBitsInit(ID, Range);
466 if (BitsInit *I = ThePool.FindNodeOrInsertPos(ID, IP))
469 BitsInit *I = new BitsInit(Range);
470 ThePool.InsertNode(I, IP);
475 void BitsInit::Profile(FoldingSetNodeID &ID) const {
476 ProfileBitsInit(ID, Bits);
480 BitsInit::convertInitializerBitRange(const std::vector<unsigned> &Bits) const {
481 SmallVector<Init *, 16> NewBits(Bits.size());
483 for (unsigned i = 0, e = Bits.size(); i != e; ++i) {
484 if (Bits[i] >= getNumBits())
486 NewBits[i] = getBit(Bits[i]);
488 return BitsInit::get(NewBits);
491 std::string BitsInit::getAsString() const {
492 std::string Result = "{ ";
493 for (unsigned i = 0, e = getNumBits(); i != e; ++i) {
494 if (i) Result += ", ";
495 if (Init *Bit = getBit(e-i-1))
496 Result += Bit->getAsString();
500 return Result + " }";
503 // Fix bit initializer to preserve the behavior that bit reference from a unset
504 // bits initializer will resolve into VarBitInit to keep the field name and bit
505 // number used in targets with fixed insn length.
506 static Init *fixBitInit(const RecordVal *RV, Init *Before, Init *After) {
507 if (RV || After != UnsetInit::get())
512 // resolveReferences - If there are any field references that refer to fields
513 // that have been filled in, we can propagate the values now.
515 Init *BitsInit::resolveReferences(Record &R, const RecordVal *RV) const {
516 bool Changed = false;
517 SmallVector<Init *, 16> NewBits(getNumBits());
519 Init *CachedInit = nullptr;
520 Init *CachedBitVar = nullptr;
521 bool CachedBitVarChanged = false;
523 for (unsigned i = 0, e = getNumBits(); i != e; ++i) {
524 Init *CurBit = Bits[i];
525 Init *CurBitVar = CurBit->getBitVar();
529 if (CurBitVar == CachedBitVar) {
530 if (CachedBitVarChanged) {
531 Init *Bit = CachedInit->getBit(CurBit->getBitNum());
532 NewBits[i] = fixBitInit(RV, CurBit, Bit);
536 CachedBitVar = CurBitVar;
537 CachedBitVarChanged = false;
542 CurBitVar = CurBitVar->resolveReferences(R, RV);
543 CachedBitVarChanged |= B != CurBitVar;
544 Changed |= B != CurBitVar;
545 } while (B != CurBitVar);
546 CachedInit = CurBitVar;
548 if (CachedBitVarChanged) {
549 Init *Bit = CurBitVar->getBit(CurBit->getBitNum());
550 NewBits[i] = fixBitInit(RV, CurBit, Bit);
555 return BitsInit::get(NewBits);
557 return const_cast<BitsInit *>(this);
562 class Pool : public T {
568 for (typename T::iterator I = this->begin(), E = this->end(); I != E; ++I) {
569 typename T::value_type &Item = *I;
575 IntInit *IntInit::get(int64_t V) {
576 static Pool<DenseMap<int64_t, IntInit *> > ThePool;
578 IntInit *&I = ThePool[V];
579 if (!I) I = new IntInit(V);
583 std::string IntInit::getAsString() const {
584 return itostr(Value);
588 IntInit::convertInitializerBitRange(const std::vector<unsigned> &Bits) const {
589 SmallVector<Init *, 16> NewBits(Bits.size());
591 for (unsigned i = 0, e = Bits.size(); i != e; ++i) {
595 NewBits[i] = BitInit::get(Value & (INT64_C(1) << Bits[i]));
597 return BitsInit::get(NewBits);
600 void StringInit::anchor() { }
602 StringInit *StringInit::get(StringRef V) {
603 static Pool<StringMap<StringInit *> > ThePool;
605 StringInit *&I = ThePool[V];
606 if (!I) I = new StringInit(V);
610 static void ProfileListInit(FoldingSetNodeID &ID,
611 ArrayRef<Init *> Range,
613 ID.AddInteger(Range.size());
614 ID.AddPointer(EltTy);
616 for (ArrayRef<Init *>::iterator i = Range.begin(),
623 ListInit *ListInit::get(ArrayRef<Init *> Range, RecTy *EltTy) {
624 typedef FoldingSet<ListInit> Pool;
626 static std::vector<std::unique_ptr<ListInit>> TheActualPool;
629 ProfileListInit(ID, Range, EltTy);
632 if (ListInit *I = ThePool.FindNodeOrInsertPos(ID, IP))
635 ListInit *I = new ListInit(Range, EltTy);
636 ThePool.InsertNode(I, IP);
637 TheActualPool.push_back(std::unique_ptr<ListInit>(I));
641 void ListInit::Profile(FoldingSetNodeID &ID) const {
642 ListRecTy *ListType = dyn_cast<ListRecTy>(getType());
643 assert(ListType && "Bad type for ListInit!");
644 RecTy *EltTy = ListType->getElementType();
646 ProfileListInit(ID, Values, EltTy);
650 ListInit::convertInitListSlice(const std::vector<unsigned> &Elements) const {
651 std::vector<Init*> Vals;
652 for (unsigned i = 0, e = Elements.size(); i != e; ++i) {
653 if (Elements[i] >= getSize())
655 Vals.push_back(getElement(Elements[i]));
657 return ListInit::get(Vals, getType());
660 Record *ListInit::getElementAsRecord(unsigned i) const {
661 assert(i < Values.size() && "List element index out of range!");
662 DefInit *DI = dyn_cast<DefInit>(Values[i]);
664 PrintFatalError("Expected record in list!");
668 Init *ListInit::resolveReferences(Record &R, const RecordVal *RV) const {
669 std::vector<Init*> Resolved;
670 Resolved.reserve(getSize());
671 bool Changed = false;
673 for (unsigned i = 0, e = getSize(); i != e; ++i) {
675 Init *CurElt = getElement(i);
679 CurElt = CurElt->resolveReferences(R, RV);
680 Changed |= E != CurElt;
681 } while (E != CurElt);
682 Resolved.push_back(E);
686 return ListInit::get(Resolved, getType());
687 return const_cast<ListInit *>(this);
690 Init *ListInit::resolveListElementReference(Record &R, const RecordVal *IRV,
691 unsigned Elt) const {
692 if (Elt >= getSize())
693 return nullptr; // Out of range reference.
694 Init *E = getElement(Elt);
695 // If the element is set to some value, or if we are resolving a reference
696 // to a specific variable and that variable is explicitly unset, then
697 // replace the VarListElementInit with it.
698 if (IRV || !isa<UnsetInit>(E))
703 std::string ListInit::getAsString() const {
704 std::string Result = "[";
705 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
706 if (i) Result += ", ";
707 Result += Values[i]->getAsString();
712 Init *OpInit::resolveListElementReference(Record &R, const RecordVal *IRV,
713 unsigned Elt) const {
714 Init *Resolved = resolveReferences(R, IRV);
715 OpInit *OResolved = dyn_cast<OpInit>(Resolved);
717 Resolved = OResolved->Fold(&R, nullptr);
720 if (Resolved != this) {
721 TypedInit *Typed = dyn_cast<TypedInit>(Resolved);
722 assert(Typed && "Expected typed init for list reference");
724 Init *New = Typed->resolveListElementReference(R, IRV, Elt);
727 return VarListElementInit::get(Typed, Elt);
734 Init *OpInit::getBit(unsigned Bit) const {
735 if (getType() == BitRecTy::get())
736 return const_cast<OpInit*>(this);
737 return VarBitInit::get(const_cast<OpInit*>(this), Bit);
740 UnOpInit *UnOpInit::get(UnaryOp opc, Init *lhs, RecTy *Type) {
741 typedef std::pair<std::pair<unsigned, Init *>, RecTy *> Key;
742 static Pool<DenseMap<Key, UnOpInit *> > ThePool;
744 Key TheKey(std::make_pair(std::make_pair(opc, lhs), Type));
746 UnOpInit *&I = ThePool[TheKey];
747 if (!I) I = new UnOpInit(opc, lhs, Type);
751 Init *UnOpInit::Fold(Record *CurRec, MultiClass *CurMultiClass) const {
752 switch (getOpcode()) {
754 if (getType()->getAsString() == "string") {
755 if (StringInit *LHSs = dyn_cast<StringInit>(LHS))
758 if (DefInit *LHSd = dyn_cast<DefInit>(LHS))
759 return StringInit::get(LHSd->getDef()->getName());
761 if (IntInit *LHSi = dyn_cast<IntInit>(LHS))
762 return StringInit::get(LHSi->getAsString());
764 if (StringInit *LHSs = dyn_cast<StringInit>(LHS)) {
765 std::string Name = LHSs->getValue();
767 // From TGParser::ParseIDValue
769 if (const RecordVal *RV = CurRec->getValue(Name)) {
770 if (RV->getType() != getType())
771 PrintFatalError("type mismatch in cast");
772 return VarInit::get(Name, RV->getType());
775 Init *TemplateArgName = QualifyName(*CurRec, CurMultiClass, Name,
778 if (CurRec->isTemplateArg(TemplateArgName)) {
779 const RecordVal *RV = CurRec->getValue(TemplateArgName);
780 assert(RV && "Template arg doesn't exist??");
782 if (RV->getType() != getType())
783 PrintFatalError("type mismatch in cast");
785 return VarInit::get(TemplateArgName, RV->getType());
790 Init *MCName = QualifyName(CurMultiClass->Rec, CurMultiClass, Name, "::");
792 if (CurMultiClass->Rec.isTemplateArg(MCName)) {
793 const RecordVal *RV = CurMultiClass->Rec.getValue(MCName);
794 assert(RV && "Template arg doesn't exist??");
796 if (RV->getType() != getType())
797 PrintFatalError("type mismatch in cast");
799 return VarInit::get(MCName, RV->getType());
803 if (Record *D = (CurRec->getRecords()).getDef(Name))
804 return DefInit::get(D);
806 PrintFatalError(CurRec->getLoc(),
807 "Undefined reference:'" + Name + "'\n");
813 if (ListInit *LHSl = dyn_cast<ListInit>(LHS)) {
814 assert(LHSl->getSize() != 0 && "Empty list in car");
815 return LHSl->getElement(0);
820 if (ListInit *LHSl = dyn_cast<ListInit>(LHS)) {
821 assert(LHSl->getSize() != 0 && "Empty list in cdr");
822 // Note the +1. We can't just pass the result of getValues()
824 ArrayRef<Init *>::iterator begin = LHSl->getValues().begin()+1;
825 ArrayRef<Init *>::iterator end = LHSl->getValues().end();
827 ListInit::get(ArrayRef<Init *>(begin, end - begin),
834 if (ListInit *LHSl = dyn_cast<ListInit>(LHS)) {
835 if (LHSl->getSize() == 0) {
836 return IntInit::get(1);
838 return IntInit::get(0);
841 if (StringInit *LHSs = dyn_cast<StringInit>(LHS)) {
842 if (LHSs->getValue().empty()) {
843 return IntInit::get(1);
845 return IntInit::get(0);
852 return const_cast<UnOpInit *>(this);
855 Init *UnOpInit::resolveReferences(Record &R, const RecordVal *RV) const {
856 Init *lhs = LHS->resolveReferences(R, RV);
859 return (UnOpInit::get(getOpcode(), lhs, getType()))->Fold(&R, nullptr);
860 return Fold(&R, nullptr);
863 std::string UnOpInit::getAsString() const {
866 case CAST: Result = "!cast<" + getType()->getAsString() + ">"; break;
867 case HEAD: Result = "!head"; break;
868 case TAIL: Result = "!tail"; break;
869 case EMPTY: Result = "!empty"; break;
871 return Result + "(" + LHS->getAsString() + ")";
874 BinOpInit *BinOpInit::get(BinaryOp opc, Init *lhs,
875 Init *rhs, RecTy *Type) {
877 std::pair<std::pair<unsigned, Init *>, Init *>,
881 static Pool<DenseMap<Key, BinOpInit *> > ThePool;
883 Key TheKey(std::make_pair(std::make_pair(std::make_pair(opc, lhs), rhs),
886 BinOpInit *&I = ThePool[TheKey];
887 if (!I) I = new BinOpInit(opc, lhs, rhs, Type);
891 Init *BinOpInit::Fold(Record *CurRec, MultiClass *CurMultiClass) const {
892 switch (getOpcode()) {
894 DagInit *LHSs = dyn_cast<DagInit>(LHS);
895 DagInit *RHSs = dyn_cast<DagInit>(RHS);
897 DefInit *LOp = dyn_cast<DefInit>(LHSs->getOperator());
898 DefInit *ROp = dyn_cast<DefInit>(RHSs->getOperator());
899 if (!LOp || !ROp || LOp->getDef() != ROp->getDef())
900 PrintFatalError("Concated Dag operators do not match!");
901 std::vector<Init*> Args;
902 std::vector<std::string> ArgNames;
903 for (unsigned i = 0, e = LHSs->getNumArgs(); i != e; ++i) {
904 Args.push_back(LHSs->getArg(i));
905 ArgNames.push_back(LHSs->getArgName(i));
907 for (unsigned i = 0, e = RHSs->getNumArgs(); i != e; ++i) {
908 Args.push_back(RHSs->getArg(i));
909 ArgNames.push_back(RHSs->getArgName(i));
911 return DagInit::get(LHSs->getOperator(), "", Args, ArgNames);
916 ListInit *LHSs = dyn_cast<ListInit>(LHS);
917 ListInit *RHSs = dyn_cast<ListInit>(RHS);
919 std::vector<Init *> Args;
920 Args.insert(Args.end(), LHSs->begin(), LHSs->end());
921 Args.insert(Args.end(), RHSs->begin(), RHSs->end());
922 return ListInit::get(
923 Args, static_cast<ListRecTy *>(LHSs->getType())->getElementType());
928 StringInit *LHSs = dyn_cast<StringInit>(LHS);
929 StringInit *RHSs = dyn_cast<StringInit>(RHS);
931 return StringInit::get(LHSs->getValue() + RHSs->getValue());
935 // try to fold eq comparison for 'bit' and 'int', otherwise fallback
936 // to string objects.
938 dyn_cast_or_null<IntInit>(LHS->convertInitializerTo(IntRecTy::get()));
940 dyn_cast_or_null<IntInit>(RHS->convertInitializerTo(IntRecTy::get()));
943 return IntInit::get(L->getValue() == R->getValue());
945 StringInit *LHSs = dyn_cast<StringInit>(LHS);
946 StringInit *RHSs = dyn_cast<StringInit>(RHS);
948 // Make sure we've resolved
950 return IntInit::get(LHSs->getValue() == RHSs->getValue());
959 dyn_cast_or_null<IntInit>(LHS->convertInitializerTo(IntRecTy::get()));
961 dyn_cast_or_null<IntInit>(RHS->convertInitializerTo(IntRecTy::get()));
963 int64_t LHSv = LHSi->getValue(), RHSv = RHSi->getValue();
965 switch (getOpcode()) {
966 default: llvm_unreachable("Bad opcode!");
967 case ADD: 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 SHL: Result = "!shl"; break;
995 case SRA: Result = "!sra"; break;
996 case SRL: Result = "!srl"; break;
997 case EQ: Result = "!eq"; break;
998 case LISTCONCAT: Result = "!listconcat"; break;
999 case STRCONCAT: Result = "!strconcat"; break;
1001 return Result + "(" + LHS->getAsString() + ", " + RHS->getAsString() + ")";
1004 TernOpInit *TernOpInit::get(TernaryOp opc, Init *lhs,
1005 Init *mhs, Init *rhs,
1009 std::pair<std::pair<unsigned, RecTy *>, Init *>,
1015 typedef DenseMap<Key, TernOpInit *> Pool;
1016 static Pool ThePool;
1018 Key TheKey(std::make_pair(std::make_pair(std::make_pair(std::make_pair(opc,
1024 TernOpInit *&I = ThePool[TheKey];
1025 if (!I) I = new TernOpInit(opc, lhs, mhs, rhs, Type);
1029 static Init *ForeachHelper(Init *LHS, Init *MHS, Init *RHS, RecTy *Type,
1030 Record *CurRec, MultiClass *CurMultiClass);
1032 static Init *EvaluateOperation(OpInit *RHSo, Init *LHS, Init *Arg,
1033 RecTy *Type, Record *CurRec,
1034 MultiClass *CurMultiClass) {
1035 std::vector<Init *> NewOperands;
1037 TypedInit *TArg = dyn_cast<TypedInit>(Arg);
1039 // If this is a dag, recurse
1040 if (TArg && TArg->getType()->getAsString() == "dag") {
1041 Init *Result = ForeachHelper(LHS, Arg, RHSo, Type,
1042 CurRec, CurMultiClass);
1046 for (int i = 0; i < RHSo->getNumOperands(); ++i) {
1047 OpInit *RHSoo = dyn_cast<OpInit>(RHSo->getOperand(i));
1050 Init *Result = EvaluateOperation(RHSoo, LHS, Arg,
1051 Type, CurRec, CurMultiClass);
1053 NewOperands.push_back(Result);
1055 NewOperands.push_back(Arg);
1057 } else if (LHS->getAsString() == RHSo->getOperand(i)->getAsString()) {
1058 NewOperands.push_back(Arg);
1060 NewOperands.push_back(RHSo->getOperand(i));
1064 // Now run the operator and use its result as the new leaf
1065 const OpInit *NewOp = RHSo->clone(NewOperands);
1066 Init *NewVal = NewOp->Fold(CurRec, CurMultiClass);
1067 return (NewVal != NewOp) ? NewVal : nullptr;
1070 static Init *ForeachHelper(Init *LHS, Init *MHS, Init *RHS, RecTy *Type,
1071 Record *CurRec, MultiClass *CurMultiClass) {
1072 DagInit *MHSd = dyn_cast<DagInit>(MHS);
1073 ListInit *MHSl = dyn_cast<ListInit>(MHS);
1075 OpInit *RHSo = dyn_cast<OpInit>(RHS);
1078 PrintFatalError(CurRec->getLoc(), "!foreach requires an operator\n");
1081 TypedInit *LHSt = dyn_cast<TypedInit>(LHS);
1084 PrintFatalError(CurRec->getLoc(), "!foreach requires typed variable\n");
1086 if ((MHSd && isa<DagRecTy>(Type)) || (MHSl && isa<ListRecTy>(Type))) {
1088 Init *Val = MHSd->getOperator();
1089 Init *Result = EvaluateOperation(RHSo, LHS, Val,
1090 Type, CurRec, CurMultiClass);
1095 std::vector<std::pair<Init *, std::string> > args;
1096 for (unsigned int i = 0; i < MHSd->getNumArgs(); ++i) {
1098 std::string ArgName;
1099 Arg = MHSd->getArg(i);
1100 ArgName = MHSd->getArgName(i);
1103 Init *Result = EvaluateOperation(RHSo, LHS, Arg, Type,
1104 CurRec, CurMultiClass);
1109 // TODO: Process arg names
1110 args.push_back(std::make_pair(Arg, ArgName));
1113 return DagInit::get(Val, "", args);
1116 std::vector<Init *> NewOperands;
1117 std::vector<Init *> NewList(MHSl->begin(), MHSl->end());
1119 for (std::vector<Init *>::iterator li = NewList.begin(),
1120 liend = NewList.end();
1124 NewOperands.clear();
1125 for(int i = 0; i < RHSo->getNumOperands(); ++i) {
1126 // First, replace the foreach variable with the list item
1127 if (LHS->getAsString() == RHSo->getOperand(i)->getAsString()) {
1128 NewOperands.push_back(Item);
1130 NewOperands.push_back(RHSo->getOperand(i));
1134 // Now run the operator and use its result as the new list item
1135 const OpInit *NewOp = RHSo->clone(NewOperands);
1136 Init *NewItem = NewOp->Fold(CurRec, CurMultiClass);
1137 if (NewItem != NewOp)
1140 return ListInit::get(NewList, MHSl->getType());
1146 Init *TernOpInit::Fold(Record *CurRec, MultiClass *CurMultiClass) const {
1147 switch (getOpcode()) {
1149 DefInit *LHSd = dyn_cast<DefInit>(LHS);
1150 VarInit *LHSv = dyn_cast<VarInit>(LHS);
1151 StringInit *LHSs = dyn_cast<StringInit>(LHS);
1153 DefInit *MHSd = dyn_cast<DefInit>(MHS);
1154 VarInit *MHSv = dyn_cast<VarInit>(MHS);
1155 StringInit *MHSs = dyn_cast<StringInit>(MHS);
1157 DefInit *RHSd = dyn_cast<DefInit>(RHS);
1158 VarInit *RHSv = dyn_cast<VarInit>(RHS);
1159 StringInit *RHSs = dyn_cast<StringInit>(RHS);
1161 if ((LHSd && MHSd && RHSd)
1162 || (LHSv && MHSv && RHSv)
1163 || (LHSs && MHSs && RHSs)) {
1165 Record *Val = RHSd->getDef();
1166 if (LHSd->getAsString() == RHSd->getAsString()) {
1167 Val = MHSd->getDef();
1169 return DefInit::get(Val);
1172 std::string Val = RHSv->getName();
1173 if (LHSv->getAsString() == RHSv->getAsString()) {
1174 Val = MHSv->getName();
1176 return VarInit::get(Val, getType());
1179 std::string Val = RHSs->getValue();
1181 std::string::size_type found;
1182 std::string::size_type idx = 0;
1184 found = Val.find(LHSs->getValue(), idx);
1185 if (found != std::string::npos) {
1186 Val.replace(found, LHSs->getValue().size(), MHSs->getValue());
1188 idx = found + MHSs->getValue().size();
1189 } while (found != std::string::npos);
1191 return StringInit::get(Val);
1198 Init *Result = ForeachHelper(LHS, MHS, RHS, getType(),
1199 CurRec, CurMultiClass);
1207 IntInit *LHSi = dyn_cast<IntInit>(LHS);
1208 if (Init *I = LHS->convertInitializerTo(IntRecTy::get()))
1209 LHSi = dyn_cast<IntInit>(I);
1211 if (LHSi->getValue()) {
1221 return const_cast<TernOpInit *>(this);
1224 Init *TernOpInit::resolveReferences(Record &R,
1225 const RecordVal *RV) const {
1226 Init *lhs = LHS->resolveReferences(R, RV);
1228 if (Opc == IF && lhs != LHS) {
1229 IntInit *Value = dyn_cast<IntInit>(lhs);
1230 if (Init *I = lhs->convertInitializerTo(IntRecTy::get()))
1231 Value = dyn_cast<IntInit>(I);
1234 if (Value->getValue()) {
1235 Init *mhs = MHS->resolveReferences(R, RV);
1236 return (TernOpInit::get(getOpcode(), lhs, mhs,
1237 RHS, getType()))->Fold(&R, nullptr);
1239 Init *rhs = RHS->resolveReferences(R, RV);
1240 return (TernOpInit::get(getOpcode(), lhs, MHS,
1241 rhs, getType()))->Fold(&R, nullptr);
1246 Init *mhs = MHS->resolveReferences(R, RV);
1247 Init *rhs = RHS->resolveReferences(R, RV);
1249 if (LHS != lhs || MHS != mhs || RHS != rhs)
1250 return (TernOpInit::get(getOpcode(), lhs, mhs, rhs,
1251 getType()))->Fold(&R, nullptr);
1252 return Fold(&R, nullptr);
1255 std::string TernOpInit::getAsString() const {
1258 case SUBST: Result = "!subst"; break;
1259 case FOREACH: Result = "!foreach"; break;
1260 case IF: Result = "!if"; break;
1262 return Result + "(" + LHS->getAsString() + ", " + MHS->getAsString() + ", "
1263 + RHS->getAsString() + ")";
1266 RecTy *TypedInit::getFieldType(const std::string &FieldName) const {
1267 if (RecordRecTy *RecordType = dyn_cast<RecordRecTy>(getType()))
1268 if (RecordVal *Field = RecordType->getRecord()->getValue(FieldName))
1269 return Field->getType();
1274 TypedInit::convertInitializerBitRange(const std::vector<unsigned> &Bits) const {
1275 BitsRecTy *T = dyn_cast<BitsRecTy>(getType());
1276 if (!T) return nullptr; // Cannot subscript a non-bits variable.
1277 unsigned NumBits = T->getNumBits();
1279 SmallVector<Init *, 16> NewBits(Bits.size());
1280 for (unsigned i = 0, e = Bits.size(); i != e; ++i) {
1281 if (Bits[i] >= NumBits)
1284 NewBits[i] = VarBitInit::get(const_cast<TypedInit *>(this), Bits[i]);
1286 return BitsInit::get(NewBits);
1290 TypedInit::convertInitListSlice(const std::vector<unsigned> &Elements) const {
1291 ListRecTy *T = dyn_cast<ListRecTy>(getType());
1292 if (!T) return nullptr; // Cannot subscript a non-list variable.
1294 if (Elements.size() == 1)
1295 return VarListElementInit::get(const_cast<TypedInit *>(this), Elements[0]);
1297 std::vector<Init*> ListInits;
1298 ListInits.reserve(Elements.size());
1299 for (unsigned i = 0, e = Elements.size(); i != e; ++i)
1300 ListInits.push_back(VarListElementInit::get(const_cast<TypedInit *>(this),
1302 return ListInit::get(ListInits, T);
1306 VarInit *VarInit::get(const std::string &VN, RecTy *T) {
1307 Init *Value = StringInit::get(VN);
1308 return VarInit::get(Value, T);
1311 VarInit *VarInit::get(Init *VN, RecTy *T) {
1312 typedef std::pair<RecTy *, Init *> Key;
1313 static Pool<DenseMap<Key, VarInit *> > ThePool;
1315 Key TheKey(std::make_pair(T, VN));
1317 VarInit *&I = ThePool[TheKey];
1318 if (!I) I = new VarInit(VN, T);
1322 const std::string &VarInit::getName() const {
1323 StringInit *NameString = dyn_cast<StringInit>(getNameInit());
1324 assert(NameString && "VarInit name is not a string!");
1325 return NameString->getValue();
1328 Init *VarInit::getBit(unsigned Bit) const {
1329 if (getType() == BitRecTy::get())
1330 return const_cast<VarInit*>(this);
1331 return VarBitInit::get(const_cast<VarInit*>(this), Bit);
1334 Init *VarInit::resolveListElementReference(Record &R,
1335 const RecordVal *IRV,
1336 unsigned Elt) const {
1337 if (R.isTemplateArg(getNameInit())) return nullptr;
1338 if (IRV && IRV->getNameInit() != getNameInit()) return nullptr;
1340 RecordVal *RV = R.getValue(getNameInit());
1341 assert(RV && "Reference to a non-existent variable?");
1342 ListInit *LI = dyn_cast<ListInit>(RV->getValue());
1344 TypedInit *VI = dyn_cast<TypedInit>(RV->getValue());
1345 assert(VI && "Invalid list element!");
1346 return VarListElementInit::get(VI, Elt);
1349 if (Elt >= LI->getSize())
1350 return nullptr; // Out of range reference.
1351 Init *E = LI->getElement(Elt);
1352 // If the element is set to some value, or if we are resolving a reference
1353 // to a specific variable and that variable is explicitly unset, then
1354 // replace the VarListElementInit with it.
1355 if (IRV || !isa<UnsetInit>(E))
1361 RecTy *VarInit::getFieldType(const std::string &FieldName) const {
1362 if (RecordRecTy *RTy = dyn_cast<RecordRecTy>(getType()))
1363 if (const RecordVal *RV = RTy->getRecord()->getValue(FieldName))
1364 return RV->getType();
1368 Init *VarInit::getFieldInit(Record &R, const RecordVal *RV,
1369 const std::string &FieldName) const {
1370 if (isa<RecordRecTy>(getType()))
1371 if (const RecordVal *Val = R.getValue(VarName)) {
1372 if (RV != Val && (RV || isa<UnsetInit>(Val->getValue())))
1374 Init *TheInit = Val->getValue();
1375 assert(TheInit != this && "Infinite loop detected!");
1376 if (Init *I = TheInit->getFieldInit(R, RV, FieldName))
1384 /// resolveReferences - This method is used by classes that refer to other
1385 /// variables which may not be defined at the time the expression is formed.
1386 /// If a value is set for the variable later, this method will be called on
1387 /// users of the value to allow the value to propagate out.
1389 Init *VarInit::resolveReferences(Record &R, const RecordVal *RV) const {
1390 if (RecordVal *Val = R.getValue(VarName))
1391 if (RV == Val || (!RV && !isa<UnsetInit>(Val->getValue())))
1392 return Val->getValue();
1393 return const_cast<VarInit *>(this);
1396 VarBitInit *VarBitInit::get(TypedInit *T, unsigned B) {
1397 typedef std::pair<TypedInit *, unsigned> Key;
1398 typedef DenseMap<Key, VarBitInit *> Pool;
1400 static Pool ThePool;
1402 Key TheKey(std::make_pair(T, B));
1404 VarBitInit *&I = ThePool[TheKey];
1405 if (!I) I = new VarBitInit(T, B);
1409 std::string VarBitInit::getAsString() const {
1410 return TI->getAsString() + "{" + utostr(Bit) + "}";
1413 Init *VarBitInit::resolveReferences(Record &R, const RecordVal *RV) const {
1414 Init *I = TI->resolveReferences(R, RV);
1416 return I->getBit(getBitNum());
1418 return const_cast<VarBitInit*>(this);
1421 VarListElementInit *VarListElementInit::get(TypedInit *T,
1423 typedef std::pair<TypedInit *, unsigned> Key;
1424 typedef DenseMap<Key, VarListElementInit *> Pool;
1426 static Pool ThePool;
1428 Key TheKey(std::make_pair(T, E));
1430 VarListElementInit *&I = ThePool[TheKey];
1431 if (!I) I = new VarListElementInit(T, E);
1435 std::string VarListElementInit::getAsString() const {
1436 return TI->getAsString() + "[" + utostr(Element) + "]";
1440 VarListElementInit::resolveReferences(Record &R, const RecordVal *RV) const {
1441 if (Init *I = getVariable()->resolveListElementReference(R, RV,
1444 return const_cast<VarListElementInit *>(this);
1447 Init *VarListElementInit::getBit(unsigned Bit) const {
1448 if (getType() == BitRecTy::get())
1449 return const_cast<VarListElementInit*>(this);
1450 return VarBitInit::get(const_cast<VarListElementInit*>(this), Bit);
1453 Init *VarListElementInit:: resolveListElementReference(Record &R,
1454 const RecordVal *RV,
1455 unsigned Elt) const {
1456 Init *Result = TI->resolveListElementReference(R, RV, Element);
1459 if (TypedInit *TInit = dyn_cast<TypedInit>(Result)) {
1460 Init *Result2 = TInit->resolveListElementReference(R, RV, Elt);
1461 if (Result2) return Result2;
1462 return new VarListElementInit(TInit, Elt);
1470 DefInit *DefInit::get(Record *R) {
1471 return R->getDefInit();
1474 RecTy *DefInit::getFieldType(const std::string &FieldName) const {
1475 if (const RecordVal *RV = Def->getValue(FieldName))
1476 return RV->getType();
1480 Init *DefInit::getFieldInit(Record &R, const RecordVal *RV,
1481 const std::string &FieldName) const {
1482 return Def->getValue(FieldName)->getValue();
1486 std::string DefInit::getAsString() const {
1487 return Def->getName();
1490 FieldInit *FieldInit::get(Init *R, const std::string &FN) {
1491 typedef std::pair<Init *, TableGenStringKey> Key;
1492 typedef DenseMap<Key, FieldInit *> Pool;
1493 static Pool ThePool;
1495 Key TheKey(std::make_pair(R, FN));
1497 FieldInit *&I = ThePool[TheKey];
1498 if (!I) I = new FieldInit(R, FN);
1502 Init *FieldInit::getBit(unsigned Bit) const {
1503 if (getType() == BitRecTy::get())
1504 return const_cast<FieldInit*>(this);
1505 return VarBitInit::get(const_cast<FieldInit*>(this), Bit);
1508 Init *FieldInit::resolveListElementReference(Record &R, const RecordVal *RV,
1509 unsigned Elt) const {
1510 if (Init *ListVal = Rec->getFieldInit(R, RV, FieldName))
1511 if (ListInit *LI = dyn_cast<ListInit>(ListVal)) {
1512 if (Elt >= LI->getSize()) return nullptr;
1513 Init *E = LI->getElement(Elt);
1515 // If the element is set to some value, or if we are resolving a
1516 // reference to a specific variable and that variable is explicitly
1517 // unset, then replace the VarListElementInit with it.
1518 if (RV || !isa<UnsetInit>(E))
1524 Init *FieldInit::resolveReferences(Record &R, const RecordVal *RV) const {
1525 Init *NewRec = RV ? Rec->resolveReferences(R, RV) : Rec;
1527 Init *BitsVal = NewRec->getFieldInit(R, RV, FieldName);
1529 Init *BVR = BitsVal->resolveReferences(R, RV);
1530 return BVR->isComplete() ? BVR : const_cast<FieldInit *>(this);
1533 if (NewRec != Rec) {
1534 return FieldInit::get(NewRec, FieldName);
1536 return const_cast<FieldInit *>(this);
1539 static void ProfileDagInit(FoldingSetNodeID &ID, Init *V, const std::string &VN,
1540 ArrayRef<Init *> ArgRange,
1541 ArrayRef<std::string> NameRange) {
1545 ArrayRef<Init *>::iterator Arg = ArgRange.begin();
1546 ArrayRef<std::string>::iterator Name = NameRange.begin();
1547 while (Arg != ArgRange.end()) {
1548 assert(Name != NameRange.end() && "Arg name underflow!");
1549 ID.AddPointer(*Arg++);
1550 ID.AddString(*Name++);
1552 assert(Name == NameRange.end() && "Arg name overflow!");
1556 DagInit::get(Init *V, const std::string &VN,
1557 ArrayRef<Init *> ArgRange,
1558 ArrayRef<std::string> NameRange) {
1559 typedef FoldingSet<DagInit> Pool;
1560 static Pool ThePool;
1562 FoldingSetNodeID ID;
1563 ProfileDagInit(ID, V, VN, ArgRange, NameRange);
1566 if (DagInit *I = ThePool.FindNodeOrInsertPos(ID, IP))
1569 DagInit *I = new DagInit(V, VN, ArgRange, NameRange);
1570 ThePool.InsertNode(I, IP);
1576 DagInit::get(Init *V, const std::string &VN,
1577 const std::vector<std::pair<Init*, std::string> > &args) {
1578 typedef std::pair<Init*, std::string> PairType;
1580 std::vector<Init *> Args;
1581 std::vector<std::string> Names;
1583 for (std::vector<PairType>::const_iterator i = args.begin(),
1587 Args.push_back(i->first);
1588 Names.push_back(i->second);
1591 return DagInit::get(V, VN, Args, Names);
1594 void DagInit::Profile(FoldingSetNodeID &ID) const {
1595 ProfileDagInit(ID, Val, ValName, Args, ArgNames);
1598 Init *DagInit::resolveReferences(Record &R, const RecordVal *RV) const {
1599 std::vector<Init*> NewArgs;
1600 for (unsigned i = 0, e = Args.size(); i != e; ++i)
1601 NewArgs.push_back(Args[i]->resolveReferences(R, RV));
1603 Init *Op = Val->resolveReferences(R, RV);
1605 if (Args != NewArgs || Op != Val)
1606 return DagInit::get(Op, ValName, NewArgs, ArgNames);
1608 return const_cast<DagInit *>(this);
1612 std::string DagInit::getAsString() const {
1613 std::string Result = "(" + Val->getAsString();
1614 if (!ValName.empty())
1615 Result += ":" + ValName;
1617 Result += " " + Args[0]->getAsString();
1618 if (!ArgNames[0].empty()) Result += ":$" + ArgNames[0];
1619 for (unsigned i = 1, e = Args.size(); i != e; ++i) {
1620 Result += ", " + Args[i]->getAsString();
1621 if (!ArgNames[i].empty()) Result += ":$" + ArgNames[i];
1624 return Result + ")";
1628 //===----------------------------------------------------------------------===//
1629 // Other implementations
1630 //===----------------------------------------------------------------------===//
1632 RecordVal::RecordVal(Init *N, RecTy *T, unsigned P)
1633 : Name(N), Ty(T), Prefix(P) {
1634 Value = Ty->convertValue(UnsetInit::get());
1635 assert(Value && "Cannot create unset value for current type!");
1638 RecordVal::RecordVal(const std::string &N, RecTy *T, unsigned P)
1639 : Name(StringInit::get(N)), Ty(T), Prefix(P) {
1640 Value = Ty->convertValue(UnsetInit::get());
1641 assert(Value && "Cannot create unset value for current type!");
1644 const std::string &RecordVal::getName() const {
1645 StringInit *NameString = dyn_cast<StringInit>(Name);
1646 assert(NameString && "RecordVal name is not a string!");
1647 return NameString->getValue();
1650 void RecordVal::dump() const { errs() << *this; }
1652 void RecordVal::print(raw_ostream &OS, bool PrintSem) const {
1653 if (getPrefix()) OS << "field ";
1654 OS << *getType() << " " << getNameInitAsString();
1657 OS << " = " << *getValue();
1659 if (PrintSem) OS << ";\n";
1662 unsigned Record::LastID = 0;
1664 void Record::init() {
1667 // Every record potentially has a def at the top. This value is
1668 // replaced with the top-level def name at instantiation time.
1669 RecordVal DN("NAME", StringRecTy::get(), 0);
1673 void Record::checkName() {
1674 // Ensure the record name has string type.
1675 const TypedInit *TypedName = dyn_cast<const TypedInit>(Name);
1676 assert(TypedName && "Record name is not typed!");
1677 RecTy *Type = TypedName->getType();
1678 if (!isa<StringRecTy>(Type))
1679 PrintFatalError(getLoc(), "Record name is not a string!");
1682 DefInit *Record::getDefInit() {
1684 TheInit = new DefInit(this, new RecordRecTy(this));
1688 const std::string &Record::getName() const {
1689 const StringInit *NameString = dyn_cast<StringInit>(Name);
1690 assert(NameString && "Record name is not a string!");
1691 return NameString->getValue();
1694 void Record::setName(Init *NewName) {
1695 if (TrackedRecords.getDef(Name->getAsUnquotedString()) == this) {
1696 TrackedRecords.removeDef(Name->getAsUnquotedString());
1697 TrackedRecords.addDef(this);
1698 } else if (TrackedRecords.getClass(Name->getAsUnquotedString()) == this) {
1699 TrackedRecords.removeClass(Name->getAsUnquotedString());
1700 TrackedRecords.addClass(this);
1701 } // Otherwise this isn't yet registered.
1704 // DO NOT resolve record values to the name at this point because
1705 // there might be default values for arguments of this def. Those
1706 // arguments might not have been resolved yet so we don't want to
1707 // prematurely assume values for those arguments were not passed to
1710 // Nonetheless, it may be that some of this Record's values
1711 // reference the record name. Indeed, the reason for having the
1712 // record name be an Init is to provide this flexibility. The extra
1713 // resolve steps after completely instantiating defs takes care of
1714 // this. See TGParser::ParseDef and TGParser::ParseDefm.
1717 void Record::setName(const std::string &Name) {
1718 setName(StringInit::get(Name));
1721 /// resolveReferencesTo - If anything in this record refers to RV, replace the
1722 /// reference to RV with the RHS of RV. If RV is null, we resolve all possible
1724 void Record::resolveReferencesTo(const RecordVal *RV) {
1725 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1726 if (RV == &Values[i]) // Skip resolve the same field as the given one
1728 if (Init *V = Values[i].getValue())
1729 if (Values[i].setValue(V->resolveReferences(*this, RV)))
1730 PrintFatalError(getLoc(), "Invalid value is found when setting '"
1731 + Values[i].getNameInitAsString()
1732 + "' after resolving references"
1733 + (RV ? " against '" + RV->getNameInitAsString()
1735 + RV->getValue()->getAsUnquotedString() + ")"
1739 Init *OldName = getNameInit();
1740 Init *NewName = Name->resolveReferences(*this, RV);
1741 if (NewName != OldName) {
1742 // Re-register with RecordKeeper.
1747 void Record::dump() const { errs() << *this; }
1749 raw_ostream &llvm::operator<<(raw_ostream &OS, const Record &R) {
1750 OS << R.getNameInitAsString();
1752 const std::vector<Init *> &TArgs = R.getTemplateArgs();
1753 if (!TArgs.empty()) {
1755 for (unsigned i = 0, e = TArgs.size(); i != e; ++i) {
1757 const RecordVal *RV = R.getValue(TArgs[i]);
1758 assert(RV && "Template argument record not found??");
1759 RV->print(OS, false);
1765 const std::vector<Record*> &SC = R.getSuperClasses();
1768 for (unsigned i = 0, e = SC.size(); i != e; ++i)
1769 OS << " " << SC[i]->getNameInitAsString();
1773 const std::vector<RecordVal> &Vals = R.getValues();
1774 for (unsigned i = 0, e = Vals.size(); i != e; ++i)
1775 if (Vals[i].getPrefix() && !R.isTemplateArg(Vals[i].getName()))
1777 for (unsigned i = 0, e = Vals.size(); i != e; ++i)
1778 if (!Vals[i].getPrefix() && !R.isTemplateArg(Vals[i].getName()))
1784 /// getValueInit - Return the initializer for a value with the specified name,
1785 /// or abort if the field does not exist.
1787 Init *Record::getValueInit(StringRef FieldName) const {
1788 const RecordVal *R = getValue(FieldName);
1789 if (!R || !R->getValue())
1790 PrintFatalError(getLoc(), "Record `" + getName() +
1791 "' does not have a field named `" + FieldName + "'!\n");
1792 return R->getValue();
1796 /// getValueAsString - This method looks up the specified field and returns its
1797 /// value as a string, aborts if the field does not exist or if
1798 /// the value is not a string.
1800 std::string Record::getValueAsString(StringRef FieldName) const {
1801 const RecordVal *R = getValue(FieldName);
1802 if (!R || !R->getValue())
1803 PrintFatalError(getLoc(), "Record `" + getName() +
1804 "' does not have a field named `" + FieldName + "'!\n");
1806 if (StringInit *SI = dyn_cast<StringInit>(R->getValue()))
1807 return SI->getValue();
1808 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1809 FieldName + "' does not have a string initializer!");
1812 /// getValueAsBitsInit - This method looks up the specified field and returns
1813 /// its value as a BitsInit, aborts if the field does not exist or if
1814 /// the value is not the right type.
1816 BitsInit *Record::getValueAsBitsInit(StringRef FieldName) const {
1817 const RecordVal *R = getValue(FieldName);
1818 if (!R || !R->getValue())
1819 PrintFatalError(getLoc(), "Record `" + getName() +
1820 "' does not have a field named `" + FieldName + "'!\n");
1822 if (BitsInit *BI = dyn_cast<BitsInit>(R->getValue()))
1824 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1825 FieldName + "' does not have a BitsInit initializer!");
1828 /// getValueAsListInit - This method looks up the specified field and returns
1829 /// its value as a ListInit, aborting if the field does not exist or if
1830 /// the value is not the right type.
1832 ListInit *Record::getValueAsListInit(StringRef FieldName) const {
1833 const RecordVal *R = getValue(FieldName);
1834 if (!R || !R->getValue())
1835 PrintFatalError(getLoc(), "Record `" + getName() +
1836 "' does not have a field named `" + FieldName + "'!\n");
1838 if (ListInit *LI = dyn_cast<ListInit>(R->getValue()))
1840 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1841 FieldName + "' does not have a list initializer!");
1844 /// getValueAsListOfDefs - This method looks up the specified field and returns
1845 /// its value as a vector of records, aborting if the field does not exist
1846 /// or if the value is not the right type.
1848 std::vector<Record*>
1849 Record::getValueAsListOfDefs(StringRef FieldName) const {
1850 ListInit *List = getValueAsListInit(FieldName);
1851 std::vector<Record*> Defs;
1852 for (unsigned i = 0; i < List->getSize(); i++) {
1853 if (DefInit *DI = dyn_cast<DefInit>(List->getElement(i))) {
1854 Defs.push_back(DI->getDef());
1856 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1857 FieldName + "' list is not entirely DefInit!");
1863 /// getValueAsInt - This method looks up the specified field and returns its
1864 /// value as an int64_t, aborting if the field does not exist or if the value
1865 /// is not the right type.
1867 int64_t Record::getValueAsInt(StringRef FieldName) const {
1868 const RecordVal *R = getValue(FieldName);
1869 if (!R || !R->getValue())
1870 PrintFatalError(getLoc(), "Record `" + getName() +
1871 "' does not have a field named `" + FieldName + "'!\n");
1873 if (IntInit *II = dyn_cast<IntInit>(R->getValue()))
1874 return II->getValue();
1875 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1876 FieldName + "' does not have an int initializer!");
1879 /// getValueAsListOfInts - This method looks up the specified field and returns
1880 /// its value as a vector of integers, aborting if the field does not exist or
1881 /// if the value is not the right type.
1883 std::vector<int64_t>
1884 Record::getValueAsListOfInts(StringRef FieldName) const {
1885 ListInit *List = getValueAsListInit(FieldName);
1886 std::vector<int64_t> Ints;
1887 for (unsigned i = 0; i < List->getSize(); i++) {
1888 if (IntInit *II = dyn_cast<IntInit>(List->getElement(i))) {
1889 Ints.push_back(II->getValue());
1891 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1892 FieldName + "' does not have a list of ints initializer!");
1898 /// getValueAsListOfStrings - This method looks up the specified field and
1899 /// returns its value as a vector of strings, aborting if the field does not
1900 /// exist or if the value is not the right type.
1902 std::vector<std::string>
1903 Record::getValueAsListOfStrings(StringRef FieldName) const {
1904 ListInit *List = getValueAsListInit(FieldName);
1905 std::vector<std::string> Strings;
1906 for (unsigned i = 0; i < List->getSize(); i++) {
1907 if (StringInit *II = dyn_cast<StringInit>(List->getElement(i))) {
1908 Strings.push_back(II->getValue());
1910 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1911 FieldName + "' does not have a list of strings initializer!");
1917 /// getValueAsDef - This method looks up the specified field and returns its
1918 /// value as a Record, aborting if the field does not exist or if the value
1919 /// is not the right type.
1921 Record *Record::getValueAsDef(StringRef FieldName) const {
1922 const RecordVal *R = getValue(FieldName);
1923 if (!R || !R->getValue())
1924 PrintFatalError(getLoc(), "Record `" + getName() +
1925 "' does not have a field named `" + FieldName + "'!\n");
1927 if (DefInit *DI = dyn_cast<DefInit>(R->getValue()))
1928 return DI->getDef();
1929 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1930 FieldName + "' does not have a def initializer!");
1933 /// getValueAsBit - This method looks up the specified field and returns its
1934 /// value as a bit, aborting if the field does not exist or if the value is
1935 /// not the right type.
1937 bool Record::getValueAsBit(StringRef FieldName) const {
1938 const RecordVal *R = getValue(FieldName);
1939 if (!R || !R->getValue())
1940 PrintFatalError(getLoc(), "Record `" + getName() +
1941 "' does not have a field named `" + FieldName + "'!\n");
1943 if (BitInit *BI = dyn_cast<BitInit>(R->getValue()))
1944 return BI->getValue();
1945 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1946 FieldName + "' does not have a bit initializer!");
1949 bool Record::getValueAsBitOrUnset(StringRef FieldName, bool &Unset) const {
1950 const RecordVal *R = getValue(FieldName);
1951 if (!R || !R->getValue())
1952 PrintFatalError(getLoc(), "Record `" + getName() +
1953 "' does not have a field named `" + FieldName.str() + "'!\n");
1955 if (R->getValue() == UnsetInit::get()) {
1960 if (BitInit *BI = dyn_cast<BitInit>(R->getValue()))
1961 return BI->getValue();
1962 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1963 FieldName + "' does not have a bit initializer!");
1966 /// getValueAsDag - This method looks up the specified field and returns its
1967 /// value as an Dag, aborting if the field does not exist or if the value is
1968 /// not the right type.
1970 DagInit *Record::getValueAsDag(StringRef FieldName) const {
1971 const RecordVal *R = getValue(FieldName);
1972 if (!R || !R->getValue())
1973 PrintFatalError(getLoc(), "Record `" + getName() +
1974 "' does not have a field named `" + FieldName + "'!\n");
1976 if (DagInit *DI = dyn_cast<DagInit>(R->getValue()))
1978 PrintFatalError(getLoc(), "Record `" + getName() + "', field `" +
1979 FieldName + "' does not have a dag initializer!");
1983 void MultiClass::dump() const {
1984 errs() << "Record:\n";
1987 errs() << "Defs:\n";
1988 for (RecordVector::const_iterator r = DefPrototypes.begin(),
1989 rend = DefPrototypes.end();
1997 void RecordKeeper::dump() const { errs() << *this; }
1999 raw_ostream &llvm::operator<<(raw_ostream &OS, const RecordKeeper &RK) {
2000 OS << "------------- Classes -----------------\n";
2001 const std::map<std::string, Record*> &Classes = RK.getClasses();
2002 for (std::map<std::string, Record*>::const_iterator I = Classes.begin(),
2003 E = Classes.end(); I != E; ++I)
2004 OS << "class " << *I->second;
2006 OS << "------------- Defs -----------------\n";
2007 const std::map<std::string, Record*> &Defs = RK.getDefs();
2008 for (std::map<std::string, Record*>::const_iterator I = Defs.begin(),
2009 E = Defs.end(); I != E; ++I)
2010 OS << "def " << *I->second;
2015 /// getAllDerivedDefinitions - This method returns all concrete definitions
2016 /// that derive from the specified class name. If a class with the specified
2017 /// name does not exist, an error is printed and true is returned.
2018 std::vector<Record*>
2019 RecordKeeper::getAllDerivedDefinitions(const std::string &ClassName) const {
2020 Record *Class = getClass(ClassName);
2022 PrintFatalError("ERROR: Couldn't find the `" + ClassName + "' class!\n");
2024 std::vector<Record*> Defs;
2025 for (std::map<std::string, Record*>::const_iterator I = getDefs().begin(),
2026 E = getDefs().end(); I != E; ++I)
2027 if (I->second->isSubClassOf(Class))
2028 Defs.push_back(I->second);
2033 /// QualifyName - Return an Init with a qualifier prefix referring
2034 /// to CurRec's name.
2035 Init *llvm::QualifyName(Record &CurRec, MultiClass *CurMultiClass,
2036 Init *Name, const std::string &Scoper) {
2037 RecTy *Type = dyn_cast<TypedInit>(Name)->getType();
2039 BinOpInit *NewName =
2040 BinOpInit::get(BinOpInit::STRCONCAT,
2041 BinOpInit::get(BinOpInit::STRCONCAT,
2042 CurRec.getNameInit(),
2043 StringInit::get(Scoper),
2044 Type)->Fold(&CurRec, CurMultiClass),
2048 if (CurMultiClass && Scoper != "::") {
2050 BinOpInit::get(BinOpInit::STRCONCAT,
2051 BinOpInit::get(BinOpInit::STRCONCAT,
2052 CurMultiClass->Rec.getNameInit(),
2053 StringInit::get("::"),
2054 Type)->Fold(&CurRec, CurMultiClass),
2055 NewName->Fold(&CurRec, CurMultiClass),
2059 return NewName->Fold(&CurRec, CurMultiClass);
2062 /// QualifyName - Return an Init with a qualifier prefix referring
2063 /// to CurRec's name.
2064 Init *llvm::QualifyName(Record &CurRec, MultiClass *CurMultiClass,
2065 const std::string &Name,
2066 const std::string &Scoper) {
2067 return QualifyName(CurRec, CurMultiClass, StringInit::get(Name), Scoper);