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 Cursor lexName(
 118     Cursor C, MIToken &Token, MIToken::TokenKind Type,
 119     MIToken::TokenKind QuotedType, unsigned PrefixLength,
 120     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 121   auto Range = C;
 122   C.advance(PrefixLength);
 123   if (C.peek() == '"') {
 124     if (Cursor R = lexStringConstant(C, ErrorCallback)) {
 125       Token = MIToken(QuotedType, Range.upto(R), PrefixLength);
 126       return R;
 127     }
 128     Token = MIToken(MIToken::Error, Range.remaining());
 129     return Range;
 130   }
 131   while (isIdentifierChar(C.peek()))
 132     C.advance();
 133   Token = MIToken(Type, Range.upto(C), PrefixLength);
 134   return C;
 135 }
 136
 137 static MIToken::TokenKind getIdentifierKind(StringRef Identifier) {
 138   return StringSwitch<MIToken::TokenKind>(Identifier)
 139       .Case("_", MIToken::underscore)
 140       .Case("implicit", MIToken::kw_implicit)
 141       .Case("implicit-def", MIToken::kw_implicit_define)
 142       .Case("dead", MIToken::kw_dead)
 143       .Case("killed", MIToken::kw_killed)
 144       .Case("undef", MIToken::kw_undef)
 145       .Case("frame-setup", MIToken::kw_frame_setup)
 146       .Case("debug-location", MIToken::kw_debug_location)
 147       .Case(".cfi_offset", MIToken::kw_cfi_offset)
 148       .Case(".cfi_def_cfa_register", MIToken::kw_cfi_def_cfa_register)
 149       .Case(".cfi_def_cfa_offset", MIToken::kw_cfi_def_cfa_offset)
 150       .Case("blockaddress", MIToken::kw_blockaddress)
 151       .Default(MIToken::Identifier);
 152 }
 153
 154 static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
 155   if (!isalpha(C.peek()) && C.peek() != '_' && C.peek() != '.')
 156     return None;
 157   auto Range = C;
 158   while (isIdentifierChar(C.peek()))
 159     C.advance();
 160   auto Identifier = Range.upto(C);
 161   Token = MIToken(getIdentifierKind(Identifier), Identifier);
 162   return C;
 163 }
 164
 165 static Cursor maybeLexMachineBasicBlock(
 166     Cursor C, MIToken &Token,
 167     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 168   if (!C.remaining().startswith("%bb."))
 169     return None;
 170   auto Range = C;
 171   C.advance(4); // Skip '%bb.'
 172   if (!isdigit(C.peek())) {
 173     Token = MIToken(MIToken::Error, C.remaining());
 174     ErrorCallback(C.location(), "expected a number after '%bb.'");
 175     return C;
 176   }
 177   auto NumberRange = C;
 178   while (isdigit(C.peek()))
 179     C.advance();
 180   StringRef Number = NumberRange.upto(C);
 181   unsigned StringOffset = 4 + Number.size(); // Drop '%bb.<id>'
 182   if (C.peek() == '.') {
 183     C.advance(); // Skip '.'
 184     ++StringOffset;
 185     while (isIdentifierChar(C.peek()))
 186       C.advance();
 187   }
 188   Token = MIToken(MIToken::MachineBasicBlock, Range.upto(C), APSInt(Number),
 189                   StringOffset);
 190   return C;
 191 }
 192
 193 static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
 194                             MIToken::TokenKind Kind) {
 195   if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
 196     return None;
 197   auto Range = C;
 198   C.advance(Rule.size());
 199   auto NumberRange = C;
 200   while (isdigit(C.peek()))
 201     C.advance();
 202   Token = MIToken(Kind, Range.upto(C), APSInt(NumberRange.upto(C)));
 203   return C;
 204 }
 205
 206 static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
 207                                    MIToken::TokenKind Kind) {
 208   if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
 209     return None;
 210   auto Range = C;
 211   C.advance(Rule.size());
 212   auto NumberRange = C;
 213   while (isdigit(C.peek()))
 214     C.advance();
 215   StringRef Number = NumberRange.upto(C);
 216   unsigned StringOffset = Rule.size() + Number.size();
 217   if (C.peek() == '.') {
 218     C.advance();
 219     ++StringOffset;
 220     while (isIdentifierChar(C.peek()))
 221       C.advance();
 222   }
 223   Token = MIToken(Kind, Range.upto(C), APSInt(Number), StringOffset);
 224   return C;
 225 }
 226
 227 static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
 228   return maybeLexIndex(C, Token, "%jump-table.", MIToken::JumpTableIndex);
 229 }
 230
 231 static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
 232   return maybeLexIndexAndName(C, Token, "%stack.", MIToken::StackObject);
 233 }
 234
 235 static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
 236   return maybeLexIndex(C, Token, "%fixed-stack.", MIToken::FixedStackObject);
 237 }
 238
 239 static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
 240   return maybeLexIndex(C, Token, "%const.", MIToken::ConstantPoolItem);
 241 }
 242
 243 static Cursor maybeLexIRBlock(
 244     Cursor C, MIToken &Token,
 245     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 246   const StringRef Rule = "%ir-block.";
 247   if (!C.remaining().startswith(Rule))
 248     return None;
 249   if (isdigit(C.peek(Rule.size())))
 250     return maybeLexIndex(C, Token, Rule, MIToken::IRBlock);
 251   return lexName(C, Token, MIToken::NamedIRBlock, MIToken::QuotedNamedIRBlock,
 252                  Rule.size(), ErrorCallback);
 253 }
 254
 255 static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
 256   auto Range = C;
 257   C.advance(); // Skip '%'
 258   auto NumberRange = C;
 259   while (isdigit(C.peek()))
 260     C.advance();
 261   Token = MIToken(MIToken::VirtualRegister, Range.upto(C),
 262                   APSInt(NumberRange.upto(C)));
 263   return C;
 264 }
 265
 266 static Cursor maybeLexRegister(Cursor C, MIToken &Token) {
 267   if (C.peek() != '%')
 268     return None;
 269   if (isdigit(C.peek(1)))
 270     return lexVirtualRegister(C, Token);
 271   auto Range = C;
 272   C.advance(); // Skip '%'
 273   while (isIdentifierChar(C.peek()))
 274     C.advance();
 275   Token = MIToken(MIToken::NamedRegister, Range.upto(C),
 276                   /*StringOffset=*/1); // Drop the '%'
 277   return C;
 278 }
 279
 280 static Cursor maybeLexGlobalValue(
 281     Cursor C, MIToken &Token,
 282     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 283   if (C.peek() != '@')
 284     return None;
 285   if (!isdigit(C.peek(1)))
 286     return lexName(C, Token, MIToken::NamedGlobalValue,
 287                    MIToken::QuotedNamedGlobalValue, /*PrefixLength=*/1,
 288                    ErrorCallback);
 289   auto Range = C;
 290   C.advance(1); // Skip the '@'
 291   auto NumberRange = C;
 292   while (isdigit(C.peek()))
 293     C.advance();
 294   Token =
 295       MIToken(MIToken::GlobalValue, Range.upto(C), APSInt(NumberRange.upto(C)));
 296   return C;
 297 }
 298
 299 static Cursor maybeLexExternalSymbol(
 300     Cursor C, MIToken &Token,
 301     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 302   if (C.peek() != '$')
 303     return None;
 304   return lexName(C, Token, MIToken::ExternalSymbol,
 305                  MIToken::QuotedExternalSymbol,
 306                  /*PrefixLength=*/1, ErrorCallback);
 307 }
 308
 309 static Cursor maybeLexIntegerLiteral(Cursor C, MIToken &Token) {
 310   if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(1))))
 311     return None;
 312   auto Range = C;
 313   C.advance();
 314   while (isdigit(C.peek()))
 315     C.advance();
 316   StringRef StrVal = Range.upto(C);
 317   Token = MIToken(MIToken::IntegerLiteral, StrVal, APSInt(StrVal));
 318   return C;
 319 }
 320
 321 static MIToken::TokenKind symbolToken(char C) {
 322   switch (C) {
 323   case ',':
 324     return MIToken::comma;
 325   case '=':
 326     return MIToken::equal;
 327   case ':':
 328     return MIToken::colon;
 329   case '!':
 330     return MIToken::exclaim;
 331   case '(':
 332     return MIToken::lparen;
 333   case ')':
 334     return MIToken::rparen;
 335   default:
 336     return MIToken::Error;
 337   }
 338 }
 339
 340 static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
 341   auto Kind = symbolToken(C.peek());
 342   if (Kind == MIToken::Error)
 343     return None;
 344   auto Range = C;
 345   C.advance();
 346   Token = MIToken(Kind, Range.upto(C));
 347   return C;
 348 }
 349
 350 StringRef llvm::lexMIToken(
 351     StringRef Source, MIToken &Token,
 352     function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
 353   auto C = skipWhitespace(Cursor(Source));
 354   if (C.isEOF()) {
 355     Token = MIToken(MIToken::Eof, C.remaining());
 356     return C.remaining();
 357   }
 358
 359   if (Cursor R = maybeLexIdentifier(C, Token))
 360     return R.remaining();
 361   if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
 362     return R.remaining();
 363   if (Cursor R = maybeLexJumpTableIndex(C, Token))
 364     return R.remaining();
 365   if (Cursor R = maybeLexStackObject(C, Token))
 366     return R.remaining();
 367   if (Cursor R = maybeLexFixedStackObject(C, Token))
 368     return R.remaining();
 369   if (Cursor R = maybeLexConstantPoolItem(C, Token))
 370     return R.remaining();
 371   if (Cursor R = maybeLexIRBlock(C, Token, ErrorCallback))
 372     return R.remaining();
 373   if (Cursor R = maybeLexRegister(C, Token))
 374     return R.remaining();
 375   if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
 376     return R.remaining();
 377   if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
 378     return R.remaining();
 379   if (Cursor R = maybeLexIntegerLiteral(C, Token))
 380     return R.remaining();
 381   if (Cursor R = maybeLexSymbol(C, Token))
 382     return R.remaining();
 383
 384   Token = MIToken(MIToken::Error, C.remaining());
 385   ErrorCallback(C.location(),
 386                 Twine("unexpected character '") + Twine(C.peek()) + "'");
 387   return C.remaining();
 388 }