include/llvm/TableGen/Record.h

   1 //===- llvm/TableGen/Record.h - Classes for Table Records -------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the main TableGen data structures, including the TableGen
  11 // types, values, and high-level data structures.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_TABLEGEN_RECORD_H
  16 #define LLVM_TABLEGEN_RECORD_H
  17
  18 #include "llvm/ADT/ArrayRef.h"
  19 #include "llvm/ADT/DenseMap.h"
  20 #include "llvm/ADT/DenseSet.h"
  21 #include "llvm/ADT/FoldingSet.h"
  22 #include "llvm/ADT/PointerIntPair.h"
  23 #include "llvm/ADT/SmallVector.h"
  24 #include "llvm/ADT/StringRef.h"
  25 #include "llvm/Support/Casting.h"
  26 #include "llvm/Support/ErrorHandling.h"
  27 #include "llvm/Support/SMLoc.h"
  28 #include "llvm/Support/TrailingObjects.h"
  29 #include "llvm/Support/raw_ostream.h"
  30 #include <algorithm>
  31 #include <cassert>
  32 #include <cstddef>
  33 #include <cstdint>
  34 #include <map>
  35 #include <memory>
  36 #include <string>
  37 #include <utility>
  38 #include <vector>
  39
  40 namespace llvm {
  41
  42 class ListRecTy;
  43 struct MultiClass;
  44 class Record;
  45 class RecordKeeper;
  46 class RecordVal;
  47 class Resolver;
  48 class StringInit;
  49 class TypedInit;
  50
  51 //===----------------------------------------------------------------------===//
  52 //  Type Classes
  53 //===----------------------------------------------------------------------===//
  54
  55 class RecTy {
  56 public:
  57   /// \brief Subclass discriminator (for dyn_cast<> et al.)
  58   enum RecTyKind {
  59     BitRecTyKind,
  60     BitsRecTyKind,
  61     CodeRecTyKind,
  62     IntRecTyKind,
  63     StringRecTyKind,
  64     ListRecTyKind,
  65     DagRecTyKind,
  66     RecordRecTyKind
  67   };
  68
  69 private:
  70   RecTyKind Kind;
  71   ListRecTy *ListTy = nullptr;
  72
  73 public:
  74   RecTy(RecTyKind K) : Kind(K) {}
  75   virtual ~RecTy() = default;
  76
  77   RecTyKind getRecTyKind() const { return Kind; }
  78
  79   virtual std::string getAsString() const = 0;
  80   void print(raw_ostream &OS) const { OS << getAsString(); }
  81   void dump() const;
  82
  83   /// Return true if all values of 'this' type can be converted to the specified
  84   /// type.
  85   virtual bool typeIsConvertibleTo(const RecTy *RHS) const;
  86
  87   /// Return true if 'this' type is equal to or a subtype of RHS. For example,
  88   /// a bit set is not an int, but they are convertible.
  89   virtual bool typeIsA(const RecTy *RHS) const;
  90
  91   /// Returns the type representing list<this>.
  92   ListRecTy *getListTy();
  93 };
  94
  95 inline raw_ostream &operator<<(raw_ostream &OS, const RecTy &Ty) {
  96   Ty.print(OS);
  97   return OS;
  98 }
  99
 100 /// 'bit' - Represent a single bit
 101 class BitRecTy : public RecTy {
 102   static BitRecTy Shared;
 103
 104   BitRecTy() : RecTy(BitRecTyKind) {}
 105
 106 public:
 107   static bool classof(const RecTy *RT) {
 108     return RT->getRecTyKind() == BitRecTyKind;
 109   }
 110
 111   static BitRecTy *get() { return &Shared; }
 112
 113   std::string getAsString() const override { return "bit"; }
 114
 115   bool typeIsConvertibleTo(const RecTy *RHS) const override;
 116 };
 117
 118 /// 'bits<n>' - Represent a fixed number of bits
 119 class BitsRecTy : public RecTy {
 120   unsigned Size;
 121
 122   explicit BitsRecTy(unsigned Sz) : RecTy(BitsRecTyKind), Size(Sz) {}
 123
 124 public:
 125   static bool classof(const RecTy *RT) {
 126     return RT->getRecTyKind() == BitsRecTyKind;
 127   }
 128
 129   static BitsRecTy *get(unsigned Sz);
 130
 131   unsigned getNumBits() const { return Size; }
 132
 133   std::string getAsString() const override;
 134
 135   bool typeIsConvertibleTo(const RecTy *RHS) const override;
 136
 137   bool typeIsA(const RecTy *RHS) const override;
 138 };
 139
 140 /// 'code' - Represent a code fragment
 141 class CodeRecTy : public RecTy {
 142   static CodeRecTy Shared;
 143
 144   CodeRecTy() : RecTy(CodeRecTyKind) {}
 145
 146 public:
 147   static bool classof(const RecTy *RT) {
 148     return RT->getRecTyKind() == CodeRecTyKind;
 149   }
 150
 151   static CodeRecTy *get() { return &Shared; }
 152
 153   std::string getAsString() const override { return "code"; }
 154
 155   bool typeIsConvertibleTo(const RecTy *RHS) const override;
 156 };
 157
 158 /// 'int' - Represent an integer value of no particular size
 159 class IntRecTy : public RecTy {
 160   static IntRecTy Shared;
 161
 162   IntRecTy() : RecTy(IntRecTyKind) {}
 163
 164 public:
 165   static bool classof(const RecTy *RT) {
 166     return RT->getRecTyKind() == IntRecTyKind;
 167   }
 168
 169   static IntRecTy *get() { return &Shared; }
 170
 171   std::string getAsString() const override { return "int"; }
 172
 173   bool typeIsConvertibleTo(const RecTy *RHS) const override;
 174 };
 175
 176 /// 'string' - Represent an string value
 177 class StringRecTy : public RecTy {
 178   static StringRecTy Shared;
 179
 180   StringRecTy() : RecTy(StringRecTyKind) {}
 181
 182 public:
 183   static bool classof(const RecTy *RT) {
 184     return RT->getRecTyKind() == StringRecTyKind;
 185   }
 186
 187   static StringRecTy *get() { return &Shared; }
 188
 189   std::string getAsString() const override;
 190
 191   bool typeIsConvertibleTo(const RecTy *RHS) const override;
 192 };
 193
 194 /// 'list<Ty>' - Represent a list of values, all of which must be of
 195 /// the specified type.
 196 class ListRecTy : public RecTy {
 197   friend ListRecTy *RecTy::getListTy();
 198
 199   RecTy *Ty;
 200
 201   explicit ListRecTy(RecTy *T) : RecTy(ListRecTyKind), Ty(T) {}
 202
 203 public:
 204   static bool classof(const RecTy *RT) {
 205     return RT->getRecTyKind() == ListRecTyKind;
 206   }
 207
 208   static ListRecTy *get(RecTy *T) { return T->getListTy(); }
 209   RecTy *getElementType() const { return Ty; }
 210
 211   std::string getAsString() const override;
 212
 213   bool typeIsConvertibleTo(const RecTy *RHS) const override;
 214
 215   bool typeIsA(const RecTy *RHS) const override;
 216 };
 217
 218 /// 'dag' - Represent a dag fragment
 219 class DagRecTy : public RecTy {
 220   static DagRecTy Shared;
 221
 222   DagRecTy() : RecTy(DagRecTyKind) {}
 223
 224 public:
 225   static bool classof(const RecTy *RT) {
 226     return RT->getRecTyKind() == DagRecTyKind;
 227   }
 228
 229   static DagRecTy *get() { return &Shared; }
 230
 231   std::string getAsString() const override;
 232 };
 233
 234 /// '[classname]' - Type of record values that have zero or more superclasses.
 235 ///
 236 /// The list of superclasses is non-redundant, i.e. only contains classes that
 237 /// are not the superclass of some other listed class.
 238 class RecordRecTy final : public RecTy, public FoldingSetNode,
 239                           public TrailingObjects<RecordRecTy, Record *> {
 240   friend class Record;
 241
 242   unsigned NumClasses;
 243
 244   explicit RecordRecTy(unsigned Num)
 245       : RecTy(RecordRecTyKind), NumClasses(Num) {}
 246
 247 public:
 248   RecordRecTy(const RecordRecTy &) = delete;
 249   RecordRecTy &operator=(const RecordRecTy &) = delete;
 250
 251   // Do not use sized deallocation due to trailing objects.
 252   void operator delete(void *p) { ::operator delete(p); }
 253
 254   static bool classof(const RecTy *RT) {
 255     return RT->getRecTyKind() == RecordRecTyKind;
 256   }
 257
 258   /// Get the record type with the given non-redundant list of superclasses.
 259   static RecordRecTy *get(ArrayRef<Record *> Classes);
 260
 261   void Profile(FoldingSetNodeID &ID) const;
 262
 263   ArrayRef<Record *> getClasses() const {
 264     return makeArrayRef(getTrailingObjects<Record *>(), NumClasses);
 265   }
 266
 267   using const_record_iterator = Record * const *;
 268
 269   const_record_iterator classes_begin() const { return getClasses().begin(); }
 270   const_record_iterator classes_end() const { return getClasses().end(); }
 271
 272   std::string getAsString() const override;
 273
 274   bool isSubClassOf(Record *Class) const;
 275   bool typeIsConvertibleTo(const RecTy *RHS) const override;
 276
 277   bool typeIsA(const RecTy *RHS) const override;
 278 };
 279
 280 /// Find a common type that T1 and T2 convert to.
 281 /// Return 0 if no such type exists.
 282 RecTy *resolveTypes(RecTy *T1, RecTy *T2);
 283
 284 //===----------------------------------------------------------------------===//
 285 //  Initializer Classes
 286 //===----------------------------------------------------------------------===//
 287
 288 class Init {
 289 protected:
 290   /// \brief Discriminator enum (for isa<>, dyn_cast<>, et al.)
 291   ///
 292   /// This enum is laid out by a preorder traversal of the inheritance
 293   /// hierarchy, and does not contain an entry for abstract classes, as per
 294   /// the recommendation in docs/HowToSetUpLLVMStyleRTTI.rst.
 295   ///
 296   /// We also explicitly include "first" and "last" values for each
 297   /// interior node of the inheritance tree, to make it easier to read the
 298   /// corresponding classof().
 299   ///
 300   /// We could pack these a bit tighter by not having the IK_FirstXXXInit
 301   /// and IK_LastXXXInit be their own values, but that would degrade
 302   /// readability for really no benefit.
 303   enum InitKind : uint8_t {
 304     IK_First, // unused; silence a spurious warning
 305     IK_FirstTypedInit,
 306     IK_BitInit,
 307     IK_BitsInit,
 308     IK_CodeInit,
 309     IK_DagInit,
 310     IK_DefInit,
 311     IK_FieldInit,
 312     IK_IntInit,
 313     IK_ListInit,
 314     IK_FirstOpInit,
 315     IK_BinOpInit,
 316     IK_TernOpInit,
 317     IK_UnOpInit,
 318     IK_LastOpInit,
 319     IK_FoldOpInit,
 320     IK_IsAOpInit,
 321     IK_StringInit,
 322     IK_VarInit,
 323     IK_VarListElementInit,
 324     IK_VarBitInit,
 325     IK_VarDefInit,
 326     IK_LastTypedInit,
 327     IK_UnsetInit
 328   };
 329
 330 private:
 331   const InitKind Kind;
 332
 333 protected:
 334   uint8_t Opc; // Used by UnOpInit, BinOpInit, and TernOpInit
 335
 336 private:
 337   virtual void anchor();
 338
 339 public:
 340   InitKind getKind() const { return Kind; }
 341
 342 protected:
 343   explicit Init(InitKind K, uint8_t Opc = 0) : Kind(K), Opc(Opc) {}
 344
 345 public:
 346   Init(const Init &) = delete;
 347   Init &operator=(const Init &) = delete;
 348   virtual ~Init() = default;
 349
 350   /// This virtual method should be overridden by values that may
 351   /// not be completely specified yet.
 352   virtual bool isComplete() const { return true; }
 353
 354   /// Is this a concrete and fully resolved value without any references or
 355   /// stuck operations? Unset values are concrete.
 356   virtual bool isConcrete() const { return false; }
 357
 358   /// Print out this value.
 359   void print(raw_ostream &OS) const { OS << getAsString(); }
 360
 361   /// Convert this value to a string form.
 362   virtual std::string getAsString() const = 0;
 363   /// Convert this value to a string form,
 364   /// without adding quote markers.  This primaruly affects
 365   /// StringInits where we will not surround the string value with
 366   /// quotes.
 367   virtual std::string getAsUnquotedString() const { return getAsString(); }
 368
 369   /// Debugging method that may be called through a debugger, just
 370   /// invokes print on stderr.
 371   void dump() const;
 372
 373   /// If this initializer is convertible to Ty, return an initializer whose
 374   /// type is-a Ty, generating a !cast operation if required. Otherwise, return
 375   /// nullptr.
 376   virtual Init *getCastTo(RecTy *Ty) const = 0;
 377
 378   /// Convert to an initializer whose type is-a Ty, or return nullptr if this
 379   /// is not possible (this can happen if the initializer's type is convertible
 380   /// to Ty, but there are unresolved references).
 381   virtual Init *convertInitializerTo(RecTy *Ty) const = 0;
 382
 383   /// This method is used to implement the bitrange
 384   /// selection operator.  Given an initializer, it selects the specified bits
 385   /// out, returning them as a new init of bits type.  If it is not legal to use
 386   /// the bit subscript operator on this initializer, return null.
 387   virtual Init *convertInitializerBitRange(ArrayRef<unsigned> Bits) const {
 388     return nullptr;
 389   }
 390
 391   /// This method is used to implement the list slice
 392   /// selection operator.  Given an initializer, it selects the specified list
 393   /// elements, returning them as a new init of list type.  If it is not legal
 394   /// to take a slice of this, return null.
 395   virtual Init *convertInitListSlice(ArrayRef<unsigned> Elements) const {
 396     return nullptr;
 397   }
 398
 399   /// This method is used to implement the FieldInit class.
 400   /// Implementors of this method should return the type of the named field if
 401   /// they are of record type.
 402   virtual RecTy *getFieldType(StringInit *FieldName) const {
 403     return nullptr;
 404   }
 405
 406   /// This method is used by classes that refer to other
 407   /// variables which may not be defined at the time the expression is formed.
 408   /// If a value is set for the variable later, this method will be called on
 409   /// users of the value to allow the value to propagate out.
 410   virtual Init *resolveReferences(Resolver &R) const {
 411     return const_cast<Init *>(this);
 412   }
 413
 414   /// This method is used to return the initializer for the specified
 415   /// bit.
 416   virtual Init *getBit(unsigned Bit) const = 0;
 417 };
 418
 419 inline raw_ostream &operator<<(raw_ostream &OS, const Init &I) {
 420   I.print(OS); return OS;
 421 }
 422
 423 /// This is the common super-class of types that have a specific,
 424 /// explicit, type.
 425 class TypedInit : public Init {
 426   RecTy *Ty;
 427
 428 protected:
 429   explicit TypedInit(InitKind K, RecTy *T, uint8_t Opc = 0)
 430     : Init(K, Opc), Ty(T) {}
 431
 432 public:
 433   TypedInit(const TypedInit &) = delete;
 434   TypedInit &operator=(const TypedInit &) = delete;
 435
 436   static bool classof(const Init *I) {
 437     return I->getKind() >= IK_FirstTypedInit &&
 438            I->getKind() <= IK_LastTypedInit;
 439   }
 440
 441   RecTy *getType() const { return Ty; }
 442
 443   Init *getCastTo(RecTy *Ty) const override;
 444   Init *convertInitializerTo(RecTy *Ty) const override;
 445
 446   Init *convertInitializerBitRange(ArrayRef<unsigned> Bits) const override;
 447   Init *convertInitListSlice(ArrayRef<unsigned> Elements) const override;
 448
 449   /// This method is used to implement the FieldInit class.
 450   /// Implementors of this method should return the type of the named field if
 451   /// they are of record type.
 452   ///
 453   RecTy *getFieldType(StringInit *FieldName) const override;
 454 };
 455
 456 /// '?' - Represents an uninitialized value
 457 class UnsetInit : public Init {
 458   UnsetInit() : Init(IK_UnsetInit) {}
 459
 460 public:
 461   UnsetInit(const UnsetInit &) = delete;
 462   UnsetInit &operator=(const UnsetInit &) = delete;
 463
 464   static bool classof(const Init *I) {
 465     return I->getKind() == IK_UnsetInit;
 466   }
 467
 468   static UnsetInit *get();
 469
 470   Init *getCastTo(RecTy *Ty) const override;
 471   Init *convertInitializerTo(RecTy *Ty) const override;
 472
 473   Init *getBit(unsigned Bit) const override {
 474     return const_cast<UnsetInit*>(this);
 475   }
 476
 477   bool isComplete() const override { return false; }
 478   bool isConcrete() const override { return true; }
 479   std::string getAsString() const override { return "?"; }
 480 };
 481
 482 /// 'true'/'false' - Represent a concrete initializer for a bit.
 483 class BitInit final : public TypedInit {
 484   bool Value;
 485
 486   explicit BitInit(bool V) : TypedInit(IK_BitInit, BitRecTy::get()), Value(V) {}
 487
 488 public:
 489   BitInit(const BitInit &) = delete;
 490   BitInit &operator=(BitInit &) = delete;
 491
 492   static bool classof(const Init *I) {
 493     return I->getKind() == IK_BitInit;
 494   }
 495
 496   static BitInit *get(bool V);
 497
 498   bool getValue() const { return Value; }
 499
 500   Init *convertInitializerTo(RecTy *Ty) const override;
 501
 502   Init *getBit(unsigned Bit) const override {
 503     assert(Bit < 1 && "Bit index out of range!");
 504     return const_cast<BitInit*>(this);
 505   }
 506
 507   bool isConcrete() const override { return true; }
 508   std::string getAsString() const override { return Value ? "1" : "0"; }
 509 };
 510
 511 /// '{ a, b, c }' - Represents an initializer for a BitsRecTy value.
 512 /// It contains a vector of bits, whose size is determined by the type.
 513 class BitsInit final : public TypedInit, public FoldingSetNode,
 514                        public TrailingObjects<BitsInit, Init *> {
 515   unsigned NumBits;
 516
 517   BitsInit(unsigned N)
 518     : TypedInit(IK_BitsInit, BitsRecTy::get(N)), NumBits(N) {}
 519
 520 public:
 521   BitsInit(const BitsInit &) = delete;
 522   BitsInit &operator=(const BitsInit &) = delete;
 523
 524   // Do not use sized deallocation due to trailing objects.
 525   void operator delete(void *p) { ::operator delete(p); }
 526
 527   static bool classof(const Init *I) {
 528     return I->getKind() == IK_BitsInit;
 529   }
 530
 531   static BitsInit *get(ArrayRef<Init *> Range);
 532
 533   void Profile(FoldingSetNodeID &ID) const;
 534
 535   unsigned getNumBits() const { return NumBits; }
 536
 537   Init *convertInitializerTo(RecTy *Ty) const override;
 538   Init *convertInitializerBitRange(ArrayRef<unsigned> Bits) const override;
 539
 540   bool isComplete() const override {
 541     for (unsigned i = 0; i != getNumBits(); ++i)
 542       if (!getBit(i)->isComplete()) return false;
 543     return true;
 544   }
 545
 546   bool allInComplete() const {
 547     for (unsigned i = 0; i != getNumBits(); ++i)
 548       if (getBit(i)->isComplete()) return false;
 549     return true;
 550   }
 551
 552   bool isConcrete() const override;
 553   std::string getAsString() const override;
 554
 555   Init *resolveReferences(Resolver &R) const override;
 556
 557   Init *getBit(unsigned Bit) const override {
 558     assert(Bit < NumBits && "Bit index out of range!");
 559     return getTrailingObjects<Init *>()[Bit];
 560   }
 561 };
 562
 563 /// '7' - Represent an initialization by a literal integer value.
 564 class IntInit : public TypedInit {
 565   int64_t Value;
 566
 567   explicit IntInit(int64_t V)
 568     : TypedInit(IK_IntInit, IntRecTy::get()), Value(V) {}
 569
 570 public:
 571   IntInit(const IntInit &) = delete;
 572   IntInit &operator=(const IntInit &) = delete;
 573
 574   static bool classof(const Init *I) {
 575     return I->getKind() == IK_IntInit;
 576   }
 577
 578   static IntInit *get(int64_t V);
 579
 580   int64_t getValue() const { return Value; }
 581
 582   Init *convertInitializerTo(RecTy *Ty) const override;
 583   Init *convertInitializerBitRange(ArrayRef<unsigned> Bits) const override;
 584
 585   bool isConcrete() const override { return true; }
 586   std::string getAsString() const override;
 587
 588   Init *getBit(unsigned Bit) const override {
 589     return BitInit::get((Value & (1ULL << Bit)) != 0);
 590   }
 591 };
 592
 593 /// "foo" - Represent an initialization by a string value.
 594 class StringInit : public TypedInit {
 595   StringRef Value;
 596
 597   explicit StringInit(StringRef V)
 598       : TypedInit(IK_StringInit, StringRecTy::get()), Value(V) {}
 599
 600 public:
 601   StringInit(const StringInit &) = delete;
 602   StringInit &operator=(const StringInit &) = delete;
 603
 604   static bool classof(const Init *I) {
 605     return I->getKind() == IK_StringInit;
 606   }
 607
 608   static StringInit *get(StringRef);
 609
 610   StringRef getValue() const { return Value; }
 611
 612   Init *convertInitializerTo(RecTy *Ty) const override;
 613
 614   bool isConcrete() const override { return true; }
 615   std::string getAsString() const override { return "\"" + Value.str() + "\""; }
 616
 617   std::string getAsUnquotedString() const override { return Value; }
 618
 619   Init *getBit(unsigned Bit) const override {
 620     llvm_unreachable("Illegal bit reference off string");
 621   }
 622 };
 623
 624 class CodeInit : public TypedInit {
 625   StringRef Value;
 626
 627   explicit CodeInit(StringRef V)
 628       : TypedInit(IK_CodeInit, static_cast<RecTy *>(CodeRecTy::get())),
 629         Value(V) {}
 630
 631 public:
 632   CodeInit(const StringInit &) = delete;
 633   CodeInit &operator=(const StringInit &) = delete;
 634
 635   static bool classof(const Init *I) {
 636     return I->getKind() == IK_CodeInit;
 637   }
 638
 639   static CodeInit *get(StringRef);
 640
 641   StringRef getValue() const { return Value; }
 642
 643   Init *convertInitializerTo(RecTy *Ty) const override;
 644
 645   bool isConcrete() const override { return true; }
 646   std::string getAsString() const override {
 647     return "[{" + Value.str() + "}]";
 648   }
 649
 650   std::string getAsUnquotedString() const override { return Value; }
 651
 652   Init *getBit(unsigned Bit) const override {
 653     llvm_unreachable("Illegal bit reference off string");
 654   }
 655 };
 656
 657 /// [AL, AH, CL] - Represent a list of defs
 658 ///
 659 class ListInit final : public TypedInit, public FoldingSetNode,
 660                        public TrailingObjects<ListInit, Init *> {
 661   unsigned NumValues;
 662
 663 public:
 664   using const_iterator = Init *const *;
 665
 666 private:
 667   explicit ListInit(unsigned N, RecTy *EltTy)
 668     : TypedInit(IK_ListInit, ListRecTy::get(EltTy)), NumValues(N) {}
 669
 670 public:
 671   ListInit(const ListInit &) = delete;
 672   ListInit &operator=(const ListInit &) = delete;
 673
 674   // Do not use sized deallocation due to trailing objects.
 675   void operator delete(void *p) { ::operator delete(p); }
 676
 677   static bool classof(const Init *I) {
 678     return I->getKind() == IK_ListInit;
 679   }
 680   static ListInit *get(ArrayRef<Init *> Range, RecTy *EltTy);
 681
 682   void Profile(FoldingSetNodeID &ID) const;
 683
 684   Init *getElement(unsigned i) const {
 685     assert(i < NumValues && "List element index out of range!");
 686     return getTrailingObjects<Init *>()[i];
 687   }
 688   RecTy *getElementType() const {
 689     return cast<ListRecTy>(getType())->getElementType();
 690   }
 691
 692   Record *getElementAsRecord(unsigned i) const;
 693
 694   Init *convertInitListSlice(ArrayRef<unsigned> Elements) const override;
 695
 696   Init *convertInitializerTo(RecTy *Ty) const override;
 697
 698   /// This method is used by classes that refer to other
 699   /// variables which may not be defined at the time they expression is formed.
 700   /// If a value is set for the variable later, this method will be called on
 701   /// users of the value to allow the value to propagate out.
 702   ///
 703   Init *resolveReferences(Resolver &R) const override;
 704
 705   bool isConcrete() const override;
 706   std::string getAsString() const override;
 707
 708   ArrayRef<Init*> getValues() const {
 709     return makeArrayRef(getTrailingObjects<Init *>(), NumValues);
 710   }
 711
 712   const_iterator begin() const { return getTrailingObjects<Init *>(); }
 713   const_iterator end  () const { return begin() + NumValues; }
 714
 715   size_t         size () const { return NumValues;  }
 716   bool           empty() const { return NumValues == 0; }
 717
 718   Init *getBit(unsigned Bit) const override {
 719     llvm_unreachable("Illegal bit reference off list");
 720   }
 721 };
 722
 723 /// Base class for operators
 724 ///
 725 class OpInit : public TypedInit {
 726 protected:
 727   explicit OpInit(InitKind K, RecTy *Type, uint8_t Opc)
 728     : TypedInit(K, Type, Opc) {}
 729
 730 public:
 731   OpInit(const OpInit &) = delete;
 732   OpInit &operator=(OpInit &) = delete;
 733
 734   static bool classof(const Init *I) {
 735     return I->getKind() >= IK_FirstOpInit &&
 736            I->getKind() <= IK_LastOpInit;
 737   }
 738
 739   // Clone - Clone this operator, replacing arguments with the new list
 740   virtual OpInit *clone(ArrayRef<Init *> Operands) const = 0;
 741
 742   virtual unsigned getNumOperands() const = 0;
 743   virtual Init *getOperand(unsigned i) const = 0;
 744
 745   // Fold - If possible, fold this to a simpler init.  Return this if not
 746   // possible to fold.
 747   virtual Init *Fold(Record *CurRec, MultiClass *CurMultiClass) const = 0;
 748
 749   Init *getBit(unsigned Bit) const override;
 750 };
 751
 752 /// !op (X) - Transform an init.
 753 ///
 754 class UnOpInit : public OpInit, public FoldingSetNode {
 755 public:
 756   enum UnaryOp : uint8_t { CAST, HEAD, TAIL, SIZE, EMPTY };
 757
 758 private:
 759   Init *LHS;
 760
 761   UnOpInit(UnaryOp opc, Init *lhs, RecTy *Type)
 762     : OpInit(IK_UnOpInit, Type, opc), LHS(lhs) {}
 763
 764 public:
 765   UnOpInit(const UnOpInit &) = delete;
 766   UnOpInit &operator=(const UnOpInit &) = delete;
 767
 768   static bool classof(const Init *I) {
 769     return I->getKind() == IK_UnOpInit;
 770   }
 771
 772   static UnOpInit *get(UnaryOp opc, Init *lhs, RecTy *Type);
 773
 774   void Profile(FoldingSetNodeID &ID) const;
 775
 776   // Clone - Clone this operator, replacing arguments with the new list
 777   OpInit *clone(ArrayRef<Init *> Operands) const override {
 778     assert(Operands.size() == 1 &&
 779            "Wrong number of operands for unary operation");
 780     return UnOpInit::get(getOpcode(), *Operands.begin(), getType());
 781   }
 782
 783   unsigned getNumOperands() const override { return 1; }
 784
 785   Init *getOperand(unsigned i) const override {
 786     assert(i == 0 && "Invalid operand id for unary operator");
 787     return getOperand();
 788   }
 789
 790   UnaryOp getOpcode() const { return (UnaryOp)Opc; }
 791   Init *getOperand() const { return LHS; }
 792
 793   // Fold - If possible, fold this to a simpler init.  Return this if not
 794   // possible to fold.
 795   Init *Fold(Record *CurRec, MultiClass *CurMultiClass) const override;
 796
 797   Init *resolveReferences(Resolver &R) const override;
 798
 799   std::string getAsString() const override;
 800 };
 801
 802 /// !op (X, Y) - Combine two inits.
 803 class BinOpInit : public OpInit, public FoldingSetNode {
 804 public:
 805   enum BinaryOp : uint8_t { ADD, AND, OR, SHL, SRA, SRL, LISTCONCAT,
 806                             STRCONCAT, CONCAT, EQ };
 807
 808 private:
 809   Init *LHS, *RHS;
 810
 811   BinOpInit(BinaryOp opc, Init *lhs, Init *rhs, RecTy *Type) :
 812       OpInit(IK_BinOpInit, Type, opc), LHS(lhs), RHS(rhs) {}
 813
 814 public:
 815   BinOpInit(const BinOpInit &) = delete;
 816   BinOpInit &operator=(const BinOpInit &) = delete;
 817
 818   static bool classof(const Init *I) {
 819     return I->getKind() == IK_BinOpInit;
 820   }
 821
 822   static BinOpInit *get(BinaryOp opc, Init *lhs, Init *rhs,
 823                         RecTy *Type);
 824
 825   void Profile(FoldingSetNodeID &ID) const;
 826
 827   // Clone - Clone this operator, replacing arguments with the new list
 828   OpInit *clone(ArrayRef<Init *> Operands) const override {
 829     assert(Operands.size() == 2 &&
 830            "Wrong number of operands for binary operation");
 831     return BinOpInit::get(getOpcode(), Operands[0], Operands[1], getType());
 832   }
 833
 834   unsigned getNumOperands() const override { return 2; }
 835   Init *getOperand(unsigned i) const override {
 836     switch (i) {
 837     default: llvm_unreachable("Invalid operand id for binary operator");
 838     case 0: return getLHS();
 839     case 1: return getRHS();
 840     }
 841   }
 842
 843   BinaryOp getOpcode() const { return (BinaryOp)Opc; }
 844   Init *getLHS() const { return LHS; }
 845   Init *getRHS() const { return RHS; }
 846
 847   // Fold - If possible, fold this to a simpler init.  Return this if not
 848   // possible to fold.
 849   Init *Fold(Record *CurRec, MultiClass *CurMultiClass) const override;
 850
 851   Init *resolveReferences(Resolver &R) const override;
 852
 853   std::string getAsString() const override;
 854 };
 855
 856 /// !op (X, Y, Z) - Combine two inits.
 857 class TernOpInit : public OpInit, public FoldingSetNode {
 858 public:
 859   enum TernaryOp : uint8_t { SUBST, FOREACH, IF };
 860
 861 private:
 862   Init *LHS, *MHS, *RHS;
 863
 864   TernOpInit(TernaryOp opc, Init *lhs, Init *mhs, Init *rhs,
 865              RecTy *Type) :
 866       OpInit(IK_TernOpInit, Type, opc), LHS(lhs), MHS(mhs), RHS(rhs) {}
 867
 868 public:
 869   TernOpInit(const TernOpInit &) = delete;
 870   TernOpInit &operator=(const TernOpInit &) = delete;
 871
 872   static bool classof(const Init *I) {
 873     return I->getKind() == IK_TernOpInit;
 874   }
 875
 876   static TernOpInit *get(TernaryOp opc, Init *lhs,
 877                          Init *mhs, Init *rhs,
 878                          RecTy *Type);
 879
 880   void Profile(FoldingSetNodeID &ID) const;
 881
 882   // Clone - Clone this operator, replacing arguments with the new list
 883   OpInit *clone(ArrayRef<Init *> Operands) const override {
 884     assert(Operands.size() == 3 &&
 885            "Wrong number of operands for ternary operation");
 886     return TernOpInit::get(getOpcode(), Operands[0], Operands[1], Operands[2],
 887                            getType());
 888   }
 889
 890   unsigned getNumOperands() const override { return 3; }
 891   Init *getOperand(unsigned i) const override {
 892     switch (i) {
 893     default: llvm_unreachable("Invalid operand id for ternary operator");
 894     case 0: return getLHS();
 895     case 1: return getMHS();
 896     case 2: return getRHS();
 897     }
 898   }
 899
 900   TernaryOp getOpcode() const { return (TernaryOp)Opc; }
 901   Init *getLHS() const { return LHS; }
 902   Init *getMHS() const { return MHS; }
 903   Init *getRHS() const { return RHS; }
 904
 905   // Fold - If possible, fold this to a simpler init.  Return this if not
 906   // possible to fold.
 907   Init *Fold(Record *CurRec, MultiClass *CurMultiClass) const override;
 908
 909   bool isComplete() const override {
 910     return LHS->isComplete() && MHS->isComplete() && RHS->isComplete();
 911   }
 912
 913   Init *resolveReferences(Resolver &R) const override;
 914
 915   std::string getAsString() const override;
 916 };
 917
 918 /// !foldl (a, b, expr, start, lst) - Fold over a list.
 919 class FoldOpInit : public TypedInit, public FoldingSetNode {
 920 private:
 921   Init *Start;
 922   Init *List;
 923   Init *A;
 924   Init *B;
 925   Init *Expr;
 926
 927   FoldOpInit(Init *Start, Init *List, Init *A, Init *B, Init *Expr, RecTy *Type)
 928       : TypedInit(IK_FoldOpInit, Type), Start(Start), List(List), A(A), B(B),
 929         Expr(Expr) {}
 930
 931 public:
 932   FoldOpInit(const FoldOpInit &) = delete;
 933   FoldOpInit &operator=(const FoldOpInit &) = delete;
 934
 935   static bool classof(const Init *I) { return I->getKind() == IK_FoldOpInit; }
 936
 937   static FoldOpInit *get(Init *Start, Init *List, Init *A, Init *B, Init *Expr,
 938                          RecTy *Type);
 939
 940   void Profile(FoldingSetNodeID &ID) const;
 941
 942   // Fold - If possible, fold this to a simpler init.  Return this if not
 943   // possible to fold.
 944   Init *Fold(Record *CurRec) const;
 945
 946   bool isComplete() const override { return false; }
 947
 948   Init *resolveReferences(Resolver &R) const override;
 949
 950   Init *getBit(unsigned Bit) const override;
 951
 952   std::string getAsString() const override;
 953 };
 954
 955 /// !isa<type>(expr) - Dynamically determine the type of an expression.
 956 class IsAOpInit : public TypedInit, public FoldingSetNode {
 957 private:
 958   RecTy *CheckType;
 959   Init *Expr;
 960
 961   IsAOpInit(RecTy *CheckType, Init *Expr)
 962       : TypedInit(IK_IsAOpInit, IntRecTy::get()), CheckType(CheckType),
 963         Expr(Expr) {}
 964
 965 public:
 966   IsAOpInit(const IsAOpInit &) = delete;
 967   IsAOpInit &operator=(const IsAOpInit &) = delete;
 968
 969   static bool classof(const Init *I) { return I->getKind() == IK_IsAOpInit; }
 970
 971   static IsAOpInit *get(RecTy *CheckType, Init *Expr);
 972
 973   void Profile(FoldingSetNodeID &ID) const;
 974
 975   // Fold - If possible, fold this to a simpler init.  Return this if not
 976   // possible to fold.
 977   Init *Fold() const;
 978
 979   bool isComplete() const override { return false; }
 980
 981   Init *resolveReferences(Resolver &R) const override;
 982
 983   Init *getBit(unsigned Bit) const override;
 984
 985   std::string getAsString() const override;
 986 };
 987
 988 /// 'Opcode' - Represent a reference to an entire variable object.
 989 class VarInit : public TypedInit {
 990   Init *VarName;
 991
 992   explicit VarInit(Init *VN, RecTy *T)
 993       : TypedInit(IK_VarInit, T), VarName(VN) {}
 994
 995 public:
 996   VarInit(const VarInit &) = delete;
 997   VarInit &operator=(const VarInit &) = delete;
 998
 999   static bool classof(const Init *I) {
1000     return I->getKind() == IK_VarInit;
1001   }
1002
1003   static VarInit *get(StringRef VN, RecTy *T);
1004   static VarInit *get(Init *VN, RecTy *T);
1005
1006   StringRef getName() const;
1007   Init *getNameInit() const { return VarName; }
1008
1009   std::string getNameInitAsString() const {
1010     return getNameInit()->getAsUnquotedString();
1011   }
1012
1013   /// This method is used by classes that refer to other
1014   /// variables which may not be defined at the time they expression is formed.
1015   /// If a value is set for the variable later, this method will be called on
1016   /// users of the value to allow the value to propagate out.
1017   ///
1018   Init *resolveReferences(Resolver &R) const override;
1019
1020   Init *getBit(unsigned Bit) const override;
1021
1022   std::string getAsString() const override { return getName(); }
1023 };
1024
1025 /// Opcode{0} - Represent access to one bit of a variable or field.
1026 class VarBitInit final : public TypedInit {
1027   TypedInit *TI;
1028   unsigned Bit;
1029
1030   VarBitInit(TypedInit *T, unsigned B)
1031       : TypedInit(IK_VarBitInit, BitRecTy::get()), TI(T), Bit(B) {
1032     assert(T->getType() &&
1033            (isa<IntRecTy>(T->getType()) ||
1034             (isa<BitsRecTy>(T->getType()) &&
1035              cast<BitsRecTy>(T->getType())->getNumBits() > B)) &&
1036            "Illegal VarBitInit expression!");
1037   }
1038
1039 public:
1040   VarBitInit(const VarBitInit &) = delete;
1041   VarBitInit &operator=(const VarBitInit &) = delete;
1042
1043   static bool classof(const Init *I) {
1044     return I->getKind() == IK_VarBitInit;
1045   }
1046
1047   static VarBitInit *get(TypedInit *T, unsigned B);
1048
1049   Init *getBitVar() const { return TI; }
1050   unsigned getBitNum() const { return Bit; }
1051
1052   std::string getAsString() const override;
1053   Init *resolveReferences(Resolver &R) const override;
1054
1055   Init *getBit(unsigned B) const override {
1056     assert(B < 1 && "Bit index out of range!");
1057     return const_cast<VarBitInit*>(this);
1058   }
1059 };
1060
1061 /// List[4] - Represent access to one element of a var or
1062 /// field.
1063 class VarListElementInit : public TypedInit {
1064   TypedInit *TI;
1065   unsigned Element;
1066
1067   VarListElementInit(TypedInit *T, unsigned E)
1068       : TypedInit(IK_VarListElementInit,
1069                   cast<ListRecTy>(T->getType())->getElementType()),
1070         TI(T), Element(E) {
1071     assert(T->getType() && isa<ListRecTy>(T->getType()) &&
1072            "Illegal VarBitInit expression!");
1073   }
1074
1075 public:
1076   VarListElementInit(const VarListElementInit &) = delete;
1077   VarListElementInit &operator=(const VarListElementInit &) = delete;
1078
1079   static bool classof(const Init *I) {
1080     return I->getKind() == IK_VarListElementInit;
1081   }
1082
1083   static VarListElementInit *get(TypedInit *T, unsigned E);
1084
1085   TypedInit *getVariable() const { return TI; }
1086   unsigned getElementNum() const { return Element; }
1087
1088   std::string getAsString() const override;
1089   Init *resolveReferences(Resolver &R) const override;
1090
1091   Init *getBit(unsigned Bit) const override;
1092 };
1093
1094 /// AL - Represent a reference to a 'def' in the description
1095 class DefInit : public TypedInit {
1096   friend class Record;
1097
1098   Record *Def;
1099
1100   explicit DefInit(Record *D);
1101
1102 public:
1103   DefInit(const DefInit &) = delete;
1104   DefInit &operator=(const DefInit &) = delete;
1105
1106   static bool classof(const Init *I) {
1107     return I->getKind() == IK_DefInit;
1108   }
1109
1110   static DefInit *get(Record*);
1111
1112   Init *convertInitializerTo(RecTy *Ty) const override;
1113
1114   Record *getDef() const { return Def; }
1115
1116   //virtual Init *convertInitializerBitRange(ArrayRef<unsigned> Bits);
1117
1118   RecTy *getFieldType(StringInit *FieldName) const override;
1119
1120   bool isConcrete() const override { return true; }
1121   std::string getAsString() const override;
1122
1123   Init *getBit(unsigned Bit) const override {
1124     llvm_unreachable("Illegal bit reference off def");
1125   }
1126 };
1127
1128 /// classname<targs...> - Represent an uninstantiated anonymous class
1129 /// instantiation.
1130 class VarDefInit final : public TypedInit, public FoldingSetNode,
1131                          public TrailingObjects<VarDefInit, Init *> {
1132   Record *Class;
1133   DefInit *Def = nullptr; // after instantiation
1134   unsigned NumArgs;
1135
1136   explicit VarDefInit(Record *Class, unsigned N)
1137     : TypedInit(IK_VarDefInit, RecordRecTy::get(Class)), Class(Class), NumArgs(N) {}
1138
1139   DefInit *instantiate();
1140
1141 public:
1142   VarDefInit(const VarDefInit &) = delete;
1143   VarDefInit &operator=(const VarDefInit &) = delete;
1144
1145   // Do not use sized deallocation due to trailing objects.
1146   void operator delete(void *p) { ::operator delete(p); }
1147
1148   static bool classof(const Init *I) {
1149     return I->getKind() == IK_VarDefInit;
1150   }
1151   static VarDefInit *get(Record *Class, ArrayRef<Init *> Args);
1152
1153   void Profile(FoldingSetNodeID &ID) const;
1154
1155   Init *resolveReferences(Resolver &R) const override;
1156   Init *Fold() const;
1157
1158   std::string getAsString() const override;
1159
1160   Init *getArg(unsigned i) const {
1161     assert(i < NumArgs && "Argument index out of range!");
1162     return getTrailingObjects<Init *>()[i];
1163   }
1164
1165   using const_iterator = Init *const *;
1166
1167   const_iterator args_begin() const { return getTrailingObjects<Init *>(); }
1168   const_iterator args_end  () const { return args_begin() + NumArgs; }
1169
1170   size_t         args_size () const { return NumArgs; }
1171   bool           args_empty() const { return NumArgs == 0; }
1172
1173   ArrayRef<Init *> args() const { return makeArrayRef(args_begin(), NumArgs); }
1174
1175   Init *getBit(unsigned Bit) const override {
1176     llvm_unreachable("Illegal bit reference off anonymous def");
1177   }
1178 };
1179
1180 /// X.Y - Represent a reference to a subfield of a variable
1181 class FieldInit : public TypedInit {
1182   Init *Rec;                // Record we are referring to
1183   StringInit *FieldName;    // Field we are accessing
1184
1185   FieldInit(Init *R, StringInit *FN)
1186       : TypedInit(IK_FieldInit, R->getFieldType(FN)), Rec(R), FieldName(FN) {
1187     assert(getType() && "FieldInit with non-record type!");
1188   }
1189
1190 public:
1191   FieldInit(const FieldInit &) = delete;
1192   FieldInit &operator=(const FieldInit &) = delete;
1193
1194   static bool classof(const Init *I) {
1195     return I->getKind() == IK_FieldInit;
1196   }
1197
1198   static FieldInit *get(Init *R, StringInit *FN);
1199
1200   Init *getRecord() const { return Rec; }
1201   StringInit *getFieldName() const { return FieldName; }
1202
1203   Init *getBit(unsigned Bit) const override;
1204
1205   Init *resolveReferences(Resolver &R) const override;
1206   Init *Fold() const;
1207
1208   std::string getAsString() const override {
1209     return Rec->getAsString() + "." + FieldName->getValue().str();
1210   }
1211 };
1212
1213 /// (v a, b) - Represent a DAG tree value.  DAG inits are required
1214 /// to have at least one value then a (possibly empty) list of arguments.  Each
1215 /// argument can have a name associated with it.
1216 class DagInit final : public TypedInit, public FoldingSetNode,
1217                       public TrailingObjects<DagInit, Init *, StringInit *> {
1218   friend TrailingObjects;
1219
1220   Init *Val;
1221   StringInit *ValName;
1222   unsigned NumArgs;
1223   unsigned NumArgNames;
1224
1225   DagInit(Init *V, StringInit *VN, unsigned NumArgs, unsigned NumArgNames)
1226       : TypedInit(IK_DagInit, DagRecTy::get()), Val(V), ValName(VN),
1227         NumArgs(NumArgs), NumArgNames(NumArgNames) {}
1228
1229   size_t numTrailingObjects(OverloadToken<Init *>) const { return NumArgs; }
1230
1231 public:
1232   DagInit(const DagInit &) = delete;
1233   DagInit &operator=(const DagInit &) = delete;
1234
1235   static bool classof(const Init *I) {
1236     return I->getKind() == IK_DagInit;
1237   }
1238
1239   static DagInit *get(Init *V, StringInit *VN, ArrayRef<Init *> ArgRange,
1240                       ArrayRef<StringInit*> NameRange);
1241   static DagInit *get(Init *V, StringInit *VN,
1242                       ArrayRef<std::pair<Init*, StringInit*>> Args);
1243
1244   void Profile(FoldingSetNodeID &ID) const;
1245
1246   Init *getOperator() const { return Val; }
1247
1248   StringInit *getName() const { return ValName; }
1249
1250   StringRef getNameStr() const {
1251     return ValName ? ValName->getValue() : StringRef();
1252   }
1253
1254   unsigned getNumArgs() const { return NumArgs; }
1255
1256   Init *getArg(unsigned Num) const {
1257     assert(Num < NumArgs && "Arg number out of range!");
1258     return getTrailingObjects<Init *>()[Num];
1259   }
1260
1261   StringInit *getArgName(unsigned Num) const {
1262     assert(Num < NumArgNames && "Arg number out of range!");
1263     return getTrailingObjects<StringInit *>()[Num];
1264   }
1265
1266   StringRef getArgNameStr(unsigned Num) const {
1267     StringInit *Init = getArgName(Num);
1268     return Init ? Init->getValue() : StringRef();
1269   }
1270
1271   ArrayRef<Init *> getArgs() const {
1272     return makeArrayRef(getTrailingObjects<Init *>(), NumArgs);
1273   }
1274
1275   ArrayRef<StringInit *> getArgNames() const {
1276     return makeArrayRef(getTrailingObjects<StringInit *>(), NumArgNames);
1277   }
1278
1279   Init *resolveReferences(Resolver &R) const override;
1280
1281   bool isConcrete() const override;
1282   std::string getAsString() const override;
1283
1284   using const_arg_iterator = SmallVectorImpl<Init*>::const_iterator;
1285   using const_name_iterator = SmallVectorImpl<StringInit*>::const_iterator;
1286
1287   inline const_arg_iterator  arg_begin() const { return getArgs().begin(); }
1288   inline const_arg_iterator  arg_end  () const { return getArgs().end(); }
1289
1290   inline size_t              arg_size () const { return NumArgs; }
1291   inline bool                arg_empty() const { return NumArgs == 0; }
1292
1293   inline const_name_iterator name_begin() const { return getArgNames().begin();}
1294   inline const_name_iterator name_end  () const { return getArgNames().end(); }
1295
1296   inline size_t              name_size () const { return NumArgNames; }
1297   inline bool                name_empty() const { return NumArgNames == 0; }
1298
1299   Init *getBit(unsigned Bit) const override {
1300     llvm_unreachable("Illegal bit reference off dag");
1301   }
1302 };
1303
1304 //===----------------------------------------------------------------------===//
1305 //  High-Level Classes
1306 //===----------------------------------------------------------------------===//
1307
1308 class RecordVal {
1309   friend class Record;
1310
1311   Init *Name;
1312   PointerIntPair<RecTy *, 1, bool> TyAndPrefix;
1313   Init *Value;
1314
1315 public:
1316   RecordVal(Init *N, RecTy *T, bool P);
1317
1318   StringRef getName() const;
1319   Init *getNameInit() const { return Name; }
1320
1321   std::string getNameInitAsString() const {
1322     return getNameInit()->getAsUnquotedString();
1323   }
1324
1325   bool getPrefix() const { return TyAndPrefix.getInt(); }
1326   RecTy *getType() const { return TyAndPrefix.getPointer(); }
1327   Init *getValue() const { return Value; }
1328
1329   bool setValue(Init *V);
1330
1331   void dump() const;
1332   void print(raw_ostream &OS, bool PrintSem = true) const;
1333 };
1334
1335 inline raw_ostream &operator<<(raw_ostream &OS, const RecordVal &RV) {
1336   RV.print(OS << "  ");
1337   return OS;
1338 }
1339
1340 class Record {
1341   static unsigned LastID;
1342
1343   Init *Name;
1344   // Location where record was instantiated, followed by the location of
1345   // multiclass prototypes used.
1346   SmallVector<SMLoc, 4> Locs;
1347   SmallVector<Init *, 0> TemplateArgs;
1348   SmallVector<RecordVal, 0> Values;
1349
1350   // All superclasses in the inheritance forest in reverse preorder (yes, it
1351   // must be a forest; diamond-shaped inheritance is not allowed).
1352   SmallVector<std::pair<Record *, SMRange>, 0> SuperClasses;
1353
1354   // Tracks Record instances. Not owned by Record.
1355   RecordKeeper &TrackedRecords;
1356
1357   DefInit *TheInit = nullptr;
1358
1359   // Unique record ID.
1360   unsigned ID;
1361
1362   bool IsAnonymous;
1363
1364   void init();
1365   void checkName();
1366
1367 public:
1368   // Constructs a record.
1369   explicit Record(Init *N, ArrayRef<SMLoc> locs, RecordKeeper &records,
1370                   bool Anonymous = false) :
1371     Name(N), Locs(locs.begin(), locs.end()), TrackedRecords(records),
1372     ID(LastID++), IsAnonymous(Anonymous) {
1373     init();
1374   }
1375
1376   explicit Record(StringRef N, ArrayRef<SMLoc> locs, RecordKeeper &records,
1377                   bool Anonymous = false)
1378     : Record(StringInit::get(N), locs, records, Anonymous) {}
1379
1380   // When copy-constructing a Record, we must still guarantee a globally unique
1381   // ID number.  Don't copy TheInit either since it's owned by the original
1382   // record. All other fields can be copied normally.
1383   Record(const Record &O) :
1384     Name(O.Name), Locs(O.Locs), TemplateArgs(O.TemplateArgs),
1385     Values(O.Values), SuperClasses(O.SuperClasses),
1386     TrackedRecords(O.TrackedRecords), ID(LastID++),
1387     IsAnonymous(O.IsAnonymous) { }
1388
1389   static unsigned getNewUID() { return LastID++; }
1390
1391   unsigned getID() const { return ID; }
1392
1393   StringRef getName() const { return cast<StringInit>(Name)->getValue(); }
1394
1395   Init *getNameInit() const {
1396     return Name;
1397   }
1398
1399   const std::string getNameInitAsString() const {
1400     return getNameInit()->getAsUnquotedString();
1401   }
1402
1403   void setName(Init *Name);      // Also updates RecordKeeper.
1404
1405   ArrayRef<SMLoc> getLoc() const { return Locs; }
1406
1407   /// get the corresponding DefInit.
1408   DefInit *getDefInit();
1409
1410   ArrayRef<Init *> getTemplateArgs() const {
1411     return TemplateArgs;
1412   }
1413
1414   ArrayRef<RecordVal> getValues() const { return Values; }
1415
1416   ArrayRef<std::pair<Record *, SMRange>>  getSuperClasses() const {
1417     return SuperClasses;
1418   }
1419
1420   /// Append the direct super classes of this record to Classes.
1421   void getDirectSuperClasses(SmallVectorImpl<Record *> &Classes) const;
1422
1423   bool isTemplateArg(Init *Name) const {
1424     for (Init *TA : TemplateArgs)
1425       if (TA == Name) return true;
1426     return false;
1427   }
1428
1429   const RecordVal *getValue(const Init *Name) const {
1430     for (const RecordVal &Val : Values)
1431       if (Val.Name == Name) return &Val;
1432     return nullptr;
1433   }
1434
1435   const RecordVal *getValue(StringRef Name) const {
1436     return getValue(StringInit::get(Name));
1437   }
1438
1439   RecordVal *getValue(const Init *Name) {
1440     return const_cast<RecordVal *>(static_cast<const Record *>(this)->getValue(Name));
1441   }
1442
1443   RecordVal *getValue(StringRef Name) {
1444     return const_cast<RecordVal *>(static_cast<const Record *>(this)->getValue(Name));
1445   }
1446
1447   void addTemplateArg(Init *Name) {
1448     assert(!isTemplateArg(Name) && "Template arg already defined!");
1449     TemplateArgs.push_back(Name);
1450   }
1451
1452   void addValue(const RecordVal &RV) {
1453     assert(getValue(RV.getNameInit()) == nullptr && "Value already added!");
1454     Values.push_back(RV);
1455     if (Values.size() > 1)
1456       // Keep NAME at the end of the list.  It makes record dumps a
1457       // bit prettier and allows TableGen tests to be written more
1458       // naturally.  Tests can use CHECK-NEXT to look for Record
1459       // fields they expect to see after a def.  They can't do that if
1460       // NAME is the first Record field.
1461       std::swap(Values[Values.size() - 2], Values[Values.size() - 1]);
1462   }
1463
1464   void removeValue(Init *Name) {
1465     for (unsigned i = 0, e = Values.size(); i != e; ++i)
1466       if (Values[i].getNameInit() == Name) {
1467         Values.erase(Values.begin()+i);
1468         return;
1469       }
1470     llvm_unreachable("Cannot remove an entry that does not exist!");
1471   }
1472
1473   void removeValue(StringRef Name) {
1474     removeValue(StringInit::get(Name));
1475   }
1476
1477   bool isSubClassOf(const Record *R) const {
1478     for (const auto &SCPair : SuperClasses)
1479       if (SCPair.first == R)
1480         return true;
1481     return false;
1482   }
1483
1484   bool isSubClassOf(StringRef Name) const {
1485     for (const auto &SCPair : SuperClasses) {
1486       if (const auto *SI = dyn_cast<StringInit>(SCPair.first->getNameInit())) {
1487         if (SI->getValue() == Name)
1488           return true;
1489       } else if (SCPair.first->getNameInitAsString() == Name) {
1490         return true;
1491       }
1492     }
1493     return false;
1494   }
1495
1496   void addSuperClass(Record *R, SMRange Range) {
1497     assert(!isSubClassOf(R) && "Already subclassing record!");
1498     SuperClasses.push_back(std::make_pair(R, Range));
1499   }
1500
1501   /// If there are any field references that refer to fields
1502   /// that have been filled in, we can propagate the values now.
1503   void resolveReferences();
1504
1505   /// Apply the resolver to the name of the record as well as to the
1506   /// initializers of all fields of the record except SkipVal.
1507   ///
1508   /// The resolver should not resolve any of the fields itself, to avoid
1509   /// recursion / infinite loops.
1510   void resolveReferences(Resolver &R, const RecordVal *SkipVal = nullptr);
1511
1512   /// If anything in this record refers to RV, replace the
1513   /// reference to RV with the RHS of RV.  If RV is null, we resolve all
1514   /// possible references.
1515   void resolveReferencesTo(const RecordVal *RV);
1516
1517   RecordKeeper &getRecords() const {
1518     return TrackedRecords;
1519   }
1520
1521   bool isAnonymous() const {
1522     return IsAnonymous;
1523   }
1524
1525   void print(raw_ostream &OS) const;
1526   void dump() const;
1527
1528   //===--------------------------------------------------------------------===//
1529   // High-level methods useful to tablegen back-ends
1530   //
1531
1532   /// Return the initializer for a value with the specified name,
1533   /// or throw an exception if the field does not exist.
1534   Init *getValueInit(StringRef FieldName) const;
1535
1536   /// Return true if the named field is unset.
1537   bool isValueUnset(StringRef FieldName) const {
1538     return isa<UnsetInit>(getValueInit(FieldName));
1539   }
1540
1541   /// This method looks up the specified field and returns
1542   /// its value as a string, throwing an exception if the field does not exist
1543   /// or if the value is not a string.
1544   StringRef getValueAsString(StringRef FieldName) const;
1545
1546   /// This method looks up the specified field and returns
1547   /// its value as a BitsInit, throwing an exception if the field does not exist
1548   /// or if the value is not the right type.
1549   BitsInit *getValueAsBitsInit(StringRef FieldName) const;
1550
1551   /// This method looks up the specified field and returns
1552   /// its value as a ListInit, throwing an exception if the field does not exist
1553   /// or if the value is not the right type.
1554   ListInit *getValueAsListInit(StringRef FieldName) const;
1555
1556   /// This method looks up the specified field and
1557   /// returns its value as a vector of records, throwing an exception if the
1558   /// field does not exist or if the value is not the right type.
1559   std::vector<Record*> getValueAsListOfDefs(StringRef FieldName) const;
1560
1561   /// This method looks up the specified field and
1562   /// returns its value as a vector of integers, throwing an exception if the
1563   /// field does not exist or if the value is not the right type.
1564   std::vector<int64_t> getValueAsListOfInts(StringRef FieldName) const;
1565
1566   /// This method looks up the specified field and
1567   /// returns its value as a vector of strings, throwing an exception if the
1568   /// field does not exist or if the value is not the right type.
1569   std::vector<StringRef> getValueAsListOfStrings(StringRef FieldName) const;
1570
1571   /// This method looks up the specified field and returns its
1572   /// value as a Record, throwing an exception if the field does not exist or if
1573   /// the value is not the right type.
1574   Record *getValueAsDef(StringRef FieldName) const;
1575
1576   /// This method looks up the specified field and returns its
1577   /// value as a bit, throwing an exception if the field does not exist or if
1578   /// the value is not the right type.
1579   bool getValueAsBit(StringRef FieldName) const;
1580
1581   /// This method looks up the specified field and
1582   /// returns its value as a bit. If the field is unset, sets Unset to true and
1583   /// returns false.
1584   bool getValueAsBitOrUnset(StringRef FieldName, bool &Unset) const;
1585
1586   /// This method looks up the specified field and returns its
1587   /// value as an int64_t, throwing an exception if the field does not exist or
1588   /// if the value is not the right type.
1589   int64_t getValueAsInt(StringRef FieldName) const;
1590
1591   /// This method looks up the specified field and returns its
1592   /// value as an Dag, throwing an exception if the field does not exist or if
1593   /// the value is not the right type.
1594   DagInit *getValueAsDag(StringRef FieldName) const;
1595 };
1596
1597 raw_ostream &operator<<(raw_ostream &OS, const Record &R);
1598
1599 struct MultiClass {
1600   Record Rec;  // Placeholder for template args and Name.
1601   using RecordVector = std::vector<std::unique_ptr<Record>>;
1602   RecordVector DefPrototypes;
1603
1604   void dump() const;
1605
1606   MultiClass(StringRef Name, SMLoc Loc, RecordKeeper &Records) :
1607     Rec(Name, Loc, Records) {}
1608 };
1609
1610 class RecordKeeper {
1611   friend class RecordRecTy;
1612   using RecordMap = std::map<std::string, std::unique_ptr<Record>>;
1613   RecordMap Classes, Defs;
1614   FoldingSet<RecordRecTy> RecordTypePool;
1615   unsigned AnonCounter = 0;
1616
1617 public:
1618   const RecordMap &getClasses() const { return Classes; }
1619   const RecordMap &getDefs() const { return Defs; }
1620
1621   Record *getClass(StringRef Name) const {
1622     auto I = Classes.find(Name);
1623     return I == Classes.end() ? nullptr : I->second.get();
1624   }
1625
1626   Record *getDef(StringRef Name) const {
1627     auto I = Defs.find(Name);
1628     return I == Defs.end() ? nullptr : I->second.get();
1629   }
1630
1631   void addClass(std::unique_ptr<Record> R) {
1632     bool Ins = Classes.insert(std::make_pair(R->getName(),
1633                                              std::move(R))).second;
1634     (void)Ins;
1635     assert(Ins && "Class already exists");
1636   }
1637
1638   void addDef(std::unique_ptr<Record> R) {
1639     bool Ins = Defs.insert(std::make_pair(R->getName(),
1640                                           std::move(R))).second;
1641     (void)Ins;
1642     assert(Ins && "Record already exists");
1643   }
1644
1645   Init *getNewAnonymousName();
1646
1647   //===--------------------------------------------------------------------===//
1648   // High-level helper methods, useful for tablegen backends...
1649
1650   /// This method returns all concrete definitions
1651   /// that derive from the specified class name.  A class with the specified
1652   /// name must exist.
1653   std::vector<Record *> getAllDerivedDefinitions(StringRef ClassName) const;
1654
1655   void dump() const;
1656 };
1657
1658 /// Sorting predicate to sort record pointers by name.
1659 struct LessRecord {
1660   bool operator()(const Record *Rec1, const Record *Rec2) const {
1661     return StringRef(Rec1->getName()).compare_numeric(Rec2->getName()) < 0;
1662   }
1663 };
1664
1665 /// Sorting predicate to sort record pointers by their
1666 /// unique ID. If you just need a deterministic order, use this, since it
1667 /// just compares two `unsigned`; the other sorting predicates require
1668 /// string manipulation.
1669 struct LessRecordByID {
1670   bool operator()(const Record *LHS, const Record *RHS) const {
1671     return LHS->getID() < RHS->getID();
1672   }
1673 };
1674
1675 /// Sorting predicate to sort record pointers by their
1676 /// name field.
1677 struct LessRecordFieldName {
1678   bool operator()(const Record *Rec1, const Record *Rec2) const {
1679     return Rec1->getValueAsString("Name") < Rec2->getValueAsString("Name");
1680   }
1681 };
1682
1683 struct LessRecordRegister {
1684   static bool ascii_isdigit(char x) { return x >= '0' && x <= '9'; }
1685
1686   struct RecordParts {
1687     SmallVector<std::pair< bool, StringRef>, 4> Parts;
1688
1689     RecordParts(StringRef Rec) {
1690       if (Rec.empty())
1691         return;
1692
1693       size_t Len = 0;
1694       const char *Start = Rec.data();
1695       const char *Curr = Start;
1696       bool isDigitPart = ascii_isdigit(Curr[0]);
1697       for (size_t I = 0, E = Rec.size(); I != E; ++I, ++Len) {
1698         bool isDigit = ascii_isdigit(Curr[I]);
1699         if (isDigit != isDigitPart) {
1700           Parts.push_back(std::make_pair(isDigitPart, StringRef(Start, Len)));
1701           Len = 0;
1702           Start = &Curr[I];
1703           isDigitPart = ascii_isdigit(Curr[I]);
1704         }
1705       }
1706       // Push the last part.
1707       Parts.push_back(std::make_pair(isDigitPart, StringRef(Start, Len)));
1708     }
1709
1710     size_t size() { return Parts.size(); }
1711
1712     std::pair<bool, StringRef> getPart(size_t i) {
1713       assert (i < Parts.size() && "Invalid idx!");
1714       return Parts[i];
1715     }
1716   };
1717
1718   bool operator()(const Record *Rec1, const Record *Rec2) const {
1719     RecordParts LHSParts(StringRef(Rec1->getName()));
1720     RecordParts RHSParts(StringRef(Rec2->getName()));
1721
1722     size_t LHSNumParts = LHSParts.size();
1723     size_t RHSNumParts = RHSParts.size();
1724     assert (LHSNumParts && RHSNumParts && "Expected at least one part!");
1725
1726     if (LHSNumParts != RHSNumParts)
1727       return LHSNumParts < RHSNumParts;
1728
1729     // We expect the registers to be of the form [_a-zA-Z]+([0-9]*[_a-zA-Z]*)*.
1730     for (size_t I = 0, E = LHSNumParts; I < E; I+=2) {
1731       std::pair<bool, StringRef> LHSPart = LHSParts.getPart(I);
1732       std::pair<bool, StringRef> RHSPart = RHSParts.getPart(I);
1733       // Expect even part to always be alpha.
1734       assert (LHSPart.first == false && RHSPart.first == false &&
1735               "Expected both parts to be alpha.");
1736       if (int Res = LHSPart.second.compare(RHSPart.second))
1737         return Res < 0;
1738     }
1739     for (size_t I = 1, E = LHSNumParts; I < E; I+=2) {
1740       std::pair<bool, StringRef> LHSPart = LHSParts.getPart(I);
1741       std::pair<bool, StringRef> RHSPart = RHSParts.getPart(I);
1742       // Expect odd part to always be numeric.
1743       assert (LHSPart.first == true && RHSPart.first == true &&
1744               "Expected both parts to be numeric.");
1745       if (LHSPart.second.size() != RHSPart.second.size())
1746         return LHSPart.second.size() < RHSPart.second.size();
1747
1748       unsigned LHSVal, RHSVal;
1749
1750       bool LHSFailed = LHSPart.second.getAsInteger(10, LHSVal); (void)LHSFailed;
1751       assert(!LHSFailed && "Unable to convert LHS to integer.");
1752       bool RHSFailed = RHSPart.second.getAsInteger(10, RHSVal); (void)RHSFailed;
1753       assert(!RHSFailed && "Unable to convert RHS to integer.");
1754
1755       if (LHSVal != RHSVal)
1756         return LHSVal < RHSVal;
1757     }
1758     return LHSNumParts < RHSNumParts;
1759   }
1760 };
1761
1762 raw_ostream &operator<<(raw_ostream &OS, const RecordKeeper &RK);
1763
1764 /// Return an Init with a qualifier prefix referring
1765 /// to CurRec's name.
1766 Init *QualifyName(Record &CurRec, MultiClass *CurMultiClass,
1767                   Init *Name, StringRef Scoper);
1768
1769 //===----------------------------------------------------------------------===//
1770 //  Resolvers
1771 //===----------------------------------------------------------------------===//
1772
1773 /// Interface for looking up the initializer for a variable name, used by
1774 /// Init::resolveReferences.
1775 class Resolver {
1776   Record *CurRec;
1777
1778 public:
1779   explicit Resolver(Record *CurRec) : CurRec(CurRec) {}
1780   virtual ~Resolver() {}
1781
1782   Record *getCurrentRecord() const { return CurRec; }
1783
1784   /// Return the initializer for the given variable name (should normally be a
1785   /// StringInit), or nullptr if the name could not be resolved.
1786   virtual Init *resolve(Init *VarName) = 0;
1787
1788   // Whether bits in a BitsInit should stay unresolved if resolving them would
1789   // result in a ? (UnsetInit). This behavior is used to represent instruction
1790   // encodings by keeping references to unset variables within a record.
1791   virtual bool keepUnsetBits() const { return false; }
1792 };
1793
1794 /// Resolve arbitrary mappings.
1795 class MapResolver final : public Resolver {
1796   struct MappedValue {
1797     Init *V;
1798     bool Resolved;
1799
1800     MappedValue() : V(nullptr), Resolved(false) {}
1801     MappedValue(Init *V, bool Resolved) : V(V), Resolved(Resolved) {}
1802   };
1803
1804   DenseMap<Init *, MappedValue> Map;
1805
1806 public:
1807   explicit MapResolver(Record *CurRec = nullptr) : Resolver(CurRec) {}
1808
1809   void set(Init *Key, Init *Value) { Map[Key] = {Value, false}; }
1810
1811   Init *resolve(Init *VarName) override;
1812 };
1813
1814 /// Resolve all variables from a record except for unset variables.
1815 class RecordResolver final : public Resolver {
1816   DenseMap<Init *, Init *> Cache;
1817   SmallVector<Init *, 4> Stack;
1818
1819 public:
1820   explicit RecordResolver(Record &R) : Resolver(&R) {}
1821
1822   Init *resolve(Init *VarName) override;
1823
1824   bool keepUnsetBits() const override { return true; }
1825 };
1826
1827 /// Resolve all references to a specific RecordVal.
1828 //
1829 // TODO: This is used for resolving references to template arguments, in a
1830 //       rather inefficient way. Change those uses to resolve all template
1831 //       arguments simultaneously and get rid of this class.
1832 class RecordValResolver final : public Resolver {
1833   const RecordVal *RV;
1834
1835 public:
1836   explicit RecordValResolver(Record &R, const RecordVal *RV)
1837       : Resolver(&R), RV(RV) {}
1838
1839   Init *resolve(Init *VarName) override {
1840     if (VarName == RV->getNameInit())
1841       return RV->getValue();
1842     return nullptr;
1843   }
1844 };
1845
1846 /// Delegate resolving to a sub-resolver, but shadow some variable names.
1847 class ShadowResolver final : public Resolver {
1848   Resolver &R;
1849   DenseSet<Init *> Shadowed;
1850
1851 public:
1852   explicit ShadowResolver(Resolver &R) : Resolver(R.getCurrentRecord()), R(R) {}
1853
1854   void addShadow(Init *Key) { Shadowed.insert(Key); }
1855
1856   Init *resolve(Init *VarName) override {
1857     if (Shadowed.count(VarName))
1858       return nullptr;
1859     return R.resolve(VarName);
1860   }
1861 };
1862
1863 /// (Optionally) delegate resolving to a sub-resolver, and keep track whether
1864 /// there were unresolved references.
1865 class TrackUnresolvedResolver final : public Resolver {
1866   Resolver *R;
1867   bool FoundUnresolved = false;
1868
1869 public:
1870   explicit TrackUnresolvedResolver(Resolver *R = nullptr)
1871       : Resolver(R ? R->getCurrentRecord() : nullptr), R(R) {}
1872
1873   bool foundUnresolved() const { return FoundUnresolved; }
1874
1875   Init *resolve(Init *VarName) override;
1876 };
1877
1878 } // end namespace llvm
1879
1880 #endif // LLVM_TABLEGEN_RECORD_H