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       .Default(MIToken::Identifier);
 180 }
 181
 182 static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
 183   if (!isalpha(C.peek()) && C.peek() != '_' && C.peek() != '.')
 184     return None;
 185   auto Range = C;
 186   while (isIdentifierChar(C.peek()))
 187     C.advance();
 188   auto Identifier = Range.upto(C);
 189   Token = MIToken(getIdentifierKind(Identifier), Identifier);
 190   return C;
 191 }
 192
 193 static Cursor maybeLexMachineBasicBlock(
 194     Cursor C, MIToken &Token,
 195     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 196   if (!C.remaining().startswith("%bb."))
 197     return None;
 198   auto Range = C;
 199   C.advance(4); // Skip '%bb.'
 200   if (!isdigit(C.peek())) {
 201     Token = MIToken(MIToken::Error, C.remaining());
 202     ErrorCallback(C.location(), "expected a number after '%bb.'");
 203     return C;
 204   }
 205   auto NumberRange = C;
 206   while (isdigit(C.peek()))
 207     C.advance();
 208   StringRef Number = NumberRange.upto(C);
 209   unsigned StringOffset = 4 + Number.size(); // Drop '%bb.<id>'
 210   if (C.peek() == '.') {
 211     C.advance(); // Skip '.'
 212     ++StringOffset;
 213     while (isIdentifierChar(C.peek()))
 214       C.advance();
 215   }
 216   Token = MIToken(MIToken::MachineBasicBlock, Range.upto(C), APSInt(Number),
 217                   StringOffset);
 218   return C;
 219 }
 220
 221 static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
 222                             MIToken::TokenKind Kind) {
 223   if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
 224     return None;
 225   auto Range = C;
 226   C.advance(Rule.size());
 227   auto NumberRange = C;
 228   while (isdigit(C.peek()))
 229     C.advance();
 230   Token = MIToken(Kind, Range.upto(C), APSInt(NumberRange.upto(C)));
 231   return C;
 232 }
 233
 234 static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
 235                                    MIToken::TokenKind Kind) {
 236   if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
 237     return None;
 238   auto Range = C;
 239   C.advance(Rule.size());
 240   auto NumberRange = C;
 241   while (isdigit(C.peek()))
 242     C.advance();
 243   StringRef Number = NumberRange.upto(C);
 244   unsigned StringOffset = Rule.size() + Number.size();
 245   if (C.peek() == '.') {
 246     C.advance();
 247     ++StringOffset;
 248     while (isIdentifierChar(C.peek()))
 249       C.advance();
 250   }
 251   Token = MIToken(Kind, Range.upto(C), APSInt(Number), StringOffset);
 252   return C;
 253 }
 254
 255 static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
 256   return maybeLexIndex(C, Token, "%jump-table.", MIToken::JumpTableIndex);
 257 }
 258
 259 static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
 260   return maybeLexIndexAndName(C, Token, "%stack.", MIToken::StackObject);
 261 }
 262
 263 static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
 264   return maybeLexIndex(C, Token, "%fixed-stack.", MIToken::FixedStackObject);
 265 }
 266
 267 static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
 268   return maybeLexIndex(C, Token, "%const.", MIToken::ConstantPoolItem);
 269 }
 270
 271 static Cursor maybeLexIRBlock(
 272     Cursor C, MIToken &Token,
 273     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 274   const StringRef Rule = "%ir-block.";
 275   if (!C.remaining().startswith(Rule))
 276     return None;
 277   if (isdigit(C.peek(Rule.size())))
 278     return maybeLexIndex(C, Token, Rule, MIToken::IRBlock);
 279   return lexName(C, Token, MIToken::NamedIRBlock, Rule.size(), ErrorCallback);
 280 }
 281
 282 static Cursor maybeLexIRValue(
 283     Cursor C, MIToken &Token,
 284     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 285   const StringRef Rule = "%ir.";
 286   if (!C.remaining().startswith(Rule))
 287     return None;
 288   return lexName(C, Token, MIToken::NamedIRValue, Rule.size(), ErrorCallback);
 289 }
 290
 291 static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
 292   auto Range = C;
 293   C.advance(); // Skip '%'
 294   auto NumberRange = C;
 295   while (isdigit(C.peek()))
 296     C.advance();
 297   Token = MIToken(MIToken::VirtualRegister, Range.upto(C),
 298                   APSInt(NumberRange.upto(C)));
 299   return C;
 300 }
 301
 302 static Cursor maybeLexRegister(Cursor C, MIToken &Token) {
 303   if (C.peek() != '%')
 304     return None;
 305   if (isdigit(C.peek(1)))
 306     return lexVirtualRegister(C, Token);
 307   auto Range = C;
 308   C.advance(); // Skip '%'
 309   while (isIdentifierChar(C.peek()))
 310     C.advance();
 311   Token = MIToken(MIToken::NamedRegister, Range.upto(C),
 312                   /*StringOffset=*/1); // Drop the '%'
 313   return C;
 314 }
 315
 316 static Cursor maybeLexGlobalValue(
 317     Cursor C, MIToken &Token,
 318     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 319   if (C.peek() != '@')
 320     return None;
 321   if (!isdigit(C.peek(1)))
 322     return lexName(C, Token, MIToken::NamedGlobalValue, /*PrefixLength=*/1,
 323                    ErrorCallback);
 324   auto Range = C;
 325   C.advance(1); // Skip the '@'
 326   auto NumberRange = C;
 327   while (isdigit(C.peek()))
 328     C.advance();
 329   Token =
 330       MIToken(MIToken::GlobalValue, Range.upto(C), APSInt(NumberRange.upto(C)));
 331   return C;
 332 }
 333
 334 static Cursor maybeLexExternalSymbol(
 335     Cursor C, MIToken &Token,
 336     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 337   if (C.peek() != '$')
 338     return None;
 339   return lexName(C, Token, MIToken::ExternalSymbol, /*PrefixLength=*/1,
 340                  ErrorCallback);
 341 }
 342
 343 static bool isValidHexFloatingPointPrefix(char C) {
 344   return C == 'H' || C == 'K' || C == 'L' || C == 'M';
 345 }
 346
 347 static Cursor maybeLexHexFloatingPointLiteral(Cursor C, MIToken &Token) {
 348   if (C.peek() != '0' || C.peek(1) != 'x')
 349     return None;
 350   Cursor Range = C;
 351   C.advance(2); // Skip '0x'
 352   if (isValidHexFloatingPointPrefix(C.peek()))
 353     C.advance();
 354   while (isxdigit(C.peek()))
 355     C.advance();
 356   Token = MIToken(MIToken::FloatingPointLiteral, Range.upto(C));
 357   return C;
 358 }
 359
 360 static Cursor lexFloatingPointLiteral(Cursor Range, Cursor C, MIToken &Token) {
 361   C.advance();
 362   // Skip over [0-9]*([eE][-+]?[0-9]+)?
 363   while (isdigit(C.peek()))
 364     C.advance();
 365   if ((C.peek() == 'e' || C.peek() == 'E') &&
 366       (isdigit(C.peek(1)) ||
 367        ((C.peek(1) == '-' || C.peek(1) == '+') && isdigit(C.peek(2))))) {
 368     C.advance(2);
 369     while (isdigit(C.peek()))
 370       C.advance();
 371   }
 372   Token = MIToken(MIToken::FloatingPointLiteral, Range.upto(C));
 373   return C;
 374 }
 375
 376 static Cursor maybeLexNumericalLiteral(Cursor C, MIToken &Token) {
 377   if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(1))))
 378     return None;
 379   auto Range = C;
 380   C.advance();
 381   while (isdigit(C.peek()))
 382     C.advance();
 383   if (C.peek() == '.')
 384     return lexFloatingPointLiteral(Range, C, Token);
 385   StringRef StrVal = Range.upto(C);
 386   Token = MIToken(MIToken::IntegerLiteral, StrVal, APSInt(StrVal));
 387   return C;
 388 }
 389
 390 static MIToken::TokenKind symbolToken(char C) {
 391   switch (C) {
 392   case ',':
 393     return MIToken::comma;
 394   case '=':
 395     return MIToken::equal;
 396   case ':':
 397     return MIToken::colon;
 398   case '!':
 399     return MIToken::exclaim;
 400   case '(':
 401     return MIToken::lparen;
 402   case ')':
 403     return MIToken::rparen;
 404   case '+':
 405     return MIToken::plus;
 406   case '-':
 407     return MIToken::minus;
 408   default:
 409     return MIToken::Error;
 410   }
 411 }
 412
 413 static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
 414   MIToken::TokenKind Kind;
 415   unsigned Length = 1;
 416   if (C.peek() == ':' && C.peek(1) == ':') {
 417     Kind = MIToken::coloncolon;
 418     Length = 2;
 419   } else
 420     Kind = symbolToken(C.peek());
 421   if (Kind == MIToken::Error)
 422     return None;
 423   auto Range = C;
 424   C.advance(Length);
 425   Token = MIToken(Kind, Range.upto(C));
 426   return C;
 427 }
 428
 429 StringRef llvm::lexMIToken(
 430     StringRef Source, MIToken &Token,
 431     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 432   auto C = skipWhitespace(Cursor(Source));
 433   if (C.isEOF()) {
 434     Token = MIToken(MIToken::Eof, C.remaining());
 435     return C.remaining();
 436   }
 437
 438   if (Cursor R = maybeLexIntegerType(C, Token))
 439     return R.remaining();
 440   if (Cursor R = maybeLexIdentifier(C, Token))
 441     return R.remaining();
 442   if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
 443     return R.remaining();
 444   if (Cursor R = maybeLexJumpTableIndex(C, Token))
 445     return R.remaining();
 446   if (Cursor R = maybeLexStackObject(C, Token))
 447     return R.remaining();
 448   if (Cursor R = maybeLexFixedStackObject(C, Token))
 449     return R.remaining();
 450   if (Cursor R = maybeLexConstantPoolItem(C, Token))
 451     return R.remaining();
 452   if (Cursor R = maybeLexIRBlock(C, Token, ErrorCallback))
 453     return R.remaining();
 454   if (Cursor R = maybeLexIRValue(C, Token, ErrorCallback))
 455     return R.remaining();
 456   if (Cursor R = maybeLexRegister(C, Token))
 457     return R.remaining();
 458   if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
 459     return R.remaining();
 460   if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
 461     return R.remaining();
 462   if (Cursor R = maybeLexHexFloatingPointLiteral(C, Token))
 463     return R.remaining();
 464   if (Cursor R = maybeLexNumericalLiteral(C, Token))
 465     return R.remaining();
 466   if (Cursor R = maybeLexSymbol(C, Token))
 467     return R.remaining();
 468
 469   Token = MIToken(MIToken::Error, C.remaining());
 470   ErrorCallback(C.location(),
 471                 Twine("unexpected character '") + Twine(C.peek()) + "'");
 472   return C.remaining();
 473 }