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/StringExtras.h"
  16 #include "llvm/ADT/StringSwitch.h"
  17 #include "llvm/ADT/Twine.h"
  18 #include <cctype>
  19
  20 using namespace llvm;
  21
  22 namespace {
  23
  24 /// This class provides a way to iterate and get characters from the source
  25 /// string.
  26 class Cursor {
  27   const char *Ptr;
  28   const char *End;
  29
  30 public:
  31   Cursor(NoneType) : Ptr(nullptr), End(nullptr) {}
  32
  33   explicit Cursor(StringRef Str) {
  34     Ptr = Str.data();
  35     End = Ptr + Str.size();
  36   }
  37
  38   bool isEOF() const { return Ptr == End; }
  39
  40   char peek(int I = 0) const { return End - Ptr <= I ? 0 : Ptr[I]; }
  41
  42   void advance(unsigned I = 1) { Ptr += I; }
  43
  44   StringRef remaining() const { return StringRef(Ptr, End - Ptr); }
  45
  46   StringRef upto(Cursor C) const {
  47     assert(C.Ptr >= Ptr && C.Ptr <= End);
  48     return StringRef(Ptr, C.Ptr - Ptr);
  49   }
  50
  51   StringRef::iterator location() const { return Ptr; }
  52
  53   operator bool() const { return Ptr != nullptr; }
  54 };
  55
  56 } // end anonymous namespace
  57
  58 /// Skip the leading whitespace characters and return the updated cursor.
  59 static Cursor skipWhitespace(Cursor C) {
  60   while (isspace(C.peek()))
  61     C.advance();
  62   return C;
  63 }
  64
  65 /// Return true if the given character satisfies the following regular
  66 /// expression: [-a-zA-Z$._0-9]
  67 static bool isIdentifierChar(char C) {
  68   return isalpha(C) || isdigit(C) || C == '_' || C == '-' || C == '.' ||
  69          C == '$';
  70 }
  71
  72 void MIToken::unescapeQuotedStringValue(std::string &Str) const {
  73   assert(isStringValueQuoted() && "String value isn't quoted");
  74   StringRef Value = Range.drop_front(StringOffset);
  75   assert(Value.front() == '"' && Value.back() == '"');
  76   Cursor C = Cursor(Value.substr(1, Value.size() - 2));
  77
  78   Str.clear();
  79   Str.reserve(C.remaining().size());
  80   while (!C.isEOF()) {
  81     char Char = C.peek();
  82     if (Char == '\\') {
  83       if (C.peek(1) == '\\') {
  84         // Two '\' become one
  85         Str += '\\';
  86         C.advance(2);
  87         continue;
  88       }
  89       if (isxdigit(C.peek(1)) && isxdigit(C.peek(2))) {
  90         Str += hexDigitValue(C.peek(1)) * 16 + hexDigitValue(C.peek(2));
  91         C.advance(3);
  92         continue;
  93       }
  94     }
  95     Str += Char;
  96     C.advance();
  97   }
  98 }
  99
 100 /// Lex a string constant using the following regular expression: \"[^\"]*\"
 101 static Cursor lexStringConstant(
 102     Cursor C,
 103     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 104   assert(C.peek() == '"');
 105   for (C.advance(); C.peek() != '"'; C.advance()) {
 106     if (C.isEOF()) {
 107       ErrorCallback(
 108           C.location(),
 109           "end of machine instruction reached before the closing '\"'");
 110       return None;
 111     }
 112   }
 113   C.advance();
 114   return C;
 115 }
 116
 117 static MIToken::TokenKind getIdentifierKind(StringRef Identifier) {
 118   return StringSwitch<MIToken::TokenKind>(Identifier)
 119       .Case("_", MIToken::underscore)
 120       .Case("implicit", MIToken::kw_implicit)
 121       .Case("implicit-def", MIToken::kw_implicit_define)
 122       .Case("dead", MIToken::kw_dead)
 123       .Case("killed", MIToken::kw_killed)
 124       .Case("undef", MIToken::kw_undef)
 125       .Case("frame-setup", MIToken::kw_frame_setup)
 126       .Default(MIToken::Identifier);
 127 }
 128
 129 static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
 130   if (!isalpha(C.peek()) && C.peek() != '_')
 131     return None;
 132   auto Range = C;
 133   while (isIdentifierChar(C.peek()))
 134     C.advance();
 135   auto Identifier = Range.upto(C);
 136   Token = MIToken(getIdentifierKind(Identifier), Identifier);
 137   return C;
 138 }
 139
 140 static Cursor maybeLexMachineBasicBlock(
 141     Cursor C, MIToken &Token,
 142     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 143   if (!C.remaining().startswith("%bb."))
 144     return None;
 145   auto Range = C;
 146   C.advance(4); // Skip '%bb.'
 147   if (!isdigit(C.peek())) {
 148     Token = MIToken(MIToken::Error, C.remaining());
 149     ErrorCallback(C.location(), "expected a number after '%bb.'");
 150     return C;
 151   }
 152   auto NumberRange = C;
 153   while (isdigit(C.peek()))
 154     C.advance();
 155   StringRef Number = NumberRange.upto(C);
 156   unsigned StringOffset = 4 + Number.size(); // Drop '%bb.<id>'
 157   if (C.peek() == '.') {
 158     C.advance(); // Skip '.'
 159     ++StringOffset;
 160     while (isIdentifierChar(C.peek()))
 161       C.advance();
 162   }
 163   Token = MIToken(MIToken::MachineBasicBlock, Range.upto(C), APSInt(Number),
 164                   StringOffset);
 165   return C;
 166 }
 167
 168 static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
 169                             MIToken::TokenKind Kind) {
 170   if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
 171     return None;
 172   auto Range = C;
 173   C.advance(Rule.size());
 174   auto NumberRange = C;
 175   while (isdigit(C.peek()))
 176     C.advance();
 177   Token = MIToken(Kind, Range.upto(C), APSInt(NumberRange.upto(C)));
 178   return C;
 179 }
 180
 181 static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
 182                                    MIToken::TokenKind Kind) {
 183   if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
 184     return None;
 185   auto Range = C;
 186   C.advance(Rule.size());
 187   auto NumberRange = C;
 188   while (isdigit(C.peek()))
 189     C.advance();
 190   StringRef Number = NumberRange.upto(C);
 191   unsigned StringOffset = Rule.size() + Number.size();
 192   if (C.peek() == '.') {
 193     C.advance();
 194     ++StringOffset;
 195     while (isIdentifierChar(C.peek()))
 196       C.advance();
 197   }
 198   Token = MIToken(Kind, Range.upto(C), APSInt(Number), StringOffset);
 199   return C;
 200 }
 201
 202 static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
 203   return maybeLexIndex(C, Token, "%jump-table.", MIToken::JumpTableIndex);
 204 }
 205
 206 static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
 207   return maybeLexIndexAndName(C, Token, "%stack.", MIToken::StackObject);
 208 }
 209
 210 static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
 211   return maybeLexIndex(C, Token, "%fixed-stack.", MIToken::FixedStackObject);
 212 }
 213
 214 static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
 215   return maybeLexIndex(C, Token, "%const.", MIToken::ConstantPoolItem);
 216 }
 217
 218 static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
 219   auto Range = C;
 220   C.advance(); // Skip '%'
 221   auto NumberRange = C;
 222   while (isdigit(C.peek()))
 223     C.advance();
 224   Token = MIToken(MIToken::VirtualRegister, Range.upto(C),
 225                   APSInt(NumberRange.upto(C)));
 226   return C;
 227 }
 228
 229 static Cursor maybeLexRegister(Cursor C, MIToken &Token) {
 230   if (C.peek() != '%')
 231     return None;
 232   if (isdigit(C.peek(1)))
 233     return lexVirtualRegister(C, Token);
 234   auto Range = C;
 235   C.advance(); // Skip '%'
 236   while (isIdentifierChar(C.peek()))
 237     C.advance();
 238   Token = MIToken(MIToken::NamedRegister, Range.upto(C),
 239                   /*StringOffset=*/1); // Drop the '%'
 240   return C;
 241 }
 242
 243 static Cursor maybeLexGlobalValue(
 244     Cursor C, MIToken &Token,
 245     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 246   if (C.peek() != '@')
 247     return None;
 248   auto Range = C;
 249   C.advance(); // Skip the '@'
 250   if (C.peek() == '"') {
 251     if (Cursor R = lexStringConstant(C, ErrorCallback)) {
 252       Token = MIToken(MIToken::QuotedNamedGlobalValue, Range.upto(R),
 253                       /*StringOffset=*/1); // Drop the '@'
 254       return R;
 255     }
 256     Token = MIToken(MIToken::Error, Range.remaining());
 257     return Range;
 258   }
 259   if (!isdigit(C.peek())) {
 260     while (isIdentifierChar(C.peek()))
 261       C.advance();
 262     Token = MIToken(MIToken::NamedGlobalValue, Range.upto(C),
 263                     /*StringOffset=*/1); // Drop the '@'
 264     return C;
 265   }
 266   auto NumberRange = C;
 267   while (isdigit(C.peek()))
 268     C.advance();
 269   Token =
 270       MIToken(MIToken::GlobalValue, Range.upto(C), APSInt(NumberRange.upto(C)));
 271   return C;
 272 }
 273
 274 static Cursor lexName(
 275     Cursor C, MIToken &Token, MIToken::TokenKind Type,
 276     MIToken::TokenKind QuotedType, unsigned PrefixLength,
 277     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 278   auto Range = C;
 279   C.advance(PrefixLength);
 280   if (C.peek() == '"') {
 281     if (Cursor R = lexStringConstant(C, ErrorCallback)) {
 282       Token = MIToken(QuotedType, Range.upto(R), PrefixLength);
 283       return R;
 284     }
 285     Token = MIToken(MIToken::Error, Range.remaining());
 286     return Range;
 287   }
 288   while (isIdentifierChar(C.peek()))
 289     C.advance();
 290   Token = MIToken(Type, Range.upto(C), PrefixLength);
 291   return C;
 292 }
 293
 294 static Cursor maybeLexExternalSymbol(
 295     Cursor C, MIToken &Token,
 296     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 297   if (C.peek() != '$')
 298     return None;
 299   return lexName(C, Token, MIToken::ExternalSymbol,
 300                  MIToken::QuotedExternalSymbol,
 301                  /*PrefixLength=*/1, ErrorCallback);
 302 }
 303
 304 static Cursor maybeLexIntegerLiteral(Cursor C, MIToken &Token) {
 305   if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(1))))
 306     return None;
 307   auto Range = C;
 308   C.advance();
 309   while (isdigit(C.peek()))
 310     C.advance();
 311   StringRef StrVal = Range.upto(C);
 312   Token = MIToken(MIToken::IntegerLiteral, StrVal, APSInt(StrVal));
 313   return C;
 314 }
 315
 316 static MIToken::TokenKind symbolToken(char C) {
 317   switch (C) {
 318   case ',':
 319     return MIToken::comma;
 320   case '=':
 321     return MIToken::equal;
 322   case ':':
 323     return MIToken::colon;
 324   default:
 325     return MIToken::Error;
 326   }
 327 }
 328
 329 static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
 330   auto Kind = symbolToken(C.peek());
 331   if (Kind == MIToken::Error)
 332     return None;
 333   auto Range = C;
 334   C.advance();
 335   Token = MIToken(Kind, Range.upto(C));
 336   return C;
 337 }
 338
 339 StringRef llvm::lexMIToken(
 340     StringRef Source, MIToken &Token,
 341     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 342   auto C = skipWhitespace(Cursor(Source));
 343   if (C.isEOF()) {
 344     Token = MIToken(MIToken::Eof, C.remaining());
 345     return C.remaining();
 346   }
 347
 348   if (Cursor R = maybeLexIdentifier(C, Token))
 349     return R.remaining();
 350   if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
 351     return R.remaining();
 352   if (Cursor R = maybeLexJumpTableIndex(C, Token))
 353     return R.remaining();
 354   if (Cursor R = maybeLexStackObject(C, Token))
 355     return R.remaining();
 356   if (Cursor R = maybeLexFixedStackObject(C, Token))
 357     return R.remaining();
 358   if (Cursor R = maybeLexConstantPoolItem(C, Token))
 359     return R.remaining();
 360   if (Cursor R = maybeLexRegister(C, Token))
 361     return R.remaining();
 362   if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
 363     return R.remaining();
 364   if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
 365     return R.remaining();
 366   if (Cursor R = maybeLexIntegerLiteral(C, Token))
 367     return R.remaining();
 368   if (Cursor R = maybeLexSymbol(C, Token))
 369     return R.remaining();
 370
 371   Token = MIToken(MIToken::Error, C.remaining());
 372   ErrorCallback(C.location(),
 373                 Twine("unexpected character '") + Twine(C.peek()) + "'");
 374   return C.remaining();
 375 }