lib/CodeGen/MIRParser/MIParser.cpp

   1 //===- MIParser.cpp - Machine instructions parser 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 parsing of machine instructions.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "MIParser.h"
  15 #include "MILexer.h"
  16 #include "llvm/ADT/StringMap.h"
  17 #include "llvm/AsmParser/SlotMapping.h"
  18 #include "llvm/CodeGen/MachineBasicBlock.h"
  19 #include "llvm/CodeGen/MachineFunction.h"
  20 #include "llvm/CodeGen/MachineFrameInfo.h"
  21 #include "llvm/CodeGen/MachineInstr.h"
  22 #include "llvm/CodeGen/MachineInstrBuilder.h"
  23 #include "llvm/CodeGen/MachineModuleInfo.h"
  24 #include "llvm/IR/Instructions.h"
  25 #include "llvm/IR/Module.h"
  26 #include "llvm/Support/raw_ostream.h"
  27 #include "llvm/Support/SourceMgr.h"
  28 #include "llvm/Target/TargetSubtargetInfo.h"
  29 #include "llvm/Target/TargetInstrInfo.h"
  30
  31 using namespace llvm;
  32
  33 namespace {
  34
  35 struct StringValueUtility {
  36   StringRef String;
  37   std::string UnescapedString;
  38
  39   StringValueUtility(const MIToken &Token) {
  40     if (Token.isStringValueQuoted()) {
  41       Token.unescapeQuotedStringValue(UnescapedString);
  42       String = UnescapedString;
  43       return;
  44     }
  45     String = Token.stringValue();
  46   }
  47
  48   operator StringRef() const { return String; }
  49 };
  50
  51 /// A wrapper struct around the 'MachineOperand' struct that includes a source
  52 /// range.
  53 struct MachineOperandWithLocation {
  54   MachineOperand Operand;
  55   StringRef::iterator Begin;
  56   StringRef::iterator End;
  57
  58   MachineOperandWithLocation(const MachineOperand &Operand,
  59                              StringRef::iterator Begin, StringRef::iterator End)
  60       : Operand(Operand), Begin(Begin), End(End) {}
  61 };
  62
  63 class MIParser {
  64   SourceMgr &SM;
  65   MachineFunction &MF;
  66   SMDiagnostic &Error;
  67   StringRef Source, CurrentSource;
  68   MIToken Token;
  69   const PerFunctionMIParsingState &PFS;
  70   /// Maps from indices to unnamed global values and metadata nodes.
  71   const SlotMapping &IRSlots;
  72   /// Maps from instruction names to op codes.
  73   StringMap<unsigned> Names2InstrOpCodes;
  74   /// Maps from register names to registers.
  75   StringMap<unsigned> Names2Regs;
  76   /// Maps from register mask names to register masks.
  77   StringMap<const uint32_t *> Names2RegMasks;
  78   /// Maps from subregister names to subregister indices.
  79   StringMap<unsigned> Names2SubRegIndices;
  80
  81 public:
  82   MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
  83            StringRef Source, const PerFunctionMIParsingState &PFS,
  84            const SlotMapping &IRSlots);
  85
  86   void lex();
  87
  88   /// Report an error at the current location with the given message.
  89   ///
  90   /// This function always return true.
  91   bool error(const Twine &Msg);
  92
  93   /// Report an error at the given location with the given message.
  94   ///
  95   /// This function always return true.
  96   bool error(StringRef::iterator Loc, const Twine &Msg);
  97
  98   bool parse(MachineInstr *&MI);
  99   bool parseMBB(MachineBasicBlock *&MBB);
 100   bool parseNamedRegister(unsigned &Reg);
 101   bool parseStandaloneVirtualRegister(unsigned &Reg);
 102
 103   bool parseRegister(unsigned &Reg);
 104   bool parseRegisterFlag(unsigned &Flags);
 105   bool parseSubRegisterIndex(unsigned &SubReg);
 106   bool parseRegisterOperand(MachineOperand &Dest, bool IsDef = false);
 107   bool parseImmediateOperand(MachineOperand &Dest);
 108   bool parseMBBReference(MachineBasicBlock *&MBB);
 109   bool parseMBBOperand(MachineOperand &Dest);
 110   bool parseStackObjectOperand(MachineOperand &Dest);
 111   bool parseFixedStackObjectOperand(MachineOperand &Dest);
 112   bool parseGlobalAddressOperand(MachineOperand &Dest);
 113   bool parseConstantPoolIndexOperand(MachineOperand &Dest);
 114   bool parseJumpTableIndexOperand(MachineOperand &Dest);
 115   bool parseExternalSymbolOperand(MachineOperand &Dest);
 116   bool parseMDNode(MDNode *&Node);
 117   bool parseMetadataOperand(MachineOperand &Dest);
 118   bool parseCFIOffset(int &Offset);
 119   bool parseCFIRegister(unsigned &Reg);
 120   bool parseCFIOperand(MachineOperand &Dest);
 121   bool parseMachineOperand(MachineOperand &Dest);
 122
 123 private:
 124   /// Convert the integer literal in the current token into an unsigned integer.
 125   ///
 126   /// Return true if an error occurred.
 127   bool getUnsigned(unsigned &Result);
 128
 129   /// If the current token is of the given kind, consume it and return false.
 130   /// Otherwise report an error and return true.
 131   bool expectAndConsume(MIToken::TokenKind TokenKind);
 132
 133   void initNames2InstrOpCodes();
 134
 135   /// Try to convert an instruction name to an opcode. Return true if the
 136   /// instruction name is invalid.
 137   bool parseInstrName(StringRef InstrName, unsigned &OpCode);
 138
 139   bool parseInstruction(unsigned &OpCode, unsigned &Flags);
 140
 141   bool verifyImplicitOperands(ArrayRef<MachineOperandWithLocation> Operands,
 142                               const MCInstrDesc &MCID);
 143
 144   void initNames2Regs();
 145
 146   /// Try to convert a register name to a register number. Return true if the
 147   /// register name is invalid.
 148   bool getRegisterByName(StringRef RegName, unsigned &Reg);
 149
 150   void initNames2RegMasks();
 151
 152   /// Check if the given identifier is a name of a register mask.
 153   ///
 154   /// Return null if the identifier isn't a register mask.
 155   const uint32_t *getRegMask(StringRef Identifier);
 156
 157   void initNames2SubRegIndices();
 158
 159   /// Check if the given identifier is a name of a subregister index.
 160   ///
 161   /// Return 0 if the name isn't a subregister index class.
 162   unsigned getSubRegIndex(StringRef Name);
 163 };
 164
 165 } // end anonymous namespace
 166
 167 MIParser::MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
 168                    StringRef Source, const PerFunctionMIParsingState &PFS,
 169                    const SlotMapping &IRSlots)
 170     : SM(SM), MF(MF), Error(Error), Source(Source), CurrentSource(Source),
 171       Token(MIToken::Error, StringRef()), PFS(PFS), IRSlots(IRSlots) {}
 172
 173 void MIParser::lex() {
 174   CurrentSource = lexMIToken(
 175       CurrentSource, Token,
 176       [this](StringRef::iterator Loc, const Twine &Msg) { error(Loc, Msg); });
 177 }
 178
 179 bool MIParser::error(const Twine &Msg) { return error(Token.location(), Msg); }
 180
 181 bool MIParser::error(StringRef::iterator Loc, const Twine &Msg) {
 182   assert(Loc >= Source.data() && Loc <= (Source.data() + Source.size()));
 183   Error = SMDiagnostic(
 184       SM, SMLoc(),
 185       SM.getMemoryBuffer(SM.getMainFileID())->getBufferIdentifier(), 1,
 186       Loc - Source.data(), SourceMgr::DK_Error, Msg.str(), Source, None, None);
 187   return true;
 188 }
 189
 190 static const char *toString(MIToken::TokenKind TokenKind) {
 191   switch (TokenKind) {
 192   case MIToken::comma:
 193     return "','";
 194   default:
 195     return "<unknown token>";
 196   }
 197 }
 198
 199 bool MIParser::expectAndConsume(MIToken::TokenKind TokenKind) {
 200   if (Token.isNot(TokenKind))
 201     return error(Twine("expected ") + toString(TokenKind));
 202   lex();
 203   return false;
 204 }
 205
 206 bool MIParser::parse(MachineInstr *&MI) {
 207   lex();
 208
 209   // Parse any register operands before '='
 210   // TODO: Allow parsing of multiple operands before '='
 211   MachineOperand MO = MachineOperand::CreateImm(0);
 212   SmallVector<MachineOperandWithLocation, 8> Operands;
 213   if (Token.isRegister() || Token.isRegisterFlag()) {
 214     auto Loc = Token.location();
 215     if (parseRegisterOperand(MO, /*IsDef=*/true))
 216       return true;
 217     Operands.push_back(MachineOperandWithLocation(MO, Loc, Token.location()));
 218     if (Token.isNot(MIToken::equal))
 219       return error("expected '='");
 220     lex();
 221   }
 222
 223   unsigned OpCode, Flags = 0;
 224   if (Token.isError() || parseInstruction(OpCode, Flags))
 225     return true;
 226
 227   // TODO: Parse the bundle instruction flags and memory operands.
 228
 229   // Parse the remaining machine operands.
 230   while (Token.isNot(MIToken::Eof) && Token.isNot(MIToken::kw_debug_location)) {
 231     auto Loc = Token.location();
 232     if (parseMachineOperand(MO))
 233       return true;
 234     Operands.push_back(MachineOperandWithLocation(MO, Loc, Token.location()));
 235     if (Token.is(MIToken::Eof))
 236       break;
 237     if (Token.isNot(MIToken::comma))
 238       return error("expected ',' before the next machine operand");
 239     lex();
 240   }
 241
 242   DebugLoc DebugLocation;
 243   if (Token.is(MIToken::kw_debug_location)) {
 244     lex();
 245     if (Token.isNot(MIToken::exclaim))
 246       return error("expected a metadata node after 'debug-location'");
 247     MDNode *Node = nullptr;
 248     if (parseMDNode(Node))
 249       return true;
 250     DebugLocation = DebugLoc(Node);
 251   }
 252
 253   const auto &MCID = MF.getSubtarget().getInstrInfo()->get(OpCode);
 254   if (!MCID.isVariadic()) {
 255     // FIXME: Move the implicit operand verification to the machine verifier.
 256     if (verifyImplicitOperands(Operands, MCID))
 257       return true;
 258   }
 259
 260   // TODO: Check for extraneous machine operands.
 261   MI = MF.CreateMachineInstr(MCID, DebugLocation, /*NoImplicit=*/true);
 262   MI->setFlags(Flags);
 263   for (const auto &Operand : Operands)
 264     MI->addOperand(MF, Operand.Operand);
 265   return false;
 266 }
 267
 268 bool MIParser::parseMBB(MachineBasicBlock *&MBB) {
 269   lex();
 270   if (Token.isNot(MIToken::MachineBasicBlock))
 271     return error("expected a machine basic block reference");
 272   if (parseMBBReference(MBB))
 273     return true;
 274   lex();
 275   if (Token.isNot(MIToken::Eof))
 276     return error(
 277         "expected end of string after the machine basic block reference");
 278   return false;
 279 }
 280
 281 bool MIParser::parseNamedRegister(unsigned &Reg) {
 282   lex();
 283   if (Token.isNot(MIToken::NamedRegister))
 284     return error("expected a named register");
 285   if (parseRegister(Reg))
 286     return 0;
 287   lex();
 288   if (Token.isNot(MIToken::Eof))
 289     return error("expected end of string after the register reference");
 290   return false;
 291 }
 292
 293 bool MIParser::parseStandaloneVirtualRegister(unsigned &Reg) {
 294   lex();
 295   if (Token.isNot(MIToken::VirtualRegister))
 296     return error("expected a virtual register");
 297   if (parseRegister(Reg))
 298     return 0;
 299   lex();
 300   if (Token.isNot(MIToken::Eof))
 301     return error("expected end of string after the register reference");
 302   return false;
 303 }
 304
 305 static const char *printImplicitRegisterFlag(const MachineOperand &MO) {
 306   assert(MO.isImplicit());
 307   return MO.isDef() ? "implicit-def" : "implicit";
 308 }
 309
 310 static std::string getRegisterName(const TargetRegisterInfo *TRI,
 311                                    unsigned Reg) {
 312   assert(TargetRegisterInfo::isPhysicalRegister(Reg) && "expected phys reg");
 313   return StringRef(TRI->getName(Reg)).lower();
 314 }
 315
 316 bool MIParser::verifyImplicitOperands(
 317     ArrayRef<MachineOperandWithLocation> Operands, const MCInstrDesc &MCID) {
 318   if (MCID.isCall())
 319     // We can't verify call instructions as they can contain arbitrary implicit
 320     // register and register mask operands.
 321     return false;
 322
 323   // Gather all the expected implicit operands.
 324   SmallVector<MachineOperand, 4> ImplicitOperands;
 325   if (MCID.ImplicitDefs)
 326     for (const uint16_t *ImpDefs = MCID.getImplicitDefs(); *ImpDefs; ++ImpDefs)
 327       ImplicitOperands.push_back(
 328           MachineOperand::CreateReg(*ImpDefs, true, true));
 329   if (MCID.ImplicitUses)
 330     for (const uint16_t *ImpUses = MCID.getImplicitUses(); *ImpUses; ++ImpUses)
 331       ImplicitOperands.push_back(
 332           MachineOperand::CreateReg(*ImpUses, false, true));
 333
 334   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 335   assert(TRI && "Expected target register info");
 336   size_t I = ImplicitOperands.size(), J = Operands.size();
 337   while (I) {
 338     --I;
 339     if (J) {
 340       --J;
 341       const auto &ImplicitOperand = ImplicitOperands[I];
 342       const auto &Operand = Operands[J].Operand;
 343       if (ImplicitOperand.isIdenticalTo(Operand))
 344         continue;
 345       if (Operand.isReg() && Operand.isImplicit()) {
 346         return error(Operands[J].Begin,
 347                      Twine("expected an implicit register operand '") +
 348                          printImplicitRegisterFlag(ImplicitOperand) + " %" +
 349                          getRegisterName(TRI, ImplicitOperand.getReg()) + "'");
 350       }
 351     }
 352     // TODO: Fix source location when Operands[J].end is right before '=', i.e:
 353     // insead of reporting an error at this location:
 354     //            %eax = MOV32r0
 355     //                 ^
 356     // report the error at the following location:
 357     //            %eax = MOV32r0
 358     //                          ^
 359     return error(J < Operands.size() ? Operands[J].End : Token.location(),
 360                  Twine("missing implicit register operand '") +
 361                      printImplicitRegisterFlag(ImplicitOperands[I]) + " %" +
 362                      getRegisterName(TRI, ImplicitOperands[I].getReg()) + "'");
 363   }
 364   return false;
 365 }
 366
 367 bool MIParser::parseInstruction(unsigned &OpCode, unsigned &Flags) {
 368   if (Token.is(MIToken::kw_frame_setup)) {
 369     Flags |= MachineInstr::FrameSetup;
 370     lex();
 371   }
 372   if (Token.isNot(MIToken::Identifier))
 373     return error("expected a machine instruction");
 374   StringRef InstrName = Token.stringValue();
 375   if (parseInstrName(InstrName, OpCode))
 376     return error(Twine("unknown machine instruction name '") + InstrName + "'");
 377   lex();
 378   return false;
 379 }
 380
 381 bool MIParser::parseRegister(unsigned &Reg) {
 382   switch (Token.kind()) {
 383   case MIToken::underscore:
 384     Reg = 0;
 385     break;
 386   case MIToken::NamedRegister: {
 387     StringRef Name = Token.stringValue();
 388     if (getRegisterByName(Name, Reg))
 389       return error(Twine("unknown register name '") + Name + "'");
 390     break;
 391   }
 392   case MIToken::VirtualRegister: {
 393     unsigned ID;
 394     if (getUnsigned(ID))
 395       return true;
 396     const auto RegInfo = PFS.VirtualRegisterSlots.find(ID);
 397     if (RegInfo == PFS.VirtualRegisterSlots.end())
 398       return error(Twine("use of undefined virtual register '%") + Twine(ID) +
 399                    "'");
 400     Reg = RegInfo->second;
 401     break;
 402   }
 403   // TODO: Parse other register kinds.
 404   default:
 405     llvm_unreachable("The current token should be a register");
 406   }
 407   return false;
 408 }
 409
 410 bool MIParser::parseRegisterFlag(unsigned &Flags) {
 411   switch (Token.kind()) {
 412   case MIToken::kw_implicit:
 413     Flags |= RegState::Implicit;
 414     break;
 415   case MIToken::kw_implicit_define:
 416     Flags |= RegState::ImplicitDefine;
 417     break;
 418   case MIToken::kw_dead:
 419     Flags |= RegState::Dead;
 420     break;
 421   case MIToken::kw_killed:
 422     Flags |= RegState::Kill;
 423     break;
 424   case MIToken::kw_undef:
 425     Flags |= RegState::Undef;
 426     break;
 427   // TODO: report an error when we specify the same flag more than once.
 428   // TODO: parse the other register flags.
 429   default:
 430     llvm_unreachable("The current token should be a register flag");
 431   }
 432   lex();
 433   return false;
 434 }
 435
 436 bool MIParser::parseSubRegisterIndex(unsigned &SubReg) {
 437   assert(Token.is(MIToken::colon));
 438   lex();
 439   if (Token.isNot(MIToken::Identifier))
 440     return error("expected a subregister index after ':'");
 441   auto Name = Token.stringValue();
 442   SubReg = getSubRegIndex(Name);
 443   if (!SubReg)
 444     return error(Twine("use of unknown subregister index '") + Name + "'");
 445   lex();
 446   return false;
 447 }
 448
 449 bool MIParser::parseRegisterOperand(MachineOperand &Dest, bool IsDef) {
 450   unsigned Reg;
 451   unsigned Flags = IsDef ? RegState::Define : 0;
 452   while (Token.isRegisterFlag()) {
 453     if (parseRegisterFlag(Flags))
 454       return true;
 455   }
 456   if (!Token.isRegister())
 457     return error("expected a register after register flags");
 458   if (parseRegister(Reg))
 459     return true;
 460   lex();
 461   unsigned SubReg = 0;
 462   if (Token.is(MIToken::colon)) {
 463     if (parseSubRegisterIndex(SubReg))
 464       return true;
 465   }
 466   Dest = MachineOperand::CreateReg(
 467       Reg, Flags & RegState::Define, Flags & RegState::Implicit,
 468       Flags & RegState::Kill, Flags & RegState::Dead, Flags & RegState::Undef,
 469       /*isEarlyClobber=*/false, SubReg);
 470   return false;
 471 }
 472
 473 bool MIParser::parseImmediateOperand(MachineOperand &Dest) {
 474   assert(Token.is(MIToken::IntegerLiteral));
 475   const APSInt &Int = Token.integerValue();
 476   if (Int.getMinSignedBits() > 64)
 477     // TODO: Replace this with an error when we can parse CIMM Machine Operands.
 478     llvm_unreachable("Can't parse large integer literals yet!");
 479   Dest = MachineOperand::CreateImm(Int.getExtValue());
 480   lex();
 481   return false;
 482 }
 483
 484 bool MIParser::getUnsigned(unsigned &Result) {
 485   assert(Token.hasIntegerValue() && "Expected a token with an integer value");
 486   const uint64_t Limit = uint64_t(std::numeric_limits<unsigned>::max()) + 1;
 487   uint64_t Val64 = Token.integerValue().getLimitedValue(Limit);
 488   if (Val64 == Limit)
 489     return error("expected 32-bit integer (too large)");
 490   Result = Val64;
 491   return false;
 492 }
 493
 494 bool MIParser::parseMBBReference(MachineBasicBlock *&MBB) {
 495   assert(Token.is(MIToken::MachineBasicBlock));
 496   unsigned Number;
 497   if (getUnsigned(Number))
 498     return true;
 499   auto MBBInfo = PFS.MBBSlots.find(Number);
 500   if (MBBInfo == PFS.MBBSlots.end())
 501     return error(Twine("use of undefined machine basic block #") +
 502                  Twine(Number));
 503   MBB = MBBInfo->second;
 504   if (!Token.stringValue().empty() && Token.stringValue() != MBB->getName())
 505     return error(Twine("the name of machine basic block #") + Twine(Number) +
 506                  " isn't '" + Token.stringValue() + "'");
 507   return false;
 508 }
 509
 510 bool MIParser::parseMBBOperand(MachineOperand &Dest) {
 511   MachineBasicBlock *MBB;
 512   if (parseMBBReference(MBB))
 513     return true;
 514   Dest = MachineOperand::CreateMBB(MBB);
 515   lex();
 516   return false;
 517 }
 518
 519 bool MIParser::parseStackObjectOperand(MachineOperand &Dest) {
 520   assert(Token.is(MIToken::StackObject));
 521   unsigned ID;
 522   if (getUnsigned(ID))
 523     return true;
 524   auto ObjectInfo = PFS.StackObjectSlots.find(ID);
 525   if (ObjectInfo == PFS.StackObjectSlots.end())
 526     return error(Twine("use of undefined stack object '%stack.") + Twine(ID) +
 527                  "'");
 528   StringRef Name;
 529   if (const auto *Alloca =
 530           MF.getFrameInfo()->getObjectAllocation(ObjectInfo->second))
 531     Name = Alloca->getName();
 532   if (!Token.stringValue().empty() && Token.stringValue() != Name)
 533     return error(Twine("the name of the stack object '%stack.") + Twine(ID) +
 534                  "' isn't '" + Token.stringValue() + "'");
 535   lex();
 536   Dest = MachineOperand::CreateFI(ObjectInfo->second);
 537   return false;
 538 }
 539
 540 bool MIParser::parseFixedStackObjectOperand(MachineOperand &Dest) {
 541   assert(Token.is(MIToken::FixedStackObject));
 542   unsigned ID;
 543   if (getUnsigned(ID))
 544     return true;
 545   auto ObjectInfo = PFS.FixedStackObjectSlots.find(ID);
 546   if (ObjectInfo == PFS.FixedStackObjectSlots.end())
 547     return error(Twine("use of undefined fixed stack object '%fixed-stack.") +
 548                  Twine(ID) + "'");
 549   lex();
 550   Dest = MachineOperand::CreateFI(ObjectInfo->second);
 551   return false;
 552 }
 553
 554 bool MIParser::parseGlobalAddressOperand(MachineOperand &Dest) {
 555   switch (Token.kind()) {
 556   case MIToken::NamedGlobalValue:
 557   case MIToken::QuotedNamedGlobalValue: {
 558     StringValueUtility Name(Token);
 559     const Module *M = MF.getFunction()->getParent();
 560     if (const auto *GV = M->getNamedValue(Name)) {
 561       Dest = MachineOperand::CreateGA(GV, /*Offset=*/0);
 562       break;
 563     }
 564     return error(Twine("use of undefined global value '@") +
 565                  Token.rawStringValue() + "'");
 566   }
 567   case MIToken::GlobalValue: {
 568     unsigned GVIdx;
 569     if (getUnsigned(GVIdx))
 570       return true;
 571     if (GVIdx >= IRSlots.GlobalValues.size())
 572       return error(Twine("use of undefined global value '@") + Twine(GVIdx) +
 573                    "'");
 574     Dest = MachineOperand::CreateGA(IRSlots.GlobalValues[GVIdx],
 575                                     /*Offset=*/0);
 576     break;
 577   }
 578   default:
 579     llvm_unreachable("The current token should be a global value");
 580   }
 581   // TODO: Parse offset and target flags.
 582   lex();
 583   return false;
 584 }
 585
 586 bool MIParser::parseConstantPoolIndexOperand(MachineOperand &Dest) {
 587   assert(Token.is(MIToken::ConstantPoolItem));
 588   unsigned ID;
 589   if (getUnsigned(ID))
 590     return true;
 591   auto ConstantInfo = PFS.ConstantPoolSlots.find(ID);
 592   if (ConstantInfo == PFS.ConstantPoolSlots.end())
 593     return error("use of undefined constant '%const." + Twine(ID) + "'");
 594   lex();
 595   // TODO: Parse offset and target flags.
 596   Dest = MachineOperand::CreateCPI(ID, /*Offset=*/0);
 597   return false;
 598 }
 599
 600 bool MIParser::parseJumpTableIndexOperand(MachineOperand &Dest) {
 601   assert(Token.is(MIToken::JumpTableIndex));
 602   unsigned ID;
 603   if (getUnsigned(ID))
 604     return true;
 605   auto JumpTableEntryInfo = PFS.JumpTableSlots.find(ID);
 606   if (JumpTableEntryInfo == PFS.JumpTableSlots.end())
 607     return error("use of undefined jump table '%jump-table." + Twine(ID) + "'");
 608   lex();
 609   // TODO: Parse target flags.
 610   Dest = MachineOperand::CreateJTI(JumpTableEntryInfo->second);
 611   return false;
 612 }
 613
 614 bool MIParser::parseExternalSymbolOperand(MachineOperand &Dest) {
 615   assert(Token.is(MIToken::ExternalSymbol) ||
 616          Token.is(MIToken::QuotedExternalSymbol));
 617   StringValueUtility Name(Token);
 618   const char *Symbol = MF.createExternalSymbolName(Name);
 619   lex();
 620   // TODO: Parse the target flags.
 621   Dest = MachineOperand::CreateES(Symbol);
 622   return false;
 623 }
 624
 625 bool MIParser::parseMDNode(MDNode *&Node) {
 626   assert(Token.is(MIToken::exclaim));
 627   auto Loc = Token.location();
 628   lex();
 629   if (Token.isNot(MIToken::IntegerLiteral) || Token.integerValue().isSigned())
 630     return error("expected metadata id after '!'");
 631   unsigned ID;
 632   if (getUnsigned(ID))
 633     return true;
 634   auto NodeInfo = IRSlots.MetadataNodes.find(ID);
 635   if (NodeInfo == IRSlots.MetadataNodes.end())
 636     return error(Loc, "use of undefined metadata '!" + Twine(ID) + "'");
 637   lex();
 638   Node = NodeInfo->second.get();
 639   return false;
 640 }
 641
 642 bool MIParser::parseMetadataOperand(MachineOperand &Dest) {
 643   MDNode *Node = nullptr;
 644   if (parseMDNode(Node))
 645     return true;
 646   Dest = MachineOperand::CreateMetadata(Node);
 647   return false;
 648 }
 649
 650 bool MIParser::parseCFIOffset(int &Offset) {
 651   if (Token.isNot(MIToken::IntegerLiteral))
 652     return error("expected a cfi offset");
 653   if (Token.integerValue().getMinSignedBits() > 32)
 654     return error("expected a 32 bit integer (the cfi offset is too large)");
 655   Offset = (int)Token.integerValue().getExtValue();
 656   lex();
 657   return false;
 658 }
 659
 660 bool MIParser::parseCFIRegister(unsigned &Reg) {
 661   if (Token.isNot(MIToken::NamedRegister))
 662     return error("expected a cfi register");
 663   unsigned LLVMReg;
 664   if (parseRegister(LLVMReg))
 665     return true;
 666   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 667   assert(TRI && "Expected target register info");
 668   int DwarfReg = TRI->getDwarfRegNum(LLVMReg, true);
 669   if (DwarfReg < 0)
 670     return error("invalid DWARF register");
 671   Reg = (unsigned)DwarfReg;
 672   lex();
 673   return false;
 674 }
 675
 676 bool MIParser::parseCFIOperand(MachineOperand &Dest) {
 677   auto Kind = Token.kind();
 678   lex();
 679   auto &MMI = MF.getMMI();
 680   int Offset;
 681   unsigned Reg;
 682   unsigned CFIIndex;
 683   switch (Kind) {
 684   case MIToken::kw_cfi_offset:
 685     if (parseCFIRegister(Reg) || expectAndConsume(MIToken::comma) ||
 686         parseCFIOffset(Offset))
 687       return true;
 688     CFIIndex =
 689         MMI.addFrameInst(MCCFIInstruction::createOffset(nullptr, Reg, Offset));
 690     break;
 691   case MIToken::kw_cfi_def_cfa_offset:
 692     if (parseCFIOffset(Offset))
 693       return true;
 694     // NB: MCCFIInstruction::createDefCfaOffset negates the offset.
 695     CFIIndex = MMI.addFrameInst(
 696         MCCFIInstruction::createDefCfaOffset(nullptr, -Offset));
 697     break;
 698   default:
 699     // TODO: Parse the other CFI operands.
 700     llvm_unreachable("The current token should be a cfi operand");
 701   }
 702   Dest = MachineOperand::CreateCFIIndex(CFIIndex);
 703   return false;
 704 }
 705
 706 bool MIParser::parseMachineOperand(MachineOperand &Dest) {
 707   switch (Token.kind()) {
 708   case MIToken::kw_implicit:
 709   case MIToken::kw_implicit_define:
 710   case MIToken::kw_dead:
 711   case MIToken::kw_killed:
 712   case MIToken::kw_undef:
 713   case MIToken::underscore:
 714   case MIToken::NamedRegister:
 715   case MIToken::VirtualRegister:
 716     return parseRegisterOperand(Dest);
 717   case MIToken::IntegerLiteral:
 718     return parseImmediateOperand(Dest);
 719   case MIToken::MachineBasicBlock:
 720     return parseMBBOperand(Dest);
 721   case MIToken::StackObject:
 722     return parseStackObjectOperand(Dest);
 723   case MIToken::FixedStackObject:
 724     return parseFixedStackObjectOperand(Dest);
 725   case MIToken::GlobalValue:
 726   case MIToken::NamedGlobalValue:
 727   case MIToken::QuotedNamedGlobalValue:
 728     return parseGlobalAddressOperand(Dest);
 729   case MIToken::ConstantPoolItem:
 730     return parseConstantPoolIndexOperand(Dest);
 731   case MIToken::JumpTableIndex:
 732     return parseJumpTableIndexOperand(Dest);
 733   case MIToken::ExternalSymbol:
 734   case MIToken::QuotedExternalSymbol:
 735     return parseExternalSymbolOperand(Dest);
 736   case MIToken::exclaim:
 737     return parseMetadataOperand(Dest);
 738   case MIToken::kw_cfi_offset:
 739   case MIToken::kw_cfi_def_cfa_offset:
 740     return parseCFIOperand(Dest);
 741   case MIToken::Error:
 742     return true;
 743   case MIToken::Identifier:
 744     if (const auto *RegMask = getRegMask(Token.stringValue())) {
 745       Dest = MachineOperand::CreateRegMask(RegMask);
 746       lex();
 747       break;
 748     }
 749   // fallthrough
 750   default:
 751     // TODO: parse the other machine operands.
 752     return error("expected a machine operand");
 753   }
 754   return false;
 755 }
 756
 757 void MIParser::initNames2InstrOpCodes() {
 758   if (!Names2InstrOpCodes.empty())
 759     return;
 760   const auto *TII = MF.getSubtarget().getInstrInfo();
 761   assert(TII && "Expected target instruction info");
 762   for (unsigned I = 0, E = TII->getNumOpcodes(); I < E; ++I)
 763     Names2InstrOpCodes.insert(std::make_pair(StringRef(TII->getName(I)), I));
 764 }
 765
 766 bool MIParser::parseInstrName(StringRef InstrName, unsigned &OpCode) {
 767   initNames2InstrOpCodes();
 768   auto InstrInfo = Names2InstrOpCodes.find(InstrName);
 769   if (InstrInfo == Names2InstrOpCodes.end())
 770     return true;
 771   OpCode = InstrInfo->getValue();
 772   return false;
 773 }
 774
 775 void MIParser::initNames2Regs() {
 776   if (!Names2Regs.empty())
 777     return;
 778   // The '%noreg' register is the register 0.
 779   Names2Regs.insert(std::make_pair("noreg", 0));
 780   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 781   assert(TRI && "Expected target register info");
 782   for (unsigned I = 0, E = TRI->getNumRegs(); I < E; ++I) {
 783     bool WasInserted =
 784         Names2Regs.insert(std::make_pair(StringRef(TRI->getName(I)).lower(), I))
 785             .second;
 786     (void)WasInserted;
 787     assert(WasInserted && "Expected registers to be unique case-insensitively");
 788   }
 789 }
 790
 791 bool MIParser::getRegisterByName(StringRef RegName, unsigned &Reg) {
 792   initNames2Regs();
 793   auto RegInfo = Names2Regs.find(RegName);
 794   if (RegInfo == Names2Regs.end())
 795     return true;
 796   Reg = RegInfo->getValue();
 797   return false;
 798 }
 799
 800 void MIParser::initNames2RegMasks() {
 801   if (!Names2RegMasks.empty())
 802     return;
 803   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 804   assert(TRI && "Expected target register info");
 805   ArrayRef<const uint32_t *> RegMasks = TRI->getRegMasks();
 806   ArrayRef<const char *> RegMaskNames = TRI->getRegMaskNames();
 807   assert(RegMasks.size() == RegMaskNames.size());
 808   for (size_t I = 0, E = RegMasks.size(); I < E; ++I)
 809     Names2RegMasks.insert(
 810         std::make_pair(StringRef(RegMaskNames[I]).lower(), RegMasks[I]));
 811 }
 812
 813 const uint32_t *MIParser::getRegMask(StringRef Identifier) {
 814   initNames2RegMasks();
 815   auto RegMaskInfo = Names2RegMasks.find(Identifier);
 816   if (RegMaskInfo == Names2RegMasks.end())
 817     return nullptr;
 818   return RegMaskInfo->getValue();
 819 }
 820
 821 void MIParser::initNames2SubRegIndices() {
 822   if (!Names2SubRegIndices.empty())
 823     return;
 824   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
 825   for (unsigned I = 1, E = TRI->getNumSubRegIndices(); I < E; ++I)
 826     Names2SubRegIndices.insert(
 827         std::make_pair(StringRef(TRI->getSubRegIndexName(I)).lower(), I));
 828 }
 829
 830 unsigned MIParser::getSubRegIndex(StringRef Name) {
 831   initNames2SubRegIndices();
 832   auto SubRegInfo = Names2SubRegIndices.find(Name);
 833   if (SubRegInfo == Names2SubRegIndices.end())
 834     return 0;
 835   return SubRegInfo->getValue();
 836 }
 837
 838 bool llvm::parseMachineInstr(MachineInstr *&MI, SourceMgr &SM,
 839                              MachineFunction &MF, StringRef Src,
 840                              const PerFunctionMIParsingState &PFS,
 841                              const SlotMapping &IRSlots, SMDiagnostic &Error) {
 842   return MIParser(SM, MF, Error, Src, PFS, IRSlots).parse(MI);
 843 }
 844
 845 bool llvm::parseMBBReference(MachineBasicBlock *&MBB, SourceMgr &SM,
 846                              MachineFunction &MF, StringRef Src,
 847                              const PerFunctionMIParsingState &PFS,
 848                              const SlotMapping &IRSlots, SMDiagnostic &Error) {
 849   return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseMBB(MBB);
 850 }
 851
 852 bool llvm::parseNamedRegisterReference(unsigned &Reg, SourceMgr &SM,
 853                                        MachineFunction &MF, StringRef Src,
 854                                        const PerFunctionMIParsingState &PFS,
 855                                        const SlotMapping &IRSlots,
 856                                        SMDiagnostic &Error) {
 857   return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseNamedRegister(Reg);
 858 }
 859
 860 bool llvm::parseVirtualRegisterReference(unsigned &Reg, SourceMgr &SM,
 861                                          MachineFunction &MF, StringRef Src,
 862                                          const PerFunctionMIParsingState &PFS,
 863                                          const SlotMapping &IRSlots,
 864                                          SMDiagnostic &Error) {
 865   return MIParser(SM, MF, Error, Src, PFS, IRSlots)
 866       .parseStandaloneVirtualRegister(Reg);
 867 }