include/llvm/MC/MCTargetAsmParser.h

   1 //===-- llvm/MC/MCTargetAsmParser.h - Target Assembly Parser ----*- 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 #ifndef LLVM_MC_MCTARGETASMPARSER_H
  11 #define LLVM_MC_MCTARGETASMPARSER_H
  12
  13 #include "llvm/MC/MCExpr.h"
  14 #include "llvm/MC/MCParser/MCAsmParserExtension.h"
  15 #include "llvm/MC/MCTargetOptions.h"
  16 #include <memory>
  17
  18 namespace llvm {
  19 class AsmToken;
  20 class MCInst;
  21 class MCParsedAsmOperand;
  22 class MCStreamer;
  23 class MCSubtargetInfo;
  24 class SMLoc;
  25 class StringRef;
  26 template <typename T> class SmallVectorImpl;
  27
  28 typedef SmallVectorImpl<std::unique_ptr<MCParsedAsmOperand>> OperandVector;
  29
  30 enum AsmRewriteKind {
  31   AOK_Delete = 0,     // Rewrite should be ignored.
  32   AOK_Align,          // Rewrite align as .align.
  33   AOK_DotOperator,    // Rewrite a dot operator expression as an immediate.
  34                       // E.g., [eax].foo.bar -> [eax].8
  35   AOK_Emit,           // Rewrite _emit as .byte.
  36   AOK_Imm,            // Rewrite as $$N.
  37   AOK_ImmPrefix,      // Add $$ before a parsed Imm.
  38   AOK_Input,          // Rewrite in terms of $N.
  39   AOK_Output,         // Rewrite in terms of $N.
  40   AOK_SizeDirective,  // Add a sizing directive (e.g., dword ptr).
  41   AOK_Label,          // Rewrite local labels.
  42   AOK_Skip            // Skip emission (e.g., offset/type operators).
  43 };
  44
  45 const char AsmRewritePrecedence [] = {
  46   0, // AOK_Delete
  47   2, // AOK_Align
  48   2, // AOK_DotOperator
  49   2, // AOK_Emit
  50   4, // AOK_Imm
  51   4, // AOK_ImmPrefix
  52   3, // AOK_Input
  53   3, // AOK_Output
  54   5, // AOK_SizeDirective
  55   1, // AOK_Label
  56   2  // AOK_Skip
  57 };
  58
  59 struct AsmRewrite {
  60   AsmRewriteKind Kind;
  61   SMLoc Loc;
  62   unsigned Len;
  63   unsigned Val;
  64   StringRef Label;
  65 public:
  66   AsmRewrite(AsmRewriteKind kind, SMLoc loc, unsigned len = 0, unsigned val = 0)
  67     : Kind(kind), Loc(loc), Len(len), Val(val) {}
  68   AsmRewrite(AsmRewriteKind kind, SMLoc loc, unsigned len, StringRef label)
  69     : Kind(kind), Loc(loc), Len(len), Val(0), Label(label) {}
  70 };
  71
  72 struct ParseInstructionInfo {
  73
  74   SmallVectorImpl<AsmRewrite> *AsmRewrites;
  75
  76   ParseInstructionInfo() : AsmRewrites(nullptr) {}
  77   ParseInstructionInfo(SmallVectorImpl<AsmRewrite> *rewrites)
  78     : AsmRewrites(rewrites) {}
  79 };
  80
  81 /// MCTargetAsmParser - Generic interface to target specific assembly parsers.
  82 class MCTargetAsmParser : public MCAsmParserExtension {
  83 public:
  84   enum MatchResultTy {
  85     Match_InvalidOperand,
  86     Match_MissingFeature,
  87     Match_MnemonicFail,
  88     Match_Success,
  89     FIRST_TARGET_MATCH_RESULT_TY
  90   };
  91
  92 private:
  93   MCTargetAsmParser(const MCTargetAsmParser &) = delete;
  94   void operator=(const MCTargetAsmParser &) = delete;
  95 protected: // Can only create subclasses.
  96   MCTargetAsmParser(MCTargetOptions const &, MCSubtargetInfo &STI);
  97
  98   /// AvailableFeatures - The current set of available features.
  99   uint64_t AvailableFeatures;
 100
 101   /// ParsingInlineAsm - Are we parsing ms-style inline assembly?
 102   bool ParsingInlineAsm;
 103
 104   /// SemaCallback - The Sema callback implementation.  Must be set when parsing
 105   /// ms-style inline assembly.
 106   MCAsmParserSemaCallback *SemaCallback;
 107
 108   /// Set of options which affects instrumentation of inline assembly.
 109   MCTargetOptions MCOptions;
 110
 111   /// Current STI.
 112   MCSubtargetInfo &STI;
 113
 114 public:
 115   ~MCTargetAsmParser() override;
 116
 117   const MCSubtargetInfo &getSTI() const;
 118
 119   uint64_t getAvailableFeatures() const { return AvailableFeatures; }
 120   void setAvailableFeatures(uint64_t Value) { AvailableFeatures = Value; }
 121
 122   bool isParsingInlineAsm () { return ParsingInlineAsm; }
 123   void setParsingInlineAsm (bool Value) { ParsingInlineAsm = Value; }
 124
 125   MCTargetOptions getTargetOptions() const { return MCOptions; }
 126
 127   void setSemaCallback(MCAsmParserSemaCallback *Callback) {
 128     SemaCallback = Callback;
 129   }
 130
 131   virtual bool ParseRegister(unsigned &RegNo, SMLoc &StartLoc,
 132                              SMLoc &EndLoc) = 0;
 133
 134   /// Sets frame register corresponding to the current MachineFunction.
 135   virtual void SetFrameRegister(unsigned RegNo) {}
 136
 137   /// ParseInstruction - Parse one assembly instruction.
 138   ///
 139   /// The parser is positioned following the instruction name. The target
 140   /// specific instruction parser should parse the entire instruction and
 141   /// construct the appropriate MCInst, or emit an error. On success, the entire
 142   /// line should be parsed up to and including the end-of-statement token. On
 143   /// failure, the parser is not required to read to the end of the line.
 144   //
 145   /// \param Name - The instruction name.
 146   /// \param NameLoc - The source location of the name.
 147   /// \param Operands [out] - The list of parsed operands, this returns
 148   ///        ownership of them to the caller.
 149   /// \return True on failure.
 150   virtual bool ParseInstruction(ParseInstructionInfo &Info, StringRef Name,
 151                                 SMLoc NameLoc, OperandVector &Operands) = 0;
 152   virtual bool ParseInstruction(ParseInstructionInfo &Info, StringRef Name,
 153                                 AsmToken Token, OperandVector &Operands) {
 154     return ParseInstruction(Info, Name, Token.getLoc(), Operands);
 155   }
 156
 157   /// ParseDirective - Parse a target specific assembler directive
 158   ///
 159   /// The parser is positioned following the directive name.  The target
 160   /// specific directive parser should parse the entire directive doing or
 161   /// recording any target specific work, or return true and do nothing if the
 162   /// directive is not target specific. If the directive is specific for
 163   /// the target, the entire line is parsed up to and including the
 164   /// end-of-statement token and false is returned.
 165   ///
 166   /// \param DirectiveID - the identifier token of the directive.
 167   virtual bool ParseDirective(AsmToken DirectiveID) = 0;
 168
 169   /// mnemonicIsValid - This returns true if this is a valid mnemonic and false
 170   /// otherwise.
 171   virtual bool mnemonicIsValid(StringRef Mnemonic, unsigned VariantID) = 0;
 172
 173   /// MatchAndEmitInstruction - Recognize a series of operands of a parsed
 174   /// instruction as an actual MCInst and emit it to the specified MCStreamer.
 175   /// This returns false on success and returns true on failure to match.
 176   ///
 177   /// On failure, the target parser is responsible for emitting a diagnostic
 178   /// explaining the match failure.
 179   virtual bool MatchAndEmitInstruction(SMLoc IDLoc, unsigned &Opcode,
 180                                        OperandVector &Operands, MCStreamer &Out,
 181                                        uint64_t &ErrorInfo,
 182                                        bool MatchingInlineAsm) = 0;
 183
 184   /// Allows targets to let registers opt out of clobber lists.
 185   virtual bool OmitRegisterFromClobberLists(unsigned RegNo) { return false; }
 186
 187   /// Allow a target to add special case operand matching for things that
 188   /// tblgen doesn't/can't handle effectively. For example, literal
 189   /// immediates on ARM. TableGen expects a token operand, but the parser
 190   /// will recognize them as immediates.
 191   virtual unsigned validateTargetOperandClass(MCParsedAsmOperand &Op,
 192                                               unsigned Kind) {
 193     return Match_InvalidOperand;
 194   }
 195
 196   /// checkTargetMatchPredicate - Validate the instruction match against
 197   /// any complex target predicates not expressible via match classes.
 198   virtual unsigned checkTargetMatchPredicate(MCInst &Inst) {
 199     return Match_Success;
 200   }
 201
 202   virtual void convertToMapAndConstraints(unsigned Kind,
 203                                           const OperandVector &Operands) = 0;
 204
 205   // Return whether this parser uses assignment statements with equals tokens
 206   virtual bool equalIsAsmAssignment() { return true; };
 207   // Return whether this start of statement identifier is a label
 208   virtual bool isLabel(AsmToken &Token) { return true; };
 209
 210   virtual const MCExpr *applyModifierToExpr(const MCExpr *E,
 211                                             MCSymbolRefExpr::VariantKind,
 212                                             MCContext &Ctx) {
 213     return nullptr;
 214   }
 215
 216   virtual void onLabelParsed(MCSymbol *Symbol) { }
 217 };
 218
 219 } // End llvm namespace
 220
 221 #endif