lib/CodeGen/MIRParser/MILexer.cpp

   1 //===- MILexer.cpp - Machine instructions lexer implementation ----------===//
   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 implements the lexing of machine instructions.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "MILexer.h"
  15 #include "llvm/ADT/StringSwitch.h"
  16 #include "llvm/ADT/Twine.h"
  17 #include <cctype>
  18
  19 using namespace llvm;
  20
  21 namespace {
  22
  23 /// This class provides a way to iterate and get characters from the source
  24 /// string.
  25 class Cursor {
  26   const char *Ptr;
  27   const char *End;
  28
  29 public:
  30   Cursor(NoneType) : Ptr(nullptr), End(nullptr) {}
  31
  32   explicit Cursor(StringRef Str) {
  33     Ptr = Str.data();
  34     End = Ptr + Str.size();
  35   }
  36
  37   bool isEOF() const { return Ptr == End; }
  38
  39   char peek(int I = 0) const { return End - Ptr <= I ? 0 : Ptr[I]; }
  40
  41   void advance(unsigned I = 1) { Ptr += I; }
  42
  43   StringRef remaining() const { return StringRef(Ptr, End - Ptr); }
  44
  45   StringRef upto(Cursor C) const {
  46     assert(C.Ptr >= Ptr && C.Ptr <= End);
  47     return StringRef(Ptr, C.Ptr - Ptr);
  48   }
  49
  50   StringRef::iterator location() const { return Ptr; }
  51
  52   operator bool() const { return Ptr != nullptr; }
  53 };
  54
  55 } // end anonymous namespace
  56
  57 /// Skip the leading whitespace characters and return the updated cursor.
  58 static Cursor skipWhitespace(Cursor C) {
  59   while (isspace(C.peek()))
  60     C.advance();
  61   return C;
  62 }
  63
  64 static bool isIdentifierChar(char C) {
  65   return isalpha(C) || isdigit(C) || C == '_' || C == '-' || C == '.';
  66 }
  67
  68 static MIToken::TokenKind getIdentifierKind(StringRef Identifier) {
  69   return StringSwitch<MIToken::TokenKind>(Identifier)
  70       .Case("_", MIToken::underscore)
  71       .Case("implicit", MIToken::kw_implicit)
  72       .Case("implicit-def", MIToken::kw_implicit_define)
  73       .Case("dead", MIToken::kw_dead)
  74       .Default(MIToken::Identifier);
  75 }
  76
  77 static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
  78   if (!isalpha(C.peek()) && C.peek() != '_')
  79     return None;
  80   auto Range = C;
  81   while (isIdentifierChar(C.peek()))
  82     C.advance();
  83   auto Identifier = Range.upto(C);
  84   Token = MIToken(getIdentifierKind(Identifier), Identifier);
  85   return C;
  86 }
  87
  88 static Cursor maybeLexMachineBasicBlock(
  89     Cursor C, MIToken &Token,
  90     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
  91   if (!C.remaining().startswith("%bb."))
  92     return None;
  93   auto Range = C;
  94   C.advance(4); // Skip '%bb.'
  95   if (!isdigit(C.peek())) {
  96     Token = MIToken(MIToken::Error, C.remaining());
  97     ErrorCallback(C.location(), "expected a number after '%bb.'");
  98     return C;
  99   }
 100   auto NumberRange = C;
 101   while (isdigit(C.peek()))
 102     C.advance();
 103   StringRef Number = NumberRange.upto(C);
 104   unsigned StringOffset = 4 + Number.size(); // Drop '%bb.<id>'
 105   if (C.peek() == '.') {
 106     C.advance(); // Skip '.'
 107     ++StringOffset;
 108     while (isIdentifierChar(C.peek()))
 109       C.advance();
 110   }
 111   Token = MIToken(MIToken::MachineBasicBlock, Range.upto(C), APSInt(Number),
 112                   StringOffset);
 113   return C;
 114 }
 115
 116 static Cursor maybeLexRegister(Cursor C, MIToken &Token) {
 117   if (C.peek() != '%')
 118     return None;
 119   auto Range = C;
 120   C.advance(); // Skip '%'
 121   while (isIdentifierChar(C.peek()))
 122     C.advance();
 123   Token = MIToken(MIToken::NamedRegister, Range.upto(C),
 124                   /*StringOffset=*/1); // Drop the '%'
 125   return C;
 126 }
 127
 128 static Cursor maybeLexGlobalValue(Cursor C, MIToken &Token) {
 129   if (C.peek() != '@')
 130     return None;
 131   auto Range = C;
 132   C.advance(); // Skip the '@'
 133   // TODO: add support for quoted names.
 134   if (!isdigit(C.peek())) {
 135     while (isIdentifierChar(C.peek()))
 136       C.advance();
 137     Token = MIToken(MIToken::NamedGlobalValue, Range.upto(C),
 138                     /*StringOffset=*/1); // Drop the '@'
 139     return C;
 140   }
 141   auto NumberRange = C;
 142   while (isdigit(C.peek()))
 143     C.advance();
 144   Token =
 145       MIToken(MIToken::GlobalValue, Range.upto(C), APSInt(NumberRange.upto(C)));
 146   return C;
 147 }
 148
 149 static Cursor maybeLexIntegerLiteral(Cursor C, MIToken &Token) {
 150   if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(1))))
 151     return None;
 152   auto Range = C;
 153   C.advance();
 154   while (isdigit(C.peek()))
 155     C.advance();
 156   StringRef StrVal = Range.upto(C);
 157   Token = MIToken(MIToken::IntegerLiteral, StrVal, APSInt(StrVal));
 158   return C;
 159 }
 160
 161 static MIToken::TokenKind symbolToken(char C) {
 162   switch (C) {
 163   case ',':
 164     return MIToken::comma;
 165   case '=':
 166     return MIToken::equal;
 167   default:
 168     return MIToken::Error;
 169   }
 170 }
 171
 172 static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
 173   auto Kind = symbolToken(C.peek());
 174   if (Kind == MIToken::Error)
 175     return None;
 176   auto Range = C;
 177   C.advance();
 178   Token = MIToken(Kind, Range.upto(C));
 179   return C;
 180 }
 181
 182 StringRef llvm::lexMIToken(
 183     StringRef Source, MIToken &Token,
 184     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 185   auto C = skipWhitespace(Cursor(Source));
 186   if (C.isEOF()) {
 187     Token = MIToken(MIToken::Eof, C.remaining());
 188     return C.remaining();
 189   }
 190
 191   if (Cursor R = maybeLexIdentifier(C, Token))
 192     return R.remaining();
 193   if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
 194     return R.remaining();
 195   if (Cursor R = maybeLexRegister(C, Token))
 196     return R.remaining();
 197   if (Cursor R = maybeLexGlobalValue(C, Token))
 198     return R.remaining();
 199   if (Cursor R = maybeLexIntegerLiteral(C, Token))
 200     return R.remaining();
 201   if (Cursor R = maybeLexSymbol(C, Token))
 202     return R.remaining();
 203
 204   Token = MIToken(MIToken::Error, C.remaining());
 205   ErrorCallback(C.location(),
 206                 Twine("unexpected character '") + Twine(C.peek()) + "'");
 207   return C.remaining();
 208 }