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 /// Unescapes the given string value.
  73 ///
  74 /// Expects the string value to be quoted.
  75 static std::string unescapeQuotedString(StringRef Value) {
  76   assert(Value.front() == '"' && Value.back() == '"');
  77   Cursor C = Cursor(Value.substr(1, Value.size() - 2));
  78
  79   std::string Str;
  80   Str.reserve(C.remaining().size());
  81   while (!C.isEOF()) {
  82     char Char = C.peek();
  83     if (Char == '\\') {
  84       if (C.peek(1) == '\\') {
  85         // Two '\' become one
  86         Str += '\\';
  87         C.advance(2);
  88         continue;
  89       }
  90       if (isxdigit(C.peek(1)) && isxdigit(C.peek(2))) {
  91         Str += hexDigitValue(C.peek(1)) * 16 + hexDigitValue(C.peek(2));
  92         C.advance(3);
  93         continue;
  94       }
  95     }
  96     Str += Char;
  97     C.advance();
  98   }
  99   return Str;
 100 }
 101
 102 /// Lex a string constant using the following regular expression: \"[^\"]*\"
 103 static Cursor lexStringConstant(
 104     Cursor C,
 105     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 106   assert(C.peek() == '"');
 107   for (C.advance(); C.peek() != '"'; C.advance()) {
 108     if (C.isEOF()) {
 109       ErrorCallback(
 110           C.location(),
 111           "end of machine instruction reached before the closing '\"'");
 112       return None;
 113     }
 114   }
 115   C.advance();
 116   return C;
 117 }
 118
 119 static Cursor lexName(
 120     Cursor C, MIToken &Token, MIToken::TokenKind Type, unsigned PrefixLength,
 121     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 122   auto Range = C;
 123   C.advance(PrefixLength);
 124   if (C.peek() == '"') {
 125     if (Cursor R = lexStringConstant(C, ErrorCallback)) {
 126       StringRef String = Range.upto(R);
 127       Token = MIToken(Type, String,
 128                       unescapeQuotedString(String.drop_front(PrefixLength)),
 129                       PrefixLength);
 130       return R;
 131     }
 132     Token = MIToken(MIToken::Error, Range.remaining());
 133     return Range;
 134   }
 135   while (isIdentifierChar(C.peek()))
 136     C.advance();
 137   Token = MIToken(Type, Range.upto(C), PrefixLength);
 138   return C;
 139 }
 140
 141 static Cursor maybeLexIntegerType(Cursor C, MIToken &Token) {
 142   if (C.peek() != 'i' || !isdigit(C.peek(1)))
 143     return None;
 144   auto Range = C;
 145   C.advance(); // Skip 'i'
 146   while (isdigit(C.peek()))
 147     C.advance();
 148   Token = MIToken(MIToken::IntegerType, Range.upto(C));
 149   return C;
 150 }
 151
 152 static MIToken::TokenKind getIdentifierKind(StringRef Identifier) {
 153   return StringSwitch<MIToken::TokenKind>(Identifier)
 154       .Case("_", MIToken::underscore)
 155       .Case("implicit", MIToken::kw_implicit)
 156       .Case("implicit-def", MIToken::kw_implicit_define)
 157       .Case("dead", MIToken::kw_dead)
 158       .Case("killed", MIToken::kw_killed)
 159       .Case("undef", MIToken::kw_undef)
 160       .Case("early-clobber", MIToken::kw_early_clobber)
 161       .Case("debug-use", MIToken::kw_debug_use)
 162       .Case("frame-setup", MIToken::kw_frame_setup)
 163       .Case("debug-location", MIToken::kw_debug_location)
 164       .Case(".cfi_offset", MIToken::kw_cfi_offset)
 165       .Case(".cfi_def_cfa_register", MIToken::kw_cfi_def_cfa_register)
 166       .Case(".cfi_def_cfa_offset", MIToken::kw_cfi_def_cfa_offset)
 167       .Case(".cfi_def_cfa", MIToken::kw_cfi_def_cfa)
 168       .Case("blockaddress", MIToken::kw_blockaddress)
 169       .Case("target-index", MIToken::kw_target_index)
 170       .Case("half", MIToken::kw_half)
 171       .Case("float", MIToken::kw_float)
 172       .Case("double", MIToken::kw_double)
 173       .Case("x86_fp80", MIToken::kw_x86_fp80)
 174       .Case("fp128", MIToken::kw_fp128)
 175       .Case("ppc_fp128", MIToken::kw_ppc_fp128)
 176       .Case("target-flags", MIToken::kw_target_flags)
 177       .Case("volatile", MIToken::kw_volatile)
 178       .Case("non-temporal", MIToken::kw_non_temporal)
 179       .Case("invariant", MIToken::kw_invariant)
 180       .Default(MIToken::Identifier);
 181 }
 182
 183 static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
 184   if (!isalpha(C.peek()) && C.peek() != '_' && C.peek() != '.')
 185     return None;
 186   auto Range = C;
 187   while (isIdentifierChar(C.peek()))
 188     C.advance();
 189   auto Identifier = Range.upto(C);
 190   Token = MIToken(getIdentifierKind(Identifier), Identifier);
 191   return C;
 192 }
 193
 194 static Cursor maybeLexMachineBasicBlock(
 195     Cursor C, MIToken &Token,
 196     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 197   if (!C.remaining().startswith("%bb."))
 198     return None;
 199   auto Range = C;
 200   C.advance(4); // Skip '%bb.'
 201   if (!isdigit(C.peek())) {
 202     Token = MIToken(MIToken::Error, C.remaining());
 203     ErrorCallback(C.location(), "expected a number after '%bb.'");
 204     return C;
 205   }
 206   auto NumberRange = C;
 207   while (isdigit(C.peek()))
 208     C.advance();
 209   StringRef Number = NumberRange.upto(C);
 210   unsigned StringOffset = 4 + Number.size(); // Drop '%bb.<id>'
 211   if (C.peek() == '.') {
 212     C.advance(); // Skip '.'
 213     ++StringOffset;
 214     while (isIdentifierChar(C.peek()))
 215       C.advance();
 216   }
 217   Token = MIToken(MIToken::MachineBasicBlock, Range.upto(C), APSInt(Number),
 218                   StringOffset);
 219   return C;
 220 }
 221
 222 static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
 223                             MIToken::TokenKind Kind) {
 224   if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
 225     return None;
 226   auto Range = C;
 227   C.advance(Rule.size());
 228   auto NumberRange = C;
 229   while (isdigit(C.peek()))
 230     C.advance();
 231   Token = MIToken(Kind, Range.upto(C), APSInt(NumberRange.upto(C)));
 232   return C;
 233 }
 234
 235 static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
 236                                    MIToken::TokenKind Kind) {
 237   if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
 238     return None;
 239   auto Range = C;
 240   C.advance(Rule.size());
 241   auto NumberRange = C;
 242   while (isdigit(C.peek()))
 243     C.advance();
 244   StringRef Number = NumberRange.upto(C);
 245   unsigned StringOffset = Rule.size() + Number.size();
 246   if (C.peek() == '.') {
 247     C.advance();
 248     ++StringOffset;
 249     while (isIdentifierChar(C.peek()))
 250       C.advance();
 251   }
 252   Token = MIToken(Kind, Range.upto(C), APSInt(Number), StringOffset);
 253   return C;
 254 }
 255
 256 static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
 257   return maybeLexIndex(C, Token, "%jump-table.", MIToken::JumpTableIndex);
 258 }
 259
 260 static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
 261   return maybeLexIndexAndName(C, Token, "%stack.", MIToken::StackObject);
 262 }
 263
 264 static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
 265   return maybeLexIndex(C, Token, "%fixed-stack.", MIToken::FixedStackObject);
 266 }
 267
 268 static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
 269   return maybeLexIndex(C, Token, "%const.", MIToken::ConstantPoolItem);
 270 }
 271
 272 static Cursor maybeLexIRBlock(
 273     Cursor C, MIToken &Token,
 274     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 275   const StringRef Rule = "%ir-block.";
 276   if (!C.remaining().startswith(Rule))
 277     return None;
 278   if (isdigit(C.peek(Rule.size())))
 279     return maybeLexIndex(C, Token, Rule, MIToken::IRBlock);
 280   return lexName(C, Token, MIToken::NamedIRBlock, Rule.size(), ErrorCallback);
 281 }
 282
 283 static Cursor maybeLexIRValue(
 284     Cursor C, MIToken &Token,
 285     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 286   const StringRef Rule = "%ir.";
 287   if (!C.remaining().startswith(Rule))
 288     return None;
 289   return lexName(C, Token, MIToken::NamedIRValue, Rule.size(), ErrorCallback);
 290 }
 291
 292 static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
 293   auto Range = C;
 294   C.advance(); // Skip '%'
 295   auto NumberRange = C;
 296   while (isdigit(C.peek()))
 297     C.advance();
 298   Token = MIToken(MIToken::VirtualRegister, Range.upto(C),
 299                   APSInt(NumberRange.upto(C)));
 300   return C;
 301 }
 302
 303 static Cursor maybeLexRegister(Cursor C, MIToken &Token) {
 304   if (C.peek() != '%')
 305     return None;
 306   if (isdigit(C.peek(1)))
 307     return lexVirtualRegister(C, Token);
 308   auto Range = C;
 309   C.advance(); // Skip '%'
 310   while (isIdentifierChar(C.peek()))
 311     C.advance();
 312   Token = MIToken(MIToken::NamedRegister, Range.upto(C),
 313                   /*StringOffset=*/1); // Drop the '%'
 314   return C;
 315 }
 316
 317 static Cursor maybeLexGlobalValue(
 318     Cursor C, MIToken &Token,
 319     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 320   if (C.peek() != '@')
 321     return None;
 322   if (!isdigit(C.peek(1)))
 323     return lexName(C, Token, MIToken::NamedGlobalValue, /*PrefixLength=*/1,
 324                    ErrorCallback);
 325   auto Range = C;
 326   C.advance(1); // Skip the '@'
 327   auto NumberRange = C;
 328   while (isdigit(C.peek()))
 329     C.advance();
 330   Token =
 331       MIToken(MIToken::GlobalValue, Range.upto(C), APSInt(NumberRange.upto(C)));
 332   return C;
 333 }
 334
 335 static Cursor maybeLexExternalSymbol(
 336     Cursor C, MIToken &Token,
 337     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 338   if (C.peek() != '$')
 339     return None;
 340   return lexName(C, Token, MIToken::ExternalSymbol, /*PrefixLength=*/1,
 341                  ErrorCallback);
 342 }
 343
 344 static bool isValidHexFloatingPointPrefix(char C) {
 345   return C == 'H' || C == 'K' || C == 'L' || C == 'M';
 346 }
 347
 348 static Cursor maybeLexHexFloatingPointLiteral(Cursor C, MIToken &Token) {
 349   if (C.peek() != '0' || C.peek(1) != 'x')
 350     return None;
 351   Cursor Range = C;
 352   C.advance(2); // Skip '0x'
 353   if (isValidHexFloatingPointPrefix(C.peek()))
 354     C.advance();
 355   while (isxdigit(C.peek()))
 356     C.advance();
 357   Token = MIToken(MIToken::FloatingPointLiteral, Range.upto(C));
 358   return C;
 359 }
 360
 361 static Cursor lexFloatingPointLiteral(Cursor Range, Cursor C, MIToken &Token) {
 362   C.advance();
 363   // Skip over [0-9]*([eE][-+]?[0-9]+)?
 364   while (isdigit(C.peek()))
 365     C.advance();
 366   if ((C.peek() == 'e' || C.peek() == 'E') &&
 367       (isdigit(C.peek(1)) ||
 368        ((C.peek(1) == '-' || C.peek(1) == '+') && isdigit(C.peek(2))))) {
 369     C.advance(2);
 370     while (isdigit(C.peek()))
 371       C.advance();
 372   }
 373   Token = MIToken(MIToken::FloatingPointLiteral, Range.upto(C));
 374   return C;
 375 }
 376
 377 static Cursor maybeLexNumericalLiteral(Cursor C, MIToken &Token) {
 378   if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(1))))
 379     return None;
 380   auto Range = C;
 381   C.advance();
 382   while (isdigit(C.peek()))
 383     C.advance();
 384   if (C.peek() == '.')
 385     return lexFloatingPointLiteral(Range, C, Token);
 386   StringRef StrVal = Range.upto(C);
 387   Token = MIToken(MIToken::IntegerLiteral, StrVal, APSInt(StrVal));
 388   return C;
 389 }
 390
 391 static MIToken::TokenKind symbolToken(char C) {
 392   switch (C) {
 393   case ',':
 394     return MIToken::comma;
 395   case '=':
 396     return MIToken::equal;
 397   case ':':
 398     return MIToken::colon;
 399   case '!':
 400     return MIToken::exclaim;
 401   case '(':
 402     return MIToken::lparen;
 403   case ')':
 404     return MIToken::rparen;
 405   case '+':
 406     return MIToken::plus;
 407   case '-':
 408     return MIToken::minus;
 409   default:
 410     return MIToken::Error;
 411   }
 412 }
 413
 414 static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
 415   MIToken::TokenKind Kind;
 416   unsigned Length = 1;
 417   if (C.peek() == ':' && C.peek(1) == ':') {
 418     Kind = MIToken::coloncolon;
 419     Length = 2;
 420   } else
 421     Kind = symbolToken(C.peek());
 422   if (Kind == MIToken::Error)
 423     return None;
 424   auto Range = C;
 425   C.advance(Length);
 426   Token = MIToken(Kind, Range.upto(C));
 427   return C;
 428 }
 429
 430 StringRef llvm::lexMIToken(
 431     StringRef Source, MIToken &Token,
 432     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 433   auto C = skipWhitespace(Cursor(Source));
 434   if (C.isEOF()) {
 435     Token = MIToken(MIToken::Eof, C.remaining());
 436     return C.remaining();
 437   }
 438
 439   if (Cursor R = maybeLexIntegerType(C, Token))
 440     return R.remaining();
 441   if (Cursor R = maybeLexIdentifier(C, Token))
 442     return R.remaining();
 443   if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
 444     return R.remaining();
 445   if (Cursor R = maybeLexJumpTableIndex(C, Token))
 446     return R.remaining();
 447   if (Cursor R = maybeLexStackObject(C, Token))
 448     return R.remaining();
 449   if (Cursor R = maybeLexFixedStackObject(C, Token))
 450     return R.remaining();
 451   if (Cursor R = maybeLexConstantPoolItem(C, Token))
 452     return R.remaining();
 453   if (Cursor R = maybeLexIRBlock(C, Token, ErrorCallback))
 454     return R.remaining();
 455   if (Cursor R = maybeLexIRValue(C, Token, ErrorCallback))
 456     return R.remaining();
 457   if (Cursor R = maybeLexRegister(C, Token))
 458     return R.remaining();
 459   if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
 460     return R.remaining();
 461   if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
 462     return R.remaining();
 463   if (Cursor R = maybeLexHexFloatingPointLiteral(C, Token))
 464     return R.remaining();
 465   if (Cursor R = maybeLexNumericalLiteral(C, Token))
 466     return R.remaining();
 467   if (Cursor R = maybeLexSymbol(C, Token))
 468     return R.remaining();
 469
 470   Token = MIToken(MIToken::Error, C.remaining());
 471   ErrorCallback(C.location(),
 472                 Twine("unexpected character '") + Twine(C.peek()) + "'");
 473   return C.remaining();
 474 }