lib/TableGen/TGParser.h

   1 //===- TGParser.h - Parser for TableGen Files -------------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 // This class represents the Parser for tablegen files.
  10 //
  11 //===----------------------------------------------------------------------===//
  12
  13 #ifndef LLVM_LIB_TABLEGEN_TGPARSER_H
  14 #define LLVM_LIB_TABLEGEN_TGPARSER_H
  15
  16 #include "TGLexer.h"
  17 #include "llvm/ADT/Twine.h"
  18 #include "llvm/Support/SourceMgr.h"
  19 #include "llvm/TableGen/Error.h"
  20 #include "llvm/TableGen/Record.h"
  21 #include <map>
  22
  23 namespace llvm {
  24   class Record;
  25   class RecordVal;
  26   class RecordKeeper;
  27   class RecTy;
  28   class Init;
  29   struct ForeachLoop;
  30   struct MultiClass;
  31   struct SubClassReference;
  32   struct SubMultiClassReference;
  33
  34   struct LetRecord {
  35     StringInit *Name;
  36     std::vector<unsigned> Bits;
  37     Init *Value;
  38     SMLoc Loc;
  39     LetRecord(StringInit *N, ArrayRef<unsigned> B, Init *V, SMLoc L)
  40       : Name(N), Bits(B), Value(V), Loc(L) {
  41     }
  42   };
  43
  44   /// RecordsEntry - Can be either a record or a foreach loop.
  45   struct RecordsEntry {
  46     std::unique_ptr<Record> Rec;
  47     std::unique_ptr<ForeachLoop> Loop;
  48
  49     void dump() const;
  50
  51     RecordsEntry() {}
  52     RecordsEntry(std::unique_ptr<Record> Rec) : Rec(std::move(Rec)) {}
  53     RecordsEntry(std::unique_ptr<ForeachLoop> Loop)
  54       : Loop(std::move(Loop)) {}
  55   };
  56
  57   /// ForeachLoop - Record the iteration state associated with a for loop.
  58   /// This is used to instantiate items in the loop body.
  59   struct ForeachLoop {
  60     SMLoc Loc;
  61     VarInit *IterVar;
  62     Init *ListValue;
  63     std::vector<RecordsEntry> Entries;
  64
  65     void dump() const;
  66
  67     ForeachLoop(SMLoc Loc, VarInit *IVar, Init *LValue)
  68       : Loc(Loc), IterVar(IVar), ListValue(LValue) {}
  69   };
  70
  71   struct DefsetRecord {
  72     SMLoc Loc;
  73     RecTy *EltTy;
  74     SmallVector<Init *, 16> Elements;
  75   };
  76
  77 struct MultiClass {
  78   Record Rec;  // Placeholder for template args and Name.
  79   std::vector<RecordsEntry> Entries;
  80
  81   void dump() const;
  82
  83   MultiClass(StringRef Name, SMLoc Loc, RecordKeeper &Records) :
  84     Rec(Name, Loc, Records) {}
  85 };
  86
  87 class TGParser {
  88   TGLexer Lex;
  89   std::vector<SmallVector<LetRecord, 4>> LetStack;
  90   std::map<std::string, std::unique_ptr<MultiClass>> MultiClasses;
  91
  92   /// Loops - Keep track of any foreach loops we are within.
  93   ///
  94   std::vector<std::unique_ptr<ForeachLoop>> Loops;
  95
  96   SmallVector<DefsetRecord *, 2> Defsets;
  97
  98   /// CurMultiClass - If we are parsing a 'multiclass' definition, this is the
  99   /// current value.
 100   MultiClass *CurMultiClass;
 101
 102   // Record tracker
 103   RecordKeeper &Records;
 104
 105   // A "named boolean" indicating how to parse identifiers.  Usually
 106   // identifiers map to some existing object but in special cases
 107   // (e.g. parsing def names) no such object exists yet because we are
 108   // in the middle of creating in.  For those situations, allow the
 109   // parser to ignore missing object errors.
 110   enum IDParseMode {
 111     ParseValueMode,   // We are parsing a value we expect to look up.
 112     ParseNameMode,    // We are parsing a name of an object that does not yet
 113                       // exist.
 114   };
 115
 116 public:
 117   TGParser(SourceMgr &SrcMgr, ArrayRef<std::string> Macros,
 118            RecordKeeper &records)
 119     : Lex(SrcMgr, Macros), CurMultiClass(nullptr), Records(records) {}
 120
 121   /// ParseFile - Main entrypoint for parsing a tblgen file.  These parser
 122   /// routines return true on error, or false on success.
 123   bool ParseFile();
 124
 125   bool Error(SMLoc L, const Twine &Msg) const {
 126     PrintError(L, Msg);
 127     return true;
 128   }
 129   bool TokError(const Twine &Msg) const {
 130     return Error(Lex.getLoc(), Msg);
 131   }
 132   const TGLexer::DependenciesMapTy &getDependencies() const {
 133     return Lex.getDependencies();
 134   }
 135
 136 private:  // Semantic analysis methods.
 137   bool AddValue(Record *TheRec, SMLoc Loc, const RecordVal &RV);
 138   bool SetValue(Record *TheRec, SMLoc Loc, Init *ValName,
 139                 ArrayRef<unsigned> BitList, Init *V,
 140                 bool AllowSelfAssignment = false);
 141   bool AddSubClass(Record *Rec, SubClassReference &SubClass);
 142   bool AddSubClass(RecordsEntry &Entry, SubClassReference &SubClass);
 143   bool AddSubMultiClass(MultiClass *CurMC,
 144                         SubMultiClassReference &SubMultiClass);
 145
 146   using SubstStack = SmallVector<std::pair<Init *, Init *>, 8>;
 147
 148   bool addEntry(RecordsEntry E);
 149   bool resolve(const ForeachLoop &Loop, SubstStack &Stack, bool Final,
 150                std::vector<RecordsEntry> *Dest, SMLoc *Loc = nullptr);
 151   bool resolve(const std::vector<RecordsEntry> &Source, SubstStack &Substs,
 152                bool Final, std::vector<RecordsEntry> *Dest,
 153                SMLoc *Loc = nullptr);
 154   bool addDefOne(std::unique_ptr<Record> Rec);
 155
 156 private:  // Parser methods.
 157   bool ParseObjectList(MultiClass *MC = nullptr);
 158   bool ParseObject(MultiClass *MC);
 159   bool ParseClass();
 160   bool ParseMultiClass();
 161   bool ParseDefm(MultiClass *CurMultiClass);
 162   bool ParseDef(MultiClass *CurMultiClass);
 163   bool ParseDefset();
 164   bool ParseForeach(MultiClass *CurMultiClass);
 165   bool ParseTopLevelLet(MultiClass *CurMultiClass);
 166   void ParseLetList(SmallVectorImpl<LetRecord> &Result);
 167
 168   bool ParseObjectBody(Record *CurRec);
 169   bool ParseBody(Record *CurRec);
 170   bool ParseBodyItem(Record *CurRec);
 171
 172   bool ParseTemplateArgList(Record *CurRec);
 173   Init *ParseDeclaration(Record *CurRec, bool ParsingTemplateArgs);
 174   VarInit *ParseForeachDeclaration(Init *&ForeachListValue);
 175
 176   SubClassReference ParseSubClassReference(Record *CurRec, bool isDefm);
 177   SubMultiClassReference ParseSubMultiClassReference(MultiClass *CurMC);
 178
 179   Init *ParseIDValue(Record *CurRec, StringInit *Name, SMLoc NameLoc,
 180                      IDParseMode Mode = ParseValueMode);
 181   Init *ParseSimpleValue(Record *CurRec, RecTy *ItemType = nullptr,
 182                          IDParseMode Mode = ParseValueMode);
 183   Init *ParseValue(Record *CurRec, RecTy *ItemType = nullptr,
 184                    IDParseMode Mode = ParseValueMode);
 185   void ParseValueList(SmallVectorImpl<llvm::Init*> &Result, Record *CurRec,
 186                       Record *ArgsRec = nullptr, RecTy *EltTy = nullptr);
 187   void ParseDagArgList(
 188       SmallVectorImpl<std::pair<llvm::Init*, StringInit*>> &Result,
 189       Record *CurRec);
 190   bool ParseOptionalRangeList(SmallVectorImpl<unsigned> &Ranges);
 191   bool ParseOptionalBitList(SmallVectorImpl<unsigned> &Ranges);
 192   void ParseRangeList(SmallVectorImpl<unsigned> &Result);
 193   bool ParseRangePiece(SmallVectorImpl<unsigned> &Ranges,
 194                        TypedInit *FirstItem = nullptr);
 195   RecTy *ParseType();
 196   Init *ParseOperation(Record *CurRec, RecTy *ItemType);
 197   Init *ParseOperationCond(Record *CurRec, RecTy *ItemType);
 198   RecTy *ParseOperatorType();
 199   Init *ParseObjectName(MultiClass *CurMultiClass);
 200   Record *ParseClassID();
 201   MultiClass *ParseMultiClassID();
 202   bool ApplyLetStack(Record *CurRec);
 203   bool ApplyLetStack(RecordsEntry &Entry);
 204 };
 205
 206 } // end namespace llvm
 207
 208 #endif